docspring 3.3.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.
Files changed (158) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +65 -63
  3. package/dist/ApiClient.js +63 -28
  4. package/dist/RequestSchemas.js +2297 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1346 -948
  7. package/dist/index.js +651 -154
  8. package/dist/model/AiFieldNamingLanguage.js +64 -0
  9. package/dist/model/{CreateWebhookData.js → AuthenticationCheck.js} +32 -28
  10. package/dist/model/BarcodeSymbology.js +89 -0
  11. package/dist/model/CheckCharacter.js +74 -0
  12. package/dist/model/CombinedFieldType.js +59 -0
  13. package/dist/model/CombinedPdf.js +294 -0
  14. package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +27 -27
  15. package/dist/model/CombinedPdfList.js +132 -0
  16. package/dist/model/{ForbiddenErrorResponse.js → CombinedPdfSource.js} +59 -73
  17. package/dist/model/CombinedPdfSourceInput.js +270 -0
  18. package/dist/model/CombinedPdfSourcePdf.js +130 -0
  19. package/dist/model/CombinedPdfSourceType.js +74 -0
  20. package/dist/model/CombinedPdfState.js +74 -0
  21. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +26 -22
  22. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +69 -53
  23. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +25 -23
  24. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +47 -28
  25. package/dist/model/{TemplateDeleteResponse.js → CreateSignatureRequestEventRequest.js} +49 -74
  26. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  27. package/dist/model/{SubmissionBatchData.js → CreateSubmissionBatchRequest.js} +67 -42
  28. package/dist/model/CreateSubmissionRequest.js +212 -0
  29. package/dist/model/CreateTemplateRequest.js +545 -0
  30. package/dist/model/CreateWebhookRequest.js +234 -0
  31. package/dist/model/CustomFile.js +67 -16
  32. package/dist/model/CustomFileList.js +132 -0
  33. package/dist/model/CustomFileSourcePdf.js +130 -0
  34. package/dist/model/ErrorCode.js +154 -0
  35. package/dist/model/{CreateSubmissionResponse.js → ErrorDetail.js} +65 -75
  36. package/dist/model/ErrorInfo.js +211 -0
  37. package/dist/model/ErrorResponse.js +12 -41
  38. package/dist/model/ExpirationInterval.js +64 -0
  39. package/dist/model/FieldComparisonCondition.js +137 -0
  40. package/dist/model/FieldComparisonOperator.js +69 -0
  41. package/dist/model/FieldDisplayType.js +79 -0
  42. package/dist/model/{MultipleErrorsResponse.js → FieldEqualsCondition.js} +48 -52
  43. package/dist/model/FieldEqualsOperator.js +59 -0
  44. package/dist/model/{SuccessMultipleErrorsResponse.js → FieldInCondition.js} +54 -53
  45. package/dist/model/FieldOverride.js +722 -0
  46. package/dist/model/FieldPresenceCondition.js +126 -0
  47. package/dist/model/FieldPresenceOperator.js +59 -0
  48. package/dist/model/FieldRangeCondition.js +148 -0
  49. package/dist/model/FieldReimportState.js +69 -0
  50. package/dist/model/FieldSetupLogic.js +59 -0
  51. package/dist/model/FieldSetupNaming.js +59 -0
  52. package/dist/model/FieldSetupSource.js +64 -0
  53. package/dist/model/Folder.js +38 -11
  54. package/dist/model/FolderList.js +132 -0
  55. package/dist/model/GeneratedFile.js +214 -0
  56. package/dist/model/GeneratedFileState.js +64 -0
  57. package/dist/model/HtmlEngineOptions.js +230 -0
  58. package/dist/model/HtmlEngineOptionsInput.js +193 -0
  59. package/dist/model/ImageGravity.js +94 -0
  60. package/dist/model/ImageScaleType.js +64 -0
  61. package/dist/model/ModelCodeLanguage.js +94 -0
  62. package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +34 -28
  63. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +25 -35
  64. package/dist/model/NumberConditionType.js +79 -0
  65. package/dist/model/PageFormat.js +114 -0
  66. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +33 -33
  67. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +25 -23
  68. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +25 -23
  69. package/dist/model/ShapeType.js +79 -0
  70. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +165 -240
  71. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  72. package/dist/model/SignatureRequestAuthType.js +84 -0
  73. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +67 -149
  74. package/dist/model/SignatureRequestEventType.js +79 -0
  75. package/dist/model/SignatureRequestInput.js +278 -0
  76. package/dist/model/SignatureRequestMessageType.js +94 -0
  77. package/dist/model/SignatureRequestState.js +64 -0
  78. package/dist/model/SignatureRequestToken.js +195 -0
  79. package/dist/model/SignatureRequestTokenType.js +59 -0
  80. package/dist/model/StringConditionType.js +74 -0
  81. package/dist/model/Submission.js +186 -345
  82. package/dist/model/SubmissionAction.js +30 -115
  83. package/dist/model/SubmissionActionState.js +69 -0
  84. package/dist/model/SubmissionActionType.js +84 -0
  85. package/dist/model/SubmissionBatch.js +74 -55
  86. package/dist/model/SubmissionBatchState.js +64 -0
  87. package/dist/model/SubmissionFiles.js +108 -0
  88. package/dist/model/SubmissionInput.js +204 -0
  89. package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +35 -42
  90. package/dist/model/SubmissionSource.js +69 -0
  91. package/dist/model/SubmissionSourcePdf.js +130 -0
  92. package/dist/model/SubmissionState.js +114 -0
  93. package/dist/model/Template.js +310 -573
  94. package/dist/model/TemplateActor.js +171 -0
  95. package/dist/model/TemplateActorType.js +64 -0
  96. package/dist/model/TemplateDefaults.js +307 -0
  97. package/dist/model/TemplateDefaultsInput.js +305 -0
  98. package/dist/model/TemplateDocument.js +280 -0
  99. package/dist/model/TemplateDocumentState.js +74 -0
  100. package/dist/model/{CreatePdfSubmissionData.js → TemplateFieldDependency.js} +70 -89
  101. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  102. package/dist/model/{TemplatePublishVersionResponse.js → TemplateFieldDependencyCondition.js} +51 -61
  103. package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
  104. package/dist/model/TemplateFieldDependencyInput.js +182 -0
  105. package/dist/model/TemplateFieldDependencyMatch.js +59 -0
  106. package/dist/model/TemplateFieldDependencyOperator.js +99 -0
  107. package/dist/model/TemplateFieldLogicStatus.js +74 -0
  108. package/dist/model/TemplateFormMode.js +64 -0
  109. package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +34 -86
  110. package/dist/model/TemplatePageAiError.js +69 -0
  111. package/dist/model/TemplatePageAiNamingStatus.js +59 -0
  112. package/dist/model/TemplatePageFieldsStatus.js +74 -0
  113. package/dist/model/TemplatePageImageStatus.js +59 -0
  114. package/dist/model/TemplatePageProcessingStatus.js +162 -0
  115. package/dist/model/{SubmissionDataRequestToken.js → TemplateSourcePdf.js} +52 -56
  116. package/dist/model/TemplateSummary.js +560 -0
  117. package/dist/model/{SuccessErrorResponse.js → TemplateSummaryList.js} +43 -55
  118. package/dist/model/TemplateType.js +59 -0
  119. package/dist/model/{Submission422Response.js → TemplateVersion.js} +60 -63
  120. package/dist/model/TemplateVersionType.js +64 -0
  121. package/dist/model/TextAlignment.js +69 -0
  122. package/dist/model/TextOverflow.js +59 -0
  123. package/dist/model/TextVerticalAlignment.js +64 -0
  124. package/dist/model/Typeface.js +134 -0
  125. package/dist/model/UpdateSignatureRequestRequest.js +183 -0
  126. package/dist/model/UpdateTemplateDocumentRequest.js +136 -0
  127. package/dist/model/UpdateTemplateRequest.js +450 -0
  128. package/dist/model/UpdateWebhookRequest.js +209 -0
  129. package/dist/model/UploadMethod.js +54 -0
  130. package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +53 -58
  131. package/dist/model/{AddFieldsData.js → UrlSourcePdf.js} +49 -31
  132. package/dist/model/Webhook.js +58 -73
  133. package/dist/model/WebhookEventType.js +174 -0
  134. package/dist/model/WebhookList.js +132 -0
  135. package/dist/model/WebhookMode.js +59 -0
  136. package/package.json +1 -1
  137. package/dist/model/BatchGeneratePdfs201Response.js +0 -194
  138. package/dist/model/CombinedSubmission.js +0 -313
  139. package/dist/model/CombinedSubmissionAction.js +0 -268
  140. package/dist/model/CreateCombinedSubmissionResponse.js +0 -180
  141. package/dist/model/CreateCustomFileResponse.js +0 -167
  142. package/dist/model/CreateHtmlTemplate.js +0 -108
  143. package/dist/model/CreatePdfTemplate.js +0 -108
  144. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  145. package/dist/model/CreateSubmissionDataRequestEventRequest.js +0 -239
  146. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -167
  147. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -167
  148. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -167
  149. package/dist/model/ErrorOrMultipleErrorsResponse.js +0 -153
  150. package/dist/model/JsonSchema.js +0 -205
  151. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  152. package/dist/model/SubmissionDataRequest.js +0 -496
  153. package/dist/model/SubmissionPreview.js +0 -509
  154. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  155. package/dist/model/TemplatePreview.js +0 -796
  156. package/dist/model/UpdateHtmlTemplate.js +0 -108
  157. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  158. package/dist/model/UpdateWebhookData.js +0 -108
