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.
Files changed (157) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +65 -63
  3. package/dist/ApiClient.js +62 -27
  4. package/dist/RequestSchemas.js +2297 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1345 -946
  7. package/dist/index.js +655 -151
  8. package/dist/model/AiFieldNamingLanguage.js +64 -0
  9. package/dist/model/{AddFieldsData.js → AuthenticationCheck.js} +31 -31
  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} +26 -26
  15. package/dist/model/CombinedPdfList.js +132 -0
  16. package/dist/model/{SubmissionDataRequestToken.js → CombinedPdfSource.js} +55 -52
  17. package/dist/model/CombinedPdfSourceInput.js +270 -0
  18. package/dist/model/{SuccessErrorResponse.js → CombinedPdfSourcePdf.js} +41 -55
  19. package/dist/model/CombinedPdfSourceType.js +74 -0
  20. package/dist/model/CombinedPdfState.js +74 -0
  21. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +25 -21
  22. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +68 -52
  23. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +24 -22
  24. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +46 -27
  25. package/dist/model/{CreateSubmissionDataRequestEventRequest.js → CreateSignatureRequestEventRequest.js} +41 -137
  26. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  27. package/dist/model/{CreatePdfSubmissionData.js → CreateSubmissionBatchRequest.js} +63 -87
  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 +66 -15
  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/{BatchGeneratePdfs201Response.js → ErrorDetail.js} +65 -76
  36. package/dist/model/ErrorInfo.js +211 -0
  37. package/dist/model/ErrorResponse.js +11 -40
  38. package/dist/model/ExpirationInterval.js +64 -0
  39. package/dist/model/{CreateSubmissionResponse.js → FieldComparisonCondition.js} +46 -64
  40. package/dist/model/FieldComparisonOperator.js +69 -0
  41. package/dist/model/FieldDisplayType.js +79 -0
  42. package/dist/model/FieldEqualsCondition.js +137 -0
  43. package/dist/model/FieldEqualsOperator.js +59 -0
  44. package/dist/model/FieldInCondition.js +145 -0
  45. package/dist/model/FieldOverride.js +722 -0
  46. package/dist/model/{MultipleErrorsResponse.js → FieldPresenceCondition.js} +39 -54
  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 +37 -10
  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} +33 -27
  63. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +24 -34
  64. package/dist/model/NumberConditionType.js +79 -0
  65. package/dist/model/PageFormat.js +114 -0
  66. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +32 -32
  67. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +24 -22
  68. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +24 -22
  69. package/dist/model/ShapeType.js +79 -0
  70. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +164 -239
  71. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  72. package/dist/model/SignatureRequestAuthType.js +84 -0
  73. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +66 -148
  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 +185 -339
  82. package/dist/model/SubmissionAction.js +29 -114
  83. package/dist/model/SubmissionActionState.js +69 -0
  84. package/dist/model/SubmissionActionType.js +84 -0
  85. package/dist/model/SubmissionBatch.js +73 -54
  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} +34 -41
  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 +309 -572
  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/TemplateFieldDependency.js +184 -0
  101. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  102. package/dist/model/{CreateCombinedSubmissionResponse.js → TemplateFieldDependencyCondition.js} +50 -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} +33 -85
  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/{SubmissionBatchData.js → TemplateSourcePdf.js} +49 -49
  116. package/dist/model/TemplateSummary.js +560 -0
  117. package/dist/model/{SuccessMultipleErrorsResponse.js → TemplateSummaryList.js} +43 -55
  118. package/dist/model/TemplateType.js +59 -0
  119. package/dist/model/{Submission422Response.js → TemplateVersion.js} +59 -62
  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/{ErrorOrMultipleErrorsResponse.js → UpdateTemplateDocumentRequest.js} +43 -60
  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} +52 -57
  131. package/dist/model/UrlSourcePdf.js +130 -0
  132. package/dist/model/Webhook.js +57 -72
  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/CombinedSubmission.js +0 -308
  138. package/dist/model/CombinedSubmissionAction.js +0 -268
  139. package/dist/model/CreateCustomFileResponse.js +0 -155
  140. package/dist/model/CreateHtmlTemplate.js +0 -108
  141. package/dist/model/CreatePdfTemplate.js +0 -108
  142. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  143. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -155
  144. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -155
  145. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -155
  146. package/dist/model/CreateWebhookData.js +0 -108
  147. package/dist/model/JsonSchema.js +0 -205
  148. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  149. package/dist/model/SubmissionDataRequest.js +0 -496
  150. package/dist/model/SubmissionPreview.js +0 -504
  151. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  152. package/dist/model/TemplateDeleteResponse.js +0 -168
  153. package/dist/model/TemplatePreview.js +0 -796
  154. package/dist/model/TemplatePublishVersionResponse.js +0 -154
  155. package/dist/model/UpdateHtmlTemplate.js +0 -108
  156. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  157. package/dist/model/UpdateWebhookData.js +0 -108
