atrium-ruby 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e19654b875c78714ae78bf0df73870460cc7c88
-  data.tar.gz: d8c7462efeb6713af68fb4ba8ab8b97d1edd8ca0
+  metadata.gz: 5eee3cbbb158bb70e26633ece1cc4e3ad83228b6
+  data.tar.gz: f4a7a46b52217ad773d932050dd2c181c71878de
 SHA512:
-  metadata.gz: e9f33e6fcfcba2a42501364ca69d211ebad6bce0bddd8960d4143d4c7508247485d65b8b1529467663ebb23d1f9a1e5f64f59e2e1a6c5d2c6156be589de5c67f
-  data.tar.gz: ca54c818ebaccc7aa5ba0542e329a1d603f86fcccb08103bb3979f583dfa6219fd6c828a85e661448ddbf11342db0bad9cd1538381703ca4ed546ed706f8bcae
+  metadata.gz: cfb3b86c3bcde2086514bd1750b4685d35f27028fbf9bca8c5800785ed1df6cca54584f0856c635bbe286b29f71d41f6e3eed3da2cf3d4bc2713b5dc5147928c
+  data.tar.gz: be5cc89c16eca5352e03fddb2e5cfb4ffa3ab8ef797c9acaffb639ce4c6e693dfa0a0db01bb886373c0dcbbbbfc56ecba7908c9ec27fcb0d241e530b36276baf

data/README.md

