OpenAPI generated code at 2026-04-02T21:34:05Z

.openapi-generator/FILES

@@ -362,6 +362,7 @@ docs/CounterpartyNumbersBACS.md
 docs/CounterpartyNumbersInternational.md
 docs/CounterpartyType.md
 docs/CountryCode.md
+docs/CraAnnualIncomeValues.md
 docs/CraBankIncomeAccount.md
 docs/CraBankIncomeAccountMetadata.md
 docs/CraBankIncomeBonusType.md
@@ -394,6 +395,7 @@ docs/CraCheckReportFreddieMacGetRequest.md
 docs/CraCheckReportFreddieMacGetResponse.md
 docs/CraCheckReportFreddieMacVerificationOfAssetsDeal.md
 docs/CraCheckReportGSEOptions.md
+docs/CraCheckReportIncomeInsightsGetOptions.md
 docs/CraCheckReportIncomeInsightsGetRequest.md
 docs/CraCheckReportIncomeInsightsGetResponse.md
 docs/CraCheckReportLendScoreGetOptions.md
@@ -414,11 +416,20 @@ docs/CraCheckReportVerificationGetRequest.md
 docs/CraCheckReportVerificationGetResponse.md
 docs/CraCheckReportVerificationPdfGetRequest.md
 docs/CraCheckReportVerificationPdfReportType.md
+docs/CraCurrentModeledIncome.md
 docs/CraEmploymentRefreshReport.md
 docs/CraEmploymentRefreshReportAccount.md
 docs/CraEmploymentRefreshReportItem.md
 docs/CraEmploymentRefreshReportTransaction.md
+docs/CraIncomeCategory.md
 docs/CraIncomeInsights.md
+docs/CraIncomeInsightsUserSummary.md
+docs/CraIncomeMetrics.md
+docs/CraIncomeNextPayment.md
+docs/CraIncomeStream.md
+docs/CraIncomeStreamInsights.md
+docs/CraIncomeTransaction.md
+docs/CraIncomeTransactionOutlier.md
 docs/CraLendScoreReport.md
 docs/CraLoanApplication.md
 docs/CraLoanApplicationDecision.md
@@ -447,6 +458,7 @@ docs/CraMonitoringInsightsSubscribeRequest.md
 docs/CraMonitoringInsightsSubscribeResponse.md
 docs/CraMonitoringInsightsUnsubscribeRequest.md
 docs/CraMonitoringInsightsUnsubscribeResponse.md
+docs/CraMonthlyIncomeValues.md
 docs/CraNetworkInsightsItem.md
 docs/CraNetworkInsightsReport.md
 docs/CraPDFAddOns.md
@@ -469,9 +481,11 @@ docs/CraPartnerInsightsUltraFicoScoreRequest.md
 docs/CraPartnerInsightsUltraFicoScoreResult.md
 docs/CraPartnerInsightsUltraFicoScoreVersion.md
 docs/CraPredictionInterval.md
+docs/CraProjectedModeledIncome.md
 docs/CraUpgradeFailedWebhook.md
 docs/CraUserCheckReportFailedWebhook.md
 docs/CraUserCheckReportReadyWebhook.md
+docs/CraUserTier.md
 docs/CraVerificationReport.md
 docs/CraVoaReport.md
 docs/CraVoaReportAccount.md
@@ -801,9 +815,11 @@ docs/IncidentUpdate.md
 docs/IncomeBreakdown.md
 docs/IncomeBreakdownType.md
 docs/IncomeInsights.md
+docs/IncomeInsightsFilter.md
 docs/IncomeInsightsIncomeExcludingTransfers.md
 docs/IncomeInsightsTotalIncome.md
 docs/IncomeInsightsTransfersIn.md
+docs/IncomeInsightsVersion.md
 docs/IncomeOverride.md
 docs/IncomeSourcesCounts.md
 docs/IncomeSummary.md
@@ -854,6 +870,10 @@ docs/InstitutionsSearchPaymentInitiationOptions.md
 docs/InstitutionsSearchRequest.md
 docs/InstitutionsSearchRequestOptions.md
 docs/InstitutionsSearchResponse.md
+docs/InvestmentAccount.md
+docs/InvestmentAccountAllOf.md
+docs/InvestmentAccountBalance.md
+docs/InvestmentAccountBalanceAllOf.md
 docs/InvestmentAccountSubtype.md
 docs/InvestmentFilter.md
 docs/InvestmentHoldingsGetRequestOptions.md
