OpenAPI generated code at 2023-09-19T21:16:58Z

.openapi-generator/FILES

@@ -59,6 +59,9 @@ docs/AssetReportFreddieGetResponse.md
 docs/AssetReportGetRequest.md
 docs/AssetReportGetRequestOptions.md
 docs/AssetReportGetResponse.md
+docs/AssetReportInvestmentHolding.md
+docs/AssetReportInvestmentSecurity.md
+docs/AssetReportInvestments.md
 docs/AssetReportItem.md
 docs/AssetReportPDFGetRequest.md
 docs/AssetReportPDFGetRequestOptions.md
@@ -175,6 +178,8 @@ docs/CountryCode.md
 docs/CraBankIncome.md
 docs/CraBankIncomeAccount.md
 docs/CraBankIncomeCause.md
+docs/CraBankIncomeCompleteResult.md
+docs/CraBankIncomeCompleteWebhook.md
 docs/CraBankIncomeEmployer.md
 docs/CraBankIncomeGetRequest.md
 docs/CraBankIncomeGetResponse.md
@@ -697,6 +702,7 @@ docs/NumbersIBANNullable.md
 docs/NumbersInternational.md
 docs/NumbersInternationalIBAN.md
 docs/NumbersInternationalNullable.md
+docs/OmittableTransferType.md
 docs/Originator.md
 docs/OriginatorExpectedTransferFrequency.md
 docs/OverrideAccountType.md
@@ -838,6 +844,8 @@ docs/PlaidApi.md
 docs/PlaidError.md
 docs/PlaidErrorType.md
 docs/PlatformIds.md
+docs/ProcessorAccountGetRequest.md
+docs/ProcessorAccountGetResponse.md
 docs/ProcessorApexProcessorTokenCreateRequest.md
 docs/ProcessorAuthGetRequest.md
 docs/ProcessorAuthGetResponse.md
@@ -958,6 +966,12 @@ docs/SandboxPublicTokenCreateRequestOptionsTransactions.md
 docs/SandboxPublicTokenCreateResponse.md
 docs/SandboxTransferFireWebhookRequest.md
 docs/SandboxTransferFireWebhookResponse.md
+docs/SandboxTransferLedgerDepositSimulateRequest.md
+docs/SandboxTransferLedgerDepositSimulateResponse.md
+docs/SandboxTransferLedgerSimulateAvailableRequest.md
+docs/SandboxTransferLedgerSimulateAvailableResponse.md
+docs/SandboxTransferLedgerWithdrawSimulateRequest.md
+docs/SandboxTransferLedgerWithdrawSimulateResponse.md
 docs/SandboxTransferRepaymentSimulateRequest.md
 docs/SandboxTransferRepaymentSimulateResponse.md
 docs/SandboxTransferSimulateRequest.md
@@ -1034,6 +1048,7 @@ docs/StudentLoanRepaymentModel.md
 docs/StudentLoanStatus.md
 docs/StudentRepaymentPlan.md
 docs/SweepStatus.md
+docs/SweepTrigger.md
 docs/SyncUpdatesAvailableWebhook.md
 docs/Taxform.md
 docs/TaxpayerID.md
@@ -1080,6 +1095,7 @@ docs/TransactionsSyncRequest.md
 docs/TransactionsSyncRequestOptions.md
 docs/TransactionsSyncResponse.md
 docs/Transfer.md
+docs/TransferACHNetwork.md
 docs/TransferAuthorization.md
 docs/TransferAuthorizationCreateRequest.md
 docs/TransferAuthorizationCreateResponse.md
@@ -1125,6 +1141,7 @@ docs/TransferEventType.md
 docs/TransferEventsUpdateWebhook.md
 docs/TransferExpectedSweepSettlementScheduleItem.md
 docs/TransferFailure.md
+docs/TransferFundingAccount.md
 docs/TransferGetRequest.md
 docs/TransferGetResponse.md
 docs/TransferIntentAuthorizationDecision.md
@@ -1138,6 +1155,14 @@ docs/TransferIntentGetFailureReason.md
 docs/TransferIntentGetRequest.md
 docs/TransferIntentGetResponse.md
 docs/TransferIntentStatus.md
