Class: VoucherifySdk::ManagementProjectsStackingRulesGetResponseBody

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

Overview

Response body schema for GET ‘/management/v1/projects/projectId/stacking-rules/stackingRulesId`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementProjectsStackingRulesGetResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



156
157
158
159
160
161
162
163
164
165
166
167
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
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
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 156

def initialize(attributes = {})
  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'discounted_amount_mode_categories')
    if (value = attributes[:'discounted_amount_mode_categories']).is_a?(Array)
      self.discounted_amount_mode_categories = value
    end
  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']
  end

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

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

Instance Attribute Details

#applicable_exclusive_redeemables_limit ⇒ Object

Defines how many redeemables with an assigned exclusive category can be applied at the same time.



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

def applicable_exclusive_redeemables_limit
  @applicable_exclusive_redeemables_limit
end

#applicable_exclusive_redeemables_per_category_limit ⇒ Object

Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to ‘"applicable_exclusive_redeemables_limit"`.



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

def applicable_exclusive_redeemables_per_category_limit
  @applicable_exclusive_redeemables_per_category_limit
end

#applicable_redeemables_limit ⇒ Object

Defines how many redeemables can be applied at the same time. The number must be less than or equal to ‘"redeemables_limit"`.



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

def applicable_redeemables_limit
  @applicable_redeemables_limit
end

#applicable_redeemables_per_category_limit ⇒ Object

Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to ‘"applicable_redeemables_limit"`.



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

def applicable_redeemables_per_category_limit
  @applicable_redeemables_per_category_limit
end

#created_at ⇒ Object

Timestamp representing the date and time when the stacking rules were created. The value for this parameter is shown in the ISO 8601 format.



59
60
61
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 59

def created_at
  @created_at
end

#discount_calculation_mode ⇒ Object

Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.



44
45
46
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 44

def discount_calculation_mode
  @discount_calculation_mode
end

#discounted_amount_mode_categories ⇒ Object

Lists the IDs of the categories that apply a discount based on the discounted amount.



50
51
52
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 50

def discounted_amount_mode_categories
  @discounted_amount_mode_categories
end

#exclusive_categories ⇒ Object

Lists the IDs of the categories that are exclusive.



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

def exclusive_categories
  @exclusive_categories
end

#id ⇒ Object

The unique identifier of the stacking rules.



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

def id
  @id
end

#initial_amount_mode_categories ⇒ Object

Lists the IDs of the categories that apply a discount based on the initial amount.



47
48
49
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 47

def initial_amount_mode_categories
  @initial_amount_mode_categories
end

#joint_categories ⇒ Object

Lists the IDs of the categories that are joint.



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

def joint_categories
  @joint_categories
end

#redeemables_application_mode ⇒ Object

Defines the application mode for redeemables. ‘"ALL"` means that all redeemables must be validated for the redemption to be successful. `"PARTIAL"` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped.



53
54
55
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 53

def redeemables_application_mode
  @redeemables_application_mode
end

#redeemables_limit ⇒ Object

Defines how many redeemables can be sent to Voucherify for validation at the same time.



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

def redeemables_limit
  @redeemables_limit
end

#redeemables_sorting_rule ⇒ Object

Defines the sorting rule for redeemables. ‘"CATEGORY_HIERARCHY"` means that redeemables are applied with the order established by the hierarchy of the categories. `"REQUESTED_ORDER"` means that redeemables are applied with the order established in the request.



56
57
58
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 56

def redeemables_sorting_rule
  @redeemables_sorting_rule
end

#updated_at ⇒ Object

Timestamp representing the date and time when the stacking rules were updated. The value for this parameter is shown in the ISO 8601 format.



62
63
64
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 62

def updated_at
  @updated_at
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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 338

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



108
109
110
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 108

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 87