@@ -908,12 +928,17 @@ docs/ItemCreateAuthentication.md
 docs/ItemErrorWebhook.md
 docs/ItemGetRequest.md
 docs/ItemGetResponse.md
+docs/ItemHandleFraudReportRequest.md
+docs/ItemHandleFraudReportResponse.md
 docs/ItemImportRequest.md
 docs/ItemImportRequestOptions.md
 docs/ItemImportRequestUserAuth.md
 docs/ItemImportResponse.md
 docs/ItemLoginRepairedWebhook.md
 docs/ItemProductReadyWebhook.md
+docs/ItemProductsTerminateReasonCode.md
+docs/ItemProductsTerminateRequest.md
+docs/ItemProductsTerminateResponse.md
 docs/ItemPublicTokenCreateRequest.md
 docs/ItemPublicTokenCreateResponse.md
 docs/ItemPublicTokenExchangeRequest.md
@@ -1012,6 +1037,7 @@ docs/LinkTokenCreateRequestCraOptions.md
 docs/LinkTokenCreateRequestCraOptionsBaseReport.md
 docs/LinkTokenCreateRequestCraOptionsBaseReportGSEOptions.md
 docs/LinkTokenCreateRequestCraOptionsCashflowInsights.md
+docs/LinkTokenCreateRequestCraOptionsIncomeInsights.md
 docs/LinkTokenCreateRequestCraOptionsLendScore.md
 docs/LinkTokenCreateRequestCraOptionsNetworkInsights.md
 docs/LinkTokenCreateRequestCraOptionsPartnerInsights.md
@@ -1284,8 +1310,6 @@ docs/PhysicalDocumentExtractedData.md
 docs/PhysicalDocumentExtractedDataAnalysis.md
 docs/PhysicalDocumentImages.md
 docs/PlaidApi.md
-docs/PlaidCheckScore.md
-docs/PlaidCheckScoreVersion.md
 docs/PlaidError.md
 docs/PlaidErrorType.md
 docs/PlaidLendScoreVersion.md
@@ -1301,7 +1325,6 @@ docs/PrismFirstDetect.md
 docs/PrismFirstDetectVersion.md
 docs/PrismInsights.md
 docs/PrismInsightsVersion.md
-docs/PrismProduct.md
 docs/PrismVersions.md
 docs/PrismVersionsDeprecated.md
 docs/ProcessorAccountGetRequest.md
@@ -1321,6 +1344,8 @@ docs/ProcessorIdentityGetResponse.md
 docs/ProcessorIdentityMatchRequest.md
 docs/ProcessorIdentityMatchResponse.md
 docs/ProcessorInitialUpdateWebhook.md
+docs/ProcessorInvestmentsAuthGetRequest.md
+docs/ProcessorInvestmentsAuthGetResponse.md
 docs/ProcessorInvestmentsHoldingsGetRequest.md
 docs/ProcessorInvestmentsHoldingsGetResponse.md
 docs/ProcessorInvestmentsTransactionsGetRequest.md
@@ -1400,9 +1425,7 @@ docs/RecaptchaRequiredError.md
 docs/RecipientBACS.md
 docs/RecipientBACSNullable.md
 docs/RecommendationString.md
-docs/Recurrence.md
 docs/RecurringCancelledWebhook.md
-docs/RecurringFrequency.md
 docs/RecurringInsightsStream.md
 docs/RecurringNewTransferWebhook.md
 docs/RecurringTransactionFrequency.md
@@ -2363,6 +2386,7 @@ 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_annual_income_values.rb
 lib/plaid/models/cra_bank_income_account.rb
 lib/plaid/models/cra_bank_income_account_metadata.rb
 lib/plaid/models/cra_bank_income_bonus_type.rb
@@ -2395,6 +2419,7 @@ lib/plaid/models/cra_check_report_freddie_mac_get_request.rb
 lib/plaid/models/cra_check_report_freddie_mac_get_response.rb
 lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb
 lib/plaid/models/cra_check_report_gse_options.rb
+lib/plaid/models/cra_check_report_income_insights_get_options.rb
 lib/plaid/models/cra_check_report_income_insights_get_request.rb
 lib/plaid/models/cra_check_report_income_insights_get_response.rb
 lib/plaid/models/cra_check_report_lend_score_get_options.rb
