Class: MergeHRISClient::EmployeeRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/models/employee_request.rb

Overview

# The Employee Object ### Description The ‘Employee` object is used to represent any person who has been employed by a company. ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmployeeRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 207

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeHRISClient::EmployeeRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MergeHRISClient::EmployeeRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'employee_number')
    self.employee_number = attributes[:'employee_number']
  end

  if attributes.key?(:'company')
    self.company = attributes[:'company']
  end

  if attributes.key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.key?(:'display_full_name')
    self.display_full_name = attributes[:'display_full_name']
  end

  if attributes.key?(:'username')
    self.username = attributes[:'username']
  end

  if attributes.key?(:'groups')
    if (value = attributes[:'groups']).is_a?(Array)
      self.groups = value
    end
  end

  if attributes.key?(:'work_email')
    self.work_email = attributes[:'work_email']
  end

  if attributes.key?(:'personal_email')
    self.personal_email = attributes[:'personal_email']
  end

  if attributes.key?(:'mobile_phone_number')
    self.mobile_phone_number = attributes[:'mobile_phone_number']
  end

  if attributes.key?(:'employments')
    if (value = attributes[:'employments']).is_a?(Array)
      self.employments = value
    end
  end

  if attributes.key?(:'home_location')
    self.home_location = attributes[:'home_location']
  end

  if attributes.key?(:'work_location')
    self.work_location = attributes[:'work_location']
  end

  if attributes.key?(:'manager')
    self.manager = attributes[:'manager']
  end

  if attributes.key?(:'team')
    self.team = attributes[:'team']
  end

  if attributes.key?(:'pay_group')
    self.pay_group = attributes[:'pay_group']
  end

  if attributes.key?(:'ssn')
    self.ssn = attributes[:'ssn']
  end

  if attributes.key?(:'gender')
    self.gender = attributes[:'gender']
  end

  if attributes.key?(:'ethnicity')
    self.ethnicity = attributes[:'ethnicity']
  end

  if attributes.key?(:'marital_status')
    self.marital_status = attributes[:'marital_status']
  end

  if attributes.key?(:'date_of_birth')
    self.date_of_birth = attributes[:'date_of_birth']
  end

  if attributes.key?(:'hire_date')
    self.hire_date = attributes[:'hire_date']
  end

  if attributes.key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.key?(:'employment_status')
    self.employment_status = attributes[:'employment_status']
  end

  if attributes.key?(:'termination_date')
    self.termination_date = attributes[:'termination_date']
  end

  if attributes.key?(:'avatar')
    self.avatar = attributes[:'avatar']
  end

  if attributes.key?(:'integration_params')
    if (value = attributes[:'integration_params']).is_a?(Hash)
      self.integration_params = value
    end
  end

  if attributes.key?(:'linked_account_params')
    if (value = attributes[:'linked_account_params']).is_a?(Hash)
      self. = value
    end
  end
end

Instance Attribute Details

#avatar ⇒ Object

The URL of the employee’s avatar image.



94
95
96
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 94

def avatar
  @avatar
end

#company ⇒ Object

The ID of the employee’s company.



23
24
25
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 23

def company
  @company
end

#date_of_birth ⇒ Object

The employee’s date of birth.



79
80
81
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 79

def date_of_birth
  @date_of_birth
end

#display_full_name ⇒ Object

The employee’s full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.



32
33
34
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 32

def display_full_name
  @display_full_name
end

#employee_number ⇒ Object

The employee’s number that appears in the third-party integration’s UI.



20
21
22
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 20

def employee_number
  @employee_number
end

#employment_status ⇒ Object

The employment status of the employee. * ‘ACTIVE` - ACTIVE * `PENDING` - PENDING * `INACTIVE` - INACTIVE



88
89
90
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 88

def employment_status
  @employment_status
end

#employments ⇒ Object

Array of ‘Employment` IDs for this Employee.



49
50
51
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 49

def employments
  @employments
end

#ethnicity ⇒ Object

