class SquareConnect::CatalogProductSet
Represents a collection of catalog objects for the purpose of applying a [PricingRule](type-pricingrule). Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations.
Attributes
If set to `true`, the product set will include every item in the catalog. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.
User-defined name for the product set. For example, "Clearance Items" or "Winter Sale Items".
Unique IDs for [CatalogObjects](type-catalogobject) to include in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.
Unique IDs for any [CatalogObjects](type-catalogobject)s to include in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent [CatalogProductSet](type-catalogproductset) to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs.
If set, there must be exactly this many items from `products_any` or `products_all` in the cart for the discount to apply. Cannot be combined with either `quantity_min` or `quantity_max`.
If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`.
If set, there must be at least this many items from `products_any` or `products_all` in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/catalog_product_set.rb, line 38 def self.attribute_map { :'name' => :'name', :'product_ids_any' => :'product_ids_any', :'product_ids_all' => :'product_ids_all', :'quantity_exact' => :'quantity_exact', :'quantity_min' => :'quantity_min', :'quantity_max' => :'quantity_max', :'all_products' => :'all_products' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/catalog_product_set.rb, line 65 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?(:'product_ids_any') if (value = attributes[:'product_ids_any']).is_a?(Array) self.product_ids_any = value end end if attributes.has_key?(:'product_ids_all') if (value = attributes[:'product_ids_all']).is_a?(Array) self.product_ids_all = value end end if attributes.has_key?(:'quantity_exact') self.quantity_exact = attributes[:'quantity_exact'] end if attributes.has_key?(:'quantity_min') self.quantity_min = attributes[:'quantity_min'] end if attributes.has_key?(:'quantity_max') self.quantity_max = attributes[:'quantity_max'] end if attributes.has_key?(:'all_products') self.all_products = attributes[:'all_products'] end end
Attribute type mapping.
# File lib/square_connect/models/catalog_product_set.rb, line 51 def self.swagger_types { :'name' => :'String', :'product_ids_any' => :'Array<String>', :'product_ids_all' => :'Array<String>', :'quantity_exact' => :'Integer', :'quantity_min' => :'Integer', :'quantity_max' => :'Integer', :'all_products' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/catalog_product_set.rb, line 120 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && product_ids_any == o.product_ids_any && product_ids_all == o.product_ids_all && quantity_exact == o.quantity_exact && quantity_min == o.quantity_min && quantity_max == o.quantity_max && all_products == o.all_products end
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_product_set.rb, line 168 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
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_product_set.rb, line 234 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
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_product_set.rb, line 147 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
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/catalog_product_set.rb, line 134 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/catalog_product_set.rb, line 140 def hash [name, product_ids_any, product_ids_all, quantity_exact, quantity_min, quantity_max, all_products].hash end
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_product_set.rb, line 107 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/catalog_product_set.rb, line 220 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/catalog_product_set.rb, line 208 def to_s to_hash.to_s end
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_product_set.rb, line 114 def valid? return true end