@@ -2415,11 +2440,20 @@ 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_pdf_get_request.rb
 lib/plaid/models/cra_check_report_verification_pdf_report_type.rb
+lib/plaid/models/cra_current_modeled_income.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_category.rb
 lib/plaid/models/cra_income_insights.rb
+lib/plaid/models/cra_income_insights_user_summary.rb
+lib/plaid/models/cra_income_metrics.rb
+lib/plaid/models/cra_income_next_payment.rb
+lib/plaid/models/cra_income_stream.rb
+lib/plaid/models/cra_income_stream_insights.rb
+lib/plaid/models/cra_income_transaction.rb
+lib/plaid/models/cra_income_transaction_outlier.rb
 lib/plaid/models/cra_lend_score_report.rb
 lib/plaid/models/cra_loan_application.rb
 lib/plaid/models/cra_loan_application_decision.rb
@@ -2449,6 +2483,7 @@ lib/plaid/models/cra_monitoring_insights_subscribe_request.rb
 lib/plaid/models/cra_monitoring_insights_subscribe_response.rb
 lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb
 lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb
+lib/plaid/models/cra_monthly_income_values.rb
 lib/plaid/models/cra_network_insights_item.rb
 lib/plaid/models/cra_network_insights_report.rb
 lib/plaid/models/cra_partner_insights.rb
@@ -2471,9 +2506,11 @@ lib/plaid/models/cra_partner_insights_ultra_fico_score_result.rb
 lib/plaid/models/cra_partner_insights_ultra_fico_score_version.rb
 lib/plaid/models/cra_pdf_add_ons.rb
 lib/plaid/models/cra_prediction_interval.rb
+lib/plaid/models/cra_projected_modeled_income.rb
 lib/plaid/models/cra_upgrade_failed_webhook.rb
 lib/plaid/models/cra_user_check_report_failed_webhook.rb
 lib/plaid/models/cra_user_check_report_ready_webhook.rb
+lib/plaid/models/cra_user_tier.rb
 lib/plaid/models/cra_verification_report.rb
 lib/plaid/models/cra_voa_report.rb
 lib/plaid/models/cra_voa_report_account.rb
@@ -2802,9 +2839,11 @@ lib/plaid/models/incident_update.rb
 lib/plaid/models/income_breakdown.rb
 lib/plaid/models/income_breakdown_type.rb
 lib/plaid/models/income_insights.rb
+lib/plaid/models/income_insights_filter.rb
 lib/plaid/models/income_insights_income_excluding_transfers.rb
 lib/plaid/models/income_insights_total_income.rb
 lib/plaid/models/income_insights_transfers_in.rb
+lib/plaid/models/income_insights_version.rb
 lib/plaid/models/income_override.rb
 lib/plaid/models/income_sources_counts.rb
 lib/plaid/models/income_summary.rb
@@ -2855,6 +2894,10 @@ lib/plaid/models/institutions_search_payment_initiation_options.rb
 lib/plaid/models/institutions_search_request.rb
 lib/plaid/models/institutions_search_request_options.rb
 lib/plaid/models/institutions_search_response.rb
+lib/plaid/models/investment_account.rb
+lib/plaid/models/investment_account_all_of.rb
+lib/plaid/models/investment_account_balance.rb
+lib/plaid/models/investment_account_balance_all_of.rb
 lib/plaid/models/investment_account_subtype.rb
 lib/plaid/models/investment_filter.rb
 lib/plaid/models/investment_holdings_get_request_options.rb
@@ -2910,12 +2953,17 @@ lib/plaid/models/item_create_authentication.rb
 lib/plaid/models/item_error_webhook.rb
 lib/plaid/models/item_get_request.rb
 lib/plaid/models/item_get_response.rb
+lib/plaid/models/item_handle_fraud_report_request.rb
+lib/plaid/models/item_handle_fraud_report_response.rb
 lib/plaid/models/item_import_request.rb
 lib/plaid/models/item_import_request_options.rb
 lib/plaid/models/item_import_request_user_auth.rb
 lib/plaid/models/item_import_response.rb
 lib/plaid/models/item_login_repaired_webhook.rb
 lib/plaid/models/item_product_ready_webhook.rb
