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



401
402
403
404
405
406
407
408
409
410
411
412
413
414
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
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 401

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

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

  
  if attributes.has_key?(:'messageType')
    
    
    self.message_type = attributes[:'messageType']
    
  
  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?(:'sessionDnis')
    
    
    self.session_dnis = attributes[:'sessionDnis']
    
  
  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?(:'peerId')
    
    
    self.peer_id = attributes[:'peerId']
    
  
  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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#address_from ⇒ Object

Returns the value of attribute address_from.



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

def address_from
  @address_from
end

#address_other ⇒ Object

Returns the value of attribute address_other.



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

def address_other
  @address_other
end

#address_self ⇒ Object

Returns the value of attribute address_self.



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

def address_self
  @address_self
end

#address_to ⇒ Object

Returns the value of attribute address_to.



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

def address_to
  @address_to
end

#ani ⇒ Object

Automatic Number Identification (caller’s number)



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

def ani
  @ani
end

#callback_numbers ⇒ Object

List of numbers to callback



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

def callback_numbers
  @callback_numbers
end

#callback_scheduled_time ⇒ Object

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



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

def callback_scheduled_time
  @callback_scheduled_time
end

#callback_user_name ⇒ Object

The name of the user requesting a call back



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

def callback_user_name
  @callback_user_name
end

#cobrowse_role ⇒ Object

Describe side of the cobrowse (sharer or viewer)



100
101
102
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 100

def cobrowse_role
  @cobrowse_role
end

#cobrowse_room_id ⇒ Object

A unique identifier for a PureCloud Cobrowse room.



103
104
105
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 103

def cobrowse_room_id
  @cobrowse_room_id
end

#direction ⇒ Object

Direction



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

def direction
  @direction
end

#disposition_analyzer ⇒ Object

(Dialer) Unique identifier of the contact list that this contact belongs to



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

def disposition_analyzer
  @disposition_analyzer
end

#disposition_name ⇒ Object

(Dialer) Result of the analysis



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

def disposition_name
  @disposition_name
end

#dnis ⇒ Object

Dialed number identification service (number dialed by the calling party)



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

def dnis
  @dnis
end

#edge_id ⇒ Object

Unique identifier of the edge device



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

def edge_id
  @edge_id
end

#flow ⇒ Object

IVR flow execution associated with this session



129
130
131
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 129

def flow
  @flow
end

#flow_out_type ⇒ Object

Type of flow out that occurred, e.g. voicemail, callback, or acd



171
172
173
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 171

def flow_out_type
  @flow_out_type
end

#journey_action_id ⇒ Object

Journey action ID



150
151
152
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 150

def journey_action_id
  @journey_action_id
end

#journey_action_map_id ⇒ Object

Journey action map ID



153
154
155
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 153

def journey_action_map_id
  @journey_action_map_id
end

#journey_action_map_version ⇒ Object

Journey action map version



156
157
158
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 156

def journey_action_map_version
  @journey_action_map_version
end

#journey_customer_id ⇒ Object

ID of the journey customer



138
139
140
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 138

def journey_customer_id
  @journey_customer_id
end

#journey_customer_id_type ⇒ Object

Type of the journey customer ID



141
142
143
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 141

def journey_customer_id_type
  @journey_customer_id_type
end

#journey_customer_session_id ⇒ Object

ID of the journey customer session



144
145
146
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 144

def journey_customer_session_id
  @journey_customer_session_id
end

#journey_customer_session_id_type ⇒ Object

Type of the journey customer session ID



147
148
149
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 147

def journey_customer_session_id_type
  @journey_customer_session_id_type
end

#media_bridge_id ⇒ Object

Returns the value of attribute media_bridge_id.



105
106
107
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 105

def media_bridge_id
  @media_bridge_id
end

#media_count ⇒ Object

Count of any media (images, files, etc) included in this session



168
169
170
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 168

def media_count
  @media_count
end

#media_endpoint_stats ⇒ Object

Media endpoint stats associated with this session



132
133
134
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 132

def media_endpoint_stats
  @media_endpoint_stats
end

#media_type ⇒ Object

