Class: VoucherifySdk::QualificationsRedeemable

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QualificationsRedeemable

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 150

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']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#applicable_to ⇒ Object

Returns the value of attribute applicable_to.



34
35
36
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 34

def applicable_to
  @applicable_to
end

Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.



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

def banner
  @banner
end

#campaign_id ⇒ Object

Id of the campaign associated to the redeemable. This field is available only if object is not ‘campaign`



54
55
56
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 54

def campaign_id
  @campaign_id
end

#campaign_name ⇒ Object

Name of the campaign associated to the redeemable. This field is available only if object is not ‘campaign`



51
52
53
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 51

def campaign_name
  @campaign_name
end

#categories ⇒ Object

List of category information.



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

def categories
  @categories
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#id ⇒ Object

Id of the redeemable.



19
20
21
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 19

def id
  @id
end

#inapplicable_to ⇒ Object

Returns the value of attribute inapplicable_to.



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

def inapplicable_to
  @inapplicable_to
end

#metadata ⇒ Object

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



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

def metadata
  @metadata
end

#name ⇒ Object

Name of the redeemable.



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

def name
  @name
end

#object ⇒ Object

Object type of the redeemable.



22
23
24
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 22

def object
  @object
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#redeemables ⇒ Object

Returns the value of attribute redeemables.



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

def redeemables
  @redeemables
end

#result ⇒ Object

Returns the value of attribute result.



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

def result
  @result
end

#validation_rule_id ⇒ Object

A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.



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

def validation_rule_id
  @validation_rule_id
end

#validation_rules_assignments ⇒ Object

Returns the value of attribute validation_rules_assignments.



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

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



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

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



105
106
107
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 105

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 83

def self.attribute_map
  {
    :'id' => :'id',
    :'object' => :'object',
    :'created_at' => :'created_at',
    :'result' => :'result',
    :'order' => :'order',
    :'validation_rule_id' => :'validation_rule_id',
    :'applicable_to' => :'applicable_to',
    :'inapplicable_to' => :'inapplicable_to',
    :'metadata' => :'metadata',
    :'categories' => :'categories',
    :'banner' => :'banner',
    :'name' => :'name',
    :'campaign_name' => :'campaign_name',
    :'campaign_id' => :'campaign_id',
    :'validation_rules_assignments' => :'validation_rules_assignments',
    :'redeemables' => :'redeemables'
  }
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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 280

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 132

def self.openapi_nullable
  Set.new([
    :'id',
    :'object',
    :'created_at',
    :'validation_rule_id',
    :'metadata',
    :'categories',
    :'banner',
    :'name',
    :'campaign_name',
    :'campaign_id',
    :'redeemables'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 110

def self.openapi_types
  {
    :'id' => :'String',
    :'object' => :'String',
    :'created_at' => :'Time',
    :'result' => :'RedeemableResult',
    :'order' => :'OrderCalculated',
    :'validation_rule_id' => :'String',
    :'applicable_to' => :'ApplicableToResultList',
    :'inapplicable_to' => :'InapplicableToResultList',
    :'metadata' => :'Object',
    :'categories' => :'Array<CategoryWithStackingRulesType>',
    :'banner' => :'String',
    :'name' => :'String',
    :'campaign_name' => :'String',
    :'campaign_id' => :'String',
    :'validation_rules_assignments' => :'ValidationRulesAssignmentsList',
    :'redeemables' => :'Array<QualificationsRedeemableBase>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      object == o.object &&
      created_at == o.created_at &&
      result == o.result &&
      order == o.order &&
      validation_rule_id == o.validation_rule_id &&
      applicable_to == o.applicable_to &&
      inapplicable_to == o.inapplicable_to &&
      metadata == o.metadata &&
      categories == o.categories &&
      banner == o.banner &&
      name == o.name &&
      campaign_name == o.campaign_name &&
      campaign_id == o.campaign_id &&
      validation_rules_assignments == o.validation_rules_assignments &&
      redeemables == o.redeemables
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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 375

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


267
268
269
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 273

def hash
  [id, object, created_at, result, order, validation_rule_id, applicable_to, inapplicable_to, metadata, categories, banner, name, campaign_name, campaign_id, validation_rules_assignments, redeemables].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



227
228
229
230
231
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 227

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



351
352
353
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 351

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 357

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



345
346
347
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 345

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



235
236
237
238
239
240
 
# File 'lib/VoucherifySdk/models/qualifications_redeemable.rb', line 235

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["campaign", "promotion_tier", "promotion_stack", "voucher"])
  return false unless object_validator.valid?(@object)
  true
end