Class: PureCloud::CobrowseMediaParticipant

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CobrowseMediaParticipant

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'script')
    
    
    self.script = attributes[:'script']
    
  
  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?(:'alertingTimeoutMs')
    
    
    self.alerting_timeout_ms = attributes[:'alertingTimeoutMs']
    
  
  end

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'conversationRoutingData')
    
    
    self.conversation_routing_data = attributes[:'conversationRoutingData']
    
  
  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

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

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

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

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

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

  
end

Instance Attribute Details

#address ⇒ Object

The participant address.



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

def address
  @address
end

#alerting_timeout_ms ⇒ Object

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



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

def alerting_timeout_ms
  @alerting_timeout_ms
end

#attributes ⇒ Object

A list of ad-hoc attributes for the participant.



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

def attributes
  @attributes
end

#cobrowse_role ⇒ Object

This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).



124
125
126
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 124

def cobrowse_role
  @cobrowse_role
end

#cobrowse_session_id ⇒ Object

The co-browse session ID.



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

def cobrowse_session_id
  @cobrowse_session_id
end

#connected_time ⇒ Object

The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def connected_time
  @connected_time
end

#controlling ⇒ Object

ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).



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

def controlling
  @controlling
end

#conversation_routing_data ⇒ Object

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



112
113
114
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 112

def conversation_routing_data
  @conversation_routing_data
end

#direction ⇒ Object

The participant’s direction. Values can be: ‘inbound’ or ‘outbound’



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

def direction
  @direction
end

#disconnect_type ⇒ Object

The reason the participant was disconnected from the conversation.



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

def disconnect_type
  @disconnect_type
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



118
119
120
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 118

def end_acw_time
  @end_acw_time
end

#end_time ⇒ Object

The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def end_time
  @end_time
end

#error_info ⇒ Object

If the conversation ends in error, contains additional error details.



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

def error_info
  @error_info
end

#external_contact ⇒ Object

If this participant represents an external contact, then this will be the reference for the external contact.



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

def external_contact
  @external_contact
end

#external_organization ⇒ Object

If this participant represents an external org, then this will be the reference for the external org.



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

def external_organization
  @external_organization
end

#flagged_reason ⇒ Object

The reason specifying why participant flagged the conversation.



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

def flagged_reason
  @flagged_reason
end

#held ⇒ Object

Value is true when the participant is on hold.



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

def held
  @held
end

#id ⇒ Object

The unique participant ID.



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

def id
  @id
end

#journey_context ⇒ Object

Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.



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

def journey_context
  @journey_context
end

#name ⇒ Object

The display friendly name of the participant.



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

def name
  @name
end

#peer ⇒ Object

The peer communication corresponding to a matching leg for this communication.



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

def peer
  @peer
end

#provider ⇒ Object

The source provider for the communication.



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

def provider
  @provider
end

#provider_event_time ⇒ Object

The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



133
134
135
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 133

def provider_event_time
  @provider_event_time
end

#purpose ⇒ Object

The participant’s purpose. Values can be: ‘agent’, ‘user’, ‘customer’, ‘external’, ‘acd’, ‘ivr



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

def purpose
  @purpose
end

#queue ⇒ Object

The PureCloud queue for this participant.



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

def queue
  @queue
end

#script ⇒ Object

The Engage script that should be used by this participant.



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

def script
  @script
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



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

def start_acw_time
  @start_acw_time
end

#start_hold_time ⇒ Object

The time when this participant’s hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_hold_time
  @start_hold_time
end

#start_time ⇒ Object

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



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

def start_time
  @start_time
end

#state ⇒ Object

The participant’s state. Values can be: ‘alerting’, ‘connected’, ‘disconnected’, ‘dialing’, ‘contacting



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

def state
  @state
end

#team ⇒ Object

The PureCloud team for this participant.



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

def team
  @team
end

#user ⇒ Object

The PureCloud user for this participant.



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

def user
  @user
end

#viewer_url ⇒ Object

The URL that can be used to open co-browse session in web browser.



130
131
132
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 130

def viewer_url
  @viewer_url
end

#wrapup ⇒ Object

Wrapup for this participant, if it has been applied.



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

def wrapup
  @wrapup
end

#wrapup_prompt ⇒ Object

The wrap-up prompt indicating the type of wrap-up to be performed.



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

def wrapup_prompt
  @wrapup_prompt
end

#wrapup_required ⇒ Object

Value is true when the participant requires wrap-up.



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

def wrapup_required
  @wrapup_required
end

#wrapup_skipped ⇒ Object

Value is true when the participant has skipped wrap-up.



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

def wrapup_skipped
  @wrapup_skipped
end

#wrapup_timeout_ms ⇒ Object

The amount of time the participant has to complete wrap-up.



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

