Class: TalonOne::TrackEventV2Response

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

Overview

This is the response type returned by the trackEventV2 endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TrackEventV2Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
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
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 75

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#awarded_giveaways ⇒ Object

Returns the value of attribute awarded_giveaways.



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

def awarded_giveaways
  @awarded_giveaways
end

#created_coupons ⇒ Object

Returns the value of attribute created_coupons.



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

def created_coupons
  @created_coupons
end

#created_referrals ⇒ Object

Returns the value of attribute created_referrals.



35
36
37
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 35

def created_referrals
  @created_referrals
end

#customer_profile ⇒ Object

Returns the value of attribute customer_profile.



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

def customer_profile
  @customer_profile
end

#effects ⇒ Object

The effects generated by the rules in your running campaigns. See [API effects](docs.talon.one/docs/dev/integration-api/api-effects).



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

def effects
  @effects
end

#event ⇒ Object

Returns the value of attribute event.



20
21
22
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 20

def event
  @event
end

#loyalty ⇒ Object

Returns the value of attribute loyalty.



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

def loyalty
  @loyalty
end

#rule_failure_reasons ⇒ Object

Returns the value of attribute rule_failure_reasons.



26
27
28
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 26

def rule_failure_reasons
  @rule_failure_reasons
end

#triggered_campaigns ⇒ Object

Returns the value of attribute triggered_campaigns.



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

def triggered_campaigns
  @triggered_campaigns
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 38

def self.attribute_map
  {
    :'customer_profile' => :'customerProfile',
    :'event' => :'event',
    :'loyalty' => :'loyalty',
    :'triggered_campaigns' => :'triggeredCampaigns',
    :'rule_failure_reasons' => :'ruleFailureReasons',
    :'awarded_giveaways' => :'awardedGiveaways',
    :'effects' => :'effects',
    :'created_coupons' => :'createdCoupons',
    :'created_referrals' => :'createdReferrals'
  }
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



196
197
198
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 196

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 53

def self.openapi_types
  {
    :'customer_profile' => :'CustomerProfile',
    :'event' => :'Event',
    :'loyalty' => :'Loyalty',
    :'triggered_campaigns' => :'Array<Campaign>',
    :'rule_failure_reasons' => :'Array<RuleFailureReason>',
    :'awarded_giveaways' => :'Array<Giveaway>',
    :'effects' => :'Array<Effect>',
    :'created_coupons' => :'Array<Coupon>',
    :'created_referrals' => :'Array<Referral>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 167

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_profile == o.customer_profile &&
      event == o.event &&
      loyalty == o.loyalty &&
      triggered_campaigns == o.triggered_campaigns &&
      rule_failure_reasons == o.rule_failure_reasons &&
      awarded_giveaways == o.awarded_giveaways &&
      effects == o.effects &&
      created_coupons == o.created_coupons &&
      created_referrals == o.created_referrals
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



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

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 293

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 203

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


183
184
185
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



189
190
191
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 189

def hash
  [customer_profile, event, loyalty, triggered_campaigns, rule_failure_reasons, awarded_giveaways, effects, created_coupons, created_referrals].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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 139

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

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

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



269
270
271
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 269

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 275

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



263
264
265
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 263

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



158
159
160
161
162
163
 
# File 'lib/talon_one/models/track_event_v2_response.rb', line 158

def valid?
  return false if @effects.nil?
  return false if @created_coupons.nil?
  return false if @created_referrals.nil?
  true
end