mx-platform-ruby 1.10.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dada7243019c79ed8273c04e7ff34ea7178d67db28997d5c4e9a10e960758e74
-  data.tar.gz: da978090bf61aa2d4f02aa1c7f5d7f39bedd3afa675ad7f1d99572aea720be47
+  metadata.gz: c51628b2fafeea5399b5646a72bed902cd8c862041a3961308a6e73d646690ec
+  data.tar.gz: f90f70b747b25c75437a14f4f41cec0be53c9358cc4475f136adf54314e272c4
 SHA512:
-  metadata.gz: 5fd11032dcaa99e6e6cfd0b7ee6704e836b86e4f4bb1d27964dd41c772cca427a80349498a1688d8a904478baf7a7a7ff2aeea3ccbfa567d412871eab35a060f
-  data.tar.gz: d874711081ff476c75693f5569ac7c1db482f3205376c584f02c43d2ce0b3d57dbee32ec6c7a395c96532b18f24db86b66c1cda535408e9f8a868866819479a5
+  metadata.gz: e8f2ff4fbe3c16ac7b63facd6c6fe3d7ed325aaa99b258ea27a7c8a4f3a65b7d27e8d63e39be15b0731c30ae7fad1f6a2f4d0c6f5af19f44a5ee00d71d121120
+  data.tar.gz: 71d515c50f80c884ac9931ad23e73083610ef276a7a7b2df0cc413d4c72b7c8242982da27304c84c3f692318981b44db86d139b98ea4d2cdd91d5b95571b1358

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (1.10.0)
+    mx-platform-ruby (1.10.1)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
       marcel

data/docs/ACHResponse.md

