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



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

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?(:'participants')
    
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
    
    
  
  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

  
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



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

def division_ids
  @division_ids
end

#evaluations ⇒ Object

Evaluations tied to this conversation



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

def evaluations
  @evaluations
end

#participants ⇒ Object

Participants in the conversation



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

def participants
  @participants
end

#surveys ⇒ Object

Surveys tied to this conversation



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

def surveys
  @surveys
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 43

def self.attribute_map
  {
    
    :'conversation_id' => :'conversationId',
    
    :'conversation_start' => :'conversationStart',
    
    :'conversation_end' => :'conversationEnd',
    
    :'participants' => :'participants',
    
    :'evaluations' => :'evaluations',
    
    :'surveys' => :'surveys',
    
    :'division_ids' => :'divisionIds'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 64

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 247

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 &&
      participants == o.participants &&
      evaluations == o.evaluations &&
      surveys == o.surveys &&
      division_ids == o.division_ids
end

#_deserialize(type, value) ⇒ Object 



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

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 351

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 272

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


261
262
263
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



267
268
269
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 267

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



168
169
170
171
172
173
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 168

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



334
335
336
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 334

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



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

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 



329
330
331
 
# File 'lib/purecloudplatformclientv2/models/analytics_conversation.rb', line 329

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end