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,74 @@
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 CombinedPdfSourceType.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var CombinedPdfSourceType = exports["default"] = /*#__PURE__*/function () {
33
+ function CombinedPdfSourceType() {
34
+ _classCallCheck(this, CombinedPdfSourceType);
35
+ }
36
+ return _createClass(CombinedPdfSourceType, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>CombinedPdfSourceType</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/CombinedPdfSourceType} The enum <code>CombinedPdfSourceType</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: "submission"
52
+ * @const
53
+ */
54
+ _defineProperty(CombinedPdfSourceType, "submission", "submission");
55
+ /**
56
+ * value: "combined_pdf"
57
+ * @const
58
+ */
59
+ _defineProperty(CombinedPdfSourceType, "combined_pdf", "combined_pdf");
60
+ /**
61
+ * value: "template"
62
+ * @const
63
+ */
64
+ _defineProperty(CombinedPdfSourceType, "template", "template");
65
+ /**
66
+ * value: "custom_file"
67
+ * @const
68
+ */
69
+ _defineProperty(CombinedPdfSourceType, "custom_file", "custom_file");
70
+ /**
71
+ * value: "url"
72
+ * @const
73
+ */
74
+ _defineProperty(CombinedPdfSourceType, "url", "url");
@@ -0,0 +1,74 @@
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 CombinedPdfState.
29
+ * @enum {}
30
+ * @readonly
31
+ */
32
+ var CombinedPdfState = exports["default"] = /*#__PURE__*/function () {
33
+ function CombinedPdfState() {
34
+ _classCallCheck(this, CombinedPdfState);
35
+ }
36
+ return _createClass(CombinedPdfState, null, [{
37
+ key: "constructFromObject",
38
+ value:
39
+ /**
40
+ * Returns a <code>CombinedPdfState</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/CombinedPdfState} The enum <code>CombinedPdfState</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(CombinedPdfState, "pending", "pending");
55
+ /**
56
+ * value: "processed"
57
+ * @const
58
+ */
59
+ _defineProperty(CombinedPdfState, "processed", "processed");
60
+ /**
61
+ * value: "error"
62
+ * @const
63
+ */
64
+ _defineProperty(CombinedPdfState, "error", "error");
65
+ /**
66
+ * value: "insufficient_credits"
67
+ * @const
68
+ */
69
+ _defineProperty(CombinedPdfState, "insufficient_credits", "insufficient_credits");
70
+ /**
71
+ * value: "account_suspended"
72
+ * @const
73
+ */
74
+ _defineProperty(CombinedPdfState, "account_suspended", "account_suspended");
@@ -13,9 +13,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
13
13
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
14
14
  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); } /**
15
15
  * DocSpring API
16
- * 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/).
16
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
17
17
  *
18
- * The version of the OpenAPI document: v1
18
+ * The version of the OpenAPI document: v2
19
19
  *
20
20
  *
21
21
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,18 +24,19 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
24
24
  *
25
25
  */
26
26
  /**
27
- * The CopyTemplateOptions model module.
28
- * @module model/CopyTemplateOptions
29
- * @version 3.3.0
27
+ * The CopyTemplateRequest model module.
28
+ * @module model/CopyTemplateRequest
29
+ * @version 4.0.0
30
30
  */
31
- var CopyTemplateOptions = /*#__PURE__*/function () {
31
+ var CopyTemplateRequest = /*#__PURE__*/function () {
32
32
  /**
33
- * Constructs a new <code>CopyTemplateOptions</code>.
34
- * @alias module:model/CopyTemplateOptions
33
+ * Constructs a new <code>CopyTemplateRequest</code>.
34
+ * Settings for the copy.
35
+ * @alias module:model/CopyTemplateRequest
35
36
  */
36
- function CopyTemplateOptions() {
37
- _classCallCheck(this, CopyTemplateOptions);
38
- CopyTemplateOptions.initialize(this);
37
+ function CopyTemplateRequest() {
38
+ _classCallCheck(this, CopyTemplateRequest);
39
+ CopyTemplateRequest.initialize(this);
39
40
  }
40
41
 
41
42
  /**
@@ -43,22 +44,22 @@ var CopyTemplateOptions = /*#__PURE__*/function () {
43
44
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
44
45
  * Only for internal use.
45
46
  */
46
- return _createClass(CopyTemplateOptions, null, [{
47
+ return _createClass(CopyTemplateRequest, null, [{
47
48
  key: "initialize",
48
49
  value: function initialize(obj) {}
49
50
 
50
51
  /**
51
- * Constructs a <code>CopyTemplateOptions</code> from a plain JavaScript object, optionally creating a new instance.
52
+ * Constructs a <code>CopyTemplateRequest</code> from a plain JavaScript object, optionally creating a new instance.
52
53
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
53
54
  * @param {Object} data The plain JavaScript object bearing properties of interest.
54
- * @param {module:model/CopyTemplateOptions} obj Optional instance to populate.
55
- * @return {module:model/CopyTemplateOptions} The populated <code>CopyTemplateOptions</code> instance.
55
+ * @param {module:model/CopyTemplateRequest} obj Optional instance to populate.
56
+ * @return {module:model/CopyTemplateRequest} The populated <code>CopyTemplateRequest</code> instance.
56
57
  */
57
58
  }, {
58
59
  key: "constructFromObject",
59
60
  value: function constructFromObject(data, obj) {
60
61
  if (data) {
61
- obj = obj || new CopyTemplateOptions();
62
+ obj = obj || new CopyTemplateRequest();
62
63
  if (data.hasOwnProperty('name')) {
63
64
  obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
64
65
  }
@@ -73,9 +74,9 @@ var CopyTemplateOptions = /*#__PURE__*/function () {
73
74
  }
74
75
 
75
76
  /**
76
- * Validates the JSON data with respect to <code>CopyTemplateOptions</code>.
77
+ * Validates the JSON data with respect to <code>CopyTemplateRequest</code>.
77
78
  * @param {Object} data The plain JavaScript object bearing properties of interest.
78
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CopyTemplateOptions</code>.
79
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CopyTemplateRequest</code>.
79
80
  */
80
81
  }, {
81
82
  key: "validateJSON",
@@ -97,17 +98,20 @@ var CopyTemplateOptions = /*#__PURE__*/function () {
97
98
  }]);
98
99
  }();
99
100
  /**
101
+ * Default: the template's name followed by a number, such as "Contract (2)". For a published version, the name followed by the version, such as "Contract (v1.2.0)".
100
102
  * @member {String} name
101
103
  */
102
- CopyTemplateOptions.prototype['name'] = undefined;
104
+ CopyTemplateRequest.prototype['name'] = undefined;
103
105
 
104
106
  /**
107
+ * The folder to put the copy in. Null puts it at the root. Left out, the copy goes in the template's own folder.
105
108
  * @member {String} parent_folder_id
106
109
  */
107
- CopyTemplateOptions.prototype['parent_folder_id'] = undefined;
110
+ CopyTemplateRequest.prototype['parent_folder_id'] = undefined;
108
111
 
109
112
  /**
113
+ * Copy this published version (`1.2.0`, or `1` for the latest 1.x.x) instead of the draft.
110
114
  * @member {String} version
111
115
  */
112
- CopyTemplateOptions.prototype['version'] = undefined;
113
- var _default = exports["default"] = CopyTemplateOptions;
116
+ CopyTemplateRequest.prototype['version'] = undefined;
117
+ var _default = exports["default"] = CopyTemplateRequest;
@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _CombinedPdfSourceInput = _interopRequireDefault(require("./CombinedPdfSourceInput"));
8
9
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
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); }
10
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; } } }; }
@@ -16,9 +17,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
17
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
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); } /**
18
19
  * DocSpring API
19
- * 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/).
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
21
  *
21
- * The version of the OpenAPI document: v1
22
+ * The version of the OpenAPI document: v2
22
23
  *
23
24
  *
24
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,19 +28,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
28
  *
28
29
  */
29
30
  /**
30
- * The CombinePdfsData model module.
31
- * @module model/CombinePdfsData
32
- * @version 3.3.0
31
+ * The CreateCombinedPdfRequest model module.
32
+ * @module model/CreateCombinedPdfRequest
33
+ * @version 4.0.0
33
34
  */
34
- var CombinePdfsData = /*#__PURE__*/function () {
35
+ var CreateCombinedPdfRequest = /*#__PURE__*/function () {
35
36
  /**
36
- * Constructs a new <code>CombinePdfsData</code>.
37
- * @alias module:model/CombinePdfsData
38
- * @param source_pdfs {Array.<Object>}
37
+ * Constructs a new <code>CreateCombinedPdfRequest</code>.
38
+ * The PDFs to merge, and the combined PDF's settings.
39
+ * @alias module:model/CreateCombinedPdfRequest
40
+ * @param source_pdfs {Array.<module:model/CombinedPdfSourceInput>} The PDFs to merge, in order.
39
41
  */
40
- function CombinePdfsData(source_pdfs) {
41
- _classCallCheck(this, CombinePdfsData);
42
- CombinePdfsData.initialize(this, source_pdfs);
42
+ function CreateCombinedPdfRequest(source_pdfs) {
43
+ _classCallCheck(this, CreateCombinedPdfRequest);
44
+ CreateCombinedPdfRequest.initialize(this, source_pdfs);
43
45
  }
44
46
 
45
47
  /**
@@ -47,56 +49,55 @@ var CombinePdfsData = /*#__PURE__*/function () {
47
49
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
48
50
  * Only for internal use.
49
51
  */
50
- return _createClass(CombinePdfsData, null, [{
52
+ return _createClass(CreateCombinedPdfRequest, null, [{
51
53
  key: "initialize",
52
54
  value: function initialize(obj, source_pdfs) {
53
55
  obj['source_pdfs'] = source_pdfs;
54
56
  }
55
57
 
56
58
  /**
57
- * Constructs a <code>CombinePdfsData</code> from a plain JavaScript object, optionally creating a new instance.
59
+ * Constructs a <code>CreateCombinedPdfRequest</code> from a plain JavaScript object, optionally creating a new instance.
58
60
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
59
61
  * @param {Object} data The plain JavaScript object bearing properties of interest.
60
- * @param {module:model/CombinePdfsData} obj Optional instance to populate.
61
- * @return {module:model/CombinePdfsData} The populated <code>CombinePdfsData</code> instance.
62
+ * @param {module:model/CreateCombinedPdfRequest} obj Optional instance to populate.
63
+ * @return {module:model/CreateCombinedPdfRequest} The populated <code>CreateCombinedPdfRequest</code> instance.
62
64
  */
63
65
  }, {
64
66
  key: "constructFromObject",
65
67
  value: function constructFromObject(data, obj) {
66
68
  if (data) {
67
- obj = obj || new CombinePdfsData();
68
- if (data.hasOwnProperty('delete_custom_files')) {
69
- obj['delete_custom_files'] = _ApiClient["default"].convertToType(data['delete_custom_files'], 'Boolean');
70
- }
71
- if (data.hasOwnProperty('expires_in')) {
72
- obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
69
+ obj = obj || new CreateCombinedPdfRequest();
70
+ if (data.hasOwnProperty('source_pdfs')) {
71
+ obj['source_pdfs'] = _ApiClient["default"].convertToType(data['source_pdfs'], [_CombinedPdfSourceInput["default"]]);
73
72
  }
74
73
  if (data.hasOwnProperty('metadata')) {
75
- obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
74
+ obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
75
+ 'String': Object
76
+ });
76
77
  }
77
78
  if (data.hasOwnProperty('password')) {
78
79
  obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
79
80
  }
80
- if (data.hasOwnProperty('source_pdfs')) {
81
- obj['source_pdfs'] = _ApiClient["default"].convertToType(data['source_pdfs'], [Object]);
81
+ if (data.hasOwnProperty('delete_custom_files')) {
82
+ obj['delete_custom_files'] = _ApiClient["default"].convertToType(data['delete_custom_files'], 'Boolean');
82
83
  }
83
- if (data.hasOwnProperty('test')) {
84
- obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
84
+ if (data.hasOwnProperty('expires_in')) {
85
+ obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
85
86
  }
86
87
  }
87
88
  return obj;
88
89
  }
89
90
 
90
91
  /**
91
- * Validates the JSON data with respect to <code>CombinePdfsData</code>.
92
+ * Validates the JSON data with respect to <code>CreateCombinedPdfRequest</code>.
92
93
  * @param {Object} data The plain JavaScript object bearing properties of interest.
93
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CombinePdfsData</code>.
94
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateCombinedPdfRequest</code>.
94
95
  */
95
96
  }, {
96
97
  key: "validateJSON",
97
98
  value: function validateJSON(data) {
98
99
  // check to make sure all required properties are present in the JSON string
99
- var _iterator = _createForOfIteratorHelper(CombinePdfsData.RequiredProperties),
100
+ var _iterator = _createForOfIteratorHelper(CreateCombinedPdfRequest.RequiredProperties),
100
101
  _step;
101
102
  try {
102
103
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -105,54 +106,69 @@ var CombinePdfsData = /*#__PURE__*/function () {
105
106
  throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
106
107
  }
107
108
  }
108
- // ensure the json data is a string
109
109
  } catch (err) {
110
110
  _iterator.e(err);
111
111
  } finally {
112
112
  _iterator.f();
113
113
  }
114
+ if (data['source_pdfs']) {
115
+ // data not null
116
+ // ensure the json data is an array
117
+ if (!Array.isArray(data['source_pdfs'])) {
118
+ throw new Error("Expected the field `source_pdfs` to be an array in the JSON data but got " + data['source_pdfs']);
119
+ }
120
+ // validate the optional field `source_pdfs` (array)
121
+ var _iterator2 = _createForOfIteratorHelper(data['source_pdfs']),
122
+ _step2;
123
+ try {
124
+ for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
125
+ var item = _step2.value;
126
+ _CombinedPdfSourceInput["default"].validateJSON(item);
127
+ }
128
+ } catch (err) {
129
+ _iterator2.e(err);
130
+ } finally {
131
+ _iterator2.f();
132
+ }
133
+ ;
134
+ }
135
+ // ensure the json data is a string
114
136
  if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
115
137
  throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
116
138
  }
117
- // ensure the json data is an array
118
- if (!Array.isArray(data['source_pdfs'])) {
119
- throw new Error("Expected the field `source_pdfs` to be an array in the JSON data but got " + data['source_pdfs']);
120
- }
121
139
  return true;
122
140
  }
123
141
  }]);
124
142
  }();
125
- CombinePdfsData.RequiredProperties = ["source_pdfs"];
143
+ CreateCombinedPdfRequest.RequiredProperties = ["source_pdfs"];
126
144
 
127
145
  /**
128
- * Delete the custom files in source_pdfs once the combined PDF has been processed (they're kept if it fails). Other combined submissions can't use them after that. A test API token can't delete custom files.
129
- * @member {Boolean} delete_custom_files
146
+ * The PDFs to merge, in order.
147
+ * @member {Array.<module:model/CombinedPdfSourceInput>} source_pdfs
130
148
  */
131
- CombinePdfsData.prototype['delete_custom_files'] = undefined;
149
+ CreateCombinedPdfRequest.prototype['source_pdfs'] = undefined;
132
150
 
133
151
  /**
134
- * @member {Number} expires_in
152
+ * Your own data about the combined PDF, such as an ID from your app.
153
+ * @member {Object.<String, Object>} metadata
135
154
  */
136
- CombinePdfsData.prototype['expires_in'] = undefined;
137
-
138
- /**
139
- * @member {Object} metadata
140
- */
141
- CombinePdfsData.prototype['metadata'] = undefined;
155
+ CreateCombinedPdfRequest.prototype['metadata'] = undefined;
142
156
 
143
157
  /**
158
+ * A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
144
159
  * @member {String} password
145
160
  */
146
- CombinePdfsData.prototype['password'] = undefined;
161
+ CreateCombinedPdfRequest.prototype['password'] = undefined;
147
162
 
148
163
  /**
149
- * @member {Array.<Object>} source_pdfs
164
+ * Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files.
165
+ * @member {Boolean} delete_custom_files
150
166
  */
151
- CombinePdfsData.prototype['source_pdfs'] = undefined;
167
+ CreateCombinedPdfRequest.prototype['delete_custom_files'] = undefined;
152
168
 
153
169
  /**
154
- * Deprecated, and has no effect. Combining always uses credits, even with a test API token or watermarked source PDFs.
155
- * @member {Boolean} test
170
+ * Seconds after the PDF is generated until the combined PDF expires, up to 10 years (315360000). One that fails is kept for at least 48 hours. Without it, the combined PDF is kept until you delete it.
171
+ * @member {Number} expires_in
156
172
  */
157
- CombinePdfsData.prototype['test'] = undefined;
158
- var _default = exports["default"] = CombinePdfsData;
173
+ CreateCombinedPdfRequest.prototype['expires_in'] = undefined;
174
+ var _default = exports["default"] = CreateCombinedPdfRequest;
@@ -16,9 +16,9 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
16
16
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
17
17
  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); } /**
18
18
  * DocSpring API
19
- * 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/).
19
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
20
20
  *
21
- * The version of the OpenAPI document: v1
21
+ * The version of the OpenAPI document: v2
22
22
  *
23
23
  *
24
24
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,19 +27,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
27
  *
28
28
  */
29
29
  /**
30
- * The CreateCustomFileData model module.
31
- * @module model/CreateCustomFileData
32
- * @version 3.3.0
30
+ * The CreateCustomFileFromUploadRequest model module.
31
+ * @module model/CreateCustomFileFromUploadRequest
32
+ * @version 4.0.0
33
33
  */
34
- var CreateCustomFileData = /*#__PURE__*/function () {
34
+ var CreateCustomFileFromUploadRequest = /*#__PURE__*/function () {
35
35
  /**
36
- * Constructs a new <code>CreateCustomFileData</code>.
37
- * @alias module:model/CreateCustomFileData
38
- * @param cache_id {String}
36
+ * Constructs a new <code>CreateCustomFileFromUploadRequest</code>.
37
+ * The uploaded file to create the custom file from.
38
+ * @alias module:model/CreateCustomFileFromUploadRequest
39
+ * @param cache_id {String} The `fields.key` from GET /uploads/presign, after you upload the file to its URL.
39
40
  */
40
- function CreateCustomFileData(cache_id) {
41
- _classCallCheck(this, CreateCustomFileData);
42
- CreateCustomFileData.initialize(this, cache_id);
41
+ function CreateCustomFileFromUploadRequest(cache_id) {
42
+ _classCallCheck(this, CreateCustomFileFromUploadRequest);
43
+ CreateCustomFileFromUploadRequest.initialize(this, cache_id);
43
44
  }
44
45
 
45
46
  /**
@@ -47,24 +48,24 @@ var CreateCustomFileData = /*#__PURE__*/function () {
47
48
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
48
49
  * Only for internal use.
49
50
  */
50
- return _createClass(CreateCustomFileData, null, [{
51
+ return _createClass(CreateCustomFileFromUploadRequest, null, [{
51
52
  key: "initialize",
52
53
  value: function initialize(obj, cache_id) {
53
54
  obj['cache_id'] = cache_id;
54
55
  }
55
56
 
56
57
  /**
57
- * Constructs a <code>CreateCustomFileData</code> from a plain JavaScript object, optionally creating a new instance.
58
+ * Constructs a <code>CreateCustomFileFromUploadRequest</code> from a plain JavaScript object, optionally creating a new instance.
58
59
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
59
60
  * @param {Object} data The plain JavaScript object bearing properties of interest.
60
- * @param {module:model/CreateCustomFileData} obj Optional instance to populate.
61
- * @return {module:model/CreateCustomFileData} The populated <code>CreateCustomFileData</code> instance.
61
+ * @param {module:model/CreateCustomFileFromUploadRequest} obj Optional instance to populate.
62
+ * @return {module:model/CreateCustomFileFromUploadRequest} The populated <code>CreateCustomFileFromUploadRequest</code> instance.
62
63
  */
63
64
  }, {
64
65
  key: "constructFromObject",
65
66
  value: function constructFromObject(data, obj) {
66
67
  if (data) {
67
- obj = obj || new CreateCustomFileData();
68
+ obj = obj || new CreateCustomFileFromUploadRequest();
68
69
  if (data.hasOwnProperty('cache_id')) {
69
70
  obj['cache_id'] = _ApiClient["default"].convertToType(data['cache_id'], 'String');
70
71
  }
@@ -73,15 +74,15 @@ var CreateCustomFileData = /*#__PURE__*/function () {
73
74
  }
74
75
 
75
76
  /**
76
- * Validates the JSON data with respect to <code>CreateCustomFileData</code>.
77
+ * Validates the JSON data with respect to <code>CreateCustomFileFromUploadRequest</code>.
77
78
  * @param {Object} data The plain JavaScript object bearing properties of interest.
78
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateCustomFileData</code>.
79
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateCustomFileFromUploadRequest</code>.
79
80
  */
80
81
  }, {
81
82
  key: "validateJSON",
82
83
  value: function validateJSON(data) {
83
84
  // check to make sure all required properties are present in the JSON string
84
- var _iterator = _createForOfIteratorHelper(CreateCustomFileData.RequiredProperties),
85
+ var _iterator = _createForOfIteratorHelper(CreateCustomFileFromUploadRequest.RequiredProperties),
85
86
  _step;
86
87
  try {
87
88
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -103,10 +104,11 @@ var CreateCustomFileData = /*#__PURE__*/function () {
103
104
  }
104
105
  }]);
105
106
  }();
106
- CreateCustomFileData.RequiredProperties = ["cache_id"];
107
+ CreateCustomFileFromUploadRequest.RequiredProperties = ["cache_id"];
107
108
 
108
109
  /**
110
+ * The `fields.key` from GET /uploads/presign, after you upload the file to its URL.
109
111
  * @member {String} cache_id
110
112
  */
111
- CreateCustomFileData.prototype['cache_id'] = undefined;
112
- var _default = exports["default"] = CreateCustomFileData;
113
+ CreateCustomFileFromUploadRequest.prototype['cache_id'] = undefined;
114
+ var _default = exports["default"] = CreateCustomFileFromUploadRequest;