phrase 4.33.0 → 4.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb68f3e7de65794408fd8af7a561ef3b36a2e2220a6d3e1fb1b70ad12b10ddda
-  data.tar.gz: 9c0223415b68d524ccc0583496b23351d6caaedb44f1cccd04e5088eff221ec4
+  metadata.gz: 20c479a028a5c32ac1919a3e60bb3b6856319b440ffeca3197e7ad36d269619f
+  data.tar.gz: ff3f4f16b7d48e49203d2ccf5109c9b1a491d5276a8ba60c96b4fe2a129a4242
 SHA512:
-  metadata.gz: '08ba82de28c3449d6abd1db15b585667c0fffb054a230a351a8dcd5c8073617ab4c2d7315ca8bf2ed4a7acf8fb6e02ee736631bbb07806e1e1643371e875857c'
-  data.tar.gz: 24c734ba8c05035c02b10128f73ced9d4c442df9ac09d5184097cf66076095a202f1c3d9eb8d797286c0960e9ad213cc7931344ff1424ac801e7c22463652623
+  metadata.gz: 0c318a2a14d1cdc5ca2d9eb47636585b0e7582a2bc3c2b7b044dd115e5392f58e3c4b2c5f9ae39903393b70c46ec2a8dbd6a18cba8ce01a70bf308027e2e1b0f
+  data.tar.gz: dbd8d3007e70708aee87fe3632c24b48cf5ec948c3e632bfb1a0be1aba06ed748c1cf1f16ef77ce24133336d996ecbcf24a23bcb421822219d3815358ead76d2

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.34.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.33.0...ruby-v4.34.0) (2026-11-05)
+
+
+### Features
+
+* **API:** add linked_key field to key list responses #STRINGS-4425 ([#1361](https://github.com/phrase/strings-openapi/issues/1361)) ([e2cd0cd](https://github.com/phrase/strings-openapi/commit/e2cd0cdf327bed106f7c37f97324e77e997f0994))
+
 ## [4.33.0](https://github.com/phrase/strings-openapi/compare/ruby-v4.32.0...ruby-v4.33.0) (2026-11-04)
 
 

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.33.0
+- Package version: 4.34.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.33.0.gem
+gem install ./phrase-4.34.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-4.33.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-4.34.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -649,6 +649,8 @@ Class | Method | HTTP request | Description
  - [Phrase::TranslationIncludeParameters](docs/TranslationIncludeParameters.md)
  - [Phrase::TranslationKey](docs/TranslationKey.md)
  - [Phrase::TranslationKeyDetails](docs/TranslationKeyDetails.md)
+ - [Phrase::TranslationKeyLinkedKey](docs/TranslationKeyLinkedKey.md)
+ - [Phrase::TranslationKeyLinkedKeyParent](docs/TranslationKeyLinkedKeyParent.md)
  - [Phrase::TranslationOrder](docs/TranslationOrder.md)
  - [Phrase::TranslationParent](docs/TranslationParent.md)
  - [Phrase::TranslationReviewParameters](docs/TranslationReviewParameters.md)

data/docs/KeysApi.md

@@ -502,7 +502,8 @@ opts = {
   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).  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.
+  locale_id: 'abcd1234abcd1234abcd1234abcd1234', # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
+  include_linked_keys: true # Boolean | When set to `true`, each key object in the response includes a `linked_key` field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent's id and name (for child keys). Keys with no active link return `linked_key: null`. Omit this parameter or set it to `false` to leave the `linked_key` field out of the response entirely. 
 }
 
 begin
@@ -528,6 +529,7 @@ Name | Type | Description  | Notes
  **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).  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] 
+ **include_linked_keys** | **Boolean**| When set to &#x60;true&#x60;, each key object in the response includes a &#x60;linked_key&#x60; field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent&#39;s id and name (for child keys). Keys with no active link return &#x60;linked_key: null&#x60;. Omit this parameter or set it to &#x60;false&#x60; to leave the &#x60;linked_key&#x60; field out of the response entirely.  | [optional] 
 
 ### Return type
 
@@ -573,7 +575,8 @@ keys_search_parameters = Phrase::KeysSearchParameters.new # KeysSearchParameters
 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
+  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  include_linked_keys: true # Boolean | When set to `true`, each key object in the response includes a `linked_key` field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent's id and name (for child keys). Keys with no active link return `linked_key: null`. Omit this parameter or set it to `false` to leave the `linked_key` field out of the response entirely. 
 }
 
 begin
