Class: VoucherifySdk::Voucher

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

Overview

This is an object representing a voucher.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Voucher

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
254
255
256
257
258
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 208

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::Voucher` 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::Voucher`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'voucher'
  end

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

A flag to toggle the voucher on or off. You can disable a voucher even though it’s within the active period defined by the ‘start_date` and `expiration_date`. - `true` indicates an active voucher - `false` indicates an inactive voucher



61
62
63
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 61

def active
  @active
end

#additional_info ⇒ Object

An optional field to keep any extra textual information about the code such as a code description and details.



64
65
66
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 64

def additional_info
  @additional_info
end

#assets ⇒ Object

Returns the value of attribute assets.



69
70
71
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 69

def assets
  @assets
end

#campaign ⇒ Object

A unique campaign name, identifies the voucher’s parent campaign.



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

def campaign
  @campaign
end

#campaign_id ⇒ Object

Assigned by the Voucherify API, identifies the voucher’s parent campaign.



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

def campaign_id
  @campaign_id
end

#categories ⇒ Object

Contains details about the category.



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

def categories
  @categories
end

#category ⇒ Object

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.



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

def category
  @category
end

#category_id ⇒ Object

Unique category ID assigned by Voucherify.



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

def category_id
  @category_id
end

#code ⇒ Object

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.



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

def code
  @code
end

#created_at ⇒ Object

Timestamp representing the date and time when the voucher was created in ISO 8601 format.



75
76
77
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 75

def created_at
  @created_at
end

#deleted ⇒ Object

Flag indicating whether this voucher is deleted.



91
92
93
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 91

def deleted
  @deleted
end

#discount ⇒ Object

Returns the value of attribute discount.



43
44
45
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 43

def discount
  @discount
end

#distributions ⇒ Object

Returns the value of attribute distributions.



88
89
90
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 88

def distributions
  @distributions
end

#expiration_date ⇒ Object

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is *inactive after* this date.



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

def expiration_date
  @expiration_date
end

#gift ⇒ Object

Returns the value of attribute gift.



45
46
47
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 45

def gift
  @gift
end

#holder ⇒ Object

Returns the value of attribute holder.



83
84
85
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 83

def holder
  @holder
end

#holder_id ⇒ Object

Unique customer ID of voucher owner.



81
82
83
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 81

def holder_id
  @holder_id
end

#id ⇒ Object

Assigned by the Voucherify API, identifies the voucher.



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

def id
  @id
end

#is_referral_code ⇒ Object

Flag indicating whether this voucher is a referral code; ‘true` for campaign type `REFERRAL_PROGRAM`.



72
73
74
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 72

def is_referral_code
  @is_referral_code
end

#loyalty_card ⇒ Object

Returns the value of attribute loyalty_card.



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

def loyalty_card
  @loyalty_card
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.



67
68
69
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 67

def metadata
  @metadata
end

#object ⇒ Object

