Class: PureCloud::ConversationEventTopicCallback

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationEventTopicCallback

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



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

def additional_properties
  @additional_properties
end

#after_call_work ⇒ Object

Returns the value of attribute after_call_work.



63
64
65
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 63

def after_call_work
  @after_call_work
end

#after_call_work_required ⇒ Object

Returns the value of attribute after_call_work_required.



65
66
67
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 65

def after_call_work_required
  @after_call_work_required
end

#automated_callback_config_id ⇒ Object

Returns the value of attribute automated_callback_config_id.



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 59

def automated_callback_config_id
  @automated_callback_config_id
end

#callback_numbers ⇒ Object

Returns the value of attribute callback_numbers.



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

def callback_numbers
  @callback_numbers
end

#callback_scheduled_time ⇒ Object

Returns the value of attribute callback_scheduled_time.



57
58
59
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 57

def callback_scheduled_time
  @callback_scheduled_time
end

#callback_user_name ⇒ Object

Returns the value of attribute callback_user_name.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 39

def callback_user_name
  @callback_user_name
end

#connected_time ⇒ Object

Returns the value of attribute connected_time.



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 53

def connected_time
  @connected_time
end

#dialer_preview ⇒ Object

Returns the value of attribute dialer_preview.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 33

def dialer_preview
  @dialer_preview
end

#direction ⇒ Object

Returns the value of attribute direction.



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

def direction
  @direction
end

#disconnect_type ⇒ Object

Returns the value of attribute disconnect_type.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 29

def disconnect_type
  @disconnect_type
end

#disconnected_time ⇒ Object

Returns the value of attribute disconnected_time.



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

def disconnected_time
  @disconnected_time
end

#external_campaign ⇒ Object

Returns the value of attribute external_campaign.



45
46
47
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 45

def external_campaign
  @external_campaign
end

#held ⇒ Object

Returns the value of attribute held.



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 27

def held
  @held
end

#id ⇒ Object

Returns the value of attribute id.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 23

def id
  @id
end

#peer_id ⇒ Object

Returns the value of attribute peer_id.



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

def peer_id
  @peer_id
end

#provider ⇒ Object

Returns the value of attribute provider.



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

def provider
  @provider
end

#script_id ⇒ Object

Returns the value of attribute script_id.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 41

def script_id
  @script_id
end

#skip_enabled ⇒ Object

Returns the value of attribute skip_enabled.



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 47

def skip_enabled
  @skip_enabled
end

#start_hold_time ⇒ Object

Returns the value of attribute start_hold_time.



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

def start_hold_time
  @start_hold_time
end

#state ⇒ Object

Returns the value of attribute state.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 21

def state
  @state
end

#timeout_seconds ⇒ Object

Returns the value of attribute timeout_seconds.



51
52
53
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 51

def timeout_seconds
  @timeout_seconds
end

#voicemail ⇒ Object

Returns the value of attribute voicemail.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 35

def voicemail
  @voicemail
end

#wrapup ⇒ Object

Returns the value of attribute wrapup.



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

def wrapup
  @wrapup
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 70

def self.attribute_map
  {
    
    :'state' => :'state',
    
    :'id' => :'id',
    
    :'direction' => :'direction',
    
    :'held' => :'held',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'dialer_preview' => :'dialerPreview',
    
    :'voicemail' => :'voicemail',
    
    :'callback_numbers' => :'callbackNumbers',
    
    :'callback_user_name' => :'callbackUserName',
    
    :'script_id' => :'scriptId',
    
    :'peer_id' => :'peerId',
    
    :'external_campaign' => :'externalCampaign',
    
    :'skip_enabled' => :'skipEnabled',
    
    :'provider' => :'provider',
    
    :'timeout_seconds' => :'timeoutSeconds',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnected_time' => :'disconnectedTime',
    
    :'callback_scheduled_time' => :'callbackScheduledTime',
    
    :'automated_callback_config_id' => :'automatedCallbackConfigId',
    
    :'wrapup' => :'wrapup',
    
    :'after_call_work' => :'afterCallWork',
    
    :'after_call_work_required' => :'afterCallWorkRequired',
    
    :'additional_properties' => :'additionalProperties'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'state' => :'String',
    
    :'id' => :'String',
    
    :'direction' => :'String',
    
    :'held' => :'BOOLEAN',
    
    :'disconnect_type' => :'String',
    
    :'start_hold_time' => :'DateTime',
    
    :'dialer_preview' => :'ConversationEventTopicDialerPreview',
    
    :'voicemail' => :'ConversationEventTopicVoicemail',
    
    :'callback_numbers' => :'Array<String>',
    
    :'callback_user_name' => :'String',
    
    :'script_id' => :'String',
    
    :'peer_id' => :'String',
    
    :'external_campaign' => :'BOOLEAN',
    
    :'skip_enabled' => :'BOOLEAN',
    
    :'provider' => :'String',
    
    :'timeout_seconds' => :'Integer',
    
    :'connected_time' => :'DateTime',
    
    :'disconnected_time' => :'DateTime',
    
    :'callback_scheduled_time' => :'DateTime',
    
    :'automated_callback_config_id' => :'String',
    
    :'wrapup' => :'ConversationEventTopicWrapup',
    
    :'after_call_work' => :'ConversationEventTopicAfterCallWork',
    
    :'after_call_work_required' => :'BOOLEAN',
    
    :'additional_properties' => :'Object'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      direction == o.direction &&
      held == o.held &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      dialer_preview == o.dialer_preview &&
      voicemail == o.voicemail &&
      callback_numbers == o.callback_numbers &&
      callback_user_name == o.callback_user_name &&
      script_id == o.script_id &&
      peer_id == o.peer_id &&
      external_campaign == o.external_campaign &&
      skip_enabled == o.skip_enabled &&
      provider == o.provider &&
      timeout_seconds == o.timeout_seconds &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      callback_scheduled_time == o.callback_scheduled_time &&
      automated_callback_config_id == o.automated_callback_config_id &&
      wrapup == o.wrapup &&
      after_call_work == o.after_call_work &&
      after_call_work_required == o.after_call_work_required &&
      additional_properties == o.additional_properties
end

#_deserialize(type, value) ⇒ Object 



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

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



805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 805

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



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 726

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


715
716
717
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 715

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



721
722
723
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 721

def hash
  [state, id, direction, held, disconnect_type, start_hold_time, dialer_preview, voicemail, callback_numbers, callback_user_name, script_id, peer_id, external_campaign, skip_enabled, provider, timeout_seconds, connected_time, disconnected_time, callback_scheduled_time, automated_callback_config_id, wrapup, after_call_work, after_call_work_required, additional_properties].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



410
411
412
413
414
415
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 410

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



788
789
790
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 788

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



793
794
795
796
797
798
799
800
801
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 793

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 



783
784
785
 
# File 'lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb', line 783

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



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

def valid?
  
  
  
  allowed_values = ["ALERTING", "DIALING", "CONTACTING", "OFFERING", "CONNECTED", "DISCONNECTED", "TERMINATED", "SCHEDULED", "UPLOADING", "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", "TIMEOUT", "TRANSFER", "TRANSFER_CONFERENCE", "TRANSFER_CONSULT", "TRANSFER_NOANSWER", "TRANSFER_NOTAVAILABLE", "TRANSFER_FORWARD", "TRANSPORT_FAILURE", "ERROR", "PEER", "OTHER", "SPAM", "UNCALLABLE"]
  if @disconnect_type && !allowed_values.include?(@disconnect_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end