cloudmersive-dlp-api-client 2.2.0 → 2.2.1

data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_detection_request.rb

@@ -27,6 +27,9 @@ module CloudmersiveDlpApiClient
     # Set to true to allow street addresses in the input text and not flag them as PII.
     attr_accessor :allow_street_address
 
+    # Set to true to allow standalone city names (e.g. \"San Francisco\") in the input text and not flag them as PII. Applies to city names mentioned outside of a full street address.
+    attr_accessor :allow_city
+
     # Set to true to allow person names in the input text and not flag them as PII.
     attr_accessor :allow_person_name
 
@@ -90,6 +93,12 @@ module CloudmersiveDlpApiClient
     # Set to true to allow health insurance member IDs in the input text and not flag them as PHI.
     attr_accessor :allow_health_insurance_member_id
 
+    # Set to true to allow medical record numbers in the input text and not flag them as PHI.
+    attr_accessor :allow_medical_record_number
+
+    # Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the input text and not flag them as PII.
+    attr_accessor :allow_billing_account_number
+
     # Set to true to allow references to injuries or diseases in the input text and not flag them as PHI.
     attr_accessor :allow_health_injury_or_disease
 
@@ -123,6 +132,9 @@ module CloudmersiveDlpApiClient
     # Set to true to include a natural language rationale explaining why each detection conclusion was formed.
     attr_accessor :provide_analysis_rationale
 
+    # Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy,  navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud
+    attr_accessor :custom_policy_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -130,6 +142,7 @@ module CloudmersiveDlpApiClient
         :'allow_email_address' => :'AllowEmailAddress',
         :'allow_phone_number' => :'AllowPhoneNumber',
         :'allow_street_address' => :'AllowStreetAddress',
+        :'allow_city' => :'AllowCity',
         :'allow_person_name' => :'AllowPersonName',
         :'allow_birth_date' => :'AllowBirthDate',
         :'allow_passport_number' => :'AllowPassportNumber',
@@ -151,6 +164,8 @@ module CloudmersiveDlpApiClient
         :'allow_ip_address' => :'AllowIpAddress',
         :'allow_mac_address' => :'AllowMacAddress',
         :'allow_health_insurance_member_id' => :'AllowHealthInsuranceMemberID',
+        :'allow_medical_record_number' => :'AllowMedicalRecordNumber',
+        :'allow_billing_account_number' => :'AllowBillingAccountNumber',
         :'allow_health_injury_or_disease' => :'AllowHealthInjuryOrDisease',
         :'allow_health_type_of_treatment' => :'AllowHealthTypeOfTreatment',
         :'allow_health_date_and_time_of_treatment' => :'AllowHealthDateAndTimeOfTreatment',
@@ -161,7 +176,8 @@ module CloudmersiveDlpApiClient
         :'allow_names_of_relatives' => :'AllowNamesOfRelatives',
         :'allow_health_universal_record_locator' => :'AllowHealthUniversalRecordLocator',
         :'allow_biometrics' => :'AllowBiometrics',
-        :'provide_analysis_rationale' => :'ProvideAnalysisRationale'
+        :'provide_analysis_rationale' => :'ProvideAnalysisRationale',
+        :'custom_policy_id' => :'CustomPolicyID'
       }
     end
 
@@ -172,6 +188,7 @@ module CloudmersiveDlpApiClient
         :'allow_email_address' => :'BOOLEAN',
         :'allow_phone_number' => :'BOOLEAN',
         :'allow_street_address' => :'BOOLEAN',
+        :'allow_city' => :'BOOLEAN',
         :'allow_person_name' => :'BOOLEAN',
         :'allow_birth_date' => :'BOOLEAN',
         :'allow_passport_number' => :'BOOLEAN',
@@ -193,6 +210,8 @@ module CloudmersiveDlpApiClient
         :'allow_ip_address' => :'BOOLEAN',
         :'allow_mac_address' => :'BOOLEAN',
         :'allow_health_insurance_member_id' => :'BOOLEAN',
+        :'allow_medical_record_number' => :'BOOLEAN',
+        :'allow_billing_account_number' => :'BOOLEAN',
         :'allow_health_injury_or_disease' => :'BOOLEAN',
         :'allow_health_type_of_treatment' => :'BOOLEAN',
         :'allow_health_date_and_time_of_treatment' => :'BOOLEAN',
@@ -203,7 +222,8 @@ module CloudmersiveDlpApiClient
         :'allow_names_of_relatives' => :'BOOLEAN',
         :'allow_health_universal_record_locator' => :'BOOLEAN',
         :'allow_biometrics' => :'BOOLEAN',
-        :'provide_analysis_rationale' => :'BOOLEAN'
+        :'provide_analysis_rationale' => :'BOOLEAN',
+        :'custom_policy_id' => :'String'
       }
     end
 
@@ -231,6 +251,10 @@ module CloudmersiveDlpApiClient
         self.allow_street_address = attributes[:'AllowStreetAddress']
       end
 
