Skip to content

Commit 24cc570

Browse files
author
devexperience
committed
Generated version 1.12.0
This commit was automatically created by a GitHub Action to generate version 1.12.0 of this library.
1 parent 2153df0 commit 24cc570

20 files changed

+43
-43
lines changed

docs/AccountsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ Name | Type | Description | Notes
519519
520520
List accounts
521521

522-
This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](https://docs.mx.com/api-reference/platform-api/reference/list-account-numbers-by-member/), [List account numbers by account](https://docs.mx.com/api-reference/platform-api/reference/list-account-numbers-by-account/), or the [Fetch Account and Routing Numbers](https://docs.mx.com/products/connectivity/instant-account-verification/fetch-account-routing-number-api/#4-read-the-account-numbers) guide. :::
522+
This endpoint returns a list of all the accounts associated with the specified `user`. :::warning This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to [List account numbers by member](/api-reference/platform-api/reference/list-account-numbers-by-member/) or [List account numbers by account](/api-reference/platform-api/reference/list-account-numbers-by-account/). :::
523523

524524
### Example
525525

docs/InstitutionResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
**code** | **str** | | [optional]
88
**forgot_password_url** | **str** | | [optional]
99
**forgot_username_url** | **str** | | [optional]
10-
**instructional_text** | **str** | | [optional]
10+
**instructional_text** | **str** | Render this text when end users are asked for their credentials, as it helps end users provide the correct credentials when creating a new member. May contain `<a></a>` tags to link to explanatory material. | [optional]
1111
**instructional_text_steps** | **List[str]** | An array of instructional steps that may contain html elements. | [optional]
1212
**is_disabled_by_client** | **bool** | | [optional]
1313
**iso_country_code** | **str** | | [optional]

docs/InstitutionsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ with mx_platform_python.ApiClient(configuration) as api_client:
5151
api_instance = mx_platform_python.InstitutionsApi(api_client)
5252
iso_country_code = ['[\"US\",\"CA\"]'] # List[str] | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). (optional)
5353
page = 1 # int | Results are paginated. Specify current page. (optional)
54-
records_per_page = 10 # int | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead. (optional)
54+
records_per_page = 10 # int | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead. (optional)
5555

5656
try:
5757
# List favorite institutions
@@ -70,7 +70,7 @@ Name | Type | Description | Notes
7070
------------- | ------------- | ------------- | -------------
7171
**iso_country_code** | [**List[str]**](str.md)| An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). | [optional]
7272
**page** | **int**| Results are paginated. Specify current page. | [optional]
73-
**records_per_page** | **int**| This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead. | [optional]
73+
**records_per_page** | **int**| This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead. | [optional]
7474

7575
### Return type
7676

@@ -216,7 +216,7 @@ with mx_platform_python.ApiClient(configuration) as api_client:
216216
name = 'mxbank' # str | This will list only institutions in which the appended string appears. (optional)
217217
iso_country_code = ['[\"US\",\"CA\"]'] # List[str] | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). (optional)
218218
page = 1 # int | Results are paginated. Specify current page. (optional)
219-
records_per_page = 10 # int | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead. (optional)
219+
records_per_page = 10 # int | This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead. (optional)
220220
supports_account_identification = true # bool | Filter only institutions which support account identification. (optional)
221221
supports_account_statement = true # bool | Filter only institutions which support account statements. (optional)
222222
supports_account_verification = true # bool | Filter only institutions which support account verification. (optional)
@@ -240,7 +240,7 @@ Name | Type | Description | Notes
240240
**name** | **str**| This will list only institutions in which the appended string appears. | [optional]
241241
**iso_country_code** | [**List[str]**](str.md)| An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico). | [optional]
242242
**page** | **int**| Results are paginated. Specify current page. | [optional]
243-
**records_per_page** | **int**| This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead. | [optional]
243+
**records_per_page** | **int**| This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead. | [optional]
244244
**supports_account_identification** | **bool**| Filter only institutions which support account identification. | [optional]
245245
**supports_account_statement** | **bool**| Filter only institutions which support account statements. | [optional]
246246
**supports_account_verification** | **bool**| Filter only institutions which support account verification. | [optional]

docs/MicrodepositsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ Name | Type | Description | Notes
331331
332332
Read a microdeposit for a user
333333

334-
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br /><br /> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
334+
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.
335335

336336
### Example
337337

docs/TransactionsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -689,7 +689,7 @@ Name | Type | Description | Notes
689689
690690
List transactions by account
691691

692-
Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
692+
Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
693693

694694
### Example
695695

@@ -1009,7 +1009,7 @@ Name | Type | Description | Notes
10091009
10101010
Read transaction
10111011