The session media type



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

def media_type
  @media_type
end

#message_type ⇒ Object

Message type for messaging services such as sms



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

def message_type
  @message_type
end

#metrics ⇒ Object

List of metrics for this session



126
127
128
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 126

def metrics
  @metrics
end

#monitored_participant_id ⇒ Object

Returns the value of attribute monitored_participant_id.



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

def monitored_participant_id
  @monitored_participant_id
end

#monitored_session_id ⇒ Object

The sessionID being monitored



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

def monitored_session_id
  @monitored_session_id
end

#outbound_campaign_id ⇒ Object

(Dialer) Unique identifier of the outbound campaign



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

def outbound_campaign_id
  @outbound_campaign_id
end

#outbound_contact_id ⇒ Object

(Dialer) Unique identifier of the contact



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

def outbound_contact_id
  @outbound_contact_id
end

#outbound_contact_list_id ⇒ Object

(Dialer) Unique identifier of the contact list that this contact belongs to



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

def outbound_contact_list_id
  @outbound_contact_list_id
end

#peer_id ⇒ Object

A unique identifier for a peer



91
92
93
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 91

def peer_id
  @peer_id
end

#protocol_call_id ⇒ Object

The original voice protocol call ID, e.g. a SIP call ID



159
160
161
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 159

def protocol_call_id
  @protocol_call_id
end

#provider ⇒ Object

The source provider for the communication



162
163
164
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 162

def provider
  @provider
end

#recording ⇒ Object

Flag determining if an audio recording was started or not



135
136
137
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 135

def recording
  @recording
end

#remote ⇒ Object

Name, phone number, or email address of the remote party.



165
166
167
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 165

def remote
  @remote
end

#remote_name_displayable ⇒ Object

Returns the value of attribute remote_name_displayable.



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

def remote_name_displayable
  @remote_name_displayable
end

#room_id ⇒ Object

Unique identifier for the room



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

def room_id
  @room_id
end

#screen_share_address_self ⇒ Object

Direct ScreenShare address



108
109
110
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 108

def screen_share_address_self
  @screen_share_address_self
end

#screen_share_room_id ⇒ Object

A unique identifier for a PureCloud ScreenShare room.



114
115
116
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 114

def screen_share_room_id
  @screen_share_room_id
end

#script_id ⇒ Object

A unique identifier for a script



88
89
90
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 88

def script_id
  @script_id
end

#segments ⇒ Object

List of segments for this session



123
124
125
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 123

def segments
  @segments
end

#session_dnis ⇒ Object

Dialed number for the current session; this can be different from dnis, e.g. if the call was transferred



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

def session_dnis
  @session_dnis
end

#session_id ⇒ Object

The unique identifier of this session



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

def session_id
  @session_id
end

#sharing_screen ⇒ Object

Flag determining if screenShare is started or not (true/false)



111
112
113
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 111

def sharing_screen
  @sharing_screen
end

#skip_enabled ⇒ Object

(Dialer) Whether the agent can skip the dialer contact



94
95
96
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 94

def skip_enabled
  @skip_enabled
end

#timeout_seconds ⇒ Object

The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling



97
98
99
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 97

def timeout_seconds
  @timeout_seconds
end

#video_address_self ⇒ Object

Direct Video address



120
121
122
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 120

def video_address_self
  @video_address_self
end

#video_room_id ⇒ Object

A unique identifier for a PureCloud video room.



117
118
119
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 117

