Class: NucleusApi::InvoiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/invoice_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvoiceApi

Returns a new instance of InvoiceApi.



19
20
21
 
# File 'lib/nucleus_api/api/invoice_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/nucleus_api/api/invoice_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_invoice_payment_using_post(invoice_payment, opts = {}) ⇒ InvoicePayment

Create a invoicePayment Create a new invoicePayment, for tracking invoice status.

Parameters:

  • invoice_payment —

    invoicePayment

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 27

def create_invoice_payment_using_post(invoice_payment, opts = {})
  data, _status_code, _headers = create_invoice_payment_using_post_with_http_info(invoice_payment, opts)
  data
end

#create_invoice_payment_using_post_with_http_info(invoice_payment, opts = {}) ⇒ Array<(InvoicePayment, Fixnum, Hash)>

Create a invoicePayment Create a new invoicePayment, for tracking invoice status.

Parameters:

  • invoice_payment —

    invoicePayment

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

    the optional parameters

Returns:

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

    InvoicePayment data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 37

def create_invoice_payment_using_post_with_http_info(invoice_payment, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.create_invoice_payment_using_post ...'
  end
  # verify the required parameter 'invoice_payment' is set
  if @api_client.config.client_side_validation && invoice_payment.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_payment' when calling InvoiceApi.create_invoice_payment_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice_payment'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invoice_payment)
  auth_names = ['oauth2']
  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 => 'InvoicePayment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoiceApi#create_invoice_payment_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_invoice_using_post(invoice, opts = {}) ⇒ Invoice

Create a invoice Create a new invoice, with your firm.

Parameters:

  • invoice —

    invoice

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 81

def create_invoice_using_post(invoice, opts = {})
  data, _status_code, _headers = create_invoice_using_post_with_http_info(invoice, opts)
  data
end

#create_invoice_using_post_with_http_info(invoice, opts = {}) ⇒ Array<(Invoice, Fixnum, Hash)>

Create a invoice Create a new invoice, with your firm.

Parameters:

  • invoice —

    invoice

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

    the optional parameters

Returns:

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

    Invoice data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 91