The employee’s ethnicity. * ‘AMERICAN_INDIAN_OR_ALASKA_NATIVE` - AMERICAN_INDIAN_OR_ALASKA_NATIVE * `ASIAN_OR_INDIAN_SUBCONTINENT` - ASIAN_OR_INDIAN_SUBCONTINENT * `BLACK_OR_AFRICAN_AMERICAN` - BLACK_OR_AFRICAN_AMERICAN * `HISPANIC_OR_LATINO` - HISPANIC_OR_LATINO * `NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER` - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER * `TWO_OR_MORE_RACES` - TWO_OR_MORE_RACES * `WHITE` - WHITE * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE



73
74
75
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 73

def ethnicity
  @ethnicity
end

#first_name ⇒ Object

The employee’s first name.



26
27
28
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 26

def first_name
  @first_name
end

#gender ⇒ Object

The employee’s gender. * ‘MALE` - MALE * `FEMALE` - FEMALE * `NON-BINARY` - NON-BINARY * `OTHER` - OTHER * `PREFER_NOT_TO_DISCLOSE` - PREFER_NOT_TO_DISCLOSE



70
71
72
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 70

def gender
  @gender
end

#groups ⇒ Object

Returns the value of attribute groups.



37
38
39
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 37

def groups
  @groups
end

#hire_date ⇒ Object

The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you’re looking for the employee’s start date, refer to the start_date field.



82
83
84
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 82

def hire_date
  @hire_date
end

#home_location ⇒ Object

The employee’s home address.



52
53
54
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 52

def home_location
  @home_location
end

#integration_params ⇒ Object

Returns the value of attribute integration_params.



96
97
98
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 96

def integration_params
  @integration_params
end

#last_name ⇒ Object

The employee’s last name.



29
30
31
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 29

def last_name
  @last_name
end

#linked_account_params ⇒ Object

Returns the value of attribute linked_account_params.



98
99
100
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 98

def 
  
end

#manager ⇒ Object

The employee ID of the employee’s manager.



58
59
60
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 58

def manager
  @manager
end

#marital_status ⇒ Object

