Class ProjectsGroups

Using projects, you can keep your source files sorted.

Use API to manage projects, change their settings, or remove them if required.

Only Crowdin Enterprise: Groups allow you to organize your projects based on specific characteristics. Using projects, you can keep your source files sorted.

Hierarchy (view full)

CrowdinApi
- ProjectsGroups

Constructors

constructor

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

Methods

deleteGroup

deleteGroup(groupId): Promise<void>
Parameters
- groupId: number
  group identifier
Returns Promise<void>
See
https://support.crowdin.com/enterprise/api/#operation/api.groups.delete
- Defined in projectsGroups/index.ts:84

deleteProject

deleteProject(projectId): Promise<void>
Parameters
- projectId: number
  project identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.delete
- Defined in projectsGroups/index.ts:168

deleteProjectFileFormatSettings

deleteProjectFileFormatSettings(projectId, fileFormatSettingsId): Promise<void>
Parameters
- projectId: number
  project identifier
- fileFormatSettingsId: number
  file format settings identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.delete
- Defined in projectsGroups/index.ts:256

deleteProjectStringsExporterSettings

deleteProjectStringsExporterSettings(projectId, systemStringsExporterSettingsId): Promise<void>
Parameters
- projectId: number
  project identifier
- systemStringsExporterSettingsId: number
  file format settings identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.delete
- Defined in projectsGroups/index.ts:320

downloadProjectFileFormatSettingsCustomSegmentation

