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

data/docs/PhishingUrlApi.md

@@ -1,120 +0,0 @@
-# CloudmersivePhishingDetectionApiClient::PhishingUrlApi
-
-All URIs are relative to *https://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**phishing_url_advanced_post**](PhishingUrlApi.md#phishing_url_advanced_post) | **POST** /phishing/url/advanced | Use advanced AI detection to determine if a URL is a known phishing threat
-[**phishing_url_post**](PhishingUrlApi.md#phishing_url_post) | **POST** /phishing/url | Use AI and deterministic detection to determine if a URL is a phishing threat
-
-
-# **phishing_url_advanced_post**
-> PhishingUrlAdvancedResponse phishing_url_advanced_post(opts)
-
-Use advanced AI detection to determine if a URL is a known phishing threat
-
-Uses advanced AI and deterministic methods to detect if a URL is a phishing threat.
-
-### 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::PhishingUrlApi.new
-
-opts = { 
-  body: CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequest.new # PhishingUrlAdvancedRequest | 
-}
-
-begin
-  #Use advanced AI detection to determine if a URL is a known phishing threat
-  result = api_instance.phishing_url_advanced_post(opts)
-  p result
-rescue CloudmersivePhishingDetectionApiClient::ApiError => e
-  puts "Exception when calling PhishingUrlApi->phishing_url_advanced_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**PhishingUrlAdvancedRequest**](PhishingUrlAdvancedRequest.md)|  | [optional] 
-
-### Return type
-
-[**PhishingUrlAdvancedResponse**](PhishingUrlAdvancedResponse.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json, application/*+json, application/xml, text/xml, application/*+xml
- - **Accept**: text/plain, application/json, text/json, application/xml, text/xml
-
-
-
-# **phishing_url_post**
-> PhishingUrlResponse phishing_url_post(opts)
-
-Use AI and deterministic detection to determine if a URL is a phishing threat
-
-Uses AI and deterministic methods to detect if a URL is a phishing threat.
-
-### 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::PhishingUrlApi.new
-
-opts = { 
-  body: CloudmersivePhishingDetectionApiClient::PhishingUrlRequest.new # PhishingUrlRequest | 
-}
-
-begin
-  #Use AI and deterministic detection to determine if a URL is a phishing threat
-  result = api_instance.phishing_url_post(opts)
-  p result
-rescue CloudmersivePhishingDetectionApiClient::ApiError => e
-  puts "Exception when calling PhishingUrlApi->phishing_url_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**PhishingUrlRequest**](PhishingUrlRequest.md)|  | [optional] 
-
-### Return type
-
-[**PhishingUrlResponse**](PhishingUrlResponse.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json, application/*+json, application/xml, text/xml, application/*+xml
- - **Accept**: text/plain, application/json, text/json, application/xml, text/xml
-
-
-

data/docs/PhishingUrlBatchApi.md

@@ -1,120 +0,0 @@
-# CloudmersivePhishingDetectionApiClient::PhishingUrlBatchApi
-
-All URIs are relative to *https://localhost*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**phishing_url_advanced_batch_post**](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.
-[**phishing_url_batch_post**](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.
-
-
-# **phishing_url_advanced_batch_post**
-> PhishingUrlAdvancedResponseBatch phishing_url_advanced_batch_post(opts)
-
-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.
-
-Uses advanced AI and deterministic methods to detect if a URL is a phishing threat.
-
-### 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::PhishingUrlBatchApi.new
-
-opts = { 
-  body: CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequestBatch.new # PhishingUrlAdvancedRequestBatch | 
-}
-
-begin
-  #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.
-  result = api_instance.phishing_url_advanced_batch_post(opts)
-  p result
-rescue CloudmersivePhishingDetectionApiClient::ApiError => e
-  puts "Exception when calling PhishingUrlBatchApi->phishing_url_advanced_batch_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**PhishingUrlAdvancedRequestBatch**](PhishingUrlAdvancedRequestBatch.md)|  | [optional] 
-
-### Return type
-
-[**PhishingUrlAdvancedResponseBatch**](PhishingUrlAdvancedResponseBatch.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json, application/*+json, application/xml, text/xml, application/*+xml
- - **Accept**: text/plain, application/json, text/json, application/xml, text/xml
-
-
-
-# **phishing_url_batch_post**
-> PhishingUrlResponseBatch phishing_url_batch_post(opts)
-
-Accept multiple urls at oncee and perform AI and deterministic methods to detect if a URL is a phishing threat.
-
-Uses AI and deterministic methods to detect if a URL is a phishing threat.
-
-### 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::PhishingUrlBatchApi.new
-
-opts = { 
-  body: [CloudmersivePhishingDetectionApiClient::PhishingUrlRequest.new] # Array<PhishingUrlRequest> | 
-}
-
-begin
-  #Accept multiple urls at oncee and perform AI and deterministic methods to detect if a URL is a phishing threat.
-  result = api_instance.phishing_url_batch_post(opts)
-  p result
-rescue CloudmersivePhishingDetectionApiClient::ApiError => e
-  puts "Exception when calling PhishingUrlBatchApi->phishing_url_batch_post: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**Array&lt;PhishingUrlRequest&gt;**](PhishingUrlRequest.md)|  | [optional] 
-
-### Return type
-
-[**PhishingUrlResponseBatch**](PhishingUrlResponseBatch.md)
-
-### Authorization
-
-[Apikey](../README.md#Apikey)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/json, application/*+json, application/xml, text/xml, application/*+xml
- - **Accept**: text/plain, application/json, text/json, application/xml, text/xml
-
-
-

data/docs/PhishingUrlRequest.md

@@ -1,8 +0,0 @@
-# CloudmersivePhishingDetectionApiClient::PhishingUrlRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**url** | **String** | Full url to be evaluated | 
-
-

data/docs/PhishingUrlResponse.md

@@ -1,13 +0,0 @@
-# CloudmersivePhishingDetectionApiClient::PhishingUrlResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clean_result** | **BOOLEAN** | Specifies if the url (or its host or domain) passed all the checks or not. | [optional] 
-**risk** | **Float** | Risk value from 0.0 - 1.0. Higher numbers are a higher risk  <br />Anything below 0.3 should be considered safe. Anything above 0.7 should be considered a significant risk. <br />  A score of 1.0 indicates the url, host, or domain failed significant safety checks.<br />  If a url passes all the tests for the basic api, the risk will be 0.7. If a url passes all the tests for the advanced api, the risk will be 0.2. | [optional] 
-**contains_threat_url** | **BOOLEAN** | Specifies if the full url with query parameters and fragment is a phishing threat  <br />The advanced api performs more checks on the full url. | [optional] 
-**contains_threat_host** | **BOOLEAN** | Specifies if the host of the url (i.e. ```mysite.hostingsite.com``` for a url of ```https://mysite.hostingsite.com/index.html```) is a phishing threat  <br />The advanced api performs more checks on the host | [optional] 
-**contains_threat_domain** | **BOOLEAN** | Specifies if the registerable domain of the url (i.e. ```hostingsite.com``` for a url of ```https://mysite.hostingsite.com/index.html```) is a phishing threat  <br />The advanced api performs more checks on the domain | [optional] 
-**input_url** | **String** | Input URL that was scanned | [optional] 
-
-

data/docs/PhishingUrlResponseBatch.md

@@ -1,9 +0,0 @@
-# CloudmersivePhishingDetectionApiClient::PhishingUrlResponseBatch
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clean_result** | **BOOLEAN** | Specifies if all the urls (or its hosts or domains) in this batch call passed all the checks or not. | [optional] 
-**url_responses** | [**Array<PhishingUrlResponse>**](PhishingUrlResponse.md) | Dictionary where the requesting url is the key and the value is the resulting validation | [optional] 
-
-

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

@@ -1,123 +0,0 @@
-=begin
-#phishingapi
-
-#Easily and directly scan and block phishing security threats.
-
-OpenAPI spec version: v1
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
-
-=end
-
-require 'uri'
-
-module CloudmersivePhishingDetectionApiClient
-  class PhishingUrlApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Use advanced AI detection to determine if a URL is a known phishing threat
-    # Uses advanced AI and deterministic methods to detect if a URL is a phishing threat.
-    # @param [Hash] opts the optional parameters
-    # @option opts [PhishingUrlAdvancedRequest] :body 
-    # @return [PhishingUrlAdvancedResponse]
-    def phishing_url_advanced_post(opts = {})
-      data, _status_code, _headers = phishing_url_advanced_post_with_http_info(opts)
-      data
-    end
-
-    # Use advanced AI detection to determine if a URL is a known phishing threat
-    # Uses advanced AI and deterministic methods to detect if a URL is a phishing threat.
-    # @param [Hash] opts the optional parameters
-    # @option opts [PhishingUrlAdvancedRequest] :body 
-    # @return [Array<(PhishingUrlAdvancedResponse, Fixnum, Hash)>] PhishingUrlAdvancedResponse data, response status code and response headers
-    def phishing_url_advanced_post_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PhishingUrlApi.phishing_url_advanced_post ...'
-      end
-      # resource path
-      local_var_path = '/phishing/url/advanced'
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])
-
-      # 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 => 'PhishingUrlAdvancedResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PhishingUrlApi#phishing_url_advanced_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Use AI and deterministic detection to determine if a URL is a phishing threat
-    # Uses AI and deterministic methods to detect if a URL is a phishing threat.
-    # @param [Hash] opts the optional parameters
-    # @option opts [PhishingUrlRequest] :body 
-    # @return [PhishingUrlResponse]
-    def phishing_url_post(opts = {})
-      data, _status_code, _headers = phishing_url_post_with_http_info(opts)
-      data
-    end
-
-    # Use AI and deterministic detection to determine if a URL is a phishing threat
-    # Uses AI and deterministic methods to detect if a URL is a phishing threat.
-    # @param [Hash] opts the optional parameters
-    # @option opts [PhishingUrlRequest] :body 
-    # @return [Array<(PhishingUrlResponse, Fixnum, Hash)>] PhishingUrlResponse data, response status code and response headers
-    def phishing_url_post_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PhishingUrlApi.phishing_url_post ...'
-      end
-      # resource path
-      local_var_path = '/phishing/url'
-
-      # 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', 'application/xml', 'text/xml'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])
-
-      # 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 => 'PhishingUrlResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PhishingUrlApi#phishing_url_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

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

@@ -1,123 +0,0 @@
-=begin
-#phishingapi
-
-#Easily and directly scan and block phishing security threats.
-
-OpenAPI spec version: v1
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
-
-=end
-
-require 'uri'
-
-module CloudmersivePhishingDetectionApiClient
-  class PhishingUrlBatchApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # 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.
-    # Uses advanced AI and deterministic methods to detect if a URL is a phishing threat.
-    # @param [Hash] opts the optional parameters
-    # @option opts [PhishingUrlAdvancedRequestBatch] :body 
-    # @return [PhishingUrlAdvancedResponseBatch]
-    def phishing_url_advanced_batch_post(opts = {})
-      data, _status_code, _headers = phishing_url_advanced_batch_post_with_http_info(opts)
-      data
-    end
-
-    # 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.
-    # Uses advanced AI and deterministic methods to detect if a URL is a phishing threat.
-    # @param [Hash] opts the optional parameters
-    # @option opts [PhishingUrlAdvancedRequestBatch] :body 
-    # @return [Array<(PhishingUrlAdvancedResponseBatch, Fixnum, Hash)>] PhishingUrlAdvancedResponseBatch data, response status code and response headers
-    def phishing_url_advanced_batch_post_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PhishingUrlBatchApi.phishing_url_advanced_batch_post ...'
-      end
-      # resource path
-      local_var_path = '/phishing/url/advanced/batch'
-
-      # 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', 'application/xml', 'text/xml'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])
-
-      # 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 => 'PhishingUrlAdvancedResponseBatch')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PhishingUrlBatchApi#phishing_url_advanced_batch_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-    # Accept multiple urls at oncee and perform AI and deterministic methods to detect if a URL is a phishing threat.
-    # Uses AI and deterministic methods to detect if a URL is a phishing threat.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Array<PhishingUrlRequest>] :body 
-    # @return [PhishingUrlResponseBatch]
-    def phishing_url_batch_post(opts = {})
-      data, _status_code, _headers = phishing_url_batch_post_with_http_info(opts)
-      data
-    end
-
-    # Accept multiple urls at oncee and perform AI and deterministic methods to detect if a URL is a phishing threat.
-    # Uses AI and deterministic methods to detect if a URL is a phishing threat.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Array<PhishingUrlRequest>] :body 
-    # @return [Array<(PhishingUrlResponseBatch, Fixnum, Hash)>] PhishingUrlResponseBatch data, response status code and response headers
-    def phishing_url_batch_post_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PhishingUrlBatchApi.phishing_url_batch_post ...'
-      end
-      # resource path
-      local_var_path = '/phishing/url/batch'
-
-      # 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', 'application/xml', 'text/xml'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json', 'application/xml', 'text/xml', 'application/*+xml'])
-
-      # 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 => 'PhishingUrlResponseBatch')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PhishingUrlBatchApi#phishing_url_batch_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end