Class: PureCloud::WebActionEvent

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebActionEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 135

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

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

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

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

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

  
  if attributes.has_key?(:'errorMessage')
    
    
    self.error_message = attributes[:'errorMessage']
    
  
  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?(:'visitReferrer')
    
    
    self.visit_referrer = attributes[:'visitReferrer']
    
  
  end

  
end

Instance Attribute Details

#action ⇒ Object

The action that triggered the event.



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

def action
  @action
end

#action_map ⇒ Object

The action map that triggered the action.



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

def action_map
  @action_map
end

#action_target ⇒ Object

The target for engagement actions.



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

def action_target
  @action_target
end

#browser ⇒ Object

Customer’s browser.



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

def browser
  @browser
end

#device ⇒ Object

Customer’s device.



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

def device
  @device
end

#error_code ⇒ Object

Code of the error returned when the action fails.



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

def error_code
  @error_code
end

#error_message ⇒ Object

Message of the error returned when the action fails.



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

def error_message
  @error_message
end

#geolocation ⇒ Object

Customer’s geolocation.



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

def geolocation
  @geolocation
end

#ip_address ⇒ Object

Visitor’s IP address.



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

def ip_address
  @ip_address
end

#ip_organization ⇒ Object

Visitor’s IP-based organization or ISP name.



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

def ip_organization
  @ip_organization
end

#mkt_campaign ⇒ Object

Marketing / traffic source information.



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

def mkt_campaign
  @mkt_campaign
end

#time_to_disposition ⇒ Object

Milliseconds elapsed until the action is disposed.



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

def time_to_disposition
  @time_to_disposition
end

#user_agent_string ⇒ Object

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



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

def user_agent_string
  @user_agent_string
end

#visit_referrer ⇒ Object

Visit’s referrer.



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 61

def visit_referrer
  @visit_referrer
end

Class Method Details

.attribute_map ⇒ Object

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



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
92
93
94
95
96
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 64

def self.attribute_map
  {
    
    :'action' => :'action',
    
    :'action_map' => :'actionMap',
    
    :'action_target' => :'actionTarget',
    
    :'time_to_disposition' => :'timeToDisposition',
    
    :'error_code' => :'errorCode',
    
    :'error_message' => :'errorMessage',
    
    :'user_agent_string' => :'userAgentString',
    
    :'browser' => :'browser',
    
    :'device' => :'device',
    
    :'geolocation' => :'geolocation',
    
    :'ip_address' => :'ipAddress',
    
    :'ip_organization' => :'ipOrganization',
    
    :'mkt_campaign' => :'mktCampaign',
    
    :'visit_referrer' => :'visitReferrer'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'action' => :'EventAction',
    
    :'action_map' => :'ActionMap',
    
    :'action_target' => :'ActionTarget',
    
    :'time_to_disposition' => :'Integer',
    
    :'error_code' => :'String',
    
    :'error_message' => :'String',
    
    :'user_agent_string' => :'String',
    
    :'browser' => :'Browser',
    
    :'device' => :'Device',
    
    :'geolocation' => :'JourneyGeolocation',
    
    :'ip_address' => :'String',
    
    :'ip_organization' => :'String',
    
    :'mkt_campaign' => :'JourneyCampaign',
    
    :'visit_referrer' => :'Referrer'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 419

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      action_map == o.action_map &&
      action_target == o.action_target &&
      time_to_disposition == o.time_to_disposition &&
      error_code == o.error_code &&
      error_message == o.error_message &&
      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 &&
      visit_referrer == o.visit_referrer
end

#_deserialize(type, value) ⇒ Object 



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 470

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



530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 530

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



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 451

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


440
441
442
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 440

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



446
447
448
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 446

def hash
  [action, action_map, action_target, time_to_disposition, error_code, error_message, user_agent_string, browser, device, geolocation, ip_address, ip_organization, mkt_campaign, visit_referrer].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



272
273
274
275
276
277
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 272

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))



513
514
515
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 513

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



518
519
520
521
522
523
524
525
526
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 518

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 



508
509
510
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 508

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



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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/purecloudplatformclientv2/models/web_action_event.rb', line 281

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

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end