+      if attributes.has_key?(:'AllowCity')
+        self.allow_city = attributes[:'AllowCity']
+      end
+
       if attributes.has_key?(:'AllowPersonName')
         self.allow_person_name = attributes[:'AllowPersonName']
       end
@@ -315,6 +339,14 @@ module CloudmersiveDlpApiClient
         self.allow_health_insurance_member_id = attributes[:'AllowHealthInsuranceMemberID']
       end
 
+      if attributes.has_key?(:'AllowMedicalRecordNumber')
+        self.allow_medical_record_number = attributes[:'AllowMedicalRecordNumber']
+      end
+
+      if attributes.has_key?(:'AllowBillingAccountNumber')
+        self.allow_billing_account_number = attributes[:'AllowBillingAccountNumber']
+      end
+
       if attributes.has_key?(:'AllowHealthInjuryOrDisease')
         self.allow_health_injury_or_disease = attributes[:'AllowHealthInjuryOrDisease']
       end
@@ -358,6 +390,10 @@ module CloudmersiveDlpApiClient
       if attributes.has_key?(:'ProvideAnalysisRationale')
         self.provide_analysis_rationale = attributes[:'ProvideAnalysisRationale']
       end
+
+      if attributes.has_key?(:'CustomPolicyID')
+        self.custom_policy_id = attributes[:'CustomPolicyID']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -382,6 +418,7 @@ module CloudmersiveDlpApiClient
           allow_email_address == o.allow_email_address &&
           allow_phone_number == o.allow_phone_number &&
           allow_street_address == o.allow_street_address &&
+          allow_city == o.allow_city &&
           allow_person_name == o.allow_person_name &&
           allow_birth_date == o.allow_birth_date &&
           allow_passport_number == o.allow_passport_number &&
@@ -403,6 +440,8 @@ module CloudmersiveDlpApiClient
           allow_ip_address == o.allow_ip_address &&
           allow_mac_address == o.allow_mac_address &&
           allow_health_insurance_member_id == o.allow_health_insurance_member_id &&
+          allow_medical_record_number == o.allow_medical_record_number &&
+          allow_billing_account_number == o.allow_billing_account_number &&
           allow_health_injury_or_disease == o.allow_health_injury_or_disease &&
           allow_health_type_of_treatment == o.allow_health_type_of_treatment &&
           allow_health_date_and_time_of_treatment == o.allow_health_date_and_time_of_treatment &&
@@ -413,7 +452,8 @@ module CloudmersiveDlpApiClient
           allow_names_of_relatives == o.allow_names_of_relatives &&
           allow_health_universal_record_locator == o.allow_health_universal_record_locator &&
           allow_biometrics == o.allow_biometrics &&
-          provide_analysis_rationale == o.provide_analysis_rationale
+          provide_analysis_rationale == o.provide_analysis_rationale &&
+          custom_policy_id == o.custom_policy_id
     end
 
     # @see the `==` method
@@ -425,7 +465,7 @@ module CloudmersiveDlpApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [input_text, allow_email_address, allow_phone_number, allow_street_address, allow_person_name, allow_birth_date, allow_passport_number, allow_drivers_license, allow_social_security_number, allow_taxpayer_id, allow_credit_card_number, allow_credit_card_expiration_date, allow_credit_card_verification_code, allow_bank_account_number, allow_iban, allow_health_insurance_number, allow_bearer_token, allow_http_cookie, allow_private_keys, allow_credentials, allow_deep_web_urls, allow_source_code, allow_ip_address, allow_mac_address, allow_health_insurance_member_id, allow_health_injury_or_disease, allow_health_type_of_treatment, allow_health_date_and_time_of_treatment, allow_health_plan_beneficiary_number, allow_health_payments_made_for_treatment, allow_vehicle_id, allow_device_id, allow_names_of_relatives, allow_health_universal_record_locator, allow_biometrics, provide_analysis_rationale].hash
+      [input_text, allow_email_address, allow_phone_number, allow_street_address, allow_city, allow_person_name, allow_birth_date, allow_passport_number, allow_drivers_license, allow_social_security_number, allow_taxpayer_id, allow_credit_card_number, allow_credit_card_expiration_date, allow_credit_card_verification_code, allow_bank_account_number, allow_iban, allow_health_insurance_number, allow_bearer_token, allow_http_cookie, allow_private_keys, allow_credentials, allow_deep_web_urls, allow_source_code, allow_ip_address, allow_mac_address, allow_health_insurance_member_id, allow_medical_record_number, allow_billing_account_number, allow_health_injury_or_disease, allow_health_type_of_treatment, allow_health_date_and_time_of_treatment, allow_health_plan_beneficiary_number, allow_health_payments_made_for_treatment, allow_vehicle_id, allow_device_id, allow_names_of_relatives, allow_health_universal_record_locator, allow_biometrics, provide_analysis_rationale, custom_policy_id].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_detection_response.rb

@@ -27,6 +27,9 @@ module CloudmersiveDlpApiClient
     # True if the input text contains street addresses.
     attr_accessor :contains_street_address
 
