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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -9
  3. data/docs/PhishingDetectionAdvancedRequest.md +8 -1
  4. data/docs/PhishingDetectionAdvancedResponse.md +7 -1
  5. data/docs/PhishingDetectionApi.md +66 -12
  6. data/docs/PhishingDetectionTextStringRequest.md +10 -0
  7. data/docs/PhishingDetectionTextStringResponse.md +10 -0
  8. data/docs/PriorHistoryItem.md +15 -0
  9. data/docs/UnsafeUrlResult.md +12 -0
  10. data/lib/cloudmersive-phishing-detection-api-client/api/phishing_detection_api.rb +56 -8
  11. data/lib/cloudmersive-phishing-detection-api-client/models/phishing_detection_advanced_request.rb +86 -14
  12. data/lib/cloudmersive-phishing-detection-api-client/models/phishing_detection_advanced_response.rb +73 -11
  13. data/lib/cloudmersive-phishing-detection-api-client/models/phishing_detection_text_string_request.rb +206 -0
  14. data/lib/cloudmersive-phishing-detection-api-client/models/phishing_detection_text_string_response.rb +206 -0
  15. data/lib/cloudmersive-phishing-detection-api-client/models/prior_history_item.rb +256 -0
  16. data/lib/cloudmersive-phishing-detection-api-client/models/unsafe_url_result.rb +226 -0
  17. data/lib/cloudmersive-phishing-detection-api-client/version.rb +1 -1
  18. data/lib/cloudmersive-phishing-detection-api-client.rb +4 -0
  19. data/spec/api/phishing_detection_api_spec.rb +15 -4
  20. data/spec/models/phishing_detection_advanced_request_spec.rb +45 -3
  21. data/spec/models/phishing_detection_advanced_response_spec.rb +37 -1
  22. data/spec/models/phishing_detection_text_string_request_spec.rb +53 -0
  23. data/spec/models/phishing_detection_text_string_response_spec.rb +53 -0
  24. data/spec/models/prior_history_item_spec.rb +83 -0
  25. data/spec/models/unsafe_url_result_spec.rb +65 -0
  26. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d09cb2566e6ef13fd750ea52942b7683cbbd4da4607681fb3f03e37e871f0b89
4
- data.tar.gz: f0686bd696fc9b3e8233cbb89e008c875f214fd9e3f9f16f874b84c167667979
3
+ metadata.gz: a31d43c558e46df6cf108f28aaab9955c8c39214e4d18223fbb3b21856812b45
4
+ data.tar.gz: 9ba607d136ca12c8c2930fd98fd46e9581488636f8c111a4936c3aac94cca813
5
5
  SHA512:
6
- metadata.gz: b5f0975e3527703e05ef19efbe872dfb58ee8ae48f56a75adae5b8640e9ce5339d27b2e472c8f1d9033851a8d929ebb92d2626532961900595ec647a319c1a9e
7
- data.tar.gz: 2aa1472249ba3fb4ece7666304239ceeeecae553daacb98c8951e1c9d21b82dd1061772ba124c5a3099c01d6fb6b3f178927fc36e3380ce207e88e16d0a75b7e
6
+ metadata.gz: b81a646b72e840f9c7cb74d758e23ff765f80bd75ba8b95bf52e50973824679243046e0abfcb6761e760c276ff0f7a0e25cca4833946a8b6beee0f301957a142
7
+ data.tar.gz: 60fb0ce8eb023273dbad3a7f3e51ce4026aa41ed1fe00683fcee841e25c93f67a709937cc1c0c5e0b845915d5966a4c89b2bb2842f3404d3e8c51060def07c41
data/README.md CHANGED
@@ -7,7 +7,7 @@ Easily and directly scan and block phishing security threats in input.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 2.2.2
10
+ - Package version: 2.2.4
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-phishing-detection-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-phishing-detection-api-client-2.2.2.gem
26
+ gem install ./cloudmersive-phishing-detection-api-client-2.2.4.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-phishing-detection-api-client-2.2.2.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-phishing-detection-api-client-2.2.4.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-phishing-detection-api-client', '~> 2.2.2'
34
+ gem 'cloudmersive-phishing-detection-api-client', '~> 2.2.4'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -69,7 +69,7 @@ opts = {
69
69
  }
