Module: VitableConnect::Internal::Types::Enum

Includes:
Type
Included in:
Types::AccessMethod, Types::AdditionalAccessMethod, Types::BenefitFamily, Types::BenefitFamilyParamItem, Types::BenefitLifecycleStageItem, Types::BenefitStatus, Types::BoundEntityType, Types::CardType, Types::Category, Types::ClassificationCorrectionSource, Types::CompensationType, Types::ContributionClassCompensation, Types::ContributionClassEmployment, Types::ContributionClassLocation, Types::CoverageTier, Types::DeductionFrequency, Types::ElectionStatusItem, Types::EligibilityRuleCompensationType, Types::EligibilityRuleEmployeeClass, Types::EligibleGeographicalLocationType, Types::EmployeeClass, Types::EmployeeStatus, Types::EnrollmentStatus, Types::EventName, Types::Gender, Types::GrantType, Types::GroupMemberSyncFailureOperation, Types::HouseholdMemberRelationship, Types::HouseholdMemberType, Types::HrisStatusItem, Types::IdpProvider, Types::MaritalStatus, Types::MemberStatus, Types::MissingEmployeeResolution, Types::NameSuffix, Types::OrganizationType, Types::OrganizationUserRole, Types::PlanYearEnrollmentElectionStatus, Types::PlanYearEnrollmentPolicyStatus, Types::PreferredLanguage, Types::ProductCode, Types::QualifyingLifeEventStatus, Types::QualifyingLifeEventType, Types::Relationship, Types::RemainingEmployeeAction, Types::ResourceType, Types::SexAtBirth, Types::State, Types::Status, Types::TaxClassification, Types::TerminationRule, Types::WaitingPeriod
Defined in:
lib/VitableConnect/internal/types/enum.rb

Overview

Module for defining enums

Instance Method Summary collapse

Methods included from JSON::Serializable

#dump

Instance Method Details

#coerce(value, strict: strict?) ) ⇒ Object

Raises:



32
33
34
35
36
37
38
39
40
 
# File 'lib/VitableConnect/internal/types/enum.rb', line 32

def coerce(value, strict: strict?)
  coerced_value = Utils.coerce(Symbol, value)

  return coerced_value if values.include?(coerced_value)

  raise Errors::TypeError, "`#{value}` not in enum #{self}" if strict

  value
end

#finalize! ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



18
19
20
 
# File 'lib/VitableConnect/internal/types/enum.rb', line 18

def finalize!
  values
end

#inspect ⇒ Object 



50
51
52
 
# File 'lib/VitableConnect/internal/types/enum.rb', line 50

def inspect
  "#{name}[#{values.join(", ")}]"
end

#load(str) ⇒ String

Parse JSON string and coerce to the enum value

Parameters:

  • str (String) —

    JSON string to parse

Returns:

  • (String) —

    The enum value



46
47
48
 
# File 'lib/VitableConnect/internal/types/enum.rb', line 46

def load(str)
  coerce(::JSON.parse(str))
end

#strict! ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



28
29
30
 
# File 'lib/VitableConnect/internal/types/enum.rb', line 28

def strict!
  @strict = true
end

#strict? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



23
24
25
 
# File 'lib/VitableConnect/internal/types/enum.rb', line 23

def strict?
  @strict ||= false
end

#values ⇒ Array<Object>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



13
14
15
 
# File 'lib/VitableConnect/internal/types/enum.rb', line 13

def values
  @values ||= constants.map { |c| const_get(c) }
end