Class: UltracartClient::OrderTaxes

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/order_taxes.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderTaxes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
188
189
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 116

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'arbitrary_tax')
    self.arbitrary_tax = attributes[:'arbitrary_tax']
  end

  if attributes.has_key?(:'arbitrary_tax_rate')
    self.arbitrary_tax_rate = attributes[:'arbitrary_tax_rate']
  end

  if attributes.has_key?(:'arbitrary_taxable_subtotal')
    self.arbitrary_taxable_subtotal = attributes[:'arbitrary_taxable_subtotal']
  end

  if attributes.has_key?(:'tax_city_accounting_code')
    self.tax_city_accounting_code = attributes[:'tax_city_accounting_code']
  end

  if attributes.has_key?(:'tax_country_accounting_code')
    self.tax_country_accounting_code = attributes[:'tax_country_accounting_code']
  end

  if attributes.has_key?(:'tax_county')
    self.tax_county = attributes[:'tax_county']
  end

  if attributes.has_key?(:'tax_county_accounting_code')
    self.tax_county_accounting_code = attributes[:'tax_county_accounting_code']
  end

  if attributes.has_key?(:'tax_gift_charge')
    self.tax_gift_charge = attributes[:'tax_gift_charge']
  end

  if attributes.has_key?(:'tax_postal_code_accounting_code')
    self.tax_postal_code_accounting_code = attributes[:'tax_postal_code_accounting_code']
  end

  if attributes.has_key?(:'tax_rate')
    self.tax_rate = attributes[:'tax_rate']
  end

  if attributes.has_key?(:'tax_rate_city')
    self.tax_rate_city = attributes[:'tax_rate_city']
  end

  if attributes.has_key?(:'tax_rate_country')
    self.tax_rate_country = attributes[:'tax_rate_country']
  end

  if attributes.has_key?(:'tax_rate_county')
    self.tax_rate_county = attributes[:'tax_rate_county']
  end

  if attributes.has_key?(:'tax_rate_postal_code')
    self.tax_rate_postal_code = attributes[:'tax_rate_postal_code']
  end

  if attributes.has_key?(:'tax_rate_state')
    self.tax_rate_state = attributes[:'tax_rate_state']
  end

  if attributes.has_key?(:'tax_shipping')
    self.tax_shipping = attributes[:'tax_shipping']
  end

  if attributes.has_key?(:'tax_state_accounting_code')
    self.tax_state_accounting_code = attributes[:'tax_state_accounting_code']
  end
end

Instance Attribute Details

#arbitrary_tax ⇒ Object

Arbitrary Tax, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.



18
19
20
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 18

def arbitrary_tax
  @arbitrary_tax
end

#arbitrary_tax_rate ⇒ Object

Arbitrary tax rate, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.



21
22
23
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 21

def arbitrary_tax_rate
  @arbitrary_tax_rate
end

#arbitrary_taxable_subtotal ⇒ Object

Arbitrary taxable subtotal, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.



24
25
26
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 24

def arbitrary_taxable_subtotal
  @arbitrary_taxable_subtotal
end

#tax_city_accounting_code ⇒ Object

QuickBooks tax city code



27
28
29
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 27

def tax_city_accounting_code
  @tax_city_accounting_code
end

#tax_country_accounting_code ⇒ Object

QuickBooks tax country code



30
31
32
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 30

def tax_country_accounting_code
  @tax_country_accounting_code
end

#tax_county ⇒ Object

County used for tax calculation purposes (only in the United States)



33
34
35
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 33

def tax_county
  @tax_county
end

#tax_county_accounting_code ⇒ Object

QuickBooks tax county code



36
37
38
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 36

def tax_county_accounting_code
  @tax_county_accounting_code
end

#tax_gift_charge ⇒ Object

True if gift charge is taxed



39
40
41
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 39

def tax_gift_charge
  @tax_gift_charge
end

#tax_postal_code_accounting_code ⇒ Object

QuickBooks tax postal code code



42
43
44
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 42

def tax_postal_code_accounting_code
  @tax_postal_code_accounting_code
end

#tax_rate ⇒ Object

Tax rate, this is meaningless for updating an order. For inserting a new order, if you need to override internal tax calculations, use the arbitrary fields.



45
46
47
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 45

def tax_rate
  @tax_rate
end

#tax_rate_city ⇒ Object

Tax rate at the city level



48
49
50
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 48

def tax_rate_city
  @tax_rate_city
end

#tax_rate_country ⇒ Object

Tax rate at the country level



51
52
53
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 51

def tax_rate_country
  @tax_rate_country
end

#tax_rate_county ⇒ Object

Tax rate at the county level



54
55
56
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 54

