OpenAPI generated code at 2025-07-21T23:23:51Z (#522)

Author: kbaig-plaid

.openapi-generator/FILES

@@ -227,6 +227,7 @@ docs/BusinessAccount.md
 docs/BusinessAccountAllOf.md
 docs/BusinessFinanceCategory.md
 docs/CRALoansRegisterRequest.md
+docs/CashFlowUpdatesEventWebhookCodes.md
 docs/CashFlowUpdatesExpectedDepositMissedWebhook.md
 docs/CashFlowUpdatesInsightsWebhook.md
 docs/CashFlowUpdatesLargeDepositWebhook.md
@@ -288,6 +289,9 @@ docs/ConsumerReportPermissiblePurpose.md
 docs/ConsumerReportUserIdentity.md
 docs/Counterparty.md
 docs/CounterpartyInsights.md
+docs/CounterpartyNumbers.md
+docs/CounterpartyNumbersBACS.md
+docs/CounterpartyNumbersInternational.md
 docs/CounterpartyType.md
 docs/CountryCode.md
 docs/CraBankIncomeAccount.md
@@ -330,10 +334,14 @@ docs/CraCheckReportPartnerInsightsGetPartnerInsights.md
 docs/CraCheckReportPartnerInsightsGetRequest.md
 docs/CraCheckReportPartnerInsightsGetResponse.md
 docs/CraCheckReportReadyWebhook.md
+docs/CraCheckReportVerificationGetEmploymentRefreshOptions.md
 docs/CraCheckReportVerificationGetReportType.md
 docs/CraCheckReportVerificationGetRequest.md
 docs/CraCheckReportVerificationGetResponse.md
-docs/CraCheckReportVerificationGetVoeOptions.md
+docs/CraEmploymentRefreshReport.md
+docs/CraEmploymentRefreshReportAccount.md
+docs/CraEmploymentRefreshReportItem.md
+docs/CraEmploymentRefreshReportTransaction.md
 docs/CraIncomeInsights.md
 docs/CraLoanApplication.md
 docs/CraLoanApplicationDecision.md
@@ -384,10 +392,6 @@ docs/CraVoaReportAccountHistoricalBalance.md
 docs/CraVoaReportAttributes.md
 docs/CraVoaReportItem.md
 docs/CraVoaReportTransactionsInsights.md
-docs/CraVoeReport.md
-docs/CraVoeReportAccount.md
-docs/CraVoeReportItem.md
-docs/CraVoeReportTransaction.md
 docs/Credit1099.md
 docs/Credit1099Filer.md
 docs/Credit1099Payer.md
@@ -953,7 +957,6 @@ docs/MonitoringIncomeSource.md
 docs/MonitoringInsights.md
 docs/MonitoringInsightsItemStatus.md
 docs/MonitoringInsightsStatus.md
-docs/MonitoringInsightsWebhook.md
 docs/MonitoringItemStatusCode.md
 docs/MonitoringLoanInsights.md
 docs/MortgageInterestRate.md
@@ -1267,6 +1270,7 @@ docs/RecurringTransactionsUpdateWebhook.md
 docs/RecurringTransfer.md
 docs/RecurringTransferNullable.md
 docs/RecurringTransferSkippedWebhook.md
+docs/RefreshResult.md
 docs/RemovedTransaction.md
 docs/ReportType.md
 docs/ReportingInformation.md
@@ -1696,6 +1700,8 @@ docs/UserCreateRequest.md
 docs/UserCreateResponse.md
 docs/UserCustomPassword.md
 docs/UserDataOverview.md
+docs/UserFinancialDataRefreshRequest.md
+docs/UserFinancialDataRefreshResponse.md
 docs/UserIDNumber.md
 docs/UserItemsGetRequest.md
 docs/UserItemsGetResponse.md
@@ -1709,6 +1715,8 @@ docs/UserThirdPartyTokenCreateRequest.md
 docs/UserThirdPartyTokenCreateResponse.md
 docs/UserThirdPartyTokenRemoveRequest.md
 docs/UserThirdPartyTokenRemoveResponse.md
+docs/UserTransactionsRefreshRequest.md
+docs/UserTransactionsRefreshResponse.md
 docs/UserUpdateRequest.md
 docs/UserUpdateResponse.md
 docs/ValidationSource.md
@@ -2053,6 +2061,7 @@ lib/plaid/models/beacon_user_update_response.rb
 lib/plaid/models/business_account.rb
 lib/plaid/models/business_account_all_of.rb
 lib/plaid/models/business_finance_category.rb
+lib/plaid/models/cash_flow_updates_event_webhook_codes.rb
 lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb
 lib/plaid/models/cash_flow_updates_insights_webhook.rb
 lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb
@@ -2114,6 +2123,9 @@ lib/plaid/models/consumer_report_permissible_purpose.rb
 lib/plaid/models/consumer_report_user_identity.rb
 lib/plaid/models/counterparty.rb
 lib/plaid/models/counterparty_insights.rb
+lib/plaid/models/counterparty_numbers.rb
+lib/plaid/models/counterparty_numbers_bacs.rb
+lib/plaid/models/counterparty_numbers_international.rb
 lib/plaid/models/counterparty_type.rb
 lib/plaid/models/country_code.rb
 lib/plaid/models/cra_bank_income_account.rb
@@ -2156,10 +2168,14 @@ lib/plaid/models/cra_check_report_partner_insights_get_request.rb
 lib/plaid/models/cra_check_report_partner_insights_get_response.rb
 lib/plaid/models/cra_check_report_pdf_get_request.rb
 lib/plaid/models/cra_check_report_ready_webhook.rb
+lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb
 lib/plaid/models/cra_check_report_verification_get_report_type.rb
 lib/plaid/models/cra_check_report_verification_get_request.rb
 lib/plaid/models/cra_check_report_verification_get_response.rb
-lib/plaid/models/cra_check_report_verification_get_voe_options.rb
+lib/plaid/models/cra_employment_refresh_report.rb
+lib/plaid/models/cra_employment_refresh_report_account.rb
+lib/plaid/models/cra_employment_refresh_report_item.rb
+lib/plaid/models/cra_employment_refresh_report_transaction.rb
 lib/plaid/models/cra_income_insights.rb
 lib/plaid/models/cra_loan_application.rb
 lib/plaid/models/cra_loan_application_decision.rb
@@ -2211,10 +2227,6 @@ lib/plaid/models/cra_voa_report_account_historical_balance.rb
 lib/plaid/models/cra_voa_report_attributes.rb
 lib/plaid/models/cra_voa_report_item.rb
 lib/plaid/models/cra_voa_report_transactions_insights.rb
-lib/plaid/models/cra_voe_report.rb
-lib/plaid/models/cra_voe_report_account.rb
-lib/plaid/models/cra_voe_report_item.rb
-lib/plaid/models/cra_voe_report_transaction.rb
 lib/plaid/models/credit1099.rb
 lib/plaid/models/credit1099_filer.rb
 lib/plaid/models/credit1099_payer.rb
@@ -2780,7 +2792,6 @@ lib/plaid/models/monitoring_income_source.rb
 lib/plaid/models/monitoring_insights.rb
 lib/plaid/models/monitoring_insights_item_status.rb
 lib/plaid/models/monitoring_insights_status.rb
-lib/plaid/models/monitoring_insights_webhook.rb
 lib/plaid/models/monitoring_item_status_code.rb
 lib/plaid/models/monitoring_loan_insights.rb
 lib/plaid/models/mortgage_interest_rate.rb
@@ -3093,6 +3104,7 @@ lib/plaid/models/recurring_transactions_update_webhook.rb
 lib/plaid/models/recurring_transfer.rb
 lib/plaid/models/recurring_transfer_nullable.rb
 lib/plaid/models/recurring_transfer_skipped_webhook.rb
+lib/plaid/models/refresh_result.rb
 lib/plaid/models/removed_transaction.rb
 lib/plaid/models/report_type.rb
 lib/plaid/models/reporting_information.rb
@@ -3522,6 +3534,8 @@ lib/plaid/models/user_create_request.rb
 lib/plaid/models/user_create_response.rb
 lib/plaid/models/user_custom_password.rb
 lib/plaid/models/user_data_overview.rb
+lib/plaid/models/user_financial_data_refresh_request.rb
+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
@@ -3535,6 +3549,8 @@ lib/plaid/models/user_third_party_token_create_request.rb
 lib/plaid/models/user_third_party_token_create_response.rb
 lib/plaid/models/user_third_party_token_remove_request.rb
 lib/plaid/models/user_third_party_token_remove_response.rb
+lib/plaid/models/user_transactions_refresh_request.rb
+lib/plaid/models/user_transactions_refresh_response.rb
 lib/plaid/models/user_update_request.rb
 lib/plaid/models/user_update_response.rb
 lib/plaid/models/validation_source.rb

CHANGELOG.md

@@ -1,5 +1,64 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 42.0.0
+- Updating to OAS 2020-09-14_1.652.0
+
+## 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
+
+### 2020-09-14_1.651.2
+- (beta) Add `user_id` field to `link/token/create` request
+- [BREAKING for Go] (beta) Make `user` object optional in `link/token/create` if `user_id` is included
+
+### 2020-09-14_1.651.1
+- Add `error` field to `WALLET_TRANSACTION_STATUS_UPDATE` webhook and to responses of `/wallet/transaction/get` and `/wallet/transaction/list`, containing error details for failed transactions.
+
+### 2020-09-14_1.651.0
+- Rename all `/verify/client/*` routes to `/protect/client/*` and update request/response body and field names accordingly.
+
+### 2020-09-14_1.650.1
+- Update description for `days_required`
+
+### 2020-09-14_1.650.0
+- Add `account_numbers` to `Counterparty` in `/transaction/get` and `/transaction/sync`
+
+### 2020-09-14_1.649.2
+- Add `InsitutionID` and `InstitutionName` to `/cra/monitoring_insights/get` response
+
+### 2020-09-14_1.649.1
+- Update max value for `cra_options.days_requested` in `link/token/create` to 731 (2 years + 1 days for leap year)
+- Reduce max value for `cra_options.days_required` in `link/token/create` to 184 (most number of days in a 6 month period) from 730
+- Set max value for `days_required` in `cra/check_report/create` to 184 (most number of days in a 6 month period)
+
+### 2020-09-14_1.649.0
+- Add wire_return_fee to Transfer and Transfer Event objects
+
+### 2020-09-14_1.648.2
+- Docs-only change to add additional subtypes to the accounts schema
+
+### 2020-09-14_1.648.1
+- Add `last_successful_update_time` to `/cashflow_report/get`
+
+### 2020-09-14_1.648.0
+- Add `require_identity` to `cra_options.base_report` in `link/token/create` and `/cra/check_report/create` requests 
+
+### 2020-09-14_1.647.1
+- Update `/transfer/ledger/distribute` summary
+
+### 2020-09-14_1.647.0
+- Add `webhook_codes` field to `/sandbox/cashflow_updates/update` request
+
+### 2020-09-14_1.646.0
+- [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` 
+
+### 2020-09-14_1.645.1
+- Update description of `/transfer/ledger/distribute`
+
 # 41.0.0
 - Updating to OAS 2020-09-14_1.645.0
 

Dockerfile

@@ -1,5 +1,5 @@
 # Note: This image is also built in CircleCI, so limit references to internal repositories.
-FROM ruby:3.1.0
+FROM ruby:3.2.0
 
 # Create app directory
 WORKDIR /usr/src/app

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=41.0.0
+RUBY_PACKAGE_VERSION=42.0.0
 
 .PHONY: release
 release:

README.md

@@ -33,7 +33,7 @@ Or install it yourself as:
 
     $ gem install plaid
 
-The gem supports Ruby 3.1.0+ only.
+The gem supports Ruby 3.2.0+ only.
 
 ### Versioning
 

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.645.0
+The version of the OpenAPI document: 2020-09-14_1.652.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -246,6 +246,7 @@
 Plaid.autoload :BusinessAccountAllOf, 'plaid/models/business_account_all_of'
 Plaid.autoload :BusinessFinanceCategory, 'plaid/models/business_finance_category'
 Plaid.autoload :CRALoansRegisterRequest, 'plaid/models/cra_loans_register_request'
+Plaid.autoload :CashFlowUpdatesEventWebhookCodes, 'plaid/models/cash_flow_updates_event_webhook_codes'
 Plaid.autoload :CashFlowUpdatesExpectedDepositMissedWebhook, 'plaid/models/cash_flow_updates_expected_deposit_missed_webhook'
 Plaid.autoload :CashFlowUpdatesInsightsWebhook, 'plaid/models/cash_flow_updates_insights_webhook'
 Plaid.autoload :CashFlowUpdatesLargeDepositWebhook, 'plaid/models/cash_flow_updates_large_deposit_webhook'
@@ -307,6 +308,9 @@
 Plaid.autoload :ConsumerReportUserIdentity, 'plaid/models/consumer_report_user_identity'
 Plaid.autoload :Counterparty, 'plaid/models/counterparty'
 Plaid.autoload :CounterpartyInsights, 'plaid/models/counterparty_insights'
+Plaid.autoload :CounterpartyNumbers, 'plaid/models/counterparty_numbers'
+Plaid.autoload :CounterpartyNumbersBACS, 'plaid/models/counterparty_numbers_bacs'
+Plaid.autoload :CounterpartyNumbersInternational, 'plaid/models/counterparty_numbers_international'
 Plaid.autoload :CounterpartyType, 'plaid/models/counterparty_type'
 Plaid.autoload :CountryCode, 'plaid/models/country_code'
 Plaid.autoload :CraBankIncomeAccount, 'plaid/models/cra_bank_income_account'
@@ -349,10 +353,14 @@
 Plaid.autoload :CraCheckReportPartnerInsightsGetRequest, 'plaid/models/cra_check_report_partner_insights_get_request'
 Plaid.autoload :CraCheckReportPartnerInsightsGetResponse, 'plaid/models/cra_check_report_partner_insights_get_response'
 Plaid.autoload :CraCheckReportReadyWebhook, 'plaid/models/cra_check_report_ready_webhook'
+Plaid.autoload :CraCheckReportVerificationGetEmploymentRefreshOptions, 'plaid/models/cra_check_report_verification_get_employment_refresh_options'
 Plaid.autoload :CraCheckReportVerificationGetReportType, 'plaid/models/cra_check_report_verification_get_report_type'
 Plaid.autoload :CraCheckReportVerificationGetRequest, 'plaid/models/cra_check_report_verification_get_request'
 Plaid.autoload :CraCheckReportVerificationGetResponse, 'plaid/models/cra_check_report_verification_get_response'
-Plaid.autoload :CraCheckReportVerificationGetVoeOptions, 'plaid/models/cra_check_report_verification_get_voe_options'
+Plaid.autoload :CraEmploymentRefreshReport, 'plaid/models/cra_employment_refresh_report'
+Plaid.autoload :CraEmploymentRefreshReportAccount, 'plaid/models/cra_employment_refresh_report_account'
+Plaid.autoload :CraEmploymentRefreshReportItem, 'plaid/models/cra_employment_refresh_report_item'
+Plaid.autoload :CraEmploymentRefreshReportTransaction, 'plaid/models/cra_employment_refresh_report_transaction'
 Plaid.autoload :CraIncomeInsights, 'plaid/models/cra_income_insights'
 Plaid.autoload :CraLoanApplication, 'plaid/models/cra_loan_application'
 Plaid.autoload :CraLoanApplicationDecision, 'plaid/models/cra_loan_application_decision'
@@ -403,10 +411,6 @@
 Plaid.autoload :CraVoaReportAttributes, 'plaid/models/cra_voa_report_attributes'
 Plaid.autoload :CraVoaReportItem, 'plaid/models/cra_voa_report_item'
 Plaid.autoload :CraVoaReportTransactionsInsights, 'plaid/models/cra_voa_report_transactions_insights'
-Plaid.autoload :CraVoeReport, 'plaid/models/cra_voe_report'
-Plaid.autoload :CraVoeReportAccount, 'plaid/models/cra_voe_report_account'
-Plaid.autoload :CraVoeReportItem, 'plaid/models/cra_voe_report_item'
-Plaid.autoload :CraVoeReportTransaction, 'plaid/models/cra_voe_report_transaction'
 Plaid.autoload :Credit1099, 'plaid/models/credit1099'
 Plaid.autoload :Credit1099Filer, 'plaid/models/credit1099_filer'
 Plaid.autoload :Credit1099Payer, 'plaid/models/credit1099_payer'
@@ -972,7 +976,6 @@
 Plaid.autoload :MonitoringInsights, 'plaid/models/monitoring_insights'
 Plaid.autoload :MonitoringInsightsItemStatus, 'plaid/models/monitoring_insights_item_status'
 Plaid.autoload :MonitoringInsightsStatus, 'plaid/models/monitoring_insights_status'
-Plaid.autoload :MonitoringInsightsWebhook, 'plaid/models/monitoring_insights_webhook'
 Plaid.autoload :MonitoringItemStatusCode, 'plaid/models/monitoring_item_status_code'
 Plaid.autoload :MonitoringLoanInsights, 'plaid/models/monitoring_loan_insights'
 Plaid.autoload :MortgageInterestRate, 'plaid/models/mortgage_interest_rate'
@@ -1285,6 +1288,7 @@
 Plaid.autoload :RecurringTransfer, 'plaid/models/recurring_transfer'
 Plaid.autoload :RecurringTransferNullable, 'plaid/models/recurring_transfer_nullable'
 Plaid.autoload :RecurringTransferSkippedWebhook, 'plaid/models/recurring_transfer_skipped_webhook'
+Plaid.autoload :RefreshResult, 'plaid/models/refresh_result'
 Plaid.autoload :RemovedTransaction, 'plaid/models/removed_transaction'
 Plaid.autoload :ReportType, 'plaid/models/report_type'
 Plaid.autoload :ReportingInformation, 'plaid/models/reporting_information'
@@ -1714,6 +1718,8 @@
 Plaid.autoload :UserCreateResponse, 'plaid/models/user_create_response'
 Plaid.autoload :UserCustomPassword, 'plaid/models/user_custom_password'
 Plaid.autoload :UserDataOverview, 'plaid/models/user_data_overview'
+Plaid.autoload :UserFinancialDataRefreshRequest, 'plaid/models/user_financial_data_refresh_request'
+Plaid.autoload :UserFinancialDataRefreshResponse, 'plaid/models/user_financial_data_refresh_response'
 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'
@@ -1727,6 +1733,8 @@
 Plaid.autoload :UserThirdPartyTokenCreateResponse, 'plaid/models/user_third_party_token_create_response'
 Plaid.autoload :UserThirdPartyTokenRemoveRequest, 'plaid/models/user_third_party_token_remove_request'
 Plaid.autoload :UserThirdPartyTokenRemoveResponse, 'plaid/models/user_third_party_token_remove_response'
+Plaid.autoload :UserTransactionsRefreshRequest, 'plaid/models/user_transactions_refresh_request'
+Plaid.autoload :UserTransactionsRefreshResponse, 'plaid/models/user_transactions_refresh_response'
 Plaid.autoload :UserUpdateRequest, 'plaid/models/user_update_request'
 Plaid.autoload :UserUpdateResponse, 'plaid/models/user_update_response'
 Plaid.autoload :ValidationSource, 'plaid/models/validation_source'