phrase 0.4.33 → 1.0.1

data/docs/KeysSearchParameters.md

@@ -0,0 +1,25 @@
+# Phrase::KeysSearchParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional] 
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
+**q** | **String** | q_description_placeholder | [optional] 
+**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysSearchParameters.new(branch: my-feature-branch,
+                                 sort: updated_at,
+                                 order: desc,
+                                 q: mykey* translated:true,
+                                 locale_id: abcd1234abcd1234abcd1234abcd1234)
+```
+
+

data/docs/KeysTagParameters.md

@@ -0,0 +1,23 @@
+# Phrase::KeysTagParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**q** | **String** | q_description_placeholder | [optional] 
+**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
+**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysTagParameters.new(branch: my-feature-branch,
+                                 q: mykey* translated:true,
+                                 locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 tags: landing-page,release-1.2)
+```
+
+

data/docs/KeysUntagParameters.md

@@ -0,0 +1,23 @@
+# Phrase::KeysUntagParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**q** | **String** | q_description_placeholder | [optional] 
+**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
+**tags** | **String** | Tag or comma-separated list of tags to remove from the matching collection of keys | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysUntagParameters.new(branch: my-feature-branch,
+                                 q: mykey* translated:true,
+                                 locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 tags: landing-page,release-1.2)
+```
+
+

data/docs/Locale.md

@@ -0,0 +1,35 @@
+# Phrase::Locale
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**code** | **String** |  | [optional] 
+**default** | **Boolean** |  | [optional] 
+**main** | **Boolean** |  | [optional] 
+**rtl** | **Boolean** |  | [optional] 
+**plural_forms** | **Array<String>** |  | [optional] 
+**source_locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Locale.new(id: null,
+                                 name: null,
+                                 code: null,
+                                 default: null,
+                                 main: null,
+                                 rtl: null,
+                                 plural_forms: null,
+                                 source_locale: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/LocaleCreateParameters.md

@@ -0,0 +1,35 @@
+# Phrase::LocaleCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**name** | **String** | Locale name | [optional] 
+**code** | **String** | Locale ISO code | [optional] 
+**default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional] 
+**main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Verification System</a> feature. | [optional] 
+**rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional] 
+**source_locale_id** | **String** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional] 
+**unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
+**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
+**autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleCreateParameters.new(branch: my-feature-branch,
+                                 name: de,
+                                 code: de-DE,
+                                 default: null,
+                                 main: null,
+                                 rtl: null,
+                                 source_locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 unverify_new_translations: null,
+                                 unverify_updated_translations: null,
+                                 autotranslate: null)
+```
+
+

data/docs/LocaleDetails.md

@@ -0,0 +1,37 @@
+# Phrase::LocaleDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**code** | **String** |  | [optional] 
+**default** | **Boolean** |  | [optional] 
+**main** | **Boolean** |  | [optional] 
+**rtl** | **Boolean** |  | [optional] 
+**plural_forms** | **Array<String>** |  | [optional] 
+**source_locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**statistics** | [**LocaleStatistics**](LocaleStatistics.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleDetails.new(id: null,
+                                 name: null,
+                                 code: null,
+                                 default: null,
+                                 main: null,
+                                 rtl: null,
+                                 plural_forms: null,
+                                 source_locale: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 statistics: null)
+```
+
+

data/docs/LocaleDetails1.md

@@ -0,0 +1,17 @@
+# Phrase::LocaleDetails1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statistics** | [**LocaleStatistics**](LocaleStatistics.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleDetails1.new(statistics: null)
+```
+
+

data/docs/LocalePreview.md

@@ -0,0 +1,21 @@
+# Phrase::LocalePreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**code** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocalePreview.new(id: null,
+                                 name: null,
+                                 code: null)
+```
+
+

data/docs/LocaleStatistics.md

@@ -0,0 +1,29 @@
+# Phrase::LocaleStatistics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**keys_total_count** | **Integer** |  | [optional] 
+**keys_untranslated_count** | **Integer** |  | [optional] 
+**words_total_count** | **Integer** |  | [optional] 
+**translations_completed_count** | **Integer** |  | [optional] 
+**translations_unverified_count** | **Integer** |  | [optional] 
+**unverified_words_count** | **Integer** |  | [optional] 
+**missing_words_count** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleStatistics.new(keys_total_count: null,
+                                 keys_untranslated_count: null,
+                                 words_total_count: null,
+                                 translations_completed_count: null,
+                                 translations_unverified_count: null,
+                                 unverified_words_count: null,
+                                 missing_words_count: null)
+```
+
+

