cloudmersive-phishing-detection-api-client 2.2.2 → 2.2.4

data/lib/cloudmersive-phishing-detection-api-client/models/phishing_detection_text_string_response.rb

@@ -0,0 +1,206 @@
+=begin
+#phishingapi
+
+#Easily and directly scan and block phishing security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersivePhishingDetectionApiClient
+  # Result of detecting phishing using AI for basic text string analysis
+  class PhishingDetectionTextStringResponse
+    # True if the result is not phishing (clean), and false otherwise
+    attr_accessor :clean_result
+
+    # Confidence level between 0.0 and 1.0 where values over 0.9 indicate high confidence
+    attr_accessor :confidence_level
+
+    # Rationale for why the conclusion was formed
+    attr_accessor :analysis_rationale
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'clean_result' => :'CleanResult',
+        :'confidence_level' => :'ConfidenceLevel',
+        :'analysis_rationale' => :'AnalysisRationale'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'clean_result' => :'BOOLEAN',
+        :'confidence_level' => :'Float',
+        :'analysis_rationale' => :'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?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      end
+
+      if attributes.has_key?(:'ConfidenceLevel')
+        self.confidence_level = attributes[:'ConfidenceLevel']
+      end
+
+      if attributes.has_key?(:'AnalysisRationale')
+        self.analysis_rationale = attributes[:'AnalysisRationale']
+      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 &&
+          clean_result == o.clean_result &&
+          confidence_level == o.confidence_level &&
+          analysis_rationale == o.analysis_rationale
+    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
+      [clean_result, confidence_level, analysis_rationale].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 = CloudmersivePhishingDetectionApiClient.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-phishing-detection-api-client/models/prior_history_item.rb

@@ -0,0 +1,256 @@
+=begin
+#phishingapi
+
+#Easily and directly scan and block phishing security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersivePhishingDetectionApiClient
+  # A single message in the prior conversation history
+  class PriorHistoryItem
+    # The text content of this historical message
+    attr_accessor :input_string
+
+    # Optional: Name of the sender
+    attr_accessor :from_name
+
+    # Optional: Name of the recipient
+    attr_accessor :to_name
+
+    # Optional: Phone number of the sender
+    attr_accessor :from_phone_number
+
+    # Optional: Phone number of the recipient
+    attr_accessor :to_phone_number
+
+    # Optional: Email address of the sender
+    attr_accessor :from_email_address
+
+    # Optional: Email address of the recipient
+    attr_accessor :to_email_address
+
+    # Optional: True if this message is from a trusted party (such as our own company), false otherwise
+    attr_accessor :trusted_party
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_string' => :'InputString',
+        :'from_name' => :'FromName',
+        :'to_name' => :'ToName',
+        :'from_phone_number' => :'FromPhoneNumber',
+        :'to_phone_number' => :'ToPhoneNumber',
+        :'from_email_address' => :'FromEmailAddress',
+        :'to_email_address' => :'ToEmailAddress',
+        :'trusted_party' => :'TrustedParty'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'input_string' => :'String',
+        :'from_name' => :'String',
+        :'to_name' => :'String',
+        :'from_phone_number' => :'String',
+        :'to_phone_number' => :'String',
+        :'from_email_address' => :'String',
+        :'to_email_address' => :'String',
+        :'trusted_party' => :'BOOLEAN'
+      }
+    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?(:'InputString')
+        self.input_string = attributes[:'InputString']
+      end
+
+      if attributes.has_key?(:'FromName')
+        self.from_name = attributes[:'FromName']
+      end
+
+      if attributes.has_key?(:'ToName')
+        self.to_name = attributes[:'ToName']
+      end
+
+      if attributes.has_key?(:'FromPhoneNumber')
+        self.from_phone_number = attributes[:'FromPhoneNumber']
+      end
+
+      if attributes.has_key?(:'ToPhoneNumber')
+        self.to_phone_number = attributes[:'ToPhoneNumber']
+      end
+
+      if attributes.has_key?(:'FromEmailAddress')
+        self.from_email_address = attributes[:'FromEmailAddress']
+      end
+
+      if attributes.has_key?(:'ToEmailAddress')
+        self.to_email_address = attributes[:'ToEmailAddress']
+      end
+
+      if attributes.has_key?(:'TrustedParty')
+        self.trusted_party = attributes[:'TrustedParty']
+      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 &&
+          input_string == o.input_string &&
+          from_name == o.from_name &&
+          to_name == o.to_name &&
+          from_phone_number == o.from_phone_number &&
+          to_phone_number == o.to_phone_number &&
+          from_email_address == o.from_email_address &&
+          to_email_address == o.to_email_address &&
+          trusted_party == o.trusted_party
+    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
+      [input_string, from_name, to_name, from_phone_number, to_phone_number, from_email_address, to_email_address, trusted_party].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 = CloudmersivePhishingDetectionApiClient.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-phishing-detection-api-client/models/unsafe_url_result.rb

