Class: PureCloud::AnalyticsConversationSegment

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsConversationSegment

Returns a new instance of AnalyticsConversationSegment.



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

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[:'segmentStart']
    self.segment_start = attributes[:'segmentStart']
  end
  
  if attributes[:'segmentEnd']
    self.segment_end = attributes[:'segmentEnd']
  end
  
  if attributes[:'queueId']
    self.queue_id = attributes[:'queueId']
  end
  
  if attributes[:'wrapUpCode']
    self.wrap_up_code = attributes[:'wrapUpCode']
  end
  
  if attributes[:'wrapUpNote']
    self.wrap_up_note = attributes[:'wrapUpNote']
  end
  
  if attributes[:'wrapUpTags']
    if (value = attributes[:'wrapUpTags']).is_a?(Array)
      self.wrap_up_tags = value
    end
  end
  
  if attributes[:'errorCode']
    self.error_code = attributes[:'errorCode']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'segmentType']
    self.segment_type = attributes[:'segmentType']
  end
  
  if attributes[:'requestedRoutingUserIds']
    if (value = attributes[:'requestedRoutingUserIds']).is_a?(Array)
      self.requested_routing_user_ids = value
    end
  end
  
  if attributes[:'requestedRoutingSkillIds']
    if (value = attributes[:'requestedRoutingSkillIds']).is_a?(Array)
      self.requested_routing_skill_ids = value
    end
  end
  
  if attributes[:'requestedLanguageId']
    self.requested_language_id = attributes[:'requestedLanguageId']
  end
  
  if attributes[:'properties']
    if (value = attributes[:'properties']).is_a?(Array)
      self.properties = value
    end
  end
  
  if attributes[:'sourceConversationId']
    self.source_conversation_id = attributes[:'sourceConversationId']
  end
  
  if attributes[:'destinationConversationId']
    self.destination_conversation_id = attributes[:'destinationConversationId']
  end
  
  if attributes[:'sourceSessionId']
    self.source_session_id = attributes[:'sourceSessionId']
  end
  
  if attributes[:'destinationSessionId']
    self.destination_session_id = attributes[:'destinationSessionId']
  end
  
  if attributes[:'sipResponseCodes']
    if (value = attributes[:'sipResponseCodes']).is_a?(Array)
      self.sip_response_codes = value
    end
  end
  
  if attributes[:'q850ResponseCodes']
    if (value = attributes[:'q850ResponseCodes']).is_a?(Array)
      self.q850_response_codes = value
    end
  end
  
  if attributes[:'conference']
    self.conference = attributes[:'conference']
  else
    self.conference = false
  end
  
  if attributes[:'groupId']
    self.group_id = attributes[:'groupId']
  end
  
  if attributes[:'subject']
    self.subject = attributes[:'subject']
  end
  
end

Instance Attribute Details

#conferenceObject

Returns the value of attribute conference.



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

def conference
  @conference
end

#destination_conversation_idObject

Returns the value of attribute destination_conversation_id.



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

def destination_conversation_id
  @destination_conversation_id
end

#destination_session_idObject

Returns the value of attribute destination_session_id.



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

def destination_session_id
  @destination_session_id
end

#disconnect_typeObject

Returns the value of attribute disconnect_type.



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

def disconnect_type
  @disconnect_type
end

#error_codeObject

Returns the value of attribute error_code.



19
20
21
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 19

def error_code
  @error_code
end

#group_idObject

Returns the value of attribute group_id.



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

def group_id
  @group_id
end

#propertiesObject

Returns the value of attribute properties.



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

def properties
  @properties
end

#q850_response_codesObject

Returns the value of attribute q850_response_codes.



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

def q850_response_codes
  @q850_response_codes
end

#queue_idObject

Returns the value of attribute queue_id.



11
12
13
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 11

def queue_id
  @queue_id
end

#requested_language_idObject

Returns the value of attribute requested_language_id.



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

def requested_language_id
  @requested_language_id
end

#requested_routing_skill_idsObject

Returns the value of attribute requested_routing_skill_ids.



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

def requested_routing_skill_ids
  @requested_routing_skill_ids
end

#requested_routing_user_idsObject

Returns the value of attribute requested_routing_user_ids.



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

def requested_routing_user_ids
  @requested_routing_user_ids
end

#segment_endObject

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



9
10
11
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 9

def segment_end
  @segment_end
end

#segment_startObject

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



6
7
8
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 6

def segment_start
  @segment_start
end

#segment_typeObject

Returns the value of attribute segment_type.



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

def segment_type
  @segment_type
end

#sip_response_codesObject

Returns the value of attribute sip_response_codes.



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

def sip_response_codes
  @sip_response_codes
end

#source_conversation_idObject

Returns the value of attribute source_conversation_id.



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

def source_conversation_id
  @source_conversation_id
end

#source_session_idObject

Returns the value of attribute source_session_id.



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

def source_session_id
  @source_session_id
end

#subjectObject

Returns the value of attribute subject.



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

def subject
  @subject
end

#wrap_up_codeObject

Returns the value of attribute wrap_up_code.



13
14
15
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 13

def wrap_up_code
  @wrap_up_code
end

#wrap_up_noteObject

Returns the value of attribute wrap_up_note.



15
16
17
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 15

def wrap_up_note
  @wrap_up_note
end

#wrap_up_tagsObject

Returns the value of attribute wrap_up_tags.



17
18
19
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 17

def wrap_up_tags
  @wrap_up_tags
end

Class Method Details

.attribute_mapObject

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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 52

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'
    
  }
end

.swagger_typesObject

Attribute type mapping.



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

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'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



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

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
end

#_deserialize(type, value) ⇒ Object



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

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 =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  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



375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 375

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 299

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


289
290
291
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 289

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



294
295
296
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 294

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].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



358
359
360
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 358

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



363
364
365
366
367
368
369
370
371
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 363

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



353
354
355
# File 'lib/purecloud/models/analytics_conversation_segment.rb', line 353

def to_s
  to_hash.to_s
end