phrase 2.5.1 → 2.7.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -4
  3. data/docs/IcuSkeletonParameters.md +2 -0
  4. data/docs/Invitation.md +3 -3
  5. data/docs/JobComment.md +29 -0
  6. data/docs/JobCommentCreateParameters.md +17 -0
  7. data/docs/JobCommentUpdateParameters.md +17 -0
  8. data/docs/JobCommentsApi.md +343 -0
  9. data/docs/JobCreateParameters.md +3 -1
  10. data/docs/JobsApi.md +130 -0
  11. data/docs/KeyCreateParameters.md +2 -0
  12. data/docs/Member.md +1 -1
  13. data/docs/ScreenshotsApi.md +12 -6
  14. data/docs/StyleguideCreateParameters.md +1 -1
  15. data/docs/StyleguideUpdateParameters.md +1 -1
  16. data/docs/{Team1.md → TeamShort.md} +2 -2
  17. data/lib/phrase/api/job_comments_api.rb +411 -0
  18. data/lib/phrase/api/jobs_api.rb +146 -0
  19. data/lib/phrase/api/screenshots_api.rb +17 -11
  20. data/lib/phrase/models/icu_skeleton_parameters.rb +11 -1
  21. data/lib/phrase/models/invitation.rb +13 -13
  22. data/lib/phrase/models/job_comment.rb +250 -0
  23. data/lib/phrase/models/job_comment_create_parameters.rb +195 -0
  24. data/lib/phrase/models/job_comment_update_parameters.rb +195 -0
  25. data/lib/phrase/models/job_create_parameters.rb +14 -4
  26. data/lib/phrase/models/key_create_parameters.rb +11 -1
  27. data/lib/phrase/models/member.rb +1 -1
  28. data/lib/phrase/models/{team1.rb → team_short.rb} +3 -3
  29. data/lib/phrase/version.rb +1 -1
  30. data/lib/phrase.rb +5 -1
  31. data/spec/api/job_comments_api_spec.rb +101 -0
  32. data/spec/api/jobs_api_spec.rb +30 -0
  33. data/spec/api/screenshots_api_spec.rb +4 -1
  34. data/spec/models/icu_skeleton_parameters_spec.rb +6 -0
  35. data/spec/models/invitation_spec.rb +6 -6
  36. data/spec/models/job_comment_create_parameters_spec.rb +29 -0
  37. data/spec/models/job_comment_spec.rb +65 -0
  38. data/spec/models/job_comment_update_parameters_spec.rb +29 -0
  39. data/spec/models/job_create_parameters_spec.rb +6 -0
  40. data/spec/models/key_create_parameters_spec.rb +6 -0
  41. data/spec/models/{team1_spec.rb → team_short_spec.rb} +6 -6
  42. metadata +217 -201
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b7172a74587dd0cc07e91bee98a1704f41a00a5cba1a67e188783fbeddad171b
4
- data.tar.gz: 75236174eeb3cd53ac3f0680195f3f3551f35d89251a9275a52a95e6ce827f6b
3
+ metadata.gz: 62ab3ca7c47d1c5c266a466aeda8cc9dac40f0d5330ae3f8be59259a950d858d
4
+ data.tar.gz: b93dbcdd89d91e22d73b35196aa553e71f7b4f7484fba64d94ffe113d64add3b
5
5
  SHA512:
6
- metadata.gz: ff69aa4ad7f154d6bae216853b86df2f731fdddaa27fac44512e0ca0f39a4fca7af4539e59d61f2aa5e2ba2d96221411531f0d83348c63c0e0d8e49e69625f9c
7
- data.tar.gz: 955a37c3fd96b6eb05edf01bdff0bd803d102a93b5cb7387dd12cbcc1a7e3d57776b07d8c038299fa1c216e4b0c86601689b2ad45ca383967f314d9a331fb474
6
+ metadata.gz: 361380faae2aa14ce6a3e553dd2babf8d8b393930ad8c37ce7ce6f55be8ae4b9564fe5726034c2d2509ae12fd00ca0855ea3fade7aaad857356992c4e30ba39c
7
+ data.tar.gz: 785ac620370cb9aef4904f56f7816ce568bec2728d86f553dc1de0ad6140d96dab8f7d4cd34f42fd751895ecb414f228956bbeef456593f089e5143c8987899b
data/README.md CHANGED
@@ -7,7 +7,7 @@ Phrase is a translation management platform for software projects. You can colla
7
7
  ## This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 2.5.1
