Class: VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee

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

Defined Under Namespace

Modules: CompensationType Classes: Address

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(date_of_birth:, email:, first_name:, last_name:, phone:, address: nil, compensation_type: nil, employee_class: nil, reference_id: nil, start_date: nil) ⇒ Object

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

Parameters:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/vitable_connect/models/employer_submit_census_sync_params.rb', line 29

class Employee < VitableConnect::Internal::Type::BaseModel
  # @!attribute date_of_birth
  #
  #   @return [Date]
  required :date_of_birth, Date

  # @!attribute email
  #
  #   @return [String]
  required :email, String

  # @!attribute first_name
  #
  #   @return [String]
  required :first_name, String

  # @!attribute last_name
  #
  #   @return [String]
  required :last_name, String

  # @!attribute phone
  #
  #   @return [String]
  required :phone, String

  # @!attribute address
  #
  #   @return [VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address, nil]
  optional :address,
           -> {
             VitableConnect::EmployerSubmitCensusSyncParams::Employee::Address
           },
           nil?: true

  # @!attribute compensation_type
  #   - `Salary` - Salary
  #   - `Hourly` - Hourly
  #
  #   @return [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::CompensationType, nil]
  optional :compensation_type,
           enum: -> { VitableConnect::EmployerSubmitCensusSyncParams::Employee::CompensationType },
           nil?: true

  # @!attribute employee_class
  #   - `Full Time` - Full Time
  #   - `Part Time` - Part Time
  #   - `Temporary` - Temporary
  #   - `Intern` - Intern
  #   - `Seasonal` - Seasonal
  #   - `Individual Contractor` - Individual Contractor
  #
  #   @return [Symbol, VitableConnect::Models::EmployeeClass, nil]
  optional :employee_class, enum: -> { VitableConnect::EmployeeClass }, nil?: true

  # @!attribute reference_id
  #
  #   @return [String, nil]
  optional :reference_id, String, nil?: true

  # @!attribute start_date
  #
  #   @return [Date, nil]
  optional :start_date, Date, nil?: true

  # @!method initialize(date_of_birth:, email:, first_name:, last_name:, phone:, address: nil, compensation_type: nil, employee_class: nil, reference_id: nil, start_date: nil)
  #   Some parameter documentations has been truncated, see
  #   {VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee} for more
  #   details.
  #
  #   @param date_of_birth [Date]
  #
  #   @param email [String]
  #
  #   @param first_name [String]
  #
  #   @param last_name [String]
  #
  #   @param phone [String]
  #
  #   @param address [VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address, nil]
  #
  #   @param compensation_type [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::CompensationType, nil] - `Salary` - Salary
  #
  #   @param employee_class [Symbol, VitableConnect::Models::EmployeeClass, nil] - `Full Time` - Full Time
  #
  #   @param reference_id [String, nil]
  #
  #   @param start_date [Date, nil]

  # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee#address
  class Address < VitableConnect::Internal::Type::BaseModel
    # @!attribute address_line_1
    #
    #   @return [String]
    required :address_line_1, String

    # @!attribute city
    #
    #   @return [String]
    required :city, String

    # @!attribute state
    #   - `AL` - AL
    #   - `AK` - AK
    #   - `AZ` - AZ
    #   - `AR` - AR
    #   - `CA` - CA
    #   - `CO` - CO
    #   - `CT` - CT
    #   - `DC` - DC
    #   - `DE` - DE
    #   - `FL` - FL
    #   - `GA` - GA
    #   - `HI` - HI
    #   - `ID` - ID
    #   - `IL` - IL
    #   - `IN` - IN
    #   - `IA` - IA
    #   - `KS` - KS
    #   - `KY` - KY
    #   - `LA` - LA
    #   - `ME` - ME
    #   - `MD` - MD
    #   - `MA` - MA
    #   - `MI` - MI
    #   - `MN` - MN
    #   - `MS` - MS
    #   - `MO` - MO
    #   - `MT` - MT
    #   - `NE` - NE
    #   - `NV` - NV
    #   - `NH` - NH
    #   - `NJ` - NJ
    #   - `NM` - NM
    #   - `NY` - NY
    #   - `NC` - NC
    #   - `ND` - ND
    #   - `OH` - OH
    #   - `OK` - OK
    #   - `OR` - OR
    #   - `PA` - PA
    #   - `RI` - RI
    #   - `SC` - SC
    #   - `SD` - SD
    #   - `TN` - TN
    #   - `TX` - TX
    #   - `UT` - UT
    #   - `VT` - VT
    #   - `VA` - VA
    #   - `WA` - WA
    #   - `WI` - WI
    #   - `WV` - WV
    #   - `WY` - WY
    #   - `PR` - PR
    #   - `GU` - GU
    #   - `AS` - AS
    #   - `VI` - VI
    #   - `MP` - MP
    #   - `MH` - MH
    #   - `PW` - PW
    #   - `FM` - FM
    #   - `AE` - AE
    #   - `AA` - AA
    #   - `AP` - AP
    #
    #   @return [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address::State]
    required :state, enum: -> { VitableConnect::EmployerSubmitCensusSyncParams::Employee::Address::State }

    # @!attribute zipcode
    #
    #   @return [String]
    required :zipcode, String

    # @!attribute address_line_2
    #
    #   @return [String, nil]
    optional :address_line_2, String, nil?: true

    # @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
    #   Some parameter documentations has been truncated, see
    #   {VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address} for
    #   more details.
    #
    #   @param address_line_1 [String]
    #
    #   @param city [String]
    #
    #   @param state [Symbol, VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address::State] - `AL` - AL
    #
    #   @param zipcode [String]
    #
    #   @param address_line_2 [String, nil]

    # - `AL` - AL
    # - `AK` - AK
    # - `AZ` - AZ
    # - `AR` - AR
    # - `CA` - CA
    # - `CO` - CO
    # - `CT` - CT
    # - `DC` - DC
    # - `DE` - DE
    # - `FL` - FL
    # - `GA` - GA
    # - `HI` - HI
    # - `ID` - ID
    # - `IL` - IL
    # - `IN` - IN
    # - `IA` - IA
    # - `KS` - KS
    # - `KY` - KY
    # - `LA` - LA
    # - `ME` - ME
    # - `MD` - MD
    # - `MA` - MA
    # - `MI` - MI
    # - `MN` - MN
    # - `MS` - MS
    # - `MO` - MO
    # - `MT` - MT
    # - `NE` - NE
    # - `NV` - NV
    # - `NH` - NH
    # - `NJ` - NJ
    # - `NM` - NM
    # - `NY` - NY
    # - `NC` - NC
    # - `ND` - ND
    # - `OH` - OH
    # - `OK` - OK
    # - `OR` - OR
    # - `PA` - PA
    # - `RI` - RI
    # - `SC` - SC
    # - `SD` - SD
    # - `TN` - TN
    # - `TX` - TX
    # - `UT` - UT
    # - `VT` - VT
    # - `VA` - VA
    # - `WA` - WA
    # - `WI` - WI
    # - `WV` - WV
    # - `WY` - WY
    # - `PR` - PR
    # - `GU` - GU
    # - `AS` - AS
    # - `VI` - VI
    # - `MP` - MP
    # - `MH` - MH
    # - `PW` - PW
    # - `FM` - FM
    # - `AE` - AE
    # - `AA` - AA
    # - `AP` - AP
    #
    # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee::Address#state
    module State
      extend VitableConnect::Internal::Type::Enum

      AL = :AL
      AK = :AK
      AZ = :AZ
      AR = :AR
      CA = :CA
      CO = :CO
      CT = :CT
      DC = :DC
      DE = :DE
      FL = :FL
      GA = :GA
      HI = :HI
      ID = :ID
      IL = :IL
      IN = :IN
      IA = :IA
      KS = :KS
      KY = :KY
      LA = :LA
      ME = :ME
      MD = :MD
      MA = :MA
      MI = :MI
      MN = :MN
      MS = :MS
      MO = :MO
      MT = :MT
      NE = :NE
      NV = :NV
      NH = :NH
      NJ = :NJ
      NM = :NM
      NY = :NY
      NC = :NC
      ND = :ND
      OH = :OH
      OK = :OK
      OR = :OR
      PA = :PA
      RI = :RI
      SC = :SC
      SD = :SD
      TN = :TN
      TX = :TX
      UT = :UT
      VT = :VT
      VA = :VA
      WA = :WA
      WI = :WI
      WV = :WV
      WY = :WY
      PR = :PR
      GU = :GU
      AS = :AS
      VI = :VI
      MP = :MP
      MH = :MH
      PW = :PW
      FM = :FM
      AE = :AE
      AA = :AA
      AP = :AP

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end

  # - `Salary` - Salary
  # - `Hourly` - Hourly
  #
  # @see VitableConnect::Models::EmployerSubmitCensusSyncParams::Employee#compensation_type
  module CompensationType
    extend VitableConnect::Internal::Type::Enum

    SALARY = :Salary
    HOURLY = :Hourly

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

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

