class PureCloud::WfmUserNotification
Attributes
Whether this notification is for an agent
The immutable globally unique identifier for the object.
Whether this notification has been marked "read"
The group ID of the notification (mutable, may change on update)
Other notification IDs in group. This field is only populated in real-time notifications
A shift trade notification. Only set if type == ShiftTrade
A time off request notification. Only set if type == TimeOffRequest
The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The type of this notification
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/wfm_user_notification.rb, line 49 def self.attribute_map { :'id' => :'id', :'mutable_group_id' => :'mutableGroupId', :'timestamp' => :'timestamp', :'type' => :'type', :'shift_trade' => :'shiftTrade', :'time_off_request' => :'timeOffRequest', :'marked_as_read' => :'markedAsRead', :'agent_notification' => :'agentNotification', :'other_notification_ids_in_group' => :'otherNotificationIdsInGroup' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/wfm_user_notification.rb, line 100 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?(:'mutableGroupId') self.mutable_group_id = attributes[:'mutableGroupId'] end if attributes.has_key?(:'timestamp') self.timestamp = attributes[:'timestamp'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'shiftTrade') self.shift_trade = attributes[:'shiftTrade'] end if attributes.has_key?(:'timeOffRequest') self.time_off_request = attributes[:'timeOffRequest'] end if attributes.has_key?(:'markedAsRead') self.marked_as_read = attributes[:'markedAsRead'] end if attributes.has_key?(:'agentNotification') self.agent_notification = attributes[:'agentNotification'] end if attributes.has_key?(:'otherNotificationIdsInGroup') if (value = attributes[:'otherNotificationIdsInGroup']).is_a?(Array) self.other_notification_ids_in_group = value end end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/wfm_user_notification.rb, line 74 def self.swagger_types { :'id' => :'String', :'mutable_group_id' => :'String', :'timestamp' => :'DateTime', :'type' => :'String', :'shift_trade' => :'ShiftTradeNotification', :'time_off_request' => :'TimeOffRequestNotification', :'marked_as_read' => :'BOOLEAN', :'agent_notification' => :'BOOLEAN', :'other_notification_ids_in_group' => :'Array<String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/wfm_user_notification.rb, line 320 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && mutable_group_id == o.mutable_group_id && timestamp == o.timestamp && type == o.type && shift_trade == o.shift_trade && time_off_request == o.time_off_request && marked_as_read == o.marked_as_read && agent_notification == o.agent_notification && other_notification_ids_in_group == o.other_notification_ids_in_group end
# File lib/purecloudplatformclientv2/models/wfm_user_notification.rb, line 366 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/wfm_user_notification.rb, line 426 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/wfm_user_notification.rb, line 347 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/wfm_user_notification.rb, line 336 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/wfm_user_notification.rb, line 342 def hash [id, mutable_group_id, timestamp, type, shift_trade, time_off_request, marked_as_read, agent_notification, other_notification_ids_in_group].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/wfm_user_notification.rb, line 194 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/wfm_user_notification.rb, line 414 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/wfm_user_notification.rb, line 404 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/purecloudplatformclientv2/models/wfm_user_notification.rb, line 282 def type=(type) allowed_values = ["ShiftTrade", "TimeOffRequest"] if type && !allowed_values.include?(type) fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}." end @type = type 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/wfm_user_notification.rb, line 203 def valid? if @id.nil? return false end if @mutable_group_id.nil? return false end allowed_values = ["ShiftTrade", "TimeOffRequest"] if @type && !allowed_values.include?(@type) return false end if @marked_as_read.nil? return false end end