+    # True if the input text contains standalone city names (e.g. \"San Francisco\") outside of a full street address.
+    attr_accessor :contains_city
+
     # True if the input text contains person names.
     attr_accessor :contains_person_name
 
@@ -90,6 +93,12 @@ module CloudmersiveDlpApiClient
     # True if the input text contains health insurance member IDs.
     attr_accessor :contains_health_insurance_member_id
 
+    # True if the input text contains medical record numbers.
+    attr_accessor :contains_medical_record_number
+
+    # True if the input text contains billing account numbers (provider/customer billing account IDs, distinct from bank account numbers).
+    attr_accessor :contains_billing_account_number
+
     # True if the input text contains references to injuries or diseases.
     attr_accessor :contains_health_injury_or_disease
 
@@ -133,6 +142,7 @@ module CloudmersiveDlpApiClient
         :'contains_email_address' => :'ContainsEmailAddress',
         :'contains_phone_number' => :'ContainsPhoneNumber',
         :'contains_street_address' => :'ContainsStreetAddress',
+        :'contains_city' => :'ContainsCity',
         :'contains_person_name' => :'ContainsPersonName',
         :'contains_birth_date' => :'ContainsBirthDate',
         :'contains_passport_number' => :'ContainsPassportNumber',
@@ -154,6 +164,8 @@ module CloudmersiveDlpApiClient
         :'contains_ip_address' => :'ContainsIpAddress',
         :'contains_mac_address' => :'ContainsMacAddress',
         :'contains_health_insurance_member_id' => :'ContainsHealthInsuranceMemberID',
+        :'contains_medical_record_number' => :'ContainsMedicalRecordNumber',
+        :'contains_billing_account_number' => :'ContainsBillingAccountNumber',
         :'contains_health_injury_or_disease' => :'ContainsHealthInjuryOrDisease',
         :'contains_health_type_of_treatment' => :'ContainsHealthTypeOfTreatment',
         :'contains_health_date_and_time_of_treatment' => :'ContainsHealthDateAndTimeOfTreatment',
@@ -176,6 +188,7 @@ module CloudmersiveDlpApiClient
         :'contains_email_address' => :'BOOLEAN',
         :'contains_phone_number' => :'BOOLEAN',
         :'contains_street_address' => :'BOOLEAN',
+        :'contains_city' => :'BOOLEAN',
         :'contains_person_name' => :'BOOLEAN',
         :'contains_birth_date' => :'BOOLEAN',
         :'contains_passport_number' => :'BOOLEAN',
@@ -197,6 +210,8 @@ module CloudmersiveDlpApiClient
         :'contains_ip_address' => :'BOOLEAN',
         :'contains_mac_address' => :'BOOLEAN',
         :'contains_health_insurance_member_id' => :'BOOLEAN',
+        :'contains_medical_record_number' => :'BOOLEAN',
+        :'contains_billing_account_number' => :'BOOLEAN',
         :'contains_health_injury_or_disease' => :'BOOLEAN',
         :'contains_health_type_of_treatment' => :'BOOLEAN',
         :'contains_health_date_and_time_of_treatment' => :'BOOLEAN',
@@ -236,6 +251,10 @@ module CloudmersiveDlpApiClient
         self.contains_street_address = attributes[:'ContainsStreetAddress']
       end
 
+      if attributes.has_key?(:'ContainsCity')
+        self.contains_city = attributes[:'ContainsCity']
+      end
+
       if attributes.has_key?(:'ContainsPersonName')
         self.contains_person_name = attributes[:'ContainsPersonName']
       end
@@ -320,6 +339,14 @@ module CloudmersiveDlpApiClient
         self.contains_health_insurance_member_id = attributes[:'ContainsHealthInsuranceMemberID']
       end
 
+      if attributes.has_key?(:'ContainsMedicalRecordNumber')
+        self.contains_medical_record_number = attributes[:'ContainsMedicalRecordNumber']
+      end
+
+      if attributes.has_key?(:'ContainsBillingAccountNumber')
+        self.contains_billing_account_number = attributes[:'ContainsBillingAccountNumber']
+      end
+
       if attributes.has_key?(:'ContainsHealthInjuryOrDisease')
         self.contains_health_injury_or_disease = attributes[:'ContainsHealthInjuryOrDisease']
       end
@@ -391,6 +418,7 @@ module CloudmersiveDlpApiClient
           contains_email_address == o.contains_email_address &&
           contains_phone_number == o.contains_phone_number &&
           contains_street_address == o.contains_street_address &&
+          contains_city == o.contains_city &&
           contains_person_name == o.contains_person_name &&
           contains_birth_date == o.contains_birth_date &&
           contains_passport_number == o.contains_passport_number &&
@@ -412,6 +440,8 @@ module CloudmersiveDlpApiClient
           contains_ip_address == o.contains_ip_address &&
           contains_mac_address == o.contains_mac_address &&
           contains_health_insurance_member_id == o.contains_health_insurance_member_id &&
