OpenAPI generated code at 2026-03-04T22:53:09Z

Author: smile4maggie

.openapi-generator/FILES

@@ -176,6 +176,7 @@ docs/BaseReportItem.md
 docs/BaseReportLongestGapInsights.md
 docs/BaseReportNumberFlowInsights.md
 docs/BaseReportTransaction.md
+docs/BaseReportTransactionPersonalFinanceCategory.md
 docs/BaseReportTransactionType.md
 docs/BaseReportUserAttributes.md
 docs/BaseReportWarning.md
@@ -257,10 +258,14 @@ docs/BetaPartnerEndCustomer.md
 docs/BetaPartnerEndCustomerWithSecrets.md
 docs/BusinessAccount.md
 docs/BusinessAccountAllOf.md
+docs/BusinessCheckBooleanStatus.md
+docs/BusinessDigitalPresenceCheck.md
 docs/BusinessEmailAddress.md
 docs/BusinessEntityType.md
 docs/BusinessFieldMatchSummary.md
 docs/BusinessFinanceCategory.md
+docs/BusinessIndustryPrediction.md
+docs/BusinessIndustryPredictionNullable.md
 docs/BusinessKYBCheck.md
 docs/BusinessKYBMatchDetails.md
 docs/BusinessPhoneNumber.md
@@ -274,7 +279,12 @@ docs/BusinessVerificationGetResponse.md
 docs/BusinessVerificationStatusKYBCheck.md
 docs/BusinessVerificationStatusOverall.md
 docs/BusinessVerificationStatusRiskCheck.md
+docs/BusinessVerificationStatusWebPresenceCheck.md
 docs/BusinessWebsite.md
+docs/BusinessWebsiteAnalysis.md
+docs/BusinessWebsiteBuildStatus.md
+docs/BusinessWebsiteSSL.md
+docs/BusinessWhoisRecord.md
 docs/CRALoansRegisterRequest.md
 docs/CashFlowInsight.md
 docs/CashFlowUpdatesEventWebhookCodes.md
@@ -441,14 +451,23 @@ docs/CraNetworkInsightsItem.md
 docs/CraNetworkInsightsReport.md
 docs/CraPDFAddOns.md
 docs/CraPartnerInsights.md
+docs/CraPartnerInsightsBaseFicoScore.md
+docs/CraPartnerInsightsBaseFicoScoreVersion.md
+docs/CraPartnerInsightsBureau.md
 docs/CraPartnerInsightsCompleteWebhook.md
 docs/CraPartnerInsightsErrorWebhook.md
+docs/CraPartnerInsightsFicoInput.md
+docs/CraPartnerInsightsFicoResults.md
 docs/CraPartnerInsightsGetRequest.md
 docs/CraPartnerInsightsGetResponse.md
 docs/CraPartnerInsightsItem.md
 docs/CraPartnerInsightsItemAccount.md
 docs/CraPartnerInsightsItemAccountMetadata.md
 docs/CraPartnerInsightsPrism.md
+docs/CraPartnerInsightsUltraFicoScore.md
+docs/CraPartnerInsightsUltraFicoScoreRequest.md
+docs/CraPartnerInsightsUltraFicoScoreResult.md
+docs/CraPartnerInsightsUltraFicoScoreVersion.md
 docs/CraPredictionInterval.md
 docs/CraUpgradeFailedWebhook.md
 docs/CraUserCheckReportFailedWebhook.md
@@ -1369,6 +1388,7 @@ docs/ProtectReportCreateRequest.md
 docs/ProtectReportCreateResponse.md
 docs/ProtectReportSource.md
 docs/ProtectReportType.md
+docs/ProtectSDKModelInputs.md
 docs/ProtectUser.md
 docs/ProtectUserEventWebhook.md
 docs/ProtectUserInsightsGetRequest.md
@@ -2158,6 +2178,7 @@ lib/plaid/models/base_report_item.rb
 lib/plaid/models/base_report_longest_gap_insights.rb
 lib/plaid/models/base_report_number_flow_insights.rb
 lib/plaid/models/base_report_transaction.rb
+lib/plaid/models/base_report_transaction_personal_finance_category.rb
 lib/plaid/models/base_report_transaction_type.rb
 lib/plaid/models/base_report_user_attributes.rb
 lib/plaid/models/base_report_warning.rb
@@ -2239,10 +2260,14 @@ lib/plaid/models/beta_partner_end_customer.rb
 lib/plaid/models/beta_partner_end_customer_with_secrets.rb
 lib/plaid/models/business_account.rb
 lib/plaid/models/business_account_all_of.rb
