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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d3f876a94ba37d340498e88c7a09e720fa277b8233cd087134497f8bcf90605
-  data.tar.gz: f26d31ccbf73ada867ca4e85b22eb0946d3a2f6f3f2c86634285dc4ac1c9a5dd
+  metadata.gz: b6c35d673d893361bc3597ccae72552fedef2b936c40b228bc2bc1fd01a6b7a9
+  data.tar.gz: c1c41115fa8dfb2a7a1a07f6a14805ba8d32b519b8cad9f9b9b414aeba879c91
 SHA512:
-  metadata.gz: 83f8591dd3989804c4ac1fd3800543f26e37480e593cef21b4ec77c34f45ae81ca64cc6b270e66196edf205285486ef0e21806352c7cf61ce2164c9ec652e82e
-  data.tar.gz: 16a9a3d5cb7d960690def7b057ec968d2352a4624f869600ac45ceb55256d9ce06354dcb1ff519b27867070b4d887dec82d1a0fd7ed9114a8c0959ec59e0bf87
+  metadata.gz: 07b2200a1df7403389143d0a90982846d507e7a2125de4f1ed7bf443be625bd604e2a2cf59f679198099a6325eec9fe8e942e64f055ae7f73c1a9ef20fe1453d
+  data.tar.gz: 6615752fc301424a9ea5cf4cb18044ce5640e3038352ec74ff456118c9378ae67c077d9563abcc1c9aaeb6a6423e7ad43a083b7175caa6a8e6915206361dc316

data/README.md

@@ -1,13 +1,13 @@
 # cloudmersive-spam-detection-api-client
 
-CloudmersiveSpamDetectionApiClient - the Ruby gem for the phishingapi
+CloudmersiveSpamDetectionApiClient - the Ruby gem for the spamapi
 
 Easily and directly scan and block phishing security threats.
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 2.2.0
+- Package version: 2.3.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-spam-detection-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-spam-detection-api-client-2.2.0.gem
+gem install ./cloudmersive-spam-detection-api-client-2.3.0.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-spam-detection-api-client-2.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-spam-detection-api-client-2.3.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-spam-detection-api-client', '~> 2.2.0'
+    gem 'cloudmersive-spam-detection-api-client', '~> 2.3.0'
 
 ### Install from Git
 
@@ -65,10 +65,11 @@ end
 api_instance = CloudmersiveSpamDetectionApiClient::SpamDetectionApi.new
 
 opts = { 
-  body: CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedRequest.new # SpamDetectionAdvancedRequest | 
+  body: CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedRequest.new # SpamDetectionAdvancedRequest | Spam detection request
 }
 
 begin
+  #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.
   result = api_instance.spam_detect_text_string_advanced_post(opts)
   p result
 rescue CloudmersiveSpamDetectionApiClient::ApiError => e
