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