plaid 13.2.0 → 14.0.0.beta.1

data/lib/plaid/products/identity.rb

@@ -1,31 +0,0 @@
-module Plaid
-  # Public: Class used to call the Identity product.
-  class Identity < BaseProduct
-    # Public: Get Identity information.
-    #
-    # Does a POST /identity/get call to retrieve all info for a given
-    # access_token's item.
-    #
-    # access_token - access_token who's item to fetch Identity data for.
-    #
-    # Returns the IdentityResponse object with Identity info.
-    def get(access_token)
-      post_with_auth 'identity/get',
-                     IdentityResponse,
-                     access_token: access_token
-    end
-  end
-
-  # Public: Response for /identity/get.
-  class IdentityResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The list of accounts: Array of Plaid::Models::Account.
-    property :accounts, coerce: Array[Models::AccountWithOwners]
-
-    ##
-    # :attr_reader:
-    # Public: The item: Plaid::Models::Item.
-    property :item, coerce: Models::Item
-  end
-end

data/lib/plaid/products/income.rb

@@ -1,31 +0,0 @@
-module Plaid
-  # Public: Class used to call the Income product.
-  class Income < BaseProduct
-    # Public: Get information about user incomes.
-    #
-    # Does a POST /income/get call which returns income info for an
-    # access_token's item.
-    #
-    # access_token - access_token whose item to fetch income for.
-    #
-    # Returns the IncomeResponse object with Income info.
-    def get(access_token)
-      post_with_auth 'income/get',
-                     IncomeResponse,
-                     access_token: access_token
-    end
-  end
-
-  # Public: Income product response.
-  class IncomeResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The item: Plaid::Models::Item.
-    property :item, coerce: Models::Item
-
-    ##
-    # :attr_reader:
-    # Public: Income information: Plaid::Models::Income.
-    property :income, coerce: Models::Income
-  end
-end

data/lib/plaid/products/institutions.rb

@@ -1,91 +0,0 @@
-module Plaid
-  # Public: Class used to call the Institutions product.
-  class Institutions < BaseProduct
-    # Public: Get information about Plaid institutions.
-    #
-    # Does a POST /institutions/get call pulls a list of supported Plaid
-    # institutions with the information for each institution.
-    #
-    # count   - Amount of institutions to pull.
-    # offset  - Offset to start pulling institutions.
-    # options - Options for filtering institutions.
-    #
-    # Returns a MultipleInstitutionsResponse instance.
-    def get(count:, offset:, country_codes:, options: nil)
-      payload = { count: count,
-                  offset: offset,
-                  country_codes: country_codes }
-      payload[:options] = options unless options.nil?
-
-      post_with_auth 'institutions/get',
-                     MultipleInstitutionsResponse,
-                     payload
-    end
-
-    # Public: Get information about a Plaid institution by ID.
-    #
-    # Does a POST /institutions/get_by_id call which allows you to pull
-    # information for an institution by ID.
-    #
-    # institution_id - Specific institution id to fetch information for.
-    # options - Options for filtering institutions.
-    #
-    # Returns a SingleInstitutionResponse instance.
-    def get_by_id(institution_id, country_codes, options: nil)
-      payload = {
-        institution_id: institution_id,
-        country_codes: country_codes
-      }
-      payload[:options] = options unless options.nil?
-      post_with_auth 'institutions/get_by_id',
-                     SingleInstitutionResponse,
-                     payload
-    end
-
-    # Public: Get information about all available institutions matching your
-    # query.
-    #
-    # Does a POST /institutions/search call which allows you to pull a list of
-    # institutions using a query parameter.
-    #
-    # query    - Search query to attempt to match institutions to.
-    # products - Product supported filter (optional).
-    # options - Options for filtering institutions.
-    #
-    # Returns a MultipleInstitutionsResponse instance.
-    def search(query, country_codes, products = nil, options: nil)
-      payload = {
-        query: query,
-        products: products,
-        country_codes: country_codes
-      }
-
-      payload[:options] = options unless options.nil?
-
-      post_with_auth 'institutions/search',
-                     MultipleInstitutionsResponse,
-                     payload
-    end
-  end
-
-  # Public: Response for institutions search returning a single institution.
-  class SingleInstitutionResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: Institution info: Plaid::Models::Institution.
-    property :institution, coerce: Models::Institution
-  end
-
-  # Public: Response for institutions search returning multiple institutions.
-  class MultipleInstitutionsResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: Institutions info: Array of Plaid::Models::Institution.
-    property :institutions, coerce: Array[Models::Institution]
-
-    ##
-    # :attr_reader:
-    # Public: The total number of search results.
-    property :total
-  end
-end

data/lib/plaid/products/investments.rb

