phrase 1.0.7 → 2.0.0

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/TranslationsApi.md

@@ -14,13 +14,13 @@ Method | HTTP request | Description
 [**translation_verify**](TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
 [**translations_by_key**](TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
 [**translations_by_locale**](TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
-[**translations_exclude**](TranslationsApi.md#translations_exclude) | **PATCH** /projects/{project_id}/translations/exclude | Set exclude from export flag on translations selected by query
-[**translations_include**](TranslationsApi.md#translations_include) | **PATCH** /projects/{project_id}/translations/include | Remove exlude from import flag from translations selected by query
+[**translations_exclude_collection**](TranslationsApi.md#translations_exclude_collection) | **PATCH** /projects/{project_id}/translations/exclude | Set exclude from export flag on translations selected by query
+[**translations_include_collection**](TranslationsApi.md#translations_include_collection) | **PATCH** /projects/{project_id}/translations/include | Remove exlude from import flag from translations selected by query
 [**translations_list**](TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
-[**translations_review**](TranslationsApi.md#translations_review) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
+[**translations_review_collection**](TranslationsApi.md#translations_review_collection) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
 [**translations_search**](TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
-[**translations_unverify**](TranslationsApi.md#translations_unverify) | **PATCH** /projects/{project_id}/translations/unverify | Mark translations selected by query as unverified
-[**translations_verify**](TranslationsApi.md#translations_verify) | **PATCH** /projects/{project_id}/translations/verify | Verify translations selected by query
+[**translations_unverify_collection**](TranslationsApi.md#translations_unverify_collection) | **PATCH** /projects/{project_id}/translations/unverify | Mark translations selected by query as unverified
+[**translations_verify_collection**](TranslationsApi.md#translations_verify_collection) | **PATCH** /projects/{project_id}/translations/verify | Verify translations selected by query
 
 
 
@@ -692,9 +692,9 @@ Response<([**Array&lt;Translation&gt;**](Translation.md))>
 - **Accept**: application/json
 
 
-## translations_exclude
+## translations_exclude_collection
 
-> AffectedCount translations_exclude(project_id, translations_exclude_parameters, opts)
+> AffectedCount translations_exclude_collection(project_id, translations_exclude_parameters, opts)
 
 Set exclude from export flag on translations selected by query
 
@@ -725,10 +725,10 @@ opts = {
 
 begin
   #Set exclude from export flag on translations selected by query
-  result = api_instance.translations_exclude(project_id, translations_exclude_parameters, opts)
+  result = api_instance.translations_exclude_collection(project_id, translations_exclude_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
-  puts "Exception when calling TranslationsApi->translations_exclude: #{e}"
+  puts "Exception when calling TranslationsApi->translations_exclude_collection: #{e}"
 end
 ```
 
@@ -755,9 +755,9 @@ Response<([**AffectedCount**](AffectedCount.md))>
 - **Accept**: application/json
 
 
-## translations_include
+## translations_include_collection
 
-> AffectedCount translations_include(project_id, translations_include_parameters, opts)
+> AffectedCount translations_include_collection(project_id, translations_include_parameters, opts)
 
 Remove exlude from import flag from translations selected by query
 
@@ -788,10 +788,10 @@ opts = {
 
 begin
   #Remove exlude from import flag from translations selected by query
-  result = api_instance.translations_include(project_id, translations_include_parameters, opts)
+  result = api_instance.translations_include_collection(project_id, translations_include_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
-  puts "Exception when calling TranslationsApi->translations_include: #{e}"
+  puts "Exception when calling TranslationsApi->translations_include_collection: #{e}"
 end
 ```
 
@@ -891,9 +891,9 @@ Response<([**Array&lt;Translation&gt;**](Translation.md))>
 - **Accept**: application/json
 
 
-## translations_review
+## translations_review_collection
 
-> AffectedCount translations_review(project_id, translations_review_parameters, opts)
+> AffectedCount translations_review_collection(project_id, translations_review_parameters, opts)
 
 Review translations selected by query
 
@@ -924,10 +924,10 @@ opts = {
 
 begin
   #Review translations selected by query
-  result = api_instance.translations_review(project_id, translations_review_parameters, opts)
+  result = api_instance.translations_review_collection(project_id, translations_review_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
-  puts "Exception when calling TranslationsApi->translations_review: #{e}"
+  puts "Exception when calling TranslationsApi->translations_review_collection: #{e}"
 end
 ```
 
@@ -1021,9 +1021,9 @@ Response<([**Array&lt;Translation&gt;**](Translation.md))>
 - **Accept**: application/json
 
 
-## translations_unverify
+## translations_unverify_collection
 
-> AffectedCount translations_unverify(project_id, translations_unverify_parameters, opts)
+> AffectedCount translations_unverify_collection(project_id, translations_unverify_parameters, opts)
 
 Mark translations selected by query as unverified
 
@@ -1054,10 +1054,10 @@ opts = {
 
 begin
   #Mark translations selected by query as unverified
-  result = api_instance.translations_unverify(project_id, translations_unverify_parameters, opts)
+  result = api_instance.translations_unverify_collection(project_id, translations_unverify_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
-  puts "Exception when calling TranslationsApi->translations_unverify: #{e}"
+  puts "Exception when calling TranslationsApi->translations_unverify_collection: #{e}"
 end
 ```
 
@@ -1084,9 +1084,9 @@ Response<([**AffectedCount**](AffectedCount.md))>
 - **Accept**: application/json
 
 
-## translations_verify
+## translations_verify_collection
 
-> AffectedCount translations_verify(project_id, translations_verify_parameters, opts)
+> AffectedCount translations_verify_collection(project_id, translations_verify_parameters, opts)
 
 Verify translations selected by query
 
@@ -1117,10 +1117,10 @@ opts = {
 
 begin
   #Verify translations selected by query
-  result = api_instance.translations_verify(project_id, translations_verify_parameters, opts)
+  result = api_instance.translations_verify_collection(project_id, translations_verify_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
-  puts "Exception when calling TranslationsApi->translations_verify: #{e}"
+  puts "Exception when calling TranslationsApi->translations_verify_collection: #{e}"
 end
 ```
 

data/docs/UsersApi.md

@@ -10,7 +10,7 @@ Method | HTTP request | Description
 
 ## show_user
 
-> User show_user(opts)
+> CurrentUser show_user(opts)
 
 Show current User
 
@@ -55,7 +55,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-Response<([**User**](User.md))>
+Response<([**CurrentUser**](CurrentUser.md))>
 
 ### Authorization
 

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
+