data/docs/LocaleUpdateParameters.md

@@ -0,0 +1,35 @@
+# Phrase::LocaleUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**name** | **String** | Locale name | [optional] 
+**code** | **String** | Locale ISO code | [optional] 
+**default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional] 
+**main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Verification System</a> feature. | [optional] 
+**rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional] 
+**source_locale_id** | **String** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional] 
+**unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
+**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
+**autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleUpdateParameters.new(branch: my-feature-branch,
+                                 name: de,
+                                 code: de-DE,
+                                 default: null,
+                                 main: null,
+                                 rtl: null,
+                                 source_locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 unverify_new_translations: null,
+                                 unverify_updated_translations: null,
+                                 autotranslate: null)
+```
+
+

data/docs/LocalesApi.md

@@ -0,0 +1,433 @@
+# Phrase::LocalesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**locale_create**](LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
+[**locale_delete**](LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
+[**locale_download**](LocalesApi.md#locale_download) | **GET** /projects/{project_id}/locales/{id}/download | Download a locale
+[**locale_show**](LocalesApi.md#locale_show) | **GET** /projects/{project_id}/locales/{id} | Get a single locale
+[**locale_update**](LocalesApi.md#locale_update) | **PATCH** /projects/{project_id}/locales/{id} | Update a locale
+[**locales_list**](LocalesApi.md#locales_list) | **GET** /projects/{project_id}/locales | List locales
+
+
+
+## locale_create
+
+> locale_create(project_id, locale_create_parameters, opts)
+
+Create a locale
+
+Create a new locale.
+
+### Example
+
+```ruby
+# 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+locale_create_parameters = Phrase::LocaleCreateParameters.new # LocaleCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a locale
+  api_instance.locale_create(project_id, locale_create_parameters, opts)
+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**](LocaleCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## locale_delete
+
+> locale_delete(project_id, id, opts)
+
+Delete a locale
+
+Delete an existing locale.
+
+### Example
+
+```ruby
+# 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+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**| ID | 
+ **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](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## locale_download
+
+> locale_download(project_id, id, opts)
+
+Download a locale
+
+Download a locale in a specific file format.
+
+### Example
+
+```ruby
+# 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+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
+  file_format: 'yml', # String | File format name. See the format guide 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.
+  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' => 'format_options_example'}, # Hash<String, String> | Additional formatting and render options. See the <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
+  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 <code>include_unverified_translations</code>.
+  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 (currently in beta) 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 public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
+}
+
+begin
+  #Download a locale
+  api_instance.locale_download(project_id, id, opts)
+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**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (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 \&quot;tags\&quot; parameter instead | [optional] 
+ **include_empty_translations** | **Boolean**| Indicates whether keys without translations should be included in the output as well. | [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** | [**Hash&lt;String, String&gt;**](String.md)| Additional formatting and render options. See the &lt;a href&#x3D;\&quot;https://help.phrase.com/help/supported-platforms-and-formats\&quot;&gt;format guide&lt;/a&gt; for a list of options available for each format. Specify format options like this: &lt;code&gt;...&amp;format_options[foo]&#x3D;bar&lt;/code&gt; | [optional] 
+ **encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \&quot;UTF-8\&quot;, \&quot;UTF-16\&quot; and \&quot;ISO-8859-1\&quot;. | [optional] 
+ **skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with &lt;code&gt;include_unverified_translations&lt;/code&gt;. | [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 (currently in beta) 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 public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to &lt;code&gt;true&lt;/code&gt;. | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## locale_show
+
+> LocaleDetails locale_show(project_id, id, opts)
+
+Get a single locale
+
+Get details on a single locale for a given project.
+
+### Example
+
+```ruby
+# 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+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**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**LocaleDetails**](LocaleDetails.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#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
+
+```ruby
+# 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+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**| ID | 
+ **locale_update_parameters** | [**LocaleUpdateParameters**](LocaleUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**LocaleDetails**](LocaleDetails.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## locales_list
+
+> Array&lt;Locale&gt; locales_list(project_id, opts)
+
+List locales
+
+List all locales for the given project.
+
+### Example
+
+```ruby
+# 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+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: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+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**| allows you to specify a page size up to 100 items, 10 by default | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**Array&lt;Locale&gt;**](Locale.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+