Class: PureCloud::CallMediaParticipant

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallMediaParticipant

Returns a new instance of CallMediaParticipant.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
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
 
# File 'lib/purecloud/models/call_media_participant.rb', line 205

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[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'address']
    self.address = attributes[:'address']
  end
  
  if attributes[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'startHoldTime']
    self.start_hold_time = attributes[:'startHoldTime']
  end
  
  if attributes[:'purpose']
    self.purpose = attributes[:'purpose']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  else
    self.held = false
  end
  
  if attributes[:'wrapupRequired']
    self.wrapup_required = attributes[:'wrapupRequired']
  else
    self.wrapup_required = false
  end
  
  if attributes[:'wrapupPrompt']
    self.wrapup_prompt = attributes[:'wrapupPrompt']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'queue']
    self.queue = attributes[:'queue']
  end
  
  if attributes[:'attributes']
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end
  
  if attributes[:'errorInfo']
    self.error_info = attributes[:'errorInfo']
  end
  
  if attributes[:'script']
    self.script = attributes[:'script']
  end
  
  if attributes[:'wrapupTimeoutMs']
    self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs']
  end
  
  if attributes[:'wrapupSkipped']
    self.wrapup_skipped = attributes[:'wrapupSkipped']
  else
    self.wrapup_skipped = false
  end
  
  if attributes[:'muted']
    self.muted = attributes[:'muted']
  else
    self.muted = false
  end
  
  if attributes[:'confined']
    self.confined = attributes[:'confined']
  else
    self.confined = false
  end
  
  if attributes[:'recording']
    self.recording = attributes[:'recording']
  else
    self.recording = false
  end
  
  if attributes[:'recordingState']
    self.recording_state = attributes[:'recordingState']
  end
  
  if attributes[:'group']
    self.group = attributes[:'group']
  end
  
  if attributes[:'ani']
    self.ani = attributes[:'ani']
  end
  
  if attributes[:'dnis']
    self.dnis = attributes[:'dnis']
  end
  
  if attributes[:'documentId']
    self.document_id = attributes[:'documentId']
  end
  
  if attributes[:'monitoredParticipantId']
    self.monitored_participant_id = attributes[:'monitoredParticipantId']
  end
  
  if attributes[:'consultParticipantId']
    self.consult_participant_id = attributes[:'consultParticipantId']
  end
  
end

Instance Attribute Details

#address ⇒ Object

The participant address.



12
13
14
 
# File 'lib/purecloud/models/call_media_participant.rb', line 12

def address
  @address
end

#ani ⇒ Object

The call ANI.



84
85
86
 
# File 'lib/purecloud/models/call_media_participant.rb', line 84

def ani
  @ani
end

#attributes ⇒ Object

A list of ad-hoc attributes for the participant.



54
55
56
 
# File 'lib/purecloud/models/call_media_participant.rb', line 54

def attributes
  @attributes
end

#confined ⇒ Object

Value is true when the call is confined.



72
73
74
 
# File 'lib/purecloud/models/call_media_participant.rb', line 72

def confined
  @confined
end

#connected_time ⇒ Object

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



18
19
20
 
# File 'lib/purecloud/models/call_media_participant.rb', line 18

def connected_time
  @connected_time
end

#consult_participant_id ⇒ Object

The ID of the consult transfer target participant when performing a consult transfer.



96
97
98
 
# File 'lib/purecloud/models/call_media_participant.rb', line 96

def consult_participant_id
  @consult_participant_id
end

#direction ⇒ Object

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



33
34
35
 
# File 'lib/purecloud/models/call_media_participant.rb', line 33

def direction
  @direction
end

#disconnect_type ⇒ Object

The reason the participant was disconnected from the conversation.



36
37
38
 
# File 'lib/purecloud/models/call_media_participant.rb', line 36

def disconnect_type
  @disconnect_type
end

#dnis ⇒ Object

The call DNIS.



87
88
89
 
# File 'lib/purecloud/models/call_media_participant.rb', line 87

def dnis
  @dnis
end

#document_id ⇒ Object

The ID of the Content Management document if the call is a fax.



90
91
92
 
# File 'lib/purecloud/models/call_media_participant.rb', line 90

def document_id
  @document_id
end

#end_time ⇒ Object

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



21
22
23
 
# File 'lib/purecloud/models/call_media_participant.rb', line 21

def end_time
  @end_time
end

#error_info ⇒ Object

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



57
58
59
 
# File 'lib/purecloud/models/call_media_participant.rb', line 57

def error_info
  @error_info
end

#group ⇒ Object

The group involved in the group ring call.



81
82
83
 
# File 'lib/purecloud/models/call_media_participant.rb', line 81

def group
  @group
end

#held ⇒ Object

Value is true when the participant is on hold.



39
40
41
 
# File 'lib/purecloud/models/call_media_participant.rb', line 39

def held
  @held
end

#id ⇒ Object

The unique participant ID.



6
7
8
 
# File 'lib/purecloud/models/call_media_participant.rb', line 6

def id
  @id
end

#monitored_participant_id ⇒ Object

The ID of the participant being monitored when performing a call monitor.



93
94
95
 
# File 'lib/purecloud/models/call_media_participant.rb', line 93

def monitored_participant_id
  @monitored_participant_id
end

#muted ⇒ Object

Value is true when the call is muted.



69
70
71
 
# File 'lib/purecloud/models/call_media_participant.rb', line 69

def muted
  @muted
end