@@ -17,12 +17,12 @@ gem build atrium-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./atrium-ruby-2.2.2.gem
+gem install ./atrium-ruby-2.3.0.gem
 ```
 
 Finally add this to the Gemfile:
 
-    gem 'atrium-ruby', '~> 2.2.2'
+    gem 'atrium-ruby', '~> 2.3.0'
 
 ### Install from Git
 
@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
 *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_statements**](docs/MembersApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
 *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
@@ -149,6 +150,8 @@ Class | Method | HTTP request | Description
  - [Atrium::Merchant](docs/Merchant.md)
  - [Atrium::MerchantResponseBody](docs/MerchantResponseBody.md)
  - [Atrium::Pagination](docs/Pagination.md)
+ - [Atrium::Statement](docs/Statement.md)
+ - [Atrium::StatementsResponseBody](docs/StatementsResponseBody.md)
  - [Atrium::Transaction](docs/Transaction.md)
  - [Atrium::TransactionCleanseAndCategorizeRequest](docs/TransactionCleanseAndCategorizeRequest.md)
  - [Atrium::TransactionCleanseAndCategorizeResponse](docs/TransactionCleanseAndCategorizeResponse.md)

data/docs/Institution.md

@@ -8,7 +8,9 @@ Name | Type | Description | Notes
 **name** | **String** |  | [optional] 
 **small_logo_url** | **String** |  | [optional] 
 **supports_account_identification** | **BOOLEAN** |  | [optional] 
+**supports_account_statement** | **BOOLEAN** |  | [optional] 
 **supports_account_verification** | **BOOLEAN** |  | [optional] 
+**supports_transaction_history** | **BOOLEAN** |  | [optional] 
 **url** | **String** |  | [optional] 
 
 

data/docs/InstitutionsApi.md

@@ -25,6 +25,10 @@ opts = {
   name: name_example, # String | This will list only institutions in which the appended string appears.
   page: 1, # Integer | Specify current page.
   records_per_page: 12, # Integer | Specify records per page.
+  supports_account_identification: true, # BOOLEAN | Filter only institutions which support account identification.
+  supports_account_statement: true, # BOOLEAN | Filter only institutions which support account statements.
+  supports_account_verification: true, # BOOLEAN | Filter only institutions which support account verification.
+  supports_transaction_history: true # BOOLEAN | Filter only institutions which support extended transaction history.
 }
 
 begin
@@ -43,6 +47,10 @@ Name | Type | Description  | Notes
  **name** | **String**| This will list only institutions in which the appended string appears. | [optional] 
  **page** | **Integer**| Specify current page. | [optional] 
  **records_per_page** | **Integer**| Specify records per page. | [optional] 
+ **supports_account_identification** | **BOOLEAN**| Filter only institutions which support account identification. | [optional] 
+ **supports_account_statement** | **BOOLEAN**| Filter only institutions which support account statements. | [optional] 
+ **supports_account_verification** | **BOOLEAN**| Filter only institutions which support account verification. | [optional] 
+ **supports_transaction_history** | **BOOLEAN**| Filter only institutions which support extended transaction history. | [optional] 
 
 ### Return type
 

data/docs/MembersApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**list_member_accounts**](MembersApi.md#list_member_accounts) | **GET** /users/{user_guid}/members/{member_guid}/accounts | List member accounts
 [**list_member_credentials**](MembersApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials
 [**list_member_mfa_challenges**](MembersApi.md#list_member_mfa_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member MFA challenges
+[**list_member_statements**](MembersApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
 [**list_member_transactions**](MembersApi.md#list_member_transactions) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List member transactions
 [**list_members**](MembersApi.md#list_members) | **GET** /users/{user_guid}/members | List members
 [**read_member**](MembersApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member
@@ -17,7 +18,7 @@ Method | HTTP request | Description
 
 
 # **aggregate_member**
-> MemberResponseBody aggregate_member(member_guid, user_guid)
+> MemberResponseBody aggregate_member(member_guid, user_guid, opts)
 
 Aggregate member
 
@@ -32,10 +33,13 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
 
 member_guid = "MBR-123" # String | The unique identifier for a `member`.
 user_guid = "USR-123" # String | The unique identifier for a `user`.
+opts = { 
+  type: "history" # String | An optional parameter which determines the type of aggregation to be peformed. Possible values are `statement` and `history`.
+}
 
 begin
   #Aggregate member
-  response = client.members.aggregate_member(member_guid, user_guid)
+  response = client.members.aggregate_member(member_guid, user_guid, opts)
   p response
 rescue Atrium::ApiError => e
   puts "Exception when calling MembersApi->aggregate_member: #{e}"
@@ -48,6 +52,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **member_guid** | **String**| The unique identifier for a `member`. | 
  **user_guid** | **String**| The unique identifier for a `user`. | 
+ **type** | **String**| An optional parameter which determines the type of aggregation to be peformed. Possible values are `statement` and `history`. | [optional] 
 
 ### Return type
 
@@ -243,6 +248,49 @@ Name | Type | Description  | Notes
 
 [**ChallengesResponseBody**](ChallengesResponseBody.md)
 
+# **list_member_statements**
+> StatementsResponseBody list_member_statements(member_guid, user_guid, opts)
+
+List member statements
+
+Certain institutions in Atrium allow developers to access account statements associated with a particular `member`. Use this endpoint to get an array of available statements.  Before this endpoint can be used, an aggregation of type `statement` should be performed on the relevant `member`. 
+
+### Example
+```ruby
+# load the gem
+require 'atrium-ruby'
+
+client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
+
+member_guid = "MBR-123" # String | The unique identifier for a `member`.
+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 member statements
+  response = client.members.list_member_statements(member_guid, user_guid, opts)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling MembersApi->list_member_statements: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **member_guid** | **String**| The unique identifier for a `member`. | 
+ **user_guid** | **String**| The unique identifier for a `user`. | 
+ **page** | **Integer**| Specify current page. | [optional] 
+ **records_per_page** | **Integer**| Specify records per page. | [optional] 
+
+### Return type
+
+[**StatementsResponseBody**](StatementsResponseBody.md)
+
 # **list_member_transactions**
 > TransactionsResponseBody list_member_transactions(member_guid, user_guid, opts)
 

data/docs/Statement.md

