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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d09cb2566e6ef13fd750ea52942b7683cbbd4da4607681fb3f03e37e871f0b89
-  data.tar.gz: f0686bd696fc9b3e8233cbb89e008c875f214fd9e3f9f16f874b84c167667979
+  metadata.gz: '0914deac554fb10ebcb51c0ccbfb8f6fd883811dad78e9722e9da05e8e098dee'
+  data.tar.gz: bb85570269976f3d0675d4f8617854ccb667b314f95a0e9adac3a6ebbe0818fd
 SHA512:
-  metadata.gz: b5f0975e3527703e05ef19efbe872dfb58ee8ae48f56a75adae5b8640e9ce5339d27b2e472c8f1d9033851a8d929ebb92d2626532961900595ec647a319c1a9e
-  data.tar.gz: 2aa1472249ba3fb4ece7666304239ceeeecae553daacb98c8951e1c9d21b82dd1061772ba124c5a3099c01d6fb6b3f178927fc36e3380ce207e88e16d0a75b7e
+  metadata.gz: 152942bf4642a422f14390985b0cb60995f7925bd6796423c27e339fa35ba7fdecffc024d46e28ab001594a9f478e553cabee2f241d094fe1b352a3ac18e035a
+  data.tar.gz: c5ff1a5cb28235ecdbb45bd09b2b0ce57c3f246b78a8f3b85e4965d608a0f6a55084965121acf807bfb6b8cc06d0d19ab626ed24b4459b01bde122de2ccef783

data/README.md

@@ -7,7 +7,7 @@ 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.2
+- Package version: 2.2.3
 - 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.2.gem
+gem install ./cloudmersive-phishing-detection-api-client-2.2.3.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-phishing-detection-api-client-2.2.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-phishing-detection-api-client-2.2.3.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.2'
+    gem 'cloudmersive-phishing-detection-api-client', '~> 2.2.3'
 
 ### Install from Git
 
