Class: TransferZero::AccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/transferzero-sdk/api/accounts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountsApi

Returns a new instance of AccountsApi.



19
20
21
 
# File 'lib/transferzero-sdk/api/accounts_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/transferzero-sdk/api/accounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_account(currency, opts = {}) ⇒ AccountResponse

Fetches account balance for specified currrency Fetches account balance for specified currrency, and returns current balance and associated currency code

Parameters:

  • currency —

    Currency code of account balance to fetch Example: `/v1/accounts/USD`

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

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/transferzero-sdk/api/accounts_api.rb', line 29

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

#get_account_with_http_info(currency, opts = {}) ⇒ Array<(AccountResponse, Fixnum, Hash)>

Fetches account balance for specified currrency Fetches account balance for specified currrency, and returns current balance and associated currency code

Parameters:

  • currency —

    Currency code of account balance to fetch Example: &#x60;/v1/accounts/USD&#x60;

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

    the optional parameters

Returns:

  • (Array<(AccountResponse, Fixnum, Hash)>) —

    AccountResponse data, response status code and response headers



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
 
# File 'lib/transferzero-sdk/api/accounts_api.rb', line 39

def (currency, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_account ...'
  end
  # verify the required parameter 'currency' is set
  if @api_client.config.client_side_validation && currency.nil?
    fail ArgumentError, "Missing the required parameter 'currency' when calling AccountsApi.get_account"
  end
  # resource path
  local_var_path = '/accounts/{Currency}'.sub('{' + 'Currency' + '}', currency.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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
  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 => 'AccountResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_accounts(opts = {}) ⇒ AccountListResponse

Fetches account balances for all currencies Fetches account balances for all currencies, and returns an array of the current balances and associated currency codes.

Parameters:

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

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/transferzero-sdk/api/accounts_api.rb', line 92

def get_accounts(opts = {})
  data, _status_code, _headers = get_accounts_with_http_info(opts)
  data
end

#get_accounts_all(opts = {}) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/transferzero-sdk/api/accounts_api.rb', line 77

def get_accounts_all(opts = {})
  result = []
  response = get_accounts(opts)
  result += response["object"]
  while next_page = response["meta"]["pagination"]["next_page"]
    response = get_accounts(opts.merge(page: next_page))
    result += response["object"]
  end
  result
end

#get_accounts_with_http_info(opts = {}) ⇒ Array<(AccountListResponse, Fixnum, Hash)>

Fetches account balances for all currencies Fetches account balances for all currencies, and returns an array of the current balances and associated currency codes.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AccountListResponse, Fixnum, Hash)>) —

    AccountListResponse data, response status code and response headers



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
 
# File 'lib/transferzero-sdk/api/accounts_api.rb', line 101

def get_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...'
  end
  # resource path
  local_var_path = '/accounts'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
  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 => 'AccountListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end