Update to version 4.4.0 on 2026-11-01

- New: list_email_actions, create_email_action, get_email_action, update_email_action and delete_email_action manage a
  template's email actions (`EmailAction`), which email each processed submission's files as attachments or a download
  link. `to`, `cc` and `bcc` take addresses, and tags for an address in the submission's fields
  (`{{ data.client_email }}`) or metadata (`{{ metadata.agent_email }}`). `send_when` sends only for the submissions
  that meet its conditions. `file_name` names the attached files, and `file_formats` chooses them: a Word template's
  Word document (`docx`), OpenDocument file (`odt`) or PDF (`pdf`), or every file the submission made (`all`). Attached
  files over `max_attachment_mb` together (7 MB unless you raise it, up to 25) go as a link instead.
  send_email_action_test_email sends one to you to check how it looks (`EmailActionTestEmail`). Without a paid plan
  (Starter or higher), email actions only email your team: test emails, and test submissions' emails.
- New: list_account_email_actions, create_account_email_action, get_account_email_action, update_account_email_action
  and delete_account_email_action manage your account's email actions, which send for every template, or for the
  templates and folders they list (`template_ids`, `folder_ids`). send_account_email_action_test_email sends one to you
  for one of its templates.
- New: list_email_actions also lists your account's email actions that send for the template, with the template's
  changes in `customization` (`EmailActionCustomization`). update_email_action_customization changes one for that
  template only, or turns it off there (`enabled`), and delete_email_action_customization removes the template's
  changes.
- New: list_email_domains, create_email_domain, get_email_domain, verify_email_domain and delete_email_domain manage the
  domains your email actions send from (`EmailDomain`), with the DNS records to add to each one (`EmailDomainDnsRecord`).
- A submission's `actions` include the emails its email actions sent (its template's and your account's), with each
  recipient and what happened to their email, and a new `email_action_id`.
- New: a field's `string_condition_type` can be `not_equals`, `not_contains`, `not_starts_with`, `not_ends_with`,
  `not_regex`, `blank` or `not_blank`, and a `regex` condition uses RE2 syntax (no lookarounds or backreferences).
- create_submission: DocSpring now emails the signers of a submission's `signature_requests` a link to sign, any
  reminders, and the signed PDF once everyone has signed. Set `send_email` to false, for the submission or for one
  signature request, when you send the links yourself or show the signing form in your app. A signature request that
  DocSpring emails needs an `email`, and its `auth_type` is optional (`email_link`). Before anyone is emailed, the
  request can be refused with a 402 (`insufficient_credits_to_send`), a 403 or a 429 (`daily_email_limit_reached`), and
  nothing is saved.
- New create_submission properties for these emails: `signing_order` (`SigningOrder`) with each signature request's
  `signing_step`, `email_subject`, `email_message`, `cc`, `reply_to`, `notification_emails`, `notify_when_signed` and
  `reminders` (`SignatureRequestReminders`).
- A signature request has `send_email`, `signing_step`, `sent_at` and `email_status` (`SignatureRequestEmailStatus`),
  and a submission has `signing_order`.
- Templates have new settings for these emails: `signature_request_from_name`, `signature_request_from_address`,
  `signature_request_signing_url`, `signature_request_include_signing_token`, `signature_request_reply_to`,
  `signature_request_notification_emails` and `signature_request_email_attachments`
  (`SignatureRequestEmailAttachments`).
- New webhook event types: `signature_request.sent` and `signature_request.email_bounced`.
- 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,
  `idempotencyKey`. 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, but Java has no optional arguments: add `null` to the end of your calls to these methods when you don't send
  a key (create_submission, create_submission_batch and create_combined_pdf already took one).
- 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.

Author: ndbroadbent

.github/workflows/maven.yml