downloadProjectFileFormatSettingsCustomSegmentation(projectId, fileFormatSettingsId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- fileFormatSettingsId: number
  file format settings identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.custom-segmentations.get
- Defined in projectsGroups/index.ts:191

editGroup

editGroup(groupId, request): Promise<ResponseObject<ProjectsGroupsModel.Group>>
Parameters
- groupId: number
  group identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<ProjectsGroupsModel.Group>>
See
https://support.crowdin.com/enterprise/api/#operation/api.groups.patch
- Defined in projectsGroups/index.ts:94

editProject

editProject(projectId, request): Promise<ResponseObject<Project | ProjectSettings>>
Parameters
- projectId: number
  project identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Project | ProjectSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.patch
- Defined in projectsGroups/index.ts:178

editProjectFileFormatSettings

editProjectFileFormatSettings(projectId, fileFormatSettingsId, request): Promise<ResponseObject<ProjectFileFormatSettings>>
Parameters
- projectId: number
  project identifier
- fileFormatSettingsId: number
  file format settings identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<ProjectFileFormatSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.patch
- Defined in projectsGroups/index.ts:267

editProjectStringsExporterSettings

editProjectStringsExporterSettings(projectId, systemStringsExporterSettingsId, request): Promise<ResponseObject<ProjectStringsExporterSettings>>
Parameters
- projectId: number
  project identifier
- systemStringsExporterSettingsId: number
  file format settings identifier
- request: AddProjectStringsExporterSettingsRequest
  request body
Returns Promise<ResponseObject<ProjectStringsExporterSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.patch
- Defined in projectsGroups/index.ts:331

getGroup

getGroup(groupId): Promise<ResponseObject<ProjectsGroupsModel.Group>>
Parameters
- groupId: number
Returns Promise<ResponseObject<ProjectsGroupsModel.Group>>
See
https://support.crowdin.com/enterprise/api/#operation/api.groups.get
- Defined in projectsGroups/index.ts:75

getProject

getProject(projectId): Promise<ResponseObject<Project | ProjectSettings>>
Parameters
- projectId: number
  project identifier
Returns Promise<ResponseObject<Project | ProjectSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.get
- Defined in projectsGroups/index.ts:157

getProjectFileFormatSettings

getProjectFileFormatSettings(projectId, fileFormatSettingsId): Promise<ResponseObject<ProjectFileFormatSettings>>
Parameters
- projectId: number
  project identifier
- fileFormatSettingsId: number
  file format settings identifier
Returns Promise<ResponseObject<ProjectFileFormatSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.get
- Defined in projectsGroups/index.ts:243

getProjectStringsExporterSettings

getProjectStringsExporterSettings(projectId, systemStringsExporterSettingsId): Promise<ResponseObject<ProjectStringsExporterSettings>>
Parameters
- projectId: number
  project identifier
- systemStringsExporterSettingsId: number
  file format settings identifier
Returns Promise<ResponseObject<ProjectStringsExporterSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.get
- Defined in projectsGroups/index.ts:307

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

listGroups

listGroups(options?): Promise<ResponseList<ProjectsGroupsModel.Group>>
Parameters
- Optionaloptions: ListGroupsOptions
  optional parameters for the request
Returns Promise<ResponseList<ProjectsGroupsModel.Group>>
See
https://support.crowdin.com/enterprise/api/#operation/api.groups.getMany
- Defined in projectsGroups/index.ts:26
listGroups(parentId?, offset?, userId?, limit?): Promise<ResponseList<ProjectsGroupsModel.Group>>
Parameters
- OptionalparentId: number
  parent group identifier
- Optionaloffset: number
  starting offset in the collection (default 0)
- OptionaluserId: number
  get user own projects
- Optionallimit: number
  maximum number of items to retrieve (default 25)
Returns Promise<ResponseList<ProjectsGroupsModel.Group>>
Deprecated
optional parameters should be passed through an object

See
https://support.crowdin.com/enterprise/api/#operation/api.groups.getMany
- Defined in projectsGroups/index.ts:35

listProjectFileFormatSettings

listProjectFileFormatSettings(projectId, options?): Promise<ResponseList<ProjectFileFormatSettings>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<ProjectFileFormatSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.getMany
- Defined in projectsGroups/index.ts:217

listProjects

listProjects(options?): Promise<ResponseList<Project | ProjectSettings>>
Parameters
- Optionaloptions: ListProjectsOptions
  optional parameters for the request
Returns Promise<ResponseList<Project | ProjectSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.getMany
- Defined in projectsGroups/index.ts:103
listProjects(groupId?, hasManagerAccess?, limit?, offset?): Promise<ResponseList<Project | ProjectSettings>>
Parameters
- OptionalgroupId: number
  group identifier
- OptionalhasManagerAccess: BooleanInt
  projects with manager access (default 0)
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Project | ProjectSettings>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.getMany
- Defined in projectsGroups/index.ts:114

listProjectStringsExporterSettings

listProjectStringsExporterSettings(projectId, options?): Promise<ResponseList<ProjectStringsExporterSettings>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: Partial<Pagination>
  optional parameters for the request
Returns Promise<ResponseList<ProjectStringsExporterSettings>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.strings-exporter-settings.getMany
- Defined in projectsGroups/index.ts:281

resetProjectFileFormatSettingsCustomSegmentation

resetProjectFileFormatSettingsCustomSegmentation(projectId, fileFormatSettingsId): Promise<ResponseObject<DownloadLink>>
Parameters
- projectId: number
  project identifier
- fileFormatSettingsId: number
  file format settings identifier
Returns Promise<ResponseObject<DownloadLink>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.file-format-settings.custom-segmentations.delete
- Defined in projectsGroups/index.ts:204

withFetchAll

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

Class ProjectsGroups

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ProjectsGroups

Methods

addGroup

Parameters

Returns Promise<ResponseObject<ProjectsGroupsModel.Group>>

See

addProject

Parameters

Returns Promise<ResponseObject<Project | ProjectSettings>>

See

addProjectFileFormatSettings

Parameters

Returns Promise<ResponseObject<ProjectFileFormatSettings>>

See

addProjectStringsExporterSettings

Parameters

Returns Promise<ResponseObject<ProjectStringsExporterSettings>>

See

deleteGroup

Parameters

Returns Promise<void>

See

deleteProject

Parameters

Returns Promise<void>

See

deleteProjectFileFormatSettings

Parameters

Returns Promise<void>

See

deleteProjectStringsExporterSettings

Parameters

Returns Promise<void>

See

downloadProjectFileFormatSettingsCustomSegmentation

Parameters

Returns Promise<ResponseObject<DownloadLink>>

See

editGroup

Parameters

Returns Promise<ResponseObject<ProjectsGroupsModel.Group>>

See

editProject

Parameters

Returns Promise<ResponseObject<Project | ProjectSettings>>

See

editProjectFileFormatSettings

Parameters

Returns Promise<ResponseObject<ProjectFileFormatSettings>>

See

editProjectStringsExporterSettings

Parameters

Returns Promise<ResponseObject<ProjectStringsExporterSettings>>

See

getGroup

Parameters

Returns Promise<ResponseObject<ProjectsGroupsModel.Group>>

See

getProject

Parameters

Returns Promise<ResponseObject<Project | ProjectSettings>>

See

getProjectFileFormatSettings

Parameters

Returns Promise<ResponseObject<ProjectFileFormatSettings>>

See

getProjectStringsExporterSettings

Parameters

Returns Promise<ResponseObject<ProjectStringsExporterSettings>>

See

graphql

Type Parameters

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string