Class: PureCloud::Participant

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/participant.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Participant

Returns a new instance of Participant.



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
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
 
# File 'lib/purecloud/models/participant.rb', line 242

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'userUri']
    self.user_uri = attributes[:'userUri']
  end
  
  if attributes[:'userId']
    self.user_id = attributes[:'userId']
  end
  
  if attributes[:'externalContactId']
    self.external_contact_id = attributes[:'externalContactId']
  end
  
  if attributes[:'externalOrganizationId']
    self.external_organization_id = attributes[:'externalOrganizationId']
  end
  
  if attributes[:'queueId']
    self.queue_id = attributes[:'queueId']
  end
  
  if attributes[:'groupId']
    self.group_id = attributes[:'groupId']
  end
  
  if attributes[:'queueName']
    self.queue_name = attributes[:'queueName']
  end
  
  if attributes[:'purpose']
    self.purpose = attributes[:'purpose']
  end
  
  if attributes[:'participantType']
    self.participant_type = attributes[:'participantType']
  end
  
  if attributes[:'consultParticipantId']
    self.consult_participant_id = attributes[:'consultParticipantId']
  end
  
  if attributes[:'address']
    self.address = attributes[:'address']
  end
  
  if attributes[:'ani']
    self.ani = attributes[:'ani']
  end
  
  if attributes[:'aniName']
    self.ani_name = attributes[:'aniName']
  end
  
  if attributes[:'dnis']
    self.dnis = attributes[:'dnis']
  end
  
  if attributes[:'locale']
    self.locale = attributes[:'locale']
  end
  
  if attributes[:'wrapupRequired']
    self.wrapup_required = attributes[:'wrapupRequired']
  end
  
  if attributes[:'wrapupPrompt']
    self.wrapup_prompt = attributes[:'wrapupPrompt']
  end
  
  if attributes[:'wrapupTimeoutMs']
    self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs']
  end
  
  if attributes[:'wrapupSkipped']
    self.wrapup_skipped = attributes[:'wrapupSkipped']
  end
  
  if attributes[:'wrapup']
    self.wrapup = attributes[:'wrapup']
  end
  
  if attributes[:'monitoredParticipantId']
    self.monitored_participant_id = attributes[:'monitoredParticipantId']
  end
  
  if attributes[:'attributes']
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end
  
  if attributes[:'calls']
    if (value = attributes[:'calls']).is_a?(Array)
      self.calls = value
    end
  end
  
  if attributes[:'callbacks']
    if (value = attributes[:'callbacks']).is_a?(Array)
      self.callbacks = value
    end
  end
  
  if attributes[:'chats']
    if (value = attributes[:'chats']).is_a?(Array)
      self.chats = value
    end
  end
  
  if attributes[:'cobrowsesessions']
    if (value = attributes[:'cobrowsesessions']).is_a?(Array)
      self.cobrowsesessions = value
    end
  end
  
  if attributes[:'emails']
    if (value = attributes[:'emails']).is_a?(Array)
      self.emails = value
    end
  end
  
  if attributes[:'screenshares']
    if (value = attributes[:'screenshares']).is_a?(Array)
      self.screenshares = value
    end
  end
  
  if attributes[:'socialExpressions']
    if (value = attributes[:'socialExpressions']).is_a?(Array)
      self.social_expressions = value
    end
  end
  
  if attributes[:'videos']
    if (value = attributes[:'videos']).is_a?(Array)
      self.videos = value
    end
  end
  
  if attributes[:'evaluations']
    if (value = attributes[:'evaluations']).is_a?(Array)
      self.evaluations = value
    end
  end
  
end

Instance Attribute Details

#address ⇒ Object

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



67
68
69
 
# File 'lib/purecloud/models/participant.rb', line 67

def address
  @address
end

#ani ⇒ Object

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



70
71
72
 
# File 'lib/purecloud/models/participant.rb', line 70

def ani
  @ani
end

#ani_name ⇒ Object

The ani-based name for this participant.



73
74
75
 
# File 'lib/purecloud/models/participant.rb', line 73

def ani_name
  @ani_name
end

#attributes ⇒ Object

Additional participant attributes



100
101
102
 
# File 'lib/purecloud/models/participant.rb', line 100

def attributes
  @attributes
end

#callbacks ⇒ Object

Returns the value of attribute callbacks.



104
105
106
 
# File 'lib/purecloud/models/participant.rb', line 104

def callbacks
  @callbacks
end

#calls ⇒ Object

Returns the value of attribute calls.



102
103
104
 
# File 'lib/purecloud/models/participant.rb', line 102

def calls
  @calls
end

#chats ⇒ Object

Returns the value of attribute chats.



106
107
108
 
# File 'lib/purecloud/models/participant.rb', line 106

def chats
  @chats
end

#cobrowsesessions ⇒ Object

Returns the value of attribute cobrowsesessions.



108
109
110
 
# File 'lib/purecloud/models/participant.rb', line 108

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/purecloud/models/participant.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.



64
65
66
 
# File 'lib/purecloud/models/participant.rb', line 64

def consult_participant_id
  @consult_participant_id
end

#dnis ⇒ Object

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



76
77
78
 
# File 'lib/purecloud/models/participant.rb', line 76

def dnis
  @dnis
end

#emails ⇒ Object

Returns the value of attribute emails.



110
111
112
 
# File 'lib/purecloud/models/participant.rb', line 110

def emails
  @emails
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/purecloud/models/participant.rb', line 28

def end_time
  @end_time
end

#evaluations ⇒ Object

Returns the value of attribute evaluations.



118
119
120
 
# File 'lib/purecloud/models/participant.rb', line 118

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/purecloud/models/participant.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/purecloud/models/participant.rb', line 46

