Skip to content

Commit ecb7e2f

Browse files
committed
Update to version 4.1.0 on 2026-10-27
- New: list_template_fields, add_template_fields, update_template_fields, remove_template_fields and reorder_template_fields read and edit a template's fields (`Field`), with all their settings and their own conditional logic (`dependencies`). A field's `y` is measured from the top of its page. - New: a template's `predefined_fields` (`PredefinedField`) and `predefined_fields_sample_data`, the field names that people using the embedded template editor choose from. get_template returns them, and create_template and update_template set them. - New: a template's `field_groups` (`FieldGroup`), the groups that its fields' names make, with their titles and the settings of lists (`min_items`, `max_items`, `allow_additional_items`). get_template returns them, and update_template changes them. - New: get_template_page_images returns an image of each page of a PDF template (`TemplatePageImages`), to see where fields go. - New: get_template_diff says what changed in a template's draft since its latest published version, or in a published version since the one before it (`TemplateDiff`). - New: validate_submission checks a submission's data and settings as create_submission does, without creating the submission or using credits (`SubmissionValidation`). It doesn't check your account's credits. - New: the `png` output format, an image of each page of a submission's PDF (`files.png.pages`). Add it to `output_formats` in create_submission or create_submission_batch (it adds `pdf`), or to a processed submission with generate_submission_files. - create_template and update_template_document take a `document_url` (DocSpring downloads it) or a `document_base64` instead of a `cache_id`. While the URL downloads, the template's `document.state` is `downloading`; if it can't be downloaded, it's `download_failed` and `document.error_message` says why.
1 parent 54ca3bf commit ecb7e2f

133 files changed

