docspring 4.0.0 → 4.2.0

data/docs/SubmissionValidation.md

@@ -0,0 +1,24 @@
+# DocSpring::SubmissionValidation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | True when creating the submission would succeed. |  |
+| **template_id** | **String** | The template's ID. |  |
+| **template_version** | **String** | The published version the request was checked against, such as `1.2.0`. Null for the draft. |  |
+| **error** | [**ErrorInfo**](ErrorInfo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::SubmissionValidation.new(
+  valid: null,
+  template_id: null,
+  template_version: null,
+  error: null
+)
+```
+

data/docs/Template.md

@@ -8,21 +8,24 @@
 | **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. It can't be changed after the template is created. |  |
-| **ready** | **Boolean** | Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once its document has been processed (`document.state` is `processed`). |  |
+| **ready** | **Boolean** | Whether the template can generate PDFs. 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. |  |
 | **document** | [**TemplateDocument**](TemplateDocument.md) | The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet. |  |
 | **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. |  |
-| **version** | **String** | The published version this is, such as `1.2.0`. Null for the draft. |  |
 | **latest_version** | **String** | The template's latest published version. Null if no version has been published. |  |
 | **version_published_at** | **Time** | When this version was published. Null for the draft. |  |
 | **locked** | **Boolean** | A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed). |  |
+| **last_changed_at** | **Time** | When the draft was last changed. |  |
+| **created_at** | **Time** | When the template was created. |  |
+| **updated_at** | **Time** | When the template was last updated. |  |
+| **version** | **String** | The published version this is, such as `1.2.0`. Null for the draft. |  |
 | **add_signature_request_submission_id_footers** | **Boolean** | Print the submission ID in the footer of each page of PDFs signed through signature requests. |  |
 | **ai_field_naming_language** | [**AiFieldNamingLanguage**](AiFieldNamingLanguage.md) | The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. New templates take it from your account's template settings. Null for HTML templates. |  |
 | **allow_additional_properties** | **Boolean** | Accept submission data with properties that aren't fields of the template. |  |
 | **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). HTML templates have no visual form, so `web` is the only value they accept. |  |
 | **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 where the template's signature requests, forms and embedded template editor can be loaded: 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). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site. |  |
+| **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_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. |  |
@@ -37,17 +40,18 @@
 | **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. |  |
 | **has_slack_webhook_url** | **Boolean** | Whether `slack_webhook_url` is set. |  |
-| **last_changed_at** | **Time** | When the draft was last changed. |  |
 | **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. |  |
-| **created_at** | **Time** | When the template was created. |  |
-| **updated_at** | **Time** | When the template was last updated. |  |
 | **defaults** | [**TemplateDefaults**](TemplateDefaults.md) |  |  |
 | **field_dependencies** | [**Array<TemplateFieldDependency>**](TemplateFieldDependency.md) | Conditional logic: each rule shows or hides its target fields, or makes them required, depending on the values of other fields. |  |
+| **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 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 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. |  |
 | **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). |  |
 
@@ -65,10 +69,13 @@ instance = DocSpring::Template.new(
   document: null,
   parent_folder_id: null,
   path: null,
-  version: null,
   latest_version: null,
   version_published_at: null,
   locked: null,
+  last_changed_at: null,
+  created_at: null,
+  updated_at: null,
+  version: null,
   add_signature_request_submission_id_footers: null,
   ai_field_naming_language: null,
   allow_additional_properties: null,
@@ -90,17 +97,18 @@ instance = DocSpring::Template.new(
   public_web_form: null,
   redirect_url: null,
   has_slack_webhook_url: null,
-  last_changed_at: null,
   last_changed_by: null,
-  created_at: null,
-  updated_at: null,
   defaults: null,
   field_dependencies: null,
+  field_groups: null,
+  predefined_fields: null,
+  predefined_fields_sample_data: null,
   html: null,
   scss: null,
   header_html: null,
   footer_html: null,
   html_engine_options: null,
+  html_escape_data: null,
   embed_edit_token: null,
   versions: null
 )

data/docs/TemplateActor.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | [**TemplateActorType**](TemplateActorType.md) | `user`: a user in your account. `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app. |  |
+| **type** | [**TemplateActorType**](TemplateActorType.md) | `user`: a user in your account, also when they make the change with an app they connected (an OAuth access token). `api`: an API token. `external_user`: someone using the embedded template editor, as identified by your app. |  |
 | **user_id** | **String** | The user's ID, for `user`. |  |
 | **external_id** | **String** | The ID your app gave the embedded editor's user, for `external_user`. |  |
 | **name** | **String** | The user's name, or the name your app gave the embedded editor's user. |  |

data/docs/TemplateDiff.md

@@ -0,0 +1,30 @@
+# DocSpring::TemplateDiff
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The template's ID. |  |
+| **from_version** | **String** | The earlier version, such as `1.1.0`. Null when no version was published before `to_version`: it's compared with a new template, so all of its fields are added. |  |
+| **to_version** | **String** | The later version, such as `1.2.0`. Null for the draft. |  |
+| **summary** | [**TemplateDiffSummary**](TemplateDiffSummary.md) | How many changes of each kind there are. |  |
+| **fields** | [**TemplateFieldChanges**](TemplateFieldChanges.md) | The fields that changed. |  |
+| **changed_settings** | **Array<String>** | The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `expire_after`, ...). Values aren't included, and secrets like `encrypt_pdfs_password` are named when they change. |  |
+| **document_changed** | **Boolean** | The template's PDF was replaced (or added, when there's no `from_version`). |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateDiff.new(
+  template_id: null,
+  from_version: null,
+  to_version: null,
+  summary: null,
+  fields: null,
+  changed_settings: null,
+  document_changed: null
+)
+```
+

data/docs/TemplateDiffSummary.md

@@ -0,0 +1,28 @@
+# DocSpring::TemplateDiffSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fields_added** | **Integer** | How many fields were added. |  |
+| **fields_removed** | **Integer** | How many fields were removed. |  |
+| **fields_changed** | **Integer** | How many fields have changed settings. |  |
+| **fields_reordered** | **Integer** | How many fields moved in the template's field order. |  |
+| **settings_changed** | **Integer** | How many of the template's settings changed. |  |
+| **total_changes** | **Integer** | All the changes, counting a new document as one. Zero when the versions are the same. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateDiffSummary.new(
+  fields_added: null,
+  fields_removed: null,
+  fields_changed: null,
+  fields_reordered: null,
+  settings_changed: null,
+  total_changes: null
+)
+```
+

