atrium-ruby 1.3.2 → 2.0.0

data/lib/atrium-ruby/version.rb

@@ -0,0 +1,11 @@
+=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
+
+module Atrium
+  VERSION = '2.0.0'
+end

data/spec/api/accounts_api_spec.rb

@@ -0,0 +1,88 @@
+=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'
+
+# Unit tests for Atrium::AccountsApi
+# Please update as you see appropriate
+describe 'AccountsApi' do
+  before do
+    # run before each test
+    @instance = Atrium::AccountsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountsApi' do
+    it 'should create an instance of AccountsApi' do
+      expect(@instance).to be_instance_of(Atrium::AccountsApi)
+    end
+  end
+
+  # unit tests for list_account_transactions
+  # 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. 
+  # @param account_guid The unique identifier for an `account`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from_date Filter transactions from this date.
+  # @option opts [String] :to_date Filter transactions to this date.
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [TransactionsResponseBody]
+  describe 'list_account_transactions 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_user_accounts
+  # 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.
+  # @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 [AccountsResponseBody]
+  describe 'list_user_accounts 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 read_account
+  # 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. 
+  # @param account_guid The unique identifier for an `account`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountResponseBody]
+  describe 'read_account 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 read_account_by_member_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. 
+  # @param account_guid The unique identifier for an `account`.
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountResponseBody]
+  describe 'read_account_by_member_guid test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/connect_widget_api_spec.rb

@@ -0,0 +1,43 @@
+=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'
+
+# Unit tests for Atrium::ConnectWidgetApi
+# Please update as you see appropriate
+describe 'ConnectWidgetApi' do
+  before do
+    # run before each test
+    @instance = Atrium::ConnectWidgetApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ConnectWidgetApi' do
+    it 'should create an instance of ConnectWidgetApi' do
+      expect(@instance).to be_instance_of(Atrium::ConnectWidgetApi)
+    end
+  end
+
+  # unit tests for get_connect_widget
+  # Embedding in a website
+  # This endpoint will return a URL for an embeddable version of MX Connect.
+  # @param user_guid The unique identifier for a `user`.
+  # @param body Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
+  # @param [Hash] opts the optional parameters
+  # @return [ConnectWidgetResponseBody]
+  describe 'get_connect_widget test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/identity_api_spec.rb

@@ -0,0 +1,56 @@
+=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'
+
+# Unit tests for Atrium::IdentityApi
+# Please update as you see appropriate
+describe 'IdentityApi' do
+  before do
+    # run before each test
+    @instance = Atrium::IdentityApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IdentityApi' do
+    it 'should create an instance of IdentityApi' do
+      expect(@instance).to be_instance_of(Atrium::IdentityApi)
+    end
+  end
+
+  # unit tests for identify_member
+  # Identify
+  # The identify endpoint begins an identification process for an already-existing 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
+  # @return [MemberResponseBody]
+  describe 'identify_member 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_account_owners
+  # List member account owners
+  # This endpoint returns an array with information about every account associated with a particular 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
+  # @return [AccountOwnersResponseBody]
+  describe 'list_account_owners test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/institutions_api_spec.rb

@@ -0,0 +1,68 @@
+=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'
+
+# Unit tests for Atrium::InstitutionsApi
+# Please update as you see appropriate
+describe 'InstitutionsApi' do
+  before do
+    # run before each test
+    @instance = Atrium::InstitutionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InstitutionsApi' do
+    it 'should create an instance of InstitutionsApi' do
+      expect(@instance).to be_instance_of(Atrium::InstitutionsApi)
+    end
+  end
+
+  # unit tests for list_institutions
+  # List institutions
+  # This endpoint allows you to see what institutions are available for connection. Information returned will include the institution_code assigned to a particular institution, URLs for the financial institution's logo, and the URL for its website.<br> This endpoint takes an optional query string, name={string}. This will list only institutions in which the appended string appears. 
+  # @param [Hash] opts the optional parameters
+  # @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.
+  # @return [InstitutionsResponseBody]
+  describe 'list_institutions 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 read_institution
+  # Read institution
+  # This endpoint allows you to see information for a specific institution.
+  # @param institution_code The institution_code of the institution.
+  # @param [Hash] opts the optional parameters
+  # @return [InstitutionResponseBody]
+  describe 'read_institution 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 read_institution_credentials
+  # Read institution credentials
+  # Use this endpoint to see which credentials will be needed to create a member for a specific institution.
+  # @param institution_code The institution_code of the institution.
+  # @param [Hash] opts the optional parameters
+  # @return [CredentialsResponseBody]
+  describe 'read_institution_credentials test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/members_api_spec.rb