+          contains_medical_record_number == o.contains_medical_record_number &&
+          contains_billing_account_number == o.contains_billing_account_number &&
           contains_health_injury_or_disease == o.contains_health_injury_or_disease &&
           contains_health_type_of_treatment == o.contains_health_type_of_treatment &&
           contains_health_date_and_time_of_treatment == o.contains_health_date_and_time_of_treatment &&
@@ -435,7 +465,7 @@ module CloudmersiveDlpApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clean_result, contains_email_address, contains_phone_number, contains_street_address, contains_person_name, contains_birth_date, contains_passport_number, contains_drivers_license, contains_social_security_number, contains_taxpayer_id, contains_credit_card_number, contains_credit_card_expiration_date, contains_credit_card_verification_code, contains_bank_account_number, contains_iban, contains_health_insurance_number, contains_bearer_token, contains_http_cookie, contains_private_keys, contains_credentials, contains_deep_web_urls, contains_source_code, contains_ip_address, contains_mac_address, contains_health_insurance_member_id, contains_health_injury_or_disease, contains_health_type_of_treatment, contains_health_date_and_time_of_treatment, contains_health_plan_beneficiary_number, contains_health_payments_made_for_treatment, contains_faces, contains_vehicle_id, contains_device_id, contains_names_of_relatives, contains_health_universal_record_locator, contains_biometrics, analysis_rationale].hash
+      [clean_result, contains_email_address, contains_phone_number, contains_street_address, contains_city, contains_person_name, contains_birth_date, contains_passport_number, contains_drivers_license, contains_social_security_number, contains_taxpayer_id, contains_credit_card_number, contains_credit_card_expiration_date, contains_credit_card_verification_code, contains_bank_account_number, contains_iban, contains_health_insurance_number, contains_bearer_token, contains_http_cookie, contains_private_keys, contains_credentials, contains_deep_web_urls, contains_source_code, contains_ip_address, contains_mac_address, contains_health_insurance_member_id, contains_medical_record_number, contains_billing_account_number, contains_health_injury_or_disease, contains_health_type_of_treatment, contains_health_date_and_time_of_treatment, contains_health_plan_beneficiary_number, contains_health_payments_made_for_treatment, contains_faces, contains_vehicle_id, contains_device_id, contains_names_of_relatives, contains_health_universal_record_locator, contains_biometrics, analysis_rationale].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_document_detection_request.rb

@@ -15,13 +15,13 @@ require 'date'
 module CloudmersiveDlpApiClient
   # Request object for advanced DLP document detection with 29 PII detection types including health-related data.
   class DlpAdvancedDocumentDetectionRequest
-    # Document file bytes (PDF, DOCX, PNG, or JPG) to scan for PII and sensitive data.
+    # Document file bytes (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, or WEBP) to scan for PII and sensitive data.
     attr_accessor :input_file
 
     # Optional. Name of the input file including extension, used for format detection. If not provided, format is detected from file contents.
     attr_accessor :file_name
 
-    # Optional. Recognition mode for image processing. Options: null (default), \"Fast\", \"FastPlus\", \"FastMini\".
+    # Optional. Recognition mode for image processing. Options: null (default), \"Normal\", \"Advanced\", \"Fast\", \"FastPlus\", \"FastMini\".
     attr_accessor :recognition_mode
 
     # Set to true to allow email addresses in the document and not flag them as PII.
@@ -33,6 +33,9 @@ module CloudmersiveDlpApiClient
     # Set to true to allow street addresses in the document and not flag them as PII.
     attr_accessor :allow_street_address
 
+    # Set to true to allow standalone city names (e.g. \"San Francisco\") in the document and not flag them as PII. Applies to city names mentioned outside of a full street address.
+    attr_accessor :allow_city
+
     # Set to true to allow person names in the document and not flag them as PII.
     attr_accessor :allow_person_name
 
@@ -96,6 +99,12 @@ module CloudmersiveDlpApiClient
     # Set to true to allow health insurance member IDs in the document and not flag them as PHI.
     attr_accessor :allow_health_insurance_member_id
 
+    # Set to true to allow medical record numbers in the document and not flag them as PHI.
+    attr_accessor :allow_medical_record_number
+
+    # Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the document and not flag them as PII.
+    attr_accessor :allow_billing_account_number
+
     # Set to true to allow references to injuries or diseases in the document and not flag them as PHI.
     attr_accessor :allow_health_injury_or_disease
 
@@ -132,6 +141,9 @@ module CloudmersiveDlpApiClient
     # Set to true to include a natural language rationale explaining why each detection conclusion was formed.
     attr_accessor :provide_analysis_rationale
 
+    # Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy,  navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud
+    attr_accessor :custom_policy_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -141,6 +153,7 @@ module CloudmersiveDlpApiClient
         :'allow_email_address' => :'AllowEmailAddress',
         :'allow_phone_number' => :'AllowPhoneNumber',
         :'allow_street_address' => :'AllowStreetAddress',
