Class: CyberSource::InvoicesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/invoices_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ InvoicesApi

Returns a new instance of InvoicesApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 18

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_invoice(create_invoice_request, opts = {}) ⇒ InvoicingV2InvoicesPost201Response

Create a New Invoice The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device. You can either use the system generated email or use the invoice payment link in your own communication. You can add discounts and taxes for the entire invoice or for each line item. To customize the invoice to match your brand see [Invoice Settings](developer.cybersource.com/api-reference-assets/index.html#invoicing_invoice-settings_update-invoice-settings). The invoice payment page uses Unified Checkout to process the payments. The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 29

def create_invoice(create_invoice_request, opts = {})
  data, status_code, headers = create_invoice_with_http_info(create_invoice_request, opts)
  return data, status_code, headers
end

#create_invoice_with_http_info(create_invoice_request, opts = {}) ⇒ Array<(InvoicingV2InvoicesPost201Response, Fixnum, Hash)>

Create a New Invoice The invoicing product enables you to bill any customer with an email address and accept digital payments securely from any connected device. You can either use the system generated email or use the invoice payment link in your own communication. You can add discounts and taxes for the entire invoice or for each line item. To customize the invoice to match your brand see [Invoice Settings](developer.cybersource.com/api-reference-assets/index.html#invoicing_invoice-settings_update-invoice-settings). The invoice payment page uses Unified Checkout to process the payments. The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.

Parameters:

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

    the optional parameters

Returns:



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
99
100
101
102
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 39

def create_invoice_with_http_info(create_invoice_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoicesApi.create_invoice ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'create_invoice_request' is set

  if @api_client.config.client_side_validation && create_invoice_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_invoice_request' when calling InvoicesApi.create_invoice"
  end
  # resource path

  local_var_path = 'invoicing/v2/invoices'

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

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

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(create_invoice_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'CreateInvoiceRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "false"
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["create_invoice","create_invoice_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["create_invoice","create_invoice_with_http_info"])

  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 => 'InvoicingV2InvoicesPost201Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoicesApi#create_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_all_invoices(offset, limit, opts = {}) ⇒ InvoicingV2InvoicesAllGet200Response

Get a List of Invoices Provides a (filtered) list of invoices that have been created in your account. You can filter the list based on Invoice Status by setting the status query parameter to one of DRAFT, CREATED, SENT, PARTIAL, PAID or CANCELED.

Parameters:

  • offset —

    Page offset number.

  • limit —

    Maximum number of items you would like returned.

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED

Returns:



112
113
114
115
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 112

def get_all_invoices(offset, limit, opts = {})
  data, status_code, headers = get_all_invoices_with_http_info(offset, limit, opts)
  return data, status_code, headers
end

#get_all_invoices_with_http_info(offset, limit, opts = {}) ⇒ Array<(InvoicingV2InvoicesAllGet200Response, Fixnum, Hash)>

Get a List of Invoices Provides a (filtered) list of invoices that have been created in your account. You can filter the list based on Invoice Status by setting the status query parameter to one of DRAFT, CREATED, SENT, PARTIAL, PAID or CANCELED.

Parameters:

  • offset —

    Page offset number.

  • limit —

    Maximum number of items you would like returned.

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

    the optional parameters

Options Hash (opts):

  • :status (String) —

    The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED

Returns:



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 124

def get_all_invoices_with_http_info(offset, limit, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoicesApi.get_all_invoices ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'offset' is set

  if @api_client.config.client_side_validation && offset.nil?
    fail ArgumentError, "Missing the required parameter 'offset' when calling InvoicesApi.get_all_invoices"
  end
  # verify the required parameter 'limit' is set

  if @api_client.config.client_side_validation && limit.nil?
    fail ArgumentError, "Missing the required parameter 'limit' when calling InvoicesApi.get_all_invoices"
  end
  # resource path

  local_var_path = 'invoicing/v2/invoices'

  # query parameters

  query_params = {}
  query_params[:'offset'] = offset
  query_params[:'limit'] = limit
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

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

  # form parameters

  form_params = {}

  # http body (model)

  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["get_all_invoices","get_all_invoices_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["get_all_invoices","get_all_invoices_with_http_info"])

  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 => 'InvoicingV2InvoicesAllGet200Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoicesApi#get_all_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_invoice(id, opts = {}) ⇒ InvoicingV2InvoicesGet200Response

Get Invoice Details You can retrieve details of a specific invoice. This can be used to check the Invoice status and get a list of invoice payments in the invoice history section of the response. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



204
205
206
207
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 204

def get_invoice(id, opts = {})
  data, status_code, headers = get_invoice_with_http_info(id, opts)
  return data, status_code, headers
end

#get_invoice_with_http_info(id, opts = {}) ⇒ Array<(InvoicingV2InvoicesGet200Response, Fixnum, Hash)>

Get Invoice Details You can retrieve details of a specific invoice. This can be used to check the Invoice status and get a list of invoice payments in the invoice history section of the response. For each payment transaction you can use the Transaction Details API to get more details on the payment transaction.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 214

def get_invoice_with_http_info(id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoicesApi.get_invoice ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.get_invoice"
  end
  # resource path

  local_var_path = 'invoicing/v2/invoices/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

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

  # form parameters

  form_params = {}

  # http body (model)

  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["get_invoice","get_invoice_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["get_invoice","get_invoice_with_http_info"])

  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 => 'InvoicingV2InvoicesGet200Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoicesApi#get_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#perform_cancel_action(id, opts = {}) ⇒ InvoicingV2InvoicesCancel200Response

Cancel an Invoice You can cancel an invoice if no payment is made to it. You cannot cancel partially or fully paid invoices.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 287

def perform_cancel_action(id, opts = {})
  data, status_code, headers = perform_cancel_action_with_http_info(id, opts)
  return data, status_code, headers
end

#perform_cancel_action_with_http_info(id, opts = {}) ⇒ Array<(InvoicingV2InvoicesCancel200Response, Fixnum, Hash)>

Cancel an Invoice You can cancel an invoice if no payment is made to it. You cannot cancel partially or fully paid invoices.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 297

def perform_cancel_action_with_http_info(id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoicesApi.perform_cancel_action ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.perform_cancel_action"
  end
  # resource path

  local_var_path = 'invoicing/v2/invoices/{id}/cancelation'.sub('{' + 'id' + '}', id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

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

  # form parameters

  form_params = {}

  # http body (model)

  if 'POST' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["perform_cancel_action","perform_cancel_action_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["perform_cancel_action","perform_cancel_action_with_http_info"])

  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 => 'InvoicingV2InvoicesCancel200Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoicesApi#perform_cancel_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#perform_publish_action(id, opts = {}) ⇒ InvoicingV2InvoicesPublish200Response

Publish an Invoice You can publish an invoice in DRAFT status. After invoking this method, the invoice status is changed to CREATED.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



370
371
372
373
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 370

def perform_publish_action(id, opts = {})
  data, status_code, headers = perform_publish_action_with_http_info(id, opts)
  return data, status_code, headers
end

#perform_publish_action_with_http_info(id, opts = {}) ⇒ Array<(InvoicingV2InvoicesPublish200Response, Fixnum, Hash)>

Publish an Invoice You can publish an invoice in DRAFT status. After invoking this method, the invoice status is changed to CREATED.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
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
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 380

def perform_publish_action_with_http_info(id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoicesApi.perform_publish_action ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.perform_publish_action"
  end
  # resource path

  local_var_path = 'invoicing/v2/invoices/{id}/publication'.sub('{' + 'id' + '}', id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

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

  # form parameters

  form_params = {}

  # http body (model)

  if 'POST' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["perform_publish_action","perform_publish_action_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["perform_publish_action","perform_publish_action_with_http_info"])

  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 => 'InvoicingV2InvoicesPublish200Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoicesApi#perform_publish_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#perform_send_action(id, opts = {}) ⇒ InvoicingV2InvoicesSend200Response

Send an Invoice You can send an invoice in draft or created state or resend a sent or partially paid invoice. Fully paid or canceled invoices cannot be resent.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



453
454
455
456
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 453

def perform_send_action(id, opts = {})
  data, status_code, headers = perform_send_action_with_http_info(id, opts)
  return data, status_code, headers
end

#perform_send_action_with_http_info(id, opts = {}) ⇒ Array<(InvoicingV2InvoicesSend200Response, Fixnum, Hash)>

Send an Invoice You can send an invoice in draft or created state or resend a sent or partially paid invoice. Fully paid or canceled invoices cannot be resent.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
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
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 463

def perform_send_action_with_http_info(id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoicesApi.perform_send_action ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.perform_send_action"
  end
  # resource path

  local_var_path = 'invoicing/v2/invoices/{id}/delivery'.sub('{' + 'id' + '}', id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

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

  # form parameters

  form_params = {}

  # http body (model)

  if 'POST' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["perform_send_action","perform_send_action_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["perform_send_action","perform_send_action_with_http_info"])

  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 => 'InvoicingV2InvoicesSend200Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoicesApi#perform_send_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#update_invoice(id, update_invoice_request, opts = {}) ⇒ InvoicingV2InvoicesPut200Response

Update an Invoice You can update all information except the invoice number till any payment is received for an invoice. Invoices that are partially or fully paid or cancelled cannot be updated.

Parameters:

  • id —

    The invoice number.

  • update_invoice_request —

    Updating the invoice does not resend the invoice automatically. You must resend the invoice separately.

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

    the optional parameters

Returns:



537
538
539
540
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 537

def update_invoice(id, update_invoice_request, opts = {})
  data, status_code, headers = update_invoice_with_http_info(id, update_invoice_request, opts)
  return data, status_code, headers
end

#update_invoice_with_http_info(id, update_invoice_request, opts = {}) ⇒ Array<(InvoicingV2InvoicesPut200Response, Fixnum, Hash)>

Update an Invoice You can update all information except the invoice number till any payment is received for an invoice. Invoices that are partially or fully paid or cancelled cannot be updated.

Parameters:

  • id —

    The invoice number.

  • update_invoice_request —

    Updating the invoice does not resend the invoice automatically. You must resend the invoice separately.

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

    the optional parameters

Returns:



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
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
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 548

def update_invoice_with_http_info(id, update_invoice_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: InvoicesApi.update_invoice ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'id' is set

  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.update_invoice"
  end
  # verify the required parameter 'update_invoice_request' is set

  if @api_client.config.client_side_validation && update_invoice_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_invoice_request' when calling InvoicesApi.update_invoice"
  end
  # resource path

  local_var_path = 'invoicing/v2/invoices/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters

  query_params = {}

  # header parameters

  header_params = {}
  # HTTP header 'Accept' (if needed)

  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'

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

  # form parameters

  form_params = {}

  # http body (model)

  post_body = @api_client.object_to_http_body(update_invoice_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'UpdateInvoiceRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "false"
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["update_invoice","update_invoice_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end

  is_response_mle_for_api = MLEUtility.check_is_response_mle_for_api(@api_client.merchantconfig, ["update_invoice","update_invoice_with_http_info"])

  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicingV2InvoicesPut200Response',
    :isResponseMLEForApi => is_response_mle_for_api)
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: InvoicesApi#update_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end