class UltracartClient::AvalaraConfig

Attributes

account_id[RW]

Avalara account ID

active[RW]

True if Avalara is active for this merchant

avalara_oid[RW]

Unique identifier for this avalara config object

company_id[RW]

Avalara company ID

enable_upc[RW]

True if this Avalara configuration is set to enable tax valuation by UPC

estimate_only[RW]

True if this Avalara configuration is to estimate taxes only and not report placed orders to Avalara

guest_customer_code[RW]

Optional customer code for customers without profiles, defaults to GuestCustomer

last_test_dts[RW]

Date/time of the connection test to Avalara

license_key[RW]

Avalara license key

sandbox[RW]

True if this Avalara instance is pointed at the Avalara Sandbox

send_test_orders[RW]

Send test orders through to Avalara. The default is to not transmit test orders to Avalara.

service_url[RW]

Avalara service URL

test_results[RW]

Test results of the last connection test to Avalara

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/avalara_config.rb, line 57
def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'active' => :'active',
    :'avalara_oid' => :'avalara_oid',
    :'company_id' => :'company_id',
    :'enable_upc' => :'enable_upc',
    :'estimate_only' => :'estimate_only',
    :'guest_customer_code' => :'guest_customer_code',
    :'last_test_dts' => :'last_test_dts',
    :'license_key' => :'license_key',
    :'sandbox' => :'sandbox',
    :'send_test_orders' => :'send_test_orders',
    :'service_url' => :'service_url',
    :'test_results' => :'test_results'
  }
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/avalara_config.rb, line 96
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?(:'account_id')
    self.account_id = attributes[:'account_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/avalara_config.rb, line 76
def self.swagger_types
  {
    :'account_id' => :'String',
    :'active' => :'BOOLEAN',
    :'avalara_oid' => :'Integer',
    :'company_id' => :'String',
    :'enable_upc' => :'BOOLEAN',
    :'estimate_only' => :'BOOLEAN',
    :'guest_customer_code' => :'String',
    :'last_test_dts' => :'String',
    :'license_key' => :'String',
    :'sandbox' => :'BOOLEAN',
    :'send_test_orders' => :'BOOLEAN',
    :'service_url' => :'String',
    :'test_results' => :'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/avalara_config.rb, line 170
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      account_id == o.account_id &&
      active == o.active &&
      avalara_oid == o.avalara_oid &&
      company_id == o.company_id &&
      enable_upc == o.enable_upc &&
      estimate_only == o.estimate_only &&
      guest_customer_code == o.guest_customer_code &&
      last_test_dts == o.last_test_dts &&
      license_key == o.license_key &&
      sandbox == o.sandbox &&
      send_test_orders == o.send_test_orders &&
      service_url == o.service_url &&
      test_results == o.test_results
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/avalara_config.rb, line 224
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/avalara_config.rb, line 290
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/avalara_config.rb, line 203
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/avalara_config.rb, line 190
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/avalara_config.rb, line 196
def hash
  [account_id, active, avalara_oid, company_id, enable_upc, estimate_only, guest_customer_code, last_test_dts, license_key, sandbox, send_test_orders, service_url, test_results].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/avalara_config.rb, line 157
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/avalara_config.rb, line 270
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/avalara_config.rb, line 276
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/avalara_config.rb, line 264
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/avalara_config.rb, line 164
def valid?
  true
end