Class: TalonOne::CampaignTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/campaign_template.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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
  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 `TalonOne::CampaignTemplate`. 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']
  end

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account that owns this entity.



25
26
27
 
# File 'lib/talon_one/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/models/campaign_template.rb', line 49

def active_ruleset_id
  @active_ruleset_id
end

#applications_ids ⇒ Object

A list of IDs of the Applications that are subscribed to this campaign template.



68
69
70
 
# File 'lib/talon_one/models/campaign_template.rb', line 68

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/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.



71
72
73
 
# File 'lib/talon_one/models/campaign_template.rb', line 71

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.



77
78
79
 
# File 'lib/talon_one/models/campaign_template.rb', line 77

def campaign_type
  @campaign_type
end

#coupon_attributes ⇒ Object

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



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

def coupon_attributes
  @coupon_attributes
end

#coupon_settings ⇒ Object

Returns the value of attribute coupon_settings.



57
58
59
 
# File 'lib/talon_one/models/campaign_template.rb', line 57

def coupon_settings
  @coupon_settings
end

#created ⇒ Object

The time this entity was created.



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

def created
  @created
end

#default_campaign_group_id ⇒ Object

The default campaign group ID.



74
75
76
 
# File 'lib/talon_one/models/campaign_template.rb', line 74

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

def description
  @description
end

#features ⇒ Object

A list of features for the campaign template.



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

def features
  @features
end

#id ⇒ Object

Internal ID of this entity.



19
20
21
 
# File 'lib/talon_one/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/models/campaign_template.rb', line 37

def instructions
  @instructions
end

#limits ⇒ Object

The set of limits that operate for this campaign template.



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

def limits
  @limits
end

#name ⇒ Object

The campaign template name.



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

def name
  @name
end

#referral_settings ⇒ Object

Returns the value of attribute referral_settings.



59
60
61
 
# File 'lib/talon_one/models/campaign_template.rb', line 59

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

def tags
  @tags
end

#template_params ⇒ Object

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



65
66
67
 
# File 'lib/talon_one/models/campaign_template.rb', line 65

def template_params
  @template_params
end

#updated ⇒ Object

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



80
81
82
 
# File 'lib/talon_one/models/campaign_template.rb', line 80

def updated
  @updated
end

#updated_by ⇒ Object

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



83
84
85
 
# File 'lib/talon_one/models/campaign_template.rb', line 83

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/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.



86
87
88
 
# File 'lib/talon_one/models/campaign_template.rb', line 86

def valid_application_ids
  @valid_application_ids
end

Class Method Details

.attribute_map ⇒ Object

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



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

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',
    :'features' => :'features',
    :'coupon_settings' => :'couponSettings',
    :'referral_settings' => :'referralSettings',
    :'limits' => :'limits',
    :'template_params' => :'templateParams',
    :'applications_ids' => :'applicationsIds',
    :'campaign_collections' => :'campaignCollections',
    :'default_campaign_group_id' => :'defaultCampaignGroupId',
    :'campaign_type' => :'campaignType',
    :'updated' => :'updated',
    :'updated_by' => :'updatedBy',
    :'valid_application_ids' => :'validApplicationIds'
  }
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



461
462
463
 
# File 'lib/talon_one/models/campaign_template.rb', line 461

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



171
172
173
174
 
# File 'lib/talon_one/models/campaign_template.rb', line 171

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'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>',
    :'features' => :'Array<String>',
    :'coupon_settings' => :'CodeGeneratorSettings',
    :'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',
    :'updated' => :'DateTime',
    :'updated_by' => :'String',
    :'valid_application_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      features == o.features &&
      coupon_settings == o.coupon_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 &&
      updated == o.updated &&
      updated_by == o.updated_by &&
      valid_application_ids == o.valid_application_ids
end

#_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



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/talon_one/models/campaign_template.rb', line 489

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    TalonOne.const_get(type).build_from_hash(value)
  end
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



558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/talon_one/models/campaign_template.rb', line 558

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

#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



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/talon_one/models/campaign_template.rb', line 468

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


448
449
450
 
# File 'lib/talon_one/models/campaign_template.rb', line 448

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



454
455
456
 
# File 'lib/talon_one/models/campaign_template.rb', line 454

def hash
  [id, created, , user_id, name, description, instructions, campaign_attributes, coupon_attributes, state, active_ruleset_id, tags, features, coupon_settings, referral_settings, limits, template_params, applications_ids, campaign_collections, default_campaign_group_id, campaign_type, updated, updated_by, valid_application_ids].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



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

def list_invalid_properties
  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 great 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 @applications_ids.nil?
    invalid_properties.push('invalid value for "applications_ids", applications_ids cannot be nil.')
  end

  if @campaign_type.nil?
    invalid_properties.push('invalid value for "campaign_type", campaign_type 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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



534
535
536
 
# File 'lib/talon_one/models/campaign_template.rb', line 534

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



540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/talon_one/models/campaign_template.rb', line 540

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



528
529
530
 
# File 'lib/talon_one/models/campaign_template.rb', line 528

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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/talon_one/models/campaign_template.rb', line 361

def valid?
  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 @applications_ids.nil?
  return false if @campaign_type.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