docspring 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2747bc5c9a69e660bfc79433a7377c43f15cba9cbd285f9b3e85fb0146befda8
-  data.tar.gz: b82c3407c3b72df8b439a8a90a1b3f696684585f515700e7d7880e565db61629
+  metadata.gz: f14e5a7b2bfc1d3afccaa2fe06b9a452849c1e68159d2bb3b5cd28317251105d
+  data.tar.gz: b34c23551a9e275212671e5bac87568bec392ee68f379589cb9de514b6871152
 SHA512:
-  metadata.gz: bdfd525f1348cfa53e6992141734a15e207e30f3986722ac62b8e544ef287c6da244377fd4c7e8513ceaece703817f0a2e55c4b190f3aaa1583f0077b36bceee
-  data.tar.gz: a472431d0ef65102dc1a25e59036256a8ebce025664ef1c63df29567d2013b1be66cd76fd36c6da8e4683e4d290399a0fad3c6e434e8479eb187f680b8b76aa0
+  metadata.gz: c9c41809479101fc003e24371dc49de667b566329208c656f653977cc7548a174f482c90978d3bcc62800771c173dc374406cbcfc973365f72ecdf6f5d6f2457
+  data.tar.gz: 51775f90a82bb42c0a6ce063b3a834c665f8adfa2e8acfd14dca4925adf65cd835e0fb8a79b108cb567daeccf6f477fe02be3b20848fbf42ea5854ad63e7a7e9

data/.openapi-generator/FILES

@@ -6,6 +6,7 @@
 Gemfile
 README.md
 Rakefile
+docs/AddTemplateFieldsRequest.md
 docs/AiFieldNamingLanguage.md
 docs/AuthenticationCheck.md
 docs/BarcodeSymbology.md
@@ -28,6 +29,7 @@ docs/CreateSignatureRequestEventRequest.md
 docs/CreateSignatureRequestTokenRequest.md
 docs/CreateSubmissionBatchRequest.md
 docs/CreateSubmissionRequest.md
+docs/CreateTemplatePreviewRequest.md
 docs/CreateTemplateRequest.md
 docs/CreateWebhookRequest.md
 docs/CustomFile.md
@@ -38,12 +40,19 @@ docs/ErrorDetail.md
 docs/ErrorInfo.md
 docs/ErrorResponse.md
 docs/ExpirationInterval.md
+docs/Field.md
 docs/FieldComparisonCondition.md
 docs/FieldComparisonOperator.md
+docs/FieldDependency.md
+docs/FieldDependencyInput.md
 docs/FieldDisplayType.md
 docs/FieldEqualsCondition.md
 docs/FieldEqualsOperator.md
+docs/FieldGroup.md
+docs/FieldGroupInput.md
+docs/FieldGroupType.md
 docs/FieldInCondition.md
+docs/FieldInput.md
 docs/FieldOverride.md
 docs/FieldPresenceCondition.md
 docs/FieldPresenceOperator.md
@@ -52,8 +61,11 @@ docs/FieldReimportState.md
 docs/FieldSetupLogic.md
 docs/FieldSetupNaming.md
 docs/FieldSetupSource.md
+docs/FieldType.md
 docs/Folder.md
 docs/FolderList.md
+docs/GenerateFilesFormat.md
+docs/GenerateSubmissionFilesRequest.md
 docs/GeneratedFile.md
 docs/GeneratedFileState.md
 docs/HtmlEngineOptions.md
@@ -64,9 +76,16 @@ docs/ModelCodeLanguage.md
 docs/MoveFolderRequest.md
 docs/MoveTemplateRequest.md
 docs/NumberConditionType.md
+docs/OutputFormat.md
 docs/PageFormat.md
+docs/PageImage.md
+docs/PageImages.md
+docs/PredefinedField.md
+docs/PredefinedFieldInput.md
 docs/PublishTemplateVersionRequest.md
+docs/RemoveTemplateFieldsRequest.md
 docs/RenameFolderRequest.md
