plaid 22.0.0 → 23.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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -1719,6 +1719,142 @@ module Plaid
       return data, status_code, headers
     end
 
+    # List Beacon Reports for a Beacon User
+    # Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
+    # @param beacon_report_list_request [BeaconReportListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BeaconReportListResponse]
+    def beacon_report_list(beacon_report_list_request, opts = {})
+      data, _status_code, _headers = beacon_report_list_with_http_info(beacon_report_list_request, opts)
+      data
+    end
+
+    # List Beacon Reports for a Beacon User
+    # Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
+    # @param beacon_report_list_request [BeaconReportListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BeaconReportListResponse, Integer, Hash)>] BeaconReportListResponse data, response status code and response headers
+    def beacon_report_list_with_http_info(beacon_report_list_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_list ...'
+      end
+      # verify the required parameter 'beacon_report_list_request' is set
+      if @api_client.config.client_side_validation && beacon_report_list_request.nil?
+        fail ArgumentError, "Missing the required parameter 'beacon_report_list_request' when calling PlaidApi.beacon_report_list"
+      end
+      # resource path
+      local_var_path = '/beacon/report/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(beacon_report_list_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BeaconReportListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.beacon_report_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#beacon_report_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Beacon Report Syndications for a Beacon User
+    # Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
+    # @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BeaconReportSyndicationListResponse]
+    def beacon_report_syndication_list(beacon_report_syndication_list_request, opts = {})
+      data, _status_code, _headers = beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts)
+      data
+    end
+
+    # List Beacon Report Syndications for a Beacon User
+    # Use the &#x60;/beacon/report_syndication/list&#x60; endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the &#x60;next_cursor&#x60; field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the &#x60;next_cursor&#x60; value as the &#x60;cursor&#x60; parameter in the next request.
+    # @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BeaconReportSyndicationListResponse, Integer, Hash)>] BeaconReportSyndicationListResponse data, response status code and response headers
+    def beacon_report_syndication_list_with_http_info(beacon_report_syndication_list_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_syndication_list ...'
+      end
+      # verify the required parameter 'beacon_report_syndication_list_request' is set
+      if @api_client.config.client_side_validation && beacon_report_syndication_list_request.nil?
+        fail ArgumentError, "Missing the required parameter 'beacon_report_syndication_list_request' when calling PlaidApi.beacon_report_syndication_list"
+      end
+      # resource path
+      local_var_path = '/beacon/report_syndication/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(beacon_report_syndication_list_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BeaconReportSyndicationListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.beacon_report_syndication_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#beacon_report_syndication_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a Beacon User
     # Create and scan a Beacon User against your Beacon Program, according to your program's settings.  When you submit a new user to `/beacon/user/create`, several checks are performed immediately:    - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`.    - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`.    - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud.
     # @param beacon_user_create_request [BeaconUserCreateRequest] 
@@ -2875,6 +3011,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Update the parsing configuration for a document income verification
+    # `/credit/payroll_income/parsing_config/update` updates the parsing configuration for a document income verification.
+    # @param request_body [Hash<String, Object>] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreditPayrollIncomeParsingConfigUpdateResponse]
+    def credit_payroll_income_parsing_config_update(request_body, opts = {})
+      data, _status_code, _headers = credit_payroll_income_parsing_config_update_with_http_info(request_body, opts)
+      data
+    end
+
+    # Update the parsing configuration for a document income verification
+    # &#x60;/credit/payroll_income/parsing_config/update&#x60; updates the parsing configuration for a document income verification.
+    # @param request_body [Hash<String, Object>] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreditPayrollIncomeParsingConfigUpdateResponse, Integer, Hash)>] CreditPayrollIncomeParsingConfigUpdateResponse data, response status code and response headers
+    def credit_payroll_income_parsing_config_update_with_http_info(request_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_parsing_config_update ...'
+      end
+      # verify the required parameter 'request_body' is set
+      if @api_client.config.client_side_validation && request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_payroll_income_parsing_config_update"
+      end
+      # resource path
+      local_var_path = '/credit/payroll_income/parsing_config/update'
+
+      # 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(request_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreditPayrollIncomeParsingConfigUpdateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.credit_payroll_income_parsing_config_update",
+        :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#credit_payroll_income_parsing_config_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Check income verification eligibility and optimize conversion
     # `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income.  While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result.  When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.
     # @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest] 
@@ -10151,6 +10355,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Simulate a refund event in Sandbox
+    # Use the `/sandbox/transfer/refund/simulate` endpoint to simulate a refund event in the Sandbox environment.  Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
+    # @param sandbox_transfer_refund_simulate_request [SandboxTransferRefundSimulateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SandboxTransferRefundSimulateResponse]
+    def sandbox_transfer_refund_simulate(sandbox_transfer_refund_simulate_request, opts = {})
+      data, _status_code, _headers = sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts)
+      data
+    end
+
+    # Simulate a refund event in Sandbox
+    # Use the &#x60;/sandbox/transfer/refund/simulate&#x60; endpoint to simulate a refund event in the Sandbox environment.  Note that while an event will be simulated and will appear when using endpoints such as &#x60;/transfer/event/sync&#x60; or &#x60;/transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
+    # @param sandbox_transfer_refund_simulate_request [SandboxTransferRefundSimulateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SandboxTransferRefundSimulateResponse, Integer, Hash)>] SandboxTransferRefundSimulateResponse data, response status code and response headers
+    def sandbox_transfer_refund_simulate_with_http_info(sandbox_transfer_refund_simulate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_refund_simulate ...'
+      end
+      # verify the required parameter 'sandbox_transfer_refund_simulate_request' is set
+      if @api_client.config.client_side_validation && sandbox_transfer_refund_simulate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'sandbox_transfer_refund_simulate_request' when calling PlaidApi.sandbox_transfer_refund_simulate"
+      end
+      # resource path
+      local_var_path = '/sandbox/transfer/refund/simulate'
+
+      # 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(sandbox_transfer_refund_simulate_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SandboxTransferRefundSimulateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.sandbox_transfer_refund_simulate",
+        :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#sandbox_transfer_refund_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Trigger the creation of a repayment
     # Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
     # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest] 
@@ -10288,7 +10560,7 @@ module Plaid
     end
 
     # Simulate creating a sweep
-    # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
+    # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of `swept` will become `swept_settled`, all `posted` or `pending` transfers with a sweep status of `unswept` will become `swept`, and all `returned` transfers with a sweep status of `swept` will become `return_swept`.
     # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SandboxTransferSweepSimulateResponse]
@@ -10298,7 +10570,7 @@ module Plaid
     end
 
     # Simulate creating a sweep
-    # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all &#x60;posted&#x60; or &#x60;pending&#x60; transfers with a sweep status of &#x60;unswept&#x60; will become &#x60;swept&#x60;, and all &#x60;returned&#x60; transfers with a sweep status of &#x60;swept&#x60; will become &#x60;return_swept&#x60;.
+    # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment. Upon calling this endpoint, all transfers with a sweep status of &#x60;swept&#x60; will become &#x60;swept_settled&#x60;, all &#x60;posted&#x60; or &#x60;pending&#x60; transfers with a sweep status of &#x60;unswept&#x60; will become &#x60;swept&#x60;, and all &#x60;returned&#x60; transfers with a sweep status of &#x60;swept&#x60; will become &#x60;return_swept&#x60;.
     # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SandboxTransferSweepSimulateResponse, Integer, Hash)>] SandboxTransferSweepSimulateResponse data, response status code and response headers
@@ -10764,7 +11036,7 @@ module Plaid
     end
 
     # Opt-in an Item to Signal
-    # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score.  If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete.  Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations).  If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item. 
+    # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score.  If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete.  Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations).  If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
     # @param signal_prepare_request [SignalPrepareRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SignalPrepareResponse]
@@ -10774,7 +11046,7 @@ module Plaid
     end
 
     # Opt-in an Item to Signal
-    # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score.  If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete.  Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account and routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, then call &#x60;/signal/prepare&#x60; to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations).  If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item. 
+    # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score.  If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete.  Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account and routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, then call &#x60;/signal/prepare&#x60; to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations).  If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
     # @param signal_prepare_request [SignalPrepareRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
@@ -11105,26 +11377,26 @@ module Plaid
 
     # Enrich locally-held transaction data
     # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
-    # @param transactions_enrich_get_request [TransactionsEnrichGetRequest] 
+    # @param transactions_enrich_request [TransactionsEnrichRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [TransactionsEnrichGetResponse]
-    def transactions_enrich(transactions_enrich_get_request, opts = {})
-      data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_get_request, opts)
+    # @return [TransactionsEnrichResponse]
+    def transactions_enrich(transactions_enrich_request, opts = {})
+      data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_request, opts)
       data
     end
 
     # Enrich locally-held transaction data
     # The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
