class PureCloud::WfmBuShortTermForecastImportCompleteTopicBuForecastModification

Attributes

display_granularity[RW]
enabled[RW]
end_interval_index[RW]
granularity[RW]
legacy_metric[RW]
metric[RW]
planning_group_ids[RW]
start_interval_index[RW]
type[RW]
value[RW]
values[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 44
def self.attribute_map
  {
    
    :'type' => :'type',
    
    :'start_interval_index' => :'startIntervalIndex',
    
    :'end_interval_index' => :'endIntervalIndex',
    
    :'metric' => :'metric',
    
    :'legacy_metric' => :'legacyMetric',
    
    :'value' => :'value',
    
    :'values' => :'values',
    
    :'enabled' => :'enabled',
    
    :'granularity' => :'granularity',
    
    :'display_granularity' => :'displayGranularity',
    
    :'planning_group_ids' => :'planningGroupIds'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 103
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?(:'enabled')
    
    
    self.enabled = attributes[:'enabled']
    
  
  end

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 73
def self.swagger_types
  {
    
    :'type' => :'String',
    
    :'start_interval_index' => :'Integer',
    
    :'end_interval_index' => :'Integer',
    
    :'metric' => :'String',
    
    :'legacy_metric' => :'String',
    
    :'value' => :'Float',
    
    :'values' => :'Array<WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue>',
    
    :'enabled' => :'BOOLEAN',
    
    :'granularity' => :'String',
    
    :'display_granularity' => :'String',
    
    :'planning_group_ids' => :'Array<String>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 374
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 &&
      enabled == o.enabled &&
      granularity == o.granularity &&
      display_granularity == o.display_granularity &&
      planning_group_ids == o.planning_group_ids
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 422
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) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 482
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) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 403
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 392
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 398
def hash
  [type, start_interval_index, end_interval_index, metric, legacy_metric, value, values, enabled, granularity, display_granularity, planning_group_ids].hash
end
legacy_metric=(legacy_metric) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] legacy_metric Object to be assigned

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 331
def legacy_metric=(legacy_metric)
  allowed_values = ["AverageAfterCallWorkTimeSeconds", "AverageHandleTimeSeconds", "AverageTalkTimeSeconds", "Offered"]
  if legacy_metric && !allowed_values.include?(legacy_metric)
    fail ArgumentError, "invalid value for 'legacy_metric', must be one of #{allowed_values}."
  end
  @legacy_metric = legacy_metric
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 217
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
metric=(metric) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] metric Object to be assigned

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 317
def metric=(metric)
  allowed_values = ["Offered", "AverageHandleTimeSeconds"]
  if metric && !allowed_values.include?(metric)
    fail ArgumentError, "invalid value for 'metric', must be one of #{allowed_values}."
  end
  @metric = metric
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 465
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 470
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() click to toggle source
# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 460
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 293
def type=(type)
  allowed_values = ["MinimumPerInterval", "MaximumPerInterval", "SetValuePerInterval", "ChangeValuePerInterval", "ChangePercentPerInterval", "SetValueOverRange", "ChangeValueOverRange", "SetValuesForIntervalSet"]
  if type && !allowed_values.include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb, line 226
def valid?
  
  
  
  allowed_values = ["MinimumPerInterval", "MaximumPerInterval", "SetValuePerInterval", "ChangeValuePerInterval", "ChangePercentPerInterval", "SetValueOverRange", "ChangeValueOverRange", "SetValuesForIntervalSet"]
  if @type && !allowed_values.include?(@type)
    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
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end