class UltracartClient::ItemTaxExemption

Attributes

city[RW]

City

country_code[RW]

Country code (ISO-3166 two letter)

county[RW]

County

postal_code[RW]

Postal code

state_code[RW]

State code

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/item_tax_exemption.rb, line 33
def self.attribute_map
  {
    :'city' => :'city',
    :'country_code' => :'country_code',
    :'county' => :'county',
    :'postal_code' => :'postal_code',
    :'state_code' => :'state_code'
  }
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/item_tax_exemption.rb, line 56
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?(:'city')
    self.city = attributes[:'city']
  end

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

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

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

  if attributes.has_key?(:'state_code')
    self.state_code = attributes[:'state_code']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/item_tax_exemption.rb, line 44
def self.swagger_types
  {
    :'city' => :'String',
    :'country_code' => :'String',
    :'county' => :'String',
    :'postal_code' => :'String',
    :'state_code' => :'String'
  }
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/item_tax_exemption.rb, line 173
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      city == o.city &&
      country_code == o.country_code &&
      county == o.county &&
      postal_code == o.postal_code &&
      state_code == o.state_code
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/item_tax_exemption.rb, line 219
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/item_tax_exemption.rb, line 285
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/item_tax_exemption.rb, line 198
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
city=(city) click to toggle source

Custom attribute writer method with validation @param [Object] city Value to be assigned

# File lib/ultracart_api/models/item_tax_exemption.rb, line 123
def city=(city)
  if !city.nil? && city.to_s.length > 32
    fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 32.'
  end

  @city = city
end
country_code=(country_code) click to toggle source

Custom attribute writer method with validation @param [Object] country_code Value to be assigned

# File lib/ultracart_api/models/item_tax_exemption.rb, line 133
def country_code=(country_code)
  if !country_code.nil? && country_code.to_s.length > 2
    fail ArgumentError, 'invalid value for "country_code", the character length must be smaller than or equal to 2.'
  end

  @country_code = country_code
end
county=(county) click to toggle source

Custom attribute writer method with validation @param [Object] county Value to be assigned

# File lib/ultracart_api/models/item_tax_exemption.rb, line 143
def county=(county)
  if !county.nil? && county.to_s.length > 32
    fail ArgumentError, 'invalid value for "county", the character length must be smaller than or equal to 32.'
  end

  @county = county
end
eql?(o) click to toggle source

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

# File lib/ultracart_api/models/item_tax_exemption.rb, line 185
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/item_tax_exemption.rb, line 191
def hash
  [city, country_code, county, postal_code, state_code].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/item_tax_exemption.rb, line 85
def list_invalid_properties
  invalid_properties = Array.new
  if !@city.nil? && @city.to_s.length > 32
    invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 32.')
  end

  if !@country_code.nil? && @country_code.to_s.length > 2
    invalid_properties.push('invalid value for "country_code", the character length must be smaller than or equal to 2.')
  end

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

  if !@postal_code.nil? && @postal_code.to_s.length > 20
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 20.')
  end

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

  invalid_properties
end
postal_code=(postal_code) click to toggle source

Custom attribute writer method with validation @param [Object] postal_code Value to be assigned

# File lib/ultracart_api/models/item_tax_exemption.rb, line 153
def postal_code=(postal_code)
  if !postal_code.nil? && postal_code.to_s.length > 20
    fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 20.'
  end

  @postal_code = postal_code
end
state_code=(state_code) click to toggle source

Custom attribute writer method with validation @param [Object] state_code Value to be assigned

# File lib/ultracart_api/models/item_tax_exemption.rb, line 163
def state_code=(state_code)
  if !state_code.nil? && state_code.to_s.length > 32
    fail ArgumentError, 'invalid value for "state_code", the character length must be smaller than or equal to 32.'
  end

  @state_code = state_code
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/item_tax_exemption.rb, line 265
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/item_tax_exemption.rb, line 271
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/item_tax_exemption.rb, line 259
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/item_tax_exemption.rb, line 112
def valid?
  return false if !@city.nil? && @city.to_s.length > 32
  return false if !@country_code.nil? && @country_code.to_s.length > 2
  return false if !@county.nil? && @county.to_s.length > 32
  return false if !@postal_code.nil? && @postal_code.to_s.length > 20
  return false if !@state_code.nil? && @state_code.to_s.length > 32
  true
end