class UltracartClient::ItemPricing

Attributes

allow_arbitrary_cost[RW]

Allow arbitrary cost

arbitrary_cost_velocity_code[RW]

Arbitrary cost velocity code

auto_order_cost[RW]

Cost if customer selects to receive item on auto order. Set to zero to delete.

automatic_pricing_tier_name[RW]

Automatic pricing tier name

automatic_pricing_tier_oid[RW]

Automatic pricing tier object identifier

cogs[RW]

Cost of goods sold

cost[RW]

Cost

currency_code[RW]

Currency code

manufacturer_suggested_retail_price[RW]

Manufacturer suggested retail price

maximum_arbitrary_cost[RW]

Maximum arbitrary cost

minimum_advertised_price[RW]

Minimum advertised price

minimum_arbitrary_cost[RW]

Minimum arbitrary cost

mix_and_match_group[RW]

Mix and match group

mix_and_match_group_oid[RW]

Mix and match group object identifier

sale_cost[RW]

Sale cost

sale_end[RW]

Sale end

sale_start[RW]

Sale start

tiers[RW]

Tiers

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_pricing.rb, line 72
def self.attribute_map
  {
    :'allow_arbitrary_cost' => :'allow_arbitrary_cost',
    :'arbitrary_cost_velocity_code' => :'arbitrary_cost_velocity_code',
    :'auto_order_cost' => :'auto_order_cost',
    :'automatic_pricing_tier_name' => :'automatic_pricing_tier_name',
    :'automatic_pricing_tier_oid' => :'automatic_pricing_tier_oid',
    :'cogs' => :'cogs',
    :'cost' => :'cost',
    :'currency_code' => :'currency_code',
    :'manufacturer_suggested_retail_price' => :'manufacturer_suggested_retail_price',
    :'maximum_arbitrary_cost' => :'maximum_arbitrary_cost',
    :'minimum_advertised_price' => :'minimum_advertised_price',
    :'minimum_arbitrary_cost' => :'minimum_arbitrary_cost',
    :'mix_and_match_group' => :'mix_and_match_group',
    :'mix_and_match_group_oid' => :'mix_and_match_group_oid',
    :'sale_cost' => :'sale_cost',
    :'sale_end' => :'sale_end',
    :'sale_start' => :'sale_start',
    :'tiers' => :'tiers'
  }
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_pricing.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?(:'allow_arbitrary_cost')
    self.allow_arbitrary_cost = attributes[:'allow_arbitrary_cost']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'tiers')
    if (value = attributes[:'tiers']).is_a?(Array)
      self.tiers = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/item_pricing.rb, line 96
def self.swagger_types
  {
    :'allow_arbitrary_cost' => :'BOOLEAN',
    :'arbitrary_cost_velocity_code' => :'String',
    :'auto_order_cost' => :'Float',
    :'automatic_pricing_tier_name' => :'String',
    :'automatic_pricing_tier_oid' => :'Integer',
    :'cogs' => :'Float',
    :'cost' => :'Float',
    :'currency_code' => :'String',
    :'manufacturer_suggested_retail_price' => :'Float',
    :'maximum_arbitrary_cost' => :'Float',
    :'minimum_advertised_price' => :'Float',
    :'minimum_arbitrary_cost' => :'Float',
    :'mix_and_match_group' => :'String',
    :'mix_and_match_group_oid' => :'Integer',
    :'sale_cost' => :'Float',
    :'sale_end' => :'String',
    :'sale_start' => :'String',
    :'tiers' => :'Array<ItemPricingTier>'
  }
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_pricing.rb, line 247
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_arbitrary_cost == o.allow_arbitrary_cost &&
      arbitrary_cost_velocity_code == o.arbitrary_cost_velocity_code &&
      auto_order_cost == o.auto_order_cost &&
      automatic_pricing_tier_name == o.automatic_pricing_tier_name &&
      automatic_pricing_tier_oid == o.automatic_pricing_tier_oid &&
      cogs == o.cogs &&
      cost == o.cost &&
      currency_code == o.currency_code &&
      manufacturer_suggested_retail_price == o.manufacturer_suggested_retail_price &&
      maximum_arbitrary_cost == o.maximum_arbitrary_cost &&
      minimum_advertised_price == o.minimum_advertised_price &&
      minimum_arbitrary_cost == o.minimum_arbitrary_cost &&
      mix_and_match_group == o.mix_and_match_group &&
      mix_and_match_group_oid == o.mix_and_match_group_oid &&
      sale_cost == o.sale_cost &&
      sale_end == o.sale_end &&
      sale_start == o.sale_start &&
      tiers == o.tiers
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_pricing.rb, line 306
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_pricing.rb, line 372
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
arbitrary_cost_velocity_code=(arbitrary_cost_velocity_code) click to toggle source

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

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

  @arbitrary_cost_velocity_code = arbitrary_cost_velocity_code
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_pricing.rb, line 285
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
currency_code=(currency_code) click to toggle source

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

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

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

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

# File lib/ultracart_api/models/item_pricing.rb, line 272
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_pricing.rb, line 278
def hash
  [allow_arbitrary_cost, arbitrary_cost_velocity_code, auto_order_cost, automatic_pricing_tier_name, automatic_pricing_tier_oid, cogs, cost, currency_code, manufacturer_suggested_retail_price, maximum_arbitrary_cost, minimum_advertised_price, minimum_arbitrary_cost, mix_and_match_group, mix_and_match_group_oid, sale_cost, sale_end, sale_start, tiers].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_pricing.rb, line 204
def list_invalid_properties
  invalid_properties = Array.new
  if !@arbitrary_cost_velocity_code.nil? && @arbitrary_cost_velocity_code.to_s.length > 10000
    invalid_properties.push('invalid value for "arbitrary_cost_velocity_code", the character length must be smaller than or equal to 10000.')
  end

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

  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/item_pricing.rb, line 352
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_pricing.rb, line 358
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_pricing.rb, line 346
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_pricing.rb, line 219
def valid?
  return false if !@arbitrary_cost_velocity_code.nil? && @arbitrary_cost_velocity_code.to_s.length > 10000
  return false if !@currency_code.nil? && @currency_code.to_s.length > 3
  true
end