plaid 41.0.0 → 43.0.0

data/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.645.0
+The version of the OpenAPI document: 2020-09-14_1.658.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -903,6 +903,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Verify auth data
+    # The `/auth/verify` endpoint verifies bank account numbers against Plaid's database via Database Auth.
+    # @param auth_verify_request [AuthVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AuthVerifyResponse]
+    def auth_verify(auth_verify_request, opts = {})
+      data, _status_code, _headers = auth_verify_with_http_info(auth_verify_request, opts)
+      data
+    end
+
+    # Verify auth data
+    # The `/auth/verify` endpoint verifies bank account numbers against Plaid's database via Database Auth.
+    # @param auth_verify_request [AuthVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuthVerifyResponse, Integer, Hash)>] AuthVerifyResponse data, response status code and response headers
+    def auth_verify_with_http_info(auth_verify_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.auth_verify ...'
+      end
+      # verify the required parameter 'auth_verify_request' is set
+      if @api_client.config.client_side_validation && auth_verify_request.nil?
+        fail ArgumentError, "Missing the required parameter 'auth_verify_request' when calling PlaidApi.auth_verify"
+      end
+      # resource path
+      local_var_path = '/auth/verify'
+
+      # 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(auth_verify_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AuthVerifyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.auth_verify",
+        :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#auth_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get balance of your Bank Transfer account
     # Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created.  The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.  Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
     # @param bank_transfer_balance_get_request [BankTransferBalanceGetRequest] 
@@ -3420,7 +3488,7 @@ module Plaid
     end
 
     # Retrieve various verification reports for a user.
-    # This endpoint allows you to retrieve verification reports for a user. To obtain a VoA or VoE 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` 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`.\"
+    # 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` 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]
@@ -3430,7 +3498,7 @@ module Plaid
     end
 
     # Retrieve various verification reports for a user.
-    # This endpoint allows you to retrieve verification reports for a user. To obtain a VoA or VoE report, you need to make sure that &#x60;cra_base_report&#x60; is included in the &#x60;products&#x60; parameter when calling &#x60;/link/token/create&#x60; or &#x60;/cra/check_report/create&#x60;.   You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;.  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 &#x60;/cra/check_report/create&#x60;.\&quot;
+    # 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 &#x60;cra_base_report&#x60; is included in the &#x60;products&#x60; parameter when calling &#x60;/link/token/create&#x60; or &#x60;/cra/check_report/create&#x60;.   You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;.  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 &#x60;/cra/check_report/create&#x60;.\&quot;
     # @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
@@ -3828,7 +3896,7 @@ module Plaid
     end
 
     # Subscribe to Monitoring Insights
-    # This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every day (best-effort).
+    # This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated between one and four times per day (best-effort).
     # @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CraMonitoringInsightsSubscribeResponse]
@@ -3838,7 +3906,7 @@ module Plaid
     end
 
     # Subscribe to Monitoring Insights
-    # This endpoint allows you to subscribe to insights for a user&#39;s linked CRA items, which are updated every day (best-effort).
+    # This endpoint allows you to subscribe to insights for a user&#39;s linked CRA items, which are updated between one and four times per day (best-effort).
     # @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CraMonitoringInsightsSubscribeResponse, Integer, Hash)>] CraMonitoringInsightsSubscribeResponse data, response status code and response headers
@@ -6467,7 +6535,7 @@ module Plaid
     end
 
     # Create a new Identity Verification
-    # Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.  You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. 
+    # Create a new Identity Verification for the user specified by the `client_user_id` and/or `user_id` field. At least one of these two fields must be provided. The requirements and behavior of the verification are determined by the `template_id` provided. If `user_id` is provided, there must be an associated user otherwise an error will be returned. If you don't know whether an active Identity Verification exists for a given `client_user_id` and/or `user_id`, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and/or `user_id`, and `template_id`. If an Identity Verification is found, it will be returned unmodified with a `200 OK` HTTP status code. If `user_id` is not provided, you can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. If `user_id` is provided, user information can not be included in the request body. Please use the `/user/update` endpoint to update user data instead. 
     # @param identity_verification_create_request [IdentityVerificationCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [IdentityVerificationCreateResponse]
@@ -6477,7 +6545,7 @@ module Plaid
     end
 
     # Create a new Identity Verification
-    # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; field. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If you don&#39;t know whether the associated user already has an active Identity Verification, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with an &#x60;200 OK&#x60; HTTP status code.  You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. 
+    # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60; field. At least one of these two fields must be provided. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If &#x60;user_id&#x60; is provided, there must be an associated user otherwise an error will be returned. If you don&#39;t know whether an active Identity Verification exists for a given &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60;, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60;, and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with a &#x60;200 OK&#x60; HTTP status code. If &#x60;user_id&#x60; is not provided, you can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. If &#x60;user_id&#x60; is provided, user information can not be included in the request body. Please use the &#x60;/user/update&#x60; endpoint to update user data instead. 
     # @param identity_verification_create_request [IdentityVerificationCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(IdentityVerificationCreateResponse, Integer, Hash)>] IdentityVerificationCreateResponse data, response status code and response headers
@@ -8371,7 +8439,7 @@ module Plaid
     end
 
     # Remove an Item
-    # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.  Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee).  In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available.  Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint.  Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.  API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
+    # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.  Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/)). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee).  In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available.  Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint.  Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.  API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
     # @param item_remove_request [ItemRemoveRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ItemRemoveResponse]
@@ -8381,7 +8449,7 @@ module Plaid
     end
 
     # Remove an Item
-    # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.  Calling &#x60;/item/remove&#x60; is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling &#x60;/item/remove&#x60; is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee).  In Limited Production, calling &#x60;/item/remove&#x60; does not impact the number of remaining Limited Production Items you have available.  Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the &#x60;/asset_report/remove&#x60; endpoint.  Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager.  API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
+    # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.  Calling &#x60;/item/remove&#x60; is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling &#x60;/item/remove&#x60; is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/)). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee).  In Limited Production, calling &#x60;/item/remove&#x60; does not impact the number of remaining Limited Production Items you have available.  Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the &#x60;/asset_report/remove&#x60; endpoint.  Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager.  API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
     # @param item_remove_request [ItemRemoveRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -8847,7 +8915,7 @@ module Plaid
     end
 
     # Get Link Token
-    # The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes.
+    # The `/link/token/get` endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don't provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes.  By default, this endpoint will only return complete event data for Hosted Link sessions. To use `/link/token/get` to retrieve event data for non-Hosted-Link sessions, contact your account manager to request that your account be enabled for Link events. If you do not have an account manager, you can submit this request via a support ticket. Enablement for Link events will also cause you to receive additional webhooks related to Link events, such as the `SESSION_FINISHED` and `EVENTS` webhook. 
     # @param link_token_get_request [LinkTokenGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [LinkTokenGetResponse]
@@ -8857,7 +8925,7 @@ module Plaid
     end
 
     # Get Link Token
-    # The &#x60;/link/token/get&#x60; endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don&#39;t provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes.
+    # The &#x60;/link/token/get&#x60; endpoint gets information about a Link session, including all callbacks fired during the session along with their metadata, including the public token. This endpoint is used with Link flows that don&#39;t provide a public token via frontend callbacks, such as the [Hosted Link flow](https://plaid.com/docs/link/hosted-link/) and the [Multi-Item Link flow](https://plaid.com/docs/link/multi-item-link/). It also can be useful for debugging purposes.  By default, this endpoint will only return complete event data for Hosted Link sessions. To use &#x60;/link/token/get&#x60; to retrieve event data for non-Hosted-Link sessions, contact your account manager to request that your account be enabled for Link events. If you do not have an account manager, you can submit this request via a support ticket. Enablement for Link events will also cause you to receive additional webhooks related to Link events, such as the &#x60;SESSION_FINISHED&#x60; and &#x60;EVENTS&#x60; webhook. 
     # @param link_token_get_request [LinkTokenGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
@@ -9935,7 +10003,7 @@ module Plaid
     end
 
     # Get payment details
-    # The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
+    # The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.  Polling for status updates in Production is highly discouraged. Repeatedly calling `/payment_initiation/payment/get` to check a payment's status is unreliable and may trigger API rate limits. Only the `payment_status_update` webhook should be used to receive real-time status updates in Production.  In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
     # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [PaymentInitiationPaymentGetResponse]
@@ -9945,7 +10013,7 @@ module Plaid
     end
 
     # Get payment details
-    # The &#x60;/payment_initiation/payment/get&#x60; endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
+    # The &#x60;/payment_initiation/payment/get&#x60; endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.  Polling for status updates in Production is highly discouraged. Repeatedly calling &#x60;/payment_initiation/payment/get&#x60; to check a payment&#39;s status is unreliable and may trigger API rate limits. Only the &#x60;payment_status_update&#x60; webhook should be used to receive real-time status updates in Production.  In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
     # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PaymentInitiationPaymentGetResponse, Integer, Hash)>] PaymentInitiationPaymentGetResponse data, response status code and response headers
@@ -12586,8 +12654,8 @@ module Plaid
       return data, status_code, headers
     end
 
-    # Trigger an update for Cashflow Updates
-    # Use the `/sandbox/cra/cashflow_updates/update` endpoint to manually trigger an update for cashflow updates (Monitoring) in the Sandbox environment.
+    # Trigger an update for Cash Flow Updates
+    # Use the `/sandbox/cra/cashflow_updates/update` endpoint to manually trigger an update for Cash Flow Updates (Monitoring) in the Sandbox environment.
     # @param sandbox_cra_cashflow_updates_update_request [SandboxCraCashflowUpdatesUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SandboxCraCashflowUpdatesUpdateResponse]
@@ -12596,8 +12664,8 @@ module Plaid
       data
     end
 
-    # Trigger an update for Cashflow Updates
-    # Use the &#x60;/sandbox/cra/cashflow_updates/update&#x60; endpoint to manually trigger an update for cashflow updates (Monitoring) in the Sandbox environment.
+    # Trigger an update for Cash Flow Updates
+    # Use the &#x60;/sandbox/cra/cashflow_updates/update&#x60; endpoint to manually trigger an update for Cash Flow Updates (Monitoring) in the Sandbox environment.
     # @param sandbox_cra_cashflow_updates_update_request [SandboxCraCashflowUpdatesUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SandboxCraCashflowUpdatesUpdateResponse, Integer, Hash)>] SandboxCraCashflowUpdatesUpdateResponse data, response status code and response headers
@@ -13267,7 +13335,7 @@ module Plaid
     end
 
     # Create sandbox transactions
-    # Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time.  This endpoint is only available in the Sandbox environment, thus can only be used with Items that were created in the Sandbox. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints.  For Items created in the Production environment, real transactions will be available once the transactions product is enabled.
+    # Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time.  This endpoint can only be used with Items that were created in the Sandbox environment using the `user_transactions_dynamic` test user. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints.
     # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SandboxTransactionsCreateResponse]
@@ -13277,7 +13345,7 @@ module Plaid
     end
 
     # Create sandbox transactions
-    # Use the &#x60;/sandbox/transactions/create&#x60; endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time.  This endpoint is only available in the Sandbox environment, thus can only be used with Items that were created in the Sandbox. You can use this to add transactions to test the &#x60;/transactions/get&#x60; and &#x60;/transactions/sync&#x60; endpoints.  For Items created in the Production environment, real transactions will be available once the transactions product is enabled.
+    # Use the &#x60;/sandbox/transactions/create&#x60; endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time.  This endpoint can only be used with Items that were created in the Sandbox environment using the &#x60;user_transactions_dynamic&#x60; test user. You can use this to add transactions to test the &#x60;/transactions/get&#x60; and &#x60;/transactions/sync&#x60; endpoints.
     # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SandboxTransactionsCreateResponse, Integer, Hash)>] SandboxTransactionsCreateResponse data, response status code and response headers
@@ -14830,74 +14898,6 @@ module Plaid
       return data, status_code, headers
     end
 
-    # Receive token notifications from The Clearing House (TCH).
-    # This endpoint allows us to receive token notifications from The Clearing House (TCH). The schema is defined by TCH.
-    # @param tch_notification [TCHNotification] 
-    # @param [Hash] opts the optional parameters
-    # @return [TCHNotificationResponse]
-    def tch_notifications(tch_notification, opts = {})
-      data, _status_code, _headers = tch_notifications_with_http_info(tch_notification, opts)
-      data
-    end
-
-    # Receive token notifications from The Clearing House (TCH).
-    # This endpoint allows us to receive token notifications from The Clearing House (TCH). The schema is defined by TCH.
-    # @param tch_notification [TCHNotification] 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(TCHNotificationResponse, Integer, Hash)>] TCHNotificationResponse data, response status code and response headers
-    def tch_notifications_with_http_info(tch_notification, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PlaidApi.tch_notifications ...'
-      end
-      # verify the required parameter 'tch_notification' is set
-      if @api_client.config.client_side_validation && tch_notification.nil?
-        fail ArgumentError, "Missing the required parameter 'tch_notification' when calling PlaidApi.tch_notifications"
-      end
-      # resource path
-      local_var_path = '/tch/notifications'
-
-      # 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(tch_notification)
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'TCHNotificationResponse'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
-
-      new_options = opts.merge(
-        :operation => :"PlaidApi.tch_notifications",
-        :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#tch_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # enhance locally-held transaction data
     # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients.  The product is currently in beta.
     # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest] 
@@ -15851,7 +15851,7 @@ module Plaid
     end
 
     # Get RTP eligibility information of a transfer
-    # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by `/transfer/migrate_account`. To simulate RTP eligibility in Sandbox, log in using the username `user_good` and password `pass_good` and use the first two checking and savings accounts in the \"First Platypus Bank\" institution (ending in 0000 or 1111), which will return `true`. Any other account will return `false`.
+    # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by `/transfer/migrate_account`.
     # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransferCapabilitiesGetResponse]
@@ -15861,7 +15861,7 @@ module Plaid
     end
 
     # Get RTP eligibility information of a transfer
-    # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by &#x60;/transfer/migrate_account&#x60;. To simulate RTP eligibility in Sandbox, log in using the username &#x60;user_good&#x60; and password &#x60;pass_good&#x60; and use the first two checking and savings accounts in the \&quot;First Platypus Bank\&quot; institution (ending in 0000 or 1111), which will return &#x60;true&#x60;. Any other account will return &#x60;false&#x60;.
+    # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by &#x60;/transfer/migrate_account&#x60;.
     # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TransferCapabilitiesGetResponse, Integer, Hash)>] TransferCapabilitiesGetResponse data, response status code and response headers
@@ -16598,8 +16598,8 @@ module Plaid
       return data, status_code, headers
     end
 
-    # Move available balance between the ledgers of the platform and one of its originators
-    # Use the `/transfer/ledger/distribute` endpoint to move available balance between the ledgers of the platform and one of its originators.
+    # Move available balance between ledgers
+    # Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you’re a platform, you can move funds between one of your ledgers and one of your customer’s ledger.
     # @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransferLedgerDistributeResponse]
@@ -16608,8 +16608,8 @@ module Plaid
       data
     end
 
-    # Move available balance between the ledgers of the platform and one of its originators
-    # Use the &#x60;/transfer/ledger/distribute&#x60; endpoint to move available balance between the ledgers of the platform and one of its originators.
+    # Move available balance between ledgers
+    # Use the &#x60;/transfer/ledger/distribute&#x60; endpoint to move available balance between ledgers, if you have multiple. If you’re a platform, you can move funds between one of your ledgers and one of your customer’s ledger.
     # @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TransferLedgerDistributeResponse, Integer, Hash)>] TransferLedgerDistributeResponse data, response status code and response headers
@@ -16666,6 +16666,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # List transfer ledger events
+    # Use the `/transfer/ledger/event/list` endpoint to get a list of ledger events for a specific ledger based on specified filter criteria.
+    # @param transfer_ledger_event_list_request [TransferLedgerEventListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [TransferLedgerEventListResponse]
+    def transfer_ledger_event_list(transfer_ledger_event_list_request, opts = {})
+      data, _status_code, _headers = transfer_ledger_event_list_with_http_info(transfer_ledger_event_list_request, opts)
+      data
+    end
+
+    # List transfer ledger events
+    # Use the &#x60;/transfer/ledger/event/list&#x60; endpoint to get a list of ledger events for a specific ledger based on specified filter criteria.
+    # @param transfer_ledger_event_list_request [TransferLedgerEventListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TransferLedgerEventListResponse, Integer, Hash)>] TransferLedgerEventListResponse data, response status code and response headers
+    def transfer_ledger_event_list_with_http_info(transfer_ledger_event_list_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_ledger_event_list ...'
+      end
+      # verify the required parameter 'transfer_ledger_event_list_request' is set
+      if @api_client.config.client_side_validation && transfer_ledger_event_list_request.nil?
+        fail ArgumentError, "Missing the required parameter 'transfer_ledger_event_list_request' when calling PlaidApi.transfer_ledger_event_list"
+      end
+      # resource path
+      local_var_path = '/transfer/ledger/event/list'
+
+      # 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(transfer_ledger_event_list_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TransferLedgerEventListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.transfer_ledger_event_list",
+        :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#transfer_ledger_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve Plaid Ledger balance
     # Use the `/transfer/ledger/get` endpoint to view a balance on the ledger held with Plaid.
     # @param transfer_ledger_get_request [TransferLedgerGetRequest] 
@@ -18505,6 +18573,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Refresh user items for Financial-Insights bundle
+    # `/user/financial_data/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Transactions Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the `results` array in the response to understand the outcome for each Item.  This endpoint is distinct from `/transactions/refresh`, which triggers a refresh for a single Item. Use `/user/financial_data/refresh` to target all Items for a user instead.
+    # @param user_financial_data_refresh_request [UserFinancialDataRefreshRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [UserFinancialDataRefreshResponse]
+    def user_financial_data_refresh(user_financial_data_refresh_request, opts = {})
+      data, _status_code, _headers = user_financial_data_refresh_with_http_info(user_financial_data_refresh_request, opts)
+      data
+    end
+
+    # Refresh user items for Financial-Insights bundle
+    # &#x60;/user/financial_data/refresh&#x60; is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Transactions Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the &#x60;results&#x60; array in the response to understand the outcome for each Item.  This endpoint is distinct from &#x60;/transactions/refresh&#x60;, which triggers a refresh for a single Item. Use &#x60;/user/financial_data/refresh&#x60; to target all Items for a user instead.
+    # @param user_financial_data_refresh_request [UserFinancialDataRefreshRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserFinancialDataRefreshResponse, Integer, Hash)>] UserFinancialDataRefreshResponse data, response status code and response headers
+    def user_financial_data_refresh_with_http_info(user_financial_data_refresh_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.user_financial_data_refresh ...'
+      end
+      # verify the required parameter 'user_financial_data_refresh_request' is set
+      if @api_client.config.client_side_validation && user_financial_data_refresh_request.nil?
+        fail ArgumentError, "Missing the required parameter 'user_financial_data_refresh_request' when calling PlaidApi.user_financial_data_refresh"
+      end
+      # resource path
+      local_var_path = '/user/financial_data/refresh'
+
+      # 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(user_financial_data_refresh_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserFinancialDataRefreshResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.user_financial_data_refresh",
+        :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#user_financial_data_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Items associated with a User
     # Returns Items associated with a User along with their corresponding statuses.
     # @param user_items_get_request [UserItemsGetRequest] 
@@ -18573,6 +18709,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # List Items associated with a User
+    # Returns Items associated with a User along with their corresponding statuses.
+    # @param user_items_list_request [UserItemsListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [UserItemsListResponse]
+    def user_items_list(user_items_list_request, opts = {})
+      data, _status_code, _headers = user_items_list_with_http_info(user_items_list_request, opts)
+      data
+    end
+
+    # List Items associated with a User
+    # Returns Items associated with a User along with their corresponding statuses.
+    # @param user_items_list_request [UserItemsListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserItemsListResponse, Integer, Hash)>] UserItemsListResponse data, response status code and response headers
+    def user_items_list_with_http_info(user_items_list_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.user_items_list ...'
+      end
+      # verify the required parameter 'user_items_list_request' is set
+      if @api_client.config.client_side_validation && user_items_list_request.nil?
+        fail ArgumentError, "Missing the required parameter 'user_items_list_request' when calling PlaidApi.user_items_list"
+      end
+      # resource path
+      local_var_path = '/user/items/list'
+
+      # 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(user_items_list_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserItemsListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.user_items_list",
+        :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#user_items_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Remove user
     # `/user/remove` deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist. If a user is created for a given `client_user_id` using `/user/create` and that user is then deleted with `/user/remove`, the `client_user_id` cannot be reused for another `/user/create` request.
     # @param user_remove_request [UserRemoveRequest] 
@@ -18780,6 +18984,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Refresh user items for Transactions bundle
+    # `/user/transactions/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Transactions bundle. This bundle refreshes only the Transactions product data. This endpoint is for clients who use the Transactions Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the `results` array in the response to understand the outcome for each Item.  This endpoint is distinct from `/transactions/refresh`, which triggers a refresh for a single Item. Use `/user/transactions/refresh` to target all Items for a user instead.
+    # @param user_transactions_refresh_request [UserTransactionsRefreshRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [UserTransactionsRefreshResponse]
+    def user_transactions_refresh(user_transactions_refresh_request, opts = {})
+      data, _status_code, _headers = user_transactions_refresh_with_http_info(user_transactions_refresh_request, opts)
+      data
+    end
+
+    # Refresh user items for Transactions bundle
+    # &#x60;/user/transactions/refresh&#x60; is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Transactions bundle. This bundle refreshes only the Transactions product data. This endpoint is for clients who use the Transactions Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the &#x60;results&#x60; array in the response to understand the outcome for each Item.  This endpoint is distinct from &#x60;/transactions/refresh&#x60;, which triggers a refresh for a single Item. Use &#x60;/user/transactions/refresh&#x60; to target all Items for a user instead.
+    # @param user_transactions_refresh_request [UserTransactionsRefreshRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserTransactionsRefreshResponse, Integer, Hash)>] UserTransactionsRefreshResponse data, response status code and response headers
+    def user_transactions_refresh_with_http_info(user_transactions_refresh_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.user_transactions_refresh ...'
+      end
+      # verify the required parameter 'user_transactions_refresh_request' is set
+      if @api_client.config.client_side_validation && user_transactions_refresh_request.nil?
+        fail ArgumentError, "Missing the required parameter 'user_transactions_refresh_request' when calling PlaidApi.user_transactions_refresh"
+      end
+      # resource path
+      local_var_path = '/user/transactions/refresh'
+
+      # 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(user_transactions_refresh_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserTransactionsRefreshResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.user_transactions_refresh",
+        :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#user_transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update user information
     # This endpoint is used to update user information associated with an existing `user_token`. It can also be used to enable an existing `user_token` for use with Consumer Reports by Plaid Check, by adding a `consumer_report_user_identity` object to the user. Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`.
     # @param user_update_request [UserUpdateRequest]