def wrapup_timeout_ms
  @wrapup_timeout_ms
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'address' => :'address',
    
    :'start_time' => :'startTime',
    
    :'connected_time' => :'connectedTime',
    
    :'end_time' => :'endTime',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'purpose' => :'purpose',
    
    :'state' => :'state',
    
    :'direction' => :'direction',
    
    :'disconnect_type' => :'disconnectType',
    
    :'held' => :'held',
    
    :'wrapup_required' => :'wrapupRequired',
    
    :'wrapup_prompt' => :'wrapupPrompt',
    
    :'user' => :'user',
    
    :'queue' => :'queue',
    
    :'team' => :'team',
    
    :'attributes' => :'attributes',
    
    :'error_info' => :'errorInfo',
    
    :'script' => :'script',
    
    :'wrapup_timeout_ms' => :'wrapupTimeoutMs',
    
    :'wrapup_skipped' => :'wrapupSkipped',
    
    :'alerting_timeout_ms' => :'alertingTimeoutMs',
    
    :'provider' => :'provider',
    
    :'external_contact' => :'externalContact',
    
    :'external_organization' => :'externalOrganization',
    
    :'wrapup' => :'wrapup',
    
    :'peer' => :'peer',
    
    :'flagged_reason' => :'flaggedReason',
    
    :'journey_context' => :'journeyContext',
    
    :'conversation_routing_data' => :'conversationRoutingData',
    
    :'start_acw_time' => :'startAcwTime',
    
    :'end_acw_time' => :'endAcwTime',
    
    :'cobrowse_session_id' => :'cobrowseSessionId',
    
    :'cobrowse_role' => :'cobrowseRole',
    
    :'controlling' => :'controlling',
    
    :'viewer_url' => :'viewerUrl',
    
    :'provider_event_time' => :'providerEventTime'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'address' => :'String',
    
    :'start_time' => :'DateTime',
    
    :'connected_time' => :'DateTime',
    
    :'end_time' => :'DateTime',
    
    :'start_hold_time' => :'DateTime',
    
    :'purpose' => :'String',
    
    :'state' => :'String',
    
    :'direction' => :'String',
    
    :'disconnect_type' => :'String',
    
    :'held' => :'BOOLEAN',
    
    :'wrapup_required' => :'BOOLEAN',
    
    :'wrapup_prompt' => :'String',
    
    :'user' => :'DomainEntityRef',
    
    :'queue' => :'DomainEntityRef',
    
    :'team' => :'DomainEntityRef',
    
    :'attributes' => :'Hash<String, String>',
    
    :'error_info' => :'ErrorInfo',
    
    :'script' => :'DomainEntityRef',
    
    :'wrapup_timeout_ms' => :'Integer',
    
    :'wrapup_skipped' => :'BOOLEAN',
    
    :'alerting_timeout_ms' => :'Integer',
    
    :'provider' => :'String',
    
    :'external_contact' => :'DomainEntityRef',
    
    :'external_organization' => :'DomainEntityRef',
    
    :'wrapup' => :'Wrapup',
    
    :'peer' => :'String',
    
    :'flagged_reason' => :'String',
    
    :'journey_context' => :'JourneyContext',
    
    :'conversation_routing_data' => :'ConversationRoutingData',
    
    :'start_acw_time' => :'DateTime',
    
    :'end_acw_time' => :'DateTime',
    
    :'cobrowse_session_id' => :'String',
    
    :'cobrowse_role' => :'String',
    
    :'controlling' => :'Array<String>',
    
    :'viewer_url' => :'String',
    
    :'provider_event_time' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      address == o.address &&
      start_time == o.start_time &&
      connected_time == o.connected_time &&
      end_time == o.end_time &&
      start_hold_time == o.start_hold_time &&
      purpose == o.purpose &&
      state == o.state &&
      direction == o.direction &&
      disconnect_type == o.disconnect_type &&
      held == o.held &&
      wrapup_required == o.wrapup_required &&
      wrapup_prompt == o.wrapup_prompt &&
      user == o.user &&
      queue == o.queue &&
      team == o.team &&
      attributes == o.attributes &&
      error_info == o.error_info &&
      script == o.script &&
      wrapup_timeout_ms == o.wrapup_timeout_ms &&
      wrapup_skipped == o.wrapup_skipped &&
      alerting_timeout_ms == o.alerting_timeout_ms &&
      provider == o.provider &&
      external_contact == o.external_contact &&
      external_organization == o.external_organization &&
      wrapup == o.wrapup &&
      peer == o.peer &&
      flagged_reason == o.flagged_reason &&
      journey_context == o.journey_context &&
      conversation_routing_data == o.conversation_routing_data &&
      start_acw_time == o.start_acw_time &&
      end_acw_time == o.end_acw_time &&
      cobrowse_session_id == o.cobrowse_session_id &&
      cobrowse_role == o.cobrowse_role &&
      controlling == o.controlling &&
      viewer_url == o.viewer_url &&
      provider_event_time == o.provider_event_time
end

#_deserialize(type, value) ⇒ Object 



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 1149

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



1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 1209

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



1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 1130

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


1119
1120
1121
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 1119

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



1125
1126
1127
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 1125

def hash
  [id, name, address, start_time, connected_time, end_time, start_hold_time, purpose, state, direction, disconnect_type, held, wrapup_required, wrapup_prompt, user, queue, team, attributes, error_info, script, wrapup_timeout_ms, wrapup_skipped, alerting_timeout_ms, provider, external_contact, external_organization, wrapup, peer, flagged_reason, journey_context, conversation_routing_data, start_acw_time, end_acw_time, cobrowse_session_id, cobrowse_role, controlling, viewer_url, provider_event_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



660
661
662
663
664
665
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 660

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



1192
1193
1194
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 1192

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



1197
1198
1199
1200
1201
1202
1203
1204
1205
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 1197

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 



1187
1188
1189
 
# File 'lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb', line 1187

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  allowed_values = ["inbound", "outbound"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
  
  
  
  
  
  allowed_values = ["endpoint", "client", "system", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam"]
  if @disconnect_type && !allowed_values.include?(@disconnect_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["general"]
  if @flagged_reason && !allowed_values.include?(@flagged_reason)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end