@@ -0,0 +1,102 @@
+# Written by DocSpring/docspring's api_clients/scripts/generate from api_clients/github_workflows/java/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 signs it and publishes it to Maven Central, in the release environment, and waits until Maven Central serves
+# it. Maven Central has no trusted publishing: the release environment's secrets hold a Central Portal user token
+# (MAVEN_CENTRAL_USERNAME, MAVEN_CENTRAL_PASSWORD) and the signing key (MAVEN_GPG_PRIVATE_KEY, MAVEN_GPG_PASSPHRASE).
+# OpenAPI Generator's maven.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: actions/setup-java@b843ebf9b913146b38da2eaa7aeddf76074ae1ad # v6.1.0
+        with:
+          distribution: temurin
+          java-version: '17'
+          cache: maven
+      # The runner's Maven is 3.10, which puts maven-metadata-local.xml and _remote.repositories in the bundle the
+      # Central publishing plugin (0.10.0) uploads, and Central rejects it. Maven 3.9 doesn't.
+      - name: Install Maven 3.9.16
+        run: |
+          curl -fsSL -o "$RUNNER_TEMP/maven.tar.gz" https://archive.apache.org/dist/maven/maven-3/3.9.16/binaries/apache-maven-3.9.16-bin.tar.gz
+          echo "831a8591fe20c8243b1dbe7d71e3244f31d1665b0804b2e825e38cbbe5ce0cafb8338851f90780735568773e0a6cd07bbec107cda0b896b008b861075358b6f6  $RUNNER_TEMP/maven.tar.gz" | sha512sum -c -
+          tar -xzf "$RUNNER_TEMP/maven.tar.gz" -C "$RUNNER_TEMP"
+          echo "$RUNNER_TEMP/apache-maven-3.9.16/bin" >> "$GITHUB_PATH"
+      - name: Check the tag matches the package version
+        if: github.ref_type == 'tag'
+        run: |
+          VERSION="$(mvn -B -q help:evaluate -Dexpression=project.version -DforceStdout)"
+          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: mvn -B -ntp -DskipTests -DskipITs package
+
+  publish:
+    needs: build
+    if: github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    environment: release
+    steps:
+      # Maven builds, signs and uploads the package from the source in one deploy
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-java@b843ebf9b913146b38da2eaa7aeddf76074ae1ad # v6.1.0
+        with:
+          distribution: temurin
+          java-version: '17'
+          server-id: central
+          server-username: MAVEN_CENTRAL_USERNAME
+          server-password: MAVEN_CENTRAL_PASSWORD
+          gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
+          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+      # The runner's Maven is 3.10, which puts maven-metadata-local.xml and _remote.repositories in the bundle the
+      # Central publishing plugin (0.10.0) uploads, and Central rejects it. Maven 3.9 doesn't.
+      - name: Install Maven 3.9.16
+        run: |
+          curl -fsSL -o "$RUNNER_TEMP/maven.tar.gz" https://archive.apache.org/dist/maven/maven-3/3.9.16/binaries/apache-maven-3.9.16-bin.tar.gz
+          echo "831a8591fe20c8243b1dbe7d71e3244f31d1665b0804b2e825e38cbbe5ce0cafb8338851f90780735568773e0a6cd07bbec107cda0b896b008b861075358b6f6  $RUNNER_TEMP/maven.tar.gz" | sha512sum -c -
+          tar -xzf "$RUNNER_TEMP/maven.tar.gz" -C "$RUNNER_TEMP"
+          echo "$RUNNER_TEMP/apache-maven-3.9.16/bin" >> "$GITHUB_PATH"
+      # The sign-artifacts profile signs with the imported key, and the Central publishing plugin publishes the upload
+      # once Central has validated it (autoPublish)
+      - run: mvn -B -ntp -DskipTests -DskipITs -P sign-artifacts -DperformRelease=true clean deploy
+        env:
+          MAVEN_CENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
+          MAVEN_CENTRAL_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+
+  verify:
+    needs: publish
+    runs-on: ubuntu-latest
+    timeout-minutes: 75
+    steps:
+      # Maven Central can take an hour to serve a published release
+      - name: Wait until Maven Central serves the version
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          for _ in $(seq 120); do
+            if curl -fsS -o /dev/null "https://repo1.maven.org/maven2/com/docspring/DocSpring/$VERSION/DocSpring-$VERSION.pom"; then
+              echo "Maven Central serves com.docspring:DocSpring $VERSION"
+              exit 0
+            fi
+            sleep 30
+          done
+          echo "::error::Maven Central doesn't serve com.docspring:DocSpring $VERSION after an hour"
+          exit 1

.github/workflows/release.yml

@@ -21,8 +21,11 @@ docs/CombinedPdfSourcePdf.md
 docs/CombinedPdfSourceType.md
 docs/CombinedPdfState.md
 docs/CopyTemplateRequest.md
