mx-platform-ruby 0.21.0 → 0.22.1

data/docs/SpendingPlanAccountResponse.md

@@ -0,0 +1,30 @@
+# MxPlatformRuby::SpendingPlanAccountResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_guid** | **String** |  | [optional] |
+| **client_guid** | **String** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **spending_plan_guid** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlanAccountResponse.new(
+  account_guid: ACT-97d3948f-ebe7-434a-9bd0-20b29d67c9d4,
+  client_guid: CLT-024284fc-a6a7-42ee-b363-dab9343e3f72,
+  created_at: 2023-04-27T23:14:16Z,
+  guid: SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a,
+  spending_plan_guid: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600,
+  updated_at: 2023-04-27T23:14:16Z,
+  user_guid: USR-72086f59-6684-4adf-8f29-c4d32db43cd7
+)
+```
+

data/docs/SpendingPlanAccountsResponse.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::SpendingPlanAccountsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **spending_plan_accounts** | [**Array<SpendingPlanAccountResponse>**](SpendingPlanAccountResponse.md) |  | [optional] |
+| **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlanAccountsResponse.new(
+  spending_plan_accounts: null,
+  pagination: null
+)
+```
+

data/docs/SpendingPlanIterationItemCreateRequestBody.md

@@ -0,0 +1,26 @@
+# MxPlatformRuby::SpendingPlanIterationItemCreateRequestBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_guid** | **String** |  | [optional] |
+| **item_type** | **Float** |  | [optional] |
+| **planned_amount** | **Float** |  |  |
+| **scheduled_payment_guid** | **String** |  | [optional] |
+| **top_level_category_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlanIterationItemCreateRequestBody.new(
+  category_guid: CAT-40faf068-abb4-405c-8f6a-e883ed541fff,
+  item_type: 1,
+  planned_amount: 110,
+  scheduled_payment_guid: SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b,
+  top_level_category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8
+)
+```
+

data/docs/SpendingPlanIterationItemResponse.md

@@ -0,0 +1,40 @@
+# MxPlatformRuby::SpendingPlanIterationItemResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actual_amount** | **Float** |  | [optional] |
+| **category_guid** | **String** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **item_type** | **String** |  | [optional] |
+| **planned_amount** | **Float** |  | [optional] |
+| **scheduled_payment_guid** | **String** |  | [optional] |
+| **spending_plan_iteration_guid** | **String** |  | [optional] |
+| **top_level_category_guid** | **String** |  | [optional] |
+| **transaction_guids** | **Array<String>** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlanIterationItemResponse.new(
+  actual_amount: 345.0,
+  category_guid: CAT-40faf068-abb4-405c-8f6a-e883ed541fff,
+  created_at: 2016-10-13T18:08:00+00:00,
+  guid: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262,
+  item_type: 0,
+  planned_amount: 345.0,
+  scheduled_payment_guid: SCP-54bed778-6600-4262-908c-8822f141cc30,
+  spending_plan_iteration_guid: SPI-848e6648-3fa3-4632-ac8f-e65f03167102,
+  top_level_category_guid: CAT-50af068-abb4-405c-8f6a-e883ed541f4f,
+  transaction_guids: null,
+  updated_at: 2016-10-13T18:09:00+00:00,
+  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
+)
+```
+

data/docs/SpendingPlanIterationItemsResponseBody.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::SpendingPlanIterationItemsResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iteration_items** | [**Array<SpendingPlanIterationItemResponse>**](SpendingPlanIterationItemResponse.md) |  | [optional] |
+| **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlanIterationItemsResponseBody.new(
+  iteration_items: null,
+  pagination: null
+)
+```
+

data/docs/SpendingPlanIterationResponse.md

@@ -0,0 +1,32 @@
+# MxPlatformRuby::SpendingPlanIterationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** |  | [optional] |
+| **end_on** | **String** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **iteration_number** | **Integer** |  | [optional] |
+| **spending_plan_guid** | **String** |  | [optional] |
+| **start_on** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlanIterationResponse.new(
+  created_at: 2016-10-13T18:08:00+00:00,
+  end_on: 2023-05-31,
+  guid: SPI-848e6648-3fa3-4632-ac8f-e65f03167102,
+  iteration_number: 1,
+  spending_plan_guid: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600,
+  start_on: 2023-05-01,
+  updated_at: 2016-10-13T18:09:00+00:00,
+  user_guid: USR-72086f59-6684-4adf-8f29-c4d32db43cd7
+)
+```
+

data/docs/SpendingPlanIterationsResponse.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::SpendingPlanIterationsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iterations** | [**Array<SpendingPlanIterationResponse>**](SpendingPlanIterationResponse.md) |  | [optional] |
+| **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlanIterationsResponse.new(
+  iterations: null,
+  pagination: null
+)
+```
+

data/docs/SpendingPlanResponse.md

@@ -0,0 +1,26 @@
+# MxPlatformRuby::SpendingPlanResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** |  | [optional] |
+| **current_iteration_number** | **Integer** |  | [optional] |
+| **guid** | **String** |  | [optional] |
+| **updated_at** | **String** |  | [optional] |
+| **user_guid** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlanResponse.new(
+  created_at: 2016-10-13T18:08:00+00:00,
+  current_iteration_number: 1,
+  guid: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262,
+  updated_at: 2016-10-13T18:09:00+00:00,
+  user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
+)
+```
+

data/docs/SpendingPlansResponseBody.md

@@ -0,0 +1,20 @@
+# MxPlatformRuby::SpendingPlansResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iteration_items** | [**Array<SpendingPlanResponse>**](SpendingPlanResponse.md) |  | [optional] |
+| **pagination** | [**PaginationResponse**](PaginationResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'mx-platform-ruby'
+
+instance = MxPlatformRuby::SpendingPlansResponseBody.new(
+  iteration_items: null,
+  pagination: null
+)
+```
+