Class: PureCloud::UpdateWeekScheduleRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateWeekScheduleRequest

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
189
190
191
192
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.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?(:'description')
    
    
    self.description = attributes[:'description']
    
  
  end

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#agent_schedules_version ⇒ Object

Version of agent schedules in the week schedule



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

def agent_schedules_version
  @agent_schedules_version
end

#agent_update_filter ⇒ Object

For a published schedule, this determines whether a notification will be shown to agents in the default PureCloud user interface. The CPC notification will always be sent and the value specified here affects what data is returned in the ‘updates’ property. In the default PureCloud UI, "None" means that agents will not be notified, "ShiftTimesOnly" means agents will only be notified for changes to shift start and end times, and "All" means that agents will be notified for any change to a shift or activity (except for full day off activities). When building a custom client, use this property to specify the level of detail you need. Defaults to "ShiftTimesOnly".



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

def agent_update_filter
  @agent_update_filter
end

#description ⇒ Object

Description of the week schedule



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

def description
  @description
end

#headcount_forecast ⇒ Object

The headcount forecast associated with the schedule. If not null, existing values will be irrecoverably replaced



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

def headcount_forecast
  @headcount_forecast
end

#metadata ⇒ Object

Version metadata for this work plan



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

def metadata
  @metadata
end

#partial_upload_ids ⇒ Object

IDs of partial uploads to include in this imported schedule. It is applicable only for large schedules where activity count in schedule is greater than 17500



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

def partial_upload_ids
  @partial_upload_ids
end

#published ⇒ Object

Whether the week schedule is published



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

def published
  @published
end

#short_term_forecast ⇒ Object

Reference to optionally point the schedule at a new short term forecast



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

def short_term_forecast
  @short_term_forecast
end

#user_schedules ⇒ Object

User schedules in the week



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

def user_schedules
  @user_schedules
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/update_week_schedule_request.rb', line 49

def self.attribute_map
  {
    
    :'description' => :'description',
    
    :'published' => :'published',
    
    :'user_schedules' => :'userSchedules',
    
    :'partial_upload_ids' => :'partialUploadIds',
    
    :'metadata' => :'metadata',
    
    :'agent_schedules_version' => :'agentSchedulesVersion',
    
    :'short_term_forecast' => :'shortTermForecast',
    
    :'headcount_forecast' => :'headcountForecast',
    
    :'agent_update_filter' => :'agentUpdateFilter'
    
  }
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/update_week_schedule_request.rb', line 74

def self.swagger_types
  {
    
    :'description' => :'String',
    
    :'published' => :'BOOLEAN',
    
    :'user_schedules' => :'Hash<String, UserSchedule>',
    
    :'partial_upload_ids' => :'Array<String>',
    
    :'metadata' => :'WfmVersionedEntityMetadata',
    
    :'agent_schedules_version' => :'Integer',
    
    :'short_term_forecast' => :'ShortTermForecastReference',
    
    :'headcount_forecast' => :'HeadcountForecast',
    
    :'agent_update_filter' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 317

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      published == o.published &&
      user_schedules == o.user_schedules &&
      partial_upload_ids == o.partial_upload_ids &&
      metadata == o.metadata &&
      agent_schedules_version == o.agent_schedules_version &&
      short_term_forecast == o.short_term_forecast &&
      headcount_forecast == o.headcount_forecast &&
      agent_update_filter == o.agent_update_filter
end

#_deserialize(type, value) ⇒ Object 



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

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 423

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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 344

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


333
334
335
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 333

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



339
340
341
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 339

def hash
  [description, published, user_schedules, partial_upload_ids, metadata, agent_schedules_version, short_term_forecast, headcount_forecast, agent_update_filter].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



196
197
198
199
200
201
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 196

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



406
407
408
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 406

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



411
412
413
414
415
416
417
418
419
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 411

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 



401
402
403
 
# File 'lib/purecloudplatformclientv2/models/update_week_schedule_request.rb', line 401

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



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

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

  
  
  
  
  
  if @agent_schedules_version.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["All", "ShiftTimeChange", "None"]
  if @agent_update_filter && !allowed_values.include?(@agent_update_filter)
    return false
  end
  
  
  
end