mx-platform-ruby 0.20.0 → 0.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/docs/MemberCreateRequestBody.md +2 -0
  4. data/docs/MxPlatformApi.md +1588 -507
  5. data/docs/SpendingPlanAccountResponse.md +30 -0
  6. data/docs/SpendingPlanAccountsResponse.md +20 -0
  7. data/docs/SpendingPlanIterationItemCreateRequestBody.md +26 -0
  8. data/docs/SpendingPlanIterationItemResponse.md +40 -0
  9. data/docs/SpendingPlanIterationItemsResponseBody.md +20 -0
  10. data/docs/SpendingPlanIterationResponse.md +32 -0
  11. data/docs/SpendingPlanIterationsResponse.md +20 -0
  12. data/docs/SpendingPlanResponse.md +26 -0
  13. data/docs/SpendingPlansResponseBody.md +20 -0
  14. data/lib/mx-platform-ruby/api/mx_platform_api.rb +1065 -8
  15. data/lib/mx-platform-ruby/models/member_create_request_body.rb +10 -1
  16. data/lib/mx-platform-ruby/models/spending_plan_account_response.rb +272 -0
  17. data/lib/mx-platform-ruby/models/spending_plan_accounts_response.rb +229 -0
  18. data/lib/mx-platform-ruby/models/spending_plan_iteration_item_create_request_body.rb +259 -0
  19. data/lib/mx-platform-ruby/models/spending_plan_iteration_item_response.rb +330 -0
  20. data/lib/mx-platform-ruby/models/spending_plan_iteration_items_response_body.rb +229 -0
  21. data/lib/mx-platform-ruby/models/spending_plan_iteration_response.rb +289 -0
  22. data/lib/mx-platform-ruby/models/spending_plan_iterations_response.rb +229 -0
  23. data/lib/mx-platform-ruby/models/spending_plan_response.rb +259 -0
  24. data/lib/mx-platform-ruby/models/spending_plans_response_body.rb +229 -0
  25. data/lib/mx-platform-ruby/version.rb +1 -1
  26. data/lib/mx-platform-ruby.rb +9 -0
  27. data/openapi/config.yml +1 -1
  28. data/spec/api/mx_platform_api_spec.rb +205 -0
  29. data/spec/models/member_create_request_body_spec.rb +6 -0
  30. data/spec/models/spending_plan_account_response_spec.rb +70 -0
  31. data/spec/models/spending_plan_accounts_response_spec.rb +40 -0
  32. data/spec/models/spending_plan_iteration_item_create_request_body_spec.rb +58 -0
  33. data/spec/models/spending_plan_iteration_item_response_spec.rb +100 -0
  34. data/spec/models/spending_plan_iteration_items_response_body_spec.rb +40 -0
  35. data/spec/models/spending_plan_iteration_response_spec.rb +76 -0
  36. data/spec/models/spending_plan_iterations_response_spec.rb +40 -0
  37. data/spec/models/spending_plan_response_spec.rb +58 -0
  38. data/spec/models/spending_plans_response_body_spec.rb +40 -0
  39. metadata +142 -106
