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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db228aa9d3ba68d5c357d0e2c18406b8a07d45ba975d5098edbf37db529f9c40
-  data.tar.gz: 5fc22a0c015282b5a962acd6572a9694e3c575abfef1db1037bda97f471f83a4
+  metadata.gz: d09cb2566e6ef13fd750ea52942b7683cbbd4da4607681fb3f03e37e871f0b89
+  data.tar.gz: f0686bd696fc9b3e8233cbb89e008c875f214fd9e3f9f16f874b84c167667979
 SHA512:
-  metadata.gz: 73acce08567c2ca1e0e5647a224a5d09c18d24ed65e1aef69b6889708879bf0f0a008a02f644ec3b7c597375eb0eb893fe0d14fb09d07fc4fba467a286867228
-  data.tar.gz: 652d44d39aa4a733742a5eb98be2069d4e979de5fa2cf8a26b073e5a1a750c73b6b900dccc4a3e9fbf6cd00b56f2efcd8cc3eba3e2bcb97f22c17e41f1c7b2e9
+  metadata.gz: b5f0975e3527703e05ef19efbe872dfb58ee8ae48f56a75adae5b8640e9ce5339d27b2e472c8f1d9033851a8d929ebb92d2626532961900595ec647a319c1a9e
+  data.tar.gz: 2aa1472249ba3fb4ece7666304239ceeeecae553daacb98c8951e1c9d21b82dd1061772ba124c5a3099c01d6fb6b3f178927fc36e3380ce207e88e16d0a75b7e

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.2
 - 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.2.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.2.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.2'
 
 ### 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,22 @@ 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.
+*CloudmersivePhishingDetectionApiClient::PhishingDetectionApi* | [**phishing_detect_url_advanced_post**](docs/PhishingDetectionApi.md#phishing_detect_url_advanced_post) | **POST** /phishing/detect/url/advanced | Perform advanced AI phishing detection and classification against an input URL.  Retrieves the URL content, checks for SSRF threats, and analyzes the page with AI deep learning to detect phishing and other unsafe content.  Uses 100-125 API calls.
 
 
 ## 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::AdvancedUrlDetectionRequest](docs/AdvancedUrlDetectionRequest.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionAdvancedRequest](docs/PhishingDetectionAdvancedRequest.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionAdvancedResponse](docs/PhishingDetectionAdvancedResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionEmailAdvancedResponse](docs/PhishingDetectionEmailAdvancedResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionResponse](docs/PhishingDetectionResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionUrlAdvancedResponse](docs/PhishingDetectionUrlAdvancedResponse.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,15 @@
+# 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] 
+**custom_policy_id** | **String** | Apply a Custom Policy for Phishing 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_email_file** | **String** | Optional: Input email file bytes (EML, PDF, etc.).  If not provided, HtmlBody will be used instead. | [optional] 
+
+

data/docs/AdvancedUrlDetectionRequest.md

@@ -0,0 +1,9 @@
+# CloudmersivePhishingDetectionApiClient::AdvancedUrlDetectionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL to check for phishing | [optional] 
+**custom_policy_id** | **String** | Apply a Custom Policy for Phishing 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/PhishingDetectionAdvancedRequest.md

@@ -0,0 +1,18 @@
+# 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] 
+**custom_policy_id** | **String** | Apply a Custom Policy for Phishing 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] 
+**provide_analysis_rationale** | **BOOLEAN** | Optional: Set to true to include an analysis rationale in the response explaining why the content was or was not flagged.  Default is true. | [optional] 
+**text_type** | **String** | Optional: Type of text being analyzed. Must be one of: \"Text Message\", \"User Message\", \"Sales Lead\", \"Email Message\", \"Support Case\", \"Other\". | [optional] 
+**from_name** | **String** | Optional: Name of the sender | [optional] 
+**to_name** | **String** | Optional: Name of the recipient | [optional] 
+**from_phone_number** | **String** | Optional: Phone number of the sender | [optional] 
+**to_phone_number** | **String** | Optional: Phone number of the recipient | [optional] 
+**from_email_address** | **String** | Optional: Email address of the sender | [optional] 
+**to_email_address** | **String** | Optional: Email address of the recipient | [optional] 
+
+

data/docs/PhishingDetectionAdvancedResponse.md

@@ -0,0 +1,11 @@
+# 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] 
+**confidence_level** | **Float** | Confidence level between 0.0 and 1.0 where values over 0.9 indicate high confidence | [optional] 
+**analysis_rationale** | **String** | Rationale for why the conclusion was formed | [optional] 
+
+

data/docs/PhishingDetectionApi.md

@@ -0,0 +1,284 @@
+# 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_url_advanced_post**](PhishingDetectionApi.md#phishing_detect_url_advanced_post) | **POST** /phishing/detect/url/advanced | Perform advanced AI phishing detection and classification against an input URL.  Retrieves the URL content, checks for SSRF threats, and analyzes the page with AI deep learning to detect phishing and other unsafe content.  Uses 100-125 API calls.
+
+
+# **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 | 
+  custom_policy_id: 'custom_policy_id_example', # 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]
+ **custom_policy_id** | **String**|  | [optional] 
+ **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
+
+
+
+# **phishing_detect_url_advanced_post**
+> PhishingDetectionUrlAdvancedResponse phishing_detect_url_advanced_post(opts)
+
+Perform advanced AI phishing detection and classification against an input URL.  Retrieves the URL content, checks for SSRF threats, and analyzes the page with AI deep learning to detect phishing and other unsafe content.  Uses 100-125 API calls.
+
+### 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::AdvancedUrlDetectionRequest.new # AdvancedUrlDetectionRequest | URL phishing detection request
+}
+
+begin
+  #Perform advanced AI phishing detection and classification against an input URL.  Retrieves the URL content, checks for SSRF threats, and analyzes the page with AI deep learning to detect phishing and other unsafe content.  Uses 100-125 API calls.
+  result = api_instance.phishing_detect_url_advanced_post(opts)
+  p result
+rescue CloudmersivePhishingDetectionApiClient::ApiError => e
+  puts "Exception when calling PhishingDetectionApi->phishing_detect_url_advanced_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AdvancedUrlDetectionRequest**](AdvancedUrlDetectionRequest.md)| URL phishing detection request | [optional] 
+
+### Return type
+
+[**PhishingDetectionUrlAdvancedResponse**](PhishingDetectionUrlAdvancedResponse.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/docs/PhishingDetectionUrlAdvancedResponse.md

@@ -0,0 +1,15 @@
+# CloudmersivePhishingDetectionApiClient::PhishingDetectionUrlAdvancedResponse
+
+## 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] 
+**is_ssrf_threat** | **BOOLEAN** | True if the URL is an SSRF threat | [optional] 
+**contains_phishing** | **BOOLEAN** | True if the URL contains phishing threat risks, false otherwise | [optional] 
+**contains_unsolicited_sales** | **BOOLEAN** | True if the URL contains unsolicited sales, false otherwise | [optional] 
+**contains_promotional_content** | **BOOLEAN** | True if the URL contains promotional content, false otherwise | [optional] 
+**contains_phishing_attempt** | **BOOLEAN** | True if the URL contains a phishing attempt, false otherwise | [optional] 
+**analysis_rationale** | **String** | Rationale for why the conclusion was formed | [optional] 
+
+