Add support for deletion of sensitive files via env var

datalogics-kam · datalogics-kam · commit fa0c08418b59 · 2025-09-18T18:58:49.000-05:00
- Updated `.env.example` with optional `PDFREST_DELETE_SENSITIVE_FILES`
  variable and usage instructions.
- Enhanced all relevant samples to use the new environment variable
  for toggling immediate deletion, defaulting to `false`.
- Revised the README to explain the configuration and default behavior.
- Updated `PrintUsage` to reflect the new environment variable.
diff --git a/DotNET/.env.example b/DotNET/.env.example
@@ -7,4 +7,10 @@ PDFREST_API_KEY=your_api_key_here
 # - Default (US): https://api.pdfrest.com
 # - EU/GDPR region: https://eu-api.pdfrest.com
 PDFREST_URL=https://api.pdfrest.com
-# For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
+# For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
+
+# Optional: Immediate deletion of sensitive files
+# - Default behavior: files are retained per the File Retention Period.
+# - Set to true to immediately delete uploaded/generated files in samples that support it.
+#   Valid values: true|false (case-insensitive)
+PDFREST_DELETE_SENSITIVE_FILES=false
diff --git a/DotNET/Endpoint Examples/JSON Payload/decrypted-pdf.cs b/DotNET/Endpoint Examples/JSON Payload/decrypted-pdf.cs
@@ -101,8 +101,12 @@ public static async Task Execute(string[] args)
                         //
                         // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
                         
-                        // Toggle deletion of sensitive files (default: false)
-                        var deleteSensitiveFiles = false;
+                        // Optional immediate deletion of sensitive files
+                        // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                        var deleteSensitiveFiles = string.Equals(
+                            Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                            "true",
+                            StringComparison.OrdinalIgnoreCase);
 
                         if (deleteSensitiveFiles)
                         {
diff --git a/DotNET/Endpoint Examples/JSON Payload/encrypted-pdf.cs b/DotNET/Endpoint Examples/JSON Payload/encrypted-pdf.cs
@@ -103,8 +103,12 @@ public static async Task Execute(string[] args)
                         //
                         // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                        // Toggle deletion of sensitive files (default: false)
-                        var deleteSensitiveFiles = false;
+                        // Optional immediate deletion of sensitive files
+                        // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                        var deleteSensitiveFiles = string.Equals(
+                            Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                            "true",
+                            StringComparison.OrdinalIgnoreCase);
 
                         if (deleteSensitiveFiles)
                         {
diff --git a/DotNET/Endpoint Examples/JSON Payload/pdf-with-redacted-text-applied.cs b/DotNET/Endpoint Examples/JSON Payload/pdf-with-redacted-text-applied.cs
@@ -67,8 +67,12 @@ public static async Task Execute(string[] args)
                     //
                     // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                    // Toggle deletion of sensitive files (default: false)
-                    var deleteSensitiveFiles = false;
+                    // Optional immediate deletion of sensitive files
+                    // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                    var deleteSensitiveFiles = string.Equals(
+                        Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                        "true",
+                        StringComparison.OrdinalIgnoreCase);
 
                     if (deleteSensitiveFiles)
                     {
diff --git a/DotNET/Endpoint Examples/JSON Payload/pdf-with-redacted-text-preview.cs b/DotNET/Endpoint Examples/JSON Payload/pdf-with-redacted-text-preview.cs
@@ -72,8 +72,12 @@ public static async Task Execute(string[] args)
                     // IMPORTANT: Do not delete the previewId (the preview PDF) file until after the redaction is applied
                     // with the /pdf-with-redacted-text-applied endpoint.
 
-                    // Toggle deletion of sensitive files (default: false)
-                    var deleteSensitiveFiles = false;
+                    // Optional immediate deletion of sensitive files
+                    // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                    var deleteSensitiveFiles = string.Equals(
+                        Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                        "true",
+                        StringComparison.OrdinalIgnoreCase);
 
                     if (deleteSensitiveFiles)
                     {
diff --git a/DotNET/Endpoint Examples/JSON Payload/restricted-pdf.cs b/DotNET/Endpoint Examples/JSON Payload/restricted-pdf.cs
@@ -104,8 +104,12 @@ public static async Task Execute(string[] args)
                         //
                         // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                        // Toggle deletion of sensitive files (default: false)
-                        var deleteSensitiveFiles = false;
+                        // Optional immediate deletion of sensitive files
+                        // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                        var deleteSensitiveFiles = string.Equals(
+                            Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                            "true",
+                            StringComparison.OrdinalIgnoreCase);
 
                         if (deleteSensitiveFiles)
                         {
@@ -130,4 +134,4 @@ public static async Task Execute(string[] args)
             }
         }
     }
