Updated on 2026-10-15 13:09:28. Version: 3.1.0

Author: ndbroadbent

.openapi-generator/FILES

@@ -25,6 +25,7 @@ docs/CreateSubmissionDataRequestEventResponse.md
 docs/CreateSubmissionDataRequestResponse.md
 docs/CreateSubmissionDataRequestTokenResponse.md
 docs/CreateSubmissionResponse.md
+docs/CreateWebhookData.md
 docs/CustomFile.md
 docs/ErrorOrMultipleErrorsResponse.md
 docs/ErrorResponse.md
@@ -53,12 +54,15 @@ docs/SuccessMultipleErrorsResponse.md
 docs/Template.md
 docs/TemplateAddFieldsResponse.md
 docs/TemplateDeleteResponse.md
+docs/TemplateModelCodeResponse.md
 docs/TemplatePreview.md
 docs/TemplatePublishVersionResponse.md
 docs/UpdateHtmlTemplate.md
 docs/UpdatePdfTemplate.md
 docs/UpdateSubmissionDataRequestData.md
+docs/UpdateWebhookData.md
 docs/UploadPresignResponse.md
+docs/Webhook.md
 git_push.sh
 gradle.properties
 gradle/wrapper/gradle-wrapper.jar
@@ -93,6 +97,7 @@ src/main/java/com/docspring/CreateSubmissionDataRequestEventResponse.java
 src/main/java/com/docspring/CreateSubmissionDataRequestResponse.java
 src/main/java/com/docspring/CreateSubmissionDataRequestTokenResponse.java
 src/main/java/com/docspring/CreateSubmissionResponse.java
+src/main/java/com/docspring/CreateWebhookData.java
 src/main/java/com/docspring/CustomFile.java
 src/main/java/com/docspring/ErrorOrMultipleErrorsResponse.java
 src/main/java/com/docspring/ErrorResponse.java
@@ -130,12 +135,15 @@ src/main/java/com/docspring/SuccessMultipleErrorsResponse.java
 src/main/java/com/docspring/Template.java
 src/main/java/com/docspring/TemplateAddFieldsResponse.java
 src/main/java/com/docspring/TemplateDeleteResponse.java
+src/main/java/com/docspring/TemplateModelCodeResponse.java
 src/main/java/com/docspring/TemplatePreview.java
 src/main/java/com/docspring/TemplatePublishVersionResponse.java
 src/main/java/com/docspring/UpdateHtmlTemplate.java
 src/main/java/com/docspring/UpdatePdfTemplate.java
 src/main/java/com/docspring/UpdateSubmissionDataRequestData.java
+src/main/java/com/docspring/UpdateWebhookData.java
 src/main/java/com/docspring/UploadPresignResponse.java
+src/main/java/com/docspring/Webhook.java
 src/main/java/com/docspring/auth/ApiKeyAuth.java
 src/main/java/com/docspring/auth/Authentication.java
 src/main/java/com/docspring/auth/HttpBasicAuth.java
@@ -160,6 +168,7 @@ src/test/java/com/docspring/CreateSubmissionDataRequestEventResponseTest.java
 src/test/java/com/docspring/CreateSubmissionDataRequestResponseTest.java
 src/test/java/com/docspring/CreateSubmissionDataRequestTokenResponseTest.java
 src/test/java/com/docspring/CreateSubmissionResponseTest.java
+src/test/java/com/docspring/CreateWebhookDataTest.java
 src/test/java/com/docspring/CustomFileTest.java
 src/test/java/com/docspring/ErrorOrMultipleErrorsResponseTest.java
 src/test/java/com/docspring/ErrorResponseTest.java
@@ -187,10 +196,13 @@ src/test/java/com/docspring/SuccessErrorResponseTest.java
 src/test/java/com/docspring/SuccessMultipleErrorsResponseTest.java
 src/test/java/com/docspring/TemplateAddFieldsResponseTest.java
 src/test/java/com/docspring/TemplateDeleteResponseTest.java