@@ -83,13 +84,16 @@ All URIs are relative to *https://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*CloudmersiveSpamDetectionApiClient::SpamDetectionApi* | [**spam_detect_text_string_advanced_post**](docs/SpamDetectionApi.md#spam_detect_text_string_advanced_post) | **POST** /spam/detect/text-string/advanced | 
+*CloudmersiveSpamDetectionApiClient::SpamDetectionApi* | [**spam_detect_text_string_advanced_post**](docs/SpamDetectionApi.md#spam_detect_text_string_advanced_post) | **POST** /spam/detect/text-string/advanced | 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.
+*CloudmersiveSpamDetectionApiClient::SpamDetectionApi* | [**spam_detect_text_string_post**](docs/SpamDetectionApi.md#spam_detect_text_string_post) | **POST** /spam/detect/text-string | 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.
 
 
 ## Documentation for Models
 
  - [CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedRequest](docs/SpamDetectionAdvancedRequest.md)
  - [CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedResponse](docs/SpamDetectionAdvancedResponse.md)
+ - [CloudmersiveSpamDetectionApiClient::SpamDetectionRequest](docs/SpamDetectionRequest.md)
+ - [CloudmersiveSpamDetectionApiClient::SpamDetectionResponse](docs/SpamDetectionResponse.md)
 
 
 ## Documentation for Authorization

data/cloudmersive-spam-detection-api-client.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Cloudmersive"]
   s.email       = [""]
-  s.homepage    = "https://www.cloudmersive.com/spam-api"
+  s.homepage    = "https://cloudmersive.com/spam-detection-api"
   s.summary     = "Scan content for spam."
   s.description = "Spam Detection API lets you scan content for spam using AI."
   s.license     = 'Apache 2.0'

data/docs/SpamDetectionAdvancedRequest.md

@@ -3,6 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**input_string** | **String** |  | [optional] 
+**input_string** | **String** | Input text string to detect spam against | [optional] 
+**model** | **String** | Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced. | [optional] 
+**allow_unsolicited_sales** | **BOOLEAN** | True if unsolicited sales should be allowed, false otherwise | [optional] 
+**allow_promotional_content** | **BOOLEAN** | True if promotional content should be allowed, false otherwise | [optional] 
+**allow_phishing** | **BOOLEAN** | True if phishing should be allowed, false otherwise | [optional] 
 
 

data/docs/SpamDetectionAdvancedResponse.md

@@ -3,6 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**clean_result** | **BOOLEAN** |  | [optional] 
+**clean_result** | **BOOLEAN** | True if the result is not spam (clean), and false otherwise | [optional] 
+**contains_spam** | **BOOLEAN** | True if the input text contains spam, false otherwise | [optional] 
+**contains_unsolicited_sales** | **BOOLEAN** | True if the input text contains unsolicited sales, false otherwise | [optional] 
+**contains_promotional_content** | **BOOLEAN** | True if the input text contains promotional content, false otherwise | [optional] 
+**contains_phishing_attempt** | **BOOLEAN** | True if the input text contains a phishing attempt, false otherwise | [optional] 
 
 

data/docs/SpamDetectionApi.md

@@ -4,13 +4,14 @@ All URIs are relative to *https://localhost*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**spam_detect_text_string_advanced_post**](SpamDetectionApi.md#spam_detect_text_string_advanced_post) | **POST** /spam/detect/text-string/advanced | 
+[**spam_detect_text_string_advanced_post**](SpamDetectionApi.md#spam_detect_text_string_advanced_post) | **POST** /spam/detect/text-string/advanced | 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.
+[**spam_detect_text_string_post**](SpamDetectionApi.md#spam_detect_text_string_post) | **POST** /spam/detect/text-string | 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.
 
 
 # **spam_detect_text_string_advanced_post**
 > SpamDetectionAdvancedResponse spam_detect_text_string_advanced_post(opts)
 
-
+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.
 
 ### Example
 ```ruby
@@ -27,10 +28,11 @@ end
 api_instance = CloudmersiveSpamDetectionApiClient::SpamDetectionApi.new
 
 opts = { 
-  body: CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedRequest.new # SpamDetectionAdvancedRequest | 
+  body: CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedRequest.new # SpamDetectionAdvancedRequest | Spam detection request
 }
 
 begin
+  #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.
   result = api_instance.spam_detect_text_string_advanced_post(opts)
   p result
 rescue CloudmersiveSpamDetectionApiClient::ApiError => e
@@ -42,7 +44,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**SpamDetectionAdvancedRequest**](SpamDetectionAdvancedRequest.md)|  | [optional] 
+ **body** | [**SpamDetectionAdvancedRequest**](SpamDetectionAdvancedRequest.md)| Spam detection request | [optional] 
 
 ### Return type
 
@@ -59,3 +61,56 @@ Name | Type | Description  | Notes
 
 
 
+# **spam_detect_text_string_post**
+> SpamDetectionResponse spam_detect_text_string_post(opts)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-spam-detection-api-client'
+# setup authorization
+CloudmersiveSpamDetectionApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveSpamDetectionApiClient::SpamDetectionApi.new
+
+opts = { 
+  body: CloudmersiveSpamDetectionApiClient::SpamDetectionRequest.new # SpamDetectionRequest | Spam detection request
+}
+
+begin
+  #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.
+  result = api_instance.spam_detect_text_string_post(opts)
+  p result
+rescue CloudmersiveSpamDetectionApiClient::ApiError => e
+  puts "Exception when calling SpamDetectionApi->spam_detect_text_string_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SpamDetectionRequest**](SpamDetectionRequest.md)| Spam detection request | [optional] 
+
+### Return type
+
+[**SpamDetectionResponse**](SpamDetectionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+

data/docs/SpamDetectionRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveSpamDetectionApiClient::SpamDetectionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_string** | **String** | Input text string to detect spam against | [optional] 
+**model** | **String** | Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced. | [optional] 
+
+

data/docs/SpamDetectionResponse.md

@@ -0,0 +1,8 @@
+# CloudmersiveSpamDetectionApiClient::SpamDetectionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_result** | **BOOLEAN** | True if the result is not spam (clean), and false otherwise | [optional] 
+
+

data/lib/cloudmersive-spam-detection-api-client/api/spam_detection_api.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -19,16 +19,18 @@ module CloudmersiveSpamDetectionApiClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # 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 
+    # @option opts [SpamDetectionAdvancedRequest] :body Spam detection request
     # @return [SpamDetectionAdvancedResponse]
     def spam_detect_text_string_advanced_post(opts = {})
       data, _status_code, _headers = spam_detect_text_string_advanced_post_with_http_info(opts)
       data
     end
 
+    # 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 
+    # @option opts [SpamDetectionAdvancedRequest] :body Spam detection request
     # @return [Array<(SpamDetectionAdvancedResponse, Fixnum, Hash)>] SpamDetectionAdvancedResponse data, response status code and response headers
     def spam_detect_text_string_advanced_post_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -65,5 +67,53 @@ module CloudmersiveSpamDetectionApiClient
       end
       return data, status_code, headers
     end
+    # 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 [SpamDetectionRequest] :body Spam detection request
+    # @return [SpamDetectionResponse]
+    def spam_detect_text_string_post(opts = {})
+      data, _status_code, _headers = spam_detect_text_string_post_with_http_info(opts)
+      data
+    end
+
+    # 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 [SpamDetectionRequest] :body Spam detection request
+    # @return [Array<(SpamDetectionResponse, Fixnum, Hash)>] SpamDetectionResponse data, response status code and response headers
+    def spam_detect_text_string_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpamDetectionApi.spam_detect_text_string_post ...'
+      end
+      # resource path
+      local_var_path = '/spam/detect/text-string'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SpamDetectionResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpamDetectionApi#spam_detect_text_string_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/cloudmersive-spam-detection-api-client/api_client.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 

data/lib/cloudmersive-spam-detection-api-client/api_error.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 

data/lib/cloudmersive-spam-detection-api-client/configuration.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 

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

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -13,20 +13,42 @@ Swagger Codegen version: 2.4.14
 require 'date'
 
 module CloudmersiveSpamDetectionApiClient
+  # AI advanced spam detection request
   class SpamDetectionAdvancedRequest
+    # 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
+
+    # 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_string' => :'inputString'
+        :'input_string' => :'InputString',
+        :'model' => :'Model',
+        :'allow_unsolicited_sales' => :'AllowUnsolicitedSales',
+        :'allow_promotional_content' => :'AllowPromotionalContent',
+        :'allow_phishing' => :'AllowPhishing'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'input_string' => :'String'
+        :'input_string' => :'String',
+        :'model' => :'String',
+        :'allow_unsolicited_sales' => :'BOOLEAN',
+        :'allow_promotional_content' => :'BOOLEAN',
+        :'allow_phishing' => :'BOOLEAN'
       }
     end
 
@@ -38,8 +60,24 @@ module CloudmersiveSpamDetectionApiClient
       # 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']
+      if attributes.has_key?(:'InputString')
+        self.input_string = attributes[:'InputString']
+      end
+
+      if attributes.has_key?(:'Model')
+        self.model = attributes[:'Model']
+      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
 
@@ -61,7 +99,11 @@ module CloudmersiveSpamDetectionApiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          input_string == o.input_string
+          input_string == o.input_string &&
+          model == o.model &&
+          allow_unsolicited_sales == o.allow_unsolicited_sales &&
+          allow_promotional_content == o.allow_promotional_content &&
+          allow_phishing == o.allow_phishing
     end
 
     # @see the `==` method
@@ -73,7 +115,7 @@ module CloudmersiveSpamDetectionApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [input_string].hash
+      [input_string, model, allow_unsolicited_sales, allow_promotional_content, allow_phishing].hash
     end
 
     # Builds the object from hash

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

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -13,20 +13,42 @@ Swagger Codegen version: 2.4.14
 require 'date'
 
 module CloudmersiveSpamDetectionApiClient
+  # Result of detecting spam using AI
   class SpamDetectionAdvancedResponse
+    # True if the result is not spam (clean), and false otherwise
     attr_accessor :clean_result
 
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'clean_result' => :'cleanResult'
+        :'clean_result' => :'CleanResult',
+        :'contains_spam' => :'ContainsSpam',
+        :'contains_unsolicited_sales' => :'ContainsUnsolicitedSales',
+        :'contains_promotional_content' => :'ContainsPromotionalContent',
+        :'contains_phishing_attempt' => :'ContainsPhishingAttempt'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'clean_result' => :'BOOLEAN'
+        :'clean_result' => :'BOOLEAN',
+        :'contains_spam' => :'BOOLEAN',
+        :'contains_unsolicited_sales' => :'BOOLEAN',
+        :'contains_promotional_content' => :'BOOLEAN',
+        :'contains_phishing_attempt' => :'BOOLEAN'
       }
     end
 
@@ -38,8 +60,24 @@ module CloudmersiveSpamDetectionApiClient
       # 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']
+      if attributes.has_key?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      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
     end
 
@@ -61,7 +99,11 @@ module CloudmersiveSpamDetectionApiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          clean_result == o.clean_result
+          clean_result == o.clean_result &&
+          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
     end
 
     # @see the `==` method
@@ -73,7 +115,7 @@ module CloudmersiveSpamDetectionApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clean_result].hash
+      [clean_result, contains_spam, contains_unsolicited_sales, contains_promotional_content, contains_phishing_attempt].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,196 @@
+=begin
+#spamapi
+
+#Easily and directly scan and block phishing security threats.
+
+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

@@ -0,0 +1,186 @@
+=begin
+#spamapi
+
+#Easily and directly scan and block phishing security threats.
+
+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 SpamDetectionResponse
+    # True if the result is not spam (clean), and false otherwise
+    attr_accessor :clean_result
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'clean_result' => :'CleanResult'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'clean_result' => :'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?(:'CleanResult')
+        self.clean_result = attributes[:'CleanResult']
+      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
+    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].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/version.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersiveSpamDetectionApiClient
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

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

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -19,6 +19,8 @@ require 'cloudmersive-spam-detection-api-client/configuration'
 # Models
 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_request'
+require 'cloudmersive-spam-detection-api-client/models/spam_detection_response'
 
 # APIs
 require 'cloudmersive-spam-detection-api-client/api/spam_detection_api'

data/spec/api/spam_detection_api_spec.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -33,8 +33,9 @@ describe 'SpamDetectionApi' do
   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.  Uses 25-100 API calls depending on model selected.
   # @param [Hash] opts the optional parameters
-  # @option opts [SpamDetectionAdvancedRequest] :body 
+  # @option opts [SpamDetectionAdvancedRequest] :body Spam detection request
   # @return [SpamDetectionAdvancedResponse]
   describe 'spam_detect_text_string_advanced_post test' do
     it 'should work' do
@@ -42,4 +43,15 @@ describe 'SpamDetectionApi' do
     end
   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.  Uses 25-75 API calls depending on model selected.
+  # @param [Hash] opts the optional parameters
+  # @option opts [SpamDetectionRequest] :body Spam detection request
+  # @return [SpamDetectionResponse]
+  describe 'spam_detect_text_string_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api_client_spec.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 

data/spec/configuration_spec.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 

data/spec/models/spam_detection_advanced_request_spec.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -38,4 +38,28 @@ describe 'SpamDetectionAdvancedRequest' do
     end
   end
 
+  describe 'test attribute "model"' 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

data/spec/models/spam_detection_advanced_response_spec.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 
@@ -38,4 +38,28 @@ describe 'SpamDetectionAdvancedResponse' do
     end
   end
 
+  describe 'test attribute "contains_spam"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "contains_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 "contains_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 "contains_phishing_attempt"' 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_request_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#spamapi
+
+#Easily and directly scan and block phishing security threats.
+
+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::SpamDetectionRequest
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SpamDetectionRequest' do
+  before do
+    # run before each test
+    @instance = CloudmersiveSpamDetectionApiClient::SpamDetectionRequest.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SpamDetectionRequest' do
+    it 'should create an instance of SpamDetectionRequest' do
+      expect(@instance).to be_instance_of(CloudmersiveSpamDetectionApiClient::SpamDetectionRequest)
+    end
+  end
+  describe 'test attribute "input_string"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "model"' 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_response_spec.rb

@@ -0,0 +1,41 @@
+=begin
+#spamapi
+
+#Easily and directly scan and block phishing security threats.
+
+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::SpamDetectionResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SpamDetectionResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveSpamDetectionApiClient::SpamDetectionResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SpamDetectionResponse' do
+    it 'should create an instance of SpamDetectionResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveSpamDetectionApiClient::SpamDetectionResponse)
+    end
+  end
+  describe 'test attribute "clean_result"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 =begin
-#phishingapi
+#spamapi
 
 #Easily and directly scan and block phishing security threats.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-spam-detection-api-client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Cloudmersive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 2025-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -204,6 +204,8 @@ files:
 - "./docs/SpamDetectionAdvancedRequest.md"
 - "./docs/SpamDetectionAdvancedResponse.md"
 - "./docs/SpamDetectionApi.md"
+- "./docs/SpamDetectionRequest.md"
+- "./docs/SpamDetectionResponse.md"
 - "./git_push.sh"
 - "./lib/cloudmersive-spam-detection-api-client.rb"
 - "./lib/cloudmersive-spam-detection-api-client/api/spam_detection_api.rb"
@@ -212,14 +214,18 @@ files:
 - "./lib/cloudmersive-spam-detection-api-client/configuration.rb"
 - "./lib/cloudmersive-spam-detection-api-client/models/spam_detection_advanced_request.rb"
 - "./lib/cloudmersive-spam-detection-api-client/models/spam_detection_advanced_response.rb"
+- "./lib/cloudmersive-spam-detection-api-client/models/spam_detection_request.rb"
+- "./lib/cloudmersive-spam-detection-api-client/models/spam_detection_response.rb"
 - "./lib/cloudmersive-spam-detection-api-client/version.rb"
 - "./spec/api/spam_detection_api_spec.rb"
 - "./spec/api_client_spec.rb"
 - "./spec/configuration_spec.rb"
 - "./spec/models/spam_detection_advanced_request_spec.rb"
 - "./spec/models/spam_detection_advanced_response_spec.rb"
+- "./spec/models/spam_detection_request_spec.rb"
+- "./spec/models/spam_detection_response_spec.rb"
 - "./spec/spec_helper.rb"
-homepage: https://www.cloudmersive.com/spam-api
+homepage: https://cloudmersive.com/spam-detection-api
 licenses:
 - Apache 2.0
 metadata: {}