class PureCloud::ConversationCallbackEventTopicCallbackMediaParticipant

Attributes

address[RW]
alerting_timeout_ms[RW]
attributes[RW]
automated_callback_config_id[RW]
callback_numbers[RW]
callback_scheduled_time[RW]
callback_user_name[RW]
connected_time[RW]
conversation_routing_data[RW]
direction[RW]
disconnect_type[RW]
end_acw_time[RW]
end_time[RW]
error_info[RW]
external_campaign[RW]
external_contact[RW]
external_organization[RW]
flagged_reason[RW]
held[RW]
id[RW]
journey_context[RW]
name[RW]
outbound_preview[RW]
peer[RW]
provider[RW]
purpose[RW]
queue[RW]
screen_recording_state[RW]
script[RW]
skip_enabled[RW]
start_acw_time[RW]
start_hold_time[RW]
start_time[RW]
state[RW]
team[RW]
timeout_seconds[RW]
user[RW]
voicemail[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/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 108
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',
    
    :'team' => :'team',
    
    :'attributes' => :'attributes',
    
    :'error_info' => :'errorInfo',
    
    :'script' => :'script',
    
    :'wrapup_timeout_ms' => :'wrapupTimeoutMs',
    
    :'wrapup_skipped' => :'wrapupSkipped',
    
    :'alerting_timeout_ms' => :'alertingTimeoutMs',
    
    :'provider' => :'provider',
    
    :'external_contact' => :'externalContact',
    
    :'external_organization' => :'externalOrganization',
    
    :'wrapup' => :'wrapup',
    
    :'conversation_routing_data' => :'conversationRoutingData',
    
    :'peer' => :'peer',
    
    :'screen_recording_state' => :'screenRecordingState',
    
    :'flagged_reason' => :'flaggedReason',
    
    :'journey_context' => :'journeyContext',
    
    :'start_acw_time' => :'startAcwTime',
    
    :'end_acw_time' => :'endAcwTime',
    
    :'outbound_preview' => :'outboundPreview',
    
    :'voicemail' => :'voicemail',
    
    :'callback_numbers' => :'callbackNumbers',
    
    :'callback_user_name' => :'callbackUserName',
    
    :'skip_enabled' => :'skipEnabled',
    
    :'external_campaign' => :'externalCampaign',
    
    :'timeout_seconds' => :'timeoutSeconds',
    
    :'callback_scheduled_time' => :'callbackScheduledTime',
    
    :'automated_callback_config_id' => :'automatedCallbackConfigId'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 295
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?(:'connectedTime')
    
    
    self.connected_time = attributes[:'connectedTime']
    
  
  end

  
  if attributes.has_key?(:'endTime')
    
    
    self.end_time = attributes[:'endTime']
    
  
  end

  
  if attributes.has_key?(:'startHoldTime')
    
    
    self.start_hold_time = attributes[:'startHoldTime']
    
  
  end

  
  if attributes.has_key?(:'purpose')
    
    
    self.purpose = attributes[:'purpose']
    
  
  end

  
  if attributes.has_key?(:'state')
    
    
    self.state = attributes[:'state']
    
  
  end

  
  if attributes.has_key?(:'direction')
    
    
    self.direction = attributes[:'direction']
    
  
  end

  
  if attributes.has_key?(:'disconnectType')
    
    
    self.disconnect_type = attributes[:'disconnectType']
    
  
  end

  
  if attributes.has_key?(:'held')
    
    
    self.held = attributes[:'held']
    
  
  end

  
  if attributes.has_key?(:'wrapupRequired')
    
    
    self.wrapup_required = attributes[:'wrapupRequired']
    
  
  end

  
  if attributes.has_key?(:'wrapupPrompt')
    
    
    self.wrapup_prompt = attributes[:'wrapupPrompt']
    
  
  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?(:'team')
    
    
    self.team = attributes[:'team']
    
  
  end

  
  if attributes.has_key?(:'attributes')
    
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'errorInfo')
    
    
    self.error_info = attributes[:'errorInfo']
    
  
  end

  
  if attributes.has_key?(:'script')
    
    
    self.script = attributes[:'script']
    
  
  end

  
  if attributes.has_key?(:'wrapupTimeoutMs')
    
    
    self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs']
    
  
  end

  
  if attributes.has_key?(:'wrapupSkipped')
    
    
    self.wrapup_skipped = attributes[:'wrapupSkipped']
    
  
  end

  
  if attributes.has_key?(:'alertingTimeoutMs')
    
    
    self.alerting_timeout_ms = attributes[:'alertingTimeoutMs']
    
  
  end

  
  if attributes.has_key?(:'provider')
    
    
    self.provider = attributes[:'provider']
    
  
  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?(:'wrapup')
    
    
    self.wrapup = attributes[:'wrapup']
    
  
  end

  
  if attributes.has_key?(:'conversationRoutingData')
    
    
    self.conversation_routing_data = attributes[:'conversationRoutingData']
    
  
  end

  
  if attributes.has_key?(:'peer')
    
    
    self.peer = attributes[:'peer']
    
  
  end

  
  if attributes.has_key?(:'screenRecordingState')
    
    
    self.screen_recording_state = attributes[:'screenRecordingState']
    
  
  end

  
  if attributes.has_key?(:'flaggedReason')
    
    
    self.flagged_reason = attributes[:'flaggedReason']
    
  
  end

  
  if attributes.has_key?(:'journeyContext')
    
    
    self.journey_context = attributes[:'journeyContext']
    
  
  end

  
  if attributes.has_key?(:'startAcwTime')
    
    
    self.start_acw_time = attributes[:'startAcwTime']
    
  
  end

  
  if attributes.has_key?(:'endAcwTime')
    
    
    self.end_acw_time = attributes[:'endAcwTime']
    
  
  end

  
  if attributes.has_key?(:'outboundPreview')
    
    
    self.outbound_preview = attributes[:'outboundPreview']
    
  
  end

  
  if attributes.has_key?(:'voicemail')
    
    
    self.voicemail = attributes[:'voicemail']
    
  
  end

  
  if attributes.has_key?(:'callbackNumbers')
    
    if (value = attributes[:'callbackNumbers']).is_a?(Array)
      self.callback_numbers = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'callbackUserName')
    
    
    self.callback_user_name = attributes[:'callbackUserName']
    
  
  end

  
  if attributes.has_key?(:'skipEnabled')
    
    
    self.skip_enabled = attributes[:'skipEnabled']
    
  
  end

  
  if attributes.has_key?(:'externalCampaign')
    
    
    self.external_campaign = attributes[:'externalCampaign']
    
  
  end

  
  if attributes.has_key?(:'timeoutSeconds')
    
    
    self.timeout_seconds = attributes[:'timeoutSeconds']
    
  
  end

  
  if attributes.has_key?(:'callbackScheduledTime')
    
    
    self.callback_scheduled_time = attributes[:'callbackScheduledTime']
    
  
  end

  
  if attributes.has_key?(:'automatedCallbackConfigId')
    
    
    self.automated_callback_config_id = attributes[:'automatedCallbackConfigId']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 201
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' => :'ConversationCallbackEventTopicUriReference',
    
    :'queue' => :'ConversationCallbackEventTopicUriReference',
    
    :'team' => :'ConversationCallbackEventTopicUriReference',
    
    :'attributes' => :'Hash<String, String>',
    
    :'error_info' => :'ConversationCallbackEventTopicErrorBody',
    
    :'script' => :'ConversationCallbackEventTopicUriReference',
    
    :'wrapup_timeout_ms' => :'Integer',
    
    :'wrapup_skipped' => :'BOOLEAN',
    
    :'alerting_timeout_ms' => :'Integer',
    
    :'provider' => :'String',
    
    :'external_contact' => :'ConversationCallbackEventTopicUriReference',
    
    :'external_organization' => :'ConversationCallbackEventTopicUriReference',
    
    :'wrapup' => :'ConversationCallbackEventTopicWrapup',
    
    :'conversation_routing_data' => :'ConversationCallbackEventTopicConversationRoutingData',
    
    :'peer' => :'String',
    
    :'screen_recording_state' => :'String',
    
    :'flagged_reason' => :'String',
    
    :'journey_context' => :'ConversationCallbackEventTopicJourneyContext',
    
    :'start_acw_time' => :'DateTime',
    
    :'end_acw_time' => :'DateTime',
    
    :'outbound_preview' => :'ConversationCallbackEventTopicDialerPreview',
    
    :'voicemail' => :'ConversationCallbackEventTopicVoicemail',
    
    :'callback_numbers' => :'Array<String>',
    
    :'callback_user_name' => :'String',
    
    :'skip_enabled' => :'BOOLEAN',
    
    :'external_campaign' => :'BOOLEAN',
    
    :'timeout_seconds' => :'Integer',
    
    :'callback_scheduled_time' => :'DateTime',
    
    :'automated_callback_config_id' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1156
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 &&
      team == o.team &&
      attributes == o.attributes &&
      error_info == o.error_info &&
      script == o.script &&
      wrapup_timeout_ms == o.wrapup_timeout_ms &&
      wrapup_skipped == o.wrapup_skipped &&
      alerting_timeout_ms == o.alerting_timeout_ms &&
      provider == o.provider &&
      external_contact == o.external_contact &&
      external_organization == o.external_organization &&
      wrapup == o.wrapup &&
      conversation_routing_data == o.conversation_routing_data &&
      peer == o.peer &&
      screen_recording_state == o.screen_recording_state &&
      flagged_reason == o.flagged_reason &&
      journey_context == o.journey_context &&
      start_acw_time == o.start_acw_time &&
      end_acw_time == o.end_acw_time &&
      outbound_preview == o.outbound_preview &&
      voicemail == o.voicemail &&
      callback_numbers == o.callback_numbers &&
      callback_user_name == o.callback_user_name &&
      skip_enabled == o.skip_enabled &&
      external_campaign == o.external_campaign &&
      timeout_seconds == o.timeout_seconds &&
      callback_scheduled_time == o.callback_scheduled_time &&
      automated_callback_config_id == o.automated_callback_config_id
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1236
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/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1296
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/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1217
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). @param [Object] direction Object to be assigned

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 960
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
disconnect_type=(disconnect_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] disconnect_type Object to be assigned

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 974
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 ArgumentError, "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 @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1206
def eql?(o)
  self == o
end
flagged_reason=(flagged_reason) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] flagged_reason Object to be assigned

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1083
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
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1212
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, team, attributes, error_info, script, wrapup_timeout_ms, wrapup_skipped, alerting_timeout_ms, provider, external_contact, external_organization, wrapup, conversation_routing_data, peer, screen_recording_state, flagged_reason, journey_context, start_acw_time, end_acw_time, outbound_preview, voicemail, callback_numbers, callback_user_name, skip_enabled, external_campaign, timeout_seconds, callback_scheduled_time, automated_callback_config_id].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 697
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 946
def state=(state)
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "scheduled", "none"]
  if state && !allowed_values.include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}."
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1279
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1284
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/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 1274
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb, line 706
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "scheduled", "none"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  allowed_values = ["inbound", "outbound"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
  
  
  
  
  
  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)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["general"]
  if @flagged_reason && !allowed_values.include?(@flagged_reason)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end