Class: Atrium::AccountsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/atrium-ruby/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.



15
16
17
 
# File 'lib/atrium-ruby/api/accounts_api.rb', line 15

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/atrium-ruby/api/accounts_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#list_account_transactions(account_guid, user_guid, opts = {}) ⇒ TransactionsResponseBody

List account transactions This endpoint allows you to see every transaction that belongs to a specific account. The default from_date is 90 days prior to the request, and the default to_date is 5 days from the time of the request.
The from_date and to_date parameters can optionally be appended to the request.

Parameters:

  • account_guid —

    The unique identifier for an `account`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Options Hash (opts):

  • :from_date (String) —

    Filter transactions from this date.

  • :to_date (String) —

    Filter transactions to this date.

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



28
29
30
31
 
# File 'lib/atrium-ruby/api/accounts_api.rb', line 28

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

#list_user_accounts(user_guid, opts = {}) ⇒ AccountsResponseBody

List accounts for a user Use this endpoint to view information about every account that belongs to a user. You’ll need the user’s GUID to access this list. The information will include the account type — e.g., CHECKING, MONEY_MARKET, or PROPERTY — the account balance, the date the account was started, etc.

Parameters:

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Specify current page.

  • :records_per_page (Integer) —

    Specify records per page.

Returns:



40
41
42
43
 
# File 'lib/atrium-ruby/api/accounts_api.rb', line 40

def list_user_accounts(user_guid, opts = {})
  data, _status_code, _headers = list_user_accounts_with_http_info(user_guid, opts)
  data
end

#read_account(account_guid, user_guid, opts = {}) ⇒ AccountResponseBody

Read an account Reading an account allows you to get information about a specific account that belongs to a user. That includes the account type — e.g., CHECKING, MONEY_MARKET, or PROPERTY — the balance, the date the account was started, and much more.
There are two endpoints for reading an account. Both will return the same information.
It’s important to remember that balance and available_balance will normally be positive numbers — for all account types. But this should be interpreted differently for debt accounts and asset accounts.
An asset account, e.g., CHECKING, SAVINGS, or INVESTMENT, will have a positive balance unless it is in an overdraft condition, in which case the balance will be negative.
On the other hand, a debt account, e.g., CREDIT CARD, LOAN, MORTGAGE, would have a positivebalance when the user owes money on the account. It would have a negative balance if the account has been overpaid.

Parameters:

  • account_guid —

    The unique identifier for an `account`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Returns:



51
52
53
54
 
# File 'lib/atrium-ruby/api/accounts_api.rb', line 51

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

#read_account_by_member_guid(account_guid, member_guid, user_guid, opts = {}) ⇒ AccountResponseBody

Read an account Reading an account allows you to get information about a specific account that belongs to a user. That includes the account type — e.g., CHECKING, MONEY_MARKET, or PROPERTY — the balance, the date the account was started, and much more.
There are two endpoints for reading an account. Both will return the same information.
It’s important to remember that balance and available_balance will normally be positive numbers — for all account types. But this should be interpreted differently for debt accounts and asset accounts.
An asset account, e.g., CHECKING, SAVINGS, or INVESTMENT, will have a positive balance unless it is in an overdraft condition, in which case the balance will be negative.
On the other hand, a debt account, e.g., CREDIT CARD, LOAN, MORTGAGE, would have a positivebalance when the user owes money on the account. It would have a negative balance if the account has been overpaid.

Parameters:

  • account_guid —

    The unique identifier for an `account`.

  • member_guid —

    The unique identifier for a `member`.

  • user_guid —

    The unique identifier for a `user`.

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

    the optional parameters

Returns:



63
64
65
66
 
# File 'lib/atrium-ruby/api/accounts_api.rb', line 63

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