plaid 13.2.0 → 42.0.0

data/lib/plaid/products/accounts.rb

@@ -1,63 +0,0 @@
-module Plaid
-  # Public: Class used to call the Balance product.
-  class Balance < BaseProduct
-    # Public: Get information about all available balances.
-    #
-    # Does a POST /accounts/balance/get call to get real-time balance
-    # information for all accounts associated with the access_token's item.
-    #
-    # access_token - The String access_token for the item to fetch balances
-    #                for.
-    # account_ids  - The Array with specific account IDs to fetch balances for
-    #                (optional).
-    # options      - Additional options to be merged into the request
-    #                (optional).
-    #
-    # Returns the AccountsResponse object with accounts information.
-    def get(access_token, account_ids: nil, options: nil)
-      post_with_auth 'accounts/balance/get',
-                     AccountsResponse,
-                     build_payload(access_token,
-                                   account_ids: account_ids,
-                                   options: options)
-    end
-  end
-
-  # Public: Class used to call the Accounts product.
-  class Accounts < BaseProduct
-    ##
-    # Public: The Plaid::Balance product accessor.
-    subproduct :balance
-
-    # Public: Get information about all available accounts.
-    #
-    # Does a POST /accounts/get call to retrieve high level account information
-    # associated with an access_token's item
-    #
-    # access_token - access_token who's item to fetch accounts for
-    # account_ids  - Specific account ids to fetch accounts for (optional)
-    # options      - Additional options to be merged into API request
-    #
-    # Returns the AccountsResponse object with accounts information.
-    def get(access_token, account_ids: nil, options: nil)
-      post_with_auth 'accounts/get',
-                     AccountsResponse,
-                     build_payload(access_token,
-                                   account_ids: account_ids,
-                                   options: options)
-    end
-  end
-
-  # Public: The response wrapper for /accounts/get and /accounts/balance/get.
-  class AccountsResponse < 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]
-  end
-end

data/lib/plaid/products/asset_report.rb

