Class: XeroRuby::PayrollAu::LeaveType

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LeaveType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
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
126
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 78

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#current_record ⇒ Object

Is the current record



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

def current_record
  @current_record
end

#is_paid_leave ⇒ Object

Set this to indicate that an employee will be paid when taking this type of leave



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

def is_paid_leave
  @is_paid_leave
end

#leave_loading_rate ⇒ Object

Enter an amount here if your organisation pays an additional percentage on top of ordinary earnings when your employees take leave (typically 17.5%)



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

def leave_loading_rate
  @leave_loading_rate
end

#leave_type_id ⇒ Object

Xero identifier



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

def leave_type_id
  @leave_type_id
end

#name ⇒ Object

Name of the earnings rate (max length = 100)



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

def name
  @name
end

#normal_entitlement ⇒ Object

The number of units the employee is entitled to each year



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

def normal_entitlement
  @normal_entitlement
end

#show_on_payslip ⇒ Object

Set this if you want a balance for this leave type to be shown on your employee’s payslips



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

def show_on_payslip
  @show_on_payslip
end

#type_of_units ⇒ Object

The type of units by which leave entitlements are normally tracked. These are typically the same as the type of units used for the employee’s ordinary earnings rate



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

def type_of_units
  @type_of_units
end

#updated_date_utc ⇒ Object

Last modified timestamp



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

def updated_date_utc
  @updated_date_utc
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 47

def self.attribute_map
  {
    :'name' => :'Name',
    :'type_of_units' => :'TypeOfUnits',
    :'leave_type_id' => :'LeaveTypeID',
    :'normal_entitlement' => :'NormalEntitlement',
    :'leave_loading_rate' => :'LeaveLoadingRate',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'is_paid_leave' => :'IsPaidLeave',
    :'show_on_payslip' => :'ShowOnPayslip',
    :'current_record' => :'CurrentRecord'
  }
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



187
188
189
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 187

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 62

def self.openapi_types
  {
    :'name' => :'String',
    :'type_of_units' => :'String',
    :'leave_type_id' => :'String',
    :'normal_entitlement' => :'Float',
    :'leave_loading_rate' => :'Float',
    :'updated_date_utc' => :'DateTime',
    :'is_paid_leave' => :'Boolean',
    :'show_on_payslip' => :'Boolean',
    :'current_record' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      type_of_units == o.type_of_units &&
      leave_type_id == o.leave_type_id &&
      normal_entitlement == o.normal_entitlement &&
      leave_loading_rate == o.leave_loading_rate &&
      updated_date_utc == o.updated_date_utc &&
      is_paid_leave == o.is_paid_leave &&
      show_on_payslip == o.show_on_payslip &&
      current_record == o.current_record
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



215
216
217
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
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 215

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::PayrollAu.const_get(type).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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 288

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 194

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


174
175
176
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 180

def hash
  [name, type_of_units, leave_type_id, normal_entitlement, leave_loading_rate, updated_date_utc, is_paid_leave, show_on_payslip, current_record].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



130
131
132
133
134
135
136
137
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 130

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



302
303
304
305
306
307
308
309
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 302

def parse_date(datestring)
  if datestring.include?('Date')
    seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
    Time.at(seconds_since_epoch).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_attributes ⇒ Object

Returns the object in the form of hash with snake_case



280
281
282
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 280

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



262
263
264
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 262

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



268
269
270
271
272
273
274
275
276
277
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 268

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)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



256
257
258
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 256

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



141
142
143
144
 
# File 'lib/xero-ruby/models/payroll_au/leave_type.rb', line 141

def valid?
  return false if !@name.nil? && @name.to_s.length > 100
  true
end