Class: XeroRuby::Accounting::TaxComponent

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaxComponent

Initializes the object

Parameters:

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

    Model attributes in the form of hash


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 53

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

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

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

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

Instance Attribute Details

#is_compoundObject

Boolean to describe if Tax rate is compounded.


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

def is_compound
  @is_compound
end

#is_non_recoverableObject

Boolean to describe if tax rate is non-recoverable. Non-recoverable rates are only applicable to Canadian organisations


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

def is_non_recoverable
  @is_non_recoverable
end

#nameObject

Name of Tax Component


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

def name
  @name
end

#rateObject

Tax Rate (up to 4dp)


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

def rate
  @rate
end

Class Method Details

.attribute_mapObject

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


32
33
34
35
36
37
38
39
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 32

def self.attribute_map
  {
    :'name' => :'Name',
    :'rate' => :'Rate',
    :'is_compound' => :'IsCompound',
    :'is_non_recoverable' => :'IsNonRecoverable'
  }
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


122
123
124
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 122

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

.openapi_typesObject

Attribute type mapping.


42
43
44
45
46
47
48
49
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 42

def self.openapi_types
  {
    :'name' => :'String',
    :'rate' => :'BigDecimal',
    :'is_compound' => :'Boolean',
    :'is_non_recoverable' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


98
99
100
101
102
103
104
105
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 98

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      rate == o.rate &&
      is_compound == o.is_compound &&
      is_non_recoverable == o.is_non_recoverable
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


150
151
152
153
154
155
156
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
185
186
187
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 150

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::Accounting.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


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

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


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 129

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

109
110
111
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 109

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


115
116
117
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 115

def hash
  [name, rate, is_compound, is_non_recoverable].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


85
86
87
88
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 85

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


239
240
241
242
243
244
245
246
247
248
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 239

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


215
216
217
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 215

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


197
198
199
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 197

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


203
204
205
206
207
208
209
210
211
212
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 203

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


191
192
193
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 191

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


92
93
94
# File 'lib/xero-ruby/models/accounting/tax_component.rb', line 92

def valid?
  true
end