docspring 4.2.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.
- package/AGENTS.md +2 -2
- package/README.md +26 -6
- package/dist/ApiClient.js +3 -3
- package/dist/RequestSchemas.js +1171 -134
- package/dist/RequestValidator.js +4 -0
- package/dist/api/Client.js +1406 -248
- package/dist/index.js +196 -0
- package/dist/model/AddTemplateFieldsRequest.js +4 -4
- package/dist/model/AiFieldNamingLanguage.js +1 -1
- package/dist/model/AuthenticationCheck.js +2 -2
- package/dist/model/BarcodeSymbology.js +1 -1
- package/dist/model/CheckCharacter.js +1 -1
- package/dist/model/CombinedFieldType.js +1 -1
- package/dist/model/CombinedPdf.js +2 -2
- package/dist/model/CombinedPdfFiles.js +2 -2
- package/dist/model/CombinedPdfList.js +2 -2
- package/dist/model/CombinedPdfSource.js +3 -3
- package/dist/model/CombinedPdfSourceInput.js +3 -3
- package/dist/model/CombinedPdfSourcePdf.js +2 -2
- package/dist/model/CombinedPdfSourceType.js +1 -1
- package/dist/model/CombinedPdfState.js +1 -1
- package/dist/model/CopyTemplateRequest.js +2 -2
- package/dist/model/CreateAccountEmailActionRequest.js +306 -0
- package/dist/model/CreateCombinedPdfRequest.js +2 -2
- package/dist/model/CreateCustomFileFromUploadRequest.js +2 -2
- package/dist/model/CreateEmailActionRequest.js +280 -0
- package/dist/model/CreateEmailDomainRequest.js +114 -0
- package/dist/model/CreateFolderRequest.js +2 -2
- package/dist/model/CreateSignatureRequestEventRequest.js +2 -2
- package/dist/model/CreateSignatureRequestTokenRequest.js +2 -2
- package/dist/model/CreateSubmissionBatchRequest.js +5 -5
- package/dist/model/CreateSubmissionRequest.js +115 -7
- package/dist/model/CreateTemplatePreviewRequest.js +2 -2
- package/dist/model/CreateTemplateRequest.js +119 -14
- package/dist/model/CreateWebhookRequest.js +2 -2
- package/dist/model/CustomFile.js +2 -2
- package/dist/model/CustomFileList.js +2 -2
- package/dist/model/CustomFileSourcePdf.js +2 -2
- package/dist/model/DnsRecordType.js +64 -0
- package/dist/model/EmailAction.js +510 -0
- package/dist/model/EmailActionConditions.js +142 -0
- package/dist/model/EmailActionConditionsInput.js +142 -0
- package/dist/model/EmailActionCustomization.js +222 -0
- package/dist/model/EmailActionDelivery.js +59 -0
- package/dist/model/EmailActionFileFormats.js +69 -0
- package/dist/model/EmailActionList.js +132 -0
- package/dist/model/EmailActionSetting.js +119 -0
- package/dist/model/EmailActionSubmissionType.js +64 -0
- package/dist/model/EmailActionTestEmail.js +116 -0
- package/dist/model/EmailDomain.js +245 -0
- package/dist/model/EmailDomainDnsRecord.js +155 -0
- package/dist/model/EmailDomainDnsRecordPurpose.js +64 -0
- package/dist/model/EmailDomainList.js +132 -0
- package/dist/model/EmailDomainRecordState.js +64 -0
- package/dist/model/EmailDomainState.js +64 -0
- package/dist/model/ErrorCode.js +11 -1
- package/dist/model/ErrorDetail.js +2 -2
- package/dist/model/ErrorInfo.js +47 -8
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/ExpirationInterval.js +1 -1
- package/dist/model/Field.js +5 -5
- package/dist/model/FieldComparisonCondition.js +2 -2
- package/dist/model/FieldComparisonOperator.js +1 -1
- package/dist/model/FieldDependency.js +2 -2
- package/dist/model/FieldDependencyInput.js +2 -2
- package/dist/model/FieldDisplayType.js +1 -1
- package/dist/model/FieldEqualsCondition.js +2 -2
- package/dist/model/FieldEqualsOperator.js +1 -1
- package/dist/model/FieldGroup.js +6 -6
- package/dist/model/FieldGroupInput.js +3 -3
- package/dist/model/FieldGroupType.js +1 -1
- package/dist/model/FieldInCondition.js +2 -2
- package/dist/model/FieldInput.js +4 -4
- package/dist/model/FieldOverride.js +2 -2
- package/dist/model/FieldPresenceCondition.js +2 -2
- package/dist/model/FieldPresenceOperator.js +1 -1
- package/dist/model/FieldRangeCondition.js +2 -2
- package/dist/model/FieldReimportState.js +1 -1
- package/dist/model/FieldSetupLogic.js +1 -1
- package/dist/model/FieldSetupNaming.js +1 -1
- package/dist/model/FieldSetupSource.js +1 -1
- package/dist/model/FieldType.js +1 -1
- package/dist/model/Folder.js +2 -2
- package/dist/model/FolderList.js +2 -2
- package/dist/model/GenerateFilesFormat.js +16 -1
- package/dist/model/GenerateSubmissionFilesRequest.js +4 -4
- package/dist/model/GeneratedFile.js +7 -7
- package/dist/model/GeneratedFileState.js +1 -1
- package/dist/model/HtmlEngineOptions.js +4 -4
- package/dist/model/HtmlEngineOptionsInput.js +3 -3
- package/dist/model/ImageGravity.js +1 -1
- package/dist/model/ImageScaleType.js +1 -1
- package/dist/model/ModelCodeLanguage.js +7 -2
- package/dist/model/MoveFolderRequest.js +2 -2
- package/dist/model/MoveTemplateRequest.js +2 -2
- package/dist/model/NumberConditionType.js +1 -1
- package/dist/model/OutputFormat.js +11 -1
- package/dist/model/PageFormat.js +1 -1
- package/dist/model/PageImage.js +2 -2
- package/dist/model/PageImages.js +2 -2
- package/dist/model/PredefinedField.js +2 -2
- package/dist/model/PredefinedFieldInput.js +2 -2
- package/dist/model/PublishTemplateVersionRequest.js +2 -2
- package/dist/model/RemoveTemplateFieldsRequest.js +2 -2
- package/dist/model/RenameFolderRequest.js +2 -2
- package/dist/model/ReorderTemplateFieldsRequest.js +2 -2
- package/dist/model/RestoreTemplateVersionRequest.js +2 -2
- package/dist/model/SendAccountEmailActionTestEmailRequest.js +91 -0
- package/dist/model/ShapeType.js +1 -1
- package/dist/model/SignatureRequest.js +53 -8
- package/dist/model/SignatureRequestAuthSecondFactorType.js +1 -1
- package/dist/model/SignatureRequestAuthType.js +1 -1
- package/dist/model/SignatureRequestEmailAttachments.js +59 -0
- package/dist/model/SignatureRequestEmailStatus.js +89 -0
- package/dist/model/SignatureRequestEvent.js +2 -2
- package/dist/model/SignatureRequestEventType.js +12 -2
- package/dist/model/SignatureRequestInput.js +25 -9
- package/dist/model/SignatureRequestMessageType.js +1 -1
- package/dist/model/SignatureRequestReminders.js +121 -0
- package/dist/model/SignatureRequestState.js +1 -1
- package/dist/model/SignatureRequestToken.js +2 -2
- package/dist/model/SignatureRequestTokenType.js +1 -1
- package/dist/model/SigningOrder.js +59 -0
- package/dist/model/StringConditionType.js +37 -2
- package/dist/model/Submission.js +31 -19
- package/dist/model/SubmissionAction.js +28 -13
- package/dist/model/SubmissionActionState.js +1 -1
- package/dist/model/SubmissionActionType.js +1 -1
- package/dist/model/SubmissionBatch.js +9 -9
- package/dist/model/SubmissionBatchState.js +1 -1
- package/dist/model/SubmissionFiles.js +20 -2
- package/dist/model/SubmissionInput.js +7 -7
- package/dist/model/SubmissionList.js +2 -2
- package/dist/model/SubmissionSource.js +1 -1
- package/dist/model/SubmissionSourcePdf.js +2 -2
- package/dist/model/SubmissionState.js +1 -1
- package/dist/model/SubmissionSummary.js +8 -8
- package/dist/model/SubmissionValidation.js +2 -2
- package/dist/model/Template.js +149 -26
- package/dist/model/TemplateActor.js +2 -2
- package/dist/model/TemplateActorType.js +1 -1
- package/dist/model/TemplateDefaults.js +2 -2
- package/dist/model/TemplateDefaultsInput.js +2 -2
- package/dist/model/TemplateDiff.js +6 -6
- package/dist/model/TemplateDiffSummary.js +2 -2
- package/dist/model/TemplateDocument.js +23 -23
- package/dist/model/TemplateDocumentState.js +12 -2
- package/dist/model/TemplateDocumentSummary.js +11 -11
- package/dist/model/TemplateFieldChange.js +2 -2
- package/dist/model/TemplateFieldChanges.js +2 -2
- package/dist/model/TemplateFieldDependency.js +2 -2
- package/dist/model/TemplateFieldDependencyAction.js +1 -1
- package/dist/model/TemplateFieldDependencyCondition.js +2 -2
- package/dist/model/TemplateFieldDependencyConditionInput.js +2 -2
- package/dist/model/TemplateFieldDependencyInput.js +2 -2
- package/dist/model/TemplateFieldDependencyMatch.js +1 -1
- package/dist/model/TemplateFieldDependencyOperator.js +1 -1
- package/dist/model/TemplateFieldLogicStatus.js +1 -1
- package/dist/model/TemplateFieldMove.js +2 -2
- package/dist/model/TemplateFields.js +2 -2
- package/dist/model/TemplateFormMode.js +1 -1
- package/dist/model/TemplateModelCode.js +2 -2
- package/dist/model/TemplatePageAiError.js +1 -1
- package/dist/model/TemplatePageAiNamingStatus.js +1 -1
- package/dist/model/TemplatePageFieldsStatus.js +1 -1
- package/dist/model/TemplatePageImageStatus.js +1 -1
- package/dist/model/TemplatePageImages.js +2 -2
- package/dist/model/TemplatePageProcessingStatus.js +2 -2
- package/dist/model/TemplatePreview.js +5 -5
- package/dist/model/TemplatePreviewState.js +1 -1
- package/dist/model/TemplateSourcePdf.js +3 -3
- package/dist/model/TemplateSummary.js +24 -12
- package/dist/model/TemplateSummaryList.js +2 -2
- package/dist/model/TemplateType.js +12 -2
- package/dist/model/TemplateVersion.js +2 -2
- package/dist/model/TemplateVersionType.js +1 -1
- package/dist/model/TextAlignment.js +1 -1
- package/dist/model/TextOverflow.js +1 -1
- package/dist/model/TextVerticalAlignment.js +1 -1
- package/dist/model/Typeface.js +1 -1
- package/dist/model/UpdateAccountEmailActionRequest.js +306 -0
- package/dist/model/UpdateEmailActionCustomizationRequest.js +258 -0
- package/dist/model/UpdateEmailActionRequest.js +280 -0
- package/dist/model/UpdateSignatureRequestRequest.js +2 -2
- package/dist/model/UpdateTemplateDocumentRequest.js +8 -8
- package/dist/model/UpdateTemplateFieldsRequest.js +2 -2
- package/dist/model/UpdateTemplateRequest.js +113 -8
- package/dist/model/UpdateWebhookRequest.js +2 -2
- package/dist/model/UploadMethod.js +1 -1
- package/dist/model/UploadPresign.js +2 -2
- package/dist/model/UrlSourcePdf.js +2 -2
- package/dist/model/ValidateSubmissionRequest.js +115 -7
- package/dist/model/Webhook.js +2 -2
- package/dist/model/WebhookEventType.js +11 -1
- package/dist/model/WebhookList.js +2 -2
- package/dist/model/WebhookMode.js +1 -1
- package/package.json +2 -2
|
@@ -11,7 +11,9 @@ var _FieldSetupLogic = _interopRequireDefault(require("./FieldSetupLogic"));
|
|
|
11
11
|
var _FieldSetupNaming = _interopRequireDefault(require("./FieldSetupNaming"));
|
|
12
12
|
var _FieldSetupSource = _interopRequireDefault(require("./FieldSetupSource"));
|
|
13
13
|
var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
|
|
14
|
+
var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
|
|
14
15
|
var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
|
|
16
|
+
var _SignatureRequestEmailAttachments = _interopRequireDefault(require("./SignatureRequestEmailAttachments"));
|
|
15
17
|
var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
|
|
16
18
|
var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
|
|
17
19
|
var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
|
|
@@ -27,7 +29,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
27
29
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
28
30
|
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); } /**
|
|
29
31
|
* DocSpring API
|
|
30
|
-
* Use DocSpring's API to
|
|
32
|
+
* 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.
|
|
31
33
|
*
|
|
32
34
|
* The version of the OpenAPI document: v2
|
|
33
35
|
*
|
|
@@ -40,14 +42,14 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
40
42
|
/**
|
|
41
43
|
* The CreateTemplateRequest model module.
|
|
42
44
|
* @module model/CreateTemplateRequest
|
|
43
|
-
* @version 4.
|
|
45
|
+
* @version 4.4.0
|
|
44
46
|
*/
|
|
45
47
|
var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
46
48
|
/**
|
|
47
49
|
* Constructs a new <code>CreateTemplateRequest</code>.
|
|
48
50
|
* The template to create.
|
|
49
51
|
* @alias module:model/CreateTemplateRequest
|
|
50
|
-
* @param template_type {module:model/TemplateType} `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
|
|
52
|
+
* @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.
|
|
51
53
|
*/
|
|
52
54
|
function CreateTemplateRequest(template_type) {
|
|
53
55
|
_classCallCheck(this, CreateTemplateRequest);
|
|
@@ -86,6 +88,9 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
|
86
88
|
if (data.hasOwnProperty('template_type')) {
|
|
87
89
|
obj['template_type'] = _ApiClient["default"].convertToType(data['template_type'], _TemplateType["default"]);
|
|
88
90
|
}
|
|
91
|
+
if (data.hasOwnProperty('output_format')) {
|
|
92
|
+
obj['output_format'] = _ApiClient["default"].convertToType(data['output_format'], _OutputFormat["default"]);
|
|
93
|
+
}
|
|
89
94
|
if (data.hasOwnProperty('parent_folder_id')) {
|
|
90
95
|
obj['parent_folder_id'] = _ApiClient["default"].convertToType(data['parent_folder_id'], 'String');
|
|
91
96
|
}
|
|
@@ -152,6 +157,27 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
|
152
157
|
if (data.hasOwnProperty('redirect_url')) {
|
|
153
158
|
obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
|
|
154
159
|
}
|
|
160
|
+
if (data.hasOwnProperty('signature_request_email_attachments')) {
|
|
161
|
+
obj['signature_request_email_attachments'] = _ApiClient["default"].convertToType(data['signature_request_email_attachments'], _SignatureRequestEmailAttachments["default"]);
|
|
162
|
+
}
|
|
163
|
+
if (data.hasOwnProperty('signature_request_from_address')) {
|
|
164
|
+
obj['signature_request_from_address'] = _ApiClient["default"].convertToType(data['signature_request_from_address'], 'String');
|
|
165
|
+
}
|
|
166
|
+
if (data.hasOwnProperty('signature_request_include_signing_token')) {
|
|
167
|
+
obj['signature_request_include_signing_token'] = _ApiClient["default"].convertToType(data['signature_request_include_signing_token'], 'Boolean');
|
|
168
|
+
}
|
|
169
|
+
if (data.hasOwnProperty('signature_request_from_name')) {
|
|
170
|
+
obj['signature_request_from_name'] = _ApiClient["default"].convertToType(data['signature_request_from_name'], 'String');
|
|
171
|
+
}
|
|
172
|
+
if (data.hasOwnProperty('signature_request_notification_emails')) {
|
|
173
|
+
obj['signature_request_notification_emails'] = _ApiClient["default"].convertToType(data['signature_request_notification_emails'], ['String']);
|
|
174
|
+
}
|
|
175
|
+
if (data.hasOwnProperty('signature_request_reply_to')) {
|
|
176
|
+
obj['signature_request_reply_to'] = _ApiClient["default"].convertToType(data['signature_request_reply_to'], 'String');
|
|
177
|
+
}
|
|
178
|
+
if (data.hasOwnProperty('signature_request_signing_url')) {
|
|
179
|
+
obj['signature_request_signing_url'] = _ApiClient["default"].convertToType(data['signature_request_signing_url'], 'String');
|
|
180
|
+
}
|
|
155
181
|
if (data.hasOwnProperty('slack_webhook_url')) {
|
|
156
182
|
obj['slack_webhook_url'] = _ApiClient["default"].convertToType(data['slack_webhook_url'], 'String');
|
|
157
183
|
}
|
|
@@ -187,6 +213,11 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
|
187
213
|
if (data.hasOwnProperty('html_escape_data')) {
|
|
188
214
|
obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
|
|
189
215
|
}
|
|
216
|
+
if (data.hasOwnProperty('layout')) {
|
|
217
|
+
obj['layout'] = _ApiClient["default"].convertToType(data['layout'], {
|
|
218
|
+
'String': Object
|
|
219
|
+
});
|
|
220
|
+
}
|
|
190
221
|
if (data.hasOwnProperty('cache_id')) {
|
|
191
222
|
obj['cache_id'] = _ApiClient["default"].convertToType(data['cache_id'], 'String');
|
|
192
223
|
}
|
|
@@ -263,6 +294,26 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
|
263
294
|
throw new Error("Expected the field `redirect_url` to be a primitive type in the JSON string but got " + data['redirect_url']);
|
|
264
295
|
}
|
|
265
296
|
// ensure the json data is a string
|
|
297
|
+
if (data['signature_request_from_address'] && !(typeof data['signature_request_from_address'] === 'string' || data['signature_request_from_address'] instanceof String)) {
|
|
298
|
+
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']);
|
|
299
|
+
}
|
|
300
|
+
// ensure the json data is a string
|
|
301
|
+
if (data['signature_request_from_name'] && !(typeof data['signature_request_from_name'] === 'string' || data['signature_request_from_name'] instanceof String)) {
|
|
302
|
+
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']);
|
|
303
|
+
}
|
|
304
|
+
// ensure the json data is an array
|
|
305
|
+
if (!Array.isArray(data['signature_request_notification_emails'])) {
|
|
306
|
+
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']);
|
|
307
|
+
}
|
|
308
|
+
// ensure the json data is a string
|
|
309
|
+
if (data['signature_request_reply_to'] && !(typeof data['signature_request_reply_to'] === 'string' || data['signature_request_reply_to'] instanceof String)) {
|
|
310
|
+
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']);
|
|
311
|
+
}
|
|
312
|
+
// ensure the json data is a string
|
|
313
|
+
if (data['signature_request_signing_url'] && !(typeof data['signature_request_signing_url'] === 'string' || data['signature_request_signing_url'] instanceof String)) {
|
|
314
|
+
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']);
|
|
315
|
+
}
|
|
316
|
+
// ensure the json data is a string
|
|
266
317
|
if (data['slack_webhook_url'] && !(typeof data['slack_webhook_url'] === 'string' || data['slack_webhook_url'] instanceof String)) {
|
|
267
318
|
throw new Error("Expected the field `slack_webhook_url` to be a primitive type in the JSON string but got " + data['slack_webhook_url']);
|
|
268
319
|
}
|
|
@@ -369,11 +420,17 @@ CreateTemplateRequest.prototype['name'] = undefined;
|
|
|
369
420
|
CreateTemplateRequest.prototype['description'] = undefined;
|
|
370
421
|
|
|
371
422
|
/**
|
|
372
|
-
* `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
|
|
423
|
+
* `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.
|
|
373
424
|
* @member {module:model/TemplateType} template_type
|
|
374
425
|
*/
|
|
375
426
|
CreateTemplateRequest.prototype['template_type'] = undefined;
|
|
376
427
|
|
|
428
|
+
/**
|
|
429
|
+
* 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.
|
|
430
|
+
* @member {module:model/OutputFormat} output_format
|
|
431
|
+
*/
|
|
432
|
+
CreateTemplateRequest.prototype['output_format'] = undefined;
|
|
433
|
+
|
|
377
434
|
/**
|
|
378
435
|
* 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.
|
|
379
436
|
* @member {String} parent_folder_id
|
|
@@ -411,7 +468,7 @@ CreateTemplateRequest.prototype['allow_additional_properties'] = undefined;
|
|
|
411
468
|
CreateTemplateRequest.prototype['allow_skipping_optional_fields'] = undefined;
|
|
412
469
|
|
|
413
470
|
/**
|
|
414
|
-
* 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).
|
|
471
|
+
* 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`.
|
|
415
472
|
* @member {module:model/TemplateFormMode} default_form_mode
|
|
416
473
|
*/
|
|
417
474
|
CreateTemplateRequest.prototype['default_form_mode'] = undefined;
|
|
@@ -423,7 +480,7 @@ CreateTemplateRequest.prototype['default_form_mode'] = undefined;
|
|
|
423
480
|
CreateTemplateRequest.prototype['editable_submissions'] = undefined;
|
|
424
481
|
|
|
425
482
|
/**
|
|
426
|
-
* 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.
|
|
483
|
+
* 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.
|
|
427
484
|
* @member {Array.<String>} embed_domains
|
|
428
485
|
*/
|
|
429
486
|
CreateTemplateRequest.prototype['embed_domains'] = undefined;
|
|
@@ -447,7 +504,7 @@ CreateTemplateRequest.prototype['embed_edit_allow_versioning'] = undefined;
|
|
|
447
504
|
CreateTemplateRequest.prototype['embed_edit_allow_document_replacement'] = undefined;
|
|
448
505
|
|
|
449
506
|
/**
|
|
450
|
-
* Encrypt generated PDFs with `encrypt_pdfs_password`.
|
|
507
|
+
* Encrypt generated PDFs with `encrypt_pdfs_password`. A Word template can only encrypt its PDFs when its `output_format` is `pdf`, because Word documents and OpenDocument files can't be password-protected.
|
|
451
508
|
* @member {Boolean} encrypt_pdfs
|
|
452
509
|
*/
|
|
453
510
|
CreateTemplateRequest.prototype['encrypt_pdfs'] = undefined;
|
|
@@ -483,7 +540,7 @@ CreateTemplateRequest.prototype['expiration_interval'] = undefined;
|
|
|
483
540
|
CreateTemplateRequest.prototype['merge_audit_trail_pdf'] = undefined;
|
|
484
541
|
|
|
485
542
|
/**
|
|
486
|
-
* Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
|
|
543
|
+
* Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML or Word template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
|
|
487
544
|
* @member {Boolean} parse_dates_using_template_date_format
|
|
488
545
|
*/
|
|
489
546
|
CreateTemplateRequest.prototype['parse_dates_using_template_date_format'] = undefined;
|
|
@@ -506,6 +563,48 @@ CreateTemplateRequest.prototype['public_web_form'] = undefined;
|
|
|
506
563
|
*/
|
|
507
564
|
CreateTemplateRequest.prototype['redirect_url'] = undefined;
|
|
508
565
|
|
|
566
|
+
/**
|
|
567
|
+
* 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.
|
|
568
|
+
* @member {module:model/SignatureRequestEmailAttachments} signature_request_email_attachments
|
|
569
|
+
*/
|
|
570
|
+
CreateTemplateRequest.prototype['signature_request_email_attachments'] = undefined;
|
|
571
|
+
|
|
572
|
+
/**
|
|
573
|
+
* 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.
|
|
574
|
+
* @member {String} signature_request_from_address
|
|
575
|
+
*/
|
|
576
|
+
CreateTemplateRequest.prototype['signature_request_from_address'] = undefined;
|
|
577
|
+
|
|
578
|
+
/**
|
|
579
|
+
* 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.
|
|
580
|
+
* @member {Boolean} signature_request_include_signing_token
|
|
581
|
+
*/
|
|
582
|
+
CreateTemplateRequest.prototype['signature_request_include_signing_token'] = undefined;
|
|
583
|
+
|
|
584
|
+
/**
|
|
585
|
+
* 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.
|
|
586
|
+
* @member {String} signature_request_from_name
|
|
587
|
+
*/
|
|
588
|
+
CreateTemplateRequest.prototype['signature_request_from_name'] = undefined;
|
|
589
|
+
|
|
590
|
+
/**
|
|
591
|
+
* 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.
|
|
592
|
+
* @member {Array.<String>} signature_request_notification_emails
|
|
593
|
+
*/
|
|
594
|
+
CreateTemplateRequest.prototype['signature_request_notification_emails'] = undefined;
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* 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.
|
|
598
|
+
* @member {String} signature_request_reply_to
|
|
599
|
+
*/
|
|
600
|
+
CreateTemplateRequest.prototype['signature_request_reply_to'] = undefined;
|
|
601
|
+
|
|
602
|
+
/**
|
|
603
|
+
* 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.
|
|
604
|
+
* @member {String} signature_request_signing_url
|
|
605
|
+
*/
|
|
606
|
+
CreateTemplateRequest.prototype['signature_request_signing_url'] = undefined;
|
|
607
|
+
|
|
509
608
|
/**
|
|
510
609
|
* 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.
|
|
511
610
|
* @member {String} slack_webhook_url
|
|
@@ -537,7 +636,7 @@ CreateTemplateRequest.prototype['predefined_fields'] = undefined;
|
|
|
537
636
|
CreateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
|
|
538
637
|
|
|
539
638
|
/**
|
|
540
|
-
* The HTML of an HTML template, as a Liquid template. Null for
|
|
639
|
+
* The HTML of an HTML template, as a Liquid template. Null for other templates.
|
|
541
640
|
* @member {String} html
|
|
542
641
|
*/
|
|
543
642
|
CreateTemplateRequest.prototype['html'] = undefined;
|
|
@@ -567,31 +666,37 @@ CreateTemplateRequest.prototype['footer_html'] = undefined;
|
|
|
567
666
|
CreateTemplateRequest.prototype['html_engine_options'] = undefined;
|
|
568
667
|
|
|
569
668
|
/**
|
|
570
|
-
* 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
|
|
669
|
+
* 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.
|
|
571
670
|
* @member {Boolean} html_escape_data
|
|
572
671
|
*/
|
|
573
672
|
CreateTemplateRequest.prototype['html_escape_data'] = undefined;
|
|
574
673
|
|
|
575
674
|
/**
|
|
576
|
-
* A
|
|
675
|
+
* 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.
|
|
676
|
+
* @member {Object.<String, Object>} layout
|
|
677
|
+
*/
|
|
678
|
+
CreateTemplateRequest.prototype['layout'] = undefined;
|
|
679
|
+
|
|
680
|
+
/**
|
|
681
|
+
* The template's document, a PDF or a Word document (.docx or .odt): the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). PDF and Word templates need one of `cache_id`, `document_url` and `document_base64`. To upload the file with the request, use POST /templates/upload.
|
|
577
682
|
* @member {String} cache_id
|
|
578
683
|
*/
|
|
579
684
|
CreateTemplateRequest.prototype['cache_id'] = undefined;
|
|
580
685
|
|
|
581
686
|
/**
|
|
582
|
-
* An https:// link to the template's PDF (up to 100 MB),
|
|
687
|
+
* An https:// link to the template's document, instead of `cache_id`: a PDF template's PDF (up to 100 MB) or a Word template's Word document (.docx or .odt, up to 50 MB). DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then, and `converting` while an .odt is converted (sync.api hosts wait for both). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why.
|
|
583
688
|
* @member {String} document_url
|
|
584
689
|
*/
|
|
585
690
|
CreateTemplateRequest.prototype['document_url'] = undefined;
|
|
586
691
|
|
|
587
692
|
/**
|
|
588
|
-
* The template's PDF, encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
|
|
693
|
+
* 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`.
|
|
589
694
|
* @member {String} document_base64
|
|
590
695
|
*/
|
|
591
696
|
CreateTemplateRequest.prototype['document_base64'] = undefined;
|
|
592
697
|
|
|
593
698
|
/**
|
|
594
|
-
* The
|
|
699
|
+
* The file's name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it.
|
|
595
700
|
* @member {String} filename
|
|
596
701
|
*/
|
|
597
702
|
CreateTemplateRequest.prototype['filename'] = undefined;
|
|
@@ -18,7 +18,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
18
18
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
19
19
|
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); } /**
|
|
20
20
|
* DocSpring API
|
|
21
|
-
* Use DocSpring's API to
|
|
21
|
+
* 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.
|
|
22
22
|
*
|
|
23
23
|
* The version of the OpenAPI document: v2
|
|
24
24
|
*
|
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
31
31
|
/**
|
|
32
32
|
* The CreateWebhookRequest model module.
|
|
33
33
|
* @module model/CreateWebhookRequest
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.4.0
|
|
35
35
|
*/
|
|
36
36
|
var CreateWebhookRequest = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
package/dist/model/CustomFile.js
CHANGED
|
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
16
16
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
17
17
|
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); } /**
|
|
18
18
|
* DocSpring API
|
|
19
|
-
* Use DocSpring's API to
|
|
19
|
+
* 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.
|
|
20
20
|
*
|
|
21
21
|
* The version of the OpenAPI document: v2
|
|
22
22
|
*
|
|
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
29
29
|
/**
|
|
30
30
|
* The CustomFile model module.
|
|
31
31
|
* @module model/CustomFile
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.4.0
|
|
33
33
|
*/
|
|
34
34
|
var CustomFile = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
17
17
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
18
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
19
|
* DocSpring API
|
|
20
|
-
* Use DocSpring's API to
|
|
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
21
|
*
|
|
22
22
|
* The version of the OpenAPI document: v2
|
|
23
23
|
*
|
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
30
30
|
/**
|
|
31
31
|
* The CustomFileList model module.
|
|
32
32
|
* @module model/CustomFileList
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.4.0
|
|
34
34
|
*/
|
|
35
35
|
var CustomFileList = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
16
16
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
17
17
|
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); } /**
|
|
18
18
|
* DocSpring API
|
|
19
|
-
* Use DocSpring's API to
|
|
19
|
+
* 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.
|
|
20
20
|
*
|
|
21
21
|
* The version of the OpenAPI document: v2
|
|
22
22
|
*
|
|
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
29
29
|
/**
|
|
30
30
|
* The CustomFileSourcePdf model module.
|
|
31
31
|
* @module model/CustomFileSourcePdf
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.4.0
|
|
33
33
|
*/
|
|
34
34
|
var CustomFileSourcePdf = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -0,0 +1,64 @@
|
|
|
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
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
9
|
+
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); }
|
|
10
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
11
|
+
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); } }
|
|
12
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
13
|
+
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
|
|
14
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
|
+
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); } /**
|
|
16
|
+
* DocSpring API
|
|
17
|
+
* 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.
|
|
18
|
+
*
|
|
19
|
+
* The version of the OpenAPI document: v2
|
|
20
|
+
*
|
|
21
|
+
*
|
|
22
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
23
|
+
* https://openapi-generator.tech
|
|
24
|
+
* Do not edit the class manually.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
/**
|
|
28
|
+
* Enum class DnsRecordType.
|
|
29
|
+
* @enum {}
|
|
30
|
+
* @readonly
|
|
31
|
+
*/
|
|
32
|
+
var DnsRecordType = exports["default"] = /*#__PURE__*/function () {
|
|
33
|
+
function DnsRecordType() {
|
|
34
|
+
_classCallCheck(this, DnsRecordType);
|
|
35
|
+
}
|
|
36
|
+
return _createClass(DnsRecordType, null, [{
|
|
37
|
+
key: "constructFromObject",
|
|
38
|
+
value:
|
|
39
|
+
/**
|
|
40
|
+
* Returns a <code>DnsRecordType</code> enum value from a Javascript object name.
|
|
41
|
+
* @param {Object} data The plain JavaScript object containing the name of the enum value.
|
|
42
|
+
* @return {module:model/DnsRecordType} The enum <code>DnsRecordType</code> value.
|
|
43
|
+
*/
|
|
44
|
+
function constructFromObject(object) {
|
|
45
|
+
// Any value, including one added to the API after this client was released
|
|
46
|
+
return object;
|
|
47
|
+
}
|
|
48
|
+
}]);
|
|
49
|
+
}();
|
|
50
|
+
/**
|
|
51
|
+
* value: "CNAME"
|
|
52
|
+
* @const
|
|
53
|
+
*/
|
|
54
|
+
_defineProperty(DnsRecordType, "CNAME", "CNAME");
|
|
55
|
+
/**
|
|
56
|
+
* value: "MX"
|
|
57
|
+
* @const
|
|
58
|
+
*/
|
|
59
|
+
_defineProperty(DnsRecordType, "MX", "MX");
|
|
60
|
+
/**
|
|
61
|
+
* value: "TXT"
|
|
62
|
+
* @const
|
|
63
|
+
*/
|
|
64
|
+
_defineProperty(DnsRecordType, "TXT", "TXT");
|