OpenAPI generated code at 2025-05-01T20:00:07Z

.openapi-generator/FILES

@@ -227,6 +227,8 @@ docs/BeaconUserStatusUpdatedWebhook.md
 docs/BeaconUserUpdateRequest.md
 docs/BeaconUserUpdateRequestData.md
 docs/BeaconUserUpdateResponse.md
+docs/BusinessAccount.md
+docs/BusinessAccountAllOf.md
 docs/BusinessFinanceCategory.md
 docs/CRALoansRegisterRequest.md
 docs/CashFlowUpdatesExpectedDepositMissedWebhook.md
@@ -959,6 +961,16 @@ docs/NumbersInternational.md
 docs/NumbersInternationalIBAN.md
 docs/NumbersInternationalNullable.md
 docs/NumbersRetirement401k.md
+docs/OAuthErrorCode.md
+docs/OAuthErrorResponse.md
+docs/OAuthGrantType.md
+docs/OAuthIntrospectRequest.md
+docs/OAuthIntrospectResponse.md
+docs/OAuthRevokeRequest.md
+docs/OAuthRevokeResponse.md
+docs/OAuthSubjectTokenType.md
+docs/OAuthTokenRequest.md
+docs/OAuthTokenResponse.md
 docs/OmittableTransferType.md
 docs/OptionContract.md
 docs/OriginatingFundSource.md
@@ -1997,6 +2009,8 @@ lib/plaid/models/beacon_user_status_updated_webhook.rb
 lib/plaid/models/beacon_user_update_request.rb
 lib/plaid/models/beacon_user_update_request_data.rb
 lib/plaid/models/beacon_user_update_response.rb
+lib/plaid/models/business_account.rb
+lib/plaid/models/business_account_all_of.rb
 lib/plaid/models/business_finance_category.rb
 lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb
 lib/plaid/models/cash_flow_updates_insights_webhook.rb
@@ -2729,6 +2743,16 @@ lib/plaid/models/numbers_international.rb
 lib/plaid/models/numbers_international_iban.rb
 lib/plaid/models/numbers_international_nullable.rb
 lib/plaid/models/numbers_retirement401k.rb
+lib/plaid/models/o_auth_error_code.rb
+lib/plaid/models/o_auth_error_response.rb
+lib/plaid/models/o_auth_grant_type.rb
+lib/plaid/models/o_auth_introspect_request.rb
+lib/plaid/models/o_auth_introspect_response.rb
+lib/plaid/models/o_auth_revoke_request.rb
+lib/plaid/models/o_auth_revoke_response.rb
+lib/plaid/models/o_auth_subject_token_type.rb
+lib/plaid/models/o_auth_token_request.rb
+lib/plaid/models/o_auth_token_response.rb
 lib/plaid/models/omittable_transfer_type.rb
 lib/plaid/models/option_contract.rb
 lib/plaid/models/originating_fund_source.rb

CHANGELOG.md

@@ -1,5 +1,34 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 38.0.0
+- Updating to OAS 2020-09-14_1.635.2
+
+## Breaking changes in this version
+- [BREAKING] Move `result` from `triggered_rule_details` to `ruleset` in response of `/signal/evaluate`
+- [BREAKING] `client_user_id` is now required for `/session/token/create`
+
+## OpenAPI Schema Changes
+### 2020-09-14_1.635.2
+- Update description of `ruleset.outcome` in `/signal/evaluate` response
+
+### 2020-09-14_1.635.1
+- Fix description undeprecating `report.items.accounts.attributes` after it was mistakenly deprecated for `/cra/check_report/base_report/get`
+
+### 2020-09-14_1.635.0
+- Add `expected_funds_available_date` to `transfer` and `sweep` objects in responses for `/transfer/create`, `/transfer/get`, `/transfer/list`, `/transfer/sweep/get`, `/transfer/sweep/list`
+
+### 2020-09-14_1.634.3
+- Undeprecated `report.items.accounts.attributes` after it was mistakenly deprecated for `/cra/check_report/base_report/get`
+
+### 2020-09-14_1.634.2
+- Removed `deposit_switch` from the `products` field in the `/link/token/create` request
+
+### 2020-09-14_1.634.1
+- [BREAKING] Move `result` from `triggered_rule_details` to `ruleset` in response of `/signal/evaluate`
+
+### 2020-09-14_1.634.0
+- [BREAKING] `client_user_id` is now required for `/session/token/create`
+
 # 37.0.0
 - Updating to OAS 2020-09-14_1.633.1
 

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=37.0.0
+RUBY_PACKAGE_VERSION=38.0.0
 
 .PHONY: release
 release:

lib/plaid.rb

@@ -3,7 +3,7 @@
 
 #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
 