10
+ - Package version: 2.7.1
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [https://developers.phrase.com/api/](https://developers.phrase.com/api/)
13
13
 
@@ -56,10 +56,10 @@ gem build phrase.gemspec
56
56
  Then install the gem locally:
57
57
 
58
58
  ```shell
59
- gem install ./phrase-2.5.1.gem
59
+ gem install ./phrase-2.7.1.gem
60
60
  ```
61
61
 
62
- (for development, run `gem install --dev ./phrase-2.5.1.gem` to install the development dependencies)
62
+ (for development, run `gem install --dev ./phrase-2.7.1.gem` to install the development dependencies)
63
63
 
64
64
  ## Getting Started
65
65
 
@@ -176,6 +176,11 @@ Class | Method | HTTP request | Description
176
176
  *Phrase::InvitationsApi* | [**invitation_update**](docs/InvitationsApi.md#invitation_update) | **PATCH** /accounts/{account_id}/invitations/{id} | Update an invitation
177
177
  *Phrase::InvitationsApi* | [**invitation_update_settings**](docs/InvitationsApi.md#invitation_update_settings) | **PATCH** /projects/{project_id}/invitations/{id} | Update a member's invitation access
178
178
  *Phrase::InvitationsApi* | [**invitations_list**](docs/InvitationsApi.md#invitations_list) | **GET** /accounts/{account_id}/invitations | List invitations
179
+ *Phrase::JobCommentsApi* | [**job_comment_create**](docs/JobCommentsApi.md#job_comment_create) | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
180
+ *Phrase::JobCommentsApi* | [**job_comment_delete**](docs/JobCommentsApi.md#job_comment_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
181
+ *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
182
+ *Phrase::JobCommentsApi* | [**job_comment_update**](docs/JobCommentsApi.md#job_comment_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/comments/{id} | Update a job comment
183
+ *Phrase::JobCommentsApi* | [**job_comments_list**](docs/JobCommentsApi.md#job_comments_list) | **GET** /projects/{project_id}/jobs/{job_id}/comments | List job comments
179
184
  *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
180
185
  *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
181
186
  *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
199
204
  *Phrase::JobsApi* | [**job_delete**](docs/JobsApi.md#job_delete) | **DELETE** /projects/{project_id}/jobs/{id} | Delete a job
200
205
  *Phrase::JobsApi* | [**job_keys_create**](docs/JobsApi.md#job_keys_create) | **POST** /projects/{project_id}/jobs/{id}/keys | Add keys to job
201
206
  *Phrase::JobsApi* | [**job_keys_delete**](docs/JobsApi.md#job_keys_delete) | **DELETE** /projects/{project_id}/jobs/{id}/keys | Remove keys from job
207
+ *Phrase::JobsApi* | [**job_lock**](docs/JobsApi.md#job_lock) | **POST** /projects/{project_id}/jobs/{id}/lock | Lock a job
202
208
  *Phrase::JobsApi* | [**job_reopen**](docs/JobsApi.md#job_reopen) | **POST** /projects/{project_id}/jobs/{id}/reopen | Reopen a job
203
209
  *Phrase::JobsApi* | [**job_show**](docs/JobsApi.md#job_show) | **GET** /projects/{project_id}/jobs/{id} | Get a single job
204
210
  *Phrase::JobsApi* | [**job_start**](docs/JobsApi.md#job_start) | **POST** /projects/{project_id}/jobs/{id}/start | Start a job
211
+ *Phrase::JobsApi* | [**job_unlock**](docs/JobsApi.md#job_unlock) | **POST** /projects/{project_id}/jobs/{id}/unlock | Unlock a job
205
212
  *Phrase::JobsApi* | [**job_update**](docs/JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
206
213
  *Phrase::JobsApi* | [**jobs_by_account**](docs/JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
207
214
  *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
386
393
  - [Phrase::InvitationUpdateParameters](docs/InvitationUpdateParameters.md)
387
394
  - [Phrase::InvitationUpdateSettingsParameters](docs/InvitationUpdateSettingsParameters.md)
388
395
  - [Phrase::Job](docs/Job.md)
396
+ - [Phrase::JobComment](docs/JobComment.md)
397
+ - [Phrase::JobCommentCreateParameters](docs/JobCommentCreateParameters.md)
398
+ - [Phrase::JobCommentUpdateParameters](docs/JobCommentUpdateParameters.md)
389
399
  - [Phrase::JobCompleteParameters](docs/JobCompleteParameters.md)
390
400
  - [Phrase::JobCreateParameters](docs/JobCreateParameters.md)
391
401
  - [Phrase::JobDetails](docs/JobDetails.md)
@@ -475,9 +485,9 @@ Class | Method | HTTP request | Description
475
485
  - [Phrase::TagWithStats1Statistics](docs/TagWithStats1Statistics.md)
476
486
  - [Phrase::TagWithStats1Statistics1](docs/TagWithStats1Statistics1.md)
477
487
  - [Phrase::Team](docs/Team.md)
478
- - [Phrase::Team1](docs/Team1.md)
479
488
  - [Phrase::TeamCreateParameters](docs/TeamCreateParameters.md)
480
489
  - [Phrase::TeamDetail](docs/TeamDetail.md)
490
+ - [Phrase::TeamShort](docs/TeamShort.md)
481
491
  - [Phrase::TeamUpdateParameters](docs/TeamUpdateParameters.md)
482
492
  - [Phrase::TeamsProjectsCreateParameters](docs/TeamsProjectsCreateParameters.md)
483
493
  - [Phrase::TeamsSpacesCreateParameters](docs/TeamsSpacesCreateParameters.md)
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **content** | **String** | Source content | [optional]
8
8
  **locale_codes** | **Array<String>** | Locale codes | [optional]
9
+ **keep_content** | **Boolean** | Keep the content and add missing plural forms for each locale | [optional]
9
10
  **zero_form_enabled** | **Boolean** | Indicates whether the zero form should be included or excluded in the returned skeletons | [optional]
10
11
 
11
12
  ## Code Sample
@@ -15,6 +16,7 @@ require 'Phrase'
15
16
 
16
17
  instance = Phrase::IcuSkeletonParameters.new(content: {number, plural, one {One} other {%{n}}},
17
18
  locale_codes: ["en"],
19
+ keep_content: null,
18
20
  zero_form_enabled: null)
19
21
  ```
20
22
 
data/docs/Invitation.md CHANGED
@@ -10,14 +10,14 @@ Name | Type | Description | Notes
10
10
  **state** | **String** | | [optional]
11
11
  **projects** | [**Array<ProjectShort>**](ProjectShort.md) | | [optional]
12
12
  **locales** | [**Array<LocalePreview>**](LocalePreview.md) | | [optional]
13
+ **teams** | [**Array<TeamShort>**](TeamShort.md) | | [optional]
13
14
  **default_locale_codes** | **Array<String>** | | [optional]
14
15
  **permissions** | [**Object**](.md) | | [optional]
15
16
  **locale_ids** | **Array<String>** | | [optional]
16
17
  **created_at** | **DateTime** | | [optional]
17
18
  **updated_at** | **DateTime** | | [optional]
18
19
  **accepted_at** | **DateTime** | | [optional]
19
- **spaces** | [**Array<MemberSpaces>**](MemberSpaces.md) | | [optional]
20
- **teams** | [**Array<Items>**](Items.md) | | [optional]
20
+ **spaces** | [**Array<Space>**](Space.md) | | [optional]
21
21
  **project_role** | [**Array<MemberProjectDetailProjectRoles>**](MemberProjectDetailProjectRoles.md) | | [optional]
22
22
 
23
23
  ## Code Sample
@@ -31,6 +31,7 @@ instance = Phrase::Invitation.new(id: null,
31
31
  state: null,
32
32
  projects: null,
33
33
  locales: null,
34
+ teams: null,
34
35
  default_locale_codes: null,
35
36
  permissions: null,
36
37
  locale_ids: null,
@@ -38,7 +39,6 @@ instance = Phrase::Invitation.new(id: null,
38
39
  updated_at: null,
39
40
  accepted_at: null,
40
41
  spaces: null,
41
- teams: null,
42
42
  project_role: null)
43
43
  ```
44
44
 
@@ -0,0 +1,29 @@
1
+ # Phrase::JobComment
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | | [optional]
8
+ **message** | **String** | | [optional]
9
+ **job_id** | **String** | | [optional]
10
+ **user** | [**UserPreview**](UserPreview.md) | | [optional]
11
+ **created_at** | **DateTime** | | [optional]
12
+ **updated_at** | **DateTime** | | [optional]
13
+ **mentioned_users** | [**Array<UserPreview>**](UserPreview.md) | | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'Phrase'
19
+
20
+ instance = Phrase::JobComment.new(id: null,
21
+ message: null,
22
+ job_id: null,
23
+ user: null,
24
+ created_at: null,
25
+ updated_at: null,
26
+ mentioned_users: null)
27
+ ```
28
+
29
+
@@ -0,0 +1,17 @@
1
+ # Phrase::JobCommentCreateParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | Job comment message | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Phrase'
13
+
14
+ instance = Phrase::JobCommentCreateParameters.new(message: Some message...)
15
+ ```
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # Phrase::JobCommentUpdateParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **message** | **String** | Comment message | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Phrase'
13
+
14
+ instance = Phrase::JobCommentUpdateParameters.new(message: Some message...)
15
+ ```
16
+
17
+
@@ -0,0 +1,343 @@
1
+ # Phrase::JobCommentsApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**job_comment_create**](JobCommentsApi.md#job_comment_create) | **POST** /projects/{project_id}/jobs/{job_id}/comments | Create a job comment
8
+ [**job_comment_delete**](JobCommentsApi.md#job_comment_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/comments/{id} | Delete a job comment
9
+ [**job_comment_show**](JobCommentsApi.md#job_comment_show) | **GET** /projects/{project_id}/jobs/{job_id}/comments/{id} | Get a single job comment
10
+ [**job_comment_update**](JobCommentsApi.md#job_comment_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/comments/{id} | Update a job comment
11
+ [**job_comments_list**](JobCommentsApi.md#job_comments_list) | **GET** /projects/{project_id}/jobs/{job_id}/comments | List job comments
12
+
13
+
14
+
15
+ ## job_comment_create
16
+
17
+ > JobComment job_comment_create(project_id, job_id, job_comment_create_parameters, opts)
18
+
19
+ Create a job comment
20
+
21
+ Create a new comment for a job.
22
+
23
+ ### Example
24
+
25
+ ```ruby
26
+ # load the gem
27
+ require 'phrase'
28
+ # setup authorization
29
+ Phrase.configure do |config|
30
+ # Configure HTTP basic authorization: Basic
31
+ config.username = 'YOUR USERNAME'
32
+ config.password = 'YOUR PASSWORD'
33
+
34
+ # Configure API key authorization: Token
35
+ config.api_key['Authorization'] = 'YOUR API KEY'
36
+ config.api_key_prefix['Authorization'] = 'token'
37
+ end
38
+
39
+ api_instance = Phrase::JobCommentsApi.new
40
+ project_id = 'project_id_example' # String | Project ID
41
+ job_id = 'job_id_example' # String | Job ID
42
+ job_comment_create_parameters = Phrase::JobCommentCreateParameters.new # JobCommentCreateParameters |
43
+ opts = {
44
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
45
+ }
46
+
47
+ begin
48
+ #Create a job comment
49
+ result = api_instance.job_comment_create(project_id, job_id, job_comment_create_parameters, opts)
50
+ pp result
51
+ rescue Phrase::ApiError => e
52
+ puts "Exception when calling JobCommentsApi->job_comment_create: #{e}"
53
+ end
54
+ ```
55
+
56
+ ### Parameters
57
+
58
+
59
+ Name | Type | Description | Notes
60
+ ------------- | ------------- | ------------- | -------------
61
+ **project_id** | **String**| Project ID |
62
+ **job_id** | **String**| Job ID |
63
+ **job_comment_create_parameters** | [**JobCommentCreateParameters**](JobCommentCreateParameters.md)| |
64
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
65
+
66
+ ### Return type
67
+
68
+ Response<([**JobComment**](JobComment.md))>
69
+
70
+ ### Authorization
71
+
72
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: application/json
77
+ - **Accept**: application/json
78
+
79
+
80
+ ## job_comment_delete
81
+
82
+ > job_comment_delete(project_id, job_id, id, opts)
83
+
84
+ Delete a job comment
85
+
86
+ Delete an existing job comment.
87
+
88
+ ### Example
89
+
90
+ ```ruby
91
+ # load the gem
92
+ require 'phrase'
93
+ # setup authorization
94
+ Phrase.configure do |config|
95
+ # Configure HTTP basic authorization: Basic
96
+ config.username = 'YOUR USERNAME'
97
+ config.password = 'YOUR PASSWORD'
98
+
99
+ # Configure API key authorization: Token
100
+ config.api_key['Authorization'] = 'YOUR API KEY'
101
+ config.api_key_prefix['Authorization'] = 'token'
102
+ end
103
+
104
+ api_instance = Phrase::JobCommentsApi.new
105
+ project_id = 'project_id_example' # String | Project ID
106
+ job_id = 'job_id_example' # String | Job ID
107
+ id = 'id_example' # String | ID
108
+ opts = {
109
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
110
+ branch: 'my-feature-branch' # String | specify the branch to use
111
+ }
112
+
113
+ begin
114
+ #Delete a job comment
115
+ api_instance.job_comment_delete(project_id, job_id, id, opts)
116
+ rescue Phrase::ApiError => e
117
+ puts "Exception when calling JobCommentsApi->job_comment_delete: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+
124
+ Name | Type | Description | Notes
125
+ ------------- | ------------- | ------------- | -------------
126
+ **project_id** | **String**| Project ID |
127
+ **job_id** | **String**| Job ID |
128
+ **id** | **String**| ID |
129
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
130
+ **branch** | **String**| specify the branch to use | [optional]
131
+
132
+ ### Return type
133
+
134
+ Response<(nil (empty response body))>
135
+
136
+ ### Authorization
137
+
138
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
139
+
140
+ ### HTTP request headers
141
+
142
+ - **Content-Type**: Not defined
143
+ - **Accept**: Not defined
144
+
145
+
146
+ ## job_comment_show
147
+
148
+ > Object job_comment_show(project_id, job_id, id, opts)
149
+
150
+ Get a single job comment
151
+
152
+ Get details on a single job comment.
153
+
154
+ ### Example
155
+
156
+ ```ruby
157
+ # load the gem
158
+ require 'phrase'
159
+ # setup authorization
160
+ Phrase.configure do |config|
161
+ # Configure HTTP basic authorization: Basic
162
+ config.username = 'YOUR USERNAME'
163
+ config.password = 'YOUR PASSWORD'
164
+
165
+ # Configure API key authorization: Token
166
+ config.api_key['Authorization'] = 'YOUR API KEY'
167
+ config.api_key_prefix['Authorization'] = 'token'
168
+ end
169
+
170
+ api_instance = Phrase::JobCommentsApi.new
171
+ project_id = 'project_id_example' # String | Project ID
172
+ job_id = 'job_id_example' # String | Job ID
173
+ id = 'id_example' # String | ID
174
+ opts = {
175
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
176
+ branch: 'my-feature-branch' # String | specify the branch to use
177
+ }
178
+
179
+ begin
180
+ #Get a single job comment
181
+ result = api_instance.job_comment_show(project_id, job_id, id, opts)
182
+ pp result
183
+ rescue Phrase::ApiError => e
184
+ puts "Exception when calling JobCommentsApi->job_comment_show: #{e}"
185
+ end
186
+ ```
187
+
188
+ ### Parameters
189
+
190
+
191
+ Name | Type | Description | Notes
192
+ ------------- | ------------- | ------------- | -------------
193
+ **project_id** | **String**| Project ID |
194
+ **job_id** | **String**| Job ID |
195
+ **id** | **String**| ID |
196
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
197
+ **branch** | **String**| specify the branch to use | [optional]
198
+
199
+ ### Return type
200
+
201
+ Response<(**Object**)>
202
+
203
+ ### Authorization
204
+
205
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: Not defined
210
+ - **Accept**: application/json
211
+
212
+
213
+ ## job_comment_update
214
+
215
+ > Object job_comment_update(project_id, key_id, id, job_comment_update_parameters, opts)
216
+
217
+ Update a job comment
218
+
219
+ Update an existing job comment.
220
+
221
+ ### Example
222
+
223
+ ```ruby
224
+ # load the gem
225
+ require 'phrase'
226
+ # setup authorization
227
+ Phrase.configure do |config|
228
+ # Configure HTTP basic authorization: Basic
229
+ config.username = 'YOUR USERNAME'
230
+ config.password = 'YOUR PASSWORD'
231
+
232
+ # Configure API key authorization: Token
233
+ config.api_key['Authorization'] = 'YOUR API KEY'
234
+ config.api_key_prefix['Authorization'] = 'token'
235
+ end
236
+
237
+ api_instance = Phrase::JobCommentsApi.new
238
+ project_id = 'project_id_example' # String | Project ID
239
+ key_id = 'key_id_example' # String | Translation Key ID
240
+ id = 'id_example' # String | ID
241
+ job_comment_update_parameters = Phrase::JobCommentUpdateParameters.new # JobCommentUpdateParameters |
242
+ opts = {
243
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
244
+ }
245
+
246
+ begin
247
+ #Update a job comment
248
+ result = api_instance.job_comment_update(project_id, key_id, id, job_comment_update_parameters, opts)
249
+ pp result
250
+ rescue Phrase::ApiError => e
251
+ puts "Exception when calling JobCommentsApi->job_comment_update: #{e}"
252
+ end
253
+ ```
254
+
255
+ ### Parameters
256
+
257
+
258
+ Name | Type | Description | Notes
259
+ ------------- | ------------- | ------------- | -------------
260
+ **project_id** | **String**| Project ID |
261
+ **key_id** | **String**| Translation Key ID |
262
+ **id** | **String**| ID |
263
+ **job_comment_update_parameters** | [**JobCommentUpdateParameters**](JobCommentUpdateParameters.md)| |
264
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
265
+
266
+ ### Return type
267
+
268
+ Response<(**Object**)>
269
+
270
+ ### Authorization
271
+
272
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
273
+
274
+ ### HTTP request headers
275
+
276
+ - **Content-Type**: application/json
277
+ - **Accept**: application/json
278
+
279
+
280
+ ## job_comments_list
281
+
282
+ > Array&lt;Object&gt; job_comments_list(project_id, job_id, opts)
283
+
284
+ List job comments
285
+
286
+ List all comments for a job.
287
+
288
+ ### Example
289
+
290
+ ```ruby
291
+ # load the gem
292
+ require 'phrase'
293
+ # setup authorization
294
+ Phrase.configure do |config|
295
+ # Configure HTTP basic authorization: Basic
296
+ config.username = 'YOUR USERNAME'
297
+ config.password = 'YOUR PASSWORD'
298
+
299
+ # Configure API key authorization: Token
300
+ config.api_key['Authorization'] = 'YOUR API KEY'
301
+ config.api_key_prefix['Authorization'] = 'token'
302
+ end
303
+
304
+ api_instance = Phrase::JobCommentsApi.new
305
+ project_id = 'project_id_example' # String | Project ID
306
+ job_id = 'job_id_example' # String | Job ID
307
+ opts = {
308
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
309
+ branch: 'my-feature-branch' # String | specify the branch to use
310
+ }
311
+
312
+ begin
313
+ #List job comments
314
+ result = api_instance.job_comments_list(project_id, job_id, opts)
315
+ pp result
316
+ rescue Phrase::ApiError => e
317
+ puts "Exception when calling JobCommentsApi->job_comments_list: #{e}"
318
+ end
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+
324
+ Name | Type | Description | Notes
325
+ ------------- | ------------- | ------------- | -------------
326
+ **project_id** | **String**| Project ID |
327
+ **job_id** | **String**| Job ID |
328
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
329
+ **branch** | **String**| specify the branch to use | [optional]
330
+
331
+ ### Return type
332
+
333
+ Response<(**Array&lt;Object&gt;**)>
334
+
335
+ ### Authorization
336
+
337
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
338
+
339
+ ### HTTP request headers
340
+
341
+ - **Content-Type**: Not defined
342
+ - **Accept**: application/json
343
+
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **ticket_url** | **String** | URL to a ticket for this job (e.g. Jira, Trello) | [optional]
13
13
  **tags** | **Array&lt;String&gt;** | tags of keys that should be included within the job | [optional]
14
14
  **translation_key_ids** | **Array&lt;String&gt;** | ids of keys that should be included within the job | [optional]
15
+ **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]
15
16
 
16
17
  ## Code Sample
17
18
 
@@ -25,7 +26,8 @@ instance = Phrase::JobCreateParameters.new(branch: my-feature-branch,
25
26
  due_date: null,
26
27
  ticket_url: https://example.atlassian.net/browse/FOO,
27
28
  tags: [&quot;myUploadTag&quot;],
28
- translation_key_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;])
29
+ translation_key_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;],
30
+ job_template_id: abcd1234cdef1234abcd1234cdef1234)
29
31
  ```
30
32
 
31
33