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
|
@@ -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;
|
|
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
16
16
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
17
17
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
18
18
|
* DocSpring API
|
|
19
|
-
* Use DocSpring's API to
|
|
19
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
20
20
|
*
|
|
21
21
|
* The version of the OpenAPI document: v2
|
|
22
22
|
*
|
|
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
29
29
|
/**
|
|
30
30
|
* The 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
|
/**
|
|
@@ -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 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
|
/**
|
|
@@ -14,7 +14,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
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
|
*
|
|
@@ -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
|
/**
|
|
@@ -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,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; } } }; }
|
|
@@ -19,7 +21,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
19
21
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
20
22
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
21
23
|
* DocSpring API
|
|
22
|
-
* Use DocSpring's API to
|
|
24
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
23
25
|
*
|
|
24
26
|
* The version of the OpenAPI document: v2
|
|
25
27
|
*
|
|
@@ -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
|
|
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;
|
|
@@ -183,19 +237,19 @@ CreateSubmissionRequest.prototype['data'] = undefined;
|
|
|
183
237
|
CreateSubmissionRequest.prototype['metadata'] = undefined;
|
|
184
238
|
|
|
185
239
|
/**
|
|
186
|
-
* A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
|
|
240
|
+
* A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
|
|
187
241
|
* @member {String} password
|
|
188
242
|
*/
|
|
189
243
|
CreateSubmissionRequest.prototype['password'] = undefined;
|
|
190
244
|
|
|
191
245
|
/**
|
|
192
|
-
* What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
|
|
246
|
+
* What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
|
|
193
247
|
* @member {Array.<module:model/OutputFormat>} output_formats
|
|
194
248
|
*/
|
|
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;
|
|
@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
16
16
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
17
17
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
18
18
|
* DocSpring API
|
|
19
|
-
* Use DocSpring's API to
|
|
19
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
20
20
|
*
|
|
21
21
|
* The version of the OpenAPI document: v2
|
|
22
22
|
*
|
|
@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
29
29
|
/**
|
|
30
30
|
* The 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
|
/**
|