Class: XeroRuby::PayrollNz::TaxSettings

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

WEEKS =
"weeks".freeze
MONTHS =
"months".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaxSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

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

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

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

Instance Attribute Details

#lump_sum_amountObject

The total of the lump sum amount


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

def lump_sum_amount
  @lump_sum_amount
end

#lump_sum_tax_codeObject

Tax code for a lump sum amount


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

def lump_sum_tax_code
  @lump_sum_tax_code
end

#period_typeObject

The type of period ("weeks" or "months")


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

def period_type
  @period_type
end

#period_unitsObject

The number of units for the period type


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

def period_units
  @period_units
end

#special_tax_rateObject

Tax rate for STC and WT


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

def special_tax_rate
  @special_tax_rate
end

#tax_codeObject

Returns the value of attribute tax_code


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

def tax_code
  @tax_code
end

Class Method Details

.attribute_mapObject

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


62
63
64
65
66
67
68
69
70
71
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 62

def self.attribute_map
  {
    :'period_units' => :'periodUnits',
    :'period_type' => :'periodType',
    :'tax_code' => :'taxCode',
    :'special_tax_rate' => :'specialTaxRate',
    :'lump_sum_tax_code' => :'lumpSumTaxCode',
    :'lump_sum_amount' => :'lumpSumAmount'
  }
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


178
179
180
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 178

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

.openapi_typesObject

Attribute type mapping.


74
75
76
77
78
79
80
81
82
83
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 74

def self.openapi_types
  {
    :'period_units' => :'BigDecimal',
    :'period_type' => :'String',
    :'tax_code' => :'TaxCode',
    :'special_tax_rate' => :'String',
    :'lump_sum_tax_code' => :'String',
    :'lump_sum_amount' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


152
153
154
155
156
157
158
159
160
161
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      period_units == o.period_units &&
      period_type == o.period_type &&
      tax_code == o.tax_code &&
      special_tax_rate == o.special_tax_rate &&
      lump_sum_tax_code == o.lump_sum_tax_code &&
      lump_sum_amount == o.lump_sum_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


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

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


279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 279

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


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 185

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

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

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


171
172
173
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 171

def hash
  [period_units, period_type, tax_code, special_tax_rate, lump_sum_tax_code, lump_sum_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


127
128
129
130
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 127

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


295
296
297
298
299
300
301
302
303
304
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 295

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


271
272
273
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 271

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


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

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


259
260
261
262
263
264
265
266
267
268
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 259

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


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

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


134
135
136
137
138
# File 'lib/xero-ruby/models/payroll_nz/tax_settings.rb', line 134

def valid?
  period_type_validator = EnumAttributeValidator.new('String', ["weeks", "months"])
  return false unless period_type_validator.valid?(@period_type)
  true
end