Class: UltracartClient::TaxState

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaxState

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/ultracart_api/models/tax_state.rb', line 133

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

  if attributes.key?(:'counties')
    if (value = attributes[:'counties']).is_a?(Array)
      self.counties = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accounting_code ⇒ Object

Accounting code for programs such as QuickBooks



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

def accounting_code
  @accounting_code
end

#counties ⇒ Object

Counties within this state



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

def counties
  @counties
end

#country_oid ⇒ Object

Tax record object identifier used internally by database



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

def country_oid
  @country_oid
end

#dont_collect_city ⇒ Object

Flag instructing engine to not collect city tax for this state



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

def dont_collect_city
  @dont_collect_city
end

#dont_collect_county ⇒ Object

Flag instructing engine to not collect county tax for this state



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

def dont_collect_county
  @dont_collect_county
end

#dont_collect_postal_code ⇒ Object

Flag instructing engine to not collect postal code tax for this state



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

def dont_collect_postal_code
  @dont_collect_postal_code
end

#dont_collect_state ⇒ Object

Flag instructing engine to not collect state tax for this state



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

def dont_collect_state
  @dont_collect_state
end

#exempt_digital_items ⇒ Object

True if digital items are exempt from sales tax in this state.



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

def exempt_digital_items
  @exempt_digital_items
end

#exempt_physical_items ⇒ Object

True if physical items are exempt from sales tax in this state.



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

def exempt_physical_items
  @exempt_physical_items
end

#exempt_service_items ⇒ Object

True if service items are exempt from sales tax in this state.



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

def exempt_service_items
  @exempt_service_items
end

#state_code ⇒ Object

State code



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

def state_code
  @state_code
end

#state_oid ⇒ Object

Tax record object identifier used internally by database



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

def state_oid
  @state_oid
end

#tax_gift_charge ⇒ Object

True if taxation within this jurisdiction should charge tax on gift charge



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

def tax_gift_charge
  @tax_gift_charge
end

#tax_gift_wrap ⇒ Object

True if taxation within this jurisdiction should charge tax on gift wrap



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

def tax_gift_wrap
  @tax_gift_wrap
end

#tax_rate ⇒ Object

Tax Rate



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

def tax_rate
  @tax_rate
end

#tax_rate_formatted ⇒ Object

Tax rate formatted



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

def tax_rate_formatted
  @tax_rate_formatted
end

#tax_shipping ⇒ Object

True if taxation within this jurisdiction should charge tax on shipping



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

def tax_shipping
  @tax_shipping
end

#use_ultracart_managed_rates ⇒ Object

If true, use UltraCart managed rates for this state



70
71
72
 
# File 'lib/ultracart_api/models/tax_state.rb', line 70

def use_ultracart_managed_rates
  @use_ultracart_managed_rates
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/ultracart_api/models/tax_state.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ultracart_api/models/tax_state.rb', line 73

def self.attribute_map
  {
    :'accounting_code' => :'accounting_code',
    :'counties' => :'counties',
    :'country_oid' => :'country_oid',
    :'dont_collect_city' => :'dont_collect_city',
    :'dont_collect_county' => :'dont_collect_county',
    :'dont_collect_postal_code' => :'dont_collect_postal_code',
    :'dont_collect_state' => :'dont_collect_state',
    :'exempt_digital_items' => :'exempt_digital_items',
    :'exempt_physical_items' => :'exempt_physical_items',
    :'exempt_service_items' => :'exempt_service_items',
    :'state_code' => :'state_code',
    :'state_oid' => :'state_oid',
    :'tax_gift_charge' => :'tax_gift_charge',
    :'tax_gift_wrap' => :'tax_gift_wrap',
    :'tax_rate' => :'tax_rate',
    :'tax_rate_formatted' => :'tax_rate_formatted',
    :'tax_shipping' => :'tax_shipping',
    :'use_ultracart_managed_rates' => :'use_ultracart_managed_rates'
  }
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



274
275
276
 
# File 'lib/ultracart_api/models/tax_state.rb', line 274

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/ultracart_api/models/tax_state.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/ultracart_api/models/tax_state.rb', line 102

def self.openapi_types
  {
    :'accounting_code' => :'String',
    :'counties' => :'Array<TaxCounty>',
    :'country_oid' => :'Integer',
    :'dont_collect_city' => :'Boolean',
    :'dont_collect_county' => :'Boolean',
    :'dont_collect_postal_code' => :'Boolean',
    :'dont_collect_state' => :'Boolean',
    :'exempt_digital_items' => :'Boolean',
    :'exempt_physical_items' => :'Boolean',
    :'exempt_service_items' => :'Boolean',
    :'state_code' => :'String',
    :'state_oid' => :'Integer',
    :'tax_gift_charge' => :'Boolean',
    :'tax_gift_wrap' => :'Boolean',
    :'tax_rate' => :'Float',
    :'tax_rate_formatted' => :'String',
    :'tax_shipping' => :'Boolean',
    :'use_ultracart_managed_rates' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/ultracart_api/models/tax_state.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accounting_code == o.accounting_code &&
      counties == o.counties &&
      country_oid == o.country_oid &&
      dont_collect_city == o.dont_collect_city &&
      dont_collect_county == o.dont_collect_county &&
      dont_collect_postal_code == o.dont_collect_postal_code &&
      dont_collect_state == o.dont_collect_state &&
      exempt_digital_items == o.exempt_digital_items &&
      exempt_physical_items == o.exempt_physical_items &&
      exempt_service_items == o.exempt_service_items &&
      state_code == o.state_code &&
      state_oid == o.state_oid &&
      tax_gift_charge == o.tax_gift_charge &&
      tax_gift_wrap == o.tax_gift_wrap &&
      tax_rate == o.tax_rate &&
      tax_rate_formatted == o.tax_rate_formatted &&
      tax_shipping == o.tax_shipping &&
      use_ultracart_managed_rates == o.use_ultracart_managed_rates
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



305
306
307
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
 
# File 'lib/ultracart_api/models/tax_state.rb', line 305

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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/ultracart_api/models/tax_state.rb', line 376

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/ultracart_api/models/tax_state.rb', line 281

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


261
262
263
 
# File 'lib/ultracart_api/models/tax_state.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



267
268
269
 
# File 'lib/ultracart_api/models/tax_state.rb', line 267

def hash
  [accounting_code, counties, country_oid, dont_collect_city, dont_collect_county, dont_collect_postal_code, dont_collect_state, exempt_digital_items, exempt_physical_items, exempt_service_items, state_code, state_oid, tax_gift_charge, tax_gift_wrap, tax_rate, tax_rate_formatted, tax_shipping, use_ultracart_managed_rates].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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



352
353
354
 
# File 'lib/ultracart_api/models/tax_state.rb', line 352

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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/ultracart_api/models/tax_state.rb', line 358

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



346
347
348
 
# File 'lib/ultracart_api/models/tax_state.rb', line 346

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



230
231
232
 
# File 'lib/ultracart_api/models/tax_state.rb', line 230

def valid?
  true
end