docspring 3.5.0 → 4.1.0

data/.travis.yml

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

data/AGENTS.md

@@ -1,15 +1,15 @@
 # AGENTS.md
 
-Notes for AI coding agents working with the DocSpring Ruby SDK (`docspring`), in this repository or
-as a dependency of an app.
+Notes for AI coding agents working with the DocSpring Ruby SDK (`docspring`): integrating it into an
+app, or working in this repository.
 
 ## This code is generated
 
 Every file here is generated from DocSpring's OpenAPI spec by
 [DocSpring's fork of OpenAPI Generator](https://github.com/DocSpring/openapi-generator/tree/docspring/all_patches), and each release replaces
-all of it. Don't edit it or open pull requests that change it, and don't patch an installed copy: the next release
-overwrites the change. Report bugs at https://github.com/DocSpring/docspring-ruby/issues or to support@docspring.com, and DocSpring fixes them in
-the generator.
+all of it. Don't patch an installed copy: the next release overwrites the change. Issues and pull requests are welcome
+at https://github.com/DocSpring/docspring-ruby (or email support@docspring.com), and DocSpring makes the fix in the generator so that every release
+keeps it.
 
 ## Where to look
 
@@ -17,17 +17,77 @@ the generator.
 - [docs/Client.md](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md): every method, with its parameters and return type.
 - [docs/](https://github.com/DocSpring/docspring-ruby/tree/main/docs): every model and its fields.
 - https://docspring.com/docs/llms.txt: DocSpring's documentation for LLMs (`llms-small.txt`, `llms-full.txt`).
-- https://docspring.com/docs/api/: the API reference, with Ruby code for every method.
-- https://docspring.com/api-docs/v1/openapi.json: the OpenAPI spec this SDK is generated from.
-
-## Using it in an app
-
-- Credentials come from `DOCSPRING_TOKEN_ID` and `DOCSPRING_TOKEN_SECRET`. Keep them in the environment or a secret
-  store, never in code. Accounts in the EU region also need `DOCSPRING_REGION=EU`.
-- Template IDs look like `tpl_...` and submission IDs like `sub_...`.
-- Pass `test: true` when you generate PDFs during development: test PDFs are free and watermarked.
-- Generating a PDF waits for it, for up to 95 seconds. For many PDFs or slow templates, set `wait` to false and use
-  webhooks or check the submission later (https://docspring.com/docs/api-guide/synchronous-requests/).
-- Errors: Methods raise `DocSpring::ApiError` for an error response, with the HTTP status in `code` and the body in `response_body`.
-- Responses can be newer than this SDK, because DocSpring adds fields and enum values to API v1 without a new
-  version. The model leaves out a response field added to the API after this release. An enum value added to the API after this release comes back as a string, so handle values you don't recognize.
+- https://docspring.com/docs/: the guides. https://docspring.com/docs/api/: the API reference, with Ruby code
+  for every method.
+- https://docspring.com/api-docs/v2/openapi.json: the OpenAPI spec this SDK is generated from.
+
+## Set up
+
+- Credentials come from `DOCSPRING_TOKEN_ID` and `DOCSPRING_TOKEN_SECRET` (an API token from
+  https://app.docspring.com/api_tokens). Keep them in the environment or a secret store, never in code. An account in
+  the EU region also needs `DOCSPRING_REGION=EU`.
+- Call DocSpring from your server. The token secret gives full access to the account, so it must never reach a browser
+  or a mobile app. Signers use signing links or the embedded signing form instead (see Signature requests).
+- `test_authentication` checks the credentials.
+
+## Generate PDFs
+
+- Read a template's data shape before writing the request: `get_template_schema` returns the
+  JSON Schema of its submission data (its field names and types), and `get_template_model_code`
+  generates typed code for it. The keys of `data` are the template's field names. Date fields take `YYYY-MM-DD`.
+- Template IDs look like `tpl_...` and submission IDs like `sub_...`. Store the submission ID with your own record.
+- Pass `test: true` while you build: test PDFs are free and watermarked. Live PDFs use credits.
+- A submission uses the template's latest published version (its draft when nothing has been published yet). Pass
+  `version` (`draft`, `1.2.0`, or `1` for the latest 1.x.x) to use another one.
+- `create_submission` waits for the PDF, for up to 95 seconds, and returns the submission in
+  its final state: check its `state` (`processed`, or a failure state with an `error_message`). If the PDF takes longer,
+  the call fails with a 504 `polling_timeout` error that has the submission's ID. The submission exists and is still
+  being made, so don't send the request again (that makes a second one): get it with
+  `get_submission` until its state isn't `pending`. For slow templates or many PDFs, set
+  `wait` to false and use webhooks (https://docspring.com/docs/api-guide/synchronous-requests/).
+  `create_submission_batch` sends up to 50 submissions in one request.
+- `files.pdf.download_url` is a temporary link. Keep the submission ID (or `files.pdf.permanent_url`, which needs your
+  API token) and get a fresh link when someone downloads the PDF.
+- Submission data is often personal data: don't log request or response bodies. `expires_in` deletes a submission's PDF
+  and data that many seconds after it's created, and `expire_submission` deletes them now.
+
+## Errors
+
+- Methods raise `DocSpring::ApiError` for an error response, with the HTTP status in `code` and the body in `response_body`.
+- Every error response has one body: `{"error": {"code", "message", "details", "request_id"}}`. Branch on `code`, not
+  on the message. Each detail has a `pointer` to the request body value it's about, or the query `parameter`.
+- 422 `invalid_data`: the data doesn't match the template. The submission is saved anyway, as `invalid_data`, and the
+  error has its `submission_id`.
+- 402 `insufficient_credits`: the submission is saved and is made automatically once the account has credits. Don't
+  send it again (https://docspring.com/docs/api-guide/credits-and-rate-limits/).
+- 429 `rate_limited`: wait for the seconds in the `Retry-After` header, then retry.
+- Requests are checked against the API's request schemas before they're sent. A request the API would reject raises `DocSpring::ValidationError` (an `ArgumentError`), whose `details` are hashes with `code`, `message` and a `pointer` into the body (or a `parameter`). Turn the check off with `client.api_client.config.client_side_validation = false`.
+
+## Webhooks
+
+- Webhooks tell your server when a submission is processed or fails, instead of polling
+  (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/).
+- No webhook is sent when a submission starts waiting for credits.
+
+## Signature requests
+
+- To have people fill in fields and sign before the PDF is made, create the submission with `signature_requests`. Each
+  one has the `fields` its signer fills in (a field belongs to one signature request), and their `name` and `email`.
+  The PDF is made when every signer has finished
+  (https://docspring.com/docs/api-guide/create-signature-requests/).
+- Send a signer to the `signature_request_url` of a token from
+  `create_signature_request_token`. An `api` token's link opens the form for 24 hours and an
+  `email` token's for 7 days (`expires_at`), so create a new token when a signer comes back later.
+- To show the signing form on your own site, use Signature Requests JS, and add the site's domain to the template's
+  Embed Domains (https://docspring.com/docs/guides/embedded-forms/embedded-signature-requests/).
+
+## Responses
+
+- List methods return `data` and `next_cursor`: pass `next_cursor` as `cursor` to get the next page.
+- Responses can be newer than this SDK, because DocSpring adds fields and enum values to API v2 without a new
+  version. The model leaves out a response field added to the API after this release. Enum values in responses are strings, so a
+  value added after this release comes back as it is: handle values you don't recognize.

data/CHANGELOG.md

@@ -1,3 +1,150 @@
+### 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
+  working. Every change is in the migration guide: https://docspring.com/docs/api-guide/migrating-to-api-v2/
+- **BREAKING CHANGE**: If you set the API's full base URL yourself, change `/api/v1` in it to `/api/v2`. The client only
+  picks the version in the URLs it builds from a region or host.
+- **BREAKING CHANGE**: Operations are named after the resource they act on. generate_pdf is create_submission,
+  batch_generate_pdfs is create_submission_batch, combine_pdfs is create_combined_pdf, create_html_template and
+  create_pdf_template_from_upload are create_template (with a `template_type`), create_pdf_template (which uploads a PDF
+  file) is upload_template, get_full_template is get_template (which returns the template, without its fields for now),
+  update_template_document (which uploads a PDF file) is upload_template_document, update_template_document_from_upload
+  is update_template_document, generate_preview is generate_submission_preview, get_combined_submission is
+  get_combined_pdf, list_combined_submissions is list_combined_pdfs, expire_combined_submission is expire_combined_pdf,
+  move_template_to_folder is move_template and move_folder_to_folder is move_folder. New: get_folder, list_custom_files,
+  get_custom_file and delete_custom_file. A template's fields, and adding fields to a template, aren't in API v2 yet.
+- **BREAKING CHANGE**: Data requests are called signature requests. `get_data_request`, `update_data_request`,
+  `create_data_request_token` and `create_data_request_event` are `get_signature_request`, `update_signature_request`,
+  `create_signature_request_token` and `create_signature_request_event` (at `/signature_requests`), and their models are
+  `SignatureRequest`, `SignatureRequestToken` and `SignatureRequestEvent`. A submission's `data_requests` is
+  `signature_requests` (also when you create one), `data_request_id` is `signature_request_id`, a token's
+  `data_request_url` is `signature_request_url`, the `waiting_for_data_requests` state is
+  `waiting_for_signature_requests`, and a template's `add_data_request_submission_id_footers` is
+  `add_signature_request_submission_id_footers`. New ones get IDs that start with `srq_` instead of `drq_`.
+- **BREAKING CHANGE**: A response is the resource itself, with no `status` or wrapper key. Lists return `data` and
+  `next_cursor`: pass `next_cursor` as `cursor` to get the next page, and `limit` (1 to 100, default 50) for its size.
+  `page` and `per_page` are gone. Every create returns 201.
+- **BREAKING CHANGE**: Every error has one shape, `{"error": {"code", "message", "details", "request_id"}}`, with a
+  `code` to check (`validation_failed`, `not_found`, `insufficient_credits`, `rate_limited`, ...), and each detail has a
+  `pointer` to the body value it's about, or a `parameter` with the query parameter's name.
+- **BREAKING CHANGE**: Requests are validated strictly: an unknown property or query parameter, or a value of the wrong
+  type, is a 422 instead of being ignored. Request bodies must be JSON (`Content-Type: application/json`, or it's a
+  415), except the PDF uploads. Request bodies are flat, with no `template`, `folder` or `webhook` key around them.
+- **BREAKING CHANGE**: Submission data is checked more strictly. An empty `data` is validated like any other, date
+  fields take `YYYY-MM-DD` (or the template's date format when `parse_dates_using_template_date_format` is on), and a
+  signature request's `fields` must be fields on the template (set `ignore_unknown_fields` to leave out the others). A
+  submission that fails because of the template is still saved as `invalid_data`, and the 422 includes its
+  `submission_id`.
+- **BREAKING CHANGE**: A submission's or combined PDF's files are in `files`, by format. `files.pdf` has `state`,
+  `error_message`, `download_url`, `permanent_url`, `filename`, `content_type`, `size` and `sha256`, and replaces
+  `download_url`, `permanent_download_url` and `pdf_hash`. A submission's `files.audit_trail` and `files.preview`, with
+  the same properties, replace `audit_trail_download_url` and `preview_download_url`. A file made after its submission
+  was processed is listed while it's being made, so check its `state` before using its links. Combined submissions are
+  combined PDFs (`CombinedPdf`), a template's `document_url` is `document.download_url`, and a custom file's `url` is
+  `download_url`.
+- **BREAKING CHANGE**: A template's `embed_domains` is a list of domains, not a comma-separated string, and each entry
+  is checked. Copying a template with `parent_folder_id` null puts the copy at the root (leave it out to keep the
+  template's folder). A template's schema and model code describe the version that submissions use by default (the
+  latest published version), not the draft: pass `version` for another one.
+- **BREAKING CHANGE**: Every property name is snake_case, including template `defaults` (`font_size`, was `fontSize`),
+  `html_engine_options` (`margin_top`), a field dependency condition's `range_max`, and the field settings in a
+  submission's `field_overrides`.
+- `field_overrides` takes a `DocSpring::FieldOverride` per field name, with every setting an override can change
+  (`required`, `font_size`, `color`, ...), so a misspelt setting or a value of the wrong type is caught before the
+  request is sent.
+- A combined PDF's `source_pdfs` and a rule's `conditions` take a model per kind, with only the properties that kind
+  uses (another kind's property is a 422 `not_allowed`). `CombinedPdfSourceInput` is a `SubmissionSourcePdf`,
+  `CombinedPdfSourcePdf`, `TemplateSourcePdf`, `CustomFileSourcePdf` or `UrlSourcePdf`, picked by its `type`.
+  `TemplateFieldDependencyConditionInput` is a `FieldPresenceCondition` (`present`, `blank`), `FieldEqualsCondition`
+  (`equals`, `not_equals`), `FieldInCondition` (`in`, with a list), `FieldComparisonCondition` (`gt`, `gte`, `lt`,
+  `lte`, on a number field) or `FieldRangeCondition` (`range`), picked by its `operator`. Pass hashes, or the models,
+  which set their own `type` (and `FieldInCondition` and `FieldRangeCondition` their `operator`):
+  `DocSpring::UrlSourcePdf.new(url: url)`. A template returns its conditions with only the properties their operators
+  use, in the shape an update takes.
+- **BREAKING CHANGE**: Templates: `ready` and a `document` object (with its `state`, `page_count` and
+  `page_dimensions`) replace `document_processed`, `document_state`, `document_parse_error` and the `page_*` fields.
+  `list_templates` returns template summaries. Templates have no `webhook_url` or `webhook_options`: create a webhook
+  with `template_ids` instead.
+- **BREAKING CHANGE**: Secrets are write-only. A submission's or combined PDF's `password` and a template's
+  `encrypt_pdfs_password` and `slack_webhook_url` aren't returned; `has_password`, `has_encrypt_pdfs_password` and
+  `has_slack_webhook_url` say whether one is set.
+- **BREAKING CHANGE**: Webhooks created with this version send payload version 4, `{"id", "event_type", "created_at",
+"data"}`, where `data` is the resource as API v2 returns it. Their events have API v2's names
+  (`combined_pdf.processed`, `signature_request.completed`). Webhooks created with 3.x or in the dashboard keep their
+  payload version.
+- **BREAKING CHANGE**: Models are named after the API's resources (`Submission`, `CombinedPdf`, `Template`,
+  `TemplateSummary`, `SignatureRequest`), request bodies after their operation (`CreateSubmissionRequest`), and
+  enums are their own types (`SubmissionState`, `WebhookEventType`).
+- Response enums are types too (`SubmissionState`, `TemplateType`). Their constants are the values this version knows
+  (`DocSpring::SubmissionState::PROCESSED`), and the values stay strings, so a value added to the API after this release
+  comes back as it came.
+- The client checks each request against the API's request schemas before sending it, so an invalid request fails
+  without a round trip, with the details the API's 422 response would have. A request the API would reject raises
+  `DocSpring::ValidationError` (an `ArgumentError`), whose `details` are hashes with `code`, `message` and a `pointer`
+  into the body (or a `parameter`). The models' setters no longer check patterns, lengths or ranges themselves. Turn
+  the check off with `client.api_client.config.client_side_validation = false`.
+- A waited request to `sync.api.docspring.com` that times out returns a 504 `polling_timeout` error with the resource's
+  ID, so you can get it later. Without an ID, the request got no answer in time: check whether the resource was created
+  before you send it again.
+- A nullable map or list that you set to `nil` (such as a template's `html_engine_options`) is sent as `null` instead of
+  being left out.
+- **BREAKING CHANGE**: A client created with credentials, a host or a region has its own `ApiClient`, with a copy of
+  `DocSpring::Configuration.default`, so two clients with different credentials or hosts no longer change each other's.
+  `DocSpring::Client.new` with no arguments still uses `ApiClient.default`. Pass `api_client:` to share one.
+- An empty API token ID or secret counts as not set, so the client reads `DOCSPRING_TOKEN_ID` or
+  `DOCSPRING_TOKEN_SECRET` instead. It was sent as an empty string.
+- Templates: new `default_form_mode` setting (`web`, `visual` or `dual`), when you create or update a template.
+  It's the hosted form that `/templates/<id>/form` opens when the link has no `mode` parameter: the web form, the
+  visual form (filled in on the PDF), or both in tabs. HTML templates have no visual form, so they only accept
+  `web`.
+- Templates: `defaults` can set `required_field_background_color`, the background colour that visual forms and
+  signature requests give required fields. PDFs don't draw it.
+- Templates: new `allow_skipping_optional_fields` setting (boolean), when you create or update a template. Visual
+  forms and signature requests then show the Continue button as soon as the required fields are filled in, without
+  visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it.
+- Templates: when you replace a template's PDF, `reimport_fields` (boolean) replaces the template's fields with the
+  fillable fields in the new PDF (or in its current PDF when you don't upload one). A PDF with no fillable fields
+  keeps the template's fields.
+- Fields: `shape_type` can be `triangle` or `polygon`, with `shape_sides` (3 to 12) for a polygon. Text fields can set
+  `keep_leading_spaces` to keep the spaces at the start of each line in the PDF.
+- Templates: create_template and upload_template take `detect_fields` (boolean, default false). DocSpring then sets
+  up the PDF's fields as the "Automatically detect fields" upload option does: it imports or detects them, names them
+  with AI and sets up conditional logic. `field_source` (`auto`, `pdf_detection` or `pdf_form_fields`),
+  `field_naming` (`ai` or `preserve`) and `field_logic` (`ai` or `none`) choose how, like the Set Up Fields choices
+  in the template editor. With `pdf_form_fields`, `preserve` and `none`, the PDF's form fields are imported with their
+  own names and no AI. Each account gets free AI pages every month, and further pages are paid from credits. See
+  https://docspring.com/docs/template-editor/automatic-field-detection/.
+- Templates: new `ai_field_naming_language` setting (`auto`, `english` or `form_language`) for PDF templates, when
+  you create or update one: the language AI uses for field names. It's null for HTML templates.
+- Templates: a template's `document` includes `has_fillable_fields`, `page_processing_statuses` (how processing is
+  going on each page: its image, its fields and AI naming) and `field_logic_status` (the AI logic step that runs once
+  every page's fields are done, and can still rename fields and add rules). Field setup is finished when
+  `document.state` is `processed` and `field_logic_status` isn't `pending` or `processing`.
+
 ### 3.5.0 [October 18, 2026]
 
 - Submissions and combined submissions can be in the new `insufficient_credits` state: a live PDF that your credit

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (3.5.0)
+    docspring (4.1.0)
       logger
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -33,10 +33,10 @@ GEM
     logger (1.7.0)
     method_source (1.1.0)
     parallel (1.28.0)
-    parser (3.3.12.0)
+    parser (3.3.13.0)
       ast (~> 2.4.1)
       racc
-    pry (0.16.0)
+    pry (0.16.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
       reline (>= 0.6.0)
@@ -104,7 +104,7 @@ CHECKSUMS
   coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
   date (3.6.0) sha256=18ac945c4e24ebd93534f8eab8c2fd8c5604b3e977105b3798d62a1e8d27b580
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
-  docspring (3.5.0)
+  docspring (4.1.0)
   ethon (0.18.0) sha256=b598afc9f30448cb068b850714b7d6948e941476095d04f90a4ac65b8d6efcb2
   ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf
   ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df
@@ -122,8 +122,8 @@ CHECKSUMS
   logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
   method_source (1.1.0) sha256=181301c9c45b731b4769bc81e8860e72f9161ad7d66dd99103c9ab84f560f5c5
   parallel (1.28.0) sha256=33e6de1484baf2524792d178b0913fc8eb94c628d6cfe45599ad4458c638c970
-  parser (3.3.12.0) sha256=21a6d7f755d5a24dfbdc6e6b772e4e879a52e7631a88bc5a3a134606052c9828
-  pry (0.16.0) sha256=d76c69065698ed1f85e717bd33d7942c38a50868f6b0673c636192b3d1b6054e
+  parser (3.3.13.0) sha256=e02f9b63c2fe05b0c68f692ba4df89b3cb113b663964f75d988fbebfd6c3deca
+  pry (0.16.1) sha256=d92d82c86e7f2dc34beec6d2892d5cf5ea517eea22eed3ceabb38ee62a98accc
   pry-byebug (3.12.0) sha256=594e094ae8a8390a7ad4c7b36ae36e13304ed02664c67417d108dc5f7213d1b7
   psych (5.5.0) sha256=4b245bbbd0f3238df8ccee766ebc1a6b062b10e4ee1d3284eb588739ba156a0a
   racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
@@ -142,4 +142,4 @@ CHECKSUMS
   unicode-display_width (1.5.0) sha256=9890eebd24feb4cb0e0542c9b8c6beecb40cda27be8c7afe49312625b36156eb
 
 BUNDLED WITH
-  4.0.8
+  4.0.20

data/README.md

@@ -6,7 +6,10 @@ templates with your data, generates PDFs from HTML templates, combines PDFs and
 [Documentation](https://docspring.com/docs/) · [API reference](https://docspring.com/docs/api/) ·
 [RubyGems](https://rubygems.org/gems/docspring) · [Changelog](https://github.com/DocSpring/docspring-ruby/blob/main/CHANGELOG.md)
 
-Version 3.5.0. Requires Ruby >= 2.7.
+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.
 
 ## Install and configure
 
@@ -57,22 +60,21 @@ Fill a template with data (use your template's ID in place of `tpl_1234567890abc
 
 ```ruby
 template_id = 'tpl_1234567890abcdef01'
-submission = {
-  data: { first_name: 'John', last_name: 'Smith', phone_number: '+11234567890' },
-  metadata: { foo: 123, bar: :baz },
+body = {
+  data: { 'first_name' => 'John', 'last_name' => 'Smith', 'phone_number' => '+11234567890' },
+  metadata: { user_id: 42 },
+  test: true,
 }
-wait = nil
 
-response = client.generate_pdf(
+response = client.create_submission(
   template_id,
-  submission,
-  wait: wait
+  body
 )
 puts response
 ```
 
-By default the call waits for the PDF, for up to 95 seconds, and the submission in the response has its
-`download_url`. Set `wait` to false to get a pending submission straight away.
+By default the call waits for the PDF, for up to 95 seconds, and the submission in the response has a link to
+download it (`files.pdf.download_url`). Set `wait` to false to get a pending submission straight away.
 [Sync vs. async processing](https://docspring.com/docs/api-guide/synchronous-requests/) covers the time limit, status
 checks and webhooks.
 
@@ -84,86 +86,100 @@ Ruby code for every method.
 
 | Method | Description |
 | ------ | ----------- |
-| [`add_fields_to_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#add_fields_to_template) | Add new fields to a Template |
-| [`batch_generate_pdfs`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#batch_generate_pdfs) | Generate multiple PDFs |
-| [`combine_pdfs`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#combine_pdfs) | Merge submission PDFs, template PDFs, or custom files |
+| [`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_custom_file_from_upload`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_custom_file_from_upload) | Create a new custom file from a cached S3 upload |
-| [`create_data_request_event`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_data_request_event) | Create a new event for emailing a signee a request for signature |
-| [`create_data_request_token`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_data_request_token) | Create a new data request token for form authentication |
+| [`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 |
 | [`create_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_folder) | Create a folder |
-| [`create_html_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_html_template) | Create a new HTML template |
-| [`create_pdf_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_pdf_template) | Create a new PDF template with a form POST file upload |
-| [`create_pdf_template_from_upload`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_pdf_template_from_upload) | Create a new PDF template from a cached S3 file upload |
+| [`create_signature_request_event`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_signature_request_event) | Record a signature request event |
+| [`create_signature_request_token`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_signature_request_token) | Create a signature request token |
+| [`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_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 |
 | [`delete_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_template) | Delete a template |
 | [`delete_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#delete_webhook) | Delete a webhook |
-| [`expire_combined_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#expire_combined_submission) | Expire a combined submission |
-| [`expire_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#expire_submission) | Expire a PDF submission |
-| [`generate_pdf`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_pdf) | Generate a PDF |
-| [`generate_preview`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#generate_preview) | Generate a preview PDF for partially completed data requests |
-| [`get_combined_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_combined_submission) | Check the status of a combined submission (merged PDFs) |
-| [`get_data_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_data_request) | Look up a submission data request |
-| [`get_full_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_full_template) | Fetch the full attributes for a PDF template |
-| [`get_presign_url`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_presign_url) | Get a presigned S3 URL for direct file upload |
-| [`get_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_submission) | Check the status of a PDF |
-| [`get_submission_batch`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_submission_batch) | Check the status of a submission batch job |
-| [`get_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template) | Check the status of an uploaded template |
-| [`get_template_model_code`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_model_code) | Generate typed model code for a template |
-| [`get_template_schema`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_template_schema) | Fetch the JSON schema for a template |
+| [`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 |
+| [`get_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_folder) | Get a folder |
+| [`get_presign_url`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_presign_url) | Get a presigned URL to upload a file |
+| [`get_signature_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#get_signature_request) | Get a signature request |
+| [`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_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_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_combined_submissions) | Get a list of all combined submissions |
-| [`list_folders`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_folders) | Get a list of all folders |
-| [`list_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_submissions) | List all submissions |
-| [`list_template_submissions`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_template_submissions) | List all submissions for a given template |
-| [`list_templates`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_templates) | Get a list of all templates |
-| [`list_webhooks`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#list_webhooks) | Get a list of all webhooks |
-| [`move_folder_to_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#move_folder_to_folder) | Move a folder |
-| [`move_template_to_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#move_template_to_folder) | Move Template to folder |
+| [`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_data_request`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_data_request) | Update a submission data 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) | Update a template's document with a form POST file upload |
-| [`update_template_document_from_upload`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_document_from_upload) | Update a template's document with a cached S3 file upload |
+| [`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
 
 Methods raise `DocSpring::ApiError` for an error response, with the HTTP status in `code` and the body in `response_body`.
 
+The client checks each request against the API's request schemas before sending it. A request the API would reject raises `DocSpring::ValidationError` (an `ArgumentError`), whose `details` are hashes with `code`, `message` and a `pointer` into the body (or a `parameter`). Turn the check off with `client.api_client.config.client_side_validation = false`.
+The details are the ones the API's 422 response would have, so you get them without a round trip.
+
 ## API changes
 
-DocSpring adds fields and enum values to API v1 without releasing a new API version. Changes that would break
+DocSpring adds fields and enum values to API v2 without releasing a new API version. Changes that would break
 existing code, such as removing or renaming a field, go in a new API version
 ([API changes](https://docspring.com/docs/api-guide/openapi-schema/#api-changes)). So this SDK keeps working with
 responses that are newer than it is:
 
 - The model leaves out a response field added to the API after this release.
-- An enum value added to the API after this release comes back as a string, so handle values you don't recognize.
+- Enum values in responses are strings, so a value added to the API after this release comes back as it is: handle values you don't recognize.
 
 Upgrade the SDK to read new fields and enum values. The [changelog](https://github.com/DocSpring/docspring-ruby/blob/main/CHANGELOG.md) lists
 what each release adds.
 
 ## About this SDK
 
-This SDK is generated from DocSpring's [OpenAPI spec](https://docspring.com/api-docs/v1/openapi.json) with
-[DocSpring's fork of OpenAPI Generator](https://github.com/DocSpring/openapi-generator/tree/docspring/all_patches) 7.16.0.
+This SDK is generated from DocSpring's [OpenAPI spec](https://docspring.com/api-docs/v2/openapi.json) with
+[DocSpring's fork of OpenAPI Generator](https://github.com/DocSpring/openapi-generator/tree/docspring/all_patches) 7.26.0.
 The fork changes the Ruby generator:
 
-- Responses with an enum value added to the API after this release don't raise `ArgumentError`. Setting an attribute yourself still checks its value.
+- An enum value added to the API after this release comes back as the API sent it, instead of raising `ArgumentError`. An enum type's constants are the values this release knows, and the values are strings.
 
 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 `update_template_document`).
+- A fix for multipart PUT requests in Ethon (file uploads to `upload_template_document`).
 
-Because the code is generated, we can't merge pull requests that change it. Please
-[open an issue](https://github.com/DocSpring/docspring-ruby/issues) or email [support@docspring.com](mailto:support@docspring.com) instead, and
-we'll fix it in the generator. [AGENTS.md](https://github.com/DocSpring/docspring-ruby/blob/main/AGENTS.md) is a short guide for AI coding agents.
+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
+[support@docspring.com](mailto:support@docspring.com), and we'll make the fix in the generator so that every release
+keeps it. [AGENTS.md](https://github.com/DocSpring/docspring-ruby/blob/main/AGENTS.md) is a guide for AI coding agents that integrate this SDK.
 
 ## License
 

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
+)
+```
+

data/docs/{RenameFolderData.md → AiFieldNamingLanguage.md}

@@ -1,18 +1,15 @@
-# DocSpring::RenameFolderData
+# DocSpring::AiFieldNamingLanguage
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  |  |
 
 ## Example
 
 ```ruby
 require 'docspring'
 
-instance = DocSpring::RenameFolderData.new(
-  name: null
-)
+instance = DocSpring::AiFieldNamingLanguage.new()
 ```
 

data/docs/AuthenticationCheck.md

@@ -0,0 +1,18 @@
+# DocSpring::AuthenticationCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authenticated** | **Boolean** | Always true. |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::AuthenticationCheck.new(
+  authenticated: null
+)
+```
+

data/docs/{CreateFolderData.md → BarcodeSymbology.md}

@@ -1,18 +1,15 @@
-# DocSpring::CreateFolderData
+# DocSpring::BarcodeSymbology
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **folder** | **Object** |  |  |
 
 ## Example
 
 ```ruby
 require 'docspring'
 
-instance = DocSpring::CreateFolderData.new(
-  folder: null
-)
+instance = DocSpring::BarcodeSymbology.new()
 ```