Class: PureCloud::AdherenceSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/adherence_settings.rb

Overview

Schedule Adherence Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdherenceSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 80

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

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

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

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

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

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

  
end

Instance Attribute Details

#adherence_exception_threshold_seconds ⇒ Object

The threshold in seconds for which agents should not be penalized for being momentarily out of adherence



29
30
31
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 29

def adherence_exception_threshold_seconds
  @adherence_exception_threshold_seconds
end

#adherence_target_percent ⇒ Object

Target adherence percentage



26
27
28
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 26

def adherence_target_percent
  @adherence_target_percent
end

#ignored_activity_categories ⇒ Object

Activity categories that should be ignored for adherence purposes



38
39
40
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 38

def ignored_activity_categories
  @ignored_activity_categories
end

#non_on_queue_activities_equivalent ⇒ Object

Whether to treat all non-on-queue activities as equivalent for adherence purposes



32
33
34
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 32

def non_on_queue_activities_equivalent
  @non_on_queue_activities_equivalent
end

#severe_alert_threshold_minutes ⇒ Object

The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence



23
24
25
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 23

def severe_alert_threshold_minutes
  @severe_alert_threshold_minutes
end

#track_on_queue_activity ⇒ Object

Whether to track on-queue activities



35
36
37
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 35

def track_on_queue_activity
  @track_on_queue_activity
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 41

def self.attribute_map
  {
    
    :'severe_alert_threshold_minutes' => :'severeAlertThresholdMinutes',
    
    :'adherence_target_percent' => :'adherenceTargetPercent',
    
    :'adherence_exception_threshold_seconds' => :'adherenceExceptionThresholdSeconds',
    
    :'non_on_queue_activities_equivalent' => :'nonOnQueueActivitiesEquivalent',
    
    :'track_on_queue_activity' => :'trackOnQueueActivity',
    
    :'ignored_activity_categories' => :'ignoredActivityCategories'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 60

def self.swagger_types
  {
    
    :'severe_alert_threshold_minutes' => :'Integer',
    
    :'adherence_target_percent' => :'Integer',
    
    :'adherence_exception_threshold_seconds' => :'Integer',
    
    :'non_on_queue_activities_equivalent' => :'BOOLEAN',
    
    :'track_on_queue_activity' => :'BOOLEAN',
    
    :'ignored_activity_categories' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      severe_alert_threshold_minutes == o.severe_alert_threshold_minutes &&
      adherence_target_percent == o.adherence_target_percent &&
      adherence_exception_threshold_seconds == o.adherence_exception_threshold_seconds &&
      non_on_queue_activities_equivalent == o.non_on_queue_activities_equivalent &&
      track_on_queue_activity == o.track_on_queue_activity &&
      ignored_activity_categories == o.ignored_activity_categories
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 260

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 320

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 241

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


230
231
232
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 236

def hash
  [severe_alert_threshold_minutes, adherence_target_percent, adherence_exception_threshold_seconds, non_on_queue_activities_equivalent, track_on_queue_activity, ignored_activity_categories].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



147
148
149
150
151
152
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 147

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



303
304
305
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 303

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



308
309
310
311
312
313
314
315
316
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 308

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 



298
299
300
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 298

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



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
 
# File 'lib/purecloudclient_v2a/models/adherence_settings.rb', line 156

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end