def tax_rate_county
  @tax_rate_county
end

#tax_rate_postal_code ⇒ Object

Tax rate at the postal code level



57
58
59
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 57

def tax_rate_postal_code
  @tax_rate_postal_code
end

#tax_rate_state ⇒ Object

Tax rate at the state level



60
61
62
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 60

def tax_rate_state
  @tax_rate_state
end

#tax_shipping ⇒ Object

True if shipping is taxed



63
64
65
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 63

def tax_shipping
  @tax_shipping
end

#tax_state_accounting_code ⇒ Object

QuickBooks tax state code



66
67
68
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 66

def tax_state_accounting_code
  @tax_state_accounting_code
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 69

def self.attribute_map
  {
    :'arbitrary_tax' => :'arbitrary_tax',
    :'arbitrary_tax_rate' => :'arbitrary_tax_rate',
    :'arbitrary_taxable_subtotal' => :'arbitrary_taxable_subtotal',
    :'tax_city_accounting_code' => :'tax_city_accounting_code',
    :'tax_country_accounting_code' => :'tax_country_accounting_code',
    :'tax_county' => :'tax_county',
    :'tax_county_accounting_code' => :'tax_county_accounting_code',
    :'tax_gift_charge' => :'tax_gift_charge',
    :'tax_postal_code_accounting_code' => :'tax_postal_code_accounting_code',
    :'tax_rate' => :'tax_rate',
    :'tax_rate_city' => :'tax_rate_city',
    :'tax_rate_country' => :'tax_rate_country',
    :'tax_rate_county' => :'tax_rate_county',
    :'tax_rate_postal_code' => :'tax_rate_postal_code',
    :'tax_rate_state' => :'tax_rate_state',
    :'tax_shipping' => :'tax_shipping',
    :'tax_state_accounting_code' => :'tax_state_accounting_code'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 92

def self.swagger_types
  {
    :'arbitrary_tax' => :'Float',
    :'arbitrary_tax_rate' => :'Float',
    :'arbitrary_taxable_subtotal' => :'Float',
    :'tax_city_accounting_code' => :'String',
    :'tax_country_accounting_code' => :'String',
    :'tax_county' => :'String',
    :'tax_county_accounting_code' => :'String',
    :'tax_gift_charge' => :'BOOLEAN',
    :'tax_postal_code_accounting_code' => :'String',
    :'tax_rate' => :'Float',
    :'tax_rate_city' => :'Float',
    :'tax_rate_country' => :'Float',
    :'tax_rate_county' => :'Float',
    :'tax_rate_postal_code' => :'Float',
    :'tax_rate_state' => :'Float',
    :'tax_shipping' => :'BOOLEAN',
    :'tax_state_accounting_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      arbitrary_tax == o.arbitrary_tax &&
      arbitrary_tax_rate == o.arbitrary_tax_rate &&
      arbitrary_taxable_subtotal == o.arbitrary_taxable_subtotal &&
      tax_city_accounting_code == o.tax_city_accounting_code &&
      tax_country_accounting_code == o.tax_country_accounting_code &&
      tax_county == o.tax_county &&
      tax_county_accounting_code == o.tax_county_accounting_code &&
      tax_gift_charge == o.tax_gift_charge &&
      tax_postal_code_accounting_code == o.tax_postal_code_accounting_code &&
      tax_rate == o.tax_rate &&
      tax_rate_city == o.tax_rate_city &&
      tax_rate_country == o.tax_rate_country &&
      tax_rate_county == o.tax_rate_county &&
      tax_rate_postal_code == o.tax_rate_postal_code &&
      tax_rate_state == o.tax_rate_state &&
      tax_shipping == o.tax_shipping &&
      tax_state_accounting_code == o.tax_state_accounting_code
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



279
280
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
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 279

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  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
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 345

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 258

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


245
246
247
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 251

def hash
  [arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, tax_city_accounting_code, tax_country_accounting_code, tax_county, tax_county_accounting_code, tax_gift_charge, tax_postal_code_accounting_code, tax_rate, tax_rate_city, tax_rate_country, tax_rate_county, tax_rate_postal_code, tax_rate_state, tax_shipping, tax_state_accounting_code].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



193
194
195
196
197
198
199
200
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 193

def list_invalid_properties
  invalid_properties = Array.new
  if !@tax_county.nil? && @tax_county.to_s.length > 32
    invalid_properties.push('invalid value for "tax_county", the character length must be smaller than or equal to 32.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



325
326
327
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 325

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



331
332
333
334
335
336
337
338
339
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 331

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



319
320
321
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 319

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



204
205
206
207
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 204

def valid?
  return false if !@tax_county.nil? && @tax_county.to_s.length > 32
  true
end