+docs/TransferLedgerBalance.md
+docs/TransferLedgerDepositRequest.md
+docs/TransferLedgerDepositResponse.md
+docs/TransferLedgerGetRequest.md
+docs/TransferLedgerGetResponse.md
+docs/TransferLedgerSweepSimulateEventType.md
+docs/TransferLedgerWithdrawRequest.md
+docs/TransferLedgerWithdrawResponse.md
 docs/TransferListRequest.md
 docs/TransferListResponse.md
 docs/TransferMetricsGetRequest.md
@@ -1149,6 +1174,8 @@ docs/TransferOriginatorAddress.md
 docs/TransferOriginatorCreateRequest.md
 docs/TransferOriginatorCreateResponse.md
 docs/TransferOriginatorDiligence.md
+docs/TransferOriginatorFundingAccountUpdateRequest.md
+docs/TransferOriginatorFundingAccountUpdateResponse.md
 docs/TransferOriginatorGetRequest.md
 docs/TransferOriginatorGetResponse.md
 docs/TransferOriginatorListRequest.md
@@ -1206,6 +1233,8 @@ docs/UserPermissionRevokedWebhook.md
 docs/UserStatedIncomeSourceCategory.md
 docs/UserStatedIncomeSourceFrequency.md
 docs/UserStatedIncomeSourcePayType.md
+docs/UserUpdateRequest.md
+docs/UserUpdateResponse.md
 docs/ValidationSource.md
 docs/ValidationSources.md
 docs/VerificationExpiredWebhook.md
@@ -1373,6 +1402,9 @@ lib/plaid/models/asset_report_freddie_get_response.rb
 lib/plaid/models/asset_report_get_request.rb
 lib/plaid/models/asset_report_get_request_options.rb
 lib/plaid/models/asset_report_get_response.rb
+lib/plaid/models/asset_report_investment_holding.rb
+lib/plaid/models/asset_report_investment_security.rb
+lib/plaid/models/asset_report_investments.rb
 lib/plaid/models/asset_report_item.rb
 lib/plaid/models/asset_report_pdf_get_request.rb
 lib/plaid/models/asset_report_pdf_get_request_options.rb
@@ -1489,6 +1521,8 @@ lib/plaid/models/country_code.rb
 lib/plaid/models/cra_bank_income.rb
 lib/plaid/models/cra_bank_income_account.rb
 lib/plaid/models/cra_bank_income_cause.rb
+lib/plaid/models/cra_bank_income_complete_result.rb
+lib/plaid/models/cra_bank_income_complete_webhook.rb
 lib/plaid/models/cra_bank_income_employer.rb
 lib/plaid/models/cra_bank_income_get_request.rb
 lib/plaid/models/cra_bank_income_get_response.rb
@@ -2011,6 +2045,7 @@ lib/plaid/models/numbers_iban_nullable.rb
 lib/plaid/models/numbers_international.rb
 lib/plaid/models/numbers_international_iban.rb
 lib/plaid/models/numbers_international_nullable.rb
+lib/plaid/models/omittable_transfer_type.rb
 lib/plaid/models/originator.rb
 lib/plaid/models/originator_expected_transfer_frequency.rb
 lib/plaid/models/override_account_type.rb
@@ -2150,6 +2185,8 @@ lib/plaid/models/plaid_error.rb
 lib/plaid/models/plaid_error_type.rb
 lib/plaid/models/platform_ids.rb
 lib/plaid/models/po_box_status.rb
+lib/plaid/models/processor_account_get_request.rb
+lib/plaid/models/processor_account_get_response.rb
 lib/plaid/models/processor_apex_processor_token_create_request.rb
 lib/plaid/models/processor_auth_get_request.rb
 lib/plaid/models/processor_auth_get_response.rb
@@ -2271,6 +2308,12 @@ lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb
 lib/plaid/models/sandbox_public_token_create_response.rb
 lib/plaid/models/sandbox_transfer_fire_webhook_request.rb
 lib/plaid/models/sandbox_transfer_fire_webhook_response.rb
+lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb
+lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb
+lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb
+lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb
+lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb
+lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb
 lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb
 lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb
 lib/plaid/models/sandbox_transfer_simulate_request.rb
