docspring-ts 4.0.0 → 4.2.0

package/AGENTS.md

@@ -69,8 +69,9 @@ keeps it.
   (https://docspring.com/docs/webhooks/overview/). A webhook created with API v2 sends events in API v2's format
   (version 4).
 - Verify each request's `X-DocSpring-Signature` header before acting on it: an HMAC-SHA256 of `{t}.{raw body}` with the
-  webhook's signing secret, computed over the raw body exactly as received
-  (https://docspring.com/docs/webhooks/verifying-signatures/).
+  webhook's signing secret, where `t` must be within 5 minutes
+  (https://docspring.com/docs/webhooks/verifying-signatures/). Pass the raw body exactly as received, not parsed JSON,
+  to `verifyWebhookSignature(payload, signatureHeader, secret)` (exported by the package), which returns true or false.
 - No webhook is sent when a submission starts waiting for credits.
 
 ## Signature requests

package/README.md

@@ -9,7 +9,7 @@ templates with your data, generates PDFs from HTML templates, combines PDFs and
 The code in this repository is generated from DocSpring's OpenAPI spec ([About this SDK](#about-this-sdk)). Issues and
 pull requests are welcome.
 
-Version 4.0.0. 
+Version 4.2.0. 
 
 ## Install and configure
 
@@ -92,6 +92,7 @@ TypeScript code for every method.
 
 | Method | Description |
 | ------ | ----------- |
+| [`addTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#addtemplatefields) | Add fields to a template |
 | [`copyTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#copytemplate) | Copy a template |
 | [`createCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createcombinedpdf) | Combine PDFs |
 | [`createCustomFileFromUpload`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createcustomfilefromupload) | Create a custom file from an upload |
@@ -101,6 +102,7 @@ TypeScript code for every method.
 | [`createSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createsubmission) | Generate a PDF |
 | [`createSubmissionBatch`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createsubmissionbatch) | Generate PDFs in a batch |
 | [`createTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createtemplate) | Create a template |
+| [`createTemplatePreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createtemplatepreview) | Preview a template with data |
 | [`createWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#createwebhook) | Create a webhook |
 | [`deleteCustomFile`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletecustomfile) | Delete a custom file |
 | [`deleteFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletefolder) | Delete a folder |
@@ -108,6 +110,7 @@ TypeScript code for every method.
 | [`deleteWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#deletewebhook) | Delete a webhook |
 | [`expireCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#expirecombinedpdf) | Expire a combined PDF |
 | [`expireSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#expiresubmission) | Expire a submission |
+| [`generateSubmissionFiles`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#generatesubmissionfiles) | Generate more files |
 | [`generateSubmissionPreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#generatesubmissionpreview) | Generate a preview PDF |
 | [`getCombinedPdf`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getcombinedpdf) | Get a combined PDF |
 | [`getCustomFile`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getcustomfile) | Get a custom file |
@@ -117,28 +120,36 @@ TypeScript code for every method.
 | [`getSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getsubmission) | Get a submission |
 | [`getSubmissionBatch`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getsubmissionbatch) | Get a batch |
 | [`getTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplate) | Get a template |
+| [`getTemplateDiff`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatediff) | Compare a version of a template with the one before it |
 | [`getTemplateModelCode`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatemodelcode) | Generate typed code for a template's submission data |
+| [`getTemplatePageImages`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatepageimages) | Get images of a template's pages |
+| [`getTemplatePreview`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplatepreview) | Get a template preview |
 | [`getTemplateSchema`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#gettemplateschema) | Get the JSON Schema of a template's submission data |
 | [`getWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#getwebhook) | Get a webhook |
 | [`listCombinedPdfs`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listcombinedpdfs) | List combined PDFs |
 | [`listCustomFiles`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listcustomfiles) | List custom files |
 | [`listFolders`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listfolders) | List folders |
 | [`listSubmissions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listsubmissions) | List submissions |
+| [`listTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listtemplatefields) | List a template's fields |
 | [`listTemplates`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listtemplates) | List templates |
 | [`listTemplateSubmissions`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listtemplatesubmissions) | List a template's submissions |
 | [`listWebhooks`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#listwebhooks) | List webhooks |
 | [`moveFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#movefolder) | Move a folder |
 | [`moveTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#movetemplate) | Move a template to a folder |
 | [`publishTemplateVersion`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#publishtemplateversion) | Publish a template version |
+| [`removeTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#removetemplatefields) | Remove fields from a template |
 | [`renameFolder`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#renamefolder) | Rename a folder |
+| [`reorderTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#reordertemplatefields) | Reorder a template's fields |
 | [`restoreTemplateVersion`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#restoretemplateversion) | Restore a template version |
 | [`testAuthentication`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#testauthentication) | Test authentication |
 | [`updateSignatureRequest`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatesignaturerequest) | Update a signature request |
 | [`updateTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplate) | Update a template |
 | [`updateTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplatedocument) | Replace a template's PDF |
+| [`updateTemplateFields`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplatefields) | Update a template's fields |
 | [`updateWebhook`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatewebhook) | Update a webhook |
 | [`uploadTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplate) | Create a PDF template from an uploaded PDF |
 | [`uploadTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplatedocument) | Replace a template's PDF with an uploaded PDF |
+| [`validateSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#validatesubmission) | Check a submission without creating it |
 
 ## Errors
 
@@ -173,6 +184,7 @@ On top of the generated code, we add:
 
 - A client constructor that reads your credentials, region and host from the environment.
 - `instanceof ApiException` and `instanceof RequiredError` are true for the errors the client throws. Stock OpenAPI Generator's classes lose their prototype when compiled to ES5, so both were false.
+- `verifyWebhookSignature(payload, signatureHeader, secret)` checks a webhook request's `X-DocSpring-Signature` header, with a `{ tolerance, now }` options object.
 
 Each release regenerates every file, so a change made only here would be lost in the next one. Issues and pull
 requests are welcome all the same: [open an issue](https://github.com/DocSpring/docspring-typescript/issues) or a pull request, or email