@@ -0,0 +1,16 @@
+# Atrium::Statement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_guid** | **String** | The unique identifier for the `account` associated with the `statement`. Defined by MX. | [optional] 
+**created_at** | **String** | The date and time the `statement` was created. | [optional] 
+**content_hash** | **String** | An SHA-256 hash value of the statement's byte payload, used as a unique identifier. | [optional] 
+**deleted_at** | **String** | The date and time the `statement` was deleted. Statements are automatically deleted when an `account` is deleted. | [optional] 
+**guid** | **String** | The unique identifier for the `statement`. Defined by MX. | [optional] 
+**is_deleted** | **BOOLEAN** | This indicates whether the `statement` has been deleted. Statements are automatically deleted when an `account` is deleted. | [optional] 
+**updated_at** | **String** | The date and time at which the `statement` was last updated. | [optional] 
+**uri** | **String** | A URI for accessing the byte payload of the `statement`. | [optional] 
+**user_guid** | **String** | The unique identifier for the `user` associated with the `statement`.  Defined by MX. | [optional] 
+
+

data/docs/StatementsResponseBody.md

@@ -0,0 +1,9 @@
+# Atrium::StatementsResponseBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statements** | [**Array<Statement>**](Statement.md) |  | [optional] 
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+

data/lib/atrium-ruby.rb

@@ -50,6 +50,8 @@ require 'atrium-ruby/models/members_response_body'
 require 'atrium-ruby/models/merchant'
 require 'atrium-ruby/models/merchant_response_body'
 require 'atrium-ruby/models/pagination'
+require 'atrium-ruby/models/statement'
+require 'atrium-ruby/models/statements_response_body'
 require 'atrium-ruby/models/transaction'
 require 'atrium-ruby/models/transaction_cleanse_and_categorize_request'
 require 'atrium-ruby/models/transaction_cleanse_and_categorize_response'

data/lib/atrium-ruby/api/institutions_api.rb

@@ -21,6 +21,10 @@ module Atrium
     # @option opts [String] :name This will list only institutions in which the appended string appears.
     # @option opts [Integer] :page Specify current page.
     # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [BOOLEAN] :supports_account_identification Filter only institutions which support account identification.
+    # @option opts [BOOLEAN] :supports_account_statement Filter only institutions which support account statements.
+    # @option opts [BOOLEAN] :supports_account_verification Filter only institutions which support account verification.
+    # @option opts [BOOLEAN] :supports_transaction_history Filter only institutions which support extended transaction history.
     # @return [InstitutionsResponseBody]
     def list_institutions(opts = {})
       data, _status_code, _headers = list_institutions_with_http_info(opts)
@@ -56,6 +60,10 @@ module Atrium
     # @option opts [String] :name This will list only institutions in which the appended string appears.
     # @option opts [Integer] :page Specify current page.
     # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [BOOLEAN] :supports_account_identification Filter only institutions which support account identification.
+    # @option opts [BOOLEAN] :supports_account_statement Filter only institutions which support account statements.
+    # @option opts [BOOLEAN] :supports_account_verification Filter only institutions which support account verification.
+    # @option opts [BOOLEAN] :supports_transaction_history Filter only institutions which support extended transaction history.
     # @return [Array<(InstitutionsResponseBody, Fixnum, Hash)>] InstitutionsResponseBody data, response status code and response headers
     def list_institutions_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -69,6 +77,10 @@ module Atrium
       query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
+      query_params[:'supports_account_identification'] = opts[:'supports_account_identification'] if !opts[:'supports_account_identification'].nil?
+      query_params[:'supports_account_statement'] = opts[:'supports_account_statement'] if !opts[:'supports_account_statement'].nil?
+      query_params[:'supports_account_verification'] = opts[:'supports_account_verification'] if !opts[:'supports_account_verification'].nil?
+      query_params[:'supports_transaction_history'] = opts[:'supports_transaction_history'] if !opts[:'supports_transaction_history'].nil?
 
       # header parameters
       header_params = {}

data/lib/atrium-ruby/api/members_api.rb

