Class: PureCloud::BuShortTermForecast

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BuShortTermForecast

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#creation_method ⇒ Object

The method by which this forecast was created



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

def creation_method
  @creation_method
end

#description ⇒ Object

The description of this forecast



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

def description
  @description
end

#generation_results ⇒ Object

Generation result metadata



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

def generation_results
  @generation_results
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#legacy ⇒ Object

Whether this forecast contains modifications on legacy metrics



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

def legacy
  @legacy
end

#metadata ⇒ Object

Metadata for this forecast



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

def metadata
  @metadata
end

#modifications ⇒ Object

Any manual modifications applied to this forecast



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

def modifications
  @modifications
end

#planning_groups ⇒ Object

A snapshot of the planning groups used for this forecast as of the version number indicated



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

def planning_groups
  @planning_groups
end

#planning_groups_version ⇒ Object

The version of the planning groups that was used for this forecast



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

def planning_groups_version
  @planning_groups_version
end

#reference_start_date ⇒ Object

The reference start date for interval-based data for this forecast. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def reference_start_date
  @reference_start_date
end

#self_uri ⇒ Object

The URI for this object



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

def self_uri
  @self_uri
end

#source_days ⇒ Object

The source day pointers for this forecast



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

def source_days
  @source_days
end

#time_zone ⇒ Object

The time zone for this forecast



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

def time_zone
  @time_zone
end

#week_count ⇒ Object

The number of weeks this forecast covers



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

def week_count
  @week_count
end

#week_date ⇒ Object

The start week date of this forecast in yyyy-MM-dd. Must fall on the start day of week for the associated business unit. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd



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

def week_date
  @week_date
end

Class Method Details

.attribute_map ⇒ Object

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



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
93
94
95
96
97
98
99
100
101
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 67

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'week_date' => :'weekDate',
    
    :'week_count' => :'weekCount',
    
    :'creation_method' => :'creationMethod',
    
    :'description' => :'description',
    
    :'legacy' => :'legacy',
    
    :'metadata' => :'metadata',
    
    :'reference_start_date' => :'referenceStartDate',
    
    :'source_days' => :'sourceDays',
    
    :'modifications' => :'modifications',
    
    :'generation_results' => :'generationResults',
    
    :'time_zone' => :'timeZone',
    
    :'planning_groups_version' => :'planningGroupsVersion',
    
    :'planning_groups' => :'planningGroups',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'week_date' => :'Date',
    
    :'week_count' => :'Integer',
    
    :'creation_method' => :'String',
    
    :'description' => :'String',
    
    :'legacy' => :'BOOLEAN',
    
    :'metadata' => :'WfmVersionedEntityMetadata',
    
    :'reference_start_date' => :'DateTime',
    
    :'source_days' => :'Array<ForecastSourceDayPointer>',
    
    :'modifications' => :'Array<BuForecastModification>',
    
    :'generation_results' => :'BuForecastGenerationResult',
    
    :'time_zone' => :'String',
    
    :'planning_groups_version' => :'Integer',
    
    :'planning_groups' => :'ForecastPlanningGroupsResponse',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 457

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      week_date == o.week_date &&
      week_count == o.week_count &&
      creation_method == o.creation_method &&
      description == o.description &&
      legacy == o.legacy &&
      metadata == o.metadata &&
      reference_start_date == o.reference_start_date &&
      source_days == o.source_days &&
      modifications == o.modifications &&
      generation_results == o.generation_results &&
      time_zone == o.time_zone &&
      planning_groups_version == o.planning_groups_version &&
      planning_groups == o.planning_groups &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 509

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



569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 569

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



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 490

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


479
480
481
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 479

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



485
486
487
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 485

def hash
  [id, week_date, week_count, creation_method, description, legacy, metadata, reference_start_date, source_days, modifications, generation_results, time_zone, planning_groups_version, planning_groups, 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



292
293
294
295
296
297
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 292

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



552
553
554
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 552

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



557
558
559
560
561
562
563
564
565
 
# File 'lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb', line 557

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 



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

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



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/bu_short_term_forecast.rb', line 301

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Import", "ImportedHistoricalWeightedAverage", "HistoricalWeightedAverage", "Advanced"]
  if @creation_method && !allowed_values.include?(@creation_method)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end