phrase 0.4.33 → 1.0.1

data/docs/Project.md

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

data/docs/ProjectCreateParameters.md

@@ -0,0 +1,27 @@
+# Phrase::ProjectCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the project | [optional] 
+**main_format** | **String** | Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional] 
+**shares_translation_memory** | **Boolean** | Indicates whether the project should share the account's translation memory | [optional] 
+**project_image** | **File** | Image to identify the project | [optional] 
+**remove_project_image** | **Boolean** | Indicates whether the project image should be deleted. | [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] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
+                                 main_format: yml,
+                                 shares_translation_memory: true,
+                                 project_image: null,
+                                 remove_project_image: null,
+                                 account_id: abcd1234)
+```
+
+

data/docs/ProjectDetails.md

@@ -0,0 +1,33 @@
+# Phrase::ProjectDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**main_format** | **String** |  | [optional] 
+**project_image_url** | **String** |  | [optional] 
+**account** | [**Account**](Account.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**slug** | **String** |  | [optional] 
+**shares_translation_memory** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectDetails.new(id: null,
+                                 name: null,
+                                 main_format: null,
+                                 project_image_url: null,
+                                 account: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 slug: null,
+                                 shares_translation_memory: null)
+```
+
+

data/docs/ProjectDetails1.md

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

data/docs/ProjectLocales.md

@@ -0,0 +1,27 @@
+# Phrase::ProjectLocales
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**main_format** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectLocales.new(id: null,
+                                 name: null,
+                                 main_format: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 locales: null)
+```
+
+

data/docs/ProjectLocales1.md

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

data/docs/ProjectShort.md

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

data/docs/ProjectUpdateParameters.md

@@ -0,0 +1,27 @@
+# Phrase::ProjectUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the project | [optional] 
+**main_format** | **String** | Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>. | [optional] 
+**shares_translation_memory** | **Boolean** | Indicates whether the project should share the account's translation memory | [optional] 
+**project_image** | **File** | Image to identify the project | [optional] 
+**remove_project_image** | **Boolean** | Indicates whether the project image should be deleted. | [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] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ProjectUpdateParameters.new(name: My Android Project,
+                                 main_format: yml,
+                                 shares_translation_memory: true,
+                                 project_image: null,
+                                 remove_project_image: null,
+                                 account_id: abcd1234)
+```
+
+

data/docs/ProjectsApi.md

@@ -0,0 +1,325 @@
+# Phrase::ProjectsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**project_create**](ProjectsApi.md#project_create) | **POST** /projects | Create a project
+[**project_delete**](ProjectsApi.md#project_delete) | **DELETE** /projects/{id} | Delete a project
+[**project_show**](ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
+[**project_update**](ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
+[**projects_list**](ProjectsApi.md#projects_list) | **GET** /projects | List projects
+
+
+
+## project_create
+
+> project_create(project_create_parameters, opts)
+
+Create a project
+
+Create a new project.
+
+### 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::ProjectsApi.new
+project_create_parameters = Phrase::ProjectCreateParameters.new # ProjectCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a project
+  api_instance.project_create(project_create_parameters, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling ProjectsApi->project_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_create_parameters** | [**ProjectCreateParameters**](ProjectCreateParameters.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
+
+
+## project_delete
+
+> project_delete(id, opts)
+
+Delete a project
+
+Delete an existing project.
+
+### 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::ProjectsApi.new
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Delete a project
+  api_instance.project_delete(id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling ProjectsApi->project_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+
+## project_show
+
+> ProjectDetails project_show(id, opts)
+
+Get a single project
+
+Get details on a single project.
+
+### 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::ProjectsApi.new
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Get a single project
+  result = api_instance.project_show(id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling ProjectsApi->project_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**ProjectDetails**](ProjectDetails.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## project_update
+
+> ProjectDetails project_update(id, project_update_parameters, opts)
+
+Update a project
+
+Update an existing project.
+
+### 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::ProjectsApi.new
+id = 'id_example' # String | ID
+project_update_parameters = Phrase::ProjectUpdateParameters.new # ProjectUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update a project
+  result = api_instance.project_update(id, project_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling ProjectsApi->project_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID | 
+ **project_update_parameters** | [**ProjectUpdateParameters**](ProjectUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**ProjectDetails**](ProjectDetails.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## projects_list
+
+> Array&lt;Project&gt; projects_list(opts)
+
+List projects
+
+List all projects 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'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Phrase::ProjectsApi.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
+}
+
+begin
+  #List projects
+  result = api_instance.projects_list(opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling ProjectsApi->projects_list: #{e}"
+end
+```
+
+### Parameters
+
+
+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] 
+
+### Return type
+
+Response<([**Array&lt;Project&gt;**](Project.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+