class PureCloud::QueueConversationVideoEventTopicCall

Attributes

_self[RW]
additional_properties[RW]
after_call_work[RW]
after_call_work_required[RW]
agent_assistant_id[RW]
confined[RW]
connected_time[RW]
direction[RW]
disconnect_reasons[RW]
disconnect_type[RW]
disconnected_time[RW]
document_id[RW]
error_info[RW]
fax_status[RW]
held[RW]
id[RW]
muted[RW]
other[RW]
peer_id[RW]
provider[RW]
recording[RW]
recording_state[RW]
script_id[RW]
start_hold_time[RW]
state[RW]
uui_data[RW]
wrapup[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb, line 76
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'state' => :'state',
    
    :'recording' => :'recording',
    
    :'recording_state' => :'recordingState',
    
    :'muted' => :'muted',
    
    :'confined' => :'confined',
    
    :'held' => :'held',
    
    :'error_info' => :'errorInfo',
    
    :'disconnect_type' => :'disconnectType',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'direction' => :'direction',
    
    :'document_id' => :'documentId',
    
    :'_self' => :'self',
    
    :'other' => :'other',
    
    :'provider' => :'provider',
    
    :'script_id' => :'scriptId',
    
    :'peer_id' => :'peerId',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnected_time' => :'disconnectedTime',
    
    :'disconnect_reasons' => :'disconnectReasons',
    
    :'fax_status' => :'faxStatus',
    
    :'uui_data' => :'uuiData',
    
    :'wrapup' => :'wrapup',
    
    :'after_call_work' => :'afterCallWork',
    
    :'after_call_work_required' => :'afterCallWorkRequired',
    
    :'agent_assistant_id' => :'agentAssistantId',
    
    :'additional_properties' => :'additionalProperties'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb, line 137
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'state' => :'String',
    
    :'recording' => :'BOOLEAN',
    
    :'recording_state' => :'String',
    
    :'muted' => :'BOOLEAN',
    
    :'confined' => :'BOOLEAN',
    
    :'held' => :'BOOLEAN',
    
    :'error_info' => :'QueueConversationVideoEventTopicErrorDetails',
    
    :'disconnect_type' => :'String',
    
    :'start_hold_time' => :'DateTime',
    
    :'direction' => :'String',
    
    :'document_id' => :'String',
    
    :'_self' => :'QueueConversationVideoEventTopicAddress',
    
    :'other' => :'QueueConversationVideoEventTopicAddress',
    
    :'provider' => :'String',
    
    :'script_id' => :'String',
    
    :'peer_id' => :'String',
    
    :'connected_time' => :'DateTime',
    
    :'disconnected_time' => :'DateTime',
    
    :'disconnect_reasons' => :'Array<QueueConversationVideoEventTopicDisconnectReason>',
    
    :'fax_status' => :'QueueConversationVideoEventTopicFaxStatus',
    
    :'uui_data' => :'String',
    
    :'wrapup' => :'QueueConversationVideoEventTopicWrapup',
    
    :'after_call_work' => :'QueueConversationVideoEventTopicAfterCallWork',
    
    :'after_call_work_required' => :'BOOLEAN',
    
    :'agent_assistant_id' => :'String',
    
    :'additional_properties' => :'Object'
    
  }
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/queue_conversation_video_event_topic_call.rb, line 770
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      state == o.state &&
      recording == o.recording &&
      recording_state == o.recording_state &&
      muted == o.muted &&
      confined == o.confined &&
      held == o.held &&
      error_info == o.error_info &&
      disconnect_type == o.disconnect_type &&
      start_hold_time == o.start_hold_time &&
      direction == o.direction &&
      document_id == o.document_id &&
      _self == o._self &&
      other == o.other &&
      provider == o.provider &&
      script_id == o.script_id &&
      peer_id == o.peer_id &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      disconnect_reasons == o.disconnect_reasons &&
      fax_status == o.fax_status &&
      uui_data == o.uui_data &&
      wrapup == o.wrapup &&
      after_call_work == o.after_call_work &&
      after_call_work_required == o.after_call_work_required &&
      agent_assistant_id == o.agent_assistant_id &&
      additional_properties == o.additional_properties
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb, line 834
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/queue_conversation_video_event_topic_call.rb, line 894
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/queue_conversation_video_event_topic_call.rb, line 815
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/queue_conversation_video_event_topic_call.rb, line 677
def direction=(direction)
  allowed_values = ["OUTBOUND", "INBOUND"]
  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/queue_conversation_video_event_topic_call.rb, line 658
def disconnect_type=(disconnect_type)
  allowed_values = ["ENDPOINT", "CLIENT", "SYSTEM", "TIMEOUT", "TRANSFER", "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/queue_conversation_video_event_topic_call.rb, line 804
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb, line 810
def hash
  [id, state, recording, recording_state, muted, confined, held, error_info, disconnect_type, start_hold_time, direction, document_id, _self, other, provider, script_id, peer_id, connected_time, disconnected_time, disconnect_reasons, fax_status, uui_data, wrapup, after_call_work, after_call_work_required, agent_assistant_id, additional_properties].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/queue_conversation_video_event_topic_call.rb, line 455
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
recording_state=(recording_state) click to toggle source

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

# File lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb, line 624
def recording_state=(recording_state)
  allowed_values = ["NONE", "ACTIVE", "PAUSED"]
  if recording_state && !allowed_values.include?(recording_state)
    fail ArgumentError, "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). @param [Object] state Object to be assigned

# File lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb, line 605
def state=(state)
  allowed_values = ["ALERTING", "DIALING", "CONTACTING", "OFFERING", "CONNECTED", "DISCONNECTED", "TERMINATED", "UPLOADING", "CONVERTING", "TRANSMITTING", "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/queue_conversation_video_event_topic_call.rb, line 877
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb, line 882
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/queue_conversation_video_event_topic_call.rb, line 872
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/queue_conversation_video_event_topic_call.rb, line 464
def valid?
  
  
  
  
  
  
  
  allowed_values = ["ALERTING", "DIALING", "CONTACTING", "OFFERING", "CONNECTED", "DISCONNECTED", "TERMINATED", "UPLOADING", "CONVERTING", "TRANSMITTING", "NONE"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["NONE", "ACTIVE", "PAUSED"]
  if @recording_state && !allowed_values.include?(@recording_state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ENDPOINT", "CLIENT", "SYSTEM", "TIMEOUT", "TRANSFER", "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 = ["OUTBOUND", "INBOUND"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end