phrase 3.7.1 → 4.4.0

data/docs/BitbucketSync.md

@@ -1,27 +0,0 @@
-# Phrase::BitbucketSync
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**repository_name** | **String** |  | [optional] 
-**last_export_to_bitbucket_at** | **Time** |  | [optional] 
-**last_import_from_bitbucket_at** | **Time** |  | [optional] 
-**valid_phraseapp_yaml** | **Boolean** |  | [optional] 
-**phraseapp_projects** | [**Array<ProjectShort>**](ProjectShort.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::BitbucketSync.new(id: null,
-                                 repository_name: null,
-                                 last_export_to_bitbucket_at: null,
-                                 last_import_from_bitbucket_at: null,
-                                 valid_phraseapp_yaml: null,
-                                 phraseapp_projects: null)
-```
-
-

data/docs/BitbucketSyncApi.md

@@ -1,197 +0,0 @@
-# Phrase::BitbucketSyncApi
-
-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 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
-
-
-
-## bitbucket_sync_export
-
-> BitbucketSyncExportResponse bitbucket_sync_export(id, bitbucket_sync_export_parameters, opts)
-
-Export from Phrase Strings to Bitbucket
-
-Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket 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::BitbucketSyncApi.new
-id = 'id_example' # String | ID
-bitbucket_sync_export_parameters = Phrase::BitbucketSyncExportParameters.new # BitbucketSyncExportParameters | 
-opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
-}
-
-begin
-  #Export from Phrase Strings to Bitbucket
-  result = api_instance.bitbucket_sync_export(id, bitbucket_sync_export_parameters, opts)
-  pp result
-rescue Phrase::ApiError => e
-  puts "Exception when calling BitbucketSyncApi->bitbucket_sync_export: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| ID | 
- **bitbucket_sync_export_parameters** | [**BitbucketSyncExportParameters**](BitbucketSyncExportParameters.md)|  | 
- **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
-
-### Return type
-
-Response<([**BitbucketSyncExportResponse**](BitbucketSyncExportResponse.md))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## bitbucket_sync_import
-
-> bitbucket_sync_import(id, bitbucket_sync_import_parameters, opts)
-
-Import to Phrase Strings from Bitbucket
-
-Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket 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::BitbucketSyncApi.new
-id = 'id_example' # String | ID
-bitbucket_sync_import_parameters = Phrase::BitbucketSyncImportParameters.new # BitbucketSyncImportParameters | 
-opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
-}
-
-begin
-  #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}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**| ID | 
- **bitbucket_sync_import_parameters** | [**BitbucketSyncImportParameters**](BitbucketSyncImportParameters.md)|  | 
- **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
-
-### Return type
-
-Response<(nil (empty response body))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: Not defined
-
-
-## bitbucket_syncs_list
-
-> Array&lt;BitbucketSync&gt; bitbucket_syncs_list(opts)
-
-List Bitbucket syncs
-
-List all Bitbucket repositories for which synchronisation with Phrase Strings 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::BitbucketSyncApi.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 project should be created in. Required if the requesting user is a member of multiple accounts.
-}
-
-begin
-  #List Bitbucket syncs
-  result = api_instance.bitbucket_syncs_list(opts)
-  pp result
-rescue Phrase::ApiError => e
-  puts "Exception when calling BitbucketSyncApi->bitbucket_syncs_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 project should be created in. Required if the requesting user is a member of multiple accounts. | [optional] 
-
-### Return type
-
-Response<([**Array&lt;BitbucketSync&gt;**](BitbucketSync.md))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/BitbucketSyncExportParameters.md

@@ -1,17 +0,0 @@
-# Phrase::BitbucketSyncExportParameters
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account_id** | **String** | Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::BitbucketSyncExportParameters.new(account_id: abcd1234)
-```
-
-

data/docs/BitbucketSyncExportResponse.md

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

data/docs/BitbucketSyncImportParameters.md

@@ -1,17 +0,0 @@
-# Phrase::BitbucketSyncImportParameters
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**account_id** | **String** | Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'Phrase'
-
-instance = Phrase::BitbucketSyncImportParameters.new(account_id: abcd1234)
-```
-
-

data/docs/GitHubSyncApi.md

@@ -1,130 +0,0 @@
-# Phrase::GitHubSyncApi
-
-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 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 Strings to GitHub
-
-Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub 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::GitHubSyncApi.new
-github_sync_export_parameters = Phrase::GithubSyncExportParameters.new # GithubSyncExportParameters | 
-opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
-}
-
-begin
-  #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}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **github_sync_export_parameters** | [**GithubSyncExportParameters**](GithubSyncExportParameters.md)|  | 
- **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
-
-### Return type
-
-Response<(nil (empty response body))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## github_sync_import
-
-> github_sync_import(github_sync_import_parameters, opts)
-
-Import to Phrase Strings from GitHub
-
-Import files to Phrase Strings from your connected GitHub 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::GitHubSyncApi.new
-github_sync_import_parameters = Phrase::GithubSyncImportParameters.new # GithubSyncImportParameters | 
-opts = {
-  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
-}
-
-begin
-  #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}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **github_sync_import_parameters** | [**GithubSyncImportParameters**](GithubSyncImportParameters.md)|  | 
- **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
-
-### Return type
-
-Response<(nil (empty response body))>
-
-### Authorization
-
-[Basic](../README.md#Basic), [Token](../README.md#Token)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-