data/docs/SpendingPlanAccountResponse.md ADDED
@@ -0,0 +1,30 @@
1
+ # MxPlatformRuby::SpendingPlanAccountResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_guid** | **String** | | [optional] |
8
+ | **client_guid** | **String** | | [optional] |
9
+ | **created_at** | **String** | | [optional] |
10
+ | **guid** | **String** | | [optional] |
11
+ | **spending_plan_guid** | **String** | | [optional] |
12
+ | **updated_at** | **String** | | [optional] |
13
+ | **user_guid** | **String** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'mx-platform-ruby'
19
+
20
+ instance = MxPlatformRuby::SpendingPlanAccountResponse.new(
21
+ account_guid: ACT-97d3948f-ebe7-434a-9bd0-20b29d67c9d4,
22
+ client_guid: CLT-024284fc-a6a7-42ee-b363-dab9343e3f72,
23
+ created_at: 2023-04-27T23:14:16Z,
24
+ guid: SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a,
25
+ spending_plan_guid: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600,
26
+ updated_at: 2023-04-27T23:14:16Z,
27
+ user_guid: USR-72086f59-6684-4adf-8f29-c4d32db43cd7
28
+ )
29
+ ```
30
+
data/docs/SpendingPlanAccountsResponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::SpendingPlanAccountsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **spending_plan_accounts** | [**Array<SpendingPlanAccountResponse>**](SpendingPlanAccountResponse.md) | | [optional] |
8
+ | **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::SpendingPlanAccountsResponse.new(
16
+ spending_plan_accounts: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
data/docs/SpendingPlanIterationItemCreateRequestBody.md ADDED
@@ -0,0 +1,26 @@
1
+ # MxPlatformRuby::SpendingPlanIterationItemCreateRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **category_guid** | **String** | | [optional] |
8
+ | **item_type** | **Float** | | [optional] |
9
+ | **planned_amount** | **Float** | | |
10
+ | **scheduled_payment_guid** | **String** | | [optional] |
11
+ | **top_level_category_guid** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mx-platform-ruby'
17
+
18
+ instance = MxPlatformRuby::SpendingPlanIterationItemCreateRequestBody.new(
19
+ category_guid: CAT-40faf068-abb4-405c-8f6a-e883ed541fff,
20
+ item_type: 1,
21
+ planned_amount: 110,
22
+ scheduled_payment_guid: SCP-c731988a-712f-4f83-9b3b-0aa5b3d5208b,
23
+ top_level_category_guid: CAT-9588eaad-90a4-bb5c-66c8-1812503d0db8
24
+ )
25
+ ```
26
+
data/docs/SpendingPlanIterationItemResponse.md ADDED
@@ -0,0 +1,40 @@
1
+ # MxPlatformRuby::SpendingPlanIterationItemResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **actual_amount** | **Float** | | [optional] |
8
+ | **category_guid** | **String** | | [optional] |
9
+ | **created_at** | **String** | | [optional] |
10
+ | **guid** | **String** | | [optional] |
11
+ | **item_type** | **String** | | [optional] |
12
+ | **planned_amount** | **Float** | | [optional] |
13
+ | **scheduled_payment_guid** | **String** | | [optional] |
14
+ | **spending_plan_iteration_guid** | **String** | | [optional] |
15
+ | **top_level_category_guid** | **String** | | [optional] |
16
+ | **transaction_guids** | **Array<String>** | | [optional] |
17
+ | **updated_at** | **String** | | [optional] |
18
+ | **user_guid** | **String** | | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'mx-platform-ruby'
24
+
25
+ instance = MxPlatformRuby::SpendingPlanIterationItemResponse.new(
26
+ actual_amount: 345.0,
27
+ category_guid: CAT-40faf068-abb4-405c-8f6a-e883ed541fff,
28
+ created_at: 2016-10-13T18:08:00+00:00,
29
+ guid: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262,
30
+ item_type: 0,
31
+ planned_amount: 345.0,
32
+ scheduled_payment_guid: SCP-54bed778-6600-4262-908c-8822f141cc30,
33
+ spending_plan_iteration_guid: SPI-848e6648-3fa3-4632-ac8f-e65f03167102,
34
+ top_level_category_guid: CAT-50af068-abb4-405c-8f6a-e883ed541f4f,
35
+ transaction_guids: null,
36
+ updated_at: 2016-10-13T18:09:00+00:00,
37
+ user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
38
+ )
39
+ ```
40
+
data/docs/SpendingPlanIterationItemsResponseBody.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::SpendingPlanIterationItemsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **iteration_items** | [**Array<SpendingPlanIterationItemResponse>**](SpendingPlanIterationItemResponse.md) | | [optional] |
8
+ | **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::SpendingPlanIterationItemsResponseBody.new(
16
+ iteration_items: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
data/docs/SpendingPlanIterationResponse.md ADDED
@@ -0,0 +1,32 @@
1
+ # MxPlatformRuby::SpendingPlanIterationResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **String** | | [optional] |
8
+ | **end_on** | **String** | | [optional] |
9
+ | **guid** | **String** | | [optional] |
10
+ | **iteration_number** | **Integer** | | [optional] |
11
+ | **spending_plan_guid** | **String** | | [optional] |
12
+ | **start_on** | **String** | | [optional] |
13
+ | **updated_at** | **String** | | [optional] |
14
+ | **user_guid** | **String** | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'mx-platform-ruby'
20
+
21
+ instance = MxPlatformRuby::SpendingPlanIterationResponse.new(
22
+ created_at: 2016-10-13T18:08:00+00:00,
23
+ end_on: 2023-05-31,
24
+ guid: SPI-848e6648-3fa3-4632-ac8f-e65f03167102,
25
+ iteration_number: 1,
26
+ spending_plan_guid: SPL-dbfe201d-c341-4bff-93c0-62a918d0b600,
27
+ start_on: 2023-05-01,
28
+ updated_at: 2016-10-13T18:09:00+00:00,
29
+ user_guid: USR-72086f59-6684-4adf-8f29-c4d32db43cd7
30
+ )
31
+ ```
32
+
data/docs/SpendingPlanIterationsResponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::SpendingPlanIterationsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **iterations** | [**Array<SpendingPlanIterationResponse>**](SpendingPlanIterationResponse.md) | | [optional] |
8
+ | **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::SpendingPlanIterationsResponse.new(
16
+ iterations: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
data/docs/SpendingPlanResponse.md ADDED
@@ -0,0 +1,26 @@
1
+ # MxPlatformRuby::SpendingPlanResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **String** | | [optional] |
8
+ | **current_iteration_number** | **Integer** | | [optional] |
9
+ | **guid** | **String** | | [optional] |
10
+ | **updated_at** | **String** | | [optional] |
11
+ | **user_guid** | **String** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'mx-platform-ruby'
17
+
18
+ instance = MxPlatformRuby::SpendingPlanResponse.new(
19
+ created_at: 2016-10-13T18:08:00+00:00,
20
+ current_iteration_number: 1,
21
+ guid: SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262,
22
+ updated_at: 2016-10-13T18:09:00+00:00,
23
+ user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
24
+ )
25
+ ```
26
+
data/docs/SpendingPlansResponseBody.md ADDED
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::SpendingPlansResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **iteration_items** | [**Array<SpendingPlanResponse>**](SpendingPlanResponse.md) | | [optional] |
8
+ | **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::SpendingPlansResponseBody.new(
16
+ iteration_items: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+