Class: VitableConnect::Models::Enrollment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/vitable_connect/models/enrollment.rb

Defined Under Namespace

Classes: Benefit

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, answered_at:, benefit:, coverage_end:, coverage_start:, created_at:, employee_deduction_in_cents:, employee_id:, employer_contribution_in_cents:, employer_id:, status:, terminated_at:, updated_at:) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::Enrollment for more details.

Parameters:

  • id (String)

    Unique enrollment identifier (enrl_*)

  • answered_at (Time, nil)

    When the employee enrolled or waived

  • benefit (VitableConnect::Models::Enrollment::Benefit)

    Nested benefit product summary

  • coverage_end (Date, nil)

    Coverage period end date

  • coverage_start (Date)

    Coverage period start date

  • created_at (Time)

    When the enrollment was created

  • employee_deduction_in_cents (Integer, nil)

    Employee monthly payroll deduction in cents

  • employee_id (String)

    Employee ID (empl_*)

  • employer_contribution_in_cents (Integer, nil)

    Employer monthly contribution in cents

  • employer_id (String)

    Employer ID (empr_*)

  • status (Symbol, VitableConnect::Models::EnrollmentStatus)
    • ‘pending` - Pending

  • terminated_at (Time, nil)

    When coverage was terminated

  • updated_at (Time)

    When the enrollment was last updated



# File 'lib/vitable_connect/models/enrollment.rb', line 87

Instance Attribute Details

#answered_atTime?

When the employee enrolled or waived

Returns:

  • (Time, nil)


16
# File 'lib/vitable_connect/models/enrollment.rb', line 16

required :answered_at, Time, nil?: true

#benefitVitableConnect::Models::Enrollment::Benefit

Nested benefit product summary



22
# File 'lib/vitable_connect/models/enrollment.rb', line 22

required :benefit, -> { VitableConnect::Enrollment::Benefit }

#coverage_endDate?

Coverage period end date

Returns:

  • (Date, nil)


28
# File 'lib/vitable_connect/models/enrollment.rb', line 28

required :coverage_end, Date, nil?: true

#coverage_startDate

Coverage period start date

Returns:

  • (Date)


34
# File 'lib/vitable_connect/models/enrollment.rb', line 34

required :coverage_start, Date

#created_atTime

When the enrollment was created

Returns:

  • (Time)


40
# File 'lib/vitable_connect/models/enrollment.rb', line 40

required :created_at, Time

#employee_deduction_in_centsInteger?

Employee monthly payroll deduction in cents

Returns:

  • (Integer, nil)


46
# File 'lib/vitable_connect/models/enrollment.rb', line 46

required :employee_deduction_in_cents, Integer, nil?: true

#employee_idString

Employee ID (empl_*)

Returns:

  • (String)


52
# File 'lib/vitable_connect/models/enrollment.rb', line 52

required :employee_id, String

#employer_contribution_in_centsInteger?

Employer monthly contribution in cents

Returns:

  • (Integer, nil)


58
# File 'lib/vitable_connect/models/enrollment.rb', line 58

required :employer_contribution_in_cents, Integer, nil?: true

#employer_idString

Employer ID (empr_*)

Returns:

  • (String)


64
# File 'lib/vitable_connect/models/enrollment.rb', line 64

required :employer_id, String

#idString

Unique enrollment identifier (enrl_*)

Returns:

  • (String)


10
# File 'lib/vitable_connect/models/enrollment.rb', line 10

required :id, String

#statusSymbol, VitableConnect::Models::EnrollmentStatus

  • ‘pending` - Pending

  • ‘enrolled` - Enrolled

  • ‘waived` - Waived

  • ‘inactive` - Inactive



73
# File 'lib/vitable_connect/models/enrollment.rb', line 73

required :status, enum: -> { VitableConnect::EnrollmentStatus }

#terminated_atTime?

When coverage was terminated

Returns:

  • (Time, nil)


79
# File 'lib/vitable_connect/models/enrollment.rb', line 79

required :terminated_at, Time, nil?: true

#updated_atTime

When the enrollment was last updated

Returns:

  • (Time)


85
# File 'lib/vitable_connect/models/enrollment.rb', line 85

required :updated_at, Time