cloudmersive-dlp-api-client 2.2.0

data/docs/DlpAdvancedDocumentRedactionResponse.md

@@ -0,0 +1,46 @@
+# CloudmersiveDlpApiClient::DlpAdvancedDocumentRedactionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redacted_document** | **String** | The redacted document as a rasterized PDF with PII regions redacted, or the original file if no disallowed PII was found. | [optional] 
+**clean_result** | **BOOLEAN** | True if no disallowed PII or sensitive data types were detected; false if any disallowed type was found and redacted. | [optional] 
+**contains_email_address** | **BOOLEAN** | True if the document contains email addresses. | [optional] 
+**contains_phone_number** | **BOOLEAN** | True if the document contains phone numbers. | [optional] 
+**contains_street_address** | **BOOLEAN** | True if the document contains street addresses. | [optional] 
+**contains_person_name** | **BOOLEAN** | True if the document contains person names. | [optional] 
+**contains_birth_date** | **BOOLEAN** | True if the document contains birth dates. | [optional] 
+**contains_passport_number** | **BOOLEAN** | True if the document contains passport numbers. | [optional] 
+**contains_drivers_license** | **BOOLEAN** | True if the document contains drivers license numbers. | [optional] 
+**contains_social_security_number** | **BOOLEAN** | True if the document contains social security numbers. | [optional] 
+**contains_taxpayer_id** | **BOOLEAN** | True if the document contains taxpayer IDs. | [optional] 
+**contains_credit_card_number** | **BOOLEAN** | True if the document contains credit card numbers. | [optional] 
+**contains_credit_card_expiration_date** | **BOOLEAN** | True if the document contains credit card expiration dates. | [optional] 
+**contains_credit_card_verification_code** | **BOOLEAN** | True if the document contains credit card verification codes. | [optional] 
+**contains_bank_account_number** | **BOOLEAN** | True if the document contains bank account numbers. | [optional] 
+**contains_iban** | **BOOLEAN** | True if the document contains IBANs. | [optional] 
+**contains_health_insurance_number** | **BOOLEAN** | True if the document contains health insurance numbers. | [optional] 
+**contains_bearer_token** | **BOOLEAN** | True if the document contains bearer tokens. | [optional] 
+**contains_http_cookie** | **BOOLEAN** | True if the document contains HTTP cookies. | [optional] 
+**contains_private_keys** | **BOOLEAN** | True if the document contains private keys. | [optional] 
+**contains_credentials** | **BOOLEAN** | True if the document contains credentials (usernames/passwords). | [optional] 
+**contains_deep_web_urls** | **BOOLEAN** | True if the document contains deep web URLs (.onion). | [optional] 
+**contains_source_code** | **BOOLEAN** | True if the document contains source code. | [optional] 
+**contains_ip_address** | **BOOLEAN** | True if the document contains IP addresses. | [optional] 
+**contains_mac_address** | **BOOLEAN** | True if the document contains MAC addresses. | [optional] 
+**contains_health_insurance_member_id** | **BOOLEAN** | True if the document contains health insurance member IDs. | [optional] 
+**contains_health_injury_or_disease** | **BOOLEAN** | True if the document contains references to injuries or diseases. | [optional] 
+**contains_health_type_of_treatment** | **BOOLEAN** | True if the document contains references to types of medical treatment. | [optional] 
+**contains_health_date_and_time_of_treatment** | **BOOLEAN** | True if the document contains dates and times of medical treatment. | [optional] 
+**contains_health_plan_beneficiary_number** | **BOOLEAN** | True if the document contains health plan beneficiary numbers. | [optional] 
+**contains_health_payments_made_for_treatment** | **BOOLEAN** | True if the document 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 document contains vehicle identifiers (e.g. license plates, VINs). | [optional] 
+**contains_device_id** | **BOOLEAN** | True if the document contains device identifiers (e.g. serial numbers, IMEIs, MAC-level device IDs). | [optional] 
+**contains_names_of_relatives** | **BOOLEAN** | True if the document contains names of relatives. | [optional] 
+**contains_health_universal_record_locator** | **BOOLEAN** | True if the document contains health universal record locators (URLs). | [optional] 
+**contains_biometrics** | **BOOLEAN** | True if the document contains biometric data references (e.g. fingerprints, retinal scans, voiceprints). | [optional] 
+**pages_redacted** | [**Array<RedactedPageInfo>**](RedactedPageInfo.md) | List of pages that were redacted (had PII regions redacted). | [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/DlpAdvancedRedactionRequest.md

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

data/docs/DlpAdvancedRedactionResponse.md

@@ -0,0 +1,44 @@
+# CloudmersiveDlpApiClient::DlpAdvancedRedactionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redacted_text** | **String** | The redacted text with PII removed or replaced, or the original text if no disallowed PII was found. | [optional] 
+**clean_result** | **BOOLEAN** | True if no disallowed PII or sensitive data types were detected; false if any disallowed type was found and redacted. | [optional] 
+**contains_email_address** | **BOOLEAN** | True if the input contains email addresses. | [optional] 
+**contains_phone_number** | **BOOLEAN** | True if the input contains phone numbers. | [optional] 
+**contains_street_address** | **BOOLEAN** | True if the input contains street addresses. | [optional] 
+**contains_person_name** | **BOOLEAN** | True if the input contains person names. | [optional] 
+**contains_birth_date** | **BOOLEAN** | True if the input contains birth dates. | [optional] 
+**contains_passport_number** | **BOOLEAN** | True if the input contains passport numbers. | [optional] 
+**contains_drivers_license** | **BOOLEAN** | True if the input contains drivers license numbers. | [optional] 
+**contains_social_security_number** | **BOOLEAN** | True if the input contains social security numbers. | [optional] 
+**contains_taxpayer_id** | **BOOLEAN** | True if the input contains taxpayer IDs. | [optional] 
+**contains_credit_card_number** | **BOOLEAN** | True if the input contains credit card numbers. | [optional] 
+**contains_credit_card_expiration_date** | **BOOLEAN** | True if the input contains credit card expiration dates. | [optional] 
+**contains_credit_card_verification_code** | **BOOLEAN** | True if the input contains credit card verification codes. | [optional] 
+**contains_bank_account_number** | **BOOLEAN** | True if the input contains bank account numbers. | [optional] 
+**contains_iban** | **BOOLEAN** | True if the input contains IBANs. | [optional] 
+**contains_health_insurance_number** | **BOOLEAN** | True if the input contains health insurance numbers. | [optional] 
+**contains_bearer_token** | **BOOLEAN** | True if the input contains bearer tokens. | [optional] 
+**contains_http_cookie** | **BOOLEAN** | True if the input contains HTTP cookies. | [optional] 
+**contains_private_keys** | **BOOLEAN** | True if the input contains private keys. | [optional] 
+**contains_credentials** | **BOOLEAN** | True if the input contains credentials (usernames/passwords). | [optional] 
+**contains_deep_web_urls** | **BOOLEAN** | True if the input contains deep web URLs (.onion). | [optional] 
+**contains_source_code** | **BOOLEAN** | True if the input contains source code. | [optional] 
+**contains_ip_address** | **BOOLEAN** | True if the input contains IP addresses. | [optional] 
+**contains_mac_address** | **BOOLEAN** | True if the input contains MAC addresses. | [optional] 
+**contains_health_insurance_member_id** | **BOOLEAN** | True if the input contains health insurance member IDs. | [optional] 
+**contains_health_injury_or_disease** | **BOOLEAN** | True if the input contains references to injuries or diseases. | [optional] 
+**contains_health_type_of_treatment** | **BOOLEAN** | True if the input contains references to types of medical treatment. | [optional] 
+**contains_health_date_and_time_of_treatment** | **BOOLEAN** | True if the input contains dates and times of medical treatment. | [optional] 
+**contains_health_plan_beneficiary_number** | **BOOLEAN** | True if the input contains health plan beneficiary numbers. | [optional] 
+**contains_health_payments_made_for_treatment** | **BOOLEAN** | True if the input contains payments made for medical treatment. | [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/DlpDetectionRequest.md

@@ -0,0 +1,31 @@
+# CloudmersiveDlpApiClient::DlpDetectionRequest
+
+## 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] 
+
+

data/docs/DlpDetectionResponse.md

@@ -0,0 +1,31 @@
+# CloudmersiveDlpApiClient::DlpDetectionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clean_result** | **BOOLEAN** | True if no disallowed PII or sensitive data types were detected; false if any disallowed type was found. | [optional] 
+**contains_email_address** | **BOOLEAN** | True if the input contains email addresses. | [optional] 
+**contains_phone_number** | **BOOLEAN** | True if the input contains phone numbers. | [optional] 
+**contains_street_address** | **BOOLEAN** | True if the input contains street addresses. | [optional] 
+**contains_person_name** | **BOOLEAN** | True if the input contains person names. | [optional] 
+**contains_birth_date** | **BOOLEAN** | True if the input contains birth dates. | [optional] 
+**contains_passport_number** | **BOOLEAN** | True if the input contains passport numbers. | [optional] 
+**contains_drivers_license** | **BOOLEAN** | True if the input contains drivers license numbers. | [optional] 
+**contains_social_security_number** | **BOOLEAN** | True if the input contains social security numbers. | [optional] 
+**contains_taxpayer_id** | **BOOLEAN** | True if the input contains taxpayer IDs. | [optional] 
+**contains_credit_card_number** | **BOOLEAN** | True if the input contains credit card numbers. | [optional] 
+**contains_credit_card_expiration_date** | **BOOLEAN** | True if the input contains credit card expiration dates. | [optional] 
+**contains_credit_card_verification_code** | **BOOLEAN** | True if the input contains credit card verification codes. | [optional] 
+**contains_bank_account_number** | **BOOLEAN** | True if the input contains bank account numbers. | [optional] 
+**contains_iban** | **BOOLEAN** | True if the input contains IBANs. | [optional] 
+**contains_health_insurance_number** | **BOOLEAN** | True if the input contains health insurance numbers. | [optional] 
+**contains_bearer_token** | **BOOLEAN** | True if the input contains bearer tokens. | [optional] 
+**contains_http_cookie** | **BOOLEAN** | True if the input contains HTTP cookies. | [optional] 
+**contains_private_keys** | **BOOLEAN** | True if the input contains private keys. | [optional] 
+**contains_credentials** | **BOOLEAN** | True if the input contains credentials (usernames/passwords). | [optional] 
+**contains_deep_web_urls** | **BOOLEAN** | True if the input contains deep web URLs (.onion). | [optional] 
+**contains_source_code** | **BOOLEAN** | True if the input contains source code. | [optional] 
+**contains_ip_address** | **BOOLEAN** | True if the input contains IP addresses. | [optional] 
+**contains_mac_address** | **BOOLEAN** | True if the input contains MAC addresses. | [optional] 
+
+

data/docs/DlpDocumentDetectionRequest.md

@@ -0,0 +1,33 @@
+# CloudmersiveDlpApiClient::DlpDocumentDetectionRequest
+
+## 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] 
+
+

data/docs/DlpDocumentRedactionRequest.md

@@ -0,0 +1,34 @@
+# CloudmersiveDlpApiClient::DlpDocumentRedactionRequest
+
+## 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] 
+
+

data/docs/DlpDocumentRedactionResponse.md

@@ -0,0 +1,33 @@
+# CloudmersiveDlpApiClient::DlpDocumentRedactionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redacted_document** | **String** | The redacted document as a rasterized PDF with PII regions blurred, or the original file if no disallowed PII was found. | [optional] 
+**clean_result** | **BOOLEAN** | True if no disallowed PII or sensitive data types were detected; false if any disallowed type was found and redacted. | [optional] 
+**contains_email_address** | **BOOLEAN** | True if the document contains email addresses. | [optional] 
+**contains_phone_number** | **BOOLEAN** | True if the document contains phone numbers. | [optional] 
+**contains_street_address** | **BOOLEAN** | True if the document contains street addresses. | [optional] 
+**contains_person_name** | **BOOLEAN** | True if the document contains person names. | [optional] 
+**contains_birth_date** | **BOOLEAN** | True if the document contains birth dates. | [optional] 
+**contains_passport_number** | **BOOLEAN** | True if the document contains passport numbers. | [optional] 
+**contains_drivers_license** | **BOOLEAN** | True if the document contains drivers license numbers. | [optional] 
+**contains_social_security_number** | **BOOLEAN** | True if the document contains social security numbers. | [optional] 
+**contains_taxpayer_id** | **BOOLEAN** | True if the document contains taxpayer IDs. | [optional] 
+**contains_credit_card_number** | **BOOLEAN** | True if the document contains credit card numbers. | [optional] 
+**contains_credit_card_expiration_date** | **BOOLEAN** | True if the document contains credit card expiration dates. | [optional] 
+**contains_credit_card_verification_code** | **BOOLEAN** | True if the document contains credit card verification codes. | [optional] 
+**contains_bank_account_number** | **BOOLEAN** | True if the document contains bank account numbers. | [optional] 
+**contains_iban** | **BOOLEAN** | True if the document contains IBANs. | [optional] 
+**contains_health_insurance_number** | **BOOLEAN** | True if the document contains health insurance numbers. | [optional] 
+**contains_bearer_token** | **BOOLEAN** | True if the document contains bearer tokens. | [optional] 
+**contains_http_cookie** | **BOOLEAN** | True if the document contains HTTP cookies. | [optional] 
+**contains_private_keys** | **BOOLEAN** | True if the document contains private keys. | [optional] 
+**contains_credentials** | **BOOLEAN** | True if the document contains credentials (usernames/passwords). | [optional] 
+**contains_deep_web_urls** | **BOOLEAN** | True if the document contains deep web URLs (.onion). | [optional] 
+**contains_source_code** | **BOOLEAN** | True if the document contains source code. | [optional] 
+**contains_ip_address** | **BOOLEAN** | True if the document contains IP addresses. | [optional] 
+**contains_mac_address** | **BOOLEAN** | True if the document contains MAC addresses. | [optional] 
+**pages_redacted** | [**Array<RedactedPageInfo>**](RedactedPageInfo.md) | List of pages that were redacted (had PII regions blurred). | [optional] 
+
+

data/docs/DlpRedactionRequest.md

@@ -0,0 +1,32 @@
+# CloudmersiveDlpApiClient::DlpRedactionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_text** | **String** | Text to scan for PII and redact sensitive data from. | [optional] 
+**allow_email_address** | **BOOLEAN** | Set to true to allow email addresses in the input text and not redact them. | [optional] 
+**allow_phone_number** | **BOOLEAN** | Set to true to allow phone numbers in the input text and not redact them. | [optional] 
+**allow_street_address** | **BOOLEAN** | Set to true to allow street addresses in the input text and not redact them. | [optional] 
+**allow_person_name** | **BOOLEAN** | Set to true to allow person names in the input text and not redact them. | [optional] 
+**allow_birth_date** | **BOOLEAN** | Set to true to allow birth dates in the input text and not redact them. | [optional] 
+**allow_passport_number** | **BOOLEAN** | Set to true to allow passport numbers in the input text and not redact them. | [optional] 
+**allow_drivers_license** | **BOOLEAN** | Set to true to allow drivers license numbers in the input text and not redact them. | [optional] 
+**allow_social_security_number** | **BOOLEAN** | Set to true to allow social security numbers in the input text and not redact them. | [optional] 
+**allow_taxpayer_id** | **BOOLEAN** | Set to true to allow taxpayer IDs in the input text and not redact them. | [optional] 
+**allow_credit_card_number** | **BOOLEAN** | Set to true to allow credit card numbers in the input text and not redact them. | [optional] 
+**allow_credit_card_expiration_date** | **BOOLEAN** | Set to true to allow credit card expiration dates in the input text and not redact them. | [optional] 
+**allow_credit_card_verification_code** | **BOOLEAN** | Set to true to allow credit card verification codes in the input text and not redact them. | [optional] 
+**allow_bank_account_number** | **BOOLEAN** | Set to true to allow bank account numbers in the input text and not redact them. | [optional] 
+**allow_iban** | **BOOLEAN** | Set to true to allow IBANs in the input text and not redact them. | [optional] 
+**allow_health_insurance_number** | **BOOLEAN** | Set to true to allow health insurance numbers in the input text and not redact them. | [optional] 
+**allow_bearer_token** | **BOOLEAN** | Set to true to allow bearer tokens in the input text and not redact them. | [optional] 
+**allow_http_cookie** | **BOOLEAN** | Set to true to allow HTTP cookies in the input text and not redact them. | [optional] 
+**allow_private_keys** | **BOOLEAN** | Set to true to allow private keys in the input text and not redact them. | [optional] 
+**allow_credentials** | **BOOLEAN** | Set to true to allow credentials (usernames/passwords) in the input text and not redact them. | [optional] 
+**allow_deep_web_urls** | **BOOLEAN** | Set to true to allow deep web URLs (.onion) in the input text and not redact them. | [optional] 
+**allow_source_code** | **BOOLEAN** | Set to true to allow source code in the input text and not redact it. | [optional] 
+**allow_ip_address** | **BOOLEAN** | Set to true to allow IP addresses in the input text and not redact them. | [optional] 
+**allow_mac_address** | **BOOLEAN** | Set to true to allow MAC addresses in the input text and not redact them. | [optional] 
+**redaction_mode** | **String** | Redaction mode: \"Delete\" to remove PII entirely, or \"ReplaceWithAsterisk\" to replace PII characters with asterisks (*). | [optional] 
+
+

data/docs/DlpRedactionResponse.md

@@ -0,0 +1,32 @@
+# CloudmersiveDlpApiClient::DlpRedactionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redacted_text** | **String** | The redacted text with PII removed or replaced, or the original text if no disallowed PII was found. | [optional] 
+**clean_result** | **BOOLEAN** | True if no disallowed PII or sensitive data types were detected; false if any disallowed type was found and redacted. | [optional] 
+**contains_email_address** | **BOOLEAN** | True if the input contains email addresses. | [optional] 
+**contains_phone_number** | **BOOLEAN** | True if the input contains phone numbers. | [optional] 
+**contains_street_address** | **BOOLEAN** | True if the input contains street addresses. | [optional] 
+**contains_person_name** | **BOOLEAN** | True if the input contains person names. | [optional] 
+**contains_birth_date** | **BOOLEAN** | True if the input contains birth dates. | [optional] 
+**contains_passport_number** | **BOOLEAN** | True if the input contains passport numbers. | [optional] 
+**contains_drivers_license** | **BOOLEAN** | True if the input contains drivers license numbers. | [optional] 
+**contains_social_security_number** | **BOOLEAN** | True if the input contains social security numbers. | [optional] 
+**contains_taxpayer_id** | **BOOLEAN** | True if the input contains taxpayer IDs. | [optional] 
+**contains_credit_card_number** | **BOOLEAN** | True if the input contains credit card numbers. | [optional] 
+**contains_credit_card_expiration_date** | **BOOLEAN** | True if the input contains credit card expiration dates. | [optional] 
+**contains_credit_card_verification_code** | **BOOLEAN** | True if the input contains credit card verification codes. | [optional] 
+**contains_bank_account_number** | **BOOLEAN** | True if the input contains bank account numbers. | [optional] 
+**contains_iban** | **BOOLEAN** | True if the input contains IBANs. | [optional] 
+**contains_health_insurance_number** | **BOOLEAN** | True if the input contains health insurance numbers. | [optional] 
+**contains_bearer_token** | **BOOLEAN** | True if the input contains bearer tokens. | [optional] 
+**contains_http_cookie** | **BOOLEAN** | True if the input contains HTTP cookies. | [optional] 
+**contains_private_keys** | **BOOLEAN** | True if the input contains private keys. | [optional] 
+**contains_credentials** | **BOOLEAN** | True if the input contains credentials (usernames/passwords). | [optional] 
+**contains_deep_web_urls** | **BOOLEAN** | True if the input contains deep web URLs (.onion). | [optional] 
+**contains_source_code** | **BOOLEAN** | True if the input contains source code. | [optional] 
+**contains_ip_address** | **BOOLEAN** | True if the input contains IP addresses. | [optional] 
+**contains_mac_address** | **BOOLEAN** | True if the input contains MAC addresses. | [optional] 
+
+

data/docs/RedactApi.md

@@ -0,0 +1,232 @@
+# CloudmersiveDlpApiClient::RedactApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**redact_document**](RedactApi.md#redact_document) | **POST** /dlp/redact/document | Redact User Data in Document
+[**redact_document_advanced**](RedactApi.md#redact_document_advanced) | **POST** /dlp/redact/document/advanced | Redact User Data in Document (Advanced)
+[**redact_text**](RedactApi.md#redact_text) | **POST** /dlp/redact/text | Redact User Data in Input Text
+[**redact_text_advanced**](RedactApi.md#redact_text_advanced) | **POST** /dlp/redact/text/advanced | Redact User Data in Input Text (Advanced)
+
+
+# **redact_document**
+> DlpDocumentRedactionResponse redact_document(opts)
+
+Redact User Data in Document
+
+Detects and redacts configurable types of user data in a document (PDF, DOCX, PNG, JPG) using Advanced AI. Rasterizes document pages, detects PII regions using a grid-overlay approach, blurs those regions, and returns a rasterized PDF.
+
+### 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::RedactApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpDocumentRedactionRequest.new # DlpDocumentRedactionRequest | Input request
+}
+
+begin
+  #Redact User Data in Document
+  result = api_instance.redact_document(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling RedactApi->redact_document: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DlpDocumentRedactionRequest**](DlpDocumentRedactionRequest.md)| Input request | [optional] 
+
+### Return type
+
+[**DlpDocumentRedactionResponse**](DlpDocumentRedactionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **redact_document_advanced**
+> DlpAdvancedDocumentRedactionResponse redact_document_advanced(opts)
+
+Redact User Data in Document (Advanced)
+
+Detects and redacts 35 configurable types of user data including health-related PHI in a document (PDF, DOCX, PNG, JPG) using Advanced AI. Rasterizes document pages, detects PII regions using a row-overlay approach, redacts those regions, and returns a rasterized PDF.
+
+### 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::RedactApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpAdvancedDocumentRedactionRequest.new # DlpAdvancedDocumentRedactionRequest | Input request
+}
+
+begin
+  #Redact User Data in Document (Advanced)
+  result = api_instance.redact_document_advanced(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling RedactApi->redact_document_advanced: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DlpAdvancedDocumentRedactionRequest**](DlpAdvancedDocumentRedactionRequest.md)| Input request | [optional] 
+
+### Return type
+
+[**DlpAdvancedDocumentRedactionResponse**](DlpAdvancedDocumentRedactionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **redact_text**
+> DlpRedactionResponse redact_text(opts)
+
+Redact User Data in Input Text
+
+Detects and redacts configurable types of user data in an input text string using Advanced AI. First detects PII, then redacts disallowed types by either deleting them or replacing them with asterisks.
+
+### 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::RedactApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpRedactionRequest.new # DlpRedactionRequest | Input request
+}
+
+begin
+  #Redact User Data in Input Text
+  result = api_instance.redact_text(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling RedactApi->redact_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DlpRedactionRequest**](DlpRedactionRequest.md)| Input request | [optional] 
+
+### Return type
+
+[**DlpRedactionResponse**](DlpRedactionResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json, application/*+json
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **redact_text_advanced**
+> DlpAdvancedRedactionResponse redact_text_advanced(opts)
+
+Redact User Data in Input Text (Advanced)
+
+Detects and redacts 34 configurable types of user data including health-related PHI in an input text string using Advanced AI. First detects PII, then redacts disallowed types by either deleting them or replacing them with asterisks.
+
+### 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::RedactApi.new
+
+opts = { 
+  body: CloudmersiveDlpApiClient::DlpAdvancedRedactionRequest.new # DlpAdvancedRedactionRequest | Input request
+}
+
+begin
+  #Redact User Data in Input Text (Advanced)
+  result = api_instance.redact_text_advanced(opts)
+  p result
+rescue CloudmersiveDlpApiClient::ApiError => e
+  puts "Exception when calling RedactApi->redact_text_advanced: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DlpAdvancedRedactionRequest**](DlpAdvancedRedactionRequest.md)| Input request | [optional] 
+
+### Return type
+
+[**DlpAdvancedRedactionResponse**](DlpAdvancedRedactionResponse.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/RedactedPageInfo.md

@@ -0,0 +1,8 @@
+# CloudmersiveDlpApiClient::RedactedPageInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_number** | **Integer** | 1-based page number that was redacted. | [optional] 
+
+