GeezerVison

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

# The oldest PHP composer.json allows

- uses: shivammathur/setup-php@eb7c497e18156a6bbabfef1d3a82760b9eda3962 # 2.40.0

with:

php-version: '8.1'

tools: composer

- name: Check the tag matches the package version

if: github.ref_type == 'tag'

run: |

- run: composer validate --no-check-publish

# As a customer's project installs it: their composer resolves the runtime dependencies and ignores our

# composer.lock, whose dev tools are locked for the PHP that generated the SDK

- run: composer update --no-dev --no-interaction --no-progress

- name: Load the client

run: |

verify:

needs: build

if: github.ref_type == 'tag'

runs-on: ubuntu-latest

# Packagist's CDN caches the package's file for up to 15 minutes

timeout-minutes: 25

steps:

- name: Wait until Packagist serves the version

run: |

docs/Model/CombinedPdfSourceType.md

docs/Model/CombinedPdfState.md

docs/Model/CopyTemplateRequest.md

docs/Model/CreateAccountEmailActionRequest.md

docs/Model/CreateCombinedPdfRequest.md

docs/Model/CreateCustomFileFromUploadRequest.md

docs/Model/CreateEmailActionRequest.md

docs/Model/CreateEmailDomainRequest.md

docs/Model/CreateFolderRequest.md

docs/Model/CreateSignatureRequestEventRequest.md

docs/Model/CreateSignatureRequestTokenRequest.md

docs/Model/CustomFile.md

docs/Model/CustomFileList.md

docs/Model/CustomFileSourcePdf.md

docs/Model/DnsRecordType.md

docs/Model/EmailAction.md

docs/Model/EmailActionConditions.md

docs/Model/EmailActionConditionsInput.md

docs/Model/EmailActionCustomization.md

docs/Model/EmailActionDelivery.md

docs/Model/EmailActionFileFormats.md

docs/Model/EmailActionList.md

docs/Model/EmailActionSetting.md

docs/Model/EmailActionSubmissionType.md

docs/Model/EmailActionTestEmail.md

docs/Model/EmailDomain.md

docs/Model/EmailDomainDnsRecord.md

docs/Model/EmailDomainDnsRecordPurpose.md

docs/Model/EmailDomainList.md

docs/Model/EmailDomainRecordState.md

docs/Model/EmailDomainState.md

docs/Model/ErrorCode.md

docs/Model/ErrorDetail.md

docs/Model/ErrorInfo.md

docs/Model/RenameFolderRequest.md

docs/Model/ReorderTemplateFieldsRequest.md

docs/Model/RestoreTemplateVersionRequest.md

docs/Model/SendAccountEmailActionTestEmailRequest.md

docs/Model/ShapeType.md

docs/Model/SignatureRequest.md

docs/Model/SignatureRequestAuthSecondFactorType.md

docs/Model/SignatureRequestAuthType.md

docs/Model/SignatureRequestEmailAttachments.md

docs/Model/SignatureRequestEmailStatus.md

docs/Model/SignatureRequestEvent.md

docs/Model/SignatureRequestEventType.md

docs/Model/SignatureRequestInput.md

docs/Model/SignatureRequestMessageType.md

docs/Model/SignatureRequestReminders.md

docs/Model/SignatureRequestState.md

docs/Model/SignatureRequestToken.md

docs/Model/SignatureRequestTokenType.md

docs/Model/SigningOrder.md

docs/Model/StringConditionType.md

docs/Model/Submission.md

docs/Model/SubmissionAction.md

docs/Model/TextOverflow.md

docs/Model/TextVerticalAlignment.md

docs/Model/Typeface.md

docs/Model/UpdateAccountEmailActionRequest.md

docs/Model/UpdateEmailActionCustomizationRequest.md

docs/Model/UpdateEmailActionRequest.md

docs/Model/UpdateSignatureRequestRequest.md

docs/Model/UpdateTemplateDocumentRequest.md

docs/Model/UpdateTemplateFieldsRequest.md

lib/Model/CombinedPdfSourceType.php

lib/Model/CombinedPdfState.php

lib/Model/CopyTemplateRequest.php

lib/Model/CreateAccountEmailActionRequest.php

lib/Model/CreateCombinedPdfRequest.php

lib/Model/CreateCustomFileFromUploadRequest.php

lib/Model/CreateEmailActionRequest.php

lib/Model/CreateEmailDomainRequest.php

lib/Model/CreateFolderRequest.php

lib/Model/CreateSignatureRequestEventRequest.php

lib/Model/CreateSignatureRequestTokenRequest.php

lib/Model/CustomFile.php

lib/Model/CustomFileList.php

lib/Model/CustomFileSourcePdf.php

lib/Model/DnsRecordType.php

lib/Model/EmailAction.php

lib/Model/EmailActionConditions.php

lib/Model/EmailActionConditionsInput.php

lib/Model/EmailActionCustomization.php

lib/Model/EmailActionDelivery.php

lib/Model/EmailActionFileFormats.php

lib/Model/EmailActionList.php

lib/Model/EmailActionSetting.php

lib/Model/EmailActionSubmissionType.php

lib/Model/EmailActionTestEmail.php

lib/Model/EmailDomain.php

lib/Model/EmailDomainDnsRecord.php

lib/Model/EmailDomainDnsRecordPurpose.php

