mx-platform-ruby 1.10.0 → 1.10.1

data/lib/mx-platform-ruby/api/microdeposits_api.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
@@ -19,33 +19,37 @@ module MxPlatformRuby
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 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 [String] The unique identifier for the microdeposit. Defined by MX.
+    # 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 [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
+    # @param microdeposit_request_body [MicrodepositRequestBody] 
     # @param [Hash] opts the optional parameters
-    # @option opts [MicrodepositVerifyRequestBody] :microdeposit_verify_request_body 
     # @return [MicrodepositResponseBody]
-    def micro_deposits_microdeposit_guid_verify_put(microdeposit_guid, opts = {})
-      data, _status_code, _headers = micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts)
+    def create_microdeposit(user_guid, microdeposit_request_body, opts = {})
+      data, _status_code, _headers = create_microdeposit_with_http_info(user_guid, microdeposit_request_body, opts)
       data
     end
 
-    # 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 [String] The unique identifier for the microdeposit. Defined by MX.
+    # 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 [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
+    # @param microdeposit_request_body [MicrodepositRequestBody] 
     # @param [Hash] opts the optional parameters
-    # @option opts [MicrodepositVerifyRequestBody] :microdeposit_verify_request_body 
     # @return [Array<(MicrodepositResponseBody, Integer, Hash)>] MicrodepositResponseBody data, response status code and response headers
