class SquareConnect::CatalogPricingRule

Defines how prices are modified or set for items that match the pricing rule during the active time period.

Attributes

apply_products_id[RW]

The [CatalogProductSet](type-catalogproductset) to apply the pricing rule to within the set of matched products specified by `match_products_id`. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products.

discount_id[RW]

Unique ID for the [CatalogDiscount](type-catalogdiscount) to take off the price of all matched items. Only one of `total_price_money`, `item_price`, or `discount` can be supplied.

exclude_products_id[RW]

Identifies the [CatalogProductSet](type-catalogproductset) to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.

match_products_id[RW]

Unique ID for the [CatalogProductSet](type-catalogproductset) that will be matched by this rule. A match rule matches within the entire cart.

name[RW]

User-defined name for the pricing rule. For example, "Buy one get one free" or "10% off".

time_period_ids[RW]

Unique ID for the [CatalogTimePeriod](type-catalogtimeperiod)s when this pricing rule is in effect. If left unset, the pricing rule is always in effect.

valid_from_date[RW]

Represents the date the Pricing Rule is valid from. Represented in RFC3339 full-date format (YYYY-MM-DD).

valid_from_local_time[RW]

Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.

valid_until_date[RW]

Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD).

valid_until_local_time[RW]

Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/catalog_pricing_rule.rb, line 47
def self.attribute_map
  {
    :'name' => :'name',
    :'time_period_ids' => :'time_period_ids',
    :'discount_id' => :'discount_id',
    :'match_products_id' => :'match_products_id',
    :'apply_products_id' => :'apply_products_id',
    :'exclude_products_id' => :'exclude_products_id',
    :'valid_from_date' => :'valid_from_date',
    :'valid_from_local_time' => :'valid_from_local_time',
    :'valid_until_date' => :'valid_until_date',
    :'valid_until_local_time' => :'valid_until_local_time'
  }
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/catalog_pricing_rule.rb, line 80
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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'time_period_ids')
    if (value = attributes[:'time_period_ids']).is_a?(Array)
      self.time_period_ids = value
    end
  end

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/catalog_pricing_rule.rb, line 63
def self.swagger_types
  {
    :'name' => :'String',
    :'time_period_ids' => :'Array<String>',
    :'discount_id' => :'String',
    :'match_products_id' => :'String',
    :'apply_products_id' => :'String',
    :'exclude_products_id' => :'String',
    :'valid_from_date' => :'String',
    :'valid_from_local_time' => :'String',
    :'valid_until_date' => :'String',
    :'valid_until_local_time' => :'String'
  }
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/catalog_pricing_rule.rb, line 145
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      time_period_ids == o.time_period_ids &&
      discount_id == o.discount_id &&
      match_products_id == o.match_products_id &&
      apply_products_id == o.apply_products_id &&
      exclude_products_id == o.exclude_products_id &&
      valid_from_date == o.valid_from_date &&
      valid_from_local_time == o.valid_from_local_time &&
      valid_until_date == o.valid_until_date &&
      valid_until_local_time == o.valid_until_local_time
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/catalog_pricing_rule.rb, line 196
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/catalog_pricing_rule.rb, line 262
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/catalog_pricing_rule.rb, line 175
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/catalog_pricing_rule.rb, line 162
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/catalog_pricing_rule.rb, line 168
def hash
  [name, time_period_ids, discount_id, match_products_id, apply_products_id, exclude_products_id, valid_from_date, valid_from_local_time, valid_until_date, valid_until_local_time].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/catalog_pricing_rule.rb, line 132
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/catalog_pricing_rule.rb, line 242
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/catalog_pricing_rule.rb, line 248
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/catalog_pricing_rule.rb, line 236
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/catalog_pricing_rule.rb, line 139
def valid?
  return true
end