class PureCloud::CallConversationNotificationParticipants

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_participants.rb, line 94
def self.attribute_map
  {
    
    :'monitored_participant_id' => :'monitoredParticipantId',
    
    :'confined' => :'confined',
    
    :'wrapup_skipped' => :'wrapupSkipped',
    
    :'purpose' => :'purpose',
    
    :'held' => :'held',
    
    :'wrapup_timeout_ms' => :'wrapupTimeoutMs',
    
    :'error_info' => :'errorInfo',
    
    :'recording' => :'recording',
    
    :'provider' => :'provider',
    
    :'wrapup_required' => :'wrapupRequired',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_time' => :'startTime',
    
    :'id' => :'id',
    
    :'state' => :'state',
    
    :'dnis' => :'dnis',
    
    :'fax_status' => :'faxStatus',
    
    :'muted' => :'muted',
    
    :'ani' => :'ani',
    
    :'direction' => :'direction',
    
    :'group' => :'group',
    
    :'wrapup' => :'wrapup',
    
    :'address' => :'address',
    
    :'external_contact' => :'externalContact',
    
    :'external_organization' => :'externalOrganization',
    
    :'script' => :'script',
    
    :'consult_participant_id' => :'consultParticipantId',
    
    :'recording_state' => :'recordingState',
    
    :'name' => :'name',
    
    :'wrapup_prompt' => :'wrapupPrompt',
    
    :'attributes' => :'attributes',
    
    :'document_id' => :'documentId',
    
    :'end_time' => :'endTime',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'user' => :'user',
    
    :'queue' => :'queue'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/call_conversation_notification_participants.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[:'monitoredParticipantId']
    self.monitored_participant_id = attributes[:'monitoredParticipantId']
  end
  
  if attributes[:'confined']
    self.confined = attributes[:'confined']
  end
  
  if attributes[:'wrapupSkipped']
    self.wrapup_skipped = attributes[:'wrapupSkipped']
  end
  
  if attributes[:'purpose']
    self.purpose = attributes[:'purpose']
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  end
  
  if attributes[:'wrapupTimeoutMs']
    self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs']
  end
  
  if attributes[:'errorInfo']
    self.error_info = attributes[:'errorInfo']
  end
  
  if attributes[:'recording']
    self.recording = attributes[:'recording']
  end
  
  if attributes[:'provider']
    self.provider = attributes[:'provider']
  end
  
  if attributes[:'wrapupRequired']
    self.wrapup_required = attributes[:'wrapupRequired']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'dnis']
    self.dnis = attributes[:'dnis']
  end
  
  if attributes[:'faxStatus']
    self.fax_status = attributes[:'faxStatus']
  end
  
  if attributes[:'muted']
    self.muted = attributes[:'muted']
  end
  
  if attributes[:'ani']
    self.ani = attributes[:'ani']
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'group']
    self.group = attributes[:'group']
  end
  
  if attributes[:'wrapup']
    self.wrapup = attributes[:'wrapup']
  end
  
  if attributes[:'address']
    self.address = attributes[:'address']
  end
  
  if attributes[:'externalContact']
    self.external_contact = attributes[:'externalContact']
  end
  
  if attributes[:'externalOrganization']
    self.external_organization = attributes[:'externalOrganization']
  end
  
  if attributes[:'script']
    self.script = attributes[:'script']
  end
  
  if attributes[:'consultParticipantId']
    self.consult_participant_id = attributes[:'consultParticipantId']
  end
  
  if attributes[:'recordingState']
    self.recording_state = attributes[:'recordingState']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'wrapupPrompt']
    self.wrapup_prompt = attributes[:'wrapupPrompt']
  end
  
  if attributes[:'attributes']
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end
  
  if attributes[:'documentId']
    self.document_id = attributes[:'documentId']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'startHoldTime']
    self.start_hold_time = attributes[:'startHoldTime']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'queue']
    self.queue = attributes[:'queue']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/call_conversation_notification_participants.rb, line 173
