mx-platform-ruby 0.38.0 → 0.40.0

data/docs/MonthlyCashFlowProfileRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::MonthlyCashFlowProfileRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **institution** | [**MonthlyCashFlowProfileRequest**](MonthlyCashFlowProfileRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MonthlyCashFlowProfileRequestBody.new(
+  institution: null
+)
+```
+

data/docs/MonthlyCashFlowResponse.md

@@ -0,0 +1,30 @@
+# MxPlatformRuby::MonthlyCashFlowResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **guid** | **String** | Unique identifier for the monthly cash flow profile. Defined by MX. | [optional] |
+| **user_guid** | **String** | Unique identifier for the user the monthly cash flow profile is attached to. Defined by MX. | [optional] |
+| **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] |
+| **uses_estimated_goals_contribution** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+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,
+  estimated_goals_contribution: null,
+  uses_estimated_goals_contribution: false
+)
+```
+

data/docs/MonthlyCashFlowResponseBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::MonthlyCashFlowResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **monthly_cash_flow_profile** | [**MonthlyCashFlowResponse**](MonthlyCashFlowResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::MonthlyCashFlowResponseBody.new(
+  monthly_cash_flow_profile: null
+)
+```
+

data/docs/MxPlatformApi.md

@@ -106,6 +106,10 @@ All URIs are relative to *https://api.mx.com*
 | [**update_transaction**](MxPlatformApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction |
 | [**update_transaction_rule**](MxPlatformApi.md#update_transaction_rule) | **PUT** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Update transaction_rule |
 | [**update_user**](MxPlatformApi.md#update_user) | **PUT** /users/{user_guid} | Update user |
+| [**users_user_guid_monthly_cash_flow_profile_get**](MxPlatformApi.md#users_user_guid_monthly_cash_flow_profile_get) | **GET** /users/{user_guid}/monthly_cash_flow_profile | Read monthly cash flow profile |
+| [**users_user_guid_monthly_cash_flow_profile_put**](MxPlatformApi.md#users_user_guid_monthly_cash_flow_profile_put) | **PUT** /users/{user_guid}/monthly_cash_flow_profile | Update monthly cash flow profile |
+| [**users_user_guid_transactions_transaction_guid_split_delete**](MxPlatformApi.md#users_user_guid_transactions_transaction_guid_split_delete) | **DELETE** /users/{user_guid}/transactions/{transaction_guid}/split | Delete split transactions |
+| [**users_user_guid_transactions_transaction_guid_split_post**](MxPlatformApi.md#users_user_guid_transactions_transaction_guid_split_post) | **POST** /users/{user_guid}/transactions/{transaction_guid}/split | Create split transactions |
 | [**verify_member**](MxPlatformApi.md#verify_member) | **POST** /users/{user_guid}/members/{member_guid}/verify | Verify member |
 
 
@@ -7695,6 +7699,293 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## users_user_guid_monthly_cash_flow_profile_get
+
+> <MonthlyCashFlowResponseBody> users_user_guid_monthly_cash_flow_profile_get(user_guid)
+
+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::MxPlatformApi.new
+user_guid = 'user_guid_example' # String | The unique identifier for the user.
+
+begin
+  # Read monthly cash flow profile
+  result = api_instance.users_user_guid_monthly_cash_flow_profile_get(user_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->users_user_guid_monthly_cash_flow_profile_get: #{e}"
+end
+```
+
+#### Using the users_user_guid_monthly_cash_flow_profile_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MonthlyCashFlowResponseBody>, Integer, Hash)> users_user_guid_monthly_cash_flow_profile_get_with_http_info(user_guid)
+
+```ruby
+begin
+  # Read monthly cash flow profile
+  data, status_code, headers = api_instance.users_user_guid_monthly_cash_flow_profile_get_with_http_info(user_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MonthlyCashFlowResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->users_user_guid_monthly_cash_flow_profile_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for the user. |  |
+
+### Return type
+
+[**MonthlyCashFlowResponseBody**](MonthlyCashFlowResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_user_guid_monthly_cash_flow_profile_put
+
+> <MonthlyCashFlowResponseBody> users_user_guid_monthly_cash_flow_profile_put(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::MxPlatformApi.new
+user_guid = 'user_guid_example' # String | The unique identifier for the user.
+monthly_cash_flow_profile_request_body = MxPlatformRuby::MonthlyCashFlowProfileRequestBody.new # MonthlyCashFlowProfileRequestBody | 
+
+begin
+  # Update monthly cash flow profile
+  result = api_instance.users_user_guid_monthly_cash_flow_profile_put(user_guid, monthly_cash_flow_profile_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->users_user_guid_monthly_cash_flow_profile_put: #{e}"
+end
+```
+
+#### Using the users_user_guid_monthly_cash_flow_profile_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MonthlyCashFlowResponseBody>, Integer, Hash)> users_user_guid_monthly_cash_flow_profile_put_with_http_info(user_guid, monthly_cash_flow_profile_request_body)
+
+```ruby
+begin
+  # Update monthly cash flow profile
+  data, status_code, headers = api_instance.users_user_guid_monthly_cash_flow_profile_put_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 MxPlatformApi->users_user_guid_monthly_cash_flow_profile_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for the user. |  |
+| **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
+
+
+## users_user_guid_transactions_transaction_guid_split_delete
+
+> users_user_guid_transactions_transaction_guid_split_delete(transaction_guid, user_guid)
+
+Delete split transactions
+
+This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
+
+### 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::MxPlatformApi.new
+transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
+user_guid = 'USR-85628b0-5210-4878-9bd3-f4ce154f90c4' # String | The unique id for a `user`.
+
+begin
+  # Delete split transactions
+  api_instance.users_user_guid_transactions_transaction_guid_split_delete(transaction_guid, user_guid)
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->users_user_guid_transactions_transaction_guid_split_delete: #{e}"
+end
+```
+
+#### Using the users_user_guid_transactions_transaction_guid_split_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> users_user_guid_transactions_transaction_guid_split_delete_with_http_info(transaction_guid, user_guid)
+
+```ruby
+begin
+  # Delete split transactions
+  data, status_code, headers = api_instance.users_user_guid_transactions_transaction_guid_split_delete_with_http_info(transaction_guid, user_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->users_user_guid_transactions_transaction_guid_split_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. |  |
+| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## users_user_guid_transactions_transaction_guid_split_post
+
+> <SplitTransactionsResponseBody> users_user_guid_transactions_transaction_guid_split_post(user_guid, transaction_guid, opts)
+
+Create split transactions
+
+This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction.  When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again.    In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
+
+### 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::MxPlatformApi.new
+user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
+transaction_guid = 'transaction_guid_example' # String | The unique identifier for the transaction. Defined by MX.
+opts = {
+  split_transaction_request_body: MxPlatformRuby::SplitTransactionRequestBody.new({transactions: MxPlatformRuby::SplitTransactionRequest.new({amount: 54.19})}) # SplitTransactionRequestBody | 
+}
+
+begin
+  # Create split transactions
+  result = api_instance.users_user_guid_transactions_transaction_guid_split_post(user_guid, transaction_guid, opts)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->users_user_guid_transactions_transaction_guid_split_post: #{e}"
+end
+```
+
+#### Using the users_user_guid_transactions_transaction_guid_split_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SplitTransactionsResponseBody>, Integer, Hash)> users_user_guid_transactions_transaction_guid_split_post_with_http_info(user_guid, transaction_guid, opts)
+
+```ruby
+begin
+  # Create split transactions
+  data, status_code, headers = api_instance.users_user_guid_transactions_transaction_guid_split_post_with_http_info(user_guid, transaction_guid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SplitTransactionsResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->users_user_guid_transactions_transaction_guid_split_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for the user. Defined by MX. |  |
+| **transaction_guid** | **String** | The unique identifier for the transaction. Defined by MX. |  |
+| **split_transaction_request_body** | [**SplitTransactionRequestBody**](SplitTransactionRequestBody.md) |  | [optional] |
+
+### Return type
+
+[**SplitTransactionsResponseBody**](SplitTransactionsResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## verify_member
 
 > <MemberResponseBody> verify_member(member_guid, user_guid)

data/docs/RepositionRequest.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::RepositionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **guid** | **String** | The unique identifier for the goal. Defined by MX. |  |
+| **position** | **Integer** | The priority of the goal in relation to multiple goals. |  |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::RepositionRequest.new(
+  guid: GOL-97665947-235c-b213-ca25-8cf0174774f5,
+  position: 1
+)
+```
+

data/docs/RepositionRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::RepositionRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **goals** | [**Array<RepositionRequest>**](RepositionRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::RepositionRequestBody.new(
+  goals: null
+)
+```
+

data/docs/RepositionResponseBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::RepositionResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **goals** | [**Array<GoalsResponse>**](GoalsResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::RepositionResponseBody.new(
+  goals: null
+)
+```
+

data/docs/RewardResponse.md

@@ -13,6 +13,7 @@
 | **guid** | **String** |  | [optional] |
 | **member_guid** | **String** |  | [optional] |
 | **unit_type** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
 | **user_guid** | **String** |  | [optional] |
 
 ## Example
@@ -30,6 +31,7 @@ instance = MxPlatformRuby::RewardResponse.new(
   guid: RWD-1234,
   member_guid: MBR-4567,
   unit_type: POINTS,
+  updated_at: 2023-06-01T19:18:06Z,
   user_guid: USR-1234
 )
 ```

data/docs/RewardsResponse.md

@@ -13,6 +13,7 @@
 | **guid** | **String** |  | [optional] |
 | **member_guid** | **String** |  | [optional] |
 | **unit_type** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
 | **user_guid** | **String** |  | [optional] |
 
 ## Example
@@ -30,6 +31,7 @@ instance = MxPlatformRuby::RewardsResponse.new(
   guid: RWD-1234,
   member_guid: MBR-4567,
   unit_type: POINTS,
+  updated_at: 2023-06-01T19:18:06Z,
   user_guid: USR-1234
 )
 ```

data/docs/SplitTransactionRequest.md

@@ -0,0 +1,24 @@
+# MxPlatformRuby::SplitTransactionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount of money you want to re-categorize. |  |
+| **description** | **String** | Description for the split transaction. | [optional] |
+| **category_guid** | **String** | Unique identifier of the category. | [optional] |
+| **memo** | **String** | Memo for the split transaction | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SplitTransactionRequest.new(
+  amount: 54.19,
+  description: Chevron Gas,
+  category_guid: CAT-b6d61a19-30a7-e852-2703-bdfb4072289e,
+  memo: Chips and Soda
+)
+```
+

data/docs/SplitTransactionRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::SplitTransactionRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactions** | [**SplitTransactionRequest**](SplitTransactionRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SplitTransactionRequestBody.new(
+  transactions: null
+)
+```
+

data/docs/SplitTransactionsResponseBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::SplitTransactionsResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SplitTransactionsResponseBody.new(
+  transactions: null
+)
+```
+

data/docs/UpdateGoalRequest.md

@@ -0,0 +1,38 @@
+# MxPlatformRuby::UpdateGoalRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** | Unique identifier of the account for the goal. | [optional] |
+| **amount** | **Float** | Amount of the goal. | [optional] |
+| **goal_type_name** | **String** | The goal type. | [optional] |
+| **meta_type_name** | **String** | The category of the goal. | [optional] |
+| **name** | **String** | The name of the goal. | [optional] |
+| **completed_at** | **String** | Date and time the goal was completed. | [optional] |
+| **has_been_spent** | **Boolean** | Determines if the goal has been spent. | [optional] |
+| **is_complete** | **Boolean** | Determines if the goal is complete. | [optional] |
+| **metadata** | **String** | Additional information a partner can store on the goal. | [optional] |
+| **position** | **Integer** | The priority of the goal in relation to multiple goals. | [optional] |
+| **targeted_to_complete_at** | **String** | Date and time the goal is to complete. Intended for users to set their own goal completion dates. | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::UpdateGoalRequest.new(
+  account_guid: ACT-4e431124-4a29-abf9-f059-ab232ac14dbf,
+  amount: 4500.5,
+  goal_type_name: PAYOFF,
+  meta_type_name: VACATION,
+  name: Save for Europe,
+  completed_at: 2015-06-19T10:37:04-06:00,
+  has_been_spent: false,
+  is_complete: false,
+  metadata: Additional information,
+  position: 3,
+  targeted_to_complete_at: 2026-12-08 00:00:00.000000
+)
+```
+

data/docs/UpdateGoalRequestBody.md

@@ -0,0 +1,18 @@
+# MxPlatformRuby::UpdateGoalRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **goal** | [**UpdateGoalRequest**](UpdateGoalRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::UpdateGoalRequestBody.new(
+  goal: null
+)
+```
+