cloudmersive-frauddetection-api-client 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e7241f0429f08a438b943bf7c0e88c2931429a4785d26eecd92ae07cee24dde
+  data.tar.gz: 3d7556ce3eb22dbb1f25d862eb42422f224a8cc962535881fd2a20c30a437262
+SHA512:
+  metadata.gz: a1c3b3c80439d3b245b6e155898c491e1c0ab4bb73218e74292c059f440764e78a4d3e656e9c34865294d540793b035e4099a729a8a8d0fda6f054787e56ba09
+  data.tar.gz: b12a408df0524fb2631507db917a014e97d8a08df01a951f3936942cac7fbce572d9e781001ffd6127ee96088c15a9e14e16a56fffdbc6c3c39f6eaf60d72bbe

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,105 @@
+# cloudmersive-frauddetection-api-client
+
+CloudmersiveFrauddetectionApiClient - the Ruby gem for the fraudapi
+
+Easily and directly scan and block fraudulent 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.0.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cloudmersive-frauddetection-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-frauddetection-api-client-2.0.0.gem
+```
+(for development, run `gem install --dev ./cloudmersive-frauddetection-api-client-2.0.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-frauddetection-api-client', '~> 2.0.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-frauddetection-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-frauddetection-api-client'
+
+# Setup authorization
+CloudmersiveFrauddetectionApiClient.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 = CloudmersiveFrauddetectionApiClient::FraudDetectionApi.new
+
+opts = { 
+  input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to perform fraud detection on
+}
+
+begin
+  #AI Fraud Detection for Documents
+  result = api_instance.document_detect_fraud(opts)
+  p result
+rescue CloudmersiveFrauddetectionApiClient::ApiError => e
+  puts "Exception when calling FraudDetectionApi->document_detect_fraud: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveFrauddetectionApiClient::FraudDetectionApi* | [**document_detect_fraud**](docs/FraudDetectionApi.md#document_detect_fraud) | **POST** /fraud-ai/detection/document | AI Fraud Detection for Documents
+*CloudmersiveFrauddetectionApiClient::FraudDetectionApi* | [**document_detect_fraud_advanced**](docs/FraudDetectionApi.md#document_detect_fraud_advanced) | **POST** /fraud-ai/detection/document/advanced | Advanced AI Fraud Detection for Documents
+
+
+## Documentation for Models
+
+ - [CloudmersiveFrauddetectionApiClient::AdvancedFraudDetectionResult](docs/AdvancedFraudDetectionResult.md)
+ - [CloudmersiveFrauddetectionApiClient::FraudDetectionResult](docs/FraudDetectionResult.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-frauddetection-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#fraudapi
+
+#Easily and directly scan and block fraudulent security threats in input.
+
+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-frauddetection-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-frauddetection-api-client"
+  s.version     = CloudmersiveFrauddetectionApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://cloudmersive.com/ai-fraud-detection-api"
+  s.summary     = "Scan input documents for fraud and other security threats using Advanced AI."
+  s.description = "Scan input documents for fraud and other security threats using Advanced 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/AdvancedFraudDetectionResult.md

@@ -0,0 +1,16 @@
+# CloudmersiveFrauddetectionApiClient::AdvancedFraudDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**clean_result** | **BOOLEAN** | True if the document is clean, false if fraud threats were found | [optional] 
+**fraud_risk_level** | **Float** | Overall fraud risk level between 0.0 and 1.0 | [optional] 
+**contains_financial_liability** | **BOOLEAN** | True if the document contains financial liability | [optional] 
+**contains_sensitive_information_collection** | **BOOLEAN** | True if the document contains sensitive data collection from the recipient | [optional] 
+**contains_asset_transfer** | **BOOLEAN** | True if the document contains an asset transfer | [optional] 
+**contains_purchase_agreement** | **BOOLEAN** | True if the document contains a purchase agreement | [optional] 
+**contains_employment_agreement** | **BOOLEAN** | True if the document contains an employment agreement | [optional] 
+**analysis_rationale** | **String** | Rationale on why the document was classified as such | [optional] 
+
+

data/docs/FraudDetectionApi.md

@@ -0,0 +1,124 @@
+# CloudmersiveFrauddetectionApiClient::FraudDetectionApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**document_detect_fraud**](FraudDetectionApi.md#document_detect_fraud) | **POST** /fraud-ai/detection/document | AI Fraud Detection for Documents
+[**document_detect_fraud_advanced**](FraudDetectionApi.md#document_detect_fraud_advanced) | **POST** /fraud-ai/detection/document/advanced | Advanced AI Fraud Detection for Documents
+
+
+# **document_detect_fraud**
+> FraudDetectionResult document_detect_fraud(opts)
+
+AI Fraud Detection for Documents
+
+Perform fraud detection and classification on input document and user context.  Input document formats supported include DOCX, PDF, PNG and JPG.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-frauddetection-api-client'
+# setup authorization
+CloudmersiveFrauddetectionApiClient.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 = CloudmersiveFrauddetectionApiClient::FraudDetectionApi.new
+
+opts = { 
+  input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to perform fraud detection on
+}
+
+begin
+  #AI Fraud Detection for Documents
+  result = api_instance.document_detect_fraud(opts)
+  p result
+rescue CloudmersiveFrauddetectionApiClient::ApiError => e
+  puts "Exception when calling FraudDetectionApi->document_detect_fraud: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input document, or photos of a document, to perform fraud detection on | [optional] 
+
+### Return type
+
+[**FraudDetectionResult**](FraudDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **document_detect_fraud_advanced**
+> AdvancedFraudDetectionResult document_detect_fraud_advanced(opts)
+
+Advanced AI Fraud Detection for Documents
+
+Perform advanced fraud detection and classification on input document and user context.  Input document formats supported include DOCX, PDF, PNG and JPG.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-frauddetection-api-client'
+# setup authorization
+CloudmersiveFrauddetectionApiClient.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 = CloudmersiveFrauddetectionApiClient::FraudDetectionApi.new
+
+opts = { 
+  user_email_address: 'user_email_address_example', # String | User email address for context (optional)
+  user_email_address_verified: true, # BOOLEAN | True if the user's email address was verified (optional)
+  input_file: File.new('/path/to/file.txt') # File | Input document, or photos of a document, to perform fraud detection on
+}
+
+begin
+  #Advanced AI Fraud Detection for Documents
+  result = api_instance.document_detect_fraud_advanced(opts)
+  p result
+rescue CloudmersiveFrauddetectionApiClient::ApiError => e
+  puts "Exception when calling FraudDetectionApi->document_detect_fraud_advanced: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_email_address** | **String**| User email address for context (optional) | [optional] 
+ **user_email_address_verified** | **BOOLEAN**| True if the user's email address was verified (optional) | [optional] 
+ **input_file** | **File**| Input document, or photos of a document, to perform fraud detection on | [optional] 
+
+### Return type
+
+[**AdvancedFraudDetectionResult**](AdvancedFraudDetectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+

data/docs/FraudDetectionResult.md

@@ -0,0 +1,15 @@
+# CloudmersiveFrauddetectionApiClient::FraudDetectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**clean_result** | **BOOLEAN** | True if the document is clean, false if fraud threats were found | [optional] 
+**fraud_risk_level** | **Float** | Overall fraud risk level between 0.0 and 1.0 | [optional] 
+**contains_financial_liability** | **BOOLEAN** | True if the document contains financial liability | [optional] 
+**contains_sensitive_information_collection** | **BOOLEAN** | True if the document contains sensitive data collection from the recipient | [optional] 
+**contains_asset_transfer** | **BOOLEAN** | True if the document contains an asset transfer | [optional] 
+**contains_purchase_agreement** | **BOOLEAN** | True if the document contains a purchase agreement | [optional] 
+**contains_employment_agreement** | **BOOLEAN** | True if the document contains an employment agreement | [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'
+

data/lib/cloudmersive-frauddetection-api-client/api/fraud_detection_api.rb

@@ -0,0 +1,131 @@
+=begin
+#fraudapi
+
+#Easily and directly scan and block fraudulent security threats in input.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveFrauddetectionApiClient
+  class FraudDetectionApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # AI Fraud Detection for Documents
+    # Perform fraud detection and classification on input document and user context.  Input document formats supported include DOCX, PDF, PNG and JPG.
+    # @param [Hash] opts the optional parameters
+    # @option opts [File] :input_file Input document, or photos of a document, to perform fraud detection on
+    # @return [FraudDetectionResult]
+    def document_detect_fraud(opts = {})
+      data, _status_code, _headers = document_detect_fraud_with_http_info(opts)
+      data
+    end
+
+    # AI Fraud Detection for Documents
+    # Perform fraud detection and classification on input document and user context.  Input document formats supported include DOCX, PDF, PNG and JPG.
+    # @param [Hash] opts the optional parameters
+    # @option opts [File] :input_file Input document, or photos of a document, to perform fraud detection on
+    # @return [Array<(FraudDetectionResult, Fixnum, Hash)>] FraudDetectionResult data, response status code and response headers
+    def document_detect_fraud_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FraudDetectionApi.document_detect_fraud ...'
+      end
+      # resource path
+      local_var_path = '/fraud-ai/detection/document'
+
+      # 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(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['InputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
+
+      # http body (model)
+      post_body = nil
+      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 => 'FraudDetectionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FraudDetectionApi#document_detect_fraud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Advanced AI Fraud Detection for Documents
+    # Perform advanced fraud detection and classification on input document and user context.  Input document formats supported include DOCX, PDF, PNG and JPG.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user_email_address User email address for context (optional)
+    # @option opts [BOOLEAN] :user_email_address_verified True if the user&#39;s email address was verified (optional)
+    # @option opts [File] :input_file Input document, or photos of a document, to perform fraud detection on
+    # @return [AdvancedFraudDetectionResult]
+    def document_detect_fraud_advanced(opts = {})
+      data, _status_code, _headers = document_detect_fraud_advanced_with_http_info(opts)
+      data
+    end
+
+    # Advanced AI Fraud Detection for Documents
+    # Perform advanced fraud detection and classification on input document and user context.  Input document formats supported include DOCX, PDF, PNG and JPG.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user_email_address User email address for context (optional)
+    # @option opts [BOOLEAN] :user_email_address_verified True if the user&#39;s email address was verified (optional)
+    # @option opts [File] :input_file Input document, or photos of a document, to perform fraud detection on
+    # @return [Array<(AdvancedFraudDetectionResult, Fixnum, Hash)>] AdvancedFraudDetectionResult data, response status code and response headers
+    def document_detect_fraud_advanced_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FraudDetectionApi.document_detect_fraud_advanced ...'
+      end
+      # resource path
+      local_var_path = '/fraud-ai/detection/document/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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+      header_params[:'UserEmailAddress'] = opts[:'user_email_address'] if !opts[:'user_email_address'].nil?
+      header_params[:'UserEmailAddressVerified'] = opts[:'user_email_address_verified'] if !opts[:'user_email_address_verified'].nil?
+
+      # form parameters
+      form_params = {}
+      form_params['InputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
+
+      # http body (model)
+      post_body = nil
+      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 => 'AdvancedFraudDetectionResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FraudDetectionApi#document_detect_fraud_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end