@@ -1,127 +0,0 @@
-require 'date'
-
-module Plaid
-  # Public: Class used to get InvestmentTransactions for the Investments
-  # product.
-  class InvestmentTransactions < BaseProduct
-    # Public: Get information about all available investment transactions.
-    #
-    # Does a POST /investments/transactions/get call which gives you high level
-    # account data along with investment transactions and associated securities
-    # from all investment accounts contained in the access_token's item.
-    #
-    # access_token - access_token who's item to get investment transactions for.
-    # start_date   - Start of query for investment transactions.
-    # end_date     - End of query for investment transactions.
-    # account_ids  - Specific account ids to fetch transactions for (optional).
-    # count        - Amount of investment transactions to pull (optional).
-    # offset       - Offset to start pulling investment transactions (optional).
-    # options      - Additional options to merge into API request.
-    #
-    # Returns GetResponse.
-    def get(access_token, start_date, end_date,
-            account_ids: nil, count: nil, offset: nil, options: nil)
-
-      options_payload = {}
-      options_payload[:account_ids] = account_ids unless account_ids.nil?
-      options_payload[:count] = count unless count.nil?
-      options_payload[:offset] = offset unless offset.nil?
-      options_payload.merge!(options) unless options.nil?
-
-      post_with_auth 'investments/transactions/get',
-                     GetResponse,
-                     access_token: access_token,
-                     start_date: Plaid.convert_to_date_string(start_date),
-                     end_date: Plaid.convert_to_date_string(end_date),
-                     options: options_payload
-    end
-
-    # Public: Response for /investments/transactions/get.
-    class GetResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The item: Plaid::Models::Item.
-      property :item, coerce: Models::Item
-
-      ##
-      # :attr_reader:
-      # Public: The list of accounts: Array of Plaid::Models::Account.
-      property :accounts, coerce: Array[Models::Account]
-
-      ##
-      # :attr_reader:
-      # Public: The list of investment transactions: Array of
-      # Plaid::Models::InvestmentTransaction.
-      property :investment_transactions,
-               coerce: Array[Models::InvestmentTransaction]
-
-      ##
-      # :attr_reader:
-      # Public: The list of securities referenced by the investment
-      # transactions: Array of Plaid::Models::Security.
-      property :securities, coerce: Array[Models::Security]
-
-      ##
-      # :attr_reader:
-      # Public: The Numeric total investment transactions count.
-      property :total_investment_transactions
-    end
-  end
-
-  # Public: Class used to get Holdings for the Investments product.
-  class Holdings < BaseProduct
-    # Public: Get information about all available investment holdings.
-    #
-    # Does a POST /investments/holdings/get call which gives you high level
-    # account data along with investment holdings and associated securities
-    # from all investment accounts contained in the access_token's item.
-    #
-    # access_token - access_token who's item to fetch holdings for.
-    # account_ids  - Specific account ids to fetch holdings for (optional).
-    # options      - Additional options to merge into API request.
-    #
-    # Returns GetResponse.
-    def get(access_token, account_ids: nil, options: nil)
-      post_with_auth 'investments/holdings/get',
-                     GetResponse,
-                     build_payload(access_token,
-                                   account_ids: account_ids,
-                                   options: options)
-    end
-
-    # Public: Response for /investments/holdings/get.
-    class GetResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The item: Plaid::Models::Item.
-      property :item, coerce: Models::Item
-
-      ##
-      # :attr_reader:
-      # Public: The list of accounts: Array of Plaid::Models::Account.
-      property :accounts, coerce: Array[Models::Account]
-
-      ##
-      # :attr_reader:
-      # Public: The list of holdings: Array of Plaid::Models::Holding.
-      property :holdings, coerce: Array[Models::Holding]
-
-      ##
-      # :attr_reader:
-      # Public: The list of securities referenced by the holdings: Array of
-      # Plaid::Models::Security.
-      property :securities, coerce: Array[Models::Security]
-    end
-  end
-
-  # Public: Class used to call the Accounts product.
-  class Investments < BaseProduct
-    ##
-    # Public: The Plaid::InvestmentTransactions product accessor.
-    subproduct :transactions, Plaid::InvestmentTransactions
-
-    ##
-    # Public: The Plaid::Holdings product accessor.
-    subproduct :holdings
-  end
-end

data/lib/plaid/products/item.rb

