Deploying from phrase/openapi@79c56381

phrase · Sep 27, 2022 · 09966d5 · 09966d5
1 parent 6905330
commit 09966d5
Show file tree

Hide file tree

Showing 26 changed files with 118 additions and 118 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # phrase
 
-Phrase - the Ruby gem for the Phrase API Reference
+Phrase - the Ruby gem for the Phrase Strings API Reference
 
-Phrase is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase for your account.
+Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.
 
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
@@ -137,8 +137,8 @@ Class | Method | HTTP request | Description
 *Phrase::AuthorizationsApi* | [**authorization_show**](docs/AuthorizationsApi.md#authorization_show) | **GET** /authorizations/{id} | Get a single authorization
 *Phrase::AuthorizationsApi* | [**authorization_update**](docs/AuthorizationsApi.md#authorization_update) | **PATCH** /authorizations/{id} | Update an authorization
 *Phrase::AuthorizationsApi* | [**authorizations_list**](docs/AuthorizationsApi.md#authorizations_list) | **GET** /authorizations | List authorizations
-*Phrase::BitbucketSyncApi* | [**bitbucket_sync_export**](docs/BitbucketSyncApi.md#bitbucket_sync_export) | **POST** /bitbucket_syncs/{id}/export | Export from Phrase to Bitbucket
-*Phrase::BitbucketSyncApi* | [**bitbucket_sync_import**](docs/BitbucketSyncApi.md#bitbucket_sync_import) | **POST** /bitbucket_syncs/{id}/import | Import to Phrase from Bitbucket
+*Phrase::BitbucketSyncApi* | [**bitbucket_sync_export**](docs/BitbucketSyncApi.md#bitbucket_sync_export) | **POST** /bitbucket_syncs/{id}/export | Export from Phrase Strings to Bitbucket
+*Phrase::BitbucketSyncApi* | [**bitbucket_sync_import**](docs/BitbucketSyncApi.md#bitbucket_sync_import) | **POST** /bitbucket_syncs/{id}/import | Import to Phrase Strings from Bitbucket
 *Phrase::BitbucketSyncApi* | [**bitbucket_syncs_list**](docs/BitbucketSyncApi.md#bitbucket_syncs_list) | **GET** /bitbucket_syncs | List Bitbucket syncs
 *Phrase::BlacklistedKeysApi* | [**blacklisted_key_create**](docs/BlacklistedKeysApi.md#blacklisted_key_create) | **POST** /projects/{project_id}/blacklisted_keys | Create a blocked key
 *Phrase::BlacklistedKeysApi* | [**blacklisted_key_delete**](docs/BlacklistedKeysApi.md#blacklisted_key_delete) | **DELETE** /projects/{project_id}/blacklisted_keys/{id} | Delete a blocked key
@@ -168,10 +168,10 @@ Class | Method | HTTP request | Description
 *Phrase::DocumentsApi* | [**document_delete**](docs/DocumentsApi.md#document_delete) | **DELETE** /projects/{project_id}/documents/{id} | Delete document
 *Phrase::DocumentsApi* | [**documents_list**](docs/DocumentsApi.md#documents_list) | **GET** /projects/{project_id}/documents | List documents
 *Phrase::FormatsApi* | [**formats_list**](docs/FormatsApi.md#formats_list) | **GET** /formats | List formats
-*Phrase::GitHubSyncApi* | [**github_sync_export**](docs/GitHubSyncApi.md#github_sync_export) | **POST** /github_syncs/export | Export from Phrase to GitHub
-*Phrase::GitHubSyncApi* | [**github_sync_import**](docs/GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase from GitHub
+*Phrase::GitHubSyncApi* | [**github_sync_export**](docs/GitHubSyncApi.md#github_sync_export) | **POST** /github_syncs/export | Export from Phrase Strings to GitHub
+*Phrase::GitHubSyncApi* | [**github_sync_import**](docs/GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase Strings from GitHub
 *Phrase::GitLabSyncApi* | [**gitlab_sync_delete**](docs/GitLabSyncApi.md#gitlab_sync_delete) | **DELETE** /gitlab_syncs/{id} | Delete single Sync Setting
-*Phrase::GitLabSyncApi* | [**gitlab_sync_export**](docs/GitLabSyncApi.md#gitlab_sync_export) | **POST** /gitlab_syncs/{gitlab_sync_id}/export | Export from Phrase to GitLab
+*Phrase::GitLabSyncApi* | [**gitlab_sync_export**](docs/GitLabSyncApi.md#gitlab_sync_export) | **POST** /gitlab_syncs/{gitlab_sync_id}/export | Export from Phrase Strings to GitLab
 *Phrase::GitLabSyncApi* | [**gitlab_sync_history**](docs/GitLabSyncApi.md#gitlab_sync_history) | **GET** /gitlab_syncs/{gitlab_sync_id}/history | History of single Sync Setting
 *Phrase::GitLabSyncApi* | [**gitlab_sync_import**](docs/GitLabSyncApi.md#gitlab_sync_import) | **POST** /gitlab_syncs/{gitlab_sync_id}/import | Import from GitLab to Phrase
 *Phrase::GitLabSyncApi* | [**gitlab_sync_list**](docs/GitLabSyncApi.md#gitlab_sync_list) | **GET** /gitlab_syncs | List GitLab syncs

diff --git a/docs/BitbucketSyncApi.md b/docs/BitbucketSyncApi.md
@@ -4,8 +4,8 @@ All URIs are relative to *https://api.phrase.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**bitbucket_sync_export**](BitbucketSyncApi.md#bitbucket_sync_export) | **POST** /bitbucket_syncs/{id}/export | Export from Phrase to Bitbucket
-[**bitbucket_sync_import**](BitbucketSyncApi.md#bitbucket_sync_import) | **POST** /bitbucket_syncs/{id}/import | Import to Phrase from Bitbucket
+[**bitbucket_sync_export**](BitbucketSyncApi.md#bitbucket_sync_export) | **POST** /bitbucket_syncs/{id}/export | Export from Phrase Strings to Bitbucket
+[**bitbucket_sync_import**](BitbucketSyncApi.md#bitbucket_sync_import) | **POST** /bitbucket_syncs/{id}/import | Import to Phrase Strings from Bitbucket
 [**bitbucket_syncs_list**](BitbucketSyncApi.md#bitbucket_syncs_list) | **GET** /bitbucket_syncs | List Bitbucket syncs
 
 
@@ -14,9 +14,9 @@ Method | HTTP request | Description
 
 > BitbucketSyncExportResponse bitbucket_sync_export(id, bitbucket_sync_export_parameters, opts)
 
-Export from Phrase to Bitbucket
+Export from Phrase Strings to Bitbucket
 
-Export translations from Phrase to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
+Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
 
 ### Example
 
@@ -42,7 +42,7 @@ opts = {
 }
 
 begin
-  #Export from Phrase to Bitbucket
+  #Export from Phrase Strings to Bitbucket
   result = api_instance.bitbucket_sync_export(id, bitbucket_sync_export_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
@@ -77,9 +77,9 @@ Response<([**BitbucketSyncExportResponse**](BitbucketSyncExportResponse.md))>
 
 > bitbucket_sync_import(id, bitbucket_sync_import_parameters, opts)
 
-Import to Phrase from Bitbucket
+Import to Phrase Strings from Bitbucket
 
-Import translations from Bitbucket to Phrase according to the .phraseapp.yml file within the Bitbucket repository.
+Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository.
 
 ### Example
 
@@ -105,7 +105,7 @@ opts = {
 }
 
 begin
-  #Import to Phrase from Bitbucket
+  #Import to Phrase Strings from Bitbucket
   api_instance.bitbucket_sync_import(id, bitbucket_sync_import_parameters, opts)
 rescue Phrase::ApiError => e
   puts "Exception when calling BitbucketSyncApi->bitbucket_sync_import: #{e}"
@@ -141,7 +141,7 @@ Response<(nil (empty response body))>
 
 List Bitbucket syncs
 
-List all Bitbucket repositories for which synchronisation with Phrase is activated.
+List all Bitbucket repositories for which synchronisation with Phrase Strings is activated.
 
 ### Example
 

diff --git a/docs/GitHubSyncApi.md b/docs/GitHubSyncApi.md
@@ -4,18 +4,18 @@ All URIs are relative to *https://api.phrase.com/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**github_sync_export**](GitHubSyncApi.md#github_sync_export) | **POST** /github_syncs/export | Export from Phrase to GitHub
-[**github_sync_import**](GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase from GitHub
+[**github_sync_export**](GitHubSyncApi.md#github_sync_export) | **POST** /github_syncs/export | Export from Phrase Strings to GitHub
+[**github_sync_import**](GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase Strings from GitHub
 
 
 
 ## github_sync_export
 
 > github_sync_export(github_sync_export_parameters, opts)
 
-Export from Phrase to GitHub
+Export from Phrase Strings to GitHub
 
-Export translations from Phrase to GitHub according to the .phraseapp.yml file within the GitHub repository.
+Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository.
 
 ### Example
 
@@ -40,7 +40,7 @@ opts = {
 }
 
 begin
-  #Export from Phrase to GitHub
+  #Export from Phrase Strings to GitHub
   api_instance.github_sync_export(github_sync_export_parameters, opts)
 rescue Phrase::ApiError => e
   puts "Exception when calling GitHubSyncApi->github_sync_export: #{e}"
@@ -73,9 +73,9 @@ Response<(nil (empty response body))>
 
 > github_sync_import(github_sync_import_parameters, opts)
 
-Import to Phrase from GitHub
+Import to Phrase Strings from GitHub
 
-Import files to Phrase from your connected GitHub repository.
+Import files to Phrase Strings from your connected GitHub repository.
 
 ### Example
 
@@ -100,7 +100,7 @@ opts = {
 }
 
 begin
-  #Import to Phrase from GitHub
+  #Import to Phrase Strings from GitHub
   api_instance.github_sync_import(github_sync_import_parameters, opts)
 rescue Phrase::ApiError => e
   puts "Exception when calling GitHubSyncApi->github_sync_import: #{e}"

diff --git a/docs/GitLabSyncApi.md b/docs/GitLabSyncApi.md
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.phrase.com/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**gitlab_sync_delete**](GitLabSyncApi.md#gitlab_sync_delete) | **DELETE** /gitlab_syncs/{id} | Delete single Sync Setting
-[**gitlab_sync_export**](GitLabSyncApi.md#gitlab_sync_export) | **POST** /gitlab_syncs/{gitlab_sync_id}/export | Export from Phrase to GitLab
+[**gitlab_sync_export**](GitLabSyncApi.md#gitlab_sync_export) | **POST** /gitlab_syncs/{gitlab_sync_id}/export | Export from Phrase Strings to GitLab
 [**gitlab_sync_history**](GitLabSyncApi.md#gitlab_sync_history) | **GET** /gitlab_syncs/{gitlab_sync_id}/history | History of single Sync Setting
 [**gitlab_sync_import**](GitLabSyncApi.md#gitlab_sync_import) | **POST** /gitlab_syncs/{gitlab_sync_id}/import | Import from GitLab to Phrase
 [**gitlab_sync_list**](GitLabSyncApi.md#gitlab_sync_list) | **GET** /gitlab_syncs | List GitLab syncs
@@ -80,9 +80,9 @@ Response<(nil (empty response body))>
 
 > GitlabSyncExport gitlab_sync_export(gitlab_sync_id, gitlab_sync_export_parameters, opts)
 
-Export from Phrase to GitLab
+Export from Phrase Strings to GitLab
 
-Export translations from Phrase to GitLab according to the .phraseapp.yml file within the GitLab repository.
+Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository.
 
 ### Example
 
@@ -108,7 +108,7 @@ opts = {
 }
 
 begin
-  #Export from Phrase to GitLab
+  #Export from Phrase Strings to GitLab
   result = api_instance.gitlab_sync_export(gitlab_sync_id, gitlab_sync_export_parameters, opts)
   pp result
 rescue Phrase::ApiError => e
@@ -212,7 +212,7 @@ Response<([**Array&lt;GitlabSyncHistory&gt;**](GitlabSyncHistory.md))>
 
 Import from GitLab to Phrase
 
-Import translations from GitLab to Phrase according to the .phraseapp.yml file within the GitLab repository.
+Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository.
 
 ### Example
 
@@ -275,7 +275,7 @@ Response<([**Array&lt;Upload&gt;**](Upload.md))>
 
 List GitLab syncs
 
-List all GitLab Sync Settings for which synchronisation with Phrase and GitLab is activated.
+List all GitLab Sync Settings for which synchronisation with Phrase Strings and GitLab is activated.
 
 ### Example
 
@@ -422,7 +422,7 @@ id = 'id_example' # String | ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   account_id: 'abcd1234', # String | Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
-  phrase_project_code: '3456abcd', # String | Code of the related Phrase Project.
+  phrase_project_code: '3456abcd', # String | Code of the related Phrase Strings Project.
   gitlab_project_id: 12345, # Integer | ID of the related GitLab Project.
   gitlab_branch_name: 'feature-development' # String | Name of the GitLab Branch.
 }
@@ -444,7 +444,7 @@ Name | Type | Description  | Notes
  **id** | **String**| ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **account_id** | **String**| Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts. | [optional] 
- **phrase_project_code** | **String**| Code of the related Phrase Project. | [optional] 
+ **phrase_project_code** | **String**| Code of the related Phrase Strings Project. | [optional] 
  **gitlab_project_id** | **Integer**| ID of the related GitLab Project. | [optional] 
  **gitlab_branch_name** | **String**| Name of the GitLab Branch. | [optional] 
 

diff --git a/docs/LocaleCreateParameters.md b/docs/LocaleCreateParameters.md
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
 **name** | **String** | Locale name | [optional] 
 **code** | **String** | Locale ISO code | [optional] 
 **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 &lt;a href&#x3D;\&quot;https://help.phrase.com/help/verification-and-proofreading\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Verification System&lt;/a&gt; feature. | [optional] 
+**main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Verification System&lt;/a&gt; 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] 
 **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 &lt;a href&#x3D;\&quot;https://help.phrase.com/help/verification-and-proofreading\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional] 
-**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://help.phrase.com/help/verification-and-proofreading\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional] 
+**unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional] 
+**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional] 
 **autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional] 
 
 ## Code Sample

diff --git a/docs/LocaleUpdateParameters.md b/docs/LocaleUpdateParameters.md
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
 **name** | **String** | Locale name | [optional] 
 **code** | **String** | Locale ISO code | [optional] 
 **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 &lt;a href&#x3D;\&quot;https://help.phrase.com/help/verification-and-proofreading\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Verification System&lt;/a&gt; feature. | [optional] 
+**main** | **Boolean** | Indicates whether locale is a main locale. Main locales are part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Verification System&lt;/a&gt; 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] 
 **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 &lt;a href&#x3D;\&quot;https://help.phrase.com/help/verification-and-proofreading\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional] 
-**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://help.phrase.com/help/verification-and-proofreading\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional] 
+**unverify_new_translations** | **Boolean** | Indicates that new translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional] 
+**unverify_updated_translations** | **Boolean** | Indicates that updated translations for this locale should be marked as unverified. Part of the &lt;a href&#x3D;\&quot;https://support.phrase.com/hc/en-us/articles/5784094755484\&quot; target&#x3D;\&quot;_blank\&quot;&gt;Advanced Workflows&lt;/a&gt; feature. | [optional] 
 **autotranslate** | **Boolean** | If set, translations for this locale will be fetched automatically, right after creation. | [optional] 
 
 ## Code Sample