docspring 4.2.0 → 4.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +2 -2
- package/README.md +26 -6
- package/dist/ApiClient.js +3 -3
- package/dist/RequestSchemas.js +1171 -134
- package/dist/RequestValidator.js +4 -0
- package/dist/api/Client.js +1406 -248
- package/dist/index.js +196 -0
- package/dist/model/AddTemplateFieldsRequest.js +4 -4
- package/dist/model/AiFieldNamingLanguage.js +1 -1
- package/dist/model/AuthenticationCheck.js +2 -2
- package/dist/model/BarcodeSymbology.js +1 -1
- package/dist/model/CheckCharacter.js +1 -1
- package/dist/model/CombinedFieldType.js +1 -1
- package/dist/model/CombinedPdf.js +2 -2
- package/dist/model/CombinedPdfFiles.js +2 -2
- package/dist/model/CombinedPdfList.js +2 -2
- package/dist/model/CombinedPdfSource.js +3 -3
- package/dist/model/CombinedPdfSourceInput.js +3 -3
- package/dist/model/CombinedPdfSourcePdf.js +2 -2
- package/dist/model/CombinedPdfSourceType.js +1 -1
- package/dist/model/CombinedPdfState.js +1 -1
- package/dist/model/CopyTemplateRequest.js +2 -2
- package/dist/model/CreateAccountEmailActionRequest.js +306 -0
- package/dist/model/CreateCombinedPdfRequest.js +2 -2
- package/dist/model/CreateCustomFileFromUploadRequest.js +2 -2
- package/dist/model/CreateEmailActionRequest.js +280 -0
- package/dist/model/CreateEmailDomainRequest.js +114 -0
- package/dist/model/CreateFolderRequest.js +2 -2
- package/dist/model/CreateSignatureRequestEventRequest.js +2 -2
- package/dist/model/CreateSignatureRequestTokenRequest.js +2 -2
- package/dist/model/CreateSubmissionBatchRequest.js +5 -5
- package/dist/model/CreateSubmissionRequest.js +115 -7
- package/dist/model/CreateTemplatePreviewRequest.js +2 -2
- package/dist/model/CreateTemplateRequest.js +119 -14
- package/dist/model/CreateWebhookRequest.js +2 -2
- package/dist/model/CustomFile.js +2 -2
- package/dist/model/CustomFileList.js +2 -2
- package/dist/model/CustomFileSourcePdf.js +2 -2
- package/dist/model/DnsRecordType.js +64 -0
- package/dist/model/EmailAction.js +510 -0
- package/dist/model/EmailActionConditions.js +142 -0
- package/dist/model/EmailActionConditionsInput.js +142 -0
- package/dist/model/EmailActionCustomization.js +222 -0
- package/dist/model/EmailActionDelivery.js +59 -0
- package/dist/model/EmailActionFileFormats.js +69 -0
- package/dist/model/EmailActionList.js +132 -0
- package/dist/model/EmailActionSetting.js +119 -0
- package/dist/model/EmailActionSubmissionType.js +64 -0
- package/dist/model/EmailActionTestEmail.js +116 -0
- package/dist/model/EmailDomain.js +245 -0
- package/dist/model/EmailDomainDnsRecord.js +155 -0
- package/dist/model/EmailDomainDnsRecordPurpose.js +64 -0
- package/dist/model/EmailDomainList.js +132 -0
- package/dist/model/EmailDomainRecordState.js +64 -0
- package/dist/model/EmailDomainState.js +64 -0
- package/dist/model/ErrorCode.js +11 -1
- package/dist/model/ErrorDetail.js +2 -2
- package/dist/model/ErrorInfo.js +47 -8
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/ExpirationInterval.js +1 -1
- package/dist/model/Field.js +5 -5
- package/dist/model/FieldComparisonCondition.js +2 -2
- package/dist/model/FieldComparisonOperator.js +1 -1
- package/dist/model/FieldDependency.js +2 -2
- package/dist/model/FieldDependencyInput.js +2 -2
- package/dist/model/FieldDisplayType.js +1 -1
- package/dist/model/FieldEqualsCondition.js +2 -2
- package/dist/model/FieldEqualsOperator.js +1 -1
- package/dist/model/FieldGroup.js +6 -6
- package/dist/model/FieldGroupInput.js +3 -3
- package/dist/model/FieldGroupType.js +1 -1
- package/dist/model/FieldInCondition.js +2 -2
- package/dist/model/FieldInput.js +4 -4
- package/dist/model/FieldOverride.js +2 -2
- package/dist/model/FieldPresenceCondition.js +2 -2
- package/dist/model/FieldPresenceOperator.js +1 -1
- package/dist/model/FieldRangeCondition.js +2 -2
- package/dist/model/FieldReimportState.js +1 -1
- package/dist/model/FieldSetupLogic.js +1 -1
- package/dist/model/FieldSetupNaming.js +1 -1
- package/dist/model/FieldSetupSource.js +1 -1
- package/dist/model/FieldType.js +1 -1
- package/dist/model/Folder.js +2 -2
- package/dist/model/FolderList.js +2 -2
- package/dist/model/GenerateFilesFormat.js +16 -1
- package/dist/model/GenerateSubmissionFilesRequest.js +4 -4
- package/dist/model/GeneratedFile.js +7 -7
- package/dist/model/GeneratedFileState.js +1 -1
- package/dist/model/HtmlEngineOptions.js +4 -4
- package/dist/model/HtmlEngineOptionsInput.js +3 -3
- package/dist/model/ImageGravity.js +1 -1
- package/dist/model/ImageScaleType.js +1 -1
- package/dist/model/ModelCodeLanguage.js +7 -2
- package/dist/model/MoveFolderRequest.js +2 -2
- package/dist/model/MoveTemplateRequest.js +2 -2
- package/dist/model/NumberConditionType.js +1 -1
- package/dist/model/OutputFormat.js +11 -1
- package/dist/model/PageFormat.js +1 -1
- package/dist/model/PageImage.js +2 -2
- package/dist/model/PageImages.js +2 -2
- package/dist/model/PredefinedField.js +2 -2
- package/dist/model/PredefinedFieldInput.js +2 -2
- package/dist/model/PublishTemplateVersionRequest.js +2 -2
- package/dist/model/RemoveTemplateFieldsRequest.js +2 -2
- package/dist/model/RenameFolderRequest.js +2 -2
- package/dist/model/ReorderTemplateFieldsRequest.js +2 -2
- package/dist/model/RestoreTemplateVersionRequest.js +2 -2
- package/dist/model/SendAccountEmailActionTestEmailRequest.js +91 -0
- package/dist/model/ShapeType.js +1 -1
- package/dist/model/SignatureRequest.js +53 -8
- package/dist/model/SignatureRequestAuthSecondFactorType.js +1 -1
- package/dist/model/SignatureRequestAuthType.js +1 -1
- package/dist/model/SignatureRequestEmailAttachments.js +59 -0
- package/dist/model/SignatureRequestEmailStatus.js +89 -0
- package/dist/model/SignatureRequestEvent.js +2 -2
- package/dist/model/SignatureRequestEventType.js +12 -2
- package/dist/model/SignatureRequestInput.js +25 -9
- package/dist/model/SignatureRequestMessageType.js +1 -1
- package/dist/model/SignatureRequestReminders.js +121 -0
- package/dist/model/SignatureRequestState.js +1 -1
- package/dist/model/SignatureRequestToken.js +2 -2
- package/dist/model/SignatureRequestTokenType.js +1 -1
- package/dist/model/SigningOrder.js +59 -0
- package/dist/model/StringConditionType.js +37 -2
- package/dist/model/Submission.js +31 -19
- package/dist/model/SubmissionAction.js +28 -13
- package/dist/model/SubmissionActionState.js +1 -1
- package/dist/model/SubmissionActionType.js +1 -1
- package/dist/model/SubmissionBatch.js +9 -9
- package/dist/model/SubmissionBatchState.js +1 -1
- package/dist/model/SubmissionFiles.js +20 -2
- package/dist/model/SubmissionInput.js +7 -7
- package/dist/model/SubmissionList.js +2 -2
- package/dist/model/SubmissionSource.js +1 -1
- package/dist/model/SubmissionSourcePdf.js +2 -2
- package/dist/model/SubmissionState.js +1 -1
- package/dist/model/SubmissionSummary.js +8 -8
- package/dist/model/SubmissionValidation.js +2 -2
- package/dist/model/Template.js +149 -26
- package/dist/model/TemplateActor.js +2 -2
- package/dist/model/TemplateActorType.js +1 -1
- package/dist/model/TemplateDefaults.js +2 -2
- package/dist/model/TemplateDefaultsInput.js +2 -2
- package/dist/model/TemplateDiff.js +6 -6
- package/dist/model/TemplateDiffSummary.js +2 -2
- package/dist/model/TemplateDocument.js +23 -23
- package/dist/model/TemplateDocumentState.js +12 -2
- package/dist/model/TemplateDocumentSummary.js +11 -11
- package/dist/model/TemplateFieldChange.js +2 -2
- package/dist/model/TemplateFieldChanges.js +2 -2
- package/dist/model/TemplateFieldDependency.js +2 -2
- package/dist/model/TemplateFieldDependencyAction.js +1 -1
- package/dist/model/TemplateFieldDependencyCondition.js +2 -2
- package/dist/model/TemplateFieldDependencyConditionInput.js +2 -2
- package/dist/model/TemplateFieldDependencyInput.js +2 -2
- package/dist/model/TemplateFieldDependencyMatch.js +1 -1
- package/dist/model/TemplateFieldDependencyOperator.js +1 -1
- package/dist/model/TemplateFieldLogicStatus.js +1 -1
- package/dist/model/TemplateFieldMove.js +2 -2
- package/dist/model/TemplateFields.js +2 -2
- package/dist/model/TemplateFormMode.js +1 -1
- package/dist/model/TemplateModelCode.js +2 -2
- package/dist/model/TemplatePageAiError.js +1 -1
- package/dist/model/TemplatePageAiNamingStatus.js +1 -1
- package/dist/model/TemplatePageFieldsStatus.js +1 -1
- package/dist/model/TemplatePageImageStatus.js +1 -1
- package/dist/model/TemplatePageImages.js +2 -2
- package/dist/model/TemplatePageProcessingStatus.js +2 -2
- package/dist/model/TemplatePreview.js +5 -5
- package/dist/model/TemplatePreviewState.js +1 -1
- package/dist/model/TemplateSourcePdf.js +3 -3
- package/dist/model/TemplateSummary.js +24 -12
- package/dist/model/TemplateSummaryList.js +2 -2
- package/dist/model/TemplateType.js +12 -2
- package/dist/model/TemplateVersion.js +2 -2
- package/dist/model/TemplateVersionType.js +1 -1
- package/dist/model/TextAlignment.js +1 -1
- package/dist/model/TextOverflow.js +1 -1
- package/dist/model/TextVerticalAlignment.js +1 -1
- package/dist/model/Typeface.js +1 -1
- package/dist/model/UpdateAccountEmailActionRequest.js +306 -0
- package/dist/model/UpdateEmailActionCustomizationRequest.js +258 -0
- package/dist/model/UpdateEmailActionRequest.js +280 -0
- package/dist/model/UpdateSignatureRequestRequest.js +2 -2
- package/dist/model/UpdateTemplateDocumentRequest.js +8 -8
- package/dist/model/UpdateTemplateFieldsRequest.js +2 -2
- package/dist/model/UpdateTemplateRequest.js +113 -8
- package/dist/model/UpdateWebhookRequest.js +2 -2
- package/dist/model/UploadMethod.js +1 -1
- package/dist/model/UploadPresign.js +2 -2
- package/dist/model/UrlSourcePdf.js +2 -2
- package/dist/model/ValidateSubmissionRequest.js +115 -7
- package/dist/model/Webhook.js +2 -2
- package/dist/model/WebhookEventType.js +11 -1
- package/dist/model/WebhookList.js +2 -2
- package/dist/model/WebhookMode.js +1 -1
- package/package.json +2 -2
|
@@ -18,7 +18,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
18
18
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
19
19
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
20
20
|
* DocSpring API
|
|
21
|
-
* Use DocSpring's API to
|
|
21
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
22
22
|
*
|
|
23
23
|
* The version of the OpenAPI document: v2
|
|
24
24
|
*
|
|
@@ -31,24 +31,25 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
31
31
|
/**
|
|
32
32
|
* The SubmissionAction model module.
|
|
33
33
|
* @module model/SubmissionAction
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.4.0
|
|
35
35
|
*/
|
|
36
36
|
var SubmissionAction = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
38
38
|
* Constructs a new <code>SubmissionAction</code>.
|
|
39
|
-
* An upload of a PDF to your storage, such as an S3 bucket.
|
|
39
|
+
* An upload of a PDF to your storage, such as an S3 bucket, or an email action's email.
|
|
40
40
|
* @alias module:model/SubmissionAction
|
|
41
41
|
* @extends Object
|
|
42
42
|
* @param id {String} The upload's ID.
|
|
43
43
|
* @param integration_id {String} The ID of the account integration it used.
|
|
44
|
-
* @param
|
|
45
|
-
* @param
|
|
46
|
-
* @param
|
|
44
|
+
* @param email_action_id {String} The ID of the email action that sent the email. Null for an upload, or once the email action is deleted.
|
|
45
|
+
* @param state {module:model/SubmissionActionState} `pending` until the upload or email has run, then `processed`. `failed`: your storage or the email service rejected it. `error`: it failed in DocSpring.
|
|
46
|
+
* @param action_type {module:model/SubmissionActionType} The kind of storage, such as `aws_s3_upload` for an S3 bucket, or `email` for an email action's email.
|
|
47
|
+
* @param result_data {Object.<String, Object>} Where the PDF was uploaded, such as the S3 bucket and key. For an email: its `subject`, `recipients`, each with its `address`, `kind` (`to`, `cc` or `bcc`), `source`, `field` or `metadata` when the address came from one, and `status` (`sent`, `delivered`, `bounced`, `complained`, `skipped` and others), `sent_at`, `delivery`, and `files` (the files it sent: `pdf`, `docx`, `odt`). An email whose submission didn't meet the email action's `send_when` conditions has only `skipped`, `conditions_not_met`, and its state is `processed`. An email whose submission made none of the files the email action sends has `skipped`, `no_files` and the action's `file_formats`, and its state is `processed` too. When the submission's data is left out (a batch, or a webhook without submission data), the subject and the addresses that came from fields or metadata are null.
|
|
47
48
|
* @param error_message {String} Why the upload failed, when `state` is `failed` or `error`.
|
|
48
49
|
*/
|
|
49
|
-
function SubmissionAction(id, integration_id, state, action_type, result_data, error_message) {
|
|
50
|
+
function SubmissionAction(id, integration_id, email_action_id, state, action_type, result_data, error_message) {
|
|
50
51
|
_classCallCheck(this, SubmissionAction);
|
|
51
|
-
SubmissionAction.initialize(this, id, integration_id, state, action_type, result_data, error_message);
|
|
52
|
+
SubmissionAction.initialize(this, id, integration_id, email_action_id, state, action_type, result_data, error_message);
|
|
52
53
|
}
|
|
53
54
|
|
|
54
55
|
/**
|
|
@@ -58,9 +59,10 @@ var SubmissionAction = /*#__PURE__*/function () {
|
|
|
58
59
|
*/
|
|
59
60
|
return _createClass(SubmissionAction, null, [{
|
|
60
61
|
key: "initialize",
|
|
61
|
-
value: function initialize(obj, id, integration_id, state, action_type, result_data, error_message) {
|
|
62
|
+
value: function initialize(obj, id, integration_id, email_action_id, state, action_type, result_data, error_message) {
|
|
62
63
|
obj['id'] = id;
|
|
63
64
|
obj['integration_id'] = integration_id;
|
|
65
|
+
obj['email_action_id'] = email_action_id;
|
|
64
66
|
obj['state'] = state;
|
|
65
67
|
obj['action_type'] = action_type;
|
|
66
68
|
obj['result_data'] = result_data;
|
|
@@ -86,6 +88,9 @@ var SubmissionAction = /*#__PURE__*/function () {
|
|
|
86
88
|
if (data.hasOwnProperty('integration_id')) {
|
|
87
89
|
obj['integration_id'] = _ApiClient["default"].convertToType(data['integration_id'], 'String');
|
|
88
90
|
}
|
|
91
|
+
if (data.hasOwnProperty('email_action_id')) {
|
|
92
|
+
obj['email_action_id'] = _ApiClient["default"].convertToType(data['email_action_id'], 'String');
|
|
93
|
+
}
|
|
89
94
|
if (data.hasOwnProperty('state')) {
|
|
90
95
|
obj['state'] = _ApiClient["default"].convertToType(data['state'], _SubmissionActionState["default"]);
|
|
91
96
|
}
|
|
@@ -136,6 +141,10 @@ var SubmissionAction = /*#__PURE__*/function () {
|
|
|
136
141
|
throw new Error("Expected the field `integration_id` to be a primitive type in the JSON string but got " + data['integration_id']);
|
|
137
142
|
}
|
|
138
143
|
// ensure the json data is a string
|
|
144
|
+
if (data['email_action_id'] && !(typeof data['email_action_id'] === 'string' || data['email_action_id'] instanceof String)) {
|
|
145
|
+
throw new Error("Expected the field `email_action_id` to be a primitive type in the JSON string but got " + data['email_action_id']);
|
|
146
|
+
}
|
|
147
|
+
// ensure the json data is a string
|
|
139
148
|
if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
|
|
140
149
|
throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
|
|
141
150
|
}
|
|
@@ -143,7 +152,7 @@ var SubmissionAction = /*#__PURE__*/function () {
|
|
|
143
152
|
}
|
|
144
153
|
}]);
|
|
145
154
|
}();
|
|
146
|
-
SubmissionAction.RequiredProperties = ["id", "integration_id", "state", "action_type", "result_data", "error_message"];
|
|
155
|
+
SubmissionAction.RequiredProperties = ["id", "integration_id", "email_action_id", "state", "action_type", "result_data", "error_message"];
|
|
147
156
|
|
|
148
157
|
/**
|
|
149
158
|
* The upload's ID.
|
|
@@ -158,19 +167,25 @@ SubmissionAction.prototype['id'] = undefined;
|
|
|
158
167
|
SubmissionAction.prototype['integration_id'] = undefined;
|
|
159
168
|
|
|
160
169
|
/**
|
|
161
|
-
*
|
|
170
|
+
* The ID of the email action that sent the email. Null for an upload, or once the email action is deleted.
|
|
171
|
+
* @member {String} email_action_id
|
|
172
|
+
*/
|
|
173
|
+
SubmissionAction.prototype['email_action_id'] = undefined;
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* `pending` until the upload or email has run, then `processed`. `failed`: your storage or the email service rejected it. `error`: it failed in DocSpring.
|
|
162
177
|
* @member {module:model/SubmissionActionState} state
|
|
163
178
|
*/
|
|
164
179
|
SubmissionAction.prototype['state'] = undefined;
|
|
165
180
|
|
|
166
181
|
/**
|
|
167
|
-
* The kind of storage, such as `aws_s3_upload` for an S3 bucket.
|
|
182
|
+
* The kind of storage, such as `aws_s3_upload` for an S3 bucket, or `email` for an email action's email.
|
|
168
183
|
* @member {module:model/SubmissionActionType} action_type
|
|
169
184
|
*/
|
|
170
185
|
SubmissionAction.prototype['action_type'] = undefined;
|
|
171
186
|
|
|
172
187
|
/**
|
|
173
|
-
* Where the PDF was uploaded, such as the S3 bucket and key.
|
|
188
|
+
* Where the PDF was uploaded, such as the S3 bucket and key. For an email: its `subject`, `recipients`, each with its `address`, `kind` (`to`, `cc` or `bcc`), `source`, `field` or `metadata` when the address came from one, and `status` (`sent`, `delivered`, `bounced`, `complained`, `skipped` and others), `sent_at`, `delivery`, and `files` (the files it sent: `pdf`, `docx`, `odt`). An email whose submission didn't meet the email action's `send_when` conditions has only `skipped`, `conditions_not_met`, and its state is `processed`. An email whose submission made none of the files the email action sends has `skipped`, `no_files` and the action's `file_formats`, and its state is `processed` too. When the submission's data is left out (a batch, or a webhook without submission data), the subject and the addresses that came from fields or metadata are null.
|
|
174
189
|
* @member {Object.<String, Object>} result_data
|
|
175
190
|
*/
|
|
176
191
|
SubmissionAction.prototype['result_data'] = undefined;
|
|
@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
|
|
|
14
14
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
15
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
16
16
|
* DocSpring API
|
|
17
|
-
* Use DocSpring's API to
|
|
17
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
18
18
|
*
|
|
19
19
|
* The version of the OpenAPI document: v2
|
|
20
20
|
*
|
|
@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
|
|
|
14
14
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
15
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
16
16
|
* DocSpring API
|
|
17
|
-
* Use DocSpring's API to
|
|
17
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
18
18
|
*
|
|
19
19
|
* The version of the OpenAPI document: v2
|
|
20
20
|
*
|
|
@@ -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,20 +31,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
31
31
|
/**
|
|
32
32
|
* The SubmissionBatch model module.
|
|
33
33
|
* @module model/SubmissionBatch
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.4.0
|
|
35
35
|
*/
|
|
36
36
|
var SubmissionBatch = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
38
38
|
* Constructs a new <code>SubmissionBatch</code>.
|
|
39
|
-
* Submissions created together in one request. Their
|
|
39
|
+
* Submissions created together in one request. Their files are only generated when every submission in the batch is valid.
|
|
40
40
|
* @alias module:model/SubmissionBatch
|
|
41
41
|
* @extends Object
|
|
42
42
|
* @param id {String} The batch's ID.
|
|
43
|
-
* @param state {module:model/SubmissionBatchState} `pending` while the
|
|
43
|
+
* @param state {module:model/SubmissionBatchState} `pending` while the files are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
|
|
44
44
|
* @param metadata {Object.<String, Object>} Your own data about the batch, such as an ID from your app.
|
|
45
45
|
* @param total_count {Number} The number of submissions in the request.
|
|
46
|
-
* @param pending_count {Number} The submissions whose
|
|
47
|
-
* @param error_count {Number} The submissions that were invalid or whose
|
|
46
|
+
* @param pending_count {Number} The submissions whose files haven't been generated yet.
|
|
47
|
+
* @param error_count {Number} The submissions that were invalid or whose files couldn't be generated.
|
|
48
48
|
* @param completion_percentage {Number} The percentage of the batch's submissions that have finished, from 0 to 100.
|
|
49
49
|
* @param submissions {Array.<module:model/Submission>} The batch's submissions, in the order of the request. Their `data` is null unless you pass `include_data=true`. A batch that failed validation only has the submissions that were recorded as `invalid_data`.
|
|
50
50
|
* @param processed_at {Date} When every submission had finished.
|
|
@@ -173,7 +173,7 @@ SubmissionBatch.RequiredProperties = ["id", "state", "metadata", "total_count",
|
|
|
173
173
|
SubmissionBatch.prototype['id'] = undefined;
|
|
174
174
|
|
|
175
175
|
/**
|
|
176
|
-
* `pending` while the
|
|
176
|
+
* `pending` while the files are being generated, then `processed`. `error` as soon as a submission fails, while the others can still be pending: the batch has finished once `processed_at` is set.
|
|
177
177
|
* @member {module:model/SubmissionBatchState} state
|
|
178
178
|
*/
|
|
179
179
|
SubmissionBatch.prototype['state'] = undefined;
|
|
@@ -191,13 +191,13 @@ SubmissionBatch.prototype['metadata'] = undefined;
|
|
|
191
191
|
SubmissionBatch.prototype['total_count'] = undefined;
|
|
192
192
|
|
|
193
193
|
/**
|
|
194
|
-
* The submissions whose
|
|
194
|
+
* The submissions whose files haven't been generated yet.
|
|
195
195
|
* @member {Number} pending_count
|
|
196
196
|
*/
|
|
197
197
|
SubmissionBatch.prototype['pending_count'] = undefined;
|
|
198
198
|
|
|
199
199
|
/**
|
|
200
|
-
* The submissions that were invalid or whose
|
|
200
|
+
* The submissions that were invalid or whose files couldn't be generated.
|
|
201
201
|
* @member {Number} error_count
|
|
202
202
|
*/
|
|
203
203
|
SubmissionBatch.prototype['error_count'] = undefined;
|
|
@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
|
|
|
14
14
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
15
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
16
16
|
* DocSpring API
|
|
17
|
-
* Use DocSpring's API to
|
|
17
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
18
18
|
*
|
|
19
19
|
* The version of the OpenAPI document: v2
|
|
20
20
|
*
|
|
@@ -15,7 +15,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
15
15
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
16
16
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
17
17
|
* DocSpring API
|
|
18
|
-
* Use DocSpring's API to
|
|
18
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
19
19
|
*
|
|
20
20
|
* The version of the OpenAPI document: v2
|
|
21
21
|
*
|
|
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
28
28
|
/**
|
|
29
29
|
* The SubmissionFiles model module.
|
|
30
30
|
* @module model/SubmissionFiles
|
|
31
|
-
* @version 4.
|
|
31
|
+
* @version 4.4.0
|
|
32
32
|
*/
|
|
33
33
|
var SubmissionFiles = /*#__PURE__*/function () {
|
|
34
34
|
/**
|
|
@@ -73,6 +73,12 @@ var SubmissionFiles = /*#__PURE__*/function () {
|
|
|
73
73
|
if (data.hasOwnProperty('preview')) {
|
|
74
74
|
obj['preview'] = _ApiClient["default"].convertToType(data['preview'], _GeneratedFile["default"]);
|
|
75
75
|
}
|
|
76
|
+
if (data.hasOwnProperty('docx')) {
|
|
77
|
+
obj['docx'] = _ApiClient["default"].convertToType(data['docx'], _GeneratedFile["default"]);
|
|
78
|
+
}
|
|
79
|
+
if (data.hasOwnProperty('odt')) {
|
|
80
|
+
obj['odt'] = _ApiClient["default"].convertToType(data['odt'], _GeneratedFile["default"]);
|
|
81
|
+
}
|
|
76
82
|
if (data.hasOwnProperty('png')) {
|
|
77
83
|
obj['png'] = data['png'] === null ? null : _PageImages["default"].constructFromObject(data['png']);
|
|
78
84
|
}
|
|
@@ -110,6 +116,18 @@ SubmissionFiles.prototype['audit_trail'] = undefined;
|
|
|
110
116
|
*/
|
|
111
117
|
SubmissionFiles.prototype['preview'] = undefined;
|
|
112
118
|
|
|
119
|
+
/**
|
|
120
|
+
* The Word document of a Word template's submission, when the submission makes one (`output_formats`).
|
|
121
|
+
* @member {module:model/GeneratedFile} docx
|
|
122
|
+
*/
|
|
123
|
+
SubmissionFiles.prototype['docx'] = undefined;
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* The OpenDocument file (.odt, the format LibreOffice uses) of a Word template's submission, converted from its Word document, when the submission makes one (`output_formats`).
|
|
127
|
+
* @member {module:model/GeneratedFile} odt
|
|
128
|
+
*/
|
|
129
|
+
SubmissionFiles.prototype['odt'] = undefined;
|
|
130
|
+
|
|
113
131
|
/**
|
|
114
132
|
* @member {module:model/PageImages} png
|
|
115
133
|
*/
|
|
@@ -15,7 +15,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
15
15
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
16
16
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
17
17
|
* DocSpring API
|
|
18
|
-
* Use DocSpring's API to
|
|
18
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
19
19
|
*
|
|
20
20
|
* The version of the OpenAPI document: v2
|
|
21
21
|
*
|
|
@@ -28,7 +28,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
28
28
|
/**
|
|
29
29
|
* The SubmissionInput model module.
|
|
30
30
|
* @module model/SubmissionInput
|
|
31
|
-
* @version 4.
|
|
31
|
+
* @version 4.4.0
|
|
32
32
|
*/
|
|
33
33
|
var SubmissionInput = /*#__PURE__*/function () {
|
|
34
34
|
/**
|
|
@@ -145,7 +145,7 @@ var SubmissionInput = /*#__PURE__*/function () {
|
|
|
145
145
|
}]);
|
|
146
146
|
}();
|
|
147
147
|
/**
|
|
148
|
-
* Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
|
|
148
|
+
* 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.
|
|
149
149
|
* @member {Boolean} test
|
|
150
150
|
*/
|
|
151
151
|
SubmissionInput.prototype['test'] = undefined;
|
|
@@ -157,7 +157,7 @@ SubmissionInput.prototype['test'] = undefined;
|
|
|
157
157
|
SubmissionInput.prototype['editable'] = undefined;
|
|
158
158
|
|
|
159
159
|
/**
|
|
160
|
-
* The values of the template's fields, by field name. Required for
|
|
160
|
+
* The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs.
|
|
161
161
|
* @member {Object.<String, Object>} data
|
|
162
162
|
*/
|
|
163
163
|
SubmissionInput.prototype['data'] = undefined;
|
|
@@ -169,19 +169,19 @@ SubmissionInput.prototype['data'] = undefined;
|
|
|
169
169
|
SubmissionInput.prototype['metadata'] = undefined;
|
|
170
170
|
|
|
171
171
|
/**
|
|
172
|
-
* A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
|
|
172
|
+
* 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.
|
|
173
173
|
* @member {String} password
|
|
174
174
|
*/
|
|
175
175
|
SubmissionInput.prototype['password'] = undefined;
|
|
176
176
|
|
|
177
177
|
/**
|
|
178
|
-
* 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.
|
|
178
|
+
* 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.
|
|
179
179
|
* @member {Array.<module:model/OutputFormat>} output_formats
|
|
180
180
|
*/
|
|
181
181
|
SubmissionInput.prototype['output_formats'] = undefined;
|
|
182
182
|
|
|
183
183
|
/**
|
|
184
|
-
* 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.
|
|
184
|
+
* 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.
|
|
185
185
|
* @member {Number} expires_in
|
|
186
186
|
*/
|
|
187
187
|
SubmissionInput.prototype['expires_in'] = undefined;
|
|
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
17
17
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
18
18
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
19
19
|
* DocSpring API
|
|
20
|
-
* Use DocSpring's API to
|
|
20
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
21
21
|
*
|
|
22
22
|
* The version of the OpenAPI document: v2
|
|
23
23
|
*
|
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
30
30
|
/**
|
|
31
31
|
* The SubmissionList model module.
|
|
32
32
|
* @module model/SubmissionList
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.4.0
|
|
34
34
|
*/
|
|
35
35
|
var SubmissionList = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
|
|
|
14
14
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
15
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
16
16
|
* DocSpring API
|
|
17
|
-
* Use DocSpring's API to
|
|
17
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
18
18
|
*
|
|
19
19
|
* The version of the OpenAPI document: v2
|
|
20
20
|
*
|
|
@@ -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 SubmissionSourcePdf model module.
|
|
31
31
|
* @module model/SubmissionSourcePdf
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.4.0
|
|
33
33
|
*/
|
|
34
34
|
var SubmissionSourcePdf = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -14,7 +14,7 @@ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object
|
|
|
14
14
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
15
15
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
16
16
|
* DocSpring API
|
|
17
|
-
* Use DocSpring's API to
|
|
17
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
18
18
|
*
|
|
19
19
|
* The version of the OpenAPI document: v2
|
|
20
20
|
*
|
|
@@ -21,7 +21,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
21
21
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
22
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); } /**
|
|
23
23
|
* DocSpring API
|
|
24
|
-
* 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.
|
|
25
25
|
*
|
|
26
26
|
* The version of the OpenAPI document: v2
|
|
27
27
|
*
|
|
@@ -34,7 +34,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
34
34
|
/**
|
|
35
35
|
* The SubmissionSummary model module.
|
|
36
36
|
* @module model/SubmissionSummary
|
|
37
|
-
* @version 4.
|
|
37
|
+
* @version 4.4.0
|
|
38
38
|
*/
|
|
39
39
|
var SubmissionSummary = /*#__PURE__*/function () {
|
|
40
40
|
/**
|
|
@@ -44,12 +44,12 @@ var SubmissionSummary = /*#__PURE__*/function () {
|
|
|
44
44
|
* @extends Object
|
|
45
45
|
* @param id {String} The submission's ID.
|
|
46
46
|
* @param template_id {String} Null once the template has been permanently deleted.
|
|
47
|
-
* @param template_type {module:model/TemplateType} The template's type: `pdf` or `
|
|
47
|
+
* @param template_type {module:model/TemplateType} The template's type: `pdf`, `html` or `docx`.
|
|
48
48
|
* @param template_version {String} The published version of the template the submission used. Null for the draft.
|
|
49
49
|
* @param batch_id {String} The ID of the batch the submission was created in.
|
|
50
50
|
* @param source {module:model/SubmissionSource} `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
|
|
51
|
-
* @param state {module:model/SubmissionState} `pending` until the
|
|
52
|
-
* @param test {Boolean} Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
|
|
51
|
+
* @param state {module:model/SubmissionState} `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
|
|
52
|
+
* @param test {Boolean} Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live.
|
|
53
53
|
* @param editable {Boolean} `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
|
|
54
54
|
* @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Null unless you pass `include_data=true`. Empty once the submission has expired.
|
|
55
55
|
* @param data_errors {Array.<module:model/ErrorDetail>} Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
|
|
@@ -240,7 +240,7 @@ SubmissionSummary.prototype['id'] = undefined;
|
|
|
240
240
|
SubmissionSummary.prototype['template_id'] = undefined;
|
|
241
241
|
|
|
242
242
|
/**
|
|
243
|
-
* The template's type: `pdf` or `
|
|
243
|
+
* The template's type: `pdf`, `html` or `docx`.
|
|
244
244
|
* @member {module:model/TemplateType} template_type
|
|
245
245
|
*/
|
|
246
246
|
SubmissionSummary.prototype['template_type'] = undefined;
|
|
@@ -264,13 +264,13 @@ SubmissionSummary.prototype['batch_id'] = undefined;
|
|
|
264
264
|
SubmissionSummary.prototype['source'] = undefined;
|
|
265
265
|
|
|
266
266
|
/**
|
|
267
|
-
* `pending` until the
|
|
267
|
+
* `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
|
|
268
268
|
* @member {module:model/SubmissionState} state
|
|
269
269
|
*/
|
|
270
270
|
SubmissionSummary.prototype['state'] = undefined;
|
|
271
271
|
|
|
272
272
|
/**
|
|
273
|
-
* Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
|
|
273
|
+
* 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.
|
|
274
274
|
* @member {Boolean} test
|
|
275
275
|
*/
|
|
276
276
|
SubmissionSummary.prototype['test'] = undefined;
|
|
@@ -17,7 +17,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
17
17
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
18
18
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
19
19
|
* DocSpring API
|
|
20
|
-
* Use DocSpring's API to
|
|
20
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
21
21
|
*
|
|
22
22
|
* The version of the OpenAPI document: v2
|
|
23
23
|
*
|
|
@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
30
30
|
/**
|
|
31
31
|
* The SubmissionValidation model module.
|
|
32
32
|
* @module model/SubmissionValidation
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.4.0
|
|
34
34
|
*/
|
|
35
35
|
var SubmissionValidation = /*#__PURE__*/function () {
|
|
36
36
|
/**
|