Class: ThePlaidApi::AccountSubtype

Inherits:
Object
  • Object
show all
Defined in:
lib/the_plaid_api/models/account_subtype.rb

Overview

See the [Account type schema](plaid.com/docs/api/accounts/#account-type-schema) for a full listing of account types and corresponding subtypes.

Constant Summary collapse

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 AUTO
  AUTO = 'auto'.freeze,

  # TODO: Write general description for BROKERAGE
  BROKERAGE = 'brokerage'.freeze,

  # TODO: Write general description for BUSINESS
  BUSINESS = 'business'.freeze,

  # TODO: Write general description for ENUM_CASH_ISA
  ENUM_CASH_ISA = 'cash isa'.freeze,

  # TODO: Write general description for ENUM_CASH_MANAGEMENT
  ENUM_CASH_MANAGEMENT = 'cash management'.freeze,

  # TODO: Write general description for CD
  CD = 'cd'.freeze,

  # TODO: Write general description for CHECKING
  CHECKING = 'checking'.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 ENUM_CREDIT_CARD
  ENUM_CREDIT_CARD = 'credit card'.freeze,

  # TODO: Write general description for ENUM_CRYPTO_EXCHANGE
  ENUM_CRYPTO_EXCHANGE = 'crypto exchange'.freeze,

  # TODO: Write general description for EBT
  EBT = 'ebt'.freeze,

  # TODO: Write general description for ENUM_EDUCATION_SAVINGS_ACCOUNT
  ENUM_EDUCATION_SAVINGS_ACCOUNT = 'education savings account'.freeze,

  # TODO: Write general description for FHSA
  FHSA = 'fhsa'.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 ENUM_HOME_EQUITY
  ENUM_HOME_EQUITY = 'home equity'.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 KEOGH
  KEOGH = 'keogh'.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 ENUM_LIMITED_PURPOSE_CHECKING
  ENUM_LIMITED_PURPOSE_CHECKING = 'limited purpose checking'.freeze,

  # TODO: Write general description for ENUM_LINE_OF_CREDIT
  ENUM_LINE_OF_CREDIT = 'line of credit'.freeze,

  # TODO: Write general description for LIRA
  LIRA = 'lira'.freeze,

  # TODO: Write general description for LOAN
  LOAN = 'loan'.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_MONEY_MARKET
  ENUM_MONEY_MARKET = 'money market'.freeze,

  # TODO: Write general description for MORTGAGE
  MORTGAGE = 'mortgage'.freeze,

  # TODO: Write general description for ENUM_MUTUAL_FUND
  ENUM_MUTUAL_FUND = 'mutual fund'.freeze,

  # TODO: Write general description for ENUM_NONCUSTODIAL_WALLET
  ENUM_NONCUSTODIAL_WALLET = 'non-custodial wallet'.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 OVERDRAFT
  OVERDRAFT = 'overdraft'.freeze,

  # TODO: Write general description for PAYPAL
  PAYPAL = 'paypal'.freeze,

  # TODO: Write general description for PAYROLL
  PAYROLL = 'payroll'.freeze,

  # TODO: Write general description for PENSION
  PENSION = 'pension'.freeze,

  # TODO: Write general description for PREPAID
  PREPAID = 'prepaid'.freeze,

  # TODO: Write general description for PRIF
  PRIF = 'prif'.freeze,

  # TODO: Write general description for ENUM_PROFIT_SHARING_PLAN
  ENUM_PROFIT_SHARING_PLAN = 'profit sharing plan'.freeze,

  # TODO: Write general description for QSHR
  QSHR = 'qshr'.freeze,

  # TODO: Write general description for RDSP
  RDSP = 'rdsp'.freeze,

  # TODO: Write general description for RESP
  RESP = 'resp'.freeze,

  # TODO: Write general description for RETIREMENT
  RETIREMENT = 'retirement'.freeze,

  # TODO: Write general description for RLIF
  RLIF = 'rlif'.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 ENUM_ROTH_403B
  ENUM_ROTH_403B = 'roth 403B'.freeze,

  # TODO: Write general description for ENUM_ROTH_457B
  ENUM_ROTH_457B = 'roth 457b'.freeze,

  # TODO: Write general description for ENUM_ROTH_PENSION
  ENUM_ROTH_PENSION = 'roth pension'.freeze,

  # TODO: Write general description for ENUM_ROTH_PROFIT_SHARING_PLAN
  ENUM_ROTH_PROFIT_SHARING_PLAN = 'roth profit sharing plan'.freeze,

  # TODO: Write general description for ENUM_ROTH_THRIFT_SAVINGS_PLAN
  ENUM_ROTH_THRIFT_SAVINGS_PLAN = 'roth thrift savings plan'.freeze,

  # TODO: Write general description for RRIF
  RRIF = 'rrif'.freeze,

  # TODO: Write general description for RRSP
  RRSP = 'rrsp'.freeze,

  # TODO: Write general description for SARSEP
  SARSEP = 'sarsep'.freeze,

  # TODO: Write general description for SAVINGS
  SAVINGS = 'savings'.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 STUDENT
  STUDENT = 'student'.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
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = ENUM_401A) ⇒ Object



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
# File 'lib/the_plaid_api/models/account_subtype.rb', line 254

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 'auto' then AUTO
  when 'brokerage' then BROKERAGE
  when 'business' then BUSINESS
  when 'enum_cash_isa' then ENUM_CASH_ISA
  when 'enum_cash_management' then ENUM_CASH_MANAGEMENT
  when 'cd' then CD
  when 'checking' then CHECKING
  when 'commercial' then COMMERCIAL
  when 'construction' then CONSTRUCTION
  when 'consumer' then CONSUMER
  when 'enum_credit_card' then ENUM_CREDIT_CARD
  when 'enum_crypto_exchange' then ENUM_CRYPTO_EXCHANGE
  when 'ebt' then EBT
  when 'enum_education_savings_account' then ENUM_EDUCATION_SAVINGS_ACCOUNT
  when 'fhsa' then FHSA
  when 'enum_fixed_annuity' then ENUM_FIXED_ANNUITY
  when 'gic' then GIC
  when 'enum_health_reimbursement_arrangement' then ENUM_HEALTH_REIMBURSEMENT_ARRANGEMENT
  when 'enum_home_equity' then ENUM_HOME_EQUITY
  when 'hsa' then HSA
  when 'isa' then ISA
  when 'ira' then IRA
  when 'keogh' then KEOGH
  when 'lif' then LIF
  when 'enum_life_insurance' then ENUM_LIFE_INSURANCE
  when 'enum_limited_purpose_checking' then ENUM_LIMITED_PURPOSE_CHECKING
  when 'enum_line_of_credit' then ENUM_LINE_OF_CREDIT
  when 'lira' then LIRA
  when 'loan' then LOAN
  when 'lrif' then LRIF
  when 'lrsp' then LRSP
  when 'enum_money_market' then ENUM_MONEY_MARKET
  when 'mortgage' then MORTGAGE
  when 'enum_mutual_fund' then ENUM_MUTUAL_FUND
  when 'enum_noncustodial_wallet' then ENUM_NONCUSTODIAL_WALLET
  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 'overdraft' then OVERDRAFT
  when 'paypal' then PAYPAL
  when 'payroll' then PAYROLL
  when 'pension' then PENSION
  when 'prepaid' then PREPAID
  when 'prif' then PRIF
  when 'enum_profit_sharing_plan' then ENUM_PROFIT_SHARING_PLAN
  when 'qshr' then QSHR
  when 'rdsp' then RDSP
  when 'resp' then RESP
  when 'retirement' then RETIREMENT
  when 'rlif' then RLIF
  when 'roth' then ROTH
  when 'enum_roth_401k' then ENUM_ROTH_401K
  when 'enum_roth_403b' then ENUM_ROTH_403B
  when 'enum_roth_457b' then ENUM_ROTH_457B
  when 'enum_roth_pension' then ENUM_ROTH_PENSION
  when 'enum_roth_profit_sharing_plan' then ENUM_ROTH_PROFIT_SHARING_PLAN
  when 'enum_roth_thrift_savings_plan' then ENUM_ROTH_THRIFT_SAVINGS_PLAN
  when 'rrif' then RRIF
  when 'rrsp' then RRSP
  when 'sarsep' then SARSEP
  when 'savings' then SAVINGS
  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 'student' then STUDENT
  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
  else
    default_value
  end
end

.validate(value) ⇒ Object



248
249
250
251
252
# File 'lib/the_plaid_api/models/account_subtype.rb', line 248

def self.validate(value)
  return false if value.nil?

  ACCOUNT_SUBTYPE.include?(value)
end