+docs/ReorderTemplateFieldsRequest.md
 docs/RestoreTemplateVersionRequest.md
 docs/ShapeType.md
 docs/SignatureRequest.md
@@ -92,13 +111,20 @@ docs/SubmissionList.md
 docs/SubmissionSource.md
 docs/SubmissionSourcePdf.md
 docs/SubmissionState.md
+docs/SubmissionSummary.md
+docs/SubmissionValidation.md
 docs/Template.md
 docs/TemplateActor.md
 docs/TemplateActorType.md
 docs/TemplateDefaults.md
 docs/TemplateDefaultsInput.md
+docs/TemplateDiff.md
+docs/TemplateDiffSummary.md
 docs/TemplateDocument.md
 docs/TemplateDocumentState.md
+docs/TemplateDocumentSummary.md
+docs/TemplateFieldChange.md
+docs/TemplateFieldChanges.md
 docs/TemplateFieldDependency.md
 docs/TemplateFieldDependencyAction.md
 docs/TemplateFieldDependencyCondition.md
@@ -107,13 +133,18 @@ docs/TemplateFieldDependencyInput.md
 docs/TemplateFieldDependencyMatch.md
 docs/TemplateFieldDependencyOperator.md
 docs/TemplateFieldLogicStatus.md
+docs/TemplateFieldMove.md
+docs/TemplateFields.md
 docs/TemplateFormMode.md
 docs/TemplateModelCode.md
 docs/TemplatePageAiError.md
 docs/TemplatePageAiNamingStatus.md
 docs/TemplatePageFieldsStatus.md
 docs/TemplatePageImageStatus.md
+docs/TemplatePageImages.md
 docs/TemplatePageProcessingStatus.md
+docs/TemplatePreview.md
+docs/TemplatePreviewState.md
 docs/TemplateSourcePdf.md
 docs/TemplateSummary.md
 docs/TemplateSummaryList.md
@@ -126,11 +157,13 @@ docs/TextVerticalAlignment.md
 docs/Typeface.md
 docs/UpdateSignatureRequestRequest.md
 docs/UpdateTemplateDocumentRequest.md
+docs/UpdateTemplateFieldsRequest.md
 docs/UpdateTemplateRequest.md
 docs/UpdateWebhookRequest.md
 docs/UploadMethod.md
 docs/UploadPresign.md
 docs/UrlSourcePdf.md
+docs/ValidateSubmissionRequest.md
 docs/Webhook.md
 docs/WebhookEventType.md
 docs/WebhookList.md
@@ -143,6 +176,7 @@ lib/docspring/api_client.rb
 lib/docspring/api_error.rb
 lib/docspring/api_model_base.rb
 lib/docspring/configuration.rb
+lib/docspring/models/add_template_fields_request.rb
 lib/docspring/models/ai_field_naming_language.rb
 lib/docspring/models/authentication_check.rb
 lib/docspring/models/barcode_symbology.rb
@@ -164,6 +198,7 @@ lib/docspring/models/create_signature_request_event_request.rb
 lib/docspring/models/create_signature_request_token_request.rb
 lib/docspring/models/create_submission_batch_request.rb
 lib/docspring/models/create_submission_request.rb
+lib/docspring/models/create_template_preview_request.rb
 lib/docspring/models/create_template_request.rb
 lib/docspring/models/create_webhook_request.rb
 lib/docspring/models/custom_file.rb
@@ -174,12 +209,19 @@ lib/docspring/models/error_detail.rb
 lib/docspring/models/error_info.rb
 lib/docspring/models/error_response.rb
 lib/docspring/models/expiration_interval.rb
+lib/docspring/models/field.rb
 lib/docspring/models/field_comparison_condition.rb
 lib/docspring/models/field_comparison_operator.rb
+lib/docspring/models/field_dependency.rb
+lib/docspring/models/field_dependency_input.rb
 lib/docspring/models/field_display_type.rb
 lib/docspring/models/field_equals_condition.rb
 lib/docspring/models/field_equals_operator.rb
