docspring 4.3.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. package/README.md +20 -1
  2. package/dist/ApiClient.js +2 -2
  3. package/dist/RequestSchemas.js +1118 -93
  4. package/dist/RequestValidator.js +4 -0
  5. package/dist/api/Client.js +1360 -206
  6. package/dist/index.js +196 -0
  7. package/dist/model/AddTemplateFieldsRequest.js +3 -3
  8. package/dist/model/AuthenticationCheck.js +1 -1
  9. package/dist/model/CombinedPdf.js +1 -1
  10. package/dist/model/CombinedPdfFiles.js +1 -1
  11. package/dist/model/CombinedPdfList.js +1 -1
  12. package/dist/model/CombinedPdfSource.js +2 -2
  13. package/dist/model/CombinedPdfSourceInput.js +2 -2
  14. package/dist/model/CombinedPdfSourcePdf.js +1 -1
  15. package/dist/model/CopyTemplateRequest.js +1 -1
  16. package/dist/model/CreateAccountEmailActionRequest.js +306 -0
  17. package/dist/model/CreateCombinedPdfRequest.js +1 -1
  18. package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
  19. package/dist/model/CreateEmailActionRequest.js +280 -0
  20. package/dist/model/CreateEmailDomainRequest.js +114 -0
  21. package/dist/model/CreateFolderRequest.js +1 -1
  22. package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
  23. package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
  24. package/dist/model/CreateSubmissionBatchRequest.js +4 -4
  25. package/dist/model/CreateSubmissionRequest.js +112 -4
  26. package/dist/model/CreateTemplatePreviewRequest.js +1 -1
  27. package/dist/model/CreateTemplateRequest.js +103 -8
  28. package/dist/model/CreateWebhookRequest.js +1 -1
  29. package/dist/model/CustomFile.js +1 -1
  30. package/dist/model/CustomFileList.js +1 -1
  31. package/dist/model/CustomFileSourcePdf.js +1 -1
  32. package/dist/model/DnsRecordType.js +64 -0
  33. package/dist/model/EmailAction.js +510 -0
  34. package/dist/model/EmailActionConditions.js +142 -0
  35. package/dist/model/EmailActionConditionsInput.js +142 -0
  36. package/dist/model/EmailActionCustomization.js +222 -0
  37. package/dist/model/EmailActionDelivery.js +59 -0
  38. package/dist/model/EmailActionFileFormats.js +69 -0
  39. package/dist/model/EmailActionList.js +132 -0
  40. package/dist/model/EmailActionSetting.js +119 -0
  41. package/dist/model/EmailActionSubmissionType.js +64 -0
  42. package/dist/model/EmailActionTestEmail.js +116 -0
  43. package/dist/model/EmailDomain.js +245 -0
  44. package/dist/model/EmailDomainDnsRecord.js +155 -0
  45. package/dist/model/EmailDomainDnsRecordPurpose.js +64 -0
  46. package/dist/model/EmailDomainList.js +132 -0
  47. package/dist/model/EmailDomainRecordState.js +64 -0
  48. package/dist/model/EmailDomainState.js +64 -0
  49. package/dist/model/ErrorCode.js +10 -0
  50. package/dist/model/ErrorDetail.js +1 -1
  51. package/dist/model/ErrorInfo.js +46 -7
  52. package/dist/model/ErrorResponse.js +1 -1
  53. package/dist/model/Field.js +3 -3
  54. package/dist/model/FieldComparisonCondition.js +1 -1
  55. package/dist/model/FieldDependency.js +1 -1
  56. package/dist/model/FieldDependencyInput.js +1 -1
  57. package/dist/model/FieldEqualsCondition.js +1 -1
  58. package/dist/model/FieldGroup.js +1 -1
  59. package/dist/model/FieldGroupInput.js +1 -1
  60. package/dist/model/FieldInCondition.js +1 -1
  61. package/dist/model/FieldInput.js +2 -2
  62. package/dist/model/FieldOverride.js +1 -1
  63. package/dist/model/FieldPresenceCondition.js +1 -1
  64. package/dist/model/FieldRangeCondition.js +1 -1
  65. package/dist/model/Folder.js +1 -1
  66. package/dist/model/FolderList.js +1 -1
  67. package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
  68. package/dist/model/GeneratedFile.js +1 -1
  69. package/dist/model/HtmlEngineOptions.js +3 -3
  70. package/dist/model/HtmlEngineOptionsInput.js +2 -2
  71. package/dist/model/MoveFolderRequest.js +1 -1
  72. package/dist/model/MoveTemplateRequest.js +1 -1
  73. package/dist/model/PageImage.js +1 -1
  74. package/dist/model/PageImages.js +1 -1
  75. package/dist/model/PredefinedField.js +1 -1
  76. package/dist/model/PredefinedFieldInput.js +1 -1
  77. package/dist/model/PublishTemplateVersionRequest.js +1 -1
  78. package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
  79. package/dist/model/RenameFolderRequest.js +1 -1
  80. package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
  81. package/dist/model/RestoreTemplateVersionRequest.js +1 -1
  82. package/dist/model/SendAccountEmailActionTestEmailRequest.js +91 -0
  83. package/dist/model/SignatureRequest.js +52 -7
  84. package/dist/model/SignatureRequestEmailAttachments.js +59 -0
  85. package/dist/model/SignatureRequestEmailStatus.js +89 -0
  86. package/dist/model/SignatureRequestEvent.js +1 -1
  87. package/dist/model/SignatureRequestEventType.js +11 -1
  88. package/dist/model/SignatureRequestInput.js +24 -8
  89. package/dist/model/SignatureRequestReminders.js +121 -0
  90. package/dist/model/SignatureRequestToken.js +1 -1
  91. package/dist/model/SigningOrder.js +59 -0
  92. package/dist/model/StringConditionType.js +36 -1
  93. package/dist/model/Submission.js +21 -9
  94. package/dist/model/SubmissionAction.js +27 -12
  95. package/dist/model/SubmissionBatch.js +1 -1
  96. package/dist/model/SubmissionFiles.js +1 -1
  97. package/dist/model/SubmissionInput.js +4 -4
  98. package/dist/model/SubmissionList.js +1 -1
  99. package/dist/model/SubmissionSourcePdf.js +1 -1
  100. package/dist/model/SubmissionSummary.js +3 -3
  101. package/dist/model/SubmissionValidation.js +1 -1
  102. package/dist/model/Template.js +130 -19
  103. package/dist/model/TemplateActor.js +1 -1
  104. package/dist/model/TemplateDefaults.js +1 -1
  105. package/dist/model/TemplateDefaultsInput.js +1 -1
  106. package/dist/model/TemplateDiff.js +1 -1
  107. package/dist/model/TemplateDiffSummary.js +1 -1
  108. package/dist/model/TemplateDocument.js +1 -1
  109. package/dist/model/TemplateDocumentSummary.js +1 -1
  110. package/dist/model/TemplateFieldChange.js +1 -1
  111. package/dist/model/TemplateFieldChanges.js +1 -1
  112. package/dist/model/TemplateFieldDependency.js +1 -1
  113. package/dist/model/TemplateFieldDependencyCondition.js +1 -1
  114. package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
  115. package/dist/model/TemplateFieldDependencyInput.js +1 -1
  116. package/dist/model/TemplateFieldMove.js +1 -1
  117. package/dist/model/TemplateFields.js +1 -1
  118. package/dist/model/TemplateModelCode.js +1 -1
  119. package/dist/model/TemplatePageImages.js +1 -1
  120. package/dist/model/TemplatePageProcessingStatus.js +1 -1
  121. package/dist/model/TemplatePreview.js +1 -1
  122. package/dist/model/TemplateSourcePdf.js +2 -2
  123. package/dist/model/TemplateSummary.js +9 -9
  124. package/dist/model/TemplateSummaryList.js +1 -1
  125. package/dist/model/TemplateType.js +6 -1
  126. package/dist/model/TemplateVersion.js +1 -1
  127. package/dist/model/UpdateAccountEmailActionRequest.js +306 -0
  128. package/dist/model/UpdateEmailActionCustomizationRequest.js +258 -0
  129. package/dist/model/UpdateEmailActionRequest.js +280 -0
  130. package/dist/model/UpdateSignatureRequestRequest.js +1 -1
  131. package/dist/model/UpdateTemplateDocumentRequest.js +2 -2
  132. package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
  133. package/dist/model/UpdateTemplateRequest.js +100 -5
  134. package/dist/model/UpdateWebhookRequest.js +1 -1
  135. package/dist/model/UploadPresign.js +1 -1
  136. package/dist/model/UrlSourcePdf.js +1 -1
  137. package/dist/model/ValidateSubmissionRequest.js +112 -4
  138. package/dist/model/Webhook.js +1 -1
  139. package/dist/model/WebhookEventType.js +10 -0
  140. package/dist/model/WebhookList.js +1 -1
  141. package/package.json +1 -1
