Class: PureCloud::ParticipantBasic

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ParticipantBasic

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
398
399
400
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
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 335

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#address ⇒ Object

The address for the this participant. For a phone call this will be the ANI.



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

def address
  @address
end

#alerting_timeout_ms ⇒ Object

Specifies how long the agent has to answer an interaction before being marked as not responding.



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

def alerting_timeout_ms
  @alerting_timeout_ms
end

#ani ⇒ Object

The address for the this participant. For a phone call this will be the ANI.



73
74
75
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 73

def ani
  @ani
end

#ani_name ⇒ Object

The ani-based name for this participant.



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

def ani_name
  @ani_name
end

#attributes ⇒ Object

Additional participant attributes



109
110
111
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 109

def attributes
  @attributes
end

#callbacks ⇒ Object

Returns the value of attribute callbacks.



113
114
115
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 113

def callbacks
  @callbacks
end

#calls ⇒ Object

Returns the value of attribute calls.



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

def calls
  @calls
end

#chats ⇒ Object

Returns the value of attribute chats.



115
116
117
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 115

def chats
  @chats
end

#cobrowsesessions ⇒ Object

Returns the value of attribute cobrowsesessions.



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

def cobrowsesessions
  @cobrowsesessions
end

#connected_time ⇒ Object

The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def connected_time
  @connected_time
end

#consult_participant_id ⇒ Object

If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred.



67
68
69
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 67

def consult_participant_id
  @consult_participant_id
end

#conversation_routing_data ⇒ Object

Information on how a communication should be routed to an agent.



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

def conversation_routing_data
  @conversation_routing_data
end

#dnis ⇒ Object

The address for the this participant. For a phone call this will be the ANI.



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

def dnis
  @dnis
end

#emails ⇒ Object

Returns the value of attribute emails.



119
120
121
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 119

def emails
  @emails
end

#end_acw_time ⇒ Object

The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def end_acw_time
  @end_acw_time
end

#end_time ⇒ Object

The timestamp when this participant disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def end_time
  @end_time
end

#evaluations ⇒ Object

Returns the value of attribute evaluations.



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

def evaluations
  @evaluations
end

#external_contact_id ⇒ Object

If this participant represents an external contact, then this will be the globally unique identifier for the external contact.



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

def external_contact_id
  @external_contact_id
end

#external_organization_id ⇒ Object

If this participant represents an external org, then this will be the globally unique identifier for the external org.



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

def external_organization_id
  @external_organization_id
end

#flagged_reason ⇒ Object

The reason specifying why participant flagged the conversation.



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

def flagged_reason
  @flagged_reason
end

#group_id ⇒ Object

If present, group of users the participant represents.



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

def group_id
  @group_id
end

#id ⇒ Object

A globally unique identifier for this conversation.



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

def id
  @id
end

#locale ⇒ Object

An ISO 639 language code specifying the locale for this participant



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

def locale
  @locale
end

#messages ⇒ Object

Returns the value of attribute messages.



121
122
123
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 121

def messages
  @messages
end

#monitored_participant_id ⇒ Object

If this participant is a monitor, then this will be the id of the participant that is being monitored.



106
107
108
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 106

def monitored_participant_id
  @monitored_participant_id
end

#name ⇒ Object

A human readable name identifying the participant.



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

def name
  @name
end

#participant_type ⇒ Object

A well known string that specifies the type of this participant.



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

def participant_type
  @participant_type
end

#purpose ⇒ Object

A well known string that specifies the purpose of this participant.



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

def purpose
  @purpose
end

#queue_id ⇒ Object

If present, the queue id that the communication channel came in on.



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

def queue_id
  @queue_id
end

#queue_name ⇒ Object

If present, the queue name that the communication channel came in on.



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

def queue_name
  @queue_name
end

#screen_recording_state ⇒ Object

The current screen recording state for this participant.



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

def screen_recording_state
  @screen_recording_state
end

#screenshares ⇒ Object

Returns the value of attribute screenshares.



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

def screenshares
  @screenshares
end

#social_expressions ⇒ Object

Returns the value of attribute social_expressions.



125
126
127
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 125

def social_expressions
  @social_expressions
end

#start_acw_time ⇒ Object

The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_acw_time
  @start_acw_time
end

#start_time ⇒ Object

The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_time
  @start_time
end

#team_id ⇒ Object

The team id that this participant is a member of when added to the conversation.



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