@@ -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 SubmissionBatchState.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var SubmissionBatchState = exports["default"] = /*#__PURE__*/function () {
33
+ function SubmissionBatchState() {
34
+ _classCallCheck(this, SubmissionBatchState);
35
+ }
36
+ return _createClass(SubmissionBatchState, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>SubmissionBatchState</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/SubmissionBatchState} The enum <code>SubmissionBatchState</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: "pending"
52
+ * @const
53
+ */
54
+ _defineProperty(SubmissionBatchState, "pending", "pending");
55
+ /**
56
+ * value: "processed"
57
+ * @const
58
+ */
59
+ _defineProperty(SubmissionBatchState, "processed", "processed");
60
+ /**
61
+ * value: "error"
62
+ * @const
63
+ */
64
+ _defineProperty(SubmissionBatchState, "error", "error");
@@ -0,0 +1,108 @@
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 _GeneratedFile = _interopRequireDefault(require("./GeneratedFile"));
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 SubmissionFiles model module.
29
+ * @module model/SubmissionFiles
30
+ * @version 4.0.0
31
+ */
32
+ var SubmissionFiles = /*#__PURE__*/function () {
33
+ /**
34
+ * Constructs a new <code>SubmissionFiles</code>.
35
+ * A submission's generated files. Each one is left out until it exists.
36
+ * @alias module:model/SubmissionFiles
37
+ * @extends Object
38
+ */
39
+ function SubmissionFiles() {
40
+ _classCallCheck(this, SubmissionFiles);
41
+ SubmissionFiles.initialize(this);
42
+ }
43
+
44
+ /**
45
+ * Initializes the fields of this object.
46
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
47
+ * Only for internal use.
48
+ */
49
+ return _createClass(SubmissionFiles, null, [{
50
+ key: "initialize",
51
+ value: function initialize(obj) {}
52
+
53
+ /**
54
+ * Constructs a <code>SubmissionFiles</code> from a plain JavaScript object, optionally creating a new instance.
55
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
56
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
57
+ * @param {module:model/SubmissionFiles} obj Optional instance to populate.
58
+ * @return {module:model/SubmissionFiles} The populated <code>SubmissionFiles</code> instance.
59
+ */
60
+ }, {
61
+ key: "constructFromObject",
62
+ value: function constructFromObject(data, obj) {
63
+ if (data) {
64
+ obj = obj || new SubmissionFiles();
65
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
66
+ if (data.hasOwnProperty('pdf')) {
67
+ obj['pdf'] = _ApiClient["default"].convertToType(data['pdf'], _GeneratedFile["default"]);
68
+ }
69
+ if (data.hasOwnProperty('audit_trail')) {
70
+ obj['audit_trail'] = _ApiClient["default"].convertToType(data['audit_trail'], _GeneratedFile["default"]);
71
+ }
72
+ if (data.hasOwnProperty('preview')) {
73
+ obj['preview'] = _ApiClient["default"].convertToType(data['preview'], _GeneratedFile["default"]);
74
+ }
75
+ }
76
+ return obj;
77
+ }
78
+
79
+ /**
80
+ * Validates the JSON data with respect to <code>SubmissionFiles</code>.
81
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
82
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SubmissionFiles</code>.
83
+ */
84
+ }, {
85
+ key: "validateJSON",
86
+ value: function validateJSON(data) {
87
+ return true;
88
+ }
89
+ }]);
90
+ }();
91
+ /**
92
+ * The submission's PDF.
93
+ * @member {module:model/GeneratedFile} pdf
94
+ */
95
+ SubmissionFiles.prototype['pdf'] = undefined;
96
+
97
+ /**
98
+ * The audit trail of a submission with signature requests: who signed, when and how. It's also added to the end of the PDF when the template's `merge_audit_trail_pdf` is on.
99
+ * @member {module:model/GeneratedFile} audit_trail
100
+ */
101
+ SubmissionFiles.prototype['audit_trail'] = undefined;
102
+
103
+ /**
104
+ * The preview PDF from POST /submissions/{submission_id}/generate_preview, such as for a submission still waiting for its signature requests.
105
+ * @member {module:model/GeneratedFile} preview
106
+ */
107
+ SubmissionFiles.prototype['preview'] = undefined;
108
+ var _default = exports["default"] = SubmissionFiles;
@@ -0,0 +1,204 @@
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 _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
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 SubmissionInput model module.
29
+ * @module model/SubmissionInput
30
+ * @version 4.0.0
31
+ */
32
+ var SubmissionInput = /*#__PURE__*/function () {
33
+ /**
34
+ * Constructs a new <code>SubmissionInput</code>.
35
+ * A submission to create in a batch, with its own template when it doesn't use the batch's.
36
+ * @alias module:model/SubmissionInput
37
+ */
38
+ function SubmissionInput() {
39
+ _classCallCheck(this, SubmissionInput);
40
+ SubmissionInput.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(SubmissionInput, null, [{
49
+ key: "initialize",
50
+ value: function initialize(obj) {}
51
+
52
+ /**
53
+ * Constructs a <code>SubmissionInput</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/SubmissionInput} obj Optional instance to populate.
57
+ * @return {module:model/SubmissionInput} The populated <code>SubmissionInput</code> instance.
58
+ */
59
+ }, {
60
+ key: "constructFromObject",
61
+ value: function constructFromObject(data, obj) {
62
+ if (data) {
63
+ obj = obj || new SubmissionInput();
64
+ if (data.hasOwnProperty('test')) {
65
+ obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
66
+ }
67
+ if (data.hasOwnProperty('editable')) {
68
+ obj['editable'] = _ApiClient["default"].convertToType(data['editable'], 'Boolean');
69
+ }
70
+ if (data.hasOwnProperty('data')) {
71
+ obj['data'] = _ApiClient["default"].convertToType(data['data'], {
72
+ 'String': Object
73
+ });
74
+ }
75
+ if (data.hasOwnProperty('metadata')) {
76
+ obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
77
+ 'String': Object
78
+ });
79
+ }
80
+ if (data.hasOwnProperty('password')) {
81
+ obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
82
+ }
83
+ if (data.hasOwnProperty('expires_in')) {
84
+ obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
85
+ }
86
+ if (data.hasOwnProperty('field_overrides')) {
87
+ obj['field_overrides'] = _ApiClient["default"].convertToType(data['field_overrides'], {
88
+ 'String': _FieldOverride["default"]
89
+ });
90
+ }
91
+ if (data.hasOwnProperty('html')) {
92
+ obj['html'] = _ApiClient["default"].convertToType(data['html'], 'String');
93
+ }
94
+ if (data.hasOwnProperty('css')) {
95
+ obj['css'] = _ApiClient["default"].convertToType(data['css'], 'String');
96
+ }
97
+ if (data.hasOwnProperty('template_id')) {
98
+ obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
99
+ }
100
+ if (data.hasOwnProperty('template_version')) {
101
+ obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
102
+ }
103
+ }
104
+ return obj;
105
+ }
106
+
107
+ /**
108
+ * Validates the JSON data with respect to <code>SubmissionInput</code>.
109
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
110
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SubmissionInput</code>.
111
+ */
112
+ }, {
113
+ key: "validateJSON",
114
+ value: function validateJSON(data) {
115
+ // ensure the json data is a string
116
+ if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
117
+ throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
118
+ }
119
+ // ensure the json data is a string
120
+ if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
121
+ throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
122
+ }
123
+ // ensure the json data is a string
124
+ if (data['css'] && !(typeof data['css'] === 'string' || data['css'] instanceof String)) {
125
+ throw new Error("Expected the field `css` to be a primitive type in the JSON string but got " + data['css']);
126
+ }
127
+ // ensure the json data is a string
128
+ if (data['template_id'] && !(typeof data['template_id'] === 'string' || data['template_id'] instanceof String)) {
129
+ throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
130
+ }
131
+ // ensure the json data is a string
132
+ if (data['template_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
133
+ throw new Error("Expected the field `template_version` to be a primitive type in the JSON string but got " + data['template_version']);
134
+ }
135
+ return true;
136
+ }
137
+ }]);
138
+ }();
139
+ /**
140
+ * Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
141
+ * @member {Boolean} test
142
+ */
143
+ SubmissionInput.prototype['test'] = undefined;
144
+
145
+ /**
146
+ * `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
147
+ * @member {Boolean} editable
148
+ */
149
+ SubmissionInput.prototype['editable'] = undefined;
150
+
151
+ /**
152
+ * The values of the template's fields, by field name. Required for a PDF template.
153
+ * @member {Object.<String, Object>} data
154
+ */
155
+ SubmissionInput.prototype['data'] = undefined;
156
+
157
+ /**
158
+ * Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
159
+ * @member {Object.<String, Object>} metadata
160
+ */
161
+ SubmissionInput.prototype['metadata'] = undefined;
162
+
163
+ /**
164
+ * A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
165
+ * @member {String} password
166
+ */
167
+ SubmissionInput.prototype['password'] = undefined;
168
+
169
+ /**
170
+ * Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours.
171
+ * @member {Number} expires_in
172
+ */
173
+ SubmissionInput.prototype['expires_in'] = undefined;
174
+
175
+ /**
176
+ * Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
177
+ * @member {Object.<String, module:model/FieldOverride>} field_overrides
178
+ */
179
+ SubmissionInput.prototype['field_overrides'] = undefined;
180
+
181
+ /**
182
+ * For an HTML template, HTML to use instead of the template's.
183
+ * @member {String} html
184
+ */
185
+ SubmissionInput.prototype['html'] = undefined;
186
+
187
+ /**
188
+ * For an HTML template, CSS to use instead of the template's.
189
+ * @member {String} css
190
+ */
191
+ SubmissionInput.prototype['css'] = undefined;
192
+
193
+ /**
194
+ * The submission's template. Default the batch's `template_id`.
195
+ * @member {String} template_id
196
+ */
197
+ SubmissionInput.prototype['template_id'] = undefined;
198
+
199
+ /**
200
+ * The version of the submission's template. Default the batch's `template_version`.
201
+ * @member {String} template_version
202
+ */
203
+ SubmissionInput.prototype['template_version'] = undefined;
204
+ var _default = exports["default"] = SubmissionInput;
@@ -19,7 +19,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
19
19
  * DocSpring API