@@ -11,6 +11,7 @@ var _FieldGroup = _interopRequireDefault(require("./FieldGroup"));
11
11
  var _HtmlEngineOptions = _interopRequireDefault(require("./HtmlEngineOptions"));
12
12
  var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
13
13
  var _PredefinedField = _interopRequireDefault(require("./PredefinedField"));
14
+ var _SignatureRequestEmailAttachments = _interopRequireDefault(require("./SignatureRequestEmailAttachments"));
14
15
  var _TemplateActor = _interopRequireDefault(require("./TemplateActor"));
15
16
  var _TemplateDefaults = _interopRequireDefault(require("./TemplateDefaults"));
16
17
  var _TemplateDocument = _interopRequireDefault(require("./TemplateDocument"));
@@ -42,7 +43,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
42
43
  /**
43
44
  * The Template model module.
44
45
  * @module model/Template
45
- * @version 4.3.0
46
+ * @version 4.4.0
46
47
  */
47
48
  var Template = /*#__PURE__*/function () {
48
49
  /**
@@ -53,9 +54,9 @@ var Template = /*#__PURE__*/function () {
53
54
  * @param id {String} The template's ID.
54
55
  * @param name {String} The template's name.
55
56
  * @param 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.
56
- * @param template_type {module:model/TemplateType} `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.
57
- * @param output_format {module:model/OutputFormat} 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.
58
- * @param 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).
57
+ * @param template_type {module:model/TemplateType} `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.
58
+ * @param output_format {module:model/OutputFormat} 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.
59
+ * @param 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).
59
60
  * @param document {module:model/TemplateDocument} 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.
60
61
  * @param 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.
61
62
  * @param path {String} The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root.
@@ -72,7 +73,7 @@ var Template = /*#__PURE__*/function () {
72
73
  * @param 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.
73
74
  * @param default_form_mode {module:model/TemplateFormMode} 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`.
74
75
  * @param editable_submissions {Boolean} Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
75
- * @param 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.
76
+ * @param 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.
76
77
  * @param 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).
77
78
  * @param embed_edit_allow_versioning {Boolean} Allow the embedded template editor to publish, restore, compare and delete published versions.
78
79
  * @param embed_edit_allow_document_replacement {Boolean} Allow the embedded template editor to replace the template's PDF.
@@ -86,6 +87,13 @@ var Template = /*#__PURE__*/function () {
86
87
  * @param public_submissions {Boolean} Allow anyone with a submission's ID to download its PDF.
87
88
  * @param public_web_form {Boolean} Allow anyone to fill in the template's web form.
88
89
  * @param redirect_url {String} Where the web form sends people after they submit it.
90
+ * @param signature_request_email_attachments {module:model/SignatureRequestEmailAttachments} 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.
91
+ * @param 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.
92
+ * @param 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.
93
+ * @param 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.
94
+ * @param 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.
95
+ * @param 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.
96
+ * @param 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.
89
97
  * @param has_slack_webhook_url {Boolean} Whether `slack_webhook_url` is set.
90
98
  * @param last_changed_by {module:model/TemplateActor} 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.
91
99
  * @param defaults {module:model/TemplateDefaults}
@@ -93,18 +101,19 @@ var Template = /*#__PURE__*/function () {
93
101
  * @param field_groups {Array.<module:model/FieldGroup>} 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/~`.
94
102
  * @param predefined_fields {Array.<module:model/PredefinedField>} 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.
95
103
  * @param predefined_fields_sample_data {Object.<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.
96
- * @param html {String} The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
104
+ * @param html {String} The HTML of an HTML template, as a Liquid template. Null for other templates.
97
105
  * @param scss {String} The SCSS of an HTML template.
98
106
  * @param header_html {String} The HTML printed at the top of each page of an HTML template.
99
107
  * @param footer_html {String} The HTML printed at the bottom of each page of an HTML template.
100
- * @param html_engine_options {module:model/HtmlEngineOptions} 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.
101
- * @param 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.
108
+ * @param html_engine_options {module:model/HtmlEngineOptions} How an HTML template's PDFs are printed. Null for other templates. Setting it replaces the whole object: options left out use their defaults.
109
+ * @param 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.
110
+ * @param layout {Object.<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.
102
111
  * @param embed_edit_token {String} The token that opens the template in the embedded template editor.
103
112
  * @param versions {Array.<module:model/TemplateVersion>} The template's published versions, newest first (up to 100).
104
113
  */
105
- function Template(id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions) {
114
+ function Template(id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, embed_edit_token, versions) {
106
115
  _classCallCheck(this, Template);
107
- Template.initialize(this, id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions);
116
+ Template.initialize(this, id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, embed_edit_token, versions);
108
117
  }
109
118
 
110
119
  /**
@@ -114,7 +123,7 @@ var Template = /*#__PURE__*/function () {
114
123
  */
115
124
  return _createClass(Template, null, [{
116
125
  key: "initialize",
117
- value: function initialize(obj, id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions) {
126
+ value: function initialize(obj, id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, embed_edit_token, versions) {
118
127
  obj['id'] = id;
119
128
  obj['name'] = name;
120
129
  obj['description'] = description;
@@ -151,6 +160,13 @@ var Template = /*#__PURE__*/function () {
151
160
  obj['public_submissions'] = public_submissions;
152
161
  obj['public_web_form'] = public_web_form;
153
162
  obj['redirect_url'] = redirect_url;
163
+ obj['signature_request_email_attachments'] = signature_request_email_attachments;
164
+ obj['signature_request_from_address'] = signature_request_from_address;
165
+ obj['signature_request_include_signing_token'] = signature_request_include_signing_token;
166
+ obj['signature_request_from_name'] = signature_request_from_name;
167
+ obj['signature_request_notification_emails'] = signature_request_notification_emails;
168
+ obj['signature_request_reply_to'] = signature_request_reply_to;
169
+ obj['signature_request_signing_url'] = signature_request_signing_url;
154
170
  obj['has_slack_webhook_url'] = has_slack_webhook_url;
155
171
  obj['last_changed_by'] = last_changed_by;
156
172
  obj['defaults'] = defaults;
@@ -164,6 +180,7 @@ var Template = /*#__PURE__*/function () {
164
180
  obj['footer_html'] = footer_html;
165
181
  obj['html_engine_options'] = html_engine_options;
166
182
  obj['html_escape_data'] = html_escape_data;
183
+ obj['layout'] = layout;
167
184
  obj['embed_edit_token'] = embed_edit_token;
168
185
  obj['versions'] = versions;
169
186
  }
@@ -289,6 +306,27 @@ var Template = /*#__PURE__*/function () {
289
306
  if (data.hasOwnProperty('redirect_url')) {
290
307
  obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
291
308
  }
309
+ if (data.hasOwnProperty('signature_request_email_attachments')) {
310
+ obj['signature_request_email_attachments'] = _ApiClient["default"].convertToType(data['signature_request_email_attachments'], _SignatureRequestEmailAttachments["default"]);
311
+ }
312
+ if (data.hasOwnProperty('signature_request_from_address')) {
313
+ obj['signature_request_from_address'] = _ApiClient["default"].convertToType(data['signature_request_from_address'], 'String');
314
+ }
315
+ if (data.hasOwnProperty('signature_request_include_signing_token')) {
316
+ obj['signature_request_include_signing_token'] = _ApiClient["default"].convertToType(data['signature_request_include_signing_token'], 'Boolean');
317
+ }
318
+ if (data.hasOwnProperty('signature_request_from_name')) {
319
+ obj['signature_request_from_name'] = _ApiClient["default"].convertToType(data['signature_request_from_name'], 'String');
320
+ }
321
+ if (data.hasOwnProperty('signature_request_notification_emails')) {
322
+ obj['signature_request_notification_emails'] = _ApiClient["default"].convertToType(data['signature_request_notification_emails'], ['String']);
323
+ }
324
+ if (data.hasOwnProperty('signature_request_reply_to')) {
325
+ obj['signature_request_reply_to'] = _ApiClient["default"].convertToType(data['signature_request_reply_to'], 'String');
326
+ }
327
+ if (data.hasOwnProperty('signature_request_signing_url')) {
328
+ obj['signature_request_signing_url'] = _ApiClient["default"].convertToType(data['signature_request_signing_url'], 'String');
329
+ }
292
330
  if (data.hasOwnProperty('has_slack_webhook_url')) {
293
331
  obj['has_slack_webhook_url'] = _ApiClient["default"].convertToType(data['has_slack_webhook_url'], 'Boolean');
294
332
  }
@@ -330,6 +368,11 @@ var Template = /*#__PURE__*/function () {
330
368
  if (data.hasOwnProperty('html_escape_data')) {
331
369
  obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
332
370
  }
371
+ if (data.hasOwnProperty('layout')) {
372
+ obj['layout'] = _ApiClient["default"].convertToType(data['layout'], {
373
+ 'String': Object
374
+ });
375
+ }
333
376
  if (data.hasOwnProperty('embed_edit_token')) {
334
377
  obj['embed_edit_token'] = _ApiClient["default"].convertToType(data['embed_edit_token'], 'String');
335
378
  }
@@ -404,6 +447,26 @@ var Template = /*#__PURE__*/function () {
404
447
  if (data['redirect_url'] && !(typeof data['redirect_url'] === 'string' || data['redirect_url'] instanceof String)) {
405
448
  throw new Error("Expected the field `redirect_url` to be a primitive type in the JSON string but got " + data['redirect_url']);
406
449
  }
450
+ // ensure the json data is a string
451
+ if (data['signature_request_from_address'] && !(typeof data['signature_request_from_address'] === 'string' || data['signature_request_from_address'] instanceof String)) {
452
+ throw new Error("Expected the field `signature_request_from_address` to be a primitive type in the JSON string but got " + data['signature_request_from_address']);
453
+ }
454
+ // ensure the json data is a string
455
+ if (data['signature_request_from_name'] && !(typeof data['signature_request_from_name'] === 'string' || data['signature_request_from_name'] instanceof String)) {
456
+ throw new Error("Expected the field `signature_request_from_name` to be a primitive type in the JSON string but got " + data['signature_request_from_name']);
457
+ }
458
+ // ensure the json data is an array
459
+ if (!Array.isArray(data['signature_request_notification_emails'])) {
460
+ throw new Error("Expected the field `signature_request_notification_emails` to be an array in the JSON data but got " + data['signature_request_notification_emails']);
461
+ }
462
+ // ensure the json data is a string
463
+ if (data['signature_request_reply_to'] && !(typeof data['signature_request_reply_to'] === 'string' || data['signature_request_reply_to'] instanceof String)) {
464
+ throw new Error("Expected the field `signature_request_reply_to` to be a primitive type in the JSON string but got " + data['signature_request_reply_to']);
465
+ }
466
+ // ensure the json data is a string
467
+ if (data['signature_request_signing_url'] && !(typeof data['signature_request_signing_url'] === 'string' || data['signature_request_signing_url'] instanceof String)) {
468
+ throw new Error("Expected the field `signature_request_signing_url` to be a primitive type in the JSON string but got " + data['signature_request_signing_url']);
469
+ }
407
470
  // validate the optional field `last_changed_by`
408
471
  if (data['last_changed_by']) {
409
472
  // data not null
@@ -471,7 +534,7 @@ var Template = /*#__PURE__*/function () {
471
534
  }
472
535
  }]);
473
536
  }();
474
- Template.RequiredProperties = ["id", "name", "description", "template_type", "output_format", "ready", "document", "parent_folder_id", "path", "latest_version", "version_published_at", "locked", "last_changed_at", "created_at", "updated_at", "version", "add_signature_request_submission_id_footers", "ai_field_naming_language", "allow_additional_properties", "allow_skipping_optional_fields", "default_form_mode", "editable_submissions", "embed_domains", "embed_edit_allow_settings", "embed_edit_allow_versioning", "embed_edit_allow_document_replacement", "encrypt_pdfs", "has_encrypt_pdfs_password", "expire_submissions", "expire_after", "expiration_interval", "merge_audit_trail_pdf", "parse_dates_using_template_date_format", "public_submissions", "public_web_form", "redirect_url", "has_slack_webhook_url", "last_changed_by", "defaults", "field_dependencies", "field_groups", "predefined_fields", "predefined_fields_sample_data", "html", "scss", "header_html", "footer_html", "html_engine_options", "html_escape_data", "embed_edit_token", "versions"];
537
+ Template.RequiredProperties = ["id", "name", "description", "template_type", "output_format", "ready", "document", "parent_folder_id", "path", "latest_version", "version_published_at", "locked", "last_changed_at", "created_at", "updated_at", "version", "add_signature_request_submission_id_footers", "ai_field_naming_language", "allow_additional_properties", "allow_skipping_optional_fields", "default_form_mode", "editable_submissions", "embed_domains", "embed_edit_allow_settings", "embed_edit_allow_versioning", "embed_edit_allow_document_replacement", "encrypt_pdfs", "has_encrypt_pdfs_password", "expire_submissions", "expire_after", "expiration_interval", "merge_audit_trail_pdf", "parse_dates_using_template_date_format", "public_submissions", "public_web_form", "redirect_url", "signature_request_email_attachments", "signature_request_from_address", "signature_request_include_signing_token", "signature_request_from_name", "signature_request_notification_emails", "signature_request_reply_to", "signature_request_signing_url", "has_slack_webhook_url", "last_changed_by", "defaults", "field_dependencies", "field_groups", "predefined_fields", "predefined_fields_sample_data", "html", "scss", "header_html", "footer_html", "html_engine_options", "html_escape_data", "layout", "embed_edit_token", "versions"];
475
538
 
476
539
  /**
477
540
  * The template's ID.
@@ -492,19 +555,19 @@ Template.prototype['name'] = undefined;
492
555
  Template.prototype['description'] = undefined;
493
556
 
494
557
  /**
495
- * `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.
558
+ * `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.
496
559
  * @member {module:model/TemplateType} template_type
497
560
  */
498
561
  Template.prototype['template_type'] = undefined;
499
562
 
500
563
  /**
501
- * 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.
564
+ * 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.
502
565
  * @member {module:model/OutputFormat} output_format
503
566
  */
504
567
  Template.prototype['output_format'] = undefined;
505
568
 
506
569
  /**
507
- * 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).
570
+ * 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).
508
571
  * @member {Boolean} ready
509
572
  */
510
573
  Template.prototype['ready'] = undefined;
@@ -606,7 +669,7 @@ Template.prototype['default_form_mode'] = undefined;
606
669
  Template.prototype['editable_submissions'] = undefined;
607
670
 
608
671
  /**
609
- * 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.
672
+ * 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.
610
673
  * @member {Array.<String>} embed_domains
611
674
  */
612
675
  Template.prototype['embed_domains'] = undefined;
@@ -689,6 +752,48 @@ Template.prototype['public_web_form'] = undefined;
689
752
  */
690
753
  Template.prototype['redirect_url'] = undefined;
691
754
 
755
+ /**
756
+ * 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.
757
+ * @member {module:model/SignatureRequestEmailAttachments} signature_request_email_attachments
758
+ */
759
+ Template.prototype['signature_request_email_attachments'] = undefined;
760
+
761
+ /**
762
+ * 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.
763
+ * @member {String} signature_request_from_address
764
+ */
765
+ Template.prototype['signature_request_from_address'] = undefined;
766
+
767
+ /**
768
+ * 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.
769
+ * @member {Boolean} signature_request_include_signing_token
770
+ */
771
+ Template.prototype['signature_request_include_signing_token'] = undefined;
772
+
773
+ /**
774
+ * 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.
775
+ * @member {String} signature_request_from_name
776
+ */
777
+ Template.prototype['signature_request_from_name'] = undefined;
778
+
779
+ /**
780
+ * 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.
781
+ * @member {Array.<String>} signature_request_notification_emails
782
+ */
783
+ Template.prototype['signature_request_notification_emails'] = undefined;
784
+
785
+ /**
786
+ * 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.
787
+ * @member {String} signature_request_reply_to
788
+ */
789
+ Template.prototype['signature_request_reply_to'] = undefined;
790
+
791
+ /**
792
+ * 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.
793
+ * @member {String} signature_request_signing_url
794
+ */
795
+ Template.prototype['signature_request_signing_url'] = undefined;
796
+
692
797
  /**
693
798
  * Whether `slack_webhook_url` is set.
694
799
  * @member {Boolean} has_slack_webhook_url
@@ -731,7 +836,7 @@ Template.prototype['predefined_fields'] = undefined;
731
836
  Template.prototype['predefined_fields_sample_data'] = undefined;
732
837
 
733
838
  /**
734
- * The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
839
+ * The HTML of an HTML template, as a Liquid template. Null for other templates.
735
840
  * @member {String} html
736
841
  */
737
842
  Template.prototype['html'] = undefined;
@@ -755,17 +860,23 @@ Template.prototype['header_html'] = undefined;
755
860
  Template.prototype['footer_html'] = undefined;
756
861
 
757
862
  /**
758
- * 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.
863
+ * How an HTML template's PDFs are printed. Null for other templates. Setting it replaces the whole object: options left out use their defaults.
759
864
  * @member {module:model/HtmlEngineOptions} html_engine_options
760
865
  */
761
866
  Template.prototype['html_engine_options'] = undefined;
762
867
 
763
868
  /**
764
- * 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.
869
+ * 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.
765
870
  * @member {Boolean} html_escape_data
766
871
  */
767
872
  Template.prototype['html_escape_data'] = undefined;
768
873
 
874
+ /**
875
+ * 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.
876
+ * @member {Object.<String, Object>} layout
877
+ */
878
+ Template.prototype['layout'] = undefined;
879
+
769
880
  /**
770
881
  * The token that opens the template in the embedded template editor.
771
882
  * @member {String} embed_edit_token
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateActor model module.
32
32
  * @module model/TemplateActor
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplateActor = /*#__PURE__*/function () {
36
36
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplateDefaults model module.
31
31
  * @module model/TemplateDefaults
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var TemplateDefaults = /*#__PURE__*/function () {
35
35
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplateDefaultsInput model module.
31
31
  * @module model/TemplateDefaultsInput
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var TemplateDefaultsInput = /*#__PURE__*/function () {
35
35
  /**
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The TemplateDiff model module.
33
33
  * @module model/TemplateDiff
34
- * @version 4.3.0
34
+ * @version 4.4.0
35
35
  */
36
36
  var TemplateDiff = /*#__PURE__*/function () {
37
37
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplateDiffSummary model module.
31
31
  * @module model/TemplateDiffSummary
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var TemplateDiffSummary = /*#__PURE__*/function () {
35
35
  /**
@@ -33,7 +33,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
33
33
  /**
34
34
  * The TemplateDocument model module.
35
35
  * @module model/TemplateDocument
36
- * @version 4.3.0
36
+ * @version 4.4.0
37
37
  */
38
38
  var TemplateDocument = /*#__PURE__*/function () {
39
39
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateDocumentSummary model module.
32
32
  * @module model/TemplateDocumentSummary
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplateDocumentSummary = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateFieldChange model module.
32
32
  * @module model/TemplateFieldChange
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplateFieldChange = /*#__PURE__*/function () {
36
36
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateFieldChanges model module.
34
34
  * @module model/TemplateFieldChanges
35
- * @version 4.3.0
35
+ * @version 4.4.0
36
36
  */
37
37
  var TemplateFieldChanges = /*#__PURE__*/function () {
38
38
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateFieldDependency model module.
34
34
  * @module model/TemplateFieldDependency
35
- * @version 4.3.0
35
+ * @version 4.4.0
36
36
  */
37
37
  var TemplateFieldDependency = /*#__PURE__*/function () {
38
38
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateFieldDependencyCondition model module.
32
32
  * @module model/TemplateFieldDependencyCondition
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplateFieldDependencyCondition = /*#__PURE__*/function () {
36
36
  /**
@@ -33,7 +33,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
33
33
  /**
34
34
  * The TemplateFieldDependencyConditionInput model module.
35
35
  * @module model/TemplateFieldDependencyConditionInput
36
- * @version 4.3.0
36
+ * @version 4.4.0
37
37
  */
38
38
  var TemplateFieldDependencyConditionInput = /*#__PURE__*/function () {
39
39
  /**
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateFieldDependencyInput model module.
34
34
  * @module model/TemplateFieldDependencyInput
35
- * @version 4.3.0
35
+ * @version 4.4.0
36
36
  */
37
37
  var TemplateFieldDependencyInput = /*#__PURE__*/function () {
38
38
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplateFieldMove model module.
31
31
  * @module model/TemplateFieldMove
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var TemplateFieldMove = /*#__PURE__*/function () {
35
35
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateFields model module.
32
32
  * @module model/TemplateFields
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplateFields = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateModelCode model module.
32
32
  * @module model/TemplateModelCode
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplateModelCode = /*#__PURE__*/function () {
36
36
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplatePageImages model module.
32
32
  * @module model/TemplatePageImages
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplatePageImages = /*#__PURE__*/function () {
36
36
  /**
@@ -33,7 +33,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
33
33
  /**
34
34
  * The TemplatePageProcessingStatus model module.
35
35
  * @module model/TemplatePageProcessingStatus
36
- * @version 4.3.0
36
+ * @version 4.4.0
37
37
  */
38
38
  var TemplatePageProcessingStatus = /*#__PURE__*/function () {
39
39
  /**
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
31
31
  /**
32
32
  * The TemplatePreview model module.
33
33
  * @module model/TemplatePreview
34
- * @version 4.3.0
34
+ * @version 4.4.0
35
35
  */
36
36
  var TemplatePreview = /*#__PURE__*/function () {
37
37
  /**
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The TemplateSourcePdf model module.
31
31
  * @module model/TemplateSourcePdf
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var TemplateSourcePdf = /*#__PURE__*/function () {
35
35
  /**
@@ -139,7 +139,7 @@ TemplateSourcePdf.prototype['type'] = 'template';
139
139
  TemplateSourcePdf.prototype['id'] = undefined;
140
140
 
141
141
  /**
142
- * 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).
142
+ * 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`.
143
143
  * @member {String} template_version
144
144
  */
145
145
  TemplateSourcePdf.prototype['template_version'] = undefined;
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
32
32
  /**
33
33
  * The TemplateSummary model module.
34
34
  * @module model/TemplateSummary
35
- * @version 4.3.0
35
+ * @version 4.4.0
36
36
  */
37
37
  var TemplateSummary = /*#__PURE__*/function () {
38
38
  /**
@@ -43,10 +43,10 @@ var TemplateSummary = /*#__PURE__*/function () {
43
43
  * @param id {String} The template's ID.
44
44
  * @param name {String} The template's name.
45
45
  * @param 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.
46
- * @param template_type {module:model/TemplateType} `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.
47
- * @param output_format {module:model/OutputFormat} 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.
48
- * @param 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).
49
- * @param document {module:model/TemplateDocumentSummary} 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.
46
+ * @param template_type {module:model/TemplateType} `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.
47
+ * @param output_format {module:model/OutputFormat} 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.
48
+ * @param 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).
49
+ * @param document {module:model/TemplateDocumentSummary} 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.
50
50
  * @param 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.
51
51
  * @param path {String} The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root.
52
52
  * @param latest_version {String} The template's latest published version. Null if no version has been published.
@@ -225,25 +225,25 @@ TemplateSummary.prototype['name'] = undefined;
225
225
  TemplateSummary.prototype['description'] = undefined;
226
226
 
227
227
  /**
228
- * `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.
228
+ * `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.
229
229
  * @member {module:model/TemplateType} template_type
230
230
  */
231
231
  TemplateSummary.prototype['template_type'] = undefined;
232
232
 
233
233
  /**
234
- * 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.
234
+ * 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.
235
235
  * @member {module:model/OutputFormat} output_format
236
236
  */
237
237
  TemplateSummary.prototype['output_format'] = undefined;
238
238
 
239
239
  /**
240
- * 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).
240
+ * 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).
241
241
  * @member {Boolean} ready
242
242
  */
243
243
  TemplateSummary.prototype['ready'] = undefined;
244
244
 
245
245
  /**
246
- * 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.
246
+ * 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.
247
247
  * @member {module:model/TemplateDocumentSummary} document
248
248
  */
249
249
  TemplateSummary.prototype['document'] = undefined;
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The TemplateSummaryList model module.
32
32
  * @module model/TemplateSummaryList
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var TemplateSummaryList = /*#__PURE__*/function () {
36
36
  /**