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

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

@@ -0,0 +1,246 @@
+=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
+  # Result of detecting spam using AI
+  class SpamDetectionFormSubmissionAdvancedResponse
+    # 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
+
+    # True if the input text contains unsolicited sales, false otherwise
+    attr_accessor :contains_unsolicited_sales
+
+    # True if the input text contains promotional content, false otherwise
+    attr_accessor :contains_promotional_content
+
+    # 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',
+        :'analysis_rationale' => :'AnalysisRationale'
+      }
+    end
+
+    # Attribute type mapping.
+    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',
+        :'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?(:'SpamRiskLevel')
+        self.spam_risk_level = attributes[:'SpamRiskLevel']
+      end
+
+      if attributes.has_key?(:'ContainsSpam')
+        self.contains_spam = attributes[:'ContainsSpam']
+      end
+
+      if attributes.has_key?(:'ContainsUnsolicitedSales')
+        self.contains_unsolicited_sales = attributes[:'ContainsUnsolicitedSales']
+      end
+
+      if attributes.has_key?(:'ContainsPromotionalContent')
+        self.contains_promotional_content = attributes[:'ContainsPromotionalContent']
+      end
+
+      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?
+    # @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 &&
+          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 &&
+          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, spam_risk_level, contains_spam, contains_unsolicited_sales, contains_promotional_content, contains_phishing_attempt, 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 = 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_request.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
+  # AI spam detection request
+  class SpamDetectionRequest
+    # Input text string to detect spam against
+    attr_accessor :input_string
+
+    # Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced.
+    attr_accessor :model
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_string' => :'InputString',
+        :'model' => :'Model'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'input_string' => :'String',
+        :'model' => :'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?(:'InputString')
+        self.input_string = attributes[:'InputString']
+      end
+
+      if attributes.has_key?(:'Model')
+        self.model = attributes[:'Model']
+      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 &&
+          model == o.model
+    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, model].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_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
 

data/lib/cloudmersive-spam-detection-api-client/version.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
 
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersiveSpamDetectionApiClient
-  VERSION = '2.2.1'
+  VERSION = '2.4.0'
 end

data/lib/cloudmersive-spam-detection-api-client.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
 
@@ -17,8 +17,12 @@ require 'cloudmersive-spam-detection-api-client/version'
 require 'cloudmersive-spam-detection-api-client/configuration'
 
 # Models
+require 'cloudmersive-spam-detection-api-client/models/spam_detection_advanced_form_field'
+require 'cloudmersive-spam-detection-api-client/models/spam_detection_advanced_form_submission_request'
 require 'cloudmersive-spam-detection-api-client/models/spam_detection_advanced_request'
 require 'cloudmersive-spam-detection-api-client/models/spam_detection_advanced_response'
+require 'cloudmersive-spam-detection-api-client/models/spam_detection_form_submission_advanced_response'
+require 'cloudmersive-spam-detection-api-client/models/spam_detection_request'
 require 'cloudmersive-spam-detection-api-client/models/spam_detection_response'
 
 # APIs

data/spec/api/spam_detection_api_spec.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
 
@@ -32,8 +32,47 @@ describe 'SpamDetectionApi' do
     end
   end
 
+  # unit tests for spam_detect_file_advanced_post
+  # Perform advanced AI spam detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :model Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced.
+  # @option opts [String] :preprocessing Optional: Specify which preprocessing to Use.  Possible choices are None, Compatability and Auto.  Default is Auto.
+  # @option opts [BOOLEAN] :allow_phishing True if phishing should be allowed, false otherwise
+  # @option opts [BOOLEAN] :allow_unsolicited_sales True if unsolicited sales should be allowed, false otherwise
+  # @option opts [BOOLEAN] :allow_promotional_content True if promotional content should be allowed, false otherwise
+  # @option opts [File] :input_file 
+  # @return [SpamDetectionAdvancedResponse]
+  describe 'spam_detect_file_advanced_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for spam_detect_file_post
+  # Perform AI spam detection and classification on an input image or document (PDF or DOCX).  Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content.  Uses 100-125 API calls depending on model selected.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :model Model to use; default setting is Advanced
+  # @option opts [File] :input_file 
+  # @return [SpamDetectionResponse]
+  describe 'spam_detect_file_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for spam_detect_form_submission_advanced_post
+  # Perform advanced AI spam detection and classification against a form submission.  Analyzes form input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+  # @param [Hash] opts the optional parameters
+  # @option opts [SpamDetectionAdvancedFormSubmissionRequest] :body Spam detection request
+  # @return [SpamDetectionFormSubmissionAdvancedResponse]
+  describe 'spam_detect_form_submission_advanced_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for spam_detect_text_string_advanced_post
-  # Perform advanced AI spam detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content.
+  # Perform advanced AI spam detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
   # @param [Hash] opts the optional parameters
   # @option opts [SpamDetectionAdvancedRequest] :body Spam detection request
   # @return [SpamDetectionAdvancedResponse]
@@ -44,9 +83,9 @@ describe 'SpamDetectionApi' do
   end
 
   # unit tests for spam_detect_text_string_post
-  # Perform AI spam detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content.
+  # Perform AI spam detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learnign to detect spam, phishing and other unsafe content.  Uses 25-75 API calls depending on model selected.
   # @param [Hash] opts the optional parameters
-  # @option opts [SpamDetectionAdvancedRequest] :body Spam detection request
+  # @option opts [SpamDetectionRequest] :body Spam detection request
   # @return [SpamDetectionResponse]
   describe 'spam_detect_text_string_post test' do
     it 'should work' do

data/spec/api_client_spec.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/spec/configuration_spec.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/spec/models/spam_detection_advanced_form_field_spec.rb

@@ -0,0 +1,47 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormField
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SpamDetectionAdvancedFormField' do
+  before do
+    # run before each test
+    @instance = CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormField.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SpamDetectionAdvancedFormField' do
+    it 'should create an instance of SpamDetectionAdvancedFormField' do
+      expect(@instance).to be_instance_of(CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormField)
+    end
+  end
+  describe 'test attribute "field_title"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "field_value"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/spam_detection_advanced_form_submission_request_spec.rb

@@ -0,0 +1,59 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormSubmissionRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SpamDetectionAdvancedFormSubmissionRequest' do
+  before do
+    # run before each test
+    @instance = CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormSubmissionRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SpamDetectionAdvancedFormSubmissionRequest' do
+    it 'should create an instance of SpamDetectionAdvancedFormSubmissionRequest' do
+      expect(@instance).to be_instance_of(CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormSubmissionRequest)
+    end
+  end
+  describe 'test attribute "input_form_fields"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_unsolicited_sales"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_promotional_content"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_phishing"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end