Skip to content

Commit e9e096a

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 2e625b6 commit e9e096a

134 files changed

Lines changed: 13774 additions & 2743 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
@@ -3,6 +3,7 @@
33
.gitlab-ci.yml
44
.travis.yml
55
README.md
6+
docs/AddTemplateFieldsRequest.md
67
docs/AiFieldNamingLanguage.md
78
docs/AuthenticationCheck.md
89
docs/BarcodeSymbology.md
@@ -37,10 +38,16 @@ docs/ErrorResponse.md
3738
docs/ExpirationInterval.md
3839
docs/FieldComparisonCondition.md
3940
docs/FieldComparisonOperator.md
41+
docs/FieldDependency.md
42+
docs/FieldDependencyInput.md
4043
docs/FieldDisplayType.md
4144
docs/FieldEqualsCondition.md
4245
docs/FieldEqualsOperator.md
46+
docs/FieldGroup.md
47+
docs/FieldGroupInput.md
48+
docs/FieldGroupType.md
4349
docs/FieldInCondition.md
50+
docs/FieldInput.md
4451
docs/FieldOverride.md
4552
docs/FieldPresenceCondition.md
4653
docs/FieldPresenceOperator.md
@@ -49,21 +56,32 @@ docs/FieldReimportState.md
4956
docs/FieldSetupLogic.md
5057
docs/FieldSetupNaming.md
5158
docs/FieldSetupSource.md
59+
docs/FieldType.md
5260
docs/Folder.md
5361
docs/FolderList.md
62+
docs/GenerateFilesFormat.md
63+
docs/GenerateSubmissionFilesRequest.md
5464
docs/GeneratedFile.md
5565
docs/GeneratedFileState.md
5666
docs/HtmlEngineOptions.md
5767
docs/HtmlEngineOptionsInput.md
5868
docs/ImageGravity.md
5969
docs/ImageScaleType.md
6070
docs/ModelCodeLanguage.md
71+
docs/ModelField.md
6172
docs/MoveFolderRequest.md
6273
docs/MoveTemplateRequest.md
6374
docs/NumberConditionType.md
75+
docs/OutputFormat.md
6476
docs/PageFormat.md
77+
docs/PageImage.md
78+
docs/PageImages.md
79+
docs/PredefinedField.md
80+
docs/PredefinedFieldInput.md
6581
docs/PublishTemplateVersionRequest.md
82+
docs/RemoveTemplateFieldsRequest.md
6683
docs/RenameFolderRequest.md
84+
docs/ReorderTemplateFieldsRequest.md
6785
docs/RestoreTemplateVersionRequest.md
6886
docs/ShapeType.md
6987
docs/SignatureRequest.md
@@ -89,13 +107,18 @@ docs/SubmissionList.md
89107
docs/SubmissionSource.md
90108
docs/SubmissionSourcePdf.md
91109
docs/SubmissionState.md
110+
docs/SubmissionValidation.md
92111
docs/Template.md
93112
docs/TemplateActor.md
94113
docs/TemplateActorType.md
95114
docs/TemplateDefaults.md
96115
docs/TemplateDefaultsInput.md
116+
docs/TemplateDiff.md
117+
docs/TemplateDiffSummary.md
97118
docs/TemplateDocument.md
98119
docs/TemplateDocumentState.md
120+
docs/TemplateFieldChange.md
121+
docs/TemplateFieldChanges.md
99122
docs/TemplateFieldDependency.md
100123
docs/TemplateFieldDependencyAction.md
101124
docs/TemplateFieldDependencyCondition.md
@@ -104,12 +127,15 @@ docs/TemplateFieldDependencyInput.md
104127
docs/TemplateFieldDependencyMatch.md
105128
docs/TemplateFieldDependencyOperator.md
106129
docs/TemplateFieldLogicStatus.md
130+
docs/TemplateFieldMove.md
131+
docs/TemplateFields.md
107132
docs/TemplateFormMode.md
108133
docs/TemplateModelCode.md
109134
docs/TemplatePageAiError.md
110135
docs/TemplatePageAiNamingStatus.md
111136
docs/TemplatePageFieldsStatus.md
112137
docs/TemplatePageImageStatus.md
138+
docs/TemplatePageImages.md
113139
docs/TemplatePageProcessingStatus.md
114140
docs/TemplateSourcePdf.md
115141
docs/TemplateSummary.md
@@ -123,11 +149,13 @@ docs/TextVerticalAlignment.md
123149
docs/Typeface.md
124150
docs/UpdateSignatureRequestRequest.md
125151
docs/UpdateTemplateDocumentRequest.md
152+
docs/UpdateTemplateFieldsRequest.md
126153
docs/UpdateTemplateRequest.md
127154
docs/UpdateWebhookRequest.md
128155
docs/UploadMethod.md
129156
docs/UploadPresign.md
130157
docs/UrlSourcePdf.md
158+
docs/ValidateSubmissionRequest.md
131159
docs/Webhook.md
132160
docs/WebhookEventType.md
133161
docs/WebhookList.md
@@ -140,6 +168,7 @@ docspring/api_response.py
140168
docspring/configuration.py
141169
docspring/exceptions.py
142170
docspring/models/__init__.py
171+
docspring/models/add_template_fields_request.py
143172
docspring/models/ai_field_naming_language.py
144173
docspring/models/authentication_check.py
145174
docspring/models/barcode_symbology.py
@@ -173,10 +202,16 @@ docspring/models/error_response.py
173202
docspring/models/expiration_interval.py
174203
docspring/models/field_comparison_condition.py
175204
docspring/models/field_comparison_operator.py
205+
docspring/models/field_dependency.py
206+
docspring/models/field_dependency_input.py
176207
docspring/models/field_display_type.py
177208
docspring/models/field_equals_condition.py
178209
docspring/models/field_equals_operator.py
210+
docspring/models/field_group.py
211+
docspring/models/field_group_input.py
212+
docspring/models/field_group_type.py
179213
docspring/models/field_in_condition.py
214+
docspring/models/field_input.py
180215
docspring/models/field_override.py
181216
docspring/models/field_presence_condition.py
182217
docspring/models/field_presence_operator.py
@@ -185,21 +220,32 @@ docspring/models/field_reimport_state.py
185220
docspring/models/field_setup_logic.py
186221
docspring/models/field_setup_naming.py
187222
docspring/models/field_setup_source.py
223+
docspring/models/field_type.py
188224
docspring/models/folder.py
189225
docspring/models/folder_list.py
226+
docspring/models/generate_files_format.py
227+
docspring/models/generate_submission_files_request.py
190228
docspring/models/generated_file.py
191229
docspring/models/generated_file_state.py
192230
docspring/models/html_engine_options.py
193231
docspring/models/html_engine_options_input.py
194232
docspring/models/image_gravity.py
195233
docspring/models/image_scale_type.py
196234
docspring/models/model_code_language.py
235+
docspring/models/model_field.py
197236
docspring/models/move_folder_request.py
198237
docspring/models/move_template_request.py
199238
docspring/models/number_condition_type.py
239+
docspring/models/output_format.py
200240
docspring/models/page_format.py
241+
docspring/models/page_image.py
242+
docspring/models/page_images.py
243+
docspring/models/predefined_field.py
244+
docspring/models/predefined_field_input.py
201245
docspring/models/publish_template_version_request.py
246+
docspring/models/remove_template_fields_request.py
202247
docspring/models/rename_folder_request.py
248+
docspring/models/reorder_template_fields_request.py
203249
docspring/models/restore_template_version_request.py
204250
docspring/models/shape_type.py
205251
docspring/models/signature_request.py
@@ -225,13 +271,18 @@ docspring/models/submission_list.py
225271
docspring/models/submission_source.py
226272
docspring/models/submission_source_pdf.py
227273
docspring/models/submission_state.py
274+
docspring/models/submission_validation.py
228275
docspring/models/template.py
229276
docspring/models/template_actor.py
230277
docspring/models/template_actor_type.py
231278
docspring/models/template_defaults.py
232279
docspring/models/template_defaults_input.py
280+
docspring/models/template_diff.py
281+
docspring/models/template_diff_summary.py
233282
docspring/models/template_document.py
234283
docspring/models/template_document_state.py
284+
docspring/models/template_field_change.py
285+
docspring/models/template_field_changes.py
235286
docspring/models/template_field_dependency.py
236287
docspring/models/template_field_dependency_action.py
237288
docspring/models/template_field_dependency_condition.py
@@ -240,12 +291,15 @@ docspring/models/template_field_dependency_input.py
240291
docspring/models/template_field_dependency_match.py
241292
docspring/models/template_field_dependency_operator.py
242293
docspring/models/template_field_logic_status.py
294+
docspring/models/template_field_move.py
295+
docspring/models/template_fields.py
243296
docspring/models/template_form_mode.py
244297
docspring/models/template_model_code.py
245298
docspring/models/template_page_ai_error.py
246299
docspring/models/template_page_ai_naming_status.py
247300
docspring/models/template_page_fields_status.py
248301
docspring/models/template_page_image_status.py
302+
docspring/models/template_page_images.py
249303
docspring/models/template_page_processing_status.py
250304
docspring/models/template_source_pdf.py
251305
docspring/models/template_summary.py
@@ -259,11 +313,13 @@ docspring/models/text_vertical_alignment.py
259313
docspring/models/typeface.py
260314
docspring/models/update_signature_request_request.py
261315
docspring/models/update_template_document_request.py
316+
docspring/models/update_template_fields_request.py
262317
docspring/models/update_template_request.py
263318
docspring/models/update_webhook_request.py
264319
docspring/models/upload_method.py
265320
docspring/models/upload_presign.py
266321
docspring/models/url_source_pdf.py
322+
docspring/models/validate_submission_request.py
267323
docspring/models/webhook.py
268324
docspring/models/webhook_event_type.py
269325
docspring/models/webhook_list.py
@@ -277,6 +333,7 @@ setup.cfg
277333
setup.py
278334
test-requirements.txt
279335
test/__init__.py
336+
test/test_add_template_fields_request.py
280337
test/test_ai_field_naming_language.py
281338
test/test_authentication_check.py
282339
test/test_barcode_symbology.py
@@ -311,10 +368,16 @@ test/test_error_response.py
311368
test/test_expiration_interval.py
312369
test/test_field_comparison_condition.py
313370
test/test_field_comparison_operator.py
371+
test/test_field_dependency.py
372+
test/test_field_dependency_input.py
314373
test/test_field_display_type.py
315374
test/test_field_equals_condition.py
316375
test/test_field_equals_operator.py
376+
test/test_field_group.py
377+
test/test_field_group_input.py
378+
test/test_field_group_type.py
317379
test/test_field_in_condition.py
380+
test/test_field_input.py
318381
test/test_field_override.py
319382
test/test_field_presence_condition.py
320383
test/test_field_presence_operator.py
@@ -323,21 +386,32 @@ test/test_field_reimport_state.py
323386
test/test_field_setup_logic.py
324387
test/test_field_setup_naming.py
325388
test/test_field_setup_source.py
389+
test/test_field_type.py
326390
test/test_folder.py
327391
test/test_folder_list.py
392+
test/test_generate_files_format.py
393+
test/test_generate_submission_files_request.py
328394
test/test_generated_file.py
329395
test/test_generated_file_state.py
330396
test/test_html_engine_options.py
331397
test/test_html_engine_options_input.py
332398
test/test_image_gravity.py
333399
test/test_image_scale_type.py
334400
test/test_model_code_language.py
401+
test/test_model_field.py
335402
test/test_move_folder_request.py
336403
test/test_move_template_request.py
337404
test/test_number_condition_type.py
405+
test/test_output_format.py
338406
test/test_page_format.py
407+
test/test_page_image.py
408+
test/test_page_images.py
409+
test/test_predefined_field.py
410+
test/test_predefined_field_input.py
339411
test/test_publish_template_version_request.py
412+
test/test_remove_template_fields_request.py
340413
test/test_rename_folder_request.py
414+
test/test_reorder_template_fields_request.py
341415
test/test_restore_template_version_request.py
342416
test/test_shape_type.py
343417
test/test_signature_request.py
@@ -363,13 +437,18 @@ test/test_submission_list.py
363437
test/test_submission_source.py
364438
test/test_submission_source_pdf.py
365439
test/test_submission_state.py
440+
test/test_submission_validation.py
366441
test/test_template.py
367442
test/test_template_actor.py
368443
test/test_template_actor_type.py
369444
test/test_template_defaults.py
370445
test/test_template_defaults_input.py
446+
test/test_template_diff.py
447+
test/test_template_diff_summary.py
371448
test/test_template_document.py
372449
test/test_template_document_state.py
450+
test/test_template_field_change.py
451+
test/test_template_field_changes.py
373452
test/test_template_field_dependency.py
374453
test/test_template_field_dependency_action.py
375454
test/test_template_field_dependency_condition.py
@@ -378,12 +457,15 @@ test/test_template_field_dependency_input.py
378457
test/test_template_field_dependency_match.py
379458
test/test_template_field_dependency_operator.py
380459
test/test_template_field_logic_status.py
460+
test/test_template_field_move.py
461+
test/test_template_fields.py
381462
test/test_template_form_mode.py
382463
test/test_template_model_code.py
383464
test/test_template_page_ai_error.py
384465
test/test_template_page_ai_naming_status.py
385466
test/test_template_page_fields_status.py
386467
test/test_template_page_image_status.py
468+
test/test_template_page_images.py
387469
test/test_template_page_processing_status.py
388470
test/test_template_source_pdf.py
389471
test/test_template_summary.py
@@ -397,11 +479,13 @@ test/test_text_vertical_alignment.py
397479
test/test_typeface.py
398480
test/test_update_signature_request_request.py
399481
test/test_update_template_document_request.py
482+
test/test_update_template_fields_request.py
400483
test/test_update_template_request.py
401484
test/test_update_webhook_request.py
402485
test/test_upload_method.py
403486
test/test_upload_presign.py
404487
test/test_url_source_pdf.py
488+
test/test_validate_submission_request.py
405489
test/test_webhook.py
406490
test/test_webhook_event_type.py
407491
test/test_webhook_list.py

‎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)