phrase 0.4.31 → 1.0.3

data/docs/TranslationsExcludeParameters.md

@@ -0,0 +1,23 @@
+# Phrase::TranslationsExcludeParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.  | [optional] 
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional] 
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsExcludeParameters.new(branch: my-feature-branch,
+                                 q: PhraseApp*%20verified:true%20tags:feature,center,
+                                 sort: updated_at,
+                                 order: desc)
+```
+
+

data/docs/TranslationsIncludeParameters.md

@@ -0,0 +1,23 @@
+# Phrase::TranslationsIncludeParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.  | [optional] 
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional] 
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsIncludeParameters.new(branch: my-feature-branch,
+                                 q: PhraseApp*%20verified:true%20tags:feature,center,
+                                 sort: updated_at,
+                                 order: desc)
+```
+
+

data/docs/TranslationsReviewParameters.md

@@ -0,0 +1,19 @@
+# Phrase::TranslationsReviewParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsReviewParameters.new(branch: my-feature-branch,
+                                 q: PhraseApp*%reviewed:false%20tags:feature,center)
+```
+
+

data/docs/TranslationsSearchParameters.md

@@ -0,0 +1,23 @@
+# Phrase::TranslationsSearchParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional] 
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
+**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsSearchParameters.new(branch: my-feature-branch,
+                                 sort: updated_at,
+                                 order: desc,
+                                 q: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center)
+```
+
+

data/docs/TranslationsUnverifyParameters.md

@@ -0,0 +1,23 @@
+# Phrase::TranslationsUnverifyParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.  | [optional] 
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional] 
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsUnverifyParameters.new(branch: my-feature-branch,
+                                 q: PhraseApp*%20verified:true%20tags:feature,center,
+                                 sort: updated_at,
+                                 order: desc)
+```
+
+

data/docs/TranslationsVerifyParameters.md

@@ -0,0 +1,23 @@
+# Phrase::TranslationsVerifyParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**q** | **String** | Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.  | [optional] 
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional] 
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsVerifyParameters.new(branch: my-feature-branch,
+                                 q: PhraseApp*%20unverified:true%20tags:feature,center,
+                                 sort: updated_at,
+                                 order: desc)
+```
+
+

data/docs/Upload.md

