phrase 3.7.1 → 4.3.0

data/docs/GitLabSyncApi.md

@@ -1,463 +0,0 @@
-# Phrase::GitLabSyncApi
-
-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 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
-[**gitlab_sync_show**](GitLabSyncApi.md#gitlab_sync_show) | **GET** /gitlab_syncs/{id} | Get single Sync Setting
-[**gitlab_sync_update**](GitLabSyncApi.md#gitlab_sync_update) | **PUT** /gitlab_syncs/{id} | Update single Sync Setting
-
-
-
-## gitlab_sync_delete
-
-> gitlab_sync_delete(id, opts)
-
-Delete single Sync Setting
-
-Deletes a single GitLab Sync Setting.
-
-### Example
-
-```ruby
-# load the gem
-require 'phrase'
-# setup authorization
-Phrase.configure do |config|
-  # Configure HTTP basic authorization: Basic
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  config.api_key_prefix['Authorization'] = 'token'
-end
-
-api_instance = Phrase::GitLabSyncApi.new
-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.
-}
-
-begin
-  #Delete single Sync Setting
-  api_instance.gitlab_sync_delete(id, opts)
-rescue Phrase::ApiError => e
-  puts "Exception when calling GitLabSyncApi->gitlab_sync_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-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] 
-
-### Return type
-
-Response<(nil (empty response body))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## gitlab_sync_export
-
-> GitlabSyncExport gitlab_sync_export(gitlab_sync_id, gitlab_sync_export_parameters, opts)
-
-Export from Phrase Strings to GitLab
-
-Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>
-
-### Example
-
-```ruby
-# load the gem
-require 'phrase'
-# setup authorization
-Phrase.configure do |config|
-  # Configure HTTP basic authorization: Basic
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  config.api_key_prefix['Authorization'] = 'token'
-end
-
-api_instance = Phrase::GitLabSyncApi.new
-gitlab_sync_id = 'gitlab_sync_id_example' # String | Gitlab Sync ID
-gitlab_sync_export_parameters = Phrase::GitlabSyncExportParameters.new # GitlabSyncExportParameters | 
-opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
-}
-
-begin
-  #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
-  puts "Exception when calling GitLabSyncApi->gitlab_sync_export: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **gitlab_sync_id** | **String**| Gitlab Sync ID | 
- **gitlab_sync_export_parameters** | [**GitlabSyncExportParameters**](GitlabSyncExportParameters.md)|  | 
- **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
-
-### Return type
-
-Response<([**GitlabSyncExport**](GitlabSyncExport.md))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## gitlab_sync_history
-
-> Array&lt;GitlabSyncHistory&gt; gitlab_sync_history(gitlab_sync_id, opts)
-
-History of single Sync Setting
-
-List history for a single Sync Setting.
-
-### Example
-
-```ruby
-# load the gem
-require 'phrase'
-# setup authorization
-Phrase.configure do |config|
-  # Configure HTTP basic authorization: Basic
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  config.api_key_prefix['Authorization'] = 'token'
-end
-
-api_instance = Phrase::GitLabSyncApi.new
-gitlab_sync_id = 'gitlab_sync_id_example' # String | Gitlab Sync ID
-opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
-  page: 1, # Integer | Page number
-  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
-  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.
-}
-
-begin
-  #History of single Sync Setting
-  result = api_instance.gitlab_sync_history(gitlab_sync_id, opts)
-  pp result
-rescue Phrase::ApiError => e
-  puts "Exception when calling GitLabSyncApi->gitlab_sync_history: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **gitlab_sync_id** | **String**| Gitlab Sync ID | 
- **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
- **page** | **Integer**| Page number | [optional] 
- **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional] 
- **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] 
-
-### Return type
-
-Response<([**Array&lt;GitlabSyncHistory&gt;**](GitlabSyncHistory.md))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## gitlab_sync_import
-
-> Array&lt;Upload&gt; gitlab_sync_import(gitlab_sync_id, gitlab_sync_import_parameters, opts)
-
-Import from GitLab to Phrase
-
-Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository. <br><br><i>Note: Import is done asynchronously and may take several seconds depending on the project size.</i>
-
-### Example
-
-```ruby
-# load the gem
-require 'phrase'
-# setup authorization
-Phrase.configure do |config|
-  # Configure HTTP basic authorization: Basic
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  config.api_key_prefix['Authorization'] = 'token'
-end
-
-api_instance = Phrase::GitLabSyncApi.new
-gitlab_sync_id = 'gitlab_sync_id_example' # String | Gitlab Sync ID
-gitlab_sync_import_parameters = Phrase::GitlabSyncImportParameters.new # GitlabSyncImportParameters | 
-opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
-}
-
-begin
-  #Import from GitLab to Phrase
-  result = api_instance.gitlab_sync_import(gitlab_sync_id, gitlab_sync_import_parameters, opts)
-  pp result
-rescue Phrase::ApiError => e
-  puts "Exception when calling GitLabSyncApi->gitlab_sync_import: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **gitlab_sync_id** | **String**| Gitlab Sync ID | 
- **gitlab_sync_import_parameters** | [**GitlabSyncImportParameters**](GitlabSyncImportParameters.md)|  | 
- **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
-
-### Return type
-
-Response<([**Array&lt;Upload&gt;**](Upload.md))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## gitlab_sync_list
-
-> Array&lt;GitlabSync&gt; gitlab_sync_list(opts)
-
-List GitLab syncs
-
-List all GitLab Sync Settings for which synchronisation with Phrase Strings and GitLab is activated.
-
-### Example
-
-```ruby
-# load the gem
-require 'phrase'
-# setup authorization
-Phrase.configure do |config|
-  # Configure HTTP basic authorization: Basic
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  config.api_key_prefix['Authorization'] = 'token'
-end
-
-api_instance = Phrase::GitLabSyncApi.new
-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.
-}
-
-begin
-  #List GitLab syncs
-  result = api_instance.gitlab_sync_list(opts)
-  pp result
-rescue Phrase::ApiError => e
-  puts "Exception when calling GitLabSyncApi->gitlab_sync_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **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] 
-
-### Return type
-
-Response<([**Array&lt;GitlabSync&gt;**](GitlabSync.md))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## gitlab_sync_show
-
-> GitlabSync gitlab_sync_show(id, opts)
-
-Get single Sync Setting
-
-Shows a single GitLab Sync Setting.
-
-### Example
-
-```ruby
-# load the gem
-require 'phrase'
-# setup authorization
-Phrase.configure do |config|
-  # Configure HTTP basic authorization: Basic
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  config.api_key_prefix['Authorization'] = 'token'
-end
-
-api_instance = Phrase::GitLabSyncApi.new
-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.
-}
-
-begin
-  #Get single Sync Setting
-  result = api_instance.gitlab_sync_show(id, opts)
-  pp result
-rescue Phrase::ApiError => e
-  puts "Exception when calling GitLabSyncApi->gitlab_sync_show: #{e}"
-end
-```
-
-### Parameters
-
-
-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] 
-
-### Return type
-
-Response<([**GitlabSync**](GitlabSync.md))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## gitlab_sync_update
-
-> GitlabSync gitlab_sync_update(id, opts)
-
-Update single Sync Setting
-
-Updates a single GitLab Sync Setting.
-
-### Example
-
-```ruby
-# load the gem
-require 'phrase'
-# setup authorization
-Phrase.configure do |config|
-  # Configure HTTP basic authorization: Basic
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
-  config.api_key_prefix['Authorization'] = 'token'
-end
-
-api_instance = Phrase::GitLabSyncApi.new
-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 Strings Project.
-  gitlab_project_id: 12345, # Integer | ID of the related GitLab Project.
-  gitlab_branch_name: 'feature-development' # String | Name of the GitLab Branch.
-}
-
-begin
-  #Update single Sync Setting
-  result = api_instance.gitlab_sync_update(id, opts)
-  pp result
-rescue Phrase::ApiError => e
-  puts "Exception when calling GitLabSyncApi->gitlab_sync_update: #{e}"
-end
-```
-
-### Parameters
-
-
-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 Strings Project. | [optional] 
- **gitlab_project_id** | **Integer**| ID of the related GitLab Project. | [optional] 
- **gitlab_branch_name** | **String**| Name of the GitLab Branch. | [optional] 
-
-### Return type
-
-Response<([**GitlabSync**](GitlabSync.md))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/GithubSyncExportParameters.md

@@ -1,17 +0,0 @@
-# Phrase::GithubSyncExportParameters
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**project_id** | **String** | Project ID to specify the actual project the GitHub export should be triggered in. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::GithubSyncExportParameters.new(project_id: abcd1234)
-```
-
-

