Class: VoucherifySdk::RedemptionRewardResult

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RedemptionRewardResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



140
141
142
143
144
145
146
147
148
149
150
151
152
153
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 140

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assignment_id ⇒ Object

Unique reward assignment ID assigned by Voucherify.



21
22
23
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 21

def assignment_id
  @assignment_id
end

#created_at ⇒ Object

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



42
43
44
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 42

def created_at
  @created_at
end

#customer ⇒ Object

Returns the value of attribute customer.



18
19
20
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 18

def customer
  @customer
end

#id ⇒ Object

Unique reward ID.



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

def id
  @id
end

#loyalty_tier_id ⇒ Object

Unique loyalty tier ID assigned by Voucherify.



30
31
32
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 30

def loyalty_tier_id
  @loyalty_tier_id
end

#metadata ⇒ Object

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



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

def metadata
  @metadata
end

#name ⇒ Object

Name of the reward.



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

def name
  @name
end

#object ⇒ Object

The type of the object represented by the JSON



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

def object
  @object
end

#parameters ⇒ Object

Returns the value of attribute parameters.



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

def parameters
  @parameters
end

#product ⇒ Object

Returns the value of attribute product.



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

def product
  @product
end

#sku ⇒ Object

Returns the value of attribute sku.



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

def sku
  @sku
end

#type ⇒ Object

Reward type.



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

def type
  @type
end

#updated_at ⇒ Object

Timestamp in ISO 8601 format indicating when the reward was updated.



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

def updated_at
  @updated_at
end

#voucher ⇒ Object

Returns the value of attribute voucher.



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

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



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

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



98
99
100
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 78

def self.attribute_map
  {
    :'customer' => :'customer',
    :'assignment_id' => :'assignment_id',
    :'voucher' => :'voucher',
    :'product' => :'product',
    :'sku' => :'sku',
    :'loyalty_tier_id' => :'loyalty_tier_id',
    :'id' => :'id',
    :'name' => :'name',
    :'object' => :'object',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'parameters' => :'parameters',
    :'metadata' => :'metadata',
    :'type' => :'type'
  }
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 260

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 123

def self.openapi_nullable
  Set.new([
    :'assignment_id',
    :'loyalty_tier_id',
    :'id',
    :'name',
    :'object',
    :'created_at',
    :'updated_at',
    :'parameters',
    :'metadata',
    :'type'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 103

def self.openapi_types
  {
    :'customer' => :'SimpleCustomer',
    :'assignment_id' => :'String',
    :'voucher' => :'Voucher',
    :'product' => :'Product',
    :'sku' => :'Sku',
    :'loyalty_tier_id' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'object' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'parameters' => :'RedemptionRewardResultParameters',
    :'metadata' => :'Object',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer == o.customer &&
      assignment_id == o.assignment_id &&
      voucher == o.voucher &&
      product == o.product &&
      sku == o.sku &&
      loyalty_tier_id == o.loyalty_tier_id &&
      id == o.id &&
      name == o.name &&
      object == o.object &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      parameters == o.parameters &&
      metadata == o.metadata &&
      type == o.type
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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 355

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


247
248
249
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 253

def hash
  [customer, assignment_id, voucher, product, sku, loyalty_tier_id, id, name, object, created_at, updated_at, parameters, metadata, type].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



207
208
209
210
211
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 207

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



331
332
333
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 331

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 337

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



325
326
327
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 325

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



215
216
217
218
219
220
221
222
 
# File 'lib/VoucherifySdk/models/redemption_reward_result.rb', line 215

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