Class: PureCloud::WorkPlanActivity

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

Overview

Activity configured for shift in work plan

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkPlanActivity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#activity_code_id ⇒ Object

ID of the activity code associated with this activity



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

def activity_code_id
  @activity_code_id
end

#counts_as_contiguous_work_time ⇒ Object

Whether the activity duration is counted towards contiguous work time



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

def counts_as_contiguous_work_time
  @counts_as_contiguous_work_time
end

#counts_as_paid_time ⇒ Object

Whether the activity is paid



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

def counts_as_paid_time
  @counts_as_paid_time
end

#delete ⇒ Object

If marked true for updating an existing activity, the activity will be permanently deleted



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

def delete
  @delete
end

#description ⇒ Object

Description of the activity



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

def description
  @description
end

#earliest_start_time_minutes ⇒ Object

Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true



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

def earliest_start_time_minutes
  @earliest_start_time_minutes
end

#exact_start_time_minutes ⇒ Object

Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false



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

def exact_start_time_minutes
  @exact_start_time_minutes
end

#flexible_start_time ⇒ Object

Whether the start time of the activity is flexible



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

def flexible_start_time
  @flexible_start_time
end

#id ⇒ Object

ID of the activity. This is required only for the case of updating an existing activity



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

def id
  @id
end

#latest_start_time_minutes ⇒ Object

Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true



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

def latest_start_time_minutes
  @latest_start_time_minutes
end

#length_minutes ⇒ Object

Length of the activity in minutes



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

def length_minutes
  @length_minutes
end

#start_time_increment_minutes ⇒ Object

Increment in offset minutes that would contribute to different possible start times for the activity



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

def start_time_increment_minutes
  @start_time_increment_minutes
end

#start_time_is_relative_to_shift_start ⇒ Object

Whether the start time of the activity is relative to the start time of the shift it belongs to



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

def start_time_is_relative_to_shift_start
  @start_time_is_relative_to_shift_start
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'activity_code_id' => :'activityCodeId',
    
    :'description' => :'description',
    
    :'length_minutes' => :'lengthMinutes',
    
    :'start_time_is_relative_to_shift_start' => :'startTimeIsRelativeToShiftStart',
    
    :'flexible_start_time' => :'flexibleStartTime',
    
    :'earliest_start_time_minutes' => :'earliestStartTimeMinutes',
    
    :'latest_start_time_minutes' => :'latestStartTimeMinutes',
    
    :'exact_start_time_minutes' => :'exactStartTimeMinutes',
    
    :'start_time_increment_minutes' => :'startTimeIncrementMinutes',
    
    :'counts_as_paid_time' => :'countsAsPaidTime',
    
    :'counts_as_contiguous_work_time' => :'countsAsContiguousWorkTime',
    
    :'id' => :'id',
    
    :'delete' => :'delete'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'activity_code_id' => :'String',
    
    :'description' => :'String',
    
    :'length_minutes' => :'Integer',
    
    :'start_time_is_relative_to_shift_start' => :'BOOLEAN',
    
    :'flexible_start_time' => :'BOOLEAN',
    
    :'earliest_start_time_minutes' => :'Integer',
    
    :'latest_start_time_minutes' => :'Integer',
    
    :'exact_start_time_minutes' => :'Integer',
    
    :'start_time_increment_minutes' => :'Integer',
    
    :'counts_as_paid_time' => :'BOOLEAN',
    
    :'counts_as_contiguous_work_time' => :'BOOLEAN',
    
    :'id' => :'String',
    
    :'delete' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 390

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activity_code_id == o.activity_code_id &&
      description == o.description &&
      length_minutes == o.length_minutes &&
      start_time_is_relative_to_shift_start == o.start_time_is_relative_to_shift_start &&
      flexible_start_time == o.flexible_start_time &&
      earliest_start_time_minutes == o.earliest_start_time_minutes &&
      latest_start_time_minutes == o.latest_start_time_minutes &&
      exact_start_time_minutes == o.exact_start_time_minutes &&
      start_time_increment_minutes == o.start_time_increment_minutes &&
      counts_as_paid_time == o.counts_as_paid_time &&
      counts_as_contiguous_work_time == o.counts_as_contiguous_work_time &&
      id == o.id &&
      delete == o.delete
end

#_deserialize(type, value) ⇒ Object 



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
469
470
471
472
473
474
475
476
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 440

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



500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 500

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



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 421

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


410
411
412
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 410

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



416
417
418
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 416

def hash
  [activity_code_id, description, length_minutes, start_time_is_relative_to_shift_start, flexible_start_time, earliest_start_time_minutes, latest_start_time_minutes, exact_start_time_minutes, start_time_increment_minutes, counts_as_paid_time, counts_as_contiguous_work_time, id, delete].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



257
258
259
260
261
262
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 257

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



483
484
485
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 483

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



488
489
490
491
492
493
494
495
496
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 488

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 



478
479
480
 
# File 'lib/purecloudplatformclientv2/models/work_plan_activity.rb', line 478

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end