phrase 2.11.0 → 2.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +19 -13
  4. data/docs/CommentReaction.md +27 -0
  5. data/docs/CommentReactionsApi.md +287 -0
  6. data/docs/DistributionCreateParameters.md +1 -1
  7. data/docs/GitlabSyncHistory.md +2 -2
  8. data/docs/GitlabSyncHistoryErrors.md +19 -0
  9. data/docs/JobLocaleUpdateParameters.md +1 -1
  10. data/docs/JobLocalesApi.md +20 -20
  11. data/docs/JobLocalesCreateParameters.md +1 -1
  12. data/docs/LocalesApi.md +2 -2
  13. data/docs/SpacesApi.md +9 -9
  14. data/docs/TeamsApi.md +6 -6
  15. data/docs/UploadCreateParameters.md +1 -1
  16. data/docs/UploadsApi.md +2 -2
  17. data/lib/phrase/api/comment_reactions_api.rb +350 -0
  18. data/lib/phrase/api/job_locales_api.rb +21 -21
  19. data/lib/phrase/api/locales_api.rb +2 -2
  20. data/lib/phrase/api/spaces_api.rb +6 -6
  21. data/lib/phrase/api/teams_api.rb +4 -4
  22. data/lib/phrase/api/uploads_api.rb +2 -2
  23. data/lib/phrase/models/comment_reaction.rb +239 -0
  24. data/lib/phrase/models/distribution_create_parameters.rb +1 -1
  25. data/lib/phrase/models/gitlab_sync_history.rb +2 -2
  26. data/lib/phrase/models/gitlab_sync_history_errors.rb +203 -0
  27. data/lib/phrase/models/job_locale_update_parameters.rb +1 -1
  28. data/lib/phrase/models/job_locales_create_parameters.rb +1 -1
  29. data/lib/phrase/models/upload_create_parameters.rb +1 -1
  30. data/lib/phrase/version.rb +1 -1
  31. data/lib/phrase.rb +3 -0
  32. data/spec/api/comment_reactions_api_spec.rb +91 -0
  33. data/spec/api/job_locales_api_spec.rb +10 -10
  34. data/spec/api/locales_api_spec.rb +1 -1
  35. data/spec/api/spaces_api_spec.rb +3 -3
  36. data/spec/api/teams_api_spec.rb +2 -2
  37. data/spec/api/uploads_api_spec.rb +1 -1
  38. data/spec/models/comment_reaction_spec.rb +59 -0
  39. data/spec/models/gitlab_sync_history_errors_spec.rb +35 -0
  40. metadata +224 -211