@@ -595,6 +598,7 @@ Name | Type | Description  | Notes
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **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] 
+ **include_linked_keys** | **Boolean**| When set to &#x60;true&#x60;, each key object in the response includes a &#x60;linked_key&#x60; field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent&#39;s id and name (for child keys). Keys with no active link return &#x60;linked_key: null&#x60;. Omit this parameter or set it to &#x60;false&#x60; to leave the &#x60;linked_key&#x60; field out of the response entirely.  | [optional] 
 
 ### Return type
 

data/docs/TranslationKey.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **data_type** | **String** |  | [optional] 
 **created_at** | **Time** |  | [optional] 
 **updated_at** | **Time** |  | [optional] 
+**linked_key** | [**TranslationKeyLinkedKey**](TranslationKeyLinkedKey.md) |  | [optional] 
 
 ## Code Sample
 
@@ -29,7 +30,8 @@ instance = Phrase::TranslationKey.new(id: nil,
                                  tags: nil,
                                  data_type: nil,
                                  created_at: nil,
-                                 updated_at: nil)
+                                 updated_at: nil,
+                                 linked_key: nil)
 ```
 
 

data/docs/TranslationKeyDetails.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **data_type** | **String** |  | [optional] 
 **created_at** | **Time** |  | [optional] 
 **updated_at** | **Time** |  | [optional] 
+**linked_key** | [**TranslationKeyLinkedKey**](TranslationKeyLinkedKey.md) |  | [optional] 
 **name_plural** | **String** |  | [optional] 
 **comments_count** | **Integer** |  | [optional] 
 **max_characters_allowed** | **Integer** |  | [optional] 
@@ -40,6 +41,7 @@ instance = Phrase::TranslationKeyDetails.new(id: nil,
                                  data_type: nil,
                                  created_at: nil,
                                  updated_at: nil,
+                                 linked_key: nil,
                                  name_plural: nil,
                                  comments_count: nil,
                                  max_characters_allowed: nil,

data/docs/TranslationKeyLinkedKey.md

@@ -0,0 +1,21 @@
+# Phrase::TranslationKeyLinkedKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | Whether this key is the parent or the child in the link relationship. | [optional] 
+**parent** | [**TranslationKeyLinkedKeyParent**](TranslationKeyLinkedKeyParent.md) |  | [optional] 
+**children_count** | **Integer** | The number of linked child keys. Set for parent keys. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'phrase'
+
+instance = Phrase::TranslationKeyLinkedKey.new(role: nil,
+                                 parent: nil,
+                                 children_count: 3)
+```
+
+

data/docs/TranslationKeyLinkedKeyParent.md

