Phrase::LocalesApi

All URIs are relative to https://api.phrase.com/v2

Method	HTTP request	Description
account_locales	GET /accounts/{id}/locales	List locales used in account
locale_create	POST /projects/{project_id}/locales	Create a locale
locale_delete	DELETE /projects/{project_id}/locales/{id}	Delete a locale
locale_download	GET /projects/{project_id}/locales/{id}/download	Download a locale
locale_show	GET /projects/{project_id}/locales/{id}	Get a single locale
locale_update	PATCH /projects/{project_id}/locales/{id}	Update a locale
locales_list	GET /projects/{project_id}/locales	List locales

account_locales

Array<LocalePreview1> account_locales(id, opts)

List locales used in account

List all locales unique by locale code used across all projects within an account.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::LocalesApi.new
id = 'id_example' # String | ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  page: 1, # Integer | Page number
  per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
}

begin
  #List locales used in account
  result = api_instance.account_locales(id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling LocalesApi->account_locales: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
page	Integer	Page number	[optional]
per_page	Integer	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]

Return type

Response<(Array<LocalePreview1>)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

locale_create

LocaleDetails locale_create(project_id, locale_create_parameters, opts)

Create a locale

Create a new locale.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::LocalesApi.new
project_id = 'project_id_example' # String | Project ID
locale_create_parameters = Phrase::LocaleCreateParameters.new({name: 'de', code: 'de-DE'}) # LocaleCreateParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Create a locale
  result = api_instance.locale_create(project_id, locale_create_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling LocalesApi->locale_create: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
locale_create_parameters	LocaleCreateParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(LocaleDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

locale_delete

locale_delete(project_id, id, opts)

Delete a locale

Delete an existing locale.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::LocalesApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Locale ID or locale name
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch' # String | specify the branch to use
}

begin
  #Delete a locale
  api_instance.locale_delete(project_id, id, opts)
rescue Phrase::ApiError => e
  puts "Exception when calling LocalesApi->locale_delete: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	Locale ID or locale name
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]

Return type

Response<(nil (empty response body))>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

locale_download

File locale_download(project_id, id, opts)

Download a locale

Download a locale in a specific file format.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::LocalesApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Locale ID or locale name
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  if_modified_since: 'if_modified_since_example', # String | Last modified condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
  if_none_match: 'if_none_match_example', # String | ETag condition, see [Conditional GET requests / HTTP Caching](/en/api/strings/pagination#conditional-get-requests-%2F-http-caching) (optional)
  branch: 'my-feature-branch', # String | specify the branch to use
  file_format: 'yml', # String | File format name. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for all supported file formats.
  tags: 'feature1,feature2', # String | Limit results to keys tagged with a list of comma separated tag names.
  tag: 'feature', # String | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
  include_empty_translations: true, # Boolean | Indicates whether keys without translations should be included in the output as well.
  exclude_empty_zero_forms: true, # Boolean | Indicates whether zero forms should be included when empty in pluralized keys.
  include_translated_keys: true, # Boolean | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
  keep_notranslate_tags: true, # Boolean | Indicates whether [NOTRANSLATE] tags should be kept.
  convert_emoji: true, # Boolean | This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
  format_options: { key: 3.56}, # Object | Additional formatting and render options. See the [format guide](https://support.phrase.com/hc/en-us/sections/6111343326364) for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar`
  encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
  skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with `include_unverified_translations`.
  include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
  use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
  fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires `include_empty_translations` to be set to `true` unless `fallback_for_unverified_translations` is also set to `true`. Mutually exclusive with `use_locale_fallback`. 
  use_locale_fallback: true, # Boolean | If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Fallback locale is defined in [locale's settings](/en/api/strings/locales/update-a-locale#body-fallback-locale-id). Requires `include_empty_translations` to be set to `true` unless `fallback_for_unverified_translations` is also set to `true`. Mutually exclusive with `fallback_locale_id`. 
  fallback_for_unverified_translations: true, # Boolean | If set to `true`, translations in a non-final state are replaced by the fallback locale's translation at export time. In the simple workflow, \"non-final\" means `unverified`. In the review workflow, it additionally includes `translated` (awaiting review). No stored translations are modified. Requires `fallback_locale_id` or `use_locale_fallback` to be set; a `422` validation error is returned otherwise. 
  source_locale_id: 'source_locale_id_example', # String | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job.
  translation_key_prefix: 'prefix_', # String | Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed.
  filter_by_prefix: true, # Boolean | Only download translation keys containing the prefix specified by `translation_key_prefix`, and remove that prefix from the generated file. Requires `translation_key_prefix` to be set.
  custom_metadata_filters: { key: 3.56}, # Object | Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. 
  locale_ids: ['inner_example'], # Array<String> | Locale IDs or locale names
  updated_since: '2023-01-01T00:00:00Z' # String | Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`). 
}

