atrium-ruby 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eee3cbbb158bb70e26633ece1cc4e3ad83228b6
-  data.tar.gz: f4a7a46b52217ad773d932050dd2c181c71878de
+  metadata.gz: 992d348d5ccb8a9a27f5d289e11cbdc0a99cb621
+  data.tar.gz: 75d5eb9ca4e3b4f8b1077080530a2f24dd9660e8
 SHA512:
-  metadata.gz: cfb3b86c3bcde2086514bd1750b4685d35f27028fbf9bca8c5800785ed1df6cca54584f0856c635bbe286b29f71d41f6e3eed3da2cf3d4bc2713b5dc5147928c
-  data.tar.gz: be5cc89c16eca5352e03fddb2e5cfb4ffa3ab8ef797c9acaffb639ce4c6e693dfa0a0db01bb886373c0dcbbbbfc56ecba7908c9ec27fcb0d241e530b36276baf
+  metadata.gz: 4430540f0ca08ab95a85f93f1e58a8ec03150fd420e1d7f9dde0c26cd27c3c4e31ea5be0b58f14ae89fd0cc65c5e6643161b29d869a1764151a26ac0336d5e3e
+  data.tar.gz: 6d4bf8a5a11e6dcb7ff618c59e1844da32f33f4c2a98c9404e35087e0c39204deb45e299e051f1b48ef14fafeb6b181fb14d4a62aa76bb017c71f9db963f6fff

data/README.md

@@ -17,12 +17,12 @@ gem build atrium-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./atrium-ruby-2.3.0.gem
+gem install ./atrium-ruby-2.4.0.gem
 ```
 
 Finally add this to the Gemfile:
 
-    gem 'atrium-ruby', '~> 2.3.0'
+    gem 'atrium-ruby', '~> 2.4.0'
 
 ### Install from Git
 
@@ -53,7 +53,7 @@ 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.
+  records_per_page: 12 # Integer | Specify records per page.
 }
 
 begin
@@ -87,10 +87,10 @@ Class | Method | HTTP request | Description
 *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* | [**extend_history**](docs/MembersApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
 *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
@@ -98,6 +98,8 @@ Class | Method | HTTP request | Description
 *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::MerchantsApi* | [**read_merchant**](docs/MerchantsApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant
+*Atrium::StatementsApi* | [**fetch_statements**](docs/StatementsApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
+*Atrium::StatementsApi* | [**list_member_statements**](docs/StatementsApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
 *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

data/docs/AccountsApi.md

@@ -28,7 +28,7 @@ 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.
+  records_per_page: 12 # Integer | Specify records per page.
 }
 
 begin
@@ -72,7 +72,7 @@ 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.
+  records_per_page: 12 # Integer | Specify records per page.
 }
 
 begin

data/docs/InstitutionsApi.md

@@ -24,7 +24,7 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
 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.
+  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.

data/docs/MembersApi.md

@@ -5,10 +5,10 @@ Method | HTTP request | Description
 [**aggregate_member**](MembersApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
 [**create_member**](MembersApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
 [**delete_member**](MembersApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
+[**extend_history**](MembersApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
 [**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
@@ -18,7 +18,7 @@ Method | HTTP request | Description
 
 
 # **aggregate_member**
-> MemberResponseBody aggregate_member(member_guid, user_guid, opts)
+> MemberResponseBody aggregate_member(member_guid, user_guid)
 
 Aggregate member
 
@@ -33,13 +33,10 @@ 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, opts)
+  response = client.members.aggregate_member(member_guid, user_guid)
   p response
 rescue Atrium::ApiError => e
   puts "Exception when calling MembersApi->aggregate_member: #{e}"
@@ -52,7 +49,6 @@ 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
 
@@ -131,12 +127,12 @@ Name | Type | Description  | Notes
 
 nil (empty response body)
 
-# **list_member_accounts**
-> AccountsResponseBody list_member_accounts(member_guid, user_guid, opts)
+# **extend_history**
+> MemberResponseBody extend_history(member_guid, user_guid)
 
-List member accounts
+Extend history
 
-This endpoint returns an array with information about every account associated with a particular member.
+The extend_history endpoint begins the process of fetching up to 24 months of data associated with a particular `member`.
 
 ### Example
 ```ruby
