Class: KoronaCloudClient::PaymentMethodCategoriesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/api/payment_method_categories_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentMethodCategoriesApi

Returns a new instance of PaymentMethodCategoriesApi.



19
20
21
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_payment_method_categories(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new payment method categories

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<PaymentMethodCategory>) —

    array of new payment method categories

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

    the optional parameters

Options Hash (opts):

  • :upsert (Boolean) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:



28
29
30
31
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 28

def add_payment_method_categories(, body, opts = {})
  data, _status_code, _headers = add_payment_method_categories_with_http_info(, body, opts)
  data
end

#add_payment_method_categories_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

adds a batch of new payment method categories

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<PaymentMethodCategory>) —

    array of new payment method categories

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

    the optional parameters

Options Hash (opts):

  • :upsert (Boolean) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:

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

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



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
95
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 39

def add_payment_method_categories_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodCategoriesApi.add_payment_method_categories ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PaymentMethodCategoriesApi.add_payment_method_categories"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PaymentMethodCategoriesApi.add_payment_method_categories"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/paymentMethodCategories'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"PaymentMethodCategoriesApi.add_payment_method_categories",
    :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: PaymentMethodCategoriesApi#add_payment_method_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_payment_method_categories(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

deletes a batch of payment method categories

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<PaymentMethodCategory>) —

    array of existing payment method categories (id or number required)

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 102

def delete_payment_method_categories(, body, opts = {})
  data, _status_code, _headers = delete_payment_method_categories_with_http_info(, body, opts)
  data
end

#delete_payment_method_categories_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

deletes a batch of payment method categories

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<PaymentMethodCategory>) —

    array of existing payment method categories (id or number required)

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

    the optional parameters

Returns:

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

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



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 112

def delete_payment_method_categories_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodCategoriesApi.delete_payment_method_categories ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PaymentMethodCategoriesApi.delete_payment_method_categories"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PaymentMethodCategoriesApi.delete_payment_method_categories"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/paymentMethodCategories'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"PaymentMethodCategoriesApi.delete_payment_method_categories",
    :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: PaymentMethodCategoriesApi#delete_payment_method_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_payment_method_category(korona_account_id, payment_method_category_id, opts = {}) ⇒ nil

deletes the single payment method category

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • payment_method_category_id (String) —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

  • (nil) 


174
175
176
177
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 174

def delete_payment_method_category(, payment_method_category_id, opts = {})
  delete_payment_method_category_with_http_info(, payment_method_category_id, opts)
  nil
end

#delete_payment_method_category_with_http_info(korona_account_id, payment_method_category_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

deletes the single payment method category

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • payment_method_category_id (String) —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 184

def delete_payment_method_category_with_http_info(, payment_method_category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodCategoriesApi.delete_payment_method_category ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PaymentMethodCategoriesApi.delete_payment_method_category"
  end
  # verify the required parameter 'payment_method_category_id' is set
  if @api_client.config.client_side_validation && payment_method_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_category_id' when calling PaymentMethodCategoriesApi.delete_payment_method_category"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/paymentMethodCategories/{paymentMethodCategoryId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'paymentMethodCategoryId' + '}', CGI.escape(payment_method_category_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'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"PaymentMethodCategoriesApi.delete_payment_method_category",
    :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: PaymentMethodCategoriesApi#delete_payment_method_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_method_categories(korona_account_id, opts = {}) ⇒ ResultListPaymentMethodCategory

lists all payment method categories

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (Boolean) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:



246
247
248
249
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 246

def get_payment_method_categories(, opts = {})
  data, _status_code, _headers = get_payment_method_categories_with_http_info(, opts)
  data
end

#get_payment_method_categories_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListPaymentMethodCategory, Integer, Hash)>

lists all payment method categories

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (Boolean) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
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
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 261

def get_payment_method_categories_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodCategoriesApi.get_payment_method_categories ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PaymentMethodCategoriesApi.get_payment_method_categories"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/paymentMethodCategories'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ResultListPaymentMethodCategory'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"PaymentMethodCategoriesApi.get_payment_method_categories",
    :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: PaymentMethodCategoriesApi#get_payment_method_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_method_category(korona_account_id, payment_method_category_id, opts = {}) ⇒ PaymentMethodCategory

