Class: XeroRuby::PayrollAu::EarningsLine

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EarningsLine

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/earnings_line.rb', line 78

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amountObject

Earnings rate amount


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

def amount
  @amount
end

#annual_salaryObject

Annual salary for earnings line


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

def annual_salary
  @annual_salary
end

#calculation_typeObject

Returns the value of attribute calculation_type


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

def calculation_type
  @calculation_type
end

#earnings_rate_idObject

Xero unique id for earnings rate


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

def earnings_rate_id
  @earnings_rate_id
end

#fixed_amountObject

Earnings rate amount. Only applicable if the EarningsRate RateType is Fixed


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

def fixed_amount
  @fixed_amount
end

#normal_number_of_unitsObject

Normal number of units for EarningsLine. Applicable when RateType is "MULTIPLE"


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

def normal_number_of_units
  @normal_number_of_units
end

#number_of_unitsObject

Earnings rate number of units.


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

def number_of_units
  @number_of_units
end

#number_of_units_per_weekObject

number of units for earning line


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

def number_of_units_per_week
  @number_of_units_per_week
end

#rate_per_unitObject

Rate per unit of the EarningsLine.


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

def rate_per_unit
  @rate_per_unit
end

Class Method Details

.attribute_mapObject

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/earnings_line.rb', line 47

def self.attribute_map
  {
    :'earnings_rate_id' => :'EarningsRateID',
    :'calculation_type' => :'CalculationType',
    :'annual_salary' => :'AnnualSalary',
    :'number_of_units_per_week' => :'NumberOfUnitsPerWeek',
    :'rate_per_unit' => :'RatePerUnit',
    :'normal_number_of_units' => :'NormalNumberOfUnits',
    :'amount' => :'Amount',
    :'number_of_units' => :'NumberOfUnits',
    :'fixed_amount' => :'FixedAmount'
  }
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_au/earnings_line.rb', line 177

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

.openapi_typesObject

Attribute type mapping.


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

def self.openapi_types
  {
    :'earnings_rate_id' => :'String',
    :'calculation_type' => :'EarningsRateCalculationType',
    :'annual_salary' => :'BigDecimal',
    :'number_of_units_per_week' => :'BigDecimal',
    :'rate_per_unit' => :'BigDecimal',
    :'normal_number_of_units' => :'BigDecimal',
    :'amount' => :'BigDecimal',
    :'number_of_units' => :'BigDecimal',
    :'fixed_amount' => :'BigDecimal'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      earnings_rate_id == o.earnings_rate_id &&
      calculation_type == o.calculation_type &&
      annual_salary == o.annual_salary &&
      number_of_units_per_week == o.number_of_units_per_week &&
      rate_per_unit == o.rate_per_unit &&
      normal_number_of_units == o.normal_number_of_units &&
      amount == o.amount &&
      number_of_units == o.number_of_units &&
      fixed_amount == o.fixed_amount
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_au/earnings_line.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::PayrollAu.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_au/earnings_line.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_au/earnings_line.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_au/earnings_line.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_au/earnings_line.rb', line 170

def hash
  [earnings_rate_id, calculation_type, annual_salary, number_of_units_per_week, rate_per_unit, normal_number_of_units, amount, number_of_units, fixed_amount].hash
end

#list_invalid_propertiesObject

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/earnings_line.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  if @earnings_rate_id.nil?
    invalid_properties.push('invalid value for "earnings_rate_id", earnings_rate_id 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_au/earnings_line.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_au/earnings_line.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_au/earnings_line.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_au/earnings_line.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_au/earnings_line.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


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

def valid?
  return false if @earnings_rate_id.nil?
  true
end