phrase 2.12.0 → 2.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +25 -13
  4. data/docs/Comment.md +5 -1
  5. data/docs/CommentReaction.md +27 -0
  6. data/docs/CommentReactionsApi.md +289 -0
  7. data/docs/CommentRepliesApi.md +427 -0
  8. data/docs/CommentsApi.md +5 -1
  9. data/docs/DistributionCreateParameters.md +1 -1
  10. data/docs/GitlabSyncHistory.md +2 -2
  11. data/docs/GitlabSyncHistoryErrors.md +19 -0
  12. data/docs/JobLocaleUpdateParameters.md +1 -1
  13. data/docs/JobLocalesApi.md +20 -20
  14. data/docs/JobLocalesCreateParameters.md +1 -1
  15. data/docs/LocalesApi.md +2 -2
  16. data/docs/SpacesApi.md +9 -9
  17. data/docs/TeamsApi.md +6 -6
  18. data/docs/UploadCreateParameters.md +1 -1
  19. data/docs/UploadsApi.md +2 -2
  20. data/lib/phrase/api/comment_reactions_api.rb +353 -0
  21. data/lib/phrase/api/comment_replies_api.rb +523 -0
  22. data/lib/phrase/api/comments_api.rb +6 -0
  23. data/lib/phrase/api/job_locales_api.rb +20 -20
  24. data/lib/phrase/api/locales_api.rb +2 -2
  25. data/lib/phrase/api/spaces_api.rb +6 -6
  26. data/lib/phrase/api/teams_api.rb +4 -4
  27. data/lib/phrase/api/uploads_api.rb +2 -2
  28. data/lib/phrase/models/comment.rb +24 -4
  29. data/lib/phrase/models/comment_reaction.rb +239 -0
  30. data/lib/phrase/models/distribution_create_parameters.rb +1 -1
  31. data/lib/phrase/models/gitlab_sync_history.rb +2 -2
  32. data/lib/phrase/models/gitlab_sync_history_errors.rb +203 -0
  33. data/lib/phrase/models/job_locale_update_parameters.rb +1 -1
  34. data/lib/phrase/models/job_locales_create_parameters.rb +1 -1
  35. data/lib/phrase/models/upload_create_parameters.rb +1 -1
  36. data/lib/phrase/version.rb +1 -1
  37. data/lib/phrase.rb +4 -0
  38. data/spec/api/comment_reactions_api_spec.rb +92 -0
  39. data/spec/api/comment_replies_api_spec.rb +126 -0
  40. data/spec/api/comments_api_spec.rb +2 -0
  41. data/spec/api/job_locales_api_spec.rb +10 -10
  42. data/spec/api/locales_api_spec.rb +1 -1
  43. data/spec/api/spaces_api_spec.rb +3 -3
  44. data/spec/api/teams_api_spec.rb +2 -2
  45. data/spec/api/uploads_api_spec.rb +1 -1
  46. data/spec/models/comment_reaction_spec.rb +59 -0
  47. data/spec/models/comment_spec.rb +12 -0
  48. data/spec/models/gitlab_sync_history_errors_spec.rb +35 -0
  49. metadata +228 -211
