Class: VitableConnect::Models::Employee

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/vitable_connect/models/employee.rb

Defined Under Namespace

Classes: Address, Deduction

Instance Attribute Summary

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

  Employee’s residential address.

• #created_at ⇒ Time

  Timestamp when the employee was created.

• #date_of_birth ⇒ Date

  Date of birth (YYYY-MM-DD).

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

  Payroll deductions from the most recent statement period.

• #email ⇒ String

  Email address.

• #employee_class ⇒ Symbol, ...

  • ‘Full Time` - Full Time - `Part Time` - Part Time - `Temporary` - Temporary - `Intern` - Intern - `Seasonal` - Seasonal - `Individual Contractor` - Individual Contractor.

• #first_name ⇒ String

  Employee’s legal first name.

• #gender ⇒ String^?

  Gender identity, if provided.

• #hire_date ⇒ Date^?

  Employee’s hire date with the employer.

• #last_name ⇒ String

  Employee’s legal last name.

• #phone ⇒ String^?

  Phone number (10-digit US domestic string).

• #reference_id ⇒ String^?

  Partner-assigned reference ID for the employee.

• #suffix ⇒ String^?

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

• #termination_date ⇒ Date^?

  Employee’s termination date, if terminated.

• #updated_at ⇒ Time

  Timestamp when the employee was last updated.

Class Method Summary

• .values ⇒ Array<Symbol>

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from VitableConnect::Internal::Type::BaseModel

Instance Attribute Details

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

Employee’s residential address

Returns:

• (VitableConnect::Models::Employee::Address, nil)

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

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

#created_at ⇒ Time

Timestamp when the employee was created

Returns:

• (Time)

# 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)

# 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:

• (Array<VitableConnect::Models::Employee::Deduction>)

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

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

#email ⇒ String

Email address

Returns:

• (String)

# 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:

• (Symbol, VitableConnect::Models::EmployeeClass, nil)

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

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

#first_name ⇒ String

Employee’s legal first name

Returns:

• (String)

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

required :first_name, String

#gender ⇒ String^?

Gender identity, if provided

Returns:

• (String, nil)

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

optional :gender, String, nil?: true

#hire_date ⇒ Date^?

Employee’s hire date with the employer

Returns:

• (Date, nil)

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

optional :hire_date, Date, nil?: true

#last_name ⇒ String

Employee’s legal last name

Returns:

• (String)

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

required :last_name, String

#phone ⇒ String^?

Phone number (10-digit US domestic string)

Returns:

• (String, nil)

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

optional :phone, String, nil?: true

#reference_id ⇒ String^?

Partner-assigned reference ID for the employee

Returns:

• (String, nil)

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

optional :reference_id, String, nil?: true

#suffix ⇒ String^?

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

Returns:

• (String, nil)

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

optional :suffix, String, nil?: true

#termination_date ⇒ Date^?

Employee’s termination date, if terminated

Returns:

• (Date, nil)

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

optional :termination_date, Date, nil?: true

#updated_at ⇒ Time

Timestamp when the employee was last updated

Returns:

• (Time)

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

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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