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.



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

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.



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

def api_client
  @api_client
end

Instance Method Details

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

Create a New Invoice Create a new invoice.

Parameters:

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

    the optional parameters

Returns:



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

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 Create a new invoice.

Parameters:

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

    the optional parameters

Returns:



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
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 38

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;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)
  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')
  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 Get a list of invoices.

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:



95
96
97
98
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 95

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 Get a list of invoices.

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:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 107

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;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 = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicingV2InvoicesAllGet200Response')
  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 Get the details of a specific invoice.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



169
170
171
172
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 169

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 Get the details of a specific invoice.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 179

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;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 = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicingV2InvoicesGet200Response')
  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 = {}) ⇒ InvoicingV2InvoicesPost201Response

Cancel an Invoice Cancel an invoice.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



234
235
236
237
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 234

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<(InvoicingV2InvoicesPost201Response, Fixnum, Hash)>

Cancel an Invoice Cancel an invoice.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 244

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;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 = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicingV2InvoicesPost201Response')
  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_send_action(id, opts = {}) ⇒ InvoicingV2InvoicesPost201Response

Send an Invoice Send an invoice.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



299
300
301
302
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 299

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<(InvoicingV2InvoicesPost201Response, Fixnum, Hash)>

Send an Invoice Send an invoice.

Parameters:

  • id —

    The invoice number.

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

    the optional parameters

Returns:



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
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 309

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;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 = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InvoicingV2InvoicesPost201Response')
  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 = {}) ⇒ InvoicingV2InvoicesPost201Response

Update an Invoice Update an invoice.

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:



365
366
367
368
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 365

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<(InvoicingV2InvoicesPost201Response, Fixnum, Hash)>

Update an Invoice Update an invoice.

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:



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
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
 
# File 'lib/cybersource_rest_client/api/invoices_api.rb', line 376

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;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)
  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 => 'InvoicingV2InvoicesPost201Response')
  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