cloudmersive-phishing-detection-api-client 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db228aa9d3ba68d5c357d0e2c18406b8a07d45ba975d5098edbf37db529f9c40
-  data.tar.gz: 5fc22a0c015282b5a962acd6572a9694e3c575abfef1db1037bda97f471f83a4
+  metadata.gz: 65747f90d512cab686795b33bc37eb8e7a0049da707291605d9069a31ce71e85
+  data.tar.gz: 948d142f3693b5b9587b90522b09f16177db24e5f016ce89dea97515c01d537e
 SHA512:
-  metadata.gz: 73acce08567c2ca1e0e5647a224a5d09c18d24ed65e1aef69b6889708879bf0f0a008a02f644ec3b7c597375eb0eb893fe0d14fb09d07fc4fba467a286867228
-  data.tar.gz: 652d44d39aa4a733742a5eb98be2069d4e979de5fa2cf8a26b073e5a1a750c73b6b900dccc4a3e9fbf6cd00b56f2efcd8cc3eba3e2bcb97f22c17e41f1c7b2e9
+  metadata.gz: 03d817eb09b2d9ea6b0a788fbfe62c256059a83a197059f028b8e21cf1c42f03bd493d1ebdb5706e102a2957da7d7eac5bb89ba3ce3b44bbeeade1f7b696ed5e
+  data.tar.gz: 8c2ba82aaa6976808eba44ba20c58196215e3f0983fd1b0787bdbad3e31cad25eb89b0ba5004194fd4f43e00c17dd9eacba22af142e0d569e1a4ea86ac4bae1a

data/README.md

@@ -2,12 +2,12 @@
 
 CloudmersivePhishingDetectionApiClient - the Ruby gem for the phishingapi
 
-Easily and directly scan and block phishing security threats.
+Easily and directly scan and block phishing 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.2.0
+- Package version: 2.2.1
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-phishing-detection-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-phishing-detection-api-client-2.2.0.gem
+gem install ./cloudmersive-phishing-detection-api-client-2.2.1.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-phishing-detection-api-client-2.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-phishing-detection-api-client-2.2.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-phishing-detection-api-client', '~> 2.2.0'
+    gem 'cloudmersive-phishing-detection-api-client', '~> 2.2.1'
 
 ### Install from Git
 
@@ -62,18 +62,18 @@ CloudmersivePhishingDetectionApiClient.configure do |config|
   #config.api_key_prefix['Apikey'] = 'Bearer'
 end
 
-api_instance = CloudmersivePhishingDetectionApiClient::PhishingUrlApi.new
+api_instance = CloudmersivePhishingDetectionApiClient::PhishingDetectionApi.new
 
 opts = { 
-  body: CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequest.new # PhishingUrlAdvancedRequest | 
+  body: CloudmersivePhishingDetectionApiClient::AdvancedEmailDetectionRequest.new # AdvancedEmailDetectionRequest | Phishing detection request
 }
 
 begin
-  #Use advanced AI detection to determine if a URL is a known phishing threat
-  result = api_instance.phishing_url_advanced_post(opts)
+  #Perform advanced AI phishing detection and classification against input email.  Analyzes input email as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+  result = api_instance.phishing_detect_email_advanced_post(opts)
   p result
 rescue CloudmersivePhishingDetectionApiClient::ApiError => e
