Class: VitableConnect::Models::EmployeeUpdateParams::Address

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

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(employee_id:, effective_date:, address: nil, compensation_type: nil, email: nil, employee_class: nil, gender: nil, phone: nil, start_date: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::EmployeeUpdateParams for more details.

Parameters:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/vitable_connect/models/employee_update_params.rb', line 101

class Address < VitableConnect::Internal::Type::BaseModel
  # @!attribute city
  #   City name
  #
  #   @return [String]
  required :city, String

  # @!attribute state
  #   Two-letter state code
  #
  #   @return [String]
  required :state, String

  # @!attribute street_1
  #   Primary street address
  #
  #   @return [String]
  required :street_1, String

  # @!attribute zip_code
  #   ZIP code
  #
  #   @return [String]
  required :zip_code, String

  # @!attribute country
  #   Country code
  #
  #   @return [String, nil]
  optional :country, String

  # @!attribute street_2
  #   Secondary street address
  #
  #   @return [String, nil]
  optional :street_2, String, nil?: true

  # @!method initialize(city:, state:, street_1:, zip_code:, country: nil, street_2: nil)
  #   Employee's residential address
  #
  #   @param city [String] City name
  #
  #   @param state [String] Two-letter state code
  #
  #   @param street_1 [String] Primary street address
  #
  #   @param zip_code [String] ZIP code
  #
  #   @param country [String] Country code
  #
  #   @param street_2 [String, nil] Secondary street address
end

Instance Attribute Details

#city ⇒ String

City name

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :city, String

#country ⇒ String?

Country code

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :country, String

#state ⇒ String

Two-letter state code

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :state, String

#street_1 ⇒ String

Primary street address

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :street_1, String

#street_2 ⇒ String?

Secondary street address

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :street_2, String, nil?: true

#zip_code ⇒ String

ZIP code

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :zip_code, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {