Class: VoucherifySdk::Campaign

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Campaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
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
376
377
378
379
380
381
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 217

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

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

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

  if attributes.key?(:'campaign_type')
    self.campaign_type = attributes[:'campaign_type']
  else
    self.campaign_type = nil
  end

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

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

  if attributes.key?(:'auto_join')
    self.auto_join = attributes[:'auto_join']
  else
    self.auto_join = nil
  end

  if attributes.key?(:'join_once')
    self.join_once = attributes[:'join_once']
  else
    self.join_once = nil
  end

  if attributes.key?(:'use_voucher_metadata_schema')
    self.use_voucher_metadata_schema = attributes[:'use_voucher_metadata_schema']
  else
    self.use_voucher_metadata_schema = nil
  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?(:'activity_duration_after_publishing')
    self.activity_duration_after_publishing = attributes[:'activity_duration_after_publishing']
  end

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

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

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

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

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

  if attributes.key?(:'creation_status')
    self.creation_status = attributes[:'creation_status']
  else
    self.creation_status = nil
  end

  if attributes.key?(:'vouchers_generation_status')
    self.vouchers_generation_status = attributes[:'vouchers_generation_status']
  else
    self.vouchers_generation_status = nil
  end

  if attributes.key?(:'protected')
    self.protected = attributes[:'protected']
  else
    self.protected = nil
  end

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

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



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

def active
  @active
end

#activity_duration_after_publishing ⇒ Object

Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a ‘duration` of `P24D` will be valid for a duration of 24 days.



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

def activity_duration_after_publishing
  @activity_duration_after_publishing
end

#auto_join ⇒ Object

Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.



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

def auto_join
  @auto_join
end

#campaign_type ⇒ Object

Type of campaign.



28
29
30
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 28

def campaign_type
  @campaign_type
end

#categories ⇒ Object

Contains details about the category.



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

def categories
  @categories
end

#category ⇒ Object

Unique category name.



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

def category
  @category
end

#category_id ⇒ Object

Unique category ID that this campaign belongs to.



86
87
88
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 86

def category_id
  @category_id
end

#created_at ⇒ Object

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



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

def created_at
  @created_at
end

#creation_status ⇒ Object

Indicates the status of the campaign creation.



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

def creation_status
  @creation_status
end

#description ⇒ Object

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



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

def description
  @description
end

#expiration_date ⇒ Object

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



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

def expiration_date
  @expiration_date
end

#id ⇒ Object

Unique campaign ID, assigned by Voucherify.



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

def id
  @id
end

#join_once ⇒ Object

If this value is set to ‘true`, customers will be able to join the campaign only once.



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

def join_once
  @join_once
end

#loyalty_tiers_expiration ⇒ Object

Returns the value of attribute loyalty_tiers_expiration.



96
97
98
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 96

def loyalty_tiers_expiration
  @loyalty_tiers_expiration
end

#metadata ⇒ Object

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



65
66
67
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 65

def metadata
  @metadata
end

#name ⇒ Object

Campaign name.



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

def name
  @name
end

#object ⇒ Object

The type of object represented by JSON. This object stores information about the campaign.



92
93
94
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 92

def object
  @object
end

#promotion ⇒ Object

Returns the value of attribute promotion.



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

def promotion
  @promotion
end

#protected ⇒ Object

Indicates whether the resource can be deleted.



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

def protected
  @protected
end

#referral_program ⇒ Object

Returns the value of attribute referral_program.



94
95
96
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 94

def referral_program
  @referral_program
end

#start_date ⇒ Object

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



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

def start_date
  @start_date
end

#type ⇒ Object

Defines whether the campaign can be updated with new vouchers after campaign creation. - ‘AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria - `STATIC`: vouchers need to be manually published



31
32
33
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 31

def type
  @type
end

#updated_at ⇒ Object

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



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

def updated_at
  @updated_at
end

#use_voucher_metadata_schema ⇒ Object

Flag indicating whether the campaign is to use the voucher’s metadata schema instead of the campaign metadata schema.



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

def use_voucher_metadata_schema
  @use_voucher_metadata_schema
end

#validation_rules_assignments ⇒ Object

Returns the value of attribute validation_rules_assignments.



100
101
102
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 100

def validation_rules_assignments
  @validation_rules_assignments
end

#validity_day_of_week ⇒ Object

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



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

def validity_day_of_week
  @validity_day_of_week
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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

def validity_timeframe
  @validity_timeframe
end

#voucher ⇒ Object

Returns the value of attribute voucher.



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

def voucher
  @voucher
end

#vouchers_count ⇒ Object

Total number of unique vouchers in campaign.



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

def vouchers_count
  @vouchers_count
end

#vouchers_generation_status ⇒ Object

Indicates the status of the campaign’s vouchers.



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

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



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 587

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



161
162
163
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 161

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 125

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'description' => :'description',
    :'campaign_type' => :'campaign_type',
    :'type' => :'type',
    :'voucher' => :'voucher',
    :'auto_join' => :'auto_join',
    :'join_once' => :'join_once',
    :'use_voucher_metadata_schema' => :'use_voucher_metadata_schema',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'activity_duration_after_publishing' => :'activity_duration_after_publishing',
    :'vouchers_count' => :'vouchers_count',
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'active' => :'active',
    :'metadata' => :'metadata',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'category' => :'category',
    :'creation_status' => :'creation_status',
    :'vouchers_generation_status' => :'vouchers_generation_status',
    :'protected' => :'protected',
    :'category_id' => :'category_id',
    :'categories' => :'categories',
    :'object' => :'object',
    :'referral_program' => :'referral_program',
    :'loyalty_tiers_expiration' => :'loyalty_tiers_expiration',
    :'promotion' => :'promotion',
    :'validation_rules_assignments' => :'validation_rules_assignments'
  }
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



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 563

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



