OpenAPI generated code at 2024-05-10T19:53:21Z

.openapi-generator/FILES

@@ -213,6 +213,7 @@ docs/BeaconUserStatusUpdatedWebhook.md
 docs/BeaconUserUpdateRequest.md
 docs/BeaconUserUpdateRequestData.md
 docs/BeaconUserUpdateResponse.md
+docs/CRALoansRegisterRequest.md
 docs/CategoriesGetResponse.md
 docs/Category.md
 docs/CategoryInsightDetails.md
@@ -225,6 +226,7 @@ docs/ClientProvidedRawTransaction.md
 docs/ClientProvidedTransaction.md
 docs/ClientProvidedTransactionLocation.md
 docs/ConnectedApplication.md
+docs/ConsumerReportPDFGetRequest.md
 docs/ConsumerReportPermissiblePurpose.md
 docs/ConsumerReportUserIdentity.md
 docs/Counterparty.md
@@ -250,6 +252,26 @@ docs/CraBankIncomeSummary.md
 docs/CraBankIncomeTransaction.md
 docs/CraBankIncomeWarning.md
 docs/CraBankIncomeWarningCode.md
+docs/CraLoanApplication.md
+docs/CraLoanApplicationDecision.md
+docs/CraLoanClosedStatus.md
+docs/CraLoanOpenedStatus.md
+docs/CraLoanPaymentHistory.md
+docs/CraLoanPaymentSchedule.md
+docs/CraLoanRegister.md
+docs/CraLoanRegisterApplication.md
+docs/CraLoanStatus.md
+docs/CraLoanStatusHistoryUpdate.md
+docs/CraLoanType.md
+docs/CraLoanUnregister.md
+docs/CraLoanUnregisterResponse.md
+docs/CraLoanUpdate.md
+docs/CraLoansApplicationsRegisterRequest.md
+docs/CraLoansApplicationsRegisterResponse.md
+docs/CraLoansRegisterResponse.md
+docs/CraLoansUnregisterRequest.md
+docs/CraLoansUpdateRequest.md
+docs/CraLoansUpdateResponse.md
 docs/CraPartnerInsights.md
 docs/CraPartnerInsightsCompleteWebhook.md
 docs/CraPartnerInsightsErrorWebhook.md
@@ -638,6 +660,7 @@ docs/ItemAccessTokenInvalidateRequest.md
 docs/ItemAccessTokenInvalidateResponse.md
 docs/ItemActivityListRequest.md
 docs/ItemActivityListResponse.md
+docs/ItemAddResultWebhook.md
 docs/ItemApplicationListRequest.md
 docs/ItemApplicationListResponse.md
 docs/ItemApplicationListUserAuth.md
@@ -709,10 +732,16 @@ docs/LinkOAuthCorrelationIdExchangeResponse.md
 docs/LinkProfileEligibilityCheckRequest.md
 docs/LinkProfileEligibilityCheckResponse.md
 docs/LinkProfileEligibilityCheckUser.md
+docs/LinkSessionBankEmploymentResult.md
+docs/LinkSessionBankIncomeResult.md
 docs/LinkSessionExit.md
+docs/LinkSessionExitDeprecated.md
 docs/LinkSessionExitMetadata.md
 docs/LinkSessionExitMetadataInstitution.md
 docs/LinkSessionFinishedWebhook.md
+docs/LinkSessionItemAddResult.md
+docs/LinkSessionPayrollIncomeResult.md
+docs/LinkSessionResults.md
 docs/LinkSessionSuccess.md
 docs/LinkSessionSuccessMetadata.md
 docs/LinkSessionSuccessMetadataAccount.md
@@ -1240,6 +1269,8 @@ docs/TransactionsUserInsightsGetResponse.md
 docs/Transfer.md
 docs/TransferACHNetwork.md
 docs/TransferAuthorization.md
+docs/TransferAuthorizationCancelRequest.md
+docs/TransferAuthorizationCancelResponse.md
 docs/TransferAuthorizationCreateRequest.md
 docs/TransferAuthorizationCreateResponse.md
 docs/TransferAuthorizationDecision.md
@@ -1722,6 +1753,7 @@ lib/plaid/models/client_provided_raw_transaction.rb
 lib/plaid/models/client_provided_transaction.rb
 lib/plaid/models/client_provided_transaction_location.rb
 lib/plaid/models/connected_application.rb
+lib/plaid/models/consumer_report_pdf_get_request.rb
 lib/plaid/models/consumer_report_permissible_purpose.rb
 lib/plaid/models/consumer_report_user_identity.rb
 lib/plaid/models/counterparty.rb
@@ -1747,6 +1779,27 @@ lib/plaid/models/cra_bank_income_summary.rb
 lib/plaid/models/cra_bank_income_transaction.rb
 lib/plaid/models/cra_bank_income_warning.rb
 lib/plaid/models/cra_bank_income_warning_code.rb
