Class TeamApi

Hierarchy

BaseAPI
- TeamApi

Index

Constructors

Properties

Methods

find findRaw getMembers getMembersRaw getTeam getTeamRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new TeamApi(configuration?: Configuration): TeamApi
Parameters
- configuration: Configuration = DefaultConfig
Returns TeamApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

find

find(requestParameters?: FindRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTGlobalTreeNodeListResponseBTTeamInfo>
Retrieve list of teams for current user.
Parameters
- requestParameters: FindRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTGlobalTreeNodeListResponseBTTeamInfo>
- Defined in apis/TeamApi.ts:101

findRaw

findRaw(requestParameters: FindRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTGlobalTreeNodeListResponseBTTeamInfo>>
Retrieve list of teams for current user.
Parameters
- requestParameters: FindRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTGlobalTreeNodeListResponseBTTeamInfo>>
- Defined in apis/TeamApi.ts:59

getMembers

getMembers(requestParameters: GetMembersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTTeamMemberInfo>
Retrieve team members by team ID.
Parameters
- requestParameters: GetMembersRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTTeamMemberInfo>
- Defined in apis/TeamApi.ts:159

getMembersRaw

getMembersRaw(requestParameters: GetMembersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTTeamMemberInfo>>
Retrieve team members by team ID.
Parameters
- requestParameters: GetMembersRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTTeamMemberInfo>>
- Defined in apis/TeamApi.ts:109

getTeam

getTeam(requestParameters: GetTeamRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTTeamInfo>
Retrieve team information by team ID.
Parameters
- requestParameters: GetTeamRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTTeamInfo>
- Defined in apis/TeamApi.ts:197

getTeamRaw

getTeamRaw(requestParameters: GetTeamRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTTeamInfo>>
Retrieve team information by team ID.
Parameters
- requestParameters: GetTeamRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTTeamInfo>>
- Defined in apis/TeamApi.ts:167

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Generated using TypeDoc