#name ⇒ Object

The display friendly name of the participant.



9
10
11
 
# File 'lib/purecloud/models/call_media_participant.rb', line 9

def name
  @name
end

#purpose ⇒ Object

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



27
28
29
 
# File 'lib/purecloud/models/call_media_participant.rb', line 27

def purpose
  @purpose
end

#queue ⇒ Object

The PureCloud queue for this participant.



51
52
53
 
# File 'lib/purecloud/models/call_media_participant.rb', line 51

def queue
  @queue
end

#recording ⇒ Object

Value is true when the call is being recorded.



75
76
77
 
# File 'lib/purecloud/models/call_media_participant.rb', line 75

def recording
  @recording
end

#recording_state ⇒ Object

The state of the call recording.



78
79
80
 
# File 'lib/purecloud/models/call_media_participant.rb', line 78

def recording_state
  @recording_state
end

#script ⇒ Object

The Engage script that should be used by this participant.



60
61
62
 
# File 'lib/purecloud/models/call_media_participant.rb', line 60

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



24
25
26
 
# File 'lib/purecloud/models/call_media_participant.rb', line 24

def start_hold_time
  @start_hold_time
end

#start_time ⇒ Object

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



15
16
17
 
# File 'lib/purecloud/models/call_media_participant.rb', line 15

def start_time
  @start_time
end

#state ⇒ Object

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



30
31
32
 
# File 'lib/purecloud/models/call_media_participant.rb', line 30

def state
  @state
end

#user ⇒ Object

The PureCloud user for this participant.



48
49
50
 
# File 'lib/purecloud/models/call_media_participant.rb', line 48

def user
  @user
end

#wrapup_prompt ⇒ Object

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



45
46
47
 
# File 'lib/purecloud/models/call_media_participant.rb', line 45

def wrapup_prompt
  @wrapup_prompt
end

#wrapup_required ⇒ Object

Value is true when the participant requires wrap-up.



42
43
44
 
# File 'lib/purecloud/models/call_media_participant.rb', line 42

def wrapup_required
  @wrapup_required
end

#wrapup_skipped ⇒ Object

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



66
67
68
 
# File 'lib/purecloud/models/call_media_participant.rb', line 66

def wrapup_skipped
  @wrapup_skipped
end

#wrapup_timeout_ms ⇒ Object

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



63
64
65
 
# File 'lib/purecloud/models/call_media_participant.rb', line 63

def wrapup_timeout_ms
  @wrapup_timeout_ms
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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
 
# File 'lib/purecloud/models/call_media_participant.rb', line 99

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',
    
    :'attributes' => :'attributes',
    
    :'error_info' => :'errorInfo',
    
    :'script' => :'script',
    
    :'wrapup_timeout_ms' => :'wrapupTimeoutMs',
    
    :'wrapup_skipped' => :'wrapupSkipped',
    
    :'muted' => :'muted',
    
    :'confined' => :'confined',
    
    :'recording' => :'recording',
    
    :'recording_state' => :'recordingState',
    
    :'group' => :'group',
    
    :'ani' => :'ani',
    
    :'dnis' => :'dnis',
    
    :'document_id' => :'documentId',
    
    :'monitored_participant_id' => :'monitoredParticipantId',
    
    :'consult_participant_id' => :'consultParticipantId'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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' => :'UriReference',
    :'queue' => :'UriReference',
    :'attributes' => :'Hash<String, String>',
    :'error_info' => :'ErrorBody',
    :'script' => :'UriReference',
    :'wrapup_timeout_ms' => :'Integer',
    :'wrapup_skipped' => :'BOOLEAN',
    :'muted' => :'BOOLEAN',
    :'confined' => :'BOOLEAN',
    :'recording' => :'BOOLEAN',
    :'recording_state' => :'String',
    :'group' => :'UriReference',
    :'ani' => :'String',
    :'dnis' => :'String',
    :'document_id' => :'String',
    :'monitored_participant_id' => :'String',
    :'consult_participant_id' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

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 &&
      attributes == o.attributes &&
      error_info == o.error_info &&
      script == o.script &&
      wrapup_timeout_ms == o.wrapup_timeout_ms &&
      wrapup_skipped == o.wrapup_skipped &&
      muted == o.muted &&
      confined == o.confined &&
      recording == o.recording &&
      recording_state == o.recording_state &&
      group == o.group &&
      ani == o.ani &&
      dnis == o.dnis &&
      document_id == o.document_id &&
      monitored_participant_id == o.monitored_participant_id &&
      consult_participant_id == o.consult_participant_id
end

#_deserialize(type, value) ⇒ Object 



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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/purecloud/models/call_media_participant.rb', line 512

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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/purecloud/models/call_media_participant.rb', line 436

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


426
427
428
 
# File 'lib/purecloud/models/call_media_participant.rb', line 426

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



431
432
433
 
# File 'lib/purecloud/models/call_media_participant.rb', line 431

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, attributes, error_info, script, wrapup_timeout_ms, wrapup_skipped, muted, confined, recording, recording_state, group, ani, dnis, document_id, monitored_participant_id, consult_participant_id].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



495
496
497
 
# File 'lib/purecloud/models/call_media_participant.rb', line 495

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



500
501
502
503
504
505
506
507
508
 
# File 'lib/purecloud/models/call_media_participant.rb', line 500

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 



490
491
492
 
# File 'lib/purecloud/models/call_media_participant.rb', line 490

def to_s
  to_hash.to_s
end