class SquareConnect::ItemVariationLocationOverrides

Price and inventory alerting overrides for a [CatalogItemVariation](type-catalogitemvariation) at a specific [location](type-location).

Attributes

inventory_alert_threshold[RW]

If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer.

inventory_alert_type[RW]

Indicates whether the [CatalogItemVariation](type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](type-inventoryalerttype) for possible values

location_id[RW]

The ID of the [location](type-location).

price_money[RW]

The price of the [CatalogItemVariation](type-catalogitemvariation) at the given [location](type-location), or blank for variable pricing.

pricing_type[RW]

The pricing type (fixed or variable) for the [CatalogItemVariation](type-catalogitemvariation) at the given [location](type-location). See [CatalogPricingType](type-catalogpricingtype) for possible values

track_inventory[RW]

If `true`, inventory tracking is active for the [CatalogItemVariation](type-catalogitemvariation) at this [location](type-location).

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/item_variation_location_overrides.rb, line 35
def self.attribute_map
  {
    :'location_id' => :'location_id',
    :'price_money' => :'price_money',
    :'pricing_type' => :'pricing_type',
    :'track_inventory' => :'track_inventory',
    :'inventory_alert_type' => :'inventory_alert_type',
    :'inventory_alert_threshold' => :'inventory_alert_threshold'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/square_connect/models/item_variation_location_overrides.rb, line 60
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?(:'location_id')
    self.location_id = attributes[:'location_id']
  end

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/item_variation_location_overrides.rb, line 47
def self.swagger_types
  {
    :'location_id' => :'String',
    :'price_money' => :'Money',
    :'pricing_type' => :'String',
    :'track_inventory' => :'BOOLEAN',
    :'inventory_alert_type' => :'String',
    :'inventory_alert_threshold' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/square_connect/models/item_variation_location_overrides.rb, line 107
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      location_id == o.location_id &&
      price_money == o.price_money &&
      pricing_type == o.pricing_type &&
      track_inventory == o.track_inventory &&
      inventory_alert_type == o.inventory_alert_type &&
      inventory_alert_threshold == o.inventory_alert_threshold
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/square_connect/models/item_variation_location_overrides.rb, line 154
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 = SquareConnect.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/square_connect/models/item_variation_location_overrides.rb, line 220
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/square_connect/models/item_variation_location_overrides.rb, line 133
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 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/square_connect/models/item_variation_location_overrides.rb, line 120
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/square_connect/models/item_variation_location_overrides.rb, line 126
def hash
  [location_id, price_money, pricing_type, track_inventory, inventory_alert_type, inventory_alert_threshold].hash
end
list_invalid_properties() click to toggle source

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

# File lib/square_connect/models/item_variation_location_overrides.rb, line 94
def list_invalid_properties
  invalid_properties = Array.new
  return 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/square_connect/models/item_variation_location_overrides.rb, line 200
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/square_connect/models/item_variation_location_overrides.rb, line 206
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/square_connect/models/item_variation_location_overrides.rb, line 194
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/square_connect/models/item_variation_location_overrides.rb, line 101
def valid?
  return true
end