Class StringTranslations

Use API to add or remove strings translations, approvals, and votes.

Hierarchy (view full)

CrowdinApi
- StringTranslations

Constructors

constructor

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

Methods

approvalBatchOperations

approvalBatchOperations(projectId, request): Promise<ResponseList<Approval>>
Parameters
- projectId: number
  project identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseList<Approval>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.patch
- Defined in stringTranslations/index.ts:122

approvalInfo

approvalInfo(projectId, approvalId): Promise<ResponseObject<Approval>>
Parameters
- projectId: number
  project identifier
- approvalId: number
  approval identifier
Returns Promise<ResponseObject<Approval>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.get
- Defined in stringTranslations/index.ts:112

cancelVote

cancelVote(projectId, voteId): Promise<void>
Parameters
- projectId: number
  project identifier
- voteId: number
  vote identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.votes.delete
- Defined in stringTranslations/index.ts:462

deleteAllTranslations

deleteAllTranslations(projectId, stringId, languageId?): Promise<void>
Parameters
- projectId: number
  project identifier
- stringId: number
  string identifier
- OptionallanguageId: string
  language identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.deleteMany
- Defined in stringTranslations/index.ts:316

deleteTranslation

deleteTranslation(projectId, translationId): Promise<void>
Parameters
- projectId: number
  project identifier
- translationId: number
  translation identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.delete
- Defined in stringTranslations/index.ts:367

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

listLanguageTranslations

listLanguageTranslations(projectId, languageId, options?): Promise<ResponseList<PlainLanguageTranslation | PluralLanguageTranslation | IcuLanguageTranslation>>
Parameters
- projectId: number
  project identifier
- languageId: string
  language identifier
- Optionaloptions: ListLanguageTranslationsOptions
  optional parameters for the request
Returns Promise<ResponseList<PlainLanguageTranslation | PluralLanguageTranslation | IcuLanguageTranslation>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.languages.translations.getMany
- Defined in stringTranslations/index.ts:146
listLanguageTranslations(projectId, languageId, stringIds?, fileId?, limit?, offset?, labelIds?, denormalizePlaceholders?, croql?): Promise<ResponseList<PlainLanguageTranslation | PluralLanguageTranslation | IcuLanguageTranslation>>
Parameters
- projectId: number
  project identifier
- languageId: string
  language identifier
- OptionalstringIds: string
  filter translations by stringIds
- OptionalfileId: number
  filter translations by fileId
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- OptionallabelIds: string
  filter translations by fileId
- OptionaldenormalizePlaceholders: BooleanInt
  enable denormalize placeholders
