Class: MoneyKit::AccountsApi

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

def api_client
  @api_client
end

Instance Method Details

#get_account(id, account_id, opts = {}) ⇒ GetAccountResponse

/links/id/accounts/account_id Fetches a single account associated with a <a href=#tag/Links>link</a>.

Parameters:

  • id (String) —

    The unique ID for this link.

  • account_id (String) —

    The account ID to fetch.

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

    the optional parameters

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18'

Returns:



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

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

#get_account_numbers(id, opts = {}) ⇒ GetAccountNumbersResponse

/links/id/accounts/numbers Returns a list of open, permissioned accounts associated with a <a href=#tag/Links>link</a>, including full account and routing numbers for appropriate accounts (such as checking and savings accounts). <p>Note that this endpoint does not trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because ‘prefetch` was requested when the link was created, or because of an on-demand update. **To force a check for new/updated account numbers, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18'

Returns:



100
101
102
103
 
# File 'lib/moneykit/api/accounts_api.rb', line 100

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

#get_account_numbers_with_http_info(id, opts = {}) ⇒ Array<(GetAccountNumbersResponse, Integer, Hash)>

/links/id/accounts/numbers Returns a list of open, permissioned accounts associated with a &lt;a href&#x3D;#tag/Links&gt;link&lt;/a&gt;, including full account and routing numbers for appropriate accounts (such as checking and savings accounts). &lt;p&gt;Note that this endpoint does not trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because &#x60;prefetch&#x60; was requested when the link was created, or because of an on-demand update. **To force a check for new/updated account numbers, you must use the &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.** &lt;p&gt;If you have requested prefetch or an on-demand update, you should check the &#x60;refreshed_at&#x60; date for this product in the returned response, and compare that against the previous &#x60;refreshed_at&#x60; date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18'

Returns:

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

    GetAccountNumbersResponse data, response status code and response headers



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
150
151
152
153
154
155
156
157
158
 
# File 'lib/moneykit/api/accounts_api.rb', line 111

def (id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_account_numbers ...'
  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.get_account_numbers"
  end
  # resource path
  local_var_path = '/links/{id}/accounts/numbers'.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'])
  header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?

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

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

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

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

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

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

/links/id/accounts/account_id Fetches a single account associated with a &lt;a href&#x3D;#tag/Links&gt;link&lt;/a&gt;.

Parameters:

  • id (String) —

    The unique ID for this link.

  • account_id (String) —

    The account ID to fetch.

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

    the optional parameters

Options Hash (opts):

  • :moneykit_version (String) — default: default to '2023-02-18'

Returns:

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

    GetAccountResponse 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
87
88
89
90
91
92
 
# File 'lib/moneykit/api/accounts_api.rb', line 41

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

  # 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] || ['OAuth2ClientCredentials']

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

#get_accounts(id, opts = {}) ⇒ GetAccountsResponse

/links/id/accounts Returns a list of open, permissioned accounts associated with a <a href=#tag/Links>link</a>.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :account_ids (Array<String>) —

    An optional list of account IDs to filter the results.

  • :moneykit_version (String) — default: default to '2023-02-18'

Returns:



167
168
169
170
 
# File 'lib/moneykit/api/accounts_api.rb', line 167

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

#get_accounts_with_http_info(id, opts = {}) ⇒ Array<(GetAccountsResponse, Integer, Hash)>

/links/id/accounts Returns a list of open, permissioned accounts associated with a &lt;a href&#x3D;#tag/Links&gt;link&lt;/a&gt;.

Parameters:

  • id (String) —

    The unique ID for this link.

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

    the optional parameters

Options Hash (opts):

  • :account_ids (Array<String>) —

    An optional list of account IDs to filter the results.

  • :moneykit_version (String) — default: default to '2023-02-18'

Returns:

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

    GetAccountsResponse data, response status code and response headers



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/moneykit/api/accounts_api.rb', line 179

def get_accounts_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...'
  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.get_accounts"
  end
  # resource path
  local_var_path = '/links/{id}/accounts'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].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[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?

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

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

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

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

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

#get_user_accounts(id, opts = {}) ⇒ GetUserAccountsResponse

/users/id/accounts Fetches all accounts belonging to a <a href=#operation/get_user_accounts>user</a>.

Parameters:

  • id (String) —

    The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;#operation/create_link_session&gt;/link-session&lt;/a&gt; to create any link for this user.

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

    the optional parameters

Options Hash (opts):

  • :account_id (Array<String>) —

    If present, filters results to accounts matching the given IDs.

  • :institution_id (Array<String>) —

    If present, filters results to accounts at institutions matching the given IDs.

  • :moneykit_version (String) — default: default to '2023-02-18'

Returns:



237
238
239
240
 
# File 'lib/moneykit/api/accounts_api.rb', line 237

def get_user_accounts(id, opts = {})
  data, _status_code, _headers = get_user_accounts_with_http_info(id, opts)
  data
end

#get_user_accounts_with_http_info(id, opts = {}) ⇒ Array<(GetUserAccountsResponse, Integer, Hash)>

/users/id/accounts Fetches all accounts belonging to a &lt;a href&#x3D;#operation/get_user_accounts&gt;user&lt;/a&gt;.

Parameters:

  • id (String) —

    The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;#operation/create_link_session&gt;/link-session&lt;/a&gt; to create any link for this user.

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

    the optional parameters

Options Hash (opts):

  • :account_id (Array<String>) —

    If present, filters results to accounts matching the given IDs.

  • :institution_id (Array<String>) —

    If present, filters results to accounts at institutions matching the given IDs.

  • :moneykit_version (String) — default: default to '2023-02-18'

Returns:

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

    GetUserAccountsResponse data, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/moneykit/api/accounts_api.rb', line 250

def get_user_accounts_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_user_accounts ...'
  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.get_user_accounts"
  end
  # resource path
  local_var_path = '/users/{id}/accounts'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_id'] = @api_client.build_collection_param(opts[:'account_id'], :multi) if !opts[:'account_id'].nil?
  query_params[:'institution_id'] = @api_client.build_collection_param(opts[:'institution_id'], :multi) if !opts[:'institution_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[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?

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

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

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

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

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