phrase 0.4.31 → 1.0.3

data/Rakefile

@@ -1,7 +1,10 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+begin
+  require 'rspec/core/rake_task'
 
-task :default => :spec
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Account.md

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

data/docs/AccountDetails.md

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

data/docs/AccountDetails1.md

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

data/docs/AccountsApi.md

@@ -0,0 +1,134 @@
+# Phrase::AccountsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**account_show**](AccountsApi.md#account_show) | **GET** /accounts/{id} | Get a single account
+[**accounts_list**](AccountsApi.md#accounts_list) | **GET** /accounts | List accounts
+
+
+
+## account_show
+
+> AccountDetails account_show(id, opts)
+
+Get a single account
+
+Get details on a single account.
+
+### 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::AccountsApi.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 account
+  result = api_instance.account_show(id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling AccountsApi->account_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<([**AccountDetails**](AccountDetails.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## accounts_list
+
+> Array&lt;Account&gt; accounts_list(opts)
+
+List accounts
+
+List all accounts 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::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: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
+}
+
+begin
+  #List accounts
+  result = api_instance.accounts_list(opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling AccountsApi->accounts_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, 25 by default | [optional] 
+
+### Return type
+
+Response<([**Array&lt;Account&gt;**](Account.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AffectedCount.md

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

data/docs/AffectedResources.md

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

data/docs/Authorization.md

@@ -0,0 +1,31 @@
+# Phrase::Authorization
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**note** | **String** |  | [optional] 
+**token_last_eight** | **String** |  | [optional] 
+**hashed_token** | **String** |  | [optional] 
+**scopes** | **Array<String>** |  | [optional] 
+**expires_at** | **DateTime** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Authorization.new(id: null,
+                                 note: null,
+                                 token_last_eight: null,
+                                 hashed_token: null,
+                                 scopes: null,
+                                 expires_at: null,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

data/docs/AuthorizationCreateParameters.md

@@ -0,0 +1,21 @@
+# Phrase::AuthorizationCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**note** | **String** | A note to help you remember what the access is used for. | [optional] 
+**scopes** | **Array<String>** | A list of scopes that the access can be used for. | [optional] 
+**expires_at** | **DateTime** | Expiration date for the authorization token. Null means no expiration date (default). | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::AuthorizationCreateParameters.new(note: My Deploy Script,
+                                 scopes: ["read","write"],
+                                 expires_at: 2015-03-30T09:52:53Z)
+```
+
+

data/docs/AuthorizationUpdateParameters.md

@@ -0,0 +1,21 @@
+# Phrase::AuthorizationUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**note** | **String** | A note to help you remember what the access is used for. | [optional] 
+**scopes** | **Array<String>** | A list of scopes that the access can be used for. | [optional] 
+**expires_at** | **DateTime** | Expiration date for the authorization token. Null means no expiration date (default). | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::AuthorizationUpdateParameters.new(note: My Deploy Script,
+                                 scopes: ["read","write"],
+                                 expires_at: 2015-03-30T09:52:53Z)
+```
+
+

data/docs/AuthorizationWithToken.md

@@ -0,0 +1,33 @@
+# Phrase::AuthorizationWithToken
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**note** | **String** |  | [optional] 
+**token_last_eight** | **String** |  | [optional] 
+**hashed_token** | **String** |  | [optional] 
+**scopes** | **Array<String>** |  | [optional] 
+**expires_at** | **DateTime** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**token** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::AuthorizationWithToken.new(id: null,
+                                 note: null,
+                                 token_last_eight: null,
+                                 hashed_token: null,
+                                 scopes: null,
+                                 expires_at: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 token: null)
+```
+
+

data/docs/AuthorizationWithToken1.md

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

data/docs/AuthorizationsApi.md

@@ -0,0 +1,321 @@
+# Phrase::AuthorizationsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**authorization_create**](AuthorizationsApi.md#authorization_create) | **POST** /authorizations | Create an authorization
+[**authorization_delete**](AuthorizationsApi.md#authorization_delete) | **DELETE** /authorizations/{id} | Delete an authorization
+[**authorization_show**](AuthorizationsApi.md#authorization_show) | **GET** /authorizations/{id} | Get a single authorization
+[**authorization_update**](AuthorizationsApi.md#authorization_update) | **PATCH** /authorizations/{id} | Update an authorization
+[**authorizations_list**](AuthorizationsApi.md#authorizations_list) | **GET** /authorizations | List authorizations
+
+
+
+## authorization_create
+
+> AuthorizationWithToken authorization_create(authorization_create_parameters, opts)
+
+Create an authorization
+
+Create a new authorization.
+
+### 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::AuthorizationsApi.new
+authorization_create_parameters = Phrase::AuthorizationCreateParameters.new # AuthorizationCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create an authorization
+  result = api_instance.authorization_create(authorization_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling AuthorizationsApi->authorization_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization_create_parameters** | [**AuthorizationCreateParameters**](AuthorizationCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**AuthorizationWithToken**](AuthorizationWithToken.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## authorization_delete
+
+> authorization_delete(id, opts)
+
+Delete an authorization
+
+Delete an existing authorization. API calls using that token will stop working.
+
+### 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::AuthorizationsApi.new
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Delete an authorization
+  api_instance.authorization_delete(id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling AuthorizationsApi->authorization_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
+
+
+## authorization_show
+
+> Authorization authorization_show(id, opts)
+
+Get a single authorization
+
+Get details on a single authorization.
+
+### 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::AuthorizationsApi.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 authorization
+  result = api_instance.authorization_show(id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling AuthorizationsApi->authorization_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<([**Authorization**](Authorization.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## authorization_update
+
+> Authorization authorization_update(id, authorization_update_parameters, opts)
+
+Update an authorization
+
+Update an existing authorization.
+
+### 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::AuthorizationsApi.new
+id = 'id_example' # String | ID
+authorization_update_parameters = Phrase::AuthorizationUpdateParameters.new # AuthorizationUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update an authorization
+  result = api_instance.authorization_update(id, authorization_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling AuthorizationsApi->authorization_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| ID | 
+ **authorization_update_parameters** | [**AuthorizationUpdateParameters**](AuthorizationUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Authorization**](Authorization.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## authorizations_list
+
+> Array&lt;Authorization&gt; authorizations_list(opts)
+
+List authorizations
+
+List all your authorizations.
+
+### 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::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: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
+}
+
+begin
+  #List authorizations
+  result = api_instance.authorizations_list(opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling AuthorizationsApi->authorizations_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, 25 by default | [optional] 
+
+### Return type
+
+Response<([**Array&lt;Authorization&gt;**](Authorization.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+