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,59 @@
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 WebhookMode.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var WebhookMode = exports["default"] = /*#__PURE__*/function () {
33
+ function WebhookMode() {
34
+ _classCallCheck(this, WebhookMode);
35
+ }
36
+ return _createClass(WebhookMode, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>WebhookMode</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/WebhookMode} The enum <code>WebhookMode</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: "test"
52
+ * @const
53
+ */
54
+ _defineProperty(WebhookMode, "test", "test");
55
+ /**
56
+ * value: "live"
57
+ * @const
58
+ */
59
+ _defineProperty(WebhookMode, "live", "live");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docspring",
3
- "version": "3.3.0",
3
+ "version": "4.0.0",
4
4
  "description": "An API client for the DocSpring PDF generation service",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",
@@ -1,194 +0,0 @@
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 _SubmissionBatch = _interopRequireDefault(require("./SubmissionBatch"));
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. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
21
- *
22
- * The version of the OpenAPI document: v1
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 BatchGeneratePdfs201Response model module.
32
- * @module model/BatchGeneratePdfs201Response
33
- * @version 3.3.0
34
- */
35
- var BatchGeneratePdfs201Response = /*#__PURE__*/function () {
36
- /**
37
- * Constructs a new <code>BatchGeneratePdfs201Response</code>.
38
- * @alias module:model/BatchGeneratePdfs201Response
39
- * @extends Object
40
- * @param status {module:model/BatchGeneratePdfs201Response.StatusEnum}
41
- * @param submission_batch {module:model/SubmissionBatch}
42
- * @param submissions {Array.<Object>}
43
- */
44
- function BatchGeneratePdfs201Response(status, submission_batch, submissions) {
45
- _classCallCheck(this, BatchGeneratePdfs201Response);
46
- BatchGeneratePdfs201Response.initialize(this, status, submission_batch, submissions);
47
- }
48
-
49
- /**
50
- * Initializes the fields of this object.
51
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
52
- * Only for internal use.
53
- */
54
- return _createClass(BatchGeneratePdfs201Response, null, [{
55
- key: "initialize",
56
- value: function initialize(obj, status, submission_batch, submissions) {
57
- obj['status'] = status;
58
- obj['submission_batch'] = submission_batch;
59
- obj['submissions'] = submissions;
60
- }
61
-
62
- /**
63
- * Constructs a <code>BatchGeneratePdfs201Response</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/BatchGeneratePdfs201Response} obj Optional instance to populate.
67
- * @return {module:model/BatchGeneratePdfs201Response} The populated <code>BatchGeneratePdfs201Response</code> instance.
68
- */
69
- }, {
70
- key: "constructFromObject",
71
- value: function constructFromObject(data, obj) {
72
- if (data) {
73
- obj = obj || new BatchGeneratePdfs201Response();
74
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
75
- if (data.hasOwnProperty('status')) {
76
- obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
77
- }
78
- if (data.hasOwnProperty('error')) {
79
- obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
80
- }
81
- if (data.hasOwnProperty('errors')) {
82
- obj['errors'] = _ApiClient["default"].convertToType(data['errors'], ['String']);
83
- }
84
- if (data.hasOwnProperty('submission_batch')) {
85
- obj['submission_batch'] = _SubmissionBatch["default"].constructFromObject(data['submission_batch']);
86
- }
87
- if (data.hasOwnProperty('submissions')) {
88
- obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [Object]);
89
- }
90
- if (data.hasOwnProperty('code')) {
91
- obj['code'] = _ApiClient["default"].convertToType(data['code'], 'String');
92
- }
93
- }
94
- return obj;
95
- }
96
-
97
- /**
98
- * Validates the JSON data with respect to <code>BatchGeneratePdfs201Response</code>.
99
- * @param {Object} data The plain JavaScript object bearing properties of interest.
100
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>BatchGeneratePdfs201Response</code>.
101
- */
102
- }, {
103
- key: "validateJSON",
104
- value: function validateJSON(data) {
105
- // check to make sure all required properties are present in the JSON string
106
- var _iterator = _createForOfIteratorHelper(BatchGeneratePdfs201Response.RequiredProperties),
107
- _step;
108
- try {
109
- for (_iterator.s(); !(_step = _iterator.n()).done;) {
110
- var property = _step.value;
111
- if (!data.hasOwnProperty(property)) {
112
- throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
113
- }
114
- }
115
- // ensure the json data is a string
116
- } catch (err) {
117
- _iterator.e(err);
118
- } finally {
119
- _iterator.f();
120
- }
121
- if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
122
- throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
123
- }
124
- // ensure the json data is a string
125
- if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
126
- throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
127
- }
128
- // ensure the json data is an array
129
- if (!Array.isArray(data['errors'])) {
130
- throw new Error("Expected the field `errors` to be an array in the JSON data but got " + data['errors']);
131
- }
132
- // ensure the json data is an array
133
- if (!Array.isArray(data['submissions'])) {
134
- throw new Error("Expected the field `submissions` to be an array in the JSON data but got " + data['submissions']);
135
- }
136
- // ensure the json data is a string
137
- if (data['code'] && !(typeof data['code'] === 'string' || data['code'] instanceof String)) {
138
- throw new Error("Expected the field `code` to be a primitive type in the JSON string but got " + data['code']);
139
- }
140
- return true;
141
- }
142
- }]);
143
- }();
144
- BatchGeneratePdfs201Response.RequiredProperties = ["status", "submission_batch", "submissions"];
145
-
146
- /**
147
- * @member {module:model/BatchGeneratePdfs201Response.StatusEnum} status
148
- */
149
- BatchGeneratePdfs201Response.prototype['status'] = undefined;
150
-
151
- /**
152
- * @member {String} error
153
- */
154
- BatchGeneratePdfs201Response.prototype['error'] = undefined;
155
-
156
- /**
157
- * @member {Array.<String>} errors
158
- */
159
- BatchGeneratePdfs201Response.prototype['errors'] = undefined;
160
-
161
- /**
162
- * @member {module:model/SubmissionBatch} submission_batch
163
- */
164
- BatchGeneratePdfs201Response.prototype['submission_batch'] = undefined;
165
-
166
- /**
167
- * @member {Array.<Object>} submissions
168
- */
169
- BatchGeneratePdfs201Response.prototype['submissions'] = undefined;
170
-
171
- /**
172
- * `insufficient_credits` when the response is a 402.
173
- * @member {String} code
174
- */
175
- BatchGeneratePdfs201Response.prototype['code'] = undefined;
176
-
177
- /**
178
- * Allowed values for the <code>status</code> property.
179
- * @enum {String}
180
- * @readonly
181
- */
182
- BatchGeneratePdfs201Response['StatusEnum'] = {
183
- /**
184
- * value: "success"
185
- * @const
186
- */
187
- "success": "success",
188
- /**
189
- * value: "error"
190
- * @const
191
- */
192
- "error": "error"
193
- };
194
- var _default = exports["default"] = BatchGeneratePdfs201Response;
@@ -1,313 +0,0 @@
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 _CombinedSubmissionAction = _interopRequireDefault(require("./CombinedSubmissionAction"));
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. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
21
- *
22
- * The version of the OpenAPI document: v1
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 CombinedSubmission model module.
32
- * @module model/CombinedSubmission
33
- * @version 3.3.0
34
- */
35
- var CombinedSubmission = /*#__PURE__*/function () {
36
- /**
37
- * Constructs a new <code>CombinedSubmission</code>.
38
- * @alias module:model/CombinedSubmission
39
- * @extends Object
40
- * @param id {String}
41
- * @param state {module:model/CombinedSubmission.StateEnum}
42
- * @param expired {Boolean}
43
- * @param expires_in {Number}
44
- * @param expires_at {String}
45
- * @param processed_at {String}
46
- * @param error_message {String}
47
- * @param submission_ids {Array.<String>}
48
- * @param source_pdfs {Array.<Object>}
49
- * @param metadata {Object}
50
- * @param password {String}
51
- * @param pdf_hash {String}
52
- * @param download_url {String}
53
- * @param actions {Array.<module:model/CombinedSubmissionAction>}
54
- */
55
- function CombinedSubmission(id, state, expired, expires_in, expires_at, processed_at, error_message, submission_ids, source_pdfs, metadata, password, pdf_hash, download_url, actions) {
56
- _classCallCheck(this, CombinedSubmission);
57
- CombinedSubmission.initialize(this, id, state, expired, expires_in, expires_at, processed_at, error_message, submission_ids, source_pdfs, metadata, password, pdf_hash, download_url, actions);
58
- }
59
-
60
- /**
61
- * Initializes the fields of this object.
62
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
63
- * Only for internal use.
64
- */
65
- return _createClass(CombinedSubmission, null, [{
66
- key: "initialize",
67
- value: function initialize(obj, id, state, expired, expires_in, expires_at, processed_at, error_message, submission_ids, source_pdfs, metadata, password, pdf_hash, download_url, actions) {
68
- obj['id'] = id;
69
- obj['state'] = state;
70
- obj['expired'] = expired;
71
- obj['expires_in'] = expires_in;
72
- obj['expires_at'] = expires_at;
73
- obj['processed_at'] = processed_at;
74
- obj['error_message'] = error_message;
75
- obj['submission_ids'] = submission_ids;
76
- obj['source_pdfs'] = source_pdfs;
77
- obj['metadata'] = metadata;
78
- obj['password'] = password;
79
- obj['pdf_hash'] = pdf_hash;
80
- obj['download_url'] = download_url;
81
- obj['actions'] = actions;
82
- }
83
-
84
- /**
85
- * Constructs a <code>CombinedSubmission</code> from a plain JavaScript object, optionally creating a new instance.
86
- * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
87
- * @param {Object} data The plain JavaScript object bearing properties of interest.
88
- * @param {module:model/CombinedSubmission} obj Optional instance to populate.
89
- * @return {module:model/CombinedSubmission} The populated <code>CombinedSubmission</code> instance.
90
- */
91
- }, {
92
- key: "constructFromObject",
93
- value: function constructFromObject(data, obj) {
94
- if (data) {
95
- obj = obj || new CombinedSubmission();
96
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
97
- if (data.hasOwnProperty('id')) {
98
- obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
99
- }
100
- if (data.hasOwnProperty('state')) {
101
- obj['state'] = _ApiClient["default"].convertToType(data['state'], 'String');
102
- }
103
- if (data.hasOwnProperty('expired')) {
104
- obj['expired'] = _ApiClient["default"].convertToType(data['expired'], 'Boolean');
105
- }
106
- if (data.hasOwnProperty('expires_in')) {
107
- obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
108
- }
109
- if (data.hasOwnProperty('expires_at')) {
110
- obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'String');
111
- }
112
- if (data.hasOwnProperty('processed_at')) {
113
- obj['processed_at'] = _ApiClient["default"].convertToType(data['processed_at'], 'String');
114
- }
115
- if (data.hasOwnProperty('error_message')) {
116
- obj['error_message'] = _ApiClient["default"].convertToType(data['error_message'], 'String');
117
- }
118
- if (data.hasOwnProperty('submission_ids')) {
119
- obj['submission_ids'] = _ApiClient["default"].convertToType(data['submission_ids'], ['String']);
120
- }
121
- if (data.hasOwnProperty('source_pdfs')) {
122
- obj['source_pdfs'] = _ApiClient["default"].convertToType(data['source_pdfs'], [Object]);
123
- }
124
- if (data.hasOwnProperty('metadata')) {
125
- obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
126
- }
127
- if (data.hasOwnProperty('password')) {
128
- obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
129
- }
130
- if (data.hasOwnProperty('pdf_hash')) {
131
- obj['pdf_hash'] = _ApiClient["default"].convertToType(data['pdf_hash'], 'String');
132
- }
133
- if (data.hasOwnProperty('download_url')) {
134
- obj['download_url'] = _ApiClient["default"].convertToType(data['download_url'], 'String');
135
- }
136
- if (data.hasOwnProperty('actions')) {
137
- obj['actions'] = _ApiClient["default"].convertToType(data['actions'], [_CombinedSubmissionAction["default"]]);
138
- }
139
- }
140
- return obj;
141
- }
142
-
143
- /**
144
- * Validates the JSON data with respect to <code>CombinedSubmission</code>.
145
- * @param {Object} data The plain JavaScript object bearing properties of interest.
146
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CombinedSubmission</code>.
147
- */
148
- }, {
149
- key: "validateJSON",
150
- value: function validateJSON(data) {
151
- // check to make sure all required properties are present in the JSON string
152
- var _iterator = _createForOfIteratorHelper(CombinedSubmission.RequiredProperties),
153
- _step;
154
- try {
155
- for (_iterator.s(); !(_step = _iterator.n()).done;) {
156
- var property = _step.value;
157
- if (!data.hasOwnProperty(property)) {
158
- throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
159
- }
160
- }
161
- // ensure the json data is a string
162
- } catch (err) {
163
- _iterator.e(err);
164
- } finally {
165
- _iterator.f();
166
- }
167
- if (data['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
168
- throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
169
- }
170
- // ensure the json data is a string
171
- if (data['state'] && !(typeof data['state'] === 'string' || data['state'] instanceof String)) {
172
- throw new Error("Expected the field `state` to be a primitive type in the JSON string but got " + data['state']);
173
- }
174
- // ensure the json data is a string
175
- if (data['expires_at'] && !(typeof data['expires_at'] === 'string' || data['expires_at'] instanceof String)) {
176
- throw new Error("Expected the field `expires_at` to be a primitive type in the JSON string but got " + data['expires_at']);
177
- }
178
- // ensure the json data is a string
179
- if (data['processed_at'] && !(typeof data['processed_at'] === 'string' || data['processed_at'] instanceof String)) {
180
- throw new Error("Expected the field `processed_at` to be a primitive type in the JSON string but got " + data['processed_at']);
181
- }
182
- // ensure the json data is a string
183
- if (data['error_message'] && !(typeof data['error_message'] === 'string' || data['error_message'] instanceof String)) {
184
- throw new Error("Expected the field `error_message` to be a primitive type in the JSON string but got " + data['error_message']);
185
- }
186
- // ensure the json data is an array
187
- if (!Array.isArray(data['submission_ids'])) {
188
- throw new Error("Expected the field `submission_ids` to be an array in the JSON data but got " + data['submission_ids']);
189
- }
190
- // ensure the json data is an array
191
- if (!Array.isArray(data['source_pdfs'])) {
192
- throw new Error("Expected the field `source_pdfs` to be an array in the JSON data but got " + data['source_pdfs']);
193
- }
194
- // ensure the json data is a string
195
- if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
196
- throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
197
- }
198
- // ensure the json data is a string
199
- if (data['pdf_hash'] && !(typeof data['pdf_hash'] === 'string' || data['pdf_hash'] instanceof String)) {
200
- throw new Error("Expected the field `pdf_hash` to be a primitive type in the JSON string but got " + data['pdf_hash']);
201
- }
202
- // ensure the json data is a string
203
- if (data['download_url'] && !(typeof data['download_url'] === 'string' || data['download_url'] instanceof String)) {
204
- throw new Error("Expected the field `download_url` to be a primitive type in the JSON string but got " + data['download_url']);
205
- }
206
- // ensure the json data is an array
207
- if (!Array.isArray(data['actions'])) {
208
- throw new Error("Expected the field `actions` to be an array in the JSON data but got " + data['actions']);
209
- }
210
- return true;
211
- }
212
- }]);
213
- }();
214
- CombinedSubmission.RequiredProperties = ["id", "state", "expired", "expires_in", "expires_at", "processed_at", "error_message", "submission_ids", "source_pdfs", "metadata", "password", "pdf_hash", "download_url", "actions"];
215
-
216
- /**
217
- * @member {String} id
218
- */
219
- CombinedSubmission.prototype['id'] = undefined;
220
-
221
- /**
222
- * @member {module:model/CombinedSubmission.StateEnum} state
223
- */
224
- CombinedSubmission.prototype['state'] = undefined;
225
-
226
- /**
227
- * @member {Boolean} expired
228
- */
229
- CombinedSubmission.prototype['expired'] = undefined;
230
-
231
- /**
232
- * @member {Number} expires_in
233
- */
234
- CombinedSubmission.prototype['expires_in'] = undefined;
235
-
236
- /**
237
- * @member {String} expires_at
238
- */
239
- CombinedSubmission.prototype['expires_at'] = undefined;
240
-
241
- /**
242
- * @member {String} processed_at
243
- */
244
- CombinedSubmission.prototype['processed_at'] = undefined;
245
-
246
- /**
247
- * @member {String} error_message
248
- */
249
- CombinedSubmission.prototype['error_message'] = undefined;
250
-
251
- /**
252
- * @member {Array.<String>} submission_ids
253
- */
254
- CombinedSubmission.prototype['submission_ids'] = undefined;
255
-
256
- /**
257
- * @member {Array.<Object>} source_pdfs
258
- */
259
- CombinedSubmission.prototype['source_pdfs'] = undefined;
260
-
261
- /**
262
- * @member {Object} metadata
263
- */
264
- CombinedSubmission.prototype['metadata'] = undefined;
265
-
266
- /**
267
- * @member {String} password
268
- */
269
- CombinedSubmission.prototype['password'] = undefined;
270
-
271
- /**
272
- * @member {String} pdf_hash
273
- */
274
- CombinedSubmission.prototype['pdf_hash'] = undefined;
275
-
276
- /**
277
- * @member {String} download_url
278
- */
279
- CombinedSubmission.prototype['download_url'] = undefined;
280
-
281
- /**
282
- * @member {Array.<module:model/CombinedSubmissionAction>} actions
283
- */
284
- CombinedSubmission.prototype['actions'] = undefined;
285
-
286
- /**
287
- * Allowed values for the <code>state</code> property.
288
- * @enum {String}
289
- * @readonly
290
- */
291
- CombinedSubmission['StateEnum'] = {
292
- /**
293
- * value: "pending"
294
- * @const
295
- */
296
- "pending": "pending",
297
- /**
298
- * value: "processed"
299
- * @const
300
- */
301
- "processed": "processed",
302
- /**
303
- * value: "error"
304
- * @const
305
- */
306
- "error": "error",
307
- /**
308
- * value: "insufficient_credits"
309
- * @const
310
- */
311
- "insufficient_credits": "insufficient_credits"
312
- };
313
- var _default = exports["default"] = CombinedSubmission;