ON-36307 # Add GeneratePdfFromSubmissionData function to `PdfClient…

…` class

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "ms-dotnettools.csdevkit",
+        "ms-dotnettools.csharp",
+        "ms-dotnettools.vscodeintellicode-csharp",
+        "MS-CST-E.vscode-devskim"
+    ]
+}

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Added
+
+-   `GeneratePdfFromSubmissionData` function to `PdfClient` class
+
 ## 5.1.1 (2023-11-01)
 
 ### Added

OneBlink.SDK/PdfClient.cs

@@ -1,3 +1,4 @@
+#pragma warning disable IDE1006 // T is already uses throughout the codebase
 using System.Threading.Tasks;
 using System.IO;
 using OneBlink.SDK.Model;
@@ -39,5 +40,11 @@ public async Task<Stream> GeneratePdf(GeneratePdfOptionsRequest options)
             string url = "/pdf-document";
             return await this.oneBlinkPdfClient.PostRequest(url, options);
         }
+
+        public async Task<Stream> GeneratePdfFromSubmissionData<T>(GeneratePDFFromSubmissionDataRequest<T> options)
+        {
+            string url = "/generate-pdf";
+            return await this.oneBlinkPdfClient.PostRequest(url, options);
+        }
     }
 }

OneBlink.SDK/models/GeneratePDFFromSubmissionDataRequest.cs

@@ -0,0 +1,30 @@
+#pragma warning disable IDE1006 // Naming is dictated by OneBlink API
+using System;
+using System.Collections.Generic;
+
+namespace OneBlink.SDK.Model
+{
+    public class GeneratePDFFromSubmissionDataRequest<T>
+    {
+        public FormSubmission<T> submissionData
+        {
+            get; set;
+        }
+        public long formsAppId
+        {
+            get; set;
+        }
+        public List<string> excludedElementIds
+        {
+            get; set;
+        }
+        public bool? usePagesAsBreaks
+        {
+            get; set;
+        }
+        public List<string> excludedCSSClasses
+        {
+            get; set;
+        }
+    }
+}

docs/pdf-client.md

@@ -3,6 +3,8 @@
 ## Instance Functions
 
 -   [`GetSubmissionPdf()`](#getSubmissionpdf)
+-   [`GeneratePdf()`](#generatepdf)
+-   [`GeneratePdfFromSubmissionData()`](#generatepdffromsubmissiondata)
 
 ## Constructor
 
@@ -81,3 +83,33 @@ Stream response = await pdfClient.GeneratePdf(pdfOptionsRequest);
 ### Result
 
 A `Stream` object
+
+## `GeneratePdfFromSubmissionData()`
+
+### Example
+
+```c#
+MySubmissionDataType submissionData = new MySubmissionDataType();
+// populuate submissionData here
+long formsAppId = 1;
+GeneratePDFFromSubmissionDataRequest<MySubmissionDataType> options = new GeneratePDFFromSubmissionDataRequest<MySubmissionDataType>();
+options.submissionData = submissionData;
+options.formsAppId = formsAppId;
+PdfClient pdfClient = new PdfClient(ACCESS_KEY, SECRET_KEY);
+Stream response = await pdfClient.GeneratePdfFromSubmissionData<MySubmissionDataType>(options);
+```
+
+### Parameters
+
+| Parameter | Required | Type                                   | Description                                                                              |
+| --------- | -------- | -------------------------------------- | ---------------------------------------------------------------------------------------- |
+| `options` | Yes      | `GeneratePDFFromSubmissionDataRequest` | Includes various PDF configuration options and the submission data to be used in the PDF |
+
+### Throws
+
+-   `OneBlinkAPIException`
+-   `Exception`
+
+### Result
+
+A `Stream` object