docspring 4.3.0 → 4.4.0

data/docs/EmailDomain.md

@@ -0,0 +1,38 @@
+# DocSpring::EmailDomain
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The email domain's ID. |  |
+| **domain** | **String** | The domain name, such as `example.com` or `mail.example.com`. Email actions can send from any address at it. |  |
+| **state** | [**EmailDomainState**](EmailDomainState.md) | `pending` until its DNS records are found, then `verified`. `failed`: its records weren't found within 3 days, or were removed. Verify it again after fixing them. |  |
+| **dkim_state** | [**EmailDomainRecordState**](EmailDomainRecordState.md) | Whether the DKIM records were found. |  |
+| **mail_from_state** | [**EmailDomainRecordState**](EmailDomainRecordState.md) | Whether the MAIL FROM records were found. They're optional: they let SPF pass for your domain too. |  |
+| **dns_records** | [**Array<EmailDomainDnsRecord>**](EmailDomainDnsRecord.md) | The DNS records to add to the domain. Empty while DocSpring is still setting the domain up: verify it again in a few minutes to get them. |  |
+| **dmarc_policy** | **String** | The policy (`p=`) of the domain's DMARC record, once it has been found. |  |
+| **last_error** | **String** | Why the domain isn't verified yet, or what to fix. |  |
+| **verified_at** | **Time** | When the domain was verified. |  |
+| **checked_at** | **Time** | When DocSpring last checked the domain's DNS records. |  |
+| **created_at** | **Time** | When the domain was added. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailDomain.new(
+  id: null,
+  domain: null,
+  state: null,
+  dkim_state: null,
+  mail_from_state: null,
+  dns_records: null,
+  dmarc_policy: null,
+  last_error: null,
+  verified_at: null,
+  checked_at: null,
+  created_at: null
+)
+```
+

data/docs/EmailDomainDnsRecord.md

@@ -0,0 +1,24 @@
+# DocSpring::EmailDomainDnsRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **purpose** | [**EmailDomainDnsRecordPurpose**](EmailDomainDnsRecordPurpose.md) | What the record is for. `dkim` signs the emails (required), `mail_from` lets SPF pass for your domain (recommended), and `dmarc` tells inboxes what to do with emails that fail these checks (required). |  |
+| **type** | [**DnsRecordType**](DnsRecordType.md) | The record's type. |  |
+| **name** | **String** | The record's name. Some DNS hosts add the domain to the end of a name by themselves. |  |
+| **value** | **String** | The record's value. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailDomainDnsRecord.new(
+  purpose: null,
+  type: null,
+  name: null,
+  value: null
+)
+```
+

data/docs/EmailDomainDnsRecordPurpose.md

@@ -0,0 +1,15 @@
+# DocSpring::EmailDomainDnsRecordPurpose
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailDomainDnsRecordPurpose.new()
+```
+

data/docs/EmailDomainList.md

@@ -0,0 +1,20 @@
+# DocSpring::EmailDomainList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<EmailDomain>**](EmailDomain.md) | The items on this page. |  |
+| **next_cursor** | **String** | Pass it as `cursor` to get the next page. Null on the last page. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailDomainList.new(
+  data: null,
+  next_cursor: null
+)
+```
+

data/docs/EmailDomainRecordState.md

@@ -0,0 +1,15 @@
+# DocSpring::EmailDomainRecordState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailDomainRecordState.new()
+```
+

data/docs/EmailDomainState.md

@@ -0,0 +1,15 @@
+# DocSpring::EmailDomainState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::EmailDomainState.new()
+```
+

data/docs/ErrorInfo.md

