plaid 14.1.0 → 14.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78d707a9478be29160a0a732af7e85555674d4f564201ae363590ff5003debdd
-  data.tar.gz: '083baef42424e0b7fc5d291579017c6289ff7f0281886ec69481398aea320c6f'
+  metadata.gz: 5a8855db141e741845f2892fa49e37c5277e504f40dda5509adcc20e9900c735
+  data.tar.gz: a3309865997f353177f7ce337a227d60b713ca6b4d05ba0c1c96efcb45382830
 SHA512:
-  metadata.gz: fc71e7d030eef17daa4af9bc5161240d1b0f2c18d5274578d941b9da328d9facf8d4f0a70e192a0e6011d850e184eccbacf0bfeaf81eb1c93a41250def8bd653
-  data.tar.gz: 6e2634b7e048a35909f092a2b01f57bb9796dd650cd375bbefd88d503dae028815bc366415fb139b9be89dff66d20c3de476a96354331eb48153bcadda19be68
+  metadata.gz: 8281e08f7f87def1b526741f49145fe24260e0066e27c41ffeec72be3bbb1510ae18c332bd832435ac56faf14d21fc7ea3b5ead00606a2836cf6e4ce3920c0e0
+  data.tar.gz: 34ca5a4c5673f9237288d33cdf3fa4017ed7ba6a11f6851b2abad04024924cdfe33271a32d13060323275314d7ddba7b3846b660643aa1aca084cb573fa6c73a

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
 
+# 14.2.0
+Updating to OAS 2020-09-14_1.31.1.
+
 # 14.1.0
 Updating to OAS 2020-09-14_1.26.1.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plaid (14.1.0)
+    plaid (14.2.0)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM

data/Makefile

@@ -1,2 +1,2 @@
 # Ruby embeds the version in the generator where as others don't so it's not possible to cat for it.
-RUBY_PACKAGE_VERSION=14.1.0
+RUBY_PACKAGE_VERSION=14.2.0

data/README.md

@@ -115,7 +115,7 @@ An example of the function's usage if you have a `public_token` in hand:
 request = Plaid::ItemPublicTokenExchangeRequest.new
 request.public_token = public_token
 
-response = client.item.public_token_exchange(request)
+response = client.item_public_token_exchange(request)
 access_token = response.access_token
 ```
 
@@ -125,7 +125,7 @@ access_token = response.access_token
 request = Plaid::ItemPublicTokenExchangeRequest.new
 request.public_token = public_token
 
-response = client.item.public_token_exchange(request)
+response = client.item_public_token_exchange(request)
 access_token = response.access_token
 
 # Provide the access_token for the Item you want to remove
@@ -140,7 +140,7 @@ client.item_remove(item_remove_request)
 request = Plaid::ItemPublicTokenExchangeRequest.new
 request.public_token = public_token
 
-response = client.item.public_token_exchange(request)
+response = client.item_public_token_exchange(request)
 access_token = response.access_token
 
 transactions_get_request = Plaid::TransactionsGetRequest.new
@@ -175,7 +175,7 @@ If you have an `access_token`, you can use following code to retreive data:
 request = Plaid::ItemPublicTokenExchangeRequest.new
 request.public_token = public_token
 
-response = client.item.public_token_exchange(request)
+response = client.item_public_token_exchange(request)
 access_token = response.access_token
 
 auth_get_request = Plaid::AuthGetRequest.new
@@ -204,7 +204,7 @@ Exchange a Plaid Link `public_token` for an API `access_token` and a Stripe `ban
 request = Plaid::ItemPublicTokenExchangeRequest.new
 request.public_token = public_token
 
-response = client.item.public_token.exchange(request)
+response = client.item_public_token_exchange(request)
 access_token = response.access_token
 
 processor_token_create_request = Plaid::ProcessorStripeBankAccountTokenCreateRequest.new

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.26.1
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -1449,6 +1449,71 @@ module Plaid
       return data, status_code, headers
     end
 
