Class InvitesClient

Organization invite lifecycle: create, list, accept, decline, cancel.

Index

Constructors

Methods

accept cancel checkPending create decline listForOrganization listForUser

Constructors

constructor

new InvitesClient(call: Caller, callPublic?: Caller): InvitesClient
Parameters
- call: Caller
  authed Caller for the user-scoped invite endpoints.
- callPublic: Caller = call
  auth-less Caller for the public, pre-auth signup-flow endpoint (checkPending). Defaults to call so existing tests construct with a single caller.
Returns InvitesClient
- Defined in src/resources/invites.ts:33

Methods

accept

accept(
req: AcceptInviteRequest,
opts?: RequestOptions,
): Promise<OrganizationData>
Accept an invite; returns the organization the caller just joined.
Parameters
- req: AcceptInviteRequest
- Optionalopts: RequestOptions
Returns Promise<OrganizationData>
- Defined in src/resources/invites.ts:64

cancel

cancel(req: CancelInviteRequest, opts?: RequestOptions): Promise<void>
Cancel (revoke) a pending invite.
Parameters
- req: CancelInviteRequest
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
NotFoundError if the invite does not exist.
- Defined in src/resources/invites.ts:87

checkPending

checkPending(email: string, opts?: RequestOptions): Promise<InviteResponse[]>
Check a user's pending invites by email — the PUBLIC, pre-auth signup-flow endpoint (GET /organization-invites/check/{email}). Unlike listForUser (post-auth, user-scoped), this runs on the auth-less pipeline so it can be called before the invitee has signed in. Returns PENDING, non-expired, organization-name-enriched invites (the backend's redundant total is dropped — use .length).
Parameters
- email: string
- Optionalopts: RequestOptions
Returns Promise<InviteResponse[]>
- Defined in src/resources/invites.ts:115

create

create(
req: CreateOrganizationInviteRequest,
opts?: RequestOptions,
): Promise<InviteResponse>
Invite a user to an organization.
Parameters
- req: CreateOrganizationInviteRequest
- Optionalopts: RequestOptions
Returns Promise<InviteResponse>
Throws
ValidationError if the request body is rejected.
- Defined in src/resources/invites.ts:42

decline

decline(req: DeclineInviteRequest, opts?: RequestOptions): Promise<void>
Decline an invite addressed to the caller.
Parameters
- req: DeclineInviteRequest
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
NotFoundError if the invite does not exist.
- Defined in src/resources/invites.ts:76

listForOrganization

listForOrganization(
params: GetOrganizationInvitesRequest,
opts?: RequestOptions,
): Promise<InviteResponse[]>
List an organization's invites, optionally filtered by ?status=.
Parameters
- params: GetOrganizationInvitesRequest
- Optionalopts: RequestOptions
Returns Promise<InviteResponse[]>
- Defined in src/resources/invites.ts:51

listForUser

listForUser(
params: GetUserInvitesRequest,
opts?: RequestOptions,
): Promise<InviteResponse[]>
List a user's invites, optionally filtered by ?status=.
Parameters
- params: GetUserInvitesRequest
- Optionalopts: RequestOptions
Returns Promise<InviteResponse[]>
- Defined in src/resources/invites.ts:95