Class: Phrase::CommentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phrase/api/comments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CommentsApi

Returns a new instance of CommentsApi.



7
8
9
 
# File 'lib/phrase/api/comments_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/phrase/api/comments_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#comment_create(project_id, key_id, comment_create_parameters, opts = {}) ⇒ Comment

Create a comment Create a new comment for a key.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_create_parameters (CommentCreateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :message (String) —

    specify the message for the comment

  • :locale_ids (Array<String>) —

    specify the locales for the comment

Returns:



20
21
22
23
 
# File 'lib/phrase/api/comments_api.rb', line 20

def comment_create(project_id, key_id, comment_create_parameters, opts = {})
  data, _status_code, _headers = comment_create_with_http_info(project_id, key_id, comment_create_parameters, opts)
  data
end

#comment_create_with_http_info(project_id, key_id, comment_create_parameters, opts = {}) ⇒ Array<(Response<(Comment)>, Integer, Hash)>

Create a comment Create a new comment for a key.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_create_parameters (CommentCreateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :message (String) —

    specify the message for the comment

  • :locale_ids (Array<String>) —

    specify the locales for the comment

Returns:

  • (Array<(Response<(Comment)>, Integer, Hash)>) —

    Response<(Comment)> data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/phrase/api/comments_api.rb', line 35

def comment_create_with_http_info(project_id, key_id, comment_create_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentsApi.comment_create ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_create"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_create"
  end
  # verify the required parameter 'comment_create_parameters' is set
  if @api_client.config.client_side_validation && comment_create_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'comment_create_parameters' when calling CommentsApi.comment_create"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'message'] = opts[:'message'] if !opts[:'message'].nil?
  query_params[:'locale_ids'] = @api_client.build_collection_param(opts[:'locale_ids'], :multi) if !opts[:'locale_ids'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(comment_create_parameters) 

  # return_type
  return_type = opts[:return_type] || 'Comment' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#comment_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#comment_delete(project_id, key_id, id, opts = {}) ⇒ nil

Delete a comment Delete an existing comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (nil) 


105
106
107
108
 
# File 'lib/phrase/api/comments_api.rb', line 105

def comment_delete(project_id, key_id, id, opts = {})
  data, _status_code, _headers = comment_delete_with_http_info(project_id, key_id, id, opts)
  data
end

#comment_delete_with_http_info(project_id, key_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Delete a comment Delete an existing comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response, Integer, Hash)>) —

    Response<(nil, response status code and response headers



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/phrase/api/comments_api.rb', line 119

def comment_delete_with_http_info(project_id, key_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentsApi.comment_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_delete"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_delete"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#comment_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#comment_mark_check(project_id, key_id, id, opts = {}) ⇒ nil

Check if comment is read Check if comment was marked as read. Returns 204 if read, 404 if unread.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (nil) 


184
185
186
187
 
# File 'lib/phrase/api/comments_api.rb', line 184

def comment_mark_check(project_id, key_id, id, opts = {})
  data, _status_code, _headers = comment_mark_check_with_http_info(project_id, key_id, id, opts)
  data
end

#comment_mark_check_with_http_info(project_id, key_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Check if comment is read Check if comment was marked as read. Returns 204 if read, 404 if unread.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response, Integer, Hash)>) —

    Response<(nil, response status code and response headers



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/phrase/api/comments_api.rb', line 198

def comment_mark_check_with_http_info(project_id, key_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentsApi.comment_mark_check ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_mark_check"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_mark_check"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_mark_check"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}/read'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#comment_mark_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#comment_mark_read(project_id, key_id, id, comment_mark_read_parameters, opts = {}) ⇒ nil

Mark a comment as read Mark a comment as read.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • comment_mark_read_parameters (CommentMarkReadParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (nil) 


263
264
265
266
 
# File 'lib/phrase/api/comments_api.rb', line 263

def comment_mark_read(project_id, key_id, id, comment_mark_read_parameters, opts = {})
  data, _status_code, _headers = comment_mark_read_with_http_info(project_id, key_id, id, comment_mark_read_parameters, opts)
  data
end

#comment_mark_read_with_http_info(project_id, key_id, id, comment_mark_read_parameters, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Mark a comment as read Mark a comment as read.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • comment_mark_read_parameters (CommentMarkReadParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response, Integer, Hash)>) —

    Response<(nil, response status code and response headers



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/phrase/api/comments_api.rb', line 277

def comment_mark_read_with_http_info(project_id, key_id, id, comment_mark_read_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentsApi.comment_mark_read ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_mark_read"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_mark_read"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_mark_read"
  end
  # verify the required parameter 'comment_mark_read_parameters' is set
  if @api_client.config.client_side_validation && comment_mark_read_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'comment_mark_read_parameters' when calling CommentsApi.comment_mark_read"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}/read'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(comment_mark_read_parameters) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#comment_mark_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#comment_mark_unread(project_id, key_id, id, opts = {}) ⇒ nil

Mark a comment as unread Mark a comment as unread.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (nil) 


347
348
349
350
 
# File 'lib/phrase/api/comments_api.rb', line 347

def comment_mark_unread(project_id, key_id, id, opts = {})
  data, _status_code, _headers = comment_mark_unread_with_http_info(project_id, key_id, id, opts)
  data
end

#comment_mark_unread_with_http_info(project_id, key_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Mark a comment as unread Mark a comment as unread.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response, Integer, Hash)>) —

    Response<(nil, response status code and response headers



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/phrase/api/comments_api.rb', line 361

def comment_mark_unread_with_http_info(project_id, key_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentsApi.comment_mark_unread ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_mark_unread"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_mark_unread"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_mark_unread"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}/read'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#comment_mark_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#comment_show(project_id, key_id, id, opts = {}) ⇒ Comment

Get a single comment Get details on a single comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:



426
427
428
429
 
# File 'lib/phrase/api/comments_api.rb', line 426

def comment_show(project_id, key_id, id, opts = {})
  data, _status_code, _headers = comment_show_with_http_info(project_id, key_id, id, opts)
  data
end

#comment_show_with_http_info(project_id, key_id, id, opts = {}) ⇒ Array<(Response<(Comment)>, Integer, Hash)>

Get a single comment Get details on a single comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :branch (String) —

    specify the branch to use

Returns:

  • (Array<(Response<(Comment)>, Integer, Hash)>) —

    Response<(Comment)> data, response status code and response headers



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/phrase/api/comments_api.rb', line 440

def comment_show_with_http_info(project_id, key_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentsApi.comment_show ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_show"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_show"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_show"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Comment' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#comment_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#comment_update(project_id, key_id, id, comment_update_parameters, opts = {}) ⇒ Comment

Update a comment Update an existing comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • comment_update_parameters (CommentUpdateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:



507
508
509
510
 
# File 'lib/phrase/api/comments_api.rb', line 507

def comment_update(project_id, key_id, id, comment_update_parameters, opts = {})
  data, _status_code, _headers = comment_update_with_http_info(project_id, key_id, id, comment_update_parameters, opts)
  data
end

#comment_update_with_http_info(project_id, key_id, id, comment_update_parameters, opts = {}) ⇒ Array<(Response<(Comment)>, Integer, Hash)>

Update a comment Update an existing comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • id (String) —

    ID

  • comment_update_parameters (CommentUpdateParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

Returns:

  • (Array<(Response<(Comment)>, Integer, Hash)>) —

    Response<(Comment)> data, response status code and response headers



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/phrase/api/comments_api.rb', line 521

def comment_update_with_http_info(project_id, key_id, id, comment_update_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentsApi.comment_update ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comment_update"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comment_update"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CommentsApi.comment_update"
  end
  # verify the required parameter 'comment_update_parameters' is set
  if @api_client.config.client_side_validation && comment_update_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'comment_update_parameters' when calling CommentsApi.comment_update"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(comment_update_parameters) 

  # return_type
  return_type = opts[:return_type] || 'Comment' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#comment_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#comments_list(project_id, key_id, comments_list_parameters, opts = {}) ⇒ Array<Comment>

List comments List all comments for a key.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comments_list_parameters (CommentsListParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

  • :branch (String) —

    specify the branch to use

  • :query (String) —

    Search query for comment messages

  • :locale_ids (Array<String>) —

    Search comments by their assigned locales

  • :filters (Array<String>) —

    Specify the filter for the comments

  • :order (String) —

    Order direction. Can be one of: asc, desc.

Returns:



599
600
601
602
 
# File 'lib/phrase/api/comments_api.rb', line 599

def comments_list(project_id, key_id, comments_list_parameters, opts = {})
  data, _status_code, _headers = comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts)
  data
end

#comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts = {}) ⇒ Array<(Response<(Array<Comment>)>, Integer, Hash)>

List comments List all comments for a key.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comments_list_parameters (CommentsListParameters)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :x_phrase_app_otp (String) —

    Two-Factor-Authentication token (optional)

  • :page (Integer) —

    Page number

  • :per_page (Integer) —

    Limit on the number of objects to be returned, between 1 and 100. 25 by default

  • :branch (String) —

    specify the branch to use

  • :query (String) —

    Search query for comment messages

  • :locale_ids (Array<String>) —

    Search comments by their assigned locales

  • :filters (Array<String>) —

    Specify the filter for the comments

  • :order (String) —

    Order direction. Can be one of: asc, desc.

Returns:

  • (Array<(Response<(Array<Comment>)>, Integer, Hash)>) —

    Response<(Array<Comment>)> data, response status code and response headers



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/phrase/api/comments_api.rb', line 619

def comments_list_with_http_info(project_id, key_id, comments_list_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentsApi.comments_list ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling CommentsApi.comments_list"
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CommentsApi.comments_list"
  end
  # verify the required parameter 'comments_list_parameters' is set
  if @api_client.config.client_side_validation && comments_list_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'comments_list_parameters' when calling CommentsApi.comments_list"
  end
  # resource path
  local_var_path = '/projects/{project_id}/keys/{key_id}/comments'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'locale_ids'] = @api_client.build_collection_param(opts[:'locale_ids'], :multi) if !opts[:'locale_ids'].nil?
  query_params[:'filters'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(comments_list_parameters) 

  # return_type
  return_type = opts[:return_type] || 'Array<Comment>' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic', 'Token']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CommentsApi#comments_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end