Class MemberApi

MemberApi - object-oriented interface

Export

Hierarchy

BaseAPI
- MemberApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteMember getMembers

Constructors

constructor

new MemberApi(configuration?, basePath?, axios?): MemberApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns MemberApi
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

deleteMember

deleteMember(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
Parameters
- requestParameters: MemberApiDeleteMemberRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
メンバーを削除する

Throws

Memberof
MemberApi
- Defined in client/api/member-api.ts:419

getMembers

getMembers(requestParameters, options?): Promise<AxiosResponse<PaginatedMembers, any>>
Parameters
- requestParameters: MemberApiGetMembersRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedMembers, any>>

Summary
メンバーを取得する

Throws

Memberof
MemberApi
- Defined in client/api/member-api.ts:440

Generated using TypeDoc