class PureCloud::AnalyticsParticipant
Attributes
List of attributes associated to this participant
External Contact
Identifier
External Organization
Identifier
Reason for which participant flagged conversation
Unique identifier for the participant
A human readable name identifying the participant
The participant's purpose
List of sessions associated to this participant
The team id the user is a member of
If a user, then this will be the unique identifier for the user
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 52 def self.attribute_map { :'participant_id' => :'participantId', :'participant_name' => :'participantName', :'user_id' => :'userId', :'purpose' => :'purpose', :'external_contact_id' => :'externalContactId', :'external_organization_id' => :'externalOrganizationId', :'flagged_reason' => :'flaggedReason', :'team_id' => :'teamId', :'sessions' => :'sessions', :'attributes' => :'attributes' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 107 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?(:'participantId') self.participant_id = attributes[:'participantId'] end if attributes.has_key?(:'participantName') self.participant_name = attributes[:'participantName'] end if attributes.has_key?(:'userId') self.user_id = attributes[:'userId'] end if attributes.has_key?(:'purpose') self.purpose = attributes[:'purpose'] end if attributes.has_key?(:'externalContactId') self.external_contact_id = attributes[:'externalContactId'] end if attributes.has_key?(:'externalOrganizationId') self.external_organization_id = attributes[:'externalOrganizationId'] end if attributes.has_key?(:'flaggedReason') self.flagged_reason = attributes[:'flaggedReason'] end if attributes.has_key?(:'teamId') self.team_id = attributes[:'teamId'] end if attributes.has_key?(:'sessions') if (value = attributes[:'sessions']).is_a?(Array) self.sessions = value end end if attributes.has_key?(:'attributes') if (value = attributes[:'attributes']).is_a?(Array) self.attributes = value end end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 79 def self.swagger_types { :'participant_id' => :'String', :'participant_name' => :'String', :'user_id' => :'String', :'purpose' => :'String', :'external_contact_id' => :'String', :'external_organization_id' => :'String', :'flagged_reason' => :'String', :'team_id' => :'String', :'sessions' => :'Array<AnalyticsSession>', :'attributes' => :'Hash<String, String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 346 def ==(o) return true if self.equal?(o) self.class == o.class && participant_id == o.participant_id && participant_name == o.participant_name && user_id == o.user_id && purpose == o.purpose && external_contact_id == o.external_contact_id && external_organization_id == o.external_organization_id && flagged_reason == o.flagged_reason && team_id == o.team_id && sessions == o.sessions && attributes == o.attributes end
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 393 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/analytics_participant.rb, line 453 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/analytics_participant.rb, line 374 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/analytics_participant.rb, line 363 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] flagged_reason
Object to be assigned
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 318 def flagged_reason=(flagged_reason) allowed_values = ["general"] if flagged_reason && !allowed_values.include?(flagged_reason) fail ArgumentError, "invalid value for 'flagged_reason', must be one of #{allowed_values}." end @flagged_reason = flagged_reason end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 369 def hash [participant_id, participant_name, user_id, purpose, external_contact_id, external_organization_id, flagged_reason, team_id, sessions, attributes].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/analytics_participant.rb, line 212 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] purpose Object to be assigned
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 294 def purpose=(purpose) allowed_values = ["manual", "dialer", "inbound", "acd", "ivr", "voicemail", "outbound", "agent", "user", "station", "group", "customer", "external", "fax", "workflow", "campaign", "api"] if purpose && !allowed_values.include?(purpose) fail ArgumentError, "invalid value for 'purpose', must be one of #{allowed_values}." end @purpose = purpose end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/analytics_participant.rb, line 441 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/analytics_participant.rb, line 431 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/analytics_participant.rb, line 221 def valid? allowed_values = ["manual", "dialer", "inbound", "acd", "ivr", "voicemail", "outbound", "agent", "user", "station", "group", "customer", "external", "fax", "workflow", "campaign", "api"] if @purpose && !allowed_values.include?(@purpose) return false end allowed_values = ["general"] if @flagged_reason && !allowed_values.include?(@flagged_reason) return false end end