Test the release workflow (a throwaway branch, not a release)

Author: ndbroadbent

.github/workflows/release.yml

@@ -0,0 +1,74 @@
+# Written by DocSpring/docspring's api_clients/scripts/generate from api_clients/github_workflows/python/release.yml:
+# change it there.
+#
+# Builds the package on every push and pull request. A v* tag (pushed by the monorepo's api_clients/scripts/release)
+# also publishes it to PyPI with trusted publishing, in the release environment, and waits until PyPI serves it.
+# OpenAPI Generator's python.yml runs the package's tests.
+name: Release
+
+on:
+  push:
+    branches: ['**']
+    tags: ['v*']
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+      - name: Check the tag matches the package version
+        if: github.ref_type == 'tag'
+        run: |
+          VERSION="$(python3 -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')"
+          if [ "v$VERSION" != "$GITHUB_REF_NAME" ]; then
+            echo "::error::The tag is $GITHUB_REF_NAME, but the package version is $VERSION"
+            exit 1
+          fi
+      - run: uv build --wheel
+      - run: uvx twine check --strict dist/*
+      - if: github.ref_type == 'tag'
+        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: package
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    needs: build
+    if: github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: package
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+
+  verify:
+    needs: publish
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - name: Wait until PyPI serves the version
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          for _ in $(seq 60); do
+            if curl -fsS -o /dev/null "https://pypi.org/pypi/docspring/$VERSION/json"; then
+              echo "PyPI serves docspring $VERSION"
+              exit 0
+            fi
+            sleep 10
+          done
+          echo "::error::PyPI doesn't serve docspring $VERSION after 10 minutes"
+          exit 1

CHANGELOG.md

@@ -1,3 +1,19 @@
+### 4.4.0 [October 31, 2026]
+
+- New: page designs (`template_type` `page_designer`), PDFs designed in the Page Designer from a JSON layout, with no
+  document to start from. create_template makes one from its `layout`, or with an empty page when `layout` is left
+  out, and update_template replaces its layout. DocSpring adds a field for each value the layout reads. A template's
+  `layout` is in the [Page Designer layout format](https://docspring.com/docs/page-designer/layout-format/) (its
+  [JSON Schema](https://docspring.com/schemas/page-designer/layout.v1.json)), and is null for other templates.
+- New: every method that creates, changes or deletes something takes an `Idempotency-Key` header, as its last argument,
+  `idempotency_key`. Send the same key when you send a request again after a timeout or a network error: within 24
+  hours, DocSpring returns the first response instead of running the request twice. Arguments you already pass keep
+  their places.
+- Changed: the request validator checks what API v2 now refuses: an ID, a query value or a template name that's blank or
+  only whitespace, an update with nothing to change, a version with a leading zero (`01`), a `filename` with a slash, a
+  signer `email` that isn't an email address, and an HTML template's `scale` outside 0.1 to 2.
+- New: get_template_model_code takes `rust` as its `lang`, for Rust structs that serde reads and writes.
+
 ### 4.3.0 [October 31, 2026]
 
 - New: get_template_model_code takes `rust` as its `lang`, for Rust structs that serde reads and writes.

README.md

@@ -10,7 +10,7 @@ e-signatures.
 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.3.0. Requires Python >=3.10.
+Version 4.4.0. Requires Python >=3.10.
 
 ## Install and configure
 

docs/Client.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **type** | [**CombinedPdfSourceType**](CombinedPdfSourceType.md) | What the PDF is: a submission's PDF, another combined PDF, a template's PDF, a custom file (POST /custom_files) or a PDF to download from a URL. | 
 **id** | **str** | The ID of the submission, combined PDF, template or custom file. | [optional] 
 **url** | **str** | For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired. | [optional] 
-**template_version** | **str** | For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published). | [optional] 
+**template_version** | **str** | For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`. | [optional] 
 **processed** | **bool** | For a `template` source: true (the default) merges the template's processed PDF, which is the PDF submissions are filled in on (decrypted, with its form fields removed). false merges the PDF as it was uploaded. | [optional] 
 
 ## Example

docs/CombinedPdfSource.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **str** | Must be `url`. | [default to 'url']
 **id** | **str** | The ID of the submission, combined PDF, template or custom file. | 
-**template_version** | **str** | For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published). | [optional] 
+**template_version** | **str** | For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`. | [optional] 
 **processed** | **bool** | For a `template` source: true (the default) merges the template's processed PDF, which is the PDF submissions are filled in on (decrypted, with its form fields removed). false merges the PDF as it was uploaded. | [optional] 
 **url** | **str** | For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired. | 
 

docs/CombinedPdfSourceInput.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **metadata** | **Dict[str, object]** | Your own data about the batch, such as an ID from your app. | [optional] 
 **template_id** | **str** | The template for each submission that doesn't name its own `template_id`. | [optional] 
-**template_version** | **str** | The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published). | [optional] 
+**template_version** | **str** | The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`. | [optional] 
 **test** | **bool** | The default `test` for each submission that doesn't set its own. | [optional] 
 **output_formats** | [**List[OutputFormat]**](OutputFormat.md) | The default `output_formats` for each submission that doesn't set its own. | [optional] 
 **submissions** | [**List[SubmissionInput]**](SubmissionInput.md) | Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch. | 

docs/CreateSubmissionBatchRequest.md

@@ -6,13 +6,13 @@ The submission's data and settings.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**test** | **bool** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions. | [optional] 
+**test** | **bool** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live. | [optional] 
 **editable** | **bool** | `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`. | [optional] 
-**data** | **Dict[str, object]** | The values of the template's fields, by field name. Required for PDF and Word templates, unless `signature_requests` collects them (PDF templates only). | [optional] 
+**data** | **Dict[str, object]** | The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them (PDF templates only). | [optional] 
 **metadata** | **Dict[str, object]** | Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`). | [optional] 
 **password** | **str** | A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them. | [optional] 
 **output_formats** | [**List[OutputFormat]**](OutputFormat.md) | What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission. | [optional] 
-**expires_in** | **int** | Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. | [optional] 
+**expires_in** | **int** | Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. The demo API token's submissions expire within an hour: up to 3600, and that's their default. | [optional] 
 **field_overrides** | [**Dict[str, FieldOverride]**](FieldOverride.md) | Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`. | [optional] 
 **html** | **str** | For an HTML template, HTML to use instead of the template's. | [optional] 
 **css** | **str** | For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity. | [optional]