Class InvitesResource

Operations for managing invitations to join the organization. Accessed via AdminClient.invites.

Index

Constructors

Methods

create delete describe list resend

Constructors

constructor

new InvitesResource(api: InvitesApi): InvitesResource
Parameters
- api: InvitesApi
Returns InvitesResource
- Defined in src/admin/resources/invites.ts:33

Methods

create

create(options: CreateInviteRequest): Promise<Invite>
Create and send a new invite to join the organization.
Parameters
- options: CreateInviteRequest
Returns Promise<Invite>
- Defined in src/admin/resources/invites.ts:38

delete

delete(inviteId: string): Promise<void>
Delete an invite by ID.
Parameters
- inviteId: string
Returns Promise<void>
- Defined in src/admin/resources/invites.ts:90

describe

describe(inviteId: string): Promise<Invite>
Get an invite's details by ID.
Parameters
- inviteId: string
Returns Promise<Invite>
- Defined in src/admin/resources/invites.ts:56

list

list(options?: ListInvitesOptions): Promise<InviteList>
List invites in the organization.
Parameters
- options: ListInvitesOptions = {}
Returns Promise<InviteList>
- Defined in src/admin/resources/invites.ts:69

resend

resend(inviteId: string): Promise<Invite>
Resend an existing invite by ID, extending its expiration.
Parameters
- inviteId: string
Returns Promise<Invite>
- Defined in src/admin/resources/invites.ts:77