Class TeamApi

TeamApi - object-oriented interface

Export

Hierarchy

BaseAPI
- TeamApi

Index

Constructors

Properties

axios basePath configuration

Methods

getTeam getTeamStats getTeams

Constructors

constructor

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

getTeam

getTeam(requestParameters, options?): Promise<AxiosResponse<Team, any>>
Parameters
- requestParameters: TeamApiGetTeamRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Team, any>>

Summary
所属するチームを取得する

Throws

Memberof
TeamApi
- Defined in client/api/team-api.ts:463

getTeamStats

getTeamStats(requestParameters, options?): Promise<AxiosResponse<TeamStats, any>>
Parameters
- requestParameters: TeamApiGetTeamStatsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<TeamStats, any>>

Summary
チームの統計情報を取得する

Throws

Memberof
TeamApi
- Defined in client/api/team-api.ts:477

getTeams

getTeams(requestParameters?, options?): Promise<AxiosResponse<PaginatedTeams, any>>
Parameters
- requestParameters: TeamApiGetTeamsRequest = {}
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedTeams, any>>

Summary
所属するチーム一覧を取得する

Throws

Memberof
TeamApi
- Defined in client/api/team-api.ts:494

Generated using TypeDoc