docspring 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d124a4eb39c1edc1b535fe60c6027af58866731018f574e3b58e9c9e658081bb
-  data.tar.gz: 4a365cf441b2b34c9a841059ea647b0c8ce0e2680183ddc229a7f6482e4af8e1
+  metadata.gz: f14e5a7b2bfc1d3afccaa2fe06b9a452849c1e68159d2bb3b5cd28317251105d
+  data.tar.gz: b34c23551a9e275212671e5bac87568bec392ee68f379589cb9de514b6871152
 SHA512:
-  metadata.gz: e565b0c650ff70a2e1791e82c6be2b9afe21c0edce375b77c17cc92f98954b71e5ff6fa473d8df181a17687e9e2cfc8b4ddffa34dbc7e103f16366eb74936e88
-  data.tar.gz: cd338cfa5caed832ebcfe25aedab0582c2e004050bab456d3b2d5b7f1e43001644d44a4a6d16be5d942f600f4a2a203fd41e83331b6ec2e7ea82f8badfe42aa2
+  metadata.gz: c9c41809479101fc003e24371dc49de667b566329208c656f653977cc7548a174f482c90978d3bcc62800771c173dc374406cbcfc973365f72ecdf6f5d6f2457
+  data.tar.gz: 51775f90a82bb42c0a6ce063b3a834c665f8adfa2e8acfd14dca4925adf65cd835e0fb8a79b108cb567daeccf6f477fe02be3b20848fbf42ea5854ad63e7a7e9

data/.openapi-generator/FILES

@@ -29,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
@@ -110,6 +111,7 @@ docs/SubmissionList.md
 docs/SubmissionSource.md
 docs/SubmissionSourcePdf.md
 docs/SubmissionState.md
+docs/SubmissionSummary.md
 docs/SubmissionValidation.md
 docs/Template.md
 docs/TemplateActor.md
@@ -120,6 +122,7 @@ docs/TemplateDiff.md
 docs/TemplateDiffSummary.md
 docs/TemplateDocument.md
 docs/TemplateDocumentState.md
+docs/TemplateDocumentSummary.md
 docs/TemplateFieldChange.md
 docs/TemplateFieldChanges.md
 docs/TemplateFieldDependency.md
@@ -140,6 +143,8 @@ 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
@@ -193,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
@@ -274,6 +280,7 @@ 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
@@ -284,6 +291,7 @@ 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
@@ -304,6 +312,8 @@ 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
@@ -351,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
@@ -432,6 +443,7 @@ 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
@@ -441,6 +453,7 @@ 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
@@ -461,6 +474,8 @@ 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

data/.travis.yml

@@ -8,4 +8,4 @@ script:
   - bundle install --path vendor/bundle
   - bundle exec rspec
   - gem build docspring.gemspec
-  - gem install ./docspring-4.1.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,43 @@
+### 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (4.1.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.1.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.1.0. Requires Ruby >= 2.7.
+Version 4.2.0. Requires Ruby >= 2.7.
 
 ## Install and configure
 
