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



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
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/ultracart_api/models/tax_state.rb', line 121

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?(:'accounting_code')
    self.accounting_code = attributes[:'accounting_code']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

def accounting_code
  @accounting_code
end

#counties ⇒ Object

Counties within this state



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

def counties
  @counties
end

#country_oid ⇒ Object

Tax record object identifier used internally by database



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

def country_oid
  @country_oid
end

#dont_collect_city ⇒ Object

Flag instructing engine to not collect city tax for this state



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

def dont_collect_city
  @dont_collect_city
end

#dont_collect_county ⇒ Object

Flag instructing engine to not collect county tax for this state



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

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



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

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



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

def dont_collect_state
  @dont_collect_state
end

#exempt_digital_items ⇒ Object

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



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

def exempt_digital_items
  @exempt_digital_items
end

#exempt_physical_items ⇒ Object

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



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

def exempt_physical_items
  @exempt_physical_items
end

#exempt_service_items ⇒ Object

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



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

def exempt_service_items
  @exempt_service_items
end

#state_code ⇒ Object

State code



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

def state_code
  @state_code
end

#state_oid ⇒ Object

Tax record object identifier used internally by database



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

def state_oid
  @state_oid
end

#tax_gift_charge ⇒ Object

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



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

def tax_gift_charge
  @tax_gift_charge
end

#tax_gift_wrap ⇒ Object

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



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

def tax_gift_wrap
  @tax_gift_wrap
end

#tax_rate ⇒ Object

Tax Rate



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

def tax_rate
  @tax_rate
end

#tax_rate_formatted ⇒ Object

Tax rate formatted



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

def tax_rate_formatted
  @tax_rate_formatted
end

#tax_shipping ⇒ Object

True if taxation within this jurisdiction should charge tax on shipping



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

def tax_shipping
  @tax_shipping
end

#use_ultracart_managed_rates ⇒ Object

If true, use UltraCart managed rates for this state



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

def use_ultracart_managed_rates
  @use_ultracart_managed_rates
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/ultracart_api/models/tax_state.rb', line 217

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



276
277
278
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
 
# File 'lib/ultracart_api/models/tax_state.rb', line 276

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/ultracart_api/models/tax_state.rb', line 342

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/ultracart_api/models/tax_state.rb', line 255

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


242
243
244
 
# File 'lib/ultracart_api/models/tax_state.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



248
249
250
 
# File 'lib/ultracart_api/models/tax_state.rb', line 248

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



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

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



322
323
324
 
# File 'lib/ultracart_api/models/tax_state.rb', line 322

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



328
329
330
331
332
333
334
335
336
 
# File 'lib/ultracart_api/models/tax_state.rb', line 328

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



316
317
318
 
# File 'lib/ultracart_api/models/tax_state.rb', line 316

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



211
212
213
 
# File 'lib/ultracart_api/models/tax_state.rb', line 211

def valid?
  true
end