Class: VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb,
sig/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rbs

Overview

See Also:

  • VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse#data

Defined Under Namespace

Modules: Family, Status Classes: ContributionStrategy, EligibilityPolicy, EmployeeContribution, EmployerContribution, EnrollmentRate

Instance Attribute Summary collapse

Class Method 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(eligible:, enrolled:, percentage:) ⇒ Object

Enrolled/eligible rate for this plan year.

Parameters:

  • eligible (Integer) —

    Employees eligible for this plan year.

  • enrolled (Integer) —

    Employees enrolled in this plan year.

  • percentage (Integer) —

    enrolled / eligible whole-number percent (0 when none).




# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 170

Instance Attribute Details

#benefit_id ⇒ String

Prefixed benefit identifier (bprd_*).

Parameters:

  • value (String)

Returns:

  • (String) 


32
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 32

required :benefit_id, String

#benefit_plan_year_id ⇒ String

Prefixed plan-year identifier (plyr_*).

Parameters:

  • value (String)

Returns:

  • (String) 


38
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 38

required :benefit_plan_year_id, String

#carrier ⇒ String?

Carrier name, or null (e.g. ICHRA).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


44
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 44

required :carrier, String, nil?: true

#contribution_strategy ⇒ VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::ContributionStrategy

How the plan year prices contributions: exactly one collection is populated, determined by the plan year's family (ICHRA vs tier-priced).

Parameters:

Returns:



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

required :contribution_strategy,
-> { VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::ContributionStrategy }

#coverage_end ⇒ Date?

Coverage end.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


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

required :coverage_end, Date, nil?: true

#coverage_start ⇒ Date

Coverage start.

Parameters:

  • value (Date)

Returns:

  • (Date) 


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

required :coverage_start, Date

#eligibility_policy ⇒ VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::EligibilityPolicy?

The plan year's active eligibility policy. Mirrors the internal PlanYearEligibilityPolicyDTO but exposes only the public subset (no raw ids, active_in, or timestamps).

Parameters:

Returns:



72
73
74
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 72

required :eligibility_policy,
-> { VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::EligibilityPolicy },
nil?: true

#employee_contribution ⇒ VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::EmployeeContribution?

Employee contribution range.

Parameters:

Returns:



80
81
82
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 80

required :employee_contribution,
-> { VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::EmployeeContribution },
nil?: true

#employer_contribution ⇒ VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::EmployerContribution?

Employer contribution range.

Parameters:

Returns:



88
89
90
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 88

required :employer_contribution,
-> { VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::EmployerContribution },
nil?: true

#enrollment_rate ⇒ VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::EnrollmentRate

Enrolled/eligible rate for this plan year.

Parameters:

Returns:



96
97
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 96

required :enrollment_rate,
-> { VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::EnrollmentRate }

#family ⇒ Symbol, VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::Family

  • mec - Mec
  • mvp - Mvp
  • ichra - Ichra
  • vpc - Vpc
  • dental - Dental
  • vision - Vision

Parameters:

  • value (VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::family)

Returns:



108
109
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 108

required :family,
enum: -> { VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::Family }

#network_names ⇒ Array<String>

Displayed networks: ["multi"] for ICHRA, otherwise the plan year's distinct network names.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


116
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 116

required :network_names, VitableConnect::Internal::Type::ArrayOf[String]

#offered_states ⇒ Array<String>

Distinct offered state codes.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


122
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 122

required :offered_states, VitableConnect::Internal::Type::ArrayOf[String]

#open_enrollment_end ⇒ Date?

Open-enrollment end.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


128
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 128

required :open_enrollment_end, Date, nil?: true

#open_enrollment_start ⇒ Date

Open-enrollment start.

Parameters:

  • value (Date)

Returns:

  • (Date) 


134
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 134

required :open_enrollment_start, Date

#premium_in_cents ⇒ Integer?

Monthly premium in cents; only for an ICHRA benefit with effective coverage.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


140
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 140

required :premium_in_cents, Integer, nil?: true

#product_name ⇒ String

Benefit/product display name.

Parameters:

  • value (String)

Returns:

  • (String) 


146
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 146

required :product_name, String

#spd_file_url ⇒ String?

Summary Plan Description (SPD) link, or null.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


152
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 152

required :spd_file_url, String, nil?: true

#status ⇒ Symbol, VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::Status

  • active - Active
  • upcoming - Upcoming
  • open_enrollment - Open Enrollment
  • inactive - Inactive

Parameters:

  • value (VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::status)

Returns:



161
162
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 161

required :status,
enum: -> { VitableConnect::Models::EmployerRetrieveBenefitPlanYearResponse::Data::Status }

#year ⇒ Integer

Calendar coverage year.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


168
 
# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 168

required :year, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rb', line 482

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


107
 
# File 'sig/vitable_connect/models/employer_retrieve_benefit_plan_year_response.rbs', line 107

def to_hash: -> {