phrase 2.5.1 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7172a74587dd0cc07e91bee98a1704f41a00a5cba1a67e188783fbeddad171b
-  data.tar.gz: 75236174eeb3cd53ac3f0680195f3f3551f35d89251a9275a52a95e6ce827f6b
+  metadata.gz: 62ab3ca7c47d1c5c266a466aeda8cc9dac40f0d5330ae3f8be59259a950d858d
+  data.tar.gz: b93dbcdd89d91e22d73b35196aa553e71f7b4f7484fba64d94ffe113d64add3b
 SHA512:
-  metadata.gz: ff69aa4ad7f154d6bae216853b86df2f731fdddaa27fac44512e0ca0f39a4fca7af4539e59d61f2aa5e2ba2d96221411531f0d83348c63c0e0d8e49e69625f9c
-  data.tar.gz: 955a37c3fd96b6eb05edf01bdff0bd803d102a93b5cb7387dd12cbcc1a7e3d57776b07d8c038299fa1c216e4b0c86601689b2ad45ca383967f314d9a331fb474
+  metadata.gz: 361380faae2aa14ce6a3e553dd2babf8d8b393930ad8c37ce7ce6f55be8ae4b9564fe5726034c2d2509ae12fd00ca0855ea3fade7aaad857356992c4e30ba39c
+  data.tar.gz: 785ac620370cb9aef4904f56f7816ce568bec2728d86f553dc1de0ad6140d96dab8f7d4cd34f42fd751895ecb414f228956bbeef456593f089e5143c8987899b

data/README.md

@@ -7,7 +7,7 @@ Phrase is a translation management platform for software projects. You can colla
 ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 2.5.1
