Translations endpoint

Translations documentation

Fetch all translations

translations(project_id[, params = None])
Parameters:

  • project_id (str) – ID of the project

  • params (dict) – (optional) Request parameters

Returns:

Collection of translations

Example:

translations = client.translations('123.abc', {
    "page": 2,
    "limit": 5,
    "disable_references": 1,
    "filter_untranslated": 1
})
translations.items[0].translation_id # => 220681321

Fetch a translation

translation(project_id, translation_id[, params = None])
Parameters:

  • project_id (str) – ID of the project

  • translation_id (int or str) – ID of the translation to fetch

  • params (dict) – (optional) Request parameters

Returns:

Task model

Example:

translation = client.translation('123.abc', 220681321, {
    "disable_references": 1
})
translation.translation # => "Welcome to the app!"
translation.language_iso # => "en_US"
translation.is_reviewed # => True

Update a translation

update_translation(project_id, translation_id, params)
Parameters:

  • project_id (str) – ID of the project

  • translation_id (int or str) – ID of the translation to update

  • params (dict) – Translation parameters

Returns:

Task model

Example:

translation = client.update_translation(PROJECT_ID, TRANSLATION_ID, {
    "translation": "Welcome again!",
    "custom_translation_status_ids": [429]
})
translation.translation # => "Welcome again!"
translation.custom_translation_statuses[0]['status_id'] # => 429