docspring 3.3.0 → 4.1.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 (184) hide show
  1. package/AGENTS.md +79 -19
  2. package/README.md +74 -63
  3. package/dist/ApiClient.js +63 -28
  4. package/dist/RequestSchemas.js +3452 -0
  5. package/dist/RequestValidator.js +494 -0
  6. package/dist/api/Client.js +1769 -921
  7. package/dist/index.js +847 -154
  8. package/dist/model/AddTemplateFieldsRequest.js +132 -0
  9. package/dist/model/AiFieldNamingLanguage.js +64 -0
  10. package/dist/model/{CreateWebhookData.js → AuthenticationCheck.js} +32 -28
  11. package/dist/model/BarcodeSymbology.js +89 -0
  12. package/dist/model/CheckCharacter.js +74 -0
  13. package/dist/model/CombinedFieldType.js +59 -0
  14. package/dist/model/CombinedPdf.js +294 -0
  15. package/dist/model/{MoveFolderData.js → CombinedPdfFiles.js} +27 -27
  16. package/dist/model/CombinedPdfList.js +132 -0
  17. package/dist/model/{ForbiddenErrorResponse.js → CombinedPdfSource.js} +59 -73
  18. package/dist/model/CombinedPdfSourceInput.js +270 -0
  19. package/dist/model/CombinedPdfSourcePdf.js +130 -0
  20. package/dist/model/CombinedPdfSourceType.js +74 -0
  21. package/dist/model/CombinedPdfState.js +74 -0
  22. package/dist/model/{CopyTemplateOptions.js → CopyTemplateRequest.js} +26 -22
  23. package/dist/model/{CombinePdfsData.js → CreateCombinedPdfRequest.js} +69 -53
  24. package/dist/model/{CreateCustomFileData.js → CreateCustomFileFromUploadRequest.js} +25 -23
  25. package/dist/model/{CreateFolderData.js → CreateFolderRequest.js} +47 -28
  26. package/dist/model/{CreateCustomFileResponse.js → CreateSignatureRequestEventRequest.js} +49 -73
  27. package/dist/model/CreateSignatureRequestTokenRequest.js +88 -0
  28. package/dist/model/CreateSubmissionBatchRequest.js +192 -0
  29. package/dist/model/CreateSubmissionRequest.js +226 -0
  30. package/dist/model/CreateTemplateRequest.js +613 -0
  31. package/dist/model/CreateWebhookRequest.js +234 -0
  32. package/dist/model/CustomFile.js +67 -16
  33. package/dist/model/CustomFileList.js +132 -0
  34. package/dist/model/CustomFileSourcePdf.js +130 -0
  35. package/dist/model/ErrorCode.js +154 -0
  36. package/dist/model/{CreateSubmissionResponse.js → ErrorDetail.js} +65 -75
  37. package/dist/model/ErrorInfo.js +211 -0
  38. package/dist/model/ErrorResponse.js +12 -41
  39. package/dist/model/ExpirationInterval.js +64 -0
  40. package/dist/model/Field.js +1230 -0
  41. package/dist/model/FieldComparisonCondition.js +137 -0
  42. package/dist/model/FieldComparisonOperator.js +69 -0
  43. package/dist/model/FieldDependency.js +154 -0
  44. package/dist/model/FieldDependencyInput.js +154 -0
  45. package/dist/model/FieldDisplayType.js +79 -0
  46. package/dist/model/{MultipleErrorsResponse.js → FieldEqualsCondition.js} +48 -52
  47. package/dist/model/FieldEqualsOperator.js +59 -0
  48. package/dist/model/FieldGroup.js +206 -0
  49. package/dist/model/FieldGroupInput.js +180 -0
  50. package/dist/model/FieldGroupType.js +59 -0
  51. package/dist/model/{SuccessMultipleErrorsResponse.js → FieldInCondition.js} +54 -53
  52. package/dist/model/FieldInput.js +1012 -0
  53. package/dist/model/FieldOverride.js +722 -0
  54. package/dist/model/FieldPresenceCondition.js +126 -0
  55. package/dist/model/FieldPresenceOperator.js +59 -0
  56. package/dist/model/FieldRangeCondition.js +148 -0
  57. package/dist/model/FieldReimportState.js +69 -0
  58. package/dist/model/FieldSetupLogic.js +59 -0
  59. package/dist/model/FieldSetupNaming.js +59 -0
  60. package/dist/model/FieldSetupSource.js +64 -0
  61. package/dist/model/FieldType.js +124 -0
  62. package/dist/model/Folder.js +38 -11
  63. package/dist/model/FolderList.js +132 -0
  64. package/dist/model/GenerateFilesFormat.js +54 -0
  65. package/dist/model/GenerateSubmissionFilesRequest.js +115 -0
  66. package/dist/model/GeneratedFile.js +214 -0
  67. package/dist/model/GeneratedFileState.js +64 -0
  68. package/dist/model/HtmlEngineOptions.js +230 -0
  69. package/dist/model/HtmlEngineOptionsInput.js +193 -0
  70. package/dist/model/ImageGravity.js +94 -0
  71. package/dist/model/ImageScaleType.js +64 -0
  72. package/dist/model/ModelCodeLanguage.js +94 -0
  73. package/dist/model/{UpdatePdfTemplate.js → MoveFolderRequest.js} +34 -28
  74. package/dist/model/{MoveTemplateData.js → MoveTemplateRequest.js} +25 -35
  75. package/dist/model/NumberConditionType.js +79 -0
  76. package/dist/model/OutputFormat.js +59 -0
  77. package/dist/model/PageFormat.js +114 -0
  78. package/dist/model/PageImage.js +220 -0
  79. package/dist/model/{TemplateDeleteResponse.js → PageImages.js} +57 -70
  80. package/dist/model/PredefinedField.js +183 -0
  81. package/dist/model/PredefinedFieldInput.js +183 -0
  82. package/dist/model/{PublishVersionData.js → PublishTemplateVersionRequest.js} +33 -33
  83. package/dist/model/{AddFieldsData.js → RemoveTemplateFieldsRequest.js} +32 -30
  84. package/dist/model/{RenameFolderData.js → RenameFolderRequest.js} +25 -23
  85. package/dist/model/ReorderTemplateFieldsRequest.js +114 -0
  86. package/dist/model/{RestoreVersionData.js → RestoreTemplateVersionRequest.js} +25 -23
  87. package/dist/model/ShapeType.js +79 -0
  88. package/dist/model/{SubmissionDataRequestShow.js → SignatureRequest.js} +165 -240
  89. package/dist/model/SignatureRequestAuthSecondFactorType.js +79 -0
  90. package/dist/model/SignatureRequestAuthType.js +84 -0
  91. package/dist/model/{SubmissionDataRequestEvent.js → SignatureRequestEvent.js} +67 -149
  92. package/dist/model/SignatureRequestEventType.js +79 -0
  93. package/dist/model/SignatureRequestInput.js +278 -0
  94. package/dist/model/SignatureRequestMessageType.js +94 -0
  95. package/dist/model/SignatureRequestState.js +64 -0
  96. package/dist/model/SignatureRequestToken.js +195 -0
  97. package/dist/model/SignatureRequestTokenType.js +59 -0
  98. package/dist/model/StringConditionType.js +74 -0
  99. package/dist/model/Submission.js +198 -341
  100. package/dist/model/SubmissionAction.js +30 -115
  101. package/dist/model/SubmissionActionState.js +69 -0
  102. package/dist/model/SubmissionActionType.js +84 -0
  103. package/dist/model/SubmissionBatch.js +74 -55
  104. package/dist/model/SubmissionBatchState.js +64 -0
  105. package/dist/model/SubmissionFiles.js +117 -0
  106. package/dist/model/SubmissionInput.js +218 -0
  107. package/dist/model/{ListSubmissionsResponse.js → SubmissionList.js} +35 -42
  108. package/dist/model/SubmissionSource.js +69 -0
  109. package/dist/model/SubmissionSourcePdf.js +130 -0
  110. package/dist/model/SubmissionState.js +114 -0
  111. package/dist/model/{SubmissionBatchData.js → SubmissionValidation.js} +46 -48
  112. package/dist/model/Template.js +359 -560
  113. package/dist/model/TemplateActor.js +171 -0
  114. package/dist/model/TemplateActorType.js +64 -0
  115. package/dist/model/TemplateDefaults.js +307 -0
  116. package/dist/model/TemplateDefaultsInput.js +305 -0
  117. package/dist/model/TemplateDiff.js +206 -0
  118. package/dist/model/TemplateDiffSummary.js +165 -0
  119. package/dist/model/TemplateDocument.js +280 -0
  120. package/dist/model/TemplateDocumentState.js +84 -0
  121. package/dist/model/TemplateFieldChange.js +146 -0
  122. package/dist/model/TemplateFieldChanges.js +196 -0
  123. package/dist/model/{CreatePdfSubmissionData.js → TemplateFieldDependency.js} +70 -89
  124. package/dist/model/TemplateFieldDependencyAction.js +64 -0
  125. package/dist/model/{TemplatePublishVersionResponse.js → TemplateFieldDependencyCondition.js} +51 -61
  126. package/dist/model/TemplateFieldDependencyConditionInput.js +304 -0
  127. package/dist/model/TemplateFieldDependencyInput.js +182 -0
  128. package/dist/model/TemplateFieldDependencyMatch.js +59 -0
  129. package/dist/model/TemplateFieldDependencyOperator.js +99 -0
  130. package/dist/model/TemplateFieldLogicStatus.js +74 -0
  131. package/dist/model/{CreatePdfTemplate.js → TemplateFieldMove.js} +52 -28
  132. package/dist/model/TemplateFields.js +147 -0
  133. package/dist/model/TemplateFormMode.js +64 -0
  134. package/dist/model/{TemplateModelCodeResponse.js → TemplateModelCode.js} +34 -86
  135. package/dist/model/TemplatePageAiError.js +69 -0
  136. package/dist/model/TemplatePageAiNamingStatus.js +59 -0
  137. package/dist/model/TemplatePageFieldsStatus.js +74 -0
  138. package/dist/model/TemplatePageImageStatus.js +59 -0
  139. package/dist/model/TemplatePageImages.js +158 -0
  140. package/dist/model/TemplatePageProcessingStatus.js +162 -0
  141. package/dist/model/{SubmissionDataRequestToken.js → TemplateSourcePdf.js} +52 -56
  142. package/dist/model/TemplateSummary.js +560 -0
  143. package/dist/model/{SuccessErrorResponse.js → TemplateSummaryList.js} +43 -55
  144. package/dist/model/TemplateType.js +59 -0
  145. package/dist/model/{Submission422Response.js → TemplateVersion.js} +60 -63
  146. package/dist/model/TemplateVersionType.js +64 -0
  147. package/dist/model/TextAlignment.js +69 -0
  148. package/dist/model/TextOverflow.js +59 -0
  149. package/dist/model/TextVerticalAlignment.js +64 -0
  150. package/dist/model/Typeface.js +134 -0
  151. package/dist/model/UpdateSignatureRequestRequest.js +183 -0
  152. package/dist/model/UpdateTemplateDocumentRequest.js +139 -0
  153. package/dist/model/UpdateTemplateFieldsRequest.js +132 -0
  154. package/dist/model/UpdateTemplateRequest.js +523 -0
  155. package/dist/model/UpdateWebhookRequest.js +209 -0
  156. package/dist/model/UploadMethod.js +54 -0
  157. package/dist/model/{UploadPresignResponse.js → UploadPresign.js} +53 -58
  158. package/dist/model/UrlSourcePdf.js +130 -0
  159. package/dist/model/ValidateSubmissionRequest.js +226 -0
  160. package/dist/model/Webhook.js +58 -73
  161. package/dist/model/WebhookEventType.js +174 -0
  162. package/dist/model/WebhookList.js +132 -0
  163. package/dist/model/WebhookMode.js +59 -0
  164. package/package.json +1 -1
  165. package/dist/model/BatchGeneratePdfs201Response.js +0 -194
  166. package/dist/model/CombinedSubmission.js +0 -313
  167. package/dist/model/CombinedSubmissionAction.js +0 -268
  168. package/dist/model/CreateCombinedSubmissionResponse.js +0 -180
  169. package/dist/model/CreateHtmlTemplate.js +0 -108
  170. package/dist/model/CreateSubmissionDataRequestData.js +0 -314
  171. package/dist/model/CreateSubmissionDataRequestEventRequest.js +0 -239
  172. package/dist/model/CreateSubmissionDataRequestEventResponse.js +0 -167
  173. package/dist/model/CreateSubmissionDataRequestResponse.js +0 -167
  174. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +0 -167
  175. package/dist/model/ErrorOrMultipleErrorsResponse.js +0 -153
  176. package/dist/model/JsonSchema.js +0 -205
  177. package/dist/model/SubmissionBatchWithSubmissions.js +0 -228
  178. package/dist/model/SubmissionDataRequest.js +0 -496
  179. package/dist/model/SubmissionPreview.js +0 -509
  180. package/dist/model/TemplateAddFieldsResponse.js +0 -156
  181. package/dist/model/TemplatePreview.js +0 -796
  182. package/dist/model/UpdateHtmlTemplate.js +0 -108
  183. package/dist/model/UpdateSubmissionDataRequestData.js +0 -311
  184. package/dist/model/UpdateWebhookData.js +0 -108