The employee’s filing status as related to marital status. * ‘SINGLE` - SINGLE * `MARRIED_FILING_JOINTLY` - MARRIED_FILING_JOINTLY * `MARRIED_FILING_SEPARATELY` - MARRIED_FILING_SEPARATELY * `HEAD_OF_HOUSEHOLD` - HEAD_OF_HOUSEHOLD * `QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD` - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD



76
77
78
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 76

def marital_status
  @marital_status
end

#mobile_phone_number ⇒ Object

The employee’s mobile phone number.



46
47
48
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 46

def mobile_phone_number
  @mobile_phone_number
end

#pay_group ⇒ Object

The employee’s pay group



64
65
66
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 64

def pay_group
  @pay_group
end

#personal_email ⇒ Object

The employee’s personal email.



43
44
45
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 43

def personal_email
  @personal_email
end

#ssn ⇒ Object

The employee’s social security number.



67
68
69
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 67

def ssn
  @ssn
end

#start_date ⇒ Object

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.



85
86
87
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 85

def start_date
  @start_date
end

#team ⇒ Object

The employee’s team.



61
62
63
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 61

def team
  @team
end

#termination_date ⇒ Object

The employee’s termination date.



91
92
93
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 91

def termination_date
  @termination_date
end

#username ⇒ Object

The employee’s username that appears in the remote UI.



35
36
37
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 35

def username
  @username
end

#work_email ⇒ Object

The employee’s work email.



40
41
42
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 40

def work_email
  @work_email
end

#work_location ⇒ Object

The employee’s work address.



55
56
57
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 55

def work_location
  @work_location
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



135
136
137
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 135

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



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
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 101

def self.attribute_map
  {
    :'employee_number' => :'employee_number',
    :'company' => :'company',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'display_full_name' => :'display_full_name',
    :'username' => :'username',
    :'groups' => :'groups',
    :'work_email' => :'work_email',
    :'personal_email' => :'personal_email',
    :'mobile_phone_number' => :'mobile_phone_number',
    :'employments' => :'employments',
    :'home_location' => :'home_location',
    :'work_location' => :'work_location',
    :'manager' => :'manager',
    :'team' => :'team',
    :'pay_group' => :'pay_group',
    :'ssn' => :'ssn',
    :'gender' => :'gender',
    :'ethnicity' => :'ethnicity',
    :'marital_status' => :'marital_status',
    :'date_of_birth' => :'date_of_birth',
    :'hire_date' => :'hire_date',
    :'start_date' => :'start_date',
    :'employment_status' => :'employment_status',
    :'termination_date' => :'termination_date',
    :'avatar' => :'avatar',
    :'integration_params' => :'integration_params',
    :'linked_account_params' => :'linked_account_params'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



464
465
466
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 464

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 174

def self.openapi_nullable
  Set.new([
    :'employee_number',
    :'company',
    :'first_name',
    :'last_name',
    :'display_full_name',
    :'username',
    :'work_email',
    :'personal_email',
    :'mobile_phone_number',
    :'home_location',
    :'work_location',
    :'manager',
    :'team',
    :'pay_group',
    :'ssn',
    :'gender',
    :'ethnicity',
    :'marital_status',
    :'date_of_birth',
    :'hire_date',
    :'start_date',
    :'employment_status',
    :'termination_date',
    :'avatar',
    :'integration_params',
    :'linked_account_params'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 140

def self.openapi_types
  {
    :'employee_number' => :'String',
    :'company' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'display_full_name' => :'String',
    :'username' => :'String',
    :'groups' => :'Array<String>',
    :'work_email' => :'String',
    :'personal_email' => :'String',
    :'mobile_phone_number' => :'String',
    :'employments' => :'Array<String>',
    :'home_location' => :'String',
    :'work_location' => :'String',
    :'manager' => :'String',
    :'team' => :'String',
    :'pay_group' => :'String',
    :'ssn' => :'String',
    :'gender' => :'GenderEnum',
    :'ethnicity' => :'EthnicityEnum',
    :'marital_status' => :'MaritalStatusEnum',
    :'date_of_birth' => :'Time',
    :'hire_date' => :'Time',
    :'start_date' => :'Time',
    :'employment_status' => :'EmploymentStatusEnum',
    :'termination_date' => :'Time',
    :'avatar' => :'String',
    :'integration_params' => :'Hash<String, Object>',
    :'linked_account_params' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 416

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      employee_number == o.employee_number &&
      company == o.company &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      display_full_name == o.display_full_name &&
      username == o.username &&
      groups == o.groups &&
      work_email == o.work_email &&
      personal_email == o.personal_email &&
      mobile_phone_number == o.mobile_phone_number &&
      employments == o.employments &&
      home_location == o.home_location &&
      work_location == o.work_location &&
      manager == o.manager &&
      team == o.team &&
      pay_group == o.pay_group &&
      ssn == o.ssn &&
      gender == o.gender &&
      ethnicity == o.ethnicity &&
      marital_status == o.marital_status &&
      date_of_birth == o.date_of_birth &&
      hire_date == o.hire_date &&
      start_date == o.start_date &&
      employment_status == o.employment_status &&
      termination_date == o.termination_date &&
      avatar == o.avatar &&
      integration_params == o.integration_params &&
       == o.
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 494

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = MergeHRISClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 565

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 471

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


451
452
453
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 451

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



457
458
459
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 457

def hash
  [employee_number, company, first_name, last_name, display_full_name, username, groups, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, pay_group, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, start_date, employment_status, termination_date, avatar, integration_params, ].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 343

def list_invalid_properties
  invalid_properties = Array.new
  if !@work_email.nil? && @work_email.to_s.length > 254
    invalid_properties.push('invalid value for "work_email", the character length must be smaller than or equal to 254.')
  end

  if !@personal_email.nil? && @personal_email.to_s.length > 254
    invalid_properties.push('invalid value for "personal_email", the character length must be smaller than or equal to 254.')
  end

  if !@ssn.nil? && @ssn.to_s.length > 100
    invalid_properties.push('invalid value for "ssn", the character length must be smaller than or equal to 100.')
  end

  if !@avatar.nil? && @avatar.to_s.length > 2000
    invalid_properties.push('invalid value for "avatar", the character length must be smaller than or equal to 2000.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



541
542
543
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 541

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 547

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



535
536
537
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 535

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



366
367
368
369
370
371
372
 
# File 'lib/merge_hris_client/models/employee_request.rb', line 366

def valid?
  return false if !@work_email.nil? && @work_email.to_s.length > 254
  return false if !@personal_email.nil? && @personal_email.to_s.length > 254
  return false if !@ssn.nil? && @ssn.to_s.length > 100
  return false if !@avatar.nil? && @avatar.to_s.length > 2000
  true
end