70
70
 
71
71
  begin
72
- #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.
72
+ #Perform advanced AI phishing detection and classification against input email. Supports email input as a file (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) or as an HTML body string. 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.
73
73
  result = api_instance.phishing_detect_email_advanced_post(opts)
74
74
  p result
75
75
  rescue CloudmersivePhishingDetectionApiClient::ApiError => e
@@ -84,10 +84,11 @@ All URIs are relative to *https://localhost*
84
84
 
85
85
  Class | Method | HTTP request | Description
86
86
  ------------ | ------------- | ------------- | -------------
87
- *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.
88
- *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.
89
- *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.
90
- *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.
87
+ *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. Supports email input as a file (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) or as an HTML body string. 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.
88
+ *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 on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). 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.
89
+ *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, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). Analyzes input content as well as embedded URLs with AI deep learning to detect phishing and other unsafe content. Uses 100-125 API calls depending on model selected.
90
+ *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 learning to detect spam, phishing and other unsafe content. Uses 25-100 API calls depending on model selected.
91
+ *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.
91
92
  *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.
92
93
 
93
94
 
@@ -99,7 +100,11 @@ Class | Method | HTTP request | Description
99
100
  - [CloudmersivePhishingDetectionApiClient::PhishingDetectionAdvancedResponse](docs/PhishingDetectionAdvancedResponse.md)
100
101
  - [CloudmersivePhishingDetectionApiClient::PhishingDetectionEmailAdvancedResponse](docs/PhishingDetectionEmailAdvancedResponse.md)
101
102
  - [CloudmersivePhishingDetectionApiClient::PhishingDetectionResponse](docs/PhishingDetectionResponse.md)
103
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringRequest](docs/PhishingDetectionTextStringRequest.md)
104
+ - [CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringResponse](docs/PhishingDetectionTextStringResponse.md)
102
105
  - [CloudmersivePhishingDetectionApiClient::PhishingDetectionUrlAdvancedResponse](docs/PhishingDetectionUrlAdvancedResponse.md)
106
+ - [CloudmersivePhishingDetectionApiClient::PriorHistoryItem](docs/PriorHistoryItem.md)
107
+ - [CloudmersivePhishingDetectionApiClient::UnsafeUrlResult](docs/UnsafeUrlResult.md)
103
108
 
104
109
 
105
110
  ## Documentation for Authorization
@@ -4,15 +4,22 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **input_string** | **String** | Input text string to detect phishing against | [optional]
7
+ **text_type** | **String** | Optional: Type of text being analyzed. Must be one of: \"TextMessage\", \"UserMessage\", \"SalesLead\", \"EmailMessage\", \"SupportCase\", \"AppMessage\", \"Other\". | [optional]
7
8
  **model** | **String** | Optional: Specify which AI model to use. Possible choices are Normal and Advanced. Default is Advanced. | [optional]
9
+ **allow_unsolicited_sales** | **BOOLEAN** | Optional: True if unsolicited sales should be allowed, false otherwise. Defaults to true. | [optional]
10
+ **allow_promotional_content** | **BOOLEAN** | Optional: True if promotional content should be allowed, false otherwise. Defaults to true. | [optional]
11
+ **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]
12
+ **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]
13
+ **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]
14
+ **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]
8
15
  **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]
9
16
  **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]
10
- **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]
11
17
  **from_name** | **String** | Optional: Name of the sender | [optional]
12
18
  **to_name** | **String** | Optional: Name of the recipient | [optional]
13
19
  **from_phone_number** | **String** | Optional: Phone number of the sender | [optional]
14
20
  **to_phone_number** | **String** | Optional: Phone number of the recipient | [optional]
15
21
  **from_email_address** | **String** | Optional: Email address of the sender | [optional]
16
22
  **to_email_address** | **String** | Optional: Email address of the recipient | [optional]
23
+ **prior_history** | [**Array<PriorHistoryItem>**](PriorHistoryItem.md) | Optional: Prior context history (e.g. message history) leading up to the current input string. If provided, the AI will take this history into account as context when evaluating the current input. | [optional]
17
24
 
18
25
 