209
210
211
212
213
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 209

def self.openapi_all_of
  [
  :'CampaignBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



202
203
204
205
206
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 202

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'campaign_type' => :'String',
    :'type' => :'String',
    :'voucher' => :'CampaignVoucher',
    :'auto_join' => :'Boolean',
    :'join_once' => :'Boolean',
    :'use_voucher_metadata_schema' => :'Boolean',
    :'validity_timeframe' => :'CampaignBaseValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'activity_duration_after_publishing' => :'String',
    :'vouchers_count' => :'Integer',
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'active' => :'Boolean',
    :'metadata' => :'Object',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'category' => :'String',
    :'creation_status' => :'String',
    :'vouchers_generation_status' => :'String',
    :'protected' => :'Boolean',
    :'category_id' => :'String',
    :'categories' => :'Array<Category>',
    :'object' => :'String',
    :'referral_program' => :'ReferralProgram',
    :'loyalty_tiers_expiration' => :'LoyaltyTiersExpirationAll',
    :'promotion' => :'PromotionTiersList',
    :'validation_rules_assignments' => :'ValidationRulesAssignmentsList'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 513

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      campaign_type == o.campaign_type &&
      type == o.type &&
      voucher == o.voucher &&
      auto_join == o.auto_join &&
      join_once == o.join_once &&
      use_voucher_metadata_schema == o.use_voucher_metadata_schema &&
      validity_timeframe == o.validity_timeframe &&
      validity_day_of_week == o.validity_day_of_week &&
      activity_duration_after_publishing == o.activity_duration_after_publishing &&
      vouchers_count == o.vouchers_count &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      active == o.active &&
      metadata == o.metadata &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      category == o.category &&
      creation_status == o.creation_status &&
      vouchers_generation_status == o.vouchers_generation_status &&
      protected == o.protected &&
      category_id == o.category_id &&
      categories == o.categories &&
      object == o.object &&
      referral_program == o.referral_program &&
      loyalty_tiers_expiration == o.loyalty_tiers_expiration &&
      promotion == o.promotion &&
      validation_rules_assignments == o.validation_rules_assignments
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



658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 658

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


550
551
552
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 550

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



556
557
558
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 556

def hash
  [id, name, description, campaign_type, type, voucher, auto_join, join_once, use_voucher_metadata_schema, validity_timeframe, validity_day_of_week, activity_duration_after_publishing, vouchers_count, start_date, expiration_date, active, metadata, created_at, updated_at, category, creation_status, vouchers_generation_status, protected, category_id, categories, object, referral_program, loyalty_tiers_expiration, promotion, validation_rules_assignments].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



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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 385

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @campaign_type.nil?
    invalid_properties.push('invalid value for "campaign_type", campaign_type cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @auto_join.nil?
    invalid_properties.push('invalid value for "auto_join", auto_join cannot be nil.')
  end

  if @join_once.nil?
    invalid_properties.push('invalid value for "join_once", join_once cannot be nil.')
  end

  if @use_voucher_metadata_schema.nil?
    invalid_properties.push('invalid value for "use_voucher_metadata_schema", use_voucher_metadata_schema cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @creation_status.nil?
    invalid_properties.push('invalid value for "creation_status", creation_status cannot be nil.')
  end

  if @vouchers_generation_status.nil?
    invalid_properties.push('invalid value for "vouchers_generation_status", vouchers_generation_status cannot be nil.')
  end

  if @protected.nil?
    invalid_properties.push('invalid value for "protected", protected cannot be nil.')
  end

  if @categories.nil?
    invalid_properties.push('invalid value for "categories", categories cannot be nil.')
  end

  if @object.nil?
    invalid_properties.push('invalid value for "object", object cannot be nil.')
  end

  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



634
635
636
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 634

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



640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 640

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



628
629
630
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 628

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



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/VoucherifySdk/models/campaign.rb', line 445

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @name.nil?
  return false if @campaign_type.nil?
  campaign_type_validator = EnumAttributeValidator.new('String', ["LOYALTY_PROGRAM", "GIFT_VOUCHERS", "DISCOUNT_COUPONS", "PROMOTION", "REFERRAL_PROGRAM", "LUCKY_DRAW"])
  return false unless campaign_type_validator.valid?(@campaign_type)
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["AUTO_UPDATE", "STATIC"])
  return false unless type_validator.valid?(@type)
  return false if @auto_join.nil?
  return false if @join_once.nil?
  return false if @use_voucher_metadata_schema.nil?
  return false if @created_at.nil?
  return false if @creation_status.nil?
  creation_status_validator = EnumAttributeValidator.new('String', ["DONE", "IN_PROGRESS", "FAILED", "DRAFT", "MODIFYING"])
  return false unless creation_status_validator.valid?(@creation_status)
  return false if @vouchers_generation_status.nil?
  vouchers_generation_status_validator = EnumAttributeValidator.new('String', ["DONE", "IN_PROGRESS", "FAILED", "DRAFT", "MODIFYING"])
  return false unless vouchers_generation_status_validator.valid?(@vouchers_generation_status)
  return false if @protected.nil?
  return false if @categories.nil?
  return false if @object.nil?
  true
end