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
@@ -0,0 +1,280 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _EmailActionConditionsInput = _interopRequireDefault(require("./EmailActionConditionsInput"));
9
+ var _EmailActionDelivery = _interopRequireDefault(require("./EmailActionDelivery"));
10
+ var _EmailActionFileFormats = _interopRequireDefault(require("./EmailActionFileFormats"));
11
+ var _EmailActionSubmissionType = _interopRequireDefault(require("./EmailActionSubmissionType"));
12
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
13
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
14
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
15
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
16
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
17
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
19
+ * DocSpring API
20
+ * Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
21
+ *
22
+ * The version of the OpenAPI document: v2
23
+ *
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * The UpdateEmailActionRequest model module.
32
+ * @module model/UpdateEmailActionRequest
33
+ * @version 4.4.0
34
+ */
35
+ var UpdateEmailActionRequest = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>UpdateEmailActionRequest</code>.
38
+ * The settings to change. Properties left out keep their values.
39
+ * @alias module:model/UpdateEmailActionRequest
40
+ */
41
+ function UpdateEmailActionRequest() {
42
+ _classCallCheck(this, UpdateEmailActionRequest);
43
+ UpdateEmailActionRequest.initialize(this);
44
+ }
45
+
46
+ /**
47
+ * Initializes the fields of this object.
48
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
49
+ * Only for internal use.
50
+ */
51
+ return _createClass(UpdateEmailActionRequest, null, [{
52
+ key: "initialize",
53
+ value: function initialize(obj) {}
54
+
55
+ /**
56
+ * Constructs a <code>UpdateEmailActionRequest</code> from a plain JavaScript object, optionally creating a new instance.
57
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
58
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
59
+ * @param {module:model/UpdateEmailActionRequest} obj Optional instance to populate.
60
+ * @return {module:model/UpdateEmailActionRequest} The populated <code>UpdateEmailActionRequest</code> instance.
61
+ */
62
+ }, {
63
+ key: "constructFromObject",
64
+ value: function constructFromObject(data, obj) {
65
+ if (data) {
66
+ obj = obj || new UpdateEmailActionRequest();
67
+ if (data.hasOwnProperty('name')) {
68
+ obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
69
+ }
70
+ if (data.hasOwnProperty('enabled')) {
71
+ obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
72
+ }
73
+ if (data.hasOwnProperty('to')) {
74
+ obj['to'] = _ApiClient["default"].convertToType(data['to'], ['String']);
75
+ }
76
+ if (data.hasOwnProperty('cc')) {
77
+ obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
78
+ }
79
+ if (data.hasOwnProperty('bcc')) {
80
+ obj['bcc'] = _ApiClient["default"].convertToType(data['bcc'], ['String']);
81
+ }
82
+ if (data.hasOwnProperty('from_name')) {
83
+ obj['from_name'] = _ApiClient["default"].convertToType(data['from_name'], 'String');
84
+ }
85
+ if (data.hasOwnProperty('from_address')) {
86
+ obj['from_address'] = _ApiClient["default"].convertToType(data['from_address'], 'String');
87
+ }
88
+ if (data.hasOwnProperty('reply_to')) {
89
+ obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
90
+ }
91
+ if (data.hasOwnProperty('subject')) {
92
+ obj['subject'] = _ApiClient["default"].convertToType(data['subject'], 'String');
93
+ }
94
+ if (data.hasOwnProperty('message')) {
95
+ obj['message'] = _ApiClient["default"].convertToType(data['message'], 'String');
96
+ }
97
+ if (data.hasOwnProperty('file_name')) {
98
+ obj['file_name'] = _ApiClient["default"].convertToType(data['file_name'], 'String');
99
+ }
100
+ if (data.hasOwnProperty('file_formats')) {
101
+ obj['file_formats'] = _ApiClient["default"].convertToType(data['file_formats'], _EmailActionFileFormats["default"]);
102
+ }
103
+ if (data.hasOwnProperty('delivery')) {
104
+ obj['delivery'] = _ApiClient["default"].convertToType(data['delivery'], _EmailActionDelivery["default"]);
105
+ }
106
+ if (data.hasOwnProperty('max_attachment_mb')) {
107
+ obj['max_attachment_mb'] = _ApiClient["default"].convertToType(data['max_attachment_mb'], 'Number');
108
+ }
109
+ if (data.hasOwnProperty('submission_type')) {
110
+ obj['submission_type'] = _ApiClient["default"].convertToType(data['submission_type'], _EmailActionSubmissionType["default"]);
111
+ }
112
+ if (data.hasOwnProperty('send_when')) {
113
+ obj['send_when'] = _ApiClient["default"].convertToType(data['send_when'], _EmailActionConditionsInput["default"]);
114
+ }
115
+ if (data.hasOwnProperty('failure_notifications_enabled')) {
116
+ obj['failure_notifications_enabled'] = _ApiClient["default"].convertToType(data['failure_notifications_enabled'], 'Boolean');
117
+ }
118
+ }
119
+ return obj;
120
+ }
121
+
122
+ /**
123
+ * Validates the JSON data with respect to <code>UpdateEmailActionRequest</code>.
124
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
125
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateEmailActionRequest</code>.
126
+ */
127
+ }, {
128
+ key: "validateJSON",
129
+ value: function validateJSON(data) {
130
+ // ensure the json data is a string
131
+ if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
132
+ throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
133
+ }
134
+ // ensure the json data is an array
135
+ if (!Array.isArray(data['to'])) {
136
+ throw new Error("Expected the field `to` to be an array in the JSON data but got " + data['to']);
137
+ }
138
+ // ensure the json data is an array
139
+ if (!Array.isArray(data['cc'])) {
140
+ throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
141
+ }
142
+ // ensure the json data is an array
143
+ if (!Array.isArray(data['bcc'])) {
144
+ throw new Error("Expected the field `bcc` to be an array in the JSON data but got " + data['bcc']);
145
+ }
146
+ // ensure the json data is a string
147
+ if (data['from_name'] && !(typeof data['from_name'] === 'string' || data['from_name'] instanceof String)) {
148
+ throw new Error("Expected the field `from_name` to be a primitive type in the JSON string but got " + data['from_name']);
149
+ }
150
+ // ensure the json data is a string
151
+ if (data['from_address'] && !(typeof data['from_address'] === 'string' || data['from_address'] instanceof String)) {
152
+ throw new Error("Expected the field `from_address` to be a primitive type in the JSON string but got " + data['from_address']);
153
+ }
154
+ // ensure the json data is a string
155
+ if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
156
+ throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
157
+ }
158
+ // ensure the json data is a string
159
+ if (data['subject'] && !(typeof data['subject'] === 'string' || data['subject'] instanceof String)) {
160
+ throw new Error("Expected the field `subject` to be a primitive type in the JSON string but got " + data['subject']);
161
+ }
162
+ // ensure the json data is a string
163
+ if (data['message'] && !(typeof data['message'] === 'string' || data['message'] instanceof String)) {
164
+ throw new Error("Expected the field `message` to be a primitive type in the JSON string but got " + data['message']);
165
+ }
166
+ // ensure the json data is a string
167
+ if (data['file_name'] && !(typeof data['file_name'] === 'string' || data['file_name'] instanceof String)) {
168
+ throw new Error("Expected the field `file_name` to be a primitive type in the JSON string but got " + data['file_name']);
169
+ }
170
+ // validate the optional field `send_when`
171
+ if (data['send_when']) {
172
+ // data not null
173
+ _EmailActionConditionsInput["default"].validateJSON(data['send_when']);
174
+ }
175
+ return true;
176
+ }
177
+ }]);
178
+ }();
179
+ /**
180
+ * A name for the email action, shown in the dashboard. Null shows its recipients instead.
181
+ * @member {String} name
182
+ */
183
+ UpdateEmailActionRequest.prototype['name'] = undefined;
184
+
185
+ /**
186
+ * Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam.
187
+ * @member {Boolean} enabled
188
+ */
189
+ UpdateEmailActionRequest.prototype['enabled'] = undefined;
190
+
191
+ /**
192
+ * Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them.
193
+ * @member {Array.<String>} to
194
+ */
195
+ UpdateEmailActionRequest.prototype['to'] = undefined;
196
+
197
+ /**
198
+ * Who is copied on each email, as in `to` (but not `{{ signer.email }}`).
199
+ * @member {Array.<String>} cc
200
+ */
201
+ UpdateEmailActionRequest.prototype['cc'] = undefined;
202
+
203
+ /**
204
+ * Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).
205
+ * @member {Array.<String>} bcc
206
+ */
207
+ UpdateEmailActionRequest.prototype['bcc'] = undefined;
208
+
209
+ /**
210
+ * The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring".
211
+ * @member {String} from_name
212
+ */
213
+ UpdateEmailActionRequest.prototype['from_name'] = undefined;
214
+
215
+ /**
216
+ * The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address.
217
+ * @member {String} from_address
218
+ */
219
+ UpdateEmailActionRequest.prototype['from_address'] = undefined;
220
+
221
+ /**
222
+ * Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address.
223
+ * @member {String} reply_to
224
+ */
225
+ UpdateEmailActionRequest.prototype['reply_to'] = undefined;
226
+
227
+ /**
228
+ * The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.<field name>` (`data["field name"]` for a name with spaces) and its metadata as `metadata.<key>`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several.
229
+ * @member {String} subject
230
+ */
231
+ UpdateEmailActionRequest.prototype['subject'] = undefined;
232
+
233
+ /**
234
+ * The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download.
235
+ * @member {String} message
236
+ */
237
+ UpdateEmailActionRequest.prototype['message'] = undefined;
238
+
239
+ /**
240
+ * The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID.
241
+ * @member {String} file_name
242
+ */
243
+ UpdateEmailActionRequest.prototype['file_name'] = undefined;
244
+
245
+ /**
246
+ * Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
247
+ * @member {module:model/EmailActionFileFormats} file_formats
248
+ */
249
+ UpdateEmailActionRequest.prototype['file_formats'] = undefined;
250
+
251
+ /**
252
+ * `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
253
+ * @member {module:model/EmailActionDelivery} delivery
254
+ */
255
+ UpdateEmailActionRequest.prototype['delivery'] = undefined;
256
+
257
+ /**
258
+ * With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
259
+ * @member {Number} max_attachment_mb
260
+ */
261
+ UpdateEmailActionRequest.prototype['max_attachment_mb'] = undefined;
262
+
263
+ /**
264
+ * Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient.
265
+ * @member {module:model/EmailActionSubmissionType} submission_type
266
+ */
267
+ UpdateEmailActionRequest.prototype['submission_type'] = undefined;
268
+
269
+ /**
270
+ * Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission.
271
+ * @member {module:model/EmailActionConditionsInput} send_when
272
+ */
273
+ UpdateEmailActionRequest.prototype['send_when'] = undefined;
274
+
275
+ /**
276
+ * Whether the account's owner gets an email when the email action's emails keep failing.
277
+ * @member {Boolean} failure_notifications_enabled
278
+ */
279
+ UpdateEmailActionRequest.prototype['failure_notifications_enabled'] = undefined;
280
+ var _default = exports["default"] = UpdateEmailActionRequest;
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
28
28
  /**
29
29
  * The UpdateSignatureRequestRequest model module.
30
30
  * @module model/UpdateSignatureRequestRequest
31
- * @version 4.3.0
31
+ * @version 4.4.0
32
32
  */
