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
@@ -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 _CombinedPdfSourceType = _interopRequireDefault(require("./CombinedPdfSourceType"));
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; } } }; }
@@ -18,7 +19,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
18
19
  * DocSpring API
19
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,23 +28,20 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
28
  *
28
29
  */
29
30
  /**
30
- * The SubmissionDataRequestToken model module.
31
- * @module model/SubmissionDataRequestToken
32
- * @version 3.2.0
31
+ * The CombinedPdfSource model module.
32
+ * @module model/CombinedPdfSource
33
+ * @version 4.0.0
33
34
  */
34
- var SubmissionDataRequestToken = /*#__PURE__*/function () {
35
+ var CombinedPdfSource = /*#__PURE__*/function () {
35
36
  /**
36
- * Constructs a new <code>SubmissionDataRequestToken</code>.
37
- * @alias module:model/SubmissionDataRequestToken
38
- * @extends Object
39
- * @param id {String}
40
- * @param secret {String}
41
- * @param expires_at {String}
42
- * @param data_request_url {String}
37
+ * Constructs a new <code>CombinedPdfSource</code>.
38
+ * A PDF to merge.
39
+ * @alias module:model/CombinedPdfSource
40
+ * @param type {module:model/CombinedPdfSourceType} What the PDF is: a submission's PDF, another combined PDF, a template's PDF, a custom file (POST /custom_files) or a PDF to download from a URL.
43
41
  */
44
- function SubmissionDataRequestToken(id, secret, expires_at, data_request_url) {
45
- _classCallCheck(this, SubmissionDataRequestToken);
46
- SubmissionDataRequestToken.initialize(this, id, secret, expires_at, data_request_url);
42
+ function CombinedPdfSource(type) {
43
+ _classCallCheck(this, CombinedPdfSource);
44
+ CombinedPdfSource.initialize(this, type);
47
45
  }
48
46
 
49
47
  /**
@@ -51,54 +49,53 @@ var SubmissionDataRequestToken = /*#__PURE__*/function () {
51
49
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
52
50
  * Only for internal use.
53
51
  */
54
- return _createClass(SubmissionDataRequestToken, null, [{
52
+ return _createClass(CombinedPdfSource, null, [{
55
53
  key: "initialize",
56
- value: function initialize(obj, id, secret, expires_at, data_request_url) {
57
- obj['id'] = id;
58
- obj['secret'] = secret;
59
- obj['expires_at'] = expires_at;
60
- obj['data_request_url'] = data_request_url;
54
+ value: function initialize(obj, type) {
55
+ obj['type'] = type;
61
56
  }
62
57
 
63
58
  /**
64
- * Constructs a <code>SubmissionDataRequestToken</code> from a plain JavaScript object, optionally creating a new instance.
59
+ * Constructs a <code>CombinedPdfSource</code> from a plain JavaScript object, optionally creating a new instance.
65
60
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
66
61
  * @param {Object} data The plain JavaScript object bearing properties of interest.
67
- * @param {module:model/SubmissionDataRequestToken} obj Optional instance to populate.
68
- * @return {module:model/SubmissionDataRequestToken} The populated <code>SubmissionDataRequestToken</code> instance.
62
+ * @param {module:model/CombinedPdfSource} obj Optional instance to populate.
63
+ * @return {module:model/CombinedPdfSource} The populated <code>CombinedPdfSource</code> instance.
69
64
  */
70
65
  }, {
71
66
  key: "constructFromObject",
72
67
  value: function constructFromObject(data, obj) {
73
68
  if (data) {
74
- obj = obj || new SubmissionDataRequestToken();
75
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
69
+ obj = obj || new CombinedPdfSource();
70
+ if (data.hasOwnProperty('type')) {
71
+ obj['type'] = _ApiClient["default"].convertToType(data['type'], _CombinedPdfSourceType["default"]);
72
+ }
76
73
  if (data.hasOwnProperty('id')) {
77
74
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
78
75
  }
79
- if (data.hasOwnProperty('secret')) {
80
- obj['secret'] = _ApiClient["default"].convertToType(data['secret'], 'String');
76
+ if (data.hasOwnProperty('url')) {
77
+ obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
81
78
  }
82
- if (data.hasOwnProperty('expires_at')) {
83
- obj['expires_at'] = _ApiClient["default"].convertToType(data['expires_at'], 'String');
79
+ if (data.hasOwnProperty('template_version')) {
80
+ obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
84
81
  }
85
- if (data.hasOwnProperty('data_request_url')) {
86
- obj['data_request_url'] = _ApiClient["default"].convertToType(data['data_request_url'], 'String');
82
+ if (data.hasOwnProperty('processed')) {
83
+ obj['processed'] = _ApiClient["default"].convertToType(data['processed'], 'Boolean');
87
84
  }
88
85
  }
89
86
  return obj;
90
87
  }
91
88
 
92
89
  /**
93
- * Validates the JSON data with respect to <code>SubmissionDataRequestToken</code>.
90
+ * Validates the JSON data with respect to <code>CombinedPdfSource</code>.
94
91
  * @param {Object} data The plain JavaScript object bearing properties of interest.
95
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SubmissionDataRequestToken</code>.
92
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CombinedPdfSource</code>.
96
93
  */
97
94
  }, {
98
95
  key: "validateJSON",
99
96
  value: function validateJSON(data) {
100
97
  // check to make sure all required properties are present in the JSON string
101
- var _iterator = _createForOfIteratorHelper(SubmissionDataRequestToken.RequiredProperties),
98
+ var _iterator = _createForOfIteratorHelper(CombinedPdfSource.RequiredProperties),
102
99
  _step;
103
100
  try {
104
101
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -117,40 +114,46 @@ var SubmissionDataRequestToken = /*#__PURE__*/function () {
117
114
  throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
118
115
  }
119
116
  // ensure the json data is a string
120
- if (data['secret'] && !(typeof data['secret'] === 'string' || data['secret'] instanceof String)) {
121
- throw new Error("Expected the field `secret` to be a primitive type in the JSON string but got " + data['secret']);
122
- }
123
- // ensure the json data is a string
124
- if (data['expires_at'] && !(typeof data['expires_at'] === 'string' || data['expires_at'] instanceof String)) {
125
- throw new Error("Expected the field `expires_at` to be a primitive type in the JSON string but got " + data['expires_at']);
117
+ if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
118
+ throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
126
119
  }
127
120
  // ensure the json data is a string
128
- if (data['data_request_url'] && !(typeof data['data_request_url'] === 'string' || data['data_request_url'] instanceof String)) {
129
- throw new Error("Expected the field `data_request_url` to be a primitive type in the JSON string but got " + data['data_request_url']);
121
+ if (data['template_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
122
+ throw new Error("Expected the field `template_version` to be a primitive type in the JSON string but got " + data['template_version']);
130
123
  }
131
124
  return true;
132
125
  }
133
126
  }]);
134
127
  }();
135
- SubmissionDataRequestToken.RequiredProperties = ["id", "secret", "expires_at", "data_request_url"];
128
+ CombinedPdfSource.RequiredProperties = ["type"];
129
+
130
+ /**
131
+ * What the PDF is: a submission's PDF, another combined PDF, a template's PDF, a custom file (POST /custom_files) or a PDF to download from a URL.
132
+ * @member {module:model/CombinedPdfSourceType} type
133
+ */
134
+ CombinedPdfSource.prototype['type'] = undefined;
136
135
 
137
136
  /**
137
+ * The ID of the submission, combined PDF, template or custom file.
138
138
  * @member {String} id
139
139
  */
140
- SubmissionDataRequestToken.prototype['id'] = undefined;
140
+ CombinedPdfSource.prototype['id'] = undefined;
141
141
 
142
142
  /**
143
- * @member {String} secret
143
+ * For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired.
144
+ * @member {String} url
144
145
  */
145
- SubmissionDataRequestToken.prototype['secret'] = undefined;
146
+ CombinedPdfSource.prototype['url'] = undefined;
146
147
 
147
148
  /**
148
- * @member {String} expires_at
149
+ * For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published).
150
+ * @member {String} template_version
149
151
  */
150
- SubmissionDataRequestToken.prototype['expires_at'] = undefined;
152
+ CombinedPdfSource.prototype['template_version'] = undefined;
151
153
 
152
154
  /**
153
- * @member {String} data_request_url
155
+ * For a `template` source: true (the default) merges the template's processed PDF, which is the PDF submissions are filled in on (decrypted, with its form fields removed). false merges the PDF as it was uploaded.
156
+ * @member {Boolean} processed
154
157
  */
155
- SubmissionDataRequestToken.prototype['data_request_url'] = undefined;
156
- var _default = exports["default"] = SubmissionDataRequestToken;
158
+ CombinedPdfSource.prototype['processed'] = undefined;
159
+ var _default = exports["default"] = CombinedPdfSource;
@@ -0,0 +1,270 @@
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 _CombinedPdfSourcePdf = _interopRequireDefault(require("./CombinedPdfSourcePdf"));
9
+ var _CustomFileSourcePdf = _interopRequireDefault(require("./CustomFileSourcePdf"));
10
+ var _SubmissionSourcePdf = _interopRequireDefault(require("./SubmissionSourcePdf"));
11
+ var _TemplateSourcePdf = _interopRequireDefault(require("./TemplateSourcePdf"));
12
+ var _UrlSourcePdf = _interopRequireDefault(require("./UrlSourcePdf"));
13
+ var _CombinedPdfSourceInput;
14
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
15
+ 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); }
16
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
17
+ 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); } }
18
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
19
+ 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; }
20
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
21
+ 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); } /**
22
+ * DocSpring API
23
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
24
+ *
25
+ * The version of the OpenAPI document: v2
26
+ *
27
+ *
28
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
29
+ * https://openapi-generator.tech
30
+ * Do not edit the class manually.
31
+ *
32
+ */
33
+ /**
34
+ * The CombinedPdfSourceInput model module.
35
+ * @module model/CombinedPdfSourceInput
36
+ * @version 4.0.0
37
+ */
38
+ var CombinedPdfSourceInput = /*#__PURE__*/function () {
39
+ /**
40
+ * Constructs a new <code>CombinedPdfSourceInput</code>.
41
+ * A PDF to merge.
42
+ * @alias module:model/CombinedPdfSourceInput
43
+ * @param {(module:model/CombinedPdfSourcePdf|module:model/CustomFileSourcePdf|module:model/SubmissionSourcePdf|module:model/TemplateSourcePdf|module:model/UrlSourcePdf)} instance The actual instance to initialize CombinedPdfSourceInput.
44
+ */
45
+ function CombinedPdfSourceInput() {
46
+ var instance = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
47
+ _classCallCheck(this, CombinedPdfSourceInput);
48
+ /**
49
+ * Returns the JSON representation of the actual instance.
50
+ * @return {string}
51
+ */
52
+ _defineProperty(this, "toJSON", function () {
53
+ return this.getActualInstance();
54
+ });
55
+ if (instance === null) {
56
+ this.actualInstance = null;
57
+ return;
58
+ }
59
+ var match = 0;
60
+ var errorMessages = [];
61
+ // if discriminator exists, use it.
62
+ if (instance && _typeof(instance) === 'object' && instance['type'] !== undefined) {
63
+ var discriminatorValue = instance['type'];
64
+ switch (discriminatorValue) {
65
+ case 'combined_pdf':
66
+ try {
67
+ _CombinedPdfSourcePdf["default"].validateJSON(instance);
68
+ this.actualInstance = _CombinedPdfSourcePdf["default"].constructFromObject(instance);
69
+ return;
70
+ } catch (err) {
71
+ throw new Error("Failed to construct CombinedPdfSourcePdf using discriminator value 'combined_pdf': " + err);
72
+ }
73
+ case 'custom_file':
74
+ try {
75
+ _CustomFileSourcePdf["default"].validateJSON(instance);
76
+ this.actualInstance = _CustomFileSourcePdf["default"].constructFromObject(instance);
77
+ return;
78
+ } catch (err) {
79
+ throw new Error("Failed to construct CustomFileSourcePdf using discriminator value 'custom_file': " + err);
80
+ }
81
+ case 'submission':
82
+ try {
83
+ _SubmissionSourcePdf["default"].validateJSON(instance);
84
+ this.actualInstance = _SubmissionSourcePdf["default"].constructFromObject(instance);
85
+ return;
86
+ } catch (err) {
87
+ throw new Error("Failed to construct SubmissionSourcePdf using discriminator value 'submission': " + err);
88
+ }
89
+ case 'template':
90
+ try {
91
+ _TemplateSourcePdf["default"].validateJSON(instance);
92
+ this.actualInstance = _TemplateSourcePdf["default"].constructFromObject(instance);
93
+ return;
94
+ } catch (err) {
95
+ throw new Error("Failed to construct TemplateSourcePdf using discriminator value 'template': " + err);
96
+ }
97
+ case 'url':
98
+ try {
99
+ _UrlSourcePdf["default"].validateJSON(instance);
100
+ this.actualInstance = _UrlSourcePdf["default"].constructFromObject(instance);
101
+ return;
102
+ } catch (err) {
103
+ throw new Error("Failed to construct UrlSourcePdf using discriminator value 'url': " + err);
104
+ }
105
+ default:
106
+ throw new Error("Unrecognized discriminator value '" + discriminatorValue + "' constructing `CombinedPdfSourceInput`. Expected one of: combined_pdf, custom_file, submission, template, url.");
107
+ }
108
+ }
109
+ // else try to construct using oneOf
110
+
111
+ try {
112
+ if (instance instanceof _SubmissionSourcePdf["default"]) {
113
+ this.actualInstance = instance;
114
+ } else {
115
+ // plain JS object
116
+ // validate the object
117
+ _SubmissionSourcePdf["default"].validateJSON(instance); // throw an exception if no match
118
+ // create SubmissionSourcePdf from JS object
119
+ this.actualInstance = _SubmissionSourcePdf["default"].constructFromObject(instance);
120
+ }
121
+ match++;
122
+ } catch (err) {
123
+ // json data failed to deserialize into SubmissionSourcePdf
124
+ errorMessages.push("Failed to construct SubmissionSourcePdf: " + err);
125
+ }
126
+ try {
127
+ if (instance instanceof _CombinedPdfSourcePdf["default"]) {
128
+ this.actualInstance = instance;
129
+ } else {
130
+ // plain JS object
131
+ // validate the object
132
+ _CombinedPdfSourcePdf["default"].validateJSON(instance); // throw an exception if no match
133
+ // create CombinedPdfSourcePdf from JS object
134
+ this.actualInstance = _CombinedPdfSourcePdf["default"].constructFromObject(instance);
135
+ }
136
+ match++;
137
+ } catch (err) {
138
+ // json data failed to deserialize into CombinedPdfSourcePdf
139
+ errorMessages.push("Failed to construct CombinedPdfSourcePdf: " + err);
140
+ }
141
+ try {
142
+ if (instance instanceof _TemplateSourcePdf["default"]) {
143
+ this.actualInstance = instance;
144
+ } else {
145
+ // plain JS object
146
+ // validate the object
147
+ _TemplateSourcePdf["default"].validateJSON(instance); // throw an exception if no match
148
+ // create TemplateSourcePdf from JS object
149
+ this.actualInstance = _TemplateSourcePdf["default"].constructFromObject(instance);
150
+ }
151
+ match++;
152
+ } catch (err) {
153
+ // json data failed to deserialize into TemplateSourcePdf
154
+ errorMessages.push("Failed to construct TemplateSourcePdf: " + err);
155
+ }
156
+ try {
157
+ if (instance instanceof _CustomFileSourcePdf["default"]) {
158
+ this.actualInstance = instance;
159
+ } else {
160
+ // plain JS object
161
+ // validate the object
162
+ _CustomFileSourcePdf["default"].validateJSON(instance); // throw an exception if no match
163
+ // create CustomFileSourcePdf from JS object
164
+ this.actualInstance = _CustomFileSourcePdf["default"].constructFromObject(instance);
165
+ }
166
+ match++;
167
+ } catch (err) {
168
+ // json data failed to deserialize into CustomFileSourcePdf
169
+ errorMessages.push("Failed to construct CustomFileSourcePdf: " + err);
170
+ }
171
+ try {
172
+ if (instance instanceof _UrlSourcePdf["default"]) {
173
+ this.actualInstance = instance;
174
+ } else {
175
+ // plain JS object
176
+ // validate the object
177
+ _UrlSourcePdf["default"].validateJSON(instance); // throw an exception if no match
178
+ // create UrlSourcePdf from JS object
179
+ this.actualInstance = _UrlSourcePdf["default"].constructFromObject(instance);
180
+ }
181
+ match++;
182
+ } catch (err) {
183
+ // json data failed to deserialize into UrlSourcePdf
184
+ errorMessages.push("Failed to construct UrlSourcePdf: " + err);
185
+ }
186
+ if (match > 1) {
187
+ throw new Error("Multiple matches found constructing `CombinedPdfSourceInput` with oneOf schemas CombinedPdfSourcePdf, CustomFileSourcePdf, SubmissionSourcePdf, TemplateSourcePdf, UrlSourcePdf. Input: " + JSON.stringify(instance));
188
+ } else if (match === 0) {
189
+ this.actualInstance = null; // clear the actual instance in case there are multiple matches
190
+ throw new Error("No match found constructing `CombinedPdfSourceInput` with oneOf schemas CombinedPdfSourcePdf, CustomFileSourcePdf, SubmissionSourcePdf, TemplateSourcePdf, UrlSourcePdf. Details: " + errorMessages.join(", "));
191
+ } else {// only 1 match
192
+ // the input is valid
193
+ }
194
+ }
195
+
196
+ /**
197
+ * Constructs a <code>CombinedPdfSourceInput</code> from a plain JavaScript object, optionally creating a new instance.
198
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
199
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
200
+ * @param {module:model/CombinedPdfSourceInput} obj Optional instance to populate.
201
+ * @return {module:model/CombinedPdfSourceInput} The populated <code>CombinedPdfSourceInput</code> instance.
202
+ */
203
+ return _createClass(CombinedPdfSourceInput, [{
204
+ key: "getActualInstance",
205
+ value:
206
+ /**
207
+ * Gets the actual instance, which can be <code>CombinedPdfSourcePdf</code>, <code>CustomFileSourcePdf</code>, <code>SubmissionSourcePdf</code>, <code>TemplateSourcePdf</code>, <code>UrlSourcePdf</code>.
208
+ * @return {(module:model/CombinedPdfSourcePdf|module:model/CustomFileSourcePdf|module:model/SubmissionSourcePdf|module:model/TemplateSourcePdf|module:model/UrlSourcePdf)} The actual instance.
209
+ */
210
+ function getActualInstance() {
211
+ return this.actualInstance;
212
+ }
213
+
214
+ /**
215
+ * Sets the actual instance, which can be <code>CombinedPdfSourcePdf</code>, <code>CustomFileSourcePdf</code>, <code>SubmissionSourcePdf</code>, <code>TemplateSourcePdf</code>, <code>UrlSourcePdf</code>.
216
+ * @param {(module:model/CombinedPdfSourcePdf|module:model/CustomFileSourcePdf|module:model/SubmissionSourcePdf|module:model/TemplateSourcePdf|module:model/UrlSourcePdf)} obj The actual instance.
217
+ */
218
+ }, {
219
+ key: "setActualInstance",
220
+ value: function setActualInstance(obj) {
221
+ this.actualInstance = CombinedPdfSourceInput.constructFromObject(obj).getActualInstance();
222
+ }
223
+ }], [{
224
+ key: "constructFromObject",
225
+ value: function constructFromObject(data, obj) {
226
+ return new CombinedPdfSourceInput(data);
227
+ }
228
+ }]);
229
+ }();
230
+ /**
231
+ * Must be `url`.
232
+ * @member {String} type
233
+ * @default 'url'
234
+ */
235
+ _CombinedPdfSourceInput = CombinedPdfSourceInput;
236
+ /**
237
+ * Create an instance of CombinedPdfSourceInput from a JSON string.
238
+ * @param {string} json_string JSON string.
239
+ * @return {module:model/CombinedPdfSourceInput} An instance of CombinedPdfSourceInput.
240
+ */
241
+ _defineProperty(CombinedPdfSourceInput, "fromJSON", function (json_string) {
242
+ return _CombinedPdfSourceInput.constructFromObject(JSON.parse(json_string));
243
+ });
244
+ CombinedPdfSourceInput.prototype['type'] = 'url';
245
+
246
+ /**
247
+ * The ID of the submission, combined PDF, template or custom file.
248
+ * @member {String} id
249
+ */
250
+ CombinedPdfSourceInput.prototype['id'] = undefined;
251
+
252
+ /**
253
+ * For a `template` source, the version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published).
254
+ * @member {String} template_version
255
+ */
256
+ CombinedPdfSourceInput.prototype['template_version'] = undefined;
257
+
258
+ /**
259
+ * For a `template` source: true (the default) merges the template's processed PDF, which is the PDF submissions are filled in on (decrypted, with its form fields removed). false merges the PDF as it was uploaded.
260
+ * @member {Boolean} processed
261
+ */
262
+ CombinedPdfSourceInput.prototype['processed'] = undefined;
263
+
264
+ /**
265
+ * For a `url` source, the URL to download the PDF from. Removed once the combined PDF has expired.
266
+ * @member {String} url
267
+ */
268
+ CombinedPdfSourceInput.prototype['url'] = undefined;
269
+ CombinedPdfSourceInput.OneOf = ["CombinedPdfSourcePdf", "CustomFileSourcePdf", "SubmissionSourcePdf", "TemplateSourcePdf", "UrlSourcePdf"];
270
+ var _default = exports["default"] = CombinedPdfSourceInput;
@@ -18,7 +18,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
18
18
  * DocSpring API
19
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,20 +27,21 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
27
27
  *
28
28
  */
29
29
  /**
30
- * The SuccessErrorResponse model module.
31
- * @module model/SuccessErrorResponse
32
- * @version 3.2.0
30
+ * The CombinedPdfSourcePdf model module.
31
+ * @module model/CombinedPdfSourcePdf
32
+ * @version 4.0.0
33
33
  */
34
- var SuccessErrorResponse = /*#__PURE__*/function () {
34
+ var CombinedPdfSourcePdf = /*#__PURE__*/function () {
35
35
  /**
36
- * Constructs a new <code>SuccessErrorResponse</code>.
37
- * @alias module:model/SuccessErrorResponse
38
- * @extends Object
39
- * @param status {module:model/SuccessErrorResponse.StatusEnum}
36
+ * Constructs a new <code>CombinedPdfSourcePdf</code>.
37
+ * Another combined PDF to merge.
38
+ * @alias module:model/CombinedPdfSourcePdf
39
+ * @param type {String} Must be `combined_pdf`.
40
+ * @param id {String} The ID of the submission, combined PDF, template or custom file.
40
41
  */
41
- function SuccessErrorResponse(status) {
42
- _classCallCheck(this, SuccessErrorResponse);
43
- SuccessErrorResponse.initialize(this, status);
42
+ function CombinedPdfSourcePdf(type, id) {
43
+ _classCallCheck(this, CombinedPdfSourcePdf);
44
+ CombinedPdfSourcePdf.initialize(this, type, id);
44
45
  }
45
46
 
46
47
  /**
@@ -48,45 +49,45 @@ var SuccessErrorResponse = /*#__PURE__*/function () {
48
49
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
49
50
  * Only for internal use.
50
51
  */
51
- return _createClass(SuccessErrorResponse, null, [{
52
+ return _createClass(CombinedPdfSourcePdf, null, [{
52
53
  key: "initialize",
53
- value: function initialize(obj, status) {
54
- obj['status'] = status;
54
+ value: function initialize(obj, type, id) {
55
+ obj['type'] = type || 'combined_pdf';
56
+ obj['id'] = id;
55
57
  }
56
58
 
57
59
  /**
58
- * Constructs a <code>SuccessErrorResponse</code> from a plain JavaScript object, optionally creating a new instance.
60
+ * Constructs a <code>CombinedPdfSourcePdf</code> from a plain JavaScript object, optionally creating a new instance.
59
61
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
60
62
  * @param {Object} data The plain JavaScript object bearing properties of interest.
61
- * @param {module:model/SuccessErrorResponse} obj Optional instance to populate.
62
- * @return {module:model/SuccessErrorResponse} The populated <code>SuccessErrorResponse</code> instance.
63
+ * @param {module:model/CombinedPdfSourcePdf} obj Optional instance to populate.
64
+ * @return {module:model/CombinedPdfSourcePdf} The populated <code>CombinedPdfSourcePdf</code> instance.
63
65
  */
64
66
  }, {
65
67
  key: "constructFromObject",
66
68
  value: function constructFromObject(data, obj) {
67
69
  if (data) {
68
- obj = obj || new SuccessErrorResponse();
69
- _ApiClient["default"].constructFromObject(data, obj, 'Object');
70
- if (data.hasOwnProperty('status')) {
71
- obj['status'] = _ApiClient["default"].convertToType(data['status'], 'String');
70
+ obj = obj || new CombinedPdfSourcePdf();
71
+ if (data.hasOwnProperty('type')) {
72
+ obj['type'] = _ApiClient["default"].convertToType(data['type'], 'String');
72
73
  }
73
- if (data.hasOwnProperty('error')) {
74
- obj['error'] = _ApiClient["default"].convertToType(data['error'], 'String');
74
+ if (data.hasOwnProperty('id')) {
75
+ obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
75
76
  }
76
77
  }
77
78
  return obj;
78
79
  }
79
80
 
80
81
  /**
81
- * Validates the JSON data with respect to <code>SuccessErrorResponse</code>.
82
+ * Validates the JSON data with respect to <code>CombinedPdfSourcePdf</code>.
82
83
  * @param {Object} data The plain JavaScript object bearing properties of interest.
83
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>SuccessErrorResponse</code>.
84
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CombinedPdfSourcePdf</code>.
84
85
  */
85
86
  }, {
86
87
  key: "validateJSON",
87
88
  value: function validateJSON(data) {
88
89
  // check to make sure all required properties are present in the JSON string
89
- var _iterator = _createForOfIteratorHelper(SuccessErrorResponse.RequiredProperties),
90
+ var _iterator = _createForOfIteratorHelper(CombinedPdfSourcePdf.RequiredProperties),
90
91
  _step;
91
92
  try {
92
93
  for (_iterator.s(); !(_step = _iterator.n()).done;) {
@@ -101,44 +102,29 @@ var SuccessErrorResponse = /*#__PURE__*/function () {
101
102
  } finally {
102
103
  _iterator.f();
103
104
  }
104
- if (data['status'] && !(typeof data['status'] === 'string' || data['status'] instanceof String)) {
105
- throw new Error("Expected the field `status` to be a primitive type in the JSON string but got " + data['status']);
105
+ if (data['type'] && !(typeof data['type'] === 'string' || data['type'] instanceof String)) {
106
+ throw new Error("Expected the field `type` to be a primitive type in the JSON string but got " + data['type']);
106
107
  }
107
108
  // ensure the json data is a string
108
- if (data['error'] && !(typeof data['error'] === 'string' || data['error'] instanceof String)) {
109
- throw new Error("Expected the field `error` to be a primitive type in the JSON string but got " + data['error']);
109
+ if (data['id'] && !(typeof data['id'] === 'string' || data['id'] instanceof String)) {
110
+ throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
110
111
  }
111
112
  return true;
112
113
  }
113
114
  }]);
114
115
  }();
115
- SuccessErrorResponse.RequiredProperties = ["status"];
116
+ CombinedPdfSourcePdf.RequiredProperties = ["type", "id"];
116
117
 
117
118
  /**
118
- * @member {module:model/SuccessErrorResponse.StatusEnum} status
119
+ * Must be `combined_pdf`.
120
+ * @member {String} type
121
+ * @default 'combined_pdf'
119
122
  */
120
- SuccessErrorResponse.prototype['status'] = undefined;
123
+ CombinedPdfSourcePdf.prototype['type'] = 'combined_pdf';
121
124
 
122
125
  /**
123
- * @member {String} error
126
+ * The ID of the submission, combined PDF, template or custom file.
127
+ * @member {String} id
124
128
  */
125
- SuccessErrorResponse.prototype['error'] = undefined;
126
-
127
- /**
128
- * Allowed values for the <code>status</code> property.
129
- * @enum {String}
130
- * @readonly
131
- */
132
- SuccessErrorResponse['StatusEnum'] = {
133
- /**
134
- * value: "success"
135
- * @const
136
- */
137
- "success": "success",
138
- /**
139
- * value: "error"
140
- * @const
141
- */
142
- "error": "error"
143
- };
144
- var _default = exports["default"] = SuccessErrorResponse;
129
+ CombinedPdfSourcePdf.prototype['id'] = undefined;
130
+ var _default = exports["default"] = CombinedPdfSourcePdf;