diff --git a/docs/WidgetRequest.md b/docs/WidgetRequest.md index a372ac2..bc409bb 100644 --- a/docs/WidgetRequest.md +++ b/docs/WidgetRequest.md @@ -2,30 +2,31 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **client_redirect_url** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. This determines the redirect destination at the end of OAuth when used with `is_mobile_webview: true` or `oauth_referral_source: 'APP'`. | [optional] | -| **color_scheme** | **String** | This option can be passed to any `widget_type` but will not affect [legacy PFM widgets](products/experience/pfm/legacy-widget-overviews/). Load the widget with the specified `color_scheme`; options are `light`, `browser` (respects user's browser setting), and `dark`. Defaults to `light`. | [optional] | -| **connections_use_case_filter** | **Boolean** | To use this parameter, you must also set `use_cases` in the same request. If `connections_use_case_filter` is set to `true`, the Connections Widget will only show connections (members) with the `use_cases` you set in the same request. For some examples, see [Filter Connections](/products/experience/pfm/widget-overviews/connections-widget#example-1). | [optional] | -| **current_institution_code** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into the credential view for the specified institution. | [optional] | -| **current_institution_guid** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into the credential view for the specified institution. | [optional] | -| **current_member_guid** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a specific member that contains an error or requires multifactor authentication. The widget will determine the best view to load based on the member's current state. `current_member_guid` takes precedence over `current_institution_code` and `current_institution_guid`. | [optional] | -| **disable_background_agg** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether background aggregation is enabled or disabled for the member created by the Connect Widget. Defaults to `false` in `aggregation` mode and `true` in `verification` mode. A global default for all members can be set by reaching out to MX. | [optional] | -| **disable_institution_search** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether the institution search is displayed within the Connect Widget. This option must be used with `current_institution_code`, `current_instituion_guid`, or `current_member_guid`. When set to `true`, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to `false`. | [optional] | -| **enable_app2app** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, the widget will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions. | [optional] | -| **include_identity** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether an account owner identification (AOI, previously called identity verification) is run in addition to the process specified by the `mode`. Defaults to `false`. This can be set in either `aggregation` or `verification` mode. The AOI runs after the primary process is complete. | [optional] | -| **include_transactions** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether transaction data are retrieved. Defaults to `true` in aggregation mode and `false` in verification mode. This can be set in either `aggregation` or `verification` mode. This option does not affect future foreground or background aggregations. | [optional] | -| **insight_guid** | **String** | Only use this option if the `widget_type` is set to `pulse_widget`. Set this to the insight guid you want to appear at the top of the insights feed. | [optional] | -| **iso_country_code** | **Array<String>** | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). | [optional] | -| **is_mobile_webview** | **Boolean** | This option is for all `widget_type`s. This configures the widget to render in a mobile WebView. JavaScript event postMessages are replaced with URL updates. | [optional] | -| **microwidget_instance_id** | **String** | Only use this option if the `widget_type` is set to `micro_pulse_carousel_widget`. Set this to a unique value for each instance of the Micro Widget. This lets us collect unique data for each instance of the widget. | [optional] | -| **mode** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. `mode` is the most important option for the Connect Widget. This determines what kind of process Connect will run, which affects how you should set many other options. Defaults to `aggregation`. `aggregation` mode retrieves account and transaction data; in other words, this runs a standard aggregation. `verification` mode retrieves account numbers and routing/transit numbers; in other words, it runs an Instant Account Verification (IAV). By default, verification mode does not retrieve transaction data; this default can be modified with secondary options. By default, background aggregation is disabled for all members created in verification mode; this default can be modified with secondary options. | [optional] | -| **oauth_referral_source** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. This determines how MX will respond to the result of an OAuth flow. When set to `APP`, MX will redirect to the URI specified in the `ui_message_webview_url_scheme`. When set to `BROWSER`, MX will send a postMessage but not redirect. If `is_mobile_webview` is `true`, this defaults to `APP`. If false, it defaults to `BROWSER`. | [optional] | -| **ui_message_version** | **Integer** | This option is for all `widget_type`s. This determines which version of postMessage events are triggered. Defaults to 4. All new implementations must use version 4. Prior versions are deprecated. | [optional] | -| **ui_message_webview_url_scheme** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. This is a client-defined scheme used in OAuth redirects in WebViews; also used in URL updates when these replace postMessages in WebViews. Defaults to `mx`. | [optional] | -| **update_credentials** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a view that allows them to update the current member. Optionally used with `current_member_guid`. This option should be used sparingly. The best practice is to use `current_member_guid` and let the widget resolve the issue. | [optional] | -| **use_cases** | **Array<String>** | The use case that will be associated with any members created through the widget. Valid values are `PFM` and/or `MONEY_MOVEMENT`. This is **required** if you've met with MX, opted in to using this field, and are requesting a widget with a `widget_type` of `connect_widget` or `connections_widget`. | [optional] | -| **widget_type** | **String** | This determines which widget URL you'll receive. See [Widget Types](/api-reference/platform-api/reference/widget-types) for a list of potential values. Additional request parameters may only apply to some widget types. | | +| Name | Type | Description | Notes | +| --------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **client_redirect_url** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. This determines the redirect destination at the end of OAuth when used with `is_mobile_webview: true` or `oauth_referral_source: 'APP'`. | [optional] | +| **color_scheme** | **String** | This option can be passed to any `widget_type` but will not affect [legacy PFM widgets](products/experience/pfm/legacy-widget-overviews/). Load the widget with the specified `color_scheme`; options are `light`, `browser` (respects user's browser setting), and `dark`. Defaults to `light`. | [optional] | +| **connections_use_case_filter** | **Boolean** | To use this parameter, you must also set `use_cases` in the same request. If `connections_use_case_filter` is set to `true`, the Connections Widget will only show connections (members) with the `use_cases` you set in the same request. For some examples, see [Filter Connections](/products/experience/pfm/widget-overviews/connections-widget#example-1). | [optional] | +| **current_institution_code** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into the credential view for the specified institution. | [optional] | +| **current_institution_guid** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into the credential view for the specified institution. | [optional] | +| **current_member_guid** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a specific member that contains an error or requires multifactor authentication. The widget will determine the best view to load based on the member's current state. `current_member_guid` takes precedence over `current_institution_code` and `current_institution_guid`. | [optional] | +| **current_microdeposit_guid** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a specific microdeposit verification flow. | [optional] | +| **disable_background_agg** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether background aggregation is enabled or disabled for the member created by the Connect Widget. Defaults to `false` in `aggregation` mode and `true` in `verification` mode. A global default for all members can be set by reaching out to MX. | [optional] | +| **disable_institution_search** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether the institution search is displayed within the Connect Widget. This option must be used with `current_institution_code`, `current_instituion_guid`, or `current_member_guid`. When set to `true`, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to `false`. | [optional] | +| **enable_app2app** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, the widget will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions. | [optional] | +| **include_identity** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether an account owner identification (AOI, previously called identity verification) is run in addition to the process specified by the `mode`. Defaults to `false`. This can be set in either `aggregation` or `verification` mode. The AOI runs after the primary process is complete. | [optional] | +| **include_transactions** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. This determines whether transaction data are retrieved. Defaults to `true` in aggregation mode and `false` in verification mode. This can be set in either `aggregation` or `verification` mode. This option does not affect future foreground or background aggregations. | [optional] | +| **insight_guid** | **String** | Only use this option if the `widget_type` is set to `pulse_widget`. Set this to the insight guid you want to appear at the top of the insights feed. | [optional] | +| **iso_country_code** | **Array<String>** | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). | [optional] | +| **is_mobile_webview** | **Boolean** | This option is for all `widget_type`s. This configures the widget to render in a mobile WebView. JavaScript event postMessages are replaced with URL updates. | [optional] | +| **microwidget_instance_id** | **String** | Only use this option if the `widget_type` is set to `micro_pulse_carousel_widget`. Set this to a unique value for each instance of the Micro Widget. This lets us collect unique data for each instance of the widget. | [optional] | +| **mode** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. `mode` is the most important option for the Connect Widget. This determines what kind of process Connect will run, which affects how you should set many other options. Defaults to `aggregation`. `aggregation` mode retrieves account and transaction data; in other words, this runs a standard aggregation. `verification` mode retrieves account numbers and routing/transit numbers; in other words, it runs an Instant Account Verification (IAV). By default, verification mode does not retrieve transaction data; this default can be modified with secondary options. By default, background aggregation is disabled for all members created in verification mode; this default can be modified with secondary options. | [optional] | +| **oauth_referral_source** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. This determines how MX will respond to the result of an OAuth flow. When set to `APP`, MX will redirect to the URI specified in the `ui_message_webview_url_scheme`. When set to `BROWSER`, MX will send a postMessage but not redirect. If `is_mobile_webview` is `true`, this defaults to `APP`. If false, it defaults to `BROWSER`. | [optional] | +| **ui_message_version** | **Integer** | This option is for all `widget_type`s. This determines which version of postMessage events are triggered. Defaults to 4. All new implementations must use version 4. Prior versions are deprecated. | [optional] | +| **ui_message_webview_url_scheme** | **String** | Only use this option if the `widget_type` is set to `connect_widget`. This is a client-defined scheme used in OAuth redirects in WebViews; also used in URL updates when these replace postMessages in WebViews. Defaults to `mx`. | [optional] | +| **update_credentials** | **Boolean** | Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a view that allows them to update the current member. Optionally used with `current_member_guid`. This option should be used sparingly. The best practice is to use `current_member_guid` and let the widget resolve the issue. | [optional] | +| **use_cases** | **Array<String>** | The use case that will be associated with any members created through the widget. Valid values are `PFM` and/or `MONEY_MOVEMENT`. This is **required** if you've met with MX, opted in to using this field, and are requesting a widget with a `widget_type` of `connect_widget` or `connections_widget`. | [optional] | +| **widget_type** | **String** | This determines which widget URL you'll receive. See [Widget Types](/api-reference/platform-api/reference/widget-types) for a list of potential values. Additional request parameters may only apply to some widget types. | | ## Example @@ -39,6 +40,7 @@ instance = MxPlatformRuby::WidgetRequest.new( current_institution_code: mxbank, current_institution_guid: INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9, current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b, + current_microdeposit_guid: MIC-09ba578e-8448-4f7f-89e1-b62ff2a3146c, disable_background_agg: false, disable_institution_search: false, enable_app2app: false, @@ -57,4 +59,3 @@ instance = MxPlatformRuby::WidgetRequest.new( widget_type: connect_widget ) ``` - diff --git a/lib/mx-platform-ruby/models/widget_request.rb b/lib/mx-platform-ruby/models/widget_request.rb index 6b2a9d9..74fe8ae 100644 --- a/lib/mx-platform-ruby/models/widget_request.rb +++ b/lib/mx-platform-ruby/models/widget_request.rb @@ -33,6 +33,9 @@ class WidgetRequest # Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a specific member that contains an error or requires multifactor authentication. The widget will determine the best view to load based on the member's current state. `current_member_guid` takes precedence over `current_institution_code` and `current_institution_guid`. attr_accessor :current_member_guid + # Only use this option if the `widget_type` is set to `connect_widget`. Load the widget into a specific microdeposit verification flow. + attr_accessor :current_microdeposit_guid + # Only use this option if the `widget_type` is set to `connect_widget`. This determines whether background aggregation is enabled or disabled for the member created by the Connect Widget. Defaults to `false` in `aggregation` mode and `true` in `verification` mode. A global default for all members can be set by reaching out to MX. attr_accessor :disable_background_agg @@ -112,6 +115,7 @@ def self.attribute_map :'current_institution_code' => :'current_institution_code', :'current_institution_guid' => :'current_institution_guid', :'current_member_guid' => :'current_member_guid', + :'current_microdeposit_guid' => :'current_microdeposit_guid', :'disable_background_agg' => :'disable_background_agg', :'disable_institution_search' => :'disable_institution_search', :'enable_app2app' => :'enable_app2app', @@ -145,6 +149,7 @@ def self.openapi_types :'current_institution_code' => :'String', :'current_institution_guid' => :'String', :'current_member_guid' => :'String', + :'current_microdeposit_guid' => :'String', :'disable_background_agg' => :'Boolean', :'disable_institution_search' => :'Boolean', :'enable_app2app' => :'Boolean', @@ -211,6 +216,10 @@ def initialize(attributes = {}) self.current_member_guid = attributes[:'current_member_guid'] end + if attributes.key?(:'current_microdeposit_guid') + self.current_microdeposit_guid = attributes[:'current_microdeposit_guid'] + end + if attributes.key?(:'disable_background_agg') self.disable_background_agg = attributes[:'disable_background_agg'] end @@ -313,6 +322,7 @@ def ==(o) current_institution_code == o.current_institution_code && current_institution_guid == o.current_institution_guid && current_member_guid == o.current_member_guid && + current_microdeposit_guid == o.current_microdeposit_guid && disable_background_agg == o.disable_background_agg && disable_institution_search == o.disable_institution_search && enable_app2app == o.enable_app2app && @@ -340,7 +350,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [client_redirect_url, color_scheme, connections_use_case_filter, current_institution_code, current_institution_guid, current_member_guid, disable_background_agg, disable_institution_search, enable_app2app, include_identity, include_transactions, insight_guid, iso_country_code, is_mobile_webview, microwidget_instance_id, mode, oauth_referral_source, ui_message_version, ui_message_webview_url_scheme, update_credentials, use_cases, widget_type].hash + [client_redirect_url, color_scheme, connections_use_case_filter, current_institution_code, current_institution_guid, current_member_guid, current_microdeposit_guid, disable_background_agg, disable_institution_search, enable_app2app, include_identity, include_transactions, insight_guid, iso_country_code, is_mobile_webview, microwidget_instance_id, mode, oauth_referral_source, ui_message_version, ui_message_webview_url_scheme, update_credentials, use_cases, widget_type].hash end # Builds the object from hash diff --git a/spec/models/widget_request_spec.rb b/spec/models/widget_request_spec.rb index c23ae31..d294c4c 100644 --- a/spec/models/widget_request_spec.rb +++ b/spec/models/widget_request_spec.rb @@ -63,6 +63,12 @@ end end + describe 'test attribute "current_microdeposit_guid"' do + it 'should work' do + # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/ + end + end + describe 'test attribute "disable_background_agg"' do it 'should work' do # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/