@@ -0,0 +1,74 @@
+# MxPlatformRuby::ACHResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** |  | [optional] |
+| **account_number_last_four** | **String** |  | [optional] |
+| **account_type** | **String** |  | [optional] |
+| **ach_initiated_at** | **String** |  | [optional] |
+| **client_guid** | **String** |  | [optional] |
+| **corrected_account_number** | **String** |  | [optional] |
+| **corrected_routing_number** | **String** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **institution_guid** | **String** |  | [optional] |
+| **investigation_notes** | **String** |  | [optional] |
+| **member_guid** | **String** |  | [optional] |
+| **processing_errors** | **String** |  | [optional] |
+| **resolution_code** | **String** |  | [optional] |
+| **resolution_detail** | **String** |  | [optional] |
+| **resolved_status_at** | **String** |  | [optional] |
+| **return_code** | **String** |  | [optional] |
+| **return_notes** | **String** |  | [optional] |
+| **return_account_number** | **String** |  | [optional] |
+| **return_routing_number** | **String** |  | [optional] |
+| **return_status** | **String** |  | [optional] |
+| **returned_at** | **String** |  | [optional] |
+| **sec_code** | **String** |  | [optional] |
+| **started_processing_at** | **String** |  | [optional] |
+| **submitted_at** | **String** |  | [optional] |
+| **transaction_amount** | **Float** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::ACHResponse.new(
+  account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
+  account_number_last_four: 1234,
+  account_type: CREDIT,
+  ach_initiated_at: 2025-02-13T18:08:00+00:00,
+  client_guid: CLT-abcd-1234,
+  corrected_account_number: null,
+  corrected_routing_number: null,
+  created_at: null,
+  guid: ACH-d74cb14f-fd0a-449f-991b-e0362a63d9c6,
+  id: client_ach_return_id_1234,
+  institution_guid: INS-34r4f44b-cfge-0f6e-3484-21f47e45tfv7,
+  investigation_notes: null,
+  member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
+  processing_errors: null,
+  resolution_code: null,
+  resolution_detail: null,
+  resolved_status_at: null,
+  return_code: R01,
+  return_notes: null,
+  return_account_number: null,
+  return_routing_number: null,
+  return_status: SUBMITTED,
+  returned_at: 2025-02-13T18:09:00+00:00,
+  sec_code: PPD,
+  started_processing_at: null,
+  submitted_at: null,
+  transaction_amount: 225.84,
+  updated_at: null,
+  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
+)
+```
+

data/docs/ACHReturnCreateRequest.md

@@ -0,0 +1,48 @@
+# MxPlatformRuby::ACHReturnCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** | The unique identifier for the account associated with the transaction. Defined by MX. |  |
+| **account_number_last_four** | **String** | The last 4 digits of the account number used for the transaction by the Originating Depository Financial Institution (ODFI). | [optional] |
+| **ach_initiated_at** | **String** | The date and time when the transaction was initiated by the Originating Depository Financial Institution (ODFI) in ISO 8601 format without timestamp. | [optional] |
+| **corrected_account_number** | **String** | The account number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`. | [optional] |
+| **corrected_routing_number** | **String** | The routing number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`. Must be a valid 9-digit routing number format. | [optional] |
+| **id** | **String** | Client-defined identifier for this specific return submission. Allows you to track and reference you requests. |  |
+| **member_guid** | **String** | The unique identifier for the member associated with the transaction. Defined by MX. |  |
+| **return_account_number** | **String** | Incorrect account number used in the ACH transaction. | [optional] |
+| **return_code** | **String** | The associated ACH return code and notice of change code (for example, R02, R03, R04, R05, R20, NOC). See [Return Codes](/api-reference/platform-api/reference/ach-return-fields#return-codes) for a complete list. |  |
+| **return_notes** | **String** | Notes that you set to inform MX on internal ACH processing. | [optional] |
+| **return_routing_number** | **String** | Incorrect routing number used in the ACH transaction. | [optional] |
+| **returned_at** | **String** | The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp. | [optional] |
+| **sec_code** | **String** | The SEC code (Standard Entry Class Code)–a three-letter code describing how a payment was authorized (for example, `WEB`). See [SEC Codes](/api-reference/platform-api/reference/ach-return-fields#sec-codes) for a complete list. | [optional] |
+| **transaction_amount** | **Float** | The amount of the transaction. | [optional] |
+| **transaction_amount_range** | **Float** | The transaction amount range, used for impact assessment. | [optional] |
+| **user_guid** | **String** | MX-defined identifier for the user associated with the ACH return. |  |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::ACHReturnCreateRequest.new(
+  account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
+  account_number_last_four: 1234,
+  ach_initiated_at: 2025-02-13T18:08:00+00:00,
+  corrected_account_number: null,
+  corrected_routing_number: null,
+  id: client_ach_id_1234,
+  member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
+  return_account_number: null,
+  return_code: R01,
+  return_notes: null,
+  return_routing_number: null,
+  returned_at: 2025-02-13T18:09:00+00:00,
+  sec_code: PPD,
+  transaction_amount: 225.84,
+  transaction_amount_range: null,
+  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
+)
+```
+

data/docs/ACHReturnCreateRequestBody.md

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

data/docs/ACHReturnResponseBody.md

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

data/docs/{HoldingsResponseBody.md → ACHReturnsResponseBody.md}

@@ -1,10 +1,10 @@
-# MxPlatformRuby::HoldingsResponseBody
+# MxPlatformRuby::ACHReturnsResponseBody
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **holdings** | [**Array<HoldingResponse>**](HoldingResponse.md) |  | [optional] |
+| **ach_returns** | [**Array<ACHResponse>**](ACHResponse.md) |  | [optional] |
 | **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
 
 ## Example
@@ -12,8 +12,8 @@
 ```ruby
 require 'mx-platform-ruby'
 
-instance = MxPlatformRuby::HoldingsResponseBody.new(
-  holdings: null,
+instance = MxPlatformRuby::ACHReturnsResponseBody.new(
+  ach_returns: null,
   pagination: null
 )
 ```

data/docs/AccountCreateRequest.md