def external_organization_id
  @external_organization_id
end

#group_id ⇒ Object

If present, group of users the participant represents.



52
53
54
 
# File 'lib/purecloud/models/participant.rb', line 52

def group_id
  @group_id
end

#id ⇒ Object

A globally unique identifier for this conversation.



22
23
24
 
# File 'lib/purecloud/models/participant.rb', line 22

def id
  @id
end

#locale ⇒ Object

An ISO 639 language code specifying the locale for this participant



79
80
81
 
# File 'lib/purecloud/models/participant.rb', line 79

def locale
  @locale
end

#monitored_participant_id ⇒ Object

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



97
98
99
 
# File 'lib/purecloud/models/participant.rb', line 97

def monitored_participant_id
  @monitored_participant_id
end

#name ⇒ Object

A human readable name identifying the participant.



34
35
36
 
# File 'lib/purecloud/models/participant.rb', line 34

def name
  @name
end

#participant_type ⇒ Object

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



61
62
63
 
# File 'lib/purecloud/models/participant.rb', line 61

def participant_type
  @participant_type
end

#purpose ⇒ Object

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



58
59
60
 
# File 'lib/purecloud/models/participant.rb', line 58

def purpose
  @purpose
end

#queue_id ⇒ Object

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



49
50
51
 
# File 'lib/purecloud/models/participant.rb', line 49

def queue_id
  @queue_id
end

#queue_name ⇒ Object

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



55
56
57
 
# File 'lib/purecloud/models/participant.rb', line 55

def queue_name
  @queue_name
end

#screenshares ⇒ Object

Returns the value of attribute screenshares.



112
113
114
 
# File 'lib/purecloud/models/participant.rb', line 112

def screenshares
  @screenshares
end

#social_expressions ⇒ Object

Returns the value of attribute social_expressions.



114
115
116
 
# File 'lib/purecloud/models/participant.rb', line 114

def social_expressions
  @social_expressions
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/purecloud/models/participant.rb', line 25

def start_time
  @start_time
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/purecloud/models/participant.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/purecloud/models/participant.rb', line 37

def user_uri
  @user_uri
end

#videos ⇒ Object

Returns the value of attribute videos.



116
117
118
 
# File 'lib/purecloud/models/participant.rb', line 116

def videos
  @videos
end

#wrapup ⇒ Object

Call wrap up or disposition data.



94
95
96
 
# File 'lib/purecloud/models/participant.rb', line 94

def wrapup
  @wrapup
end

#wrapup_prompt ⇒ Object

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



85
86
87
 
# File 'lib/purecloud/models/participant.rb', line 85

def wrapup_prompt
  @wrapup_prompt
end

#wrapup_required ⇒ Object

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



82
83
84
 
# File 'lib/purecloud/models/participant.rb', line 82

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.



91
92
93
 
# File 'lib/purecloud/models/participant.rb', line 91

def wrapup_skipped
  @wrapup_skipped
end

#wrapup_timeout_ms ⇒ Object

Specifies how long a timed ACW session will last.



88
89
90
 
# File 'lib/purecloud/models/participant.rb', line 88

def wrapup_timeout_ms
  @wrapup_timeout_ms
end

Class Method Details

.attribute_map ⇒ Object

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
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
 
# File 'lib/purecloud/models/participant.rb', line 121

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',
    
    :'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',
    
    :'monitored_participant_id' => :'monitoredParticipantId',
    
    :'attributes' => :'attributes',
    
    :'calls' => :'calls',
    
    :'callbacks' => :'callbacks',
    
    :'chats' => :'chats',
    
    :'cobrowsesessions' => :'cobrowsesessions',
    
    :'emails' => :'emails',
    
    :'screenshares' => :'screenshares',
    
    :'social_expressions' => :'socialExpressions',
    
    :'videos' => :'videos',
    
    :'evaluations' => :'evaluations'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloud/models/participant.rb', line 200

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',
    :'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',
    :'monitored_participant_id' => :'String',
    :'attributes' => :'Hash<String, String>',
    :'calls' => :'Array<Call>',
    :'callbacks' => :'Array<Callback>',
    :'chats' => :'Array<ConversationChat>',
    :'cobrowsesessions' => :'Array<Cobrowsesession>',
    :'emails' => :'Array<Email>',
    :'screenshares' => :'Array<Screenshare>',
    :'social_expressions' => :'Array<SocialExpression>',
    :'videos' => :'Array<Video>',
    :'evaluations' => :'Array<Evaluation>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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
 
# File 'lib/purecloud/models/participant.rb', line 425

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 &&
      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 &&
      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 &&
      screenshares == o.screenshares &&
      social_expressions == o.social_expressions &&
      videos == o.videos &&
      evaluations == o.evaluations
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/participant.rb', line 496

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



556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/purecloud/models/participant.rb', line 556

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



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/purecloud/models/participant.rb', line 477

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

Returns:

  • (Boolean)

See Also:

  • `==` method


467
468
469
 
# File 'lib/purecloud/models/participant.rb', line 467

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



472
473
474
 
# File 'lib/purecloud/models/participant.rb', line 472

def hash
  [id, start_time, end_time, connected_time, name, user_uri, user_id, external_contact_id, external_organization_id, queue_id, group_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, monitored_participant_id, attributes, calls, callbacks, chats, cobrowsesessions, emails, screenshares, social_expressions, videos, evaluations].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



539
540
541
 
# File 'lib/purecloud/models/participant.rb', line 539

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



544
545
546
547
548
549
550
551
552
 
# File 'lib/purecloud/models/participant.rb', line 544

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 



534
535
536
 
# File 'lib/purecloud/models/participant.rb', line 534

def to_s
  to_hash.to_s
end