OpenAPI generated code at 2025-08-13T19:28:36Z

.openapi-generator/FILES

@@ -1,3 +1,6 @@
+docs/AAMVAAnalysis.md
+docs/AAMVADetailedMatchResult.md
+docs/AAMVAMatchResult.md
 docs/ACHClass.md
 docs/APR.md
 docs/AccountAccess.md
@@ -46,6 +49,9 @@ docs/Asset.md
 docs/AssetDetail.md
 docs/AssetHolder.md
 docs/AssetHolderName.md
+docs/AssetHolding.md
+docs/AssetHoldings.md
+docs/AssetInvestmentTransactionType.md
 docs/AssetOwner.md
 docs/AssetOwners.md
 docs/AssetReport.md
@@ -101,6 +107,10 @@ docs/AuthGetResponse.md
 docs/AuthMetadata.md
 docs/AuthSupportedMethods.md
 docs/AuthUpdateTypes.md
+docs/AuthVerifyNumbersACH.md
+docs/AuthVerifyRequest.md
+docs/AuthVerifyRequestNumbers.md
+docs/AuthVerifyResponse.md
 docs/AutomaticallyVerifiedWebhook.md
 docs/BankIncomeCompleteResult.md
 docs/BankIncomeCompleteWebhook.md
@@ -269,6 +279,7 @@ docs/Cause.md
 docs/CauseAllOf.md
 docs/CheckReportWarning.md
 docs/CheckReportWarningCode.md
+docs/ClientCustomization.md
 docs/ClientProvidedEnhancedTransaction.md
 docs/ClientProvidedEnrichedTransaction.md
 docs/ClientProvidedRawTransaction.md
@@ -840,6 +851,7 @@ docs/KYCCheckPhoneSummary.md
 docs/LastDataAccessTimes.md
 docs/LatestScoredEvent.md
 docs/LayerAuthenticationPassedWebhook.md
+docs/LedgerEventSourceType.md
 docs/LiabilitiesDefaultUpdateWebhook.md
 docs/LiabilitiesGetRequest.md
 docs/LiabilitiesGetRequestOptions.md
@@ -1450,8 +1462,6 @@ docs/SweepStatus.md
 docs/SweepTrigger.md
 docs/SyncUpdatesAvailableWebhook.md
 docs/SyntheticFraud.md
-docs/TCHNotification.md
-docs/TCHNotificationResponse.md
 docs/Taxform.md
 docs/TaxpayerID.md
 docs/TaxpayerIdentifier.md
@@ -1598,6 +1608,9 @@ docs/TransferLedgerDepositRequest.md
 docs/TransferLedgerDepositResponse.md
 docs/TransferLedgerDistributeRequest.md
 docs/TransferLedgerDistributeResponse.md
+docs/TransferLedgerEvent.md
+docs/TransferLedgerEventListRequest.md
+docs/TransferLedgerEventListResponse.md
 docs/TransferLedgerGetRequest.md
 docs/TransferLedgerGetResponse.md
 docs/TransferLedgerSweepSimulateEventType.md
@@ -1705,6 +1718,8 @@ docs/UserFinancialDataRefreshResponse.md
 docs/UserIDNumber.md
 docs/UserItemsGetRequest.md
 docs/UserItemsGetResponse.md
+docs/UserItemsListRequest.md
+docs/UserItemsListResponse.md
 docs/UserPermissionRevokedWebhook.md
 docs/UserRemoveRequest.md
 docs/UserRemoveResponse.md
@@ -1833,6 +1848,9 @@ lib/plaid/api/plaid_api.rb
 lib/plaid/api_client.rb
 lib/plaid/api_error.rb
 lib/plaid/configuration.rb
+lib/plaid/models/aamva_analysis.rb
+lib/plaid/models/aamva_detailed_match_result.rb
+lib/plaid/models/aamva_match_result.rb
 lib/plaid/models/account_access.rb
 lib/plaid/models/account_assets.rb
 lib/plaid/models/account_balance.rb