@@ -34,23 +34,23 @@ require 'mx-platform-ruby'
 instance = MxPlatformRuby::AccountCreateRequest.new(
   account_subtype: PERSONAL,
   account_type: SAVINGS,
-  apr: 1.0,
-  apy: 1.0,
-  available_balance: 1000.0,
-  balance: 1000.0,
-  cash_surrender_value: 1000.0,
-  credit_limit: 100.0,
+  apr: 1,
+  apy: 1,
+  available_balance: 1000,
+  balance: 1000,
+  cash_surrender_value: 1000,
+  credit_limit: 100,
   currency_code: USD,
   death_benefit: 1000,
-  interest_rate: 1.0,
+  interest_rate: 1,
   is_business: false,
   is_closed: false,
   is_hidden: false,
-  loan_amount: 1000.0,
+  loan_amount: 1000,
   metadata: some metadata,
   name: Test account 2,
   nickname: Swiss Account,
-  original_balance: 10.0,
+  original_balance: 10,
   property_type: VEHICLE,
   skip_webhook: true
 )

data/docs/AccountNumberResponse.md

@@ -7,9 +7,9 @@
 | **account_guid** | **String** |  | [optional] |
 | **account_number** | **String** |  | [optional] |
 | **guid** | **String** |  | [optional] |
+| **institution_number** | **String** |  | [optional] |
 | **loan_guarantor** | **String** |  | [optional] |
 | **loan_reference_number** | **String** |  | [optional] |
-| **institution_number** | **String** |  | [optional] |
 | **member_guid** | **String** |  | [optional] |
 | **passed_validation** | **Boolean** |  | [optional] |
 | **routing_number** | **String** |  | [optional] |
