docspring 4.3.0 → 4.5.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 -0
- package/LICENSE +1 -1
- package/README.md +23 -1
- package/dist/ApiClient.js +2 -2
- package/dist/RequestSchemas.js +1212 -132
- package/dist/RequestValidator.js +4 -0
- package/dist/api/Client.js +1364 -207
- package/dist/index.js +210 -0
- package/dist/model/AddTemplateFieldsRequest.js +3 -3
- package/dist/model/AuthenticationCheck.js +1 -1
- package/dist/model/CombinedPdf.js +1 -1
- package/dist/model/CombinedPdfFiles.js +1 -1
- package/dist/model/CombinedPdfList.js +1 -1
- package/dist/model/CombinedPdfSource.js +2 -2
- package/dist/model/CombinedPdfSourceInput.js +2 -2
- package/dist/model/CombinedPdfSourcePdf.js +1 -1
- package/dist/model/CopyTemplateRequest.js +1 -1
- package/dist/model/CreateAccountEmailActionRequest.js +306 -0
- package/dist/model/CreateCombinedPdfRequest.js +1 -1
- package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
- package/dist/model/CreateEmailActionRequest.js +280 -0
- package/dist/model/CreateEmailDomainRequest.js +114 -0
- package/dist/model/CreateFolderRequest.js +1 -1
- package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
- package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
- package/dist/model/CreateSubmissionBatchRequest.js +4 -4
- package/dist/model/CreateSubmissionRequest.js +114 -6
- package/dist/model/CreateTemplatePreviewRequest.js +1 -1
- package/dist/model/CreateTemplateRequest.js +148 -9
- package/dist/model/CreateWebhookRequest.js +1 -1
- package/dist/model/CustomFile.js +1 -1
- package/dist/model/CustomFileList.js +1 -1
- package/dist/model/CustomFileSourcePdf.js +1 -1
- package/dist/model/DnsRecordType.js +64 -0
- package/dist/model/EmailAction.js +510 -0
- package/dist/model/EmailActionConditions.js +142 -0
- package/dist/model/EmailActionConditionsInput.js +142 -0
- package/dist/model/EmailActionCustomization.js +222 -0
- package/dist/model/EmailActionDelivery.js +59 -0
- package/dist/model/EmailActionFileFormats.js +69 -0
- package/dist/model/EmailActionList.js +132 -0
- package/dist/model/EmailActionSetting.js +119 -0
- package/dist/model/EmailActionSubmissionType.js +64 -0
- package/dist/model/EmailActionTestEmail.js +116 -0
- package/dist/model/EmailDomain.js +245 -0
- package/dist/model/EmailDomainDnsRecord.js +155 -0
- package/dist/model/EmailDomainDnsRecordPurpose.js +64 -0
- package/dist/model/EmailDomainList.js +132 -0
- package/dist/model/EmailDomainRecordState.js +64 -0
- package/dist/model/EmailDomainState.js +64 -0
- package/dist/model/ErrorCode.js +10 -0
- package/dist/model/ErrorDetail.js +1 -1
- package/dist/model/ErrorInfo.js +72 -7
- package/dist/model/ErrorResponse.js +1 -1
- package/dist/model/Field.js +3 -3
- package/dist/model/FieldComparisonCondition.js +1 -1
- package/dist/model/FieldDependency.js +1 -1
- package/dist/model/FieldDependencyInput.js +1 -1
- package/dist/model/FieldEqualsCondition.js +1 -1
- package/dist/model/FieldGroup.js +1 -1
- package/dist/model/FieldGroupInput.js +1 -1
- package/dist/model/FieldInCondition.js +1 -1
- package/dist/model/FieldInput.js +2 -2
- package/dist/model/FieldOverride.js +1 -1
- package/dist/model/FieldPresenceCondition.js +1 -1
- package/dist/model/FieldRangeCondition.js +1 -1
- package/dist/model/Folder.js +1 -1
- package/dist/model/FolderList.js +1 -1
- package/dist/model/GenerateSubmissionFilesRequest.js +1 -1
- package/dist/model/GeneratedFile.js +1 -1
- package/dist/model/HtmlEngineOptions.js +9 -9
- package/dist/model/HtmlEngineOptionsInput.js +6 -6
- package/dist/model/MoveFolderRequest.js +1 -1
- package/dist/model/MoveTemplateRequest.js +1 -1
- package/dist/model/PageImage.js +1 -1
- package/dist/model/PageImages.js +1 -1
- package/dist/model/PredefinedField.js +1 -1
- package/dist/model/PredefinedFieldInput.js +1 -1
- package/dist/model/PublishTemplateVersionRequest.js +1 -1
- package/dist/model/RemoveTemplateFieldsRequest.js +1 -1
- package/dist/model/RenameFolderRequest.js +1 -1
- package/dist/model/ReorderTemplateFieldsRequest.js +1 -1
- package/dist/model/RestoreTemplateVersionRequest.js +1 -1
- package/dist/model/SendAccountEmailActionTestEmailRequest.js +91 -0
- package/dist/model/SignatureRequest.js +52 -7
- package/dist/model/SignatureRequestEmailAttachments.js +59 -0
- package/dist/model/SignatureRequestEmailStatus.js +89 -0
- package/dist/model/SignatureRequestEvent.js +1 -1
- package/dist/model/SignatureRequestEventType.js +11 -1
- package/dist/model/SignatureRequestInput.js +24 -8
- package/dist/model/SignatureRequestReminders.js +121 -0
- package/dist/model/SignatureRequestToken.js +1 -1
- package/dist/model/SigningOrder.js +59 -0
- package/dist/model/StringConditionType.js +36 -1
- package/dist/model/Submission.js +21 -9
- package/dist/model/SubmissionAction.js +27 -12
- package/dist/model/SubmissionBatch.js +1 -1
- package/dist/model/SubmissionFiles.js +1 -1
- package/dist/model/SubmissionInput.js +5 -5
- package/dist/model/SubmissionList.js +1 -1
- package/dist/model/SubmissionSourcePdf.js +1 -1
- package/dist/model/SubmissionSummary.js +3 -3
- package/dist/model/SubmissionValidation.js +1 -1
- package/dist/model/Template.js +189 -21
- package/dist/model/TemplateActor.js +1 -1
- package/dist/model/TemplateDefaults.js +1 -1
- package/dist/model/TemplateDefaultsInput.js +1 -1
- package/dist/model/TemplateDiff.js +1 -1
- package/dist/model/TemplateDiffSummary.js +1 -1
- package/dist/model/TemplateDocument.js +1 -1
- package/dist/model/TemplateDocumentSummary.js +1 -1
- package/dist/model/TemplateFieldChange.js +1 -1
- package/dist/model/TemplateFieldChanges.js +1 -1
- package/dist/model/TemplateFieldDependency.js +1 -1
- package/dist/model/TemplateFieldDependencyCondition.js +1 -1
- package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
- package/dist/model/TemplateFieldDependencyInput.js +1 -1
- package/dist/model/TemplateFieldMove.js +1 -1
- package/dist/model/TemplateFields.js +1 -1
- package/dist/model/TemplateFormSection.js +161 -0
- package/dist/model/TemplateFormSectionInput.js +157 -0
- package/dist/model/TemplateModelCode.js +1 -1
- package/dist/model/TemplatePageImages.js +1 -1
- package/dist/model/TemplatePageProcessingStatus.js +1 -1
- package/dist/model/TemplatePreview.js +1 -1
- package/dist/model/TemplateSourcePdf.js +2 -2
- package/dist/model/TemplateSummary.js +9 -9
- package/dist/model/TemplateSummaryList.js +1 -1
- package/dist/model/TemplateType.js +6 -1
- package/dist/model/TemplateVersion.js +1 -1
- package/dist/model/UpdateAccountEmailActionRequest.js +306 -0
- package/dist/model/UpdateEmailActionCustomizationRequest.js +258 -0
- package/dist/model/UpdateEmailActionRequest.js +280 -0
- package/dist/model/UpdateSignatureRequestRequest.js +1 -1
- package/dist/model/UpdateTemplateDocumentRequest.js +2 -2
- package/dist/model/UpdateTemplateFieldsRequest.js +1 -1
- package/dist/model/UpdateTemplateRequest.js +173 -12
- package/dist/model/UpdateWebhookRequest.js +1 -1
- package/dist/model/UploadPresign.js +1 -1
- package/dist/model/UrlSourcePdf.js +1 -1
- package/dist/model/ValidateSubmissionRequest.js +114 -6
- package/dist/model/Webhook.js +1 -1
- package/dist/model/WebhookEventType.js +10 -0
- package/dist/model/WebhookList.js +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,280 @@
|
|
|
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
|
+
var _EmailActionConditionsInput = _interopRequireDefault(require("./EmailActionConditionsInput"));
|
|
9
|
+
var _EmailActionDelivery = _interopRequireDefault(require("./EmailActionDelivery"));
|
|
10
|
+
var _EmailActionFileFormats = _interopRequireDefault(require("./EmailActionFileFormats"));
|
|
11
|
+
var _EmailActionSubmissionType = _interopRequireDefault(require("./EmailActionSubmissionType"));
|
|
12
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
13
|
+
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); }
|
|
14
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
15
|
+
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); } }
|
|
16
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
17
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
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
|
+
* DocSpring API
|
|
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
|
+
*
|
|
22
|
+
* The version of the OpenAPI document: v2
|
|
23
|
+
*
|
|
24
|
+
*
|
|
25
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
26
|
+
* https://openapi-generator.tech
|
|
27
|
+
* Do not edit the class manually.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
/**
|
|
31
|
+
* The UpdateEmailActionRequest model module.
|
|
32
|
+
* @module model/UpdateEmailActionRequest
|
|
33
|
+
* @version 4.5.0
|
|
34
|
+
*/
|
|
35
|
+
var UpdateEmailActionRequest = /*#__PURE__*/function () {
|
|
36
|
+
/**
|
|
37
|
+
* Constructs a new <code>UpdateEmailActionRequest</code>.
|
|
38
|
+
* The settings to change. Properties left out keep their values.
|
|
39
|
+
* @alias module:model/UpdateEmailActionRequest
|
|
40
|
+
*/
|
|
41
|
+
function UpdateEmailActionRequest() {
|
|
42
|
+
_classCallCheck(this, UpdateEmailActionRequest);
|
|
43
|
+
UpdateEmailActionRequest.initialize(this);
|
|
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(UpdateEmailActionRequest, null, [{
|
|
52
|
+
key: "initialize",
|
|
53
|
+
value: function initialize(obj) {}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Constructs a <code>UpdateEmailActionRequest</code> from a plain JavaScript object, optionally creating a new instance.
|
|
57
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
58
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
59
|
+
* @param {module:model/UpdateEmailActionRequest} obj Optional instance to populate.
|
|
60
|
+
* @return {module:model/UpdateEmailActionRequest} The populated <code>UpdateEmailActionRequest</code> instance.
|
|
61
|
+
*/
|
|
62
|
+
}, {
|
|
63
|
+
key: "constructFromObject",
|
|
64
|
+
value: function constructFromObject(data, obj) {
|
|
65
|
+
if (data) {
|
|
66
|
+
obj = obj || new UpdateEmailActionRequest();
|
|
67
|
+
if (data.hasOwnProperty('name')) {
|
|
68
|
+
obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
|
|
69
|
+
}
|
|
70
|
+
if (data.hasOwnProperty('enabled')) {
|
|
71
|
+
obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
|
|
72
|
+
}
|
|
73
|
+
if (data.hasOwnProperty('to')) {
|
|
74
|
+
obj['to'] = _ApiClient["default"].convertToType(data['to'], ['String']);
|
|
75
|
+
}
|
|
76
|
+
if (data.hasOwnProperty('cc')) {
|
|
77
|
+
obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
|
|
78
|
+
}
|
|
79
|
+
if (data.hasOwnProperty('bcc')) {
|
|
80
|
+
obj['bcc'] = _ApiClient["default"].convertToType(data['bcc'], ['String']);
|
|
81
|
+
}
|
|
82
|
+
if (data.hasOwnProperty('from_name')) {
|
|
83
|
+
obj['from_name'] = _ApiClient["default"].convertToType(data['from_name'], 'String');
|
|
84
|
+
}
|
|
85
|
+
if (data.hasOwnProperty('from_address')) {
|
|
86
|
+
obj['from_address'] = _ApiClient["default"].convertToType(data['from_address'], 'String');
|
|
87
|
+
}
|
|
88
|
+
if (data.hasOwnProperty('reply_to')) {
|
|
89
|
+
obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
|
|
90
|
+
}
|
|
91
|
+
if (data.hasOwnProperty('subject')) {
|
|
92
|
+
obj['subject'] = _ApiClient["default"].convertToType(data['subject'], 'String');
|
|
93
|
+
}
|
|
94
|
+
if (data.hasOwnProperty('message')) {
|
|
95
|
+
obj['message'] = _ApiClient["default"].convertToType(data['message'], 'String');
|
|
96
|
+
}
|
|
97
|
+
if (data.hasOwnProperty('file_name')) {
|
|
98
|
+
obj['file_name'] = _ApiClient["default"].convertToType(data['file_name'], 'String');
|
|
99
|
+
}
|
|
100
|
+
if (data.hasOwnProperty('file_formats')) {
|
|
101
|
+
obj['file_formats'] = _ApiClient["default"].convertToType(data['file_formats'], _EmailActionFileFormats["default"]);
|
|
102
|
+
}
|
|
103
|
+
if (data.hasOwnProperty('delivery')) {
|
|
104
|
+
obj['delivery'] = _ApiClient["default"].convertToType(data['delivery'], _EmailActionDelivery["default"]);
|
|
105
|
+
}
|
|
106
|
+
if (data.hasOwnProperty('max_attachment_mb')) {
|
|
107
|
+
obj['max_attachment_mb'] = _ApiClient["default"].convertToType(data['max_attachment_mb'], 'Number');
|
|
108
|
+
}
|
|
109
|
+
if (data.hasOwnProperty('submission_type')) {
|
|
110
|
+
obj['submission_type'] = _ApiClient["default"].convertToType(data['submission_type'], _EmailActionSubmissionType["default"]);
|
|
111
|
+
}
|
|
112
|
+
if (data.hasOwnProperty('send_when')) {
|
|
113
|
+
obj['send_when'] = _ApiClient["default"].convertToType(data['send_when'], _EmailActionConditionsInput["default"]);
|
|
114
|
+
}
|
|
115
|
+
if (data.hasOwnProperty('failure_notifications_enabled')) {
|
|
116
|
+
obj['failure_notifications_enabled'] = _ApiClient["default"].convertToType(data['failure_notifications_enabled'], 'Boolean');
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
return obj;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* Validates the JSON data with respect to <code>UpdateEmailActionRequest</code>.
|
|
124
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
125
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateEmailActionRequest</code>.
|
|
126
|
+
*/
|
|
127
|
+
}, {
|
|
128
|
+
key: "validateJSON",
|
|
129
|
+
value: function validateJSON(data) {
|
|
130
|
+
// ensure the json data is a string
|
|
131
|
+
if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
|
|
132
|
+
throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
|
|
133
|
+
}
|
|
134
|
+
// ensure the json data is an array
|
|
135
|
+
if (!Array.isArray(data['to'])) {
|
|
136
|
+
throw new Error("Expected the field `to` to be an array in the JSON data but got " + data['to']);
|
|
137
|
+
}
|
|
138
|
+
// ensure the json data is an array
|
|
139
|
+
if (!Array.isArray(data['cc'])) {
|
|
140
|
+
throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
|
|
141
|
+
}
|
|
142
|
+
// ensure the json data is an array
|
|
143
|
+
if (!Array.isArray(data['bcc'])) {
|
|
144
|
+
throw new Error("Expected the field `bcc` to be an array in the JSON data but got " + data['bcc']);
|
|
145
|
+
}
|
|
146
|
+
// ensure the json data is a string
|
|
147
|
+
if (data['from_name'] && !(typeof data['from_name'] === 'string' || data['from_name'] instanceof String)) {
|
|
148
|
+
throw new Error("Expected the field `from_name` to be a primitive type in the JSON string but got " + data['from_name']);
|
|
149
|
+
}
|
|
150
|
+
// ensure the json data is a string
|
|
151
|
+
if (data['from_address'] && !(typeof data['from_address'] === 'string' || data['from_address'] instanceof String)) {
|
|
152
|
+
throw new Error("Expected the field `from_address` to be a primitive type in the JSON string but got " + data['from_address']);
|
|
153
|
+
}
|
|
154
|
+
// ensure the json data is a string
|
|
155
|
+
if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
|
|
156
|
+
throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
|
|
157
|
+
}
|
|
158
|
+
// ensure the json data is a string
|
|
159
|
+
if (data['subject'] && !(typeof data['subject'] === 'string' || data['subject'] instanceof String)) {
|
|
160
|
+
throw new Error("Expected the field `subject` to be a primitive type in the JSON string but got " + data['subject']);
|
|
161
|
+
}
|
|
162
|
+
// ensure the json data is a string
|
|
163
|
+
if (data['message'] && !(typeof data['message'] === 'string' || data['message'] instanceof String)) {
|
|
164
|
+
throw new Error("Expected the field `message` to be a primitive type in the JSON string but got " + data['message']);
|
|
165
|
+
}
|
|
166
|
+
// ensure the json data is a string
|
|
167
|
+
if (data['file_name'] && !(typeof data['file_name'] === 'string' || data['file_name'] instanceof String)) {
|
|
168
|
+
throw new Error("Expected the field `file_name` to be a primitive type in the JSON string but got " + data['file_name']);
|
|
169
|
+
}
|
|
170
|
+
// validate the optional field `send_when`
|
|
171
|
+
if (data['send_when']) {
|
|
172
|
+
// data not null
|
|
173
|
+
_EmailActionConditionsInput["default"].validateJSON(data['send_when']);
|
|
174
|
+
}
|
|
175
|
+
return true;
|
|
176
|
+
}
|
|
177
|
+
}]);
|
|
178
|
+
}();
|
|
179
|
+
/**
|
|
180
|
+
* A name for the email action, shown in the dashboard. Null shows its recipients instead.
|
|
181
|
+
* @member {String} name
|
|
182
|
+
*/
|
|
183
|
+
UpdateEmailActionRequest.prototype['name'] = undefined;
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* Whether it sends emails. DocSpring turns an email action off after 3 days of failed emails, or straight away when one of the addresses in `to`, `cc` or `bcc` (not one from a field or metadata) bounces or marks an email as spam.
|
|
187
|
+
* @member {Boolean} enabled
|
|
188
|
+
*/
|
|
189
|
+
UpdateEmailActionRequest.prototype['enabled'] = undefined;
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* Who gets each email: email addresses, and tags for an address that each submission gives, from one of the template's text or email fields (`{{ data.client_email }}`, or `{{ data["client email"] }}` for a name with spaces) or from its metadata (`{{ metadata.agent_email }}`, or `{{ metadata.agent.email }}` for a value in an object). A tag whose value is blank or isn't a valid address is skipped for that submission, and so is a field an account email action names that the template doesn't have. `{{ signer.email }}` sends each of the submission's signers their own email, to them alone, and everyone else in `to`, `cc` and `bcc` one email together, without the signers. An email needs at least one entry in `to`, `cc` or `bcc`, and at most 10 across them.
|
|
193
|
+
* @member {Array.<String>} to
|
|
194
|
+
*/
|
|
195
|
+
UpdateEmailActionRequest.prototype['to'] = undefined;
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Who is copied on each email, as in `to` (but not `{{ signer.email }}`).
|
|
199
|
+
* @member {Array.<String>} cc
|
|
200
|
+
*/
|
|
201
|
+
UpdateEmailActionRequest.prototype['cc'] = undefined;
|
|
202
|
+
|
|
203
|
+
/**
|
|
204
|
+
* Who is blind-copied on each email, as in `to` (but not `{{ signer.email }}`).
|
|
205
|
+
* @member {Array.<String>} bcc
|
|
206
|
+
*/
|
|
207
|
+
UpdateEmailActionRequest.prototype['bcc'] = undefined;
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* The sender's name. Null uses your account's name. From DocSpring's shared address, the name is followed by "via DocSpring".
|
|
211
|
+
* @member {String} from_name
|
|
212
|
+
*/
|
|
213
|
+
UpdateEmailActionRequest.prototype['from_name'] = undefined;
|
|
214
|
+
|
|
215
|
+
/**
|
|
216
|
+
* The sender's address, at one of your verified email domains. Null sends from DocSpring's shared address.
|
|
217
|
+
* @member {String} from_address
|
|
218
|
+
*/
|
|
219
|
+
UpdateEmailActionRequest.prototype['from_address'] = undefined;
|
|
220
|
+
|
|
221
|
+
/**
|
|
222
|
+
* Where replies go: a team member's email address, or an address at one of your verified email domains. Null sends without a reply address.
|
|
223
|
+
* @member {String} reply_to
|
|
224
|
+
*/
|
|
225
|
+
UpdateEmailActionRequest.prototype['reply_to'] = undefined;
|
|
226
|
+
|
|
227
|
+
/**
|
|
228
|
+
* The subject line, a Liquid template with the variables `account.name`, `template.name`, `template.id`, `submission.id`, the submission's values as `data.<field name>` (`data["field name"]` for a name with spaces) and its metadata as `metadata.<key>`, such as `Your {{ template.name }}`. Null uses the template's name followed by the file it sends, such as "Lease PDF", or by "files" when it sends several.
|
|
229
|
+
* @member {String} subject
|
|
230
|
+
*/
|
|
231
|
+
UpdateEmailActionRequest.prototype['subject'] = undefined;
|
|
232
|
+
|
|
233
|
+
/**
|
|
234
|
+
* The email's text, a Liquid template with the same variables as `subject`. `if`, `unless` and `case` tags work. Line breaks are kept. Null uses a short message that says the files are attached or ready to download.
|
|
235
|
+
* @member {String} message
|
|
236
|
+
*/
|
|
237
|
+
UpdateEmailActionRequest.prototype['message'] = undefined;
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* The attached files' name, a Liquid template with the same variables as `subject`, such as `{{ data.last_name }} lease`. Each file's extension (`.pdf`, `.docx` or `.odt`) is added. Null uses the submission's `pdf_filename` metadata when it has one, and otherwise the template's name. A download link's files have the names their other downloads have: the submission's `pdf_filename`, or its ID.
|
|
241
|
+
* @member {String} file_name
|
|
242
|
+
*/
|
|
243
|
+
UpdateEmailActionRequest.prototype['file_name'] = undefined;
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* Which of the submission's files the email sends: `all` sends every file the submission made (its PDF, and a Word template's Word document and OpenDocument file when it made them), and `docx`, `odt` or `pdf` sends only that file. A submission that made none of them sends nothing, and its email shows as skipped. Only Word templates make Word documents and OpenDocument files, so another template's email action takes `pdf` or `all`.
|
|
247
|
+
* @member {module:model/EmailActionFileFormats} file_formats
|
|
248
|
+
*/
|
|
249
|
+
UpdateEmailActionRequest.prototype['file_formats'] = undefined;
|
|
250
|
+
|
|
251
|
+
/**
|
|
252
|
+
* `attachment` attaches the files, or sends a download link when together they're larger than `max_attachment_mb`. `link` sends a download link, which works for 7 days. Accounts with a BAA start with `link`.
|
|
253
|
+
* @member {module:model/EmailActionDelivery} delivery
|
|
254
|
+
*/
|
|
255
|
+
UpdateEmailActionRequest.prototype['delivery'] = undefined;
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* With `delivery` `attachment`, files larger than this many megabytes in all (1 MB is 1,000,000 bytes) are sent as a download link instead. Emailing a file makes it about 38% larger, and many company mail servers refuse emails over 10 MB, so the default is 7. Raise it only when every recipient's mail server accepts larger emails, such as Microsoft 365 (up to 36 MB) or Gmail (50 MB).
|
|
259
|
+
* @member {Number} max_attachment_mb
|
|
260
|
+
*/
|
|
261
|
+
UpdateEmailActionRequest.prototype['max_attachment_mb'] = undefined;
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Which submissions send emails: `live`, `test` or `all`. Test submissions only email your team's members, and skip every other recipient.
|
|
265
|
+
* @member {module:model/EmailActionSubmissionType} submission_type
|
|
266
|
+
*/
|
|
267
|
+
UpdateEmailActionRequest.prototype['submission_type'] = undefined;
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* Sends the email only when the submission's values meet these conditions, which work as a conditional logic rule's do. The values are the ones the PDF has: formulas worked out, and blank for a field that a rule hides. A field the template doesn't have (in an account email action's conditions) counts as blank. A submission that doesn't meet them sends nothing, and its email shows as skipped. Null sends for every submission.
|
|
271
|
+
* @member {module:model/EmailActionConditionsInput} send_when
|
|
272
|
+
*/
|
|
273
|
+
UpdateEmailActionRequest.prototype['send_when'] = undefined;
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Whether the account's owner gets an email when the email action's emails keep failing.
|
|
277
|
+
* @member {Boolean} failure_notifications_enabled
|
|
278
|
+
*/
|
|
279
|
+
UpdateEmailActionRequest.prototype['failure_notifications_enabled'] = undefined;
|
|
280
|
+
var _default = exports["default"] = UpdateEmailActionRequest;
|
|
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
28
28
|
/**
|
|
29
29
|
* The UpdateSignatureRequestRequest model module.
|
|
30
30
|
* @module model/UpdateSignatureRequestRequest
|
|
31
|
-
* @version 4.
|
|
31
|
+
* @version 4.5.0
|
|
32
32
|
*/
|
|
33
33
|
var UpdateSignatureRequestRequest = /*#__PURE__*/function () {
|
|
34
34
|
/**
|
|
@@ -26,7 +26,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
26
26
|
/**
|
|
27
27
|
* The UpdateTemplateDocumentRequest model module.
|
|
28
28
|
* @module model/UpdateTemplateDocumentRequest
|
|
29
|
-
* @version 4.
|
|
29
|
+
* @version 4.5.0
|
|
30
30
|
*/
|
|
31
31
|
var UpdateTemplateDocumentRequest = /*#__PURE__*/function () {
|
|
32
32
|
/**
|
|
@@ -120,7 +120,7 @@ UpdateTemplateDocumentRequest.prototype['cache_id'] = undefined;
|
|
|
120
120
|
UpdateTemplateDocumentRequest.prototype['document_url'] = undefined;
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* The template's document (a PDF, or a Word template's Word document), encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
|
|
123
|
+
* The template's document (a PDF, or a Word template's Word document), encoded as base64 (a `data:` URI works too), instead of `cache_id`. Line breaks and spaces in it are ignored. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
|
|
124
124
|
* @member {String} document_base64
|
|
125
125
|
*/
|
|
126
126
|
UpdateTemplateDocumentRequest.prototype['document_base64'] = undefined;
|
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
30
30
|
/**
|
|
31
31
|
* The UpdateTemplateFieldsRequest model module.
|
|
32
32
|
* @module model/UpdateTemplateFieldsRequest
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.5.0
|
|
34
34
|
*/
|
|
35
35
|
var UpdateTemplateFieldsRequest = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
@@ -11,9 +11,11 @@ var _FieldGroupInput = _interopRequireDefault(require("./FieldGroupInput"));
|
|
|
11
11
|
var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
|
|
12
12
|
var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
|
|
13
13
|
var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
|
|
14
|
+
var _SignatureRequestEmailAttachments = _interopRequireDefault(require("./SignatureRequestEmailAttachments"));
|
|
14
15
|
var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
|
|
15
16
|
var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
|
|
16
17
|
var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
|
|
18
|
+
var _TemplateFormSectionInput = _interopRequireDefault(require("./TemplateFormSectionInput"));
|
|
17
19
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
18
20
|
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); }
|
|
19
21
|
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; } } }; }
|
|
@@ -38,7 +40,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
38
40
|
/**
|
|
39
41
|
* The UpdateTemplateRequest model module.
|
|
40
42
|
* @module model/UpdateTemplateRequest
|
|
41
|
-
* @version 4.
|
|
43
|
+
* @version 4.5.0
|
|
42
44
|
*/
|
|
43
45
|
var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
44
46
|
/**
|
|
@@ -147,6 +149,36 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
|
147
149
|
if (data.hasOwnProperty('redirect_url')) {
|
|
148
150
|
obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
|
|
149
151
|
}
|
|
152
|
+
if (data.hasOwnProperty('signature_request_email_attachments')) {
|
|
153
|
+
obj['signature_request_email_attachments'] = _ApiClient["default"].convertToType(data['signature_request_email_attachments'], _SignatureRequestEmailAttachments["default"]);
|
|
154
|
+
}
|
|
155
|
+
if (data.hasOwnProperty('signature_request_from_address')) {
|
|
156
|
+
obj['signature_request_from_address'] = _ApiClient["default"].convertToType(data['signature_request_from_address'], 'String');
|
|
157
|
+
}
|
|
158
|
+
if (data.hasOwnProperty('signature_request_include_signing_token')) {
|
|
159
|
+
obj['signature_request_include_signing_token'] = _ApiClient["default"].convertToType(data['signature_request_include_signing_token'], 'Boolean');
|
|
160
|
+
}
|
|
161
|
+
if (data.hasOwnProperty('signature_request_from_name')) {
|
|
162
|
+
obj['signature_request_from_name'] = _ApiClient["default"].convertToType(data['signature_request_from_name'], 'String');
|
|
163
|
+
}
|
|
164
|
+
if (data.hasOwnProperty('signature_request_notification_emails')) {
|
|
165
|
+
obj['signature_request_notification_emails'] = _ApiClient["default"].convertToType(data['signature_request_notification_emails'], ['String']);
|
|
166
|
+
}
|
|
167
|
+
if (data.hasOwnProperty('signature_request_reply_to')) {
|
|
168
|
+
obj['signature_request_reply_to'] = _ApiClient["default"].convertToType(data['signature_request_reply_to'], 'String');
|
|
169
|
+
}
|
|
170
|
+
if (data.hasOwnProperty('signature_request_signing_url')) {
|
|
171
|
+
obj['signature_request_signing_url'] = _ApiClient["default"].convertToType(data['signature_request_signing_url'], 'String');
|
|
172
|
+
}
|
|
173
|
+
if (data.hasOwnProperty('success_title')) {
|
|
174
|
+
obj['success_title'] = _ApiClient["default"].convertToType(data['success_title'], 'String');
|
|
175
|
+
}
|
|
176
|
+
if (data.hasOwnProperty('success_message')) {
|
|
177
|
+
obj['success_message'] = _ApiClient["default"].convertToType(data['success_message'], 'String');
|
|
178
|
+
}
|
|
179
|
+
if (data.hasOwnProperty('show_fill_again_button')) {
|
|
180
|
+
obj['show_fill_again_button'] = _ApiClient["default"].convertToType(data['show_fill_again_button'], 'Boolean');
|
|
181
|
+
}
|
|
150
182
|
if (data.hasOwnProperty('slack_webhook_url')) {
|
|
151
183
|
obj['slack_webhook_url'] = _ApiClient["default"].convertToType(data['slack_webhook_url'], 'String');
|
|
152
184
|
}
|
|
@@ -159,6 +191,9 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
|
159
191
|
if (data.hasOwnProperty('field_groups')) {
|
|
160
192
|
obj['field_groups'] = _ApiClient["default"].convertToType(data['field_groups'], [_FieldGroupInput["default"]]);
|
|
161
193
|
}
|
|
194
|
+
if (data.hasOwnProperty('form_sections')) {
|
|
195
|
+
obj['form_sections'] = _ApiClient["default"].convertToType(data['form_sections'], [_TemplateFormSectionInput["default"]]);
|
|
196
|
+
}
|
|
162
197
|
if (data.hasOwnProperty('predefined_fields')) {
|
|
163
198
|
obj['predefined_fields'] = _ApiClient["default"].convertToType(data['predefined_fields'], [_PredefinedFieldInput["default"]]);
|
|
164
199
|
}
|
|
@@ -185,6 +220,11 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
|
185
220
|
if (data.hasOwnProperty('html_escape_data')) {
|
|
186
221
|
obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
|
|
187
222
|
}
|
|
223
|
+
if (data.hasOwnProperty('layout')) {
|
|
224
|
+
obj['layout'] = _ApiClient["default"].convertToType(data['layout'], {
|
|
225
|
+
'String': Object
|
|
226
|
+
});
|
|
227
|
+
}
|
|
188
228
|
}
|
|
189
229
|
return obj;
|
|
190
230
|
}
|
|
@@ -222,6 +262,34 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
|
222
262
|
throw new Error("Expected the field `redirect_url` to be a primitive type in the JSON string but got " + data['redirect_url']);
|
|
223
263
|
}
|
|
224
264
|
// ensure the json data is a string
|
|
265
|
+
if (data['signature_request_from_address'] && !(typeof data['signature_request_from_address'] === 'string' || data['signature_request_from_address'] instanceof String)) {
|
|
266
|
+
throw new Error("Expected the field `signature_request_from_address` to be a primitive type in the JSON string but got " + data['signature_request_from_address']);
|
|
267
|
+
}
|
|
268
|
+
// ensure the json data is a string
|
|
269
|
+
if (data['signature_request_from_name'] && !(typeof data['signature_request_from_name'] === 'string' || data['signature_request_from_name'] instanceof String)) {
|
|
270
|
+
throw new Error("Expected the field `signature_request_from_name` to be a primitive type in the JSON string but got " + data['signature_request_from_name']);
|
|
271
|
+
}
|
|
272
|
+
// ensure the json data is an array
|
|
273
|
+
if (!Array.isArray(data['signature_request_notification_emails'])) {
|
|
274
|
+
throw new Error("Expected the field `signature_request_notification_emails` to be an array in the JSON data but got " + data['signature_request_notification_emails']);
|
|
275
|
+
}
|
|
276
|
+
// ensure the json data is a string
|
|
277
|
+
if (data['signature_request_reply_to'] && !(typeof data['signature_request_reply_to'] === 'string' || data['signature_request_reply_to'] instanceof String)) {
|
|
278
|
+
throw new Error("Expected the field `signature_request_reply_to` to be a primitive type in the JSON string but got " + data['signature_request_reply_to']);
|
|
279
|
+
}
|
|
280
|
+
// ensure the json data is a string
|
|
281
|
+
if (data['signature_request_signing_url'] && !(typeof data['signature_request_signing_url'] === 'string' || data['signature_request_signing_url'] instanceof String)) {
|
|
282
|
+
throw new Error("Expected the field `signature_request_signing_url` to be a primitive type in the JSON string but got " + data['signature_request_signing_url']);
|
|
283
|
+
}
|
|
284
|
+
// ensure the json data is a string
|
|
285
|
+
if (data['success_title'] && !(typeof data['success_title'] === 'string' || data['success_title'] instanceof String)) {
|
|
286
|
+
throw new Error("Expected the field `success_title` to be a primitive type in the JSON string but got " + data['success_title']);
|
|
287
|
+
}
|
|
288
|
+
// ensure the json data is a string
|
|
289
|
+
if (data['success_message'] && !(typeof data['success_message'] === 'string' || data['success_message'] instanceof String)) {
|
|
290
|
+
throw new Error("Expected the field `success_message` to be a primitive type in the JSON string but got " + data['success_message']);
|
|
291
|
+
}
|
|
292
|
+
// ensure the json data is a string
|
|
225
293
|
if (data['slack_webhook_url'] && !(typeof data['slack_webhook_url'] === 'string' || data['slack_webhook_url'] instanceof String)) {
|
|
226
294
|
throw new Error("Expected the field `slack_webhook_url` to be a primitive type in the JSON string but got " + data['slack_webhook_url']);
|
|
227
295
|
}
|
|
@@ -272,19 +340,19 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
|
272
340
|
}
|
|
273
341
|
;
|
|
274
342
|
}
|
|
275
|
-
if (data['
|
|
343
|
+
if (data['form_sections']) {
|
|
276
344
|
// data not null
|
|
277
345
|
// ensure the json data is an array
|
|
278
|
-
if (!Array.isArray(data['
|
|
279
|
-
throw new Error("Expected the field `
|
|
346
|
+
if (!Array.isArray(data['form_sections'])) {
|
|
347
|
+
throw new Error("Expected the field `form_sections` to be an array in the JSON data but got " + data['form_sections']);
|
|
280
348
|
}
|
|
281
|
-
// validate the optional field `
|
|
282
|
-
var _iterator3 = _createForOfIteratorHelper(data['
|
|
349
|
+
// validate the optional field `form_sections` (array)
|
|
350
|
+
var _iterator3 = _createForOfIteratorHelper(data['form_sections']),
|
|
283
351
|
_step3;
|
|
284
352
|
try {
|
|
285
353
|
for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
|
|
286
354
|
var _item2 = _step3.value;
|
|
287
|
-
|
|
355
|
+
_TemplateFormSectionInput["default"].validateJSON(_item2);
|
|
288
356
|
}
|
|
289
357
|
} catch (err) {
|
|
290
358
|
_iterator3.e(err);
|
|
@@ -293,6 +361,27 @@ var UpdateTemplateRequest = /*#__PURE__*/function () {
|
|
|
293
361
|
}
|
|
294
362
|
;
|
|
295
363
|
}
|
|
364
|
+
if (data['predefined_fields']) {
|
|
365
|
+
// data not null
|
|
366
|
+
// ensure the json data is an array
|
|
367
|
+
if (!Array.isArray(data['predefined_fields'])) {
|
|
368
|
+
throw new Error("Expected the field `predefined_fields` to be an array in the JSON data but got " + data['predefined_fields']);
|
|
369
|
+
}
|
|
370
|
+
// validate the optional field `predefined_fields` (array)
|
|
371
|
+
var _iterator4 = _createForOfIteratorHelper(data['predefined_fields']),
|
|
372
|
+
_step4;
|
|
373
|
+
try {
|
|
374
|
+
for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
|
|
375
|
+
var _item3 = _step4.value;
|
|
376
|
+
_PredefinedFieldInput["default"].validateJSON(_item3);
|
|
377
|
+
}
|
|
378
|
+
} catch (err) {
|
|
379
|
+
_iterator4.e(err);
|
|
380
|
+
} finally {
|
|
381
|
+
_iterator4.f();
|
|
382
|
+
}
|
|
383
|
+
;
|
|
384
|
+
}
|
|
296
385
|
// ensure the json data is a string
|
|
297
386
|
if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
|
|
298
387
|
throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
|
|
@@ -331,7 +420,7 @@ UpdateTemplateRequest.prototype['name'] = undefined;
|
|
|
331
420
|
UpdateTemplateRequest.prototype['description'] = undefined;
|
|
332
421
|
|
|
333
422
|
/**
|
|
334
|
-
* What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created;
|
|
423
|
+
* What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; other templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
|
|
335
424
|
* @member {module:model/OutputFormat} output_format
|
|
336
425
|
*/
|
|
337
426
|
UpdateTemplateRequest.prototype['output_format'] = undefined;
|
|
@@ -385,7 +474,7 @@ UpdateTemplateRequest.prototype['default_form_mode'] = undefined;
|
|
|
385
474
|
UpdateTemplateRequest.prototype['editable_submissions'] = undefined;
|
|
386
475
|
|
|
387
476
|
/**
|
|
388
|
-
* The sites that can embed the template's live signature requests and its embedded template editor: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and
|
|
477
|
+
* The sites that can embed the template's live signature requests and its embedded template editor: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work), without a path. Each one is stored in lowercase, without a trailing slash. Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and Web Forms JS) aren't restricted.
|
|
389
478
|
* @member {Array.<String>} embed_domains
|
|
390
479
|
*/
|
|
391
480
|
UpdateTemplateRequest.prototype['embed_domains'] = undefined;
|
|
@@ -463,11 +552,71 @@ UpdateTemplateRequest.prototype['public_submissions'] = undefined;
|
|
|
463
552
|
UpdateTemplateRequest.prototype['public_web_form'] = undefined;
|
|
464
553
|
|
|
465
554
|
/**
|
|
466
|
-
* Where the web form sends people after they submit it.
|
|
555
|
+
* Where the web form sends people after they submit it, instead of showing its success screen. After its `?` or `#`, it can have variables such as `{{ data.first_name }}`, which the form fills in with what they submitted.
|
|
467
556
|
* @member {String} redirect_url
|
|
468
557
|
*/
|
|
469
558
|
UpdateTemplateRequest.prototype['redirect_url'] = undefined;
|
|
470
559
|
|
|
560
|
+
/**
|
|
561
|
+
* How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached. PDF templates only. A signature request uses the value it had when the request was created.
|
|
562
|
+
* @member {module:model/SignatureRequestEmailAttachments} signature_request_email_attachments
|
|
563
|
+
*/
|
|
564
|
+
UpdateTemplateRequest.prototype['signature_request_email_attachments'] = undefined;
|
|
565
|
+
|
|
566
|
+
/**
|
|
567
|
+
* The address DocSpring's emails to your signers come from: an address at one of your verified email domains, on the Growth plan or higher. Null sends them from DocSpring's shared address, with "via DocSpring" after the sender name. PDF templates only.
|
|
568
|
+
* @member {String} signature_request_from_address
|
|
569
|
+
*/
|
|
570
|
+
UpdateTemplateRequest.prototype['signature_request_from_address'] = undefined;
|
|
571
|
+
|
|
572
|
+
/**
|
|
573
|
+
* Puts a signing token in `signature_request_signing_url`, as `{{ token_id }}` and `{{ token_secret }}`, so your page can open the signing form without creating a token itself. The email then carries a credential: anyone who has it can open the form and sign. PDF templates only.
|
|
574
|
+
* @member {Boolean} signature_request_include_signing_token
|
|
575
|
+
*/
|
|
576
|
+
UpdateTemplateRequest.prototype['signature_request_include_signing_token'] = undefined;
|
|
577
|
+
|
|
578
|
+
/**
|
|
579
|
+
* The sender name on the emails DocSpring sends your signers, as in "Acme via DocSpring". It can't contain an email address, a website or quotes. Null uses your account's name. PDF templates only.
|
|
580
|
+
* @member {String} signature_request_from_name
|
|
581
|
+
*/
|
|
582
|
+
UpdateTemplateRequest.prototype['signature_request_from_name'] = undefined;
|
|
583
|
+
|
|
584
|
+
/**
|
|
585
|
+
* Who DocSpring tells when a signature request's document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Empty means your account's owner. A submission's `notification_emails` replaces them. PDF templates only.
|
|
586
|
+
* @member {Array.<String>} signature_request_notification_emails
|
|
587
|
+
*/
|
|
588
|
+
UpdateTemplateRequest.prototype['signature_request_notification_emails'] = undefined;
|
|
589
|
+
|
|
590
|
+
/**
|
|
591
|
+
* Where your signers' replies to DocSpring's emails go: a member of your DocSpring team or an address at one of your verified email domains. Null means your account's owner. A submission's `reply_to` replaces it. PDF templates only.
|
|
592
|
+
* @member {String} signature_request_reply_to
|
|
593
|
+
*/
|
|
594
|
+
UpdateTemplateRequest.prototype['signature_request_reply_to'] = undefined;
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page. PDF templates only.
|
|
598
|
+
* @member {String} signature_request_signing_url
|
|
599
|
+
*/
|
|
600
|
+
UpdateTemplateRequest.prototype['signature_request_signing_url'] = undefined;
|
|
601
|
+
|
|
602
|
+
/**
|
|
603
|
+
* The title of the web form's success screen. When it's null or empty, the screen says "Thanks for filling out" and the template's name. It can have variables such as `{{ data.first_name }}`.
|
|
604
|
+
* @member {String} success_title
|
|
605
|
+
*/
|
|
606
|
+
UpdateTemplateRequest.prototype['success_title'] = undefined;
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* A message under the title of the web form's success screen, as plain text. Line breaks show, and web addresses become links. It can have variables such as `{{ data.first_name }}`.
|
|
610
|
+
* @member {String} success_message
|
|
611
|
+
*/
|
|
612
|
+
UpdateTemplateRequest.prototype['success_message'] = undefined;
|
|
613
|
+
|
|
614
|
+
/**
|
|
615
|
+
* Whether the web form's success screen has a "Fill out again" button, which clears the form so someone can fill it in again.
|
|
616
|
+
* @member {Boolean} show_fill_again_button
|
|
617
|
+
*/
|
|
618
|
+
UpdateTemplateRequest.prototype['show_fill_again_button'] = undefined;
|
|
619
|
+
|
|
471
620
|
/**
|
|
472
621
|
* A Slack incoming webhook URL that is notified about the template's submissions. It's never returned; `has_slack_webhook_url` says if it's set.
|
|
473
622
|
* @member {String} slack_webhook_url
|
|
@@ -492,6 +641,12 @@ UpdateTemplateRequest.prototype['field_dependencies'] = undefined;
|
|
|
492
641
|
*/
|
|
493
642
|
UpdateTemplateRequest.prototype['field_groups'] = undefined;
|
|
494
643
|
|
|
644
|
+
/**
|
|
645
|
+
* The web form's sections, in order. Setting them replaces all of the sections; an empty list removes them.
|
|
646
|
+
* @member {Array.<module:model/TemplateFormSectionInput>} form_sections
|
|
647
|
+
*/
|
|
648
|
+
UpdateTemplateRequest.prototype['form_sections'] = undefined;
|
|
649
|
+
|
|
495
650
|
/**
|
|
496
651
|
* The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off.
|
|
497
652
|
* @member {Array.<module:model/PredefinedFieldInput>} predefined_fields
|
|
@@ -505,7 +660,7 @@ UpdateTemplateRequest.prototype['predefined_fields'] = undefined;
|
|
|
505
660
|
UpdateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
|
|
506
661
|
|
|
507
662
|
/**
|
|
508
|
-
* The HTML of an HTML template, as a Liquid template. Null for
|
|
663
|
+
* The HTML of an HTML template, as a Liquid template. Null for other templates.
|
|
509
664
|
* @member {String} html
|
|
510
665
|
*/
|
|
511
666
|
UpdateTemplateRequest.prototype['html'] = undefined;
|
|
@@ -535,8 +690,14 @@ UpdateTemplateRequest.prototype['footer_html'] = undefined;
|
|
|
535
690
|
UpdateTemplateRequest.prototype['html_engine_options'] = undefined;
|
|
536
691
|
|
|
537
692
|
/**
|
|
538
|
-
* Whether an HTML template HTML-escapes the values it prints. When true, `{{ value }}` prints a value as text, so a `<` or `&` in it is printed as that character, and `{{ value | raw }}` prints a value as HTML. New HTML templates default to true. Templates created before October 2026, or with API v1, default to false, which prints every value as HTML. Null for
|
|
693
|
+
* Whether an HTML template HTML-escapes the values it prints. When true, `{{ value }}` prints a value as text, so a `<` or `&` in it is printed as that character, and `{{ value | raw }}` prints a value as HTML. New HTML templates default to true. Templates created before October 2026, or with API v1, default to false, which prints every value as HTML. Null for other templates.
|
|
539
694
|
* @member {Boolean} html_escape_data
|
|
540
695
|
*/
|
|
541
696
|
UpdateTemplateRequest.prototype['html_escape_data'] = undefined;
|
|
697
|
+
|
|
698
|
+
/**
|
|
699
|
+
* A page design's layout: its page setup, its sections and the elements placed in them, in the Page Designer layout format (https://docspring.com/docs/page-designer/layout-format/). Its JSON Schema is at https://docspring.com/schemas/page-designer/layout.v1.json. Null for other templates. Setting it replaces the whole layout, and DocSpring adds a field for each value it reads. Left out when a page design is created, it starts with an empty page.
|
|
700
|
+
* @member {Object.<String, Object>} layout
|
|
701
|
+
*/
|
|
702
|
+
UpdateTemplateRequest.prototype['layout'] = undefined;
|
|
542
703
|
var _default = exports["default"] = UpdateTemplateRequest;
|
|
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
28
28
|
/**
|
|
29
29
|
* The UpdateWebhookRequest model module.
|
|
30
30
|
* @module model/UpdateWebhookRequest
|
|
31
|
-
* @version 4.
|
|
31
|
+
* @version 4.5.0
|
|
32
32
|
*/
|
|
33
33
|
var UpdateWebhookRequest = /*#__PURE__*/function () {
|
|
34
34
|
/**
|
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
30
30
|
/**
|
|
31
31
|
* The UploadPresign model module.
|
|
32
32
|
* @module model/UploadPresign
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.5.0
|
|
34
34
|
*/
|
|
35
35
|
var UploadPresign = /*#__PURE__*/function () {
|
|
36
36
|
/**
|