class CybridApiBank::InvoicesBankApi
def cancel_invoice(invoice_guid, opts = {})
-
(InvoiceBankModel)-
Parameters:
-
opts(Hash) -- the optional parameters -
invoice_guid(String) -- Identifier for the invoice.
def cancel_invoice(invoice_guid, opts = {}) data, _status_code, _headers = cancel_invoice_with_http_info(invoice_guid, opts) data end
def cancel_invoice_with_http_info(invoice_guid, opts = {})
-
(Array<(InvoiceBankModel, Integer, Hash)>)- InvoiceBankModel data, response status code and response headers
Parameters:
-
opts(Hash) -- the optional parameters -
invoice_guid(String) -- Identifier for the invoice.
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
def create_invoice(post_invoice_bank_model, opts = {})
-
(InvoiceBankModel)-
Parameters:
-
opts(Hash) -- the optional parameters -
post_invoice_bank_model(PostInvoiceBankModel) --
def create_invoice(post_invoice_bank_model, opts = {}) data, _status_code, _headers = create_invoice_with_http_info(post_invoice_bank_model, opts) data end
def create_invoice_with_http_info(post_invoice_bank_model, opts = {})
-
(Array<(InvoiceBankModel, Integer, Hash)>)- InvoiceBankModel data, response status code and response headers
Parameters:
-
opts(Hash) -- the optional parameters -
post_invoice_bank_model(PostInvoiceBankModel) --
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
def get_invoice(invoice_guid, opts = {})
-
(InvoiceBankModel)-
Parameters:
-
opts(Hash) -- the optional parameters -
invoice_guid(String) -- Identifier for the payment instruction.
def get_invoice(invoice_guid, opts = {}) data, _status_code, _headers = get_invoice_with_http_info(invoice_guid, opts) data end
def get_invoice_with_http_info(invoice_guid, opts = {})
-
(Array<(InvoiceBankModel, Integer, Hash)>)- InvoiceBankModel data, response status code and response headers
Parameters:
-
opts(Hash) -- the optional parameters -
invoice_guid(String) -- Identifier for the payment instruction.
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
def initialize(api_client = ApiClient.default)
def initialize(api_client = ApiClient.default) @api_client = api_client end
def list_invoices(opts = {})
-
(InvoiceListBankModel)-
Options Hash:
(**opts)-
:label(String) -- Comma separated labels to list invoices for. -
:environment(String) -- -
:asset(String) -- Comma separated assets to list invoices for. -
:state(String) -- Comma separated states to list invoices for. -
:account_guid(String) -- Comma separated account_guids to list invoices for. -
:customer_guid(String) -- Comma separated customer_guids to list invoices for. -
:bank_guid(String) -- Comma separated bank_guids to list invoices for. -
:guid(String) -- Comma separated guids to list invoices for. -
:per_page(Integer) -- The number of entities per page to return. -
:page(Integer) -- The page index to retrieve.
Parameters:
-
opts(Hash) -- the optional parameters
def list_invoices(opts = {}) data, _status_code, _headers = list_invoices_with_http_info(opts) data end
def list_invoices_with_http_info(opts = {})
-
(Array<(InvoiceListBankModel, Integer, Hash)>)- InvoiceListBankModel data, response status code and response headers
Options Hash:
(**opts)-
:label(String) -- Comma separated labels to list invoices for. -
:environment(String) -- -
:asset(String) -- Comma separated assets to list invoices for. -
:state(String) -- Comma separated states to list invoices for. -
:account_guid(String) -- Comma separated account_guids to list invoices for. -
:customer_guid(String) -- Comma separated customer_guids to list invoices for. -
:bank_guid(String) -- Comma separated bank_guids to list invoices for. -
:guid(String) -- Comma separated guids to list invoices for. -
:per_page(Integer) -- The number of entities per page to return. -
:page(Integer) -- The page index to retrieve.
Parameters:
-
opts(Hash) -- the optional parameters
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