Class: PureCloud::Evaluation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Evaluation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
304
305
306
307
308
309
310
311
312
313
314
315
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
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
420
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 195

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#agent ⇒ Object

Returns the value of attribute agent.



33
34
35
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 33

def agent
  @agent
end

#agent_has_read ⇒ Object

Returns the value of attribute agent_has_read.



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 41

def agent_has_read
  @agent_has_read
end

#answers ⇒ Object

Returns the value of attribute answers.



39
40
41
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 39

def answers
  @answers
end

#assigned_date ⇒ Object

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



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 47

def assigned_date
  @assigned_date
end

#calibration ⇒ Object

Returns the value of attribute calibration.



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 35

def calibration
  @calibration
end

#changed_date ⇒ Object

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



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 50

def changed_date
  @changed_date
end

#conversation ⇒ Object

Returns the value of attribute conversation.



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 26

def conversation
  @conversation
end

#conversation_date ⇒ Object

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



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

def conversation_date
  @conversation_date
end

#conversation_end_date ⇒ Object

End date of conversation if it had completed before evaluation creation. Null if created before the conversation ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def conversation_end_date
  @conversation_end_date
end

#evaluation_form ⇒ Object

Evaluation form used for evaluation.



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 29

def evaluation_form
  @evaluation_form
end

#evaluator ⇒ Object

Returns the value of attribute evaluator.



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

def evaluator
  @evaluator
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#is_scoring_index ⇒ Object

Returns the value of attribute is_scoring_index.



78
79
80
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 78

def is_scoring_index
  @is_scoring_index
end

#media_type ⇒ Object

List of different communication types used in conversation.



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

def media_type
  @media_type
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 24

def name
  @name
end

#never_release ⇒ Object

Signifies if the evaluation is never to be released. This cannot be set true if release date is also set.



67
68
69
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 67

def never_release
  @never_release
end

#queue ⇒ Object

Returns the value of attribute queue.



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

def queue
  @queue
end

#redacted ⇒ Object

Is only true when the user making the request does not have sufficient permissions to see evaluation



76
77
78
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 76

def redacted
  @redacted
end

#release_date ⇒ Object

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



44
45
46
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 44

def release_date
  @release_date
end

#rescore ⇒ Object

Is only true when evaluation is re-scored.



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

def rescore
  @rescore
end

#resource_id ⇒ Object

Only used for email evaluations. Will be null for all other evaluations.



70
71
72
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 70

def resource_id
  @resource_id
end

#resource_type ⇒ Object

The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources.



73
74
75
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 73

def resource_type
  @resource_type
end

#self_uri ⇒ Object

The URI for this object



81
82
83
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 81

def self_uri
  @self_uri
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
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
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 84

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'conversation' => :'conversation',
    
    :'evaluation_form' => :'evaluationForm',
    
    :'evaluator' => :'evaluator',
    
    :'agent' => :'agent',
    
    :'calibration' => :'calibration',
    
    :'status' => :'status',
    
    :'answers' => :'answers',
    
    :'agent_has_read' => :'agentHasRead',
    
    :'release_date' => :'releaseDate',
    
    :'assigned_date' => :'assignedDate',
    
    :'changed_date' => :'changedDate',
    
    :'queue' => :'queue',
    
    :'media_type' => :'mediaType',
    
    :'rescore' => :'rescore',
    
    :'conversation_date' => :'conversationDate',
    
    :'conversation_end_date' => :'conversationEndDate',
    
    :'never_release' => :'neverRelease',
    
    :'resource_id' => :'resourceId',
    
    :'resource_type' => :'resourceType',
    
    :'redacted' => :'redacted',
    
    :'is_scoring_index' => :'isScoringIndex',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'conversation' => :'Conversation',
    
    :'evaluation_form' => :'EvaluationForm',
    
    :'evaluator' => :'User',
    
    :'agent' => :'User',
    
    :'calibration' => :'Calibration',
    
    :'status' => :'String',
    
    :'answers' => :'EvaluationScoringSet',
    
    :'agent_has_read' => :'BOOLEAN',
    
    :'release_date' => :'DateTime',
    
    :'assigned_date' => :'DateTime',
    
    :'changed_date' => :'DateTime',
    
    :'queue' => :'Queue',
    
    :'media_type' => :'Array<String>',
    
    :'rescore' => :'BOOLEAN',
    
    :'conversation_date' => :'DateTime',
    
    :'conversation_end_date' => :'DateTime',
    
    :'never_release' => :'BOOLEAN',
    
    :'resource_id' => :'String',
    
    :'resource_type' => :'String',
    
    :'redacted' => :'BOOLEAN',
    
    :'is_scoring_index' => :'BOOLEAN',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 684

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      conversation == o.conversation &&
      evaluation_form == o.evaluation_form &&
      evaluator == o.evaluator &&
      agent == o.agent &&
      calibration == o.calibration &&
      status == o.status &&
      answers == o.answers &&
      agent_has_read == o.agent_has_read &&
      release_date == o.release_date &&
      assigned_date == o.assigned_date &&
      changed_date == o.changed_date &&
      queue == o.queue &&
      media_type == o.media_type &&
      rescore == o.rescore &&
      conversation_date == o.conversation_date &&
      conversation_end_date == o.conversation_end_date &&
      never_release == o.never_release &&
      resource_id == o.resource_id &&
      resource_type == o.resource_type &&
      redacted == o.redacted &&
      is_scoring_index == o.is_scoring_index &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 745

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



805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 805

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



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 726

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


715
716
717
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 715

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



721
722
723
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 721

def hash
  [id, name, conversation, evaluation_form, evaluator, agent, calibration, status, answers, agent_has_read, release_date, assigned_date, changed_date, queue, media_type, rescore, conversation_date, conversation_end_date, never_release, resource_id, resource_type, redacted, is_scoring_index, self_uri].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



424
425
426
427
428
429
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 424

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



788
789
790
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 788

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



793
794
795
796
797
798
799
800
801
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 793

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 



783
784
785
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 783

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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/purecloudplatformclientv2/models/evaluation.rb', line 433

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["PENDING", "INPROGRESS", "FINISHED"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["EMAIL"]
  if @resource_type && !allowed_values.include?(@resource_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end