class PureCloud::BuForecastModification
Attributes
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
Whether the modification is enabled for the forecast
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
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
The legacy metric to which this modification applies if applicable
The metric to which this modification applies
The IDs of the planning groups to which this forecast modification applies. Leave empty to apply to all
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
The type of the modification
The value of the modification. Must be null if "values" is populated
The list of values to update. Only applicable for grid-type modifications. Must be null if "value" is populated
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute
type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
# 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
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_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 the object from hash
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/bu_forecast_modification.rb, line 423 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] legacy_metric
Object to be assigned
# File lib/purecloudplatformclientv2/models/bu_forecast_modification.rb, line 362 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/bu_forecast_modification.rb, line 228 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] metric Object to be assigned
# File lib/purecloudplatformclientv2/models/bu_forecast_modification.rb, line 348 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
return the object in the form of hash
# 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
# File lib/purecloudplatformclientv2/models/bu_forecast_modification.rb, line 491 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/purecloudplatformclientv2/models/bu_forecast_modification.rb, line 324 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
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_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