class CybridApiBank::ExternalBankAccountsBankApi
def create_external_bank_account(post_external_bank_account_bank_model, opts = {})
-
(ExternalBankAccountBankModel)-
Parameters:
-
opts(Hash) -- the optional parameters -
post_external_bank_account_bank_model(PostExternalBankAccountBankModel) --
def create_external_bank_account(post_external_bank_account_bank_model, opts = {}) data, _status_code, _headers = create_external_bank_account_with_http_info(post_external_bank_account_bank_model, opts) data end
def create_external_bank_account_with_http_info(post_external_bank_account_bank_model, opts = {})
-
(Array<(ExternalBankAccountBankModel, Integer, Hash)>)- ExternalBankAccountBankModel data, response status code and response headers
Parameters:
-
opts(Hash) -- the optional parameters -
post_external_bank_account_bank_model(PostExternalBankAccountBankModel) --
def create_external_bank_account_with_http_info(post_external_bank_account_bank_model, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExternalBankAccountsBankApi.create_external_bank_account ...' end # verify the required parameter 'post_external_bank_account_bank_model' is set if @api_client.config.client_side_validation && post_external_bank_account_bank_model.nil? fail ArgumentError, "Missing the required parameter 'post_external_bank_account_bank_model' when calling ExternalBankAccountsBankApi.create_external_bank_account" end # resource path local_var_path = '/api/external_bank_accounts' # 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_external_bank_account_bank_model) # return_type return_type = opts[:debug_return_type] || 'ExternalBankAccountBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"ExternalBankAccountsBankApi.create_external_bank_account", :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: ExternalBankAccountsBankApi#create_external_bank_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
def delete_external_bank_account(external_bank_account_guid, opts = {})
-
(ExternalBankAccountBankModel)-
Parameters:
-
opts(Hash) -- the optional parameters -
external_bank_account_guid(String) -- Identifier for the external bank account.
def delete_external_bank_account(external_bank_account_guid, opts = {}) data, _status_code, _headers = delete_external_bank_account_with_http_info(external_bank_account_guid, opts) data end
def delete_external_bank_account_with_http_info(external_bank_account_guid, opts = {})
-
(Array<(ExternalBankAccountBankModel, Integer, Hash)>)- ExternalBankAccountBankModel data, response status code and response headers
Parameters:
-
opts(Hash) -- the optional parameters -
external_bank_account_guid(String) -- Identifier for the external bank account.
def delete_external_bank_account_with_http_info(external_bank_account_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExternalBankAccountsBankApi.delete_external_bank_account ...' end # verify the required parameter 'external_bank_account_guid' is set if @api_client.config.client_side_validation && external_bank_account_guid.nil? fail ArgumentError, "Missing the required parameter 'external_bank_account_guid' when calling ExternalBankAccountsBankApi.delete_external_bank_account" end # resource path local_var_path = '/api/external_bank_accounts/{external_bank_account_guid}'.sub('{' + 'external_bank_account_guid' + '}', CGI.escape(external_bank_account_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] || 'ExternalBankAccountBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"ExternalBankAccountsBankApi.delete_external_bank_account", :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: ExternalBankAccountsBankApi#delete_external_bank_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
def get_external_bank_account(external_bank_account_guid, opts = {})
-
(ExternalBankAccountBankModel)-
Options Hash:
(**opts)-
:include_pii(Boolean) -- Include the account holder's PII in the response (requires **external_bank_accounts:pii:read** scope). -
:include_balances(Boolean) -- Include balance information in the response. If `force_balance_refresh` is `true`, the most up to date balance will be returned. If `force_balance_refresh` is `false`, the cached balance will be returned. `balance_updated_at` in the response will provide the timestamp the balance was last updated. -
:force_balance_refresh(Boolean) -- Force the balance on the account to be retrieved.
Parameters:
-
opts(Hash) -- the optional parameters -
external_bank_account_guid(String) -- Identifier for the external bank account.
def get_external_bank_account(external_bank_account_guid, opts = {}) data, _status_code, _headers = get_external_bank_account_with_http_info(external_bank_account_guid, opts) data end
def get_external_bank_account_with_http_info(external_bank_account_guid, opts = {})
-
(Array<(ExternalBankAccountBankModel, Integer, Hash)>)- ExternalBankAccountBankModel data, response status code and response headers
Options Hash:
(**opts)-
:include_pii(Boolean) -- Include the account holder's PII in the response (requires **external_bank_accounts:pii:read** scope). -
:include_balances(Boolean) -- Include balance information in the response. If `force_balance_refresh` is `true`, the most up to date balance will be returned. If `force_balance_refresh` is `false`, the cached balance will be returned. `balance_updated_at` in the response will provide the timestamp the balance was last updated. -
:force_balance_refresh(Boolean) -- Force the balance on the account to be retrieved.
Parameters:
-
opts(Hash) -- the optional parameters -
external_bank_account_guid(String) -- Identifier for the external bank account.
def get_external_bank_account_with_http_info(external_bank_account_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExternalBankAccountsBankApi.get_external_bank_account ...' end # verify the required parameter 'external_bank_account_guid' is set if @api_client.config.client_side_validation && external_bank_account_guid.nil? fail ArgumentError, "Missing the required parameter 'external_bank_account_guid' when calling ExternalBankAccountsBankApi.get_external_bank_account" end # resource path local_var_path = '/api/external_bank_accounts/{external_bank_account_guid}'.sub('{' + 'external_bank_account_guid' + '}', CGI.escape(external_bank_account_guid.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'force_balance_refresh'] = opts[:'force_balance_refresh'] if !opts[:'force_balance_refresh'].nil? query_params[:'include_balances'] = opts[:'include_balances'] if !opts[:'include_balances'].nil? query_params[:'include_pii'] = opts[:'include_pii'] if !opts[:'include_pii'].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] || 'ExternalBankAccountBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"ExternalBankAccountsBankApi.get_external_bank_account", :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: ExternalBankAccountsBankApi#get_external_bank_account\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_external_bank_accounts(opts = {})
-
(ExternalBankAccountListBankModel)-
Options Hash:
(**opts)-
:state(String) -- Comma separated states to list external_bank_accounts for. Filtering by \"completed\" and \"unverified\" states is only supported for individual customer accounts. -
:asset(String) -- Comma separated assets to list external_bank_accounts for. -
:counterparty_guid(String) -- Comma separated counterparty_guids to list external_bank_accounts for. -
:customer_guid(String) -- Comma separated customer_guids to list external_bank_accounts for. -
:bank_guid(String) -- Comma separated bank_guids to list external_bank_accounts for. -
:guid(String) -- Comma separated external_bank_account_guids to list external_bank_accounts 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_external_bank_accounts(opts = {}) data, _status_code, _headers = list_external_bank_accounts_with_http_info(opts) data end
def list_external_bank_accounts_with_http_info(opts = {})
-
(Array<(ExternalBankAccountListBankModel, Integer, Hash)>)- ExternalBankAccountListBankModel data, response status code and response headers
Options Hash:
(**opts)-
:state(String) -- Comma separated states to list external_bank_accounts for. Filtering by \"completed\" and \"unverified\" states is only supported for individual customer accounts. -
:asset(String) -- Comma separated assets to list external_bank_accounts for. -
:counterparty_guid(String) -- Comma separated counterparty_guids to list external_bank_accounts for. -
:customer_guid(String) -- Comma separated customer_guids to list external_bank_accounts for. -
:bank_guid(String) -- Comma separated bank_guids to list external_bank_accounts for. -
:guid(String) -- Comma separated external_bank_account_guids to list external_bank_accounts 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_external_bank_accounts_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExternalBankAccountsBankApi.list_external_bank_accounts ...' end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ExternalBankAccountsBankApi.list_external_bank_accounts, 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 ExternalBankAccountsBankApi.list_external_bank_accounts, 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 ExternalBankAccountsBankApi.list_external_bank_accounts, must be greater than or equal to 1.' end # resource path local_var_path = '/api/external_bank_accounts' # 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[:'counterparty_guid'] = opts[:'counterparty_guid'] if !opts[:'counterparty_guid'].nil? query_params[:'asset'] = opts[:'asset'] if !opts[:'asset'].nil? query_params[:'state'] = opts[:'state'] if !opts[:'state'].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] || 'ExternalBankAccountListBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"ExternalBankAccountsBankApi.list_external_bank_accounts", :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: ExternalBankAccountsBankApi#list_external_bank_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
def patch_external_bank_account(external_bank_account_guid, patch_external_bank_account_bank_model, opts = {})
-
(ExternalBankAccountBankModel)-
Parameters:
-
opts(Hash) -- the optional parameters -
patch_external_bank_account_bank_model(PatchExternalBankAccountBankModel) -- -
external_bank_account_guid(String) -- Identifier for the external bank account.
def patch_external_bank_account(external_bank_account_guid, patch_external_bank_account_bank_model, opts = {}) data, _status_code, _headers = patch_external_bank_account_with_http_info(external_bank_account_guid, patch_external_bank_account_bank_model, opts) data end
def patch_external_bank_account_with_http_info(external_bank_account_guid, patch_external_bank_account_bank_model, opts = {})
-
(Array<(ExternalBankAccountBankModel, Integer, Hash)>)- ExternalBankAccountBankModel data, response status code and response headers
Parameters:
-
opts(Hash) -- the optional parameters -
patch_external_bank_account_bank_model(PatchExternalBankAccountBankModel) -- -
external_bank_account_guid(String) -- Identifier for the external bank account.
def patch_external_bank_account_with_http_info(external_bank_account_guid, patch_external_bank_account_bank_model, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ExternalBankAccountsBankApi.patch_external_bank_account ...' end # verify the required parameter 'external_bank_account_guid' is set if @api_client.config.client_side_validation && external_bank_account_guid.nil? fail ArgumentError, "Missing the required parameter 'external_bank_account_guid' when calling ExternalBankAccountsBankApi.patch_external_bank_account" end # verify the required parameter 'patch_external_bank_account_bank_model' is set if @api_client.config.client_side_validation && patch_external_bank_account_bank_model.nil? fail ArgumentError, "Missing the required parameter 'patch_external_bank_account_bank_model' when calling ExternalBankAccountsBankApi.patch_external_bank_account" end # resource path local_var_path = '/api/external_bank_accounts/{external_bank_account_guid}'.sub('{' + 'external_bank_account_guid' + '}', CGI.escape(external_bank_account_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']) # 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(patch_external_bank_account_bank_model) # return_type return_type = opts[:debug_return_type] || 'ExternalBankAccountBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"ExternalBankAccountsBankApi.patch_external_bank_account", :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(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: ExternalBankAccountsBankApi#patch_external_bank_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end