mx-platform-ruby 1.10.0 → 1.10.1

data/spec/api/microdeposits_api_spec.rb

@@ -1,9 +1,9 @@
 =begin
 #MX Platform API
 
-#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.  Just getting started? See our [use case guides](/use-cases/). 
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 20111101
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.8.0
@@ -32,65 +32,77 @@ describe 'MicrodepositsApi' do
     end
   end
 
-  # unit tests for micro_deposits_microdeposit_guid_verify_put
-  # Verify a Microdeposit
-  # Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the `status` is `VERIFIED`. Poll the `/users/{user_guid}/micro_deposits/{micro_deposit_guid}` (read microdeposit) endpoint until you see this status or an error state.
-  # @param microdeposit_guid The unique identifier for the microdeposit. Defined by MX.
+  # unit tests for create_microdeposit
+  # Create or pre-initiate a microdeposit
+  # Use this endpoint to create or pre-initiate a microdeposit. The response will include the new microdeposit record with a status of `INITIATED` or `PREINITIATED` respectively.  To pre-initiate a microdeposit, you only need to set `email` (string), `first_name` (string), and `last_name` (string) in the request body.   Pre-initiating a microdeposit allows you to pass the end user's first name, last name, and email if this data has already been collected. If the end user selects an institution which requires the microdeposit flow, the pre-initiated `micro_deposit` will be used and the Connect Widget step that normally requests this info from the end user will be skipped. However, if the end user selects an institution which supports IAV, the pre-initiated `micro_deposit` will be deleted and IAV will be used instead. When requesting a Connect Widget URL after pre-initiating, make sure to set the `current_microdeposit_guid` to the resulting microdeposit's `guid` and set the `mode` to `verification`. If you use this enhanced flow, a `micro_deposit` should be pre-initiated for all connect sessions in verification mode. After pre-initiating a microdeposit, pass the GUID to the config as `current_microdeposit_guid` and set the `mode` to `verification` when requesting a Connect URL.  Pre-initiating a microdeposit is optional. If you choose to implement this flow, it should be used for all Connect Widget sessions in verification mode. 
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param microdeposit_request_body 
   # @param [Hash] opts the optional parameters
-  # @option opts [MicrodepositVerifyRequestBody] :microdeposit_verify_request_body 
   # @return [MicrodepositResponseBody]
-  describe 'micro_deposits_microdeposit_guid_verify_put test' do
+  describe 'create_microdeposit test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_microdeposit
+  # Delete a microdeposit
+  # Use this endpoint to delete the specified microdeposit.
+  # @param micro_deposit_guid The unique identifier for the microdeposit. Defined by MX.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_microdeposit test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for users_user_guid_micro_deposits_get
+  # unit tests for list_user_microdeposits
   # List all microdeposits for a user
   # Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.
-  # @param user_guid The unique identifier for the user. Defined by MX.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
   # @param [Hash] opts the optional parameters
   # @return [MicrodepositsResponseBody]
-  describe 'users_user_guid_micro_deposits_get test' do
+  describe 'list_user_microdeposits test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for users_user_guid_micro_deposits_micro_deposit_guid_delete
-  # Delete a microdeposit
-  # Use this endpoint to delete the specified microdeposit.
-  # @param micro_deposit_guid The unique identifier for the microdeposit. Defined by MX.
-  # @param user_guid The unique id for a `user`.
+  # unit tests for list_user_verifications
+  # List all verifications for a user
+  # This endpoint returns a list of the account verifications associated with the user, as well as the status of those verifications. 
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'users_user_guid_micro_deposits_micro_deposit_guid_delete test' do
+  # @return [MicrodepositResponseBody]
+  describe 'list_user_verifications test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for users_user_guid_micro_deposits_micro_deposit_guid_get
+  # unit tests for read_user_microdeposit
   # Read a microdeposit for a user
-  # Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
-  # @param user_guid The unique identifier for the user. Defined by MX.
+  # Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint. 
   # @param micro_deposit_guid The unique identifier for the microdeposit. Defined by MX.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
   # @param [Hash] opts the optional parameters
   # @return [MicrodepositResponseBody]