@@ -0,0 +1,31 @@
+# Phrase::Upload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**filename** | **String** |  | [optional] 
+**format** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**tag** | **String** |  | [optional] 
+**summary** | [**UploadSummary**](UploadSummary.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Upload.new(id: null,
+                                 filename: null,
+                                 format: null,
+                                 state: null,
+                                 tag: null,
+                                 summary: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/UploadCreateParameters.md

@@ -0,0 +1,45 @@
+# Phrase::UploadCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**file** | **File** | File to be imported | [optional] 
+**file_format** | **String** | File format. Auto-detected when possible and not specified. | [optional] 
+**locale_id** | **String** | Locale of the file's content. Can be the name or public id of the locale. Preferred is the public id. | [optional] 
+**tags** | **String** | List of tags separated by comma to be associated with the new keys contained in the upload. | [optional] 
+**update_translations** | **Boolean** | Indicates whether existing translations should be updated with the file content. | [optional] 
+**update_descriptions** | **Boolean** | Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions. | [optional] 
+**convert_emoji** | **Boolean** | This option is obsolete. Providing the option will cause a bad request error. | [optional] 
+**skip_upload_tags** | **Boolean** | Indicates whether the upload should not create upload tags. | [optional] 
+**skip_unverification** | **Boolean** | Indicates whether the upload should unverify updated translations. | [optional] 
+**file_encoding** | **String** | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional] 
+**locale_mapping** | [**Object**](.md) | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. | [optional] 
+**format_options** | [**Object**](.md) | Additional options available for specific formats. See our format guide for complete list. | [optional] 
+**autotranslate** | **Boolean** | If set, translations for the uploaded language will be fetched automatically. | [optional] 
+**mark_reviewed** | **Boolean** | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::UploadCreateParameters.new(branch: my-feature-branch,
+                                 file: null,
+                                 file_format: json,
+                                 locale_id: abcd1234cdef1234abcd1234cdef1234,
+                                 tags: awesome-feature,needs-proofreading,
+                                 update_translations: null,
+                                 update_descriptions: null,
+                                 convert_emoji: null,
+                                 skip_upload_tags: null,
+                                 skip_unverification: null,
+                                 file_encoding: null,
+                                 locale_mapping: {"en": "2"},
+                                 format_options: {"foo": "bar"},
+                                 autotranslate: null,
+                                 mark_reviewed: null)
+```
+
+

data/docs/UploadSummary.md

@@ -0,0 +1,31 @@
+# Phrase::UploadSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locales_created** | **Integer** |  | [optional] 
+**translation_keys_created** | **Integer** |  | [optional] 
+**translation_keys_updated** | **Integer** |  | [optional] 
+**translation_keys_unmentioned** | **Integer** |  | [optional] 
+**translations_created** | **Integer** |  | [optional] 
+**translations_updated** | **Integer** |  | [optional] 
+**tags_created** | **Integer** |  | [optional] 
+**translation_keys_ignored** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::UploadSummary.new(locales_created: null,
+                                 translation_keys_created: null,
+                                 translation_keys_updated: null,
+                                 translation_keys_unmentioned: null,
+                                 translations_created: null,
+                                 translations_updated: null,
+                                 tags_created: null,
+                                 translation_keys_ignored: null)
+```
+
+

data/docs/UploadsApi.md

@@ -0,0 +1,234 @@
+# Phrase::UploadsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**upload_create**](UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
+[**upload_show**](UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | View upload details
+[**uploads_list**](UploadsApi.md#uploads_list) | **GET** /projects/{project_id}/uploads | List uploads
+
+
+
+## upload_create
+
+> Upload upload_create(project_id, opts)
+
+Upload a new file
+
+Upload a new language file. Creates necessary resources in your 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::UploadsApi.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)
+  branch: 'branch_example', # String | specify the branch to use
+  file: File.new('/path/to/file'), # File | File to be imported
+  file_format: 'file_format_example', # String | File format. Auto-detected when possible and not specified.
+  locale_id: 'locale_id_example', # String | Locale of the file's content. Can be the name or public id of the locale. Preferred is the public id.
+  tags: 'tags_example', # String | List of tags separated by comma to be associated with the new keys contained in the upload.
+  update_translations: true, # Boolean | Indicates whether existing translations should be updated with the file content.
+  update_descriptions: true, # Boolean | Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.
+  convert_emoji: true, # Boolean | This option is obsolete. Providing the option will cause a bad request error.
+  skip_upload_tags: true, # Boolean | Indicates whether the upload should not create upload tags.
+  skip_unverification: true, # Boolean | Indicates whether the upload should unverify updated translations.
+  file_encoding: 'file_encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\".
+  locale_mapping: nil, # Object | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.
+  format_options: nil, # Object | Additional options available for specific formats. See our format guide for complete list.
+  autotranslate: true, # Boolean | If set, translations for the uploaded language will be fetched automatically.
+  mark_reviewed: true # Boolean | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project.
+}
+
+begin
+  #Upload a new file
+  result = api_instance.upload_create(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling UploadsApi->upload_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+ **file** | **File**| File to be imported | [optional] 
+ **file_format** | **String**| File format. Auto-detected when possible and not specified. | [optional] 
+ **locale_id** | **String**| Locale of the file's content. Can be the name or public id of the locale. Preferred is the public id. | [optional] 
+ **tags** | **String**| List of tags separated by comma to be associated with the new keys contained in the upload. | [optional] 
+ **update_translations** | **Boolean**| Indicates whether existing translations should be updated with the file content. | [optional] 
+ **update_descriptions** | **Boolean**| Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions. | [optional] 
+ **convert_emoji** | **Boolean**| This option is obsolete. Providing the option will cause a bad request error. | [optional] 
+ **skip_upload_tags** | **Boolean**| Indicates whether the upload should not create upload tags. | [optional] 
+ **skip_unverification** | **Boolean**| Indicates whether the upload should unverify updated translations. | [optional] 
+ **file_encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\". | [optional] 
+ **locale_mapping** | [**Object**](Object.md)| Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. | [optional] 
+ **format_options** | [**Object**](Object.md)| Additional options available for specific formats. See our format guide for complete list. | [optional] 
+ **autotranslate** | **Boolean**| If set, translations for the uploaded language will be fetched automatically. | [optional] 
+ **mark_reviewed** | **Boolean**| Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project. | [optional] 
+
+### Return type
+
+Response<([**Upload**](Upload.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+
+
+## upload_show
+
+> Upload upload_show(project_id, id, opts)
+
+View upload details
+
+View details and summary for a single upload.
+
+### 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::UploadsApi.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
+  #View upload details
+  result = api_instance.upload_show(project_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling UploadsApi->upload_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<([**Upload**](Upload.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## uploads_list
+
+> Array&lt;Upload&gt; uploads_list(project_id, opts)
+
+List uploads
+
+List all uploads 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'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::UploadsApi.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
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #List uploads
+  result = api_instance.uploads_list(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling UploadsApi->uploads_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] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**Array&lt;Upload&gt;**](Upload.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+