Class: SquareConnect::CatalogProductSet

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/catalog_product_set.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogProductSet

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# 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

Instance Attribute Details

#all_products ⇒ Object

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.



34
35
36
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 34

def all_products
  @all_products
end

#name ⇒ Object

User-defined name for the product set. For example, "Clearance Items" or "Winter Sale Items".



16
17
18
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 16

def name
  @name
end

#product_ids_all ⇒ Object

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.



22
23
24
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 22

def product_ids_all
  @product_ids_all
end

#product_ids_any ⇒ Object

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.



19
20
21
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 19

def product_ids_any
  @product_ids_any
end

#quantity_exact ⇒ Object

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`.



25
26
27
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 25

def quantity_exact
  @quantity_exact
end

#quantity_max ⇒ Object

If set, the pricing rule will apply to a maximum of this many items from ‘products_any` or `products_all`.



31
32
33
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 31

def quantity_max
  @quantity_max
end

#quantity_min ⇒ Object

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.



28
29
30
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 28

def quantity_min
  @quantity_min
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



120
121
122
123
124
125
126
127
128
129
130
 
# 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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# 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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# 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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


134
135
136
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 134

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# 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

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



107
108
109
110
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 107

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



214
215
216
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 214

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



220
221
222
223
224
225
226
227
228
 
# 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



208
209
210
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 208

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



114
115
116
 
# File 'lib/square_connect/models/catalog_product_set.rb', line 114

def valid?
  return true
end