+lib/plaid/models/business_check_boolean_status.rb
+lib/plaid/models/business_digital_presence_check.rb
 lib/plaid/models/business_email_address.rb
 lib/plaid/models/business_entity_type.rb
 lib/plaid/models/business_field_match_summary.rb
 lib/plaid/models/business_finance_category.rb
+lib/plaid/models/business_industry_prediction.rb
+lib/plaid/models/business_industry_prediction_nullable.rb
 lib/plaid/models/business_kyb_check.rb
 lib/plaid/models/business_kyb_match_details.rb
 lib/plaid/models/business_phone_number.rb
@@ -2256,7 +2281,12 @@ lib/plaid/models/business_verification_get_response.rb
 lib/plaid/models/business_verification_status_kyb_check.rb
 lib/plaid/models/business_verification_status_overall.rb
 lib/plaid/models/business_verification_status_risk_check.rb
+lib/plaid/models/business_verification_status_web_presence_check.rb
 lib/plaid/models/business_website.rb
+lib/plaid/models/business_website_analysis.rb
+lib/plaid/models/business_website_build_status.rb
+lib/plaid/models/business_website_ssl.rb
+lib/plaid/models/business_whois_record.rb
 lib/plaid/models/cash_flow_insight.rb
 lib/plaid/models/cash_flow_updates_event_webhook_codes.rb
 lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb
@@ -2422,14 +2452,23 @@ lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb
 lib/plaid/models/cra_network_insights_item.rb
 lib/plaid/models/cra_network_insights_report.rb
 lib/plaid/models/cra_partner_insights.rb
+lib/plaid/models/cra_partner_insights_base_fico_score.rb
+lib/plaid/models/cra_partner_insights_base_fico_score_version.rb
+lib/plaid/models/cra_partner_insights_bureau.rb
 lib/plaid/models/cra_partner_insights_complete_webhook.rb
 lib/plaid/models/cra_partner_insights_error_webhook.rb
+lib/plaid/models/cra_partner_insights_fico_input.rb
+lib/plaid/models/cra_partner_insights_fico_results.rb
 lib/plaid/models/cra_partner_insights_get_request.rb
 lib/plaid/models/cra_partner_insights_get_response.rb
 lib/plaid/models/cra_partner_insights_item.rb
 lib/plaid/models/cra_partner_insights_item_account.rb
 lib/plaid/models/cra_partner_insights_item_account_metadata.rb
 lib/plaid/models/cra_partner_insights_prism.rb
+lib/plaid/models/cra_partner_insights_ultra_fico_score.rb
+lib/plaid/models/cra_partner_insights_ultra_fico_score_request.rb
+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_upgrade_failed_webhook.rb
@@ -3349,6 +3388,7 @@ lib/plaid/models/protect_report_create_request.rb
 lib/plaid/models/protect_report_create_response.rb
 lib/plaid/models/protect_report_source.rb
 lib/plaid/models/protect_report_type.rb
+lib/plaid/models/protect_sdk_model_inputs.rb
 lib/plaid/models/protect_user.rb
 lib/plaid/models/protect_user_event_webhook.rb
 lib/plaid/models/protect_user_insights_get_request.rb

CHANGELOG.md

