plaid 31.0.0 → 32.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.556.0
+The version of the OpenAPI document: 2020-09-14_1.565.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -2535,6 +2535,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # List a historical log of item consent events
+    # List a historical log of item consent events
+    # @param consent_events_get_request [ConsentEventsGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConsentEventsGetResponse]
+    def consent_events_get(consent_events_get_request, opts = {})
+      data, _status_code, _headers = consent_events_get_with_http_info(consent_events_get_request, opts)
+      data
+    end
+
+    # List a historical log of item consent events
+    # List a historical log of item consent events
+    # @param consent_events_get_request [ConsentEventsGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConsentEventsGetResponse, Integer, Hash)>] ConsentEventsGetResponse data, response status code and response headers
+    def consent_events_get_with_http_info(consent_events_get_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.consent_events_get ...'
+      end
+      # verify the required parameter 'consent_events_get_request' is set
+      if @api_client.config.client_side_validation && consent_events_get_request.nil?
+        fail ArgumentError, "Missing the required parameter 'consent_events_get_request' when calling PlaidApi.consent_events_get"
+      end
+      # resource path
+      local_var_path = '/consent/events/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(consent_events_get_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConsentEventsGetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.consent_events_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#consent_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve a PDF Reports
     # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format.  Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
     # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest] 
@@ -2944,7 +3012,7 @@ module Plaid
     end
 
     # Create a Consumer Report
-    # `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. Plaid Check automatically starts creating Consumer Report data after the user completes the Link process with a Plaid Check product, so you typically would only call this endpoint if you wish to generate an updated report, some time after the initial report was generated.
+    # `/cra/check_report/create` creates a Consumer Report powered by Plaid Check. You can call this endpoint to create a new report if `consumer_report_permissible_purpose` was omitted during Link token creation. If you did provide a `consumer_report_permissible_purpose` during Link token creation, then Plaid Check will automatically begin creating a Consumer Report once the user completes the Link process, and it is not necessary to call `/cra/check_report/create` before retrieving the report.   `/cra/check_report/create` can also be used to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any `/get` endpoints on the report before it expires. If a report expires, you can call `/cra/check_report/create` again to re-generate it. Note that refreshing or regenerating a report is a billable event.\"
     # @param cra_check_report_create_request [CraCheckReportCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CraCheckReportCreateResponse]
@@ -2954,7 +3022,7 @@ module Plaid
     end
 
     # Create a Consumer Report
-    # &#x60;/cra/check_report/create&#x60; creates a Consumer Report powered by Plaid Check. Plaid Check automatically starts creating Consumer Report data after the user completes the Link process with a Plaid Check product, so you typically would only call this endpoint if you wish to generate an updated report, some time after the initial report was generated.
+    # &#x60;/cra/check_report/create&#x60; creates a Consumer Report powered by Plaid Check. You can call this endpoint to create a new report if &#x60;consumer_report_permissible_purpose&#x60; was omitted during Link token creation. If you did provide a &#x60;consumer_report_permissible_purpose&#x60; during Link token creation, then Plaid Check will automatically begin creating a Consumer Report once the user completes the Link process, and it is not necessary to call &#x60;/cra/check_report/create&#x60; before retrieving the report.   &#x60;/cra/check_report/create&#x60; can also be used to refresh data in an existing report. A Consumer Report will last for 24 hours before expiring; you should call any &#x60;/get&#x60; endpoints on the report before it expires. If a report expires, you can call &#x60;/cra/check_report/create&#x60; again to re-generate it. Note that refreshing or regenerating a report is a billable event.\&quot;
     # @param cra_check_report_create_request [CraCheckReportCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CraCheckReportCreateResponse, Integer, Hash)>] CraCheckReportCreateResponse data, response status code and response headers
@@ -3216,7 +3284,7 @@ module Plaid
     end
 
     # Retrieve Consumer Reports as a PDF
-    # `/cra/check_report/pdf/get` retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
+    # `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Income Insights report be included in the PDF as well, use the `add-ons` field.
     # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [File]
@@ -3226,7 +3294,7 @@ module Plaid
     end
 
     # Retrieve Consumer Reports as a PDF
-    # &#x60;/cra/check_report/pdf/get&#x60; retrieves the most recent Bank Income report (if it exists) followed by the most recent Base Report (if it exists) in PDF format.
+    # &#x60;/cra/check_report/pdf/get&#x60; retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Income Insights report be included in the PDF as well, use the &#x60;add-ons&#x60; field.
     # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -5460,7 +5528,7 @@ module Plaid
     end
 
     # Retrieve a dashboard user
-    # Retrieve information about a dashboard user.
+    # The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `audit_trail` object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
     # @param dashboard_user_get_request [DashboardUserGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [DashboardUserGetResponse]
@@ -5470,7 +5538,7 @@ module Plaid
     end
 
     # Retrieve a dashboard user
-    # Retrieve information about a dashboard user.
+    # The &#x60;/dashboard_user/get&#x60; endpoint provides details (such as email address) about a specific Dashboard user based on the &#x60;dashboard_user_id&#x60; field, which is returned in the &#x60;audit_trail&#x60; object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
     # @param dashboard_user_get_request [DashboardUserGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DashboardUserGetResponse, Integer, Hash)>] DashboardUserGetResponse data, response status code and response headers
@@ -5528,7 +5596,7 @@ module Plaid
     end
 
     # List dashboard users
-    # List all dashboard users associated with your account.
+    # The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
     # @param dashboard_user_list_request [DashboardUserListRequest] 
     # @param [Hash] opts the optional parameters
     # @return [DashboardUserListResponse]
@@ -5538,7 +5606,7 @@ module Plaid
     end
 
     # List dashboard users
-    # List all dashboard users associated with your account.
+    # The &#x60;/dashboard_user/list&#x60; endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
     # @param dashboard_user_list_request [DashboardUserListRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(DashboardUserListResponse, Integer, Hash)>] DashboardUserListResponse data, response status code and response headers
@@ -5595,7 +5663,7 @@ module Plaid
       return data, status_code, headers
     end
 
-    # Create a deposit switch without using Plaid Exchange
+    # (Deprecated) Create a deposit switch without using Plaid Exchange
     # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
     # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest] 
     # @param [Hash] opts the optional parameters
@@ -5605,7 +5673,7 @@ module Plaid
       data
     end
 
-    # Create a deposit switch without using Plaid Exchange
+    # (Deprecated) Create a deposit switch without using Plaid Exchange
     # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
     # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest] 
     # @param [Hash] opts the optional parameters
@@ -5663,7 +5731,7 @@ module Plaid
       return data, status_code, headers
     end
 
-    # Create a deposit switch
+    # (Deprecated) Create a deposit switch
     # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
     # @param deposit_switch_create_request [DepositSwitchCreateRequest] 
     # @param [Hash] opts the optional parameters
@@ -5673,7 +5741,7 @@ module Plaid
       data
     end
 
-    # Create a deposit switch
+    # (Deprecated) Create a deposit switch
     # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
     # @param deposit_switch_create_request [DepositSwitchCreateRequest] 
     # @param [Hash] opts the optional parameters
@@ -5731,7 +5799,7 @@ module Plaid
       return data, status_code, headers
     end
 
-    # Retrieve a deposit switch
+    # (Deprecated) Retrieve a deposit switch
     # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
     # @param deposit_switch_get_request [DepositSwitchGetRequest] 
     # @param [Hash] opts the optional parameters
@@ -5741,7 +5809,7 @@ module Plaid
       data
     end
 
-    # Retrieve a deposit switch
+    # (Deprecated) Retrieve a deposit switch
     # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user&#39;s direct deposit allocation preferences.
     # @param deposit_switch_get_request [DepositSwitchGetRequest] 
     # @param [Hash] opts the optional parameters
@@ -5799,7 +5867,7 @@ module Plaid
       return data, status_code, headers
     end
 
-    # Create a deposit switch token
+    # (Deprecated) Create a deposit switch token
     # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes. 
     # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest] 
     # @param [Hash] opts the optional parameters
@@ -5809,7 +5877,7 @@ module Plaid
       data
     end
 
-    # Create a deposit switch token
+    # (Deprecated) Create a deposit switch token
     # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes. 
     # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest] 
     # @param [Hash] opts the optional parameters
@@ -7622,6 +7690,210 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Get an Issue
+    # Retrieve detailed information about a specific `Issue`. This endpoint returns a single `Issue` object.
+    # @param issues_get_request [IssuesGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [IssuesGetResponse]
+    def issues_get(issues_get_request, opts = {})
+      data, _status_code, _headers = issues_get_with_http_info(issues_get_request, opts)
+      data
+    end
+
+    # Get an Issue
+    # Retrieve detailed information about a specific &#x60;Issue&#x60;. This endpoint returns a single &#x60;Issue&#x60; object.
+    # @param issues_get_request [IssuesGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IssuesGetResponse, Integer, Hash)>] IssuesGetResponse data, response status code and response headers
+    def issues_get_with_http_info(issues_get_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.issues_get ...'
+      end
+      # verify the required parameter 'issues_get_request' is set
+      if @api_client.config.client_side_validation && issues_get_request.nil?
+        fail ArgumentError, "Missing the required parameter 'issues_get_request' when calling PlaidApi.issues_get"
+      end
+      # resource path
+      local_var_path = '/issues/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(issues_get_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IssuesGetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.issues_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#issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search for an Issue
+    # Search for an issue associated with one of the following identifiers:  `item_id`, `link_session_id` or Link session `request_id`.  This endpoint returns a list of `Issue` objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.
+    # @param issues_search_request [IssuesSearchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [IssuesSearchResponse]
+    def issues_search(issues_search_request, opts = {})
+      data, _status_code, _headers = issues_search_with_http_info(issues_search_request, opts)
+      data
+    end
+
+    # Search for an Issue
+    # Search for an issue associated with one of the following identifiers:  &#x60;item_id&#x60;, &#x60;link_session_id&#x60; or Link session &#x60;request_id&#x60;.  This endpoint returns a list of &#x60;Issue&#x60; objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.
+    # @param issues_search_request [IssuesSearchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IssuesSearchResponse, Integer, Hash)>] IssuesSearchResponse data, response status code and response headers
+    def issues_search_with_http_info(issues_search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.issues_search ...'
+      end
+      # verify the required parameter 'issues_search_request' is set
+      if @api_client.config.client_side_validation && issues_search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'issues_search_request' when calling PlaidApi.issues_search"
+      end
+      # resource path
+      local_var_path = '/issues/search'
+
+      # 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(issues_search_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IssuesSearchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.issues_search",
+        :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#issues_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Subscribe to an Issue
+    # Allows a user to subscribe to updates on a specific `Issue` using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved.
+    # @param issues_subscribe_request [IssuesSubscribeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [IssuesSubscribeResponse]
+    def issues_subscribe(issues_subscribe_request, opts = {})
+      data, _status_code, _headers = issues_subscribe_with_http_info(issues_subscribe_request, opts)
+      data
+    end
+
+    # Subscribe to an Issue
+    # Allows a user to subscribe to updates on a specific &#x60;Issue&#x60; using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved.
+    # @param issues_subscribe_request [IssuesSubscribeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IssuesSubscribeResponse, Integer, Hash)>] IssuesSubscribeResponse data, response status code and response headers
+    def issues_subscribe_with_http_info(issues_subscribe_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.issues_subscribe ...'
+      end
+      # verify the required parameter 'issues_subscribe_request' is set
+      if @api_client.config.client_side_validation && issues_subscribe_request.nil?
+        fail ArgumentError, "Missing the required parameter 'issues_subscribe_request' when calling PlaidApi.issues_subscribe"
+      end
+      # resource path
+      local_var_path = '/issues/subscribe'
+
+      # 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(issues_subscribe_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IssuesSubscribeResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.issues_subscribe",
+        :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#issues_subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Invalidate access_token
     # By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner.  You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`. 
     # @param item_access_token_invalidate_request [ItemAccessTokenInvalidateRequest] 
@@ -9527,7 +9799,7 @@ module Plaid
     end
 
     # Create a payment
-    # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient.  Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency).  If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day.  Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.  In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported. 
+    # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient.  Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency).  If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day.  Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.  In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
     # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [PaymentInitiationPaymentCreateResponse]
@@ -9537,7 +9809,7 @@ module Plaid
     end
 
     # Create a payment
-    # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient.  Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency).  If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day.  Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.  In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported. 
+    # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient.  Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency).  If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day.  Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.  In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
     # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -14831,7 +15103,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. 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`. 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`.
     # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransferCapabilitiesGetResponse]
@@ -14841,7 +15113,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. 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;. 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;.
     # @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
@@ -15307,7 +15579,7 @@ module Plaid
     end
 
     # Retrieve a transfer
-    # The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
+    # The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id` or `authorization_id`. One of `transfer_id` or `authorization_id` must be populated but not both.
     # @param transfer_get_request [TransferGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransferGetResponse]
@@ -15317,7 +15589,7 @@ module Plaid
     end
 
     # Retrieve a transfer
-    # The &#x60;/transfer/get&#x60; endpoint fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
+    # The &#x60;/transfer/get&#x60; endpoint fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60; or &#x60;authorization_id&#x60;. One of &#x60;transfer_id&#x60; or &#x60;authorization_id&#x60; must be populated but not both.
     # @param transfer_get_request [TransferGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
@@ -16326,6 +16598,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Submit onboarding requirements for Scaled Platform originators
+    # The `/transfer/platform/requirement/submit` endpoint allows platforms to submit onboarding requirements for an originator as part of the Scaled Platform Transfer offering.
+    # @param transfer_platform_requirement_submit_request [TransferPlatformRequirementSubmitRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [TransferPlatformRequirementSubmitResponse]
+    def transfer_platform_requirement_submit(transfer_platform_requirement_submit_request, opts = {})
+      data, _status_code, _headers = transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts)
+      data
+    end
+
+    # Submit onboarding requirements for Scaled Platform originators
+    # The &#x60;/transfer/platform/requirement/submit&#x60; endpoint allows platforms to submit onboarding requirements for an originator as part of the Scaled Platform Transfer offering.
+    # @param transfer_platform_requirement_submit_request [TransferPlatformRequirementSubmitRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TransferPlatformRequirementSubmitResponse, Integer, Hash)>] TransferPlatformRequirementSubmitResponse data, response status code and response headers
+    def transfer_platform_requirement_submit_with_http_info(transfer_platform_requirement_submit_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_platform_requirement_submit ...'
+      end
+      # verify the required parameter 'transfer_platform_requirement_submit_request' is set
+      if @api_client.config.client_side_validation && transfer_platform_requirement_submit_request.nil?
+        fail ArgumentError, "Missing the required parameter 'transfer_platform_requirement_submit_request' when calling PlaidApi.transfer_platform_requirement_submit"
+      end
+      # resource path
+      local_var_path = '/transfer/platform/requirement/submit'
+
+      # 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_platform_requirement_submit_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TransferPlatformRequirementSubmitResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.transfer_platform_requirement_submit",
+        :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_platform_requirement_submit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Generate a Plaid-hosted onboarding UI URL.
     # The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
     # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest] 

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.556.0
+The version of the OpenAPI document: 2020-09-14_1.565.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -41,7 +41,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 v31.0.0"
+      @user_agent = "Plaid Ruby v32.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.556.0
+The version of the OpenAPI document: 2020-09-14_1.565.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.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.556.0
+The version of the OpenAPI document: 2020-09-14_1.565.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.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.556.0
+The version of the OpenAPI document: 2020-09-14_1.565.0
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0

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