-  puts "Exception when calling PhishingUrlApi->phishing_url_advanced_post: #{e}"
+  puts "Exception when calling PhishingDetectionApi->phishing_detect_email_advanced_post: #{e}"
 end
 
 ```
@@ -84,21 +84,19 @@ All URIs are relative to *https://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*CloudmersivePhishingDetectionApiClient::PhishingUrlApi* | [**phishing_url_advanced_post**](docs/PhishingUrlApi.md#phishing_url_advanced_post) | **POST** /phishing/url/advanced | Use advanced AI detection to determine if a URL is a known phishing threat
-*CloudmersivePhishingDetectionApiClient::PhishingUrlApi* | [**phishing_url_post**](docs/PhishingUrlApi.md#phishing_url_post) | **POST** /phishing/url | Use AI and deterministic detection to determine if a URL is a phishing threat
-*CloudmersivePhishingDetectionApiClient::PhishingUrlBatchApi* | [**phishing_url_advanced_batch_post**](docs/PhishingUrlBatchApi.md#phishing_url_advanced_batch_post) | **POST** /phishing/url/advanced/batch | Accept multiple urls at once to perform lookups to see if the urls are known phishing sites as well as multiple other scans to determine  if the URL is a potential phishing threat.
-*CloudmersivePhishingDetectionApiClient::PhishingUrlBatchApi* | [**phishing_url_batch_post**](docs/PhishingUrlBatchApi.md#phishing_url_batch_post) | **POST** /phishing/url/batch | Accept multiple urls at oncee and perform AI and deterministic methods to detect if a URL is a phishing threat.
+*CloudmersivePhishingDetectionApiClient::PhishingDetectionApi* | [**phishing_detect_email_advanced_post**](docs/PhishingDetectionApi.md#phishing_detect_email_advanced_post) | **POST** /phishing/detect/email/advanced | Perform advanced AI phishing detection and classification against input email.  Analyzes input email as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+*CloudmersivePhishingDetectionApiClient::PhishingDetectionApi* | [**phishing_detect_file_advanced_post**](docs/PhishingDetectionApi.md#phishing_detect_file_advanced_post) | **POST** /phishing/detect/file/advanced | Perform advanced AI phishing detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+*CloudmersivePhishingDetectionApiClient::PhishingDetectionApi* | [**phishing_detect_file_post**](docs/PhishingDetectionApi.md#phishing_detect_file_post) | **POST** /phishing/detect/file | Perform AI phishing 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 phishing and other unsafe content.  Uses 100-125 API calls depending on model selected.
+*CloudmersivePhishingDetectionApiClient::PhishingDetectionApi* | [**phishing_detect_text_string_advanced_post**](docs/PhishingDetectionApi.md#phishing_detect_text_string_advanced_post) | **POST** /phishing/detect/text-string/advanced | Perform advanced AI phishing 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.
 
 
 ## Documentation for Models
 
- - [CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequest](docs/PhishingUrlAdvancedRequest.md)
- - [CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequestBatch](docs/PhishingUrlAdvancedRequestBatch.md)
- - [CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedResponse](docs/PhishingUrlAdvancedResponse.md)
- - [CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedResponseBatch](docs/PhishingUrlAdvancedResponseBatch.md)
- - [CloudmersivePhishingDetectionApiClient::PhishingUrlRequest](docs/PhishingUrlRequest.md)
- - [CloudmersivePhishingDetectionApiClient::PhishingUrlResponse](docs/PhishingUrlResponse.md)
- - [CloudmersivePhishingDetectionApiClient::PhishingUrlResponseBatch](docs/PhishingUrlResponseBatch.md)
+ - [CloudmersivePhishingDetectionApiClient::AdvancedEmailDetectionRequest](docs/AdvancedEmailDetectionRequest.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionAdvancedRequest](docs/PhishingDetectionAdvancedRequest.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionAdvancedResponse](docs/PhishingDetectionAdvancedResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionEmailAdvancedResponse](docs/PhishingDetectionEmailAdvancedResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionResponse](docs/PhishingDetectionResponse.md)
 
 
 ## Documentation for Authorization

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

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

data/docs/AdvancedEmailDetectionRequest.md

@@ -0,0 +1,14 @@
+# CloudmersivePhishingDetectionApiClient::AdvancedEmailDetectionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from_email_address** | **String** | Email address of the sender | [optional] 
+**to_email_address** | **String** | Email address of the recipient | [optional] 
+**subject** | **String** | Subject of the email | [optional] 
+**html_body** | **String** | Body of the email in HTML, or text | [optional] 
+**allow_low_reputation_senders** | **BOOLEAN** | Allow email from low reputation senders and domains | [optional] 
+**allow_sanctioned** | **BOOLEAN** | True to allow sanctioned countries and certain known sanctioned entities, false otherwise (default) | [optional] 
+**input_email_file** | **String** |  | [optional] 
+
+

data/docs/PhishingDetectionAdvancedRequest.md

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

data/docs/PhishingDetectionAdvancedResponse.md

@@ -0,0 +1,10 @@
+# CloudmersivePhishingDetectionApiClient::PhishingDetectionAdvancedResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_result** | **BOOLEAN** | True if the result is not phishing (clean), and false otherwise | [optional] 
+**phishing_risk_level** | **Float** | Overall phishing risk level between 0.0 and 1.0 | [optional] 
+**analysis_rationale** | **String** | Rationale for why the conclusion was formed | [optional] 
+
+

data/docs/PhishingDetectionApi.md

@@ -0,0 +1,228 @@
+# CloudmersivePhishingDetectionApiClient::PhishingDetectionApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**phishing_detect_email_advanced_post**](PhishingDetectionApi.md#phishing_detect_email_advanced_post) | **POST** /phishing/detect/email/advanced | Perform advanced AI phishing detection and classification against input email.  Analyzes input email as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+[**phishing_detect_file_advanced_post**](PhishingDetectionApi.md#phishing_detect_file_advanced_post) | **POST** /phishing/detect/file/advanced | Perform advanced AI phishing detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+[**phishing_detect_file_post**](PhishingDetectionApi.md#phishing_detect_file_post) | **POST** /phishing/detect/file | Perform AI phishing 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 phishing and other unsafe content.  Uses 100-125 API calls depending on model selected.
+[**phishing_detect_text_string_advanced_post**](PhishingDetectionApi.md#phishing_detect_text_string_advanced_post) | **POST** /phishing/detect/text-string/advanced | Perform advanced AI phishing 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.
+
+
+# **phishing_detect_email_advanced_post**
+> PhishingDetectionEmailAdvancedResponse phishing_detect_email_advanced_post(opts)
+
+Perform advanced AI phishing detection and classification against input email.  Analyzes input email as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-phishing-detection-api-client'
+# setup authorization
+CloudmersivePhishingDetectionApiClient.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 = CloudmersivePhishingDetectionApiClient::PhishingDetectionApi.new
+
+opts = { 
+  body: CloudmersivePhishingDetectionApiClient::AdvancedEmailDetectionRequest.new # AdvancedEmailDetectionRequest | Phishing detection request
+}
+
+begin
+  #Perform advanced AI phishing detection and classification against input email.  Analyzes input email as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+  result = api_instance.phishing_detect_email_advanced_post(opts)
+  p result
+rescue CloudmersivePhishingDetectionApiClient::ApiError => e
+  puts "Exception when calling PhishingDetectionApi->phishing_detect_email_advanced_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AdvancedEmailDetectionRequest**](AdvancedEmailDetectionRequest.md)| Phishing detection request | [optional] 
+
+### Return type
+
+[**PhishingDetectionEmailAdvancedResponse**](PhishingDetectionEmailAdvancedResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **phishing_detect_file_advanced_post**
+> PhishingDetectionAdvancedResponse phishing_detect_file_advanced_post(opts)
+
+Perform advanced AI phishing detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-phishing-detection-api-client'
+# setup authorization
+CloudmersivePhishingDetectionApiClient.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 = CloudmersivePhishingDetectionApiClient::PhishingDetectionApi.new
+
+opts = { 
+  model: 'Advanced', # String | 
+  input_file: File.new('/path/to/file.txt') # File | 
+}
+
+begin
+  #Perform advanced AI phishing detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+  result = api_instance.phishing_detect_file_advanced_post(opts)
+  p result
+rescue CloudmersivePhishingDetectionApiClient::ApiError => e
+  puts "Exception when calling PhishingDetectionApi->phishing_detect_file_advanced_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **model** | **String**|  | [optional] [default to Advanced]
+ **input_file** | **File**|  | [optional] 
+
+### Return type
+
+[**PhishingDetectionAdvancedResponse**](PhishingDetectionAdvancedResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **phishing_detect_file_post**
+> PhishingDetectionResponse phishing_detect_file_post(opts)
+
+Perform AI phishing 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 phishing and other unsafe content.  Uses 100-125 API calls depending on model selected.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-phishing-detection-api-client'
+# setup authorization
+CloudmersivePhishingDetectionApiClient.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 = CloudmersivePhishingDetectionApiClient::PhishingDetectionApi.new
+
+opts = { 
+  model: 'Advanced', # String | Model to use; default setting is Advanced
+  input_file: File.new('/path/to/file.txt') # File | 
+}
+
+begin
+  #Perform AI phishing 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 phishing and other unsafe content.  Uses 100-125 API calls depending on model selected.
+  result = api_instance.phishing_detect_file_post(opts)
+  p result
+rescue CloudmersivePhishingDetectionApiClient::ApiError => e
+  puts "Exception when calling PhishingDetectionApi->phishing_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
+
+[**PhishingDetectionResponse**](PhishingDetectionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **phishing_detect_text_string_advanced_post**
+> PhishingDetectionAdvancedResponse phishing_detect_text_string_advanced_post(opts)
+
+Perform advanced AI phishing 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
+# load the gem
+require 'cloudmersive-phishing-detection-api-client'
+# setup authorization
+CloudmersivePhishingDetectionApiClient.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 = CloudmersivePhishingDetectionApiClient::PhishingDetectionApi.new
+
+opts = { 
+  body: CloudmersivePhishingDetectionApiClient::PhishingDetectionAdvancedRequest.new # PhishingDetectionAdvancedRequest | Phishing detection request
+}
+
+begin
+  #Perform advanced AI phishing 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.phishing_detect_text_string_advanced_post(opts)
+  p result
+rescue CloudmersivePhishingDetectionApiClient::ApiError => e
+  puts "Exception when calling PhishingDetectionApi->phishing_detect_text_string_advanced_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**PhishingDetectionAdvancedRequest**](PhishingDetectionAdvancedRequest.md)| Phishing detection request | [optional] 
+
+### Return type
+
+[**PhishingDetectionAdvancedResponse**](PhishingDetectionAdvancedResponse.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/PhishingDetectionEmailAdvancedResponse.md

@@ -0,0 +1,17 @@
+# CloudmersivePhishingDetectionApiClient::PhishingDetectionEmailAdvancedResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_result** | **BOOLEAN** | True if the result is not phishing (clean), and false otherwise | [optional] 
+**phishing_risk_level** | **Float** | Overall phishing risk level between 0.0 and 1.0 | [optional] 
+**spam_risk_level** | **Float** | Overall phishing spam level between 0.0 and 1.0 | [optional] 
+**contains_low_reputation_sender** | **BOOLEAN** | True if the input email is from a low reputation sender | [optional] 
+**contains_phishing** | **BOOLEAN** | True if the input email contains phishing threat risks, false otherwise | [optional] 
+**contains_spam** | **BOOLEAN** | True if the email contains phishing threat risks, false otherwise | [optional] 
+**contains_unsolicited_sales** | **BOOLEAN** | True if the input email contains unsolicited sales, false otherwise | [optional] 
+**contains_promotional_content** | **BOOLEAN** | True if the input email contains promotional content, false otherwise | [optional] 
+**contains_phishing_attempt** | **BOOLEAN** | True if the input email contains a phishing attempt, false otherwise | [optional] 
+**analysis_rationale** | **String** | Rationale for why the conclusion was formed | [optional] 
+
+

data/docs/PhishingDetectionResponse.md

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

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

@@ -0,0 +1,223 @@
+=begin
+#phishingapi
+
+#Easily and directly scan and block phishing security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersivePhishingDetectionApiClient
+  class PhishingDetectionApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Perform advanced AI phishing detection and classification against input email.  Analyzes input email as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+    # @param [Hash] opts the optional parameters
+    # @option opts [AdvancedEmailDetectionRequest] :body Phishing detection request
+    # @return [PhishingDetectionEmailAdvancedResponse]
+    def phishing_detect_email_advanced_post(opts = {})
+      data, _status_code, _headers = phishing_detect_email_advanced_post_with_http_info(opts)
+      data
+    end
+
+    # Perform advanced AI phishing detection and classification against input email.  Analyzes input email as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+    # @param [Hash] opts the optional parameters
+    # @option opts [AdvancedEmailDetectionRequest] :body Phishing detection request
+    # @return [Array<(PhishingDetectionEmailAdvancedResponse, Fixnum, Hash)>] PhishingDetectionEmailAdvancedResponse data, response status code and response headers
+    def phishing_detect_email_advanced_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhishingDetectionApi.phishing_detect_email_advanced_post ...'
+      end
+      # resource path
+      local_var_path = '/phishing/detect/email/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 => 'PhishingDetectionEmailAdvancedResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhishingDetectionApi#phishing_detect_email_advanced_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Perform advanced AI phishing detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :model  (default to Advanced)
+    # @option opts [File] :input_file 
+    # @return [PhishingDetectionAdvancedResponse]
+    def phishing_detect_file_advanced_post(opts = {})
+      data, _status_code, _headers = phishing_detect_file_advanced_post_with_http_info(opts)
+      data
+    end
+
+    # Perform advanced AI phishing detection and classification against input text string.  Analyzes input content as well as embedded URLs with AI deep learning to detect phishing, phishing and other unsafe content.  Uses 25-100 API calls depending on model selected.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :model 
+    # @option opts [File] :input_file 
+    # @return [Array<(PhishingDetectionAdvancedResponse, Fixnum, Hash)>] PhishingDetectionAdvancedResponse data, response status code and response headers
+    def phishing_detect_file_advanced_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhishingDetectionApi.phishing_detect_file_advanced_post ...'
+      end
+      # resource path
+      local_var_path = '/phishing/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?
+
+      # 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 => 'PhishingDetectionAdvancedResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhishingDetectionApi#phishing_detect_file_advanced_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Perform AI phishing 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 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 (default to Advanced)
+    # @option opts [File] :input_file 
+    # @return [PhishingDetectionResponse]
+    def phishing_detect_file_post(opts = {})
+      data, _status_code, _headers = phishing_detect_file_post_with_http_info(opts)
+      data
+    end
+
+    # Perform AI phishing 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 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 [Array<(PhishingDetectionResponse, Fixnum, Hash)>] PhishingDetectionResponse data, response status code and response headers
+    def phishing_detect_file_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhishingDetectionApi.phishing_detect_file_post ...'
+      end
+      # resource path
+      local_var_path = '/phishing/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 => 'PhishingDetectionResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhishingDetectionApi#phishing_detect_file_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Perform advanced AI phishing 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 [PhishingDetectionAdvancedRequest] :body Phishing detection request
+    # @return [PhishingDetectionAdvancedResponse]
+    def phishing_detect_text_string_advanced_post(opts = {})
+      data, _status_code, _headers = phishing_detect_text_string_advanced_post_with_http_info(opts)
+      data
+    end
+
+    # Perform advanced AI phishing 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 [PhishingDetectionAdvancedRequest] :body Phishing detection request
+    # @return [Array<(PhishingDetectionAdvancedResponse, Fixnum, Hash)>] PhishingDetectionAdvancedResponse data, response status code and response headers
+    def phishing_detect_text_string_advanced_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhishingDetectionApi.phishing_detect_text_string_advanced_post ...'
+      end
+      # resource path
+      local_var_path = '/phishing/detect/text-string/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 => 'PhishingDetectionAdvancedResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhishingDetectionApi#phishing_detect_text_string_advanced_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

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

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

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