Class: PureCloud::CreateWorkPlanShift

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

Overview

Shift in a work plan

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWorkPlanShift

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#activities ⇒ Object

Activities configured for this shift



74
75
76
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 74

def activities
  @activities
end

#constrain_contiguous_work_time ⇒ Object

Whether the contiguous time constraint for the shift is enabled



65
66
67
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 65

def constrain_contiguous_work_time
  @constrain_contiguous_work_time
end

#constrain_latest_stop_time ⇒ Object

Whether the latest stop time constraint for the shift is enabled



44
45
46
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 44

def constrain_latest_stop_time
  @constrain_latest_stop_time
end

#constrain_stop_time ⇒ Object

Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 41

def constrain_stop_time
  @constrain_stop_time
end

#days ⇒ Object

Days of the week applicable for this shift



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 26

def days
  @days
end

#earliest_start_time_minutes_from_midnight ⇒ Object

Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 35

def earliest_start_time_minutes_from_midnight
  @earliest_start_time_minutes_from_midnight
end

#exact_paid_time_minutes ⇒ Object

Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false



56
57
58
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 56

def exact_paid_time_minutes
  @exact_paid_time_minutes
end

#exact_start_time_minutes_from_midnight ⇒ Object

Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 32

def exact_start_time_minutes_from_midnight
  @exact_start_time_minutes_from_midnight
end

#flexible_paid_time ⇒ Object

Whether the paid time setting for the shift is flexible



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 53

def flexible_paid_time
  @flexible_paid_time
end

#flexible_start_time ⇒ Object

Whether the start time of the shift is flexible



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 29

def flexible_start_time
  @flexible_start_time
end

#latest_start_time_minutes_from_midnight ⇒ Object

Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 38

def latest_start_time_minutes_from_midnight
  @latest_start_time_minutes_from_midnight
end

#latest_stop_time_minutes_from_midnight ⇒ Object

Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 47

def latest_stop_time_minutes_from_midnight
  @latest_stop_time_minutes_from_midnight
end

#maximum_contiguous_work_time_minutes ⇒ Object

Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true



71
72
73
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 71

def maximum_contiguous_work_time_minutes
  @maximum_contiguous_work_time_minutes
end

#maximum_paid_time_minutes ⇒ Object

Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true



62
63
64
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 62

def maximum_paid_time_minutes
  @maximum_paid_time_minutes
end

#minimum_contiguous_work_time_minutes ⇒ Object

Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true



68
69
70
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 68

def minimum_contiguous_work_time_minutes
  @minimum_contiguous_work_time_minutes
end

#minimum_paid_time_minutes ⇒ Object

Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 59

def minimum_paid_time_minutes
  @minimum_paid_time_minutes
end

#name ⇒ Object

Name of the shift



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

def name
  @name
end

#start_increment_minutes ⇒ Object

Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 50

def start_increment_minutes
  @start_increment_minutes
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
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
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 77

