Contents

module Plaid
  # Public: Class used to call the Auth product.
  class Auth < BaseProduct
    # Public: Get information about account and routing numbers for checking
    # and savings accounts.
    #
    # Does a POST /auth/get call which returns high level account information
    # along with account and routing numbers for checking and savings
    # accounts.
    #
    # access_token - access_token who's item to fetch Auth for.
    # account_ids  - Specific account ids to fetch numbers for (optional).
    # options      - Additional options to merge into API request.
    #
    # Returns AuthResponse.
    def get(access_token, account_ids: nil, options: nil)
      post_with_auth 'auth/get',
                     AuthResponse,
                     build_payload(access_token,
                                   account_ids: account_ids,
                                   options: options)
    end
  end

  # Public: Response wrapper for /accounts/get and /accounts/balance/get
  class AuthResponse < Models::BaseResponse
    ##
    # :attr_reader:
    # Public: The list of accounts: Array of Plaid::Models::Account.
    property :accounts, coerce: Array[Models::Account]

    ##
    # :attr_reader:
    # Public: The item: Plaid::Models::Numbers.
    property :numbers, coerce: Models::Numbers

    ##
    # :attr_reader:
    # Public: The item: Plaid::Models::Item.
    property :item, coerce: Models::Item
  end
end

Version data entries

29 entries across 29 versions & 1 rubygems

Version	Path
plaid-8.0.0	lib/plaid/products/auth.rb
plaid-7.0.0	lib/plaid/products/auth.rb
plaid-6.3.1	lib/plaid/products/auth.rb
plaid-7.0.0.rc0	lib/plaid/products/auth.rb
plaid-6.3.0	lib/plaid/products/auth.rb
plaid-6.2.1	lib/plaid/products/auth.rb
plaid-6.2.0	lib/plaid/products/auth.rb
plaid-6.1.0	lib/plaid/products/auth.rb
plaid-6.0.0	lib/plaid/products/auth.rb