@@ -88,6 +88,7 @@ Class | Method | HTTP request | Description
 *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_text_string_post**](docs/PhishingDetectionApi.md#phishing_detect_text_string_post) | **POST** /phishing/detect/text-string | Perform AI phishing detection against input text string.  Returns a clean/not-clean result with confidence level and optional rationale.
 *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.
 
 
@@ -99,7 +100,10 @@ Class | Method | HTTP request | Description
  - [CloudmersivePhishingDetectionApiClient::PhishingDetectionAdvancedResponse](docs/PhishingDetectionAdvancedResponse.md)
  - [CloudmersivePhishingDetectionApiClient::PhishingDetectionEmailAdvancedResponse](docs/PhishingDetectionEmailAdvancedResponse.md)
  - [CloudmersivePhishingDetectionApiClient::PhishingDetectionResponse](docs/PhishingDetectionResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringRequest](docs/PhishingDetectionTextStringRequest.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringResponse](docs/PhishingDetectionTextStringResponse.md)
  - [CloudmersivePhishingDetectionApiClient::PhishingDetectionUrlAdvancedResponse](docs/PhishingDetectionUrlAdvancedResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::UnsafeUrlResult](docs/UnsafeUrlResult.md)
 
 
 ## Documentation for Authorization

data/docs/PhishingDetectionAdvancedRequest.md

@@ -4,10 +4,16 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **input_string** | **String** | Input text string to detect phishing against | [optional] 
+**text_type** | **String** | Optional: Type of text being analyzed. Must be one of: \"TextMessage\", \"UserMessage\", \"SalesLead\", \"EmailMessage\", \"SupportCase\", \"AppMessage\", \"Other\". | [optional] 
 **model** | **String** | Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced. | [optional] 
+**allow_unsolicited_sales** | **BOOLEAN** | Optional: True if unsolicited sales should be allowed, false otherwise. Defaults to true. | [optional] 
+**allow_promotional_content** | **BOOLEAN** | Optional: True if promotional content should be allowed, false otherwise. Defaults to true. | [optional] 
+**allow_web_urls** | **BOOLEAN** | Optional: True if web URLs should be allowed in the input text, false otherwise. Defaults to true. When false, input containing URLs (including homoglyph URLs and spaced-out URLs) will be flagged as not clean. | [optional] 
+**allow_phone_numbers** | **BOOLEAN** | Optional: True if phone numbers should be allowed in the input text, false otherwise. Defaults to true. When false, input containing phone numbers (including homoglyph digits and spaced-out or spelled-out workarounds) will be flagged as not clean. | [optional] 
+**allow_email_addresses** | **BOOLEAN** | Optional: True if email addresses should be allowed in the input text, false otherwise. Defaults to true. When false, input containing email addresses (including homoglyph characters and obfuscated workarounds like \"danny at somedomaine [DOT] com\") will be flagged as not clean. | [optional] 
+**provide_url_analysis** | **BOOLEAN** | Optional: True to perform deep URL analysis on any URLs detected in the text. When enabled, if the initial AI scan detects URLs, a second AI call enumerates them and each URL is individually analyzed for phishing. Defaults to true. | [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] 

data/docs/PhishingDetectionAdvancedResponse.md

@@ -4,8 +4,14 @@
 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] 
+**contains_phishing** | **BOOLEAN** | True if the input text contains a phishing attempt, 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_web_urls** | **BOOLEAN** | True if the input text contains web URLs, including homoglyph URLs and spaced-out URL workarounds | [optional] 
+**contains_phone_numbers** | **BOOLEAN** | True if the input text contains phone numbers, including homoglyph digits and spaced-out or spelled-out workarounds | [optional] 
+**contains_email_addresses** | **BOOLEAN** | True if the input text contains email addresses, including homoglyph characters and obfuscated workarounds | [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] 
+**unsafe_urls** | [**Array<UnsafeUrlResult>**](UnsafeUrlResult.md) | URLs detected in the input text that were analyzed and found to be unsafe. Only populated when ProvideUrlAnalysis is true and URLs are detected. | [optional] 
 
 

data/docs/PhishingDetectionApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**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_text_string_post**](PhishingDetectionApi.md#phishing_detect_text_string_post) | **POST** /phishing/detect/text-string | Perform AI phishing detection against input text string.  Returns a clean/not-clean result with confidence level and optional rationale.
 [**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.
 
 
@@ -229,6 +230,59 @@ Name | Type | Description  | Notes
 
 
 
+# **phishing_detect_text_string_post**
+> PhishingDetectionTextStringResponse phishing_detect_text_string_post(opts)
+
+Perform AI phishing detection against input text string.  Returns a clean/not-clean result with confidence level and optional rationale.
+
+### 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::PhishingDetectionTextStringRequest.new # PhishingDetectionTextStringRequest | Phishing detection request
+}
+
+begin
+  #Perform AI phishing detection against input text string.  Returns a clean/not-clean result with confidence level and optional rationale.
+  result = api_instance.phishing_detect_text_string_post(opts)
+  p result
+rescue CloudmersivePhishingDetectionApiClient::ApiError => e
+  puts "Exception when calling PhishingDetectionApi->phishing_detect_text_string_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**PhishingDetectionTextStringRequest**](PhishingDetectionTextStringRequest.md)| Phishing detection request | [optional] 
+
+### Return type
+
+[**PhishingDetectionTextStringResponse**](PhishingDetectionTextStringResponse.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)
 

data/docs/PhishingDetectionTextStringRequest.md

@@ -0,0 +1,10 @@
+# CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringRequest
+
+## 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] 
+**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] 
+
+

data/docs/PhishingDetectionTextStringResponse.md

@@ -0,0 +1,10 @@
+# CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_result** | **BOOLEAN** | True if the result is not phishing (clean), and false otherwise | [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/UnsafeUrlResult.md