def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'days' => :'days',
    
    :'flexible_start_time' => :'flexibleStartTime',
    
    :'exact_start_time_minutes_from_midnight' => :'exactStartTimeMinutesFromMidnight',
    
    :'earliest_start_time_minutes_from_midnight' => :'earliestStartTimeMinutesFromMidnight',
    
    :'latest_start_time_minutes_from_midnight' => :'latestStartTimeMinutesFromMidnight',
    
    :'constrain_stop_time' => :'constrainStopTime',
    
    :'constrain_latest_stop_time' => :'constrainLatestStopTime',
    
    :'latest_stop_time_minutes_from_midnight' => :'latestStopTimeMinutesFromMidnight',
    
    :'start_increment_minutes' => :'startIncrementMinutes',
    
    :'flexible_paid_time' => :'flexiblePaidTime',
    
    :'exact_paid_time_minutes' => :'exactPaidTimeMinutes',
    
    :'minimum_paid_time_minutes' => :'minimumPaidTimeMinutes',
    
    :'maximum_paid_time_minutes' => :'maximumPaidTimeMinutes',
    
    :'constrain_contiguous_work_time' => :'constrainContiguousWorkTime',
    
    :'minimum_contiguous_work_time_minutes' => :'minimumContiguousWorkTimeMinutes',
    
    :'maximum_contiguous_work_time_minutes' => :'maximumContiguousWorkTimeMinutes',
    
    :'activities' => :'activities'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'name' => :'String',
    
    :'days' => :'SetWrapperDayOfWeek',
    
    :'flexible_start_time' => :'BOOLEAN',
    
    :'exact_start_time_minutes_from_midnight' => :'Integer',
    
    :'earliest_start_time_minutes_from_midnight' => :'Integer',
    
    :'latest_start_time_minutes_from_midnight' => :'Integer',
    
    :'constrain_stop_time' => :'BOOLEAN',
    
    :'constrain_latest_stop_time' => :'BOOLEAN',
    
    :'latest_stop_time_minutes_from_midnight' => :'Integer',
    
    :'start_increment_minutes' => :'Integer',
    
    :'flexible_paid_time' => :'BOOLEAN',
    
    :'exact_paid_time_minutes' => :'Integer',
    
    :'minimum_paid_time_minutes' => :'Integer',
    
    :'maximum_paid_time_minutes' => :'Integer',
    
    :'constrain_contiguous_work_time' => :'BOOLEAN',
    
    :'minimum_contiguous_work_time_minutes' => :'Integer',
    
    :'maximum_contiguous_work_time_minutes' => :'Integer',
    
    :'activities' => :'Array<CreateWorkPlanActivity>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 522

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      days == o.days &&
      flexible_start_time == o.flexible_start_time &&
      exact_start_time_minutes_from_midnight == o.exact_start_time_minutes_from_midnight &&
      earliest_start_time_minutes_from_midnight == o.earliest_start_time_minutes_from_midnight &&
      latest_start_time_minutes_from_midnight == o.latest_start_time_minutes_from_midnight &&
      constrain_stop_time == o.constrain_stop_time &&
      constrain_latest_stop_time == o.constrain_latest_stop_time &&
      latest_stop_time_minutes_from_midnight == o.latest_stop_time_minutes_from_midnight &&
      start_increment_minutes == o.start_increment_minutes &&
      flexible_paid_time == o.flexible_paid_time &&
      exact_paid_time_minutes == o.exact_paid_time_minutes &&
      minimum_paid_time_minutes == o.minimum_paid_time_minutes &&
      maximum_paid_time_minutes == o.maximum_paid_time_minutes &&
      constrain_contiguous_work_time == o.constrain_contiguous_work_time &&
      minimum_contiguous_work_time_minutes == o.minimum_contiguous_work_time_minutes &&
      maximum_contiguous_work_time_minutes == o.maximum_contiguous_work_time_minutes &&
      activities == o.activities
end

#_deserialize(type, value) ⇒ Object 



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 577

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



637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 637

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



558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 558

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


547
548
549
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 547

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



553
554
555
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 553

def hash
  [name, days, flexible_start_time, exact_start_time_minutes_from_midnight, earliest_start_time_minutes_from_midnight, latest_start_time_minutes_from_midnight, constrain_stop_time, constrain_latest_stop_time, latest_stop_time_minutes_from_midnight, start_increment_minutes, flexible_paid_time, exact_paid_time_minutes, minimum_paid_time_minutes, maximum_paid_time_minutes, constrain_contiguous_work_time, minimum_contiguous_work_time_minutes, maximum_contiguous_work_time_minutes, activities].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



339
340
341
342
343
344
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 339

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



620
621
622
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 620

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



625
626
627
628
629
630
631
632
633
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 625

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 



615
616
617
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 615

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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
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
 
# File 'lib/purecloudplatformclientv2/models/create_work_plan_shift.rb', line 348

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

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end