OpenAPI generated code at 2025-02-07T19:08:21Z

CHANGELOG.md

@@ -1,5 +1,42 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 30.0.0
+- Updating to OAS 2020-09-14_1.617.1
+
+## Breaking changes in this version
+- [Breaking] Removed the deprecated longest_gap_between_transactions, average_inflow_amount, and average_outflow_amount fields from the BaseReportAccountInsights object in the /cra/check_report/base_report/get response.
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.617.1
+- For Plaid Check: `date_of_birth` is now required within the `consumer_report_user_identity` object when creating or updating a user token.
+
+### 2020-09-14_1.617.0
+- [Breaking] Removed the deprecated longest_gap_between_transactions, average_inflow_amount, and average_outflow_amount fields from the BaseReportAccountInsights object in the /cra/check_report/base_report/get response.
+
+### 2020-09-14_1.616.0
+- Add `originating_fund_source` to `/wallet/transaction/execute` endpoint.
+
+### 2020-09-14_1.615.0
+- Add `account_details_401k` objects to `/investments/auth/get` endpoint.
+
+### 2020-09-14_1.614.1
+- Update `owners` field description for empty case
+
+### 2020-09-14_1.614.0
+- Add model for the new `retirement_401k` numbers object to the `InvestmentsAuthGetNumbers` schema.
+
+### 2020-09-14_1.613.0
+- Add `POST /signal/schedule` endpoint
+
+### 2025-01-27_1.611.0
+- Add `end_to_end_id` to `/payment_initiation/payment/get`
+
+### 2020-09-14_1.611.0
+- Add RfP to /transfer/capabilities/get
+
+### 2020-09-14_1.610.2
+- Update `cashflow_updates` docs to reflect proper cadence
+
 # 29.1.0
 - Updating to OAS 2020-09-14_1.610.1
 - Update versions of okhttp, retrofit2, and gson-fire in pom.xml to address vulnerabilities.
@@ -64,7 +101,7 @@ endpoints.
 ### 2020-09-14_1.600.2
 - Update descriptions for `/network/status/get` request and response fields
 - Add `nullable: true` to mortgage `account_number` field in the `MortgageLiability` schema to reflect actual behavior.
-- Add `transactions_refresh` to `Products` array to reflect actual behavior; this field is not accepted as input to `/link/token/create` but can be part of supported products array in the `Institution` object. 
+- Add `transactions_refresh` to `Products` array to reflect actual behavior; this field is not accepted as input to `/link/token/create` but can be part of supported products array in the `Institution` object.
 
 ### 2020-09-14_1.600.1
 - `depository`+`cash management` Accounts are now eligible for Auth data for certain institutions
@@ -354,7 +391,7 @@ endpoints.
 - add `/issues/get`, `/issues/search`, and `/issues/subscribe` for Support API endpoints.
 
 ### 2020-09-14_1.563.0
-- Update fields on `item` object in `/item/get` response 
+- Update fields on `item` object in `/item/get` response
   - Add `consented_use_cases` field
   - Add `consented_data_scopes` field
   - Add `created_at` field
@@ -534,14 +571,14 @@ endpoints.
 
 ### 2020-09-14_1.535.2
 - Make some `CraBankIncomeSummary` fields visible.
-- 
+-
 ### 2020-09-14_1.535.1
 
 ### 2020-09-14_1.535.0
 - [Breaking for Go] Updated `consumer_report_user_identity` field in `/user/update` to be required to reflect actual API behavior.
 
 ### 2020-09-14_1.534.7
-- Add `stated_account_number_enabled` to `investments_auth` in `LinkTokenCreateRequest` 
+- Add `stated_account_number_enabled` to `investments_auth` in `LinkTokenCreateRequest`
 
 ### 2020-09-14_1.534.6
 - [Breaking] Updated base report endpoints and objects to include `cra` prefix
@@ -930,7 +967,7 @@ endpoints.
 - Remove `additionalProperties: true` incorrectly applied to `transferIntentGet` object and missed in `2020-09-14_1.352.0`. This will result in more strict type checking for this object, but should not be a breaking change.
 
 ### 2020-09-14_1.498.1
-- Enable original description for all customers 
+- Enable original description for all customers
 
 ### 2020-09-14_1.498.0
 - Add `POST /beacon/account_risk/v1/evaluate` endpoint
@@ -1064,7 +1101,7 @@ endpoints.
 - Internal changes only
 
 ### 2020-09-14_1.483.0
-- Added net new fields to StatementsAccount object: `account_mask`, `account_subtype`, `account_official_name` 
+- Added net new fields to StatementsAccount object: `account_mask`, `account_subtype`, `account_official_name`
 
 # 19.2.0
 - Updating to OAS 2020-09-14_1.482.3

pom.xml

@@ -4,7 +4,7 @@
 
   <groupId>com.plaid</groupId>
   <artifactId>plaid-java</artifactId>
-  <version>29.1.0-SNAPSHOT</version>
+  <version>30.0.0-SNAPSHOT</version>
 
   <parent>
     <groupId>org.sonatype.oss</groupId>

src/main/java/com/plaid/client/ApiClient.java