@@ -4,8 +4,14 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **clean_result** | **BOOLEAN** | True if the result is not phishing (clean), and false otherwise | [optional]
7
- **phishing_risk_level** | **Float** | Overall phishing risk level between 0.0 and 1.0 | [optional]
7
+ **contains_phishing** | **BOOLEAN** | True if the input text contains a phishing attempt, false otherwise | [optional]
8
+ **contains_unsolicited_sales** | **BOOLEAN** | True if the input text contains unsolicited sales, false otherwise | [optional]
9
+ **contains_promotional_content** | **BOOLEAN** | True if the input text contains promotional content, false otherwise | [optional]
10
+ **contains_web_urls** | **BOOLEAN** | True if the input text contains web URLs, including homoglyph URLs and spaced-out URL workarounds | [optional]
11
+ **contains_phone_numbers** | **BOOLEAN** | True if the input text contains phone numbers, including homoglyph digits and spaced-out or spelled-out workarounds | [optional]
12
+ **contains_email_addresses** | **BOOLEAN** | True if the input text contains email addresses, including homoglyph characters and obfuscated workarounds | [optional]
8
13
  **confidence_level** | **Float** | Confidence level between 0.0 and 1.0 where values over 0.9 indicate high confidence | [optional]
9
14
  **analysis_rationale** | **String** | Rationale for why the conclusion was formed | [optional]
15
+ **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]
10
16
 
11
17
 
