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.

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# 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

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.



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

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.



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

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.



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

def exclude_products_id
  @exclude_products_id
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.



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

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

#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

#valid_from_date ⇒ Object

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



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

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.



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

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



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

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.



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

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.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# 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) ⇒ 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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


162
163
164
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 162

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# 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 ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



132
133
134
135
 
# 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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 242

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



248
249
250
251
252
253
254
255
256
 
# 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



236
237
238
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 236

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



139
140
141
 
# File 'lib/square_connect/models/catalog_pricing_rule.rb', line 139

def valid?
  return true
end