Class: XeroRuby::PayrollUk::EmployeeStatutorySickLeave

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmployeeStatutorySickLeave

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#employee_idObject

The unique identifier (guid) of the employee


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

def employee_id
  @employee_id
end

#end_dateObject

The date when the leave ends


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

def end_date
  @end_date
end

#entitlement_failure_reasonsObject

If the leave requested was considered "not entitled", the reasons why are listed here.


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

def entitlement_failure_reasons
  @entitlement_failure_reasons
end

#entitlement_weeks_qualifiedObject

The amount of statutory sick leave time off (in weeks) that is available to take at the time the leave was requested


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

def entitlement_weeks_qualified
  @entitlement_weeks_qualified
end

#entitlement_weeks_remainingObject

A calculated amount of time (in weeks) that remains for the statutory sick leave period


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

def entitlement_weeks_remaining
  @entitlement_weeks_remaining
end

#entitlement_weeks_requestedObject

The amount of requested time (in weeks)


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

def entitlement_weeks_requested
  @entitlement_weeks_requested
end

#is_entitledObject

Whether the leave was entitled to receive payment


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

def is_entitled
  @is_entitled
end

Whether the sick leave was pregnancy related


44
45
46
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 44

def is_pregnancy_related
  @is_pregnancy_related
end

#leave_type_idObject

The unique identifier (guid) of the "Statutory Sick Leave (non-pensionable)" pay item


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

def leave_type_id
  @leave_type_id
end

#overlaps_with_other_leaveObject

Whether another leave (Paternity, Shared Parental specifically) occurs during the requested leave's period. While this is allowed it could affect payment amounts


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

def overlaps_with_other_leave
  @overlaps_with_other_leave
end

#start_dateObject

The date when the leave starts


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

def start_date
  @start_date
end

#statusObject

the type of statutory leave


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

def status
  @status
end

#statutory_leave_idObject

The unique identifier (guid) of a statutory leave


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

def statutory_leave_id
  @statutory_leave_id
end

#sufficient_noticeObject

Whether the employee provided sufficient notice and documentation as required by the employer supporting the sick leave request


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

def sufficient_notice
  @sufficient_notice
end

#typeObject

the type of statutory leave


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

def type
  @type
end

#work_patternObject

The days of the work week the employee is scheduled to work at the time the leave is taken


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

def work_pattern
  @work_pattern
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'statutory_leave_id' => :'statutoryLeaveID',
    :'employee_id' => :'employeeID',
    :'leave_type_id' => :'leaveTypeID',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'type' => :'type',
    :'status' => :'status',
    :'work_pattern' => :'workPattern',
    :'is_pregnancy_related' => :'isPregnancyRelated',
    :'sufficient_notice' => :'sufficientNotice',
    :'is_entitled' => :'isEntitled',
    :'entitlement_weeks_requested' => :'entitlementWeeksRequested',
    :'entitlement_weeks_qualified' => :'entitlementWeeksQualified',
    :'entitlement_weeks_remaining' => :'entitlementWeeksRemaining',
    :'overlaps_with_other_leave' => :'overlapsWithOtherLeave',
    :'entitlement_failure_reasons' => :'entitlementFailureReasons'
  }
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


303
304
305
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 303

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

.openapi_typesObject

Attribute type mapping.


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

def self.openapi_types
  {
    :'statutory_leave_id' => :'String',
    :'employee_id' => :'String',
    :'leave_type_id' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'type' => :'String',
    :'status' => :'String',
    :'work_pattern' => :'Array<String>',
    :'is_pregnancy_related' => :'Boolean',
    :'sufficient_notice' => :'Boolean',
    :'is_entitled' => :'Boolean',
    :'entitlement_weeks_requested' => :'Float',
    :'entitlement_weeks_qualified' => :'Float',
    :'entitlement_weeks_remaining' => :'Float',
    :'overlaps_with_other_leave' => :'Boolean',
    :'entitlement_failure_reasons' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 267

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      statutory_leave_id == o.statutory_leave_id &&
      employee_id == o.employee_id &&
      leave_type_id == o.leave_type_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      type == o.type &&
      status == o.status &&
      work_pattern == o.work_pattern &&
      is_pregnancy_related == o.is_pregnancy_related &&
      sufficient_notice == o.sufficient_notice &&
      is_entitled == o.is_entitled &&
      entitlement_weeks_requested == o.entitlement_weeks_requested &&
      entitlement_weeks_qualified == o.entitlement_weeks_qualified &&
      entitlement_weeks_remaining == o.entitlement_weeks_remaining &&
      overlaps_with_other_leave == o.overlaps_with_other_leave &&
      entitlement_failure_reasons == o.entitlement_failure_reasons
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


331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 331

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


404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 404

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


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 310

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

290
291
292
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 290

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


296
297
298
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 296

def hash
  [statutory_leave_id, employee_id, leave_type_id, start_date, end_date, type, status, work_pattern, is_pregnancy_related, sufficient_notice, is_entitled, entitlement_weeks_requested, entitlement_weeks_qualified, entitlement_weeks_remaining, overlaps_with_other_leave, entitlement_failure_reasons].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


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

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

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

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

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

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


420
421
422
423
424
425
426
427
428
429
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 420

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


396
397
398
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 396

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


378
379
380
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 378

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


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

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


372
373
374
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 372

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


254
255
256
257
258
259
260
261
262
263
# File 'lib/xero-ruby/models/payroll_uk/employee_statutory_sick_leave.rb', line 254

def valid?
  return false if @employee_id.nil?
  return false if @leave_type_id.nil?
  return false if @start_date.nil?
  return false if @end_date.nil?
  return false if @work_pattern.nil?
  return false if @is_pregnancy_related.nil?
  return false if @sufficient_notice.nil?
  true
end