+        :'allow_city' => :'AllowCity',
         :'allow_person_name' => :'AllowPersonName',
         :'allow_birth_date' => :'AllowBirthDate',
         :'allow_passport_number' => :'AllowPassportNumber',
@@ -162,6 +175,8 @@ module CloudmersiveDlpApiClient
         :'allow_ip_address' => :'AllowIpAddress',
         :'allow_mac_address' => :'AllowMacAddress',
         :'allow_health_insurance_member_id' => :'AllowHealthInsuranceMemberID',
+        :'allow_medical_record_number' => :'AllowMedicalRecordNumber',
+        :'allow_billing_account_number' => :'AllowBillingAccountNumber',
         :'allow_health_injury_or_disease' => :'AllowHealthInjuryOrDisease',
         :'allow_health_type_of_treatment' => :'AllowHealthTypeOfTreatment',
         :'allow_health_date_and_time_of_treatment' => :'AllowHealthDateAndTimeOfTreatment',
@@ -173,7 +188,8 @@ module CloudmersiveDlpApiClient
         :'allow_names_of_relatives' => :'AllowNamesOfRelatives',
         :'allow_health_universal_record_locator' => :'AllowHealthUniversalRecordLocator',
         :'allow_biometrics' => :'AllowBiometrics',
-        :'provide_analysis_rationale' => :'ProvideAnalysisRationale'
+        :'provide_analysis_rationale' => :'ProvideAnalysisRationale',
+        :'custom_policy_id' => :'CustomPolicyID'
       }
     end
 
@@ -186,6 +202,7 @@ module CloudmersiveDlpApiClient
         :'allow_email_address' => :'BOOLEAN',
         :'allow_phone_number' => :'BOOLEAN',
         :'allow_street_address' => :'BOOLEAN',
+        :'allow_city' => :'BOOLEAN',
         :'allow_person_name' => :'BOOLEAN',
         :'allow_birth_date' => :'BOOLEAN',
         :'allow_passport_number' => :'BOOLEAN',
@@ -207,6 +224,8 @@ module CloudmersiveDlpApiClient
         :'allow_ip_address' => :'BOOLEAN',
         :'allow_mac_address' => :'BOOLEAN',
         :'allow_health_insurance_member_id' => :'BOOLEAN',
+        :'allow_medical_record_number' => :'BOOLEAN',
+        :'allow_billing_account_number' => :'BOOLEAN',
         :'allow_health_injury_or_disease' => :'BOOLEAN',
         :'allow_health_type_of_treatment' => :'BOOLEAN',
         :'allow_health_date_and_time_of_treatment' => :'BOOLEAN',
@@ -218,7 +237,8 @@ module CloudmersiveDlpApiClient
         :'allow_names_of_relatives' => :'BOOLEAN',
         :'allow_health_universal_record_locator' => :'BOOLEAN',
         :'allow_biometrics' => :'BOOLEAN',
-        :'provide_analysis_rationale' => :'BOOLEAN'
+        :'provide_analysis_rationale' => :'BOOLEAN',
+        :'custom_policy_id' => :'String'
       }
     end
 
@@ -254,6 +274,10 @@ module CloudmersiveDlpApiClient
         self.allow_street_address = attributes[:'AllowStreetAddress']
       end
 
+      if attributes.has_key?(:'AllowCity')
+        self.allow_city = attributes[:'AllowCity']
+      end
+
       if attributes.has_key?(:'AllowPersonName')
         self.allow_person_name = attributes[:'AllowPersonName']
       end
@@ -338,6 +362,14 @@ module CloudmersiveDlpApiClient
         self.allow_health_insurance_member_id = attributes[:'AllowHealthInsuranceMemberID']
       end
 
+      if attributes.has_key?(:'AllowMedicalRecordNumber')
+        self.allow_medical_record_number = attributes[:'AllowMedicalRecordNumber']
+      end
+
+      if attributes.has_key?(:'AllowBillingAccountNumber')
+        self.allow_billing_account_number = attributes[:'AllowBillingAccountNumber']
+      end
+
       if attributes.has_key?(:'AllowHealthInjuryOrDisease')
         self.allow_health_injury_or_disease = attributes[:'AllowHealthInjuryOrDisease']
       end
@@ -385,6 +417,10 @@ module CloudmersiveDlpApiClient
       if attributes.has_key?(:'ProvideAnalysisRationale')
         self.provide_analysis_rationale = attributes[:'ProvideAnalysisRationale']
       end
+
+      if attributes.has_key?(:'CustomPolicyID')
+        self.custom_policy_id = attributes[:'CustomPolicyID']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -426,6 +462,7 @@ module CloudmersiveDlpApiClient
           allow_email_address == o.allow_email_address &&
           allow_phone_number == o.allow_phone_number &&
           allow_street_address == o.allow_street_address &&
+          allow_city == o.allow_city &&
           allow_person_name == o.allow_person_name &&
           allow_birth_date == o.allow_birth_date &&
           allow_passport_number == o.allow_passport_number &&
