Class: PureCloud::HistoricalAdherenceDayMetrics

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HistoricalAdherenceDayMetrics

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#actual_length_secs ⇒ Object

Total duration in seconds for all actually worked activities



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

def actual_length_secs
  @actual_length_secs
end

#adherence_percentage ⇒ Object

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



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

def adherence_percentage
  @adherence_percentage
end

#adherence_schedule_secs ⇒ Object

Duration of schedule in seconds included for adherence percentage calculation



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

def adherence_schedule_secs
  @adherence_schedule_secs
end

#conformance_actual_secs ⇒ Object

Total actually worked duration in seconds for OnQueue activities



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

def conformance_actual_secs
  @conformance_actual_secs
end

#conformance_percentage ⇒ Object

Total 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.



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

def conformance_percentage
  @conformance_percentage
end

#conformance_schedule_secs ⇒ Object

Total scheduled duration in seconds for OnQueue activities



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

def conformance_schedule_secs
  @conformance_schedule_secs
end

#day_start_offset_secs ⇒ Object

Start of day offset in seconds relative to query start time



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

def day_start_offset_secs
  @day_start_offset_secs
end

#exception_count ⇒ Object

Total number of adherence exceptions for this user



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

def exception_count
  @exception_count
end

#exception_duration_secs ⇒ Object

Total duration in seconds of adherence exceptions for this user



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

def exception_duration_secs
  @exception_duration_secs
end

#impact_seconds ⇒ Object

The impact duration in seconds of current adherence state for this user



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

def impact_seconds
  @impact_seconds
end

#schedule_length_secs ⇒ Object

Total duration in seconds for all scheduled activities



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

def schedule_length_secs
  @schedule_length_secs
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'day_start_offset_secs' => :'dayStartOffsetSecs',
    
    :'adherence_schedule_secs' => :'adherenceScheduleSecs',
    
    :'conformance_schedule_secs' => :'conformanceScheduleSecs',
    
    :'conformance_actual_secs' => :'conformanceActualSecs',
    
    :'exception_count' => :'exceptionCount',
    
    :'exception_duration_secs' => :'exceptionDurationSecs',
    
    :'impact_seconds' => :'impactSeconds',
    
    :'schedule_length_secs' => :'scheduleLengthSecs',
    
    :'actual_length_secs' => :'actualLengthSecs',
    
    :'adherence_percentage' => :'adherencePercentage',
    
    :'conformance_percentage' => :'conformancePercentage'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'day_start_offset_secs' => :'Integer',
    
    :'adherence_schedule_secs' => :'Integer',
    
    :'conformance_schedule_secs' => :'Integer',
    
    :'conformance_actual_secs' => :'Integer',
    
    :'exception_count' => :'Integer',
    
    :'exception_duration_secs' => :'Integer',
    
    :'impact_seconds' => :'Integer',
    
    :'schedule_length_secs' => :'Integer',
    
    :'actual_length_secs' => :'Integer',
    
    :'adherence_percentage' => :'Float',
    
    :'conformance_percentage' => :'Float'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      day_start_offset_secs == o.day_start_offset_secs &&
      adherence_schedule_secs == o.adherence_schedule_secs &&
      conformance_schedule_secs == o.conformance_schedule_secs &&
      conformance_actual_secs == o.conformance_actual_secs &&
      exception_count == o.exception_count &&
      exception_duration_secs == o.exception_duration_secs &&
      impact_seconds == o.impact_seconds &&
      schedule_length_secs == o.schedule_length_secs &&
      actual_length_secs == o.actual_length_secs &&
      adherence_percentage == o.adherence_percentage &&
      conformance_percentage == o.conformance_percentage
end

#_deserialize(type, value) ⇒ Object 



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
421
422
423
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 387

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



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 447

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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 368

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


357
358
359
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 357

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



363
364
365
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 363

def hash
  [day_start_offset_secs, adherence_schedule_secs, conformance_schedule_secs, conformance_actual_secs, exception_count, exception_duration_secs, impact_seconds, schedule_length_secs, actual_length_secs, adherence_percentage, conformance_percentage].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



224
225
226
227
228
229
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 224

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



430
431
432
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 430

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



435
436
437
438
439
440
441
442
443
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 435

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 



425
426
427
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb', line 425

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end