20
20
  * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
21
21
  *
22
- * The version of the OpenAPI document: v1
22
+ * The version of the OpenAPI document: v2
23
23
  *
24
24
  *
25
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,22 +28,22 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
28
28
  *
29
29
  */
30
30
  /**
31
- * The ListSubmissionsResponse model module.
32
- * @module model/ListSubmissionsResponse
33
- * @version 3.2.0
31
+ * The SubmissionList model module.
32
+ * @module model/SubmissionList
33
+ * @version 4.0.0
34
34
  */
35
- var ListSubmissionsResponse = /*#__PURE__*/function () {
35
+ var SubmissionList = /*#__PURE__*/function () {
36
36
  /**
37
- * Constructs a new <code>ListSubmissionsResponse</code>.
38
- * @alias module:model/ListSubmissionsResponse
37
+ * Constructs a new <code>SubmissionList</code>.
38
+ * A page of submissions, newest first.
39
+ * @alias module:model/SubmissionList
39
40
  * @extends Object
40
- * @param submissions {Array.<module:model/Submission>}
41
- * @param limit {Number}
42
- * @param next_cursor {String}
41
+ * @param data {Array.<module:model/Submission>} The items on this page.
42
+ * @param next_cursor {String} Pass it as `cursor` to get the next page. Null on the last page.
43
43
  */
44
- function ListSubmissionsResponse(submissions, limit, next_cursor) {
45
- _classCallCheck(this, ListSubmissionsResponse);
46
- ListSubmissionsResponse.initialize(this, submissions, limit, next_cursor);
44
+ function SubmissionList(data, next_cursor) {
45
+ _classCallCheck(this, SubmissionList);
46
+ SubmissionList.initialize(this, data, next_cursor);
47
47
  }
48
48
 
49
49
  /**
@@ -51,32 +51,28 @@ var ListSubmissionsResponse = /*#__PURE__*/function () {
51
51
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
52
52
  * Only for internal use.
53
53
  */
54
- return _createClass(ListSubmissionsResponse, null, [{
54
+ return _createClass(SubmissionList, null, [{
55
55
  key: "initialize",
56
- value: function initialize(obj, submissions, limit, next_cursor) {
57
- obj['submissions'] = submissions;
58
- obj['limit'] = limit;
56
+ value: function initialize(obj, data, next_cursor) {
57
+ obj['data'] = data;
59
58
  obj['next_cursor'] = next_cursor;
60
59
  }
61
60
 
62
61
  /**
63
- * Constructs a <code>ListSubmissionsResponse</code> from a plain JavaScript object, optionally creating a new instance.
62
+ * Constructs a <code>SubmissionList</code> from a plain JavaScript object, optionally creating a new instance.
64
63
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
65
64
  * @param {Object} data The plain JavaScript object bearing properties of interest.
66
- * @param {module:model/ListSubmissionsResponse} obj Optional instance to populate.
67
- * @return {module:model/ListSubmissionsResponse} The populated <code>ListSubmissionsResponse</code> instance.
65
+ * @param {module:model/SubmissionList} obj Optional instance to populate.
66
+ * @return {module:model/SubmissionList} The populated <code>SubmissionList</code> instance.
68
67
  */
69
68
  }, {
70
69
  key: "constructFromObject",
71
70
  value: function constructFromObject(data, obj) {
72
71
  if (data) {
73
- obj = obj || new ListSubmissionsResponse();
72
+ obj = obj || new SubmissionList();
74
73
  _ApiClient["default"].constructFromObject(data, obj, 'Object');
75
- if (data.hasOwnProperty('submissions')) {
76
- obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [_Submission["default"]]);
77
- }
78
- if (data.hasOwnProperty('limit')) {
79
- obj['limit'] = _ApiClient["default"].convertToType(data['limit'], 'Number');
74
+ if (data.hasOwnProperty('data')) {
75
+ obj['data'] = _ApiClient["default"].convertToType(data['data'], [_Submission["default"]]);
80
76
  }
81
77
  if (data.hasOwnProperty('next_cursor')) {
82
78
  obj['next_cursor'] = _ApiClient["default"].convertToType(data['next_cursor'], 'String');
@@ -86,15 +82,15 @@ var ListSubmissionsResponse = /*#__PURE__*/function () {
86
82
  }
87
83
 
88
84
  /**
89
- * Validates the JSON data with respect to <code>ListSubmissionsResponse</code>.
85
+ * Validates the JSON data with respect to <code>SubmissionList</code>.
90
86
  * @param {Object} data The plain JavaScript object bearing properties of interest.
91
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>ListSubmissionsResponse</code>.
87
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SubmissionList</code>.
92
88
  */
93
89
  }, {
94
90
  key: "validateJSON",
95
91
  value: function validateJSON(data) {
96
92
  // check to make sure all required properties are present in the JSON string
97
- var _iterator = _createForOfIteratorHelper(ListSubmissionsResponse.RequiredProperties),
93
+ var _iterator = _createForOfIteratorHelper(SubmissionList.RequiredProperties),
98
94
  _step;
99
95
  try {
100
96
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -109,8 +105,8 @@ var ListSubmissionsResponse = /*#__PURE__*/function () {
109
105
  } finally {
110
106
  _iterator.f();
111
107
  }
112
- if (!Array.isArray(data['submissions'])) {
113
- throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
108
+ if (!Array.isArray(data['data'])) {
109
+ throw new Error("Expected the field `data` to be an array in the JSON data but got " + data['data']);
114
110
  }
115
111
  // ensure the json data is a string
116
112
  if (data['next_cursor'] && !(typeof data['next_cursor'] === 'string' || data['next_cursor'] instanceof String)) {
@@ -120,20 +116,17 @@ var ListSubmissionsResponse = /*#__PURE__*/function () {
120
116
  }
121
117
  }]);
122
118
  }();
123
- ListSubmissionsResponse.RequiredProperties = ["submissions", "limit", "next_cursor"];
124
-
125
- /**
126
- * @member {Array.<module:model/Submission>} submissions
127
- */
128
- ListSubmissionsResponse.prototype['submissions'] = undefined;
119
+ SubmissionList.RequiredProperties = ["data", "next_cursor"];
129
120
 
130
121
  /**
131
- * @member {Number} limit
122
+ * The items on this page.
123
+ * @member {Array.<module:model/Submission>} data
132
124
  */
133
- ListSubmissionsResponse.prototype['limit'] = undefined;
125
+ SubmissionList.prototype['data'] = undefined;
134
126
 
135
127
  /**
128
+ * Pass it as `cursor` to get the next page. Null on the last page.
136
129
  * @member {String} next_cursor
137
130
  */
138
- ListSubmissionsResponse.prototype['next_cursor'] = undefined;
139
- var _default = exports["default"] = ListSubmissionsResponse;
131
+ SubmissionList.prototype['next_cursor'] = undefined;
132
+ var _default = exports["default"] = SubmissionList;
@@ -0,0 +1,69 @@
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 SubmissionSource.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var SubmissionSource = exports["default"] = /*#__PURE__*/function () {
33
+ function SubmissionSource() {
34
+ _classCallCheck(this, SubmissionSource);
35
+ }
36
+ return _createClass(SubmissionSource, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>SubmissionSource</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/SubmissionSource} The enum <code>SubmissionSource</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: "api"
52
+ * @const
53
+ */
54
+ _defineProperty(SubmissionSource, "api", "api");
55
+ /**
56
+ * value: "web"
57
+ * @const
58
+ */
59
+ _defineProperty(SubmissionSource, "web", "web");
60
+ /**
61
+ * value: "reprocess"
62
+ * @const
63
+ */
64
+ _defineProperty(SubmissionSource, "reprocess", "reprocess");
65
+ /**
66
+ * value: "webhook"
67
+ * @const
68
+ */
69
+ _defineProperty(SubmissionSource, "webhook", "webhook");