@@ -1881,6 +1899,9 @@ lib/plaid/models/asset.rb
 lib/plaid/models/asset_detail.rb
 lib/plaid/models/asset_holder.rb
 lib/plaid/models/asset_holder_name.rb
+lib/plaid/models/asset_holding.rb
+lib/plaid/models/asset_holdings.rb
+lib/plaid/models/asset_investment_transaction_type.rb
 lib/plaid/models/asset_owner.rb
 lib/plaid/models/asset_owners.rb
 lib/plaid/models/asset_report.rb
@@ -1936,6 +1957,10 @@ lib/plaid/models/auth_get_response.rb
 lib/plaid/models/auth_metadata.rb
 lib/plaid/models/auth_supported_methods.rb
 lib/plaid/models/auth_update_types.rb
+lib/plaid/models/auth_verify_numbers_ach.rb
+lib/plaid/models/auth_verify_request.rb
+lib/plaid/models/auth_verify_request_numbers.rb
+lib/plaid/models/auth_verify_response.rb
 lib/plaid/models/automatically_verified_webhook.rb
 lib/plaid/models/bank_income_complete_result.rb
 lib/plaid/models/bank_income_complete_webhook.rb
@@ -2103,6 +2128,7 @@ lib/plaid/models/cause.rb
 lib/plaid/models/cause_all_of.rb
 lib/plaid/models/check_report_warning.rb
 lib/plaid/models/check_report_warning_code.rb
+lib/plaid/models/client_customization.rb
 lib/plaid/models/client_provided_enhanced_transaction.rb
 lib/plaid/models/client_provided_enriched_transaction.rb
 lib/plaid/models/client_provided_raw_transaction.rb
@@ -2675,6 +2701,7 @@ lib/plaid/models/kyc_check_phone_summary.rb
 lib/plaid/models/last_data_access_times.rb
 lib/plaid/models/latest_scored_event.rb
 lib/plaid/models/layer_authentication_passed_webhook.rb
+lib/plaid/models/ledger_event_source_type.rb
 lib/plaid/models/liabilities_default_update_webhook.rb
 lib/plaid/models/liabilities_get_request.rb
 lib/plaid/models/liabilities_get_request_options.rb
@@ -3289,8 +3316,6 @@ lib/plaid/models/taxpayer_id.rb
 lib/plaid/models/taxpayer_identifier.rb
 lib/plaid/models/taxpayer_identifier_type.rb
 lib/plaid/models/taxpayer_identifiers.rb
-lib/plaid/models/tch_notification.rb
-lib/plaid/models/tch_notification_response.rb
 lib/plaid/models/total.rb
 lib/plaid/models/total_canonical_description.rb
 lib/plaid/models/total_inflow_amount.rb
@@ -3432,6 +3457,9 @@ lib/plaid/models/transfer_ledger_deposit_request.rb
 lib/plaid/models/transfer_ledger_deposit_response.rb
 lib/plaid/models/transfer_ledger_distribute_request.rb
 lib/plaid/models/transfer_ledger_distribute_response.rb
+lib/plaid/models/transfer_ledger_event.rb
+lib/plaid/models/transfer_ledger_event_list_request.rb
+lib/plaid/models/transfer_ledger_event_list_response.rb
 lib/plaid/models/transfer_ledger_get_request.rb
 lib/plaid/models/transfer_ledger_get_response.rb
 lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb
@@ -3539,6 +3567,8 @@ lib/plaid/models/user_financial_data_refresh_response.rb
 lib/plaid/models/user_id_number.rb
 lib/plaid/models/user_items_get_request.rb
 lib/plaid/models/user_items_get_response.rb
+lib/plaid/models/user_items_list_request.rb
+lib/plaid/models/user_items_list_response.rb
 lib/plaid/models/user_permission_revoked_webhook.rb
 lib/plaid/models/user_remove_request.rb
 lib/plaid/models/user_remove_response.rb

CHANGELOG.md

