apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/account_identity.rb

@@ -0,0 +1,206 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # AccountIdentity Model.
+  class AccountIdentity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Plaid’s unique identifier for the account. This value will not change
+    # unless Plaid can't reconcile the account with the data returned by the
+    # financial institution. This may occur, for example, when the name of the
+    # account changes. If this happens a new `account_id` will be assigned to
+    # the account.
+    # The `account_id` can also change if the `access_token` is deleted and the
+    # same credentials that were used to generate that `access_token` are used
+    # to generate a new `access_token` on a later date. In that case, the new
+    # `account_id` will be different from the old `account_id`.
+    # If an account with a specific `account_id` disappears instead of changing,
+    # the account is likely closed. Closed accounts are not returned by the
+    # Plaid API.
+    # Like all Plaid identifiers, the `account_id` is case sensitive.
+    # @return [String]
+    attr_accessor :account_id
+
+    # 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`.
+    # @return [AccountBalance]
+    attr_accessor :balances
+
+    # The last 2-4 alphanumeric characters of an account's official account
+    # number. Note that the mask may be non-unique between an Item's accounts,
+    # and it may also not match the mask that the bank displays to the user.
+    # @return [String]
+    attr_accessor :mask
+
+    # The name of the account, either assigned by the user or by the financial
+    # institution itself
+    # @return [String]
+    attr_accessor :name
+
+    # The official name of the account as given by the financial institution
+    # @return [String]
+    attr_accessor :official_name
+
+    # `investment:` Investment account
+    # `credit:` Credit card
+    # `depository:` Depository account
+    # `loan:` Loan account
+    # `brokerage`: An investment account. Used for `/assets/` endpoints only;
+    # other endpoints use `investment`.
+    # `other:` Non-specified account type
+    # See the [Account type
+    # schema](https://plaid.com/docs/api/accounts#account-type-schema) for a
+    # full listing of account types and corresponding subtypes.
+    # @return [AccountType]
+    attr_accessor :type
+
+    # See the [Account type
+    # schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a
+    # full listing of account types and corresponding subtypes.
+    # @return [AccountSubtype]
+    attr_accessor :subtype
+
+    # The current verification status of an Auth Item initiated through
+    # Automated or Manual micro-deposits.  Returned for Auth Items only.
+    # `pending_automatic_verification`: The Item is pending automatic
+    # verification
+    # `pending_manual_verification`: The Item is pending manual micro-deposit
+    # verification. Items remain in this state until the user successfully
+    # verifies the two amounts.
+    # `automatically_verified`: The Item has successfully been automatically
+    # verified	
+    # `manually_verified`: The Item has successfully been manually verified
+    # `verification_expired`: Plaid was unable to automatically verify the
+    # deposit within 7 calendar days and will no longer attempt to validate the
+    # Item. Users may retry by submitting their information again through Link.
+    # `verification_failed`: The Item failed manual micro-deposit verification
+    # because the user exhausted all 3 verification attempts. Users may retry by
+    # submitting their information again through Link.
+    # @return [VerificationStatus4]
+    attr_accessor :verification_status
+
+    # Data returned by the financial institution about the account owner or
+    # owners. Only returned by Identity or Assets endpoints. Multiple owners on
+    # a single account will be represented in the same `owner` object, not in
+    # multiple owner objects within the array.
+    # @return [Array[Owner]]
+    attr_accessor :owners
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account_id'
+      @_hash['balances'] = 'balances'
+      @_hash['mask'] = 'mask'
+      @_hash['name'] = 'name'
+      @_hash['official_name'] = 'official_name'
+      @_hash['type'] = 'type'
+      @_hash['subtype'] = 'subtype'
+      @_hash['verification_status'] = 'verification_status'
+      @_hash['owners'] = 'owners'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        verification_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        mask
+        official_name
+      ]
+    end
+
+    def initialize(account_id:, balances:, mask:, name:, official_name:, type:,
+                   subtype:, owners:, verification_status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_id = account_id
+      @balances = balances
+      @mask = mask
+      @name = name
+      @official_name = official_name
+      @type = type
+      @subtype = subtype
+      @verification_status = verification_status unless verification_status == SKIP
+      @owners = owners
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      account_id = hash.key?('account_id') ? hash['account_id'] : nil
+      balances = AccountBalance.from_hash(hash['balances']) if hash['balances']
+      mask = hash.key?('mask') ? hash['mask'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      official_name = hash.key?('official_name') ? hash['official_name'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      subtype = hash.key?('subtype') ? hash['subtype'] : nil
+      # Parameter is an array, so we need to iterate through it
+      owners = nil
+      unless hash['owners'].nil?
+        owners = []
+        hash['owners'].each do |structure|
+          owners << (Owner.from_hash(structure) if structure)
+        end
+      end
+
+      owners = nil unless hash.key?('owners')
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      AccountIdentity.new(account_id: account_id,
+                          balances: balances,
+                          mask: mask,
+                          name: name,
+                          official_name: official_name,
+                          type: type,
+                          subtype: subtype,
+                          owners: owners,
+                          verification_status: verification_status,
+                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, balances: #{@balances}, mask: #{@mask}, name:"\
+      " #{@name}, official_name: #{@official_name}, type: #{@type}, subtype: #{@subtype},"\
+      " verification_status: #{@verification_status}, owners: #{@owners}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, balances: #{@balances.inspect}, mask:"\
+      " #{@mask.inspect}, name: #{@name.inspect}, official_name: #{@official_name.inspect}, type:"\
+      " #{@type.inspect}, subtype: #{@subtype.inspect}, verification_status:"\
+      " #{@verification_status.inspect}, owners: #{@owners.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/account_selection_cardinality.rb

@@ -0,0 +1,44 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The application requires that accounts be limited to a specific cardinality.
+  # `MULTI_SELECT`: indicates that the user should be allowed to pick multiple
+  # accounts. `SINGLE_SELECT`: indicates that the user should be allowed to pick
+  # only a single account. `ALL`: indicates that the user must share all of
+  # their accounts and should not be given the opportunity to de-select
+  class AccountSelectionCardinality
+    ACCOUNT_SELECTION_CARDINALITY = [
+      # TODO: Write general description for SINGLE_SELECT
+      SINGLE_SELECT = 'SINGLE_SELECT'.freeze,
+
+      # TODO: Write general description for MULTI_SELECT
+      MULTI_SELECT = 'MULTI_SELECT'.freeze,
+
+      # TODO: Write general description for ALL
+      ALL = 'ALL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = SINGLE_SELECT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'single_select' then SINGLE_SELECT
+      when 'multi_select' then MULTI_SELECT
+      when 'all' then ALL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/account_subtype.rb

@@ -0,0 +1,319 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # See the [Account type
+  # schema](https://plaid.com/docs/api/accounts/#account-type-schema) for a full
+  # listing of account types and corresponding subtypes.
+  class AccountSubtype
+    ACCOUNT_SUBTYPE = [
+      # TODO: Write general description for ENUM_401A
+      ENUM_401A = '401a'.freeze,
+
+      # TODO: Write general description for ENUM_401K
+      ENUM_401K = '401k'.freeze,
+
+      # TODO: Write general description for ENUM_403B
+      ENUM_403B = '403B'.freeze,
+
+      # TODO: Write general description for ENUM_457B
+      ENUM_457B = '457b'.freeze,
+
+      # TODO: Write general description for ENUM_529
+      ENUM_529 = '529'.freeze,
+
+      # TODO: Write general description for BROKERAGE
+      BROKERAGE = 'brokerage'.freeze,
+
+      # TODO: Write general description for ENUM_CASH_ISA
+      ENUM_CASH_ISA = 'cash isa'.freeze,
+
+      # TODO: Write general description for ENUM_EDUCATION_SAVINGS_ACCOUNT
+      ENUM_EDUCATION_SAVINGS_ACCOUNT = 'education savings account'.freeze,
+
+      # TODO: Write general description for EBT
+      EBT = 'ebt'.freeze,
+
+      # TODO: Write general description for ENUM_FIXED_ANNUITY
+      ENUM_FIXED_ANNUITY = 'fixed annuity'.freeze,
+
+      # TODO: Write general description for GIC
+      GIC = 'gic'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_HEALTH_REIMBURSEMENT_ARRANGEMENT
+      ENUM_HEALTH_REIMBURSEMENT_ARRANGEMENT = 'health reimbursement arrangement'.freeze,
+
+      # TODO: Write general description for HSA
+      HSA = 'hsa'.freeze,
+
+      # TODO: Write general description for ISA
+      ISA = 'isa'.freeze,
+
+      # TODO: Write general description for IRA
+      IRA = 'ira'.freeze,
+
+      # TODO: Write general description for LIF
+      LIF = 'lif'.freeze,
+
+      # TODO: Write general description for ENUM_LIFE_INSURANCE
+      ENUM_LIFE_INSURANCE = 'life insurance'.freeze,
+
+      # TODO: Write general description for LIRA
+      LIRA = 'lira'.freeze,
+
+      # TODO: Write general description for LRIF
+      LRIF = 'lrif'.freeze,
+
+      # TODO: Write general description for LRSP
+      LRSP = 'lrsp'.freeze,
+
+      # TODO: Write general description for ENUM_NONTAXABLE_BROKERAGE_ACCOUNT
+      ENUM_NONTAXABLE_BROKERAGE_ACCOUNT = 'non-taxable brokerage account'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze,
+
+      # TODO: Write general description for ENUM_OTHER_INSURANCE
+      ENUM_OTHER_INSURANCE = 'other insurance'.freeze,
+
+      # TODO: Write general description for ENUM_OTHER_ANNUITY
+      ENUM_OTHER_ANNUITY = 'other annuity'.freeze,
+
+      # TODO: Write general description for PRIF
+      PRIF = 'prif'.freeze,
+
+      # TODO: Write general description for RDSP
+      RDSP = 'rdsp'.freeze,
+
+      # TODO: Write general description for RESP
+      RESP = 'resp'.freeze,
+
+      # TODO: Write general description for RLIF
+      RLIF = 'rlif'.freeze,
+
+      # TODO: Write general description for RRIF
+      RRIF = 'rrif'.freeze,
+
+      # TODO: Write general description for PENSION
+      PENSION = 'pension'.freeze,
+
+      # TODO: Write general description for ENUM_PROFIT_SHARING_PLAN
+      ENUM_PROFIT_SHARING_PLAN = 'profit sharing plan'.freeze,
+
+      # TODO: Write general description for RETIREMENT
+      RETIREMENT = 'retirement'.freeze,
+
+      # TODO: Write general description for ROTH
+      ROTH = 'roth'.freeze,
+
+      # TODO: Write general description for ENUM_ROTH_401K
+      ENUM_ROTH_401K = 'roth 401k'.freeze,
+
+      # TODO: Write general description for RRSP
+      RRSP = 'rrsp'.freeze,
+
+      # TODO: Write general description for ENUM_SEP_IRA
+      ENUM_SEP_IRA = 'sep ira'.freeze,
+
+      # TODO: Write general description for ENUM_SIMPLE_IRA
+      ENUM_SIMPLE_IRA = 'simple ira'.freeze,
+
+      # TODO: Write general description for SIPP
+      SIPP = 'sipp'.freeze,
+
+      # TODO: Write general description for ENUM_STOCK_PLAN
+      ENUM_STOCK_PLAN = 'stock plan'.freeze,
+
+      # TODO: Write general description for ENUM_THRIFT_SAVINGS_PLAN
+      ENUM_THRIFT_SAVINGS_PLAN = 'thrift savings plan'.freeze,
+
+      # TODO: Write general description for TFSA
+      TFSA = 'tfsa'.freeze,
+
+      # TODO: Write general description for TRUST
+      TRUST = 'trust'.freeze,
+
+      # TODO: Write general description for UGMA
+      UGMA = 'ugma'.freeze,
+
+      # TODO: Write general description for UTMA
+      UTMA = 'utma'.freeze,
+
+      # TODO: Write general description for ENUM_VARIABLE_ANNUITY
+      ENUM_VARIABLE_ANNUITY = 'variable annuity'.freeze,
+
+      # TODO: Write general description for ENUM_CREDIT_CARD
+      ENUM_CREDIT_CARD = 'credit card'.freeze,
+
+      # TODO: Write general description for PAYPAL
+      PAYPAL = 'paypal'.freeze,
+
+      # TODO: Write general description for CD
+      CD = 'cd'.freeze,
+
+      # TODO: Write general description for CHECKING
+      CHECKING = 'checking'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'savings'.freeze,
+
+      # TODO: Write general description for ENUM_MONEY_MARKET
+      ENUM_MONEY_MARKET = 'money market'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'prepaid'.freeze,
+
+      # TODO: Write general description for AUTO
+      AUTO = 'auto'.freeze,
+
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'business'.freeze,
+
+      # TODO: Write general description for COMMERCIAL
+      COMMERCIAL = 'commercial'.freeze,
+
+      # TODO: Write general description for CONSTRUCTION
+      CONSTRUCTION = 'construction'.freeze,
+
+      # TODO: Write general description for CONSUMER
+      CONSUMER = 'consumer'.freeze,
+
+      # TODO: Write general description for HOME
+      HOME = 'home'.freeze,
+
+      # TODO: Write general description for ENUM_HOME_EQUITY
+      ENUM_HOME_EQUITY = 'home equity'.freeze,
+
+      # TODO: Write general description for LOAN
+      LOAN = 'loan'.freeze,
+
+      # TODO: Write general description for MORTGAGE
+      MORTGAGE = 'mortgage'.freeze,
+
+      # TODO: Write general description for OVERDRAFT
+      OVERDRAFT = 'overdraft'.freeze,
+
+      # TODO: Write general description for ENUM_LINE_OF_CREDIT
+      ENUM_LINE_OF_CREDIT = 'line of credit'.freeze,
+
+      # TODO: Write general description for STUDENT
+      STUDENT = 'student'.freeze,
+
+      # TODO: Write general description for ENUM_CASH_MANAGEMENT
+      ENUM_CASH_MANAGEMENT = 'cash management'.freeze,
+
+      # TODO: Write general description for KEOGH
+      KEOGH = 'keogh'.freeze,
+
+      # TODO: Write general description for ENUM_MUTUAL_FUND
+      ENUM_MUTUAL_FUND = 'mutual fund'.freeze,
+
+      # TODO: Write general description for RECURRING
+      RECURRING = 'recurring'.freeze,
+
+      # TODO: Write general description for REWARDS
+      REWARDS = 'rewards'.freeze,
+
+      # TODO: Write general description for ENUM_SAFE_DEPOSIT
+      ENUM_SAFE_DEPOSIT = 'safe deposit'.freeze,
+
+      # TODO: Write general description for SARSEP
+      SARSEP = 'sarsep'.freeze,
+
+      # TODO: Write general description for PAYROLL
+      PAYROLL = 'payroll'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_401A)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_401a' then ENUM_401A
+      when 'enum_401k' then ENUM_401K
+      when 'enum_403b' then ENUM_403B
+      when 'enum_457b' then ENUM_457B
+      when 'enum_529' then ENUM_529
+      when 'brokerage' then BROKERAGE
+      when 'enum_cash_isa' then ENUM_CASH_ISA
+      when 'enum_education_savings_account' then ENUM_EDUCATION_SAVINGS_ACCOUNT
+      when 'ebt' then EBT
+      when 'enum_fixed_annuity' then ENUM_FIXED_ANNUITY
+      when 'gic' then GIC
+      when 'enum_health_reimbursement_arrangement' then ENUM_HEALTH_REIMBURSEMENT_ARRANGEMENT
+      when 'hsa' then HSA
+      when 'isa' then ISA
+      when 'ira' then IRA
+      when 'lif' then LIF
+      when 'enum_life_insurance' then ENUM_LIFE_INSURANCE
+      when 'lira' then LIRA
+      when 'lrif' then LRIF
+      when 'lrsp' then LRSP
+      when 'enum_nontaxable_brokerage_account' then ENUM_NONTAXABLE_BROKERAGE_ACCOUNT
+      when 'other' then OTHER
+      when 'enum_other_insurance' then ENUM_OTHER_INSURANCE
+      when 'enum_other_annuity' then ENUM_OTHER_ANNUITY
+      when 'prif' then PRIF
+      when 'rdsp' then RDSP
+      when 'resp' then RESP
+      when 'rlif' then RLIF
+      when 'rrif' then RRIF
+      when 'pension' then PENSION
+      when 'enum_profit_sharing_plan' then ENUM_PROFIT_SHARING_PLAN
+      when 'retirement' then RETIREMENT
+      when 'roth' then ROTH
+      when 'enum_roth_401k' then ENUM_ROTH_401K
+      when 'rrsp' then RRSP
+      when 'enum_sep_ira' then ENUM_SEP_IRA
+      when 'enum_simple_ira' then ENUM_SIMPLE_IRA
+      when 'sipp' then SIPP
+      when 'enum_stock_plan' then ENUM_STOCK_PLAN
+      when 'enum_thrift_savings_plan' then ENUM_THRIFT_SAVINGS_PLAN
+      when 'tfsa' then TFSA
+      when 'trust' then TRUST
+      when 'ugma' then UGMA
+      when 'utma' then UTMA
+      when 'enum_variable_annuity' then ENUM_VARIABLE_ANNUITY
+      when 'enum_credit_card' then ENUM_CREDIT_CARD
+      when 'paypal' then PAYPAL
+      when 'cd' then CD
+      when 'checking' then CHECKING
+      when 'savings' then SAVINGS
+      when 'enum_money_market' then ENUM_MONEY_MARKET
+      when 'prepaid' then PREPAID
+      when 'auto' then AUTO
+      when 'business' then BUSINESS
+      when 'commercial' then COMMERCIAL
+      when 'construction' then CONSTRUCTION
+      when 'consumer' then CONSUMER
+      when 'home' then HOME
+      when 'enum_home_equity' then ENUM_HOME_EQUITY
+      when 'loan' then LOAN
+      when 'mortgage' then MORTGAGE
+      when 'overdraft' then OVERDRAFT
+      when 'enum_line_of_credit' then ENUM_LINE_OF_CREDIT
+      when 'student' then STUDENT
+      when 'enum_cash_management' then ENUM_CASH_MANAGEMENT
+      when 'keogh' then KEOGH
+      when 'enum_mutual_fund' then ENUM_MUTUAL_FUND
+      when 'recurring' then RECURRING
+      when 'rewards' then REWARDS
+      when 'enum_safe_deposit' then ENUM_SAFE_DEPOSIT
+      when 'sarsep' then SARSEP
+      when 'payroll' then PAYROLL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/account_subtype1.rb

@@ -0,0 +1,36 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # The account subtype of the account, either `checking` or `savings`.
+  class AccountSubtype1
+    ACCOUNT_SUBTYPE1 = [
+      # TODO: Write general description for CHECKING
+      CHECKING = 'checking'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'savings'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CHECKING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'checking' then CHECKING
+      when 'savings' then SAVINGS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/plaid/models/account_type.rb

@@ -0,0 +1,57 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # `investment:` Investment account `credit:` Credit card `depository:`
+  # Depository account `loan:` Loan account `brokerage`: An investment account.
+  # Used for `/assets/` endpoints only; other endpoints use `investment`.
+  # `other:` Non-specified account type See the [Account type
+  # schema](https://plaid.com/docs/api/accounts#account-type-schema) for a full
+  # listing of account types and corresponding subtypes.
+  class AccountType
+    ACCOUNT_TYPE = [
+      # TODO: Write general description for INVESTMENT
+      INVESTMENT = 'investment'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for DEPOSITORY
+      DEPOSITORY = 'depository'.freeze,
+
+      # TODO: Write general description for LOAN
+      LOAN = 'loan'.freeze,
+
+      # TODO: Write general description for BROKERAGE
+      BROKERAGE = 'brokerage'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = INVESTMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'investment' then INVESTMENT
+      when 'credit' then CREDIT
+      when 'depository' then DEPOSITORY
+      when 'loan' then LOAN
+      when 'brokerage' then BROKERAGE
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end