Class: SubfiPay::BalanceTransactionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subfi_pay/api/balance_transactions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BalanceTransactionsApi

Returns a new instance of BalanceTransactionsApi.



19
20
21
 
# File 'lib/subfi_pay/api/balance_transactions_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/subfi_pay/api/balance_transactions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_balance_transactions(x_api_version, x_account_id, opts = {}) ⇒ ListBalanceTransactionsResponse

List all balance transactions

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of results to retrieve.

  • :per_page (Integer) —

    Number of results per page.

  • :connected_account_id (String) —

    Filter results by sub_merchant ID.

Returns:



30
31
32
33
 
# File 'lib/subfi_pay/api/balance_transactions_api.rb', line 30

def list_balance_transactions(x_api_version, , opts = {})
  data, _status_code, _headers = list_balance_transactions_with_http_info(x_api_version, , opts)
  data
end

#list_balance_transactions_with_http_info(x_api_version, x_account_id, opts = {}) ⇒ Array<(ListBalanceTransactionsResponse, Integer, Hash)>

List all balance transactions

Parameters:

  • x_api_version (String)
  • x_account_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of results to retrieve.

  • :per_page (Integer) —

    Number of results per page.

  • :connected_account_id (String) —

    Filter results by sub_merchant ID.

Returns:



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
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/subfi_pay/api/balance_transactions_api.rb', line 43

def list_balance_transactions_with_http_info(x_api_version, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BalanceTransactionsApi.list_balance_transactions ...'
  end
  # verify the required parameter 'x_api_version' is set
  if @api_client.config.client_side_validation && x_api_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_api_version' when calling BalanceTransactionsApi.list_balance_transactions"
  end
  # verify the required parameter 'x_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_id' when calling BalanceTransactionsApi.list_balance_transactions"
  end
  # resource path
  local_var_path = '/balance_transactions'

  # 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[:'connected_account_id'] = opts[:'connected_account_id'] if !opts[:'connected_account_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Api-Version'] = x_api_version
  header_params[:'X-Account-Id'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

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