-    def micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts = {})
+    def create_microdeposit_with_http_info(user_guid, microdeposit_request_body, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.micro_deposits_microdeposit_guid_verify_put ...'
+        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.create_microdeposit ...'
       end
-      # verify the required parameter 'microdeposit_guid' is set
-      if @api_client.config.client_side_validation && microdeposit_guid.nil?
-        fail ArgumentError, "Missing the required parameter 'microdeposit_guid' when calling MicrodepositsApi.micro_deposits_microdeposit_guid_verify_put"
+      # 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 MicrodepositsApi.create_microdeposit"
+      end
+      # verify the required parameter 'microdeposit_request_body' is set
+      if @api_client.config.client_side_validation && microdeposit_request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'microdeposit_request_body' when calling MicrodepositsApi.create_microdeposit"
       end
       # resource path
-      local_var_path = '/micro_deposits/{microdeposit_guid}/verify'.sub('{' + 'microdeposit_guid' + '}', CGI.escape(microdeposit_guid.to_s))
+      local_var_path = '/users/{user_guid}/micro_deposits'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -64,7 +68,7 @@ module MxPlatformRuby
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'microdeposit_verify_request_body'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(microdeposit_request_body)
 
       # return_type
       return_type = opts[:debug_return_type] || 'MicrodepositResponseBody'
@@ -73,7 +77,7 @@ module MxPlatformRuby
       auth_names = opts[:debug_auth_names] || ['basicAuth']
 
       new_options = opts.merge(
-        :operation => :"MicrodepositsApi.micro_deposits_microdeposit_guid_verify_put",
+        :operation => :"MicrodepositsApi.create_microdeposit",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -82,35 +86,102 @@ module MxPlatformRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MicrodepositsApi#create_microdeposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a microdeposit
+    # Use this endpoint to delete the specified microdeposit.
+    # @param micro_deposit_guid [String] The unique identifier for the microdeposit. Defined by MX.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_microdeposit(micro_deposit_guid, user_guid, opts = {})
+      delete_microdeposit_with_http_info(micro_deposit_guid, user_guid, opts)
+      nil
+    end
+
+    # Delete a microdeposit
+    # Use this endpoint to delete the specified microdeposit.
+    # @param micro_deposit_guid [String] The unique identifier for the microdeposit. Defined by MX.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_microdeposit_with_http_info(micro_deposit_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.delete_microdeposit ...'
+      end
+      # verify the required parameter 'micro_deposit_guid' is set
+      if @api_client.config.client_side_validation && micro_deposit_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'micro_deposit_guid' when calling MicrodepositsApi.delete_microdeposit"
+      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 MicrodepositsApi.delete_microdeposit"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/micro_deposits/{micro_deposit_guid}'.sub('{' + 'micro_deposit_guid' + '}', CGI.escape(micro_deposit_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MicrodepositsApi.delete_microdeposit",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MicrodepositsApi#micro_deposits_microdeposit_guid_verify_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: MicrodepositsApi#delete_microdeposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # 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 [String] The unique identifier for the user. Defined by MX.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param [Hash] opts the optional parameters
     # @return [MicrodepositsResponseBody]
-    def users_user_guid_micro_deposits_get(user_guid, opts = {})
-      data, _status_code, _headers = users_user_guid_micro_deposits_get_with_http_info(user_guid, opts)
+    def list_user_microdeposits(user_guid, opts = {})
+      data, _status_code, _headers = list_user_microdeposits_with_http_info(user_guid, opts)
       data
     end
 
     # 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 [String] The unique identifier for the user. Defined by MX.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param [Hash] opts the optional parameters
     # @return [Array<(MicrodepositsResponseBody, Integer, Hash)>] MicrodepositsResponseBody data, response status code and response headers
-    def users_user_guid_micro_deposits_get_with_http_info(user_guid, opts = {})
+    def list_user_microdeposits_with_http_info(user_guid, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.users_user_guid_micro_deposits_get ...'
+        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.list_user_microdeposits ...'
       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 MicrodepositsApi.users_user_guid_micro_deposits_get"
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MicrodepositsApi.list_user_microdeposits"
       end
       # resource path
       local_var_path = '/users/{user_guid}/micro_deposits'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
@@ -136,7 +207,7 @@ module MxPlatformRuby
       auth_names = opts[:debug_auth_names] || ['basicAuth']
 
       new_options = opts.merge(
-        :operation => :"MicrodepositsApi.users_user_guid_micro_deposits_get",
+        :operation => :"MicrodepositsApi.list_user_microdeposits",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -147,48 +218,44 @@ module MxPlatformRuby
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MicrodepositsApi#users_user_guid_micro_deposits_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: MicrodepositsApi#list_user_microdeposits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Delete a microdeposit
-    # Use this endpoint to delete the specified microdeposit.
-    # @param micro_deposit_guid [String] The unique identifier for the microdeposit. Defined by MX.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # 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 [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def users_user_guid_micro_deposits_micro_deposit_guid_delete(micro_deposit_guid, user_guid, opts = {})
-      users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid, opts)
-      nil
+    # @return [MicrodepositResponseBody]
+    def list_user_verifications(user_guid, opts = {})
+      data, _status_code, _headers = list_user_verifications_with_http_info(user_guid, opts)
+      data
     end
 
-    # Delete a microdeposit
-    # Use this endpoint to delete the specified microdeposit.
-    # @param micro_deposit_guid [String] The unique identifier for the microdeposit. Defined by MX.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # 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 [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid, opts = {})
+    # @return [Array<(MicrodepositResponseBody, Integer, Hash)>] MicrodepositResponseBody data, response status code and response headers
+    def list_user_verifications_with_http_info(user_guid, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_delete ...'
-      end
-      # verify the required parameter 'micro_deposit_guid' is set
-      if @api_client.config.client_side_validation && micro_deposit_guid.nil?
-        fail ArgumentError, "Missing the required parameter 'micro_deposit_guid' when calling MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_delete"
+        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.list_user_verifications ...'
       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 MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_delete"
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MicrodepositsApi.list_user_verifications"
       end
       # resource path
-      local_var_path = '/users/{user_guid}/micro_deposits/{micro_deposit_guid}'.sub('{' + 'micro_deposit_guid' + '}', CGI.escape(micro_deposit_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+      local_var_path = '/users/{user_guid}/account_verifications'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
 
       # header parameters
       header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -197,13 +264,13 @@ module MxPlatformRuby
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'MicrodepositResponseBody'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['basicAuth']
 
       new_options = opts.merge(
-        :operation => :"MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_delete",
+        :operation => :"MicrodepositsApi.list_user_verifications",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -212,44 +279,44 @@ module MxPlatformRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MicrodepositsApi#users_user_guid_micro_deposits_micro_deposit_guid_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: MicrodepositsApi#list_user_verifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # 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 [String] 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 [String] The unique identifier for the microdeposit. Defined by MX.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param [Hash] opts the optional parameters
     # @return [MicrodepositResponseBody]
-    def users_user_guid_micro_deposits_micro_deposit_guid_get(user_guid, micro_deposit_guid, opts = {})
-      data, _status_code, _headers = users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid, opts)
+    def read_user_microdeposit(micro_deposit_guid, user_guid, opts = {})
+      data, _status_code, _headers = read_user_microdeposit_with_http_info(micro_deposit_guid, user_guid, opts)
       data
     end
 
     # Read a microdeposit for a user
-    # Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. &lt;br&gt;&lt;/br&gt; 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 [String] 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. &lt;br&gt;&lt;/br&gt; 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 [String] The unique identifier for the microdeposit. Defined by MX.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param [Hash] opts the optional parameters
     # @return [Array<(MicrodepositResponseBody, Integer, Hash)>] MicrodepositResponseBody data, response status code and response headers
-    def users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid, opts = {})
+    def read_user_microdeposit_with_http_info(micro_deposit_guid, user_guid, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_get ...'
-      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 MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_get"
+        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.read_user_microdeposit ...'
       end
       # verify the required parameter 'micro_deposit_guid' is set
       if @api_client.config.client_side_validation && micro_deposit_guid.nil?
-        fail ArgumentError, "Missing the required parameter 'micro_deposit_guid' when calling MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_get"
+        fail ArgumentError, "Missing the required parameter 'micro_deposit_guid' when calling MicrodepositsApi.read_user_microdeposit"
+      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 MicrodepositsApi.read_user_microdeposit"
       end
       # resource path
-      local_var_path = '/users/{user_guid}/micro_deposits/{micro_deposit_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'micro_deposit_guid' + '}', CGI.escape(micro_deposit_guid.to_s))
+      local_var_path = '/users/{user_guid}/micro_deposits/{micro_deposit_guid}'.sub('{' + 'micro_deposit_guid' + '}', CGI.escape(micro_deposit_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -272,7 +339,7 @@ module MxPlatformRuby
       auth_names = opts[:debug_auth_names] || ['basicAuth']
 
       new_options = opts.merge(
-        :operation => :"MicrodepositsApi.users_user_guid_micro_deposits_micro_deposit_guid_get",
+        :operation => :"MicrodepositsApi.read_user_microdeposit",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -283,42 +350,38 @@ module MxPlatformRuby
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MicrodepositsApi#users_user_guid_micro_deposits_micro_deposit_guid_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: MicrodepositsApi#read_user_microdeposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # 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 [String] The unique identifier for the user. Defined by MX.
-    # @param microdeposit_request_body [MicrodepositRequestBody] 
+    # 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 [String] The unique identifier for the microdeposit. Defined by MX.
     # @param [Hash] opts the optional parameters
+    # @option opts [MicrodepositVerifyRequestBody] :microdeposit_verify_request_body 
     # @return [MicrodepositResponseBody]
-    def users_user_guid_micro_deposits_post(user_guid, microdeposit_request_body, opts = {})
-      data, _status_code, _headers = users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body, opts)
+    def verify_microdeposit(micro_deposit_guid, opts = {})
+      data, _status_code, _headers = verify_microdeposit_with_http_info(micro_deposit_guid, opts)
       data
     end
 
-    # 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 [String] The unique identifier for the user. Defined by MX.
-    # @param microdeposit_request_body [MicrodepositRequestBody] 
+    # 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 &#x60;status&#x60; is &#x60;VERIFIED&#x60;. Poll the &#x60;/users/{user_guid}/micro_deposits/{micro_deposit_guid}&#x60; (read microdeposit) endpoint until you see this status or an error state.
+    # @param micro_deposit_guid [String] The unique identifier for the microdeposit. Defined by MX.
     # @param [Hash] opts the optional parameters
+    # @option opts [MicrodepositVerifyRequestBody] :microdeposit_verify_request_body 
     # @return [Array<(MicrodepositResponseBody, Integer, Hash)>] MicrodepositResponseBody data, response status code and response headers
-    def users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body, opts = {})
+    def verify_microdeposit_with_http_info(micro_deposit_guid, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.users_user_guid_micro_deposits_post ...'
-      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 MicrodepositsApi.users_user_guid_micro_deposits_post"
+        @api_client.config.logger.debug 'Calling API: MicrodepositsApi.verify_microdeposit ...'
       end
-      # verify the required parameter 'microdeposit_request_body' is set
-      if @api_client.config.client_side_validation && microdeposit_request_body.nil?
-        fail ArgumentError, "Missing the required parameter 'microdeposit_request_body' when calling MicrodepositsApi.users_user_guid_micro_deposits_post"
+      # verify the required parameter 'micro_deposit_guid' is set
+      if @api_client.config.client_side_validation && micro_deposit_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'micro_deposit_guid' when calling MicrodepositsApi.verify_microdeposit"
       end
       # resource path
-      local_var_path = '/users/{user_guid}/micro_deposits'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+      local_var_path = '/micro_deposits/{micro_deposit_guid}/verify'.sub('{' + 'micro_deposit_guid' + '}', CGI.escape(micro_deposit_guid.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -337,7 +400,7 @@ module MxPlatformRuby
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(microdeposit_request_body)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'microdeposit_verify_request_body'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'MicrodepositResponseBody'
@@ -346,7 +409,7 @@ module MxPlatformRuby
       auth_names = opts[:debug_auth_names] || ['basicAuth']
 
       new_options = opts.merge(
-        :operation => :"MicrodepositsApi.users_user_guid_micro_deposits_post",
+        :operation => :"MicrodepositsApi.verify_microdeposit",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -355,9 +418,9 @@ module MxPlatformRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MicrodepositsApi#users_user_guid_micro_deposits_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: MicrodepositsApi#verify_microdeposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/mx-platform-ruby/api/monthly_cash_flow_profile_api.rb

@@ -0,0 +1,159 @@
+=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 'cgi'
+
+module MxPlatformRuby
+  class MonthlyCashFlowProfileApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Read monthly cash flow profile
+    # Read monthly cash flow profile.
+    # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
+    # @param [Hash] opts the optional parameters
+    # @return [MonthlyCashFlowResponseBody]
+    def read_monthly_cash_flow_profile(user_guid, opts = {})
+      data, _status_code, _headers = read_monthly_cash_flow_profile_with_http_info(user_guid, opts)
+      data
+    end
+
+    # Read monthly cash flow profile
+    # Read monthly cash flow profile.
+    # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MonthlyCashFlowResponseBody, Integer, Hash)>] MonthlyCashFlowResponseBody data, response status code and response headers
+    def read_monthly_cash_flow_profile_with_http_info(user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MonthlyCashFlowProfileApi.read_monthly_cash_flow_profile ...'
+      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 MonthlyCashFlowProfileApi.read_monthly_cash_flow_profile"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/monthly_cash_flow_profile'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MonthlyCashFlowResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MonthlyCashFlowProfileApi.read_monthly_cash_flow_profile",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MonthlyCashFlowProfileApi#read_monthly_cash_flow_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update monthly cash flow profile
+    # Use this endpoint to update the attributes of a `monthly_cash_flow_profile`.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param monthly_cash_flow_profile_request_body [MonthlyCashFlowProfileRequestBody] 
+    # @param [Hash] opts the optional parameters
+    # @return [MonthlyCashFlowResponseBody]
+    def update_monthly_cash_flow_profile(user_guid, monthly_cash_flow_profile_request_body, opts = {})
+      data, _status_code, _headers = update_monthly_cash_flow_profile_with_http_info(user_guid, monthly_cash_flow_profile_request_body, opts)
+      data
+    end
+
+    # Update monthly cash flow profile
+    # Use this endpoint to update the attributes of a &#x60;monthly_cash_flow_profile&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param monthly_cash_flow_profile_request_body [MonthlyCashFlowProfileRequestBody] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MonthlyCashFlowResponseBody, Integer, Hash)>] MonthlyCashFlowResponseBody data, response status code and response headers
+    def update_monthly_cash_flow_profile_with_http_info(user_guid, monthly_cash_flow_profile_request_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MonthlyCashFlowProfileApi.update_monthly_cash_flow_profile ...'
+      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 MonthlyCashFlowProfileApi.update_monthly_cash_flow_profile"
+      end
+      # verify the required parameter 'monthly_cash_flow_profile_request_body' is set
+      if @api_client.config.client_side_validation && monthly_cash_flow_profile_request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'monthly_cash_flow_profile_request_body' when calling MonthlyCashFlowProfileApi.update_monthly_cash_flow_profile"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/monthly_cash_flow_profile'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(monthly_cash_flow_profile_request_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MonthlyCashFlowResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MonthlyCashFlowProfileApi.update_monthly_cash_flow_profile",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MonthlyCashFlowProfileApi#update_monthly_cash_flow_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end