Class: PureCloud::ForecastCreation

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/forecast_creation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ForecastCreation

Returns a new instance of ForecastCreation.



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
102
103
104
 
# File 'lib/purecloud/models/forecast_creation.rb', line 71

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'numberOfPeriods']
    self.number_of_periods = attributes[:'numberOfPeriods']
  end
  
  if attributes[:'periodFrequency']
    self.period_frequency = attributes[:'periodFrequency']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'metrics']
    if (value = attributes[:'metrics']).is_a?(Array)
      self.metrics = value
    end
  end
  
  if attributes[:'managementUnitId']
    self.management_unit_id = attributes[:'managementUnitId']
  end
  
  if attributes[:'copiedForecastId']
    self.copied_forecast_id = attributes[:'copiedForecastId']
  end
  
end

Instance Attribute Details

#copied_forecast_id ⇒ Object

The id of forecast the new forecast will copy from



37
38
39
 
# File 'lib/purecloud/models/forecast_creation.rb', line 37

def copied_forecast_id
  @copied_forecast_id
end

#description ⇒ Object

The description of the forecast to be created



28
29
30
 
# File 'lib/purecloud/models/forecast_creation.rb', line 28

def description
  @description
end

#management_unit_id ⇒ Object

The id of the management unit to which the new forecast belongs



34
35
36
 
# File 'lib/purecloud/models/forecast_creation.rb', line 34

def management_unit_id
  @management_unit_id
end

#metrics ⇒ Object

The metrics the forecast is for



31
32
33
 
# File 'lib/purecloud/models/forecast_creation.rb', line 31

def metrics
  @metrics
end

#number_of_periods ⇒ Object

The number of periods to be forecasted for



22
23
24
 
# File 'lib/purecloud/models/forecast_creation.rb', line 22

def number_of_periods
  @number_of_periods
end

#period_frequency ⇒ Object

The frequency of the period



25
26
27
 
# File 'lib/purecloud/models/forecast_creation.rb', line 25

def period_frequency
  @period_frequency
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/purecloud/models/forecast_creation.rb', line 40

def self.attribute_map
  {
    
    :'number_of_periods' => :'numberOfPeriods',
    
    :'period_frequency' => :'periodFrequency',
    
    :'description' => :'description',
    
    :'metrics' => :'metrics',
    
    :'management_unit_id' => :'managementUnitId',
    
    :'copied_forecast_id' => :'copiedForecastId'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/purecloud/models/forecast_creation.rb', line 59

def self.swagger_types
  {
    :'number_of_periods' => :'Integer',
    :'period_frequency' => :'String',
    :'description' => :'String',
    :'metrics' => :'Array<String>',
    :'management_unit_id' => :'String',
    :'copied_forecast_id' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/purecloud/models/forecast_creation.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      number_of_periods == o.number_of_periods &&
      period_frequency == o.period_frequency &&
      description == o.description &&
      metrics == o.metrics &&
      management_unit_id == o.management_unit_id &&
      copied_forecast_id == o.copied_forecast_id
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/forecast_creation.rb', line 157

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



217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/purecloud/models/forecast_creation.rb', line 217

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/purecloud/models/forecast_creation.rb', line 138

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

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
 
# File 'lib/purecloud/models/forecast_creation.rb', line 128

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



133
134
135
 
# File 'lib/purecloud/models/forecast_creation.rb', line 133

def hash
  [number_of_periods, period_frequency, description, metrics, management_unit_id, copied_forecast_id].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



200
201
202
 
# File 'lib/purecloud/models/forecast_creation.rb', line 200

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



205
206
207
208
209
210
211
212
213
 
# File 'lib/purecloud/models/forecast_creation.rb', line 205

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 



195
196
197
 
# File 'lib/purecloud/models/forecast_creation.rb', line 195

def to_s
  to_hash.to_s
end