-}
+}
diff --git a/DotNET/Endpoint Examples/JSON Payload/unrestricted-pdf.cs b/DotNET/Endpoint Examples/JSON Payload/unrestricted-pdf.cs
@@ -101,8 +101,12 @@ public static async Task Execute(string[] args)
                         //
                         // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                        // Toggle deletion of sensitive files (default: false)
-                        var deleteSensitiveFiles = false;
+                        // Optional immediate deletion of sensitive files
+                        // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                        var deleteSensitiveFiles = string.Equals(
+                            Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                            "true",
+                            StringComparison.OrdinalIgnoreCase);
 
                         if (deleteSensitiveFiles)
                         {
@@ -126,4 +130,4 @@ public static async Task Execute(string[] args)
             }
         }
     }
-}
+}
diff --git a/DotNET/Endpoint Examples/JSON Payload/watermarked-pdf.cs b/DotNET/Endpoint Examples/JSON Payload/watermarked-pdf.cs
@@ -66,8 +66,12 @@ public static async Task Execute(string[] args)
                     //
                     // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                    // Toggle deletion of sensitive files (default: false)
-                    var deleteSensitiveFiles = false;
+                    // Optional immediate deletion of sensitive files
+                    // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                    var deleteSensitiveFiles = string.Equals(
+                        Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                        "true",
+                        StringComparison.OrdinalIgnoreCase);
 
                     if (deleteSensitiveFiles)
                     {
diff --git a/DotNET/Endpoint Examples/Multipart Payload/decrypted-pdf.cs b/DotNET/Endpoint Examples/Multipart Payload/decrypted-pdf.cs
@@ -79,8 +79,12 @@ public static async Task Execute(string[] args)
                 //
                 // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                // Toggle deletion of sensitive files (default: false)
-                var deleteSensitiveFiles = false;
+                // Optional immediate deletion of sensitive files
+                // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                var deleteSensitiveFiles = string.Equals(
+                    Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                    "true",
+                    StringComparison.OrdinalIgnoreCase);
 
                 if (deleteSensitiveFiles)
                 {
diff --git a/DotNET/Endpoint Examples/Multipart Payload/encrypted-pdf.cs b/DotNET/Endpoint Examples/Multipart Payload/encrypted-pdf.cs
@@ -79,8 +79,12 @@ public static async Task Execute(string[] args)
                 //
                 // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                // Toggle deletion of sensitive files (default: false)
-                var deleteSensitiveFiles = false;
+                // Optional immediate deletion of sensitive files
+                // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                var deleteSensitiveFiles = string.Equals(
+                    Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                    "true",
+                    StringComparison.OrdinalIgnoreCase);
 
                 if (deleteSensitiveFiles)
                 {
diff --git a/DotNET/Endpoint Examples/Multipart Payload/pdf-with-redacted-text-applied.cs b/DotNET/Endpoint Examples/Multipart Payload/pdf-with-redacted-text-applied.cs
@@ -76,8 +76,12 @@ public static async Task Execute(string[] args)
                 //
                 // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                // Toggle deletion of sensitive files (default: false)
-                var deleteSensitiveFiles = false;
+                // Optional immediate deletion of sensitive files
+                // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                var deleteSensitiveFiles = string.Equals(
+                    Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                    "true",
+                    StringComparison.OrdinalIgnoreCase);
 
                 if (deleteSensitiveFiles)
                 {
diff --git a/DotNET/Endpoint Examples/Multipart Payload/pdf-with-redacted-text-preview.cs b/DotNET/Endpoint Examples/Multipart Payload/pdf-with-redacted-text-preview.cs
@@ -93,8 +93,12 @@ public static async Task Execute(string[] args)
                 //
                 // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                // Toggle deletion of sensitive files (default: false)
-                var deleteSensitiveFiles = false;
+                // Optional immediate deletion of sensitive files
+                // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                var deleteSensitiveFiles = string.Equals(
+                    Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                    "true",
+                    StringComparison.OrdinalIgnoreCase);
 
                 if (deleteSensitiveFiles)
                 {
diff --git a/DotNET/Endpoint Examples/Multipart Payload/restricted-pdf.cs b/DotNET/Endpoint Examples/Multipart Payload/restricted-pdf.cs
@@ -82,8 +82,12 @@ public static async Task Execute(string[] args)
                 //
                 // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                // Toggle deletion of sensitive files (default: false)
-                var deleteSensitiveFiles = false;
+                // Optional immediate deletion of sensitive files
+                // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                var deleteSensitiveFiles = string.Equals(
+                    Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                    "true",
+                    StringComparison.OrdinalIgnoreCase);
 
                 if (deleteSensitiveFiles)
                 {
diff --git a/DotNET/Endpoint Examples/Multipart Payload/unrestricted-pdf.cs b/DotNET/Endpoint Examples/Multipart Payload/unrestricted-pdf.cs
@@ -78,8 +78,12 @@ public static async Task Execute(string[] args)
                 //
                 // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                // Toggle deletion of sensitive files (default: false)
-                var deleteSensitiveFiles = false;
+                // Optional immediate deletion of sensitive files
+                // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                var deleteSensitiveFiles = string.Equals(
+                    Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                    "true",
+                    StringComparison.OrdinalIgnoreCase);
 
                 if (deleteSensitiveFiles)
                 {
diff --git a/DotNET/Endpoint Examples/Multipart Payload/watermarked-pdf.cs b/DotNET/Endpoint Examples/Multipart Payload/watermarked-pdf.cs
@@ -76,8 +76,12 @@ public static async Task Execute(string[] args)
                 //
                 // Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.
 
-                // Toggle deletion of sensitive files (default: false)
-                var deleteSensitiveFiles = false;
+                // Optional immediate deletion of sensitive files
+                // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true
+                var deleteSensitiveFiles = string.Equals(
+                    Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),
+                    "true",
+                    StringComparison.OrdinalIgnoreCase);
 
                 if (deleteSensitiveFiles)
                 {
diff --git a/DotNET/Program.cs b/DotNET/Program.cs
@@ -117,6 +117,7 @@ static void PrintUsage()
     Console.Error.WriteLine("Environment (.env supported):");
     Console.Error.WriteLine("  PDFREST_API_KEY=...    Required API key");
     Console.Error.WriteLine("  PDFREST_URL=...        Optional base URL (e.g., https://eu-api.pdfrest.com for EU/GDPR)");
+    Console.Error.WriteLine("  PDFREST_DELETE_SENSITIVE_FILES  Optional immediate deletion (true|false; default false)\n");
 }
 
 // Entry point