def team_id
  @team_id
end

#user_id ⇒ Object

If this participant represents a user, then this will be the globally unique identifier for the user.



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

def user_id
  @user_id
end

#user_uri ⇒ Object

If this participant represents a user, then this will be an URI that can be used to fetch the user.



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

def user_uri
  @user_uri
end

#videos ⇒ Object

Returns the value of attribute videos.



127
128
129
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 127

def videos
  @videos
end

#wrapup ⇒ Object

Call wrap up or disposition data.



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

def wrapup
  @wrapup
end

#wrapup_prompt ⇒ Object

This field controls how the UI prompts the agent for a wrapup.



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

def wrapup_prompt
  @wrapup_prompt
end

#wrapup_required ⇒ Object

True iff this participant is required to enter wrapup for this conversation.



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

def wrapup_required
  @wrapup_required
end

#wrapup_skipped ⇒ Object

The UI sets this field when the agent chooses to skip entering a wrapup for this participant.



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

def wrapup_skipped
  @wrapup_skipped
end

#wrapup_timeout_ms ⇒ Object

Specifies how long a timed ACW session will last.



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

def wrapup_timeout_ms
  @wrapup_timeout_ms
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'start_time' => :'startTime',
    
    :'end_time' => :'endTime',
    
    :'connected_time' => :'connectedTime',
    
    :'name' => :'name',
    
    :'user_uri' => :'userUri',
    
    :'user_id' => :'userId',
    
    :'external_contact_id' => :'externalContactId',
    
    :'external_organization_id' => :'externalOrganizationId',
    
    :'queue_id' => :'queueId',
    
    :'group_id' => :'groupId',
    
    :'team_id' => :'teamId',
    
    :'queue_name' => :'queueName',
    
    :'purpose' => :'purpose',
    
    :'participant_type' => :'participantType',
    
    :'consult_participant_id' => :'consultParticipantId',
    
    :'address' => :'address',
    
    :'ani' => :'ani',
    
    :'ani_name' => :'aniName',
    
    :'dnis' => :'dnis',
    
    :'locale' => :'locale',
    
    :'wrapup_required' => :'wrapupRequired',
    
    :'wrapup_prompt' => :'wrapupPrompt',
    
    :'wrapup_timeout_ms' => :'wrapupTimeoutMs',
    
    :'wrapup_skipped' => :'wrapupSkipped',
    
    :'wrapup' => :'wrapup',
    
    :'conversation_routing_data' => :'conversationRoutingData',
    
    :'alerting_timeout_ms' => :'alertingTimeoutMs',
    
    :'monitored_participant_id' => :'monitoredParticipantId',
    
    :'attributes' => :'attributes',
    
    :'calls' => :'calls',
    
    :'callbacks' => :'callbacks',
    
    :'chats' => :'chats',
    
    :'cobrowsesessions' => :'cobrowsesessions',
    
    :'emails' => :'emails',
    
    :'messages' => :'messages',
    
    :'screenshares' => :'screenshares',
    
    :'social_expressions' => :'socialExpressions',
    
    :'videos' => :'videos',
    
    :'evaluations' => :'evaluations',
    
    :'screen_recording_state' => :'screenRecordingState',
    
    :'flagged_reason' => :'flaggedReason',
    
    :'start_acw_time' => :'startAcwTime',
    
    :'end_acw_time' => :'endAcwTime'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'start_time' => :'DateTime',
    
    :'end_time' => :'DateTime',
    
    :'connected_time' => :'DateTime',
    
    :'name' => :'String',
    
    :'user_uri' => :'String',
    
    :'user_id' => :'String',
    
    :'external_contact_id' => :'String',
    
    :'external_organization_id' => :'String',
    
    :'queue_id' => :'String',
    
    :'group_id' => :'String',
    
    :'team_id' => :'String',
    
    :'queue_name' => :'String',
    
    :'purpose' => :'String',
    
    :'participant_type' => :'String',
    
    :'consult_participant_id' => :'String',
    
    :'address' => :'String',
    
    :'ani' => :'String',
    
    :'ani_name' => :'String',
    
    :'dnis' => :'String',
    
    :'locale' => :'String',
    
    :'wrapup_required' => :'BOOLEAN',
    
    :'wrapup_prompt' => :'String',
    
    :'wrapup_timeout_ms' => :'Integer',
    
    :'wrapup_skipped' => :'BOOLEAN',
    
    :'wrapup' => :'Wrapup',
    
    :'conversation_routing_data' => :'ConversationRoutingData',
    
    :'alerting_timeout_ms' => :'Integer',
    
    :'monitored_participant_id' => :'String',
    
    :'attributes' => :'Hash<String, String>',
    
    :'calls' => :'Array<CallBasic>',
    
    :'callbacks' => :'Array<CallbackBasic>',
    
    :'chats' => :'Array<ConversationChat>',
    
    :'cobrowsesessions' => :'Array<Cobrowsesession>',
    
    :'emails' => :'Array<Email>',
    
    :'messages' => :'Array<Message>',
    
    :'screenshares' => :'Array<Screenshare>',
    
    :'social_expressions' => :'Array<SocialExpression>',
    
    :'videos' => :'Array<Video>',
    
    :'evaluations' => :'Array<Evaluation>',
    
    :'screen_recording_state' => :'String',
    
    :'flagged_reason' => :'String',
    
    :'start_acw_time' => :'DateTime',
    
    :'end_acw_time' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      connected_time == o.connected_time &&
      name == o.name &&
      user_uri == o.user_uri &&
      user_id == o.user_id &&
      external_contact_id == o.external_contact_id &&
      external_organization_id == o.external_organization_id &&
      queue_id == o.queue_id &&
      group_id == o.group_id &&
      team_id == o.team_id &&
      queue_name == o.queue_name &&
      purpose == o.purpose &&
      participant_type == o.participant_type &&
      consult_participant_id == o.consult_participant_id &&
      address == o.address &&
      ani == o.ani &&
      ani_name == o.ani_name &&
      dnis == o.dnis &&
      locale == o.locale &&
      wrapup_required == o.wrapup_required &&
      wrapup_prompt == o.wrapup_prompt &&
      wrapup_timeout_ms == o.wrapup_timeout_ms &&
      wrapup_skipped == o.wrapup_skipped &&
      wrapup == o.wrapup &&
      conversation_routing_data == o.conversation_routing_data &&
      alerting_timeout_ms == o.alerting_timeout_ms &&
      monitored_participant_id == o.monitored_participant_id &&
      attributes == o.attributes &&
      calls == o.calls &&
      callbacks == o.callbacks &&
      chats == o.chats &&
      cobrowsesessions == o.cobrowsesessions &&
      emails == o.emails &&
      messages == o.messages &&
      screenshares == o.screenshares &&
      social_expressions == o.social_expressions &&
      videos == o.videos &&
      evaluations == o.evaluations &&
      screen_recording_state == o.screen_recording_state &&
      flagged_reason == o.flagged_reason &&
      start_acw_time == o.start_acw_time &&
      end_acw_time == o.end_acw_time