1012-
Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
1012+
Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
10131013

10141014
### Example
10151015

@@ -1091,7 +1091,7 @@ Name | Type | Description | Notes
10911091
10921092
List Repeating Transactions
10931093

1094-
Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx).
1094+
Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions).
10951095

10961096
### Example
10971097

@@ -1169,7 +1169,7 @@ Name | Type | Description | Notes
11691169
11701170
Get a Repeating Transaction
11711171

1172-
Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)
1172+
Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)
11731173

11741174
### Example
11751175

docs/UsersApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Name | Type | Description | Notes
9595
9696
Delete user
9797

98-
Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](https://docs.mx.com/api-reference/platform-api/overview/deleting-objects). :::
98+
Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object. :::warning Deleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects). :::
9999

100100
### Example
101101

docs/WidgetRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
**current_institution_guid** | **str** | Only use this option if the &#x60;widget_type&#x60; is set to &#x60;connect_widget&#x60;. Load the widget into the credential view for the specified institution. | [optional]
1212
**current_member_guid** | **str** | Only use this option if the &#x60;widget_type&#x60; is set to &#x60;connect_widget&#x60;. 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&#39;s current state. &#x60;current_member_guid&#x60; takes precedence over &#x60;current_institution_code&#x60; and &#x60;current_institution_guid&#x60;. | [optional]
1313
**disable_background_agg** | **bool** | Only use this option if the &#x60;widget_type&#x60; is set to &#x60;connect_widget&#x60;. This determines whether background aggregation is enabled or disabled for the member created by the Connect Widget. Defaults to &#x60;false&#x60; in &#x60;aggregation&#x60; mode and &#x60;true&#x60; in &#x60;verification&#x60; mode. A global default for all members can be set by reaching out to MX. | [optional]
14-
**disable_institution_search** | **bool** | Only use this option if the &#x60;widget_type&#x60; is set to &#x60;connect_widget&#x60;. This determines whether the institution search is displayed within the Connect Widget. This option must be used with &#x60;current_institution_code&#x60;, &#x60;current_instituion_guid&#x60;, or &#x60;current_member_guid&#x60;. When set to &#x60;true&#x60;, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to &#x60;false&#x60;. | [optional]
14+
**disable_institution_search** | **bool** | Only use this option if the &#x60;widget_type&#x60; is set to &#x60;connect_widget&#x60;. This determines whether the institution search is displayed within the Connect Widget. This option must be used with &#x60;current_institution_code&#x60;, &#x60;current_instituion_guid&#x60;, or &#x60;current_member_guid&#x60;. When set to &#x60;true&#x60;, the institution search feature will be disabled and end users will not be able to navigate to it. Defaults to &#x60;false&#x60;. If you set &#x60;disable_institution_search&#x60; to &#x60;true&#x60;, you must also listen for the [backToSearch event](/connect/guides/handling-events/#back-to-search) to intercept the user from navigating back to search during the flow. Don&#39;t listen for any Primary Action postMessages when you disable search. All buttons that will take a user to the search institution page are still displayed in the Connect Widget experience and your user can still select them. This may trigger during several steps in the Connect Widget flow, such as Connected, MDV/Microdeposits Verified, Login Error, and Credentials/OAuth (back button). | [optional]
1515
**enable_app2app** | **bool** | Only use this option if the &#x60;widget_type&#x60; is set to &#x60;connect_widget&#x60;. This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to &#x60;true&#x60;. When set to &#x60;false&#x60;, the widget 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]
1616
**include_identity** | **bool** | Only use this option if the &#x60;widget_type&#x60; is set to &#x60;connect_widget&#x60;. This determines whether an account owner identification (AOI, previously called identity verification) is run in addition to the process specified by the &#x60;mode&#x60;. Defaults to &#x60;false&#x60;. This can be set in either &#x60;aggregation&#x60; or &#x60;verification&#x60; mode. The AOI runs after the primary process is complete. | [optional]
1717
**include_transactions** | **bool** | Only use this option if the &#x60;widget_type&#x60; is set to &#x60;connect_widget&#x60;. This determines whether transaction data are retrieved. Defaults to &#x60;true&#x60; in aggregation mode and &#x60;false&#x60; in verification mode. This can be set in either &#x60;aggregation&#x60; or &#x60;verification&#x60; mode. This option does not affect future foreground or background aggregations. | [optional]

mx_platform_python/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
""" # noqa: E501
1515

1616

17-
__version__ = "1.11.0"
17+
__version__ = "1.12.0"
1818

1919
# import apis into sdk package
2020
from mx_platform_python.api.accounts_api import AccountsApi

0 commit comments

Comments
 (0)