+- Package version: 2.7.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./phrase-2.5.1.gem
+gem install ./phrase-2.7.1.gem
 ```
 
-(for development, run `gem install --dev ./phrase-2.5.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./phrase-2.7.1.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -176,6 +176,11 @@ Class | Method | HTTP request | Description
 *Phrase::InvitationsApi* | [**invitation_update**](docs/InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
 *Phrase::InvitationsApi* | [**invitation_update_settings**](docs/InvitationsApi.md#invitation_update_settings) | **PATCH** /projects/{project_id}/invitations/{id} | Update a member's invitation access
 *Phrase::InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
+*Phrase::JobCommentsApi* | [**job_comment_create**](docs/JobCommentsApi.md#job_comment_create) | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
+*Phrase::JobCommentsApi* | [**job_comment_delete**](docs/JobCommentsApi.md#job_comment_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
+*Phrase::JobCommentsApi* | [**job_comment_show**](docs/JobCommentsApi.md#job_comment_show) | **GET** /projects/{project_id}/jobs/{job_id}/comments/{id} | Get a single job comment
+*Phrase::JobCommentsApi* | [**job_comment_update**](docs/JobCommentsApi.md#job_comment_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/comments/{id} | Update a job comment
+*Phrase::JobCommentsApi* | [**job_comments_list**](docs/JobCommentsApi.md#job_comments_list) | **GET** /projects/{project_id}/jobs/{job_id}/comments | List job comments
 *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_complete_review**](docs/JobLocalesApi.md#job_locale_complete_review) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review | Review 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
@@ -199,9 +204,11 @@ Class | Method | HTTP request | Description
 *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_lock**](docs/JobsApi.md#job_lock) | **POST** /projects/{project_id}/jobs/{id}/lock | Lock a 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_unlock**](docs/JobsApi.md#job_unlock) | **POST** /projects/{project_id}/jobs/{id}/unlock | Unlock a job
 *Phrase::JobsApi* | [**job_update**](docs/JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
 *Phrase::JobsApi* | [**jobs_by_account**](docs/JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
 *Phrase::JobsApi* | [**jobs_list**](docs/JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
@@ -386,6 +393,9 @@ Class | Method | HTTP request | Description
  - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
  - [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
  - [Phrase::Job](docs/Job.md)
+ - [Phrase::JobComment](docs/JobComment.md)
+ - [Phrase::JobCommentCreateParameters](docs/JobCommentCreateParameters.md)
+ - [Phrase::JobCommentUpdateParameters](docs/JobCommentUpdateParameters.md)
  - [Phrase::JobCompleteParameters](docs/JobCompleteParameters.md)
  - [Phrase::JobCreateParameters](docs/JobCreateParameters.md)
  - [Phrase::JobDetails](docs/JobDetails.md)
@@ -475,9 +485,9 @@ Class | Method | HTTP request | Description
  - [Phrase::TagWithStats1Statistics](docs/TagWithStats1Statistics.md)
  - [Phrase::TagWithStats1Statistics1](docs/TagWithStats1Statistics1.md)
  - [Phrase::Team](docs/Team.md)
- - [Phrase::Team1](docs/Team1.md)
  - [Phrase::TeamCreateParameters](docs/TeamCreateParameters.md)
  - [Phrase::TeamDetail](docs/TeamDetail.md)
+ - [Phrase::TeamShort](docs/TeamShort.md)
  - [Phrase::TeamUpdateParameters](docs/TeamUpdateParameters.md)
  - [Phrase::TeamsProjectsCreateParameters](docs/TeamsProjectsCreateParameters.md)
  - [Phrase::TeamsSpacesCreateParameters](docs/TeamsSpacesCreateParameters.md)

data/docs/IcuSkeletonParameters.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **content** | **String** | Source content | [optional] 
 **locale_codes** | **Array<String>** | Locale codes | [optional] 
+**keep_content** | **Boolean** | Keep the content and add missing plural forms for each locale | [optional] 
 **zero_form_enabled** | **Boolean** | Indicates whether the zero form should be included or excluded in the returned skeletons | [optional] 
 
 ## Code Sample
@@ -15,6 +16,7 @@ require 'Phrase'
 
 instance = Phrase::IcuSkeletonParameters.new(content: {number, plural, one {One} other {%{n}}},
                                  locale_codes: ["en"],
+                                 keep_content: null,
                                  zero_form_enabled: null)
 ```
 

data/docs/Invitation.md

@@ -10,14 +10,14 @@ Name | Type | Description | Notes
 **state** | **String** |  | [optional] 
 **projects** | [**Array<ProjectShort>**](ProjectShort.md) |  | [optional] 
 **locales** | [**Array<LocalePreview>**](LocalePreview.md) |  | [optional] 
+**teams** | [**Array<TeamShort>**](TeamShort.md) |  | [optional] 
 **default_locale_codes** | **Array<String>** |  | [optional] 
 **permissions** | [**Object**](.md) |  | [optional] 
 **locale_ids** | **Array<String>** |  | [optional] 
 **created_at** | **DateTime** |  | [optional] 
 **updated_at** | **DateTime** |  | [optional] 
 **accepted_at** | **DateTime** |  | [optional] 
-**spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) |  | [optional] 
-**teams** | [**Array<Items>**](Items.md) |  | [optional] 
+**spaces** | [**Array<Space>**](Space.md) |  | [optional] 
 **project_role** | [**Array<MemberProjectDetailProjectRoles>**](MemberProjectDetailProjectRoles.md) |  | [optional] 
 
 ## Code Sample
@@ -31,6 +31,7 @@ instance = Phrase::Invitation.new(id: null,
                                  state: null,
                                  projects: null,
                                  locales: null,
+                                 teams: null,
                                  default_locale_codes: null,
                                  permissions: null,
                                  locale_ids: null,
@@ -38,7 +39,6 @@ instance = Phrase::Invitation.new(id: null,
                                  updated_at: null,
                                  accepted_at: null,
                                  spaces: null,
-                                 teams: null,
                                  project_role: null)
 ```
 

data/docs/JobComment.md

@@ -0,0 +1,29 @@
+# Phrase::JobComment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+**job_id** | **String** |  | [optional] 
+**user** | [**UserPreview**](UserPreview.md) |  | [optional] 
+**created_at** | **DateTime** |  | [optional] 
+**updated_at** | **DateTime** |  | [optional] 
+**mentioned_users** | [**Array<UserPreview>**](UserPreview.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Phrase'
+
+instance = Phrase::JobComment.new(id: null,
+                                 message: null,
+                                 job_id: null,
+                                 user: null,
+                                 created_at: null,
+                                 updated_at: null,
+                                 mentioned_users: null)
+```
+
+

data/docs/JobCommentCreateParameters.md

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

data/docs/JobCommentUpdateParameters.md

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

data/docs/JobCommentsApi.md

@@ -0,0 +1,343 @@
+# Phrase::JobCommentsApi
+
+All URIs are relative to *https://api.phrase.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**job_comment_create**](JobCommentsApi.md#job_comment_create) | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
+[**job_comment_delete**](JobCommentsApi.md#job_comment_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
+[**job_comment_show**](JobCommentsApi.md#job_comment_show) | **GET** /projects/{project_id}/jobs/{job_id}/comments/{id} | Get a single job comment
+[**job_comment_update**](JobCommentsApi.md#job_comment_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/comments/{id} | Update a job comment
+[**job_comments_list**](JobCommentsApi.md#job_comments_list) | **GET** /projects/{project_id}/jobs/{job_id}/comments | List job comments
+
+
+
+## job_comment_create
+
+> JobComment job_comment_create(project_id, job_id, job_comment_create_parameters, opts)
+
+Create a job comment
+
+Create a new comment for a job.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+job_comment_create_parameters = Phrase::JobCommentCreateParameters.new # JobCommentCreateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Create a job comment
+  result = api_instance.job_comment_create(project_id, job_id, job_comment_create_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comment_create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **job_comment_create_parameters** | [**JobCommentCreateParameters**](JobCommentCreateParameters.md)|  | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+
+### Return type
+
+Response<([**JobComment**](JobComment.md))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## job_comment_delete
+
+> job_comment_delete(project_id, job_id, id, opts)
+
+Delete a job comment
+
+Delete an existing job comment.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Delete a job comment
+  api_instance.job_comment_delete(project_id, job_id, id, opts)
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comment_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(nil (empty response body))>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## job_comment_show
+
+> Object job_comment_show(project_id, job_id, id, opts)
+
+Get a single job comment
+
+Get details on a single job comment.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+id = 'id_example' # String | ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #Get a single job comment
+  result = api_instance.job_comment_show(project_id, job_id, id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comment_show: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **id** | **String**| ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(**Object**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## job_comment_update
+
+> Object job_comment_update(project_id, key_id, id, job_comment_update_parameters, opts)
+
+Update a job comment
+
+Update an existing job comment.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+key_id = 'key_id_example' # String | Translation Key ID
+id = 'id_example' # String | ID
+job_comment_update_parameters = Phrase::JobCommentUpdateParameters.new # JobCommentUpdateParameters | 
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
+}
+
+begin
+  #Update a job comment
+  result = api_instance.job_comment_update(project_id, key_id, id, job_comment_update_parameters, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comment_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **key_id** | **String**| Translation Key ID | 
+ **id** | **String**| ID | 
+ **job_comment_update_parameters** | [**JobCommentUpdateParameters**](JobCommentUpdateParameters.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_comments_list
+
+> Array&lt;Object&gt; job_comments_list(project_id, job_id, opts)
+
+List job comments
+
+List all comments for a job.
+
+### Example
+
+```ruby
+# load the gem
+require 'phrase'
+# setup authorization
+Phrase.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key_prefix['Authorization'] = 'token'
+end
+
+api_instance = Phrase::JobCommentsApi.new
+project_id = 'project_id_example' # String | Project ID
+job_id = 'job_id_example' # String | Job ID
+opts = {
+  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
+  branch: 'my-feature-branch' # String | specify the branch to use
+}
+
+begin
+  #List job comments
+  result = api_instance.job_comments_list(project_id, job_id, opts)
+  pp result
+rescue Phrase::ApiError => e
+  puts "Exception when calling JobCommentsApi->job_comments_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project_id** | **String**| Project ID | 
+ **job_id** | **String**| Job ID | 
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] 
+ **branch** | **String**| specify the branch to use | [optional] 
+
+### Return type
+
+Response<(**Array&lt;Object&gt;**)>
+
+### Authorization
+
+[Basic](../README.md#Basic), [Token](../README.md#Token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/JobCreateParameters.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) | [optional] 
 **tags** | **Array<String>** | tags of keys that should be included within the job | [optional] 
 **translation_key_ids** | **Array<String>** | ids of keys that should be included within the job | [optional] 
+**job_template_id** | **String** | id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes. | [optional] 
 
 ## Code Sample
 
@@ -25,7 +26,8 @@ instance = Phrase::JobCreateParameters.new(branch: my-feature-branch,
                                  due_date: null,
                                  ticket_url: https://example.atlassian.net/browse/FOO,
                                  tags: ["myUploadTag"],
-                                 translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"])
+                                 translation_key_ids: ["abcd1234cdef1234abcd1234cdef1234"],
+                                 job_template_id: abcd1234cdef1234abcd1234cdef1234)
 ```