docspring 4.2.0 → 4.3.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 +7 -6
- package/dist/ApiClient.js +3 -3
- package/dist/RequestSchemas.js +19 -7
- package/dist/api/Client.js +53 -49
- package/dist/model/AddTemplateFieldsRequest.js +2 -2
- 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 +2 -2
- package/dist/model/CombinedPdfSourceInput.js +2 -2
- 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/CreateCombinedPdfRequest.js +2 -2
- package/dist/model/CreateCustomFileFromUploadRequest.js +2 -2
- 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 +2 -2
- package/dist/model/CreateSubmissionRequest.js +5 -5
- package/dist/model/CreateTemplatePreviewRequest.js +2 -2
- package/dist/model/CreateTemplateRequest.js +22 -12
- 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/ErrorCode.js +1 -1
- package/dist/model/ErrorDetail.js +2 -2
- package/dist/model/ErrorInfo.js +4 -4
- package/dist/model/ErrorResponse.js +2 -2
- package/dist/model/ExpirationInterval.js +1 -1
- package/dist/model/Field.js +3 -3
- 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 +3 -3
- 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 +2 -2
- package/dist/model/HtmlEngineOptionsInput.js +2 -2
- 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/ShapeType.js +1 -1
- package/dist/model/SignatureRequest.js +2 -2
- package/dist/model/SignatureRequestAuthSecondFactorType.js +1 -1
- package/dist/model/SignatureRequestAuthType.js +1 -1
- package/dist/model/SignatureRequestEvent.js +2 -2
- package/dist/model/SignatureRequestEventType.js +1 -1
- package/dist/model/SignatureRequestInput.js +2 -2
- package/dist/model/SignatureRequestMessageType.js +1 -1
- package/dist/model/SignatureRequestState.js +1 -1
- package/dist/model/SignatureRequestToken.js +2 -2
- package/dist/model/SignatureRequestTokenType.js +1 -1
- package/dist/model/StringConditionType.js +1 -1
- package/dist/model/Submission.js +11 -11
- package/dist/model/SubmissionAction.js +2 -2
- 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 +5 -5
- 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 +6 -6
- package/dist/model/SubmissionValidation.js +2 -2
- package/dist/model/Template.js +34 -22
- 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 +2 -2
- package/dist/model/TemplateSummary.js +24 -12
- package/dist/model/TemplateSummaryList.js +2 -2
- package/dist/model/TemplateType.js +7 -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/UpdateSignatureRequestRequest.js +2 -2
- package/dist/model/UpdateTemplateDocumentRequest.js +8 -8
- package/dist/model/UpdateTemplateFieldsRequest.js +2 -2
- package/dist/model/UpdateTemplateRequest.js +16 -6
- 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 +5 -5
- package/dist/model/Webhook.js +2 -2
- package/dist/model/WebhookEventType.js +1 -1
- package/dist/model/WebhookList.js +2 -2
- package/dist/model/WebhookMode.js +1 -1
- package/package.json +2 -2
package/dist/model/Submission.js
CHANGED
|
@@ -24,7 +24,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
24
24
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
25
25
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
26
26
|
* DocSpring API
|
|
27
|
-
* Use DocSpring's API to
|
|
27
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
28
28
|
*
|
|
29
29
|
* The version of the OpenAPI document: v2
|
|
30
30
|
*
|
|
@@ -37,28 +37,28 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
37
37
|
/**
|
|
38
38
|
* The Submission model module.
|
|
39
39
|
* @module model/Submission
|
|
40
|
-
* @version 4.
|
|
40
|
+
* @version 4.3.0
|
|
41
41
|
*/
|
|
42
42
|
var Submission = /*#__PURE__*/function () {
|
|
43
43
|
/**
|
|
44
44
|
* Constructs a new <code>Submission</code>.
|
|
45
|
-
* Data submitted to a template, and the
|
|
45
|
+
* Data submitted to a template, and the files generated from it (a PDF, a Word document, an OpenDocument file, or more than one of them).
|
|
46
46
|
* @alias module:model/Submission
|
|
47
47
|
* @extends Object
|
|
48
48
|
* @param id {String} The submission's ID.
|
|
49
49
|
* @param template_id {String} Null once the template has been permanently deleted.
|
|
50
|
-
* @param template_type {module:model/TemplateType} The template's type: `pdf` or `
|
|
50
|
+
* @param template_type {module:model/TemplateType} The template's type: `pdf`, `html` or `docx`.
|
|
51
51
|
* @param template_version {String} The published version of the template the submission used. Null for the draft.
|
|
52
52
|
* @param batch_id {String} The ID of the batch the submission was created in.
|
|
53
53
|
* @param source {module:model/SubmissionSource} `api`: created with the API. `web`: a web form. `reprocess`: a copy of another submission, made to generate its PDF again.
|
|
54
|
-
* @param state {module:model/SubmissionState} `pending` until the
|
|
54
|
+
* @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`.
|
|
55
55
|
* @param test {Boolean} Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
|
|
56
56
|
* @param editable {Boolean} `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
|
|
57
57
|
* @param data {Object.<String, Object>} The submission's data, with the values entered in completed signature requests. Empty once the submission has expired. Null in a batch's submissions unless you pass `include_data=true`, and in the events of a webhook that leaves out submission data.
|
|
58
58
|
* @param data_errors {Array.<module:model/ErrorDetail>} Why the data doesn't match the template's fields, when `state` is `invalid_data`: the same details as the 422 response that recorded it, with pointers into the request that created the submission (`/data/name`). Cleared once the submission has expired.
|
|
59
59
|
* @param error_message {String} Why the PDF couldn't be generated, when `state` is `error`.
|
|
60
60
|
* @param metadata {Object.<String, Object>} Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
|
|
61
|
-
* @param files {module:model/SubmissionFiles} The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
|
|
61
|
+
* @param files {module:model/SubmissionFiles} The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
|
|
62
62
|
* @param expired {Boolean} An expired submission's data, metadata, password and PDF have been deleted.
|
|
63
63
|
* @param expires_at {Date} When the submission expires. Null if it's kept until you delete it.
|
|
64
64
|
* @param processed_at {Date} When the PDF was generated. Null until then.
|
|
@@ -68,7 +68,7 @@ var Submission = /*#__PURE__*/function () {
|
|
|
68
68
|
* @param signature_requests {Array.<module:model/SignatureRequest>} The people asked to sign the submission (and fill in their fields), in order.
|
|
69
69
|
* @param actions {Array.<module:model/SubmissionAction>} The uploads of the submission's PDF to your storage (account integrations).
|
|
70
70
|
* @param truncated_text {Object.<String, Array.<String>>} The text of each field that didn't fit in it, by field name. Left out (null) with `data`, and empty once the submission has expired.
|
|
71
|
-
* @param output_formats {Array.<module:model/OutputFormat>} What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
|
|
71
|
+
* @param output_formats {Array.<module:model/OutputFormat>} What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
|
|
72
72
|
* @param preview_generated_at {Date} When the preview PDF was generated. Null if there is no preview.
|
|
73
73
|
*/
|
|
74
74
|
function Submission(id, template_id, template_type, template_version, batch_id, source, state, test, editable, data, data_errors, error_message, metadata, files, expired, expires_at, processed_at, created_at, updated_at, has_password, signature_requests, actions, truncated_text, output_formats, preview_generated_at) {
|
|
@@ -287,7 +287,7 @@ Submission.prototype['id'] = undefined;
|
|
|
287
287
|
Submission.prototype['template_id'] = undefined;
|
|
288
288
|
|
|
289
289
|
/**
|
|
290
|
-
* The template's type: `pdf` or `
|
|
290
|
+
* The template's type: `pdf`, `html` or `docx`.
|
|
291
291
|
* @member {module:model/TemplateType} template_type
|
|
292
292
|
*/
|
|
293
293
|
Submission.prototype['template_type'] = undefined;
|
|
@@ -311,7 +311,7 @@ Submission.prototype['batch_id'] = undefined;
|
|
|
311
311
|
Submission.prototype['source'] = undefined;
|
|
312
312
|
|
|
313
313
|
/**
|
|
314
|
-
* `pending` until the
|
|
314
|
+
* `pending` until the files have been generated, then `processed`. `waiting_for_signature_requests` until every signature request is completed. `insufficient_credits`: waiting for credits; `error_message` says whether the files are generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. Waiting ends in `error` if it's discarded or takes over 30 days. Every other state is final, with no files: `invalid_data` (the data doesn't match the template's fields: see `data_errors`), `declined` (a signature request was declined), and the states where generating the files failed, which have an `error_message`: `syntax_error` (a mistake in an HTML template's Liquid or SCSS, or in a Word template's tags), `image_download_failed` or `image_processing_failed` (an image in the data or the template couldn't be downloaded or read) and `error` (anything else). Older submissions can also be `license_revoked` or `accidental`.
|
|
315
315
|
* @member {module:model/SubmissionState} state
|
|
316
316
|
*/
|
|
317
317
|
Submission.prototype['state'] = undefined;
|
|
@@ -353,7 +353,7 @@ Submission.prototype['error_message'] = undefined;
|
|
|
353
353
|
Submission.prototype['metadata'] = undefined;
|
|
354
354
|
|
|
355
355
|
/**
|
|
356
|
-
* The generated files: `pdf` once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
|
|
356
|
+
* The generated files: `pdf`, `docx` and `odt` (by `output_formats`) once the submission has been processed, `png` (the images of the PDF's pages, when `output_formats` has it: `files.png.pages[0]` is page 1), `audit_trail` once its signature requests are completed, and `preview` once a preview PDF has been generated. Empty once the submission has expired.
|
|
357
357
|
* @member {module:model/SubmissionFiles} files
|
|
358
358
|
*/
|
|
359
359
|
Submission.prototype['files'] = undefined;
|
|
@@ -413,7 +413,7 @@ Submission.prototype['actions'] = undefined;
|
|
|
413
413
|
Submission.prototype['truncated_text'] = undefined;
|
|
414
414
|
|
|
415
415
|
/**
|
|
416
|
-
* What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
|
|
416
|
+
* What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
|
|
417
417
|
* @member {Array.<module:model/OutputFormat>} output_formats
|
|
418
418
|
*/
|
|
419
419
|
Submission.prototype['output_formats'] = undefined;
|
|
@@ -18,7 +18,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
18
18
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
19
19
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
20
20
|
* DocSpring API
|
|
21
|
-
* Use DocSpring's API to
|
|
21
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
22
22
|
*
|
|
23
23
|
* The version of the OpenAPI document: v2
|
|
24
24
|
*
|
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
31
31
|
/**
|
|
32
32
|
* The SubmissionAction model module.
|
|
33
33
|
* @module model/SubmissionAction
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.3.0
|
|
35
35
|
*/
|
|
36
36
|
var SubmissionAction = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -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.3.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.3.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.3.0
|
|
32
32
|
*/
|
|
33
33
|
var SubmissionInput = /*#__PURE__*/function () {
|
|
34
34
|
/**
|
|
@@ -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 and Word templates.
|
|
161
161
|
* @member {Object.<String, Object>} data
|
|
162
162
|
*/
|
|
163
163
|
SubmissionInput.prototype['data'] = undefined;
|
|
@@ -169,13 +169,13 @@ 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;
|
|
@@ -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.3.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.3.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.3.0
|
|
38
38
|
*/
|
|
39
39
|
var SubmissionSummary = /*#__PURE__*/function () {
|
|
40
40
|
/**
|
|
@@ -44,11 +44,11 @@ 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
|
|
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
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.
|
|
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.
|
|
@@ -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,7 +264,7 @@ 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;
|
|
@@ -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.3.0
|
|
34
34
|
*/
|
|
35
35
|
var SubmissionValidation = /*#__PURE__*/function () {
|
|
36
36
|
/**
|