@@ -1,8 +1,65 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 43.0.0
+- Updating to OAS 2020-09-14_1.658.0
+
+## Breaking changes in this version
+
+- [BREAKING] To improve consistency and resolve a bug in a third-party client library, changed `MonitoringConsumerReportPermissiblePurpose` schema object title from `ConsumerReportPermissiblePurpose` to `MonitoringConsumerReportPermissiblePurpose`. This may be a breaking change for certain client libraries.
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.658.0
+- (beta) Add `user_id` field to `/session/token/create` request.
+- [BREAKING for Go] (beta) Make `user` object optional in `/session/token/create` if `user_id` is included.
+
+### 2020-09-14_1.657.0
+Add Add `subtype` property to the `Security` model.
+
+### 2020-09-14_1.656.1
+- Renamed `protect_sdk_session_id` field in the request of `/protect/event/send` to `protect_session_id` for consistency across endpoints.
+
+### 2020-09-14_1.656.0
+- Added `aamva_verification` object in the responses of `documentary_verification.documents[].analysis`. This impacts the following endpoints: 
+    - `identity_verification/create`
+    - `identity_verification/get`
+    - `identity_verification/list`
+    - `identity_verification/retry`
+
+### 2020-09-14_1.655.0
+- Add `max_amount` and `iso_currency_code` to `rfp` in `/transfer/capabilitied/get` response
+
+### 2020-09-14_1.654.0
+- [BREAKING] To improve consistency and resolve a bug in a third-party client library, changed `MonitoringConsumerReportPermissiblePurpose` schema object title from `ConsumerReportPermissiblePurpose` to `MonitoringConsumerReportPermissiblePurpose`. This may be a breaking change for certain client libraries.
+
+### 2020-09-14_1.653.0
+- (beta) Add optional `user_id` field to `identity_verification/create` and `identity_verification/list` requests. When `user_id` is present during creation and `client_user_id` is not, the `client_user_id` from the associated user will be set on the created identity verification. If `user_id` is present during creation, the `user` object may not also be present. Modifying user data should be done via the `user/update` endpoint.
+- [BREAKING for Go] (beta) Make `client_user_id` optional in `identity_verification/list` if `user_id` is included.
+- (beta) Add nullable `user_id` to the response of all of the identity verification endpoints:
+   - `identity_verification/create`
+   - `identity_verification/get`
+   - `identity_verification/list`
+   - `identity_verification/retry`
+
+### 2020-09-14_1.652.3
+- Added support for `cra_monitoring` to `Products` array.
+
+### 2020-09-14_1.652.2
+- (beta) Add `/user/items/list` endpoint
+
+### 2020-09-14_1.652.1
+- Add `/transfer/ledger/event/list` endpoint
+
 # 42.0.0
 - Updating to OAS 2020-09-14_1.652.0
 
+## Breaking changes in this version
+
+- [Breaking] Replacing `voe` references to instead be `employment_refresh` in `/cra/check_report/verification/get` and `/cra/check_report/create`
+  - `/cra/check_report/verification/get`'s `reports_requested` options are now `VOA` and `employment_refresh`
+  - `voe_options` in the request is now `employment_refresh_options`
+  - `/cra/check_report/verification/get`'s response now has `report.employment_refresh` instead of `report.voe`
+  - `gse_options.report_type` in `/cra/check_report/create` are now `VOA` and `employment_refresh` 
+
 ## OpenAPI Schema Changes
 ### 2020-09-14_1.652.0
 - Add optional `cursor` and `count` fields to the `/payment_initiation/recipient/list` request and `next_cursor` to its response
@@ -62,6 +119,12 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
 # 41.0.0
 - Updating to OAS 2020-09-14_1.645.0
 
+## Breaking changes in this version
+
+- [Breaking] For Signal, remove enum values `REAL_TIME_PAYMENTS` and `DEBIT_CARD` as these payment methods are not supported by the Signal product.
+- [Breaking] Rename client library `/cra/check_report/create`'s `partner_insights` object to type `CraCheckReportCreatePartnerInsightsOptions` instead of `CraCheckReportPartnerInsightsGetOptions`. All the object fields are identical.
+- [Breaking] Rename client library `/cra/check_report/partner_insights/get`'s `option.prism_versions` object to type `PrismVersionsDeprecated` instead of `PrismVersions`. All the object fields' are identical.
+
 ## OpenAPI Schema Changes
 ### 2020-09-14_1.645.0
 - Removes the `payment_details` field from `/accounts/balance/get` request
