Class: PureCloud::BuForecastModification

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BuForecastModification

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#display_granularity ⇒ Object

The client side display granularity of the modification, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H



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

def display_granularity
  @display_granularity
end

#enabled ⇒ Object

Whether the modification is enabled for the forecast



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

def enabled
  @enabled
end

#end_interval_index ⇒ Object

The number of 15 minute intervals past referenceStartDate representing the last interval to which to apply this modification. Must be null if values is populated



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

def end_interval_index
  @end_interval_index
end

#granularity ⇒ Object

The actual granularity of the modification as stored behind the scenes, expressed in the ISO-8601 duration format. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H



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

def granularity
  @granularity
end

#legacy_metric ⇒ Object

The legacy metric to which this modification applies if applicable



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

def legacy_metric
  @legacy_metric
end

#metric ⇒ Object

The metric to which this modification applies



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

def metric
  @metric
end

#planning_group_ids ⇒ Object

The IDs of the planning groups to which this forecast modification applies. Leave empty to apply to all



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

def planning_group_ids
  @planning_group_ids
end

#start_interval_index ⇒ Object

The number of 15 minute intervals past referenceStartDate representing the first interval to which to apply this modification. Must be null if values is populated



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

def start_interval_index
  @start_interval_index
end

#type ⇒ Object

The type of the modification



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

def type
  @type
end

#value ⇒ Object

The value of the modification. Must be null if "values" is populated



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

def value
  @value
end

#values ⇒ Object

The list of values to update. Only applicable for grid-type modifications. Must be null if "value" is populated



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

def values
  @values
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 55

def self.attribute_map
  {
    
    :'type' => :'type',
    
    :'start_interval_index' => :'startIntervalIndex',
    
    :'end_interval_index' => :'endIntervalIndex',
    
    :'metric' => :'metric',
    
    :'legacy_metric' => :'legacyMetric',
    
    :'value' => :'value',
    
    :'values' => :'values',
    
    :'display_granularity' => :'displayGranularity',
    
    :'granularity' => :'granularity',
    
    :'enabled' => :'enabled',
    
    :'planning_group_ids' => :'planningGroupIds'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'type' => :'String',
    
    :'start_interval_index' => :'Integer',
    
    :'end_interval_index' => :'Integer',
    
    :'metric' => :'String',
    
    :'legacy_metric' => :'String',
    
    :'value' => :'Float',
    
    :'values' => :'Array<WfmForecastModificationIntervalOffsetValue>',
    
    :'display_granularity' => :'String',
    
    :'granularity' => :'String',
    
    :'enabled' => :'BOOLEAN',
    
    :'planning_group_ids' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 405

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      start_interval_index == o.start_interval_index &&
      end_interval_index == o.end_interval_index &&
      metric == o.metric &&
      legacy_metric == o.legacy_metric &&
      value == o.value &&
      values == o.values &&
      display_granularity == o.display_granularity &&
      granularity == o.granularity &&
      enabled == o.enabled &&
      planning_group_ids == o.planning_group_ids
end

#_deserialize(type, value) ⇒ Object 



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 453

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



513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 513

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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 434

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


423
424
425
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 423

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



429
430
431
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 429

def hash
  [type, start_interval_index, end_interval_index, metric, legacy_metric, value, values, display_granularity, granularity, enabled, planning_group_ids].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



228
229
230
231
232
233
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 228

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



496
497
498
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 496

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



501
502
503
504
505
506
507
508
509
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 501

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 



491
492
493
 
# File 'lib/purecloudplatformclientv2/models/bu_forecast_modification.rb', line 491

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



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

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

  
  
  allowed_values = ["MinimumPerInterval", "MaximumPerInterval", "SetValuePerInterval", "ChangeValuePerInterval", "ChangePercentPerInterval", "SetValueOverRange", "ChangeValueOverRange", "SetValuesForIntervalSet"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  if @metric.nil?
    return false
  end

  
  
  allowed_values = ["Offered", "AverageHandleTimeSeconds"]
  if @metric && !allowed_values.include?(@metric)
    return false
  end
  
  
  
  
  
  allowed_values = ["AverageAfterCallWorkTimeSeconds", "AverageHandleTimeSeconds", "AverageTalkTimeSeconds", "Offered"]
  if @legacy_metric && !allowed_values.include?(@legacy_metric)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  if @display_granularity.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @enabled.nil?
    return false
  end

  
  
  
  
  
  
  
  
end