Class: TalonOne::Effect

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

Overview

A generic effect that is fired by a triggered campaign. The props property will contain information specific to the specific effect type.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Effect

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/talon_one/models/effect.rb', line 118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#adjustment_reference_id ⇒ Object

The reference identifier of the selected price adjustment for this SKU. This is only returned if the ‘selectedPrice` resulted from a price adjustment.



61
62
63
 
# File 'lib/talon_one/models/effect.rb', line 61

def adjustment_reference_id
  @adjustment_reference_id
end

#campaign_id ⇒ Object

The ID of the campaign that triggered this effect.



19
20
21
 
# File 'lib/talon_one/models/effect.rb', line 19

def campaign_id
  @campaign_id
end

#campaign_revision_id ⇒ Object

The revision ID of the campaign that was used when triggering the effect.



49
50
51
 
# File 'lib/talon_one/models/effect.rb', line 49

def campaign_revision_id
  @campaign_revision_id
end

#campaign_revision_version_id ⇒ Object

The revision version ID of the campaign that was used when triggering the effect.



52
53
54
 
# File 'lib/talon_one/models/effect.rb', line 52

def campaign_revision_version_id
  @campaign_revision_version_id
end

#condition_index ⇒ Object

The index of the condition that was triggered.



40
41
42
 
# File 'lib/talon_one/models/effect.rb', line 40

def condition_index
  @condition_index
end

#effect_type ⇒ Object

The type of effect that was triggered. See [API effects](docs.talon.one/docs/dev/integration-api/api-effects).



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

def effect_type
  @effect_type
end

#evaluation_group_id ⇒ Object

The ID of the evaluation group. For more information, see [Managing campaign evaluation](docs.talon.one/docs/product/applications/managing-campaign-evaluation).



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

def evaluation_group_id
  @evaluation_group_id
end

#evaluation_group_mode ⇒ Object

The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](docs.talon.one/docs/product/applications/managing-campaign-evaluation).



46
47
48
 
# File 'lib/talon_one/models/effect.rb', line 46

def evaluation_group_mode
  @evaluation_group_mode
end

#props ⇒ Object

The properties of the effect. See [API effects](docs.talon.one/docs/dev/integration-api/api-effects).



64
65
66
 
# File 'lib/talon_one/models/effect.rb', line 64

def props
  @props
end

#rule_index ⇒ Object

The position of the rule that triggered this effect within the ruleset.



25
26
27
 
# File 'lib/talon_one/models/effect.rb', line 25

def rule_index
  @rule_index
end

#rule_name ⇒ Object

The name of the rule that triggered this effect.



28
29
30
 
# File 'lib/talon_one/models/effect.rb', line 28

def rule_name
  @rule_name
end

#ruleset_id ⇒ Object

The ID of the ruleset that was active in the campaign when this effect was triggered.



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

def ruleset_id
  @ruleset_id
end

#selected_price ⇒ Object

The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied.



58
59
60
 
# File 'lib/talon_one/models/effect.rb', line 58

def selected_price
  @selected_price
end

#selected_price_type ⇒ Object

The selected price type for the SKU targeted by this effect.



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

def selected_price_type
  @selected_price_type
end

#triggered_by_coupon ⇒ Object

The ID of the coupon that was being evaluated when this effect was triggered.



34
35
36
 
# File 'lib/talon_one/models/effect.rb', line 34

def triggered_by_coupon
  @triggered_by_coupon
end

#triggered_for_catalog_item ⇒ Object

The ID of the catalog item that was being evaluated when this effect was triggered.



37
38
39
 
# File 'lib/talon_one/models/effect.rb', line 37

def triggered_for_catalog_item
  @triggered_for_catalog_item
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/talon_one/models/effect.rb', line 67

def self.attribute_map
  {
    :'campaign_id' => :'campaignId',
    :'ruleset_id' => :'rulesetId',
    :'rule_index' => :'ruleIndex',
    :'rule_name' => :'ruleName',
    :'effect_type' => :'effectType',
    :'triggered_by_coupon' => :'triggeredByCoupon',
    :'triggered_for_catalog_item' => :'triggeredForCatalogItem',
    :'condition_index' => :'conditionIndex',
    :'evaluation_group_id' => :'evaluationGroupID',
    :'evaluation_group_mode' => :'evaluationGroupMode',
    :'campaign_revision_id' => :'campaignRevisionId',
    :'campaign_revision_version_id' => :'campaignRevisionVersionId',
    :'selected_price_type' => :'selectedPriceType',
    :'selected_price' => :'selectedPrice',
    :'adjustment_reference_id' => :'adjustmentReferenceId',
    :'props' => :'props'
  }
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



277
278
279
 
# File 'lib/talon_one/models/effect.rb', line 277

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/talon_one/models/effect.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/talon_one/models/effect.rb', line 89

def self.openapi_types
  {
    :'campaign_id' => :'Integer',
    :'ruleset_id' => :'Integer',
    :'rule_index' => :'Integer',
    :'rule_name' => :'String',
    :'effect_type' => :'String',
    :'triggered_by_coupon' => :'Integer',
    :'triggered_for_catalog_item' => :'Integer',
    :'condition_index' => :'Integer',
    :'evaluation_group_id' => :'Integer',
    :'evaluation_group_mode' => :'String',
    :'campaign_revision_id' => :'Integer',
    :'campaign_revision_version_id' => :'Integer',
    :'selected_price_type' => :'String',
    :'selected_price' => :'Float',
    :'adjustment_reference_id' => :'String',
    :'props' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/talon_one/models/effect.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      campaign_id == o.campaign_id &&
      ruleset_id == o.ruleset_id &&
      rule_index == o.rule_index &&
      rule_name == o.rule_name &&
      effect_type == o.effect_type &&
      triggered_by_coupon == o.triggered_by_coupon &&
      triggered_for_catalog_item == o.triggered_for_catalog_item &&
      condition_index == o.condition_index &&
      evaluation_group_id == o.evaluation_group_id &&
      evaluation_group_mode == o.evaluation_group_mode &&
      campaign_revision_id == o.campaign_revision_id &&
      campaign_revision_version_id == o.campaign_revision_version_id &&
      selected_price_type == o.selected_price_type &&
      selected_price == o.selected_price &&
      adjustment_reference_id == o.adjustment_reference_id &&
      props == o.props
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



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

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/talon_one/models/effect.rb', line 374

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/talon_one/models/effect.rb', line 284

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


264
265
266
 
# File 'lib/talon_one/models/effect.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/talon_one/models/effect.rb', line 270

def hash
  [campaign_id, ruleset_id, rule_index, rule_name, effect_type, triggered_by_coupon, triggered_for_catalog_item, condition_index, evaluation_group_id, evaluation_group_mode, campaign_revision_id, campaign_revision_version_id, selected_price_type, selected_price, adjustment_reference_id, props].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @campaign_id.nil?
    invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
  end

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

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

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

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

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



350
351
352
 
# File 'lib/talon_one/models/effect.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/talon_one/models/effect.rb', line 356

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



344
345
346
 
# File 'lib/talon_one/models/effect.rb', line 344

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



229
230
231
232
233
234
235
236
237
 
# File 'lib/talon_one/models/effect.rb', line 229

def valid?
  return false if @campaign_id.nil?
  return false if @ruleset_id.nil?
  return false if @rule_index.nil?
  return false if @rule_name.nil?
  return false if @effect_type.nil?
  return false if @props.nil?
  true
end