diff --git a/DotNET/README.md b/DotNET/README.md
@@ -120,7 +120,13 @@ Each script builds the project once, discovers suitable inputs inside the direct
 
 ## Optional deletion toggle
 
-- Some samples include an optional delete step to remove uploaded/generated files from pdfRest servers. This is controlled by a local `var deleteSensitiveFiles = false;` variable near the top of the file. Set it to `true` to enable deletion; it is off by default.
+- Some samples include an optional delete step to remove uploaded/generated files from pdfRest servers. By default, this is OFF. To enable immediate deletion for supported samples, set the following environment variable:
+
+  ```
+  PDFREST_DELETE_SENSITIVE_FILES=true
+  ```
+
+  If unset or set to any value other than `true` (case-insensitive), deletion remains disabled. The default behavior retains files according to the File Retention Period shown on https://pdfrest.com/pricing.
 
 ## Project Structure & Build Notes
 

Original file line number	Diff line number	Diff line change
`@@ -104,8 +104,12 @@ public static async Task Execute(string[] args)`
`104`	`104`	`//`
`105`	`105`	`// Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.`
`106`	`106`
`107`		`- // Toggle deletion of sensitive files (default: false)`
`108`		`- var deleteSensitiveFiles = false;`
	`107`	`+ // Optional immediate deletion of sensitive files`
	`108`	`+ // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true`
	`109`	`+ var deleteSensitiveFiles = string.Equals(`
	`110`	`+ Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),`
	`111`	`+ "true",`
	`112`	`+ StringComparison.OrdinalIgnoreCase);`
`109`	`113`
`110`	`114`	`if (deleteSensitiveFiles)`
`111`	`115`	`{`
`@@ -130,4 +134,4 @@ public static async Task Execute(string[] args)`
`130`	`134`	`}`
`131`	`135`	`}`
`132`	`136`	`}`
`133`		`-}`
	`137`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -101,8 +101,12 @@ public static async Task Execute(string[] args)`
`101`	`101`	`//`
`102`	`102`	`// Deletes all files in the workflow, including outputs. Save all desired files before enabling this step.`
`103`	`103`
`104`		`- // Toggle deletion of sensitive files (default: false)`
`105`		`- var deleteSensitiveFiles = false;`
	`104`	`+ // Optional immediate deletion of sensitive files`
	`105`	`+ // Default: false; override with PDFREST_DELETE_SENSITIVE_FILES=true`
	`106`	`+ var deleteSensitiveFiles = string.Equals(`
	`107`	`+ Environment.GetEnvironmentVariable("PDFREST_DELETE_SENSITIVE_FILES"),`
	`108`	`+ "true",`
	`109`	`+ StringComparison.OrdinalIgnoreCase);`
`106`	`110`
`107`	`111`	`if (deleteSensitiveFiles)`
`108`	`112`	`{`
`@@ -126,4 +130,4 @@ public static async Task Execute(string[] args)`
`126`	`130`	`}`
`127`	`131`	`}`
`128`	`132`	`}`
`129`		`-}`
	`133`	`+}`