@@ -1,209 +0,0 @@
-module Plaid
-  # Public: Class used to call the AccessToken sub-product.
-  class AccessToken < BaseProduct
-    # Public: Rotate your access_token, keeping it attached to the item
-    #
-    # Does a POST /item/access_token/invalidate call which will give you a new
-    # access_token allowing you to rotate access_tokens.
-    #
-    # access_token - The String access_token to invalidate and rotate.
-    #
-    # Returns an InvalidateResponse object with the new access_token and
-    # request id.
-    def invalidate(access_token)
-      post_with_auth 'item/access_token/invalidate',
-                     InvalidateResponse,
-                     access_token: access_token
-    end
-
-    # Public: Response for /item/access_token/invalidate.
-    class InvalidateResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The String new access token.
-      property :new_access_token
-    end
-  end
-
-  # Public: Class used to call the PublicToken sub-product
-  class PublicToken < BaseProduct
-    # Public: Creates a public token from an access_token.
-    #
-    # Does a POST /item/public_token/create call which can be used to
-    # initialize Link in update mode.
-    #
-    # access_token - access_token to create a public token for
-    #
-    # Returns a CreateResponse object with a public token and expiration info.
-    def create(access_token)
-      puts 'Warning: this method will be deprecated in a future version. '\
-           'To replace the public_token for initializing Link, look into '\
-           'the link_token at https://plaid.com/docs/api/tokens/#linktokencreate.'
-
-      post_with_auth 'item/public_token/create',
-                     CreateResponse,
-                     access_token: access_token
-    end
-
-    # Public: Response for /item/public_token/create.
-    class CreateResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The String token.
-      property :public_token
-
-      ##
-      # :attr_reader:
-      # Public: The String token expiration time.
-      property :expiration
-    end
-
-    # Public: Exchange a public token for an access_token
-    #
-    # Does a POST /item/public_token/exchange call helps you exchange a public
-    # token (possibly from Plaid Link) for an access_token you can use in the
-    # rest of your app.
-    #
-    # public_token - The Public token to get an access_token from.
-    #
-    # Returns an ExchangeResponse object with an access_token and request id.
-    def exchange(public_token)
-      post_with_auth 'item/public_token/exchange',
-                     ExchangeResponse,
-                     public_token: public_token
-    end
-
-    # Public: Response for /item/public_token/exchange.
-    class ExchangeResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The String access token for use with API.
-      property :access_token
-
-      ##
-      # :attr_reader:
-      # Public: The String item ID.
-      property :item_id
-    end
-  end
-
-  # Public: Class used to call the Webhook sub-product
-  class Webhook < BaseProduct
-    # Public: Update webhook for an access_token.
-    #
-    # Does a POST /item/webhook/update call which is used to update webhook
-    # for a particular access_token. Webhooks are used to be notified when
-    # transactions for an item are updated and ready.
-    #
-    # access_token - The access_token of an item to update webhook for.
-    # webhook      - The new webhook link.
-    #
-    # Returns an UpdateResponse object with either an ItemStatus or MFA
-    # response.
-    def update(access_token, webhook)
-      post_with_auth 'item/webhook/update',
-                     UpdateResponse,
-                     access_token: access_token,
-                     webhook: webhook
-    end
-
-    # Public: Response for /item/webhook/update.
-    class UpdateResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The item: Plaid::Models::Item.
-      property :item, coerce: Models::Item
-    end
-  end
-
-  # Public: Class used to call the Item product.
-  class Item < BaseProduct
-    ##
-    # :attr_reader:
-    # Public: The Plaid::AccessToken product accessor.
-    subproduct :access_token
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::PublicToken product accessor.
-    subproduct :public_token
-
-    ##
-    # :attr_reader:
-    # Public: The Plaid::Webhook product accessor.
-    subproduct :webhook
-
-    # Public: Get information about an item.
-    #
-    # Does a POST /item/get call which returns information about an item or
-    # ItemStatus.
-    #
-    # access_token - access_token who's item to fetch status for
-    #
-    # Returns a GetResponse object with item information.
-    def get(access_token)
-      post_with_auth 'item/get',
-                     GetResponse,
-                     access_token: access_token
-    end
-
-    # Public: Response for /item/get.
-    class GetResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The item: Plaid::Models::Item.
-      property :item, coerce: Models::Item
-
-      ##
-      # :attr_reader:
-      # Public: The item status: Plaid::Models::ItemStatus.
-      property :status, coerce: Models::ItemStatus
-    end
-
-    # Public: Removes an item
-    #
-    # Does a POST /item/remove call which is used to remove an item
-    #
-    # access_token - access_token who's item to remove
-    #
-    # Returns a RemoveResponse object with remove result.
-    def remove(access_token)
-      post_with_auth 'item/remove',
-                     RemoveResponse,
-                     access_token: access_token
-    end
-
-    # Public: Response for /item/remove.
-    class RemoveResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The Boolean flag meaning successful removal.
-      property :removed
-    end
-
-    # Public: Import an item.
-    #
-    # Does a POST /item/import call which imports an item.
-    #
-    # products - array of products to enable
-    # user_auth - hash map of user authentication information
-    # options - optional hash map of options
-    #
-    # Returns an access token for the item.
-    def import(products, user_auth, options)
-      post_with_auth 'item/import',
-                     ImportResponse,
-                     products: products,
-                     user_auth: user_auth,
-                     options: options
-    end
-
-    # Public: Response for /item/import.
-    class ImportResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The access token string
-      property :access_token
-    end
-  end
-end