def self.swagger_types
  {
    :'monitored_participant_id' => :'String',
    :'confined' => :'BOOLEAN',
    :'wrapup_skipped' => :'BOOLEAN',
    :'purpose' => :'String',
    :'held' => :'BOOLEAN',
    :'wrapup_timeout_ms' => :'Integer',
    :'error_info' => :'CallConversationNotificationErrorInfo',
    :'recording' => :'BOOLEAN',
    :'provider' => :'String',
    :'wrapup_required' => :'BOOLEAN',
    :'connected_time' => :'DateTime',
    :'disconnect_type' => :'String',
    :'start_time' => :'DateTime',
    :'id' => :'String',
    :'state' => :'String',
    :'dnis' => :'String',
    :'fax_status' => :'CallConversationNotificationFaxStatus',
    :'muted' => :'BOOLEAN',
    :'ani' => :'String',
    :'direction' => :'String',
    :'group' => :'CallConversationNotificationUriReference',
    :'wrapup' => :'ConversationNotificationWrapup',
    :'address' => :'String',
    :'external_contact' => :'CallConversationNotificationUriReference',
    :'external_organization' => :'CallConversationNotificationUriReference',
    :'script' => :'CallConversationNotificationUriReference',
    :'consult_participant_id' => :'String',
    :'recording_state' => :'String',
    :'name' => :'String',
    :'wrapup_prompt' => :'String',
    :'attributes' => :'Hash<String, String>',
    :'document_id' => :'String',
    :'end_time' => :'DateTime',
    :'start_hold_time' => :'DateTime',
    :'user' => :'DocumentDataV2NotificationCreatedBy',
    :'queue' => :'CallConversationNotificationUriReference'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/call_conversation_notification_participants.rb, line 407
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      monitored_participant_id == o.monitored_participant_id &&
      confined == o.confined &&
      wrapup_skipped == o.wrapup_skipped &&
      purpose == o.purpose &&
      held == o.held &&
      wrapup_timeout_ms == o.wrapup_timeout_ms &&
      error_info == o.error_info &&
      recording == o.recording &&
      provider == o.provider &&
      wrapup_required == o.wrapup_required &&
      connected_time == o.connected_time &&
      disconnect_type == o.disconnect_type &&
      start_time == o.start_time &&
      id == o.id &&
      state == o.state &&
      dnis == o.dnis &&
      fax_status == o.fax_status &&
      muted == o.muted &&
      ani == o.ani &&
      direction == o.direction &&
      group == o.group &&
      wrapup == o.wrapup &&
      address == o.address &&
      external_contact == o.external_contact &&
      external_organization == o.external_organization &&
      script == o.script &&
      consult_participant_id == o.consult_participant_id &&
      recording_state == o.recording_state &&
      name == o.name &&
      wrapup_prompt == o.wrapup_prompt &&
      attributes == o.attributes &&
      document_id == o.document_id &&
      end_time == o.end_time &&
      start_hold_time == o.start_hold_time &&
      user == o.user &&
      queue == o.queue
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/call_conversation_notification_participants.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_participants.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_participants.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_participants.rb, line 389
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_participants.rb, line 371
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_participants.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_participants.rb, line 454
def hash
  [monitored_participant_id, confined, wrapup_skipped, purpose, held, wrapup_timeout_ms, error_info, recording, provider, wrapup_required, connected_time, disconnect_type, start_time, id, state, dnis, fax_status, muted, ani, direction, group, wrapup, address, external_contact, external_organization, script, consult_participant_id, recording_state, name, wrapup_prompt, attributes, document_id, end_time, start_hold_time, user, queue].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_participants.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_participants.rb, line 380
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_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/call_conversation_notification_participants.rb, line 521
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/call_conversation_notification_participants.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_participants.rb, line 516
def to_s
  to_hash.to_s
end