class PureCloud::DocumentAudit

Attributes

action[RW]
action_context[RW]
application[RW]
changes[RW]
entity[RW]
id[RW]

The globally unique identifier for the object.

level[RW]
name[RW]
self_uri[RW]

The URI for this object

service_name[RW]
status[RW]
timestamp[RW]

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

transaction_id[RW]
transaction_initiator[RW]
user[RW]
workspace[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/document_audit.rb, line 57
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'user' => :'user',
    
    :'workspace' => :'workspace',
    
    :'transaction_id' => :'transactionId',
    
    :'transaction_initiator' => :'transactionInitiator',
    
    :'application' => :'application',
    
    :'service_name' => :'serviceName',
    
    :'level' => :'level',
    
    :'timestamp' => :'timestamp',
    
    :'status' => :'status',
    
    :'action_context' => :'actionContext',
    
    :'action' => :'action',
    
    :'entity' => :'entity',
    
    :'changes' => :'changes',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/document_audit.rb, line 96
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'user' => :'DomainEntityRef',
    
    :'workspace' => :'DomainEntityRef',
    
    :'transaction_id' => :'String',
    
    :'transaction_initiator' => :'BOOLEAN',
    
    :'application' => :'String',
    
    :'service_name' => :'String',
    
    :'level' => :'String',
    
    :'timestamp' => :'DateTime',
    
    :'status' => :'String',
    
    :'action_context' => :'String',
    
    :'action' => :'String',
    
    :'entity' => :'AuditEntityReference',
    
    :'changes' => :'Array<AuditChange>',
    
    :'self_uri' => :'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/document_audit.rb, line 509
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      user == o.user &&
      workspace == o.workspace &&
      transaction_id == o.transaction_id &&
      transaction_initiator == o.transaction_initiator &&
      application == o.application &&
      service_name == o.service_name &&
      level == o.level &&
      timestamp == o.timestamp &&
      status == o.status &&
      action_context == o.action_context &&
      action == o.action &&
      entity == o.entity &&
      changes == o.changes &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/document_audit.rb, line 562
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/document_audit.rb, line 622
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
action=(action) click to toggle source

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

# File lib/purecloudplatformclientv2/models/document_audit.rb, line 481
def action=(action)
  allowed_values = ["CREATE", "READ", "UPDATE", "DELETE", "DOWNLOAD", "VIEW", "UPLOAD", "SAVE", "MOVE", "COPY", "ADD", "REMOVE", "RECEIVE", "CONVERT", "FAX", "CREATE_COVERPAGE", "USER_ADD", "USER_REMOVE", "MEMBER_ADD", "MEMBER_REMOVE", "MEMBER_UPDATE", "TAG_ADD", "TAG_REMOVE", "TAG_UPDATE", "ATTRIBUTE_ADD", "ATTRIBUTE_REMOVE", "ATTRIBUTE_UPDATE", "ATTRIBUTE_GROUP_INSTANCE_ADD", "ATTRIBUTE_GROUP_INSTANCE_REMOVE", "ATTRIBUTE_GROUP_INSTANCE_UPDATE", "INDEX_SAVE", "INDEX_DELETE", "INDEX_CREATE", "FILE_SAVE", "FILE_DELETE", "FILE_READ", "THUMBNAIL_CREATE", "TEXT_EXTRACT", "SHARE_ADD", "SHARE_REMOVE", "VERSION_CREATE"]
  if action && !allowed_values.include?(action)
    fail ArgumentError, "invalid value for 'action', must be one of #{allowed_values}."
  end
  @action = action
end
action_context=(action_context) click to toggle source

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

# File lib/purecloudplatformclientv2/models/document_audit.rb, line 467
def action_context=(action_context)
  allowed_values = ["CREATE", "READ", "UPDATE", "DELETE", "DOWNLOAD", "VIEW", "UPLOAD", "SAVE", "MOVE", "COPY", "ADD", "REMOVE", "RECEIVE", "CONVERT", "FAX", "CREATE_COVERPAGE", "USER_ADD", "USER_REMOVE", "MEMBER_ADD", "MEMBER_REMOVE", "MEMBER_UPDATE", "TAG_ADD", "TAG_REMOVE", "TAG_UPDATE", "ATTRIBUTE_ADD", "ATTRIBUTE_REMOVE", "ATTRIBUTE_UPDATE", "ATTRIBUTE_GROUP_INSTANCE_ADD", "ATTRIBUTE_GROUP_INSTANCE_REMOVE", "ATTRIBUTE_GROUP_INSTANCE_UPDATE", "INDEX_SAVE", "INDEX_DELETE", "INDEX_CREATE", "FILE_SAVE", "FILE_DELETE", "FILE_READ", "THUMBNAIL_CREATE", "TEXT_EXTRACT", "SHARE_ADD", "SHARE_REMOVE", "VERSION_CREATE"]
  if action_context && !allowed_values.include?(action_context)
    fail ArgumentError, "invalid value for 'action_context', must be one of #{allowed_values}."
  end
  @action_context = action_context
end
build_from_hash(attributes) click to toggle source

build the object from hash

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

# File lib/purecloudplatformclientv2/models/document_audit.rb, line 532
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/document_audit.rb, line 538
def hash
  [id, name, user, workspace, transaction_id, transaction_initiator, application, service_name, level, timestamp, status, action_context, action, entity, changes, self_uri].hash
end
level=(level) click to toggle source

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

# File lib/purecloudplatformclientv2/models/document_audit.rb, line 434
def level=(level)
  allowed_values = ["USER", "SYSTEM"]
  if level && !allowed_values.include?(level)
    fail ArgumentError, "invalid value for 'level', must be one of #{allowed_values}."
  end
  @level = level
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/document_audit.rb, line 293
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
status=(status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/document_audit.rb, line 453
def status=(status)
  allowed_values = ["SUCCESS", "FAILURE", "WARNING"]
  if status && !allowed_values.include?(status)
    fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}."
  end
  @status = status
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/document_audit.rb, line 610
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/document_audit.rb, line 600
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/document_audit.rb, line 302
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["USER", "SYSTEM"]
  if @level && !allowed_values.include?(@level)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["SUCCESS", "FAILURE", "WARNING"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  allowed_values = ["CREATE", "READ", "UPDATE", "DELETE", "DOWNLOAD", "VIEW", "UPLOAD", "SAVE", "MOVE", "COPY", "ADD", "REMOVE", "RECEIVE", "CONVERT", "FAX", "CREATE_COVERPAGE", "USER_ADD", "USER_REMOVE", "MEMBER_ADD", "MEMBER_REMOVE", "MEMBER_UPDATE", "TAG_ADD", "TAG_REMOVE", "TAG_UPDATE", "ATTRIBUTE_ADD", "ATTRIBUTE_REMOVE", "ATTRIBUTE_UPDATE", "ATTRIBUTE_GROUP_INSTANCE_ADD", "ATTRIBUTE_GROUP_INSTANCE_REMOVE", "ATTRIBUTE_GROUP_INSTANCE_UPDATE", "INDEX_SAVE", "INDEX_DELETE", "INDEX_CREATE", "FILE_SAVE", "FILE_DELETE", "FILE_READ", "THUMBNAIL_CREATE", "TEXT_EXTRACT", "SHARE_ADD", "SHARE_REMOVE", "VERSION_CREATE"]
  if @action_context && !allowed_values.include?(@action_context)
    return false
  end
  
  
  
  
  
  allowed_values = ["CREATE", "READ", "UPDATE", "DELETE", "DOWNLOAD", "VIEW", "UPLOAD", "SAVE", "MOVE", "COPY", "ADD", "REMOVE", "RECEIVE", "CONVERT", "FAX", "CREATE_COVERPAGE", "USER_ADD", "USER_REMOVE", "MEMBER_ADD", "MEMBER_REMOVE", "MEMBER_UPDATE", "TAG_ADD", "TAG_REMOVE", "TAG_UPDATE", "ATTRIBUTE_ADD", "ATTRIBUTE_REMOVE", "ATTRIBUTE_UPDATE", "ATTRIBUTE_GROUP_INSTANCE_ADD", "ATTRIBUTE_GROUP_INSTANCE_REMOVE", "ATTRIBUTE_GROUP_INSTANCE_UPDATE", "INDEX_SAVE", "INDEX_DELETE", "INDEX_CREATE", "FILE_SAVE", "FILE_DELETE", "FILE_READ", "THUMBNAIL_CREATE", "TEXT_EXTRACT", "SHARE_ADD", "SHARE_REMOVE", "VERSION_CREATE"]
  if @action && !allowed_values.include?(@action)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end