class PureCloud::ActivityCode
Activity code data
Attributes
Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off.
The activity code's category.
Whether an agent is paid while performing this activity
Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints
The globally unique identifier for the object.
Whether this activity code is active or has been deleted
Whether this is a default activity code
The default length of the activity in minutes
Version metadata for the associated management unit's list of activity codes
The name of the activity code. Default activity codes will be created with an empty name
The URI for this object
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 56 def self.attribute_map { :'id' => :'id', :'self_uri' => :'selfUri', :'name' => :'name', :'is_active' => :'isActive', :'is_default' => :'isDefault', :'category' => :'category', :'length_in_minutes' => :'lengthInMinutes', :'counts_as_paid_time' => :'countsAsPaidTime', :'counts_as_work_time' => :'countsAsWorkTime', :'agent_time_off_selectable' => :'agentTimeOffSelectable', :'metadata' => :'metadata' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 115 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?(:'selfUri') self.self_uri = attributes[:'selfUri'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'isActive') self.is_active = attributes[:'isActive'] end if attributes.has_key?(:'isDefault') self.is_default = attributes[:'isDefault'] end if attributes.has_key?(:'category') self.category = attributes[:'category'] end if attributes.has_key?(:'lengthInMinutes') self.length_in_minutes = attributes[:'lengthInMinutes'] end if attributes.has_key?(:'countsAsPaidTime') self.counts_as_paid_time = attributes[:'countsAsPaidTime'] end if attributes.has_key?(:'countsAsWorkTime') self.counts_as_work_time = attributes[:'countsAsWorkTime'] end if attributes.has_key?(:'agentTimeOffSelectable') self.agent_time_off_selectable = attributes[:'agentTimeOffSelectable'] end if attributes.has_key?(:'metadata') self.metadata = attributes[:'metadata'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 85 def self.swagger_types { :'id' => :'String', :'self_uri' => :'String', :'name' => :'String', :'is_active' => :'BOOLEAN', :'is_default' => :'BOOLEAN', :'category' => :'String', :'length_in_minutes' => :'Integer', :'counts_as_paid_time' => :'BOOLEAN', :'counts_as_work_time' => :'BOOLEAN', :'agent_time_off_selectable' => :'BOOLEAN', :'metadata' => :'WfmVersionedEntityMetadata' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 359 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && self_uri == o.self_uri && name == o.name && is_active == o.is_active && is_default == o.is_default && category == o.category && length_in_minutes == o.length_in_minutes && counts_as_paid_time == o.counts_as_paid_time && counts_as_work_time == o.counts_as_work_time && agent_time_off_selectable == o.agent_time_off_selectable && metadata == o.metadata end
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 407 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/activity_code.rb, line 467 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 the object from hash
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 388 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
Custom attribute writer method checking allowed values (enum). @param [Object] category Object to be assigned
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 321 def category=(category) allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"] if category && !allowed_values.include?(category) fail ArgumentError, "invalid value for 'category', must be one of #{allowed_values}." end @category = category end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 377 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 383 def hash [id, self_uri, name, is_active, is_default, category, length_in_minutes, counts_as_paid_time, counts_as_work_time, agent_time_off_selectable, metadata].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 225 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/activity_code.rb, line 455 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/activity_code.rb, line 445 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/activity_code.rb, line 234 def valid? allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"] if @category && !allowed_values.include?(@category) return false end if @metadata.nil? return false end end