Class: PureCloud::WorkPlan

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

Overview

Work plan information

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkPlan

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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/purecloudplatformclientv2/models/work_plan.rb', line 177

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#agents ⇒ Object

Agents in this work plan



73
74
75
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 73

def agents
  @agents
end

#constrain_minimum_time_between_shifts ⇒ Object

Whether the minimum time between shifts constraint is enabled for this work plan



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

def constrain_minimum_time_between_shifts
  @constrain_minimum_time_between_shifts
end

#constrain_paid_time_granularity ⇒ Object

Whether paid time granularity is constrained for this workplan



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

def constrain_paid_time_granularity
  @constrain_paid_time_granularity
end

#constrain_weekly_paid_time ⇒ Object

Whether the weekly paid time constraint is enabled for this work plan



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

def constrain_weekly_paid_time
  @constrain_weekly_paid_time
end

#enabled ⇒ Object

Whether the work plan is enabled for scheduling



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

def enabled
  @enabled
end

#flexible_weekly_paid_time ⇒ Object

Whether the weekly paid time constraint is flexible for this work plan



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

def flexible_weekly_paid_time
  @flexible_weekly_paid_time
end

#id ⇒ Object

The globally unique identifier for the object.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 23

def id
  @id
end

#maximum_days ⇒ Object

Maximum number days in a week allowed to be scheduled for this work plan



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 58

def maximum_days
  @maximum_days
end

#metadata ⇒ Object

Version metadata for this work plan



76
77
78
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 76

def metadata
  @metadata
end

#minimum_time_between_shifts_minutes ⇒ Object

Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 55

def minimum_time_between_shifts_minutes
  @minimum_time_between_shifts_minutes
end

#minimum_working_days_per_week ⇒ Object

The minimum number of days that agents assigned to a work plan must work per week



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 61

def minimum_working_days_per_week
  @minimum_working_days_per_week
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#optional_days ⇒ Object

Optional days to schedule for this work plan



64
65
66
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 64

def optional_days
  @optional_days
end

Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true



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

def paid_time_granularity_minutes
  @paid_time_granularity_minutes
end

#self_uri ⇒ Object

The URI for this object



79
80
81
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 79

def self_uri
  @self_uri
end

#shift_start_variances ⇒ Object

Variance in minutes among start times of shifts in this work plan



67
68
69
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 67

def shift_start_variances
  @shift_start_variances
end

#shifts ⇒ Object

Shifts in this work plan



70
71
72
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 70

def shifts
  @shifts
end

#weekly_exact_paid_minutes ⇒ Object

Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false



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

def weekly_exact_paid_minutes
  @weekly_exact_paid_minutes
end

#weekly_maximum_paid_minutes ⇒ Object

Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true



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

def weekly_maximum_paid_minutes
  @weekly_maximum_paid_minutes
end

#weekly_minimum_paid_minutes ⇒ Object

Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true



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

def weekly_minimum_paid_minutes
  @weekly_minimum_paid_minutes
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'enabled' => :'enabled',
    
    :'constrain_weekly_paid_time' => :'constrainWeeklyPaidTime',
    
    :'flexible_weekly_paid_time' => :'flexibleWeeklyPaidTime',
    
    :'weekly_exact_paid_minutes' => :'weeklyExactPaidMinutes',
    
    :'weekly_minimum_paid_minutes' => :'weeklyMinimumPaidMinutes',
    
    :'weekly_maximum_paid_minutes' => :'weeklyMaximumPaidMinutes',
    
    :'constrain_paid_time_granularity' => :'constrainPaidTimeGranularity',
    
    :'paid_time_granularity_minutes' => :'paidTimeGranularityMinutes',
    
    :'constrain_minimum_time_between_shifts' => :'constrainMinimumTimeBetweenShifts',
    
    :'minimum_time_between_shifts_minutes' => :'minimumTimeBetweenShiftsMinutes',
    
    :'maximum_days' => :'maximumDays',
    
    :'minimum_working_days_per_week' => :'minimumWorkingDaysPerWeek',
    
    :'optional_days' => :'optionalDays',
    
    :'shift_start_variances' => :'shiftStartVariances',
    
    :'shifts' => :'shifts',
    
    :'agents' => :'agents',
    
    :'metadata' => :'metadata',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'enabled' => :'BOOLEAN',
    
    :'constrain_weekly_paid_time' => :'BOOLEAN',
    
    :'flexible_weekly_paid_time' => :'BOOLEAN',
    
    :'weekly_exact_paid_minutes' => :'Integer',
    
    :'weekly_minimum_paid_minutes' => :'Integer',
    
    :'weekly_maximum_paid_minutes' => :'Integer',
    
    :'constrain_paid_time_granularity' => :'BOOLEAN',
    
    :'paid_time_granularity_minutes' => :'Integer',
    
    :'constrain_minimum_time_between_shifts' => :'BOOLEAN',
    
    :'minimum_time_between_shifts_minutes' => :'Integer',
    
    :'maximum_days' => :'Integer',
    
    :'minimum_working_days_per_week' => :'Integer',
    
    :'optional_days' => :'SetWrapperDayOfWeek',
    
    :'shift_start_variances' => :'ListWrapperShiftStartVariance',
    
    :'shifts' => :'Array<WorkPlanShift>',
    
    :'agents' => :'Array<DeletableUserReference>',
    
    :'metadata' => :'WfmVersionedEntityMetadata',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 573

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      enabled == o.enabled &&
      constrain_weekly_paid_time == o.constrain_weekly_paid_time &&
      flexible_weekly_paid_time == o.flexible_weekly_paid_time &&
      weekly_exact_paid_minutes == o.weekly_exact_paid_minutes &&
      weekly_minimum_paid_minutes == o.weekly_minimum_paid_minutes &&
      weekly_maximum_paid_minutes == o.weekly_maximum_paid_minutes &&
      constrain_paid_time_granularity == o.constrain_paid_time_granularity &&
      paid_time_granularity_minutes == o.paid_time_granularity_minutes &&
      constrain_minimum_time_between_shifts == o.constrain_minimum_time_between_shifts &&
      minimum_time_between_shifts_minutes == o.minimum_time_between_shifts_minutes &&
      maximum_days == o.maximum_days &&
      minimum_working_days_per_week == o.minimum_working_days_per_week &&
      optional_days == o.optional_days &&
      shift_start_variances == o.shift_start_variances &&
      shifts == o.shifts &&
      agents == o.agents &&
      metadata == o.metadata &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 630

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



690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 690

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



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 611

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


600
601
602
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 600

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



606
607
608
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 606

def hash
  [id, name, enabled, constrain_weekly_paid_time, flexible_weekly_paid_time, weekly_exact_paid_minutes, weekly_minimum_paid_minutes, weekly_maximum_paid_minutes, constrain_paid_time_granularity, paid_time_granularity_minutes, constrain_minimum_time_between_shifts, minimum_time_between_shifts_minutes, maximum_days, minimum_working_days_per_week, optional_days, shift_start_variances, shifts, agents, metadata, 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



372
373
374
375
376
377
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 372

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



673
674
675
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 673

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



678
679
680
681
682
683
684
685
686
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 678

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 



668
669
670
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 668

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



381
382
383
384
385
386
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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/purecloudplatformclientv2/models/work_plan.rb', line 381

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if @metadata.nil?
    return false
  end

  
  
  
  
  
  
  
  
end