phrase 1.0.9 → 1.0.14

data/docs/ProjectUpdateParameters.md

@@ -4,24 +4,58 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the project | [optional] 
-**main_format** | **String** | Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional] 
-**shares_translation_memory** | **Boolean** | Indicates whether the project should share the account's translation memory | [optional] 
-**project_image** | **File** | Image to identify the project | [optional] 
-**remove_project_image** | **Boolean** | Indicates whether the project image should be deleted. | [optional] 
-**account_id** | **String** | Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. | [optional] 
+**account_id** | **String** | Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. | [optional] 
+**name** | **String** | (Optional) Name of the project | [optional] 
+**main_format** | **String** | (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional] 
+**shares_translation_memory** | **Boolean** | (Optional) Indicates whether the project should share the account's translation memory | [optional] 
+**project_image** | **File** | (Optional) Image to identify the project | [optional] 
+**remove_project_image** | **Boolean** | (Optional) Indicates whether the project image should be deleted. | [optional] 
+**workflow** | **String** | (Optional) Review Workflow. \"simple\" / \"review\". <a href=\"https://help.phrase.com/help/advanced-review-workflow\">Read more</a> | [optional] 
+**machine_translation_enabled** | **Boolean** | (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest | [optional] 
+**enable_branching** | **Boolean** | (Optional) Enable branching in the project | [optional] 
+**protect_master_branch** | **Boolean** | (Optional) Protect the master branch in project where branching is enabled | [optional] 
+**enable_all_data_type_translation_keys_for_translators** | **Boolean** | (Optional) Otherwise, translators are not allowed to edit translations other than strings | [optional] 
+**enable_icu_message_format** | **Boolean** | (Optional) We can validate and highlight your ICU messages. <a href=\"https://help.phrase.com/help/icu-message-format\">Read more</a> | [optional] 
+**zero_plural_form_enabled** | **Boolean** | (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly. | [optional] 
+**autotranslate_enabled** | **Boolean** | (Optional) Autopilot, requires machine_translation_enabled. <a href=\"https://help.phrase.com/help/autopilot\">Read more</a> | [optional] 
+**autotranslate_check_new_translation_keys** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_check_new_uploads** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_check_new_locales** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_mark_as_unverified** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_use_machine_translation** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**autotranslate_use_translation_memory** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional] 
+**smart_suggest_enabled** | **Boolean** | (Optional) Smart Suggest, requires machine_translation_enabled | [optional] 
+**smart_suggest_use_glossary** | **Boolean** | (Optional) Requires smart_suggest_enabled to be true | [optional] 
+**smart_suggest_use_machine_translation** | **Boolean** | (Optional) Requires smart_suggest_enabled to be true | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ProjectUpdateParameters.new(name: My Android Project,
+instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
+                                 name: My Android Project,
                                  main_format: yml,
                                  shares_translation_memory: true,
                                  project_image: null,
-                                 remove_project_image: null,
-                                 account_id: abcd1234)
+                                 remove_project_image: false,
+                                 workflow: review,
+                                 machine_translation_enabled: true,
+                                 enable_branching: true,
+                                 protect_master_branch: true,
+                                 enable_all_data_type_translation_keys_for_translators: true,
+                                 enable_icu_message_format: true,
+                                 zero_plural_form_enabled: true,
+                                 autotranslate_enabled: true,
+                                 autotranslate_check_new_translation_keys: true,
+                                 autotranslate_check_new_uploads: true,
+                                 autotranslate_check_new_locales: true,
+                                 autotranslate_mark_as_unverified: true,
+                                 autotranslate_use_machine_translation: true,
+                                 autotranslate_use_translation_memory: true,
+                                 smart_suggest_enabled: true,
+                                 smart_suggest_use_glossary: true,
+                                 smart_suggest_use_machine_translation: true)
 ```
 
 

data/docs/ScreenshotCreateParameters.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
 **name** | **String** | Name of the screenshot | [optional] 
 **description** | **String** | Description of the screenshot | [optional] 
 **filename** | **File** | Screenshot file | [optional] 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ScreenshotCreateParameters.new(name: A screenshot name,
+instance = Phrase::ScreenshotCreateParameters.new(branch: my-feature-branch,
+                                 name: A screenshot name,
                                  description: A screenshot description,
                                  filename: null)
 ```

data/docs/ScreenshotMarkerCreateParameters.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
 **key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional] 
 **presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional] 
 