@@ -1,199 +0,0 @@
-module Plaid
-  # Public: Class used to call the Assets product. Documentation available at
-  # https://plaid.com/docs/api/#assets.
-  class AssetReport < BaseProduct
-    # Public: Create an asset report.
-    #
-    # access_tokens  - An array of access tokens, one token for each Item to be
-    #                  included in the Asset Report.
-    # days_requested - Days of transaction history requested to be included in
-    #                  the Asset Report. Plaid will return as much data as
-    #                  possible within the implied date range, up to a maximum
-    #                  of 730 days (2 years) of history.
-    # options        - An optional object containing client-provided user
-    #                  information, a client-provided report ID, and a webhook.
-    #                  For more information, see the website listed above.
-    #
-    # Returns a AssetReportCreateResponse object.
-    def create(access_tokens, days_requested, options = {})
-      post_with_auth 'asset_report/create',
-                     AssetReportCreateResponse,
-                     access_tokens: access_tokens,
-                     days_requested: days_requested,
-                     options: options
-    end
-
-    # Public: Create a new, filtered asset report.
-    #
-    # asset_report_token     - The asset report token for the asset report you
-    #                          want to filter.
-    # account_ids_to_exclude - The list of account IDs to exclude from the
-    #                          original asset report.
-    #
-    # Returns a AssetReportFilterResponse object.
-    def filter(asset_report_token, account_ids_to_exclude)
-      post_with_auth 'asset_report/filter',
-                     AssetReportFilterResponse,
-                     asset_report_token: asset_report_token,
-                     account_ids_to_exclude: account_ids_to_exclude
-    end
-
-    # Public: Create a new, refreshed asset report.
-    #
-    # asset_report_token - The asset report token for the asset report you want
-    #                      to refresh.
-    # days_requested     - Days of transaction history requested to be included
-    #                      in the Asset Report. Plaid will return as much data
-    #                      as possible within the implied date range, up to a
-    #                      maximum of 730 days (2 years) of history.
-    # options            - An optional object containing client-provided user
-    #                      information, a client-provided report ID, and a
-    #                      webhook. For more information, see the website
-    #                      listed above.
-    #
-    # Returns a AssetReportRefreshResponse object.
-    def refresh(asset_report_token, days_requested, options = {})
-      post_with_auth 'asset_report/refresh',
-                     AssetReportRefreshResponse,
-                     asset_report_token: asset_report_token,
-                     days_requested: days_requested,
-                     options: options
-    end
-
-    # Public: Retrieve an asset report.
-    #
-    # asset_report_token - The asset report token from the `create` response.
-    # include_insights   - An optional boolean specifying whether we should
-    #                      retrieve the report as an "Assets + Insights"
-    #                      report. For information about Assets + Insights
-    #                      reports, see https://plaid.com/docs/#assets.
-    #
-    # Returns a AssetReportGetResponse object.
-    def get(asset_report_token, include_insights: false)
-      post_with_auth 'asset_report/get',
-                     AssetReportGetResponse,
-                     asset_report_token: asset_report_token,
-                     include_insights: include_insights
-    end
-
-    # Public: Retrieve an asset report as a PDF.
-    #
-    # asset_report_token - The asset report token from the `create` response.
-    #
-    # Returns the PDF.
-    def get_pdf(asset_report_token)
-      client.post_with_auth 'asset_report/pdf/get',
-                            asset_report_token: asset_report_token
-    end
-
-    # Public: Remove an asset report.
-    #
-    # asset_report_token - The asset report token from the `create` response.
-    #
-    # Returns a AssetReportRemoveResponse object.
-    def remove(asset_report_token)
-      post_with_auth 'asset_report/remove',
-                     AssetReportRemoveResponse,
-                     asset_report_token: asset_report_token
-    end
-
-    # Public: Create an audit copy token.
-    #
-    # asset_report_token - The asset report token from the `create` response.
-    # auditor_id         - The ID of the third party with which you would like
-    #                      to share the asset report.
-    #
-    # Returns a AuditCopyCreateResponse object.
-    def create_audit_copy(asset_report_token, auditor_id)
-      post_with_auth 'asset_report/audit_copy/create',
-                     AuditCopyCreateResponse,
-                     asset_report_token: asset_report_token,
-                     auditor_id: auditor_id
-    end
-
-    # Public: Retrieve an audit copy.
-    #
-    # audit_copy_token - The audit copy token from the `create_audit_copy`
-    #                    response.
-    #
-    # Returns a AuditCopyGetResponse object.
-    def get_audit_copy(audit_copy_token)
-      post_with_auth 'asset_report/audit_copy/get',
-                     AuditCopyGetResponse,
-                     audit_copy_token: audit_copy_token
-    end
-
-    # Public: Remove an audit copy token.
-    #
-    # audit_copy_token - The audit copy token from the `create` response.
-    #
-    # Returns a AuditCopyRemoveResponse object.
-    def remove_audit_copy(audit_copy_token)
-      post_with_auth 'asset_report/audit_copy/remove',
-                     AuditCopyRemoveResponse,
-                     audit_copy_token: audit_copy_token
-    end
-  end
-
-  # Public: The response wrapper for /asset_report/create.
-  class AssetReportCreateResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The asset report token.
-    property :asset_report_token
-
-    ##
-    # :attr_reader:
-    # Public: The asset report ID.
-    property :asset_report_id
-  end
-
-  # Public: The response wrapper for /asset_report/filter.
-  class AssetReportFilterResponse < AssetReportCreateResponse
-  end
-
-  # Public: The response wrapper for /asset_report/refresh.
-  class AssetReportRefreshResponse < AssetReportCreateResponse
-  end
-
-  # Public: The response wrapper for /asset_report/get.
-  class AssetReportGetResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The asset report token.
-    property :report, coerce: Models::AssetReport
-
-    ##
-    # :attr_reader:
-    # Public: Warnings encountered during asset report generation.
-    property :warnings, coerce: Array[Models::Warning]
-  end
-
-  # Public: The response wrapper for /asset_report/remove.
-  class AssetReportRemoveResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: A boolean indicating whether the report was removed.
-    property :removed
-  end
-
-  # Public: The response wrapper for /asset_report/audit_copy/create.
-  class AuditCopyCreateResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The audit copy token.
-    property :audit_copy_token
-  end
-
-  # Public: The response wrapper for /asset_report/audit_copy/get.
-  class AuditCopyGetResponse < AssetReportGetResponse
-  end
-
-  # Public: The response wrapper for /asset_report/audit_copy/remove.
-  class AuditCopyRemoveResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: A boolean indicating whether the audit copy was removed.
-    property :removed
-  end
-end

