Class: SquareConnect::CatalogPricingRule

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

Overview

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogPricingRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 116

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?(:'total_price_money')
    self.total_price_money = attributes[:'total_price_money']
  end

  if attributes.has_key?(:'item_price_money')
    self.item_price_money = attributes[:'item_price_money']
  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?(:'stackable')
    self.stackable = attributes[:'stackable']
  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

Instance Attribute Details

#apply_products_id ⇒ Object

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.



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

def apply_products_id
  @apply_products_id
end

#discount_id ⇒ Object

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.



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

def discount_id
  @discount_id
end

#exclude_products_id ⇒ Object

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.



40
41
42
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 40

def exclude_products_id
  @exclude_products_id
end

#item_price_money ⇒ Object

The amount of money to charge for each matched item. Only one of ‘total_price_money`, `item_price`, or `discount` can be supplied.



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

def item_price_money
  @item_price_money
end

#match_products_id ⇒ Object

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



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

def match_products_id
  @match_products_id
end

#name ⇒ Object

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



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

def name
  @name
end

#stackable ⇒ Object

Describes how the pricing rule can be combined with other pricing rules. See [Stackable](#type-stackable) for all possible values. See [AggregationStrategy](#type-aggregationstrategy) for possible values



37
38
39
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 37

def stackable
  @stackable
end

#time_period_ids ⇒ Object

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.



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

def time_period_ids
  @time_period_ids
end

#total_price_money ⇒ Object

The total amount of money to charge for all matched items. Only one of ‘total_price_money`, `item_price`, or `discount` can be supplied.



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

def total_price_money
  @total_price_money
end

#valid_from_date ⇒ Object

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



43
44
45
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 43

def valid_from_date
  @valid_from_date
end

#valid_from_local_time ⇒ Object

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.



46
47
48
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 46

def valid_from_local_time
  @valid_from_local_time
end

#valid_until_date ⇒ Object

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



49
50
51
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 49

def valid_until_date
  @valid_until_date
end

#valid_until_local_time ⇒ Object

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.



52
53
54
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 52

def valid_until_local_time
  @valid_until_local_time
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 77

def self.attribute_map
  {
    :'name' => :'name',
    :'time_period_ids' => :'time_period_ids',
    :'total_price_money' => :'total_price_money',
    :'item_price_money' => :'item_price_money',
    :'discount_id' => :'discount_id',
    :'match_products_id' => :'match_products_id',
    :'apply_products_id' => :'apply_products_id',
    :'stackable' => :'stackable',
    :'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

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 96

def self.swagger_types
  {
    :'name' => :'String',
    :'time_period_ids' => :'Array<String>',
    :'total_price_money' => :'Money',
    :'item_price_money' => :'Money',
    :'discount_id' => :'String',
    :'match_products_id' => :'String',
    :'apply_products_id' => :'String',
    :'stackable' => :'String',
    :'exclude_products_id' => :'String',
    :'valid_from_date' => :'String',
    :'valid_from_local_time' => :'String',
    :'valid_until_date' => :'String',
    :'valid_until_local_time' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      time_period_ids == o.time_period_ids &&
      total_price_money == o.total_price_money &&
      item_price_money == o.item_price_money &&
      discount_id == o.discount_id &&
      match_products_id == o.match_products_id &&
      apply_products_id == o.apply_products_id &&
      stackable == o.stackable &&
      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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 259

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 325

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 238

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


225
226
227
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 231

def hash
  [name, time_period_ids, total_price_money, item_price_money, discount_id, match_products_id, apply_products_id, stackable, exclude_products_id, valid_from_date, valid_from_local_time, valid_until_date, valid_until_local_time].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



180
181
182
183
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 180

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



305
306
307
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 305

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



311
312
313
314
315
316
317
318
319
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 311

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



299
300
301
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 299

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



187
188
189
190
191
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 187

def valid?
  stackable_validator = EnumAttributeValidator.new('String', ["UNKNOWN", "BASE", "STACKABLE", "EXCLUSIVE"])
  return false unless stackable_validator.valid?(@stackable)
  return true
end