@@ -147,17 +143,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 = { 
-  page: 1, # Integer | Specify current page.
-  records_per_page: 12, # Integer | Specify records per page.
-}
 
 begin
-  #List member accounts
-  response = client.members.list_member_accounts(member_guid, user_guid, opts)
+  #Extend history
+  response = client.members.extend_history(member_guid, user_guid)
   p response
 rescue Atrium::ApiError => e
-  puts "Exception when calling MembersApi->list_member_accounts: #{e}"
+  puts "Exception when calling MembersApi->extend_history: #{e}"
 end
 ```
 
@@ -167,19 +159,17 @@ 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
 
-[**AccountsResponseBody**](AccountsResponseBody.md)
+[**MemberResponseBody**](MemberResponseBody.md)
 
-# **list_member_credentials**
-> CredentialsResponseBody list_member_credentials(member_guid, user_guid)
+# **list_member_accounts**
+> AccountsResponseBody list_member_accounts(member_guid, user_guid, opts)
 
-List member credentials
+List member accounts
 
-This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
+This endpoint returns an array with information about every account associated with a particular member.
 
 ### Example
 ```ruby
@@ -190,13 +180,17 @@ 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 credentials
-  response = client.members.list_member_credentials(member_guid, user_guid)
+  #List member accounts
+  response = client.members.list_member_accounts(member_guid, user_guid, opts)
   p response
 rescue Atrium::ApiError => e
-  puts "Exception when calling MembersApi->list_member_credentials: #{e}"
+  puts "Exception when calling MembersApi->list_member_accounts: #{e}"
 end
 ```
 
@@ -206,17 +200,19 @@ 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
 
-[**CredentialsResponseBody**](CredentialsResponseBody.md)
+[**AccountsResponseBody**](AccountsResponseBody.md)
 
-# **list_member_mfa_challenges**
-> ChallengesResponseBody list_member_mfa_challenges(member_guid, user_guid)
+# **list_member_credentials**
+> CredentialsResponseBody list_member_credentials(member_guid, user_guid)
 
-List member MFA challenges
+List member credentials
 
-Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.<br> If the aggregation is not challenged, i.e., the member does not have a connection status of CHALLENGED, then code 204 No Content will be returned.<br> If the aggregation has been challenged, i.e., the member does have a connection status of CHALLENGED, then code 200 OK will be returned — along with the corresponding credentials. 
+This endpoint returns an array which contains information on every non-MFA credential associated with a specific member.
 
 ### Example
 ```ruby
@@ -229,11 +225,11 @@ member_guid = "MBR-123" # String | The unique identifier for a `member`.
 user_guid = "USR-123" # String | The unique identifier for a `user`.
 
 begin
-  #List member MFA challenges
-  response = client.members.list_member_mfa_challenges(member_guid, user_guid)
+  #List member credentials
+  response = client.members.list_member_credentials(member_guid, user_guid)
   p response
 rescue Atrium::ApiError => e
-  puts "Exception when calling MembersApi->list_member_mfa_challenges: #{e}"
+  puts "Exception when calling MembersApi->list_member_credentials: #{e}"
 end
 ```
 
@@ -246,14 +242,14 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**ChallengesResponseBody**](ChallengesResponseBody.md)
+[**CredentialsResponseBody**](CredentialsResponseBody.md)
 
-# **list_member_statements**
-> StatementsResponseBody list_member_statements(member_guid, user_guid, opts)
+# **list_member_mfa_challenges**
+> ChallengesResponseBody list_member_mfa_challenges(member_guid, user_guid)
 
-List member statements
+List member MFA challenges
 
-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`. 
+Use this endpoint for information on what multi-factor authentication challenges need to be answered in order to aggregate a member.<br> If the aggregation is not challenged, i.e., the member does not have a connection status of CHALLENGED, then code 204 No Content will be returned.<br> If the aggregation has been challenged, i.e., the member does have a connection status of CHALLENGED, then code 200 OK will be returned — along with the corresponding credentials. 
 
 ### Example
 ```ruby
@@ -264,17 +260,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 = { 
-  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)
+  #List member MFA challenges
+  response = client.members.list_member_mfa_challenges(member_guid, user_guid)
   p response
 rescue Atrium::ApiError => e
-  puts "Exception when calling MembersApi->list_member_statements: #{e}"
+  puts "Exception when calling MembersApi->list_member_mfa_challenges: #{e}"
 end
 ```
 
