Class InvitationsApi

InvitationsApi - object-oriented interface

Export

InvitationsApi

Hierarchy

BaseAPI
- InvitationsApi

Index

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

invitationsAccept

invitationsAccept(
requestParameters: InvitationsApiInvitationsAcceptRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AcceptInvitationRead, any>>
Parameters
- requestParameters: InvitationsApiInvitationsAcceptRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AcceptInvitationRead, any>>
Throws
Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:917

invitationsCreate

invitationsCreate(
requestParameters: InvitationsApiInvitationsCreateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<InvitationRead, any>>
Parameters
- requestParameters: InvitationsApiInvitationsCreateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<InvitationRead, any>>
Throws
Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:929

invitationsDecline

invitationsDecline(
requestParameters: InvitationsApiInvitationsDeclineRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: InvitationsApiInvitationsDeclineRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:941

invitationsDestroy

invitationsDestroy(
requestParameters: InvitationsApiInvitationsDestroyRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: InvitationsApiInvitationsDestroyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:953

invitationsList

invitationsList(
requestParameters?: InvitationsApiInvitationsListRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PaginatedInvitationReadList, any>>
Parameters
- requestParameters: InvitationsApiInvitationsListRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaginatedInvitationReadList, any>>
Throws
Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:965

invitationsPartialUpdate

invitationsPartialUpdate(
requestParameters: InvitationsApiInvitationsPartialUpdateRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<InvitationRead, any>>
Parameters
- requestParameters: InvitationsApiInvitationsPartialUpdateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<InvitationRead, any>>
Throws
Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:977

invitationsResend

invitationsResend(
requestParameters: InvitationsApiInvitationsResendRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: InvitationsApiInvitationsResendRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:989

invitationsRetrieve

invitationsRetrieve(
requestParameters: InvitationsApiInvitationsRetrieveRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<InvitationRead, any>>
Parameters
- requestParameters: InvitationsApiInvitationsRetrieveRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<InvitationRead, any>>
Throws
Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:1001

Class InvitationsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InvitationsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

invitationsAccept

Parameters

Returns Promise<AxiosResponse<AcceptInvitationRead, any>>

Throws

Memberof

invitationsCreate

Parameters

Returns Promise<AxiosResponse<InvitationRead, any>>

Throws

Memberof

invitationsDecline

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

invitationsDestroy

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

invitationsList

Parameters

Returns Promise<AxiosResponse<PaginatedInvitationReadList, any>>

Throws

Memberof

invitationsPartialUpdate

Parameters

Returns Promise<AxiosResponse<InvitationRead, any>>

Throws

Memberof

invitationsResend

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

invitationsRetrieve

Parameters

Returns Promise<AxiosResponse<InvitationRead, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration