docspring-ts 4.1.0 → 4.3.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
@@ -89,5 +90,5 @@ keeps it.
 
 - List methods return `data` and `next_cursor`: pass `next_cursor` as `cursor` to get the next page.
 - Responses can be newer than this SDK, because DocSpring adds fields and enum values to API v2 without a new
-  version. The model leaves out a response field added to the API after this release. Enum values in responses are strings, so a
-  value added after this release comes back as it is: handle values you don't recognize.
+  version. The model leaves out a response field added to the API after this release. An enum value added after this release comes
+  back as the API sent it: handle values you don't recognize.

package/README.md

@@ -1,7 +1,8 @@
 # DocSpring TypeScript SDK
 
 The official TypeScript client for the [DocSpring API](https://docspring.com/docs/api/). DocSpring fills PDF
-templates with your data, generates PDFs from HTML templates, combines PDFs and collects e-signatures.
+forms with your data, generates PDFs and Word documents from HTML and Word templates, combines PDFs and collects
+e-signatures.
 
 [Documentation](https://docspring.com/docs/) · [API reference](https://docspring.com/docs/api/) ·
 [npm](https://www.npmjs.com/package/docspring-ts) · [Changelog](https://github.com/DocSpring/docspring-typescript/blob/main/CHANGELOG.md)
@@ -9,7 +10,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.1.0. 
+Version 4.3.0. 
 
 ## Install and configure
 
@@ -102,6 +103,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 |
@@ -122,6 +124,7 @@ TypeScript code for every method.
 | [`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 |
@@ -142,11 +145,11 @@ TypeScript code for every method.
 | [`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 |
+| [`updateTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#updatetemplatedocument) | Replace a template's document |
 | [`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 |
+| [`uploadTemplate`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplate) | Create a template from an uploaded PDF or Word document |
+| [`uploadTemplateDocument`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#uploadtemplatedocument) | Replace a template's document with an uploaded file |
 | [`validateSubmission`](https://github.com/DocSpring/docspring-typescript/blob/main/docs/Client.md#validatesubmission) | Check a submission without creating it |
 
 ## Errors
@@ -164,7 +167,7 @@ existing code, such as removing or renaming a field, go in a new API version
 responses that are newer than it is:
 
 - The model leaves out a response field added to the API after this release.
-- Enum values in responses are strings, so a value added to the API after this release comes back as it is: handle values you don't recognize.
+- An enum value added to the API after this release comes back as the API sent it: handle values you don't recognize.
 
 Upgrade the SDK to read new fields and enum values. The [changelog](https://github.com/DocSpring/docspring-typescript/blob/main/CHANGELOG.md) lists
 what each release adds.
@@ -182,6 +185,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

package/dist/RequestSchemas.js

@@ -638,7 +638,7 @@ exports.requestSchemas = {
                         "name": {
                             "type": "string",
                             "minLength": 1,
-                            "maxLength": 255
+                            "maxLength": 512
                         },
                         "parent_folder_id": {
                             "type": [
@@ -908,6 +908,8 @@ exports.requestSchemas = {
                                 "type": "string",
                                 "enum": [
                                     "pdf",
+                                    "docx",
+                                    "odt",
                                     "png"
                                 ]
                             }
@@ -947,7 +949,7 @@ exports.requestSchemas = {
                                             "string",
                                             "null"
                                         ],
-                                        "maxLength": 255
+                                        "maxLength": 254
                                     },
                                     "fields": {
                                         "type": "array",
@@ -1081,6 +1083,8 @@ exports.requestSchemas = {
                                 "type": "string",
                                 "enum": [
                                     "pdf",
+                                    "docx",
+                                    "odt",
                                     "png"
                                 ]
                             }
@@ -1116,6 +1120,8 @@ exports.requestSchemas = {
                                             "type": "string",
                                             "enum": [
                                                 "pdf",
+                                                "docx",
+                                                "odt",
                                                 "png"
                                             ]
                                         }
@@ -1175,7 +1181,7 @@ exports.requestSchemas = {
                         "name": {
                             "type": "string",
                             "minLength": 1,
-                            "maxLength": 255
+                            "maxLength": 512
                         },
                         "description": {
                             "type": [
@@ -1187,7 +1193,16 @@ exports.requestSchemas = {
                             "type": "string",
                             "enum": [
                                 "pdf",
-                                "html"
+                                "html",
+                                "docx"
+                            ]
+                        },
+                        "output_format": {
+                            "type": "string",
+                            "enum": [
+                                "pdf",
+                                "docx",
+                                "odt"
                             ]
                         },
                         "parent_folder_id": {
@@ -1714,6 +1729,9 @@ exports.requestSchemas = {
                             },
                             "additionalProperties": false
                         },
+                        "html_escape_data": {
+                            "type": "boolean"
+                        },
                         "cache_id": {
                             "type": "string",
                             "minLength": 1,
@@ -1768,6 +1786,34 @@ exports.requestSchemas = {
                 }
             }
         },
+        "createTemplatePreview": {
+            "query": {
+                "version": {
+                    "required": false,
+                    "schema": {
+                        "type": "string",
+                        "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
+                        "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
+                    }
+                }
+            },
+            "body": {
+                "mediaType": "application/json",
+                "required": true,
+                "schema": {
+                    "type": "object",
+                    "required": [
+                        "data"
+                    ],
+                    "properties": {
+                        "data": {
+                            "type": "object"
+                        }
+                    },
+                    "additionalProperties": false
+                }
+            }
+        },
         "createWebhook": {
             "body": {
                 "mediaType": "application/json",
@@ -1780,7 +1826,7 @@ exports.requestSchemas = {
                                 "string",
                                 "null"
                             ],
-                            "maxLength": 255
+                            "maxLength": 512
                         },
                         "url": {
                             "type": "string",
@@ -1922,6 +1968,9 @@ exports.requestSchemas = {
                             "items": {
                                 "type": "string",
                                 "enum": [
+                                    "pdf",
+                                    "docx",
+                                    "odt",
                                     "png"
                                 ]
                             }
@@ -1995,9 +2044,16 @@ exports.requestSchemas = {
                             "java",
                             "csharp",
                             "elixir",
-                            "go"
+                            "go",
+                            "rust"
                         ]
                     }
+                },
+                "just_types": {
+                    "required": false,
+                    "schema": {
+                        "type": "boolean"
+                    }
                 }
             }
         },
@@ -2013,6 +2069,7 @@ exports.requestSchemas = {
                 }
             }
         },
+        "getTemplatePreview": {},
         "getTemplateSchema": {
             "query": {
                 "version": {
@@ -2133,6 +2190,33 @@ exports.requestSchemas = {
                     "schema": {
                         "type": "string"
                     }
+                },
+                "state": {
+                    "required": false,
+                    "schema": {
+                        "type": "string",
+                        "enum": [
+                            "pending",
+                            "processed",
+                            "invalid_data",
+                            "error",
+                            "image_download_failed",
+                            "image_processing_failed",
+                            "waiting_for_signature_requests",
+                            "syntax_error",
+                            "insufficient_credits",
+                            "account_suspended",
+                            "license_revoked",
+                            "accidental",
+                            "declined"
+                        ]
+                    }
+                },
+                "include_files": {
+                    "required": false,
+                    "schema": {
+                        "type": "boolean"
+                    }
                 }
             }
         },
@@ -2189,6 +2273,33 @@ exports.requestSchemas = {
                     "schema": {
                         "type": "string"
                     }
+                },
+                "state": {
+                    "required": false,
+                    "schema": {
+                        "type": "string",
+                        "enum": [
+                            "pending",
+                            "processed",
+                            "invalid_data",
+                            "error",
+                            "image_download_failed",
+                            "image_processing_failed",
+                            "waiting_for_signature_requests",
+                            "syntax_error",
+                            "insufficient_credits",
+                            "account_suspended",
+                            "license_revoked",
+                            "accidental",
+                            "declined"
+                        ]
+                    }
+                },
+                "include_files": {
+                    "required": false,
+                    "schema": {
+                        "type": "boolean"
+                    }
                 }
             }
         },
@@ -2545,7 +2656,7 @@ exports.requestSchemas = {
                         "name": {
                             "type": "string",
                             "minLength": 1,
-                            "maxLength": 255
+                            "maxLength": 512
                         },
                         "description": {
                             "type": [
@@ -2553,6 +2664,14 @@ exports.requestSchemas = {
                                 "null"
                             ]
                         },
+                        "output_format": {
+                            "type": "string",
+                            "enum": [
+                                "pdf",
+                                "docx",
+                                "odt"
+                            ]
+                        },
                         "parent_folder_id": {
                             "type": [
                                 "string",
@@ -3118,6 +3237,9 @@ exports.requestSchemas = {
                                 }
                             },
                             "additionalProperties": false
+                        },
+                        "html_escape_data": {
+                            "type": "boolean"
                         }
                     },
                     "additionalProperties": false
@@ -3805,7 +3927,7 @@ exports.requestSchemas = {
                                 "string",
                                 "null"
                             ],
-                            "maxLength": 255
+                            "maxLength": 512
                         },
                         "url": {
                             "type": "string",
@@ -3926,7 +4048,7 @@ exports.requestSchemas = {
                         "name": {
                             "type": "string",
                             "minLength": 1,
-                            "maxLength": 255
+                            "maxLength": 512
                         },
                         "description": {
                             "type": "string"
@@ -3967,6 +4089,14 @@ exports.requestSchemas = {
                                 "ai",
                                 "none"
                             ]
+                        },
+                        "output_format": {
+                            "type": "string",
+                            "enum": [
+                                "pdf",
+                                "docx",
+                                "odt"
+                            ]
                         }
                     },
                     "additionalProperties": false
@@ -4044,6 +4174,8 @@ exports.requestSchemas = {
                                 "type": "string",
                                 "enum": [
                                     "pdf",
+                                    "docx",
+                                    "odt",
                                     "png"
                                 ]
                             }
@@ -4083,7 +4215,7 @@ exports.requestSchemas = {
                                             "string",
                                             "null"
                                         ],
-                                        "maxLength": 255
+                                        "maxLength": 254
                                     },
                                     "fields": {
                                         "type": "array",
@@ -4205,6 +4337,7 @@ exports.requestSchemas = {
         "GET /templates/{template_id}/fields": "listTemplateFields",
         "GET /templates/{template_id}/model_code": "getTemplateModelCode",
         "GET /templates/{template_id}/page_images": "getTemplatePageImages",
+        "GET /templates/{template_id}/previews/{preview_id}": "getTemplatePreview",
         "GET /templates/{template_id}/schema": "getTemplateSchema",
         "GET /templates/{template_id}/submissions": "listTemplateSubmissions",
         "GET /uploads/presign": "getPresignUrl",
@@ -4227,6 +4360,7 @@ exports.requestSchemas = {
         "POST /templates/{template_id}/fields/remove": "removeTemplateFields",
         "POST /templates/{template_id}/fields/reorder": "reorderTemplateFields",
         "POST /templates/{template_id}/move": "moveTemplate",
+        "POST /templates/{template_id}/previews": "createTemplatePreview",
         "POST /templates/{template_id}/publish_version": "publishTemplateVersion",
         "POST /templates/{template_id}/restore_version": "restoreTemplateVersion",
         "POST /templates/{template_id}/submissions": "createSubmission",