plaid 24.2.0 → 24.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd6f739a1f852a87bb85ffa351831a01e47b631ad122b9a8105071a14411aab1
-  data.tar.gz: dcf5b389f29514d3e44e36084af5834476585fee1a44e490a5d74eb32f5fc19c
+  metadata.gz: 1afa00db99ae9e3b1c619b2d55386e983963a40ecfa32fe0f34051f46f5ed959
+  data.tar.gz: d236c762f035f5c06dbf7d5eaf1c687d86a5e08ca4991a226423f5466aeafc1c
 SHA512:
-  metadata.gz: 5b902929380b8fb0d1e1bd6f44c27a7ef0adba9538346f64f123a99764603467d8e84ae78317e074a59c92a85dc14d5363e506817c8dabe8b5c1ffed81a0c214
-  data.tar.gz: 384eb76ea7e7c7df3e672773d6de589b19c5024a256d0011411e844b85a1dc39d2563584affbe45be1f87d19ce5bf9c1a3f623fb09aca3917d6b93ef21c24281
+  metadata.gz: 198e83c3cd6b92f5fa44b99abb8278138143f0ed5318f969ba5346402859b899fe20e0446097afbd094a949dd6ea63b90dd19f8717c4c32bf1606e33706bdbad
+  data.tar.gz: '03594f758364f0a2f04788a9f634e607da1cf4277872994c5ab618b4b1f54deade230dd22d578b73198afeff6843626b442f7075f33752447e418f1ae2cacd35'

data/CHANGELOG.md

@@ -1,5 +1,82 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 24.3.0
+
+- Updating to OAS 2020-09-14_1.482.3
+- Fix bug in error handling (https://github.com/plaid/plaid-ruby/issues/481) introduced in 24.1.0
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.482.3
+- Update `description` description for `/transfer/create`
+
+### 2020-09-14_1.482.2
+- Update /credit/relay/get response example
+
+### 2020-09-14_1.482.1
+- Update `funding_account_id` description for `/transfer/intent/create`
+
+### 2020-09-14_1.482.0
+- Adds a new field `payment_details` to `/accounts/balance/get` request
+- Adds a new field `payment_risk_assessment` to `/accounts/balance/get` response
+
+### 2020-09-14_1.481.1
+- Update `USER_ACCOUNT_REVOKED` description and set to visible
+
+### 2020-09-14_1.481.0
+- Add `available` to balance object in `wallet/get` and `wallet/list` response
+
+### 2020-09-14_1.480.1
+- Documentation-only change to Investments `Security` object for new fields and sandbox availability
+
+### 2020-09-14_1.480.0
+- Add `phone_number` to `/transactions/enrich` response
+
+### 2020-09-14_1.479.0
+- [Breaking change for Go client library] Make `street` and `city` optional in the address attribute of `identity_verification/create`
+
+### 2020-09-14_1.478.4
+- Add `registration_number` to `/partner/customer/create` request
+
+### 2020-09-14_1.478.3
+
+### 2020-09-14_1.478.2
+- Deprecate `funding_account_id` from `/transfer/recurring/create` request
+
+### 2020-09-14_1.478.1
+- Description-only changes to support Hosted Link (beta)
+
+### 2020-09-14_1.478.0
+- Add `market_identifier_code` and `option_contract` fields in the Security (investment) object
+- `option_contract` object contains `contract_type`, `expiration_date`, `strike_price`, and `underlying_security_ticker`
+
+### 2020-09-14_1.477.1
+- Changes `last_user_modified_date` to `last_user_modified_datetime` on transaction stream object.
+
+### 2020-09-14_1.477.0
+- Bug fix nullability definitions for `/beacon/user/create` and `/beacon/user/update` request payloads
+
+### 2020-09-14_1.476.1
+- Update Recurring Transaction description
+
+### 2020-09-14_1.476.0
+- Add `/beacon/user/update`
+
+### 2020-09-14_1.475.0
+- Add `/beacon/report_syndication/get` route
+
+### 2020-09-14_1.474.4
+- Add Statements Refresh webhook
+
+### 2020-09-14_1.474.3
+- Internal changes only
+
+### 2020-09-14_1.474.2
+- Deprecate `credit_funds_source` in `/transfer/authorization/create` request
+
+### 2020-09-14_1.474.1
+
+- Added `identity_match` to Products schema object
+
 # 24.2.0
 
 - Updating to OAS 2020-09-14_1.474.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (24.2.0)
+    plaid (24.3.0)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart (>= 1.0.1, < 2.0)
 
@@ -12,7 +12,7 @@ GEM
     base64 (0.2.0)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    faraday (2.7.12)
+    faraday (2.8.0)
       base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)