@@ -0,0 +1,12 @@
+# CloudmersivePhishingDetectionApiClient::UnsafeUrlResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | The URL that was detected and analyzed | [optional] 
+**clean_result** | **BOOLEAN** | True if the result is not phishing (clean), and false otherwise | [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_phishing_attempt** | **BOOLEAN** | True if the URL contains a phishing attempt, false otherwise | [optional] 
+
+

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

@@ -222,6 +222,54 @@ module CloudmersivePhishingDetectionApiClient
       end
       return data, status_code, headers
     end
+    # Perform AI phishing detection against input text string.  Returns a clean/not-clean result with confidence level and optional rationale.
+    # @param [Hash] opts the optional parameters
+    # @option opts [PhishingDetectionTextStringRequest] :body Phishing detection request
+    # @return [PhishingDetectionTextStringResponse]
+    def phishing_detect_text_string_post(opts = {})
+      data, _status_code, _headers = phishing_detect_text_string_post_with_http_info(opts)
+      data
+    end
+
+    # Perform AI phishing detection against input text string.  Returns a clean/not-clean result with confidence level and optional rationale.
+    # @param [Hash] opts the optional parameters
+    # @option opts [PhishingDetectionTextStringRequest] :body Phishing detection request
+    # @return [Array<(PhishingDetectionTextStringResponse, Fixnum, Hash)>] PhishingDetectionTextStringResponse data, response status code and response headers
+    def phishing_detect_text_string_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhishingDetectionApi.phishing_detect_text_string_post ...'
+      end
+      # resource path
+      local_var_path = '/phishing/detect/text-string'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'body'])
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PhishingDetectionTextStringResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhishingDetectionApi#phishing_detect_text_string_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 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.
     # @param [Hash] opts the optional parameters
     # @option opts [AdvancedUrlDetectionRequest] :body URL phishing detection request

data/lib/cloudmersive-phishing-detection-api-client/models/phishing_detection_advanced_request.rb

@@ -18,18 +18,36 @@ module CloudmersivePhishingDetectionApiClient
     # Input text string to detect phishing against
     attr_accessor :input_string
 
+    # Optional: Type of text being analyzed. Must be one of: \"TextMessage\", \"UserMessage\", \"SalesLead\", \"EmailMessage\", \"SupportCase\", \"AppMessage\", \"Other\".
+    attr_accessor :text_type
+
     # Optional: Specify which AI model to use.  Possible choices are Normal and Advanced.  Default is Advanced.
     attr_accessor :model
 
+    # Optional: True if unsolicited sales should be allowed, false otherwise. Defaults to true.
+    attr_accessor :allow_unsolicited_sales
+
+    # Optional: True if promotional content should be allowed, false otherwise. Defaults to true.
+    attr_accessor :allow_promotional_content
+
+    # Optional: True if web URLs should be allowed in the input text, false otherwise. Defaults to true. When false, input containing URLs (including homoglyph URLs and spaced-out URLs) will be flagged as not clean.
+    attr_accessor :allow_web_urls
+
+    # Optional: True if phone numbers should be allowed in the input text, false otherwise. Defaults to true. When false, input containing phone numbers (including homoglyph digits and spaced-out or spelled-out workarounds) will be flagged as not clean.
+    attr_accessor :allow_phone_numbers
+
+    # Optional: True if email addresses should be allowed in the input text, false otherwise. Defaults to true. When false, input containing email addresses (including homoglyph characters and obfuscated workarounds like \"danny at somedomaine [DOT] com\") will be flagged as not clean.
+    attr_accessor :allow_email_addresses
+
+    # Optional: True to perform deep URL analysis on any URLs detected in the text. When enabled, if the initial AI scan detects URLs, a second AI call enumerates them and each URL is individually analyzed for phishing. Defaults to true.
+    attr_accessor :provide_url_analysis
+
     # 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
     attr_accessor :custom_policy_id
 
     # Optional: Set to true to include an analysis rationale in the response explaining why the content was or was not flagged.  Default is true.
     attr_accessor :provide_analysis_rationale
 