@@ -96,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 |
@@ -116,6 +117,7 @@ Ruby code for every method.
 | [`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 |
@@ -175,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/Client.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://sync.api.docspring.com/api/v2*
 | [**create_submission**](Client.md#create_submission) | **POST** /templates/{template_id}/submissions | Generate a PDF |
 | [**create_submission_batch**](Client.md#create_submission_batch) | **POST** /submissions/batches | Generate PDFs in a batch |
 | [**create_template**](Client.md#create_template) | **POST** /templates | Create a template |
+| [**create_template_preview**](Client.md#create_template_preview) | **POST** /templates/{template_id}/previews | Preview a template with data |
 | [**create_webhook**](Client.md#create_webhook) | **POST** /webhooks | Create a webhook |
 | [**delete_custom_file**](Client.md#delete_custom_file) | **DELETE** /custom_files/{custom_file_id} | Delete a custom file |
 | [**delete_folder**](Client.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder |
@@ -34,6 +35,7 @@ All URIs are relative to *https://sync.api.docspring.com/api/v2*
 | [**get_template_diff**](Client.md#get_template_diff) | **GET** /templates/{template_id}/diff | Compare a version of a template with the one before it |
 | [**get_template_model_code**](Client.md#get_template_model_code) | **GET** /templates/{template_id}/model_code | Generate typed code for a template's submission data |
 | [**get_template_page_images**](Client.md#get_template_page_images) | **GET** /templates/{template_id}/page_images | Get images of a template's pages |
+| [**get_template_preview**](Client.md#get_template_preview) | **GET** /templates/{template_id}/previews/{preview_id} | Get a template preview |
 | [**get_template_schema**](Client.md#get_template_schema) | **GET** /templates/{template_id}/schema | Get the JSON Schema of a template's submission data |
 | [**get_webhook**](Client.md#get_webhook) | **GET** /webhooks/{webhook_id} | Get a webhook |
 | [**list_combined_pdfs**](Client.md#list_combined_pdfs) | **GET** /combined_pdfs | List combined PDFs |
@@ -231,7 +233,8 @@ end
 api_instance = DocSpring::Client.new
 body = DocSpring::CreateCombinedPdfRequest.new({source_pdfs: [DocSpring::CombinedPdfSourcePdf.new({type: 'type_example', id: 'id_example'})]}) # CreateCombinedPdfRequest | The PDFs to merge, and the combined PDF's settings.
 opts = {
-  wait: true # Boolean | Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+  wait: true, # Boolean | Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+  idempotency_key: 'idempotency_key_example' # String | A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another combined PDF. Send a new key with each new combined PDF, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
 }
 
 begin
@@ -267,6 +270,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **body** | [**CreateCombinedPdfRequest**](CreateCombinedPdfRequest.md) | The PDFs to merge, and the combined PDF's settings. |  |
 | **wait** | **Boolean** | Wait until the PDF has been generated before responding. Default true on sync.api hosts. | [optional] |
+| **idempotency_key** | **String** | A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another combined PDF. Send a new key with each new combined PDF, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds. | [optional] |
 
 ### Return type
 
@@ -428,7 +432,7 @@ end
 
 Record a signature request event
 
-Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. 
+Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. A finished (completed, declined or expired) signature request's audit trail takes no more events, and a test API token can't record one for a live signature request. 
 
 ### Examples
 
@@ -593,7 +597,8 @@ template_id = 'tpl_1234567890abcdef01' # String | The template's ID.
 body = DocSpring::CreateSubmissionRequest.new # CreateSubmissionRequest | The submission's data and settings.
 opts = {
   version: 'version_example', # String | The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published).
-  wait: true # Boolean | Wait until the files have been generated before responding. Default true on sync.api hosts.
+  wait: true, # Boolean | Wait until the files have been generated before responding. Default true on sync.api hosts.
+  idempotency_key: 'idempotency_key_example' # String | A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another submission. Send a new key with each new submission, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
 }
 
 begin
@@ -631,6 +636,7 @@ end
 | **body** | [**CreateSubmissionRequest**](CreateSubmissionRequest.md) | The submission's data and settings. |  |
 | **version** | **String** | The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published). | [optional] |
 | **wait** | **Boolean** | Wait until the files have been generated before responding. Default true on sync.api hosts. | [optional] |
+| **idempotency_key** | **String** | A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another submission. Send a new key with each new submission, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds. | [optional] |
 
 ### Return type
 
@@ -669,7 +675,8 @@ end
 api_instance = DocSpring::Client.new
 body = DocSpring::CreateSubmissionBatchRequest.new({submissions: [DocSpring::SubmissionInput.new]}) # CreateSubmissionBatchRequest | The submissions to create, and the settings they share.
 opts = {
-  wait: true # Boolean | Wait until every PDF in the batch has been generated before responding. Default true on sync.api hosts.
+  wait: true, # Boolean | Wait until every PDF in the batch has been generated before responding. Default true on sync.api hosts.
+  idempotency_key: 'idempotency_key_example' # String | A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another batch. Send a new key with each new batch, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
 }
 
 begin
@@ -705,6 +712,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **body** | [**CreateSubmissionBatchRequest**](CreateSubmissionBatchRequest.md) | The submissions to create, and the settings they share. |  |
 | **wait** | **Boolean** | Wait until every PDF in the batch has been generated before responding. Default true on sync.api hosts. | [optional] |
+| **idempotency_key** | **String** | A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another batch. Send a new key with each new batch, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds. | [optional] |
 
 ### Return type
 
@@ -794,6 +802,82 @@ end
 - **Accept**: application/json
 
 
+## create_template_preview
+
+> <TemplatePreview> create_template_preview(template_id, body, opts)
+
+Preview a template with data
+
+Makes PNG images of a template's pages filled in with the data you send (not a PDF), so you can check how an HTML or PDF template prints with your data before you publish a version or send live data. It renders the template's draft, or the published `version` you ask for. A preview makes no submission and uses no credits, and its pages are watermarked like a test submission's PDF. It's `pending` while it renders: get it with GET /templates/{template_id}/previews/{preview_id} until it's `processed`, with an image of each page, or `error`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::Client.new
+template_id = 'tpl_1234567890abcdef02' # String | The template's ID.
+body = DocSpring::CreateTemplatePreviewRequest.new({data: { key: 3.56}}) # CreateTemplatePreviewRequest | The data to render the template with.
+opts = {
+  version: 'version_example' # String | A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+}
+
+begin
+  # Preview a template with data
+  result = api_instance.create_template_preview(template_id, body, opts)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Error when calling Client->create_template_preview: #{e}"
+end
+```
+
+#### Using the create_template_preview_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TemplatePreview>, Integer, Hash)> create_template_preview_with_http_info(template_id, body, opts)
+
+```ruby
+begin
+  # Preview a template with data
+  data, status_code, headers = api_instance.create_template_preview_with_http_info(template_id, body, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplatePreview>
+rescue DocSpring::ApiError => e
+  puts "Error when calling Client->create_template_preview_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The template's ID. |  |
+| **body** | [**CreateTemplatePreviewRequest**](CreateTemplatePreviewRequest.md) | The data to render the template with. |  |
+| **version** | **String** | A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`. | [optional] |
+
+### Return type
+
+[**TemplatePreview**](TemplatePreview.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_webhook
 
 > <Webhook> create_webhook(body)
@@ -2079,7 +2163,7 @@ end
 
 Generate typed code for a template's submission data
 
-Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
+Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object, and `just_types=true` leaves out the code that converts JSON to and from the types. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
 
 ### Examples
 
@@ -2097,7 +2181,8 @@ api_instance = DocSpring::Client.new
 template_id = 'tpl_1234567890abcdef01' # String | The template's ID.
 lang = DocSpring::ModelCodeLanguage::TYPESCRIPT # ModelCodeLanguage | The language to generate the code in.
 opts = {
-  version: 'draft' # String | The template version: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published), the version a submission uses by default.
+  version: 'draft', # String | The template version: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published), the version a submission uses by default.
+  just_types: true # Boolean | Return only the types (interfaces, classes or structs), without the code that converts JSON to and from them. Default false. JavaScript has no types and PHP no types-only code, so theirs is the same either way.
 }
 
 begin
@@ -2134,6 +2219,7 @@ end
 | **template_id** | **String** | The template's ID. |  |
 | **lang** | [**ModelCodeLanguage**](.md) | The language to generate the code in. |  |
 | **version** | **String** | The template version: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published), the version a submission uses by default. | [optional] |
+| **just_types** | **Boolean** | Return only the types (interfaces, classes or structs), without the code that converts JSON to and from them. Default false. JavaScript has no types and PHP no types-only code, so theirs is the same either way. | [optional] |
 
 ### Return type
 
@@ -2223,6 +2309,78 @@ end
 - **Accept**: application/json
 
 
+## get_template_preview
+
+> <TemplatePreview> get_template_preview(template_id, preview_id)
+
+Get a template preview
+
+Returns a preview made with POST /templates/{template_id}/previews. Once it's `processed`, `pages` has a PNG image of each page with a temporary link to download it: a preview has no PDF. Previews are deleted an hour after they're created. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::Client.new
+template_id = 'tpl_1234567890abcdef02' # String | The template's ID.
+preview_id = 'tpv_1234567890abcdef0123' # String | The preview's ID.
+
+begin
+  # Get a template preview
+  result = api_instance.get_template_preview(template_id, preview_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Error when calling Client->get_template_preview: #{e}"
+end
+```
+
+#### Using the get_template_preview_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TemplatePreview>, Integer, Hash)> get_template_preview_with_http_info(template_id, preview_id)
+
+```ruby
+begin
+  # Get a template preview
+  data, status_code, headers = api_instance.get_template_preview_with_http_info(template_id, preview_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplatePreview>
+rescue DocSpring::ApiError => e
+  puts "Error when calling Client->get_template_preview_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The template's ID. |  |
+| **preview_id** | **String** | The preview's ID. |  |
+
+### Return type
+
+[**TemplatePreview**](TemplatePreview.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_template_schema
 
 > Hash&lt;String, Object&gt; get_template_schema(template_id, opts)
@@ -2597,7 +2755,7 @@ end
 
 List submissions
 
-Returns the submissions in your account, newest first, one page at a time. Lists leave out each submission's `data` unless you pass `include_data=true`. 
+Returns the submissions in your account, newest first, one page at a time. Each one is a summary: its `data` is null unless you pass `include_data=true`, and its `files` are empty unless you pass `include_files=true`. Get a submission by its ID for its signature requests, uploads and page images. 
 
 ### Examples
 
@@ -2619,7 +2777,9 @@ opts = {
   created_before: Time.parse('2018-10-20T09:00:00Z'), # Time | Only list submissions created before this time.
   include_data: true, # Boolean | Include each submission's `data` (null without it).
   limit: 56, # Integer | How many items to return (1-100, default 50).
-  cursor: 'cursor_example' # String | The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  cursor: 'cursor_example', # String | The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  state: DocSpring::SubmissionState::PENDING, # SubmissionState | Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+  include_files: true # Boolean | Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
 }
 
 begin
@@ -2660,6 +2820,8 @@ end
 | **include_data** | **Boolean** | Include each submission's `data` (null without it). | [optional] |
 | **limit** | **Integer** | How many items to return (1-100, default 50). | [optional][default to 50] |
 | **cursor** | **String** | The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one. | [optional] |
+| **state** | [**SubmissionState**](.md) | Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck. | [optional] |
+| **include_files** | **Boolean** | Include each submission's generated files and their download links (`files`, empty without it), without the page images' links. | [optional] |
 
 ### Return type
 
@@ -2777,7 +2939,9 @@ opts = {
   created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only list submissions created before this time.
   include_data: true, # Boolean | Include each submission's `data` (null without it).
   limit: 56, # Integer | How many items to return (1-100, default 50).
-  cursor: 'cursor_example' # String | The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  cursor: 'cursor_example', # String | The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  state: DocSpring::SubmissionState::PENDING, # SubmissionState | Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+  include_files: true # Boolean | Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
 }
 
 begin
@@ -2818,6 +2982,8 @@ end
 | **include_data** | **Boolean** | Include each submission's `data` (null without it). | [optional] |
 | **limit** | **Integer** | How many items to return (1-100, default 50). | [optional][default to 50] |
 | **cursor** | **String** | The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one. | [optional] |
+| **state** | [**SubmissionState**](.md) | Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck. | [optional] |
+| **include_files** | **Boolean** | Include each submission's generated files and their download links (`files`, empty without it), without the page images' links. | [optional] |
 
 ### Return type
 
@@ -2839,7 +3005,7 @@ end
 
 List templates
 
-Returns the templates in your account (their drafts), newest first, one page at a time. Get a template by its ID for its HTML, defaults and published versions. 
+Returns the templates in your account (their drafts), newest first, one page at a time. Each one is a summary: get a template by its ID for its settings, its PDF in full, its HTML, defaults and published versions. 
 
 ### Examples
 

data/docs/CombinedPdf.md

@@ -7,7 +7,7 @@
 | **id** | **String** | The combined PDF's ID. |  |
 | **state** | [**CombinedPdfState**](CombinedPdfState.md) | `pending` until the PDF has been generated, then `processed`. `insufficient_credits`: waiting for credits; `error_message` says whether the PDF is generated once you add them. `account_suspended`: waiting for the account to be reactivated, for up to 30 days. `error`: the PDFs couldn't be merged (see `error_message`). Waiting ends in `error` if it's discarded or takes over 30 days. |  |
 | **source_pdfs** | [**Array<CombinedPdfSource>**](CombinedPdfSource.md) | The PDFs to merge, in order. |  |
-| **metadata** | **Hash<String, Object>** | Your own data about the combined PDF, such as an ID from your app. |  |
+| **metadata** | **Hash<String, Object>** | Your own data about the combined PDF, such as an ID from your app. Its `pdf_filename` key names the PDF's file (`files.pdf.filename`, and its download): a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the combined PDF's ID (`com_1234567890abcdef01.pdf`). |  |
 | **has_password** | **Boolean** | Whether the PDF needs a password to open (`password`). |  |
 | **delete_custom_files** | **Boolean** | Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files. |  |
 | **error_message** | **String** | Why the PDFs couldn't be merged, when `state` is `error`. |  |

data/docs/CreateCombinedPdfRequest.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **source_pdfs** | [**Array<CombinedPdfSourceInput>**](CombinedPdfSourceInput.md) | The PDFs to merge, in order. |  |
-| **metadata** | **Hash<String, Object>** | Your own data about the combined PDF, such as an ID from your app. | [optional] |
+| **metadata** | **Hash<String, Object>** | Your own data about the combined PDF, such as an ID from your app. Its `pdf_filename` key names the PDF's file (`files.pdf.filename`, and its download): a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the combined PDF's ID (`com_1234567890abcdef01.pdf`). | [optional] |
 | **password** | **String** | A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. | [optional] |
 | **delete_custom_files** | **Boolean** | Delete the custom files in `source_pdfs` once the combined PDF has been generated (they're kept if it fails). Other combined PDFs can't use them after that. A test API token can't delete custom files. | [optional] |
 | **expires_in** | **Integer** | Seconds after the PDF is generated until the combined PDF expires, up to 10 years (315360000). One that fails is kept for at least 48 hours. Without it, the combined PDF is kept until you delete it. | [optional] |