Class: TripletexApi::Employee

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end

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

  if attributes.has_key?(:'url')
    self.url = attributes[:'url']
  end

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

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

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

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

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'phoneNumberMobile')
    self.phone_number_mobile = attributes[:'phoneNumberMobile']
  end

  if attributes.has_key?(:'nationalIdentityNumber')
    self.national_identity_number = attributes[:'nationalIdentityNumber']
  end

  if attributes.has_key?(:'dnumber')
    self.dnumber = attributes[:'dnumber']
  end

  if attributes.has_key?(:'bankAccountNumber')
    self. = attributes[:'bankAccountNumber']
  end

  if attributes.has_key?(:'userType')
    self.user_type = attributes[:'userType']
  end

  if attributes.has_key?(:'allowInformationRegistration')
    self.allow_information_registration = attributes[:'allowInformationRegistration']
  else
    self.allow_information_registration = false
  end

  if attributes.has_key?(:'isContact')
    self.is_contact = attributes[:'isContact']
  else
    self.is_contact = false
  end

  if attributes.has_key?(:'address')
    self.address = attributes[:'address']
  end

  if attributes.has_key?(:'department')
    self.department = attributes[:'department']
  end

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

end

Instance Attribute Details

#address ⇒ Object

Address tied to the employee



53
54
55
 
# File 'lib/tripletex_api/models/employee.rb', line 53

def address
  @address
end

#allow_information_registration ⇒ Object

Determines if salary information can be registered on the user including hours, travel expenses and employee expenses. The user may also be selected as a project member on projects.



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

def allow_information_registration
  @allow_information_registration
end

#bank_account_number ⇒ Object

Returns the value of attribute bank_account_number.



42
43
44
 
# File 'lib/tripletex_api/models/employee.rb', line 42

def 
  @bank_account_number
end

#changes ⇒ Object

Returns the value of attribute changes.



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

def changes
  @changes
end

#date_of_birth ⇒ Object

Returns the value of attribute date_of_birth.



32
33
34
 
# File 'lib/tripletex_api/models/employee.rb', line 32

def date_of_birth
  @date_of_birth
end

#department ⇒ Object

Returns the value of attribute department.



55
56
57
 
# File 'lib/tripletex_api/models/employee.rb', line 55

def department
  @department
end

#dnumber ⇒ Object

Returns the value of attribute dnumber.



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

def dnumber
  @dnumber
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#employee_number ⇒ Object

Returns the value of attribute employee_number.



30
31
32
 
# File 'lib/tripletex_api/models/employee.rb', line 30

def employee_number
  @employee_number
end

#employments ⇒ Object

Employments tied to the employee



58
59
60
 
# File 'lib/tripletex_api/models/employee.rb', line 58

def employments
  @employments
end

#first_name ⇒ Object

Returns the value of attribute first_name.



26
27
28
 
# File 'lib/tripletex_api/models/employee.rb', line 26

def first_name
  @first_name
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/tripletex_api/models/employee.rb', line 18

def id
  @id
end

#is_contact ⇒ Object

Returns the value of attribute is_contact.



50
51
52
 
# File 'lib/tripletex_api/models/employee.rb', line 50

def is_contact
  @is_contact
end

#last_name ⇒ Object

Returns the value of attribute last_name.



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

def last_name
  @last_name
end

#national_identity_number ⇒ Object

Returns the value of attribute national_identity_number.



38
39
40
 
# File 'lib/tripletex_api/models/employee.rb', line 38

def national_identity_number
  @national_identity_number
end

#phone_number_mobile ⇒ Object

Returns the value of attribute phone_number_mobile.



36
37
38
 
# File 'lib/tripletex_api/models/employee.rb', line 36

def phone_number_mobile
  @phone_number_mobile
end

#url ⇒ Object

Returns the value of attribute url.



24
25
26
 
# File 'lib/tripletex_api/models/employee.rb', line 24

def url
  @url
end

#user_type ⇒ Object

Define the employee’s user type.
STANDARD: Reduced access. Users with limited system entitlements.
EXTENDED: Users can be given all system entitlements.
NO_ACCESS: User with no log on access.
Users with access to Tripletex must confirm the email address.



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

def user_type
  @user_type
end

#version ⇒ Object

Returns the value of attribute version.



20
21
22
 