@@ -447,6 +484,8 @@ module CloudmersiveDlpApiClient
           allow_ip_address == o.allow_ip_address &&
           allow_mac_address == o.allow_mac_address &&
           allow_health_insurance_member_id == o.allow_health_insurance_member_id &&
+          allow_medical_record_number == o.allow_medical_record_number &&
+          allow_billing_account_number == o.allow_billing_account_number &&
           allow_health_injury_or_disease == o.allow_health_injury_or_disease &&
           allow_health_type_of_treatment == o.allow_health_type_of_treatment &&
           allow_health_date_and_time_of_treatment == o.allow_health_date_and_time_of_treatment &&
@@ -458,7 +497,8 @@ module CloudmersiveDlpApiClient
           allow_names_of_relatives == o.allow_names_of_relatives &&
           allow_health_universal_record_locator == o.allow_health_universal_record_locator &&
           allow_biometrics == o.allow_biometrics &&
-          provide_analysis_rationale == o.provide_analysis_rationale
+          provide_analysis_rationale == o.provide_analysis_rationale &&
+          custom_policy_id == o.custom_policy_id
     end
 
     # @see the `==` method
@@ -470,7 +510,7 @@ module CloudmersiveDlpApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [input_file, file_name, recognition_mode, allow_email_address, allow_phone_number, allow_street_address, allow_person_name, allow_birth_date, allow_passport_number, allow_drivers_license, allow_social_security_number, allow_taxpayer_id, allow_credit_card_number, allow_credit_card_expiration_date, allow_credit_card_verification_code, allow_bank_account_number, allow_iban, allow_health_insurance_number, allow_bearer_token, allow_http_cookie, allow_private_keys, allow_credentials, allow_deep_web_urls, allow_source_code, allow_ip_address, allow_mac_address, allow_health_insurance_member_id, allow_health_injury_or_disease, allow_health_type_of_treatment, allow_health_date_and_time_of_treatment, allow_health_plan_beneficiary_number, allow_health_payments_made_for_treatment, allow_faces, allow_vehicle_id, allow_device_id, allow_names_of_relatives, allow_health_universal_record_locator, allow_biometrics, provide_analysis_rationale].hash
+      [input_file, file_name, recognition_mode, allow_email_address, allow_phone_number, allow_street_address, allow_city, allow_person_name, allow_birth_date, allow_passport_number, allow_drivers_license, allow_social_security_number, allow_taxpayer_id, allow_credit_card_number, allow_credit_card_expiration_date, allow_credit_card_verification_code, allow_bank_account_number, allow_iban, allow_health_insurance_number, allow_bearer_token, allow_http_cookie, allow_private_keys, allow_credentials, allow_deep_web_urls, allow_source_code, allow_ip_address, allow_mac_address, allow_health_insurance_member_id, allow_medical_record_number, allow_billing_account_number, allow_health_injury_or_disease, allow_health_type_of_treatment, allow_health_date_and_time_of_treatment, allow_health_plan_beneficiary_number, allow_health_payments_made_for_treatment, allow_faces, allow_vehicle_id, allow_device_id, allow_names_of_relatives, allow_health_universal_record_locator, allow_biometrics, provide_analysis_rationale, custom_policy_id].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-dlp-api-client/models/dlp_advanced_document_redaction_request.rb

@@ -15,13 +15,13 @@ require 'date'
 module CloudmersiveDlpApiClient
   # Request object for advanced DLP document redaction with 35 PII detection types including health-related data.
   class DlpAdvancedDocumentRedactionRequest
-    # Document file bytes (PDF, DOCX, PNG, or JPG) to scan for PII and redact.
+    # Document file bytes (PDF, DOC, DOCX, XLS, XLSX, PPT, PPTX, HTML, EML, MSG, PNG, JPG, or WEBP) to scan for PII and redact.
     attr_accessor :input_file
 
     # Optional. Name of the input file including extension, used for format detection. If not provided, format is detected from file contents.
     attr_accessor :file_name
 
-    # Optional. Recognition mode for image processing. Options: null (default), \"Fast\", \"FastPlus\", \"FastMini\".
+    # Optional. Recognition mode for image processing. Options: null (default), \"Normal\", \"Advanced\", \"Fast\", \"FastPlus\", \"FastMini\".
     attr_accessor :recognition_mode
 
     # 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.
@@ -36,6 +36,9 @@ module CloudmersiveDlpApiClient
     # Set to true to allow street addresses in the document and not redact them.
     attr_accessor :allow_street_address
 
+    # Set to true to allow standalone city names (e.g. \"San Francisco\") in the document and not redact them. Applies to city names mentioned outside of a full street address.
+    attr_accessor :allow_city
+
     # Set to true to allow person names in the document and not redact them.
     attr_accessor :allow_person_name
 
@@ -99,6 +102,12 @@ module CloudmersiveDlpApiClient
     # Set to true to allow health insurance member IDs in the document and not redact them.
     attr_accessor :allow_health_insurance_member_id
 
