phrase 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffca40a4f9017ee331ef15370f82ff0905d1331cbcded2f8281fc49c908f486a
-  data.tar.gz: 975618371652fdeda75b8af1024e7e25e5159dde04078a11ddfb3a87774a2a0a
+  metadata.gz: 49a19fc546ef52207dcf5bb6fb55be7d17952a2bf653c9ffff5be7635d3b4458
+  data.tar.gz: 0fa6cbdbea643ec4d224630d8c64d4985e98f24c027222f752a3401c9326ec4b
 SHA512:
-  metadata.gz: 4bd17deee15174bea2fa279f3049458c5d6321206ca93c7505ad7b56f2c6948e44d73261cf439b3873d765b30fa6a5a119a7a8f18f8ca495102df4a7514f4857
-  data.tar.gz: dba28ac1b043877b45a5a58e41381cda4bbaa28d8c42dd736eafc30bb3b5289d642a973839acff8e7053788c2f115d10378727a59dc5632d2c422a2eee67d981
+  metadata.gz: 6417d48d5c4db8bdd56e5d15e82e443a30ce12709930a38e36e1e10d7ca2d1de79c68a8f603dce55d6ace04eb24828503615116337883e74a9fa343ceb971a71
+  data.tar.gz: 1f3acb829026fc944d11b5a17b0d33fda84461f2373a170371266a13d52f2292a8ca5978a441cd65aa2d4a0136ffffb44d2d3017d8a8222bbeaeee31f71699a5

data/README.md

@@ -7,7 +7,7 @@ Phrase is a translation management platform for software projects. You can colla
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 1.0.12
+- Package version: 1.0.13
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./phrase-1.0.12.gem
+gem install ./phrase-1.0.13.gem
 ```
 
-(for development, run `gem install --dev ./phrase-1.0.12.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-1.0.13.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -284,6 +284,11 @@ Class | Method | HTTP request | Description
 *Phrase::UploadsApi* | [**upload_show**](docs/UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | View upload details
 *Phrase::UploadsApi* | [**uploads_list**](docs/UploadsApi.md#uploads_list) | **GET** /projects/{project_id}/uploads | List uploads
 *Phrase::UsersApi* | [**show_user**](docs/UsersApi.md#show_user) | **GET** /user | Show current User
+*Phrase::VariablesApi* | [**variable_create**](docs/VariablesApi.md#variable_create) | **POST** /projects/{project_id}/variables | Create a variable
+*Phrase::VariablesApi* | [**variable_delete**](docs/VariablesApi.md#variable_delete) | **DELETE** /projects/{project_id}/variables/{name} | Delete a variable
+*Phrase::VariablesApi* | [**variable_show**](docs/VariablesApi.md#variable_show) | **GET** /projects/{project_id}/variables/{name} | Get a single variable
+*Phrase::VariablesApi* | [**variable_update**](docs/VariablesApi.md#variable_update) | **PATCH** /projects/{project_id}/variables/{name} | Update a variable
+*Phrase::VariablesApi* | [**variables_list**](docs/VariablesApi.md#variables_list) | **GET** /projects/{project_id}/variables | List variables
 *Phrase::VersionsHistoryApi* | [**version_show**](docs/VersionsHistoryApi.md#version_show) | **GET** /projects/{project_id}/translations/{translation_id}/versions/{id} | Get a single version
 *Phrase::VersionsHistoryApi* | [**versions_list**](docs/VersionsHistoryApi.md#versions_list) | **GET** /projects/{project_id}/translations/{translation_id}/versions | List all versions
 *Phrase::WebhooksApi* | [**webhook_create**](docs/WebhooksApi.md#webhook_create) | **POST** /projects/{project_id}/webhooks | Create a webhook
@@ -455,6 +460,9 @@ Class | Method | HTTP request | Description
  - [Phrase::UploadSummary](docs/UploadSummary.md)
  - [Phrase::User](docs/User.md)
  - [Phrase::UserPreview](docs/UserPreview.md)
+ - [Phrase::Variable](docs/Variable.md)
+ - [Phrase::VariableCreateParameters](docs/VariableCreateParameters.md)
+ - [Phrase::VariableUpdateParameters](docs/VariableUpdateParameters.md)
  - [Phrase::Webhook](docs/Webhook.md)
  - [Phrase::WebhookCreateParameters](docs/WebhookCreateParameters.md)
  - [Phrase::WebhookUpdateParameters](docs/WebhookUpdateParameters.md)

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/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
+