Module crowdin_api.api_resources.translations.resource

Classes

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

Resource for Translations.

Translators can work with entirely untranslated project or you can pre-translate the files to ease the translations process.

Use API to pre-translate files via Machine Translation (MT) or Translation Memory (TM), upload your existing translations, and download translations correspondingly. Pre-translate and build are asynchronous operations and shall be completed with sequence of API methods.

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

Ancestors

• BaseResource

Methods

def apply_pre_translation(self, languageIds: Iterable[str], fileIds: Iterable[int], projectId: Optional[int] = None, method: Optional[PreTranslationApplyMethod] = None, engineId: Optional[int] = None, aiPromptId: Optional[int] = None, autoApproveOption: Optional[PreTranslationAutoApproveOption] = None, duplicateTranslations: Optional[bool] = None, skipApprovedTranslations: Optional[bool] = None, translateUntranslatedOnly: Optional[bool] = None, translateWithPerfectMatchOnly: Optional[bool] = None, fallbackLanguages: Optional[Iterable[FallbackLanguages]] = None, labelIds: Optional[Iterable[int]] = None, excludeLabelIds: Optional[Iterable[int]] = None)

Apply Pre-Translation.

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

def build_crowdin_project_translation(self, projectId: Optional[int] = None, branchId: Optional[int] = None, targetLanguageIds: Optional[Iterable[str]] = None, skipUntranslatedStrings: Optional[bool] = None, skipUntranslatedFiles: Optional[bool] = None, exportApprovedOnly: Optional[bool] = None, exportWithMinApprovalsCount: Optional[int] = None)

Build Project Translation(Crowdin Translation Create Project Build Form).

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

def build_project_directory_translation(self, directoryId: int, projectId: Optional[int] = None, targetLanguageIds: Optional[Iterable[str]] = None, skipUntranslatedStrings: Optional[bool] = None, skipUntranslatedFiles: Optional[bool] = None, exportApprovedOnly: Optional[bool] = None)

Build Project Directory Translation.

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

def build_project_file_translation(self, fileId: int, targetLanguageId: str, projectId: Optional[int] = None, skipUntranslatedStrings: Optional[bool] = None, skipUntranslatedFiles: Optional[bool] = None, exportApprovedOnly: Optional[bool] = None, eTag: Optional[str] = None)

Build Project File Translation.

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

def build_project_translation(self, request_data: Dict[~KT, ~VT], projectId: Optional[int] = None)

Build Project Translation.

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

def build_pseudo_project_translation(self, pseudo: bool, projectId: Optional[int] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, lengthTransformation: Optional[int] = None, charTransformation: Optional[CharTransformation] = None)

Build Project Translation(Translation Create Project Pseudo Build Form).

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

def cancel_build(self, buildId: int, projectId: Optional[int] = None)

Cancel Build.

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

def check_project_build_status(self, buildId: int, projectId: Optional[int] = None)

Check Project Build Status.

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

def download_project_translations(self, buildId: int, projectId: Optional[int] = None)

Download Project Translations.

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

def edit_pre_translation(self, preTranslationId: str, data: Iterable[EditPreTranslationScheme], projectId: Optional[int] = None)

Edit Pre-Translation

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

def export_project_translation(self, targetLanguageId: str, projectId: Optional[int] = None, format: Optional[ExportProjectTranslationFormat] = None, labelIds: Optional[Iterable[int]] = None, branchIds: Optional[Iterable[int]] = None, directoryIds: Optional[Iterable[int]] = None, fileIds: Optional[Iterable[int]] = None, skipUntranslatedStrings: Optional[bool] = None, skipUntranslatedFiles: Optional[bool] = None, exportApprovedOnly: Optional[bool] = None)

Export Project Translation.

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

def get_builds_path(self, projectId: int, buildId: Optional[int] = None)

def list_pre_translations(self, projectId: Optional[int] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Pre-Translations

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

def list_project_builds(self, projectId: Optional[int] = None, branchId: Optional[int] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Project Builds.

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

def pre_translation_status(self, preTranslationId: str, projectId: Optional[int] = None)

Pre-Translation Status.

Link to documentation: https://developer.crowdin.com/api/v2/#tag/Translations/paths/~1projects~1{projectId}~1pre-translations~1{preTranslationId}/get

def upload_translation(self, languageId: str, storageId: int, fileId: int, projectId: Optional[int] = None, importEqSuggestions: Optional[bool] = None, autoApproveImported: Optional[bool] = None, translateHidden: Optional[bool] = None, addToTm: Optional[bool] = None)

Upload Translations.

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