phrase 2.7.0 → 2.8.0

data/docs/JobCommentCreateParameters.md

@@ -0,0 +1,17 @@
+# Phrase::JobCommentCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | Job comment message | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobCommentCreateParameters.new(message: Some message...)
+```
+
+

data/docs/JobCommentUpdateParameters.md

@@ -0,0 +1,17 @@
+# Phrase::JobCommentUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | Comment message | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobCommentUpdateParameters.new(message: Some message...)
+```
+
+

data/docs/JobCommentsApi.md

@@ -0,0 +1,343 @@
+# Phrase::JobCommentsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**job_comment_create**](JobCommentsApi.md#job_comment_create) | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
+[**job_comment_delete**](JobCommentsApi.md#job_comment_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
+[**job_comment_show**](JobCommentsApi.md#job_comment_show) | **GET** /projects/{project_id}/jobs/{job_id}/comments/{id} | Get a single job comment
+[**job_comment_update**](JobCommentsApi.md#job_comment_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/comments/{id} | Update a job comment
+[**job_comments_list**](JobCommentsApi.md#job_comments_list) | **GET** /projects/{project_id}/jobs/{job_id}/comments | List job comments
+
+
+
+## job_comment_create
+
+> JobComment job_comment_create(project_id, job_id, job_comment_create_parameters, opts)
+
+Create a job comment
+
+Create a new comment for a job.
+
+### 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::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+job_comment_create_parameters = Phrase::JobCommentCreateParameters.new # JobCommentCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a job comment
+  result = api_instance.job_comment_create(project_id, job_id, job_comment_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comment_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **job_comment_create_parameters** | [**JobCommentCreateParameters**](JobCommentCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**JobComment**](JobComment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_comment_delete
+
+> job_comment_delete(project_id, job_id, id, opts)
+
+Delete a job comment
+
+Delete an existing job comment.
+
+### 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::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job 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
+  #Delete a job comment
+  api_instance.job_comment_delete(project_id, job_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comment_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job 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
+
+
+## job_comment_show
+
+> Object job_comment_show(project_id, job_id, id, opts)
+
+Get a single job comment
+
+Get details on a single job comment.
+
+### 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::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job 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 job comment
+  result = api_instance.job_comment_show(project_id, job_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comment_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job 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<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## job_comment_update
+
+> Object job_comment_update(project_id, key_id, id, job_comment_update_parameters, opts)
+
+Update a job comment
+
+Update an existing job comment.
+
+### 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::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+id = 'id_example' # String | ID
+job_comment_update_parameters = Phrase::JobCommentUpdateParameters.new # JobCommentUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update a job comment
+  result = api_instance.job_comment_update(project_id, key_id, id, job_comment_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comment_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **key_id** | **String**| Translation Key ID | 
+ **id** | **String**| ID | 
+ **job_comment_update_parameters** | [**JobCommentUpdateParameters**](JobCommentUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_comments_list
+
+> Array&lt;Object&gt; job_comments_list(project_id, job_id, opts)
+
+List job comments
+
+List all comments for a job.
+
+### 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::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job 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
+  #List job comments
+  result = api_instance.job_comments_list(project_id, job_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comments_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(**Array&lt;Object&gt;**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Locale.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **rtl** | **Boolean** |  | [optional] 
 **plural_forms** | **Array<String>** |  | [optional] 
 **source_locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
+**fallback_locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
 
@@ -28,6 +29,7 @@ instance = Phrase::Locale.new(id: null,
                                  rtl: null,
                                  plural_forms: null,
                                  source_locale: null,
+                                 fallback_locale: null,
                                  created_at: null,
                                  updated_at: null)
 ```

data/docs/LocaleCreateParameters.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Verification System</a> feature. | [optional] 
 **rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional] 
 **source_locale_id** | **String** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional] 
+**fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional] 
 **unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
 **unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
 **autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional] 
@@ -27,6 +28,7 @@ instance = Phrase::LocaleCreateParameters.new(branch: my-feature-branch,
                                  main: null,
                                  rtl: null,
                                  source_locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 fallback_locale_id: abcd1234abcd1234abcd1234abcd1234,
                                  unverify_new_translations: null,
                                  unverify_updated_translations: null,
                                  autotranslate: null)

data/docs/LocaleDetails.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **rtl** | **Boolean** |  | [optional] 
 **plural_forms** | **Array<String>** |  | [optional] 
 **source_locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
+**fallback_locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
 **statistics** | [**LocaleStatistics**](LocaleStatistics.md) |  | [optional] 
@@ -29,6 +30,7 @@ instance = Phrase::LocaleDetails.new(id: null,
                                  rtl: null,
                                  plural_forms: null,
                                  source_locale: null,
+                                 fallback_locale: null,
                                  created_at: null,
                                  updated_at: null,
                                  statistics: null)

data/docs/LocaleUpdateParameters.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Verification System</a> feature. | [optional] 
 **rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional] 
 **source_locale_id** | **String** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional] 
+**fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional] 
 **unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
 **unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
 **autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional] 
@@ -27,6 +28,7 @@ instance = Phrase::LocaleUpdateParameters.new(branch: my-feature-branch,
                                  main: null,
                                  rtl: null,
                                  source_locale_id: abcd1234abcd1234abcd1234abcd1234,
+                                 fallback_locale_id: abcd1234abcd1234abcd1234abcd1234,
                                  unverify_new_translations: null,
                                  unverify_updated_translations: null,
                                  autotranslate: null)

data/docs/ScreenshotsApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 ## screenshot_create
 
-> Screenshot screenshot_create(project_id, screenshot_create_parameters, opts)
+> Screenshot screenshot_create(project_id, opts)
 
 Create a screenshot
 
@@ -38,14 +38,17 @@ end
 
 api_instance = Phrase::ScreenshotsApi.new
 project_id = 'project_id_example' # String | Project ID
-screenshot_create_parameters = Phrase::ScreenshotCreateParameters.new # ScreenshotCreateParameters | 
 opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'branch_example', # String | specify the branch to use
+  name: 'name_example', # String | Name of the screenshot
+  description: 'description_example', # String | Description of the screenshot
+  filename: File.new('/path/to/file') # File | Screenshot file
 }
 
 begin
   #Create a screenshot
-  result = api_instance.screenshot_create(project_id, screenshot_create_parameters, opts)
+  result = api_instance.screenshot_create(project_id, opts)
   pp result
 rescue Phrase::ApiError => e
   puts "Exception when calling ScreenshotsApi->screenshot_create: #{e}"
@@ -58,8 +61,11 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_id** | **String**| Project ID | 
- **screenshot_create_parameters** | [**ScreenshotCreateParameters**](ScreenshotCreateParameters.md)|  | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+ **name** | **String**| Name of the screenshot | [optional] 
+ **description** | **String**| Description of the screenshot | [optional] 
+ **filename** | **File**| Screenshot file | [optional] 
 
 ### Return type
 
@@ -71,7 +77,7 @@ Response<([**Screenshot**](Screenshot.md))>
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: multipart/form-data
 - **Accept**: application/json
 
 

data/docs/StyleguideCreateParameters.md

@@ -31,7 +31,7 @@ instance = Phrase::StyleguideCreateParameters.new(title: Web application style g
                                  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,
+                                 glossary_terms: Apartment, cabin, loft,
                                  grammar_consistency: null,
                                  literal_translation: Neutral,
                                  overall_tone: Tone should be fun and light,

data/docs/StyleguideUpdateParameters.md

@@ -31,7 +31,7 @@ instance = Phrase::StyleguideUpdateParameters.new(title: Web application style g
                                  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,
+                                 glossary_terms: Apartment, cabin, loft,
                                  grammar_consistency: null,
                                  literal_translation: Neutral,
                                  overall_tone: Tone should be fun and light,

data/docs/VersionsHistoryApi.md

@@ -82,7 +82,7 @@ Response<([**TranslationVersionWithUser**](TranslationVersionWithUser.md))>
 
 List all versions
 
-List all versions for the given translation.
+List all changes done to a given translation.
 
 ### Example