phrase 0.4.33 → 1.0.1

data/docs/Member.md

@@ -0,0 +1,25 @@
+# Phrase::Member
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**username** | **String** |  | [optional] 
+**role** | **String** |  | [optional] 
+**projects** | [**Array<ProjectLocales>**](ProjectLocales.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Member.new(id: null,
+                                 email: null,
+                                 username: null,
+                                 role: null,
+                                 projects: null)
+```
+
+

data/docs/MemberUpdateParameters.md

@@ -0,0 +1,23 @@
+# Phrase::MemberUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional] 
+**project_ids** | **String** | List of project ids the user has access to.  | [optional] 
+**locale_ids** | **String** | List of locale ids the user has access to. | [optional] 
+**permissions** | **Hash<String, String>** | Additional permissions depending on member role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::MemberUpdateParameters.new(role: Developer,
+                                 project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+                                 locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+                                 permissions: {"create_upload":true,"review_translations":true})
+```
+
+

data/docs/MembersApi.md

@@ -0,0 +1,271 @@
+# Phrase::MembersApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**member_delete**](MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
+[**member_show**](MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
+[**member_update**](MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
+[**members_list**](MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
+
+
+
+## member_delete
+
+> member_delete(account_id, id, opts)
+
+Remove a user from the account
+
+Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include <code>team.manage</code>.
+
+### 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::MembersApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Remove a user from the account
+  api_instance.member_delete(account_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling MembersApi->member_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **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
+
+
+## member_show
+
+> Member member_show(account_id, id, opts)
+
+Get single member
+
+Get details on a single user in the account. Access token scope must include <code>team.manage</code>.
+
+### 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::MembersApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Get single member
+  result = api_instance.member_show(account_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling MembersApi->member_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Member**](Member.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## member_update
+
+> Member member_update(account_id, id, member_update_parameters, opts)
+
+Update a member
+
+Update user permissions in the account. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
+
+### 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::MembersApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+member_update_parameters = Phrase::MemberUpdateParameters.new # MemberUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update a member
+  result = api_instance.member_update(account_id, id, member_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling MembersApi->member_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **member_update_parameters** | [**MemberUpdateParameters**](MemberUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Member**](Member.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## members_list
+
+> Array&lt;Member&gt; members_list(account_id, opts)
+
+List members
+
+Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.
+
+### 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::MembersApi.new
+account_id = 'account_id_example' # String | Account 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
+}
+
+begin
+  #List members
+  result = api_instance.members_list(account_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling MembersApi->members_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account 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] 
+
+### Return type
+
+Response<([**Array&lt;Member&gt;**](Member.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/OrderConfirmParameters.md

@@ -0,0 +1,17 @@
+# Phrase::OrderConfirmParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrderConfirmParameters.new(branch: my-feature-branch)
+```
+
+

data/docs/OrderCreateParameters.md

@@ -0,0 +1,43 @@
+# Phrase::OrderCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**lsp** | **String** | Name of the LSP that should process this order. Can be one of gengo, textmaster. | [optional] 
+**source_locale_id** | **String** | Source locale for the order. Can be the name or public id of the source locale. Preferred is the public id. | [optional] 
+**target_locale_ids** | **Array<String>** | List of target locales you want the source content translate to. Can be the name or public id of the target locales. Preferred is the public id. | [optional] 
+**translation_type** | **String** | Name of the quality level, availability depends on the LSP. Can be one of:  standard, pro (for orders processed by Gengo) and one of regular, premium, enterprise (for orders processed by TextMaster) | [optional] 
+**tag** | **String** | Tag you want to order translations for. | [optional] 
+**message** | **String** | Message that is displayed to the translators for description. | [optional] 
+**styleguide_id** | **String** | Style guide for translators to be sent with the order. | [optional] 
+**unverify_translations_upon_delivery** | **Boolean** | Unverify translations upon delivery. | [optional] 
+**include_untranslated_keys** | **Boolean** | Order translations for keys with untranslated content in the selected target locales. | [optional] 
+**include_unverified_translations** | **Boolean** | Order translations for keys with unverified content in the selected target locales. | [optional] 
+**category** | **String** | Category to use (required for orders processed by TextMaster). | [optional] 
+**quality** | **Boolean** | Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster. | [optional] 
+**priority** | **Boolean** | Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrderCreateParameters.new(branch: my-feature-branch,
+                                 lsp: textmaster,
+                                 source_locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 target_locale_ids: ["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],
+                                 translation_type: premium,
+                                 tag: my-awesome-feature,
+                                 message: Please make everything sound really nice :),
+                                 styleguide_id: 1234abcd1234abcd1234abcd1234abcd,
+                                 unverify_translations_upon_delivery: null,
+                                 include_untranslated_keys: null,
+                                 include_unverified_translations: null,
+                                 category: C021,
+                                 quality: null,
+                                 priority: null)
+```
+
+

data/docs/OrdersApi.md

@@ -0,0 +1,341 @@
+# Phrase::OrdersApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**order_confirm**](OrdersApi.md#order_confirm) | **PATCH** /projects/{project_id}/orders/{id}/confirm | Confirm an order
+[**order_create**](OrdersApi.md#order_create) | **POST** /projects/{project_id}/orders | Create a new order
+[**order_delete**](OrdersApi.md#order_delete) | **DELETE** /projects/{project_id}/orders/{id} | Cancel an order
+[**order_show**](OrdersApi.md#order_show) | **GET** /projects/{project_id}/orders/{id} | Get a single order
+[**orders_list**](OrdersApi.md#orders_list) | **GET** /projects/{project_id}/orders | List orders
+
+
+
+## order_confirm
+
+> TranslationOrder order_confirm(project_id, id, order_confirm_parameters, opts)
+
+Confirm an order
+
+Confirm an existing order and send it to the provider for translation. Same constraints as for create.
+
+### 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::OrdersApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+order_confirm_parameters = Phrase::OrderConfirmParameters.new # OrderConfirmParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Confirm an order
+  result = api_instance.order_confirm(project_id, id, order_confirm_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling OrdersApi->order_confirm: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| ID | 
+ **order_confirm_parameters** | [**OrderConfirmParameters**](OrderConfirmParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**TranslationOrder**](TranslationOrder.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## order_create
+
+> order_create(project_id, order_create_parameters, opts)
+
+Create a new order
+
+Create a new order. Access token scope must include <code>orders.create</code>.
+
+### 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::OrdersApi.new
+project_id = 'project_id_example' # String | Project ID
+order_create_parameters = Phrase::OrderCreateParameters.new # OrderCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a new order
+  api_instance.order_create(project_id, order_create_parameters, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling OrdersApi->order_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **order_create_parameters** | [**OrderCreateParameters**](OrderCreateParameters.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
+
+
+## order_delete
+
+> order_delete(project_id, id, opts)
+
+Cancel an order
+
+Cancel an existing order. Must not yet be confirmed.
+
+### 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::OrdersApi.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
+  #Cancel an order
+  api_instance.order_delete(project_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling OrdersApi->order_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
+
+
+## order_show
+
+> TranslationOrder order_show(project_id, id, opts)
+
+Get a single order
+
+Get details on a single order.
+
+### 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::OrdersApi.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 order
+  result = api_instance.order_show(project_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling OrdersApi->order_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<([**TranslationOrder**](TranslationOrder.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## orders_list
+
+> Array&lt;TranslationOrder&gt; orders_list(project_id, opts)
+
+List orders
+
+List all orders 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::OrdersApi.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 orders
+  result = api_instance.orders_list(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling OrdersApi->orders_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;TranslationOrder&gt;**](TranslationOrder.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+