Class: PureCloud::AnalyticsSession

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsSession

Returns a new instance of AnalyticsSession.



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

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[:'mediaType']
    self.media_type = attributes[:'mediaType']
  end
  
  if attributes[:'sessionId']
    self.session_id = attributes[:'sessionId']
  end
  
  if attributes[:'addressOther']
    self.address_other = attributes[:'addressOther']
  end
  
  if attributes[:'addressSelf']
    self.address_self = attributes[:'addressSelf']
  end
  
  if attributes[:'ani']
    self.ani = attributes[:'ani']
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'dnis']
    self.dnis = attributes[:'dnis']
  end
  
  if attributes[:'outboundCampaignId']
    self.outbound_campaign_id = attributes[:'outboundCampaignId']
  end
  
  if attributes[:'outboundContactListId']
    self.outbound_contact_list_id = attributes[:'outboundContactListId']
  end
  
  if attributes[:'dispositionAnalyzer']
    self.disposition_analyzer = attributes[:'dispositionAnalyzer']
  end
  
  if attributes[:'dispositionName']
    self.disposition_name = attributes[:'dispositionName']
  end
  
  if attributes[:'edgeId']
    self.edge_id = attributes[:'edgeId']
  end
  
  if attributes[:'remoteNameDisplayable']
    self.remote_name_displayable = attributes[:'remoteNameDisplayable']
  end
  
  if attributes[:'roomId']
    self.room_id = attributes[:'roomId']
  end
  
  if attributes[:'monitoredSessionId']
    self.monitored_session_id = attributes[:'monitoredSessionId']
  end
  
  if attributes[:'monitoredParticipantId']
    self.monitored_participant_id = attributes[:'monitoredParticipantId']
  end
  
  if attributes[:'segments']
    if (value = attributes[:'segments']).is_a?(Array)
      self.segments = value
    end
  end
  
end

Instance Attribute Details

#address_otherObject

Returns the value of attribute address_other.



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

def address_other
  @address_other
end

#address_selfObject

Returns the value of attribute address_self.



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

def address_self
  @address_self
end

#aniObject

Returns the value of attribute ani.



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

def ani
  @ani
end

#directionObject

Returns the value of attribute direction.



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

def direction
  @direction
end

#disposition_analyzerObject

Returns the value of attribute disposition_analyzer.



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

def disposition_analyzer
  @disposition_analyzer
end

#disposition_nameObject

Returns the value of attribute disposition_name.



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

def disposition_name
  @disposition_name
end

#dnisObject

Returns the value of attribute dnis.



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

def dnis
  @dnis
end

#edge_idObject

Returns the value of attribute edge_id.



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

def edge_id
  @edge_id
end

#media_typeObject

Returns the value of attribute media_type.



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

def media_type
  @media_type
end

#monitored_participant_idObject

Returns the value of attribute monitored_participant_id.



51
52
53
# File 'lib/purecloud/models/analytics_session.rb', line 51

def monitored_participant_id
  @monitored_participant_id
end

#monitored_session_idObject

Returns the value of attribute monitored_session_id.



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

def monitored_session_id
  @monitored_session_id
end

#outbound_campaign_idObject

Returns the value of attribute outbound_campaign_id.



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

def outbound_campaign_id
  @outbound_campaign_id
end

#outbound_contact_list_idObject

Returns the value of attribute outbound_contact_list_id.



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

def outbound_contact_list_id
  @outbound_contact_list_id
end

#remote_name_displayableObject

Returns the value of attribute remote_name_displayable.



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

def remote_name_displayable
  @remote_name_displayable
end

#room_idObject

Returns the value of attribute room_id.



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

def room_id
  @room_id
end

#segmentsObject

Returns the value of attribute segments.



53
54
55
# File 'lib/purecloud/models/analytics_session.rb', line 53

def segments
  @segments
end

#session_idObject

Returns the value of attribute session_id.



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

def session_id
  @session_id
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    
    :'media_type' => :'mediaType',
    
    :'session_id' => :'sessionId',
    
    :'address_other' => :'addressOther',
    
    :'address_self' => :'addressSelf',
    
    :'ani' => :'ani',
    
    :'direction' => :'direction',
    
    :'dnis' => :'dnis',
    
    :'outbound_campaign_id' => :'outboundCampaignId',
    
    :'outbound_contact_list_id' => :'outboundContactListId',
    
    :'disposition_analyzer' => :'dispositionAnalyzer',
    
    :'disposition_name' => :'dispositionName',
    
    :'edge_id' => :'edgeId',
    
    :'remote_name_displayable' => :'remoteNameDisplayable',
    
    :'room_id' => :'roomId',
    
    :'monitored_session_id' => :'monitoredSessionId',
    
    :'monitored_participant_id' => :'monitoredParticipantId',
    
    :'segments' => :'segments'
    
  }
end

.swagger_typesObject

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'lib/purecloud/models/analytics_session.rb', line 97

def self.swagger_types
  {
    :'media_type' => :'String',
    :'session_id' => :'String',
    :'address_other' => :'String',
    :'address_self' => :'String',
    :'ani' => :'String',
    :'direction' => :'String',
    :'dnis' => :'String',
    :'outbound_campaign_id' => :'String',
    :'outbound_contact_list_id' => :'String',
    :'disposition_analyzer' => :'String',
    :'disposition_name' => :'String',
    :'edge_id' => :'String',
    :'remote_name_displayable' => :'String',
    :'room_id' => :'String',
    :'monitored_session_id' => :'String',
    :'monitored_participant_id' => :'String',
    :'segments' => :'Array<AnalyticsConversationSegment>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/purecloud/models/analytics_session.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      media_type == o.media_type &&
      session_id == o.session_id &&
      address_other == o.address_other &&
      address_self == o.address_self &&
      ani == o.ani &&
      direction == o.direction &&
      dnis == o.dnis &&
      outbound_campaign_id == o.outbound_campaign_id &&
      outbound_contact_list_id == o.outbound_contact_list_id &&
      disposition_analyzer == o.disposition_analyzer &&
      disposition_name == o.disposition_name &&
      edge_id == o.edge_id &&
      remote_name_displayable == o.remote_name_displayable &&
      room_id == o.room_id &&
      monitored_session_id == o.monitored_session_id &&
      monitored_participant_id == o.monitored_participant_id &&
      segments == o.segments
end

#_deserialize(type, value) ⇒ Object



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

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



330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/purecloud/models/analytics_session.rb', line 330

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/purecloud/models/analytics_session.rb', line 251

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


241
242
243
# File 'lib/purecloud/models/analytics_session.rb', line 241

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



246
247
248
# File 'lib/purecloud/models/analytics_session.rb', line 246

def hash
  [media_type, session_id, address_other, address_self, ani, direction, dnis, outbound_campaign_id, outbound_contact_list_id, disposition_analyzer, disposition_name, edge_id, remote_name_displayable, room_id, monitored_session_id, monitored_participant_id, segments].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



313
314
315
# File 'lib/purecloud/models/analytics_session.rb', line 313

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



318
319
320
321
322
323
324
325
326
# File 'lib/purecloud/models/analytics_session.rb', line 318

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



308
309
310
# File 'lib/purecloud/models/analytics_session.rb', line 308

def to_s
  to_hash.to_s
end