@@ -26,9 +26,9 @@ instance = MxPlatformRuby::AccountNumberResponse.new(
   account_guid: ACT-06d7f45b-caae-0f6e-1384-01f52e75dcb1,
   account_number: 10001,
   guid: ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f,
-  loan_guarantor: U.S. DEPARTMENT OF EDUCATION,
-  loan_reference_number: 123456789012345,
   institution_number: 123,
+  loan_guarantor: U.S. DEPARTMENT OF EDUCATION (123456),
+  loan_reference_number: 123456789012345,
   member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
   passed_validation: true,
   routing_number: 68899990000000,

data/docs/AccountResponse.md

@@ -140,23 +140,23 @@ instance = MxPlatformRuby::AccountResponse.new(
   annuity_policy_to_date: 2016-10-13T17:57:37.000Z,
   annuity_provider: Metlife,
   annuity_term_year: 2048,
-  apr: 1.0,
+  apr: 1,
   apr_set_by: 1,
-  apy: 1.0,
+  apy: 1,
   apy_set_by: 1,
-  available_balance: 1000.0,
+  available_balance: 1000,
   available_balance_set_by: 1,
-  available_credit: 1000.0,
+  available_credit: 1000,
   available_credit_set_by: 1,
-  balance: 10000.0,
+  balance: 10000,
   balance_set_by: 1,
   calculated_apr: 21.66409,
-  cash_balance: 1000.0,
+  cash_balance: 1000,
   cash_balance_set_by: 1,
-  cash_surrender_value: 1000.0,
+  cash_surrender_value: 1000,
   cash_surrender_value_set_by: 1,
   created_at: 2023-07-25T17:14:46Z,
-  credit_limit: 100.0,
+  credit_limit: 100,
   credit_limit_set_by: 1,
   currency_code: USD,
   currency_code_set_by: 1,
@@ -168,75 +168,75 @@ instance = MxPlatformRuby::AccountResponse.new(
   feed_account_number: 5366,
   feed_account_subtype: 1,
   feed_account_type: 1,
-  feed_apr: 1.0,
-  feed_apy: 1.0,
-  feed_available_balance: 1000.0,
-  feed_balance: 1000.0,
-  feed_cash_balance: 1000.0,
-  feed_cash_surrender_value: 1000.0,
-  feed_credit_limit: 100.0,
+  feed_apr: 1,
+  feed_apy: 1,
+  feed_available_balance: 1000,
+  feed_balance: 1000,
+  feed_cash_balance: 1000,
+  feed_cash_surrender_value: 1000,
+  feed_credit_limit: 100,
   feed_currency_code: USD,
   feed_day_payment_is_due: 20,
   feed_death_benefit: 1000,
-  feed_holdings_value: 1000.0,
-  feed_interest_rate: 1.0,
+  feed_holdings_value: 1000,
+  feed_interest_rate: 1,
   feed_is_closed: false,
-  feed_last_payment: 100.0,
+  feed_last_payment: 100,
   feed_last_payment_at: 2023-07-25T17:14:46Z,
-  feed_loan_amount: 1000.0,
+  feed_loan_amount: 1000,
   feed_matures_on: 2015-10-13T17:57:37.000Z,
-  feed_minimum_balance: 100.0,
-  feed_minimum_payment: 10.0,
+  feed_minimum_balance: 100,
+  feed_minimum_payment: 10,
   feed_name: Test account 2,
   feed_nickname: My Checking,
-  feed_original_balance: 10.0,
+  feed_original_balance: 10,
   feed_payment_due_at: 2025-02-13T17:57:37.000Z,
-  feed_payoff_balance: 10.0,
+  feed_payoff_balance: 10,
   feed_routing_number: 68899990000000,
   feed_started_on: 2020-10-13T17:57:37.000Z,
-  feed_statement_balance: 100.0,
-  feed_total_account_value: 100.0,
+  feed_statement_balance: 100,
+  feed_total_account_value: 100,
   guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
-  holdings_value: 1000.0,
+  holdings_value: 1000,
   holdings_value_set_by: 1,
   id: 1040434698,
   imported_at: 2015-10-13T17:57:37.000Z,
   institution_code: 3af3685e-05d9-7060-359f-008d0755e993,
   institution_guid: INS-12a3b-4c5dd6-1349-008d0755e993,
   insured_name: Tommy Shelby,
-  interest_rate: 1.0,
+  interest_rate: 1,
   interest_rate_set_by: 1,
   is_closed: false,
   is_closed_set_by: 1,
   is_hidden: false,
   is_manual: false,
-  last_payment: 100.0,
+  last_payment: 100,
   last_payment_set_by: 1,
   last_payment_at: 2023-07-25T17:14:46Z,
   last_payment_at_set_by: 1,
-  loan_amount: 1000.0,
+  loan_amount: 1000,
   loan_amount_set_by: 1,
-  margin_balance: 1000.0,
+  margin_balance: 1000,
   matures_on: 2015-10-13T17:57:37.000Z,
   matures_on_set_by: 1,
   member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
   member_id: member123,
   member_is_managed_by_user: false,
   metadata: some metadata,
-  minimum_balance: 100.0,
+  minimum_balance: 100,
   minimum_balance_set_by: 1,
-  minimum_payment: 10.0,
+  minimum_payment: 10,
   minimum_payment_set_by: 1,
   name: Test account 2,
   name_set_by: 1,
   nickname: My Checking,
   nickname_set_by: 1,
-  original_balance: 10.0,
+  original_balance: 10,
   original_balance_set_by: 1,
-  pay_out_amount: 10.0,
+  pay_out_amount: 10,
   payment_due_at: 2015-10-13T17:57:37.000Z,
   payment_due_at_set_by: 1,
-  payoff_balance: 10.0,
+  payoff_balance: 10,
   payoff_balance_set_by: 1,
   premium_amount: 3900,
   property_type: VEHICLE,
@@ -249,9 +249,9 @@ instance = MxPlatformRuby::AccountResponse.new(
   subtype_set_by: 1,
   today_ugl_amount: 1000.5,
   today_ugl_percentage: 6.9,
-  total_account_value: 1.0,
+  total_account_value: 1,
   total_account_value_set_by: 1,
-  total_account_value_ugl: 1.0,
+  total_account_value_ugl: 1,
   type: SAVINGS,
   type_set_by: 1,
   updated_at: 2016-10-13T18:08:00.000Z,

data/docs/AccountUpdateRequest.md

@@ -4,27 +4,27 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **account_subtype** | **String** |  | [optional] |
-| **account_type** | **String** |  | [optional] |
-| **apr** | **Float** |  | [optional] |
-| **apy** | **Float** |  | [optional] |
-| **available_balance** | **Float** |  | [optional] |
-| **balance** | **Float** |  | [optional] |
-| **cash_surrender_value** | **Float** |  | [optional] |
-| **credit_limit** | **Float** |  | [optional] |
-| **currency_code** | **String** |  | [optional] |
-| **death_benefit** | **Integer** |  | [optional] |
-| **interest_rate** | **Float** |  | [optional] |
-| **is_business** | **Boolean** |  | [optional] |
-| **is_closed** | **Boolean** |  | [optional] |
-| **is_hidden** | **Boolean** |  | [optional] |
-| **loan_amount** | **Float** |  | [optional] |
-| **metadata** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **nickname** | **String** |  | [optional] |
-| **original_balance** | **Float** |  | [optional] |
-| **property_type** | **String** |  | [optional] |
-| **skip_webhook** | **Boolean** |  | [optional] |
+| **account_subtype** | **String** | Can only be updated for manual accounts. | [optional] |
+| **account_type** | **String** | Can only be updated for manual accounts. | [optional] |
+| **apr** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **apy** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **available_balance** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **balance** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **cash_surrender_value** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **credit_limit** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **currency_code** | **String** | Can only be updated for manual accounts. | [optional] |
+| **death_benefit** | **Integer** | Can only be updated for manual accounts. | [optional] |
+| **interest_rate** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **is_business** | **Boolean** | Can be updated for manual accounts and aggregated accounts. | [optional] |
+| **is_closed** | **Boolean** | Can only be updated for manual accounts. | [optional] |
+| **is_hidden** | **Boolean** | Can be updated for manual accounts and aggregated accounts. | [optional] |
+| **loan_amount** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **metadata** | **String** | Can only be updated for manual accounts. | [optional] |
+| **name** | **String** | Can only be updated for manual accounts. | [optional] |
+| **nickname** | **String** | Can only be updated for manual accounts. | [optional] |
+| **original_balance** | **Float** | Can only be updated for manual accounts. | [optional] |
+| **property_type** | **String** | Can only be updated for manual accounts. | [optional] |
+| **skip_webhook** | **Boolean** | If set to true, prevents sending an account webhook for the update if that webhook type is enabled for you. | [optional] |
 
 ## Example
 
@@ -34,23 +34,23 @@ require 'mx-platform-ruby'
 instance = MxPlatformRuby::AccountUpdateRequest.new(
   account_subtype: PERSONAL,
   account_type: SAVINGS,
-  apr: 1.0,
-  apy: 1.0,
-  available_balance: 1000.0,
-  balance: 1000.0,
-  cash_surrender_value: 1000.0,
-  credit_limit: 100.0,
+  apr: 1,
+  apy: 1,
+  available_balance: 1000,
+  balance: 1000,
+  cash_surrender_value: 1000,
+  credit_limit: 100,
   currency_code: USD,
   death_benefit: 1000,
-  interest_rate: 1.0,
+  interest_rate: 1,
   is_business: false,
   is_closed: false,
   is_hidden: false,
-  loan_amount: 1000.0,
+  loan_amount: 1000,
   metadata: some metadata,
   name: Test account 2,
   nickname: Swiss Account,
-  original_balance: 10.0,
+  original_balance: 10,
   property_type: VEHICLE,
   skip_webhook: true
 )