Class: Phrase::CommentReactionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CommentReactionsApi

Returns a new instance of CommentReactionsApi.



7
8
9
 
# File 'lib/phrase/api/comment_reactions_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/comment_reactions_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#reaction_create(project_id, key_id, comment_id, opts = {}) ⇒ CommentReaction

Create a reaction Create a new reaction for a comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_id (String) —

    Comment 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

  • :emoji (String) —

    specify the emoji for the reaction

Returns:



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

def reaction_create(project_id, key_id, comment_id, opts = {})
  data, _status_code, _headers = reaction_create_with_http_info(project_id, key_id, comment_id, opts)
  data
end

#reaction_create_with_http_info(project_id, key_id, comment_id, opts = {}) ⇒ Array<(Response<(CommentReaction)>, Integer, Hash)>

Create a reaction Create a new reaction for a comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_id (String) —

    Comment 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

  • :emoji (String) —

    specify the emoji for the reaction

Returns:

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

    Response<(CommentReaction)> 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
 
# File 'lib/phrase/api/comment_reactions_api.rb', line 35

def reaction_create_with_http_info(project_id, key_id, comment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentReactionsApi.reaction_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 CommentReactionsApi.reaction_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 CommentReactionsApi.reaction_create"
  end
  # verify the required parameter 'comment_id' is set
  if @api_client.config.client_side_validation && comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentReactionsApi.reaction_create"
  end
  # resource path
  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))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
  query_params[:'emoji'] = opts[:'emoji'] if !opts[:'emoji'].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] || 'CommentReaction' 

  # 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: CommentReactionsApi#reaction_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

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

Delete a reaction Delete an existing reaction.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_id (String) —

    Comment 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) 


104
105
106
107
 
# File 'lib/phrase/api/comment_reactions_api.rb', line 104

def reaction_delete(project_id, key_id, comment_id, id, opts = {})
  data, _status_code, _headers = reaction_delete_with_http_info(project_id, key_id, comment_id, id, opts)
  data
end

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

Delete a reaction Delete an existing reaction.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_id (String) —

    Comment 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
174
175
176
177
 
# File 'lib/phrase/api/comment_reactions_api.rb', line 119

def reaction_delete_with_http_info(project_id, key_id, comment_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentReactionsApi.reaction_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 CommentReactionsApi.reaction_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 CommentReactionsApi.reaction_delete"
  end
  # verify the required parameter 'comment_id' is set
  if @api_client.config.client_side_validation && comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentReactionsApi.reaction_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 CommentReactionsApi.reaction_delete"
  end
  # resource path
  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))

  # 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: CommentReactionsApi#reaction_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#reaction_show(project_id, key_id, comment_id, id, opts = {}) ⇒ CommentReaction

Get a single reaction Get details on a single reaction.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_id (String) —

    Comment 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:



189
190
191
192
 
# File 'lib/phrase/api/comment_reactions_api.rb', line 189

def reaction_show(project_id, key_id, comment_id, id, opts = {})
  data, _status_code, _headers = reaction_show_with_http_info(project_id, key_id, comment_id, id, opts)
  data
end

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

Get a single reaction Get details on a single reaction.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_id (String) —

    Comment 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<(CommentReaction)>, Integer, Hash)>) —

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



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
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/phrase/api/comment_reactions_api.rb', line 204

def reaction_show_with_http_info(project_id, key_id, comment_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentReactionsApi.reaction_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 CommentReactionsApi.reaction_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 CommentReactionsApi.reaction_show"
  end
  # verify the required parameter 'comment_id' is set
  if @api_client.config.client_side_validation && comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentReactionsApi.reaction_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 CommentReactionsApi.reaction_show"
  end
  # resource path
  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))

  # 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] || 'CommentReaction' 

  # 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: CommentReactionsApi#reaction_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end

#reactions_list(project_id, key_id, comment_id, opts = {}) ⇒ Array<CommentReaction>

List reactions List all reactions for a comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_id (String) —

    Comment ID

  • 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

Returns:



277
278
279
280
 
# File 'lib/phrase/api/comment_reactions_api.rb', line 277

def reactions_list(project_id, key_id, comment_id, opts = {})
  data, _status_code, _headers = reactions_list_with_http_info(project_id, key_id, comment_id, opts)
  data
end

#reactions_list_with_http_info(project_id, key_id, comment_id, opts = {}) ⇒ Array<(Response<(Array<CommentReaction>)>, Integer, Hash)>

List reactions List all reactions for a comment.

Parameters:

  • project_id (String) —

    Project ID

  • key_id (String) —

    Translation Key ID

  • comment_id (String) —

    Comment ID

  • 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

Returns:

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

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



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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/phrase/api/comment_reactions_api.rb', line 293

def reactions_list_with_http_info(project_id, key_id, comment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CommentReactionsApi.reactions_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 CommentReactionsApi.reactions_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 CommentReactionsApi.reactions_list"
  end
  # verify the required parameter 'comment_id' is set
  if @api_client.config.client_side_validation && comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'comment_id' when calling CommentReactionsApi.reactions_list"
  end
  # resource path
  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))

  # 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?

  # 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] || 'Array<CommentReaction>' 

  # 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: CommentReactionsApi#reactions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  response = ::Phrase::Response.new(data, headers)
  return response, status_code, headers
end