@@ -0,0 +1,19 @@
+# Phrase::TranslationKeyLinkedKeyParent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The parent key's public identifier (code). | [optional] 
+**name** | **String** | The parent key's name. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'phrase'
+
+instance = Phrase::TranslationKeyLinkedKeyParent.new(id: 'abc12345def67890abc12345def67890',
+                                 name: 'home.welcome.title')
+```
+
+

data/lib/phrase/api/keys_api.rb

@@ -546,6 +546,7 @@ module Phrase
     # @option opts [String] :order Order direction. Can be one of: asc, desc.
     # @option opts [String] :q 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). 
     # @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
+    # @option opts [Boolean] :include_linked_keys When set to `true`, each key object in the response includes a `linked_key` field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent's id and name (for child keys). Keys with no active link return `linked_key: null`. Omit this parameter or set it to `false` to leave the `linked_key` field out of the response entirely. 
     # @return [Array<TranslationKey>]
     def keys_list(project_id, opts = {})
       data, _status_code, _headers = keys_list_with_http_info(project_id, opts)
@@ -564,6 +565,7 @@ module Phrase
     # @option opts [String] :order Order direction. Can be one of: asc, desc.
     # @option opts [String] :q 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). 
     # @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
+    # @option opts [Boolean] :include_linked_keys When set to &#x60;true&#x60;, each key object in the response includes a &#x60;linked_key&#x60; field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent&#39;s id and name (for child keys). Keys with no active link return &#x60;linked_key: null&#x60;. Omit this parameter or set it to &#x60;false&#x60; to leave the &#x60;linked_key&#x60; field out of the response entirely. 
     # @return [Array<(Response<(Array<TranslationKey>)>, Integer, Hash)>] Response<(Array<TranslationKey>)> data, response status code and response headers
     def keys_list_with_http_info(project_id, opts = {})
       if @api_client.config.debugging
@@ -585,6 +587,7 @@ module Phrase
       query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
       query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
       query_params[:'locale_id'] = opts[:'locale_id'] if !opts[:'locale_id'].nil?
+      query_params[:'include_linked_keys'] = opts[:'include_linked_keys'] if !opts[:'include_linked_keys'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -629,6 +632,7 @@ module Phrase
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+    # @option opts [Boolean] :include_linked_keys When set to &#x60;true&#x60;, each key object in the response includes a &#x60;linked_key&#x60; field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent&#39;s id and name (for child keys). Keys with no active link return &#x60;linked_key: null&#x60;. Omit this parameter or set it to &#x60;false&#x60; to leave the &#x60;linked_key&#x60; field out of the response entirely. 
     # @return [Array<TranslationKey>]
     def keys_search(project_id, keys_search_parameters, opts = {})
       data, _status_code, _headers = keys_search_with_http_info(project_id, keys_search_parameters, opts)
@@ -643,6 +647,7 @@ module Phrase
     # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
     # @option opts [Integer] :page Page number
     # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+    # @option opts [Boolean] :include_linked_keys When set to &#x60;true&#x60;, each key object in the response includes a &#x60;linked_key&#x60; field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent&#39;s id and name (for child keys). Keys with no active link return &#x60;linked_key: null&#x60;. Omit this parameter or set it to &#x60;false&#x60; to leave the &#x60;linked_key&#x60; field out of the response entirely. 
     # @return [Array<(Response<(Array<TranslationKey>)>, Integer, Hash)>] Response<(Array<TranslationKey>)> data, response status code and response headers
     def keys_search_with_http_info(project_id, keys_search_parameters, opts = {})
       if @api_client.config.debugging
@@ -663,6 +668,7 @@ module Phrase
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'include_linked_keys'] = opts[:'include_linked_keys'] if !opts[:'include_linked_keys'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/phrase/models/translation_key.rb

@@ -22,6 +22,8 @@ module Phrase
 
     attr_accessor :updated_at
 
+    attr_accessor :linked_key
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -34,7 +36,8 @@ module Phrase
         :'tags' => :'tags',
         :'data_type' => :'data_type',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at'
+        :'updated_at' => :'updated_at',
+        :'linked_key' => :'linked_key'
       }
     end
 
@@ -50,13 +53,15 @@ module Phrase
         :'tags' => :'Array<String>',
         :'data_type' => :'String',
         :'created_at' => :'DateTime',
-        :'updated_at' => :'DateTime'
+        :'updated_at' => :'DateTime',
+        :'linked_key' => :'TranslationKeyLinkedKey'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'linked_key'
       ])
     end
 
@@ -116,6 +121,10 @@ module Phrase
       if attributes.key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
+
+      if attributes.key?(:'linked_key')
+        self.linked_key = attributes[:'linked_key']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -145,7 +154,8 @@ module Phrase
           tags == o.tags &&
           data_type == o.data_type &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          linked_key == o.linked_key
     end
 
     # @see the `==` method
@@ -157,7 +167,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, name_hash, plural, use_ordinal_rules, tags, data_type, created_at, updated_at].hash
+      [id, name, description, name_hash, plural, use_ordinal_rules, tags, data_type, created_at, updated_at, linked_key].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/translation_key_details.rb

@@ -22,6 +22,8 @@ module Phrase
 
     attr_accessor :updated_at
 
+    attr_accessor :linked_key
+
     attr_accessor :name_plural
 
     attr_accessor :comments_count
@@ -55,6 +57,7 @@ module Phrase
         :'data_type' => :'data_type',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
+        :'linked_key' => :'linked_key',
         :'name_plural' => :'name_plural',
         :'comments_count' => :'comments_count',
         :'max_characters_allowed' => :'max_characters_allowed',
@@ -81,6 +84,7 @@ module Phrase
         :'data_type' => :'String',
         :'created_at' => :'DateTime',
         :'updated_at' => :'DateTime',
+        :'linked_key' => :'TranslationKeyLinkedKey',
         :'name_plural' => :'String',
         :'comments_count' => :'Integer',
         :'max_characters_allowed' => :'Integer',
@@ -97,6 +101,7 @@ module Phrase
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'linked_key',
       ])
     end
 
@@ -164,6 +169,10 @@ module Phrase
         self.updated_at = attributes[:'updated_at']
       end
 
+      if attributes.key?(:'linked_key')
+        self.linked_key = attributes[:'linked_key']
+      end
+
       if attributes.key?(:'name_plural')
         self.name_plural = attributes[:'name_plural']
       end
@@ -235,6 +244,7 @@ module Phrase
           data_type == o.data_type &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
+          linked_key == o.linked_key &&
           name_plural == o.name_plural &&
           comments_count == o.comments_count &&
           max_characters_allowed == o.max_characters_allowed &&
@@ -256,7 +266,7 @@ module Phrase
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, name_hash, plural, use_ordinal_rules, tags, data_type, created_at, updated_at, name_plural, comments_count, max_characters_allowed, screenshot_url, unformatted, xml_space_preserve, original_file, format_value_type, creator, custom_metadata].hash
+      [id, name, description, name_hash, plural, use_ordinal_rules, tags, data_type, created_at, updated_at, linked_key, name_plural, comments_count, max_characters_allowed, screenshot_url, unformatted, xml_space_preserve, original_file, format_value_type, creator, custom_metadata].hash
     end
 
     # Builds the object from hash

data/lib/phrase/models/translation_key_linked_key.rb

@@ -0,0 +1,253 @@
+require 'date'
+
+module Phrase
+  # Describes a key's role in a parent–child link relationship.
+  class TranslationKeyLinkedKey
+    # Whether this key is the parent or the child in the link relationship.
+    attr_accessor :role
+
+    attr_accessor :parent
+
+    # The number of linked child keys. Set for parent keys.
+    attr_accessor :children_count
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'role' => :'role',
+        :'parent' => :'parent',
+        :'children_count' => :'children_count'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'role' => :'String',
+        :'parent' => :'TranslationKeyLinkedKeyParent',
+        :'children_count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'parent',
+        :'children_count'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::TranslationKeyLinkedKey` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::TranslationKeyLinkedKey`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'role')
+        self.role = attributes[:'role']
+      end
+
+      if attributes.key?(:'parent')
+        self.parent = attributes[:'parent']
+      end
+
+      if attributes.key?(:'children_count')
+        self.children_count = attributes[:'children_count']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      role_validator = EnumAttributeValidator.new('String', ["parent", "child"])
+      return false unless role_validator.valid?(@role)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] role Object to be assigned
+    def role=(role)
+      validator = EnumAttributeValidator.new('String', ["parent", "child"])
+      unless validator.valid?(role)
+        fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
+      end
+      @role = role
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          role == o.role &&
+          parent == o.parent &&
+          children_count == o.children_count
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [role, parent, children_count].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :Time
+        Time.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Phrase.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/phrase/models/translation_key_linked_key_parent.rb

@@ -0,0 +1,208 @@
+require 'date'
+
+module Phrase
+  # The parent key's public identifier and name. Set for child keys.
+  class TranslationKeyLinkedKeyParent
+    # The parent key's public identifier (code).
+    attr_accessor :id
+
+    # The parent key's name.
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::TranslationKeyLinkedKeyParent` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::TranslationKeyLinkedKeyParent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :Time
+        Time.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Phrase.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/phrase/version.rb

