Class: PureCloud::CallConversationNotificationParticipants

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CallConversationNotificationParticipants

Returns a new instance of CallConversationNotificationParticipants.



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
351
352
353
354
355
356
357
358
359
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 210

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

Instance Attribute Details

#addressObject

Returns the value of attribute address.



77
78
79
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 77

def address
  @address
end

#aniObject

Returns the value of attribute ani.



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

def ani
  @ani
end

#attributesObject

Returns the value of attribute attributes.



83
84
85
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 83

def attributes
  @attributes
end

#confinedObject

Returns the value of attribute confined.



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

def confined
  @confined
end

#connected_timeObject

Returns the value of attribute connected_time.



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

def connected_time
  @connected_time
end

#consult_participant_idObject

Returns the value of attribute consult_participant_id.



29
30
31
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 29

def consult_participant_id
  @consult_participant_id
end

#directionObject

Returns the value of attribute direction.



31
32
33
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 31

def direction
  @direction
end

#disconnect_typeObject

Returns the value of attribute disconnect_type.



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

def disconnect_type
  @disconnect_type
end

#dnisObject

Returns the value of attribute dnis.



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

def dnis
  @dnis
end

#document_idObject

Returns the value of attribute document_id.



89
90
91
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 89

def document_id
  @document_id
end

#end_timeObject

Returns the value of attribute end_time.



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

def end_time
  @end_time
end

#error_infoObject

Returns the value of attribute error_info.



25
26
27
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 25

def error_info
  @error_info
end

#external_contactObject

Returns the value of attribute external_contact.



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

def external_contact
  @external_contact
end

#external_organizationObject

Returns the value of attribute external_organization.



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

def external_organization
  @external_organization
end

#fax_statusObject

Returns the value of attribute fax_status.



65
66
67
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 65

def fax_status
  @fax_status
end

#groupObject

Returns the value of attribute group.



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

def group
  @group
end

#heldObject

Returns the value of attribute held.



59
60
61
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 59

def held
  @held
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#monitored_participant_idObject

Returns the value of attribute monitored_participant_id.



41
42
43
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 41

def monitored_participant_id
  @monitored_participant_id
end

#mutedObject

Returns the value of attribute muted.



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

def muted
  @muted
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#providerObject

Returns the value of attribute provider.



71
72
73
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 71

def provider
  @provider
end

#purposeObject

Returns the value of attribute purpose.



37
38
39
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 37

def purpose
  @purpose
end

#queueObject

Returns the value of attribute queue.



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

def queue
  @queue
end

#recordingObject

Returns the value of attribute recording.



23
24
25
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 23

def recording
  @recording
end

#recording_stateObject

Returns the value of attribute recording_state.



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

def recording_state
  @recording_state
end

#scriptObject

Returns the value of attribute script.



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

def script
  @script
end

#start_hold_timeObject

Returns the value of attribute start_hold_time.



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

def start_hold_time
  @start_hold_time
end

#start_timeObject

Returns the value of attribute start_time.



43
44
45
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 43

def start_time
  @start_time
end

#stateObject

Returns the value of attribute state.



35
36
37
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 35

def state
  @state
end

#userObject

Returns the value of attribute user.



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

def user
  @user
end

#wrapup_promptObject

Returns the value of attribute wrapup_prompt.



47
48
49
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 47

def wrapup_prompt
  @wrapup_prompt
end

#wrapup_requiredObject

Returns the value of attribute wrapup_required.



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

def wrapup_required
  @wrapup_required
end

#wrapup_skippedObject

Returns the value of attribute wrapup_skipped.



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

def wrapup_skipped
  @wrapup_skipped
end

#wrapup_timeout_msObject

Returns the value of attribute wrapup_timeout_ms.



53
54
55
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 53

def wrapup_timeout_ms
  @wrapup_timeout_ms
end

Class Method Details

.attribute_mapObject

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



92
93
94
95
96
97
98
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
166
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 92

