phrase 2.22.2 → 2.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ccb4f85cd722e85e531b2efd29e47a7c0b54a7414c1d4b31fc0cfa08397911c
-  data.tar.gz: 89c22edbd0407ff4ab36e719637498218919920bb0fceb284d10f9aad700e9f4
+  metadata.gz: 582ba53291883b020549a82fce6657cca1fb45b5bee1fab80005fe56d8866a11
+  data.tar.gz: cf1605ad717045fa0747aaeab826389cdcb2997691e807808b81cc820d1afd69
 SHA512:
-  metadata.gz: fc7c4dc4359575d7a8a544625e9c51ec672360ddd075ed4bf65dd302c34c09cec189ca01dec62e74410856892cb9698fe412ba59373b8a35a338d01daa465568
-  data.tar.gz: 3c4b006c644deef14343a21c2806c58132226f630f08e0617fa5868b1cfa09c60a8df21e8e165b780c2bf1c1b6e60dd4f2ebddb5f85acf867fe1a22cf50d1dad
+  metadata.gz: 183270d16369039bae7e2cefd09908eea7355728e993d66657abc6fa9c6020a710900cd19abf8957fa372a41bac68be3c6484821c87acfa500420947df97f86b
+  data.tar.gz: 3f41891e25ee2a2cfe7b7ecfe8ed4faf3565aac0a271a8ba81b627df66750cb4e15945b61869ff3d200f053bf3ec6661452910fe3a6f713835271f24b5247888

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [2.24.0](https://github.com/phrase/openapi/compare/ruby-v2.23.0...ruby-v2.24.0) (2024-04-10)
+
+
+### Features
+
+* **API:** add Linked Keys endpoints ([#555](https://github.com/phrase/openapi/issues/555)) ([4935dac](https://github.com/phrase/openapi/commit/4935dac58c787eaade2f1f65ce649f466b5e3a60))
+
+
+### Bug Fixes
+
+* (API) Add mandatory params to linked keys endpoints ([#564](https://github.com/phrase/openapi/issues/564)) ([08d9846](https://github.com/phrase/openapi/commit/08d9846bc224d349e2ade9abf28d733afb1e8be3))
+
+## [2.23.0](https://github.com/phrase/openapi/compare/ruby-v2.22.2...ruby-v2.23.0) (2024-02-07)
+
+
+### Features
+
+* add query param for properties ([#542](https://github.com/phrase/openapi/issues/542)) ([b4e12d0](https://github.com/phrase/openapi/commit/b4e12d04fd2916351f9201e1e6de504143ecc9aa))
+
 ## [2.22.2](https://github.com/phrase/openapi/compare/ruby-v2.22.1...ruby-v2.22.2) (2024-02-05)
 
 

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: 2.22.2
+- Package version: 2.24.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-2.22.2.gem
+gem install ./phrase-2.24.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-2.22.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-2.24.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -267,6 +267,10 @@ Class | Method | HTTP request | Description
 *Phrase::KeysApi* | [**keys_untag**](docs/KeysApi.md#keys_untag) | **PATCH** /projects/{project_id}/keys/untag | Remove tags from collection of keys
 *Phrase::KeysFigmaAttachmentsApi* | [**figma_attachment_attach_to_key**](docs/KeysFigmaAttachmentsApi.md#figma_attachment_attach_to_key) | **POST** /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys | Attach the Figma attachment to a key
 *Phrase::KeysFigmaAttachmentsApi* | [**figma_attachment_detach_from_key**](docs/KeysFigmaAttachmentsApi.md#figma_attachment_detach_from_key) | **DELETE** /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} | Detach the Figma attachment from a key
+*Phrase::LinkedKeysApi* | [**key_links_batch_destroy**](docs/LinkedKeysApi.md#key_links_batch_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links | Batch unlink child keys from a parent key
+*Phrase::LinkedKeysApi* | [**key_links_create**](docs/LinkedKeysApi.md#key_links_create) | **POST** /projects/{project_id}/keys/{id}/key_links | Link child keys to a parent key
+*Phrase::LinkedKeysApi* | [**key_links_destroy**](docs/LinkedKeysApi.md#key_links_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links/{child_key_id} | Unlink a child key from a parent key
+*Phrase::LinkedKeysApi* | [**key_links_index**](docs/LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | Retrieve all child keys linked to a specific parent key
 *Phrase::LocalesApi* | [**account_locales**](docs/LocalesApi.md#account_locales) | **GET** /accounts/{id}/locales | List locales used in account
 *Phrase::LocalesApi* | [**locale_create**](docs/LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
 *Phrase::LocalesApi* | [**locale_delete**](docs/LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
@@ -489,6 +493,10 @@ Class | Method | HTTP request | Description
  - [Phrase::JobTemplateUpdateParameters](docs/JobTemplateUpdateParameters.md)
  - [Phrase::JobUpdateParameters](docs/JobUpdateParameters.md)
  - [Phrase::KeyCreateParameters](docs/KeyCreateParameters.md)
+ - [Phrase::KeyLink](docs/KeyLink.md)
+ - [Phrase::KeyLinksBatchDestroyParameters](docs/KeyLinksBatchDestroyParameters.md)
+ - [Phrase::KeyLinksCreateParameters](docs/KeyLinksCreateParameters.md)
+ - [Phrase::KeyLinksIndex400Response](docs/KeyLinksIndex400Response.md)
  - [Phrase::KeyPreview](docs/KeyPreview.md)
  - [Phrase::KeyUpdateParameters](docs/KeyUpdateParameters.md)
  - [Phrase::KeysExcludeParameters](docs/KeysExcludeParameters.md)

data/docs/CustomMetadataApi.md

@@ -106,6 +106,7 @@ opts = {
   project_id: 'abcd1234cdef1234abcd1234cdef1234', # String | id of project that the properties belong to
   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
+  q: 'character_name', # String | query to find a property by name
   sort: 'updated_at', # String | Sort criteria. Can be one of: name, data_type, created_at.
   order: 'desc' # String | Order direction. Can be one of: asc, desc.
 }
@@ -130,6 +131,7 @@ Name | Type | Description  | Notes
  **project_id** | **String**| id of project that the properties belong to | [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] 
+ **q** | **String**| query to find a property by name | [optional] 
  **sort** | **String**| Sort criteria. Can be one of: name, data_type, created_at. | [optional] 
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional] 
 

data/docs/KeyCreateParameters.md

@@ -35,7 +35,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@276038e7,
+                                 screenshot: [B@59a8891e,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  default_translation_content: Default translation content,

data/docs/KeyLink.md

@@ -0,0 +1,29 @@
+# Phrase::KeyLink
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **Time** | The timestamp when the link was created. | 
+**updated_at** | **Time** | The timestamp when the link was last updated. | 
+**created_by** | [**UserPreview**](UserPreview.md) |  | 
+**updated_by** | [**UserPreview**](UserPreview.md) |  | 
+**account** | [**Account**](Account.md) |  | 
+**parent** | [**KeyPreview**](KeyPreview.md) |  | 
+**children** | [**Array<KeyPreview>**](KeyPreview.md) | The child translation keys linked to the parent. | 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeyLink.new(created_at: null,
+                                 updated_at: null,
+                                 created_by: null,
+                                 updated_by: null,
+                                 account: null,
+                                 parent: null,
+                                 children: null)
+```
+
+

data/docs/KeyLinksBatchDestroyParameters.md

@@ -0,0 +1,17 @@
+# Phrase::KeyLinksBatchDestroyParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**child_key_ids** | **Array<String>** | The IDs of the child keys to unlink from the parent key. | 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeyLinksBatchDestroyParameters.new(child_key_ids: ["child_key_id1","child_key_id2"])
+```
+
+

data/docs/KeyLinksCreateParameters.md

@@ -0,0 +1,17 @@
+# Phrase::KeyLinksCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**child_key_ids** | **Array<String>** | The IDs of the child keys to link to the parent key. Can be left empty, to only mark the given translation-key as parent | 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeyLinksCreateParameters.new(child_key_ids: ["child_key_id1","child_key_id2"])
+```
+
+

data/docs/KeyLinksIndex400Response.md

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

data/docs/KeyUpdateParameters.md

@@ -34,7 +34,7 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
                                  data_type: number,
                                  tags: awesome-feature,needs-proofreading,
                                  max_characters_allowed: 140,
-                                 screenshot: [B@4be8d40e,
+                                 screenshot: [B@f054e29,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  xml_space_preserve: null,

data/docs/LinkedKeysApi.md

@@ -0,0 +1,270 @@
+# Phrase::LinkedKeysApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**key_links_batch_destroy**](LinkedKeysApi.md#key_links_batch_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links | Batch unlink child keys from a parent key
+[**key_links_create**](LinkedKeysApi.md#key_links_create) | **POST** /projects/{project_id}/keys/{id}/key_links | Link child keys to a parent key
+[**key_links_destroy**](LinkedKeysApi.md#key_links_destroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links/{child_key_id} | Unlink a child key from a parent key
+[**key_links_index**](LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | Retrieve all child keys linked to a specific parent key
+
+
+
+## key_links_batch_destroy
+
+> key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, opts)
+
+Batch unlink child keys from a parent key
+
+Unlinks multiple child keys from a given parent key in a single operation.
+
+### 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::LinkedKeysApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | Parent Translation Key ID
+key_links_batch_destroy_parameters = Phrase::KeyLinksBatchDestroyParameters.new({child_key_ids: ["child_key_id1", "child_key_id2"]}) # KeyLinksBatchDestroyParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  unlink_parent: true # Boolean | Whether to unlink the parent key as well and unmark it as linked-key.
+}
+
+begin
+  #Batch unlink child keys from a parent key
+  api_instance.key_links_batch_destroy(project_id, id, key_links_batch_destroy_parameters, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling LinkedKeysApi->key_links_batch_destroy: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| Parent Translation Key ID | 
+ **key_links_batch_destroy_parameters** | [**KeyLinksBatchDestroyParameters**](KeyLinksBatchDestroyParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **unlink_parent** | **Boolean**| Whether to unlink the parent key as well and unmark it as linked-key. | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## key_links_create
+
+> KeyLink key_links_create(project_id, id, key_links_create_parameters, opts)
+
+Link child keys to a parent key
+
+Creates links between a given parent key and one or more child keys.
+
+### 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::LinkedKeysApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | Parent Translation Key ID
+key_links_create_parameters = Phrase::KeyLinksCreateParameters.new({child_key_ids: ["child_key_id1", "child_key_id2"]}) # KeyLinksCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Link child keys to a parent key
+  result = api_instance.key_links_create(project_id, id, key_links_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling LinkedKeysApi->key_links_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| Parent Translation Key ID | 
+ **key_links_create_parameters** | [**KeyLinksCreateParameters**](KeyLinksCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**KeyLink**](KeyLink.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## key_links_destroy
+
+> key_links_destroy(project_id, id, child_key_id, opts)
+
+Unlink a child key from a parent key
+
+Unlinks a single child key from a given parent key.
+
+### 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::LinkedKeysApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | Parent Translation Key ID
+child_key_id = 'child_key_id_example' # String | The ID of the child key to unlink.
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Unlink a child key from a parent key
+  api_instance.key_links_destroy(project_id, id, child_key_id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling LinkedKeysApi->key_links_destroy: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| Parent Translation Key ID | 
+ **child_key_id** | **String**| The ID of the child key to unlink. | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [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**: application/json
+
+
+## key_links_index
+
+> KeyLink key_links_index(project_id, id, opts)
+
+Retrieve all child keys linked to a specific parent key
+
+Returns detailed information about a parent key, including its linked child keys.
+
+### 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::LinkedKeysApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | Parent Translation Key ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Retrieve all child keys linked to a specific parent key
+  result = api_instance.key_links_index(project_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling LinkedKeysApi->key_links_index: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| Parent Translation Key ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**KeyLink**](KeyLink.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ProjectCreateParameters.md

@@ -40,7 +40,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@596707f5,
+                                 project_image: [B@2c890ee3,
                                  remove_project_image: null,
                                  account_id: abcd1234,
                                  point_of_contact: abcd1234,

data/docs/ProjectUpdateParameters.md

@@ -41,7 +41,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@6ec05499,
+                                 project_image: [B@62068fa5,
                                  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@4659d776)
+                                 filename: [B@3db2665d)
 ```
 
 

data/lib/phrase/api/custom_metadata_api.rb

@@ -86,6 +86,7 @@ module Phrase
     # @option opts [String] :project_id id of project that the properties belong to
     # @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 [String] :q query to find a property by name
     # @option opts [String] :sort Sort criteria. Can be one of: name, data_type, created_at.
     # @option opts [String] :order Order direction. Can be one of: asc, desc.
     # @return [Array<CustomMetadataProperty>]
@@ -103,6 +104,7 @@ module Phrase
     # @option opts [String] :project_id id of project that the properties belong to
     # @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 [String] :q query to find a property by name
     # @option opts [String] :sort Sort criteria. Can be one of: name, data_type, created_at.
     # @option opts [String] :order Order direction. Can be one of: asc, desc.
     # @return [Array<(Response<(Array<CustomMetadataProperty>)>, Integer, Hash)>] Response<(Array<CustomMetadataProperty>)> data, response status code and response headers
@@ -123,6 +125,7 @@ module Phrase
       query_params[:'project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
       query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?