Lines changed: 31055 additions & 3937 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.openapi-generator/FILES‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ README.md
55
api/openapi.yaml
66
build.gradle
77
build.sbt
8+
docs/AddTemplateFieldsRequest.md
89
docs/AiFieldNamingLanguage.md
910
docs/AuthenticationCheck.md
1011
docs/BarcodeSymbology.md
@@ -37,12 +38,19 @@ docs/ErrorDetail.md
3738
docs/ErrorInfo.md
3839
docs/ErrorResponse.md
3940
docs/ExpirationInterval.md
41+
docs/Field.md
4042
docs/FieldComparisonCondition.md
4143
docs/FieldComparisonOperator.md
44+
docs/FieldDependency.md
45+
docs/FieldDependencyInput.md
4246
docs/FieldDisplayType.md
4347
docs/FieldEqualsCondition.md
4448
docs/FieldEqualsOperator.md
49+
docs/FieldGroup.md
50+
docs/FieldGroupInput.md
51+
docs/FieldGroupType.md
4552
docs/FieldInCondition.md
53+
docs/FieldInput.md
4654
docs/FieldOverride.md
4755
docs/FieldPresenceCondition.md
4856
docs/FieldPresenceOperator.md
@@ -51,8 +59,11 @@ docs/FieldReimportState.md
5159
docs/FieldSetupLogic.md
5260
docs/FieldSetupNaming.md
5361
docs/FieldSetupSource.md
62+
docs/FieldType.md
5463
docs/Folder.md
5564
docs/FolderList.md
65+
docs/GenerateFilesFormat.md
66+
docs/GenerateSubmissionFilesRequest.md
5667
docs/GeneratedFile.md
5768
docs/GeneratedFileState.md
5869
docs/HtmlEngineOptions.md
@@ -63,9 +74,16 @@ docs/ModelCodeLanguage.md
6374
docs/MoveFolderRequest.md
6475
docs/MoveTemplateRequest.md
6576
docs/NumberConditionType.md
77+
docs/OutputFormat.md
6678
docs/PageFormat.md
79+
docs/PageImage.md
80+
docs/PageImages.md
81+
docs/PredefinedField.md
82+
docs/PredefinedFieldInput.md
6783
docs/PublishTemplateVersionRequest.md
84+
docs/RemoveTemplateFieldsRequest.md
6885
docs/RenameFolderRequest.md
86+
docs/ReorderTemplateFieldsRequest.md
6987
docs/RestoreTemplateVersionRequest.md
7088
docs/ShapeType.md
7189
docs/SignatureRequest.md
@@ -91,13 +109,18 @@ docs/SubmissionList.md
91109
docs/SubmissionSource.md
92110
docs/SubmissionSourcePdf.md
93111
docs/SubmissionState.md
112+
docs/SubmissionValidation.md
94113
docs/Template.md
95114
docs/TemplateActor.md
96115
docs/TemplateActorType.md
97116
docs/TemplateDefaults.md
98117
docs/TemplateDefaultsInput.md
118+
docs/TemplateDiff.md
119+
docs/TemplateDiffSummary.md
99120
docs/TemplateDocument.md
100121
docs/TemplateDocumentState.md
122+
docs/TemplateFieldChange.md
123+
docs/TemplateFieldChanges.md
101124
docs/TemplateFieldDependency.md
102125
docs/TemplateFieldDependencyAction.md
103126
docs/TemplateFieldDependencyCondition.md
@@ -106,12 +129,15 @@ docs/TemplateFieldDependencyInput.md
106129
docs/TemplateFieldDependencyMatch.md
107130
docs/TemplateFieldDependencyOperator.md
108131
docs/TemplateFieldLogicStatus.md
132+
docs/TemplateFieldMove.md
133+
docs/TemplateFields.md
109134
docs/TemplateFormMode.md
110135
docs/TemplateModelCode.md
111136
docs/TemplatePageAiError.md
112137
docs/TemplatePageAiNamingStatus.md
113138
docs/TemplatePageFieldsStatus.md
114139
docs/TemplatePageImageStatus.md
140+
docs/TemplatePageImages.md
115141
docs/TemplatePageProcessingStatus.md
116142
docs/TemplateSourcePdf.md
117143
docs/TemplateSummary.md
@@ -125,11 +151,13 @@ docs/TextVerticalAlignment.md
125151
docs/Typeface.md
126152
docs/UpdateSignatureRequestRequest.md
127153
docs/UpdateTemplateDocumentRequest.md
154+
docs/UpdateTemplateFieldsRequest.md
128155
docs/UpdateTemplateRequest.md
129156
docs/UpdateWebhookRequest.md
130157
docs/UploadMethod.md
131158
docs/UploadPresign.md
132159
docs/UrlSourcePdf.md
160+
docs/ValidateSubmissionRequest.md
133161
docs/Webhook.md
134162
docs/WebhookEventType.md
135163
docs/WebhookList.md
@@ -144,6 +172,7 @@ pom.xml
144172
settings.gradle
145173
src/main/AndroidManifest.xml
146174
src/main/java/com/docspring/AbstractOpenApiSchema.java
175+
src/main/java/com/docspring/AddTemplateFieldsRequest.java
147176
src/main/java/com/docspring/AiFieldNamingLanguage.java
148177
src/main/java/com/docspring/ApiClient.java
149178
src/main/java/com/docspring/ApiException.java
@@ -180,12 +209,19 @@ src/main/java/com/docspring/ErrorDetail.java
180209
src/main/java/com/docspring/ErrorInfo.java
181210
src/main/java/com/docspring/ErrorResponse.java
182211
src/main/java/com/docspring/ExpirationInterval.java
212+
src/main/java/com/docspring/Field.java
183213
src/main/java/com/docspring/FieldComparisonCondition.java
184214
src/main/java/com/docspring/FieldComparisonOperator.java
215+
src/main/java/com/docspring/FieldDependency.java
216+
src/main/java/com/docspring/FieldDependencyInput.java
185217
src/main/java/com/docspring/FieldDisplayType.java
186218
src/main/java/com/docspring/FieldEqualsCondition.java
187219
src/main/java/com/docspring/FieldEqualsOperator.java
220+
src/main/java/com/docspring/FieldGroup.java
221+
src/main/java/com/docspring/FieldGroupInput.java
222+
src/main/java/com/docspring/FieldGroupType.java
188223
src/main/java/com/docspring/FieldInCondition.java
224+
src/main/java/com/docspring/FieldInput.java
189225
src/main/java/com/docspring/FieldOverride.java
190226
src/main/java/com/docspring/FieldPresenceCondition.java
191227
src/main/java/com/docspring/FieldPresenceOperator.java
@@ -194,8 +230,11 @@ src/main/java/com/docspring/FieldReimportState.java
194230
src/main/java/com/docspring/FieldSetupLogic.java
195231
src/main/java/com/docspring/FieldSetupNaming.java
196232
src/main/java/com/docspring/FieldSetupSource.java
233+
src/main/java/com/docspring/FieldType.java
197234
src/main/java/com/docspring/Folder.java
198235
src/main/java/com/docspring/FolderList.java
236+
src/main/java/com/docspring/GenerateFilesFormat.java
237+
src/main/java/com/docspring/GenerateSubmissionFilesRequest.java
199238
src/main/java/com/docspring/GeneratedFile.java
200239
src/main/java/com/docspring/GeneratedFileState.java
201240
src/main/java/com/docspring/HtmlEngineOptions.java
@@ -208,13 +247,20 @@ src/main/java/com/docspring/ModelCodeLanguage.java
208247
src/main/java/com/docspring/MoveFolderRequest.java
209248
src/main/java/com/docspring/MoveTemplateRequest.java
210249
src/main/java/com/docspring/NumberConditionType.java
250+
src/main/java/com/docspring/OutputFormat.java
211251
src/main/java/com/docspring/PageFormat.java
252+
src/main/java/com/docspring/PageImage.java
253+
src/main/java/com/docspring/PageImages.java
212254
src/main/java/com/docspring/Pair.java
255+
src/main/java/com/docspring/PredefinedField.java
256+
src/main/java/com/docspring/PredefinedFieldInput.java
213257
src/main/java/com/docspring/PublishTemplateVersionRequest.java
214258
src/main/java/com/docspring/RFC3339DateFormat.java
215259
src/main/java/com/docspring/RFC3339InstantDeserializer.java
216260
src/main/java/com/docspring/RFC3339JavaTimeModule.java
261+
src/main/java/com/docspring/RemoveTemplateFieldsRequest.java
217262
src/main/java/com/docspring/RenameFolderRequest.java
263+
src/main/java/com/docspring/ReorderTemplateFieldsRequest.java
218264
src/main/java/com/docspring/RestoreTemplateVersionRequest.java
219265
src/main/java/com/docspring/ServerConfiguration.java
220266
src/main/java/com/docspring/ServerVariable.java
@@ -243,13 +289,18 @@ src/main/java/com/docspring/SubmissionList.java
243289
src/main/java/com/docspring/SubmissionSource.java
244290
src/main/java/com/docspring/SubmissionSourcePdf.java
245291
src/main/java/com/docspring/SubmissionState.java
292+
src/main/java/com/docspring/SubmissionValidation.java
246293
src/main/java/com/docspring/Template.java
247294
src/main/java/com/docspring/TemplateActor.java
248295
src/main/java/com/docspring/TemplateActorType.java
249296
src/main/java/com/docspring/TemplateDefaults.java
250297
src/main/java/com/docspring/TemplateDefaultsInput.java
298+
src/main/java/com/docspring/TemplateDiff.java
299+
src/main/java/com/docspring/TemplateDiffSummary.java
251300
src/main/java/com/docspring/TemplateDocument.java
252301
src/main/java/com/docspring/TemplateDocumentState.java
302+
src/main/java/com/docspring/TemplateFieldChange.java
303+
src/main/java/com/docspring/TemplateFieldChanges.java
253304
src/main/java/com/docspring/TemplateFieldDependency.java
254305
src/main/java/com/docspring/TemplateFieldDependencyAction.java
255306
src/main/java/com/docspring/TemplateFieldDependencyCondition.java
@@ -258,12 +309,15 @@ src/main/java/com/docspring/TemplateFieldDependencyInput.java
258309
src/main/java/com/docspring/TemplateFieldDependencyMatch.java
259310
src/main/java/com/docspring/TemplateFieldDependencyOperator.java
260311
src/main/java/com/docspring/TemplateFieldLogicStatus.java
312+
src/main/java/com/docspring/TemplateFieldMove.java
313+
src/main/java/com/docspring/TemplateFields.java
261314
src/main/java/com/docspring/TemplateFormMode.java
262315
src/main/java/com/docspring/TemplateModelCode.java
263316
src/main/java/com/docspring/TemplatePageAiError.java
264317
src/main/java/com/docspring/TemplatePageAiNamingStatus.java
265318
src/main/java/com/docspring/TemplatePageFieldsStatus.java
266319
src/main/java/com/docspring/TemplatePageImageStatus.java
320+
src/main/java/com/docspring/TemplatePageImages.java
267321
src/main/java/com/docspring/TemplatePageProcessingStatus.java
268322
src/main/java/com/docspring/TemplateSourcePdf.java
269323
src/main/java/com/docspring/TemplateSummary.java
@@ -277,11 +331,13 @@ src/main/java/com/docspring/TextVerticalAlignment.java
277331
src/main/java/com/docspring/Typeface.java
278332
src/main/java/com/docspring/UpdateSignatureRequestRequest.java
279333
src/main/java/com/docspring/UpdateTemplateDocumentRequest.java
334+
src/main/java/com/docspring/UpdateTemplateFieldsRequest.java
280335
src/main/java/com/docspring/UpdateTemplateRequest.java
281336
src/main/java/com/docspring/UpdateWebhookRequest.java
282337
src/main/java/com/docspring/UploadMethod.java
283338
src/main/java/com/docspring/UploadPresign.java
284339
src/main/java/com/docspring/UrlSourcePdf.java
340+
src/main/java/com/docspring/ValidateSubmissionRequest.java
285341
src/main/java/com/docspring/Webhook.java
286342
src/main/java/com/docspring/WebhookEventType.java
287343
src/main/java/com/docspring/WebhookList.java
@@ -290,6 +346,7 @@ src/main/java/com/docspring/auth/ApiKeyAuth.java
290346
src/main/java/com/docspring/auth/Authentication.java
291347
src/main/java/com/docspring/auth/HttpBasicAuth.java
292348
src/main/java/com/docspring/auth/HttpBearerAuth.java
349+
src/test/java/com/docspring/AddTemplateFieldsRequestTest.java
293350
src/test/java/com/docspring/AiFieldNamingLanguageTest.java
294351
src/test/java/com/docspring/AuthenticationCheckTest.java
295352
src/test/java/com/docspring/BarcodeSymbologyTest.java
@@ -324,10 +381,16 @@ src/test/java/com/docspring/ErrorResponseTest.java
324381
src/test/java/com/docspring/ExpirationIntervalTest.java
325382
src/test/java/com/docspring/FieldComparisonConditionTest.java
326383
src/test/java/com/docspring/FieldComparisonOperatorTest.java
384+
src/test/java/com/docspring/FieldDependencyInputTest.java
385+
src/test/java/com/docspring/FieldDependencyTest.java
327386
src/test/java/com/docspring/FieldDisplayTypeTest.java
328387
src/test/java/com/docspring/FieldEqualsConditionTest.java
329388
src/test/java/com/docspring/FieldEqualsOperatorTest.java
389+
src/test/java/com/docspring/FieldGroupInputTest.java
390+
src/test/java/com/docspring/FieldGroupTest.java
391+
src/test/java/com/docspring/FieldGroupTypeTest.java
330392
src/test/java/com/docspring/FieldInConditionTest.java
393+
src/test/java/com/docspring/FieldInputTest.java
331394
src/test/java/com/docspring/FieldOverrideTest.java
332395
src/test/java/com/docspring/FieldPresenceConditionTest.java
333396
src/test/java/com/docspring/FieldPresenceOperatorTest.java
@@ -336,8 +399,12 @@ src/test/java/com/docspring/FieldReimportStateTest.java
336399
src/test/java/com/docspring/FieldSetupLogicTest.java
337400
src/test/java/com/docspring/FieldSetupNamingTest.java
338401
src/test/java/com/docspring/FieldSetupSourceTest.java
402+
src/test/java/com/docspring/FieldTest.java
403+
src/test/java/com/docspring/FieldTypeTest.java
339404
src/test/java/com/docspring/FolderListTest.java
340405
src/test/java/com/docspring/FolderTest.java
406+
src/test/java/com/docspring/GenerateFilesFormatTest.java
407+
src/test/java/com/docspring/GenerateSubmissionFilesRequestTest.java
341408
src/test/java/com/docspring/GeneratedFileStateTest.java
342409
src/test/java/com/docspring/GeneratedFileTest.java
343410
src/test/java/com/docspring/HtmlEngineOptionsInputTest.java
@@ -348,9 +415,16 @@ src/test/java/com/docspring/ModelCodeLanguageTest.java
348415
src/test/java/com/docspring/MoveFolderRequestTest.java
349416
src/test/java/com/docspring/MoveTemplateRequestTest.java
350417
src/test/java/com/docspring/NumberConditionTypeTest.java
418+
src/test/java/com/docspring/OutputFormatTest.java
351419
src/test/java/com/docspring/PageFormatTest.java
420+
src/test/java/com/docspring/PageImageTest.java
421+
src/test/java/com/docspring/PageImagesTest.java
422+
src/test/java/com/docspring/PredefinedFieldInputTest.java
423+
src/test/java/com/docspring/PredefinedFieldTest.java
352424
src/test/java/com/docspring/PublishTemplateVersionRequestTest.java
425+
src/test/java/com/docspring/RemoveTemplateFieldsRequestTest.java
353426
src/test/java/com/docspring/RenameFolderRequestTest.java
427+
src/test/java/com/docspring/ReorderTemplateFieldsRequestTest.java
354428
src/test/java/com/docspring/RestoreTemplateVersionRequestTest.java
355429
src/test/java/com/docspring/ShapeTypeTest.java
356430
src/test/java/com/docspring/SignatureRequestAuthSecondFactorTypeTest.java
@@ -376,12 +450,17 @@ src/test/java/com/docspring/SubmissionSourcePdfTest.java
376450
src/test/java/com/docspring/SubmissionSourceTest.java
377451
src/test/java/com/docspring/SubmissionStateTest.java
378452
src/test/java/com/docspring/SubmissionTest.java
453+
src/test/java/com/docspring/SubmissionValidationTest.java
379454
src/test/java/com/docspring/TemplateActorTest.java
380455
src/test/java/com/docspring/TemplateActorTypeTest.java
381456
src/test/java/com/docspring/TemplateDefaultsInputTest.java
382457
src/test/java/com/docspring/TemplateDefaultsTest.java
458+
src/test/java/com/docspring/TemplateDiffSummaryTest.java
459+
src/test/java/com/docspring/TemplateDiffTest.java
383460
src/test/java/com/docspring/TemplateDocumentStateTest.java
384461
src/test/java/com/docspring/TemplateDocumentTest.java
462+
src/test/java/com/docspring/TemplateFieldChangeTest.java
463+
src/test/java/com/docspring/TemplateFieldChangesTest.java
385464
src/test/java/com/docspring/TemplateFieldDependencyActionTest.java
386465
src/test/java/com/docspring/TemplateFieldDependencyConditionInputTest.java
387466
src/test/java/com/docspring/TemplateFieldDependencyConditionTest.java
@@ -390,12 +469,15 @@ src/test/java/com/docspring/TemplateFieldDependencyMatchTest.java
390469
src/test/java/com/docspring/TemplateFieldDependencyOperatorTest.java
391470
src/test/java/com/docspring/TemplateFieldDependencyTest.java
392471
src/test/java/com/docspring/TemplateFieldLogicStatusTest.java
472+
src/test/java/com/docspring/TemplateFieldMoveTest.java
473+
src/test/java/com/docspring/TemplateFieldsTest.java
393474
src/test/java/com/docspring/TemplateFormModeTest.java
394475
src/test/java/com/docspring/TemplateModelCodeTest.java
395476
src/test/java/com/docspring/TemplatePageAiErrorTest.java
396477
src/test/java/com/docspring/TemplatePageAiNamingStatusTest.java
397478
src/test/java/com/docspring/TemplatePageFieldsStatusTest.java
398479
src/test/java/com/docspring/TemplatePageImageStatusTest.java
480+
src/test/java/com/docspring/TemplatePageImagesTest.java
399481
src/test/java/com/docspring/TemplatePageProcessingStatusTest.java
400482
src/test/java/com/docspring/TemplateSourcePdfTest.java
401483
src/test/java/com/docspring/TemplateSummaryListTest.java
@@ -410,11 +492,13 @@ src/test/java/com/docspring/TextVerticalAlignmentTest.java
410492
src/test/java/com/docspring/TypefaceTest.java
411493
src/test/java/com/docspring/UpdateSignatureRequestRequestTest.java
412494
src/test/java/com/docspring/UpdateTemplateDocumentRequestTest.java
495+
src/test/java/com/docspring/UpdateTemplateFieldsRequestTest.java
413496
src/test/java/com/docspring/UpdateTemplateRequestTest.java
414497
src/test/java/com/docspring/UpdateWebhookRequestTest.java
415498
src/test/java/com/docspring/UploadMethodTest.java
416499
src/test/java/com/docspring/UploadPresignTest.java
417500
src/test/java/com/docspring/UrlSourcePdfTest.java
501+
src/test/java/com/docspring/ValidateSubmissionRequestTest.java
418502
src/test/java/com/docspring/WebhookEventTypeTest.java
419503
src/test/java/com/docspring/WebhookListTest.java
420504
src/test/java/com/docspring/WebhookModeTest.java