data/docs/GithubSyncImportParameters.md

@@ -1,17 +0,0 @@
-# Phrase::GithubSyncImportParameters
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**project_id** | **String** | Project ID to specify the actual project the GitHub import should be triggered in. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::GithubSyncImportParameters.new(project_id: abcd1234)
-```
-
-

data/docs/GitlabSync.md

@@ -1,37 +0,0 @@
-# Phrase::GitlabSync
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**project_id** | **String** |  | [optional] 
-**gitlab_project_id** | **Integer** |  | [optional] 
-**gitlab_branch_name** | **String** |  | [optional] 
-**auto_import** | **Boolean** |  | [optional] 
-**auto_import_secret** | **String** |  | [optional] 
-**auto_import_url** | **String** |  | [optional] 
-**self_hosted_api_url** | **String** |  | [optional] 
-**last_exported_at** | **Time** |  | [optional] 
-**last_imported_at** | **Time** |  | [optional] 
-**last_status** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::GitlabSync.new(id: null,
-                                 project_id: null,
-                                 gitlab_project_id: null,
-                                 gitlab_branch_name: null,
-                                 auto_import: null,
-                                 auto_import_secret: null,
-                                 auto_import_url: null,
-                                 self_hosted_api_url: null,
-                                 last_exported_at: null,
-                                 last_imported_at: null,
-                                 last_status: null)
-```
-
-

