Class: MergeHRISClient::Dependent

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

Overview

# The Dependent Object ### Description The ‘Dependent` object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an `Employee` ### Usage Example Fetch from the `LIST Dependents` endpoint and filter by `ID` to show all dependents.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Dependent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#date_of_birth ⇒ Object

The dependent’s date of birth.



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

def date_of_birth
  @date_of_birth
end

#employee ⇒ Object

The employee this person is a dependent of.



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

def employee
  @employee
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



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

def field_mappings
  @field_mappings
end

#first_name ⇒ Object

The dependents’s first name.



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

def first_name
  @first_name
end

#gender ⇒ Object

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



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

def gender
  @gender
end

#home_location ⇒ Object

The dependents’s home address.



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

def home_location
  @home_location
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#is_student ⇒ Object

Whether or not the dependent is a student



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

def is_student
  @is_student
end

#last_name ⇒ Object

The dependents’s last name.



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

def last_name
  @last_name
end

#middle_name ⇒ Object

The dependents’s middle name.



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

def middle_name
  @middle_name
end

#modified_at ⇒ Object

This is the datetime that this object was last updated by Merge



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

def modified_at
  @modified_at
end

#phone_number ⇒ Object

The dependent’s phone number.



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

def phone_number
  @phone_number
end

#relationship ⇒ Object

The dependent’s relationship to the employee. * ‘CHILD` - CHILD * `SPOUSE` - SPOUSE * `DOMESTIC_PARTNER` - DOMESTIC_PARTNER



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

def relationship
  @relationship
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



65
66
67
 
# File 'lib/merge_hris_client/models/dependent.rb', line 65

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/dependent.rb', line 22

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Object

Indicates whether or not this object has been deleted by third party webhooks.



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

def remote_was_deleted
  @remote_was_deleted
end

#ssn ⇒ Object

The dependents’s social security number.



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

def ssn
  @ssn
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/merge_hris_client/models/dependent.rb', line 68

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'first_name' => :'first_name',
    :'middle_name' => :'middle_name',
    :'last_name' => :'last_name',
    :'relationship' => :'relationship',
    :'employee' => :'employee',
    :'date_of_birth' => :'date_of_birth',
    :'gender' => :'gender',
    :'phone_number' => :'phone_number',
    :'home_location' => :'home_location',
    :'is_student' => :'is_student',
    :'ssn' => :'ssn',
    :'remote_was_deleted' => :'remote_was_deleted',
    :'modified_at' => :'modified_at',
    :'field_mappings' => :'field_mappings',
    :'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



353
354
355
 
# File 'lib/merge_hris_client/models/dependent.rb', line 353

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/merge_hris_client/models/dependent.rb', line 119

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'first_name',
    :'middle_name',
    :'last_name',
    :'relationship',
    :'employee',
    :'date_of_birth',
    :'gender',
    :'phone_number',
    :'home_location',
    :'is_student',
    :'ssn',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/merge_hris_client/models/dependent.rb', line 96

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'relationship' => :'RelationshipEnum',
    :'employee' => :'String',
    :'date_of_birth' => :'Time',
    :'gender' => :'GenderEnum',
    :'phone_number' => :'String',
    :'home_location' => :'String',
    :'is_student' => :'Boolean',
    :'ssn' => :'String',
    :'remote_was_deleted' => :'Boolean',
    :'modified_at' => :'Time',
    :'field_mappings' => :'Hash<String, Object>',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/merge_hris_client/models/dependent.rb', line 316

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      first_name == o.first_name &&
      middle_name == o.middle_name &&
      last_name == o.last_name &&
      relationship == o.relationship &&
      employee == o.employee &&
      date_of_birth == o.date_of_birth &&
      gender == o.gender &&
      phone_number == o.phone_number &&
      home_location == o.home_location &&
      is_student == o.is_student &&
      ssn == o.ssn &&
      remote_was_deleted == o.remote_was_deleted &&
      modified_at == o.modified_at &&
      field_mappings == o.field_mappings &&
      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



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
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/merge_hris_client/models/dependent.rb', line 383

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



454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/merge_hris_client/models/dependent.rb', line 454

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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/merge_hris_client/models/dependent.rb', line 360

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


340
341
342
 
# File 'lib/merge_hris_client/models/dependent.rb', line 340

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



346
347
348
 
# File 'lib/merge_hris_client/models/dependent.rb', line 346

def hash
  [id, remote_id, first_name, middle_name, last_name, relationship, employee, date_of_birth, gender, phone_number, home_location, is_student, ssn, remote_was_deleted, modified_at, field_mappings, 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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/merge_hris_client/models/dependent.rb', line 228

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

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

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

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

  if !@ssn.nil? && @ssn.to_s.length > 50
    invalid_properties.push('invalid value for "ssn", the character length must be smaller than or equal to 50.')
  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



430
431
432
 
# File 'lib/merge_hris_client/models/dependent.rb', line 430

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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/merge_hris_client/models/dependent.rb', line 436

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



424
425
426
 
# File 'lib/merge_hris_client/models/dependent.rb', line 424

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



255
256
257
258
259
260
261
262
 
# File 'lib/merge_hris_client/models/dependent.rb', line 255

def valid?
  return false if !@first_name.nil? && @first_name.to_s.length > 60
  return false if !@middle_name.nil? && @middle_name.to_s.length > 60
  return false if !@last_name.nil? && @last_name.to_s.length > 60
  return false if !@phone_number.nil? && @phone_number.to_s.length > 50
  return false if !@ssn.nil? && @ssn.to_s.length > 50
  true
end