+lib/docspring/models/field_group.rb
+lib/docspring/models/field_group_input.rb
+lib/docspring/models/field_group_type.rb
 lib/docspring/models/field_in_condition.rb
+lib/docspring/models/field_input.rb
 lib/docspring/models/field_override.rb
 lib/docspring/models/field_presence_condition.rb
 lib/docspring/models/field_presence_operator.rb
@@ -188,8 +230,11 @@ lib/docspring/models/field_reimport_state.rb
 lib/docspring/models/field_setup_logic.rb
 lib/docspring/models/field_setup_naming.rb
 lib/docspring/models/field_setup_source.rb
+lib/docspring/models/field_type.rb
 lib/docspring/models/folder.rb
 lib/docspring/models/folder_list.rb
+lib/docspring/models/generate_files_format.rb
+lib/docspring/models/generate_submission_files_request.rb
 lib/docspring/models/generated_file.rb
 lib/docspring/models/generated_file_state.rb
 lib/docspring/models/html_engine_options.rb
@@ -200,9 +245,16 @@ lib/docspring/models/model_code_language.rb
 lib/docspring/models/move_folder_request.rb
 lib/docspring/models/move_template_request.rb
 lib/docspring/models/number_condition_type.rb
+lib/docspring/models/output_format.rb
 lib/docspring/models/page_format.rb
+lib/docspring/models/page_image.rb
+lib/docspring/models/page_images.rb
+lib/docspring/models/predefined_field.rb
+lib/docspring/models/predefined_field_input.rb
 lib/docspring/models/publish_template_version_request.rb
+lib/docspring/models/remove_template_fields_request.rb
 lib/docspring/models/rename_folder_request.rb
+lib/docspring/models/reorder_template_fields_request.rb
 lib/docspring/models/restore_template_version_request.rb
 lib/docspring/models/shape_type.rb
 lib/docspring/models/signature_request.rb
@@ -228,13 +280,20 @@ lib/docspring/models/submission_list.rb
 lib/docspring/models/submission_source.rb
 lib/docspring/models/submission_source_pdf.rb
 lib/docspring/models/submission_state.rb
+lib/docspring/models/submission_summary.rb
+lib/docspring/models/submission_validation.rb
 lib/docspring/models/template.rb
 lib/docspring/models/template_actor.rb
 lib/docspring/models/template_actor_type.rb
 lib/docspring/models/template_defaults.rb
 lib/docspring/models/template_defaults_input.rb
+lib/docspring/models/template_diff.rb
+lib/docspring/models/template_diff_summary.rb
 lib/docspring/models/template_document.rb
 lib/docspring/models/template_document_state.rb
+lib/docspring/models/template_document_summary.rb
+lib/docspring/models/template_field_change.rb
+lib/docspring/models/template_field_changes.rb
 lib/docspring/models/template_field_dependency.rb
 lib/docspring/models/template_field_dependency_action.rb
 lib/docspring/models/template_field_dependency_condition.rb
@@ -243,13 +302,18 @@ lib/docspring/models/template_field_dependency_input.rb
 lib/docspring/models/template_field_dependency_match.rb
 lib/docspring/models/template_field_dependency_operator.rb
 lib/docspring/models/template_field_logic_status.rb
+lib/docspring/models/template_field_move.rb
+lib/docspring/models/template_fields.rb
 lib/docspring/models/template_form_mode.rb
 lib/docspring/models/template_model_code.rb
 lib/docspring/models/template_page_ai_error.rb
 lib/docspring/models/template_page_ai_naming_status.rb
 lib/docspring/models/template_page_fields_status.rb
 lib/docspring/models/template_page_image_status.rb
+lib/docspring/models/template_page_images.rb
 lib/docspring/models/template_page_processing_status.rb
+lib/docspring/models/template_preview.rb
+lib/docspring/models/template_preview_state.rb
 lib/docspring/models/template_source_pdf.rb
 lib/docspring/models/template_summary.rb
 lib/docspring/models/template_summary_list.rb