@@ -2347,6 +2390,7 @@ lib/plaid/models/student_loan_repayment_model.rb
 lib/plaid/models/student_loan_status.rb
 lib/plaid/models/student_repayment_plan.rb
 lib/plaid/models/sweep_status.rb
+lib/plaid/models/sweep_trigger.rb
 lib/plaid/models/sync_updates_available_webhook.rb
 lib/plaid/models/taxform.rb
 lib/plaid/models/taxpayer_id.rb
@@ -2393,6 +2437,7 @@ lib/plaid/models/transactions_sync_request.rb
 lib/plaid/models/transactions_sync_request_options.rb
 lib/plaid/models/transactions_sync_response.rb
 lib/plaid/models/transfer.rb
+lib/plaid/models/transfer_ach_network.rb
 lib/plaid/models/transfer_authorization.rb
 lib/plaid/models/transfer_authorization_create_request.rb
 lib/plaid/models/transfer_authorization_create_response.rb
@@ -2438,6 +2483,7 @@ lib/plaid/models/transfer_event_type.rb
 lib/plaid/models/transfer_events_update_webhook.rb
 lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb
 lib/plaid/models/transfer_failure.rb
+lib/plaid/models/transfer_funding_account.rb
 lib/plaid/models/transfer_get_request.rb
 lib/plaid/models/transfer_get_response.rb
 lib/plaid/models/transfer_intent_authorization_decision.rb
@@ -2451,6 +2497,14 @@ lib/plaid/models/transfer_intent_get_failure_reason.rb
 lib/plaid/models/transfer_intent_get_request.rb
 lib/plaid/models/transfer_intent_get_response.rb
 lib/plaid/models/transfer_intent_status.rb
+lib/plaid/models/transfer_ledger_balance.rb
+lib/plaid/models/transfer_ledger_deposit_request.rb
+lib/plaid/models/transfer_ledger_deposit_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
+lib/plaid/models/transfer_ledger_withdraw_request.rb
+lib/plaid/models/transfer_ledger_withdraw_response.rb
 lib/plaid/models/transfer_list_request.rb
 lib/plaid/models/transfer_list_response.rb
 lib/plaid/models/transfer_metrics_get_request.rb
@@ -2462,6 +2516,8 @@ lib/plaid/models/transfer_originator_address.rb
 lib/plaid/models/transfer_originator_create_request.rb
 lib/plaid/models/transfer_originator_create_response.rb
 lib/plaid/models/transfer_originator_diligence.rb
+lib/plaid/models/transfer_originator_funding_account_update_request.rb
+lib/plaid/models/transfer_originator_funding_account_update_response.rb
 lib/plaid/models/transfer_originator_get_request.rb
 lib/plaid/models/transfer_originator_get_response.rb
 lib/plaid/models/transfer_originator_list_request.rb
@@ -2519,6 +2575,8 @@ lib/plaid/models/user_permission_revoked_webhook.rb
 lib/plaid/models/user_stated_income_source_category.rb
 lib/plaid/models/user_stated_income_source_frequency.rb
 lib/plaid/models/user_stated_income_source_pay_type.rb
+lib/plaid/models/user_update_request.rb
+lib/plaid/models/user_update_response.rb
 lib/plaid/models/validation_source.rb
 lib/plaid/models/validation_sources.rb
 lib/plaid/models/verification_expired_webhook.rb

CHANGELOG.md

