phrase 1.0.2 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aae5a4cef9ef59af5c86c21345a105395e27ec284b6066e0f2190cff3767df2f
-  data.tar.gz: 2f67c99c9d7ee5e6e0e71caa463ed45e9f20c98bd054a0f0ac89cabd2c3590ab
+  metadata.gz: 363818b3fafb57ee99cac2370eaad0ab61a2e1e287092aec2536b48037a7b724
+  data.tar.gz: b856a73bc10eae5eb9f37aaff1cf4edb96d12d599e2230d3dc2a015e84259c94
 SHA512:
-  metadata.gz: 2aa97915991fdf06dcaf1b28ea30256f931161cbb8ac0bacc8dbf4997079517559497d0a70419a0278e4d11f4a82fe6d32de5f436e8eff167f4e2e5eae5b0cbe
-  data.tar.gz: d69cb1356d438ea7f6d03c11831be40bc3afcdf15f651a3e79d46b363d6e12b60bb71cb2615029d9c4551c145f45214726046d1b4fb850a00239f821f77e132b
+  metadata.gz: ee376ffad0648c64a9f4eec806331afbaf9a65eaaf1577a9fc5192b93abdfcf85fff077a299c942902b983b84b70b2f46102fb27dd1fd499009dc8585dcec1b9
+  data.tar.gz: e9fd4bc297f45da44232563a52bc812771e58ee9fafcb0893f79ca80a9d7df0544025b4914e7b27e6413035612d2fa16a8f79eb3c2417ae2881968388129a0fd

data/README.md

