Class: XeroRuby::PayrollUk::Employee

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/payroll_uk/employee.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

M =
"M".freeze
F =
"F".freeze

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


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
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 132

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#addressObject

Returns the value of attribute address


35
36
37
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 35

def address
  @address
end

#created_date_utcObject

UTC timestamp when the employee was created in Xero


61
62
63
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 61

def created_date_utc
  @created_date_utc
end

#date_of_birthObject

Date of birth of the employee (YYYY-MM-DD)


32
33
34
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 32

def date_of_birth
  @date_of_birth
end

#emailObject

The email address for the employee


38
39
40
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 38

def email
  @email
end

#employee_idObject

Xero unique identifier for the employee


20
21
22
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 20

def employee_id
  @employee_id
end

#end_dateObject

Employment end date of the employee at the time it was requested


52
53
54
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 52

def end_date
  @end_date
end

#first_nameObject

First name of employee


26
27
28
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 26

def first_name
  @first_name
end

#genderObject

The employee’s gender


41
42
43
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 41

def gender
  @gender
end

#last_nameObject

Last name of employee


29
30
31
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 29

def last_name
  @last_name
end

#national_insurance_numberObject

National insurance number of the employee


64
65
66
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 64

def national_insurance_number
  @national_insurance_number
end

#payroll_calendar_idObject

Xero unique identifier for the payroll calendar of the employee


55
56
57
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 55

def payroll_calendar_id
  @payroll_calendar_id
end

#phone_numberObject

Employee phone number


46
47
48
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 46

def phone_number
  @phone_number
end

#start_dateObject

Employment start date of the employee at the time it was requested


49
50
51
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 49

def start_date
  @start_date
end

#titleObject

Title of the employee


23
24
25
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 23

def title
  @title
end

#updated_date_utcObject

UTC timestamp of last update to the employee


58
59
60
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 58

def updated_date_utc
  @updated_date_utc
end

Class Method Details

.attribute_mapObject

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


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 89

def self.attribute_map
  {
    :'employee_id' => :'employeeID',
    :'title' => :'title',
    :'first_name' => :'firstName',
    :'last_name' => :'lastName',
    :'date_of_birth' => :'dateOfBirth',
    :'address' => :'address',
    :'email' => :'email',
    :'gender' => :'gender',
    :'phone_number' => :'phoneNumber',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'payroll_calendar_id' => :'payrollCalendarID',
    :'updated_date_utc' => :'updatedDateUTC',
    :'created_date_utc' => :'createdDateUTC',
    :'national_insurance_number' => :'nationalInsuranceNumber'
  }
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


268
269
270
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 268

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

.openapi_typesObject

Attribute type mapping.


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 110

def self.openapi_types
  {
    :'employee_id' => :'String',
    :'title' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'date_of_birth' => :'Date',
    :'address' => :'Address',
    :'email' => :'String',
    :'gender' => :'String',
    :'phone_number' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'payroll_calendar_id' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'created_date_utc' => :'DateTime',
    :'national_insurance_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      employee_id == o.employee_id &&
      title == o.title &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      date_of_birth == o.date_of_birth &&
      address == o.address &&
      email == o.email &&
      gender == o.gender &&
      phone_number == o.phone_number &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      payroll_calendar_id == o.payroll_calendar_id &&
      updated_date_utc == o.updated_date_utc &&
      created_date_utc == o.created_date_utc &&
      national_insurance_number == o.national_insurance_number
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


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
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 296

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::PayrollUk.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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


369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 369

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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


275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 275

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # 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

255
256
257
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 255

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


261
262
263
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 261

def hash
  [employee_id, title, first_name, last_name, date_of_birth, address, email, gender, phone_number, start_date, end_date, payroll_calendar_id, updated_date_utc, created_date_utc, national_insurance_number].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


208
209
210
211
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 208

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


385
386
387
388
389
390
391
392
393
394
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 385

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case


361
362
363
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 361

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


343
344
345
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 343

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


349
350
351
352
353
354
355
356
357
358
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 349

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


337
338
339
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 337

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


215
216
217
218
219
# File 'lib/xero-ruby/models/payroll_uk/employee.rb', line 215

def valid?
  gender_validator = EnumAttributeValidator.new('String', ["M", "F"])
  return false unless gender_validator.valid?(@gender)
  true
end