+    # Set to true to allow medical record numbers in the document and not redact them.
+    attr_accessor :allow_medical_record_number
+
+    # Set to true to allow billing account numbers (e.g. provider/customer billing account IDs, distinct from bank account numbers) in the document and not redact them.
+    attr_accessor :allow_billing_account_number
+
     # Set to true to allow references to injuries or diseases in the document and not redact them.
     attr_accessor :allow_health_injury_or_disease
 
@@ -135,6 +144,12 @@ module CloudmersiveDlpApiClient
     # Set to true to include a natural language rationale explaining why each detection conclusion was formed.
     attr_accessor :provide_analysis_rationale
 
+    # Apply a Custom Policy for DLP Enforcement by providing the ID; to create a Custom Policy,  navigate to the Cloudmersive Management Portal and select Custom Policies.  Requires Managed Instance or Private Cloud
+    attr_accessor :custom_policy_id
+
+    # Optional list of caller-defined custom PII fields to detect and redact in addition  to the built-in categories. Each entry has a Title (used to derive the redaction  tag, e.g. \"internal participant code\" → [INTERNAL-PARTICIPANT-CODE]) and a  Description telling the redaction LLM what the field looks like. Default null.
+    attr_accessor :custom_fields
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -145,6 +160,7 @@ module CloudmersiveDlpApiClient
         :'allow_email_address' => :'AllowEmailAddress',
         :'allow_phone_number' => :'AllowPhoneNumber',
         :'allow_street_address' => :'AllowStreetAddress',
+        :'allow_city' => :'AllowCity',
         :'allow_person_name' => :'AllowPersonName',
         :'allow_birth_date' => :'AllowBirthDate',
         :'allow_passport_number' => :'AllowPassportNumber',
@@ -166,6 +182,8 @@ module CloudmersiveDlpApiClient
         :'allow_ip_address' => :'AllowIpAddress',
         :'allow_mac_address' => :'AllowMacAddress',
         :'allow_health_insurance_member_id' => :'AllowHealthInsuranceMemberID',
+        :'allow_medical_record_number' => :'AllowMedicalRecordNumber',
+        :'allow_billing_account_number' => :'AllowBillingAccountNumber',
         :'allow_health_injury_or_disease' => :'AllowHealthInjuryOrDisease',
         :'allow_health_type_of_treatment' => :'AllowHealthTypeOfTreatment',
         :'allow_health_date_and_time_of_treatment' => :'AllowHealthDateAndTimeOfTreatment',
@@ -177,7 +195,9 @@ module CloudmersiveDlpApiClient
         :'allow_names_of_relatives' => :'AllowNamesOfRelatives',
         :'allow_health_universal_record_locator' => :'AllowHealthUniversalRecordLocator',
         :'allow_biometrics' => :'AllowBiometrics',
-        :'provide_analysis_rationale' => :'ProvideAnalysisRationale'
+        :'provide_analysis_rationale' => :'ProvideAnalysisRationale',
+        :'custom_policy_id' => :'CustomPolicyID',
+        :'custom_fields' => :'CustomFields'
       }
     end
 
@@ -191,6 +211,7 @@ module CloudmersiveDlpApiClient
         :'allow_email_address' => :'BOOLEAN',
         :'allow_phone_number' => :'BOOLEAN',
         :'allow_street_address' => :'BOOLEAN',
+        :'allow_city' => :'BOOLEAN',
         :'allow_person_name' => :'BOOLEAN',
         :'allow_birth_date' => :'BOOLEAN',
         :'allow_passport_number' => :'BOOLEAN',
@@ -212,6 +233,8 @@ module CloudmersiveDlpApiClient
         :'allow_ip_address' => :'BOOLEAN',
         :'allow_mac_address' => :'BOOLEAN',
         :'allow_health_insurance_member_id' => :'BOOLEAN',
+        :'allow_medical_record_number' => :'BOOLEAN',
+        :'allow_billing_account_number' => :'BOOLEAN',
         :'allow_health_injury_or_disease' => :'BOOLEAN',
         :'allow_health_type_of_treatment' => :'BOOLEAN',
         :'allow_health_date_and_time_of_treatment' => :'BOOLEAN',
@@ -223,7 +246,9 @@ module CloudmersiveDlpApiClient
         :'allow_names_of_relatives' => :'BOOLEAN',
         :'allow_health_universal_record_locator' => :'BOOLEAN',
         :'allow_biometrics' => :'BOOLEAN',
-        :'provide_analysis_rationale' => :'BOOLEAN'
+        :'provide_analysis_rationale' => :'BOOLEAN',
+        :'custom_policy_id' => :'String',
+        :'custom_fields' => :'Array<CustomPiiField>'
       }
     end
 
@@ -263,6 +288,10 @@ module CloudmersiveDlpApiClient
         self.allow_street_address = attributes[:'AllowStreetAddress']
       end
 
+      if attributes.has_key?(:'AllowCity')
+        self.allow_city = attributes[:'AllowCity']
+      end
+
       if attributes.has_key?(:'AllowPersonName')
         self.allow_person_name = attributes[:'AllowPersonName']
       end
