Class: UpBankingClient::AccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/up_banking/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/up_banking/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/up_banking/api/accounts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#accounts_get(opts = {}) ⇒ ListAccountsResponse

List accounts Retrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the ‘prev` and `next` links where present.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records to return in each page.

  • :filter_account_type (AccountTypeEnum) —

    The type of account for which to return records. This can be used to filter Savers from spending accounts.

  • :filter_ownership_type (OwnershipTypeEnum) —

    The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts.

Returns:



29
30
31
32
 
# File 'lib/up_banking/api/accounts_api.rb', line 29

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

#accounts_get_with_http_info(opts = {}) ⇒ Array<(ListAccountsResponse, Integer, Hash)>

List accounts Retrieve a paginated list of all accounts for the currently authenticated user. The returned list is paginated and can be scrolled by following the &#x60;prev&#x60; and &#x60;next&#x60; links where present.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of records to return in each page.

  • :filter_account_type (AccountTypeEnum) —

    The type of account for which to return records. This can be used to filter Savers from spending accounts.

  • :filter_ownership_type (OwnershipTypeEnum) —

    The account ownership structure for which to return records. This can be used to filter 2Up accounts from Up accounts.

Returns:

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

    ListAccountsResponse data, response status code and response headers



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
84
85
86
 
# File 'lib/up_banking/api/accounts_api.rb', line 41

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'filter[accountType]'] = opts[:'filter_account_type'] if !opts[:'filter_account_type'].nil?
  query_params[:'filter[ownershipType]'] = opts[:'filter_ownership_type'] if !opts[:'filter_ownership_type'].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] || 'ListAccountsResponse'

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

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

#accounts_id_get(id, opts = {}) ⇒ GetAccountResponse

Retrieve account Retrieve a specific account by providing its unique identifier.

Parameters:

  • id (String) —

    The unique identifier for the account.

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

    the optional parameters

Returns:



93
94
95
96
 
# File 'lib/up_banking/api/accounts_api.rb', line 93

def accounts_id_get(id, opts = {})
  data, _status_code, _headers = accounts_id_get_with_http_info(id, opts)
  data
end

#accounts_id_get_with_http_info(id, opts = {}) ⇒ Array<(GetAccountResponse, Integer, Hash)>

Retrieve account Retrieve a specific account by providing its unique identifier.

Parameters:

  • id (String) —

    The unique identifier for the account.

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

    the optional parameters

Returns:

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

    GetAccountResponse data, response status code and response headers



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
 
# File 'lib/up_banking/api/accounts_api.rb', line 103

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

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

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