Class: XeroRuby::PayrollUk::EmployeeLeave

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmployeeLeave

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
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
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 68

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

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

Instance Attribute Details

#description ⇒ Object

The description of the leave (max length = 50)



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

def description
  @description
end

#end_date ⇒ Object

End date of the leave (YYYY-MM-DD)



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

def end_date
  @end_date
end

#leave_id ⇒ Object

The Xero identifier for LeaveType



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

def leave_id
  @leave_id
end

#leave_type_id ⇒ Object

The Xero identifier for LeaveType



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

def leave_type_id
  @leave_type_id
end

#periods ⇒ Object

The leave period information. The StartDate, EndDate and NumberOfUnits needs to be specified when you do not want to calculate NumberOfUnits automatically. Using incorrect period StartDate and EndDate will result in automatic computation of the NumberOfUnits.



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

def periods
  @periods
end

#start_date ⇒ Object

Start date of the leave (YYYY-MM-DD)



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

def start_date
  @start_date
end

#updated_date_utc ⇒ Object

UTC timestamp of last update to the leave type note



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

def updated_date_utc
  @updated_date_utc
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 41

def self.attribute_map
  {
    :'leave_id' => :'leaveID',
    :'leave_type_id' => :'leaveTypeID',
    :'description' => :'description',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'periods' => :'periods',
    :'updated_date_utc' => :'updatedDateUTC'
  }
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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 54

def self.openapi_types
  {
    :'leave_id' => :'String',
    :'leave_type_id' => :'String',
    :'description' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'periods' => :'Array<LeavePeriod>',
    :'updated_date_utc' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 147

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      leave_id == o.leave_id &&
      leave_type_id == o.leave_type_id &&
      description == o.description &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      periods == o.periods &&
      updated_date_utc == o.updated_date_utc
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



202
203
204
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
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 202

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 275

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 181

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


161
162
163
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



167
168
169
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 167

def hash
  [leave_id, leave_type_id, description, start_date, end_date, periods, updated_date_utc].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



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

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 @description.nil?
    invalid_properties.push('invalid value for "description", description 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

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



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

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



267
268
269
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 267

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



249
250
251
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 249

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



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

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



243
244
245
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 243

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



137
138
139
140
141
142
143
 
# File 'lib/xero-ruby/models/payroll_uk/employee_leave.rb', line 137

def valid?
  return false if @leave_type_id.nil?
  return false if @description.nil?
  return false if @start_date.nil?
  return false if @end_date.nil?
  true
end