@@ -1,5 +1,120 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 22.0.0
+- Updating to OAS 2020-09-14_1.431.7
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.431.7
+- Add processor Zero Hash
+
+### 2020-09-14_1.431.6
+- Update response example of `sandbox/transfer/ledger/deposit/simulate` and `sandbox/transfer/ledger/withdraw/simulate`
+
+### 2020-09-14_1.431.5
+- Update the description of `sweep.settled` event
+
+### 2020-09-14_1.431.4
+- Update description of endpoint `/sandbox/transfer/ledger/simulate_available`
+
+### 2020-09-14_1.431.3
+- Deprecate `originator_client_id` in `/transfer/get`, `/transfer/cancel`, and `/transfer/balance/get`
+
+### 2020-09-14_1.431.2
+- Docs updates for Statements endpoints
+
+### 2020-09-14_1.431.1
+- Remove `balance` field from response of `/sandbox/transfer/ledger/simulate_available`
+
+### 2020-09-14_1.431.0
+- Add `/user/update` and update the description for consumer report user identity
+
+### 2020-09-14_1.430.3
+- Add `sandbox/transfer/ledger/deposit/simulate` and `sandbox/transfer/ledger/withdraw/simulate`
+
+### 2020-09-14_1.430.2
+- Update `transfer/sweep/list` to support filter by `trigger`
+
+### 2020-09-14_1.430.1
+- Add `transfer/ledger/withdraw` route
+
+### 2020-09-14_1.430.0
+- Add `transfer/originator/funding_account/update` route
+
+### 2020-09-14_1.429.3
+- add ledger sweep event types to `TransferEventType`
+
+### 2020-09-14_1.429.2
+- Documentation updates for `LOGIN_REPAIRED` webhook and transfer.
+- Add `transfer/ledger/deposit` route
+
+### 2020-09-14_1.429.1
+- Updated /identity/match's address score threshold recommendation from 80 or above to 70 or above
+
+### 2020-09-14_1.429.0
+- [Breaking change for Go client library] For Transfer endpoints that take payment profiles as input, remove `payment_profile` field and make 
+`account_id` and `access_token` mandatory. The removed field is not in use.
+- Mark all payment profile-specific endpoints as `deprecated`.
+- Docs updates for Transfer, including clarifying that certain request fields for `/transfer/authorization/create`
+are not currently used.
+- Propagate Signal docs update from 2020-09-14_1.419.0 to all relevant endpoints.
+- Add `institution_not_supported` as a property to `LinkSessionExitMetadata.Status`
+
+### 2020-09-14_1.428.1
+- Change `/credit/reports/freddie_mac/get` schema to contain new `ReportingInformationParentIdentifier` field
+
+### 2020-09-14_1.428.0
+- Add `verification_report_type` to `asset_report/create` request
+
+### 2020-09-14_1.427.1
+- Remove references to the verification `report_type` field in `asset_report/get` and `asset_report/pdf/get`
+
+### 2020-09-14_1.427.0
+- Add `/processor/account/get` route
+
+### 2020-09-14_1.426.0
+- Add `instant_microdeposits_enabled` field to `auth` object in `link/token/create`
+
+### 2020-09-14_1.425.0
+- Add `investments` field to `asset_report/get` response as part of the `items.accounts` object
+
+### 2020-09-14_1.424.2
+- Update descriptions of some Transactions endpoint fields
+
+### 2020-09-14_1.424.1
+- Add clarification to processor webhook doc that the processor can call it
+- Fix `sandbox/transfer/ledger/simulate_available` doc url
+
+### 2020-09-14_1.424.0
+- Add `/sandbox/transfer/ledger/simulate_available` route
+
+### 2020-09-14_1.423.0
+- Update code of `BaseReportsErrorWebhook` to `ERROR`
+- Add new enum to StudentRepaymentPlan and add to description of repayment_plan_type
+
+### 2020-09-14_1.422.0
+- Move `BaseReportsProductReadyWebhook` and `BaseReportsErrorWebhook`
+- Remove `asset_report_id` and add `user_id` to `BaseReportsErrorWebhook`
+
+### 2020-09-14_1.421.0
+
+- Update permissible purpose code `LEGITIMATE_BUSINESS_NEED_TENANT_OTHER` to `LEGITIMATE_BUSINESS_NEED_OTHER`
+
+### 2020-09-14_1.420.1
+
+- Add new enums to `canonical_description` in `credit/payroll_income/get`
+
+### 2020-09-14_1.420.0
+
+- Add `database_match_enabled` field to `auth` object in `link/token/create`
+
+### 2020-09-14_1.419.2
+
+- Add `/transfer/ledger/get` route
+
+### 2020-09-14_1.419.1
+
+- Add `submitted` and `not_submitted` to transferDiligenceStatus
+
 # 21.3.0
 - Updating to OAS 2020-09-14_1.419.0
 

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=21.3.0
+RUBY_PACKAGE_VERSION=22.0.0
 
 .PHONY: release
 release: