class UltracartClient::TaxState

Attributes

accounting_code[RW]

Accounting code for programs such as QuickBooks

counties[RW]

Counties within this state

country_oid[RW]

Tax record object identifier used internally by database

dont_collect_city[RW]

Flag instructing engine to not collect city tax for this state

dont_collect_county[RW]

Flag instructing engine to not collect county tax for this state

dont_collect_postal_code[RW]

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

dont_collect_state[RW]

Flag instructing engine to not collect state tax for this state

state_code[RW]

State code

state_oid[RW]

Tax record object identifier used internally by database

tax_gift_charge[RW]

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

tax_gift_wrap[RW]

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

tax_rate[RW]

Tax Rate

tax_rate_formatted[RW]

Tax rate formatted

tax_shipping[RW]

True if taxation within this jurisdiction should charge tax on shipping

use_ultracart_managed_rates[RW]

If true, use UltraCart managed rates for this state

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/tax_state.rb, line 63
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',
    :'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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ultracart_api/models/tax_state.rb, line 106
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?(:'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
swagger_types() click to toggle source

Attribute type mapping.

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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ultracart_api/models/tax_state.rb, line 190
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 &&
      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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ultracart_api/models/tax_state.rb, line 246
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/ultracart_api/models/tax_state.rb, line 312
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ultracart_api/models/tax_state.rb, line 225
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ultracart_api/models/tax_state.rb, line 212
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/ultracart_api/models/tax_state.rb, line 218
def hash
  [accounting_code, counties, country_oid, dont_collect_city, dont_collect_county, dont_collect_postal_code, dont_collect_state, 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ultracart_api/models/tax_state.rb, line 177
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/tax_state.rb, line 292
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/tax_state.rb, line 298
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ultracart_api/models/tax_state.rb, line 286
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/ultracart_api/models/tax_state.rb, line 184
def valid?
  true
end