Class: XeroRuby::PayrollUk::SalaryAndWage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

ACTIVE =
"Active".freeze
PENDING =
"Pending".freeze
HISTORY =
"History".freeze
SALARY =
"Salary".freeze
HOURLY =
"Hourly".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SalaryAndWage

Initializes the object

Parameters:

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

    Model attributes in the form of hash


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 105

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

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

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

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

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

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

Instance Attribute Details

#annual_salaryObject

The annual salary


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

def annual_salary
  @annual_salary
end

#earnings_rate_idObject

Xero unique identifier for an earnings rate


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

def earnings_rate_id
  @earnings_rate_id
end

#effective_fromObject

The effective date of the corresponding salary and wages


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

def effective_from
  @effective_from
end

#number_of_units_per_dayObject

The Number of Units per day for the corresponding salary and wages


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

def number_of_units_per_day
  @number_of_units_per_day
end

#number_of_units_per_weekObject

The Number of Units per week for the corresponding salary and wages


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

def number_of_units_per_week
  @number_of_units_per_week
end

#payment_typeObject

The type of the payment of the corresponding salary and wages


47
48
49
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 47

def payment_type
  @payment_type
end

#rate_per_unitObject

The rate of each unit for the corresponding salary and wages


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

def rate_per_unit
  @rate_per_unit
end

#salary_and_wages_idObject

Xero unique identifier for a salary and wages record


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

def salary_and_wages_id
  @salary_and_wages_id
end

#statusObject

The current status of the corresponding salary and wages


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

def status
  @status
end

Class Method Details

.attribute_mapObject

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


74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 74

def self.attribute_map
  {
    :'salary_and_wages_id' => :'salaryAndWagesID',
    :'earnings_rate_id' => :'earningsRateID',
    :'number_of_units_per_week' => :'numberOfUnitsPerWeek',
    :'rate_per_unit' => :'ratePerUnit',
    :'number_of_units_per_day' => :'numberOfUnitsPerDay',
    :'effective_from' => :'effectiveFrom',
    :'annual_salary' => :'annualSalary',
    :'status' => :'status',
    :'payment_type' => :'paymentType'
  }
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


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

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

.openapi_typesObject

Attribute type mapping.


89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 89

def self.openapi_types
  {
    :'salary_and_wages_id' => :'String',
    :'earnings_rate_id' => :'String',
    :'number_of_units_per_week' => :'Float',
    :'rate_per_unit' => :'Float',
    :'number_of_units_per_day' => :'Float',
    :'effective_from' => :'Date',
    :'annual_salary' => :'Float',
    :'status' => :'String',
    :'payment_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      salary_and_wages_id == o.salary_and_wages_id &&
      earnings_rate_id == o.earnings_rate_id &&
      number_of_units_per_week == o.number_of_units_per_week &&
      rate_per_unit == o.rate_per_unit &&
      number_of_units_per_day == o.number_of_units_per_day &&
      effective_from == o.effective_from &&
      annual_salary == o.annual_salary &&
      status == o.status &&
      payment_type == o.payment_type
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


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 281

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


354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 354

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


260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 260

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

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

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


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

def hash
  [salary_and_wages_id, earnings_rate_id, number_of_units_per_week, rate_per_unit, number_of_units_per_day, effective_from, annual_salary, status, payment_type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 157

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

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

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

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object


370
371
372
373
374
375
376
377
378
379
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 370

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


346
347
348
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 346

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


328
329
330
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 328

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


334
335
336
337
338
339
340
341
342
343
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 334

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


322
323
324
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 322

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


188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/xero-ruby/models/payroll_uk/salary_and_wage.rb', line 188

def valid?
  return false if @earnings_rate_id.nil?
  return false if @number_of_units_per_week.nil?
  return false if @effective_from.nil?
  return false if @annual_salary.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["Active", "Pending", "History"])
  return false unless status_validator.valid?(@status)
  return false if @payment_type.nil?
  payment_type_validator = EnumAttributeValidator.new('String', ["Salary", "Hourly"])
  return false unless payment_type_validator.valid?(@payment_type)
  true
end