atrium-ruby 1.3.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 279c66eac36024e6ab3cfacdd9243dd784f1676ad87e0d0175d84cc147b7d5d6
-  data.tar.gz: cdb8839bcf632ee70df7899d3873e92cad318558dfa0350dbf8ccce90ed8261b
+SHA1:
+  metadata.gz: c9624847519c952560ff039cbc406308dcc99adf
+  data.tar.gz: 12ca20e1f16b2ef8286196d399345d268382e8e0
 SHA512:
-  metadata.gz: ddc08d12886e56bbb2dfd2f2fe3bbcf19c618f9376b518037ec723fce28c236669cbac653885cbd6af55fbb0d33b5b0e4076091cac3833e90c083cd61a1e9d66
-  data.tar.gz: 4dab84a369eeaf288c6829d077c0965bfff26c9f33dc61416cb4bcc824f413b175ff28588c79632e3bece261b772f7c6944b68deefcab044d141606896bad4e0
+  metadata.gz: 582cb421c757a5c23ca4362e56b814d9350afc2d69f654cfc277719f7bb408e0acbc9d254e160bf042d6c9c0a2d39131fdbaff333bdcadfc37cb09cb443d282a
+  data.tar.gz: 2e28386f660dbe81c80cfa86725d77d08db1cc425229eeb1b2d55c060e4909447267ca0df9490cb54d22e9df824256a5a8ba867599f2f0c61da2e86afc503e3c

data/Gemfile

@@ -1,4 +1,7 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in mx-atrium-ruby.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -1,88 +1,154 @@
-# Atrium-Ruby [![Build Status](https://travis-ci.org/mxenabled/atrium-ruby.svg?branch=master)](https://travis-ci.org/mxenabled/atrium-ruby)
+# atrium-ruby
 
