OpenAPI generated code at 2026-02-17T19:14:23Z

.openapi-generator/FILES

@@ -1351,6 +1351,8 @@ docs/ProfileNetworkStatusGetResponse.md
 docs/ProgramNameSensitivity.md
 docs/ProjectedIncomeSummaryFieldNumber.md
 docs/ProtectBankAccount.md
+docs/ProtectComputeRequest.md
+docs/ProtectComputeResponse.md
 docs/ProtectEvent.md
 docs/ProtectEventGetRequest.md
 docs/ProtectEventGetResponse.md
@@ -1359,12 +1361,15 @@ docs/ProtectEventSendResponse.md
 docs/ProtectIncidentAmount.md
 docs/ProtectIncidentEvent.md
 docs/ProtectIncidentEventResponse.md
+docs/ProtectLinkModelInputs.md
+docs/ProtectModelInputs.md
 docs/ProtectReport.md
 docs/ProtectReportConfidence.md
 docs/ProtectReportCreateRequest.md
 docs/ProtectReportCreateResponse.md
 docs/ProtectReportSource.md
 docs/ProtectReportType.md
+docs/ProtectUser.md
 docs/ProtectUserEventWebhook.md
 docs/ProtectUserInsightsGetRequest.md
 docs/ProtectUserInsightsGetResponse.md
@@ -1476,6 +1481,9 @@ docs/SandboxTransferRefundSimulateRequest.md
 docs/SandboxTransferRefundSimulateResponse.md
 docs/SandboxTransferRepaymentSimulateRequest.md
 docs/SandboxTransferRepaymentSimulateResponse.md
+docs/SandboxTransferRfpSimulateAction.md
+docs/SandboxTransferRfpSimulateRequest.md
+docs/SandboxTransferRfpSimulateResponse.md
 docs/SandboxTransferSimulateRequest.md
 docs/SandboxTransferSimulateResponse.md
 docs/SandboxTransferSweepSimulateRequest.md
@@ -1811,7 +1819,10 @@ docs/UpdateEntityScreeningRequestSearchTerms.md
 docs/UpdateIndividualScreeningRequestSearchTerms.md
 docs/UserAccountIdentity.md
 docs/UserAccountIdentityAddress.md
+docs/UserAccountIdentityEditCounts.md
+docs/UserAccountIdentityEditHistory.md
 docs/UserAccountIdentityName.md
+docs/UserAccountIdentityOfficialDocument.md
 docs/UserAccountItem.md
 docs/UserAccountRevokedWebhook.md
 docs/UserAccountSessionEvent.md
@@ -1895,6 +1906,7 @@ docs/WalletTransactionGetResponse.md
 docs/WalletTransactionListRequest.md
 docs/WalletTransactionListRequestOptions.md
 docs/WalletTransactionListResponse.md
+docs/WalletTransactionPayeeVerificationStatus.md
 docs/WalletTransactionRelation.md
 docs/WalletTransactionStatus.md
 docs/WalletTransactionStatusUpdateWebhook.md
@@ -3319,6 +3331,8 @@ lib/plaid/models/profile_network_status_get_response.rb
 lib/plaid/models/program_name_sensitivity.rb
 lib/plaid/models/projected_income_summary_field_number.rb
 lib/plaid/models/protect_bank_account.rb
+lib/plaid/models/protect_compute_request.rb
+lib/plaid/models/protect_compute_response.rb
 lib/plaid/models/protect_event.rb
 lib/plaid/models/protect_event_get_request.rb
 lib/plaid/models/protect_event_get_response.rb
@@ -3327,12 +3341,15 @@ lib/plaid/models/protect_event_send_response.rb
 lib/plaid/models/protect_incident_amount.rb
 lib/plaid/models/protect_incident_event.rb
 lib/plaid/models/protect_incident_event_response.rb
+lib/plaid/models/protect_link_model_inputs.rb
+lib/plaid/models/protect_model_inputs.rb
 lib/plaid/models/protect_report.rb
 lib/plaid/models/protect_report_confidence.rb
 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_user.rb
 lib/plaid/models/protect_user_event_webhook.rb
 lib/plaid/models/protect_user_insights_get_request.rb
 lib/plaid/models/protect_user_insights_get_response.rb
