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
package/dist/RequestSchemas.js ADDED
@@ -0,0 +1,3452 @@
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
+ "addTemplateFields": {
11
+ "body": {
12
+ "mediaType": "application/json",
13
+ "required": true,
14
+ "schema": {
15
+ "type": "object",
16
+ "required": ["fields"],
17
+ "properties": {
18
+ "fields": {
19
+ "type": "array",
20
+ "minItems": 1,
21
+ "maxItems": 1000,
22
+ "items": {
23
+ "type": "object",
24
+ "properties": {
25
+ "name": {
26
+ "type": ["string", "null"]
27
+ },
28
+ "page": {
29
+ "type": "integer",
30
+ "minimum": 1
31
+ },
32
+ "type": {
33
+ "type": "string",
34
+ "enum": ["string", "number", "boolean", "date", "address", "country", "email", "url", "image", "signature", "initials", "barcode", "combined"]
35
+ },
36
+ "static": {
37
+ "type": "boolean"
38
+ },
39
+ "editable": {
40
+ "type": "boolean"
41
+ },
42
+ "default": {
43
+ "type": ["string", "null"]
44
+ },
45
+ "title": {
46
+ "type": "string"
47
+ },
48
+ "description": {
49
+ "type": "string"
50
+ },
51
+ "placeholder": {
52
+ "type": "string"
53
+ },
54
+ "metadata": {
55
+ "type": "string"
56
+ },
57
+ "required": {
58
+ "type": "boolean"
59
+ },
60
+ "option_list": {
61
+ "type": ["string", "null"]
62
+ },
63
+ "combined_field_names": {
64
+ "type": "string"
65
+ },
66
+ "combined_field_type": {
67
+ "type": "string",
68
+ "enum": ["separator", "format"]
69
+ },
70
+ "combined_field_separator": {
71
+ "type": "string"
72
+ },
73
+ "combined_field_format": {
74
+ "type": "string"
75
+ },
76
+ "integer": {
77
+ "type": "boolean"
78
+ },
79
+ "minimum": {
80
+ "type": ["number", "null"]
81
+ },
82
+ "maximum": {
83
+ "type": ["number", "null"]
84
+ },
85
+ "exclusive_minimum": {
86
+ "type": "boolean"
87
+ },
88
+ "exclusive_maximum": {
89
+ "type": "boolean"
90
+ },
91
+ "include_time": {
92
+ "type": ["boolean", "null"]
93
+ },
94
+ "signature_allow_draw": {
95
+ "type": "boolean"
96
+ },
97
+ "signature_allow_type": {
98
+ "type": "boolean"
99
+ },
100
+ "barcode_symbology": {
101
+ "type": "string",
102
+ "enum": ["code_25", "code_39", "code_93", "code_128", "ean_13", "ean_8", "upc_a", "pdf417"]
103
+ },
104
+ "hidden": {
105
+ "type": "boolean"
106
+ },
107
+ "x": {
108
+ "type": "number",
109
+ "minimum": 0
110
+ },
111
+ "y": {
112
+ "type": "number",
113
+ "minimum": 0
114
+ },
115
+ "width": {
116
+ "type": "number",
117
+ "exclusiveMinimum": 0
118
+ },
119
+ "height": {
120
+ "type": "number",
121
+ "exclusiveMinimum": 0
122
+ },
123
+ "rotation": {
124
+ "type": "number",
125
+ "minimum": -360,
126
+ "maximum": 360
127
+ },
128
+ "display_type": {
129
+ "type": "string",
130
+ "enum": ["text", "check", "qrcode", "barcode", "image", "shape"]
131
+ },
132
+ "opacity": {
133
+ "type": "number",
134
+ "minimum": 0,
135
+ "maximum": 1
136
+ },
137
+ "date_time_format": {
138
+ "type": ["string", "null"]
139
+ },
140
+ "typeface": {
141
+ "type": ["string", "null"],
142
+ "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]
143
+ },
144
+ "font_size": {
145
+ "type": ["integer", "null"],
146
+ "minimum": 1
147
+ },
148
+ "character_spacing": {
149
+ "type": "number",
150
+ "minimum": 0,
151
+ "maximum": 50
152
+ },
153
+ "bold": {
154
+ "type": "boolean"
155
+ },
156
+ "uppercase": {
157
+ "type": "boolean"
158
+ },
159
+ "strikethrough": {
160
+ "type": "boolean"
161
+ },
162
+ "keep_leading_spaces": {
163
+ "type": "boolean"
164
+ },
165
+ "overflow": {
166
+ "type": "string",
167
+ "enum": ["shrink_to_fit", "truncate"]
168
+ },
169
+ "multiline": {
170
+ "type": "boolean"
171
+ },
172
+ "multiline_lines": {
173
+ "type": ["integer", "null"],
174
+ "minimum": 1,
175
+ "maximum": 300
176
+ },
177
+ "min_length": {
178
+ "type": "number"
179
+ },
180
+ "max_length": {
181
+ "type": ["integer", "null"],
182
+ "minimum": 0
183
+ },
184
+ "auto_calculate_max_length": {
185
+ "type": "boolean"
186
+ },
187
+ "color": {
188
+ "type": ["string", "null"],
189
+ "pattern": "^[A-Fa-f0-9]{6}$",
190
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
191
+ },
192
+ "color_field_name": {
193
+ "type": ["string", "null"]
194
+ },
195
+ "color_field_required": {
196
+ "type": "boolean"
197
+ },
198
+ "background_color": {
199
+ "type": ["string", "null"],
200
+ "pattern": "^[A-Fa-f0-9]{6}$",
201
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
202
+ },
203
+ "background_color_field_name": {
204
+ "type": ["string", "null"]
205
+ },
206
+ "background_color_field_required": {
207
+ "type": "boolean"
208
+ },
209
+ "alignment": {
210
+ "type": "string",
211
+ "enum": ["left", "center", "right", "justify"]
212
+ },
213
+ "v_alignment": {
214
+ "type": "string",
215
+ "enum": ["bottom", "center", "top"]
216
+ },
217
+ "comb": {
218
+ "type": "boolean"
219
+ },
220
+ "comb_number_of_cells": {
221
+ "type": "integer",
222
+ "minimum": 1
223
+ },
224
+ "comb_value_offset": {
225
+ "type": "integer",
226
+ "minimum": 0
227
+ },
228
+ "shape_type": {
229
+ "type": "string",
230
+ "enum": ["square", "rectangle", "circle", "ellipse", "triangle", "polygon"]
231
+ },
232
+ "shape_sides": {
233
+ "type": "integer",
234
+ "minimum": 3,
235
+ "maximum": 12
236
+ },
237
+ "shape_border_width": {
238
+ "type": "integer",
239
+ "minimum": 1
240
+ },
241
+ "shape_border_color": {
242
+ "type": "string",
243
+ "pattern": "^[A-Fa-f0-9]{6}$",
244
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
245
+ },
246
+ "shape_border_color_field_name": {
247
+ "type": ["string", "null"]
248
+ },
249
+ "shape_border_color_field_required": {
250
+ "type": "boolean"
251
+ },
252
+ "shape_fill_color": {
253
+ "type": ["string", "null"],
254
+ "pattern": "^[A-Fa-f0-9]{6}$",
255
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
256
+ },
257
+ "shape_fill_color_field_name": {
258
+ "type": ["string", "null"]
259
+ },
260
+ "shape_fill_color_field_required": {
261
+ "type": "boolean"
262
+ },
263
+ "check_character": {
264
+ "type": "string",
265
+ "enum": ["✓", "✔", "✖", "✗", "✘"]
266
+ },
267
+ "check_color": {
268
+ "type": ["string", "null"],
269
+ "pattern": "^[A-Fa-f0-9]{6}$",
270
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
271
+ },
272
+ "check_color_field_name": {
273
+ "type": ["string", "null"]
274
+ },
275
+ "check_color_field_required": {
276
+ "type": "boolean"
277
+ },
278
+ "qrcode_color": {
279
+ "type": ["string", "null"],
280
+ "pattern": "^[A-Fa-f0-9]{6}$",
281
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
282
+ },
283
+ "qrcode_color_field_name": {
284
+ "type": ["string", "null"]
285
+ },
286
+ "qrcode_color_field_required": {
287
+ "type": "boolean"
288
+ },
289
+ "true_text": {
290
+ "type": ["string", "null"]
291
+ },
292
+ "false_text": {
293
+ "type": ["string", "null"]
294
+ },
295
+ "condition": {
296
+ "type": ["string", "null"]
297
+ },
298
+ "string_condition_type": {
299
+ "type": "string",
300
+ "enum": ["equals", "contains", "starts_with", "ends_with", "regex"]
301
+ },
302
+ "number_condition_type": {
303
+ "type": "string",
304
+ "enum": ["equals", "range", "gte", "gt", "lte", "lt"]
305
+ },
306
+ "number_condition_range_min": {
307
+ "type": ["number", "null"]
308
+ },
309
+ "number_condition_range_max": {
310
+ "type": ["number", "null"]
311
+ },
312
+ "number_condition_range_exclusive_min": {
313
+ "type": "boolean"
314
+ },
315
+ "number_condition_range_exclusive_max": {
316
+ "type": "boolean"
317
+ },
318
+ "invert_boolean_condition": {
319
+ "type": "boolean"
320
+ },
321
+ "currency": {
322
+ "type": "boolean"
323
+ },
324
+ "decimal_places": {
325
+ "type": ["integer", "null"],
326
+ "minimum": 0,
327
+ "maximum": 99
328
+ },
329
+ "image_scale_type": {
330
+ "type": "string",
331
+ "enum": ["fit", "fill", "stretch"]
332
+ },
333
+ "image_gravity": {
334
+ "type": "string",
335
+ "enum": ["NorthWest", "North", "NorthEast", "West", "Center", "East", "SouthWest", "South", "SouthEast"]
336
+ },
337
+ "dependencies": {
338
+ "type": ["object", "null"],
339
+ "required": ["action", "conditions"],
340
+ "properties": {
341
+ "action": {
342
+ "type": "string",
343
+ "enum": ["require_and_show", "show", "require"]
344
+ },
345
+ "match": {
346
+ "type": "string",
347
+ "enum": ["all", "any"]
348
+ },
349
+ "conditions": {
350
+ "type": "array",
351
+ "items": {
352
+ "oneOf": [{
353
+ "$ref": "#/components/schemas/FieldPresenceCondition"
354
+ }, {
355
+ "$ref": "#/components/schemas/FieldEqualsCondition"
356
+ }, {
357
+ "$ref": "#/components/schemas/FieldInCondition"
358
+ }, {
359
+ "$ref": "#/components/schemas/FieldComparisonCondition"
360
+ }, {
361
+ "$ref": "#/components/schemas/FieldRangeCondition"
362
+ }],
363
+ "discriminator": {
364
+ "propertyName": "operator",
365
+ "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"]]
366
+ }
367
+ }
368
+ }
369
+ },
370
+ "additionalProperties": false
371
+ },
372
+ "id": {
373
+ "type": "integer",
374
+ "minimum": 0
375
+ }
376
+ },
377
+ "additionalProperties": false
378
+ }
379
+ }
380
+ },
381
+ "additionalProperties": false
382
+ }
383
+ }
384
+ },
385
+ "copyTemplate": {
386
+ "body": {
387
+ "mediaType": "application/json",
388
+ "required": false,
389
+ "schema": {
390
+ "type": "object",
391
+ "properties": {
392
+ "name": {
393
+ "type": "string",
394
+ "minLength": 1,
395
+ "maxLength": 255
396
+ },
397
+ "parent_folder_id": {
398
+ "type": ["string", "null"],
399
+ "minLength": 1
400
+ },
401
+ "version": {
402
+ "type": "string",
403
+ "pattern": "^\\d+(\\.\\d+(\\.\\d+)?)?$",
404
+ "x-pattern-message": "must be a published version like 1.2.3 or 1"
405
+ }
406
+ },
407
+ "additionalProperties": false
408
+ }
409
+ }
410
+ },
411
+ "createCombinedPdf": {
412
+ "query": {
413
+ "wait": {
414
+ "required": false,
415
+ "schema": {
416
+ "type": "boolean"
417
+ }
418
+ }
419
+ },
420
+ "body": {
421
+ "mediaType": "application/json",
422
+ "required": true,
423
+ "schema": {
424
+ "type": "object",
425
+ "properties": {
426
+ "source_pdfs": {
427
+ "type": "array",
428
+ "minItems": 1,
429
+ "items": {
430
+ "oneOf": [{
431
+ "$ref": "#/components/schemas/SubmissionSourcePdf"
432
+ }, {
433
+ "$ref": "#/components/schemas/CombinedPdfSourcePdf"
434
+ }, {
435
+ "$ref": "#/components/schemas/TemplateSourcePdf"
436
+ }, {
437
+ "$ref": "#/components/schemas/CustomFileSourcePdf"
438
+ }, {
439
+ "$ref": "#/components/schemas/UrlSourcePdf"
440
+ }],
441
+ "discriminator": {
442
+ "propertyName": "type",
443
+ "mapping": [["submission", "#/components/schemas/SubmissionSourcePdf"], ["combined_pdf", "#/components/schemas/CombinedPdfSourcePdf"], ["template", "#/components/schemas/TemplateSourcePdf"], ["custom_file", "#/components/schemas/CustomFileSourcePdf"], ["url", "#/components/schemas/UrlSourcePdf"]]
444
+ }
445
+ }
446
+ },
447
+ "metadata": {
448
+ "type": "object"
449
+ },
450
+ "password": {
451
+ "type": "string",
452
+ "minLength": 1
453
+ },
454
+ "delete_custom_files": {
455
+ "type": "boolean"
456
+ },
457
+ "expires_in": {
458
+ "type": "integer",
459
+ "minimum": 1,
460
+ "maximum": 315360000
461
+ }
462
+ },
463
+ "required": ["source_pdfs"],
464
+ "additionalProperties": false
465
+ }
466
+ }
467
+ },
468
+ "createCustomFileFromUpload": {
469
+ "body": {
470
+ "mediaType": "application/json",
471
+ "required": true,
472
+ "schema": {
473
+ "type": "object",
474
+ "required": ["cache_id"],
475
+ "properties": {
476
+ "cache_id": {
477
+ "type": "string",
478
+ "minLength": 1,
479
+ "maxLength": 255
480
+ }
481
+ },
482
+ "additionalProperties": false
483
+ }
484
+ }
485
+ },
486
+ "createFolder": {
487
+ "body": {
488
+ "mediaType": "application/json",
489
+ "required": true,
490
+ "schema": {
491
+ "type": "object",
492
+ "properties": {
493
+ "name": {
494
+ "type": "string",
495
+ "minLength": 1,
496
+ "maxLength": 255,
497
+ "pattern": "^[^/]*$",
498
+ "x-pattern-message": "can't contain a slash (/)"
499
+ },
500
+ "parent_folder_id": {
501
+ "type": ["string", "null"],
502
+ "minLength": 1
503
+ }
504
+ },
505
+ "required": ["name"],
506
+ "additionalProperties": false
507
+ }
508
+ }
509
+ },
510
+ "createSignatureRequestEvent": {
511
+ "body": {
512
+ "mediaType": "application/json",
513
+ "required": true,
514
+ "schema": {
515
+ "type": "object",
516
+ "properties": {
517
+ "event_type": {
518
+ "type": "string",
519
+ "enum": ["send_request"]
520
+ },
521
+ "message_type": {
522
+ "type": ["string", "null"],
523
+ "enum": ["email", "sms", "fax", "mail", "slack", "msteams", "discord", "telegram", "whatsapp", null]
524
+ },
525
+ "message_recipient": {
526
+ "type": ["string", "null"],
527
+ "maxLength": 255
528
+ },
529
+ "occurred_at": {
530
+ "type": "string",
531
+ "format": "date-time"
532
+ }
533
+ },
534
+ "required": ["event_type"],
535
+ "additionalProperties": false
536
+ }
537
+ }
538
+ },
539
+ "createSignatureRequestToken": {
540
+ "body": {
541
+ "mediaType": "application/json",
542
+ "required": false,
543
+ "schema": {
544
+ "type": "object",
545
+ "properties": {
546
+ "type": {
547
+ "type": "string",
548
+ "enum": ["api", "email"]
549
+ }
550
+ },
551
+ "additionalProperties": false
552
+ }
553
+ }
554
+ },
555
+ "createSubmission": {
556
+ "query": {
557
+ "version": {
558
+ "required": false,
559
+ "schema": {
560
+ "type": "string",
561
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
562
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
563
+ }
564
+ },
565
+ "wait": {
566
+ "required": false,
567
+ "schema": {
568
+ "type": "boolean"
569
+ }
570
+ }
571
+ },
572
+ "body": {
573
+ "mediaType": "application/json",
574
+ "required": true,
575
+ "schema": {
576
+ "type": "object",
577
+ "properties": {
578
+ "test": {
579
+ "type": "boolean"
580
+ },
581
+ "editable": {
582
+ "type": "boolean"
583
+ },
584
+ "data": {
585
+ "type": "object"
586
+ },
587
+ "metadata": {
588
+ "type": "object"
589
+ },
590
+ "password": {
591
+ "type": "string",
592
+ "minLength": 1
593
+ },
594
+ "output_formats": {
595
+ "type": "array",
596
+ "minItems": 1,
597
+ "uniqueItems": true,
598
+ "items": {
599
+ "type": "string",
600
+ "enum": ["pdf", "png"]
601
+ }
602
+ },
603
+ "expires_in": {
604
+ "type": "integer",
605
+ "minimum": 1,
606
+ "maximum": 315360000
607
+ },
608
+ "field_overrides": {
609
+ "type": "object",
610
+ "additionalProperties": {
611
+ "$ref": "#/components/schemas/FieldOverride"
612
+ }
613
+ },
614
+ "html": {
615
+ "type": "string"
616
+ },
617
+ "css": {
618
+ "type": "string"
619
+ },
620
+ "signature_requests": {
621
+ "type": "array",
622
+ "maxItems": 100,
623
+ "items": {
624
+ "type": "object",
625
+ "properties": {
626
+ "name": {
627
+ "type": ["string", "null"],
628
+ "maxLength": 255
629
+ },
630
+ "email": {
631
+ "type": ["string", "null"],
632
+ "maxLength": 255
633
+ },
634
+ "fields": {
635
+ "type": "array",
636
+ "minItems": 1,
637
+ "uniqueItems": true,
638
+ "items": {
639
+ "type": "string",
640
+ "minLength": 1
641
+ }
642
+ },
643
+ "metadata": {
644
+ "type": "object"
645
+ },
646
+ "role": {
647
+ "type": "string",
648
+ "minLength": 1
649
+ },
650
+ "auth_type": {
651
+ "type": "string",
652
+ "enum": ["password", "oauth", "email_link", "phone_number", "ldap", "saml"]
653
+ },
654
+ "auth_second_factor_type": {
655
+ "type": "string",
656
+ "enum": ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"]
657
+ },
658
+ "auth_provider": {
659
+ "type": ["string", "null"],
660
+ "maxLength": 255
661
+ },
662
+ "auth_session_started_at": {
663
+ "type": ["string", "null"],
664
+ "format": "date-time"
665
+ },
666
+ "auth_session_id_hash": {
667
+ "type": ["string", "null"]
668
+ },
669
+ "auth_user_id_hash": {
670
+ "type": ["string", "null"]
671
+ },
672
+ "auth_username_hash": {
673
+ "type": ["string", "null"]
674
+ },
675
+ "auth_phone_number_hash": {
676
+ "type": ["string", "null"]
677
+ },
678
+ "ignore_unknown_fields": {
679
+ "type": "boolean"
680
+ },
681
+ "prefilled_values_editable": {
682
+ "type": "boolean"
683
+ }
684
+ },
685
+ "required": ["fields", "auth_type"],
686
+ "additionalProperties": false
687
+ }
688
+ }
689
+ },
690
+ "additionalProperties": false
691
+ }
692
+ }
693
+ },
694
+ "createSubmissionBatch": {
695
+ "query": {
696
+ "wait": {
697
+ "required": false,
698
+ "schema": {
699
+ "type": "boolean"
700
+ }
701
+ }
702
+ },
703
+ "body": {
704
+ "mediaType": "application/json",
705
+ "required": true,
706
+ "schema": {
707
+ "type": "object",
708
+ "properties": {
709
+ "metadata": {
710
+ "type": "object"
711
+ },
712
+ "template_id": {
713
+ "type": "string"
714
+ },
715
+ "template_version": {
716
+ "type": "string",
717
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
718
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
719
+ },
720
+ "test": {
721
+ "type": "boolean"
722
+ },
723
+ "output_formats": {
724
+ "type": "array",
725
+ "minItems": 1,
726
+ "uniqueItems": true,
727
+ "items": {
728
+ "type": "string",
729
+ "enum": ["pdf", "png"]
730
+ }
731
+ },
732
+ "submissions": {
733
+ "type": "array",
734
+ "minItems": 1,
735
+ "maxItems": 50,
736
+ "items": {
737
+ "type": "object",
738
+ "properties": {
739
+ "test": {
740
+ "type": "boolean"
741
+ },
742
+ "editable": {
743
+ "type": "boolean"
744
+ },
745
+ "data": {
746
+ "type": "object"
747
+ },
748
+ "metadata": {
749
+ "type": "object"
750
+ },
751
+ "password": {
752
+ "type": "string",
753
+ "minLength": 1
754
+ },
755
+ "output_formats": {
756
+ "type": "array",
757
+ "minItems": 1,
758
+ "uniqueItems": true,
759
+ "items": {
760
+ "type": "string",
761
+ "enum": ["pdf", "png"]
762
+ }
763
+ },
764
+ "expires_in": {
765
+ "type": "integer",
766
+ "minimum": 1,
767
+ "maximum": 315360000
768
+ },
769
+ "field_overrides": {
770
+ "type": "object",
771
+ "additionalProperties": {
772
+ "$ref": "#/components/schemas/FieldOverride"
773
+ }
774
+ },
775
+ "html": {
776
+ "type": "string"
777
+ },
778
+ "css": {
779
+ "type": "string"
780
+ },
781
+ "template_id": {
782
+ "type": "string"
783
+ },
784
+ "template_version": {
785
+ "type": "string",
786
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
787
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
788
+ }
789
+ },
790
+ "additionalProperties": false
791
+ }
792
+ }
793
+ },
794
+ "required": ["submissions"],
795
+ "additionalProperties": false
796
+ }
797
+ }
798
+ },
799
+ "createTemplate": {
800
+ "query": {
801
+ "wait": {
802
+ "required": false,
803
+ "schema": {
804
+ "type": "boolean"
805
+ }
806
+ }
807
+ },
808
+ "body": {
809
+ "mediaType": "application/json",
810
+ "required": true,
811
+ "schema": {
812
+ "type": "object",
813
+ "properties": {
814
+ "name": {
815
+ "type": "string",
816
+ "minLength": 1,
817
+ "maxLength": 255
818
+ },
819
+ "description": {
820
+ "type": ["string", "null"]
821
+ },
822
+ "template_type": {
823
+ "type": "string",
824
+ "enum": ["pdf", "html"]
825
+ },
826
+ "parent_folder_id": {
827
+ "type": ["string", "null"],
828
+ "minLength": 1
829
+ },
830
+ "locked": {
831
+ "type": "boolean"
832
+ },
833
+ "add_signature_request_submission_id_footers": {
834
+ "type": "boolean"
835
+ },
836
+ "ai_field_naming_language": {
837
+ "type": "string",
838
+ "enum": ["auto", "english", "form_language"]
839
+ },
840
+ "allow_additional_properties": {
841
+ "type": "boolean"
842
+ },
843
+ "allow_skipping_optional_fields": {
844
+ "type": "boolean"
845
+ },
846
+ "default_form_mode": {
847
+ "type": "string",
848
+ "enum": ["web", "visual", "dual"]
849
+ },
850
+ "editable_submissions": {
851
+ "type": "boolean"
852
+ },
853
+ "embed_domains": {
854
+ "type": "array",
855
+ "maxItems": 100,
856
+ "items": {
857
+ "type": "string",
858
+ "minLength": 1,
859
+ "maxLength": 255
860
+ }
861
+ },
862
+ "embed_edit_allow_settings": {
863
+ "type": "boolean"
864
+ },
865
+ "embed_edit_allow_versioning": {
866
+ "type": "boolean"
867
+ },
868
+ "embed_edit_allow_document_replacement": {
869
+ "type": "boolean"
870
+ },
871
+ "encrypt_pdfs": {
872
+ "type": "boolean"
873
+ },
874
+ "encrypt_pdfs_password": {
875
+ "type": ["string", "null"]
876
+ },
877
+ "expire_submissions": {
878
+ "type": "boolean"
879
+ },
880
+ "expire_after": {
881
+ "type": "integer",
882
+ "minimum": 1,
883
+ "maximum": 5256000
884
+ },
885
+ "expiration_interval": {
886
+ "type": "string",
887
+ "enum": ["minutes", "hours", "days"]
888
+ },
889
+ "merge_audit_trail_pdf": {
890
+ "type": "boolean"
891
+ },
892
+ "parse_dates_using_template_date_format": {
893
+ "type": "boolean"
894
+ },
895
+ "public_submissions": {
896
+ "type": "boolean"
897
+ },
898
+ "public_web_form": {
899
+ "type": "boolean"
900
+ },
901
+ "redirect_url": {
902
+ "type": ["string", "null"],
903
+ "format": "uri"
904
+ },
905
+ "slack_webhook_url": {
906
+ "type": ["string", "null"],
907
+ "format": "uri"
908
+ },
909
+ "defaults": {
910
+ "type": "object",
911
+ "properties": {
912
+ "typeface": {
913
+ "type": ["string", "null"],
914
+ "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]
915
+ },
916
+ "font_size": {
917
+ "type": ["integer", "null"],
918
+ "minimum": 1
919
+ },
920
+ "character_spacing": {
921
+ "type": ["number", "null"],
922
+ "minimum": 0,
923
+ "maximum": 50
924
+ },
925
+ "color": {
926
+ "type": ["string", "null"],
927
+ "pattern": "^[A-Fa-f0-9]{6}$",
928
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
929
+ },
930
+ "background_color": {
931
+ "type": ["string", "null"],
932
+ "pattern": "^[A-Fa-f0-9]{6}$",
933
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
934
+ },
935
+ "bold": {
936
+ "type": "boolean"
937
+ },
938
+ "uppercase": {
939
+ "type": "boolean"
940
+ },
941
+ "alignment": {
942
+ "type": "string",
943
+ "enum": ["left", "center", "right", "justify"]
944
+ },
945
+ "opacity": {
946
+ "type": "number",
947
+ "minimum": 0,
948
+ "maximum": 1
949
+ },
950
+ "date_format": {
951
+ "type": ["string", "null"]
952
+ },
953
+ "date_time_format": {
954
+ "type": ["string", "null"]
955
+ },
956
+ "check_color": {
957
+ "type": ["string", "null"],
958
+ "pattern": "^[A-Fa-f0-9]{6}$",
959
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
960
+ },
961
+ "check_character": {
962
+ "type": ["string", "null"],
963
+ "enum": ["✓", "✔", "✖", "✗", "✘", null]
964
+ },
965
+ "check_background_color": {
966
+ "type": ["string", "null"],
967
+ "pattern": "^[A-Fa-f0-9]{6}$",
968
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
969
+ },
970
+ "required_field_background_color": {
971
+ "type": ["string", "null"],
972
+ "pattern": "^[A-Fa-f0-9]{6}$",
973
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
974
+ },
975
+ "true_text": {
976
+ "type": ["string", "null"]
977
+ },
978
+ "false_text": {
979
+ "type": ["string", "null"]
980
+ },
981
+ "shape_fill_color": {
982
+ "type": ["string", "null"],
983
+ "pattern": "^[A-Fa-f0-9]{6}$",
984
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
985
+ },
986
+ "shape_border_color": {
987
+ "type": ["string", "null"],
988
+ "pattern": "^[A-Fa-f0-9]{6}$",
989
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
990
+ },
991
+ "shape_border_width": {
992
+ "type": "integer",
993
+ "minimum": 1
994
+ }
995
+ },
996
+ "additionalProperties": false
997
+ },
998
+ "field_dependencies": {
999
+ "type": "array",
1000
+ "items": {
1001
+ "type": "object",
1002
+ "properties": {
1003
+ "action": {
1004
+ "type": "string",
1005
+ "enum": ["require_and_show", "show", "require"]
1006
+ },
1007
+ "match": {
1008
+ "type": "string",
1009
+ "enum": ["all", "any"]
1010
+ },
1011
+ "conditions": {
1012
+ "type": "array",
1013
+ "items": {
1014
+ "oneOf": [{
1015
+ "$ref": "#/components/schemas/FieldPresenceCondition"
1016
+ }, {
1017
+ "$ref": "#/components/schemas/FieldEqualsCondition"
1018
+ }, {
1019
+ "$ref": "#/components/schemas/FieldInCondition"
1020
+ }, {
1021
+ "$ref": "#/components/schemas/FieldComparisonCondition"
1022
+ }, {
1023
+ "$ref": "#/components/schemas/FieldRangeCondition"
1024
+ }],
1025
+ "discriminator": {
1026
+ "propertyName": "operator",
1027
+ "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"]]
1028
+ }
1029
+ }
1030
+ },
1031
+ "targets": {
1032
+ "type": "array",
1033
+ "minItems": 1,
1034
+ "items": {
1035
+ "type": "string",
1036
+ "minLength": 1
1037
+ }
1038
+ },
1039
+ "group": {
1040
+ "type": "string"
1041
+ }
1042
+ },
1043
+ "required": ["action", "conditions", "targets"],
1044
+ "additionalProperties": false
1045
+ }
1046
+ },
1047
+ "predefined_fields": {
1048
+ "type": "array",
1049
+ "items": {
1050
+ "type": "object",
1051
+ "required": ["name", "type"],
1052
+ "properties": {
1053
+ "name": {
1054
+ "type": "string",
1055
+ "minLength": 1
1056
+ },
1057
+ "display_name": {
1058
+ "type": ["string", "null"],
1059
+ "minLength": 1
1060
+ },
1061
+ "title": {
1062
+ "type": ["string", "null"]
1063
+ },
1064
+ "type": {
1065
+ "type": "string",
1066
+ "enum": ["string", "number", "boolean", "date", "address", "country", "email", "url", "image", "signature", "initials", "barcode", "combined"]
1067
+ },
1068
+ "option_list": {
1069
+ "type": ["string", "null"]
1070
+ },
1071
+ "required_in_template": {
1072
+ "type": "boolean"
1073
+ },
1074
+ "field_required": {
1075
+ "type": "boolean"
1076
+ }
1077
+ },
1078
+ "additionalProperties": false
1079
+ }
1080
+ },
1081
+ "predefined_fields_sample_data": {
1082
+ "type": ["object", "null"]
1083
+ },
1084
+ "html": {
1085
+ "type": ["string", "null"]
1086
+ },
1087
+ "scss": {
1088
+ "type": ["string", "null"]
1089
+ },
1090
+ "header_html": {
1091
+ "type": ["string", "null"]
1092
+ },
1093
+ "footer_html": {
1094
+ "type": ["string", "null"]
1095
+ },
1096
+ "html_engine_options": {
1097
+ "type": ["object", "null"],
1098
+ "properties": {
1099
+ "format": {
1100
+ "type": "string",
1101
+ "enum": ["Letter", "Legal", "Tabloid", "Ledger", "CR80", "A0", "A1", "A2", "A3", "A4", "A5", "A6", "Custom"]
1102
+ },
1103
+ "width": {
1104
+ "type": "string"
1105
+ },
1106
+ "height": {
1107
+ "type": "string"
1108
+ },
1109
+ "scale": {
1110
+ "type": "number",
1111
+ "exclusiveMinimum": 0
1112
+ },
1113
+ "landscape": {
1114
+ "type": "boolean"
1115
+ },
1116
+ "print_background": {
1117
+ "type": "boolean"
1118
+ },
1119
+ "margin_top": {
1120
+ "type": "string"
1121
+ },
1122
+ "margin_bottom": {
1123
+ "type": "string"
1124
+ },
1125
+ "margin_left": {
1126
+ "type": "string"
1127
+ },
1128
+ "margin_right": {
1129
+ "type": "string"
1130
+ }
1131
+ },
1132
+ "additionalProperties": false
1133
+ },
1134
+ "cache_id": {
1135
+ "type": "string",
1136
+ "minLength": 1,
1137
+ "maxLength": 255
1138
+ },
1139
+ "document_url": {
1140
+ "type": "string",
1141
+ "minLength": 1,
1142
+ "maxLength": 2048,
1143
+ "pattern": "^https://",
1144
+ "x-pattern-message": "must be an https:// link"
1145
+ },
1146
+ "document_base64": {
1147
+ "type": "string",
1148
+ "minLength": 1
1149
+ },
1150
+ "filename": {
1151
+ "type": "string",
1152
+ "minLength": 1,
1153
+ "maxLength": 255
1154
+ },
1155
+ "detect_fields": {
1156
+ "type": "boolean"
1157
+ },
1158
+ "field_source": {
1159
+ "type": "string",
1160
+ "enum": ["auto", "pdf_detection", "pdf_form_fields"]
1161
+ },
1162
+ "field_naming": {
1163
+ "type": "string",
1164
+ "enum": ["ai", "preserve"]
1165
+ },
1166
+ "field_logic": {
1167
+ "type": "string",
1168
+ "enum": ["ai", "none"]
1169
+ }
1170
+ },
1171
+ "required": ["template_type"],
1172
+ "additionalProperties": false
1173
+ }
1174
+ }
1175
+ },
1176
+ "createWebhook": {
1177
+ "body": {
1178
+ "mediaType": "application/json",
1179
+ "required": true,
1180
+ "schema": {
1181
+ "type": "object",
1182
+ "properties": {
1183
+ "name": {
1184
+ "type": ["string", "null"],
1185
+ "maxLength": 255
1186
+ },
1187
+ "url": {
1188
+ "type": "string",
1189
+ "format": "uri"
1190
+ },
1191
+ "enabled": {
1192
+ "type": "boolean"
1193
+ },
1194
+ "event_types": {
1195
+ "type": "array",
1196
+ "minItems": 1,
1197
+ "uniqueItems": true,
1198
+ "items": {
1199
+ "type": "string",
1200
+ "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"]
1201
+ }
1202
+ },
1203
+ "mode": {
1204
+ "type": ["string", "null"],
1205
+ "enum": ["test", "live", null]
1206
+ },
1207
+ "api_token_ids": {
1208
+ "type": "array",
1209
+ "uniqueItems": true,
1210
+ "items": {
1211
+ "type": "string"
1212
+ }
1213
+ },
1214
+ "template_ids": {
1215
+ "type": "array",
1216
+ "uniqueItems": true,
1217
+ "items": {
1218
+ "type": "string"
1219
+ }
1220
+ },
1221
+ "folder_ids": {
1222
+ "type": "array",
1223
+ "uniqueItems": true,
1224
+ "items": {
1225
+ "type": "string"
1226
+ }
1227
+ },
1228
+ "include_submission_data": {
1229
+ "type": "boolean"
1230
+ },
1231
+ "strip_fields": {
1232
+ "type": "array",
1233
+ "items": {
1234
+ "type": "string"
1235
+ }
1236
+ },
1237
+ "headers": {
1238
+ "type": "object",
1239
+ "additionalProperties": {
1240
+ "type": "string"
1241
+ }
1242
+ }
1243
+ },
1244
+ "required": ["url", "event_types"],
1245
+ "additionalProperties": false
1246
+ }
1247
+ }
1248
+ },
1249
+ "deleteCustomFile": {},
1250
+ "deleteFolder": {},
1251
+ "deleteTemplate": {
1252
+ "query": {
1253
+ "version": {
1254
+ "required": false,
1255
+ "schema": {
1256
+ "type": "string",
1257
+ "pattern": "^(\\d+\\.\\d+\\.\\d+|draft)$",
1258
+ "x-pattern-message": "must be a full version like 1.2.3, or draft"
1259
+ }
1260
+ }
1261
+ }
1262
+ },
1263
+ "deleteWebhook": {},
1264
+ "expireCombinedPdf": {},
1265
+ "expireSubmission": {},
1266
+ "generateSubmissionFiles": {
1267
+ "query": {
1268
+ "wait": {
1269
+ "required": false,
1270
+ "schema": {
1271
+ "type": "boolean"
1272
+ }
1273
+ }
1274
+ },
1275
+ "body": {
1276
+ "mediaType": "application/json",
1277
+ "required": true,
1278
+ "schema": {
1279
+ "type": "object",
1280
+ "required": ["formats"],
1281
+ "properties": {
1282
+ "formats": {
1283
+ "type": "array",
1284
+ "minItems": 1,
1285
+ "uniqueItems": true,
1286
+ "items": {
1287
+ "type": "string",
1288
+ "enum": ["png"]
1289
+ }
1290
+ }
1291
+ },
1292
+ "additionalProperties": false
1293
+ }
1294
+ }
1295
+ },
1296
+ "generateSubmissionPreview": {},
1297
+ "getCombinedPdf": {},
1298
+ "getCustomFile": {},
1299
+ "getFolder": {},
1300
+ "getPresignUrl": {},
1301
+ "getSignatureRequest": {},
1302
+ "getSubmission": {},
1303
+ "getSubmissionBatch": {
1304
+ "query": {
1305
+ "include_data": {
1306
+ "required": false,
1307
+ "schema": {
1308
+ "type": "boolean"
1309
+ }
1310
+ }
1311
+ }
1312
+ },
1313
+ "getTemplate": {
1314
+ "query": {
1315
+ "version": {
1316
+ "required": false,
1317
+ "schema": {
1318
+ "type": "string",
1319
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1320
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1321
+ }
1322
+ }
1323
+ }
1324
+ },
1325
+ "getTemplateDiff": {
1326
+ "query": {
1327
+ "version": {
1328
+ "required": false,
1329
+ "schema": {
1330
+ "type": "string",
1331
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1332
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1333
+ }
1334
+ }
1335
+ }
1336
+ },
1337
+ "getTemplateModelCode": {
1338
+ "query": {
1339
+ "version": {
1340
+ "required": false,
1341
+ "schema": {
1342
+ "type": "string",
1343
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1344
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1345
+ }
1346
+ },
1347
+ "lang": {
1348
+ "required": true,
1349
+ "schema": {
1350
+ "type": "string",
1351
+ "enum": ["typescript", "javascript", "ruby", "python", "php", "java", "csharp", "elixir", "go"]
1352
+ }
1353
+ }
1354
+ }
1355
+ },
1356
+ "getTemplatePageImages": {
1357
+ "query": {
1358
+ "version": {
1359
+ "required": false,
1360
+ "schema": {
1361
+ "type": "string",
1362
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1363
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1364
+ }
1365
+ }
1366
+ }
1367
+ },
1368
+ "getTemplateSchema": {
1369
+ "query": {
1370
+ "version": {
1371
+ "required": false,
1372
+ "schema": {
1373
+ "type": "string",
1374
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1375
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1376
+ }
1377
+ }
1378
+ }
1379
+ },
1380
+ "getWebhook": {},
1381
+ "listCombinedPdfs": {
1382
+ "query": {
1383
+ "limit": {
1384
+ "required": false,
1385
+ "schema": {
1386
+ "type": "integer",
1387
+ "minimum": 1,
1388
+ "maximum": 100
1389
+ }
1390
+ },
1391
+ "cursor": {
1392
+ "required": false,
1393
+ "schema": {
1394
+ "type": "string"
1395
+ }
1396
+ }
1397
+ }
1398
+ },
1399
+ "listCustomFiles": {
1400
+ "query": {
1401
+ "limit": {
1402
+ "required": false,
1403
+ "schema": {
1404
+ "type": "integer",
1405
+ "minimum": 1,
1406
+ "maximum": 100
1407
+ }
1408
+ },
1409
+ "cursor": {
1410
+ "required": false,
1411
+ "schema": {
1412
+ "type": "string"
1413
+ }
1414
+ }
1415
+ }
1416
+ },
1417
+ "listFolders": {
1418
+ "query": {
1419
+ "parent_folder_id": {
1420
+ "required": false,
1421
+ "schema": {
1422
+ "type": "string"
1423
+ }
1424
+ },
1425
+ "limit": {
1426
+ "required": false,
1427
+ "schema": {
1428
+ "type": "integer",
1429
+ "minimum": 1,
1430
+ "maximum": 100
1431
+ }
1432
+ },
1433
+ "cursor": {
1434
+ "required": false,
1435
+ "schema": {
1436
+ "type": "string"
1437
+ }
1438
+ }
1439
+ }
1440
+ },
1441
+ "listSubmissions": {
1442
+ "query": {
1443
+ "template_id": {
1444
+ "required": false,
1445
+ "schema": {
1446
+ "type": "string"
1447
+ }
1448
+ },
1449
+ "test": {
1450
+ "required": false,
1451
+ "schema": {
1452
+ "type": "boolean"
1453
+ }
1454
+ },
1455
+ "created_after": {
1456
+ "required": false,
1457
+ "schema": {
1458
+ "type": "string",
1459
+ "format": "date-time"
1460
+ }
1461
+ },
1462
+ "created_before": {
1463
+ "required": false,
1464
+ "schema": {
1465
+ "type": "string",
1466
+ "format": "date-time"
1467
+ }
1468
+ },
1469
+ "include_data": {
1470
+ "required": false,
1471
+ "schema": {
1472
+ "type": "boolean"
1473
+ }
1474
+ },
1475
+ "limit": {
1476
+ "required": false,
1477
+ "schema": {
1478
+ "type": "integer",
1479
+ "minimum": 1,
1480
+ "maximum": 100
1481
+ }
1482
+ },
1483
+ "cursor": {
1484
+ "required": false,
1485
+ "schema": {
1486
+ "type": "string"
1487
+ }
1488
+ }
1489
+ }
1490
+ },
1491
+ "listTemplateFields": {
1492
+ "query": {
1493
+ "version": {
1494
+ "required": false,
1495
+ "schema": {
1496
+ "type": "string",
1497
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
1498
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
1499
+ }
1500
+ }
1501
+ }
1502
+ },
1503
+ "listTemplateSubmissions": {
1504
+ "query": {
1505
+ "test": {
1506
+ "required": false,
1507
+ "schema": {
1508
+ "type": "boolean"
1509
+ }
1510
+ },
1511
+ "created_after": {
1512
+ "required": false,
1513
+ "schema": {
1514
+ "type": "string",
1515
+ "format": "date-time"
1516
+ }
1517
+ },
1518
+ "created_before": {
1519
+ "required": false,
1520
+ "schema": {
1521
+ "type": "string",
1522
+ "format": "date-time"
1523
+ }
1524
+ },
1525
+ "include_data": {
1526
+ "required": false,
1527
+ "schema": {
1528
+ "type": "boolean"
1529
+ }
1530
+ },
1531
+ "limit": {
1532
+ "required": false,
1533
+ "schema": {
1534
+ "type": "integer",
1535
+ "minimum": 1,
1536
+ "maximum": 100
1537
+ }
1538
+ },
1539
+ "cursor": {
1540
+ "required": false,
1541
+ "schema": {
1542
+ "type": "string"
1543
+ }
1544
+ }
1545
+ }
1546
+ },
1547
+ "listTemplates": {
1548
+ "query": {
1549
+ "query": {
1550
+ "required": false,
1551
+ "schema": {
1552
+ "type": "string"
1553
+ }
1554
+ },
1555
+ "parent_folder_id": {
1556
+ "required": false,
1557
+ "schema": {
1558
+ "type": "string"
1559
+ }
1560
+ },
1561
+ "limit": {
1562
+ "required": false,
1563
+ "schema": {
1564
+ "type": "integer",
1565
+ "minimum": 1,
1566
+ "maximum": 100
1567
+ }
1568
+ },
1569
+ "cursor": {
1570
+ "required": false,
1571
+ "schema": {
1572
+ "type": "string"
1573
+ }
1574
+ }
1575
+ }
1576
+ },
1577
+ "listWebhooks": {
1578
+ "query": {
1579
+ "event_type": {
1580
+ "required": false,
1581
+ "schema": {
1582
+ "type": "string",
1583
+ "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"]
1584
+ }
1585
+ },
1586
+ "mode": {
1587
+ "required": false,
1588
+ "schema": {
1589
+ "type": "string",
1590
+ "enum": ["test", "live"]
1591
+ }
1592
+ },
1593
+ "template_id": {
1594
+ "required": false,
1595
+ "schema": {
1596
+ "type": "string"
1597
+ }
1598
+ },
1599
+ "folder_id": {
1600
+ "required": false,
1601
+ "schema": {
1602
+ "type": "string"
1603
+ }
1604
+ },
1605
+ "api_token_id": {
1606
+ "required": false,
1607
+ "schema": {
1608
+ "type": "string"
1609
+ }
1610
+ },
1611
+ "limit": {
1612
+ "required": false,
1613
+ "schema": {
1614
+ "type": "integer",
1615
+ "minimum": 1,
1616
+ "maximum": 100
1617
+ }
1618
+ },
1619
+ "cursor": {
1620
+ "required": false,
1621
+ "schema": {
1622
+ "type": "string"
1623
+ }
1624
+ }
1625
+ }
1626
+ },
1627
+ "moveFolder": {
1628
+ "body": {
1629
+ "mediaType": "application/json",
1630
+ "required": true,
1631
+ "schema": {
1632
+ "type": "object",
1633
+ "properties": {
1634
+ "parent_folder_id": {
1635
+ "type": ["string", "null"],
1636
+ "minLength": 1
1637
+ }
1638
+ },
1639
+ "required": ["parent_folder_id"],
1640
+ "additionalProperties": false
1641
+ }
1642
+ }
1643
+ },
1644
+ "moveTemplate": {
1645
+ "body": {
1646
+ "mediaType": "application/json",
1647
+ "required": true,
1648
+ "schema": {
1649
+ "type": "object",
1650
+ "required": ["parent_folder_id"],
1651
+ "properties": {
1652
+ "parent_folder_id": {
1653
+ "type": ["string", "null"],
1654
+ "minLength": 1
1655
+ }
1656
+ },
1657
+ "additionalProperties": false
1658
+ }
1659
+ }
1660
+ },
1661
+ "publishTemplateVersion": {
1662
+ "body": {
1663
+ "mediaType": "application/json",
1664
+ "required": true,
1665
+ "schema": {
1666
+ "type": "object",
1667
+ "required": ["version_type"],
1668
+ "properties": {
1669
+ "version_type": {
1670
+ "type": "string",
1671
+ "enum": ["major", "minor", "patch"]
1672
+ },
1673
+ "description": {
1674
+ "type": "string",
1675
+ "maxLength": 500
1676
+ }
1677
+ },
1678
+ "additionalProperties": false
1679
+ }
1680
+ }
1681
+ },
1682
+ "removeTemplateFields": {
1683
+ "body": {
1684
+ "mediaType": "application/json",
1685
+ "required": true,
1686
+ "schema": {
1687
+ "type": "object",
1688
+ "required": ["field_ids"],
1689
+ "properties": {
1690
+ "field_ids": {
1691
+ "type": "array",
1692
+ "minItems": 1,
1693
+ "maxItems": 1000,
1694
+ "items": {
1695
+ "type": "integer"
1696
+ }
1697
+ }
1698
+ },
1699
+ "additionalProperties": false
1700
+ }
1701
+ }
1702
+ },
1703
+ "renameFolder": {
1704
+ "body": {
1705
+ "mediaType": "application/json",
1706
+ "required": true,
1707
+ "schema": {
1708
+ "type": "object",
1709
+ "properties": {
1710
+ "name": {
1711
+ "type": "string",
1712
+ "minLength": 1,
1713
+ "maxLength": 255,
1714
+ "pattern": "^[^/]*$",
1715
+ "x-pattern-message": "can't contain a slash (/)"
1716
+ }
1717
+ },
1718
+ "required": ["name"],
1719
+ "additionalProperties": false
1720
+ }
1721
+ }
1722
+ },
1723
+ "reorderTemplateFields": {
1724
+ "body": {
1725
+ "mediaType": "application/json",
1726
+ "required": true,
1727
+ "schema": {
1728
+ "type": "object",
1729
+ "required": ["field_ids"],
1730
+ "properties": {
1731
+ "field_ids": {
1732
+ "type": "array",
1733
+ "minItems": 1,
1734
+ "items": {
1735
+ "type": "integer"
1736
+ }
1737
+ }
1738
+ },
1739
+ "additionalProperties": false
1740
+ }
1741
+ }
1742
+ },
1743
+ "restoreTemplateVersion": {
1744
+ "body": {
1745
+ "mediaType": "application/json",
1746
+ "required": true,
1747
+ "schema": {
1748
+ "type": "object",
1749
+ "required": ["version"],
1750
+ "properties": {
1751
+ "version": {
1752
+ "type": "string",
1753
+ "pattern": "^\\d+(\\.\\d+(\\.\\d+)?)?$",
1754
+ "x-pattern-message": "must be a published version like 1.2.3 or 1"
1755
+ }
1756
+ },
1757
+ "additionalProperties": false
1758
+ }
1759
+ }
1760
+ },
1761
+ "testAuthentication": {},
1762
+ "updateSignatureRequest": {
1763
+ "body": {
1764
+ "mediaType": "application/json",
1765
+ "required": true,
1766
+ "schema": {
1767
+ "type": "object",
1768
+ "properties": {
1769
+ "metadata": {
1770
+ "type": "object"
1771
+ },
1772
+ "auth_type": {
1773
+ "type": "string",
1774
+ "enum": ["password", "oauth", "email_link", "phone_number", "ldap", "saml"]
1775
+ },
1776
+ "auth_second_factor_type": {
1777
+ "type": "string",
1778
+ "enum": ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"]
1779
+ },
1780
+ "auth_provider": {
1781
+ "type": ["string", "null"],
1782
+ "maxLength": 255
1783
+ },
1784
+ "auth_session_started_at": {
1785
+ "type": ["string", "null"],
1786
+ "format": "date-time"
1787
+ },
1788
+ "auth_session_id_hash": {
1789
+ "type": ["string", "null"]
1790
+ },
1791
+ "auth_user_id_hash": {
1792
+ "type": ["string", "null"]
1793
+ },
1794
+ "auth_username_hash": {
1795
+ "type": ["string", "null"]
1796
+ },
1797
+ "auth_phone_number_hash": {
1798
+ "type": ["string", "null"]
1799
+ }
1800
+ },
1801
+ "additionalProperties": false
1802
+ }
1803
+ }
1804
+ },
1805
+ "updateTemplate": {
1806
+ "body": {
1807
+ "mediaType": "application/json",
1808
+ "required": true,
1809
+ "schema": {
1810
+ "type": "object",
1811
+ "properties": {
1812
+ "name": {
1813
+ "type": "string",
1814
+ "minLength": 1,
1815
+ "maxLength": 255
1816
+ },
1817
+ "description": {
1818
+ "type": ["string", "null"]
1819
+ },
1820
+ "parent_folder_id": {
1821
+ "type": ["string", "null"],
1822
+ "minLength": 1
1823
+ },
1824
+ "locked": {
1825
+ "type": "boolean"
1826
+ },
1827
+ "add_signature_request_submission_id_footers": {
1828
+ "type": "boolean"
1829
+ },
1830
+ "ai_field_naming_language": {
1831
+ "type": "string",
1832
+ "enum": ["auto", "english", "form_language"]
1833
+ },
1834
+ "allow_additional_properties": {
1835
+ "type": "boolean"
1836
+ },
1837
+ "allow_skipping_optional_fields": {
1838
+ "type": "boolean"
1839
+ },
1840
+ "default_form_mode": {
1841
+ "type": "string",
1842
+ "enum": ["web", "visual", "dual"]
1843
+ },
1844
+ "editable_submissions": {
1845
+ "type": "boolean"
1846
+ },
1847
+ "embed_domains": {
1848
+ "type": "array",
1849
+ "maxItems": 100,
1850
+ "items": {
1851
+ "type": "string",
1852
+ "minLength": 1,
1853
+ "maxLength": 255
1854
+ }
1855
+ },
1856
+ "embed_edit_allow_settings": {
1857
+ "type": "boolean"
1858
+ },
1859
+ "embed_edit_allow_versioning": {
1860
+ "type": "boolean"
1861
+ },
1862
+ "embed_edit_allow_document_replacement": {
1863
+ "type": "boolean"
1864
+ },
1865
+ "encrypt_pdfs": {
1866
+ "type": "boolean"
1867
+ },
1868
+ "encrypt_pdfs_password": {
1869
+ "type": ["string", "null"]
1870
+ },
1871
+ "expire_submissions": {
1872
+ "type": "boolean"
1873
+ },
1874
+ "expire_after": {
1875
+ "type": "integer",
1876
+ "minimum": 1,
1877
+ "maximum": 5256000
1878
+ },
1879
+ "expiration_interval": {
1880
+ "type": "string",
1881
+ "enum": ["minutes", "hours", "days"]
1882
+ },
1883
+ "merge_audit_trail_pdf": {
1884
+ "type": "boolean"
1885
+ },
1886
+ "parse_dates_using_template_date_format": {
1887
+ "type": "boolean"
1888
+ },
1889
+ "public_submissions": {
1890
+ "type": "boolean"
1891
+ },
1892
+ "public_web_form": {
1893
+ "type": "boolean"
1894
+ },
1895
+ "redirect_url": {
1896
+ "type": ["string", "null"],
1897
+ "format": "uri"
1898
+ },
1899
+ "slack_webhook_url": {
1900
+ "type": ["string", "null"],
1901
+ "format": "uri"
1902
+ },
1903
+ "defaults": {
1904
+ "type": "object",
1905
+ "properties": {
1906
+ "typeface": {
1907
+ "type": ["string", "null"],
1908
+ "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]
1909
+ },
1910
+ "font_size": {
1911
+ "type": ["integer", "null"],
1912
+ "minimum": 1
1913
+ },
1914
+ "character_spacing": {
1915
+ "type": ["number", "null"],
1916
+ "minimum": 0,
1917
+ "maximum": 50
1918
+ },
1919
+ "color": {
1920
+ "type": ["string", "null"],
1921
+ "pattern": "^[A-Fa-f0-9]{6}$",
1922
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1923
+ },
1924
+ "background_color": {
1925
+ "type": ["string", "null"],
1926
+ "pattern": "^[A-Fa-f0-9]{6}$",
1927
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1928
+ },
1929
+ "bold": {
1930
+ "type": "boolean"
1931
+ },
1932
+ "uppercase": {
1933
+ "type": "boolean"
1934
+ },
1935
+ "alignment": {
1936
+ "type": "string",
1937
+ "enum": ["left", "center", "right", "justify"]
1938
+ },
1939
+ "opacity": {
1940
+ "type": "number",
1941
+ "minimum": 0,
1942
+ "maximum": 1
1943
+ },
1944
+ "date_format": {
1945
+ "type": ["string", "null"]
1946
+ },
1947
+ "date_time_format": {
1948
+ "type": ["string", "null"]
1949
+ },
1950
+ "check_color": {
1951
+ "type": ["string", "null"],
1952
+ "pattern": "^[A-Fa-f0-9]{6}$",
1953
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1954
+ },
1955
+ "check_character": {
1956
+ "type": ["string", "null"],
1957
+ "enum": ["✓", "✔", "✖", "✗", "✘", null]
1958
+ },
1959
+ "check_background_color": {
1960
+ "type": ["string", "null"],
1961
+ "pattern": "^[A-Fa-f0-9]{6}$",
1962
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1963
+ },
1964
+ "required_field_background_color": {
1965
+ "type": ["string", "null"],
1966
+ "pattern": "^[A-Fa-f0-9]{6}$",
1967
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1968
+ },
1969
+ "true_text": {
1970
+ "type": ["string", "null"]
1971
+ },
1972
+ "false_text": {
1973
+ "type": ["string", "null"]
1974
+ },
1975
+ "shape_fill_color": {
1976
+ "type": ["string", "null"],
1977
+ "pattern": "^[A-Fa-f0-9]{6}$",
1978
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1979
+ },
1980
+ "shape_border_color": {
1981
+ "type": ["string", "null"],
1982
+ "pattern": "^[A-Fa-f0-9]{6}$",
1983
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
1984
+ },
1985
+ "shape_border_width": {
1986
+ "type": "integer",
1987
+ "minimum": 1
1988
+ }
1989
+ },
1990
+ "additionalProperties": false
1991
+ },
1992
+ "field_dependencies": {
1993
+ "type": "array",
1994
+ "items": {
1995
+ "type": "object",
1996
+ "properties": {
1997
+ "action": {
1998
+ "type": "string",
1999
+ "enum": ["require_and_show", "show", "require"]
2000
+ },
2001
+ "match": {
2002
+ "type": "string",
2003
+ "enum": ["all", "any"]
2004
+ },
2005
+ "conditions": {
2006
+ "type": "array",
2007
+ "items": {
2008
+ "oneOf": [{
2009
+ "$ref": "#/components/schemas/FieldPresenceCondition"
2010
+ }, {
2011
+ "$ref": "#/components/schemas/FieldEqualsCondition"
2012
+ }, {
2013
+ "$ref": "#/components/schemas/FieldInCondition"
2014
+ }, {
2015
+ "$ref": "#/components/schemas/FieldComparisonCondition"
2016
+ }, {
2017
+ "$ref": "#/components/schemas/FieldRangeCondition"
2018
+ }],
2019
+ "discriminator": {
2020
+ "propertyName": "operator",
2021
+ "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"]]
2022
+ }
2023
+ }
2024
+ },
2025
+ "targets": {
2026
+ "type": "array",
2027
+ "minItems": 1,
2028
+ "items": {
2029
+ "type": "string",
2030
+ "minLength": 1
2031
+ }
2032
+ },
2033
+ "group": {
2034
+ "type": "string"
2035
+ }
2036
+ },
2037
+ "required": ["action", "conditions", "targets"],
2038
+ "additionalProperties": false
2039
+ }
2040
+ },
2041
+ "field_groups": {
2042
+ "type": "array",
2043
+ "items": {
2044
+ "type": "object",
2045
+ "properties": {
2046
+ "name": {
2047
+ "type": "string",
2048
+ "minLength": 1
2049
+ },
2050
+ "title": {
2051
+ "type": "string"
2052
+ },
2053
+ "description": {
2054
+ "type": "string"
2055
+ },
2056
+ "metadata": {
2057
+ "type": "string"
2058
+ },
2059
+ "min_items": {
2060
+ "type": ["integer", "null"],
2061
+ "minimum": 0
2062
+ },
2063
+ "max_items": {
2064
+ "type": ["integer", "null"],
2065
+ "minimum": 1
2066
+ },
2067
+ "allow_additional_items": {
2068
+ "type": "boolean"
2069
+ }
2070
+ },
2071
+ "required": ["name"],
2072
+ "additionalProperties": false
2073
+ }
2074
+ },
2075
+ "predefined_fields": {
2076
+ "type": "array",
2077
+ "items": {
2078
+ "type": "object",
2079
+ "required": ["name", "type"],
2080
+ "properties": {
2081
+ "name": {
2082
+ "type": "string",
2083
+ "minLength": 1
2084
+ },
2085
+ "display_name": {
2086
+ "type": ["string", "null"],
2087
+ "minLength": 1
2088
+ },
2089
+ "title": {
2090
+ "type": ["string", "null"]
2091
+ },
2092
+ "type": {
2093
+ "type": "string",
2094
+ "enum": ["string", "number", "boolean", "date", "address", "country", "email", "url", "image", "signature", "initials", "barcode", "combined"]
2095
+ },
2096
+ "option_list": {
2097
+ "type": ["string", "null"]
2098
+ },
2099
+ "required_in_template": {
2100
+ "type": "boolean"
2101
+ },
2102
+ "field_required": {
2103
+ "type": "boolean"
2104
+ }
2105
+ },
2106
+ "additionalProperties": false
2107
+ }
2108
+ },
2109
+ "predefined_fields_sample_data": {
2110
+ "type": ["object", "null"]
2111
+ },
2112
+ "html": {
2113
+ "type": ["string", "null"]
2114
+ },
2115
+ "scss": {
2116
+ "type": ["string", "null"]
2117
+ },
2118
+ "header_html": {
2119
+ "type": ["string", "null"]
2120
+ },
2121
+ "footer_html": {
2122
+ "type": ["string", "null"]
2123
+ },
2124
+ "html_engine_options": {
2125
+ "type": ["object", "null"],
2126
+ "properties": {
2127
+ "format": {
2128
+ "type": "string",
2129
+ "enum": ["Letter", "Legal", "Tabloid", "Ledger", "CR80", "A0", "A1", "A2", "A3", "A4", "A5", "A6", "Custom"]
2130
+ },
2131
+ "width": {
2132
+ "type": "string"
2133
+ },
2134
+ "height": {
2135
+ "type": "string"
2136
+ },
2137
+ "scale": {
2138
+ "type": "number",
2139
+ "exclusiveMinimum": 0
2140
+ },
2141
+ "landscape": {
2142
+ "type": "boolean"
2143
+ },
2144
+ "print_background": {
2145
+ "type": "boolean"
2146
+ },
2147
+ "margin_top": {
2148
+ "type": "string"
2149
+ },
2150
+ "margin_bottom": {
2151
+ "type": "string"
2152
+ },
2153
+ "margin_left": {
2154
+ "type": "string"
2155
+ },
2156
+ "margin_right": {
2157
+ "type": "string"
2158
+ }
2159
+ },
2160
+ "additionalProperties": false
2161
+ }
2162
+ },
2163
+ "additionalProperties": false
2164
+ }
2165
+ }
2166
+ },
2167
+ "updateTemplateDocument": {
2168
+ "query": {
2169
+ "wait": {
2170
+ "required": false,
2171
+ "schema": {
2172
+ "type": "boolean"
2173
+ }
2174
+ }
2175
+ },
2176
+ "body": {
2177
+ "mediaType": "application/json",
2178
+ "required": true,
2179
+ "schema": {
2180
+ "type": "object",
2181
+ "properties": {
2182
+ "cache_id": {
2183
+ "type": "string",
2184
+ "minLength": 1,
2185
+ "maxLength": 255
2186
+ },
2187
+ "document_url": {
2188
+ "type": "string",
2189
+ "minLength": 1,
2190
+ "maxLength": 2048,
2191
+ "pattern": "^https://",
2192
+ "x-pattern-message": "must be an https:// link"
2193
+ },
2194
+ "document_base64": {
2195
+ "type": "string",
2196
+ "minLength": 1
2197
+ },
2198
+ "filename": {
2199
+ "type": "string",
2200
+ "minLength": 1,
2201
+ "maxLength": 255
2202
+ },
2203
+ "reimport_fields": {
2204
+ "type": "boolean"
2205
+ }
2206
+ },
2207
+ "additionalProperties": false
2208
+ }
2209
+ }
2210
+ },
2211
+ "updateTemplateFields": {
2212
+ "body": {
2213
+ "mediaType": "application/json",
2214
+ "required": true,
2215
+ "schema": {
2216
+ "type": "object",
2217
+ "required": ["fields"],
2218
+ "properties": {
2219
+ "fields": {
2220
+ "type": "array",
2221
+ "minItems": 1,
2222
+ "maxItems": 1000,
2223
+ "items": {
2224
+ "type": "object",
2225
+ "properties": {
2226
+ "name": {
2227
+ "type": ["string", "null"]
2228
+ },
2229
+ "page": {
2230
+ "type": "integer",
2231
+ "minimum": 1
2232
+ },
2233
+ "type": {
2234
+ "type": "string",
2235
+ "enum": ["string", "number", "boolean", "date", "address", "country", "email", "url", "image", "signature", "initials", "barcode", "combined"]
2236
+ },
2237
+ "static": {
2238
+ "type": "boolean"
2239
+ },
2240
+ "editable": {
2241
+ "type": "boolean"
2242
+ },
2243
+ "default": {
2244
+ "type": ["string", "null"]
2245
+ },
2246
+ "title": {
2247
+ "type": "string"
2248
+ },
2249
+ "description": {
2250
+ "type": "string"
2251
+ },
2252
+ "placeholder": {
2253
+ "type": "string"
2254
+ },
2255
+ "metadata": {
2256
+ "type": "string"
2257
+ },
2258
+ "required": {
2259
+ "type": "boolean"
2260
+ },
2261
+ "option_list": {
2262
+ "type": ["string", "null"]
2263
+ },
2264
+ "combined_field_names": {
2265
+ "type": "string"
2266
+ },
2267
+ "combined_field_type": {
2268
+ "type": "string",
2269
+ "enum": ["separator", "format"]
2270
+ },
2271
+ "combined_field_separator": {
2272
+ "type": "string"
2273
+ },
2274
+ "combined_field_format": {
2275
+ "type": "string"
2276
+ },
2277
+ "integer": {
2278
+ "type": "boolean"
2279
+ },
2280
+ "minimum": {
2281
+ "type": ["number", "null"]
2282
+ },
2283
+ "maximum": {
2284
+ "type": ["number", "null"]
2285
+ },
2286
+ "exclusive_minimum": {
2287
+ "type": "boolean"
2288
+ },
2289
+ "exclusive_maximum": {
2290
+ "type": "boolean"
2291
+ },
2292
+ "include_time": {
2293
+ "type": ["boolean", "null"]
2294
+ },
2295
+ "signature_allow_draw": {
2296
+ "type": "boolean"
2297
+ },
2298
+ "signature_allow_type": {
2299
+ "type": "boolean"
2300
+ },
2301
+ "barcode_symbology": {
2302
+ "type": "string",
2303
+ "enum": ["code_25", "code_39", "code_93", "code_128", "ean_13", "ean_8", "upc_a", "pdf417"]
2304
+ },
2305
+ "hidden": {
2306
+ "type": "boolean"
2307
+ },
2308
+ "x": {
2309
+ "type": "number",
2310
+ "minimum": 0
2311
+ },
2312
+ "y": {
2313
+ "type": "number",
2314
+ "minimum": 0
2315
+ },
2316
+ "width": {
2317
+ "type": "number",
2318
+ "exclusiveMinimum": 0
2319
+ },
2320
+ "height": {
2321
+ "type": "number",
2322
+ "exclusiveMinimum": 0
2323
+ },
2324
+ "rotation": {
2325
+ "type": "number",
2326
+ "minimum": -360,
2327
+ "maximum": 360
2328
+ },
2329
+ "display_type": {
2330
+ "type": "string",
2331
+ "enum": ["text", "check", "qrcode", "barcode", "image", "shape"]
2332
+ },
2333
+ "opacity": {
2334
+ "type": "number",
2335
+ "minimum": 0,
2336
+ "maximum": 1
2337
+ },
2338
+ "date_time_format": {
2339
+ "type": ["string", "null"]
2340
+ },
2341
+ "typeface": {
2342
+ "type": ["string", "null"],
2343
+ "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]
2344
+ },
2345
+ "font_size": {
2346
+ "type": ["integer", "null"],
2347
+ "minimum": 1
2348
+ },
2349
+ "character_spacing": {
2350
+ "type": "number",
2351
+ "minimum": 0,
2352
+ "maximum": 50
2353
+ },
2354
+ "bold": {
2355
+ "type": "boolean"
2356
+ },
2357
+ "uppercase": {
2358
+ "type": "boolean"
2359
+ },
2360
+ "strikethrough": {
2361
+ "type": "boolean"
2362
+ },
2363
+ "keep_leading_spaces": {
2364
+ "type": "boolean"
2365
+ },
2366
+ "overflow": {
2367
+ "type": "string",
2368
+ "enum": ["shrink_to_fit", "truncate"]
2369
+ },
2370
+ "multiline": {
2371
+ "type": "boolean"
2372
+ },
2373
+ "multiline_lines": {
2374
+ "type": ["integer", "null"],
2375
+ "minimum": 1,
2376
+ "maximum": 300
2377
+ },
2378
+ "min_length": {
2379
+ "type": "number"
2380
+ },
2381
+ "max_length": {
2382
+ "type": ["integer", "null"],
2383
+ "minimum": 0
2384
+ },
2385
+ "auto_calculate_max_length": {
2386
+ "type": "boolean"
2387
+ },
2388
+ "color": {
2389
+ "type": ["string", "null"],
2390
+ "pattern": "^[A-Fa-f0-9]{6}$",
2391
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2392
+ },
2393
+ "color_field_name": {
2394
+ "type": ["string", "null"]
2395
+ },
2396
+ "color_field_required": {
2397
+ "type": "boolean"
2398
+ },
2399
+ "background_color": {
2400
+ "type": ["string", "null"],
2401
+ "pattern": "^[A-Fa-f0-9]{6}$",
2402
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2403
+ },
2404
+ "background_color_field_name": {
2405
+ "type": ["string", "null"]
2406
+ },
2407
+ "background_color_field_required": {
2408
+ "type": "boolean"
2409
+ },
2410
+ "alignment": {
2411
+ "type": "string",
2412
+ "enum": ["left", "center", "right", "justify"]
2413
+ },
2414
+ "v_alignment": {
2415
+ "type": "string",
2416
+ "enum": ["bottom", "center", "top"]
2417
+ },
2418
+ "comb": {
2419
+ "type": "boolean"
2420
+ },
2421
+ "comb_number_of_cells": {
2422
+ "type": "integer",
2423
+ "minimum": 1
2424
+ },
2425
+ "comb_value_offset": {
2426
+ "type": "integer",
2427
+ "minimum": 0
2428
+ },
2429
+ "shape_type": {
2430
+ "type": "string",
2431
+ "enum": ["square", "rectangle", "circle", "ellipse", "triangle", "polygon"]
2432
+ },
2433
+ "shape_sides": {
2434
+ "type": "integer",
2435
+ "minimum": 3,
2436
+ "maximum": 12
2437
+ },
2438
+ "shape_border_width": {
2439
+ "type": "integer",
2440
+ "minimum": 1
2441
+ },
2442
+ "shape_border_color": {
2443
+ "type": "string",
2444
+ "pattern": "^[A-Fa-f0-9]{6}$",
2445
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2446
+ },
2447
+ "shape_border_color_field_name": {
2448
+ "type": ["string", "null"]
2449
+ },
2450
+ "shape_border_color_field_required": {
2451
+ "type": "boolean"
2452
+ },
2453
+ "shape_fill_color": {
2454
+ "type": ["string", "null"],
2455
+ "pattern": "^[A-Fa-f0-9]{6}$",
2456
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2457
+ },
2458
+ "shape_fill_color_field_name": {
2459
+ "type": ["string", "null"]
2460
+ },
2461
+ "shape_fill_color_field_required": {
2462
+ "type": "boolean"
2463
+ },
2464
+ "check_character": {
2465
+ "type": "string",
2466
+ "enum": ["✓", "✔", "✖", "✗", "✘"]
2467
+ },
2468
+ "check_color": {
2469
+ "type": ["string", "null"],
2470
+ "pattern": "^[A-Fa-f0-9]{6}$",
2471
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2472
+ },
2473
+ "check_color_field_name": {
2474
+ "type": ["string", "null"]
2475
+ },
2476
+ "check_color_field_required": {
2477
+ "type": "boolean"
2478
+ },
2479
+ "qrcode_color": {
2480
+ "type": ["string", "null"],
2481
+ "pattern": "^[A-Fa-f0-9]{6}$",
2482
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
2483
+ },
2484
+ "qrcode_color_field_name": {
2485
+ "type": ["string", "null"]
2486
+ },
2487
+ "qrcode_color_field_required": {
2488
+ "type": "boolean"
2489
+ },
2490
+ "true_text": {
2491
+ "type": ["string", "null"]
2492
+ },
2493
+ "false_text": {
2494
+ "type": ["string", "null"]
2495
+ },
2496
+ "condition": {
2497
+ "type": ["string", "null"]
2498
+ },
2499
+ "string_condition_type": {
2500
+ "type": "string",
2501
+ "enum": ["equals", "contains", "starts_with", "ends_with", "regex"]
2502
+ },
2503
+ "number_condition_type": {
2504
+ "type": "string",
2505
+ "enum": ["equals", "range", "gte", "gt", "lte", "lt"]
2506
+ },
2507
+ "number_condition_range_min": {
2508
+ "type": ["number", "null"]
2509
+ },
2510
+ "number_condition_range_max": {
2511
+ "type": ["number", "null"]
2512
+ },
2513
+ "number_condition_range_exclusive_min": {
2514
+ "type": "boolean"
2515
+ },
2516
+ "number_condition_range_exclusive_max": {
2517
+ "type": "boolean"
2518
+ },
2519
+ "invert_boolean_condition": {
2520
+ "type": "boolean"
2521
+ },
2522
+ "currency": {
2523
+ "type": "boolean"
2524
+ },
2525
+ "decimal_places": {
2526
+ "type": ["integer", "null"],
2527
+ "minimum": 0,
2528
+ "maximum": 99
2529
+ },
2530
+ "image_scale_type": {
2531
+ "type": "string",
2532
+ "enum": ["fit", "fill", "stretch"]
2533
+ },
2534
+ "image_gravity": {
2535
+ "type": "string",
2536
+ "enum": ["NorthWest", "North", "NorthEast", "West", "Center", "East", "SouthWest", "South", "SouthEast"]
2537
+ },
2538
+ "dependencies": {
2539
+ "type": ["object", "null"],
2540
+ "required": ["action", "conditions"],
2541
+ "properties": {
2542
+ "action": {
2543
+ "type": "string",
2544
+ "enum": ["require_and_show", "show", "require"]
2545
+ },
2546
+ "match": {
2547
+ "type": "string",
2548
+ "enum": ["all", "any"]
2549
+ },
2550
+ "conditions": {
2551
+ "type": "array",
2552
+ "items": {
2553
+ "oneOf": [{
2554
+ "$ref": "#/components/schemas/FieldPresenceCondition"
2555
+ }, {
2556
+ "$ref": "#/components/schemas/FieldEqualsCondition"
2557
+ }, {
2558
+ "$ref": "#/components/schemas/FieldInCondition"
2559
+ }, {
2560
+ "$ref": "#/components/schemas/FieldComparisonCondition"
2561
+ }, {
2562
+ "$ref": "#/components/schemas/FieldRangeCondition"
2563
+ }],
2564
+ "discriminator": {
2565
+ "propertyName": "operator",
2566
+ "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"]]
2567
+ }
2568
+ }
2569
+ }
2570
+ },
2571
+ "additionalProperties": false
2572
+ },
2573
+ "id": {
2574
+ "type": "integer",
2575
+ "minimum": 0
2576
+ }
2577
+ },
2578
+ "additionalProperties": false
2579
+ }
2580
+ }
2581
+ },
2582
+ "additionalProperties": false
2583
+ }
2584
+ }
2585
+ },
2586
+ "updateWebhook": {
2587
+ "body": {
2588
+ "mediaType": "application/json",
2589
+ "required": true,
2590
+ "schema": {
2591
+ "type": "object",
2592
+ "properties": {
2593
+ "name": {
2594
+ "type": ["string", "null"],
2595
+ "maxLength": 255
2596
+ },
2597
+ "url": {
2598
+ "type": "string",
2599
+ "format": "uri"
2600
+ },
2601
+ "enabled": {
2602
+ "type": "boolean"
2603
+ },
2604
+ "event_types": {
2605
+ "type": "array",
2606
+ "minItems": 1,
2607
+ "uniqueItems": true,
2608
+ "items": {
2609
+ "type": "string",
2610
+ "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"]
2611
+ }
2612
+ },
2613
+ "mode": {
2614
+ "type": ["string", "null"],
2615
+ "enum": ["test", "live", null]
2616
+ },
2617
+ "api_token_ids": {
2618
+ "type": "array",
2619
+ "uniqueItems": true,
2620
+ "items": {
2621
+ "type": "string"
2622
+ }
2623
+ },
2624
+ "template_ids": {
2625
+ "type": "array",
2626
+ "uniqueItems": true,
2627
+ "items": {
2628
+ "type": "string"
2629
+ }
2630
+ },
2631
+ "folder_ids": {
2632
+ "type": "array",
2633
+ "uniqueItems": true,
2634
+ "items": {
2635
+ "type": "string"
2636
+ }
2637
+ },
2638
+ "include_submission_data": {
2639
+ "type": "boolean"
2640
+ },
2641
+ "strip_fields": {
2642
+ "type": "array",
2643
+ "items": {
2644
+ "type": "string"
2645
+ }
2646
+ },
2647
+ "headers": {
2648
+ "type": "object",
2649
+ "additionalProperties": {
2650
+ "type": "string"
2651
+ }
2652
+ }
2653
+ },
2654
+ "additionalProperties": false
2655
+ }
2656
+ }
2657
+ },
2658
+ "uploadTemplate": {
2659
+ "query": {
2660
+ "wait": {
2661
+ "required": false,
2662
+ "schema": {
2663
+ "type": "boolean"
2664
+ }
2665
+ }
2666
+ },
2667
+ "body": {
2668
+ "mediaType": "multipart/form-data",
2669
+ "required": true,
2670
+ "schema": {
2671
+ "type": "object",
2672
+ "required": ["document"],
2673
+ "properties": {
2674
+ "document": {
2675
+ "type": "string",
2676
+ "format": "binary"
2677
+ },
2678
+ "name": {
2679
+ "type": "string",
2680
+ "minLength": 1,
2681
+ "maxLength": 255
2682
+ },
2683
+ "description": {
2684
+ "type": "string"
2685
+ },
2686
+ "parent_folder_id": {
2687
+ "type": "string",
2688
+ "minLength": 1
2689
+ },
2690
+ "ai_field_naming_language": {
2691
+ "type": "string",
2692
+ "enum": ["auto", "english", "form_language"]
2693
+ },
2694
+ "detect_fields": {
2695
+ "type": "boolean"
2696
+ },
2697
+ "field_source": {
2698
+ "type": "string",
2699
+ "enum": ["auto", "pdf_detection", "pdf_form_fields"]
2700
+ },
2701
+ "field_naming": {
2702
+ "type": "string",
2703
+ "enum": ["ai", "preserve"]
2704
+ },
2705
+ "field_logic": {
2706
+ "type": "string",
2707
+ "enum": ["ai", "none"]
2708
+ }
2709
+ },
2710
+ "additionalProperties": false
2711
+ }
2712
+ }
2713
+ },
2714
+ "uploadTemplateDocument": {
2715
+ "query": {
2716
+ "wait": {
2717
+ "required": false,
2718
+ "schema": {
2719
+ "type": "boolean"
2720
+ }
2721
+ }
2722
+ },
2723
+ "body": {
2724
+ "mediaType": "multipart/form-data",
2725
+ "required": true,
2726
+ "schema": {
2727
+ "type": "object",
2728
+ "required": ["document"],
2729
+ "properties": {
2730
+ "document": {
2731
+ "type": "string",
2732
+ "format": "binary"
2733
+ },
2734
+ "reimport_fields": {
2735
+ "type": "boolean"
2736
+ }
2737
+ },
2738
+ "additionalProperties": false
2739
+ }
2740
+ }
2741
+ },
2742
+ "validateSubmission": {
2743
+ "query": {
2744
+ "version": {
2745
+ "required": false,
2746
+ "schema": {
2747
+ "type": "string",
2748
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
2749
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
2750
+ }
2751
+ }
2752
+ },
2753
+ "body": {
2754
+ "mediaType": "application/json",
2755
+ "required": true,
2756
+ "schema": {
2757
+ "type": "object",
2758
+ "properties": {
2759
+ "test": {
2760
+ "type": "boolean"
2761
+ },
2762
+ "editable": {
2763
+ "type": "boolean"
2764
+ },
2765
+ "data": {
2766
+ "type": "object"
2767
+ },
2768
+ "metadata": {
2769
+ "type": "object"
2770
+ },
2771
+ "password": {
2772
+ "type": "string",
2773
+ "minLength": 1
2774
+ },
2775
+ "output_formats": {
2776
+ "type": "array",
2777
+ "minItems": 1,
2778
+ "uniqueItems": true,
2779
+ "items": {
2780
+ "type": "string",
2781
+ "enum": ["pdf", "png"]
2782
+ }
2783
+ },
2784
+ "expires_in": {
2785
+ "type": "integer",
2786
+ "minimum": 1,
2787
+ "maximum": 315360000
2788
+ },
2789
+ "field_overrides": {
2790
+ "type": "object",
2791
+ "additionalProperties": {
2792
+ "$ref": "#/components/schemas/FieldOverride"
2793
+ }
2794
+ },
2795
+ "html": {
2796
+ "type": "string"
2797
+ },
2798
+ "css": {
2799
+ "type": "string"
2800
+ },
2801
+ "signature_requests": {
2802
+ "type": "array",
2803
+ "maxItems": 100,
2804
+ "items": {
2805
+ "type": "object",
2806
+ "properties": {
2807
+ "name": {
2808
+ "type": ["string", "null"],
2809
+ "maxLength": 255
2810
+ },
2811
+ "email": {
2812
+ "type": ["string", "null"],
2813
+ "maxLength": 255
2814
+ },
2815
+ "fields": {
2816
+ "type": "array",
2817
+ "minItems": 1,
2818
+ "uniqueItems": true,
2819
+ "items": {
2820
+ "type": "string",
2821
+ "minLength": 1
2822
+ }
2823
+ },
2824
+ "metadata": {
2825
+ "type": "object"
2826
+ },
2827
+ "role": {
2828
+ "type": "string",
2829
+ "minLength": 1
2830
+ },
2831
+ "auth_type": {
2832
+ "type": "string",
2833
+ "enum": ["password", "oauth", "email_link", "phone_number", "ldap", "saml"]
2834
+ },
2835
+ "auth_second_factor_type": {
2836
+ "type": "string",
2837
+ "enum": ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"]
2838
+ },
2839
+ "auth_provider": {
2840
+ "type": ["string", "null"],
2841
+ "maxLength": 255
2842
+ },
2843
+ "auth_session_started_at": {
2844
+ "type": ["string", "null"],
2845
+ "format": "date-time"
2846
+ },
2847
+ "auth_session_id_hash": {
2848
+ "type": ["string", "null"]
2849
+ },
2850
+ "auth_user_id_hash": {
2851
+ "type": ["string", "null"]
2852
+ },
2853
+ "auth_username_hash": {
2854
+ "type": ["string", "null"]
2855
+ },
2856
+ "auth_phone_number_hash": {
2857
+ "type": ["string", "null"]
2858
+ },
2859
+ "ignore_unknown_fields": {
2860
+ "type": "boolean"
2861
+ },
2862
+ "prefilled_values_editable": {
2863
+ "type": "boolean"
2864
+ }
2865
+ },
2866
+ "required": ["fields", "auth_type"],
2867
+ "additionalProperties": false
2868
+ }
2869
+ }
2870
+ },
2871
+ "additionalProperties": false
2872
+ }
2873
+ }
2874
+ }
2875
+ },
2876
+ "routes": {
2877
+ "DELETE /combined_pdfs/{combined_pdf_id}": "expireCombinedPdf",
2878
+ "DELETE /custom_files/{custom_file_id}": "deleteCustomFile",
2879
+ "DELETE /folders/{folder_id}": "deleteFolder",
2880
+ "DELETE /submissions/{submission_id}": "expireSubmission",
2881
+ "DELETE /templates/{template_id}": "deleteTemplate",
2882
+ "DELETE /webhooks/{webhook_id}": "deleteWebhook",
2883
+ "GET /authentication": "testAuthentication",
2884
+ "GET /combined_pdfs": "listCombinedPdfs",
2885
+ "GET /combined_pdfs/{combined_pdf_id}": "getCombinedPdf",
2886
+ "GET /custom_files": "listCustomFiles",
2887
+ "GET /custom_files/{custom_file_id}": "getCustomFile",
2888
+ "GET /folders": "listFolders",
2889
+ "GET /folders/{folder_id}": "getFolder",
2890
+ "GET /signature_requests/{signature_request_id}": "getSignatureRequest",
2891
+ "GET /submissions": "listSubmissions",
2892
+ "GET /submissions/batches/{submission_batch_id}": "getSubmissionBatch",
2893
+ "GET /submissions/{submission_id}": "getSubmission",
2894
+ "GET /templates": "listTemplates",
2895
+ "GET /templates/{template_id}": "getTemplate",
2896
+ "GET /templates/{template_id}/diff": "getTemplateDiff",
2897
+ "GET /templates/{template_id}/fields": "listTemplateFields",
2898
+ "GET /templates/{template_id}/model_code": "getTemplateModelCode",
2899
+ "GET /templates/{template_id}/page_images": "getTemplatePageImages",
2900
+ "GET /templates/{template_id}/schema": "getTemplateSchema",
2901
+ "GET /templates/{template_id}/submissions": "listTemplateSubmissions",
2902
+ "GET /uploads/presign": "getPresignUrl",
2903
+ "GET /webhooks": "listWebhooks",
2904
+ "GET /webhooks/{webhook_id}": "getWebhook",
2905
+ "POST /combined_pdfs": "createCombinedPdf",
2906
+ "POST /custom_files": "createCustomFileFromUpload",
2907
+ "POST /folders": "createFolder",
2908
+ "POST /folders/{folder_id}/move": "moveFolder",
2909
+ "POST /folders/{folder_id}/rename": "renameFolder",
2910
+ "POST /signature_requests/{signature_request_id}/events": "createSignatureRequestEvent",
2911
+ "POST /signature_requests/{signature_request_id}/tokens": "createSignatureRequestToken",
2912
+ "POST /submissions/batches": "createSubmissionBatch",
2913
+ "POST /submissions/{submission_id}/generate_files": "generateSubmissionFiles",
2914
+ "POST /submissions/{submission_id}/generate_preview": "generateSubmissionPreview",
2915
+ "POST /templates": "createTemplate",
2916
+ "POST /templates/upload": "uploadTemplate",
2917
+ "POST /templates/{template_id}/copy": "copyTemplate",
2918
+ "POST /templates/{template_id}/fields": "addTemplateFields",
2919
+ "POST /templates/{template_id}/fields/remove": "removeTemplateFields",
2920
+ "POST /templates/{template_id}/fields/reorder": "reorderTemplateFields",
2921
+ "POST /templates/{template_id}/move": "moveTemplate",
2922
+ "POST /templates/{template_id}/publish_version": "publishTemplateVersion",
2923
+ "POST /templates/{template_id}/restore_version": "restoreTemplateVersion",
2924
+ "POST /templates/{template_id}/submissions": "createSubmission",
2925
+ "POST /templates/{template_id}/submissions/validate": "validateSubmission",
2926
+ "POST /webhooks": "createWebhook",
2927
+ "PUT /signature_requests/{signature_request_id}": "updateSignatureRequest",
2928
+ "PUT /templates/{template_id}": "updateTemplate",
2929
+ "PUT /templates/{template_id}/document": "updateTemplateDocument",
2930
+ "PUT /templates/{template_id}/document/upload": "uploadTemplateDocument",
2931
+ "PUT /templates/{template_id}/fields": "updateTemplateFields",
2932
+ "PUT /webhooks/{webhook_id}": "updateWebhook"
2933
+ },
2934
+ "components": {
2935
+ "schemas": {
2936
+ "CombinedPdfSourcePdf": {
2937
+ "type": "object",
2938
+ "required": ["type", "id"],
2939
+ "properties": {
2940
+ "type": {
2941
+ "type": "string",
2942
+ "const": "combined_pdf"
2943
+ },
2944
+ "id": {
2945
+ "type": "string",
2946
+ "minLength": 1
2947
+ }
2948
+ },
2949
+ "additionalProperties": false,
2950
+ "x-not-allowed-properties": {
2951
+ "url": "isn't used by 'combined_pdf' source PDFs. Remove it",
2952
+ "template_version": "isn't used by 'combined_pdf' source PDFs. Remove it",
2953
+ "processed": "isn't used by 'combined_pdf' source PDFs. Remove it"
2954
+ }
2955
+ },
2956
+ "CustomFileSourcePdf": {
2957
+ "type": "object",
2958
+ "required": ["type", "id"],
2959
+ "properties": {
2960
+ "type": {
2961
+ "type": "string",
2962
+ "const": "custom_file"
2963
+ },
2964
+ "id": {
2965
+ "type": "string",
2966
+ "minLength": 1
2967
+ }
2968
+ },
2969
+ "additionalProperties": false,
2970
+ "x-not-allowed-properties": {
2971
+ "url": "isn't used by 'custom_file' source PDFs. Remove it",
2972
+ "template_version": "isn't used by 'custom_file' source PDFs. Remove it",
2973
+ "processed": "isn't used by 'custom_file' source PDFs. Remove it"
2974
+ }
2975
+ },
2976
+ "FieldComparisonCondition": {
2977
+ "type": "object",
2978
+ "required": ["field", "operator", "value"],
2979
+ "properties": {
2980
+ "field": {
2981
+ "type": "string"
2982
+ },
2983
+ "operator": {
2984
+ "type": "string",
2985
+ "enum": ["gt", "gte", "lt", "lte"]
2986
+ },
2987
+ "value": {
2988
+ "type": ["number", "string"],
2989
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
2990
+ "x-pattern-message": "must be a number, like 10 or 2.5"
2991
+ }
2992
+ },
2993
+ "additionalProperties": false,
2994
+ "x-not-allowed-properties": {
2995
+ "range_max": "isn't used by 'gt', 'gte', 'lt' or 'lte' conditions. Remove it"
2996
+ }
2997
+ },
2998
+ "FieldEqualsCondition": {
2999
+ "type": "object",
3000
+ "required": ["field", "operator", "value"],
3001
+ "properties": {
3002
+ "field": {
3003
+ "type": "string"
3004
+ },
3005
+ "operator": {
3006
+ "type": "string",
3007
+ "enum": ["equals", "not_equals"]
3008
+ },
3009
+ "value": {
3010
+ "type": ["string", "number", "boolean"]
3011
+ }
3012
+ },
3013
+ "additionalProperties": false,
3014
+ "x-not-allowed-properties": {
3015
+ "range_max": "isn't used by 'equals' or 'not_equals' conditions. Remove it"
3016
+ }
3017
+ },
3018
+ "FieldInCondition": {
3019
+ "type": "object",
3020
+ "required": ["field", "operator", "value"],
3021
+ "properties": {
3022
+ "field": {
3023
+ "type": "string"
3024
+ },
3025
+ "operator": {
3026
+ "type": "string",
3027
+ "const": "in"
3028
+ },
3029
+ "value": {
3030
+ "type": "array",
3031
+ "minItems": 1,
3032
+ "items": {
3033
+ "type": ["string", "number", "boolean"],
3034
+ "minLength": 1
3035
+ }
3036
+ }
3037
+ },
3038
+ "additionalProperties": false,
3039
+ "x-not-allowed-properties": {
3040
+ "range_max": "isn't used by 'in' conditions. Remove it"
3041
+ }
3042
+ },
3043
+ "FieldOverride": {
3044
+ "type": "object",
3045
+ "properties": {
3046
+ "static": {
3047
+ "type": "boolean"
3048
+ },
3049
+ "editable": {
3050
+ "type": "boolean"
3051
+ },
3052
+ "default": {
3053
+ "type": ["string", "null"]
3054
+ },
3055
+ "title": {
3056
+ "type": "string"
3057
+ },
3058
+ "required": {
3059
+ "type": "boolean"
3060
+ },
3061
+ "option_list": {
3062
+ "type": ["string", "null"]
3063
+ },
3064
+ "combined_field_names": {
3065
+ "type": "string"
3066
+ },
3067
+ "combined_field_type": {
3068
+ "type": "string",
3069
+ "enum": ["separator", "format"]
3070
+ },
3071
+ "combined_field_separator": {
3072
+ "type": "string"
3073
+ },
3074
+ "combined_field_format": {
3075
+ "type": "string"
3076
+ },
3077
+ "integer": {
3078
+ "type": "boolean"
3079
+ },
3080
+ "include_time": {
3081
+ "type": ["boolean", "null"]
3082
+ },
3083
+ "signature_allow_draw": {
3084
+ "type": "boolean"
3085
+ },
3086
+ "signature_allow_type": {
3087
+ "type": "boolean"
3088
+ },
3089
+ "barcode_symbology": {
3090
+ "type": "string",
3091
+ "enum": ["code_25", "code_39", "code_93", "code_128", "ean_13", "ean_8", "upc_a", "pdf417"]
3092
+ },
3093
+ "hidden": {
3094
+ "type": "boolean"
3095
+ },
3096
+ "x": {
3097
+ "type": "number",
3098
+ "minimum": 0
3099
+ },
3100
+ "y": {
3101
+ "type": "number",
3102
+ "minimum": 0
3103
+ },
3104
+ "width": {
3105
+ "type": "number",
3106
+ "exclusiveMinimum": 0
3107
+ },
3108
+ "height": {
3109
+ "type": "number",
3110
+ "exclusiveMinimum": 0
3111
+ },
3112
+ "rotation": {
3113
+ "type": "number",
3114
+ "minimum": -360,
3115
+ "maximum": 360
3116
+ },
3117
+ "display_type": {
3118
+ "type": "string",
3119
+ "enum": ["text", "check", "qrcode", "barcode", "image", "shape"]
3120
+ },
3121
+ "opacity": {
3122
+ "type": "number",
3123
+ "minimum": 0,
3124
+ "maximum": 1
3125
+ },
3126
+ "date_time_format": {
3127
+ "type": ["string", "null"]
3128
+ },
3129
+ "typeface": {
3130
+ "type": ["string", "null"],
3131
+ "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]
3132
+ },
3133
+ "font_size": {
3134
+ "type": ["integer", "null"],
3135
+ "minimum": 1
3136
+ },
3137
+ "character_spacing": {
3138
+ "type": "number",
3139
+ "minimum": 0,
3140
+ "maximum": 50
3141
+ },
3142
+ "bold": {
3143
+ "type": "boolean"
3144
+ },
3145
+ "uppercase": {
3146
+ "type": "boolean"
3147
+ },
3148
+ "strikethrough": {
3149
+ "type": "boolean"
3150
+ },
3151
+ "keep_leading_spaces": {
3152
+ "type": "boolean"
3153
+ },
3154
+ "overflow": {
3155
+ "type": "string",
3156
+ "enum": ["shrink_to_fit", "truncate"]
3157
+ },
3158
+ "multiline": {
3159
+ "type": "boolean"
3160
+ },
3161
+ "multiline_lines": {
3162
+ "type": ["integer", "null"],
3163
+ "minimum": 1,
3164
+ "maximum": 300
3165
+ },
3166
+ "max_length": {
3167
+ "type": ["integer", "null"],
3168
+ "minimum": 0
3169
+ },
3170
+ "color": {
3171
+ "type": ["string", "null"],
3172
+ "pattern": "^[A-Fa-f0-9]{6}$",
3173
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3174
+ },
3175
+ "background_color": {
3176
+ "type": ["string", "null"],
3177
+ "pattern": "^[A-Fa-f0-9]{6}$",
3178
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3179
+ },
3180
+ "alignment": {
3181
+ "type": "string",
3182
+ "enum": ["left", "center", "right", "justify"]
3183
+ },
3184
+ "v_alignment": {
3185
+ "type": "string",
3186
+ "enum": ["bottom", "center", "top"]
3187
+ },
3188
+ "comb": {
3189
+ "type": "boolean"
3190
+ },
3191
+ "comb_number_of_cells": {
3192
+ "type": "integer",
3193
+ "minimum": 1
3194
+ },
3195
+ "comb_value_offset": {
3196
+ "type": "integer",
3197
+ "minimum": 0
3198
+ },
3199
+ "shape_type": {
3200
+ "type": "string",
3201
+ "enum": ["square", "rectangle", "circle", "ellipse", "triangle", "polygon"]
3202
+ },
3203
+ "shape_sides": {
3204
+ "type": "integer",
3205
+ "minimum": 3,
3206
+ "maximum": 12
3207
+ },
3208
+ "shape_border_width": {
3209
+ "type": "integer",
3210
+ "minimum": 1
3211
+ },
3212
+ "shape_border_color": {
3213
+ "type": "string",
3214
+ "pattern": "^[A-Fa-f0-9]{6}$",
3215
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3216
+ },
3217
+ "shape_fill_color": {
3218
+ "type": ["string", "null"],
3219
+ "pattern": "^[A-Fa-f0-9]{6}$",
3220
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3221
+ },
3222
+ "check_character": {
3223
+ "type": "string",
3224
+ "enum": ["✓", "✔", "✖", "✗", "✘"]
3225
+ },
3226
+ "check_color": {
3227
+ "type": ["string", "null"],
3228
+ "pattern": "^[A-Fa-f0-9]{6}$",
3229
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3230
+ },
3231
+ "qrcode_color": {
3232
+ "type": ["string", "null"],
3233
+ "pattern": "^[A-Fa-f0-9]{6}$",
3234
+ "x-pattern-message": "must be a 6-digit hex color without #, like FF0000"
3235
+ },
3236
+ "true_text": {
3237
+ "type": ["string", "null"]
3238
+ },
3239
+ "false_text": {
3240
+ "type": ["string", "null"]
3241
+ },
3242
+ "condition": {
3243
+ "type": ["string", "null"]
3244
+ },
3245
+ "string_condition_type": {
3246
+ "type": "string",
3247
+ "enum": ["equals", "contains", "starts_with", "ends_with", "regex"]
3248
+ },
3249
+ "number_condition_type": {
3250
+ "type": "string",
3251
+ "enum": ["equals", "range", "gte", "gt", "lte", "lt"]
3252
+ },
3253
+ "number_condition_range_min": {
3254
+ "type": ["number", "null"]
3255
+ },
3256
+ "number_condition_range_max": {
3257
+ "type": ["number", "null"]
3258
+ },
3259
+ "number_condition_range_exclusive_min": {
3260
+ "type": "boolean"
3261
+ },
3262
+ "number_condition_range_exclusive_max": {
3263
+ "type": "boolean"
3264
+ },
3265
+ "invert_boolean_condition": {
3266
+ "type": "boolean"
3267
+ },
3268
+ "decimal_places": {
3269
+ "type": ["integer", "null"],
3270
+ "minimum": 0,
3271
+ "maximum": 99
3272
+ },
3273
+ "image_scale_type": {
3274
+ "type": "string",
3275
+ "enum": ["fit", "fill", "stretch"]
3276
+ },
3277
+ "image_gravity": {
3278
+ "type": "string",
3279
+ "enum": ["NorthWest", "North", "NorthEast", "West", "Center", "East", "SouthWest", "South", "SouthEast"]
3280
+ }
3281
+ },
3282
+ "x-unknown-property-message": "isn't a field setting",
3283
+ "x-not-allowed-properties": {
3284
+ "id": "can't be changed for one submission. Change the field in the template",
3285
+ "name": "can't be changed for one submission. Change the field in the template",
3286
+ "type": "can't be changed for one submission. Change the field in the template",
3287
+ "field_count": "can't be changed for one submission. Change the field in the template",
3288
+ "fieldCount": "can't be changed for one submission. Change the field in the template",
3289
+ "dependencies": "can't be changed for one submission. Change the field in the template",
3290
+ "acroform_name": "can't be changed for one submission. Change the field in the template",
3291
+ "allow_additional_items": "can't be changed for one submission. Change the field in the template",
3292
+ "allowAdditionalItems": "can't be changed for one submission. Change the field in the template",
3293
+ "min_items": "can't be changed for one submission. Change the field in the template",
3294
+ "minItems": "can't be changed for one submission. Change the field in the template",
3295
+ "max_items": "can't be changed for one submission. Change the field in the template",
3296
+ "maxItems": "can't be changed for one submission. Change the field in the template",
3297
+ "description": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3298
+ "placeholder": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3299
+ "metadata": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3300
+ "minimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3301
+ "maximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3302
+ "exclusive_minimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3303
+ "exclusiveMinimum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3304
+ "exclusive_maximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3305
+ "exclusiveMaximum": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3306
+ "currency": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3307
+ "min_length": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3308
+ "minLength": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3309
+ "auto_calculate_max_length": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3310
+ "autoCalculateMaxLength": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3311
+ "color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3312
+ "colorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3313
+ "color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3314
+ "colorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3315
+ "background_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3316
+ "backgroundColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3317
+ "background_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3318
+ "backgroundColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3319
+ "check_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3320
+ "checkColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3321
+ "check_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3322
+ "checkColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3323
+ "qrcode_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3324
+ "qrcodeColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3325
+ "qrcode_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3326
+ "qrcodeColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3327
+ "shape_border_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3328
+ "shapeBorderColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3329
+ "shape_border_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3330
+ "shapeBorderColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3331
+ "shape_fill_color_field_name": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3332
+ "shapeFillColorFieldName": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3333
+ "shape_fill_color_field_required": "can't be changed for one submission: the template's setting always applies. Change it in the template",
3334
+ "shapeFillColorFieldRequired": "can't be changed for one submission: the template's setting always applies. Change it in the template"
3335
+ },
3336
+ "additionalProperties": false
3337
+ },
3338
+ "FieldPresenceCondition": {
3339
+ "type": "object",
3340
+ "required": ["field", "operator"],
3341
+ "properties": {
3342
+ "field": {
3343
+ "type": "string"
3344
+ },
3345
+ "operator": {
3346
+ "type": "string",
3347
+ "enum": ["present", "blank"]
3348
+ }
3349
+ },
3350
+ "additionalProperties": false,
3351
+ "x-not-allowed-properties": {
3352
+ "value": "isn't used by 'present' or 'blank' conditions. Remove it",
3353
+ "range_max": "isn't used by 'present' or 'blank' conditions. Remove it"
3354
+ }
3355
+ },
3356
+ "FieldRangeCondition": {
3357
+ "type": "object",
3358
+ "required": ["field", "operator"],
3359
+ "properties": {
3360
+ "field": {
3361
+ "type": "string"
3362
+ },
3363
+ "operator": {
3364
+ "type": "string",
3365
+ "const": "range"
3366
+ },
3367
+ "value": {
3368
+ "type": ["number", "string", "null"],
3369
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
3370
+ "x-pattern-message": "must be a number, like 10 or 2.5"
3371
+ },
3372
+ "range_max": {
3373
+ "type": ["number", "string", "null"],
3374
+ "pattern": "^-?\\d+(\\.\\d+)?([eE][-+]?\\d+)?$",
3375
+ "x-pattern-message": "must be a number, like 10 or 2.5"
3376
+ }
3377
+ },
3378
+ "additionalProperties": false
3379
+ },
3380
+ "SubmissionSourcePdf": {
3381
+ "type": "object",
3382
+ "required": ["type", "id"],
3383
+ "properties": {
3384
+ "type": {
3385
+ "type": "string",
3386
+ "const": "submission"
3387
+ },
3388
+ "id": {
3389
+ "type": "string",
3390
+ "minLength": 1
3391
+ }
3392
+ },
3393
+ "additionalProperties": false,
3394
+ "x-not-allowed-properties": {
3395
+ "url": "isn't used by 'submission' source PDFs. Remove it",
3396
+ "template_version": "isn't used by 'submission' source PDFs. Remove it",
3397
+ "processed": "isn't used by 'submission' source PDFs. Remove it"
3398
+ }
3399
+ },
3400
+ "TemplateSourcePdf": {
3401
+ "type": "object",
3402
+ "required": ["type", "id"],
3403
+ "properties": {
3404
+ "type": {
3405
+ "type": "string",
3406
+ "const": "template"
3407
+ },
3408
+ "id": {
3409
+ "type": "string",
3410
+ "minLength": 1
3411
+ },
3412
+ "template_version": {
3413
+ "type": "string",
3414
+ "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
3415
+ "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
3416
+ },
3417
+ "processed": {
3418
+ "type": "boolean"
3419
+ }
3420
+ },
3421
+ "additionalProperties": false,
3422
+ "x-not-allowed-properties": {
3423
+ "url": "isn't used by 'template' source PDFs. Remove it"
3424
+ }
3425
+ },
3426
+ "UrlSourcePdf": {
3427
+ "type": "object",
3428
+ "required": ["type", "url"],
3429
+ "properties": {
3430
+ "type": {
3431
+ "type": "string",
3432
+ "const": "url"
3433
+ },
3434
+ "url": {
3435
+ "type": "string",
3436
+ "format": "uri"
3437
+ }
3438
+ },
3439
+ "additionalProperties": false,
3440
+ "x-not-allowed-properties": {
3441
+ "id": "isn't used by 'url' source PDFs. Remove it",
3442
+ "template_version": "isn't used by 'url' source PDFs. Remove it",
3443
+ "processed": "isn't used by 'url' source PDFs. Remove it"
3444
+ }
3445
+ }
3446
+ }
3447
+ },
3448
+ "formatMessages": {
3449
+ "uri": "must be a full URL, like https://example.com",
3450
+ "date-time": "must be a date and time in RFC 3339 format, like 2026-10-20T09:00:00Z"
3451
+ }
3452
+ };