Class Teams

Hierarchy (view full)

CrowdinApi
- Teams

Index

Constructors

Methods

addTeam addTeamMembers addTeamToProject deleteAllTeamMembers deleteTeam deleteTeamMember editTeam editTeamProjectPermissions getGroupTeam getTeam graphql listGroupTeams listTeamProjectPermissions listTeams teamMembersList updateGroupTeams withFetchAll

Constructors

constructor

new Teams(credentials, config?): Teams
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns Teams
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:232

Methods

deleteAllTeamMembers

deleteAllTeamMembers(teamId): Promise<void>
Parameters
- teamId: number
  team identifier
Returns Promise<void>
See
https://support.crowdin.com/enterprise/api/#operation/api.teams.members.deleteMany
- Defined in teams/index.ts:197

deleteTeam

deleteTeam(teamId): Promise<void>
Parameters
- teamId: number
  team identifier
Returns Promise<void>
See
https://support.crowdin.com/enterprise/api/#operation/api.teams.delete
- Defined in teams/index.ts:139

deleteTeamMember

deleteTeamMember(teamId, memberId): Promise<void>
Parameters
- teamId: number
  team identifier
- memberId: number
  member identifier
Returns Promise<void>
See
https://support.crowdin.com/enterprise/api/#operation/api.teams.members.delete
- Defined in teams/index.ts:207

editTeam

editTeam(teamId, request): Promise<ResponseObject<Team>>
Parameters
- teamId: number
  team identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Team>>
See
https://support.crowdin.com/enterprise/api/#operation/api.teams.patch
- Defined in teams/index.ts:149

editTeamProjectPermissions

editTeamProjectPermissions(teamId, request): Promise<ResponseList<TeamsModel.ProjectPermissions>>
Parameters
- teamId: number
  team identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseList<TeamsModel.ProjectPermissions>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.teams.projects.permissions.patch
- Defined in teams/index.ts:67

getGroupTeam

getGroupTeam(groupId, teamId): Promise<ResponseObject<TeamGroup>>
Parameters
- groupId: number
  group identifier
- teamId: number
  team identifier
Returns Promise<ResponseObject<TeamGroup>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Teams/operation/api.groups.teams.get
- Defined in teams/index.ts:44

getTeam

getTeam(teamId): Promise<ResponseObject<Team>>
Parameters
- teamId: number
  team identifier
Returns Promise<ResponseObject<Team>>
See
https://support.crowdin.com/enterprise/api/#operation/api.teams.get
- Defined in teams/index.ts:130

graphql

graphql<T>(req, config?): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
- config: {
  url?: string;
  } = {}
  - Optionalurl?: string
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:266

listGroupTeams

listGroupTeams(groupId, options?): Promise<ResponseList<TeamGroup>>
Parameters
- groupId: number
  group identifier
- Optionaloptions: ListGroupTeamsOptions
  request options
Returns Promise<ResponseList<TeamGroup>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Teams/operation/api.groups.teams.getMany
- Defined in teams/index.ts:20

listTeamProjectPermissions

listTeamProjectPermissions(teamId, options?): Promise<ResponseList<TeamsModel.ProjectPermissions>>
Parameters
- teamId: number
  team identifier
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<TeamsModel.ProjectPermissions>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.teams.projects.permissions.getMany
- Defined in teams/index.ts:54

listTeams

listTeams(options?): Promise<ResponseList<Team>>
Parameters
- Optionaloptions: ListTeamsOptions
  optional pagination parameters for the request
Returns Promise<ResponseList<Team>>
See
https://support.crowdin.com/enterprise/api/#operation/api.teams.getMany
- Defined in teams/index.ts:92
listTeams(limit?, offset?): Promise<ResponseList<Team>>
Parameters
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Team>>
Deprecated
optional parameters should be passed through an object

See
https://support.crowdin.com/enterprise/api/#operation/api.teams.getMany
- Defined in teams/index.ts:99

teamMembersList

teamMembersList(teamId, options?): Promise<ResponseList<TeamMember>>
Parameters
- teamId: number
  team identifier
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<TeamMember>>
See
https://support.crowdin.com/enterprise/api/#operation/api.teams.members.getMany
- Defined in teams/index.ts:159
teamMembersList(teamId, limit?, offset?): Promise<ResponseList<TeamMember>>
Parameters
- teamId: number
  team identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<TeamMember>>
Deprecated
optional parameters should be passed through an object

See
https://support.crowdin.com/enterprise/api/#operation/api.teams.members.getMany
- Defined in teams/index.ts:167

updateGroupTeams

updateGroupTeams(groupId, request): Promise<ResponseList<TeamGroup>>
Parameters
- groupId: number
  group identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseList<TeamGroup>>
See
https://support.crowdin.com/developer/enterprise/api/v2/#tag/Teams/operation/api.groups.teams.patch
- Defined in teams/index.ts:34

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:328

Class Teams

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Teams

Methods

addTeam

Parameters

Returns Promise<ResponseObject<Team>>

See

addTeamMembers

Parameters

Returns Promise<AddTeamMembersResponse>

See

addTeamToProject

Parameters

Returns Promise<ProjectTeamResources>

See

deleteAllTeamMembers

Parameters

Returns Promise<void>

See

deleteTeam

Parameters

Returns Promise<void>

See

deleteTeamMember

Parameters

Returns Promise<void>

See

editTeam

Parameters

Returns Promise<ResponseObject<Team>>

See

editTeamProjectPermissions

Parameters

Returns Promise<ResponseList<TeamsModel.ProjectPermissions>>

See

getGroupTeam

Parameters

Returns Promise<ResponseObject<TeamGroup>>

See

getTeam

Parameters

Returns Promise<ResponseObject<Team>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listGroupTeams

Parameters

Returns Promise<ResponseList<TeamGroup>>

See

listTeamProjectPermissions

Parameters

Returns Promise<ResponseList<TeamsModel.ProjectPermissions>>

See

listTeams

Parameters

Returns Promise<ResponseList<Team>>

See

Parameters

Returns Promise<ResponseList<Team>>

Deprecated

See

teamMembersList

Parameters

Returns Promise<ResponseList<TeamMember>>

See

Parameters

Returns Promise<ResponseList<TeamMember>>

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string