data/Makefile

@@ -1,5 +1,5 @@
 # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
-RUBY_PACKAGE_VERSION=24.2.0
+RUBY_PACKAGE_VERSION=24.3.0
 
 .PHONY: release
 release:

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.474.0
+The version of the OpenAPI document: 2020-09-14_1.482.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -1719,6 +1719,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Get a Beacon Report
+    # Returns a Beacon report for a given Beacon report id.
+    # @param beacon_report_get_request [BeaconReportGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BeaconReportGetResponse]
+    def beacon_report_get(beacon_report_get_request, opts = {})
+      data, _status_code, _headers = beacon_report_get_with_http_info(beacon_report_get_request, opts)
+      data
+    end
+
+    # Get a Beacon Report
+    # Returns a Beacon report for a given Beacon report id.
+    # @param beacon_report_get_request [BeaconReportGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BeaconReportGetResponse, Integer, Hash)>] BeaconReportGetResponse data, response status code and response headers
+    def beacon_report_get_with_http_info(beacon_report_get_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_get ...'
+      end
+      # verify the required parameter 'beacon_report_get_request' is set
+      if @api_client.config.client_side_validation && beacon_report_get_request.nil?
+        fail ArgumentError, "Missing the required parameter 'beacon_report_get_request' when calling PlaidApi.beacon_report_get"
+      end
+      # resource path
+      local_var_path = '/beacon/report/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(beacon_report_get_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BeaconReportGetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.beacon_report_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#beacon_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      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] 
@@ -1787,6 +1855,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Get a Beacon Report Syndication
+    # Returns a Beacon Report Syndication for a given Beacon Report Syndication id.
+    # @param beacon_report_syndication_get_request [BeaconReportSyndicationGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BeaconReportSyndicationGetResponse]
+    def beacon_report_syndication_get(beacon_report_syndication_get_request, opts = {})
+      data, _status_code, _headers = beacon_report_syndication_get_with_http_info(beacon_report_syndication_get_request, opts)
+      data
+    end
+
+    # Get a Beacon Report Syndication
+    # Returns a Beacon Report Syndication for a given Beacon Report Syndication id.
+    # @param beacon_report_syndication_get_request [BeaconReportSyndicationGetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BeaconReportSyndicationGetResponse, Integer, Hash)>] BeaconReportSyndicationGetResponse data, response status code and response headers
+    def beacon_report_syndication_get_with_http_info(beacon_report_syndication_get_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_syndication_get ...'
+      end
+      # verify the required parameter 'beacon_report_syndication_get_request' is set
+      if @api_client.config.client_side_validation && beacon_report_syndication_get_request.nil?
+        fail ArgumentError, "Missing the required parameter 'beacon_report_syndication_get_request' when calling PlaidApi.beacon_report_syndication_get"
+      end
+      # resource path
+      local_var_path = '/beacon/report_syndication/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(beacon_report_syndication_get_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BeaconReportSyndicationGetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.beacon_report_syndication_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#beacon_report_syndication_get\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] 
@@ -2059,6 +2195,74 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Update the identity data of a Beacon User
+    # Update the identity data for a Beacon User in your Beacon Program.  Similar to `/beacon/user/create`, several checks are performed immediately when you submit a change to `/beacon/user/update`:    - The user's updated PII 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 updated 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.  Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
+    # @param beacon_user_update_request [BeaconUserUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BeaconUserUpdateResponse]
+    def beacon_user_update(beacon_user_update_request, opts = {})
+      data, _status_code, _headers = beacon_user_update_with_http_info(beacon_user_update_request, opts)
+      data
+    end
+
+    # Update the identity data of a Beacon User
+    # Update the identity data for a Beacon User in your Beacon Program.  Similar to &#x60;/beacon/user/create&#x60;, several checks are performed immediately when you submit a change to &#x60;/beacon/user/update&#x60;:    - The user&#39;s updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;.    - The user&#39;s updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;.    - Finally, the user&#39;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 &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud.  Plaid maintains a version history for each Beacon User, so the Beacon User&#39;s identity data before and after the update is retained as separate versions.
+    # @param beacon_user_update_request [BeaconUserUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BeaconUserUpdateResponse, Integer, Hash)>] BeaconUserUpdateResponse data, response status code and response headers
+    def beacon_user_update_with_http_info(beacon_user_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_update ...'
+      end
+      # verify the required parameter 'beacon_user_update_request' is set
+      if @api_client.config.client_side_validation && beacon_user_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'beacon_user_update_request' when calling PlaidApi.beacon_user_update"
+      end
+      # resource path
+      local_var_path = '/beacon/user/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(beacon_user_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BeaconUserUpdateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.beacon_user_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#beacon_user_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get categories
     # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.  All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
     # @param body [Object] 
@@ -9948,7 +10152,7 @@ module Plaid
     end
 
     # Set verification status for Sandbox account
-    # The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.  Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access).  For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
+    # The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.  For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
     # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SandboxItemSetVerificationStatusResponse]
@@ -9958,7 +10162,7 @@ module Plaid
     end
 
     # Set verification status for Sandbox account
-    # The &#x60;/sandbox/item/set_verification_status&#x60; endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.  Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access).  For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
+    # The &#x60;/sandbox/item/set_verification_status&#x60; endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.  For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
     # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
@@ -11716,7 +11920,7 @@ module Plaid
     end
 
     # Fetch recurring transaction streams
-    # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.  This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.  This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook.  After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
+    # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.  This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.  This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). For optimal results, we strongly recommend customers using Recurring Transactions to request at least 180 days of history when initializing items with Transactions (using the [`days_requested`](https://plaid.com/docs/api/tokens/#link-token-create-request-transactions-days-requested) option). Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook.  After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
     # @param transactions_recurring_get_request [TransactionsRecurringGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TransactionsRecurringGetResponse]
@@ -11726,7 +11930,7 @@ module Plaid
     end
 
     # Fetch recurring transaction streams
-    # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.  This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.  This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook.  After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
+    # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.  This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.  This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). For optimal results, we strongly recommend customers using Recurring Transactions to request at least 180 days of history when initializing items with Transactions (using the [&#x60;days_requested&#x60;](https://plaid.com/docs/api/tokens/#link-token-create-request-transactions-days-requested) option). Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook.  After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
     # @param transactions_recurring_get_request [TransactionsRecurringGetRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse 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.474.0
+The version of the OpenAPI document: 2020-09-14_1.482.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.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 v24.2.0"
+      @user_agent = "Plaid Ruby v24.3.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.474.0
+The version of the OpenAPI document: 2020-09-14_1.482.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -25,7 +25,6 @@ module Plaid
           super(arg[:message] || arg['message'])
         else
           super arg
-          @message = arg
         end
 
         arg.each do |k, v|
@@ -33,6 +32,7 @@ module Plaid
         end
       else
         super arg
+        @message = arg
       end
     end
 

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.474.0
+The version of the OpenAPI document: 2020-09-14_1.482.3
 
 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.474.0
+The version of the OpenAPI document: 2020-09-14_1.482.3
 
 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.474.0
+The version of the OpenAPI document: 2020-09-14_1.482.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0

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

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

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

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

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

data/lib/plaid/models/account_identity.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.474.0
+The version of the OpenAPI document: 2020-09-14_1.482.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -43,6 +43,9 @@ module Plaid
     # Data returned by the financial institution about the account owner or owners. Only returned by Identity or Assets endpoints. For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution; detecting whether the linked account is a business account is not currently supported. Multiple owners on a single account will be represented in the same `owner` object, not in multiple owner objects within the array. In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29)
     attr_accessor :owners
 
+    # Array of documents that identity data is dervied from. This array will be empty if none of the account identity is from a document.
+    attr_accessor :documents
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -77,7 +80,8 @@ module Plaid
         :'subtype' => :'subtype',
         :'verification_status' => :'verification_status',
         :'persistent_account_id' => :'persistent_account_id',
-        :'owners' => :'owners'
+        :'owners' => :'owners',
+        :'documents' => :'documents'
       }
     end
 
@@ -98,7 +102,8 @@ module Plaid
         :'subtype' => :'AccountSubtype',
         :'verification_status' => :'String',
         :'persistent_account_id' => :'String',
-        :'owners' => :'Array<Owner>'
+        :'owners' => :'Array<Owner>',
+        :'documents' => :'Array<IdentityDocument>'
       }
     end
 
@@ -175,6 +180,12 @@ module Plaid
           self.owners = value
         end
       end
+
+      if attributes.key?(:'documents')
+        if (value = attributes[:'documents']).is_a?(Array)
+          self.documents = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -241,7 +252,8 @@ module Plaid
           subtype == o.subtype &&
           verification_status == o.verification_status &&
           persistent_account_id == o.persistent_account_id &&
-          owners == o.owners
+          owners == o.owners &&
+          documents == o.documents
     end
 
     # @see the `==` method
@@ -253,7 +265,7 @@ module Plaid
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, balances, mask, name, official_name, type, subtype, verification_status, persistent_account_id, owners].hash
+      [account_id, balances, mask, name, official_name, type, subtype, verification_status, persistent_account_id, owners, documents].hash
     end
 
     # Builds the object from hash