+docs/CreateAccountEmailActionRequest.md
 docs/CreateCombinedPdfRequest.md
 docs/CreateCustomFileFromUploadRequest.md
+docs/CreateEmailActionRequest.md
+docs/CreateEmailDomainRequest.md
 docs/CreateFolderRequest.md
 docs/CreateSignatureRequestEventRequest.md
 docs/CreateSignatureRequestTokenRequest.md
@@ -34,6 +37,23 @@ docs/CreateWebhookRequest.md
 docs/CustomFile.md
 docs/CustomFileList.md
 docs/CustomFileSourcePdf.md
+docs/DnsRecordType.md
+docs/EmailAction.md
+docs/EmailActionConditions.md
+docs/EmailActionConditionsInput.md
+docs/EmailActionCustomization.md
+docs/EmailActionDelivery.md
+docs/EmailActionFileFormats.md
+docs/EmailActionList.md
+docs/EmailActionSetting.md
+docs/EmailActionSubmissionType.md
+docs/EmailActionTestEmail.md
+docs/EmailDomain.md
+docs/EmailDomainDnsRecord.md
+docs/EmailDomainDnsRecordPurpose.md
+docs/EmailDomainList.md
+docs/EmailDomainRecordState.md
+docs/EmailDomainState.md
 docs/ErrorCode.md
 docs/ErrorDetail.md
 docs/ErrorInfo.md
@@ -86,17 +106,22 @@ docs/RemoveTemplateFieldsRequest.md
 docs/RenameFolderRequest.md
 docs/ReorderTemplateFieldsRequest.md
 docs/RestoreTemplateVersionRequest.md
+docs/SendAccountEmailActionTestEmailRequest.md
 docs/ShapeType.md
 docs/SignatureRequest.md
 docs/SignatureRequestAuthSecondFactorType.md
 docs/SignatureRequestAuthType.md
+docs/SignatureRequestEmailAttachments.md
+docs/SignatureRequestEmailStatus.md
 docs/SignatureRequestEvent.md
 docs/SignatureRequestEventType.md
 docs/SignatureRequestInput.md
 docs/SignatureRequestMessageType.md
+docs/SignatureRequestReminders.md
 docs/SignatureRequestState.md
 docs/SignatureRequestToken.md
 docs/SignatureRequestTokenType.md
+docs/SigningOrder.md
 docs/StringConditionType.md
 docs/Submission.md
 docs/SubmissionAction.md
@@ -154,6 +179,9 @@ docs/TextAlignment.md
 docs/TextOverflow.md
 docs/TextVerticalAlignment.md
 docs/Typeface.md
+docs/UpdateAccountEmailActionRequest.md
+docs/UpdateEmailActionCustomizationRequest.md
+docs/UpdateEmailActionRequest.md
 docs/UpdateSignatureRequestRequest.md
 docs/UpdateTemplateDocumentRequest.md
 docs/UpdateTemplateFieldsRequest.md
@@ -197,8 +225,11 @@ src/main/java/com/docspring/CombinedPdfSourceType.java
 src/main/java/com/docspring/CombinedPdfState.java
 src/main/java/com/docspring/Configuration.java
 src/main/java/com/docspring/CopyTemplateRequest.java
+src/main/java/com/docspring/CreateAccountEmailActionRequest.java
 src/main/java/com/docspring/CreateCombinedPdfRequest.java
 src/main/java/com/docspring/CreateCustomFileFromUploadRequest.java
+src/main/java/com/docspring/CreateEmailActionRequest.java
+src/main/java/com/docspring/CreateEmailDomainRequest.java
 src/main/java/com/docspring/CreateFolderRequest.java
 src/main/java/com/docspring/CreateSignatureRequestEventRequest.java
 src/main/java/com/docspring/CreateSignatureRequestTokenRequest.java
@@ -210,6 +241,23 @@ src/main/java/com/docspring/CreateWebhookRequest.java
 src/main/java/com/docspring/CustomFile.java
 src/main/java/com/docspring/CustomFileList.java
 src/main/java/com/docspring/CustomFileSourcePdf.java