lib/Model/EmailDomainList.php

lib/Model/EmailDomainRecordState.php

lib/Model/EmailDomainState.php

lib/Model/ErrorCode.php

lib/Model/ErrorDetail.php

lib/Model/ErrorInfo.php

lib/Model/RenameFolderRequest.php

lib/Model/ReorderTemplateFieldsRequest.php

lib/Model/RestoreTemplateVersionRequest.php

lib/Model/SendAccountEmailActionTestEmailRequest.php

lib/Model/ShapeType.php

lib/Model/SignatureRequest.php

lib/Model/SignatureRequestAuthSecondFactorType.php

lib/Model/SignatureRequestAuthType.php

lib/Model/SignatureRequestEmailAttachments.php

lib/Model/SignatureRequestEmailStatus.php

lib/Model/SignatureRequestEvent.php

lib/Model/SignatureRequestEventType.php

lib/Model/SignatureRequestInput.php

lib/Model/SignatureRequestMessageType.php

lib/Model/SignatureRequestReminders.php

lib/Model/SignatureRequestState.php

lib/Model/SignatureRequestToken.php

lib/Model/SignatureRequestTokenType.php

lib/Model/SigningOrder.php

lib/Model/StringConditionType.php

lib/Model/Submission.php

lib/Model/SubmissionAction.php

lib/Model/TextOverflow.php

lib/Model/TextVerticalAlignment.php

lib/Model/Typeface.php

lib/Model/UpdateAccountEmailActionRequest.php

lib/Model/UpdateEmailActionCustomizationRequest.php

lib/Model/UpdateEmailActionRequest.php

lib/Model/UpdateSignatureRequestRequest.php

lib/Model/UpdateTemplateDocumentRequest.php

lib/Model/UpdateTemplateFieldsRequest.php

test/Model/CombinedPdfStateTest.php

test/Model/CombinedPdfTest.php

test/Model/CopyTemplateRequestTest.php

test/Model/CreateAccountEmailActionRequestTest.php

test/Model/CreateCombinedPdfRequestTest.php

test/Model/CreateCustomFileFromUploadRequestTest.php

test/Model/CreateEmailActionRequestTest.php

test/Model/CreateEmailDomainRequestTest.php

test/Model/CreateFolderRequestTest.php

test/Model/CreateSignatureRequestEventRequestTest.php

test/Model/CreateSignatureRequestTokenRequestTest.php

test/Model/CustomFileListTest.php

test/Model/CustomFileSourcePdfTest.php

test/Model/CustomFileTest.php

test/Model/DnsRecordTypeTest.php

test/Model/EmailActionConditionsInputTest.php

test/Model/EmailActionConditionsTest.php

test/Model/EmailActionCustomizationTest.php

test/Model/EmailActionDeliveryTest.php

test/Model/EmailActionFileFormatsTest.php

test/Model/EmailActionListTest.php

test/Model/EmailActionSettingTest.php

test/Model/EmailActionSubmissionTypeTest.php

test/Model/EmailActionTest.php

test/Model/EmailActionTestEmailTest.php

test/Model/EmailDomainDnsRecordPurposeTest.php

test/Model/EmailDomainDnsRecordTest.php

test/Model/EmailDomainListTest.php

test/Model/EmailDomainRecordStateTest.php

test/Model/EmailDomainStateTest.php

test/Model/EmailDomainTest.php

test/Model/ErrorCodeTest.php

test/Model/ErrorDetailTest.php

test/Model/ErrorInfoTest.php

test/Model/RenameFolderRequestTest.php

test/Model/ReorderTemplateFieldsRequestTest.php

test/Model/RestoreTemplateVersionRequestTest.php

test/Model/SendAccountEmailActionTestEmailRequestTest.php

test/Model/ShapeTypeTest.php

test/Model/SignatureRequestAuthSecondFactorTypeTest.php

test/Model/SignatureRequestAuthTypeTest.php

test/Model/SignatureRequestEmailAttachmentsTest.php

test/Model/SignatureRequestEmailStatusTest.php

test/Model/SignatureRequestEventTest.php

test/Model/SignatureRequestEventTypeTest.php

test/Model/SignatureRequestInputTest.php

test/Model/SignatureRequestMessageTypeTest.php

test/Model/SignatureRequestRemindersTest.php

test/Model/SignatureRequestStateTest.php

test/Model/SignatureRequestTest.php

test/Model/SignatureRequestTokenTest.php

test/Model/SignatureRequestTokenTypeTest.php

test/Model/SigningOrderTest.php

test/Model/StringConditionTypeTest.php

test/Model/SubmissionActionStateTest.php

test/Model/SubmissionActionTest.php

test/Model/TextOverflowTest.php

test/Model/TextVerticalAlignmentTest.php

test/Model/TypefaceTest.php

test/Model/UpdateAccountEmailActionRequestTest.php

test/Model/UpdateEmailActionCustomizationRequestTest.php

test/Model/UpdateEmailActionRequestTest.php

test/Model/UpdateSignatureRequestRequestTest.php

test/Model/UpdateTemplateDocumentRequestTest.php

test/Model/UpdateTemplateFieldsRequestTest.php

- 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,

`$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, except `$contentType`, which is now after `$idempotency_key`: if you pass it, pass it by name

(`contentType: ...`).

- 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.

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