data/lib/plaid/products/auth.rb

@@ -1,42 +0,0 @@
-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

data/lib/plaid/products/base_product.rb

@@ -1,64 +0,0 @@
-module Plaid
-  # Internal: Support for subproduct metaprogramming
-  #
-  # Allows to write
-  #
-  #   class SomeProduct
-  #     subproduct :cool, Plaid::Cool
-  #   end
-  #
-  # You may even skip the class part:
-  #
-  #   class SomeProduct
-  #     subproduct :foo_bar
-  #   end
-  #
-  # will use Plaid::FooBar.
-  module SubproductMixin
-    def subproduct(name, klass = nil)
-      unless klass
-        class_name = name.to_s.split('_').map(&:capitalize).join
-        klass = Plaid.const_get(class_name)
-      end
-
-      define_method(name) do
-        ivar = "@#{name}"
-
-        if instance_variable_defined?(ivar)
-          instance_variable_get(ivar)
-        else
-          instance_variable_set(ivar, klass.new(client))
-        end
-      end
-    end
-  end
-
-  # Internal: The base class for all client products
-  class BaseProduct
-    def initialize(client)
-      @client = client
-    end
-
-    attr_reader :client
-
-    extend SubproductMixin
-
-    protected
-
-    # Internal: Build a simple payload with access_token, options, and
-    # account_ids.
-    def build_payload(access_token, account_ids: nil, options: nil)
-      options_payload = {}
-      options_payload[:account_ids] = account_ids unless account_ids.nil?
-      options_payload.merge!(options) unless options.nil?
-
-      { access_token: access_token,
-        options: options_payload }
-    end
-
-    # Internal: Do a POST to API and capture it into a response object.
-    def post_with_auth(path, response_class, payload)
-      response_class.new(client.post_with_auth(path, payload))
-    end
-  end
-end

data/lib/plaid/products/categories.rb

@@ -1,21 +0,0 @@
-module Plaid
-  # Public: Class used to call the Categories product.
-  class Categories < BaseProduct
-    # Public: Get information about all Plaid categories
-    #
-    # Does a POST /categories/get call to retrieve a list of all categories.
-    #
-    # Returns the CategoriesResponse object with a list of categories.
-    def get
-      CategoriesResponse.new(client.post('categories/get', {}))
-    end
-  end
-
-  # Public: Response wrapper for /categories/get.
-  class CategoriesResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: Categories: Array of Plaid::Models::Category.
-    property :categories, coerce: Array[Models::Category]
-  end
-end

data/lib/plaid/products/credit_details.rb

