Deploying from phrase/openapi@d810e9eb

phrase · Apr 23, 2024 · f2b3089 · f2b3089
1 parent c1db529
commit f2b3089
Show file tree

Hide file tree

Showing 71 changed files with 347 additions and 240 deletions.
diff --git a/README.md b/README.md
@@ -227,7 +227,7 @@ Class | Method | HTTP request | Description
 *GlossaryTermsApi* | [**glossaryTermShow**](docs/Api/GlossaryTermsApi.md#glossarytermshow) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Get a single term
 *GlossaryTermsApi* | [**glossaryTermUpdate**](docs/Api/GlossaryTermsApi.md#glossarytermupdate) | **PATCH** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Update a term
 *GlossaryTermsApi* | [**glossaryTermsList**](docs/Api/GlossaryTermsApi.md#glossarytermslist) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms | List terms
-*ICUApi* | [**icuSkeleton**](docs/Api/ICUApi.md#icuskeleton) | **POST** /icu/skeleton | Build icu skeletons
+*ICUApi* | [**icuSkeleton**](docs/Api/ICUApi.md#icuskeleton) | **POST** /icu/skeleton | Build ICU skeletons
 *InvitationsApi* | [**invitationCreate**](docs/Api/InvitationsApi.md#invitationcreate) | **POST** /accounts/{account_id}/invitations | Create a new invitation
 *InvitationsApi* | [**invitationDelete**](docs/Api/InvitationsApi.md#invitationdelete) | **DELETE** /accounts/{account_id}/invitations/{id} | Delete an invitation
 *InvitationsApi* | [**invitationResend**](docs/Api/InvitationsApi.md#invitationresend) | **POST** /accounts/{account_id}/invitations/{id}/resend | Resend an invitation
@@ -287,7 +287,7 @@ Class | Method | HTTP request | Description
 *LinkedKeysApi* | [**keyLinksBatchDestroy**](docs/Api/LinkedKeysApi.md#keylinksbatchdestroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links | Batch unlink child keys from a parent key
 *LinkedKeysApi* | [**keyLinksCreate**](docs/Api/LinkedKeysApi.md#keylinkscreate) | **POST** /projects/{project_id}/keys/{id}/key_links | Link child keys to a parent key
 *LinkedKeysApi* | [**keyLinksDestroy**](docs/Api/LinkedKeysApi.md#keylinksdestroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links/{child_key_id} | Unlink a child key from a parent key
-*LinkedKeysApi* | [**keyLinksIndex**](docs/Api/LinkedKeysApi.md#keylinksindex) | **GET** /projects/{project_id}/keys/{id}/key_links | Retrieve all child keys linked to a specific parent key
+*LinkedKeysApi* | [**keyLinksIndex**](docs/Api/LinkedKeysApi.md#keylinksindex) | **GET** /projects/{project_id}/keys/{id}/key_links | List child keys of a parent key
 *LocalesApi* | [**accountLocales**](docs/Api/LocalesApi.md#accountlocales) | **GET** /accounts/{id}/locales | List locales used in account
 *LocalesApi* | [**localeCreate**](docs/Api/LocalesApi.md#localecreate) | **POST** /projects/{project_id}/locales | Create a locale
 *LocalesApi* | [**localeDelete**](docs/Api/LocalesApi.md#localedelete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale

diff --git a/docs/Api/ICUApi.md b/docs/Api/ICUApi.md
@@ -4,17 +4,17 @@ All URIs are relative to *https://api.phrase.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**icuSkeleton**](ICUApi.md#icuSkeleton) | **POST** /icu/skeleton | Build icu skeletons
+[**icuSkeleton**](ICUApi.md#icuSkeleton) | **POST** /icu/skeleton | Build ICU skeletons
 
 
 
 ## icuSkeleton
 
 > \Phrase\Model\Icu icuSkeleton($icu_skeleton_parameters, $x_phrase_app_otp)
 
-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
 

diff --git a/docs/Api/LinkedKeysApi.md b/docs/Api/LinkedKeysApi.md
@@ -7,13 +7,13 @@ Method | HTTP request | Description
 [**keyLinksBatchDestroy**](LinkedKeysApi.md#keyLinksBatchDestroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links | Batch unlink child keys from a parent key
 [**keyLinksCreate**](LinkedKeysApi.md#keyLinksCreate) | **POST** /projects/{project_id}/keys/{id}/key_links | Link child keys to a parent key
 [**keyLinksDestroy**](LinkedKeysApi.md#keyLinksDestroy) | **DELETE** /projects/{project_id}/keys/{id}/key_links/{child_key_id} | Unlink a child key from a parent key
-[**keyLinksIndex**](LinkedKeysApi.md#keyLinksIndex) | **GET** /projects/{project_id}/keys/{id}/key_links | Retrieve all child keys linked to a specific parent key
+[**keyLinksIndex**](LinkedKeysApi.md#keyLinksIndex) | **GET** /projects/{project_id}/keys/{id}/key_links | List child keys of a parent key
 
 
 
 ## keyLinksBatchDestroy
 
-> keyLinksBatchDestroy($project_id, $id, $key_links_batch_destroy_parameters, $x_phrase_app_otp, $unlink_parent)
+> keyLinksBatchDestroy($project_id, $id, $key_links_batch_destroy_parameters, $x_phrase_app_otp)
 
 Batch unlink child keys from a parent key
 
@@ -38,10 +38,9 @@ $project_id = 'project_id_example'; // string | Project ID
 $id = 'id_example'; // string | Parent Translation Key ID
 $key_links_batch_destroy_parameters = new \Phrase\Model\KeyLinksBatchDestroyParameters(); // \Phrase\Model\KeyLinksBatchDestroyParameters | 
 $x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)
-$unlink_parent = True; // bool | Whether to unlink the parent key as well and unmark it as linked-key.
 
 try {
-    $apiInstance->keyLinksBatchDestroy($project_id, $id, $key_links_batch_destroy_parameters, $x_phrase_app_otp, $unlink_parent);
+    $apiInstance->keyLinksBatchDestroy($project_id, $id, $key_links_batch_destroy_parameters, $x_phrase_app_otp);
 } catch (Exception $e) {
     echo 'Exception when calling LinkedKeysApi->keyLinksBatchDestroy: ', $e->getMessage(), PHP_EOL;
 }
@@ -57,7 +56,6 @@ Name | Type | Description  | Notes
  **id** | **string**| Parent Translation Key ID |
  **key_links_batch_destroy_parameters** | [**\Phrase\Model\KeyLinksBatchDestroyParameters**](../Model/KeyLinksBatchDestroyParameters.md)|  |
  **x_phrase_app_otp** | **string**| Two-Factor-Authentication token (optional) | [optional]
- **unlink_parent** | **bool**| Whether to unlink the parent key as well and unmark it as linked-key. | [optional]
 
 ### Return type
 
@@ -210,7 +208,7 @@ void (empty response body)
 
 > \Phrase\Model\KeyLink keyLinksIndex($project_id, $id, $x_phrase_app_otp)
 
-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.
 

diff --git a/docs/Api/LocalesApi.md b/docs/Api/LocalesApi.md
@@ -248,7 +248,7 @@ $encoding = 'encoding_example'; // string | Enforces a specific encoding on the
 $skip_unverified_translations = True; // bool | 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; // bool | if set to false unverified translations are excluded
 $use_last_reviewed_version = True; // bool | 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 = array('key' => new \stdClass); // 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.
 
@@ -285,7 +285,7 @@ Name | Type | Description  | Notes
  **skip_unverified_translations** | **bool**| 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** | **bool**| if set to false unverified translations are excluded | [optional]
  **use_last_reviewed_version** | **bool**| 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**](../Model/.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]
 

diff --git a/docs/Api/UploadsApi.md b/docs/Api/UploadsApi.md
@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 ## uploadCreate
 
-> \Phrase\Model\Upload uploadCreate($project_id, $x_phrase_app_otp, $branch, $file, $file_format, $locale_id, $tags, $update_translations, $update_descriptions, $convert_emoji, $skip_upload_tags, $skip_unverification, $file_encoding, $locale_mapping, $format_options, $autotranslate, $mark_reviewed, $tag_only_affected_keys)
+> \Phrase\Model\Upload uploadCreate($project_id, $file, $file_format, $locale_id, $x_phrase_app_otp, $branch, $tags, $update_translations, $update_descriptions, $convert_emoji, $skip_upload_tags, $skip_unverification, $file_encoding, $locale_mapping, $format_options, $autotranslate, $mark_reviewed, $tag_only_affected_keys)
 
 Upload a new file
 
@@ -34,26 +34,26 @@ $apiInstance = new Phrase\Api\UploadsApi(
     $config
 );
 $project_id = 'project_id_example'; // string | Project ID
-$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)
-$branch = 'branch_example'; // string | specify the branch to use
 $file = "/path/to/file.txt"; // \SplFileObject | File to be imported
 $file_format = 'file_format_example'; // string | File format. Auto-detected when possible and not specified.
-$locale_id = 'locale_id_example'; // string | Locale of the file's content. Can be the name or public id of the locale. Preferred is the public id.
+$locale_id = 'locale_id_example'; // string | Locale of the file's content. Can be the name or id of the locale. Preferred is id.
+$x_phrase_app_otp = 'x_phrase_app_otp_example'; // string | Two-Factor-Authentication token (optional)
+$branch = 'branch_example'; // string | specify the branch to use
 $tags = 'tags_example'; // string | List of tags separated by comma to be associated with the new keys contained in the upload.
 $update_translations = True; // bool | Indicates whether existing translations should be updated with the file content.
 $update_descriptions = True; // bool | Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.
 $convert_emoji = True; // bool | This option is obsolete. Providing the option will cause a bad request error.
 $skip_upload_tags = True; // bool | Indicates whether the upload should not create upload tags.
 $skip_unverification = True; // bool | Indicates whether the upload should unverify updated translations.
 $file_encoding = 'file_encoding_example'; // string | Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\".
-$locale_mapping = array('key' => new \stdClass); // object | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.
+$locale_mapping = array('key' => new \stdClass); // object | Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
 $format_options = array('key' => new \stdClass); // object | Additional options available for specific formats. See our format guide for complete list.
 $autotranslate = True; // bool | If set, translations for the uploaded language will be fetched automatically.
 $mark_reviewed = True; // bool | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
 $tag_only_affected_keys = false; // bool | Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`
 
 try {
-    $result = $apiInstance->uploadCreate($project_id, $x_phrase_app_otp, $branch, $file, $file_format, $locale_id, $tags, $update_translations, $update_descriptions, $convert_emoji, $skip_upload_tags, $skip_unverification, $file_encoding, $locale_mapping, $format_options, $autotranslate, $mark_reviewed, $tag_only_affected_keys);
+    $result = $apiInstance->uploadCreate($project_id, $file, $file_format, $locale_id, $x_phrase_app_otp, $branch, $tags, $update_translations, $update_descriptions, $convert_emoji, $skip_upload_tags, $skip_unverification, $file_encoding, $locale_mapping, $format_options, $autotranslate, $mark_reviewed, $tag_only_affected_keys);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling UploadsApi->uploadCreate: ', $e->getMessage(), PHP_EOL;
@@ -67,19 +67,19 @@ try {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_id** | **string**| Project ID |
+ **file** | **\SplFileObject****\SplFileObject**| File to be imported |
+ **file_format** | **string**| File format. Auto-detected when possible and not specified. |
+ **locale_id** | **string**| Locale of the file&#39;s content. Can be the name or id of the locale. Preferred is id. |
  **x_phrase_app_otp** | **string**| Two-Factor-Authentication token (optional) | [optional]
  **branch** | **string**| specify the branch to use | [optional]
- **file** | **\SplFileObject****\SplFileObject**| File to be imported | [optional]
- **file_format** | **string**| File format. Auto-detected when possible and not specified. | [optional]
- **locale_id** | **string**| Locale of the file&#39;s content. Can be the name or public id of the locale. Preferred is the public id. | [optional]
  **tags** | **string**| List of tags separated by comma to be associated with the new keys contained in the upload. | [optional]
  **update_translations** | **bool**| Indicates whether existing translations should be updated with the file content. | [optional]
  **update_descriptions** | **bool**| Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions. | [optional]
  **convert_emoji** | **bool**| This option is obsolete. Providing the option will cause a bad request error. | [optional]
  **skip_upload_tags** | **bool**| Indicates whether the upload should not create upload tags. | [optional]
  **skip_unverification** | **bool**| Indicates whether the upload should unverify updated translations. | [optional]
  **file_encoding** | **string**| Enforces a specific encoding on the file contents. Valid options are \\\&quot;UTF-8\\\&quot;, \\\&quot;UTF-16\\\&quot; and \\\&quot;ISO-8859-1\\\&quot;. | [optional]
- **locale_mapping** | [**object**](../Model/object.md)| Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. | [optional]
+ **locale_mapping** | [**object**](../Model/object.md)| Mapping between locale names and translation columns. Required in some formats like CSV or XLSX. | [optional]
  **format_options** | [**object**](../Model/object.md)| Additional options available for specific formats. See our format guide for complete list. | [optional]
  **autotranslate** | **bool**| If set, translations for the uploaded language will be fetched automatically. | [optional]
  **mark_reviewed** | **bool**| Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. | [optional]

diff --git a/docs/Model/AuthorizationCreateParameters.md b/docs/Model/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** | **string[]** | A list of scopes that the access can be used for. | [optional] 
 **expires_at** | **\DateTime** | Expiration date for the authorization token. Null means no expiration date (default). | [optional] 
 

diff --git a/docs/Model/BlacklistedKeyCreateParameters.md b/docs/Model/BlacklistedKeyCreateParameters.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | Blocked key name | [optional] 
+**name** | **string** | Blocked key name | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

diff --git a/docs/Model/BranchCreateParameters.md b/docs/Model/BranchCreateParameters.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **string** | Name of the branch | [optional] 
+**name** | **string** | Name of the branch | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

diff --git a/docs/Model/DistributionCreateParameters.md b/docs/Model/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** | **string[]** | 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** | **string[]** | List of locale ids that will be part of distribution releases | [optional] 
 **format_options** | **array&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/Model/FigmaAttachmentCreateParameters.md b/docs/Model/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 | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

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

diff --git a/docs/Model/GlossaryTermCreateParameters.md b/docs/Model/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** | **bool** | Indicates whether the term should be used for all languages or can be translated | [optional] 
 **case_sensitive** | **bool** | Indicates whether the term is case sensitive | [optional]