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



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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 128

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.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.



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

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.



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

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.



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

def arbitrary_taxable_subtotal
  @arbitrary_taxable_subtotal
end

#tax_city_accounting_code ⇒ Object

QuickBooks tax city code



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

def tax_city_accounting_code
  @tax_city_accounting_code
end

#tax_country_accounting_code ⇒ Object

QuickBooks tax country code



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

def tax_country_accounting_code
  @tax_country_accounting_code
end

#tax_county ⇒ Object

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



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

def tax_county
  @tax_county
end

#tax_county_accounting_code ⇒ Object

QuickBooks tax county code



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

def tax_county_accounting_code
  @tax_county_accounting_code
end

#tax_gift_charge ⇒ Object

True if gift charge is taxed



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

def tax_gift_charge
  @tax_gift_charge
end

#tax_postal_code_accounting_code ⇒ Object

QuickBooks tax postal code code



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

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.



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

def tax_rate
  @tax_rate
end

#tax_rate_city ⇒ Object

Tax rate at the city level



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

def tax_rate_city
  @tax_rate_city
end

#tax_rate_country ⇒ Object

Tax rate at the country level



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

def tax_rate_country
  @tax_rate_country
end

#tax_rate_county ⇒ Object

Tax rate at the county level



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

def tax_rate_county
  @tax_rate_county
end

#tax_rate_postal_code ⇒ Object

Tax rate at the postal code level



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

def tax_rate_postal_code
  @tax_rate_postal_code
end

#tax_rate_state ⇒ Object

Tax rate at the state level



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

def tax_rate_state
  @tax_rate_state
end

#tax_shipping ⇒ Object

True if shipping is taxed



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

def tax_shipping
  @tax_shipping
end

#tax_state_accounting_code ⇒ Object

QuickBooks tax state code



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

def tax_state_accounting_code
  @tax_state_accounting_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.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



277
278
279
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 277

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



121
122
123
124
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 121

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 98

def self.openapi_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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 240

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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 308

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 379

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 284

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 270

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



212
213
214
215
216
217
218
219
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 212

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



355
356
357
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 355

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 361

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



349
350
351
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 349

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



223
224
225
226
 
# File 'lib/ultracart_api/models/order_taxes.rb', line 223

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