begin
  #Download a locale
  result = api_instance.locale_download(project_id, id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling LocalesApi->locale_download: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	Locale ID or locale name
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
if_modified_since	String	Last modified condition, see Conditional GET requests / HTTP Caching (optional)	[optional]
if_none_match	String	ETag condition, see Conditional GET requests / HTTP Caching (optional)	[optional]
branch	String	specify the branch to use	[optional]
file_format	String	File format name. See the format guide for all supported file formats.	[optional]
tags	String	Limit results to keys tagged with a list of comma separated tag names.	[optional]
tag	String	Limit download to tagged keys. This parameter is deprecated. Please use the "tags" parameter instead	[optional]
include_empty_translations	Boolean	Indicates whether keys without translations should be included in the output as well.	[optional]
exclude_empty_zero_forms	Boolean	Indicates whether zero forms should be included when empty in pluralized keys.	[optional]
include_translated_keys	Boolean	Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.	[optional]
keep_notranslate_tags	Boolean	Indicates whether [NOTRANSLATE] tags should be kept.	[optional]
convert_emoji	Boolean	This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.	[optional]
format_options	Object	Additional formatting and render options. See the format guide for a list of options available for each format. Specify format options like this: `...&format_options[foo]=bar`	[optional]
encoding	String	Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1".	[optional]
skip_unverified_translations	Boolean	Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with `include_unverified_translations`.	[optional]
include_unverified_translations	Boolean	if set to false unverified translations are excluded	[optional]
use_last_reviewed_version	Boolean	If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.	[optional]
fallback_locale_id	String	If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires `include_empty_translations` to be set to `true` unless `fallback_for_unverified_translations` is also set to `true`. Mutually exclusive with `use_locale_fallback`.	[optional]
use_locale_fallback	Boolean	If a key has no translation in the locale being downloaded, the translation in the fallback locale will be used. Fallback locale is defined in locale's settings. Requires `include_empty_translations` to be set to `true` unless `fallback_for_unverified_translations` is also set to `true`. Mutually exclusive with `fallback_locale_id`.	[optional]
fallback_for_unverified_translations	Boolean	If set to `true`, translations in a non-final state are replaced by the fallback locale's translation at export time. In the simple workflow, "non-final" means `unverified`. In the review workflow, it additionally includes `translated` (awaiting review). No stored translations are modified. Requires `fallback_locale_id` or `use_locale_fallback` to be set; a `422` validation error is returned otherwise.	[optional]
source_locale_id	String	Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a `tag` parameter indicating a specific job.	[optional]
translation_key_prefix	String	Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed.	[optional]
filter_by_prefix	Boolean	Only download translation keys containing the prefix specified by `translation_key_prefix`, and remove that prefix from the generated file. Requires `translation_key_prefix` to be set.	[optional]
custom_metadata_filters	Object	Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.	[optional]
locale_ids	Array<String>	Locale IDs or locale names	[optional]
updated_since	String	Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).	[optional]

Return type

Response<(File)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: *

locale_show

LocaleDetails locale_show(project_id, id, opts)

Get a single locale

Get details on a single locale for a given project.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::LocalesApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Locale ID or locale name
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  branch: 'my-feature-branch' # String | specify the branch to use
}

begin
  #Get a single locale
  result = api_instance.locale_show(project_id, id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling LocalesApi->locale_show: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	Locale ID or locale name
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
branch	String	specify the branch to use	[optional]

Return type

Response<(LocaleDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

locale_update

LocaleDetails locale_update(project_id, id, locale_update_parameters, opts)

Update a locale

Update an existing locale.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::LocalesApi.new
project_id = 'project_id_example' # String | Project ID
id = 'id_example' # String | Locale ID or locale name
locale_update_parameters = Phrase::LocaleUpdateParameters.new # LocaleUpdateParameters | 
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
}

begin
  #Update a locale
  result = api_instance.locale_update(project_id, id, locale_update_parameters, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling LocalesApi->locale_update: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
id	String	Locale ID or locale name
locale_update_parameters	LocaleUpdateParameters
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]

Return type

Response<(LocaleDetails)>

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

locales_list

Array<Locale> locales_list(project_id, opts)

List locales

List all locales for the given project.

Example

# load the gem
require 'phrase'
# setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::LocalesApi.new
project_id = 'project_id_example' # String | Project ID
opts = {
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
  page: 1, # Integer | Page number
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
  sort_by: 'sort_by_example', # String | Sort locales. Valid options are \"name_asc\", \"name_desc\", \"default_asc\", \"default_desc\".
  branch: 'my-feature-branch', # String | specify the branch to use
  q: 'name:en' # String | Specify a query to filter locales. Currently supports `name` argument, filtering only locales with names starting with the given string.
}

begin
  #List locales
  result = api_instance.locales_list(project_id, opts)
  pp result
rescue Phrase::ApiError => e
  puts "Exception when calling LocalesApi->locales_list: #{e}"
end

Parameters

Name	Type	Description	Notes
project_id	String	Project ID
x_phrase_app_otp	String	Two-Factor-Authentication token (optional)	[optional]
page	Integer	Page number	[optional]
per_page	Integer	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]
sort_by	String	Sort locales. Valid options are "name_asc", "name_desc", "default_asc", "default_desc".	[optional]
branch	String	specify the branch to use	[optional]
q	String	Specify a query to filter locales. Currently supports `name` argument, filtering only locales with names starting with the given string.	[optional]

Return type

Response<(Array<Locale>)>

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

LocalesApi.md

Latest commit

History

LocalesApi.md

File metadata and controls

Phrase::LocalesApi

account_locales

Example

Parameters

Return type

Authorization

HTTP request headers

locale_create

Example

Parameters

Return type

Authorization

HTTP request headers

locale_delete

Example

Parameters

Return type

Authorization

HTTP request headers

locale_download

Example

Parameters

Return type

Authorization

HTTP request headers

locale_show

Example

Parameters

Return type

Authorization

HTTP request headers

locale_update

Example

Parameters

Return type

Authorization

HTTP request headers

locales_list

Example

Parameters

Return type

Authorization

HTTP request headers