data/docs/TemplateDocument.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **filename** | **String** | The PDF's file name. |  |
+| **filename** | **String** | The PDF's file name. Null until a `document_url` has been downloaded. |  |
+| **state** | [**TemplateDocumentState**](TemplateDocumentState.md) | `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be. |  |
+| **error_message** | **String** | Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error. |  |
+| **page_count** | **Integer** | 0 until the PDF has been processed. |  |
 | **md5** | **String** | The MD5 hash of the PDF. |  |
-| **state** | [**TemplateDocumentState**](TemplateDocumentState.md) | `pending` while DocSpring processes the PDF, then `processed`. `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. |  |
-| **error_message** | **String** | Why the PDF couldn't be processed, and how to fix it. Null unless `state` is an error. |  |
 | **field_reimport_state** | [**FieldReimportState**](FieldReimportState.md) | Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was). |  |
-| **page_count** | **Integer** | 0 until the PDF has been processed. |  |
 | **page_dimensions** | **Array<Array<Float>>** | Each page's width and height in PDF points. Null until the PDF has been processed. |  |
 | **has_fillable_fields** | **Boolean** | Whether the PDF has fillable form fields. Null until DocSpring has read the PDF. |  |
 | **page_processing_statuses** | [**Array<TemplatePageProcessingStatus>**](TemplatePageProcessingStatus.md) | How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, and for PDFs uploaded before DocSpring recorded page statuses. |  |
