Class: CybridApiBank::InvoicesBankApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvoicesBankApi

Returns a new instance of InvoicesBankApi.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_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/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_invoice(invoice_guid, opts = {}) ⇒ InvoiceBankModel

Cancel Invoice Cancels an invoice. Required scope: invoices:execute

Parameters:

  • invoice_guid (String) —

    Identifier for the invoice.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 27

def cancel_invoice(invoice_guid, opts = {})
  data, _status_code, _headers = cancel_invoice_with_http_info(invoice_guid, opts)
  data
end

#cancel_invoice_with_http_info(invoice_guid, opts = {}) ⇒ Array<(InvoiceBankModel, Integer, Hash)>

Cancel Invoice Cancels an invoice. Required scope: invoices:execute

Parameters:

  • invoice_guid (String) —

    Identifier for the invoice.

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

    the optional parameters

Returns:

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

    InvoiceBankModel 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
76
77
78
79
80
81
82
83
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 37

def cancel_invoice_with_http_info(invoice_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesBankApi.cancel_invoice ...'
  end
  # verify the required parameter 'invoice_guid' is set
  if @api_client.config.client_side_validation && invoice_guid.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_guid' when calling InvoicesBankApi.cancel_invoice"
  end
  # resource path
  local_var_path = '/api/invoices/{invoice_guid}'.sub('{' + 'invoice_guid' + '}', CGI.escape(invoice_guid.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] || 'InvoiceBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

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

#create_invoice(post_invoice_bank_model, opts = {}) ⇒ InvoiceBankModel

Create Invoice Creates a invoice. ## State | State | Description | |——-|————-| | storing | The Platform is storing the invoice details in our private store | | unpaid | The invoice is unpaid. Payment instructions can be generated for an invoice in this state | | cancelling | The invocie is in the process of being cancelled | | cancelled | The invoice has been cancelled | | settling | The invoice has been paid and the funds associated with this invoice are in the process of being settled | | paid | The invoice has been paid and the funds associated with this invoice have been settled | Required scope: invoices:execute

Parameters:

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 90

def create_invoice(post_invoice_bank_model, opts = {})
  data, _status_code, _headers = create_invoice_with_http_info(post_invoice_bank_model, opts)
  data
end

#create_invoice_with_http_info(post_invoice_bank_model, opts = {}) ⇒ Array<(InvoiceBankModel, Integer, Hash)>

Create Invoice Creates a invoice. ## State | State | Description | |——-|————-| | storing | The Platform is storing the invoice details in our private store | | unpaid | The invoice is unpaid. Payment instructions can be generated for an invoice in this state | | cancelling | The invocie is in the process of being cancelled | | cancelled | The invoice has been cancelled | | settling | The invoice has been paid and the funds associated with this invoice are in the process of being settled | | paid | The invoice has been paid and the funds associated with this invoice have been settled | Required scope: invoices:execute

Parameters:

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

    the optional parameters

Returns:

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

    InvoiceBankModel data, response status code and response headers



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 100

def create_invoice_with_http_info(post_invoice_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesBankApi.create_invoice ...'
  end
  # verify the required parameter 'post_invoice_bank_model' is set
  if @api_client.config.client_side_validation && post_invoice_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_invoice_bank_model' when calling InvoicesBankApi.create_invoice"
  end
  # resource path
  local_var_path = '/api/invoices'

  # 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(post_invoice_bank_model)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

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

#get_invoice(invoice_guid, opts = {}) ⇒ InvoiceBankModel

Get Invoice Retrieves a invoice. Required scope: invoices:read

Parameters:

  • invoice_guid (String) —

    Identifier for the payment instruction.

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 158

def get_invoice(invoice_guid, opts = {})
  data, _status_code, _headers = get_invoice_with_http_info(invoice_guid, opts)
  data
end

#get_invoice_with_http_info(invoice_guid, opts = {}) ⇒ Array<(InvoiceBankModel, Integer, Hash)>

Get Invoice Retrieves a invoice. Required scope: invoices:read

Parameters:

  • invoice_guid (String) —

    Identifier for the payment instruction.

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

    the optional parameters

Returns:

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

    InvoiceBankModel data, response status code and response headers



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 168

def get_invoice_with_http_info(invoice_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesBankApi.get_invoice ...'
  end
  # verify the required parameter 'invoice_guid' is set
  if @api_client.config.client_side_validation && invoice_guid.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_guid' when calling InvoicesBankApi.get_invoice"
  end
  # resource path
  local_var_path = '/api/invoices/{invoice_guid}'.sub('{' + 'invoice_guid' + '}', CGI.escape(invoice_guid.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] || 'InvoiceBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

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

#list_invoices(opts = {}) ⇒ InvoiceListBankModel

List Invoices Retrieves a list of invoices. Required scope: invoices:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated guids to list invoices for.

  • :bank_guid (String) —

    Comma separated bank_guids to list invoices for.

  • :customer_guid (String) —

    Comma separated customer_guids to list invoices for.

  • :account_guid (String) —

    Comma separated account_guids to list invoices for.

  • :state (String) —

    Comma separated states to list invoices for.

  • :asset (String) —

    Comma separated assets to list invoices for.

  • :environment (String)
  • :label (String) —

    Comma separated labels to list invoices for.

Returns:



230
231
232
233
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 230

def list_invoices(opts = {})
  data, _status_code, _headers = list_invoices_with_http_info(opts)
  data
end

#list_invoices_with_http_info(opts = {}) ⇒ Array<(InvoiceListBankModel, Integer, Hash)>

List Invoices Retrieves a list of invoices. Required scope: invoices:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page index to retrieve.

  • :per_page (Integer) —

    The number of entities per page to return.

  • :guid (String) —

    Comma separated guids to list invoices for.

  • :bank_guid (String) —

    Comma separated bank_guids to list invoices for.

  • :customer_guid (String) —

    Comma separated customer_guids to list invoices for.

  • :account_guid (String) —

    Comma separated account_guids to list invoices for.

  • :state (String) —

    Comma separated states to list invoices for.

  • :asset (String) —

    Comma separated assets to list invoices for.

  • :environment (String)
  • :label (String) —

    Comma separated labels to list invoices for.

Returns:

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

    InvoiceListBankModel data, response status code and response headers



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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb', line 249

def list_invoices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesBankApi.list_invoices ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling InvoicesBankApi.list_invoices, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling InvoicesBankApi.list_invoices, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling InvoicesBankApi.list_invoices, must be greater than or equal to 1.'
  end

  allowable_values = ["sandbox", "production"]
  if @api_client.config.client_side_validation && opts[:'environment'] && !allowable_values.include?(opts[:'environment'])
    fail ArgumentError, "invalid value for \"environment\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/invoices'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
  query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
  query_params[:'customer_guid'] = opts[:'customer_guid'] if !opts[:'customer_guid'].nil?
  query_params[:'account_guid'] = opts[:'account_guid'] if !opts[:'account_guid'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'asset'] = opts[:'asset'] if !opts[:'asset'].nil?
  query_params[:'environment'] = opts[:'environment'] if !opts[:'environment'].nil?
  query_params[:'label'] = opts[:'label'] if !opts[:'label'].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] || 'InvoiceListBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

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