Class: MergeHRISClient::Employee

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

Overview

# The Employee Object ### Description The ‘Employee` object is used to represent an Employee for 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 = {}) ⇒ Employee

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeHRISClient::Employee` 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::Employee`. 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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  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?(:'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?(:'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?(:'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?(:'employee_number')
    self.employee_number = attributes[:'employee_number']
  end

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

Instance Attribute Details

#avatar ⇒ Object

The URL of the employee’s avatar image.



84
85
86
 
# File 'lib/merge_hris_client/models/employee.rb', line 84

def avatar
  @avatar
end

#company ⇒ Object

The ID of the Employee’s company.



25
26
27
 
# File 'lib/merge_hris_client/models/employee.rb', line 25

def company
  @company
end

#date_of_birth ⇒ Object

The employee’s date of birth.



72
73
74
 
# File 'lib/merge_hris_client/models/employee.rb', line 72

def date_of_birth
  @date_of_birth
end

#display_full_name ⇒ Object

The employee’s full name, to use for display purposes.



34
35
36
 
# File 'lib/merge_hris_client/models/employee.rb', line 34

def display_full_name
  @display_full_name
end

#employee_number ⇒ Object

The identification number for the employee.



87
88
89
 
# File 'lib/merge_hris_client/models/employee.rb', line 87

def employee_number
  @employee_number
end

#employment_status ⇒ Object

The employment status of the employee.



78
79
80
 
# File 'lib/merge_hris_client/models/employee.rb', line 78

def employment_status
  @employment_status
end

#employments ⇒ Object

Returns the value of attribute employments.



45
46
47
 
# File 'lib/merge_hris_client/models/employee.rb', line 45

def employments
  @employments
end

#ethnicity ⇒ Object

The employee’s ethnicity.



66
67
68
 
# File 'lib/merge_hris_client/models/employee.rb', line 66

def ethnicity
  @ethnicity
end

#first_name ⇒ Object

The employee’s first name.



28
29
30
 
# File 'lib/merge_hris_client/models/employee.rb', line 28

def first_name
  @first_name
end

#gender ⇒ Object

The employee’s gender.



63
64
65
 
# File 'lib/merge_hris_client/models/employee.rb', line 63

def gender
  @gender
end

#hire_date ⇒ Object

The employee’s hire date.



75
76
77
 
# File 'lib/merge_hris_client/models/employee.rb', line 75

def hire_date
  @hire_date
end

#home_location ⇒ Object

The employee’s home address.



48
49
50
 
# File 'lib/merge_hris_client/models/employee.rb', line 48

def home_location
  @home_location
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_hris_client/models/employee.rb', line 19

def id
  @id
end

#last_name ⇒ Object

The employee’s last name.



31
32
33
 
# File 'lib/merge_hris_client/models/employee.rb', line 31

def last_name
  @last_name
end

#manager ⇒ Object

The employee ID of the employee’s manager.



54
55
56
 
# File 'lib/merge_hris_client/models/employee.rb', line 54

def manager
  @manager
end

#marital_status ⇒ Object

The employee’s marital status.



69
70
71
 
# File 'lib/merge_hris_client/models/employee.rb', line 69

def marital_status
  @marital_status
end

#mobile_phone_number ⇒ Object

The employee’s mobile phone number.



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

def mobile_phone_number
  @mobile_phone_number
end

#personal_email ⇒ Object

The employee’s personal email.



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

def personal_email
  @personal_email
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



89
90
91
 
# File 'lib/merge_hris_client/models/employee.rb', line 89

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_hris_client/models/employee.rb', line 22

def remote_id
  @remote_id
end

#ssn ⇒ Object

The employee’s social security number.



60
61
62
 
# File 'lib/merge_hris_client/models/employee.rb', line 60

def ssn
  @ssn
end

#team ⇒ Object

The employee’s team.



57
58
59
 
# File 'lib/merge_hris_client/models/employee.rb', line 57

def team
  @team
end

#termination_date ⇒ Object

The employee’s termination date.



81
82
83
 
# File 'lib/merge_hris_client/models/employee.rb', line 81

def termination_date
  @termination_date
end

#work_email ⇒ Object

The employee’s work email.



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

def work_email
  @work_email
end

#work_location ⇒ Object

The employee’s work address.



51
52
53
 
# File 'lib/merge_hris_client/models/employee.rb', line 51

def work_location
  @work_location
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



123
124
125
 
# File 'lib/merge_hris_client/models/employee.rb', line 123

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'company' => :'company',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'display_full_name' => :'display_full_name',
    :'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',
    :'ssn' => :'ssn',
    :'gender' => :'gender',
    :'ethnicity' => :'ethnicity',
    :'marital_status' => :'marital_status',
    :'date_of_birth' => :'date_of_birth',
    :'hire_date' => :'hire_date',
    :'employment_status' => :'employment_status',
    :'termination_date' => :'termination_date',
    :'avatar' => :'avatar',
    :'employee_number' => :'employee_number',
    :'remote_data' => :'remote_data'
  }
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



427
428
429
 
# File 'lib/merge_hris_client/models/employee.rb', line 427

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'company' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'display_full_name' => :'String',
    :'work_email' => :'String',
    :'personal_email' => :'String',
    :'mobile_phone_number' => :'String',
    :'employments' => :'Array<String>',
    :'home_location' => :'String',
    :'work_location' => :'String',
    :'manager' => :'String',
    :'team' => :'String',
    :'ssn' => :'String',
    :'gender' => :'GenderEnum',
    :'ethnicity' => :'EthnicityEnum',
    :'marital_status' => :'MaritalStatusEnum',
    :'date_of_birth' => :'Time',
    :'hire_date' => :'Time',
    :'employment_status' => :'EmploymentStatusEnum',
    :'termination_date' => :'Time',
    :'avatar' => :'String',
    :'employee_number' => :'String',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/merge_hris_client/models/employee.rb', line 382

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      company == o.company &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      display_full_name == o.display_full_name &&
      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 &&
      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 &&
      employment_status == o.employment_status &&
      termination_date == o.termination_date &&
      avatar == o.avatar &&
      employee_number == o.employee_number &&
      remote_data == o.remote_data
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



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/merge_hris_client/models/employee.rb', line 457

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  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



528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/merge_hris_client/models/employee.rb', line 528

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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/merge_hris_client/models/employee.rb', line 434

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


414
415
416
 
# File 'lib/merge_hris_client/models/employee.rb', line 414

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



420
421
422
 
# File 'lib/merge_hris_client/models/employee.rb', line 420

def hash
  [id, remote_id, company, first_name, last_name, display_full_name, work_email, personal_email, mobile_phone_number, employments, home_location, work_location, manager, team, ssn, gender, ethnicity, marital_status, date_of_birth, hire_date, employment_status, termination_date, avatar, employee_number, remote_data].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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/merge_hris_client/models/employee.rb', line 309

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 > 700
    invalid_properties.push('invalid value for "avatar", the character length must be smaller than or equal to 700.')
  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



504
505
506
 
# File 'lib/merge_hris_client/models/employee.rb', line 504

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



510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/merge_hris_client/models/employee.rb', line 510

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



498
499
500
 
# File 'lib/merge_hris_client/models/employee.rb', line 498

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



332
333
334
335
336
337
338
 
# File 'lib/merge_hris_client/models/employee.rb', line 332

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 > 700
  true
end