Class: VoucherifySdk::SimpleVoucher

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

Overview

Simplified voucher data.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SimpleVoucher

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

  if attributes.key?(:'referrer_id')
    self.referrer_id = attributes[:'referrer_id']
  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?(:'active')
    self.active = attributes[:'active']
  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?(:'redemption')
    self.redemption = attributes[:'redemption']
  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?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

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

Instance Attribute Details

#active ⇒ Object

Shows whether the voucher is on or off. ‘true` indicates an active voucher and `false` indicates an inactive voucher.



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

def active
  @active
end

#campaign ⇒ Object

Campaign name.



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

def campaign
  @campaign
end

#campaign_id ⇒ Object

Campaign unique ID.



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

def campaign_id
  @campaign_id
end

#categories ⇒ Object

Contains details about the category.



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

def categories
  @categories
end

#category_id ⇒ Object

Unique identifier of the category that this voucher belongs to.



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

def category_id
  @category_id
end

#code ⇒ Object

Voucher code.



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

def code
  @code
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#discount ⇒ Object

Returns the value of attribute discount.



27
28
29
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 27

def discount
  @discount
end

#expiration_date ⇒ Object

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



70
71
72
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 70

def expiration_date
  @expiration_date
end

#gift ⇒ Object

Returns the value of attribute gift.



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

def gift
  @gift
end

#holder_id ⇒ Object

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.



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

def holder_id
  @holder_id
end

#id ⇒ Object

A unique identifier that represents the voucher assigned by Voucherify.



20
21
22
 
# File 'lib/VoucherifySdk/models/simple_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`.



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

def is_referral_code
  @is_referral_code
end

#loyalty_card ⇒ Object

Returns the value of attribute loyalty_card.



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

def loyalty_card
  @loyalty_card
end

#metadata ⇒ Object

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.



73
74
75
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 73

def metadata
  @metadata
end

#object ⇒ Object

The type of the object represented by JSON.



76
77
78
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 76

def object
  @object
end

#redemption ⇒ Object

Returns the value of attribute redemption.



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

def redemption
  @redemption
end

#referrer_id ⇒ Object

Unique identifier of the referrer assigned by Voucherify.



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

def referrer_id
  @referrer_id
end

#start_date ⇒ Object

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



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

def start_date
  @start_date
end

#type ⇒ Object

Type of the voucher.



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

def type
  @type
end

#updated_at ⇒ Object

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.



62
63
64
 
# File 'lib/VoucherifySdk/models/simple_voucher.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



366
367
368
369
370
371
372
373
374
375
376
377
378
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
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 366

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



128
129
130
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 128

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'code' => :'code',
    :'gift' => :'gift',
    :'discount' => :'discount',
    :'loyalty_card' => :'loyalty_card',
    :'type' => :'type',
    :'campaign' => :'campaign',
    :'campaign_id' => :'campaign_id',
    :'is_referral_code' => :'is_referral_code',
    :'holder_id' => :'holder_id',
    :'referrer_id' => :'referrer_id',
    :'category_id' => :'category_id',
    :'categories' => :'categories',
    :'active' => :'active',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'redemption' => :'redemption',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'metadata' => :'metadata',
    :'object' => :'object'
  }
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 342

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 160

def self.openapi_nullable
  Set.new([
    :'id',
    :'code',
    :'type',
    :'campaign',
    :'campaign_id',
    :'is_referral_code',
    :'holder_id',
    :'referrer_id',
    :'category_id',
    :'categories',
    :'active',
    :'created_at',
    :'updated_at',
    :'redemption',
    :'start_date',
    :'expiration_date',
    :'metadata',
    :'object'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'code' => :'String',
    :'gift' => :'Gift',
    :'discount' => :'Discount',
    :'loyalty_card' => :'SimpleLoyaltyCard',
    :'type' => :'String',
    :'campaign' => :'String',
    :'campaign_id' => :'String',
    :'is_referral_code' => :'Boolean',
    :'holder_id' => :'String',
    :'referrer_id' => :'String',
    :'category_id' => :'String',
    :'categories' => :'Array<Category>',
    :'active' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'redemption' => :'SimpleVoucherRedemption',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'metadata' => :'Object',
    :'object' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      code == o.code &&
      gift == o.gift &&
      discount == o.discount &&
      loyalty_card == o.loyalty_card &&
      type == o.type &&
      campaign == o.campaign &&
      campaign_id == o.campaign_id &&
      is_referral_code == o.is_referral_code &&
      holder_id == o.holder_id &&
      referrer_id == o.referrer_id &&
      category_id == o.category_id &&
      categories == o.categories &&
      active == o.active &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      redemption == o.redemption &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      metadata == o.metadata &&
      object == o.object
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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 437

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


329
330
331
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 335

def hash
  [id, code, gift, discount, loyalty_card, type, campaign, campaign_id, is_referral_code, holder_id, referrer_id, category_id, categories, active, created_at, updated_at, redemption, start_date, expiration_date, metadata, object].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



282
283
284
285
286
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 282

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



413
414
415
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 419

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



407
408
409
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 407

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



290
291
292
293
294
295
296
297
 
# File 'lib/VoucherifySdk/models/simple_voucher.rb', line 290

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