Class: TalonOne::CampaignTemplate

Inherits:
ApiModelBase show all
Defined in:
lib/talon_one_sdk/models/campaign_template.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CampaignTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/talon_one_sdk/models/campaign_template.rb', line 216

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CampaignTemplate` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::CampaignTemplate`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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?(:'created')
    self.created = attributes[:'created']
  else
    self.created = nil
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'is_user_favorite')
    self.is_user_favorite = attributes[:'is_user_favorite']
  else
    self.is_user_favorite = false
  end
end

Instance Attribute Details

#account_id ⇒ Object

The ID of the account that owns this entity.



25
26
27
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 25

def 
  @account_id
end

#active_ruleset_id ⇒ Object

The ID of the ruleset this campaign template will use.



49
50
51
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 49

def active_ruleset_id
  @active_ruleset_id
end

#applications_ids ⇒ Object

Returns the value of attribute applications_ids.



72
73
74
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 72

def applications_ids
  @applications_ids
end

#campaign_attributes ⇒ Object

The campaign attributes that campaigns created from this template will have by default.



40
41
42
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 40

def campaign_attributes
  @campaign_attributes
end

#campaign_collections ⇒ Object

The campaign collections from the blueprint campaign for the template.



75
76
77
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 75

def campaign_collections
  @campaign_collections
end

#campaign_type ⇒ Object

The campaign type. Possible type values: - ‘cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items.



81
82
83
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 81

def campaign_type
  @campaign_type
end

#campaigns_count ⇒ Object

The number of Campaigns created from this template.



84
85
86
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 84

def campaigns_count
  @campaigns_count
end

#coupon_attributes ⇒ Object

The campaign attributes that coupons created from this template will have by default.



43
44
45
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 43

def coupon_attributes
  @coupon_attributes
end

#coupon_reservation_settings ⇒ Object

Returns the value of attribute coupon_reservation_settings.



62
63
64
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 62

def coupon_reservation_settings
  @coupon_reservation_settings
end

#coupon_settings ⇒ Object

Returns the value of attribute coupon_settings.



60
61
62
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 60

def coupon_settings
  @coupon_settings
end

#created ⇒ Object

The time this entity was created.



22
23
24
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 22

def created
  @created
end

#default_campaign_group_id ⇒ Object

The default campaign group ID.



78
79
80
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 78

def default_campaign_group_id
  @default_campaign_group_id
end

#description ⇒ Object

Customer-facing text that explains the objective of the template.



34
35
36
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 34

def description
  @description
end

#features ⇒ Object

A list of features for the campaign template.



58
59
60
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 58

def features
  @features
end

#id ⇒ Object

The internal ID of this entity.



19
20
21
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 19

def id
  @id
end

#instructions ⇒ Object

Customer-facing text that explains how to use the template. For example, you can use this property to explain the available attributes of this template, and how they can be modified when a user uses this template to create a new campaign.



37
38
39
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 37

def instructions
  @instructions
end

#is_user_favorite ⇒ Object

A flag indicating whether the user marked the template as a favorite.



96
97
98
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 96

def is_user_favorite
  @is_user_favorite
end

#limits ⇒ Object

The set of limits that operate for this campaign template.



67
68
69
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 67

def limits
  @limits
end

#name ⇒ Object

The campaign template name.



31
32
33
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 31

def name
  @name
end

#reevaluate_on_return ⇒ Object

Indicates whether campaigns created from this template should be reevaluated when a customer returns an item.



55
56
57
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 55

def reevaluate_on_return
  @reevaluate_on_return
end

#referral_settings ⇒ Object

Returns the value of attribute referral_settings.



64
65
66
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 64

def referral_settings
  @referral_settings
end

#state ⇒ Object

Only campaign templates in ‘available’ state may be used to create campaigns.



46
47
48
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 46

def state
  @state
end

#tags ⇒ Object

A list of tags for the campaign template.



52
53
54
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 52

def tags
  @tags
end

#template_params ⇒ Object

Fields which can be used to replace values in a rule.



70
71
72
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 70

def template_params
  @template_params
end

#updated ⇒ Object

Timestamp of the most recent update to the campaign template or any of its elements.



87
88
89
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 87

def updated
  @updated
end

#updated_by ⇒ Object

Name of the user who last updated this campaign template, if available.



90
91
92
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 90

def updated_by
  @updated_by
end

#user_id ⇒ Object

The ID of the user associated with this entity.



28
29
30
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 28

def user_id
  @user_id
end

#valid_application_ids ⇒ Object

The IDs of the Applications that are related to this entity.



93
94
95
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 93

def valid_application_ids
  @valid_application_ids
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



155
156
157
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 155

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