+src/main/java/com/docspring/DnsRecordType.java
+src/main/java/com/docspring/EmailAction.java
+src/main/java/com/docspring/EmailActionConditions.java
+src/main/java/com/docspring/EmailActionConditionsInput.java
+src/main/java/com/docspring/EmailActionCustomization.java
+src/main/java/com/docspring/EmailActionDelivery.java
+src/main/java/com/docspring/EmailActionFileFormats.java
+src/main/java/com/docspring/EmailActionList.java
+src/main/java/com/docspring/EmailActionSetting.java
+src/main/java/com/docspring/EmailActionSubmissionType.java
+src/main/java/com/docspring/EmailActionTestEmail.java
+src/main/java/com/docspring/EmailDomain.java
+src/main/java/com/docspring/EmailDomainDnsRecord.java
+src/main/java/com/docspring/EmailDomainDnsRecordPurpose.java
+src/main/java/com/docspring/EmailDomainList.java
+src/main/java/com/docspring/EmailDomainRecordState.java
+src/main/java/com/docspring/EmailDomainState.java
 src/main/java/com/docspring/ErrorCode.java
 src/main/java/com/docspring/ErrorDetail.java
 src/main/java/com/docspring/ErrorInfo.java
@@ -268,19 +316,24 @@ src/main/java/com/docspring/RemoveTemplateFieldsRequest.java
 src/main/java/com/docspring/RenameFolderRequest.java
 src/main/java/com/docspring/ReorderTemplateFieldsRequest.java
 src/main/java/com/docspring/RestoreTemplateVersionRequest.java
+src/main/java/com/docspring/SendAccountEmailActionTestEmailRequest.java
 src/main/java/com/docspring/ServerConfiguration.java
 src/main/java/com/docspring/ServerVariable.java
 src/main/java/com/docspring/ShapeType.java
 src/main/java/com/docspring/SignatureRequest.java
 src/main/java/com/docspring/SignatureRequestAuthSecondFactorType.java
 src/main/java/com/docspring/SignatureRequestAuthType.java
+src/main/java/com/docspring/SignatureRequestEmailAttachments.java
+src/main/java/com/docspring/SignatureRequestEmailStatus.java
 src/main/java/com/docspring/SignatureRequestEvent.java
 src/main/java/com/docspring/SignatureRequestEventType.java
 src/main/java/com/docspring/SignatureRequestInput.java
 src/main/java/com/docspring/SignatureRequestMessageType.java
+src/main/java/com/docspring/SignatureRequestReminders.java
 src/main/java/com/docspring/SignatureRequestState.java
 src/main/java/com/docspring/SignatureRequestToken.java
 src/main/java/com/docspring/SignatureRequestTokenType.java
+src/main/java/com/docspring/SigningOrder.java
 src/main/java/com/docspring/StringConditionType.java
 src/main/java/com/docspring/StringUtil.java
 src/main/java/com/docspring/Submission.java
@@ -339,6 +392,9 @@ src/main/java/com/docspring/TextAlignment.java
 src/main/java/com/docspring/TextOverflow.java
 src/main/java/com/docspring/TextVerticalAlignment.java
 src/main/java/com/docspring/Typeface.java
+src/main/java/com/docspring/UpdateAccountEmailActionRequest.java
+src/main/java/com/docspring/UpdateEmailActionCustomizationRequest.java
+src/main/java/com/docspring/UpdateEmailActionRequest.java
 src/main/java/com/docspring/UpdateSignatureRequestRequest.java
 src/main/java/com/docspring/UpdateTemplateDocumentRequest.java
 src/main/java/com/docspring/UpdateTemplateFieldsRequest.java
@@ -372,8 +428,11 @@ src/test/java/com/docspring/CombinedPdfSourceTypeTest.java
 src/test/java/com/docspring/CombinedPdfStateTest.java
 src/test/java/com/docspring/CombinedPdfTest.java
 src/test/java/com/docspring/CopyTemplateRequestTest.java
+src/test/java/com/docspring/CreateAccountEmailActionRequestTest.java
 src/test/java/com/docspring/CreateCombinedPdfRequestTest.java
 src/test/java/com/docspring/CreateCustomFileFromUploadRequestTest.java
+src/test/java/com/docspring/CreateEmailActionRequestTest.java
+src/test/java/com/docspring/CreateEmailDomainRequestTest.java
 src/test/java/com/docspring/CreateFolderRequestTest.java
 src/test/java/com/docspring/CreateSignatureRequestEventRequestTest.java
 src/test/java/com/docspring/CreateSignatureRequestTokenRequestTest.java
