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,2297 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ // API v2's request schemas (api_clients/scripts/extract_request_schemas), for RequestValidator.js
8
+ var _default = exports["default"] = {
9
+ "operations": {
10
+ "copyTemplate": {
11
+ "body": {
12
+ "mediaType": "application/json",
13
+ "required": false,
14
+ "schema": {
15
+ "type": "object",
16
+ "properties": {
17
+ "name": {
18
+ "type": "string",
19
+ "minLength": 1,
20
+ "maxLength": 255
21
+ },
22
+ "parent_folder_id": {
23
+ "type": ["string", "null"],
24
+ "minLength": 1
25
+ },
26
+ "version": {
27
+ "type": "string",
28
+ "pattern": "^\\d+(\\.\\d+(\\.\\d+)?)?$",
29
+ "x-pattern-message": "must be a published version like 1.2.3 or 1"
30
+ }
31
+ },
32
+ "additionalProperties": false
33
+ }
34
+ }
35
+ },
36
+ "createCombinedPdf": {
37
+ "query": {
38
+ "wait": {
39
+ "required": false,
40
+ "schema": {
41
+ "type": "boolean"
42
+ }
43
+ }
44
+ },
45
+ "body": {
46
+ "mediaType": "application/json",
47
+ "required": true,
48
+ "schema": {
49
+ "type": "object",
50
+ "properties": {
51
+ "source_pdfs": {
52
+ "type": "array",
53
+ "minItems": 1,
54
+ "items": {
55
+ "oneOf": [{
56
+ "$ref": "#/components/schemas/SubmissionSourcePdf"
57
+ }, {
58
+ "$ref": "#/components/schemas/CombinedPdfSourcePdf"
59
+ }, {
60
+ "$ref": "#/components/schemas/TemplateSourcePdf"
61
+ }, {
62
+ "$ref": "#/components/schemas/CustomFileSourcePdf"
63
+ }, {
64
+ "$ref": "#/components/schemas/UrlSourcePdf"
65
+ }],
66
+ "discriminator": {
67
+ "propertyName": "type",
68
+ "mapping": [["submission", "#/components/schemas/SubmissionSourcePdf"], ["combined_pdf", "#/components/schemas/CombinedPdfSourcePdf"], ["template", "#/components/schemas/TemplateSourcePdf"], ["custom_file", "#/components/schemas/CustomFileSourcePdf"], ["url", "#/components/schemas/UrlSourcePdf"]]
69
+ }
70
+ }
71
+ },
72
+ "metadata": {
73
+ "type": "object"
74
+ },
75
+ "password": {
76
+ "type": "string",
77
+ "minLength": 1
78
+ },
79
+ "delete_custom_files": {
80
+ "type": "boolean"
81
+ },
82
+ "expires_in": {
83
+ "type": "integer",
84
+ "minimum": 1,
85
+ "maximum": 315360000
86
+ }
87
+ },
88
+ "required": ["source_pdfs"],
89
+ "additionalProperties": false
90
+ }
91
+ }
92
+ },
93
+ "createCustomFileFromUpload": {
94
+ "body": {
95
+ "mediaType": "application/json",
96
+ "required": true,
97
+ "schema": {
98
+ "type": "object",
99
+ "required": ["cache_id"],
100
+ "properties": {
101
+ "cache_id": {
102
+ "type": "string",
103
+ "minLength": 1,
104
+ "maxLength": 255
105
+ }
106
+ },
107
+ "additionalProperties": false
108
+ }
109
+ }
110
+ },
111
+ "createFolder": {
112
+ "body": {
113
+ "mediaType": "application/json",
114
+ "required": true,
115
+ "schema": {
116
+ "type": "object",
117
+ "properties": {
118
+ "name": {
119
+ "type": "string",
120
+ "minLength": 1,
121
+ "maxLength": 255,
122
+ "pattern": "^[^/]*$",
123
+ "x-pattern-message": "can't contain a slash (/)"
124
+ },
125
+ "parent_folder_id": {
126
+ "type": ["string", "null"],
127
+ "minLength": 1
128
+ }
129
+ },
130
+ "required": ["name"],
131
+ "additionalProperties": false
132
+ }
133
+ }
134
+ },
135
+ "createSignatureRequestEvent": {
136
+ "body": {
137
+ "mediaType": "application/json",
138
+ "required": true,
139
+ "schema": {
140
+ "type": "object",
141
+ "properties": {
142
+ "event_type": {
143
+ "type": "string",
144
+ "enum": ["send_request"]
145
+ },
146
+ "message_type": {
147
+ "type": ["string", "null"],
148
+ "enum": ["email", "sms", "fax", "mail", "slack", "msteams", "discord", "telegram", "whatsapp", null]
149
+ },
150
+ "message_recipient": {
151
+ "type": ["string", "null"],
152
+ "maxLength": 255
153
+ },
154
+ "occurred_at": {
155
+ "type": "string",
156
+ "format": "date-time"
157
+ }
158
+ },
159
+ "required": ["event_type"],
160
+ "additionalProperties": false
161
+ }
162
+ }
163
+ },
164
+ "createSignatureRequestToken": {
165
+ "body": {
166
+ "mediaType": "application/json",
167
+ "required": false,
168
+ "schema": {
169
+ "type": "object",
170
+ "properties": {
171
+ "type": {
172
+ "type": "string",
173
+ "enum": ["api", "email"]
174
+ }
175
+ },
176
+ "additionalProperties": false
177
+ }
178
+ }
179
+ },
180
+ "createSubmission": {
181
+ "query": {
182
+ "version": {
183
+ "required": false,
184
+ "schema": {
185
+ "type": "string",
186
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
187
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
188
+ }
189
+ },
190
+ "wait": {
191
+ "required": false,
192
+ "schema": {
193
+ "type": "boolean"
194
+ }
195
+ }
196
+ },
197
+ "body": {
198
+ "mediaType": "application/json",
199
+ "required": true,
200
+ "schema": {
201
+ "type": "object",
202
+ "properties": {
203
+ "test": {
204
+ "type": "boolean"
205
+ },
206
+ "editable": {
207
+ "type": "boolean"
208
+ },
209
+ "data": {
210
+ "type": "object"
211
+ },
212
+ "metadata": {
213
+ "type": "object"
214
+ },
215
+ "password": {
216
+ "type": "string",
217
+ "minLength": 1
218
+ },
219
+ "expires_in": {
220
+ "type": "integer",
221
+ "minimum": 1,
222
+ "maximum": 315360000
223
+ },
224
+ "field_overrides": {
225
+ "type": "object",
226
+ "additionalProperties": {
227
+ "$ref": "#/components/schemas/FieldOverride"
228
+ }
229
+ },
230
+ "html": {
231
+ "type": "string"
232
+ },
233
+ "css": {
234
+ "type": "string"
235
+ },
236
+ "signature_requests": {
237
+ "type": "array",
238
+ "maxItems": 100,
239
+ "items": {
240
+ "type": "object",
241
+ "properties": {
242
+ "name": {
243
+ "type": ["string", "null"],
244
+ "maxLength": 255
245
+ },
246
+ "email": {
247
+ "type": ["string", "null"],
248
+ "maxLength": 255
249
+ },
250
+ "fields": {
251
+ "type": "array",
252
+ "minItems": 1,
253
+ "uniqueItems": true,
254
+ "items": {
255
+ "type": "string",
256
+ "minLength": 1
257
+ }
258
+ },
259
+ "metadata": {
260
+ "type": "object"
261
+ },
262
+ "role": {
263
+ "type": "string",
264
+ "minLength": 1
265
+ },
266
+ "auth_type": {
267
+ "type": "string",
268
+ "enum": ["password", "oauth", "email_link", "phone_number", "ldap", "saml"]
269
+ },
270
+ "auth_second_factor_type": {
271
+ "type": "string",
272
+ "enum": ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"]
273
+ },
274
+ "auth_provider": {
275
+ "type": ["string", "null"],
276
+ "maxLength": 255
277
+ },
278
+ "auth_session_started_at": {
279
+ "type": ["string", "null"],
280
+ "format": "date-time"
281
+ },
282
+ "auth_session_id_hash": {
283
+ "type": ["string", "null"]
284
+ },
285
+ "auth_user_id_hash": {
286
+ "type": ["string", "null"]
287
+ },
288
+ "auth_username_hash": {
289
+ "type": ["string", "null"]
290
+ },
291
+ "auth_phone_number_hash": {
292
+ "type": ["string", "null"]
293
+ },
294
+ "ignore_unknown_fields": {
295
+ "type": "boolean"
296
+ },
297
+ "prefilled_values_editable": {
298
+ "type": "boolean"
299
+ }
300
+ },
301
+ "required": ["fields", "auth_type"],
302
+ "additionalProperties": false
303
+ }
304
+ }
305
+ },
306
+ "additionalProperties": false
307
+ }
308
+ }
309
+ },
310
+ "createSubmissionBatch": {
311
+ "query": {
312
+ "wait": {
313
+ "required": false,
314
+ "schema": {
315
+ "type": "boolean"
316
+ }
317
+ }
318
+ },
319
+ "body": {
320
+ "mediaType": "application/json",
321
+ "required": true,
322
+ "schema": {
323
+ "type": "object",
324
+ "properties": {
325
+ "metadata": {
326
+ "type": "object"
327
+ },
328
+ "template_id": {
329
+ "type": "string"
330
+ },
331
+ "template_version": {
332
+ "type": "string",
333
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
334
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
335
+ },
336
+ "test": {
337
+ "type": "boolean"
338
+ },
339
+ "submissions": {
340
+ "type": "array",
341
+ "minItems": 1,
342
+ "maxItems": 50,
343
+ "items": {
344
+ "type": "object",
345
+ "properties": {
346
+ "test": {
347
+ "type": "boolean"
348
+ },
349
+ "editable": {
350
+ "type": "boolean"
351
+ },
352
+ "data": {
353
+ "type": "object"
354
+ },
355
+ "metadata": {
356
+ "type": "object"
357
+ },
358
+ "password": {
359
+ "type": "string",
360
+ "minLength": 1
361
+ },
362
+ "expires_in": {
363
+ "type": "integer",
364
+ "minimum": 1,
365
+ "maximum": 315360000
366
+ },
367
+ "field_overrides": {
368
+ "type": "object",
369
+ "additionalProperties": {
370
+ "$ref": "#/components/schemas/FieldOverride"
371
+ }
372
+ },
373
+ "html": {
374
+ "type": "string"
375
+ },
376
+ "css": {
377
+ "type": "string"
378
+ },
379
+ "template_id": {
380
+ "type": "string"
381
+ },
382
+ "template_version": {
383
+ "type": "string",
384
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
385
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
386
+ }
387
+ },
388
+ "additionalProperties": false
389
+ }
390
+ }
391
+ },
392
+ "required": ["submissions"],
393
+ "additionalProperties": false
394
+ }
395
+ }
396
+ },
397
+ "createTemplate": {
398
+ "query": {
399
+ "wait": {
400
+ "required": false,
401
+ "schema": {
402
+ "type": "boolean"
403
+ }
404
+ }
405
+ },
406
+ "body": {
407
+ "mediaType": "application/json",
408
+ "required": true,
409
+ "schema": {
410
+ "type": "object",
411
+ "properties": {
412
+ "name": {
413
+ "type": "string",
414
+ "minLength": 1,
415
+ "maxLength": 255
416
+ },
417
+ "description": {
418
+ "type": ["string", "null"]
419
+ },
420
+ "template_type": {
421
+ "type": "string",
422
+ "enum": ["pdf", "html"]
423
+ },
424
+ "parent_folder_id": {
425
+ "type": ["string", "null"],
426
+ "minLength": 1
427
+ },
428
+ "locked": {
429
+ "type": "boolean"
430
+ },
431
+ "add_signature_request_submission_id_footers": {
432
+ "type": "boolean"
433
+ },
434
+ "ai_field_naming_language": {
435
+ "type": "string",
436
+ "enum": ["auto", "english", "form_language"]
437
+ },
438
+ "allow_additional_properties": {
439
+ "type": "boolean"
440
+ },
441
+ "allow_skipping_optional_fields": {
442
+ "type": "boolean"
443
+ },
444
+ "default_form_mode": {
445
+ "type": "string",
446
+ "enum": ["web", "visual", "dual"]
447
+ },
448
+ "editable_submissions": {
449
+ "type": "boolean"
450
+ },
451
+ "embed_domains": {
452
+ "type": "array",
453
+ "maxItems": 100,
454
+ "items": {
455
+ "type": "string",
456
+ "minLength": 1,
457
+ "maxLength": 255
458
+ }
459
+ },
460
+ "embed_edit_allow_settings": {
461
+ "type": "boolean"
462
+ },
463
+ "embed_edit_allow_versioning": {
464
+ "type": "boolean"
465
+ },
466
+ "embed_edit_allow_document_replacement": {
467
+ "type": "boolean"
468
+ },
469
+ "encrypt_pdfs": {
470
+ "type": "boolean"
471
+ },
472
+ "encrypt_pdfs_password": {
473
+ "type": ["string", "null"]
474
+ },
475
+ "expire_submissions": {
476
+ "type": "boolean"
477
+ },
478
+ "expire_after": {
479
+ "type": "integer",
480
+ "minimum": 1,
481
+ "maximum": 5256000
482
+ },
483
+ "expiration_interval": {
484
+ "type": "string",
485
+ "enum": ["minutes", "hours", "days"]
486
+ },
487
+ "merge_audit_trail_pdf": {
488
+ "type": "boolean"
489
+ },
490
+ "parse_dates_using_template_date_format": {
491
+ "type": "boolean"
492
+ },
493
+ "public_submissions": {
494
+ "type": "boolean"
495
+ },
496
+ "public_web_form": {
497
+ "type": "boolean"
498
+ },
499
+ "redirect_url": {
500
+ "type": ["string", "null"],
501
+ "format": "uri"
502
+ },
503
+ "slack_webhook_url": {
504
+ "type": ["string", "null"],
505
+ "format": "uri"
506
+ },
507
+ "defaults": {
508
+ "type": "object",
509
+ "properties": {
510
+ "typeface": {
511
+ "type": ["string", "null"],
512
+ "enum": ["Inconsolata", "Roboto Mono", "Ubuntu Mono", "Menlo", "Courier", "Helvetica", "Arial", "Calibri", "Open Sans", "Roboto", "Lato", "Poppins", "Public Sans", "Questrial", "Times New Roman", "Dancing Script", "Lovtony Script", null]
513
+ },
514
+ "font_size": {
515
+ "type": ["integer", "null"],
516
+ "minimum": 1
517
+ },
518
+ "character_spacing": {
519
+ "type": ["number", "null"],
520
+ "minimum": 0,
521
+ "maximum": 50
522
+ },
523
+ "color": {
524
+ "type": ["string", "null"],
525
+ "pattern": "^[A-Fa-f0-9]{6}$",
526
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
527
+ },
528
+ "background_color": {
529
+ "type": ["string", "null"],
530
+ "pattern": "^[A-Fa-f0-9]{6}$",
531
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
532
+ },
533
+ "bold": {
534
+ "type": "boolean"
535
+ },
536
+ "uppercase": {
537
+ "type": "boolean"
538
+ },
539
+ "alignment": {
540
+ "type": "string",
541
+ "enum": ["left", "center", "right", "justify"]
542
+ },
543
+ "opacity": {
544
+ "type": "number",
545
+ "minimum": 0,
546
+ "maximum": 1
547
+ },
548
+ "date_format": {
549
+ "type": ["string", "null"]
550
+ },
551
+ "date_time_format": {
552
+ "type": ["string", "null"]
553
+ },
554
+ "check_color": {
555
+ "type": ["string", "null"],
556
+ "pattern": "^[A-Fa-f0-9]{6}$",
557
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
558
+ },
559
+ "check_character": {
560
+ "type": ["string", "null"],
561
+ "enum": ["✓", "✔", "✖", "✗", "✘", null]
562
+ },
563
+ "check_background_color": {
564
+ "type": ["string", "null"],
565
+ "pattern": "^[A-Fa-f0-9]{6}$",
566
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
567
+ },
568
+ "required_field_background_color": {
569
+ "type": ["string", "null"],
570
+ "pattern": "^[A-Fa-f0-9]{6}$",
571
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
572
+ },
573
+ "true_text": {
574
+ "type": ["string", "null"]
575
+ },
576
+ "false_text": {
577
+ "type": ["string", "null"]
578
+ },
579
+ "shape_fill_color": {
580
+ "type": ["string", "null"],
581
+ "pattern": "^[A-Fa-f0-9]{6}$",
582
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
583
+ },
584
+ "shape_border_color": {
585
+ "type": ["string", "null"],
586
+ "pattern": "^[A-Fa-f0-9]{6}$",
587
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
588
+ },
589
+ "shape_border_width": {
590
+ "type": "integer",
591
+ "minimum": 1
592
+ }
593
+ },
594
+ "additionalProperties": false
595
+ },
596
+ "field_dependencies": {
597
+ "type": "array",
598
+ "items": {
599
+ "type": "object",
600
+ "properties": {
601
+ "action": {
602
+ "type": "string",
603
+ "enum": ["require_and_show", "show", "require"]
604
+ },
605
+ "match": {
606
+ "type": "string",
607
+ "enum": ["all", "any"]
608
+ },
609
+ "conditions": {
610
+ "type": "array",
611
+ "items": {
612
+ "oneOf": [{
613
+ "$ref": "#/components/schemas/FieldPresenceCondition"
614
+ }, {
615
+ "$ref": "#/components/schemas/FieldEqualsCondition"
616
+ }, {
617
+ "$ref": "#/components/schemas/FieldInCondition"
618
+ }, {
619
+ "$ref": "#/components/schemas/FieldComparisonCondition"
620
+ }, {
621
+ "$ref": "#/components/schemas/FieldRangeCondition"
622
+ }],
623
+ "discriminator": {
624
+ "propertyName": "operator",
625
+ "mapping": [["present", "#/components/schemas/FieldPresenceCondition"], ["blank", "#/components/schemas/FieldPresenceCondition"], ["equals", "#/components/schemas/FieldEqualsCondition"], ["not_equals", "#/components/schemas/FieldEqualsCondition"], ["in", "#/components/schemas/FieldInCondition"], ["gt", "#/components/schemas/FieldComparisonCondition"], ["gte", "#/components/schemas/FieldComparisonCondition"], ["lt", "#/components/schemas/FieldComparisonCondition"], ["lte", "#/components/schemas/FieldComparisonCondition"], ["range", "#/components/schemas/FieldRangeCondition"]]
626
+ }
627
+ }
628
+ },
629
+ "targets": {
630
+ "type": "array",
631
+ "minItems": 1,
632
+ "items": {
633
+ "type": "string",
634
+ "minLength": 1
635
+ }
636
+ },
637
+ "group": {
638
+ "type": "string"
639
+ }
640
+ },
641
+ "required": ["action", "conditions", "targets"],
642
+ "additionalProperties": false
643
+ }
644
+ },
645
+ "html": {
646
+ "type": ["string", "null"]
647
+ },
648
+ "scss": {
649
+ "type": ["string", "null"]
650
+ },
651
+ "header_html": {
652
+ "type": ["string", "null"]
653
+ },
654
+ "footer_html": {
655
+ "type": ["string", "null"]
656
+ },
657
+ "html_engine_options": {
658
+ "type": ["object", "null"],
659
+ "properties": {
660
+ "format": {
661
+ "type": "string",
662
+ "enum": ["Letter", "Legal", "Tabloid", "Ledger", "CR80", "A0", "A1", "A2", "A3", "A4", "A5", "A6", "Custom"]
663
+ },
664
+ "width": {
665
+ "type": "string"
666
+ },
667
+ "height": {
668
+ "type": "string"
669
+ },
670
+ "scale": {
671
+ "type": "number",
672
+ "exclusiveMinimum": 0
673
+ },
674
+ "landscape": {
675
+ "type": "boolean"
676
+ },
677
+ "print_background": {
678
+ "type": "boolean"
679
+ },
680
+ "margin_top": {
681
+ "type": "string"
682
+ },
683
+ "margin_bottom": {
684
+ "type": "string"
685
+ },
686
+ "margin_left": {
687
+ "type": "string"
688
+ },
689
+ "margin_right": {
690
+ "type": "string"
691
+ }
692
+ },
693
+ "additionalProperties": false
694
+ },
695
+ "cache_id": {
696
+ "type": "string",
697
+ "minLength": 1,
698
+ "maxLength": 255
699
+ },
700
+ "filename": {
701
+ "type": "string",
702
+ "minLength": 1,
703
+ "maxLength": 255
704
+ },
705
+ "detect_fields": {
706
+ "type": "boolean"
707
+ },
708
+ "field_source": {
709
+ "type": "string",
710
+ "enum": ["auto", "pdf_detection", "pdf_form_fields"]
711
+ },
712
+ "field_naming": {
713
+ "type": "string",
714
+ "enum": ["ai", "preserve"]
715
+ },
716
+ "field_logic": {
717
+ "type": "string",
718
+ "enum": ["ai", "none"]
719
+ }
720
+ },
721
+ "required": ["template_type"],
722
+ "additionalProperties": false
723
+ }
724
+ }
725
+ },
726
+ "createWebhook": {
727
+ "body": {
728
+ "mediaType": "application/json",
729
+ "required": true,
730
+ "schema": {
731
+ "type": "object",
732
+ "properties": {
733
+ "name": {
734
+ "type": ["string", "null"],
735
+ "maxLength": 255
736
+ },
737
+ "url": {
738
+ "type": "string",
739
+ "format": "uri"
740
+ },
741
+ "enabled": {
742
+ "type": "boolean"
743
+ },
744
+ "event_types": {
745
+ "type": "array",
746
+ "minItems": 1,
747
+ "uniqueItems": true,
748
+ "items": {
749
+ "type": "string",
750
+ "enum": ["submission.processed", "submission.failed", "submission.declined", "signature_request.viewed", "signature_request.completed", "signature_request.declined", "combined_pdf.processed", "combined_pdf.failed", "submission_batch.processed", "submission_batch.failed", "submission.created", "submission.updated", "submission.expired", "signature_request.updated", "combined_pdf.expired", "template.created", "template.updated", "template.deleted", "webhook.created", "webhook.updated", "webhook.deleted", "custom_file.created", "folder.created", "folder.updated", "folder.deleted"]
751
+ }
752
+ },
753
+ "mode": {
754
+ "type": ["string", "null"],
755
+ "enum": ["test", "live", null]
756
+ },
757
+ "api_token_ids": {
758
+ "type": "array",
759
+ "uniqueItems": true,
760
+ "items": {
761
+ "type": "string"
762
+ }
763
+ },
764
+ "template_ids": {
765
+ "type": "array",
766
+ "uniqueItems": true,
767
+ "items": {
768
+ "type": "string"
769
+ }
770
+ },
771
+ "folder_ids": {
772
+ "type": "array",
773
+ "uniqueItems": true,
774
+ "items": {
775
+ "type": "string"
776
+ }
777
+ },
778
+ "include_submission_data": {
779
+ "type": "boolean"
780
+ },
781
+ "strip_fields": {
782
+ "type": "array",
783
+ "items": {
784
+ "type": "string"
785
+ }
786
+ },
787
+ "headers": {
788
+ "type": "object",
789
+ "additionalProperties": {
790
+ "type": "string"
791
+ }
792
+ }
793
+ },
794
+ "required": ["url", "event_types"],
795
+ "additionalProperties": false
796
+ }
797
+ }
798
+ },
799
+ "deleteCustomFile": {},
800
+ "deleteFolder": {},
801
+ "deleteTemplate": {
802
+ "query": {
803
+ "version": {
804
+ "required": false,
805
+ "schema": {
806
+ "type": "string",
807
+ "pattern": "^(\\d+\\.\\d+\\.\\d+|draft)$",
808
+ "x-pattern-message": "must be a full version like 1.2.3, or draft"
809
+ }
810
+ }
811
+ }
812
+ },
813
+ "deleteWebhook": {},
814
+ "expireCombinedPdf": {},
815
+ "expireSubmission": {},
816
+ "generateSubmissionPreview": {},
817
+ "getCombinedPdf": {},
818
+ "getCustomFile": {},
819
+ "getFolder": {},
820
+ "getPresignUrl": {},
821
+ "getSignatureRequest": {},
822
+ "getSubmission": {},
823
+ "getSubmissionBatch": {
824
+ "query": {
825
+ "include_data": {
826
+ "required": false,
827
+ "schema": {
828
+ "type": "boolean"
829
+ }
830
+ }
831
+ }
832
+ },
833
+ "getTemplate": {
834
+ "query": {
835
+ "version": {
836
+ "required": false,
837
+ "schema": {
838
+ "type": "string",
839
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
840
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
841
+ }
842
+ }
843
+ }
844
+ },
845
+ "getTemplateModelCode": {
846
+ "query": {
847
+ "version": {
848
+ "required": false,
849
+ "schema": {
850
+ "type": "string",
851
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
852
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
853
+ }
854
+ },
855
+ "lang": {
856
+ "required": true,
857
+ "schema": {
858
+ "type": "string",
859
+ "enum": ["typescript", "javascript", "ruby", "python", "php", "java", "csharp", "elixir", "go"]
860
+ }
861
+ }
862
+ }
863
+ },
864
+ "getTemplateSchema": {
865
+ "query": {
866
+ "version": {
867
+ "required": false,
868
+ "schema": {
869
+ "type": "string",
870
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
871
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
872
+ }
873
+ }
874
+ }
875
+ },
876
+ "getWebhook": {},
877
+ "listCombinedPdfs": {
878
+ "query": {
879
+ "limit": {
880
+ "required": false,
881
+ "schema": {
882
+ "type": "integer",
883
+ "minimum": 1,
884
+ "maximum": 100
885
+ }
886
+ },
887
+ "cursor": {
888
+ "required": false,
889
+ "schema": {
890
+ "type": "string"
891
+ }
892
+ }
893
+ }
894
+ },
895
+ "listCustomFiles": {
896
+ "query": {
897
+ "limit": {
898
+ "required": false,
899
+ "schema": {
900
+ "type": "integer",
901
+ "minimum": 1,
902
+ "maximum": 100
903
+ }
904
+ },
905
+ "cursor": {
906
+ "required": false,
907
+ "schema": {
908
+ "type": "string"
909
+ }
910
+ }
911
+ }
912
+ },
913
+ "listFolders": {
914
+ "query": {
915
+ "parent_folder_id": {
916
+ "required": false,
917
+ "schema": {
918
+ "type": "string"
919
+ }
920
+ },
921
+ "limit": {
922
+ "required": false,
923
+ "schema": {
924
+ "type": "integer",
925
+ "minimum": 1,
926
+ "maximum": 100
927
+ }
928
+ },
929
+ "cursor": {
930
+ "required": false,
931
+ "schema": {
932
+ "type": "string"
933
+ }
934
+ }
935
+ }
936
+ },
937
+ "listSubmissions": {
938
+ "query": {
939
+ "template_id": {
940
+ "required": false,
941
+ "schema": {
942
+ "type": "string"
943
+ }
944
+ },
945
+ "test": {
946
+ "required": false,
947
+ "schema": {
948
+ "type": "boolean"
949
+ }
950
+ },
951
+ "created_after": {
952
+ "required": false,
953
+ "schema": {
954
+ "type": "string",
955
+ "format": "date-time"
956
+ }
957
+ },
958
+ "created_before": {
959
+ "required": false,
960
+ "schema": {
961
+ "type": "string",
962
+ "format": "date-time"
963
+ }
964
+ },
965
+ "include_data": {
966
+ "required": false,
967
+ "schema": {
968
+ "type": "boolean"
969
+ }
970
+ },
971
+ "limit": {
972
+ "required": false,
973
+ "schema": {
974
+ "type": "integer",
975
+ "minimum": 1,
976
+ "maximum": 100
977
+ }
978
+ },
979
+ "cursor": {
980
+ "required": false,
981
+ "schema": {
982
+ "type": "string"
983
+ }
984
+ }
985
+ }
986
+ },
987
+ "listTemplateSubmissions": {
988
+ "query": {
989
+ "test": {
990
+ "required": false,
991
+ "schema": {
992
+ "type": "boolean"
993
+ }
994
+ },
995
+ "created_after": {
996
+ "required": false,
997
+ "schema": {
998
+ "type": "string",
999
+ "format": "date-time"
1000
+ }
1001
+ },
1002
+ "created_before": {
1003
+ "required": false,
1004
+ "schema": {
1005
+ "type": "string",
1006
+ "format": "date-time"
1007
+ }
1008
+ },
1009
+ "include_data": {
1010
+ "required": false,
1011
+ "schema": {
1012
+ "type": "boolean"
1013
+ }
1014
+ },
1015
+ "limit": {
1016
+ "required": false,
1017
+ "schema": {
1018
+ "type": "integer",
1019
+ "minimum": 1,
1020
+ "maximum": 100
1021
+ }
1022
+ },
1023
+ "cursor": {
1024
+ "required": false,
1025
+ "schema": {
1026
+ "type": "string"
1027
+ }
1028
+ }
1029
+ }
1030
+ },
1031
+ "listTemplates": {
1032
+ "query": {
1033
+ "query": {
1034
+ "required": false,
1035
+ "schema": {
1036
+ "type": "string"
1037
+ }
1038
+ },
1039
+ "parent_folder_id": {
1040
+ "required": false,
1041
+ "schema": {
1042
+ "type": "string"
1043
+ }
1044
+ },
1045
+ "limit": {
1046
+ "required": false,
1047
+ "schema": {
1048
+ "type": "integer",
1049
+ "minimum": 1,
1050
+ "maximum": 100
1051
+ }
1052
+ },
1053
+ "cursor": {
1054
+ "required": false,
1055
+ "schema": {
1056
+ "type": "string"
1057
+ }
1058
+ }
1059
+ }
1060
+ },
1061
+ "listWebhooks": {
1062
+ "query": {
1063
+ "event_type": {
1064
+ "required": false,
1065
+ "schema": {
1066
+ "type": "string",
1067
+ "enum": ["submission.processed", "submission.failed", "submission.declined", "signature_request.viewed", "signature_request.completed", "signature_request.declined", "combined_pdf.processed", "combined_pdf.failed", "submission_batch.processed", "submission_batch.failed", "submission.created", "submission.updated", "submission.expired", "signature_request.updated", "combined_pdf.expired", "template.created", "template.updated", "template.deleted", "webhook.created", "webhook.updated", "webhook.deleted", "custom_file.created", "folder.created", "folder.updated", "folder.deleted"]
1068
+ }
1069
+ },
1070
+ "mode": {
1071
+ "required": false,
1072
+ "schema": {
1073
+ "type": "string",
1074
+ "enum": ["test", "live"]
1075
+ }
1076
+ },
1077
+ "template_id": {
1078
+ "required": false,
1079
+ "schema": {
1080
+ "type": "string"
1081
+ }
1082
+ },
1083
+ "folder_id": {
1084
+ "required": false,
1085
+ "schema": {
1086
+ "type": "string"
1087
+ }
1088
+ },
1089
+ "api_token_id": {
1090
+ "required": false,
1091
+ "schema": {
1092
+ "type": "string"
1093
+ }
1094
+ },
1095
+ "limit": {
1096
+ "required": false,
1097
+ "schema": {
1098
+ "type": "integer",
1099
+ "minimum": 1,
1100
+ "maximum": 100
1101
+ }
1102
+ },
1103
+ "cursor": {
1104
+ "required": false,
1105
+ "schema": {
1106
+ "type": "string"
1107
+ }
1108
+ }
1109
+ }
1110
+ },
1111
+ "moveFolder": {
1112
+ "body": {
1113
+ "mediaType": "application/json",
1114
+ "required": true,
1115
+ "schema": {
1116
+ "type": "object",
1117
+ "properties": {
1118
+ "parent_folder_id": {
1119
+ "type": ["string", "null"],
1120
+ "minLength": 1
1121
+ }
1122
+ },
1123
+ "required": ["parent_folder_id"],
1124
+ "additionalProperties": false
1125
+ }
1126
+ }
1127
+ },
1128
+ "moveTemplate": {
1129
+ "body": {
1130
+ "mediaType": "application/json",
1131
+ "required": true,
1132
+ "schema": {
1133
+ "type": "object",
1134
+ "required": ["parent_folder_id"],
1135
+ "properties": {
1136
+ "parent_folder_id": {
1137
+ "type": ["string", "null"],
1138
+ "minLength": 1
1139
+ }
1140
+ },
1141
+ "additionalProperties": false
1142
+ }
1143
+ }
1144
+ },
1145
+ "publishTemplateVersion": {
1146
+ "body": {
1147
+ "mediaType": "application/json",
1148
+ "required": true,
1149
+ "schema": {
1150
+ "type": "object",
1151
+ "required": ["version_type"],
1152
+ "properties": {
1153
+ "version_type": {
1154
+ "type": "string",
1155
+ "enum": ["major", "minor", "patch"]
1156
+ },
1157
+ "description": {
1158
+ "type": "string",
1159
+ "maxLength": 500
1160
+ }
1161
+ },
1162
+ "additionalProperties": false
1163
+ }
1164
+ }
1165
+ },
1166
+ "renameFolder": {
1167
+ "body": {
1168
+ "mediaType": "application/json",
1169
+ "required": true,
1170
+ "schema": {
1171
+ "type": "object",
1172
+ "properties": {
1173
+ "name": {
1174
+ "type": "string",
1175
+ "minLength": 1,
1176
+ "maxLength": 255,
1177
+ "pattern": "^[^/]*$",
1178
+ "x-pattern-message": "can't contain a slash (/)"
1179
+ }
1180
+ },
1181
+ "required": ["name"],
1182
+ "additionalProperties": false
1183
+ }
1184
+ }
1185
+ },
1186
+ "restoreTemplateVersion": {
1187
+ "body": {
1188
+ "mediaType": "application/json",
1189
+ "required": true,
1190
+ "schema": {
1191
+ "type": "object",
1192
+ "required": ["version"],
1193
+ "properties": {
1194
+ "version": {
1195
+ "type": "string",
1196
+ "pattern": "^\\d+(\\.\\d+(\\.\\d+)?)?$",
1197
+ "x-pattern-message": "must be a published version like 1.2.3 or 1"
1198
+ }
1199
+ },
1200
+ "additionalProperties": false
1201
+ }
1202
+ }
1203
+ },
1204
+ "testAuthentication": {},
1205
+ "updateSignatureRequest": {
1206
+ "body": {
1207
+ "mediaType": "application/json",
1208
+ "required": true,
1209
+ "schema": {
1210
+ "type": "object",
1211
+ "properties": {
1212
+ "metadata": {
1213
+ "type": "object"
1214
+ },
1215
+ "auth_type": {
1216
+ "type": "string",
1217
+ "enum": ["password", "oauth", "email_link", "phone_number", "ldap", "saml"]
1218
+ },
1219
+ "auth_second_factor_type": {
1220
+ "type": "string",
1221
+ "enum": ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"]
1222
+ },
1223
+ "auth_provider": {
1224
+ "type": ["string", "null"],
1225
+ "maxLength": 255
1226
+ },
1227
+ "auth_session_started_at": {
1228
+ "type": ["string", "null"],
1229
+ "format": "date-time"
1230
+ },
1231
+ "auth_session_id_hash": {
1232
+ "type": ["string", "null"]
1233
+ },
1234
+ "auth_user_id_hash": {
1235
+ "type": ["string", "null"]
1236
+ },
1237
+ "auth_username_hash": {
1238
+ "type": ["string", "null"]
1239
+ },
1240
+ "auth_phone_number_hash": {
1241
+ "type": ["string", "null"]
1242
+ }
1243
+ },
1244
+ "additionalProperties": false
1245
+ }
1246
+ }
1247
+ },
1248
+ "updateTemplate": {
1249
+ "body": {
1250
+ "mediaType": "application/json",
1251
+ "required": true,
1252
+ "schema": {
1253
+ "type": "object",
1254
+ "properties": {
1255
+ "name": {
1256
+ "type": "string",
1257
+ "minLength": 1,
1258
+ "maxLength": 255
1259
+ },
1260
+ "description": {
1261
+ "type": ["string", "null"]
1262
+ },
1263
+ "parent_folder_id": {
1264
+ "type": ["string", "null"],
1265
+ "minLength": 1
1266
+ },
1267
+ "locked": {
1268
+ "type": "boolean"
1269
+ },
1270
+ "add_signature_request_submission_id_footers": {
1271
+ "type": "boolean"
1272
+ },
1273
+ "ai_field_naming_language": {
1274
+ "type": "string",
1275
+ "enum": ["auto", "english", "form_language"]
1276
+ },
1277
+ "allow_additional_properties": {
1278
+ "type": "boolean"
1279
+ },
1280
+ "allow_skipping_optional_fields": {
1281
+ "type": "boolean"
1282
+ },
1283
+ "default_form_mode": {
1284
+ "type": "string",
1285
+ "enum": ["web", "visual", "dual"]
1286
+ },
1287
+ "editable_submissions": {
1288
+ "type": "boolean"
1289
+ },
1290
+ "embed_domains": {
1291
+ "type": "array",
1292
+ "maxItems": 100,
1293
+ "items": {
1294
+ "type": "string",
1295
+ "minLength": 1,
1296
+ "maxLength": 255
1297
+ }
1298
+ },
1299
+ "embed_edit_allow_settings": {
1300
+ "type": "boolean"
1301
+ },
1302
+ "embed_edit_allow_versioning": {
1303
+ "type": "boolean"
1304
+ },
1305
+ "embed_edit_allow_document_replacement": {
1306
+ "type": "boolean"
1307
+ },
1308
+ "encrypt_pdfs": {
1309
+ "type": "boolean"
1310
+ },
1311
+ "encrypt_pdfs_password": {
1312
+ "type": ["string", "null"]
1313
+ },
1314
+ "expire_submissions": {
1315
+ "type": "boolean"
1316
+ },
1317
+ "expire_after": {
1318
+ "type": "integer",
1319
+ "minimum": 1,
1320
+ "maximum": 5256000
1321
+ },
1322
+ "expiration_interval": {
1323
+ "type": "string",
1324
+ "enum": ["minutes", "hours", "days"]
1325
+ },
1326
+ "merge_audit_trail_pdf": {
1327
+ "type": "boolean"
1328
+ },
1329
+ "parse_dates_using_template_date_format": {
1330
+ "type": "boolean"
1331
+ },
1332
+ "public_submissions": {
1333
+ "type": "boolean"
1334
+ },
1335
+ "public_web_form": {
1336
+ "type": "boolean"
1337
+ },
1338
+ "redirect_url": {
1339
+ "type": ["string", "null"],
1340
+ "format": "uri"
1341
+ },
1342
+ "slack_webhook_url": {
1343
+ "type": ["string", "null"],
1344
+ "format": "uri"
1345
+ },
1346
+ "defaults": {
1347
+ "type": "object",
1348
+ "properties": {
1349
+ "typeface": {
1350
+ "type": ["string", "null"],
1351
+ "enum": ["Inconsolata", "Roboto Mono", "Ubuntu Mono", "Menlo", "Courier", "Helvetica", "Arial", "Calibri", "Open Sans", "Roboto", "Lato", "Poppins", "Public Sans", "Questrial", "Times New Roman", "Dancing Script", "Lovtony Script", null]
1352
+ },
1353
+ "font_size": {
1354
+ "type": ["integer", "null"],
1355
+ "minimum": 1
1356
+ },
1357
+ "character_spacing": {
1358
+ "type": ["number", "null"],
1359
+ "minimum": 0,
1360
+ "maximum": 50
1361
+ },
1362
+ "color": {
1363
+ "type": ["string", "null"],
1364
+ "pattern": "^[A-Fa-f0-9]{6}$",
1365
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1366
+ },
1367
+ "background_color": {
1368
+ "type": ["string", "null"],
1369
+ "pattern": "^[A-Fa-f0-9]{6}$",
1370
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1371
+ },
1372
+ "bold": {
1373
+ "type": "boolean"
1374
+ },
1375
+ "uppercase": {
1376
+ "type": "boolean"
1377
+ },
1378
+ "alignment": {
1379
+ "type": "string",
1380
+ "enum": ["left", "center", "right", "justify"]
1381
+ },
1382
+ "opacity": {
1383
+ "type": "number",
1384
+ "minimum": 0,
1385
+ "maximum": 1
1386
+ },
1387
+ "date_format": {
1388
+ "type": ["string", "null"]
1389
+ },
1390
+ "date_time_format": {
1391
+ "type": ["string", "null"]
1392
+ },
1393
+ "check_color": {
1394
+ "type": ["string", "null"],
1395
+ "pattern": "^[A-Fa-f0-9]{6}$",
1396
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1397
+ },
1398
+ "check_character": {
1399
+ "type": ["string", "null"],
1400
+ "enum": ["✓", "✔", "✖", "✗", "✘", null]
1401
+ },
1402
+ "check_background_color": {
1403
+ "type": ["string", "null"],
1404
+ "pattern": "^[A-Fa-f0-9]{6}$",
1405
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1406
+ },
1407
+ "required_field_background_color": {
1408
+ "type": ["string", "null"],
1409
+ "pattern": "^[A-Fa-f0-9]{6}$",
1410
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1411
+ },
1412
+ "true_text": {
1413
+ "type": ["string", "null"]
1414
+ },
1415
+ "false_text": {
1416
+ "type": ["string", "null"]
1417
+ },
1418
+ "shape_fill_color": {
1419
+ "type": ["string", "null"],
1420
+ "pattern": "^[A-Fa-f0-9]{6}$",
1421
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1422
+ },
1423
+ "shape_border_color": {
1424
+ "type": ["string", "null"],
1425
+ "pattern": "^[A-Fa-f0-9]{6}$",
1426
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1427
+ },
1428
+ "shape_border_width": {
1429
+ "type": "integer",
1430
+ "minimum": 1
1431
+ }
1432
+ },
1433
+ "additionalProperties": false
1434
+ },
1435
+ "field_dependencies": {
1436
+ "type": "array",
1437
+ "items": {
1438
+ "type": "object",
1439
+ "properties": {
1440
+ "action": {
1441
+ "type": "string",
1442
+ "enum": ["require_and_show", "show", "require"]
1443
+ },
1444
+ "match": {
1445
+ "type": "string",
1446
+ "enum": ["all", "any"]
1447
+ },
1448
+ "conditions": {
1449
+ "type": "array",
1450
+ "items": {
1451
+ "oneOf": [{
1452
+ "$ref": "#/components/schemas/FieldPresenceCondition"
1453
+ }, {
1454
+ "$ref": "#/components/schemas/FieldEqualsCondition"
1455
+ }, {
1456
+ "$ref": "#/components/schemas/FieldInCondition"
1457
+ }, {
1458
+ "$ref": "#/components/schemas/FieldComparisonCondition"
1459
+ }, {
1460
+ "$ref": "#/components/schemas/FieldRangeCondition"
1461
+ }],
1462
+ "discriminator": {
1463
+ "propertyName": "operator",
1464
+ "mapping": [["present", "#/components/schemas/FieldPresenceCondition"], ["blank", "#/components/schemas/FieldPresenceCondition"], ["equals", "#/components/schemas/FieldEqualsCondition"], ["not_equals", "#/components/schemas/FieldEqualsCondition"], ["in", "#/components/schemas/FieldInCondition"], ["gt", "#/components/schemas/FieldComparisonCondition"], ["gte", "#/components/schemas/FieldComparisonCondition"], ["lt", "#/components/schemas/FieldComparisonCondition"], ["lte", "#/components/schemas/FieldComparisonCondition"], ["range", "#/components/schemas/FieldRangeCondition"]]
1465
+ }
1466
+ }
1467
+ },
1468
+ "targets": {
1469
+ "type": "array",
1470
+ "minItems": 1,
1471
+ "items": {
1472
+ "type": "string",
1473
+ "minLength": 1
1474
+ }
1475
+ },
1476
+ "group": {
1477
+ "type": "string"
1478
+ }
1479
+ },
1480
+ "required": ["action", "conditions", "targets"],
1481
+ "additionalProperties": false
1482
+ }
1483
+ },
1484
+ "html": {
1485
+ "type": ["string", "null"]
1486
+ },
1487
+ "scss": {
1488
+ "type": ["string", "null"]
1489
+ },
1490
+ "header_html": {
1491
+ "type": ["string", "null"]
1492
+ },
1493
+ "footer_html": {
1494
+ "type": ["string", "null"]
1495
+ },
1496
+ "html_engine_options": {
1497
+ "type": ["object", "null"],
1498
+ "properties": {
1499
+ "format": {
1500
+ "type": "string",
1501
+ "enum": ["Letter", "Legal", "Tabloid", "Ledger", "CR80", "A0", "A1", "A2", "A3", "A4", "A5", "A6", "Custom"]
1502
+ },
1503
+ "width": {
1504
+ "type": "string"
1505
+ },
1506
+ "height": {
1507
+ "type": "string"
1508
+ },
1509
+ "scale": {
1510
+ "type": "number",
1511
+ "exclusiveMinimum": 0
1512
+ },
1513
+ "landscape": {
1514
+ "type": "boolean"
1515
+ },
1516
+ "print_background": {
1517
+ "type": "boolean"
1518
+ },
1519
+ "margin_top": {
1520
+ "type": "string"
1521
+ },
1522
+ "margin_bottom": {
1523
+ "type": "string"
1524
+ },
1525
+ "margin_left": {
1526
+ "type": "string"
1527
+ },
1528
+ "margin_right": {
1529
+ "type": "string"
1530
+ }
1531
+ },
1532
+ "additionalProperties": false
1533
+ }
1534
+ },
1535
+ "additionalProperties": false
1536
+ }
1537
+ }
1538
+ },
1539
+ "updateTemplateDocument": {
1540
+ "query": {
1541
+ "wait": {
1542
+ "required": false,
1543
+ "schema": {
1544
+ "type": "boolean"
1545
+ }
1546
+ }
1547
+ },
1548
+ "body": {
1549
+ "mediaType": "application/json",
1550
+ "required": true,
1551
+ "schema": {
1552
+ "type": "object",
1553
+ "required": ["cache_id"],
1554
+ "properties": {
1555
+ "cache_id": {
1556
+ "type": "string",
1557
+ "minLength": 1,
1558
+ "maxLength": 255
1559
+ },
1560
+ "filename": {
1561
+ "type": "string",
1562
+ "minLength": 1,
1563
+ "maxLength": 255
1564
+ },
1565
+ "reimport_fields": {
1566
+ "type": "boolean"
1567
+ }
1568
+ },
1569
+ "additionalProperties": false
1570
+ }
1571
+ }
1572
+ },
1573
+ "updateWebhook": {
1574
+ "body": {
1575
+ "mediaType": "application/json",
1576
+ "required": true,
1577
+ "schema": {
1578
+ "type": "object",
1579
+ "properties": {
1580
+ "name": {
1581
+ "type": ["string", "null"],
1582
+ "maxLength": 255
1583
+ },
1584
+ "url": {
1585
+ "type": "string",
1586
+ "format": "uri"
1587
+ },
1588
+ "enabled": {
1589
+ "type": "boolean"
1590
+ },
1591
+ "event_types": {
1592
+ "type": "array",
1593
+ "minItems": 1,
1594
+ "uniqueItems": true,
1595
+ "items": {
1596
+ "type": "string",
1597
+ "enum": ["submission.processed", "submission.failed", "submission.declined", "signature_request.viewed", "signature_request.completed", "signature_request.declined", "combined_pdf.processed", "combined_pdf.failed", "submission_batch.processed", "submission_batch.failed", "submission.created", "submission.updated", "submission.expired", "signature_request.updated", "combined_pdf.expired", "template.created", "template.updated", "template.deleted", "webhook.created", "webhook.updated", "webhook.deleted", "custom_file.created", "folder.created", "folder.updated", "folder.deleted"]
1598
+ }
1599
+ },
1600
+ "mode": {
1601
+ "type": ["string", "null"],
1602
+ "enum": ["test", "live", null]
1603
+ },
1604
+ "api_token_ids": {
1605
+ "type": "array",
1606
+ "uniqueItems": true,
1607
+ "items": {
1608
+ "type": "string"
1609
+ }
1610
+ },
1611
+ "template_ids": {
1612
+ "type": "array",
1613
+ "uniqueItems": true,
1614
+ "items": {
1615
+ "type": "string"
1616
+ }
1617
+ },
1618
+ "folder_ids": {
1619
+ "type": "array",
1620
+ "uniqueItems": true,
1621
+ "items": {
1622
+ "type": "string"
1623
+ }
1624
+ },
1625
+ "include_submission_data": {
1626
+ "type": "boolean"
1627
+ },
1628
+ "strip_fields": {
1629
+ "type": "array",
1630
+ "items": {
1631
+ "type": "string"
1632
+ }
1633
+ },
1634
+ "headers": {
1635
+ "type": "object",
1636
+ "additionalProperties": {
1637
+ "type": "string"
1638
+ }
1639
+ }
1640
+ },
1641
+ "additionalProperties": false
1642
+ }
1643
+ }
1644
+ },
1645
+ "uploadTemplate": {
1646
+ "query": {
1647
+ "wait": {
1648
+ "required": false,
1649
+ "schema": {
1650
+ "type": "boolean"
1651
+ }
1652
+ }
1653
+ },
1654
+ "body": {
1655
+ "mediaType": "multipart/form-data",
1656
+ "required": true,
1657
+ "schema": {
1658
+ "type": "object",
1659
+ "required": ["document"],
1660
+ "properties": {
1661
+ "document": {
1662
+ "type": "string",
1663
+ "format": "binary"
1664
+ },
1665
+ "name": {
1666
+ "type": "string",
1667
+ "minLength": 1,
1668
+ "maxLength": 255
1669
+ },
1670
+ "description": {
1671
+ "type": "string"
1672
+ },
1673
+ "parent_folder_id": {
1674
+ "type": "string",
1675
+ "minLength": 1
1676
+ },
1677
+ "ai_field_naming_language": {
1678
+ "type": "string",
1679
+ "enum": ["auto", "english", "form_language"]
1680
+ },
1681
+ "detect_fields": {
1682
+ "type": "boolean"
1683
+ },
1684
+ "field_source": {
1685
+ "type": "string",
1686
+ "enum": ["auto", "pdf_detection", "pdf_form_fields"]
1687
+ },
1688
+ "field_naming": {
1689
+ "type": "string",
1690
+ "enum": ["ai", "preserve"]
1691
+ },
1692
+ "field_logic": {
1693
+ "type": "string",
1694
+ "enum": ["ai", "none"]
1695
+ }
1696
+ },
1697
+ "additionalProperties": false
1698
+ }
1699
+ }
1700
+ },
1701
+ "uploadTemplateDocument": {
1702
+ "query": {
1703
+ "wait": {
1704
+ "required": false,
1705
+ "schema": {
1706
+ "type": "boolean"
1707
+ }
1708
+ }
1709
+ },
1710
+ "body": {
1711
+ "mediaType": "multipart/form-data",
1712
+ "required": true,
1713
+ "schema": {
1714
+ "type": "object",
1715
+ "required": ["document"],
1716
+ "properties": {
1717
+ "document": {
1718
+ "type": "string",
1719
+ "format": "binary"
1720
+ },
1721
+ "reimport_fields": {
1722
+ "type": "boolean"
1723
+ }
1724
+ },
1725
+ "additionalProperties": false
1726
+ }
1727
+ }
1728
+ }
1729
+ },
1730
+ "routes": {
1731
+ "DELETE /combined_pdfs/{combined_pdf_id}": "expireCombinedPdf",
1732
+ "DELETE /custom_files/{custom_file_id}": "deleteCustomFile",
1733
+ "DELETE /folders/{folder_id}": "deleteFolder",
1734
+ "DELETE /submissions/{submission_id}": "expireSubmission",
1735
+ "DELETE /templates/{template_id}": "deleteTemplate",
1736
+ "DELETE /webhooks/{webhook_id}": "deleteWebhook",
1737
+ "GET /authentication": "testAuthentication",
1738
+ "GET /combined_pdfs": "listCombinedPdfs",
1739
+ "GET /combined_pdfs/{combined_pdf_id}": "getCombinedPdf",
1740
+ "GET /custom_files": "listCustomFiles",
1741
+ "GET /custom_files/{custom_file_id}": "getCustomFile",
1742
+ "GET /folders": "listFolders",
1743
+ "GET /folders/{folder_id}": "getFolder",
1744
+ "GET /signature_requests/{signature_request_id}": "getSignatureRequest",
1745
+ "GET /submissions": "listSubmissions",
1746
+ "GET /submissions/batches/{submission_batch_id}": "getSubmissionBatch",
1747
+ "GET /submissions/{submission_id}": "getSubmission",
1748
+ "GET /templates": "listTemplates",
1749
+ "GET /templates/{template_id}": "getTemplate",
1750
+ "GET /templates/{template_id}/model_code": "getTemplateModelCode",
1751
+ "GET /templates/{template_id}/schema": "getTemplateSchema",
1752
+ "GET /templates/{template_id}/submissions": "listTemplateSubmissions",
1753
+ "GET /uploads/presign": "getPresignUrl",
1754
+ "GET /webhooks": "listWebhooks",
1755
+ "GET /webhooks/{webhook_id}": "getWebhook",
1756
+ "POST /combined_pdfs": "createCombinedPdf",
1757
+ "POST /custom_files": "createCustomFileFromUpload",
1758
+ "POST /folders": "createFolder",
1759
+ "POST /folders/{folder_id}/move": "moveFolder",
1760
+ "POST /folders/{folder_id}/rename": "renameFolder",
1761
+ "POST /signature_requests/{signature_request_id}/events": "createSignatureRequestEvent",
1762
+ "POST /signature_requests/{signature_request_id}/tokens": "createSignatureRequestToken",
1763
+ "POST /submissions/batches": "createSubmissionBatch",
1764
+ "POST /submissions/{submission_id}/generate_preview": "generateSubmissionPreview",
1765
+ "POST /templates": "createTemplate",
1766
+ "POST /templates/upload": "uploadTemplate",
1767
+ "POST /templates/{template_id}/copy": "copyTemplate",
1768
+ "POST /templates/{template_id}/move": "moveTemplate",
1769
+ "POST /templates/{template_id}/publish_version": "publishTemplateVersion",
1770
+ "POST /templates/{template_id}/restore_version": "restoreTemplateVersion",
1771
+ "POST /templates/{template_id}/submissions": "createSubmission",
1772
+ "POST /webhooks": "createWebhook",
1773
+ "PUT /signature_requests/{signature_request_id}": "updateSignatureRequest",
1774
+ "PUT /templates/{template_id}": "updateTemplate",
1775
+ "PUT /templates/{template_id}/document": "updateTemplateDocument",
1776
+ "PUT /templates/{template_id}/document/upload": "uploadTemplateDocument",
1777
+ "PUT /webhooks/{webhook_id}": "updateWebhook"
1778
+ },
1779
+ "components": {
1780
+ "schemas": {
1781
+ "CombinedPdfSourcePdf": {
1782
+ "type": "object",
1783
+ "required": ["type", "id"],
1784
+ "properties": {
1785
+ "type": {
1786
+ "type": "string",
1787
+ "const": "combined_pdf"
1788
+ },
1789
+ "id": {
1790
+ "type": "string",
1791
+ "minLength": 1
1792
+ }
1793
+ },
1794
+ "additionalProperties": false,
1795
+ "x-not-allowed-properties": {
1796
+ "url": "isn't used by 'combined_pdf' source PDFs. Remove it",
1797
+ "template_version": "isn't used by 'combined_pdf' source PDFs. Remove it",
1798
+ "processed": "isn't used by 'combined_pdf' source PDFs. Remove it"
1799
+ }
1800
+ },
1801
+ "CustomFileSourcePdf": {
1802
+ "type": "object",
1803
+ "required": ["type", "id"],
1804
+ "properties": {
1805
+ "type": {
1806
+ "type": "string",
1807
+ "const": "custom_file"
1808
+ },
1809
+ "id": {
1810
+ "type": "string",
1811
+ "minLength": 1
1812
+ }
1813
+ },
1814
+ "additionalProperties": false,
1815
+ "x-not-allowed-properties": {
1816
+ "url": "isn't used by 'custom_file' source PDFs. Remove it",
1817
+ "template_version": "isn't used by 'custom_file' source PDFs. Remove it",
1818
+ "processed": "isn't used by 'custom_file' source PDFs. Remove it"
1819
+ }
1820
+ },
1821
+ "FieldComparisonCondition": {
1822
+ "type": "object",
1823
+ "required": ["field", "operator", "value"],
1824
+ "properties": {
1825
+ "field": {
1826
+ "type": "string"
1827
+ },
1828
+ "operator": {
1829
+ "type": "string",
1830
+ "enum": ["gt", "gte", "lt", "lte"]
1831
+ },
1832
+ "value": {
1833
+ "type": ["number", "string"],
1834
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
1835
+ "x-pattern-message": "must be a number, like 10 or 2.5"
1836
+ }
1837
+ },
1838
+ "additionalProperties": false,
1839
+ "x-not-allowed-properties": {
1840
+ "range_max": "isn't used by 'gt', 'gte', 'lt' or 'lte' conditions. Remove it"
1841
+ }
1842
+ },
1843
+ "FieldEqualsCondition": {
1844
+ "type": "object",
1845
+ "required": ["field", "operator", "value"],
1846
+ "properties": {
1847
+ "field": {
1848
+ "type": "string"
1849
+ },
1850
+ "operator": {
1851
+ "type": "string",
1852
+ "enum": ["equals", "not_equals"]
1853
+ },
1854
+ "value": {
1855
+ "type": ["string", "number", "boolean"]
1856
+ }
1857
+ },
1858
+ "additionalProperties": false,
1859
+ "x-not-allowed-properties": {
1860
+ "range_max": "isn't used by 'equals' or 'not_equals' conditions. Remove it"
1861
+ }
1862
+ },
1863
+ "FieldInCondition": {
1864
+ "type": "object",
1865
+ "required": ["field", "operator", "value"],
1866
+ "properties": {
1867
+ "field": {
1868
+ "type": "string"
1869
+ },
1870
+ "operator": {
1871
+ "type": "string",
1872
+ "const": "in"
1873
+ },
1874
+ "value": {
1875
+ "type": "array",
1876
+ "minItems": 1,
1877
+ "items": {
1878
+ "type": ["string", "number", "boolean"],
1879
+ "minLength": 1
1880
+ }
1881
+ }
1882
+ },
1883
+ "additionalProperties": false,
1884
+ "x-not-allowed-properties": {
1885
+ "range_max": "isn't used by 'in' conditions. Remove it"
1886
+ }
1887
+ },
1888
+ "FieldOverride": {
1889
+ "type": "object",
1890
+ "properties": {
1891
+ "static": {
1892
+ "type": "boolean"
1893
+ },
1894
+ "editable": {
1895
+ "type": "boolean"
1896
+ },
1897
+ "default": {
1898
+ "type": ["string", "null"]
1899
+ },
1900
+ "title": {
1901
+ "type": "string"
1902
+ },
1903
+ "required": {
1904
+ "type": "boolean"
1905
+ },
1906
+ "option_list": {
1907
+ "type": ["string", "null"]
1908
+ },
1909
+ "combined_field_names": {
1910
+ "type": "string"
1911
+ },
1912
+ "combined_field_type": {
1913
+ "type": "string",
1914
+ "enum": ["separator", "format"]
1915
+ },
1916
+ "combined_field_separator": {
1917
+ "type": "string"
1918
+ },
1919
+ "combined_field_format": {
1920
+ "type": "string"
1921
+ },
1922
+ "integer": {
1923
+ "type": "boolean"
1924
+ },
1925
+ "include_time": {
1926
+ "type": ["boolean", "null"]
1927
+ },
1928
+ "signature_allow_draw": {
1929
+ "type": "boolean"
1930
+ },
1931
+ "signature_allow_type": {
1932
+ "type": "boolean"
1933
+ },
1934
+ "barcode_symbology": {
1935
+ "type": "string",
1936
+ "enum": ["code_25", "code_39", "code_93", "code_128", "ean_13", "ean_8", "upc_a", "pdf417"]
1937
+ },
1938
+ "hidden": {
1939
+ "type": "boolean"
1940
+ },
1941
+ "x": {
1942
+ "type": "number",
1943
+ "minimum": 0
1944
+ },
1945
+ "y": {
1946
+ "type": "number",
1947
+ "minimum": 0
1948
+ },
1949
+ "width": {
1950
+ "type": "number",
1951
+ "exclusiveMinimum": 0
1952
+ },
1953
+ "height": {
1954
+ "type": "number",
1955
+ "exclusiveMinimum": 0
1956
+ },
1957
+ "rotation": {
1958
+ "type": "number",
1959
+ "minimum": -360,
1960
+ "maximum": 360
1961
+ },
1962
+ "display_type": {
1963
+ "type": "string",
1964
+ "enum": ["text", "check", "qrcode", "barcode", "image", "shape"]
1965
+ },
1966
+ "opacity": {
1967
+ "type": "number",
1968
+ "minimum": 0,
1969
+ "maximum": 1
1970
+ },
1971
+ "date_time_format": {
1972
+ "type": ["string", "null"]
1973
+ },
1974
+ "typeface": {
1975
+ "type": ["string", "null"],
1976
+ "enum": ["Inconsolata", "Roboto Mono", "Ubuntu Mono", "Menlo", "Courier", "Helvetica", "Arial", "Calibri", "Open Sans", "Roboto", "Lato", "Poppins", "Public Sans", "Questrial", "Times New Roman", "Dancing Script", "Lovtony Script", null]
1977
+ },
1978
+ "font_size": {
1979
+ "type": ["integer", "null"],
1980
+ "minimum": 1
1981
+ },
1982
+ "character_spacing": {
1983
+ "type": "number",
1984
+ "minimum": 0,
1985
+ "maximum": 50
1986
+ },
1987
+ "bold": {
1988
+ "type": "boolean"
1989
+ },
1990
+ "uppercase": {
1991
+ "type": "boolean"
1992
+ },
1993
+ "strikethrough": {
1994
+ "type": "boolean"
1995
+ },
1996
+ "keep_leading_spaces": {
1997
+ "type": "boolean"
1998
+ },
1999
+ "overflow": {
2000
+ "type": "string",
2001
+ "enum": ["shrink_to_fit", "truncate"]
2002
+ },
2003
+ "multiline": {
2004
+ "type": "boolean"
2005
+ },
2006
+ "multiline_lines": {
2007
+ "type": ["integer", "null"],
2008
+ "minimum": 1,
2009
+ "maximum": 300
2010
+ },
2011
+ "max_length": {
2012
+ "type": ["integer", "null"],
2013
+ "minimum": 0
2014
+ },
2015
+ "color": {
2016
+ "type": ["string", "null"],
2017
+ "pattern": "^[A-Fa-f0-9]{6}$",
2018
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2019
+ },
2020
+ "background_color": {
2021
+ "type": ["string", "null"],
2022
+ "pattern": "^[A-Fa-f0-9]{6}$",
2023
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2024
+ },
2025
+ "alignment": {
2026
+ "type": "string",
2027
+ "enum": ["left", "center", "right", "justify"]
2028
+ },
2029
+ "v_alignment": {
2030
+ "type": "string",
2031
+ "enum": ["bottom", "center", "top"]
2032
+ },
2033
+ "comb": {
2034
+ "type": "boolean"
2035
+ },
2036
+ "comb_number_of_cells": {
2037
+ "type": "integer",
2038
+ "minimum": 1
2039
+ },
2040
+ "comb_value_offset": {
2041
+ "type": "integer",
2042
+ "minimum": 0
2043
+ },
2044
+ "shape_type": {
2045
+ "type": "string",
2046
+ "enum": ["square", "rectangle", "circle", "ellipse", "triangle", "polygon"]
2047
+ },
2048
+ "shape_sides": {
2049
+ "type": "integer",
2050
+ "minimum": 3,
2051
+ "maximum": 12
2052
+ },
2053
+ "shape_border_width": {
2054
+ "type": "integer",
2055
+ "minimum": 1
2056
+ },
2057
+ "shape_border_color": {
2058
+ "type": "string",
2059
+ "pattern": "^[A-Fa-f0-9]{6}$",
2060
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2061
+ },
2062
+ "shape_fill_color": {
2063
+ "type": ["string", "null"],
2064
+ "pattern": "^[A-Fa-f0-9]{6}$",
2065
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2066
+ },
2067
+ "check_character": {
2068
+ "type": "string",
2069
+ "enum": ["✓", "✔", "✖", "✗", "✘"]
2070
+ },
2071
+ "check_color": {
2072
+ "type": ["string", "null"],
2073
+ "pattern": "^[A-Fa-f0-9]{6}$",
2074
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2075
+ },
2076
+ "qrcode_color": {
2077
+ "type": ["string", "null"],
2078
+ "pattern": "^[A-Fa-f0-9]{6}$",
2079
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2080
+ },
2081
+ "true_text": {
2082
+ "type": ["string", "null"]
2083
+ },
2084
+ "false_text": {
2085
+ "type": ["string", "null"]
2086
+ },
2087
+ "condition": {
2088
+ "type": ["string", "null"]
2089
+ },
2090
+ "string_condition_type": {
2091
+ "type": "string",
2092
+ "enum": ["equals", "contains", "starts_with", "ends_with", "regex"]
2093
+ },
2094
+ "number_condition_type": {
2095
+ "type": "string",
2096
+ "enum": ["equals", "range", "gte", "gt", "lte", "lt"]
2097
+ },
2098
+ "number_condition_range_min": {
2099
+ "type": ["number", "null"]
2100
+ },
2101
+ "number_condition_range_max": {
2102
+ "type": ["number", "null"]
2103
+ },
2104
+ "number_condition_range_exclusive_min": {
2105
+ "type": "boolean"
2106
+ },
2107
+ "number_condition_range_exclusive_max": {
2108
+ "type": "boolean"
2109
+ },
2110
+ "invert_boolean_condition": {
2111
+ "type": "boolean"
2112
+ },
2113
+ "decimal_places": {
2114
+ "type": ["integer", "null"],
2115
+ "minimum": 0,
2116
+ "maximum": 99
2117
+ },
2118
+ "image_scale_type": {
2119
+ "type": "string",
2120
+ "enum": ["fit", "fill", "stretch"]
2121
+ },
2122
+ "image_gravity": {
2123
+ "type": "string",
2124
+ "enum": ["NorthWest", "North", "NorthEast", "West", "Center", "East", "SouthWest", "South", "SouthEast"]
2125
+ }
2126
+ },
2127
+ "x-unknown-property-message": "isn't a field setting",
2128
+ "x-not-allowed-properties": {
2129
+ "id": "can't be changed for one submission. Change the field in the template",
2130
+ "name": "can't be changed for one submission. Change the field in the template",
2131
+ "type": "can't be changed for one submission. Change the field in the template",
2132
+ "field_count": "can't be changed for one submission. Change the field in the template",
2133
+ "fieldCount": "can't be changed for one submission. Change the field in the template",
2134
+ "dependencies": "can't be changed for one submission. Change the field in the template",
2135
+ "acroform_name": "can't be changed for one submission. Change the field in the template",
2136
+ "allow_additional_items": "can't be changed for one submission. Change the field in the template",
2137
+ "allowAdditionalItems": "can't be changed for one submission. Change the field in the template",
2138
+ "min_items": "can't be changed for one submission. Change the field in the template",
2139
+ "minItems": "can't be changed for one submission. Change the field in the template",
2140
+ "max_items": "can't be changed for one submission. Change the field in the template",
2141
+ "maxItems": "can't be changed for one submission. Change the field in the template",
2142
+ "description": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2143
+ "placeholder": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2144
+ "metadata": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2145
+ "minimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2146
+ "maximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2147
+ "exclusive_minimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2148
+ "exclusiveMinimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2149
+ "exclusive_maximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2150
+ "exclusiveMaximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2151
+ "currency": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2152
+ "min_length": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2153
+ "minLength": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2154
+ "auto_calculate_max_length": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2155
+ "autoCalculateMaxLength": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2156
+ "color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2157
+ "colorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2158
+ "color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2159
+ "colorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2160
+ "background_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2161
+ "backgroundColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2162
+ "background_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2163
+ "backgroundColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2164
+ "check_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2165
+ "checkColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2166
+ "check_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2167
+ "checkColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2168
+ "qrcode_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2169
+ "qrcodeColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2170
+ "qrcode_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2171
+ "qrcodeColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2172
+ "shape_border_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2173
+ "shapeBorderColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2174
+ "shape_border_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2175
+ "shapeBorderColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2176
+ "shape_fill_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2177
+ "shapeFillColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2178
+ "shape_fill_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
2179
+ "shapeFillColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template"
2180
+ },
2181
+ "additionalProperties": false
2182
+ },
2183
+ "FieldPresenceCondition": {
2184
+ "type": "object",
2185
+ "required": ["field", "operator"],
2186
+ "properties": {
2187
+ "field": {
2188
+ "type": "string"
2189
+ },
2190
+ "operator": {
2191
+ "type": "string",
2192
+ "enum": ["present", "blank"]
2193
+ }
2194
+ },
2195
+ "additionalProperties": false,
2196
+ "x-not-allowed-properties": {
2197
+ "value": "isn't used by 'present' or 'blank' conditions. Remove it",
2198
+ "range_max": "isn't used by 'present' or 'blank' conditions. Remove it"
2199
+ }
2200
+ },
2201
+ "FieldRangeCondition": {
2202
+ "type": "object",
2203
+ "required": ["field", "operator"],
2204
+ "properties": {
2205
+ "field": {
2206
+ "type": "string"
2207
+ },
2208
+ "operator": {
2209
+ "type": "string",
2210
+ "const": "range"
2211
+ },
2212
+ "value": {
2213
+ "type": ["number", "string", "null"],
2214
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
2215
+ "x-pattern-message": "must be a number, like 10 or 2.5"
2216
+ },
2217
+ "range_max": {
2218
+ "type": ["number", "string", "null"],
2219
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
2220
+ "x-pattern-message": "must be a number, like 10 or 2.5"
2221
+ }
2222
+ },
2223
+ "additionalProperties": false
2224
+ },
2225
+ "SubmissionSourcePdf": {
2226
+ "type": "object",
2227
+ "required": ["type", "id"],
2228
+ "properties": {
2229
+ "type": {
2230
+ "type": "string",
2231
+ "const": "submission"
2232
+ },
2233
+ "id": {
2234
+ "type": "string",
2235
+ "minLength": 1
2236
+ }
2237
+ },
2238
+ "additionalProperties": false,
2239
+ "x-not-allowed-properties": {
2240
+ "url": "isn't used by 'submission' source PDFs. Remove it",
2241
+ "template_version": "isn't used by 'submission' source PDFs. Remove it",
2242
+ "processed": "isn't used by 'submission' source PDFs. Remove it"
2243
+ }
2244
+ },
2245
+ "TemplateSourcePdf": {
2246
+ "type": "object",
2247
+ "required": ["type", "id"],
2248
+ "properties": {
2249
+ "type": {
2250
+ "type": "string",
2251
+ "const": "template"
2252
+ },
2253
+ "id": {
2254
+ "type": "string",
2255
+ "minLength": 1
2256
+ },
2257
+ "template_version": {
2258
+ "type": "string",
2259
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
2260
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
2261
+ },
2262
+ "processed": {
2263
+ "type": "boolean"
2264
+ }
2265
+ },
2266
+ "additionalProperties": false,
2267
+ "x-not-allowed-properties": {
2268
+ "url": "isn't used by 'template' source PDFs. Remove it"
2269
+ }
2270
+ },
2271
+ "UrlSourcePdf": {
2272
+ "type": "object",
2273
+ "required": ["type", "url"],
2274
+ "properties": {
2275
+ "type": {
2276
+ "type": "string",
2277
+ "const": "url"
2278
+ },
2279
+ "url": {
2280
+ "type": "string",
2281
+ "format": "uri"
2282
+ }
2283
+ },
2284
+ "additionalProperties": false,
2285
+ "x-not-allowed-properties": {
2286
+ "id": "isn't used by 'url' source PDFs. Remove it",
2287
+ "template_version": "isn't used by 'url' source PDFs. Remove it",
2288
+ "processed": "isn't used by 'url' source PDFs. Remove it"
2289
+ }
2290
+ }
2291
+ }
2292
+ },
2293
+ "formatMessages": {
2294
+ "uri": "must be a full URL, like https://example.com",
2295
+ "date-time": "must be a date and time in RFC 3339 format, like 2026-10-20T09:00:00Z"
2296
+ }
2297
+ };