phrase 2.26.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 533035456c9b58cd7f63959b8a0e17d7813feaf8804e9ae5cf81ee3f0a375af5
-  data.tar.gz: '0581b5a61eedd4b514a9611dbecedb5d0db42356fcc50b54f61f451e60fa1284'
+  metadata.gz: 6ee59312f9329dd85344eda376dfd14c854dc35cc4dc202570422b8491dbcfd3
+  data.tar.gz: ee61abb9396d7c7f339d44501c4c163f6e29484930030907364f4c59fbba8758
 SHA512:
-  metadata.gz: e23ed46b1098ec42caebd13f4cb07a62281b3556187e45ae14c7e7e01d19164296c0bb47beb0d894131d703a7e9e0eafde183d15983483c05da56816fb037a86
-  data.tar.gz: 736cc4652b5148b32f4a2b1d0c31b701a96cee37ef2270746eadbc8bff674f4eae538104a48bcd51ae095ad2272e7354d25a7d751bbe291263b67c68551274af
+  metadata.gz: 0fac1bf4668800fca47cd9950d1816ceb9b26f196623f0673314bc073bca7bc923c71910144ee2983944f4421aef2e811770354df5902fe636efca8dab4e7e60
+  data.tar.gz: 9b97d1f7dfa45416f19cb80555226d74ae65e538231f296091b0c14b29e3cd28c359daa4d5a0ad78f6fe06e1c18b84e7d02c20eaafb2a0b62660af97e303c251

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [3.0.0](https://github.com/phrase/openapi/compare/ruby-v2.26.0...ruby-v3.0.0) (2024-04-23)
+
+
+### ⚠ BREAKING CHANGES
+
+* add missing required params ([#571](https://github.com/phrase/openapi/issues/571))
+
+### Code Refactoring
+
+* add missing required params ([#571](https://github.com/phrase/openapi/issues/571)) ([d810e9e](https://github.com/phrase/openapi/commit/d810e9ebc767e14ba9e56106de8c5774d9d6d178))
+
 ## [2.26.0](https://github.com/phrase/openapi/compare/ruby-v2.25.0...ruby-v2.26.0) (2024-04-22)
 
 

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.26.0
+- Package version: 3.0.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.26.0.gem
+gem install ./phrase-3.0.0.gem
 ```
 
-(for development, run `gem install --dev ./phrase-2.26.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-3.0.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -210,7 +210,7 @@ Class | Method | HTTP request | Description
 *Phrase::GlossaryTermsApi* | [**glossary_term_show**](docs/GlossaryTermsApi.md#glossary_term_show) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Get a single term
 *Phrase::GlossaryTermsApi* | [**glossary_term_update**](docs/GlossaryTermsApi.md#glossary_term_update) | **PATCH** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Update a term
 *Phrase::GlossaryTermsApi* | [**glossary_terms_list**](docs/GlossaryTermsApi.md#glossary_terms_list) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms | List terms
-*Phrase::ICUApi* | [**icu_skeleton**](docs/ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build icu skeletons
+*Phrase::ICUApi* | [**icu_skeleton**](docs/ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build ICU skeletons
 *Phrase::InvitationsApi* | [**invitation_create**](docs/InvitationsApi.md#invitation_create) | **POST** /accounts/{account_id}/invitations | Create a new invitation
 *Phrase::InvitationsApi* | [**invitation_delete**](docs/InvitationsApi.md#invitation_delete) | **DELETE** /accounts/{account_id}/invitations/{id} | Delete an invitation
 *Phrase::InvitationsApi* | [**invitation_resend**](docs/InvitationsApi.md#invitation_resend) | **POST** /accounts/{account_id}/invitations/{id}/resend | Resend an invitation
@@ -270,7 +270,7 @@ Class | Method | HTTP request | Description
 *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::LinkedKeysApi* | [**key_links_index**](docs/LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | List child keys of a 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

data/docs/AuthorizationCreateParameters.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**note** | **String** | A note to help you remember what the access is used for. | [optional] 
+**note** | **String** | A note to help you remember what the access is used for. | 
 **scopes** | **Array<String>** | A list of scopes that the access can be used for. | [optional] 
 **expires_at** | **Time** | Expiration date for the authorization token. Null means no expiration date (default). | [optional] 
 

data/docs/AuthorizationsApi.md

@@ -37,7 +37,7 @@ Phrase.configure do |config|
 end
 
 api_instance = Phrase::AuthorizationsApi.new
-authorization_create_parameters = Phrase::AuthorizationCreateParameters.new # AuthorizationCreateParameters | 
+authorization_create_parameters = Phrase::AuthorizationCreateParameters.new({note: 'My Deploy Script'}) # AuthorizationCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/BlacklistedKeyCreateParameters.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Blocked key name | [optional] 
+**name** | **String** | Blocked key name | 
 
 ## Code Sample
 

data/docs/BlacklistedKeysApi.md

@@ -38,7 +38,7 @@ end
 
 api_instance = Phrase::BlacklistedKeysApi.new
 project_id = 'project_id_example' # String | Project ID
-blacklisted_key_create_parameters = Phrase::BlacklistedKeyCreateParameters.new # BlacklistedKeyCreateParameters | 
+blacklisted_key_create_parameters = Phrase::BlacklistedKeyCreateParameters.new({name: 'date.formats.*'}) # BlacklistedKeyCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/BranchCreateParameters.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the branch | [optional] 
+**name** | **String** | Name of the branch | 
 
 ## Code Sample
 

data/docs/BranchesApi.md

@@ -102,7 +102,7 @@ end
 
 api_instance = Phrase::BranchesApi.new
 project_id = 'project_id_example' # String | Project ID
-branch_create_parameters = Phrase::BranchCreateParameters.new # BranchCreateParameters | 
+branch_create_parameters = Phrase::BranchCreateParameters.new({name: 'my-branch'}) # BranchCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/DistributionCreateParameters.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the distribution | [optional] 
-**project_id** | **String** | Project id the distribution should be assigned to. | [optional] 
+**name** | **String** | Name of the distribution | 
+**project_id** | **String** | Project id the distribution should be assigned to. | 
 **platforms** | **Array<String>** | List of platforms the distribution should support. Valid values are: * `android` * `ios` * `flutter` * `i18next` * `rails` | [optional] 
 **locale_ids** | **Array<String>** | List of locale ids that will be part of distribution releases | [optional] 
 **format_options** | **Hash<String, String>** | Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>. | [optional] 

data/docs/DistributionsApi.md

@@ -38,7 +38,7 @@ end
 
 api_instance = Phrase::DistributionsApi.new
 account_id = 'account_id_example' # String | Account ID
-distribution_create_parameters = Phrase::DistributionCreateParameters.new # DistributionCreateParameters | 
+distribution_create_parameters = Phrase::DistributionCreateParameters.new({name: 'My Android Distribution', project_id: 'abcd1234abcd1234abcd1234'}) # DistributionCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/FigmaAttachmentCreateParameters.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
-**url** | **String** | Figma file url | [optional] 
+**url** | **String** | Figma file url | 
 
 ## Code Sample
 

data/docs/FigmaAttachmentsApi.md

@@ -38,7 +38,7 @@ end
 
 api_instance = Phrase::FigmaAttachmentsApi.new
 project_id = 'project_id_example' # String | Project ID
-figma_attachment_create_parameters = Phrase::FigmaAttachmentCreateParameters.new # FigmaAttachmentCreateParameters | 
+figma_attachment_create_parameters = Phrase::FigmaAttachmentCreateParameters.new({url: 'https://figma.com/file/xxxxx/sample'}) # FigmaAttachmentCreateParameters | 
 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

data/docs/GlossariesApi.md

@@ -103,7 +103,7 @@ end
 
 api_instance = Phrase::GlossariesApi.new
 account_id = 'account_id_example' # String | Account ID
-glossary_create_parameters = Phrase::GlossaryCreateParameters.new # GlossaryCreateParameters | 
+glossary_create_parameters = Phrase::GlossaryCreateParameters.new({name: 'My glossary'}) # GlossaryCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/GlossaryCreateParameters.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the glossary | [optional] 
+**name** | **String** | Name of the glossary | 
 **project_ids** | **String** | List of project ids the glossary should be assigned to. | [optional] 
 **space_ids** | **Array<String>** | List of space ids the glossary should be assigned to. | [optional] 
 

data/docs/GlossaryTermCreateParameters.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**term** | **String** | Glossary term | [optional] 
+**term** | **String** | Glossary term | 
 **description** | **String** | Description of term | [optional] 
 **translatable** | **Boolean** | Indicates whether the term should be used for all languages or can be translated | [optional] 
 **case_sensitive** | **Boolean** | Indicates whether the term is case sensitive | [optional] 

data/docs/GlossaryTermTranslationCreateParameters.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**locale_code** | **String** | Identifies the language for this translation | [optional] 
-**content** | **String** | The content of the translation | [optional] 
+**locale_code** | **String** | Identifies the language for this translation | 
+**content** | **String** | The content of the translation | 
 
 ## Code Sample
 

data/docs/GlossaryTermTranslationsApi.md

@@ -38,7 +38,7 @@ api_instance = Phrase::GlossaryTermTranslationsApi.new
 account_id = 'account_id_example' # String | Account ID
 glossary_id = 'glossary_id_example' # String | Glossary ID
 term_id = 'term_id_example' # String | Term ID
-glossary_term_translation_create_parameters = Phrase::GlossaryTermTranslationCreateParameters.new # GlossaryTermTranslationCreateParameters | 
+glossary_term_translation_create_parameters = Phrase::GlossaryTermTranslationCreateParameters.new({locale_code: 'en-US', content: 'My translated term'}) # GlossaryTermTranslationCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/GlossaryTermsApi.md

@@ -39,7 +39,7 @@ end
 api_instance = Phrase::GlossaryTermsApi.new
 account_id = 'account_id_example' # String | Account ID
 glossary_id = 'glossary_id_example' # String | Glossary ID
-glossary_term_create_parameters = Phrase::GlossaryTermCreateParameters.new # GlossaryTermCreateParameters | 
+glossary_term_create_parameters = Phrase::GlossaryTermCreateParameters.new({term: 'MyCompany'}) # GlossaryTermCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/ICUApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *https://api.phrase.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**icu_skeleton**](ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build icu skeletons
+[**icu_skeleton**](ICUApi.md#icu_skeleton) | **POST** /icu/skeleton | Build ICU skeletons
 
 
 
@@ -12,9 +12,9 @@ Method | HTTP request | Description
 
 > Icu icu_skeleton(icu_skeleton_parameters, opts)
 
-Build icu skeletons
+Build ICU skeletons
 
-Returns icu skeletons for multiple locale codes based on a source content.
+Returns ICU skeletons for multiple locale codes based on a source content.
 
 ### Example
 
@@ -39,7 +39,7 @@ opts = {
 }
 
 begin
-  #Build icu skeletons
+  #Build ICU skeletons
   result = api_instance.icu_skeleton(icu_skeleton_parameters, opts)
   pp result
 rescue Phrase::ApiError => e

data/docs/InvitationCreateParameters.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **String** | The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email. | [optional] 
-**role** | **String** | Invitiation role, can be any of Manager, Developer, Translator. | [optional] 
+**email** | **String** | The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email. | 
+**role** | **String** | Invitiation role, can be any of Manager, Developer, Translator. | 
 **project_ids** | **String** | List of project ids the invited user has access to. | [optional] 
 **locale_ids** | **String** | List of locale ids the invited user has access to. | [optional] 
 **space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional] 

data/docs/InvitationsApi.md

@@ -40,7 +40,7 @@ end
 
 api_instance = Phrase::InvitationsApi.new
 account_id = 'account_id_example' # String | Account ID
-invitation_create_parameters = Phrase::InvitationCreateParameters.new # InvitationCreateParameters | 
+invitation_create_parameters = Phrase::InvitationCreateParameters.new({email: 'example@mail.com', role: 'Developer'}) # InvitationCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/JobCreateParameters.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
-**name** | **String** | Job name | [optional] 
+**name** | **String** | Job name | 
 **source_locale_id** | **String** | The API id of the source language | [optional] 
 **briefing** | **String** | Briefing for the translators | [optional] 
 **due_date** | **Time** | Date the job should be finished | [optional] 

data/docs/JobsApi.md

@@ -111,7 +111,7 @@ end
 
 api_instance = Phrase::JobsApi.new
 project_id = 'project_id_example' # String | Project ID
-job_create_parameters = Phrase::JobCreateParameters.new # JobCreateParameters | 
+job_create_parameters = Phrase::JobCreateParameters.new({name: 'de'}) # JobCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/KeyCreateParameters.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
-**name** | **String** | Key name | [optional] 
+**name** | **String** | Key name | 
 **description** | **String** | Key description (usually includes contextual information for translators) | [optional] 
 **plural** | **Boolean** | Indicates whether key supports pluralization | [optional] 
 **name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional] 
@@ -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@2eb4a3ec,
+                                 screenshot: [B@4c57acc5,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  default_translation_content: Default translation content,

data/docs/KeyLink.md

@@ -4,13 +4,13 @@
 
 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. | 
+**created_at** | **Time** | The timestamp when the link was created. | [optional] 
+**updated_at** | **Time** | The timestamp when the link was last updated. | [optional] 
+**created_by** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**updated_by** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**account** | [**Account**](Account.md) |  | [optional] 
+**parent** | [**KeyPreview**](KeyPreview.md) |  | [optional] 
+**children** | [**Array<KeyPreview>**](KeyPreview.md) | The child translation keys linked to the parent. | [optional] 
 
 ## Code Sample
 

data/docs/KeyLinksBatchDestroyParameters.md

@@ -5,13 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **child_key_ids** | **Array<String>** | The IDs of the child keys to unlink from the parent key. | 
+**unlink_parent** | **Boolean** | Whether to unlink the parent key as well and unmark it as linked-key. | [optional] [default to false]
 
 ## Code Sample
 
 ```ruby
 require 'Phrase'
 
-instance = Phrase::KeyLinksBatchDestroyParameters.new(child_key_ids: ["child_key_id1","child_key_id2"])
+instance = Phrase::KeyLinksBatchDestroyParameters.new(child_key_ids: ["child_key_id1","child_key_id2"],
+                                 unlink_parent: 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@38e6dab2,
+                                 screenshot: [B@1d57b043,
                                  remove_screenshot: null,
                                  unformatted: null,
                                  xml_space_preserve: null,

data/docs/KeysApi.md

@@ -44,7 +44,7 @@ end
 
 api_instance = Phrase::KeysApi.new
 project_id = 'project_id_example' # String | Project ID
-key_create_parameters = Phrase::KeyCreateParameters.new # KeyCreateParameters | 
+key_create_parameters = Phrase::KeyCreateParameters.new({name: 'home.index.headline'}) # KeyCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/LinkedKeysApi.md

@@ -7,7 +7,7 @@ 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_index**](LinkedKeysApi.md#key_links_index) | **GET** /projects/{project_id}/keys/{id}/key_links | List child keys of a parent key
 
 
 
@@ -40,8 +40,7 @@ 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.
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }
 
 begin
@@ -61,7 +60,6 @@ Name | Type | Description  | Notes
  **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
 
@@ -210,7 +208,7 @@ Response<(nil (empty response body))>
 
 > KeyLink key_links_index(project_id, id, opts)
 
-Retrieve all child keys linked to a specific parent key
+List child keys of a parent key
 
 Returns detailed information about a parent key, including its linked child keys.
 
@@ -238,7 +236,7 @@ opts = {
 }
 
 begin
-  #Retrieve all child keys linked to a specific parent key
+  #List child keys of a parent key
   result = api_instance.key_links_index(project_id, id, opts)
   pp result
 rescue Phrase::ApiError => e

data/docs/LocaleCreateParameters.md

@@ -5,12 +5,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
-**name** | **String** | Locale name | [optional] 
-**code** | **String** | Locale ISO code | [optional] 
+**name** | **String** | Locale name | 
+**code** | **String** | Locale ISO code | 
 **default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional] 
 **main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Verification System</a> feature. | [optional] 
 **rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional] 
-**source_locale_id** | **String** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional] 
+**source_locale_id** | **String** | Source locale. Can be the name or id of the locale. Preferred is id. | [optional] 
 **fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional] 
 **unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
 **unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 

data/docs/LocaleUpdateParameters.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **default** | **Boolean** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional] 
 **main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Verification System</a> feature. | [optional] 
 **rtl** | **Boolean** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional] 
-**source_locale_id** | **String** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional] 
+**source_locale_id** | **String** | Source locale. Can be the name or id of the locale. Preferred is id. | [optional] 
 **fallback_locale_id** | **String** | Fallback locale for empty translations. Can be a locale name or id. | [optional] 
 **unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 
 **unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature. | [optional] 

data/docs/LocalesApi.md

@@ -105,7 +105,7 @@ end
 
 api_instance = Phrase::LocalesApi.new
 project_id = 'project_id_example' # String | Project ID
-locale_create_parameters = Phrase::LocaleCreateParameters.new # LocaleCreateParameters | 
+locale_create_parameters = Phrase::LocaleCreateParameters.new({name: 'de', code: 'de-DE'}) # LocaleCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }
@@ -251,7 +251,7 @@ opts = {
   skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
   include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
   use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
-  fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
+  fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
   source_locale_id: 'source_locale_id_example', # String | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job.
   custom_metadata_filters: { key: 3.56} # Object | Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. 
 }
@@ -289,7 +289,7 @@ Name | Type | Description  | Notes
  **skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with &lt;code&gt;include_unverified_translations&lt;/code&gt;. | [optional] 
  **include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional] 
  **use_last_reviewed_version** | **Boolean**| If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | [optional] 
- **fallback_locale_id** | **String**| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to &lt;code&gt;true&lt;/code&gt;. | [optional] 
+ **fallback_locale_id** | **String**| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to &lt;code&gt;true&lt;/code&gt;. | [optional] 
  **source_locale_id** | **String**| Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a &lt;code&gt;tag&lt;/code&gt; parameter indicating a specific job. | [optional] 
  **custom_metadata_filters** | [**Object**](.md)| Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.  | [optional] 
 

data/docs/OrderCreateParameters.md

@@ -5,10 +5,10 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
-**name** | **String** | the name of the order, default name is: Translation order from 'current datetime' | [optional] 
-**lsp** | **String** | Name of the LSP that should process this order. Can be one of gengo, textmaster. | [optional] 
-**source_locale_id** | **String** | Source locale for the order. Can be the name or public id of the source locale. Preferred is the public id. | [optional] 
-**target_locale_ids** | **Array<String>** | List of target locales you want the source content translate to. Can be the name or public id of the target locales. Preferred is the public id. | [optional] 
+**name** | **String** | the name of the order, default name is: Translation order from 'current datetime' | 
+**lsp** | **String** | Name of the LSP that should process this order. Can be one of gengo, textmaster. | 
+**source_locale_id** | **String** | Source locale for the order. Can be the name or id of the source locale. Preferred is id. | [optional] 
+**target_locale_ids** | **Array<String>** | List of target locales you want the source content translate to. Can be the name or id of the target locales. Preferred is id. | [optional] 
 **translation_type** | **String** | Name of the quality level, availability depends on the LSP. Can be one of:  standard, pro (for orders processed by Gengo) and one of regular, premium, enterprise (for orders processed by TextMaster) | [optional] 
 **tag** | **String** | Tag you want to order translations for. | [optional] 
 **message** | **String** | Message that is displayed to the translators for description. | [optional] 

data/docs/OrdersApi.md

@@ -103,7 +103,7 @@ end
 
 api_instance = Phrase::OrdersApi.new
 project_id = 'project_id_example' # String | Project ID
-order_create_parameters = Phrase::OrderCreateParameters.new # OrderCreateParameters | 
+order_create_parameters = Phrase::OrderCreateParameters.new({name: 'Welcome message translations', lsp: 'textmaster'}) # OrderCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/ProjectCreateParameters.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the project | [optional] 
+**name** | **String** | Name of the project | 
 **main_format** | **String** | Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional] 
 **media** | **String** | (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value. | [optional] 
 **shares_translation_memory** | **Boolean** | Indicates whether the project should share the account's translation memory | [optional] 
@@ -40,7 +40,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
                                  main_format: yml,
                                  media: Python,
                                  shares_translation_memory: true,
-                                 project_image: [B@faca8e8,
+                                 project_image: [B@f33b8fc,
                                  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@3b85a820,
+                                 project_image: [B@697714d8,
                                  remove_project_image: false,
                                  workflow: review,
                                  machine_translation_enabled: true,

data/docs/ProjectsApi.md

@@ -37,7 +37,7 @@ Phrase.configure do |config|
 end
 
 api_instance = Phrase::ProjectsApi.new
-project_create_parameters = Phrase::ProjectCreateParameters.new # ProjectCreateParameters | 
+project_create_parameters = Phrase::ProjectCreateParameters.new({name: 'My Android Project'}) # ProjectCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

data/docs/ScreenshotMarkerCreateParameters.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **branch** | **String** | specify the branch to use | [optional] 
-**key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional] 
+**key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | 
 **presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional] 
 
 ## Code Sample

data/docs/ScreenshotMarkersApi.md

@@ -39,7 +39,7 @@ end
 api_instance = Phrase::ScreenshotMarkersApi.new
 project_id = 'project_id_example' # String | Project ID
 screenshot_id = 'screenshot_id_example' # String | Screenshot ID
-screenshot_marker_create_parameters = Phrase::ScreenshotMarkerCreateParameters.new # ScreenshotMarkerCreateParameters | 
+screenshot_marker_create_parameters = Phrase::ScreenshotMarkerCreateParameters.new({key_id: 'abcd1234abcd1234abcd1234abcd1234'}) # ScreenshotMarkerCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

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@44b5a87a)
+                                 filename: [B@5eb11bb7)
 ```
 
 

data/docs/SpaceCreateParameters.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Name of the space | [optional] 
+**name** | **String** | Name of the space | 
 
 ## Code Sample