@@ -4,14 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **code** | [**ErrorCode**](ErrorCode.md) | A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count) or the embedded template editor. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): a request with the same Idempotency-Key is still being processed. Send the request again in a few seconds; when the first request has already created its record, its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. |  |
+| **code** | [**ErrorCode**](ErrorCode.md) | A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept. When the first request created a record, its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id` or `webhook_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`). |  |
 | **message** | **String** | A human-readable explanation, safe to show to developers. |  |
 | **details** | [**Array<ErrorDetail>**](ErrorDetail.md) | What was wrong with each part of the request. Empty when the error isn't about one part of it. |  |
 | **request_id** | **String** | The ID of the request. Include it when you contact support. |  |
-| **submission_id** | **String** | When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout` or `idempotency_key_in_use`, the submission that's still being processed. | [optional] |
-| **submission_batch_id** | **String** | The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout` or `idempotency_key_in_use`, the batch that's still being processed. | [optional] |
-| **combined_pdf_id** | **String** | With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout` or `idempotency_key_in_use`, the combined PDF that's still being processed. | [optional] |
-| **template_id** | **String** | With `polling_timeout`, the template whose PDF is still being processed. | [optional] |
+| **submission_id** | **String** | When a submission's data fails validation, the submission is still recorded (state `invalid_data`) so you can see it in the dashboard. This is its ID. With `insufficient_credits`, the submission that waits for credits. With `polling_timeout`, the submission that's still being processed. With `idempotency_key_in_use`, the submission the first request with the key created. | [optional] |
+| **submission_batch_id** | **String** | The ID of the recorded batch, when items in a batch fail validation. With `insufficient_credits`, the batch whose submissions wait for credits. With `polling_timeout`, the batch that's still being processed. With `idempotency_key_in_use`, the batch the first request with the key created. | [optional] |
+| **combined_pdf_id** | **String** | With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout`, the combined PDF that's still being processed. With `idempotency_key_in_use`, the combined PDF the first request with the key created. | [optional] |
+| **template_id** | **String** | With `polling_timeout`, the template whose PDF is still being processed. With `idempotency_key_in_use`, the template the first request with the key created. | [optional] |
+| **folder_id** | **String** | With `idempotency_key_in_use`, the folder the first request with the key created. | [optional] |
+| **custom_file_id** | **String** | With `idempotency_key_in_use`, the custom file the first request with the key created. | [optional] |
+| **webhook_id** | **String** | With `idempotency_key_in_use`, the webhook the first request with the key created. | [optional] |
 
 ## Example
 
@@ -26,7 +29,10 @@ instance = DocSpring::ErrorInfo.new(
   submission_id: null,
   submission_batch_id: null,
   combined_pdf_id: null,
-  template_id: null
+  template_id: null,
+  folder_id: null,
+  custom_file_id: null,
+  webhook_id: null
 )
 ```
 

data/docs/Field.md

@@ -83,7 +83,7 @@
 | **true_text** | **String** | Boolean fields with text display: the text printed when the value is `true`. Empty uses the template's `true_text`; when neither is set, nothing prints. |  |
 | **false_text** | **String** | Boolean fields with text display: the text printed when the value is `false`. Empty uses the template's `false_text`; when neither is set, nothing prints. |  |
 | **condition** | **String** | Check and shape display only: the value a string or number field's value is compared with, by `string_condition_type` or `number_condition_type`, to decide whether the check mark or shape prints. Boolean fields print when `true` (see `invert_boolean_condition`), and other types print when they have a value. |  |
-| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match. |  |
+| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`. |  |
 | **number_condition_type** | [**NumberConditionType**](NumberConditionType.md) | Number fields with check or shape display: how the value is compared with `condition`: `equals`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), or `range`, between `number_condition_range_min` and `number_condition_range_max`. |  |
 | **number_condition_range_min** | **Float** | With `number_condition_type` `range`: the lower end of the range, included unless `number_condition_range_exclusive_min` is set. |  |
 | **number_condition_range_max** | **Float** | With `number_condition_type` `range`: the upper end of the range, included unless `number_condition_range_exclusive_max` is set. |  |

data/docs/FieldInput.md

@@ -81,7 +81,7 @@
 | **true_text** | **String** | Boolean fields with text display: the text printed when the value is `true`. Empty uses the template's `true_text`; when neither is set, nothing prints. | [optional] |
 | **false_text** | **String** | Boolean fields with text display: the text printed when the value is `false`. Empty uses the template's `false_text`; when neither is set, nothing prints. | [optional] |
 | **condition** | **String** | Check and shape display only: the value a string or number field's value is compared with, by `string_condition_type` or `number_condition_type`, to decide whether the check mark or shape prints. Boolean fields print when `true` (see `invert_boolean_condition`), and other types print when they have a value. | [optional] |
-| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression the value must match. | [optional] |
+| **string_condition_type** | [**StringConditionType**](StringConditionType.md) | String fields with check or shape display: how the value is compared with `condition`: `equals`, `contains`, `starts_with`, `ends_with`, or `regex`, where `condition` is a regular expression (RE2 syntax) the value must match; each has a `not_` form that prints when it doesn't match (`not_equals`, `not_regex`, ...). `blank` prints when the value is empty or only spaces and line breaks, and `not_blank` when it isn't; they ignore `condition`. | [optional] |
 | **number_condition_type** | [**NumberConditionType**](NumberConditionType.md) | Number fields with check or shape display: how the value is compared with `condition`: `equals`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than), `lte` (less than or equal to), or `range`, between `number_condition_range_min` and `number_condition_range_max`. | [optional] |
 | **number_condition_range_min** | **Float** | With `number_condition_type` `range`: the lower end of the range, included unless `number_condition_range_exclusive_min` is set. | [optional] |
 | **number_condition_range_max** | **Float** | With `number_condition_type` `range`: the upper end of the range, included unless `number_condition_range_exclusive_max` is set. | [optional] |

data/docs/HtmlEngineOptions.md

@@ -7,7 +7,7 @@
 | **format** | [**PageFormat**](PageFormat.md) | The paper size. `Custom` uses `width` and `height`. |  |
 | **width** | **String** | The page width for the `Custom` format, with a unit (`8.5in`, `210mm`). | [optional] |
 | **height** | **String** | The page height for the `Custom` format, with a unit. | [optional] |
-| **scale** | **Float** | How much to scale the page, such as `0.8`. `1` prints it at its normal size. |  |
+| **scale** | **Float** | How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size. |  |
 | **landscape** | **Boolean** | Print pages in landscape orientation. |  |
 | **print_background** | **Boolean** | Print background colors and images. |  |
 | **margin_top** | **String** | The top margin, with a unit, such as `1in` or `20mm`. |  |

data/docs/HtmlEngineOptionsInput.md

@@ -7,7 +7,7 @@
 | **format** | [**PageFormat**](PageFormat.md) | The paper size. `Custom` uses `width` and `height`. | [optional] |
 | **width** | **String** | The page width for the `Custom` format, with a unit (`8.5in`, `210mm`). | [optional] |
 | **height** | **String** | The page height for the `Custom` format, with a unit. | [optional] |
-| **scale** | **Float** | How much to scale the page, such as `0.8`. `1` prints it at its normal size. | [optional] |
+| **scale** | **Float** | How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size. | [optional] |
 | **landscape** | **Boolean** | Print pages in landscape orientation. | [optional] |
 | **print_background** | **Boolean** | Print background colors and images. | [optional] |
 | **margin_top** | **String** | The top margin, with a unit, such as `1in` or `20mm`. | [optional] |

data/docs/SendAccountEmailActionTestEmailRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::SendAccountEmailActionTestEmailRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | A template the email action sends for: the test uses its PDF and name. Left out, it uses the one that changed most recently. | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SendAccountEmailActionTestEmailRequest.new(
+  template_id: null
+)
+```
+

data/docs/SignatureRequest.md

@@ -7,11 +7,15 @@
 | **id** | **String** | The signature request's ID. |  |
 | **submission_id** | **String** | The ID of the submission the signature request belongs to. |  |
 | **name** | **String** | The name of the person the request is for. |  |
-| **email** | **String** | Their email address. |  |
+| **email** | **String** | Their email address. Null when they have none. |  |
 | **fields** | **Array<String>** | The fields this person fills in. Null for a signature request created with API v1 without a field list: it asks for every field the submission's data doesn't have. |  |
 | **metadata** | **Hash<String, Object>** | Your own data about the signature request, such as an ID from your app. |  |
 | **role** | **String** | Which of the template's signers the person is. Until templates have roles of their own, a template's signers are `Signer 1`, `Signer 2` and so on, up to `Signer 100`: `Signer 1` is the one whose details the template's `@@signature_requests/0` fields print. |  |
 | **sort_order** | **Integer** | The signer's position, from 0: `Signer 1` is 0. The template's `@@signature_requests/<sort_order>` fields print this signature request's details. |  |
