Class: VoucherifySdk::Redemption

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

Overview

This is an object representing a redemption for POST ‘v1/redemptions` and POST `/client/v1/redemptions`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Redemption

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 191

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction.



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

def amount
  @amount
end

#channel ⇒ Object

Returns the value of attribute channel.



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

def channel
  @channel
end

#customer ⇒ Object

Returns the value of attribute customer.



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

def customer
  @customer
end

#customer_id ⇒ Object

Unique customer ID of the redeeming customer.



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

def customer_id
  @customer_id
end

#date ⇒ Object

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



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

def date
  @date
end

#failure_code ⇒ Object

If the result is ‘FAILURE`, this parameter will provide a generic reason as to why the redemption failed.



52
53
54
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 52

def failure_code
  @failure_code
end

#failure_message ⇒ Object

If the result is ‘FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed.



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

def failure_message
  @failure_message
end

#gift ⇒ Object

Returns the value of attribute gift.



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

def gift
  @gift
end

#id ⇒ Object

Unique redemption ID.



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

def id
  @id
end

#loyalty_card ⇒ Object

Returns the value of attribute loyalty_card.



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

def loyalty_card
  @loyalty_card
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the redemption.



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

def metadata
  @metadata
end

#object ⇒ Object

The type of the object represented by the JSON



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

def object
  @object
end

#order ⇒ Object

Returns the value of attribute order.



57
58
59
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 57

def order
  @order
end

#promotion_tier ⇒ Object

Returns the value of attribute promotion_tier.



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

def promotion_tier
  @promotion_tier
end

#redemption ⇒ Object

Unique redemption ID of the parent redemption.



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

def redemption
  @redemption
end

#related_object_id ⇒ Object

Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.



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

def related_object_id
  @related_object_id
end

#related_object_type ⇒ Object

Defines the related object.



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

def related_object_type
  @related_object_type
end

#related_redemptions ⇒ Object

Returns the value of attribute related_redemptions.



49
50
51
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 49

def related_redemptions
  @related_redemptions
end

#result ⇒ Object

Redemption result.



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

def result
  @result
end

#reward ⇒ Object

Returns the value of attribute reward.



71
72
73
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 71

def reward
  @reward
end

#status ⇒ Object

Redemption status.



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

def status
  @status
end

#tracking_id ⇒ Object

Hashed customer source ID.



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

def tracking_id
  @tracking_id
end

#voucher ⇒ Object

Returns the value of attribute voucher.



77
78
79
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 77

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



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
413
414
415
416
417
418
419
420
421
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 384

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



131
132
133
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 131

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 102

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'date' => :'date',
    :'customer_id' => :'customer_id',
    :'tracking_id' => :'tracking_id',
    :'metadata' => :'metadata',
    :'amount' => :'amount',
    :'redemption' => :'redemption',
    :'result' => :'result',
    :'status' => :'status',
    :'related_redemptions' => :'related_redemptions',
    :'failure_code' => :'failure_code',
    :'failure_message' => :'failure_message',
    :'order' => :'order',
    :'channel' => :'channel',
    :'customer' => :'customer',
    :'related_object_type' => :'related_object_type',
    :'related_object_id' => :'related_object_id',
    :'promotion_tier' => :'promotion_tier',
    :'reward' => :'reward',
    :'gift' => :'gift',
    :'loyalty_card' => :'loyalty_card',
    :'voucher' => :'voucher'
  }
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



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 360

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 165

def self.openapi_nullable
  Set.new([
    :'id',
    :'object',
    :'date',
    :'customer_id',
    :'tracking_id',
    :'metadata',
    :'amount',
    :'redemption',
    :'result',
    :'status',
    :'related_redemptions',
    :'failure_code',
    :'failure_message',
    :'channel',
    :'related_object_type',
    :'related_object_id',
    :'gift',
    :'loyalty_card',
    :'voucher'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'date' => :'Time',
    :'customer_id' => :'String',
    :'tracking_id' => :'String',
    :'metadata' => :'Object',
    :'amount' => :'Integer',
    :'redemption' => :'String',
    :'result' => :'String',
    :'status' => :'String',
    :'related_redemptions' => :'RedemptionRelatedRedemptions',
    :'failure_code' => :'String',
    :'failure_message' => :'String',
    :'order' => :'OrderCalculated',
    :'channel' => :'RedemptionChannel',
    :'customer' => :'SimpleCustomer',
    :'related_object_type' => :'String',
    :'related_object_id' => :'String',
    :'promotion_tier' => :'PromotionTier',
    :'reward' => :'RedemptionRewardResult',
    :'gift' => :'RedemptionGift',
    :'loyalty_card' => :'RedemptionLoyaltyCard',
    :'voucher' => :'RedemptionVoucher'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      date == o.date &&
      customer_id == o.customer_id &&
      tracking_id == o.tracking_id &&
      metadata == o.metadata &&
      amount == o.amount &&
      redemption == o.redemption &&
      result == o.result &&
      status == o.status &&
      related_redemptions == o.related_redemptions &&
      failure_code == o.failure_code &&
      failure_message == o.failure_message &&
      order == o.order &&
      channel == o.channel &&
      customer == o.customer &&
      related_object_type == o.related_object_type &&
      related_object_id == o.related_object_id &&
      promotion_tier == o.promotion_tier &&
      reward == o.reward &&
      gift == o.gift &&
      loyalty_card == o.loyalty_card &&
      voucher == o.voucher
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



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 455

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


347
348
349
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 347

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



353
354
355
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 353

def hash
  [id, object, date, customer_id, tracking_id, metadata, amount, redemption, result, status, related_redemptions, failure_code, failure_message, order, channel, customer, related_object_type, related_object_id, promotion_tier, reward, gift, loyalty_card, voucher].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



294
295
296
297
298
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 294

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



431
432
433
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 431

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



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

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



425
426
427
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 425

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



302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/VoucherifySdk/models/redemption.rb', line 302

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["redemption"])
  return false unless object_validator.valid?(@object)
  result_validator = EnumAttributeValidator.new('String', ["SUCCESS", "FAILURE"])
  return false unless result_validator.valid?(@result)
  status_validator = EnumAttributeValidator.new('String', ["SUCCEEDED", "FAILED", "ROLLED_BACK"])
  return false unless status_validator.valid?(@status)
  related_object_type_validator = EnumAttributeValidator.new('String', ["voucher", "promotion_tier", "redemption"])
  return false unless related_object_type_validator.valid?(@related_object_type)
  true
end