# File 'lib/tripletex_api/models/employee.rb', line 20

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/tripletex_api/models/employee.rb', line 83

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'employee_number' => :'employeeNumber',
    :'date_of_birth' => :'dateOfBirth',
    :'email' => :'email',
    :'phone_number_mobile' => :'phoneNumberMobile',
    :'national_identity_number' => :'nationalIdentityNumber',
    :'dnumber' => :'dnumber',
    :'bank_account_number' => :'bankAccountNumber',
    :'user_type' => :'userType',
    :'allow_information_registration' => :'allowInformationRegistration',
    :'is_contact' => :'isContact',
    :'address' => :'address',
    :'department' => :'department',
    :'employments' => :'employments'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/tripletex_api/models/employee.rb', line 108

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'employee_number' => :'String',
    :'date_of_birth' => :'String',
    :'email' => :'String',
    :'phone_number_mobile' => :'String',
    :'national_identity_number' => :'String',
    :'dnumber' => :'String',
    :'bank_account_number' => :'String',
    :'user_type' => :'String',
    :'allow_information_registration' => :'BOOLEAN',
    :'is_contact' => :'BOOLEAN',
    :'address' => :'Address',
    :'department' => :'Department',
    :'employments' => :'Array<Employment>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/tripletex_api/models/employee.rb', line 424

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      employee_number == o.employee_number &&
      date_of_birth == o.date_of_birth &&
      email == o.email &&
      phone_number_mobile == o.phone_number_mobile &&
      national_identity_number == o.national_identity_number &&
      dnumber == o.dnumber &&
       == o. &&
      user_type == o.user_type &&
      allow_information_registration == o.allow_information_registration &&
      is_contact == o.is_contact &&
      address == o.address &&
      department == o.department &&
      employments == o.employments
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



484
485
486
487
488
489
490
491
492
493
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
 
# File 'lib/tripletex_api/models/employee.rb', line 484

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = TripletexApi.const_get(type).new
    temp_model.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



550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/tripletex_api/models/employee.rb', line 550

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



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/tripletex_api/models/employee.rb', line 463

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


450
451
452
 
# File 'lib/tripletex_api/models/employee.rb', line 450

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



456
457
458
 
# File 'lib/tripletex_api/models/employee.rb', line 456

def hash
  [id, version, changes, url, first_name, last_name, employee_number, date_of_birth, email, phone_number_mobile, national_identity_number, dnumber, , user_type, allow_information_registration, is_contact, address, department, employments].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
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
 
# File 'lib/tripletex_api/models/employee.rb', line 228

def list_invalid_properties
  invalid_properties = Array.new
  if @first_name.nil?
    invalid_properties.push("invalid value for 'first_name', first_name cannot be nil.")
  end

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

  if @first_name.to_s.length < 1
    invalid_properties.push("invalid value for 'first_name', the character length must be great than or equal to 1.")
  end

  if @last_name.nil?
    invalid_properties.push("invalid value for 'last_name', last_name cannot be nil.")
  end

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

  if @last_name.to_s.length < 1
    invalid_properties.push("invalid value for 'last_name', the character length must be great than or equal to 1.")
  end

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

  if !@employee_number.nil? && @employee_number.to_s.length < 0
    invalid_properties.push("invalid value for 'employee_number', the character length must be great than or equal to 0.")
  end

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

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

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

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

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

  return 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



530
531
532
 
# File 'lib/tripletex_api/models/employee.rb', line 530

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



536
537
538
539
540
541
542
543
544
 
# File 'lib/tripletex_api/models/employee.rb', line 536

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



524
525
526
 
# File 'lib/tripletex_api/models/employee.rb', line 524

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/tripletex_api/models/employee.rb', line 287

def valid?
  return false if @first_name.nil?
  return false if @first_name.to_s.length > 100
  return false if @first_name.to_s.length < 1
  return false if @last_name.nil?
  return false if @last_name.to_s.length > 100
  return false if @last_name.to_s.length < 1
  return false if !@employee_number.nil? && @employee_number.to_s.length > 100
  return false if !@employee_number.nil? && @employee_number.to_s.length < 0
  return false if !@email.nil? && @email.to_s.length > 100
  return false if !@phone_number_mobile.nil? && @phone_number_mobile.to_s.length > 100
  return false if !@national_identity_number.nil? && @national_identity_number.to_s.length > 100
  return false if !@dnumber.nil? && @dnumber.to_s.length > 11
  return false if !@bank_account_number.nil? && @bank_account_number.to_s.length > 100
  user_type_validator = EnumAttributeValidator.new('String', ["STANDARD", "EXTENDED", "NO_ACCESS"])
  return false unless user_type_validator.valid?(@user_type)
  return true
end