@@ -20,6 +20,7 @@ module Atrium
     # @param member_guid The unique identifier for a `member`.
     # @param user_guid The unique identifier for a `user`.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :type An optional parameter which determines the type of aggregation to be peformed. Possible values are `statement` and `history`.
     # @return [MemberResponseBody]
     def aggregate_member(member_guid, user_guid, opts = {})
       data, _status_code, _headers = aggregate_member_with_http_info(member_guid, user_guid, opts)
@@ -83,6 +84,19 @@ module Atrium
       data
     end
 
+    # List member statements
+    # Certain institutions in Atrium allow developers to access account statements associated with a particular `member`. Use this endpoint to get an array of available statements.  Before this endpoint can be used, an aggregation of type `statement` should be performed on the relevant `member`. 
+    # @param member_guid The unique identifier for a `member`.
+    # @param user_guid The unique identifier for a `user`.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
+    # @return [StatementsResponseBody]
+    def list_member_statements(member_guid, user_guid, opts = {})
+      data, _status_code, _headers = list_member_statements_with_http_info(member_guid, user_guid, opts)
+      data
+    end
+
     # List member transactions
     # Use this endpoint to get all transactions from all accounts associated with a specific member.<br> This endpoint accepts optional URL query parameters — from_date and to_date — which are used to filter transactions according to the date they were posted. If no values are given for the query parameters, from_date will default to 90 days prior to the request and to_date will default to 5 days from the time of the request. 
     # @param member_guid The unique identifier for a &#x60;member&#x60;.
@@ -164,6 +178,7 @@ module Atrium
     # @param member_guid The unique identifier for a &#x60;member&#x60;.
     # @param user_guid The unique identifier for a &#x60;user&#x60;.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :type An optional parameter which determines the type of aggregation to be peformed. Possible values are &#x60;statement&#x60; and &#x60;history&#x60;.
     # @return [Array<(MemberResponseBody, Fixnum, Hash)>] MemberResponseBody data, response status code and response headers
     def aggregate_member_with_http_info(member_guid, user_guid, opts = {})
       if @api_client.config.debugging
@@ -182,11 +197,14 @@ module Atrium
 
       # query parameters
       query_params = {}
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
 
       # header parameters
       header_params = {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
 
       # form parameters
       form_params = {}
@@ -446,6 +464,57 @@ module Atrium
       end
       return data, status_code, headers
     end
+    # List member statements
+    # Certain institutions in Atrium allow developers to access account statements associated with a particular &#x60;member&#x60;. Use this endpoint to get an array of available statements.  Before this endpoint can be used, an aggregation of type &#x60;statement&#x60; should be performed on the relevant &#x60;member&#x60;. 
+    # @param member_guid The unique identifier for a &#x60;member&#x60;.
+    # @param user_guid The unique identifier for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
+    # @return [Array<(StatementsResponseBody, Fixnum, Hash)>] StatementsResponseBody data, response status code and response headers
+    def list_member_statements_with_http_info(member_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MembersApi.list_member_statements ...'
+      end
+      # verify the required parameter 'member_guid' is set
+      if @api_client.config.client_side_validation && member_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'member_guid' when calling MembersApi.list_member_statements"
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MembersApi.list_member_statements"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/members/{member_guid}/statements'.sub('{' + 'member_guid' + '}', member_guid.to_s).sub('{' + 'user_guid' + '}', user_guid.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.atrium.v1+json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['apiKey', 'clientID']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'StatementsResponseBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MembersApi#list_member_statements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # List member transactions
     # Use this endpoint to get all transactions from all accounts associated with a specific member.&lt;br&gt; This endpoint accepts optional URL query parameters — from_date and to_date — which are used to filter transactions according to the date they were posted. If no values are given for the query parameters, from_date will default to 90 days prior to the request and to_date will default to 5 days from the time of the request. 
     # @param member_guid The unique identifier for a &#x60;member&#x60;.

data/lib/atrium-ruby/models/institution.rb

@@ -20,8 +20,12 @@ module Atrium
 
     attr_accessor :supports_account_identification
 
+    attr_accessor :supports_account_statement
+
     attr_accessor :supports_account_verification
 
+    attr_accessor :supports_transaction_history
+
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -32,7 +36,9 @@ module Atrium
         :'name' => :'name',
         :'small_logo_url' => :'small_logo_url',
         :'supports_account_identification' => :'supports_account_identification',
+        :'supports_account_statement' => :'supports_account_statement',
         :'supports_account_verification' => :'supports_account_verification',
+        :'supports_transaction_history' => :'supports_transaction_history',
         :'url' => :'url'
       }
     end
@@ -45,7 +51,9 @@ module Atrium
         :'name' => :'String',
         :'small_logo_url' => :'String',
         :'supports_account_identification' => :'BOOLEAN',
+        :'supports_account_statement' => :'BOOLEAN',
         :'supports_account_verification' => :'BOOLEAN',
+        :'supports_transaction_history' => :'BOOLEAN',
         :'url' => :'String'
       }
     end
