Skip to content

Commit efec2d7

Browse files
committed
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 the `:"Idempotency-Key"` option. 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.
1 parent 044b3b4 commit efec2d7

54 files changed

Lines changed: 3995 additions & 286 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/release.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Written by DocSpring/docspring's api_clients/scripts/generate from api_clients/github_workflows/elixir/release.yml:
2+
# change it there.
3+
#
4+
# Builds the package on every push and pull request. A v* tag (pushed by the monorepo's api_clients/scripts/release)
5+
# also publishes it and its docs to Hex, in the release environment, and waits until Hex serves it. Hex's workload
6+
# identities (OIDC) aren't turned on for the package yet, so publishing uses HEX_API_KEY, a key that can only publish
7+
# docspring, as a secret of the release environment.
8+
name: Release
9+
10+
on:
11+
push:
12+
branches: ['**']
13+
tags: ['v*']
14+
pull_request:
15+
16+
permissions:
17+
contents: read
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
24+
with:
25+
persist-credentials: false
26+
- uses: erlef/setup-beam@54075bcc5e249e4758d363f27d099f55d843f124 # v1.24.1
27+
with:
28+
otp-version: '27'
29+
elixir-version: '1.18'
30+
- name: Check the tag matches the package version
31+
if: github.ref_type == 'tag'
32+
run: |
33+
VERSION="$(sed -n 's/^ *version: "\(.*\)",$/\1/p' mix.exs)"
34+
if [ "v$VERSION" != "$GITHUB_REF_NAME" ]; then
35+
echo "::error::The tag is $GITHUB_REF_NAME, but the package version is $VERSION"
36+
exit 1
37+
fi
38+
- run: mix deps.get
39+
- run: mix hex.build
40+
- run: mix docs
41+
42+
publish:
43+
needs: build
44+
if: github.ref_type == 'tag'
45+
runs-on: ubuntu-latest
46+
environment: release
47+
steps:
48+
# mix hex.publish builds the package and its docs from the source
49+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
50+
with:
51+
persist-credentials: false
52+
- uses: erlef/setup-beam@54075bcc5e249e4758d363f27d099f55d843f124 # v1.24.1
53+
with:
54+
otp-version: '27'
55+
elixir-version: '1.18'
56+
- run: mix deps.get
57+
- run: mix hex.publish --yes
58+
env:
59+
HEX_API_KEY: ${{ secrets.HEX_API_KEY }}
60+
61+
verify:
62+
needs: publish
63+
runs-on: ubuntu-latest
64+
timeout-minutes: 15
65+
steps:
66+
- name: Wait until Hex serves the version
67+
run: |
68+
VERSION="${GITHUB_REF_NAME#v}"
69+
for _ in $(seq 60); do
70+
if curl -fsS -o /dev/null "https://hex.pm/api/packages/docspring/releases/$VERSION"; then
71+
echo "Hex serves docspring $VERSION"
72+
exit 0
73+
fi
74+
sleep 10
75+
done
76+
echo "::error::Hex doesn't serve docspring $VERSION after 10 minutes"
77+
exit 1

