Class InvitationsApi

InvitationsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- InvitationsApi

Index

Constructors

constructor

new InvitationsApi(configuration?, basePath?, axios?): InvitationsApi
Parameters
- Optional configuration: 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, options?): Promise<AxiosResponse<AcceptInvitationRead, any>>
Parameters
- requestParameters: InvitationsApiInvitationsAcceptRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AcceptInvitationRead, any>>

Summary
Method registers user and accepts invitation to organization

Throws

Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:822

invitationsCreate

invitationsCreate(requestParameters, options?): Promise<AxiosResponse<InvitationRead, any>>
Parameters
- requestParameters: InvitationsApiInvitationsCreateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<InvitationRead, any>>

Summary
Method creates an invitation

Throws

Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:834

invitationsDestroy

invitationsDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: InvitationsApiInvitationsDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes an invitation

Throws

Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:846

invitationsList

invitationsList(requestParameters?, options?): Promise<AxiosResponse<PaginatedInvitationReadList, any>>
Parameters
- requestParameters: InvitationsApiInvitationsListRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedInvitationReadList, any>>

Summary
Method returns a paginated list of invitations

Throws

Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:858

invitationsPartialUpdate

invitationsPartialUpdate(requestParameters, options?): Promise<AxiosResponse<InvitationRead, any>>
Parameters
- requestParameters: InvitationsApiInvitationsPartialUpdateRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<InvitationRead, any>>

Summary
Methods does a partial update of chosen fields in an invitation

Throws

Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:870

invitationsResend

invitationsResend(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: InvitationsApiInvitationsResendRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method resends the invitation

Throws

Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:882

invitationsRetrieve

invitationsRetrieve(requestParameters, options?): Promise<AxiosResponse<InvitationRead, any>>
Parameters
- requestParameters: InvitationsApiInvitationsRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<InvitationRead, any>>

Summary
Method returns details of an invitation

Throws

Memberof
InvitationsApi
- Defined in api-client/invitations-api.ts:894

Class InvitationsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns InvitationsApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

invitationsAccept

Parameters

requestParameters: InvitationsApiInvitationsAcceptRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<AcceptInvitationRead, any>>

Summary

Throws

Memberof

invitationsCreate

Parameters

requestParameters: InvitationsApiInvitationsCreateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<InvitationRead, any>>

Summary

Throws

Memberof

invitationsDestroy

Parameters

requestParameters: InvitationsApiInvitationsDestroyRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

invitationsList

Parameters

requestParameters: InvitationsApiInvitationsListRequest = {}

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<PaginatedInvitationReadList, any>>

Summary

Throws

Memberof

invitationsPartialUpdate

Parameters

requestParameters: InvitationsApiInvitationsPartialUpdateRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<InvitationRead, any>>

Summary

Throws

Memberof

invitationsResend

Parameters

requestParameters: InvitationsApiInvitationsResendRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

invitationsRetrieve

Parameters

requestParameters: InvitationsApiInvitationsRetrieveRequest

Optional options: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<InvitationRead, any>>

Summary

Throws

Memberof

Settings

Member Visibility

Theme

On This Page

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>

`Optional` options: AxiosRequestConfig<any>