@@ -78,10 +86,18 @@ module Atrium
         self.supports_account_identification = attributes[:'supports_account_identification']
       end
 
+      if attributes.has_key?(:'supports_account_statement')
+        self.supports_account_statement = attributes[:'supports_account_statement']
+      end
+
       if attributes.has_key?(:'supports_account_verification')
         self.supports_account_verification = attributes[:'supports_account_verification']
       end
 
+      if attributes.has_key?(:'supports_transaction_history')
+        self.supports_transaction_history = attributes[:'supports_transaction_history']
+      end
+
       if attributes.has_key?(:'url')
         self.url = attributes[:'url']
       end
@@ -110,7 +126,9 @@ module Atrium
           name == o.name &&
           small_logo_url == o.small_logo_url &&
           supports_account_identification == o.supports_account_identification &&
+          supports_account_statement == o.supports_account_statement &&
           supports_account_verification == o.supports_account_verification &&
+          supports_transaction_history == o.supports_transaction_history &&
           url == o.url
     end
 
@@ -123,7 +141,7 @@ module Atrium
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [code, medium_logo_url, name, small_logo_url, supports_account_identification, supports_account_verification, url].hash
+      [code, medium_logo_url, name, small_logo_url, supports_account_identification, supports_account_statement, supports_account_verification, supports_transaction_history, url].hash
     end
 
     # Builds the object from hash

data/lib/atrium-ruby/models/statement.rb

@@ -0,0 +1,260 @@
+=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
+
+require 'date'
+
+module Atrium
+  class Statement
+    # The unique identifier for the `account` associated with the `statement`. Defined by MX.
+    attr_accessor :account_guid
+
+    # The date and time the `statement` was created.
+    attr_accessor :created_at
+
+    # An SHA-256 hash value of the statement's byte payload, used as a unique identifier.
+    attr_accessor :content_hash
+
+    # The date and time the `statement` was deleted. Statements are automatically deleted when an `account` is deleted.
+    attr_accessor :deleted_at
+
+    # The unique identifier for the `statement`. Defined by MX.
+    attr_accessor :guid
+
+    # This indicates whether the `statement` has been deleted. Statements are automatically deleted when an `account` is deleted.
+    attr_accessor :is_deleted
+
+    # The date and time at which the `statement` was last updated.
+    attr_accessor :updated_at
+
+    # A URI for accessing the byte payload of the `statement`.
+    attr_accessor :uri
+
+    # The unique identifier for the `user` associated with the `statement`.  Defined by MX.
+    attr_accessor :user_guid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_guid' => :'account_guid',
+        :'created_at' => :'created_at',
+        :'content_hash' => :'content_hash',
+        :'deleted_at' => :'deleted_at',
+        :'guid' => :'guid',
+        :'is_deleted' => :'is_deleted',
+        :'updated_at' => :'updated_at',
+        :'uri' => :'uri',
+        :'user_guid' => :'user_guid'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.mx_types
+      {
+        :'account_guid' => :'String',
+        :'created_at' => :'String',
+        :'content_hash' => :'String',
+        :'deleted_at' => :'String',
+        :'guid' => :'String',
+        :'is_deleted' => :'BOOLEAN',
+        :'updated_at' => :'String',
+        :'uri' => :'String',
+        :'user_guid' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'account_guid')
+        self.account_guid = attributes[:'account_guid']
+      end
+
+      if attributes.has_key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.has_key?(:'content_hash')
+        self.content_hash = attributes[:'content_hash']
+      end
+
+      if attributes.has_key?(:'deleted_at')
+        self.deleted_at = attributes[:'deleted_at']
+      end
+
+      if attributes.has_key?(:'guid')
+        self.guid = attributes[:'guid']
+      end
+
+      if attributes.has_key?(:'is_deleted')
+        self.is_deleted = attributes[:'is_deleted']
+      end
+
+      if attributes.has_key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.has_key?(:'uri')
+        self.uri = attributes[:'uri']
+      end
+
+      if attributes.has_key?(:'user_guid')
+        self.user_guid = attributes[:'user_guid']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          account_guid == o.account_guid &&
+          created_at == o.created_at &&
+          content_hash == o.content_hash &&
+          deleted_at == o.deleted_at &&
+          guid == o.guid &&
+          is_deleted == o.is_deleted &&
+          updated_at == o.updated_at &&
+          uri == o.uri &&
+          user_guid == o.user_guid
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [account_guid, created_at, content_hash, deleted_at, guid, is_deleted, updated_at, uri, user_guid].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.mx_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Atrium.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/atrium-ruby/models/statements_response_body.rb

