Class: XeroRuby::PayrollNz::EmployeeLeaveSetup

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmployeeLeaveSetup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 93

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#annual_leave_anniversary_date ⇒ Object

The first date the employee will accrue Annual Leave. When null the Employee’s start date is used as the anniversary date



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

def annual_leave_anniversary_date
  @annual_leave_anniversary_date
end

#annual_leave_opening_balance ⇒ Object

Initial annual leave balance. The balance at their last anniversary, less any leave taken since then and excluding accrued annual leave.



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

def annual_leave_opening_balance
  @annual_leave_opening_balance
end

#holiday_pay_opening_balance ⇒ Object

Initial holiday pay balance. A percentage — usually 8% — of gross earnings since their last work anniversary.



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

def holiday_pay_opening_balance
  @holiday_pay_opening_balance
end

#include_holiday_pay ⇒ Object

Identifier if holiday pay will be included in each payslip



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

def include_holiday_pay
  @include_holiday_pay
end

#negative_annual_leave_balance_paid_amount ⇒ Object

The dollar value of annual leave opening balance if negative.



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

def negative_annual_leave_balance_paid_amount
  @negative_annual_leave_balance_paid_amount
end

#sick_leave_anniversary_date ⇒ Object

If Sick Leave Schedule of Accrual is "OnAnniversaryDate", this is the date when entitled to Sick Leave. When null the Employee’s start date is used as the anniversary date



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

def sick_leave_anniversary_date
  @sick_leave_anniversary_date
end

#sick_leave_hours_to_accrue_annually ⇒ Object

Deprecated use SickLeaveToAccrueAnnually



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

def sick_leave_hours_to_accrue_annually
  @sick_leave_hours_to_accrue_annually
end

#sick_leave_maximum_hours_to_accrue ⇒ Object

Deprecated use SickLeaveMaximumToAccrue



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

def sick_leave_maximum_hours_to_accrue
  @sick_leave_maximum_hours_to_accrue
end

#sick_leave_maximum_to_accrue ⇒ Object

Maximum number of units accrued annually for sick leave. The type of units is determined by the property "TypeOfUnitsToAccrue" on the "Sick Leave" leave type



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

def sick_leave_maximum_to_accrue
  @sick_leave_maximum_to_accrue
end

#sick_leave_opening_balance ⇒ Object

Initial sick leave balance. This will be positive unless they’ve taken sick leave in advance



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

def sick_leave_opening_balance
  @sick_leave_opening_balance
end

#sick_leave_schedule_of_accrual ⇒ Object

Set Schedule of Accrual Type for Sick Leave



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

def sick_leave_schedule_of_accrual
  @sick_leave_schedule_of_accrual
end

#sick_leave_to_accrue_annually ⇒ Object

Number of units accrued annually for sick leave. The type of units is determined by the property "TypeOfUnitsToAccrue" on the "Sick Leave" leave type



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

def sick_leave_to_accrue_annually
  @sick_leave_to_accrue_annually
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 56

def self.attribute_map
  {
    :'include_holiday_pay' => :'includeHolidayPay',
    :'holiday_pay_opening_balance' => :'holidayPayOpeningBalance',
    :'annual_leave_opening_balance' => :'annualLeaveOpeningBalance',
    :'negative_annual_leave_balance_paid_amount' => :'negativeAnnualLeaveBalancePaidAmount',
    :'sick_leave_hours_to_accrue_annually' => :'sickLeaveHoursToAccrueAnnually',
    :'sick_leave_maximum_hours_to_accrue' => :'sickLeaveMaximumHoursToAccrue',
    :'sick_leave_to_accrue_annually' => :'SickLeaveToAccrueAnnually',
    :'sick_leave_maximum_to_accrue' => :'SickLeaveMaximumToAccrue',
    :'sick_leave_opening_balance' => :'sickLeaveOpeningBalance',
    :'sick_leave_schedule_of_accrual' => :'SickLeaveScheduleOfAccrual',
    :'sick_leave_anniversary_date' => :'SickLeaveAnniversaryDate',
    :'annual_leave_anniversary_date' => :'AnnualLeaveAnniversaryDate'
  }
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



202
203
204
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 202

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

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 74

def self.openapi_types
  {
    :'include_holiday_pay' => :'Boolean',
    :'holiday_pay_opening_balance' => :'BigDecimal',
    :'annual_leave_opening_balance' => :'BigDecimal',
    :'negative_annual_leave_balance_paid_amount' => :'BigDecimal',
    :'sick_leave_hours_to_accrue_annually' => :'BigDecimal',
    :'sick_leave_maximum_hours_to_accrue' => :'BigDecimal',
    :'sick_leave_to_accrue_annually' => :'BigDecimal',
    :'sick_leave_maximum_to_accrue' => :'BigDecimal',
    :'sick_leave_opening_balance' => :'BigDecimal',
    :'sick_leave_schedule_of_accrual' => :'String',
    :'sick_leave_anniversary_date' => :'Date',
    :'annual_leave_anniversary_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      include_holiday_pay == o.include_holiday_pay &&
      holiday_pay_opening_balance == o.holiday_pay_opening_balance &&
      annual_leave_opening_balance == o.annual_leave_opening_balance &&
      negative_annual_leave_balance_paid_amount == o.negative_annual_leave_balance_paid_amount &&
      sick_leave_hours_to_accrue_annually == o.sick_leave_hours_to_accrue_annually &&
      sick_leave_maximum_hours_to_accrue == o.sick_leave_maximum_hours_to_accrue &&
      sick_leave_to_accrue_annually == o.sick_leave_to_accrue_annually &&
      sick_leave_maximum_to_accrue == o.sick_leave_maximum_to_accrue &&
      sick_leave_opening_balance == o.sick_leave_opening_balance &&
      sick_leave_schedule_of_accrual == o.sick_leave_schedule_of_accrual &&
      sick_leave_anniversary_date == o.sick_leave_anniversary_date &&
      annual_leave_anniversary_date == o.annual_leave_anniversary_date
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



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
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 230

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::PayrollNz.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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 303

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 209

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


189
190
191
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 195

def hash
  [include_holiday_pay, holiday_pay_opening_balance, annual_leave_opening_balance, negative_annual_leave_balance_paid_amount, sick_leave_hours_to_accrue_annually, sick_leave_maximum_hours_to_accrue, sick_leave_to_accrue_annually, sick_leave_maximum_to_accrue, sick_leave_opening_balance, sick_leave_schedule_of_accrual, sick_leave_anniversary_date, annual_leave_anniversary_date].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



157
158
159
160
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 319

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
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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_attributes ⇒ Object

Returns the object in the form of hash with snake_case



295
296
297
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 295

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



277
278
279
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 277

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



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 283

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



271
272
273
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 271

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



164
165
166
 
# File 'lib/xero-ruby/models/payroll_nz/employee_leave_setup.rb', line 164

def valid?
  true
end