Class: XeroRuby::PayrollNz::LeavePeriod

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

APPROVED =
"Approved".freeze
COMPLETED =
"Completed".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LeavePeriod

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

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

Instance Attribute Details

#number_of_unitsObject

The Number of Units for the leave


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

def number_of_units
  @number_of_units
end

#period_end_dateObject

The Pay Period End Date (YYYY-MM-DD)


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

def period_end_date
  @period_end_date
end

#period_start_dateObject

The Pay Period Start Date (YYYY-MM-DD)


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

def period_start_date
  @period_start_date
end

#period_statusObject

Period Status


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

def period_status
  @period_status
end

Class Method Details

.attribute_mapObject

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


56
57
58
59
60
61
62
63
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 56

def self.attribute_map
  {
    :'period_start_date' => :'periodStartDate',
    :'period_end_date' => :'periodEndDate',
    :'number_of_units' => :'numberOfUnits',
    :'period_status' => :'periodStatus'
  }
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


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

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

.openapi_typesObject

Attribute type mapping.


66
67
68
69
70
71
72
73
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 66

def self.openapi_types
  {
    :'period_start_date' => :'Date',
    :'period_end_date' => :'Date',
    :'number_of_units' => :'BigDecimal',
    :'period_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


134
135
136
137
138
139
140
141
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      period_start_date == o.period_start_date &&
      period_end_date == o.period_end_date &&
      number_of_units == o.number_of_units &&
      period_status == o.period_status
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


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 186

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


259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 259

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


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 165

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

145
146
147
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 145

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


151
152
153
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 151

def hash
  [period_start_date, period_end_date, number_of_units, period_status].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


109
110
111
112
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 109

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


275
276
277
278
279
280
281
282
283
284
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 275

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


251
252
253
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 251

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


233
234
235
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 233

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


239
240
241
242
243
244
245
246
247
248
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 239

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


227
228
229
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 227

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


116
117
118
119
120
# File 'lib/xero-ruby/models/payroll_nz/leave_period.rb', line 116

def valid?
  period_status_validator = EnumAttributeValidator.new('String', ["Approved", "Completed"])
  return false unless period_status_validator.valid?(@period_status)
  true
end