@@ -1,3 +1,3 @@
 module Phrase
-  VERSION = '4.33.0'
+  VERSION = '4.34.0'
 end

data/lib/phrase.rb

@@ -222,6 +222,8 @@ require 'phrase/models/translation_exclude_parameters'
 require 'phrase/models/translation_include_parameters'
 require 'phrase/models/translation_key'
 require 'phrase/models/translation_key_details'
+require 'phrase/models/translation_key_linked_key'
+require 'phrase/models/translation_key_linked_key_parent'
 require 'phrase/models/translation_order'
 require 'phrase/models/translation_parent'
 require 'phrase/models/translation_review_parameters'

data/spec/api/keys_api_spec.rb

@@ -136,6 +136,7 @@ describe 'KeysApi' do
   # @option opts [String] :order Order direction. Can be one of: asc, desc.
   # @option opts [String] :q 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). 
   # @option opts [String] :locale_id Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
+  # @option opts [Boolean] :include_linked_keys When set to `true`, each key object in the response includes a `linked_key` field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent's id and name (for child keys). Keys with no active link return `linked_key: null`. Omit this parameter or set it to `false` to leave the `linked_key` field out of the response entirely. 
   # @return [Array<TranslationKey>]
   describe 'keys_list test' do
     it 'should work' do
@@ -152,6 +153,7 @@ describe 'KeysApi' do
   # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
   # @option opts [Integer] :page Page number
   # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
