docs/AccountsApi.md in atrium-ruby-2.4.0 vs docs/AccountsApi.md in atrium-ruby-2.5.0

- old
+ new

@@ -7,11 +7,11 @@ [**read_account**](AccountsApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read an account [**read_account_by_member_guid**](AccountsApi.md#read_account_by_member_guid) | **GET** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Read an account # **list_account_transactions** -> TransactionsResponseBody list_account_transactions(account_guid, user_guid, opts) +> TransactionsResponseBody list_account_transactions(account_guid, user_guid, , opts) 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.<br> The from_date and to_date parameters can optionally be appended to the request. @@ -31,11 +31,11 @@ records_per_page: 12 # Integer | Specify records per page. } begin #List account transactions - response = client.accounts.list_account_transactions(account_guid, user_guid, opts) + response = client.accounts.list_account_transactions(account_guid, user_guid, , opts) p response rescue Atrium::ApiError => e puts "Exception when calling AccountsApi->list_account_transactions: #{e}" end ``` @@ -54,11 +54,11 @@ ### Return type [**TransactionsResponseBody**](TransactionsResponseBody.md) # **list_user_accounts** -> AccountsResponseBody list_user_accounts(user_guid, opts) +> AccountsResponseBody list_user_accounts(user_guid, , opts) 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. @@ -75,11 +75,11 @@ records_per_page: 12 # Integer | Specify records per page. } begin #List accounts for a user - response = client.accounts.list_user_accounts(user_guid, opts) + response = client.accounts.list_user_accounts(user_guid, , opts) p response rescue Atrium::ApiError => e puts "Exception when calling AccountsApi->list_user_accounts: #{e}" end ``` @@ -95,11 +95,11 @@ ### Return type [**AccountsResponseBody**](AccountsResponseBody.md) # **read_account** -> AccountResponseBody read_account(account_guid, user_guid) +> AccountResponseBody read_account(account_guid, user_guid, ) 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.<br> There are two endpoints for reading an account. Both will return the same information.<br> 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.<br> 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.<br> 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. @@ -113,11 +113,11 @@ account_guid = "ACT-123" # String | The unique identifier for an `account`. user_guid = "USR-123" # String | The unique identifier for a `user`. begin #Read an account - response = client.accounts.read_account(account_guid, user_guid) + response = client.accounts.read_account(account_guid, user_guid, ) p response rescue Atrium::ApiError => e puts "Exception when calling AccountsApi->read_account: #{e}" end ``` @@ -132,11 +132,11 @@ ### Return type [**AccountResponseBody**](AccountResponseBody.md) # **read_account_by_member_guid** -> AccountResponseBody read_account_by_member_guid(account_guid, member_guid, user_guid) +> AccountResponseBody read_account_by_member_guid(account_guid, member_guid, user_guid, ) 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.<br> There are two endpoints for reading an account. Both will return the same information.<br> 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.<br> 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.<br> 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. @@ -151,10 +151,10 @@ member_guid = "MBR-123" # String | The unique identifier for a `member`. user_guid = "USR-123" # String | The unique identifier for a `user`. begin #Read an account - response = client.accounts.read_account_by_member_guid(account_guid, member_guid, user_guid) + response = client.accounts.read_account_by_member_guid(account_guid, member_guid, user_guid, ) p response rescue Atrium::ApiError => e puts "Exception when calling AccountsApi->read_account_by_member_guid: #{e}" end ```