‎CHANGELOG.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
### 4.1.0 [October 27, 2026]
2+
3+
- New: list_template_fields, add_template_fields, update_template_fields, remove_template_fields and
4+
reorder_template_fields read and edit a template's fields (`Field`), with all their settings and their own conditional
5+
logic (`dependencies`). A field's `y` is measured from the top of its page.
6+
- New: a template's `predefined_fields` (`PredefinedField`) and `predefined_fields_sample_data`, the field names that
7+
people using the embedded template editor choose from. get_template returns them, and create_template and
8+
update_template set them.
9+
- New: a template's `field_groups` (`FieldGroup`), the groups that its fields' names make, with their titles and the
10+
settings of lists (`min_items`, `max_items`, `allow_additional_items`). get_template returns them, and update_template
11+
changes them.
12+
- New: get_template_page_images returns an image of each page of a PDF template (`TemplatePageImages`), to see where
13+
fields go.
14+
- New: get_template_diff says what changed in a template's draft since its latest published version, or in a published
15+
version since the one before it (`TemplateDiff`).
16+
- New: validate_submission checks a submission's data and settings as create_submission does, without creating the
17+
submission or using credits (`SubmissionValidation`). It doesn't check your account's credits.
18+
- New: the `png` output format, an image of each page of a submission's PDF (`files.png.pages`). Add it to
19+
`output_formats` in create_submission or create_submission_batch (it adds `pdf`), or to a processed submission with
20+
generate_submission_files.
21+
- create_template and update_template_document take a `document_url` (DocSpring downloads it) or a `document_base64`
22+
instead of a `cache_id`. While the URL downloads, the template's `document.state` is `downloading`; if it can't be
23+
downloaded, it's `download_failed` and `document.error_message` says why.
24+
125
### 4.0.0 [October 26, 2026]
226

327
- **BREAKING CHANGE**: This version calls DocSpring API v2 (`/api/v2`). The 3.x versions call API v1, which keeps

0 commit comments

Comments
 (0)