returns the single payment method category

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • payment_method_category_id (String) —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:



320
321
322
323
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 320

def get_payment_method_category(, payment_method_category_id, opts = {})
  data, _status_code, _headers = get_payment_method_category_with_http_info(, payment_method_category_id, opts)
  data
end

#get_payment_method_category_with_http_info(korona_account_id, payment_method_category_id, opts = {}) ⇒ Array<(PaymentMethodCategory, Integer, Hash)>

returns the single payment method category

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • payment_method_category_id (String) —

    id of the related object (important: id should match the uuid-format)

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

    the optional parameters

Returns:

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

    PaymentMethodCategory data, response status code and response headers



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 330

def get_payment_method_category_with_http_info(, payment_method_category_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodCategoriesApi.get_payment_method_category ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PaymentMethodCategoriesApi.get_payment_method_category"
  end
  # verify the required parameter 'payment_method_category_id' is set
  if @api_client.config.client_side_validation && payment_method_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_category_id' when calling PaymentMethodCategoriesApi.get_payment_method_category"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/paymentMethodCategories/{paymentMethodCategoryId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'paymentMethodCategoryId' + '}', CGI.escape(payment_method_category_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'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PaymentMethodCategory'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"PaymentMethodCategoriesApi.get_payment_method_category",
    :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: PaymentMethodCategoriesApi#get_payment_method_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_payment_method_categories(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of payment method categories

number

must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<PaymentMethodCategory>) —

    an array of existing payment method categories

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

    the optional parameters

Returns:



388
389
390
391
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 388

def update_payment_method_categories(, body, opts = {})
  data, _status_code, _headers = update_payment_method_categories_with_http_info(, body, opts)
  data
end

#update_payment_method_categories_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

updates a batch of payment method categories

number

must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<PaymentMethodCategory>) —

    an array of existing payment method categories

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

    the optional parameters

Returns:

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

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



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
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
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 399

def update_payment_method_categories_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodCategoriesApi.update_payment_method_categories ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PaymentMethodCategoriesApi.update_payment_method_categories"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PaymentMethodCategoriesApi.update_payment_method_categories"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/paymentMethodCategories'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"PaymentMethodCategoriesApi.update_payment_method_categories",
    :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: PaymentMethodCategoriesApi#update_payment_method_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_payment_method_category(korona_account_id, payment_method_category_id, body, opts = {}) ⇒ nil

updates the single payment method category if [number] is set, the number of the object will change and the resource location as well

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • payment_method_category_id (String) —

    id of the related object (important: id should match the uuid-format)

  • body (PaymentMethodCategory) —

    the properties to update of the payment method

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

    the optional parameters

Returns:

  • (nil) 


463
464
465
466
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 463

def update_payment_method_category(, payment_method_category_id, body, opts = {})
  update_payment_method_category_with_http_info(, payment_method_category_id, body, opts)
  nil
end

#update_payment_method_category_with_http_info(korona_account_id, payment_method_category_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single payment method category if [number] is set, the number of the object will change and the resource location as well

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • payment_method_category_id (String) —

    id of the related object (important: id should match the uuid-format)

  • body (PaymentMethodCategory) —

    the properties to update of the payment method

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/korona-cloud-client/api/payment_method_categories_api.rb', line 475

def update_payment_method_category_with_http_info(, payment_method_category_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentMethodCategoriesApi.update_payment_method_category ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling PaymentMethodCategoriesApi.update_payment_method_category"
  end
  # verify the required parameter 'payment_method_category_id' is set
  if @api_client.config.client_side_validation && payment_method_category_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_category_id' when calling PaymentMethodCategoriesApi.update_payment_method_category"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PaymentMethodCategoriesApi.update_payment_method_category"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/paymentMethodCategories/{paymentMethodCategoryId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'paymentMethodCategoryId' + '}', CGI.escape(payment_method_category_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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"PaymentMethodCategoriesApi.update_payment_method_category",
    :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: PaymentMethodCategoriesApi#update_payment_method_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end