33
33
  var UpdateSignatureRequestRequest = /*#__PURE__*/function () {
34
34
  /**
@@ -26,7 +26,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
26
26
  /**
27
27
  * The UpdateTemplateDocumentRequest model module.
28
28
  * @module model/UpdateTemplateDocumentRequest
29
- * @version 4.3.0
29
+ * @version 4.4.0
30
30
  */
31
31
  var UpdateTemplateDocumentRequest = /*#__PURE__*/function () {
32
32
  /**
@@ -120,7 +120,7 @@ UpdateTemplateDocumentRequest.prototype['cache_id'] = undefined;
120
120
  UpdateTemplateDocumentRequest.prototype['document_url'] = undefined;
121
121
 
122
122
  /**
123
- * The template's document (a PDF, or a Word template's Word document), 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`.
123
+ * The template's document (a PDF, or a Word template's Word document), encoded as base64 (a `data:` URI works too), instead of `cache_id`. Line breaks and spaces in it are ignored. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
124
124
  * @member {String} document_base64
125
125
  */
126
126
  UpdateTemplateDocumentRequest.prototype['document_base64'] = undefined;
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The UpdateTemplateFieldsRequest model module.
32
32
  * @module model/UpdateTemplateFieldsRequest
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var UpdateTemplateFieldsRequest = /*#__PURE__*/function () {
36
36
  /**
@@ -11,6 +11,7 @@ var _FieldGroupInput = _interopRequireDefault(require("./FieldGroupInput"));
11
11
  var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
12
12
  var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
13
13
  var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
14
+ var _SignatureRequestEmailAttachments = _interopRequireDefault(require("./SignatureRequestEmailAttachments"));
14
15
  var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
15
16
  var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
16
17
  var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
@@ -38,7 +39,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
38
39
  /**
39
40
  * The UpdateTemplateRequest model module.
40
41
  * @module model/UpdateTemplateRequest
41
- * @version 4.3.0
42
+ * @version 4.4.0
42
43
  */
43
44
  var UpdateTemplateRequest = /*#__PURE__*/function () {
44
45
  /**
@@ -147,6 +148,27 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
147
148
  if (data.hasOwnProperty('redirect_url')) {
148
149
  obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
149
150
  }
151
+ if (data.hasOwnProperty('signature_request_email_attachments')) {
152
+ obj['signature_request_email_attachments'] = _ApiClient["default"].convertToType(data['signature_request_email_attachments'], _SignatureRequestEmailAttachments["default"]);
153
+ }
154
+ if (data.hasOwnProperty('signature_request_from_address')) {
155
+ obj['signature_request_from_address'] = _ApiClient["default"].convertToType(data['signature_request_from_address'], 'String');
156
+ }
157
+ if (data.hasOwnProperty('signature_request_include_signing_token')) {
158
+ obj['signature_request_include_signing_token'] = _ApiClient["default"].convertToType(data['signature_request_include_signing_token'], 'Boolean');
159
+ }
160
+ if (data.hasOwnProperty('signature_request_from_name')) {
161
+ obj['signature_request_from_name'] = _ApiClient["default"].convertToType(data['signature_request_from_name'], 'String');
162
+ }
163
+ if (data.hasOwnProperty('signature_request_notification_emails')) {
164
+ obj['signature_request_notification_emails'] = _ApiClient["default"].convertToType(data['signature_request_notification_emails'], ['String']);
165
+ }
166
+ if (data.hasOwnProperty('signature_request_reply_to')) {
167
+ obj['signature_request_reply_to'] = _ApiClient["default"].convertToType(data['signature_request_reply_to'], 'String');
168
+ }
169
+ if (data.hasOwnProperty('signature_request_signing_url')) {
170
+ obj['signature_request_signing_url'] = _ApiClient["default"].convertToType(data['signature_request_signing_url'], 'String');
171
+ }
150
172
  if (data.hasOwnProperty('slack_webhook_url')) {
151
173
  obj['slack_webhook_url'] = _ApiClient["default"].convertToType(data['slack_webhook_url'], 'String');
152
174
  }
@@ -185,6 +207,11 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
185
207
  if (data.hasOwnProperty('html_escape_data')) {
186
208
  obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
187
209
  }
210
+ if (data.hasOwnProperty('layout')) {
211
+ obj['layout'] = _ApiClient["default"].convertToType(data['layout'], {
212
+ 'String': Object
213
+ });
214
+ }
188
215
  }
189
216
  return obj;
190
217
  }
@@ -222,6 +249,26 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
222
249
  throw new Error("Expected the field `redirect_url` to be a primitive type in the JSON string but got " + data['redirect_url']);
223
250
  }
224
251
  // ensure the json data is a string
252
+ if (data['signature_request_from_address'] && !(typeof data['signature_request_from_address'] === 'string' || data['signature_request_from_address'] instanceof String)) {
253
+ 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']);
254
+ }
255
+ // ensure the json data is a string
256
+ if (data['signature_request_from_name'] && !(typeof data['signature_request_from_name'] === 'string' || data['signature_request_from_name'] instanceof String)) {
257
+ 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']);
258
+ }
259
+ // ensure the json data is an array
260
+ if (!Array.isArray(data['signature_request_notification_emails'])) {
261
+ 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']);
262
+ }
263
+ // ensure the json data is a string
264
+ if (data['signature_request_reply_to'] && !(typeof data['signature_request_reply_to'] === 'string' || data['signature_request_reply_to'] instanceof String)) {
265
+ 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']);
266
+ }
267
+ // ensure the json data is a string
268
+ if (data['signature_request_signing_url'] && !(typeof data['signature_request_signing_url'] === 'string' || data['signature_request_signing_url'] instanceof String)) {
269
+ 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']);
270
+ }
271
+ // ensure the json data is a string
225
272
  if (data['slack_webhook_url'] && !(typeof data['slack_webhook_url'] === 'string' || data['slack_webhook_url'] instanceof String)) {
226
273
  throw new Error("Expected the field `slack_webhook_url` to be a primitive type in the JSON string but got " + data['slack_webhook_url']);
227
274
  }
@@ -331,7 +378,7 @@ UpdateTemplateRequest.prototype['name'] = undefined;
331
378
  UpdateTemplateRequest.prototype['description'] = undefined;
332
379
 
333
380
  /**
334
- * 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.
381
+ * 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.
335
382
  * @member {module:model/OutputFormat} output_format
336
383
  */
337
384
  UpdateTemplateRequest.prototype['output_format'] = undefined;
@@ -385,7 +432,7 @@ UpdateTemplateRequest.prototype['default_form_mode'] = undefined;
385
432
  UpdateTemplateRequest.prototype['editable_submissions'] = undefined;
386
433
 
387
434
  /**
388
- * 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.
435
+ * 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.
389
436
  * @member {Array.<String>} embed_domains
390
437
  */
391
438
  UpdateTemplateRequest.prototype['embed_domains'] = undefined;
@@ -468,6 +515,48 @@ UpdateTemplateRequest.prototype['public_web_form'] = undefined;
468
515
  */
469
516
  UpdateTemplateRequest.prototype['redirect_url'] = undefined;
470
517
 
518
+ /**
519
+ * 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.
520
+ * @member {module:model/SignatureRequestEmailAttachments} signature_request_email_attachments
521
+ */
522
+ UpdateTemplateRequest.prototype['signature_request_email_attachments'] = undefined;
523
+
524
+ /**
525
+ * 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.
526
+ * @member {String} signature_request_from_address
527
+ */
528
+ UpdateTemplateRequest.prototype['signature_request_from_address'] = undefined;
529
+
530
+ /**
531
+ * 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.
532
+ * @member {Boolean} signature_request_include_signing_token
533
+ */
534
+ UpdateTemplateRequest.prototype['signature_request_include_signing_token'] = undefined;
535
+
536
+ /**
537
+ * 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.
538
+ * @member {String} signature_request_from_name
539
+ */
540
+ UpdateTemplateRequest.prototype['signature_request_from_name'] = undefined;
541
+
542
+ /**
543
+ * 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.
544
+ * @member {Array.<String>} signature_request_notification_emails
545
+ */
546
+ UpdateTemplateRequest.prototype['signature_request_notification_emails'] = undefined;
547
+
548
+ /**
549
+ * 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.
550
+ * @member {String} signature_request_reply_to
551
+ */
552
+ UpdateTemplateRequest.prototype['signature_request_reply_to'] = undefined;
553
+
554
+ /**
555
+ * 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.
556
+ * @member {String} signature_request_signing_url
557
+ */
558
+ UpdateTemplateRequest.prototype['signature_request_signing_url'] = undefined;
559
+
471
560
  /**
472
561
  * 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.
473
562
  * @member {String} slack_webhook_url
@@ -505,7 +594,7 @@ UpdateTemplateRequest.prototype['predefined_fields'] = undefined;
505
594
  UpdateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
506
595
 
507
596
  /**
508
- * The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
597
+ * The HTML of an HTML template, as a Liquid template. Null for other templates.
509
598
  * @member {String} html
510
599
  */
511
600
  UpdateTemplateRequest.prototype['html'] = undefined;
@@ -535,8 +624,14 @@ UpdateTemplateRequest.prototype['footer_html'] = undefined;
535
624
  UpdateTemplateRequest.prototype['html_engine_options'] = undefined;
536
625
 
537
626
  /**
538
- * 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.
627
+ * 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.
539
628
  * @member {Boolean} html_escape_data
540
629
  */
541
630
  UpdateTemplateRequest.prototype['html_escape_data'] = undefined;
631
+
632
+ /**
633
+ * 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.
634
+ * @member {Object.<String, Object>} layout
635
+ */
636
+ UpdateTemplateRequest.prototype['layout'] = undefined;
542
637
  var _default = exports["default"] = UpdateTemplateRequest;
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
28
28
  /**
29
29
  * The UpdateWebhookRequest model module.
30
30
  * @module model/UpdateWebhookRequest
31
- * @version 4.3.0
31
+ * @version 4.4.0
32
32
  */
33
33
  var UpdateWebhookRequest = /*#__PURE__*/function () {
34
34
  /**
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
30
30
  /**
31
31
  * The UploadPresign model module.
32
32
  * @module model/UploadPresign
33
- * @version 4.3.0
33
+ * @version 4.4.0
34
34
  */
35
35
  var UploadPresign = /*#__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 UrlSourcePdf model module.
31
31
  * @module model/UrlSourcePdf
32
- * @version 4.3.0
32
+ * @version 4.4.0
33
33
  */
34
34
  var UrlSourcePdf = /*#__PURE__*/function () {
35
35
  /**