Class: PureCloud::HistoricalAdherenceQueryResult

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HistoricalAdherenceQueryResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#actuals ⇒ Object

List of actual activity with offset for this user



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

def actuals
  @actuals
end

#adherence_percentage ⇒ Object

Adherence percentage for this user, in the scale of 0 - 100



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

def adherence_percentage
  @adherence_percentage
end

#conformance_percentage ⇒ Object

Conformance percentage for this user, in the scale of 0 - 100. Conformance percentage can be greater than 100 when the actual on queue time is greater than the scheduled on queue time for the same period.



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

def conformance_percentage
  @conformance_percentage
end

#day_metrics ⇒ Object

Adherence and conformance metrics for days in query range



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

def day_metrics
  @day_metrics
end

#end_date ⇒ Object

End of the date range that was queried, in ISO-8601 format. If it was not set, end date will be set to the queried time



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

def end_date
  @end_date
end

#exception_info ⇒ Object

List of adherence exceptions for this user



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

def exception_info
  @exception_info
end

#impact ⇒ Object

The impact of the current adherence state for this user



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

def impact
  @impact
end

#start_date ⇒ Object

Beginning of the date range that was queried, in ISO-8601 format



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

def start_date
  @start_date
end

#user_id ⇒ Object

The ID of the user for whom the adherence is queried



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 49

def self.attribute_map
  {
    
    :'user_id' => :'userId',
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'adherence_percentage' => :'adherencePercentage',
    
    :'conformance_percentage' => :'conformancePercentage',
    
    :'impact' => :'impact',
    
    :'exception_info' => :'exceptionInfo',
    
    :'day_metrics' => :'dayMetrics',
    
    :'actuals' => :'actuals'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 74

def self.swagger_types
  {
    
    :'user_id' => :'String',
    
    :'start_date' => :'DateTime',
    
    :'end_date' => :'DateTime',
    
    :'adherence_percentage' => :'Float',
    
    :'conformance_percentage' => :'Float',
    
    :'impact' => :'String',
    
    :'exception_info' => :'Array<HistoricalAdherenceExceptionInfo>',
    
    :'day_metrics' => :'Array<HistoricalAdherenceDayMetrics>',
    
    :'actuals' => :'Array<HistoricalAdherenceActuals>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 309

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      adherence_percentage == o.adherence_percentage &&
      conformance_percentage == o.conformance_percentage &&
      impact == o.impact &&
      exception_info == o.exception_info &&
      day_metrics == o.day_metrics &&
      actuals == o.actuals
end

#_deserialize(type, value) ⇒ Object 



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

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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 415

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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 336

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


325
326
327
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 325

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



331
332
333
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 331

def hash
  [user_id, start_date, end_date, adherence_percentage, conformance_percentage, impact, exception_info, day_metrics, actuals].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



198
199
200
201
202
203
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 198

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



398
399
400
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 398

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



403
404
405
406
407
408
409
410
411
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 403

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 



393
394
395
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb', line 393

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Positive", "Negative", "Neutral", "Unknown"]
  if @impact && !allowed_values.include?(@impact)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end