Class: PureCloud::HistoricalAdherenceExceptionInfo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HistoricalAdherenceExceptionInfo

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
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.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?(:'startOffsetSeconds')
    
    
    self.start_offset_seconds = attributes[:'startOffsetSeconds']
    
  
  end

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#actual_activity_category ⇒ Object

Activity for which the user is actually engaged



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

def actual_activity_category
  @actual_activity_category
end

#end_offset_seconds ⇒ Object

Exception end offset in seconds relative to query start time



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

def end_offset_seconds
  @end_offset_seconds
end

#impact ⇒ Object

The impact of the current adherence state for this user



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

def impact
  @impact
end

#routing_status ⇒ Object

Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue



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

def routing_status
  @routing_status
end

#scheduled_activity_category ⇒ Object

Activity for which the user is scheduled



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

def scheduled_activity_category
  @scheduled_activity_category
end

#scheduled_activity_code_id ⇒ Object

The ID of the scheduled activity for this user



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

def scheduled_activity_code_id
  @scheduled_activity_code_id
end

#secondary_presence_lookup_id ⇒ Object

The lookup ID used to retrieve secondary status from map of lookup ID to corresponding secondary presence ID



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

def secondary_presence_lookup_id
  @secondary_presence_lookup_id
end

#start_offset_seconds ⇒ Object

Exception start offset in seconds relative to query start time



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

def start_offset_seconds
  @start_offset_seconds
end

#system_presence ⇒ Object

Actual underlying system presence value



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

def system_presence
  @system_presence
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_exception_info.rb', line 49

def self.attribute_map
  {
    
    :'start_offset_seconds' => :'startOffsetSeconds',
    
    :'end_offset_seconds' => :'endOffsetSeconds',
    
    :'scheduled_activity_code_id' => :'scheduledActivityCodeId',
    
    :'scheduled_activity_category' => :'scheduledActivityCategory',
    
    :'actual_activity_category' => :'actualActivityCategory',
    
    :'system_presence' => :'systemPresence',
    
    :'routing_status' => :'routingStatus',
    
    :'impact' => :'impact',
    
    :'secondary_presence_lookup_id' => :'secondaryPresenceLookupId'
    
  }
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_exception_info.rb', line 74

def self.swagger_types
  {
    
    :'start_offset_seconds' => :'Integer',
    
    :'end_offset_seconds' => :'Integer',
    
    :'scheduled_activity_code_id' => :'String',
    
    :'scheduled_activity_category' => :'String',
    
    :'actual_activity_category' => :'String',
    
    :'system_presence' => :'String',
    
    :'routing_status' => :'RoutingStatus',
    
    :'impact' => :'String',
    
    :'secondary_presence_lookup_id' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 345

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_offset_seconds == o.start_offset_seconds &&
      end_offset_seconds == o.end_offset_seconds &&
      scheduled_activity_code_id == o.scheduled_activity_code_id &&
      scheduled_activity_category == o.scheduled_activity_category &&
      actual_activity_category == o.actual_activity_category &&
      system_presence == o.system_presence &&
      routing_status == o.routing_status &&
      impact == o.impact &&
      secondary_presence_lookup_id == o.secondary_presence_lookup_id
end

#_deserialize(type, value) ⇒ Object 



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
424
425
426
427
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 391

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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 451

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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 372

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


361
362
363
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 361

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



367
368
369
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 367

def hash
  [start_offset_seconds, end_offset_seconds, scheduled_activity_code_id, scheduled_activity_category, actual_activity_category, system_presence, routing_status, impact, secondary_presence_lookup_id].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



192
193
194
195
196
197
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 192

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



434
435
436
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 434

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



439
440
441
442
443
444
445
446
447
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 439

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 



429
430
431
 
# File 'lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb', line 429

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"]
  if @scheduled_activity_category && !allowed_values.include?(@scheduled_activity_category)
    return false
  end
  
  
  
  
  
  allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"]
  if @actual_activity_category && !allowed_values.include?(@actual_activity_category)
    return false
  end
  
  
  
  
  
  allowed_values = ["Available", "Away", "Busy", "Offline", "Idle", "OnQueue", "Meal", "Training", "Meeting", "Break"]
  if @system_presence && !allowed_values.include?(@system_presence)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["Positive", "Negative", "Neutral", "Unknown"]
  if @impact && !allowed_values.include?(@impact)
    return false
  end
  
  
  
  
  
  
  
end