cloudmersive-virus-scan-api-client 2.0.1 → 2.0.6

data/lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb

@@ -0,0 +1,298 @@
+=begin
+#virusapi
+
+#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveVirusScanApiClient
+  # Result of running an advanced virus scan on cloud storage
+  class CloudStorageAdvancedVirusScanResult
+    # True if the operation of retrieving the file, and scanning it were successfully completed, false if the file could not be downloaded from cloud storage, or if the file could not be scanned.  Note that successful completion does not mean the file is clean; for the output of the virus scanning operation itself, use the CleanResult and FoundViruses parameters.
+    attr_accessor :successful
+
+    # True if the scan contained no viruses, false otherwise
+    attr_accessor :clean_result
+
+    # True if the scan contained an executable (application code), which can be a significant risk factor
+    attr_accessor :contains_executable
+
+    # True if the scan contained an invalid file (such as a PDF that is not a valid PDF, Word Document that is not a valid Word Document, etc.), which can be a significant risk factor
+    attr_accessor :contains_invalid_file
+
+    # True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor
+    attr_accessor :contains_script
+
+    # True if the scan contained a password protected or encrypted file, which can be a significant risk factor
+    attr_accessor :contains_password_protected_file
+
+    # True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false
+    attr_accessor :contains_restricted_file_format
+
+    # True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor
+    attr_accessor :contains_macros
+
+    # For file format verification-supported file formats, the contents-verified file format of the file.  Null indicates that the file format is not supported for contents verification.  If a Virus or Malware is found, this field will always be set to Null.
+    attr_accessor :verified_file_format
+
+    # Array of viruses found, if any
+    attr_accessor :found_viruses
+
+    # Detailed error message if the operation was not successful
+    attr_accessor :error_detailed_description
+
+    # Size in bytes of the file that was retrieved and scanned
+    attr_accessor :file_size
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'clean_result' => :'CleanResult',
+        :'contains_executable' => :'ContainsExecutable',
+        :'contains_invalid_file' => :'ContainsInvalidFile',
+        :'contains_script' => :'ContainsScript',
+        :'contains_password_protected_file' => :'ContainsPasswordProtectedFile',
+        :'contains_restricted_file_format' => :'ContainsRestrictedFileFormat',
+        :'contains_macros' => :'ContainsMacros',
+        :'verified_file_format' => :'VerifiedFileFormat',
+        :'found_viruses' => :'FoundViruses',
+        :'error_detailed_description' => :'ErrorDetailedDescription',
+        :'file_size' => :'FileSize'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'clean_result' => :'BOOLEAN',
+        :'contains_executable' => :'BOOLEAN',
+        :'contains_invalid_file' => :'BOOLEAN',
+        :'contains_script' => :'BOOLEAN',
+        :'contains_password_protected_file' => :'BOOLEAN',
+        :'contains_restricted_file_format' => :'BOOLEAN',
+        :'contains_macros' => :'BOOLEAN',
+        :'verified_file_format' => :'String',
+        :'found_viruses' => :'Array<CloudStorageVirusFound>',
+        :'error_detailed_description' => :'String',
+        :'file_size' => :'Integer'
+      }
+    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?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      end
+
+      if attributes.has_key?(:'ContainsExecutable')
+        self.contains_executable = attributes[:'ContainsExecutable']
+      end
+
+      if attributes.has_key?(:'ContainsInvalidFile')
+        self.contains_invalid_file = attributes[:'ContainsInvalidFile']
+      end
+
+      if attributes.has_key?(:'ContainsScript')
+        self.contains_script = attributes[:'ContainsScript']
+      end
+
+      if attributes.has_key?(:'ContainsPasswordProtectedFile')
+        self.contains_password_protected_file = attributes[:'ContainsPasswordProtectedFile']
+      end
+
+      if attributes.has_key?(:'ContainsRestrictedFileFormat')
+        self.contains_restricted_file_format = attributes[:'ContainsRestrictedFileFormat']
+      end
+
+      if attributes.has_key?(:'ContainsMacros')
+        self.contains_macros = attributes[:'ContainsMacros']
+      end
+
+      if attributes.has_key?(:'VerifiedFileFormat')
+        self.verified_file_format = attributes[:'VerifiedFileFormat']
+      end
+
+      if attributes.has_key?(:'FoundViruses')
+        if (value = attributes[:'FoundViruses']).is_a?(Array)
+          self.found_viruses = value
+        end
+      end
+
+      if attributes.has_key?(:'ErrorDetailedDescription')
+        self.error_detailed_description = attributes[:'ErrorDetailedDescription']
+      end
+
+      if attributes.has_key?(:'FileSize')
+        self.file_size = attributes[:'FileSize']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          successful == o.successful &&
+          clean_result == o.clean_result &&
+          contains_executable == o.contains_executable &&
+          contains_invalid_file == o.contains_invalid_file &&
+          contains_script == o.contains_script &&
+          contains_password_protected_file == o.contains_password_protected_file &&
+          contains_restricted_file_format == o.contains_restricted_file_format &&
+          contains_macros == o.contains_macros &&
+          verified_file_format == o.verified_file_format &&
+          found_viruses == o.found_viruses &&
+          error_detailed_description == o.error_detailed_description &&
+          file_size == o.file_size
+    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
+      [successful, clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, verified_file_format, found_viruses, error_detailed_description, file_size].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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 =~ /\A(true|t|yes|y|1)\z/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
+        temp_model = CloudmersiveVirusScanApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns 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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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

data/lib/cloudmersive-virus-scan-api-client/models/cloud_storage_virus_found.rb

@@ -0,0 +1,196 @@
+=begin
+#virusapi
+
+#The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveVirusScanApiClient
+  # Virus positively identified
+  class CloudStorageVirusFound
+    # Name of the file containing the virus
+    attr_accessor :file_name
+
+    # Name of the virus that was found
+    attr_accessor :virus_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'file_name' => :'FileName',
+        :'virus_name' => :'VirusName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'file_name' => :'String',
+        :'virus_name' => :'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?(:'FileName')
+        self.file_name = attributes[:'FileName']
+      end
+
+      if attributes.has_key?(:'VirusName')
+        self.virus_name = attributes[:'VirusName']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      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?
+      true
+    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 &&
+          file_name == o.file_name &&
+          virus_name == o.virus_name
+    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
+      [file_name, virus_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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 =~ /\A(true|t|yes|y|1)\z/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
+        temp_model = CloudmersiveVirusScanApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns 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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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