docspring 3.2.0 → 4.0.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 +79 -19
- package/README.md +65 -63
- package/dist/ApiClient.js +62 -27
- package/dist/RequestSchemas.js +2297 -0
- package/dist/RequestValidator.js +494 -0
- package/dist/api/Client.js +1345 -946
- package/dist/index.js +655 -151
- package/dist/model/AiFieldNamingLanguage.js +64 -0
- package/dist/model/{AddFieldsData.js → AuthenticationCheck.js} +31 -31
- package/dist/model/BarcodeSymbology.js +89 -0
- package/dist/model/CheckCharacter.js +74 -0
- package/dist/model/CombinedFieldType.js +59 -0
- package/dist/model/CombinedPdf.js +294 -0
- package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +26 -26
- package/dist/model/CombinedPdfList.js +132 -0
- package/dist/model/{SubmissionDataRequestToken.js → CombinedPdfSource.js} +55 -52
- package/dist/model/CombinedPdfSourceInput.js +270 -0
- package/dist/model/{SuccessErrorResponse.js → CombinedPdfSourcePdf.js} +41 -55
- package/dist/model/CombinedPdfSourceType.js +74 -0
- package/dist/model/CombinedPdfState.js +74 -0
- package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +25 -21
- package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +68 -52
- package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +24 -22
- package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +46 -27
- package/dist/model/{CreateSubmissionDataRequestEventRequest.js → CreateSignatureRequestEventRequest.js} +41 -137
- package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
- package/dist/model/{CreatePdfSubmissionData.js → CreateSubmissionBatchRequest.js} +63 -87
- package/dist/model/CreateSubmissionRequest.js +212 -0
- package/dist/model/CreateTemplateRequest.js +545 -0
- package/dist/model/CreateWebhookRequest.js +234 -0
- package/dist/model/CustomFile.js +66 -15
- package/dist/model/CustomFileList.js +132 -0
- package/dist/model/CustomFileSourcePdf.js +130 -0
- package/dist/model/ErrorCode.js +154 -0
- package/dist/model/{BatchGeneratePdfs201Response.js → ErrorDetail.js} +65 -76
- package/dist/model/ErrorInfo.js +211 -0
- package/dist/model/ErrorResponse.js +11 -40
- package/dist/model/ExpirationInterval.js +64 -0
- package/dist/model/{CreateSubmissionResponse.js → FieldComparisonCondition.js} +46 -64
- package/dist/model/FieldComparisonOperator.js +69 -0
- package/dist/model/FieldDisplayType.js +79 -0
- package/dist/model/FieldEqualsCondition.js +137 -0
- package/dist/model/FieldEqualsOperator.js +59 -0
- package/dist/model/FieldInCondition.js +145 -0
- package/dist/model/FieldOverride.js +722 -0
- package/dist/model/{MultipleErrorsResponse.js → FieldPresenceCondition.js} +39 -54
- package/dist/model/FieldPresenceOperator.js +59 -0
- package/dist/model/FieldRangeCondition.js +148 -0
- package/dist/model/FieldReimportState.js +69 -0
- package/dist/model/FieldSetupLogic.js +59 -0
- package/dist/model/FieldSetupNaming.js +59 -0
- package/dist/model/FieldSetupSource.js +64 -0
- package/dist/model/Folder.js +37 -10
- package/dist/model/FolderList.js +132 -0
- package/dist/model/GeneratedFile.js +214 -0
- package/dist/model/GeneratedFileState.js +64 -0
- package/dist/model/HtmlEngineOptions.js +230 -0
- package/dist/model/HtmlEngineOptionsInput.js +193 -0
- package/dist/model/ImageGravity.js +94 -0
- package/dist/model/ImageScaleType.js +64 -0
- package/dist/model/ModelCodeLanguage.js +94 -0
- package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +33 -27
- package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +24 -34
- package/dist/model/NumberConditionType.js +79 -0
- package/dist/model/PageFormat.js +114 -0
- package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +32 -32
- package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +24 -22
- package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +24 -22
- package/dist/model/ShapeType.js +79 -0
- package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +164 -239
- package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
- package/dist/model/SignatureRequestAuthType.js +84 -0
- package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +66 -148
- package/dist/model/SignatureRequestEventType.js +79 -0
- package/dist/model/SignatureRequestInput.js +278 -0
- package/dist/model/SignatureRequestMessageType.js +94 -0
- package/dist/model/SignatureRequestState.js +64 -0
- package/dist/model/SignatureRequestToken.js +195 -0
- package/dist/model/SignatureRequestTokenType.js +59 -0
- package/dist/model/StringConditionType.js +74 -0
- package/dist/model/Submission.js +185 -339
- package/dist/model/SubmissionAction.js +29 -114
- package/dist/model/SubmissionActionState.js +69 -0
- package/dist/model/SubmissionActionType.js +84 -0
- package/dist/model/SubmissionBatch.js +73 -54
- package/dist/model/SubmissionBatchState.js +64 -0
- package/dist/model/SubmissionFiles.js +108 -0
- package/dist/model/SubmissionInput.js +204 -0
- package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +34 -41
- package/dist/model/SubmissionSource.js +69 -0
- package/dist/model/SubmissionSourcePdf.js +130 -0
- package/dist/model/SubmissionState.js +114 -0
- package/dist/model/Template.js +309 -572
- package/dist/model/TemplateActor.js +171 -0
- package/dist/model/TemplateActorType.js +64 -0
- package/dist/model/TemplateDefaults.js +307 -0
- package/dist/model/TemplateDefaultsInput.js +305 -0
- package/dist/model/TemplateDocument.js +280 -0
- package/dist/model/TemplateDocumentState.js +74 -0
- package/dist/model/TemplateFieldDependency.js +184 -0
- package/dist/model/TemplateFieldDependencyAction.js +64 -0
- package/dist/model/{CreateCombinedSubmissionResponse.js → TemplateFieldDependencyCondition.js} +50 -61
- package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
- package/dist/model/TemplateFieldDependencyInput.js +182 -0
- package/dist/model/TemplateFieldDependencyMatch.js +59 -0
- package/dist/model/TemplateFieldDependencyOperator.js +99 -0
- package/dist/model/TemplateFieldLogicStatus.js +74 -0
- package/dist/model/TemplateFormMode.js +64 -0
- package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +33 -85
- package/dist/model/TemplatePageAiError.js +69 -0
- package/dist/model/TemplatePageAiNamingStatus.js +59 -0
- package/dist/model/TemplatePageFieldsStatus.js +74 -0
- package/dist/model/TemplatePageImageStatus.js +59 -0
- package/dist/model/TemplatePageProcessingStatus.js +162 -0
- package/dist/model/{SubmissionBatchData.js → TemplateSourcePdf.js} +49 -49
- package/dist/model/TemplateSummary.js +560 -0
- package/dist/model/{SuccessMultipleErrorsResponse.js → TemplateSummaryList.js} +43 -55
- package/dist/model/TemplateType.js +59 -0
- package/dist/model/{Submission422Response.js → TemplateVersion.js} +59 -62
- package/dist/model/TemplateVersionType.js +64 -0
- package/dist/model/TextAlignment.js +69 -0
- package/dist/model/TextOverflow.js +59 -0
- package/dist/model/TextVerticalAlignment.js +64 -0
- package/dist/model/Typeface.js +134 -0
- package/dist/model/UpdateSignatureRequestRequest.js +183 -0
- package/dist/model/{ErrorOrMultipleErrorsResponse.js → UpdateTemplateDocumentRequest.js} +43 -60
- package/dist/model/UpdateTemplateRequest.js +450 -0
- package/dist/model/UpdateWebhookRequest.js +209 -0
- package/dist/model/UploadMethod.js +54 -0
- package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +52 -57
- package/dist/model/UrlSourcePdf.js +130 -0
- package/dist/model/Webhook.js +57 -72
- package/dist/model/WebhookEventType.js +174 -0
- package/dist/model/WebhookList.js +132 -0
- package/dist/model/WebhookMode.js +59 -0
- package/package.json +1 -1
- package/dist/model/CombinedSubmission.js +0 -308
- package/dist/model/CombinedSubmissionAction.js +0 -268
- package/dist/model/CreateCustomFileResponse.js +0 -155
- package/dist/model/CreateHtmlTemplate.js +0 -108
- package/dist/model/CreatePdfTemplate.js +0 -108
- package/dist/model/CreateSubmissionDataRequestData.js +0 -314
- package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -155
- package/dist/model/CreateSubmissionDataRequestResponse.js +0 -155
- package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -155
- package/dist/model/CreateWebhookData.js +0 -108
- package/dist/model/JsonSchema.js +0 -205
- package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
- package/dist/model/SubmissionDataRequest.js +0 -496
- package/dist/model/SubmissionPreview.js +0 -504
- package/dist/model/TemplateAddFieldsResponse.js +0 -156
- package/dist/model/TemplateDeleteResponse.js +0 -168
- package/dist/model/TemplatePreview.js +0 -796
- package/dist/model/TemplatePublishVersionResponse.js +0 -154
- package/dist/model/UpdateHtmlTemplate.js +0 -108
- package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
- package/dist/model/UpdateWebhookData.js +0 -108
|
@@ -0,0 +1,560 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports["default"] = void 0;
|
|
7
|
+
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
+
var _AiFieldNamingLanguage = _interopRequireDefault(require("./AiFieldNamingLanguage"));
|
|
9
|
+
var _ExpirationInterval = _interopRequireDefault(require("./ExpirationInterval"));
|
|
10
|
+
var _TemplateActor = _interopRequireDefault(require("./TemplateActor"));
|
|
11
|
+
var _TemplateDocument = _interopRequireDefault(require("./TemplateDocument"));
|
|
12
|
+
var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
|
|
13
|
+
var _TemplateType = _interopRequireDefault(require("./TemplateType"));
|
|
14
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
15
|
+
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
16
|
+
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
17
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
18
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
19
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
20
|
+
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
21
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
22
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
23
|
+
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); } /**
|
|
24
|
+
* DocSpring API
|
|
25
|
+
* Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
|
|
26
|
+
*
|
|
27
|
+
* The version of the OpenAPI document: v2
|
|
28
|
+
*
|
|
29
|
+
*
|
|
30
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
31
|
+
* https://openapi-generator.tech
|
|
32
|
+
* Do not edit the class manually.
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
/**
|
|
36
|
+
* The TemplateSummary model module.
|
|
37
|
+
* @module model/TemplateSummary
|
|
38
|
+
* @version 4.0.0
|
|
39
|
+
*/
|
|
40
|
+
var TemplateSummary = /*#__PURE__*/function () {
|
|
41
|
+
/**
|
|
42
|
+
* Constructs a new <code>TemplateSummary</code>.
|
|
43
|
+
* A template in a list. Get a template by its ID for its HTML, defaults, field dependency rules and published versions.
|
|
44
|
+
* @alias module:model/TemplateSummary
|
|
45
|
+
* @extends Object
|
|
46
|
+
* @param id {String} The template's ID.
|
|
47
|
+
* @param name {String} The template's name.
|
|
48
|
+
* @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.
|
|
49
|
+
* @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.
|
|
50
|
+
* @param ready {Boolean} Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once its document has been processed (`document.state` is `processed`).
|
|
51
|
+
* @param document {module:model/TemplateDocument} The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet.
|
|
52
|
+
* @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.
|
|
53
|
+
* @param path {String} The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root.
|
|
54
|
+
* @param version {String} The published version this is, such as `1.2.0`. Null for the draft.
|
|
55
|
+
* @param latest_version {String} The template's latest published version. Null if no version has been published.
|
|
56
|
+
* @param version_published_at {Date} When this version was published. Null for the draft.
|
|
57
|
+
* @param locked {Boolean} A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed).
|
|
58
|
+
* @param add_signature_request_submission_id_footers {Boolean} Print the submission ID in the footer of each page of PDFs signed through signature requests.
|
|
59
|
+
* @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.
|
|
60
|
+
* @param allow_additional_properties {Boolean} Accept submission data with properties that aren't fields of the template.
|
|
61
|
+
* @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.
|
|
62
|
+
* @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). HTML templates have no visual form, so `web` is the only value they accept.
|
|
63
|
+
* @param editable_submissions {Boolean} Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
|
|
64
|
+
* @param embed_domains {Array.<String>} The sites where the template's signature requests, forms and embedded template editor can be loaded: 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). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
|
|
65
|
+
* @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).
|
|
66
|
+
* @param embed_edit_allow_versioning {Boolean} Allow the embedded template editor to publish, restore, compare and delete published versions.
|
|
67
|
+
* @param embed_edit_allow_document_replacement {Boolean} Allow the embedded template editor to replace the template's PDF.
|
|
68
|
+
* @param encrypt_pdfs {Boolean} Encrypt generated PDFs with `encrypt_pdfs_password`.
|
|
69
|
+
* @param has_encrypt_pdfs_password {Boolean} Whether `encrypt_pdfs_password` is set.
|
|
70
|
+
* @param expire_submissions {Boolean} Delete each submission's data and PDF after `expire_after` `expiration_interval`.
|
|
71
|
+
* @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).
|
|
72
|
+
* @param expiration_interval {module:model/ExpirationInterval} The unit of `expire_after`.
|
|
73
|
+
* @param merge_audit_trail_pdf {Boolean} Add the audit trail to the end of PDFs signed through signature requests.
|
|
74
|
+
* @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.
|
|
75
|
+
* @param public_submissions {Boolean} Allow anyone with a submission's ID to download its PDF.
|
|
76
|
+
* @param public_web_form {Boolean} Allow anyone to fill in the template's web form.
|
|
77
|
+
* @param redirect_url {String} Where the web form sends people after they submit it.
|
|
78
|
+
* @param has_slack_webhook_url {Boolean} Whether `slack_webhook_url` is set.
|
|
79
|
+
* @param last_changed_at {Date} When the draft was last changed.
|
|
80
|
+
* @param last_changed_by {module:model/TemplateActor} Who last changed the draft: a user in your account, an API token, or someone using the embedded template editor. Null if no change has been recorded.
|
|
81
|
+
* @param created_at {Date} When the template was created.
|
|
82
|
+
* @param updated_at {Date} When the template was last updated.
|
|
83
|
+
*/
|
|
84
|
+
function TemplateSummary(id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, 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_at, last_changed_by, created_at, updated_at) {
|
|
85
|
+
_classCallCheck(this, TemplateSummary);
|
|
86
|
+
TemplateSummary.initialize(this, id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, 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_at, last_changed_by, created_at, updated_at);
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* Initializes the fields of this object.
|
|
91
|
+
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
92
|
+
* Only for internal use.
|
|
93
|
+
*/
|
|
94
|
+
return _createClass(TemplateSummary, null, [{
|
|
95
|
+
key: "initialize",
|
|
96
|
+
value: function initialize(obj, id, name, description, template_type, ready, document, parent_folder_id, path, version, latest_version, version_published_at, locked, 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_at, last_changed_by, created_at, updated_at) {
|
|
97
|
+
obj['id'] = id;
|
|
98
|
+
obj['name'] = name;
|
|
99
|
+
obj['description'] = description;
|
|
100
|
+
obj['template_type'] = template_type;
|
|
101
|
+
obj['ready'] = ready;
|
|
102
|
+
obj['document'] = document;
|
|
103
|
+
obj['parent_folder_id'] = parent_folder_id;
|
|
104
|
+
obj['path'] = path;
|
|
105
|
+
obj['version'] = version;
|
|
106
|
+
obj['latest_version'] = latest_version;
|
|
107
|
+
obj['version_published_at'] = version_published_at;
|
|
108
|
+
obj['locked'] = locked;
|
|
109
|
+
obj['add_signature_request_submission_id_footers'] = add_signature_request_submission_id_footers;
|
|
110
|
+
obj['ai_field_naming_language'] = ai_field_naming_language;
|
|
111
|
+
obj['allow_additional_properties'] = allow_additional_properties;
|
|
112
|
+
obj['allow_skipping_optional_fields'] = allow_skipping_optional_fields;
|
|
113
|
+
obj['default_form_mode'] = default_form_mode;
|
|
114
|
+
obj['editable_submissions'] = editable_submissions;
|
|
115
|
+
obj['embed_domains'] = embed_domains;
|
|
116
|
+
obj['embed_edit_allow_settings'] = embed_edit_allow_settings;
|
|
117
|
+
obj['embed_edit_allow_versioning'] = embed_edit_allow_versioning;
|
|
118
|
+
obj['embed_edit_allow_document_replacement'] = embed_edit_allow_document_replacement;
|
|
119
|
+
obj['encrypt_pdfs'] = encrypt_pdfs;
|
|
120
|
+
obj['has_encrypt_pdfs_password'] = has_encrypt_pdfs_password;
|
|
121
|
+
obj['expire_submissions'] = expire_submissions;
|
|
122
|
+
obj['expire_after'] = expire_after;
|
|
123
|
+
obj['expiration_interval'] = expiration_interval;
|
|
124
|
+
obj['merge_audit_trail_pdf'] = merge_audit_trail_pdf;
|
|
125
|
+
obj['parse_dates_using_template_date_format'] = parse_dates_using_template_date_format;
|
|
126
|
+
obj['public_submissions'] = public_submissions;
|
|
127
|
+
obj['public_web_form'] = public_web_form;
|
|
128
|
+
obj['redirect_url'] = redirect_url;
|
|
129
|
+
obj['has_slack_webhook_url'] = has_slack_webhook_url;
|
|
130
|
+
obj['last_changed_at'] = last_changed_at;
|
|
131
|
+
obj['last_changed_by'] = last_changed_by;
|
|
132
|
+
obj['created_at'] = created_at;
|
|
133
|
+
obj['updated_at'] = updated_at;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Constructs a <code>TemplateSummary</code> from a plain JavaScript object, optionally creating a new instance.
|
|
138
|
+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
139
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
140
|
+
* @param {module:model/TemplateSummary} obj Optional instance to populate.
|
|
141
|
+
* @return {module:model/TemplateSummary} The populated <code>TemplateSummary</code> instance.
|
|
142
|
+
*/
|
|
143
|
+
}, {
|
|
144
|
+
key: "constructFromObject",
|
|
145
|
+
value: function constructFromObject(data, obj) {
|
|
146
|
+
if (data) {
|
|
147
|
+
obj = obj || new TemplateSummary();
|
|
148
|
+
_ApiClient["default"].constructFromObject(data, obj, 'Object');
|
|
149
|
+
if (data.hasOwnProperty('id')) {
|
|
150
|
+
obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
|
|
151
|
+
}
|
|
152
|
+
if (data.hasOwnProperty('name')) {
|
|
153
|
+
obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
|
|
154
|
+
}
|
|
155
|
+
if (data.hasOwnProperty('description')) {
|
|
156
|
+
obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
|
|
157
|
+
}
|
|
158
|
+
if (data.hasOwnProperty('template_type')) {
|
|
159
|
+
obj['template_type'] = _ApiClient["default"].convertToType(data['template_type'], _TemplateType["default"]);
|
|
160
|
+
}
|
|
161
|
+
if (data.hasOwnProperty('ready')) {
|
|
162
|
+
obj['ready'] = _ApiClient["default"].convertToType(data['ready'], 'Boolean');
|
|
163
|
+
}
|
|
164
|
+
if (data.hasOwnProperty('document')) {
|
|
165
|
+
obj['document'] = _ApiClient["default"].convertToType(data['document'], _TemplateDocument["default"]);
|
|
166
|
+
}
|
|
167
|
+
if (data.hasOwnProperty('parent_folder_id')) {
|
|
168
|
+
obj['parent_folder_id'] = _ApiClient["default"].convertToType(data['parent_folder_id'], 'String');
|
|
169
|
+
}
|
|
170
|
+
if (data.hasOwnProperty('path')) {
|
|
171
|
+
obj['path'] = _ApiClient["default"].convertToType(data['path'], 'String');
|
|
172
|
+
}
|
|
173
|
+
if (data.hasOwnProperty('version')) {
|
|
174
|
+
obj['version'] = _ApiClient["default"].convertToType(data['version'], 'String');
|
|
175
|
+
}
|
|
176
|
+
if (data.hasOwnProperty('latest_version')) {
|
|
177
|
+
obj['latest_version'] = _ApiClient["default"].convertToType(data['latest_version'], 'String');
|
|
178
|
+
}
|
|
179
|
+
if (data.hasOwnProperty('version_published_at')) {
|
|
180
|
+
obj['version_published_at'] = _ApiClient["default"].convertToType(data['version_published_at'], 'Date');
|
|
181
|
+
}
|
|
182
|
+
if (data.hasOwnProperty('locked')) {
|
|
183
|
+
obj['locked'] = _ApiClient["default"].convertToType(data['locked'], 'Boolean');
|
|
184
|
+
}
|
|
185
|
+
if (data.hasOwnProperty('add_signature_request_submission_id_footers')) {
|
|
186
|
+
obj['add_signature_request_submission_id_footers'] = _ApiClient["default"].convertToType(data['add_signature_request_submission_id_footers'], 'Boolean');
|
|
187
|
+
}
|
|
188
|
+
if (data.hasOwnProperty('ai_field_naming_language')) {
|
|
189
|
+
obj['ai_field_naming_language'] = _ApiClient["default"].convertToType(data['ai_field_naming_language'], _AiFieldNamingLanguage["default"]);
|
|
190
|
+
}
|
|
191
|
+
if (data.hasOwnProperty('allow_additional_properties')) {
|
|
192
|
+
obj['allow_additional_properties'] = _ApiClient["default"].convertToType(data['allow_additional_properties'], 'Boolean');
|
|
193
|
+
}
|
|
194
|
+
if (data.hasOwnProperty('allow_skipping_optional_fields')) {
|
|
195
|
+
obj['allow_skipping_optional_fields'] = _ApiClient["default"].convertToType(data['allow_skipping_optional_fields'], 'Boolean');
|
|
196
|
+
}
|
|
197
|
+
if (data.hasOwnProperty('default_form_mode')) {
|
|
198
|
+
obj['default_form_mode'] = _ApiClient["default"].convertToType(data['default_form_mode'], _TemplateFormMode["default"]);
|
|
199
|
+
}
|
|
200
|
+
if (data.hasOwnProperty('editable_submissions')) {
|
|
201
|
+
obj['editable_submissions'] = _ApiClient["default"].convertToType(data['editable_submissions'], 'Boolean');
|
|
202
|
+
}
|
|
203
|
+
if (data.hasOwnProperty('embed_domains')) {
|
|
204
|
+
obj['embed_domains'] = _ApiClient["default"].convertToType(data['embed_domains'], ['String']);
|
|
205
|
+
}
|
|
206
|
+
if (data.hasOwnProperty('embed_edit_allow_settings')) {
|
|
207
|
+
obj['embed_edit_allow_settings'] = _ApiClient["default"].convertToType(data['embed_edit_allow_settings'], 'Boolean');
|
|
208
|
+
}
|
|
209
|
+
if (data.hasOwnProperty('embed_edit_allow_versioning')) {
|
|
210
|
+
obj['embed_edit_allow_versioning'] = _ApiClient["default"].convertToType(data['embed_edit_allow_versioning'], 'Boolean');
|
|
211
|
+
}
|
|
212
|
+
if (data.hasOwnProperty('embed_edit_allow_document_replacement')) {
|
|
213
|
+
obj['embed_edit_allow_document_replacement'] = _ApiClient["default"].convertToType(data['embed_edit_allow_document_replacement'], 'Boolean');
|
|
214
|
+
}
|
|
215
|
+
if (data.hasOwnProperty('encrypt_pdfs')) {
|
|
216
|
+
obj['encrypt_pdfs'] = _ApiClient["default"].convertToType(data['encrypt_pdfs'], 'Boolean');
|
|
217
|
+
}
|
|
218
|
+
if (data.hasOwnProperty('has_encrypt_pdfs_password')) {
|
|
219
|
+
obj['has_encrypt_pdfs_password'] = _ApiClient["default"].convertToType(data['has_encrypt_pdfs_password'], 'Boolean');
|
|
220
|
+
}
|
|
221
|
+
if (data.hasOwnProperty('expire_submissions')) {
|
|
222
|
+
obj['expire_submissions'] = _ApiClient["default"].convertToType(data['expire_submissions'], 'Boolean');
|
|
223
|
+
}
|
|
224
|
+
if (data.hasOwnProperty('expire_after')) {
|
|
225
|
+
obj['expire_after'] = _ApiClient["default"].convertToType(data['expire_after'], 'Number');
|
|
226
|
+
}
|
|
227
|
+
if (data.hasOwnProperty('expiration_interval')) {
|
|
228
|
+
obj['expiration_interval'] = _ApiClient["default"].convertToType(data['expiration_interval'], _ExpirationInterval["default"]);
|
|
229
|
+
}
|
|
230
|
+
if (data.hasOwnProperty('merge_audit_trail_pdf')) {
|
|
231
|
+
obj['merge_audit_trail_pdf'] = _ApiClient["default"].convertToType(data['merge_audit_trail_pdf'], 'Boolean');
|
|
232
|
+
}
|
|
233
|
+
if (data.hasOwnProperty('parse_dates_using_template_date_format')) {
|
|
234
|
+
obj['parse_dates_using_template_date_format'] = _ApiClient["default"].convertToType(data['parse_dates_using_template_date_format'], 'Boolean');
|
|
235
|
+
}
|
|
236
|
+
if (data.hasOwnProperty('public_submissions')) {
|
|
237
|
+
obj['public_submissions'] = _ApiClient["default"].convertToType(data['public_submissions'], 'Boolean');
|
|
238
|
+
}
|
|
239
|
+
if (data.hasOwnProperty('public_web_form')) {
|
|
240
|
+
obj['public_web_form'] = _ApiClient["default"].convertToType(data['public_web_form'], 'Boolean');
|
|
241
|
+
}
|
|
242
|
+
if (data.hasOwnProperty('redirect_url')) {
|
|
243
|
+
obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
|
|
244
|
+
}
|
|
245
|
+
if (data.hasOwnProperty('has_slack_webhook_url')) {
|
|
246
|
+
obj['has_slack_webhook_url'] = _ApiClient["default"].convertToType(data['has_slack_webhook_url'], 'Boolean');
|
|
247
|
+
}
|
|
248
|
+
if (data.hasOwnProperty('last_changed_at')) {
|
|
249
|
+
obj['last_changed_at'] = _ApiClient["default"].convertToType(data['last_changed_at'], 'Date');
|
|
250
|
+
}
|
|
251
|
+
if (data.hasOwnProperty('last_changed_by')) {
|
|
252
|
+
obj['last_changed_by'] = _ApiClient["default"].convertToType(data['last_changed_by'], _TemplateActor["default"]);
|
|
253
|
+
}
|
|
254
|
+
if (data.hasOwnProperty('created_at')) {
|
|
255
|
+
obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
|
|
256
|
+
}
|
|
257
|
+
if (data.hasOwnProperty('updated_at')) {
|
|
258
|
+
obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
return obj;
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* Validates the JSON data with respect to <code>TemplateSummary</code>.
|
|
266
|
+
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
267
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>TemplateSummary</code>.
|
|
268
|
+
*/
|
|
269
|
+
}, {
|
|
270
|
+
key: "validateJSON",
|
|
271
|
+
value: function validateJSON(data) {
|
|
272
|
+
// check to make sure all required properties are present in the JSON string
|
|
273
|
+
var _iterator = _createForOfIteratorHelper(TemplateSummary.RequiredProperties),
|
|
274
|
+
_step;
|
|
275
|
+
try {
|
|
276
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
277
|
+
var property = _step.value;
|
|
278
|
+
if (!data.hasOwnProperty(property)) {
|
|
279
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
280
|
+
}
|
|
281
|
+
}
|
|
282
|
+
// ensure the json data is a string
|
|
283
|
+
} catch (err) {
|
|
284
|
+
_iterator.e(err);
|
|
285
|
+
} finally {
|
|
286
|
+
_iterator.f();
|
|
287
|
+
}
|
|
288
|
+
if (data['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
|
|
289
|
+
throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
|
|
290
|
+
}
|
|
291
|
+
// ensure the json data is a string
|
|
292
|
+
if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
|
|
293
|
+
throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
|
|
294
|
+
}
|
|
295
|
+
// ensure the json data is a string
|
|
296
|
+
if (data['description'] && !(typeof data['description'] === 'string' || data['description'] instanceof String)) {
|
|
297
|
+
throw new Error("Expected the field `description` to be a primitive type in the JSON string but got " + data['description']);
|
|
298
|
+
}
|
|
299
|
+
// validate the optional field `document`
|
|
300
|
+
if (data['document']) {
|
|
301
|
+
// data not null
|
|
302
|
+
_TemplateDocument["default"].validateJSON(data['document']);
|
|
303
|
+
}
|
|
304
|
+
// ensure the json data is a string
|
|
305
|
+
if (data['parent_folder_id'] && !(typeof data['parent_folder_id'] === 'string' || data['parent_folder_id'] instanceof String)) {
|
|
306
|
+
throw new Error("Expected the field `parent_folder_id` to be a primitive type in the JSON string but got " + data['parent_folder_id']);
|
|
307
|
+
}
|
|
308
|
+
// ensure the json data is a string
|
|
309
|
+
if (data['path'] && !(typeof data['path'] === 'string' || data['path'] instanceof String)) {
|
|
310
|
+
throw new Error("Expected the field `path` to be a primitive type in the JSON string but got " + data['path']);
|
|
311
|
+
}
|
|
312
|
+
// ensure the json data is a string
|
|
313
|
+
if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
|
|
314
|
+
throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
|
|
315
|
+
}
|
|
316
|
+
// ensure the json data is a string
|
|
317
|
+
if (data['latest_version'] && !(typeof data['latest_version'] === 'string' || data['latest_version'] instanceof String)) {
|
|
318
|
+
throw new Error("Expected the field `latest_version` to be a primitive type in the JSON string but got " + data['latest_version']);
|
|
319
|
+
}
|
|
320
|
+
// ensure the json data is an array
|
|
321
|
+
if (!Array.isArray(data['embed_domains'])) {
|
|
322
|
+
throw new Error("Expected the field `embed_domains` to be an array in the JSON data but got " + data['embed_domains']);
|
|
323
|
+
}
|
|
324
|
+
// ensure the json data is a string
|
|
325
|
+
if (data['redirect_url'] && !(typeof data['redirect_url'] === 'string' || data['redirect_url'] instanceof String)) {
|
|
326
|
+
throw new Error("Expected the field `redirect_url` to be a primitive type in the JSON string but got " + data['redirect_url']);
|
|
327
|
+
}
|
|
328
|
+
// validate the optional field `last_changed_by`
|
|
329
|
+
if (data['last_changed_by']) {
|
|
330
|
+
// data not null
|
|
331
|
+
_TemplateActor["default"].validateJSON(data['last_changed_by']);
|
|
332
|
+
}
|
|
333
|
+
return true;
|
|
334
|
+
}
|
|
335
|
+
}]);
|
|
336
|
+
}();
|
|
337
|
+
TemplateSummary.RequiredProperties = ["id", "name", "description", "template_type", "ready", "document", "parent_folder_id", "path", "version", "latest_version", "version_published_at", "locked", "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_at", "last_changed_by", "created_at", "updated_at"];
|
|
338
|
+
|
|
339
|
+
/**
|
|
340
|
+
* The template's ID.
|
|
341
|
+
* @member {String} id
|
|
342
|
+
*/
|
|
343
|
+
TemplateSummary.prototype['id'] = undefined;
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* The template's name.
|
|
347
|
+
* @member {String} name
|
|
348
|
+
*/
|
|
349
|
+
TemplateSummary.prototype['name'] = undefined;
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
* 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.
|
|
353
|
+
* @member {String} description
|
|
354
|
+
*/
|
|
355
|
+
TemplateSummary.prototype['description'] = undefined;
|
|
356
|
+
|
|
357
|
+
/**
|
|
358
|
+
* `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.
|
|
359
|
+
* @member {module:model/TemplateType} template_type
|
|
360
|
+
*/
|
|
361
|
+
TemplateSummary.prototype['template_type'] = undefined;
|
|
362
|
+
|
|
363
|
+
/**
|
|
364
|
+
* Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once its document has been processed (`document.state` is `processed`).
|
|
365
|
+
* @member {Boolean} ready
|
|
366
|
+
*/
|
|
367
|
+
TemplateSummary.prototype['ready'] = undefined;
|
|
368
|
+
|
|
369
|
+
/**
|
|
370
|
+
* The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet.
|
|
371
|
+
* @member {module:model/TemplateDocument} document
|
|
372
|
+
*/
|
|
373
|
+
TemplateSummary.prototype['document'] = undefined;
|
|
374
|
+
|
|
375
|
+
/**
|
|
376
|
+
* 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.
|
|
377
|
+
* @member {String} parent_folder_id
|
|
378
|
+
*/
|
|
379
|
+
TemplateSummary.prototype['parent_folder_id'] = undefined;
|
|
380
|
+
|
|
381
|
+
/**
|
|
382
|
+
* The path of the folder the template is in, such as `/Contracts`. `/` for a template at the root.
|
|
383
|
+
* @member {String} path
|
|
384
|
+
*/
|
|
385
|
+
TemplateSummary.prototype['path'] = undefined;
|
|
386
|
+
|
|
387
|
+
/**
|
|
388
|
+
* The published version this is, such as `1.2.0`. Null for the draft.
|
|
389
|
+
* @member {String} version
|
|
390
|
+
*/
|
|
391
|
+
TemplateSummary.prototype['version'] = undefined;
|
|
392
|
+
|
|
393
|
+
/**
|
|
394
|
+
* The template's latest published version. Null if no version has been published.
|
|
395
|
+
* @member {String} latest_version
|
|
396
|
+
*/
|
|
397
|
+
TemplateSummary.prototype['latest_version'] = undefined;
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* When this version was published. Null for the draft.
|
|
401
|
+
* @member {Date} version_published_at
|
|
402
|
+
*/
|
|
403
|
+
TemplateSummary.prototype['version_published_at'] = undefined;
|
|
404
|
+
|
|
405
|
+
/**
|
|
406
|
+
* A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed).
|
|
407
|
+
* @member {Boolean} locked
|
|
408
|
+
*/
|
|
409
|
+
TemplateSummary.prototype['locked'] = undefined;
|
|
410
|
+
|
|
411
|
+
/**
|
|
412
|
+
* Print the submission ID in the footer of each page of PDFs signed through signature requests.
|
|
413
|
+
* @member {Boolean} add_signature_request_submission_id_footers
|
|
414
|
+
*/
|
|
415
|
+
TemplateSummary.prototype['add_signature_request_submission_id_footers'] = undefined;
|
|
416
|
+
|
|
417
|
+
/**
|
|
418
|
+
* 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.
|
|
419
|
+
* @member {module:model/AiFieldNamingLanguage} ai_field_naming_language
|
|
420
|
+
*/
|
|
421
|
+
TemplateSummary.prototype['ai_field_naming_language'] = undefined;
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* Accept submission data with properties that aren't fields of the template.
|
|
425
|
+
* @member {Boolean} allow_additional_properties
|
|
426
|
+
*/
|
|
427
|
+
TemplateSummary.prototype['allow_additional_properties'] = undefined;
|
|
428
|
+
|
|
429
|
+
/**
|
|
430
|
+
* 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.
|
|
431
|
+
* @member {Boolean} allow_skipping_optional_fields
|
|
432
|
+
*/
|
|
433
|
+
TemplateSummary.prototype['allow_skipping_optional_fields'] = undefined;
|
|
434
|
+
|
|
435
|
+
/**
|
|
436
|
+
* 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). HTML templates have no visual form, so `web` is the only value they accept.
|
|
437
|
+
* @member {module:model/TemplateFormMode} default_form_mode
|
|
438
|
+
*/
|
|
439
|
+
TemplateSummary.prototype['default_form_mode'] = undefined;
|
|
440
|
+
|
|
441
|
+
/**
|
|
442
|
+
* Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
|
|
443
|
+
* @member {Boolean} editable_submissions
|
|
444
|
+
*/
|
|
445
|
+
TemplateSummary.prototype['editable_submissions'] = undefined;
|
|
446
|
+
|
|
447
|
+
/**
|
|
448
|
+
* The sites where the template's signature requests, forms and embedded template editor can be loaded: 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). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
|
|
449
|
+
* @member {Array.<String>} embed_domains
|
|
450
|
+
*/
|
|
451
|
+
TemplateSummary.prototype['embed_domains'] = undefined;
|
|
452
|
+
|
|
453
|
+
/**
|
|
454
|
+
* Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
|
|
455
|
+
* @member {Boolean} embed_edit_allow_settings
|
|
456
|
+
*/
|
|
457
|
+
TemplateSummary.prototype['embed_edit_allow_settings'] = undefined;
|
|
458
|
+
|
|
459
|
+
/**
|
|
460
|
+
* Allow the embedded template editor to publish, restore, compare and delete published versions.
|
|
461
|
+
* @member {Boolean} embed_edit_allow_versioning
|
|
462
|
+
*/
|
|
463
|
+
TemplateSummary.prototype['embed_edit_allow_versioning'] = undefined;
|
|
464
|
+
|
|
465
|
+
/**
|
|
466
|
+
* Allow the embedded template editor to replace the template's PDF.
|
|
467
|
+
* @member {Boolean} embed_edit_allow_document_replacement
|
|
468
|
+
*/
|
|
469
|
+
TemplateSummary.prototype['embed_edit_allow_document_replacement'] = undefined;
|
|
470
|
+
|
|
471
|
+
/**
|
|
472
|
+
* Encrypt generated PDFs with `encrypt_pdfs_password`.
|
|
473
|
+
* @member {Boolean} encrypt_pdfs
|
|
474
|
+
*/
|
|
475
|
+
TemplateSummary.prototype['encrypt_pdfs'] = undefined;
|
|
476
|
+
|
|
477
|
+
/**
|
|
478
|
+
* Whether `encrypt_pdfs_password` is set.
|
|
479
|
+
* @member {Boolean} has_encrypt_pdfs_password
|
|
480
|
+
*/
|
|
481
|
+
TemplateSummary.prototype['has_encrypt_pdfs_password'] = undefined;
|
|
482
|
+
|
|
483
|
+
/**
|
|
484
|
+
* Delete each submission's data and PDF after `expire_after` `expiration_interval`.
|
|
485
|
+
* @member {Boolean} expire_submissions
|
|
486
|
+
*/
|
|
487
|
+
TemplateSummary.prototype['expire_submissions'] = undefined;
|
|
488
|
+
|
|
489
|
+
/**
|
|
490
|
+
* 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).
|
|
491
|
+
* @member {Number} expire_after
|
|
492
|
+
*/
|
|
493
|
+
TemplateSummary.prototype['expire_after'] = undefined;
|
|
494
|
+
|
|
495
|
+
/**
|
|
496
|
+
* The unit of `expire_after`.
|
|
497
|
+
* @member {module:model/ExpirationInterval} expiration_interval
|
|
498
|
+
*/
|
|
499
|
+
TemplateSummary.prototype['expiration_interval'] = undefined;
|
|
500
|
+
|
|
501
|
+
/**
|
|
502
|
+
* Add the audit trail to the end of PDFs signed through signature requests.
|
|
503
|
+
* @member {Boolean} merge_audit_trail_pdf
|
|
504
|
+
*/
|
|
505
|
+
TemplateSummary.prototype['merge_audit_trail_pdf'] = undefined;
|
|
506
|
+
|
|
507
|
+
/**
|
|
508
|
+
* 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.
|
|
509
|
+
* @member {Boolean} parse_dates_using_template_date_format
|
|
510
|
+
*/
|
|
511
|
+
TemplateSummary.prototype['parse_dates_using_template_date_format'] = undefined;
|
|
512
|
+
|
|
513
|
+
/**
|
|
514
|
+
* Allow anyone with a submission's ID to download its PDF.
|
|
515
|
+
* @member {Boolean} public_submissions
|
|
516
|
+
*/
|
|
517
|
+
TemplateSummary.prototype['public_submissions'] = undefined;
|
|
518
|
+
|
|
519
|
+
/**
|
|
520
|
+
* Allow anyone to fill in the template's web form.
|
|
521
|
+
* @member {Boolean} public_web_form
|
|
522
|
+
*/
|
|
523
|
+
TemplateSummary.prototype['public_web_form'] = undefined;
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* Where the web form sends people after they submit it.
|
|
527
|
+
* @member {String} redirect_url
|
|
528
|
+
*/
|
|
529
|
+
TemplateSummary.prototype['redirect_url'] = undefined;
|
|
530
|
+
|
|
531
|
+
/**
|
|
532
|
+
* Whether `slack_webhook_url` is set.
|
|
533
|
+
* @member {Boolean} has_slack_webhook_url
|
|
534
|
+
*/
|
|
535
|
+
TemplateSummary.prototype['has_slack_webhook_url'] = undefined;
|
|
536
|
+
|
|
537
|
+
/**
|
|
538
|
+
* When the draft was last changed.
|
|
539
|
+
* @member {Date} last_changed_at
|
|
540
|
+
*/
|
|
541
|
+
TemplateSummary.prototype['last_changed_at'] = undefined;
|
|
542
|
+
|
|
543
|
+
/**
|
|
544
|
+
* Who last changed the draft: a user in your account, an API token, or someone using the embedded template editor. Null if no change has been recorded.
|
|
545
|
+
* @member {module:model/TemplateActor} last_changed_by
|
|
546
|
+
*/
|
|
547
|
+
TemplateSummary.prototype['last_changed_by'] = undefined;
|
|
548
|
+
|
|
549
|
+
/**
|
|
550
|
+
* When the template was created.
|
|
551
|
+
* @member {Date} created_at
|
|
552
|
+
*/
|
|
553
|
+
TemplateSummary.prototype['created_at'] = undefined;
|
|
554
|
+
|
|
555
|
+
/**
|
|
556
|
+
* When the template was last updated.
|
|
557
|
+
* @member {Date} updated_at
|
|
558
|
+
*/
|
|
559
|
+
TemplateSummary.prototype['updated_at'] = undefined;
|
|
560
|
+
var _default = exports["default"] = TemplateSummary;
|