@@ -0,0 +1,195 @@
+=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'
+
+# Unit tests for Atrium::MembersApi
+# Please update as you see appropriate
+describe 'MembersApi' do
+  before do
+    # run before each test
+    @instance = Atrium::MembersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MembersApi' do
+    it 'should create an instance of MembersApi' do
+      expect(@instance).to be_instance_of(Atrium::MembersApi)
+    end
+  end
+
+  # unit tests for aggregate_member
+  # Aggregate member
+  # Calling this endpoint initiates an aggregation event for the member. This brings in the latest account and transaction data from the connected institution. If this data has recently been updated, MX may not initiate an aggregation event. 
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [MemberResponseBody]
+  describe 'aggregate_member 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 create_member
+  # Create member
+  # This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters identifier and metadata.<br> When creating a member, you'll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the /institutions/{institution_code}/credentials endpoint.<br> If successful, Atrium will respond with the newly-created member object.<br> Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions. 
+  # @param user_guid The unique identifier for a `user`.
+  # @param body Member object to be created with optional parameters (identifier and metadata) and required parameters (credentials and institution_code)
+  # @param [Hash] opts the optional parameters
+  # @return [MemberResponseBody]
+  describe 'create_member 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 delete_member
+  # Delete member
+  # Accessing this endpoint will permanently delete a 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
+  # @return [nil]
+  describe 'delete_member 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_accounts
+  # List member accounts
+  # This endpoint returns an array with information about every account associated with a particular 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 [AccountsResponseBody]
+  describe 'list_member_accounts 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_credentials
+  # List member credentials
+  # This endpoint returns an array which contains information on every non-MFA credential associated with a specific 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
+  # @return [CredentialsResponseBody]
+  describe 'list_member_credentials 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_mfa_challenges
+  # List member MFA challenges
+  # 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. 
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [ChallengesResponseBody]
+  describe 'list_member_mfa_challenges 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. 
+  # @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] :from_date Filter transactions from this date.
+  # @option opts [String] :to_date Filter transactions to this date.
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [TransactionsResponseBody]
+  describe 'list_member_transactions 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_members
+  # List members
+  # This endpoint returns an array which contains information on every member associated with a specific user.
+  # @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 [MembersResponseBody]
+  describe 'list_members 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 read_member
+  # Read member
+  # Use this endpoint to read the attributes of a specific 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
+  # @return [MemberResponseBody]
+  describe 'read_member 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 read_member_status
+  # Read member connection status
+  # This endpoint provides the status of the member's most recent aggregation event. This is an important step in the aggregation process, and the results returned by this endpoint should determine what you do next in order to successfully aggregate a member.<br> MX has introduced new, more detailed information on the current status of a member's connection to a financial institution and the state of its aggregation: the connection_status field. These are intended to replace and expand upon the information provided in the status field, which will soon be deprecated; support for the status field remains for the time being. 
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [MemberConnectionStatusResponseBody]
+  describe 'read_member_status 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 resume_member
+  # Resume aggregation from MFA
+  # This endpoint answers the challenges needed when a member has been challenged by multi-factor authentication.
+  # @param member_guid The unique identifier for a `member`.
+  # @param user_guid The unique identifier for a `user`.
+  # @param body Member object with MFA challenge answers
+  # @param [Hash] opts the optional parameters
+  # @return [MemberResponseBody]
+  describe 'resume_member 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 update_member
+  # Update member
+  # Use this endpoint to update a member's attributes. Only the credentials, identifier, and metadata parameters can be updated. To get a list of the required credentials for the member, use the list member credentials endpoint. 
+  # @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 [MemberUpdateRequestBody] :body Member object to be updated with optional parameters (credentials, identifier, metadata)
+  # @return [MemberResponseBody]
+  describe 'update_member test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end