phrase 4.14.0 → 4.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6eafb6674f53665915555e2352445b2c1b81a981cc7d472ac7684855ca5061cc
-  data.tar.gz: 6b630a9fcb6f2376c7bec8c179754b60b1d2c9109e18010714a35a00fef6067c
+  metadata.gz: 45d6f1838ce11f059ebdd0b8edb97904465814670820db88ac973ed769e5ffe9
+  data.tar.gz: 7e2e8e6b3984121cdb98b7cb2819fe9b82aa96fa2a5e550b31085f93851334dc
 SHA512:
-  metadata.gz: 771899ee1169536d3e35957c20cd8b4ce58dd81552ee1a979a02f2b5d10215ed4a5f53b25f6f06e67f9b4b2b95554b0e8545f9e8fb4d937c31e5f2865aa027fd
-  data.tar.gz: d75c3aa7238687236f7e1d917676dbac4e82a6381a17802d16e6ff0fea2b87ac27e909a8818ad3c3c0afcccf3dd2576c5a3a6866ee093018cbd2359157629d64
+  metadata.gz: 6701eee93a798aac96f015485b8b08c84801aa01b4a5179291106da017cb44b677806a8dbe203c9abb3b53474ba1c85d021692159bcb9d5a7d16893651ac8b68
+  data.tar.gz: 6a64754c48c1deb723a68c2d8698c901def5fdbfe8cc56174d7fe8c2aa683eed897ae0edaa52fa2572ca0ee5d500e58e7bd8ca6daca1c3d191ae9e2a278afab1

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.14.1](https://github.com/phrase/openapi/compare/ruby-v4.14.0...ruby-v4.14.1) (2025-11-10)
+
+
+### Bug Fixes
+
+* **API:** Add omit_translation_keys to Jobs#show endpoint ([#957](https://github.com/phrase/openapi/issues/957)) ([23ece66](https://github.com/phrase/openapi/commit/23ece66b05fc748a4598ce876cb2954ed1a385cc))
+
 ## [4.14.0](https://github.com/phrase/openapi/compare/ruby-v4.13.0...ruby-v4.14.0) (2025-10-27)
 
 

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.14.0
+- Package version: 4.14.1
 - 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.14.0.gem
+gem install ./phrase-4.14.1.gem
 ```
 
-(for development, run `gem install --dev ./phrase-4.14.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-4.14.1.gem` to install the development dependencies)
 
 ## Getting Started
 

data/docs/JobsApi.md

@@ -500,7 +500,8 @@ 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
-  include_annotations: true # Boolean | Include job-locale annotations in the response
+  include_annotations: true, # Boolean | Include job-locale annotations in the response
+  omit_translation_keys: true # Boolean | Omit translation keys in the response to reduce payload size for bigger jobs
 }
 
 begin
@@ -522,6 +523,7 @@ Name | Type | Description  | Notes
  **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]
+ **omit_translation_keys** | **Boolean**| Omit translation keys in the response to reduce payload size for bigger jobs | [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@1df2b230,
+                                 screenshot: [B@38171f9,
                                  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@37d85eec,
+                                 screenshot: [B@3614cd03,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  xml_space_preserve: null,

data/docs/KeysExcludeParameters.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [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: - `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  Find more examples [here](/en/api/strings/usage-examples).      | [optional] 
-**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional] 
+**target_locale_id** | **String** | Exclude translations in locale | [optional] 
 **tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional] 
 
 ## Code Sample

data/docs/KeysIncludeParameters.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [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:  * `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  Find more examples [here](/en/api/strings/usage-examples).  | [optional] 
-**target_locale_id** | **String** | Locale used to exlcude or include keys. | [optional] 
+**target_locale_id** | **String** | Include translations in locale | [optional] 
 **tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional] 
 
 ## Code Sample

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@e80fc9d,
+                                 project_image: [B@37d85eec,
                                  remove_project_image: null,
                                  account_id: abcd1234,
                                  point_of_contact: abcd1234,

data/docs/ProjectUpdateParameters.md

@@ -39,7 +39,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@4abc179d,
+                                 project_image: [B@14443c86,
                                  remove_project_image: false,
                                  workflow: review,
                                  machine_translation_enabled: true,

data/docs/ScreenshotUpdateParameters.md

@@ -17,7 +17,7 @@ require 'Phrase'
 instance = Phrase::ScreenshotUpdateParameters.new(branch: my-feature-branch,
                                  name: A screenshot name,
                                  description: A screenshot description,
-                                 filename: [B@141fc03a)
+                                 filename: [B@76db7ef0)
 ```
 
 

data/docs/UploadSummary.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **locales_created** | **Integer** |  | [optional] 
 **translation_keys_created** | **Integer** |  | [optional] 
 **translation_keys_updated** | **Integer** |  | [optional] 
-**translation_keys_unmentioned** | **Integer** |  | [optional] 
+**translation_keys_unmentioned** | **Integer** | The number of translation keys in the project that were not mentioned in the upload.  Note: this field is not calculated (and shows 0) if the upload contains more than 10,000 keys.  | [optional] 
 **translations_created** | **Integer** |  | [optional] 
 **translations_updated** | **Integer** |  | [optional] 
 **tags_created** | **Integer** |  | [optional] 

data/docs/UploadsApi.md

@@ -16,7 +16,7 @@ Method | HTTP request | Description
 
 Upload a new file
 
-Upload a new language file. Creates necessary resources in your project.
+Upload a new language file. Creates necessary resources in your project.  Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0). 
 
 ### Example
 