@@ -0,0 +1,234 @@
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 _WebhookEventType = _interopRequireDefault(require("./WebhookEventType"));
9
+ var _WebhookMode = _interopRequireDefault(require("./WebhookMode"));
10
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
11
+ 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); }
12
+ 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; } } }; }
13
+ 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; } }
14
+ 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; }
15
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
16
+ 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); } }
17
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
18
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
19
+ 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); } /**
20
+ * DocSpring API
21
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
22
+ *
23
+ * The version of the OpenAPI document: v2
24
+ *
25
+ *
26
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
27
+ * https://openapi-generator.tech
28
+ * Do not edit the class manually.
29
+ *
30
+ */
31
+ /**
32
+ * The CreateWebhookRequest model module.
33
+ * @module model/CreateWebhookRequest
34
+ * @version 4.1.0
35
+ */
36
+ var CreateWebhookRequest = /*#__PURE__*/function () {
37
+ /**
38
+ * Constructs a new <code>CreateWebhookRequest</code>.
39
+ * The webhook to create.
40
+ * @alias module:model/CreateWebhookRequest
41
+ * @param url {String} The endpoint that receives webhook POST requests.
42
+ * @param event_types {Array.<module:model/WebhookEventType>} The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names.
43
+ */
44
+ function CreateWebhookRequest(url, event_types) {
45
+ _classCallCheck(this, CreateWebhookRequest);
46
+ CreateWebhookRequest.initialize(this, url, event_types);
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(CreateWebhookRequest, null, [{
55
+ key: "initialize",
56
+ value: function initialize(obj, url, event_types) {
57
+ obj['url'] = url;
58
+ obj['event_types'] = event_types;
59
+ }
60
+
61
+ /**
62
+ * Constructs a <code>CreateWebhookRequest</code> from a plain JavaScript object, optionally creating a new instance.
63
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
64
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
65
+ * @param {module:model/CreateWebhookRequest} obj Optional instance to populate.
66
+ * @return {module:model/CreateWebhookRequest} The populated <code>CreateWebhookRequest</code> instance.
67
+ */
68
+ }, {
69
+ key: "constructFromObject",
70
+ value: function constructFromObject(data, obj) {
71
+ if (data) {
72
+ obj = obj || new CreateWebhookRequest();
73
+ if (data.hasOwnProperty('name')) {
74
+ obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
75
+ }
76
+ if (data.hasOwnProperty('url')) {
77
+ obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
78
+ }
79
+ if (data.hasOwnProperty('enabled')) {
80
+ obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
81
+ }
82
+ if (data.hasOwnProperty('event_types')) {
83
+ obj['event_types'] = _ApiClient["default"].convertToType(data['event_types'], [_WebhookEventType["default"]]);
84
+ }
85
+ if (data.hasOwnProperty('mode')) {
86
+ obj['mode'] = _ApiClient["default"].convertToType(data['mode'], _WebhookMode["default"]);
87
+ }
88
+ if (data.hasOwnProperty('api_token_ids')) {
89
+ obj['api_token_ids'] = _ApiClient["default"].convertToType(data['api_token_ids'], ['String']);
90
+ }
91
+ if (data.hasOwnProperty('template_ids')) {
92
+ obj['template_ids'] = _ApiClient["default"].convertToType(data['template_ids'], ['String']);
93
+ }
94
+ if (data.hasOwnProperty('folder_ids')) {
95
+ obj['folder_ids'] = _ApiClient["default"].convertToType(data['folder_ids'], ['String']);
96
+ }
97
+ if (data.hasOwnProperty('include_submission_data')) {
98
+ obj['include_submission_data'] = _ApiClient["default"].convertToType(data['include_submission_data'], 'Boolean');
99
+ }
100
+ if (data.hasOwnProperty('strip_fields')) {
101
+ obj['strip_fields'] = _ApiClient["default"].convertToType(data['strip_fields'], ['String']);
102
+ }
103
+ if (data.hasOwnProperty('headers')) {
104
+ obj['headers'] = _ApiClient["default"].convertToType(data['headers'], {
105
+ 'String': 'String'
106
+ });
107
+ }
108
+ }
109
+ return obj;
110
+ }
111
+
112
+ /**
113
+ * Validates the JSON data with respect to <code>CreateWebhookRequest</code>.
114
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
115
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CreateWebhookRequest</code>.
116
+ */
117
+ }, {
118
+ key: "validateJSON",
119
+ value: function validateJSON(data) {
120
+ // check to make sure all required properties are present in the JSON string
121
+ var _iterator = _createForOfIteratorHelper(CreateWebhookRequest.RequiredProperties),
122
+ _step;
123
+ try {
124
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
125
+ var property = _step.value;
126
+ if (!data.hasOwnProperty(property)) {
127
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
128
+ }
129
+ }
130
+ // ensure the json data is a string
131
+ } catch (err) {
132
+ _iterator.e(err);
133
+ } finally {
134
+ _iterator.f();
135
+ }
136
+ if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
137
+ throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
138
+ }
139
+ // ensure the json data is a string
140
+ if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
141
+ throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
142
+ }
143
+ // ensure the json data is an array
144
+ if (!Array.isArray(data['event_types'])) {
145
+ throw new Error("Expected the field `event_types` to be an array in the JSON data but got " + data['event_types']);
146
+ }
147
+ // ensure the json data is an array
148
+ if (!Array.isArray(data['api_token_ids'])) {
149
+ throw new Error("Expected the field `api_token_ids` to be an array in the JSON data but got " + data['api_token_ids']);
150
+ }
151
+ // ensure the json data is an array
152
+ if (!Array.isArray(data['template_ids'])) {
153
+ throw new Error("Expected the field `template_ids` to be an array in the JSON data but got " + data['template_ids']);
154
+ }
155
+ // ensure the json data is an array
156
+ if (!Array.isArray(data['folder_ids'])) {
157
+ throw new Error("Expected the field `folder_ids` to be an array in the JSON data but got " + data['folder_ids']);
158
+ }
159
+ // ensure the json data is an array
160
+ if (!Array.isArray(data['strip_fields'])) {
161
+ throw new Error("Expected the field `strip_fields` to be an array in the JSON data but got " + data['strip_fields']);
162
+ }
163
+ return true;
164
+ }
165
+ }]);
166
+ }();
167
+ CreateWebhookRequest.RequiredProperties = ["url", "event_types"];
168
+
169
+ /**
170
+ * A name for the webhook, shown in the dashboard.
171
+ * @member {String} name
172
+ */
173
+ CreateWebhookRequest.prototype['name'] = undefined;
174
+
175
+ /**
176
+ * The endpoint that receives webhook POST requests.
177
+ * @member {String} url
178
+ */
179
+ CreateWebhookRequest.prototype['url'] = undefined;
180
+
181
+ /**
182
+ * Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
183
+ * @member {Boolean} enabled
184
+ */
185
+ CreateWebhookRequest.prototype['enabled'] = undefined;
186
+
187
+ /**
188
+ * The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names.
189
+ * @member {Array.<module:model/WebhookEventType>} event_types
190
+ */
191
+ CreateWebhookRequest.prototype['event_types'] = undefined;
192
+
193
+ /**
194
+ * Only send events for test or live submissions. Null sends both.
195
+ * @member {module:model/WebhookMode} mode
196
+ */
197
+ CreateWebhookRequest.prototype['mode'] = undefined;
198
+
199
+ /**
200
+ * Only send events from these API tokens. Combined with the other scope lists using OR. Applies to submission, signature request, combined PDF, submission batch and custom file events.
201
+ * @member {Array.<String>} api_token_ids
202
+ */
203
+ CreateWebhookRequest.prototype['api_token_ids'] = undefined;
204
+
205
+ /**
206
+ * Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
207
+ * @member {Array.<String>} template_ids
208
+ */
209
+ CreateWebhookRequest.prototype['template_ids'] = undefined;
210
+
211
+ /**
212
+ * Only send events for templates in these folders, including their subfolders. Combined with the other scope lists using OR. Applies to submission, signature request, template and folder events.
213
+ * @member {Array.<String>} folder_ids
214
+ */
215
+ CreateWebhookRequest.prototype['folder_ids'] = undefined;
216
+
217
+ /**
218
+ * Include the submission's field data in the payload. When false, the submission's data and truncated_text, and each signature request's data, ip_address and user_agent, are null.
219
+ * @member {Boolean} include_submission_data
220
+ */
221
+ CreateWebhookRequest.prototype['include_submission_data'] = undefined;
222
+
223
+ /**
224
+ * Dot-separated paths to remove from the event's data object. Form fields live under `data` (`data.ssn` removes the ssn field). A bare name removes a top-level key (`metadata` removes the whole metadata object).
225
+ * @member {Array.<String>} strip_fields
226
+ */
227
+ CreateWebhookRequest.prototype['strip_fields'] = undefined;
228
+
229
+ /**
230
+ * Headers to send with each request.
231
+ * @member {Object.<String, String>} headers
232
+ */
233
+ CreateWebhookRequest.prototype['headers'] = undefined;
234
+ var _default = exports["default"] = CreateWebhookRequest;
@@ -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).
@@ -29,19 +29,24 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
29
29
  /**
30
30
  * The CustomFile model module.
31
31
  * @module model/CustomFile
32
- * @version 3.3.0
32
+ * @version 4.1.0
33
33
  */