@@ -1,5 +1,36 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 45.4.0
+- Updating to OAS 2020-09-14_1.682.2
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.682.2
+- Add personal_finance_category to BaseReportTransaction model.
+
+### 2020-09-14_1.682.1
+- Update `ProtectComputeResponse`: promote `score` and `model` to top-level fields, rename `fraud_attributes` to `attributes`, and remove `trust_index` and `subscores`
+- Mark `ProtectComputeResponse.score` as nullable so it is omitted from the API response when no trust index score is present, preventing clients from seeing a spurious `"score": 0`
+
+### 2020-09-14_1.682.0
+- Add `has_null_available_balance` field to `OverrideAccounts` schema. When set to `true`, the Sandbox test account will always return `null` for its available balance. Cannot be set together with `force_available_balance`.
+
+### 2020-09-14_1.681.9
+- Add `fico` field to `CraCheckReportPartnerInsightsGetPartnerInsights`, `CraCheckReportCreatePartnerInsightsOptions`, and `LinkTokenCreateRequestCraOptionsPartnerInsights` schemas to support UltraFICO score generation; add new `CraPartnerInsightsFicoInput`, `CraPartnerInsightsUltraFicoScoreRequest`, `CraPartnerInsightsBaseFicoScore`, `CraPartnerInsightsUltraFicoScoreVersion`, `CraPartnerInsightsBureau`, and `CraPartnerInsightsBaseFicoScoreVersion` schemas
+
+### 2020-09-14_1.681.8
+- Update `beta/transactions/rules/v1` endpoints to use `client_user_id` instead of `access_token`
+- Split `personal_finance_category` into `pfc_primary_category` and `pfc_detailed_category` on rule request/response schemas; add optional `pfc_version` field
+- Rename `TransactionsRuleField` enum value `NAME` to `MERCHANT_NAME`
+- Add `updated_at` and `client_user_id` to `TransactionsCategoryRule`; replace `item_id` and `personal_finance_category`
+
+### 2020-09-14_1.681.7
+- Add `sdk` field to `ProtectModelInputs` on `ProtectComputeRequest`.
+
+### 2020-09-14_1.681.6
+- Clarify `/protect/compute` `model` field: version suffix is required and must be `major.minor` format; removed references to versionless model names
+- Expand `require_extracted_data` field description to document HTTP 400 / `FAILED_PRECONDITION` behavior when set to `true`
+- Add readiness error to `/protect/compute` endpoint description: for link-session models, calling the endpoint before the Link session is complete returns HTTP 400 with `error_type` = `INVALID_REQUEST` and `error_code` = `FAILED_PRECONDITION`
+
 # 45.3.0
 - Updating to OAS 2020-09-14_1.681.5
 

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.3.0
+RUBY_PACKAGE_VERSION=45.4.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.681.5
+The version of the OpenAPI document: 2020-09-14_1.682.2
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -195,6 +195,7 @@
 Plaid.autoload :BaseReportLongestGapInsights, 'plaid/models/base_report_longest_gap_insights'
 Plaid.autoload :BaseReportNumberFlowInsights, 'plaid/models/base_report_number_flow_insights'
 Plaid.autoload :BaseReportTransaction, 'plaid/models/base_report_transaction'
+Plaid.autoload :BaseReportTransactionPersonalFinanceCategory, 'plaid/models/base_report_transaction_personal_finance_category'
 Plaid.autoload :BaseReportTransactionType, 'plaid/models/base_report_transaction_type'
 Plaid.autoload :BaseReportUserAttributes, 'plaid/models/base_report_user_attributes'
 Plaid.autoload :BaseReportWarning, 'plaid/models/base_report_warning'
@@ -276,10 +277,14 @@
 Plaid.autoload :BetaPartnerEndCustomerWithSecrets, 'plaid/models/beta_partner_end_customer_with_secrets'
 Plaid.autoload :BusinessAccount, 'plaid/models/business_account'
 Plaid.autoload :BusinessAccountAllOf, 'plaid/models/business_account_all_of'
+Plaid.autoload :BusinessCheckBooleanStatus, 'plaid/models/business_check_boolean_status'
+Plaid.autoload :BusinessDigitalPresenceCheck, 'plaid/models/business_digital_presence_check'
 Plaid.autoload :BusinessEmailAddress, 'plaid/models/business_email_address'
 Plaid.autoload :BusinessEntityType, 'plaid/models/business_entity_type'
 Plaid.autoload :BusinessFieldMatchSummary, 'plaid/models/business_field_match_summary'
 Plaid.autoload :BusinessFinanceCategory, 'plaid/models/business_finance_category'
+Plaid.autoload :BusinessIndustryPrediction, 'plaid/models/business_industry_prediction'
+Plaid.autoload :BusinessIndustryPredictionNullable, 'plaid/models/business_industry_prediction_nullable'
 Plaid.autoload :BusinessKYBCheck, 'plaid/models/business_kyb_check'
 Plaid.autoload :BusinessKYBMatchDetails, 'plaid/models/business_kyb_match_details'
 Plaid.autoload :BusinessPhoneNumber, 'plaid/models/business_phone_number'
@@ -293,7 +298,12 @@
 Plaid.autoload :BusinessVerificationStatusKYBCheck, 'plaid/models/business_verification_status_kyb_check'
 Plaid.autoload :BusinessVerificationStatusOverall, 'plaid/models/business_verification_status_overall'
 Plaid.autoload :BusinessVerificationStatusRiskCheck, 'plaid/models/business_verification_status_risk_check'
+Plaid.autoload :BusinessVerificationStatusWebPresenceCheck, 'plaid/models/business_verification_status_web_presence_check'
 Plaid.autoload :BusinessWebsite, 'plaid/models/business_website'
