class PureCloud::AuditMessage

Attributes

action[RW]

A string representing the action that took place

action_context[RW]

The context of a system-level action

application[RW]

The application through which the action of this AuditMessage was initiated.

changes[RW]

Details about any changes that occurred in this audit

correlation_id[RW]

Correlation ID.

entity[RW]
id[RW]
level[RW]

The level of this audit. USER or SYSTEM.

received_timestamp[RW]

The time at which this AuditMessage was received.

service_context[RW]

The service-specific context associated with this AuditMessage.

service_name[RW]

The name of the service which sent this AuditMessage.

status[RW]

The status of the action of this AuditMessage

timestamp[RW]

The time at which the action of this AuditMessage was initiated.

transaction_id[RW]

Transaction ID.

transaction_initiator[RW]

Whether or not this audit can be considered the initiator of the transaction it is a part of.

user[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/audit_message.rb, line 68
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'user' => :'user',
    
    :'correlation_id' => :'correlationId',
    
    :'transaction_id' => :'transactionId',
    
    :'transaction_initiator' => :'transactionInitiator',
    
    :'application' => :'application',
    
    :'service_name' => :'serviceName',
    
    :'level' => :'level',
    
    :'timestamp' => :'timestamp',
    
    :'received_timestamp' => :'receivedTimestamp',
    
    :'status' => :'status',
    
    :'action_context' => :'actionContext',
    
    :'action' => :'action',
    
    :'changes' => :'changes',
    
    :'entity' => :'entity',
    
    :'service_context' => :'serviceContext'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/audit_message.rb, line 129
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[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'correlationId']
    self.correlation_id = attributes[:'correlationId']
  end
  
  if attributes[:'transactionId']
    self.transaction_id = attributes[:'transactionId']
  end
  
  if attributes[:'transactionInitiator']
    self.transaction_initiator = attributes[:'transactionInitiator']
  end
  
  if attributes[:'application']
    self.application = attributes[:'application']
  end
  
  if attributes[:'serviceName']
    self.service_name = attributes[:'serviceName']
  end
  
  if attributes[:'level']
    self.level = attributes[:'level']
  end
  
  if attributes[:'timestamp']
    self.timestamp = attributes[:'timestamp']
  end
  
  if attributes[:'receivedTimestamp']
    self.received_timestamp = attributes[:'receivedTimestamp']
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'actionContext']
    self.action_context = attributes[:'actionContext']
  end
  
  if attributes[:'action']
    self.action = attributes[:'action']
  end
  
  if attributes[:'changes']
    if (value = attributes[:'changes']).is_a?(Array)
      self.changes = value
    end
  end
  
  if attributes[:'entity']
    self.entity = attributes[:'entity']
  end
  
  if attributes[:'serviceContext']
    self.service_context = attributes[:'serviceContext']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/audit_message.rb, line 107
def self.swagger_types
  {
    :'id' => :'String',
    :'user' => :'AuditUser',
    :'correlation_id' => :'String',
    :'transaction_id' => :'String',
    :'transaction_initiator' => :'BOOLEAN',
    :'application' => :'String',
    :'service_name' => :'String',
    :'level' => :'String',
    :'timestamp' => :'String',
    :'received_timestamp' => :'String',
    :'status' => :'String',
    :'action_context' => :'String',
    :'action' => :'String',
    :'changes' => :'Array<Change>',
    :'entity' => :'AuditEntity',
    :'service_context' => :'ServiceContext'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/audit_message.rb, line 205
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user == o.user &&
      correlation_id == o.correlation_id &&
      transaction_id == o.transaction_id &&
      transaction_initiator == o.transaction_initiator &&
      application == o.application &&
      service_name == o.service_name &&
      level == o.level &&
      timestamp == o.timestamp &&
      received_timestamp == o.received_timestamp &&
      status == o.status &&
      action_context == o.action_context &&
      action == o.action &&
      changes == o.changes &&
      entity == o.entity &&
      service_context == o.service_context
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/audit_message.rb, line 256
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/audit_message.rb, line 316
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/audit_message.rb, line 237
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
eql?(o) click to toggle source

@see the `==` method

# File lib/purecloud/models/audit_message.rb, line 227
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/audit_message.rb, line 232
def hash
  [id, user, correlation_id, transaction_id, transaction_initiator, application, service_name, level, timestamp, received_timestamp, status, action_context, action, changes, entity, service_context].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloud/models/audit_message.rb, line 304
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/audit_message.rb, line 294
def to_s
  to_hash.to_s
end