@@ -24,11 +24,11 @@ require 'docspring'
 
 instance = DocSpring::TemplateDocument.new(
   filename: null,
-  md5: null,
   state: null,
   error_message: null,
-  field_reimport_state: null,
   page_count: null,
+  md5: null,
+  field_reimport_state: null,
   page_dimensions: null,
   has_fillable_fields: null,
   page_processing_statuses: null,

data/docs/TemplateDocumentSummary.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplateDocumentSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filename** | **String** | The PDF's file name. Null until a `document_url` has been downloaded. |  |
+| **state** | [**TemplateDocumentState**](TemplateDocumentState.md) | `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be. |  |
+| **error_message** | **String** | Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error. |  |
+| **page_count** | **Integer** | 0 until the PDF has been processed. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateDocumentSummary.new(
+  filename: null,
+  state: null,
+  error_message: null,
+  page_count: null
+)
+```
+

data/docs/TemplateFieldChange.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplateFieldChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The field's ID. |  |
+| **changed_settings** | **Array<String>** | The names of the settings that changed, such as `x` or `required`. |  |
+| **old** | [**Field**](Field.md) |  |  |
+| **new** | [**Field**](Field.md) |  |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFieldChange.new(
+  id: null,
+  changed_settings: null,
+  old: null,
+  new: null
+)
+```
+

data/docs/TemplateFieldChanges.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplateFieldChanges
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **added** | [**Array<Field>**](Field.md) | The fields that `to_version` has and `from_version` doesn't. |  |
+| **removed** | [**Array<Field>**](Field.md) | The fields that `from_version` has and `to_version` doesn't, as they were. |  |
+| **changed** | [**Array<TemplateFieldChange>**](TemplateFieldChange.md) | The fields with changed settings. |  |
+| **reordered** | [**Array<TemplateFieldMove>**](TemplateFieldMove.md) | The fields that moved in the template's field order (the order of its fields across all its pages, as the fields endpoint lists them): fields that swapped places, or the field that moved the furthest. The fields that a move pushed along aren't listed. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFieldChanges.new(
+  added: null,
+  removed: null,
+  changed: null,
+  reordered: null
+)
+```
+

data/docs/TemplateFieldDependency.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to its targets when its conditions are met. |  |
+| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to the fields it applies to when its conditions are met. |  |
 | **match** | [**TemplateFieldDependencyMatch**](TemplateFieldDependencyMatch.md) | Whether all of the conditions (the default) or any of them must be met. | [optional] |
 | **conditions** | [**Array<TemplateFieldDependencyCondition>**](TemplateFieldDependencyCondition.md) | The conditions on other fields' values. |  |
 | **targets** | **Array<String>** | The names of the fields the rule shows or makes required. |  |

data/docs/TemplateFieldDependencyInput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to its targets when its conditions are met. |  |
+| **action** | [**TemplateFieldDependencyAction**](TemplateFieldDependencyAction.md) | What the rule does to the fields it applies to when its conditions are met. |  |
 | **match** | [**TemplateFieldDependencyMatch**](TemplateFieldDependencyMatch.md) | Whether all of the conditions (the default) or any of them must be met. | [optional] |
 | **conditions** | [**Array<TemplateFieldDependencyConditionInput>**](TemplateFieldDependencyConditionInput.md) | The conditions on other fields' values. |  |
 | **targets** | **Array<String>** | The names of the fields the rule shows or makes required. |  |

data/docs/TemplateFieldMove.md

@@ -0,0 +1,22 @@
+# DocSpring::TemplateFieldMove
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The field's ID. |  |
+| **old_index** | **Integer** | Its place in `from_version`'s field order, starting at 0. |  |
+| **new_index** | **Integer** | Its place in `to_version`'s field order, starting at 0. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFieldMove.new(
+  id: null,
+  old_index: null,
+  new_index: null
+)
+```
+

data/docs/TemplateFields.md

@@ -0,0 +1,22 @@
+# DocSpring::TemplateFields
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The template's ID. |  |
+| **version** | **String** | The published version the fields are of, such as `1.2.0`. Null for the draft. |  |
+| **fields** | [**Array<Field>**](Field.md) | The fields. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplateFields.new(
+  template_id: null,
+  version: null,
+  fields: null
+)
+```
+

data/docs/TemplatePageImages.md

@@ -0,0 +1,24 @@
+# DocSpring::TemplatePageImages
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The template's ID. |  |
+| **version** | **String** | The published version the images are of, such as `1.2.0`. Null for the draft. |  |
+| **page_count** | **Integer** | How many pages the PDF has. |  |
+| **pages** | [**Array<PageImage>**](PageImage.md) | An image of each page, in order: `pages[0]` is page 1. Their `download_url`s expire, so get them again when you need them. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplatePageImages.new(
+  template_id: null,
+  version: null,
+  page_count: null,
+  pages: null
+)
+```
+

data/docs/TemplatePreview.md

@@ -0,0 +1,32 @@
+# DocSpring::TemplatePreview
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The preview's ID. |  |
+| **template_id** | **String** | The template's ID. |  |
+| **version** | **String** | The published version that was rendered, such as `1.2.0`. Null for the draft. |  |
+| **state** | [**TemplatePreviewState**](TemplatePreviewState.md) | `pending` while it renders (usually a few seconds), then `processed`, or `error` with an `error_message`. |  |
+| **error_message** | **String** | Why the preview couldn't be rendered, such as an error in an HTML template's Liquid, or a value in the data that a field can't print. |  |
+| **page_count** | **Integer** | How many pages the template printed, once it's processed. |  |
+| **pages** | [**Array<PageImage>**](PageImage.md) | A PNG image of each page once it's processed, in order: `pages[0]` is page 1. A preview has no PDF. Their `download_url`s expire, so get the preview again when you need them. |  |
+| **expires_at** | **Time** | When the preview and its images are deleted. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::TemplatePreview.new(
+  id: null,
+  template_id: null,
+  version: null,
+  state: null,
+  error_message: null,
+  page_count: null,
+  pages: null,
+  expires_at: null
+)
+```
+