160
161
162
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 160

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
147
148
149
150
151
152
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 121

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'account_id' => :'accountId',
    :'user_id' => :'userId',
    :'name' => :'name',
    :'description' => :'description',
    :'instructions' => :'instructions',
    :'campaign_attributes' => :'campaignAttributes',
    :'coupon_attributes' => :'couponAttributes',
    :'state' => :'state',
    :'active_ruleset_id' => :'activeRulesetId',
    :'tags' => :'tags',
    :'reevaluate_on_return' => :'reevaluateOnReturn',
    :'features' => :'features',
    :'coupon_settings' => :'couponSettings',
    :'coupon_reservation_settings' => :'couponReservationSettings',
    :'referral_settings' => :'referralSettings',
    :'limits' => :'limits',
    :'template_params' => :'templateParams',
    :'applications_ids' => :'applicationsIds',
    :'campaign_collections' => :'campaignCollections',
    :'default_campaign_group_id' => :'defaultCampaignGroupId',
    :'campaign_type' => :'campaignType',
    :'campaigns_count' => :'campaignsCount',
    :'updated' => :'updated',
    :'updated_by' => :'updatedBy',
    :'valid_application_ids' => :'validApplicationIds',
    :'is_user_favorite' => :'isUserFavorite'
  }
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



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 655

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)



205
206
207
208
209
210
211
212
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 205

def self.openapi_all_of
  [
  :'AccountEntity',
  :'Entity',
  :'UpdateCampaignTemplate',
  :'UserEntity'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



199
200
201
202
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 199

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 165

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'Time',
    :'account_id' => :'Integer',
    :'user_id' => :'Integer',
    :'name' => :'String',
    :'description' => :'String',
    :'instructions' => :'String',
    :'campaign_attributes' => :'Object',
    :'coupon_attributes' => :'Object',
    :'state' => :'String',
    :'active_ruleset_id' => :'Integer',
    :'tags' => :'Array<String>',
    :'reevaluate_on_return' => :'Boolean',
    :'features' => :'Array<String>',
    :'coupon_settings' => :'CodeGeneratorSettings',
    :'coupon_reservation_settings' => :'CampaignTemplateCouponReservationSettings',
    :'referral_settings' => :'CodeGeneratorSettings',
    :'limits' => :'Array<TemplateLimitConfig>',
    :'template_params' => :'Array<CampaignTemplateParams>',
    :'applications_ids' => :'Array<Integer>',
    :'campaign_collections' => :'Array<CampaignTemplateCollection>',
    :'default_campaign_group_id' => :'Integer',
    :'campaign_type' => :'String',
    :'campaigns_count' => :'Integer',
    :'updated' => :'Time',
    :'updated_by' => :'String',
    :'valid_application_ids' => :'Array<Integer>',
    :'is_user_favorite' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 607

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
       == o. &&
      user_id == o.user_id &&
      name == o.name &&
      description == o.description &&
      instructions == o.instructions &&
      campaign_attributes == o.campaign_attributes &&
      coupon_attributes == o.coupon_attributes &&
      state == o.state &&
      active_ruleset_id == o.active_ruleset_id &&
      tags == o.tags &&
      reevaluate_on_return == o.reevaluate_on_return &&
      features == o.features &&
      coupon_settings == o.coupon_settings &&
      coupon_reservation_settings == o.coupon_reservation_settings &&
      referral_settings == o.referral_settings &&
      limits == o.limits &&
      template_params == o.template_params &&
      applications_ids == o.applications_ids &&
      campaign_collections == o.campaign_collections &&
      default_campaign_group_id == o.default_campaign_group_id &&
      campaign_type == o.campaign_type &&
      campaigns_count == o.campaigns_count &&
      updated == o.updated &&
      updated_by == o.updated_by &&
      valid_application_ids == o.valid_application_ids &&
      is_user_favorite == o.is_user_favorite
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


642
643
644
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 642

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



648
649
650
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 648

def hash
  [id, created, , user_id, name, description, instructions, campaign_attributes, coupon_attributes, state, active_ruleset_id, tags, reevaluate_on_return, features, coupon_settings, coupon_reservation_settings, referral_settings, limits, template_params, applications_ids, campaign_collections, default_campaign_group_id, campaign_type, campaigns_count, updated, updated_by, valid_application_ids, is_user_favorite].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/talon_one_sdk/models/campaign_template.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 @created.nil?
    invalid_properties.push('invalid value for "created", created cannot be nil.')
  end

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

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

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

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
  end

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

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

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

  if !@tags.nil? && @tags.length > 50
    invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 50.')
  end

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 677

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

#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
 
# File 'lib/talon_one_sdk/models/campaign_template.rb', line 445

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @created.nil?
  return false if @account_id.nil?
  return false if @user_id.nil?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @description.nil?
  return false if @instructions.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["draft", "enabled", "disabled"])
  return false unless state_validator.valid?(@state)
  return false if !@tags.nil? && @tags.length > 50
  return false if @reevaluate_on_return.nil?
  return false if @applications_ids.nil?
  campaign_type_validator = EnumAttributeValidator.new('String', ["cartItem", "advanced"])
  return false unless campaign_type_validator.valid?(@campaign_type)
  return false if @valid_application_ids.nil?
  true
end