Class: PureCloud::AnalyticsConversationSegment

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/analytics_conversation_segment.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsConversationSegment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 190

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#audio_muted ⇒ Object

Returns the value of attribute audio_muted.



74
75
76
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 74

def audio_muted
  @audio_muted
end

#conference ⇒ Object

Indicates whether the segment was a conference



68
69
70
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 68

def conference
  @conference
end

#destination_conversation_id ⇒ Object

Returns the value of attribute destination_conversation_id.



57
58
59
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 57

def destination_conversation_id
  @destination_conversation_id
end

#destination_session_id ⇒ Object

Returns the value of attribute destination_session_id.



61
62
63
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 61

def destination_session_id
  @destination_session_id
end

#disconnect_type ⇒ Object

A description of the event that disconnected the segment



41
42
43
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 41

def disconnect_type
  @disconnect_type
end

#error_code ⇒ Object

Returns the value of attribute error_code.



38
39
40
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 38

def error_code
  @error_code
end

#group_id ⇒ Object

Returns the value of attribute group_id.



70
71
72
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 70

def group_id
  @group_id
end

#properties ⇒ Object

Returns the value of attribute properties.



53
54
55
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 53

def properties
  @properties
end

#q850_response_codes ⇒ Object

Returns the value of attribute q850_response_codes.



65
66
67
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 65

def q850_response_codes
  @q850_response_codes
end

#queue_id ⇒ Object

Queue identifier



28
29
30
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 28

def queue_id
  @queue_id
end

#requested_language_id ⇒ Object

A unique identifier for the language requested for an interaction.



51
52
53
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 51

def requested_language_id
  @requested_language_id
end

#requested_routing_skill_ids ⇒ Object

Returns the value of attribute requested_routing_skill_ids.



48
49
50
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 48

def requested_routing_skill_ids
  @requested_routing_skill_ids
end

#requested_routing_user_ids ⇒ Object

Returns the value of attribute requested_routing_user_ids.



46
47
48
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 46

def requested_routing_user_ids
  @requested_routing_user_ids
end

#segment_end ⇒ Object

The timestamp when this segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



25
26
27
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 25

def segment_end
  @segment_end
end

#segment_start ⇒ Object

The timestamp when this segment began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



22
23
24
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 22

def segment_start
  @segment_start
end

#segment_type ⇒ Object

The activity taking place for the participant in the segment



44
45
46
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 44

def segment_type
  @segment_type
end

#sip_response_codes ⇒ Object

Returns the value of attribute sip_response_codes.



63
64
65
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 63

def sip_response_codes
  @sip_response_codes
end

#source_conversation_id ⇒ Object

Returns the value of attribute source_conversation_id.



55
56
57
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 55

def source_conversation_id
  @source_conversation_id
end

#source_session_id ⇒ Object

Returns the value of attribute source_session_id.



59
60
61
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 59

def source_session_id
  @source_session_id
end

#subject ⇒ Object

Returns the value of attribute subject.



72
73
74
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 72

def subject
  @subject
end

#video_muted ⇒ Object

Returns the value of attribute video_muted.



76
77
78
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 76

def video_muted
  @video_muted
end

#wrap_up_code ⇒ Object

Wrapup Code id



31
32
33
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 31

def wrap_up_code
  @wrap_up_code
end

#wrap_up_note ⇒ Object

Note entered by an agent during after-call work



34
35
36
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 34

def wrap_up_note
  @wrap_up_note
end

#wrap_up_tags ⇒ Object

Returns the value of attribute wrap_up_tags.



36
37
38
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 36

def wrap_up_tags
  @wrap_up_tags
end

Class Method Details

.attribute_map ⇒ Object

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



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
123
124
125
126
127
128
129
130
131
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 79

