Class: PureCloud::Evaluation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Evaluation

Returns a new instance of Evaluation.



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

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[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'conversation']
    self.conversation = attributes[:'conversation']
  end
  
  if attributes[:'evaluationForm']
    self.evaluation_form = attributes[:'evaluationForm']
  end
  
  if attributes[:'evaluator']
    self.evaluator = attributes[:'evaluator']
  end
  
  if attributes[:'agent']
    self.agent = attributes[:'agent']
  end
  
  if attributes[:'calibration']
    self.calibration = attributes[:'calibration']
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'answers']
    self.answers = attributes[:'answers']
  end
  
  if attributes[:'agentHasRead']
    self.agent_has_read = attributes[:'agentHasRead']
  end
  
  if attributes[:'releaseDate']
    self.release_date = attributes[:'releaseDate']
  end
  
  if attributes[:'assignedDate']
    self.assigned_date = attributes[:'assignedDate']
  end
  
  if attributes[:'changedDate']
    self.changed_date = attributes[:'changedDate']
  end
  
  if attributes[:'queue']
    self.queue = attributes[:'queue']
  end
  
  if attributes[:'neverRelease']
    self.never_release = attributes[:'neverRelease']
  end
  
  if attributes[:'resourceId']
    self.resource_id = attributes[:'resourceId']
  end
  
  if attributes[:'resourceType']
    self.resource_type = attributes[:'resourceType']
  end
  
  if attributes[:'redacted']
    self.redacted = attributes[:'redacted']
  end
  
  if attributes[:'isScoringIndex']
    self.is_scoring_index = attributes[:'isScoringIndex']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#agent ⇒ Object

Returns the value of attribute agent.



33
34
35
 
# File 'lib/purecloud/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/purecloud/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/purecloud/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/purecloud/models/evaluation.rb', line 47

def assigned_date
  @assigned_date
end

#calibration ⇒ Object

Returns the value of attribute calibration.



35
36
37
 
# File 'lib/purecloud/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/purecloud/models/evaluation.rb', line 50

def changed_date
  @changed_date
end

#conversation ⇒ Object

Returns the value of attribute conversation.



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

def conversation
  @conversation
end

#evaluation_form ⇒ Object

Evaluation form used for evaluation.



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

def evaluation_form
  @evaluation_form
end

#evaluator ⇒ Object

Returns the value of attribute evaluator.



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

def evaluator
  @evaluator
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#is_scoring_index ⇒ Object

Returns the value of attribute is_scoring_index.



66
67
68
 
# File 'lib/purecloud/models/evaluation.rb', line 66

def is_scoring_index
  @is_scoring_index
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloud/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.



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

def never_release
  @never_release
end

#queue ⇒ Object

Returns the value of attribute queue.



52
53
54
 
# File 'lib/purecloud/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



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

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/purecloud/models/evaluation.rb', line 44

def release_date
  @release_date
end

#resource_id ⇒ Object

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



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

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.



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

def resource_type
  @resource_type
end

#self_uri ⇒ Object

The URI for this object



69
70
71
 
# File 'lib/purecloud/models/evaluation.rb', line 69

def self_uri
  @self_uri
end

#status ⇒ Object

Returns the value of attribute status.



37
38
39
 
# File 'lib/purecloud/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.



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
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/purecloud/models/evaluation.rb', line 72

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',
    
    :'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.



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

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',
    :'never_release' => :'BOOLEAN',
    :'resource_id' => :'String',
    :'resource_type' => :'String',
    :'redacted' => :'BOOLEAN',
    :'is_scoring_index' => :'BOOLEAN',
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/purecloud/models/evaluation.rb', line 253

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



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

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/purecloud/models/evaluation.rb', line 368

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/purecloud/models/evaluation.rb', line 289

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


279
280
281
 
# File 'lib/purecloud/models/evaluation.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



284
285
286
 
# File 'lib/purecloud/models/evaluation.rb', line 284

def hash
  [id, name, conversation, evaluation_form, evaluator, agent, calibration, status, answers, agent_has_read, release_date, assigned_date, changed_date, queue, never_release, resource_id, resource_type, redacted, is_scoring_index, self_uri].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



351
352
353
 
# File 'lib/purecloud/models/evaluation.rb', line 351

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



356
357
358
359
360
361
362
363
364
 
# File 'lib/purecloud/models/evaluation.rb', line 356

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 



346
347
348
 
# File 'lib/purecloud/models/evaluation.rb', line 346

def to_s
  to_hash.to_s
end