Class: WhiteLabelMachineName::RefundCommentService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RefundCommentService

Returns a new instance of RefundCommentService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#all(space_id, refund_id, opts = {}) ⇒ Array<RefundComment>

Find by refund Returns all comments of the given refund.

Parameters:

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

    the optional parameters

Returns:



34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 34

def all(space_id, refund_id, opts = {})
  data, _status_code, _headers = all_with_http_info(space_id, refund_id, opts)
  return data
end

#all_with_http_info(space_id, refund_id, opts = {}) ⇒ Array<(Array<RefundComment>, Fixnum, Hash)>

Find by refund Returns all comments of the given refund.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<RefundComment>, Fixnum, Hash)>) —

    Array<RefundComment> data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 45

def all_with_http_info(space_id, refund_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundCommentService.all ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundCommentService.all" if space_id.nil?
  # verify the required parameter 'refund_id' is set
  fail ArgumentError, "Missing the required parameter 'refund_id' when calling RefundCommentService.all" if refund_id.nil?
  # resource path
  local_var_path = "/refund-comment/all".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'refundId'] = refund_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<RefundComment>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundCommentService#all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(space_id, entity, opts = {}) ⇒ RefundComment

Create Creates the comment with the given properties.

Parameters:

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 97

def create(space_id, entity, opts = {})
  data, _status_code, _headers = create_with_http_info(space_id, entity, opts)
  return data
end

#create_with_http_info(space_id, entity, opts = {}) ⇒ Array<(RefundComment, Fixnum, Hash)>

Create Creates the comment with the given properties.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(RefundComment, Fixnum, Hash)>) —

    RefundComment data, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 108

def create_with_http_info(space_id, entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundCommentService.create ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundCommentService.create" if space_id.nil?
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling RefundCommentService.create" if entity.nil?
  # resource path
  local_var_path = "/refund-comment/create".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(entity)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RefundComment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundCommentService#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(space_id, id, opts = {}) ⇒ nil

Delete Deletes the comment with the given id.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


159
160
161
162
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 159

def delete(space_id, id, opts = {})
  delete_with_http_info(space_id, id, opts)
  return nil
end

#delete_with_http_info(space_id, id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Deletes the comment with the given id.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 170

def delete_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundCommentService.delete ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundCommentService.delete" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling RefundCommentService.delete" if id.nil?
  # resource path
  local_var_path = "/refund-comment/delete".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundCommentService#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#pin(space_id, id, opts = {}) ⇒ nil

Pin Pins the comment to the top.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


221
222
223
224
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 221

def pin(space_id, id, opts = {})
  pin_with_http_info(space_id, id, opts)
  return nil
end

#pin_with_http_info(space_id, id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Pin Pins the comment to the top.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 232

def pin_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundCommentService.pin ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundCommentService.pin" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling RefundCommentService.pin" if id.nil?
  # resource path
  local_var_path = "/refund-comment/pin".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundCommentService#pin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(space_id, id, opts = {}) ⇒ RefundComment

Read Reads the comment with the given ‘id’ and returns it.

Parameters:

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

    the optional parameters

Returns:



283
284
285
286
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 283

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(RefundComment, Fixnum, Hash)>

Read Reads the comment with the given &#39;id&#39; and returns it.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(RefundComment, Fixnum, Hash)>) —

    RefundComment data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 294

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundCommentService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundCommentService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling RefundCommentService.read" if id.nil?
  # resource path
  local_var_path = "/refund-comment/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RefundComment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundCommentService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unpin(space_id, id, opts = {}) ⇒ nil

Unpin Unpins the comment from the top.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


346
347
348
349
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 346

def unpin(space_id, id, opts = {})
  unpin_with_http_info(space_id, id, opts)
  return nil
end

#unpin_with_http_info(space_id, id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Unpin Unpins the comment from the top.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



357
358
359
360
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 357

def unpin_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundCommentService.unpin ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundCommentService.unpin" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling RefundCommentService.unpin" if id.nil?
  # resource path
  local_var_path = "/refund-comment/unpin".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundCommentService#unpin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(space_id, entity, opts = {}) ⇒ RefundComment

Update This updates the comment with the given properties. Only those properties which should be updated can be provided. The ‘id’ and ‘version’ are required to identify the comment.

Parameters:

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

    the optional parameters

Returns:



408
409
410
411
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 408

def update(space_id, entity, opts = {})
  data, _status_code, _headers = update_with_http_info(space_id, entity, opts)
  return data
end

#update_with_http_info(space_id, entity, opts = {}) ⇒ Array<(RefundComment, Fixnum, Hash)>

Update This updates the comment with the given properties. Only those properties which should be updated can be provided. The &#39;id&#39; and &#39;version&#39; are required to identify the comment.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(RefundComment, Fixnum, Hash)>) —

    RefundComment data, response status code and response headers



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_comment_service_api.rb', line 419

def update_with_http_info(space_id, entity, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RefundCommentService.update ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundCommentService.update" if space_id.nil?
  # verify the required parameter 'entity' is set
  fail ArgumentError, "Missing the required parameter 'entity' when calling RefundCommentService.update" if entity.nil?
  # resource path
  local_var_path = "/refund-comment/update".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(entity)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RefundComment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RefundCommentService#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end