Class Invitations

Index

Constructors

constructor

new Invitations(_options: Invitations.Options): Invitations
Parameters
- _options: Invitations.Options
Returns Invitations

Methods

list

list(
    id: string,
    request?: Management.ListOrganizationInvitationsRequestParameters,
    requestOptions?: Invitations.RequestOptions,
): Promise<Page<OrganizationInvitation>>
Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review Invite Organization Members.
Parameters
- id: string
  Organization identifier.
- request: Management.ListOrganizationInvitationsRequestParameters = {}
- OptionalrequestOptions: Invitations.RequestOptions
  Request-specific configuration.
Returns Promise<Page<OrganizationInvitation>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.invitations.list("id")
```

create

create(
    id: string,
    request: Management.CreateOrganizationInvitationRequestContent,
    requestOptions?: Invitations.RequestOptions,
): HttpResponsePromise<CreateOrganizationInvitationResponseContent>
Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review Invite Organization Members.
Parameters
- id: string
  Organization identifier.
- request: Management.CreateOrganizationInvitationRequestContent
- OptionalrequestOptions: Invitations.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateOrganizationInvitationResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.invitations.create("id", {
        inviter: {
            name: "name"
        },
        invitee: {
            email: "email"
        },
        client_id: "client_id"
    })
```

get

get(
    id: string,
    invitationId: string,
    request?: Management.GetOrganizationInvitationRequestParameters,
    requestOptions?: Invitations.RequestOptions,
): HttpResponsePromise<GetOrganizationInvitationResponseContent>
Parameters
- id: string
  Organization identifier.
- invitationId: string
  The id of the user invitation.
- request: Management.GetOrganizationInvitationRequestParameters = {}
- OptionalrequestOptions: Invitations.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetOrganizationInvitationResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.invitations.get("id", "invitation_id")
```

delete

delete(
    id: string,
    invitationId: string,
    requestOptions?: Invitations.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
  Organization identifier.
- invitationId: string
  The id of the user invitation.
- OptionalrequestOptions: Invitations.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.invitations.delete("id", "invitation_id")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Invitations.Options

Class Invitations

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns Invitations

Methods

list

Parameters

Returns Promise<Page<OrganizationInvitation>>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateOrganizationInvitationResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetOrganizationInvitationResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options