Class: PureCloud::AnalyticsConversation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsConversation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 107

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#conversation_end ⇒ Object

Date/time the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 28

def conversation_end
  @conversation_end
end

#conversation_id ⇒ Object

Unique identifier for the conversation



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 22

def conversation_id
  @conversation_id
end

#conversation_start ⇒ Object

Date/time the conversation started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def conversation_start
  @conversation_start
end

#division_ids ⇒ Object

Identifiers of divisions associated with this conversation



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 46

def division_ids
  @division_ids
end

#evaluations ⇒ Object

Evaluations tied to this conversation



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 40

def evaluations
  @evaluations
end

#media_stats_min_conversation_mos ⇒ Object

The lowest estimated average MOS among all the audio streams belonging to this conversation



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

def media_stats_min_conversation_mos
  @media_stats_min_conversation_mos
end

#media_stats_min_conversation_r_factor ⇒ Object

The lowest R-factor value among all of the audio streams belonging to this conversation



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 34

def media_stats_min_conversation_r_factor
  @media_stats_min_conversation_r_factor
end

#originating_direction ⇒ Object

The original direction of the conversation



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

def originating_direction
  @originating_direction
end

#participants ⇒ Object

Participants in the conversation



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

def participants
  @participants
end

#surveys ⇒ Object

Surveys tied to this conversation



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

def surveys
  @surveys
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 52

def self.attribute_map
  {
    
    :'conversation_id' => :'conversationId',
    
    :'conversation_start' => :'conversationStart',
    
    :'conversation_end' => :'conversationEnd',
    
    :'media_stats_min_conversation_mos' => :'mediaStatsMinConversationMos',
    
    :'media_stats_min_conversation_r_factor' => :'mediaStatsMinConversationRFactor',
    
    :'originating_direction' => :'originatingDirection',
    
    :'evaluations' => :'evaluations',
    
    :'surveys' => :'surveys',
    
    :'division_ids' => :'divisionIds',
    
    :'participants' => :'participants'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'conversation_id' => :'String',
    
    :'conversation_start' => :'DateTime',
    
    :'conversation_end' => :'DateTime',
    
    :'media_stats_min_conversation_mos' => :'Float',
    
    :'media_stats_min_conversation_r_factor' => :'Float',
    
    :'originating_direction' => :'String',
    
    :'evaluations' => :'Array<AnalyticsEvaluation>',
    
    :'surveys' => :'Array<AnalyticsSurvey>',
    
    :'division_ids' => :'Array<String>',
    
    :'participants' => :'Array<AnalyticsParticipant>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 336

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      conversation_id == o.conversation_id &&
      conversation_start == o.conversation_start &&
      conversation_end == o.conversation_end &&
      media_stats_min_conversation_mos == o.media_stats_min_conversation_mos &&
      media_stats_min_conversation_r_factor == o.media_stats_min_conversation_r_factor &&
      originating_direction == o.originating_direction &&
      evaluations == o.evaluations &&
      surveys == o.surveys &&
      division_ids == o.division_ids &&
      participants == o.participants
end

#_deserialize(type, value) ⇒ Object 



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

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



443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 443

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 364

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


353
354
355
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 353

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



359
360
361
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 359

def hash
  [conversation_id, conversation_start, conversation_end, media_stats_min_conversation_mos, media_stats_min_conversation_r_factor, originating_direction, evaluations, surveys, division_ids, participants].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



216
217
218
219
220
221
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 216

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



426
427
428
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 426

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



431
432
433
434
435
436
437
438
439
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 431

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 



421
422
423
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 421

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["inbound", "outbound"]
  if @originating_direction && !allowed_values.include?(@originating_direction)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end