def self.attribute_map
  {
    
    :'queue' => :'queue',
    
    :'recording' => :'recording',
    
    :'error_info' => :'errorInfo',
    
    :'connected_time' => :'connectedTime',
    
    :'consult_participant_id' => :'consultParticipantId',
    
    :'direction' => :'direction',
    
    :'wrapup_skipped' => :'wrapupSkipped',
    
    :'state' => :'state',
    
    :'purpose' => :'purpose',
    
    :'end_time' => :'endTime',
    
    :'monitored_participant_id' => :'monitoredParticipantId',
    
    :'start_time' => :'startTime',
    
    :'id' => :'id',
    
    :'wrapup_prompt' => :'wrapupPrompt',
    
    :'name' => :'name',
    
    :'confined' => :'confined',
    
    :'wrapup_timeout_ms' => :'wrapupTimeoutMs',
    
    :'external_organization' => :'externalOrganization',
    
    :'dnis' => :'dnis',
    
    :'held' => :'held',
    
    :'ani' => :'ani',
    
    :'muted' => :'muted',
    
    :'fax_status' => :'faxStatus',
    
    :'wrapup_required' => :'wrapupRequired',
    
    :'external_contact' => :'externalContact',
    
    :'provider' => :'provider',
    
    :'script' => :'script',
    
    :'disconnect_type' => :'disconnectType',
    
    :'address' => :'address',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'recording_state' => :'recordingState',
    
    :'attributes' => :'attributes',
    
    :'group' => :'group',
    
    :'user' => :'user',
    
    :'document_id' => :'documentId'
    
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'queue' => :'CallConversationNotificationUriReference',
    :'recording' => :'BOOLEAN',
    :'error_info' => :'CallConversationNotificationErrorInfo',
    :'connected_time' => :'DateTime',
    :'consult_participant_id' => :'String',
    :'direction' => :'String',
    :'wrapup_skipped' => :'BOOLEAN',
    :'state' => :'String',
    :'purpose' => :'String',
    :'end_time' => :'DateTime',
    :'monitored_participant_id' => :'String',
    :'start_time' => :'DateTime',
    :'id' => :'String',
    :'wrapup_prompt' => :'String',
    :'name' => :'String',
    :'confined' => :'BOOLEAN',
    :'wrapup_timeout_ms' => :'Integer',
    :'external_organization' => :'CallConversationNotificationUriReference',
    :'dnis' => :'String',
    :'held' => :'BOOLEAN',
    :'ani' => :'String',
    :'muted' => :'BOOLEAN',
    :'fax_status' => :'CallConversationNotificationFaxStatus',
    :'wrapup_required' => :'BOOLEAN',
    :'external_contact' => :'CallConversationNotificationUriReference',
    :'provider' => :'String',
    :'script' => :'CallConversationNotificationUriReference',
    :'disconnect_type' => :'String',
    :'address' => :'String',
    :'start_hold_time' => :'DateTime',
    :'recording_state' => :'String',
    :'attributes' => :'Hash<String, String>',
    :'group' => :'CallConversationNotificationUriReference',
    :'user' => :'DocumentDataV2NotificationCreatedBy',
    :'document_id' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      queue == o.queue &&
      recording == o.recording &&
      error_info == o.error_info &&
      connected_time == o.connected_time &&
      consult_participant_id == o.consult_participant_id &&
      direction == o.direction &&
      wrapup_skipped == o.wrapup_skipped &&
      state == o.state &&
      purpose == o.purpose &&
      end_time == o.end_time &&
      monitored_participant_id == o.monitored_participant_id &&
      start_time == o.start_time &&
      id == o.id &&
      wrapup_prompt == o.wrapup_prompt &&
      name == o.name &&
      confined == o.confined &&
      wrapup_timeout_ms == o.wrapup_timeout_ms &&
      external_organization == o.external_organization &&
      dnis == o.dnis &&
      held == o.held &&
      ani == o.ani &&
      muted == o.muted &&
      fax_status == o.fax_status &&
      wrapup_required == o.wrapup_required &&
      external_contact == o.external_contact &&
      provider == o.provider &&
      script == o.script &&
      disconnect_type == o.disconnect_type &&
      address == o.address &&
      start_hold_time == o.start_hold_time &&
      recording_state == o.recording_state &&
      attributes == o.attributes &&
      group == o.group &&
      user == o.user &&
      document_id == o.document_id
end

#_deserialize(type, value) ⇒ Object



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

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



528
529
530
531
532
533
534
535
536
537
538
539
540
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 528

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



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 449

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


439
440
441
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 439

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



444
445
446
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 444

def hash
  [queue, recording, error_info, connected_time, consult_participant_id, direction, wrapup_skipped, state, purpose, end_time, monitored_participant_id, start_time, id, wrapup_prompt, name, confined, wrapup_timeout_ms, external_organization, dnis, held, ani, muted, fax_status, wrapup_required, external_contact, provider, script, disconnect_type, address, start_hold_time, recording_state, attributes, group, user, document_id].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



511
512
513
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 511

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



516
517
518
519
520
521
522
523
524
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 516

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_sObject



506
507
508
# File 'lib/purecloud/models/call_conversation_notification_participants.rb', line 506

def to_s
  to_hash.to_s
end