Class: XeroRuby::PayrollUk::EarningsLine

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/payroll_uk/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_uk/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::PayrollUk::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::PayrollUk::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_line_id')
    self.earnings_line_id = attributes[:'earnings_line_id']
  end

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The amount of the earnings line.



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

def amount
  @amount
end

#display_name ⇒ Object

name of earnings rate for display in UI



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

def display_name
  @display_name
end

#earnings_line_id ⇒ Object

Xero identifier for payroll earnings line



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

def earnings_line_id
  @earnings_line_id
end

#earnings_rate_id ⇒ Object

Xero identifier for payroll earnings rate



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

def earnings_rate_id
  @earnings_rate_id
end

#fixed_amount ⇒ Object

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



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

def fixed_amount
  @fixed_amount
end

#is_average_daily_pay_rate ⇒ Object

Identifies if the earnings is using an average daily pay rate



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

def is_average_daily_pay_rate
  @is_average_daily_pay_rate
end

#is_linked_to_timesheet ⇒ Object

Identifies if the earnings is taken from the timesheet. False for earnings line



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

def is_linked_to_timesheet
  @is_linked_to_timesheet
end

#number_of_units ⇒ Object

Earnings number of units



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

def number_of_units
  @number_of_units
end

#rate_per_unit ⇒ Object

Rate per unit for earnings line



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

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

def self.attribute_map
  {
    :'earnings_line_id' => :'earningsLineID',
    :'earnings_rate_id' => :'earningsRateID',
    :'display_name' => :'displayName',
    :'rate_per_unit' => :'ratePerUnit',
    :'number_of_units' => :'numberOfUnits',
    :'fixed_amount' => :'fixedAmount',
    :'amount' => :'amount',
    :'is_linked_to_timesheet' => :'isLinkedToTimesheet',
    :'is_average_daily_pay_rate' => :'isAverageDailyPayRate'
  }
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



172
173
174
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 172

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

def self.openapi_types
  {
    :'earnings_line_id' => :'String',
    :'earnings_rate_id' => :'String',
    :'display_name' => :'String',
    :'rate_per_unit' => :'Float',
    :'number_of_units' => :'Float',
    :'fixed_amount' => :'Float',
    :'amount' => :'Float',
    :'is_linked_to_timesheet' => :'Boolean',
    :'is_average_daily_pay_rate' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      earnings_line_id == o.earnings_line_id &&
      earnings_rate_id == o.earnings_rate_id &&
      display_name == o.display_name &&
      rate_per_unit == o.rate_per_unit &&
      number_of_units == o.number_of_units &&
      fixed_amount == o.fixed_amount &&
      amount == o.amount &&
      is_linked_to_timesheet == o.is_linked_to_timesheet &&
      is_average_daily_pay_rate == o.is_average_daily_pay_rate
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



200
201
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
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 200

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



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

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



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

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


159
160
161
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [earnings_line_id, earnings_rate_id, display_name, rate_per_unit, number_of_units, fixed_amount, amount, is_linked_to_timesheet, is_average_daily_pay_rate].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
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object 



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

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



265
266
267
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 265

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



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

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



253
254
255
256
257
258
259
260
261
262
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 253

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



241
242
243
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 241

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
 
# File 'lib/xero-ruby/models/payroll_uk/earnings_line.rb', line 137

def valid?
  true
end