class PureCloud::UserScheduleAdherence
Attributes
The list of queues to which this user is joined
Time when the list of active queues for this user was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
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.
Time when presence was last updated. Used to calculate time in current status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
For notification purposes. Used to indicate that a user was removed from the management unit
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
The team to which this user belongs
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/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 78 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'user' => :'user', :'management_unit' => :'managementUnit', :'team' => :'team', :'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', :'presence_update_time' => :'presenceUpdateTime', :'active_queues' => :'activeQueues', :'active_queues_modified_time' => :'activeQueuesModifiedTime', :'removed_from_management_unit' => :'removedFromManagementUnit', :'self_uri' => :'selfUri' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 169 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'user') self.user = attributes[:'user'] end if attributes.has_key?(:'managementUnit') self.management_unit = attributes[:'managementUnit'] end if attributes.has_key?(:'team') self.team = attributes[:'team'] end if attributes.has_key?(:'scheduledActivityCategory') self.scheduled_activity_category = attributes[:'scheduledActivityCategory'] end if attributes.has_key?(:'systemPresence') self.system_presence = attributes[:'systemPresence'] end if attributes.has_key?(:'organizationSecondaryPresenceId') self.organization_secondary_presence_id = attributes[:'organizationSecondaryPresenceId'] end if attributes.has_key?(:'routingStatus') self.routing_status = attributes[:'routingStatus'] end if attributes.has_key?(:'actualActivityCategory') self.actual_activity_category = attributes[:'actualActivityCategory'] end if attributes.has_key?(:'isOutOfOffice') self.is_out_of_office = attributes[:'isOutOfOffice'] end if attributes.has_key?(:'adherenceState') self.adherence_state = attributes[:'adherenceState'] end if attributes.has_key?(:'impact') self.impact = attributes[:'impact'] end if attributes.has_key?(:'timeOfAdherenceChange') self.time_of_adherence_change = attributes[:'timeOfAdherenceChange'] end if attributes.has_key?(:'presenceUpdateTime') self.presence_update_time = attributes[:'presenceUpdateTime'] end if attributes.has_key?(:'activeQueues') if (value = attributes[:'activeQueues']).is_a?(Array) self.active_queues = value end end if attributes.has_key?(:'activeQueuesModifiedTime') self.active_queues_modified_time = attributes[:'activeQueuesModifiedTime'] end if attributes.has_key?(:'removedFromManagementUnit') self.removed_from_management_unit = attributes[:'removedFromManagementUnit'] end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 123 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'user' => :'UserReference', :'management_unit' => :'ManagementUnit', :'team' => :'Team', :'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' => :'DateTime', :'presence_update_time' => :'DateTime', :'active_queues' => :'Array<QueueReference>', :'active_queues_modified_time' => :'DateTime', :'removed_from_management_unit' => :'BOOLEAN', :'self_uri' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 624 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 && team == o.team && 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 && presence_update_time == o.presence_update_time && active_queues == o.active_queues && active_queues_modified_time == o.active_queues_modified_time && removed_from_management_unit == o.removed_from_management_unit && self_uri == o.self_uri end
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 680 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/user_schedule_adherence.rb, line 740 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/user_schedule_adherence.rb, line 548 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
Custom attribute writer method checking allowed values (enum). @param [Object] adherence_state
Object to be assigned
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 567 def adherence_state=(adherence_state) allowed_values = ["InAdherence", "OutOfAdherence", "Unscheduled", "Unknown", "Ignored"] if adherence_state && !allowed_values.include?(adherence_state) fail ArgumentError, "invalid value for 'adherence_state', must be one of #{allowed_values}." end @adherence_state = adherence_state end
build the object from hash
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 661 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/user_schedule_adherence.rb, line 650 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 656 def hash [id, name, user, management_unit, team, 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, presence_update_time, active_queues, active_queues_modified_time, removed_from_management_unit, self_uri].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] impact Object to be assigned
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 581 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/user_schedule_adherence.rb, line 353 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] routing_status
Object to be assigned
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 534 def routing_status=(routing_status) allowed_values = ["OFF_QUEUE", "IDLE", "INTERACTING", "NOT_RESPONDING", "COMMUNICATING"] if routing_status && !allowed_values.include?(routing_status) fail ArgumentError, "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). @param [Object] scheduled_activity_category
Object to be assigned
# File lib/purecloudplatformclientv2/models/user_schedule_adherence.rb, line 501 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/user_schedule_adherence.rb, line 515 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/user_schedule_adherence.rb, line 728 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/user_schedule_adherence.rb, line 718 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/user_schedule_adherence.rb, line 362 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 = ["Available", "Away", "Busy", "Offline", "Idle", "OnQueue", "Meal", "Training", "Meeting", "Break"] if @system_presence && !allowed_values.include?(@system_presence) return false end allowed_values = ["OFF_QUEUE", "IDLE", "INTERACTING", "NOT_RESPONDING", "COMMUNICATING"] if @routing_status && !allowed_values.include?(@routing_status) 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 = ["InAdherence", "OutOfAdherence", "Unscheduled", "Unknown", "Ignored"] if @adherence_state && !allowed_values.include?(@adherence_state) return false end allowed_values = ["Positive", "Negative", "Neutral", "Unknown"] if @impact && !allowed_values.include?(@impact) return false end end