‎.openapi-generator/FILES‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,11 @@ lib/docspring/model/combined_pdf_source_pdf.ex
2121
lib/docspring/model/combined_pdf_source_type.ex
2222
lib/docspring/model/combined_pdf_state.ex
2323
lib/docspring/model/copy_template_request.ex
24+
lib/docspring/model/create_account_email_action_request.ex
2425
lib/docspring/model/create_combined_pdf_request.ex
2526
lib/docspring/model/create_custom_file_from_upload_request.ex
27+
lib/docspring/model/create_email_action_request.ex
28+
lib/docspring/model/create_email_domain_request.ex
2629
lib/docspring/model/create_folder_request.ex
2730
lib/docspring/model/create_signature_request_event_request.ex
2831
lib/docspring/model/create_signature_request_token_request.ex
@@ -34,6 +37,23 @@ lib/docspring/model/create_webhook_request.ex
3437
lib/docspring/model/custom_file.ex
3538
lib/docspring/model/custom_file_list.ex
3639
lib/docspring/model/custom_file_source_pdf.ex
40+
lib/docspring/model/dns_record_type.ex
41+
lib/docspring/model/email_action.ex
42+
lib/docspring/model/email_action_conditions.ex
43+
lib/docspring/model/email_action_conditions_input.ex
44+
lib/docspring/model/email_action_customization.ex
45+
lib/docspring/model/email_action_delivery.ex
46+
lib/docspring/model/email_action_file_formats.ex
47+
lib/docspring/model/email_action_list.ex
48+
lib/docspring/model/email_action_setting.ex
49+
lib/docspring/model/email_action_submission_type.ex
50+
lib/docspring/model/email_action_test_email.ex
51+
lib/docspring/model/email_domain.ex
52+
lib/docspring/model/email_domain_dns_record.ex
53+
lib/docspring/model/email_domain_dns_record_purpose.ex
54+
lib/docspring/model/email_domain_list.ex
55+
lib/docspring/model/email_domain_record_state.ex
56+
lib/docspring/model/email_domain_state.ex
3757
lib/docspring/model/error_code.ex
3858
lib/docspring/model/error_detail.ex
3959
lib/docspring/model/error_info.ex
@@ -86,17 +106,22 @@ lib/docspring/model/remove_template_fields_request.ex
86106
lib/docspring/model/rename_folder_request.ex
87107
lib/docspring/model/reorder_template_fields_request.ex
88108
lib/docspring/model/restore_template_version_request.ex
109+
lib/docspring/model/send_account_email_action_test_email_request.ex
89110
lib/docspring/model/shape_type.ex
90111
lib/docspring/model/signature_request.ex
91112
lib/docspring/model/signature_request_auth_second_factor_type.ex
92113
lib/docspring/model/signature_request_auth_type.ex
114+
lib/docspring/model/signature_request_email_attachments.ex
115+
lib/docspring/model/signature_request_email_status.ex
93116
lib/docspring/model/signature_request_event.ex
94117
lib/docspring/model/signature_request_event_type.ex
95118
lib/docspring/model/signature_request_input.ex
96119
lib/docspring/model/signature_request_message_type.ex
120+
lib/docspring/model/signature_request_reminders.ex
97121
lib/docspring/model/signature_request_state.ex
98122
lib/docspring/model/signature_request_token.ex
99123
lib/docspring/model/signature_request_token_type.ex
124+
lib/docspring/model/signing_order.ex
100125
lib/docspring/model/string_condition_type.ex
101126
lib/docspring/model/submission.ex
102127
lib/docspring/model/submission_action.ex
@@ -154,6 +179,9 @@ lib/docspring/model/text_alignment.ex
154179
lib/docspring/model/text_overflow.ex
155180
lib/docspring/model/text_vertical_alignment.ex
156181
lib/docspring/model/typeface.ex
182+
lib/docspring/model/update_account_email_action_request.ex
183+
lib/docspring/model/update_email_action_customization_request.ex
184+
lib/docspring/model/update_email_action_request.ex
157185
lib/docspring/model/update_signature_request_request.ex
158186
lib/docspring/model/update_template_document_request.ex
159187
lib/docspring/model/update_template_fields_request.ex

