Class: XeroRuby::PayrollUk::LeaveType

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/payroll_uk/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


73
74
75
76
77
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
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 73

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

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

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

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

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

Instance Attribute Details

#is_activeObject

Shows whether the leave type is active or not


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

def is_active
  @is_active
end

#is_paid_leaveObject

Indicate that an employee will be paid when taking this type of leave


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

def is_paid_leave
  @is_paid_leave
end

#is_statutory_leaveObject

Shows whether the leave type is a statutory leave type or not


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

def is_statutory_leave
  @is_statutory_leave
end

#leave_idObject

Xero unique identifier for the leave


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

def leave_id
  @leave_id
end

#leave_type_idObject

Xero unique identifier for the leave type


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

def leave_type_id
  @leave_type_id
end

#nameObject

Name of the leave type


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

def name
  @name
end

#show_on_payslipObject

Indicate that a balance for this leave type to be shown on the employee’s payslips


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

def show_on_payslip
  @show_on_payslip
end

#updated_date_utcObject

UTC timestamp of last update to the leave type note


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

def updated_date_utc
  @updated_date_utc
end

Class Method Details

.attribute_mapObject

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


44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 44

def self.attribute_map
  {
    :'leave_id' => :'leaveID',
    :'leave_type_id' => :'leaveTypeID',
    :'name' => :'name',
    :'is_paid_leave' => :'isPaidLeave',
    :'show_on_payslip' => :'showOnPayslip',
    :'updated_date_utc' => :'updatedDateUTC',
    :'is_active' => :'isActive',
    :'is_statutory_leave' => :'isStatutoryLeave'
  }
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


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

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

.openapi_typesObject

Attribute type mapping.


58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 58

def self.openapi_types
  {
    :'leave_id' => :'String',
    :'leave_type_id' => :'String',
    :'name' => :'String',
    :'is_paid_leave' => :'Boolean',
    :'show_on_payslip' => :'Boolean',
    :'updated_date_utc' => :'DateTime',
    :'is_active' => :'Boolean',
    :'is_statutory_leave' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      leave_id == o.leave_id &&
      leave_type_id == o.leave_type_id &&
      name == o.name &&
      is_paid_leave == o.is_paid_leave &&
      show_on_payslip == o.show_on_payslip &&
      updated_date_utc == o.updated_date_utc &&
      is_active == o.is_active &&
      is_statutory_leave == o.is_statutory_leave
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


205
206
207
208
209
210
211
212
213
214
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
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 205

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


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 278

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


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 184

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

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

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


170
171
172
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 170

def hash
  [leave_id, leave_type_id, name, is_paid_leave, show_on_payslip, updated_date_utc, is_active, is_statutory_leave].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 121

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


294
295
296
297
298
299
300
301
302
303
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 294

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


270
271
272
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 270

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


252
253
254
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 252

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


258
259
260
261
262
263
264
265
266
267
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 258

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


246
247
248
# File 'lib/xero-ruby/models/payroll_uk/leave_type.rb', line 246

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


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

def valid?
  return false if @name.nil?
  return false if @is_paid_leave.nil?
  return false if @show_on_payslip.nil?
  true
end