Class: VoucherifySdk::LoyaltiesMembersCreateResponseBody

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

Overview

Respone body schema for assigning a loyalty card to a customer using POST ‘/loyalties/campaignId/members`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltiesMembersCreateResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
318
319
320
321
322
323
324
325
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 210

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

A flag to toggle the voucher on or off. You can disable a voucher even though it’s within the active period defined by the ‘start_date` and `expiration_date`. - `true` indicates an active voucher - `false` indicates an inactive voucher



60
61
62
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 60

def active
  @active
end

#additional_info ⇒ Object

An optional field to keep any extra textual information about the code such as a code description and details.



63
64
65
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 63

def additional_info
  @additional_info
end

#assets ⇒ Object

Returns the value of attribute assets.



68
69
70
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 68

def assets
  @assets
end

#campaign ⇒ Object

A unique campaign name, identifies the voucher’s parent campaign.



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

def campaign
  @campaign
end

#campaign_id ⇒ Object

Assigned by the Voucherify API, identifies the voucher’s parent campaign.



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

def campaign_id
  @campaign_id
end

#category ⇒ Object

Tag defining the category that this voucher belongs to.



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

def category
  @category
end

#category_id ⇒ Object

Unique category ID assigned by Voucherify.



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

def category_id
  @category_id
end

#code ⇒ Object

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.



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

def code
  @code
end

#created_at ⇒ Object

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



74
75
76
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 74

def created_at
  @created_at
end

#discount ⇒ Object

Returns the value of attribute discount.



40
41
42
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 40

def discount
  @discount
end

#expiration_date ⇒ Object

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



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

def expiration_date
  @expiration_date
end

#gift ⇒ Object

Returns the value of attribute gift.



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

def gift
  @gift
end

#holder_id ⇒ Object

Unique identifier of the customer who owns the voucher.



80
81
82
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 80

def holder_id
  @holder_id
end

#id ⇒ Object

Assigned by the Voucherify API, identifies the voucher.



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

def id
  @id
end

#is_referral_code ⇒ Object

This is always false for loyalty members.



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

def is_referral_code
  @is_referral_code
end

#loyalty_card ⇒ Object

Returns the value of attribute loyalty_card.



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

def loyalty_card
  @loyalty_card
end

#metadata ⇒ Object

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



66
67
68
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 66

def metadata
  @metadata
end

#object ⇒ Object

The type of the object represented by JSON. Default is ‘voucher`.



83
84
85
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 83

def object
  @object
end

#publish ⇒ Object

Returns the value of attribute publish.



85
86
87
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 85

def publish
  @publish
end

#redemption ⇒ Object

Returns the value of attribute redemption.



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

def redemption
  @redemption
end

#start_date ⇒ Object

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



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

def start_date
  @start_date
end

#type ⇒ Object

Defines the type of the voucher.



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

def type
  @type
end

#updated_at ⇒ Object

Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.



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

def updated_at
  @updated_at
end

#validity_day_of_week ⇒ Object

Integer array corresponding to the particular days of the week in which the voucher is valid. - ‘0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday



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

def validity_day_of_week
  @validity_day_of_week
end

#validity_hours ⇒ Object

Returns the value of attribute validity_hours.



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

def validity_hours
  @validity_hours
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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

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



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 416

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



144
145
146
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 144

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



112
113
114
115
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
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 112

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



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 392

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



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

def self.openapi_nullable
  Set.new([
    :'id',
    :'code',
    :'campaign',
    :'campaign_id',
    :'category',
    :'category_id',
    :'type',
    :'discount',
    :'gift',
    :'loyalty_card',
    :'start_date',
    :'expiration_date',
    :'active',
    :'additional_info',
    :'metadata',
    :'is_referral_code',
    :'created_at',
    :'updated_at',
    :'holder_id',
    :'object',
    :'publish',
    :'redemption'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'code' => :'String',
    :'campaign' => :'String',
    :'campaign_id' => :'String',
    :'category' => :'String',
    :'category_id' => :'String',
    :'type' => :'String',
    :'discount' => :'Object',
    :'gift' => :'Object',
    :'loyalty_card' => :'LoyaltiesMembersCreateResponseBodyLoyaltyCard',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'ValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'validity_hours' => :'ValidityHours',
    :'active' => :'Boolean',
    :'additional_info' => :'String',
    :'metadata' => :'Object',
    :'assets' => :'VoucherAssets',
    :'is_referral_code' => :'Boolean',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'holder_id' => :'String',
    :'object' => :'String',
    :'publish' => :'LoyaltiesMembersCreateResponseBodyPublish',
    :'redemption' => :'LoyaltiesMembersCreateResponseBodyRedemption'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 346

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



487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 487

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


379
380
381
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 379

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



385
386
387
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 385

def hash
  [id, code, campaign, campaign_id, category, category_id, type, discount, gift, loyalty_card, start_date, expiration_date, validity_timeframe, validity_day_of_week, validity_hours, active, additional_info, metadata, assets, is_referral_code, created_at, updated_at, holder_id, object, publish, redemption].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



329
330
331
332
333
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 329

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



463
464
465
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 463

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



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 469

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



457
458
459
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 457

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



337
338
339
340
341
342
 
# File 'lib/VoucherifySdk/models/loyalties_members_create_response_body.rb', line 337

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