class PureCloud::BuShortTermForecast

Attributes

creation_method[RW]

The method by which this forecast was created

description[RW]

The description of this forecast

generation_results[RW]

Generation result metadata

id[RW]

The globally unique identifier for the object.

legacy[RW]

Whether this forecast contains modifications on legacy metrics

metadata[RW]

Metadata for this forecast

modifications[RW]

Any manual modifications applied to this forecast

planning_groups[RW]

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

planning_groups_version[RW]

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

reference_start_date[RW]

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

self_uri[RW]

The URI for this object

source_days[RW]

The source day pointers for this forecast

time_zone[RW]

The time zone for this forecast

week_count[RW]

The number of weeks this forecast covers

week_date[RW]

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

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

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

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

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

# 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) click to toggle source
# 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) 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/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) click to toggle source

build the object from hash

# 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
creation_method=(creation_method) click to toggle source

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

# File lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb, line 389
def creation_method=(creation_method)
  allowed_values = ["Import", "ImportedHistoricalWeightedAverage", "HistoricalWeightedAverage", "Advanced"]
  if creation_method && !allowed_values.include?(creation_method)
    fail ArgumentError, "invalid value for 'creation_method', must be one of #{allowed_values}."
  end
  @creation_method = creation_method
end
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb, line 479
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/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() 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/bu_short_term_forecast.rb, line 292
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# 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() click to toggle source
# File lib/purecloudplatformclientv2/models/bu_short_term_forecast.rb, line 547
def to_s
  to_hash.to_s
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/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