cloudmersive-spam-detection-api-client 2.3.0 → 2.4.0

data/lib/cloudmersive-spam-detection-api-client/models/spam_detection_advanced_form_field.rb

@@ -0,0 +1,196 @@
+=begin
+#spamapi
+
+#Easily and directly scan and block spam 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 CloudmersiveSpamDetectionApiClient
+  # Form field submitted to run spam detection on
+  class SpamDetectionAdvancedFormField
+    # Title of the field
+    attr_accessor :field_title
+
+    # Value of the field
+    attr_accessor :field_value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'field_title' => :'FieldTitle',
+        :'field_value' => :'FieldValue'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'field_title' => :'String',
+        :'field_value' => :'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?(:'FieldTitle')
+        self.field_title = attributes[:'FieldTitle']
+      end
+
+      if attributes.has_key?(:'FieldValue')
+        self.field_value = attributes[:'FieldValue']
+      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 &&
+          field_title == o.field_title &&
+          field_value == o.field_value
+    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
+      [field_title, field_value].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 = CloudmersiveSpamDetectionApiClient.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-spam-detection-api-client/models/spam_detection_advanced_form_submission_request.rb

@@ -0,0 +1,218 @@
+=begin
+#spamapi
+
+#Easily and directly scan and block spam 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 CloudmersiveSpamDetectionApiClient
+  # AI advanced spam detection request
+  class SpamDetectionAdvancedFormSubmissionRequest
+    # Form fields and values that you received in your form submission
+    attr_accessor :input_form_fields
+
+    # True if unsolicited sales should be allowed, false otherwise
+    attr_accessor :allow_unsolicited_sales
+
+    # True if promotional content should be allowed, false otherwise
+    attr_accessor :allow_promotional_content
+
+    # True if phishing should be allowed, false otherwise
+    attr_accessor :allow_phishing
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_form_fields' => :'InputFormFields',
+        :'allow_unsolicited_sales' => :'AllowUnsolicitedSales',
+        :'allow_promotional_content' => :'AllowPromotionalContent',
+        :'allow_phishing' => :'AllowPhishing'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'input_form_fields' => :'Array<SpamDetectionAdvancedFormField>',
+        :'allow_unsolicited_sales' => :'BOOLEAN',
+        :'allow_promotional_content' => :'BOOLEAN',
+        :'allow_phishing' => :'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?(:'InputFormFields')
+        if (value = attributes[:'InputFormFields']).is_a?(Array)
+          self.input_form_fields = value
+        end
+      end
+
+      if attributes.has_key?(:'AllowUnsolicitedSales')
+        self.allow_unsolicited_sales = attributes[:'AllowUnsolicitedSales']
+      end
+
+      if attributes.has_key?(:'AllowPromotionalContent')
+        self.allow_promotional_content = attributes[:'AllowPromotionalContent']
+      end
+
+      if attributes.has_key?(:'AllowPhishing')
+        self.allow_phishing = attributes[:'AllowPhishing']
+      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_form_fields == o.input_form_fields &&
+          allow_unsolicited_sales == o.allow_unsolicited_sales &&
+          allow_promotional_content == o.allow_promotional_content &&
+          allow_phishing == o.allow_phishing
+    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_form_fields, allow_unsolicited_sales, allow_promotional_content, allow_phishing].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 = CloudmersiveSpamDetectionApiClient.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-spam-detection-api-client/models/spam_detection_advanced_request.rb

@@ -1,7 +1,7 @@
 =begin
 #spamapi
 
-#Easily and directly scan and block phishing security threats.
+#Easily and directly scan and block spam security threats in input.
 
 OpenAPI spec version: v1
 

data/lib/cloudmersive-spam-detection-api-client/models/spam_detection_advanced_response.rb

@@ -1,7 +1,7 @@
 =begin
 #spamapi
 
-#Easily and directly scan and block phishing security threats.
+#Easily and directly scan and block spam security threats in input.
 
 OpenAPI spec version: v1
 
@@ -18,6 +18,9 @@ module CloudmersiveSpamDetectionApiClient
     # True if the result is not spam (clean), and false otherwise
     attr_accessor :clean_result
 
+    # Overall spam risk level between 0.0 and 1.0
+    attr_accessor :spam_risk_level
+
     # True if the input text contains spam, false otherwise
     attr_accessor :contains_spam
 
@@ -30,14 +33,19 @@ module CloudmersiveSpamDetectionApiClient
     # True if the input text contains a phishing attempt, false otherwise
     attr_accessor :contains_phishing_attempt
 
+    # 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',
+        :'spam_risk_level' => :'SpamRiskLevel',
         :'contains_spam' => :'ContainsSpam',
         :'contains_unsolicited_sales' => :'ContainsUnsolicitedSales',
         :'contains_promotional_content' => :'ContainsPromotionalContent',
-        :'contains_phishing_attempt' => :'ContainsPhishingAttempt'
+        :'contains_phishing_attempt' => :'ContainsPhishingAttempt',
+        :'analysis_rationale' => :'AnalysisRationale'
       }
     end
 
@@ -45,10 +53,12 @@ module CloudmersiveSpamDetectionApiClient
     def self.swagger_types
       {
         :'clean_result' => :'BOOLEAN',
+        :'spam_risk_level' => :'Float',
         :'contains_spam' => :'BOOLEAN',
         :'contains_unsolicited_sales' => :'BOOLEAN',
         :'contains_promotional_content' => :'BOOLEAN',
-        :'contains_phishing_attempt' => :'BOOLEAN'
+        :'contains_phishing_attempt' => :'BOOLEAN',
+        :'analysis_rationale' => :'String'
       }
     end
 
@@ -64,6 +74,10 @@ module CloudmersiveSpamDetectionApiClient
         self.clean_result = attributes[:'CleanResult']
       end
 
+      if attributes.has_key?(:'SpamRiskLevel')
+        self.spam_risk_level = attributes[:'SpamRiskLevel']
+      end
+
       if attributes.has_key?(:'ContainsSpam')
         self.contains_spam = attributes[:'ContainsSpam']
       end
@@ -79,6 +93,10 @@ module CloudmersiveSpamDetectionApiClient
       if attributes.has_key?(:'ContainsPhishingAttempt')
         self.contains_phishing_attempt = attributes[:'ContainsPhishingAttempt']
       end
+
+      if attributes.has_key?(:'AnalysisRationale')
+        self.analysis_rationale = attributes[:'AnalysisRationale']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,10 +118,12 @@ module CloudmersiveSpamDetectionApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           clean_result == o.clean_result &&
+          spam_risk_level == o.spam_risk_level &&
           contains_spam == o.contains_spam &&
           contains_unsolicited_sales == o.contains_unsolicited_sales &&
           contains_promotional_content == o.contains_promotional_content &&
-          contains_phishing_attempt == o.contains_phishing_attempt
+          contains_phishing_attempt == o.contains_phishing_attempt &&
+          analysis_rationale == o.analysis_rationale
     end
 
     # @see the `==` method
@@ -115,7 +135,7 @@ module CloudmersiveSpamDetectionApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clean_result, contains_spam, contains_unsolicited_sales, contains_promotional_content, contains_phishing_attempt].hash
+      [clean_result, spam_risk_level, contains_spam, contains_unsolicited_sales, contains_promotional_content, contains_phishing_attempt, analysis_rationale].hash
     end
 
     # Builds the object from hash