Module crowdin_api.api_resources.translation_status.resource

Classes

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

Resource for Translation Status.

Status represents the general localization progress on both translations and proofreading.

Use API to check translation and proofreading progress on different levels: file, language, branch, directory.

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

Ancestors

• BaseResource

Methods

def cancel_qa_checks_revalidation(self, projectId: Optional[int] = None, revalidationId: Optional[str] = None)

Cancel QA Checks Revalidation.

Cancels the QA checks revalidation job identified by revalidationId (the identifier returned by start_qa_checks_revalidation). Omitting revalidationId is deprecated.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Translation-Status/operation/api.projects.qa-checks.revalidate.delete

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

Get Branch Progress.

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

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

Get Directory Progress.

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

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

Get File Progress.

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

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

Get Language Progress.

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

def get_project_progress(self, projectId: Optional[int] = None, languageIds: Optional[Iterable[str]] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None)

Get Project Progress.

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

def get_qa_checks_revalidation_path(self, projectId: int, revalidationId: Optional[str] = None)

def get_qa_checks_revalidation_status(self, projectId: Optional[int] = None, revalidationId: Optional[str] = None)

Get QA Checks Revalidation Status.

Returns the status of the QA checks revalidation job identified by revalidationId (the identifier returned by start_qa_checks_revalidation). Omitting revalidationId is deprecated.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Translation-Status/operation/api.projects.qa-checks.revalidate.get

def list_qa_check_issues(self, projectId: Optional[int] = None, category: Optional[Iterable[Category]] = None, validation: Optional[Iterable[Validation]] = None, languageIds: Optional[Iterable[str]] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None, taskId: Optional[int] = None, fileId: Optional[int] = None, branchId: Optional[int] = None)

List QA Check Issues.

fileId is available in file-based projects only, branchId in string-based projects only.

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

def start_qa_checks_revalidation(self, projectId: Optional[int] = None, qaCheckCategories: Optional[Iterable[QaChecksRevalidationCategory]] = None, languageIds: Optional[Iterable[str]] = None, failedOnly: Optional[bool] = None, externalQaCheckIds: Optional[Iterable[int]] = None)

Start QA Checks Revalidation.

Triggers a new QA checks revalidation job for the project.

externalQaCheckIds is available in Crowdin Enterprise only.

Link to documentation: https://support.crowdin.com/developer/api/v2/#tag/Translation-Status/operation/api.projects.qa-checks.revalidate.post

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Translation-Status/operation/api.projects.qa-checks.revalidate.post

def validate_text_by_qa_checks(self, data: Iterable[ValidateQaChecksRequest], projectId: Optional[int] = None)

Validate Text by QA Checks.

Runs QA checks against the passed texts without saving them as translations.

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

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