@@ -142,8 +205,8 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
 - Add missing `unsent` value as a possible `verification_status` to reflect actual API behavior.
 
 ### 2020-09-14_1.637.3
-- (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/create`
-- (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/remove`
+- (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/create`. This header is only for the use of customers in the new user API beta; customers should *not* use this parameter unless they have been advised to do so by Plaid. 
+- (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/remove`. This header is only for the use of customers in the new user API beta; customers should *not* use this parameter unless they have been advised to do so by Plaid. 
 
 ### 2020-09-14_1.637.2
 - (beta) Add `user_id` to `/session/token/create` response

Dockerfile

@@ -1,4 +1,5 @@
 # Note: This image is also built in CircleCI, so limit references to internal repositories.
+# Keep this in sync with the image in plaid-ruby-release Jenkinsfile
 FROM ruby:3.2.0
 
 # Create app directory

Makefile

@@ -1,5 +1,5 @@
 # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
-RUBY_PACKAGE_VERSION=42.0.0
+RUBY_PACKAGE_VERSION=43.0.0
 
 .PHONY: release
 release:

lib/plaid.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.652.0
+The version of the OpenAPI document: 2020-09-14_1.658.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -17,6 +17,9 @@
 require 'plaid/configuration'
 
 # Models
+Plaid.autoload :AAMVAAnalysis, 'plaid/models/aamva_analysis'
+Plaid.autoload :AAMVADetailedMatchResult, 'plaid/models/aamva_detailed_match_result'
+Plaid.autoload :AAMVAMatchResult, 'plaid/models/aamva_match_result'
 Plaid.autoload :ACHClass, 'plaid/models/ach_class'
 Plaid.autoload :APR, 'plaid/models/apr'
 Plaid.autoload :AccountAccess, 'plaid/models/account_access'
@@ -65,6 +68,9 @@
 Plaid.autoload :AssetDetail, 'plaid/models/asset_detail'
 Plaid.autoload :AssetHolder, 'plaid/models/asset_holder'
 Plaid.autoload :AssetHolderName, 'plaid/models/asset_holder_name'
+Plaid.autoload :AssetHolding, 'plaid/models/asset_holding'
+Plaid.autoload :AssetHoldings, 'plaid/models/asset_holdings'
+Plaid.autoload :AssetInvestmentTransactionType, 'plaid/models/asset_investment_transaction_type'
 Plaid.autoload :AssetOwner, 'plaid/models/asset_owner'
 Plaid.autoload :AssetOwners, 'plaid/models/asset_owners'
 Plaid.autoload :AssetReport, 'plaid/models/asset_report'
@@ -120,6 +126,10 @@
 Plaid.autoload :AuthMetadata, 'plaid/models/auth_metadata'
 Plaid.autoload :AuthSupportedMethods, 'plaid/models/auth_supported_methods'
 Plaid.autoload :AuthUpdateTypes, 'plaid/models/auth_update_types'
+Plaid.autoload :AuthVerifyNumbersACH, 'plaid/models/auth_verify_numbers_ach'
+Plaid.autoload :AuthVerifyRequest, 'plaid/models/auth_verify_request'
+Plaid.autoload :AuthVerifyRequestNumbers, 'plaid/models/auth_verify_request_numbers'
+Plaid.autoload :AuthVerifyResponse, 'plaid/models/auth_verify_response'
 Plaid.autoload :AutomaticallyVerifiedWebhook, 'plaid/models/automatically_verified_webhook'
 Plaid.autoload :BankIncomeCompleteResult, 'plaid/models/bank_income_complete_result'
 Plaid.autoload :BankIncomeCompleteWebhook, 'plaid/models/bank_income_complete_webhook'
@@ -288,6 +298,7 @@
 Plaid.autoload :CauseAllOf, 'plaid/models/cause_all_of'
 Plaid.autoload :CheckReportWarning, 'plaid/models/check_report_warning'
 Plaid.autoload :CheckReportWarningCode, 'plaid/models/check_report_warning_code'
+Plaid.autoload :ClientCustomization, 'plaid/models/client_customization'
 Plaid.autoload :ClientProvidedEnhancedTransaction, 'plaid/models/client_provided_enhanced_transaction'
 Plaid.autoload :ClientProvidedEnrichedTransaction, 'plaid/models/client_provided_enriched_transaction'
 Plaid.autoload :ClientProvidedRawTransaction, 'plaid/models/client_provided_raw_transaction'
@@ -859,6 +870,7 @@
 Plaid.autoload :LastDataAccessTimes, 'plaid/models/last_data_access_times'
 Plaid.autoload :LatestScoredEvent, 'plaid/models/latest_scored_event'
 Plaid.autoload :LayerAuthenticationPassedWebhook, 'plaid/models/layer_authentication_passed_webhook'
+Plaid.autoload :LedgerEventSourceType, 'plaid/models/ledger_event_source_type'
 Plaid.autoload :LiabilitiesDefaultUpdateWebhook, 'plaid/models/liabilities_default_update_webhook'
 Plaid.autoload :LiabilitiesGetRequest, 'plaid/models/liabilities_get_request'
 Plaid.autoload :LiabilitiesGetRequestOptions, 'plaid/models/liabilities_get_request_options'
@@ -1468,8 +1480,6 @@
 Plaid.autoload :SweepTrigger, 'plaid/models/sweep_trigger'
 Plaid.autoload :SyncUpdatesAvailableWebhook, 'plaid/models/sync_updates_available_webhook'
 Plaid.autoload :SyntheticFraud, 'plaid/models/synthetic_fraud'
-Plaid.autoload :TCHNotification, 'plaid/models/tch_notification'
-Plaid.autoload :TCHNotificationResponse, 'plaid/models/tch_notification_response'
 Plaid.autoload :Taxform, 'plaid/models/taxform'
 Plaid.autoload :TaxpayerID, 'plaid/models/taxpayer_id'
 Plaid.autoload :TaxpayerIdentifier, 'plaid/models/taxpayer_identifier'
@@ -1616,6 +1626,9 @@
 Plaid.autoload :TransferLedgerDepositResponse, 'plaid/models/transfer_ledger_deposit_response'
 Plaid.autoload :TransferLedgerDistributeRequest, 'plaid/models/transfer_ledger_distribute_request'
 Plaid.autoload :TransferLedgerDistributeResponse, 'plaid/models/transfer_ledger_distribute_response'
+Plaid.autoload :TransferLedgerEvent, 'plaid/models/transfer_ledger_event'
+Plaid.autoload :TransferLedgerEventListRequest, 'plaid/models/transfer_ledger_event_list_request'
+Plaid.autoload :TransferLedgerEventListResponse, 'plaid/models/transfer_ledger_event_list_response'
 Plaid.autoload :TransferLedgerGetRequest, 'plaid/models/transfer_ledger_get_request'
 Plaid.autoload :TransferLedgerGetResponse, 'plaid/models/transfer_ledger_get_response'
 Plaid.autoload :TransferLedgerSweepSimulateEventType, 'plaid/models/transfer_ledger_sweep_simulate_event_type'
@@ -1723,6 +1736,8 @@
 Plaid.autoload :UserIDNumber, 'plaid/models/user_id_number'
 Plaid.autoload :UserItemsGetRequest, 'plaid/models/user_items_get_request'
 Plaid.autoload :UserItemsGetResponse, 'plaid/models/user_items_get_response'
+Plaid.autoload :UserItemsListRequest, 'plaid/models/user_items_list_request'
+Plaid.autoload :UserItemsListResponse, 'plaid/models/user_items_list_response'
 Plaid.autoload :UserPermissionRevokedWebhook, 'plaid/models/user_permission_revoked_webhook'
 Plaid.autoload :UserRemoveRequest, 'plaid/models/user_remove_request'
 Plaid.autoload :UserRemoveResponse, 'plaid/models/user_remove_response'