The type of object represented by JSON. Default is ‘voucher`.



86
87
88
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 86

def object
  @object
end

#publish ⇒ Object

Returns the value of attribute publish.



95
96
97
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 95

def publish
  @publish
end

#redemption ⇒ Object

Returns the value of attribute redemption.



97
98
99
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 97

def redemption
  @redemption
end

#start_date ⇒ Object

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is *inactive before* this date.



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

def start_date
  @start_date
end

#type ⇒ Object

Defines the type of the voucher.



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

def type
  @type
end

#updated_at ⇒ Object

Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.



78
79
80
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 78

def updated_at
  @updated_at
end

#validation_rules_assignments ⇒ Object

Returns the value of attribute validation_rules_assignments.



93
94
95
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 93

def validation_rules_assignments
  @validation_rules_assignments
end

#validity_day_of_week ⇒ Object

Integer array corresponding to the particular days of the week in which the voucher is valid. - ‘0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday



58
59
60
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 58

def validity_day_of_week
  @validity_day_of_week
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



55
56
57
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 55

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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 453

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



158
159
160
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 158

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 122

def self.attribute_map
  {
    :'id' => :'id',
    :'code' => :'code',
    :'campaign' => :'campaign',
    :'campaign_id' => :'campaign_id',
    :'category' => :'category',
    :'category_id' => :'category_id',
    :'categories' => :'categories',
    :'type' => :'type',
    :'discount' => :'discount',
    :'gift' => :'gift',
    :'loyalty_card' => :'loyalty_card',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'active' => :'active',
    :'additional_info' => :'additional_info',
    :'metadata' => :'metadata',
    :'assets' => :'assets',
    :'is_referral_code' => :'is_referral_code',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'holder_id' => :'holder_id',
    :'holder' => :'holder',
    :'object' => :'object',
    :'distributions' => :'distributions',
    :'deleted' => :'deleted',
    :'validation_rules_assignments' => :'validation_rules_assignments',
    :'publish' => :'publish',
    :'redemption' => :'redemption'
  }
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



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 429

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



199
200
201
202
203
204
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 199

def self.openapi_nullable
  Set.new([
    :'active',
    :'is_referral_code',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 163

def self.openapi_types
  {
    :'id' => :'String',
    :'code' => :'String',
    :'campaign' => :'String',
    :'campaign_id' => :'String',
    :'category' => :'String',
    :'category_id' => :'String',
    :'categories' => :'Array<Category>',
    :'type' => :'String',
    :'discount' => :'Discount',
    :'gift' => :'VoucherGift',
    :'loyalty_card' => :'VoucherLoyaltyCard',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'VoucherValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'active' => :'Boolean',
    :'additional_info' => :'String',
    :'metadata' => :'Object',
    :'assets' => :'VoucherAssets',
    :'is_referral_code' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'holder_id' => :'String',
    :'holder' => :'SimpleCustomer',
    :'object' => :'String',
    :'distributions' => :'Array<Object>',
    :'deleted' => :'Boolean',
    :'validation_rules_assignments' => :'ValidationRulesAssignmentsList',
    :'publish' => :'VoucherPublish',
    :'redemption' => :'VoucherRedemption'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 379

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      code == o.code &&
      campaign == o.campaign &&
      campaign_id == o.campaign_id &&
      category == o.category &&
      category_id == o.category_id &&
      categories == o.categories &&
      type == o.type &&
      discount == o.discount &&
      gift == o.gift &&
      loyalty_card == o.loyalty_card &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      validity_timeframe == o.validity_timeframe &&
      validity_day_of_week == o.validity_day_of_week &&
      active == o.active &&
      additional_info == o.additional_info &&
      metadata == o.metadata &&
      assets == o.assets &&
      is_referral_code == o.is_referral_code &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      holder_id == o.holder_id &&
      holder == o.holder &&
      object == o.object &&
      distributions == o.distributions &&
      deleted == o.deleted &&
      validation_rules_assignments == o.validation_rules_assignments &&
      publish == o.publish &&
      redemption == o.redemption
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



524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 524

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


416
417
418
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 416

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



422
423
424
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 422

def hash
  [id, code, campaign, campaign_id, category, category_id, categories, type, discount, gift, loyalty_card, start_date, expiration_date, validity_timeframe, validity_day_of_week, active, additional_info, metadata, assets, is_referral_code, created_at, updated_at, holder_id, holder, object, distributions, deleted, validation_rules_assignments, publish, redemption].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



352
353
354
355
356
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 352

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



500
501
502
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 500

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



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 506

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



494
495
496
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 494

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



360
361
362
363
364
365
 
# File 'lib/VoucherifySdk/models/voucher.rb', line 360

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["GIFT_VOUCHER", "DISCOUNT_VOUCHER", "LOYALTY_CARD"])
  return false unless type_validator.valid?(@type)
  true
end