phrase 0.4.31 → 1.0.3

data/docs/Job.md

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

data/docs/JobCompleteParameters.md

@@ -0,0 +1,17 @@
+# Phrase::JobCompleteParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobCompleteParameters.new(branch: my-feature-branch)
+```
+
+

data/docs/JobCreateParameters.md

@@ -0,0 +1,27 @@
+# Phrase::JobCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**name** | **String** | Job name | [optional] 
+**briefing** | **String** | Briefing for the translators | [optional] 
+**due_date** | **DateTime** | Date the job should be finished | [optional] 
+**tags** | **Array<String>** | tags of keys that should be included within the job | [optional] 
+**translation_key_ids** | **Array<String>** | ids of keys that should be included within the job | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobCreateParameters.new(branch: my-feature-branch,
+                                 name: de,
+                                 briefing: de-DE,
+                                 due_date: null,
+                                 tags: ["myUploadTag"],
+                                 translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+

data/docs/JobDetails.md

@@ -0,0 +1,37 @@
+# Phrase::JobDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**briefing** | **String** |  | [optional] 
+**due_date** | **DateTime** |  | [optional] 
+**state** | **String** |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**owner** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**job_tag_name** | **String** |  | [optional] 
+**locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
+**keys** | [**Array<KeyPreview>**](KeyPreview.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobDetails.new(id: null,
+                                 name: null,
+                                 briefing: null,
+                                 due_date: null,
+                                 state: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 owner: null,
+                                 job_tag_name: null,
+                                 locales: null,
+                                 keys: null)
+```
+
+

data/docs/JobDetails1.md

@@ -0,0 +1,23 @@
+# Phrase::JobDetails1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**owner** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**job_tag_name** | **String** |  | [optional] 
+**locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
+**keys** | [**Array<KeyPreview>**](KeyPreview.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobDetails1.new(owner: null,
+                                 job_tag_name: null,
+                                 locales: null,
+                                 keys: null)
+```
+
+

data/docs/JobKeysCreateParameters.md

@@ -0,0 +1,19 @@
+# Phrase::JobKeysCreateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**translation_key_ids** | **Array<String>** | ids of keys that should added to the job | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobKeysCreateParameters.new(branch: my-feature-branch,
+                                 translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+

data/docs/JobLocale.md

@@ -0,0 +1,23 @@
+# Phrase::JobLocale
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**job** | [**JobPreview**](JobPreview.md) |  | [optional] 
+**locale** | [**LocalePreview**](LocalePreview.md) |  | [optional] 
+**users** | [**Array<UserPreview>**](UserPreview.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocale.new(id: null,
+                                 job: null,
+                                 locale: null,
+                                 users: null)
+```
+
+

data/docs/JobLocaleCompleteParameters.md

@@ -0,0 +1,17 @@
+# Phrase::JobLocaleCompleteParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocaleCompleteParameters.new(branch: my-feature-branch)
+```
+
+

data/docs/JobLocaleReopenParameters.md

@@ -0,0 +1,17 @@
+# Phrase::JobLocaleReopenParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocaleReopenParameters.new(branch: my-feature-branch)
+```
+
+

data/docs/JobLocaleUpdateParameters.md

@@ -0,0 +1,21 @@
+# Phrase::JobLocaleUpdateParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional] 
+**locale_id** | **String** | locale id | [optional] 
+**user_ids** | **Array<String>** | Array of user ids to be assigned to the job locale | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocaleUpdateParameters.new(branch: my-feature-branch,
+                                 locale_id: abcd1234cdef1234abcd1234cdef1234,
+                                 user_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+

data/docs/JobLocalesApi.md

@@ -0,0 +1,483 @@
+# Phrase::JobLocalesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**job_locale_complete**](JobLocalesApi.md#job_locale_complete) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete | Complete a job locale
+[**job_locale_delete**](JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Delete a job locale
+[**job_locale_reopen**](JobLocalesApi.md#job_locale_reopen) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen | Reopen a job locale
+[**job_locale_show**](JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locale/{id} | Get a single job locale
+[**job_locale_update**](JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job locale
+[**job_locales_create**](JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales | Create a job locale
+[**job_locales_list**](JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job locales
+
+
+
+## job_locale_complete
+
+> JobLocale job_locale_complete(project_id, job_id, id, job_locale_complete_parameters, opts)
+
+Complete a job locale
+
+Mark a job locale as completed.
+
+### 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | ID
+job_locale_complete_parameters = Phrase::JobLocaleCompleteParameters.new # JobLocaleCompleteParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Complete a job locale
+  result = api_instance.job_locale_complete(project_id, job_id, id, job_locale_complete_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobLocalesApi->job_locale_complete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| ID | 
+ **job_locale_complete_parameters** | [**JobLocaleCompleteParameters**](JobLocaleCompleteParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**JobLocale**](JobLocale.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_locale_delete
+
+> job_locale_delete(project_id, job_id, id, opts)
+
+Delete a job locale
+
+Delete an existing job locale.
+
+### 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Delete a job locale
+  api_instance.job_locale_delete(project_id, job_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobLocalesApi->job_locale_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [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
+
+
+## job_locale_reopen
+
+> JobLocale job_locale_reopen(project_id, job_id, id, job_locale_reopen_parameters, opts)
+
+Reopen a job locale
+
+Mark a job locale as uncompleted.
+
+### 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | ID
+job_locale_reopen_parameters = Phrase::JobLocaleReopenParameters.new # JobLocaleReopenParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Reopen a job locale
+  result = api_instance.job_locale_reopen(project_id, job_id, id, job_locale_reopen_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobLocalesApi->job_locale_reopen: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| ID | 
+ **job_locale_reopen_parameters** | [**JobLocaleReopenParameters**](JobLocaleReopenParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**JobLocale**](JobLocale.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_locale_show
+
+> JobLocale job_locale_show(project_id, job_id, id, opts)
+
+Get a single job locale
+
+Get a single job locale for a given job.
+
+### 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Get a single job locale
+  result = api_instance.job_locale_show(project_id, job_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobLocalesApi->job_locale_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**JobLocale**](JobLocale.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## job_locale_update
+
+> JobLocale job_locale_update(project_id, job_id, id, job_locale_update_parameters, opts)
+
+Update a job locale
+
+Update an existing job locale.
+
+### 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | ID
+job_locale_update_parameters = Phrase::JobLocaleUpdateParameters.new # JobLocaleUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update a job locale
+  result = api_instance.job_locale_update(project_id, job_id, id, job_locale_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobLocalesApi->job_locale_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| ID | 
+ **job_locale_update_parameters** | [**JobLocaleUpdateParameters**](JobLocaleUpdateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**JobLocale**](JobLocale.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_locales_create
+
+> JobLocale job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
+
+Create a job locale
+
+Create a new job locale.
+
+### 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+job_locales_create_parameters = Phrase::JobLocalesCreateParameters.new # JobLocalesCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a job locale
+  result = api_instance.job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobLocalesApi->job_locales_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **job_locales_create_parameters** | [**JobLocalesCreateParameters**](JobLocalesCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**JobLocale**](JobLocale.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_locales_list
+
+> Array&lt;JobLocale&gt; job_locales_list(project_id, job_id, opts)
+
+List job locales
+
+List all job locales for a given job.
+
+### 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job 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
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #List job locales
+  result = api_instance.job_locales_list(project_id, job_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobLocalesApi->job_locales_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job 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] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<([**Array&lt;JobLocale&gt;**](JobLocale.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+