@@ -0,0 +1,226 @@
+=begin
+#phishingapi
+
+#Easily and directly scan and block phishing security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersivePhishingDetectionApiClient
+  # Result of analyzing an individual URL found in text
+  class UnsafeUrlResult
+    # The URL that was detected and analyzed
+    attr_accessor :url
+
+    # True if the result is not phishing (clean), and false otherwise
+    attr_accessor :clean_result
+
+    # True if the URL is an SSRF threat
+    attr_accessor :is_ssrf_threat
+
+    # True if the URL contains phishing threat risks, false otherwise
+    attr_accessor :contains_phishing
+
+    # True if the URL contains a phishing attempt, false otherwise
+    attr_accessor :contains_phishing_attempt
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'Url',
+        :'clean_result' => :'CleanResult',
+        :'is_ssrf_threat' => :'IsSsrfThreat',
+        :'contains_phishing' => :'ContainsPhishing',
+        :'contains_phishing_attempt' => :'ContainsPhishingAttempt'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'url' => :'String',
+        :'clean_result' => :'BOOLEAN',
+        :'is_ssrf_threat' => :'BOOLEAN',
+        :'contains_phishing' => :'BOOLEAN',
+        :'contains_phishing_attempt' => :'BOOLEAN'
+      }
+    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?(:'Url')
+        self.url = attributes[:'Url']
+      end
+
+      if attributes.has_key?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      end
+
+      if attributes.has_key?(:'IsSsrfThreat')
+        self.is_ssrf_threat = attributes[:'IsSsrfThreat']
+      end
+
+      if attributes.has_key?(:'ContainsPhishing')
+        self.contains_phishing = attributes[:'ContainsPhishing']
+      end
+
+      if attributes.has_key?(:'ContainsPhishingAttempt')
+        self.contains_phishing_attempt = attributes[:'ContainsPhishingAttempt']
+      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 &&
+          url == o.url &&
+          clean_result == o.clean_result &&
+          is_ssrf_threat == o.is_ssrf_threat &&
+          contains_phishing == o.contains_phishing &&
+          contains_phishing_attempt == o.contains_phishing_attempt
+    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
+      [url, clean_result, is_ssrf_threat, contains_phishing, contains_phishing_attempt].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 = CloudmersivePhishingDetectionApiClient.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-phishing-detection-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersivePhishingDetectionApiClient
-  VERSION = '2.2.2'
+  VERSION = '2.2.4'
 end

data/lib/cloudmersive-phishing-detection-api-client.rb

@@ -23,7 +23,11 @@ require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_ad
 require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_advanced_response'
 require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_email_advanced_response'
 require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_response'
+require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_text_string_request'
+require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_text_string_response'
 require 'cloudmersive-phishing-detection-api-client/models/phishing_detection_url_advanced_response'
+require 'cloudmersive-phishing-detection-api-client/models/prior_history_item'
+require 'cloudmersive-phishing-detection-api-client/models/unsafe_url_result'
 
 # APIs
 require 'cloudmersive-phishing-detection-api-client/api/phishing_detection_api'