@@ -262,17 +326,20 @@ lib/docspring/models/text_vertical_alignment.rb
 lib/docspring/models/typeface.rb
 lib/docspring/models/update_signature_request_request.rb
 lib/docspring/models/update_template_document_request.rb
+lib/docspring/models/update_template_fields_request.rb
 lib/docspring/models/update_template_request.rb
 lib/docspring/models/update_webhook_request.rb
 lib/docspring/models/upload_method.rb
 lib/docspring/models/upload_presign.rb
 lib/docspring/models/url_source_pdf.rb
+lib/docspring/models/validate_submission_request.rb
 lib/docspring/models/webhook.rb
 lib/docspring/models/webhook_event_type.rb
 lib/docspring/models/webhook_list.rb
 lib/docspring/models/webhook_mode.rb
 lib/docspring/version.rb
 spec/api/client_spec.rb
+spec/models/add_template_fields_request_spec.rb
 spec/models/ai_field_naming_language_spec.rb
 spec/models/authentication_check_spec.rb
 spec/models/barcode_symbology_spec.rb
@@ -294,6 +361,7 @@ spec/models/create_signature_request_event_request_spec.rb
 spec/models/create_signature_request_token_request_spec.rb
 spec/models/create_submission_batch_request_spec.rb
 spec/models/create_submission_request_spec.rb
+spec/models/create_template_preview_request_spec.rb
 spec/models/create_template_request_spec.rb
 spec/models/create_webhook_request_spec.rb
 spec/models/custom_file_list_spec.rb
@@ -306,10 +374,16 @@ spec/models/error_response_spec.rb
 spec/models/expiration_interval_spec.rb
 spec/models/field_comparison_condition_spec.rb
 spec/models/field_comparison_operator_spec.rb
+spec/models/field_dependency_input_spec.rb
+spec/models/field_dependency_spec.rb
 spec/models/field_display_type_spec.rb
 spec/models/field_equals_condition_spec.rb
 spec/models/field_equals_operator_spec.rb
+spec/models/field_group_input_spec.rb
+spec/models/field_group_spec.rb
+spec/models/field_group_type_spec.rb
 spec/models/field_in_condition_spec.rb
+spec/models/field_input_spec.rb
 spec/models/field_override_spec.rb
 spec/models/field_presence_condition_spec.rb
 spec/models/field_presence_operator_spec.rb
@@ -318,8 +392,12 @@ spec/models/field_reimport_state_spec.rb
 spec/models/field_setup_logic_spec.rb
 spec/models/field_setup_naming_spec.rb
 spec/models/field_setup_source_spec.rb
+spec/models/field_spec.rb
+spec/models/field_type_spec.rb
 spec/models/folder_list_spec.rb
 spec/models/folder_spec.rb
+spec/models/generate_files_format_spec.rb
+spec/models/generate_submission_files_request_spec.rb
 spec/models/generated_file_spec.rb
 spec/models/generated_file_state_spec.rb
 spec/models/html_engine_options_input_spec.rb
@@ -330,9 +408,16 @@ spec/models/model_code_language_spec.rb
 spec/models/move_folder_request_spec.rb
 spec/models/move_template_request_spec.rb
 spec/models/number_condition_type_spec.rb
+spec/models/output_format_spec.rb
 spec/models/page_format_spec.rb
+spec/models/page_image_spec.rb
+spec/models/page_images_spec.rb
+spec/models/predefined_field_input_spec.rb
+spec/models/predefined_field_spec.rb
 spec/models/publish_template_version_request_spec.rb
+spec/models/remove_template_fields_request_spec.rb
 spec/models/rename_folder_request_spec.rb
+spec/models/reorder_template_fields_request_spec.rb
 spec/models/restore_template_version_request_spec.rb
 spec/models/shape_type_spec.rb
 spec/models/signature_request_auth_second_factor_type_spec.rb
@@ -358,12 +443,19 @@ spec/models/submission_source_pdf_spec.rb
 spec/models/submission_source_spec.rb
 spec/models/submission_spec.rb
 spec/models/submission_state_spec.rb