+lib/plaid/models/cra_loan_application.rb
+lib/plaid/models/cra_loan_application_decision.rb
+lib/plaid/models/cra_loan_closed_status.rb
+lib/plaid/models/cra_loan_opened_status.rb
+lib/plaid/models/cra_loan_payment_history.rb
+lib/plaid/models/cra_loan_payment_schedule.rb
+lib/plaid/models/cra_loan_register.rb
+lib/plaid/models/cra_loan_register_application.rb
+lib/plaid/models/cra_loan_status.rb
+lib/plaid/models/cra_loan_status_history_update.rb
+lib/plaid/models/cra_loan_type.rb
+lib/plaid/models/cra_loan_unregister.rb
+lib/plaid/models/cra_loan_unregister_response.rb
+lib/plaid/models/cra_loan_update.rb
+lib/plaid/models/cra_loans_applications_register_request.rb
+lib/plaid/models/cra_loans_applications_register_response.rb
+lib/plaid/models/cra_loans_register_request.rb
+lib/plaid/models/cra_loans_register_response.rb
+lib/plaid/models/cra_loans_unregister_request.rb
+lib/plaid/models/cra_loans_update_request.rb
+lib/plaid/models/cra_loans_update_response.rb
 lib/plaid/models/cra_partner_insights.rb
 lib/plaid/models/cra_partner_insights_complete_webhook.rb
 lib/plaid/models/cra_partner_insights_error_webhook.rb
@@ -2135,6 +2188,7 @@ lib/plaid/models/item_access_token_invalidate_request.rb
 lib/plaid/models/item_access_token_invalidate_response.rb
 lib/plaid/models/item_activity_list_request.rb
 lib/plaid/models/item_activity_list_response.rb
+lib/plaid/models/item_add_result_webhook.rb
 lib/plaid/models/item_application_list_request.rb
 lib/plaid/models/item_application_list_response.rb
 lib/plaid/models/item_application_list_user_auth.rb
@@ -2206,10 +2260,16 @@ lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb
 lib/plaid/models/link_profile_eligibility_check_request.rb
 lib/plaid/models/link_profile_eligibility_check_response.rb
 lib/plaid/models/link_profile_eligibility_check_user.rb
+lib/plaid/models/link_session_bank_employment_result.rb
+lib/plaid/models/link_session_bank_income_result.rb
 lib/plaid/models/link_session_exit.rb
+lib/plaid/models/link_session_exit_deprecated.rb
 lib/plaid/models/link_session_exit_metadata.rb
 lib/plaid/models/link_session_exit_metadata_institution.rb
 lib/plaid/models/link_session_finished_webhook.rb
+lib/plaid/models/link_session_item_add_result.rb
+lib/plaid/models/link_session_payroll_income_result.rb
+lib/plaid/models/link_session_results.rb
 lib/plaid/models/link_session_success.rb
 lib/plaid/models/link_session_success_metadata.rb
 lib/plaid/models/link_session_success_metadata_account.rb
@@ -2736,6 +2796,8 @@ lib/plaid/models/transactions_user_insights_get_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_cancel_request.rb
+lib/plaid/models/transfer_authorization_cancel_response.rb
 lib/plaid/models/transfer_authorization_create_request.rb
 lib/plaid/models/transfer_authorization_create_response.rb
 lib/plaid/models/transfer_authorization_decision.rb

CHANGELOG.md

