import { Client } from ".."; import { App } from "../models/regional/apps"; import { Collaborator, CollaboratorInvitePayload } from "../models/regional/collaborators"; import { OrganizationScopedParams } from "../params/regional/organization"; export type IndexQuery = OrganizationScopedParams & Record; export interface IndexResponse { collaborators: Collaborator[]; } /** * Collaborators API Client */ export default class Collaborators { /** Scalingo API Client */ _client: Client; /** * Create a new "thematic" client * @param client Scalingo API Client */ constructor(client: Client); /** * List all collaborators of an application * @see https://developers.scalingo.com/collaborators#list-collaborators-of-an-app * @param appId ID of the app to get collaborators list} */ for(appId: string): Promise; /** * Remove a collaborator * @see https://developers.scalingo.com/collaborators#delete-a-collaborator * @param appId ID of the application * @param collaboratorId ID of the collaborator to remove */ destroy(appId: string, collaboratorId: string): Promise; /** * Invite collaborators to an application * @see https://developers.scalingo.com/collaborators#invite-collaborator-to-work-on-an-app * @param appId Id of the application * @param payload (string | CollaboratorInvitePayload) Email of the limited collaborator or CollaboratorInvitePayload */ invite(appId: string, payload: CollaboratorInvitePayload | string): Promise; /** * Accept invitation to an application * @see https://developers.scalingo.com/collaborators#accept-an-invitation-to-collaborate * @params {String} token Token of the invitation returned when adding a collaborator */ inviteAccept(token: string): Promise; /** * list all request owner collaborators * @param params Optional query parameters * @param params.organization_id ID of the organization to scope the results to */ all(params?: IndexQuery): Promise; /** * List update a collaborator of an application * @see https://developers.scalingo.com/collaborators#update-a-collaborator * @param appId ID of the app to get collaborators list} */ update(appId: string, collaboratorId: string, collaborator: Partial): Promise; } //# sourceMappingURL=index.d.ts.map