@@ -0,0 +1,427 @@
1
+ # Phrase::CommentRepliesApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**replies_list**](CommentRepliesApi.md#replies_list) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | List replies
8
+ [**reply_create**](CommentRepliesApi.md#reply_create) | **POST** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies | Create a reply
9
+ [**reply_delete**](CommentRepliesApi.md#reply_delete) | **DELETE** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Delete a reply
10
+ [**reply_mark_as_read**](CommentRepliesApi.md#reply_mark_as_read) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read | Mark a reply as read
11
+ [**reply_mark_as_unread**](CommentRepliesApi.md#reply_mark_as_unread) | **PATCH** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread | Mark a reply as unread
12
+ [**reply_show**](CommentRepliesApi.md#reply_show) | **GET** /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} | Get a single reply
13
+
14
+
15
+
16
+ ## replies_list
17
+
18
+ > Array<Comment> replies_list(project_id, key_id, comment_id, opts)
19
+
20
+ List replies
21
+
22
+ List all replies for a comment.
23
+
24
+ ### Example
25
+
26
+ ```ruby
27
+ # load the gem
28
+ require 'phrase'
29
+ # setup authorization
30
+ Phrase.configure do |config|
31
+ # Configure HTTP basic authorization: Basic
32
+ config.username = 'YOUR USERNAME'
33
+ config.password = 'YOUR PASSWORD'
34
+
35
+ # Configure API key authorization: Token
36
+ config.api_key['Authorization'] = 'YOUR API KEY'
37
+ config.api_key_prefix['Authorization'] = 'token'
38
+ end
39
+
40
+ api_instance = Phrase::CommentRepliesApi.new
41
+ project_id = 'project_id_example' # String | Project ID
42
+ key_id = 'key_id_example' # String | Translation Key ID
43
+ comment_id = 'comment_id_example' # String | Comment ID
44
+ opts = {
45
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
46
+ page: 1, # Integer | Page number
47
+ per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
48
+ branch: 'my-feature-branch' # String | specify the branch to use
49
+ }
50
+
51
+ begin
52
+ #List replies
53
+ result = api_instance.replies_list(project_id, key_id, comment_id, opts)
54
+ pp result
55
+ rescue Phrase::ApiError => e
56
+ puts "Exception when calling CommentRepliesApi->replies_list: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+
63
+ Name | Type | Description | Notes
64
+ ------------- | ------------- | ------------- | -------------
65
+ **project_id** | **String**| Project ID |
66
+ **key_id** | **String**| Translation Key ID |
67
+ **comment_id** | **String**| Comment ID |
68
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
69
+ **page** | **Integer**| Page number | [optional]
70
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
71
+ **branch** | **String**| specify the branch to use | [optional]
72
+
73
+ ### Return type
74
+
75
+ Response<([**Array&lt;Comment&gt;**](Comment.md))>
76
+
77
+ ### Authorization
78
+
79
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: Not defined
84
+ - **Accept**: application/json
85
+
86
+
87
+ ## reply_create
88
+
89
+ > Comment reply_create(project_id, key_id, comment_id, opts)
90
+
91
+ Create a reply
92
+
93
+ Create a new reply for a comment.
94
+
95
+ ### Example
96
+
97
+ ```ruby
98
+ # load the gem
99
+ require 'phrase'
100
+ # setup authorization
101
+ Phrase.configure do |config|
102
+ # Configure HTTP basic authorization: Basic
103
+ config.username = 'YOUR USERNAME'
104
+ config.password = 'YOUR PASSWORD'
105
+
106
+ # Configure API key authorization: Token
107
+ config.api_key['Authorization'] = 'YOUR API KEY'
108
+ config.api_key_prefix['Authorization'] = 'token'
109
+ end
110
+
111
+ api_instance = Phrase::CommentRepliesApi.new
112
+ project_id = 'project_id_example' # String | Project ID
113
+ key_id = 'key_id_example' # String | Translation Key ID
114
+ comment_id = 'comment_id_example' # String | Comment ID
115
+ opts = {
116
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
117
+ branch: 'my-feature-branch', # String | specify the branch to use
118
+ message: 'some message...' # String | specify the message for the comment
119
+ }
120
+
121
+ begin
122
+ #Create a reply
123
+ result = api_instance.reply_create(project_id, key_id, comment_id, opts)
124
+ pp result
125
+ rescue Phrase::ApiError => e
126
+ puts "Exception when calling CommentRepliesApi->reply_create: #{e}"
127
+ end
128
+ ```
129
+
130
+ ### Parameters
131
+
132
+
133
+ Name | Type | Description | Notes
134
+ ------------- | ------------- | ------------- | -------------
135
+ **project_id** | **String**| Project ID |
136
+ **key_id** | **String**| Translation Key ID |
137
+ **comment_id** | **String**| Comment ID |
138
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
139
+ **branch** | **String**| specify the branch to use | [optional]
140
+ **message** | **String**| specify the message for the comment | [optional]
141
+
142
+ ### Return type
143
+
144
+ Response<([**Comment**](Comment.md))>
145
+
146
+ ### Authorization
147
+
148
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## reply_delete
157
+
158
+ > reply_delete(project_id, key_id, comment_id, id, opts)
159
+
160
+ Delete a reply
161
+
162
+ Delete an existing reply.
163
+
164
+ ### Example
165
+
166
+ ```ruby
167
+ # load the gem
168
+ require 'phrase'
169
+ # setup authorization
170
+ Phrase.configure do |config|
171
+ # Configure HTTP basic authorization: Basic
172
+ config.username = 'YOUR USERNAME'
173
+ config.password = 'YOUR PASSWORD'
174
+
175
+ # Configure API key authorization: Token
176
+ config.api_key['Authorization'] = 'YOUR API KEY'
177
+ config.api_key_prefix['Authorization'] = 'token'
178
+ end
179
+
180
+ api_instance = Phrase::CommentRepliesApi.new
181
+ project_id = 'project_id_example' # String | Project ID
182
+ key_id = 'key_id_example' # String | Translation Key ID
183
+ comment_id = 'comment_id_example' # String | Comment ID
184
+ id = 'id_example' # String | ID
185
+ opts = {
186
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
187
+ branch: 'my-feature-branch' # String | specify the branch to use
188
+ }
189
+
190
+ begin
191
+ #Delete a reply
192
+ api_instance.reply_delete(project_id, key_id, comment_id, id, opts)
193
+ rescue Phrase::ApiError => e
194
+ puts "Exception when calling CommentRepliesApi->reply_delete: #{e}"
195
+ end
196
+ ```
197
+
198
+ ### Parameters
199
+
200
+
201
+ Name | Type | Description | Notes
202
+ ------------- | ------------- | ------------- | -------------
203
+ **project_id** | **String**| Project ID |
204
+ **key_id** | **String**| Translation Key ID |
205
+ **comment_id** | **String**| Comment ID |
206
+ **id** | **String**| ID |
207
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
208
+ **branch** | **String**| specify the branch to use | [optional]
209
+
210
+ ### Return type
211
+
212
+ Response<(nil (empty response body))>
213
+
214
+ ### Authorization
215
+
216
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
217
+
218
+ ### HTTP request headers
219
+
220
+ - **Content-Type**: Not defined
221
+ - **Accept**: Not defined
222
+
223
+
224
+ ## reply_mark_as_read
225
+
226
+ > reply_mark_as_read(project_id, key_id, comment_id, id, opts)
227
+
228
+ Mark a reply as read
229
+
230
+ Mark a reply as read.
231
+
232
+ ### Example
233
+
234
+ ```ruby
235
+ # load the gem
236
+ require 'phrase'
237
+ # setup authorization
238
+ Phrase.configure do |config|
239
+ # Configure HTTP basic authorization: Basic
240
+ config.username = 'YOUR USERNAME'
241
+ config.password = 'YOUR PASSWORD'
242
+
243
+ # Configure API key authorization: Token
244
+ config.api_key['Authorization'] = 'YOUR API KEY'
245
+ config.api_key_prefix['Authorization'] = 'token'
246
+ end
247
+
248
+ api_instance = Phrase::CommentRepliesApi.new
249
+ project_id = 'project_id_example' # String | Project ID
250
+ key_id = 'key_id_example' # String | Translation Key ID
251
+ comment_id = 'comment_id_example' # String | Comment ID
252
+ id = 'id_example' # String | ID
253
+ opts = {
254
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
255
+ branch: 'my-feature-branch' # String | specify the branch to use
256
+ }
257
+
258
+ begin
259
+ #Mark a reply as read
260
+ api_instance.reply_mark_as_read(project_id, key_id, comment_id, id, opts)
261
+ rescue Phrase::ApiError => e
262
+ puts "Exception when calling CommentRepliesApi->reply_mark_as_read: #{e}"
263
+ end
264
+ ```
265
+
266
+ ### Parameters
267
+
268
+
269
+ Name | Type | Description | Notes
270
+ ------------- | ------------- | ------------- | -------------
271
+ **project_id** | **String**| Project ID |
272
+ **key_id** | **String**| Translation Key ID |
273
+ **comment_id** | **String**| Comment ID |
274
+ **id** | **String**| ID |
275
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
276
+ **branch** | **String**| specify the branch to use | [optional]
277
+
278
+ ### Return type
279
+
280
+ Response<(nil (empty response body))>
281
+
282
+ ### Authorization
283
+
284
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
285
+
286
+ ### HTTP request headers
287
+
288
+ - **Content-Type**: Not defined
289
+ - **Accept**: Not defined
290
+
291
+
292
+ ## reply_mark_as_unread
293
+
294
+ > reply_mark_as_unread(project_id, key_id, comment_id, id, opts)
295
+
296
+ Mark a reply as unread
297
+
298
+ Mark a reply as unread.
299
+
300
+ ### Example
301
+
302
+ ```ruby
303
+ # load the gem
304
+ require 'phrase'
305
+ # setup authorization
306
+ Phrase.configure do |config|
307
+ # Configure HTTP basic authorization: Basic
308
+ config.username = 'YOUR USERNAME'
309
+ config.password = 'YOUR PASSWORD'
310
+
311
+ # Configure API key authorization: Token
312
+ config.api_key['Authorization'] = 'YOUR API KEY'
313
+ config.api_key_prefix['Authorization'] = 'token'
314
+ end
315
+
316
+ api_instance = Phrase::CommentRepliesApi.new
317
+ project_id = 'project_id_example' # String | Project ID
318
+ key_id = 'key_id_example' # String | Translation Key ID
319
+ comment_id = 'comment_id_example' # String | Comment ID
320
+ id = 'id_example' # String | ID
321
+ opts = {
322
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
323
+ branch: 'my-feature-branch' # String | specify the branch to use
324
+ }
325
+
326
+ begin
327
+ #Mark a reply as unread
328
+ api_instance.reply_mark_as_unread(project_id, key_id, comment_id, id, opts)
329
+ rescue Phrase::ApiError => e
330
+ puts "Exception when calling CommentRepliesApi->reply_mark_as_unread: #{e}"
331
+ end
332
+ ```
333
+
334
+ ### Parameters
335
+
336
+
337
+ Name | Type | Description | Notes
338
+ ------------- | ------------- | ------------- | -------------
339
+ **project_id** | **String**| Project ID |
340
+ **key_id** | **String**| Translation Key ID |
341
+ **comment_id** | **String**| Comment ID |
342
+ **id** | **String**| ID |
343
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
344
+ **branch** | **String**| specify the branch to use | [optional]
345
+
346
+ ### Return type
347
+
348
+ Response<(nil (empty response body))>
349
+
350
+ ### Authorization
351
+
352
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
353
+
354
+ ### HTTP request headers
355
+
356
+ - **Content-Type**: Not defined
357
+ - **Accept**: Not defined
358
+
359
+
360
+ ## reply_show
361
+
362
+ > Comment reply_show(project_id, key_id, comment_id, id, opts)
363
+
364
+ Get a single reply
365
+
366
+ Get details on a single reply.
367
+
368
+ ### Example
369
+
370
+ ```ruby
371
+ # load the gem
372
+ require 'phrase'
373
+ # setup authorization
374
+ Phrase.configure do |config|
375
+ # Configure HTTP basic authorization: Basic
376
+ config.username = 'YOUR USERNAME'
377
+ config.password = 'YOUR PASSWORD'
378
+
379
+ # Configure API key authorization: Token
380
+ config.api_key['Authorization'] = 'YOUR API KEY'
381
+ config.api_key_prefix['Authorization'] = 'token'
382
+ end
383
+
384
+ api_instance = Phrase::CommentRepliesApi.new
385
+ project_id = 'project_id_example' # String | Project ID
386
+ key_id = 'key_id_example' # String | Translation Key ID
387
+ comment_id = 'comment_id_example' # String | Comment ID
388
+ id = 'id_example' # String | ID
389
+ opts = {
390
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
391
+ branch: 'my-feature-branch' # String | specify the branch to use
392
+ }
393
+
394
+ begin
395
+ #Get a single reply
396
+ result = api_instance.reply_show(project_id, key_id, comment_id, id, opts)
397
+ pp result
398
+ rescue Phrase::ApiError => e
399
+ puts "Exception when calling CommentRepliesApi->reply_show: #{e}"
400
+ end
401
+ ```
402
+
403
+ ### Parameters
404
+
405
+
406
+ Name | Type | Description | Notes
407
+ ------------- | ------------- | ------------- | -------------
408
+ **project_id** | **String**| Project ID |
409
+ **key_id** | **String**| Translation Key ID |
410
+ **comment_id** | **String**| Comment ID |
411
+ **id** | **String**| ID |
412
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
413
+ **branch** | **String**| specify the branch to use | [optional]
414
+
415
+ ### Return type
416
+
417
+ Response<([**Comment**](Comment.md))>
418
+
419
+ ### Authorization
420
+
421
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
422
+
423
+ ### HTTP request headers
424
+
425
+ - **Content-Type**: Not defined
426
+ - **Accept**: application/json
427
+
data/docs/CommentsApi.md CHANGED
@@ -44,7 +44,9 @@ project_id = 'project_id_example' # String | Project ID
44
44
  key_id = 'key_id_example' # String | Translation Key ID
45
45
  comment_create_parameters = Phrase::CommentCreateParameters.new # CommentCreateParameters |
46
46
  opts = {
47
- x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
47
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
48
+ message: 'some message...', # String | specify the message for the comment
49
+ locale_ids: ['someId'] # Array<String> | specify the locales for the comment
48
50
  }
49
51
 
50
52
  begin
@@ -65,6 +67,8 @@ Name | Type | Description | Notes
65
67
  **key_id** | **String**| Translation Key ID |
66
68
  **comment_create_parameters** | [**CommentCreateParameters**](CommentCreateParameters.md)| |
67
69
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
70
+ **message** | **String**| specify the message for the comment | [optional]
71
+ **locale_ids** | [**Array&lt;String&gt;**](String.md)| specify the locales for the comment | [optional]
68
72
 
69
73
  ### Return type
70
74
 
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **name** | **String** | Name of the distribution | [optional]
8
8
  **project_id** | **String** | Project id the distribution should be assigned to. | [optional]
9
- **platforms** | **Array&lt;String&gt;** | List of platforms the distribution should support. | [optional]
9
+ **platforms** | **Array&lt;String&gt;** | List of platforms the distribution should support. Valid values are: * &#x60;android&#x60; * &#x60;ios&#x60; * &#x60;flutter&#x60; * &#x60;i18next&#x60; | [optional]
10
10
  **locale_ids** | **Array&lt;String&gt;** | List of locale ids that will be part of distribution releases | [optional]
11
11
  **format_options** | **Hash&lt;String, String&gt;** | Additional formatting and render options. Only &lt;code&gt;enclose_in_cdata&lt;/code&gt; is available for platform &lt;code&gt;android&lt;/code&gt;. | [optional]
12
12
  **fallback_locales_enabled** | **Boolean** | Use fallback locale if there is no translation in the current locale. | [optional]
@@ -4,9 +4,9 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **status** | **Integer** | | [optional]
7
+ **status** | **String** | | [optional]
8
8
  **action** | **String** | | [optional]
9
- **errors** | **Array&lt;String&gt;** | | [optional]
9
+ **errors** | [**Array&lt;GitlabSyncHistoryErrors&gt;**](GitlabSyncHistoryErrors.md) | | [optional]
10
10
  **date** | **DateTime** | | [optional]
11
11
  **details** | [**Object**](.md) | | [optional]
12
12
 
@@ -0,0 +1,19 @@
1
+ # Phrase::GitlabSyncHistoryErrors
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **error** | **String** | | [optional]
8
+ **message** | **String** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::GitlabSyncHistoryErrors.new(error: null,
16
+ message: null)
17
+ ```
18
+
19
+
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
- **locale_id** | **String** | locale id | [optional]
8
+ **locale_id** | **String** | ID of a target locale to update | [optional]
9
9
  **user_ids** | **Array&lt;String&gt;** | Array of user ids to be assigned to the job locale | [optional]
10
10
  **reviewer_ids** | **Array&lt;String&gt;** | Array of reviewer ids to be assigned to the job locale as reviewers | [optional]
11
11
  **translator_team_ids** | **Array&lt;String&gt;** | Array of team ids to be assigned to the job locale as translators | [optional]
@@ -6,12 +6,12 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**job_locale_complete**](JobLocalesApi.md#job_locale_complete) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete | Complete a job locale
8
8
  [**job_locale_complete_review**](JobLocalesApi.md#job_locale_complete_review) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review | Review a job locale
9
- [**job_locale_delete**](JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Delete a job locale
9
+ [**job_locale_delete**](JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Remove a target locale from a job
10
10
  [**job_locale_reopen**](JobLocalesApi.md#job_locale_reopen) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen | Reopen a job locale
11
- [**job_locale_show**](JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{id} | Get a single job locale
12
- [**job_locale_update**](JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job locale
13
- [**job_locales_create**](JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales | Create a job locale
14
- [**job_locales_list**](JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job locales
11
+ [**job_locale_show**](JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locales/{id} | Show single job target locale
12
+ [**job_locale_update**](JobLocalesApi.md#job_locale_update) | **PATCH** /projects/{project_id}/jobs/{job_id}/locales/{id} | Update a job target locale
13
+ [**job_locales_create**](JobLocalesApi.md#job_locales_create) | **POST** /projects/{project_id}/jobs/{job_id}/locales | Add a target locale to a job
14
+ [**job_locales_list**](JobLocalesApi.md#job_locales_list) | **GET** /projects/{project_id}/jobs/{job_id}/locales | List job target locales
15
15
 
16
16
 
17
17
 
@@ -153,9 +153,9 @@ Response<([**JobLocale**](JobLocale.md))>
153
153
 
154
154
  > job_locale_delete(project_id, job_id, id, opts)
155
155
 
156
- Delete a job locale
156
+ Remove a target locale from a job
157
157
 
158
- Delete an existing job locale.
158
+ Removes a target locale from a job.
159
159
 
160
160
  ### Example
161
161
 
@@ -183,7 +183,7 @@ opts = {
183
183
  }
184
184
 
185
185
  begin
186
- #Delete a job locale
186
+ #Remove a target locale from a job
187
187
  api_instance.job_locale_delete(project_id, job_id, id, opts)
188
188
  rescue Phrase::ApiError => e
189
189
  puts "Exception when calling JobLocalesApi->job_locale_delete: #{e}"
@@ -286,9 +286,9 @@ Response<([**JobLocale**](JobLocale.md))>
286
286
 
287
287
  > JobLocale job_locale_show(project_id, job_id, id, opts)
288
288
 
289
- Get a single job locale
289
+ Show single job target locale
290
290
 
291
- Get a single job locale for a given job.
291
+ Get a single target locale for a given job.
292
292
 
293
293
  ### Example
294
294
 
@@ -316,7 +316,7 @@ opts = {
316
316
  }
317
317
 
318
318
  begin
319
- #Get a single job locale
319
+ #Show single job target locale
320
320
  result = api_instance.job_locale_show(project_id, job_id, id, opts)
321
321
  pp result
322
322
  rescue Phrase::ApiError => e
@@ -353,9 +353,9 @@ Response<([**JobLocale**](JobLocale.md))>
353
353
 
354
354
  > JobLocale job_locale_update(project_id, job_id, id, job_locale_update_parameters, opts)
355
355
 
356
- Update a job locale
356
+ Update a job target locale
357
357
 
358
- Update an existing job locale.
358
+ Update an existing job target locale.
359
359
 
360
360
  ### Example
361
361
 
@@ -383,7 +383,7 @@ opts = {
383
383
  }
384
384
 
385
385
  begin
386
- #Update a job locale
386
+ #Update a job target locale
387
387
  result = api_instance.job_locale_update(project_id, job_id, id, job_locale_update_parameters, opts)
388
388
  pp result
389
389
  rescue Phrase::ApiError => e
@@ -420,9 +420,9 @@ Response<([**JobLocale**](JobLocale.md))>
420
420
 
421
421
  > JobLocale job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
422
422
 
423
- Create a job locale
423
+ Add a target locale to a job
424
424
 
425
- Create a new job locale.
425
+ Adds a target locale to a job.
426
426
 
427
427
  ### Example
428
428
 
@@ -449,7 +449,7 @@ opts = {
449
449
  }
450
450
 
451
451
  begin
452
- #Create a job locale
452
+ #Add a target locale to a job
453
453
  result = api_instance.job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
454
454
  pp result
455
455
  rescue Phrase::ApiError => e
@@ -485,9 +485,9 @@ Response<([**JobLocale**](JobLocale.md))>
485
485
 
486
486
  > Array&lt;JobLocale&gt; job_locales_list(project_id, job_id, opts)
487
487
 
488
- List job locales
488
+ List job target locales
489
489
 
490
- List all job locales for a given job.
490
+ List all target locales for a given job.
491
491
 
492
492
  ### Example
493
493
 
@@ -516,7 +516,7 @@ opts = {
516
516
  }
517
517
 
518
518
  begin
519
- #List job locales
519
+ #List job target locales
520
520
  result = api_instance.job_locales_list(project_id, job_id, opts)
521
521
  pp result
522
522
  rescue Phrase::ApiError => e
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
- **locale_id** | **String** | locale id |
8
+ **locale_id** | **String** | ID of a locale to be added |
9
9
  **user_ids** | **Array&lt;String&gt;** | Array of user ids to be assigned to the job locale as translators | [optional]
10
10
  **reviewer_ids** | **Array&lt;String&gt;** | Array of reviewer ids to be assigned to the job locale as reviewers | [optional]
11
11
  **translator_team_ids** | **Array&lt;String&gt;** | Array of team ids to be assigned to the job locale as translators | [optional]
data/docs/LocalesApi.md CHANGED
@@ -250,7 +250,7 @@ opts = {
250
250
  encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
251
251
  skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
252
252
  include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
253
- use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow (currently in beta) is enabled for the project.
253
+ use_last_reviewed_version: true, # Boolean | If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
254
254
  fallback_locale_id: 'fallback_locale_id_example', # String | If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
255
255
  source_locale_id: 'source_locale_id_example' # String | Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job.
256
256
  }
@@ -287,7 +287,7 @@ Name | Type | Description | Notes
287
287
  **encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \&quot;UTF-8\&quot;, \&quot;UTF-16\&quot; and \&quot;ISO-8859-1\&quot;. | [optional]
288
288
  **skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with &lt;code&gt;include_unverified_translations&lt;/code&gt;. | [optional]
289
289
  **include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional]
290
- **use_last_reviewed_version** | **Boolean**| If set to true the last reviewed version of a translation is used. This is only available if the review workflow (currently in beta) is enabled for the project. | [optional]
290
+ **use_last_reviewed_version** | **Boolean**| If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | [optional]
291
291
  **fallback_locale_id** | **String**| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to &lt;code&gt;true&lt;/code&gt;. | [optional]
292
292
  **source_locale_id** | **String**| Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a &lt;code&gt;tag&lt;/code&gt; parameter indicating a specific job. | [optional]
293
293