Updated on 2026-10-18 16:56:57. Version: 3.2.0

Author: ndbroadbent

AGENTS.md

@@ -0,0 +1,33 @@
+# AGENTS.md
+
+Notes for AI coding agents working with the DocSpring Python 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-python/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-python/blob/main/docs/Client.md): every method, with its parameters and return type.
+- [docs/](https://github.com/DocSpring/docspring-python/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 Python 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: Methods raise `docspring.ApiException` for an error response (or a subclass from `docspring.exceptions`, such as `NotFoundException`), with the HTTP status in `status` and the body in `body`.
+- Responses can be newer than this SDK, because DocSpring adds fields and enum values to API v1 without a new
+  version. The model keeps a response field added to the API after this release in its `additional_properties` dict. An enum value added to the API after this release comes back as a string, so handle values you don't recognize.

CHANGELOG.md

@@ -1,3 +1,12 @@
+### 3.2.0 [October 18, 2026]
+
+- Response models keep fields this version doesn't know in `additional_properties`.
+- Templates: new `parse_dates_using_template_date_format` setting, when you create or update a template. When it's
+  true, date values sent as NN/NN/YYYY (with slashes, dashes or dots) are read in the order of the template's default
+  date format: month first for `%m/%d/%Y`, day first for `%d/%m/%Y`. When it's false, they're read day first.
+- A new README: installing, a quick start, every API method, errors, and how API changes are handled. The repository
+  also has an AGENTS.md for coding agents.
+
 ### 3.1.0 [October 15, 2026]
 
 - Submissions and data requests can now be in the `declined` state, when a signer declines to sign. Data

README.md

@@ -34,6 +34,7 @@ Name | Type | Description | Notes
 **page_count** | **int** |  | 
 **page_dimensions** | **List[List[float]]** |  | 
 **parent_folder_id** | **str** |  | 
+**parse_dates_using_template_date_format** | **bool** |  | 
 **path** | **str** |  | 
 **permanent_document_url** | **str** |  | 
 **public_submissions** | **bool** |  | 

docs/Template.md

@@ -34,6 +34,7 @@ Name | Type | Description | Notes
 **page_count** | **int** |  | 
 **page_dimensions** | **List[List[float]]** |  | 
 **parent_folder_id** | **str** |  | 
+**parse_dates_using_template_date_format** | **bool** |  | 
 **path** | **str** |  | 
 **permanent_document_url** | **str** |  | 
 **public_submissions** | **bool** |  | 

docs/TemplatePreview.md

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "3.1.0"
+__version__ = "3.2.0"
 
 # Define package exports
 __all__ = [

docspring/__init__.py

@@ -92,7 +92,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'docspring-python-3.1.0'
+        self.user_agent = 'docspring-python-3.2.0'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

docspring/api_client.py

@@ -527,7 +527,7 @@ def to_debug_report(self) -> str:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v1\n"\
-               "SDK Package Version: 3.1.0".\
+               "SDK Package Version: 3.2.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

docspring/configuration.py

@@ -33,6 +33,7 @@ class BatchGeneratePdfs201Response(BaseModel):
     errors: Optional[List[StrictStr]] = None
     submission_batch: SubmissionBatch
     submissions: List[Dict[str, Any]]
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["status", "error", "errors", "submission_batch", "submissions"]
 
     @field_validator('status')
@@ -76,8 +77,10 @@ def to_dict(self) -> Dict[str, Any]:
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
         excluded_fields: Set[str] = set([
+            "additional_properties",
         ])
 
         _dict = self.model_dump(
@@ -88,6 +91,11 @@ def to_dict(self) -> Dict[str, Any]:
         # override the default output from pydantic by calling `to_dict()` of submission_batch
         if self.submission_batch:
             _dict['submission_batch'] = self.submission_batch.to_dict()
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         return _dict
 
     @classmethod
@@ -106,6 +114,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "submission_batch": SubmissionBatch.from_dict(obj["submission_batch"]) if obj.get("submission_batch") is not None else None,
             "submissions": obj.get("submissions")
         }, context={"skip_enum_validation": True})
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj
 
 

docspring/models/batch_generate_pdfs201_response.py

@@ -42,6 +42,7 @@ class CombinedSubmission(BaseModel):
     pdf_hash: Optional[StrictStr]
     download_url: Optional[StrictStr]
     actions: List[CombinedSubmissionAction]
+    additional_properties: Dict[str, Any] = {}
     __properties: ClassVar[List[str]] = ["id", "state", "expired", "expires_in", "expires_at", "processed_at", "error_message", "submission_ids", "source_pdfs", "metadata", "password", "pdf_hash", "download_url", "actions"]
 
     @field_validator('state')
@@ -85,8 +86,10 @@ def to_dict(self) -> Dict[str, Any]:
         * `None` is only added to the output dict for nullable fields that
           were set at model initialization. Other fields with value `None`
           are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
         """
         excluded_fields: Set[str] = set([
+            "additional_properties",
         ])
 
         _dict = self.model_dump(
@@ -101,6 +104,11 @@ def to_dict(self) -> Dict[str, Any]:
                 if _item_actions:
                     _items.append(_item_actions.to_dict())
             _dict['actions'] = _items
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
         # set to None if id (nullable) is None
         # and model_fields_set contains the field
         if self.id is None and "id" in self.model_fields_set:
@@ -168,6 +176,11 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "download_url": obj.get("download_url"),
             "actions": [CombinedSubmissionAction.from_dict(_item) for _item in obj["actions"]] if obj.get("actions") is not None else None
         }, context={"skip_enum_validation": True})
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
         return _obj