-  describe 'users_user_guid_micro_deposits_micro_deposit_guid_get test' do
+  describe 'read_user_microdeposit test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for users_user_guid_micro_deposits_post
-  # Create a microdeposit
-  # Use this endpoint to create a microdeposit. The response will include the new microdeposit record with a status of INITIATED.
-  # @param user_guid The unique identifier for the user. Defined by MX.
-  # @param microdeposit_request_body 
+  # unit tests for verify_microdeposit
+  # Verify a Microdeposit
+  # Use this endpoint to verify the amounts deposited into the account during a microdeposit verification. The verification has not successfully completed until the `status` is `VERIFIED`. Poll the `/users/{user_guid}/micro_deposits/{micro_deposit_guid}` (read microdeposit) endpoint until you see this status or an error state.
+  # @param micro_deposit_guid The unique identifier for the microdeposit. Defined by MX.
   # @param [Hash] opts the optional parameters
+  # @option opts [MicrodepositVerifyRequestBody] :microdeposit_verify_request_body 
   # @return [MicrodepositResponseBody]
-  describe 'users_user_guid_micro_deposits_post test' do
+  describe 'verify_microdeposit test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end

data/spec/api/monthly_cash_flow_profile_api_spec.rb

@@ -0,0 +1,60 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MxPlatformRuby::MonthlyCashFlowProfileApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MonthlyCashFlowProfileApi' do
+  before do
+    # run before each test
+    @api_instance = MxPlatformRuby::MonthlyCashFlowProfileApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MonthlyCashFlowProfileApi' do
+    it 'should create an instance of MonthlyCashFlowProfileApi' do
+      expect(@api_instance).to be_instance_of(MxPlatformRuby::MonthlyCashFlowProfileApi)
+    end
+  end
+
+  # unit tests for read_monthly_cash_flow_profile
+  # Read monthly cash flow profile
+  # Read monthly cash flow profile.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param [Hash] opts the optional parameters
+  # @return [MonthlyCashFlowResponseBody]
+  describe 'read_monthly_cash_flow_profile test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_monthly_cash_flow_profile
+  # Update monthly cash flow profile
+  # Use this endpoint to update the attributes of a `monthly_cash_flow_profile`.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param monthly_cash_flow_profile_request_body 
+  # @param [Hash] opts the optional parameters
+  # @return [MonthlyCashFlowResponseBody]
+  describe 'update_monthly_cash_flow_profile test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/notifications_api_spec.rb

@@ -0,0 +1,78 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MxPlatformRuby::NotificationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'NotificationsApi' do
+  before do
+    # run before each test
+    @api_instance = MxPlatformRuby::NotificationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NotificationsApi' do
+    it 'should create an instance of NotificationsApi' do
+      expect(@api_instance).to be_instance_of(MxPlatformRuby::NotificationsApi)
+    end
+  end
+
+  # unit tests for create_notification
+  # Create a notification
+  # All notifications created through the API will be of notification type `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an entity.  No other channels are supported.  This will only have an effect for clients using an MX mobile application.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param content The information related to the notification.
+  # @param subject The subject related to the notification.
+  # @param [Hash] opts the optional parameters
+  # @return [NotificationResponseBody]
+  describe 'create_notification test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_notifications
+  # List notifications
+  # All notifications for the user can be listed, including notifications created by MX for other channels besides `PUSH`.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :from_date Filter transactions from this date. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 120 days ago if not provided.
+  # @option opts [String] :to_date Filter transactions to this date (at midnight). This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Defaults to 5 days forward from the day the request is made to capture pending transactions.
+  # @option opts [Integer] :page Results are paginated. Specify current page.
+  # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
+  # @return [NotificationsResponseBody]
+  describe 'list_notifications test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_notifications
+  # Read notifications
+  # Can pull up any notification associated with the user, including notifications created by MX for other channels besides `PUSH`. 
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param notification_guid The unique identifier for notifications. Defined by MX.
+  # @param [Hash] opts the optional parameters
+  # @return [NotificationResponseBody]
+  describe 'read_notifications test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/processor_token_api_spec.rb