+lib/plaid/models/item_products_terminate_reason_code.rb
+lib/plaid/models/item_products_terminate_request.rb
+lib/plaid/models/item_products_terminate_response.rb
 lib/plaid/models/item_public_token_create_request.rb
 lib/plaid/models/item_public_token_create_response.rb
 lib/plaid/models/item_public_token_exchange_request.rb
@@ -3014,6 +3062,7 @@ lib/plaid/models/link_token_create_request_cra_options.rb
 lib/plaid/models/link_token_create_request_cra_options_base_report.rb
 lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb
 lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb
+lib/plaid/models/link_token_create_request_cra_options_income_insights.rb
 lib/plaid/models/link_token_create_request_cra_options_lend_score.rb
 lib/plaid/models/link_token_create_request_cra_options_network_insights.rb
 lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb
@@ -3283,8 +3332,6 @@ lib/plaid/models/physical_document_category.rb
 lib/plaid/models/physical_document_extracted_data.rb
 lib/plaid/models/physical_document_extracted_data_analysis.rb
 lib/plaid/models/physical_document_images.rb
-lib/plaid/models/plaid_check_score.rb
-lib/plaid/models/plaid_check_score_version.rb
 lib/plaid/models/plaid_error.rb
 lib/plaid/models/plaid_error_type.rb
 lib/plaid/models/plaid_lend_score_version.rb
@@ -3301,7 +3348,6 @@ lib/plaid/models/prism_first_detect.rb
 lib/plaid/models/prism_first_detect_version.rb
 lib/plaid/models/prism_insights.rb
 lib/plaid/models/prism_insights_version.rb
-lib/plaid/models/prism_product.rb
 lib/plaid/models/prism_versions.rb
 lib/plaid/models/prism_versions_deprecated.rb
 lib/plaid/models/processor_account_get_request.rb
@@ -3321,6 +3367,8 @@ lib/plaid/models/processor_identity_get_response.rb
 lib/plaid/models/processor_identity_match_request.rb
 lib/plaid/models/processor_identity_match_response.rb
 lib/plaid/models/processor_initial_update_webhook.rb
+lib/plaid/models/processor_investments_auth_get_request.rb
+lib/plaid/models/processor_investments_auth_get_response.rb
 lib/plaid/models/processor_investments_holdings_get_request.rb
 lib/plaid/models/processor_investments_holdings_get_response.rb
 lib/plaid/models/processor_investments_transactions_get_request.rb
@@ -3401,9 +3449,7 @@ lib/plaid/models/recaptcha_required_error.rb
 lib/plaid/models/recipient_bacs.rb
 lib/plaid/models/recipient_bacs_nullable.rb
 lib/plaid/models/recommendation_string.rb
-lib/plaid/models/recurrence.rb
 lib/plaid/models/recurring_cancelled_webhook.rb
-lib/plaid/models/recurring_frequency.rb
 lib/plaid/models/recurring_insights_stream.rb
 lib/plaid/models/recurring_new_transfer_webhook.rb
 lib/plaid/models/recurring_transaction_frequency.rb

CHANGELOG.md