def video_room_id
  @video_room_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'media_type' => :'mediaType',
    
    :'session_id' => :'sessionId',
    
    :'address_other' => :'addressOther',
    
    :'address_self' => :'addressSelf',
    
    :'address_from' => :'addressFrom',
    
    :'address_to' => :'addressTo',
    
    :'message_type' => :'messageType',
    
    :'ani' => :'ani',
    
    :'direction' => :'direction',
    
    :'dnis' => :'dnis',
    
    :'session_dnis' => :'sessionDnis',
    
    :'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',
    
    :'peer_id' => :'peerId',
    
    :'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',
    
    :'metrics' => :'metrics',
    
    :'flow' => :'flow',
    
    :'media_endpoint_stats' => :'mediaEndpointStats',
    
    :'recording' => :'recording',
    
    :'journey_customer_id' => :'journeyCustomerId',
    
    :'journey_customer_id_type' => :'journeyCustomerIdType',
    
    :'journey_customer_session_id' => :'journeyCustomerSessionId',
    
    :'journey_customer_session_id_type' => :'journeyCustomerSessionIdType',
    
    :'journey_action_id' => :'journeyActionId',
    
    :'journey_action_map_id' => :'journeyActionMapId',
    
    :'journey_action_map_version' => :'journeyActionMapVersion',
    
    :'protocol_call_id' => :'protocolCallId',
    
    :'provider' => :'provider',
    
    :'remote' => :'remote',
    
    :'media_count' => :'mediaCount',
    
    :'flow_out_type' => :'flowOutType'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
345
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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 287

def self.swagger_types
  {
    
    :'media_type' => :'String',
    
    :'session_id' => :'String',
    
    :'address_other' => :'String',
    
    :'address_self' => :'String',
    
    :'address_from' => :'String',
    
    :'address_to' => :'String',
    
    :'message_type' => :'String',
    
    :'ani' => :'String',
    
    :'direction' => :'String',
    
    :'dnis' => :'String',
    
    :'session_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',
    
    :'peer_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>',
    
    :'metrics' => :'Array<AnalyticsSessionMetric>',
    
    :'flow' => :'AnalyticsFlow',
    
    :'media_endpoint_stats' => :'Array<AnalyticsMediaEndpointStat>',
    
    :'recording' => :'BOOLEAN',
    
    :'journey_customer_id' => :'String',
    
    :'journey_customer_id_type' => :'String',
    
    :'journey_customer_session_id' => :'String',
    
    :'journey_customer_session_id_type' => :'String',
    
    :'journey_action_id' => :'String',
    
    :'journey_action_map_id' => :'String',
    
    :'journey_action_map_version' => :'String',
    
    :'protocol_call_id' => :'String',
    
    :'provider' => :'String',
    
    :'remote' => :'String',
    
    :'media_count' => :'Integer',
    
    :'flow_out_type' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1432

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 &&
      address_from == o.address_from &&
      address_to == o.address_to &&
      message_type == o.message_type &&
      ani == o.ani &&
      direction == o.direction &&
      dnis == o.dnis &&
      session_dnis == o.session_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 &&
      peer_id == o.peer_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 &&
      metrics == o.metrics &&
      flow == o.flow &&
      media_endpoint_stats == o.media_endpoint_stats &&
      recording == o.recording &&
      journey_customer_id == o.journey_customer_id &&
      journey_customer_id_type == o.journey_customer_id_type &&
      journey_customer_session_id == o.journey_customer_session_id &&
      journey_customer_session_id_type == o.journey_customer_session_id_type &&
      journey_action_id == o.journey_action_id &&
      journey_action_map_id == o.journey_action_map_id &&
      journey_action_map_version == o.journey_action_map_version &&
      protocol_call_id == o.protocol_call_id &&
      provider == o.provider &&
      remote == o.remote &&
      media_count == o.media_count &&
      flow_out_type == o.flow_out_type
end

#_deserialize(type, value) ⇒ Object 



1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1522

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



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1582

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



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1503

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


1492
1493
1494
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1492

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



1498
1499
1500
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1498

def hash
  [media_type, session_id, address_other, address_self, address_from, address_to, message_type, ani, direction, dnis, session_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, peer_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, metrics, flow, media_endpoint_stats, recording, journey_customer_id, journey_customer_id_type, journey_customer_session_id, journey_customer_session_id_type, journey_action_id, journey_action_map_id, journey_action_map_version, protocol_call_id, provider, remote, media_count, flow_out_type].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



897
898
899
900
901
902
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 897

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



1565
1566
1567
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1565

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



1570
1571
1572
1573
1574
1575
1576
1577
1578
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1570

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 



1560
1561
1562
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 1560

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



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/purecloudplatformclientv2/models/analytics_session.rb', line 906

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