@@ -3443,6 +3460,9 @@ lib/plaid/models/sandbox_transfer_refund_simulate_request.rb
 lib/plaid/models/sandbox_transfer_refund_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_rfp_simulate_action.rb
+lib/plaid/models/sandbox_transfer_rfp_simulate_request.rb
+lib/plaid/models/sandbox_transfer_rfp_simulate_response.rb
 lib/plaid/models/sandbox_transfer_simulate_request.rb
 lib/plaid/models/sandbox_transfer_simulate_response.rb
 lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb
@@ -3780,7 +3800,10 @@ lib/plaid/models/update_entity_screening_request_search_terms.rb
 lib/plaid/models/update_individual_screening_request_search_terms.rb
 lib/plaid/models/user_account_identity.rb
 lib/plaid/models/user_account_identity_address.rb
+lib/plaid/models/user_account_identity_edit_counts.rb
+lib/plaid/models/user_account_identity_edit_history.rb
 lib/plaid/models/user_account_identity_name.rb
+lib/plaid/models/user_account_identity_official_document.rb
 lib/plaid/models/user_account_item.rb
 lib/plaid/models/user_account_revoked_webhook.rb
 lib/plaid/models/user_account_session_event.rb
@@ -3864,6 +3887,7 @@ lib/plaid/models/wallet_transaction_get_response.rb
 lib/plaid/models/wallet_transaction_list_request.rb
 lib/plaid/models/wallet_transaction_list_request_options.rb
 lib/plaid/models/wallet_transaction_list_response.rb
+lib/plaid/models/wallet_transaction_payee_verification_status.rb
 lib/plaid/models/wallet_transaction_relation.rb
 lib/plaid/models/wallet_transaction_status.rb
 lib/plaid/models/wallet_transaction_status_update_webhook.rb

CHANGELOG.md

@@ -1,5 +1,24 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 45.2.0
+- Updating to OAS 2020-09-14_1.681.4
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.681.4
+- Add `client_user_id` field to `ProtectUserEventWebhook`
+
+### 2020-09-14_1.681.2
+- Add `edits_current` field to `UserAccountIdentityEditCounts` schema. This field tracks the number of edits made to a specific identity field during the current session.
+
+### 2020-09-14_1.681.1
+- Add `user_id` field to the following webhook schemas: `SyncUpdatesAvailableWebhook`, `ItemPendingExpirationWebhook`, `ItemErrorWebhook`, `ItemLoginRepairedWebhook`, `InvestmentsTransactionsDefaultUpdateWebhook`, `InvestmentsTransactionsHistoricalUpdateWebhook`, `HoldingsDefaultUpdateWebhook`, `LiabilitiesDefaultUpdateWebhook`, `ItemPendingDisconnectWebhook`, `ItemUserPermissionRevokedWebhook`, `NewAccountsAvailableWebhook`, `UserAccountRevokedWebhook`, `LinkSessionFinishedWebhook`
+
+### 2020-09-14_1.681.0
+- Add `trust_index_score` field to `risk_check` schema for IDV endpoints.
+
+### 2020-09-14_1.680.9
+- Add `payee_verification_status` field to `WalletTransaction` schema. This field indicates the result of payee verification checks for EUR payouts.
+
 # 45.1.0
 - Updating to OAS 2020-09-14_1.680.8
 

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.1.0
+RUBY_PACKAGE_VERSION=45.2.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.680.8
+The version of the OpenAPI document: 2020-09-14_1.681.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -1369,6 +1369,8 @@
 Plaid.autoload :ProgramNameSensitivity, 'plaid/models/program_name_sensitivity'
 Plaid.autoload :ProjectedIncomeSummaryFieldNumber, 'plaid/models/projected_income_summary_field_number'
 Plaid.autoload :ProtectBankAccount, 'plaid/models/protect_bank_account'
