Class: VoucherifySdk::StackingRules

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/stacking_rules.rb

Overview

Defines stacking rules for redeemables. Read more in the [Help Center](support.voucherify.io/article/604-stacking-rules)

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StackingRules

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
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
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::StackingRules` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `VoucherifySdk::StackingRules`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'redeemables_limit')
    self.redeemables_limit = attributes[:'redeemables_limit']
  else
    self.redeemables_limit = 30
  end

  if attributes.key?(:'applicable_redeemables_limit')
    self.applicable_redeemables_limit = attributes[:'applicable_redeemables_limit']
  else
    self.applicable_redeemables_limit = 5
  end

  if attributes.key?(:'applicable_exclusive_redeemables_limit')
    self.applicable_exclusive_redeemables_limit = attributes[:'applicable_exclusive_redeemables_limit']
  else
    self.applicable_exclusive_redeemables_limit = 1
  end

  if attributes.key?(:'applicable_redeemables_per_category_limit')
    self.applicable_redeemables_per_category_limit = attributes[:'applicable_redeemables_per_category_limit']
  else
    self.applicable_redeemables_per_category_limit = 1
  end

  if attributes.key?(:'exclusive_categories')
    if (value = attributes[:'exclusive_categories']).is_a?(Array)
      self.exclusive_categories = value
    end
  else
    self.exclusive_categories = nil
  end

  if attributes.key?(:'joint_categories')
    if (value = attributes[:'joint_categories']).is_a?(Array)
      self.joint_categories = value
    end
  else
    self.joint_categories = nil
  end

  if attributes.key?(:'redeemables_application_mode')
    self.redeemables_application_mode = attributes[:'redeemables_application_mode']
  end

  if attributes.key?(:'redeemables_sorting_rule')
    self.redeemables_sorting_rule = attributes[:'redeemables_sorting_rule']
  else
    self.redeemables_sorting_rule = 'REQUESTED_ORDER'
  end
end

Instance Attribute Details

#applicable_exclusive_redeemables_limit ⇒ Object

Defines how many redeemables with an exclusive category can be applied in one request.



26
27
28
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 26

def applicable_exclusive_redeemables_limit
  @applicable_exclusive_redeemables_limit
end

#applicable_redeemables_limit ⇒ Object

Defines how many of the sent redeemables will be applied to the order. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be labelled as SKIPPED.



23
24
25
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 23

def applicable_redeemables_limit
  @applicable_redeemables_limit
end

#applicable_redeemables_per_category_limit ⇒ Object

Defines how many redeemables per category can be applied in one request.



29
30
31
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 29

def applicable_redeemables_per_category_limit
  @applicable_redeemables_per_category_limit
end

#exclusive_categories ⇒ Object

Lists all exclusive categories. A redeemable from a campaign with an exclusive category is the only redeemable to be redeemed when applied with redeemables from other campaigns unless these campaigns are exclusive or joint.



32
33
34
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 32

def exclusive_categories
  @exclusive_categories
end

#joint_categories ⇒ Object

Lists all joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns.



35
36
37
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 35

def joint_categories
  @joint_categories
end

#redeemables_application_mode ⇒ Object

Defines redeemables application mode.



38
39
40
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 38

def redeemables_application_mode
  @redeemables_application_mode
end

#redeemables_limit ⇒ Object

Defines how many redeemables can be sent in one stacking request (note: more redeemables means more processing time!).



20
21
22
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 20

def redeemables_limit
  @redeemables_limit
end

#redeemables_sorting_rule ⇒ Object

Defines redeemables sorting rule.



41
42
43
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 41

def redeemables_sorting_rule
  @redeemables_sorting_rule
end

Class Method Details

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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 400

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = VoucherifySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 66

def self.attribute_map
  {
    :'redeemables_limit' => :'redeemables_limit',
    :'applicable_redeemables_limit' => :'applicable_redeemables_limit',
    :'applicable_exclusive_redeemables_limit' => :'applicable_exclusive_redeemables_limit',
    :'applicable_redeemables_per_category_limit' => :'applicable_redeemables_per_category_limit',
    :'exclusive_categories' => :'exclusive_categories',
    :'joint_categories' => :'joint_categories',
    :'redeemables_application_mode' => :'redeemables_application_mode',
    :'redeemables_sorting_rule' => :'redeemables_sorting_rule'
  }
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



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 376

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 99

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 85

def self.openapi_types
  {
    :'redeemables_limit' => :'Integer',
    :'applicable_redeemables_limit' => :'Integer',
    :'applicable_exclusive_redeemables_limit' => :'Integer',
    :'applicable_redeemables_per_category_limit' => :'Integer',
    :'exclusive_categories' => :'Array<String>',
    :'joint_categories' => :'Array<String>',
    :'redeemables_application_mode' => :'String',
    :'redeemables_sorting_rule' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 348

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      redeemables_limit == o.redeemables_limit &&
      applicable_redeemables_limit == o.applicable_redeemables_limit &&
      applicable_exclusive_redeemables_limit == o.applicable_exclusive_redeemables_limit &&
      applicable_redeemables_per_category_limit == o.applicable_redeemables_per_category_limit &&
      exclusive_categories == o.exclusive_categories &&
      joint_categories == o.joint_categories &&
      redeemables_application_mode == o.redeemables_application_mode &&
      redeemables_sorting_rule == o.redeemables_sorting_rule
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



471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 471

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


363
364
365
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 363

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



369
370
371
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 369

def hash
  [redeemables_limit, applicable_redeemables_limit, applicable_exclusive_redeemables_limit, applicable_redeemables_per_category_limit, exclusive_categories, joint_categories, redeemables_application_mode, redeemables_sorting_rule].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 172

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @redeemables_limit.nil?
    invalid_properties.push('invalid value for "redeemables_limit", redeemables_limit cannot be nil.')
  end

  if @redeemables_limit > 30
    invalid_properties.push('invalid value for "redeemables_limit", must be smaller than or equal to 30.')
  end

  if @redeemables_limit < 1
    invalid_properties.push('invalid value for "redeemables_limit", must be greater than or equal to 1.')
  end

  if @applicable_redeemables_limit.nil?
    invalid_properties.push('invalid value for "applicable_redeemables_limit", applicable_redeemables_limit cannot be nil.')
  end

  if @applicable_redeemables_limit > 30
    invalid_properties.push('invalid value for "applicable_redeemables_limit", must be smaller than or equal to 30.')
  end

  if @applicable_redeemables_limit < 1
    invalid_properties.push('invalid value for "applicable_redeemables_limit", must be greater than or equal to 1.')
  end

  if @applicable_exclusive_redeemables_limit.nil?
    invalid_properties.push('invalid value for "applicable_exclusive_redeemables_limit", applicable_exclusive_redeemables_limit cannot be nil.')
  end

  if @applicable_exclusive_redeemables_limit > 30
    invalid_properties.push('invalid value for "applicable_exclusive_redeemables_limit", must be smaller than or equal to 30.')
  end

  if @applicable_exclusive_redeemables_limit < 1
    invalid_properties.push('invalid value for "applicable_exclusive_redeemables_limit", must be greater than or equal to 1.')
  end

  if !@applicable_redeemables_per_category_limit.nil? && @applicable_redeemables_per_category_limit > 30
    invalid_properties.push('invalid value for "applicable_redeemables_per_category_limit", must be smaller than or equal to 30.')
  end

  if !@applicable_redeemables_per_category_limit.nil? && @applicable_redeemables_per_category_limit < 1
    invalid_properties.push('invalid value for "applicable_redeemables_per_category_limit", must be greater than or equal to 1.')
  end

  if @exclusive_categories.nil?
    invalid_properties.push('invalid value for "exclusive_categories", exclusive_categories cannot be nil.')
  end

  if @joint_categories.nil?
    invalid_properties.push('invalid value for "joint_categories", joint_categories cannot be nil.')
  end

  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



447
448
449
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 447

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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 453

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



441
442
443
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 441

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/VoucherifySdk/models/stacking_rules.rb', line 232

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @redeemables_limit.nil?
  return false if @redeemables_limit > 30
  return false if @redeemables_limit < 1
  return false if @applicable_redeemables_limit.nil?
  return false if @applicable_redeemables_limit > 30
  return false if @applicable_redeemables_limit < 1
  return false if @applicable_exclusive_redeemables_limit.nil?
  return false if @applicable_exclusive_redeemables_limit > 30
  return false if @applicable_exclusive_redeemables_limit < 1
  return false if !@applicable_redeemables_per_category_limit.nil? && @applicable_redeemables_per_category_limit > 30
  return false if !@applicable_redeemables_per_category_limit.nil? && @applicable_redeemables_per_category_limit < 1
  return false if @exclusive_categories.nil?
  return false if @joint_categories.nil?
  redeemables_application_mode_validator = EnumAttributeValidator.new('String', ["ALL", "PARTIAL"])
  return false unless redeemables_application_mode_validator.valid?(@redeemables_application_mode)
  redeemables_sorting_rule_validator = EnumAttributeValidator.new('String', ["CATEGORY_HIERARCHY", "REQUESTED_ORDER"])
  return false unless redeemables_sorting_rule_validator.valid?(@redeemables_sorting_rule)
  true
end