class PureCloud::CallHistoryParticipant
Attributes
The participant address.
The call ANI.
Indicates whether the contact ever connected
The participant's direction. Values can be: 'inbound' or 'outbound'
The reason the participant was disconnected from the conversation.
The call DNIS.
The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The PureCloud
external contact
The PureCloud
external organization
The reason specifying why participant flagged the conversation.
The group involved in the group ring call.
The unique participant ID.
The display friendly name of the participant.
The outbound campaign associated with the participant
The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr
The PureCloud
queue for this participant.
Indicates SIP Response
codes associated with the participant
The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The PureCloud
user for this participant.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 79 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'address' => :'address', :'start_time' => :'startTime', :'end_time' => :'endTime', :'purpose' => :'purpose', :'direction' => :'direction', :'ani' => :'ani', :'dnis' => :'dnis', :'user' => :'user', :'queue' => :'queue', :'group' => :'group', :'disconnect_type' => :'disconnectType', :'external_contact' => :'externalContact', :'external_organization' => :'externalOrganization', :'did_interact' => :'didInteract', :'sip_response_codes' => :'sipResponseCodes', :'flagged_reason' => :'flaggedReason', :'outbound_campaign' => :'outboundCampaign' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 170 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'address') self.address = attributes[:'address'] end if attributes.has_key?(:'startTime') self.start_time = attributes[:'startTime'] end if attributes.has_key?(:'endTime') self.end_time = attributes[:'endTime'] end if attributes.has_key?(:'purpose') self.purpose = attributes[:'purpose'] end if attributes.has_key?(:'direction') self.direction = attributes[:'direction'] end if attributes.has_key?(:'ani') self.ani = attributes[:'ani'] end if attributes.has_key?(:'dnis') self.dnis = attributes[:'dnis'] end if attributes.has_key?(:'user') self.user = attributes[:'user'] end if attributes.has_key?(:'queue') self.queue = attributes[:'queue'] end if attributes.has_key?(:'group') self.group = attributes[:'group'] end if attributes.has_key?(:'disconnectType') self.disconnect_type = attributes[:'disconnectType'] end if attributes.has_key?(:'externalContact') self.external_contact = attributes[:'externalContact'] end if attributes.has_key?(:'externalOrganization') self.external_organization = attributes[:'externalOrganization'] end if attributes.has_key?(:'didInteract') self.did_interact = attributes[:'didInteract'] end if attributes.has_key?(:'sipResponseCodes') if (value = attributes[:'sipResponseCodes']).is_a?(Array) self.sip_response_codes = value end end if attributes.has_key?(:'flaggedReason') self.flagged_reason = attributes[:'flaggedReason'] end if attributes.has_key?(:'outboundCampaign') self.outbound_campaign = attributes[:'outboundCampaign'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 124 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'address' => :'String', :'start_time' => :'DateTime', :'end_time' => :'DateTime', :'purpose' => :'String', :'direction' => :'String', :'ani' => :'String', :'dnis' => :'String', :'user' => :'User', :'queue' => :'Queue', :'group' => :'Group', :'disconnect_type' => :'String', :'external_contact' => :'ExternalContact', :'external_organization' => :'ExternalOrganization', :'did_interact' => :'BOOLEAN', :'sip_response_codes' => :'Array<Integer>', :'flagged_reason' => :'String', :'outbound_campaign' => :'Campaign' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 583 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && address == o.address && start_time == o.start_time && end_time == o.end_time && purpose == o.purpose && direction == o.direction && ani == o.ani && dnis == o.dnis && user == o.user && queue == o.queue && group == o.group && disconnect_type == o.disconnect_type && external_contact == o.external_contact && external_organization == o.external_organization && did_interact == o.did_interact && sip_response_codes == o.sip_response_codes && flagged_reason == o.flagged_reason && outbound_campaign == o.outbound_campaign end
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 639 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/call_history_participant.rb, line 699 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/call_history_participant.rb, line 620 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] direction Object to be assigned
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 492 def direction=(direction) allowed_values = ["inbound", "outbound"] if direction && !allowed_values.include?(direction) fail ArgumentError, "invalid value for 'direction', must be one of #{allowed_values}." end @direction = direction end
Custom attribute writer method checking allowed values (enum). @param [Object] disconnect_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 531 def disconnect_type=(disconnect_type) allowed_values = ["endpoint", "client", "system", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam"] if disconnect_type && !allowed_values.include?(disconnect_type) fail ArgumentError, "invalid value for 'disconnect_type', must be one of #{allowed_values}." end @disconnect_type = disconnect_type end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 609 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/call_history_participant.rb, line 565 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/call_history_participant.rb, line 615 def hash [id, name, address, start_time, end_time, purpose, direction, ani, dnis, user, queue, group, disconnect_type, external_contact, external_organization, did_interact, sip_response_codes, flagged_reason, outbound_campaign].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/call_history_participant.rb, line 354 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/call_history_participant.rb, line 687 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/call_history_participant.rb, line 677 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/call_history_participant.rb, line 363 def valid? allowed_values = ["inbound", "outbound"] if @direction && !allowed_values.include?(@direction) return false end allowed_values = ["endpoint", "client", "system", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam"] if @disconnect_type && !allowed_values.include?(@disconnect_type) return false end allowed_values = ["general"] if @flagged_reason && !allowed_values.include?(@flagged_reason) return false end end