docspring 4.0.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.
- package/README.md +10 -1
- package/dist/ApiClient.js +2 -2
- package/dist/RequestSchemas.js +1171 -16
- package/dist/api/Client.js +474 -24
- package/dist/index.js +196 -0
- package/dist/model/AddTemplateFieldsRequest.js +132 -0
- package/dist/model/AuthenticationCheck.js +1 -1
- package/dist/model/CombinedPdf.js +1 -1
- package/dist/model/CombinedPdfFiles.js +1 -1
- package/dist/model/CombinedPdfList.js +1 -1
- package/dist/model/CombinedPdfSource.js +1 -1
- package/dist/model/CombinedPdfSourceInput.js +1 -1
- package/dist/model/CombinedPdfSourcePdf.js +1 -1
- package/dist/model/CopyTemplateRequest.js +1 -1
- package/dist/model/CreateCombinedPdfRequest.js +1 -1
- package/dist/model/CreateCustomFileFromUploadRequest.js +1 -1
- package/dist/model/CreateFolderRequest.js +1 -1
- package/dist/model/CreateSignatureRequestEventRequest.js +1 -1
- package/dist/model/CreateSignatureRequestTokenRequest.js +1 -1
- package/dist/model/CreateSubmissionBatchRequest.js +15 -1
- package/dist/model/CreateSubmissionRequest.js +15 -1
- package/dist/model/CreateTemplateRequest.js +71 -3
- package/dist/model/CreateWebhookRequest.js +1 -1
- package/dist/model/CustomFile.js +1 -1
- package/dist/model/CustomFileList.js +1 -1
- package/dist/model/CustomFileSourcePdf.js +1 -1
- package/dist/model/ErrorDetail.js +1 -1
- package/dist/model/ErrorInfo.js +1 -1
- package/dist/model/ErrorResponse.js +1 -1
- package/dist/model/Field.js +1230 -0
- package/dist/model/FieldComparisonCondition.js +1 -1
- package/dist/model/FieldDependency.js +154 -0
- package/dist/model/FieldDependencyInput.js +154 -0
- package/dist/model/FieldEqualsCondition.js +1 -1
- package/dist/model/FieldGroup.js +206 -0
- package/dist/model/FieldGroupInput.js +180 -0
- package/dist/model/FieldGroupType.js +59 -0
- package/dist/model/FieldInCondition.js +1 -1
- package/dist/model/FieldInput.js +1012 -0
- package/dist/model/FieldOverride.js +1 -1
- package/dist/model/FieldPresenceCondition.js +1 -1
- package/dist/model/FieldRangeCondition.js +1 -1
- package/dist/model/FieldType.js +124 -0
- package/dist/model/Folder.js +1 -1
- package/dist/model/FolderList.js +1 -1
- package/dist/model/GenerateFilesFormat.js +54 -0
- package/dist/model/GenerateSubmissionFilesRequest.js +115 -0
- package/dist/model/GeneratedFile.js +1 -1
- package/dist/model/HtmlEngineOptions.js +1 -1
- package/dist/model/HtmlEngineOptionsInput.js +1 -1
- package/dist/model/MoveFolderRequest.js +1 -1
- package/dist/model/MoveTemplateRequest.js +1 -1
- package/dist/model/OutputFormat.js +59 -0
- package/dist/model/PageImage.js +220 -0
- package/dist/model/PageImages.js +155 -0
- package/dist/model/PredefinedField.js +183 -0
- package/dist/model/PredefinedFieldInput.js +183 -0
- package/dist/model/PublishTemplateVersionRequest.js +1 -1
- package/dist/model/RemoveTemplateFieldsRequest.js +114 -0
- package/dist/model/RenameFolderRequest.js +1 -1
- package/dist/model/ReorderTemplateFieldsRequest.js +114 -0
- package/dist/model/RestoreTemplateVersionRequest.js +1 -1
- package/dist/model/SignatureRequest.js +1 -1
- package/dist/model/SignatureRequestEvent.js +1 -1
- package/dist/model/SignatureRequestInput.js +1 -1
- package/dist/model/SignatureRequestToken.js +1 -1
- package/dist/model/Submission.js +23 -7
- package/dist/model/SubmissionAction.js +1 -1
- package/dist/model/SubmissionBatch.js +1 -1
- package/dist/model/SubmissionFiles.js +10 -1
- package/dist/model/SubmissionInput.js +15 -1
- package/dist/model/SubmissionList.js +1 -1
- package/dist/model/SubmissionSourcePdf.js +1 -1
- package/dist/model/SubmissionValidation.js +151 -0
- package/dist/model/Template.js +67 -5
- package/dist/model/TemplateActor.js +1 -1
- package/dist/model/TemplateDefaults.js +1 -1
- package/dist/model/TemplateDefaultsInput.js +1 -1
- package/dist/model/TemplateDiff.js +206 -0
- package/dist/model/TemplateDiffSummary.js +165 -0
- package/dist/model/TemplateDocument.js +7 -7
- package/dist/model/TemplateDocumentState.js +11 -1
- package/dist/model/TemplateFieldChange.js +146 -0
- package/dist/model/TemplateFieldChanges.js +196 -0
- package/dist/model/TemplateFieldDependency.js +3 -3
- package/dist/model/TemplateFieldDependencyCondition.js +1 -1
- package/dist/model/TemplateFieldDependencyConditionInput.js +1 -1
- package/dist/model/TemplateFieldDependencyInput.js +3 -3
- package/dist/model/TemplateFieldMove.js +132 -0
- package/dist/model/TemplateFields.js +147 -0
- package/dist/model/TemplateModelCode.js +1 -1
- package/dist/model/TemplatePageImages.js +158 -0
- package/dist/model/TemplatePageProcessingStatus.js +1 -1
- package/dist/model/TemplateSourcePdf.js +1 -1
- package/dist/model/TemplateSummary.js +1 -1
- package/dist/model/TemplateSummaryList.js +1 -1
- package/dist/model/TemplateVersion.js +1 -1
- package/dist/model/UpdateSignatureRequestRequest.js +1 -1
- package/dist/model/UpdateTemplateDocumentRequest.js +33 -30
- package/dist/model/UpdateTemplateFieldsRequest.js +132 -0
- package/dist/model/UpdateTemplateRequest.js +74 -1
- package/dist/model/UpdateWebhookRequest.js +1 -1
- package/dist/model/UploadPresign.js +1 -1
- package/dist/model/UrlSourcePdf.js +1 -1
- package/dist/model/ValidateSubmissionRequest.js +226 -0
- package/dist/model/Webhook.js +1 -1
- package/dist/model/WebhookList.js +1 -1
- package/package.json +1 -1
package/dist/RequestSchemas.js
CHANGED
|
@@ -7,6 +7,381 @@ exports["default"] = void 0;
|
|
|
7
7
|
// API v2's request schemas (api_clients/scripts/extract_request_schemas), for RequestValidator.js
|
|
8
8
|
var _default = exports["default"] = {
|
|
9
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
|
+
},
|
|
10
385
|
"copyTemplate": {
|
|
11
386
|
"body": {
|
|
12
387
|
"mediaType": "application/json",
|
|
@@ -216,6 +591,15 @@ var _default = exports["default"] = {
|
|
|
216
591
|
"type": "string",
|
|
217
592
|
"minLength": 1
|
|
218
593
|
},
|
|
594
|
+
"output_formats": {
|
|
595
|
+
"type": "array",
|
|
596
|
+
"minItems": 1,
|
|
597
|
+
"uniqueItems": true,
|
|
598
|
+
"items": {
|
|
599
|
+
"type": "string",
|
|
600
|
+
"enum": ["pdf", "png"]
|
|
601
|
+
}
|
|
602
|
+
},
|
|
219
603
|
"expires_in": {
|
|
220
604
|
"type": "integer",
|
|
221
605
|
"minimum": 1,
|
|
@@ -336,6 +720,15 @@ var _default = exports["default"] = {
|
|
|
336
720
|
"test": {
|
|
337
721
|
"type": "boolean"
|
|
338
722
|
},
|
|
723
|
+
"output_formats": {
|
|
724
|
+
"type": "array",
|
|
725
|
+
"minItems": 1,
|
|
726
|
+
"uniqueItems": true,
|
|
727
|
+
"items": {
|
|
728
|
+
"type": "string",
|
|
729
|
+
"enum": ["pdf", "png"]
|
|
730
|
+
}
|
|
731
|
+
},
|
|
339
732
|
"submissions": {
|
|
340
733
|
"type": "array",
|
|
341
734
|
"minItems": 1,
|
|
@@ -359,6 +752,15 @@ var _default = exports["default"] = {
|
|
|
359
752
|
"type": "string",
|
|
360
753
|
"minLength": 1
|
|
361
754
|
},
|
|
755
|
+
"output_formats": {
|
|
756
|
+
"type": "array",
|
|
757
|
+
"minItems": 1,
|
|
758
|
+
"uniqueItems": true,
|
|
759
|
+
"items": {
|
|
760
|
+
"type": "string",
|
|
761
|
+
"enum": ["pdf", "png"]
|
|
762
|
+
}
|
|
763
|
+
},
|
|
362
764
|
"expires_in": {
|
|
363
765
|
"type": "integer",
|
|
364
766
|
"minimum": 1,
|
|
@@ -642,6 +1044,43 @@ var _default = exports["default"] = {
|
|
|
642
1044
|
"additionalProperties": false
|
|
643
1045
|
}
|
|
644
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
|
+
},
|
|
645
1084
|
"html": {
|
|
646
1085
|
"type": ["string", "null"]
|
|
647
1086
|
},
|
|
@@ -697,6 +1136,17 @@ var _default = exports["default"] = {
|
|
|
697
1136
|
"minLength": 1,
|
|
698
1137
|
"maxLength": 255
|
|
699
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
|
+
},
|
|
700
1150
|
"filename": {
|
|
701
1151
|
"type": "string",
|
|
702
1152
|
"minLength": 1,
|
|
@@ -813,27 +1263,69 @@ var _default = exports["default"] = {
|
|
|
813
1263
|
"deleteWebhook": {},
|
|
814
1264
|
"expireCombinedPdf": {},
|
|
815
1265
|
"expireSubmission": {},
|
|
816
|
-
"
|
|
817
|
-
"getCombinedPdf": {},
|
|
818
|
-
"getCustomFile": {},
|
|
819
|
-
"getFolder": {},
|
|
820
|
-
"getPresignUrl": {},
|
|
821
|
-
"getSignatureRequest": {},
|
|
822
|
-
"getSubmission": {},
|
|
823
|
-
"getSubmissionBatch": {
|
|
1266
|
+
"generateSubmissionFiles": {
|
|
824
1267
|
"query": {
|
|
825
|
-
"
|
|
1268
|
+
"wait": {
|
|
826
1269
|
"required": false,
|
|
827
1270
|
"schema": {
|
|
828
1271
|
"type": "boolean"
|
|
829
1272
|
}
|
|
830
1273
|
}
|
|
831
|
-
}
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
"
|
|
836
|
-
"
|
|
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,
|
|
837
1329
|
"schema": {
|
|
838
1330
|
"type": "string",
|
|
839
1331
|
"pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
|
|
@@ -861,6 +1353,18 @@ var _default = exports["default"] = {
|
|
|
861
1353
|
}
|
|
862
1354
|
}
|
|
863
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
|
+
},
|
|
864
1368
|
"getTemplateSchema": {
|
|
865
1369
|
"query": {
|
|
866
1370
|
"version": {
|
|
@@ -984,6 +1488,18 @@ var _default = exports["default"] = {
|
|
|
984
1488
|
}
|
|
985
1489
|
}
|
|
986
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
|
+
},
|
|
987
1503
|
"listTemplateSubmissions": {
|
|
988
1504
|
"query": {
|
|
989
1505
|
"test": {
|
|
@@ -1163,6 +1679,27 @@ var _default = exports["default"] = {
|
|
|
1163
1679
|
}
|
|
1164
1680
|
}
|
|
1165
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
|
+
},
|
|
1166
1703
|
"renameFolder": {
|
|
1167
1704
|
"body": {
|
|
1168
1705
|
"mediaType": "application/json",
|
|
@@ -1183,6 +1720,26 @@ var _default = exports["default"] = {
|
|
|
1183
1720
|
}
|
|
1184
1721
|
}
|
|
1185
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
|
+
},
|
|
1186
1743
|
"restoreTemplateVersion": {
|
|
1187
1744
|
"body": {
|
|
1188
1745
|
"mediaType": "application/json",
|
|
@@ -1481,6 +2038,77 @@ var _default = exports["default"] = {
|
|
|
1481
2038
|
"additionalProperties": false
|
|
1482
2039
|
}
|
|
1483
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
|
+
},
|
|
1484
2112
|
"html": {
|
|
1485
2113
|
"type": ["string", "null"]
|
|
1486
2114
|
},
|
|
@@ -1550,13 +2178,23 @@ var _default = exports["default"] = {
|
|
|
1550
2178
|
"required": true,
|
|
1551
2179
|
"schema": {
|
|
1552
2180
|
"type": "object",
|
|
1553
|
-
"required": ["cache_id"],
|
|
1554
2181
|
"properties": {
|
|
1555
2182
|
"cache_id": {
|
|
1556
2183
|
"type": "string",
|
|
1557
2184
|
"minLength": 1,
|
|
1558
2185
|
"maxLength": 255
|
|
1559
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
|
+
},
|
|
1560
2198
|
"filename": {
|
|
1561
2199
|
"type": "string",
|
|
1562
2200
|
"minLength": 1,
|
|
@@ -1570,6 +2208,381 @@ var _default = exports["default"] = {
|
|
|
1570
2208
|
}
|
|
1571
2209
|
}
|
|
1572
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
|
+
},
|
|
1573
2586
|
"updateWebhook": {
|
|
1574
2587
|
"body": {
|
|
1575
2588
|
"mediaType": "application/json",
|
|
@@ -1725,6 +2738,139 @@ var _default = exports["default"] = {
|
|
|
1725
2738
|
"additionalProperties": false
|
|
1726
2739
|
}
|
|
1727
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
|
+
}
|
|
1728
2874
|
}
|
|
1729
2875
|
},
|
|
1730
2876
|
"routes": {
|
|
@@ -1747,7 +2893,10 @@ var _default = exports["default"] = {
|
|
|
1747
2893
|
"GET /submissions/{submission_id}": "getSubmission",
|
|
1748
2894
|
"GET /templates": "listTemplates",
|
|
1749
2895
|
"GET /templates/{template_id}": "getTemplate",
|
|
2896
|
+
"GET /templates/{template_id}/diff": "getTemplateDiff",
|
|
2897
|
+
"GET /templates/{template_id}/fields": "listTemplateFields",
|
|
1750
2898
|
"GET /templates/{template_id}/model_code": "getTemplateModelCode",
|
|
2899
|
+
"GET /templates/{template_id}/page_images": "getTemplatePageImages",
|
|
1751
2900
|
"GET /templates/{template_id}/schema": "getTemplateSchema",
|
|
1752
2901
|
"GET /templates/{template_id}/submissions": "listTemplateSubmissions",
|
|
1753
2902
|
"GET /uploads/presign": "getPresignUrl",
|
|
@@ -1761,19 +2910,25 @@ var _default = exports["default"] = {
|
|
|
1761
2910
|
"POST /signature_requests/{signature_request_id}/events": "createSignatureRequestEvent",
|
|
1762
2911
|
"POST /signature_requests/{signature_request_id}/tokens": "createSignatureRequestToken",
|
|
1763
2912
|
"POST /submissions/batches": "createSubmissionBatch",
|
|
2913
|
+
"POST /submissions/{submission_id}/generate_files": "generateSubmissionFiles",
|
|
1764
2914
|
"POST /submissions/{submission_id}/generate_preview": "generateSubmissionPreview",
|
|
1765
2915
|
"POST /templates": "createTemplate",
|
|
1766
2916
|
"POST /templates/upload": "uploadTemplate",
|
|
1767
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",
|
|
1768
2921
|
"POST /templates/{template_id}/move": "moveTemplate",
|
|
1769
2922
|
"POST /templates/{template_id}/publish_version": "publishTemplateVersion",
|
|
1770
2923
|
"POST /templates/{template_id}/restore_version": "restoreTemplateVersion",
|
|
1771
2924
|
"POST /templates/{template_id}/submissions": "createSubmission",
|
|
2925
|
+
"POST /templates/{template_id}/submissions/validate": "validateSubmission",
|
|
1772
2926
|
"POST /webhooks": "createWebhook",
|
|
1773
2927
|
"PUT /signature_requests/{signature_request_id}": "updateSignatureRequest",
|
|
1774
2928
|
"PUT /templates/{template_id}": "updateTemplate",
|
|
1775
2929
|
"PUT /templates/{template_id}/document": "updateTemplateDocument",
|
|
1776
2930
|
"PUT /templates/{template_id}/document/upload": "uploadTemplateDocument",
|
|
2931
|
+
"PUT /templates/{template_id}/fields": "updateTemplateFields",
|
|
1777
2932
|
"PUT /webhooks/{webhook_id}": "updateWebhook"
|
|
1778
2933
|
},
|
|
1779
2934
|
"components": {
|