-The version of the OpenAPI document: 2020-09-14_1.633.1
+The version of the OpenAPI document: 2020-09-14_1.635.2
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -246,6 +246,8 @@
 Plaid.autoload :BeaconUserUpdateRequest, 'plaid/models/beacon_user_update_request'
 Plaid.autoload :BeaconUserUpdateRequestData, 'plaid/models/beacon_user_update_request_data'
 Plaid.autoload :BeaconUserUpdateResponse, 'plaid/models/beacon_user_update_response'
+Plaid.autoload :BusinessAccount, 'plaid/models/business_account'
+Plaid.autoload :BusinessAccountAllOf, 'plaid/models/business_account_all_of'
 Plaid.autoload :BusinessFinanceCategory, 'plaid/models/business_finance_category'
 Plaid.autoload :CRALoansRegisterRequest, 'plaid/models/cra_loans_register_request'
 Plaid.autoload :CashFlowUpdatesExpectedDepositMissedWebhook, 'plaid/models/cash_flow_updates_expected_deposit_missed_webhook'
@@ -978,6 +980,16 @@
 Plaid.autoload :NumbersInternationalIBAN, 'plaid/models/numbers_international_iban'
 Plaid.autoload :NumbersInternationalNullable, 'plaid/models/numbers_international_nullable'
 Plaid.autoload :NumbersRetirement401k, 'plaid/models/numbers_retirement401k'
+Plaid.autoload :OAuthErrorCode, 'plaid/models/o_auth_error_code'
+Plaid.autoload :OAuthErrorResponse, 'plaid/models/o_auth_error_response'
+Plaid.autoload :OAuthGrantType, 'plaid/models/o_auth_grant_type'
+Plaid.autoload :OAuthIntrospectRequest, 'plaid/models/o_auth_introspect_request'
+Plaid.autoload :OAuthIntrospectResponse, 'plaid/models/o_auth_introspect_response'
+Plaid.autoload :OAuthRevokeRequest, 'plaid/models/o_auth_revoke_request'
+Plaid.autoload :OAuthRevokeResponse, 'plaid/models/o_auth_revoke_response'
+Plaid.autoload :OAuthSubjectTokenType, 'plaid/models/o_auth_subject_token_type'
+Plaid.autoload :OAuthTokenRequest, 'plaid/models/o_auth_token_request'
+Plaid.autoload :OAuthTokenResponse, 'plaid/models/o_auth_token_response'
 Plaid.autoload :OmittableTransferType, 'plaid/models/omittable_transfer_type'
 Plaid.autoload :OptionContract, 'plaid/models/option_contract'
 Plaid.autoload :OriginatingFundSource, 'plaid/models/originating_fund_source'

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.633.1
+The version of the OpenAPI document: 2020-09-14_1.635.2
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -8914,6 +8914,210 @@ def network_status_get_with_http_info(network_status_get_request, opts = {})
       return data, status_code, headers
     end
 
