mx-platform-ruby 1.10.0 → 1.10.1

data/docs/WidgetRequest.md

@@ -4,24 +4,28 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **client_redirect_url** | **String** |  | [optional] |
-| **color_scheme** | **String** |  | [optional] |
-| **current_institution_code** | **String** |  | [optional] |
-| **current_institution_guid** | **String** |  | [optional] |
-| **current_member_guid** | **String** |  | [optional] |
-| **disable_background_agg** | **Boolean** |  | [optional] |
-| **disable_institution_search** | **Boolean** |  | [optional] |
-| **include_identity** | **Boolean** |  | [optional] |
-| **include_transactions** | **Boolean** |  | [optional] |
-| **insight_guid** | **String** |  | [optional] |
-| **is_mobile_webview** | **Boolean** |  | [optional] |
-| **microwidget_instance_id** | **String** |  | [optional] |
-| **mode** | **String** |  | [optional] |
-| **oauth_referral_source** | **String** |  | [optional] |
-| **ui_message_version** | **Integer** |  | [optional] |
-| **ui_message_webview_url_scheme** | **String** |  | [optional] |
-| **update_credentials** | **Boolean** |  | [optional] |
-| **widget_type** | **String** |  |  |
+| **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.  |  |
 
 ## Example
 
@@ -29,23 +33,27 @@
 require 'mx-platform-ruby'
 
 instance = MxPlatformRuby::WidgetRequest.new(
-  client_redirect_url: https://mx.com,
+  client_redirect_url: https://{yoursite.com},
   color_scheme: light,
-  current_institution_code: chase,
+  connections_use_case_filter: false,
+  current_institution_code: mxbank,
   current_institution_guid: INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9,
   current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
   disable_background_agg: false,
   disable_institution_search: false,
+  enable_app2app: false,
   include_identity: false,
   include_transactions: true,
-  insight_guid: BET-123,
+  insight_guid: null,
+  iso_country_code: ["US","CA"],
   is_mobile_webview: false,
-  microwidget_instance_id: accounts_page,
+  microwidget_instance_id: null,
   mode: aggregation,
   oauth_referral_source: BROWSER,
   ui_message_version: 4,
-  ui_message_webview_url_scheme: mx,
+  ui_message_webview_url_scheme: null,
   update_credentials: false,
+  use_cases: ["PFM"],
   widget_type: connect_widget
 )
 ```

data/docs/WidgetsApi.md

@@ -0,0 +1,244 @@
+# MxPlatformRuby::WidgetsApi
+
+All URIs are relative to *https://int-api.mx.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**request_connect_widget_url**](WidgetsApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | (Deprecated) Request connect widget URL |
+| [**request_o_auth_window_uri**](WidgetsApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri |
+| [**request_widget_url**](WidgetsApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget URL |
+
+
+## request_connect_widget_url
+
+> <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, connect_widget_request_body)
+
+(Deprecated) Request connect widget URL
+
+This endpoint will return a URL for an embeddable version of MX Connect.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::WidgetsApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+connect_widget_request_body = MxPlatformRuby::ConnectWidgetRequestBody.new # ConnectWidgetRequestBody | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials)
+
+begin
+  # (Deprecated) Request connect widget URL
+  result = api_instance.request_connect_widget_url(user_guid, connect_widget_request_body)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling WidgetsApi->request_connect_widget_url: #{e}"
+end
+```
+
+#### Using the request_connect_widget_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConnectWidgetResponseBody>, Integer, Hash)> request_connect_widget_url_with_http_info(user_guid, connect_widget_request_body)
+
+```ruby
+begin
+  # (Deprecated) Request connect widget URL
+  data, status_code, headers = api_instance.request_connect_widget_url_with_http_info(user_guid, connect_widget_request_body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConnectWidgetResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling WidgetsApi->request_connect_widget_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **connect_widget_request_body** | [**ConnectWidgetRequestBody**](ConnectWidgetRequestBody.md) | Optional config options for WebView (is_mobile_webview, current_institution_code, current_member_guid, update_credentials) |  |
+
+### Return type
+
+[**ConnectWidgetResponseBody**](ConnectWidgetResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## request_o_auth_window_uri
+
+> <OAuthWindowResponseBody> request_o_auth_window_uri(member_guid, user_guid, opts)
+
+Request oauth window uri
+
+This endpoint will generate an `oauth_window_uri` for the specified `member`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::WidgetsApi.new
+member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+opts = {
+  client_redirect_url: 'https://{yoursite.com}', # String | A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with `referral_source=APP`.
+  enable_app2app: 'false', # String | This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, any `oauth_window_uri` generated will **not** direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions.
+  referral_source: 'APP', # String | Must be either `BROWSER` or `APP` depending on the implementation. Defaults to `BROWSER`.
+  skip_aggregation: false, # Boolean | Setting this parameter to `true` will prevent the member from automatically aggregating after being redirected from the authorization page.
+  ui_message_webview_url_scheme: 'ui_message_webview_url_scheme_example' # String | A scheme for routing the user back to the application state they were previously in. Only available with `referral_source=APP`.
+}
+
+begin
+  # Request oauth window uri
+  result = api_instance.request_o_auth_window_uri(member_guid, user_guid, opts)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling WidgetsApi->request_o_auth_window_uri: #{e}"
+end
+```
+
+#### Using the request_o_auth_window_uri_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OAuthWindowResponseBody>, Integer, Hash)> request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts)
+
+```ruby
+begin
+  # Request oauth window uri
+  data, status_code, headers = api_instance.request_o_auth_window_uri_with_http_info(member_guid, user_guid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OAuthWindowResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling WidgetsApi->request_o_auth_window_uri_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member_guid** | **String** | The unique id for a &#x60;member&#x60;. |  |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **client_redirect_url** | **String** | A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with &#x60;referral_source&#x3D;APP&#x60;. | [optional] |
+| **enable_app2app** | **String** | This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to &#x60;true&#x60;. When set to &#x60;false&#x60;, any &#x60;oauth_window_uri&#x60; generated will **not** direct the end user to the institution&#39;s mobile application. This setting is not persistent. This setting currently only affects Chase institutions. | [optional] |
+| **referral_source** | **String** | Must be either &#x60;BROWSER&#x60; or &#x60;APP&#x60; depending on the implementation. Defaults to &#x60;BROWSER&#x60;. | [optional] |
+| **skip_aggregation** | **Boolean** | Setting this parameter to &#x60;true&#x60; will prevent the member from automatically aggregating after being redirected from the authorization page. | [optional] |
+| **ui_message_webview_url_scheme** | **String** | A scheme for routing the user back to the application state they were previously in. Only available with &#x60;referral_source&#x3D;APP&#x60;. | [optional] |
+
+### Return type
+
+[**OAuthWindowResponseBody**](OAuthWindowResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## request_widget_url
+
+> <WidgetResponseBody> request_widget_url(user_guid, widget_request_body, opts)
+
+Request widget URL
+
+Get an embeddable URL for integrating a widget into your website or app. The URL expires after ten minutes or upon first use, whichever occurs first. You'll need to obtain a new URL each time the page loads or reloads.  Include the `widget_type` in the request body to specify which widget you want to embed—the Connect Widget, a Personal Financial Management widget, or an Insights widget. Some request parameters are specific to certain widget types.  To embed the Connect Widget, set `widget_type` to `connect_widget`.  For a full list of available widget types, see [Widget Types](/api-reference/platform-api/reference/widgets#widget-types). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::WidgetsApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique identifier for a `user`, beginning with the prefix `USR-`.
+widget_request_body = MxPlatformRuby::WidgetRequestBody.new # WidgetRequestBody | The widget url configuration options.
+opts = {
+  accept_language: 'en-US', # String | The desired language of the widget.
+  x_callback_payload: '813e50bd-4a7e-4517-b6bb-9eef65a68cbd' # String | The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.
+}
+
+begin
+  # Request widget URL
+  result = api_instance.request_widget_url(user_guid, widget_request_body, opts)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling WidgetsApi->request_widget_url: #{e}"
+end
+```
+
+#### Using the request_widget_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WidgetResponseBody>, Integer, Hash)> request_widget_url_with_http_info(user_guid, widget_request_body, opts)
+
+```ruby
+begin
+  # Request widget URL
+  data, status_code, headers = api_instance.request_widget_url_with_http_info(user_guid, widget_request_body, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WidgetResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling WidgetsApi->request_widget_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_guid** | **String** | The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;. |  |
+| **widget_request_body** | [**WidgetRequestBody**](WidgetRequestBody.md) | The widget url configuration options. |  |
+| **accept_language** | **String** | The desired language of the widget. | [optional] |
+| **x_callback_payload** | **String** | The base64 encoded string defined in this header will be returned in the [Member](/resources/webhooks/member/) and [Member Data Updated](/resources/webhooks/member#member-data-updated) webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters. | [optional] |
+
+### Return type
+
+[**WidgetResponseBody**](WidgetResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/vnd.mx.api.v1+json
+