data/docs/GitlabSyncExport.md

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

data/docs/GitlabSyncExportParameters.md

@@ -1,17 +0,0 @@
-# Phrase::GitlabSyncExportParameters
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::GitlabSyncExportParameters.new(account_id: abcd1234)
-```
-
-

data/docs/GitlabSyncHistory.md

@@ -1,25 +0,0 @@
-# Phrase::GitlabSyncHistory
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** |  | [optional] 
-**action** | **String** |  | [optional] 
-**errors** | [**Array<GitlabSyncHistoryErrorsInner>**](GitlabSyncHistoryErrorsInner.md) |  | [optional] 
-**date** | **Time** |  | [optional] 
-**details** | **Object** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::GitlabSyncHistory.new(status: null,
-                                 action: null,
-                                 errors: null,
-                                 date: null,
-                                 details: null)
-```
-
-

data/docs/GitlabSyncHistoryErrorsInner.md

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

data/docs/GitlabSyncImportParameters.md

@@ -1,17 +0,0 @@
-# Phrase::GitlabSyncImportParameters
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**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] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::GitlabSyncImportParameters.new(account_id: abcd1234)
-```
-
-

data/docs/ProjectsQualityPerformanceScore200Response.md

@@ -1,21 +0,0 @@
-# Phrase::ProjectsQualityPerformanceScore200Response
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | [**ErrorError**](ErrorError.md) |  | [optional] 
-**data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) |  | [optional] 
-**errors** | [**Array<ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner>**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::ProjectsQualityPerformanceScore200Response.new(error: null,
-                                 data: null,
-                                 errors: null)
-```
-
-

data/docs/ProjectsQualityPerformanceScore200ResponseAnyOf.md

@@ -1,19 +0,0 @@
-# Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**ProjectsQualityPerformanceScore200ResponseAnyOfData**](ProjectsQualityPerformanceScore200ResponseAnyOfData.md) |  | [optional] 
-**errors** | [**Array<ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner>**](ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner.md) | Array of errors for any failing translation IDs | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOf.new(data: null,
-                                 errors: null)
-```
-
-

data/docs/ProjectsQualityPerformanceScore200ResponseAnyOfData.md

@@ -1,17 +0,0 @@
-# Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**translations** | [**Array<ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner>**](ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::ProjectsQualityPerformanceScore200ResponseAnyOfData.new(translations: null)
-```
-
-