phrase 4.5.0 → 4.8.0

data/docs/JobAnnotationsApi.md

@@ -0,0 +1,416 @@
+# Phrase::JobAnnotationsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**job_annotation_delete**](JobAnnotationsApi.md#job_annotation_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Delete a job annotation
+[**job_annotation_update**](JobAnnotationsApi.md#job_annotation_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Create/Update a job annotation
+[**job_annotations_list**](JobAnnotationsApi.md#job_annotations_list) | **GET** /projects/{project_id}/jobs/{job_id}/annotations | List job annotations
+[**job_locale_annotation_delete**](JobAnnotationsApi.md#job_locale_annotation_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Delete a job locale annotation
+[**job_locale_annotation_update**](JobAnnotationsApi.md#job_locale_annotation_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Create/Update a job locale annotation
+[**job_locale_annotations_list**](JobAnnotationsApi.md#job_locale_annotations_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations | List job locale annotations
+
+
+
+## job_annotation_delete
+
+> job_annotation_delete(project_id, job_id, id, opts)
+
+Delete a job annotation
+
+Delete an annotation 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::JobAnnotationsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | Name of the annotation to delete.
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | Branch to use
+}
+
+begin
+  #Delete a job annotation
+  api_instance.job_annotation_delete(project_id, job_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobAnnotationsApi->job_annotation_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| Name of the annotation to delete. | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| 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_annotation_update
+
+> JobAnnotation job_annotation_update(project_id, job_id, id, job_annotation_update_parameters, opts)
+
+Create/Update a job annotation
+
+Create or update an annotation for a job. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.
+
+### 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::JobAnnotationsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | Name of the annotation to set or update.
+job_annotation_update_parameters = Phrase::JobAnnotationUpdateParameters.new # JobAnnotationUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create/Update a job annotation
+  result = api_instance.job_annotation_update(project_id, job_id, id, job_annotation_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobAnnotationsApi->job_annotation_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| Name of the annotation to set or update. | 
+ **job_annotation_update_parameters** | [**JobAnnotationUpdateParameters**](JobAnnotationUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**JobAnnotation**](JobAnnotation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_annotations_list
+
+> Array&lt;JobAnnotation&gt; job_annotations_list(project_id, job_id, opts)
+
+List job annotations
+
+Retrieve a list of annotations 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::JobAnnotationsApi.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 | Branch to use
+}
+
+begin
+  #List job annotations
+  result = api_instance.job_annotations_list(project_id, job_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobAnnotationsApi->job_annotations_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**| Branch to use | [optional] 
+
+### Return type
+
+Response<([**Array&lt;JobAnnotation&gt;**](JobAnnotation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## job_locale_annotation_delete
+
+> job_locale_annotation_delete(project_id, job_id, job_locale_id, id, opts)
+
+Delete a job locale annotation
+
+Delete an annotation for a job locale.
+
+### 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::JobAnnotationsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+job_locale_id = 'job_locale_id_example' # String | Job Locale ID
+id = 'id_example' # String | Name of the annotation to delete.
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | Branch to use
+}
+
+begin
+  #Delete a job locale annotation
+  api_instance.job_locale_annotation_delete(project_id, job_id, job_locale_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobAnnotationsApi->job_locale_annotation_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **job_locale_id** | **String**| Job Locale ID | 
+ **id** | **String**| Name of the annotation to delete. | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| 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_locale_annotation_update
+
+> JobAnnotation job_locale_annotation_update(project_id, job_id, job_locale_id, id, job_annotation_update_parameters, opts)
+
+Create/Update a job locale annotation
+
+Create or update an annotation for a job locale. If the annotation already exists, it will be updated; otherwise, a new annotation will be created.
+
+### 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::JobAnnotationsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+job_locale_id = 'job_locale_id_example' # String | Job Locale ID
+id = 'id_example' # String | Name of the annotation to set or update.
+job_annotation_update_parameters = Phrase::JobAnnotationUpdateParameters.new # JobAnnotationUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create/Update a job locale annotation
+  result = api_instance.job_locale_annotation_update(project_id, job_id, job_locale_id, id, job_annotation_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobAnnotationsApi->job_locale_annotation_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **job_locale_id** | **String**| Job Locale ID | 
+ **id** | **String**| Name of the annotation to set or update. | 
+ **job_annotation_update_parameters** | [**JobAnnotationUpdateParameters**](JobAnnotationUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**JobAnnotation**](JobAnnotation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_locale_annotations_list
+
+> Array&lt;JobAnnotation&gt; job_locale_annotations_list(project_id, job_id, job_locale_id, opts)
+
+List job locale annotations
+
+Retrieve a list of annotations for a job locale.
+
+### 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::JobAnnotationsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+job_locale_id = 'job_locale_id_example' # String | Job Locale ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | Branch to use
+}
+
+begin
+  #List job locale annotations
+  result = api_instance.job_locale_annotations_list(project_id, job_id, job_locale_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobAnnotationsApi->job_locale_annotations_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **job_locale_id** | **String**| Job Locale ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| Branch to use | [optional] 
+
+### Return type
+
+Response<([**Array&lt;JobAnnotation&gt;**](JobAnnotation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/JobDetails.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **source_locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
 **locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
 **keys** | [**Array<KeyPreview>**](KeyPreview.md) |  | [optional] 
+**annotations** | [**Array<JobAnnotationShort>**](JobAnnotationShort.md) |  | [optional] 
 
 ## Code Sample
 
@@ -41,7 +42,8 @@ instance = Phrase::JobDetails.new(id: null,
                                  source_translations_updated_at: null,
                                  source_locale: null,
                                  locales: null,
-                                 keys: null)
+                                 keys: null,
+                                 annotations: null)
 ```
 
 

data/docs/JobLocale.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **completed** | **Boolean** |  | [optional] 
 **translation_completed_at** | **Time** |  | [optional] 
 **review_completed_at** | **Time** |  | [optional] 
+**annotations** | [**Array<JobAnnotationShort>**](JobAnnotationShort.md) |  | [optional] 
 
 ## Code Sample
 
@@ -25,7 +26,8 @@ instance = Phrase::JobLocale.new(id: null,
                                  teams: null,
                                  completed: null,
                                  translation_completed_at: null,
-                                 review_completed_at: null)
+                                 review_completed_at: null,
+                                 annotations: null)
 ```
 
 

data/docs/JobLocalesApi.md

@@ -312,7 +312,8 @@ 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 | Branch to use
+  branch: 'my-feature-branch', # String | Branch to use
+  include_annotations: true # Boolean | Include job-locale annotations in the response
 }
 
 begin
@@ -334,6 +335,7 @@ Name | Type | Description  | Notes
  **id** | **String**| ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **branch** | **String**| Branch to use | [optional] 
+ **include_annotations** | **Boolean**| Include job-locale annotations in the response | [optional] [default to false]
 
 ### Return type
 
@@ -512,7 +514,8 @@ 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 | Limit on the number of objects to be returned, between 1 and 100. 25 by default
-  branch: 'my-feature-branch' # String | Branch to use
+  branch: 'my-feature-branch', # String | Branch to use
+  include_annotations: true # Boolean | Include job-locale annotations in the response
 }
 
 begin
@@ -535,6 +538,7 @@ Name | Type | Description  | Notes
  **page** | **Integer**| Page number | [optional] 
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
  **branch** | **String**| Branch to use | [optional] 
+ **include_annotations** | **Boolean**| Include job-locale annotations in the response | [optional] [default to false]
 
 ### Return type
 

data/docs/JobsApi.md

@@ -499,7 +499,8 @@ 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
+  branch: 'my-feature-branch', # String | Branch to use
+  include_annotations: true # Boolean | Include job-locale annotations in the response
 }
 
 begin
@@ -519,7 +520,8 @@ 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] 
+ **branch** | **String**| Branch to use | [optional] 
+ **include_annotations** | **Boolean**| Include job-locale annotations in the response | [optional] [default to false]
 
 ### Return type
 
@@ -761,7 +763,7 @@ opts = {
   per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
   owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
   assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
-  state: 'completed', # String | filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
+  state: 'completed', # String | filter by state of job; valid states are: `draft`, `in_progress`, `completed`
   updated_since: '2013-02-21T00:00:00.000Z' # String | filter by jobs updated since given date
 }
 
@@ -785,7 +787,7 @@ Name | Type | Description  | Notes
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
  **owned_by** | **String**| filter by user owning job | [optional] 
  **assigned_to** | **String**| filter by user assigned to job | [optional] 
- **state** | **String**| filter by state of job; valid states are: &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt; | [optional] 
+ **state** | **String**| filter by state of job; valid states are: &#x60;draft&#x60;, &#x60;in_progress&#x60;, &#x60;completed&#x60; | [optional] 
  **updated_since** | **String**| filter by jobs updated since given date | [optional] 
 
 ### Return type
@@ -835,7 +837,7 @@ opts = {
   branch: 'my-feature-branch', # String | Branch to use
   owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
   assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
-  state: 'completed', # String | filter by state of job; valid states are: <code>draft</code>, <code>in_progress</code>, <code>completed</code>
+  state: 'completed', # String | filter by state of job; valid states are: `draft`, `in_progress`, `completed`
   updated_since: '2013-02-21T00:00:00.000Z' # String | filter by jobs updated since given date
 }
 
@@ -860,7 +862,7 @@ Name | Type | Description  | Notes
  **branch** | **String**| Branch to use | [optional] 
  **owned_by** | **String**| filter by user owning job | [optional] 
  **assigned_to** | **String**| filter by user assigned to job | [optional] 
- **state** | **String**| filter by state of job; valid states are: &lt;code&gt;draft&lt;/code&gt;, &lt;code&gt;in_progress&lt;/code&gt;, &lt;code&gt;completed&lt;/code&gt; | [optional] 
+ **state** | **String**| filter by state of job; valid states are: &#x60;draft&#x60;, &#x60;in_progress&#x60;, &#x60;completed&#x60; | [optional] 
  **updated_since** | **String**| filter by jobs updated since given date | [optional] 
 
 ### Return type

data/docs/KeyCreateParameters.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **name** | **String** | Key name | 
 **description** | **String** | Key description (usually includes contextual information for translators) | [optional] 
 **plural** | **Boolean** | Indicates whether key supports pluralization | [optional] 
+**use_ordinal_rules** | **Boolean** | Indicates whether key uses ordinal rules for pluralization | [optional] 
 **name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional] 
 **data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional] 
 **tags** | **String** | List of tags separated by comma to be associated with the key. | [optional] 
@@ -32,11 +33,12 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
                                  name: home.index.headline,
                                  description: Some description worth knowing...,
                                  plural: null,
+                                 use_ordinal_rules: null,
                                  name_plural: home.index.headlines,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@905e189,
+                                 screenshot: [B@3e6b4f51,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  default_translation_content: Default translation content,

data/docs/KeyPreview.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **id** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **plural** | **Boolean** |  | [optional] 
+**use_ordinal_rules** | **Boolean** |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'Phrase'
 
 instance = Phrase::KeyPreview.new(id: null,
                                  name: null,
-                                 plural: null)
+                                 plural: null,
+                                 use_ordinal_rules: null)
 ```
 
 

data/docs/KeyUpdateParameters.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **name** | **String** | Key name | [optional] 
 **description** | **String** | Key description (usually includes contextual information for translators) | [optional] 
 **plural** | **Boolean** | Indicates whether key supports pluralization | [optional] 
+**use_ordinal_rules** | **Boolean** | Indicates whether key uses ordinal rules for pluralization | [optional] 
 **name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional] 
 **data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional] 
 **tags** | **String** | List of tags separated by comma to be associated with the key. | [optional] 
@@ -30,11 +31,12 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
                                  name: home.index.headline,
                                  description: Some description worth knowing...,
                                  plural: null,
+                                 use_ordinal_rules: null,
                                  name_plural: home.index.headlines,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@7b31281b,
+                                 screenshot: [B@3ca07d9,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  xml_space_preserve: null,

data/docs/KeysApi.md

@@ -304,7 +304,7 @@ 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: 'my-feature-branch', # String | specify the branch to use
-  q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
+  q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).  The following qualifiers are also supported in the search term:  - `ids:key_id,...` for queries on a comma-separated list of ids - `name:key_name` for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads  **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored.  Find more examples [here](/en/api/strings/usage-examples). 
   locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
 }
 
@@ -325,7 +325,7 @@ 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] 
- **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt;   &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt;   &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes&lt;/li&gt;   &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt;   &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt;   &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt;   &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; &lt;br/&gt; &lt;p&gt;&lt;strong&gt;Caution:&lt;/strong&gt; Query parameters with empty values will be treated as though they are not included in the request and will be ignored.&lt;/p&gt; &lt;br/&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.  | [optional] 
+ **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).  The following qualifiers are also supported in the search term:  - &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids - &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes - &#x60;tags:tag_name&#x60; to filter for keys with certain tags - &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) - &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries - &#x60;unmentioned_in_upload:upload_id,...&#x60; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads  **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored.  Find more examples [here](/en/api/strings/usage-examples).  | [optional] 
  **locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
 
 ### Return type
@@ -501,7 +501,7 @@ opts = {
   branch: 'my-feature-branch', # String | specify the branch to use
   sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
   order: 'desc', # String | Order direction. Can be one of: asc, desc.
-  q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id,...</code> to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in <strong>all</strong> uploads</li> </ul> <br/> <p><strong>Caution:</strong> Query parameters with empty values will be treated as though they are not included in the request and will be ignored.</p> <br/> Find more examples <a href=\"#overview--usage-examples\">here</a>. 
+  q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).  The following qualifiers are also supported in the search term:  - `ids:key_id,...` for queries on a comma-separated list of ids - `name:key_name` for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes - `tags:tag_name` to filter for keys with certain tags - `translated:{true|false}` for translation status (also requires `locale_id` to be specified) - `updated_at:{>=|<=}2013-02-21T00:00:00Z` for date range queries - `unmentioned_in_upload:upload_id,...` to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads  **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored.  Find more examples [here](/en/api/strings/usage-examples). 
   locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
 }
 
@@ -526,7 +526,7 @@ Name | Type | Description  | Notes
  **branch** | **String**| specify the branch to use | [optional] 
  **sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional] 
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional] 
- **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt;   &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt;   &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes&lt;/li&gt;   &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt;   &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt;   &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt;   &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id,...&lt;/code&gt; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in &lt;strong&gt;all&lt;/strong&gt; uploads&lt;/li&gt; &lt;/ul&gt; &lt;br/&gt; &lt;p&gt;&lt;strong&gt;Caution:&lt;/strong&gt; Query parameters with empty values will be treated as though they are not included in the request and will be ignored.&lt;/p&gt; &lt;br/&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;.  | [optional] 
+ **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).  The following qualifiers are also supported in the search term:  - &#x60;ids:key_id,...&#x60; for queries on a comma-separated list of ids - &#x60;name:key_name&#x60; for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes - &#x60;tags:tag_name&#x60; to filter for keys with certain tags - &#x60;translated:{true|false}&#x60; for translation status (also requires &#x60;locale_id&#x60; to be specified) - &#x60;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&#x60; for date range queries - &#x60;unmentioned_in_upload:upload_id,...&#x60; to filter keys unmentioned within upload. When multiple upload IDs provided, matches only keys not mentioned in **all** uploads  **Caution:** Query parameters with empty values will be treated as though they are not included in the request and will be ignored.  Find more examples [here](/en/api/strings/usage-examples).  | [optional] 
  **locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional] 
 
 ### Return type