@@ -0,0 +1,115 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MxPlatformRuby::ProcessorTokenApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ProcessorTokenApi' do
+  before do
+    # run before each test
+    @api_instance = MxPlatformRuby::ProcessorTokenApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProcessorTokenApi' do
+    it 'should create an instance of ProcessorTokenApi' do
+      expect(@api_instance).to be_instance_of(MxPlatformRuby::ProcessorTokenApi)
+    end
+  end
+
+  # unit tests for check_real_time_account_balance
+  # Check Real Time Account Balance (Processors Only)
+  # Check the real-time account balance using your access token.
+  # @param [Hash] opts the optional parameters
+  # @return [MemberResponseBody]
+  describe 'check_real_time_account_balance test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for deprecated_request_payment_processor_authorization_code
+  # (Deprecated) Request an authorization code
+  # (This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
+  # @param payment_processor_authorization_code_request_body The scope for the authorization code.
+  # @param [Hash] opts the optional parameters
+  # @return [PaymentProcessorAuthorizationCodeResponseBody]
+  describe 'deprecated_request_payment_processor_authorization_code test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_account_owner_info
+  # Get account owner information (Processors Only)
+  # Get account owner information (Processors Only)
+  # @param [Hash] opts the optional parameters
+  # @return [ProcessorOwnerBody]
+  describe 'get_account_owner_info test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_tokens
+  # View a List of Tokens
+  # View a list of tokens that exist for a user, member, or account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [TokenRequestBody] :token_request_body 
+  # @return [TokenResponseBody]
+  describe 'list_tokens test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_account_balance
+  # Read the account balance (Processors Only)
+  # Read the account balance (Processors Only)
+  # @param [Hash] opts the optional parameters
+  # @return [PaymentAccountBody]
+  describe 'read_account_balance test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for request_account_number
+  # Request an account number (Processors Only)
+  # Get account information such as routing number and account number, scoped to your access token.
+  # @param [Hash] opts the optional parameters
+  # @return [ProcessorAccountNumberBody]
+  describe 'request_account_number test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for request_authorization_code
+  # Request an authorization code
+  # Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.
+  # @param authorization_code_request_body The scope for the authorization code.
+  # @param [Hash] opts the optional parameters
+  # @return [AuthorizationCodeResponseBody]
+  describe 'request_authorization_code test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/rewards_api_spec.rb

@@ -0,0 +1,87 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MxPlatformRuby::RewardsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RewardsApi' do
+  before do
+    # run before each test
+    @api_instance = MxPlatformRuby::RewardsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RewardsApi' do
+    it 'should create an instance of RewardsApi' do
+      expect(@api_instance).to be_instance_of(MxPlatformRuby::RewardsApi)
+    end
+  end
+
+  # unit tests for credit_card
+  # Read a Credit Card Product
+  # This endpoint returns the specified `credit_card_product` according to the unique GUID.
+  # @param credit_card_product_guid The required `credit_card_product_guid` can be found on the `account` object.
+  # @param [Hash] opts the optional parameters
+  # @return [CreditCardProductResponse]
+  describe 'credit_card test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for fetch_rewards
+  # Fetch Rewards
+  # Calling this endpoint initiates an aggregation-type event which will gather the member's rewards information, as well as account and transaction information. Rewards data is also gathered with daily background aggregations. Member and Rewards guids are defined by MX.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param member_guid The unique id for a `member`.
+  # @param [Hash] opts the optional parameters
+  # @return [MemberResponseBody]
+  describe 'fetch_rewards test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_rewards
+  # List Rewards
+  # Use this endpoint to list all the `rewards` associated with a specified `member`. Member guids are defined by MX.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param member_guid The unique id for a `member`.
+  # @param [Hash] opts the optional parameters
+  # @return [RewardsResponseBody]
+  describe 'list_rewards test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_rewards
+  # Read Reward
+  # Use this endpoint to read a specific `reward` based on its unique GUID. Member and Rewards guids are defined by MX.
+  # @param user_guid The unique identifier for a `user`, beginning with the prefix `USR-`.
+  # @param member_guid The unique id for a `member`.
+  # @param reward_guid The unique identifier for the rewards. Defined by MX.
+  # @param [Hash] opts the optional parameters
+  # @return [RewardResponseBody]
+  describe 'read_rewards test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end