@@ -1,5 +1,78 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 46.0.0
+- Updating to OAS 2020-09-14_1.686.0
+
+## Breaking changes in this version
+- [BREAKING] Remove deprecated beta `recurrence` field from `Enrichments` schema in `/transactions/enrich` response and remove `Recurrence` and `RecurringFrequency` schema definitions
+- [BREAKING] Update `InvestmentsHoldingsGetResponse`, `InvestmentsTransactionsGetResponse`, `InvestmentsAuthGetResponse`, `ProcessorInvestmentsHoldingsGetResponse`, and `ProcessorInvestmentsTransactionsGetResponse` to use `InvestmentAccount` instead of `AccountBase`
+- [Breaking] `CraPartnerInsightsPrism` is now nullable. The `prism` field will be omitted from `/cra/check_report/partner_insights/get` responses when Prism Data was not included in the request. Clients that always expect `prism` to be present should update to handle a null or missing value.
+- [Breaking] Remove Plaid Check Score references from the API. Plaid Check Score is not in active use by customers and has been deprecated in favor of the Plaid LendScore.
+
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.686.0
+- Add Income Insights V2 schemas and fields to client libraries (hidden from docs)
+### 2020-09-14_1.685.3
+- Add `cfi_code` field to the Investments `Security` schema.
+
+### 2020-09-14_1.685.2
+- Add `protect_transactions` to the public `Products` and `UserBasedProducts` enums and expose it in `/link/token/create` product array docs.
+
+### 2020-09-14_1.685.1
+- Add Item IDs to FAILED CHECK_REPORT webhooks for closed beta
+
+### 2020-09-14_1.685.0
+- [BREAKING] Remove deprecated beta `recurrence` field from `Enrichments` schema in `/transactions/enrich` response and remove `Recurrence` and `RecurringFrequency` schema definitions
+
+### 2020-09-14_1.684.1
+- Add missing investment account subtypes to `InvestmentAccountSubtype` and `InvestmentAccountSubtypeStandalone` schemas: `fhsa`, `line of credit`, `roth 403B`, `roth 457b`, `roth pension`, `roth profit sharing plan`, `roth thrift savings plan`, and `thrift savings plan`. Add these subtypes plus `qshr` to the `AccountSubtype` enum.
+
+### 2020-09-14_1.684.0
+- Add `InvestmentAccountBalance` and `InvestmentAccount` schemas to expose `margin_loan_amount` on investment endpoints
+- [BREAKING] Update `InvestmentsHoldingsGetResponse`, `InvestmentsTransactionsGetResponse`, `InvestmentsAuthGetResponse`, `ProcessorInvestmentsHoldingsGetResponse`, and `ProcessorInvestmentsTransactionsGetResponse` to use `InvestmentAccount` instead of `AccountBase`
+
+### 2020-09-14_1.683.2
+
+### 2020-09-14_1.683.1
+- Add version `4.1` to `PrismDetectVersion`, `PrismCashScoreVersion`, `PrismExtendVersion`, and `PrismInsightsVersion` enums for Prism v4.1 support in `/cra/check_report/partner_insights/get`.
+
+### 2020-09-14_1.683.0
+- Add OpenAPI spec for `/item/products/terminate` and `/item/handle_fraud_report` endpoints
+
+### 2020-09-14_1.683.0
+- Add `user_id` field to `CreditBankIncomeGetRequest`, `CreditBankIncomePDFGetRequest`, `CreditBankIncomeRefreshRequest`, `CreditBankIncomeWebhookUpdateRequest`, `CreditPayrollIncomeParsingConfigUpdateRequest`, `CreditPayrollIncomeRiskSignalsGetRequest`, `CreditPayrollIncomeGetRequest`, `CreditPayrollIncomePrecheckRequest`, and `CreditPayrollIncomeRefreshRequest`.
+
+### 2020-09-14_1.682.12
+- Update `with_guarantee` field in `/transfer/authorization/create` with clearer wording
+
+### 2020-09-14_1.682.11
+- Update `/user/items/remove` description with clearer wording
+
+### 2020-09-14_1.682.10
+- Add `cfi_code` to the Investments `Security` model.
+
+### 2020-09-14_1.682.9
+- Make `with_upgraded_user` field in `/user/create` visible in docs
+
+### 2020-09-14_1.682.8
+- Remove deprecated `prism_products` field from `CraCheckReportCreatePartnerInsightsOptions`, `CraCheckReportPartnerInsightsGetOptions`, `LinkTokenCreateRequestCraOptionsPartnerInsights`, and `LinkTokenCreateRequestCreditPartnerInsights` schemas. Remove deprecated `PrismProduct` enum. Use `prism_versions` instead.
+
+### 2020-09-14_1.682.7
+[Breaking] `CraPartnerInsightsPrism` is now nullable. The `prism` field will be omitted from `/cra/check_report/partner_insights/get` responses when Prism Data was not included in the request. Clients that always expect `prism` to be present should update to handle a null or missing value.
+
+### 2020-09-14_1.682.6
+
+### 2020-09-14_1.682.5
+Update copy for Layer email availability
+
+### 2020-09-14_1.682.4
+- Add `link_session_id` field to `ProtectUserEventWebhook`
+-
+
+### 2020-09-14_1.682.3
+[Breaking] Remove Plaid Check Score references from the API. Plaid Check Score is not in active use by customers and has been deprecated in favor of the Plaid LendScore.
+
 # 45.4.0
 - Updating to OAS 2020-09-14_1.682.2
 

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=45.4.0
+RUBY_PACKAGE_VERSION=46.0.0
 
 .PHONY: release
 release: