phrase 0.4.33 → 1.0.1

data/docs/GlossaryUpdateParameters.md

@@ -0,0 +1,21 @@
+# Phrase::GlossaryUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the glossary | [optional] 
+**project_ids** | **String** | List of project ids the glossary should be assigned to. | [optional] 
+**space_ids** | **Array<String>** | List of space ids the glossary should be assigned to. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::GlossaryUpdateParameters.new(name: My glossary,
+                                 project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+                                 space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"])
+```
+
+

data/docs/Invitation.md

@@ -0,0 +1,35 @@
+# Phrase::Invitation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**role** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**projects** | [**Array<ProjectShort>**](ProjectShort.md) |  | [optional] 
+**locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
+**permissions** | [**Object**](.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**accepted_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Invitation.new(id: null,
+                                 email: null,
+                                 role: null,
+                                 state: null,
+                                 projects: null,
+                                 locales: null,
+                                 permissions: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 accepted_at: null)
+```
+
+

data/docs/InvitationCreateParameters.md

@@ -0,0 +1,25 @@
+# Phrase::InvitationCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email. | [optional] 
+**role** | **String** | Invitiation role, can be any of Manager, Developer, Translator. | [optional] 
+**project_ids** | **String** | List of project ids the invited user has access to. | [optional] 
+**locale_ids** | **String** | List of locale ids the invited user has access to. | [optional] 
+**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::InvitationCreateParameters.new(email: example@mail.com,
+                                 role: Developer,
+                                 project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+                                 locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+                                 permissions: {"create_upload":true,"review_translations":true})
+```
+
+

data/docs/InvitationUpdateParameters.md

@@ -0,0 +1,23 @@
+# Phrase::InvitationUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | Invitiation role, can be any of Manager, Developer, Translator | [optional] 
+**project_ids** | **String** | List of project ids the invited user has access to | [optional] 
+**locale_ids** | **String** | List of locale ids the invited user has access to | [optional] 
+**permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::InvitationUpdateParameters.new(role: Invitiation role,
+                                 project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+                                 locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+                                 permissions: {"create_upload":true})
+```
+
+

data/docs/InvitationsApi.md

@@ -0,0 +1,400 @@
+# Phrase::InvitationsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**invitation_create**](InvitationsApi.md#invitation_create) | **POST** /accounts/{account_id}/invitations | Create a new invitation
+[**invitation_delete**](InvitationsApi.md#invitation_delete) | **DELETE** /accounts/{account_id}/invitations/{id} | Delete an invitation
+[**invitation_resend**](InvitationsApi.md#invitation_resend) | **POST** /accounts/{account_id}/invitations/{id}/resend | Resend an invitation
+[**invitation_show**](InvitationsApi.md#invitation_show) | **GET** /accounts/{account_id}/invitations/{id} | Get a single invitation
+[**invitation_update**](InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
+[**invitations_list**](InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
+
+
+
+## invitation_create
+
+> invitation_create(account_id, invitation_create_parameters, opts)
+
+Create a new invitation
+
+Invite a person to an account. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
+
+### 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::InvitationsApi.new
+account_id = 'account_id_example' # String | Account ID
+invitation_create_parameters = Phrase::InvitationCreateParameters.new # InvitationCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a new invitation
+  api_instance.invitation_create(account_id, invitation_create_parameters, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling InvitationsApi->invitation_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **invitation_create_parameters** | [**InvitationCreateParameters**](InvitationCreateParameters.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
+
+
+## invitation_delete
+
+> invitation_delete(account_id, id, opts)
+
+Delete an invitation
+
+Delete an existing invitation (must not be accepted yet). Access token scope must include <code>team.manage</code>.
+
+### 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::InvitationsApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Delete an invitation
+  api_instance.invitation_delete(account_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling InvitationsApi->invitation_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account 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
+
+
+## invitation_resend
+
+> Invitation invitation_resend(account_id, id, opts)
+
+Resend an invitation
+
+Resend the invitation email (must not be accepted yet). Access token scope must include <code>team.manage</code>.
+
+### 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::InvitationsApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Resend an invitation
+  result = api_instance.invitation_resend(account_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling InvitationsApi->invitation_resend: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Invitation**](Invitation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## invitation_show
+
+> Invitation invitation_show(account_id, id, opts)
+
+Get a single invitation
+
+Get details on a single invitation. Access token scope must include <code>team.manage</code>.
+
+### 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::InvitationsApi.new
+account_id = 'account_id_example' # String | Account ID
+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 invitation
+  result = api_instance.invitation_show(account_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling InvitationsApi->invitation_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Invitation**](Invitation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## invitation_update
+
+> Invitation invitation_update(account_id, id, invitation_update_parameters, opts)
+
+Update an invitation
+
+Update an existing invitation (must not be accepted yet). The <code>email</code> cannot be updated. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
+
+### 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::InvitationsApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+invitation_update_parameters = Phrase::InvitationUpdateParameters.new # InvitationUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update an invitation
+  result = api_instance.invitation_update(account_id, id, invitation_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling InvitationsApi->invitation_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID | 
+ **id** | **String**| ID | 
+ **invitation_update_parameters** | [**InvitationUpdateParameters**](InvitationUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**Invitation**](Invitation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## invitations_list
+
+> Array&lt;Invitation&gt; invitations_list(account_id, opts)
+
+List invitations
+
+List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.
+
+### 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::InvitationsApi.new
+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
+}
+
+begin
+  #List invitations
+  result = api_instance.invitations_list(account_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling InvitationsApi->invitations_list: #{e}"
+end
+```
+
+### Parameters
+
+
+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] 
+
+### Return type
+
+Response<([**Array&lt;Invitation&gt;**](Invitation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+