Class: PureCloud::WebEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/web_event.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 128

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  
  if attributes.has_key?(:'eventName')
    
    
    self.event_name = attributes[:'eventName']
    
  
  end

  
  if attributes.has_key?(:'totalEventCount')
    
    
    self.total_event_count = attributes[:'totalEventCount']
    
  
  end

  
  if attributes.has_key?(:'totalPageviewCount')
    
    
    self.total_pageview_count = attributes[:'totalPageviewCount']
    
  
  end

  
  if attributes.has_key?(:'page')
    
    
    self.page = attributes[:'page']
    
  
  end

  
  if attributes.has_key?(:'userAgentString')
    
    
    self.user_agent_string = attributes[:'userAgentString']
    
  
  end

  
  if attributes.has_key?(:'browser')
    
    
    self.browser = attributes[:'browser']
    
  
  end

  
  if attributes.has_key?(:'device')
    
    
    self.device = attributes[:'device']
    
  
  end

  
  if attributes.has_key?(:'geolocation')
    
    
    self.geolocation = attributes[:'geolocation']
    
  
  end

  
  if attributes.has_key?(:'ipAddress')
    
    
    self.ip_address = attributes[:'ipAddress']
    
  
  end

  
  if attributes.has_key?(:'ipOrganization')
    
    
    self.ip_organization = attributes[:'ipOrganization']
    
  
  end

  
  if attributes.has_key?(:'mktCampaign')
    
    
    self.mkt_campaign = attributes[:'mktCampaign']
    
  
  end

  
  if attributes.has_key?(:'referrer')
    
    
    self.referrer = attributes[:'referrer']
    
  
  end

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

  
end

Instance Attribute Details

#attributes ⇒ Object

User-defined attributes associated with a particular event.



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 58

def attributes
  @attributes
end

#browser ⇒ Object

Customer’s browser.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 37

def browser
  @browser
end

#device ⇒ Object

Customer’s device.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 40

def device
  @device
end

#event_name ⇒ Object

Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. page_viewed, order_completed, user_registered).



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 22

def event_name
  @event_name
end

#geolocation ⇒ Object

Customer’s geolocation.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 43

def geolocation
  @geolocation
end

#ip_address ⇒ Object

Customer’s IP address. May be null if the business configures the tracker to not collect IP addresses.



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 46

def ip_address
  @ip_address
end

#ip_organization ⇒ Object

Customer’s IP-based organization or ISP name.



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 49

def ip_organization
  @ip_organization
end

#mkt_campaign ⇒ Object

Marketing / traffic source information.



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 52

def mkt_campaign
  @mkt_campaign
end

#page ⇒ Object

The webpage where the user interaction occurred.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 31

def page
  @page
end

#referrer ⇒ Object

Identifies the page URL that originally generated the request for the current page being viewed.



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 55

def referrer
  @referrer
end

#total_event_count ⇒ Object

The total count of events performed by the customer across all sessions.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 25

def total_event_count
  @total_event_count
end

#total_pageview_count ⇒ Object

The total count of pageviews performed by the customer across all sessions.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 28

def total_pageview_count
  @total_pageview_count
end

#user_agent_string ⇒ Object

HTTP User-Agent string (see tools.ietf.org/html/rfc1945#section-10.15).



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 34

def user_agent_string
  @user_agent_string
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 61

def self.attribute_map
  {
    
    :'event_name' => :'eventName',
    
    :'total_event_count' => :'totalEventCount',
    
    :'total_pageview_count' => :'totalPageviewCount',
    
    :'page' => :'page',
    
    :'user_agent_string' => :'userAgentString',
    
    :'browser' => :'browser',
    
    :'device' => :'device',
    
    :'geolocation' => :'geolocation',
    
    :'ip_address' => :'ipAddress',
    
    :'ip_organization' => :'ipOrganization',
    
    :'mkt_campaign' => :'mktCampaign',
    
    :'referrer' => :'referrer',
    
    :'attributes' => :'attributes'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 94

def self.swagger_types
  {
    
    :'event_name' => :'String',
    
    :'total_event_count' => :'Integer',
    
    :'total_pageview_count' => :'Integer',
    
    :'page' => :'JourneyPage',
    
    :'user_agent_string' => :'String',
    
    :'browser' => :'Browser',
    
    :'device' => :'Device',
    
    :'geolocation' => :'JourneyGeolocation',
    
    :'ip_address' => :'String',
    
    :'ip_organization' => :'String',
    
    :'mkt_campaign' => :'JourneyCampaign',
    
    :'referrer' => :'Referrer',
    
    :'attributes' => :'Hash<String, CustomEventAttribute>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 396

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_name == o.event_name &&
      total_event_count == o.total_event_count &&
      total_pageview_count == o.total_pageview_count &&
      page == o.page &&
      user_agent_string == o.user_agent_string &&
      browser == o.browser &&
      device == o.device &&
      geolocation == o.geolocation &&
      ip_address == o.ip_address &&
      ip_organization == o.ip_organization &&
      mkt_campaign == o.mkt_campaign &&
      referrer == o.referrer &&
      attributes == o.attributes
end

#_deserialize(type, value) ⇒ Object 



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 446

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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 506

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

build the object from hash



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 427

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


416
417
418
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 416

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



422
423
424
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 422

def hash
  [event_name, total_event_count, total_pageview_count, page, user_agent_string, browser, device, geolocation, ip_address, ip_organization, mkt_campaign, referrer, attributes].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



258
259
260
261
262
263
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 258

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



489
490
491
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 489

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



494
495
496
497
498
499
500
501
502
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 494

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ Object 



484
485
486
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 484

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



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
 
# File 'lib/purecloudplatformclientv2/models/web_event.rb', line 267

def valid?
  
  
  if @event_name.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end