Class: XeroRuby::PayrollNz::Benefit

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

KIWI_SAVER = 
"KiwiSaver".freeze
COMPLYING_FUND = 
"ComplyingFund".freeze
OTHER = 
"Other".freeze
FIXED_AMOUNT = 
"FixedAmount".freeze
PERCENTAGE_OF_TAXABLE_EARNINGS = 
"PercentageOfTaxableEarnings".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Benefit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.rb', line 110

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#calculation_type_nz ⇒ Object

Calculation Type of the superannuation either FixedAmount or PercentageOfTaxableEarnings



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

def calculation_type_nz
  @calculation_type_nz
end

#category ⇒ Object

Superannuations Category type



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

def category
  @category
end

#company_max ⇒ Object

Company Maximum amount of the superannuation



49
50
51
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.rb', line 49

def company_max
  @company_max
end

#current_record ⇒ Object

Identifier of a record is active or not.



52
53
54
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.rb', line 52

def current_record
  @current_record
end

#expense_account_id ⇒ Object

Xero identifier for Expense Account



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

def 
  @expense_account_id
end

#id ⇒ Object

The Xero identifier for superannuation



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

def id
  @id
end

#liability_account_id ⇒ Object

Xero identifier for Liability Account



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

def 
  @liability_account_id
end

#name ⇒ Object

Name of the superannuations



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

def name
  @name
end

#percentage ⇒ Object

Percentage of Taxable Earnings of the superannuation



46
47
48
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.rb', line 46

def percentage
  @percentage
end

#standard_amount ⇒ Object

Standard amount of the superannuation



43
44
45
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.rb', line 43

def standard_amount
  @standard_amount
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.rb', line 77

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'category' => :'category',
    :'liability_account_id' => :'liabilityAccountId',
    :'expense_account_id' => :'expenseAccountId',
    :'calculation_type_nz' => :'calculationTypeNZ',
    :'standard_amount' => :'standardAmount',
    :'percentage' => :'percentage',
    :'company_max' => :'companyMax',
    :'current_record' => :'currentRecord'
  }
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_nz/benefit.rb', line 253

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

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.rb', line 93

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'category' => :'String',
    :'liability_account_id' => :'String',
    :'expense_account_id' => :'String',
    :'calculation_type_nz' => :'String',
    :'standard_amount' => :'BigDecimal',
    :'percentage' => :'BigDecimal',
    :'company_max' => :'BigDecimal',
    :'current_record' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      category == o.category &&
       == o. &&
       == o. &&
      calculation_type_nz == o.calculation_type_nz &&
      standard_amount == o.standard_amount &&
      percentage == o.percentage &&
      company_max == o.company_max &&
      current_record == o.current_record
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_nz/benefit.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::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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.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_nz/benefit.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_nz/benefit.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [id, name, category, , , calculation_type_nz, standard_amount, percentage, company_max, current_record].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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.rb', line 166

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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

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

  if @expense_account_id.nil?
    invalid_properties.push('invalid value for "expense_account_id", expense_account_id 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_nz/benefit.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_attributes ⇒ Object

Returns the object in the form of hash with snake_case



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

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



328
329
330
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.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_nz/benefit.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



322
323
324
 
# File 'lib/xero-ruby/models/payroll_nz/benefit.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



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

def valid?
  return false if @name.nil?
  return false if @category.nil?
  category_validator = EnumAttributeValidator.new('String', ["KiwiSaver", "ComplyingFund", "Other"])
  return false unless category_validator.valid?(@category)
  return false if @liability_account_id.nil?
  return false if @expense_account_id.nil?
  calculation_type_nz_validator = EnumAttributeValidator.new('String', ["FixedAmount", "PercentageOfTaxableEarnings"])
  return false unless calculation_type_nz_validator.valid?(@calculation_type_nz)
  true
end