Class TeamsService

Hierarchy (view full)

BaseService<Team, TeamInterface>
- TeamsService

Index

Constructors

Properties

availableOperations baseUrl headers instances teams

Methods

disable enable factory get getByName getMany list

Constructors

constructor

new TeamsService(init): TeamsService
Service classes are not intended to be instantiated directly. Instead, use the Client class to create instances of services.
Parameters
- init: {
  headers: Record<string, string>;
  }
  - headers: Record<string, string>
Returns TeamsService
Inherited from BaseService.constructor
- Defined in base-service.ts:26

Properties

availableOperations

availableOperations: ServiceOperation[] = ...

Lists out the available operations for the resource, calling methods not in this list will result in an error

baseUrl

baseUrl: string = 'https://api.app.shortcut.com/api/v3/groups'

headers

headers: Record<string, string>

`Protected` instances

instances: Record<string, Team> = {}

`Static` teams

teams: Record<number, Team> = {}

Methods

disable

disable(): Promise<boolean>
Disables the teams feature for the workspace.

Returns Promise<boolean>
- Defined in teams/teams-service.ts:25

enable

enable(): Promise<boolean>
Enables the teams feature for the workspace.

Returns Promise<boolean>
- Defined in teams/teams-service.ts:17

`Protected` factory

factory(data): Team
Parameters
- data: TeamInterface
Returns Team
Overrides BaseService.factory
- Defined in teams/teams-service.ts:10

get

get(id): Promise<Team>
Parameters
- id: string | number
Returns Promise<Team>
Inherited from BaseService.get
- Defined in base-service.ts:30

getByName

getByName(name): Promise<null | Team>
A convenience method to get a team by name instead of by ID. Search is case-sensitive.
Parameters
- name: string
Returns Promise<null | Team>
- Defined in teams/teams-service.ts:34

getMany

getMany(ids): Promise<Team[]>
Parameters
- ids: string[] | number[]
Returns Promise<Team[]>
Inherited from BaseService.getMany
- Defined in base-service.ts:49

list

list(): Promise<Team[]>
Returns Promise<Team[]>
Inherited from BaseService.list
- Defined in base-service.ts:53