Class: VoucherifySdk::RedemptionInternal

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

Overview

Model Used for internal communication

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RedemptionInternal

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items’ amounts.



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

def amount
  @amount
end

#campaign_name ⇒ Object

Campaign name



87
88
89
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 87

def campaign_name
  @campaign_name
end

#channel_id ⇒ Object

Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard or an X-APP-Id of a user using the API.



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

def channel_id
  @channel_id
end

#channel_type ⇒ Object

The source of the channel for the redemption rollback. A ‘USER` corresponds to the Voucherify Dashboard and an `API` corresponds to the API.



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

def channel_type
  @channel_type
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#customer ⇒ Object

Returns the value of attribute customer.



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

def customer
  @customer
end

#customer_id ⇒ Object

Unique customer ID of the redeeming customer.



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

def customer_id
  @customer_id
end

#failure_code ⇒ Object

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



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

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.



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

def failure_message
  @failure_message
end

#id ⇒ Object

Unique redemption ID.



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

def id
  @id
end

#metadata ⇒ Object

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



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

def metadata
  @metadata
end

#object ⇒ Object

The type of object represented by the JSON. This object stores information about the ‘redemption`.



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

def object
  @object
end

#order ⇒ Object

Returns the value of attribute order.



46
47
48
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 46

def order
  @order
end

#parent_redemption_id ⇒ Object

Unique redemption ID of the parent redemption.



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

def parent_redemption_id
  @parent_redemption_id
end

#previous_order ⇒ Object

Returns the value of attribute previous_order.



48
49
50
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 48

def previous_order
  @previous_order
end

#promotion_tier ⇒ Object

Returns the value of attribute promotion_tier.



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

def promotion_tier
  @promotion_tier
end

#reason ⇒ Object

System generated cause for the redemption being invalid in the context of the provided parameters.



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

def reason
  @reason
end

#redemption ⇒ Object

Unique redemption ID of the parent redemption.



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

def redemption
  @redemption
end

#related_object_id ⇒ Object

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



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

def related_object_id
  @related_object_id
end

#related_object_parent_id ⇒ Object

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



84
85
86
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 84

def related_object_parent_id
  @related_object_parent_id
end

#related_object_type ⇒ Object

Defines the related object.



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

def related_object_type
  @related_object_type
end

#related_redemptions ⇒ Object

Returns the value of attribute related_redemptions.



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

def related_redemptions
  @related_redemptions
end

#result ⇒ Object

Redemption result.



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

def result
  @result
end

#reward ⇒ Object

Returns the value of attribute reward.



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

def reward
  @reward
end

#status ⇒ Object

Redemption status.



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

def status
  @status
end

#tracking_id ⇒ Object

Hashed customer source ID.



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

def tracking_id
  @tracking_id
end

#voucher ⇒ Object

Returns the value of attribute voucher.



89
90
91
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 89

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



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
491
492
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 455

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



149
150
151
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 149

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



116
117
118
119
120
121
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
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 116

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'created_at' => :'created_at',
    :'tracking_id' => :'tracking_id',
    :'metadata' => :'metadata',
    :'channel_type' => :'channel_type',
    :'channel_id' => :'channel_id',
    :'failure_code' => :'failure_code',
    :'failure_message' => :'failure_message',
    :'order' => :'order',
    :'previous_order' => :'previous_order',
    :'reward' => :'reward',
    :'amount' => :'amount',
    :'reason' => :'reason',
    :'result' => :'result',
    :'status' => :'status',
    :'related_redemptions' => :'related_redemptions',
    :'parent_redemption_id' => :'parent_redemption_id',
    :'redemption' => :'redemption',
    :'customer' => :'customer',
    :'customer_id' => :'customer_id',
    :'related_object_type' => :'related_object_type',
    :'related_object_id' => :'related_object_id',
    :'related_object_parent_id' => :'related_object_parent_id',
    :'campaign_name' => :'campaign_name',
    :'voucher' => :'voucher',
    :'promotion_tier' => :'promotion_tier'
  }
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



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

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



187
188
189
190
191
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 187

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

.openapi_types ⇒ Object

Attribute type mapping.



154
155
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
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 154

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'created_at' => :'Time',
    :'tracking_id' => :'String',
    :'metadata' => :'Object',
    :'channel_type' => :'String',
    :'channel_id' => :'String',
    :'failure_code' => :'String',
    :'failure_message' => :'String',
    :'order' => :'OrderCalculated',
    :'previous_order' => :'OrderCalculated',
    :'reward' => :'RedemptionRewardResult',
    :'amount' => :'Integer',
    :'reason' => :'String',
    :'result' => :'String',
    :'status' => :'String',
    :'related_redemptions' => :'RedemptionInternalRelatedRedemptions',
    :'parent_redemption_id' => :'String',
    :'redemption' => :'String',
    :'customer' => :'SimpleCustomer',
    :'customer_id' => :'String',
    :'related_object_type' => :'String',
    :'related_object_id' => :'String',
    :'related_object_parent_id' => :'String',
    :'campaign_name' => :'String',
    :'voucher' => :'Voucher',
    :'promotion_tier' => :'PromotionTier'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      created_at == o.created_at &&
      tracking_id == o.tracking_id &&
      metadata == o.metadata &&
      channel_type == o.channel_type &&
      channel_id == o.channel_id &&
      failure_code == o.failure_code &&
      failure_message == o.failure_message &&
      order == o.order &&
      previous_order == o.previous_order &&
      reward == o.reward &&
      amount == o.amount &&
      reason == o.reason &&
      result == o.result &&
      status == o.status &&
      related_redemptions == o.related_redemptions &&
      parent_redemption_id == o.parent_redemption_id &&
      redemption == o.redemption &&
      customer == o.customer &&
      customer_id == o.customer_id &&
      related_object_type == o.related_object_type &&
      related_object_id == o.related_object_id &&
      related_object_parent_id == o.related_object_parent_id &&
      campaign_name == o.campaign_name &&
      voucher == o.voucher &&
      promotion_tier == o.promotion_tier
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



526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 526

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


418
419
420
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 418

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



424
425
426
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 424

def hash
  [id, object, created_at, tracking_id, metadata, channel_type, channel_id, failure_code, failure_message, order, previous_order, reward, amount, reason, result, status, related_redemptions, parent_redemption_id, redemption, customer, customer_id, related_object_type, related_object_id, related_object_parent_id, campaign_name, voucher, promotion_tier].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



321
322
323
324
325
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 321

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



502
503
504
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 502

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



508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 508

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



496
497
498
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 496

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



329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/VoucherifySdk/models/redemption_internal.rb', line 329

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