data/docs/SpacesApi.md CHANGED
@@ -9,9 +9,9 @@ Method | HTTP request | Description
9
9
  [**space_show**](SpacesApi.md#space_show) | **GET** /accounts/{account_id}/spaces/{id} | Get Space
10
10
  [**space_update**](SpacesApi.md#space_update) | **PATCH** /accounts/{account_id}/spaces/{id} | Update Space
11
11
  [**spaces_list**](SpacesApi.md#spaces_list) | **GET** /accounts/{account_id}/spaces | List Spaces
12
- [**spaces_projects_create**](SpacesApi.md#spaces_projects_create) | **POST** /accounts/{account_id}/spaces/{space_id}/projects | Add Project
13
- [**spaces_projects_delete**](SpacesApi.md#spaces_projects_delete) | **DELETE** /accounts/{account_id}/spaces/{space_id}/projects/{id} | Remove Project
14
- [**spaces_projects_list**](SpacesApi.md#spaces_projects_list) | **GET** /accounts/{account_id}/spaces/{space_id}/projects | List Projects
12
+ [**spaces_projects_create**](SpacesApi.md#spaces_projects_create) | **POST** /accounts/{account_id}/spaces/{space_id}/projects | Add Project to Space
13
+ [**spaces_projects_delete**](SpacesApi.md#spaces_projects_delete) | **DELETE** /accounts/{account_id}/spaces/{space_id}/projects/{id} | Remove Project from Space
14
+ [**spaces_projects_list**](SpacesApi.md#spaces_projects_list) | **GET** /accounts/{account_id}/spaces/{space_id}/projects | List Projects in Space
15
15
 
16
16
 
17
17
 
@@ -337,7 +337,7 @@ Response<([**Array&lt;Space&gt;**](Space.md))>
337
337
 
338
338
  > spaces_projects_create(account_id, space_id, spaces_projects_create_parameters, opts)
339
339
 
340
- Add Project
340
+ Add Project to Space
341
341
 
342
342
  Adds an existing project to the space.
343
343
 
@@ -366,7 +366,7 @@ opts = {
366
366
  }
367
367
 
368
368
  begin
369
- #Add Project
369
+ #Add Project to Space
370
370
  api_instance.spaces_projects_create(account_id, space_id, spaces_projects_create_parameters, opts)
371
371
  rescue Phrase::ApiError => e
372
372
  puts "Exception when calling SpacesApi->spaces_projects_create: #{e}"
@@ -401,7 +401,7 @@ Response<(nil (empty response body))>
401
401
 
402
402
  > spaces_projects_delete(account_id, space_id, id, opts)
403
403
 
404
- Remove Project
404
+ Remove Project from Space
405
405
 
406
406
  Removes a specified project from the specified space.
407
407
 
@@ -430,7 +430,7 @@ opts = {
430
430
  }
431
431
 
432
432
  begin
433
- #Remove Project
433
+ #Remove Project from Space
434
434
  api_instance.spaces_projects_delete(account_id, space_id, id, opts)
435
435
  rescue Phrase::ApiError => e
436
436
  puts "Exception when calling SpacesApi->spaces_projects_delete: #{e}"
@@ -465,7 +465,7 @@ Response<(nil (empty response body))>
465
465
 
466
466
  > Array&lt;Project&gt; spaces_projects_list(account_id, space_id, opts)
467
467
 
468
- List Projects
468
+ List Projects in Space
469
469
 
470
470
  List all projects for the specified Space.
471
471
 
@@ -495,7 +495,7 @@ opts = {
495
495
  }
496
496
 
497
497
  begin
498
- #List Projects
498
+ #List Projects in Space
499
499
  result = api_instance.spaces_projects_list(account_id, space_id, opts)
500
500
  pp result
501
501
  rescue Phrase::ApiError => e
data/docs/TeamsApi.md CHANGED
@@ -9,8 +9,8 @@ Method | HTTP request | Description
9
9
  [**team_show**](TeamsApi.md#team_show) | **GET** /accounts/{account_id}/teams/{id} | Get Team
10
10
  [**team_update**](TeamsApi.md#team_update) | **PATCH** /accounts/{account_id}/teams/{id} | Update Team
11
11
  [**teams_list**](TeamsApi.md#teams_list) | **GET** /accounts/{account_id}/teams | List Teams
12
- [**teams_projects_create**](TeamsApi.md#teams_projects_create) | **POST** /accounts/{account_id}/teams/{team_id}/projects | Add Project
13
- [**teams_projects_delete**](TeamsApi.md#teams_projects_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/projects/{id} | Remove Project
12
+ [**teams_projects_create**](TeamsApi.md#teams_projects_create) | **POST** /accounts/{account_id}/teams/{team_id}/projects | Add Project to Team
13
+ [**teams_projects_delete**](TeamsApi.md#teams_projects_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/projects/{id} | Remove Project from Team
14
14
  [**teams_spaces_create**](TeamsApi.md#teams_spaces_create) | **POST** /accounts/{account_id}/teams/{team_id}/spaces | Add Space
15
15
  [**teams_spaces_delete**](TeamsApi.md#teams_spaces_delete) | **DELETE** /accounts/{account_id}/teams/{team_id}/spaces/{id} | Remove Space
16
16
  [**teams_users_create**](TeamsApi.md#teams_users_create) | **POST** /accounts/{account_id}/teams/{team_id}/users | Add User
@@ -340,7 +340,7 @@ Response<([**Array&lt;Team&gt;**](Team.md))>
340
340
 
341
341
  > teams_projects_create(account_id, team_id, teams_projects_create_parameters, opts)
342
342
 
343
- Add Project
343
+ Add Project to Team
344
344
 
345
345
  Adds an existing project to the team.
346
346
 
@@ -369,7 +369,7 @@ opts = {
369
369
  }
370
370
 
371
371
  begin
372
- #Add Project
372
+ #Add Project to Team
373
373
  api_instance.teams_projects_create(account_id, team_id, teams_projects_create_parameters, opts)
374
374
  rescue Phrase::ApiError => e
375
375
  puts "Exception when calling TeamsApi->teams_projects_create: #{e}"
@@ -404,7 +404,7 @@ Response<(nil (empty response body))>
404
404
 
405
405
  > teams_projects_delete(account_id, team_id, id, opts)
406
406
 
407
- Remove Project
407
+ Remove Project from Team
408
408
 
409
409
  Removes a specified project from the specified team.
410
410
 
@@ -433,7 +433,7 @@ opts = {
433
433
  }
434
434
 
435
435
  begin
436
- #Remove Project
436
+ #Remove Project from Team
437
437
  api_instance.teams_projects_delete(account_id, team_id, id, opts)
438
438
  rescue Phrase::ApiError => e
439
439
  puts "Exception when calling TeamsApi->teams_projects_delete: #{e}"
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
18
18
  **locale_mapping** | [**Object**](.md) | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. | [optional]
19
19
  **format_options** | [**Object**](.md) | Additional options available for specific formats. See our format guide for complete list. | [optional]
20
20
  **autotranslate** | **Boolean** | If set, translations for the uploaded language will be fetched automatically. | [optional]
21
- **mark_reviewed** | **Boolean** | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project. | [optional]
21
+ **mark_reviewed** | **Boolean** | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. | [optional]
22
22
 
23
23
  ## Code Sample
24
24
 
data/docs/UploadsApi.md CHANGED
@@ -52,7 +52,7 @@ opts = {
52
52
  locale_mapping: nil, # Object | Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.
53
53
  format_options: nil, # Object | Additional options available for specific formats. See our format guide for complete list.
54
54
  autotranslate: true, # Boolean | If set, translations for the uploaded language will be fetched automatically.
55
- mark_reviewed: true # Boolean | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project.
55
+ mark_reviewed: true # Boolean | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
56
56
  }
57
57
 
58
58
  begin
@@ -85,7 +85,7 @@ Name | Type | Description | Notes
85
85
  **locale_mapping** | [**Object**](Object.md)| Optional, format specific mapping between locale names and the columns the translations to those locales are contained in. | [optional]
86
86
  **format_options** | [**Object**](Object.md)| Additional options available for specific formats. See our format guide for complete list. | [optional]
87
87
  **autotranslate** | **Boolean**| If set, translations for the uploaded language will be fetched automatically. | [optional]
88
- **mark_reviewed** | **Boolean**| Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project. | [optional]
88
+ **mark_reviewed** | **Boolean**| Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. | [optional]
89
89
 
90
90
  ### Return type
91
91
 
@@ -0,0 +1,350 @@
1
+ require 'cgi'
2
+
3
+ module Phrase
4
+ class CommentReactionsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+ # Create a reaction
11
+ # Create a new reaction for a comment.
12
+ # @param project_id [String] Project ID
13
+ # @param key_id [String] Translation Key ID
14
+ # @param comment_id [String] Comment ID
15
+ # @param [Hash] opts the optional parameters
16
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
17
+ # @option opts [String] :branch specify the branch to use
18
+ # @return [CommentReaction]
19
+ def reaction_create(project_id, key_id, comment_id, opts = {})
20
+ data, _status_code, _headers = reaction_create_with_http_info(project_id, key_id, comment_id, opts)
21
+ data
22
+ end
23
+
24
+ # Create a reaction
25
+ # Create a new reaction for a comment.
26
+ # @param project_id [String] Project ID
27
+ # @param key_id [String] Translation Key ID
28
+ # @param comment_id [String] Comment ID
29
+ # @param [Hash] opts the optional parameters
30
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
31
+ # @option opts [String] :branch specify the branch to use
32
+ # @return [Array<(Response<(CommentReaction)>, Integer, Hash)>] Response<(CommentReaction)> data, response status code and response headers
33
+ def reaction_create_with_http_info(project_id, key_id, comment_id, opts = {})
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: CommentReactionsApi.reaction_create ...'
36
+ end
37
+ # verify the required parameter 'project_id' is set
38
+ if @api_client.config.client_side_validation && project_id.nil?
39
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentReactionsApi.reaction_create"
40
+ end
41
+ # verify the required parameter 'key_id' is set
42
+ if @api_client.config.client_side_validation && key_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentReactionsApi.reaction_create"
44
+ end
45
+ # verify the required parameter 'comment_id' is set
46
+ if @api_client.config.client_side_validation && comment_id.nil?
47
+ fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentReactionsApi.reaction_create"
48
+ end
49
+ # resource path
50
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'comment_id' + '}', CGI.escape(comment_id.to_s))
51
+
52
+ # query parameters
53
+ query_params = opts[:query_params] || {}
54
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
55
+
56
+ # header parameters
57
+ header_params = opts[:header_params] || {}
58
+ # HTTP header 'Accept' (if needed)
59
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
60
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
61
+
62
+ # form parameters
63
+ form_params = opts[:form_params] || {}
64
+
65
+ # http body (model)
66
+ post_body = opts[:body]
67
+
68
+ # return_type
69
+ return_type = opts[:return_type] || 'CommentReaction'
70
+
71
+ # auth_names
72
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
73
+
74
+ new_options = opts.merge(
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: CommentReactionsApi#reaction_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ response = ::Phrase::Response.new(data, headers)
88
+ return response, status_code, headers
89
+ end
90
+
91
+ # Delete a reaction
92
+ # Delete an existing reaction.
93
+ # @param project_id [String] Project ID
94
+ # @param key_id [String] Translation Key ID
95
+ # @param comment_id [String] Comment ID
96
+ # @param id [String] ID
97
+ # @param [Hash] opts the optional parameters
98
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
99
+ # @option opts [String] :branch specify the branch to use
100
+ # @return [nil]
101
+ def reaction_delete(project_id, key_id, comment_id, id, opts = {})
102
+ data, _status_code, _headers = reaction_delete_with_http_info(project_id, key_id, comment_id, id, opts)
103
+ data
104
+ end
105
+
106
+ # Delete a reaction
107
+ # Delete an existing reaction.
108
+ # @param project_id [String] Project ID
109
+ # @param key_id [String] Translation Key ID
110
+ # @param comment_id [String] Comment ID
111
+ # @param id [String] ID
112
+ # @param [Hash] opts the optional parameters
113
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
114
+ # @option opts [String] :branch specify the branch to use
115
+ # @return [Array<(Response, Integer, Hash)>] Response<(nil, response status code and response headers
116
+ def reaction_delete_with_http_info(project_id, key_id, comment_id, id, opts = {})
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug 'Calling API: CommentReactionsApi.reaction_delete ...'
119
+ end
120
+ # verify the required parameter 'project_id' is set
121
+ if @api_client.config.client_side_validation && project_id.nil?
122
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentReactionsApi.reaction_delete"
123
+ end
124
+ # verify the required parameter 'key_id' is set
125
+ if @api_client.config.client_side_validation && key_id.nil?
126
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentReactionsApi.reaction_delete"
127
+ end
128
+ # verify the required parameter 'comment_id' is set
129
+ if @api_client.config.client_side_validation && comment_id.nil?
130
+ fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentReactionsApi.reaction_delete"
131
+ end
132
+ # verify the required parameter 'id' is set
133
+ if @api_client.config.client_side_validation && id.nil?
134
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommentReactionsApi.reaction_delete"
135
+ end
136
+ # resource path
137
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'comment_id' + '}', CGI.escape(comment_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
138
+
139
+ # query parameters
140
+ query_params = opts[:query_params] || {}
141
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
142
+
143
+ # header parameters
144
+ header_params = opts[:header_params] || {}
145
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
146
+
147
+ # form parameters
148
+ form_params = opts[:form_params] || {}
149
+
150
+ # http body (model)
151
+ post_body = opts[:body]
152
+
153
+ # return_type
154
+ return_type = opts[:return_type]
155
+
156
+ # auth_names
157
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
158
+
159
+ new_options = opts.merge(
160
+ :header_params => header_params,
161
+ :query_params => query_params,
162
+ :form_params => form_params,
163
+ :body => post_body,
164
+ :auth_names => auth_names,
165
+ :return_type => return_type
166
+ )
167
+
168
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
169
+ if @api_client.config.debugging
170
+ @api_client.config.logger.debug "API called: CommentReactionsApi#reaction_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
171
+ end
172
+ response = ::Phrase::Response.new(data, headers)
173
+ return response, status_code, headers
174
+ end
175
+
176
+ # Get a single reaction
177
+ # Get details on a single reaction.
178
+ # @param project_id [String] Project ID
179
+ # @param key_id [String] Translation Key ID
180
+ # @param comment_id [String] Comment ID
181
+ # @param id [String] ID
182
+ # @param [Hash] opts the optional parameters
183
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
184
+ # @option opts [String] :branch specify the branch to use
185
+ # @return [CommentReaction]
186
+ def reaction_show(project_id, key_id, comment_id, id, opts = {})
187
+ data, _status_code, _headers = reaction_show_with_http_info(project_id, key_id, comment_id, id, opts)
188
+ data
189
+ end
190
+
191
+ # Get a single reaction
192
+ # Get details on a single reaction.
193
+ # @param project_id [String] Project ID
194
+ # @param key_id [String] Translation Key ID
195
+ # @param comment_id [String] Comment ID
196
+ # @param id [String] ID
197
+ # @param [Hash] opts the optional parameters
198
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
199
+ # @option opts [String] :branch specify the branch to use
200
+ # @return [Array<(Response<(CommentReaction)>, Integer, Hash)>] Response<(CommentReaction)> data, response status code and response headers
201
+ def reaction_show_with_http_info(project_id, key_id, comment_id, id, opts = {})
202
+ if @api_client.config.debugging
203
+ @api_client.config.logger.debug 'Calling API: CommentReactionsApi.reaction_show ...'
204
+ end
205
+ # verify the required parameter 'project_id' is set
206
+ if @api_client.config.client_side_validation && project_id.nil?
207
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentReactionsApi.reaction_show"
208
+ end
209
+ # verify the required parameter 'key_id' is set
210
+ if @api_client.config.client_side_validation && key_id.nil?
211
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentReactionsApi.reaction_show"
212
+ end
213
+ # verify the required parameter 'comment_id' is set
214
+ if @api_client.config.client_side_validation && comment_id.nil?
215
+ fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentReactionsApi.reaction_show"
216
+ end
217
+ # verify the required parameter 'id' is set
218
+ if @api_client.config.client_side_validation && id.nil?
219
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommentReactionsApi.reaction_show"
220
+ end
221
+ # resource path
222
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'comment_id' + '}', CGI.escape(comment_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
223
+
224
+ # query parameters
225
+ query_params = opts[:query_params] || {}
226
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
227
+
228
+ # header parameters
229
+ header_params = opts[:header_params] || {}
230
+ # HTTP header 'Accept' (if needed)
231
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
232
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
233
+
234
+ # form parameters
235
+ form_params = opts[:form_params] || {}
236
+
237
+ # http body (model)
238
+ post_body = opts[:body]
239
+
240
+ # return_type
241
+ return_type = opts[:return_type] || 'CommentReaction'
242
+
243
+ # auth_names
244
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
245
+
246
+ new_options = opts.merge(
247
+ :header_params => header_params,
248
+ :query_params => query_params,
249
+ :form_params => form_params,
250
+ :body => post_body,
251
+ :auth_names => auth_names,
252
+ :return_type => return_type
253
+ )
254
+
255
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
256
+ if @api_client.config.debugging
257
+ @api_client.config.logger.debug "API called: CommentReactionsApi#reaction_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
258
+ end
259
+ response = ::Phrase::Response.new(data, headers)
260
+ return response, status_code, headers
261
+ end
262
+
263
+ # List reactions
264
+ # List all reactions for a comment.
265
+ # @param project_id [String] Project ID
266
+ # @param key_id [String] Translation Key ID
267
+ # @param comment_id [String] Comment ID
268
+ # @param [Hash] opts the optional parameters
269
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
270
+ # @option opts [Integer] :page Page number
271
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
272
+ # @option opts [String] :branch specify the branch to use
273
+ # @return [Array<CommentReaction>]
274
+ def reactions_list(project_id, key_id, comment_id, opts = {})
275
+ data, _status_code, _headers = reactions_list_with_http_info(project_id, key_id, comment_id, opts)
276
+ data
277
+ end
278
+
279
+ # List reactions
280
+ # List all reactions for a comment.
281
+ # @param project_id [String] Project ID
282
+ # @param key_id [String] Translation Key ID
283
+ # @param comment_id [String] Comment ID
284
+ # @param [Hash] opts the optional parameters
285
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
286
+ # @option opts [Integer] :page Page number
287
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
288
+ # @option opts [String] :branch specify the branch to use
289
+ # @return [Array<(Response<(Array<CommentReaction>)>, Integer, Hash)>] Response<(Array<CommentReaction>)> data, response status code and response headers
290
+ def reactions_list_with_http_info(project_id, key_id, comment_id, opts = {})
291
+ if @api_client.config.debugging
292
+ @api_client.config.logger.debug 'Calling API: CommentReactionsApi.reactions_list ...'
293
+ end
294
+ # verify the required parameter 'project_id' is set
295
+ if @api_client.config.client_side_validation && project_id.nil?
296
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentReactionsApi.reactions_list"
297
+ end
298
+ # verify the required parameter 'key_id' is set
299
+ if @api_client.config.client_side_validation && key_id.nil?
300
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentReactionsApi.reactions_list"
301
+ end
302
+ # verify the required parameter 'comment_id' is set
303
+ if @api_client.config.client_side_validation && comment_id.nil?
304
+ fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentReactionsApi.reactions_list"
305
+ end
306
+ # resource path
307
+ local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'comment_id' + '}', CGI.escape(comment_id.to_s))
308
+
309
+ # query parameters
310
+ query_params = opts[:query_params] || {}
311
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
312
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
313
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
314
+
315
+ # header parameters
316
+ header_params = opts[:header_params] || {}
317
+ # HTTP header 'Accept' (if needed)
318
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
319
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
320
+
321
+ # form parameters
322
+ form_params = opts[:form_params] || {}
323
+
324
+ # http body (model)
325
+ post_body = opts[:body]
326
+
327
+ # return_type
328
+ return_type = opts[:return_type] || 'Array<CommentReaction>'
329
+
330
+ # auth_names
331
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
332
+
333
+ new_options = opts.merge(
334
+ :header_params => header_params,
335
+ :query_params => query_params,
336
+ :form_params => form_params,
337
+ :body => post_body,
338
+ :auth_names => auth_names,
339
+ :return_type => return_type
340
+ )
341
+
342
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
343
+ if @api_client.config.debugging
344
+ @api_client.config.logger.debug "API called: CommentReactionsApi#reactions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
345
+ end
346
+ response = ::Phrase::Response.new(data, headers)
347
+ return response, status_code, headers
348
+ end
349
+ end
350
+ end
@@ -179,8 +179,8 @@ module Phrase
179
179
  return response, status_code, headers
180
180
  end
181
181
 
182
- # Delete a job locale
183
- # Delete an existing job locale.
182
+ # Remove a target locale from a job
183
+ # Removes a target locale from a job.
184
184
  # @param project_id [String] Project ID
185
185
  # @param job_id [String] Job ID
186
186
  # @param id [String] ID
@@ -193,8 +193,8 @@ module Phrase
193
193
  data
194
194
  end
195
195
 
196
- # Delete a job locale
197
- # Delete an existing job locale.
196
+ # Remove a target locale from a job
197
+ # Removes a target locale from a job.
198
198
  # @param project_id [String] Project ID
199
199
  # @param job_id [String] Job ID
200
200
  # @param id [String] ID
@@ -344,8 +344,8 @@ module Phrase
344
344
  return response, status_code, headers
345
345
  end
346
346
 
347
- # Get a single job locale
348
- # Get a single job locale for a given job.
347
+ # Show single job target locale
348
+ # Get a single target locale for a given job.
349
349
  # @param project_id [String] Project ID
350
350
  # @param job_id [String] Job ID
351
351
  # @param id [String] ID
@@ -358,8 +358,8 @@ module Phrase
358
358
  data
359
359
  end
360
360
 
361
- # Get a single job locale
362
- # Get a single job locale for a given job.
361
+ # Show single job target locale
362
+ # Get a single target locale for a given job.
363
363
  # @param project_id [String] Project ID
364
364
  # @param job_id [String] Job ID
365
365
  # @param id [String] ID
@@ -384,7 +384,7 @@ module Phrase
384
384
  fail ArgumentError, "Missing the required parameter 'id' when calling JobLocalesApi.job_locale_show"
385
385
  end
386
386
  # resource path
387
- local_var_path = '/projects/{project_id}/jobs/{job_id}/locale/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
387
+ local_var_path = '/projects/{project_id}/jobs/{job_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
388
388
 
389
389
  # query parameters
390
390
  query_params = opts[:query_params] || {}
@@ -425,8 +425,8 @@ module Phrase
425
425
  return response, status_code, headers
426
426
  end
427
427
 
428
- # Update a job locale
429
- # Update an existing job locale.
428
+ # Update a job target locale
429
+ # Update an existing job target locale.
430
430
  # @param project_id [String] Project ID
431
431
  # @param job_id [String] Job ID
432
432
  # @param id [String] ID
@@ -439,8 +439,8 @@ module Phrase
439
439
  data
440
440
  end
441
441
 
442
- # Update a job locale
443
- # Update an existing job locale.
442
+ # Update a job target locale
443
+ # Update an existing job target locale.
444
444
  # @param project_id [String] Project ID
445
445
  # @param job_id [String] Job ID
446
446
  # @param id [String] ID
@@ -511,8 +511,8 @@ module Phrase
511
511
  return response, status_code, headers
512
512
  end
513
513
 
514
- # Create a job locale
515
- # Create a new job locale.
514
+ # Add a target locale to a job
515
+ # Adds a target locale to a job.
516
516
  # @param project_id [String] Project ID
517
517
  # @param job_id [String] Job ID
518
518
  # @param job_locales_create_parameters [JobLocalesCreateParameters]
@@ -524,8 +524,8 @@ module Phrase
524
524
  data
525
525
  end
526
526
 
527
- # Create a job locale
528
- # Create a new job locale.
527
+ # Add a target locale to a job
528
+ # Adds a target locale to a job.
529
529
  # @param project_id [String] Project ID
530
530
  # @param job_id [String] Job ID
531
531
  # @param job_locales_create_parameters [JobLocalesCreateParameters]
@@ -591,8 +591,8 @@ module Phrase
591
591
  return response, status_code, headers
592
592
  end
593
593
 
594
- # List job locales
595
- # List all job locales for a given job.
594
+ # List job target locales
595
+ # List all target locales for a given job.
596
596
  # @param project_id [String] Project ID
597
597
  # @param job_id [String] Job ID
598
598
  # @param [Hash] opts the optional parameters
@@ -606,8 +606,8 @@ module Phrase
606
606
  data
607
607
  end
608
608
 
609
- # List job locales
610
- # List all job locales for a given job.
609
+ # List job target locales
610
+ # List all target locales for a given job.
611
611
  # @param project_id [String] Project ID
612
612
  # @param job_id [String] Job ID
613
613
  # @param [Hash] opts the optional parameters
@@ -247,7 +247,7 @@ module Phrase
247
247
  # @option opts [String] :encoding 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;.
248
248
  # @option opts [Boolean] :skip_unverified_translations 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;.
249
249
  # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
250
- # @option opts [Boolean] :use_last_reviewed_version 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.
250
+ # @option opts [Boolean] :use_last_reviewed_version 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.
251
251
  # @option opts [String] :fallback_locale_id 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;.
252
252
  # @option opts [String] :source_locale_id 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.
253
253
  # @return [File]
@@ -277,7 +277,7 @@ module Phrase
277
277
  # @option opts [String] :encoding 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;.
278
278
  # @option opts [Boolean] :skip_unverified_translations 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;.
279
279
  # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
280
- # @option opts [Boolean] :use_last_reviewed_version 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.
280
+ # @option opts [Boolean] :use_last_reviewed_version 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.
281
281
  # @option opts [String] :fallback_locale_id 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;.
282
282
  # @option opts [String] :source_locale_id 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.
283
283
  # @return [Array<(Response<(File)>, Integer, Hash)>] Response<(File)> data, response status code and response headers