Updated on 2026-10-15 13:05:03. Version: 3.1.0

Author: ndbroadbent

.openapi-generator/FILES

@@ -23,6 +23,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
@@ -51,12 +52,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
 docspring/__init__.py
 docspring/api/__init__.py
 docspring/api/client.py
@@ -84,6 +88,7 @@ docspring/models/create_submission_data_request_event_response.py
 docspring/models/create_submission_data_request_response.py
 docspring/models/create_submission_data_request_token_response.py
 docspring/models/create_submission_response.py
+docspring/models/create_webhook_data.py
 docspring/models/custom_file.py
 docspring/models/error_or_multiple_errors_response.py
 docspring/models/error_response.py
@@ -112,12 +117,15 @@ docspring/models/success_multiple_errors_response.py
 docspring/models/template.py
 docspring/models/template_add_fields_response.py
 docspring/models/template_delete_response.py
+docspring/models/template_model_code_response.py
 docspring/models/template_preview.py
 docspring/models/template_publish_version_response.py
 docspring/models/update_html_template.py
 docspring/models/update_pdf_template.py
 docspring/models/update_submission_data_request_data.py
+docspring/models/update_webhook_data.py
 docspring/models/upload_presign_response.py
+docspring/models/webhook.py
 docspring/py.typed
 docspring/rest.py
 git_push.sh
@@ -147,6 +155,7 @@ test/test_create_submission_data_request_event_response.py
 test/test_create_submission_data_request_response.py
 test/test_create_submission_data_request_token_response.py
 test/test_create_submission_response.py
+test/test_create_webhook_data.py
 test/test_custom_file.py
 test/test_error_or_multiple_errors_response.py
 test/test_error_response.py
@@ -175,10 +184,13 @@ test/test_success_multiple_errors_response.py
 test/test_template.py
 test/test_template_add_fields_response.py
 test/test_template_delete_response.py
+test/test_template_model_code_response.py
 test/test_template_preview.py
 test/test_template_publish_version_response.py
 test/test_update_html_template.py
 test/test_update_pdf_template.py
 test/test_update_submission_data_request_data.py
+test/test_update_webhook_data.py
 test/test_upload_presign_response.py
+test/test_webhook.py
 tox.ini

CHANGELOG.md

@@ -1,3 +1,42 @@
+### 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.
+- A response with an enum value added to the API after this release (e.g. a new submission state) no longer raises
+  an error. The attribute keeps the new value.
+- get_submission, list_submissions and list_template_submissions no longer fail when `include_data` isn't set.
+  `source`, `referrer` and `data` are optional on submissions, because the API only returns them with
+  `include_data`.
+- The `host` argument and `DOCSPRING_HOST` can end with `/api/v1/` or have spaces around them (a trailing slash
+  after `/api/v1` used to repeat it).
+- The package metadata names DocSpring as the author, declares the MIT license (like the LICENSE file) and links to
+  the docspring-python repository.
+
 ### 3.0.0 [September 24, 2025]
 
 - All our API clients are now 100% end-to-end tested against our real server.

README.md

@@ -4,7 +4,7 @@ Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 3.0.0
+- Package version: 3.1.0
 - Generator version: 7.16.0-DOCSPRING
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -18,9 +18,9 @@ Python 3.9+
 If the python package is hosted on a repository, you can install directly using:
 
 ```sh
-pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+pip install git+https://github.com/DocSpring/docspring-python.git
 ```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/DocSpring/docspring-python.git`)
 
 Then import the package:
 ```python
@@ -107,8 +107,10 @@ Class | Method | HTTP request | Description
 *Client* | [**create_html_template**](docs/Client.md#create_html_template) | **POST** /templates?endpoint_variant=create_html_template | Create a new HTML template
 *Client* | [**create_pdf_template**](docs/Client.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload
 *Client* | [**create_pdf_template_from_upload**](docs/Client.md#create_pdf_template_from_upload) | **POST** /templates?endpoint_variant=create_template_from_cached_upload | Create a new PDF template from a cached S3 file upload
+*Client* | [**create_webhook**](docs/Client.md#create_webhook) | **POST** /webhooks | Create a webhook
 *Client* | [**delete_folder**](docs/Client.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
 *Client* | [**delete_template**](docs/Client.md#delete_template) | **DELETE** /templates/{template_id} | Delete a template
+*Client* | [**delete_webhook**](docs/Client.md#delete_webhook) | **DELETE** /webhooks/{webhook_id} | Delete a webhook
 *Client* | [**expire_combined_submission**](docs/Client.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *Client* | [**expire_submission**](docs/Client.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
 *Client* | [**generate_pdf**](docs/Client.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generate a PDF
@@ -120,12 +122,15 @@ Class | Method | HTTP request | Description
 *Client* | [**get_submission**](docs/Client.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 *Client* | [**get_submission_batch**](docs/Client.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
 *Client* | [**get_template**](docs/Client.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
+*Client* | [**get_template_model_code**](docs/Client.md#get_template_model_code) | **GET** /templates/{template_id}/model_code | Generate typed model code for a template
 *Client* | [**get_template_schema**](docs/Client.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
+*Client* | [**get_webhook**](docs/Client.md#get_webhook) | **GET** /webhooks/{webhook_id} | Get a webhook
 *Client* | [**list_combined_submissions**](docs/Client.md#list_combined_submissions) | **GET** /combined_submissions | Get a list of all combined submissions
 *Client* | [**list_folders**](docs/Client.md#list_folders) | **GET** /folders/ | Get a list of all folders
 *Client* | [**list_submissions**](docs/Client.md#list_submissions) | **GET** /submissions | List all submissions
 *Client* | [**list_template_submissions**](docs/Client.md#list_template_submissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
 *Client* | [**list_templates**](docs/Client.md#list_templates) | **GET** /templates | Get a list of all templates
+*Client* | [**list_webhooks**](docs/Client.md#list_webhooks) | **GET** /webhooks | Get a list of all webhooks
 *Client* | [**move_folder_to_folder**](docs/Client.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
 *Client* | [**move_template_to_folder**](docs/Client.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
 *Client* | [**publish_template_version**](docs/Client.md#publish_template_version) | **POST** /templates/{template_id}/publish_version | Publish a template version
@@ -136,6 +141,7 @@ Class | Method | HTTP request | Description
 *Client* | [**update_template**](docs/Client.md#update_template) | **PUT** /templates/{template_id} | Update a Template
 *Client* | [**update_template_document**](docs/Client.md#update_template_document) | **PUT** /templates/{template_id}?endpoint_variant=update_template_pdf_with_form_post | Update a template's document with a form POST file upload
 *Client* | [**update_template_document_from_upload**](docs/Client.md#update_template_document_from_upload) | **PUT** /templates/{template_id}?endpoint_variant=update_template_pdf_with_cached_upload | Update a template's document with a cached S3 file upload
+*Client* | [**update_webhook**](docs/Client.md#update_webhook) | **PUT** /webhooks/{webhook_id} | Update a webhook
 
 
 ## Documentation For Models
@@ -159,6 +165,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)
@@ -187,12 +194,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>
@@ -208,6 +218,6 @@ Authentication schemes defined for the API:
 
 ## Author
 
-
+support@docspring.com