@@ -49,7 +49,7 @@ public ApiClient() {
             public Response intercept(Chain chain) throws IOException {
                 Request originalRequest = chain.request();
                 Request requestWithUserAgent = originalRequest.newBuilder()
-                        .header("User-Agent", "Plaid Java v29.1.0")
+                        .header("User-Agent", "Plaid Java v30.0.0")
                         .header("Plaid-Version", "2020-09-14")
                         .build();
                 return chain.proceed(requestWithUserAgent);

src/main/java/com/plaid/client/JSON.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/main/java/com/plaid/client/StringUtil.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@
 import java.util.Collection;
 import java.util.Iterator;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class StringUtil {
   /**
    * Check if the given array contains the given value (with case-insensitive comparison).

src/main/java/com/plaid/client/model/ACHClass.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/main/java/com/plaid/client/model/APR.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,7 +28,7 @@
  * Information about the APR on the account.
  */
 @ApiModel(description = "Information about the APR on the account.")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class APR {
   public static final String SERIALIZED_NAME_APR_PERCENTAGE = "apr_percentage";
   @SerializedName(SERIALIZED_NAME_APR_PERCENTAGE)

src/main/java/com/plaid/client/model/AccountAccess.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,7 +29,7 @@
  * Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered `new_accounts`.
  */
 @ApiModel(description = "Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered `new_accounts`.")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountAccess {
   public static final String SERIALIZED_NAME_UNIQUE_ID = "unique_id";
   @SerializedName(SERIALIZED_NAME_UNIQUE_ID)

src/main/java/com/plaid/client/model/AccountAssets.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -40,7 +40,7 @@
  * Asset information about an account
  */
 @ApiModel(description = "Asset information about an account")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountAssets {
   public static final String SERIALIZED_NAME_ACCOUNT_ID = "account_id";
   @SerializedName(SERIALIZED_NAME_ACCOUNT_ID)

src/main/java/com/plaid/client/model/AccountBalance.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,7 +29,7 @@
  * A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by `/accounts/balance/get`.
  */
 @ApiModel(description = "A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by `/accounts/balance/get`.")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountBalance {
   public static final String SERIALIZED_NAME_AVAILABLE = "available";
   @SerializedName(SERIALIZED_NAME_AVAILABLE)

src/main/java/com/plaid/client/model/AccountBase.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -33,7 +33,7 @@
  * A single account at a financial institution.
  */
 @ApiModel(description = "A single account at a financial institution.")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountBase {
   public static final String SERIALIZED_NAME_ACCOUNT_ID = "account_id";
   @SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
@@ -194,11 +194,11 @@ public AccountBase mask(String mask) {
   }
 
    /**
-   * The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
+   * The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.
    * @return mask
   **/
   @javax.annotation.Nullable
-  @ApiModelProperty(required = true, value = "The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.")
+  @ApiModelProperty(required = true, value = "The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.")
 
   public String getMask() {
     return mask;

src/main/java/com/plaid/client/model/AccountFilter.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,7 +30,7 @@
  * Enumerates the account subtypes that the application wishes for the user to be able to select from. For more details refer to Plaid documentation on account filters.
  */
 @ApiModel(description = "Enumerates the account subtypes that the application wishes for the user to be able to select from. For more details refer to Plaid documentation on account filters.")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountFilter {
   public static final String SERIALIZED_NAME_DEPOSITORY = "depository";
   @SerializedName(SERIALIZED_NAME_DEPOSITORY)

src/main/java/com/plaid/client/model/AccountFiltersResponse.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,7 +32,7 @@
  * The `account_filters` specified in the original call to `/link/token/create`. 
  */
 @ApiModel(description = "The `account_filters` specified in the original call to `/link/token/create`. ")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountFiltersResponse {
   public static final String SERIALIZED_NAME_DEPOSITORY = "depository";
   @SerializedName(SERIALIZED_NAME_DEPOSITORY)

src/main/java/com/plaid/client/model/AccountHolderCategory.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/main/java/com/plaid/client/model/AccountIdentity.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,7 +38,7 @@
  * Identity information about an account
  */
 @ApiModel(description = "Identity information about an account")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountIdentity {
   public static final String SERIALIZED_NAME_ACCOUNT_ID = "account_id";
   @SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
@@ -203,11 +203,11 @@ public AccountIdentity mask(String mask) {
   }
 
    /**
-   * The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
+   * The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.
    * @return mask
   **/
   @javax.annotation.Nullable
-  @ApiModelProperty(required = true, value = "The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.")
+  @ApiModelProperty(required = true, value = "The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.")
 
   public String getMask() {
     return mask;

src/main/java/com/plaid/client/model/AccountIdentityAllOf.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,7 +30,7 @@
 /**
  * AccountIdentityAllOf
  */
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountIdentityAllOf {
   public static final String SERIALIZED_NAME_OWNERS = "owners";
   @SerializedName(SERIALIZED_NAME_OWNERS)

src/main/java/com/plaid/client/model/AccountIdentityDocumentUpload.java

@@ -2,7 +2,7 @@
  * The Plaid API
  * The Plaid REST API. Please see https://plaid.com/docs/api for more details.
  *
- * The version of the OpenAPI document: 2020-09-14_1.610.1
+ * The version of the OpenAPI document: 2020-09-14_1.617.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -39,7 +39,7 @@
  * Identity information about an account
  */
 @ApiModel(description = "Identity information about an account")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-01-23T20:55:58.809242Z[Etc/UTC]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-02-07T19:05:33.763924Z[Etc/UTC]")
 public class AccountIdentityDocumentUpload {
   public static final String SERIALIZED_NAME_ACCOUNT_ID = "account_id";
   @SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
@@ -208,11 +208,11 @@ public AccountIdentityDocumentUpload mask(String mask) {
   }
 
    /**
-   * The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.
+   * The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.
    * @return mask
   **/
   @javax.annotation.Nullable
-  @ApiModelProperty(required = true, value = "The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, and it may also not match the mask that the bank displays to the user.")
+  @ApiModelProperty(required = true, value = "The last 2-4 alphanumeric characters of either the account’s displayed mask or the account’s official account number. Note that the mask may be non-unique between an Item’s accounts.")
 
   public String getMask() {
     return mask;