class PureCloud::ScheduleGenerationWarning

Schedule generation warning

Attributes

no_need_days[RW]

Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels

shifts_too_close_together[RW]

Whether the schedule did not meet the minimum time between shifts defined in the agent work plan

unable_to_meet_max_days[RW]

Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan

unable_to_meet_max_paid_for_the_week[RW]

Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan

unable_to_meet_min_paid_for_the_week[RW]

Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan

unable_to_schedule_required_days[RW]

Days indicated as required to work in agent work plan where no viable shift was found to schedule

user_id[RW]

ID of the user in the warning

user_not_licensed[RW]

Whether the user does not have the appropriate license to be scheduled

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/schedule_generation_warning.rb, line 47
def self.attribute_map
  {
    
    :'user_id' => :'userId',
    
    :'user_not_licensed' => :'userNotLicensed',
    
    :'unable_to_meet_max_days' => :'unableToMeetMaxDays',
    
    :'unable_to_schedule_required_days' => :'unableToScheduleRequiredDays',
    
    :'unable_to_meet_min_paid_for_the_week' => :'unableToMeetMinPaidForTheWeek',
    
    :'unable_to_meet_max_paid_for_the_week' => :'unableToMeetMaxPaidForTheWeek',
    
    :'no_need_days' => :'noNeedDays',
    
    :'shifts_too_close_together' => :'shiftsTooCloseTogether'
    
  }
end
new(attributes = {}) click to toggle source

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

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

  
  if attributes.has_key?(:'userNotLicensed')
    
    
    self.user_not_licensed = attributes[:'userNotLicensed']
    
  
  end

  
  if attributes.has_key?(:'unableToMeetMaxDays')
    
    
    self.unable_to_meet_max_days = attributes[:'unableToMeetMaxDays']
    
  
  end

  
  if attributes.has_key?(:'unableToScheduleRequiredDays')
    
    if (value = attributes[:'unableToScheduleRequiredDays']).is_a?(Array)
      self.unable_to_schedule_required_days = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'unableToMeetMinPaidForTheWeek')
    
    
    self.unable_to_meet_min_paid_for_the_week = attributes[:'unableToMeetMinPaidForTheWeek']
    
  
  end

  
  if attributes.has_key?(:'unableToMeetMaxPaidForTheWeek')
    
    
    self.unable_to_meet_max_paid_for_the_week = attributes[:'unableToMeetMaxPaidForTheWeek']
    
  
  end

  
  if attributes.has_key?(:'noNeedDays')
    
    if (value = attributes[:'noNeedDays']).is_a?(Array)
      self.no_need_days = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'shiftsTooCloseTogether')
    
    
    self.shifts_too_close_together = attributes[:'shiftsTooCloseTogether']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/schedule_generation_warning.rb, line 70
def self.swagger_types
  {
    
    :'user_id' => :'String',
    
    :'user_not_licensed' => :'BOOLEAN',
    
    :'unable_to_meet_max_days' => :'BOOLEAN',
    
    :'unable_to_schedule_required_days' => :'Array<String>',
    
    :'unable_to_meet_min_paid_for_the_week' => :'BOOLEAN',
    
    :'unable_to_meet_max_paid_for_the_week' => :'BOOLEAN',
    
    :'no_need_days' => :'Array<String>',
    
    :'shifts_too_close_together' => :'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/schedule_generation_warning.rb, line 269
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      user_id == o.user_id &&
      user_not_licensed == o.user_not_licensed &&
      unable_to_meet_max_days == o.unable_to_meet_max_days &&
      unable_to_schedule_required_days == o.unable_to_schedule_required_days &&
      unable_to_meet_min_paid_for_the_week == o.unable_to_meet_min_paid_for_the_week &&
      unable_to_meet_max_paid_for_the_week == o.unable_to_meet_max_paid_for_the_week &&
      no_need_days == o.no_need_days &&
      shifts_too_close_together == o.shifts_too_close_together
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/schedule_generation_warning.rb, line 314
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/schedule_generation_warning.rb, line 374
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_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/schedule_generation_warning.rb, line 295
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/schedule_generation_warning.rb, line 284
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/schedule_generation_warning.rb, line 290
def hash
  [user_id, user_not_licensed, unable_to_meet_max_days, unable_to_schedule_required_days, unable_to_meet_min_paid_for_the_week, unable_to_meet_max_paid_for_the_week, no_need_days, shifts_too_close_together].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/schedule_generation_warning.rb, line 181
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/schedule_generation_warning.rb, line 362
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/schedule_generation_warning.rb, line 352
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/schedule_generation_warning.rb, line 190
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end