Class: VitableConnect::Models::EmployerListResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• VitableConnect::Models::EmployerListResponse

Defined in:

lib/vitable_connect/models/employer_list_response.rb,
sig/vitable_connect/models/employer_list_response.rbs

Overview

See Also:

• VitableConnect::Resources::Employers#list

Defined Under Namespace

Classes: Address, BenefitLifecycleStage, EnrollmentRateSummary, HRISStatus

Instance Attribute Summary

• #active ⇒ Boolean

  Whether the employer is currently active in the system.

• #address ⇒ VitableConnect::Models::EmployerListResponse::Address

  Shared read serializer for a postal address on public API responses.

• #benefit_families ⇒ Array<String>

  Distinct benefit-family tags across the employer's active benefits (e.g. MEC, ICHRA, VPC).

• #benefit_lifecycle_stage ⇒ VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage
• #created_at ⇒ Time

  Timestamp when the employer was created.

• #ein ⇒ String^?

  Employer Identification Number (masked in responses).

• #email ⇒ String^?

  Email address for billing and communications.

• #employer_id ⇒ String

  Prefixed employer identifier (empr_<base64-encoded-uuid>).

• #enrollment_rate_summary ⇒ VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary

  Enrolled/eligible employees roll-up.

• #hris_status ⇒ VitableConnect::Models::EmployerListResponse::HRISStatus^?

  HRIS connection, or null when the employer has none.

• #legal_name ⇒ String^?

  Legal business name for compliance and tax purposes.

• #name ⇒ String

  Employer name.

• #organization_id ⇒ String^?

  ID of the parent organization (org_*), or null when unknown.

• #phone_number ⇒ String^?

  Employer phone number.

• #reference_id ⇒ String^?

  The organization's own reference id for this employer, or null when none was assigned.

• #updated_at ⇒ Time

  Timestamp when the employer was last updated.

Instance Method Summary

• #initialize(eligible:, enrolled:, percentage:) ⇒ Object constructor

  Enrolled/eligible employees roll-up.

• #to_hash ⇒ {

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 employees roll-up.

Parameters:

• eligible (Integer) —

  Employees eligible for at least one active benefit.

• enrolled (Integer) —

  Employees enrolled in at least one active benefit.

• percentage (Integer) —

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

# File 'lib/vitable_connect/models/employer_list_response.rb', line 111

Instance Attribute Details

#active ⇒ Boolean

Whether the employer is currently active in the system.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 11

required :active, VitableConnect::Internal::Type::Boolean

#address ⇒ VitableConnect::Models::EmployerListResponse::Address

Shared read serializer for a postal address on public API responses.

One definition for the address block every public resource emits (employer, employee, …), so the 5-field shape isn't hand-rolled per endpoint. Read-only: it renders an already-built address value object (e.g. AddressDVO) whose attributes map 1:1 to these fields.

Parameters:

• value (VitableConnect::Models::EmployerListResponse::Address)

Returns:

• (VitableConnect::Models::EmployerListResponse::Address)

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

required :address, -> { VitableConnect::Models::EmployerListResponse::Address }

#benefit_families ⇒ Array<String>

Distinct benefit-family tags across the employer's active benefits (e.g. MEC, ICHRA, VPC).

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 29

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

#benefit_lifecycle_stage ⇒ VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage

Parameters:

• value (VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage)

Returns:

• (VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage)

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

required :benefit_lifecycle_stage,
-> { VitableConnect::Models::EmployerListResponse::BenefitLifecycleStage }

#created_at ⇒ Time

Timestamp when the employer was created.

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 41

required :created_at, Time

#ein ⇒ String^?

Employer Identification Number (masked in responses).

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 47

required :ein, String, nil?: true

#email ⇒ String^?

Email address for billing and communications.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 53

required :email, String, nil?: true

#employer_id ⇒ String

Prefixed employer identifier (empr_<base64-encoded-uuid>).

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 59

required :employer_id, String

#enrollment_rate_summary ⇒ VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary

Enrolled/eligible employees roll-up.

Parameters:

• value (VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary)

Returns:

• (VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 65

required :enrollment_rate_summary,
-> { VitableConnect::Models::EmployerListResponse::EnrollmentRateSummary }

#hris_status ⇒ VitableConnect::Models::EmployerListResponse::HRISStatus^?

HRIS connection, or null when the employer has none.

Parameters:

• value (VitableConnect::Models::EmployerListResponse::HRISStatus, nil)

Returns:

• (VitableConnect::Models::EmployerListResponse::HRISStatus, nil)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 72

required :hris_status, -> { VitableConnect::Models::EmployerListResponse::HRISStatus }, nil?: true

#legal_name ⇒ String^?

Legal business name for compliance and tax purposes.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 78

required :legal_name, String, nil?: true

#name ⇒ String

Employer name.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 84

required :name, String

#organization_id ⇒ String^?

ID of the parent organization (org_*), or null when unknown.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 90

required :organization_id, String, nil?: true

#phone_number ⇒ String^?

Employer phone number.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :phone_number, String, nil?: true

#reference_id ⇒ String^?

The organization's own reference id for this employer, or null when none was assigned.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/vitable_connect/models/employer_list_response.rb', line 103

required :reference_id, String, nil?: true

#updated_at ⇒ Time

Timestamp when the employer was last updated.

Parameters:

• value (Time)

Returns:

• (Time)

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

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/vitable_connect/models/employer_list_response.rbs', line 75

def to_hash: -> {