+spec/models/submission_summary_spec.rb
+spec/models/submission_validation_spec.rb
 spec/models/template_actor_spec.rb
 spec/models/template_actor_type_spec.rb
 spec/models/template_defaults_input_spec.rb
 spec/models/template_defaults_spec.rb
+spec/models/template_diff_spec.rb
+spec/models/template_diff_summary_spec.rb
 spec/models/template_document_spec.rb
 spec/models/template_document_state_spec.rb
+spec/models/template_document_summary_spec.rb
+spec/models/template_field_change_spec.rb
+spec/models/template_field_changes_spec.rb
 spec/models/template_field_dependency_action_spec.rb
 spec/models/template_field_dependency_condition_input_spec.rb
 spec/models/template_field_dependency_condition_spec.rb
@@ -372,13 +464,18 @@ spec/models/template_field_dependency_match_spec.rb
 spec/models/template_field_dependency_operator_spec.rb
 spec/models/template_field_dependency_spec.rb
 spec/models/template_field_logic_status_spec.rb
+spec/models/template_field_move_spec.rb
+spec/models/template_fields_spec.rb
 spec/models/template_form_mode_spec.rb
 spec/models/template_model_code_spec.rb
 spec/models/template_page_ai_error_spec.rb
 spec/models/template_page_ai_naming_status_spec.rb
 spec/models/template_page_fields_status_spec.rb
 spec/models/template_page_image_status_spec.rb
+spec/models/template_page_images_spec.rb
 spec/models/template_page_processing_status_spec.rb
+spec/models/template_preview_spec.rb
+spec/models/template_preview_state_spec.rb
 spec/models/template_source_pdf_spec.rb
 spec/models/template_spec.rb
 spec/models/template_summary_list_spec.rb
@@ -392,11 +489,13 @@ spec/models/text_vertical_alignment_spec.rb
 spec/models/typeface_spec.rb
 spec/models/update_signature_request_request_spec.rb
 spec/models/update_template_document_request_spec.rb
+spec/models/update_template_fields_request_spec.rb
 spec/models/update_template_request_spec.rb
 spec/models/update_webhook_request_spec.rb
 spec/models/upload_method_spec.rb
 spec/models/upload_presign_spec.rb
 spec/models/url_source_pdf_spec.rb
+spec/models/validate_submission_request_spec.rb
 spec/models/webhook_event_type_spec.rb
 spec/models/webhook_list_spec.rb
 spec/models/webhook_mode_spec.rb

data/.travis.yml

@@ -8,4 +8,4 @@ script:
   - bundle install --path vendor/bundle
   - bundle exec rspec
   - gem build docspring.gemspec
-  - gem install ./docspring-4.0.0.gem
+  - gem install ./docspring-4.2.0.gem

data/AGENTS.md

