class PureCloud::HistoricalAdherenceExceptionInfo
Attributes
Activity for which the user is actually engaged
Exception end offset in seconds relative to query start time
The impact of the current adherence state for this user
Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue
Activity for which the user is scheduled
The ID of the scheduled activity for this user
The lookup ID used to retrieve secondary status from map of lookup ID to corresponding secondary presence ID
Exception start offset in seconds relative to query start time
Actual underlying system presence value
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 49 def self.attribute_map { :'start_offset_seconds' => :'startOffsetSeconds', :'end_offset_seconds' => :'endOffsetSeconds', :'scheduled_activity_code_id' => :'scheduledActivityCodeId', :'scheduled_activity_category' => :'scheduledActivityCategory', :'actual_activity_category' => :'actualActivityCategory', :'system_presence' => :'systemPresence', :'routing_status' => :'routingStatus', :'impact' => :'impact', :'secondary_presence_lookup_id' => :'secondaryPresenceLookupId' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 100 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?(:'startOffsetSeconds') self.start_offset_seconds = attributes[:'startOffsetSeconds'] end if attributes.has_key?(:'endOffsetSeconds') self.end_offset_seconds = attributes[:'endOffsetSeconds'] end if attributes.has_key?(:'scheduledActivityCodeId') self.scheduled_activity_code_id = attributes[:'scheduledActivityCodeId'] end if attributes.has_key?(:'scheduledActivityCategory') self.scheduled_activity_category = attributes[:'scheduledActivityCategory'] end if attributes.has_key?(:'actualActivityCategory') self.actual_activity_category = attributes[:'actualActivityCategory'] end if attributes.has_key?(:'systemPresence') self.system_presence = attributes[:'systemPresence'] end if attributes.has_key?(:'routingStatus') self.routing_status = attributes[:'routingStatus'] end if attributes.has_key?(:'impact') self.impact = attributes[:'impact'] end if attributes.has_key?(:'secondaryPresenceLookupId') self.secondary_presence_lookup_id = attributes[:'secondaryPresenceLookupId'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 74 def self.swagger_types { :'start_offset_seconds' => :'Integer', :'end_offset_seconds' => :'Integer', :'scheduled_activity_code_id' => :'String', :'scheduled_activity_category' => :'String', :'actual_activity_category' => :'String', :'system_presence' => :'String', :'routing_status' => :'RoutingStatus', :'impact' => :'String', :'secondary_presence_lookup_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 345 def ==(o) return true if self.equal?(o) self.class == o.class && start_offset_seconds == o.start_offset_seconds && end_offset_seconds == o.end_offset_seconds && scheduled_activity_code_id == o.scheduled_activity_code_id && scheduled_activity_category == o.scheduled_activity_category && actual_activity_category == o.actual_activity_category && system_presence == o.system_presence && routing_status == o.routing_status && impact == o.impact && secondary_presence_lookup_id == o.secondary_presence_lookup_id end
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 391 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/historical_adherence_exception_info.rb, line 451 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
Custom attribute writer method checking allowed values (enum). @param [Object] actual_activity_category
Object to be assigned
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 294 def actual_activity_category=(actual_activity_category) allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"] if actual_activity_category && !allowed_values.include?(actual_activity_category) fail ArgumentError, "invalid value for 'actual_activity_category', must be one of #{allowed_values}." end @actual_activity_category = actual_activity_category end
build the object from hash
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 372 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/historical_adherence_exception_info.rb, line 361 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 367 def hash [start_offset_seconds, end_offset_seconds, scheduled_activity_code_id, scheduled_activity_category, actual_activity_category, system_presence, routing_status, impact, secondary_presence_lookup_id].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] impact Object to be assigned
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 327 def impact=(impact) allowed_values = ["Positive", "Negative", "Neutral", "Unknown"] if impact && !allowed_values.include?(impact) fail ArgumentError, "invalid value for 'impact', must be one of #{allowed_values}." end @impact = impact end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 192 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] scheduled_activity_category
Object to be assigned
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 280 def scheduled_activity_category=(scheduled_activity_category) allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"] if scheduled_activity_category && !allowed_values.include?(scheduled_activity_category) fail ArgumentError, "invalid value for 'scheduled_activity_category', must be one of #{allowed_values}." end @scheduled_activity_category = scheduled_activity_category end
Custom attribute writer method checking allowed values (enum). @param [Object] system_presence
Object to be assigned
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 308 def system_presence=(system_presence) allowed_values = ["Available", "Away", "Busy", "Offline", "Idle", "OnQueue", "Meal", "Training", "Meeting", "Break"] if system_presence && !allowed_values.include?(system_presence) fail ArgumentError, "invalid value for 'system_presence', must be one of #{allowed_values}." end @system_presence = system_presence end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb, line 439 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/historical_adherence_exception_info.rb, line 429 def to_s to_hash.to_s 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/historical_adherence_exception_info.rb, line 201 def valid? allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"] if @scheduled_activity_category && !allowed_values.include?(@scheduled_activity_category) return false end allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"] if @actual_activity_category && !allowed_values.include?(@actual_activity_category) return false end allowed_values = ["Available", "Away", "Busy", "Offline", "Idle", "OnQueue", "Meal", "Training", "Meeting", "Break"] if @system_presence && !allowed_values.include?(@system_presence) return false end allowed_values = ["Positive", "Negative", "Neutral", "Unknown"] if @impact && !allowed_values.include?(@impact) return false end end