Skip to content

Commit 1adfcf3

Browse files
author
devexperience
committed
Generated version 1.13.0
This commit was automatically created by a GitHub Action to generate version 1.13.0 of this library.
1 parent 9d06eb5 commit 1adfcf3

23 files changed

+57
-57
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ mvn clean package
2424
```
2525

2626
Then manually install the following JARs:
27-
- `target/mx-platform-java-1.12.0.jar`
27+
- `target/mx-platform-java-1.13.0.jar`
2828
- `target/lib/*.jar`
2929

3030
### Maven users
@@ -35,7 +35,7 @@ Add this dependency to your project's POM:
3535
<dependency>
3636
<groupId>com.mx</groupId>
3737
<artifactId>mx-platform-java</artifactId>
38-
<version>1.12.0</version>
38+
<version>1.13.0</version>
3939
<scope>compile</scope>
4040
</dependency>
4141
```

docs/AccountsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ public class Example {
461461
462462
List accounts
463463

464-
This endpoint returns a list of all the accounts associated with the specified &#x60;user&#x60;. :::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. :::
464+
This endpoint returns a list of all the accounts associated with the specified &#x60;user&#x60;. :::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/). :::
465465

466466
### Example
467467
```java

docs/InstitutionResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
|**code** | **String** | | [optional] |
1111
|**forgotPasswordUrl** | **String** | | [optional] |
1212
|**forgotUsernameUrl** | **String** | | [optional] |
13-
|**instructionalText** | **String** | | [optional] |
13+
|**instructionalText** | **String** | 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 &#x60;&lt;a&gt;&lt;/a&gt;&#x60; tags to link to explanatory material. | [optional] |
1414
|**instructionalTextSteps** | **List&lt;String&gt;** | An array of instructional steps that may contain html elements. | [optional] |
1515
|**isDisabledByClient** | **Boolean** | | [optional] |
1616
|**isoCountryCode** | **String** | | [optional] |

docs/InstitutionsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public class Example {
4141
InstitutionsApi apiInstance = new InstitutionsApi(defaultClient);
4242
List<String> isoCountryCode = Arrays.asList(); // List<String> | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
4343
Integer page = 1; // Integer | Results are paginated. Specify current page.
44-
Integer recordsPerPage = 10; // Integer | 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.
44+
Integer recordsPerPage = 10; // Integer | 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.
4545
try {
4646
InstitutionsResponseBody result = apiInstance.listFavoriteInstitutions(isoCountryCode, page, recordsPerPage);
4747
System.out.println(result);
@@ -62,7 +62,7 @@ public class Example {
6262
|------------- | ------------- | ------------- | -------------|
6363
| **isoCountryCode** | [**List&lt;String&gt;**](String.md)| An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include &#x60;US&#x60;, &#x60;CA&#x60;, and &#x60;MX&#x60; (Mexico). | [optional] |
6464
| **page** | **Integer**| Results are paginated. Specify current page. | [optional] |
65-
| **recordsPerPage** | **Integer**| This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
65+
| **recordsPerPage** | **Integer**| This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
6666

6767
### Return type
6868

@@ -186,7 +186,7 @@ public class Example {
186186
String name = "mxbank"; // String | This will list only institutions in which the appended string appears.
187187
List<String> isoCountryCode = Arrays.asList(); // List<String> | An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
188188
Integer page = 1; // Integer | Results are paginated. Specify current page.
189-
Integer recordsPerPage = 10; // Integer | 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.
189+
Integer recordsPerPage = 10; // Integer | 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.
190190
Boolean supportsAccountIdentification = true; // Boolean | Filter only institutions which support account identification.
191191
Boolean supportsAccountStatement = true; // Boolean | Filter only institutions which support account statements.
192192
Boolean supportsAccountVerification = true; // Boolean | Filter only institutions which support account verification.
@@ -212,7 +212,7 @@ public class Example {
212212
| **name** | **String**| This will list only institutions in which the appended string appears. | [optional] |
213213
| **isoCountryCode** | [**List&lt;String&gt;**](String.md)| An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include &#x60;US&#x60;, &#x60;CA&#x60;, and &#x60;MX&#x60; (Mexico). | [optional] |
214214
| **page** | **Integer**| Results are paginated. Specify current page. | [optional] |
215-
| **recordsPerPage** | **Integer**| This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
215+
| **recordsPerPage** | **Integer**| This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead. | [optional] |
216216
| **supportsAccountIdentification** | **Boolean**| Filter only institutions which support account identification. | [optional] |
217217
| **supportsAccountStatement** | **Boolean**| Filter only institutions which support account statements. | [optional] |
218218
| **supportsAccountVerification** | **Boolean**| 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
@@ -293,7 +293,7 @@ public class Example {
293293
294294
Read a microdeposit for a user
295295

296-
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. &lt;br /&gt;&lt;br /&gt; 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.
296+
Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. &lt;br&gt;&lt;/br&gt; 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.
297297

298298
### Example
299299
```java

docs/TransactionsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@ public class Example {
613613
614614
List transactions by account
615615

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

618618
### Example
619619
```java
@@ -903,7 +903,7 @@ public class Example {
903903
904904
Read transaction
905905

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

908908
### Example
909909
```java
@@ -975,7 +975,7 @@ public class Example {
975975
976976
List Repeating Transactions
977977

978-
Retrieve a list of all recurring transactions for a user. &lt;br /&gt;&lt;br /&gt;For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx).
978+
Retrieve a list of all recurring transactions for a user. &lt;br /&gt;&lt;br /&gt;For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions).
979979

980980
### Example
981981
```java
@@ -1043,7 +1043,7 @@ public class Example {
10431043
10441044
Get a Repeating Transaction
10451045

1046-
Get a Specific Repeating Transaction. &lt;br /&gt;&lt;br /&gt;List For more see the [Repeating Transactions guide](repeating-transactions-overview.mdx)
1046+
Get a Specific Repeating Transaction. &lt;br /&gt;&lt;br /&gt;List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)
10471047

10481048
### Example
10491049
```java

docs/UsersApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public class Example {
8585
8686
Delete user
8787

88-
Use this endpoint to delete the specified &#x60;user&#x60;. The response will have a status of &#x60;204 No Content&#x60; 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). :::
88+
Use this endpoint to delete the specified &#x60;user&#x60;. The response will have a status of &#x60;204 No Content&#x60; 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). :::
8989

9090
### Example
9191
```java

docs/WidgetRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
|**currentInstitutionGuid** | **String** | 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] |
1515
|**currentMemberGuid** | **String** | 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] |
1616
|**disableBackgroundAgg** | **Boolean** | 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] |
17-
|**disableInstitutionSearch** | **Boolean** | 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] |
17+
|**disableInstitutionSearch** | **Boolean** | 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] |
1818
|**enableApp2app** | **Boolean** | 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] |
1919
|**includeIdentity** | **Boolean** | 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] |
2020
|**includeTransactions** | **Boolean** | 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] |

openapi/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ apiPackage: com.mx.client.mx-platform-api
33
artifactDescription: A Java library for the MX Platform API
44
artifactId: mx-platform-java
55
artifactUrl: https://github.com/mxenabled/mx-platform-java
6-
artifactVersion: 1.12.0
6+
artifactVersion: 1.13.0
77
developerEmail: devexperience@mx.com
88
developerName: MX
99
developerOrganization: MX Technologies Inc.

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<artifactId>mx-platform-java</artifactId>
66
<packaging>jar</packaging>
77
<name>mx-platform-java</name>
8-
<version>1.12.0</version>
8+
<version>1.13.0</version>
99
<url>https://github.com/mxenabled/mx-platform-java</url>
1010
<description>A Java library for the MX Platform API</description>
1111
<scm>

0 commit comments

Comments
 (0)