Class: VitableConnect::Models::EmployeeUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/vitable_connect/models/employee_update_params.rb,
sig/vitable_connect/models/employee_update_params.rbs

Overview

See Also:

  • VitableConnect::Resources::Employees#update

Defined Under Namespace

Modules: CompensationType, Gender Classes: Address

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::VitableConnect

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(city:, state:, street_1:, zip_code:, country: nil, street_2: nil) ⇒ Object

Employee's residential address

Parameters:

  • city (String) —

    City name

  • state (String) —

    Two-letter state code

  • street_1 (String) —

    Primary street address

  • zip_code (String) —

    ZIP code

  • country (String) (defaults to: nil) —

    Country code

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

    Secondary street address




# File 'lib/vitable_connect/models/employee_update_params.rb', line 138

Instance Attribute Details

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

Employee's residential address

Parameters:

  • value (VitableConnect::EmployeeUpdateParams::Address, nil)

Returns:



27
 
# File 'lib/vitable_connect/models/employee_update_params.rb', line 27

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

#compensation_type ⇒ Symbol, ...

  • Salary - Salary
  • Hourly - Hourly

Parameters:

  • value (VitableConnect::Models::EmployeeUpdateParams::compensation_type, nil)

Returns:



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

optional :compensation_type,
enum: -> { VitableConnect::EmployeeUpdateParams::CompensationType },
nil?: true

#effective_date ⇒ Date

Past or present date applied to each tracked employment field included in this request

Parameters:

  • value (Date)

Returns:

  • (Date) 


21
 
# File 'lib/vitable_connect/models/employee_update_params.rb', line 21

required :effective_date, Date

#email ⇒ String?

Email address

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :email, String, nil?: true

#employee_class ⇒ Symbol, ...

  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor

Parameters:

  • value (VitableConnect::Models::employee_class, nil)

Returns:



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

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

#employee_id ⇒ String

Unique employee identifier (empl_*)

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/vitable_connect/models/employee_update_params.rb', line 14

required :employee_id, String

#gender ⇒ Symbol, ...

  • Male - Male
  • Female - Female
  • Transgender - Transgender
  • Non-binary - Non-binary
  • Prefer not to respond - Prefer not to respond

Parameters:

  • value (VitableConnect::Models::EmployeeUpdateParams::gender, nil)

Returns:



63
 
# File 'lib/vitable_connect/models/employee_update_params.rb', line 63

optional :gender, enum: -> { VitableConnect::EmployeeUpdateParams::Gender }, nil?: true

#phone ⇒ String?

Phone number

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


69
 
# File 'lib/vitable_connect/models/employee_update_params.rb', line 69

optional :phone, String, nil?: true

#start_date ⇒ Date?

Employment start date

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


75
 
# File 'lib/vitable_connect/models/employee_update_params.rb', line 75

optional :start_date, Date, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/employee_update_params.rb', line 162

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


52
 
# File 'sig/vitable_connect/models/employee_update_params.rbs', line 52

def to_hash: -> {