@@ -0,0 +1,190 @@
+=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
+
+require 'date'
+
+module Atrium
+  class StatementsResponseBody
+    attr_accessor :statements
+
+    attr_accessor :pagination
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'statements' => :'statements',
+        :'pagination' => :'pagination'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.mx_types
+      {
+        :'statements' => :'Array<Statement>',
+        :'pagination' => :'Pagination'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'statements')
+        if (value = attributes[:'statements']).is_a?(Array)
+          self.statements = value
+        end
+      end
+
+      if attributes.has_key?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          statements == o.statements &&
+          pagination == o.pagination
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [statements, pagination].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.mx_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = Atrium.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/atrium-ruby/version.rb

@@ -7,5 +7,5 @@
 =end
 
 module Atrium
-  VERSION = '2.2.2'
+  VERSION = '2.3.0'
 end

data/spec/api/institutions_api_spec.rb

@@ -34,6 +34,10 @@ describe 'InstitutionsApi' do
   # @option opts [String] :name This will list only institutions in which the appended string appears.
   # @option opts [Integer] :page Specify current page.
   # @option opts [Integer] :records_per_page Specify records per page.
+  # @option opts [BOOLEAN] :supports_account_identification Filter only institutions which support account identification.
+  # @option opts [BOOLEAN] :supports_account_statement Filter only institutions which support account statements.
+  # @option opts [BOOLEAN] :supports_account_verification Filter only institutions which support account verification.
+  # @option opts [BOOLEAN] :supports_transaction_history Filter only institutions which support extended transaction history.
   # @return [InstitutionsResponseBody]
   describe 'list_institutions test' do
     it 'should work' do

data/spec/api/members_api_spec.rb

@@ -33,6 +33,7 @@ describe 'MembersApi' do
   # @param member_guid The unique identifier for a `member`.
   # @param user_guid The unique identifier for a `user`.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :type An optional parameter which determines the type of aggregation to be peformed. Possible values are `statement` and `history`.
   # @return [MemberResponseBody]
   describe 'aggregate_member test' do
     it 'should work' do
@@ -107,6 +108,21 @@ describe 'MembersApi' do
     end
   end
 
