Class: TalonOne::CreateTemplateCampaign

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTemplateCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 87

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#campaign_attributes_overrides ⇒ Object

Custom Campaign Attributes. If the Campaign Template defines the same values, they will be overridden.



27
28
29
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 27

def campaign_attributes_overrides
  @campaign_attributes_overrides
end

#campaign_groups ⇒ Object

The IDs of the [campaign groups](docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to.



36
37
38
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 36

def campaign_groups
  @campaign_groups
end

#description ⇒ Object

A detailed description of the campaign.



21
22
23
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 21

def description
  @description
end

#evaluation_group_id ⇒ Object

The ID of the campaign evaluation group the campaign belongs to.



42
43
44
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 42

def evaluation_group_id
  @evaluation_group_id
end

#limit_overrides ⇒ Object

Limits for this Campaign. If the Campaign Template or Application define default values for the same limits, they will be overridden.



33
34
35
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 33

def limit_overrides
  @limit_overrides
end

#linked_store_ids ⇒ Object

A list of store IDs that are linked to the campaign. Note: Campaigns with linked store IDs will only be evaluated when there is a [customer session update](docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store.



45
46
47
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 45

def linked_store_ids
  @linked_store_ids
end

#name ⇒ Object

A user-facing name for this campaign.



18
19
20
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 18

def name
  @name
end

#tags ⇒ Object

A list of tags for the campaign. If the campaign template has tags, they will be overridden by this list.



39
40
41
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 39

def tags
  @tags
end

#template_id ⇒ Object

The ID of the Campaign Template which will be used in order to create the Campaign.



24
25
26
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 24

def template_id
  @template_id
end

#template_param_values ⇒ Object

Actual values to replace the template placeholder values in the Ruleset bindings. Values for all Template Parameters must be provided.



30
31
32
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 30

def template_param_values
  @template_param_values
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 48

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'template_id' => :'templateId',
    :'campaign_attributes_overrides' => :'campaignAttributesOverrides',
    :'template_param_values' => :'templateParamValues',
    :'limit_overrides' => :'limitOverrides',
    :'campaign_groups' => :'campaignGroups',
    :'tags' => :'tags',
    :'evaluation_group_id' => :'evaluationGroupId',
    :'linked_store_ids' => :'linkedStoreIds'
  }
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



225
226
227
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 225

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 64

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'template_id' => :'Integer',
    :'campaign_attributes_overrides' => :'Object',
    :'template_param_values' => :'Array<Binding>',
    :'limit_overrides' => :'Array<LimitConfig>',
    :'campaign_groups' => :'Array<Integer>',
    :'tags' => :'Array<String>',
    :'evaluation_group_id' => :'Integer',
    :'linked_store_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      template_id == o.template_id &&
      campaign_attributes_overrides == o.campaign_attributes_overrides &&
      template_param_values == o.template_param_values &&
      limit_overrides == o.limit_overrides &&
      campaign_groups == o.campaign_groups &&
      tags == o.tags &&
      evaluation_group_id == o.evaluation_group_id &&
      linked_store_ids == o.linked_store_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



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

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 322

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 232

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


212
213
214
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 218

def hash
  [name, description, template_id, campaign_attributes_overrides, template_param_values, limit_overrides, campaign_groups, tags, evaluation_group_id, linked_store_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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  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 @template_id.nil?
    invalid_properties.push('invalid value for "template_id", template_id 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



298
299
300
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 298

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 304

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



292
293
294
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 292

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



172
173
174
175
176
177
 
# File 'lib/talon_one/models/create_template_campaign.rb', line 172

def valid?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @template_id.nil?
  true
end