+  # @option opts [Boolean] :include_linked_keys When set to &#x60;true&#x60;, each key object in the response includes a &#x60;linked_key&#x60; field describing whether the key is a parent or child in a key-link relationship, and the number of children (for parent keys) or the parent&#39;s id and name (for child keys). Keys with no active link return &#x60;linked_key: null&#x60;. Omit this parameter or set it to &#x60;false&#x60; to leave the &#x60;linked_key&#x60; field out of the response entirely. 
   # @return [Array<TranslationKey>]
   describe 'keys_search test' do
     it 'should work' do

data/spec/models/translation_key_details_spec.rb

@@ -80,6 +80,12 @@ describe 'TranslationKeyDetails' do
     end
   end
 
+  describe 'test attribute "linked_key"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "name_plural"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/translation_key_linked_key_parent_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::TranslationKeyLinkedKeyParent
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TranslationKeyLinkedKeyParent' do
+  before do
+    # run before each test
+    @instance = Phrase::TranslationKeyLinkedKeyParent.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TranslationKeyLinkedKeyParent' do
+    it 'should create an instance of TranslationKeyLinkedKeyParent' do
+      expect(@instance).to be_instance_of(Phrase::TranslationKeyLinkedKeyParent)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/translation_key_linked_key_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Phrase::TranslationKeyLinkedKey
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TranslationKeyLinkedKey' do
+  before do
+    # run before each test
+    @instance = Phrase::TranslationKeyLinkedKey.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TranslationKeyLinkedKey' do
+    it 'should create an instance of TranslationKeyLinkedKey' do
+      expect(@instance).to be_instance_of(Phrase::TranslationKeyLinkedKey)
+    end
+  end
+  describe 'test attribute "role"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["parent", "child"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.role = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "parent"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "children_count"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/translation_key_spec.rb

@@ -80,4 +80,10 @@ describe 'TranslationKey' do
     end
   end
 
+  describe 'test attribute "linked_key"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phrase
 version: !ruby/object:Gem::Version
-  version: 4.33.0
+  version: 4.34.0
 platform: ruby
 authors:
 - Phrase
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-11-04 00:00:00.000000000 Z
+date: 2026-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -347,6 +347,8 @@ files:
 - docs/TranslationIncludeParameters.md
 - docs/TranslationKey.md
 - docs/TranslationKeyDetails.md
+- docs/TranslationKeyLinkedKey.md
+- docs/TranslationKeyLinkedKeyParent.md
 - docs/TranslationOrder.md
 - docs/TranslationParent.md
 - docs/TranslationReviewParameters.md
@@ -666,6 +668,8 @@ files:
 - lib/phrase/models/translation_include_parameters.rb
 - lib/phrase/models/translation_key.rb
 - lib/phrase/models/translation_key_details.rb
+- lib/phrase/models/translation_key_linked_key.rb
+- lib/phrase/models/translation_key_linked_key_parent.rb
 - lib/phrase/models/translation_order.rb
 - lib/phrase/models/translation_parent.rb
 - lib/phrase/models/translation_review_parameters.rb
@@ -975,6 +979,8 @@ files:
 - spec/models/translation_exclude_parameters_spec.rb
 - spec/models/translation_include_parameters_spec.rb
 - spec/models/translation_key_details_spec.rb
+- spec/models/translation_key_linked_key_parent_spec.rb
+- spec/models/translation_key_linked_key_spec.rb
 - spec/models/translation_key_spec.rb
 - spec/models/translation_order_spec.rb
 - spec/models/translation_parent_spec.rb
@@ -1134,6 +1140,7 @@ test_files:
 - spec/models/job_template_preview_spec.rb
 - spec/models/teams_users_create_parameters_spec.rb
 - spec/models/translations_unreview_parameters_spec.rb
+- spec/models/translation_key_linked_key_spec.rb
 - spec/models/translations_include_parameters_spec.rb
 - spec/models/upload_spec.rb
 - spec/models/job_comment_create_parameters_spec.rb
@@ -1262,6 +1269,7 @@ test_files:
 - spec/models/automation_event_project_spec.rb
 - spec/models/invitation_create_parameters_spec.rb
 - spec/models/order_create_parameters_spec.rb
+- spec/models/translation_key_linked_key_parent_spec.rb
 - spec/models/locale_report_spec.rb
 - spec/models/tag_spec.rb
 - spec/models/branch_sync_parameters_spec.rb