@@ -284,12 +276,10 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **member_guid** | **String**| The unique identifier for a &#x60;member&#x60;. | 
  **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
 
-[**StatementsResponseBody**](StatementsResponseBody.md)
+[**ChallengesResponseBody**](ChallengesResponseBody.md)
 
 # **list_member_transactions**
 > TransactionsResponseBody list_member_transactions(member_guid, user_guid, opts)
@@ -311,7 +301,7 @@ 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.
+  records_per_page: 12 # Integer | Specify records per page.
 }
 
 begin
@@ -355,7 +345,7 @@ 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.
+  records_per_page: 12 # Integer | Specify records per page.
 }
 
 begin

data/docs/Statement.md

@@ -5,12 +5,10 @@ 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] 
+**member_guid** | **String** | The unique identifier for the `member` associated with the `statement`.  Defined by MX. | [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] 
+**updated_at** | **String** | The date and time at which the `statement` was last updated. | [optional] 
 
 

data/docs/StatementsApi.md

@@ -0,0 +1,88 @@
+# Atrium::StatementsApi
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fetch_statements**](StatementsApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
+[**list_member_statements**](StatementsApi.md#list_member_statements) | **GET** /users/{user_guid}/members/{member_guid}/statements | List member statements
+
+
+# **fetch_statements**
+> MemberResponseBody fetch_statements(member_guid, user_guid)
+
+Fetch statements
+
+The fetch statements endpoint begins fetching statements for a 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`.
+
+begin
+  #Fetch statements
+  response = client.statements.fetch_statements(member_guid, user_guid)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling StatementsApi->fetch_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`. | 
+
+### Return type
+
+[**MemberResponseBody**](MemberResponseBody.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, `fetch_statements` 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.statements.list_member_statements(member_guid, user_guid, opts)
+  p response
+rescue Atrium::ApiError => e
+  puts "Exception when calling StatementsApi->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)
+

data/docs/TransactionsApi.md

@@ -60,7 +60,7 @@ user_guid = "USR-123" # String | The unique identifier for a `user`.
 opts = { 
   page: 1, # Integer | Specify current page.
   from_date: "2016-09-20", # String | Filter transactions from this date.
-  records_per_page: 12, # Integer | Specify records per page.
+  records_per_page: 12 # Integer | Specify records per page.
   to_date: "2016-10-20" # String | Filter transactions to this date.
 }
 

data/docs/UsersApi.md

@@ -94,7 +94,7 @@ client = Atrium::AtriumClient.new("YOUR_API_KEY", "YOUR_CLIENT_ID")
 
 opts = { 
   page: 1, # Integer | Specify current page.
-  records_per_page: 12, # Integer | Specify records per page.
+  records_per_page: 12 # Integer | Specify records per page.
 }
 
 begin

data/lib/atrium-ruby.rb

@@ -73,6 +73,7 @@ require 'atrium-ruby/api/identity_api'
 require 'atrium-ruby/api/institutions_api'
 require 'atrium-ruby/api/members_api'
 require 'atrium-ruby/api/merchants_api'
+require 'atrium-ruby/api/statements_api'
 require 'atrium-ruby/api/transactions_api'
 require 'atrium-ruby/api/users_api'
 require 'atrium-ruby/api/verification_api'