diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..05a17cb
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,39 @@
+# Generated by: https://openapi-generator.tech
+#
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore
new file mode 100644
index 0000000..7484ee5
--- /dev/null
+++ b/.openapi-generator-ignore
@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
new file mode 100644
index 0000000..8191138
--- /dev/null
+++ b/.openapi-generator/VERSION
@@ -0,0 +1 @@
+4.3.0
\ No newline at end of file
diff --git a/.rspec b/.rspec
new file mode 100644
index 0000000..83e16f8
--- /dev/null
+++ b/.rspec
@@ -0,0 +1,2 @@
+--color
+--require spec_helper
diff --git a/.rubocop.yml b/.rubocop.yml
new file mode 100644
index 0000000..df46058
--- /dev/null
+++ b/.rubocop.yml
@@ -0,0 +1,148 @@
+# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
+# Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
+AllCops:
+ TargetRubyVersion: 2.4
+ # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+ # to ignore them, so only the ones explicitly set in this file are enabled.
+ DisabledByDefault: true
+ Exclude:
+ - '**/templates/**/*'
+ - '**/vendor/**/*'
+ - 'actionpack/lib/action_dispatch/journey/parser.rb'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+ Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+ Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+ Enabled: true
+
+Layout/ElseAlignment:
+ Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+ Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+ Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+ Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+ Enabled: true
+
+Layout/FirstArgumentIndentation:
+ Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+ Enabled: false
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+ Enabled: true
+ EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+ Enabled: true
+
+Layout/LeadingCommentSpace:
+ Enabled: true
+
+Layout/SpaceAfterColon:
+ Enabled: true
+
+Layout/SpaceAfterComma:
+ Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+ Enabled: true
+
+Layout/SpaceAroundKeyword:
+ Enabled: true
+
+Layout/SpaceAroundOperators:
+ Enabled: true
+
+Layout/SpaceBeforeComma:
+ Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+ Enabled: true
+
+Style/DefWithParentheses:
+ Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+ Enabled: true
+
+Style/FrozenStringLiteralComment:
+ Enabled: false
+ EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+ Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+ Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+ Enabled: true
+
+Layout/SpaceInsideParens:
+ Enabled: true
+
+# Check quotes usage according to lint rule below.
+#Style/StringLiterals:
+# Enabled: true
+# EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+ Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+ Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+ Enabled: false
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+ Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+ Enabled: true
+ EnforcedStyleAlignWith: variable
+ AutoCorrect: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+ Enabled: true
+
+Style/RedundantReturn:
+ Enabled: true
+ AllowMultipleReturnValues: true
+
+Style/Semicolon:
+ Enabled: true
+ AllowAsExpressionSeparator: true
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..20469e3
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+ - 2.3
+ - 2.4
+ - 2.5
+script:
+ - bundle install --path vendor/bundle
+ - bundle exec rspec
+ - gem build Phrase.gemspec
+ - gem install ./Phrase-1.0.0.gem
diff --git a/Gemfile b/Gemfile
new file mode 100644
index 0000000..c2e3127
--- /dev/null
+++ b/Gemfile
@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+ gem 'rake', '~> 13.0.1'
+ gem 'pry-byebug'
+ gem 'rubocop', '~> 0.66.0'
+end
diff --git a/Phrase.gemspec b/Phrase.gemspec
new file mode 100644
index 0000000..884910f
--- /dev/null
+++ b/Phrase.gemspec
@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require "Phrase/version"
+
+Gem::Specification.new do |s|
+ s.name = "Phrase"
+ s.version = Phrase::VERSION
+ s.platform = Gem::Platform::RUBY
+ s.authors = ["Phrase"]
+ s.email = ["support@phrase.com"]
+ s.homepage = "https://developers.phrase.com/api/"
+ s.summary = "You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase for your account."
+ s.description = "Phrase is a translation management platform for software projects."
+ s.license = 'MIT'
+ s.required_ruby_version = ">= 1.9"
+
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+ s.add_runtime_dependency 'link-header-parser'
+
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+ s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+ s.test_files = `find spec/*`.split("\n")
+ s.executables = []
+ s.require_paths = ["lib"]
+end
diff --git a/README.md b/README.md
index e96941f..d28454b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,775 @@
-# phrase-ruby
\ No newline at end of file
+# Phrase
+
+Phrase - the Ruby gem for the Phrase API Reference
+
+Phrase is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase for your account.
+
+## API Endpoint
+
+
+
+
https://api.phrase.com/v2/
+
+
https://api.phrase.com/, and the current version is v2 which results in the base URL for all requests: https://api.phrase.com/v2/.
+
+
+## Usage
+
+[curl](http://curl.haxx.se/) is used primarily to send requests to Phrase in the examples. On most you'll find a second variant using the [Phrase API v2 client](https://phrase.com/cli/) that might be more convenient to handle. For further information check its [documentation](https://help.phrase.com/help/phrase-in-your-terminal).
+
+
+## Use of HTTP Verbs
+
+Phrase API v2 tries to use the appropriate HTTP verb for accessing each endpoint according to REST specification where possible:
+
+
+
+
+
+ Verb
+ Description
+
+
+
+
+ GET
+ Retrieve one or multiple resources
+
+
+ POST
+ Create a resource
+
+
+ PUT
+ Update a resource
+
+
+ PATCH
+ Update a resource (partially)
+
+
+ DELETE
+ Delete a resource
+
+
+
+
User-Agent: Frederiks Mobile App (frederik@phrase.com)
+User-Agent: ACME Inc Python Client (http://example.com/contact)$ curl -u EMAIL_OR_ACCESS_TOKEN \"https://api.phrase.com/v2/projects?page=2\"$ curl -H 'Content-Type: application/json' -d '{\"name\":\"My new project\"}' -u EMAIL_OR_ACCESS_TOKEN https://api.phrase.com/v2/projects{
+ \"message\": \"JSON could not be parsed\"
+}{
+ \"message\": \"Validation Failed\",
+ \"errors\": [
+ {
+ \"resource\": \"Project\",
+ \"field\": \"name\",
+ \"message\": \"can't be blank\"
+ }
+ ]
+}YYYY-MM-DDTHH:MM:SSZYYYY-MM-DDTHH:MM:SS±hh:mm2015-03-31T13:00+01:00$ curl -u username:password \"https://api.phrase.com/v2/projects\"$ curl -u ACCESS_TOKEN: \"https://api.phrase.com/v2/projects\"$ curl -H \"Authorization: token ACCESS_TOKEN\" https://api.phrase.com/v2/projectsAPI v2 Authentication Guide .
+
+#### Send via parameter
+
+As JSONP (and other) requests cannot send HTTP Basic Auth credentials, a special query parameter `access_token` can be used:
+
+curl \"https://api.phrase.com/v2/projects?access_token=ACCESS_TOKEN\"X-PhraseApp-OTP: required; appcurl -H \"X-PhraseApp-OTP: MFA-TOKEN\" -u EMAIL https://api.phrase.com/v2/projectsTranslation Center by switching to the desired account and then visiting the account details page. If required, you can specify the account just like a normal parameter within the request.
+
+## Pagination
+
+Endpoints that return a list or resources will usually return paginated results and include 25 items by default. To access further pages, use the `page` parameter:
+
+$ curl -u EMAIL_OR_ACCESS_TOKEN \"https://api.phrase.com/v2/projects?page=2\"$ curl -u EMAIL_OR_ACCESS_TOKEN \"https://api.phrase.com/v2/projects?page=2&per_page=50\"Link: ; rel=\"first\", ; rel=\"prev\", ; rel=\"next\", ; rel=\"last\"
+
+
+
+ Value
+ Description
+
+
+
+
+ next
+ URL of the next page of results
+
+
+ last
+ URL of the last page of results
+
+
+ first
+ URL of the first page of results
+
+
+ prev
+ URL of the previous page of results
+
+
+
+
+
+
+
+ Header
+ Description
+
+
+
+
+ X-Rate-Limit-LimitNumber of max requests allowed in the current time period
+
+
+ X-Rate-Limit-RemainingNumber of remaining requests in the current time period
+
+
+ X-Rate-Limit-ResetTimestamp of end of current time period as UNIX timestamp
+
+
+
+
$ curl -i -u EMAIL_OR_ACCESS_TOKEN \"https://api.phrase.com/v2/projects/1234abcd1234abcdefefabcd1234efab/locales/en/download\"
+HTTP/1.1 200 OK
+ETag: \"abcd1234abcdefefabcd1234efab1234\"
+Last-Modified: Wed, 28 Jan 2015 15:31:30 UTC
+Status: 200 OK
+
+$ curl -i -u EMAIL_OR_ACCESS_TOKEN \"https://api.phrase.com/v2/projects/1234abcd1234abcdefefabcd1234efab/locales/en/download\" -H 'If-None-Match: \"abcd1234abcdefefabcd1234efab1234\"'
+HTTP/1.1 304 Not Modified
+ETag: \"abcd1234abcdefefabcd1234efab1234\"
+Last-Modified: Wed, 28 Jan 2015 15:31:30 UTC
+Status: 304 Not Modified
+
+$ curl -i -u EMAIL_OR_ACCESS_TOKEN \"https://api.phrase.com/v2/projects/1234abcd1234abcdefefabcd1234efab/locales/en/download\" -H \"If-Modified-Since: Wed, 28 Jan 2015 15:31:30 UTC\"
+HTTP/1.1 304 Not Modified
+Last-Modified: Wed, 28 Jan 2015 15:31:30 UTC
+Status: 304 Not Modified$ curl \"https://api.phrase.com/v2/projects?callback=myFunction\"myFunction({
+ {
+ \"meta\": {
+ \"status\": 200,
+ ...
+ },
+ \"data\": [
+ {
+ \"id\": \"1234abcd1234abc1234abcd1234abc\"
+ ...
+ }
+ ]
+ }
+});$ curl \"https://api.phrase.com/v2/projects?callback=myFunction&access_token=ACCESS-TOKEN\"project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
+
+### 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 = Phrase::InvitationCreate.new # InvitationCreate |
+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, 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** | [**InvitationCreate**](InvitationCreate.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 team.manage.
+
+### 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
+
+> Object invitation_resend(account_id, id, opts)
+
+Resend an invitation
+
+Resend the invitation email (must not be accepted yet). Access token scope must include team.manage.
+
+### 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<(**Object**)>
+
+### 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 team.manage.
+
+### 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
+
+> Object invitation_update(account_id, id, invitation_update, opts)
+
+Update an invitation
+
+Update an existing invitation (must not be accepted yet). The email cannot be updated. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
+
+### 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 = Phrase::InvitationUpdate.new # InvitationUpdate |
+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, 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** | [**InvitationUpdate**](InvitationUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## invitations_list
+
+> Array<Object> 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 team.manage.
+
+### 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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/Job.md b/docs/Job.md
new file mode 100644
index 0000000..52fa11f
--- /dev/null
+++ b/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)
+```
+
+
diff --git a/docs/JobComplete.md b/docs/JobComplete.md
new file mode 100644
index 0000000..f23f597
--- /dev/null
+++ b/docs/JobComplete.md
@@ -0,0 +1,17 @@
+# Phrase::JobComplete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobComplete.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobCreate.md b/docs/JobCreate.md
new file mode 100644
index 0000000..fbe10d2
--- /dev/null
+++ b/docs/JobCreate.md
@@ -0,0 +1,27 @@
+# Phrase::JobCreate
+
+## 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** | **String** | Date the job should be finished | [optional]
+**tags** | **String** | tags of keys that should be included within the job | [optional]
+**translation_key_ids** | **String** | ids of keys that should be included within the job | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobCreate.new(branch: my-feature-branch,
+ name: de,
+ briefing: de-DE,
+ due_date: 2017-08-15,
+ tags: ["myUploadTag"],
+ translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+
diff --git a/docs/JobDelete.md b/docs/JobDelete.md
new file mode 100644
index 0000000..5e49815
--- /dev/null
+++ b/docs/JobDelete.md
@@ -0,0 +1,17 @@
+# Phrase::JobDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobDelete.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobKeysCreate.md b/docs/JobKeysCreate.md
new file mode 100644
index 0000000..119bf0e
--- /dev/null
+++ b/docs/JobKeysCreate.md
@@ -0,0 +1,19 @@
+# Phrase::JobKeysCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**translation_key_ids** | **String** | ids of keys that should added to the job | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobKeysCreate.new(branch: my-feature-branch,
+ translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+
diff --git a/docs/JobKeysDelete.md b/docs/JobKeysDelete.md
new file mode 100644
index 0000000..8022803
--- /dev/null
+++ b/docs/JobKeysDelete.md
@@ -0,0 +1,19 @@
+# Phrase::JobKeysDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**translation_key_ids** | **String** | ids of keys that should added to the job | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobKeysDelete.new(branch: my-feature-branch,
+ translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+
diff --git a/docs/JobLocale.md b/docs/JobLocale.md
new file mode 100644
index 0000000..920e6ae
--- /dev/null
+++ b/docs/JobLocale.md
@@ -0,0 +1,23 @@
+# Phrase::JobLocale
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**job** | [**JobPreview**](JobPreview.md) | | [optional]
+**locale** | **Object** | | [optional]
+**users** | **Array<Object>** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocale.new(id: null,
+ job: null,
+ locale: null,
+ users: null)
+```
+
+
diff --git a/docs/JobLocaleComplete.md b/docs/JobLocaleComplete.md
new file mode 100644
index 0000000..d28a12c
--- /dev/null
+++ b/docs/JobLocaleComplete.md
@@ -0,0 +1,17 @@
+# Phrase::JobLocaleComplete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocaleComplete.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobLocaleDelete.md b/docs/JobLocaleDelete.md
new file mode 100644
index 0000000..0056d19
--- /dev/null
+++ b/docs/JobLocaleDelete.md
@@ -0,0 +1,17 @@
+# Phrase::JobLocaleDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocaleDelete.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobLocaleReopen.md b/docs/JobLocaleReopen.md
new file mode 100644
index 0000000..7375b8c
--- /dev/null
+++ b/docs/JobLocaleReopen.md
@@ -0,0 +1,17 @@
+# Phrase::JobLocaleReopen
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocaleReopen.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobLocaleShow.md b/docs/JobLocaleShow.md
new file mode 100644
index 0000000..ddd205d
--- /dev/null
+++ b/docs/JobLocaleShow.md
@@ -0,0 +1,17 @@
+# Phrase::JobLocaleShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocaleShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobLocaleUpdate.md b/docs/JobLocaleUpdate.md
new file mode 100644
index 0000000..28a85d9
--- /dev/null
+++ b/docs/JobLocaleUpdate.md
@@ -0,0 +1,21 @@
+# Phrase::JobLocaleUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**locale_id** | **String** | locale id | [optional]
+**user_ids** | **String** | Array of user ids to be assigned to the job locale | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocaleUpdate.new(branch: my-feature-branch,
+ locale_id: abcd1234cdef1234abcd1234cdef1234,
+ user_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+
diff --git a/docs/JobLocalesApi.md b/docs/JobLocalesApi.md
new file mode 100644
index 0000000..0d180d9
--- /dev/null
+++ b/docs/JobLocalesApi.md
@@ -0,0 +1,489 @@
+# 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
+
+> Object job_locale_complete(project_id, job_id, id, job_locale_complete, 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'
+ # 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::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 = Phrase::JobLocaleComplete.new # JobLocaleComplete |
+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, 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** | [**JobLocaleComplete**](JobLocaleComplete.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### 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, job_locale_delete, 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'
+ # 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::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_delete = Phrase::JobLocaleDelete.new # JobLocaleDelete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Delete a job locale
+ api_instance.job_locale_delete(project_id, job_id, id, job_locale_delete, 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 |
+ **job_locale_delete** | [**JobLocaleDelete**](JobLocaleDelete.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
+
+
+## job_locale_reopen
+
+> Object job_locale_reopen(project_id, job_id, id, job_locale_reopen, 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'
+ # 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::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 = Phrase::JobLocaleReopen.new # JobLocaleReopen |
+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, 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** | [**JobLocaleReopen**](JobLocaleReopen.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### 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, job_locale_show, 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'
+ # 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::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_show = Phrase::JobLocaleShow.new # JobLocaleShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Get a single job locale
+ result = api_instance.job_locale_show(project_id, job_id, id, job_locale_show, 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 |
+ **job_locale_show** | [**JobLocaleShow**](JobLocaleShow.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_update
+
+> Object job_locale_update(project_id, job_id, id, job_locale_update, 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'
+ # 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::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 = Phrase::JobLocaleUpdate.new # JobLocaleUpdate |
+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, 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** | [**JobLocaleUpdate**](JobLocaleUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_locales_create
+
+> job_locales_create(project_id, job_id, job_locales_create, 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'
+ # 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+job_locales_create = Phrase::JobLocalesCreate.new # JobLocalesCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a job locale
+ api_instance.job_locales_create(project_id, job_id, job_locales_create, opts)
+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** | [**JobLocalesCreate**](JobLocalesCreate.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
+
+
+## job_locales_list
+
+> Array<Object> job_locales_list(project_id, job_id, job_locales_list, 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'
+ # 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::JobLocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+job_locales_list = Phrase::JobLocalesList.new # JobLocalesList |
+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 job locales
+ result = api_instance.job_locales_list(project_id, job_id, job_locales_list, 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 |
+ **job_locales_list** | [**JobLocalesList**](JobLocalesList.md)| |
+ **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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/JobLocalesCreate.md b/docs/JobLocalesCreate.md
new file mode 100644
index 0000000..6bf8a20
--- /dev/null
+++ b/docs/JobLocalesCreate.md
@@ -0,0 +1,21 @@
+# Phrase::JobLocalesCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**locale_id** | **String** | locale id | [optional]
+**user_ids** | **String** | Array of user ids to be assigned to the job locale | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocalesCreate.new(branch: my-feature-branch,
+ locale_id: abcd1234cdef1234abcd1234cdef1234,
+ user_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+```
+
+
diff --git a/docs/JobLocalesList.md b/docs/JobLocalesList.md
new file mode 100644
index 0000000..132a2de
--- /dev/null
+++ b/docs/JobLocalesList.md
@@ -0,0 +1,17 @@
+# Phrase::JobLocalesList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobLocalesList.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobPreview.md b/docs/JobPreview.md
new file mode 100644
index 0000000..82b8cf7
--- /dev/null
+++ b/docs/JobPreview.md
@@ -0,0 +1,21 @@
+# Phrase::JobPreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**name** | **String** | | [optional]
+**state** | **String** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobPreview.new(id: null,
+ name: null,
+ state: null)
+```
+
+
diff --git a/docs/JobReopen.md b/docs/JobReopen.md
new file mode 100644
index 0000000..d30605e
--- /dev/null
+++ b/docs/JobReopen.md
@@ -0,0 +1,17 @@
+# Phrase::JobReopen
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobReopen.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobShow.md b/docs/JobShow.md
new file mode 100644
index 0000000..ac78864
--- /dev/null
+++ b/docs/JobShow.md
@@ -0,0 +1,17 @@
+# Phrase::JobShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobStart.md b/docs/JobStart.md
new file mode 100644
index 0000000..76562ea
--- /dev/null
+++ b/docs/JobStart.md
@@ -0,0 +1,17 @@
+# Phrase::JobStart
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobStart.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/JobUpdate.md b/docs/JobUpdate.md
new file mode 100644
index 0000000..3d72931
--- /dev/null
+++ b/docs/JobUpdate.md
@@ -0,0 +1,23 @@
+# Phrase::JobUpdate
+
+## 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** | **String** | Date the job should be finished | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobUpdate.new(branch: my-feature-branch,
+ name: de,
+ briefing: de-DE,
+ due_date: 2017-08-15)
+```
+
+
diff --git a/docs/JobsApi.md b/docs/JobsApi.md
new file mode 100644
index 0000000..8a6cd4a
--- /dev/null
+++ b/docs/JobsApi.md
@@ -0,0 +1,675 @@
+# Phrase::JobsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**job_complete**](JobsApi.md#job_complete) | **POST** /projects/{project_id}/jobs/{id}/complete | Complete a job
+[**job_create**](JobsApi.md#job_create) | **POST** /projects/{project_id}/jobs | Create a job
+[**job_delete**](JobsApi.md#job_delete) | **DELETE** /projects/{project_id}/jobs/{id} | Delete a job
+[**job_keys_create**](JobsApi.md#job_keys_create) | **POST** /projects/{project_id}/jobs/{id}/keys | Add keys to job
+[**job_keys_delete**](JobsApi.md#job_keys_delete) | **DELETE** /projects/{project_id}/jobs/{id}/keys | Remove keys from job
+[**job_reopen**](JobsApi.md#job_reopen) | **POST** /projects/{project_id}/jobs/{id}/reopen | Reopen a job
+[**job_show**](JobsApi.md#job_show) | **GET** /projects/{project_id}/jobs/{id} | Get a single job
+[**job_start**](JobsApi.md#job_start) | **POST** /projects/{project_id}/jobs/{id}/start | Start a job
+[**job_update**](JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
+[**jobs_list**](JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
+
+
+
+## job_complete
+
+> Object job_complete(project_id, id, job_complete, opts)
+
+Complete a job
+
+Mark a job 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'
+ # 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+job_complete = Phrase::JobComplete.new # JobComplete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Complete a job
+ result = api_instance.job_complete(project_id, id, job_complete, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_complete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **job_complete** | [**JobComplete**](JobComplete.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_create
+
+> job_create(project_id, job_create, opts)
+
+Create a job
+
+Create a new 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'
+ # 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_create = Phrase::JobCreate.new # JobCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a job
+ api_instance.job_create(project_id, job_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **job_create** | [**JobCreate**](JobCreate.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
+
+
+## job_delete
+
+> job_delete(project_id, id, job_delete, opts)
+
+Delete a job
+
+Delete an existing 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'
+ # 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+job_delete = Phrase::JobDelete.new # JobDelete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Delete a job
+ api_instance.job_delete(project_id, id, job_delete, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **job_delete** | [**JobDelete**](JobDelete.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
+
+
+## job_keys_create
+
+> Object job_keys_create(project_id, id, job_keys_create, opts)
+
+Add keys to job
+
+Add multiple keys to a existing 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'
+ # 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+job_keys_create = Phrase::JobKeysCreate.new # JobKeysCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Add keys to job
+ result = api_instance.job_keys_create(project_id, id, job_keys_create, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_keys_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **job_keys_create** | [**JobKeysCreate**](JobKeysCreate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_keys_delete
+
+> job_keys_delete(project_id, id, job_keys_delete, opts)
+
+Remove keys from job
+
+Remove multiple keys from existing 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'
+ # 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+job_keys_delete = Phrase::JobKeysDelete.new # JobKeysDelete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Remove keys from job
+ api_instance.job_keys_delete(project_id, id, job_keys_delete, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_keys_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **job_keys_delete** | [**JobKeysDelete**](JobKeysDelete.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
+
+
+## job_reopen
+
+> Object job_reopen(project_id, id, job_reopen, opts)
+
+Reopen a job
+
+Mark a job 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'
+ # 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+job_reopen = Phrase::JobReopen.new # JobReopen |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Reopen a job
+ result = api_instance.job_reopen(project_id, id, job_reopen, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_reopen: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **job_reopen** | [**JobReopen**](JobReopen.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_show
+
+> Object job_show(project_id, id, job_show, opts)
+
+Get a single job
+
+Get details on a single job for a given 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+job_show = Phrase::JobShow.new # JobShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Get a single job
+ result = api_instance.job_show(project_id, id, job_show, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **job_show** | [**JobShow**](JobShow.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_start
+
+> Object job_start(project_id, id, job_start, opts)
+
+Start a job
+
+Starts an existing job in state draft.
+
+### 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+job_start = Phrase::JobStart.new # JobStart |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Start a job
+ result = api_instance.job_start(project_id, id, job_start, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_start: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **job_start** | [**JobStart**](JobStart.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_update
+
+> Object job_update(project_id, id, job_update, opts)
+
+Update a job
+
+Update an existing 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'
+ # 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+job_update = Phrase::JobUpdate.new # JobUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a job
+ result = api_instance.job_update(project_id, id, job_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->job_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **job_update** | [**JobUpdate**](JobUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## jobs_list
+
+> Array<Job> jobs_list(project_id, jobs_list, opts)
+
+List jobs
+
+List all jobs for the given 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::JobsApi.new
+project_id = 'project_id_example' # String | Project ID
+jobs_list = Phrase::JobsList.new # JobsList |
+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 jobs
+ result = api_instance.jobs_list(project_id, jobs_list, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling JobsApi->jobs_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **jobs_list** | [**JobsList**](JobsList.md)| |
+ **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<Job>**](Job.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/JobsList.md b/docs/JobsList.md
new file mode 100644
index 0000000..f3f11ee
--- /dev/null
+++ b/docs/JobsList.md
@@ -0,0 +1,23 @@
+# Phrase::JobsList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**owned_by** | **String** | filter by user owning job | [optional]
+**assigned_to** | **String** | filter by user assigned to job | [optional]
+**state** | **String** | filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code> | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobsList.new(branch: my-feature-branch,
+ owned_by: abcd1234cdef1234abcd1234cdef1234,
+ assigned_to: abcd1234cdef1234abcd1234cdef1234,
+ state: completed)
+```
+
+
diff --git a/docs/KeyCreate.md b/docs/KeyCreate.md
new file mode 100644
index 0000000..1333087
--- /dev/null
+++ b/docs/KeyCreate.md
@@ -0,0 +1,45 @@
+# Phrase::KeyCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**name** | **String** | Key name | [optional]
+**description** | **String** | Key description (usually includes contextual information for translators) | [optional]
+**plural** | **String** | Indicates whether key supports pluralization | [optional]
+**name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional]
+**data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional]
+**tags** | **String** | List of tags separated by comma to be associated with the key. | [optional]
+**max_characters_allowed** | **String** | Max. number of characters translations for this key can have. | [optional]
+**screenshot** | **String** | Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
+**remove_screenshot** | **String** | Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
+**unformatted** | **String** | Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats. | [optional]
+**xml_space_preserve** | **String** | Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats. | [optional]
+**original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
+**localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
+**localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeyCreate.new(branch: my-feature-branch,
+ name: home.index.headline,
+ description: Some description worth knowing...,
+ plural: null,
+ name_plural: home.index.headlines,
+ data_type: number,
+ tags: awesome-feature,needs-proofreading,
+ max_characters_allowed: 140,
+ screenshot: /path/to/my/screenshot.png,
+ remove_screenshot: null,
+ unformatted: null,
+ xml_space_preserve: null,
+ original_file: null,
+ localized_format_string: null,
+ localized_format_key: null)
+```
+
+
diff --git a/docs/KeyDelete.md b/docs/KeyDelete.md
new file mode 100644
index 0000000..525f41f
--- /dev/null
+++ b/docs/KeyDelete.md
@@ -0,0 +1,17 @@
+# Phrase::KeyDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeyDelete.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/KeyPreview.md b/docs/KeyPreview.md
new file mode 100644
index 0000000..dd67d9f
--- /dev/null
+++ b/docs/KeyPreview.md
@@ -0,0 +1,21 @@
+# Phrase::KeyPreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**name** | **String** | | [optional]
+**plural** | **Boolean** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeyPreview.new(id: null,
+ name: null,
+ plural: null)
+```
+
+
diff --git a/docs/KeyShow.md b/docs/KeyShow.md
new file mode 100644
index 0000000..d3ffbef
--- /dev/null
+++ b/docs/KeyShow.md
@@ -0,0 +1,17 @@
+# Phrase::KeyShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeyShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/KeyUpdate.md b/docs/KeyUpdate.md
new file mode 100644
index 0000000..0d78d12
--- /dev/null
+++ b/docs/KeyUpdate.md
@@ -0,0 +1,45 @@
+# Phrase::KeyUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**name** | **String** | Key name | [optional]
+**description** | **String** | Key description (usually includes contextual information for translators) | [optional]
+**plural** | **String** | Indicates whether key supports pluralization | [optional]
+**name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional]
+**data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional]
+**tags** | **String** | List of tags separated by comma to be associated with the key. | [optional]
+**max_characters_allowed** | **String** | Max. number of characters translations for this key can have. | [optional]
+**screenshot** | **String** | Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
+**remove_screenshot** | **String** | Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
+**unformatted** | **String** | Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats. | [optional]
+**xml_space_preserve** | **String** | Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats. | [optional]
+**original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
+**localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
+**localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeyUpdate.new(branch: my-feature-branch,
+ name: home.index.headline,
+ description: Some description worth knowing...,
+ plural: null,
+ name_plural: home.index.headlines,
+ data_type: number,
+ tags: awesome-feature,needs-proofreading,
+ max_characters_allowed: 140,
+ screenshot: /path/to/my/screenshot.png,
+ remove_screenshot: null,
+ unformatted: null,
+ xml_space_preserve: null,
+ original_file: null,
+ localized_format_string: null,
+ localized_format_key: null)
+```
+
+
diff --git a/docs/KeysApi.md b/docs/KeysApi.md
new file mode 100644
index 0000000..84759ae
--- /dev/null
+++ b/docs/KeysApi.md
@@ -0,0 +1,605 @@
+# Phrase::KeysApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**key_create**](KeysApi.md#key_create) | **POST** /projects/{project_id}/keys | Create a key
+[**key_delete**](KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
+[**key_show**](KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
+[**key_update**](KeysApi.md#key_update) | **PATCH** /projects/{project_id}/keys/{id} | Update a key
+[**keys_delete**](KeysApi.md#keys_delete) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
+[**keys_list**](KeysApi.md#keys_list) | **GET** /projects/{project_id}/keys | List keys
+[**keys_search**](KeysApi.md#keys_search) | **POST** /projects/{project_id}/keys/search | Search keys
+[**keys_tag**](KeysApi.md#keys_tag) | **PATCH** /projects/{project_id}/keys/tag | Add tags to collection of keys
+[**keys_untag**](KeysApi.md#keys_untag) | **PATCH** /projects/{project_id}/keys/untag | Remove tags from collection of keys
+
+
+
+## key_create
+
+> key_create(project_id, key_create, opts)
+
+Create a key
+
+Create a new key.
+
+### 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+key_create = Phrase::KeyCreate.new # KeyCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a key
+ api_instance.key_create(project_id, key_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->key_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **key_create** | [**KeyCreate**](KeyCreate.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
+
+
+## key_delete
+
+> key_delete(project_id, id, key_delete, opts)
+
+Delete a key
+
+Delete an existing key.
+
+### 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+key_delete = Phrase::KeyDelete.new # KeyDelete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Delete a key
+ api_instance.key_delete(project_id, id, key_delete, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->key_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **key_delete** | [**KeyDelete**](KeyDelete.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
+
+
+## key_show
+
+> Object key_show(project_id, id, key_show, opts)
+
+Get a single key
+
+Get details on a single key for a given 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+key_show = Phrase::KeyShow.new # KeyShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Get a single key
+ result = api_instance.key_show(project_id, id, key_show, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->key_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **key_show** | [**KeyShow**](KeyShow.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## key_update
+
+> Object key_update(project_id, id, key_update, opts)
+
+Update a key
+
+Update an existing key.
+
+### 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+key_update = Phrase::KeyUpdate.new # KeyUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a key
+ result = api_instance.key_update(project_id, id, key_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->key_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **key_update** | [**KeyUpdate**](KeyUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## keys_delete
+
+> AffectedResources keys_delete(project_id, keys_delete, opts)
+
+Delete collection of keys
+
+Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
+
+### 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+keys_delete = Phrase::KeysDelete.new # KeysDelete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Delete collection of keys
+ result = api_instance.keys_delete(project_id, keys_delete, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->keys_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **keys_delete** | [**KeysDelete**](KeysDelete.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<([**AffectedResources**](AffectedResources.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## keys_list
+
+> Array<TranslationKey> keys_list(project_id, keys_list, opts)
+
+List keys
+
+List all keys for the given project. Alternatively you can POST requests to /search.
+
+### 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+keys_list = Phrase::KeysList.new # KeysList |
+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 keys
+ result = api_instance.keys_list(project_id, keys_list, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->keys_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **keys_list** | [**KeysList**](KeysList.md)| |
+ **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<TranslationKey>**](TranslationKey.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## keys_search
+
+> Array<Object> keys_search(project_id, keys_search, opts)
+
+Search keys
+
+Search keys for the given project matching query.
+
+### 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+keys_search = Phrase::KeysSearch.new # KeysSearch |
+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
+ #Search keys
+ result = api_instance.keys_search(project_id, keys_search, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->keys_search: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **keys_search** | [**KeysSearch**](KeysSearch.md)| |
+ **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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## keys_tag
+
+> Object keys_tag(project_id, keys_tag, opts)
+
+Add tags to collection of keys
+
+Tags all keys matching query. Same constraints as list.
+
+### 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+keys_tag = Phrase::KeysTag.new # KeysTag |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Add tags to collection of keys
+ result = api_instance.keys_tag(project_id, keys_tag, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->keys_tag: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **keys_tag** | [**KeysTag**](KeysTag.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## keys_untag
+
+> Object keys_untag(project_id, keys_untag, opts)
+
+Remove tags from collection of keys
+
+Removes specified tags from keys matching query.
+
+### 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::KeysApi.new
+project_id = 'project_id_example' # String | Project ID
+keys_untag = Phrase::KeysUntag.new # KeysUntag |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Remove tags from collection of keys
+ result = api_instance.keys_untag(project_id, keys_untag, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling KeysApi->keys_untag: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **keys_untag** | [**KeysUntag**](KeysUntag.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/KeysDelete.md b/docs/KeysDelete.md
new file mode 100644
index 0000000..2ada9fe
--- /dev/null
+++ b/docs/KeysDelete.md
@@ -0,0 +1,21 @@
+# Phrase::KeysDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysDelete.new(branch: my-feature-branch,
+ q: mykey* translated:true,
+ locale_id: abcd1234abcd1234abcd1234abcd1234)
+```
+
+
diff --git a/docs/KeysList.md b/docs/KeysList.md
new file mode 100644
index 0000000..5d76e5e
--- /dev/null
+++ b/docs/KeysList.md
@@ -0,0 +1,25 @@
+# Phrase::KeysList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysList.new(branch: my-feature-branch,
+ sort: updated_at,
+ order: desc,
+ q: mykey* translated:true,
+ locale_id: abcd1234abcd1234abcd1234abcd1234)
+```
+
+
diff --git a/docs/KeysSearch.md b/docs/KeysSearch.md
new file mode 100644
index 0000000..2638d30
--- /dev/null
+++ b/docs/KeysSearch.md
@@ -0,0 +1,25 @@
+# Phrase::KeysSearch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysSearch.new(branch: my-feature-branch,
+ sort: updated_at,
+ order: desc,
+ q: mykey* translated:true,
+ locale_id: abcd1234abcd1234abcd1234abcd1234)
+```
+
+
diff --git a/docs/KeysTag.md b/docs/KeysTag.md
new file mode 100644
index 0000000..4149e7b
--- /dev/null
+++ b/docs/KeysTag.md
@@ -0,0 +1,23 @@
+# Phrase::KeysTag
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
+**tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysTag.new(branch: my-feature-branch,
+ q: mykey* translated:true,
+ locale_id: abcd1234abcd1234abcd1234abcd1234,
+ tags: landing-page,release-1.2)
+```
+
+
diff --git a/docs/KeysUntag.md b/docs/KeysUntag.md
new file mode 100644
index 0000000..25b6fb1
--- /dev/null
+++ b/docs/KeysUntag.md
@@ -0,0 +1,23 @@
+# Phrase::KeysUntag
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
+**tags** | **String** | Tag or comma-separated list of tags to remove from the matching collection of keys | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::KeysUntag.new(branch: my-feature-branch,
+ q: mykey* translated:true,
+ locale_id: abcd1234abcd1234abcd1234abcd1234,
+ tags: landing-page,release-1.2)
+```
+
+
diff --git a/docs/Locale.md b/docs/Locale.md
new file mode 100644
index 0000000..728d5b6
--- /dev/null
+++ b/docs/Locale.md
@@ -0,0 +1,35 @@
+# Phrase::Locale
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**name** | **String** | | [optional]
+**code** | **String** | | [optional]
+**default** | **Boolean** | | [optional]
+**main** | **Boolean** | | [optional]
+**rtl** | **Boolean** | | [optional]
+**plural_forms** | **Array<String>** | | [optional]
+**source_locale** | **Object** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Locale.new(id: null,
+ name: null,
+ code: null,
+ default: null,
+ main: null,
+ rtl: null,
+ plural_forms: null,
+ source_locale: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/LocaleCreate.md b/docs/LocaleCreate.md
new file mode 100644
index 0000000..54182df
--- /dev/null
+++ b/docs/LocaleCreate.md
@@ -0,0 +1,35 @@
+# Phrase::LocaleCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**name** | **String** | Locale name | [optional]
+**code** | **String** | Locale ISO code | [optional]
+**default** | **String** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
+**main** | **String** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Verification System</a> feature. | [optional]
+**rtl** | **String** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional]
+**source_locale_id** | **String** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional]
+**unverify_new_translations** | **String** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
+**unverify_updated_translations** | **String** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
+**autotranslate** | **String** | If set, translations for this locale will be fetched automatically, right after creation. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleCreate.new(branch: my-feature-branch,
+ name: de,
+ code: de-DE,
+ default: null,
+ main: null,
+ rtl: null,
+ source_locale_id: abcd1234abcd1234abcd1234abcd1234,
+ unverify_new_translations: null,
+ unverify_updated_translations: null,
+ autotranslate: null)
+```
+
+
diff --git a/docs/LocaleDelete.md b/docs/LocaleDelete.md
new file mode 100644
index 0000000..6bafcbd
--- /dev/null
+++ b/docs/LocaleDelete.md
@@ -0,0 +1,17 @@
+# Phrase::LocaleDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleDelete.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/LocaleDownload.md b/docs/LocaleDownload.md
new file mode 100644
index 0000000..a7b0e8e
--- /dev/null
+++ b/docs/LocaleDownload.md
@@ -0,0 +1,43 @@
+# Phrase::LocaleDownload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**file_format** | **String** | File format name. See the format guide for all supported file formats. | [optional]
+**tags** | **String** | Limit results to keys tagged with a list of comma separated tag names. | [optional]
+**tag** | **String** | Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead | [optional]
+**include_empty_translations** | **String** | Indicates whether keys without translations should be included in the output as well. | [optional]
+**include_translated_keys** | **String** | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
+**keep_notranslate_tags** | **String** | Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
+**convert_emoji** | **String** | This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. | [optional]
+**format_options** | **String** | Additional formatting and render options. See the <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code> | [optional]
+**encoding** | **String** | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional]
+**skip_unverified_translations** | **String** | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>. | [optional]
+**include_unverified_translations** | **String** | if set to false unverified translations are excluded | [optional]
+**use_last_reviewed_version** | **String** | If set to true the last reviewed version of a translation is used. This is only available if the review workflow (currently in beta) is enabled for the project. | [optional]
+**fallback_locale_id** | **String** | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleDownload.new(branch: my-feature-branch,
+ file_format: yml,
+ tags: feature1,feature2,
+ tag: feature,
+ include_empty_translations: null,
+ include_translated_keys: null,
+ keep_notranslate_tags: null,
+ convert_emoji: null,
+ format_options: null,
+ encoding: null,
+ skip_unverified_translations: null,
+ include_unverified_translations: null,
+ use_last_reviewed_version: null,
+ fallback_locale_id: null)
+```
+
+
diff --git a/docs/LocalePreview.md b/docs/LocalePreview.md
new file mode 100644
index 0000000..6edf232
--- /dev/null
+++ b/docs/LocalePreview.md
@@ -0,0 +1,21 @@
+# Phrase::LocalePreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**name** | **String** | | [optional]
+**code** | **String** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocalePreview.new(id: null,
+ name: null,
+ code: null)
+```
+
+
diff --git a/docs/LocaleShow.md b/docs/LocaleShow.md
new file mode 100644
index 0000000..ad77968
--- /dev/null
+++ b/docs/LocaleShow.md
@@ -0,0 +1,17 @@
+# Phrase::LocaleShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/LocaleUpdate.md b/docs/LocaleUpdate.md
new file mode 100644
index 0000000..f69e7fb
--- /dev/null
+++ b/docs/LocaleUpdate.md
@@ -0,0 +1,35 @@
+# Phrase::LocaleUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**name** | **String** | Locale name | [optional]
+**code** | **String** | Locale ISO code | [optional]
+**default** | **String** | Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale. | [optional]
+**main** | **String** | Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Verification System</a> feature. | [optional]
+**rtl** | **String** | Indicates whether locale is a RTL (Right-to-Left) locale. | [optional]
+**source_locale_id** | **String** | Source locale. Can be the name or public id of the locale. Preferred is the public id. | [optional]
+**unverify_new_translations** | **String** | Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
+**unverify_updated_translations** | **String** | Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
+**autotranslate** | **String** | If set, translations for this locale will be fetched automatically, right after creation. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocaleUpdate.new(branch: my-feature-branch,
+ name: de,
+ code: de-DE,
+ default: null,
+ main: null,
+ rtl: null,
+ source_locale_id: abcd1234abcd1234abcd1234abcd1234,
+ unverify_new_translations: null,
+ unverify_updated_translations: null,
+ autotranslate: null)
+```
+
+
diff --git a/docs/LocalesApi.md b/docs/LocalesApi.md
new file mode 100644
index 0000000..fb68fd3
--- /dev/null
+++ b/docs/LocalesApi.md
@@ -0,0 +1,407 @@
+# Phrase::LocalesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**locale_create**](LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
+[**locale_delete**](LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
+[**locale_download**](LocalesApi.md#locale_download) | **GET** /projects/{project_id}/locales/{id}/download | Download a locale
+[**locale_show**](LocalesApi.md#locale_show) | **GET** /projects/{project_id}/locales/{id} | Get a single locale
+[**locale_update**](LocalesApi.md#locale_update) | **PATCH** /projects/{project_id}/locales/{id} | Update a locale
+[**locales_list**](LocalesApi.md#locales_list) | **GET** /projects/{project_id}/locales | List locales
+
+
+
+## locale_create
+
+> locale_create(project_id, locale_create, opts)
+
+Create a locale
+
+Create a new 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'
+ # 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::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+locale_create = Phrase::LocaleCreate.new # LocaleCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a locale
+ api_instance.locale_create(project_id, locale_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling LocalesApi->locale_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **locale_create** | [**LocaleCreate**](LocaleCreate.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
+
+
+## locale_delete
+
+> locale_delete(project_id, id, locale_delete, opts)
+
+Delete a locale
+
+Delete an existing 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'
+ # 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::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+locale_delete = Phrase::LocaleDelete.new # LocaleDelete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Delete a locale
+ api_instance.locale_delete(project_id, id, locale_delete, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling LocalesApi->locale_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **locale_delete** | [**LocaleDelete**](LocaleDelete.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
+
+
+## locale_download
+
+> locale_download(project_id, id, locale_download, opts)
+
+Download a locale
+
+Download a locale in a specific file format.
+
+### 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::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+locale_download = Phrase::LocaleDownload.new # LocaleDownload |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Download a locale
+ api_instance.locale_download(project_id, id, locale_download, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling LocalesApi->locale_download: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **locale_download** | [**LocaleDownload**](LocaleDownload.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
+
+
+## locale_show
+
+> Object locale_show(project_id, id, locale_show, opts)
+
+Get a single locale
+
+Get details on a single locale for a given 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::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+locale_show = Phrase::LocaleShow.new # LocaleShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Get a single locale
+ result = api_instance.locale_show(project_id, id, locale_show, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling LocalesApi->locale_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **locale_show** | [**LocaleShow**](LocaleShow.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## locale_update
+
+> Object locale_update(project_id, id, locale_update, opts)
+
+Update a locale
+
+Update an existing 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'
+ # 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::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+locale_update = Phrase::LocaleUpdate.new # LocaleUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a locale
+ result = api_instance.locale_update(project_id, id, locale_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling LocalesApi->locale_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **locale_update** | [**LocaleUpdate**](LocaleUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## locales_list
+
+> Array<Locale> locales_list(project_id, locales_list, opts)
+
+List locales
+
+List all locales for the given 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::LocalesApi.new
+project_id = 'project_id_example' # String | Project ID
+locales_list = Phrase::LocalesList.new # LocalesList |
+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 locales
+ result = api_instance.locales_list(project_id, locales_list, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling LocalesApi->locales_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **locales_list** | [**LocalesList**](LocalesList.md)| |
+ **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<Locale>**](Locale.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/LocalesList.md b/docs/LocalesList.md
new file mode 100644
index 0000000..9592d12
--- /dev/null
+++ b/docs/LocalesList.md
@@ -0,0 +1,17 @@
+# Phrase::LocalesList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::LocalesList.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/Member.md b/docs/Member.md
new file mode 100644
index 0000000..a7c686f
--- /dev/null
+++ b/docs/Member.md
@@ -0,0 +1,25 @@
+# Phrase::Member
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**email** | **String** | | [optional]
+**username** | **String** | | [optional]
+**role** | **String** | | [optional]
+**projects** | **Array<Object>** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Member.new(id: null,
+ email: null,
+ username: null,
+ role: null,
+ projects: null)
+```
+
+
diff --git a/docs/MemberUpdate.md b/docs/MemberUpdate.md
new file mode 100644
index 0000000..f9e9535
--- /dev/null
+++ b/docs/MemberUpdate.md
@@ -0,0 +1,23 @@
+# Phrase::MemberUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | Member role, can be any of of Manager, Developer, Translator | [optional]
+**project_ids** | **String** | List of project ids the user has access to. | [optional]
+**locale_ids** | **String** | List of locale ids the user has access to. | [optional]
+**permissions** | **String** | Additional permissions depending on member role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::MemberUpdate.new(role: Developer,
+ project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+ locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
+ permissions: {"create_upload":true,"review_translations":true})
+```
+
+
diff --git a/docs/MembersApi.md b/docs/MembersApi.md
new file mode 100644
index 0000000..d1f032c
--- /dev/null
+++ b/docs/MembersApi.md
@@ -0,0 +1,271 @@
+# Phrase::MembersApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**member_delete**](MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
+[**member_show**](MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
+[**member_update**](MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
+[**members_list**](MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
+
+
+
+## member_delete
+
+> member_delete(account_id, id, opts)
+
+Remove a user from the account
+
+Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include team.manage.
+
+### 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::MembersApi.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
+ #Remove a user from the account
+ api_instance.member_delete(account_id, id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling MembersApi->member_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
+
+
+## member_show
+
+> Member member_show(account_id, id, opts)
+
+Get single member
+
+Get details on a single user in the account. Access token scope must include team.manage.
+
+### 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::MembersApi.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 single member
+ result = api_instance.member_show(account_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling MembersApi->member_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<([**Member**](Member.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## member_update
+
+> Object member_update(account_id, id, member_update, opts)
+
+Update a member
+
+Update user permissions in the account. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
+
+### 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::MembersApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+member_update = Phrase::MemberUpdate.new # MemberUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a member
+ result = api_instance.member_update(account_id, id, member_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling MembersApi->member_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **id** | **String**| ID |
+ **member_update** | [**MemberUpdate**](MemberUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## members_list
+
+> Array<Object> members_list(account_id, opts)
+
+List members
+
+Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include team.manage.
+
+### 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::MembersApi.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 members
+ result = api_instance.members_list(account_id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling MembersApi->members_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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/OrderConfirm.md b/docs/OrderConfirm.md
new file mode 100644
index 0000000..f621e2b
--- /dev/null
+++ b/docs/OrderConfirm.md
@@ -0,0 +1,17 @@
+# Phrase::OrderConfirm
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrderConfirm.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/OrderCreate.md b/docs/OrderCreate.md
new file mode 100644
index 0000000..d4aa529
--- /dev/null
+++ b/docs/OrderCreate.md
@@ -0,0 +1,43 @@
+# Phrase::OrderCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**lsp** | **String** | Name of the LSP that should process this order. Can be one of gengo, textmaster. | [optional]
+**source_locale_id** | **String** | Source locale for the order. Can be the name or public id of the source locale. Preferred is the public id. | [optional]
+**target_locale_ids** | **String** | List of target locales you want the source content translate to. Can be the name or public id of the target locales. Preferred is the public id. | [optional]
+**translation_type** | **String** | Name of the quality level, availability depends on the LSP. Can be one of: standard, pro (for orders processed by Gengo) and one of regular, premium, enterprise (for orders processed by TextMaster) | [optional]
+**tag** | **String** | Tag you want to order translations for. | [optional]
+**message** | **String** | Message that is displayed to the translators for description. | [optional]
+**styleguide_id** | **String** | Style guide for translators to be sent with the order. | [optional]
+**unverify_translations_upon_delivery** | **String** | Unverify translations upon delivery. | [optional]
+**include_untranslated_keys** | **String** | Order translations for keys with untranslated content in the selected target locales. | [optional]
+**include_unverified_translations** | **String** | Order translations for keys with unverified content in the selected target locales. | [optional]
+**category** | **String** | Category to use (required for orders processed by TextMaster). | [optional]
+**quality** | **String** | Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster. | [optional]
+**priority** | **String** | Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrderCreate.new(branch: my-feature-branch,
+ lsp: textmaster,
+ source_locale_id: abcd1234abcd1234abcd1234abcd1234,
+ target_locale_ids: ["1234abcd1234abcd1234abcd1234abcd","abcd1234abcd1234abcd1234abcd1234"],
+ translation_type: premium,
+ tag: my-awesome-feature,
+ message: Please make everything sound really nice :),
+ styleguide_id: 1234abcd1234abcd1234abcd1234abcd,
+ unverify_translations_upon_delivery: null,
+ include_untranslated_keys: null,
+ include_unverified_translations: null,
+ category: C021,
+ quality: null,
+ priority: null)
+```
+
+
diff --git a/docs/OrderDelete.md b/docs/OrderDelete.md
new file mode 100644
index 0000000..8e3a43e
--- /dev/null
+++ b/docs/OrderDelete.md
@@ -0,0 +1,17 @@
+# Phrase::OrderDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrderDelete.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/OrderShow.md b/docs/OrderShow.md
new file mode 100644
index 0000000..b0268b9
--- /dev/null
+++ b/docs/OrderShow.md
@@ -0,0 +1,17 @@
+# Phrase::OrderShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrderShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/OrdersApi.md b/docs/OrdersApi.md
new file mode 100644
index 0000000..eff91c0
--- /dev/null
+++ b/docs/OrdersApi.md
@@ -0,0 +1,341 @@
+# Phrase::OrdersApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**order_confirm**](OrdersApi.md#order_confirm) | **PATCH** /projects/{project_id}/orders/{id}/confirm | Confirm an order
+[**order_create**](OrdersApi.md#order_create) | **POST** /projects/{project_id}/orders | Create a new order
+[**order_delete**](OrdersApi.md#order_delete) | **DELETE** /projects/{project_id}/orders/{id} | Cancel an order
+[**order_show**](OrdersApi.md#order_show) | **GET** /projects/{project_id}/orders/{id} | Get a single order
+[**orders_list**](OrdersApi.md#orders_list) | **GET** /projects/{project_id}/orders | List orders
+
+
+
+## order_confirm
+
+> Object order_confirm(project_id, id, order_confirm, opts)
+
+Confirm an order
+
+Confirm an existing order and send it to the provider for translation. Same constraints as for create.
+
+### 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::OrdersApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+order_confirm = Phrase::OrderConfirm.new # OrderConfirm |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Confirm an order
+ result = api_instance.order_confirm(project_id, id, order_confirm, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling OrdersApi->order_confirm: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **order_confirm** | [**OrderConfirm**](OrderConfirm.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## order_create
+
+> order_create(project_id, order_create, opts)
+
+Create a new order
+
+Create a new order. Access token scope must include orders.create.
+
+### 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::OrdersApi.new
+project_id = 'project_id_example' # String | Project ID
+order_create = Phrase::OrderCreate.new # OrderCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a new order
+ api_instance.order_create(project_id, order_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling OrdersApi->order_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **order_create** | [**OrderCreate**](OrderCreate.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
+
+
+## order_delete
+
+> order_delete(project_id, id, order_delete, opts)
+
+Cancel an order
+
+Cancel an existing order. Must not yet be confirmed.
+
+### 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::OrdersApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+order_delete = Phrase::OrderDelete.new # OrderDelete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Cancel an order
+ api_instance.order_delete(project_id, id, order_delete, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling OrdersApi->order_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **order_delete** | [**OrderDelete**](OrderDelete.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
+
+
+## order_show
+
+> TranslationOrder order_show(project_id, id, order_show, opts)
+
+Get a single order
+
+Get details on a single order.
+
+### 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::OrdersApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+order_show = Phrase::OrderShow.new # OrderShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Get a single order
+ result = api_instance.order_show(project_id, id, order_show, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling OrdersApi->order_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **order_show** | [**OrderShow**](OrderShow.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<([**TranslationOrder**](TranslationOrder.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## orders_list
+
+> Array<Object> orders_list(project_id, orders_list, opts)
+
+List orders
+
+List all orders for the given 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::OrdersApi.new
+project_id = 'project_id_example' # String | Project ID
+orders_list = Phrase::OrdersList.new # OrdersList |
+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 orders
+ result = api_instance.orders_list(project_id, orders_list, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling OrdersApi->orders_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **orders_list** | [**OrdersList**](OrdersList.md)| |
+ **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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/OrdersList.md b/docs/OrdersList.md
new file mode 100644
index 0000000..9a18b0d
--- /dev/null
+++ b/docs/OrdersList.md
@@ -0,0 +1,17 @@
+# Phrase::OrdersList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::OrdersList.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/Project.md b/docs/Project.md
new file mode 100644
index 0000000..675b421
--- /dev/null
+++ b/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)
+```
+
+
diff --git a/docs/ProjectCreate.md b/docs/ProjectCreate.md
new file mode 100644
index 0000000..4958b99
--- /dev/null
+++ b/docs/ProjectCreate.md
@@ -0,0 +1,27 @@
+# Phrase::ProjectCreate
+
+## 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** | **String** | Indicates whether the project should share the account's translation memory | [optional]
+**project_image** | **String** | Image to identify the project | [optional]
+**remove_project_image** | **String** | 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::ProjectCreate.new(name: My Android Project,
+ main_format: yml,
+ shares_translation_memory: true,
+ project_image: /path/to/my/project-screenshot.png,
+ remove_project_image: null,
+ account_id: abcd1234)
+```
+
+
diff --git a/docs/ProjectShort.md b/docs/ProjectShort.md
new file mode 100644
index 0000000..b916156
--- /dev/null
+++ b/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)
+```
+
+
diff --git a/docs/ProjectUpdate.md b/docs/ProjectUpdate.md
new file mode 100644
index 0000000..809c11c
--- /dev/null
+++ b/docs/ProjectUpdate.md
@@ -0,0 +1,27 @@
+# Phrase::ProjectUpdate
+
+## 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** | **String** | Indicates whether the project should share the account's translation memory | [optional]
+**project_image** | **String** | Image to identify the project | [optional]
+**remove_project_image** | **String** | 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::ProjectUpdate.new(name: My Android Project,
+ main_format: yml,
+ shares_translation_memory: true,
+ project_image: /path/to/my/project-screenshot.png,
+ remove_project_image: null,
+ account_id: abcd1234)
+```
+
+
diff --git a/docs/ProjectsApi.md b/docs/ProjectsApi.md
new file mode 100644
index 0000000..ffeae17
--- /dev/null
+++ b/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, 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 = Phrase::ProjectCreate.new # ProjectCreate |
+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, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling ProjectsApi->project_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_create** | [**ProjectCreate**](ProjectCreate.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
+
+> Project 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<([**Project**](Project.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## project_update
+
+> Object project_update(id, project_update, 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 = Phrase::ProjectUpdate.new # ProjectUpdate |
+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, 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** | [**ProjectUpdate**](ProjectUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## projects_list
+
+> Array<Project> 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<Project>**](Project.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/Release.md b/docs/Release.md
new file mode 100644
index 0000000..aa97da1
--- /dev/null
+++ b/docs/Release.md
@@ -0,0 +1,37 @@
+# Phrase::Release
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**version** | **Integer** | | [optional]
+**app_min_version** | **String** | | [optional]
+**app_max_version** | **String** | | [optional]
+**description** | **String** | | [optional]
+**platforms** | **Array<String>** | | [optional]
+**environments** | **Array<String>** | | [optional]
+**locales** | **Array<Object>** | | [optional]
+**project** | **Object** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Release.new(id: null,
+ version: null,
+ app_min_version: null,
+ app_max_version: null,
+ description: null,
+ platforms: null,
+ environments: null,
+ locales: null,
+ project: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/ReleaseCreate.md b/docs/ReleaseCreate.md
new file mode 100644
index 0000000..7c4cdc0
--- /dev/null
+++ b/docs/ReleaseCreate.md
@@ -0,0 +1,21 @@
+# Phrase::ReleaseCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Description of the release | [optional]
+**platforms** | **String** | List of platforms the release should support. | [optional]
+**branch** | **String** | Branch used for release | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ReleaseCreate.new(description: My first Release,
+ platforms: ["android","ios"],
+ branch: my-feature-branch)
+```
+
+
diff --git a/docs/ReleasePreview.md b/docs/ReleasePreview.md
new file mode 100644
index 0000000..750a3a0
--- /dev/null
+++ b/docs/ReleasePreview.md
@@ -0,0 +1,37 @@
+# Phrase::ReleasePreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**version** | **Integer** | | [optional]
+**app_min_version** | **String** | | [optional]
+**app_max_version** | **String** | | [optional]
+**description** | **String** | | [optional]
+**platforms** | **Array<String>** | | [optional]
+**environments** | **Array<String>** | | [optional]
+**locale_codes** | **Array<String>** | | [optional]
+**project** | **Object** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ReleasePreview.new(id: null,
+ version: null,
+ app_min_version: null,
+ app_max_version: null,
+ description: null,
+ platforms: null,
+ environments: null,
+ locale_codes: null,
+ project: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/ReleaseUpdate.md b/docs/ReleaseUpdate.md
new file mode 100644
index 0000000..3774973
--- /dev/null
+++ b/docs/ReleaseUpdate.md
@@ -0,0 +1,21 @@
+# Phrase::ReleaseUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Description of the release | [optional]
+**platforms** | **String** | List of platforms the release should support. | [optional]
+**branch** | **String** | Branch used for release | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ReleaseUpdate.new(description: My first Release,
+ platforms: ["android","ios"],
+ branch: my-feature-branch)
+```
+
+
diff --git a/docs/ReleasesApi.md b/docs/ReleasesApi.md
new file mode 100644
index 0000000..abbf631
--- /dev/null
+++ b/docs/ReleasesApi.md
@@ -0,0 +1,412 @@
+# Phrase::ReleasesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**release_create**](ReleasesApi.md#release_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
+[**release_delete**](ReleasesApi.md#release_delete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
+[**release_publish**](ReleasesApi.md#release_publish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release
+[**release_show**](ReleasesApi.md#release_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Get a single release
+[**release_update**](ReleasesApi.md#release_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Update a release
+[**releases_list**](ReleasesApi.md#releases_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases | List releases
+
+
+
+## release_create
+
+> release_create(account_id, distribution_id, release_create, opts)
+
+Create a release
+
+Create a new release.
+
+### 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::ReleasesApi.new
+account_id = 'account_id_example' # String | Account ID
+distribution_id = 'distribution_id_example' # String | Distribution ID
+release_create = Phrase::ReleaseCreate.new # ReleaseCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a release
+ api_instance.release_create(account_id, distribution_id, release_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling ReleasesApi->release_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **distribution_id** | **String**| Distribution ID |
+ **release_create** | [**ReleaseCreate**](ReleaseCreate.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
+
+
+## release_delete
+
+> release_delete(account_id, distribution_id, id, opts)
+
+Delete a release
+
+Delete an existing release.
+
+### 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::ReleasesApi.new
+account_id = 'account_id_example' # String | Account ID
+distribution_id = 'distribution_id_example' # String | Distribution ID
+id = 'id_example' # String | ID
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Delete a release
+ api_instance.release_delete(account_id, distribution_id, id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling ReleasesApi->release_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **distribution_id** | **String**| Distribution 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
+
+
+## release_publish
+
+> Object release_publish(account_id, distribution_id, id, opts)
+
+Publish a release
+
+Publish a release for production.
+
+### 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::ReleasesApi.new
+account_id = 'account_id_example' # String | Account ID
+distribution_id = 'distribution_id_example' # String | Distribution ID
+id = 'id_example' # String | ID
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Publish a release
+ result = api_instance.release_publish(account_id, distribution_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ReleasesApi->release_publish: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **distribution_id** | **String**| Distribution ID |
+ **id** | **String**| ID |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## release_show
+
+> Release release_show(account_id, distribution_id, id, opts)
+
+Get a single release
+
+Get details on a single release.
+
+### 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::ReleasesApi.new
+account_id = 'account_id_example' # String | Account ID
+distribution_id = 'distribution_id_example' # String | Distribution 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 release
+ result = api_instance.release_show(account_id, distribution_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ReleasesApi->release_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **distribution_id** | **String**| Distribution ID |
+ **id** | **String**| ID |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<([**Release**](Release.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## release_update
+
+> Object release_update(account_id, distribution_id, id, release_update, opts)
+
+Update a release
+
+Update an existing release.
+
+### 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::ReleasesApi.new
+account_id = 'account_id_example' # String | Account ID
+distribution_id = 'distribution_id_example' # String | Distribution ID
+id = 'id_example' # String | ID
+release_update = Phrase::ReleaseUpdate.new # ReleaseUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a release
+ result = api_instance.release_update(account_id, distribution_id, id, release_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ReleasesApi->release_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **distribution_id** | **String**| Distribution ID |
+ **id** | **String**| ID |
+ **release_update** | [**ReleaseUpdate**](ReleaseUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## releases_list
+
+> Array<ReleasePreview> releases_list(account_id, distribution_id, opts)
+
+List releases
+
+List all releases for the given distribution.
+
+### 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::ReleasesApi.new
+account_id = 'account_id_example' # String | Account ID
+distribution_id = 'distribution_id_example' # String | Distribution 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 releases
+ result = api_instance.releases_list(account_id, distribution_id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ReleasesApi->releases_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **distribution_id** | **String**| Distribution 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<ReleasePreview>**](ReleasePreview.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/Screenshot.md b/docs/Screenshot.md
new file mode 100644
index 0000000..9a317d1
--- /dev/null
+++ b/docs/Screenshot.md
@@ -0,0 +1,29 @@
+# Phrase::Screenshot
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**name** | **String** | | [optional]
+**description** | **String** | | [optional]
+**screenshot_url** | **String** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+**markers_count** | **Integer** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Screenshot.new(id: null,
+ name: null,
+ description: null,
+ screenshot_url: null,
+ created_at: null,
+ updated_at: null,
+ markers_count: null)
+```
+
+
diff --git a/docs/ScreenshotCreate.md b/docs/ScreenshotCreate.md
new file mode 100644
index 0000000..b733b21
--- /dev/null
+++ b/docs/ScreenshotCreate.md
@@ -0,0 +1,21 @@
+# Phrase::ScreenshotCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the screenshot | [optional]
+**description** | **String** | Description of the screenshot | [optional]
+**filename** | **String** | Screenshot file | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ScreenshotCreate.new(name: A screenshot name,
+ description: A screenshot description,
+ filename: /path/to/my/screenshot.png)
+```
+
+
diff --git a/docs/ScreenshotMarker.md b/docs/ScreenshotMarker.md
new file mode 100644
index 0000000..4c0d9ca
--- /dev/null
+++ b/docs/ScreenshotMarker.md
@@ -0,0 +1,27 @@
+# Phrase::ScreenshotMarker
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**presentation** | **String** | | [optional]
+**presentation_type** | **String** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+**translation_key** | **Object** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ScreenshotMarker.new(id: null,
+ presentation: null,
+ presentation_type: null,
+ created_at: null,
+ updated_at: null,
+ translation_key: null)
+```
+
+
diff --git a/docs/ScreenshotMarkerCreate.md b/docs/ScreenshotMarkerCreate.md
new file mode 100644
index 0000000..834d63e
--- /dev/null
+++ b/docs/ScreenshotMarkerCreate.md
@@ -0,0 +1,19 @@
+# Phrase::ScreenshotMarkerCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional]
+**presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ScreenshotMarkerCreate.new(key_id: abcd1234abcd1234abcd1234abcd1234,
+ presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
+```
+
+
diff --git a/docs/ScreenshotMarkerUpdate.md b/docs/ScreenshotMarkerUpdate.md
new file mode 100644
index 0000000..a2eee8b
--- /dev/null
+++ b/docs/ScreenshotMarkerUpdate.md
@@ -0,0 +1,19 @@
+# Phrase::ScreenshotMarkerUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key_id** | **String** | Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project. | [optional]
+**presentation** | **String** | Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels). | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ScreenshotMarkerUpdate.new(key_id: abcd1234abcd1234abcd1234abcd1234,
+ presentation: { "x": 100, "y": 100, "w": 100, "h": 100 })
+```
+
+
diff --git a/docs/ScreenshotMarkersApi.md b/docs/ScreenshotMarkersApi.md
new file mode 100644
index 0000000..8cd4929
--- /dev/null
+++ b/docs/ScreenshotMarkersApi.md
@@ -0,0 +1,341 @@
+# Phrase::ScreenshotMarkersApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**screenshot_marker_create**](ScreenshotMarkersApi.md#screenshot_marker_create) | **POST** /projects/{project_id}/screenshots/{screenshot_id}/markers | Create a screenshot marker
+[**screenshot_marker_delete**](ScreenshotMarkersApi.md#screenshot_marker_delete) | **DELETE** /projects/{project_id}/screenshots/{screenshot_id}/markers | Delete a screenshot marker
+[**screenshot_marker_show**](ScreenshotMarkersApi.md#screenshot_marker_show) | **GET** /projects/{project_id}/screenshots/{screenshot_id}/markers/{id} | Get a single screenshot marker
+[**screenshot_marker_update**](ScreenshotMarkersApi.md#screenshot_marker_update) | **PATCH** /projects/{project_id}/screenshots/{screenshot_id}/markers | Update a screenshot marker
+[**screenshot_markers_list**](ScreenshotMarkersApi.md#screenshot_markers_list) | **GET** /projects/{project_id}/screenshots/{id}/markers | List screenshot markers
+
+
+
+## screenshot_marker_create
+
+> screenshot_marker_create(project_id, screenshot_id, screenshot_marker_create, opts)
+
+Create a screenshot marker
+
+Create a new screenshot marker.
+
+### 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::ScreenshotMarkersApi.new
+project_id = 'project_id_example' # String | Project ID
+screenshot_id = 'screenshot_id_example' # String | Screenshot ID
+screenshot_marker_create = Phrase::ScreenshotMarkerCreate.new # ScreenshotMarkerCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a screenshot marker
+ api_instance.screenshot_marker_create(project_id, screenshot_id, screenshot_marker_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotMarkersApi->screenshot_marker_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **screenshot_id** | **String**| Screenshot ID |
+ **screenshot_marker_create** | [**ScreenshotMarkerCreate**](ScreenshotMarkerCreate.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
+
+
+## screenshot_marker_delete
+
+> screenshot_marker_delete(project_id, screenshot_id, opts)
+
+Delete a screenshot marker
+
+Delete an existing screenshot marker.
+
+### 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::ScreenshotMarkersApi.new
+project_id = 'project_id_example' # String | Project ID
+screenshot_id = 'screenshot_id_example' # String | Screenshot ID
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Delete a screenshot marker
+ api_instance.screenshot_marker_delete(project_id, screenshot_id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotMarkersApi->screenshot_marker_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **screenshot_id** | **String**| Screenshot 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
+
+
+## screenshot_marker_show
+
+> Object screenshot_marker_show(project_id, screenshot_id, id, opts)
+
+Get a single screenshot marker
+
+Get details on a single screenshot marker for a given 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::ScreenshotMarkersApi.new
+project_id = 'project_id_example' # String | Project ID
+screenshot_id = 'screenshot_id_example' # String | Screenshot 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 screenshot marker
+ result = api_instance.screenshot_marker_show(project_id, screenshot_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotMarkersApi->screenshot_marker_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **screenshot_id** | **String**| Screenshot ID |
+ **id** | **String**| ID |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## screenshot_marker_update
+
+> ScreenshotMarker screenshot_marker_update(project_id, screenshot_id, screenshot_marker_update, opts)
+
+Update a screenshot marker
+
+Update an existing screenshot marker.
+
+### 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::ScreenshotMarkersApi.new
+project_id = 'project_id_example' # String | Project ID
+screenshot_id = 'screenshot_id_example' # String | Screenshot ID
+screenshot_marker_update = Phrase::ScreenshotMarkerUpdate.new # ScreenshotMarkerUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a screenshot marker
+ result = api_instance.screenshot_marker_update(project_id, screenshot_id, screenshot_marker_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotMarkersApi->screenshot_marker_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **screenshot_id** | **String**| Screenshot ID |
+ **screenshot_marker_update** | [**ScreenshotMarkerUpdate**](ScreenshotMarkerUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<([**ScreenshotMarker**](ScreenshotMarker.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## screenshot_markers_list
+
+> Array<Object> screenshot_markers_list(project_id, id, opts)
+
+List screenshot markers
+
+List all screenshot markers for the given 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::ScreenshotMarkersApi.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)
+ 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 screenshot markers
+ result = api_instance.screenshot_markers_list(project_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotMarkersApi->screenshot_markers_list: #{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]
+ **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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/ScreenshotUpdate.md b/docs/ScreenshotUpdate.md
new file mode 100644
index 0000000..2f4f29d
--- /dev/null
+++ b/docs/ScreenshotUpdate.md
@@ -0,0 +1,21 @@
+# Phrase::ScreenshotUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the screenshot | [optional]
+**description** | **String** | Description of the screenshot | [optional]
+**filename** | **String** | Screenshot file | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::ScreenshotUpdate.new(name: A screenshot name,
+ description: A screenshot description,
+ filename: /path/to/my/screenshot.png)
+```
+
+
diff --git a/docs/ScreenshotsApi.md b/docs/ScreenshotsApi.md
new file mode 100644
index 0000000..11d7412
--- /dev/null
+++ b/docs/ScreenshotsApi.md
@@ -0,0 +1,335 @@
+# Phrase::ScreenshotsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**screenshot_create**](ScreenshotsApi.md#screenshot_create) | **POST** /projects/{project_id}/screenshots | Create a screenshot
+[**screenshot_delete**](ScreenshotsApi.md#screenshot_delete) | **DELETE** /projects/{project_id}/screenshots/{id} | Delete a screenshot
+[**screenshot_show**](ScreenshotsApi.md#screenshot_show) | **GET** /projects/{project_id}/screenshots/{id} | Get a single screenshot
+[**screenshot_update**](ScreenshotsApi.md#screenshot_update) | **PATCH** /projects/{project_id}/screenshots/{id} | Update a screenshot
+[**screenshots_list**](ScreenshotsApi.md#screenshots_list) | **GET** /projects/{project_id}/screenshots | List screenshots
+
+
+
+## screenshot_create
+
+> screenshot_create(project_id, screenshot_create, opts)
+
+Create a screenshot
+
+Create a new screenshot.
+
+### 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::ScreenshotsApi.new
+project_id = 'project_id_example' # String | Project ID
+screenshot_create = Phrase::ScreenshotCreate.new # ScreenshotCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a screenshot
+ api_instance.screenshot_create(project_id, screenshot_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotsApi->screenshot_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **screenshot_create** | [**ScreenshotCreate**](ScreenshotCreate.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
+
+
+## screenshot_delete
+
+> screenshot_delete(project_id, id, opts)
+
+Delete a screenshot
+
+Delete an existing screenshot.
+
+### 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::ScreenshotsApi.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 a screenshot
+ api_instance.screenshot_delete(project_id, id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotsApi->screenshot_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
+
+
+## screenshot_show
+
+> Screenshot screenshot_show(project_id, id, opts)
+
+Get a single screenshot
+
+Get details on a single screenshot for a given 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::ScreenshotsApi.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
+ #Get a single screenshot
+ result = api_instance.screenshot_show(project_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotsApi->screenshot_show: #{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<([**Screenshot**](Screenshot.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## screenshot_update
+
+> Object screenshot_update(project_id, id, screenshot_update, opts)
+
+Update a screenshot
+
+Update an existing screenshot.
+
+### 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::ScreenshotsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+screenshot_update = Phrase::ScreenshotUpdate.new # ScreenshotUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a screenshot
+ result = api_instance.screenshot_update(project_id, id, screenshot_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotsApi->screenshot_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **screenshot_update** | [**ScreenshotUpdate**](ScreenshotUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## screenshots_list
+
+> Array<Object> screenshots_list(project_id, opts)
+
+List screenshots
+
+List all screenshots for the given 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::ScreenshotsApi.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: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
+}
+
+begin
+ #List screenshots
+ result = api_instance.screenshots_list(project_id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling ScreenshotsApi->screenshots_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, 10 by default | [optional]
+
+### Return type
+
+Response<(**Array<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/Space.md b/docs/Space.md
new file mode 100644
index 0000000..cd7f247
--- /dev/null
+++ b/docs/Space.md
@@ -0,0 +1,27 @@
+# Phrase::Space
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**name** | **String** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+**projects_count** | **Integer** | | [optional]
+**projects** | [**Array<Project>**](Project.md) | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Space.new(id: null,
+ name: null,
+ created_at: null,
+ updated_at: null,
+ projects_count: null,
+ projects: null)
+```
+
+
diff --git a/docs/SpaceCreate.md b/docs/SpaceCreate.md
new file mode 100644
index 0000000..05beccf
--- /dev/null
+++ b/docs/SpaceCreate.md
@@ -0,0 +1,17 @@
+# Phrase::SpaceCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the space | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::SpaceCreate.new(name: My Android Projects)
+```
+
+
diff --git a/docs/SpaceUpdate.md b/docs/SpaceUpdate.md
new file mode 100644
index 0000000..9b1e626
--- /dev/null
+++ b/docs/SpaceUpdate.md
@@ -0,0 +1,17 @@
+# Phrase::SpaceUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | New name of the space | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::SpaceUpdate.new(name: My Android Projects)
+```
+
+
diff --git a/docs/SpacesApi.md b/docs/SpacesApi.md
new file mode 100644
index 0000000..94df187
--- /dev/null
+++ b/docs/SpacesApi.md
@@ -0,0 +1,536 @@
+# Phrase::SpacesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**space_create**](SpacesApi.md#space_create) | **POST** /accounts/{account_id}/spaces | Create a Space
+[**space_delete**](SpacesApi.md#space_delete) | **DELETE** /accounts/{account_id}/spaces/{id} | Delete Space
+[**space_show**](SpacesApi.md#space_show) | **GET** /accounts/{account_id}/spaces/{id} | Get Space
+[**space_update**](SpacesApi.md#space_update) | **PATCH** /accounts/{account_id}/spaces/{id} | Update Space
+[**spaces_list**](SpacesApi.md#spaces_list) | **GET** /accounts/{account_id}/spaces | List Spaces
+[**spaces_projects_create**](SpacesApi.md#spaces_projects_create) | **POST** /accounts/{account_id}/spaces/{space_id}/projects | Add Project
+[**spaces_projects_delete**](SpacesApi.md#spaces_projects_delete) | **DELETE** /accounts/{account_id}/spaces/{space_id}/projects/{id} | Remove Project
+[**spaces_projects_list**](SpacesApi.md#spaces_projects_list) | **GET** /accounts/{account_id}/spaces/{space_id}/projects | List Projects
+
+
+
+## space_create
+
+> space_create(account_id, space_create, opts)
+
+Create a Space
+
+Create a new Space.
+
+### 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::SpacesApi.new
+account_id = 'account_id_example' # String | Account ID
+space_create = Phrase::SpaceCreate.new # SpaceCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a Space
+ api_instance.space_create(account_id, space_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling SpacesApi->space_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **space_create** | [**SpaceCreate**](SpaceCreate.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
+
+
+## space_delete
+
+> space_delete(account_id, id, opts)
+
+Delete Space
+
+Delete the specified Space.
+
+### 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::SpacesApi.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 Space
+ api_instance.space_delete(account_id, id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling SpacesApi->space_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
+
+
+## space_show
+
+> Space space_show(account_id, id, opts)
+
+Get Space
+
+Show the specified Space.
+
+### 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::SpacesApi.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 Space
+ result = api_instance.space_show(account_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling SpacesApi->space_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<([**Space**](Space.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## space_update
+
+> Space space_update(account_id, id, space_update, opts)
+
+Update Space
+
+Update the specified Space.
+
+### 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::SpacesApi.new
+account_id = 'account_id_example' # String | Account ID
+id = 'id_example' # String | ID
+space_update = Phrase::SpaceUpdate.new # SpaceUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update Space
+ result = api_instance.space_update(account_id, id, space_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling SpacesApi->space_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **id** | **String**| ID |
+ **space_update** | [**SpaceUpdate**](SpaceUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<([**Space**](Space.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## spaces_list
+
+> Array<Space> spaces_list(account_id, opts)
+
+List Spaces
+
+List all Spaces for the given 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'
+ # 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::SpacesApi.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 Spaces
+ result = api_instance.spaces_list(account_id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling SpacesApi->spaces_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<Space>**](Space.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## spaces_projects_create
+
+> spaces_projects_create(account_id, space_id, spaces_projects_create, opts)
+
+Add Project
+
+Adds an existing project to the space.
+
+### 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::SpacesApi.new
+account_id = 'account_id_example' # String | Account ID
+space_id = 'space_id_example' # String | Space ID
+spaces_projects_create = Phrase::SpacesProjectsCreate.new # SpacesProjectsCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Add Project
+ api_instance.spaces_projects_create(account_id, space_id, spaces_projects_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling SpacesApi->spaces_projects_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **space_id** | **String**| Space ID |
+ **spaces_projects_create** | [**SpacesProjectsCreate**](SpacesProjectsCreate.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
+
+
+## spaces_projects_delete
+
+> spaces_projects_delete(account_id, space_id, id, opts)
+
+Remove Project
+
+Removes a specified project from the specified space.
+
+### 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::SpacesApi.new
+account_id = 'account_id_example' # String | Account ID
+space_id = 'space_id_example' # String | Space ID
+id = 'id_example' # String | ID
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Remove Project
+ api_instance.spaces_projects_delete(account_id, space_id, id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling SpacesApi->spaces_projects_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **space_id** | **String**| Space 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
+
+
+## spaces_projects_list
+
+> Array<Project> spaces_projects_list(account_id, space_id, opts)
+
+List Projects
+
+List all projects for the specified Space.
+
+### 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::SpacesApi.new
+account_id = 'account_id_example' # String | Account ID
+space_id = 'space_id_example' # String | Space 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 Projects
+ result = api_instance.spaces_projects_list(account_id, space_id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling SpacesApi->spaces_projects_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| Account ID |
+ **space_id** | **String**| Space 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<Project>**](Project.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/SpacesProjectsCreate.md b/docs/SpacesProjectsCreate.md
new file mode 100644
index 0000000..36a54f8
--- /dev/null
+++ b/docs/SpacesProjectsCreate.md
@@ -0,0 +1,17 @@
+# Phrase::SpacesProjectsCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Project ID to add or to the Space | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::SpacesProjectsCreate.new(id: a4b3c2d1)
+```
+
+
diff --git a/docs/StyleGuidesApi.md b/docs/StyleGuidesApi.md
new file mode 100644
index 0000000..36db2ba
--- /dev/null
+++ b/docs/StyleGuidesApi.md
@@ -0,0 +1,335 @@
+# Phrase::StyleGuidesApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**styleguide_create**](StyleGuidesApi.md#styleguide_create) | **POST** /projects/{project_id}/styleguides | Create a style guide
+[**styleguide_delete**](StyleGuidesApi.md#styleguide_delete) | **DELETE** /projects/{project_id}/styleguides/{id} | Delete a style guide
+[**styleguide_show**](StyleGuidesApi.md#styleguide_show) | **GET** /projects/{project_id}/styleguides/{id} | Get a single style guide
+[**styleguide_update**](StyleGuidesApi.md#styleguide_update) | **PATCH** /projects/{project_id}/styleguides/{id} | Update a style guide
+[**styleguides_list**](StyleGuidesApi.md#styleguides_list) | **GET** /projects/{project_id}/styleguides | List style guides
+
+
+
+## styleguide_create
+
+> styleguide_create(project_id, styleguide_create, opts)
+
+Create a style guide
+
+Create a new style guide.
+
+### 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::StyleGuidesApi.new
+project_id = 'project_id_example' # String | Project ID
+styleguide_create = Phrase::StyleguideCreate.new # StyleguideCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a style guide
+ api_instance.styleguide_create(project_id, styleguide_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling StyleGuidesApi->styleguide_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **styleguide_create** | [**StyleguideCreate**](StyleguideCreate.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
+
+
+## styleguide_delete
+
+> styleguide_delete(project_id, id, opts)
+
+Delete a style guide
+
+Delete an existing style guide.
+
+### 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::StyleGuidesApi.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 a style guide
+ api_instance.styleguide_delete(project_id, id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling StyleGuidesApi->styleguide_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
+
+
+## styleguide_show
+
+> Object styleguide_show(project_id, id, opts)
+
+Get a single style guide
+
+Get details on a single style guide.
+
+### 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::StyleGuidesApi.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
+ #Get a single style guide
+ result = api_instance.styleguide_show(project_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling StyleGuidesApi->styleguide_show: #{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<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## styleguide_update
+
+> Object styleguide_update(project_id, id, styleguide_update, opts)
+
+Update a style guide
+
+Update an existing style guide.
+
+### 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::StyleGuidesApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+styleguide_update = Phrase::StyleguideUpdate.new # StyleguideUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a style guide
+ result = api_instance.styleguide_update(project_id, id, styleguide_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling StyleGuidesApi->styleguide_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **styleguide_update** | [**StyleguideUpdate**](StyleguideUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## styleguides_list
+
+> Array<Styleguide> styleguides_list(project_id, opts)
+
+List style guides
+
+List all styleguides for the given 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::StyleGuidesApi.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: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
+}
+
+begin
+ #List style guides
+ result = api_instance.styleguides_list(project_id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling StyleGuidesApi->styleguides_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, 10 by default | [optional]
+
+### Return type
+
+Response<([**Array<Styleguide>**](Styleguide.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/Styleguide.md b/docs/Styleguide.md
new file mode 100644
index 0000000..78a3f72
--- /dev/null
+++ b/docs/Styleguide.md
@@ -0,0 +1,23 @@
+# Phrase::Styleguide
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**title** | **String** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Styleguide.new(id: null,
+ title: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/StyleguideCreate.md b/docs/StyleguideCreate.md
new file mode 100644
index 0000000..6461a76
--- /dev/null
+++ b/docs/StyleguideCreate.md
@@ -0,0 +1,41 @@
+# Phrase::StyleguideCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Style guide title | [optional]
+**audience** | **String** | Audience description | [optional]
+**target_audience** | **String** | Can be one of: not_specified, children, teenager, young_adults, adults, old_adults. | [optional]
+**grammatical_person** | **String** | Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural. | [optional]
+**vocabulary_type** | **String** | Can be one of: not_specified, popular, technical, fictional. | [optional]
+**business** | **String** | Description of the business | [optional]
+**company_branding** | **String** | Company branding to remain consistent. | [optional]
+**formatting** | **String** | Formatting requirements and character limitations. | [optional]
+**glossary_terms** | **String** | List of terms and/or phrases that need to be translated consistently. | [optional]
+**grammar_consistency** | **String** | Formal or informal pronouns, consistent conjugation, grammatical gender | [optional]
+**literal_translation** | **String** | Can be one of: Cultural/Conversational, Literal, Neutral. | [optional]
+**overall_tone** | **String** | Tone requirement descriptions | [optional]
+**samples** | **String** | Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::StyleguideCreate.new(title: Web application style guide,
+ audience: customer-facing,
+ target_audience: teenager,
+ grammatical_person: first_person_singular,
+ vocabulary_type: technical,
+ business: We are a travel site that helps customers find the best hotels and flights.,
+ company_branding: ACME Inc. should never be translated.,
+ formatting: Never use capital letters,
+ glossary_terms: Appartement, cabin, loft,
+ grammar_consistency: null,
+ literal_translation: Neutral,
+ overall_tone: Tone should be fun and light,
+ samples: http://www.myexample.com/my/document/path/to/samples.pdf)
+```
+
+
diff --git a/docs/StyleguidePreview.md b/docs/StyleguidePreview.md
new file mode 100644
index 0000000..2c5e08d
--- /dev/null
+++ b/docs/StyleguidePreview.md
@@ -0,0 +1,19 @@
+# Phrase::StyleguidePreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**title** | **String** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::StyleguidePreview.new(id: null,
+ title: null)
+```
+
+
diff --git a/docs/StyleguideUpdate.md b/docs/StyleguideUpdate.md
new file mode 100644
index 0000000..99d6595
--- /dev/null
+++ b/docs/StyleguideUpdate.md
@@ -0,0 +1,41 @@
+# Phrase::StyleguideUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Style guide title | [optional]
+**audience** | **String** | Audience description | [optional]
+**target_audience** | **String** | Can be one of: not_specified, children, teenager, young_adults, adults, old_adults. | [optional]
+**grammatical_person** | **String** | Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural. | [optional]
+**vocabulary_type** | **String** | Can be one of: not_specified, popular, technical, fictional. | [optional]
+**business** | **String** | Description of the business | [optional]
+**company_branding** | **String** | Company branding to remain consistent. | [optional]
+**formatting** | **String** | Formatting requirements and character limitations. | [optional]
+**glossary_terms** | **String** | List of terms and/or phrases that need to be translated consistently. | [optional]
+**grammar_consistency** | **String** | Formal or informal pronouns, consistent conjugation, grammatical gender | [optional]
+**literal_translation** | **String** | Can be one of: Cultural/Conversational, Literal, Neutral. | [optional]
+**overall_tone** | **String** | Tone requirement descriptions | [optional]
+**samples** | **String** | Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::StyleguideUpdate.new(title: Web application style guide,
+ audience: customer-facing,
+ target_audience: teenager,
+ grammatical_person: first_person_singular,
+ vocabulary_type: technical,
+ business: We are a travel site that helps customers find the best hotels and flights.,
+ company_branding: ACME Inc. should never be translated.,
+ formatting: Never use capital letters,
+ glossary_terms: Appartement, cabin, loft,
+ grammar_consistency: null,
+ literal_translation: Neutral,
+ overall_tone: Tone should be fun and light,
+ samples: http://www.myexample.com/my/document/path/to/samples.pdf)
+```
+
+
diff --git a/docs/Tag.md b/docs/Tag.md
new file mode 100644
index 0000000..9806bdd
--- /dev/null
+++ b/docs/Tag.md
@@ -0,0 +1,23 @@
+# Phrase::Tag
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | | [optional]
+**keys_count** | **Integer** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Tag.new(name: null,
+ keys_count: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/TagCreate.md b/docs/TagCreate.md
new file mode 100644
index 0000000..cf1a20d
--- /dev/null
+++ b/docs/TagCreate.md
@@ -0,0 +1,19 @@
+# Phrase::TagCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**name** | **String** | Name of the tag | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TagCreate.new(branch: my-feature-branch,
+ name: my-feature)
+```
+
+
diff --git a/docs/TagDelete.md b/docs/TagDelete.md
new file mode 100644
index 0000000..8b5bdef
--- /dev/null
+++ b/docs/TagDelete.md
@@ -0,0 +1,17 @@
+# Phrase::TagDelete
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TagDelete.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/TagShow.md b/docs/TagShow.md
new file mode 100644
index 0000000..3355644
--- /dev/null
+++ b/docs/TagShow.md
@@ -0,0 +1,17 @@
+# Phrase::TagShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TagShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/TagsApi.md b/docs/TagsApi.md
new file mode 100644
index 0000000..403970f
--- /dev/null
+++ b/docs/TagsApi.md
@@ -0,0 +1,274 @@
+# Phrase::TagsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**tag_create**](TagsApi.md#tag_create) | **POST** /projects/{project_id}/tags | Create a tag
+[**tag_delete**](TagsApi.md#tag_delete) | **DELETE** /projects/{project_id}/tags/{name} | Delete a tag
+[**tag_show**](TagsApi.md#tag_show) | **GET** /projects/{project_id}/tags/{name} | Get a single tag
+[**tags_list**](TagsApi.md#tags_list) | **GET** /projects/{project_id}/tags | List tags
+
+
+
+## tag_create
+
+> tag_create(project_id, tag_create, opts)
+
+Create a tag
+
+Create a new tag.
+
+### 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::TagsApi.new
+project_id = 'project_id_example' # String | Project ID
+tag_create = Phrase::TagCreate.new # TagCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a tag
+ api_instance.tag_create(project_id, tag_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling TagsApi->tag_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **tag_create** | [**TagCreate**](TagCreate.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
+
+
+## tag_delete
+
+> tag_delete(project_id, name, tag_delete, opts)
+
+Delete a tag
+
+Delete an existing tag.
+
+### 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::TagsApi.new
+project_id = 'project_id_example' # String | Project ID
+name = 'name_example' # String | name
+tag_delete = Phrase::TagDelete.new # TagDelete |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Delete a tag
+ api_instance.tag_delete(project_id, name, tag_delete, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling TagsApi->tag_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **name** | **String**| name |
+ **tag_delete** | [**TagDelete**](TagDelete.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
+
+
+## tag_show
+
+> Object tag_show(project_id, name, tag_show, opts)
+
+Get a single tag
+
+Get details and progress information on a single tag for a given 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::TagsApi.new
+project_id = 'project_id_example' # String | Project ID
+name = 'name_example' # String | name
+tag_show = Phrase::TagShow.new # TagShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Get a single tag
+ result = api_instance.tag_show(project_id, name, tag_show, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TagsApi->tag_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **name** | **String**| name |
+ **tag_show** | [**TagShow**](TagShow.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## tags_list
+
+> Array<Tag> tags_list(project_id, tags_list, opts)
+
+List tags
+
+List all tags for the given 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::TagsApi.new
+project_id = 'project_id_example' # String | Project ID
+tags_list = Phrase::TagsList.new # TagsList |
+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 tags
+ result = api_instance.tags_list(project_id, tags_list, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TagsApi->tags_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **tags_list** | [**TagsList**](TagsList.md)| |
+ **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<Tag>**](Tag.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/TagsList.md b/docs/TagsList.md
new file mode 100644
index 0000000..7e46b3e
--- /dev/null
+++ b/docs/TagsList.md
@@ -0,0 +1,17 @@
+# Phrase::TagsList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TagsList.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/Translation.md b/docs/Translation.md
new file mode 100644
index 0000000..d3bf0c5
--- /dev/null
+++ b/docs/Translation.md
@@ -0,0 +1,37 @@
+# Phrase::Translation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**content** | **String** | | [optional]
+**unverified** | **Boolean** | | [optional]
+**excluded** | **Boolean** | | [optional]
+**plural_suffix** | **String** | | [optional]
+**key** | [**KeyPreview**](KeyPreview.md) | | [optional]
+**locale** | **Object** | | [optional]
+**placeholders** | **Array<String>** | | [optional]
+**state** | **String** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Translation.new(id: null,
+ content: null,
+ unverified: null,
+ excluded: null,
+ plural_suffix: null,
+ key: null,
+ locale: null,
+ placeholders: null,
+ state: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/TranslationCreate.md b/docs/TranslationCreate.md
new file mode 100644
index 0000000..842c50c
--- /dev/null
+++ b/docs/TranslationCreate.md
@@ -0,0 +1,31 @@
+# Phrase::TranslationCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**locale_id** | **String** | Locale. Can be the name or public id of the locale. Preferred is the public id. | [optional]
+**key_id** | **String** | Key | [optional]
+**content** | **String** | Translation content | [optional]
+**plural_suffix** | **String** | Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized. | [optional]
+**unverified** | **String** | Indicates whether translation is unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
+**excluded** | **String** | Indicates whether translation is excluded. | [optional]
+**autotranslate** | **String** | Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationCreate.new(branch: my-feature-branch,
+ locale_id: abcd1234cdef1234abcd1234cdef1234,
+ key_id: abcd1234cdef1234abcd1234cdef1234,
+ content: My translation,
+ plural_suffix: null,
+ unverified: null,
+ excluded: null,
+ autotranslate: null)
+```
+
+
diff --git a/docs/TranslationExclude.md b/docs/TranslationExclude.md
new file mode 100644
index 0000000..8a41854
--- /dev/null
+++ b/docs/TranslationExclude.md
@@ -0,0 +1,17 @@
+# Phrase::TranslationExclude
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationExclude.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/TranslationInclude.md b/docs/TranslationInclude.md
new file mode 100644
index 0000000..48b7422
--- /dev/null
+++ b/docs/TranslationInclude.md
@@ -0,0 +1,17 @@
+# Phrase::TranslationInclude
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationInclude.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/TranslationKey.md b/docs/TranslationKey.md
new file mode 100644
index 0000000..fe00795
--- /dev/null
+++ b/docs/TranslationKey.md
@@ -0,0 +1,33 @@
+# Phrase::TranslationKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**name** | **String** | | [optional]
+**description** | **String** | | [optional]
+**name_hash** | **String** | | [optional]
+**plural** | **Boolean** | | [optional]
+**tags** | **Array<String>** | | [optional]
+**data_type** | **String** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationKey.new(id: null,
+ name: null,
+ description: null,
+ name_hash: null,
+ plural: null,
+ tags: null,
+ data_type: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/TranslationOrder.md b/docs/TranslationOrder.md
new file mode 100644
index 0000000..30dd7d8
--- /dev/null
+++ b/docs/TranslationOrder.md
@@ -0,0 +1,49 @@
+# Phrase::TranslationOrder
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**lsp** | **String** | | [optional]
+**amount_in_cents** | **Integer** | | [optional]
+**currency** | **String** | | [optional]
+**message** | **String** | | [optional]
+**state** | **String** | | [optional]
+**translation_type** | **String** | | [optional]
+**progress_percent** | **Integer** | | [optional]
+**source_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
+**target_locales** | **Array<Object>** | | [optional]
+**tag** | **String** | | [optional]
+**styleguide** | [**StyleguidePreview**](StyleguidePreview.md) | | [optional]
+**unverify_translations_upon_delivery** | **Boolean** | | [optional]
+**quality** | **Boolean** | | [optional]
+**priority** | **Boolean** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationOrder.new(id: null,
+ lsp: null,
+ amount_in_cents: null,
+ currency: null,
+ message: null,
+ state: null,
+ translation_type: null,
+ progress_percent: null,
+ source_locale: null,
+ target_locales: null,
+ tag: null,
+ styleguide: null,
+ unverify_translations_upon_delivery: null,
+ quality: null,
+ priority: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/TranslationReview.md b/docs/TranslationReview.md
new file mode 100644
index 0000000..2dbc1cf
--- /dev/null
+++ b/docs/TranslationReview.md
@@ -0,0 +1,17 @@
+# Phrase::TranslationReview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationReview.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/TranslationShow.md b/docs/TranslationShow.md
new file mode 100644
index 0000000..4002936
--- /dev/null
+++ b/docs/TranslationShow.md
@@ -0,0 +1,17 @@
+# Phrase::TranslationShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/TranslationUnverify.md b/docs/TranslationUnverify.md
new file mode 100644
index 0000000..53efba3
--- /dev/null
+++ b/docs/TranslationUnverify.md
@@ -0,0 +1,17 @@
+# Phrase::TranslationUnverify
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationUnverify.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/TranslationUpdate.md b/docs/TranslationUpdate.md
new file mode 100644
index 0000000..2db7fcb
--- /dev/null
+++ b/docs/TranslationUpdate.md
@@ -0,0 +1,27 @@
+# Phrase::TranslationUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**content** | **String** | Translation content | [optional]
+**plural_suffix** | **String** | Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized. | [optional]
+**unverified** | **String** | Indicates whether translation is unverified. Part of the <a href=\"https://help.phrase.com/help/verification-and-proofreading\" target=\"_blank\">Advanced Workflows</a> feature. | [optional]
+**excluded** | **String** | Indicates whether translation is excluded. | [optional]
+**autotranslate** | **String** | Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationUpdate.new(branch: my-feature-branch,
+ content: My translation,
+ plural_suffix: null,
+ unverified: null,
+ excluded: null,
+ autotranslate: null)
+```
+
+
diff --git a/docs/TranslationVerify.md b/docs/TranslationVerify.md
new file mode 100644
index 0000000..c47e7aa
--- /dev/null
+++ b/docs/TranslationVerify.md
@@ -0,0 +1,17 @@
+# Phrase::TranslationVerify
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationVerify.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/TranslationVersion.md b/docs/TranslationVersion.md
new file mode 100644
index 0000000..7f4c4e0
--- /dev/null
+++ b/docs/TranslationVersion.md
@@ -0,0 +1,31 @@
+# Phrase::TranslationVersion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**content** | **String** | | [optional]
+**plural_suffix** | **String** | | [optional]
+**key** | **Object** | | [optional]
+**locale** | **Object** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+**changed_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationVersion.new(id: null,
+ content: null,
+ plural_suffix: null,
+ key: null,
+ locale: null,
+ created_at: null,
+ updated_at: null,
+ changed_at: null)
+```
+
+
diff --git a/docs/TranslationsApi.md b/docs/TranslationsApi.md
new file mode 100644
index 0000000..a3479de
--- /dev/null
+++ b/docs/TranslationsApi.md
@@ -0,0 +1,1146 @@
+# Phrase::TranslationsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**translation_create**](TranslationsApi.md#translation_create) | **POST** /projects/{project_id}/translations | Create a translation
+[**translation_exclude**](TranslationsApi.md#translation_exclude) | **PATCH** /projects/{project_id}/translations/{id}/exclude | Exclude a translation from export
+[**translation_include**](TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Revoke exclusion of a translation in export
+[**translation_review**](TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
+[**translation_show**](TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
+[**translation_unverify**](TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
+[**translation_update**](TranslationsApi.md#translation_update) | **PATCH** /projects/{project_id}/translations/{id} | Update a translation
+[**translation_verify**](TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
+[**translations_by_key**](TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
+[**translations_by_locale**](TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
+[**translations_exclude**](TranslationsApi.md#translations_exclude) | **PATCH** /projects/{project_id}/translations/exclude | Set exclude from export flag on translations selected by query
+[**translations_include**](TranslationsApi.md#translations_include) | **PATCH** /projects/{project_id}/translations/include | Remove exlude from import flag from translations selected by query
+[**translations_list**](TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
+[**translations_review**](TranslationsApi.md#translations_review) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
+[**translations_search**](TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
+[**translations_unverify**](TranslationsApi.md#translations_unverify) | **PATCH** /projects/{project_id}/translations/unverify | Mark translations selected by query as unverified
+[**translations_verify**](TranslationsApi.md#translations_verify) | **PATCH** /projects/{project_id}/translations/verify | Verify translations selected by query
+
+
+
+## translation_create
+
+> translation_create(project_id, translation_create, opts)
+
+Create a translation
+
+Create a translation.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+translation_create = Phrase::TranslationCreate.new # TranslationCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a translation
+ api_instance.translation_create(project_id, translation_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translation_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translation_create** | [**TranslationCreate**](TranslationCreate.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
+
+
+## translation_exclude
+
+> Object translation_exclude(project_id, id, translation_exclude, opts)
+
+Exclude a translation from export
+
+Set exclude from export flag on an existing translation.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+translation_exclude = Phrase::TranslationExclude.new # TranslationExclude |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Exclude a translation from export
+ result = api_instance.translation_exclude(project_id, id, translation_exclude, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translation_exclude: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **translation_exclude** | [**TranslationExclude**](TranslationExclude.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translation_include
+
+> Object translation_include(project_id, id, translation_include, opts)
+
+Revoke exclusion of a translation in export
+
+Remove exclude from export flag from an existing translation.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+translation_include = Phrase::TranslationInclude.new # TranslationInclude |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Revoke exclusion of a translation in export
+ result = api_instance.translation_include(project_id, id, translation_include, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translation_include: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **translation_include** | [**TranslationInclude**](TranslationInclude.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translation_review
+
+> Object translation_review(project_id, id, translation_review, opts)
+
+Review a translation
+
+Mark an existing translation as reviewed.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+translation_review = Phrase::TranslationReview.new # TranslationReview |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Review a translation
+ result = api_instance.translation_review(project_id, id, translation_review, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translation_review: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **translation_review** | [**TranslationReview**](TranslationReview.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translation_show
+
+> Object translation_show(project_id, id, translation_show, opts)
+
+Get a single translation
+
+Get details on a single translation.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+translation_show = Phrase::TranslationShow.new # TranslationShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Get a single translation
+ result = api_instance.translation_show(project_id, id, translation_show, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translation_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **translation_show** | [**TranslationShow**](TranslationShow.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translation_unverify
+
+> Object translation_unverify(project_id, id, translation_unverify, opts)
+
+Mark a translation as unverified
+
+Mark an existing translation as unverified.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+translation_unverify = Phrase::TranslationUnverify.new # TranslationUnverify |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Mark a translation as unverified
+ result = api_instance.translation_unverify(project_id, id, translation_unverify, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translation_unverify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **translation_unverify** | [**TranslationUnverify**](TranslationUnverify.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translation_update
+
+> Object translation_update(project_id, id, translation_update, opts)
+
+Update a translation
+
+Update an existing translation.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+translation_update = Phrase::TranslationUpdate.new # TranslationUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a translation
+ result = api_instance.translation_update(project_id, id, translation_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translation_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **translation_update** | [**TranslationUpdate**](TranslationUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translation_verify
+
+> Object translation_verify(project_id, id, translation_verify, opts)
+
+Verify a translation
+
+Verify an existing translation.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+translation_verify = Phrase::TranslationVerify.new # TranslationVerify |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Verify a translation
+ result = api_instance.translation_verify(project_id, id, translation_verify, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translation_verify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **translation_verify** | [**TranslationVerify**](TranslationVerify.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_by_key
+
+> Array<Object> translations_by_key(project_id, key_id, translations_by_key, opts)
+
+List translations by key
+
+List translations for a specific key.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+translations_by_key = Phrase::TranslationsByKey.new # TranslationsByKey |
+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 translations by key
+ result = api_instance.translations_by_key(project_id, key_id, translations_by_key, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_by_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **key_id** | **String**| Translation Key ID |
+ **translations_by_key** | [**TranslationsByKey**](TranslationsByKey.md)| |
+ **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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_by_locale
+
+> Array<Object> translations_by_locale(project_id, locale_id, translations_by_locale, opts)
+
+List translations by locale
+
+List translations for a specific locale. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+locale_id = 'locale_id_example' # String | Locale ID
+translations_by_locale = Phrase::TranslationsByLocale.new # TranslationsByLocale |
+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 translations by locale
+ result = api_instance.translations_by_locale(project_id, locale_id, translations_by_locale, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_by_locale: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **locale_id** | **String**| Locale ID |
+ **translations_by_locale** | [**TranslationsByLocale**](TranslationsByLocale.md)| |
+ **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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_exclude
+
+> Object translations_exclude(project_id, translations_exclude, opts)
+
+Set exclude from export flag on translations selected by query
+
+Exclude translations matching query from locale export.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+translations_exclude = Phrase::TranslationsExclude.new # TranslationsExclude |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Set exclude from export flag on translations selected by query
+ result = api_instance.translations_exclude(project_id, translations_exclude, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_exclude: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translations_exclude** | [**TranslationsExclude**](TranslationsExclude.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_include
+
+> Object translations_include(project_id, translations_include, opts)
+
+Remove exlude from import flag from translations selected by query
+
+Include translations matching query in locale export.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+translations_include = Phrase::TranslationsInclude.new # TranslationsInclude |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Remove exlude from import flag from translations selected by query
+ result = api_instance.translations_include(project_id, translations_include, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_include: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translations_include** | [**TranslationsInclude**](TranslationsInclude.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_list
+
+> Array<Translation> translations_list(project_id, translations_list, opts)
+
+List all translations
+
+List translations for the given project. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+translations_list = Phrase::TranslationsList.new # TranslationsList |
+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 all translations
+ result = api_instance.translations_list(project_id, translations_list, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translations_list** | [**TranslationsList**](TranslationsList.md)| |
+ **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<Translation>**](Translation.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_review
+
+> Object translations_review(project_id, translations_review, opts)
+
+Review translations selected by query
+
+Review translations matching query.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+translations_review = Phrase::TranslationsReview.new # TranslationsReview |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Review translations selected by query
+ result = api_instance.translations_review(project_id, translations_review, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_review: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translations_review** | [**TranslationsReview**](TranslationsReview.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_search
+
+> Array<Object> translations_search(project_id, translations_search, opts)
+
+Search translations
+
+Search translations for the given project. Provides the same search interface as translations#index but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+translations_search = Phrase::TranslationsSearch.new # TranslationsSearch |
+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
+ #Search translations
+ result = api_instance.translations_search(project_id, translations_search, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_search: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translations_search** | [**TranslationsSearch**](TranslationsSearch.md)| |
+ **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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_unverify
+
+> Object translations_unverify(project_id, translations_unverify, opts)
+
+Mark translations selected by query as unverified
+
+Mark translations matching query as unverified.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+translations_unverify = Phrase::TranslationsUnverify.new # TranslationsUnverify |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Mark translations selected by query as unverified
+ result = api_instance.translations_unverify(project_id, translations_unverify, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_unverify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translations_unverify** | [**TranslationsUnverify**](TranslationsUnverify.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## translations_verify
+
+> AffectedCount translations_verify(project_id, translations_verify, opts)
+
+Verify translations selected by query
+
+Verify translations matching query.
+
+### 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::TranslationsApi.new
+project_id = 'project_id_example' # String | Project ID
+translations_verify = Phrase::TranslationsVerify.new # TranslationsVerify |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Verify translations selected by query
+ result = api_instance.translations_verify(project_id, translations_verify, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling TranslationsApi->translations_verify: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translations_verify** | [**TranslationsVerify**](TranslationsVerify.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<([**AffectedCount**](AffectedCount.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/TranslationsByKey.md b/docs/TranslationsByKey.md
new file mode 100644
index 0000000..fd6e38c
--- /dev/null
+++ b/docs/TranslationsByKey.md
@@ -0,0 +1,23 @@
+# Phrase::TranslationsByKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsByKey.new(branch: my-feature-branch,
+ sort: updated_at,
+ order: desc,
+ q: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center)
+```
+
+
diff --git a/docs/TranslationsByLocale.md b/docs/TranslationsByLocale.md
new file mode 100644
index 0000000..b5ab37a
--- /dev/null
+++ b/docs/TranslationsByLocale.md
@@ -0,0 +1,23 @@
+# Phrase::TranslationsByLocale
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsByLocale.new(branch: my-feature-branch,
+ sort: updated_at,
+ order: desc,
+ q: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center)
+```
+
+
diff --git a/docs/TranslationsExclude.md b/docs/TranslationsExclude.md
new file mode 100644
index 0000000..e07fa39
--- /dev/null
+++ b/docs/TranslationsExclude.md
@@ -0,0 +1,23 @@
+# Phrase::TranslationsExclude
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsExclude.new(branch: my-feature-branch,
+ q: PhraseApp*%20verified:true%20tags:feature,center,
+ sort: updated_at,
+ order: desc)
+```
+
+
diff --git a/docs/TranslationsInclude.md b/docs/TranslationsInclude.md
new file mode 100644
index 0000000..8008cd6
--- /dev/null
+++ b/docs/TranslationsInclude.md
@@ -0,0 +1,23 @@
+# Phrase::TranslationsInclude
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsInclude.new(branch: my-feature-branch,
+ q: PhraseApp*%20verified:true%20tags:feature,center,
+ sort: updated_at,
+ order: desc)
+```
+
+
diff --git a/docs/TranslationsList.md b/docs/TranslationsList.md
new file mode 100644
index 0000000..9510fd5
--- /dev/null
+++ b/docs/TranslationsList.md
@@ -0,0 +1,23 @@
+# Phrase::TranslationsList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsList.new(branch: my-feature-branch,
+ sort: updated_at,
+ order: desc,
+ q: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center)
+```
+
+
diff --git a/docs/TranslationsReview.md b/docs/TranslationsReview.md
new file mode 100644
index 0000000..9f35835
--- /dev/null
+++ b/docs/TranslationsReview.md
@@ -0,0 +1,19 @@
+# Phrase::TranslationsReview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsReview.new(branch: my-feature-branch,
+ q: PhraseApp*%reviewed:false%20tags:feature,center)
+```
+
+
diff --git a/docs/TranslationsSearch.md b/docs/TranslationsSearch.md
new file mode 100644
index 0000000..b8a2add
--- /dev/null
+++ b/docs/TranslationsSearch.md
@@ -0,0 +1,23 @@
+# Phrase::TranslationsSearch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsSearch.new(branch: my-feature-branch,
+ sort: updated_at,
+ order: desc,
+ q: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center)
+```
+
+
diff --git a/docs/TranslationsUnverify.md b/docs/TranslationsUnverify.md
new file mode 100644
index 0000000..c7078ba
--- /dev/null
+++ b/docs/TranslationsUnverify.md
@@ -0,0 +1,23 @@
+# Phrase::TranslationsUnverify
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsUnverify.new(branch: my-feature-branch,
+ q: PhraseApp*%20verified:true%20tags:feature,center,
+ sort: updated_at,
+ order: desc)
+```
+
+
diff --git a/docs/TranslationsVerify.md b/docs/TranslationsVerify.md
new file mode 100644
index 0000000..77927b6
--- /dev/null
+++ b/docs/TranslationsVerify.md
@@ -0,0 +1,23 @@
+# Phrase::TranslationsVerify
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**q** | **String** | q_description_placeholder | [optional]
+**sort** | **String** | Sort criteria. Can be one of: key_name, created_at, updated_at. | [optional]
+**order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::TranslationsVerify.new(branch: my-feature-branch,
+ q: PhraseApp*%20unverified:true%20tags:feature,center,
+ sort: updated_at,
+ order: desc)
+```
+
+
diff --git a/docs/Upload.md b/docs/Upload.md
new file mode 100644
index 0000000..2ec6c43
--- /dev/null
+++ b/docs/Upload.md
@@ -0,0 +1,31 @@
+# Phrase::Upload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**filename** | **String** | | [optional]
+**format** | **String** | | [optional]
+**state** | **String** | | [optional]
+**tag** | **String** | | [optional]
+**summary** | [**UploadSummary**](UploadSummary.md) | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Upload.new(id: null,
+ filename: null,
+ format: null,
+ state: null,
+ tag: null,
+ summary: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/UploadCreate.md b/docs/UploadCreate.md
new file mode 100644
index 0000000..a719378
--- /dev/null
+++ b/docs/UploadCreate.md
@@ -0,0 +1,45 @@
+# Phrase::UploadCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+**file** | **String** | File to be imported | [optional]
+**file_format** | **String** | File format. Auto-detected when possible and not specified. | [optional]
+**locale_id** | **String** | Locale of the file's content. Can be the name or public id of the locale. Preferred is the public id. | [optional]
+**tags** | **String** | List of tags separated by comma to be associated with the new keys contained in the upload. | [optional]
+**update_translations** | **String** | Indicates whether existing translations should be updated with the file content. | [optional]
+**update_descriptions** | **String** | Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions. | [optional]
+**convert_emoji** | **String** | This option is obsolete. Providing the option will cause a bad request error. | [optional]
+**skip_upload_tags** | **String** | Indicates whether the upload should not create upload tags. | [optional]
+**skip_unverification** | **String** | Indicates whether the upload should unverify updated translations. | [optional]
+**file_encoding** | **String** | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | [optional]
+**locale_mapping** | **String** | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. | [optional]
+**format_options** | **String** | Additional options available for specific formats. See our format guide for complete list. | [optional]
+**autotranslate** | **String** | If set, translations for the uploaded language will be fetched automatically. | [optional]
+**mark_reviewed** | **String** | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project. | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::UploadCreate.new(branch: my-feature-branch,
+ file: /path/to/my/file.json,
+ file_format: json,
+ locale_id: abcd1234cdef1234abcd1234cdef1234,
+ tags: awesome-feature,needs-proofreading,
+ update_translations: null,
+ update_descriptions: null,
+ convert_emoji: null,
+ skip_upload_tags: null,
+ skip_unverification: null,
+ file_encoding: null,
+ locale_mapping: {"en": "2"},
+ format_options: {"foo": "bar"},
+ autotranslate: null,
+ mark_reviewed: null)
+```
+
+
diff --git a/docs/UploadShow.md b/docs/UploadShow.md
new file mode 100644
index 0000000..b9715a8
--- /dev/null
+++ b/docs/UploadShow.md
@@ -0,0 +1,17 @@
+# Phrase::UploadShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::UploadShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/UploadSummary.md b/docs/UploadSummary.md
new file mode 100644
index 0000000..30cf51c
--- /dev/null
+++ b/docs/UploadSummary.md
@@ -0,0 +1,31 @@
+# Phrase::UploadSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locales_created** | **Integer** | | [optional]
+**translation_keys_created** | **Integer** | | [optional]
+**translation_keys_updated** | **Integer** | | [optional]
+**translation_keys_unmentioned** | **Integer** | | [optional]
+**translations_created** | **Integer** | | [optional]
+**translations_updated** | **Integer** | | [optional]
+**tags_created** | **Integer** | | [optional]
+**translation_keys_ignored** | **Integer** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::UploadSummary.new(locales_created: null,
+ translation_keys_created: null,
+ translation_keys_updated: null,
+ translation_keys_unmentioned: null,
+ translations_created: null,
+ translations_updated: null,
+ tags_created: null,
+ translation_keys_ignored: null)
+```
+
+
diff --git a/docs/UploadsApi.md b/docs/UploadsApi.md
new file mode 100644
index 0000000..dc53e1d
--- /dev/null
+++ b/docs/UploadsApi.md
@@ -0,0 +1,208 @@
+# Phrase::UploadsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**upload_create**](UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
+[**upload_show**](UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | View upload details
+[**uploads_list**](UploadsApi.md#uploads_list) | **GET** /projects/{project_id}/uploads | List uploads
+
+
+
+## upload_create
+
+> upload_create(project_id, upload_create, opts)
+
+Upload a new file
+
+Upload a new language file. Creates necessary resources in your 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::UploadsApi.new
+project_id = 'project_id_example' # String | Project ID
+upload_create = Phrase::UploadCreate.new # UploadCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Upload a new file
+ api_instance.upload_create(project_id, upload_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling UploadsApi->upload_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **upload_create** | [**UploadCreate**](UploadCreate.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
+
+
+## upload_show
+
+> Upload upload_show(project_id, id, upload_show, opts)
+
+View upload details
+
+View details and summary for a single upload.
+
+### 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::UploadsApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+upload_show = Phrase::UploadShow.new # UploadShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #View upload details
+ result = api_instance.upload_show(project_id, id, upload_show, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling UploadsApi->upload_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **upload_show** | [**UploadShow**](UploadShow.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<([**Upload**](Upload.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## uploads_list
+
+> Array<Object> uploads_list(project_id, uploads_list, opts)
+
+List uploads
+
+List all uploads for the given 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::UploadsApi.new
+project_id = 'project_id_example' # String | Project ID
+uploads_list = Phrase::UploadsList.new # UploadsList |
+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 uploads
+ result = api_instance.uploads_list(project_id, uploads_list, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling UploadsApi->uploads_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **uploads_list** | [**UploadsList**](UploadsList.md)| |
+ **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<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/UploadsList.md b/docs/UploadsList.md
new file mode 100644
index 0000000..eac72fc
--- /dev/null
+++ b/docs/UploadsList.md
@@ -0,0 +1,17 @@
+# Phrase::UploadsList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::UploadsList.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/User.md b/docs/User.md
new file mode 100644
index 0000000..93b5e3d
--- /dev/null
+++ b/docs/User.md
@@ -0,0 +1,29 @@
+# Phrase::User
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**username** | **String** | | [optional]
+**name** | **String** | | [optional]
+**email** | **String** | | [optional]
+**position** | **String** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::User.new(id: null,
+ username: null,
+ name: null,
+ email: null,
+ position: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/UserPreview.md b/docs/UserPreview.md
new file mode 100644
index 0000000..379b64d
--- /dev/null
+++ b/docs/UserPreview.md
@@ -0,0 +1,21 @@
+# Phrase::UserPreview
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**username** | **String** | | [optional]
+**name** | **String** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::UserPreview.new(id: null,
+ username: null,
+ name: null)
+```
+
+
diff --git a/docs/UsersApi.md b/docs/UsersApi.md
new file mode 100644
index 0000000..fb912a6
--- /dev/null
+++ b/docs/UsersApi.md
@@ -0,0 +1,69 @@
+# Phrase::UsersApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**show_user**](UsersApi.md#show_user) | **GET** /user | Show current User
+
+
+
+## show_user
+
+> User show_user(opts)
+
+Show current User
+
+Show details for current User.
+
+### 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::UsersApi.new
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Show current User
+ result = api_instance.show_user(opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling UsersApi->show_user: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<([**User**](User.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/docs/VersionShow.md b/docs/VersionShow.md
new file mode 100644
index 0000000..771a250
--- /dev/null
+++ b/docs/VersionShow.md
@@ -0,0 +1,17 @@
+# Phrase::VersionShow
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::VersionShow.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/VersionsHistoryApi.md b/docs/VersionsHistoryApi.md
new file mode 100644
index 0000000..195a5f1
--- /dev/null
+++ b/docs/VersionsHistoryApi.md
@@ -0,0 +1,148 @@
+# Phrase::VersionsHistoryApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**version_show**](VersionsHistoryApi.md#version_show) | **GET** /projects/{project_id}/translations/{translation_id}/versions/{id} | Get a single version
+[**versions_list**](VersionsHistoryApi.md#versions_list) | **GET** /projects/{project_id}/translations/{translation_id}/versions | List all versions
+
+
+
+## version_show
+
+> Object version_show(project_id, translation_id, id, version_show, opts)
+
+Get a single version
+
+Get details on a single version.
+
+### 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::VersionsHistoryApi.new
+project_id = 'project_id_example' # String | Project ID
+translation_id = 'translation_id_example' # String | Translation ID
+id = 'id_example' # String | ID
+version_show = Phrase::VersionShow.new # VersionShow |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Get a single version
+ result = api_instance.version_show(project_id, translation_id, id, version_show, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling VersionsHistoryApi->version_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translation_id** | **String**| Translation ID |
+ **id** | **String**| ID |
+ **version_show** | [**VersionShow**](VersionShow.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## versions_list
+
+> Array<TranslationVersion> versions_list(project_id, translation_id, versions_list, opts)
+
+List all versions
+
+List all versions for the given translation.
+
+### 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::VersionsHistoryApi.new
+project_id = 'project_id_example' # String | Project ID
+translation_id = 'translation_id_example' # String | Translation ID
+versions_list = Phrase::VersionsList.new # VersionsList |
+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 all versions
+ result = api_instance.versions_list(project_id, translation_id, versions_list, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling VersionsHistoryApi->versions_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **translation_id** | **String**| Translation ID |
+ **versions_list** | [**VersionsList**](VersionsList.md)| |
+ **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<TranslationVersion>**](TranslationVersion.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
diff --git a/docs/VersionsList.md b/docs/VersionsList.md
new file mode 100644
index 0000000..235ec76
--- /dev/null
+++ b/docs/VersionsList.md
@@ -0,0 +1,17 @@
+# Phrase::VersionsList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**branch** | **String** | specify the branch to use | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::VersionsList.new(branch: my-feature-branch)
+```
+
+
diff --git a/docs/Webhook.md b/docs/Webhook.md
new file mode 100644
index 0000000..f7ed8ff
--- /dev/null
+++ b/docs/Webhook.md
@@ -0,0 +1,29 @@
+# Phrase::Webhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | | [optional]
+**callback_url** | **String** | | [optional]
+**description** | **String** | | [optional]
+**events** | **Array<String>** | | [optional]
+**active** | **Boolean** | | [optional]
+**created_at** | **DateTime** | | [optional]
+**updated_at** | **DateTime** | | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::Webhook.new(id: null,
+ callback_url: null,
+ description: null,
+ events: null,
+ active: null,
+ created_at: null,
+ updated_at: null)
+```
+
+
diff --git a/docs/WebhookCreate.md b/docs/WebhookCreate.md
new file mode 100644
index 0000000..0b89f57
--- /dev/null
+++ b/docs/WebhookCreate.md
@@ -0,0 +1,23 @@
+# Phrase::WebhookCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**callback_url** | **String** | Callback URL to send requests to | [optional]
+**description** | **String** | Webhook description | [optional]
+**events** | **String** | List of event names to trigger the webhook (separated by comma) | [optional]
+**active** | **String** | Whether webhook is active or inactive | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::WebhookCreate.new(callback_url: http://example.com/hooks/phraseapp-notifications,
+ description: My webhook for chat notifications,
+ events: locales:create,translations:update,
+ active: null)
+```
+
+
diff --git a/docs/WebhookUpdate.md b/docs/WebhookUpdate.md
new file mode 100644
index 0000000..1c8b0f2
--- /dev/null
+++ b/docs/WebhookUpdate.md
@@ -0,0 +1,23 @@
+# Phrase::WebhookUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**callback_url** | **String** | Callback URL to send requests to | [optional]
+**description** | **String** | Webhook description | [optional]
+**events** | **String** | List of event names to trigger the webhook (separated by comma) | [optional]
+**active** | **String** | Whether webhook is active or inactive | [optional]
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::WebhookUpdate.new(callback_url: http://example.com/hooks/phraseapp-notifications,
+ description: My webhook for chat notifications,
+ events: locales:create,translations:update,
+ active: null)
+```
+
+
diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md
new file mode 100644
index 0000000..fa3fcdb
--- /dev/null
+++ b/docs/WebhooksApi.md
@@ -0,0 +1,399 @@
+# Phrase::WebhooksApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**webhook_create**](WebhooksApi.md#webhook_create) | **POST** /projects/{project_id}/webhooks | Create a webhook
+[**webhook_delete**](WebhooksApi.md#webhook_delete) | **DELETE** /projects/{project_id}/webhooks/{id} | Delete a webhook
+[**webhook_show**](WebhooksApi.md#webhook_show) | **GET** /projects/{project_id}/webhooks/{id} | Get a single webhook
+[**webhook_test**](WebhooksApi.md#webhook_test) | **POST** /projects/{project_id}/webhooks/{id}/test | Test a webhook
+[**webhook_update**](WebhooksApi.md#webhook_update) | **PATCH** /projects/{project_id}/webhooks/{id} | Update a webhook
+[**webhooks_list**](WebhooksApi.md#webhooks_list) | **GET** /projects/{project_id}/webhooks | List webhooks
+
+
+
+## webhook_create
+
+> webhook_create(project_id, webhook_create, opts)
+
+Create a webhook
+
+Create a new webhook.
+
+### 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::WebhooksApi.new
+project_id = 'project_id_example' # String | Project ID
+webhook_create = Phrase::WebhookCreate.new # WebhookCreate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Create a webhook
+ api_instance.webhook_create(project_id, webhook_create, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling WebhooksApi->webhook_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **webhook_create** | [**WebhookCreate**](WebhookCreate.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
+
+
+## webhook_delete
+
+> webhook_delete(project_id, id, opts)
+
+Delete a webhook
+
+Delete an existing webhook.
+
+### 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::WebhooksApi.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 a webhook
+ api_instance.webhook_delete(project_id, id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling WebhooksApi->webhook_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
+
+
+## webhook_show
+
+> Webhook webhook_show(project_id, id, opts)
+
+Get a single webhook
+
+Get details on a single webhook.
+
+### 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::WebhooksApi.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
+ #Get a single webhook
+ result = api_instance.webhook_show(project_id, id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling WebhooksApi->webhook_show: #{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<([**Webhook**](Webhook.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## webhook_test
+
+> webhook_test(project_id, id, opts)
+
+Test a webhook
+
+Perform a test request for a webhook.
+
+### 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::WebhooksApi.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
+ #Test a webhook
+ api_instance.webhook_test(project_id, id, opts)
+rescue Phrase::ApiError => e
+ puts "Exception when calling WebhooksApi->webhook_test: #{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
+
+
+## webhook_update
+
+> Object webhook_update(project_id, id, webhook_update, opts)
+
+Update a webhook
+
+Update an existing webhook.
+
+### 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::WebhooksApi.new
+project_id = 'project_id_example' # String | Project ID
+id = 'id_example' # String | ID
+webhook_update = Phrase::WebhookUpdate.new # WebhookUpdate |
+opts = {
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+ #Update a webhook
+ result = api_instance.webhook_update(project_id, id, webhook_update, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling WebhooksApi->webhook_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID |
+ **id** | **String**| ID |
+ **webhook_update** | [**WebhookUpdate**](WebhookUpdate.md)| |
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## webhooks_list
+
+> Array<Object> webhooks_list(project_id, opts)
+
+List webhooks
+
+List all webhooks for the given 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::WebhooksApi.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: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
+}
+
+begin
+ #List webhooks
+ result = api_instance.webhooks_list(project_id, opts)
+ pp result
+rescue Phrase::ApiError => e
+ puts "Exception when calling WebhooksApi->webhooks_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, 10 by default | [optional]
+
+### Return type
+
+Response<(**Array<Object>**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
diff --git a/git_push.sh b/git_push.sh
new file mode 100644
index 0000000..ced3be2
--- /dev/null
+++ b/git_push.sh
@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+ git_host="github.com"
+ echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+ git_user_id="GIT_USER_ID"
+ echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+ git_repo_id="GIT_REPO_ID"
+ echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+ release_note="Minor update"
+ echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+ if [ "$GIT_TOKEN" = "" ]; then
+ echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+ git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+ else
+ git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+ fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+
diff --git a/lib/Phrase.rb b/lib/Phrase.rb
new file mode 100644
index 0000000..c224e7a
--- /dev/null
+++ b/lib/Phrase.rb
@@ -0,0 +1,263 @@
+require 'link-header-parser'
+
+# Common files
+require 'Phrase/api_client'
+require 'Phrase/api_error'
+require 'Phrase/version'
+require 'Phrase/configuration'
+
+# Models
+require 'Phrase/models/account'
+require 'Phrase/models/affected_count'
+require 'Phrase/models/affected_resources'
+require 'Phrase/models/authorization'
+require 'Phrase/models/authorization_create'
+require 'Phrase/models/authorization_update'
+require 'Phrase/models/bitbucket_sync'
+require 'Phrase/models/bitbucket_sync_export'
+require 'Phrase/models/bitbucket_sync_export_response'
+require 'Phrase/models/bitbucket_sync_import'
+require 'Phrase/models/bitbucket_syncs_list'
+require 'Phrase/models/blacklisted_key'
+require 'Phrase/models/blacklisted_key_create'
+require 'Phrase/models/blacklisted_key_update'
+require 'Phrase/models/branch'
+require 'Phrase/models/branch_compare'
+require 'Phrase/models/branch_create'
+require 'Phrase/models/branch_merge'
+require 'Phrase/models/branch_update'
+require 'Phrase/models/comment'
+require 'Phrase/models/comment_create'
+require 'Phrase/models/comment_delete'
+require 'Phrase/models/comment_mark_check'
+require 'Phrase/models/comment_mark_read'
+require 'Phrase/models/comment_mark_unread'
+require 'Phrase/models/comment_show'
+require 'Phrase/models/comment_update'
+require 'Phrase/models/comments_list'
+require 'Phrase/models/distribution'
+require 'Phrase/models/distribution_create'
+require 'Phrase/models/distribution_preview'
+require 'Phrase/models/distribution_update'
+require 'Phrase/models/errors'
+require 'Phrase/models/errors_errors'
+require 'Phrase/models/format'
+require 'Phrase/models/gitlab_sync'
+require 'Phrase/models/gitlab_sync_delete'
+require 'Phrase/models/gitlab_sync_export'
+require 'Phrase/models/gitlab_sync_export1'
+require 'Phrase/models/gitlab_sync_history'
+require 'Phrase/models/gitlab_sync_history1'
+require 'Phrase/models/gitlab_sync_import'
+require 'Phrase/models/gitlab_sync_list'
+require 'Phrase/models/gitlab_sync_show'
+require 'Phrase/models/gitlab_sync_update'
+require 'Phrase/models/glossary'
+require 'Phrase/models/glossary_create'
+require 'Phrase/models/glossary_term'
+require 'Phrase/models/glossary_term_create'
+require 'Phrase/models/glossary_term_translation'
+require 'Phrase/models/glossary_term_translation_create'
+require 'Phrase/models/glossary_term_translation_update'
+require 'Phrase/models/glossary_term_update'
+require 'Phrase/models/glossary_update'
+require 'Phrase/models/invitation'
+require 'Phrase/models/invitation_create'
+require 'Phrase/models/invitation_update'
+require 'Phrase/models/job'
+require 'Phrase/models/job_complete'
+require 'Phrase/models/job_create'
+require 'Phrase/models/job_delete'
+require 'Phrase/models/job_keys_create'
+require 'Phrase/models/job_keys_delete'
+require 'Phrase/models/job_locale'
+require 'Phrase/models/job_locale_complete'
+require 'Phrase/models/job_locale_delete'
+require 'Phrase/models/job_locale_reopen'
+require 'Phrase/models/job_locale_show'
+require 'Phrase/models/job_locale_update'
+require 'Phrase/models/job_locales_create'
+require 'Phrase/models/job_locales_list'
+require 'Phrase/models/job_preview'
+require 'Phrase/models/job_reopen'
+require 'Phrase/models/job_show'
+require 'Phrase/models/job_start'
+require 'Phrase/models/job_update'
+require 'Phrase/models/jobs_list'
+require 'Phrase/models/key_create'
+require 'Phrase/models/key_delete'
+require 'Phrase/models/key_preview'
+require 'Phrase/models/key_show'
+require 'Phrase/models/key_update'
+require 'Phrase/models/keys_delete'
+require 'Phrase/models/keys_list'
+require 'Phrase/models/keys_search'
+require 'Phrase/models/keys_tag'
+require 'Phrase/models/keys_untag'
+require 'Phrase/models/locale'
+require 'Phrase/models/locale_create'
+require 'Phrase/models/locale_delete'
+require 'Phrase/models/locale_download'
+require 'Phrase/models/locale_preview'
+require 'Phrase/models/locale_show'
+require 'Phrase/models/locale_update'
+require 'Phrase/models/locales_list'
+require 'Phrase/models/member'
+require 'Phrase/models/member_update'
+require 'Phrase/models/order_confirm'
+require 'Phrase/models/order_create'
+require 'Phrase/models/order_delete'
+require 'Phrase/models/order_show'
+require 'Phrase/models/orders_list'
+require 'Phrase/models/project'
+require 'Phrase/models/project_create'
+require 'Phrase/models/project_short'
+require 'Phrase/models/project_update'
+require 'Phrase/models/release'
+require 'Phrase/models/release_create'
+require 'Phrase/models/release_preview'
+require 'Phrase/models/release_update'
+require 'Phrase/models/screenshot'
+require 'Phrase/models/screenshot_create'
+require 'Phrase/models/screenshot_marker'
+require 'Phrase/models/screenshot_marker_create'
+require 'Phrase/models/screenshot_marker_update'
+require 'Phrase/models/screenshot_update'
+require 'Phrase/models/space'
+require 'Phrase/models/space_create'
+require 'Phrase/models/space_update'
+require 'Phrase/models/spaces_projects_create'
+require 'Phrase/models/styleguide'
+require 'Phrase/models/styleguide_create'
+require 'Phrase/models/styleguide_preview'
+require 'Phrase/models/styleguide_update'
+require 'Phrase/models/tag'
+require 'Phrase/models/tag_create'
+require 'Phrase/models/tag_delete'
+require 'Phrase/models/tag_show'
+require 'Phrase/models/tags_list'
+require 'Phrase/models/translation'
+require 'Phrase/models/translation_create'
+require 'Phrase/models/translation_exclude'
+require 'Phrase/models/translation_include'
+require 'Phrase/models/translation_key'
+require 'Phrase/models/translation_order'
+require 'Phrase/models/translation_review'
+require 'Phrase/models/translation_show'
+require 'Phrase/models/translation_unverify'
+require 'Phrase/models/translation_update'
+require 'Phrase/models/translation_verify'
+require 'Phrase/models/translation_version'
+require 'Phrase/models/translations_by_key'
+require 'Phrase/models/translations_by_locale'
+require 'Phrase/models/translations_exclude'
+require 'Phrase/models/translations_include'
+require 'Phrase/models/translations_list'
+require 'Phrase/models/translations_review'
+require 'Phrase/models/translations_search'
+require 'Phrase/models/translations_unverify'
+require 'Phrase/models/translations_verify'
+require 'Phrase/models/upload'
+require 'Phrase/models/upload_create'
+require 'Phrase/models/upload_show'
+require 'Phrase/models/upload_summary'
+require 'Phrase/models/uploads_list'
+require 'Phrase/models/user'
+require 'Phrase/models/user_preview'
+require 'Phrase/models/version_show'
+require 'Phrase/models/versions_list'
+require 'Phrase/models/webhook'
+require 'Phrase/models/webhook_create'
+require 'Phrase/models/webhook_update'
+
+# APIs
+require 'Phrase/api/accounts_api'
+require 'Phrase/api/authorizations_api'
+require 'Phrase/api/bitbucket_sync_api'
+require 'Phrase/api/blacklisted_keys_api'
+require 'Phrase/api/branches_api'
+require 'Phrase/api/comments_api'
+require 'Phrase/api/distributions_api'
+require 'Phrase/api/formats_api'
+require 'Phrase/api/git_lab_sync_api'
+require 'Phrase/api/glossary_api'
+require 'Phrase/api/glossary_term_translations_api'
+require 'Phrase/api/glossary_terms_api'
+require 'Phrase/api/invitations_api'
+require 'Phrase/api/job_locales_api'
+require 'Phrase/api/jobs_api'
+require 'Phrase/api/keys_api'
+require 'Phrase/api/locales_api'
+require 'Phrase/api/members_api'
+require 'Phrase/api/orders_api'
+require 'Phrase/api/projects_api'
+require 'Phrase/api/releases_api'
+require 'Phrase/api/screenshot_markers_api'
+require 'Phrase/api/screenshots_api'
+require 'Phrase/api/spaces_api'
+require 'Phrase/api/style_guides_api'
+require 'Phrase/api/tags_api'
+require 'Phrase/api/translations_api'
+require 'Phrase/api/uploads_api'
+require 'Phrase/api/users_api'
+require 'Phrase/api/versions_history_api'
+require 'Phrase/api/webhooks_api'
+
+module Phrase
+ class Response
+ attr_reader :data
+
+ def initialize(data, headers)
+ @data = data
+ @paginated = false
+ @next_page = nil
+
+ link_headers = headers["link"]
+ if link_headers
+ @paginated = true
+ parsed_links = LinkHeaderParser.parse(link_headers, base: 'https://api.phrase.com').by_relation_type
+ next_page_link = parsed_links[:next]&.first
+ if next_page_link
+ @next_page = CGI.parse(URI.parse(next_page_link.target_uri).query)["page"]&.first&.to_i
+ end
+ end
+ end
+
+ def method_missing(method, *args, &block)
+ if data.respond_to?(method)
+ data.send(method, *args, &block)
+ else
+ super
+ end
+ end
+
+ def next_page
+ @next_page
+ end
+
+ def next_page?
+ paginated? && !next_page.nil?
+ end
+
+ def paginated?
+ @paginated
+ end
+ end
+
+
+ class << self
+ # Customize default settings for the SDK using block.
+ # Phrase.configure do |config|
+ # config.username = "xxx"
+ # config.password = "xxx"
+ # end
+ # If no block given, return the default Configuration object.
+ def configure
+ if block_given?
+ yield(Configuration.default)
+ else
+ Configuration.default
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/api/accounts_api.rb b/lib/Phrase/api/accounts_api.rb
new file mode 100644
index 0000000..969a114
--- /dev/null
+++ b/lib/Phrase/api/accounts_api.rb
@@ -0,0 +1,142 @@
+require 'cgi'
+
+module Phrase
+ class AccountsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Get a single account
+ # Get details on a single account.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Account]
+ def account_show(id, opts = {})
+ data, _status_code, _headers = account_show_with_http_info(id, opts)
+ data
+ end
+
+ # Get a single account
+ # Get details on a single account.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Account)>, Integer, Hash)>] Response<(Account)> data, response status code and response headers
+ def account_show_with_http_info(id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: AccountsApi.account_show ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.account_show"
+ end
+ # resource path
+ local_var_path = '/accounts/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Account'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: AccountsApi#account_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List accounts
+ # List all accounts the current user has access to.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def accounts_list(opts = {})
+ data, _status_code, _headers = accounts_list_with_http_info(opts)
+ data
+ end
+
+ # List accounts
+ # List all accounts the current user has access to.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def accounts_list_with_http_info(opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: AccountsApi.accounts_list ...'
+ end
+ # resource path
+ local_var_path = '/accounts'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: AccountsApi#accounts_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/authorizations_api.rb b/lib/Phrase/api/authorizations_api.rb
new file mode 100644
index 0000000..6436eab
--- /dev/null
+++ b/lib/Phrase/api/authorizations_api.rb
@@ -0,0 +1,346 @@
+require 'cgi'
+
+module Phrase
+ class AuthorizationsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create an authorization
+ # Create a new authorization.
+ # @param authorization_create [AuthorizationCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def authorization_create(authorization_create, opts = {})
+ authorization_create_with_http_info(authorization_create, opts)
+ nil
+ end
+
+ # Create an authorization
+ # Create a new authorization.
+ # @param authorization_create [AuthorizationCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def authorization_create_with_http_info(authorization_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: AuthorizationsApi.authorization_create ...'
+ end
+ # verify the required parameter 'authorization_create' is set
+ if @api_client.config.client_side_validation && authorization_create.nil?
+ fail ArgumentError, "Missing the required parameter 'authorization_create' when calling AuthorizationsApi.authorization_create"
+ end
+ # resource path
+ local_var_path = '/authorizations'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(authorization_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: AuthorizationsApi#authorization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete an authorization
+ # Delete an existing authorization. API calls using that token will stop working.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def authorization_delete(id, opts = {})
+ authorization_delete_with_http_info(id, opts)
+ nil
+ end
+
+ # Delete an authorization
+ # Delete an existing authorization. API calls using that token will stop working.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def authorization_delete_with_http_info(id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: AuthorizationsApi.authorization_delete ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling AuthorizationsApi.authorization_delete"
+ end
+ # resource path
+ local_var_path = '/authorizations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: AuthorizationsApi#authorization_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single authorization
+ # Get details on a single authorization.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Authorization]
+ def authorization_show(id, opts = {})
+ data, _status_code, _headers = authorization_show_with_http_info(id, opts)
+ data
+ end
+
+ # Get a single authorization
+ # Get details on a single authorization.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Authorization)>, Integer, Hash)>] Response<(Authorization)> data, response status code and response headers
+ def authorization_show_with_http_info(id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: AuthorizationsApi.authorization_show ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling AuthorizationsApi.authorization_show"
+ end
+ # resource path
+ local_var_path = '/authorizations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Authorization'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: AuthorizationsApi#authorization_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update an authorization
+ # Update an existing authorization.
+ # @param id [String] ID
+ # @param authorization_update [AuthorizationUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def authorization_update(id, authorization_update, opts = {})
+ data, _status_code, _headers = authorization_update_with_http_info(id, authorization_update, opts)
+ data
+ end
+
+ # Update an authorization
+ # Update an existing authorization.
+ # @param id [String] ID
+ # @param authorization_update [AuthorizationUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def authorization_update_with_http_info(id, authorization_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: AuthorizationsApi.authorization_update ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling AuthorizationsApi.authorization_update"
+ end
+ # verify the required parameter 'authorization_update' is set
+ if @api_client.config.client_side_validation && authorization_update.nil?
+ fail ArgumentError, "Missing the required parameter 'authorization_update' when calling AuthorizationsApi.authorization_update"
+ end
+ # resource path
+ local_var_path = '/authorizations/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(authorization_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: AuthorizationsApi#authorization_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List authorizations
+ # List all your authorizations.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def authorizations_list(opts = {})
+ data, _status_code, _headers = authorizations_list_with_http_info(opts)
+ data
+ end
+
+ # List authorizations
+ # List all your authorizations.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def authorizations_list_with_http_info(opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: AuthorizationsApi.authorizations_list ...'
+ end
+ # resource path
+ local_var_path = '/authorizations'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: AuthorizationsApi#authorizations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/bitbucket_sync_api.rb b/lib/Phrase/api/bitbucket_sync_api.rb
new file mode 100644
index 0000000..ba6709e
--- /dev/null
+++ b/lib/Phrase/api/bitbucket_sync_api.rb
@@ -0,0 +1,224 @@
+require 'cgi'
+
+module Phrase
+ class BitbucketSyncApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Export from Phrase to Bitbucket
+ # Export translations from Phrase to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
+ # @param id [String] ID
+ # @param bitbucket_sync_export [BitbucketSyncExport]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [BitbucketSyncExportResponse]
+ def bitbucket_sync_export(id, bitbucket_sync_export, opts = {})
+ data, _status_code, _headers = bitbucket_sync_export_with_http_info(id, bitbucket_sync_export, opts)
+ data
+ end
+
+ # Export from Phrase to Bitbucket
+ # Export translations from Phrase to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.
+ # @param id [String] ID
+ # @param bitbucket_sync_export [BitbucketSyncExport]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(BitbucketSyncExportResponse)>, Integer, Hash)>] Response<(BitbucketSyncExportResponse)> data, response status code and response headers
+ def bitbucket_sync_export_with_http_info(id, bitbucket_sync_export, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BitbucketSyncApi.bitbucket_sync_export ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling BitbucketSyncApi.bitbucket_sync_export"
+ end
+ # verify the required parameter 'bitbucket_sync_export' is set
+ if @api_client.config.client_side_validation && bitbucket_sync_export.nil?
+ fail ArgumentError, "Missing the required parameter 'bitbucket_sync_export' when calling BitbucketSyncApi.bitbucket_sync_export"
+ end
+ # resource path
+ local_var_path = '/bitbucket_syncs/{id}/export'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(bitbucket_sync_export)
+
+ # return_type
+ return_type = opts[:return_type] || 'BitbucketSyncExportResponse'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BitbucketSyncApi#bitbucket_sync_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Import to Phrase from Bitbucket
+ # Import translations from Bitbucket to Phrase according to the .phraseapp.yml file within the Bitbucket repository.
+ # @param id [String] ID
+ # @param bitbucket_sync_import [BitbucketSyncImport]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def bitbucket_sync_import(id, bitbucket_sync_import, opts = {})
+ bitbucket_sync_import_with_http_info(id, bitbucket_sync_import, opts)
+ nil
+ end
+
+ # Import to Phrase from Bitbucket
+ # Import translations from Bitbucket to Phrase according to the .phraseapp.yml file within the Bitbucket repository.
+ # @param id [String] ID
+ # @param bitbucket_sync_import [BitbucketSyncImport]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def bitbucket_sync_import_with_http_info(id, bitbucket_sync_import, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BitbucketSyncApi.bitbucket_sync_import ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling BitbucketSyncApi.bitbucket_sync_import"
+ end
+ # verify the required parameter 'bitbucket_sync_import' is set
+ if @api_client.config.client_side_validation && bitbucket_sync_import.nil?
+ fail ArgumentError, "Missing the required parameter 'bitbucket_sync_import' when calling BitbucketSyncApi.bitbucket_sync_import"
+ end
+ # resource path
+ local_var_path = '/bitbucket_syncs/{id}/import'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(bitbucket_sync_import)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BitbucketSyncApi#bitbucket_sync_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List Bitbucket syncs
+ # List all Bitbucket repositories for which synchronisation with Phrase is activated.
+ # @param bitbucket_syncs_list [BitbucketSyncsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array]
+ def bitbucket_syncs_list(bitbucket_syncs_list, opts = {})
+ data, _status_code, _headers = bitbucket_syncs_list_with_http_info(bitbucket_syncs_list, opts)
+ data
+ end
+
+ # List Bitbucket syncs
+ # List all Bitbucket repositories for which synchronisation with Phrase is activated.
+ # @param bitbucket_syncs_list [BitbucketSyncsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def bitbucket_syncs_list_with_http_info(bitbucket_syncs_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BitbucketSyncApi.bitbucket_syncs_list ...'
+ end
+ # verify the required parameter 'bitbucket_syncs_list' is set
+ if @api_client.config.client_side_validation && bitbucket_syncs_list.nil?
+ fail ArgumentError, "Missing the required parameter 'bitbucket_syncs_list' when calling BitbucketSyncApi.bitbucket_syncs_list"
+ end
+ # resource path
+ local_var_path = '/bitbucket_syncs'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(bitbucket_syncs_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BitbucketSyncApi#bitbucket_syncs_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/blacklisted_keys_api.rb b/lib/Phrase/api/blacklisted_keys_api.rb
new file mode 100644
index 0000000..1c76486
--- /dev/null
+++ b/lib/Phrase/api/blacklisted_keys_api.rb
@@ -0,0 +1,376 @@
+require 'cgi'
+
+module Phrase
+ class BlacklistedKeysApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a blacklisted key
+ # Create a new rule for blacklisting keys.
+ # @param project_id [String] Project ID
+ # @param blacklisted_key_create [BlacklistedKeyCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def blacklisted_key_create(project_id, blacklisted_key_create, opts = {})
+ blacklisted_key_create_with_http_info(project_id, blacklisted_key_create, opts)
+ nil
+ end
+
+ # Create a blacklisted key
+ # Create a new rule for blacklisting keys.
+ # @param project_id [String] Project ID
+ # @param blacklisted_key_create [BlacklistedKeyCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def blacklisted_key_create_with_http_info(project_id, blacklisted_key_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BlacklistedKeysApi.blacklisted_key_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BlacklistedKeysApi.blacklisted_key_create"
+ end
+ # verify the required parameter 'blacklisted_key_create' is set
+ if @api_client.config.client_side_validation && blacklisted_key_create.nil?
+ fail ArgumentError, "Missing the required parameter 'blacklisted_key_create' when calling BlacklistedKeysApi.blacklisted_key_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/blacklisted_keys'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(blacklisted_key_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BlacklistedKeysApi#blacklisted_key_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a blacklisted key
+ # Delete an existing rule for blacklisting keys.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def blacklisted_key_delete(project_id, id, opts = {})
+ blacklisted_key_delete_with_http_info(project_id, id, opts)
+ nil
+ end
+
+ # Delete a blacklisted key
+ # Delete an existing rule for blacklisting keys.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def blacklisted_key_delete_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BlacklistedKeysApi.blacklisted_key_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BlacklistedKeysApi.blacklisted_key_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling BlacklistedKeysApi.blacklisted_key_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/blacklisted_keys/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BlacklistedKeysApi#blacklisted_key_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single blacklisted key
+ # Get details on a single rule for blacklisting keys for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [BlacklistedKey]
+ def blacklisted_key_show(project_id, id, opts = {})
+ data, _status_code, _headers = blacklisted_key_show_with_http_info(project_id, id, opts)
+ data
+ end
+
+ # Get a single blacklisted key
+ # Get details on a single rule for blacklisting keys for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(BlacklistedKey)>, Integer, Hash)>] Response<(BlacklistedKey)> data, response status code and response headers
+ def blacklisted_key_show_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BlacklistedKeysApi.blacklisted_key_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BlacklistedKeysApi.blacklisted_key_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling BlacklistedKeysApi.blacklisted_key_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/blacklisted_keys/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'BlacklistedKey'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BlacklistedKeysApi#blacklisted_key_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a blacklisted key
+ # Update an existing rule for blacklisting keys.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param blacklisted_key_update [BlacklistedKeyUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def blacklisted_key_update(project_id, id, blacklisted_key_update, opts = {})
+ data, _status_code, _headers = blacklisted_key_update_with_http_info(project_id, id, blacklisted_key_update, opts)
+ data
+ end
+
+ # Update a blacklisted key
+ # Update an existing rule for blacklisting keys.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param blacklisted_key_update [BlacklistedKeyUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def blacklisted_key_update_with_http_info(project_id, id, blacklisted_key_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BlacklistedKeysApi.blacklisted_key_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BlacklistedKeysApi.blacklisted_key_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling BlacklistedKeysApi.blacklisted_key_update"
+ end
+ # verify the required parameter 'blacklisted_key_update' is set
+ if @api_client.config.client_side_validation && blacklisted_key_update.nil?
+ fail ArgumentError, "Missing the required parameter 'blacklisted_key_update' when calling BlacklistedKeysApi.blacklisted_key_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/blacklisted_keys/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(blacklisted_key_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BlacklistedKeysApi#blacklisted_key_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List blacklisted keys
+ # List all rules for blacklisting keys for the given project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def blacklisted_keys_list(project_id, opts = {})
+ data, _status_code, _headers = blacklisted_keys_list_with_http_info(project_id, opts)
+ data
+ end
+
+ # List blacklisted keys
+ # List all rules for blacklisting keys for the given project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def blacklisted_keys_list_with_http_info(project_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BlacklistedKeysApi.blacklisted_keys_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BlacklistedKeysApi.blacklisted_keys_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/blacklisted_keys'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BlacklistedKeysApi#blacklisted_keys_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/branches_api.rb b/lib/Phrase/api/branches_api.rb
new file mode 100644
index 0000000..242d20c
--- /dev/null
+++ b/lib/Phrase/api/branches_api.rb
@@ -0,0 +1,532 @@
+require 'cgi'
+
+module Phrase
+ class BranchesApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Compare branches
+ # Compare branch with main branch.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param branch_compare [BranchCompare]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def branch_compare(project_id, name, branch_compare, opts = {})
+ branch_compare_with_http_info(project_id, name, branch_compare, opts)
+ nil
+ end
+
+ # Compare branches
+ # Compare branch with main branch.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param branch_compare [BranchCompare]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def branch_compare_with_http_info(project_id, name, branch_compare, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BranchesApi.branch_compare ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BranchesApi.branch_compare"
+ end
+ # verify the required parameter 'name' is set
+ if @api_client.config.client_side_validation && name.nil?
+ fail ArgumentError, "Missing the required parameter 'name' when calling BranchesApi.branch_compare"
+ end
+ # verify the required parameter 'branch_compare' is set
+ if @api_client.config.client_side_validation && branch_compare.nil?
+ fail ArgumentError, "Missing the required parameter 'branch_compare' when calling BranchesApi.branch_compare"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/branches/{name}/compare'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(branch_compare)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BranchesApi#branch_compare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Create a branch
+ # Create a new branch.
+ # @param project_id [String] Project ID
+ # @param branch_create [BranchCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def branch_create(project_id, branch_create, opts = {})
+ branch_create_with_http_info(project_id, branch_create, opts)
+ nil
+ end
+
+ # Create a branch
+ # Create a new branch.
+ # @param project_id [String] Project ID
+ # @param branch_create [BranchCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def branch_create_with_http_info(project_id, branch_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BranchesApi.branch_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BranchesApi.branch_create"
+ end
+ # verify the required parameter 'branch_create' is set
+ if @api_client.config.client_side_validation && branch_create.nil?
+ fail ArgumentError, "Missing the required parameter 'branch_create' when calling BranchesApi.branch_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/branches'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(branch_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BranchesApi#branch_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a branch
+ # Delete an existing branch.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def branch_delete(project_id, name, opts = {})
+ branch_delete_with_http_info(project_id, name, opts)
+ nil
+ end
+
+ # Delete a branch
+ # Delete an existing branch.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def branch_delete_with_http_info(project_id, name, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BranchesApi.branch_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BranchesApi.branch_delete"
+ end
+ # verify the required parameter 'name' is set
+ if @api_client.config.client_side_validation && name.nil?
+ fail ArgumentError, "Missing the required parameter 'name' when calling BranchesApi.branch_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/branches/{name}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BranchesApi#branch_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Merge a branch
+ # Merge an existing branch.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param branch_merge [BranchMerge]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def branch_merge(project_id, name, branch_merge, opts = {})
+ branch_merge_with_http_info(project_id, name, branch_merge, opts)
+ nil
+ end
+
+ # Merge a branch
+ # Merge an existing branch.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param branch_merge [BranchMerge]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def branch_merge_with_http_info(project_id, name, branch_merge, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BranchesApi.branch_merge ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BranchesApi.branch_merge"
+ end
+ # verify the required parameter 'name' is set
+ if @api_client.config.client_side_validation && name.nil?
+ fail ArgumentError, "Missing the required parameter 'name' when calling BranchesApi.branch_merge"
+ end
+ # verify the required parameter 'branch_merge' is set
+ if @api_client.config.client_side_validation && branch_merge.nil?
+ fail ArgumentError, "Missing the required parameter 'branch_merge' when calling BranchesApi.branch_merge"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/branches/{name}/merge'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(branch_merge)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BranchesApi#branch_merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single branch
+ # Get details on a single branch for a given project.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Branch]
+ def branch_show(project_id, name, opts = {})
+ data, _status_code, _headers = branch_show_with_http_info(project_id, name, opts)
+ data
+ end
+
+ # Get a single branch
+ # Get details on a single branch for a given project.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Branch)>, Integer, Hash)>] Response<(Branch)> data, response status code and response headers
+ def branch_show_with_http_info(project_id, name, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BranchesApi.branch_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BranchesApi.branch_show"
+ end
+ # verify the required parameter 'name' is set
+ if @api_client.config.client_side_validation && name.nil?
+ fail ArgumentError, "Missing the required parameter 'name' when calling BranchesApi.branch_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/branches/{name}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Branch'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BranchesApi#branch_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a branch
+ # Update an existing branch.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param branch_update [BranchUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def branch_update(project_id, name, branch_update, opts = {})
+ data, _status_code, _headers = branch_update_with_http_info(project_id, name, branch_update, opts)
+ data
+ end
+
+ # Update a branch
+ # Update an existing branch.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param branch_update [BranchUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def branch_update_with_http_info(project_id, name, branch_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BranchesApi.branch_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BranchesApi.branch_update"
+ end
+ # verify the required parameter 'name' is set
+ if @api_client.config.client_side_validation && name.nil?
+ fail ArgumentError, "Missing the required parameter 'name' when calling BranchesApi.branch_update"
+ end
+ # verify the required parameter 'branch_update' is set
+ if @api_client.config.client_side_validation && branch_update.nil?
+ fail ArgumentError, "Missing the required parameter 'branch_update' when calling BranchesApi.branch_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/branches/{name}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(branch_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BranchesApi#branch_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List branches
+ # List all branches the of the current project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def branches_list(project_id, opts = {})
+ data, _status_code, _headers = branches_list_with_http_info(project_id, opts)
+ data
+ end
+
+ # List branches
+ # List all branches the of the current project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def branches_list_with_http_info(project_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: BranchesApi.branches_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling BranchesApi.branches_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/branches'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: BranchesApi#branches_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/comments_api.rb b/lib/Phrase/api/comments_api.rb
new file mode 100644
index 0000000..71b0605
--- /dev/null
+++ b/lib/Phrase/api/comments_api.rb
@@ -0,0 +1,682 @@
+require 'cgi'
+
+module Phrase
+ class CommentsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a comment
+ # Create a new comment for a key.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param comment_create [CommentCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def comment_create(project_id, key_id, comment_create, opts = {})
+ comment_create_with_http_info(project_id, key_id, comment_create, opts)
+ nil
+ end
+
+ # Create a comment
+ # Create a new comment for a key.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param comment_create [CommentCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def comment_create_with_http_info(project_id, key_id, comment_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: CommentsApi.comment_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_create"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_create"
+ end
+ # verify the required parameter 'comment_create' is set
+ if @api_client.config.client_side_validation && comment_create.nil?
+ fail ArgumentError, "Missing the required parameter 'comment_create' when calling CommentsApi.comment_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(comment_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: CommentsApi#comment_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a comment
+ # Delete an existing comment.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_delete [CommentDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def comment_delete(project_id, key_id, id, comment_delete, opts = {})
+ comment_delete_with_http_info(project_id, key_id, id, comment_delete, opts)
+ nil
+ end
+
+ # Delete a comment
+ # Delete an existing comment.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_delete [CommentDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def comment_delete_with_http_info(project_id, key_id, id, comment_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: CommentsApi.comment_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_delete"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_delete"
+ end
+ # verify the required parameter 'comment_delete' is set
+ if @api_client.config.client_side_validation && comment_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'comment_delete' when calling CommentsApi.comment_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(comment_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: CommentsApi#comment_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Check if comment is read
+ # Check if comment was marked as read. Returns 204 if read, 404 if unread.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_mark_check [CommentMarkCheck]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def comment_mark_check(project_id, key_id, id, comment_mark_check, opts = {})
+ comment_mark_check_with_http_info(project_id, key_id, id, comment_mark_check, opts)
+ nil
+ end
+
+ # Check if comment is read
+ # Check if comment was marked as read. Returns 204 if read, 404 if unread.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_mark_check [CommentMarkCheck]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def comment_mark_check_with_http_info(project_id, key_id, id, comment_mark_check, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: CommentsApi.comment_mark_check ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_mark_check"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_mark_check"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_mark_check"
+ end
+ # verify the required parameter 'comment_mark_check' is set
+ if @api_client.config.client_side_validation && comment_mark_check.nil?
+ fail ArgumentError, "Missing the required parameter 'comment_mark_check' when calling CommentsApi.comment_mark_check"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}/read'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(comment_mark_check)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: CommentsApi#comment_mark_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Mark a comment as read
+ # Mark a comment as read.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_mark_read [CommentMarkRead]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def comment_mark_read(project_id, key_id, id, comment_mark_read, opts = {})
+ comment_mark_read_with_http_info(project_id, key_id, id, comment_mark_read, opts)
+ nil
+ end
+
+ # Mark a comment as read
+ # Mark a comment as read.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_mark_read [CommentMarkRead]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def comment_mark_read_with_http_info(project_id, key_id, id, comment_mark_read, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: CommentsApi.comment_mark_read ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_mark_read"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_mark_read"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_mark_read"
+ end
+ # verify the required parameter 'comment_mark_read' is set
+ if @api_client.config.client_side_validation && comment_mark_read.nil?
+ fail ArgumentError, "Missing the required parameter 'comment_mark_read' when calling CommentsApi.comment_mark_read"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}/read'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(comment_mark_read)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: CommentsApi#comment_mark_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Mark a comment as unread
+ # Mark a comment as unread.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_mark_unread [CommentMarkUnread]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def comment_mark_unread(project_id, key_id, id, comment_mark_unread, opts = {})
+ comment_mark_unread_with_http_info(project_id, key_id, id, comment_mark_unread, opts)
+ nil
+ end
+
+ # Mark a comment as unread
+ # Mark a comment as unread.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_mark_unread [CommentMarkUnread]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def comment_mark_unread_with_http_info(project_id, key_id, id, comment_mark_unread, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: CommentsApi.comment_mark_unread ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_mark_unread"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_mark_unread"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_mark_unread"
+ end
+ # verify the required parameter 'comment_mark_unread' is set
+ if @api_client.config.client_side_validation && comment_mark_unread.nil?
+ fail ArgumentError, "Missing the required parameter 'comment_mark_unread' when calling CommentsApi.comment_mark_unread"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}/read'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(comment_mark_unread)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: CommentsApi#comment_mark_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single comment
+ # Get details on a single comment.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_show [CommentShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Comment]
+ def comment_show(project_id, key_id, id, comment_show, opts = {})
+ data, _status_code, _headers = comment_show_with_http_info(project_id, key_id, id, comment_show, opts)
+ data
+ end
+
+ # Get a single comment
+ # Get details on a single comment.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_show [CommentShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Comment)>, Integer, Hash)>] Response<(Comment)> data, response status code and response headers
+ def comment_show_with_http_info(project_id, key_id, id, comment_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: CommentsApi.comment_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_show"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_show"
+ end
+ # verify the required parameter 'comment_show' is set
+ if @api_client.config.client_side_validation && comment_show.nil?
+ fail ArgumentError, "Missing the required parameter 'comment_show' when calling CommentsApi.comment_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(comment_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'Comment'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: CommentsApi#comment_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a comment
+ # Update an existing comment.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_update [CommentUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def comment_update(project_id, key_id, id, comment_update, opts = {})
+ data, _status_code, _headers = comment_update_with_http_info(project_id, key_id, id, comment_update, opts)
+ data
+ end
+
+ # Update a comment
+ # Update an existing comment.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param id [String] ID
+ # @param comment_update [CommentUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def comment_update_with_http_info(project_id, key_id, id, comment_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: CommentsApi.comment_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_update"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_update"
+ end
+ # verify the required parameter 'comment_update' is set
+ if @api_client.config.client_side_validation && comment_update.nil?
+ fail ArgumentError, "Missing the required parameter 'comment_update' when calling CommentsApi.comment_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(comment_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: CommentsApi#comment_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List comments
+ # List all comments for a key.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param comments_list [CommentsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def comments_list(project_id, key_id, comments_list, opts = {})
+ data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, comments_list, opts)
+ data
+ end
+
+ # List comments
+ # List all comments for a key.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param comments_list [CommentsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def comments_list_with_http_info(project_id, key_id, comments_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: CommentsApi.comments_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comments_list"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comments_list"
+ end
+ # verify the required parameter 'comments_list' is set
+ if @api_client.config.client_side_validation && comments_list.nil?
+ fail ArgumentError, "Missing the required parameter 'comments_list' when calling CommentsApi.comments_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(comments_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: CommentsApi#comments_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/distributions_api.rb b/lib/Phrase/api/distributions_api.rb
new file mode 100644
index 0000000..33ebcf5
--- /dev/null
+++ b/lib/Phrase/api/distributions_api.rb
@@ -0,0 +1,376 @@
+require 'cgi'
+
+module Phrase
+ class DistributionsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a distribution
+ # Create a new distribution.
+ # @param account_id [String] Account ID
+ # @param distribution_create [DistributionCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def distribution_create(account_id, distribution_create, opts = {})
+ distribution_create_with_http_info(account_id, distribution_create, opts)
+ nil
+ end
+
+ # Create a distribution
+ # Create a new distribution.
+ # @param account_id [String] Account ID
+ # @param distribution_create [DistributionCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def distribution_create_with_http_info(account_id, distribution_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: DistributionsApi.distribution_create ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling DistributionsApi.distribution_create"
+ end
+ # verify the required parameter 'distribution_create' is set
+ if @api_client.config.client_side_validation && distribution_create.nil?
+ fail ArgumentError, "Missing the required parameter 'distribution_create' when calling DistributionsApi.distribution_create"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(distribution_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: DistributionsApi#distribution_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a distribution
+ # Delete an existing distribution.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def distribution_delete(account_id, id, opts = {})
+ distribution_delete_with_http_info(account_id, id, opts)
+ nil
+ end
+
+ # Delete a distribution
+ # Delete an existing distribution.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def distribution_delete_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: DistributionsApi.distribution_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling DistributionsApi.distribution_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling DistributionsApi.distribution_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: DistributionsApi#distribution_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single distribution
+ # Get details on a single distribution.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Distribution]
+ def distribution_show(account_id, id, opts = {})
+ data, _status_code, _headers = distribution_show_with_http_info(account_id, id, opts)
+ data
+ end
+
+ # Get a single distribution
+ # Get details on a single distribution.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Distribution)>, Integer, Hash)>] Response<(Distribution)> data, response status code and response headers
+ def distribution_show_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: DistributionsApi.distribution_show ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling DistributionsApi.distribution_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling DistributionsApi.distribution_show"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Distribution'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: DistributionsApi#distribution_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a distribution
+ # Update an existing distribution.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param distribution_update [DistributionUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def distribution_update(account_id, id, distribution_update, opts = {})
+ data, _status_code, _headers = distribution_update_with_http_info(account_id, id, distribution_update, opts)
+ data
+ end
+
+ # Update a distribution
+ # Update an existing distribution.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param distribution_update [DistributionUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def distribution_update_with_http_info(account_id, id, distribution_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: DistributionsApi.distribution_update ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling DistributionsApi.distribution_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling DistributionsApi.distribution_update"
+ end
+ # verify the required parameter 'distribution_update' is set
+ if @api_client.config.client_side_validation && distribution_update.nil?
+ fail ArgumentError, "Missing the required parameter 'distribution_update' when calling DistributionsApi.distribution_update"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(distribution_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: DistributionsApi#distribution_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List distributions
+ # List all distributions for the given account.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def distributions_list(account_id, opts = {})
+ data, _status_code, _headers = distributions_list_with_http_info(account_id, opts)
+ data
+ end
+
+ # List distributions
+ # List all distributions for the given account.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def distributions_list_with_http_info(account_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: DistributionsApi.distributions_list ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling DistributionsApi.distributions_list"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: DistributionsApi#distributions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/formats_api.rb b/lib/Phrase/api/formats_api.rb
new file mode 100644
index 0000000..db08066
--- /dev/null
+++ b/lib/Phrase/api/formats_api.rb
@@ -0,0 +1,70 @@
+require 'cgi'
+
+module Phrase
+ class FormatsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # List formats
+ # Get a handy list of all localization file formats supported in Phrase.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array]
+ def formats_list(opts = {})
+ data, _status_code, _headers = formats_list_with_http_info(opts)
+ data
+ end
+
+ # List formats
+ # Get a handy list of all localization file formats supported in Phrase.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def formats_list_with_http_info(opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: FormatsApi.formats_list ...'
+ end
+ # resource path
+ local_var_path = '/formats'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: FormatsApi#formats_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/git_lab_sync_api.rb b/lib/Phrase/api/git_lab_sync_api.rb
new file mode 100644
index 0000000..f59ef3a
--- /dev/null
+++ b/lib/Phrase/api/git_lab_sync_api.rb
@@ -0,0 +1,526 @@
+require 'cgi'
+
+module Phrase
+ class GitLabSyncApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Delete single Sync Setting
+ # Deletes a single GitLab Sync Setting.
+ # @param id [String] ID
+ # @param gitlab_sync_delete [GitlabSyncDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def gitlab_sync_delete(id, gitlab_sync_delete, opts = {})
+ gitlab_sync_delete_with_http_info(id, gitlab_sync_delete, opts)
+ nil
+ end
+
+ # Delete single Sync Setting
+ # Deletes a single GitLab Sync Setting.
+ # @param id [String] ID
+ # @param gitlab_sync_delete [GitlabSyncDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def gitlab_sync_delete_with_http_info(id, gitlab_sync_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_delete ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GitLabSyncApi.gitlab_sync_delete"
+ end
+ # verify the required parameter 'gitlab_sync_delete' is set
+ if @api_client.config.client_side_validation && gitlab_sync_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_delete' when calling GitLabSyncApi.gitlab_sync_delete"
+ end
+ # resource path
+ local_var_path = '/gitlab_syncs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(gitlab_sync_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GitLabSyncApi#gitlab_sync_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Export from Phrase to GitLab
+ # Export translations from Phrase to GitLab according to the .phraseapp.yml file within the GitLab repository.
+ # @param gitlab_sync_id [String] Gitlab Sync ID
+ # @param gitlab_sync_export [GitlabSyncExport]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [GitlabSyncExport1]
+ def gitlab_sync_export(gitlab_sync_id, gitlab_sync_export, opts = {})
+ data, _status_code, _headers = gitlab_sync_export_with_http_info(gitlab_sync_id, gitlab_sync_export, opts)
+ data
+ end
+
+ # Export from Phrase to GitLab
+ # Export translations from Phrase to GitLab according to the .phraseapp.yml file within the GitLab repository.
+ # @param gitlab_sync_id [String] Gitlab Sync ID
+ # @param gitlab_sync_export [GitlabSyncExport]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(GitlabSyncExport1)>, Integer, Hash)>] Response<(GitlabSyncExport1)> data, response status code and response headers
+ def gitlab_sync_export_with_http_info(gitlab_sync_id, gitlab_sync_export, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_export ...'
+ end
+ # verify the required parameter 'gitlab_sync_id' is set
+ if @api_client.config.client_side_validation && gitlab_sync_id.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_id' when calling GitLabSyncApi.gitlab_sync_export"
+ end
+ # verify the required parameter 'gitlab_sync_export' is set
+ if @api_client.config.client_side_validation && gitlab_sync_export.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_export' when calling GitLabSyncApi.gitlab_sync_export"
+ end
+ # resource path
+ local_var_path = '/gitlab_syncs/{gitlab_sync_id}/export'.sub('{' + 'gitlab_sync_id' + '}', CGI.escape(gitlab_sync_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(gitlab_sync_export)
+
+ # return_type
+ return_type = opts[:return_type] || 'GitlabSyncExport1'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GitLabSyncApi#gitlab_sync_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # History of single Sync Setting
+ # List history for a single Sync Setting.
+ # @param gitlab_sync_id [String] Gitlab Sync ID
+ # @param gitlab_sync_history [GitlabSyncHistory]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def gitlab_sync_history(gitlab_sync_id, gitlab_sync_history, opts = {})
+ data, _status_code, _headers = gitlab_sync_history_with_http_info(gitlab_sync_id, gitlab_sync_history, opts)
+ data
+ end
+
+ # History of single Sync Setting
+ # List history for a single Sync Setting.
+ # @param gitlab_sync_id [String] Gitlab Sync ID
+ # @param gitlab_sync_history [GitlabSyncHistory]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def gitlab_sync_history_with_http_info(gitlab_sync_id, gitlab_sync_history, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_history ...'
+ end
+ # verify the required parameter 'gitlab_sync_id' is set
+ if @api_client.config.client_side_validation && gitlab_sync_id.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_id' when calling GitLabSyncApi.gitlab_sync_history"
+ end
+ # verify the required parameter 'gitlab_sync_history' is set
+ if @api_client.config.client_side_validation && gitlab_sync_history.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_history' when calling GitLabSyncApi.gitlab_sync_history"
+ end
+ # resource path
+ local_var_path = '/gitlab_syncs/{gitlab_sync_id}/history'.sub('{' + 'gitlab_sync_id' + '}', CGI.escape(gitlab_sync_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(gitlab_sync_history)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GitLabSyncApi#gitlab_sync_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Import from GitLab to Phrase
+ # Import translations from GitLab to Phrase according to the .phraseapp.yml file within the GitLab repository.
+ # @param gitlab_sync_id [String] Gitlab Sync ID
+ # @param gitlab_sync_import [GitlabSyncImport]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array]
+ def gitlab_sync_import(gitlab_sync_id, gitlab_sync_import, opts = {})
+ data, _status_code, _headers = gitlab_sync_import_with_http_info(gitlab_sync_id, gitlab_sync_import, opts)
+ data
+ end
+
+ # Import from GitLab to Phrase
+ # Import translations from GitLab to Phrase according to the .phraseapp.yml file within the GitLab repository.
+ # @param gitlab_sync_id [String] Gitlab Sync ID
+ # @param gitlab_sync_import [GitlabSyncImport]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def gitlab_sync_import_with_http_info(gitlab_sync_id, gitlab_sync_import, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_import ...'
+ end
+ # verify the required parameter 'gitlab_sync_id' is set
+ if @api_client.config.client_side_validation && gitlab_sync_id.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_id' when calling GitLabSyncApi.gitlab_sync_import"
+ end
+ # verify the required parameter 'gitlab_sync_import' is set
+ if @api_client.config.client_side_validation && gitlab_sync_import.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_import' when calling GitLabSyncApi.gitlab_sync_import"
+ end
+ # resource path
+ local_var_path = '/gitlab_syncs/{gitlab_sync_id}/import'.sub('{' + 'gitlab_sync_id' + '}', CGI.escape(gitlab_sync_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(gitlab_sync_import)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GitLabSyncApi#gitlab_sync_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List GitLab syncs
+ # List all GitLab Sync Settings for which synchronisation with Phrase and GitLab is activated.
+ # @param gitlab_sync_list [GitlabSyncList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array]
+ def gitlab_sync_list(gitlab_sync_list, opts = {})
+ data, _status_code, _headers = gitlab_sync_list_with_http_info(gitlab_sync_list, opts)
+ data
+ end
+
+ # List GitLab syncs
+ # List all GitLab Sync Settings for which synchronisation with Phrase and GitLab is activated.
+ # @param gitlab_sync_list [GitlabSyncList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def gitlab_sync_list_with_http_info(gitlab_sync_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_list ...'
+ end
+ # verify the required parameter 'gitlab_sync_list' is set
+ if @api_client.config.client_side_validation && gitlab_sync_list.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_list' when calling GitLabSyncApi.gitlab_sync_list"
+ end
+ # resource path
+ local_var_path = '/gitlab_syncs'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(gitlab_sync_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GitLabSyncApi#gitlab_sync_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get single Sync Setting
+ # Shows a single GitLab Sync Setting.
+ # @param id [String] ID
+ # @param gitlab_sync_show [GitlabSyncShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [GitlabSync]
+ def gitlab_sync_show(id, gitlab_sync_show, opts = {})
+ data, _status_code, _headers = gitlab_sync_show_with_http_info(id, gitlab_sync_show, opts)
+ data
+ end
+
+ # Get single Sync Setting
+ # Shows a single GitLab Sync Setting.
+ # @param id [String] ID
+ # @param gitlab_sync_show [GitlabSyncShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(GitlabSync)>, Integer, Hash)>] Response<(GitlabSync)> data, response status code and response headers
+ def gitlab_sync_show_with_http_info(id, gitlab_sync_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_show ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GitLabSyncApi.gitlab_sync_show"
+ end
+ # verify the required parameter 'gitlab_sync_show' is set
+ if @api_client.config.client_side_validation && gitlab_sync_show.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_show' when calling GitLabSyncApi.gitlab_sync_show"
+ end
+ # resource path
+ local_var_path = '/gitlab_syncs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(gitlab_sync_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'GitlabSync'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GitLabSyncApi#gitlab_sync_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update single Sync Setting
+ # Updates a single GitLab Sync Setting.
+ # @param id [String] ID
+ # @param gitlab_sync_update [GitlabSyncUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def gitlab_sync_update(id, gitlab_sync_update, opts = {})
+ data, _status_code, _headers = gitlab_sync_update_with_http_info(id, gitlab_sync_update, opts)
+ data
+ end
+
+ # Update single Sync Setting
+ # Updates a single GitLab Sync Setting.
+ # @param id [String] ID
+ # @param gitlab_sync_update [GitlabSyncUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def gitlab_sync_update_with_http_info(id, gitlab_sync_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GitLabSyncApi.gitlab_sync_update ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GitLabSyncApi.gitlab_sync_update"
+ end
+ # verify the required parameter 'gitlab_sync_update' is set
+ if @api_client.config.client_side_validation && gitlab_sync_update.nil?
+ fail ArgumentError, "Missing the required parameter 'gitlab_sync_update' when calling GitLabSyncApi.gitlab_sync_update"
+ end
+ # resource path
+ local_var_path = '/gitlab_syncs/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(gitlab_sync_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GitLabSyncApi#gitlab_sync_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/glossary_api.rb b/lib/Phrase/api/glossary_api.rb
new file mode 100644
index 0000000..d7e2042
--- /dev/null
+++ b/lib/Phrase/api/glossary_api.rb
@@ -0,0 +1,376 @@
+require 'cgi'
+
+module Phrase
+ class GlossaryApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # List glossaries
+ # List all glossaries the current user has access to.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def glossaries_list(account_id, opts = {})
+ data, _status_code, _headers = glossaries_list_with_http_info(account_id, opts)
+ data
+ end
+
+ # List glossaries
+ # List all glossaries the current user has access to.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def glossaries_list_with_http_info(account_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryApi.glossaries_list ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryApi.glossaries_list"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryApi#glossaries_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Create a glossary
+ # Create a new glossary.
+ # @param account_id [String] Account ID
+ # @param glossary_create [GlossaryCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def glossary_create(account_id, glossary_create, opts = {})
+ glossary_create_with_http_info(account_id, glossary_create, opts)
+ nil
+ end
+
+ # Create a glossary
+ # Create a new glossary.
+ # @param account_id [String] Account ID
+ # @param glossary_create [GlossaryCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def glossary_create_with_http_info(account_id, glossary_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryApi.glossary_create ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryApi.glossary_create"
+ end
+ # verify the required parameter 'glossary_create' is set
+ if @api_client.config.client_side_validation && glossary_create.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_create' when calling GlossaryApi.glossary_create"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(glossary_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryApi#glossary_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a glossary
+ # Delete an existing glossary.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def glossary_delete(account_id, id, opts = {})
+ glossary_delete_with_http_info(account_id, id, opts)
+ nil
+ end
+
+ # Delete a glossary
+ # Delete an existing glossary.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def glossary_delete_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryApi.glossary_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryApi.glossary_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryApi.glossary_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryApi#glossary_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single glossary
+ # Get details on a single glossary.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Glossary]
+ def glossary_show(account_id, id, opts = {})
+ data, _status_code, _headers = glossary_show_with_http_info(account_id, id, opts)
+ data
+ end
+
+ # Get a single glossary
+ # Get details on a single glossary.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Glossary)>, Integer, Hash)>] Response<(Glossary)> data, response status code and response headers
+ def glossary_show_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryApi.glossary_show ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryApi.glossary_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryApi.glossary_show"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Glossary'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryApi#glossary_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a glossary
+ # Update an existing glossary.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param glossary_update [GlossaryUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def glossary_update(account_id, id, glossary_update, opts = {})
+ data, _status_code, _headers = glossary_update_with_http_info(account_id, id, glossary_update, opts)
+ data
+ end
+
+ # Update a glossary
+ # Update an existing glossary.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param glossary_update [GlossaryUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def glossary_update_with_http_info(account_id, id, glossary_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryApi.glossary_update ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryApi.glossary_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryApi.glossary_update"
+ end
+ # verify the required parameter 'glossary_update' is set
+ if @api_client.config.client_side_validation && glossary_update.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_update' when calling GlossaryApi.glossary_update"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(glossary_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryApi#glossary_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/glossary_term_translations_api.rb b/lib/Phrase/api/glossary_term_translations_api.rb
new file mode 100644
index 0000000..01396fb
--- /dev/null
+++ b/lib/Phrase/api/glossary_term_translations_api.rb
@@ -0,0 +1,268 @@
+require 'cgi'
+
+module Phrase
+ class GlossaryTermTranslationsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a glossary term translation
+ # Create a new glossary term translation.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param term_id [String] Term ID
+ # @param glossary_term_translation_create [GlossaryTermTranslationCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def glossary_term_translation_create(account_id, glossary_id, term_id, glossary_term_translation_create, opts = {})
+ glossary_term_translation_create_with_http_info(account_id, glossary_id, term_id, glossary_term_translation_create, opts)
+ nil
+ end
+
+ # Create a glossary term translation
+ # Create a new glossary term translation.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param term_id [String] Term ID
+ # @param glossary_term_translation_create [GlossaryTermTranslationCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def glossary_term_translation_create_with_http_info(account_id, glossary_id, term_id, glossary_term_translation_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryTermTranslationsApi.glossary_term_translation_create ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_create"
+ end
+ # verify the required parameter 'glossary_id' is set
+ if @api_client.config.client_side_validation && glossary_id.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_create"
+ end
+ # verify the required parameter 'term_id' is set
+ if @api_client.config.client_side_validation && term_id.nil?
+ fail ArgumentError, "Missing the required parameter 'term_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_create"
+ end
+ # verify the required parameter 'glossary_term_translation_create' is set
+ if @api_client.config.client_side_validation && glossary_term_translation_create.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_term_translation_create' when calling GlossaryTermTranslationsApi.glossary_term_translation_create"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'term_id' + '}', CGI.escape(term_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(glossary_term_translation_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryTermTranslationsApi#glossary_term_translation_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a glossary term translation
+ # Delete an existing glossary term translation.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param term_id [String] Term ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def glossary_term_translation_delete(account_id, glossary_id, term_id, id, opts = {})
+ glossary_term_translation_delete_with_http_info(account_id, glossary_id, term_id, id, opts)
+ nil
+ end
+
+ # Delete a glossary term translation
+ # Delete an existing glossary term translation.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param term_id [String] Term ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def glossary_term_translation_delete_with_http_info(account_id, glossary_id, term_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryTermTranslationsApi.glossary_term_translation_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_delete"
+ end
+ # verify the required parameter 'glossary_id' is set
+ if @api_client.config.client_side_validation && glossary_id.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_delete"
+ end
+ # verify the required parameter 'term_id' is set
+ if @api_client.config.client_side_validation && term_id.nil?
+ fail ArgumentError, "Missing the required parameter 'term_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermTranslationsApi.glossary_term_translation_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'term_id' + '}', CGI.escape(term_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryTermTranslationsApi#glossary_term_translation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a glossary term translation
+ # Update an existing glossary term translation.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param term_id [String] Term ID
+ # @param id [String] ID
+ # @param glossary_term_translation_update [GlossaryTermTranslationUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [GlossaryTermTranslation]
+ def glossary_term_translation_update(account_id, glossary_id, term_id, id, glossary_term_translation_update, opts = {})
+ data, _status_code, _headers = glossary_term_translation_update_with_http_info(account_id, glossary_id, term_id, id, glossary_term_translation_update, opts)
+ data
+ end
+
+ # Update a glossary term translation
+ # Update an existing glossary term translation.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param term_id [String] Term ID
+ # @param id [String] ID
+ # @param glossary_term_translation_update [GlossaryTermTranslationUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(GlossaryTermTranslation)>, Integer, Hash)>] Response<(GlossaryTermTranslation)> data, response status code and response headers
+ def glossary_term_translation_update_with_http_info(account_id, glossary_id, term_id, id, glossary_term_translation_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryTermTranslationsApi.glossary_term_translation_update ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_update"
+ end
+ # verify the required parameter 'glossary_id' is set
+ if @api_client.config.client_side_validation && glossary_id.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_update"
+ end
+ # verify the required parameter 'term_id' is set
+ if @api_client.config.client_side_validation && term_id.nil?
+ fail ArgumentError, "Missing the required parameter 'term_id' when calling GlossaryTermTranslationsApi.glossary_term_translation_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermTranslationsApi.glossary_term_translation_update"
+ end
+ # verify the required parameter 'glossary_term_translation_update' is set
+ if @api_client.config.client_side_validation && glossary_term_translation_update.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_term_translation_update' when calling GlossaryTermTranslationsApi.glossary_term_translation_update"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'term_id' + '}', CGI.escape(term_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(glossary_term_translation_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'GlossaryTermTranslation'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryTermTranslationsApi#glossary_term_translation_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/glossary_terms_api.rb b/lib/Phrase/api/glossary_terms_api.rb
new file mode 100644
index 0000000..02adc35
--- /dev/null
+++ b/lib/Phrase/api/glossary_terms_api.rb
@@ -0,0 +1,406 @@
+require 'cgi'
+
+module Phrase
+ class GlossaryTermsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a glossary term
+ # Create a new glossary term.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param glossary_term_create [GlossaryTermCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def glossary_term_create(account_id, glossary_id, glossary_term_create, opts = {})
+ glossary_term_create_with_http_info(account_id, glossary_id, glossary_term_create, opts)
+ nil
+ end
+
+ # Create a glossary term
+ # Create a new glossary term.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param glossary_term_create [GlossaryTermCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def glossary_term_create_with_http_info(account_id, glossary_id, glossary_term_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_create ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_create"
+ end
+ # verify the required parameter 'glossary_id' is set
+ if @api_client.config.client_side_validation && glossary_id.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_create"
+ end
+ # verify the required parameter 'glossary_term_create' is set
+ if @api_client.config.client_side_validation && glossary_term_create.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_term_create' when calling GlossaryTermsApi.glossary_term_create"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(glossary_term_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a glossary term
+ # Delete an existing glossary term.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def glossary_term_delete(account_id, glossary_id, id, opts = {})
+ glossary_term_delete_with_http_info(account_id, glossary_id, id, opts)
+ nil
+ end
+
+ # Delete a glossary term
+ # Delete an existing glossary term.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def glossary_term_delete_with_http_info(account_id, glossary_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_delete"
+ end
+ # verify the required parameter 'glossary_id' is set
+ if @api_client.config.client_side_validation && glossary_id.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single glossary term
+ # Get details on a single glossary term.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [GlossaryTerm]
+ def glossary_term_show(account_id, glossary_id, id, opts = {})
+ data, _status_code, _headers = glossary_term_show_with_http_info(account_id, glossary_id, id, opts)
+ data
+ end
+
+ # Get a single glossary term
+ # Get details on a single glossary term.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(GlossaryTerm)>, Integer, Hash)>] Response<(GlossaryTerm)> data, response status code and response headers
+ def glossary_term_show_with_http_info(account_id, glossary_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_show ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_show"
+ end
+ # verify the required parameter 'glossary_id' is set
+ if @api_client.config.client_side_validation && glossary_id.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_show"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'GlossaryTerm'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a glossary term
+ # Update an existing glossary term.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param id [String] ID
+ # @param glossary_term_update [GlossaryTermUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def glossary_term_update(account_id, glossary_id, id, glossary_term_update, opts = {})
+ data, _status_code, _headers = glossary_term_update_with_http_info(account_id, glossary_id, id, glossary_term_update, opts)
+ data
+ end
+
+ # Update a glossary term
+ # Update an existing glossary term.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param id [String] ID
+ # @param glossary_term_update [GlossaryTermUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def glossary_term_update_with_http_info(account_id, glossary_id, id, glossary_term_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_update ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_update"
+ end
+ # verify the required parameter 'glossary_id' is set
+ if @api_client.config.client_side_validation && glossary_id.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_update"
+ end
+ # verify the required parameter 'glossary_term_update' is set
+ if @api_client.config.client_side_validation && glossary_term_update.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_term_update' when calling GlossaryTermsApi.glossary_term_update"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(glossary_term_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List glossary terms
+ # List all glossary terms the current user has access to.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def glossary_terms_list(account_id, glossary_id, opts = {})
+ data, _status_code, _headers = glossary_terms_list_with_http_info(account_id, glossary_id, opts)
+ data
+ end
+
+ # List glossary terms
+ # List all glossary terms the current user has access to.
+ # @param account_id [String] Account ID
+ # @param glossary_id [String] Glossary ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def glossary_terms_list_with_http_info(account_id, glossary_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_terms_list ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_terms_list"
+ end
+ # verify the required parameter 'glossary_id' is set
+ if @api_client.config.client_side_validation && glossary_id.nil?
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_terms_list"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_terms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/invitations_api.rb b/lib/Phrase/api/invitations_api.rb
new file mode 100644
index 0000000..d0cabbc
--- /dev/null
+++ b/lib/Phrase/api/invitations_api.rb
@@ -0,0 +1,448 @@
+require 'cgi'
+
+module Phrase
+ class InvitationsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a new invitation
+ # Invite a person to an account. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param invitation_create [InvitationCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def invitation_create(account_id, invitation_create, opts = {})
+ invitation_create_with_http_info(account_id, invitation_create, opts)
+ nil
+ end
+
+ # 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>.
+ # @param account_id [String] Account ID
+ # @param invitation_create [InvitationCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def invitation_create_with_http_info(account_id, invitation_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_create ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_create"
+ end
+ # verify the required parameter 'invitation_create' is set
+ if @api_client.config.client_side_validation && invitation_create.nil?
+ fail ArgumentError, "Missing the required parameter 'invitation_create' when calling InvitationsApi.invitation_create"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/invitations'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(invitation_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete an invitation
+ # Delete an existing invitation (must not be accepted yet). Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def invitation_delete(account_id, id, opts = {})
+ invitation_delete_with_http_info(account_id, id, opts)
+ nil
+ end
+
+ # Delete an invitation
+ # Delete an existing invitation (must not be accepted yet). Access token scope must include <code>team.manage</code>.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def invitation_delete_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvitationsApi.invitation_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/invitations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Resend an invitation
+ # Resend the invitation email (must not be accepted yet). Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def invitation_resend(account_id, id, opts = {})
+ data, _status_code, _headers = invitation_resend_with_http_info(account_id, id, opts)
+ data
+ end
+
+ # Resend an invitation
+ # Resend the invitation email (must not be accepted yet). Access token scope must include <code>team.manage</code>.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def invitation_resend_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_resend ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_resend"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvitationsApi.invitation_resend"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/invitations/{id}/resend'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_resend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single invitation
+ # Get details on a single invitation. Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Invitation]
+ def invitation_show(account_id, id, opts = {})
+ data, _status_code, _headers = invitation_show_with_http_info(account_id, id, opts)
+ data
+ end
+
+ # Get a single invitation
+ # Get details on a single invitation. Access token scope must include <code>team.manage</code>.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Invitation)>, Integer, Hash)>] Response<(Invitation)> data, response status code and response headers
+ def invitation_show_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_show ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvitationsApi.invitation_show"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/invitations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Invitation'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update an invitation
+ # Update an existing invitation (must not be accepted yet). The email cannot be updated. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param invitation_update [InvitationUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def invitation_update(account_id, id, invitation_update, opts = {})
+ data, _status_code, _headers = invitation_update_with_http_info(account_id, id, invitation_update, opts)
+ data
+ end
+
+ # 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>.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param invitation_update [InvitationUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def invitation_update_with_http_info(account_id, id, invitation_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_update ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvitationsApi.invitation_update"
+ end
+ # verify the required parameter 'invitation_update' is set
+ if @api_client.config.client_side_validation && invitation_update.nil?
+ fail ArgumentError, "Missing the required parameter 'invitation_update' when calling InvitationsApi.invitation_update"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/invitations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(invitation_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # 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 team.manage.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def invitations_list(account_id, opts = {})
+ data, _status_code, _headers = invitations_list_with_http_info(account_id, opts)
+ data
+ end
+
+ # 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>.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def invitations_list_with_http_info(account_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitations_list ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitations_list"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/invitations'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: InvitationsApi#invitations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/job_locales_api.rb b/lib/Phrase/api/job_locales_api.rb
new file mode 100644
index 0000000..707113e
--- /dev/null
+++ b/lib/Phrase/api/job_locales_api.rb
@@ -0,0 +1,602 @@
+require 'cgi'
+
+module Phrase
+ class JobLocalesApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Complete a job locale
+ # Mark a job locale as completed.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_complete [JobLocaleComplete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_locale_complete(project_id, job_id, id, job_locale_complete, opts = {})
+ data, _status_code, _headers = job_locale_complete_with_http_info(project_id, job_id, id, job_locale_complete, opts)
+ data
+ end
+
+ # Complete a job locale
+ # Mark a job locale as completed.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_complete [JobLocaleComplete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_locale_complete_with_http_info(project_id, job_id, id, job_locale_complete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_complete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_complete"
+ end
+ # verify the required parameter 'job_id' is set
+ if @api_client.config.client_side_validation && job_id.nil?
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_complete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_complete"
+ end
+ # verify the required parameter 'job_locale_complete' is set
+ if @api_client.config.client_side_validation && job_locale_complete.nil?
+ fail ArgumentError, "Missing the required parameter 'job_locale_complete' when calling JobLocalesApi.job_locale_complete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}/complete'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_locale_complete)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a job locale
+ # Delete an existing job locale.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_delete [JobLocaleDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def job_locale_delete(project_id, job_id, id, job_locale_delete, opts = {})
+ job_locale_delete_with_http_info(project_id, job_id, id, job_locale_delete, opts)
+ nil
+ end
+
+ # Delete a job locale
+ # Delete an existing job locale.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_delete [JobLocaleDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def job_locale_delete_with_http_info(project_id, job_id, id, job_locale_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_delete"
+ end
+ # verify the required parameter 'job_id' is set
+ if @api_client.config.client_side_validation && job_id.nil?
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_delete"
+ end
+ # verify the required parameter 'job_locale_delete' is set
+ if @api_client.config.client_side_validation && job_locale_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'job_locale_delete' when calling JobLocalesApi.job_locale_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_locale_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Reopen a job locale
+ # Mark a job locale as uncompleted.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_reopen [JobLocaleReopen]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_locale_reopen(project_id, job_id, id, job_locale_reopen, opts = {})
+ data, _status_code, _headers = job_locale_reopen_with_http_info(project_id, job_id, id, job_locale_reopen, opts)
+ data
+ end
+
+ # Reopen a job locale
+ # Mark a job locale as uncompleted.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_reopen [JobLocaleReopen]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_locale_reopen_with_http_info(project_id, job_id, id, job_locale_reopen, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_reopen ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_reopen"
+ end
+ # verify the required parameter 'job_id' is set
+ if @api_client.config.client_side_validation && job_id.nil?
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_reopen"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_reopen"
+ end
+ # verify the required parameter 'job_locale_reopen' is set
+ if @api_client.config.client_side_validation && job_locale_reopen.nil?
+ fail ArgumentError, "Missing the required parameter 'job_locale_reopen' when calling JobLocalesApi.job_locale_reopen"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}/reopen'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_locale_reopen)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_reopen\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single job locale
+ # Get a single job locale for a given job.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_show [JobLocaleShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [JobLocale]
+ def job_locale_show(project_id, job_id, id, job_locale_show, opts = {})
+ data, _status_code, _headers = job_locale_show_with_http_info(project_id, job_id, id, job_locale_show, opts)
+ data
+ end
+
+ # Get a single job locale
+ # Get a single job locale for a given job.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_show [JobLocaleShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(JobLocale)>, Integer, Hash)>] Response<(JobLocale)> data, response status code and response headers
+ def job_locale_show_with_http_info(project_id, job_id, id, job_locale_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_show"
+ end
+ # verify the required parameter 'job_id' is set
+ if @api_client.config.client_side_validation && job_id.nil?
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_show"
+ end
+ # verify the required parameter 'job_locale_show' is set
+ if @api_client.config.client_side_validation && job_locale_show.nil?
+ fail ArgumentError, "Missing the required parameter 'job_locale_show' when calling JobLocalesApi.job_locale_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{job_id}/locale/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_locale_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'JobLocale'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a job locale
+ # Update an existing job locale.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_update [JobLocaleUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_locale_update(project_id, job_id, id, job_locale_update, opts = {})
+ data, _status_code, _headers = job_locale_update_with_http_info(project_id, job_id, id, job_locale_update, opts)
+ data
+ end
+
+ # Update a job locale
+ # Update an existing job locale.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param id [String] ID
+ # @param job_locale_update [JobLocaleUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_locale_update_with_http_info(project_id, job_id, id, job_locale_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locale_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locale_update"
+ end
+ # verify the required parameter 'job_id' is set
+ if @api_client.config.client_side_validation && job_id.nil?
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locale_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_update"
+ end
+ # verify the required parameter 'job_locale_update' is set
+ if @api_client.config.client_side_validation && job_locale_update.nil?
+ fail ArgumentError, "Missing the required parameter 'job_locale_update' when calling JobLocalesApi.job_locale_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_locale_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobLocalesApi#job_locale_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Create a job locale
+ # Create a new job locale.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param job_locales_create [JobLocalesCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def job_locales_create(project_id, job_id, job_locales_create, opts = {})
+ job_locales_create_with_http_info(project_id, job_id, job_locales_create, opts)
+ nil
+ end
+
+ # Create a job locale
+ # Create a new job locale.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param job_locales_create [JobLocalesCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def job_locales_create_with_http_info(project_id, job_id, job_locales_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locales_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locales_create"
+ end
+ # verify the required parameter 'job_id' is set
+ if @api_client.config.client_side_validation && job_id.nil?
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locales_create"
+ end
+ # verify the required parameter 'job_locales_create' is set
+ if @api_client.config.client_side_validation && job_locales_create.nil?
+ fail ArgumentError, "Missing the required parameter 'job_locales_create' when calling JobLocalesApi.job_locales_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{job_id}/locales'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_locales_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobLocalesApi#job_locales_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List job locales
+ # List all job locales for a given job.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param job_locales_list [JobLocalesList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def job_locales_list(project_id, job_id, job_locales_list, opts = {})
+ data, _status_code, _headers = job_locales_list_with_http_info(project_id, job_id, job_locales_list, opts)
+ data
+ end
+
+ # List job locales
+ # List all job locales for a given job.
+ # @param project_id [String] Project ID
+ # @param job_id [String] Job ID
+ # @param job_locales_list [JobLocalesList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def job_locales_list_with_http_info(project_id, job_id, job_locales_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobLocalesApi.job_locales_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobLocalesApi.job_locales_list"
+ end
+ # verify the required parameter 'job_id' is set
+ if @api_client.config.client_side_validation && job_id.nil?
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling JobLocalesApi.job_locales_list"
+ end
+ # verify the required parameter 'job_locales_list' is set
+ if @api_client.config.client_side_validation && job_locales_list.nil?
+ fail ArgumentError, "Missing the required parameter 'job_locales_list' when calling JobLocalesApi.job_locales_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{job_id}/locales'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_locales_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobLocalesApi#job_locales_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/jobs_api.rb b/lib/Phrase/api/jobs_api.rb
new file mode 100644
index 0000000..df45385
--- /dev/null
+++ b/lib/Phrase/api/jobs_api.rb
@@ -0,0 +1,798 @@
+require 'cgi'
+
+module Phrase
+ class JobsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Complete a job
+ # Mark a job as completed.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_complete [JobComplete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_complete(project_id, id, job_complete, opts = {})
+ data, _status_code, _headers = job_complete_with_http_info(project_id, id, job_complete, opts)
+ data
+ end
+
+ # Complete a job
+ # Mark a job as completed.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_complete [JobComplete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_complete_with_http_info(project_id, id, job_complete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_complete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_complete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_complete"
+ end
+ # verify the required parameter 'job_complete' is set
+ if @api_client.config.client_side_validation && job_complete.nil?
+ fail ArgumentError, "Missing the required parameter 'job_complete' when calling JobsApi.job_complete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{id}/complete'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_complete)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_complete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Create a job
+ # Create a new job.
+ # @param project_id [String] Project ID
+ # @param job_create [JobCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def job_create(project_id, job_create, opts = {})
+ job_create_with_http_info(project_id, job_create, opts)
+ nil
+ end
+
+ # Create a job
+ # Create a new job.
+ # @param project_id [String] Project ID
+ # @param job_create [JobCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def job_create_with_http_info(project_id, job_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_create"
+ end
+ # verify the required parameter 'job_create' is set
+ if @api_client.config.client_side_validation && job_create.nil?
+ fail ArgumentError, "Missing the required parameter 'job_create' when calling JobsApi.job_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a job
+ # Delete an existing job.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_delete [JobDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def job_delete(project_id, id, job_delete, opts = {})
+ job_delete_with_http_info(project_id, id, job_delete, opts)
+ nil
+ end
+
+ # Delete a job
+ # Delete an existing job.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_delete [JobDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def job_delete_with_http_info(project_id, id, job_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_delete"
+ end
+ # verify the required parameter 'job_delete' is set
+ if @api_client.config.client_side_validation && job_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'job_delete' when calling JobsApi.job_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Add keys to job
+ # Add multiple keys to a existing job.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_keys_create [JobKeysCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_keys_create(project_id, id, job_keys_create, opts = {})
+ data, _status_code, _headers = job_keys_create_with_http_info(project_id, id, job_keys_create, opts)
+ data
+ end
+
+ # Add keys to job
+ # Add multiple keys to a existing job.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_keys_create [JobKeysCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_keys_create_with_http_info(project_id, id, job_keys_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_keys_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_keys_create"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_keys_create"
+ end
+ # verify the required parameter 'job_keys_create' is set
+ if @api_client.config.client_side_validation && job_keys_create.nil?
+ fail ArgumentError, "Missing the required parameter 'job_keys_create' when calling JobsApi.job_keys_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{id}/keys'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_keys_create)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_keys_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Remove keys from job
+ # Remove multiple keys from existing job.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_keys_delete [JobKeysDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def job_keys_delete(project_id, id, job_keys_delete, opts = {})
+ job_keys_delete_with_http_info(project_id, id, job_keys_delete, opts)
+ nil
+ end
+
+ # Remove keys from job
+ # Remove multiple keys from existing job.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_keys_delete [JobKeysDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def job_keys_delete_with_http_info(project_id, id, job_keys_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_keys_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_keys_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_keys_delete"
+ end
+ # verify the required parameter 'job_keys_delete' is set
+ if @api_client.config.client_side_validation && job_keys_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'job_keys_delete' when calling JobsApi.job_keys_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{id}/keys'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_keys_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_keys_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Reopen a job
+ # Mark a job as uncompleted.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_reopen [JobReopen]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_reopen(project_id, id, job_reopen, opts = {})
+ data, _status_code, _headers = job_reopen_with_http_info(project_id, id, job_reopen, opts)
+ data
+ end
+
+ # Reopen a job
+ # Mark a job as uncompleted.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_reopen [JobReopen]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_reopen_with_http_info(project_id, id, job_reopen, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_reopen ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_reopen"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_reopen"
+ end
+ # verify the required parameter 'job_reopen' is set
+ if @api_client.config.client_side_validation && job_reopen.nil?
+ fail ArgumentError, "Missing the required parameter 'job_reopen' when calling JobsApi.job_reopen"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{id}/reopen'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_reopen)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_reopen\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single job
+ # Get details on a single job for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_show [JobShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_show(project_id, id, job_show, opts = {})
+ data, _status_code, _headers = job_show_with_http_info(project_id, id, job_show, opts)
+ data
+ end
+
+ # Get a single job
+ # Get details on a single job for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_show [JobShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_show_with_http_info(project_id, id, job_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_show"
+ end
+ # verify the required parameter 'job_show' is set
+ if @api_client.config.client_side_validation && job_show.nil?
+ fail ArgumentError, "Missing the required parameter 'job_show' when calling JobsApi.job_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Start a job
+ # Starts an existing job in state draft.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_start [JobStart]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_start(project_id, id, job_start, opts = {})
+ data, _status_code, _headers = job_start_with_http_info(project_id, id, job_start, opts)
+ data
+ end
+
+ # Start a job
+ # Starts an existing job in state draft.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_start [JobStart]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_start_with_http_info(project_id, id, job_start, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_start ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_start"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_start"
+ end
+ # verify the required parameter 'job_start' is set
+ if @api_client.config.client_side_validation && job_start.nil?
+ fail ArgumentError, "Missing the required parameter 'job_start' when calling JobsApi.job_start"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{id}/start'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_start)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a job
+ # Update an existing job.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_update [JobUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def job_update(project_id, id, job_update, opts = {})
+ data, _status_code, _headers = job_update_with_http_info(project_id, id, job_update, opts)
+ data
+ end
+
+ # Update a job
+ # Update an existing job.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param job_update [JobUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def job_update_with_http_info(project_id, id, job_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.job_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.job_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling JobsApi.job_update"
+ end
+ # verify the required parameter 'job_update' is set
+ if @api_client.config.client_side_validation && job_update.nil?
+ fail ArgumentError, "Missing the required parameter 'job_update' when calling JobsApi.job_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(job_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#job_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List jobs
+ # List all jobs for the given project.
+ # @param project_id [String] Project ID
+ # @param jobs_list [JobsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def jobs_list(project_id, jobs_list, opts = {})
+ data, _status_code, _headers = jobs_list_with_http_info(project_id, jobs_list, opts)
+ data
+ end
+
+ # List jobs
+ # List all jobs for the given project.
+ # @param project_id [String] Project ID
+ # @param jobs_list [JobsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def jobs_list_with_http_info(project_id, jobs_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: JobsApi.jobs_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling JobsApi.jobs_list"
+ end
+ # verify the required parameter 'jobs_list' is set
+ if @api_client.config.client_side_validation && jobs_list.nil?
+ fail ArgumentError, "Missing the required parameter 'jobs_list' when calling JobsApi.jobs_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/jobs'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(jobs_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: JobsApi#jobs_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/keys_api.rb b/lib/Phrase/api/keys_api.rb
new file mode 100644
index 0000000..ae405f7
--- /dev/null
+++ b/lib/Phrase/api/keys_api.rb
@@ -0,0 +1,702 @@
+require 'cgi'
+
+module Phrase
+ class KeysApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a key
+ # Create a new key.
+ # @param project_id [String] Project ID
+ # @param key_create [KeyCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def key_create(project_id, key_create, opts = {})
+ key_create_with_http_info(project_id, key_create, opts)
+ nil
+ end
+
+ # Create a key
+ # Create a new key.
+ # @param project_id [String] Project ID
+ # @param key_create [KeyCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def key_create_with_http_info(project_id, key_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.key_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.key_create"
+ end
+ # verify the required parameter 'key_create' is set
+ if @api_client.config.client_side_validation && key_create.nil?
+ fail ArgumentError, "Missing the required parameter 'key_create' when calling KeysApi.key_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(key_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#key_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a key
+ # Delete an existing key.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param key_delete [KeyDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def key_delete(project_id, id, key_delete, opts = {})
+ key_delete_with_http_info(project_id, id, key_delete, opts)
+ nil
+ end
+
+ # Delete a key
+ # Delete an existing key.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param key_delete [KeyDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def key_delete_with_http_info(project_id, id, key_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.key_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.key_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling KeysApi.key_delete"
+ end
+ # verify the required parameter 'key_delete' is set
+ if @api_client.config.client_side_validation && key_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'key_delete' when calling KeysApi.key_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(key_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#key_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single key
+ # Get details on a single key for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param key_show [KeyShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def key_show(project_id, id, key_show, opts = {})
+ data, _status_code, _headers = key_show_with_http_info(project_id, id, key_show, opts)
+ data
+ end
+
+ # Get a single key
+ # Get details on a single key for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param key_show [KeyShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def key_show_with_http_info(project_id, id, key_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.key_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.key_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling KeysApi.key_show"
+ end
+ # verify the required parameter 'key_show' is set
+ if @api_client.config.client_side_validation && key_show.nil?
+ fail ArgumentError, "Missing the required parameter 'key_show' when calling KeysApi.key_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(key_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#key_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a key
+ # Update an existing key.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param key_update [KeyUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def key_update(project_id, id, key_update, opts = {})
+ data, _status_code, _headers = key_update_with_http_info(project_id, id, key_update, opts)
+ data
+ end
+
+ # Update a key
+ # Update an existing key.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param key_update [KeyUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def key_update_with_http_info(project_id, id, key_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.key_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.key_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling KeysApi.key_update"
+ end
+ # verify the required parameter 'key_update' is set
+ if @api_client.config.client_side_validation && key_update.nil?
+ fail ArgumentError, "Missing the required parameter 'key_update' when calling KeysApi.key_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(key_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#key_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete collection of keys
+ # Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
+ # @param project_id [String] Project ID
+ # @param keys_delete [KeysDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [AffectedResources]
+ def keys_delete(project_id, keys_delete, opts = {})
+ data, _status_code, _headers = keys_delete_with_http_info(project_id, keys_delete, opts)
+ data
+ end
+
+ # Delete collection of keys
+ # Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
+ # @param project_id [String] Project ID
+ # @param keys_delete [KeysDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(AffectedResources)>, Integer, Hash)>] Response<(AffectedResources)> data, response status code and response headers
+ def keys_delete_with_http_info(project_id, keys_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.keys_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.keys_delete"
+ end
+ # verify the required parameter 'keys_delete' is set
+ if @api_client.config.client_side_validation && keys_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'keys_delete' when calling KeysApi.keys_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(keys_delete)
+
+ # return_type
+ return_type = opts[:return_type] || 'AffectedResources'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#keys_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List keys
+ # List all keys for the given project. Alternatively you can POST requests to /search.
+ # @param project_id [String] Project ID
+ # @param keys_list [KeysList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def keys_list(project_id, keys_list, opts = {})
+ data, _status_code, _headers = keys_list_with_http_info(project_id, keys_list, opts)
+ data
+ end
+
+ # List keys
+ # List all keys for the given project. Alternatively you can POST requests to /search.
+ # @param project_id [String] Project ID
+ # @param keys_list [KeysList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def keys_list_with_http_info(project_id, keys_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.keys_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.keys_list"
+ end
+ # verify the required parameter 'keys_list' is set
+ if @api_client.config.client_side_validation && keys_list.nil?
+ fail ArgumentError, "Missing the required parameter 'keys_list' when calling KeysApi.keys_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(keys_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#keys_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Search keys
+ # Search keys for the given project matching query.
+ # @param project_id [String] Project ID
+ # @param keys_search [KeysSearch]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def keys_search(project_id, keys_search, opts = {})
+ data, _status_code, _headers = keys_search_with_http_info(project_id, keys_search, opts)
+ data
+ end
+
+ # Search keys
+ # Search keys for the given project matching query.
+ # @param project_id [String] Project ID
+ # @param keys_search [KeysSearch]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def keys_search_with_http_info(project_id, keys_search, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.keys_search ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.keys_search"
+ end
+ # verify the required parameter 'keys_search' is set
+ if @api_client.config.client_side_validation && keys_search.nil?
+ fail ArgumentError, "Missing the required parameter 'keys_search' when calling KeysApi.keys_search"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/search'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(keys_search)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#keys_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Add tags to collection of keys
+ # Tags all keys matching query. Same constraints as list.
+ # @param project_id [String] Project ID
+ # @param keys_tag [KeysTag]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def keys_tag(project_id, keys_tag, opts = {})
+ data, _status_code, _headers = keys_tag_with_http_info(project_id, keys_tag, opts)
+ data
+ end
+
+ # Add tags to collection of keys
+ # Tags all keys matching query. Same constraints as list.
+ # @param project_id [String] Project ID
+ # @param keys_tag [KeysTag]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def keys_tag_with_http_info(project_id, keys_tag, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.keys_tag ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.keys_tag"
+ end
+ # verify the required parameter 'keys_tag' is set
+ if @api_client.config.client_side_validation && keys_tag.nil?
+ fail ArgumentError, "Missing the required parameter 'keys_tag' when calling KeysApi.keys_tag"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/tag'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(keys_tag)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#keys_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Remove tags from collection of keys
+ # Removes specified tags from keys matching query.
+ # @param project_id [String] Project ID
+ # @param keys_untag [KeysUntag]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def keys_untag(project_id, keys_untag, opts = {})
+ data, _status_code, _headers = keys_untag_with_http_info(project_id, keys_untag, opts)
+ data
+ end
+
+ # Remove tags from collection of keys
+ # Removes specified tags from keys matching query.
+ # @param project_id [String] Project ID
+ # @param keys_untag [KeysUntag]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def keys_untag_with_http_info(project_id, keys_untag, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: KeysApi.keys_untag ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling KeysApi.keys_untag"
+ end
+ # verify the required parameter 'keys_untag' is set
+ if @api_client.config.client_side_validation && keys_untag.nil?
+ fail ArgumentError, "Missing the required parameter 'keys_untag' when calling KeysApi.keys_untag"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/untag'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(keys_untag)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: KeysApi#keys_untag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/locales_api.rb b/lib/Phrase/api/locales_api.rb
new file mode 100644
index 0000000..eb3b49e
--- /dev/null
+++ b/lib/Phrase/api/locales_api.rb
@@ -0,0 +1,478 @@
+require 'cgi'
+
+module Phrase
+ class LocalesApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a locale
+ # Create a new locale.
+ # @param project_id [String] Project ID
+ # @param locale_create [LocaleCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def locale_create(project_id, locale_create, opts = {})
+ locale_create_with_http_info(project_id, locale_create, opts)
+ nil
+ end
+
+ # Create a locale
+ # Create a new locale.
+ # @param project_id [String] Project ID
+ # @param locale_create [LocaleCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def locale_create_with_http_info(project_id, locale_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locale_create"
+ end
+ # verify the required parameter 'locale_create' is set
+ if @api_client.config.client_side_validation && locale_create.nil?
+ fail ArgumentError, "Missing the required parameter 'locale_create' when calling LocalesApi.locale_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/locales'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(locale_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: LocalesApi#locale_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a locale
+ # Delete an existing locale.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param locale_delete [LocaleDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def locale_delete(project_id, id, locale_delete, opts = {})
+ locale_delete_with_http_info(project_id, id, locale_delete, opts)
+ nil
+ end
+
+ # Delete a locale
+ # Delete an existing locale.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param locale_delete [LocaleDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def locale_delete_with_http_info(project_id, id, locale_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locale_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling LocalesApi.locale_delete"
+ end
+ # verify the required parameter 'locale_delete' is set
+ if @api_client.config.client_side_validation && locale_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'locale_delete' when calling LocalesApi.locale_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(locale_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: LocalesApi#locale_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Download a locale
+ # Download a locale in a specific file format.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param locale_download [LocaleDownload]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def locale_download(project_id, id, locale_download, opts = {})
+ locale_download_with_http_info(project_id, id, locale_download, opts)
+ nil
+ end
+
+ # Download a locale
+ # Download a locale in a specific file format.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param locale_download [LocaleDownload]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def locale_download_with_http_info(project_id, id, locale_download, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_download ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locale_download"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling LocalesApi.locale_download"
+ end
+ # verify the required parameter 'locale_download' is set
+ if @api_client.config.client_side_validation && locale_download.nil?
+ fail ArgumentError, "Missing the required parameter 'locale_download' when calling LocalesApi.locale_download"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/locales/{id}/download'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(locale_download)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: LocalesApi#locale_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single locale
+ # Get details on a single locale for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param locale_show [LocaleShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def locale_show(project_id, id, locale_show, opts = {})
+ data, _status_code, _headers = locale_show_with_http_info(project_id, id, locale_show, opts)
+ data
+ end
+
+ # Get a single locale
+ # Get details on a single locale for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param locale_show [LocaleShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def locale_show_with_http_info(project_id, id, locale_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locale_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling LocalesApi.locale_show"
+ end
+ # verify the required parameter 'locale_show' is set
+ if @api_client.config.client_side_validation && locale_show.nil?
+ fail ArgumentError, "Missing the required parameter 'locale_show' when calling LocalesApi.locale_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(locale_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: LocalesApi#locale_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a locale
+ # Update an existing locale.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param locale_update [LocaleUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def locale_update(project_id, id, locale_update, opts = {})
+ data, _status_code, _headers = locale_update_with_http_info(project_id, id, locale_update, opts)
+ data
+ end
+
+ # Update a locale
+ # Update an existing locale.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param locale_update [LocaleUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def locale_update_with_http_info(project_id, id, locale_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locale_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling LocalesApi.locale_update"
+ end
+ # verify the required parameter 'locale_update' is set
+ if @api_client.config.client_side_validation && locale_update.nil?
+ fail ArgumentError, "Missing the required parameter 'locale_update' when calling LocalesApi.locale_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(locale_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: LocalesApi#locale_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List locales
+ # List all locales for the given project.
+ # @param project_id [String] Project ID
+ # @param locales_list [LocalesList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def locales_list(project_id, locales_list, opts = {})
+ data, _status_code, _headers = locales_list_with_http_info(project_id, locales_list, opts)
+ data
+ end
+
+ # List locales
+ # List all locales for the given project.
+ # @param project_id [String] Project ID
+ # @param locales_list [LocalesList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def locales_list_with_http_info(project_id, locales_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locales_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locales_list"
+ end
+ # verify the required parameter 'locales_list' is set
+ if @api_client.config.client_side_validation && locales_list.nil?
+ fail ArgumentError, "Missing the required parameter 'locales_list' when calling LocalesApi.locales_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/locales'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(locales_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: LocalesApi#locales_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/members_api.rb b/lib/Phrase/api/members_api.rb
new file mode 100644
index 0000000..a4ca267
--- /dev/null
+++ b/lib/Phrase/api/members_api.rb
@@ -0,0 +1,304 @@
+require 'cgi'
+
+module Phrase
+ class MembersApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Remove a user from the account
+ # Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def member_delete(account_id, id, opts = {})
+ member_delete_with_http_info(account_id, id, opts)
+ nil
+ end
+
+ # Remove a user from the account
+ # Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include <code>team.manage</code>.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def member_delete_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: MembersApi.member_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling MembersApi.member_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling MembersApi.member_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/members/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: MembersApi#member_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get single member
+ # Get details on a single user in the account. Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Member]
+ def member_show(account_id, id, opts = {})
+ data, _status_code, _headers = member_show_with_http_info(account_id, id, opts)
+ data
+ end
+
+ # Get single member
+ # Get details on a single user in the account. Access token scope must include <code>team.manage</code>.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Member)>, Integer, Hash)>] Response<(Member)> data, response status code and response headers
+ def member_show_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: MembersApi.member_show ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling MembersApi.member_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling MembersApi.member_show"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/members/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Member'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: MembersApi#member_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a member
+ # Update user permissions in the account. Developers and translators need project_ids and locale_ids assigned to access them. Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param member_update [MemberUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def member_update(account_id, id, member_update, opts = {})
+ data, _status_code, _headers = member_update_with_http_info(account_id, id, member_update, opts)
+ data
+ end
+
+ # Update a member
+ # Update user permissions in the 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>.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param member_update [MemberUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def member_update_with_http_info(account_id, id, member_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: MembersApi.member_update ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling MembersApi.member_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling MembersApi.member_update"
+ end
+ # verify the required parameter 'member_update' is set
+ if @api_client.config.client_side_validation && member_update.nil?
+ fail ArgumentError, "Missing the required parameter 'member_update' when calling MembersApi.member_update"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/members/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(member_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: MembersApi#member_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List members
+ # Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include team.manage.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def members_list(account_id, opts = {})
+ data, _status_code, _headers = members_list_with_http_info(account_id, opts)
+ data
+ end
+
+ # List members
+ # Get all users active in the account. It also lists resources like projects and locales the member 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>.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def members_list_with_http_info(account_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: MembersApi.members_list ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling MembersApi.members_list"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/members'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: MembersApi#members_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/orders_api.rb b/lib/Phrase/api/orders_api.rb
new file mode 100644
index 0000000..ef60ed2
--- /dev/null
+++ b/lib/Phrase/api/orders_api.rb
@@ -0,0 +1,400 @@
+require 'cgi'
+
+module Phrase
+ class OrdersApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Confirm an order
+ # Confirm an existing order and send it to the provider for translation. Same constraints as for create.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param order_confirm [OrderConfirm]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def order_confirm(project_id, id, order_confirm, opts = {})
+ data, _status_code, _headers = order_confirm_with_http_info(project_id, id, order_confirm, opts)
+ data
+ end
+
+ # Confirm an order
+ # Confirm an existing order and send it to the provider for translation. Same constraints as for create.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param order_confirm [OrderConfirm]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def order_confirm_with_http_info(project_id, id, order_confirm, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: OrdersApi.order_confirm ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling OrdersApi.order_confirm"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.order_confirm"
+ end
+ # verify the required parameter 'order_confirm' is set
+ if @api_client.config.client_side_validation && order_confirm.nil?
+ fail ArgumentError, "Missing the required parameter 'order_confirm' when calling OrdersApi.order_confirm"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/orders/{id}/confirm'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(order_confirm)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: OrdersApi#order_confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Create a new order
+ # Create a new order. Access token scope must include orders.create.
+ # @param project_id [String] Project ID
+ # @param order_create [OrderCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def order_create(project_id, order_create, opts = {})
+ order_create_with_http_info(project_id, order_create, opts)
+ nil
+ end
+
+ # Create a new order
+ # Create a new order. Access token scope must include <code>orders.create</code>.
+ # @param project_id [String] Project ID
+ # @param order_create [OrderCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def order_create_with_http_info(project_id, order_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: OrdersApi.order_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling OrdersApi.order_create"
+ end
+ # verify the required parameter 'order_create' is set
+ if @api_client.config.client_side_validation && order_create.nil?
+ fail ArgumentError, "Missing the required parameter 'order_create' when calling OrdersApi.order_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/orders'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(order_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: OrdersApi#order_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Cancel an order
+ # Cancel an existing order. Must not yet be confirmed.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param order_delete [OrderDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def order_delete(project_id, id, order_delete, opts = {})
+ order_delete_with_http_info(project_id, id, order_delete, opts)
+ nil
+ end
+
+ # Cancel an order
+ # Cancel an existing order. Must not yet be confirmed.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param order_delete [OrderDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def order_delete_with_http_info(project_id, id, order_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: OrdersApi.order_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling OrdersApi.order_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.order_delete"
+ end
+ # verify the required parameter 'order_delete' is set
+ if @api_client.config.client_side_validation && order_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'order_delete' when calling OrdersApi.order_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/orders/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(order_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: OrdersApi#order_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single order
+ # Get details on a single order.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param order_show [OrderShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [TranslationOrder]
+ def order_show(project_id, id, order_show, opts = {})
+ data, _status_code, _headers = order_show_with_http_info(project_id, id, order_show, opts)
+ data
+ end
+
+ # Get a single order
+ # Get details on a single order.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param order_show [OrderShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(TranslationOrder)>, Integer, Hash)>] Response<(TranslationOrder)> data, response status code and response headers
+ def order_show_with_http_info(project_id, id, order_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: OrdersApi.order_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling OrdersApi.order_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.order_show"
+ end
+ # verify the required parameter 'order_show' is set
+ if @api_client.config.client_side_validation && order_show.nil?
+ fail ArgumentError, "Missing the required parameter 'order_show' when calling OrdersApi.order_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/orders/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(order_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'TranslationOrder'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: OrdersApi#order_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List orders
+ # List all orders for the given project.
+ # @param project_id [String] Project ID
+ # @param orders_list [OrdersList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def orders_list(project_id, orders_list, opts = {})
+ data, _status_code, _headers = orders_list_with_http_info(project_id, orders_list, opts)
+ data
+ end
+
+ # List orders
+ # List all orders for the given project.
+ # @param project_id [String] Project ID
+ # @param orders_list [OrdersList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def orders_list_with_http_info(project_id, orders_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: OrdersApi.orders_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling OrdersApi.orders_list"
+ end
+ # verify the required parameter 'orders_list' is set
+ if @api_client.config.client_side_validation && orders_list.nil?
+ fail ArgumentError, "Missing the required parameter 'orders_list' when calling OrdersApi.orders_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/orders'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(orders_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: OrdersApi#orders_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/projects_api.rb b/lib/Phrase/api/projects_api.rb
new file mode 100644
index 0000000..02396b1
--- /dev/null
+++ b/lib/Phrase/api/projects_api.rb
@@ -0,0 +1,346 @@
+require 'cgi'
+
+module Phrase
+ class ProjectsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a project
+ # Create a new project.
+ # @param project_create [ProjectCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def project_create(project_create, opts = {})
+ project_create_with_http_info(project_create, opts)
+ nil
+ end
+
+ # Create a project
+ # Create a new project.
+ # @param project_create [ProjectCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def project_create_with_http_info(project_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ProjectsApi.project_create ...'
+ end
+ # verify the required parameter 'project_create' is set
+ if @api_client.config.client_side_validation && project_create.nil?
+ fail ArgumentError, "Missing the required parameter 'project_create' when calling ProjectsApi.project_create"
+ end
+ # resource path
+ local_var_path = '/projects'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(project_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ProjectsApi#project_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a project
+ # Delete an existing project.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def project_delete(id, opts = {})
+ project_delete_with_http_info(id, opts)
+ nil
+ end
+
+ # Delete a project
+ # Delete an existing project.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def project_delete_with_http_info(id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ProjectsApi.project_delete ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.project_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ProjectsApi#project_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single project
+ # Get details on a single project.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Project]
+ def project_show(id, opts = {})
+ data, _status_code, _headers = project_show_with_http_info(id, opts)
+ data
+ end
+
+ # Get a single project
+ # Get details on a single project.
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Project)>, Integer, Hash)>] Response<(Project)> data, response status code and response headers
+ def project_show_with_http_info(id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ProjectsApi.project_show ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.project_show"
+ end
+ # resource path
+ local_var_path = '/projects/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Project'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ProjectsApi#project_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a project
+ # Update an existing project.
+ # @param id [String] ID
+ # @param project_update [ProjectUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def project_update(id, project_update, opts = {})
+ data, _status_code, _headers = project_update_with_http_info(id, project_update, opts)
+ data
+ end
+
+ # Update a project
+ # Update an existing project.
+ # @param id [String] ID
+ # @param project_update [ProjectUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def project_update_with_http_info(id, project_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ProjectsApi.project_update ...'
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.project_update"
+ end
+ # verify the required parameter 'project_update' is set
+ if @api_client.config.client_side_validation && project_update.nil?
+ fail ArgumentError, "Missing the required parameter 'project_update' when calling ProjectsApi.project_update"
+ end
+ # resource path
+ local_var_path = '/projects/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(project_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ProjectsApi#project_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List projects
+ # List all projects the current user has access to.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def projects_list(opts = {})
+ data, _status_code, _headers = projects_list_with_http_info(opts)
+ data
+ end
+
+ # List projects
+ # List all projects the current user has access to.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def projects_list_with_http_info(opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ProjectsApi.projects_list ...'
+ end
+ # resource path
+ local_var_path = '/projects'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ProjectsApi#projects_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/releases_api.rb b/lib/Phrase/api/releases_api.rb
new file mode 100644
index 0000000..ce5efb3
--- /dev/null
+++ b/lib/Phrase/api/releases_api.rb
@@ -0,0 +1,484 @@
+require 'cgi'
+
+module Phrase
+ class ReleasesApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a release
+ # Create a new release.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param release_create [ReleaseCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def release_create(account_id, distribution_id, release_create, opts = {})
+ release_create_with_http_info(account_id, distribution_id, release_create, opts)
+ nil
+ end
+
+ # Create a release
+ # Create a new release.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param release_create [ReleaseCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def release_create_with_http_info(account_id, distribution_id, release_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ReleasesApi.release_create ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_create"
+ end
+ # verify the required parameter 'distribution_id' is set
+ if @api_client.config.client_side_validation && distribution_id.nil?
+ fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_create"
+ end
+ # verify the required parameter 'release_create' is set
+ if @api_client.config.client_side_validation && release_create.nil?
+ fail ArgumentError, "Missing the required parameter 'release_create' when calling ReleasesApi.release_create"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(release_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ReleasesApi#release_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a release
+ # Delete an existing release.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def release_delete(account_id, distribution_id, id, opts = {})
+ release_delete_with_http_info(account_id, distribution_id, id, opts)
+ nil
+ end
+
+ # Delete a release
+ # Delete an existing release.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def release_delete_with_http_info(account_id, distribution_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ReleasesApi.release_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_delete"
+ end
+ # verify the required parameter 'distribution_id' is set
+ if @api_client.config.client_side_validation && distribution_id.nil?
+ fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ReleasesApi.release_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ReleasesApi#release_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Publish a release
+ # Publish a release for production.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def release_publish(account_id, distribution_id, id, opts = {})
+ data, _status_code, _headers = release_publish_with_http_info(account_id, distribution_id, id, opts)
+ data
+ end
+
+ # Publish a release
+ # Publish a release for production.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def release_publish_with_http_info(account_id, distribution_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ReleasesApi.release_publish ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_publish"
+ end
+ # verify the required parameter 'distribution_id' is set
+ if @api_client.config.client_side_validation && distribution_id.nil?
+ fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_publish"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ReleasesApi.release_publish"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ReleasesApi#release_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single release
+ # Get details on a single release.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Release]
+ def release_show(account_id, distribution_id, id, opts = {})
+ data, _status_code, _headers = release_show_with_http_info(account_id, distribution_id, id, opts)
+ data
+ end
+
+ # Get a single release
+ # Get details on a single release.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Release)>, Integer, Hash)>] Response<(Release)> data, response status code and response headers
+ def release_show_with_http_info(account_id, distribution_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ReleasesApi.release_show ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_show"
+ end
+ # verify the required parameter 'distribution_id' is set
+ if @api_client.config.client_side_validation && distribution_id.nil?
+ fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ReleasesApi.release_show"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Release'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ReleasesApi#release_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a release
+ # Update an existing release.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param id [String] ID
+ # @param release_update [ReleaseUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def release_update(account_id, distribution_id, id, release_update, opts = {})
+ data, _status_code, _headers = release_update_with_http_info(account_id, distribution_id, id, release_update, opts)
+ data
+ end
+
+ # Update a release
+ # Update an existing release.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param id [String] ID
+ # @param release_update [ReleaseUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def release_update_with_http_info(account_id, distribution_id, id, release_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ReleasesApi.release_update ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.release_update"
+ end
+ # verify the required parameter 'distribution_id' is set
+ if @api_client.config.client_side_validation && distribution_id.nil?
+ fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.release_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ReleasesApi.release_update"
+ end
+ # verify the required parameter 'release_update' is set
+ if @api_client.config.client_side_validation && release_update.nil?
+ fail ArgumentError, "Missing the required parameter 'release_update' when calling ReleasesApi.release_update"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(release_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ReleasesApi#release_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List releases
+ # List all releases for the given distribution.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def releases_list(account_id, distribution_id, opts = {})
+ data, _status_code, _headers = releases_list_with_http_info(account_id, distribution_id, opts)
+ data
+ end
+
+ # List releases
+ # List all releases for the given distribution.
+ # @param account_id [String] Account ID
+ # @param distribution_id [String] Distribution ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def releases_list_with_http_info(account_id, distribution_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ReleasesApi.releases_list ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling ReleasesApi.releases_list"
+ end
+ # verify the required parameter 'distribution_id' is set
+ if @api_client.config.client_side_validation && distribution_id.nil?
+ fail ArgumentError, "Missing the required parameter 'distribution_id' when calling ReleasesApi.releases_list"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/distributions/{distribution_id}/releases'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'distribution_id' + '}', CGI.escape(distribution_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ReleasesApi#releases_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/screenshot_markers_api.rb b/lib/Phrase/api/screenshot_markers_api.rb
new file mode 100644
index 0000000..62cf416
--- /dev/null
+++ b/lib/Phrase/api/screenshot_markers_api.rb
@@ -0,0 +1,394 @@
+require 'cgi'
+
+module Phrase
+ class ScreenshotMarkersApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a screenshot marker
+ # Create a new screenshot marker.
+ # @param project_id [String] Project ID
+ # @param screenshot_id [String] Screenshot ID
+ # @param screenshot_marker_create [ScreenshotMarkerCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def screenshot_marker_create(project_id, screenshot_id, screenshot_marker_create, opts = {})
+ screenshot_marker_create_with_http_info(project_id, screenshot_id, screenshot_marker_create, opts)
+ nil
+ end
+
+ # Create a screenshot marker
+ # Create a new screenshot marker.
+ # @param project_id [String] Project ID
+ # @param screenshot_id [String] Screenshot ID
+ # @param screenshot_marker_create [ScreenshotMarkerCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def screenshot_marker_create_with_http_info(project_id, screenshot_id, screenshot_marker_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotMarkersApi.screenshot_marker_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotMarkersApi.screenshot_marker_create"
+ end
+ # verify the required parameter 'screenshot_id' is set
+ if @api_client.config.client_side_validation && screenshot_id.nil?
+ fail ArgumentError, "Missing the required parameter 'screenshot_id' when calling ScreenshotMarkersApi.screenshot_marker_create"
+ end
+ # verify the required parameter 'screenshot_marker_create' is set
+ if @api_client.config.client_side_validation && screenshot_marker_create.nil?
+ fail ArgumentError, "Missing the required parameter 'screenshot_marker_create' when calling ScreenshotMarkersApi.screenshot_marker_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots/{screenshot_id}/markers'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'screenshot_id' + '}', CGI.escape(screenshot_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(screenshot_marker_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotMarkersApi#screenshot_marker_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a screenshot marker
+ # Delete an existing screenshot marker.
+ # @param project_id [String] Project ID
+ # @param screenshot_id [String] Screenshot ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def screenshot_marker_delete(project_id, screenshot_id, opts = {})
+ screenshot_marker_delete_with_http_info(project_id, screenshot_id, opts)
+ nil
+ end
+
+ # Delete a screenshot marker
+ # Delete an existing screenshot marker.
+ # @param project_id [String] Project ID
+ # @param screenshot_id [String] Screenshot ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def screenshot_marker_delete_with_http_info(project_id, screenshot_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotMarkersApi.screenshot_marker_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotMarkersApi.screenshot_marker_delete"
+ end
+ # verify the required parameter 'screenshot_id' is set
+ if @api_client.config.client_side_validation && screenshot_id.nil?
+ fail ArgumentError, "Missing the required parameter 'screenshot_id' when calling ScreenshotMarkersApi.screenshot_marker_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots/{screenshot_id}/markers'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'screenshot_id' + '}', CGI.escape(screenshot_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotMarkersApi#screenshot_marker_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single screenshot marker
+ # Get details on a single screenshot marker for a given project.
+ # @param project_id [String] Project ID
+ # @param screenshot_id [String] Screenshot ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def screenshot_marker_show(project_id, screenshot_id, id, opts = {})
+ data, _status_code, _headers = screenshot_marker_show_with_http_info(project_id, screenshot_id, id, opts)
+ data
+ end
+
+ # Get a single screenshot marker
+ # Get details on a single screenshot marker for a given project.
+ # @param project_id [String] Project ID
+ # @param screenshot_id [String] Screenshot ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def screenshot_marker_show_with_http_info(project_id, screenshot_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotMarkersApi.screenshot_marker_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotMarkersApi.screenshot_marker_show"
+ end
+ # verify the required parameter 'screenshot_id' is set
+ if @api_client.config.client_side_validation && screenshot_id.nil?
+ fail ArgumentError, "Missing the required parameter 'screenshot_id' when calling ScreenshotMarkersApi.screenshot_marker_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ScreenshotMarkersApi.screenshot_marker_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots/{screenshot_id}/markers/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'screenshot_id' + '}', CGI.escape(screenshot_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotMarkersApi#screenshot_marker_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a screenshot marker
+ # Update an existing screenshot marker.
+ # @param project_id [String] Project ID
+ # @param screenshot_id [String] Screenshot ID
+ # @param screenshot_marker_update [ScreenshotMarkerUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [ScreenshotMarker]
+ def screenshot_marker_update(project_id, screenshot_id, screenshot_marker_update, opts = {})
+ data, _status_code, _headers = screenshot_marker_update_with_http_info(project_id, screenshot_id, screenshot_marker_update, opts)
+ data
+ end
+
+ # Update a screenshot marker
+ # Update an existing screenshot marker.
+ # @param project_id [String] Project ID
+ # @param screenshot_id [String] Screenshot ID
+ # @param screenshot_marker_update [ScreenshotMarkerUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(ScreenshotMarker)>, Integer, Hash)>] Response<(ScreenshotMarker)> data, response status code and response headers
+ def screenshot_marker_update_with_http_info(project_id, screenshot_id, screenshot_marker_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotMarkersApi.screenshot_marker_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotMarkersApi.screenshot_marker_update"
+ end
+ # verify the required parameter 'screenshot_id' is set
+ if @api_client.config.client_side_validation && screenshot_id.nil?
+ fail ArgumentError, "Missing the required parameter 'screenshot_id' when calling ScreenshotMarkersApi.screenshot_marker_update"
+ end
+ # verify the required parameter 'screenshot_marker_update' is set
+ if @api_client.config.client_side_validation && screenshot_marker_update.nil?
+ fail ArgumentError, "Missing the required parameter 'screenshot_marker_update' when calling ScreenshotMarkersApi.screenshot_marker_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots/{screenshot_id}/markers'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'screenshot_id' + '}', CGI.escape(screenshot_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(screenshot_marker_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'ScreenshotMarker'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotMarkersApi#screenshot_marker_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List screenshot markers
+ # List all screenshot markers for the given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def screenshot_markers_list(project_id, id, opts = {})
+ data, _status_code, _headers = screenshot_markers_list_with_http_info(project_id, id, opts)
+ data
+ end
+
+ # List screenshot markers
+ # List all screenshot markers for the given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def screenshot_markers_list_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotMarkersApi.screenshot_markers_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotMarkersApi.screenshot_markers_list"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ScreenshotMarkersApi.screenshot_markers_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots/{id}/markers'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotMarkersApi#screenshot_markers_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/screenshots_api.rb b/lib/Phrase/api/screenshots_api.rb
new file mode 100644
index 0000000..68c24f0
--- /dev/null
+++ b/lib/Phrase/api/screenshots_api.rb
@@ -0,0 +1,376 @@
+require 'cgi'
+
+module Phrase
+ class ScreenshotsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a screenshot
+ # Create a new screenshot.
+ # @param project_id [String] Project ID
+ # @param screenshot_create [ScreenshotCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def screenshot_create(project_id, screenshot_create, opts = {})
+ screenshot_create_with_http_info(project_id, screenshot_create, opts)
+ nil
+ end
+
+ # Create a screenshot
+ # Create a new screenshot.
+ # @param project_id [String] Project ID
+ # @param screenshot_create [ScreenshotCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def screenshot_create_with_http_info(project_id, screenshot_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_create"
+ end
+ # verify the required parameter 'screenshot_create' is set
+ if @api_client.config.client_side_validation && screenshot_create.nil?
+ fail ArgumentError, "Missing the required parameter 'screenshot_create' when calling ScreenshotsApi.screenshot_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(screenshot_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotsApi#screenshot_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a screenshot
+ # Delete an existing screenshot.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def screenshot_delete(project_id, id, opts = {})
+ screenshot_delete_with_http_info(project_id, id, opts)
+ nil
+ end
+
+ # Delete a screenshot
+ # Delete an existing screenshot.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def screenshot_delete_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ScreenshotsApi.screenshot_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotsApi#screenshot_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single screenshot
+ # Get details on a single screenshot for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Screenshot]
+ def screenshot_show(project_id, id, opts = {})
+ data, _status_code, _headers = screenshot_show_with_http_info(project_id, id, opts)
+ data
+ end
+
+ # Get a single screenshot
+ # Get details on a single screenshot for a given project.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Screenshot)>, Integer, Hash)>] Response<(Screenshot)> data, response status code and response headers
+ def screenshot_show_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ScreenshotsApi.screenshot_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Screenshot'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotsApi#screenshot_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a screenshot
+ # Update an existing screenshot.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param screenshot_update [ScreenshotUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def screenshot_update(project_id, id, screenshot_update, opts = {})
+ data, _status_code, _headers = screenshot_update_with_http_info(project_id, id, screenshot_update, opts)
+ data
+ end
+
+ # Update a screenshot
+ # Update an existing screenshot.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param screenshot_update [ScreenshotUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def screenshot_update_with_http_info(project_id, id, screenshot_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshot_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshot_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling ScreenshotsApi.screenshot_update"
+ end
+ # verify the required parameter 'screenshot_update' is set
+ if @api_client.config.client_side_validation && screenshot_update.nil?
+ fail ArgumentError, "Missing the required parameter 'screenshot_update' when calling ScreenshotsApi.screenshot_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(screenshot_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotsApi#screenshot_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List screenshots
+ # List all screenshots for the given project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def screenshots_list(project_id, opts = {})
+ data, _status_code, _headers = screenshots_list_with_http_info(project_id, opts)
+ data
+ end
+
+ # List screenshots
+ # List all screenshots for the given project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def screenshots_list_with_http_info(project_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: ScreenshotsApi.screenshots_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling ScreenshotsApi.screenshots_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/screenshots'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: ScreenshotsApi#screenshots_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/spaces_api.rb b/lib/Phrase/api/spaces_api.rb
new file mode 100644
index 0000000..09d9eeb
--- /dev/null
+++ b/lib/Phrase/api/spaces_api.rb
@@ -0,0 +1,608 @@
+require 'cgi'
+
+module Phrase
+ class SpacesApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a Space
+ # Create a new Space.
+ # @param account_id [String] Account ID
+ # @param space_create [SpaceCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def space_create(account_id, space_create, opts = {})
+ space_create_with_http_info(account_id, space_create, opts)
+ nil
+ end
+
+ # Create a Space
+ # Create a new Space.
+ # @param account_id [String] Account ID
+ # @param space_create [SpaceCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def space_create_with_http_info(account_id, space_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: SpacesApi.space_create ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling SpacesApi.space_create"
+ end
+ # verify the required parameter 'space_create' is set
+ if @api_client.config.client_side_validation && space_create.nil?
+ fail ArgumentError, "Missing the required parameter 'space_create' when calling SpacesApi.space_create"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/spaces'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(space_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: SpacesApi#space_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete Space
+ # Delete the specified Space.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def space_delete(account_id, id, opts = {})
+ space_delete_with_http_info(account_id, id, opts)
+ nil
+ end
+
+ # Delete Space
+ # Delete the specified Space.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def space_delete_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: SpacesApi.space_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling SpacesApi.space_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling SpacesApi.space_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/spaces/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: SpacesApi#space_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get Space
+ # Show the specified Space.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Space]
+ def space_show(account_id, id, opts = {})
+ data, _status_code, _headers = space_show_with_http_info(account_id, id, opts)
+ data
+ end
+
+ # Get Space
+ # Show the specified Space.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Space)>, Integer, Hash)>] Response<(Space)> data, response status code and response headers
+ def space_show_with_http_info(account_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: SpacesApi.space_show ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling SpacesApi.space_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling SpacesApi.space_show"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/spaces/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Space'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: SpacesApi#space_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update Space
+ # Update the specified Space.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param space_update [SpaceUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Space]
+ def space_update(account_id, id, space_update, opts = {})
+ data, _status_code, _headers = space_update_with_http_info(account_id, id, space_update, opts)
+ data
+ end
+
+ # Update Space
+ # Update the specified Space.
+ # @param account_id [String] Account ID
+ # @param id [String] ID
+ # @param space_update [SpaceUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Space)>, Integer, Hash)>] Response<(Space)> data, response status code and response headers
+ def space_update_with_http_info(account_id, id, space_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: SpacesApi.space_update ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling SpacesApi.space_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling SpacesApi.space_update"
+ end
+ # verify the required parameter 'space_update' is set
+ if @api_client.config.client_side_validation && space_update.nil?
+ fail ArgumentError, "Missing the required parameter 'space_update' when calling SpacesApi.space_update"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/spaces/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(space_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Space'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: SpacesApi#space_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List Spaces
+ # List all Spaces for the given account.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def spaces_list(account_id, opts = {})
+ data, _status_code, _headers = spaces_list_with_http_info(account_id, opts)
+ data
+ end
+
+ # List Spaces
+ # List all Spaces for the given account.
+ # @param account_id [String] Account ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def spaces_list_with_http_info(account_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: SpacesApi.spaces_list ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling SpacesApi.spaces_list"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/spaces'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: SpacesApi#spaces_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Add Project
+ # Adds an existing project to the space.
+ # @param account_id [String] Account ID
+ # @param space_id [String] Space ID
+ # @param spaces_projects_create [SpacesProjectsCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def spaces_projects_create(account_id, space_id, spaces_projects_create, opts = {})
+ spaces_projects_create_with_http_info(account_id, space_id, spaces_projects_create, opts)
+ nil
+ end
+
+ # Add Project
+ # Adds an existing project to the space.
+ # @param account_id [String] Account ID
+ # @param space_id [String] Space ID
+ # @param spaces_projects_create [SpacesProjectsCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def spaces_projects_create_with_http_info(account_id, space_id, spaces_projects_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: SpacesApi.spaces_projects_create ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling SpacesApi.spaces_projects_create"
+ end
+ # verify the required parameter 'space_id' is set
+ if @api_client.config.client_side_validation && space_id.nil?
+ fail ArgumentError, "Missing the required parameter 'space_id' when calling SpacesApi.spaces_projects_create"
+ end
+ # verify the required parameter 'spaces_projects_create' is set
+ if @api_client.config.client_side_validation && spaces_projects_create.nil?
+ fail ArgumentError, "Missing the required parameter 'spaces_projects_create' when calling SpacesApi.spaces_projects_create"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/spaces/{space_id}/projects'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'space_id' + '}', CGI.escape(space_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(spaces_projects_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: SpacesApi#spaces_projects_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Remove Project
+ # Removes a specified project from the specified space.
+ # @param account_id [String] Account ID
+ # @param space_id [String] Space ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def spaces_projects_delete(account_id, space_id, id, opts = {})
+ spaces_projects_delete_with_http_info(account_id, space_id, id, opts)
+ nil
+ end
+
+ # Remove Project
+ # Removes a specified project from the specified space.
+ # @param account_id [String] Account ID
+ # @param space_id [String] Space ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def spaces_projects_delete_with_http_info(account_id, space_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: SpacesApi.spaces_projects_delete ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling SpacesApi.spaces_projects_delete"
+ end
+ # verify the required parameter 'space_id' is set
+ if @api_client.config.client_side_validation && space_id.nil?
+ fail ArgumentError, "Missing the required parameter 'space_id' when calling SpacesApi.spaces_projects_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling SpacesApi.spaces_projects_delete"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/spaces/{space_id}/projects/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'space_id' + '}', CGI.escape(space_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: SpacesApi#spaces_projects_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List Projects
+ # List all projects for the specified Space.
+ # @param account_id [String] Account ID
+ # @param space_id [String] Space ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def spaces_projects_list(account_id, space_id, opts = {})
+ data, _status_code, _headers = spaces_projects_list_with_http_info(account_id, space_id, opts)
+ data
+ end
+
+ # List Projects
+ # List all projects for the specified Space.
+ # @param account_id [String] Account ID
+ # @param space_id [String] Space ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def spaces_projects_list_with_http_info(account_id, space_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: SpacesApi.spaces_projects_list ...'
+ end
+ # verify the required parameter 'account_id' is set
+ if @api_client.config.client_side_validation && account_id.nil?
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling SpacesApi.spaces_projects_list"
+ end
+ # verify the required parameter 'space_id' is set
+ if @api_client.config.client_side_validation && space_id.nil?
+ fail ArgumentError, "Missing the required parameter 'space_id' when calling SpacesApi.spaces_projects_list"
+ end
+ # resource path
+ local_var_path = '/accounts/{account_id}/spaces/{space_id}/projects'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'space_id' + '}', CGI.escape(space_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: SpacesApi#spaces_projects_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/style_guides_api.rb b/lib/Phrase/api/style_guides_api.rb
new file mode 100644
index 0000000..8320e8a
--- /dev/null
+++ b/lib/Phrase/api/style_guides_api.rb
@@ -0,0 +1,376 @@
+require 'cgi'
+
+module Phrase
+ class StyleGuidesApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a style guide
+ # Create a new style guide.
+ # @param project_id [String] Project ID
+ # @param styleguide_create [StyleguideCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def styleguide_create(project_id, styleguide_create, opts = {})
+ styleguide_create_with_http_info(project_id, styleguide_create, opts)
+ nil
+ end
+
+ # Create a style guide
+ # Create a new style guide.
+ # @param project_id [String] Project ID
+ # @param styleguide_create [StyleguideCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def styleguide_create_with_http_info(project_id, styleguide_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: StyleGuidesApi.styleguide_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling StyleGuidesApi.styleguide_create"
+ end
+ # verify the required parameter 'styleguide_create' is set
+ if @api_client.config.client_side_validation && styleguide_create.nil?
+ fail ArgumentError, "Missing the required parameter 'styleguide_create' when calling StyleGuidesApi.styleguide_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/styleguides'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(styleguide_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: StyleGuidesApi#styleguide_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a style guide
+ # Delete an existing style guide.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def styleguide_delete(project_id, id, opts = {})
+ styleguide_delete_with_http_info(project_id, id, opts)
+ nil
+ end
+
+ # Delete a style guide
+ # Delete an existing style guide.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def styleguide_delete_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: StyleGuidesApi.styleguide_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling StyleGuidesApi.styleguide_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling StyleGuidesApi.styleguide_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/styleguides/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: StyleGuidesApi#styleguide_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single style guide
+ # Get details on a single style guide.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def styleguide_show(project_id, id, opts = {})
+ data, _status_code, _headers = styleguide_show_with_http_info(project_id, id, opts)
+ data
+ end
+
+ # Get a single style guide
+ # Get details on a single style guide.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def styleguide_show_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: StyleGuidesApi.styleguide_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling StyleGuidesApi.styleguide_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling StyleGuidesApi.styleguide_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/styleguides/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: StyleGuidesApi#styleguide_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a style guide
+ # Update an existing style guide.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param styleguide_update [StyleguideUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def styleguide_update(project_id, id, styleguide_update, opts = {})
+ data, _status_code, _headers = styleguide_update_with_http_info(project_id, id, styleguide_update, opts)
+ data
+ end
+
+ # Update a style guide
+ # Update an existing style guide.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param styleguide_update [StyleguideUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def styleguide_update_with_http_info(project_id, id, styleguide_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: StyleGuidesApi.styleguide_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling StyleGuidesApi.styleguide_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling StyleGuidesApi.styleguide_update"
+ end
+ # verify the required parameter 'styleguide_update' is set
+ if @api_client.config.client_side_validation && styleguide_update.nil?
+ fail ArgumentError, "Missing the required parameter 'styleguide_update' when calling StyleGuidesApi.styleguide_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/styleguides/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(styleguide_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: StyleGuidesApi#styleguide_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List style guides
+ # List all styleguides for the given project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def styleguides_list(project_id, opts = {})
+ data, _status_code, _headers = styleguides_list_with_http_info(project_id, opts)
+ data
+ end
+
+ # List style guides
+ # List all styleguides for the given project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def styleguides_list_with_http_info(project_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: StyleGuidesApi.styleguides_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling StyleGuidesApi.styleguides_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/styleguides'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: StyleGuidesApi#styleguides_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/tags_api.rb b/lib/Phrase/api/tags_api.rb
new file mode 100644
index 0000000..60ad9e3
--- /dev/null
+++ b/lib/Phrase/api/tags_api.rb
@@ -0,0 +1,320 @@
+require 'cgi'
+
+module Phrase
+ class TagsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a tag
+ # Create a new tag.
+ # @param project_id [String] Project ID
+ # @param tag_create [TagCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def tag_create(project_id, tag_create, opts = {})
+ tag_create_with_http_info(project_id, tag_create, opts)
+ nil
+ end
+
+ # Create a tag
+ # Create a new tag.
+ # @param project_id [String] Project ID
+ # @param tag_create [TagCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def tag_create_with_http_info(project_id, tag_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TagsApi.tag_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TagsApi.tag_create"
+ end
+ # verify the required parameter 'tag_create' is set
+ if @api_client.config.client_side_validation && tag_create.nil?
+ fail ArgumentError, "Missing the required parameter 'tag_create' when calling TagsApi.tag_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/tags'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(tag_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TagsApi#tag_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a tag
+ # Delete an existing tag.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param tag_delete [TagDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def tag_delete(project_id, name, tag_delete, opts = {})
+ tag_delete_with_http_info(project_id, name, tag_delete, opts)
+ nil
+ end
+
+ # Delete a tag
+ # Delete an existing tag.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param tag_delete [TagDelete]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def tag_delete_with_http_info(project_id, name, tag_delete, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TagsApi.tag_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TagsApi.tag_delete"
+ end
+ # verify the required parameter 'name' is set
+ if @api_client.config.client_side_validation && name.nil?
+ fail ArgumentError, "Missing the required parameter 'name' when calling TagsApi.tag_delete"
+ end
+ # verify the required parameter 'tag_delete' is set
+ if @api_client.config.client_side_validation && tag_delete.nil?
+ fail ArgumentError, "Missing the required parameter 'tag_delete' when calling TagsApi.tag_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/tags/{name}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(tag_delete)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TagsApi#tag_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single tag
+ # Get details and progress information on a single tag for a given project.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param tag_show [TagShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def tag_show(project_id, name, tag_show, opts = {})
+ data, _status_code, _headers = tag_show_with_http_info(project_id, name, tag_show, opts)
+ data
+ end
+
+ # Get a single tag
+ # Get details and progress information on a single tag for a given project.
+ # @param project_id [String] Project ID
+ # @param name [String] name
+ # @param tag_show [TagShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def tag_show_with_http_info(project_id, name, tag_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TagsApi.tag_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TagsApi.tag_show"
+ end
+ # verify the required parameter 'name' is set
+ if @api_client.config.client_side_validation && name.nil?
+ fail ArgumentError, "Missing the required parameter 'name' when calling TagsApi.tag_show"
+ end
+ # verify the required parameter 'tag_show' is set
+ if @api_client.config.client_side_validation && tag_show.nil?
+ fail ArgumentError, "Missing the required parameter 'tag_show' when calling TagsApi.tag_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/tags/{name}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(tag_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TagsApi#tag_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List tags
+ # List all tags for the given project.
+ # @param project_id [String] Project ID
+ # @param tags_list [TagsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def tags_list(project_id, tags_list, opts = {})
+ data, _status_code, _headers = tags_list_with_http_info(project_id, tags_list, opts)
+ data
+ end
+
+ # List tags
+ # List all tags for the given project.
+ # @param project_id [String] Project ID
+ # @param tags_list [TagsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def tags_list_with_http_info(project_id, tags_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TagsApi.tags_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TagsApi.tags_list"
+ end
+ # verify the required parameter 'tags_list' is set
+ if @api_client.config.client_side_validation && tags_list.nil?
+ fail ArgumentError, "Missing the required parameter 'tags_list' when calling TagsApi.tags_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/tags'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(tags_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TagsApi#tags_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/translations_api.rb b/lib/Phrase/api/translations_api.rb
new file mode 100644
index 0000000..e1f51af
--- /dev/null
+++ b/lib/Phrase/api/translations_api.rb
@@ -0,0 +1,1344 @@
+require 'cgi'
+
+module Phrase
+ class TranslationsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a translation
+ # Create a translation.
+ # @param project_id [String] Project ID
+ # @param translation_create [TranslationCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def translation_create(project_id, translation_create, opts = {})
+ translation_create_with_http_info(project_id, translation_create, opts)
+ nil
+ end
+
+ # Create a translation
+ # Create a translation.
+ # @param project_id [String] Project ID
+ # @param translation_create [TranslationCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def translation_create_with_http_info(project_id, translation_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_create"
+ end
+ # verify the required parameter 'translation_create' is set
+ if @api_client.config.client_side_validation && translation_create.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_create' when calling TranslationsApi.translation_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Exclude a translation from export
+ # Set exclude from export flag on an existing translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_exclude [TranslationExclude]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translation_exclude(project_id, id, translation_exclude, opts = {})
+ data, _status_code, _headers = translation_exclude_with_http_info(project_id, id, translation_exclude, opts)
+ data
+ end
+
+ # Exclude a translation from export
+ # Set exclude from export flag on an existing translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_exclude [TranslationExclude]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translation_exclude_with_http_info(project_id, id, translation_exclude, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_exclude ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_exclude"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_exclude"
+ end
+ # verify the required parameter 'translation_exclude' is set
+ if @api_client.config.client_side_validation && translation_exclude.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_exclude' when calling TranslationsApi.translation_exclude"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{id}/exclude'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_exclude)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_exclude\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Revoke exclusion of a translation in export
+ # Remove exclude from export flag from an existing translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_include [TranslationInclude]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translation_include(project_id, id, translation_include, opts = {})
+ data, _status_code, _headers = translation_include_with_http_info(project_id, id, translation_include, opts)
+ data
+ end
+
+ # Revoke exclusion of a translation in export
+ # Remove exclude from export flag from an existing translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_include [TranslationInclude]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translation_include_with_http_info(project_id, id, translation_include, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_include ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_include"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_include"
+ end
+ # verify the required parameter 'translation_include' is set
+ if @api_client.config.client_side_validation && translation_include.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_include' when calling TranslationsApi.translation_include"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{id}/include'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_include)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_include\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Review a translation
+ # Mark an existing translation as reviewed.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_review [TranslationReview]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translation_review(project_id, id, translation_review, opts = {})
+ data, _status_code, _headers = translation_review_with_http_info(project_id, id, translation_review, opts)
+ data
+ end
+
+ # Review a translation
+ # Mark an existing translation as reviewed.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_review [TranslationReview]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translation_review_with_http_info(project_id, id, translation_review, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_review ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_review"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_review"
+ end
+ # verify the required parameter 'translation_review' is set
+ if @api_client.config.client_side_validation && translation_review.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_review' when calling TranslationsApi.translation_review"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{id}/review'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_review)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single translation
+ # Get details on a single translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_show [TranslationShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translation_show(project_id, id, translation_show, opts = {})
+ data, _status_code, _headers = translation_show_with_http_info(project_id, id, translation_show, opts)
+ data
+ end
+
+ # Get a single translation
+ # Get details on a single translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_show [TranslationShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translation_show_with_http_info(project_id, id, translation_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_show"
+ end
+ # verify the required parameter 'translation_show' is set
+ if @api_client.config.client_side_validation && translation_show.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_show' when calling TranslationsApi.translation_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Mark a translation as unverified
+ # Mark an existing translation as unverified.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_unverify [TranslationUnverify]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translation_unverify(project_id, id, translation_unverify, opts = {})
+ data, _status_code, _headers = translation_unverify_with_http_info(project_id, id, translation_unverify, opts)
+ data
+ end
+
+ # Mark a translation as unverified
+ # Mark an existing translation as unverified.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_unverify [TranslationUnverify]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translation_unverify_with_http_info(project_id, id, translation_unverify, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_unverify ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_unverify"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_unverify"
+ end
+ # verify the required parameter 'translation_unverify' is set
+ if @api_client.config.client_side_validation && translation_unverify.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_unverify' when calling TranslationsApi.translation_unverify"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{id}/unverify'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_unverify)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_unverify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a translation
+ # Update an existing translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_update [TranslationUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translation_update(project_id, id, translation_update, opts = {})
+ data, _status_code, _headers = translation_update_with_http_info(project_id, id, translation_update, opts)
+ data
+ end
+
+ # Update a translation
+ # Update an existing translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_update [TranslationUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translation_update_with_http_info(project_id, id, translation_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_update"
+ end
+ # verify the required parameter 'translation_update' is set
+ if @api_client.config.client_side_validation && translation_update.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_update' when calling TranslationsApi.translation_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Verify a translation
+ # Verify an existing translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_verify [TranslationVerify]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translation_verify(project_id, id, translation_verify, opts = {})
+ data, _status_code, _headers = translation_verify_with_http_info(project_id, id, translation_verify, opts)
+ data
+ end
+
+ # Verify a translation
+ # Verify an existing translation.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param translation_verify [TranslationVerify]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translation_verify_with_http_info(project_id, id, translation_verify, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_verify ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_verify"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_verify"
+ end
+ # verify the required parameter 'translation_verify' is set
+ if @api_client.config.client_side_validation && translation_verify.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_verify' when calling TranslationsApi.translation_verify"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{id}/verify'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_verify)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List translations by key
+ # List translations for a specific key.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param translations_by_key [TranslationsByKey]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def translations_by_key(project_id, key_id, translations_by_key, opts = {})
+ data, _status_code, _headers = translations_by_key_with_http_info(project_id, key_id, translations_by_key, opts)
+ data
+ end
+
+ # List translations by key
+ # List translations for a specific key.
+ # @param project_id [String] Project ID
+ # @param key_id [String] Translation Key ID
+ # @param translations_by_key [TranslationsByKey]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def translations_by_key_with_http_info(project_id, key_id, translations_by_key, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_by_key ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_by_key"
+ end
+ # verify the required parameter 'key_id' is set
+ if @api_client.config.client_side_validation && key_id.nil?
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling TranslationsApi.translations_by_key"
+ end
+ # verify the required parameter 'translations_by_key' is set
+ if @api_client.config.client_side_validation && translations_by_key.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_by_key' when calling TranslationsApi.translations_by_key"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/keys/{key_id}/translations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_by_key)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List translations by locale
+ # List translations for a specific locale. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
+ # @param project_id [String] Project ID
+ # @param locale_id [String] Locale ID
+ # @param translations_by_locale [TranslationsByLocale]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def translations_by_locale(project_id, locale_id, translations_by_locale, opts = {})
+ data, _status_code, _headers = translations_by_locale_with_http_info(project_id, locale_id, translations_by_locale, opts)
+ data
+ end
+
+ # List translations by locale
+ # List translations for a specific locale. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
+ # @param project_id [String] Project ID
+ # @param locale_id [String] Locale ID
+ # @param translations_by_locale [TranslationsByLocale]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def translations_by_locale_with_http_info(project_id, locale_id, translations_by_locale, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_by_locale ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_by_locale"
+ end
+ # verify the required parameter 'locale_id' is set
+ if @api_client.config.client_side_validation && locale_id.nil?
+ fail ArgumentError, "Missing the required parameter 'locale_id' when calling TranslationsApi.translations_by_locale"
+ end
+ # verify the required parameter 'translations_by_locale' is set
+ if @api_client.config.client_side_validation && translations_by_locale.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_by_locale' when calling TranslationsApi.translations_by_locale"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/locales/{locale_id}/translations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'locale_id' + '}', CGI.escape(locale_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_by_locale)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_by_locale\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Set exclude from export flag on translations selected by query
+ # Exclude translations matching query from locale export.
+ # @param project_id [String] Project ID
+ # @param translations_exclude [TranslationsExclude]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translations_exclude(project_id, translations_exclude, opts = {})
+ data, _status_code, _headers = translations_exclude_with_http_info(project_id, translations_exclude, opts)
+ data
+ end
+
+ # Set exclude from export flag on translations selected by query
+ # Exclude translations matching query from locale export.
+ # @param project_id [String] Project ID
+ # @param translations_exclude [TranslationsExclude]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translations_exclude_with_http_info(project_id, translations_exclude, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_exclude ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_exclude"
+ end
+ # verify the required parameter 'translations_exclude' is set
+ if @api_client.config.client_side_validation && translations_exclude.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_exclude' when calling TranslationsApi.translations_exclude"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/exclude'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_exclude)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_exclude\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Remove exlude from import flag from translations selected by query
+ # Include translations matching query in locale export.
+ # @param project_id [String] Project ID
+ # @param translations_include [TranslationsInclude]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translations_include(project_id, translations_include, opts = {})
+ data, _status_code, _headers = translations_include_with_http_info(project_id, translations_include, opts)
+ data
+ end
+
+ # Remove exlude from import flag from translations selected by query
+ # Include translations matching query in locale export.
+ # @param project_id [String] Project ID
+ # @param translations_include [TranslationsInclude]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translations_include_with_http_info(project_id, translations_include, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_include ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_include"
+ end
+ # verify the required parameter 'translations_include' is set
+ if @api_client.config.client_side_validation && translations_include.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_include' when calling TranslationsApi.translations_include"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/include'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_include)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_include\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List all translations
+ # List translations for the given project. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
+ # @param project_id [String] Project ID
+ # @param translations_list [TranslationsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def translations_list(project_id, translations_list, opts = {})
+ data, _status_code, _headers = translations_list_with_http_info(project_id, translations_list, opts)
+ data
+ end
+
+ # List all translations
+ # List translations for the given project. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
+ # @param project_id [String] Project ID
+ # @param translations_list [TranslationsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def translations_list_with_http_info(project_id, translations_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_list"
+ end
+ # verify the required parameter 'translations_list' is set
+ if @api_client.config.client_side_validation && translations_list.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_list' when calling TranslationsApi.translations_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Review translations selected by query
+ # Review translations matching query.
+ # @param project_id [String] Project ID
+ # @param translations_review [TranslationsReview]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translations_review(project_id, translations_review, opts = {})
+ data, _status_code, _headers = translations_review_with_http_info(project_id, translations_review, opts)
+ data
+ end
+
+ # Review translations selected by query
+ # Review translations matching query.
+ # @param project_id [String] Project ID
+ # @param translations_review [TranslationsReview]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translations_review_with_http_info(project_id, translations_review, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_review ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_review"
+ end
+ # verify the required parameter 'translations_review' is set
+ if @api_client.config.client_side_validation && translations_review.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_review' when calling TranslationsApi.translations_review"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/review'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_review)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Search translations
+ # Search translations for the given project. Provides the same search interface as translations#index but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the locales#download endpoint.
+ # @param project_id [String] Project ID
+ # @param translations_search [TranslationsSearch]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def translations_search(project_id, translations_search, opts = {})
+ data, _status_code, _headers = translations_search_with_http_info(project_id, translations_search, opts)
+ data
+ end
+
+ # Search translations
+ # Search translations for the given project. Provides the same search interface as <code>translations#index</code> but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
+ # @param project_id [String] Project ID
+ # @param translations_search [TranslationsSearch]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def translations_search_with_http_info(project_id, translations_search, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_search ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_search"
+ end
+ # verify the required parameter 'translations_search' is set
+ if @api_client.config.client_side_validation && translations_search.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_search' when calling TranslationsApi.translations_search"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/search'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_search)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Mark translations selected by query as unverified
+ # Mark translations matching query as unverified.
+ # @param project_id [String] Project ID
+ # @param translations_unverify [TranslationsUnverify]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def translations_unverify(project_id, translations_unverify, opts = {})
+ data, _status_code, _headers = translations_unverify_with_http_info(project_id, translations_unverify, opts)
+ data
+ end
+
+ # Mark translations selected by query as unverified
+ # Mark translations matching query as unverified.
+ # @param project_id [String] Project ID
+ # @param translations_unverify [TranslationsUnverify]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def translations_unverify_with_http_info(project_id, translations_unverify, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_unverify ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_unverify"
+ end
+ # verify the required parameter 'translations_unverify' is set
+ if @api_client.config.client_side_validation && translations_unverify.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_unverify' when calling TranslationsApi.translations_unverify"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/unverify'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_unverify)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_unverify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Verify translations selected by query
+ # Verify translations matching query.
+ # @param project_id [String] Project ID
+ # @param translations_verify [TranslationsVerify]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [AffectedCount]
+ def translations_verify(project_id, translations_verify, opts = {})
+ data, _status_code, _headers = translations_verify_with_http_info(project_id, translations_verify, opts)
+ data
+ end
+
+ # Verify translations selected by query
+ # Verify translations matching query.
+ # @param project_id [String] Project ID
+ # @param translations_verify [TranslationsVerify]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(AffectedCount)>, Integer, Hash)>] Response<(AffectedCount)> data, response status code and response headers
+ def translations_verify_with_http_info(project_id, translations_verify, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_verify ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_verify"
+ end
+ # verify the required parameter 'translations_verify' is set
+ if @api_client.config.client_side_validation && translations_verify.nil?
+ fail ArgumentError, "Missing the required parameter 'translations_verify' when calling TranslationsApi.translations_verify"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/verify'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_verify)
+
+ # return_type
+ return_type = opts[:return_type] || 'AffectedCount'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/uploads_api.rb b/lib/Phrase/api/uploads_api.rb
new file mode 100644
index 0000000..f13de9d
--- /dev/null
+++ b/lib/Phrase/api/uploads_api.rb
@@ -0,0 +1,242 @@
+require 'cgi'
+
+module Phrase
+ class UploadsApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Upload a new file
+ # Upload a new language file. Creates necessary resources in your project.
+ # @param project_id [String] Project ID
+ # @param upload_create [UploadCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def upload_create(project_id, upload_create, opts = {})
+ upload_create_with_http_info(project_id, upload_create, opts)
+ nil
+ end
+
+ # Upload a new file
+ # Upload a new language file. Creates necessary resources in your project.
+ # @param project_id [String] Project ID
+ # @param upload_create [UploadCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def upload_create_with_http_info(project_id, upload_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: UploadsApi.upload_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling UploadsApi.upload_create"
+ end
+ # verify the required parameter 'upload_create' is set
+ if @api_client.config.client_side_validation && upload_create.nil?
+ fail ArgumentError, "Missing the required parameter 'upload_create' when calling UploadsApi.upload_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/uploads'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(upload_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: UploadsApi#upload_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # View upload details
+ # View details and summary for a single upload.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param upload_show [UploadShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Upload]
+ def upload_show(project_id, id, upload_show, opts = {})
+ data, _status_code, _headers = upload_show_with_http_info(project_id, id, upload_show, opts)
+ data
+ end
+
+ # View upload details
+ # View details and summary for a single upload.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param upload_show [UploadShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Upload)>, Integer, Hash)>] Response<(Upload)> data, response status code and response headers
+ def upload_show_with_http_info(project_id, id, upload_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: UploadsApi.upload_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling UploadsApi.upload_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling UploadsApi.upload_show"
+ end
+ # verify the required parameter 'upload_show' is set
+ if @api_client.config.client_side_validation && upload_show.nil?
+ fail ArgumentError, "Missing the required parameter 'upload_show' when calling UploadsApi.upload_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/uploads/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(upload_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'Upload'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: UploadsApi#upload_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List uploads
+ # List all uploads for the given project.
+ # @param project_id [String] Project ID
+ # @param uploads_list [UploadsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def uploads_list(project_id, uploads_list, opts = {})
+ data, _status_code, _headers = uploads_list_with_http_info(project_id, uploads_list, opts)
+ data
+ end
+
+ # List uploads
+ # List all uploads for the given project.
+ # @param project_id [String] Project ID
+ # @param uploads_list [UploadsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def uploads_list_with_http_info(project_id, uploads_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: UploadsApi.uploads_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling UploadsApi.uploads_list"
+ end
+ # verify the required parameter 'uploads_list' is set
+ if @api_client.config.client_side_validation && uploads_list.nil?
+ fail ArgumentError, "Missing the required parameter 'uploads_list' when calling UploadsApi.uploads_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/uploads'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(uploads_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: UploadsApi#uploads_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/users_api.rb b/lib/Phrase/api/users_api.rb
new file mode 100644
index 0000000..a24a504
--- /dev/null
+++ b/lib/Phrase/api/users_api.rb
@@ -0,0 +1,70 @@
+require 'cgi'
+
+module Phrase
+ class UsersApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Show current User
+ # Show details for current User.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [User]
+ def show_user(opts = {})
+ data, _status_code, _headers = show_user_with_http_info(opts)
+ data
+ end
+
+ # Show current User
+ # Show details for current User.
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(User)>, Integer, Hash)>] Response<(User)> data, response status code and response headers
+ def show_user_with_http_info(opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: UsersApi.show_user ...'
+ end
+ # resource path
+ local_var_path = '/user'
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'User'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: UsersApi#show_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/versions_history_api.rb b/lib/Phrase/api/versions_history_api.rb
new file mode 100644
index 0000000..844897b
--- /dev/null
+++ b/lib/Phrase/api/versions_history_api.rb
@@ -0,0 +1,182 @@
+require 'cgi'
+
+module Phrase
+ class VersionsHistoryApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Get a single version
+ # Get details on a single version.
+ # @param project_id [String] Project ID
+ # @param translation_id [String] Translation ID
+ # @param id [String] ID
+ # @param version_show [VersionShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def version_show(project_id, translation_id, id, version_show, opts = {})
+ data, _status_code, _headers = version_show_with_http_info(project_id, translation_id, id, version_show, opts)
+ data
+ end
+
+ # Get a single version
+ # Get details on a single version.
+ # @param project_id [String] Project ID
+ # @param translation_id [String] Translation ID
+ # @param id [String] ID
+ # @param version_show [VersionShow]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def version_show_with_http_info(project_id, translation_id, id, version_show, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: VersionsHistoryApi.version_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling VersionsHistoryApi.version_show"
+ end
+ # verify the required parameter 'translation_id' is set
+ if @api_client.config.client_side_validation && translation_id.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_id' when calling VersionsHistoryApi.version_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling VersionsHistoryApi.version_show"
+ end
+ # verify the required parameter 'version_show' is set
+ if @api_client.config.client_side_validation && version_show.nil?
+ fail ArgumentError, "Missing the required parameter 'version_show' when calling VersionsHistoryApi.version_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{translation_id}/versions/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'translation_id' + '}', CGI.escape(translation_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(version_show)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: VersionsHistoryApi#version_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List all versions
+ # List all versions for the given translation.
+ # @param project_id [String] Project ID
+ # @param translation_id [String] Translation ID
+ # @param versions_list [VersionsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def versions_list(project_id, translation_id, versions_list, opts = {})
+ data, _status_code, _headers = versions_list_with_http_info(project_id, translation_id, versions_list, opts)
+ data
+ end
+
+ # List all versions
+ # List all versions for the given translation.
+ # @param project_id [String] Project ID
+ # @param translation_id [String] Translation ID
+ # @param versions_list [VersionsList]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def versions_list_with_http_info(project_id, translation_id, versions_list, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: VersionsHistoryApi.versions_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling VersionsHistoryApi.versions_list"
+ end
+ # verify the required parameter 'translation_id' is set
+ if @api_client.config.client_side_validation && translation_id.nil?
+ fail ArgumentError, "Missing the required parameter 'translation_id' when calling VersionsHistoryApi.versions_list"
+ end
+ # verify the required parameter 'versions_list' is set
+ if @api_client.config.client_side_validation && versions_list.nil?
+ fail ArgumentError, "Missing the required parameter 'versions_list' when calling VersionsHistoryApi.versions_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/translations/{translation_id}/versions'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'translation_id' + '}', CGI.escape(translation_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(versions_list)
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: VersionsHistoryApi#versions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api/webhooks_api.rb b/lib/Phrase/api/webhooks_api.rb
new file mode 100644
index 0000000..f350e67
--- /dev/null
+++ b/lib/Phrase/api/webhooks_api.rb
@@ -0,0 +1,446 @@
+require 'cgi'
+
+module Phrase
+ class WebhooksApi
+ attr_accessor :api_client
+
+ def initialize(api_client = ApiClient.default)
+ @api_client = api_client
+ end
+ # Create a webhook
+ # Create a new webhook.
+ # @param project_id [String] Project ID
+ # @param webhook_create [WebhookCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def webhook_create(project_id, webhook_create, opts = {})
+ webhook_create_with_http_info(project_id, webhook_create, opts)
+ nil
+ end
+
+ # Create a webhook
+ # Create a new webhook.
+ # @param project_id [String] Project ID
+ # @param webhook_create [WebhookCreate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def webhook_create_with_http_info(project_id, webhook_create, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_create ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_create"
+ end
+ # verify the required parameter 'webhook_create' is set
+ if @api_client.config.client_side_validation && webhook_create.nil?
+ fail ArgumentError, "Missing the required parameter 'webhook_create' when calling WebhooksApi.webhook_create"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/webhooks'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(webhook_create)
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: WebhooksApi#webhook_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Delete a webhook
+ # Delete an existing webhook.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def webhook_delete(project_id, id, opts = {})
+ webhook_delete_with_http_info(project_id, id, opts)
+ nil
+ end
+
+ # Delete a webhook
+ # Delete an existing webhook.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def webhook_delete_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_delete ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_delete"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_delete"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: WebhooksApi#webhook_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Get a single webhook
+ # Get details on a single webhook.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Webhook]
+ def webhook_show(project_id, id, opts = {})
+ data, _status_code, _headers = webhook_show_with_http_info(project_id, id, opts)
+ data
+ end
+
+ # Get a single webhook
+ # Get details on a single webhook.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Webhook)>, Integer, Hash)>] Response<(Webhook)> data, response status code and response headers
+ def webhook_show_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_show ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_show"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_show"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Webhook'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: WebhooksApi#webhook_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Test a webhook
+ # Perform a test request for a webhook.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [nil]
+ def webhook_test(project_id, id, opts = {})
+ webhook_test_with_http_info(project_id, id, opts)
+ nil
+ end
+
+ # Test a webhook
+ # Perform a test request for a webhook.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
+ def webhook_test_with_http_info(project_id, id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_test ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_test"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_test"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/webhooks/{id}/test'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type]
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: WebhooksApi#webhook_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # Update a webhook
+ # Update an existing webhook.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param webhook_update [WebhookUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Object]
+ def webhook_update(project_id, id, webhook_update, opts = {})
+ data, _status_code, _headers = webhook_update_with_http_info(project_id, id, webhook_update, opts)
+ data
+ end
+
+ # Update a webhook
+ # Update an existing webhook.
+ # @param project_id [String] Project ID
+ # @param id [String] ID
+ # @param webhook_update [WebhookUpdate]
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @return [Array<(Response<(Object)>, Integer, Hash)>] Response<(Object)> data, response status code and response headers
+ def webhook_update_with_http_info(project_id, id, webhook_update, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_update ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_update"
+ end
+ # verify the required parameter 'id' is set
+ if @api_client.config.client_side_validation && id.nil?
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_update"
+ end
+ # verify the required parameter 'webhook_update' is set
+ if @api_client.config.client_side_validation && webhook_update.nil?
+ fail ArgumentError, "Missing the required parameter 'webhook_update' when calling WebhooksApi.webhook_update"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ # HTTP header 'Content-Type'
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body] || @api_client.object_to_http_body(webhook_update)
+
+ # return_type
+ return_type = opts[:return_type] || 'Object'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: WebhooksApi#webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+
+ # List webhooks
+ # List all webhooks for the given project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array]
+ def webhooks_list(project_id, opts = {})
+ data, _status_code, _headers = webhooks_list_with_http_info(project_id, opts)
+ data
+ end
+
+ # List webhooks
+ # List all webhooks for the given project.
+ # @param project_id [String] Project ID
+ # @param [Hash] opts the optional parameters
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
+ # @option opts [Integer] :page Page number
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
+ # @return [Array<(Response<(Array)>, Integer, Hash)>] Response<(Array)> data, response status code and response headers
+ def webhooks_list_with_http_info(project_id, opts = {})
+ if @api_client.config.debugging
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_list ...'
+ end
+ # verify the required parameter 'project_id' is set
+ if @api_client.config.client_side_validation && project_id.nil?
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhooks_list"
+ end
+ # resource path
+ local_var_path = '/projects/{project_id}/webhooks'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
+
+ # query parameters
+ query_params = opts[:query_params] || {}
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+ # header parameters
+ header_params = opts[:header_params] || {}
+ # HTTP header 'Accept' (if needed)
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
+
+ # form parameters
+ form_params = opts[:form_params] || {}
+
+ # http body (model)
+ post_body = opts[:body]
+
+ # return_type
+ return_type = opts[:return_type] || 'Array'
+
+ # auth_names
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
+
+ new_options = opts.merge(
+ :header_params => header_params,
+ :query_params => query_params,
+ :form_params => form_params,
+ :body => post_body,
+ :auth_names => auth_names,
+ :return_type => return_type
+ )
+
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+ if @api_client.config.debugging
+ @api_client.config.logger.debug "API called: WebhooksApi#webhooks_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+ end
+ response = ::Phrase::Response.new(data, headers)
+ return response, status_code, headers
+ end
+ end
+end
diff --git a/lib/Phrase/api_client.rb b/lib/Phrase/api_client.rb
new file mode 100644
index 0000000..85b57c8
--- /dev/null
+++ b/lib/Phrase/api_client.rb
@@ -0,0 +1,376 @@
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'typhoeus'
+
+module Phrase
+ class ApiClient
+ # The Configuration object holding settings to be used in the API client.
+ attr_accessor :config
+
+ # Defines the headers to be used in HTTP requests of all API calls by default.
+ #
+ # @return [Hash]
+ attr_accessor :default_headers
+
+ # Initializes the ApiClient
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
+ def initialize(config = Configuration.default)
+ @config = config
+ @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
+ @default_headers = {
+ 'Content-Type' => 'application/json',
+ 'User-Agent' => @user_agent
+ }
+ end
+
+ def self.default
+ @@default ||= ApiClient.new
+ end
+
+ # Call an API with given options.
+ #
+ # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
+ # the data deserialized from response body (could be nil), response status code and response headers.
+ def call_api(http_method, path, opts = {})
+ request = build_request(http_method, path, opts)
+ response = request.run
+
+ if @config.debugging
+ @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+ end
+
+ unless response.success?
+ if response.timed_out?
+ fail ApiError.new('Connection timed out')
+ elsif response.code == 0
+ # Errors from libcurl will be made visible here
+ fail ApiError.new(:code => 0,
+ :message => response.return_message)
+ else
+ fail ApiError.new(:code => response.code,
+ :response_headers => response.headers,
+ :response_body => response.body),
+ response.status_message
+ end
+ end
+
+ if opts[:return_type]
+ data = deserialize(response, opts[:return_type])
+ else
+ data = nil
+ end
+ return data, response.code, response.headers
+ end
+
+ # Builds the HTTP request
+ #
+ # @param [String] http_method HTTP method/verb (e.g. POST)
+ # @param [String] path URL path (e.g. /account/new)
+ # @option opts [Hash] :header_params Header parameters
+ # @option opts [Hash] :query_params Query parameters
+ # @option opts [Hash] :form_params Query parameters
+ # @option opts [Object] :body HTTP body (JSON/XML)
+ # @return [Typhoeus::Request] A Typhoeus Request
+ def build_request(http_method, path, opts = {})
+ url = build_request_url(path)
+ http_method = http_method.to_sym.downcase
+
+ header_params = @default_headers.merge(opts[:header_params] || {})
+ query_params = opts[:query_params] || {}
+ form_params = opts[:form_params] || {}
+
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
+
+ # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
+ _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
+
+ req_opts = {
+ :method => http_method,
+ :headers => header_params,
+ :params => query_params,
+ :params_encoding => @config.params_encoding,
+ :timeout => @config.timeout,
+ :ssl_verifypeer => @config.verify_ssl,
+ :ssl_verifyhost => _verify_ssl_host,
+ :sslcert => @config.cert_file,
+ :sslkey => @config.key_file,
+ :verbose => @config.debugging
+ }
+
+ # set custom cert, if provided
+ req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+
+ if [:post, :patch, :put, :delete].include?(http_method)
+ req_body = build_request_body(header_params, form_params, opts[:body])
+ req_opts.update :body => req_body
+ if @config.debugging
+ @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+ end
+ end
+
+ request = Typhoeus::Request.new(url, req_opts)
+ download_file(request) if opts[:return_type] == 'File'
+ request
+ end
+
+ # Builds the HTTP request body
+ #
+ # @param [Hash] header_params Header parameters
+ # @param [Hash] form_params Query parameters
+ # @param [Object] body HTTP body (JSON/XML)
+ # @return [String] HTTP body data in the form of string
+ def build_request_body(header_params, form_params, body)
+ # http form
+ if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+ header_params['Content-Type'] == 'multipart/form-data'
+ data = {}
+ form_params.each do |key, value|
+ case value
+ when ::File, ::Array, nil
+ # let typhoeus handle File, Array and nil parameters
+ data[key] = value
+ else
+ data[key] = value.to_s
+ end
+ end
+ elsif body
+ data = body.is_a?(String) ? body : body.to_json
+ else
+ data = nil
+ end
+ data
+ end
+
+ # Check if the given MIME is a JSON MIME.
+ # JSON MIME examples:
+ # application/json
+ # application/json; charset=UTF8
+ # APPLICATION/JSON
+ # */*
+ # @param [String] mime MIME
+ # @return [Boolean] True if the MIME is application/json
+ def json_mime?(mime)
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+ end
+
+ # Deserialize the response to the given return type.
+ #
+ # @param [Response] response HTTP response
+ # @param [String] return_type some examples: "User", "Array", "Hash"
+ def deserialize(response, return_type)
+ body = response.body
+
+ # handle file downloading - return the File instance processed in request callbacks
+ # note that response body is empty when the file is written in chunks in request on_body callback
+ return @tempfile if return_type == 'File'
+
+ return nil if body.nil? || body.empty?
+
+ # return response body directly for String return type
+ return body if return_type == 'String'
+
+ # ensuring a default content type
+ content_type = response.headers['Content-Type'] || 'application/json'
+
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
+
+ begin
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+ rescue JSON::ParserError => e
+ if %w(String Date DateTime).include?(return_type)
+ data = body
+ else
+ raise e
+ end
+ end
+
+ convert_to_type data, return_type
+ end
+
+ # Convert data to the given return type.
+ # @param [Object] data Data to be converted
+ # @param [String] return_type Return type
+ # @return [Mixed] Data in a particular type
+ def convert_to_type(data, return_type)
+ return nil if data.nil?
+ case return_type
+ when 'String'
+ data.to_s
+ when 'Integer'
+ data.to_i
+ when 'Float'
+ data.to_f
+ when 'Boolean'
+ data == true
+ when 'DateTime'
+ # parse date time (expecting ISO 8601 format)
+ DateTime.parse data
+ when 'Date'
+ # parse date time (expecting ISO 8601 format)
+ Date.parse data
+ when 'Object'
+ # generic object (usually a Hash), return directly
+ data
+ when /\AArray<(.+)>\z/
+ # e.g. Array
+ sub_type = $1
+ data.map { |item| convert_to_type(item, sub_type) }
+ when /\AHash\\z/
+ # e.g. Hash
+ sub_type = $1
+ {}.tap do |hash|
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
+ end
+ else
+ # models, e.g. Pet
+ Phrase.const_get(return_type).build_from_hash(data)
+ end
+ end
+
+ # Save response body into a file in (the defined) temporary folder, using the filename
+ # from the "Content-Disposition" header if provided, otherwise a random filename.
+ # The response body is written to the file in chunks in order to handle files which
+ # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+ # process can use.
+ #
+ # @see Configuration#temp_folder_path
+ def download_file(request)
+ tempfile = nil
+ encoding = nil
+ request.on_headers do |response|
+ content_disposition = response.headers['Content-Disposition']
+ if content_disposition && content_disposition =~ /filename=/i
+ filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+ prefix = sanitize_filename(filename)
+ else
+ prefix = 'download-'
+ end
+ prefix = prefix + '-' unless prefix.end_with?('-')
+ encoding = response.body.encoding
+ tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+ @tempfile = tempfile
+ end
+ request.on_body do |chunk|
+ chunk.force_encoding(encoding)
+ tempfile.write(chunk)
+ end
+ request.on_complete do |response|
+ if tempfile
+ tempfile.close
+ @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+ "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+ "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+ "explicitly with `tempfile.delete`"
+ end
+ end
+ end
+
+ # Sanitize filename by removing path.
+ # e.g. ../../sun.gif becomes sun.gif
+ #
+ # @param [String] filename the filename to be sanitized
+ # @return [String] the sanitized filename
+ def sanitize_filename(filename)
+ filename.gsub(/.*[\/\\]/, '')
+ end
+
+ def build_request_url(path)
+ # Add leading and trailing slashes to path
+ path = "/#{path}".gsub(/\/+/, '/')
+ @config.base_url + path
+ end
+
+ # Update hearder and query params based on authentication settings.
+ #
+ # @param [Hash] header_params Header parameters
+ # @param [Hash] query_params Query parameters
+ # @param [String] auth_names Authentication scheme name
+ def update_params_for_auth!(header_params, query_params, auth_names)
+ Array(auth_names).each do |auth_name|
+ auth_setting = @config.auth_settings[auth_name]
+ next unless auth_setting
+ case auth_setting[:in]
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+ end
+ end
+ end
+
+ # Sets user agent in HTTP header
+ #
+ # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
+ def user_agent=(user_agent)
+ @user_agent = user_agent
+ @default_headers['User-Agent'] = @user_agent
+ end
+
+ # Return Accept header based on an array of accepts provided.
+ # @param [Array] accepts array for Accept
+ # @return [String] the Accept header (e.g. application/json)
+ def select_header_accept(accepts)
+ return nil if accepts.nil? || accepts.empty?
+ # use JSON when present, otherwise use all of the provided
+ json_accept = accepts.find { |s| json_mime?(s) }
+ json_accept || accepts.join(',')
+ end
+
+ # Return Content-Type header based on an array of content types provided.
+ # @param [Array] content_types array for Content-Type
+ # @return [String] the Content-Type header (e.g. application/json)
+ def select_header_content_type(content_types)
+ # use application/json by default
+ return 'application/json' if content_types.nil? || content_types.empty?
+ # use JSON when present, otherwise use the first one
+ json_content_type = content_types.find { |s| json_mime?(s) }
+ json_content_type || content_types.first
+ end
+
+ # Convert object (array, hash, object, etc) to JSON string.
+ # @param [Object] model object to be converted into JSON string
+ # @return [String] JSON string representation of the object
+ def object_to_http_body(model)
+ return model if model.nil? || model.is_a?(String)
+ local_body = nil
+ if model.is_a?(Array)
+ local_body = model.map { |m| object_to_hash(m) }
+ else
+ local_body = object_to_hash(model)
+ end
+ local_body.to_json
+ end
+
+ # Convert object(non-array) to hash.
+ # @param [Object] obj object to be converted into JSON string
+ # @return [String] JSON string representation of the object
+ def object_to_hash(obj)
+ if obj.respond_to?(:to_hash)
+ obj.to_hash
+ else
+ obj
+ end
+ end
+
+ # Build parameter value according to the given collection format.
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+ def build_collection_param(param, collection_format)
+ case collection_format
+ when :csv
+ param.join(',')
+ when :ssv
+ param.join(' ')
+ when :tsv
+ param.join("\t")
+ when :pipes
+ param.join('|')
+ when :multi
+ # return the array directly as typhoeus will handle it as expected
+ param
+ else
+ fail "unknown collection format: #{collection_format.inspect}"
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/api_error.rb b/lib/Phrase/api_error.rb
new file mode 100644
index 0000000..f5e2cfc
--- /dev/null
+++ b/lib/Phrase/api_error.rb
@@ -0,0 +1,45 @@
+module Phrase
+ class ApiError < StandardError
+ attr_reader :code, :response_headers, :response_body
+
+ # Usage examples:
+ # ApiError.new
+ # ApiError.new("message")
+ # ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+ # ApiError.new(:code => 404, :message => "Not Found")
+ def initialize(arg = nil)
+ if arg.is_a? Hash
+ if arg.key?(:message) || arg.key?('message')
+ super(arg[:message] || arg['message'])
+ else
+ super arg
+ end
+
+ arg.each do |k, v|
+ instance_variable_set "@#{k}", v
+ end
+ else
+ super arg
+ end
+ end
+
+ # Override to_s to display a friendly error message
+ def to_s
+ message
+ end
+
+ def message
+ if @message.nil?
+ msg = "Error message: the server returns an error"
+ else
+ msg = @message
+ end
+
+ msg += "\nHTTP status code: #{code}" if code
+ msg += "\nResponse headers: #{response_headers}" if response_headers
+ msg += "\nResponse body: #{response_body}" if response_body
+
+ msg
+ end
+ end
+end
diff --git a/lib/Phrase/configuration.rb b/lib/Phrase/configuration.rb
new file mode 100644
index 0000000..9d5d69f
--- /dev/null
+++ b/lib/Phrase/configuration.rb
@@ -0,0 +1,243 @@
+module Phrase
+ class Configuration
+ # Defines url scheme
+ attr_accessor :scheme
+
+ # Defines url host
+ attr_accessor :host
+
+ # Defines url base path
+ attr_accessor :base_path
+
+ # Defines API keys used with API Key authentications.
+ #
+ # @return [Hash] key: parameter name, value: parameter value (API key)
+ #
+ # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+ # config.api_key['api_key'] = 'xxx'
+ attr_accessor :api_key
+
+ # Defines API key prefixes used with API Key authentications.
+ #
+ # @return [Hash] key: parameter name, value: API key prefix
+ #
+ # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+ # config.api_key_prefix['api_key'] = 'Token'
+ attr_accessor :api_key_prefix
+
+ # Defines the username used with HTTP basic authentication.
+ #
+ # @return [String]
+ attr_accessor :username
+
+ # Defines the password used with HTTP basic authentication.
+ #
+ # @return [String]
+ attr_accessor :password
+
+ # Defines the access token (Bearer) used with OAuth2.
+ attr_accessor :access_token
+
+ # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+ # details will be logged with `logger.debug` (see the `logger` attribute).
+ # Default to false.
+ #
+ # @return [true, false]
+ attr_accessor :debugging
+
+ # Defines the logger used for debugging.
+ # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+ #
+ # @return [#debug]
+ attr_accessor :logger
+
+ # Defines the temporary folder to store downloaded files
+ # (for API endpoints that have file response).
+ # Default to use `Tempfile`.
+ #
+ # @return [String]
+ attr_accessor :temp_folder_path
+
+ # The time limit for HTTP request in seconds.
+ # Default to 0 (never times out).
+ attr_accessor :timeout
+
+ # Set this to false to skip client side validation in the operation.
+ # Default to true.
+ # @return [true, false]
+ attr_accessor :client_side_validation
+
+ ### TLS/SSL setting
+ # Set this to false to skip verifying SSL certificate when calling API from https server.
+ # Default to true.
+ #
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+ #
+ # @return [true, false]
+ attr_accessor :verify_ssl
+
+ ### TLS/SSL setting
+ # Set this to false to skip verifying SSL host name
+ # Default to true.
+ #
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+ #
+ # @return [true, false]
+ attr_accessor :verify_ssl_host
+
+ ### TLS/SSL setting
+ # Set this to customize the certificate file to verify the peer.
+ #
+ # @return [String] the path to the certificate file
+ #
+ # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+ # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+ attr_accessor :ssl_ca_cert
+
+ ### TLS/SSL setting
+ # Client certificate file (for client certificate)
+ attr_accessor :cert_file
+
+ ### TLS/SSL setting
+ # Client private key file (for client certificate)
+ attr_accessor :key_file
+
+ # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+ # Default to nil.
+ #
+ # @see The params_encoding option of Ethon. Related source code:
+ # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+ attr_accessor :params_encoding
+
+ attr_accessor :inject_format
+
+ attr_accessor :force_ending_format
+
+ def initialize
+ @scheme = 'https'
+ @host = 'api.phrase.com'
+ @base_path = '/v2'
+ @api_key = {}
+ @api_key_prefix = {}
+ @timeout = 0
+ @client_side_validation = true
+ @verify_ssl = true
+ @verify_ssl_host = true
+ @params_encoding = nil
+ @cert_file = nil
+ @key_file = nil
+ @debugging = false
+ @inject_format = false
+ @force_ending_format = false
+ @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+ yield(self) if block_given?
+ end
+
+ # The default Configuration object.
+ def self.default
+ @@default ||= Configuration.new
+ end
+
+ def configure
+ yield(self) if block_given?
+ end
+
+ def scheme=(scheme)
+ # remove :// from scheme
+ @scheme = scheme.sub(/:\/\//, '')
+ end
+
+ def host=(host)
+ # remove http(s):// and anything after a slash
+ @host = host.sub(/https?:\/\//, '').split('/').first
+ end
+
+ def base_path=(base_path)
+ # Add leading and trailing slashes to base_path
+ @base_path = "/#{base_path}".gsub(/\/+/, '/')
+ @base_path = '' if @base_path == '/'
+ end
+
+ def base_url
+ "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+ end
+
+ # Gets API key (with prefix if set).
+ # @param [String] param_name the parameter name of API key auth
+ def api_key_with_prefix(param_name)
+ if @api_key_prefix[param_name]
+ "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+ else
+ @api_key[param_name]
+ end
+ end
+
+ # Gets Basic Auth token string
+ def basic_auth_token
+ 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+ end
+
+ # Returns Auth Settings hash for api client.
+ def auth_settings
+ {
+ 'Basic' =>
+ {
+ type: 'basic',
+ in: 'header',
+ key: 'Authorization',
+ value: basic_auth_token
+ },
+ 'Token' =>
+ {
+ type: 'api_key',
+ in: 'header',
+ key: 'Authorization',
+ value: api_key_with_prefix('Authorization')
+ },
+ }
+ end
+
+ # Returns an array of Server setting
+ def server_settings
+ [
+ {
+ url: "https://api.phrase.com/v2",
+ description: "No description provided",
+ }
+ ]
+ end
+
+ # Returns URL based on server settings
+ #
+ # @param index array index of the server settings
+ # @param variables hash of variable and the corresponding value
+ def server_url(index, variables = {})
+ servers = server_settings
+
+ # check array index out of bound
+ if (index < 0 || index >= servers.size)
+ fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+ end
+
+ server = servers[index]
+ url = server[:url]
+
+ # go through variable and assign a value
+ server[:variables].each do |name, variable|
+ if variables.key?(name)
+ if (server[:variables][name][:enum_values].include? variables[name])
+ url.gsub! "{" + name.to_s + "}", variables[name]
+ else
+ fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+ end
+ else
+ # use default value
+ url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+ end
+ end
+
+ url
+ end
+ end
+end
diff --git a/lib/Phrase/models/account.rb b/lib/Phrase/models/account.rb
new file mode 100644
index 0000000..c55393c
--- /dev/null
+++ b/lib/Phrase/models/account.rb
@@ -0,0 +1,230 @@
+require 'date'
+
+module Phrase
+ class Account
+ attr_accessor :id
+
+ attr_accessor :name
+
+ attr_accessor :company
+
+ attr_accessor :created_at
+
+ attr_accessor :updated_at
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'id' => :'id',
+ :'name' => :'name',
+ :'company' => :'company',
+ :'created_at' => :'created_at',
+ :'updated_at' => :'updated_at'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'id' => :'String',
+ :'name' => :'String',
+ :'company' => :'String',
+ :'created_at' => :'DateTime',
+ :'updated_at' => :'DateTime'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::Account` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'id')
+ self.id = attributes[:'id']
+ end
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+
+ if attributes.key?(:'company')
+ self.company = attributes[:'company']
+ end
+
+ if attributes.key?(:'created_at')
+ self.created_at = attributes[:'created_at']
+ end
+
+ if attributes.key?(:'updated_at')
+ self.updated_at = attributes[:'updated_at']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ id == o.id &&
+ name == o.name &&
+ company == o.company &&
+ created_at == o.created_at &&
+ updated_at == o.updated_at
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [id, name, company, created_at, updated_at].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/affected_count.rb b/lib/Phrase/models/affected_count.rb
new file mode 100644
index 0000000..b63a5bb
--- /dev/null
+++ b/lib/Phrase/models/affected_count.rb
@@ -0,0 +1,194 @@
+require 'date'
+
+module Phrase
+ class AffectedCount
+ attr_accessor :records_affected
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'records_affected' => :'records_affected'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'records_affected' => :'Integer'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::AffectedCount` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::AffectedCount`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'records_affected')
+ self.records_affected = attributes[:'records_affected']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ records_affected == o.records_affected
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [records_affected].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/affected_resources.rb b/lib/Phrase/models/affected_resources.rb
new file mode 100644
index 0000000..1a43fb3
--- /dev/null
+++ b/lib/Phrase/models/affected_resources.rb
@@ -0,0 +1,194 @@
+require 'date'
+
+module Phrase
+ class AffectedResources
+ attr_accessor :records_affected
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'records_affected' => :'records_affected'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'records_affected' => :'Integer'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::AffectedResources` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::AffectedResources`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'records_affected')
+ self.records_affected = attributes[:'records_affected']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ records_affected == o.records_affected
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [records_affected].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/authorization.rb b/lib/Phrase/models/authorization.rb
new file mode 100644
index 0000000..34fda68
--- /dev/null
+++ b/lib/Phrase/models/authorization.rb
@@ -0,0 +1,259 @@
+require 'date'
+
+module Phrase
+ class Authorization
+ attr_accessor :id
+
+ attr_accessor :note
+
+ attr_accessor :token_last_eight
+
+ attr_accessor :hashed_token
+
+ attr_accessor :scopes
+
+ attr_accessor :expires_at
+
+ attr_accessor :created_at
+
+ attr_accessor :updated_at
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'id' => :'id',
+ :'note' => :'note',
+ :'token_last_eight' => :'token_last_eight',
+ :'hashed_token' => :'hashed_token',
+ :'scopes' => :'scopes',
+ :'expires_at' => :'expires_at',
+ :'created_at' => :'created_at',
+ :'updated_at' => :'updated_at'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'id' => :'String',
+ :'note' => :'String',
+ :'token_last_eight' => :'String',
+ :'hashed_token' => :'String',
+ :'scopes' => :'Array',
+ :'expires_at' => :'DateTime',
+ :'created_at' => :'DateTime',
+ :'updated_at' => :'DateTime'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::Authorization` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::Authorization`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'id')
+ self.id = attributes[:'id']
+ end
+
+ if attributes.key?(:'note')
+ self.note = attributes[:'note']
+ end
+
+ if attributes.key?(:'token_last_eight')
+ self.token_last_eight = attributes[:'token_last_eight']
+ end
+
+ if attributes.key?(:'hashed_token')
+ self.hashed_token = attributes[:'hashed_token']
+ end
+
+ if attributes.key?(:'scopes')
+ if (value = attributes[:'scopes']).is_a?(Array)
+ self.scopes = value
+ end
+ end
+
+ if attributes.key?(:'expires_at')
+ self.expires_at = attributes[:'expires_at']
+ end
+
+ if attributes.key?(:'created_at')
+ self.created_at = attributes[:'created_at']
+ end
+
+ if attributes.key?(:'updated_at')
+ self.updated_at = attributes[:'updated_at']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ id == o.id &&
+ note == o.note &&
+ token_last_eight == o.token_last_eight &&
+ hashed_token == o.hashed_token &&
+ scopes == o.scopes &&
+ expires_at == o.expires_at &&
+ created_at == o.created_at &&
+ updated_at == o.updated_at
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [id, note, token_last_eight, hashed_token, scopes, expires_at, created_at, updated_at].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/authorization_create.rb b/lib/Phrase/models/authorization_create.rb
new file mode 100644
index 0000000..9ea10a6
--- /dev/null
+++ b/lib/Phrase/models/authorization_create.rb
@@ -0,0 +1,215 @@
+require 'date'
+
+module Phrase
+ class AuthorizationCreate
+ # A note to help you remember what the access is used for.
+ attr_accessor :note
+
+ # A list of scopes that the access can be used for.
+ attr_accessor :scopes
+
+ # Expiration date for the authorization token. Null means no expiration date (default).
+ attr_accessor :expires_at
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'note' => :'note',
+ :'scopes' => :'scopes',
+ :'expires_at' => :'expires_at'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'note' => :'String',
+ :'scopes' => :'String',
+ :'expires_at' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::AuthorizationCreate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::AuthorizationCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'note')
+ self.note = attributes[:'note']
+ end
+
+ if attributes.key?(:'scopes')
+ self.scopes = attributes[:'scopes']
+ end
+
+ if attributes.key?(:'expires_at')
+ self.expires_at = attributes[:'expires_at']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ note == o.note &&
+ scopes == o.scopes &&
+ expires_at == o.expires_at
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [note, scopes, expires_at].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/authorization_update.rb b/lib/Phrase/models/authorization_update.rb
new file mode 100644
index 0000000..730614f
--- /dev/null
+++ b/lib/Phrase/models/authorization_update.rb
@@ -0,0 +1,215 @@
+require 'date'
+
+module Phrase
+ class AuthorizationUpdate
+ # A note to help you remember what the access is used for.
+ attr_accessor :note
+
+ # A list of scopes that the access can be used for.
+ attr_accessor :scopes
+
+ # Expiration date for the authorization token. Null means no expiration date (default).
+ attr_accessor :expires_at
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'note' => :'note',
+ :'scopes' => :'scopes',
+ :'expires_at' => :'expires_at'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'note' => :'String',
+ :'scopes' => :'String',
+ :'expires_at' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::AuthorizationUpdate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::AuthorizationUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'note')
+ self.note = attributes[:'note']
+ end
+
+ if attributes.key?(:'scopes')
+ self.scopes = attributes[:'scopes']
+ end
+
+ if attributes.key?(:'expires_at')
+ self.expires_at = attributes[:'expires_at']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ note == o.note &&
+ scopes == o.scopes &&
+ expires_at == o.expires_at
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [note, scopes, expires_at].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/bitbucket_sync.rb b/lib/Phrase/models/bitbucket_sync.rb
new file mode 100644
index 0000000..e24dbfc
--- /dev/null
+++ b/lib/Phrase/models/bitbucket_sync.rb
@@ -0,0 +1,241 @@
+require 'date'
+
+module Phrase
+ class BitbucketSync
+ attr_accessor :id
+
+ attr_accessor :repository_name
+
+ attr_accessor :last_export_to_bitbucket_at
+
+ attr_accessor :last_import_from_bitbucket_at
+
+ attr_accessor :valid_phraseapp_yaml
+
+ attr_accessor :phraseapp_projects
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'id' => :'id',
+ :'repository_name' => :'repository_name',
+ :'last_export_to_bitbucket_at' => :'last_export_to_bitbucket_at',
+ :'last_import_from_bitbucket_at' => :'last_import_from_bitbucket_at',
+ :'valid_phraseapp_yaml' => :'valid_phraseapp_yaml',
+ :'phraseapp_projects' => :'phraseapp_projects'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'id' => :'String',
+ :'repository_name' => :'String',
+ :'last_export_to_bitbucket_at' => :'DateTime',
+ :'last_import_from_bitbucket_at' => :'DateTime',
+ :'valid_phraseapp_yaml' => :'Boolean',
+ :'phraseapp_projects' => :'Array'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BitbucketSync` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BitbucketSync`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'id')
+ self.id = attributes[:'id']
+ end
+
+ if attributes.key?(:'repository_name')
+ self.repository_name = attributes[:'repository_name']
+ end
+
+ if attributes.key?(:'last_export_to_bitbucket_at')
+ self.last_export_to_bitbucket_at = attributes[:'last_export_to_bitbucket_at']
+ end
+
+ if attributes.key?(:'last_import_from_bitbucket_at')
+ self.last_import_from_bitbucket_at = attributes[:'last_import_from_bitbucket_at']
+ end
+
+ if attributes.key?(:'valid_phraseapp_yaml')
+ self.valid_phraseapp_yaml = attributes[:'valid_phraseapp_yaml']
+ end
+
+ if attributes.key?(:'phraseapp_projects')
+ if (value = attributes[:'phraseapp_projects']).is_a?(Array)
+ self.phraseapp_projects = value
+ end
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ id == o.id &&
+ repository_name == o.repository_name &&
+ last_export_to_bitbucket_at == o.last_export_to_bitbucket_at &&
+ last_import_from_bitbucket_at == o.last_import_from_bitbucket_at &&
+ valid_phraseapp_yaml == o.valid_phraseapp_yaml &&
+ phraseapp_projects == o.phraseapp_projects
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [id, repository_name, last_export_to_bitbucket_at, last_import_from_bitbucket_at, valid_phraseapp_yaml, phraseapp_projects].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/bitbucket_sync_export.rb b/lib/Phrase/models/bitbucket_sync_export.rb
new file mode 100644
index 0000000..ef2681e
--- /dev/null
+++ b/lib/Phrase/models/bitbucket_sync_export.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BitbucketSyncExport
+ # Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.
+ attr_accessor :account_id
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'account_id' => :'account_id'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'account_id' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BitbucketSyncExport` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BitbucketSyncExport`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'account_id')
+ self.account_id = attributes[:'account_id']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ account_id == o.account_id
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [account_id].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/bitbucket_sync_export_response.rb b/lib/Phrase/models/bitbucket_sync_export_response.rb
new file mode 100644
index 0000000..1b67a3e
--- /dev/null
+++ b/lib/Phrase/models/bitbucket_sync_export_response.rb
@@ -0,0 +1,194 @@
+require 'date'
+
+module Phrase
+ class BitbucketSyncExportResponse
+ attr_accessor :status_path
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'status_path' => :'status_path'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'status_path' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BitbucketSyncExportResponse` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BitbucketSyncExportResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'status_path')
+ self.status_path = attributes[:'status_path']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ status_path == o.status_path
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [status_path].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/bitbucket_sync_import.rb b/lib/Phrase/models/bitbucket_sync_import.rb
new file mode 100644
index 0000000..9b46bf6
--- /dev/null
+++ b/lib/Phrase/models/bitbucket_sync_import.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BitbucketSyncImport
+ # Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.
+ attr_accessor :account_id
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'account_id' => :'account_id'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'account_id' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BitbucketSyncImport` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BitbucketSyncImport`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'account_id')
+ self.account_id = attributes[:'account_id']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ account_id == o.account_id
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [account_id].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/bitbucket_syncs_list.rb b/lib/Phrase/models/bitbucket_syncs_list.rb
new file mode 100644
index 0000000..fd5df57
--- /dev/null
+++ b/lib/Phrase/models/bitbucket_syncs_list.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BitbucketSyncsList
+ # Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.
+ attr_accessor :account_id
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'account_id' => :'account_id'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'account_id' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BitbucketSyncsList` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BitbucketSyncsList`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'account_id')
+ self.account_id = attributes[:'account_id']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ account_id == o.account_id
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [account_id].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/blacklisted_key.rb b/lib/Phrase/models/blacklisted_key.rb
new file mode 100644
index 0000000..4b6fbc4
--- /dev/null
+++ b/lib/Phrase/models/blacklisted_key.rb
@@ -0,0 +1,221 @@
+require 'date'
+
+module Phrase
+ class BlacklistedKey
+ attr_accessor :id
+
+ attr_accessor :name
+
+ attr_accessor :created_at
+
+ attr_accessor :updated_at
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'id' => :'id',
+ :'name' => :'name',
+ :'created_at' => :'created_at',
+ :'updated_at' => :'updated_at'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'id' => :'String',
+ :'name' => :'String',
+ :'created_at' => :'DateTime',
+ :'updated_at' => :'DateTime'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BlacklistedKey` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BlacklistedKey`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'id')
+ self.id = attributes[:'id']
+ end
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+
+ if attributes.key?(:'created_at')
+ self.created_at = attributes[:'created_at']
+ end
+
+ if attributes.key?(:'updated_at')
+ self.updated_at = attributes[:'updated_at']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ id == o.id &&
+ name == o.name &&
+ created_at == o.created_at &&
+ updated_at == o.updated_at
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [id, name, created_at, updated_at].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/blacklisted_key_create.rb b/lib/Phrase/models/blacklisted_key_create.rb
new file mode 100644
index 0000000..712daa9
--- /dev/null
+++ b/lib/Phrase/models/blacklisted_key_create.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BlacklistedKeyCreate
+ # Blacklisted key name
+ attr_accessor :name
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'name' => :'name'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'name' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BlacklistedKeyCreate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BlacklistedKeyCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ name == o.name
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [name].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/blacklisted_key_update.rb b/lib/Phrase/models/blacklisted_key_update.rb
new file mode 100644
index 0000000..eb9e8dc
--- /dev/null
+++ b/lib/Phrase/models/blacklisted_key_update.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BlacklistedKeyUpdate
+ # Blacklisted key name
+ attr_accessor :name
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'name' => :'name'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'name' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BlacklistedKeyUpdate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BlacklistedKeyUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ name == o.name
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [name].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/branch.rb b/lib/Phrase/models/branch.rb
new file mode 100644
index 0000000..5afa612
--- /dev/null
+++ b/lib/Phrase/models/branch.rb
@@ -0,0 +1,248 @@
+require 'date'
+
+module Phrase
+ class Branch
+ attr_accessor :name
+
+ attr_accessor :created_at
+
+ attr_accessor :updated_at
+
+ attr_accessor :merged_at
+
+ attr_accessor :merged_by
+
+ attr_accessor :created_by
+
+ attr_accessor :state
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'name' => :'name',
+ :'created_at' => :'created_at',
+ :'updated_at' => :'updated_at',
+ :'merged_at' => :'merged_at',
+ :'merged_by' => :'merged_by',
+ :'created_by' => :'created_by',
+ :'state' => :'state'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'name' => :'String',
+ :'created_at' => :'DateTime',
+ :'updated_at' => :'DateTime',
+ :'merged_at' => :'DateTime',
+ :'merged_by' => :'UserPreview',
+ :'created_by' => :'Object',
+ :'state' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::Branch` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::Branch`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+
+ if attributes.key?(:'created_at')
+ self.created_at = attributes[:'created_at']
+ end
+
+ if attributes.key?(:'updated_at')
+ self.updated_at = attributes[:'updated_at']
+ end
+
+ if attributes.key?(:'merged_at')
+ self.merged_at = attributes[:'merged_at']
+ end
+
+ if attributes.key?(:'merged_by')
+ self.merged_by = attributes[:'merged_by']
+ end
+
+ if attributes.key?(:'created_by')
+ self.created_by = attributes[:'created_by']
+ end
+
+ if attributes.key?(:'state')
+ self.state = attributes[:'state']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ name == o.name &&
+ created_at == o.created_at &&
+ updated_at == o.updated_at &&
+ merged_at == o.merged_at &&
+ merged_by == o.merged_by &&
+ created_by == o.created_by &&
+ state == o.state
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [name, created_at, updated_at, merged_at, merged_by, created_by, state].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/branch_compare.rb b/lib/Phrase/models/branch_compare.rb
new file mode 100644
index 0000000..74643ed
--- /dev/null
+++ b/lib/Phrase/models/branch_compare.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BranchCompare
+ # Name of the branch
+ attr_accessor :name
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'name' => :'name'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'name' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BranchCompare` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BranchCompare`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ name == o.name
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [name].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/branch_create.rb b/lib/Phrase/models/branch_create.rb
new file mode 100644
index 0000000..bf85cb1
--- /dev/null
+++ b/lib/Phrase/models/branch_create.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BranchCreate
+ # Name of the branch
+ attr_accessor :name
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'name' => :'name'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'name' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BranchCreate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BranchCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ name == o.name
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [name].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/branch_merge.rb b/lib/Phrase/models/branch_merge.rb
new file mode 100644
index 0000000..bec6c67
--- /dev/null
+++ b/lib/Phrase/models/branch_merge.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BranchMerge
+ # strategy used for merge blocking, use_master or use_branch
+ attr_accessor :strategy
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'strategy' => :'strategy'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'strategy' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BranchMerge` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BranchMerge`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'strategy')
+ self.strategy = attributes[:'strategy']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ strategy == o.strategy
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [strategy].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/branch_update.rb b/lib/Phrase/models/branch_update.rb
new file mode 100644
index 0000000..1c1bb6e
--- /dev/null
+++ b/lib/Phrase/models/branch_update.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class BranchUpdate
+ # Name of the branch
+ attr_accessor :name
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'name' => :'name'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'name' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::BranchUpdate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::BranchUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ name == o.name
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [name].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comment.rb b/lib/Phrase/models/comment.rb
new file mode 100644
index 0000000..becf7e8
--- /dev/null
+++ b/lib/Phrase/models/comment.rb
@@ -0,0 +1,230 @@
+require 'date'
+
+module Phrase
+ class Comment
+ attr_accessor :id
+
+ attr_accessor :message
+
+ attr_accessor :user
+
+ attr_accessor :created_at
+
+ attr_accessor :updated_at
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'id' => :'id',
+ :'message' => :'message',
+ :'user' => :'user',
+ :'created_at' => :'created_at',
+ :'updated_at' => :'updated_at'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'id' => :'String',
+ :'message' => :'String',
+ :'user' => :'Object',
+ :'created_at' => :'DateTime',
+ :'updated_at' => :'DateTime'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::Comment` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::Comment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'id')
+ self.id = attributes[:'id']
+ end
+
+ if attributes.key?(:'message')
+ self.message = attributes[:'message']
+ end
+
+ if attributes.key?(:'user')
+ self.user = attributes[:'user']
+ end
+
+ if attributes.key?(:'created_at')
+ self.created_at = attributes[:'created_at']
+ end
+
+ if attributes.key?(:'updated_at')
+ self.updated_at = attributes[:'updated_at']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ id == o.id &&
+ message == o.message &&
+ user == o.user &&
+ created_at == o.created_at &&
+ updated_at == o.updated_at
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [id, message, user, created_at, updated_at].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comment_create.rb b/lib/Phrase/models/comment_create.rb
new file mode 100644
index 0000000..1cd2384
--- /dev/null
+++ b/lib/Phrase/models/comment_create.rb
@@ -0,0 +1,205 @@
+require 'date'
+
+module Phrase
+ class CommentCreate
+ # specify the branch to use
+ attr_accessor :branch
+
+ # Comment message
+ attr_accessor :message
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'branch' => :'branch',
+ :'message' => :'message'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'branch' => :'String',
+ :'message' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentCreate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'branch')
+ self.branch = attributes[:'branch']
+ end
+
+ if attributes.key?(:'message')
+ self.message = attributes[:'message']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ branch == o.branch &&
+ message == o.message
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [branch, message].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comment_delete.rb b/lib/Phrase/models/comment_delete.rb
new file mode 100644
index 0000000..e61b0fa
--- /dev/null
+++ b/lib/Phrase/models/comment_delete.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class CommentDelete
+ # specify the branch to use
+ attr_accessor :branch
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'branch' => :'branch'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'branch' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentDelete` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentDelete`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'branch')
+ self.branch = attributes[:'branch']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ branch == o.branch
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [branch].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comment_mark_check.rb b/lib/Phrase/models/comment_mark_check.rb
new file mode 100644
index 0000000..740bcbb
--- /dev/null
+++ b/lib/Phrase/models/comment_mark_check.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class CommentMarkCheck
+ # specify the branch to use
+ attr_accessor :branch
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'branch' => :'branch'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'branch' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentMarkCheck` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentMarkCheck`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'branch')
+ self.branch = attributes[:'branch']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ branch == o.branch
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [branch].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comment_mark_read.rb b/lib/Phrase/models/comment_mark_read.rb
new file mode 100644
index 0000000..9c4670d
--- /dev/null
+++ b/lib/Phrase/models/comment_mark_read.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class CommentMarkRead
+ # specify the branch to use
+ attr_accessor :branch
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'branch' => :'branch'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'branch' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentMarkRead` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentMarkRead`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'branch')
+ self.branch = attributes[:'branch']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ branch == o.branch
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [branch].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comment_mark_unread.rb b/lib/Phrase/models/comment_mark_unread.rb
new file mode 100644
index 0000000..f176943
--- /dev/null
+++ b/lib/Phrase/models/comment_mark_unread.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class CommentMarkUnread
+ # specify the branch to use
+ attr_accessor :branch
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'branch' => :'branch'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'branch' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentMarkUnread` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentMarkUnread`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'branch')
+ self.branch = attributes[:'branch']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ branch == o.branch
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [branch].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comment_show.rb b/lib/Phrase/models/comment_show.rb
new file mode 100644
index 0000000..5944f7b
--- /dev/null
+++ b/lib/Phrase/models/comment_show.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class CommentShow
+ # specify the branch to use
+ attr_accessor :branch
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'branch' => :'branch'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'branch' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentShow` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentShow`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'branch')
+ self.branch = attributes[:'branch']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ branch == o.branch
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [branch].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comment_update.rb b/lib/Phrase/models/comment_update.rb
new file mode 100644
index 0000000..f18c309
--- /dev/null
+++ b/lib/Phrase/models/comment_update.rb
@@ -0,0 +1,205 @@
+require 'date'
+
+module Phrase
+ class CommentUpdate
+ # specify the branch to use
+ attr_accessor :branch
+
+ # Comment message
+ attr_accessor :message
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'branch' => :'branch',
+ :'message' => :'message'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'branch' => :'String',
+ :'message' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentUpdate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'branch')
+ self.branch = attributes[:'branch']
+ end
+
+ if attributes.key?(:'message')
+ self.message = attributes[:'message']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ branch == o.branch &&
+ message == o.message
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [branch, message].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/comments_list.rb b/lib/Phrase/models/comments_list.rb
new file mode 100644
index 0000000..9cf0b7e
--- /dev/null
+++ b/lib/Phrase/models/comments_list.rb
@@ -0,0 +1,195 @@
+require 'date'
+
+module Phrase
+ class CommentsList
+ # specify the branch to use
+ attr_accessor :branch
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'branch' => :'branch'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'branch' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::CommentsList` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::CommentsList`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'branch')
+ self.branch = attributes[:'branch']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ branch == o.branch
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [branch].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/distribution.rb b/lib/Phrase/models/distribution.rb
new file mode 100644
index 0000000..e839c35
--- /dev/null
+++ b/lib/Phrase/models/distribution.rb
@@ -0,0 +1,252 @@
+require 'date'
+
+module Phrase
+ class Distribution
+ attr_accessor :id
+
+ attr_accessor :name
+
+ attr_accessor :project
+
+ attr_accessor :platforms
+
+ attr_accessor :releases
+
+ attr_accessor :created_at
+
+ attr_accessor :deleted_at
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'id' => :'id',
+ :'name' => :'name',
+ :'project' => :'project',
+ :'platforms' => :'platforms',
+ :'releases' => :'releases',
+ :'created_at' => :'created_at',
+ :'deleted_at' => :'deleted_at'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'id' => :'String',
+ :'name' => :'String',
+ :'project' => :'ProjectShort',
+ :'platforms' => :'Array',
+ :'releases' => :'Array',
+ :'created_at' => :'DateTime',
+ :'deleted_at' => :'DateTime'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::Distribution` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::Distribution`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'id')
+ self.id = attributes[:'id']
+ end
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+
+ if attributes.key?(:'project')
+ self.project = attributes[:'project']
+ end
+
+ if attributes.key?(:'platforms')
+ if (value = attributes[:'platforms']).is_a?(Array)
+ self.platforms = value
+ end
+ end
+
+ if attributes.key?(:'releases')
+ if (value = attributes[:'releases']).is_a?(Array)
+ self.releases = value
+ end
+ end
+
+ if attributes.key?(:'created_at')
+ self.created_at = attributes[:'created_at']
+ end
+
+ if attributes.key?(:'deleted_at')
+ self.deleted_at = attributes[:'deleted_at']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ id == o.id &&
+ name == o.name &&
+ project == o.project &&
+ platforms == o.platforms &&
+ releases == o.releases &&
+ created_at == o.created_at &&
+ deleted_at == o.deleted_at
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [id, name, project, platforms, releases, created_at, deleted_at].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/distribution_create.rb b/lib/Phrase/models/distribution_create.rb
new file mode 100644
index 0000000..28199cc
--- /dev/null
+++ b/lib/Phrase/models/distribution_create.rb
@@ -0,0 +1,255 @@
+require 'date'
+
+module Phrase
+ class DistributionCreate
+ # Name of the distribution
+ attr_accessor :name
+
+ # Project id the distribution should be assigned to.
+ attr_accessor :project_id
+
+ # List of platforms the distribution should support.
+ attr_accessor :platforms
+
+ # Additional formatting and render options. Only enclose_in_cdata is available for platform android.
+ attr_accessor :format_options
+
+ # Indicates whether to fallback to non regional locale when locale can not be found
+ attr_accessor :fallback_to_non_regional_locale
+
+ # Indicates whether to fallback to projects default locale when locale can not be found
+ attr_accessor :fallback_to_default_locale
+
+ # Use last reviewed instead of latest translation in a project
+ attr_accessor :use_last_reviewed_version
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'name' => :'name',
+ :'project_id' => :'project_id',
+ :'platforms' => :'platforms',
+ :'format_options' => :'format_options',
+ :'fallback_to_non_regional_locale' => :'fallback_to_non_regional_locale',
+ :'fallback_to_default_locale' => :'fallback_to_default_locale',
+ :'use_last_reviewed_version' => :'use_last_reviewed_version'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'name' => :'String',
+ :'project_id' => :'String',
+ :'platforms' => :'String',
+ :'format_options' => :'String',
+ :'fallback_to_non_regional_locale' => :'String',
+ :'fallback_to_default_locale' => :'String',
+ :'use_last_reviewed_version' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::DistributionCreate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::DistributionCreate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+
+ if attributes.key?(:'project_id')
+ self.project_id = attributes[:'project_id']
+ end
+
+ if attributes.key?(:'platforms')
+ self.platforms = attributes[:'platforms']
+ end
+
+ if attributes.key?(:'format_options')
+ self.format_options = attributes[:'format_options']
+ end
+
+ if attributes.key?(:'fallback_to_non_regional_locale')
+ self.fallback_to_non_regional_locale = attributes[:'fallback_to_non_regional_locale']
+ end
+
+ if attributes.key?(:'fallback_to_default_locale')
+ self.fallback_to_default_locale = attributes[:'fallback_to_default_locale']
+ end
+
+ if attributes.key?(:'use_last_reviewed_version')
+ self.use_last_reviewed_version = attributes[:'use_last_reviewed_version']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ name == o.name &&
+ project_id == o.project_id &&
+ platforms == o.platforms &&
+ format_options == o.format_options &&
+ fallback_to_non_regional_locale == o.fallback_to_non_regional_locale &&
+ fallback_to_default_locale == o.fallback_to_default_locale &&
+ use_last_reviewed_version == o.use_last_reviewed_version
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [name, project_id, platforms, format_options, fallback_to_non_regional_locale, fallback_to_default_locale, use_last_reviewed_version].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/distribution_preview.rb b/lib/Phrase/models/distribution_preview.rb
new file mode 100644
index 0000000..7c0501e
--- /dev/null
+++ b/lib/Phrase/models/distribution_preview.rb
@@ -0,0 +1,250 @@
+require 'date'
+
+module Phrase
+ class DistributionPreview
+ attr_accessor :id
+
+ attr_accessor :name
+
+ attr_accessor :project
+
+ attr_accessor :platforms
+
+ attr_accessor :release_count
+
+ attr_accessor :created_at
+
+ attr_accessor :deleted_at
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'id' => :'id',
+ :'name' => :'name',
+ :'project' => :'project',
+ :'platforms' => :'platforms',
+ :'release_count' => :'release_count',
+ :'created_at' => :'created_at',
+ :'deleted_at' => :'deleted_at'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'id' => :'String',
+ :'name' => :'String',
+ :'project' => :'Object',
+ :'platforms' => :'Array',
+ :'release_count' => :'Integer',
+ :'created_at' => :'DateTime',
+ :'deleted_at' => :'DateTime'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::DistributionPreview` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::DistributionPreview`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'id')
+ self.id = attributes[:'id']
+ end
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+
+ if attributes.key?(:'project')
+ self.project = attributes[:'project']
+ end
+
+ if attributes.key?(:'platforms')
+ if (value = attributes[:'platforms']).is_a?(Array)
+ self.platforms = value
+ end
+ end
+
+ if attributes.key?(:'release_count')
+ self.release_count = attributes[:'release_count']
+ end
+
+ if attributes.key?(:'created_at')
+ self.created_at = attributes[:'created_at']
+ end
+
+ if attributes.key?(:'deleted_at')
+ self.deleted_at = attributes[:'deleted_at']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ id == o.id &&
+ name == o.name &&
+ project == o.project &&
+ platforms == o.platforms &&
+ release_count == o.release_count &&
+ created_at == o.created_at &&
+ deleted_at == o.deleted_at
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [id, name, project, platforms, release_count, created_at, deleted_at].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/distribution_update.rb b/lib/Phrase/models/distribution_update.rb
new file mode 100644
index 0000000..c6ffdad
--- /dev/null
+++ b/lib/Phrase/models/distribution_update.rb
@@ -0,0 +1,255 @@
+require 'date'
+
+module Phrase
+ class DistributionUpdate
+ # Name of the distribution
+ attr_accessor :name
+
+ # Project id the distribution should be assigned to.
+ attr_accessor :project_id
+
+ # List of platforms the distribution should support.
+ attr_accessor :platforms
+
+ # Additional formatting and render options. Only enclose_in_cdata is available for platform android.
+ attr_accessor :format_options
+
+ # Indicates whether to fallback to non regional locale when locale can not be found
+ attr_accessor :fallback_to_non_regional_locale
+
+ # Indicates whether to fallback to projects default locale when locale can not be found
+ attr_accessor :fallback_to_default_locale
+
+ # Use last reviewed instead of latest translation in a project
+ attr_accessor :use_last_reviewed_version
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'name' => :'name',
+ :'project_id' => :'project_id',
+ :'platforms' => :'platforms',
+ :'format_options' => :'format_options',
+ :'fallback_to_non_regional_locale' => :'fallback_to_non_regional_locale',
+ :'fallback_to_default_locale' => :'fallback_to_default_locale',
+ :'use_last_reviewed_version' => :'use_last_reviewed_version'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'name' => :'String',
+ :'project_id' => :'String',
+ :'platforms' => :'String',
+ :'format_options' => :'String',
+ :'fallback_to_non_regional_locale' => :'String',
+ :'fallback_to_default_locale' => :'String',
+ :'use_last_reviewed_version' => :'String'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::DistributionUpdate` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::DistributionUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'name')
+ self.name = attributes[:'name']
+ end
+
+ if attributes.key?(:'project_id')
+ self.project_id = attributes[:'project_id']
+ end
+
+ if attributes.key?(:'platforms')
+ self.platforms = attributes[:'platforms']
+ end
+
+ if attributes.key?(:'format_options')
+ self.format_options = attributes[:'format_options']
+ end
+
+ if attributes.key?(:'fallback_to_non_regional_locale')
+ self.fallback_to_non_regional_locale = attributes[:'fallback_to_non_regional_locale']
+ end
+
+ if attributes.key?(:'fallback_to_default_locale')
+ self.fallback_to_default_locale = attributes[:'fallback_to_default_locale']
+ end
+
+ if attributes.key?(:'use_last_reviewed_version')
+ self.use_last_reviewed_version = attributes[:'use_last_reviewed_version']
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ name == o.name &&
+ project_id == o.project_id &&
+ platforms == o.platforms &&
+ format_options == o.format_options &&
+ fallback_to_non_regional_locale == o.fallback_to_non_regional_locale &&
+ fallback_to_default_locale == o.fallback_to_default_locale &&
+ use_last_reviewed_version == o.use_last_reviewed_version
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [name, project_id, platforms, format_options, fallback_to_non_regional_locale, fallback_to_default_locale, use_last_reviewed_version].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?.+?), (?.+)>\z/
+ k_type = Regexp.last_match[:k_type]
+ v_type = Regexp.last_match[:v_type]
+ {}.tap do |hash|
+ value.each do |k, v|
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+ end
+ end
+ else # model
+ Phrase.const_get(type).build_from_hash(value)
+ end
+ end
+
+ # Returns the string representation of the object
+ # @return [String] String presentation of the object
+ def to_s
+ to_hash.to_s
+ end
+
+ # to_body is an alias to to_hash (backward compatibility)
+ # @return [Hash] Returns the object in the form of hash
+ def to_body
+ to_hash
+ end
+
+ # Returns the object in the form of hash
+ # @return [Hash] Returns the object in the form of hash
+ def to_hash
+ hash = {}
+ self.class.attribute_map.each_pair do |attr, param|
+ value = self.send(attr)
+ if value.nil?
+ is_nullable = self.class.openapi_nullable.include?(attr)
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+ end
+
+ hash[param] = _to_hash(value)
+ end
+ hash
+ end
+
+ # Outputs non-array value in the form of hash
+ # For object, use to_hash. Otherwise, just return the value
+ # @param [Object] value Any valid value
+ # @return [Hash] Returns the value in the form of hash
+ def _to_hash(value)
+ if value.is_a?(Array)
+ value.compact.map { |v| _to_hash(v) }
+ elsif value.is_a?(Hash)
+ {}.tap do |hash|
+ value.each { |k, v| hash[k] = _to_hash(v) }
+ end
+ elsif value.respond_to? :to_hash
+ value.to_hash
+ else
+ value
+ end
+ end
+ end
+end
diff --git a/lib/Phrase/models/errors.rb b/lib/Phrase/models/errors.rb
new file mode 100644
index 0000000..60c9401
--- /dev/null
+++ b/lib/Phrase/models/errors.rb
@@ -0,0 +1,205 @@
+require 'date'
+
+module Phrase
+ class Errors
+ attr_accessor :message
+
+ attr_accessor :errors
+
+ # Attribute mapping from ruby-style variable name to JSON key.
+ def self.attribute_map
+ {
+ :'message' => :'message',
+ :'errors' => :'errors'
+ }
+ end
+
+ # Attribute type mapping.
+ def self.openapi_types
+ {
+ :'message' => :'String',
+ :'errors' => :'Array'
+ }
+ end
+
+ # List of attributes with nullable: true
+ def self.openapi_nullable
+ Set.new([
+ ])
+ end
+
+ # Initializes the object
+ # @param [Hash] attributes Model attributes in the form of hash
+ def initialize(attributes = {})
+ if (!attributes.is_a?(Hash))
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::Errors` initialize method"
+ end
+
+ # check to see if the attribute exists and convert string to symbol for hash key
+ attributes = attributes.each_with_object({}) { |(k, v), h|
+ if (!self.class.attribute_map.key?(k.to_sym))
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::Errors`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+ end
+ h[k.to_sym] = v
+ }
+
+ if attributes.key?(:'message')
+ self.message = attributes[:'message']
+ end
+
+ if attributes.key?(:'errors')
+ if (value = attributes[:'errors']).is_a?(Array)
+ self.errors = value
+ end
+ end
+ end
+
+ # Show invalid properties with the reasons. Usually used together with valid?
+ # @return Array for valid properties with the reasons
+ def list_invalid_properties
+ invalid_properties = Array.new
+ invalid_properties
+ end
+
+ # Check to see if the all the properties in the model are valid
+ # @return true if the model is valid
+ def valid?
+ true
+ end
+
+ # Checks equality by comparing each attribute.
+ # @param [Object] Object to be compared
+ def ==(o)
+ return true if self.equal?(o)
+ self.class == o.class &&
+ message == o.message &&
+ errors == o.errors
+ end
+
+ # @see the `==` method
+ # @param [Object] Object to be compared
+ def eql?(o)
+ self == o
+ end
+
+ # Calculates hash code according to all attributes.
+ # @return [Integer] Hash code
+ def hash
+ [message, errors].hash
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def self.build_from_hash(attributes)
+ new.build_from_hash(attributes)
+ end
+
+ # Builds the object from hash
+ # @param [Hash] attributes Model attributes in the form of hash
+ # @return [Object] Returns the model itself
+ def build_from_hash(attributes)
+ return nil unless attributes.is_a?(Hash)
+ self.class.openapi_types.each_pair do |key, type|
+ if type =~ /\AArray<(.*)>/i
+ # check to ensure the input is an array given that the attribute
+ # is documented as an array but the input is not
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+ end
+ elsif !attributes[self.class.attribute_map[key]].nil?
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
+ end
+
+ self
+ end
+
+ # Deserializes the data based on type
+ # @param string type Data type
+ # @param string value Value to be deserialized
+ # @return [Object] Deserialized data
+ def _deserialize(type, value)
+ case type.to_sym
+ when :DateTime
+ DateTime.parse(value)
+ when :Date
+ Date.parse(value)
+ when :String
+ value.to_s
+ when :Integer
+ value.to_i
+ when :Float
+ value.to_f
+ when :Boolean
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+ true
+ else
+ false
+ end
+ when :Object
+ # generic object (usually a Hash), return directly
+ value
+ when /\AArray<(?.+)>\z/
+ inner_type = Regexp.last_match[:inner_type]
+ value.map { |v| _deserialize(inner_type, v) }
+ when /\AHash<(?