+    # List sweeps
+    # The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
+    # @param bank_transfer_sweep_list_request [BankTransferSweepListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BankTransferSweepListResponse]
+    def bank_transfer_sweep_list(bank_transfer_sweep_list_request, opts = {})
+      data, _status_code, _headers = bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts)
+      data
+    end
+
+    # List sweeps
+    # The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
+    # @param bank_transfer_sweep_list_request [BankTransferSweepListRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BankTransferSweepListResponse, Integer, Hash)>] BankTransferSweepListResponse data, response status code and response headers
+    def bank_transfer_sweep_list_with_http_info(bank_transfer_sweep_list_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.bank_transfer_sweep_list ...'
+      end
+      # verify the required parameter 'bank_transfer_sweep_list_request' is set
+      if @api_client.config.client_side_validation && bank_transfer_sweep_list_request.nil?
+        fail ArgumentError, "Missing the required parameter 'bank_transfer_sweep_list_request' when calling PlaidApi.bank_transfer_sweep_list"
+      end
+      # resource path
+      local_var_path = '/bank_transfer/sweep/list'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(bank_transfer_sweep_list_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BankTransferSweepListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.bank_transfer_sweep_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PlaidApi#bank_transfer_sweep_list\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.
     # @param body [Object] 
@@ -2102,16 +2167,16 @@ module Plaid
     # (Deprecated) Retrieve information from a single paystub used for income verification
     # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [IncomeVerificationPaystubGetResponse]
     def income_verification_paystub_get(income_verification_paystub_get_request, opts = {})
-      income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts)
-      nil
+      data, _status_code, _headers = income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts)
+      data
     end
 
     # (Deprecated) Retrieve information from a single paystub used for income verification
     # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(IncomeVerificationPaystubGetResponse, Integer, Hash)>] IncomeVerificationPaystubGetResponse data, response status code and response headers
     def income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
@@ -2140,7 +2205,7 @@ module Plaid
       post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystub_get_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubGetResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -2227,6 +2292,71 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Check a user's eligibility for the income verification product
+    # `/income/verification/precheck` returns whether a given user is supportable by the income product
+    # @param income_verification_precheck_request [IncomeVerificationPrecheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [IncomeVerificationPrecheckResponse]
+    def income_verification_precheck(income_verification_precheck_request, opts = {})
+      data, _status_code, _headers = income_verification_precheck_with_http_info(income_verification_precheck_request, opts)
+      data
+    end
+
+    # Check a user&#39;s eligibility for the income verification product
+    # &#x60;/income/verification/precheck&#x60; returns whether a given user is supportable by the income product
+    # @param income_verification_precheck_request [IncomeVerificationPrecheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IncomeVerificationPrecheckResponse, Integer, Hash)>] IncomeVerificationPrecheckResponse data, response status code and response headers
+    def income_verification_precheck_with_http_info(income_verification_precheck_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_precheck ...'
+      end
+      # verify the required parameter 'income_verification_precheck_request' is set
+      if @api_client.config.client_side_validation && income_verification_precheck_request.nil?
+        fail ArgumentError, "Missing the required parameter 'income_verification_precheck_request' when calling PlaidApi.income_verification_precheck"
+      end
+      # resource path
+      local_var_path = '/income/verification/precheck'
+
+      # 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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_precheck_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IncomeVerificationPrecheckResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.income_verification_precheck",
+        :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#income_verification_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Refresh an income verification
     # `/income/verification/refresh` refreshes a given income verification.
     # @param income_verification_refresh_request [IncomeVerificationRefreshRequest] 
@@ -3722,6 +3852,71 @@ module Plaid
       return data, status_code, headers
     end
 
+    # Reverse an existing payment
+    # Reverse a previously initiated payment.  A payment can only be reversed once and will be refunded to the original sender's account. 
+    # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PaymentInitiationPaymentReverseResponse]
+    def payment_initiation_payment_reverse(payment_initiation_payment_reverse_request, opts = {})
+      data, _status_code, _headers = payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts)
+      data
+    end
+
+    # Reverse an existing payment
+    # Reverse a previously initiated payment.  A payment can only be reversed once and will be refunded to the original sender&#39;s account. 
+    # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
+    def payment_initiation_payment_reverse_with_http_info(payment_initiation_payment_reverse_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_payment_reverse ...'
+      end
+      # verify the required parameter 'payment_initiation_payment_reverse_request' is set
+      if @api_client.config.client_side_validation && payment_initiation_payment_reverse_request.nil?
+        fail ArgumentError, "Missing the required parameter 'payment_initiation_payment_reverse_request' when calling PlaidApi.payment_initiation_payment_reverse"
+      end
+      # resource path
+      local_var_path = '/payment_initiation/payment/reverse'
+
+      # 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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_payment_reverse_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaymentInitiationPaymentReverseResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
+
+      new_options = opts.merge(
+        :operation => :"PlaidApi.payment_initiation_payment_reverse",
+        :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#payment_initiation_payment_reverse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create payment recipient
     # Create a payment recipient for payment initiation.  The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA).  For a standing order (recurring) payment, the recipient must be in the UK.  The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`. 
     # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest] 

data/lib/plaid/api_client.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.26.1
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -30,11 +30,10 @@ 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 v#{VERSION}"
+      @user_agent = "Plaid Ruby v#"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent,
-        'Plaid-Version' => '2020-09-14',
       }
     end
 
@@ -72,7 +71,8 @@ module Plaid
           else
             fail ApiError.new(:code => response.status,
                               :response_headers => response.headers,
-                              :response_body => response.body),
+                              :response_body => response.body,
+                              :data => JSON.parse(response.body)),
                  response.reason_phrase
           end
         end

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.26.1
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -12,7 +12,7 @@ OpenAPI Generator version: 5.1.0
 
 module Plaid
   class ApiError < StandardError
