class PureCloud::UserScheduleAdherence
Attributes
Activity in which the user is actually engaged
The user's current adherence state
The globally unique identifier for the object.
The impact of the user's current adherenceState
Whether the user is marked OutOfOffice
The management unit to which this user belongs
Organization
Secondary Presence Id.
Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue
Activity for which the user is scheduled
The URI for this object
Actual underlying system presence value
Time when the user entered the current adherenceState in ISO-8601 format
The user for whom this status applies
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/user_schedule_adherence.rb, line 63 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'user' => :'user', :'management_unit' => :'managementUnit', :'scheduled_activity_category' => :'scheduledActivityCategory', :'system_presence' => :'systemPresence', :'organization_secondary_presence_id' => :'organizationSecondaryPresenceId', :'routing_status' => :'routingStatus', :'actual_activity_category' => :'actualActivityCategory', :'is_out_of_office' => :'isOutOfOffice', :'adherence_state' => :'adherenceState', :'impact' => :'impact', :'time_of_adherence_change' => :'timeOfAdherenceChange', :'self_uri' => :'selfUri' } end
# File lib/purecloud/models/user_schedule_adherence.rb, line 118 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[:'id'] self.id = attributes[:'id'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'user'] self.user = attributes[:'user'] end if attributes[:'managementUnit'] self.management_unit = attributes[:'managementUnit'] end if attributes[:'scheduledActivityCategory'] self.scheduled_activity_category = attributes[:'scheduledActivityCategory'] end if attributes[:'systemPresence'] self.system_presence = attributes[:'systemPresence'] end if attributes[:'organizationSecondaryPresenceId'] self.organization_secondary_presence_id = attributes[:'organizationSecondaryPresenceId'] end if attributes[:'routingStatus'] self.routing_status = attributes[:'routingStatus'] end if attributes[:'actualActivityCategory'] self.actual_activity_category = attributes[:'actualActivityCategory'] end if attributes[:'isOutOfOffice'] self.is_out_of_office = attributes[:'isOutOfOffice'] end if attributes[:'adherenceState'] self.adherence_state = attributes[:'adherenceState'] end if attributes[:'impact'] self.impact = attributes[:'impact'] end if attributes[:'timeOfAdherenceChange'] self.time_of_adherence_change = attributes[:'timeOfAdherenceChange'] end if attributes[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloud/models/user_schedule_adherence.rb, line 98 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'user' => :'User', :'management_unit' => :'ManagementUnit', :'scheduled_activity_category' => :'String', :'system_presence' => :'String', :'organization_secondary_presence_id' => :'String', :'routing_status' => :'String', :'actual_activity_category' => :'String', :'is_out_of_office' => :'BOOLEAN', :'adherence_state' => :'String', :'impact' => :'String', :'time_of_adherence_change' => :'String', :'self_uri' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/user_schedule_adherence.rb, line 238 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && user == o.user && management_unit == o.management_unit && scheduled_activity_category == o.scheduled_activity_category && system_presence == o.system_presence && organization_secondary_presence_id == o.organization_secondary_presence_id && routing_status == o.routing_status && actual_activity_category == o.actual_activity_category && is_out_of_office == o.is_out_of_office && adherence_state == o.adherence_state && impact == o.impact && time_of_adherence_change == o.time_of_adherence_change && self_uri == o.self_uri end
# File lib/purecloud/models/user_schedule_adherence.rb, line 287 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/purecloud/models/user_schedule_adherence.rb, line 347 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).
# File lib/purecloud/models/user_schedule_adherence.rb, line 211 def actual_activity_category=(actual_activity_category) allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable"] if actual_activity_category && !allowed_values.include?(actual_activity_category) fail "invalid value for 'actual_activity_category', must be one of #{allowed_values}" end @actual_activity_category = actual_activity_category end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/user_schedule_adherence.rb, line 220 def adherence_state=(adherence_state) allowed_values = ["InAdherence", "OutOfAdherence", "Unscheduled", "Unknown"] if adherence_state && !allowed_values.include?(adherence_state) fail "invalid value for 'adherence_state', must be one of #{allowed_values}" end @adherence_state = adherence_state end
build the object from hash
# File lib/purecloud/models/user_schedule_adherence.rb, line 268 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
# File lib/purecloud/models/user_schedule_adherence.rb, line 258 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/user_schedule_adherence.rb, line 263 def hash [id, name, user, management_unit, scheduled_activity_category, system_presence, organization_secondary_presence_id, routing_status, actual_activity_category, is_out_of_office, adherence_state, impact, time_of_adherence_change, self_uri].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/user_schedule_adherence.rb, line 229 def impact=(impact) allowed_values = ["Positive", "Negative", "Neutral", "Unknown"] if impact && !allowed_values.include?(impact) fail "invalid value for 'impact', must be one of #{allowed_values}" end @impact = impact end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/user_schedule_adherence.rb, line 202 def routing_status=(routing_status) allowed_values = ["OFF_QUEUE", "IDLE", "INTERACTING", "NOT_RESPONDING", "COMMUNICATING"] if routing_status && !allowed_values.include?(routing_status) fail "invalid value for 'routing_status', must be one of #{allowed_values}" end @routing_status = routing_status end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/user_schedule_adherence.rb, line 184 def scheduled_activity_category=(scheduled_activity_category) allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable"] if scheduled_activity_category && !allowed_values.include?(scheduled_activity_category) fail "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).
# File lib/purecloud/models/user_schedule_adherence.rb, line 193 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 "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/purecloud/models/user_schedule_adherence.rb, line 335 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/purecloud/models/user_schedule_adherence.rb, line 325 def to_s to_hash.to_s end