Class: VoucherifySdk::ApplicableTo

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicableTo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 170

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

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

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

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

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

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

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

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

  if attributes.key?(:'effect')
    self.effect = attributes[:'effect']
  else
    self.effect = nil
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aggregated_amount_limit ⇒ Object

Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - ‘APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value)



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

def aggregated_amount_limit
  @aggregated_amount_limit
end

#aggregated_quantity_limit ⇒ Object

The maximum number of units allowed to be discounted combined across all matched order line items.



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

def aggregated_quantity_limit
  @aggregated_quantity_limit
end

#amount_limit ⇒ Object

Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.



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

def amount_limit
  @amount_limit
end

#effect ⇒ Object

Returns the value of attribute effect.



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

def effect
  @effect
end

#id ⇒ Object

Unique product collection, product, or SKU identifier assigned by Voucherify.



22
23
24
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 22

def id
  @id
end

#object ⇒ Object

This object stores information about the resource to which the discount is applicable.



19
20
21
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 19

def object
  @object
end

#order_item_indices ⇒ Object

Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the ‘order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on.



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

def order_item_indices
  @order_item_indices
end

#order_item_units ⇒ Object

Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the ‘index` corresponds to the order line sent in the `order` object in the request.



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

def order_item_units
  @order_item_units
end

#price ⇒ Object

New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price.



36
37
38
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 36

def price
  @price
end

#price_formula ⇒ Object

Formula used to calculate the discounted price of an item.



39
40
41
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 39

def price_formula
  @price_formula
end

#product_id ⇒ Object

Parent product’s unique ID assigned by Voucherify.



28
29
30
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 28

def product_id
  @product_id
end

#product_source_id ⇒ Object

Parent product’s source ID from your inventory system.



31
32
33
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 31

def product_source_id
  @product_source_id
end

#quantity_limit ⇒ Object

The maximum number of units allowed to be discounted per order line item.



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

def quantity_limit
  @quantity_limit
end

#repeat ⇒ Object

Determines the recurrence of the discount, e.g. ‘"repeat": 3` means that the discount is applied to every third item.



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

def repeat
  @repeat
end

#skip_initially ⇒ Object

Determines how many items are skipped before the discount is applied.



65
66
67
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 65

def skip_initially
  @skip_initially
end

#source_id ⇒ Object

The source identifier from your inventory system.



25
26
27
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 25

def source_id
  @source_id
end

#strict ⇒ Object

Returns the value of attribute strict.



33
34
35
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 33

def strict
  @strict
end

#target ⇒ Object

Determines to which kinds of objects the discount is applicable. ‘ITEM` includes products and SKUs. `UNIT` means particular units within an order line.



68
69
70
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 68

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



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
376
377
378
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 341

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



117
118
119
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 117

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 93

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'source_id' => :'source_id',
    :'product_id' => :'product_id',
    :'product_source_id' => :'product_source_id',
    :'strict' => :'strict',
    :'price' => :'price',
    :'price_formula' => :'price_formula',
    :'effect' => :'effect',
    :'quantity_limit' => :'quantity_limit',
    :'aggregated_quantity_limit' => :'aggregated_quantity_limit',
    :'amount_limit' => :'amount_limit',
    :'aggregated_amount_limit' => :'aggregated_amount_limit',
    :'order_item_indices' => :'order_item_indices',
    :'order_item_units' => :'order_item_units',
    :'repeat' => :'repeat',
    :'skip_initially' => :'skip_initially',
    :'target' => :'target'
  }
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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 317

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 146

def self.openapi_nullable
  Set.new([
    :'object',
    :'id',
    :'source_id',
    :'product_id',
    :'product_source_id',
    :'strict',
    :'price',
    :'price_formula',
    :'quantity_limit',
    :'aggregated_quantity_limit',
    :'amount_limit',
    :'aggregated_amount_limit',
    :'order_item_indices',
    :'order_item_units',
    :'repeat',
    :'skip_initially',
    :'target'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 122

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'source_id' => :'String',
    :'product_id' => :'String',
    :'product_source_id' => :'String',
    :'strict' => :'Boolean',
    :'price' => :'Float',
    :'price_formula' => :'Float',
    :'effect' => :'ApplicableToEffect',
    :'quantity_limit' => :'Integer',
    :'aggregated_quantity_limit' => :'Integer',
    :'amount_limit' => :'Integer',
    :'aggregated_amount_limit' => :'Integer',
    :'order_item_indices' => :'Array<Integer>',
    :'order_item_units' => :'Array<ApplicableToOrderItemUnitsItem>',
    :'repeat' => :'Integer',
    :'skip_initially' => :'Integer',
    :'target' => :'String'
  }
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
298
299
300
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      source_id == o.source_id &&
      product_id == o.product_id &&
      product_source_id == o.product_source_id &&
      strict == o.strict &&
      price == o.price &&
      price_formula == o.price_formula &&
      effect == o.effect &&
      quantity_limit == o.quantity_limit &&
      aggregated_quantity_limit == o.aggregated_quantity_limit &&
      amount_limit == o.amount_limit &&
      aggregated_amount_limit == o.aggregated_amount_limit &&
      order_item_indices == o.order_item_indices &&
      order_item_units == o.order_item_units &&
      repeat == o.repeat &&
      skip_initially == o.skip_initially &&
      target == o.target
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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 412

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


304
305
306
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 304

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



310
311
312
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 310

def hash
  [object, id, source_id, product_id, product_source_id, strict, price, price_formula, effect, quantity_limit, aggregated_quantity_limit, amount_limit, aggregated_amount_limit, order_item_indices, order_item_units, repeat, skip_initially, target].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



257
258
259
260
261
262
263
264
265
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 257

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @effect.nil?
    invalid_properties.push('invalid value for "effect", effect 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



388
389
390
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 388

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 394

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



382
383
384
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 382

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



269
270
271
272
273
274
275
 
# File 'lib/VoucherifySdk/models/applicable_to.rb', line 269

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["product", "sku", "products_collection"])
  return false unless object_validator.valid?(@object)
  return false if @effect.nil?
  true
end