phrase 4.7.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 948f5fdc24faee23c2c48762da38f24b474b4e194c7b53c67158dc98a42d5753
-  data.tar.gz: 804500983b26670344bc10b91dc1cd638da8a724fa8292c2d592ce4a1ca34eec
+  metadata.gz: 409fc307ec1cf1fe89bd1944ca88b9a7998ec360ee909ab4d0c6944d78f7ffa6
+  data.tar.gz: dc6493d8a07d03cdaf7713ee90e2a323bff7baac98e9a596a0ac27a1126cab66
 SHA512:
-  metadata.gz: 30aeb12b985801bd58736231829c440ea343ff09a5d96b0911d61f15f565b2eaceef62014be0abfdae1dadfbfcb73a56f2c5b11dc50fe69ef5f29ab16d8bf0b1
-  data.tar.gz: 225496bb4df91acbaa6902c78ef4c939ac8c067c14869cc73911526b5fa4d51c0165c0e142c93ba24004b63f6f54e56ba821fc3ed4d8f28806f1c9ea28220f7f
+  metadata.gz: 0211d3d1ab6721de5775140a05496a1995c99bb42af00952884edd3aff4546c34810427783c74af787d284b68b5c2ec47feb582410af5241b178914c93b560e5
+  data.tar.gz: 4a1a9d7b2ae64db7802b7c5502db5cb8710e85509083e01d937d78c2a04b281d3e1411e499a4a46f24d1a722b1d340481b7aa8c2033a703787bd51ff78a16d7e

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [4.9.0](https://github.com/phrase/openapi/compare/ruby-v4.8.0...ruby-v4.9.0) (2025-08-01)
+
+
+### Features
+
+* **API:** Add support for `update_custom_metadata` option on upload ([#882](https://github.com/phrase/openapi/issues/882)) ([5b486ea](https://github.com/phrase/openapi/commit/5b486eabf30c84402a8e31911a5ba6fe3b343a89))
+
+## [4.8.0](https://github.com/phrase/openapi/compare/ruby-v4.7.0...ruby-v4.8.0) (2025-07-23)
+
+
+### Features
+
+* **API:** Job and job locale annotations #SCD-145 ([#867](https://github.com/phrase/openapi/issues/867)) ([95b6c2a](https://github.com/phrase/openapi/commit/95b6c2a2ab798d01f9bc0d53a22dbf817a5eb0ee))
+
 ## [4.7.0](https://github.com/phrase/openapi/compare/ruby-v4.6.0...ruby-v4.7.0) (2025-07-18)
 
 

data/README.md

@@ -7,7 +7,7 @@ Phrase Strings is a translation management platform for software projects. You c
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.7.0
+- Package version: 4.9.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./phrase-4.7.0.gem
+gem install ./phrase-4.9.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-4.7.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-4.9.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -206,6 +206,12 @@ Class | Method | HTTP request | Description
 *Phrase::InvitationsApi* | [**invitation_update**](docs/InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
 *Phrase::InvitationsApi* | [**invitation_update_settings**](docs/InvitationsApi.md#invitation_update_settings) | **PATCH** /projects/{project_id}/invitations/{id} | Update a member's invitation access
 *Phrase::InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
+*Phrase::JobAnnotationsApi* | [**job_annotation_delete**](docs/JobAnnotationsApi.md#job_annotation_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Delete a job annotation
+*Phrase::JobAnnotationsApi* | [**job_annotation_update**](docs/JobAnnotationsApi.md#job_annotation_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/annotations/{id} | Create/Update a job annotation
+*Phrase::JobAnnotationsApi* | [**job_annotations_list**](docs/JobAnnotationsApi.md#job_annotations_list) | **GET** /projects/{project_id}/jobs/{job_id}/annotations | List job annotations
+*Phrase::JobAnnotationsApi* | [**job_locale_annotation_delete**](docs/JobAnnotationsApi.md#job_locale_annotation_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id} | Delete a job locale annotation
+*Phrase::JobAnnotationsApi* | [**job_locale_annotation_update**](docs/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
+*Phrase::JobAnnotationsApi* | [**job_locale_annotations_list**](docs/JobAnnotationsApi.md#job_locale_annotations_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations | List job locale annotations
 *Phrase::JobCommentsApi* | [**job_comment_create**](docs/JobCommentsApi.md#job_comment_create) | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
 *Phrase::JobCommentsApi* | [**job_comment_delete**](docs/JobCommentsApi.md#job_comment_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
 *Phrase::JobCommentsApi* | [**job_comment_show**](docs/JobCommentsApi.md#job_comment_show) | **GET** /projects/{project_id}/jobs/{job_id}/comments/{id} | Get a single job comment
@@ -460,6 +466,9 @@ Class | Method | HTTP request | Description
  - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
  - [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
  - [Phrase::Job](docs/Job.md)
+ - [Phrase::JobAnnotation](docs/JobAnnotation.md)
+ - [Phrase::JobAnnotationShort](docs/JobAnnotationShort.md)
+ - [Phrase::JobAnnotationUpdateParameters](docs/JobAnnotationUpdateParameters.md)
  - [Phrase::JobComment](docs/JobComment.md)
  - [Phrase::JobCommentCreateParameters](docs/JobCommentCreateParameters.md)
  - [Phrase::JobCommentUpdateParameters](docs/JobCommentUpdateParameters.md)

data/docs/JobAnnotation.md

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

data/docs/JobAnnotationShort.md

@@ -0,0 +1,19 @@
+# Phrase::JobAnnotationShort
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**value** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobAnnotationShort.new(name: null,
+                                 value: null)
+```
+
+

data/docs/JobAnnotationUpdateParameters.md

@@ -0,0 +1,19 @@
+# Phrase::JobAnnotationUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | Annotation value | [optional] 
+**branch** | **String** | Branch name of the job | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobAnnotationUpdateParameters.new(value: Some value...,
+                                 branch: my-feature-branch)
+```
+
+

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
 

data/docs/KeyCreateParameters.md

@@ -38,7 +38,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@283dd82a,
+                                 screenshot: [B@307b954,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  default_translation_content: Default translation content,

data/docs/KeyUpdateParameters.md

@@ -36,7 +36,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@53365a58,
+                                 screenshot: [B@52fd6b76,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  xml_space_preserve: null,

data/docs/ProjectCreateParameters.md

@@ -37,7 +37,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@70d7282a,
+                                 project_image: [B@3feafba2,
                                  remove_project_image: null,
                                  account_id: abcd1234,
                                  point_of_contact: abcd1234,