+src/test/java/com/docspring/TemplateModelCodeResponseTest.java
 src/test/java/com/docspring/TemplatePreviewTest.java
 src/test/java/com/docspring/TemplatePublishVersionResponseTest.java
 src/test/java/com/docspring/TemplateTest.java
 src/test/java/com/docspring/UpdateHtmlTemplateTest.java
 src/test/java/com/docspring/UpdatePdfTemplateTest.java
 src/test/java/com/docspring/UpdateSubmissionDataRequestDataTest.java
+src/test/java/com/docspring/UpdateWebhookDataTest.java
 src/test/java/com/docspring/UploadPresignResponseTest.java
+src/test/java/com/docspring/WebhookTest.java

CHANGELOG.md

@@ -1,3 +1,41 @@
+### 3.1.0 [October 15, 2026]
+
+- Submissions and data requests can now be in the `declined` state, when a signer declines to sign. Data
+  requests have a new `declined_at` timestamp. Earlier versions raise an error when they read a declined
+  submission or data request.
+- New API methods for webhooks: create_webhook, list_webhooks, get_webhook, update_webhook and delete_webhook.
+- New API method: get_template_model_code, which generates typed model code for a template's submission data, so
+  your app can catch mistakes before it calls the API.
+- Templates:
+  - Field dependencies: `field_dependencies` when you create or update a template, and `dependencies` on the fields
+    you add with add_fields_to_template.
+  - add_fields_to_template accepts the `initials` field type and an `editable` setting for each field.
+  - Embedded template editor settings: `embed_edit_allow_document_replacement`, `embed_edit_allow_settings`,
+    `embed_edit_allow_versioning` and `embed_edit_token`.
+  - New `template_schema_version` attribute.
+  - A template's `path` is never null.
+  - Individual template `defaults` can be null (for example `fontSize` after it's cleared in the template editor).
+  - `last_changed_by_type` can be `external_user` (a change made in the embedded template editor), with
+    `last_changed_by_external_id`, `last_changed_by_external_name` and `last_changed_by_external_email`.
+  - Template versions say who published them with `published_by_type`, `published_by_user_id`,
+    `published_by_name`, `published_by_email` and `published_by_external_id`. These replace `published_by_id`,
+    which the API no longer returns.
+  - The JSON schema from get_template_schema includes `$id`, `allOf` and `dependencies`.
+- copy_template accepts a template `version`, and `parent_folder_id` is now optional. move_template_to_folder also
+  accepts a `version`.
+- Pass a null `parent_folder_id` to move_template_to_folder or move_folder_to_folder to move it to the root folder.
+- Submissions and submission actions include an `error_message` when processing fails.
+- combine_pdfs: `delete_custom_files` now deletes the custom files once the merged PDF is processed (it used to be
+  ignored). `test` has no effect and is deprecated.
+- `new Client()` reads `DOCSPRING_TOKEN_ID`, `DOCSPRING_TOKEN_SECRET`, `DOCSPRING_HOST` and `DOCSPRING_REGION`
+  (US or EU) from the environment, for any credentials or host not already set on the default ApiClient. New
+  constructors: `Client(apiTokenId, apiTokenSecret)` and `Client(apiTokenId, apiTokenSecret, host, region)`.
+- An enum value added to the API after this release (e.g. a new submission state) deserializes as
+  `UNKNOWN_DEFAULT_OPEN_API` instead of throwing, or as `null` for an attribute that can be null. Enums have the
+  new `UNKNOWN_DEFAULT_OPEN_API` constant, so an exhaustive `switch` over one needs a case for it.
+- `source`, `referrer` and `data` are optional on submissions, because get_submission, list_submissions and
+  list_template_submissions only return them with `include_data`. `getSource()` is now `@Nullable`.
+
 ### 3.0.1 [September 24, 2025]
 
 - Accidentally had a hard-coded 2.x version in the user agent string for v3.0.0

README.md

@@ -42,7 +42,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.docspring</groupId>
   <artifactId>DocSpring</artifactId>
-  <version>3.0.1</version>
+  <version>3.1.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -58,7 +58,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "com.docspring:DocSpring:3.0.1"
+     implementation "com.docspring:DocSpring:3.1.0"
   }
 ```
 
@@ -72,7 +72,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-- `target/DocSpring-3.0.1.jar`
+- `target/DocSpring-3.1.0.jar`
 - `target/lib/*.jar`
 
 ## Usage
@@ -157,8 +157,10 @@ Class | Method | HTTP request | Description
 *Client* | [**createHtmlTemplate**](docs/Client.md#createHtmlTemplate) | **POST** /templates?endpoint_variant&#x3D;create_html_template | Create a new HTML template
 *Client* | [**createPdfTemplate**](docs/Client.md#createPdfTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
 *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
+*Client* | [**createWebhook**](docs/Client.md#createWebhook) | **POST** /webhooks | Create a webhook
 *Client* | [**deleteFolder**](docs/Client.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
 *Client* | [**deleteTemplate**](docs/Client.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
+*Client* | [**deleteWebhook**](docs/Client.md#deleteWebhook) | **DELETE** /webhooks/{webhook_id} | Delete a webhook
 *Client* | [**expireCombinedSubmission**](docs/Client.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *Client* | [**expireSubmission**](docs/Client.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
 *Client* | [**generatePdf**](docs/Client.md#generatePdf) | **POST** /templates/{template_id}/submissions | Generate a PDF
@@ -170,12 +172,15 @@ Class | Method | HTTP request | Description
 *Client* | [**getSubmission**](docs/Client.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 *Client* | [**getSubmissionBatch**](docs/Client.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
 *Client* | [**getTemplate**](docs/Client.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
+*Client* | [**getTemplateModelCode**](docs/Client.md#getTemplateModelCode) | **GET** /templates/{template_id}/model_code | Generate typed model code for a template
 *Client* | [**getTemplateSchema**](docs/Client.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
+*Client* | [**getWebhook**](docs/Client.md#getWebhook) | **GET** /webhooks/{webhook_id} | Get a webhook
 *Client* | [**listCombinedSubmissions**](docs/Client.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
 *Client* | [**listFolders**](docs/Client.md#listFolders) | **GET** /folders/ | Get a list of all folders
 *Client* | [**listSubmissions**](docs/Client.md#listSubmissions) | **GET** /submissions | List all submissions
 *Client* | [**listTemplateSubmissions**](docs/Client.md#listTemplateSubmissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
 *Client* | [**listTemplates**](docs/Client.md#listTemplates) | **GET** /templates | Get a list of all templates
+*Client* | [**listWebhooks**](docs/Client.md#listWebhooks) | **GET** /webhooks | Get a list of all webhooks
 *Client* | [**moveFolderToFolder**](docs/Client.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
 *Client* | [**moveTemplateToFolder**](docs/Client.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
 *Client* | [**publishTemplateVersion**](docs/Client.md#publishTemplateVersion) | **POST** /templates/{template_id}/publish_version | Publish a template version
@@ -186,6 +191,7 @@ Class | Method | HTTP request | Description
 *Client* | [**updateTemplate**](docs/Client.md#updateTemplate) | **PUT** /templates/{template_id} | Update a Template
 *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
 *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
+*Client* | [**updateWebhook**](docs/Client.md#updateWebhook) | **PUT** /webhooks/{webhook_id} | Update a webhook
 
 
 ## Documentation for Models
@@ -209,6 +215,7 @@ Class | Method | HTTP request | Description
  - [CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)
  - [CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
  - [CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
+ - [CreateWebhookData](docs/CreateWebhookData.md)
  - [CustomFile](docs/CustomFile.md)
  - [ErrorOrMultipleErrorsResponse](docs/ErrorOrMultipleErrorsResponse.md)
  - [ErrorResponse](docs/ErrorResponse.md)
@@ -237,12 +244,15 @@ Class | Method | HTTP request | Description
  - [Template](docs/Template.md)
  - [TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)
  - [TemplateDeleteResponse](docs/TemplateDeleteResponse.md)
+ - [TemplateModelCodeResponse](docs/TemplateModelCodeResponse.md)
  - [TemplatePreview](docs/TemplatePreview.md)
  - [TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)
  - [UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)
  - [UpdatePdfTemplate](docs/UpdatePdfTemplate.md)
  - [UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
+ - [UpdateWebhookData](docs/UpdateWebhookData.md)
  - [UploadPresignResponse](docs/UploadPresignResponse.md)
+ - [Webhook](docs/Webhook.md)
 
 
 <a id="documentation-for-authorization"></a>