+Plaid.autoload :ProtectComputeRequest, 'plaid/models/protect_compute_request'
+Plaid.autoload :ProtectComputeResponse, 'plaid/models/protect_compute_response'
 Plaid.autoload :ProtectEvent, 'plaid/models/protect_event'
 Plaid.autoload :ProtectEventGetRequest, 'plaid/models/protect_event_get_request'
 Plaid.autoload :ProtectEventGetResponse, 'plaid/models/protect_event_get_response'
@@ -1377,12 +1379,15 @@
 Plaid.autoload :ProtectIncidentAmount, 'plaid/models/protect_incident_amount'
 Plaid.autoload :ProtectIncidentEvent, 'plaid/models/protect_incident_event'
 Plaid.autoload :ProtectIncidentEventResponse, 'plaid/models/protect_incident_event_response'
+Plaid.autoload :ProtectLinkModelInputs, 'plaid/models/protect_link_model_inputs'
+Plaid.autoload :ProtectModelInputs, 'plaid/models/protect_model_inputs'
 Plaid.autoload :ProtectReport, 'plaid/models/protect_report'
 Plaid.autoload :ProtectReportConfidence, 'plaid/models/protect_report_confidence'
 Plaid.autoload :ProtectReportCreateRequest, 'plaid/models/protect_report_create_request'
 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 :ProtectUser, 'plaid/models/protect_user'
 Plaid.autoload :ProtectUserEventWebhook, 'plaid/models/protect_user_event_webhook'
 Plaid.autoload :ProtectUserInsightsGetRequest, 'plaid/models/protect_user_insights_get_request'
 Plaid.autoload :ProtectUserInsightsGetResponse, 'plaid/models/protect_user_insights_get_response'
@@ -1494,6 +1499,9 @@
 Plaid.autoload :SandboxTransferRefundSimulateResponse, 'plaid/models/sandbox_transfer_refund_simulate_response'
 Plaid.autoload :SandboxTransferRepaymentSimulateRequest, 'plaid/models/sandbox_transfer_repayment_simulate_request'
 Plaid.autoload :SandboxTransferRepaymentSimulateResponse, 'plaid/models/sandbox_transfer_repayment_simulate_response'
+Plaid.autoload :SandboxTransferRfpSimulateAction, 'plaid/models/sandbox_transfer_rfp_simulate_action'
+Plaid.autoload :SandboxTransferRfpSimulateRequest, 'plaid/models/sandbox_transfer_rfp_simulate_request'
+Plaid.autoload :SandboxTransferRfpSimulateResponse, 'plaid/models/sandbox_transfer_rfp_simulate_response'
 Plaid.autoload :SandboxTransferSimulateRequest, 'plaid/models/sandbox_transfer_simulate_request'
 Plaid.autoload :SandboxTransferSimulateResponse, 'plaid/models/sandbox_transfer_simulate_response'
 Plaid.autoload :SandboxTransferSweepSimulateRequest, 'plaid/models/sandbox_transfer_sweep_simulate_request'
@@ -1829,7 +1837,10 @@
 Plaid.autoload :UpdateIndividualScreeningRequestSearchTerms, 'plaid/models/update_individual_screening_request_search_terms'
 Plaid.autoload :UserAccountIdentity, 'plaid/models/user_account_identity'
 Plaid.autoload :UserAccountIdentityAddress, 'plaid/models/user_account_identity_address'
+Plaid.autoload :UserAccountIdentityEditCounts, 'plaid/models/user_account_identity_edit_counts'
+Plaid.autoload :UserAccountIdentityEditHistory, 'plaid/models/user_account_identity_edit_history'
 Plaid.autoload :UserAccountIdentityName, 'plaid/models/user_account_identity_name'
+Plaid.autoload :UserAccountIdentityOfficialDocument, 'plaid/models/user_account_identity_official_document'
 Plaid.autoload :UserAccountItem, 'plaid/models/user_account_item'
 Plaid.autoload :UserAccountRevokedWebhook, 'plaid/models/user_account_revoked_webhook'
 Plaid.autoload :UserAccountSessionEvent, 'plaid/models/user_account_session_event'
