Class: VitableConnect::Models::Employee

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

Defined Under Namespace

Classes: Address, Deduction, Enrollment

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(id:, status:, answered_at: nil) ⇒ Object

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

Parameters:

  • id (String) —

    Unique enrollment identifier with ‘enrl_’ prefix

  • status (Symbol, VitableConnect::Models::EnrollmentStatus) —

    • ‘pending` - Pending

  • answered_at (Time, nil) (defaults to: nil) —

    Timestamp when the enrollment decision was made




# File 'lib/vitable_connect/models/employee.rb', line 296

Instance Attribute Details

#address ⇒ VitableConnect::Models::Employee::Address?

Employee’s residential address

Returns:



60
 
# File 'lib/vitable_connect/models/employee.rb', line 60

optional :address, -> { VitableConnect::Employee::Address }, nil?: true

#created_at ⇒ Time

Timestamp when the employee was created

Returns:

  • (Time) 


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

required :created_at, Time

#date_of_birth ⇒ Date

Date of birth (YYYY-MM-DD)

Returns:

  • (Date) 


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

required :date_of_birth, Date

#deductions ⇒ Array<VitableConnect::Models::Employee::Deduction>

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

Returns:



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

required :deductions, -> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Employee::Deduction] }

#email ⇒ String

Email address

Returns:

  • (String) 


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

required :email, String

#employee_class ⇒ Symbol, ...

  • ‘Full Time` - Full Time

  • ‘Part Time` - Part Time

  • ‘Temporary` - Temporary

  • ‘Intern` - Intern

  • ‘Seasonal` - Seasonal

  • ‘Individual Contractor` - Individual Contractor

Returns:



71
 
# File 'lib/vitable_connect/models/employee.rb', line 71

optional :employee_class, enum: -> { VitableConnect::EmployeeClass }, nil?: true

#enrollments ⇒ Array<VitableConnect::Models::Employee::Enrollment>

Benefit enrollments for this employee

Returns:



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

required :enrollments,
-> { VitableConnect::Internal::Type::ArrayOf[VitableConnect::Employee::Enrollment] }

#first_name ⇒ String

Employee’s legal first name

Returns:

  • (String) 


42
 
# File 'lib/vitable_connect/models/employee.rb', line 42

required :first_name, String

#gender ⇒ String?

Gender identity, if provided

Returns:

  • (String, nil) 


77
 
# File 'lib/vitable_connect/models/employee.rb', line 77

optional :gender, String, nil?: true

#hire_date ⇒ Date?

Employee’s hire date with the employer

Returns:

  • (Date, nil) 


83
 
# File 'lib/vitable_connect/models/employee.rb', line 83

optional :hire_date, Date, nil?: true

#last_name ⇒ String

Employee’s legal last name

Returns:

  • (String) 


48
 
# File 'lib/vitable_connect/models/employee.rb', line 48

required :last_name, String

#phone ⇒ String?

Phone number (10-digit US domestic string)

Returns:

  • (String, nil) 


89
 
# File 'lib/vitable_connect/models/employee.rb', line 89

optional :phone, String, nil?: true

#reference_id ⇒ String?

Partner-assigned reference ID for the employee

Returns:

  • (String, nil) 


95
 
# File 'lib/vitable_connect/models/employee.rb', line 95

optional :reference_id, String, nil?: true

#suffix ⇒ String?

Name suffix (e.g., Jr., Sr., III)

Returns:

  • (String, nil) 


101
 
# File 'lib/vitable_connect/models/employee.rb', line 101

optional :suffix, String, nil?: true

#termination_date ⇒ Date?

Employee’s termination date, if terminated

Returns:

  • (Date, nil) 


107
 
# File 'lib/vitable_connect/models/employee.rb', line 107

optional :termination_date, Date, nil?: true

#updated_at ⇒ Time

Timestamp when the employee was last updated

Returns:

  • (Time) 


54
 
# File 'lib/vitable_connect/models/employee.rb', line 54

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/employee.rb', line 267