data/lib/phrase/api/jobs_api.rb

@@ -553,6 +553,7 @@ module Phrase
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [String] :branch Branch to use
     # @option opts [Boolean] :include_annotations Include job-locale annotations in the response (default to false)
+    # @option opts [Boolean] :omit_translation_keys Omit translation keys in the response to reduce payload size for bigger jobs (default to false)
     # @return [JobDetails]
     def job_show(project_id, id, opts = {})
       data, _status_code, _headers = job_show_with_http_info(project_id, id, opts)
@@ -567,6 +568,7 @@ module Phrase
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [String] :branch Branch to use
     # @option opts [Boolean] :include_annotations Include job-locale annotations in the response
+    # @option opts [Boolean] :omit_translation_keys Omit translation keys in the response to reduce payload size for bigger jobs
     # @return [Array<(Response<(JobDetails)>, Integer, Hash)>] Response<(JobDetails)> data, response status code and response headers
     def job_show_with_http_info(project_id, id, opts = {})
       if @api_client.config.debugging
@@ -587,6 +589,7 @@ module Phrase
       query_params = opts[:query_params] || {}
       query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
       query_params[:'include_annotations'] = opts[:'include_annotations'] if !opts[:'include_annotations'].nil?
+      query_params[:'omit_translation_keys'] = opts[:'omit_translation_keys'] if !opts[:'omit_translation_keys'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/phrase/api/uploads_api.rb

@@ -8,7 +8,7 @@ module Phrase
       @api_client = api_client
     end
     # Upload a new file
-    # Upload a new language file. Creates necessary resources in your project.
+    # Upload a new language file. Creates necessary resources in your project.  Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0). 
     # @param project_id [String] Project ID
     # @param file [File] File to be imported
     # @param file_format [String] File format. Auto-detected when possible and not specified.
@@ -41,7 +41,7 @@ module Phrase
     end
 
     # Upload a new file
-    # Upload a new language file. Creates necessary resources in your project.
+    # Upload a new language file. Creates necessary resources in your project.  Note: be aware of [upload limits](https://support.phrase.com/hc/en-us/articles/8548271212188-Phrase-Strings-Limits#file-size-upload-limits-0-0). 
     # @param project_id [String] Project ID
     # @param file [File] File to be imported
     # @param file_format [String] File format. Auto-detected when possible and not specified.

data/lib/phrase/models/keys_exclude_parameters.rb

@@ -8,7 +8,7 @@ module Phrase
     # 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  Find more examples [here](/en/api/strings/usage-examples).     
     attr_accessor :q
 
-    # Locale used to exlcude or include keys.
+    # Exclude translations in locale
     attr_accessor :target_locale_id
 
     # Tag or comma-separated list of tags to add to the matching collection of keys

data/lib/phrase/models/keys_include_parameters.rb

@@ -8,7 +8,7 @@ module Phrase
     # 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  Find more examples [here](/en/api/strings/usage-examples). 
     attr_accessor :q
 
-    # Locale used to exlcude or include keys.
+    # Include translations in locale
     attr_accessor :target_locale_id
 
     # Tag or comma-separated list of tags to add to the matching collection of keys

data/lib/phrase/models/upload_summary.rb

@@ -8,6 +8,7 @@ module Phrase
 
     attr_accessor :translation_keys_updated
 
+    # The number of translation keys in the project that were not mentioned in the upload.  Note: this field is not calculated (and shows 0) if the upload contains more than 10,000 keys. 
     attr_accessor :translation_keys_unmentioned
 
     attr_accessor :translations_created

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '4.14.0'
+  VERSION = '4.14.1'
 end

data/spec/api/jobs_api_spec.rb

@@ -133,6 +133,7 @@ describe 'JobsApi' do
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @option opts [String] :branch Branch to use
   # @option opts [Boolean] :include_annotations Include job-locale annotations in the response
+  # @option opts [Boolean] :omit_translation_keys Omit translation keys in the response to reduce payload size for bigger jobs
   # @return [JobDetails]
   describe 'job_show test' do
     it 'should work' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phrase
 version: !ruby/object:Gem::Version
-  version: 4.14.0
+  version: 4.14.1
 platform: ruby
 authors:
 - Phrase
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-27 00:00:00.000000000 Z
+date: 2025-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus