phrase 1.0.12 → 2.1.0

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
+

data/lib/phrase.rb

@@ -11,6 +11,7 @@ require 'phrase/configuration'
 require 'phrase/models/account'
 require 'phrase/models/account_details'
 require 'phrase/models/account_details1'
+require 'phrase/models/account_search_result'
 require 'phrase/models/affected_count'
 require 'phrase/models/affected_resources'
 require 'phrase/models/authorization'
@@ -34,6 +35,7 @@ require 'phrase/models/comment'
 require 'phrase/models/comment_create_parameters'
 require 'phrase/models/comment_mark_read_parameters'
 require 'phrase/models/comment_update_parameters'
+require 'phrase/models/current_user'
 require 'phrase/models/distribution'
 require 'phrase/models/distribution_create_parameters'
 require 'phrase/models/distribution_preview'
@@ -76,10 +78,20 @@ require 'phrase/models/job_locales_create_parameters'
 require 'phrase/models/job_preview'
 require 'phrase/models/job_reopen_parameters'
 require 'phrase/models/job_start_parameters'
+require 'phrase/models/job_template'
+require 'phrase/models/job_template_create_parameters'
+require 'phrase/models/job_template_locale'
+require 'phrase/models/job_template_locale_update_parameters'
+require 'phrase/models/job_template_locales_create_parameters'
+require 'phrase/models/job_template_preview'
+require 'phrase/models/job_template_update_parameters'
+require 'phrase/models/job_template_user_preview'
 require 'phrase/models/job_update_parameters'
 require 'phrase/models/key_create_parameters'
 require 'phrase/models/key_preview'
 require 'phrase/models/key_update_parameters'
+require 'phrase/models/keys_exclude_parameters'
+require 'phrase/models/keys_include_parameters'
 require 'phrase/models/keys_search_parameters'
 require 'phrase/models/keys_tag_parameters'
 require 'phrase/models/keys_untag_parameters'
@@ -88,6 +100,7 @@ require 'phrase/models/locale_create_parameters'
 require 'phrase/models/locale_details'
 require 'phrase/models/locale_details1'
 require 'phrase/models/locale_preview'
+require 'phrase/models/locale_preview1'
 require 'phrase/models/locale_statistics'
 require 'phrase/models/locale_update_parameters'
 require 'phrase/models/member'
@@ -96,6 +109,9 @@ require 'phrase/models/member_project_detail_project_roles'
 require 'phrase/models/member_spaces'
 require 'phrase/models/member_update_parameters'
 require 'phrase/models/member_update_settings_parameters'
+require 'phrase/models/notification'
+require 'phrase/models/notification_group'
+require 'phrase/models/notification_group_detail'
 require 'phrase/models/order_confirm_parameters'
 require 'phrase/models/order_create_parameters'
 require 'phrase/models/project'
@@ -116,7 +132,9 @@ require 'phrase/models/screenshot_marker'
 require 'phrase/models/screenshot_marker_create_parameters'
 require 'phrase/models/screenshot_marker_update_parameters'
 require 'phrase/models/screenshot_update_parameters'
+require 'phrase/models/search_in_account_parameters'
 require 'phrase/models/space'
+require 'phrase/models/space1'
 require 'phrase/models/space_create_parameters'
 require 'phrase/models/space_update_parameters'
 require 'phrase/models/spaces_projects_create_parameters'
@@ -126,6 +144,7 @@ require 'phrase/models/styleguide_details'
 require 'phrase/models/styleguide_details1'
 require 'phrase/models/styleguide_preview'
 require 'phrase/models/styleguide_update_parameters'
+require 'phrase/models/subscription'
 require 'phrase/models/tag'
 require 'phrase/models/tag_create_parameters'
 require 'phrase/models/tag_with_stats'
@@ -167,6 +186,9 @@ require 'phrase/models/upload_create_parameters'
 require 'phrase/models/upload_summary'
 require 'phrase/models/user'
 require 'phrase/models/user_preview'
+require 'phrase/models/variable'
+require 'phrase/models/variable_create_parameters'
+require 'phrase/models/variable_update_parameters'
 require 'phrase/models/webhook'
 require 'phrase/models/webhook_create_parameters'
 require 'phrase/models/webhook_update_parameters'
@@ -188,15 +210,20 @@ require 'phrase/api/glossary_term_translations_api'
 require 'phrase/api/glossary_terms_api'
 require 'phrase/api/invitations_api'
 require 'phrase/api/job_locales_api'
+require 'phrase/api/job_template_locales_api'
+require 'phrase/api/job_templates_api'
 require 'phrase/api/jobs_api'
 require 'phrase/api/keys_api'
 require 'phrase/api/locales_api'
 require 'phrase/api/members_api'
+require 'phrase/api/notification_groups_api'
+require 'phrase/api/notifications_api'
 require 'phrase/api/orders_api'
 require 'phrase/api/projects_api'
 require 'phrase/api/releases_api'
 require 'phrase/api/screenshot_markers_api'
 require 'phrase/api/screenshots_api'
+require 'phrase/api/search_api'
 require 'phrase/api/spaces_api'
 require 'phrase/api/style_guides_api'
 require 'phrase/api/tags_api'
@@ -204,6 +231,7 @@ require 'phrase/api/teams_api'
 require 'phrase/api/translations_api'
 require 'phrase/api/uploads_api'
 require 'phrase/api/users_api'
+require 'phrase/api/variables_api'
 require 'phrase/api/versions_history_api'
 require 'phrase/api/webhooks_api'