Class TeamAPI

Hierarchy

APIBase
- TeamAPI

Index

Constructors

Properties

apiClient options

Methods

checkApiKey deleteTeam retrieveTeam retrieveTeams setApiAuthorization setApiUrl

Constructors

constructor

new TeamAPI(apiClient: APIClient, options: ClientOptions): TeamAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns TeamAPI
Overrides APIBase.constructor
- Defined in api/TeamAPI.ts:9

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

`Protected`checkApiKey

checkApiKey(apiName?: string): void
Parameters
- OptionalapiName: string
Returns void
Inherited from APIBase.checkApiKey
- Defined in api/APIBase.ts:41

deleteTeam

deleteTeam(id: string): Promise<void>
Deletes a team
Parameters
- id: string
  The team id
Returns Promise<void>
- Defined in api/TeamAPI.ts:17

retrieveTeam

retrieveTeam(id: string): Promise<Team>
Retrieve a single team
Parameters
- id: string
Returns Promise<Team>
- Defined in api/TeamAPI.ts:26

retrieveTeams

retrieveTeams(options?: PaginationOptions): Promise<Paginated<Team[]>>
Retrieve teams
Parameters
- Optionaloptions: PaginationOptions
Returns Promise<Paginated<Team[]>>
- Defined in api/TeamAPI.ts:36

setApiAuthorization

setApiAuthorization(authorization: Authorization): void
Set a new API key.
Parameters
- authorization: Authorization
  The API authorization data
Returns void
Inherited from APIBase.setApiAuthorization
- Defined in api/APIBase.ts:20

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:37