phrase 0.4.31 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bf0b86279fd6eb155d420c6f6e1eb484721f89f5
-  data.tar.gz: 4ab2fdd122f8a275df89fb76f020a48772cb631c
+SHA256:
+  metadata.gz: 5a2a3ba240b5fe6192611ada80af8b0e4801f5d8b3719537257c63acff09d41e
+  data.tar.gz: 61a4a7f0c7a3dabd110a1b5c9c585c59238977a5cbdcf52f6139e8d2bac3d9de
 SHA512:
-  metadata.gz: 169aeda0534c724f894cbbd03f6e08292da3e96fa3f9f1aee4bfa7c900e1098330a577b9383606b632f9988d5992189bda3b28d5035cfc2de5c95eacfc2c7b0f
-  data.tar.gz: 457868e5efae4cf27f2e3e240776b5b5e224f3f1e834447c4200926deee552cecb1c3334b4f20a3f85b7f17c14c292dc4b9e247f3f1d649731d9e49e61c92459
+  metadata.gz: 7a798dcbf704b4b174f4cf7aca3df46abea328efd23dcd0668c23c775e79f73ebaf1dfa2620cfb06e0db2eb20aa12d5b94be4ba4dfb8d817d17f82fa856c2540
+  data.tar.gz: 36f134b201a9d3c770a413b67bad3418fe2ad9b1e254dc0de6fdce651f21ff0a2b02df37d40edf2176698f4a91119486bda4163820ee01d7c470a52ca7a837cc

data/Gemfile

@@ -1,3 +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

data/LICENSE

@@ -1,22 +1,21 @@
-Copyright (c) 2012 Dynport GmbH
-
 MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Copyright (c) 2016 Dynport GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,298 +1,467 @@