@@ -7,7 +7,7 @@ Phrase is a translation management platform for software projects. You can colla
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 1.0.1
+- Package version: 1.0.7
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./phrase-1.0.1.gem
+gem install ./phrase-1.0.7.gem
 ```
 
-(for development, run `gem install --dev ./phrase-1.0.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-1.0.7.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -139,7 +139,11 @@ Class | Method | HTTP request | Description
 *Phrase::DistributionsApi* | [**distribution_show**](docs/DistributionsApi.md#distribution_show) | **GET** /accounts/{account_id}/distributions/{id} | Get a single distribution
 *Phrase::DistributionsApi* | [**distribution_update**](docs/DistributionsApi.md#distribution_update) | **PATCH** /accounts/{account_id}/distributions/{id} | Update a distribution
 *Phrase::DistributionsApi* | [**distributions_list**](docs/DistributionsApi.md#distributions_list) | **GET** /accounts/{account_id}/distributions | List distributions
+*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::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_history**](docs/GitLabSyncApi.md#gitlab_sync_history) | **GET** /gitlab_syncs/{gitlab_sync_id}/history | History of single Sync Setting
@@ -182,6 +186,7 @@ Class | Method | HTTP request | Description
 *Phrase::JobsApi* | [**job_show**](docs/JobsApi.md#job_show) | **GET** /projects/{project_id}/jobs/{id} | Get a single job
 *Phrase::JobsApi* | [**job_start**](docs/JobsApi.md#job_start) | **POST** /projects/{project_id}/jobs/{id}/start | Start a job
 *Phrase::JobsApi* | [**job_update**](docs/JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
+*Phrase::JobsApi* | [**jobs_by_account**](docs/JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
 *Phrase::JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
 *Phrase::KeysApi* | [**key_create**](docs/KeysApi.md#key_create) | **POST** /projects/{project_id}/keys | Create a key
 *Phrase::KeysApi* | [**key_delete**](docs/KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
@@ -318,7 +323,10 @@ Class | Method | HTTP request | Description
  - [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
  - [Phrase::DistributionPreview](docs/DistributionPreview.md)
  - [Phrase::DistributionUpdateParameters](docs/DistributionUpdateParameters.md)
+ - [Phrase::Document](docs/Document.md)
  - [Phrase::Format](docs/Format.md)
+ - [Phrase::GithubSyncExportParameters](docs/GithubSyncExportParameters.md)
+ - [Phrase::GithubSyncImportParameters](docs/GithubSyncImportParameters.md)
  - [Phrase::GitlabSync](docs/GitlabSync.md)
  - [Phrase::GitlabSyncExport](docs/GitlabSyncExport.md)
  - [Phrase::GitlabSyncExportParameters](docs/GitlabSyncExportParameters.md)
@@ -333,6 +341,8 @@ Class | Method | HTTP request | Description
  - [Phrase::GlossaryTermTranslationUpdateParameters](docs/GlossaryTermTranslationUpdateParameters.md)
  - [Phrase::GlossaryTermUpdateParameters](docs/GlossaryTermUpdateParameters.md)
  - [Phrase::GlossaryUpdateParameters](docs/GlossaryUpdateParameters.md)
+ - [Phrase::InlineResponse422](docs/InlineResponse422.md)
+ - [Phrase::InlineResponse422Errors](docs/InlineResponse422Errors.md)
  - [Phrase::Invitation](docs/Invitation.md)
  - [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
  - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)

data/docs/Account.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
+**slug** | **String** |  | [optional] 
 **company** | **String** |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
@@ -17,6 +18,7 @@ require 'Phrase'
 
 instance = Phrase::Account.new(id: null,
                                  name: null,
+                                 slug: null,
                                  company: null,
                                  created_at: null,
                                  updated_at: null)

data/docs/AccountDetails.md

@@ -6,10 +6,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
+**slug** | **String** |  | [optional] 
 **company** | **String** |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
-**slug** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -18,10 +18,10 @@ require 'Phrase'
 
 instance = Phrase::AccountDetails.new(id: null,
                                  name: null,
+                                 slug: null,
                                  company: null,
                                  created_at: null,
-                                 updated_at: null,
-                                 slug: null)
+                                 updated_at: null)
 ```
 
 

data/docs/AccountsApi.md

@@ -98,7 +98,7 @@ api_instance = Phrase::AccountsApi.new
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
-  per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
+  per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
 }
 
 begin
@@ -117,7 +117,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
 
 ### Return type
 

data/docs/AuthorizationsApi.md

@@ -285,7 +285,7 @@ api_instance = Phrase::AuthorizationsApi.new
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
-  per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
+  per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
 }
 
 begin
@@ -304,7 +304,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
 
 ### Return type
 

data/docs/BlacklistedKeysApi.md

@@ -294,7 +294,8 @@ project_id = 'project_id_example' # String | Project ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
-  per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
+  per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
+  branch: 'my-feature-branch' # String | specify the branch to use
 }
 
 begin
@@ -314,7 +315,8 @@ Name | Type | Description  | Notes
  **project_id** | **String**| Project ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type
 

data/docs/BranchesApi.md

@@ -422,7 +422,7 @@ project_id = 'project_id_example' # String | Project ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
-  per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
+  per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
 }
 
 begin
@@ -442,7 +442,7 @@ Name | Type | Description  | Notes
  **project_id** | **String**| Project ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
 
 ### Return type
 

data/docs/CommentsApi.md

@@ -508,7 +508,7 @@ key_id = 'key_id_example' # String | Translation Key ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
-  per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
+  per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
   branch: 'my-feature-branch' # String | specify the branch to use
 }
 
@@ -530,7 +530,7 @@ Name | Type | Description  | Notes
  **key_id** | **String**| Translation Key ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
  **branch** | **String**| specify the branch to use | [optional] 
 
 ### Return type

data/docs/DistributionsApi.md

@@ -294,7 +294,7 @@ account_id = 'account_id_example' # String | Account ID
 opts = {
   x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
   page: 1, # Integer | Page number
-  per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
+  per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
 }
 
 begin
@@ -314,7 +314,7 @@ Name | Type | Description  | Notes
  **account_id** | **String**| Account ID | 
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
  **page** | **Integer**| Page number | [optional] 
- **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
 
 ### Return type
 

data/docs/Document.md

@@ -0,0 +1,23 @@
+# Phrase::Document
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Document.new(id: null,
+                                 name: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/DocumentsApi.md

@@ -0,0 +1,137 @@
+# Phrase::DocumentsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**document_delete**](DocumentsApi.md#document_delete) | **DELETE** /projects/{project_id}/documents/{id} | Delete document
+[**documents_list**](DocumentsApi.md#documents_list) | **GET** /projects/{project_id}/documents | List documents
+
+
+
+## document_delete
+
+> document_delete(project_id, id, opts)
+
+Delete document
+
+Delete an existing document.
+
+### 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::DocumentsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Delete document
+  api_instance.document_delete(project_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling DocumentsApi->document_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **id** | **String**| ID | 
+ **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**: Not defined
+- **Accept**: Not defined
+
+
+## documents_list
+
+> Array&lt;Document&gt; documents_list(project_id, opts)
+
+List documents
+
+List all documents the current user has access to.
+
+### 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::DocumentsApi.new
+project_id = 'project_id_example' # String | Project 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 | allows you to specify a page size up to 100 items, 25 by default
+}
+
+begin
+  #List documents
+  result = api_instance.documents_list(project_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling DocumentsApi->documents_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **page** | **Integer**| Page number | [optional] 
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional] 
+
+### Return type
+
+Response<([**Array&lt;Document&gt;**](Document.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GitHubSyncApi.md

@@ -0,0 +1,130 @@
+# 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 to GitHub
+[**github_sync_import**](GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase from GitHub
+
+
+
+## github_sync_export
+
+> github_sync_export(github_sync_export_parameters, opts)
+
+Export from Phrase to GitHub
+
+Export translations from Phrase to GitHub according to the .phraseapp.yml file within the GitHub repository.
+
+### 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 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 from GitHub
+
+Import files to Phrase from your connected GitHub repository.
+
+### 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 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
+