class PureCloud::CallConversationNotificationCallMediaParticipant
Attributes
address[RW]
ani[RW]
attributes[RW]
confined[RW]
connected_time[RW]
consult_participant_id[RW]
direction[RW]
disconnect_type[RW]
dnis[RW]
document_id[RW]
end_time[RW]
error_info[RW]
external_contact[RW]
external_organization[RW]
fax_status[RW]
group[RW]
held[RW]
id[RW]
monitored_participant_id[RW]
muted[RW]
name[RW]
provider[RW]
purpose[RW]
queue[RW]
recording[RW]
recording_state[RW]
script[RW]
start_hold_time[RW]
start_time[RW]
state[RW]
user[RW]
wrapup[RW]
wrapup_prompt[RW]
wrapup_required[RW]
wrapup_skipped[RW]
wrapup_timeout_ms[RW]
Public Class Methods
attribute_map()
click to toggle source
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 94 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'address' => :'address', :'start_time' => :'startTime', :'connected_time' => :'connectedTime', :'end_time' => :'endTime', :'start_hold_time' => :'startHoldTime', :'purpose' => :'purpose', :'state' => :'state', :'direction' => :'direction', :'disconnect_type' => :'disconnectType', :'held' => :'held', :'wrapup_required' => :'wrapupRequired', :'wrapup_prompt' => :'wrapupPrompt', :'user' => :'user', :'queue' => :'queue', :'attributes' => :'attributes', :'error_info' => :'errorInfo', :'script' => :'script', :'wrapup_timeout_ms' => :'wrapupTimeoutMs', :'wrapup_skipped' => :'wrapupSkipped', :'provider' => :'provider', :'external_contact' => :'externalContact', :'external_organization' => :'externalOrganization', :'wrapup' => :'wrapup', :'muted' => :'muted', :'confined' => :'confined', :'recording' => :'recording', :'recording_state' => :'recordingState', :'group' => :'group', :'ani' => :'ani', :'dnis' => :'dnis', :'document_id' => :'documentId', :'monitored_participant_id' => :'monitoredParticipantId', :'consult_participant_id' => :'consultParticipantId', :'fax_status' => :'faxStatus' } end
new(attributes = {})
click to toggle source
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 215 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[:'id'] self.id = attributes[:'id'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'address'] self.address = attributes[:'address'] end if attributes[:'startTime'] self.start_time = attributes[:'startTime'] end if attributes[:'connectedTime'] self.connected_time = attributes[:'connectedTime'] end if attributes[:'endTime'] self.end_time = attributes[:'endTime'] end if attributes[:'startHoldTime'] self.start_hold_time = attributes[:'startHoldTime'] end if attributes[:'purpose'] self.purpose = attributes[:'purpose'] end if attributes[:'state'] self.state = attributes[:'state'] end if attributes[:'direction'] self.direction = attributes[:'direction'] end if attributes[:'disconnectType'] self.disconnect_type = attributes[:'disconnectType'] end if attributes[:'held'] self.held = attributes[:'held'] end if attributes[:'wrapupRequired'] self.wrapup_required = attributes[:'wrapupRequired'] end if attributes[:'wrapupPrompt'] self.wrapup_prompt = attributes[:'wrapupPrompt'] end if attributes[:'user'] self.user = attributes[:'user'] end if attributes[:'queue'] self.queue = attributes[:'queue'] end if attributes[:'attributes'] if (value = attributes[:'attributes']).is_a?(Array) self.attributes = value end end if attributes[:'errorInfo'] self.error_info = attributes[:'errorInfo'] end if attributes[:'script'] self.script = attributes[:'script'] end if attributes[:'wrapupTimeoutMs'] self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs'] end if attributes[:'wrapupSkipped'] self.wrapup_skipped = attributes[:'wrapupSkipped'] end if attributes[:'provider'] self.provider = attributes[:'provider'] end if attributes[:'externalContact'] self.external_contact = attributes[:'externalContact'] end if attributes[:'externalOrganization'] self.external_organization = attributes[:'externalOrganization'] end if attributes[:'wrapup'] self.wrapup = attributes[:'wrapup'] end if attributes[:'muted'] self.muted = attributes[:'muted'] end if attributes[:'confined'] self.confined = attributes[:'confined'] end if attributes[:'recording'] self.recording = attributes[:'recording'] end if attributes[:'recordingState'] self.recording_state = attributes[:'recordingState'] end if attributes[:'group'] self.group = attributes[:'group'] end if attributes[:'ani'] self.ani = attributes[:'ani'] end if attributes[:'dnis'] self.dnis = attributes[:'dnis'] end if attributes[:'documentId'] self.document_id = attributes[:'documentId'] end if attributes[:'monitoredParticipantId'] self.monitored_participant_id = attributes[:'monitoredParticipantId'] end if attributes[:'consultParticipantId'] self.consult_participant_id = attributes[:'consultParticipantId'] end if attributes[:'faxStatus'] self.fax_status = attributes[:'faxStatus'] end end
swagger_types()
click to toggle source
Attribute
type mapping.
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 173 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'address' => :'String', :'start_time' => :'DateTime', :'connected_time' => :'DateTime', :'end_time' => :'DateTime', :'start_hold_time' => :'DateTime', :'purpose' => :'String', :'state' => :'String', :'direction' => :'String', :'disconnect_type' => :'String', :'held' => :'BOOLEAN', :'wrapup_required' => :'BOOLEAN', :'wrapup_prompt' => :'String', :'user' => :'DocumentDataV2NotificationCreatedBy', :'queue' => :'CallConversationNotificationUriReference', :'attributes' => :'Hash<String, String>', :'error_info' => :'CallConversationNotificationErrorInfo', :'script' => :'CallConversationNotificationUriReference', :'wrapup_timeout_ms' => :'Integer', :'wrapup_skipped' => :'BOOLEAN', :'provider' => :'String', :'external_contact' => :'CallConversationNotificationUriReference', :'external_organization' => :'CallConversationNotificationUriReference', :'wrapup' => :'ConversationNotificationWrapup', :'muted' => :'BOOLEAN', :'confined' => :'BOOLEAN', :'recording' => :'BOOLEAN', :'recording_state' => :'String', :'group' => :'CallConversationNotificationUriReference', :'ani' => :'String', :'dnis' => :'String', :'document_id' => :'String', :'monitored_participant_id' => :'String', :'consult_participant_id' => :'String', :'fax_status' => :'CallConversationNotificationFaxStatus' } end
Public Instance Methods
==(o)
click to toggle source
Check equality by comparing each attribute.
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 407 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 && connected_time == o.connected_time && end_time == o.end_time && start_hold_time == o.start_hold_time && purpose == o.purpose && state == o.state && direction == o.direction && disconnect_type == o.disconnect_type && held == o.held && wrapup_required == o.wrapup_required && wrapup_prompt == o.wrapup_prompt && user == o.user && queue == o.queue && attributes == o.attributes && error_info == o.error_info && script == o.script && wrapup_timeout_ms == o.wrapup_timeout_ms && wrapup_skipped == o.wrapup_skipped && provider == o.provider && external_contact == o.external_contact && external_organization == o.external_organization && wrapup == o.wrapup && muted == o.muted && confined == o.confined && recording == o.recording && recording_state == o.recording_state && group == o.group && ani == o.ani && dnis == o.dnis && document_id == o.document_id && monitored_participant_id == o.monitored_participant_id && consult_participant_id == o.consult_participant_id && fax_status == o.fax_status end
_deserialize(type, value)
click to toggle source
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 478 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/call_conversation_notification_call_media_participant.rb, line 538 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/call_conversation_notification_call_media_participant.rb, line 459 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
direction=(direction)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 380 def direction=(direction) allowed_values = ["inbound", "outbound"] if direction && !allowed_values.include?(direction) fail "invalid value for 'direction', must be one of #{allowed_values}" end @direction = direction end
disconnect_type=(disconnect_type)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 389 def disconnect_type=(disconnect_type) allowed_values = ["endpoint", "client", "system", "transfer", "timeout", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam", "uncallable"] if disconnect_type && !allowed_values.include?(disconnect_type) fail "invalid value for 'disconnect_type', must be one of #{allowed_values}" end @disconnect_type = disconnect_type end
eql?(o)
click to toggle source
@see the `==` method
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 449 def eql?(o) self == o end
hash()
click to toggle source
Calculate hash code according to all attributes.
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 454 def hash [id, name, address, start_time, connected_time, end_time, start_hold_time, purpose, state, direction, disconnect_type, held, wrapup_required, wrapup_prompt, user, queue, attributes, error_info, script, wrapup_timeout_ms, wrapup_skipped, provider, external_contact, external_organization, wrapup, muted, confined, recording, recording_state, group, ani, dnis, document_id, monitored_participant_id, consult_participant_id, fax_status].hash end
recording_state=(recording_state)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 398 def recording_state=(recording_state) allowed_values = ["none", "active", "paused"] if recording_state && !allowed_values.include?(recording_state) fail "invalid value for 'recording_state', must be one of #{allowed_values}" end @recording_state = recording_state end
state=(state)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 371 def state=(state) allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "scheduled", "none"] if state && !allowed_values.include?(state) fail "invalid value for 'state', must be one of #{allowed_values}" end @state = state end
to_body()
click to toggle source
to_hash()
click to toggle source
return the object in the form of hash
# File lib/purecloud/models/call_conversation_notification_call_media_participant.rb, line 526 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/call_conversation_notification_call_media_participant.rb, line 516 def to_s to_hash.to_s end