@@ -1,5 +1,70 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 28.0.0
+- Updating to OAS 2020-09-14_1.517.0
+
+## Breaking changes in this version
+### 2020-09-14_1.517.0
+- [Breaking] Update `onExit` field type in `/link/token/get` response from `LinkSessionExit` to `LinkSessionExitDeprecated`
+
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.517.0
+- [Breaking] Update `/link/token/get` response structure
+
+### 2020-09-14_1.516.0
+- Internal changes only
+
+### 2020-09-14_1.515.0
+- Added `/cra/loans/applications/register`
+- Added `/cra/loans/register`
+- Added `/cra/loans/update`
+- Added `/cra/loans/unregister`
+
+### 2020-09-14_1.514.2
+- Added `days_since_first_observed transaction` as a field in the Account Risk Insights response.
+
+### 2020-09-14_1.514.1
+- Update `risk_profile_key`and `RiskProfile` description
+
+### 2020-09-14_1.514.0
+- Added `transfer/authorization/cancel` endpoint
+
+### 2020-09-14_1.513.0
+- Added `consumer_report/pdf/get` endpoint
+
+### 2020-09-14_1.512.0
+- Added support for address and date of birth in `/payment_initiation/payment/reverse` request.
+
+### 2020-09-14_1.511.0
+- Added `user_token` to `link/token/get` response metadata
+- Internal changes
+
+### 2020-09-14_1.510.2
+- Added `include_insights` to `/credit/relay/get` request
+-
+### 2020-09-14_1.510.1
+- Add `database_insights_pending` as a potential enum value to `LinkDeliveryVerificationStatus` and `LinkSessionSuccessMetadataAccount.VerificationStatus`.
+- Remove `database_insights_pass`, `database_insights_pass_with_caution` and `database_insights_fail` as potential values from `LinkDeliveryVerificationStatus` and `LinkSessionSuccessMetadataAccount.VerificationStatus`
+
+### 2020-09-14_1.510.0
+- Internal changes only
+
+### 2020-09-14_1.509.4
+- Internal changes only
+
+### 2020-09-14_1.509.3
+- Update description of transfer authorization decision code `MANUALLY_VERIFIED_ITEM`
+
+### 2020-09-14_1.509.2
+- Fixes to `RemovedTransaction` object definition: set `additionalProperties` explicitly to true and list `account_id` and `transaction_id` as `required`.
+
+### 2020-09-14_1.509.1
+- add `SMS_MICRODEPOSITS_VERIFICATION` to the `webhook_code` field of `/sandbox/item/fire_webhook`
+
+### 2020-09-14_1.509.0
+- Add `supports_payment_consents` to institution's `payment_initiation_metadata`.
+
 # 27.0.0
 - Updating to OAS 2020-09-14_1.508.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=27.0.0
+RUBY_PACKAGE_VERSION=28.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.508.0
+The version of the OpenAPI document: 2020-09-14_1.517.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -232,6 +232,7 @@
 Plaid.autoload :BeaconUserUpdateRequest, 'plaid/models/beacon_user_update_request'
 Plaid.autoload :BeaconUserUpdateRequestData, 'plaid/models/beacon_user_update_request_data'
 Plaid.autoload :BeaconUserUpdateResponse, 'plaid/models/beacon_user_update_response'
+Plaid.autoload :CRALoansRegisterRequest, 'plaid/models/cra_loans_register_request'
 Plaid.autoload :CategoriesGetResponse, 'plaid/models/categories_get_response'
 Plaid.autoload :Category, 'plaid/models/category'
 Plaid.autoload :CategoryInsightDetails, 'plaid/models/category_insight_details'
@@ -244,6 +245,7 @@
 Plaid.autoload :ClientProvidedTransaction, 'plaid/models/client_provided_transaction'
 Plaid.autoload :ClientProvidedTransactionLocation, 'plaid/models/client_provided_transaction_location'
 Plaid.autoload :ConnectedApplication, 'plaid/models/connected_application'
+Plaid.autoload :ConsumerReportPDFGetRequest, 'plaid/models/consumer_report_pdf_get_request'
 Plaid.autoload :ConsumerReportPermissiblePurpose, 'plaid/models/consumer_report_permissible_purpose'
 Plaid.autoload :ConsumerReportUserIdentity, 'plaid/models/consumer_report_user_identity'
 Plaid.autoload :Counterparty, 'plaid/models/counterparty'
@@ -269,6 +271,26 @@
 Plaid.autoload :CraBankIncomeTransaction, 'plaid/models/cra_bank_income_transaction'
 Plaid.autoload :CraBankIncomeWarning, 'plaid/models/cra_bank_income_warning'
 Plaid.autoload :CraBankIncomeWarningCode, 'plaid/models/cra_bank_income_warning_code'