-    attr_reader :code, :response_headers, :response_body
+    attr_reader :code, :response_headers, :response_body, :data
 
     # Usage examples:
     #   ApiError.new
@@ -54,4 +54,4 @@ module Plaid
       msg
     end
   end
-end
+end

data/lib/plaid/configuration.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.26.1
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -145,7 +145,9 @@ module Plaid
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
-      @api_key = {}
+      @api_key = {
+        'Plaid-Version' => '2020-09-14',
+      }
       @api_key_prefix = {}
       @timeout = 0
       @client_side_validation = true

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.26.1
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.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.26.1
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.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.26.1
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.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.26.1
+The version of the OpenAPI document: 2020-09-14_1.31.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.1.0
@@ -16,10 +16,10 @@ require 'time'
 module Plaid
   # A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by `/accounts/balance/get`.
   class AccountBalance
-    # The amount of funds available to be withdrawn from the account, as determined by the financial institution.  For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows.  For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit.  For `investment`-type accounts, the `available` balance is the total cash available to withdraw as presented by the institution.  Note that not all institutions calculate the `available`  balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`.  Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`.
+    # The amount of funds available to be withdrawn from the account, as determined by the financial institution.  For `credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows.  For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit.  For `investment`-type accounts, the `available` balance is the total cash available to withdraw as presented by the institution.  Note that not all institutions calculate the `available`  balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`.  Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`.  If `current` is `null` this field is guaranteed not to be `null`.
     attr_accessor :available
 
-    # The total amount of funds in or owed by the account.  For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.  For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.  For `investment`-type accounts, the current balance is the total value of assets as presented by the institution.  Note that balance information may be cached unless the value was returned by `/accounts/balance/get`; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`.
+    # The total amount of funds in or owed by the account.  For `credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.  For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.  For `investment`-type accounts, the current balance is the total value of assets as presented by the institution.  Note that balance information may be cached unless the value was returned by `/accounts/balance/get`; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`.  When returned by `/accounts/balance/get`, this field may be `null`. When this happens, `available` is guaranteed not to be `null`.
     attr_accessor :current
 
     # For `credit`-type accounts, this represents the credit limit.  For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.  In North America, this field is typically only available for `credit`-type accounts.