- Optionalcroql: string
  filter translations by CroQL (Can't be used with stringIds, labelIds or fileId in same request)
Returns Promise<ResponseList<PlainLanguageTranslation | PluralLanguageTranslation | IcuLanguageTranslation>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.languages.translations.getMany
- Defined in stringTranslations/index.ts:170

listStringTranslations

listStringTranslations(projectId, stringId, languageId, options?): Promise<ResponseList<StringTranslation>>
Parameters
- projectId: number
  project identifier
- stringId: number
  string identifier
- languageId: string
  language identifier
- Optionaloptions: ListStringTranslationsOptions
  optional parameters for the request
Returns Promise<ResponseList<StringTranslation>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.getMany
- Defined in stringTranslations/index.ts:250
listStringTranslations(projectId, stringId, languageId, limit?, offset?, denormalizePlaceholders?): Promise<ResponseList<StringTranslation>>
Parameters
- projectId: number
  project identifier
- stringId: number
  string identifier
- languageId: string
  language identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- OptionaldenormalizePlaceholders: BooleanInt
  enable denormalize placeholders
Returns Promise<ResponseList<StringTranslation>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.getMany
- Defined in stringTranslations/index.ts:266

listTranslationApprovals

listTranslationApprovals(projectId, options?): Promise<ResponseList<Approval>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListTranslationApprovalsOptions
  optional parameters for the request
Returns Promise<ResponseList<Approval>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.getMany
- Defined in stringTranslations/index.ts:21
listTranslationApprovals(projectId, stringId?, languageId?, translationId?, limit?, offset?, fileId?, labelIds?, excludeLabelIds?): Promise<ResponseList<Approval>>
Parameters
- projectId: number
  project identifier
- OptionalstringId: number
  string identifier
- OptionallanguageId: string
  language identifier
- OptionaltranslationId: number
  translation identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
- OptionalfileId: number
  file identifier
- OptionallabelIds: string
  label Identifiers
- OptionalexcludeLabelIds: string
  exclude label Identifiers
Returns Promise<ResponseList<Approval>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.getMany
- Defined in stringTranslations/index.ts:38

listTranslationVotes

listTranslationVotes(projectId, options?): Promise<ResponseList<Vote>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListTranslationVotesOptions
  optional parameters for the request
Returns Promise<ResponseList<Vote>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.votes.getMany
- Defined in stringTranslations/index.ts:377
listTranslationVotes(projectId, stringId?, languageId?, translationId?, labelIds?, excludeLabelIds?, limit?, offset?): Promise<ResponseList<Vote>>
Parameters
- projectId: number
  project identifier
- OptionalstringId: number
  string identifier
- OptionallanguageId: string
  language identifier
- OptionaltranslationId: number
  translation identifier
- OptionallabelIds: string
  label Identifiers
- OptionalexcludeLabelIds: string
  exclude label Identifiers
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Vote>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.votes.getMany
- Defined in stringTranslations/index.ts:393

removeApproval

removeApproval(projectId, approvalId): Promise<void>
Parameters
- projectId: number
  project identifier
- approvalId: number
  approval identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.approvals.delete
- Defined in stringTranslations/index.ts:135

removeStringApprovals

removeStringApprovals(projectId, stringId): Promise<void>
Parameters
- projectId: number
  project identifier
- stringId: number
  string identifier
Returns Promise<void>
See
https://support.crowdin.com/developer/api/v2/#tag/String-Translations/operation/api.projects.approvals.deleteMany
- Defined in stringTranslations/index.ts:101

restoreTranslation

restoreTranslation(projectId, translationId): Promise<ResponseObject<StringTranslation>>
Parameters
- projectId: number
  project identifier
- translationId: number
  translation identifier
Returns Promise<ResponseObject<StringTranslation>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.put
- Defined in stringTranslations/index.ts:341

translationAlignment

translationAlignment(projectId, request): Promise<ResponseObject<TranslationAlignmentResponse>>
Parameters
- projectId: number
  project identifier
- request: TranslationAlignmentRequest
  request body
Returns Promise<ResponseObject<TranslationAlignmentResponse>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.alignment.post
- Defined in stringTranslations/index.ts:235

translationBatchOperations

translationBatchOperations(projectId, request): Promise<ResponseList<StringTranslation>>
Parameters
- projectId: number
  project identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseList<StringTranslation>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.patch
- Defined in stringTranslations/index.ts:354

translationInfo

translationInfo(projectId, translationId): Promise<ResponseObject<StringTranslation>>
Parameters
- projectId: number
  project identifier
- translationId: number
  translation identifier
Returns Promise<ResponseObject<StringTranslation>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.translations.get
- Defined in stringTranslations/index.ts:328

voteInfo

voteInfo(projectId, voteId): Promise<ResponseObject<Vote>>
Parameters
- projectId: number
  project identifier
- voteId: number
  vote identifier
Returns Promise<ResponseObject<Vote>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.votes.get
- Defined in stringTranslations/index.ts:452

withFetchAll

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

Class StringTranslations

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns StringTranslations

Methods

addApproval

Parameters

Returns Promise<ResponseObject<Approval>>

See

addTranslation

Parameters

Returns Promise<ResponseObject<StringTranslation>>

See

addVote

Parameters

Returns Promise<ResponseObject<Vote>>

See

approvalBatchOperations

Parameters

Returns Promise<ResponseList<Approval>>

See

approvalInfo

Parameters

Returns Promise<ResponseObject<Approval>>

See

cancelVote

Parameters

Returns Promise<void>

See

deleteAllTranslations

Parameters

Returns Promise<void>

See

deleteTranslation

Parameters

Returns Promise<void>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

listLanguageTranslations

Parameters

Returns Promise<ResponseList<PlainLanguageTranslation | PluralLanguageTranslation | IcuLanguageTranslation>>

See

Parameters

Returns Promise<ResponseList<PlainLanguageTranslation | PluralLanguageTranslation | IcuLanguageTranslation>>

Deprecated

See

listStringTranslations

Parameters

Returns Promise<ResponseList<StringTranslation>>

See

Parameters

Returns Promise<ResponseList<StringTranslation>>

Deprecated

See

listTranslationApprovals

Parameters

Returns Promise<ResponseList<Approval>>

See

Parameters

Returns Promise<ResponseList<Approval>>

Deprecated

See

listTranslationVotes

Parameters

Returns Promise<ResponseList<Vote>>

See

Parameters

Returns Promise<ResponseList<Vote>>

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string