Class: PureCloud::AnalyticsSession

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsSession

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#address_other ⇒ Object

Returns the value of attribute address_other.



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

def address_other
  @address_other
end

#address_self ⇒ Object

Returns the value of attribute address_self.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 27

def address_self
  @address_self
end

#ani ⇒ Object

Returns the value of attribute ani.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 29

def ani
  @ani
end

#callback_numbers ⇒ Object

Returns the value of attribute callback_numbers.



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 57

def callback_numbers
  @callback_numbers
end

#callback_scheduled_time ⇒ Object

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



60
61
62
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 60

def callback_scheduled_time
  @callback_scheduled_time
end

#callback_user_name ⇒ Object

Returns the value of attribute callback_user_name.



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

def callback_user_name
  @callback_user_name
end

#cobrowse_role ⇒ Object

Returns the value of attribute cobrowse_role.



68
69
70
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 68

def cobrowse_role
  @cobrowse_role
end

#cobrowse_room_id ⇒ Object

Returns the value of attribute cobrowse_room_id.



70
71
72
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 70

def cobrowse_room_id
  @cobrowse_room_id
end

#direction ⇒ Object

Returns the value of attribute direction.



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

def direction
  @direction
end

#disposition_analyzer ⇒ Object

Returns the value of attribute disposition_analyzer.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 41

def disposition_analyzer
  @disposition_analyzer
end

#disposition_name ⇒ Object

Returns the value of attribute disposition_name.



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

def disposition_name
  @disposition_name
end

#dnis ⇒ Object

Returns the value of attribute dnis.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 33

def dnis
  @dnis
end

#edge_id ⇒ Object

Returns the value of attribute edge_id.



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 45

def edge_id
  @edge_id
end

#media_bridge_id ⇒ Object

Returns the value of attribute media_bridge_id.



72
73
74
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 72

def media_bridge_id
  @media_bridge_id
end

#media_type ⇒ Object

Returns the value of attribute media_type.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 21

def media_type
  @media_type
end

#monitored_participant_id ⇒ Object

Returns the value of attribute monitored_participant_id.



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 53

def monitored_participant_id
  @monitored_participant_id
end

#monitored_session_id ⇒ Object

Returns the value of attribute monitored_session_id.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 51

def monitored_session_id
  @monitored_session_id
end

#outbound_campaign_id ⇒ Object

Returns the value of attribute outbound_campaign_id.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 35

def outbound_campaign_id
  @outbound_campaign_id
end

#outbound_contact_id ⇒ Object

Returns the value of attribute outbound_contact_id.



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

def outbound_contact_id
  @outbound_contact_id
end

#outbound_contact_list_id ⇒ Object

Returns the value of attribute outbound_contact_list_id.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 39

def outbound_contact_list_id
  @outbound_contact_list_id
end

#remote_name_displayable ⇒ Object

Returns the value of attribute remote_name_displayable.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 47

def remote_name_displayable
  @remote_name_displayable
end

#room_id ⇒ Object

Returns the value of attribute room_id.



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

def room_id
  @room_id
end

#screen_share_address_self ⇒ Object

Returns the value of attribute screen_share_address_self.



74
75
76
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 74

def screen_share_address_self
  @screen_share_address_self
end

#screen_share_room_id ⇒ Object

Returns the value of attribute screen_share_room_id.



78
79
80
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 78

def screen_share_room_id
  @screen_share_room_id
end

#script_id ⇒ Object

Returns the value of attribute script_id.



62
63
64
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 62

def script_id
  @script_id
end

#segments ⇒ Object

Returns the value of attribute segments.



84
85
86
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 84

def segments
  @segments
end

#session_id ⇒ Object

Returns the value of attribute session_id.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 23

def session_id
  @session_id
end

#sharing_screen ⇒ Object

Returns the value of attribute sharing_screen.



76
77
78
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 76

def sharing_screen
  @sharing_screen
end

#skip_enabled ⇒ Object

Returns the value of attribute skip_enabled.



64
65
66
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 64

def skip_enabled
  @skip_enabled
end

#timeout_seconds ⇒ Object

Returns the value of attribute timeout_seconds.



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 66

def timeout_seconds
  @timeout_seconds
end

#video_address_self ⇒ Object

Returns the value of attribute video_address_self.



82
83
84
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 82

def video_address_self
  @video_address_self
end

#video_room_id ⇒ Object

Returns the value of attribute video_room_id.



80
81
82
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 80

