mx-platform-ruby 0.28.0 → 0.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/docs/AccountResponse.md +2 -2
  4. data/docs/InsightResponse.md +56 -0
  5. data/docs/InsightResponseBody.md +18 -0
  6. data/docs/InsightUpdateRequest.md +20 -0
  7. data/docs/InsightsApi.md +706 -0
  8. data/docs/InsightsResponseBody.md +20 -0
  9. data/docs/MxPlatformApi.md +1 -1
  10. data/docs/ScheduledPaymentResponse.md +42 -0
  11. data/docs/ScheduledPaymentsResponseBody.md +20 -0
  12. data/docs/WidgetRequest.md +1 -1
  13. data/lib/mx-platform-ruby/api/insights_api.rb +690 -0
  14. data/lib/mx-platform-ruby/api/mx_platform_api.rb +2 -2
  15. data/lib/mx-platform-ruby/models/account_response.rb +11 -11
  16. data/lib/mx-platform-ruby/models/insight_response.rb +404 -0
  17. data/lib/mx-platform-ruby/models/insight_response_body.rb +216 -0
  18. data/lib/mx-platform-ruby/models/insight_update_request.rb +223 -0
  19. data/lib/mx-platform-ruby/models/insights_response_body.rb +225 -0
  20. data/lib/mx-platform-ruby/models/scheduled_payment_response.rb +322 -0
  21. data/lib/mx-platform-ruby/models/scheduled_payments_response_body.rb +225 -0
  22. data/lib/mx-platform-ruby/version.rb +1 -1
  23. data/lib/mx-platform-ruby.rb +7 -0
  24. data/openapi/config.yml +1 -1
  25. data/spec/api/insights_api_spec.rb +166 -0
  26. data/spec/api/mx_platform_api_spec.rb +1 -1
  27. data/spec/models/account_response_spec.rb +3 -3
  28. data/spec/models/insight_response_body_spec.rb +34 -0
  29. data/spec/models/insight_response_spec.rb +148 -0
  30. data/spec/models/insight_update_request_spec.rb +40 -0
  31. data/spec/models/insights_response_body_spec.rb +40 -0
  32. data/spec/models/scheduled_payment_response_spec.rb +106 -0
  33. data/spec/models/scheduled_payments_response_body_spec.rb +40 -0
  34. metadata +30 -2
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::InsightsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **insights** | [**Array<InsightResponse>**](InsightResponse.md) | | [optional] |
8
+ | **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::InsightsResponseBody.new(
16
+ insights: null,
17
+ pagination: null
18
+ )
19
+ ```
20
+
@@ -549,7 +549,7 @@ end
549
549
 
550
550
  Create manual account
551
551
 
552
- This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed..
552
+ This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed.
553
553
 
554
554
  ### Examples
555
555
 
@@ -0,0 +1,42 @@
1
+ # MxPlatformRuby::ScheduledPaymentResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Float** | | [optional] |
8
+ | **created_at** | **String** | | [optional] |
9
+ | **description** | **String** | | [optional] |
10
+ | **guid** | **String** | | [optional] |
11
+ | **is_completed** | **Boolean** | | [optional] |
12
+ | **is_recurring** | **Boolean** | | [optional] |
13
+ | **merchant_guid** | **String** | | [optional] |
14
+ | **occurs_on** | **String** | | [optional] |
15
+ | **recurrence_day** | **Integer** | | [optional] |
16
+ | **recurrence_type** | **String** | | [optional] |
17
+ | **transaction_type** | **String** | | [optional] |
18
+ | **updated_at** | **String** | | [optional] |
19
+ | **user_guid** | **String** | | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'mx-platform-ruby'
25
+
26
+ instance = MxPlatformRuby::ScheduledPaymentResponse.new(
27
+ amount: 13.54,
28
+ created_at: 2023-04-27T23:14:16Z,
29
+ description: Netflix,
30
+ guid: SPA-c76e4a85-b2c4-4335-82b7-8f8b8f28c35a,
31
+ is_completed: false,
32
+ is_recurring: true,
33
+ merchant_guid: MCH-b8a2624c-2176-59ec-c150-37854bc38aa8,
34
+ occurs_on: 2022-01-15,
35
+ recurrence_day: 15,
36
+ recurrence_type: EVERY_MONTH,
37
+ transaction_type: DEBIT,
38
+ updated_at: 2023-04-27T23:14:16Z,
39
+ user_guid: USR-72086f59-6684-4adf-8f29-c4d32db43cd7
40
+ )
41
+ ```
42
+
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::ScheduledPaymentsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **pagination** | [**PaginationResponse**](PaginationResponse.md) | | [optional] |
8
+ | **scheduled_payments** | [**Array<ScheduledPaymentResponse>**](ScheduledPaymentResponse.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::ScheduledPaymentsResponseBody.new(
16
+ pagination: null,
17
+ scheduled_payments: null
18
+ )
19
+ ```
20
+
@@ -38,7 +38,7 @@ instance = MxPlatformRuby::WidgetRequest.new(
38
38
  disable_institution_search: false,
39
39
  include_identity: false,
40
40
  include_transactions: true,
41
- insight_guid: BET-1234,
41
+ insight_guid: BET-123,
42
42
  is_mobile_webview: false,
43
43
  microwidget_instance_id: accounts_page,
44
44
  mode: aggregation,