purecloudplatformclientv2 71.0.0 → 72.0.0

data/lib/purecloudplatformclientv2/models/audit_log_message.rb

@@ -0,0 +1,536 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require 'date'
+
+module PureCloud
+  class AuditLogMessage
+    # Id of the audit message.
+    attr_accessor :id
+
+    # User associated with this audit message.
+    attr_accessor :user
+
+    # Client associated with this audit message.
+    attr_accessor :client
+
+    # List of IP addresses of systems that originated or handled the request.
+    attr_accessor :remote_ip
+
+    # Name of the service that logged this audit message.
+    attr_accessor :service_name
+
+    # Date and time of when the audit message was logged. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :event_date
+
+    # Message describing the event being audited.
+    attr_accessor :message
+
+    # Action that took place.
+    attr_accessor :action
+
+    # Entity that was impacted.
+    attr_accessor :entity
+
+    # Type of the entity that was impacted.
+    attr_accessor :entity_type
+
+    # List of properties that were changed and changes made to those properties.
+    attr_accessor :property_changes
+
+    # Additional context for this message.
+    attr_accessor :context
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'id' => :'id',
+        
+        :'user' => :'user',
+        
+        :'client' => :'client',
+        
+        :'remote_ip' => :'remoteIp',
+        
+        :'service_name' => :'serviceName',
+        
+        :'event_date' => :'eventDate',
+        
+        :'message' => :'message',
+        
+        :'action' => :'action',
+        
+        :'entity' => :'entity',
+        
+        :'entity_type' => :'entityType',
+        
+        :'property_changes' => :'propertyChanges',
+        
+        :'context' => :'context'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'user' => :'AddressableEntityRef',
+        
+        :'client' => :'AddressableEntityRef',
+        
+        :'remote_ip' => :'Array<String>',
+        
+        :'service_name' => :'String',
+        
+        :'event_date' => :'DateTime',
+        
+        :'message' => :'MessageInfo',
+        
+        :'action' => :'String',
+        
+        :'entity' => :'AddressableEntityRef',
+        
+        :'entity_type' => :'String',
+        
+        :'property_changes' => :'Array<PropertyChange>',
+        
+        :'context' => :'Hash<String, String>'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'user')
+        
+        
+        self.user = attributes[:'user']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'client')
+        
+        
+        self.client = attributes[:'client']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'remoteIp')
+        
+        if (value = attributes[:'remoteIp']).is_a?(Array)
+          self.remote_ip = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'serviceName')
+        
+        
+        self.service_name = attributes[:'serviceName']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'eventDate')
+        
+        
+        self.event_date = attributes[:'eventDate']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'message')
+        
+        
+        self.message = attributes[:'message']
+        
+      
+      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?(:'entityType')
+        
+        
+        self.entity_type = attributes[:'entityType']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'propertyChanges')
+        
+        if (value = attributes[:'propertyChanges']).is_a?(Array)
+          self.property_changes = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'context')
+        
+        if (value = attributes[:'context']).is_a?(Array)
+          self.context = value
+        end
+        
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitionsService"]
+      if @service_name && !allowed_values.include?(@service_name)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "Execute", "Publish"]
+      if @action && !allowed_values.include?(@action)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "BulkActions", "Feedback", "Topic", "Program"]
+      if @entity_type && !allowed_values.include?(@entity_type)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] service_name Object to be assigned
+    def service_name=(service_name)
+      allowed_values = ["ContactCenter", "ContentManagement", "PeoplePermissions", "Quality", "LanguageUnderstanding", "TopicsDefinitionsService"]
+      if service_name && !allowed_values.include?(service_name)
+        fail ArgumentError, "invalid value for 'service_name', must be one of #{allowed_values}."
+      end
+      @service_name = service_name
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action Object to be assigned
+    def action=(action)
+      allowed_values = ["Create", "View", "Update", "Delete", "Download", "MemberAdd", "MemberUpdate", "MemberRemove", "Read", "Execute", "Publish"]
+      if action && !allowed_values.include?(action)
+        fail ArgumentError, "invalid value for 'action', must be one of #{allowed_values}."
+      end
+      @action = action
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] entity_type Object to be assigned
+    def entity_type=(entity_type)
+      allowed_values = ["Document", "Queue", "Recording", "Role", "VoicemailUserPolicy", "WrapupCode", "AccessToken", "BulkActions", "Feedback", "Topic", "Program"]
+      if entity_type && !allowed_values.include?(entity_type)
+        fail ArgumentError, "invalid value for 'entity_type', must be one of #{allowed_values}."
+      end
+      @entity_type = entity_type
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          user == o.user &&
+          client == o.client &&
+          remote_ip == o.remote_ip &&
+          service_name == o.service_name &&
+          event_date == o.event_date &&
+          message == o.message &&
+          action == o.action &&
+          entity == o.entity &&
+          entity_type == o.entity_type &&
+          property_changes == o.property_changes &&
+          context == o.context
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, user, client, remote_ip, service_name, event_date, message, action, entity, entity_type, property_changes, context].hash
+    end
+
+    # build the object from hash
+    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
+
+    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
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    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
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    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
+
+  end
+end