-    # @param transactions_enrich_get_request [TransactionsEnrichGetRequest] 
+    # @param transactions_enrich_request [TransactionsEnrichRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
-    def transactions_enrich_with_http_info(transactions_enrich_get_request, opts = {})
+    # @return [Array<(TransactionsEnrichResponse, Integer, Hash)>] TransactionsEnrichResponse data, response status code and response headers
+    def transactions_enrich_with_http_info(transactions_enrich_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enrich ...'
       end
-      # verify the required parameter 'transactions_enrich_get_request' is set
-      if @api_client.config.client_side_validation && transactions_enrich_get_request.nil?
-        fail ArgumentError, "Missing the required parameter 'transactions_enrich_get_request' when calling PlaidApi.transactions_enrich"
+      # verify the required parameter 'transactions_enrich_request' is set
+      if @api_client.config.client_side_validation && transactions_enrich_request.nil?
+        fail ArgumentError, "Missing the required parameter 'transactions_enrich_request' when calling PlaidApi.transactions_enrich"
       end
       # resource path
       local_var_path = '/transactions/enrich'
@@ -11146,10 +11418,10 @@ module Plaid
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enrich_get_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enrich_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'TransactionsEnrichGetResponse'
+      return_type = opts[:debug_return_type] || 'TransactionsEnrichResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -11647,8 +11919,76 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Obtain user insights based on transactions sent through /transactions/enrich
+    # The `/beta/transactions/user_insights/v1/get` gets user insights for clients who have enriched data with `/transactions/enrich`.  The product is currently in beta.
+    # @param transactions_user_insights_get_request [TransactionsUserInsightsGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [TransactionsUserInsightsGetResponse]
+    def transactions_user_insights_get(transactions_user_insights_get_request, opts = {})
+      data, _status_code, _headers = transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts)
+      data
+    end
+
+    # Obtain user insights based on transactions sent through /transactions/enrich
+    # The &#x60;/beta/transactions/user_insights/v1/get&#x60; gets user insights for clients who have enriched data with &#x60;/transactions/enrich&#x60;.  The product is currently in beta.
+    # @param transactions_user_insights_get_request [TransactionsUserInsightsGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TransactionsUserInsightsGetResponse, Integer, Hash)>] TransactionsUserInsightsGetResponse data, response status code and response headers
+    def transactions_user_insights_get_with_http_info(transactions_user_insights_get_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_user_insights_get ...'
+      end
+      # verify the required parameter 'transactions_user_insights_get_request' is set
+      if @api_client.config.client_side_validation && transactions_user_insights_get_request.nil?
+        fail ArgumentError, "Missing the required parameter 'transactions_user_insights_get_request' when calling PlaidApi.transactions_user_insights_get"
+      end
+      # resource path
+      local_var_path = '/beta/transactions/user_insights/v1/get'
+
+      # 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(transactions_user_insights_get_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TransactionsUserInsightsGetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.transactions_user_insights_get",
+        :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#transactions_user_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a transfer authorization
-    # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`.   There are three possible outcomes to calling this endpoint: If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema.  In Plaid's Sandbox environment the decisions will be returned as follows:    - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account.    - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).    - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required).    - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.    - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
+    # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`.  There are three possible outcomes to calling this endpoint: If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema.  In Plaid's Sandbox environment the decisions will be returned as follows:    - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account.    - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).    - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required).    - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.    - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
     # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransferAuthorizationCreateResponse]
@@ -11658,7 +11998,7 @@ module Plaid
     end
 
     # Create a transfer authorization
-    # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;.   There are three possible outcomes to calling this endpoint: If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema.  In Plaid&#39;s Sandbox environment the decisions will be returned as follows:    - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account.    - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).    - To approve a transfer with the rationale code &#x60;ITEM_LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required).    - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.    - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
+    # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;.  There are three possible outcomes to calling this endpoint: If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema.  In Plaid&#39;s Sandbox environment the decisions will be returned as follows:    - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account.    - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).    - To approve a transfer with the rationale code &#x60;ITEM_LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required).    - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.    - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
     # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -11852,7 +12192,7 @@ module Plaid
     end
 
     # Get RTP eligibility information of a transfer
-    # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
+    # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligiblity 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`.
     # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransferCapabilitiesGetResponse]
@@ -11862,7 +12202,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 a transfer.
+    # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of a transfer. To simulate RTP eligiblity 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;.
     # @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
@@ -12055,7 +12395,7 @@ module Plaid
       return data, status_code, headers
     end
 
-    # This endpoint allows third-party sender customers to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data.
+    # Upload transfer diligence document on behalf of the originator
     # Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header.
     # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest] 
     # @param [Hash] opts the optional parameters
@@ -12065,7 +12405,7 @@ module Plaid
       data
     end
 
-    # This endpoint allows third-party sender customers to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data.
+    # Upload transfer diligence document on behalf of the originator
     # Third-party sender customers can use &#x60;/transfer/diligence/document/upload&#x60; endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the &#x60;client_id&#x60; in the &#x60;PLAID-CLIENT-ID&#x60; header and &#x60;secret&#x60; in the &#x60;PLAID-SECRET&#x60; header.
     # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest] 
     # @param [Hash] opts the optional parameters
@@ -12123,8 +12463,8 @@ module Plaid
       return data, status_code, headers
     end
 
-    # Submit transfer diligence on behalf of the end customer (i.e. the originator).
-    # Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator.
+    # Submit transfer diligence on behalf of the originator
+    # Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
     # @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransferDiligenceSubmitResponse]
@@ -12133,8 +12473,8 @@ module Plaid
       data
     end
 
-    # Submit transfer diligence on behalf of the end customer (i.e. the originator).
-    # Use the &#x60;/transfer/diligence/submit&#x60; endpoint to submit transfer diligence on behalf of the originator.
+    # Submit transfer diligence on behalf of the originator
+    # Use the &#x60;/transfer/diligence/submit&#x60; endpoint to submit transfer diligence on behalf of the originator (i.e., the end customer).
     # @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TransferDiligenceSubmitResponse, Integer, Hash)>] TransferDiligenceSubmitResponse data, response status code and response headers
@@ -13348,7 +13688,7 @@ module Plaid
     end
 
     # Create a recurring transfer
-    # Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
+    # Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers.
     # @param transfer_recurring_create_request [TransferRecurringCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransferRecurringCreateResponse]
@@ -13358,7 +13698,7 @@ module Plaid
     end
 
     # Create a recurring transfer
-    # Use the &#x60;/transfer/recurring/create&#x60; endpoint to initiate a new recurring transfer.
+    # Use the &#x60;/transfer/recurring/create&#x60; endpoint to initiate a new recurring transfer. This capability is not currently supported for Transfer UI or Platform Payments (beta) customers.
     # @param transfer_recurring_create_request [TransferRecurringCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TransferRecurringCreateResponse, Integer, Hash)>] TransferRecurringCreateResponse data, response status code and response headers
@@ -14096,7 +14436,7 @@ module Plaid
     end
 
     # Update user information
-    # This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call   If you call the endpoint with a non-exist `user_token`, the call will fail with an error message indicating that the user token is not found.
+    # This endpoint is used to update user information associated with an existing `user_token`. The `user_token` should be in the response of `/user/create` call  If you call the endpoint with a non-exist `user_token`, the call will fail with an error message indicating that the user token is not found.
     # @param user_update_request [UserUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [UserUpdateResponse]
@@ -14106,7 +14446,7 @@ module Plaid
     end
 
     # Update user information
-    # This endpoint is used to update user information associated with an existing &#x60;user_token&#x60;. The &#x60;user_token&#x60; should be in the response of &#x60;/user/create&#x60; call   If you call the endpoint with a non-exist &#x60;user_token&#x60;, the call will fail with an error message indicating that the user token is not found.
+    # This endpoint is used to update user information associated with an existing &#x60;user_token&#x60;. The &#x60;user_token&#x60; should be in the response of &#x60;/user/create&#x60; call  If you call the endpoint with a non-exist &#x60;user_token&#x60;, the call will fail with an error message indicating that the user token is not found.
     # @param user_update_request [UserUpdateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(UserUpdateResponse, Integer, Hash)>] UserUpdateResponse data, response status code and response headers

data/lib/plaid/api_client.rb

@@ -7,7 +7,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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0
@@ -38,7 +38,7 @@ module Plaid
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Plaid Ruby v22.0.0"
+      @user_agent = "Plaid Ruby v23.0.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent,

data/lib/plaid/api_error.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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/configuration.rb

@@ -7,7 +7,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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0

data/lib/plaid/models/account_access.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.431.7
+The version of the OpenAPI document: 2020-09-14_1.457.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.1.0