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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6c35d673d893361bc3597ccae72552fedef2b936c40b228bc2bc1fd01a6b7a9
-  data.tar.gz: c1c41115fa8dfb2a7a1a07f6a14805ba8d32b519b8cad9f9b9b414aeba879c91
+  metadata.gz: 43118e3c22c9dde6a27a06d94420d8c04773d40d46f70d9a4bc1bf33e9fdd3bd
+  data.tar.gz: 0a9aaf253388aaf786ad14ad00a5dbc280e1783432d7dee7343b69de69fd90d0
 SHA512:
-  metadata.gz: 07b2200a1df7403389143d0a90982846d507e7a2125de4f1ed7bf443be625bd604e2a2cf59f679198099a6325eec9fe8e942e64f055ae7f73c1a9ef20fe1453d
-  data.tar.gz: 6615752fc301424a9ea5cf4cb18044ce5640e3038352ec74ff456118c9378ae67c077d9563abcc1c9aaeb6a6423e7ad43a083b7175caa6a8e6915206361dc316
+  metadata.gz: 4d7d3f0428640f0c50fe5a83ffcfb155f83ded9b99525b83c7129a0d9c7becf4f7cf4089b17c033d54d61ad7d223a8104f920642e3107fd9f411e221b8762fcd
+  data.tar.gz: 49772a9cac003efbfc17d75993dcb3cfb53675e53ea5c479a6731c181c36eb8d3362d9637798bf00b0e7c9fb3496e9274a1ad1093e9b1732b3284dc19c1fcf2a

data/README.md

@@ -2,12 +2,12 @@
 
 CloudmersiveSpamDetectionApiClient - the Ruby gem for the spamapi
 
-Easily and directly scan and block phishing security threats.
+Easily and directly scan and block spam security threats in input.
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 2.3.0
+- Package version: 2.4.1
 - 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.3.0.gem
+gem install ./cloudmersive-spam-detection-api-client-2.4.1.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-spam-detection-api-client-2.3.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-spam-detection-api-client-2.4.1.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.3.0'
+    gem 'cloudmersive-spam-detection-api-client', '~> 2.4.1'
 
 ### Install from Git
 
@@ -65,15 +65,21 @@ end
 api_instance = CloudmersiveSpamDetectionApiClient::SpamDetectionApi.new
 
 opts = { 
-  body: CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedRequest.new # SpamDetectionAdvancedRequest | Spam detection request
+  model: 'Advanced', # String | Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced.
+  preprocessing: 'Auto', # String | Optional: Specify which preprocessing to Use.  Possible choices are None, Compatability and Auto.  Default is Auto.
+  allow_phishing: false, # BOOLEAN | True if phishing should be allowed, false otherwise
+  allow_unsolicited_sales: false, # BOOLEAN | True if unsolicited sales should be allowed, false otherwise
+  allow_promotional_content: true, # BOOLEAN | True if promotional content should be allowed, false otherwise
+  custom_policy_id: 'custom_policy_id_example', # String | Apply a Custom Policy for Spam Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud
+  input_file: File.new('/path/to/file.txt') # File | 
 }
 
 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)
+  #Perform advanced AI spam detection and classification against input text file.
+  result = api_instance.spam_detect_file_advanced_post(opts)
   p result
 rescue CloudmersiveSpamDetectionApiClient::ApiError => e
