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
|
@@ -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 SignatureRequestInput model module.
|
|
33
33
|
* @module model/SignatureRequestInput
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.4.0
|
|
35
35
|
*/
|
|
36
36
|
var SignatureRequestInput = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -39,11 +39,10 @@ var SignatureRequestInput = /*#__PURE__*/function () {
|
|
|
39
39
|
* A request for someone to fill in their fields of a submission and sign it. Someone who only fills in fields for the people who sign later (such as an employer's section) has a signature request too. The submission's PDF is generated once every signature request is completed.
|
|
40
40
|
* @alias module:model/SignatureRequestInput
|
|
41
41
|
* @param fields {Array.<String>} The fields this person fills in. Each field can only be in one signature request, and a field that `data` fills in needs `prefilled_values_editable`.
|
|
42
|
-
* @param auth_type {module:model/SignatureRequestAuthType} How your app authenticated the person before it showed them the signature request.
|
|
43
42
|
*/
|
|
44
|
-
function SignatureRequestInput(fields
|
|
43
|
+
function SignatureRequestInput(fields) {
|
|
45
44
|
_classCallCheck(this, SignatureRequestInput);
|
|
46
|
-
SignatureRequestInput.initialize(this, fields
|
|
45
|
+
SignatureRequestInput.initialize(this, fields);
|
|
47
46
|
}
|
|
48
47
|
|
|
49
48
|
/**
|
|
@@ -53,9 +52,8 @@ var SignatureRequestInput = /*#__PURE__*/function () {
|
|
|
53
52
|
*/
|
|
54
53
|
return _createClass(SignatureRequestInput, null, [{
|
|
55
54
|
key: "initialize",
|
|
56
|
-
value: function initialize(obj, fields
|
|
55
|
+
value: function initialize(obj, fields) {
|
|
57
56
|
obj['fields'] = fields;
|
|
58
|
-
obj['auth_type'] = auth_type;
|
|
59
57
|
}
|
|
60
58
|
|
|
61
59
|
/**
|
|
@@ -117,6 +115,12 @@ var SignatureRequestInput = /*#__PURE__*/function () {
|
|
|
117
115
|
if (data.hasOwnProperty('prefilled_values_editable')) {
|
|
118
116
|
obj['prefilled_values_editable'] = _ApiClient["default"].convertToType(data['prefilled_values_editable'], 'Boolean');
|
|
119
117
|
}
|
|
118
|
+
if (data.hasOwnProperty('send_email')) {
|
|
119
|
+
obj['send_email'] = _ApiClient["default"].convertToType(data['send_email'], 'Boolean');
|
|
120
|
+
}
|
|
121
|
+
if (data.hasOwnProperty('signing_step')) {
|
|
122
|
+
obj['signing_step'] = _ApiClient["default"].convertToType(data['signing_step'], 'Number');
|
|
123
|
+
}
|
|
120
124
|
}
|
|
121
125
|
return obj;
|
|
122
126
|
}
|
|
@@ -184,7 +188,7 @@ var SignatureRequestInput = /*#__PURE__*/function () {
|
|
|
184
188
|
}
|
|
185
189
|
}]);
|
|
186
190
|
}();
|
|
187
|
-
SignatureRequestInput.RequiredProperties = ["fields"
|
|
191
|
+
SignatureRequestInput.RequiredProperties = ["fields"];
|
|
188
192
|
|
|
189
193
|
/**
|
|
190
194
|
* The name of the person the request is for.
|
|
@@ -193,7 +197,7 @@ SignatureRequestInput.RequiredProperties = ["fields", "auth_type"];
|
|
|
193
197
|
SignatureRequestInput.prototype['name'] = undefined;
|
|
194
198
|
|
|
195
199
|
/**
|
|
196
|
-
* Their email address.
|
|
200
|
+
* Their email address. Null when they have none.
|
|
197
201
|
* @member {String} email
|
|
198
202
|
*/
|
|
199
203
|
SignatureRequestInput.prototype['email'] = undefined;
|
|
@@ -275,4 +279,16 @@ SignatureRequestInput.prototype['ignore_unknown_fields'] = undefined;
|
|
|
275
279
|
* @member {Boolean} prefilled_values_editable
|
|
276
280
|
*/
|
|
277
281
|
SignatureRequestInput.prototype['prefilled_values_editable'] = undefined;
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Whether DocSpring emails this person their signing link. Default: the submission's `send_email`. Set it to false for someone who signs in your app (embedded signing) or whose link you send yourself. When DocSpring emails them, `email` is required and `auth_type` is `email_link` (the default). Otherwise `auth_type` is required.
|
|
285
|
+
* @member {Boolean} send_email
|
|
286
|
+
*/
|
|
287
|
+
SignatureRequestInput.prototype['send_email'] = undefined;
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* When this person signs, with `signing_order: sequential`: everyone in step 1 first, then step 2, and so on. People in the same step sign in any order. Only the order of the numbers matters. Either every signature request has a `signing_step` or none does; without them, each person is a step of their own, in the order of `signature_requests`.
|
|
291
|
+
* @member {Number} signing_step
|
|
292
|
+
*/
|
|
293
|
+
SignatureRequestInput.prototype['signing_step'] = undefined;
|
|
278
294
|
var _default = exports["default"] = SignatureRequestInput;
|
|
@@ -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
|
*
|
|
@@ -0,0 +1,121 @@
|
|
|
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 SignatureRequestReminders model module.
|
|
31
|
+
* @module model/SignatureRequestReminders
|
|
32
|
+
* @version 4.4.0
|
|
33
|
+
*/
|
|
34
|
+
var SignatureRequestReminders = /*#__PURE__*/function () {
|
|
35
|
+
/**
|
|
36
|
+
* Constructs a new <code>SignatureRequestReminders</code>.
|
|
37
|
+
* How often DocSpring reminds people who haven't signed.
|
|
38
|
+
* @alias module:model/SignatureRequestReminders
|
|
39
|
+
* @param interval_days {Number} Days between reminders.
|
|
40
|
+
* @param max_count {Number} The most reminders each person gets.
|
|
41
|
+
*/
|
|
42
|
+
function SignatureRequestReminders(interval_days, max_count) {
|
|
43
|
+
_classCallCheck(this, SignatureRequestReminders);
|
|
44
|
+
SignatureRequestReminders.initialize(this, interval_days, max_count);
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Initializes the fields of this object.
|
|
49
|
+
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
50
|
+
* Only for internal use.
|
|
51
|
+
*/
|
|
52
|
+
return _createClass(SignatureRequestReminders, null, [{
|
|
53
|
+
key: "initialize",
|
|
54
|
+
value: function initialize(obj, interval_days, max_count) {
|
|
55
|
+
obj['interval_days'] = interval_days;
|
|
56
|
+
obj['max_count'] = max_count;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/**
|
|
60
|
+
* Constructs a <code>SignatureRequestReminders</code> from a plain JavaScript object, optionally creating a new instance.
|
|
61
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
62
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
63
|
+
* @param {module:model/SignatureRequestReminders} obj Optional instance to populate.
|
|
64
|
+
* @return {module:model/SignatureRequestReminders} The populated <code>SignatureRequestReminders</code> instance.
|
|
65
|
+
*/
|
|
66
|
+
}, {
|
|
67
|
+
key: "constructFromObject",
|
|
68
|
+
value: function constructFromObject(data, obj) {
|
|
69
|
+
if (data) {
|
|
70
|
+
obj = obj || new SignatureRequestReminders();
|
|
71
|
+
if (data.hasOwnProperty('interval_days')) {
|
|
72
|
+
obj['interval_days'] = _ApiClient["default"].convertToType(data['interval_days'], 'Number');
|
|
73
|
+
}
|
|
74
|
+
if (data.hasOwnProperty('max_count')) {
|
|
75
|
+
obj['max_count'] = _ApiClient["default"].convertToType(data['max_count'], 'Number');
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
return obj;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Validates the JSON data with respect to <code>SignatureRequestReminders</code>.
|
|
83
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
84
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>SignatureRequestReminders</code>.
|
|
85
|
+
*/
|
|
86
|
+
}, {
|
|
87
|
+
key: "validateJSON",
|
|
88
|
+
value: function validateJSON(data) {
|
|
89
|
+
// check to make sure all required properties are present in the JSON string
|
|
90
|
+
var _iterator = _createForOfIteratorHelper(SignatureRequestReminders.RequiredProperties),
|
|
91
|
+
_step;
|
|
92
|
+
try {
|
|
93
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
94
|
+
var property = _step.value;
|
|
95
|
+
if (!data.hasOwnProperty(property)) {
|
|
96
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
} catch (err) {
|
|
100
|
+
_iterator.e(err);
|
|
101
|
+
} finally {
|
|
102
|
+
_iterator.f();
|
|
103
|
+
}
|
|
104
|
+
return true;
|
|
105
|
+
}
|
|
106
|
+
}]);
|
|
107
|
+
}();
|
|
108
|
+
SignatureRequestReminders.RequiredProperties = ["interval_days", "max_count"];
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Days between reminders.
|
|
112
|
+
* @member {Number} interval_days
|
|
113
|
+
*/
|
|
114
|
+
SignatureRequestReminders.prototype['interval_days'] = undefined;
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* The most reminders each person gets.
|
|
118
|
+
* @member {Number} max_count
|
|
119
|
+
*/
|
|
120
|
+
SignatureRequestReminders.prototype['max_count'] = undefined;
|
|
121
|
+
var _default = exports["default"] = SignatureRequestReminders;
|
|
@@ -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 SignatureRequestToken model module.
|
|
32
32
|
* @module model/SignatureRequestToken
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.4.0
|
|
34
34
|
*/
|
|
35
35
|
var SignatureRequestToken = /*#__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
|
*
|
|
@@ -0,0 +1,59 @@
|
|
|
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 SigningOrder.
|
|
29
|
+
* @enum {}
|
|
30
|
+
* @readonly
|
|
31
|
+
*/
|
|
32
|
+
var SigningOrder = exports["default"] = /*#__PURE__*/function () {
|
|
33
|
+
function SigningOrder() {
|
|
34
|
+
_classCallCheck(this, SigningOrder);
|
|
35
|
+
}
|
|
36
|
+
return _createClass(SigningOrder, null, [{
|
|
37
|
+
key: "constructFromObject",
|
|
38
|
+
value:
|
|
39
|
+
/**
|
|
40
|
+
* Returns a <code>SigningOrder</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/SigningOrder} The enum <code>SigningOrder</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: "parallel"
|
|
52
|
+
* @const
|
|
53
|
+
*/
|
|
54
|
+
_defineProperty(SigningOrder, "parallel", "parallel");
|
|
55
|
+
/**
|
|
56
|
+
* value: "sequential"
|
|
57
|
+
* @const
|
|
58
|
+
*/
|
|
59
|
+
_defineProperty(SigningOrder, "sequential", "sequential");
|
|
@@ -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
|
*
|
|
@@ -52,23 +52,58 @@ var StringConditionType = exports["default"] = /*#__PURE__*/function () {
|
|
|
52
52
|
* @const
|
|
53
53
|
*/
|
|
54
54
|
_defineProperty(StringConditionType, "equals", "equals");
|
|
55
|
+
/**
|
|
56
|
+
* value: "not_equals"
|
|
57
|
+
* @const
|
|
58
|
+
*/
|
|
59
|
+
_defineProperty(StringConditionType, "not_equals", "not_equals");
|
|
55
60
|
/**
|
|
56
61
|
* value: "contains"
|
|
57
62
|
* @const
|
|
58
63
|
*/
|
|
59
64
|
_defineProperty(StringConditionType, "contains", "contains");
|
|
65
|
+
/**
|
|
66
|
+
* value: "not_contains"
|
|
67
|
+
* @const
|
|
68
|
+
*/
|
|
69
|
+
_defineProperty(StringConditionType, "not_contains", "not_contains");
|
|
60
70
|
/**
|
|
61
71
|
* value: "starts_with"
|
|
62
72
|
* @const
|
|
63
73
|
*/
|
|
64
74
|
_defineProperty(StringConditionType, "starts_with", "starts_with");
|
|
75
|
+
/**
|
|
76
|
+
* value: "not_starts_with"
|
|
77
|
+
* @const
|
|
78
|
+
*/
|
|
79
|
+
_defineProperty(StringConditionType, "not_starts_with", "not_starts_with");
|
|
65
80
|
/**
|
|
66
81
|
* value: "ends_with"
|
|
67
82
|
* @const
|
|
68
83
|
*/
|
|
69
84
|
_defineProperty(StringConditionType, "ends_with", "ends_with");
|
|
85
|
+
/**
|
|
86
|
+
* value: "not_ends_with"
|
|
87
|
+
* @const
|
|
88
|
+
*/
|
|
89
|
+
_defineProperty(StringConditionType, "not_ends_with", "not_ends_with");
|
|
70
90
|
/**
|
|
71
91
|
* value: "regex"
|
|
72
92
|
* @const
|
|
73
93
|
*/
|
|
74
|
-
_defineProperty(StringConditionType, "regex", "regex");
|
|
94
|
+
_defineProperty(StringConditionType, "regex", "regex");
|
|
95
|
+
/**
|
|
96
|
+
* value: "not_regex"
|
|
97
|
+
* @const
|
|
98
|
+
*/
|
|
99
|
+
_defineProperty(StringConditionType, "not_regex", "not_regex");
|
|
100
|
+
/**
|
|
101
|
+
* value: "blank"
|
|
102
|
+
* @const
|
|
103
|
+
*/
|
|
104
|
+
_defineProperty(StringConditionType, "blank", "blank");
|
|
105
|
+
/**
|
|
106
|
+
* value: "not_blank"
|
|
107
|
+
* @const
|
|
108
|
+
*/
|
|
109
|
+
_defineProperty(StringConditionType, "not_blank", "not_blank");
|
package/dist/model/Submission.js
CHANGED
|
@@ -8,6 +8,7 @@ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
|
8
8
|
var _ErrorDetail = _interopRequireDefault(require("./ErrorDetail"));
|
|
9
9
|
var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
|
|
10
10
|
var _SignatureRequest = _interopRequireDefault(require("./SignatureRequest"));
|
|
11
|
+
var _SigningOrder = _interopRequireDefault(require("./SigningOrder"));
|
|
11
12
|
var _SubmissionAction = _interopRequireDefault(require("./SubmissionAction"));
|
|
12
13
|
var _SubmissionFiles = _interopRequireDefault(require("./SubmissionFiles"));
|
|
13
14
|
var _SubmissionSource = _interopRequireDefault(require("./SubmissionSource"));
|
|
@@ -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,28 +38,28 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
37
38
|
/**
|
|
38
39
|
* The Submission model module.
|
|
39
40
|
* @module model/Submission
|
|
40
|
-
* @version 4.
|
|
41
|
+
* @version 4.4.0
|
|
41
42
|
*/
|
|
42
43
|
var Submission = /*#__PURE__*/function () {
|
|
43
44
|
/**
|
|
44
45
|
* Constructs a new <code>Submission</code>.
|
|
45
|
-
* Data submitted to a template, and the
|
|
46
|
+
* Data submitted to a template, and the files generated from it (a PDF, a Word document, an OpenDocument file, or more than one of them).
|
|
46
47
|
* @alias module:model/Submission
|
|
47
48
|
* @extends Object
|
|
48
49
|
* @param id {String} The submission's ID.
|
|
49
50
|
* @param template_id {String} Null once the template has been permanently deleted.
|
|
50
|
-
* @param template_type {module:model/TemplateType} The template's type: `pdf` or `
|
|
51
|
+
* @param template_type {module:model/TemplateType} The template's type: `pdf`, `html` or `docx`.
|
|
51
52
|
* @param template_version {String} The published version of the template the submission used. Null for the draft.
|
|
52
53
|
* @param batch_id {String} The ID of the batch the submission was created in.
|
|
53
54
|
* @param source {module:model/SubmissionSource} `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
|
|
54
|
-
* @param state {module:model/SubmissionState} `pending` until the
|
|
55
|
-
* @param test {Boolean} Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
|
|
55
|
+
* @param state {module:model/SubmissionState} `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
|
|
56
|
+
* @param test {Boolean} 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.
|
|
56
57
|
* @param editable {Boolean} `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
|
|
57
58
|
* @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data.
|
|
58
59
|
* @param data_errors {Array.<module:model/ErrorDetail>} Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
|
|
59
60
|
* @param error_message {String} Why the PDF couldn't be generated, when `state` is `error`.
|
|
60
61
|
* @param metadata {Object.<String, Object>} 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`).
|
|
61
|
-
* @param files {module:model/SubmissionFiles} The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
|
|
62
|
+
* @param files {module:model/SubmissionFiles} The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
|
|
62
63
|
* @param expired {Boolean} An expired submission's data, metadata, password and PDF have been deleted.
|
|
63
64
|
* @param expires_at {Date} When the submission expires. Null if it's kept until you delete it.
|
|
64
65
|
* @param processed_at {Date} When the PDF was generated. Null until then.
|
|
@@ -66,14 +67,15 @@ var Submission = /*#__PURE__*/function () {
|
|
|
66
67
|
* @param updated_at {Date} When the submission was last updated.
|
|
67
68
|
* @param has_password {Boolean} Whether the PDF needs a password to open (`password`).
|
|
68
69
|
* @param signature_requests {Array.<module:model/SignatureRequest>} The people asked to sign the submission (and fill in their fields), in order.
|
|
69
|
-
* @param
|
|
70
|
+
* @param signing_order {module:model/SigningOrder} `parallel`: everyone can sign at once. `sequential`: people sign one step at a time (each signature request's `signing_step`).
|
|
71
|
+
* @param actions {Array.<module:model/SubmissionAction>} The uploads of the submission's PDF to your storage (account integrations), and the emails its template's email actions sent.
|
|
70
72
|
* @param truncated_text {Object.<String, Array.<String>>} The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
|
|
71
|
-
* @param output_formats {Array.<module:model/OutputFormat>} 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.
|
|
73
|
+
* @param output_formats {Array.<module:model/OutputFormat>} 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.
|
|
72
74
|
* @param preview_generated_at {Date} When the preview PDF was generated. Null if there is no preview.
|
|
73
75
|
*/
|
|
74
|
-
function Submission(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at) {
|
|
76
|
+
function Submission(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, signing_order, actions, truncated_text, output_formats, preview_generated_at) {
|
|
75
77
|
_classCallCheck(this, Submission);
|
|
76
|
-
Submission.initialize(this, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at);
|
|
78
|
+
Submission.initialize(this, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, signing_order, actions, truncated_text, output_formats, preview_generated_at);
|
|
77
79
|
}
|
|
78
80
|
|
|
79
81
|
/**
|
|
@@ -83,7 +85,7 @@ var Submission = /*#__PURE__*/function () {
|
|
|
83
85
|
*/
|
|
84
86
|
return _createClass(Submission, null, [{
|
|
85
87
|
key: "initialize",
|
|
86
|
-
value: function initialize(obj, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at) {
|
|
88
|
+
value: function initialize(obj, id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, signing_order, actions, truncated_text, output_formats, preview_generated_at) {
|
|
87
89
|
obj['id'] = id;
|
|
88
90
|
obj['template_id'] = template_id;
|
|
89
91
|
obj['template_type'] = template_type;
|
|
@@ -105,6 +107,7 @@ var Submission = /*#__PURE__*/function () {
|
|
|
105
107
|
obj['updated_at'] = updated_at;
|
|
106
108
|
obj['has_password'] = has_password;
|
|
107
109
|
obj['signature_requests'] = signature_requests;
|
|
110
|
+
obj['signing_order'] = signing_order;
|
|
108
111
|
obj['actions'] = actions;
|
|
109
112
|
obj['truncated_text'] = truncated_text;
|
|
110
113
|
obj['output_formats'] = output_formats;
|
|
@@ -191,6 +194,9 @@ var Submission = /*#__PURE__*/function () {
|
|
|
191
194
|
if (data.hasOwnProperty('signature_requests')) {
|
|
192
195
|
obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequest["default"]]);
|
|
193
196
|
}
|
|
197
|
+
if (data.hasOwnProperty('signing_order')) {
|
|
198
|
+
obj['signing_order'] = _ApiClient["default"].convertToType(data['signing_order'], _SigningOrder["default"]);
|
|
199
|
+
}
|
|
194
200
|
if (data.hasOwnProperty('actions')) {
|
|
195
201
|
obj['actions'] = _ApiClient["default"].convertToType(data['actions'], [_SubmissionAction["default"]]);
|
|
196
202
|
}
|
|
@@ -272,7 +278,7 @@ var Submission = /*#__PURE__*/function () {
|
|
|
272
278
|
}
|
|
273
279
|
}]);
|
|
274
280
|
}();
|
|
275
|
-
Submission.RequiredProperties = ["id", "template_id", "template_type", "template_version", "batch_id", "source", "state", "test", "editable", "data", "data_errors", "error_message", "metadata", "files", "expired", "expires_at", "processed_at", "created_at", "updated_at", "has_password", "signature_requests", "actions", "truncated_text", "output_formats", "preview_generated_at"];
|
|
281
|
+
Submission.RequiredProperties = ["id", "template_id", "template_type", "template_version", "batch_id", "source", "state", "test", "editable", "data", "data_errors", "error_message", "metadata", "files", "expired", "expires_at", "processed_at", "created_at", "updated_at", "has_password", "signature_requests", "signing_order", "actions", "truncated_text", "output_formats", "preview_generated_at"];
|
|
276
282
|
|
|
277
283
|
/**
|
|
278
284
|
* The submission's ID.
|
|
@@ -287,7 +293,7 @@ Submission.prototype['id'] = undefined;
|
|
|
287
293
|
Submission.prototype['template_id'] = undefined;
|
|
288
294
|
|
|
289
295
|
/**
|
|
290
|
-
* The template's type: `pdf` or `
|
|
296
|
+
* The template's type: `pdf`, `html` or `docx`.
|
|
291
297
|
* @member {module:model/TemplateType} template_type
|
|
292
298
|
*/
|
|
293
299
|
Submission.prototype['template_type'] = undefined;
|
|
@@ -311,13 +317,13 @@ Submission.prototype['batch_id'] = undefined;
|
|
|
311
317
|
Submission.prototype['source'] = undefined;
|
|
312
318
|
|
|
313
319
|
/**
|
|
314
|
-
* `pending` until the
|
|
320
|
+
* `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
|
|
315
321
|
* @member {module:model/SubmissionState} state
|
|
316
322
|
*/
|
|
317
323
|
Submission.prototype['state'] = undefined;
|
|
318
324
|
|
|
319
325
|
/**
|
|
320
|
-
* Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
|
|
326
|
+
* 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.
|
|
321
327
|
* @member {Boolean} test
|
|
322
328
|
*/
|
|
323
329
|
Submission.prototype['test'] = undefined;
|
|
@@ -353,7 +359,7 @@ Submission.prototype['error_message'] = undefined;
|
|
|
353
359
|
Submission.prototype['metadata'] = undefined;
|
|
354
360
|
|
|
355
361
|
/**
|
|
356
|
-
* The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
|
|
362
|
+
* The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
|
|
357
363
|
* @member {module:model/SubmissionFiles} files
|
|
358
364
|
*/
|
|
359
365
|
Submission.prototype['files'] = undefined;
|
|
@@ -401,7 +407,13 @@ Submission.prototype['has_password'] = undefined;
|
|
|
401
407
|
Submission.prototype['signature_requests'] = undefined;
|
|
402
408
|
|
|
403
409
|
/**
|
|
404
|
-
*
|
|
410
|
+
* `parallel`: everyone can sign at once. `sequential`: people sign one step at a time (each signature request's `signing_step`).
|
|
411
|
+
* @member {module:model/SigningOrder} signing_order
|
|
412
|
+
*/
|
|
413
|
+
Submission.prototype['signing_order'] = undefined;
|
|
414
|
+
|
|
415
|
+
/**
|
|
416
|
+
* The uploads of the submission's PDF to your storage (account integrations), and the emails its template's email actions sent.
|
|
405
417
|
* @member {Array.<module:model/SubmissionAction>} actions
|
|
406
418
|
*/
|
|
407
419
|
Submission.prototype['actions'] = undefined;
|
|
@@ -413,7 +425,7 @@ Submission.prototype['actions'] = undefined;
|
|
|
413
425
|
Submission.prototype['truncated_text'] = undefined;
|
|
414
426
|
|
|
415
427
|
/**
|
|
416
|
-
* 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.
|
|
428
|
+
* 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.
|
|
417
429
|
* @member {Array.<module:model/OutputFormat>} output_formats
|
|
418
430
|
*/
|
|
419
431
|
Submission.prototype['output_formats'] = undefined;
|