phrase 0.4.31 → 1.0.3

data/docs/StyleguideDetails1.md

@@ -0,0 +1,41 @@
+# Phrase::StyleguideDetails1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**public_url** | **String** |  | [optional] 
+**audience** | **String** |  | [optional] 
+**target_audience** | **String** |  | [optional] 
+**grammatical_person** | **String** |  | [optional] 
+**vocabulary_type** | **String** |  | [optional] 
+**business** | **String** |  | [optional] 
+**company_branding** | **String** |  | [optional] 
+**formatting** | **String** |  | [optional] 
+**glossary_terms** | **String** |  | [optional] 
+**grammar_consistency** | **String** |  | [optional] 
+**literal_translation** | **String** |  | [optional] 
+**overall_tone** | **String** |  | [optional] 
+**samples** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::StyleguideDetails1.new(public_url: null,
+                                 audience: null,
+                                 target_audience: null,
+                                 grammatical_person: null,
+                                 vocabulary_type: null,
+                                 business: null,
+                                 company_branding: null,
+                                 formatting: null,
+                                 glossary_terms: null,
+                                 grammar_consistency: null,
+                                 literal_translation: null,
+                                 overall_tone: null,
+                                 samples: null)
+```
+
+

data/docs/StyleguidePreview.md

@@ -0,0 +1,19 @@
+# Phrase::StyleguidePreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::StyleguidePreview.new(id: null,
+                                 title: null)
+```
+
+

data/docs/StyleguideUpdateParameters.md

@@ -0,0 +1,41 @@
+# Phrase::StyleguideUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Style guide title | [optional] 
+**audience** | **String** | Audience description | [optional] 
+**target_audience** | **String** | Can be one of: not_specified, children, teenager, young_adults, adults, old_adults. | [optional] 
+**grammatical_person** | **String** | Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural. | [optional] 
+**vocabulary_type** | **String** | Can be one of: not_specified, popular, technical, fictional. | [optional] 
+**business** | **String** | Description of the business | [optional] 
+**company_branding** | **String** | Company branding to remain consistent. | [optional] 
+**formatting** | **String** | Formatting requirements and character limitations. | [optional] 
+**glossary_terms** | **String** | List of terms and/or phrases that need to be translated consistently. | [optional] 
+**grammar_consistency** | **String** | Formal or informal pronouns, consistent conjugation, grammatical gender | [optional] 
+**literal_translation** | **String** | Can be one of: Cultural/Conversational, Literal, Neutral. | [optional] 
+**overall_tone** | **String** | Tone requirement descriptions | [optional] 
+**samples** | **String** | Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::StyleguideUpdateParameters.new(title: Web application style guide,
+                                 audience: customer-facing,
+                                 target_audience: teenager,
+                                 grammatical_person: first_person_singular,
+                                 vocabulary_type: technical,
+                                 business: We are a travel site that helps customers find the best hotels and flights.,
+                                 company_branding: ACME Inc. should never be translated.,
+                                 formatting: Never use capital letters,
+                                 glossary_terms: Appartement, cabin, loft,
+                                 grammar_consistency: null,
+                                 literal_translation: Neutral,
+                                 overall_tone: Tone should be fun and light,
+                                 samples: http://www.myexample.com/my/document/path/to/samples.pdf)
+```
+
+

data/docs/Tag.md

@@ -0,0 +1,23 @@
+# Phrase::Tag
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**keys_count** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Tag.new(name: null,
+                                 keys_count: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/TagCreateParameters.md

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

data/docs/TagWithStats.md

@@ -0,0 +1,25 @@
+# Phrase::TagWithStats
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**keys_count** | **Integer** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**statistics** | [**Array<TagWithStats1Statistics1>**](TagWithStats1Statistics1.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TagWithStats.new(name: null,
+                                 keys_count: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 statistics: null)
+```
+
+

data/docs/TagWithStats1.md

@@ -0,0 +1,17 @@
+# Phrase::TagWithStats1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statistics** | [**Array<TagWithStats1Statistics1>**](TagWithStats1Statistics1.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TagWithStats1.new(statistics: null)
+```
+
+

data/docs/TagWithStats1Statistics.md

@@ -0,0 +1,23 @@
+# Phrase::TagWithStats1Statistics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**keys_total_count** | **Integer** |  | [optional] 
+**translations_completed_count** | **Integer** |  | [optional] 
+**translations_unverified_count** | **Integer** |  | [optional] 
+**keys_untranslated_count** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TagWithStats1Statistics.new(keys_total_count: null,
+                                 translations_completed_count: null,
+                                 translations_unverified_count: null,
+                                 keys_untranslated_count: null)
+```
+
+

data/docs/TagWithStats1Statistics1.md

@@ -0,0 +1,19 @@
+# Phrase::TagWithStats1Statistics1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
+**statistics** | [**TagWithStats1Statistics**](TagWithStats1Statistics.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TagWithStats1Statistics1.new(locale: null,
+                                 statistics: null)
+```
+
+

data/docs/TagsApi.md

@@ -0,0 +1,271 @@
+# Phrase::TagsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**tag_create**](TagsApi.md#tag_create) | **POST** /projects/{project_id}/tags | Create a tag
+[**tag_delete**](TagsApi.md#tag_delete) | **DELETE** /projects/{project_id}/tags/{name} | Delete a tag
+[**tag_show**](TagsApi.md#tag_show) | **GET** /projects/{project_id}/tags/{name} | Get a single tag
+[**tags_list**](TagsApi.md#tags_list) | **GET** /projects/{project_id}/tags | List tags
+
+
+
+## tag_create
+
+> TagWithStats tag_create(project_id, tag_create_parameters, opts)
+
+Create a tag
+
+Create a new tag.
+
+### 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::TagsApi.new
+project_id = 'project_id_example' # String | Project ID
+tag_create_parameters = Phrase::TagCreateParameters.new # TagCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a tag
+  result = api_instance.tag_create(project_id, tag_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling TagsApi->tag_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **tag_create_parameters** | [**TagCreateParameters**](TagCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**TagWithStats**](TagWithStats.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## tag_delete
+
+> tag_delete(project_id, name, opts)
+
+Delete a tag
+
+Delete an existing tag.
+
+### 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::TagsApi.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)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Delete a tag
+  api_instance.tag_delete(project_id, name, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling TagsApi->tag_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] 
+ **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
+
+
+## tag_show
+
+> TagWithStats tag_show(project_id, name, opts)
+
+Get a single tag
+
+Get details and progress information on a single tag 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::TagsApi.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)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Get a single tag
+  result = api_instance.tag_show(project_id, name, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling TagsApi->tag_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] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**TagWithStats**](TagWithStats.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## tags_list
+
+> Array&lt;Tag&gt; tags_list(project_id, opts)
+
+List tags
+
+List all tags 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::TagsApi.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 tags
+  result = api_instance.tags_list(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling TagsApi->tags_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;Tag&gt;**](Tag.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+