def create_invoice_using_post_with_http_info(invoice, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.create_invoice_using_post ...'
  end
  # verify the required parameter 'invoice' is set
  if @api_client.config.client_side_validation && invoice.nil?
    fail ArgumentError, "Missing the required parameter 'invoice' when calling InvoiceApi.create_invoice_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invoice)
  auth_names = ['oauth2']
  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 => 'Invoice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoiceApi#create_invoice_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_invoice_payment_using_delete(invoice_payment_id, opts = {}) ⇒ nil

Delete a invoicePayment Delete a invoicePayment.

Parameters:

  • invoice_payment_id —

    UUID invoice_payment_id

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

    the optional parameters

Returns:

  • (nil) 


135
136
137
138
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 135

def delete_invoice_payment_using_delete(invoice_payment_id, opts = {})
  delete_invoice_payment_using_delete_with_http_info(invoice_payment_id, opts)
  nil
end

#delete_invoice_payment_using_delete_with_http_info(invoice_payment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a invoicePayment Delete a invoicePayment.

Parameters:

  • invoice_payment_id —

    UUID invoice_payment_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/nucleus_api/api/invoice_api.rb', line 145

def delete_invoice_payment_using_delete_with_http_info(invoice_payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.delete_invoice_payment_using_delete ...'
  end
  # verify the required parameter 'invoice_payment_id' is set
  if @api_client.config.client_side_validation && invoice_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_payment_id' when calling InvoiceApi.delete_invoice_payment_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice_payment/{invoice_payment_id}'.sub('{' + 'invoice_payment_id' + '}', invoice_payment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

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

#delete_invoice_using_delete(invoice_id, opts = {}) ⇒ nil

Delete a invoice Delete a invoice.

Parameters:

  • invoice_id —

    UUID invoice_id

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

    the optional parameters

Returns:

  • (nil) 


186
187
188
189
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 186

def delete_invoice_using_delete(invoice_id, opts = {})
  delete_invoice_using_delete_with_http_info(invoice_id, opts)
  nil
end

#delete_invoice_using_delete_with_http_info(invoice_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a invoice Delete a invoice.

Parameters:

  • invoice_id —

    UUID invoice_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 196

def delete_invoice_using_delete_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.delete_invoice_using_delete ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoiceApi.delete_invoice_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice/{invoice_id}'.sub('{' + 'invoice_id' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

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

#get_invoice_all_using_get(opts = {}) ⇒ PageInvoice

List all invoices List all invoice.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



242
243
244
245
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 242

def get_invoice_all_using_get(opts = {})
  data, _status_code, _headers = get_invoice_all_using_get_with_http_info(opts)
  data
end

#get_invoice_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageInvoice, Fixnum, Hash)>

List all invoices List all invoice.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageInvoice data, response status code and response headers



257
258
259
260
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
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 257

def get_invoice_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.get_invoice_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageInvoice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoiceApi#get_invoice_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_payment_all_using_get(opts = {}) ⇒ PageInvoicePayment

List all invoice payments List all invoicePayment.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



306
307
308
309
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 306

def get_invoice_payment_all_using_get(opts = {})
  data, _status_code, _headers = get_invoice_payment_all_using_get_with_http_info(opts)
  data
end

#get_invoice_payment_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageInvoicePayment, Fixnum, Hash)>

List all invoice payments List all invoicePayment.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageInvoicePayment data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 321

def get_invoice_payment_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.get_invoice_payment_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice_payment'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageInvoicePayment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoiceApi#get_invoice_payment_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_payment_using_get(invoice_payment_id, opts = {}) ⇒ InvoicePayment

Retrieve a invoicePayment Retrieve a invoicePayment.

Parameters:

  • invoice_payment_id —

    UUID invoice_payment_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:



366
367
368
369
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 366

def get_invoice_payment_using_get(invoice_payment_id, opts = {})
  data, _status_code, _headers = get_invoice_payment_using_get_with_http_info(invoice_payment_id, opts)
  data
end

#get_invoice_payment_using_get_with_http_info(invoice_payment_id, opts = {}) ⇒ Array<(InvoicePayment, Fixnum, Hash)>

Retrieve a invoicePayment Retrieve a invoicePayment.

Parameters:

  • invoice_payment_id —

    UUID invoice_payment_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:

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

    InvoicePayment data, response status code and response headers



377
378
379
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
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 377

def get_invoice_payment_using_get_with_http_info(invoice_payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.get_invoice_payment_using_get ...'
  end
  # verify the required parameter 'invoice_payment_id' is set
  if @api_client.config.client_side_validation && invoice_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_payment_id' when calling InvoiceApi.get_invoice_payment_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice_payment/{invoice_payment_id}'.sub('{' + 'invoice_payment_id' + '}', invoice_payment_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'InvoicePayment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoiceApi#get_invoice_payment_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_invoice_using_get(invoice_id, opts = {}) ⇒ Invoice

Retrieve a invoice Retrieve a invoice.

Parameters:

  • invoice_id —

    UUID invoice_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:



421
422
423
424
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 421

def get_invoice_using_get(invoice_id, opts = {})
  data, _status_code, _headers = get_invoice_using_get_with_http_info(invoice_id, opts)
  data
end

#get_invoice_using_get_with_http_info(invoice_id, opts = {}) ⇒ Array<(Invoice, Fixnum, Hash)>

Retrieve a invoice Retrieve a invoice.

Parameters:

  • invoice_id —

    UUID invoice_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:

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

    Invoice data, response status code and response headers



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 432

def get_invoice_using_get_with_http_info(invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.get_invoice_using_get ...'
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoiceApi.get_invoice_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice/{invoice_id}'.sub('{' + 'invoice_id' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'Invoice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoiceApi#get_invoice_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_invoice_payment_using_put(invoice_payment, invoice_payment_id, opts = {}) ⇒ InvoicePayment

Update a invoicePayment Update a invoicePayment.

Parameters:

  • invoice_payment —

    invoice_payment

  • invoice_payment_id —

    UUID invoice_payment_id

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

    the optional parameters

Returns:



476
477
478
479
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 476

def update_invoice_payment_using_put(invoice_payment, invoice_payment_id, opts = {})
  data, _status_code, _headers = update_invoice_payment_using_put_with_http_info(invoice_payment, invoice_payment_id, opts)
  data
end

#update_invoice_payment_using_put_with_http_info(invoice_payment, invoice_payment_id, opts = {}) ⇒ Array<(InvoicePayment, Fixnum, Hash)>

Update a invoicePayment Update a invoicePayment.

Parameters:

  • invoice_payment —

    invoice_payment

  • invoice_payment_id —

    UUID invoice_payment_id

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

    the optional parameters

Returns:

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

    InvoicePayment data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 487

def update_invoice_payment_using_put_with_http_info(invoice_payment, invoice_payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.update_invoice_payment_using_put ...'
  end
  # verify the required parameter 'invoice_payment' is set
  if @api_client.config.client_side_validation && invoice_payment.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_payment' when calling InvoiceApi.update_invoice_payment_using_put"
  end
  # verify the required parameter 'invoice_payment_id' is set
  if @api_client.config.client_side_validation && invoice_payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_payment_id' when calling InvoiceApi.update_invoice_payment_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice_payment/{invoice_payment_id}'.sub('{' + 'invoice_payment_id' + '}', invoice_payment_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invoice_payment)
  auth_names = ['oauth2']
  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 => 'InvoicePayment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoiceApi#update_invoice_payment_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_invoice_using_put(invoice, invoice_id, opts = {}) ⇒ Invoice

Update a invoice Update a invoice.

Parameters:

  • invoice —

    invoice

  • invoice_id —

    UUID invoice_id

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

    the optional parameters

Returns:



536
537
538
539
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 536

def update_invoice_using_put(invoice, invoice_id, opts = {})
  data, _status_code, _headers = update_invoice_using_put_with_http_info(invoice, invoice_id, opts)
  data
end

#update_invoice_using_put_with_http_info(invoice, invoice_id, opts = {}) ⇒ Array<(Invoice, Fixnum, Hash)>

Update a invoice Update a invoice.

Parameters:

  • invoice —

    invoice

  • invoice_id —

    UUID invoice_id

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

    the optional parameters

Returns:

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

    Invoice data, response status code and response headers



547
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
 
# File 'lib/nucleus_api/api/invoice_api.rb', line 547

def update_invoice_using_put_with_http_info(invoice, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoiceApi.update_invoice_using_put ...'
  end
  # verify the required parameter 'invoice' is set
  if @api_client.config.client_side_validation && invoice.nil?
    fail ArgumentError, "Missing the required parameter 'invoice' when calling InvoiceApi.update_invoice_using_put"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling InvoiceApi.update_invoice_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/invoice/{invoice_id}'.sub('{' + 'invoice_id' + '}', invoice_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(invoice)
  auth_names = ['oauth2']
  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 => 'Invoice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoiceApi#update_invoice_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end