+    # Get metadata about an OAuth token
+    # `/oauth/introspect` returns metadata about an access token or refresh token.  Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
+    # @param o_auth_introspect_request [OAuthIntrospectRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthIntrospectResponse]
+    def oauth_introspect(o_auth_introspect_request, opts = {})
+      data, _status_code, _headers = oauth_introspect_with_http_info(o_auth_introspect_request, opts)
+      data
+    end
+
+    # Get metadata about an OAuth token
+    # `/oauth/introspect` returns metadata about an access token or refresh token.  Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
+    # @param o_auth_introspect_request [OAuthIntrospectRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthIntrospectResponse, Integer, Hash)>] OAuthIntrospectResponse data, response status code and response headers
+    def oauth_introspect_with_http_info(o_auth_introspect_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_introspect ...'
+      end
+      # verify the required parameter 'o_auth_introspect_request' is set
+      if @api_client.config.client_side_validation && o_auth_introspect_request.nil?
+        fail ArgumentError, "Missing the required parameter 'o_auth_introspect_request' when calling PlaidApi.oauth_introspect"
+      end
+      # resource path
+      local_var_path = '/oauth/introspect'
+
+      # 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(o_auth_introspect_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthIntrospectResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.oauth_introspect",
+        :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#oauth_introspect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke an OAuth token
+    # `/oauth/revoke` revokes an access or refresh token, preventing any further use. If a refresh token is revoked, all access and refresh tokens derived from it are also revoked, including exchanged tokens.  Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
+    # @param o_auth_revoke_request [OAuthRevokeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthRevokeResponse]
+    def oauth_revoke(o_auth_revoke_request, opts = {})
+      data, _status_code, _headers = oauth_revoke_with_http_info(o_auth_revoke_request, opts)
+      data
+    end
+
+    # Revoke an OAuth token
+    # &#x60;/oauth/revoke&#x60; revokes an access or refresh token, preventing any further use. If a refresh token is revoked, all access and refresh tokens derived from it are also revoked, including exchanged tokens.  Note: This endpoint supports &#x60;Content-Type: application/x-www-form-urlencoded&#x60; as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
+    # @param o_auth_revoke_request [OAuthRevokeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthRevokeResponse, Integer, Hash)>] OAuthRevokeResponse data, response status code and response headers
+    def oauth_revoke_with_http_info(o_auth_revoke_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_revoke ...'
+      end
+      # verify the required parameter 'o_auth_revoke_request' is set
+      if @api_client.config.client_side_validation && o_auth_revoke_request.nil?
+        fail ArgumentError, "Missing the required parameter 'o_auth_revoke_request' when calling PlaidApi.oauth_revoke"
+      end
+      # resource path
+      local_var_path = '/oauth/revoke'
+
+      # 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(o_auth_revoke_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthRevokeResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.oauth_revoke",
+        :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#oauth_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create or refresh an OAuth access token
+    # `/oauth/token` issues an access token and refresh token depending on the `grant_type` provided:   - `refresh_token` allows refreshing an access token using a refresh token. Only the `refresh_token` field is required.   - `urn:ietf:params:oauth:grant-type:token-exchange` allows exchanging a subject token for an OAuth token. The following `subject_token_type`s are supported:     - `urn:plaid:params:tokensdb::user-token` allows exchanging a Plaid-issued user token for an OAuth token. `audience` must be the same as the `client_id`. `subject_token` must be a Plaid-issued user token issued from the `/user/create` endpoint.     - `urn:plaid:params:oauth::user-token` allows exchanging a refresh token for an OAuth token to another `client_id`. The other `client_id` is provided in `audience`. `subject_token` must be an OAuth refresh token issued from the `/oauth/token` endpoint.  Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
+    # @param o_auth_token_request [OAuthTokenRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthTokenResponse]
+    def oauth_token(o_auth_token_request, opts = {})
+      data, _status_code, _headers = oauth_token_with_http_info(o_auth_token_request, opts)
+      data
+    end
+
+    # Create or refresh an OAuth access token
+    # &#x60;/oauth/token&#x60; issues an access token and refresh token depending on the &#x60;grant_type&#x60; provided:   - &#x60;refresh_token&#x60; allows refreshing an access token using a refresh token. Only the &#x60;refresh_token&#x60; field is required.   - &#x60;urn:ietf:params:oauth:grant-type:token-exchange&#x60; allows exchanging a subject token for an OAuth token. The following &#x60;subject_token_type&#x60;s are supported:     - &#x60;urn:plaid:params:tokensdb::user-token&#x60; allows exchanging a Plaid-issued user token for an OAuth token. &#x60;audience&#x60; must be the same as the &#x60;client_id&#x60;. &#x60;subject_token&#x60; must be a Plaid-issued user token issued from the &#x60;/user/create&#x60; endpoint.     - &#x60;urn:plaid:params:oauth::user-token&#x60; allows exchanging a refresh token for an OAuth token to another &#x60;client_id&#x60;. The other &#x60;client_id&#x60; is provided in &#x60;audience&#x60;. &#x60;subject_token&#x60; must be an OAuth refresh token issued from the &#x60;/oauth/token&#x60; endpoint.  Note: This endpoint supports &#x60;Content-Type: application/x-www-form-urlencoded&#x60; as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
+    # @param o_auth_token_request [OAuthTokenRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthTokenResponse, Integer, Hash)>] OAuthTokenResponse data, response status code and response headers
+    def oauth_token_with_http_info(o_auth_token_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_token ...'
+      end
+      # verify the required parameter 'o_auth_token_request' is set
+      if @api_client.config.client_side_validation && o_auth_token_request.nil?
+        fail ArgumentError, "Missing the required parameter 'o_auth_token_request' when calling PlaidApi.oauth_token"
+      end
+      # resource path
+      local_var_path = '/oauth/token'
+
+      # 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(o_auth_token_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthTokenResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.oauth_token",
+        :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#oauth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Creates a new end customer for a Plaid reseller.
     # The `/partner/customer/create` endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, even when creating Sandbox API keys. If called in the Sandbox environment, it will return a sample response, but no customer will be created and the API keys will not be valid.
     # @param partner_customer_create_request [PartnerCustomerCreateRequest] 

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.633.1
+The version of the OpenAPI document: 2020-09-14_1.635.2
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.3.0
@@ -41,7 +41,7 @@ class ApiConnectionFailedError < ApiError; end
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Plaid Ruby v37.0.0"
+      @user_agent = "Plaid Ruby v38.0.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent,

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

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