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.
- package/README.md +20 -1
- package/dist/ApiClient.js +2 -2
- package/dist/RequestSchemas.js +1118 -93
- package/dist/RequestValidator.js +4 -0
- package/dist/api/Client.js +1360 -206
- package/dist/index.js +196 -0
- package/dist/model/AddTemplateFieldsRequest.js +3 -3
- package/dist/model/AuthenticationCheck.js +1 -1
- package/dist/model/CombinedPdf.js +1 -1
- package/dist/model/CombinedPdfFiles.js +1 -1
- package/dist/model/CombinedPdfList.js +1 -1
- package/dist/model/CombinedPdfSource.js +2 -2
- package/dist/model/CombinedPdfSourceInput.js +2 -2
- package/dist/model/CombinedPdfSourcePdf.js +1 -1
- package/dist/model/CopyTemplateRequest.js +1 -1
- package/dist/model/CreateAccountEmailActionRequest.js +306 -0
- package/dist/model/CreateCombinedPdfRequest.js +1 -1
- package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
- package/dist/model/CreateEmailActionRequest.js +280 -0
- package/dist/model/CreateEmailDomainRequest.js +114 -0
- package/dist/model/CreateFolderRequest.js +1 -1
- package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
- package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
- package/dist/model/CreateSubmissionBatchRequest.js +4 -4
- package/dist/model/CreateSubmissionRequest.js +112 -4
- package/dist/model/CreateTemplatePreviewRequest.js +1 -1
- package/dist/model/CreateTemplateRequest.js +103 -8
- package/dist/model/CreateWebhookRequest.js +1 -1
- package/dist/model/CustomFile.js +1 -1
- package/dist/model/CustomFileList.js +1 -1
- package/dist/model/CustomFileSourcePdf.js +1 -1
- 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 +10 -0
- package/dist/model/ErrorDetail.js +1 -1
- package/dist/model/ErrorInfo.js +46 -7
- package/dist/model/ErrorResponse.js +1 -1
- package/dist/model/Field.js +3 -3
- package/dist/model/FieldComparisonCondition.js +1 -1
- package/dist/model/FieldDependency.js +1 -1
- package/dist/model/FieldDependencyInput.js +1 -1
- package/dist/model/FieldEqualsCondition.js +1 -1
- package/dist/model/FieldGroup.js +1 -1
- package/dist/model/FieldGroupInput.js +1 -1
- package/dist/model/FieldInCondition.js +1 -1
- package/dist/model/FieldInput.js +2 -2
- package/dist/model/FieldOverride.js +1 -1
- package/dist/model/FieldPresenceCondition.js +1 -1
- package/dist/model/FieldRangeCondition.js +1 -1
- package/dist/model/Folder.js +1 -1
- package/dist/model/FolderList.js +1 -1
- package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
- package/dist/model/GeneratedFile.js +1 -1
- package/dist/model/HtmlEngineOptions.js +3 -3
- package/dist/model/HtmlEngineOptionsInput.js +2 -2
- package/dist/model/MoveFolderRequest.js +1 -1
- package/dist/model/MoveTemplateRequest.js +1 -1
- package/dist/model/PageImage.js +1 -1
- package/dist/model/PageImages.js +1 -1
- package/dist/model/PredefinedField.js +1 -1
- package/dist/model/PredefinedFieldInput.js +1 -1
- package/dist/model/PublishTemplateVersionRequest.js +1 -1
- package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
- package/dist/model/RenameFolderRequest.js +1 -1
- package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
- package/dist/model/RestoreTemplateVersionRequest.js +1 -1
- package/dist/model/SendAccountEmailActionTestEmailRequest.js +91 -0
- package/dist/model/SignatureRequest.js +52 -7
- package/dist/model/SignatureRequestEmailAttachments.js +59 -0
- package/dist/model/SignatureRequestEmailStatus.js +89 -0
- package/dist/model/SignatureRequestEvent.js +1 -1
- package/dist/model/SignatureRequestEventType.js +11 -1
- package/dist/model/SignatureRequestInput.js +24 -8
- package/dist/model/SignatureRequestReminders.js +121 -0
- package/dist/model/SignatureRequestToken.js +1 -1
- package/dist/model/SigningOrder.js +59 -0
- package/dist/model/StringConditionType.js +36 -1
- package/dist/model/Submission.js +21 -9
- package/dist/model/SubmissionAction.js +27 -12
- package/dist/model/SubmissionBatch.js +1 -1
- package/dist/model/SubmissionFiles.js +1 -1
- package/dist/model/SubmissionInput.js +4 -4
- package/dist/model/SubmissionList.js +1 -1
- package/dist/model/SubmissionSourcePdf.js +1 -1
- package/dist/model/SubmissionSummary.js +3 -3
- package/dist/model/SubmissionValidation.js +1 -1
- package/dist/model/Template.js +130 -19
- package/dist/model/TemplateActor.js +1 -1
- package/dist/model/TemplateDefaults.js +1 -1
- package/dist/model/TemplateDefaultsInput.js +1 -1
- package/dist/model/TemplateDiff.js +1 -1
- package/dist/model/TemplateDiffSummary.js +1 -1
- package/dist/model/TemplateDocument.js +1 -1
- package/dist/model/TemplateDocumentSummary.js +1 -1
- package/dist/model/TemplateFieldChange.js +1 -1
- package/dist/model/TemplateFieldChanges.js +1 -1
- package/dist/model/TemplateFieldDependency.js +1 -1
- package/dist/model/TemplateFieldDependencyCondition.js +1 -1
- package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
- package/dist/model/TemplateFieldDependencyInput.js +1 -1
- package/dist/model/TemplateFieldMove.js +1 -1
- package/dist/model/TemplateFields.js +1 -1
- package/dist/model/TemplateModelCode.js +1 -1
- package/dist/model/TemplatePageImages.js +1 -1
- package/dist/model/TemplatePageProcessingStatus.js +1 -1
- package/dist/model/TemplatePreview.js +1 -1
- package/dist/model/TemplateSourcePdf.js +2 -2
- package/dist/model/TemplateSummary.js +9 -9
- package/dist/model/TemplateSummaryList.js +1 -1
- package/dist/model/TemplateType.js +6 -1
- package/dist/model/TemplateVersion.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 +1 -1
- package/dist/model/UpdateTemplateDocumentRequest.js +2 -2
- package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
- package/dist/model/UpdateTemplateRequest.js +100 -5
- package/dist/model/UpdateWebhookRequest.js +1 -1
- package/dist/model/UploadPresign.js +1 -1
- package/dist/model/UrlSourcePdf.js +1 -1
- package/dist/model/ValidateSubmissionRequest.js +112 -4
- package/dist/model/Webhook.js +1 -1
- package/dist/model/WebhookEventType.js +10 -0
- package/dist/model/WebhookList.js +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,114 @@
|
|
|
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 _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
11
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
12
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
13
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
14
|
+
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); } }
|
|
15
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
16
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
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
|
+
* DocSpring API
|
|
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
|
+
*
|
|
21
|
+
* The version of the OpenAPI document: v2
|
|
22
|
+
*
|
|
23
|
+
*
|
|
24
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
25
|
+
* https://openapi-generator.tech
|
|
26
|
+
* Do not edit the class manually.
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
/**
|
|
30
|
+
* The CreateEmailDomainRequest model module.
|
|
31
|
+
* @module model/CreateEmailDomainRequest
|
|
32
|
+
* @version 4.4.0
|
|
33
|
+
*/
|
|
34
|
+
var CreateEmailDomainRequest = /*#__PURE__*/function () {
|
|
35
|
+
/**
|
|
36
|
+
* Constructs a new <code>CreateEmailDomainRequest</code>.
|
|
37
|
+
* The domain to add.
|
|
38
|
+
* @alias module:model/CreateEmailDomainRequest
|
|
39
|
+
* @param domain {String} The domain name, such as `example.com` or `mail.example.com`. Email actions can send from any address at it.
|
|
40
|
+
*/
|
|
41
|
+
function CreateEmailDomainRequest(domain) {
|
|
42
|
+
_classCallCheck(this, CreateEmailDomainRequest);
|
|
43
|
+
CreateEmailDomainRequest.initialize(this, domain);
|
|
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(CreateEmailDomainRequest, null, [{
|
|
52
|
+
key: "initialize",
|
|
53
|
+
value: function initialize(obj, domain) {
|
|
54
|
+
obj['domain'] = domain;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Constructs a <code>CreateEmailDomainRequest</code> from a plain JavaScript object, optionally creating a new instance.
|
|
59
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
60
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
61
|
+
* @param {module:model/CreateEmailDomainRequest} obj Optional instance to populate.
|
|
62
|
+
* @return {module:model/CreateEmailDomainRequest} The populated <code>CreateEmailDomainRequest</code> instance.
|
|
63
|
+
*/
|
|
64
|
+
}, {
|
|
65
|
+
key: "constructFromObject",
|
|
66
|
+
value: function constructFromObject(data, obj) {
|
|
67
|
+
if (data) {
|
|
68
|
+
obj = obj || new CreateEmailDomainRequest();
|
|
69
|
+
if (data.hasOwnProperty('domain')) {
|
|
70
|
+
obj['domain'] = _ApiClient["default"].convertToType(data['domain'], 'String');
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
return obj;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Validates the JSON data with respect to <code>CreateEmailDomainRequest</code>.
|
|
78
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
79
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateEmailDomainRequest</code>.
|
|
80
|
+
*/
|
|
81
|
+
}, {
|
|
82
|
+
key: "validateJSON",
|
|
83
|
+
value: function validateJSON(data) {
|
|
84
|
+
// check to make sure all required properties are present in the JSON string
|
|
85
|
+
var _iterator = _createForOfIteratorHelper(CreateEmailDomainRequest.RequiredProperties),
|
|
86
|
+
_step;
|
|
87
|
+
try {
|
|
88
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
89
|
+
var property = _step.value;
|
|
90
|
+
if (!data.hasOwnProperty(property)) {
|
|
91
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
// ensure the json data is a string
|
|
95
|
+
} catch (err) {
|
|
96
|
+
_iterator.e(err);
|
|
97
|
+
} finally {
|
|
98
|
+
_iterator.f();
|
|
99
|
+
}
|
|
100
|
+
if (data['domain'] && !(typeof data['domain'] === 'string' || data['domain'] instanceof String)) {
|
|
101
|
+
throw new Error("Expected the field `domain` to be a primitive type in the JSON string but got " + data['domain']);
|
|
102
|
+
}
|
|
103
|
+
return true;
|
|
104
|
+
}
|
|
105
|
+
}]);
|
|
106
|
+
}();
|
|
107
|
+
CreateEmailDomainRequest.RequiredProperties = ["domain"];
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* The domain name, such as `example.com` or `mail.example.com`. Email actions can send from any address at it.
|
|
111
|
+
* @member {String} domain
|
|
112
|
+
*/
|
|
113
|
+
CreateEmailDomainRequest.prototype['domain'] = undefined;
|
|
114
|
+
var _default = exports["default"] = CreateEmailDomainRequest;
|
|
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
29
29
|
/**
|
|
30
30
|
* The CreateFolderRequest model module.
|
|
31
31
|
* @module model/CreateFolderRequest
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.4.0
|
|
33
33
|
*/
|
|
34
34
|
var CreateFolderRequest = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
31
31
|
/**
|
|
32
32
|
* The CreateSignatureRequestEventRequest model module.
|
|
33
33
|
* @module model/CreateSignatureRequestEventRequest
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.4.0
|
|
35
35
|
*/
|
|
36
36
|
var CreateSignatureRequestEventRequest = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -27,7 +27,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
27
27
|
/**
|
|
28
28
|
* The CreateSignatureRequestTokenRequest model module.
|
|
29
29
|
* @module model/CreateSignatureRequestTokenRequest
|
|
30
|
-
* @version 4.
|
|
30
|
+
* @version 4.4.0
|
|
31
31
|
*/
|
|
32
32
|
var CreateSignatureRequestTokenRequest = /*#__PURE__*/function () {
|
|
33
33
|
/**
|
|
@@ -31,14 +31,14 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
31
31
|
/**
|
|
32
32
|
* The CreateSubmissionBatchRequest model module.
|
|
33
33
|
* @module model/CreateSubmissionBatchRequest
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.4.0
|
|
35
35
|
*/
|
|
36
36
|
var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
38
38
|
* Constructs a new <code>CreateSubmissionBatchRequest</code>.
|
|
39
39
|
* The submissions to create, and the settings they share.
|
|
40
40
|
* @alias module:model/CreateSubmissionBatchRequest
|
|
41
|
-
* @param submissions {Array.<module:model/SubmissionInput>} Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch.
|
|
41
|
+
* @param submissions {Array.<module:model/SubmissionInput>} Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests` and the options for DocSpring's emails to signers (`send_email`, `signing_order`, `email_subject`, `email_message`, `cc`, `reply_to`, `notification_emails`, `notify_when_signed` and `reminders`), plus `template_id` and `template_version` when it uses a different template from the batch.
|
|
42
42
|
*/
|
|
43
43
|
function CreateSubmissionBatchRequest(submissions) {
|
|
44
44
|
_classCallCheck(this, CreateSubmissionBatchRequest);
|
|
@@ -167,7 +167,7 @@ CreateSubmissionBatchRequest.prototype['metadata'] = undefined;
|
|
|
167
167
|
CreateSubmissionBatchRequest.prototype['template_id'] = undefined;
|
|
168
168
|
|
|
169
169
|
/**
|
|
170
|
-
* The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest`
|
|
170
|
+
* The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` (the newest published version, or the draft when none has been published) or `draft`. Default `latest`.
|
|
171
171
|
* @member {String} template_version
|
|
172
172
|
*/
|
|
173
173
|
CreateSubmissionBatchRequest.prototype['template_version'] = undefined;
|
|
@@ -185,7 +185,7 @@ CreateSubmissionBatchRequest.prototype['test'] = undefined;
|
|
|
185
185
|
CreateSubmissionBatchRequest.prototype['output_formats'] = undefined;
|
|
186
186
|
|
|
187
187
|
/**
|
|
188
|
-
* Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch.
|
|
188
|
+
* Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests` and the options for DocSpring's emails to signers (`send_email`, `signing_order`, `email_subject`, `email_message`, `cc`, `reply_to`, `notification_emails`, `notify_when_signed` and `reminders`), plus `template_id` and `template_version` when it uses a different template from the batch.
|
|
189
189
|
* @member {Array.<module:model/SubmissionInput>} submissions
|
|
190
190
|
*/
|
|
191
191
|
CreateSubmissionBatchRequest.prototype['submissions'] = undefined;
|
|
@@ -8,6 +8,8 @@ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
|
8
8
|
var _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
|
|
9
9
|
var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
|
|
10
10
|
var _SignatureRequestInput = _interopRequireDefault(require("./SignatureRequestInput"));
|
|
11
|
+
var _SignatureRequestReminders = _interopRequireDefault(require("./SignatureRequestReminders"));
|
|
12
|
+
var _SigningOrder = _interopRequireDefault(require("./SigningOrder"));
|
|
11
13
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
12
14
|
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); }
|
|
13
15
|
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
@@ -32,7 +34,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
32
34
|
/**
|
|
33
35
|
* The CreateSubmissionRequest model module.
|
|
34
36
|
* @module model/CreateSubmissionRequest
|
|
35
|
-
* @version 4.
|
|
37
|
+
* @version 4.4.0
|
|
36
38
|
*/
|
|
37
39
|
var CreateSubmissionRequest = /*#__PURE__*/function () {
|
|
38
40
|
/**
|
|
@@ -105,6 +107,33 @@ var CreateSubmissionRequest = /*#__PURE__*/function () {
|
|
|
105
107
|
if (data.hasOwnProperty('signature_requests')) {
|
|
106
108
|
obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequestInput["default"]]);
|
|
107
109
|
}
|
|
110
|
+
if (data.hasOwnProperty('send_email')) {
|
|
111
|
+
obj['send_email'] = _ApiClient["default"].convertToType(data['send_email'], 'Boolean');
|
|
112
|
+
}
|
|
113
|
+
if (data.hasOwnProperty('signing_order')) {
|
|
114
|
+
obj['signing_order'] = _ApiClient["default"].convertToType(data['signing_order'], _SigningOrder["default"]);
|
|
115
|
+
}
|
|
116
|
+
if (data.hasOwnProperty('email_subject')) {
|
|
117
|
+
obj['email_subject'] = _ApiClient["default"].convertToType(data['email_subject'], 'String');
|
|
118
|
+
}
|
|
119
|
+
if (data.hasOwnProperty('email_message')) {
|
|
120
|
+
obj['email_message'] = _ApiClient["default"].convertToType(data['email_message'], 'String');
|
|
121
|
+
}
|
|
122
|
+
if (data.hasOwnProperty('cc')) {
|
|
123
|
+
obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
|
|
124
|
+
}
|
|
125
|
+
if (data.hasOwnProperty('reply_to')) {
|
|
126
|
+
obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
|
|
127
|
+
}
|
|
128
|
+
if (data.hasOwnProperty('notification_emails')) {
|
|
129
|
+
obj['notification_emails'] = _ApiClient["default"].convertToType(data['notification_emails'], ['String']);
|
|
130
|
+
}
|
|
131
|
+
if (data.hasOwnProperty('notify_when_signed')) {
|
|
132
|
+
obj['notify_when_signed'] = _ApiClient["default"].convertToType(data['notify_when_signed'], 'Boolean');
|
|
133
|
+
}
|
|
134
|
+
if (data.hasOwnProperty('reminders')) {
|
|
135
|
+
obj['reminders'] = _ApiClient["default"].convertToType(data['reminders'], _SignatureRequestReminders["default"]);
|
|
136
|
+
}
|
|
108
137
|
}
|
|
109
138
|
return obj;
|
|
110
139
|
}
|
|
@@ -154,12 +183,37 @@ var CreateSubmissionRequest = /*#__PURE__*/function () {
|
|
|
154
183
|
}
|
|
155
184
|
;
|
|
156
185
|
}
|
|
186
|
+
// ensure the json data is a string
|
|
187
|
+
if (data['email_subject'] && !(typeof data['email_subject'] === 'string' || data['email_subject'] instanceof String)) {
|
|
188
|
+
throw new Error("Expected the field `email_subject` to be a primitive type in the JSON string but got " + data['email_subject']);
|
|
189
|
+
}
|
|
190
|
+
// ensure the json data is a string
|
|
191
|
+
if (data['email_message'] && !(typeof data['email_message'] === 'string' || data['email_message'] instanceof String)) {
|
|
192
|
+
throw new Error("Expected the field `email_message` to be a primitive type in the JSON string but got " + data['email_message']);
|
|
193
|
+
}
|
|
194
|
+
// ensure the json data is an array
|
|
195
|
+
if (!Array.isArray(data['cc'])) {
|
|
196
|
+
throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
|
|
197
|
+
}
|
|
198
|
+
// ensure the json data is a string
|
|
199
|
+
if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
|
|
200
|
+
throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
|
|
201
|
+
}
|
|
202
|
+
// ensure the json data is an array
|
|
203
|
+
if (!Array.isArray(data['notification_emails'])) {
|
|
204
|
+
throw new Error("Expected the field `notification_emails` to be an array in the JSON data but got " + data['notification_emails']);
|
|
205
|
+
}
|
|
206
|
+
// validate the optional field `reminders`
|
|
207
|
+
if (data['reminders']) {
|
|
208
|
+
// data not null
|
|
209
|
+
_SignatureRequestReminders["default"].validateJSON(data['reminders']);
|
|
210
|
+
}
|
|
157
211
|
return true;
|
|
158
212
|
}
|
|
159
213
|
}]);
|
|
160
214
|
}();
|
|
161
215
|
/**
|
|
162
|
-
* Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
|
|
216
|
+
* Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live.
|
|
163
217
|
* @member {Boolean} test
|
|
164
218
|
*/
|
|
165
219
|
CreateSubmissionRequest.prototype['test'] = undefined;
|
|
@@ -171,7 +225,7 @@ CreateSubmissionRequest.prototype['test'] = undefined;
|
|
|
171
225
|
CreateSubmissionRequest.prototype['editable'] = undefined;
|
|
172
226
|
|
|
173
227
|
/**
|
|
174
|
-
* The values of the template's fields, by field name. Required for PDF
|
|
228
|
+
* The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them (PDF templates only).
|
|
175
229
|
* @member {Object.<String, Object>} data
|
|
176
230
|
*/
|
|
177
231
|
CreateSubmissionRequest.prototype['data'] = undefined;
|
|
@@ -195,7 +249,7 @@ CreateSubmissionRequest.prototype['password'] = undefined;
|
|
|
195
249
|
CreateSubmissionRequest.prototype['output_formats'] = undefined;
|
|
196
250
|
|
|
197
251
|
/**
|
|
198
|
-
* Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
|
|
252
|
+
* Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
|
|
199
253
|
* @member {Number} expires_in
|
|
200
254
|
*/
|
|
201
255
|
CreateSubmissionRequest.prototype['expires_in'] = undefined;
|
|
@@ -223,4 +277,58 @@ CreateSubmissionRequest.prototype['css'] = undefined;
|
|
|
223
277
|
* @member {Array.<module:model/SignatureRequestInput>} signature_requests
|
|
224
278
|
*/
|
|
225
279
|
CreateSubmissionRequest.prototype['signature_requests'] = undefined;
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* Whether DocSpring emails the signers their signing links, and sends the reminders and the completed document. Default true. Each signature request's own `send_email` overrides it. A test submission only emails your DocSpring team: every other address is a 422. `true` needs `signature_requests`. DocSpring doesn't email the signers of a form library template: leave `send_email` out, and send them their links yourself.
|
|
283
|
+
* @member {Boolean} send_email
|
|
284
|
+
*/
|
|
285
|
+
CreateSubmissionRequest.prototype['send_email'] = undefined;
|
|
286
|
+
|
|
287
|
+
/**
|
|
288
|
+
* `parallel` (the default): everyone can sign at once. `sequential`: people sign one step at a time (`signing_step`), and DocSpring emails each step when the one before it is done. Needs `signature_requests`.
|
|
289
|
+
* @member {module:model/SigningOrder} signing_order
|
|
290
|
+
*/
|
|
291
|
+
CreateSubmissionRequest.prototype['signing_order'] = undefined;
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* The subject of the emails that ask people to sign. You can use `{{ signer.name }}`, `{{ signer.email }}`, `{{ document.name }}`, `{{ sender.name }}` and `{{ account.name }}`. Default "<sender> sent you <document> to sign" when you leave it out (a blank subject is a 422). Links and web addresses are shown as plain text (`example[.]com`).
|
|
295
|
+
* @member {String} email_subject
|
|
296
|
+
*/
|
|
297
|
+
CreateSubmissionRequest.prototype['email_subject'] = undefined;
|
|
298
|
+
|
|
299
|
+
/**
|
|
300
|
+
* A message for the people who sign, shown above the signing button. It takes the same variables as `email_subject`. Links and web addresses are shown as plain text. Leave it out for none: a blank message is a 422.
|
|
301
|
+
* @member {String} email_message
|
|
302
|
+
*/
|
|
303
|
+
CreateSubmissionRequest.prototype['email_message'] = undefined;
|
|
304
|
+
|
|
305
|
+
/**
|
|
306
|
+
* People who get a copy of the completed document. They don't sign.
|
|
307
|
+
* @member {Array.<String>} cc
|
|
308
|
+
*/
|
|
309
|
+
CreateSubmissionRequest.prototype['cc'] = undefined;
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Where replies to the emails go: a member of your DocSpring team, or an address at one of your verified email domains. Leave it out for the template's reply-to address (the account owner when it has none).
|
|
313
|
+
* @member {String} reply_to
|
|
314
|
+
*/
|
|
315
|
+
CreateSubmissionRequest.prototype['reply_to'] = undefined;
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* Who DocSpring tells when the 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. Leave it out for the template's notification addresses (the account owner when it has none); an empty list means the account owner.
|
|
319
|
+
* @member {Array.<String>} notification_emails
|
|
320
|
+
*/
|
|
321
|
+
CreateSubmissionRequest.prototype['notification_emails'] = undefined;
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Also email `notification_emails` each time someone signs. Default false.
|
|
325
|
+
* @member {Boolean} notify_when_signed
|
|
326
|
+
*/
|
|
327
|
+
CreateSubmissionRequest.prototype['notify_when_signed'] = undefined;
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* Remind people who haven't signed: every `interval_days` days, up to `max_count` times. Each reminder has a new signing link. Without it, DocSpring sends no reminders.
|
|
331
|
+
* @member {module:model/SignatureRequestReminders} reminders
|
|
332
|
+
*/
|
|
333
|
+
CreateSubmissionRequest.prototype['reminders'] = undefined;
|
|
226
334
|
var _default = exports["default"] = CreateSubmissionRequest;
|
|
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
29
29
|
/**
|
|
30
30
|
* The CreateTemplatePreviewRequest model module.
|
|
31
31
|
* @module model/CreateTemplatePreviewRequest
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.4.0
|
|
33
33
|
*/
|
|
34
34
|
var CreateTemplatePreviewRequest = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -13,6 +13,7 @@ var _FieldSetupSource = _interopRequireDefault(require("./FieldSetupSource"));
|
|
|
13
13
|
var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
|
|
14
14
|
var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
|
|
15
15
|
var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
|
|
16
|
+
var _SignatureRequestEmailAttachments = _interopRequireDefault(require("./SignatureRequestEmailAttachments"));
|
|
16
17
|
var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
|
|
17
18
|
var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
|
|
18
19
|
var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
|
|
@@ -41,14 +42,14 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
41
42
|
/**
|
|
42
43
|
* The CreateTemplateRequest model module.
|
|
43
44
|
* @module model/CreateTemplateRequest
|
|
44
|
-
* @version 4.
|
|
45
|
+
* @version 4.4.0
|
|
45
46
|
*/
|
|
46
47
|
var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
47
48
|
/**
|
|
48
49
|
* Constructs a new <code>CreateTemplateRequest</code>.
|
|
49
50
|
* The template to create.
|
|
50
51
|
* @alias module:model/CreateTemplateRequest
|
|
51
|
-
* @param template_type {module:model/TemplateType} `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created.
|
|
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.
|
|
52
53
|
*/
|
|
53
54
|
function CreateTemplateRequest(template_type) {
|
|
54
55
|
_classCallCheck(this, CreateTemplateRequest);
|
|
@@ -156,6 +157,27 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
|
156
157
|
if (data.hasOwnProperty('redirect_url')) {
|
|
157
158
|
obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
|
|
158
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
|
+
}
|
|
159
181
|
if (data.hasOwnProperty('slack_webhook_url')) {
|
|
160
182
|
obj['slack_webhook_url'] = _ApiClient["default"].convertToType(data['slack_webhook_url'], 'String');
|
|
161
183
|
}
|
|
@@ -191,6 +213,11 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
|
191
213
|
if (data.hasOwnProperty('html_escape_data')) {
|
|
192
214
|
obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
|
|
193
215
|
}
|
|
216
|
+
if (data.hasOwnProperty('layout')) {
|
|
217
|
+
obj['layout'] = _ApiClient["default"].convertToType(data['layout'], {
|
|
218
|
+
'String': Object
|
|
219
|
+
});
|
|
220
|
+
}
|
|
194
221
|
if (data.hasOwnProperty('cache_id')) {
|
|
195
222
|
obj['cache_id'] = _ApiClient["default"].convertToType(data['cache_id'], 'String');
|
|
196
223
|
}
|
|
@@ -267,6 +294,26 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
|
|
|
267
294
|
throw new Error("Expected the field `redirect_url` to be a primitive type in the JSON string but got " + data['redirect_url']);
|
|
268
295
|
}
|
|
269
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
|
|
270
317
|
if (data['slack_webhook_url'] && !(typeof data['slack_webhook_url'] === 'string' || data['slack_webhook_url'] instanceof String)) {
|
|
271
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']);
|
|
272
319
|
}
|
|
@@ -373,13 +420,13 @@ CreateTemplateRequest.prototype['name'] = undefined;
|
|
|
373
420
|
CreateTemplateRequest.prototype['description'] = undefined;
|
|
374
421
|
|
|
375
422
|
/**
|
|
376
|
-
* `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created.
|
|
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.
|
|
377
424
|
* @member {module:model/TemplateType} template_type
|
|
378
425
|
*/
|
|
379
426
|
CreateTemplateRequest.prototype['template_type'] = undefined;
|
|
380
427
|
|
|
381
428
|
/**
|
|
382
|
-
* 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;
|
|
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.
|
|
383
430
|
* @member {module:model/OutputFormat} output_format
|
|
384
431
|
*/
|
|
385
432
|
CreateTemplateRequest.prototype['output_format'] = undefined;
|
|
@@ -433,7 +480,7 @@ CreateTemplateRequest.prototype['default_form_mode'] = undefined;
|
|
|
433
480
|
CreateTemplateRequest.prototype['editable_submissions'] = undefined;
|
|
434
481
|
|
|
435
482
|
/**
|
|
436
|
-
* 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.
|
|
437
484
|
* @member {Array.<String>} embed_domains
|
|
438
485
|
*/
|
|
439
486
|
CreateTemplateRequest.prototype['embed_domains'] = undefined;
|
|
@@ -516,6 +563,48 @@ CreateTemplateRequest.prototype['public_web_form'] = undefined;
|
|
|
516
563
|
*/
|
|
517
564
|
CreateTemplateRequest.prototype['redirect_url'] = undefined;
|
|
518
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
|
+
|
|
519
608
|
/**
|
|
520
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.
|
|
521
610
|
* @member {String} slack_webhook_url
|
|
@@ -547,7 +636,7 @@ CreateTemplateRequest.prototype['predefined_fields'] = undefined;
|
|
|
547
636
|
CreateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
|
|
548
637
|
|
|
549
638
|
/**
|
|
550
|
-
* 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.
|
|
551
640
|
* @member {String} html
|
|
552
641
|
*/
|
|
553
642
|
CreateTemplateRequest.prototype['html'] = undefined;
|
|
@@ -577,11 +666,17 @@ CreateTemplateRequest.prototype['footer_html'] = undefined;
|
|
|
577
666
|
CreateTemplateRequest.prototype['html_engine_options'] = undefined;
|
|
578
667
|
|
|
579
668
|
/**
|
|
580
|
-
* 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.
|
|
581
670
|
* @member {Boolean} html_escape_data
|
|
582
671
|
*/
|
|
583
672
|
CreateTemplateRequest.prototype['html_escape_data'] = undefined;
|
|
584
673
|
|
|
674
|
+
/**
|
|
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
|
+
|
|
585
680
|
/**
|
|
586
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.
|
|
587
682
|
* @member {String} cache_id
|
|
@@ -595,7 +690,7 @@ CreateTemplateRequest.prototype['cache_id'] = undefined;
|
|
|
595
690
|
CreateTemplateRequest.prototype['document_url'] = undefined;
|
|
596
691
|
|
|
597
692
|
/**
|
|
598
|
-
* 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`.
|
|
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`.
|
|
599
694
|
* @member {String} document_base64
|
|
600
695
|
*/
|
|
601
696
|
CreateTemplateRequest.prototype['document_base64'] = undefined;
|
|
@@ -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
|
@@ -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
|
/**
|
|
@@ -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
|
/**
|