cloudmersive-dlp-api-client 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c2c3cd63b4bcd9a040547d2e0192b2bcabbfa974a968b11cd95168a0b108ff93
+  data.tar.gz: 4bcae80507c0dc6021fac639147affe1d305a14a3ba4b29ebdd02440161f694e
+SHA512:
+  metadata.gz: 60b0d96c63c0c88bbb964ccc26f95deffd8bd77373bf35846c20c6738984582a3c395bd8fba04c36501f2a66e11bf76567c9ec6b32a44dc4ea47460f230ced9b
+  data.tar.gz: 63f4b9019c2b4bceb901125f6271279e5d5e4fb6d832cb7b2f7e336f87ddc1e16aa337e5b5182d6efbb437c7ac1d9ea1343d2afbe40c982dd468f73e3a22f459

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,124 @@
+# cloudmersive-dlp-api-client
+
+CloudmersiveDlpApiClient - the Ruby gem for the dlpapi
+
+Easily and directly scan and detect sensitive data (PII) in input text.
+
+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-dlp-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-dlp-api-client-2.2.0.gem
+```
+(for development, run `gem install --dev ./cloudmersive-dlp-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-dlp-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-dlp-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-dlp-api-client'
+
+# Setup authorization
+CloudmersiveDlpApiClient.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 = CloudmersiveDlpApiClient::DetectApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpDocumentDetectionRequest.new # DlpDocumentDetectionRequest | Input request
+}
+
+begin
+  #Detect User Data in Document Image
+  result = api_instance.detect_document(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling DetectApi->detect_document: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveDlpApiClient::DetectApi* | [**detect_document**](docs/DetectApi.md#detect_document) | **POST** /dlp/detect/document | Detect User Data in Document Image
+*CloudmersiveDlpApiClient::DetectApi* | [**detect_document_advanced**](docs/DetectApi.md#detect_document_advanced) | **POST** /dlp/detect/document/advanced | Detect User Data in Document Image (Advanced)
+*CloudmersiveDlpApiClient::DetectApi* | [**detect_text**](docs/DetectApi.md#detect_text) | **POST** /dlp/detect/text | Detect User Data in Input Text
+*CloudmersiveDlpApiClient::DetectApi* | [**detect_text_advanced**](docs/DetectApi.md#detect_text_advanced) | **POST** /dlp/detect/text/advanced | Detect User Data in Input Text (Advanced)
+*CloudmersiveDlpApiClient::RedactApi* | [**redact_document**](docs/RedactApi.md#redact_document) | **POST** /dlp/redact/document | Redact User Data in Document
+*CloudmersiveDlpApiClient::RedactApi* | [**redact_document_advanced**](docs/RedactApi.md#redact_document_advanced) | **POST** /dlp/redact/document/advanced | Redact User Data in Document (Advanced)
+*CloudmersiveDlpApiClient::RedactApi* | [**redact_text**](docs/RedactApi.md#redact_text) | **POST** /dlp/redact/text | Redact User Data in Input Text
+*CloudmersiveDlpApiClient::RedactApi* | [**redact_text_advanced**](docs/RedactApi.md#redact_text_advanced) | **POST** /dlp/redact/text/advanced | Redact User Data in Input Text (Advanced)
+
+
+## Documentation for Models
+
+ - [CloudmersiveDlpApiClient::DlpAdvancedDetectionRequest](docs/DlpAdvancedDetectionRequest.md)
+ - [CloudmersiveDlpApiClient::DlpAdvancedDetectionResponse](docs/DlpAdvancedDetectionResponse.md)
+ - [CloudmersiveDlpApiClient::DlpAdvancedDocumentDetectionRequest](docs/DlpAdvancedDocumentDetectionRequest.md)
+ - [CloudmersiveDlpApiClient::DlpAdvancedDocumentRedactionRequest](docs/DlpAdvancedDocumentRedactionRequest.md)
+ - [CloudmersiveDlpApiClient::DlpAdvancedDocumentRedactionResponse](docs/DlpAdvancedDocumentRedactionResponse.md)
+ - [CloudmersiveDlpApiClient::DlpAdvancedRedactionRequest](docs/DlpAdvancedRedactionRequest.md)
+ - [CloudmersiveDlpApiClient::DlpAdvancedRedactionResponse](docs/DlpAdvancedRedactionResponse.md)
+ - [CloudmersiveDlpApiClient::DlpDetectionRequest](docs/DlpDetectionRequest.md)
+ - [CloudmersiveDlpApiClient::DlpDetectionResponse](docs/DlpDetectionResponse.md)
+ - [CloudmersiveDlpApiClient::DlpDocumentDetectionRequest](docs/DlpDocumentDetectionRequest.md)
+ - [CloudmersiveDlpApiClient::DlpDocumentRedactionRequest](docs/DlpDocumentRedactionRequest.md)
+ - [CloudmersiveDlpApiClient::DlpDocumentRedactionResponse](docs/DlpDocumentRedactionResponse.md)
+ - [CloudmersiveDlpApiClient::DlpRedactionRequest](docs/DlpRedactionRequest.md)
+ - [CloudmersiveDlpApiClient::DlpRedactionResponse](docs/DlpRedactionResponse.md)
+ - [CloudmersiveDlpApiClient::RedactedPageInfo](docs/RedactedPageInfo.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-dlp-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#dlpapi
+
+#Easily and directly scan and detect sensitive data (PII) in input text.
+
+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-dlp-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-dlp-api-client"
+  s.version     = CloudmersiveDlpApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://cloudmersive.com/dlp-data-loss-prevention-api"
+  s.summary     = "Scan input for PII."
+  s.description = "Cloudmersive Data Loss Prevention allows you to scan input for Personally Identifiable Information (PII), Personal Health Information (PHI), Personal Financial Information and other types of sensitive data.  Advanced AI is used to both detect and redact with next-generation accuracy."
+  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/DetectApi.md

@@ -0,0 +1,232 @@
+# CloudmersiveDlpApiClient::DetectApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**detect_document**](DetectApi.md#detect_document) | **POST** /dlp/detect/document | Detect User Data in Document Image
+[**detect_document_advanced**](DetectApi.md#detect_document_advanced) | **POST** /dlp/detect/document/advanced | Detect User Data in Document Image (Advanced)
+[**detect_text**](DetectApi.md#detect_text) | **POST** /dlp/detect/text | Detect User Data in Input Text
+[**detect_text_advanced**](DetectApi.md#detect_text_advanced) | **POST** /dlp/detect/text/advanced | Detect User Data in Input Text (Advanced)
+
+
+# **detect_document**
+> DlpDetectionResponse detect_document(opts)
+
+Detect User Data in Document Image
+
+Detects configurable types of user data in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-dlp-api-client'
+# setup authorization
+CloudmersiveDlpApiClient.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 = CloudmersiveDlpApiClient::DetectApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpDocumentDetectionRequest.new # DlpDocumentDetectionRequest | Input request
+}
+
+begin
+  #Detect User Data in Document Image
+  result = api_instance.detect_document(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling DetectApi->detect_document: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DlpDocumentDetectionRequest**](DlpDocumentDetectionRequest.md)| Input request | [optional] 
+
+### Return type
+
+[**DlpDetectionResponse**](DlpDetectionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **detect_document_advanced**
+> DlpAdvancedDetectionResponse detect_document_advanced(opts)
+
+Detect User Data in Document Image (Advanced)
+
+Detects 29 configurable types of user data including health-related PHI in a document image (PDF, DOCX, PNG, JPG) using Advanced AI.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-dlp-api-client'
+# setup authorization
+CloudmersiveDlpApiClient.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 = CloudmersiveDlpApiClient::DetectApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpAdvancedDocumentDetectionRequest.new # DlpAdvancedDocumentDetectionRequest | Input request
+}
+
+begin
+  #Detect User Data in Document Image (Advanced)
+  result = api_instance.detect_document_advanced(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling DetectApi->detect_document_advanced: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DlpAdvancedDocumentDetectionRequest**](DlpAdvancedDocumentDetectionRequest.md)| Input request | [optional] 
+
+### Return type
+
+[**DlpAdvancedDetectionResponse**](DlpAdvancedDetectionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **detect_text**
+> DlpDetectionResponse detect_text(opts)
+
+Detect User Data in Input Text
+
+Detects configurable types of user data in an input text string using Advanced AI.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-dlp-api-client'
+# setup authorization
+CloudmersiveDlpApiClient.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 = CloudmersiveDlpApiClient::DetectApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpDetectionRequest.new # DlpDetectionRequest | Input request
+}
+
+begin
+  #Detect User Data in Input Text
+  result = api_instance.detect_text(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling DetectApi->detect_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DlpDetectionRequest**](DlpDetectionRequest.md)| Input request | [optional] 
+
+### Return type
+
+[**DlpDetectionResponse**](DlpDetectionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **detect_text_advanced**
+> DlpAdvancedDetectionResponse detect_text_advanced(opts)
+
+Detect User Data in Input Text (Advanced)
+
+Detects 29 configurable types of user data including health-related PHI in an input text string using Advanced AI.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-dlp-api-client'
+# setup authorization
+CloudmersiveDlpApiClient.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 = CloudmersiveDlpApiClient::DetectApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpAdvancedDetectionRequest.new # DlpAdvancedDetectionRequest | Input request
+}
+
+begin
+  #Detect User Data in Input Text (Advanced)
+  result = api_instance.detect_text_advanced(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling DetectApi->detect_text_advanced: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DlpAdvancedDetectionRequest**](DlpAdvancedDetectionRequest.md)| Input request | [optional] 
+
+### Return type
+
+[**DlpAdvancedDetectionResponse**](DlpAdvancedDetectionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+

data/docs/DlpAdvancedDetectionRequest.md

@@ -0,0 +1,43 @@
+# CloudmersiveDlpApiClient::DlpAdvancedDetectionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_text** | **String** | Text to scan for PII and sensitive data. | [optional] 
+**allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the input text and not flag them as PII. | [optional] 
+**allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the input text and not flag them as PII. | [optional] 
+**allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the input text and not flag them as PII. | [optional] 
+**allow_person_name** | **BOOLEAN** | Set to true to allow person names in the input text and not flag them as PII. | [optional] 
+**allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the input text and not flag them as PII. | [optional] 
+**allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the input text and not flag them as PII. | [optional] 
+**allow_drivers_license** | **BOOLEAN** | Set to true to allow drivers license numbers in the input text and not flag them as PII. | [optional] 
+**allow_social_security_number** | **BOOLEAN** | Set to true to allow social security numbers in the input text and not flag them as PII. | [optional] 
+**allow_taxpayer_id** | **BOOLEAN** | Set to true to allow taxpayer IDs in the input text and not flag them as PII. | [optional] 
+**allow_credit_card_number** | **BOOLEAN** | Set to true to allow credit card numbers in the input text and not flag them as PII. | [optional] 
+**allow_credit_card_expiration_date** | **BOOLEAN** | Set to true to allow credit card expiration dates in the input text and not flag them as PII. | [optional] 
+**allow_credit_card_verification_code** | **BOOLEAN** | Set to true to allow credit card verification codes in the input text and not flag them as PII. | [optional] 
+**allow_bank_account_number** | **BOOLEAN** | Set to true to allow bank account numbers in the input text and not flag them as PII. | [optional] 
+**allow_iban** | **BOOLEAN** | Set to true to allow IBANs in the input text and not flag them as PII. | [optional] 
+**allow_health_insurance_number** | **BOOLEAN** | Set to true to allow health insurance numbers in the input text and not flag them as PII. | [optional] 
+**allow_bearer_token** | **BOOLEAN** | Set to true to allow bearer tokens in the input text and not flag them as PII. | [optional] 
+**allow_http_cookie** | **BOOLEAN** | Set to true to allow HTTP cookies in the input text and not flag them as PII. | [optional] 
+**allow_private_keys** | **BOOLEAN** | Set to true to allow private keys in the input text and not flag them as PII. | [optional] 
+**allow_credentials** | **BOOLEAN** | Set to true to allow credentials (usernames/passwords) in the input text and not flag them as PII. | [optional] 
+**allow_deep_web_urls** | **BOOLEAN** | Set to true to allow deep web URLs (.onion) in the input text and not flag them as PII. | [optional] 
+**allow_source_code** | **BOOLEAN** | Set to true to allow source code in the input text and not flag it as sensitive data. | [optional] 
+**allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the input text and not flag them as PII. | [optional] 
+**allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the input text and not flag them as PII. | [optional] 
+**allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the input text and not flag them as PHI. | [optional] 
+**allow_health_injury_or_disease** | **BOOLEAN** | Set to true to allow references to injuries or diseases in the input text and not flag them as PHI. | [optional] 
+**allow_health_type_of_treatment** | **BOOLEAN** | Set to true to allow references to types of medical treatment in the input text and not flag them as PHI. | [optional] 
+**allow_health_date_and_time_of_treatment** | **BOOLEAN** | Set to true to allow dates and times of medical treatment in the input text and not flag them as PHI. | [optional] 
+**allow_health_plan_beneficiary_number** | **BOOLEAN** | Set to true to allow health plan beneficiary numbers in the input text and not flag them as PHI. | [optional] 
+**allow_health_payments_made_for_treatment** | **BOOLEAN** | Set to true to allow payments made for medical treatment in the input text and not flag them as PHI. | [optional] 
+**allow_vehicle_id** | **BOOLEAN** | Set to true to allow vehicle identifiers (e.g. license plates, VINs) in the input text and not flag them as PII. | [optional] 
+**allow_device_id** | **BOOLEAN** | Set to true to allow device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs) in the input text and not flag them as PII. | [optional] 
+**allow_names_of_relatives** | **BOOLEAN** | Set to true to allow names of relatives in the input text and not flag them as PII. | [optional] 
+**allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the input text and not flag them as PHI. | [optional] 
+**allow_biometrics** | **BOOLEAN** | Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the input text and not flag them as PII. | [optional] 
+**provide_analysis_rationale** | **BOOLEAN** | Set to true to include a natural language rationale explaining why each detection conclusion was formed. | [optional] 
+
+

data/docs/DlpAdvancedDetectionResponse.md

@@ -0,0 +1,44 @@
+# CloudmersiveDlpApiClient::DlpAdvancedDetectionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_result** | **BOOLEAN** | True if no disallowed PII or sensitive data types were detected in the input text; false if any disallowed type was found. | [optional] 
+**contains_email_address** | **BOOLEAN** | True if the input text contains email addresses. | [optional] 
+**contains_phone_number** | **BOOLEAN** | True if the input text contains phone numbers. | [optional] 
+**contains_street_address** | **BOOLEAN** | True if the input text contains street addresses. | [optional] 
+**contains_person_name** | **BOOLEAN** | True if the input text contains person names. | [optional] 
+**contains_birth_date** | **BOOLEAN** | True if the input text contains birth dates. | [optional] 
+**contains_passport_number** | **BOOLEAN** | True if the input text contains passport numbers. | [optional] 
+**contains_drivers_license** | **BOOLEAN** | True if the input text contains drivers license numbers. | [optional] 
+**contains_social_security_number** | **BOOLEAN** | True if the input text contains social security numbers. | [optional] 
+**contains_taxpayer_id** | **BOOLEAN** | True if the input text contains taxpayer IDs. | [optional] 
+**contains_credit_card_number** | **BOOLEAN** | True if the input text contains credit card numbers. | [optional] 
+**contains_credit_card_expiration_date** | **BOOLEAN** | True if the input text contains credit card expiration dates. | [optional] 
+**contains_credit_card_verification_code** | **BOOLEAN** | True if the input text contains credit card verification codes. | [optional] 
+**contains_bank_account_number** | **BOOLEAN** | True if the input text contains bank account numbers. | [optional] 
+**contains_iban** | **BOOLEAN** | True if the input text contains IBANs. | [optional] 
+**contains_health_insurance_number** | **BOOLEAN** | True if the input text contains health insurance numbers. | [optional] 
+**contains_bearer_token** | **BOOLEAN** | True if the input text contains bearer tokens. | [optional] 
+**contains_http_cookie** | **BOOLEAN** | True if the input text contains HTTP cookies. | [optional] 
+**contains_private_keys** | **BOOLEAN** | True if the input text contains private keys. | [optional] 
+**contains_credentials** | **BOOLEAN** | True if the input text contains credentials (usernames/passwords). | [optional] 
+**contains_deep_web_urls** | **BOOLEAN** | True if the input text contains deep web URLs (.onion). | [optional] 
+**contains_source_code** | **BOOLEAN** | True if the input text contains source code. | [optional] 
+**contains_ip_address** | **BOOLEAN** | True if the input text contains IP addresses. | [optional] 
+**contains_mac_address** | **BOOLEAN** | True if the input text contains MAC addresses. | [optional] 
+**contains_health_insurance_member_id** | **BOOLEAN** | True if the input text contains health insurance member IDs. | [optional] 
+**contains_health_injury_or_disease** | **BOOLEAN** | True if the input text contains references to injuries or diseases. | [optional] 
+**contains_health_type_of_treatment** | **BOOLEAN** | True if the input text contains references to types of medical treatment. | [optional] 
+**contains_health_date_and_time_of_treatment** | **BOOLEAN** | True if the input text contains dates and times of medical treatment. | [optional] 
+**contains_health_plan_beneficiary_number** | **BOOLEAN** | True if the input text contains health plan beneficiary numbers. | [optional] 
+**contains_health_payments_made_for_treatment** | **BOOLEAN** | True if the input text contains payments made for medical treatment. | [optional] 
+**contains_faces** | **BOOLEAN** | True if the document contains identifiable human faces. | [optional] 
+**contains_vehicle_id** | **BOOLEAN** | True if the input contains vehicle identifiers (e.g. license plates, VINs). | [optional] 
+**contains_device_id** | **BOOLEAN** | True if the input contains device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs). | [optional] 
+**contains_names_of_relatives** | **BOOLEAN** | True if the input contains names of relatives. | [optional] 
+**contains_health_universal_record_locator** | **BOOLEAN** | True if the input contains health universal record locators (URLs). | [optional] 
+**contains_biometrics** | **BOOLEAN** | True if the input contains biometric data references (e.g. fingerprints, retinal scans, voiceprints). | [optional] 
+**analysis_rationale** | **String** | Rationale for why the conclusion was formed. Only populated when ProvideAnalysisRationale is set to true in the request. | [optional] 
+
+

data/docs/DlpAdvancedDocumentDetectionRequest.md

@@ -0,0 +1,46 @@
+# CloudmersiveDlpApiClient::DlpAdvancedDocumentDetectionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file** | **String** | Document file bytes (PDF, DOCX, PNG, or JPG) to scan for PII and sensitive data. | [optional] 
+**file_name** | **String** | Optional. Name of the input file including extension, used for format detection. If not provided, format is detected from file contents. | [optional] 
+**recognition_mode** | **String** | Optional. Recognition mode for image processing. Options: null (default), \"Fast\", \"FastPlus\", \"FastMini\". | [optional] 
+**allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the document and not flag them as PII. | [optional] 
+**allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the document and not flag them as PII. | [optional] 
+**allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the document and not flag them as PII. | [optional] 
+**allow_person_name** | **BOOLEAN** | Set to true to allow person names in the document and not flag them as PII. | [optional] 
+**allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the document and not flag them as PII. | [optional] 
+**allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the document and not flag them as PII. | [optional] 
+**allow_drivers_license** | **BOOLEAN** | Set to true to allow drivers license numbers in the document and not flag them as PII. | [optional] 
+**allow_social_security_number** | **BOOLEAN** | Set to true to allow social security numbers in the document and not flag them as PII. | [optional] 
+**allow_taxpayer_id** | **BOOLEAN** | Set to true to allow taxpayer IDs in the document and not flag them as PII. | [optional] 
+**allow_credit_card_number** | **BOOLEAN** | Set to true to allow credit card numbers in the document and not flag them as PII. | [optional] 
+**allow_credit_card_expiration_date** | **BOOLEAN** | Set to true to allow credit card expiration dates in the document and not flag them as PII. | [optional] 
+**allow_credit_card_verification_code** | **BOOLEAN** | Set to true to allow credit card verification codes in the document and not flag them as PII. | [optional] 
+**allow_bank_account_number** | **BOOLEAN** | Set to true to allow bank account numbers in the document and not flag them as PII. | [optional] 
+**allow_iban** | **BOOLEAN** | Set to true to allow IBANs in the document and not flag them as PII. | [optional] 
+**allow_health_insurance_number** | **BOOLEAN** | Set to true to allow health insurance numbers in the document and not flag them as PII. | [optional] 
+**allow_bearer_token** | **BOOLEAN** | Set to true to allow bearer tokens in the document and not flag them as PII. | [optional] 
+**allow_http_cookie** | **BOOLEAN** | Set to true to allow HTTP cookies in the document and not flag them as PII. | [optional] 
+**allow_private_keys** | **BOOLEAN** | Set to true to allow private keys in the document and not flag them as PII. | [optional] 
+**allow_credentials** | **BOOLEAN** | Set to true to allow credentials (usernames/passwords) in the document and not flag them as PII. | [optional] 
+**allow_deep_web_urls** | **BOOLEAN** | Set to true to allow deep web URLs (.onion) in the document and not flag them as PII. | [optional] 
+**allow_source_code** | **BOOLEAN** | Set to true to allow source code in the document and not flag it as sensitive data. | [optional] 
+**allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the document and not flag them as PII. | [optional] 
+**allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the document and not flag them as PII. | [optional] 
+**allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the document and not flag them as PHI. | [optional] 
+**allow_health_injury_or_disease** | **BOOLEAN** | Set to true to allow references to injuries or diseases in the document and not flag them as PHI. | [optional] 
+**allow_health_type_of_treatment** | **BOOLEAN** | Set to true to allow references to types of medical treatment in the document and not flag them as PHI. | [optional] 
+**allow_health_date_and_time_of_treatment** | **BOOLEAN** | Set to true to allow dates and times of medical treatment in the document and not flag them as PHI. | [optional] 
+**allow_health_plan_beneficiary_number** | **BOOLEAN** | Set to true to allow health plan beneficiary numbers in the document and not flag them as PHI. | [optional] 
+**allow_health_payments_made_for_treatment** | **BOOLEAN** | Set to true to allow payments made for medical treatment in the document and not flag them as PHI. | [optional] 
+**allow_faces** | **BOOLEAN** | Set to true to allow identifiable human faces in the document and not flag them as PII. | [optional] 
+**allow_vehicle_id** | **BOOLEAN** | Set to true to allow vehicle identifiers (e.g. license plates, VINs) in the document and not flag them as PII. | [optional] 
+**allow_device_id** | **BOOLEAN** | Set to true to allow device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs) in the document and not flag them as PII. | [optional] 
+**allow_names_of_relatives** | **BOOLEAN** | Set to true to allow names of relatives in the document and not flag them as PII. | [optional] 
+**allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the document and not flag them as PHI. | [optional] 
+**allow_biometrics** | **BOOLEAN** | Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the document and not flag them as PII. | [optional] 
+**provide_analysis_rationale** | **BOOLEAN** | Set to true to include a natural language rationale explaining why each detection conclusion was formed. | [optional] 
+
+

data/docs/DlpAdvancedDocumentRedactionRequest.md

@@ -0,0 +1,47 @@
+# CloudmersiveDlpApiClient::DlpAdvancedDocumentRedactionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_file** | **String** | Document file bytes (PDF, DOCX, PNG, or JPG) to scan for PII and redact. | [optional] 
+**file_name** | **String** | Optional. Name of the input file including extension, used for format detection. If not provided, format is detected from file contents. | [optional] 
+**recognition_mode** | **String** | Optional. Recognition mode for image processing. Options: null (default), \"Fast\", \"FastPlus\", \"FastMini\". | [optional] 
+**redaction_mode** | **String** | Redaction mode for PII regions. Options: \"BlackOut\" (default) draws black rectangles over PII rows, \"Blur\" applies Gaussian blur to PII rows, \"BlackOutEntirePage\" blacks out entire dirty pages, \"BlurEntirePage\" blurs entire dirty pages. | [optional] 
+**allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the document and not redact them. | [optional] 
+**allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the document and not redact them. | [optional] 
+**allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the document and not redact them. | [optional] 
+**allow_person_name** | **BOOLEAN** | Set to true to allow person names in the document and not redact them. | [optional] 
+**allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the document and not redact them. | [optional] 
+**allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the document and not redact them. | [optional] 
+**allow_drivers_license** | **BOOLEAN** | Set to true to allow drivers license numbers in the document and not redact them. | [optional] 
+**allow_social_security_number** | **BOOLEAN** | Set to true to allow social security numbers in the document and not redact them. | [optional] 
+**allow_taxpayer_id** | **BOOLEAN** | Set to true to allow taxpayer IDs in the document and not redact them. | [optional] 
+**allow_credit_card_number** | **BOOLEAN** | Set to true to allow credit card numbers in the document and not redact them. | [optional] 
+**allow_credit_card_expiration_date** | **BOOLEAN** | Set to true to allow credit card expiration dates in the document and not redact them. | [optional] 
+**allow_credit_card_verification_code** | **BOOLEAN** | Set to true to allow credit card verification codes in the document and not redact them. | [optional] 
+**allow_bank_account_number** | **BOOLEAN** | Set to true to allow bank account numbers in the document and not redact them. | [optional] 
+**allow_iban** | **BOOLEAN** | Set to true to allow IBANs in the document and not redact them. | [optional] 
+**allow_health_insurance_number** | **BOOLEAN** | Set to true to allow health insurance numbers in the document and not redact them. | [optional] 
+**allow_bearer_token** | **BOOLEAN** | Set to true to allow bearer tokens in the document and not redact them. | [optional] 
+**allow_http_cookie** | **BOOLEAN** | Set to true to allow HTTP cookies in the document and not redact them. | [optional] 
+**allow_private_keys** | **BOOLEAN** | Set to true to allow private keys in the document and not redact them. | [optional] 
+**allow_credentials** | **BOOLEAN** | Set to true to allow credentials (usernames/passwords) in the document and not redact them. | [optional] 
+**allow_deep_web_urls** | **BOOLEAN** | Set to true to allow deep web URLs (.onion) in the document and not redact them. | [optional] 
+**allow_source_code** | **BOOLEAN** | Set to true to allow source code in the document and not redact it. | [optional] 
+**allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the document and not redact them. | [optional] 
+**allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the document and not redact them. | [optional] 
+**allow_health_insurance_member_id** | **BOOLEAN** | Set to true to allow health insurance member IDs in the document and not redact them. | [optional] 
+**allow_health_injury_or_disease** | **BOOLEAN** | Set to true to allow references to injuries or diseases in the document and not redact them. | [optional] 
+**allow_health_type_of_treatment** | **BOOLEAN** | Set to true to allow references to types of medical treatment in the document and not redact them. | [optional] 
+**allow_health_date_and_time_of_treatment** | **BOOLEAN** | Set to true to allow dates and times of medical treatment in the document and not redact them. | [optional] 
+**allow_health_plan_beneficiary_number** | **BOOLEAN** | Set to true to allow health plan beneficiary numbers in the document and not redact them. | [optional] 
+**allow_health_payments_made_for_treatment** | **BOOLEAN** | Set to true to allow payments made for medical treatment in the document and not redact them. | [optional] 
+**allow_faces** | **BOOLEAN** | Set to true to allow identifiable human faces in the document and not redact them. | [optional] 
+**allow_vehicle_id** | **BOOLEAN** | Set to true to allow vehicle identifiers (e.g. license plates, VINs) in the document and not redact them. | [optional] 
+**allow_device_id** | **BOOLEAN** | Set to true to allow device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs) in the document and not redact them. | [optional] 
+**allow_names_of_relatives** | **BOOLEAN** | Set to true to allow names of relatives in the document and not redact them. | [optional] 
+**allow_health_universal_record_locator** | **BOOLEAN** | Set to true to allow health universal record locators (URLs) in the document and not redact them. | [optional] 
+**allow_biometrics** | **BOOLEAN** | Set to true to allow biometric data references (e.g. fingerprints, retinal scans, voiceprints) in the document and not redact them. | [optional] 
+**provide_analysis_rationale** | **BOOLEAN** | Set to true to include a natural language rationale explaining why each detection conclusion was formed. | [optional] 
+
+