Class: VitableConnect::Models::Employer

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

Overview

See Also:

Defined Under Namespace

Classes: Address

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:, active:, address:, created_at:, ein:, eligibility_policy_id:, legal_name:, name:, organization_id:, updated_at:, email: nil, phone_number: nil, reference_id: nil) ⇒ Object

Serializer for Employer entity in public API responses.

Parameters:

  • id (String) —

    Unique employer identifier with ‘empr_’ prefix

  • active (Boolean) —

    Whether the employer is currently active in the system

  • address (VitableConnect::Models::Employer::Address) —

    Nested address within EmployerSerializer.

  • created_at (Time) —

    Timestamp when the employer was created

  • ein (String, nil) —

    Employer Identification Number (masked in responses)

  • eligibility_policy_id (String, nil) —

    ID of the benefit eligibility policy (epol_*), if assigned

  • legal_name (String) —

    Legal business name for compliance and tax purposes

  • name (String) —

    Display name of the employer

  • organization_id (String, nil) —

    ID of the parent organization (org_*)

  • updated_at (Time) —

    Timestamp when the employer was last updated

  • email (String, nil) (defaults to: nil) —

    Email address for billing and communications

  • phone_number (String, nil) (defaults to: nil) —

    Employer phone number (E.164 format recommended)

  • reference_id (String, nil) (defaults to: nil) —

    Partner-assigned reference ID for the employer




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

Instance Attribute Details

#active ⇒ Boolean

Whether the employer is currently active in the system

Returns:

  • (Boolean) 


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

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

#address ⇒ VitableConnect::Models::Employer::Address

Nested address within EmployerSerializer.

Returns:



17
 
# File 'lib/vitable_connect/models/employer.rb', line 17

required :address, -> { VitableConnect::Employer::Address }

#created_at ⇒ Time

Timestamp when the employer was created

Returns:

  • (Time) 


23
 
# File 'lib/vitable_connect/models/employer.rb', line 23

required :created_at, Time

#email ⇒ String?

Email address for billing and communications

Returns:

  • (String, nil) 


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

optional :email, String, nil?: true

#legal_name ⇒ String

Legal business name for compliance and tax purposes

Returns:

  • (String) 


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

required :legal_name, String

#name ⇒ String

Display name of the employer

Returns:

  • (String) 


35
 
# File 'lib/vitable_connect/models/employer.rb', line 35

required :name, String

#phone_number ⇒ String?

Employer phone number (E.164 format recommended)

Returns:

  • (String, nil) 


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

optional :phone_number, String, nil?: true

#reference_id ⇒ String?

Partner-assigned reference ID for the employer

Returns:

  • (String, nil) 


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

optional :reference_id, String, nil?: true

#updated_at ⇒ Time

Timestamp when the employer was last updated

Returns:

  • (Time) 


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

required :updated_at, Time