class PureCloud::ConversationNotificationCalls

Attributes

_self[RW]
additional_properties[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]
provider[RW]
recording[RW]
recording_state[RW]
start_hold_time[RW]
state[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/conversation_notification_calls.rb, line 62
def self.attribute_map
  {
    
    :'disconnected_time' => :'disconnectedTime',
    
    :'other' => :'other',
    
    :'confined' => :'confined',
    
    :'held' => :'held',
    
    :'recording' => :'recording',
    
    :'error_info' => :'errorInfo',
    
    :'recording_state' => :'recordingState',
    
    :'provider' => :'provider',
    
    :'disconnect_type' => :'disconnectType',
    
    :'_self' => :'self',
    
    :'connected_time' => :'connectedTime',
    
    :'document_id' => :'documentId',
    
    :'id' => :'id',
    
    :'state' => :'state',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'fax_status' => :'faxStatus',
    
    :'additional_properties' => :'additionalProperties',
    
    :'muted' => :'muted',
    
    :'direction' => :'direction',
    
    :'disconnect_reasons' => :'disconnectReasons'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/conversation_notification_calls.rb, line 135
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[:'disconnectedTime']
    self.disconnected_time = attributes[:'disconnectedTime']
  end
  
  if attributes[:'other']
    self.other = attributes[:'other']
  end
  
  if attributes[:'confined']
    self.confined = attributes[:'confined']
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  end
  
  if attributes[:'recording']
    self.recording = attributes[:'recording']
  end
  
  if attributes[:'errorInfo']
    self.error_info = attributes[:'errorInfo']
  end
  
  if attributes[:'recordingState']
    self.recording_state = attributes[:'recordingState']
  end
  
  if attributes[:'provider']
    self.provider = attributes[:'provider']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'self']
    self._self = attributes[:'self']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'documentId']
    self.document_id = attributes[:'documentId']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'startHoldTime']
    self.start_hold_time = attributes[:'startHoldTime']
  end
  
  if attributes[:'faxStatus']
    self.fax_status = attributes[:'faxStatus']
  end
  
  if attributes[:'additionalProperties']
    self.additional_properties = attributes[:'additionalProperties']
  end
  
  if attributes[:'muted']
    self.muted = attributes[:'muted']
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'disconnectReasons']
    if (value = attributes[:'disconnectReasons']).is_a?(Array)
      self.disconnect_reasons = value
    end
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/conversation_notification_calls.rb, line 109
def self.swagger_types
  {
    :'disconnected_time' => :'DateTime',
    :'other' => :'ConversationNotificationAddress',
    :'confined' => :'BOOLEAN',
    :'held' => :'BOOLEAN',
    :'recording' => :'BOOLEAN',
    :'error_info' => :'ConversationNotificationErrorInfo',
    :'recording_state' => :'String',
    :'provider' => :'String',
    :'disconnect_type' => :'String',
    :'_self' => :'ConversationNotificationSelf',
    :'connected_time' => :'DateTime',
    :'document_id' => :'String',
    :'id' => :'String',
    :'state' => :'String',
    :'start_hold_time' => :'DateTime',
    :'fax_status' => :'ConversationNotificationFaxStatus',
    :'additional_properties' => :'Object',
    :'muted' => :'BOOLEAN',
    :'direction' => :'String',
    :'disconnect_reasons' => :'Array<ConversationNotificationDisconnectReasons>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/conversation_notification_calls.rb, line 263
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      disconnected_time == o.disconnected_time &&
      other == o.other &&
      confined == o.confined &&
      held == o.held &&
      recording == o.recording &&
      error_info == o.error_info &&
      recording_state == o.recording_state &&
      provider == o.provider &&
      disconnect_type == o.disconnect_type &&
      _self == o._self &&
      connected_time == o.connected_time &&
      document_id == o.document_id &&
      id == o.id &&
      state == o.state &&
      start_hold_time == o.start_hold_time &&
      fax_status == o.fax_status &&
      additional_properties == o.additional_properties &&
      muted == o.muted &&
      direction == o.direction &&
      disconnect_reasons == o.disconnect_reasons
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/conversation_notification_calls.rb, line 318
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/conversation_notification_calls.rb, line 378
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/conversation_notification_calls.rb, line 299
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/conversation_notification_calls.rb, line 254
def direction=(direction)
  allowed_values = ["OUTBOUND", "INBOUND"]
  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/conversation_notification_calls.rb, line 236
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 "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/conversation_notification_calls.rb, line 289
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/conversation_notification_calls.rb, line 294
def hash
  [disconnected_time, other, confined, held, recording, error_info, recording_state, provider, disconnect_type, _self, connected_time, document_id, id, state, start_hold_time, fax_status, additional_properties, muted, direction, disconnect_reasons].hash
end
recording_state=(recording_state) click to toggle source

Custom attribute writer method checking allowed values (enum).

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

return the object in the form of hash

# File lib/purecloud/models/conversation_notification_calls.rb, line 366
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/conversation_notification_calls.rb, line 356
def to_s
  to_hash.to_s
end