-    # Optional: Type of text being analyzed. Must be one of: \"Text Message\", \"User Message\", \"Sales Lead\", \"Email Message\", \"Support Case\", \"Other\".
-    attr_accessor :text_type
-
     # Optional: Name of the sender
     attr_accessor :from_name
 
@@ -52,10 +70,16 @@ module CloudmersivePhishingDetectionApiClient
     def self.attribute_map
       {
         :'input_string' => :'InputString',
+        :'text_type' => :'TextType',
         :'model' => :'Model',
+        :'allow_unsolicited_sales' => :'AllowUnsolicitedSales',
+        :'allow_promotional_content' => :'AllowPromotionalContent',
+        :'allow_web_urls' => :'AllowWebUrls',
+        :'allow_phone_numbers' => :'AllowPhoneNumbers',
+        :'allow_email_addresses' => :'AllowEmailAddresses',
+        :'provide_url_analysis' => :'ProvideUrlAnalysis',
         :'custom_policy_id' => :'CustomPolicyID',
         :'provide_analysis_rationale' => :'ProvideAnalysisRationale',
-        :'text_type' => :'TextType',
         :'from_name' => :'FromName',
         :'to_name' => :'ToName',
         :'from_phone_number' => :'FromPhoneNumber',
@@ -69,10 +93,16 @@ module CloudmersivePhishingDetectionApiClient
     def self.swagger_types
       {
         :'input_string' => :'String',
+        :'text_type' => :'String',
         :'model' => :'String',
+        :'allow_unsolicited_sales' => :'BOOLEAN',
+        :'allow_promotional_content' => :'BOOLEAN',
+        :'allow_web_urls' => :'BOOLEAN',
+        :'allow_phone_numbers' => :'BOOLEAN',
+        :'allow_email_addresses' => :'BOOLEAN',
+        :'provide_url_analysis' => :'BOOLEAN',
         :'custom_policy_id' => :'String',
         :'provide_analysis_rationale' => :'BOOLEAN',
-        :'text_type' => :'String',
         :'from_name' => :'String',
         :'to_name' => :'String',
         :'from_phone_number' => :'String',
@@ -94,10 +124,38 @@ module CloudmersivePhishingDetectionApiClient
         self.input_string = attributes[:'InputString']
       end
 
+      if attributes.has_key?(:'TextType')
+        self.text_type = attributes[:'TextType']
+      end
+
       if attributes.has_key?(:'Model')
         self.model = attributes[:'Model']
       end
 
+      if attributes.has_key?(:'AllowUnsolicitedSales')
+        self.allow_unsolicited_sales = attributes[:'AllowUnsolicitedSales']
+      end
+
+      if attributes.has_key?(:'AllowPromotionalContent')
+        self.allow_promotional_content = attributes[:'AllowPromotionalContent']
+      end
+
+      if attributes.has_key?(:'AllowWebUrls')
+        self.allow_web_urls = attributes[:'AllowWebUrls']
+      end
+
+      if attributes.has_key?(:'AllowPhoneNumbers')
+        self.allow_phone_numbers = attributes[:'AllowPhoneNumbers']
+      end
+
+      if attributes.has_key?(:'AllowEmailAddresses')
+        self.allow_email_addresses = attributes[:'AllowEmailAddresses']
+      end
+
+      if attributes.has_key?(:'ProvideUrlAnalysis')
+        self.provide_url_analysis = attributes[:'ProvideUrlAnalysis']
+      end
+
       if attributes.has_key?(:'CustomPolicyID')
         self.custom_policy_id = attributes[:'CustomPolicyID']
       end
@@ -106,10 +164,6 @@ module CloudmersivePhishingDetectionApiClient
         self.provide_analysis_rationale = attributes[:'ProvideAnalysisRationale']
       end
 
-      if attributes.has_key?(:'TextType')
-        self.text_type = attributes[:'TextType']
-      end
-
       if attributes.has_key?(:'FromName')
         self.from_name = attributes[:'FromName']
       end
@@ -154,10 +208,16 @@ module CloudmersivePhishingDetectionApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           input_string == o.input_string &&
+          text_type == o.text_type &&
           model == o.model &&
+          allow_unsolicited_sales == o.allow_unsolicited_sales &&
+          allow_promotional_content == o.allow_promotional_content &&
+          allow_web_urls == o.allow_web_urls &&
+          allow_phone_numbers == o.allow_phone_numbers &&
+          allow_email_addresses == o.allow_email_addresses &&
+          provide_url_analysis == o.provide_url_analysis &&
           custom_policy_id == o.custom_policy_id &&
           provide_analysis_rationale == o.provide_analysis_rationale &&
-          text_type == o.text_type &&
           from_name == o.from_name &&
           to_name == o.to_name &&
           from_phone_number == o.from_phone_number &&
@@ -175,7 +235,7 @@ module CloudmersivePhishingDetectionApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [input_string, model, custom_policy_id, provide_analysis_rationale, text_type, from_name, to_name, from_phone_number, to_phone_number, from_email_address, to_email_address].hash
+      [input_string, text_type, model, allow_unsolicited_sales, allow_promotional_content, allow_web_urls, allow_phone_numbers, allow_email_addresses, provide_url_analysis, custom_policy_id, provide_analysis_rationale, from_name, to_name, from_phone_number, to_phone_number, from_email_address, to_email_address].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-phishing-detection-api-client/models/phishing_detection_advanced_response.rb

@@ -18,8 +18,23 @@ module CloudmersivePhishingDetectionApiClient
     # True if the result is not phishing (clean), and false otherwise
     attr_accessor :clean_result
 
-    # Overall phishing risk level between 0.0 and 1.0
-    attr_accessor :phishing_risk_level
+    # True if the input text contains a phishing attempt, false otherwise
+    attr_accessor :contains_phishing
+
+    # True if the input text contains unsolicited sales, false otherwise
+    attr_accessor :contains_unsolicited_sales
+
+    # True if the input text contains promotional content, false otherwise
+    attr_accessor :contains_promotional_content
+
+    # True if the input text contains web URLs, including homoglyph URLs and spaced-out URL workarounds
+    attr_accessor :contains_web_urls
+
+    # True if the input text contains phone numbers, including homoglyph digits and spaced-out or spelled-out workarounds
+    attr_accessor :contains_phone_numbers
+
+    # True if the input text contains email addresses, including homoglyph characters and obfuscated workarounds
+    attr_accessor :contains_email_addresses
 
     # Confidence level between 0.0 and 1.0 where values over 0.9 indicate high confidence
     attr_accessor :confidence_level
@@ -27,13 +42,22 @@ module CloudmersivePhishingDetectionApiClient
     # Rationale for why the conclusion was formed
     attr_accessor :analysis_rationale
 
+    # URLs detected in the input text that were analyzed and found to be unsafe. Only populated when ProvideUrlAnalysis is true and URLs are detected.
+    attr_accessor :unsafe_urls
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'clean_result' => :'CleanResult',
-        :'phishing_risk_level' => :'PhishingRiskLevel',
+        :'contains_phishing' => :'ContainsPhishing',
+        :'contains_unsolicited_sales' => :'ContainsUnsolicitedSales',
+        :'contains_promotional_content' => :'ContainsPromotionalContent',
+        :'contains_web_urls' => :'ContainsWebUrls',
+        :'contains_phone_numbers' => :'ContainsPhoneNumbers',
+        :'contains_email_addresses' => :'ContainsEmailAddresses',
         :'confidence_level' => :'ConfidenceLevel',
-        :'analysis_rationale' => :'AnalysisRationale'
+        :'analysis_rationale' => :'AnalysisRationale',
+        :'unsafe_urls' => :'UnsafeUrls'
       }
     end
 
@@ -41,9 +65,15 @@ module CloudmersivePhishingDetectionApiClient
     def self.swagger_types
       {
         :'clean_result' => :'BOOLEAN',
-        :'phishing_risk_level' => :'Float',
+        :'contains_phishing' => :'BOOLEAN',
+        :'contains_unsolicited_sales' => :'BOOLEAN',
+        :'contains_promotional_content' => :'BOOLEAN',
+        :'contains_web_urls' => :'BOOLEAN',
+        :'contains_phone_numbers' => :'BOOLEAN',
+        :'contains_email_addresses' => :'BOOLEAN',
         :'confidence_level' => :'Float',
-        :'analysis_rationale' => :'String'
+        :'analysis_rationale' => :'String',
+        :'unsafe_urls' => :'Array<UnsafeUrlResult>'
       }
     end
 
@@ -59,8 +89,28 @@ module CloudmersivePhishingDetectionApiClient
         self.clean_result = attributes[:'CleanResult']
       end
 
-      if attributes.has_key?(:'PhishingRiskLevel')
-        self.phishing_risk_level = attributes[:'PhishingRiskLevel']
+      if attributes.has_key?(:'ContainsPhishing')
+        self.contains_phishing = attributes[:'ContainsPhishing']
+      end
+
+      if attributes.has_key?(:'ContainsUnsolicitedSales')
+        self.contains_unsolicited_sales = attributes[:'ContainsUnsolicitedSales']
+      end
+
+      if attributes.has_key?(:'ContainsPromotionalContent')
+        self.contains_promotional_content = attributes[:'ContainsPromotionalContent']
+      end
+
+      if attributes.has_key?(:'ContainsWebUrls')
+        self.contains_web_urls = attributes[:'ContainsWebUrls']
+      end
+
+      if attributes.has_key?(:'ContainsPhoneNumbers')
+        self.contains_phone_numbers = attributes[:'ContainsPhoneNumbers']
+      end
+
+      if attributes.has_key?(:'ContainsEmailAddresses')
+        self.contains_email_addresses = attributes[:'ContainsEmailAddresses']
       end
 
       if attributes.has_key?(:'ConfidenceLevel')
@@ -70,6 +120,12 @@ module CloudmersivePhishingDetectionApiClient
       if attributes.has_key?(:'AnalysisRationale')
         self.analysis_rationale = attributes[:'AnalysisRationale']
       end
+
+      if attributes.has_key?(:'UnsafeUrls')
+        if (value = attributes[:'UnsafeUrls']).is_a?(Array)
+          self.unsafe_urls = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,9 +147,15 @@ module CloudmersivePhishingDetectionApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           clean_result == o.clean_result &&
-          phishing_risk_level == o.phishing_risk_level &&
+          contains_phishing == o.contains_phishing &&
+          contains_unsolicited_sales == o.contains_unsolicited_sales &&
+          contains_promotional_content == o.contains_promotional_content &&
+          contains_web_urls == o.contains_web_urls &&
+          contains_phone_numbers == o.contains_phone_numbers &&
+          contains_email_addresses == o.contains_email_addresses &&
           confidence_level == o.confidence_level &&
-          analysis_rationale == o.analysis_rationale
+          analysis_rationale == o.analysis_rationale &&
+          unsafe_urls == o.unsafe_urls
     end
 
     # @see the `==` method
@@ -105,7 +167,7 @@ module CloudmersivePhishingDetectionApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clean_result, phishing_risk_level, confidence_level, analysis_rationale].hash
+      [clean_result, contains_phishing, contains_unsolicited_sales, contains_promotional_content, contains_web_urls, contains_phone_numbers, contains_email_addresses, confidence_level, analysis_rationale, unsafe_urls].hash
     end
 
     # Builds the object from hash