SDK: invitations

The invitations area has 4 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

invitationsAccept

Accept a team invitation (a person does this)

• Request: POST on /v1/invitations/accept

invitationsAccept(args: { body: AcceptInvitationRequest }, options?: CallOptions): Promise<Record<string, unknown>>

invitationsCreate

Invite someone to the team (policy class)

• Request: POST on /v1/tenants/{tenantId}/invitations
• Needs an approval for agents: class policy_change

invitationsCreate(args: { tenantId: string; body: CreateInvitationRequest }, options?: CallOptions): Promise<Record<string, unknown>>

invitationsList

List open invitations

• Request: GET on /v1/tenants/{tenantId}/invitations

invitationsList(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

invitationsRevoke

Revoke an invitation

• Request: DELETE on /v1/tenants/{tenantId}/invitations/{invitationId}

invitationsRevoke(args: { tenantId: string; invitationId: string }, options?: CallOptions): Promise<Record<string, unknown>>