34
34
  var CustomFile = /*#__PURE__*/function () {
35
35
  /**
36
36
  * Constructs a new <code>CustomFile</code>.
37
+ * A PDF you uploaded to merge with other PDFs (POST /combined_pdfs). Get an upload URL with GET /uploads/presign first.
37
38
  * @alias module:model/CustomFile
38
39
  * @extends Object
39
- * @param id {String}
40
- * @param url {String}
40
+ * @param id {String} The custom file's ID.
41
+ * @param download_url {String} A temporary link to download the file.
42
+ * @param size {Number} The file's size in bytes.
43
+ * @param content_type {String} The file's media type, such as `application/pdf`.
44
+ * @param created_at {Date} When the custom file was created.
45
+ * @param updated_at {Date} When the custom file was last updated.
41
46
  */
42
- function CustomFile(id, url) {
47
+ function CustomFile(id, download_url, size, content_type, created_at, updated_at) {
43
48
  _classCallCheck(this, CustomFile);
44
- CustomFile.initialize(this, id, url);
49
+ CustomFile.initialize(this, id, download_url, size, content_type, created_at, updated_at);
45
50
  }
46
51
 
47
52
  /**
@@ -51,9 +56,13 @@ var CustomFile = /*#__PURE__*/function () {
51
56
  */
52
57
  return _createClass(CustomFile, null, [{
53
58
  key: "initialize",
54
- value: function initialize(obj, id, url) {
59
+ value: function initialize(obj, id, download_url, size, content_type, created_at, updated_at) {
55
60
  obj['id'] = id;
56
- obj['url'] = url;
61
+ obj['download_url'] = download_url;
62
+ obj['size'] = size;
63
+ obj['content_type'] = content_type;
64
+ obj['created_at'] = created_at;
65
+ obj['updated_at'] = updated_at;
57
66
  }
58
67
 
59
68
  /**
@@ -72,8 +81,20 @@ var CustomFile = /*#__PURE__*/function () {
72
81
  if (data.hasOwnProperty('id')) {
73
82
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
74
83
  }
75
- if (data.hasOwnProperty('url')) {
76
- obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
84
+ if (data.hasOwnProperty('download_url')) {
85
+ obj['download_url'] = _ApiClient["default"].convertToType(data['download_url'], 'String');
86
+ }
87
+ if (data.hasOwnProperty('size')) {
88
+ obj['size'] = _ApiClient["default"].convertToType(data['size'], 'Number');
89
+ }
90
+ if (data.hasOwnProperty('content_type')) {
91
+ obj['content_type'] = _ApiClient["default"].convertToType(data['content_type'], 'String');
92
+ }
93
+ if (data.hasOwnProperty('created_at')) {
94
+ obj['created_at'] = _ApiClient["default"].convertToType(data['created_at'], 'Date');
95
+ }
96
+ if (data.hasOwnProperty('updated_at')) {
97
+ obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
77
98
  }
78
99
  }
79
100
  return obj;
@@ -107,22 +128,52 @@ var CustomFile = /*#__PURE__*/function () {
107
128
  throw new Error("Expected the field `id` to be a primitive type in the JSON string but got " + data['id']);
108
129
  }
109
130
  // ensure the json data is a string
110
- if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
111
- throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
131
+ if (data['download_url'] && !(typeof data['download_url'] === 'string' || data['download_url'] instanceof String)) {
132
+ throw new Error("Expected the field `download_url` to be a primitive type in the JSON string but got " + data['download_url']);
133
+ }
134
+ // ensure the json data is a string
135
+ if (data['content_type'] && !(typeof data['content_type'] === 'string' || data['content_type'] instanceof String)) {
136
+ throw new Error("Expected the field `content_type` to be a primitive type in the JSON string but got " + data['content_type']);
112
137
  }
113
138
  return true;
114
139
  }
115
140
  }]);
116
141
  }();
117
- CustomFile.RequiredProperties = ["id", "url"];
142
+ CustomFile.RequiredProperties = ["id", "download_url", "size", "content_type", "created_at", "updated_at"];
118
143
 
119
144
  /**
145
+ * The custom file's ID.
120
146
  * @member {String} id
121
147
  */
122
148
  CustomFile.prototype['id'] = undefined;
123
149
 
124
150
  /**
125
- * @member {String} url
151
+ * A temporary link to download the file.
152
+ * @member {String} download_url
153
+ */
154
+ CustomFile.prototype['download_url'] = undefined;
155
+
156
+ /**
157
+ * The file's size in bytes.
158
+ * @member {Number} size
159
+ */
160
+ CustomFile.prototype['size'] = undefined;
161
+
162
+ /**
163
+ * The file's media type, such as `application/pdf`.
164
+ * @member {String} content_type
165
+ */
166
+ CustomFile.prototype['content_type'] = undefined;
167
+
168
+ /**
169
+ * When the custom file was created.
170
+ * @member {Date} created_at
171
+ */
172
+ CustomFile.prototype['created_at'] = undefined;
173
+
174
+ /**
175
+ * When the custom file was last updated.
176
+ * @member {Date} updated_at
126
177
  */
127
- CustomFile.prototype['url'] = undefined;
178
+ CustomFile.prototype['updated_at'] = undefined;
128
179
  var _default = exports["default"] = CustomFile;
@@ -0,0 +1,132 @@
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 _CustomFile = _interopRequireDefault(require("./CustomFile"));
9
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
10
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
11
+ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
12
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
13
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
14
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
15
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
16
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
17
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
18
+ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
19
+ * DocSpring API
20
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
21
+ *
22
+ * The version of the OpenAPI document: v2
23
+ *
24
+ *
25
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
26
+ * https://openapi-generator.tech
27
+ * Do not edit the class manually.
28
+ *
29
+ */
30
+ /**
31
+ * The CustomFileList model module.
32
+ * @module model/CustomFileList
33
+ * @version 4.1.0
34
+ */
35
+ var CustomFileList = /*#__PURE__*/function () {
36
+ /**
37
+ * Constructs a new <code>CustomFileList</code>.
38
+ * A page of custom files, newest first.
39
+ * @alias module:model/CustomFileList
40
+ * @extends Object
41
+ * @param data {Array.<module:model/CustomFile>} The items on this page.
42
+ * @param next_cursor {String} Pass it as `cursor` to get the next page. Null on the last page.
43
+ */
44
+ function CustomFileList(data, next_cursor) {
45
+ _classCallCheck(this, CustomFileList);
46
+ CustomFileList.initialize(this, data, next_cursor);
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(CustomFileList, null, [{
55
+ key: "initialize",
56
+ value: function initialize(obj, data, next_cursor) {
57
+ obj['data'] = data;
58
+ obj['next_cursor'] = next_cursor;
59
+ }
60
+
61
+ /**
62
+ * Constructs a <code>CustomFileList</code> from a plain JavaScript object, optionally creating a new instance.
63
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
64
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
65
+ * @param {module:model/CustomFileList} obj Optional instance to populate.
66
+ * @return {module:model/CustomFileList} The populated <code>CustomFileList</code> instance.
67
+ */
68
+ }, {
69
+ key: "constructFromObject",
70
+ value: function constructFromObject(data, obj) {
71
+ if (data) {
72
+ obj = obj || new CustomFileList();
73
+ _ApiClient["default"].constructFromObject(data, obj, 'Object');
74
+ if (data.hasOwnProperty('data')) {
75
+ obj['data'] = _ApiClient["default"].convertToType(data['data'], [_CustomFile["default"]]);
76
+ }
77
+ if (data.hasOwnProperty('next_cursor')) {
78
+ obj['next_cursor'] = _ApiClient["default"].convertToType(data['next_cursor'], 'String');
79
+ }
80
+ }
81
+ return obj;
82
+ }
83
+
84
+ /**
85
+ * Validates the JSON data with respect to <code>CustomFileList</code>.
86
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
87
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CustomFileList</code>.
88
+ */
89
+ }, {
90
+ key: "validateJSON",
91
+ value: function validateJSON(data) {
92
+ // check to make sure all required properties are present in the JSON string
93
+ var _iterator = _createForOfIteratorHelper(CustomFileList.RequiredProperties),
94
+ _step;
95
+ try {
96
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
97
+ var property = _step.value;
98
+ if (!data.hasOwnProperty(property)) {
99
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
100
+ }
101
+ }
102
+ // ensure the json data is an array
103
+ } catch (err) {
104
+ _iterator.e(err);
105
+ } finally {
106
+ _iterator.f();
107
+ }
108
+ if (!Array.isArray(data['data'])) {
109
+ throw new Error("Expected the field `data` to be an array in the JSON data but got " + data['data']);
110
+ }
111
+ // ensure the json data is a string
112
+ if (data['next_cursor'] && !(typeof data['next_cursor'] === 'string' || data['next_cursor'] instanceof String)) {
113
+ throw new Error("Expected the field `next_cursor` to be a primitive type in the JSON string but got " + data['next_cursor']);
114
+ }
115
+ return true;
116
+ }
117
+ }]);
118
+ }();
119
+ CustomFileList.RequiredProperties = ["data", "next_cursor"];
120
+
121
+ /**
122
+ * The items on this page.
123
+ * @member {Array.<module:model/CustomFile>} data
124
+ */
125
+ CustomFileList.prototype['data'] = undefined;
126
+
127
+ /**
128
+ * Pass it as `cursor` to get the next page. Null on the last page.
129
+ * @member {String} next_cursor
130
+ */
131
+ CustomFileList.prototype['next_cursor'] = undefined;
132
+ var _default = exports["default"] = CustomFileList;
@@ -0,0 +1,130 @@
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 _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; } } }; }
11
+ 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; } }
12
+ 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; }
13
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
14
+ 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); } }
15
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
16
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
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
+ * 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.
20
+ *
21
+ * The version of the OpenAPI document: v2
22
+ *
23
+ *
24
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
25
+ * https://openapi-generator.tech
26
+ * Do not edit the class manually.
27
+ *
28
+ */
29
+ /**
30
+ * The CustomFileSourcePdf model module.
31
+ * @module model/CustomFileSourcePdf
32
+ * @version 4.1.0
33
+ */
34
+ var CustomFileSourcePdf = /*#__PURE__*/function () {
35
+ /**
36
+ * Constructs a new <code>CustomFileSourcePdf</code>.
37
+ * A custom file to merge (POST /custom_files).
38
+ * @alias module:model/CustomFileSourcePdf
39
+ * @param type {String} Must be `custom_file`.
40
+ * @param id {String} The ID of the submission, combined PDF, template or custom file.
41
+ */
42
+ function CustomFileSourcePdf(type, id) {
43
+ _classCallCheck(this, CustomFileSourcePdf);
44
+ CustomFileSourcePdf.initialize(this, type, id);
45
+ }
46
+
47
+ /**
48
+ * Initializes the fields of this object.
49
+ * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
50
+ * Only for internal use.
51
+ */
52
+ return _createClass(CustomFileSourcePdf, null, [{
53
+ key: "initialize",
54
+ value: function initialize(obj, type, id) {
55
+ obj['type'] = type || 'custom_file';
56
+ obj['id'] = id;
57
+ }
58
+
59
+ /**
60
+ * Constructs a <code>CustomFileSourcePdf</code> from a plain JavaScript object, optionally creating a new instance.
61
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
62
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
63
+ * @param {module:model/CustomFileSourcePdf} obj Optional instance to populate.
64
+ * @return {module:model/CustomFileSourcePdf} The populated <code>CustomFileSourcePdf</code> instance.
65
+ */
66
+ }, {
67
+ key: "constructFromObject",
68
+ value: function constructFromObject(data, obj) {
69
+ if (data) {
70
+ obj = obj || new CustomFileSourcePdf();
71
+ if (data.hasOwnProperty('type')) {
72
+ obj['type'] = _ApiClient["default"].convertToType(data['type'], 'String');
73
+ }
74
+ if (data.hasOwnProperty('id')) {
75
+ obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
76
+ }
77
+ }
78
+ return obj;
79
+ }
80
+
81
+ /**
82
+ * Validates the JSON data with respect to <code>CustomFileSourcePdf</code>.
83
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
84
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>CustomFileSourcePdf</code>.
85
+ */
86
+ }, {
87
+ key: "validateJSON",
88
+ value: function validateJSON(data) {
89
+ // check to make sure all required properties are present in the JSON string
90
+ var _iterator = _createForOfIteratorHelper(CustomFileSourcePdf.RequiredProperties),
91
+ _step;
92
+ try {
93
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
94
+ var property = _step.value;
95
+ if (!data.hasOwnProperty(property)) {
96
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
97
+ }
98
+ }
99
+ // ensure the json data is a string
100
+ } catch (err) {
101
+ _iterator.e(err);
102
+ } finally {
103
+ _iterator.f();
104
+ }
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']);
107
+ }
108
+ // ensure the json data is a string
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']);
111
+ }
112
+ return true;
113
+ }
114
+ }]);
115
+ }();
116
+ CustomFileSourcePdf.RequiredProperties = ["type", "id"];
117
+
118
+ /**
119
+ * Must be `custom_file`.
120
+ * @member {String} type
121
+ * @default 'custom_file'
122
+ */
123
+ CustomFileSourcePdf.prototype['type'] = 'custom_file';
124
+
125
+ /**
126
+ * The ID of the submission, combined PDF, template or custom file.
127
+ * @member {String} id
128
+ */
129
+ CustomFileSourcePdf.prototype['id'] = undefined;
130
+ var _default = exports["default"] = CustomFileSourcePdf;