-  puts "Exception when calling SpamDetectionApi->spam_detect_text_string_advanced_post: #{e}"
+  puts "Exception when calling SpamDetectionApi->spam_detect_file_advanced_post: #{e}"
 end
 
 ```
@@ -84,14 +90,20 @@ 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 | 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.
+*CloudmersiveSpamDetectionApiClient::SpamDetectionApi* | [**spam_detect_file_advanced_post**](docs/SpamDetectionApi.md#spam_detect_file_advanced_post) | **POST** /spam/detect/file/advanced | Perform advanced AI spam detection and classification against input text file.
+*CloudmersiveSpamDetectionApiClient::SpamDetectionApi* | [**spam_detect_file_post**](docs/SpamDetectionApi.md#spam_detect_file_post) | **POST** /spam/detect/file | Perform AI spam detection and classification on an input image or document (PDF or DOCX)
+*CloudmersiveSpamDetectionApiClient::SpamDetectionApi* | [**spam_detect_form_submission_advanced_post**](docs/SpamDetectionApi.md#spam_detect_form_submission_advanced_post) | **POST** /spam/detect/form-submission/advanced | Perform advanced AI spam detection and classification against a form submission
+*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
+*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
 
 
 ## Documentation for Models
 
+ - [CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormField](docs/SpamDetectionAdvancedFormField.md)
+ - [CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormSubmissionRequest](docs/SpamDetectionAdvancedFormSubmissionRequest.md)
  - [CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedRequest](docs/SpamDetectionAdvancedRequest.md)
  - [CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedResponse](docs/SpamDetectionAdvancedResponse.md)
+ - [CloudmersiveSpamDetectionApiClient::SpamDetectionFormSubmissionAdvancedResponse](docs/SpamDetectionFormSubmissionAdvancedResponse.md)
  - [CloudmersiveSpamDetectionApiClient::SpamDetectionRequest](docs/SpamDetectionRequest.md)
  - [CloudmersiveSpamDetectionApiClient::SpamDetectionResponse](docs/SpamDetectionResponse.md)
 

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

@@ -3,7 +3,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/docs/SpamDetectionAdvancedFormField.md

@@ -0,0 +1,9 @@
+# CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormField
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field_title** | **String** | Title of the field | [optional] 
+**field_value** | **String** | Value of the field | [optional] 
+
+

data/docs/SpamDetectionAdvancedFormSubmissionRequest.md

@@ -0,0 +1,11 @@
+# CloudmersiveSpamDetectionApiClient::SpamDetectionAdvancedFormSubmissionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_form_fields** | [**Array<SpamDetectionAdvancedFormField>**](SpamDetectionAdvancedFormField.md) | Form fields and values that you received in your form submission | [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/SpamDetectionAdvancedRequest.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **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] 
+**custom_policy_id** | **String** | Apply a Custom Policy for Spam Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud | [optional] 
 
 

data/docs/SpamDetectionAdvancedResponse.md

@@ -4,9 +4,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **clean_result** | **BOOLEAN** | True if the result is not spam (clean), and false otherwise | [optional] 
+**spam_risk_level** | **Float** | Overall spam risk level between 0.0 and 1.0 | [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] 
+**analysis_rationale** | **String** | Rationale for why the conclusion was formed | [optional] 
 
 

data/docs/SpamDetectionApi.md

@@ -4,14 +4,198 @@ 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 | 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_file_advanced_post**](SpamDetectionApi.md#spam_detect_file_advanced_post) | **POST** /spam/detect/file/advanced | Perform advanced AI spam detection and classification against input text file.
+[**spam_detect_file_post**](SpamDetectionApi.md#spam_detect_file_post) | **POST** /spam/detect/file | Perform AI spam detection and classification on an input image or document (PDF or DOCX)
+[**spam_detect_form_submission_advanced_post**](SpamDetectionApi.md#spam_detect_form_submission_advanced_post) | **POST** /spam/detect/form-submission/advanced | Perform advanced AI spam detection and classification against a form submission
+[**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
+[**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
+
+
+# **spam_detect_file_advanced_post**
+> SpamDetectionAdvancedResponse spam_detect_file_advanced_post(opts)
+
+Perform advanced AI spam detection and classification against input text file.
+
+Analyzes input content as well as embedded URLs with AI deep learning to detect spam, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.  Supported file formats include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.
+
+### 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 = { 
+  model: 'Advanced', # String | Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced.
+  preprocessing: 'Auto', # String | Optional: Specify which preprocessing to Use.  Possible choices are None, Compatability and Auto.  Default is Auto.
+  allow_phishing: false, # BOOLEAN | True if phishing should be allowed, false otherwise
+  allow_unsolicited_sales: false, # BOOLEAN | True if unsolicited sales should be allowed, false otherwise
+  allow_promotional_content: true, # BOOLEAN | True if promotional content should be allowed, false otherwise
+  custom_policy_id: 'custom_policy_id_example', # String | Apply a Custom Policy for Spam Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud
+  input_file: File.new('/path/to/file.txt') # File | 
+}
+
+begin
+  #Perform advanced AI spam detection and classification against input text file.
+  result = api_instance.spam_detect_file_advanced_post(opts)
+  p result
+rescue CloudmersiveSpamDetectionApiClient::ApiError => e
+  puts "Exception when calling SpamDetectionApi->spam_detect_file_advanced_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **model** | **String**| Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced. | [optional] [default to Advanced]
+ **preprocessing** | **String**| Optional: Specify which preprocessing to Use.  Possible choices are None, Compatability and Auto.  Default is Auto. | [optional] [default to Auto]
+ **allow_phishing** | **BOOLEAN**| True if phishing should be allowed, false otherwise | [optional] [default to false]
+ **allow_unsolicited_sales** | **BOOLEAN**| True if unsolicited sales should be allowed, false otherwise | [optional] [default to false]
+ **allow_promotional_content** | **BOOLEAN**| True if promotional content should be allowed, false otherwise | [optional] [default to true]
+ **custom_policy_id** | **String**| Apply a Custom Policy for Spam Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud | [optional] 
+ **input_file** | **File**|  | [optional] 
+
+### Return type
+
+[**SpamDetectionAdvancedResponse**](SpamDetectionAdvancedResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **spam_detect_file_post**
+> SpamDetectionResponse spam_detect_file_post(opts)
+
+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.  Supported file formats include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.
+
+### 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 = { 
+  model: 'Advanced', # String | Model to use; default setting is Advanced
+  input_file: File.new('/path/to/file.txt') # File | 
+}
+
+begin
+  #Perform AI spam detection and classification on an input image or document (PDF or DOCX)
+  result = api_instance.spam_detect_file_post(opts)
+  p result
+rescue CloudmersiveSpamDetectionApiClient::ApiError => e
+  puts "Exception when calling SpamDetectionApi->spam_detect_file_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **model** | **String**| Model to use; default setting is Advanced | [optional] [default to Advanced]
+ **input_file** | **File**|  | [optional] 
+
+### Return type
+
+[**SpamDetectionResponse**](SpamDetectionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **spam_detect_form_submission_advanced_post**
+> SpamDetectionFormSubmissionAdvancedResponse spam_detect_form_submission_advanced_post(opts)
+
+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.
+
+### 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::SpamDetectionAdvancedFormSubmissionRequest.new # SpamDetectionAdvancedFormSubmissionRequest | Spam detection request
+}
+
+begin
+  #Perform advanced AI spam detection and classification against a form submission
+  result = api_instance.spam_detect_form_submission_advanced_post(opts)
+  p result
+rescue CloudmersiveSpamDetectionApiClient::ApiError => e
+  puts "Exception when calling SpamDetectionApi->spam_detect_form_submission_advanced_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SpamDetectionAdvancedFormSubmissionRequest**](SpamDetectionAdvancedFormSubmissionRequest.md)| Spam detection request | [optional] 
+
+### Return type
+
+[**SpamDetectionFormSubmissionAdvancedResponse**](SpamDetectionFormSubmissionAdvancedResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
 
 
 # **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.
+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
@@ -32,7 +216,7 @@ opts = {
 }
 
 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.
+  #Perform advanced AI spam detection and classification against input text string
   result = api_instance.spam_detect_text_string_advanced_post(opts)
   p result
 rescue CloudmersiveSpamDetectionApiClient::ApiError => e
@@ -64,7 +248,9 @@ 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.
+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
@@ -85,7 +271,7 @@ opts = {
 }
 
 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.
+  #Perform AI spam detection and classification against input text string
   result = api_instance.spam_detect_text_string_post(opts)
   p result
 rescue CloudmersiveSpamDetectionApiClient::ApiError => e

data/docs/SpamDetectionFormSubmissionAdvancedResponse.md

@@ -0,0 +1,14 @@
+# CloudmersiveSpamDetectionApiClient::SpamDetectionFormSubmissionAdvancedResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_result** | **BOOLEAN** | True if the result is not spam (clean), and false otherwise | [optional] 
+**spam_risk_level** | **Float** | Overall spam risk level between 0.0 and 1.0 | [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] 
+**analysis_rationale** | **String** | Rationale for why the conclusion was formed | [optional] 
+
+

data/lib/cloudmersive-spam-detection-api-client/api/spam_detection_api.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
 
@@ -19,7 +19,181 @@ 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.
+    # Perform advanced AI spam detection and classification against input text file.
+    # Analyzes input content as well as embedded URLs with AI deep learning to detect spam, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.  Supported file formats include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.
+    # @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. (default to Advanced)
+    # @option opts [String] :preprocessing Optional: Specify which preprocessing to Use.  Possible choices are None, Compatability and Auto.  Default is Auto. (default to Auto)
+    # @option opts [BOOLEAN] :allow_phishing True if phishing should be allowed, false otherwise (default to false)
+    # @option opts [BOOLEAN] :allow_unsolicited_sales True if unsolicited sales should be allowed, false otherwise (default to false)
+    # @option opts [BOOLEAN] :allow_promotional_content True if promotional content should be allowed, false otherwise (default to true)
+    # @option opts [String] :custom_policy_id Apply a Custom Policy for Spam Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud
+    # @option opts [File] :input_file 
+    # @return [SpamDetectionAdvancedResponse]
+    def spam_detect_file_advanced_post(opts = {})
+      data, _status_code, _headers = spam_detect_file_advanced_post_with_http_info(opts)
+      data
+    end
+
+    # Perform advanced AI spam detection and classification against input text file.
+    # Analyzes input content as well as embedded URLs with AI deep learning to detect spam, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.  Supported file formats include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.
+    # @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 [String] :custom_policy_id Apply a Custom Policy for Spam Enforcement by providing the ID; to create a Custom Policy, navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud
+    # @option opts [File] :input_file 
+    # @return [Array<(SpamDetectionAdvancedResponse, Fixnum, Hash)>] SpamDetectionAdvancedResponse data, response status code and response headers
+    def spam_detect_file_advanced_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpamDetectionApi.spam_detect_file_advanced_post ...'
+      end
+      # resource path
+      local_var_path = '/spam/detect/file/advanced'
+
+      # 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(['multipart/form-data'])
+      header_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
+      header_params[:'preprocessing'] = opts[:'preprocessing'] if !opts[:'preprocessing'].nil?
+      header_params[:'allowPhishing'] = opts[:'allow_phishing'] if !opts[:'allow_phishing'].nil?
+      header_params[:'allowUnsolicitedSales'] = opts[:'allow_unsolicited_sales'] if !opts[:'allow_unsolicited_sales'].nil?
+      header_params[:'allowPromotionalContent'] = opts[:'allow_promotional_content'] if !opts[:'allow_promotional_content'].nil?
+      header_params[:'customPolicyId'] = opts[:'custom_policy_id'] if !opts[:'custom_policy_id'].nil?
+
+      # form parameters
+      form_params = {}
+      form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
+
+      # http body (model)
+      post_body = nil
+      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 => 'SpamDetectionAdvancedResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpamDetectionApi#spam_detect_file_advanced_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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.  Supported file formats include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :model Model to use; default setting is Advanced (default to Advanced)
+    # @option opts [File] :input_file 
+    # @return [SpamDetectionResponse]
+    def spam_detect_file_post(opts = {})
+      data, _status_code, _headers = spam_detect_file_post_with_http_info(opts)
+      data
+    end
+
+    # 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.  Supported file formats include DOCX, PDF, XLSX, PPTX, EML, MSG, JPG, PNG and WEBP.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :model Model to use; default setting is Advanced
+    # @option opts [File] :input_file 
+    # @return [Array<(SpamDetectionResponse, Fixnum, Hash)>] SpamDetectionResponse data, response status code and response headers
+    def spam_detect_file_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpamDetectionApi.spam_detect_file_post ...'
+      end
+      # resource path
+      local_var_path = '/spam/detect/file'
+
+      # 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(['multipart/form-data'])
+      header_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
+
+      # form parameters
+      form_params = {}
+      form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
+
+      # http body (model)
+      post_body = nil
+      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_file_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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]
+    def spam_detect_form_submission_advanced_post(opts = {})
+      data, _status_code, _headers = spam_detect_form_submission_advanced_post_with_http_info(opts)
+      data
+    end
+
+    # 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 [Array<(SpamDetectionFormSubmissionAdvancedResponse, Fixnum, Hash)>] SpamDetectionFormSubmissionAdvancedResponse data, response status code and response headers
+    def spam_detect_form_submission_advanced_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpamDetectionApi.spam_detect_form_submission_advanced_post ...'
+      end
+      # resource path
+      local_var_path = '/spam/detect/form-submission/advanced'
+
+      # 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 => 'SpamDetectionFormSubmissionAdvancedResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SpamDetectionApi#spam_detect_form_submission_advanced_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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 Spam detection request
     # @return [SpamDetectionAdvancedResponse]
@@ -28,7 +202,8 @@ module CloudmersiveSpamDetectionApiClient
       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.
+    # 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 [Array<(SpamDetectionAdvancedResponse, Fixnum, Hash)>] SpamDetectionAdvancedResponse data, response status code and response headers
@@ -67,7 +242,8 @@ 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.
+    # 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]
@@ -76,7 +252,8 @@ module CloudmersiveSpamDetectionApiClient
       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.
+    # 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

data/lib/cloudmersive-spam-detection-api-client/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
 

data/lib/cloudmersive-spam-detection-api-client/api_error.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/configuration.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