class PureCloud::UserScheduleActivity

Represents a single activity in a user's shift

Attributes

activity_code_id[RW]

The id for the activity code. Look up a map of activity codes with the activities route

counts_as_paid_time[RW]

Whether this activity is paid

description[RW]

Description for this activity

is_dst_fallback[RW]

Whether this activity spans a DST fallback

length_in_minutes[RW]

Length in minutes for this activity

start_date[RW]

Start time in UTC for this activity, in ISO-8601 format

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/user_schedule_activity.rb, line 41
def self.attribute_map
  {
    
    :'activity_code_id' => :'activityCodeId',
    
    :'start_date' => :'startDate',
    
    :'length_in_minutes' => :'lengthInMinutes',
    
    :'description' => :'description',
    
    :'counts_as_paid_time' => :'countsAsPaidTime',
    
    :'is_dst_fallback' => :'isDstFallback'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/user_schedule_activity.rb, line 72
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[:'activityCodeId']
    self.activity_code_id = attributes[:'activityCodeId']
  end
  
  if attributes[:'startDate']
    self.start_date = attributes[:'startDate']
  end
  
  if attributes[:'lengthInMinutes']
    self.length_in_minutes = attributes[:'lengthInMinutes']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'countsAsPaidTime']
    self.counts_as_paid_time = attributes[:'countsAsPaidTime']
  end
  
  if attributes[:'isDstFallback']
    self.is_dst_fallback = attributes[:'isDstFallback']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/user_schedule_activity.rb, line 60
def self.swagger_types
  {
    :'activity_code_id' => :'String',
    :'start_date' => :'DateTime',
    :'length_in_minutes' => :'Integer',
    :'description' => :'String',
    :'counts_as_paid_time' => :'BOOLEAN',
    :'is_dst_fallback' => :'BOOLEAN'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/user_schedule_activity.rb, line 106
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      activity_code_id == o.activity_code_id &&
      start_date == o.start_date &&
      length_in_minutes == o.length_in_minutes &&
      description == o.description &&
      counts_as_paid_time == o.counts_as_paid_time &&
      is_dst_fallback == o.is_dst_fallback
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/user_schedule_activity.rb, line 147
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/purecloud/models/user_schedule_activity.rb, line 207
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/purecloud/models/user_schedule_activity.rb, line 128
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

# File lib/purecloud/models/user_schedule_activity.rb, line 118
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/user_schedule_activity.rb, line 123
def hash
  [activity_code_id, start_date, length_in_minutes, description, counts_as_paid_time, is_dst_fallback].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/user_schedule_activity.rb, line 190
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/user_schedule_activity.rb, line 195
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/purecloud/models/user_schedule_activity.rb, line 185
def to_s
  to_hash.to_s
end