Class: ThePlaidApi::EarningsBreakdownCanonicalDescription

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

Overview

Commonly used term to describe the earning line item.

Constant Summary collapse

EARNINGS_BREAKDOWN_CANONICAL_DESCRIPTION = 
[
  # TODO: Write general description for BONUS
  BONUS = 'BONUS'.freeze,

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

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

  # TODO: Write general description for ENUM_PAID_TIME_OFF
  ENUM_PAID_TIME_OFF = 'PAID TIME OFF'.freeze,

  # TODO: Write general description for ENUM_REGULAR_PAY
  ENUM_REGULAR_PAY = 'REGULAR PAY'.freeze,

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

  # TODO: Write general description for ENUM_BASIC_ALLOWANCE_HOUSING
  ENUM_BASIC_ALLOWANCE_HOUSING = 'BASIC ALLOWANCE HOUSING'.freeze,

  # TODO: Write general description for ENUM_BASIC_ALLOWANCE_SUBSISTENCE
  ENUM_BASIC_ALLOWANCE_SUBSISTENCE = 'BASIC ALLOWANCE SUBSISTENCE'.freeze,

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = BONUS) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/the_plaid_api/models/earnings_breakdown_canonical_description.rb', line 44

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

  str = value.to_s.strip

  case str.downcase
  when 'bonus' then BONUS
  when 'commission' then COMMISSION
  when 'overtime' then OVERTIME
  when 'enum_paid_time_off' then ENUM_PAID_TIME_OFF
  when 'enum_regular_pay' then ENUM_REGULAR_PAY
  when 'vacation' then VACATION
  when 'enum_basic_allowance_housing' then ENUM_BASIC_ALLOWANCE_HOUSING
  when 'enum_basic_allowance_subsistence' then ENUM_BASIC_ALLOWANCE_SUBSISTENCE
  when 'other' then OTHER
  else
    default_value
  end
end

.validate(value) ⇒ Object 



38
39
40
41
42
 
# File 'lib/the_plaid_api/models/earnings_breakdown_canonical_description.rb', line 38

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

  EARNINGS_BREAKDOWN_CANONICAL_DESCRIPTION.include?(value)
end