docspring 4.1.0 → 4.3.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 +5 -4
- package/README.md +10 -6
- package/dist/ApiClient.js +3 -3
- package/dist/RequestSchemas.js +94 -15
- package/dist/WebhookSignature.js +86 -0
- package/dist/api/Client.js +193 -57
- package/dist/index.js +42 -0
- package/dist/model/AddTemplateFieldsRequest.js +2 -2
- 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 +4 -4
- package/dist/model/CombinedPdfFiles.js +2 -2
- package/dist/model/CombinedPdfList.js +2 -2
- package/dist/model/CombinedPdfSource.js +2 -2
- package/dist/model/CombinedPdfSourceInput.js +2 -2
- 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/CreateCombinedPdfRequest.js +3 -3
- package/dist/model/CreateCustomFileFromUploadRequest.js +2 -2
- 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 +2 -2
- package/dist/model/CreateSubmissionRequest.js +7 -7
- package/dist/model/CreateTemplatePreviewRequest.js +112 -0
- package/dist/model/CreateTemplateRequest.js +32 -13
- 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/ErrorCode.js +12 -2
- package/dist/model/ErrorDetail.js +3 -3
- package/dist/model/ErrorInfo.js +7 -7
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/ExpirationInterval.js +1 -1
- package/dist/model/Field.js +3 -3
- 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 +3 -3
- 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 +2 -2
- package/dist/model/HtmlEngineOptionsInput.js +2 -2
- 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/ShapeType.js +1 -1
- package/dist/model/SignatureRequest.js +2 -2
- package/dist/model/SignatureRequestAuthSecondFactorType.js +1 -1
- package/dist/model/SignatureRequestAuthType.js +1 -1
- package/dist/model/SignatureRequestEvent.js +2 -2
- package/dist/model/SignatureRequestEventType.js +1 -1
- package/dist/model/SignatureRequestInput.js +2 -2
- package/dist/model/SignatureRequestMessageType.js +1 -1
- package/dist/model/SignatureRequestState.js +1 -1
- package/dist/model/SignatureRequestToken.js +2 -2
- package/dist/model/SignatureRequestTokenType.js +1 -1
- package/dist/model/StringConditionType.js +1 -1
- package/dist/model/Submission.js +82 -82
- package/dist/model/SubmissionAction.js +2 -2
- 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 +6 -6
- 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 +343 -0
- package/dist/model/SubmissionValidation.js +2 -2
- package/dist/model/Template.js +95 -72
- package/dist/model/TemplateActor.js +4 -4
- 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 +49 -49
- package/dist/model/TemplateDocumentState.js +12 -2
- package/dist/model/TemplateDocumentSummary.js +152 -0
- 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 +211 -0
- package/dist/model/TemplatePreviewState.js +64 -0
- package/dist/model/TemplateSourcePdf.js +2 -2
- package/dist/model/TemplateSummary.js +29 -291
- package/dist/model/TemplateSummaryList.js +2 -2
- package/dist/model/TemplateType.js +7 -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/UpdateSignatureRequestRequest.js +2 -2
- package/dist/model/UpdateTemplateDocumentRequest.js +8 -8
- package/dist/model/UpdateTemplateFieldsRequest.js +2 -2
- package/dist/model/UpdateTemplateRequest.js +26 -7
- 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 +7 -7
- package/dist/model/Webhook.js +2 -2
- package/dist/model/WebhookEventType.js +1 -1
- package/dist/model/WebhookList.js +2 -2
- package/dist/model/WebhookMode.js +1 -1
- package/package.json +4 -3
|
@@ -13,7 +13,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
13
13
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
14
14
|
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); } /**
|
|
15
15
|
* DocSpring API
|
|
16
|
-
* Use DocSpring's API to
|
|
16
|
+
* 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.
|
|
17
17
|
*
|
|
18
18
|
* The version of the OpenAPI document: v2
|
|
19
19
|
*
|
|
@@ -26,12 +26,12 @@ 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.
|
|
29
|
+
* @version 4.3.0
|
|
30
30
|
*/
|
|
31
31
|
var UpdateTemplateDocumentRequest = /*#__PURE__*/function () {
|
|
32
32
|
/**
|
|
33
33
|
* Constructs a new <code>UpdateTemplateDocumentRequest</code>.
|
|
34
|
-
* The new PDF, as one of `cache_id`, `document_url` and `document_base64`.
|
|
34
|
+
* The new PDF, or a Word template's new Word document, as one of `cache_id`, `document_url` and `document_base64`.
|
|
35
35
|
* @alias module:model/UpdateTemplateDocumentRequest
|
|
36
36
|
*/
|
|
37
37
|
function UpdateTemplateDocumentRequest() {
|
|
@@ -108,31 +108,31 @@ var UpdateTemplateDocumentRequest = /*#__PURE__*/function () {
|
|
|
108
108
|
}]);
|
|
109
109
|
}();
|
|
110
110
|
/**
|
|
111
|
-
* The `fields.key` of the new PDF, uploaded with the presigned upload (GET /uploads/presign).
|
|
111
|
+
* The `fields.key` of the new PDF or Word document (.docx or .odt), uploaded with the presigned upload (GET /uploads/presign).
|
|
112
112
|
* @member {String} cache_id
|
|
113
113
|
*/
|
|
114
114
|
UpdateTemplateDocumentRequest.prototype['cache_id'] = undefined;
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
* An https:// link to the template's PDF (up to 100 MB),
|
|
117
|
+
* 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.
|
|
118
118
|
* @member {String} document_url
|
|
119
119
|
*/
|
|
120
120
|
UpdateTemplateDocumentRequest.prototype['document_url'] = undefined;
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* 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`.
|
|
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`.
|
|
124
124
|
* @member {String} document_base64
|
|
125
125
|
*/
|
|
126
126
|
UpdateTemplateDocumentRequest.prototype['document_base64'] = undefined;
|
|
127
127
|
|
|
128
128
|
/**
|
|
129
|
-
* The
|
|
129
|
+
* 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.
|
|
130
130
|
* @member {String} filename
|
|
131
131
|
*/
|
|
132
132
|
UpdateTemplateDocumentRequest.prototype['filename'] = undefined;
|
|
133
133
|
|
|
134
134
|
/**
|
|
135
|
-
* Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields.
|
|
135
|
+
* Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields. Only for PDF templates: a Word template adds a field for each new tag.
|
|
136
136
|
* @member {Boolean} reimport_fields
|
|
137
137
|
*/
|
|
138
138
|
UpdateTemplateDocumentRequest.prototype['reimport_fields'] = undefined;
|
|
@@ -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 UpdateTemplateFieldsRequest model module.
|
|
32
32
|
* @module model/UpdateTemplateFieldsRequest
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.3.0
|
|
34
34
|
*/
|
|
35
35
|
var UpdateTemplateFieldsRequest = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
@@ -9,6 +9,7 @@ var _AiFieldNamingLanguage = _interopRequireDefault(require("./AiFieldNamingLang
|
|
|
9
9
|
var _ExpirationInterval = _interopRequireDefault(require("./ExpirationInterval"));
|
|
10
10
|
var _FieldGroupInput = _interopRequireDefault(require("./FieldGroupInput"));
|
|
11
11
|
var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
|
|
12
|
+
var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
|
|
12
13
|
var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
|
|
13
14
|
var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
|
|
14
15
|
var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
|
|
@@ -24,7 +25,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
24
25
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
25
26
|
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); } /**
|
|
26
27
|
* DocSpring API
|
|
27
|
-
* Use DocSpring's API to
|
|
28
|
+
* 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.
|
|
28
29
|
*
|
|
29
30
|
* The version of the OpenAPI document: v2
|
|
30
31
|
*
|
|
@@ -37,7 +38,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
37
38
|
/**
|
|
38
39
|
* The UpdateTemplateRequest model module.
|
|
39
40
|
* @module model/UpdateTemplateRequest
|
|
40
|
-
* @version 4.
|
|
41
|
+
* @version 4.3.0
|
|
41
42
|
*/
|
|
42
43
|
var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
43
44
|
/**
|
|
@@ -77,6 +78,9 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
|
77
78
|
if (data.hasOwnProperty('description')) {
|
|
78
79
|
obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
|
|
79
80
|
}
|
|
81
|
+
if (data.hasOwnProperty('output_format')) {
|
|
82
|
+
obj['output_format'] = _ApiClient["default"].convertToType(data['output_format'], _OutputFormat["default"]);
|
|
83
|
+
}
|
|
80
84
|
if (data.hasOwnProperty('parent_folder_id')) {
|
|
81
85
|
obj['parent_folder_id'] = _ApiClient["default"].convertToType(data['parent_folder_id'], 'String');
|
|
82
86
|
}
|
|
@@ -178,6 +182,9 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
|
178
182
|
if (data.hasOwnProperty('html_engine_options')) {
|
|
179
183
|
obj['html_engine_options'] = _ApiClient["default"].convertToType(data['html_engine_options'], _HtmlEngineOptionsInput["default"]);
|
|
180
184
|
}
|
|
185
|
+
if (data.hasOwnProperty('html_escape_data')) {
|
|
186
|
+
obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
|
|
187
|
+
}
|
|
181
188
|
}
|
|
182
189
|
return obj;
|
|
183
190
|
}
|
|
@@ -323,6 +330,12 @@ UpdateTemplateRequest.prototype['name'] = undefined;
|
|
|
323
330
|
*/
|
|
324
331
|
UpdateTemplateRequest.prototype['description'] = undefined;
|
|
325
332
|
|
|
333
|
+
/**
|
|
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.
|
|
335
|
+
* @member {module:model/OutputFormat} output_format
|
|
336
|
+
*/
|
|
337
|
+
UpdateTemplateRequest.prototype['output_format'] = undefined;
|
|
338
|
+
|
|
326
339
|
/**
|
|
327
340
|
* 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.
|
|
328
341
|
* @member {String} parent_folder_id
|
|
@@ -360,7 +373,7 @@ UpdateTemplateRequest.prototype['allow_additional_properties'] = undefined;
|
|
|
360
373
|
UpdateTemplateRequest.prototype['allow_skipping_optional_fields'] = undefined;
|
|
361
374
|
|
|
362
375
|
/**
|
|
363
|
-
* 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).
|
|
376
|
+
* 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`.
|
|
364
377
|
* @member {module:model/TemplateFormMode} default_form_mode
|
|
365
378
|
*/
|
|
366
379
|
UpdateTemplateRequest.prototype['default_form_mode'] = undefined;
|
|
@@ -372,7 +385,7 @@ UpdateTemplateRequest.prototype['default_form_mode'] = undefined;
|
|
|
372
385
|
UpdateTemplateRequest.prototype['editable_submissions'] = undefined;
|
|
373
386
|
|
|
374
387
|
/**
|
|
375
|
-
* The sites
|
|
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.
|
|
376
389
|
* @member {Array.<String>} embed_domains
|
|
377
390
|
*/
|
|
378
391
|
UpdateTemplateRequest.prototype['embed_domains'] = undefined;
|
|
@@ -396,7 +409,7 @@ UpdateTemplateRequest.prototype['embed_edit_allow_versioning'] = undefined;
|
|
|
396
409
|
UpdateTemplateRequest.prototype['embed_edit_allow_document_replacement'] = undefined;
|
|
397
410
|
|
|
398
411
|
/**
|
|
399
|
-
* Encrypt generated PDFs with `encrypt_pdfs_password`.
|
|
412
|
+
* 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.
|
|
400
413
|
* @member {Boolean} encrypt_pdfs
|
|
401
414
|
*/
|
|
402
415
|
UpdateTemplateRequest.prototype['encrypt_pdfs'] = undefined;
|
|
@@ -432,7 +445,7 @@ UpdateTemplateRequest.prototype['expiration_interval'] = undefined;
|
|
|
432
445
|
UpdateTemplateRequest.prototype['merge_audit_trail_pdf'] = undefined;
|
|
433
446
|
|
|
434
447
|
/**
|
|
435
|
-
* 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.
|
|
448
|
+
* 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.
|
|
436
449
|
* @member {Boolean} parse_dates_using_template_date_format
|
|
437
450
|
*/
|
|
438
451
|
UpdateTemplateRequest.prototype['parse_dates_using_template_date_format'] = undefined;
|
|
@@ -492,7 +505,7 @@ UpdateTemplateRequest.prototype['predefined_fields'] = undefined;
|
|
|
492
505
|
UpdateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
|
|
493
506
|
|
|
494
507
|
/**
|
|
495
|
-
* The HTML of an HTML template, as a Liquid template. Null for PDF templates.
|
|
508
|
+
* The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
|
|
496
509
|
* @member {String} html
|
|
497
510
|
*/
|
|
498
511
|
UpdateTemplateRequest.prototype['html'] = undefined;
|
|
@@ -520,4 +533,10 @@ UpdateTemplateRequest.prototype['footer_html'] = undefined;
|
|
|
520
533
|
* @member {module:model/HtmlEngineOptionsInput} html_engine_options
|
|
521
534
|
*/
|
|
522
535
|
UpdateTemplateRequest.prototype['html_engine_options'] = undefined;
|
|
536
|
+
|
|
537
|
+
/**
|
|
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.
|
|
539
|
+
* @member {Boolean} html_escape_data
|
|
540
|
+
*/
|
|
541
|
+
UpdateTemplateRequest.prototype['html_escape_data'] = undefined;
|
|
523
542
|
var _default = exports["default"] = UpdateTemplateRequest;
|
|
@@ -15,7 +15,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
15
15
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
16
16
|
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); } /**
|
|
17
17
|
* DocSpring API
|
|
18
|
-
* Use DocSpring's API to
|
|
18
|
+
* 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.
|
|
19
19
|
*
|
|
20
20
|
* The version of the OpenAPI document: v2
|
|
21
21
|
*
|
|
@@ -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.
|
|
31
|
+
* @version 4.3.0
|
|
32
32
|
*/
|
|
33
33
|
var UpdateWebhookRequest = /*#__PURE__*/function () {
|
|
34
34
|
/**
|
|
@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
|
|
|
14
14
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
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
16
|
* DocSpring API
|
|
17
|
-
* Use DocSpring's API to
|
|
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
18
|
*
|
|
19
19
|
* The version of the OpenAPI document: v2
|
|
20
20
|
*
|
|
@@ -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 UploadPresign model module.
|
|
32
32
|
* @module model/UploadPresign
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.3.0
|
|
34
34
|
*/
|
|
35
35
|
var UploadPresign = /*#__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 UrlSourcePdf model module.
|
|
31
31
|
* @module model/UrlSourcePdf
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.3.0
|
|
33
33
|
*/
|
|
34
34
|
var UrlSourcePdf = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -19,7 +19,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
19
19
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
20
20
|
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); } /**
|
|
21
21
|
* DocSpring API
|
|
22
|
-
* Use DocSpring's API to
|
|
22
|
+
* 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.
|
|
23
23
|
*
|
|
24
24
|
* The version of the OpenAPI document: v2
|
|
25
25
|
*
|
|
@@ -32,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
32
32
|
/**
|
|
33
33
|
* The ValidateSubmissionRequest model module.
|
|
34
34
|
* @module model/ValidateSubmissionRequest
|
|
35
|
-
* @version 4.
|
|
35
|
+
* @version 4.3.0
|
|
36
36
|
*/
|
|
37
37
|
var ValidateSubmissionRequest = /*#__PURE__*/function () {
|
|
38
38
|
/**
|
|
@@ -171,25 +171,25 @@ ValidateSubmissionRequest.prototype['test'] = undefined;
|
|
|
171
171
|
ValidateSubmissionRequest.prototype['editable'] = undefined;
|
|
172
172
|
|
|
173
173
|
/**
|
|
174
|
-
* The values of the template's fields, by field name. Required for
|
|
174
|
+
* The values of the template's fields, by field name. Required for PDF and Word templates, unless `signature_requests` collects them (PDF templates only).
|
|
175
175
|
* @member {Object.<String, Object>} data
|
|
176
176
|
*/
|
|
177
177
|
ValidateSubmissionRequest.prototype['data'] = undefined;
|
|
178
178
|
|
|
179
179
|
/**
|
|
180
|
-
* Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
|
|
180
|
+
* Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
|
|
181
181
|
* @member {Object.<String, Object>} metadata
|
|
182
182
|
*/
|
|
183
183
|
ValidateSubmissionRequest.prototype['metadata'] = undefined;
|
|
184
184
|
|
|
185
185
|
/**
|
|
186
|
-
* A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
|
|
186
|
+
* A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
|
|
187
187
|
* @member {String} password
|
|
188
188
|
*/
|
|
189
189
|
ValidateSubmissionRequest.prototype['password'] = undefined;
|
|
190
190
|
|
|
191
191
|
/**
|
|
192
|
-
* What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
|
|
192
|
+
* What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
|
|
193
193
|
* @member {Array.<module:model/OutputFormat>} output_formats
|
|
194
194
|
*/
|
|
195
195
|
ValidateSubmissionRequest.prototype['output_formats'] = undefined;
|
|
@@ -213,7 +213,7 @@ ValidateSubmissionRequest.prototype['field_overrides'] = undefined;
|
|
|
213
213
|
ValidateSubmissionRequest.prototype['html'] = undefined;
|
|
214
214
|
|
|
215
215
|
/**
|
|
216
|
-
* For an HTML template, CSS
|
|
216
|
+
* For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity.
|
|
217
217
|
* @member {String} css
|
|
218
218
|
*/
|
|
219
219
|
ValidateSubmissionRequest.prototype['css'] = undefined;
|
package/dist/model/Webhook.js
CHANGED
|
@@ -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 Webhook model module.
|
|
33
33
|
* @module model/Webhook
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.3.0
|
|
35
35
|
*/
|
|
36
36
|
var Webhook = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
|
|
|
14
14
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
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
16
|
* DocSpring API
|
|
17
|
-
* Use DocSpring's API to
|
|
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
18
|
*
|
|
19
19
|
* The version of the OpenAPI document: v2
|
|
20
20
|
*
|
|
@@ -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 WebhookList model module.
|
|
32
32
|
* @module model/WebhookList
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.3.0
|
|
34
34
|
*/
|
|
35
35
|
var WebhookList = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
|
|
|
14
14
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
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
16
|
* DocSpring API
|
|
17
|
-
* Use DocSpring's API to
|
|
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
18
|
*
|
|
19
19
|
* The version of the OpenAPI document: v2
|
|
20
20
|
*
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docspring",
|
|
3
|
-
"version": "4.
|
|
4
|
-
"description": "An API client for
|
|
3
|
+
"version": "4.3.0",
|
|
4
|
+
"description": "An API client for DocSpring: fill PDF forms, generate PDFs and Word documents, and collect e-signatures",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"scripts": {
|
|
@@ -10,7 +10,8 @@
|
|
|
10
10
|
"test": "mocha --require @babel/register --recursive"
|
|
11
11
|
},
|
|
12
12
|
"browser": {
|
|
13
|
-
"fs": false
|
|
13
|
+
"fs": false,
|
|
14
|
+
"crypto": false
|
|
14
15
|
},
|
|
15
16
|
"dependencies": {
|
|
16
17
|
"@babel/cli": "^7.0.0",
|