cloudmersive-phishing-detection-api-client 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db228aa9d3ba68d5c357d0e2c18406b8a07d45ba975d5098edbf37db529f9c40
+  data.tar.gz: 5fc22a0c015282b5a962acd6572a9694e3c575abfef1db1037bda97f471f83a4
+SHA512:
+  metadata.gz: 73acce08567c2ca1e0e5647a224a5d09c18d24ed65e1aef69b6889708879bf0f0a008a02f644ec3b7c597375eb0eb893fe0d14fb09d07fc4fba467a286867228
+  data.tar.gz: 652d44d39aa4a733742a5eb98be2069d4e979de5fa2cf8a26b073e5a1a750c73b6b900dccc4a3e9fbf6cd00b56f2efcd8cc3eba3e2bcb97f22c17e41f1c7b2e9

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,112 @@
+# cloudmersive-phishing-detection-api-client
+
+CloudmersivePhishingDetectionApiClient - the Ruby gem for the phishingapi
+
+Easily and directly scan and block phishing security threats.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 2.2.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cloudmersive-phishing-detection-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-phishing-detection-api-client-2.2.0.gem
+```
+(for development, run `gem install --dev ./cloudmersive-phishing-detection-api-client-2.2.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'cloudmersive-phishing-detection-api-client', '~> 2.2.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'cloudmersive-phishing-detection-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```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
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersivePhishingDetectionApiClient::PhishingUrlApi* | [**phishing_url_advanced_post**](docs/PhishingUrlApi.md#phishing_url_advanced_post) | **POST** /phishing/url/advanced | Use advanced AI detection to determine if a URL is a known phishing threat
+*CloudmersivePhishingDetectionApiClient::PhishingUrlApi* | [**phishing_url_post**](docs/PhishingUrlApi.md#phishing_url_post) | **POST** /phishing/url | Use AI and deterministic detection to determine if a URL is a phishing threat
+*CloudmersivePhishingDetectionApiClient::PhishingUrlBatchApi* | [**phishing_url_advanced_batch_post**](docs/PhishingUrlBatchApi.md#phishing_url_advanced_batch_post) | **POST** /phishing/url/advanced/batch | Accept multiple urls at once to perform lookups to see if the urls are known phishing sites as well as multiple other scans to determine  if the URL is a potential phishing threat.
+*CloudmersivePhishingDetectionApiClient::PhishingUrlBatchApi* | [**phishing_url_batch_post**](docs/PhishingUrlBatchApi.md#phishing_url_batch_post) | **POST** /phishing/url/batch | Accept multiple urls at oncee and perform AI and deterministic methods to detect if a URL is a phishing threat.
+
+
+## Documentation for Models
+
+ - [CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequest](docs/PhishingUrlAdvancedRequest.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequestBatch](docs/PhishingUrlAdvancedRequestBatch.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedResponse](docs/PhishingUrlAdvancedResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedResponseBatch](docs/PhishingUrlAdvancedResponseBatch.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingUrlRequest](docs/PhishingUrlRequest.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingUrlResponse](docs/PhishingUrlResponse.md)
+ - [CloudmersivePhishingDetectionApiClient::PhishingUrlResponseBatch](docs/PhishingUrlResponseBatch.md)
+
+
+## Documentation for Authorization
+
+
+### Apikey
+
+- **Type**: API key
+- **API key parameter name**: Apikey
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

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

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cloudmersive-phishing-detection-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-phishing-detection-api-client"
+  s.version     = CloudmersivePhishingDetectionApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://www.cloudmersive.com/phishing-api"
+  s.summary     = "Scan URLs for phishing."
+  s.description = "Phishing Detection API lets you scan websites for phishing attacks using AI."
+  s.license     = 'Apache 2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = Dir['./**/*']
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/PhishingUrlAdvancedRequest.md

@@ -0,0 +1,10 @@
+# CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Full url data to be evaluated | 
+**allow_list** | **Array<String>** | The caller may specify a collection of   hosts or domains which are always considered safe.<br />  This is to allow internal sites to be marked as safe | [optional] 
+**block_list** | **Array<String>** | The caller may specify a collection of   hosts or domains which are always considered unsafe.<br />  This is to allow internal sites to be marked as safe | [optional] 
+
+

data/docs/PhishingUrlAdvancedRequestBatch.md

@@ -0,0 +1,10 @@
+# CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedRequestBatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**urls** | **Array<String>** | Collection of all urls to check | 
+**allow_list** | **Array<String>** | The caller may specify a collection of   hosts or domains which are always considered safe.<br />  This is to allow internal sites to be marked as safe | [optional] 
+**block_list** | **Array<String>** | The caller may specify a collection of   hosts or domains which are always considered unsafe.<br />  This is to allow internal sites to be marked as safe | [optional] 
+
+

data/docs/PhishingUrlAdvancedResponse.md

@@ -0,0 +1,18 @@
+# CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedResponse
+
+## 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] 
+**contains_threat_ssrf** | **BOOLEAN** | The url that was provided or the destination url after redirection contains an SSRF threat | [optional] 
+**contains_threat_url_format** | **BOOLEAN** | The url that was provided or the destination url after redirection is an unsafe format | [optional] 
+**contains_threat_domain_quality** | **BOOLEAN** | The domain of the destination url is low quality. | [optional] 
+**contains_threat_domain_age** | **BOOLEAN** | The domain of the destination url has been registered too recently. | [optional] 
+**url_is_invalid_syntax** | **BOOLEAN** | Specifies if the url was malformed or not | [optional] 
+**input_url** | **String** | Input URL that was scanned | [optional] 
+
+

data/docs/PhishingUrlAdvancedResponseBatch.md

@@ -0,0 +1,9 @@
+# CloudmersivePhishingDetectionApiClient::PhishingUrlAdvancedResponseBatch
+
+## 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<PhishingUrlAdvancedResponse>**](PhishingUrlAdvancedResponse.md) | Resulting URL validations | [optional] 
+
+

data/docs/PhishingUrlApi.md

@@ -0,0 +1,120 @@
+# 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

@@ -0,0 +1,120 @@
+# 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

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

data/docs/PhishingUrlResponse.md

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1,9 @@
+# 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/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+