@@ -385,6 +444,23 @@ src/test/java/com/docspring/CreateWebhookRequestTest.java
 src/test/java/com/docspring/CustomFileListTest.java
 src/test/java/com/docspring/CustomFileSourcePdfTest.java
 src/test/java/com/docspring/CustomFileTest.java
+src/test/java/com/docspring/DnsRecordTypeTest.java
+src/test/java/com/docspring/EmailActionConditionsInputTest.java
+src/test/java/com/docspring/EmailActionConditionsTest.java
+src/test/java/com/docspring/EmailActionCustomizationTest.java
+src/test/java/com/docspring/EmailActionDeliveryTest.java
+src/test/java/com/docspring/EmailActionFileFormatsTest.java
+src/test/java/com/docspring/EmailActionListTest.java
+src/test/java/com/docspring/EmailActionSettingTest.java
+src/test/java/com/docspring/EmailActionSubmissionTypeTest.java
+src/test/java/com/docspring/EmailActionTest.java
+src/test/java/com/docspring/EmailActionTestEmailTest.java
+src/test/java/com/docspring/EmailDomainDnsRecordPurposeTest.java
+src/test/java/com/docspring/EmailDomainDnsRecordTest.java
+src/test/java/com/docspring/EmailDomainListTest.java
+src/test/java/com/docspring/EmailDomainRecordStateTest.java
+src/test/java/com/docspring/EmailDomainStateTest.java
+src/test/java/com/docspring/EmailDomainTest.java
 src/test/java/com/docspring/ErrorCodeTest.java
 src/test/java/com/docspring/ErrorDetailTest.java
 src/test/java/com/docspring/ErrorInfoTest.java
@@ -437,17 +513,22 @@ src/test/java/com/docspring/RemoveTemplateFieldsRequestTest.java
 src/test/java/com/docspring/RenameFolderRequestTest.java
 src/test/java/com/docspring/ReorderTemplateFieldsRequestTest.java
 src/test/java/com/docspring/RestoreTemplateVersionRequestTest.java
+src/test/java/com/docspring/SendAccountEmailActionTestEmailRequestTest.java
 src/test/java/com/docspring/ShapeTypeTest.java
 src/test/java/com/docspring/SignatureRequestAuthSecondFactorTypeTest.java
 src/test/java/com/docspring/SignatureRequestAuthTypeTest.java
+src/test/java/com/docspring/SignatureRequestEmailAttachmentsTest.java
+src/test/java/com/docspring/SignatureRequestEmailStatusTest.java
 src/test/java/com/docspring/SignatureRequestEventTest.java
 src/test/java/com/docspring/SignatureRequestEventTypeTest.java
 src/test/java/com/docspring/SignatureRequestInputTest.java
 src/test/java/com/docspring/SignatureRequestMessageTypeTest.java
+src/test/java/com/docspring/SignatureRequestRemindersTest.java
 src/test/java/com/docspring/SignatureRequestStateTest.java
 src/test/java/com/docspring/SignatureRequestTest.java
 src/test/java/com/docspring/SignatureRequestTokenTest.java
 src/test/java/com/docspring/SignatureRequestTokenTypeTest.java
+src/test/java/com/docspring/SigningOrderTest.java
 src/test/java/com/docspring/StringConditionTypeTest.java
 src/test/java/com/docspring/SubmissionActionStateTest.java
 src/test/java/com/docspring/SubmissionActionTest.java
@@ -505,6 +586,9 @@ src/test/java/com/docspring/TextAlignmentTest.java
 src/test/java/com/docspring/TextOverflowTest.java
 src/test/java/com/docspring/TextVerticalAlignmentTest.java
 src/test/java/com/docspring/TypefaceTest.java
+src/test/java/com/docspring/UpdateAccountEmailActionRequestTest.java
+src/test/java/com/docspring/UpdateEmailActionCustomizationRequestTest.java
+src/test/java/com/docspring/UpdateEmailActionRequestTest.java
 src/test/java/com/docspring/UpdateSignatureRequestRequestTest.java
 src/test/java/com/docspring/UpdateTemplateDocumentRequestTest.java
 src/test/java/com/docspring/UpdateTemplateFieldsRequestTest.java