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/Template.js
CHANGED
|
@@ -9,6 +9,7 @@ var _AiFieldNamingLanguage = _interopRequireDefault(require("./AiFieldNamingLang
|
|
|
9
9
|
var _ExpirationInterval = _interopRequireDefault(require("./ExpirationInterval"));
|
|
10
10
|
var _FieldGroup = _interopRequireDefault(require("./FieldGroup"));
|
|
11
11
|
var _HtmlEngineOptions = _interopRequireDefault(require("./HtmlEngineOptions"));
|
|
12
|
+
var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
|
|
12
13
|
var _PredefinedField = _interopRequireDefault(require("./PredefinedField"));
|
|
13
14
|
var _TemplateActor = _interopRequireDefault(require("./TemplateActor"));
|
|
14
15
|
var _TemplateDefaults = _interopRequireDefault(require("./TemplateDefaults"));
|
|
@@ -28,7 +29,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
28
29
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
29
30
|
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); } /**
|
|
30
31
|
* DocSpring API
|
|
31
|
-
* Use DocSpring's API to
|
|
32
|
+
* 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.
|
|
32
33
|
*
|
|
33
34
|
* The version of the OpenAPI document: v2
|
|
34
35
|
*
|
|
@@ -41,7 +42,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
41
42
|
/**
|
|
42
43
|
* The Template model module.
|
|
43
44
|
* @module model/Template
|
|
44
|
-
* @version 4.
|
|
45
|
+
* @version 4.3.0
|
|
45
46
|
*/
|
|
46
47
|
var Template = /*#__PURE__*/function () {
|
|
47
48
|
/**
|
|
@@ -52,9 +53,10 @@ var Template = /*#__PURE__*/function () {
|
|
|
52
53
|
* @param id {String} The template's ID.
|
|
53
54
|
* @param name {String} The template's name.
|
|
54
55
|
* @param description {String} Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests.
|
|
55
|
-
* @param template_type {module:model/TemplateType} `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
|
|
56
|
-
* @param
|
|
57
|
-
* @param
|
|
56
|
+
* @param template_type {module:model/TemplateType} `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created.
|
|
57
|
+
* @param output_format {module:model/OutputFormat} What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
|
|
58
|
+
* @param ready {Boolean} Whether the template can make documents. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded).
|
|
59
|
+
* @param document {module:model/TemplateDocument} The PDF of a PDF template, or the Word document of a Word template. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url` has one, with no file, while it's downloaded.
|
|
58
60
|
* @param parent_folder_id {String} The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions.
|
|
59
61
|
* @param path {String} The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root.
|
|
60
62
|
* @param latest_version {String} The template's latest published version. Null if no version has been published.
|
|
@@ -68,19 +70,19 @@ var Template = /*#__PURE__*/function () {
|
|
|
68
70
|
* @param ai_field_naming_language {module:model/AiFieldNamingLanguage} The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. New templates take it from your account's template settings. Null for HTML templates.
|
|
69
71
|
* @param allow_additional_properties {Boolean} Accept submission data with properties that aren't fields of the template.
|
|
70
72
|
* @param allow_skipping_optional_fields {Boolean} Visual forms and signature request forms show the Continue button as soon as the required fields are filled in, without visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it.
|
|
71
|
-
* @param default_form_mode {module:model/TemplateFormMode} The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs).
|
|
73
|
+
* @param default_form_mode {module:model/TemplateFormMode} The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). Only PDF templates have a visual form, so other templates accept only `web`.
|
|
72
74
|
* @param editable_submissions {Boolean} Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
|
|
73
75
|
* @param embed_domains {Array.<String>} The sites that can embed the template's live signature requests and its embedded template editor: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and the simple form) aren't restricted.
|
|
74
76
|
* @param embed_edit_allow_settings {Boolean} Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
|
|
75
77
|
* @param embed_edit_allow_versioning {Boolean} Allow the embedded template editor to publish, restore, compare and delete published versions.
|
|
76
78
|
* @param embed_edit_allow_document_replacement {Boolean} Allow the embedded template editor to replace the template's PDF.
|
|
77
|
-
* @param encrypt_pdfs {Boolean} Encrypt generated PDFs with `encrypt_pdfs_password`.
|
|
79
|
+
* @param encrypt_pdfs {Boolean} Encrypt generated PDFs with `encrypt_pdfs_password`. A Word template can only encrypt its PDFs when its `output_format` is `pdf`, because Word documents and OpenDocument files can't be password-protected.
|
|
78
80
|
* @param has_encrypt_pdfs_password {Boolean} Whether `encrypt_pdfs_password` is set.
|
|
79
81
|
* @param expire_submissions {Boolean} Delete each submission's data and PDF after `expire_after` `expiration_interval`.
|
|
80
82
|
* @param expire_after {Number} How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` is on. At most 5256000 (10 years in minutes).
|
|
81
83
|
* @param expiration_interval {module:model/ExpirationInterval} The unit of `expire_after`.
|
|
82
84
|
* @param merge_audit_trail_pdf {Boolean} Add the audit trail to the end of PDFs signed through signature requests.
|
|
83
|
-
* @param parse_dates_using_template_date_format {Boolean} Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
|
|
85
|
+
* @param parse_dates_using_template_date_format {Boolean} Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML or Word template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
|
|
84
86
|
* @param public_submissions {Boolean} Allow anyone with a submission's ID to download its PDF.
|
|
85
87
|
* @param public_web_form {Boolean} Allow anyone to fill in the template's web form.
|
|
86
88
|
* @param redirect_url {String} Where the web form sends people after they submit it.
|
|
@@ -91,18 +93,18 @@ var Template = /*#__PURE__*/function () {
|
|
|
91
93
|
* @param field_groups {Array.<module:model/FieldGroup>} The groups of the template's fields, with their settings. A field's name puts it in groups: `address/city` is in the group `address`, and `items/0/price` is in the list `items` and its items' group `items/~`.
|
|
92
94
|
* @param predefined_fields {Array.<module:model/PredefinedField>} The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off.
|
|
93
95
|
* @param predefined_fields_sample_data {Object.<String, Object>} Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for.
|
|
94
|
-
* @param html {String} The HTML of an HTML template, as a Liquid template. Null for PDF templates.
|
|
96
|
+
* @param html {String} The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
|
|
95
97
|
* @param scss {String} The SCSS of an HTML template.
|
|
96
98
|
* @param header_html {String} The HTML printed at the top of each page of an HTML template.
|
|
97
99
|
* @param footer_html {String} The HTML printed at the bottom of each page of an HTML template.
|
|
98
|
-
* @param html_engine_options {module:model/HtmlEngineOptions} How an HTML template's PDFs are printed. Null for PDF templates. Setting it replaces the whole object: options left out use their defaults.
|
|
100
|
+
* @param html_engine_options {module:model/HtmlEngineOptions} How an HTML template's PDFs are printed. Null for PDF and Word templates. Setting it replaces the whole object: options left out use their defaults.
|
|
99
101
|
* @param html_escape_data {Boolean} Whether an HTML template HTML-escapes the values it prints. When true, `{{ value }}` prints a value as text, so a `<` or `&` in it is printed as that character, and `{{ value | raw }}` prints a value as HTML. New HTML templates default to true. Templates created before October 2026, or with API v1, default to false, which prints every value as HTML. Null for PDF templates.
|
|
100
102
|
* @param embed_edit_token {String} The token that opens the template in the embedded template editor.
|
|
101
103
|
* @param versions {Array.<module:model/TemplateVersion>} The template's published versions, newest first (up to 100).
|
|
102
104
|
*/
|
|
103
|
-
function Template(id, name, description, template_type, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions) {
|
|
105
|
+
function Template(id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions) {
|
|
104
106
|
_classCallCheck(this, Template);
|
|
105
|
-
Template.initialize(this, id, name, description, template_type, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions);
|
|
107
|
+
Template.initialize(this, id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions);
|
|
106
108
|
}
|
|
107
109
|
|
|
108
110
|
/**
|
|
@@ -112,11 +114,12 @@ var Template = /*#__PURE__*/function () {
|
|
|
112
114
|
*/
|
|
113
115
|
return _createClass(Template, null, [{
|
|
114
116
|
key: "initialize",
|
|
115
|
-
value: function initialize(obj, id, name, description, template_type, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions) {
|
|
117
|
+
value: function initialize(obj, id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, has_encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, embed_edit_token, versions) {
|
|
116
118
|
obj['id'] = id;
|
|
117
119
|
obj['name'] = name;
|
|
118
120
|
obj['description'] = description;
|
|
119
121
|
obj['template_type'] = template_type;
|
|
122
|
+
obj['output_format'] = output_format;
|
|
120
123
|
obj['ready'] = ready;
|
|
121
124
|
obj['document'] = document;
|
|
122
125
|
obj['parent_folder_id'] = parent_folder_id;
|
|
@@ -190,6 +193,9 @@ var Template = /*#__PURE__*/function () {
|
|
|
190
193
|
if (data.hasOwnProperty('template_type')) {
|
|
191
194
|
obj['template_type'] = _ApiClient["default"].convertToType(data['template_type'], _TemplateType["default"]);
|
|
192
195
|
}
|
|
196
|
+
if (data.hasOwnProperty('output_format')) {
|
|
197
|
+
obj['output_format'] = _ApiClient["default"].convertToType(data['output_format'], _OutputFormat["default"]);
|
|
198
|
+
}
|
|
193
199
|
if (data.hasOwnProperty('ready')) {
|
|
194
200
|
obj['ready'] = _ApiClient["default"].convertToType(data['ready'], 'Boolean');
|
|
195
201
|
}
|
|
@@ -465,7 +471,7 @@ var Template = /*#__PURE__*/function () {
|
|
|
465
471
|
}
|
|
466
472
|
}]);
|
|
467
473
|
}();
|
|
468
|
-
Template.RequiredProperties = ["id", "name", "description", "template_type", "ready", "document", "parent_folder_id", "path", "latest_version", "version_published_at", "locked", "last_changed_at", "created_at", "updated_at", "version", "add_signature_request_submission_id_footers", "ai_field_naming_language", "allow_additional_properties", "allow_skipping_optional_fields", "default_form_mode", "editable_submissions", "embed_domains", "embed_edit_allow_settings", "embed_edit_allow_versioning", "embed_edit_allow_document_replacement", "encrypt_pdfs", "has_encrypt_pdfs_password", "expire_submissions", "expire_after", "expiration_interval", "merge_audit_trail_pdf", "parse_dates_using_template_date_format", "public_submissions", "public_web_form", "redirect_url", "has_slack_webhook_url", "last_changed_by", "defaults", "field_dependencies", "field_groups", "predefined_fields", "predefined_fields_sample_data", "html", "scss", "header_html", "footer_html", "html_engine_options", "html_escape_data", "embed_edit_token", "versions"];
|
|
474
|
+
Template.RequiredProperties = ["id", "name", "description", "template_type", "output_format", "ready", "document", "parent_folder_id", "path", "latest_version", "version_published_at", "locked", "last_changed_at", "created_at", "updated_at", "version", "add_signature_request_submission_id_footers", "ai_field_naming_language", "allow_additional_properties", "allow_skipping_optional_fields", "default_form_mode", "editable_submissions", "embed_domains", "embed_edit_allow_settings", "embed_edit_allow_versioning", "embed_edit_allow_document_replacement", "encrypt_pdfs", "has_encrypt_pdfs_password", "expire_submissions", "expire_after", "expiration_interval", "merge_audit_trail_pdf", "parse_dates_using_template_date_format", "public_submissions", "public_web_form", "redirect_url", "has_slack_webhook_url", "last_changed_by", "defaults", "field_dependencies", "field_groups", "predefined_fields", "predefined_fields_sample_data", "html", "scss", "header_html", "footer_html", "html_engine_options", "html_escape_data", "embed_edit_token", "versions"];
|
|
469
475
|
|
|
470
476
|
/**
|
|
471
477
|
* The template's ID.
|
|
@@ -486,19 +492,25 @@ Template.prototype['name'] = undefined;
|
|
|
486
492
|
Template.prototype['description'] = undefined;
|
|
487
493
|
|
|
488
494
|
/**
|
|
489
|
-
* `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
|
|
495
|
+
* `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. It can't be changed after the template is created.
|
|
490
496
|
* @member {module:model/TemplateType} template_type
|
|
491
497
|
*/
|
|
492
498
|
Template.prototype['template_type'] = undefined;
|
|
493
499
|
|
|
494
500
|
/**
|
|
495
|
-
*
|
|
501
|
+
* What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
|
|
502
|
+
* @member {module:model/OutputFormat} output_format
|
|
503
|
+
*/
|
|
504
|
+
Template.prototype['output_format'] = undefined;
|
|
505
|
+
|
|
506
|
+
/**
|
|
507
|
+
* Whether the template can make documents. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded).
|
|
496
508
|
* @member {Boolean} ready
|
|
497
509
|
*/
|
|
498
510
|
Template.prototype['ready'] = undefined;
|
|
499
511
|
|
|
500
512
|
/**
|
|
501
|
-
* The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet.
|
|
513
|
+
* The PDF of a PDF template, or the Word document of a Word template. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url` has one, with no file, while it's downloaded.
|
|
502
514
|
* @member {module:model/TemplateDocument} document
|
|
503
515
|
*/
|
|
504
516
|
Template.prototype['document'] = undefined;
|
|
@@ -582,7 +594,7 @@ Template.prototype['allow_additional_properties'] = undefined;
|
|
|
582
594
|
Template.prototype['allow_skipping_optional_fields'] = undefined;
|
|
583
595
|
|
|
584
596
|
/**
|
|
585
|
-
* The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs).
|
|
597
|
+
* The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). Only PDF templates have a visual form, so other templates accept only `web`.
|
|
586
598
|
* @member {module:model/TemplateFormMode} default_form_mode
|
|
587
599
|
*/
|
|
588
600
|
Template.prototype['default_form_mode'] = undefined;
|
|
@@ -618,7 +630,7 @@ Template.prototype['embed_edit_allow_versioning'] = undefined;
|
|
|
618
630
|
Template.prototype['embed_edit_allow_document_replacement'] = undefined;
|
|
619
631
|
|
|
620
632
|
/**
|
|
621
|
-
* Encrypt generated PDFs with `encrypt_pdfs_password`.
|
|
633
|
+
* Encrypt generated PDFs with `encrypt_pdfs_password`. A Word template can only encrypt its PDFs when its `output_format` is `pdf`, because Word documents and OpenDocument files can't be password-protected.
|
|
622
634
|
* @member {Boolean} encrypt_pdfs
|
|
623
635
|
*/
|
|
624
636
|
Template.prototype['encrypt_pdfs'] = undefined;
|
|
@@ -654,7 +666,7 @@ Template.prototype['expiration_interval'] = undefined;
|
|
|
654
666
|
Template.prototype['merge_audit_trail_pdf'] = undefined;
|
|
655
667
|
|
|
656
668
|
/**
|
|
657
|
-
* Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
|
|
669
|
+
* Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML or Word template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
|
|
658
670
|
* @member {Boolean} parse_dates_using_template_date_format
|
|
659
671
|
*/
|
|
660
672
|
Template.prototype['parse_dates_using_template_date_format'] = undefined;
|
|
@@ -719,7 +731,7 @@ Template.prototype['predefined_fields'] = undefined;
|
|
|
719
731
|
Template.prototype['predefined_fields_sample_data'] = undefined;
|
|
720
732
|
|
|
721
733
|
/**
|
|
722
|
-
* The HTML of an HTML template, as a Liquid template. Null for PDF templates.
|
|
734
|
+
* The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
|
|
723
735
|
* @member {String} html
|
|
724
736
|
*/
|
|
725
737
|
Template.prototype['html'] = undefined;
|
|
@@ -743,7 +755,7 @@ Template.prototype['header_html'] = undefined;
|
|
|
743
755
|
Template.prototype['footer_html'] = undefined;
|
|
744
756
|
|
|
745
757
|
/**
|
|
746
|
-
* How an HTML template's PDFs are printed. Null for PDF templates. Setting it replaces the whole object: options left out use their defaults.
|
|
758
|
+
* How an HTML template's PDFs are printed. Null for PDF and Word templates. Setting it replaces the whole object: options left out use their defaults.
|
|
747
759
|
* @member {module:model/HtmlEngineOptions} html_engine_options
|
|
748
760
|
*/
|
|
749
761
|
Template.prototype['html_engine_options'] = 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 TemplateActor model module.
|
|
32
32
|
* @module model/TemplateActor
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.3.0
|
|
34
34
|
*/
|
|
35
35
|
var TemplateActor = /*#__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 TemplateDefaults model module.
|
|
31
31
|
* @module model/TemplateDefaults
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.3.0
|
|
33
33
|
*/
|
|
34
34
|
var TemplateDefaults = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -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 TemplateDefaultsInput model module.
|
|
31
31
|
* @module model/TemplateDefaultsInput
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.3.0
|
|
33
33
|
*/
|
|
34
34
|
var TemplateDefaultsInput = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -18,7 +18,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
18
18
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
19
19
|
function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
|
|
20
20
|
* DocSpring API
|
|
21
|
-
* Use DocSpring's API to
|
|
21
|
+
* Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
|
|
22
22
|
*
|
|
23
23
|
* The version of the OpenAPI document: v2
|
|
24
24
|
*
|
|
@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
31
31
|
/**
|
|
32
32
|
* The TemplateDiff model module.
|
|
33
33
|
* @module model/TemplateDiff
|
|
34
|
-
* @version 4.
|
|
34
|
+
* @version 4.3.0
|
|
35
35
|
*/
|
|
36
36
|
var TemplateDiff = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
@@ -44,8 +44,8 @@ var TemplateDiff = /*#__PURE__*/function () {
|
|
|
44
44
|
* @param to_version {String} The later version, such as `1.2.0`. Null for the draft.
|
|
45
45
|
* @param summary {module:model/TemplateDiffSummary} How many changes of each kind there are.
|
|
46
46
|
* @param fields {module:model/TemplateFieldChanges} The fields that changed.
|
|
47
|
-
* @param changed_settings {Array.<String>} The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `
|
|
48
|
-
* @param document_changed {Boolean} The template's PDF was replaced (or added, when there's no `from_version`).
|
|
47
|
+
* @param changed_settings {Array.<String>} The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `merge_audit_trail_pdf`, ...). Values aren't included. Settings that apply to every version, such as `webhook_url` and `encrypt_pdfs_password`, are the same on every version, so they're named only when there's no earlier version to compare with; a secret is named without its value.
|
|
48
|
+
* @param document_changed {Boolean} The template's PDF was replaced, or its Word document replaced or edited (or added, when there's no `from_version`).
|
|
49
49
|
*/
|
|
50
50
|
function TemplateDiff(template_id, from_version, to_version, summary, fields, changed_settings, document_changed) {
|
|
51
51
|
_classCallCheck(this, TemplateDiff);
|
|
@@ -193,13 +193,13 @@ TemplateDiff.prototype['summary'] = undefined;
|
|
|
193
193
|
TemplateDiff.prototype['fields'] = undefined;
|
|
194
194
|
|
|
195
195
|
/**
|
|
196
|
-
* The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `
|
|
196
|
+
* The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `merge_audit_trail_pdf`, ...). Values aren't included. Settings that apply to every version, such as `webhook_url` and `encrypt_pdfs_password`, are the same on every version, so they're named only when there's no earlier version to compare with; a secret is named without its value.
|
|
197
197
|
* @member {Array.<String>} changed_settings
|
|
198
198
|
*/
|
|
199
199
|
TemplateDiff.prototype['changed_settings'] = undefined;
|
|
200
200
|
|
|
201
201
|
/**
|
|
202
|
-
* The template's PDF was replaced (or added, when there's no `from_version`).
|
|
202
|
+
* The template's PDF was replaced, or its Word document replaced or edited (or added, when there's no `from_version`).
|
|
203
203
|
* @member {Boolean} document_changed
|
|
204
204
|
*/
|
|
205
205
|
TemplateDiff.prototype['document_changed'] = undefined;
|
|
@@ -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 TemplateDiffSummary model module.
|
|
31
31
|
* @module model/TemplateDiffSummary
|
|
32
|
-
* @version 4.
|
|
32
|
+
* @version 4.3.0
|
|
33
33
|
*/
|
|
34
34
|
var TemplateDiffSummary = /*#__PURE__*/function () {
|
|
35
35
|
/**
|
|
@@ -20,7 +20,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
|
|
|
20
20
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
21
21
|
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); } /**
|
|
22
22
|
* DocSpring API
|
|
23
|
-
* Use DocSpring's API to
|
|
23
|
+
* 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.
|
|
24
24
|
*
|
|
25
25
|
* The version of the OpenAPI document: v2
|
|
26
26
|
*
|
|
@@ -33,25 +33,25 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
33
33
|
/**
|
|
34
34
|
* The TemplateDocument model module.
|
|
35
35
|
* @module model/TemplateDocument
|
|
36
|
-
* @version 4.
|
|
36
|
+
* @version 4.3.0
|
|
37
37
|
*/
|
|
38
38
|
var TemplateDocument = /*#__PURE__*/function () {
|
|
39
39
|
/**
|
|
40
40
|
* Constructs a new <code>TemplateDocument</code>.
|
|
41
|
-
* A PDF template's PDF.
|
|
41
|
+
* A PDF template's PDF, or a Word template's Word document.
|
|
42
42
|
* @alias module:model/TemplateDocument
|
|
43
|
-
* @param filename {String} The
|
|
44
|
-
* @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its
|
|
45
|
-
* @param error_message {String} Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
|
|
46
|
-
* @param page_count {Number} 0 until the PDF has been processed.
|
|
47
|
-
* @param md5 {String} The MD5 hash of the PDF.
|
|
43
|
+
* @param filename {String} The file's name. Null until a `document_url` has been downloaded or an OpenDocument file converted.
|
|
44
|
+
* @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. `converting` while DocSpring converts an OpenDocument file (.odt) uploaded to a Word template to a Word document, and `conversion_failed` when it couldn't, with `error_message` saying why. A template keeps its document while a new one is downloaded or converted, and when it couldn't be. A Word document is `processed` once it's uploaded, downloaded or converted.
|
|
45
|
+
* @param error_message {String} Why the PDF couldn't be processed, or the document downloaded or converted, and how to fix it. Null unless `state` is an error.
|
|
46
|
+
* @param page_count {Number} 0 until the PDF has been processed. 0 for a Word document, whose pages depend on the data.
|
|
47
|
+
* @param md5 {String} The MD5 hash of the PDF. Null for a Word document.
|
|
48
48
|
* @param field_reimport_state {module:model/FieldReimportState} Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
|
|
49
49
|
* @param page_dimensions {Array.<Array.<Number>>} Each page's width and height in PDF points. Null until the PDF has been processed.
|
|
50
|
-
* @param has_fillable_fields {Boolean} Whether the PDF has fillable form fields. Null until DocSpring has read the PDF.
|
|
51
|
-
* @param page_processing_statuses {Array.<module:model/TemplatePageProcessingStatus>} How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF,
|
|
52
|
-
* @param field_logic_status {module:model/TemplateFieldLogicStatus} AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields).
|
|
53
|
-
* @param download_url {String} A temporary link to download the PDF.
|
|
54
|
-
* @param permanent_url {String} A link to download the
|
|
50
|
+
* @param has_fillable_fields {Boolean} Whether the PDF has fillable form fields. Null until DocSpring has read the PDF, and for a Word document.
|
|
51
|
+
* @param page_processing_statuses {Array.<module:model/TemplatePageProcessingStatus>} How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, for PDFs uploaded before DocSpring recorded page statuses, and for a Word document.
|
|
52
|
+
* @param field_logic_status {module:model/TemplateFieldLogicStatus} AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields). Null for a Word document.
|
|
53
|
+
* @param download_url {String} A temporary link to download the PDF. Null for a Word document (use `permanent_url`).
|
|
54
|
+
* @param permanent_url {String} A link to download the file that doesn't expire. Null until a PDF has been processed. A Word document's is built from the template's current document when it's downloaded.
|
|
55
55
|
*/
|
|
56
56
|
function TemplateDocument(filename, state, error_message, page_count, md5, field_reimport_state, page_dimensions, has_fillable_fields, page_processing_statuses, field_logic_status, download_url, permanent_url) {
|
|
57
57
|
_classCallCheck(this, TemplateDocument);
|
|
@@ -207,31 +207,31 @@ var TemplateDocument = /*#__PURE__*/function () {
|
|
|
207
207
|
TemplateDocument.RequiredProperties = ["filename", "state", "error_message", "page_count", "md5", "field_reimport_state", "page_dimensions", "has_fillable_fields", "page_processing_statuses", "field_logic_status", "download_url", "permanent_url"];
|
|
208
208
|
|
|
209
209
|
/**
|
|
210
|
-
* The
|
|
210
|
+
* The file's name. Null until a `document_url` has been downloaded or an OpenDocument file converted.
|
|
211
211
|
* @member {String} filename
|
|
212
212
|
*/
|
|
213
213
|
TemplateDocument.prototype['filename'] = undefined;
|
|
214
214
|
|
|
215
215
|
/**
|
|
216
|
-
* `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its
|
|
216
|
+
* `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. `converting` while DocSpring converts an OpenDocument file (.odt) uploaded to a Word template to a Word document, and `conversion_failed` when it couldn't, with `error_message` saying why. A template keeps its document while a new one is downloaded or converted, and when it couldn't be. A Word document is `processed` once it's uploaded, downloaded or converted.
|
|
217
217
|
* @member {module:model/TemplateDocumentState} state
|
|
218
218
|
*/
|
|
219
219
|
TemplateDocument.prototype['state'] = undefined;
|
|
220
220
|
|
|
221
221
|
/**
|
|
222
|
-
* Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
|
|
222
|
+
* Why the PDF couldn't be processed, or the document downloaded or converted, and how to fix it. Null unless `state` is an error.
|
|
223
223
|
* @member {String} error_message
|
|
224
224
|
*/
|
|
225
225
|
TemplateDocument.prototype['error_message'] = undefined;
|
|
226
226
|
|
|
227
227
|
/**
|
|
228
|
-
* 0 until the PDF has been processed.
|
|
228
|
+
* 0 until the PDF has been processed. 0 for a Word document, whose pages depend on the data.
|
|
229
229
|
* @member {Number} page_count
|
|
230
230
|
*/
|
|
231
231
|
TemplateDocument.prototype['page_count'] = undefined;
|
|
232
232
|
|
|
233
233
|
/**
|
|
234
|
-
* The MD5 hash of the PDF.
|
|
234
|
+
* The MD5 hash of the PDF. Null for a Word document.
|
|
235
235
|
* @member {String} md5
|
|
236
236
|
*/
|
|
237
237
|
TemplateDocument.prototype['md5'] = undefined;
|
|
@@ -249,31 +249,31 @@ TemplateDocument.prototype['field_reimport_state'] = undefined;
|
|
|
249
249
|
TemplateDocument.prototype['page_dimensions'] = undefined;
|
|
250
250
|
|
|
251
251
|
/**
|
|
252
|
-
* Whether the PDF has fillable form fields. Null until DocSpring has read the PDF.
|
|
252
|
+
* Whether the PDF has fillable form fields. Null until DocSpring has read the PDF, and for a Word document.
|
|
253
253
|
* @member {Boolean} has_fillable_fields
|
|
254
254
|
*/
|
|
255
255
|
TemplateDocument.prototype['has_fillable_fields'] = undefined;
|
|
256
256
|
|
|
257
257
|
/**
|
|
258
|
-
* How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF,
|
|
258
|
+
* How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, for PDFs uploaded before DocSpring recorded page statuses, and for a Word document.
|
|
259
259
|
* @member {Array.<module:model/TemplatePageProcessingStatus>} page_processing_statuses
|
|
260
260
|
*/
|
|
261
261
|
TemplateDocument.prototype['page_processing_statuses'] = undefined;
|
|
262
262
|
|
|
263
263
|
/**
|
|
264
|
-
* AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields).
|
|
264
|
+
* AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields). Null for a Word document.
|
|
265
265
|
* @member {module:model/TemplateFieldLogicStatus} field_logic_status
|
|
266
266
|
*/
|
|
267
267
|
TemplateDocument.prototype['field_logic_status'] = undefined;
|
|
268
268
|
|
|
269
269
|
/**
|
|
270
|
-
* A temporary link to download the PDF.
|
|
270
|
+
* A temporary link to download the PDF. Null for a Word document (use `permanent_url`).
|
|
271
271
|
* @member {String} download_url
|
|
272
272
|
*/
|
|
273
273
|
TemplateDocument.prototype['download_url'] = undefined;
|
|
274
274
|
|
|
275
275
|
/**
|
|
276
|
-
* A link to download the
|
|
276
|
+
* A link to download the file that doesn't expire. Null until a PDF has been processed. A Word document's is built from the template's current document when it's downloaded.
|
|
277
277
|
* @member {String} permanent_url
|
|
278
278
|
*/
|
|
279
279
|
TemplateDocument.prototype['permanent_url'] = 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
|
*
|
|
@@ -81,4 +81,14 @@ _defineProperty(TemplateDocumentState, "downloading", "downloading");
|
|
|
81
81
|
* value: "download_failed"
|
|
82
82
|
* @const
|
|
83
83
|
*/
|
|
84
|
-
_defineProperty(TemplateDocumentState, "download_failed", "download_failed");
|
|
84
|
+
_defineProperty(TemplateDocumentState, "download_failed", "download_failed");
|
|
85
|
+
/**
|
|
86
|
+
* value: "converting"
|
|
87
|
+
* @const
|
|
88
|
+
*/
|
|
89
|
+
_defineProperty(TemplateDocumentState, "converting", "converting");
|
|
90
|
+
/**
|
|
91
|
+
* value: "conversion_failed"
|
|
92
|
+
* @const
|
|
93
|
+
*/
|
|
94
|
+
_defineProperty(TemplateDocumentState, "conversion_failed", "conversion_failed");
|
|
@@ -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,17 +30,17 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
|
|
|
30
30
|
/**
|
|
31
31
|
* The TemplateDocumentSummary model module.
|
|
32
32
|
* @module model/TemplateDocumentSummary
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.3.0
|
|
34
34
|
*/
|
|
35
35
|
var TemplateDocumentSummary = /*#__PURE__*/function () {
|
|
36
36
|
/**
|
|
37
37
|
* Constructs a new <code>TemplateDocumentSummary</code>.
|
|
38
|
-
* A PDF template's PDF, as template lists show it.
|
|
38
|
+
* A PDF template's PDF or a Word template's Word document, as template lists show it.
|
|
39
39
|
* @alias module:model/TemplateDocumentSummary
|
|
40
|
-
* @param filename {String} The
|
|
41
|
-
* @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its
|
|
42
|
-
* @param error_message {String} Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
|
|
43
|
-
* @param page_count {Number} 0 until the PDF has been processed.
|
|
40
|
+
* @param filename {String} The file's name. Null until a `document_url` has been downloaded or an OpenDocument file converted.
|
|
41
|
+
* @param state {module:model/TemplateDocumentState} `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. `converting` while DocSpring converts an OpenDocument file (.odt) uploaded to a Word template to a Word document, and `conversion_failed` when it couldn't, with `error_message` saying why. A template keeps its document while a new one is downloaded or converted, and when it couldn't be. A Word document is `processed` once it's uploaded, downloaded or converted.
|
|
42
|
+
* @param error_message {String} Why the PDF couldn't be processed, or the document downloaded or converted, and how to fix it. Null unless `state` is an error.
|
|
43
|
+
* @param page_count {Number} 0 until the PDF has been processed. 0 for a Word document, whose pages depend on the data.
|
|
44
44
|
*/
|
|
45
45
|
function TemplateDocumentSummary(filename, state, error_message, page_count) {
|
|
46
46
|
_classCallCheck(this, TemplateDocumentSummary);
|
|
@@ -127,25 +127,25 @@ var TemplateDocumentSummary = /*#__PURE__*/function () {
|
|
|
127
127
|
TemplateDocumentSummary.RequiredProperties = ["filename", "state", "error_message", "page_count"];
|
|
128
128
|
|
|
129
129
|
/**
|
|
130
|
-
* The
|
|
130
|
+
* The file's name. Null until a `document_url` has been downloaded or an OpenDocument file converted.
|
|
131
131
|
* @member {String} filename
|
|
132
132
|
*/
|
|
133
133
|
TemplateDocumentSummary.prototype['filename'] = undefined;
|
|
134
134
|
|
|
135
135
|
/**
|
|
136
|
-
* `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its
|
|
136
|
+
* `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. `converting` while DocSpring converts an OpenDocument file (.odt) uploaded to a Word template to a Word document, and `conversion_failed` when it couldn't, with `error_message` saying why. A template keeps its document while a new one is downloaded or converted, and when it couldn't be. A Word document is `processed` once it's uploaded, downloaded or converted.
|
|
137
137
|
* @member {module:model/TemplateDocumentState} state
|
|
138
138
|
*/
|
|
139
139
|
TemplateDocumentSummary.prototype['state'] = undefined;
|
|
140
140
|
|
|
141
141
|
/**
|
|
142
|
-
* Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
|
|
142
|
+
* Why the PDF couldn't be processed, or the document downloaded or converted, and how to fix it. Null unless `state` is an error.
|
|
143
143
|
* @member {String} error_message
|
|
144
144
|
*/
|
|
145
145
|
TemplateDocumentSummary.prototype['error_message'] = undefined;
|
|
146
146
|
|
|
147
147
|
/**
|
|
148
|
-
* 0 until the PDF has been processed.
|
|
148
|
+
* 0 until the PDF has been processed. 0 for a Word document, whose pages depend on the data.
|
|
149
149
|
* @member {Number} page_count
|
|
150
150
|
*/
|
|
151
151
|
TemplateDocumentSummary.prototype['page_count'] = 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 TemplateFieldChange model module.
|
|
32
32
|
* @module model/TemplateFieldChange
|
|
33
|
-
* @version 4.
|
|
33
|
+
* @version 4.3.0
|
|
34
34
|
*/
|
|
35
35
|
var TemplateFieldChange = /*#__PURE__*/function () {
|
|
36
36
|
/**
|