‎CHANGELOG.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,58 @@
1+
### 4.4.0 [November 1, 2026]
2+
3+
- New: list_email_actions, create_email_action, get_email_action, update_email_action and delete_email_action manage a
4+
template's email actions (`EmailAction`), which email each processed submission's files as attachments or a download
5+
link. `to`, `cc` and `bcc` take addresses, and tags for an address in the submission's fields
6+
(`{{ data.client_email }}`) or metadata (`{{ metadata.agent_email }}`). `send_when` sends only for the submissions
7+
that meet its conditions. `file_name` names the attached files, and `file_formats` chooses them: a Word template's
8+
Word document (`docx`), OpenDocument file (`odt`) or PDF (`pdf`), or every file the submission made (`all`). Attached
9+
files over `max_attachment_mb` together (7 MB unless you raise it, up to 25) go as a link instead.
10+
send_email_action_test_email sends one to you to check how it looks (`EmailActionTestEmail`). Without a paid plan
11+
(Starter or higher), email actions only email your team: test emails, and test submissions' emails.
12+
- New: list_account_email_actions, create_account_email_action, get_account_email_action, update_account_email_action
13+
and delete_account_email_action manage your account's email actions, which send for every template, or for the
14+
templates and folders they list (`template_ids`, `folder_ids`). send_account_email_action_test_email sends one to you
15+
for one of its templates.
16+
- New: list_email_actions also lists your account's email actions that send for the template, with the template's
17+
changes in `customization` (`EmailActionCustomization`). update_email_action_customization changes one for that
18+
template only, or turns it off there (`enabled`), and delete_email_action_customization removes the template's
19+
changes.
20+
- New: list_email_domains, create_email_domain, get_email_domain, verify_email_domain and delete_email_domain manage the
21+
domains your email actions send from (`EmailDomain`), with the DNS records to add to each one (`EmailDomainDnsRecord`).
22+
- A submission's `actions` include the emails its email actions sent (its template's and your account's), with each
23+
recipient and what happened to their email, and a new `email_action_id`.
24+
- New: a field's `string_condition_type` can be `not_equals`, `not_contains`, `not_starts_with`, `not_ends_with`,
25+
`not_regex`, `blank` or `not_blank`, and a `regex` condition uses RE2 syntax (no lookarounds or backreferences).
26+
- create_submission: DocSpring now emails the signers of a submission's `signature_requests` a link to sign, any
27+
reminders, and the signed PDF once everyone has signed. Set `send_email` to false, for the submission or for one
28+
signature request, when you send the links yourself or show the signing form in your app. A signature request that
29+
DocSpring emails needs an `email`, and its `auth_type` is optional (`email_link`). Before anyone is emailed, the
30+
request can be refused with a 402 (`insufficient_credits_to_send`), a 403 or a 429 (`daily_email_limit_reached`), and
31+
nothing is saved.
32+
- New create_submission properties for these emails: `signing_order` (`SigningOrder`) with each signature request's
33+
`signing_step`, `email_subject`, `email_message`, `cc`, `reply_to`, `notification_emails`, `notify_when_signed` and
34+
`reminders` (`SignatureRequestReminders`).
35+
- A signature request has `send_email`, `signing_step`, `sent_at` and `email_status` (`SignatureRequestEmailStatus`),
36+
and a submission has `signing_order`.
37+
- Templates have new settings for these emails: `signature_request_from_name`, `signature_request_from_address`,
38+
`signature_request_signing_url`, `signature_request_include_signing_token`, `signature_request_reply_to`,
39+
`signature_request_notification_emails` and `signature_request_email_attachments`
40+
(`SignatureRequestEmailAttachments`).
41+
- New webhook event types: `signature_request.sent` and `signature_request.email_bounced`.
42+
- New: page designs (`template_type` `page_designer`), PDFs designed in the Page Designer from a JSON layout, with no
43+
document to start from. create_template makes one from its `layout`, or with an empty page when `layout` is left
44+
out, and update_template replaces its layout. DocSpring adds a field for each value the layout reads. A template's
45+
`layout` is in the [Page Designer layout format](https://docspring.com/docs/page-designer/layout-format/) (its
46+
[JSON Schema](https://docspring.com/schemas/page-designer/layout.v1.json)), and is null for other templates.
47+
- New: every method that creates, changes or deletes something takes an `Idempotency-Key` header, as the
48+
`:"Idempotency-Key"` option. Send the same key when you send a request again after a timeout or a network error:
49+
within 24 hours, DocSpring returns the first response instead of running the request twice. Arguments you already pass
50+
keep their places.
51+
- Changed: the request validator checks what API v2 now refuses: an ID, a query value or a template name that's blank or
52+
only whitespace, an update with nothing to change, a version with a leading zero (`01`), a `filename` with a slash, a
53+
signer `email` that isn't an email address, and an HTML template's `scale` outside 0.1 to 2.
54+
- New: get_template_model_code takes `rust` as its `lang`, for Rust structs that serde reads and writes.
55+
156
### 4.3.0 [October 31, 2026]
257

358
- New: get_template_model_code takes `rust` as its `lang`, for Rust structs that serde reads and writes.

0 commit comments

Comments
 (0)