+| **send_email** | **Boolean** | Whether DocSpring emails this person their signing link. |  |
+| **signing_step** | **Integer** | When this person signs, when the submission's `signing_order` is `sequential`: everyone in step 1 first, then step 2, and so on. Null when everyone can sign at once. |  |
+| **sent_at** | **Time** | When DocSpring first emailed this person their signing link. Null until it has, and when it doesn't email them (`send_email` is false). |  |
+| **email_status** | [**SignatureRequestEmailStatus**](SignatureRequestEmailStatus.md) | What happened to the latest email DocSpring sent this person with their signing link: `sent` until the email service reports on it, then `delayed` (still trying), `delivered`, `undelivered` (it stopped trying, as with a full mailbox), `bounced` (the address doesn't exist) or `complained` (marked as spam). `failed` means DocSpring couldn't send the first email with their link, and `unknown` that it couldn't tell whether that email went: neither is sent again. Null until DocSpring has emailed them or tried to. |  |
 | **state** | [**SignatureRequestState**](SignatureRequestState.md) | `pending` until the person completes the signature request (`completed`) or declines it (`declined`). |  |
 | **data** | **Hash<String, Object>** | The values this person entered for their own fields (`fields`). Null when their submission's data is left out: in lists without `include_data=true`, in the events of a webhook that leaves out submission data, and once the submission has expired. |  |
 | **viewed_at** | **Time** | When the person first opened the signature request. |  |
@@ -44,6 +48,10 @@ instance = DocSpring::SignatureRequest.new(
   metadata: null,
   role: null,
   sort_order: null,
+  send_email: null,
+  signing_step: null,
+  sent_at: null,
+  email_status: null,
   state: null,
   data: null,
   viewed_at: null,

data/docs/SignatureRequestEmailAttachments.md

@@ -0,0 +1,15 @@
+# DocSpring::SignatureRequestEmailAttachments
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SignatureRequestEmailAttachments.new()
+```
+

data/docs/SignatureRequestEmailStatus.md

@@ -0,0 +1,15 @@
+# DocSpring::SignatureRequestEmailStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SignatureRequestEmailStatus.new()
+```
+

data/docs/SignatureRequestInput.md

@@ -5,11 +5,11 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the person the request is for. | [optional] |
-| **email** | **String** | Their email address. | [optional] |
+| **email** | **String** | Their email address. Null when they have none. | [optional] |
 | **fields** | **Array<String>** | The fields this person fills in. Each field can only be in one signature request, and a field that `data` fills in needs `prefilled_values_editable`. |  |
 | **metadata** | **Hash<String, Object>** | Your own data about the signature request, such as an ID from your app. | [optional] |
 | **role** | **String** | Which of the template's signers the person is: `Signer 1`, `Signer 2` and so on, up to `Signer 100`, until templates have roles of their own. Either every signature request has a `role` or none does, and each role can only have one. | [optional] |
-| **auth_type** | [**SignatureRequestAuthType**](SignatureRequestAuthType.md) | How your app authenticated the person before it showed them the signature request. |  |
+| **auth_type** | [**SignatureRequestAuthType**](SignatureRequestAuthType.md) | How your app authenticated the person before it showed them the signature request. | [optional] |
 | **auth_second_factor_type** | [**SignatureRequestAuthSecondFactorType**](SignatureRequestAuthSecondFactorType.md) | The second factor your app authenticated them with, if any. | [optional] |
 | **auth_provider** | **String** | The service that authenticated them, such as `google`. Required when `auth_type` is `oauth`. | [optional] |
 | **auth_session_started_at** | **Time** | When your app authenticated them. Set for you with `email_link`. | [optional] |
@@ -19,6 +19,8 @@
 | **auth_phone_number_hash** | **String** | The phone number they authenticated with, or a SHA-256 hash of a salt and the phone number. | [optional] |
 | **ignore_unknown_fields** | **Boolean** | Leave out names in `fields` that the template doesn't have, for one field list that you send with several templates. Without it, an unknown name makes the submission `invalid_data`. | [optional] |
 | **prefilled_values_editable** | **Boolean** | Let the person change the values that `data` already has for fields in `fields`. Without it, those fields are a 422. | [optional] |
+| **send_email** | **Boolean** | Whether DocSpring emails this person their signing link. Default: the submission's `send_email`. Set it to false for someone who signs in your app (embedded signing) or whose link you send yourself. When DocSpring emails them, `email` is required and `auth_type` is `email_link` (the default). Otherwise `auth_type` is required. | [optional] |
+| **signing_step** | **Integer** | When this person signs, with `signing_order: sequential`: everyone in step 1 first, then step 2, and so on. People in the same step sign in any order. Only the order of the numbers matters. Either every signature request has a `signing_step` or none does; without them, each person is a step of their own, in the order of `signature_requests`. | [optional] |
 
 ## Example
 
@@ -40,7 +42,9 @@ instance = DocSpring::SignatureRequestInput.new(
   auth_username_hash: null,
   auth_phone_number_hash: null,
   ignore_unknown_fields: null,
-  prefilled_values_editable: null
+  prefilled_values_editable: null,
+  send_email: null,
+  signing_step: null
 )
 ```
 

data/docs/SignatureRequestReminders.md

@@ -0,0 +1,20 @@
+# DocSpring::SignatureRequestReminders
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **interval_days** | **Integer** | Days between reminders. |  |
+| **max_count** | **Integer** | The most reminders each person gets. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SignatureRequestReminders.new(
+  interval_days: null,
+  max_count: null
+)
+```
+

data/docs/SigningOrder.md

@@ -0,0 +1,15 @@
+# DocSpring::SigningOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SigningOrder.new()
+```
+

data/docs/Submission.md

@@ -11,7 +11,7 @@
 | **batch_id** | **String** | The ID of the batch the submission was created in. |  |
 | **source** | [**SubmissionSource**](SubmissionSource.md) | `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again. |  |
 | **state** | [**SubmissionState**](SubmissionState.md) | `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`. |  |
-| **test** | **Boolean** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions. |  |
+| **test** | **Boolean** | 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. |  |
 | **editable** | **Boolean** | `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`. |  |
 | **data** | **Hash<String, Object>** | The submission's data, with the values entered in completed signature requests. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data. |  |
 | **data_errors** | [**Array<ErrorDetail>**](ErrorDetail.md) | Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired. |  |
@@ -25,7 +25,8 @@
 | **updated_at** | **Time** | When the submission was last updated. |  |
 | **has_password** | **Boolean** | Whether the PDF needs a password to open (`password`). |  |
 | **signature_requests** | [**Array<SignatureRequest>**](SignatureRequest.md) | The people asked to sign the submission (and fill in their fields), in order. |  |
-| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | The uploads of the submission's PDF to your storage (account integrations). |  |
+| **signing_order** | [**SigningOrder**](SigningOrder.md) | `parallel`: everyone can sign at once. `sequential`: people sign one step at a time (each signature request's `signing_step`). |  |
+| **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | The uploads of the submission's PDF to your storage (account integrations), and the emails its template's email actions sent. |  |
 | **truncated_text** | **Hash<String, Array<String>>** | The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired. |  |
 | **output_formats** | [**Array<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. |  |
 | **preview_generated_at** | **Time** | When the preview PDF was generated. Null if there is no preview. |  |
@@ -57,6 +58,7 @@ instance = DocSpring::Submission.new(
   updated_at: null,
   has_password: null,
   signature_requests: null,
+  signing_order: null,
   actions: null,
   truncated_text: null,
   output_formats: null,

data/docs/SubmissionAction.md

@@ -6,9 +6,10 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The upload's ID. |  |
 | **integration_id** | **String** | The ID of the account integration it used. |  |
-| **state** | [**SubmissionActionState**](SubmissionActionState.md) | `pending` until the upload has run, then `processed`. `failed`: your storage rejected it. `error`: it failed in DocSpring. |  |
-| **action_type** | [**SubmissionActionType**](SubmissionActionType.md) | The kind of storage, such as `aws_s3_upload` for an S3 bucket. |  |
-| **result_data** | **Hash<String, Object>** | Where the PDF was uploaded, such as the S3 bucket and key. |  |
+| **email_action_id** | **String** | The ID of the email action that sent the email. Null for an upload, or once the email action is deleted. |  |
+| **state** | [**SubmissionActionState**](SubmissionActionState.md) | `pending` until the upload or email has run, then `processed`. `failed`: your storage or the email service rejected it. `error`: it failed in DocSpring. |  |
+| **action_type** | [**SubmissionActionType**](SubmissionActionType.md) | The kind of storage, such as `aws_s3_upload` for an S3 bucket, or `email` for an email action's email. |  |
+| **result_data** | **Hash<String, Object>** | Where the PDF was uploaded, such as the S3 bucket and key. For an email: its `subject`, `recipients`, each with its `address`, `kind` (`to`, `cc` or `bcc`), `source`, `field` or `metadata` when the address came from one, and `status` (`sent`, `delivered`, `bounced`, `complained`, `skipped` and others), `sent_at`, `delivery`, and `files` (the files it sent: `pdf`, `docx`, `odt`). An email whose submission didn't meet the email action's `send_when` conditions has only `skipped`, `conditions_not_met`, and its state is `processed`. An email whose submission made none of the files the email action sends has `skipped`, `no_files` and the action's `file_formats`, and its state is `processed` too. When the submission's data is left out (a batch, or a webhook without submission data), the subject and the addresses that came from fields or metadata are null. |  |
 | **error_message** | **String** | Why the upload failed, when `state` is `failed` or `error`. |  |
 
 ## Example
@@ -19,6 +20,7 @@ require 'docspring'
 instance = DocSpring::SubmissionAction.new(
   id: null,
   integration_id: null,
+  email_action_id: null,
   state: null,
   action_type: null,
   result_data: null,

data/docs/SubmissionInput.md

@@ -4,13 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **test** | **Boolean** | 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** | **Boolean** | 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** | **Boolean** | `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** | **Hash<String, Object>** | The values of the template's fields, by field name. Required for PDF and Word templates. | [optional] |
+| **data** | **Hash<String, Object>** | The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs. | [optional] |
 | **metadata** | **Hash<String, 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** | **String** | 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** | [**Array<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** | **Integer** | 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** | **Integer** | 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** | [**Hash<String, 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** | **String** | For an HTML template, HTML to use instead of the template's. | [optional] |
 | **css** | **String** | 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] |

data/docs/SubmissionSummary.md

@@ -11,7 +11,7 @@
 | **batch_id** | **String** | The ID of the batch the submission was created in. |  |
 | **source** | [**SubmissionSource**](SubmissionSource.md) | `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again. |  |
 | **state** | [**SubmissionState**](SubmissionState.md) | `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`. |  |
-| **test** | **Boolean** | Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions. |  |
+| **test** | **Boolean** | 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. |  |
 | **editable** | **Boolean** | `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`. |  |
 | **data** | **Hash<String, Object>** | The submission's data, with the values entered in completed signature requests. Null unless you pass `include_data=true`. Empty once the submission has expired. |  |
 | **data_errors** | [**Array<ErrorDetail>**](ErrorDetail.md) | Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired. |  |

data/docs/Template.md

@@ -7,9 +7,9 @@
 | **id** | **String** | The template's ID. |  |
 | **name** | **String** | The template's name. |  |
 | **description** | **String** | Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests. |  |
-| **template_type** | [**TemplateType**](TemplateType.md) | `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created. |  |
-| **output_format** | [**OutputFormat**](OutputFormat.md) | What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected. |  |
-| **ready** | **Boolean** | Whether the template can make documents. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded). |  |
+| **template_type** | [**TemplateType**](TemplateType.md) | `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. `page_designer`: a page design, a PDF laid out in the Page Designer from its `layout`. It can't be changed after the template is created. |  |
+| **output_format** | [**OutputFormat**](OutputFormat.md) | What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; other templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected. |  |
+| **ready** | **Boolean** | Whether the template can make documents. HTML templates and page designs are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded). |  |
 | **document** | [**TemplateDocument**](TemplateDocument.md) | The PDF of a PDF template, or the Word document of a Word template. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url` has one, with no file, while it's downloaded. |  |
 | **parent_folder_id** | **String** | The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions. |  |
 | **path** | **String** | The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root. |  |
@@ -26,7 +26,7 @@
 | **allow_skipping_optional_fields** | **Boolean** | Visual forms and signature request forms show the Continue button as soon as the required fields are filled in, without visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it. |  |
 | **default_form_mode** | [**TemplateFormMode**](TemplateFormMode.md) | The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). Only PDF templates have a visual form, so other templates accept only `web`. |  |
 | **editable_submissions** | **Boolean** | Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it. |  |
-| **embed_domains** | **Array<String>** | The sites that can embed the template's live signature requests and its embedded template editor: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and the simple form) aren't restricted. |  |
+| **embed_domains** | **Array<String>** | The sites that can embed the template's live signature requests and its embedded template editor: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work), without a path. Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and the simple form) aren't restricted. |  |
 | **embed_edit_allow_settings** | **Boolean** | Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on). |  |
 | **embed_edit_allow_versioning** | **Boolean** | Allow the embedded template editor to publish, restore, compare and delete published versions. |  |
 | **embed_edit_allow_document_replacement** | **Boolean** | Allow the embedded template editor to replace the template's PDF. |  |
@@ -40,6 +40,13 @@
 | **public_submissions** | **Boolean** | Allow anyone with a submission's ID to download its PDF. |  |
 | **public_web_form** | **Boolean** | Allow anyone to fill in the template's web form. |  |
 | **redirect_url** | **String** | Where the web form sends people after they submit it. |  |
+| **signature_request_email_attachments** | [**SignatureRequestEmailAttachments**](SignatureRequestEmailAttachments.md) | How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached. PDF templates only. A signature request uses the value it had when the request was created. |  |
+| **signature_request_from_address** | **String** | The address DocSpring's emails to your signers come from: an address at one of your verified email domains, on the Growth plan or higher. Null sends them from DocSpring's shared address, with "via DocSpring" after the sender name. PDF templates only. |  |
+| **signature_request_include_signing_token** | **Boolean** | Puts a signing token in `signature_request_signing_url`, as `{{ token_id }}` and `{{ token_secret }}`, so your page can open the signing form without creating a token itself. The email then carries a credential: anyone who has it can open the form and sign. PDF templates only. |  |
+| **signature_request_from_name** | **String** | The sender name on the emails DocSpring sends your signers, as in "Acme via DocSpring". It can't contain an email address, a website or quotes. Null uses your account's name. PDF templates only. |  |
+| **signature_request_notification_emails** | **Array<String>** | Who DocSpring tells when a signature request's document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Empty means your account's owner. A submission's `notification_emails` replaces them. PDF templates only. |  |
+| **signature_request_reply_to** | **String** | Where your signers' replies to DocSpring's emails go: a member of your DocSpring team or an address at one of your verified email domains. Null means your account's owner. A submission's `reply_to` replaces it. PDF templates only. |  |
+| **signature_request_signing_url** | **String** | A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page. PDF templates only. |  |
 | **has_slack_webhook_url** | **Boolean** | Whether `slack_webhook_url` is set. |  |
 | **last_changed_by** | [**TemplateActor**](TemplateActor.md) | Who last changed the draft: a user in your account, an API token, or someone using the embedded template editor. Null if no change has been recorded. |  |
 | **defaults** | [**TemplateDefaults**](TemplateDefaults.md) |  |  |
@@ -47,12 +54,13 @@
 | **field_groups** | [**Array<FieldGroup>**](FieldGroup.md) | The groups of the template's fields, with their settings. A field's name puts it in groups: `address/city` is in the group `address`, and `items/0/price` is in the list `items` and its items' group `items/~`. |  |
 | **predefined_fields** | [**Array<PredefinedField>**](PredefinedField.md) | The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off. |  |
 | **predefined_fields_sample_data** | **Hash<String, Object>** | Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for. |  |
-| **html** | **String** | The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates. |  |
+| **html** | **String** | The HTML of an HTML template, as a Liquid template. Null for other templates. |  |
 | **scss** | **String** | The SCSS of an HTML template. |  |
 | **header_html** | **String** | The HTML printed at the top of each page of an HTML template. |  |
 | **footer_html** | **String** | The HTML printed at the bottom of each page of an HTML template. |  |
-| **html_engine_options** | [**HtmlEngineOptions**](HtmlEngineOptions.md) | How an HTML template's PDFs are printed. Null for PDF and Word templates. Setting it replaces the whole object: options left out use their defaults. |  |
-| **html_escape_data** | **Boolean** | Whether an HTML template HTML-escapes the values it prints. When true, `{{ value }}` prints a value as text, so a `<` or `&` in it is printed as that character, and `{{ value | raw }}` prints a value as HTML. New HTML templates default to true. Templates created before October 2026, or with API v1, default to false, which prints every value as HTML. Null for PDF templates. |  |
+| **html_engine_options** | [**HtmlEngineOptions**](HtmlEngineOptions.md) | How an HTML template's PDFs are printed. Null for other templates. Setting it replaces the whole object: options left out use their defaults. |  |
+| **html_escape_data** | **Boolean** | Whether an HTML template HTML-escapes the values it prints. When true, `{{ value }}` prints a value as text, so a `<` or `&` in it is printed as that character, and `{{ value | raw }}` prints a value as HTML. New HTML templates default to true. Templates created before October 2026, or with API v1, default to false, which prints every value as HTML. Null for other templates. |  |
+| **layout** | **Hash<String, Object>** | A page design's layout: its page setup, its sections and the elements placed in them, in the Page Designer layout format (https://docspring.com/docs/page-designer/layout-format/). Its JSON Schema is at https://docspring.com/schemas/page-designer/layout.v1.json. Null for other templates. Setting it replaces the whole layout, and DocSpring adds a field for each value it reads. Left out when a page design is created, it starts with an empty page. |  |
 | **embed_edit_token** | **String** | The token that opens the template in the embedded template editor. |  |
 | **versions** | [**Array<TemplateVersion>**](TemplateVersion.md) | The template's published versions, newest first (up to 100). |  |
 
@@ -98,6 +106,13 @@ instance = DocSpring::Template.new(
   public_submissions: null,
   public_web_form: null,
   redirect_url: null,
+  signature_request_email_attachments: null,
+  signature_request_from_address: null,
+  signature_request_include_signing_token: null,
+  signature_request_from_name: null,
+  signature_request_notification_emails: null,
+  signature_request_reply_to: null,
+  signature_request_signing_url: null,
   has_slack_webhook_url: null,
   last_changed_by: null,
   defaults: null,
@@ -111,6 +126,7 @@ instance = DocSpring::Template.new(
   footer_html: null,
   html_engine_options: null,
   html_escape_data: null,
+  layout: null,
   embed_edit_token: null,
   versions: null
 )

data/docs/TemplateSourcePdf.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** | Must be `template`. | [default to 'template'] |
 | **id** | **String** | The ID of the submission, combined PDF, template or custom file. |  |
-| **template_version** | **String** | 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** | **String** | 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** | **Boolean** | 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

data/docs/TemplateSummary.md

@@ -7,10 +7,10 @@
 | **id** | **String** | The template's ID. |  |
 | **name** | **String** | The template's name. |  |
 | **description** | **String** | Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests. |  |
-| **template_type** | [**TemplateType**](TemplateType.md) | `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created. |  |
-| **output_format** | [**OutputFormat**](OutputFormat.md) | What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected. |  |
-| **ready** | **Boolean** | Whether the template can make documents. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded). |  |
-| **document** | [**TemplateDocumentSummary**](TemplateDocumentSummary.md) | The PDF of a PDF template, or the Word document of a Word template: its file name, page count and processing state. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url`, or a Word template created from an OpenDocument file (.odt), has one, with no file, while it's downloaded or converted. |  |
+| **template_type** | [**TemplateType**](TemplateType.md) | `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. `page_designer`: a page design, a PDF laid out in the Page Designer from its `layout`. It can't be changed after the template is created. |  |
+| **output_format** | [**OutputFormat**](OutputFormat.md) | What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; other templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected. |  |
+| **ready** | **Boolean** | Whether the template can make documents. HTML templates and page designs are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded). |  |
+| **document** | [**TemplateDocumentSummary**](TemplateDocumentSummary.md) | The PDF of a PDF template, or the Word document of a Word template: its file name, page count and processing state. Null for HTML templates and page designs, and for a PDF template that has no PDF yet. A template created from a `document_url`, or a Word template created from an OpenDocument file (.odt), has one, with no file, while it's downloaded or converted. |  |
 | **parent_folder_id** | **String** | The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions. |  |
 | **path** | **String** | The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root. |  |
 | **latest_version** | **String** | The template's latest published version. Null if no version has been published. |  |