Class InvitationApi

InvitationApi - object-oriented interface

Export

Hierarchy

BaseAPI
- InvitationApi

Index

Constructors

Properties

axios basePath configuration

Methods

disinvite getInvitations invite

Constructors

constructor

new InvitationApi(configuration?, basePath?, axios?): InvitationApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns InvitationApi
Inherited from BaseAPI.constructor
- Defined in client/base.ts:51

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

disinvite

disinvite(requestParameters, options?): Promise<AxiosResponse<void, any>>
招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。このAPIはteamのownerだけがご利用可能です。
Parameters
- requestParameters: InvitationApiDisinviteRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
招待を取り下げる

Throws

Memberof
InvitationApi
- Defined in client/api/invitation-api.ts:489

getInvitations

getInvitations(requestParameters, options?): Promise<AxiosResponse<InvitationList, any>>
招待中のメンバーの一覧を取得します。このAPIはteamのownerだけがご利用可能です。
Parameters
- requestParameters: InvitationApiGetInvitationsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<InvitationList, any>>

Summary
招待中のメンバー一覧を取得する

Throws

Memberof
InvitationApi
- Defined in client/api/invitation-api.ts:506

invite

invite(requestParameters, options?): Promise<AxiosResponse<InvitationList, any>>
招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。このAPIはteamのownerだけがご利用可能です。
Parameters
- requestParameters: InvitationApiInviteRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<InvitationList, any>>

Summary
Emailで招待する

Throws

Memberof
InvitationApi
- Defined in client/api/invitation-api.ts:523

Generated using TypeDoc