class PureCloud::WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate

Attributes

active_queues[RW]
active_queues_modified_time[RW]
actual_activity_category[RW]
adherence_change_time[RW]
adherence_state[RW]
impact[RW]
is_out_of_office[RW]
management_unit_id[RW]
organization_secondary_presence_id[RW]
presence_update_time[RW]
removed_from_management_unit[RW]
routing_status[RW]
scheduled_activity_category[RW]
system_presence[RW]
team[RW]
user[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 54
def self.attribute_map
  {
    
    :'user' => :'user',
    
    :'management_unit_id' => :'managementUnitId',
    
    :'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',
    
    :'adherence_change_time' => :'adherenceChangeTime',
    
    :'presence_update_time' => :'presenceUpdateTime',
    
    :'active_queues' => :'activeQueues',
    
    :'active_queues_modified_time' => :'activeQueuesModifiedTime',
    
    :'removed_from_management_unit' => :'removedFromManagementUnit'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 133
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?(:'user')
    
    
    self.user = attributes[:'user']
    
  
  end

  
  if attributes.has_key?(:'managementUnitId')
    
    
    self.management_unit_id = attributes[:'managementUnitId']
    
  
  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?(:'adherenceChangeTime')
    
    
    self.adherence_change_time = attributes[:'adherenceChangeTime']
    
  
  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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 93
def self.swagger_types
  {
    
    :'user' => :'WfmUserScheduleAdherenceUpdatedTopicUserReference',
    
    :'management_unit_id' => :'String',
    
    :'team' => :'WfmUserScheduleAdherenceUpdatedTopicUriReference',
    
    :'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',
    
    :'adherence_change_time' => :'DateTime',
    
    :'presence_update_time' => :'DateTime',
    
    :'active_queues' => :'Array<WfmUserScheduleAdherenceUpdatedTopicQueueReference>',
    
    :'active_queues_modified_time' => :'DateTime',
    
    :'removed_from_management_unit' => :'BOOLEAN'
    
  }
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/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 478
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user == o.user &&
      management_unit_id == o.management_unit_id &&
      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 &&
      adherence_change_time == o.adherence_change_time &&
      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
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 531
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/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 591
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
adherence_state=(adherence_state) click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 435
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_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 512
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
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 501
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/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 507
def hash
  [user, management_unit_id, team, scheduled_activity_category, system_presence, organization_secondary_presence_id, routing_status, actual_activity_category, is_out_of_office, adherence_state, impact, adherence_change_time, presence_update_time, active_queues, active_queues_modified_time, removed_from_management_unit].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/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 290
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
routing_status=(routing_status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 411
def routing_status=(routing_status)
  allowed_values = ["__EMPTY__", "OFF_QUEUE", "IDLE", "INTERACTING", "NOT_RESPONDING", "COMMUNICATING", "OFFLINE"]
  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
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 579
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/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 569
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/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb, line 299
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["__EMPTY__", "OFF_QUEUE", "IDLE", "INTERACTING", "NOT_RESPONDING", "COMMUNICATING", "OFFLINE"]
  if @routing_status && !allowed_values.include?(@routing_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["InAdherence", "OutOfAdherence", "Unscheduled", "Unknown", "Ignored"]
  if @adherence_state && !allowed_values.include?(@adherence_state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end