@@ -347,6 +376,14 @@ module CloudmersiveDlpApiClient
         self.allow_health_insurance_member_id = attributes[:'AllowHealthInsuranceMemberID']
       end
 
+      if attributes.has_key?(:'AllowMedicalRecordNumber')
+        self.allow_medical_record_number = attributes[:'AllowMedicalRecordNumber']
+      end
+
+      if attributes.has_key?(:'AllowBillingAccountNumber')
+        self.allow_billing_account_number = attributes[:'AllowBillingAccountNumber']
+      end
+
       if attributes.has_key?(:'AllowHealthInjuryOrDisease')
         self.allow_health_injury_or_disease = attributes[:'AllowHealthInjuryOrDisease']
       end
@@ -394,6 +431,16 @@ module CloudmersiveDlpApiClient
       if attributes.has_key?(:'ProvideAnalysisRationale')
         self.provide_analysis_rationale = attributes[:'ProvideAnalysisRationale']
       end
+
+      if attributes.has_key?(:'CustomPolicyID')
+        self.custom_policy_id = attributes[:'CustomPolicyID']
+      end
+
+      if attributes.has_key?(:'CustomFields')
+        if (value = attributes[:'CustomFields']).is_a?(Array)
+          self.custom_fields = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -436,6 +483,7 @@ module CloudmersiveDlpApiClient
           allow_email_address == o.allow_email_address &&
           allow_phone_number == o.allow_phone_number &&
           allow_street_address == o.allow_street_address &&
+          allow_city == o.allow_city &&
           allow_person_name == o.allow_person_name &&
           allow_birth_date == o.allow_birth_date &&
           allow_passport_number == o.allow_passport_number &&
@@ -457,6 +505,8 @@ module CloudmersiveDlpApiClient
           allow_ip_address == o.allow_ip_address &&
           allow_mac_address == o.allow_mac_address &&
           allow_health_insurance_member_id == o.allow_health_insurance_member_id &&
+          allow_medical_record_number == o.allow_medical_record_number &&
+          allow_billing_account_number == o.allow_billing_account_number &&
           allow_health_injury_or_disease == o.allow_health_injury_or_disease &&
           allow_health_type_of_treatment == o.allow_health_type_of_treatment &&
           allow_health_date_and_time_of_treatment == o.allow_health_date_and_time_of_treatment &&
@@ -468,7 +518,9 @@ module CloudmersiveDlpApiClient
           allow_names_of_relatives == o.allow_names_of_relatives &&
           allow_health_universal_record_locator == o.allow_health_universal_record_locator &&
           allow_biometrics == o.allow_biometrics &&
-          provide_analysis_rationale == o.provide_analysis_rationale
+          provide_analysis_rationale == o.provide_analysis_rationale &&
+          custom_policy_id == o.custom_policy_id &&
+          custom_fields == o.custom_fields
     end
 
     # @see the `==` method
@@ -480,7 +532,7 @@ module CloudmersiveDlpApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [input_file, file_name, recognition_mode, redaction_mode, allow_email_address, allow_phone_number, allow_street_address, allow_person_name, allow_birth_date, allow_passport_number, allow_drivers_license, allow_social_security_number, allow_taxpayer_id, allow_credit_card_number, allow_credit_card_expiration_date, allow_credit_card_verification_code, allow_bank_account_number, allow_iban, allow_health_insurance_number, allow_bearer_token, allow_http_cookie, allow_private_keys, allow_credentials, allow_deep_web_urls, allow_source_code, allow_ip_address, allow_mac_address, allow_health_insurance_member_id, allow_health_injury_or_disease, allow_health_type_of_treatment, allow_health_date_and_time_of_treatment, allow_health_plan_beneficiary_number, allow_health_payments_made_for_treatment, allow_faces, allow_vehicle_id, allow_device_id, allow_names_of_relatives, allow_health_universal_record_locator, allow_biometrics, provide_analysis_rationale].hash
+      [input_file, file_name, recognition_mode, redaction_mode, allow_email_address, allow_phone_number, allow_street_address, allow_city, allow_person_name, allow_birth_date, allow_passport_number, allow_drivers_license, allow_social_security_number, allow_taxpayer_id, allow_credit_card_number, allow_credit_card_expiration_date, allow_credit_card_verification_code, allow_bank_account_number, allow_iban, allow_health_insurance_number, allow_bearer_token, allow_http_cookie, allow_private_keys, allow_credentials, allow_deep_web_urls, allow_source_code, allow_ip_address, allow_mac_address, allow_health_insurance_member_id, allow_medical_record_number, allow_billing_account_number, allow_health_injury_or_disease, allow_health_type_of_treatment, allow_health_date_and_time_of_treatment, allow_health_plan_beneficiary_number, allow_health_payments_made_for_treatment, allow_faces, allow_vehicle_id, allow_device_id, allow_names_of_relatives, allow_health_universal_record_locator, allow_biometrics, provide_analysis_rationale, custom_policy_id, custom_fields].hash
     end
 
     # Builds the object from hash