docspring 3.1.0 → 3.2.0

package/AGENTS.md

@@ -0,0 +1,33 @@
+# AGENTS.md
+
+Notes for AI coding agents working with the DocSpring JavaScript SDK (`docspring`), in this repository or
+as a dependency of an app.
+
+## This code is generated
+
+Every file here is generated from DocSpring's OpenAPI spec by
+[DocSpring's fork of OpenAPI Generator](https://github.com/DocSpring/openapi-generator/tree/docspring/all_patches), and each release replaces
+all of it. Don't edit it or open pull requests that change it, and don't patch an installed copy: the next release
+overwrites the change. Report bugs at https://github.com/DocSpring/docspring-javascript/issues or to support@docspring.com, and DocSpring fixes them in
+the generator.
+
+## Where to look
+
+- [README.md](README.md): install, configuration, an example and how errors and API changes are handled.
+- [docs/Client.md](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md): every method, with its parameters and return type.
+- [docs/](https://github.com/DocSpring/docspring-javascript/tree/main/docs): every model and its fields.
+- https://docspring.com/docs/llms.txt: DocSpring's documentation for LLMs (`llms-small.txt`, `llms-full.txt`).
+- https://docspring.com/docs/api/: the API reference, with JavaScript code for every method.
+- https://docspring.com/api-docs/v1/openapi.json: the OpenAPI spec this SDK is generated from.
+
+## Using it in an app
+
+- Credentials come from `DOCSPRING_TOKEN_ID` and `DOCSPRING_TOKEN_SECRET`. Keep them in the environment or a secret
+  store, never in code. Accounts in the EU region also need `DOCSPRING_REGION=EU`.
+- Template IDs look like `tpl_...` and submission IDs like `sub_...`.
+- Pass `test: true` when you generate PDFs during development: test PDFs are free and watermarked.
+- Generating a PDF waits for it, for up to 95 seconds. For many PDFs or slow templates, set `wait` to false and use
+  webhooks or check the submission later (https://docspring.com/docs/api-guide/synchronous-requests/).
+- Errors: The callback gets `(error, data, response)`. For an error response, `error.status` is the HTTP status and `response.body` the parsed body.
+- Responses can be newer than this SDK, because DocSpring adds fields and enum values to API v1 without a new
+  version. The model object keeps a response field added to the API after this release as a property. An enum value added to the API after this release comes back as a string, so handle values you don't recognize.

package/README.md

@@ -1,246 +1,179 @@
-# docspring
+# DocSpring JavaScript SDK
 
-DocSpring - JavaScript client for docspring
-Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+The official JavaScript 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.
 
-- API version: v1
-- Package version: 3.1.0
-- Generator version: 7.16.0-DOCSPRING
-- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
+[Documentation](https://docspring.com/docs/) · [API reference](https://docspring.com/docs/api/) ·
+[npm](https://www.npmjs.com/package/docspring) · [Changelog](https://github.com/DocSpring/docspring-javascript/blob/main/CHANGELOG.md)
 
-## Installation
+Version 3.2.0. 
 
-### For [Node.js](https://nodejs.org/)
+## Install and configure
 
-#### npm
+Add docspring to your package.json:
 
-To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
-
-Then install it via:
-
-```shell
+```bash
 npm install docspring --save
 ```
 
-Finally, you need to build the module:
-
-```shell
-npm run build
-```
-
-##### Local development
-
-To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
-
-```shell
-npm install
-```
-
-Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
+Or with Yarn:
 
-```shell
-npm link
+```bash
+yarn add docspring
 ```
 
-To use the link you just defined in your project, switch to the directory you want to use your docspring from, and run:
+Configure authentication via environment variables:
 
-```shell
-npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
+```bash
+export DOCSPRING_TOKEN_ID="API_TOKEN_ID"
+export DOCSPRING_TOKEN_SECRET="API_TOKEN_SECRET"
 ```
 
-Finally, you need to build the module:
+You can also configure the region or host. The host takes priority over the region:
 
-```shell
-npm run build
+```bash
+export DOCSPRING_REGION="US" # US or EU (defaults to US)
+export DOCSPRING_HOST="docspring.yourcompany.com" # For on-premise deployments
 ```
 
-#### git
-
-If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
-then install it via:
-
-```shell
-    npm install GIT_USER_ID/GIT_REPO_ID --save
-```
+Initialize the DocSpring client with no arguments:
 
-### For browser
-
-The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
-the above steps with Node.js and installing browserify with `npm install -g browserify`,
-perform the following (assuming *main.js* is your entry file):
-
-```shell
-browserify main.js > bundle.js
+```javascript
+const DocSpring = require("docspring");
+const apiInstance = new DocSpring.Client();
 ```
 
-Then include *bundle.js* in the HTML pages.
-
-### Webpack Configuration
-
-Using Webpack you may encounter the following error: "Module not found: Error:
-Cannot resolve module", most certainly you should disable AMD loader. Add/merge
-the following section to your webpack config:
+Or provide credentials directly:
 
 ```javascript
-module: {
-  rules: [
-    {
-      parser: {
-        amd: false
-      }
-    }
-  ]
-}
+const DocSpring = require("docspring");
+const apiInstance = new DocSpring.Client({
+  apiTokenId: "API_TOKEN_ID",
+  apiTokenSecret: "API_TOKEN_SECRET",
+});
 ```
 
-## Getting Started
+## Generate a PDF
 
-Please follow the [installation](#installation) instruction and execute the following JS code:
+Fill a template with data (use your template's ID in place of `tpl_1234567890abcdef01`):
 
 ```javascript
-var DocSpring = require('docspring');
-
-var defaultClient = DocSpring.ApiClient.instance;
-// Configure HTTP basic authorization: api_token_basic
-var api_token_basic = defaultClient.authentications['api_token_basic'];
-api_token_basic.username = 'YOUR USERNAME'
-api_token_basic.password = 'YOUR PASSWORD'
-
-var api = new DocSpring.Client()
-var template_id = "tpl_1234567890abcdef02"; // {String} 
-var data = new DocSpring.AddFieldsData(); // {AddFieldsData} 
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
+const templateId = 'tpl_1234567890abcdef01'
+const submission = {
+  data: {
+    first_name: 'John',
+    last_name: 'Smith',
+    phone_number: '+11234567890',
+  },
+  metadata: { foo: 123, bar: 'baz' },
+}
+const wait = undefined
+
+apiInstance.generatePdf(
+  templateId,
+  submission,
+  { wait: wait },
+  (error, data, response) => {
+    if (error) {
+      console.error('Error calling generatePdf:', error)
+    } else {
+      console.log('API call completed successfully:', data)
+    }
   }
-};
-api.addFieldsToTemplate(template_id, data, callback);
-
+)
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://sync.api.docspring.com/api/v1*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*DocSpring.Client* | [**addFieldsToTemplate**](docs/Client.md#addFieldsToTemplate) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
-*DocSpring.Client* | [**batchGeneratePdfs**](docs/Client.md#batchGeneratePdfs) | **POST** /submissions/batches | Generate multiple PDFs
-*DocSpring.Client* | [**combinePdfs**](docs/Client.md#combinePdfs) | **POST** /combined_submissions | Merge submission PDFs, template PDFs, or custom files
-*DocSpring.Client* | [**copyTemplate**](docs/Client.md#copyTemplate) | **POST** /templates/{template_id}/copy | Copy a template
-*DocSpring.Client* | [**createCustomFileFromUpload**](docs/Client.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached S3 upload
-*DocSpring.Client* | [**createDataRequestEvent**](docs/Client.md#createDataRequestEvent) | **POST** /data_requests/{data_request_id}/events | Create a new event for emailing a signee a request for signature
-*DocSpring.Client* | [**createDataRequestToken**](docs/Client.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Create a new data request token for form authentication
-*DocSpring.Client* | [**createFolder**](docs/Client.md#createFolder) | **POST** /folders/ | Create a folder
-*DocSpring.Client* | [**createHtmlTemplate**](docs/Client.md#createHtmlTemplate) | **POST** /templates?endpoint_variant&#x3D;create_html_template | Create a new HTML template
-*DocSpring.Client* | [**createPdfTemplate**](docs/Client.md#createPdfTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
-*DocSpring.Client* | [**createPdfTemplateFromUpload**](docs/Client.md#createPdfTemplateFromUpload) | **POST** /templates?endpoint_variant&#x3D;create_template_from_cached_upload | Create a new PDF template from a cached S3 file upload
-*DocSpring.Client* | [**createWebhook**](docs/Client.md#createWebhook) | **POST** /webhooks | Create a webhook
-*DocSpring.Client* | [**deleteFolder**](docs/Client.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
-*DocSpring.Client* | [**deleteTemplate**](docs/Client.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
-*DocSpring.Client* | [**deleteWebhook**](docs/Client.md#deleteWebhook) | **DELETE** /webhooks/{webhook_id} | Delete a webhook
-*DocSpring.Client* | [**expireCombinedSubmission**](docs/Client.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
-*DocSpring.Client* | [**expireSubmission**](docs/Client.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
-*DocSpring.Client* | [**generatePdf**](docs/Client.md#generatePdf) | **POST** /templates/{template_id}/submissions | Generate a PDF
-*DocSpring.Client* | [**generatePreview**](docs/Client.md#generatePreview) | **POST** /submissions/{submission_id}/generate_preview | Generate a preview PDF for partially completed data requests
-*DocSpring.Client* | [**getCombinedSubmission**](docs/Client.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
-*DocSpring.Client* | [**getDataRequest**](docs/Client.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
-*DocSpring.Client* | [**getFullTemplate**](docs/Client.md#getFullTemplate) | **GET** /templates/{template_id}?full&#x3D;true | Fetch the full attributes for a PDF template
-*DocSpring.Client* | [**getPresignUrl**](docs/Client.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned S3 URL for direct file upload
-*DocSpring.Client* | [**getSubmission**](docs/Client.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
-*DocSpring.Client* | [**getSubmissionBatch**](docs/Client.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
-*DocSpring.Client* | [**getTemplate**](docs/Client.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
-*DocSpring.Client* | [**getTemplateModelCode**](docs/Client.md#getTemplateModelCode) | **GET** /templates/{template_id}/model_code | Generate typed model code for a template
-*DocSpring.Client* | [**getTemplateSchema**](docs/Client.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
-*DocSpring.Client* | [**getWebhook**](docs/Client.md#getWebhook) | **GET** /webhooks/{webhook_id} | Get a webhook
-*DocSpring.Client* | [**listCombinedSubmissions**](docs/Client.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
-*DocSpring.Client* | [**listFolders**](docs/Client.md#listFolders) | **GET** /folders/ | Get a list of all folders
-*DocSpring.Client* | [**listSubmissions**](docs/Client.md#listSubmissions) | **GET** /submissions | List all submissions
-*DocSpring.Client* | [**listTemplateSubmissions**](docs/Client.md#listTemplateSubmissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
-*DocSpring.Client* | [**listTemplates**](docs/Client.md#listTemplates) | **GET** /templates | Get a list of all templates
-*DocSpring.Client* | [**listWebhooks**](docs/Client.md#listWebhooks) | **GET** /webhooks | Get a list of all webhooks
-*DocSpring.Client* | [**moveFolderToFolder**](docs/Client.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
-*DocSpring.Client* | [**moveTemplateToFolder**](docs/Client.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
-*DocSpring.Client* | [**publishTemplateVersion**](docs/Client.md#publishTemplateVersion) | **POST** /templates/{template_id}/publish_version | Publish a template version
-*DocSpring.Client* | [**renameFolder**](docs/Client.md#renameFolder) | **POST** /folders/{folder_id}/rename | Rename a folder
-*DocSpring.Client* | [**restoreTemplateVersion**](docs/Client.md#restoreTemplateVersion) | **POST** /templates/{template_id}/restore_version | Restore a template version
-*DocSpring.Client* | [**testAuthentication**](docs/Client.md#testAuthentication) | **GET** /authentication | Test authentication
-*DocSpring.Client* | [**updateDataRequest**](docs/Client.md#updateDataRequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request
-*DocSpring.Client* | [**updateTemplate**](docs/Client.md#updateTemplate) | **PUT** /templates/{template_id} | Update a Template
-*DocSpring.Client* | [**updateTemplateDocument**](docs/Client.md#updateTemplateDocument) | **PUT** /templates/{template_id}?endpoint_variant&#x3D;update_template_pdf_with_form_post | Update a template&#39;s document with a form POST file upload
-*DocSpring.Client* | [**updateTemplateDocumentFromUpload**](docs/Client.md#updateTemplateDocumentFromUpload) | **PUT** /templates/{template_id}?endpoint_variant&#x3D;update_template_pdf_with_cached_upload | Update a template&#39;s document with a cached S3 file upload
-*DocSpring.Client* | [**updateWebhook**](docs/Client.md#updateWebhook) | **PUT** /webhooks/{webhook_id} | Update a webhook
-
-
-## Documentation for Models
-
- - [DocSpring.AddFieldsData](docs/AddFieldsData.md)
- - [DocSpring.BatchGeneratePdfs201Response](docs/BatchGeneratePdfs201Response.md)
- - [DocSpring.CombinePdfsData](docs/CombinePdfsData.md)
- - [DocSpring.CombinedSubmission](docs/CombinedSubmission.md)
- - [DocSpring.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
- - [DocSpring.CopyTemplateOptions](docs/CopyTemplateOptions.md)
- - [DocSpring.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
- - [DocSpring.CreateCustomFileData](docs/CreateCustomFileData.md)
- - [DocSpring.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
- - [DocSpring.CreateFolderData](docs/CreateFolderData.md)
- - [DocSpring.CreateHtmlTemplate](docs/CreateHtmlTemplate.md)
- - [DocSpring.CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)
- - [DocSpring.CreatePdfTemplate](docs/CreatePdfTemplate.md)
- - [DocSpring.CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
- - [DocSpring.CreateSubmissionDataRequestEventRequest](docs/CreateSubmissionDataRequestEventRequest.md)
- - [DocSpring.CreateSubmissionDataRequestEventResponse](docs/CreateSubmissionDataRequestEventResponse.md)
- - [DocSpring.CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)
- - [DocSpring.CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
- - [DocSpring.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
- - [DocSpring.CreateWebhookData](docs/CreateWebhookData.md)
- - [DocSpring.CustomFile](docs/CustomFile.md)
- - [DocSpring.ErrorOrMultipleErrorsResponse](docs/ErrorOrMultipleErrorsResponse.md)
- - [DocSpring.ErrorResponse](docs/ErrorResponse.md)
- - [DocSpring.Folder](docs/Folder.md)
- - [DocSpring.JsonSchema](docs/JsonSchema.md)
- - [DocSpring.ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
- - [DocSpring.MoveFolderData](docs/MoveFolderData.md)
- - [DocSpring.MoveTemplateData](docs/MoveTemplateData.md)
- - [DocSpring.MultipleErrorsResponse](docs/MultipleErrorsResponse.md)
- - [DocSpring.PublishVersionData](docs/PublishVersionData.md)
- - [DocSpring.RenameFolderData](docs/RenameFolderData.md)
- - [DocSpring.RestoreVersionData](docs/RestoreVersionData.md)
- - [DocSpring.Submission](docs/Submission.md)
- - [DocSpring.Submission422Response](docs/Submission422Response.md)
- - [DocSpring.SubmissionAction](docs/SubmissionAction.md)
- - [DocSpring.SubmissionBatch](docs/SubmissionBatch.md)
- - [DocSpring.SubmissionBatchData](docs/SubmissionBatchData.md)
- - [DocSpring.SubmissionBatchWithSubmissions](docs/SubmissionBatchWithSubmissions.md)
- - [DocSpring.SubmissionDataRequest](docs/SubmissionDataRequest.md)
- - [DocSpring.SubmissionDataRequestEvent](docs/SubmissionDataRequestEvent.md)
- - [DocSpring.SubmissionDataRequestShow](docs/SubmissionDataRequestShow.md)
- - [DocSpring.SubmissionDataRequestToken](docs/SubmissionDataRequestToken.md)
- - [DocSpring.SubmissionPreview](docs/SubmissionPreview.md)
- - [DocSpring.SuccessErrorResponse](docs/SuccessErrorResponse.md)
- - [DocSpring.SuccessMultipleErrorsResponse](docs/SuccessMultipleErrorsResponse.md)
- - [DocSpring.Template](docs/Template.md)
- - [DocSpring.TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)
- - [DocSpring.TemplateDeleteResponse](docs/TemplateDeleteResponse.md)
- - [DocSpring.TemplateModelCodeResponse](docs/TemplateModelCodeResponse.md)
- - [DocSpring.TemplatePreview](docs/TemplatePreview.md)
- - [DocSpring.TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)
- - [DocSpring.UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)
- - [DocSpring.UpdatePdfTemplate](docs/UpdatePdfTemplate.md)
- - [DocSpring.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
- - [DocSpring.UpdateWebhookData](docs/UpdateWebhookData.md)
- - [DocSpring.UploadPresignResponse](docs/UploadPresignResponse.md)
- - [DocSpring.Webhook](docs/Webhook.md)
-
-
-## Documentation for Authorization
-
-
-Authentication schemes defined for the API:
-### api_token_basic
-
-- **Type**: HTTP basic authentication
-
+By default the call waits for the PDF, for up to 95 seconds, and the submission in the response has its
+`download_url`. Set `wait` to false to get a pending submission straight away.
+[Sync vs. async processing](https://docspring.com/docs/api-guide/synchronous-requests/) covers the time limit, status
+checks and webhooks.
+
+## Methods
+
+[docs/Client.md](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md) has each method's parameters and return type, and
+[docs/](https://github.com/DocSpring/docspring-javascript/tree/main/docs) has the models. The [API reference](https://docspring.com/docs/api/) has
+JavaScript code for every method.
+
+| Method | Description |
+| ------ | ----------- |
+| [`addFieldsToTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#addfieldstotemplate) | Add new fields to a Template |
+| [`batchGeneratePdfs`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#batchgeneratepdfs) | Generate multiple PDFs |
+| [`combinePdfs`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#combinepdfs) | Merge submission PDFs, template PDFs, or custom files |
+| [`copyTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#copytemplate) | Copy a template |
+| [`createCustomFileFromUpload`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createcustomfilefromupload) | Create a new custom file from a cached S3 upload |
+| [`createDataRequestEvent`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createdatarequestevent) | Create a new event for emailing a signee a request for signature |
+| [`createDataRequestToken`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createdatarequesttoken) | Create a new data request token for form authentication |
+| [`createFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createfolder) | Create a folder |
+| [`createHtmlTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createhtmltemplate) | Create a new HTML template |
+| [`createPdfTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createpdftemplate) | Create a new PDF template with a form POST file upload |
+| [`createPdfTemplateFromUpload`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createpdftemplatefromupload) | Create a new PDF template from a cached S3 file upload |
+| [`createWebhook`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#createwebhook) | Create a webhook |
+| [`deleteFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deletefolder) | Delete a folder |
+| [`deleteTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deletetemplate) | Delete a template |
+| [`deleteWebhook`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#deletewebhook) | Delete a webhook |
+| [`expireCombinedSubmission`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#expirecombinedsubmission) | Expire a combined submission |
+| [`expireSubmission`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#expiresubmission) | Expire a PDF submission |
+| [`generatePdf`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#generatepdf) | Generate a PDF |
+| [`generatePreview`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#generatepreview) | Generate a preview PDF for partially completed data requests |
+| [`getCombinedSubmission`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getcombinedsubmission) | Check the status of a combined submission (merged PDFs) |
+| [`getDataRequest`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getdatarequest) | Look up a submission data request |
+| [`getFullTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getfulltemplate) | Fetch the full attributes for a PDF template |
+| [`getPresignUrl`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getpresignurl) | Get a presigned S3 URL for direct file upload |
+| [`getSubmission`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getsubmission) | Check the status of a PDF |
+| [`getSubmissionBatch`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getsubmissionbatch) | Check the status of a submission batch job |
+| [`getTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#gettemplate) | Check the status of an uploaded template |
+| [`getTemplateModelCode`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#gettemplatemodelcode) | Generate typed model code for a template |
+| [`getTemplateSchema`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#gettemplateschema) | Fetch the JSON schema for a template |
+| [`getWebhook`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#getwebhook) | Get a webhook |
+| [`listCombinedSubmissions`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listcombinedsubmissions) | Get a list of all combined submissions |
+| [`listFolders`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listfolders) | Get a list of all folders |
+| [`listSubmissions`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listsubmissions) | List all submissions |
+| [`listTemplates`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listtemplates) | Get a list of all templates |
+| [`listTemplateSubmissions`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listtemplatesubmissions) | List all submissions for a given template |
+| [`listWebhooks`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#listwebhooks) | Get a list of all webhooks |
+| [`moveFolderToFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#movefoldertofolder) | Move a folder |
+| [`moveTemplateToFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#movetemplatetofolder) | Move Template to folder |
+| [`publishTemplateVersion`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#publishtemplateversion) | Publish a template version |
+| [`renameFolder`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#renamefolder) | Rename a folder |
+| [`restoreTemplateVersion`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#restoretemplateversion) | Restore a template version |
+| [`testAuthentication`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#testauthentication) | Test authentication |
+| [`updateDataRequest`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updatedatarequest) | Update a submission data request |
+| [`updateTemplate`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updatetemplate) | Update a Template |
+| [`updateTemplateDocument`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updatetemplatedocument) | Update a template's document with a form POST file upload |
+| [`updateTemplateDocumentFromUpload`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updatetemplatedocumentfromupload) | Update a template's document with a cached S3 file upload |
+| [`updateWebhook`](https://github.com/DocSpring/docspring-javascript/blob/main/docs/Client.md#updatewebhook) | Update a webhook |
+
+## Errors
+
+The callback gets `(error, data, response)`. For an error response, `error.status` is the HTTP status and `response.body` the parsed body.
+
+## API changes
+
+DocSpring adds fields and enum values to API v1 without releasing a new API version. Changes that would break
+existing code, such as removing or renaming a field, go in a new API version
+([API changes](https://docspring.com/docs/api-guide/openapi-schema/#api-changes)). So this SDK keeps working with
+responses that are newer than it is:
+
+- The model object keeps a response field added to the API after this release as a property.
+- An enum value added to the API after this release comes back as a string, so handle values you don't recognize.
+
+Upgrade the SDK to read new fields and enum values. The [changelog](https://github.com/DocSpring/docspring-javascript/blob/main/CHANGELOG.md) lists
+what each release adds.
+
+## About this SDK
+
+This SDK is generated from DocSpring's [OpenAPI spec](https://docspring.com/api-docs/v1/openapi.json) with
+[DocSpring's fork of OpenAPI Generator](https://github.com/DocSpring/openapi-generator/tree/docspring/all_patches) 7.16.0.
+The fork doesn't change the JavaScript generator.
+
+On top of the generated code, we add:
+
+- A client constructor that reads your credentials, region and host from the environment.
+
+Because the code is generated, we can't merge pull requests that change it. Please
+[open an issue](https://github.com/DocSpring/docspring-javascript/issues) or email [support@docspring.com](mailto:support@docspring.com) instead, and
+we'll fix it in the generator. [AGENTS.md](https://github.com/DocSpring/docspring-javascript/blob/main/AGENTS.md) is a short guide for AI coding agents.
+
+## License
+
+MIT. See [LICENSE](https://github.com/DocSpring/docspring-javascript/blob/main/LICENSE).

package/dist/ApiClient.js

@@ -25,7 +25,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
  */
 /**
 * @module ApiClient
-* @version 3.1.0
+* @version 3.2.0
 */
 /**
 * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
@@ -66,7 +66,7 @@ var ApiClient = /*#__PURE__*/function () {
             * @default {}
             */
     this.defaultHeaders = {
-      'User-Agent': 'docspring-javascript-3.1.0'
+      'User-Agent': 'docspring-javascript-3.2.0'
     };
 
     /**

package/dist/api/Client.js

@@ -75,7 +75,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
 * Client service.
 * @module api/Client
-* @version 3.1.0
+* @version 3.2.0
 */
 var Client = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/model/AddFieldsData.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The AddFieldsData model module.
  * @module model/AddFieldsData
- * @version 3.1.0
+ * @version 3.2.0
  */
 var AddFieldsData = /*#__PURE__*/function () {
   /**

package/dist/model/BatchGeneratePdfs201Response.js

@@ -30,12 +30,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The BatchGeneratePdfs201Response model module.
  * @module model/BatchGeneratePdfs201Response
- * @version 3.1.0
+ * @version 3.2.0
  */
 var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>BatchGeneratePdfs201Response</code>.
    * @alias module:model/BatchGeneratePdfs201Response
+   * @extends Object
    * @param status {module:model/BatchGeneratePdfs201Response.StatusEnum} 
    * @param submission_batch {module:model/SubmissionBatch} 
    * @param submissions {Array.<Object>} 
@@ -70,6 +71,7 @@ var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
     value: function constructFromObject(data, obj) {
       if (data) {
         obj = obj || new BatchGeneratePdfs201Response();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
         if (data.hasOwnProperty('status')) {
           obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
         }
@@ -124,11 +126,6 @@ var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
       if (!Array.isArray(data['errors'])) {
         throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
       }
-      // validate the optional field `submission_batch`
-      if (data['submission_batch']) {
-        // data not null
-        _SubmissionBatch["default"].validateJSON(data['submission_batch']);
-      }
       // ensure the json data is an array
       if (!Array.isArray(data['submissions'])) {
         throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);

package/dist/model/CombinePdfsData.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CombinePdfsData model module.
  * @module model/CombinePdfsData
- * @version 3.1.0
+ * @version 3.2.0
  */
 var CombinePdfsData = /*#__PURE__*/function () {
   /**

package/dist/model/CombinedSubmission.js

@@ -30,12 +30,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CombinedSubmission model module.
  * @module model/CombinedSubmission
- * @version 3.1.0
+ * @version 3.2.0
  */
 var CombinedSubmission = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CombinedSubmission</code>.
    * @alias module:model/CombinedSubmission
+   * @extends Object
    * @param id {String} 
    * @param state {module:model/CombinedSubmission.StateEnum} 
    * @param expired {Boolean} 
@@ -92,6 +93,7 @@ var CombinedSubmission = /*#__PURE__*/function () {
     value: function constructFromObject(data, obj) {
       if (data) {
         obj = obj || new CombinedSubmission();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
         if (data.hasOwnProperty('id')) {
           obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
         }
@@ -201,26 +203,9 @@ var CombinedSubmission = /*#__PURE__*/function () {
       if (data['download_url'] && !(typeof data['download_url'] === 'string' || data['download_url'] instanceof String)) {
         throw new Error("Expected the field `download_url` to be a primitive type in the JSON string but got " + data['download_url']);
       }
-      if (data['actions']) {
-        // data not null
-        // ensure the json data is an array
-        if (!Array.isArray(data['actions'])) {
-          throw new Error("Expected the field `actions` to be an array in the JSON data but got " + data['actions']);
-        }
-        // validate the optional field `actions` (array)
-        var _iterator2 = _createForOfIteratorHelper(data['actions']),
-          _step2;
-        try {
-          for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
-            var item = _step2.value;
-            _CombinedSubmissionAction["default"].validateJSON(item);
-          }
-        } catch (err) {
-          _iterator2.e(err);
-        } finally {
-          _iterator2.f();
-        }
-        ;
+      // ensure the json data is an array
+      if (!Array.isArray(data['actions'])) {
+        throw new Error("Expected the field `actions` to be an array in the JSON data but got " + data['actions']);
       }
       return true;
     }

package/dist/model/CombinedSubmissionAction.js

@@ -29,12 +29,13 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CombinedSubmissionAction model module.
  * @module model/CombinedSubmissionAction
- * @version 3.1.0
+ * @version 3.2.0
  */
 var CombinedSubmissionAction = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CombinedSubmissionAction</code>.
    * @alias module:model/CombinedSubmissionAction
+   * @extends Object
    * @param id {String} 
    * @param integration_id {String} 
    * @param state {module:model/CombinedSubmissionAction.StateEnum} 
@@ -77,6 +78,7 @@ var CombinedSubmissionAction = /*#__PURE__*/function () {
     value: function constructFromObject(data, obj) {
       if (data) {
         obj = obj || new CombinedSubmissionAction();
+        _ApiClient["default"].constructFromObject(data, obj, 'Object');
         if (data.hasOwnProperty('id')) {
           obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
         }