Class: VitableConnect::Models::Employer

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

Defined Under Namespace

Classes: Address, Contact

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(address_line_1:, city:, state:, zipcode:, address_line_2: nil) ⇒ Object

Nested address within EmployerSerializer.

Parameters:

  • address_line_1 (String) —

    Primary street address

  • city (String) —

    City name

  • state (String) —

    Two-letter state code (e.g., CA, NY)

  • zipcode (String) —

    ZIP code (5 or 9 digit)

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

    Secondary street address (apt, suite, etc.)




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

Instance Attribute Details

#active ⇒ Boolean

Whether the employer is currently active in the system

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

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

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

Nested address within EmployerSerializer.

Parameters:

  • value (VitableConnect::Employer::Address)

Returns:



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

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

#contact ⇒ VitableConnect::Employer::Contact?

Returns the value of attribute contact.

Returns:

  • (VitableConnect::Employer::Contact, nil) 


41
42
43
 
# File 'sig/vitable_connect/models/employer.rbs', line 41

def contact
  @contact
end

#created_at ⇒ Time

Timestamp when the employer was created

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#ein ⇒ String?

Returns the value of attribute ein.

Returns:

  • (String, nil) 


43
44
45
 
# File 'sig/vitable_connect/models/employer.rbs', line 43

def ein
  @ein
end

#email ⇒ String?

Email address for billing and communications

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :email, String, nil?: true

#id ⇒ String

Returns the value of attribute id.

Returns:

  • (String) 


39
40
41
 
# File 'sig/vitable_connect/models/employer.rbs', line 39

def id
  @id
end

#legal_name ⇒ String

Legal business name for compliance and tax purposes

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :legal_name, String

#name ⇒ String

Display name of the employer

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :name, String

#organization_id ⇒ String?

Returns the value of attribute organization_id.

Returns:

  • (String, nil) 


45
46
47
 
# File 'sig/vitable_connect/models/employer.rbs', line 45

def organization_id
  @organization_id
end

#phone_number ⇒ String?

Employer phone number (E.164 format recommended)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :phone_number, String, nil?: true

#reference_id ⇒ String?

Partner-assigned reference ID for the employer

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :reference_id, String, nil?: true

#updated_at ⇒ Time

Timestamp when the employer was last updated

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/vitable_connect/models/employer.rbs', line 63

def to_hash: -> {