Class: PureCloud::UserScheduleAdherence

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserScheduleAdherence

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
260
261
262
263
264
265
266
267
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#actual_activity_category ⇒ Object

Activity in which the user is actually engaged



45
46
47
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 45

def actual_activity_category
  @actual_activity_category
end

#adherence_state ⇒ Object

The user’s current adherence state



51
52
53
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 51

def adherence_state
  @adherence_state
end

#id ⇒ Object

The globally unique identifier for the object.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 22

def id
  @id
end

#impact ⇒ Object

The impact of the user’s current adherenceState



54
55
56
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 54

def impact
  @impact
end

#is_out_of_office ⇒ Object

Whether the user is marked OutOfOffice



48
49
50
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 48

def is_out_of_office
  @is_out_of_office
end

#management_unit ⇒ Object

The management unit to which this user belongs



30
31
32
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 30

def management_unit
  @management_unit
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 24

def name
  @name
end

#organization_secondary_presence_id ⇒ Object

Organization Secondary Presence Id.



39
40
41
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 39

def organization_secondary_presence_id
  @organization_secondary_presence_id
end

#routing_status ⇒ Object

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



42
43
44
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 42

def routing_status
  @routing_status
end

#scheduled_activity_category ⇒ Object

Activity for which the user is scheduled



33
34
35
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 33

def scheduled_activity_category
  @scheduled_activity_category
end

#self_uri ⇒ Object

The URI for this object



60
61
62
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 60

def self_uri
  @self_uri
end

#system_presence ⇒ Object

Actual underlying system presence value



36
37
38
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 36

def system_presence
  @system_presence
end

#time_of_adherence_change ⇒ Object

Time when the user entered the current adherenceState in ISO-8601 format



57
58
59
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 57

def time_of_adherence_change
  @time_of_adherence_change
end

#user ⇒ Object

The user for whom this status applies



27
28
29
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 27

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



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/purecloudclient_v2a/models/user_schedule_adherence.rb', line 63

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'user' => :'user',
    
    :'management_unit' => :'managementUnit',
    
    :'scheduled_activity_category' => :'scheduledActivityCategory',
    
    :'system_presence' => :'systemPresence',
    
    :'organization_secondary_presence_id' => :'organizationSecondaryPresenceId',
    
    :'routing_status' => :'routingStatus',
    
    :'actual_activity_category' => :'actualActivityCategory',
    
    :'is_out_of_office' => :'isOutOfOffice',
    
    :'adherence_state' => :'adherenceState',
    
    :'impact' => :'impact',
    
    :'time_of_adherence_change' => :'timeOfAdherenceChange',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

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
122
123
124
125
126
127
128
129
130
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 98

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'user' => :'User',
    
    :'management_unit' => :'ManagementUnit',
    
    :'scheduled_activity_category' => :'String',
    
    :'system_presence' => :'String',
    
    :'organization_secondary_presence_id' => :'String',
    
    :'routing_status' => :'String',
    
    :'actual_activity_category' => :'String',
    
    :'is_out_of_office' => :'BOOLEAN',
    
    :'adherence_state' => :'String',
    
    :'impact' => :'String',
    
    :'time_of_adherence_change' => :'String',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 497

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      user == o.user &&
      management_unit == o.management_unit &&
      scheduled_activity_category == o.scheduled_activity_category &&
      system_presence == o.system_presence &&
      organization_secondary_presence_id == o.organization_secondary_presence_id &&
      routing_status == o.routing_status &&
      actual_activity_category == o.actual_activity_category &&
      is_out_of_office == o.is_out_of_office &&
      adherence_state == o.adherence_state &&
      impact == o.impact &&
      time_of_adherence_change == o.time_of_adherence_change &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 548

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



608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 608

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



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 529

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


518
519
520
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 518

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



524
525
526
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 524

def hash
  [id, name, user, management_unit, scheduled_activity_category, system_presence, organization_secondary_presence_id, routing_status, actual_activity_category, is_out_of_office, adherence_state, impact, time_of_adherence_change, self_uri].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



271
272
273
274
275
276
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 271

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



591
592
593
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 591

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



596
597
598
599
600
601
602
603
604
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 596

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 



586
587
588
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 586

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



280
281
282
283
284
285
286
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/purecloudclient_v2a/models/user_schedule_adherence.rb', line 280

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 = ["Available", "Away", "Busy", "Offline", "Idle", "OnQueue", "Meal", "Training", "Meeting", "Break"]
  if @system_presence && !allowed_values.include?(@system_presence)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["OFF_QUEUE", "IDLE", "INTERACTING", "NOT_RESPONDING", "COMMUNICATING"]
  if @routing_status && !allowed_values.include?(@routing_status)
    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 = ["InAdherence", "OutOfAdherence", "Unscheduled", "Unknown"]
  if @adherence_state && !allowed_values.include?(@adherence_state)
    return false
  end
  
  
  
  
  
  allowed_values = ["Positive", "Negative", "Neutral", "Unknown"]
  if @impact && !allowed_values.include?(@impact)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end