@@ -4,17 +4,18 @@ All URIs are relative to *https://localhost*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**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.
8
- [**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.
9
- [**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.
10
- [**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.
7
+ [**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. Supports email input as a file (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) or as an HTML body string. 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.
8
+ [**phishing_detect_file_advanced_post**](PhishingDetectionApi.md#phishing_detect_file_advanced_post) | **POST** /phishing/detect/file/advanced | Perform advanced AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). 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.
9
+ [**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, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). Analyzes input content as well as embedded URLs with AI deep learning to detect phishing and other unsafe content. Uses 100-125 API calls depending on model selected.
10
+ [**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 learning to detect spam, phishing and other unsafe content. Uses 25-100 API calls depending on model selected.
11
+ [**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.
11
12
  [**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.
12
13
 
13
14
 
14
15
  # **phishing_detect_email_advanced_post**
15
16
  > PhishingDetectionEmailAdvancedResponse phishing_detect_email_advanced_post(opts)
16
17
 
17
- 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.
18
+ Perform advanced AI phishing detection and classification against input email. Supports email input as a file (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) or as an HTML body string. 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.
18
19
 
19
20
  ### Example
20
21
  ```ruby
@@ -35,7 +36,7 @@ opts = {
35
36
  }
36
37
 
37
38
  begin
38
- #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.
39
+ #Perform advanced AI phishing detection and classification against input email. Supports email input as a file (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) or as an HTML body string. 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.
39
40
  result = api_instance.phishing_detect_email_advanced_post(opts)
40
41
  p result
41
42
  rescue CloudmersivePhishingDetectionApiClient::ApiError => e
@@ -67,7 +68,7 @@ Name | Type | Description | Notes
67
68
  # **phishing_detect_file_advanced_post**
68
69
  > PhishingDetectionAdvancedResponse phishing_detect_file_advanced_post(opts)
69
70
 
70
- 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.
71
+ Perform advanced AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). 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.
71
72
 
72
73
  ### Example
73
74
  ```ruby
@@ -90,7 +91,7 @@ opts = {
90
91
  }
91
92
 
92
93
  begin
93
- #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.
94
+ #Perform advanced AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). 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.
94
95
  result = api_instance.phishing_detect_file_advanced_post(opts)
95
96
  p result
96
97
  rescue CloudmersivePhishingDetectionApiClient::ApiError => e
@@ -124,7 +125,7 @@ Name | Type | Description | Notes
124
125
  # **phishing_detect_file_post**
125
126
  > PhishingDetectionResponse phishing_detect_file_post(opts)
126
127
 
127
- 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.
128
+ Perform AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). Analyzes input content as well as embedded URLs with AI deep learning to detect phishing and other unsafe content. Uses 100-125 API calls depending on model selected.
128
129
 
129
130
  ### Example
130
131
  ```ruby
@@ -146,7 +147,7 @@ opts = {
146
147
  }
147
148
 
148
149
  begin
149
- #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.
150
+ #Perform AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). Analyzes input content as well as embedded URLs with AI deep learning to detect phishing and other unsafe content. Uses 100-125 API calls depending on model selected.
150
151
  result = api_instance.phishing_detect_file_post(opts)
151
152
  p result
152
153
  rescue CloudmersivePhishingDetectionApiClient::ApiError => e
@@ -179,7 +180,7 @@ Name | Type | Description | Notes
179
180
  # **phishing_detect_text_string_advanced_post**
180
181
  > PhishingDetectionAdvancedResponse phishing_detect_text_string_advanced_post(opts)
181
182
 
182
- 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.
183
+ 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 spam, phishing and other unsafe content. Uses 25-100 API calls depending on model selected.
183
184
 
184
185
  ### Example
185
186
  ```ruby
@@ -200,7 +201,7 @@ opts = {
200
201
  }
201
202
 
202
203
  begin
203
- #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.
204
+ #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 spam, phishing and other unsafe content. Uses 25-100 API calls depending on model selected.
204
205
  result = api_instance.phishing_detect_text_string_advanced_post(opts)
205
206
  p result
206
207
  rescue CloudmersivePhishingDetectionApiClient::ApiError => e
@@ -229,6 +230,59 @@ Name | Type | Description | Notes
229
230
 
230
231
 
231
232
 
233
+ # **phishing_detect_text_string_post**
234
+ > PhishingDetectionTextStringResponse phishing_detect_text_string_post(opts)
235
+
236
+ Perform AI phishing detection against input text string. Returns a clean/not-clean result with confidence level and optional rationale.
237
+
238
+ ### Example
239
+ ```ruby
240
+ # load the gem
241
+ require 'cloudmersive-phishing-detection-api-client'
242
+ # setup authorization
243
+ CloudmersivePhishingDetectionApiClient.configure do |config|
244
+ # Configure API key authorization: Apikey
245
+ config.api_key['Apikey'] = 'YOUR API KEY'
246
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
247
+ #config.api_key_prefix['Apikey'] = 'Bearer'
248
+ end
249
+
250
+ api_instance = CloudmersivePhishingDetectionApiClient::PhishingDetectionApi.new
251
+
252
+ opts = {
253
+ body: CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringRequest.new # PhishingDetectionTextStringRequest | Phishing detection request
254
+ }
255
+
256
+ begin
257
+ #Perform AI phishing detection against input text string. Returns a clean/not-clean result with confidence level and optional rationale.
258
+ result = api_instance.phishing_detect_text_string_post(opts)
259
+ p result
260
+ rescue CloudmersivePhishingDetectionApiClient::ApiError => e
261
+ puts "Exception when calling PhishingDetectionApi->phishing_detect_text_string_post: #{e}"
262
+ end
263
+ ```
264
+
265
+ ### Parameters
266
+
267
+ Name | Type | Description | Notes
268
+ ------------- | ------------- | ------------- | -------------
269
+ **body** | [**PhishingDetectionTextStringRequest**](PhishingDetectionTextStringRequest.md)| Phishing detection request | [optional]
270
+
271
+ ### Return type
272
+
273
+ [**PhishingDetectionTextStringResponse**](PhishingDetectionTextStringResponse.md)
274
+
275
+ ### Authorization
276
+
277
+ [Apikey](../README.md#Apikey)
278
+
279
+ ### HTTP request headers
280
+
281
+ - **Content-Type**: application/json, text/json, application/*+json
282
+ - **Accept**: text/plain, application/json, text/json
283
+
284
+
285
+
232
286
  # **phishing_detect_url_advanced_post**
233
287
  > PhishingDetectionUrlAdvancedResponse phishing_detect_url_advanced_post(opts)
234
288
 
@@ -0,0 +1,10 @@
1
+ # CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_string** | **String** | Input text string to detect phishing against | [optional]
7
+ **model** | **String** | Optional: Specify which AI model to use. Possible choices are Normal and Advanced. Default is Advanced. | [optional]
8
+ **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]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CloudmersivePhishingDetectionApiClient::PhishingDetectionTextStringResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **clean_result** | **BOOLEAN** | True if the result is not phishing (clean), and false otherwise | [optional]
7
+ **confidence_level** | **Float** | Confidence level between 0.0 and 1.0 where values over 0.9 indicate high confidence | [optional]
8
+ **analysis_rationale** | **String** | Rationale for why the conclusion was formed | [optional]
9
+
10
+
@@ -0,0 +1,15 @@
1
+ # CloudmersivePhishingDetectionApiClient::PriorHistoryItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_string** | **String** | The text content of this historical message | [optional]
7
+ **from_name** | **String** | Optional: Name of the sender | [optional]
8
+ **to_name** | **String** | Optional: Name of the recipient | [optional]
9
+ **from_phone_number** | **String** | Optional: Phone number of the sender | [optional]
10
+ **to_phone_number** | **String** | Optional: Phone number of the recipient | [optional]
11
+ **from_email_address** | **String** | Optional: Email address of the sender | [optional]
12
+ **to_email_address** | **String** | Optional: Email address of the recipient | [optional]
13
+ **trusted_party** | **BOOLEAN** | Optional: True if this message is from a trusted party (such as our own company), false otherwise | [optional]
14
+
15
+
@@ -0,0 +1,12 @@
1
+ # CloudmersivePhishingDetectionApiClient::UnsafeUrlResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | The URL that was detected and analyzed | [optional]
7
+ **clean_result** | **BOOLEAN** | True if the result is not phishing (clean), and false otherwise | [optional]
8
+ **is_ssrf_threat** | **BOOLEAN** | True if the URL is an SSRF threat | [optional]
9
+ **contains_phishing** | **BOOLEAN** | True if the URL contains phishing threat risks, false otherwise | [optional]
10
+ **contains_phishing_attempt** | **BOOLEAN** | True if the URL contains a phishing attempt, false otherwise | [optional]
11
+
12
+
@@ -19,7 +19,7 @@ module CloudmersivePhishingDetectionApiClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # 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.
22
+ # Perform advanced AI phishing detection and classification against input email. Supports email input as a file (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) or as an HTML body string. 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.
23
23
  # @param [Hash] opts the optional parameters
24
24
  # @option opts [AdvancedEmailDetectionRequest] :body Phishing detection request
25
25
  # @return [PhishingDetectionEmailAdvancedResponse]
@@ -28,7 +28,7 @@ module CloudmersivePhishingDetectionApiClient
28
28
  data
29
29
  end
30
30
 
31
- # 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.
31
+ # Perform advanced AI phishing detection and classification against input email. Supports email input as a file (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP) or as an HTML body string. 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.
32
32
  # @param [Hash] opts the optional parameters
33
33
  # @option opts [AdvancedEmailDetectionRequest] :body Phishing detection request
34
34
  # @return [Array<(PhishingDetectionEmailAdvancedResponse, Fixnum, Hash)>] PhishingDetectionEmailAdvancedResponse data, response status code and response headers
@@ -67,7 +67,7 @@ module CloudmersivePhishingDetectionApiClient
67
67
  end
68
68
  return data, status_code, headers
69
69
  end
70
- # 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.
70
+ # Perform advanced AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). 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.
71
71
  # @param [Hash] opts the optional parameters
72
72
  # @option opts [String] :model (default to Advanced)
73
73
  # @option opts [String] :custom_policy_id
@@ -78,7 +78,7 @@ module CloudmersivePhishingDetectionApiClient
78
78
  data
79
79
  end
80
80
 
81
- # 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.
81
+ # Perform advanced AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). 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.
82
82
  # @param [Hash] opts the optional parameters
83
83
  # @option opts [String] :model
84
84
  # @option opts [String] :custom_policy_id
@@ -122,7 +122,7 @@ module CloudmersivePhishingDetectionApiClient
122
122
  end
123
123
  return data, status_code, headers
124
124
  end
125
- # 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.
125
+ # Perform AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). Analyzes input content as well as embedded URLs with AI deep learning to detect phishing and other unsafe content. Uses 100-125 API calls depending on model selected.
126
126
  # @param [Hash] opts the optional parameters
127
127
  # @option opts [String] :model Model to use; default setting is Advanced (default to Advanced)
128
128
  # @option opts [File] :input_file
@@ -132,7 +132,7 @@ module CloudmersivePhishingDetectionApiClient
132
132
  data
133
133
  end
134
134
 
135
- # 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.
135
+ # Perform AI phishing detection and classification on an input image or document (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, WEBP). Analyzes input content as well as embedded URLs with AI deep learning to detect phishing and other unsafe content. Uses 100-125 API calls depending on model selected.
136
136
  # @param [Hash] opts the optional parameters
137
137
  # @option opts [String] :model Model to use; default setting is Advanced
138
138
  # @option opts [File] :input_file
@@ -174,7 +174,7 @@ module CloudmersivePhishingDetectionApiClient
174
174
  end
175
175
  return data, status_code, headers
176
176
  end
177
- # 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.
177
+ # 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 spam, phishing and other unsafe content. Uses 25-100 API calls depending on model selected.
178
178
  # @param [Hash] opts the optional parameters
179
179
  # @option opts [PhishingDetectionAdvancedRequest] :body Phishing detection request
180
180
  # @return [PhishingDetectionAdvancedResponse]
@@ -183,7 +183,7 @@ module CloudmersivePhishingDetectionApiClient
183
183
  data
184
184
  end
185
185
 
186
- # 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.
186
+ # 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 spam, phishing and other unsafe content. Uses 25-100 API calls depending on model selected.
187
187
  # @param [Hash] opts the optional parameters
188
188
  # @option opts [PhishingDetectionAdvancedRequest] :body Phishing detection request
189
189
  # @return [Array<(PhishingDetectionAdvancedResponse, Fixnum, Hash)>] PhishingDetectionAdvancedResponse data, response status code and response headers
@@ -222,6 +222,54 @@ module CloudmersivePhishingDetectionApiClient
222
222
  end
223
223
  return data, status_code, headers
224
224
  end
225
+ # Perform AI phishing detection against input text string. Returns a clean/not-clean result with confidence level and optional rationale.
226
+ # @param [Hash] opts the optional parameters
227
+ # @option opts [PhishingDetectionTextStringRequest] :body Phishing detection request
228
+ # @return [PhishingDetectionTextStringResponse]
229
+ def phishing_detect_text_string_post(opts = {})
230
+ data, _status_code, _headers = phishing_detect_text_string_post_with_http_info(opts)
231
+ data
232
+ end
233
+
234
+ # Perform AI phishing detection against input text string. Returns a clean/not-clean result with confidence level and optional rationale.
235
+ # @param [Hash] opts the optional parameters
236
+ # @option opts [PhishingDetectionTextStringRequest] :body Phishing detection request
237
+ # @return [Array<(PhishingDetectionTextStringResponse, Fixnum, Hash)>] PhishingDetectionTextStringResponse data, response status code and response headers
238
+ def phishing_detect_text_string_post_with_http_info(opts = {})
239
+ if @api_client.config.debugging
240
+ @api_client.config.logger.debug 'Calling API: PhishingDetectionApi.phishing_detect_text_string_post ...'
241
+ end
242
+ # resource path
243
+ local_var_path = '/phishing/detect/text-string'
244
+
245
+ # query parameters
246
+ query_params = {}
247
+
248
+ # header parameters
249
+ header_params = {}
250
+ # HTTP header 'Accept' (if needed)
251
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
252
+ # HTTP header 'Content-Type'
253
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
254
+
255
+ # form parameters
256
+ form_params = {}
257
+
258
+ # http body (model)
259
+ post_body = @api_client.object_to_http_body(opts[:'body'])
260
+ auth_names = ['Apikey']
261
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
262
+ :header_params => header_params,
263
+ :query_params => query_params,
264
+ :form_params => form_params,
265
+ :body => post_body,
266
+ :auth_names => auth_names,
267
+ :return_type => 'PhishingDetectionTextStringResponse')
268
+ if @api_client.config.debugging
269
+ @api_client.config.logger.debug "API called: PhishingDetectionApi#phishing_detect_text_string_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
270
+ end
271
+ return data, status_code, headers
272
+ end
225
273
  # 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.
226
274
  # @param [Hash] opts the optional parameters
227
275
  # @option opts [AdvancedUrlDetectionRequest] :body URL phishing detection request