@@ -0,0 +1,230 @@
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 _PageFormat = _interopRequireDefault(require("./PageFormat"));
9
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
10
+ 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); }
11
+ 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; } } }; }
12
+ 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; } }
13
+ 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; }
14
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
15
+ 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); } }
16
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
17
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
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
+ * DocSpring API
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
21
+ *
22
+ * The version of the OpenAPI document: v2
23
+ *
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * The HtmlEngineOptions model module.
32
+ * @module model/HtmlEngineOptions
33
+ * @version 4.0.0
34
+ */
35
+ var HtmlEngineOptions = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>HtmlEngineOptions</code>.
38
+ * How an HTML template's PDFs are printed.
39
+ * @alias module:model/HtmlEngineOptions
40
+ * @param format {module:model/PageFormat} The paper size. `Custom` uses `width` and `height`.
41
+ * @param scale {Number} How much to scale the page, such as `0.8`. `1` prints it at its normal size.
42
+ * @param landscape {Boolean} Print pages in landscape orientation.
43
+ * @param print_background {Boolean} Print background colors and images.
44
+ * @param margin_top {String} The top margin, with a unit, such as `1in` or `20mm`.
45
+ * @param margin_bottom {String} The bottom margin, with a unit.
46
+ * @param margin_left {String} The left margin, with a unit.
47
+ * @param margin_right {String} The right margin, with a unit.
48
+ */
49
+ function HtmlEngineOptions(format, scale, landscape, print_background, margin_top, margin_bottom, margin_left, margin_right) {
50
+ _classCallCheck(this, HtmlEngineOptions);
51
+ HtmlEngineOptions.initialize(this, format, scale, landscape, print_background, margin_top, margin_bottom, margin_left, margin_right);
52
+ }
53
+
54
+ /**
55
+ * Initializes the fields of this object.
56
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
57
+ * Only for internal use.
58
+ */
59
+ return _createClass(HtmlEngineOptions, null, [{
60
+ key: "initialize",
61
+ value: function initialize(obj, format, scale, landscape, print_background, margin_top, margin_bottom, margin_left, margin_right) {
62
+ obj['format'] = format;
63
+ obj['scale'] = scale;
64
+ obj['landscape'] = landscape;
65
+ obj['print_background'] = print_background;
66
+ obj['margin_top'] = margin_top;
67
+ obj['margin_bottom'] = margin_bottom;
68
+ obj['margin_left'] = margin_left;
69
+ obj['margin_right'] = margin_right;
70
+ }
71
+
72
+ /**
73
+ * Constructs a <code>HtmlEngineOptions</code> from a plain JavaScript object, optionally creating a new instance.
74
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
75
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
76
+ * @param {module:model/HtmlEngineOptions} obj Optional instance to populate.
77
+ * @return {module:model/HtmlEngineOptions} The populated <code>HtmlEngineOptions</code> instance.
78
+ */
79
+ }, {
80
+ key: "constructFromObject",
81
+ value: function constructFromObject(data, obj) {
82
+ if (data) {
83
+ obj = obj || new HtmlEngineOptions();
84
+ if (data.hasOwnProperty('format')) {
85
+ obj['format'] = _ApiClient["default"].convertToType(data['format'], _PageFormat["default"]);
86
+ }
87
+ if (data.hasOwnProperty('width')) {
88
+ obj['width'] = _ApiClient["default"].convertToType(data['width'], 'String');
89
+ }
90
+ if (data.hasOwnProperty('height')) {
91
+ obj['height'] = _ApiClient["default"].convertToType(data['height'], 'String');
92
+ }
93
+ if (data.hasOwnProperty('scale')) {
94
+ obj['scale'] = _ApiClient["default"].convertToType(data['scale'], 'Number');
95
+ }
96
+ if (data.hasOwnProperty('landscape')) {
97
+ obj['landscape'] = _ApiClient["default"].convertToType(data['landscape'], 'Boolean');
98
+ }
99
+ if (data.hasOwnProperty('print_background')) {
100
+ obj['print_background'] = _ApiClient["default"].convertToType(data['print_background'], 'Boolean');
101
+ }
102
+ if (data.hasOwnProperty('margin_top')) {
103
+ obj['margin_top'] = _ApiClient["default"].convertToType(data['margin_top'], 'String');
104
+ }
105
+ if (data.hasOwnProperty('margin_bottom')) {
106
+ obj['margin_bottom'] = _ApiClient["default"].convertToType(data['margin_bottom'], 'String');
107
+ }
108
+ if (data.hasOwnProperty('margin_left')) {
109
+ obj['margin_left'] = _ApiClient["default"].convertToType(data['margin_left'], 'String');
110
+ }
111
+ if (data.hasOwnProperty('margin_right')) {
112
+ obj['margin_right'] = _ApiClient["default"].convertToType(data['margin_right'], 'String');
113
+ }
114
+ }
115
+ return obj;
116
+ }
117
+
118
+ /**
119
+ * Validates the JSON data with respect to <code>HtmlEngineOptions</code>.
120
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
121
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>HtmlEngineOptions</code>.
122
+ */
123
+ }, {
124
+ key: "validateJSON",
125
+ value: function validateJSON(data) {
126
+ // check to make sure all required properties are present in the JSON string
127
+ var _iterator = _createForOfIteratorHelper(HtmlEngineOptions.RequiredProperties),
128
+ _step;
129
+ try {
130
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
131
+ var property = _step.value;
132
+ if (!data.hasOwnProperty(property)) {
133
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
134
+ }
135
+ }
136
+ // ensure the json data is a string
137
+ } catch (err) {
138
+ _iterator.e(err);
139
+ } finally {
140
+ _iterator.f();
141
+ }
142
+ if (data['width'] && !(typeof data['width'] === 'string' || data['width'] instanceof String)) {
143
+ throw new Error("Expected the field `width` to be a primitive type in the JSON string but got " + data['width']);
144
+ }
145
+ // ensure the json data is a string
146
+ if (data['height'] && !(typeof data['height'] === 'string' || data['height'] instanceof String)) {
147
+ throw new Error("Expected the field `height` to be a primitive type in the JSON string but got " + data['height']);
148
+ }
149
+ // ensure the json data is a string
150
+ if (data['margin_top'] && !(typeof data['margin_top'] === 'string' || data['margin_top'] instanceof String)) {
151
+ throw new Error("Expected the field `margin_top` to be a primitive type in the JSON string but got " + data['margin_top']);
152
+ }
153
+ // ensure the json data is a string
154
+ if (data['margin_bottom'] && !(typeof data['margin_bottom'] === 'string' || data['margin_bottom'] instanceof String)) {
155
+ throw new Error("Expected the field `margin_bottom` to be a primitive type in the JSON string but got " + data['margin_bottom']);
156
+ }
157
+ // ensure the json data is a string
158
+ if (data['margin_left'] && !(typeof data['margin_left'] === 'string' || data['margin_left'] instanceof String)) {
159
+ throw new Error("Expected the field `margin_left` to be a primitive type in the JSON string but got " + data['margin_left']);
160
+ }
161
+ // ensure the json data is a string
162
+ if (data['margin_right'] && !(typeof data['margin_right'] === 'string' || data['margin_right'] instanceof String)) {
163
+ throw new Error("Expected the field `margin_right` to be a primitive type in the JSON string but got " + data['margin_right']);
164
+ }
165
+ return true;
166
+ }
167
+ }]);
168
+ }();
169
+ HtmlEngineOptions.RequiredProperties = ["format", "scale", "landscape", "print_background", "margin_top", "margin_bottom", "margin_left", "margin_right"];
170
+
171
+ /**
172
+ * The paper size. `Custom` uses `width` and `height`.
173
+ * @member {module:model/PageFormat} format
174
+ */
175
+ HtmlEngineOptions.prototype['format'] = undefined;
176
+
177
+ /**
178
+ * The page width for the `Custom` format, with a unit (`8.5in`, `210mm`).
179
+ * @member {String} width
180
+ */
181
+ HtmlEngineOptions.prototype['width'] = undefined;
182
+
183
+ /**
184
+ * The page height for the `Custom` format, with a unit.
185
+ * @member {String} height
186
+ */
187
+ HtmlEngineOptions.prototype['height'] = undefined;
188
+
189
+ /**
190
+ * How much to scale the page, such as `0.8`. `1` prints it at its normal size.
191
+ * @member {Number} scale
192
+ */
193
+ HtmlEngineOptions.prototype['scale'] = undefined;
194
+
195
+ /**
196
+ * Print pages in landscape orientation.
197
+ * @member {Boolean} landscape
198
+ */
199
+ HtmlEngineOptions.prototype['landscape'] = undefined;
200
+
201
+ /**
202
+ * Print background colors and images.
203
+ * @member {Boolean} print_background
204
+ */
205
+ HtmlEngineOptions.prototype['print_background'] = undefined;
206
+
207
+ /**
208
+ * The top margin, with a unit, such as `1in` or `20mm`.
209
+ * @member {String} margin_top
210
+ */
211
+ HtmlEngineOptions.prototype['margin_top'] = undefined;
212
+
213
+ /**
214
+ * The bottom margin, with a unit.
215
+ * @member {String} margin_bottom
216
+ */
217
+ HtmlEngineOptions.prototype['margin_bottom'] = undefined;
218
+
219
+ /**
220
+ * The left margin, with a unit.
221
+ * @member {String} margin_left
222
+ */
223
+ HtmlEngineOptions.prototype['margin_left'] = undefined;
224
+
225
+ /**
226
+ * The right margin, with a unit.
227
+ * @member {String} margin_right
228
+ */
229
+ HtmlEngineOptions.prototype['margin_right'] = undefined;
230
+ var _default = exports["default"] = HtmlEngineOptions;
@@ -0,0 +1,193 @@
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 _PageFormat = _interopRequireDefault(require("./PageFormat"));
9
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
10
+ 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); }
11
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
12
+ 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); } }
13
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
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
+ * DocSpring API
17
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
18
+ *
19
+ * The version of the OpenAPI document: v2
20
+ *
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * The HtmlEngineOptionsInput model module.
29
+ * @module model/HtmlEngineOptionsInput
30
+ * @version 4.0.0
31
+ */
32
+ var HtmlEngineOptionsInput = /*#__PURE__*/function () {
33
+ /**
34
+ * Constructs a new <code>HtmlEngineOptionsInput</code>.
35
+ * How an HTML template's PDFs are printed.
36
+ * @alias module:model/HtmlEngineOptionsInput
37
+ */
38
+ function HtmlEngineOptionsInput() {
39
+ _classCallCheck(this, HtmlEngineOptionsInput);
40
+ HtmlEngineOptionsInput.initialize(this);
41
+ }
42
+
43
+ /**
44
+ * Initializes the fields of this object.
45
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
46
+ * Only for internal use.
47
+ */
48
+ return _createClass(HtmlEngineOptionsInput, null, [{
49
+ key: "initialize",
50
+ value: function initialize(obj) {}
51
+
52
+ /**
53
+ * Constructs a <code>HtmlEngineOptionsInput</code> from a plain JavaScript object, optionally creating a new instance.
54
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
55
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
56
+ * @param {module:model/HtmlEngineOptionsInput} obj Optional instance to populate.
57
+ * @return {module:model/HtmlEngineOptionsInput} The populated <code>HtmlEngineOptionsInput</code> instance.
58
+ */
59
+ }, {
60
+ key: "constructFromObject",
61
+ value: function constructFromObject(data, obj) {
62
+ if (data) {
63
+ obj = obj || new HtmlEngineOptionsInput();
64
+ if (data.hasOwnProperty('format')) {
65
+ obj['format'] = _ApiClient["default"].convertToType(data['format'], _PageFormat["default"]);
66
+ }
67
+ if (data.hasOwnProperty('width')) {
68
+ obj['width'] = _ApiClient["default"].convertToType(data['width'], 'String');
69
+ }
70
+ if (data.hasOwnProperty('height')) {
71
+ obj['height'] = _ApiClient["default"].convertToType(data['height'], 'String');
72
+ }
73
+ if (data.hasOwnProperty('scale')) {
74
+ obj['scale'] = _ApiClient["default"].convertToType(data['scale'], 'Number');
75
+ }
76
+ if (data.hasOwnProperty('landscape')) {
77
+ obj['landscape'] = _ApiClient["default"].convertToType(data['landscape'], 'Boolean');
78
+ }
79
+ if (data.hasOwnProperty('print_background')) {
80
+ obj['print_background'] = _ApiClient["default"].convertToType(data['print_background'], 'Boolean');
81
+ }
82
+ if (data.hasOwnProperty('margin_top')) {
83
+ obj['margin_top'] = _ApiClient["default"].convertToType(data['margin_top'], 'String');
84
+ }
85
+ if (data.hasOwnProperty('margin_bottom')) {
86
+ obj['margin_bottom'] = _ApiClient["default"].convertToType(data['margin_bottom'], 'String');
87
+ }
88
+ if (data.hasOwnProperty('margin_left')) {
89
+ obj['margin_left'] = _ApiClient["default"].convertToType(data['margin_left'], 'String');
90
+ }
91
+ if (data.hasOwnProperty('margin_right')) {
92
+ obj['margin_right'] = _ApiClient["default"].convertToType(data['margin_right'], 'String');
93
+ }
94
+ }
95
+ return obj;
96
+ }
97
+
98
+ /**
99
+ * Validates the JSON data with respect to <code>HtmlEngineOptionsInput</code>.
100
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
101
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>HtmlEngineOptionsInput</code>.
102
+ */
103
+ }, {
104
+ key: "validateJSON",
105
+ value: function validateJSON(data) {
106
+ // ensure the json data is a string
107
+ if (data['width'] && !(typeof data['width'] === 'string' || data['width'] instanceof String)) {
108
+ throw new Error("Expected the field `width` to be a primitive type in the JSON string but got " + data['width']);
109
+ }
110
+ // ensure the json data is a string
111
+ if (data['height'] && !(typeof data['height'] === 'string' || data['height'] instanceof String)) {
112
+ throw new Error("Expected the field `height` to be a primitive type in the JSON string but got " + data['height']);
113
+ }
114
+ // ensure the json data is a string
115
+ if (data['margin_top'] && !(typeof data['margin_top'] === 'string' || data['margin_top'] instanceof String)) {
116
+ throw new Error("Expected the field `margin_top` to be a primitive type in the JSON string but got " + data['margin_top']);
117
+ }
118
+ // ensure the json data is a string
119
+ if (data['margin_bottom'] && !(typeof data['margin_bottom'] === 'string' || data['margin_bottom'] instanceof String)) {
120
+ throw new Error("Expected the field `margin_bottom` to be a primitive type in the JSON string but got " + data['margin_bottom']);
121
+ }
122
+ // ensure the json data is a string
123
+ if (data['margin_left'] && !(typeof data['margin_left'] === 'string' || data['margin_left'] instanceof String)) {
124
+ throw new Error("Expected the field `margin_left` to be a primitive type in the JSON string but got " + data['margin_left']);
125
+ }
126
+ // ensure the json data is a string
127
+ if (data['margin_right'] && !(typeof data['margin_right'] === 'string' || data['margin_right'] instanceof String)) {
128
+ throw new Error("Expected the field `margin_right` to be a primitive type in the JSON string but got " + data['margin_right']);
129
+ }
130
+ return true;
131
+ }
132
+ }]);
133
+ }();
134
+ /**
135
+ * The paper size. `Custom` uses `width` and `height`.
136
+ * @member {module:model/PageFormat} format
137
+ */
138
+ HtmlEngineOptionsInput.prototype['format'] = undefined;
139
+
140
+ /**
141
+ * The page width for the `Custom` format, with a unit (`8.5in`, `210mm`).
142
+ * @member {String} width
143
+ */
144
+ HtmlEngineOptionsInput.prototype['width'] = undefined;
145
+
146
+ /**
147
+ * The page height for the `Custom` format, with a unit.
148
+ * @member {String} height
149
+ */
150
+ HtmlEngineOptionsInput.prototype['height'] = undefined;
151
+
152
+ /**
153
+ * How much to scale the page, such as `0.8`. `1` prints it at its normal size.
154
+ * @member {Number} scale
155
+ */
156
+ HtmlEngineOptionsInput.prototype['scale'] = undefined;
157
+
158
+ /**
159
+ * Print pages in landscape orientation.
160
+ * @member {Boolean} landscape
161
+ */
162
+ HtmlEngineOptionsInput.prototype['landscape'] = undefined;
163
+
164
+ /**
165
+ * Print background colors and images.
166
+ * @member {Boolean} print_background
167
+ */
168
+ HtmlEngineOptionsInput.prototype['print_background'] = undefined;
169
+
170
+ /**
171
+ * The top margin, with a unit, such as `1in` or `20mm`.
172
+ * @member {String} margin_top
173
+ */
174
+ HtmlEngineOptionsInput.prototype['margin_top'] = undefined;
175
+
176
+ /**
177
+ * The bottom margin, with a unit.
178
+ * @member {String} margin_bottom
179
+ */
180
+ HtmlEngineOptionsInput.prototype['margin_bottom'] = undefined;
181
+
182
+ /**
183
+ * The left margin, with a unit.
184
+ * @member {String} margin_left
185
+ */
186
+ HtmlEngineOptionsInput.prototype['margin_left'] = undefined;
187
+
188
+ /**
189
+ * The right margin, with a unit.
190
+ * @member {String} margin_right
191
+ */
192
+ HtmlEngineOptionsInput.prototype['margin_right'] = undefined;
193
+ var _default = exports["default"] = HtmlEngineOptionsInput;
@@ -0,0 +1,94 @@
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
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ 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); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ 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); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
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
+ * DocSpring API
17
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
18
+ *
19
+ * The version of the OpenAPI document: v2
20
+ *
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * Enum class ImageGravity.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var ImageGravity = exports["default"] = /*#__PURE__*/function () {
33
+ function ImageGravity() {
34
+ _classCallCheck(this, ImageGravity);
35
+ }
36
+ return _createClass(ImageGravity, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>ImageGravity</code> enum value from a Javascript object name.
41
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
42
+ * @return {module:model/ImageGravity} The enum <code>ImageGravity</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "NorthWest"
52
+ * @const
53
+ */
54
+ _defineProperty(ImageGravity, "NorthWest", "NorthWest");
55
+ /**
56
+ * value: "North"
57
+ * @const
58
+ */
59
+ _defineProperty(ImageGravity, "North", "North");
60
+ /**
61
+ * value: "NorthEast"
62
+ * @const
63
+ */
64
+ _defineProperty(ImageGravity, "NorthEast", "NorthEast");
65
+ /**
66
+ * value: "West"
67
+ * @const
68
+ */
69
+ _defineProperty(ImageGravity, "West", "West");
70
+ /**
71
+ * value: "Center"
72
+ * @const
73
+ */
74
+ _defineProperty(ImageGravity, "Center", "Center");
75
+ /**
76
+ * value: "East"
77
+ * @const
78
+ */
79
+ _defineProperty(ImageGravity, "East", "East");
80
+ /**
81
+ * value: "SouthWest"
82
+ * @const
83
+ */
84
+ _defineProperty(ImageGravity, "SouthWest", "SouthWest");
85
+ /**
86
+ * value: "South"
87
+ * @const
88
+ */
89
+ _defineProperty(ImageGravity, "South", "South");
90
+ /**
91
+ * value: "SouthEast"
92
+ * @const
93
+ */
94
+ _defineProperty(ImageGravity, "SouthEast", "SouthEast");
@@ -0,0 +1,64 @@
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
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ 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); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ 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); } }
12
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
14
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
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
+ * DocSpring API
17
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
18
+ *
19
+ * The version of the OpenAPI document: v2
20
+ *
21
+ *
22
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
23
+ * https://openapi-generator.tech
24
+ * Do not edit the class manually.
25
+ *
26
+ */
27
+ /**
28
+ * Enum class ImageScaleType.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var ImageScaleType = exports["default"] = /*#__PURE__*/function () {
33
+ function ImageScaleType() {
34
+ _classCallCheck(this, ImageScaleType);
35
+ }
36
+ return _createClass(ImageScaleType, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>ImageScaleType</code> enum value from a Javascript object name.
41
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
42
+ * @return {module:model/ImageScaleType} The enum <code>ImageScaleType</code> value.
43
+ */
44
+ function constructFromObject(object) {
45
+ // Any value, including one added to the API after this client was released
46
+ return object;
47
+ }
48
+ }]);
49
+ }();
50
+ /**
51
+ * value: "fit"
52
+ * @const
53
+ */
54
+ _defineProperty(ImageScaleType, "fit", "fit");
55
+ /**
56
+ * value: "fill"
57
+ * @const
58
+ */
59
+ _defineProperty(ImageScaleType, "fill", "fill");
60
+ /**
61
+ * value: "stretch"
62
+ * @const
63
+ */
64
+ _defineProperty(ImageScaleType, "stretch", "stretch");