Class: MoneyKit::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/api/users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



17
18
19
 
# File 'lib/moneykit/api/users_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/moneykit/api/users_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#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:



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

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



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
93
94
95
96
 
# File 'lib/moneykit/api/users_api.rb', line 42

def get_user_accounts_with_http_info(id, opts = {})
  @api_client.config.logger.debug 'Calling API: UsersApi.get_user_accounts ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    raise ArgumentError, "Missing the required parameter 'id' when calling UsersApi.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] || {}
  unless opts[:account_id].nil?
    query_params[:account_id] =
      @api_client.build_collection_param(opts[:account_id], :multi)
  end
  unless opts[:institution_id].nil?
    query_params[:institution_id] =
      @api_client.build_collection_param(opts[:institution_id], :multi)
  end

  # 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] unless 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: :"UsersApi.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: UsersApi#get_user_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end

#get_user_links(id, opts = {}) ⇒ GetUserLinksResponse

/users/id/links Fetches all links 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):

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

Returns:



104
105
106
107
 
# File 'lib/moneykit/api/users_api.rb', line 104

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

#get_user_links_with_http_info(id, opts = {}) ⇒ Array<(GetUserLinksResponse, Integer, Hash)>

/users/id/links Fetches all links 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):

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

Returns:

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

    GetUserLinksResponse data, response status code and response headers



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
159
160
161
 
# File 'lib/moneykit/api/users_api.rb', line 115

def get_user_links_with_http_info(id, opts = {})
  @api_client.config.logger.debug 'Calling API: UsersApi.get_user_links ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    raise ArgumentError, "Missing the required parameter 'id' when calling UsersApi.get_user_links"
  end

  # resource path
  local_var_path = '/users/{id}/links'.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] unless 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] || 'GetUserLinksResponse'

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

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

#get_user_transactions(id, opts = {}) ⇒ GetUserTransactionsResponse

/users/id/transactions Fetches transactions for a <a href=#operation/get_user_accounts>user</a>. <p>This endpoint fetches all transactions for a user across all of their links. You can use it to retrieve transactions from any or all accounts at once, regardless of which institution they belong to.

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):

  • :transaction_type (Array<TransactionTypeFilter>)
  • :category (Array<String>)
  • :account_id (Array<String>) —

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

  • :institution_id (Array<String>) —

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

  • :page (Integer) —

    The page number to return. (default to 1)

  • :size (Integer) —

    The number of items to return per page. (default to 50)

  • :start_date (String) —

    The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the &#x60;end_date&#x60;. &lt;p&gt;If you want to retrieve all transactions, use &#x60;1900-01-01&#x60;.

  • :end_date (String) —

    The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.

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

Returns:



177
178
179
180
 
# File 'lib/moneykit/api/users_api.rb', line 177

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

#get_user_transactions_with_http_info(id, opts = {}) ⇒ Array<(GetUserTransactionsResponse, Integer, Hash)>

/users/id/transactions Fetches transactions for a &lt;a href&#x3D;#operation/get_user_accounts&gt;user&lt;/a&gt;. &lt;p&gt;This endpoint fetches all transactions for a user across all of their links. You can use it to retrieve transactions from any or all accounts at once, regardless of which institution they belong to.

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):

  • :transaction_type (Array<TransactionTypeFilter>)
  • :category (Array<String>)
  • :account_id (Array<String>) —

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

  • :institution_id (Array<String>) —

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

  • :page (Integer) —

    The page number to return. (default to 1)

  • :size (Integer) —

    The number of items to return per page. (default to 50)

  • :start_date (String) —

    The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the &#x60;end_date&#x60;. &lt;p&gt;If you want to retrieve all transactions, use &#x60;1900-01-01&#x60;.

  • :end_date (String) —

    The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.

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

Returns:

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

    GetUserTransactionsResponse data, response status code and response headers



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
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
 
# File 'lib/moneykit/api/users_api.rb', line 196

def get_user_transactions_with_http_info(id, opts = {})
  @api_client.config.logger.debug 'Calling API: UsersApi.get_user_transactions ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    raise ArgumentError, "Missing the required parameter 'id' when calling UsersApi.get_user_transactions"
  end

  if @api_client.config.client_side_validation && !opts[:page].nil? && opts[:page] < 1
    raise ArgumentError,
          'invalid value for "opts[:"page"]" when calling UsersApi.get_user_transactions, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:size].nil? && opts[:size] > 100
    raise ArgumentError,
          'invalid value for "opts[:"size"]" when calling UsersApi.get_user_transactions, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:size].nil? && opts[:size] < 1
    raise ArgumentError,
          'invalid value for "opts[:"size"]" when calling UsersApi.get_user_transactions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/users/{id}/transactions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  unless opts[:transaction_type].nil?
    query_params[:transaction_type] =
      @api_client.build_collection_param(opts[:transaction_type], :multi)
  end
  unless opts[:category].nil?
    query_params[:category] =
      @api_client.build_collection_param(opts[:category], :multi)
  end
  unless opts[:account_id].nil?
    query_params[:account_id] =
      @api_client.build_collection_param(opts[:account_id], :multi)
  end
  unless opts[:institution_id].nil?
    query_params[:institution_id] =
      @api_client.build_collection_param(opts[:institution_id], :multi)
  end
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:size] = opts[:size] unless opts[:size].nil?
  query_params[:start_date] = opts[:start_date] unless opts[:start_date].nil?
  query_params[:end_date] = opts[:end_date] unless opts[:end_date].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] unless 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] || 'GetUserTransactionsResponse'

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

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