Class: XeroRuby::PayrollUk::EmployeeLeaveType

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

BEGINNING_OF_CALENDAR_YEAR =
"BeginningOfCalendarYear".freeze
ON_ANNIVERSARY_DATE =
"OnAnniversaryDate".freeze
EACH_PAY_PERIOD =
"EachPayPeriod".freeze
ON_HOUR_WORKED =
"OnHourWorked".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmployeeLeaveType

Initializes the object

Parameters:

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

    Model attributes in the form of hash


89
90
91
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
121
122
123
124
125
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 89

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

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

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

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

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

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

Instance Attribute Details

#hours_accrued_annuallyObject

The number of hours accrued for the leave annually. This is 0 when the scheduleOfAccrual chosen is "OnHourWorked"


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

def hours_accrued_annually
  @hours_accrued_annually
end

#leave_type_idObject

The Xero identifier for leave type


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

def leave_type_id
  @leave_type_id
end

#maximum_to_accrueObject

The maximum number of hours that can be accrued for the leave


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

def maximum_to_accrue
  @maximum_to_accrue
end

#opening_balanceObject

The initial number of hours assigned when the leave was added to the employee


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

def opening_balance
  @opening_balance
end

#rate_accrued_hourlyObject

The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is "OnHourWorked"


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

def rate_accrued_hourly
  @rate_accrued_hourly
end

#schedule_of_accrualObject

The schedule of accrual


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

def schedule_of_accrual
  @schedule_of_accrual
end

Class Method Details

.attribute_mapObject

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


64
65
66
67
68
69
70
71
72
73
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 64

def self.attribute_map
  {
    :'leave_type_id' => :'leaveTypeID',
    :'schedule_of_accrual' => :'scheduleOfAccrual',
    :'hours_accrued_annually' => :'hoursAccruedAnnually',
    :'maximum_to_accrue' => :'maximumToAccrue',
    :'opening_balance' => :'openingBalance',
    :'rate_accrued_hourly' => :'rateAccruedHourly'
  }
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


190
191
192
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 190

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

.openapi_typesObject

Attribute type mapping.


76
77
78
79
80
81
82
83
84
85
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 76

def self.openapi_types
  {
    :'leave_type_id' => :'String',
    :'schedule_of_accrual' => :'String',
    :'hours_accrued_annually' => :'Float',
    :'maximum_to_accrue' => :'Float',
    :'opening_balance' => :'Float',
    :'rate_accrued_hourly' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


164
165
166
167
168
169
170
171
172
173
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      leave_type_id == o.leave_type_id &&
      schedule_of_accrual == o.schedule_of_accrual &&
      hours_accrued_annually == o.hours_accrued_annually &&
      maximum_to_accrue == o.maximum_to_accrue &&
      opening_balance == o.opening_balance &&
      rate_accrued_hourly == o.rate_accrued_hourly
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


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

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


291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 291

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


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 197

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

177
178
179
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 177

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


183
184
185
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 183

def hash
  [leave_type_id, schedule_of_accrual, hours_accrued_annually, maximum_to_accrue, opening_balance, rate_accrued_hourly].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 129

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


307
308
309
310
311
312
313
314
315
316
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 307

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


283
284
285
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 283

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


265
266
267
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 265

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


271
272
273
274
275
276
277
278
279
280
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 271

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


259
260
261
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 259

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


144
145
146
147
148
149
150
# File 'lib/xero-ruby/models/payroll_uk/employee_leave_type.rb', line 144

def valid?
  return false if @leave_type_id.nil?
  return false if @schedule_of_accrual.nil?
  schedule_of_accrual_validator = EnumAttributeValidator.new('String', ["BeginningOfCalendarYear", "OnAnniversaryDate", "EachPayPeriod", "OnHourWorked"])
  return false unless schedule_of_accrual_validator.valid?(@schedule_of_accrual)
  true
end