def self.attribute_map
  {
    
    :'segment_start' => :'segmentStart',
    
    :'segment_end' => :'segmentEnd',
    
    :'queue_id' => :'queueId',
    
    :'wrap_up_code' => :'wrapUpCode',
    
    :'wrap_up_note' => :'wrapUpNote',
    
    :'wrap_up_tags' => :'wrapUpTags',
    
    :'error_code' => :'errorCode',
    
    :'disconnect_type' => :'disconnectType',
    
    :'segment_type' => :'segmentType',
    
    :'requested_routing_user_ids' => :'requestedRoutingUserIds',
    
    :'requested_routing_skill_ids' => :'requestedRoutingSkillIds',
    
    :'requested_language_id' => :'requestedLanguageId',
    
    :'properties' => :'properties',
    
    :'source_conversation_id' => :'sourceConversationId',
    
    :'destination_conversation_id' => :'destinationConversationId',
    
    :'source_session_id' => :'sourceSessionId',
    
    :'destination_session_id' => :'destinationSessionId',
    
    :'sip_response_codes' => :'sipResponseCodes',
    
    :'q850_response_codes' => :'q850ResponseCodes',
    
    :'conference' => :'conference',
    
    :'group_id' => :'groupId',
    
    :'subject' => :'subject',
    
    :'audio_muted' => :'audioMuted',
    
    :'video_muted' => :'videoMuted'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 134

def self.swagger_types
  {
    
    :'segment_start' => :'DateTime',
    
    :'segment_end' => :'DateTime',
    
    :'queue_id' => :'String',
    
    :'wrap_up_code' => :'String',
    
    :'wrap_up_note' => :'String',
    
    :'wrap_up_tags' => :'Array<String>',
    
    :'error_code' => :'String',
    
    :'disconnect_type' => :'String',
    
    :'segment_type' => :'String',
    
    :'requested_routing_user_ids' => :'Array<String>',
    
    :'requested_routing_skill_ids' => :'Array<String>',
    
    :'requested_language_id' => :'String',
    
    :'properties' => :'Array<AnalyticsProperty>',
    
    :'source_conversation_id' => :'String',
    
    :'destination_conversation_id' => :'String',
    
    :'source_session_id' => :'String',
    
    :'destination_session_id' => :'String',
    
    :'sip_response_codes' => :'Array<Integer>',
    
    :'q850_response_codes' => :'Array<Integer>',
    
    :'conference' => :'BOOLEAN',
    
    :'group_id' => :'String',
    
    :'subject' => :'String',
    
    :'audio_muted' => :'BOOLEAN',
    
    :'video_muted' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 689

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      segment_start == o.segment_start &&
      segment_end == o.segment_end &&
      queue_id == o.queue_id &&
      wrap_up_code == o.wrap_up_code &&
      wrap_up_note == o.wrap_up_note &&
      wrap_up_tags == o.wrap_up_tags &&
      error_code == o.error_code &&
      disconnect_type == o.disconnect_type &&
      segment_type == o.segment_type &&
      requested_routing_user_ids == o.requested_routing_user_ids &&
      requested_routing_skill_ids == o.requested_routing_skill_ids &&
      requested_language_id == o.requested_language_id &&
      properties == o.properties &&
      source_conversation_id == o.source_conversation_id &&
      destination_conversation_id == o.destination_conversation_id &&
      source_session_id == o.source_session_id &&
      destination_session_id == o.destination_session_id &&
      sip_response_codes == o.sip_response_codes &&
      q850_response_codes == o.q850_response_codes &&
      conference == o.conference &&
      group_id == o.group_id &&
      subject == o.subject &&
      audio_muted == o.audio_muted &&
      video_muted == o.video_muted
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 750

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



810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 810

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



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 731

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


720
721
722
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 720

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



726
727
728
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 726

def hash
  [segment_start, segment_end, queue_id, wrap_up_code, wrap_up_note, wrap_up_tags, error_code, disconnect_type, segment_type, requested_routing_user_ids, requested_routing_skill_ids, requested_language_id, properties, source_conversation_id, destination_conversation_id, source_session_id, destination_session_id, sip_response_codes, q850_response_codes, conference, group_id, subject, audio_muted, video_muted].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



429
430
431
432
433
434
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 429

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



793
794
795
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 793

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



798
799
800
801
802
803
804
805
806
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 798

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 



788
789
790
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 788

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



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
 
# File 'lib/purecloudclient_v2a/models/analytics_conversation_segment.rb', line 438

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["endpoint", "client", "system", "transfer", "error", "peer", "other", "spam", "transportFailure", "conferenceTransfer", "consultTransfer", "forwardTransfer", "timeout", "noAnswerTransfer", "notAvailableTransfer", "uncallable"]
  if @disconnect_type && !allowed_values.include?(@disconnect_type)
    return false
  end
  
  
  
  
  
  allowed_values = ["unknown", "alert", "system", "delay", "hold", "interact", "ivr", "dialing", "wrapup", "voicemail", "scheduled", "contacting", "transmitting", "converting", "uploading", "sharing"]
  if @segment_type && !allowed_values.include?(@segment_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end