data/docs/TemplatePreviewState.md

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

data/docs/TemplateSummary.md

@@ -8,37 +8,14 @@
 | **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. It can't be changed after the template is created. |  |
-| **ready** | **Boolean** | Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once its document has been processed (`document.state` is `processed`). |  |
-| **document** | [**TemplateDocument**](TemplateDocument.md) | The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet. |  |
+| **ready** | **Boolean** | Whether the template can generate PDFs. 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. |  |
+| **document** | [**TemplateDocumentSummary**](TemplateDocumentSummary.md) | The PDF of a PDF template: its file name, page count and processing state. Null for HTML templates, and for a PDF template that has no PDF yet. |  |
 | **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. |  |
-| **version** | **String** | The published version this is, such as `1.2.0`. Null for the draft. |  |
 | **latest_version** | **String** | The template's latest published version. Null if no version has been published. |  |
 | **version_published_at** | **Time** | When this version was published. Null for the draft. |  |
 | **locked** | **Boolean** | A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed). |  |
-| **add_signature_request_submission_id_footers** | **Boolean** | Print the submission ID in the footer of each page of PDFs signed through signature requests. |  |
-| **ai_field_naming_language** | [**AiFieldNamingLanguage**](AiFieldNamingLanguage.md) | The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. New templates take it from your account's template settings. Null for HTML templates. |  |
-| **allow_additional_properties** | **Boolean** | Accept submission data with properties that aren't fields of the template. |  |
-| **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). HTML templates have no visual form, so `web` is the only value they accept. |  |
-| **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 where the template's signature requests, forms and embedded template editor can be loaded: 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). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site. |  |
-| **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. |  |
-| **encrypt_pdfs** | **Boolean** | Encrypt generated PDFs with `encrypt_pdfs_password`. |  |
-| **has_encrypt_pdfs_password** | **Boolean** | Whether `encrypt_pdfs_password` is set. |  |
-| **expire_submissions** | **Boolean** | Delete each submission's data and PDF after `expire_after` `expiration_interval`. |  |
-| **expire_after** | **Integer** | How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` is on. At most 5256000 (10 years in minutes). |  |
-| **expiration_interval** | [**ExpirationInterval**](ExpirationInterval.md) | The unit of `expire_after`. |  |
-| **merge_audit_trail_pdf** | **Boolean** | Add the audit trail to the end of PDFs signed through signature requests. |  |
-| **parse_dates_using_template_date_format** | **Boolean** | Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way. |  |
-| **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. |  |
-| **has_slack_webhook_url** | **Boolean** | Whether `slack_webhook_url` is set. |  |
 | **last_changed_at** | **Time** | When the draft was last changed. |  |
-| **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. |  |
 | **created_at** | **Time** | When the template was created. |  |
 | **updated_at** | **Time** | When the template was last updated. |  |
 
@@ -56,33 +33,10 @@ instance = DocSpring::TemplateSummary.new(
   document: null,
   parent_folder_id: null,
   path: null,
-  version: null,
   latest_version: null,
   version_published_at: null,
   locked: null,
-  add_signature_request_submission_id_footers: null,
-  ai_field_naming_language: null,
-  allow_additional_properties: null,
-  allow_skipping_optional_fields: null,
-  default_form_mode: null,
-  editable_submissions: null,
-  embed_domains: null,
-  embed_edit_allow_settings: null,
-  embed_edit_allow_versioning: null,
-  embed_edit_allow_document_replacement: null,
-  encrypt_pdfs: null,
-  has_encrypt_pdfs_password: null,
-  expire_submissions: null,
-  expire_after: null,
-  expiration_interval: null,
-  merge_audit_trail_pdf: null,
-  parse_dates_using_template_date_format: null,
-  public_submissions: null,
-  public_web_form: null,
-  redirect_url: null,
-  has_slack_webhook_url: null,
   last_changed_at: null,
-  last_changed_by: null,
   created_at: null,
   updated_at: null
 )

data/docs/UpdateTemplateDocumentRequest.md

@@ -4,8 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **cache_id** | **String** | The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign). |  |
-| **filename** | **String** | The PDF's file name, for a `cache_id` (presigned uploads don't send one). | [optional] |
+| **cache_id** | **String** | The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign). | [optional] |
+| **document_url** | **String** | An https:// link to the template's PDF (up to 100 MB), instead of `cache_id`. DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then (sync.api hosts wait for it). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why. | [optional] |
+| **document_base64** | **String** | The template's PDF, encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`. | [optional] |
+| **filename** | **String** | The PDF's file name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it. | [optional] |
 | **reimport_fields** | **Boolean** | Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. | [optional] |
 
 ## Example