+Plaid.autoload :CraLoanApplication, 'plaid/models/cra_loan_application'
+Plaid.autoload :CraLoanApplicationDecision, 'plaid/models/cra_loan_application_decision'
+Plaid.autoload :CraLoanClosedStatus, 'plaid/models/cra_loan_closed_status'
+Plaid.autoload :CraLoanOpenedStatus, 'plaid/models/cra_loan_opened_status'
+Plaid.autoload :CraLoanPaymentHistory, 'plaid/models/cra_loan_payment_history'
+Plaid.autoload :CraLoanPaymentSchedule, 'plaid/models/cra_loan_payment_schedule'
+Plaid.autoload :CraLoanRegister, 'plaid/models/cra_loan_register'
+Plaid.autoload :CraLoanRegisterApplication, 'plaid/models/cra_loan_register_application'
+Plaid.autoload :CraLoanStatus, 'plaid/models/cra_loan_status'
+Plaid.autoload :CraLoanStatusHistoryUpdate, 'plaid/models/cra_loan_status_history_update'
+Plaid.autoload :CraLoanType, 'plaid/models/cra_loan_type'
+Plaid.autoload :CraLoanUnregister, 'plaid/models/cra_loan_unregister'
+Plaid.autoload :CraLoanUnregisterResponse, 'plaid/models/cra_loan_unregister_response'
+Plaid.autoload :CraLoanUpdate, 'plaid/models/cra_loan_update'
+Plaid.autoload :CraLoansApplicationsRegisterRequest, 'plaid/models/cra_loans_applications_register_request'
+Plaid.autoload :CraLoansApplicationsRegisterResponse, 'plaid/models/cra_loans_applications_register_response'
+Plaid.autoload :CraLoansRegisterResponse, 'plaid/models/cra_loans_register_response'
+Plaid.autoload :CraLoansUnregisterRequest, 'plaid/models/cra_loans_unregister_request'
+Plaid.autoload :CraLoansUpdateRequest, 'plaid/models/cra_loans_update_request'
+Plaid.autoload :CraLoansUpdateResponse, 'plaid/models/cra_loans_update_response'
 Plaid.autoload :CraPartnerInsights, 'plaid/models/cra_partner_insights'
 Plaid.autoload :CraPartnerInsightsCompleteWebhook, 'plaid/models/cra_partner_insights_complete_webhook'
 Plaid.autoload :CraPartnerInsightsErrorWebhook, 'plaid/models/cra_partner_insights_error_webhook'
@@ -657,6 +679,7 @@
 Plaid.autoload :ItemAccessTokenInvalidateResponse, 'plaid/models/item_access_token_invalidate_response'
 Plaid.autoload :ItemActivityListRequest, 'plaid/models/item_activity_list_request'
 Plaid.autoload :ItemActivityListResponse, 'plaid/models/item_activity_list_response'
+Plaid.autoload :ItemAddResultWebhook, 'plaid/models/item_add_result_webhook'
 Plaid.autoload :ItemApplicationListRequest, 'plaid/models/item_application_list_request'
 Plaid.autoload :ItemApplicationListResponse, 'plaid/models/item_application_list_response'
 Plaid.autoload :ItemApplicationListUserAuth, 'plaid/models/item_application_list_user_auth'
@@ -728,10 +751,16 @@
 Plaid.autoload :LinkProfileEligibilityCheckRequest, 'plaid/models/link_profile_eligibility_check_request'
 Plaid.autoload :LinkProfileEligibilityCheckResponse, 'plaid/models/link_profile_eligibility_check_response'
 Plaid.autoload :LinkProfileEligibilityCheckUser, 'plaid/models/link_profile_eligibility_check_user'
+Plaid.autoload :LinkSessionBankEmploymentResult, 'plaid/models/link_session_bank_employment_result'
+Plaid.autoload :LinkSessionBankIncomeResult, 'plaid/models/link_session_bank_income_result'
 Plaid.autoload :LinkSessionExit, 'plaid/models/link_session_exit'
+Plaid.autoload :LinkSessionExitDeprecated, 'plaid/models/link_session_exit_deprecated'
 Plaid.autoload :LinkSessionExitMetadata, 'plaid/models/link_session_exit_metadata'
 Plaid.autoload :LinkSessionExitMetadataInstitution, 'plaid/models/link_session_exit_metadata_institution'
 Plaid.autoload :LinkSessionFinishedWebhook, 'plaid/models/link_session_finished_webhook'
+Plaid.autoload :LinkSessionItemAddResult, 'plaid/models/link_session_item_add_result'
+Plaid.autoload :LinkSessionPayrollIncomeResult, 'plaid/models/link_session_payroll_income_result'
+Plaid.autoload :LinkSessionResults, 'plaid/models/link_session_results'
 Plaid.autoload :LinkSessionSuccess, 'plaid/models/link_session_success'
 Plaid.autoload :LinkSessionSuccessMetadata, 'plaid/models/link_session_success_metadata'
 Plaid.autoload :LinkSessionSuccessMetadataAccount, 'plaid/models/link_session_success_metadata_account'
@@ -1258,6 +1287,8 @@
 Plaid.autoload :Transfer, 'plaid/models/transfer'
 Plaid.autoload :TransferACHNetwork, 'plaid/models/transfer_ach_network'
 Plaid.autoload :TransferAuthorization, 'plaid/models/transfer_authorization'
+Plaid.autoload :TransferAuthorizationCancelRequest, 'plaid/models/transfer_authorization_cancel_request'
+Plaid.autoload :TransferAuthorizationCancelResponse, 'plaid/models/transfer_authorization_cancel_response'
 Plaid.autoload :TransferAuthorizationCreateRequest, 'plaid/models/transfer_authorization_create_request'
 Plaid.autoload :TransferAuthorizationCreateResponse, 'plaid/models/transfer_authorization_create_response'
 Plaid.autoload :TransferAuthorizationDecision, 'plaid/models/transfer_authorization_decision'