@@ -69,8 +69,9 @@ keeps it.
   (https://docspring.com/docs/webhooks/overview/). A webhook created with API v2 sends events in API v2's format
   (version 4).
 - Verify each request's `X-DocSpring-Signature` header before acting on it: an HMAC-SHA256 of `{t}.{raw body}` with the
-  webhook's signing secret, computed over the raw body exactly as received
-  (https://docspring.com/docs/webhooks/verifying-signatures/).
+  webhook's signing secret, where `t` must be within 5 minutes
+  (https://docspring.com/docs/webhooks/verifying-signatures/). Pass the raw body exactly as received, not parsed JSON,
+  to `DocSpring.verify_webhook_signature(payload, signature_header, secret)`, which returns true or false.
 - No webhook is sent when a submission starts waiting for credits.
 
 ## Signature requests

data/CHANGELOG.md

@@ -1,3 +1,67 @@
+### 4.2.0 [October 29, 2026]
+
+- **BREAKING CHANGE**: list_templates returns a shorter `TemplateSummary`: a template's name, description, type, folder
+  (`parent_folder_id`, `path`), latest published version, whether it's `ready`, and its PDF's file name, state, error
+  and page count (`document`, a `TemplateDocumentSummary`). get_template returns its settings and the rest.
+- **BREAKING CHANGE**: list_submissions and list_template_submissions return `SubmissionSummary` instead of
+  `Submission`: without signature requests and uploads, with `data` only when you pass `include_data` (as before), and
+  with `files` only when you pass the new `include_files` (without the links to page images). get_submission returns the
+  whole submission.
+- New: the template webhook events (version 4) send the whole template, as get_template returns it, without its
+  `embed_edit_token`. They sent the settings without the rest.
+- New: list_submissions and list_template_submissions take a `state` filter: one state, such as `invalid_data` or
+  `error`.
+- New: get_template_model_code takes `just_types`, for the types alone, without the code that converts and checks JSON
+  (TypeScript, Ruby, Python, Java, C#, Elixir and Go: JavaScript and PHP code is the same either way).
+- New: create_submission, create_submission_batch and create_combined_pdf take an `Idempotency-Key` header. A request
+  repeated with the same key within 24 hours returns the first response and creates nothing. The same key with a
+  different request is a 422, and a repeat while the first request is still running is a 409.
+- New: create_template_preview and get_template_preview fill an HTML or PDF template's draft (or a published version)
+  with your data and return PNG images of its pages, not a PDF, so you can check how it prints before you publish it or
+  send live data. A preview creates no submission and uses no credits. Get the preview until its `state` is
+  `processed`. Previews are watermarked like test PDFs.
+- New: HTML templates' `html_escape_data` setting HTML-escapes the values they print (`{{ value }}`). It's on for new
+  templates and off for existing ones; `{{ value | raw }}` prints a value as it is.
+- New: `DocSpring.verify_webhook_signature(payload, signature_header, secret)` checks a webhook request's
+  `X-DocSpring-Signature` header. Pass it the request body exactly as it was received. It returns true or false, accepts
+  any `v1` that matches and rejects a timestamp more than 5 minutes old (`tolerance:` for another tolerance).
+- publish_template_version answers 409 when the draft hasn't changed since the latest published version, instead of
+  publishing a copy of it (code `conflict`). A template's first publish always works.
+- Every operation documents the 429 rate limit response (with `Retry-After`), and the creates that the sync hosts wait
+  for document their 504 (the record was saved: get it by the ID in the error).
+- Every optional field takes `null` in a submission's `data`, whatever its type, so model code that writes missing
+  values as null works. A null checkbox or group of fields (an object or a list) gets its defaults, as a missing key
+  does, and a null text, number, date, image or signature field prints blank, as before. Null in a required field is
+  still an error.
+- Query parameters and request body values that take a date and time (`created_after`, `created_before`) take a `Time`,
+  `DateTime` or `Date` as well as a string, sent as RFC 3339 (a `Date` as midnight UTC). They failed the request's
+  validation before.
+- Template and webhook names can be up to 512 characters, up from 255.
+
+### 4.1.0 [October 27, 2026]
+
+- 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.
+
 ### 4.0.0 [October 26, 2026]
 
 - **BREAKING CHANGE**: This version calls DocSpring API v2 (`/api/v2`). The 3.x versions call API v1, which keeps

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (4.0.0)
+    docspring (4.2.0)
       logger
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -14,7 +14,7 @@ GEM
     coderay (1.1.3)
     date (3.6.0)
     diff-lcs (1.6.2)
-    ethon (0.18.0)
+    ethon (0.19.1)
       ffi (>= 1.15.0)
       logger
     ffi (1.17.4)
@@ -28,7 +28,7 @@ GEM
     ffi (1.17.4-x86_64-darwin)
     ffi (1.17.4-x86_64-linux-gnu)
     ffi (1.17.4-x86_64-linux-musl)
-    io-console (0.9.4)
+    io-console (0.9.5)
     jaro_winkler (1.5.6)
     logger (1.7.0)
     method_source (1.1.0)
@@ -74,8 +74,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
     stringio (3.2.0)
-    typhoeus (1.6.0)
-      ethon (>= 0.18.0)
+    typhoeus (1.7.1)
+      ethon (>= 0.19.1, < 0.20.0)
     unicode-display_width (1.5.0)
 
 PLATFORMS
@@ -104,8 +104,8 @@ CHECKSUMS
   coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
   date (3.6.0) sha256=18ac945c4e24ebd93534f8eab8c2fd8c5604b3e977105b3798d62a1e8d27b580
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
-  docspring (4.0.0)
-  ethon (0.18.0) sha256=b598afc9f30448cb068b850714b7d6948e941476095d04f90a4ac65b8d6efcb2
+  docspring (4.2.0)
+  ethon (0.19.1) sha256=f309dec67cfdefaf96b3d1ee0ed4f186eac518f131340f607bb3df3b4e13ddc4
   ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf
   ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df
   ffi (1.17.4-aarch64-linux-musl) sha256=9286b7a615f2676245283aef0a0a3b475ae3aae2bb5448baace630bb77b91f39
@@ -117,7 +117,7 @@ CHECKSUMS
   ffi (1.17.4-x86_64-darwin) sha256=aa70390523cf3235096cf64962b709b4cfbd5c082a2cb2ae714eb0fe2ccda496
   ffi (1.17.4-x86_64-linux-gnu) sha256=9d3db14c2eae074b382fa9c083fe95aec6e0a1451da249eab096c34002bc752d
   ffi (1.17.4-x86_64-linux-musl) sha256=3fdf9888483de005f8ef8d1cf2d3b20d86626af206cbf780f6a6a12439a9c49e
-  io-console (0.9.4) sha256=a403304f32928ee85e56d457b4612ca43f2703b561a3258844992bd24085fbb1
+  io-console (0.9.5) sha256=83dd9bbf4c4680416629245b39cd4212eb5f4d9a4ea91804870c1f6b846414d5
   jaro_winkler (1.5.6) sha256=007db7805527ada1cc12f2547676181d63b0a504ec4dd7a9a2eb2424521ccd81
   logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
   method_source (1.1.0) sha256=181301c9c45b731b4769bc81e8860e72f9161ad7d66dd99103c9ab84f560f5c5
@@ -138,7 +138,7 @@ CHECKSUMS
   rubocop (0.66.0) sha256=f05a6896f367765b3f0fba663d0add120444f8de604dada405662b10a0860f5a
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
   stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
-  typhoeus (1.6.0) sha256=bacc41c23e379547e29801dc235cd1699b70b955a1ba3d32b2b877aa844c331d
+  typhoeus (1.7.1) sha256=86dcb6d787ee08e34947c9436b24af3c4b02880dc83c466b6ca4dbfc53c2ee7f
   unicode-display_width (1.5.0) sha256=9890eebd24feb4cb0e0542c9b8c6beecb40cda27be8c7afe49312625b36156eb
 
 BUNDLED WITH

data/README.md

@@ -9,7 +9,7 @@ templates with your data, generates PDFs from HTML templates, combines PDFs and
 The code in this repository is generated from DocSpring's OpenAPI spec ([About this SDK](#about-this-sdk)). Issues and
 pull requests are welcome.
 
-Version 4.0.0. Requires Ruby >= 2.7.
+Version 4.2.0. Requires Ruby >= 2.7.
 
 ## Install and configure
 
@@ -86,6 +86,7 @@ Ruby code for every method.
 
 | Method | Description |
 | ------ | ----------- |
+| [`add_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#add_template_fields) | Add fields to a template |
 | [`copy_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#copy_template) | Copy a template |
 | [`create_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_combined_pdf) | Combine PDFs |
 | [`create_custom_file_from_upload`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_custom_file_from_upload) | Create a custom file from an upload |
@@ -95,6 +96,7 @@ Ruby code for every method.
 | [`create_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_submission) | Generate a PDF |
 | [`create_submission_batch`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_submission_batch) | Generate PDFs in a batch |
 | [`create_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_template) | Create a template |
+| [`create_template_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_template_preview) | Preview a template with data |
 | [`create_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_webhook) | Create a webhook |
 | [`delete_custom_file`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_custom_file) | Delete a custom file |
 | [`delete_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_folder) | Delete a folder |
@@ -102,6 +104,7 @@ Ruby code for every method.
 | [`delete_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_webhook) | Delete a webhook |
 | [`expire_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#expire_combined_pdf) | Expire a combined PDF |
 | [`expire_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#expire_submission) | Expire a submission |
+| [`generate_submission_files`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_submission_files) | Generate more files |
 | [`generate_submission_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_submission_preview) | Generate a preview PDF |
 | [`get_combined_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_combined_pdf) | Get a combined PDF |
 | [`get_custom_file`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_custom_file) | Get a custom file |
@@ -111,28 +114,36 @@ Ruby code for every method.
 | [`get_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_submission) | Get a submission |
 | [`get_submission_batch`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_submission_batch) | Get a batch |
 | [`get_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template) | Get a template |
+| [`get_template_diff`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_diff) | Compare a version of a template with the one before it |
 | [`get_template_model_code`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_model_code) | Generate typed code for a template's submission data |
+| [`get_template_page_images`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_page_images) | Get images of a template's pages |
+| [`get_template_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_preview) | Get a template preview |
 | [`get_template_schema`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_schema) | Get the JSON Schema of a template's submission data |
 | [`get_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_webhook) | Get a webhook |
 | [`list_combined_pdfs`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_combined_pdfs) | List combined PDFs |
 | [`list_custom_files`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_custom_files) | List custom files |
 | [`list_folders`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_folders) | List folders |
 | [`list_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_submissions) | List submissions |
+| [`list_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_template_fields) | List a template's fields |
 | [`list_template_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_template_submissions) | List a template's submissions |
 | [`list_templates`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_templates) | List templates |
 | [`list_webhooks`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_webhooks) | List webhooks |
 | [`move_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#move_folder) | Move a folder |
 | [`move_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#move_template) | Move a template to a folder |
 | [`publish_template_version`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#publish_template_version) | Publish a template version |
+| [`remove_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#remove_template_fields) | Remove fields from a template |
 | [`rename_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#rename_folder) | Rename a folder |
+| [`reorder_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#reorder_template_fields) | Reorder a template's fields |
 | [`restore_template_version`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#restore_template_version) | Restore a template version |
 | [`test_authentication`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#test_authentication) | Test authentication |
 | [`update_signature_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_signature_request) | Update a signature request |
 | [`update_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template) | Update a template |
 | [`update_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_document) | Replace a template's PDF |
+| [`update_template_fields`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_fields) | Update a template's fields |
 | [`update_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_webhook) | Update a webhook |
 | [`upload_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template) | Create a PDF template from an uploaded PDF |
 | [`upload_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template_document) | Replace a template's PDF with an uploaded PDF |
+| [`validate_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#validate_submission) | Check a submission without creating it |
 
 ## Errors
 
@@ -166,6 +177,8 @@ On top of the generated code, we add:
 
 - A client constructor that reads your credentials, region and host from the environment.
 - A fix for multipart PUT requests in Ethon (file uploads to `upload_template_document`).
+- Dates and times in a request (`created_after`, a model's date-time attribute) can be a `Time`, `DateTime` or `Date`, sent as RFC 3339 strings. A `Date` is midnight UTC.
+- `DocSpring.verify_webhook_signature(payload, signature_header, secret)` checks a webhook request's `X-DocSpring-Signature` header, with `tolerance:` and `now:` keywords.
 
 Each release regenerates every file, so a change made only here would be lost in the next one. Issues and pull
 requests are welcome all the same: [open an issue](https://github.com/DocSpring/docspring-ruby/issues) or a pull request, or email

data/docs/AddTemplateFieldsRequest.md

@@ -0,0 +1,18 @@
+# DocSpring::AddTemplateFieldsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fields** | [**Array<FieldInput>**](FieldInput.md) | The fields to add. Settings left out have their defaults, except that a field with the name of other fields takes their shared settings. Shared settings it sets change them for every field with the name. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::AddTemplateFieldsRequest.new(
+  fields: null
+)
+```
+