Returns:



58
59
60
61
62
 
# File 'lib/vitable_connect/models/employer_submit_census_sync_params.rb', line 58

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

#compensation_type ⇒ Symbol, ...

  • ‘Salary` - Salary

  • ‘Hourly` - Hourly

Returns:



69
70
71
 
# File 'lib/vitable_connect/models/employer_submit_census_sync_params.rb', line 69

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

#date_of_birth ⇒ Date

Returns:

  • (Date) 


33
 
# File 'lib/vitable_connect/models/employer_submit_census_sync_params.rb', line 33

required :date_of_birth, Date

#email ⇒ String

Returns:

  • (String) 


38
 
# File 'lib/vitable_connect/models/employer_submit_census_sync_params.rb', line 38

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:



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

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

#first_name ⇒ String

Returns:

  • (String) 


43
 
# File 'lib/vitable_connect/models/employer_submit_census_sync_params.rb', line 43

required :first_name, String

#last_name ⇒ String

Returns:

  • (String) 


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

required :last_name, String

#phone ⇒ String

Returns:

  • (String) 


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

required :phone, String

#reference_id ⇒ String?

Returns:

  • (String, nil) 


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

optional :reference_id, String, nil?: true

#start_date ⇒ Date?

Returns:

  • (Date, nil) 


92
 
# File 'lib/vitable_connect/models/employer_submit_census_sync_params.rb', line 92

optional :start_date, Date, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/employer_submit_census_sync_params.rb', line 353