-# PhraseApp #
-[![Code Climate](https://codeclimate.com/github/phrase/phrase.png)](https://codeclimate.com/github/phrase/phrase)
-[![Build Status](https://secure.travis-ci.org/phrase/phrase.png)](http://travis-ci.org/phrase/phrase)
+# phrase
 
-PhraseApp lets you set up a professional translation process to boost the quality of your translations with the powerful In-Context Editor.
+Phrase - the Ruby gem for the Phrase API Reference
 
-You can order professional translations from within PhraseApp, or just work with your own team. Our platform support various programming languages and frameworks. Such as [Ruby on Rails, Symfony, Zend Framework, iOS, Android and many more](https://phraseapp.com/docs/general/supported-platforms).
+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.
 
-This client lets you integrate PhraseApp into your project and access your locale files through the PhraseApp [API](https://phraseapp.com/docs/api/overview).
+## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-[Get your free PhraseApp trial](https://phraseapp.com/signup) and start right away.
+- API version: 2.0.0
+- Package version: 1.0.3
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
-### Supported Formats ###
-You can manage your locale files with PhraseApp if you use one of the following formats:
+## Installation
 
-* Ruby/Rails YAML
-* Gettext
-* Gettext Template
-* Android Strings
-* iOS Localizable Strings
-* XLIFF
-* Qt Phrase Book
-* Qt Translation Source
-* Chrome JSON i18n
-* Simple JSON
-* Nested JSON
-* i18n-node-2 JSON
-* .NET ResX
-* Windows Phone ResX
-* Windows 8 Resource
-* INI
-* Java Properties .properties
-* Java Properties XML
-* Objective-C/Cocoa Property List
-* Symfony YAML
-* Symfony2 YAML (Beta)
-* TMX Translation Memory eXchange
-* Excel XLSX (Beta)
-* CSV
-* PHP Array
-* Zendesk CSV
-* Laravel PHP
-* Angular Translate
-* Mozilla Properties
-* Play Properties
+### Install from [rubygems.org](https://rubygems.org/)
 
-## Usage
+Install from the command line:
 
-This command line client is a Ruby gem. If you haven't installed Ruby on your system yet, we have put together a [handy tutorial](https://phraseapp.com/docs/installation/ruby-installation) for you.
+```shell
+$ gem install phrase
+```
 
-You don't have to use this client but can also use the [API directly](https://phraseapp.com/docs/api/overview).
+Install via Gemfile:
 
-### Installation
+    gem "phrase"
 
-Install the gem via `gem install`
+### Install from GitHub Packages
 
-	gem install phrase
-	
-or add it to your `Gemfile` when using bundler:
+Install from the command line:
 
-	gem 'phrase'
+```shell
+$ gem install phrase-ruby --source "https://rubygems.pkg.github.com/phrase"
+```
 
-and install it	
+Install via Gemfile:
 
-	$ bundle install
-	
-That's it!
+    source "https://rubygems.pkg.github.com/phrase" do
+      gem "phrase-ruby"
+    end
 
-### Initialization
+### Install from Git
 
-Before you can use the phrase command line client you have to set up some configuration data. When using Rails we recommend using the Rails generator we provide. For all other environments you can use a simple command to initialize the setup.
+Add the following in the Gemfile:
+
+    gem 'phrase', git: 'https://github.com/phrase/phrase-ruby.git'
+
+### Build and install a gem on your own
+
+To build the Ruby code into a gem:
+
+```shell
+gem build phrase.gemspec
+```
+
+Then install the gem locally:
+
+```shell
+gem install ./phrase-1.0.3.gem
+```
+
+(for development, run `gem install --dev ./phrase-1.0.3.gem` to install the development dependencies)
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```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'
+
+  # Or configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::AccountsApi.new
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Get a single account
+  result = api_instance.account_show(id, opts)
+  pp result
+  pp result.next_page?
+  pp result.next_page
+rescue Phrase::ApiError => e
+  puts "Exception when calling AccountsApi->account_show: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Phrase::AccountsApi* | [**account_show**](docs/AccountsApi.md#account_show) | **GET** /accounts/{id} | Get a single account
+*Phrase::AccountsApi* | [**accounts_list**](docs/AccountsApi.md#accounts_list) | **GET** /accounts | List accounts
+*Phrase::AuthorizationsApi* | [**authorization_create**](docs/AuthorizationsApi.md#authorization_create) | **POST** /authorizations | Create an authorization
+*Phrase::AuthorizationsApi* | [**authorization_delete**](docs/AuthorizationsApi.md#authorization_delete) | **DELETE** /authorizations/{id} | Delete an authorization
+*Phrase::AuthorizationsApi* | [**authorization_show**](docs/AuthorizationsApi.md#authorization_show) | **GET** /authorizations/{id} | Get a single authorization
+*Phrase::AuthorizationsApi* | [**authorization_update**](docs/AuthorizationsApi.md#authorization_update) | **PATCH** /authorizations/{id} | Update an authorization
+*Phrase::AuthorizationsApi* | [**authorizations_list**](docs/AuthorizationsApi.md#authorizations_list) | **GET** /authorizations | List authorizations
+*Phrase::BitbucketSyncApi* | [**bitbucket_sync_export**](docs/BitbucketSyncApi.md#bitbucket_sync_export) | **POST** /bitbucket_syncs/{id}/export | Export from Phrase to Bitbucket
+*Phrase::BitbucketSyncApi* | [**bitbucket_sync_import**](docs/BitbucketSyncApi.md#bitbucket_sync_import) | **POST** /bitbucket_syncs/{id}/import | Import to Phrase from Bitbucket
+*Phrase::BitbucketSyncApi* | [**bitbucket_syncs_list**](docs/BitbucketSyncApi.md#bitbucket_syncs_list) | **GET** /bitbucket_syncs | List Bitbucket syncs
+*Phrase::BlacklistedKeysApi* | [**blacklisted_key_create**](docs/BlacklistedKeysApi.md#blacklisted_key_create) | **POST** /projects/{project_id}/blacklisted_keys | Create a blacklisted key
+*Phrase::BlacklistedKeysApi* | [**blacklisted_key_delete**](docs/BlacklistedKeysApi.md#blacklisted_key_delete) | **DELETE** /projects/{project_id}/blacklisted_keys/{id} | Delete a blacklisted key
+*Phrase::BlacklistedKeysApi* | [**blacklisted_key_show**](docs/BlacklistedKeysApi.md#blacklisted_key_show) | **GET** /projects/{project_id}/blacklisted_keys/{id} | Get a single blacklisted key
+*Phrase::BlacklistedKeysApi* | [**blacklisted_key_update**](docs/BlacklistedKeysApi.md#blacklisted_key_update) | **PATCH** /projects/{project_id}/blacklisted_keys/{id} | Update a blacklisted key
+*Phrase::BlacklistedKeysApi* | [**blacklisted_keys_list**](docs/BlacklistedKeysApi.md#blacklisted_keys_list) | **GET** /projects/{project_id}/blacklisted_keys | List blacklisted keys
+*Phrase::BranchesApi* | [**branch_compare**](docs/BranchesApi.md#branch_compare) | **GET** /projects/{project_id}/branches/{name}/compare | Compare branches
+*Phrase::BranchesApi* | [**branch_create**](docs/BranchesApi.md#branch_create) | **POST** /projects/{project_id}/branches | Create a branch
+*Phrase::BranchesApi* | [**branch_delete**](docs/BranchesApi.md#branch_delete) | **DELETE** /projects/{project_id}/branches/{name} | Delete a branch
+*Phrase::BranchesApi* | [**branch_merge**](docs/BranchesApi.md#branch_merge) | **PATCH** /projects/{project_id}/branches/{name}/merge | Merge a branch
+*Phrase::BranchesApi* | [**branch_show**](docs/BranchesApi.md#branch_show) | **GET** /projects/{project_id}/branches/{name} | Get a single branch
+*Phrase::BranchesApi* | [**branch_update**](docs/BranchesApi.md#branch_update) | **PATCH** /projects/{project_id}/branches/{name} | Update a branch
+*Phrase::BranchesApi* | [**branches_list**](docs/BranchesApi.md#branches_list) | **GET** /projects/{project_id}/branches | List branches
+*Phrase::CommentsApi* | [**comment_create**](docs/CommentsApi.md#comment_create) | **POST** /projects/{project_id}/keys/{key_id}/comments | Create a comment
+*Phrase::CommentsApi* | [**comment_delete**](docs/CommentsApi.md#comment_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{id} | Delete a comment
+*Phrase::CommentsApi* | [**comment_mark_check**](docs/CommentsApi.md#comment_mark_check) | **GET** /projects/{project_id}/keys/{key_id}/comments/{id}/read | Check if comment is read
+*Phrase::CommentsApi* | [**comment_mark_read**](docs/CommentsApi.md#comment_mark_read) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{id}/read | Mark a comment as read
+*Phrase::CommentsApi* | [**comment_mark_unread**](docs/CommentsApi.md#comment_mark_unread) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{id}/read | Mark a comment as unread
+*Phrase::CommentsApi* | [**comment_show**](docs/CommentsApi.md#comment_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{id} | Get a single comment
+*Phrase::CommentsApi* | [**comment_update**](docs/CommentsApi.md#comment_update) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{id} | Update a comment
+*Phrase::CommentsApi* | [**comments_list**](docs/CommentsApi.md#comments_list) | **GET** /projects/{project_id}/keys/{key_id}/comments | List comments
+*Phrase::DistributionsApi* | [**distribution_create**](docs/DistributionsApi.md#distribution_create) | **POST** /accounts/{account_id}/distributions | Create a distribution
+*Phrase::DistributionsApi* | [**distribution_delete**](docs/DistributionsApi.md#distribution_delete) | **DELETE** /accounts/{account_id}/distributions/{id} | Delete a distribution
+*Phrase::DistributionsApi* | [**distribution_show**](docs/DistributionsApi.md#distribution_show) | **GET** /accounts/{account_id}/distributions/{id} | Get a single distribution
+*Phrase::DistributionsApi* | [**distribution_update**](docs/DistributionsApi.md#distribution_update) | **PATCH** /accounts/{account_id}/distributions/{id} | Update a distribution
+*Phrase::DistributionsApi* | [**distributions_list**](docs/DistributionsApi.md#distributions_list) | **GET** /accounts/{account_id}/distributions | List distributions
+*Phrase::DocumentsApi* | [**document_delete**](docs/DocumentsApi.md#document_delete) | **DELETE** /projects/{project_id}/documents/{id} | Delete document
+*Phrase::DocumentsApi* | [**documents_list**](docs/DocumentsApi.md#documents_list) | **GET** /projects/{project_id}/documents | List documents
+*Phrase::FormatsApi* | [**formats_list**](docs/FormatsApi.md#formats_list) | **GET** /formats | List formats
+*Phrase::GitHubSyncApi* | [**github_sync_export**](docs/GitHubSyncApi.md#github_sync_export) | **POST** /github_syncs/export | Export from Phrase to GitHub
+*Phrase::GitHubSyncApi* | [**github_sync_import**](docs/GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase from GitHub
+*Phrase::GitLabSyncApi* | [**gitlab_sync_delete**](docs/GitLabSyncApi.md#gitlab_sync_delete) | **DELETE** /gitlab_syncs/{id} | Delete single Sync Setting
+*Phrase::GitLabSyncApi* | [**gitlab_sync_export**](docs/GitLabSyncApi.md#gitlab_sync_export) | **POST** /gitlab_syncs/{gitlab_sync_id}/export | Export from Phrase to GitLab
+*Phrase::GitLabSyncApi* | [**gitlab_sync_history**](docs/GitLabSyncApi.md#gitlab_sync_history) | **GET** /gitlab_syncs/{gitlab_sync_id}/history | History of single Sync Setting
+*Phrase::GitLabSyncApi* | [**gitlab_sync_import**](docs/GitLabSyncApi.md#gitlab_sync_import) | **POST** /gitlab_syncs/{gitlab_sync_id}/import | Import from GitLab to Phrase
+*Phrase::GitLabSyncApi* | [**gitlab_sync_list**](docs/GitLabSyncApi.md#gitlab_sync_list) | **GET** /gitlab_syncs | List GitLab syncs
+*Phrase::GitLabSyncApi* | [**gitlab_sync_show**](docs/GitLabSyncApi.md#gitlab_sync_show) | **GET** /gitlab_syncs/{id} | Get single Sync Setting
+*Phrase::GitLabSyncApi* | [**gitlab_sync_update**](docs/GitLabSyncApi.md#gitlab_sync_update) | **PUT** /gitlab_syncs/{id} | Update single Sync Setting
+*Phrase::GlossariesApi* | [**glossaries_list**](docs/GlossariesApi.md#glossaries_list) | **GET** /accounts/{account_id}/glossaries | List glossaries
+*Phrase::GlossariesApi* | [**glossary_create**](docs/GlossariesApi.md#glossary_create) | **POST** /accounts/{account_id}/glossaries | Create a glossary
+*Phrase::GlossariesApi* | [**glossary_delete**](docs/GlossariesApi.md#glossary_delete) | **DELETE** /accounts/{account_id}/glossaries/{id} | Delete a glossary
+*Phrase::GlossariesApi* | [**glossary_show**](docs/GlossariesApi.md#glossary_show) | **GET** /accounts/{account_id}/glossaries/{id} | Get a single glossary
+*Phrase::GlossariesApi* | [**glossary_update**](docs/GlossariesApi.md#glossary_update) | **PATCH** /accounts/{account_id}/glossaries/{id} | Update a glossary
+*Phrase::GlossaryTermTranslationsApi* | [**glossary_term_translation_create**](docs/GlossaryTermTranslationsApi.md#glossary_term_translation_create) | **POST** /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations | Create a glossary term translation
+*Phrase::GlossaryTermTranslationsApi* | [**glossary_term_translation_delete**](docs/GlossaryTermTranslationsApi.md#glossary_term_translation_delete) | **DELETE** /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id} | Delete a glossary term translation
+*Phrase::GlossaryTermTranslationsApi* | [**glossary_term_translation_update**](docs/GlossaryTermTranslationsApi.md#glossary_term_translation_update) | **PATCH** /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id} | Update a glossary term translation
+*Phrase::GlossaryTermsApi* | [**glossary_term_create**](docs/GlossaryTermsApi.md#glossary_term_create) | **POST** /accounts/{account_id}/glossaries/{glossary_id}/terms | Create a glossary term
+*Phrase::GlossaryTermsApi* | [**glossary_term_delete**](docs/GlossaryTermsApi.md#glossary_term_delete) | **DELETE** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Delete a glossary term
+*Phrase::GlossaryTermsApi* | [**glossary_term_show**](docs/GlossaryTermsApi.md#glossary_term_show) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Get a single glossary term
+*Phrase::GlossaryTermsApi* | [**glossary_term_update**](docs/GlossaryTermsApi.md#glossary_term_update) | **PATCH** /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} | Update a glossary term
+*Phrase::GlossaryTermsApi* | [**glossary_terms_list**](docs/GlossaryTermsApi.md#glossary_terms_list) | **GET** /accounts/{account_id}/glossaries/{glossary_id}/terms | List glossary terms
+*Phrase::InvitationsApi* | [**invitation_create**](docs/InvitationsApi.md#invitation_create) | **POST** /accounts/{account_id}/invitations | Create a new invitation
+*Phrase::InvitationsApi* | [**invitation_delete**](docs/InvitationsApi.md#invitation_delete) | **DELETE** /accounts/{account_id}/invitations/{id} | Delete an invitation
+*Phrase::InvitationsApi* | [**invitation_resend**](docs/InvitationsApi.md#invitation_resend) | **POST** /accounts/{account_id}/invitations/{id}/resend | Resend an invitation
+*Phrase::InvitationsApi* | [**invitation_show**](docs/InvitationsApi.md#invitation_show) | **GET** /accounts/{account_id}/invitations/{id} | Get a single invitation
+*Phrase::InvitationsApi* | [**invitation_update**](docs/InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
+*Phrase::InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
+*Phrase::JobLocalesApi* | [**job_locale_complete**](docs/JobLocalesApi.md#job_locale_complete) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete | Complete a job locale
+*Phrase::JobLocalesApi* | [**job_locale_delete**](docs/JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Delete a job locale
+*Phrase::JobLocalesApi* | [**job_locale_reopen**](docs/JobLocalesApi.md#job_locale_reopen) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen | Reopen a job locale
+*Phrase::JobLocalesApi* | [**job_locale_show**](docs/JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locale/{id} | Get a single job locale
+*Phrase::JobLocalesApi* | [**job_locale_update**](docs/JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job locale
+*Phrase::JobLocalesApi* | [**job_locales_create**](docs/JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales | Create a job locale
+*Phrase::JobLocalesApi* | [**job_locales_list**](docs/JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job locales
+*Phrase::JobsApi* | [**job_complete**](docs/JobsApi.md#job_complete) | **POST** /projects/{project_id}/jobs/{id}/complete | Complete a job
+*Phrase::JobsApi* | [**job_create**](docs/JobsApi.md#job_create) | **POST** /projects/{project_id}/jobs | Create a job
+*Phrase::JobsApi* | [**job_delete**](docs/JobsApi.md#job_delete) | **DELETE** /projects/{project_id}/jobs/{id} | Delete a job
+*Phrase::JobsApi* | [**job_keys_create**](docs/JobsApi.md#job_keys_create) | **POST** /projects/{project_id}/jobs/{id}/keys | Add keys to job
+*Phrase::JobsApi* | [**job_keys_delete**](docs/JobsApi.md#job_keys_delete) | **DELETE** /projects/{project_id}/jobs/{id}/keys | Remove keys from job
+*Phrase::JobsApi* | [**job_reopen**](docs/JobsApi.md#job_reopen) | **POST** /projects/{project_id}/jobs/{id}/reopen | Reopen a job
+*Phrase::JobsApi* | [**job_show**](docs/JobsApi.md#job_show) | **GET** /projects/{project_id}/jobs/{id} | Get a single job
+*Phrase::JobsApi* | [**job_start**](docs/JobsApi.md#job_start) | **POST** /projects/{project_id}/jobs/{id}/start | Start a job
+*Phrase::JobsApi* | [**job_update**](docs/JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
+*Phrase::JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
+*Phrase::KeysApi* | [**key_create**](docs/KeysApi.md#key_create) | **POST** /projects/{project_id}/keys | Create a key
+*Phrase::KeysApi* | [**key_delete**](docs/KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
+*Phrase::KeysApi* | [**key_show**](docs/KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
+*Phrase::KeysApi* | [**key_update**](docs/KeysApi.md#key_update) | **PATCH** /projects/{project_id}/keys/{id} | Update a key
+*Phrase::KeysApi* | [**keys_delete**](docs/KeysApi.md#keys_delete) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
+*Phrase::KeysApi* | [**keys_list**](docs/KeysApi.md#keys_list) | **GET** /projects/{project_id}/keys | List keys
+*Phrase::KeysApi* | [**keys_search**](docs/KeysApi.md#keys_search) | **POST** /projects/{project_id}/keys/search | Search keys
+*Phrase::KeysApi* | [**keys_tag**](docs/KeysApi.md#keys_tag) | **PATCH** /projects/{project_id}/keys/tag | Add tags to collection of keys
+*Phrase::KeysApi* | [**keys_untag**](docs/KeysApi.md#keys_untag) | **PATCH** /projects/{project_id}/keys/untag | Remove tags from collection of keys
+*Phrase::LocalesApi* | [**locale_create**](docs/LocalesApi.md#locale_create) | **POST** /projects/{project_id}/locales | Create a locale
+*Phrase::LocalesApi* | [**locale_delete**](docs/LocalesApi.md#locale_delete) | **DELETE** /projects/{project_id}/locales/{id} | Delete a locale
+*Phrase::LocalesApi* | [**locale_download**](docs/LocalesApi.md#locale_download) | **GET** /projects/{project_id}/locales/{id}/download | Download a locale
+*Phrase::LocalesApi* | [**locale_show**](docs/LocalesApi.md#locale_show) | **GET** /projects/{project_id}/locales/{id} | Get a single locale
+*Phrase::LocalesApi* | [**locale_update**](docs/LocalesApi.md#locale_update) | **PATCH** /projects/{project_id}/locales/{id} | Update a locale
+*Phrase::LocalesApi* | [**locales_list**](docs/LocalesApi.md#locales_list) | **GET** /projects/{project_id}/locales | List locales
+*Phrase::MembersApi* | [**member_delete**](docs/MembersApi.md#member_delete) | **DELETE** /accounts/{account_id}/members/{id} | Remove a user from the account
+*Phrase::MembersApi* | [**member_show**](docs/MembersApi.md#member_show) | **GET** /accounts/{account_id}/members/{id} | Get single member
+*Phrase::MembersApi* | [**member_update**](docs/MembersApi.md#member_update) | **PATCH** /accounts/{account_id}/members/{id} | Update a member
+*Phrase::MembersApi* | [**members_list**](docs/MembersApi.md#members_list) | **GET** /accounts/{account_id}/members | List members
+*Phrase::OrdersApi* | [**order_confirm**](docs/OrdersApi.md#order_confirm) | **PATCH** /projects/{project_id}/orders/{id}/confirm | Confirm an order
+*Phrase::OrdersApi* | [**order_create**](docs/OrdersApi.md#order_create) | **POST** /projects/{project_id}/orders | Create a new order
+*Phrase::OrdersApi* | [**order_delete**](docs/OrdersApi.md#order_delete) | **DELETE** /projects/{project_id}/orders/{id} | Cancel an order
+*Phrase::OrdersApi* | [**order_show**](docs/OrdersApi.md#order_show) | **GET** /projects/{project_id}/orders/{id} | Get a single order
+*Phrase::OrdersApi* | [**orders_list**](docs/OrdersApi.md#orders_list) | **GET** /projects/{project_id}/orders | List orders
+*Phrase::ProjectsApi* | [**project_create**](docs/ProjectsApi.md#project_create) | **POST** /projects | Create a project
+*Phrase::ProjectsApi* | [**project_delete**](docs/ProjectsApi.md#project_delete) | **DELETE** /projects/{id} | Delete a project
+*Phrase::ProjectsApi* | [**project_show**](docs/ProjectsApi.md#project_show) | **GET** /projects/{id} | Get a single project
+*Phrase::ProjectsApi* | [**project_update**](docs/ProjectsApi.md#project_update) | **PATCH** /projects/{id} | Update a project
+*Phrase::ProjectsApi* | [**projects_list**](docs/ProjectsApi.md#projects_list) | **GET** /projects | List projects
+*Phrase::ReleasesApi* | [**release_create**](docs/ReleasesApi.md#release_create) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases | Create a release
+*Phrase::ReleasesApi* | [**release_delete**](docs/ReleasesApi.md#release_delete) | **DELETE** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Delete a release
+*Phrase::ReleasesApi* | [**release_publish**](docs/ReleasesApi.md#release_publish) | **POST** /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish | Publish a release
+*Phrase::ReleasesApi* | [**release_show**](docs/ReleasesApi.md#release_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Get a single release
+*Phrase::ReleasesApi* | [**release_update**](docs/ReleasesApi.md#release_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Update a release
+*Phrase::ReleasesApi* | [**releases_list**](docs/ReleasesApi.md#releases_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases | List releases
+*Phrase::ScreenshotMarkersApi* | [**screenshot_marker_create**](docs/ScreenshotMarkersApi.md#screenshot_marker_create) | **POST** /projects/{project_id}/screenshots/{screenshot_id}/markers | Create a screenshot marker
+*Phrase::ScreenshotMarkersApi* | [**screenshot_marker_delete**](docs/ScreenshotMarkersApi.md#screenshot_marker_delete) | **DELETE** /projects/{project_id}/screenshots/{screenshot_id}/markers | Delete a screenshot marker
+*Phrase::ScreenshotMarkersApi* | [**screenshot_marker_show**](docs/ScreenshotMarkersApi.md#screenshot_marker_show) | **GET** /projects/{project_id}/screenshots/{screenshot_id}/markers/{id} | Get a single screenshot marker
+*Phrase::ScreenshotMarkersApi* | [**screenshot_marker_update**](docs/ScreenshotMarkersApi.md#screenshot_marker_update) | **PATCH** /projects/{project_id}/screenshots/{screenshot_id}/markers | Update a screenshot marker
+*Phrase::ScreenshotMarkersApi* | [**screenshot_markers_list**](docs/ScreenshotMarkersApi.md#screenshot_markers_list) | **GET** /projects/{project_id}/screenshots/{id}/markers | List screenshot markers
+*Phrase::ScreenshotsApi* | [**screenshot_create**](docs/ScreenshotsApi.md#screenshot_create) | **POST** /projects/{project_id}/screenshots | Create a screenshot
+*Phrase::ScreenshotsApi* | [**screenshot_delete**](docs/ScreenshotsApi.md#screenshot_delete) | **DELETE** /projects/{project_id}/screenshots/{id} | Delete a screenshot
+*Phrase::ScreenshotsApi* | [**screenshot_show**](docs/ScreenshotsApi.md#screenshot_show) | **GET** /projects/{project_id}/screenshots/{id} | Get a single screenshot
+*Phrase::ScreenshotsApi* | [**screenshot_update**](docs/ScreenshotsApi.md#screenshot_update) | **PATCH** /projects/{project_id}/screenshots/{id} | Update a screenshot
+*Phrase::ScreenshotsApi* | [**screenshots_list**](docs/ScreenshotsApi.md#screenshots_list) | **GET** /projects/{project_id}/screenshots | List screenshots
+*Phrase::SpacesApi* | [**space_create**](docs/SpacesApi.md#space_create) | **POST** /accounts/{account_id}/spaces | Create a Space
+*Phrase::SpacesApi* | [**space_delete**](docs/SpacesApi.md#space_delete) | **DELETE** /accounts/{account_id}/spaces/{id} | Delete Space
+*Phrase::SpacesApi* | [**space_show**](docs/SpacesApi.md#space_show) | **GET** /accounts/{account_id}/spaces/{id} | Get Space
+*Phrase::SpacesApi* | [**space_update**](docs/SpacesApi.md#space_update) | **PATCH** /accounts/{account_id}/spaces/{id} | Update Space
+*Phrase::SpacesApi* | [**spaces_list**](docs/SpacesApi.md#spaces_list) | **GET** /accounts/{account_id}/spaces | List Spaces
+*Phrase::SpacesApi* | [**spaces_projects_create**](docs/SpacesApi.md#spaces_projects_create) | **POST** /accounts/{account_id}/spaces/{space_id}/projects | Add Project
+*Phrase::SpacesApi* | [**spaces_projects_delete**](docs/SpacesApi.md#spaces_projects_delete) | **DELETE** /accounts/{account_id}/spaces/{space_id}/projects/{id} | Remove Project
+*Phrase::SpacesApi* | [**spaces_projects_list**](docs/SpacesApi.md#spaces_projects_list) | **GET** /accounts/{account_id}/spaces/{space_id}/projects | List Projects
+*Phrase::StyleGuidesApi* | [**styleguide_create**](docs/StyleGuidesApi.md#styleguide_create) | **POST** /projects/{project_id}/styleguides | Create a style guide
+*Phrase::StyleGuidesApi* | [**styleguide_delete**](docs/StyleGuidesApi.md#styleguide_delete) | **DELETE** /projects/{project_id}/styleguides/{id} | Delete a style guide
+*Phrase::StyleGuidesApi* | [**styleguide_show**](docs/StyleGuidesApi.md#styleguide_show) | **GET** /projects/{project_id}/styleguides/{id} | Get a single style guide
+*Phrase::StyleGuidesApi* | [**styleguide_update**](docs/StyleGuidesApi.md#styleguide_update) | **PATCH** /projects/{project_id}/styleguides/{id} | Update a style guide
+*Phrase::StyleGuidesApi* | [**styleguides_list**](docs/StyleGuidesApi.md#styleguides_list) | **GET** /projects/{project_id}/styleguides | List style guides
+*Phrase::TagsApi* | [**tag_create**](docs/TagsApi.md#tag_create) | **POST** /projects/{project_id}/tags | Create a tag
+*Phrase::TagsApi* | [**tag_delete**](docs/TagsApi.md#tag_delete) | **DELETE** /projects/{project_id}/tags/{name} | Delete a tag
+*Phrase::TagsApi* | [**tag_show**](docs/TagsApi.md#tag_show) | **GET** /projects/{project_id}/tags/{name} | Get a single tag
+*Phrase::TagsApi* | [**tags_list**](docs/TagsApi.md#tags_list) | **GET** /projects/{project_id}/tags | List tags
+*Phrase::TeamsApi* | [**team_create**](docs/TeamsApi.md#team_create) | **POST** /accounts/{account_id}/teams | Create a Team
+*Phrase::TeamsApi* | [**team_delete**](docs/TeamsApi.md#team_delete) | **DELETE** /accounts/{account_id}/teams/{team_id} | Delete Team
+*Phrase::TeamsApi* | [**team_show**](docs/TeamsApi.md#team_show) | **GET** /accounts/{account_id}/teams/{team_id} | Get Team
+*Phrase::TeamsApi* | [**team_update**](docs/TeamsApi.md#team_update) | **PATCH** /accounts/{account_id}/teams/{team_id} | Update Team
+*Phrase::TeamsApi* | [**teams_list**](docs/TeamsApi.md#teams_list) | **GET** /accounts/{account_id}/teams | List Teams
+*Phrase::TeamsApi* | [**teams_projects_create**](docs/TeamsApi.md#teams_projects_create) | **POST** /accounts/{account_id}/teams/{team_id}/projects | Add Project
+*Phrase::TeamsApi* | [**teams_projects_delete**](docs/TeamsApi.md#teams_projects_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/projects/{id} | Remove Project
+*Phrase::TeamsApi* | [**teams_spaces_create**](docs/TeamsApi.md#teams_spaces_create) | **POST** /accounts/{account_id}/teams/{team_id}/spaces | Add Space
+*Phrase::TeamsApi* | [**teams_spaces_delete**](docs/TeamsApi.md#teams_spaces_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/spaces/{id} | Remove Space
+*Phrase::TeamsApi* | [**teams_users_create**](docs/TeamsApi.md#teams_users_create) | **POST** /accounts/{account_id}/teams/{team_id}/users | Add User
+*Phrase::TeamsApi* | [**teams_users_delete**](docs/TeamsApi.md#teams_users_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/users/{id} | Remove User
+*Phrase::TranslationsApi* | [**translation_create**](docs/TranslationsApi.md#translation_create) | **POST** /projects/{project_id}/translations | Create a translation
+*Phrase::TranslationsApi* | [**translation_exclude**](docs/TranslationsApi.md#translation_exclude) | **PATCH** /projects/{project_id}/translations/{id}/exclude | Exclude a translation from export
+*Phrase::TranslationsApi* | [**translation_include**](docs/TranslationsApi.md#translation_include) | **PATCH** /projects/{project_id}/translations/{id}/include | Revoke exclusion of a translation in export
+*Phrase::TranslationsApi* | [**translation_review**](docs/TranslationsApi.md#translation_review) | **PATCH** /projects/{project_id}/translations/{id}/review | Review a translation
+*Phrase::TranslationsApi* | [**translation_show**](docs/TranslationsApi.md#translation_show) | **GET** /projects/{project_id}/translations/{id} | Get a single translation
+*Phrase::TranslationsApi* | [**translation_unverify**](docs/TranslationsApi.md#translation_unverify) | **PATCH** /projects/{project_id}/translations/{id}/unverify | Mark a translation as unverified
+*Phrase::TranslationsApi* | [**translation_update**](docs/TranslationsApi.md#translation_update) | **PATCH** /projects/{project_id}/translations/{id} | Update a translation
+*Phrase::TranslationsApi* | [**translation_verify**](docs/TranslationsApi.md#translation_verify) | **PATCH** /projects/{project_id}/translations/{id}/verify | Verify a translation
+*Phrase::TranslationsApi* | [**translations_by_key**](docs/TranslationsApi.md#translations_by_key) | **GET** /projects/{project_id}/keys/{key_id}/translations | List translations by key
+*Phrase::TranslationsApi* | [**translations_by_locale**](docs/TranslationsApi.md#translations_by_locale) | **GET** /projects/{project_id}/locales/{locale_id}/translations | List translations by locale
+*Phrase::TranslationsApi* | [**translations_exclude**](docs/TranslationsApi.md#translations_exclude) | **PATCH** /projects/{project_id}/translations/exclude | Set exclude from export flag on translations selected by query
+*Phrase::TranslationsApi* | [**translations_include**](docs/TranslationsApi.md#translations_include) | **PATCH** /projects/{project_id}/translations/include | Remove exlude from import flag from translations selected by query
+*Phrase::TranslationsApi* | [**translations_list**](docs/TranslationsApi.md#translations_list) | **GET** /projects/{project_id}/translations | List all translations
+*Phrase::TranslationsApi* | [**translations_review**](docs/TranslationsApi.md#translations_review) | **PATCH** /projects/{project_id}/translations/review | Review translations selected by query
+*Phrase::TranslationsApi* | [**translations_search**](docs/TranslationsApi.md#translations_search) | **POST** /projects/{project_id}/translations/search | Search translations
+*Phrase::TranslationsApi* | [**translations_unverify**](docs/TranslationsApi.md#translations_unverify) | **PATCH** /projects/{project_id}/translations/unverify | Mark translations selected by query as unverified
+*Phrase::TranslationsApi* | [**translations_verify**](docs/TranslationsApi.md#translations_verify) | **PATCH** /projects/{project_id}/translations/verify | Verify translations selected by query
+*Phrase::UploadsApi* | [**upload_create**](docs/UploadsApi.md#upload_create) | **POST** /projects/{project_id}/uploads | Upload a new file
+*Phrase::UploadsApi* | [**upload_show**](docs/UploadsApi.md#upload_show) | **GET** /projects/{project_id}/uploads/{id} | View upload details
+*Phrase::UploadsApi* | [**uploads_list**](docs/UploadsApi.md#uploads_list) | **GET** /projects/{project_id}/uploads | List uploads
+*Phrase::UsersApi* | [**show_user**](docs/UsersApi.md#show_user) | **GET** /user | Show current User
+*Phrase::VersionsHistoryApi* | [**version_show**](docs/VersionsHistoryApi.md#version_show) | **GET** /projects/{project_id}/translations/{translation_id}/versions/{id} | Get a single version
+*Phrase::VersionsHistoryApi* | [**versions_list**](docs/VersionsHistoryApi.md#versions_list) | **GET** /projects/{project_id}/translations/{translation_id}/versions | List all versions
+*Phrase::WebhooksApi* | [**webhook_create**](docs/WebhooksApi.md#webhook_create) | **POST** /projects/{project_id}/webhooks | Create a webhook
+*Phrase::WebhooksApi* | [**webhook_delete**](docs/WebhooksApi.md#webhook_delete) | **DELETE** /projects/{project_id}/webhooks/{id} | Delete a webhook
+*Phrase::WebhooksApi* | [**webhook_show**](docs/WebhooksApi.md#webhook_show) | **GET** /projects/{project_id}/webhooks/{id} | Get a single webhook
+*Phrase::WebhooksApi* | [**webhook_test**](docs/WebhooksApi.md#webhook_test) | **POST** /projects/{project_id}/webhooks/{id}/test | Test a webhook
+*Phrase::WebhooksApi* | [**webhook_update**](docs/WebhooksApi.md#webhook_update) | **PATCH** /projects/{project_id}/webhooks/{id} | Update a webhook
+*Phrase::WebhooksApi* | [**webhooks_list**](docs/WebhooksApi.md#webhooks_list) | **GET** /projects/{project_id}/webhooks | List webhooks
+
+
+## Documentation for Models
+
+ - [Phrase::Account](docs/Account.md)
+ - [Phrase::AccountDetails](docs/AccountDetails.md)
+ - [Phrase::AccountDetails1](docs/AccountDetails1.md)
+ - [Phrase::AffectedCount](docs/AffectedCount.md)
+ - [Phrase::AffectedResources](docs/AffectedResources.md)
+ - [Phrase::Authorization](docs/Authorization.md)
+ - [Phrase::AuthorizationCreateParameters](docs/AuthorizationCreateParameters.md)
+ - [Phrase::AuthorizationUpdateParameters](docs/AuthorizationUpdateParameters.md)
+ - [Phrase::AuthorizationWithToken](docs/AuthorizationWithToken.md)
+ - [Phrase::AuthorizationWithToken1](docs/AuthorizationWithToken1.md)
+ - [Phrase::BitbucketSync](docs/BitbucketSync.md)
+ - [Phrase::BitbucketSyncExportParameters](docs/BitbucketSyncExportParameters.md)
+ - [Phrase::BitbucketSyncExportResponse](docs/BitbucketSyncExportResponse.md)
+ - [Phrase::BitbucketSyncImportParameters](docs/BitbucketSyncImportParameters.md)
+ - [Phrase::BlacklistedKey](docs/BlacklistedKey.md)
+ - [Phrase::BlacklistedKeyCreateParameters](docs/BlacklistedKeyCreateParameters.md)
+ - [Phrase::BlacklistedKeyUpdateParameters](docs/BlacklistedKeyUpdateParameters.md)
+ - [Phrase::Branch](docs/Branch.md)
+ - [Phrase::BranchCreateParameters](docs/BranchCreateParameters.md)
+ - [Phrase::BranchMergeParameters](docs/BranchMergeParameters.md)
+ - [Phrase::BranchUpdateParameters](docs/BranchUpdateParameters.md)
+ - [Phrase::Comment](docs/Comment.md)
+ - [Phrase::CommentCreateParameters](docs/CommentCreateParameters.md)
+ - [Phrase::CommentMarkReadParameters](docs/CommentMarkReadParameters.md)
+ - [Phrase::CommentUpdateParameters](docs/CommentUpdateParameters.md)
+ - [Phrase::Distribution](docs/Distribution.md)
+ - [Phrase::DistributionCreateParameters](docs/DistributionCreateParameters.md)
+ - [Phrase::DistributionPreview](docs/DistributionPreview.md)
+ - [Phrase::DistributionUpdateParameters](docs/DistributionUpdateParameters.md)
+ - [Phrase::Document](docs/Document.md)
+ - [Phrase::Format](docs/Format.md)
+ - [Phrase::GithubSyncExportParameters](docs/GithubSyncExportParameters.md)
+ - [Phrase::GithubSyncImportParameters](docs/GithubSyncImportParameters.md)
+ - [Phrase::GitlabSync](docs/GitlabSync.md)
+ - [Phrase::GitlabSyncExport](docs/GitlabSyncExport.md)
+ - [Phrase::GitlabSyncExportParameters](docs/GitlabSyncExportParameters.md)
+ - [Phrase::GitlabSyncHistory](docs/GitlabSyncHistory.md)
+ - [Phrase::GitlabSyncImportParameters](docs/GitlabSyncImportParameters.md)
+ - [Phrase::Glossary](docs/Glossary.md)
+ - [Phrase::GlossaryCreateParameters](docs/GlossaryCreateParameters.md)
+ - [Phrase::GlossaryTerm](docs/GlossaryTerm.md)
+ - [Phrase::GlossaryTermCreateParameters](docs/GlossaryTermCreateParameters.md)
+ - [Phrase::GlossaryTermTranslation](docs/GlossaryTermTranslation.md)
+ - [Phrase::GlossaryTermTranslationCreateParameters](docs/GlossaryTermTranslationCreateParameters.md)
+ - [Phrase::GlossaryTermTranslationUpdateParameters](docs/GlossaryTermTranslationUpdateParameters.md)
+ - [Phrase::GlossaryTermUpdateParameters](docs/GlossaryTermUpdateParameters.md)
+ - [Phrase::GlossaryUpdateParameters](docs/GlossaryUpdateParameters.md)
+ - [Phrase::InlineResponse422](docs/InlineResponse422.md)
+ - [Phrase::InlineResponse422Errors](docs/InlineResponse422Errors.md)
+ - [Phrase::Invitation](docs/Invitation.md)
+ - [Phrase::InvitationCreateParameters](docs/InvitationCreateParameters.md)
+ - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
+ - [Phrase::Job](docs/Job.md)
+ - [Phrase::JobCompleteParameters](docs/JobCompleteParameters.md)
+ - [Phrase::JobCreateParameters](docs/JobCreateParameters.md)
+ - [Phrase::JobDetails](docs/JobDetails.md)
+ - [Phrase::JobDetails1](docs/JobDetails1.md)
+ - [Phrase::JobKeysCreateParameters](docs/JobKeysCreateParameters.md)
+ - [Phrase::JobLocale](docs/JobLocale.md)
+ - [Phrase::JobLocaleCompleteParameters](docs/JobLocaleCompleteParameters.md)
+ - [Phrase::JobLocaleReopenParameters](docs/JobLocaleReopenParameters.md)
+ - [Phrase::JobLocaleUpdateParameters](docs/JobLocaleUpdateParameters.md)
+ - [Phrase::JobLocalesCreateParameters](docs/JobLocalesCreateParameters.md)
+ - [Phrase::JobPreview](docs/JobPreview.md)
+ - [Phrase::JobReopenParameters](docs/JobReopenParameters.md)
+ - [Phrase::JobStartParameters](docs/JobStartParameters.md)
+ - [Phrase::JobUpdateParameters](docs/JobUpdateParameters.md)
+ - [Phrase::KeyCreateParameters](docs/KeyCreateParameters.md)
+ - [Phrase::KeyPreview](docs/KeyPreview.md)
+ - [Phrase::KeyUpdateParameters](docs/KeyUpdateParameters.md)
+ - [Phrase::KeysSearchParameters](docs/KeysSearchParameters.md)
+ - [Phrase::KeysTagParameters](docs/KeysTagParameters.md)
+ - [Phrase::KeysUntagParameters](docs/KeysUntagParameters.md)
+ - [Phrase::Locale](docs/Locale.md)
+ - [Phrase::LocaleCreateParameters](docs/LocaleCreateParameters.md)
+ - [Phrase::LocaleDetails](docs/LocaleDetails.md)
+ - [Phrase::LocaleDetails1](docs/LocaleDetails1.md)
+ - [Phrase::LocalePreview](docs/LocalePreview.md)
+ - [Phrase::LocaleStatistics](docs/LocaleStatistics.md)
+ - [Phrase::LocaleUpdateParameters](docs/LocaleUpdateParameters.md)
+ - [Phrase::Member](docs/Member.md)
+ - [Phrase::MemberUpdateParameters](docs/MemberUpdateParameters.md)
+ - [Phrase::OrderConfirmParameters](docs/OrderConfirmParameters.md)
+ - [Phrase::OrderCreateParameters](docs/OrderCreateParameters.md)
+ - [Phrase::Project](docs/Project.md)
+ - [Phrase::ProjectCreateParameters](docs/ProjectCreateParameters.md)
+ - [Phrase::ProjectDetails](docs/ProjectDetails.md)
+ - [Phrase::ProjectDetails1](docs/ProjectDetails1.md)
+ - [Phrase::ProjectLocales](docs/ProjectLocales.md)
+ - [Phrase::ProjectLocales1](docs/ProjectLocales1.md)
+ - [Phrase::ProjectShort](docs/ProjectShort.md)
+ - [Phrase::ProjectUpdateParameters](docs/ProjectUpdateParameters.md)
+ - [Phrase::Release](docs/Release.md)
+ - [Phrase::ReleaseCreateParameters](docs/ReleaseCreateParameters.md)
+ - [Phrase::ReleasePreview](docs/ReleasePreview.md)
+ - [Phrase::ReleaseUpdateParameters](docs/ReleaseUpdateParameters.md)
+ - [Phrase::Screenshot](docs/Screenshot.md)
+ - [Phrase::ScreenshotCreateParameters](docs/ScreenshotCreateParameters.md)
+ - [Phrase::ScreenshotMarker](docs/ScreenshotMarker.md)
+ - [Phrase::ScreenshotMarkerCreateParameters](docs/ScreenshotMarkerCreateParameters.md)
+ - [Phrase::ScreenshotMarkerUpdateParameters](docs/ScreenshotMarkerUpdateParameters.md)
+ - [Phrase::ScreenshotUpdateParameters](docs/ScreenshotUpdateParameters.md)
+ - [Phrase::Space](docs/Space.md)
+ - [Phrase::SpaceCreateParameters](docs/SpaceCreateParameters.md)
+ - [Phrase::SpaceUpdateParameters](docs/SpaceUpdateParameters.md)
+ - [Phrase::SpacesProjectsCreateParameters](docs/SpacesProjectsCreateParameters.md)
+ - [Phrase::Styleguide](docs/Styleguide.md)
+ - [Phrase::StyleguideCreateParameters](docs/StyleguideCreateParameters.md)
+ - [Phrase::StyleguideDetails](docs/StyleguideDetails.md)
+ - [Phrase::StyleguideDetails1](docs/StyleguideDetails1.md)
+ - [Phrase::StyleguidePreview](docs/StyleguidePreview.md)
+ - [Phrase::StyleguideUpdateParameters](docs/StyleguideUpdateParameters.md)
+ - [Phrase::Tag](docs/Tag.md)
+ - [Phrase::TagCreateParameters](docs/TagCreateParameters.md)
+ - [Phrase::TagWithStats](docs/TagWithStats.md)
+ - [Phrase::TagWithStats1](docs/TagWithStats1.md)
+ - [Phrase::TagWithStats1Statistics](docs/TagWithStats1Statistics.md)
+ - [Phrase::TagWithStats1Statistics1](docs/TagWithStats1Statistics1.md)
+ - [Phrase::Team](docs/Team.md)
+ - [Phrase::TeamCreateParameters](docs/TeamCreateParameters.md)
+ - [Phrase::TeamDetail](docs/TeamDetail.md)
+ - [Phrase::TeamUpdateParameters](docs/TeamUpdateParameters.md)
+ - [Phrase::TeamsProjectsCreateParameters](docs/TeamsProjectsCreateParameters.md)
+ - [Phrase::TeamsSpacesCreateParameters](docs/TeamsSpacesCreateParameters.md)
+ - [Phrase::TeamsUsersCreateParameters](docs/TeamsUsersCreateParameters.md)
+ - [Phrase::Translation](docs/Translation.md)
+ - [Phrase::TranslationCreateParameters](docs/TranslationCreateParameters.md)
+ - [Phrase::TranslationDetails](docs/TranslationDetails.md)
+ - [Phrase::TranslationDetails1](docs/TranslationDetails1.md)
+ - [Phrase::TranslationExcludeParameters](docs/TranslationExcludeParameters.md)
+ - [Phrase::TranslationIncludeParameters](docs/TranslationIncludeParameters.md)
+ - [Phrase::TranslationKey](docs/TranslationKey.md)
+ - [Phrase::TranslationKeyDetails](docs/TranslationKeyDetails.md)
+ - [Phrase::TranslationKeyDetails1](docs/TranslationKeyDetails1.md)
+ - [Phrase::TranslationOrder](docs/TranslationOrder.md)
+ - [Phrase::TranslationReviewParameters](docs/TranslationReviewParameters.md)
+ - [Phrase::TranslationUnverifyParameters](docs/TranslationUnverifyParameters.md)
+ - [Phrase::TranslationUpdateParameters](docs/TranslationUpdateParameters.md)
+ - [Phrase::TranslationVerifyParameters](docs/TranslationVerifyParameters.md)
+ - [Phrase::TranslationVersion](docs/TranslationVersion.md)
+ - [Phrase::TranslationVersionWithUser](docs/TranslationVersionWithUser.md)
+ - [Phrase::TranslationVersionWithUser1](docs/TranslationVersionWithUser1.md)
+ - [Phrase::TranslationsExcludeParameters](docs/TranslationsExcludeParameters.md)
+ - [Phrase::TranslationsIncludeParameters](docs/TranslationsIncludeParameters.md)
+ - [Phrase::TranslationsReviewParameters](docs/TranslationsReviewParameters.md)
+ - [Phrase::TranslationsSearchParameters](docs/TranslationsSearchParameters.md)
+ - [Phrase::TranslationsUnverifyParameters](docs/TranslationsUnverifyParameters.md)
+ - [Phrase::TranslationsVerifyParameters](docs/TranslationsVerifyParameters.md)
+ - [Phrase::Upload](docs/Upload.md)
+ - [Phrase::UploadCreateParameters](docs/UploadCreateParameters.md)
+ - [Phrase::UploadSummary](docs/UploadSummary.md)
+ - [Phrase::User](docs/User.md)
+ - [Phrase::UserPreview](docs/UserPreview.md)
+ - [Phrase::Webhook](docs/Webhook.md)
+ - [Phrase::WebhookCreateParameters](docs/WebhookCreateParameters.md)
+ - [Phrase::WebhookUpdateParameters](docs/WebhookUpdateParameters.md)
+
+
+## Documentation for Authorization
+
+
+### Basic
+
+- **Type**: HTTP basic authentication
+
+### Token
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
 
-To initialize phrase, your project auth token (secret) is required. You can find the auth token next to the project on [your project overview](https://phraseapp.com/projects).
-
-#### When using Rails
-
-Install phrase by executing the Rails generator:
-
-	bundle exec rails generate phrase:install --auth-token=<YOUR_TOKEN>
-	
-This will:
-
-* create a `phrase.rb` initializer file in `./config/initializers/`
-* initialize your phrase project by creating a default locale in PhraseApp
-* create a `.phrase` configuration file containing the secret
-
-*Using the generator will automatically prepare your Rails application for use with the [In-Context-Editor](https://phraseapp.com/features).*
-
-#### Without Rails
-
-You can use the `phrase init` command to initialize your project:
-
-	phrase init --secret=<YOUR_TOKEN>
-	
-This will:
-
-* initialize your phrase project by creating a default locale in PhraseApp
-* create a `.phrase` configuration file containing the secret
-
-### Pushing Locale Files
-
-Push your localization files to PhraseApp by using the push command:
-
-    phrase push FILE|DIRECTORY
-
-This will push all files found in the given directory or push only the file if the given path points to a file. The path falls back to `./config/locales`, the default localization file path in Ruby on Rails applications.
-
-* `--recursive, -R`
-
-    To push all files in a given directory recursively you can use the `--recursive` parameter:
-
-        phrase push </path/to/file.extension> --recursive
-
-* `--tags`
-
-    Attach one or multiple tags with your file upload. All keys added by the push will be tagged with the specified tags:
-
-        phrase push --tags=foo,bar
-
-* `--locale`
-
-	Some formats do not contain information about their content's locale. These formats (e.g. Java Properties) require you to specify the locale (name) with the push command:
-	
-	    phrase push messages.properties --locale=en
-
-* `--format`
-
-	Specify the format of the files you want to push. We usually try to guess it by evaluating the file name but sometimes you need to tell us more:
-	
-	    phrase push messages.json --format=simple_json
-	
-	For a full list of all supported formats check our [format guide](https://phraseapp.com/docs/format-guide/overview).
-	
-* `--force-update-translations`
-
-	When pushing files to PhraseApp, we only add new resources (keys and translations) by default. Use this flag if you want to override existing translations as well. 
-	
-	    phrase push most-recent.yml --force-update-translations
-	
-	Please note that we do not delete resources from your project even when using this option. Still you have to make sure that your file contains the most recent translations since all translations in your project will be updated with the file content!
-
-* `--skip-unverification`
-
-	When using the `--force-update-translations` flag (see above) we will automatically unverify updated translations if configured in your workflow. Use this flag to prevent all translations being unverified. This option is great if you have copy&replaced strings in your file and just want to update all translations:
-	
-	    phrase push most-recent.yml --force-update-translations --skip-unverification
-
-* `--skip-upload-tags`
-
-	When you push translations we will automatically attach new keys to an upload tag. To prevent this from happening, you can use this option:
-	
-	    phrase push my-file.yml --skip-upload-tags
-	  
-	This can be very useful if you replace your content very often and do not want to create hundreds of upload-tags.
-	
-* `--convert-emoji`
-
-	When you use Emoji symbols in your locale files (i.e. in iOS Localizable strings files) you can tell us to convert them to more readable symbols:
-	
-	    phrase push Localizable.strings --convert-emoji
-	
-	Please note that you should only use this option if your file definitely contains Emoji symbols since it slows down the upload time quite a bit.
-
-* `--secret`
-
-	Your project auth token. You can find the auth token in your project overview or project settings form. This will fall back to the token stored in your `.phrase` config file.
-
-### Pulling Locale files
-
-Pull your most recent locale files by using the `pull` command:
-
-    phrase pull
-
-This will pull localization files for all of your locales available in the current project. Files are by default stored at `./phrase/locales` in YAML format.
-
-* `--format`
-
-	Specify the format you want to download your files in:
-	
-	    phrase pull en --format=simple_json
-	
-	For a full list of all supported formats check our [format guide](https://phraseapp.com/docs/format-guide/overview).
-
-* `--target`
-
-	Specify where you want to download the files to:
-	
-	    phrase pull fr --target="./config/locales"
-		
-	By default, files will be downloaded to `./phrase/locales`.
-	
-* `--tag`
-	
-	Limit results to a given tag instead of downloading all translations:
-	
-	    phrase pull de --tag=feature-messenger-v2
-	  
-* `--updated-since`
-
-	Limit results to translations being updated after the given date and time (UTC) in the format `YYYYMMDDHHMMSS`:
-	
-	    phrase pull en --updated-since=20140601123000
-
-* `--include-empty-translations`
-
-	By default we will only return translated keys in the file. Use this flag to include empty translations as well:
-	
-	    phrase pull en --include-empty-translations
-
-* `--convert-emoji`
-
-	When you use Emoji symbols in your translations you can tell us to convert them back to correctly encoded symbols:
-	
-	    phrase pull --convert-emoji
-	
-	Please note that you should only use this option if your translations definitely contains Emojis since it slows down the download time a bit.
-
-* `--encoding`
-	
-	Set the encoding for your localization files to UTF-8, UTF-16 or Latin-1. 
-
-	    phrase pull --encoding=UTF-8
-
-	Please note that the encodings only work for a handful of formats like IOS .strings or Java .properties. The default will be UTF-8. If none is provided the default encoding of the formats is used.
-
-* `--skip-unverified-translations`
-	
-	By default all translations are downloaded. Use this flag to skip all unverified translations.
-
-	    phrase pull --skip-unverified-translations
-
-
-* `--secret`
-
-	Your project auth token. You can find the auth token in your project overview or project settings form. This will fall back to the token stored in your `.phrase` config file.
-	
-### Advanced configuration
-
-The `phrase init` command allows several advanced configuration options to further customize the setup:
-
-* `--default-locale`
-
-	You can specify a locale that should be used as the default locale when setting up your PhraseApp project (default is `en`).
-	
-	    phrase init --secret=<YOUR_TOKEN> --default-locale=fr
-
-* `--default-format`
-
-	Specify a format that should be used as the default format when downloading files (default is `yml`). For a full list of all supported formats check our [format guide](https://phraseapp.com/docs/format-guide/overview).
-        
-* `--domain`
-
-	Set a domain for use with Gettext translation files (default is `phrase`).
-	
-* `--locale-directory`
-
-	Set the directory that contains your source locales (used by the `phrase push` command). Allows [placeholders](#allowed-placeholders-for-advanced-configuration).
-	
-* `--locale-filename`
-
-	Set the filename for files you download from PhraseApp via `phrase pull`. Allows [placeholders](#allowed-placeholders-for-advanced-configuration).
-	
-* `--default-target`
-
-	Set the target directly to store your localization files retrieved by `phrase pull`. Allows [placeholders](#allowed-placeholders-for-advanced-configuration).
-
-	
-These options will be stored in your `.phrase` config file where you can edit them later on as well.
-
-### Allowed placeholders for advanced configuration
-
-Some advanced configuration options support placeholders. These will be replaced with the actual content. This allows you to create more flexible path and filename settings.
-
-| Placeholder     | Description            | Default |
-| --------------- | ---------------------- | ------- |
-| \<domain\>      | Name of the domain     | phrase  |
-| \<format\>      | Format name/identifier | yml     |
-| \<locale\>      | Locale name            | en      |
-| \<locale.name\> | Locale name            | en      |
-| \<locale.code\> | Locale code            | -       |
-
-For example you can specify a different file name for files you retrieve via the `phrase pull` command:
-
-    phrase init --secret=<YOUR_TOKEN> --locale-filename="<locale.name>.yml"
-
-## Further Information
-* [Read the PhraseApp documentation](https://phraseapp.com/docs)
-* [Get your free PhraseApp trial](https://phraseapp.com/signup)
-* [Get in touch with the engineers](https://phraseapp.com/contact)
-
-## References
-* [PhraseApp In-Context Editor](http://demo.phraseapp.com)
-* [PhraseApp API](https://phraseapp.com/docs/api/overview)
-
-## Partner-Integrations
-* [PhraseApp and Ruby Motion](https://github.com/phrase/motion-phrase)
-* [Heroku Add-on](https://addons.heroku.com/phrase)
-* [Cloudcontrol Add-on](https://phraseapp.com/docs/cloudcontrol/introduction)