Deploying from phrase/openapi@d810e9eb

phrase · Apr 23, 2024 · 9d5c881 · 9d5c881
1 parent 0679fef
commit 9d5c881
Show file tree

Hide file tree

Showing 95 changed files with 314 additions and 173 deletions.
diff --git a/README.md b/README.md
@@ -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

diff --git a/docs/AuthorizationCreateParameters.md b/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&lt;String&gt;** | 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] 
 

diff --git a/docs/AuthorizationsApi.md b/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)
 }

diff --git a/docs/BlacklistedKeyCreateParameters.md b/docs/BlacklistedKeyCreateParameters.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **String** | Blocked key name | [optional] 
+**name** | **String** | Blocked key name | 
 
 ## Code Sample
 

diff --git a/docs/BlacklistedKeysApi.md b/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)
 }

diff --git a/docs/BranchCreateParameters.md b/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
 

diff --git a/docs/BranchesApi.md b/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)
 }

diff --git a/docs/DistributionCreateParameters.md b/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&lt;String&gt;** | List of platforms the distribution should support. Valid values are: * &#x60;android&#x60; * &#x60;ios&#x60; * &#x60;flutter&#x60; * &#x60;i18next&#x60; * &#x60;rails&#x60; | [optional] 
 **locale_ids** | **Array&lt;String&gt;** | List of locale ids that will be part of distribution releases | [optional] 
 **format_options** | **Hash&lt;String, String&gt;** | Additional formatting and render options. Only &lt;code&gt;enclose_in_cdata&lt;/code&gt; is available for platform &lt;code&gt;android&lt;/code&gt;. | [optional] 

diff --git a/docs/DistributionsApi.md b/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)
 }

diff --git a/docs/FigmaAttachmentCreateParameters.md b/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
 

diff --git a/docs/FigmaAttachmentsApi.md b/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

diff --git a/docs/GlossariesApi.md b/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)
 }

diff --git a/docs/GlossaryCreateParameters.md b/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&lt;String&gt;** | List of space ids the glossary should be assigned to. | [optional] 
 

diff --git a/docs/GlossaryTermCreateParameters.md b/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] 

diff --git a/docs/GlossaryTermTranslationCreateParameters.md b/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
 

diff --git a/docs/GlossaryTermTranslationsApi.md b/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)
 }

diff --git a/docs/GlossaryTermsApi.md b/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)
 }

diff --git a/docs/ICUApi.md b/docs/ICUApi.md
@@ -4,17 +4,17 @@ 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
 
 
 
 ## icu_skeleton
 
 > 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

diff --git a/docs/InvitationCreateParameters.md b/docs/InvitationCreateParameters.md
@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **String** | The email of the invited user. The &lt;code&gt;email&lt;/code&gt; 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 &lt;code&gt;email&lt;/code&gt; 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&lt;String&gt;** | List of spaces the user is assigned to. | [optional] 

diff --git a/docs/InvitationsApi.md b/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: '[email protected]', role: 'Developer'}) # InvitationCreateParameters | 
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
 }

diff --git a/docs/JobCreateParameters.md b/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] 

diff --git a/docs/JobsApi.md b/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)
 }

diff --git a/docs/KeyCreateParameters.md b/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,

diff --git a/docs/KeyLink.md b/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&lt;KeyPreview&gt;**](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&lt;KeyPreview&gt;**](KeyPreview.md) | The child translation keys linked to the parent. | [optional] 
 
 ## Code Sample
 

diff --git a/docs/KeyLinksBatchDestroyParameters.md b/docs/KeyLinksBatchDestroyParameters.md
@@ -5,13 +5,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **child_key_ids** | **Array&lt;String&gt;** | 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: [&quot;child_key_id1&quot;,&quot;child_key_id2&quot;])
+instance = Phrase::KeyLinksBatchDestroyParameters.new(child_key_ids: [&quot;child_key_id1&quot;,&quot;child_key_id2&quot;],
+                                 unlink_parent: null)
 ```
 
 
diff --git a/docs/KeyUpdateParameters.md b/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,

diff --git a/docs/KeysApi.md b/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)
 }

diff --git a/docs/LinkedKeysApi.md b/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