def self.attribute_map
  {
    :'id' => :'id',
    :'exclusive_categories' => :'exclusive_categories',
    :'joint_categories' => :'joint_categories',
    :'redeemables_limit' => :'redeemables_limit',
    :'applicable_redeemables_limit' => :'applicable_redeemables_limit',
    :'applicable_redeemables_per_category_limit' => :'applicable_redeemables_per_category_limit',
    :'applicable_exclusive_redeemables_limit' => :'applicable_exclusive_redeemables_limit',
    :'applicable_exclusive_redeemables_per_category_limit' => :'applicable_exclusive_redeemables_per_category_limit',
    :'discount_calculation_mode' => :'discount_calculation_mode',
    :'initial_amount_mode_categories' => :'initial_amount_mode_categories',
    :'discounted_amount_mode_categories' => :'discounted_amount_mode_categories',
    :'redeemables_application_mode' => :'redeemables_application_mode',
    :'redeemables_sorting_rule' => :'redeemables_sorting_rule',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 314

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 134

def self.openapi_nullable
  Set.new([
    :'id',
    :'exclusive_categories',
    :'joint_categories',
    :'redeemables_limit',
    :'applicable_redeemables_limit',
    :'applicable_redeemables_per_category_limit',
    :'applicable_exclusive_redeemables_limit',
    :'applicable_exclusive_redeemables_per_category_limit',
    :'discount_calculation_mode',
    :'initial_amount_mode_categories',
    :'discounted_amount_mode_categories',
    :'redeemables_application_mode',
    :'redeemables_sorting_rule',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 113

def self.openapi_types
  {
    :'id' => :'String',
    :'exclusive_categories' => :'Array<String>',
    :'joint_categories' => :'Array<String>',
    :'redeemables_limit' => :'Integer',
    :'applicable_redeemables_limit' => :'Integer',
    :'applicable_redeemables_per_category_limit' => :'Integer',
    :'applicable_exclusive_redeemables_limit' => :'Integer',
    :'applicable_exclusive_redeemables_per_category_limit' => :'Integer',
    :'discount_calculation_mode' => :'String',
    :'initial_amount_mode_categories' => :'Array<String>',
    :'discounted_amount_mode_categories' => :'Array<String>',
    :'redeemables_application_mode' => :'String',
    :'redeemables_sorting_rule' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 279

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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 409

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


301
302
303
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



307
308
309
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 307

def hash
  [id, exclusive_categories, joint_categories, redeemables_limit, applicable_redeemables_limit, applicable_redeemables_per_category_limit, applicable_exclusive_redeemables_limit, applicable_exclusive_redeemables_per_category_limit, discount_calculation_mode, initial_amount_mode_categories, discounted_amount_mode_categories, redeemables_application_mode, redeemables_sorting_rule, created_at, updated_at].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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 233

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@redeemables_limit.nil? && @redeemables_limit > 30
    invalid_properties.push('invalid value for "redeemables_limit", must be smaller than or equal to 30.')
  end

  if !@redeemables_limit.nil? && @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? && @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? && @applicable_exclusive_redeemables_limit > 5
    invalid_properties.push('invalid value for "applicable_exclusive_redeemables_limit", must be smaller than or equal to 5.')
  end

  if !@applicable_exclusive_redeemables_limit.nil? && @applicable_exclusive_redeemables_limit < 1
    invalid_properties.push('invalid value for "applicable_exclusive_redeemables_limit", must be greater than or equal to 1.')
  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



385
386
387
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 385

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 391

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



379
380
381
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 379

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/VoucherifySdk/models/management_projects_stacking_rules_get_response_body.rb', line 261

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@redeemables_limit.nil? && @redeemables_limit > 30
  return false if !@redeemables_limit.nil? && @redeemables_limit < 1
  return false if !@applicable_redeemables_limit.nil? && @applicable_redeemables_limit < 1
  return false if !@applicable_exclusive_redeemables_limit.nil? && @applicable_exclusive_redeemables_limit > 5
  return false if !@applicable_exclusive_redeemables_limit.nil? && @applicable_exclusive_redeemables_limit < 1
  discount_calculation_mode_validator = EnumAttributeValidator.new('String', ["INITIAL_AMOUNT", "DISCOUNTED_AMOUNT"])
  return false unless discount_calculation_mode_validator.valid?(@discount_calculation_mode)
  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