end

#_deserialize(type, value) ⇒ Object 



1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1299

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



1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1359

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



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1280

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


1269
1270
1271
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1269

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



1275
1276
1277
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1275

def hash
  [id, start_time, end_time, connected_time, name, user_uri, user_id, external_contact_id, external_organization_id, queue_id, group_id, team_id, queue_name, purpose, participant_type, consult_participant_id, address, ani, ani_name, dnis, locale, wrapup_required, wrapup_prompt, wrapup_timeout_ms, wrapup_skipped, wrapup, conversation_routing_data, alerting_timeout_ms, monitored_participant_id, attributes, calls, callbacks, chats, cobrowsesessions, emails, messages, screenshares, social_expressions, videos, evaluations, screen_recording_state, flagged_reason, start_acw_time, end_acw_time].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



764
765
766
767
768
769
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 764

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



1342
1343
1344
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1342

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



1347
1348
1349
1350
1351
1352
1353
1354
1355
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1347

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 



1337
1338
1339
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 1337

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



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
894
895
896
897
898
899
900
901
902
903
904
905
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
 
# File 'lib/purecloudplatformclientv2/models/participant_basic.rb', line 773

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["mandatory", "optional", "agentRequested", "timeout", "forcedTimeout"]
  if @wrapup_prompt && !allowed_values.include?(@wrapup_prompt)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["requested", "active", "paused", "stopped", "error", "timeout"]
  if @screen_recording_state && !allowed_values.include?(@screen_recording_state)
    return false
  end
  
  
  
  
  
  allowed_values = ["general"]
  if @flagged_reason && !allowed_values.include?(@flagged_reason)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end