Class: PureCloud::ObservationValue

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ObservationValue

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  
  if attributes.has_key?(:'sessionId')
    
    
    self.session_id = attributes[:'sessionId']
    
  
  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?(:'routingPriority')
    
    
    self.routing_priority = attributes[:'routingPriority']
    
  
  end

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#address_from ⇒ Object

The address that initiated an action



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 55

def address_from
  @address_from
end

#address_to ⇒ Object

The address receiving an action



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 58

def address_to
  @address_to
end

#ani ⇒ Object

Automatic Number Identification (caller’s number)



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 61

def ani
  @ani
end

#conversation_id ⇒ Object

Unique identifier for the conversation



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

def conversation_id
  @conversation_id
end

#converted_from ⇒ Object

Session media type that was converted from in case of a media type conversion



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

def converted_from
  @converted_from
end

#converted_to ⇒ Object

Session media type that was converted to in case of a media type conversion



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 52

def converted_to
  @converted_to
end

#direction ⇒ Object

The direction of the communication



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

def direction
  @direction
end

#dnis ⇒ Object

Dialed number identification service (number dialed by the calling party)



64
65
66
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 64

def dnis
  @dnis
end

#observation_date ⇒ Object

The time at which the observation occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def observation_date
  @observation_date
end

#participant_name ⇒ Object

A human readable name identifying the participant



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

def participant_name
  @participant_name
end

#requested_language_id ⇒ Object

Unique identifier for the language requested for an interaction



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

def requested_language_id
  @requested_language_id
end

#requested_routing_skill_ids ⇒ Object

Unique identifier for a skill requested for an interaction



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

def requested_routing_skill_ids
  @requested_routing_skill_ids
end

#routing_priority ⇒ Object

Routing priority for the current interaction



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

def routing_priority
  @routing_priority
end

#scored_agents ⇒ Object

Returns the value of attribute scored_agents.



66
67
68
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 66

def scored_agents
  @scored_agents
end

#session_id ⇒ Object

The unique identifier of this session



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

def session_id
  @session_id
end

#user_id ⇒ Object

Unique identifier for the user



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



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
101
102
103
104
105
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 69

def self.attribute_map
  {
    
    :'observation_date' => :'observationDate',
    
    :'conversation_id' => :'conversationId',
    
    :'session_id' => :'sessionId',
    
    :'requested_routing_skill_ids' => :'requestedRoutingSkillIds',
    
    :'requested_language_id' => :'requestedLanguageId',
    
    :'routing_priority' => :'routingPriority',
    
    :'participant_name' => :'participantName',
    
    :'user_id' => :'userId',
    
    :'direction' => :'direction',
    
    :'converted_from' => :'convertedFrom',
    
    :'converted_to' => :'convertedTo',
    
    :'address_from' => :'addressFrom',
    
    :'address_to' => :'addressTo',
    
    :'ani' => :'ani',
    
    :'dnis' => :'dnis',
    
    :'scored_agents' => :'scoredAgents'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'observation_date' => :'DateTime',
    
    :'conversation_id' => :'String',
    
    :'session_id' => :'String',
    
    :'requested_routing_skill_ids' => :'Array<String>',
    
    :'requested_language_id' => :'String',
    
    :'routing_priority' => :'Integer',
    
    :'participant_name' => :'String',
    
    :'user_id' => :'String',
    
    :'direction' => :'String',
    
    :'converted_from' => :'String',
    
    :'converted_to' => :'String',
    
    :'address_from' => :'String',
    
    :'address_to' => :'String',
    
    :'ani' => :'String',
    
    :'dnis' => :'String',
    
    :'scored_agents' => :'Array<AnalyticsScoredAgent>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 486

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      observation_date == o.observation_date &&
      conversation_id == o.conversation_id &&
      session_id == o.session_id &&
      requested_routing_skill_ids == o.requested_routing_skill_ids &&
      requested_language_id == o.requested_language_id &&
      routing_priority == o.routing_priority &&
      participant_name == o.participant_name &&
      user_id == o.user_id &&
      direction == o.direction &&
      converted_from == o.converted_from &&
      converted_to == o.converted_to &&
      address_from == o.address_from &&
      address_to == o.address_to &&
      ani == o.ani &&
      dnis == o.dnis &&
      scored_agents == o.scored_agents
end

#_deserialize(type, value) ⇒ Object 



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 539

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



599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 599

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



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 520

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


509
510
511
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 509

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



515
516
517
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 515

def hash
  [observation_date, conversation_id, session_id, requested_routing_skill_ids, requested_language_id, routing_priority, participant_name, user_id, direction, converted_from, converted_to, address_from, address_to, ani, dnis, scored_agents].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



307
308
309
310
311
312
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 307

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



582
583
584
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 582

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



587
588
589
590
591
592
593
594
595
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 587

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 



577
578
579
 
# File 'lib/purecloudplatformclientv2/models/observation_value.rb', line 577

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



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

def valid?
  
  
  if @observation_date.nil?
    return false
  end

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