Module crowdin_api.api_resources.string_translations.resource

Classes

class StringTranslationsResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for String Translations.

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

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/String-Translations

Ancestors

• BaseResource

Methods

def add_approval(self, translationId: Optional[int] = None, projectId: Optional[int] = None, correctionId: Optional[int] = None)

Add Approval.

Pass either translationId or correctionId (Crowdin Enterprise only).

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.approvals.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.approvals.post

def add_file_translations(self, fileId: int, languageId: str, storageId: int, projectId: Optional[int] = None)

Add Translation (upload translations of a file from storage).

File-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.translations.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.translations.post

def add_translation(self, stringId: int, languageId: str, text: str, projectId: Optional[int] = None, pluralCategoryName: Optional[PluralCategoryName] = None, addToTm: Optional[bool] = None, provider: Optional[TranslationProvider] = None, providerId: Optional[int] = None, isPreTranslated: Optional[bool] = None)

Add Translation.

provider is required when providerId or isPreTranslated is specified.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.translations.post

def add_vote(self, mark: VoteMark, translationId: int, projectId: Optional[int] = None)

Add Vote.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.votes.post

def approval_batch_operations(self, project_id: int, data: Iterable[ApprovalBatchOpPatchRequest])

Approval Batch Operations

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/String-Translations/operation/api.projects.approvals.patch

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Translations/operation/api.projects.approvals.patch

def cancel_vote(self, voteId: int, projectId: Optional[int] = None)

Cancel Vote.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.votes.delete

def delete_string_translations(self, stringId: Optional[int] = None, languageId: Optional[str] = None, projectId: Optional[int] = None, fileId: Optional[int] = None)

Delete String Translations.

Delete translations of a string (stringId) or of all strings in a file (fileId, file-based projects only). stringId is required in string-based projects.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.translations.deleteMany

def delete_translation(self, translationId: int, projectId: Optional[int] = None)

Delete Translation.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.translations.delete

def get_approval(self, approvalId: int, projectId: Optional[int] = None)

Get Approval.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.approvals.get

def get_approvals_path(self, projectId: int, approvalId: Optional[int] = None)

def get_translation(self, translationId: int, projectId: Optional[int] = None, denormalizePlaceholders: Optional[DenormalizePlaceholders] = None)

Get Translation.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.translations.get

def get_translation_votes_path(self, projectId: int, voteId: Optional[int] = None)

def get_translations_path(self, projectId: int, translationId: Optional[int] = None)

def get_vote(self, voteId: int, projectId: Optional[int] = None)

Get Vote.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.votes.get

def list_language_translations(self, languageId: str, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, stringIds: Optional[Iterable[int]] = None, labelIds: Optional[Iterable[int]] = None, fileId: Optional[int] = None, branchId: Optional[int] = None, directoryId: Optional[int] = None, croql: Optional[str] = None, denormalizePlaceholders: Optional[DenormalizePlaceholders] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None, approvedOnly: Union[bool, int, None] = None, passedWorkflow: Union[bool, int, None] = None, minApprovalCount: Optional[int] = None)

List Language Translations

fileId and directoryId are available in file-based projects only. orderBy and approvedOnly are available in Crowdin only; passedWorkflow and minApprovalCount in Crowdin Enterprise only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.languages.translations.getMany

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.languages.translations.getMany

def list_string_translations(self, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, stringId: Optional[int] = None, languageId: Optional[str] = None, denormalizePlaceholders: Optional[DenormalizePlaceholders] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None, fileId: Optional[int] = None)

List String Translations

languageId is required by the API. fileId is available in file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.translations.getMany

def list_translation_approvals(self, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, fileId: Optional[int] = None, labelIds: Optional[str] = None, excludeLabelIds: Optional[str] = None, stringId: Optional[int] = None, languageId: Optional[str] = None, translationId: Optional[int] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None, correctionId: Optional[int] = None)

List Translation Approvals

fileId is available in file-based projects only, correctionId in Crowdin Enterprise only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.approvals.getMany

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.approvals.getMany

def list_translation_votes(self, projectId: Optional[int] = None, stringId: Optional[int] = None, languageId: Optional[str] = None, translationId: Optional[int] = None, fileId: Optional[int] = None, labelIds: Optional[str] = None, excludeLabelIds: Optional[str] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Translation Votes

fileId is available in file-based projects only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.votes.getMany

def remove_approval(self, approvalId: int, projectId: Optional[int] = None)

Remove Approval.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.approvals.delete

def remove_string_approvals(self, stringId: Optional[int] = None, projectId: Optional[int] = None, fileId: Optional[int] = None)

Remove String Approvals

Remove approvals of a string (stringId) or of all strings in a file (fileId, file-based projects only). stringId is required in string-based projects.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/String-Translations/operation/api.projects.approvals.deleteMany

def restore_translation(self, translationId: int, projectId: Optional[int] = None)

Restore Translation.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.translations.put

def search_translations(self, filter: str, projectIds: Optional[Iterable[int]] = None, userId: Optional[int] = None, languageIds: Optional[Iterable[str]] = None, denormalizePlaceholders: Optional[DenormalizePlaceholders] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

Search Translations.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.translations.getMany https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.translations.getMany

def translation_alignment(self, sourceLanguageId: str, targetLanguageId: str, text: str, projectId: Optional[int] = None)

Translation Alignment

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.projects.translations.alignment.post

def translation_batch_operations(self, project_id: int, data: Iterable[TranslationBatchOpPatchRequest])

Translation Batch Operations

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/String-Translations/operation/api.projects.translations.patch

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/String-Translations/operation/api.projects.translations.patch