-A Ruby wrapper for use with the [MX Atrium API](https://atrium.mx.com). In order to make requests, you will need to [sign up for MX Atrium API](https://atrium.mx.com/developers/sign_up) and get a `MX-API-KEY` and `MX-CLIENT-ID`. Then, configure your instance with:
-```ruby
-Atrium.configure do |config|
-  config.mx_api_key = YOUR_API_KEY
-  config.mx_client_id = YOUR_CLIENT_ID
-  config.base_url = "https://atrium.mx.com" # base_url is set to "https://vestibule.mx.com" by default
-end
-```
+Atrium - the Ruby gem for the MX API
 
-From there, you can start using some basic class methods to make calls for data. See our [full documentation](https://atrium.mx.com/documentation) for more details.
+The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
 
-## Examples
+## Installation
 
-### Pagination
+### Build a gem
 
-The following demonstrates how you can read data back from the API in a memory efficient way using built-in pagination
-helpers. You can also specify query parameters such as `from_date` and `to_date`.
+To build the Ruby code into a gem:
 
-```ruby
-::Atrium::User.list_each do |user|
-  user.each_member do |member|
-    puts member.name
-    puts member.accounts.total_entries
-
-    member.each_account do |account|
-      puts account.name
-      puts account.transactions.total_entries
-
-      account.each_transaction do |transaction|
-        puts transaction.description
-      end
-    end
-  end
-
-  user.each_account do |account|
-    puts account.name
-    puts account.transactions.total_entries
-
-    account.each_transaction do |transaction|
-      puts transaction.description
-    end
-  end
-
-  user.each_transaction do |transaction|
-    puts transaction.description
-  end
-end
+```shell
+gem build atrium-ruby.gemspec
 ```
 
-### Date Range
+Then either install the gem locally:
 
-You can specify `from_date` and `to_date` to limit or widen your search. For example:
+```shell
+gem install ./atrium-ruby-2.0.0.gem
+```
 
-```ruby
-from_date = ::Date.new(2017, 02, 18)
-to_date = ::Date.new(2017, 03, 18)
-params = {:from_date => from_date, :to_date => to_date}
+Finally add this to the Gemfile:
 
-::Atrium::Transaction.list_each(:user_guid => "USR-123", :query_params => params) do |transaction|
-  puts transaction.description
-end
-```
+    gem 'atrium-ruby', '~> 2.0.0'
 
-## Installation
+### Install from Git
 
-Add this line to your application's Gemfile:
+Add the following in the Gemfile:
 
-```ruby
-gem 'atrium-ruby'
-```
+    gem 'atrium-ruby', :git => 'https://github.com/mxenabled/atrium-ruby.git'
 
-And then execute:
+### Include the Ruby code directly
 
-    $ bundle
+Include the Ruby code directly using `-I` as follows:
 
-Or install it yourself as:
+```shell
+ruby -Ilib script.rb
+```
 
-    $ gem install atrium-ruby
+## Example Usage
 
-## Development
+Please see `docs` directory for additional endpoint examples
+```ruby
+# Load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+account_guid = "ACT-123" # String | The unique identifier for an `account`.
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+opts = { 
+  from_date: "2016-09-20", # String | Filter transactions from this date.
+  to_date: "2016-10-20" # String | Filter transactions to this date.
+  page: 1, # Integer | Specify current page.
+  records_per_page: 12, # Integer | Specify records per page.
+}
+
+begin
+  #List account transactions
+  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
 
-Suggested implementation flow can be found in `bin/demo` comments. You can also use that as an executable for managing the settings and creating your own test flow to handle the requests and data with `./bin/demo`
+```
 
-## Contributing
+## Documentation for API Endpoints
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Atrium::AccountsApi* | [**list_account_transactions**](docs/AccountsApi.md#list_account_transactions) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List account transactions
+*Atrium::AccountsApi* | [**list_user_accounts**](docs/AccountsApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts for a user
+*Atrium::AccountsApi* | [**read_account**](docs/AccountsApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read an account
+*Atrium::AccountsApi* | [**read_account_by_member_guid**](docs/AccountsApi.md#read_account_by_member_guid) | **GET** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Read an account
+*Atrium::ConnectWidgetApi* | [**get_connect_widget**](docs/ConnectWidgetApi.md#get_connect_widget) | **POST** /users/{user_guid}/connect_widget_url | Embedding in a website
+*Atrium::IdentityApi* | [**identify_member**](docs/IdentityApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify
+*Atrium::IdentityApi* | [**list_account_owners**](docs/IdentityApi.md#list_account_owners) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List member account owners
+*Atrium::InstitutionsApi* | [**list_institutions**](docs/InstitutionsApi.md#list_institutions) | **GET** /institutions | List institutions
+*Atrium::InstitutionsApi* | [**read_institution**](docs/InstitutionsApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution
+*Atrium::InstitutionsApi* | [**read_institution_credentials**](docs/InstitutionsApi.md#read_institution_credentials) | **GET** /institutions/{institution_code}/credentials | Read institution credentials
+*Atrium::MembersApi* | [**aggregate_member**](docs/MembersApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
+*Atrium::MembersApi* | [**create_member**](docs/MembersApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
+*Atrium::MembersApi* | [**delete_member**](docs/MembersApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
+*Atrium::MembersApi* | [**list_member_accounts**](docs/MembersApi.md#list_member_accounts) | **GET** /users/{user_guid}/members/{member_guid}/accounts | List member accounts
+*Atrium::MembersApi* | [**list_member_credentials**](docs/MembersApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials
+*Atrium::MembersApi* | [**list_member_mfa_challenges**](docs/MembersApi.md#list_member_mfa_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member MFA challenges
+*Atrium::MembersApi* | [**list_member_transactions**](docs/MembersApi.md#list_member_transactions) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List member transactions
+*Atrium::MembersApi* | [**list_members**](docs/MembersApi.md#list_members) | **GET** /users/{user_guid}/members | List members
+*Atrium::MembersApi* | [**read_member**](docs/MembersApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member
+*Atrium::MembersApi* | [**read_member_status**](docs/MembersApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member connection status
+*Atrium::MembersApi* | [**resume_member**](docs/MembersApi.md#resume_member) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation from MFA
+*Atrium::MembersApi* | [**update_member**](docs/MembersApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member
+*Atrium::TransactionsApi* | [**cleanse_and_categorize_transactions**](docs/TransactionsApi.md#cleanse_and_categorize_transactions) | **POST** /cleanse_and_categorize | Categorize transactions
+*Atrium::TransactionsApi* | [**list_user_transactions**](docs/TransactionsApi.md#list_user_transactions) | **GET** /users/{user_guid}/transactions | List transactions for a user
+*Atrium::TransactionsApi* | [**read_transaction**](docs/TransactionsApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read a transaction
+*Atrium::UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /users | Create user
+*Atrium::UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user
+*Atrium::UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /users | List users
+*Atrium::UsersApi* | [**read_user**](docs/UsersApi.md#read_user) | **GET** /users/{user_guid} | Read user
+*Atrium::UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /users/{user_guid} | Update user
+*Atrium::VerificationApi* | [**list_account_numbers**](docs/VerificationApi.md#list_account_numbers) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | Read account numbers
+*Atrium::VerificationApi* | [**list_account_numbers_by_account**](docs/VerificationApi.md#list_account_numbers_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/account_numbers | Read account numbers by account GUID
+*Atrium::VerificationApi* | [**verify_member**](docs/VerificationApi.md#verify_member) | **POST** /users/{user_guid}/members/{member_guid}/verify | Verify
+
+
+## Documentation for Models
+
+ - [Atrium::Account](docs/Account.md)
+ - [Atrium::AccountNumber](docs/AccountNumber.md)
+ - [Atrium::AccountNumbersResponseBody](docs/AccountNumbersResponseBody.md)
+ - [Atrium::AccountOwner](docs/AccountOwner.md)
+ - [Atrium::AccountOwnersResponseBody](docs/AccountOwnersResponseBody.md)
+ - [Atrium::AccountResponseBody](docs/AccountResponseBody.md)
+ - [Atrium::AccountsResponseBody](docs/AccountsResponseBody.md)
+ - [Atrium::Challenge](docs/Challenge.md)
+ - [Atrium::ChallengeOption](docs/ChallengeOption.md)
+ - [Atrium::ChallengesResponseBody](docs/ChallengesResponseBody.md)
+ - [Atrium::ConnectWidget](docs/ConnectWidget.md)
+ - [Atrium::ConnectWidgetRequestBody](docs/ConnectWidgetRequestBody.md)
+ - [Atrium::ConnectWidgetResponseBody](docs/ConnectWidgetResponseBody.md)
+ - [Atrium::CredentialOption](docs/CredentialOption.md)
+ - [Atrium::CredentialRequest](docs/CredentialRequest.md)
+ - [Atrium::CredentialResponse](docs/CredentialResponse.md)
+ - [Atrium::CredentialsResponseBody](docs/CredentialsResponseBody.md)
+ - [Atrium::Institution](docs/Institution.md)
+ - [Atrium::InstitutionResponseBody](docs/InstitutionResponseBody.md)
+ - [Atrium::InstitutionsResponseBody](docs/InstitutionsResponseBody.md)
+ - [Atrium::Member](docs/Member.md)
+ - [Atrium::MemberConnectionStatus](docs/MemberConnectionStatus.md)
+ - [Atrium::MemberConnectionStatusResponseBody](docs/MemberConnectionStatusResponseBody.md)
+ - [Atrium::MemberCreateRequest](docs/MemberCreateRequest.md)
+ - [Atrium::MemberCreateRequestBody](docs/MemberCreateRequestBody.md)
+ - [Atrium::MemberResponseBody](docs/MemberResponseBody.md)
+ - [Atrium::MemberResumeRequest](docs/MemberResumeRequest.md)
+ - [Atrium::MemberResumeRequestBody](docs/MemberResumeRequestBody.md)
+ - [Atrium::MemberUpdateRequest](docs/MemberUpdateRequest.md)
+ - [Atrium::MemberUpdateRequestBody](docs/MemberUpdateRequestBody.md)
+ - [Atrium::MembersResponseBody](docs/MembersResponseBody.md)
+ - [Atrium::Pagination](docs/Pagination.md)
+ - [Atrium::Transaction](docs/Transaction.md)
+ - [Atrium::TransactionCleanseAndCategorizeRequest](docs/TransactionCleanseAndCategorizeRequest.md)
+ - [Atrium::TransactionCleanseAndCategorizeResponse](docs/TransactionCleanseAndCategorizeResponse.md)
+ - [Atrium::TransactionResponseBody](docs/TransactionResponseBody.md)
+ - [Atrium::TransactionsCleanseAndCategorizeRequestBody](docs/TransactionsCleanseAndCategorizeRequestBody.md)
+ - [Atrium::TransactionsCleanseAndCategorizeResponseBody](docs/TransactionsCleanseAndCategorizeResponseBody.md)
+ - [Atrium::TransactionsResponseBody](docs/TransactionsResponseBody.md)
+ - [Atrium::User](docs/User.md)
+ - [Atrium::UserCreateRequestBody](docs/UserCreateRequestBody.md)
+ - [Atrium::UserResponseBody](docs/UserResponseBody.md)
+ - [Atrium::UserUpdateRequestBody](docs/UserUpdateRequestBody.md)
+ - [Atrium::UsersResponseBody](docs/UsersResponseBody.md)
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/mxenabled/atrium-ruby.

data/Rakefile

@@ -1,5 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+begin
+  require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/atrium-ruby.gemspec

@@ -1,33 +1,41 @@
-# coding: utf-8
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "atrium/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "atrium-ruby"
-  spec.version       = ::Atrium::VERSION
-  spec.authors       = ["Jon Carstens, Dan Jones, Zach Toolson"]
-  spec.email         = ["jon.carstens@mx.com, dan.jones@mx.com, zach.toolson@mx.com"]
-  spec.summary       = "Ruby wrapper for the Atrium API by MX"
-  spec.description   = "Ruby wrapper for the Atrium API by MX"
-  spec.homepage      = "http://github.com/mxenabled/atrium-ruby"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "active_attr"
-  spec.add_runtime_dependency "httpclient"
-
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "mad_rubocop"
+# -*- encoding: utf-8 -*-
+
+=begin
+#MX API
+
+#The MX Atrium API supports over 48,000 data connections to thousands of financial institutions. It provides secure access to your users' accounts and transactions with industry-leading cleansing, categorization, and classification.  Atrium is designed according to resource-oriented REST architecture and responds with JSON bodies and HTTP response codes.  Use Atrium's development environment, vestibule.mx.com, to quickly get up and running. The development environment limits are 100 users, 25 members per user, and access to the top 15 institutions. Contact MX to purchase production access. 
+
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "atrium-ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "atrium-ruby"
+  s.version     = Atrium::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["MX"]
+  s.email       = ["atrium.api@mx.com"]
+  s.homepage    = "https://atrium.mx.com"
+  s.summary     = "Ruby wrapper for the Atrium API by MX"
+  s.description = "A ruby wrapper for the MX API."
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
 end

data/docs/Account.md

@@ -0,0 +1,35 @@
+# Atrium::Account
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**apr** | **Float** |  | [optional] 
+**apy** | **Float** |  | [optional] 
+**available_balance** | **Float** |  | [optional] 
+**available_credit** | **Float** |  | [optional] 
+**balance** | **Float** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**credit_limit** | **Float** |  | [optional] 
+**currency_code** | **String** |  | [optional] 
+**day_payment_is_due** | **Integer** |  | [optional] 
+**guid** | **String** |  | [optional] 
+**institution_code** | **String** |  | [optional] 
+**interest_rate** | **Float** |  | [optional] 
+**is_closed** | **BOOLEAN** |  | [optional] 
+**last_payment** | **Float** |  | [optional] 
+**matures_on** | **String** |  | [optional] 
+**member_guid** | **String** |  | [optional] 
+**minimum_balance** | **Float** |  | [optional] 
+**minimum_payment** | **Float** |  | [optional] 
+**name** | **String** |  | [optional] 
+**original_balance** | **Float** |  | [optional] 
+**payment_due_at** | **String** |  | [optional] 
+**payoff_balance** | **Float** |  | [optional] 
+**started_on** | **String** |  | [optional] 
+**subtype** | **String** |  | [optional] 
+**total_account_value** | **Float** |  | [optional] 
+**type** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+**user_guid** | **String** |  | [optional] 
+
+

data/docs/AccountNumber.md

@@ -0,0 +1,12 @@
+# Atrium::AccountNumber
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_guid** | **String** |  | [optional] 
+**account_number** | **String** |  | [optional] 
+**member_guid** | **String** |  | [optional] 
+**routing_number** | **String** |  | [optional] 
+**user_guid** | **String** |  | [optional] 
+
+

data/docs/AccountNumbersResponseBody.md

@@ -0,0 +1,8 @@
+# Atrium::AccountNumbersResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_numbers** | [**Array<AccountNumber>**](AccountNumber.md) |  | [optional] 
+
+

data/docs/AccountOwner.md

@@ -0,0 +1,18 @@
+# Atrium::AccountOwner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_guid** | **String** |  | [optional] 
+**address** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**guid** | **String** |  | [optional] 
+**member_guid** | **String** |  | [optional] 
+**owner_name** | **String** |  | [optional] 
+**postal_code** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**user_guid** | **String** |  | [optional] 
+
+

data/docs/AccountOwnersResponseBody.md

@@ -0,0 +1,8 @@
+# Atrium::AccountOwnersResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_owners** | [**Array<AccountOwner>**](AccountOwner.md) |  | [optional] 
+
+

data/docs/AccountResponseBody.md

@@ -0,0 +1,8 @@
+# Atrium::AccountResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | [**Account**](Account.md) |  | [optional] 
+
+

data/docs/AccountsApi.md

@@ -0,0 +1,174 @@
+# Atrium::AccountsApi
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_account_transactions**](AccountsApi.md#list_account_transactions) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List account transactions
+[**list_user_accounts**](AccountsApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts for a user
+[**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)
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+account_guid = "ACT-123" # String | The unique identifier for an `account`.
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+opts = { 
+  from_date: "2016-09-20", # String | Filter transactions from this date.
+  to_date: "2016-10-20" # String | Filter transactions to this date.
+  page: 1, # Integer | Specify current page.
+  records_per_page: 12, # Integer | Specify records per page.
+}
+
+begin
+  #List account transactions
+  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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_guid** | **String**| The unique identifier for an &#x60;account&#x60;. | 
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+ **from_date** | **String**| Filter transactions from this date. | [optional] 
+ **to_date** | **String**| Filter transactions to this date. | [optional] 
+ **page** | **Integer**| Specify current page. | [optional] 
+ **records_per_page** | **Integer**| Specify records per page. | [optional] 
+
+### Return type
+
+[**TransactionsResponseBody**](TransactionsResponseBody.md)
+
+# **list_user_accounts**
+> 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.
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+user_guid = "USR-123" # String | The unique identifier for a `user`.
+opts = { 
+  page: 1, # Integer | Specify current page.
+  records_per_page: 12, # Integer | Specify records per page.
+}
+
+begin
+  #List accounts for a user
+  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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+ **page** | **Integer**| Specify current page. | [optional] 
+ **records_per_page** | **Integer**| Specify records per page. | [optional] 
+
+### Return type
+
+[**AccountsResponseBody**](AccountsResponseBody.md)
+
+# **read_account**
+> 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. 
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+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)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling AccountsApi->read_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_guid** | **String**| The unique identifier for an &#x60;account&#x60;. | 
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+
+### Return type
+
+[**AccountResponseBody**](AccountResponseBody.md)
+
+# **read_account_by_member_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. 
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+account_guid = "ACT-123" # String | The unique identifier for an `account`.
+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)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling AccountsApi->read_account_by_member_guid: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_guid** | **String**| The unique identifier for an &#x60;account&#x60;. | 
+ **member_guid** | **String**| The unique identifier for a &#x60;member&#x60;. | 
+ **user_guid** | **String**| The unique identifier for a &#x60;user&#x60;. | 
+
+### Return type
+
+[**AccountResponseBody**](AccountResponseBody.md)
+