@@ -15,6 +17,8 @@ require 'docspring'
 
 instance = DocSpring::UpdateTemplateDocumentRequest.new(
   cache_id: null,
+  document_url: null,
+  document_base64: null,
   filename: null,
   reimport_fields: null
 )

data/docs/UpdateTemplateFieldsRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::UpdateTemplateFieldsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fields** | [**Array<FieldInput>**](FieldInput.md) | The changes, each with the `id` of the field it changes. Settings left out keep their values. Changing a shared setting changes it for every field with the same name. Renaming a field moves it to the shared settings of its new name, and conditional logic and formulas that use the old name follow it when no other field has that name. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::UpdateTemplateFieldsRequest.new(
+  fields: null
+)
+```
+

data/docs/UpdateTemplateRequest.md

@@ -14,7 +14,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. | [optional] |
 | **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). HTML templates have no visual form, so `web` is the only value they accept. | [optional] |
 | **editable_submissions** | **Boolean** | Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it. | [optional] |
-| **embed_domains** | **Array<String>** | The sites where the template's signature requests, forms and embedded template editor can be loaded: 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). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site. | [optional] |
+| **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. | [optional] |
 | **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). | [optional] |
 | **embed_edit_allow_versioning** | **Boolean** | Allow the embedded template editor to publish, restore, compare and delete published versions. | [optional] |
 | **embed_edit_allow_document_replacement** | **Boolean** | Allow the embedded template editor to replace the template's PDF. | [optional] |
@@ -31,11 +31,15 @@
 | **slack_webhook_url** | **String** | A Slack incoming webhook URL that is notified about the template's submissions. It's never returned; `has_slack_webhook_url` says if it's set. | [optional] |
 | **defaults** | [**TemplateDefaultsInput**](TemplateDefaultsInput.md) | The default style of the template's fields. Setting it replaces the whole object. | [optional] |
 | **field_dependencies** | [**Array<TemplateFieldDependencyInput>**](TemplateFieldDependencyInput.md) | The template's conditional logic rules. Setting them replaces all of the rules. | [optional] |
+| **field_groups** | [**Array<FieldGroupInput>**](FieldGroupInput.md) | Changes to the settings of the template's field groups, each with the `name` of the group it changes. Settings left out keep their values, and groups left out are unchanged. | [optional] |
+| **predefined_fields** | [**Array<PredefinedFieldInput>**](PredefinedFieldInput.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. | [optional] |
+| **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. | [optional] |
 | **html** | **String** | The HTML of an HTML template, as a Liquid template. Null for PDF templates. | [optional] |
 | **scss** | **String** | The SCSS of an HTML template. | [optional] |
 | **header_html** | **String** | The HTML printed at the top of each page of an HTML template. | [optional] |
 | **footer_html** | **String** | The HTML printed at the bottom of each page of an HTML template. | [optional] |
 | **html_engine_options** | [**HtmlEngineOptionsInput**](HtmlEngineOptionsInput.md) | Null resets the options to their defaults. | [optional] |
+| **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. | [optional] |
 
 ## Example
 
@@ -70,11 +74,15 @@ instance = DocSpring::UpdateTemplateRequest.new(
   slack_webhook_url: null,
   defaults: null,
   field_dependencies: null,
+  field_groups: null,
+  predefined_fields: null,
+  predefined_fields_sample_data: null,
   html: null,
   scss: null,
   header_html: null,
   footer_html: null,
-  html_engine_options: null
+  html_engine_options: null,
+  html_escape_data: null
 )
 ```