Class: KoronaCloudClient::VouchersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VouchersApi

Returns a new instance of VouchersApi.



19
20
21
 
# File 'lib/korona-cloud-client/api/vouchers_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/vouchers_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_voucher_voucher_transactions(korona_account_id, voucher_id, voucher_transaction, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new voucher transactions

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction (Array<VoucherTransaction>) —

    array of new voucher transactions

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

    the optional parameters

Returns:



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

def add_voucher_voucher_transactions(, voucher_id, voucher_transaction, opts = {})
  data, _status_code, _headers = add_voucher_voucher_transactions_with_http_info(, voucher_id, voucher_transaction, opts)
  data
end

#add_voucher_voucher_transactions_with_http_info(korona_account_id, voucher_id, voucher_transaction, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

adds a batch of new voucher transactions

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction (Array<VoucherTransaction>) —

    array of new voucher transactions

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

    the optional parameters

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
96
97
98
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 39

def add_voucher_voucher_transactions_with_http_info(, voucher_id, voucher_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.add_voucher_voucher_transactions ...'
  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 VouchersApi.add_voucher_voucher_transactions"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.add_voucher_voucher_transactions"
  end
  # verify the required parameter 'voucher_transaction' is set
  if @api_client.config.client_side_validation && voucher_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_transaction' when calling VouchersApi.add_voucher_voucher_transactions"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}/transactions'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_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(voucher_transaction)

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

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

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

#add_vouchers(korona_account_id, voucher, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new vouchers

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher (Array<Voucher>) —

    array of new vouchers

  • 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; deprecated, use writeMode ADD_OR_UPDATE instead

  • :write_mode (String) —

    DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields

Returns:



107
108
109
110
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 107

def add_vouchers(, voucher, opts = {})
  data, _status_code, _headers = add_vouchers_with_http_info(, voucher, opts)
  data
end

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

adds a batch of new vouchers

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher (Array<Voucher>) —

    array of new vouchers

  • 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; deprecated, use writeMode ADD_OR_UPDATE instead

  • :write_mode (String) —

    DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields

Returns:

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

    Array<AddOrUpdateResult> data, 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
178
179
180
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 119

def add_vouchers_with_http_info(, voucher, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.add_vouchers ...'
  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 VouchersApi.add_vouchers"
  end
  # verify the required parameter 'voucher' is set
  if @api_client.config.client_side_validation && voucher.nil?
    fail ArgumentError, "Missing the required parameter 'voucher' when calling VouchersApi.add_vouchers"
  end
  allowable_values = ["DEFAULT", "ADD_OR_UPDATE", "ADD_OR_REPLACE"]
  if @api_client.config.client_side_validation && opts[:'write_mode'] && !allowable_values.include?(opts[:'write_mode'])
    fail ArgumentError, "invalid value for \"write_mode\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?
  query_params[:'writeMode'] = opts[:'write_mode'] if !opts[:'write_mode'].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(voucher)

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

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

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

#delete_voucher(korona_account_id, voucher_id, opts = {}) ⇒ nil

deletes the single voucher

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


187
188
189
190
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 187

def delete_voucher(, voucher_id, opts = {})
  delete_voucher_with_http_info(, voucher_id, opts)
  nil
end

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

deletes the single voucher

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_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



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
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 197

def delete_voucher_with_http_info(, voucher_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.delete_voucher ...'
  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 VouchersApi.delete_voucher"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.delete_voucher"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_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 => :"VouchersApi.delete_voucher",
    :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: VouchersApi#delete_voucher\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_vouchers(korona_account_id, voucher, opts = {}) ⇒ Array<AddOrUpdateResult>

deletes a batch of vouchers

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher (Array<Voucher>) —

    array of existing vouchers (id or number required)

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

    the optional parameters

Returns:



254
255
256
257
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 254

def delete_vouchers(, voucher, opts = {})
  data, _status_code, _headers = delete_vouchers_with_http_info(, voucher, opts)
  data
end

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

deletes a batch of vouchers

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher (Array<Voucher>) —

    array of existing vouchers (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



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
314
315
316
317
318
319
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 264

def delete_vouchers_with_http_info(, voucher, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.delete_vouchers ...'
  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 VouchersApi.delete_vouchers"
  end
  # verify the required parameter 'voucher' is set
  if @api_client.config.client_side_validation && voucher.nil?
    fail ArgumentError, "Missing the required parameter 'voucher' when calling VouchersApi.delete_vouchers"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers'.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(voucher)

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

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

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

#get_voucher(korona_account_id, voucher_id, opts = {}) ⇒ Voucher

returns the single voucher

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

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

    the optional parameters

Returns:



326
327
328
329
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 326

def get_voucher(, voucher_id, opts = {})
  data, _status_code, _headers = get_voucher_with_http_info(, voucher_id, opts)
  data
end

#get_voucher_voucher_transaction(korona_account_id, voucher_id, voucher_transaction_id, opts = {}) ⇒ VoucherTransaction

returns the single voucher transaction

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction_id (String) —

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

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

    the optional parameters

Returns:



394
395
396
397
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 394

def get_voucher_voucher_transaction(, voucher_id, voucher_transaction_id, opts = {})
  data, _status_code, _headers = get_voucher_voucher_transaction_with_http_info(, voucher_id, voucher_transaction_id, opts)
  data
end

#get_voucher_voucher_transaction_with_http_info(korona_account_id, voucher_id, voucher_transaction_id, opts = {}) ⇒ Array<(VoucherTransaction, Integer, Hash)>

returns the single voucher transaction

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction_id (String) —

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

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

    the optional parameters

Returns:

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

    VoucherTransaction data, response status code and response headers



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
455
456
457
458
459
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 405

def get_voucher_voucher_transaction_with_http_info(, voucher_id, voucher_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.get_voucher_voucher_transaction ...'
  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 VouchersApi.get_voucher_voucher_transaction"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.get_voucher_voucher_transaction"
  end
  # verify the required parameter 'voucher_transaction_id' is set
  if @api_client.config.client_side_validation && voucher_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_transaction_id' when calling VouchersApi.get_voucher_voucher_transaction"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}/transactions/{voucherTransactionId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_id.to_s)).sub('{' + 'voucherTransactionId' + '}', CGI.escape(voucher_transaction_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] || 'VoucherTransaction'

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

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

#get_voucher_voucher_transactions(korona_account_id, voucher_id, opts = {}) ⇒ ResultListVoucherTransaction

returns all voucher transaction of specified voucher

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • 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

Returns:



470
471
472
473
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 470

def get_voucher_voucher_transactions(, voucher_id, opts = {})
  data, _status_code, _headers = get_voucher_voucher_transactions_with_http_info(, voucher_id, opts)
  data
end

#get_voucher_voucher_transactions_with_http_info(korona_account_id, voucher_id, opts = {}) ⇒ Array<(ResultListVoucherTransaction, Integer, Hash)>

returns all voucher transaction of specified voucher

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • 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

Returns:



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
535
536
537
538
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 484

def get_voucher_voucher_transactions_with_http_info(, voucher_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.get_voucher_voucher_transactions ...'
  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 VouchersApi.get_voucher_voucher_transactions"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.get_voucher_voucher_transactions"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}/transactions'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_id.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?

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

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

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

#get_voucher_with_http_info(korona_account_id, voucher_id, opts = {}) ⇒ Array<(Voucher, Integer, Hash)>

returns the single voucher

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

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

    the optional parameters

Returns:

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

    Voucher data, response status code and response headers



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
381
382
383
384
385
386
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 336

def get_voucher_with_http_info(, voucher_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.get_voucher ...'
  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 VouchersApi.get_voucher"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.get_voucher"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_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] || 'Voucher'

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

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

#get_vouchers(korona_account_id, opts = {}) ⇒ ResultListVoucher

lists all vouchers

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)

  • :tag (String) —

    voucher configuration id to filter by

  • :customer (String) —

    voucher configuration id to filter by

  • :number (String) —

    number of the related object

Returns:



552
553
554
555
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 552

def get_vouchers(, opts = {})
  data, _status_code, _headers = get_vouchers_with_http_info(, opts)
  data
end

#get_vouchers_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListVoucher, Integer, Hash)>

lists all vouchers

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)

  • :tag (String) —

    voucher configuration id to filter by

  • :customer (String) —

    voucher configuration id to filter by

  • :number (String) —

    number of the related object

Returns:

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

    ResultListVoucher data, response status code and response headers



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 569

def get_vouchers_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.get_vouchers ...'
  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 VouchersApi.get_vouchers"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers'.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[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
  query_params[:'customer'] = opts[:'customer'] if !opts[:'customer'].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] || 'ResultListVoucher'

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

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

#update_voucher(korona_account_id, voucher_id, voucher, opts = {}) ⇒ nil

updates the single voucher; 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

  • voucher_id (String) —

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

  • voucher (Voucher) —

    the properties to update of the voucher

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

    the optional parameters

Returns:

  • (nil) 


631
632
633
634
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 631

def update_voucher(, voucher_id, voucher, opts = {})
  update_voucher_with_http_info(, voucher_id, voucher, opts)
  nil
end

#update_voucher_voucher_transaction(korona_account_id, voucher_id, voucher_transaction_id, voucher_transaction, opts = {}) ⇒ nil

updates the voucher transaction

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction_id (String) —

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

  • voucher_transaction (VoucherTransaction) —

    the properties to update of the voucher transaction

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

    the optional parameters

Returns:

  • (nil) 


710
711
712
713
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 710

def update_voucher_voucher_transaction(, voucher_id, voucher_transaction_id, voucher_transaction, opts = {})
  update_voucher_voucher_transaction_with_http_info(, voucher_id, voucher_transaction_id, voucher_transaction, opts)
  nil
end

#update_voucher_voucher_transaction_with_http_info(korona_account_id, voucher_id, voucher_transaction_id, voucher_transaction, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the voucher transaction

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction_id (String) —

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

  • voucher_transaction (VoucherTransaction) —

    the properties to update of the voucher transaction

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 722

def update_voucher_voucher_transaction_with_http_info(, voucher_id, voucher_transaction_id, voucher_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.update_voucher_voucher_transaction ...'
  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 VouchersApi.update_voucher_voucher_transaction"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.update_voucher_voucher_transaction"
  end
  # verify the required parameter 'voucher_transaction_id' is set
  if @api_client.config.client_side_validation && voucher_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_transaction_id' when calling VouchersApi.update_voucher_voucher_transaction"
  end
  # verify the required parameter 'voucher_transaction' is set
  if @api_client.config.client_side_validation && voucher_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_transaction' when calling VouchersApi.update_voucher_voucher_transaction"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}/transactions/{voucherTransactionId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_id.to_s)).sub('{' + 'voucherTransactionId' + '}', CGI.escape(voucher_transaction_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(voucher_transaction)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_voucher_voucher_transactions(korona_account_id, voucher_id, voucher_transaction, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of vouchers; [id] must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction (Array<VoucherTransaction>) —

    an array of existing voucher transactions

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

    the optional parameters

Returns:



793
794
795
796
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 793

def update_voucher_voucher_transactions(, voucher_id, voucher_transaction, opts = {})
  data, _status_code, _headers = update_voucher_voucher_transactions_with_http_info(, voucher_id, voucher_transaction, opts)
  data
end

#update_voucher_voucher_transactions_with_http_info(korona_account_id, voucher_id, voucher_transaction, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

updates a batch of vouchers; [id] must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction (Array<VoucherTransaction>) —

    an array of existing voucher transactions

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

    the optional parameters

Returns:

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

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



804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 804

def update_voucher_voucher_transactions_with_http_info(, voucher_id, voucher_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.update_voucher_voucher_transactions ...'
  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 VouchersApi.update_voucher_voucher_transactions"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.update_voucher_voucher_transactions"
  end
  # verify the required parameter 'voucher_transaction' is set
  if @api_client.config.client_side_validation && voucher_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_transaction' when calling VouchersApi.update_voucher_voucher_transactions"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}/transactions'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_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(voucher_transaction)

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

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

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

#update_voucher_with_http_info(korona_account_id, voucher_id, voucher, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single voucher; 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

  • voucher_id (String) —

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

  • voucher (Voucher) —

    the properties to update of the voucher

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 642

def update_voucher_with_http_info(, voucher_id, voucher, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.update_voucher ...'
  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 VouchersApi.update_voucher"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.update_voucher"
  end
  # verify the required parameter 'voucher' is set
  if @api_client.config.client_side_validation && voucher.nil?
    fail ArgumentError, "Missing the required parameter 'voucher' when calling VouchersApi.update_voucher"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_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(voucher)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_vouchers(korona_account_id, voucher, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of vouchers; [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

  • voucher (Array<Voucher>) —

    an array of existing vouchers

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

    the optional parameters

Returns:



870
871
872
873
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 870

def update_vouchers(, voucher, opts = {})
  data, _status_code, _headers = update_vouchers_with_http_info(, voucher, opts)
  data
end

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

updates a batch of vouchers; [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

  • voucher (Array<Voucher>) —

    an array of existing vouchers

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

    the optional parameters

Returns:

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

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



880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 880

def update_vouchers_with_http_info(, voucher, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.update_vouchers ...'
  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 VouchersApi.update_vouchers"
  end
  # verify the required parameter 'voucher' is set
  if @api_client.config.client_side_validation && voucher.nil?
    fail ArgumentError, "Missing the required parameter 'voucher' when calling VouchersApi.update_vouchers"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers'.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(voucher)

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

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

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

#void_voucher_voucher_transaction(korona_account_id, voucher_id, voucher_transaction_id, opts = {}) ⇒ nil

voids the voucher transaction

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


943
944
945
946
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 943

def void_voucher_voucher_transaction(, voucher_id, voucher_transaction_id, opts = {})
  void_voucher_voucher_transaction_with_http_info(, voucher_id, voucher_transaction_id, opts)
  nil
end

#void_voucher_voucher_transaction_with_http_info(korona_account_id, voucher_id, voucher_transaction_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

voids the voucher transaction

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • voucher_id (String) —

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

  • voucher_transaction_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



954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/korona-cloud-client/api/vouchers_api.rb', line 954

def void_voucher_voucher_transaction_with_http_info(, voucher_id, voucher_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VouchersApi.void_voucher_voucher_transaction ...'
  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 VouchersApi.void_voucher_voucher_transaction"
  end
  # verify the required parameter 'voucher_id' is set
  if @api_client.config.client_side_validation && voucher_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_id' when calling VouchersApi.void_voucher_voucher_transaction"
  end
  # verify the required parameter 'voucher_transaction_id' is set
  if @api_client.config.client_side_validation && voucher_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'voucher_transaction_id' when calling VouchersApi.void_voucher_voucher_transaction"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/vouchers/{voucherId}/transactions/{voucherTransactionId}/void'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'voucherId' + '}', CGI.escape(voucher_id.to_s)).sub('{' + 'voucherTransactionId' + '}', CGI.escape(voucher_transaction_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 => :"VouchersApi.void_voucher_voucher_transaction",
    :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: VouchersApi#void_voucher_voucher_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end