@@ -12,7 +13,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ScreenshotMarkerCreateParameters.new(key_id: abcd1234abcd1234abcd1234abcd1234,
+instance = Phrase::ScreenshotMarkerCreateParameters.new(branch: my-feature-branch,
+                                 key_id: abcd1234abcd1234abcd1234abcd1234,
                                  presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
 ```
 

data/docs/ScreenshotMarkerUpdateParameters.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
 **key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional] 
 **presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional] 
 
@@ -12,7 +13,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ScreenshotMarkerUpdateParameters.new(key_id: abcd1234abcd1234abcd1234abcd1234,
+instance = Phrase::ScreenshotMarkerUpdateParameters.new(branch: my-feature-branch,
+                                 key_id: abcd1234abcd1234abcd1234abcd1234,
                                  presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
 ```
 

data/docs/ScreenshotMarkersApi.md

@@ -105,7 +105,8 @@ api_instance = Phrase::ScreenshotMarkersApi.new
 project_id = 'project_id_example' # String | Project ID
 screenshot_id = 'screenshot_id_example' # String | Screenshot ID
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+  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
@@ -124,6 +125,7 @@ Name | Type | Description  | Notes
  **project_id** | **String**| Project ID | 
  **screenshot_id** | **String**| Screenshot ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type
 
@@ -168,7 +170,8 @@ project_id = 'project_id_example' # String | Project ID
 screenshot_id = 'screenshot_id_example' # String | Screenshot ID
 id = 'id_example' # String | ID
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+  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
@@ -189,6 +192,7 @@ Name | Type | Description  | Notes
  **screenshot_id** | **String**| Screenshot 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
 
@@ -299,7 +303,8 @@ 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 | allows you to specify a page size up to 100 items, 25 by default
+  per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
+  branch: 'my-feature-branch' # String | specify the branch to use
 }
 
 begin
@@ -321,6 +326,7 @@ Name | Type | Description  | Notes
  **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, 25 by default | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type
 

data/docs/ScreenshotUpdateParameters.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
 **name** | **String** | Name of the screenshot | [optional] 
 **description** | **String** | Description of the screenshot | [optional] 
 **filename** | **File** | Screenshot file | [optional] 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'Phrase'
 
-instance = Phrase::ScreenshotUpdateParameters.new(name: A screenshot name,
+instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
+                                 name: A screenshot name,
                                  description: A screenshot description,
                                  filename: null)
 ```

data/docs/ScreenshotsApi.md

@@ -103,7 +103,8 @@ api_instance = Phrase::ScreenshotsApi.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)
+  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
@@ -122,6 +123,7 @@ 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
 
@@ -165,7 +167,8 @@ api_instance = Phrase::ScreenshotsApi.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)
+  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
@@ -185,6 +188,7 @@ 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
 
@@ -295,6 +299,7 @@ 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 | allows you to specify a page size up to 100 items, 25 by default
+  branch: 'my-feature-branch', # String | specify the branch to use
   key_id: 'abcd1234cdef1234abcd1234cdef1234' # String | filter by key
 }
 
@@ -316,6 +321,7 @@ Name | Type | Description  | Notes
  **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, 25 by default | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
  **key_id** | **String**| filter by key | [optional] 
 
 ### Return type

data/docs/Variable.md

@@ -0,0 +1,23 @@
+# Phrase::Variable
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Variable.new(name: null,
+                                 value: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/VariableCreateParameters.md

@@ -0,0 +1,19 @@
+# Phrase::VariableCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the variable | [optional] 
+**value** | **String** | Value of the variable | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::VariableCreateParameters.new(name: MY_VARIABLE,
+                                 value: Hello World)
+```
+
+

data/docs/VariableUpdateParameters.md

@@ -0,0 +1,19 @@
+# Phrase::VariableUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the variable | [optional] 
+**value** | **String** | Value of the variable | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::VariableUpdateParameters.new(name: MY_VARIABLE,
+                                 value: Hello World)
+```
+
+

data/docs/VariablesApi.md

@@ -0,0 +1,331 @@
+# Phrase::VariablesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**variable_create**](VariablesApi.md#variable_create) | **POST** /projects/{project_id}/variables | Create a variable
+[**variable_delete**](VariablesApi.md#variable_delete) | **DELETE** /projects/{project_id}/variables/{name} | Delete a variable
+[**variable_show**](VariablesApi.md#variable_show) | **GET** /projects/{project_id}/variables/{name} | Get a single variable
+[**variable_update**](VariablesApi.md#variable_update) | **PATCH** /projects/{project_id}/variables/{name} | Update a variable
+[**variables_list**](VariablesApi.md#variables_list) | **GET** /projects/{project_id}/variables | List variables
+
+
+
+## variable_create
+
+> Variable variable_create(project_id, variable_create_parameters, opts)
+
+Create a variable
+
+Create a new variable.
+
+### 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'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::VariablesApi.new
+project_id = 'project_id_example' # String | Project ID
+variable_create_parameters = Phrase::VariableCreateParameters.new # VariableCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a variable
+  result = api_instance.variable_create(project_id, variable_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling VariablesApi->variable_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **variable_create_parameters** | [**VariableCreateParameters**](VariableCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Variable**](Variable.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## variable_delete
+
+> variable_delete(project_id, name, opts)
+
+Delete a variable
+
+Delete an existing variable.
+
+### 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'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::VariablesApi.new
+project_id = 'project_id_example' # String | Project ID
+name = 'name_example' # String | name
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Delete a variable
+  api_instance.variable_delete(project_id, name, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling VariablesApi->variable_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **name** | **String**| name | 
+ **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**: Not defined
+- **Accept**: Not defined
+
+
+## variable_show
+
+> Variable variable_show(project_id, name, opts)
+
+Get a single variable
+
+Get details on a single variable 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'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::VariablesApi.new
+project_id = 'project_id_example' # String | Project ID
+name = 'name_example' # String | name
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Get a single variable
+  result = api_instance.variable_show(project_id, name, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling VariablesApi->variable_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **name** | **String**| name | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Variable**](Variable.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## variable_update
+
+> Variable variable_update(project_id, name, variable_update_parameters, opts)
+
+Update a variable
+
+Update an existing variable.
+
+### 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'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::VariablesApi.new
+project_id = 'project_id_example' # String | Project ID
+name = 'name_example' # String | name
+variable_update_parameters = Phrase::VariableUpdateParameters.new # VariableUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update a variable
+  result = api_instance.variable_update(project_id, name, variable_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling VariablesApi->variable_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **name** | **String**| name | 
+ **variable_update_parameters** | [**VariableUpdateParameters**](VariableUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Variable**](Variable.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## variables_list
+
+> Array&lt;Variable&gt; variables_list(project_id, opts)
+
+List variables
+
+List all variables for the current 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'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::VariablesApi.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 | allows you to specify a page size up to 100 items, 25 by default
+}
+
+begin
+  #List variables
+  result = api_instance.variables_list(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling VariablesApi->variables_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, 25 by default | [optional] 
+
+### Return type
+
+Response<([**Array&lt;Variable&gt;**](Variable.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+