@@ -1,40 +0,0 @@
-module Plaid
-  # Public: Class used to call the CreditDetails product.
-  class CreditDetails < BaseProduct
-    # Public: Get information about all available credit_details.
-    #
-    # Does a POST /credit_details/get call which fetches credit details
-    # associated with an access_token's item.
-    #
-    # access_token - access_token of an item to fetch credit details for.
-    # account_ids  - Specific account ids to fetch credit details for
-    #                (optional).
-    #
-    # Returns the CreditDetailsResponse object with credit details info.
-    def get(access_token, account_ids: nil)
-      post_with_auth 'credit_details/get',
-                     CreditDetailsResponse,
-                     build_payload(access_token,
-                                   account_ids: account_ids)
-    end
-  end
-
-  # Public: Response wrapper for /credit_details/get.
-  class CreditDetailsResponse < Models::BaseResponse
-    ##
-    # :attr_reader:
-    # Public: The list of accounts: Array of Plaid::Models::Account.
-    property :accounts, coerce: Array[Models::Account]
-
-    ##
-    # :attr_reader:
-    # Public: The list of credit details: Array of
-    # Plaid::Models::CreditDetails.
-    property :credit_details, coerce: Array[Models::CreditDetails]
-
-    ##
-    # :attr_reader:
-    # Public: The item: Plaid::Models::Item.
-    property :item, coerce: Models::Item
-  end
-end

data/lib/plaid/products/deposit_switch.rb

@@ -1,99 +0,0 @@
-module Plaid
-  # Public: Class used to call the Deposit Switch product.
-  class DepositSwitch < BaseProduct
-    # Public: Get Deposit Switch information.
-    #
-    # Does a POST /deposit_switch/get call which fetches deposit switch
-    # associated with a deposit switch id.
-    #
-    # deposit_switch_id - deposit_switch_id to fetch deposit switch
-    # Returns the DepositSwitchResponse object with deposit switch data.
-    def get(deposit_switch_id)
-      post_with_auth 'deposit_switch/get',
-                     GetResponse,
-                     deposit_switch_id: deposit_switch_id
-    end
-
-    # Public: Response wrapper for /deposit_switch/get.
-    class GetResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The ID associated with the deposit switch.
-      property :deposit_switch_id
-
-      ##
-      # :attr_reader:
-      # Public: The ID of the item that the deposit switch was a target to.
-      property :target_item_id
-
-      ##
-      # :attr_reader:
-      # Public: The ID of the account that the deposit switch was a target to.
-      property :target_account_id
-
-      ##
-      # :attr_reader:
-      # Public: The state that the deposit switch is in.
-      property :state
-
-      ##
-      # :attr_reader:
-      # Public: The date on which the deposit switch was created.
-      property :date_created
-
-      ##
-      # :attr_reader:
-      # Public: The date on which the deposit switch was completed.
-      property :date_completed
-    end
-
-    # Public: Create Deposit Switch.
-    #
-    # Does a POST /deposit_switch/create call which creates a deposit switch
-    #
-    # target_account_id - ID of the bank account for the deposit switch
-    # target_access_token - access token for the switch
-    #
-    # Returns the DepositSwitchResponse object with deposit switch data.
-    def create(target_account_id, target_access_token)
-      post_with_auth 'deposit_switch/create',
-                     CreateResponse,
-                     target_account_id: target_account_id,
-                     target_access_token: target_access_token
-    end
-    # Public: Response wrapper for /deposit_switch/create.
-    class CreateResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: The ID associated with the deposit switch
-      property :deposit_switch_id
-    end
-
-    # Public: Create Deposit Switch token.
-    #
-    # Does a POST /deposit_switch/token/create call which creates a deposit
-    # switch.
-    #
-    # deposit_switch_item - ID of the deposit switch
-    #
-    # Returns the CreateTokenResponse object.
-    def create_token(deposit_switch_id)
-      post_with_auth 'deposit_switch/token/create',
-                     CreateTokenResponse,
-                     deposit_switch_id: deposit_switch_id
-    end
-
-    # Public: Response wrapper for /deposit_switch/create.
-    class CreateTokenResponse < Models::BaseResponse
-      ##
-      # :attr_reader:
-      # Public: A deposit switch token for the deposit switch.
-      property :deposit_switch_token
-
-      ##
-      # :attr_reader:
-      # Public: The expiration time of the deposit switch token
-      property :deposit_switch_token_expiration_time
-    end
-  end
-end

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