+Plaid.autoload :BusinessWebsiteAnalysis, 'plaid/models/business_website_analysis'
+Plaid.autoload :BusinessWebsiteBuildStatus, 'plaid/models/business_website_build_status'
+Plaid.autoload :BusinessWebsiteSSL, 'plaid/models/business_website_ssl'
+Plaid.autoload :BusinessWhoisRecord, 'plaid/models/business_whois_record'
 Plaid.autoload :CRALoansRegisterRequest, 'plaid/models/cra_loans_register_request'
 Plaid.autoload :CashFlowInsight, 'plaid/models/cash_flow_insight'
 Plaid.autoload :CashFlowUpdatesEventWebhookCodes, 'plaid/models/cash_flow_updates_event_webhook_codes'
@@ -460,14 +470,23 @@
 Plaid.autoload :CraNetworkInsightsReport, 'plaid/models/cra_network_insights_report'
 Plaid.autoload :CraPDFAddOns, 'plaid/models/cra_pdf_add_ons'
 Plaid.autoload :CraPartnerInsights, 'plaid/models/cra_partner_insights'
+Plaid.autoload :CraPartnerInsightsBaseFicoScore, 'plaid/models/cra_partner_insights_base_fico_score'
+Plaid.autoload :CraPartnerInsightsBaseFicoScoreVersion, 'plaid/models/cra_partner_insights_base_fico_score_version'
+Plaid.autoload :CraPartnerInsightsBureau, 'plaid/models/cra_partner_insights_bureau'
 Plaid.autoload :CraPartnerInsightsCompleteWebhook, 'plaid/models/cra_partner_insights_complete_webhook'
 Plaid.autoload :CraPartnerInsightsErrorWebhook, 'plaid/models/cra_partner_insights_error_webhook'
+Plaid.autoload :CraPartnerInsightsFicoInput, 'plaid/models/cra_partner_insights_fico_input'
+Plaid.autoload :CraPartnerInsightsFicoResults, 'plaid/models/cra_partner_insights_fico_results'
 Plaid.autoload :CraPartnerInsightsGetRequest, 'plaid/models/cra_partner_insights_get_request'
 Plaid.autoload :CraPartnerInsightsGetResponse, 'plaid/models/cra_partner_insights_get_response'
 Plaid.autoload :CraPartnerInsightsItem, 'plaid/models/cra_partner_insights_item'
 Plaid.autoload :CraPartnerInsightsItemAccount, 'plaid/models/cra_partner_insights_item_account'
 Plaid.autoload :CraPartnerInsightsItemAccountMetadata, 'plaid/models/cra_partner_insights_item_account_metadata'
 Plaid.autoload :CraPartnerInsightsPrism, 'plaid/models/cra_partner_insights_prism'
+Plaid.autoload :CraPartnerInsightsUltraFicoScore, 'plaid/models/cra_partner_insights_ultra_fico_score'
+Plaid.autoload :CraPartnerInsightsUltraFicoScoreRequest, 'plaid/models/cra_partner_insights_ultra_fico_score_request'
+Plaid.autoload :CraPartnerInsightsUltraFicoScoreResult, 'plaid/models/cra_partner_insights_ultra_fico_score_result'
+Plaid.autoload :CraPartnerInsightsUltraFicoScoreVersion, 'plaid/models/cra_partner_insights_ultra_fico_score_version'
 Plaid.autoload :CraPredictionInterval, 'plaid/models/cra_prediction_interval'
 Plaid.autoload :CraUpgradeFailedWebhook, 'plaid/models/cra_upgrade_failed_webhook'
 Plaid.autoload :CraUserCheckReportFailedWebhook, 'plaid/models/cra_user_check_report_failed_webhook'
@@ -1387,6 +1406,7 @@
 Plaid.autoload :ProtectReportCreateResponse, 'plaid/models/protect_report_create_response'
 Plaid.autoload :ProtectReportSource, 'plaid/models/protect_report_source'
 Plaid.autoload :ProtectReportType, 'plaid/models/protect_report_type'
+Plaid.autoload :ProtectSDKModelInputs, 'plaid/models/protect_sdk_model_inputs'
 Plaid.autoload :ProtectUser, 'plaid/models/protect_user'
 Plaid.autoload :ProtectUserEventWebhook, 'plaid/models/protect_user_event_webhook'
 Plaid.autoload :ProtectUserInsightsGetRequest, 'plaid/models/protect_user_insights_get_request'