def video_room_id
  @video_room_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'media_type' => :'mediaType',
    :'session_id' => :'sessionId',
    :'address_other' => :'addressOther',
    :'address_self' => :'addressSelf',
    :'ani' => :'ani',
    :'direction' => :'direction',
    :'dnis' => :'dnis',
    :'outbound_campaign_id' => :'outboundCampaignId',
    :'outbound_contact_id' => :'outboundContactId',
    :'outbound_contact_list_id' => :'outboundContactListId',
    :'disposition_analyzer' => :'dispositionAnalyzer',
    :'disposition_name' => :'dispositionName',
    :'edge_id' => :'edgeId',
    :'remote_name_displayable' => :'remoteNameDisplayable',
    :'room_id' => :'roomId',
    :'monitored_session_id' => :'monitoredSessionId',
    :'monitored_participant_id' => :'monitoredParticipantId',
    :'callback_user_name' => :'callbackUserName',
    :'callback_numbers' => :'callbackNumbers',
    :'callback_scheduled_time' => :'callbackScheduledTime',
    :'script_id' => :'scriptId',
    :'skip_enabled' => :'skipEnabled',
    :'timeout_seconds' => :'timeoutSeconds',
    :'cobrowse_role' => :'cobrowseRole',
    :'cobrowse_room_id' => :'cobrowseRoomId',
    :'media_bridge_id' => :'mediaBridgeId',
    :'screen_share_address_self' => :'screenShareAddressSelf',
    :'sharing_screen' => :'sharingScreen',
    :'screen_share_room_id' => :'screenShareRoomId',
    :'video_room_id' => :'videoRoomId',
    :'video_address_self' => :'videoAddressSelf',
    :'segments' => :'segments'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'media_type' => :'String',
    :'session_id' => :'String',
    :'address_other' => :'String',
    :'address_self' => :'String',
    :'ani' => :'String',
    :'direction' => :'String',
    :'dnis' => :'String',
    :'outbound_campaign_id' => :'String',
    :'outbound_contact_id' => :'String',
    :'outbound_contact_list_id' => :'String',
    :'disposition_analyzer' => :'String',
    :'disposition_name' => :'String',
    :'edge_id' => :'String',
    :'remote_name_displayable' => :'String',
    :'room_id' => :'String',
    :'monitored_session_id' => :'String',
    :'monitored_participant_id' => :'String',
    :'callback_user_name' => :'String',
    :'callback_numbers' => :'Array<String>',
    :'callback_scheduled_time' => :'DateTime',
    :'script_id' => :'String',
    :'skip_enabled' => :'BOOLEAN',
    :'timeout_seconds' => :'Integer',
    :'cobrowse_role' => :'String',
    :'cobrowse_room_id' => :'String',
    :'media_bridge_id' => :'String',
    :'screen_share_address_self' => :'String',
    :'sharing_screen' => :'BOOLEAN',
    :'screen_share_room_id' => :'String',
    :'video_room_id' => :'String',
    :'video_address_self' => :'String',
    :'segments' => :'Array<AnalyticsConversationSegment>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 346

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      media_type == o.media_type &&
      session_id == o.session_id &&
      address_other == o.address_other &&
      address_self == o.address_self &&
      ani == o.ani &&
      direction == o.direction &&
      dnis == o.dnis &&
      outbound_campaign_id == o.outbound_campaign_id &&
      outbound_contact_id == o.outbound_contact_id &&
      outbound_contact_list_id == o.outbound_contact_list_id &&
      disposition_analyzer == o.disposition_analyzer &&
      disposition_name == o.disposition_name &&
      edge_id == o.edge_id &&
      remote_name_displayable == o.remote_name_displayable &&
      room_id == o.room_id &&
      monitored_session_id == o.monitored_session_id &&
      monitored_participant_id == o.monitored_participant_id &&
      callback_user_name == o.callback_user_name &&
      callback_numbers == o.callback_numbers &&
      callback_scheduled_time == o.callback_scheduled_time &&
      script_id == o.script_id &&
      skip_enabled == o.skip_enabled &&
      timeout_seconds == o.timeout_seconds &&
      cobrowse_role == o.cobrowse_role &&
      cobrowse_room_id == o.cobrowse_room_id &&
      media_bridge_id == o.media_bridge_id &&
      screen_share_address_self == o.screen_share_address_self &&
      sharing_screen == o.sharing_screen &&
      screen_share_room_id == o.screen_share_room_id &&
      video_room_id == o.video_room_id &&
      video_address_self == o.video_address_self &&
      segments == o.segments
end

#_deserialize(type, value) ⇒ Object 



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 415

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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 475

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



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

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


385
386
387
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 385

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



391
392
393
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 391

def hash
  [media_type, session_id, address_other, address_self, ani, direction, dnis, outbound_campaign_id, outbound_contact_id, outbound_contact_list_id, disposition_analyzer, disposition_name, edge_id, remote_name_displayable, room_id, monitored_session_id, monitored_participant_id, callback_user_name, callback_numbers, callback_scheduled_time, script_id, skip_enabled, timeout_seconds, cobrowse_role, cobrowse_room_id, media_bridge_id, screen_share_address_self, sharing_screen, screen_share_room_id, video_room_id, video_address_self, segments].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



306
307
308
309
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 306

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



458
459
460
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 458

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



463
464
465
466
467
468
469
470
471
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 463

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 



453
454
455
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 453

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



313
314
315
316
317
318
319
320
321
322
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 313

def valid?
  allowed_values = ["voice", "chat", "email", "callback", "cobrowse", "video", "screenshare"]
  if @media_type && !allowed_values.include?(@media_type)
    return false
  end
  allowed_values = ["inbound", "outbound"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
end