+  # unit tests for list_member_statements
+  # List member statements
+  # Certain institutions in Atrium allow developers to access account statements associated with a particular `member`. Use this endpoint to get an array of available statements.  Before this endpoint can be used, an aggregation of type `statement` should be performed on the relevant `member`. 
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [StatementsResponseBody]
+  describe 'list_member_statements test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for list_member_transactions
   # List member transactions
   # Use this endpoint to get all transactions from all accounts associated with a specific member.<br> This endpoint accepts optional URL query parameters — from_date and to_date — which are used to filter transactions according to the date they were posted. If no values are given for the query parameters, from_date will default to 90 days prior to the request and to_date will default to 5 days from the time of the request. 

data/spec/models/institution_spec.rb

@@ -57,12 +57,24 @@ describe 'Institution' do
     end
   end
 
+  describe 'test attribute "supports_account_statement"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "supports_account_verification"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  describe 'test attribute "supports_transaction_history"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "url"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/statement_spec.rb

@@ -0,0 +1,84 @@
+=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
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Atrium::Statement
+# Please update as you see appropriate
+describe 'Statement' do
+  before do
+    # run before each test
+    @instance = Atrium::Statement.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Statement' do
+    it 'should create an instance of Statement' do
+      expect(@instance).to be_instance_of(Atrium::Statement)
+    end
+  end
+  describe 'test attribute "account_guid"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "content_hash"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "deleted_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "guid"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "is_deleted"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "updated_at"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "uri"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "user_guid"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/statements_response_body_spec.rb

@@ -0,0 +1,42 @@
+=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
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Atrium::StatementsResponseBody
+# Please update as you see appropriate
+describe 'StatementsResponseBody' do
+  before do
+    # run before each test
+    @instance = Atrium::StatementsResponseBody.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of StatementsResponseBody' do
+    it 'should create an instance of StatementsResponseBody' do
+      expect(@instance).to be_instance_of(Atrium::StatementsResponseBody)
+    end
+  end
+  describe 'test attribute "statements"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "pagination"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atrium-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - MX
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-25 00:00:00.000000000 Z
+date: 2019-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -245,6 +245,8 @@ files:
 - docs/MerchantResponseBody.md
 - docs/MerchantsApi.md
 - docs/Pagination.md
+- docs/Statement.md
+- docs/StatementsResponseBody.md
 - docs/Transaction.md
 - docs/TransactionCleanseAndCategorizeRequest.md
 - docs/TransactionCleanseAndCategorizeResponse.md
@@ -313,6 +315,8 @@ files:
 - lib/atrium-ruby/models/merchant.rb
 - lib/atrium-ruby/models/merchant_response_body.rb
 - lib/atrium-ruby/models/pagination.rb
+- lib/atrium-ruby/models/statement.rb
+- lib/atrium-ruby/models/statements_response_body.rb
 - lib/atrium-ruby/models/transaction.rb
 - lib/atrium-ruby/models/transaction_cleanse_and_categorize_request.rb
 - lib/atrium-ruby/models/transaction_cleanse_and_categorize_response.rb
@@ -375,6 +379,8 @@ files:
 - spec/models/merchant_response_body_spec.rb
 - spec/models/merchant_spec.rb
 - spec/models/pagination_spec.rb
+- spec/models/statement_spec.rb
+- spec/models/statements_response_body_spec.rb
 - spec/models/transaction_cleanse_and_categorize_request_spec.rb
 - spec/models/transaction_cleanse_and_categorize_response_spec.rb
 - spec/models/transaction_response_body_spec.rb
@@ -437,6 +443,7 @@ test_files:
 - spec/models/connect_widget_request_body_spec.rb
 - spec/models/institution_spec.rb
 - spec/models/credential_option_spec.rb
+- spec/models/statements_response_body_spec.rb
 - spec/models/account_number_spec.rb
 - spec/models/members_response_body_spec.rb
 - spec/models/transactions_response_body_spec.rb
@@ -473,5 +480,6 @@ test_files:
 - spec/models/account_response_body_spec.rb
 - spec/models/user_spec.rb
 - spec/models/transactions_cleanse_and_categorize_request_body_spec.rb
+- spec/models/statement_spec.rb
 - spec/models/member_spec.rb
 - spec/spec_helper.rb