Class: ThePlaidApi::InvestmentTransactionSubtype

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

Overview

For descriptions of possible transaction types and subtypes, see the [Investment transaction types schema](plaid.com/docs/api/accounts/#investment-transaction-types-sc hema).

Constant Summary collapse

INVESTMENT_TRANSACTION_SUBTYPE = 
[
  # TODO: Write general description for ENUM_ACCOUNT_FEE
  ENUM_ACCOUNT_FEE = 'account fee'.freeze,

  # TODO: Write general description for ADJUSTMENT
  ADJUSTMENT = 'adjustment'.freeze,

  # TODO: Write general description for ASSIGNMENT
  ASSIGNMENT = 'assignment'.freeze,

  # TODO: Write general description for BUY
  BUY = 'buy'.freeze,

  # TODO: Write general description for ENUM_BUY_TO_COVER
  ENUM_BUY_TO_COVER = 'buy to cover'.freeze,

  # TODO: Write general description for CONTRIBUTION
  CONTRIBUTION = 'contribution'.freeze,

  # TODO: Write general description for DEPOSIT
  DEPOSIT = 'deposit'.freeze,

  # TODO: Write general description for DISTRIBUTION
  DISTRIBUTION = 'distribution'.freeze,

  # TODO: Write general description for DIVIDEND
  DIVIDEND = 'dividend'.freeze,

  # TODO: Write general description for ENUM_DIVIDEND_REINVESTMENT
  ENUM_DIVIDEND_REINVESTMENT = 'dividend reinvestment'.freeze,

  # TODO: Write general description for EXERCISE
  EXERCISE = 'exercise'.freeze,

  # TODO: Write general description for EXPIRE
  EXPIRE = 'expire'.freeze,

  # TODO: Write general description for ENUM_FUND_FEE
  ENUM_FUND_FEE = 'fund fee'.freeze,

  # TODO: Write general description for INTEREST
  INTEREST = 'interest'.freeze,

  # TODO: Write general description for ENUM_INTEREST_RECEIVABLE
  ENUM_INTEREST_RECEIVABLE = 'interest receivable'.freeze,

  # TODO: Write general description for ENUM_INTEREST_REINVESTMENT
  ENUM_INTEREST_REINVESTMENT = 'interest reinvestment'.freeze,

  # TODO: Write general description for ENUM_LEGAL_FEE
  ENUM_LEGAL_FEE = 'legal fee'.freeze,

  # TODO: Write general description for ENUM_LOAN_PAYMENT
  ENUM_LOAN_PAYMENT = 'loan payment'.freeze,

  # TODO: Write general description for ENUM_LONGTERM_CAPITAL_GAIN
  ENUM_LONGTERM_CAPITAL_GAIN = 'long-term capital gain'.freeze,

  # TODO: Write general description for
  # ENUM_LONGTERM_CAPITAL_GAIN_REINVESTMENT
  ENUM_LONGTERM_CAPITAL_GAIN_REINVESTMENT = 'long-term capital gain reinvestment'.freeze,

  # TODO: Write general description for ENUM_MANAGEMENT_FEE
  ENUM_MANAGEMENT_FEE = 'management fee'.freeze,

  # TODO: Write general description for ENUM_MARGIN_EXPENSE
  ENUM_MARGIN_EXPENSE = 'margin expense'.freeze,

  # TODO: Write general description for MERGER
  MERGER = 'merger'.freeze,

  # TODO: Write general description for ENUM_MISCELLANEOUS_FEE
  ENUM_MISCELLANEOUS_FEE = 'miscellaneous fee'.freeze,

  # TODO: Write general description for ENUM_NONQUALIFIED_DIVIDEND
  ENUM_NONQUALIFIED_DIVIDEND = 'non-qualified dividend'.freeze,

  # TODO: Write general description for ENUM_NONRESIDENT_TAX
  ENUM_NONRESIDENT_TAX = 'non-resident tax'.freeze,

  # TODO: Write general description for ENUM_PENDING_CREDIT
  ENUM_PENDING_CREDIT = 'pending credit'.freeze,

  # TODO: Write general description for ENUM_PENDING_DEBIT
  ENUM_PENDING_DEBIT = 'pending debit'.freeze,

  # TODO: Write general description for ENUM_QUALIFIED_DIVIDEND
  ENUM_QUALIFIED_DIVIDEND = 'qualified dividend'.freeze,

  # TODO: Write general description for REBALANCE
  REBALANCE = 'rebalance'.freeze,

  # TODO: Write general description for ENUM_RETURN_OF_PRINCIPAL
  ENUM_RETURN_OF_PRINCIPAL = 'return of principal'.freeze,

  # TODO: Write general description for REQUEST
  REQUEST = 'request'.freeze,

  # TODO: Write general description for SELL
  SELL = 'sell'.freeze,

  # TODO: Write general description for ENUM_SELL_SHORT
  ENUM_SELL_SHORT = 'sell short'.freeze,

  # TODO: Write general description for SEND
  SEND = 'send'.freeze,

  # TODO: Write general description for ENUM_SHORTTERM_CAPITAL_GAIN
  ENUM_SHORTTERM_CAPITAL_GAIN = 'short-term capital gain'.freeze,

  # TODO: Write general description for
  # ENUM_SHORTTERM_CAPITAL_GAIN_REINVESTMENT
  ENUM_SHORTTERM_CAPITAL_GAIN_REINVESTMENT = 'short-term capital gain reinvestment'.freeze,

  # TODO: Write general description for ENUM_SPIN_OFF
  ENUM_SPIN_OFF = 'spin off'.freeze,

  # TODO: Write general description for SPLIT
  SPLIT = 'split'.freeze,

  # TODO: Write general description for ENUM_STOCK_DISTRIBUTION
  ENUM_STOCK_DISTRIBUTION = 'stock distribution'.freeze,

  # TODO: Write general description for TAX
  TAX = 'tax'.freeze,

  # TODO: Write general description for ENUM_TAX_WITHHELD
  ENUM_TAX_WITHHELD = 'tax withheld'.freeze,

  # TODO: Write general description for TRADE
  TRADE = 'trade'.freeze,

  # TODO: Write general description for TRANSFER
  TRANSFER = 'transfer'.freeze,

  # TODO: Write general description for ENUM_TRANSFER_FEE
  ENUM_TRANSFER_FEE = 'transfer fee'.freeze,

  # TODO: Write general description for ENUM_TRUST_FEE
  ENUM_TRUST_FEE = 'trust fee'.freeze,

  # TODO: Write general description for ENUM_UNQUALIFIED_GAIN
  ENUM_UNQUALIFIED_GAIN = 'unqualified gain'.freeze,

  # TODO: Write general description for WITHDRAWAL
  WITHDRAWAL = 'withdrawal'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = ENUM_ACCOUNT_FEE) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/the_plaid_api/models/investment_transaction_subtype.rb', line 166

def self.from_value(value, default_value = ENUM_ACCOUNT_FEE)
  return default_value if value.nil?

  str = value.to_s.strip

  case str.downcase
  when 'enum_account_fee' then ENUM_ACCOUNT_FEE
  when 'adjustment' then ADJUSTMENT
  when 'assignment' then ASSIGNMENT
  when 'buy' then BUY
  when 'enum_buy_to_cover' then ENUM_BUY_TO_COVER
  when 'contribution' then CONTRIBUTION
  when 'deposit' then DEPOSIT
  when 'distribution' then DISTRIBUTION
  when 'dividend' then DIVIDEND
  when 'enum_dividend_reinvestment' then ENUM_DIVIDEND_REINVESTMENT
  when 'exercise' then EXERCISE
  when 'expire' then EXPIRE
  when 'enum_fund_fee' then ENUM_FUND_FEE
  when 'interest' then INTEREST
  when 'enum_interest_receivable' then ENUM_INTEREST_RECEIVABLE
  when 'enum_interest_reinvestment' then ENUM_INTEREST_REINVESTMENT
  when 'enum_legal_fee' then ENUM_LEGAL_FEE
  when 'enum_loan_payment' then ENUM_LOAN_PAYMENT
  when 'enum_longterm_capital_gain' then ENUM_LONGTERM_CAPITAL_GAIN
  when 'enum_longterm_capital_gain_reinvestment' then ENUM_LONGTERM_CAPITAL_GAIN_REINVESTMENT
  when 'enum_management_fee' then ENUM_MANAGEMENT_FEE
  when 'enum_margin_expense' then ENUM_MARGIN_EXPENSE
  when 'merger' then MERGER
  when 'enum_miscellaneous_fee' then ENUM_MISCELLANEOUS_FEE
  when 'enum_nonqualified_dividend' then ENUM_NONQUALIFIED_DIVIDEND
  when 'enum_nonresident_tax' then ENUM_NONRESIDENT_TAX
  when 'enum_pending_credit' then ENUM_PENDING_CREDIT
  when 'enum_pending_debit' then ENUM_PENDING_DEBIT
  when 'enum_qualified_dividend' then ENUM_QUALIFIED_DIVIDEND
  when 'rebalance' then REBALANCE
  when 'enum_return_of_principal' then ENUM_RETURN_OF_PRINCIPAL
  when 'request' then REQUEST
  when 'sell' then SELL
  when 'enum_sell_short' then ENUM_SELL_SHORT
  when 'send' then SEND
  when 'enum_shortterm_capital_gain' then ENUM_SHORTTERM_CAPITAL_GAIN
  when 'enum_shortterm_capital_gain_reinvestment' then ENUM_SHORTTERM_CAPITAL_GAIN_REINVESTMENT
  when 'enum_spin_off' then ENUM_SPIN_OFF
  when 'split' then SPLIT
  when 'enum_stock_distribution' then ENUM_STOCK_DISTRIBUTION
  when 'tax' then TAX
  when 'enum_tax_withheld' then ENUM_TAX_WITHHELD
  when 'trade' then TRADE
  when 'transfer' then TRANSFER
  when 'enum_transfer_fee' then ENUM_TRANSFER_FEE
  when 'enum_trust_fee' then ENUM_TRUST_FEE
  when 'enum_unqualified_gain' then ENUM_UNQUALIFIED_GAIN
  when 'withdrawal' then WITHDRAWAL
  else
    default_value
  end
end

.validate(value) ⇒ Object 



160
161
162
163
164
 
# File 'lib/the_plaid_api/models/investment_transaction_subtype.rb', line 160

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

  INVESTMENT_TRANSACTION_SUBTYPE.include?(value)
end