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.



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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/purecloud/models/evaluation.rb', line 123

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']
  else
    self.agent_has_read = false
  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[:'resourceId']
    self.resource_id = attributes[:'resourceId']
  end
  
  if attributes[:'resourceType']
    self.resource_type = attributes[:'resourceType']
  end
  
  if attributes[:'redacted']
    self.redacted = attributes[:'redacted']
  else
    self.redacted = false
  end
  
  if attributes[:'isScoringIndex']
    self.is_scoring_index = attributes[:'isScoringIndex']
  else
    self.is_scoring_index = false
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end

Instance Attribute Details

#agentObject

Returns the value of attribute agent.



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

def agent
  @agent
end

#agent_has_readObject

Returns the value of attribute agent_has_read.



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

def agent_has_read
  @agent_has_read
end

#answersObject

Returns the value of attribute answers.



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

def answers
  @answers
end

#assigned_dateObject

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



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

def assigned_date
  @assigned_date
end

#calibrationObject

Returns the value of attribute calibration.



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

def calibration
  @calibration
end

#changed_dateObject

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



34
35
36
# File 'lib/purecloud/models/evaluation.rb', line 34

def changed_date
  @changed_date
end

#conversationObject

Returns the value of attribute conversation.



10
11
12
# File 'lib/purecloud/models/evaluation.rb', line 10

def conversation
  @conversation
end

#evaluation_formObject

Evaluation form used for evaluation.



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

def evaluation_form
  @evaluation_form
end

#evaluatorObject

Returns the value of attribute evaluator.



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

def evaluator
  @evaluator
end

#idObject

The globally unique identifier for the object.



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

def id
  @id
end

#is_scoring_indexObject

Returns the value of attribute is_scoring_index.



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

def is_scoring_index
  @is_scoring_index
end

#nameObject

Returns the value of attribute name.



8
9
10
# File 'lib/purecloud/models/evaluation.rb', line 8

def name
  @name
end

#queueObject

Returns the value of attribute queue.



36
37
38
# File 'lib/purecloud/models/evaluation.rb', line 36

def queue
  @queue
end

#redactedObject

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



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

def redacted
  @redacted
end

#release_dateObject

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



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

def release_date
  @release_date
end

#resource_idObject

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



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

def resource_id
  @resource_id
end

#resource_typeObject

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



42
43
44
# File 'lib/purecloud/models/evaluation.rb', line 42

def resource_type
  @resource_type
end

#self_uriObject

The URI for this object



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

def self_uri
  @self_uri
end

#statusObject

Returns the value of attribute status.



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

def status
  @status
end

Class Method Details

.attribute_mapObject

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



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

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',
    
    :'resource_id' => :'resourceId',
    
    :'resource_type' => :'resourceType',
    
    :'redacted' => :'redacted',
    
    :'is_scoring_index' => :'isScoringIndex',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_typesObject

Attribute type mapping.



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

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/purecloud/models/evaluation.rb', line 233

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



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

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



344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'lib/purecloud/models/evaluation.rb', line 344

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/purecloud/models/evaluation.rb', line 268

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


258
259
260
# File 'lib/purecloud/models/evaluation.rb', line 258

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



263
264
265
# File 'lib/purecloud/models/evaluation.rb', line 263

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

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



327
328
329
# File 'lib/purecloud/models/evaluation.rb', line 327

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



332
333
334
335
336
337
338
339
340
# File 'lib/purecloud/models/evaluation.rb', line 332

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



322
323
324
# File 'lib/purecloud/models/evaluation.rb', line 322

def to_s
  to_hash.to_s
end