mx-platform-ruby 1.10.0 → 1.10.1

data/docs/MicrodepositsApi.md

@@ -1,23 +1,24 @@
 # MxPlatformRuby::MicrodepositsApi
 
-All URIs are relative to *https://api.mx.com*
+All URIs are relative to *https://int-api.mx.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**micro_deposits_microdeposit_guid_verify_put**](MicrodepositsApi.md#micro_deposits_microdeposit_guid_verify_put) | **PUT** /micro_deposits/{microdeposit_guid}/verify | Verify a Microdeposit |
-| [**users_user_guid_micro_deposits_get**](MicrodepositsApi.md#users_user_guid_micro_deposits_get) | **GET** /users/{user_guid}/micro_deposits | List all microdeposits for a user |
-| [**users_user_guid_micro_deposits_micro_deposit_guid_delete**](MicrodepositsApi.md#users_user_guid_micro_deposits_micro_deposit_guid_delete) | **DELETE** /users/{user_guid}/micro_deposits/{micro_deposit_guid} | Delete a microdeposit |
-| [**users_user_guid_micro_deposits_micro_deposit_guid_get**](MicrodepositsApi.md#users_user_guid_micro_deposits_micro_deposit_guid_get) | **GET** /users/{user_guid}/micro_deposits/{micro_deposit_guid} | Read a microdeposit for a user |
-| [**users_user_guid_micro_deposits_post**](MicrodepositsApi.md#users_user_guid_micro_deposits_post) | **POST** /users/{user_guid}/micro_deposits | Create a microdeposit |
+| [**create_microdeposit**](MicrodepositsApi.md#create_microdeposit) | **POST** /users/{user_guid}/micro_deposits | Create or pre-initiate a microdeposit |
+| [**delete_microdeposit**](MicrodepositsApi.md#delete_microdeposit) | **DELETE** /users/{user_guid}/micro_deposits/{micro_deposit_guid} | Delete a microdeposit |
+| [**list_user_microdeposits**](MicrodepositsApi.md#list_user_microdeposits) | **GET** /users/{user_guid}/micro_deposits | List all microdeposits for a user |
+| [**list_user_verifications**](MicrodepositsApi.md#list_user_verifications) | **GET** /users/{user_guid}/account_verifications | List all verifications for a user |
+| [**read_user_microdeposit**](MicrodepositsApi.md#read_user_microdeposit) | **GET** /users/{user_guid}/micro_deposits/{micro_deposit_guid} | Read a microdeposit for a user |
+| [**verify_microdeposit**](MicrodepositsApi.md#verify_microdeposit) | **PUT** /micro_deposits/{micro_deposit_guid}/verify | Verify a Microdeposit |
 
 
-## micro_deposits_microdeposit_guid_verify_put
+## create_microdeposit
 
-> <MicrodepositResponseBody> micro_deposits_microdeposit_guid_verify_put(microdeposit_guid, opts)
+> <MicrodepositResponseBody> create_microdeposit(user_guid, microdeposit_request_body)
 
-Verify a Microdeposit
+Create or pre-initiate 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.
+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. 
 
 ### Examples
 
@@ -32,35 +33,33 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::MicrodepositsApi.new
-microdeposit_guid = 'microdeposit_guid_example' # String | The unique identifier for the microdeposit. Defined by MX.
-opts = {
-  microdeposit_verify_request_body: MxPlatformRuby::MicrodepositVerifyRequestBody.new # MicrodepositVerifyRequestBody | 
-}
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+microdeposit_request_body = MxPlatformRuby::MicrodepositRequestBody.new # MicrodepositRequestBody | 
 
 begin
-  # Verify a Microdeposit
-  result = api_instance.micro_deposits_microdeposit_guid_verify_put(microdeposit_guid, opts)
+  # Create or pre-initiate a microdeposit
+  result = api_instance.create_microdeposit(user_guid, microdeposit_request_body)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->micro_deposits_microdeposit_guid_verify_put: #{e}"
+  puts "Error when calling MicrodepositsApi->create_microdeposit: #{e}"
 end
 ```
 
-#### Using the micro_deposits_microdeposit_guid_verify_put_with_http_info variant
+#### Using the create_microdeposit_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<MicrodepositResponseBody>, Integer, Hash)> micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts)
+> <Array(<MicrodepositResponseBody>, Integer, Hash)> create_microdeposit_with_http_info(user_guid, microdeposit_request_body)
 
 ```ruby
 begin
-  # Verify a Microdeposit
-  data, status_code, headers = api_instance.micro_deposits_microdeposit_guid_verify_put_with_http_info(microdeposit_guid, opts)
+  # Create or pre-initiate a microdeposit
+  data, status_code, headers = api_instance.create_microdeposit_with_http_info(user_guid, microdeposit_request_body)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <MicrodepositResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->micro_deposits_microdeposit_guid_verify_put_with_http_info: #{e}"
+  puts "Error when calling MicrodepositsApi->create_microdeposit_with_http_info: #{e}"
 end
 ```
 
@@ -68,8 +67,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **microdeposit_guid** | **String** | The unique identifier for the microdeposit. Defined by MX. |  |
-| **microdeposit_verify_request_body** | [**MicrodepositVerifyRequestBody**](MicrodepositVerifyRequestBody.md) |  | [optional] |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **microdeposit_request_body** | [**MicrodepositRequestBody**](MicrodepositRequestBody.md) |  |  |
 
 ### Return type
 
@@ -85,9 +84,80 @@ end
 - **Accept**: application/json
 
 
-## users_user_guid_micro_deposits_get
+## delete_microdeposit
+
+> delete_microdeposit(micro_deposit_guid, user_guid)
+
+Delete a microdeposit
+
+Use this endpoint to delete the specified microdeposit.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MicrodepositsApi.new
+micro_deposit_guid = 'MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb' # String | The unique identifier for the microdeposit. Defined by MX.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+
+begin
+  # Delete a microdeposit
+  api_instance.delete_microdeposit(micro_deposit_guid, user_guid)
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MicrodepositsApi->delete_microdeposit: #{e}"
+end
+```
+
+#### Using the delete_microdeposit_with_http_info variant
 
-> <MicrodepositsResponseBody> users_user_guid_micro_deposits_get(user_guid)
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_microdeposit_with_http_info(micro_deposit_guid, user_guid)
+
+```ruby
+begin
+  # Delete a microdeposit
+  data, status_code, headers = api_instance.delete_microdeposit_with_http_info(micro_deposit_guid, user_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MicrodepositsApi->delete_microdeposit_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **micro_deposit_guid** | **String** | The unique identifier for the microdeposit. Defined by MX. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list_user_microdeposits
+
+> <MicrodepositsResponseBody> list_user_microdeposits(user_guid)
 
 List all microdeposits for a user
 
@@ -106,32 +176,32 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::MicrodepositsApi.new
-user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
 
 begin
   # List all microdeposits for a user
-  result = api_instance.users_user_guid_micro_deposits_get(user_guid)
+  result = api_instance.list_user_microdeposits(user_guid)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_get: #{e}"
+  puts "Error when calling MicrodepositsApi->list_user_microdeposits: #{e}"
 end
 ```
 
-#### Using the users_user_guid_micro_deposits_get_with_http_info variant
+#### Using the list_user_microdeposits_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<MicrodepositsResponseBody>, Integer, Hash)> users_user_guid_micro_deposits_get_with_http_info(user_guid)
+> <Array(<MicrodepositsResponseBody>, Integer, Hash)> list_user_microdeposits_with_http_info(user_guid)
 
 ```ruby
 begin
   # List all microdeposits for a user
-  data, status_code, headers = api_instance.users_user_guid_micro_deposits_get_with_http_info(user_guid)
+  data, status_code, headers = api_instance.list_user_microdeposits_with_http_info(user_guid)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <MicrodepositsResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_get_with_http_info: #{e}"
+  puts "Error when calling MicrodepositsApi->list_user_microdeposits_with_http_info: #{e}"
 end
 ```
 
@@ -139,7 +209,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
 
 ### Return type
 
@@ -155,13 +225,13 @@ end
 - **Accept**: application/json
 
 
-## users_user_guid_micro_deposits_micro_deposit_guid_delete
+## list_user_verifications
 
-> users_user_guid_micro_deposits_micro_deposit_guid_delete(micro_deposit_guid, user_guid)
+> <MicrodepositResponseBody> list_user_verifications(user_guid)
 
-Delete a microdeposit
+List all verifications for a user
 
-Use this endpoint to delete the specified microdeposit.
+This endpoint returns a list of the account verifications associated with the user, as well as the status of those verifications. 
 
 ### Examples
 
@@ -176,32 +246,32 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::MicrodepositsApi.new
-micro_deposit_guid = 'MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb' # String | The unique identifier for the microdeposit. Defined by MX.
-user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
 
 begin
-  # Delete a microdeposit
-  api_instance.users_user_guid_micro_deposits_micro_deposit_guid_delete(micro_deposit_guid, user_guid)
+  # List all verifications for a user
+  result = api_instance.list_user_verifications(user_guid)
+  p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_micro_deposit_guid_delete: #{e}"
+  puts "Error when calling MicrodepositsApi->list_user_verifications: #{e}"
 end
 ```
 
-#### Using the users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info variant
+#### Using the list_user_verifications_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid)
+> <Array(<MicrodepositResponseBody>, Integer, Hash)> list_user_verifications_with_http_info(user_guid)
 
 ```ruby
 begin
-  # Delete a microdeposit
-  data, status_code, headers = api_instance.users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info(micro_deposit_guid, user_guid)
+  # List all verifications for a user
+  data, status_code, headers = api_instance.list_user_verifications_with_http_info(user_guid)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <MicrodepositResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_micro_deposit_guid_delete_with_http_info: #{e}"
+  puts "Error when calling MicrodepositsApi->list_user_verifications_with_http_info: #{e}"
 end
 ```
 
@@ -209,12 +279,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **micro_deposit_guid** | **String** | The unique identifier for the microdeposit. Defined by MX. |  |
-| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
 
 ### Return type
 
-nil (empty response body)
+[**MicrodepositResponseBody**](MicrodepositResponseBody.md)
 
 ### Authorization
 
@@ -223,16 +292,16 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
-## users_user_guid_micro_deposits_micro_deposit_guid_get
+## read_user_microdeposit
 
-> <MicrodepositResponseBody> users_user_guid_micro_deposits_micro_deposit_guid_get(user_guid, micro_deposit_guid)
+> <MicrodepositResponseBody> read_user_microdeposit(micro_deposit_guid, user_guid)
 
 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.
+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. 
 
 ### Examples
 
@@ -247,33 +316,33 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::MicrodepositsApi.new
-user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
-micro_deposit_guid = 'micro_deposit_guid_example' # String | The unique identifier for the microdeposit. Defined by MX.
+micro_deposit_guid = 'MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb' # String | The unique identifier for the microdeposit. Defined by MX.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
 
 begin
   # Read a microdeposit for a user
-  result = api_instance.users_user_guid_micro_deposits_micro_deposit_guid_get(user_guid, micro_deposit_guid)
+  result = api_instance.read_user_microdeposit(micro_deposit_guid, user_guid)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_micro_deposit_guid_get: #{e}"
+  puts "Error when calling MicrodepositsApi->read_user_microdeposit: #{e}"
 end
 ```
 
-#### Using the users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info variant
+#### Using the read_user_microdeposit_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<MicrodepositResponseBody>, Integer, Hash)> users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid)
+> <Array(<MicrodepositResponseBody>, Integer, Hash)> read_user_microdeposit_with_http_info(micro_deposit_guid, user_guid)
 
 ```ruby
 begin
   # Read a microdeposit for a user
-  data, status_code, headers = api_instance.users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info(user_guid, micro_deposit_guid)
+  data, status_code, headers = api_instance.read_user_microdeposit_with_http_info(micro_deposit_guid, user_guid)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <MicrodepositResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_micro_deposit_guid_get_with_http_info: #{e}"
+  puts "Error when calling MicrodepositsApi->read_user_microdeposit_with_http_info: #{e}"
 end
 ```
 
@@ -281,8 +350,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
 | **micro_deposit_guid** | **String** | The unique identifier for the microdeposit. Defined by MX. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
 
 ### Return type
 
@@ -298,13 +367,13 @@ end
 - **Accept**: application/json
 
 
-## users_user_guid_micro_deposits_post
+## verify_microdeposit
 
-> <MicrodepositResponseBody> users_user_guid_micro_deposits_post(user_guid, microdeposit_request_body)
+> <MicrodepositResponseBody> verify_microdeposit(micro_deposit_guid, opts)
 
-Create a microdeposit
+Verify a Microdeposit
 
-Use this endpoint to create a microdeposit. The response will include the new microdeposit record with a status of INITIATED.
+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.
 
 ### Examples
 
@@ -319,33 +388,35 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::MicrodepositsApi.new
-user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
-microdeposit_request_body = MxPlatformRuby::MicrodepositRequestBody.new # MicrodepositRequestBody | 
+micro_deposit_guid = 'MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb' # String | The unique identifier for the microdeposit. Defined by MX.
+opts = {
+  microdeposit_verify_request_body: MxPlatformRuby::MicrodepositVerifyRequestBody.new # MicrodepositVerifyRequestBody | 
+}
 
 begin
-  # Create a microdeposit
-  result = api_instance.users_user_guid_micro_deposits_post(user_guid, microdeposit_request_body)
+  # Verify a Microdeposit
+  result = api_instance.verify_microdeposit(micro_deposit_guid, opts)
   p result
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_post: #{e}"
+  puts "Error when calling MicrodepositsApi->verify_microdeposit: #{e}"
 end
 ```
 
-#### Using the users_user_guid_micro_deposits_post_with_http_info variant
+#### Using the verify_microdeposit_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<MicrodepositResponseBody>, Integer, Hash)> users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body)
+> <Array(<MicrodepositResponseBody>, Integer, Hash)> verify_microdeposit_with_http_info(micro_deposit_guid, opts)
 
 ```ruby
 begin
-  # Create a microdeposit
-  data, status_code, headers = api_instance.users_user_guid_micro_deposits_post_with_http_info(user_guid, microdeposit_request_body)
+  # Verify a Microdeposit
+  data, status_code, headers = api_instance.verify_microdeposit_with_http_info(micro_deposit_guid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <MicrodepositResponseBody>
 rescue MxPlatformRuby::ApiError => e
-  puts "Error when calling MicrodepositsApi->users_user_guid_micro_deposits_post_with_http_info: #{e}"
+  puts "Error when calling MicrodepositsApi->verify_microdeposit_with_http_info: #{e}"
 end
 ```
 
@@ -353,8 +424,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
-| **microdeposit_request_body** | [**MicrodepositRequestBody**](MicrodepositRequestBody.md) |  |  |
+| **micro_deposit_guid** | **String** | The unique identifier for the microdeposit. Defined by MX. |  |
+| **microdeposit_verify_request_body** | [**MicrodepositVerifyRequestBody**](MicrodepositVerifyRequestBody.md) |  | [optional] |
 
 ### Return type
 

data/docs/MonthlyCashFlowProfileApi.md

@@ -0,0 +1,151 @@
+# MxPlatformRuby::MonthlyCashFlowProfileApi
+
+All URIs are relative to *https://int-api.mx.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**read_monthly_cash_flow_profile**](MonthlyCashFlowProfileApi.md#read_monthly_cash_flow_profile) | **GET** /users/{user_guid}/monthly_cash_flow_profile | Read monthly cash flow profile |
+| [**update_monthly_cash_flow_profile**](MonthlyCashFlowProfileApi.md#update_monthly_cash_flow_profile) | **PUT** /users/{user_guid}/monthly_cash_flow_profile | Update monthly cash flow profile |
+
+
+## read_monthly_cash_flow_profile
+
+> <MonthlyCashFlowResponseBody> read_monthly_cash_flow_profile(user_guid)
+
+Read monthly cash flow profile
+
+Read monthly cash flow profile.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MonthlyCashFlowProfileApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+
+begin
+  # Read monthly cash flow profile
+  result = api_instance.read_monthly_cash_flow_profile(user_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MonthlyCashFlowProfileApi->read_monthly_cash_flow_profile: #{e}"
+end
+```
+
+#### Using the read_monthly_cash_flow_profile_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MonthlyCashFlowResponseBody>, Integer, Hash)> read_monthly_cash_flow_profile_with_http_info(user_guid)
+
+```ruby
+begin
+  # Read monthly cash flow profile
+  data, status_code, headers = api_instance.read_monthly_cash_flow_profile_with_http_info(user_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MonthlyCashFlowResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MonthlyCashFlowProfileApi->read_monthly_cash_flow_profile_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+
+### Return type
+
+[**MonthlyCashFlowResponseBody**](MonthlyCashFlowResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_monthly_cash_flow_profile
+
+> <MonthlyCashFlowResponseBody> update_monthly_cash_flow_profile(user_guid, monthly_cash_flow_profile_request_body)
+
+Update monthly cash flow profile
+
+Use this endpoint to update the attributes of a `monthly_cash_flow_profile`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MonthlyCashFlowProfileApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+monthly_cash_flow_profile_request_body = MxPlatformRuby::MonthlyCashFlowProfileRequestBody.new # MonthlyCashFlowProfileRequestBody | 
+
+begin
+  # Update monthly cash flow profile
+  result = api_instance.update_monthly_cash_flow_profile(user_guid, monthly_cash_flow_profile_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MonthlyCashFlowProfileApi->update_monthly_cash_flow_profile: #{e}"
+end
+```
+
+#### Using the update_monthly_cash_flow_profile_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MonthlyCashFlowResponseBody>, Integer, Hash)> update_monthly_cash_flow_profile_with_http_info(user_guid, monthly_cash_flow_profile_request_body)
+
+```ruby
+begin
+  # Update monthly cash flow profile
+  data, status_code, headers = api_instance.update_monthly_cash_flow_profile_with_http_info(user_guid, monthly_cash_flow_profile_request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MonthlyCashFlowResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MonthlyCashFlowProfileApi->update_monthly_cash_flow_profile_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **monthly_cash_flow_profile_request_body** | [**MonthlyCashFlowProfileRequestBody**](MonthlyCashFlowProfileRequestBody.md) |  |  |
+
+### Return type
+
+[**MonthlyCashFlowResponseBody**](MonthlyCashFlowResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/MonthlyCashFlowResponse.md

@@ -9,7 +9,7 @@
 | **budgeted_income** | **Float** | The amount of the budgeted income for the user. | [optional] |
 | **budgeted_expenses** | **Float** | The amount of the budgeted expenses for the user. | [optional] |
 | **goals_contribution** | **Float** | The monthly dollar amount allocated for goals. | [optional] |
-| **estimated_goals_contribution** | **Integer** | The estimated monthly dollar amount allocated for goals calculated from income and budgets. | [optional] |
+| **estimated_goals_contribution** | **Float** | The estimated monthly dollar amount allocated for goals calculated from income and budgets. | [optional] |
 | **uses_estimated_goals_contribution** | **Boolean** |  | [optional] |
 
 ## Example
@@ -21,8 +21,8 @@ instance = MxPlatformRuby::MonthlyCashFlowResponse.new(
   guid: MCF-4e431124-4a29-abf9-f059-ab232ac14dbf,
   user_guid: USR-6c83f63c-efcc-0189-3f14-100f0bad378a,
   budgeted_income: 1200.12,
-  budgeted_expenses: 1000.0,
-  goals_contribution: 150.0,
+  budgeted_expenses: 1000,
+  goals_contribution: 150,
   estimated_goals_contribution: null,
   uses_estimated_goals_contribution: false
 )

data/docs/NotificationResponse.md

@@ -0,0 +1,36 @@
+# MxPlatformRuby::NotificationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **guid** | **Object** |  | [optional] |
+| **content** | **Object** |  | [optional] |
+| **deep_link_guid** | **Object** |  | [optional] |
+| **delivered_at** | **Object** |  | [optional] |
+| **entity_guid** | **Object** |  | [optional] |
+| **has_been_delivered** | **Object** |  | [optional] |
+| **has_been_viewed** | **Object** |  | [optional] |
+| **notification_type** | **Object** |  | [optional] |
+| **subject** | **Object** |  | [optional] |
+| **channel** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::NotificationResponse.new(
+  guid: TF-b53294f5-2356-4782-9f81-ae064c42b40a,
+  content: The content related to the notification.,
+  deep_link_guid: BGT-e386a323-e452-47f2-b2fd-1ac3c18533de,
+  delivered_at: null,
+  entity_guid: BGT-e386a323-e452-47f2-b2fd-1ac3c18533de,
+  has_been_delivered: true,
+  has_been_viewed: false,
+  notification_type: 2,
+  subject: You're projected to spend $1,920.07 more than you've budgeted for Fees & Charges. You've already spent $65.67 of $316.00.,
+  channel: push
+)
+```
+