@@ -1913,6 +1924,7 @@
 Plaid.autoload :WalletTransactionListRequest, 'plaid/models/wallet_transaction_list_request'
 Plaid.autoload :WalletTransactionListRequestOptions, 'plaid/models/wallet_transaction_list_request_options'
 Plaid.autoload :WalletTransactionListResponse, 'plaid/models/wallet_transaction_list_response'
+Plaid.autoload :WalletTransactionPayeeVerificationStatus, 'plaid/models/wallet_transaction_payee_verification_status'
 Plaid.autoload :WalletTransactionRelation, 'plaid/models/wallet_transaction_relation'
 Plaid.autoload :WalletTransactionStatus, 'plaid/models/wallet_transaction_status'
 Plaid.autoload :WalletTransactionStatusUpdateWebhook, 'plaid/models/wallet_transaction_status_update_webhook'

lib/plaid/api/plaid_api.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.680.8
+The version of the OpenAPI document: 2020-09-14_1.681.4
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -4099,8 +4099,8 @@ def cra_check_report_pdf_get_with_http_info(cra_check_report_pdf_get_request, op
       return data, status_code, headers
     end
 
-    # Retrieve various verification reports for a user.
-    # This endpoint allows you to retrieve verification reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`.   You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`.  If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.\"
+    # Retrieve various home lending reports for a user.
+    # This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`.   You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`.  If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.\"
     # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CraCheckReportVerificationGetResponse]
@@ -4109,8 +4109,8 @@ def cra_check_report_verification_get(cra_check_report_verification_get_request,
       data
     end
 
-    # Retrieve various verification reports for a user.
-    # This endpoint allows you to retrieve verification reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`.   You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`.  If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.\"
+    # Retrieve various home lending reports for a user.
+    # This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`.   You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`.  If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.\"
     # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CraCheckReportVerificationGetResponse, Integer, Hash)>] CraCheckReportVerificationGetResponse data, response status code and response headers
@@ -12926,6 +12926,74 @@ def profile_network_status_get_with_http_info(profile_network_status_get_request
       return data, status_code, headers
     end
 
+    # Compute Protect Trust Index Score
+    # Use this endpoint to compute a Protect Trust Index score and retrieve fraud attributes
+    # @param protect_compute_request [ProtectComputeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ProtectComputeResponse]
+    def protect_compute(protect_compute_request, opts = {})
+      data, _status_code, _headers = protect_compute_with_http_info(protect_compute_request, opts)
+      data
+    end
+
+    # Compute Protect Trust Index Score
+    # Use this endpoint to compute a Protect Trust Index score and retrieve fraud attributes
+    # @param protect_compute_request [ProtectComputeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProtectComputeResponse, Integer, Hash)>] ProtectComputeResponse data, response status code and response headers
+    def protect_compute_with_http_info(protect_compute_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.protect_compute ...'
+      end
+      # verify the required parameter 'protect_compute_request' is set
+      if @api_client.config.client_side_validation && protect_compute_request.nil?
+        fail ArgumentError, "Missing the required parameter 'protect_compute_request' when calling PlaidApi.protect_compute"
+      end
+      # resource path
+      local_var_path = '/protect/compute'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_compute_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProtectComputeResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.protect_compute",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PlaidApi#protect_compute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get information about a user event
     # Get information about a user event including Trust Index score and fraud attributes.
     # @param protect_event_get_request [ProtectEventGetRequest] 
@@ -15034,7 +15102,7 @@ def sandbox_user_reset_login_with_http_info(sandbox_user_reset_login_request, op
       return data, status_code, headers
     end
 
-    # Create a Session Token
+    # Create a Link token for Layer
     # `/session/token/create` is used to create a Link token for Layer. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
     # @param session_token_create_request [SessionTokenCreateRequest] 
     # @param [Hash] opts the optional parameters
@@ -15044,7 +15112,7 @@ def session_token_create(session_token_create_request, opts = {})
       data
     end
 
-    # Create a Session Token
+    # Create a Link token for Layer
     # &#x60;/session/token/create&#x60; is used to create a Link token for Layer. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
     # @param session_token_create_request [SessionTokenCreateRequest] 
     # @param [Hash] opts the optional parameters