Class InviteTokensApi

InviteTokensApi - object-oriented interface export InviteTokensApi

Hierarchy (view full)

BaseAPI
- InviteTokensApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiInviteTokenDecryptGet apiInviteTokenSendPost

Constructors

constructor

new InviteTokensApi(configuration?, basePath?, axios?): InviteTokensApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns InviteTokensApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiInviteTokenDecryptGet

apiInviteTokenDecryptGet(token?, options?): Promise<AxiosResponse<InviteInfo, any>>
summary Decrypt an invite token and return information for display
Parameters
- Optionaltoken: string
  The encrypted token value
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<InviteInfo, any>>
Throws
memberof InviteTokensApi
- Defined in src/api/api.ts:20531

apiInviteTokenSendPost

apiInviteTokenSendPost(inviteSendDeets?, options?): Promise<AxiosResponse<void, any>>
summary Send an invite token
Parameters
- OptionalinviteSendDeets: InviteSendDeets
  The invite details, including the token value
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof InviteTokensApi
- Defined in src/api/api.ts:20543