docspring 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f14e5a7b2bfc1d3afccaa2fe06b9a452849c1e68159d2bb3b5cd28317251105d
-  data.tar.gz: b34c23551a9e275212671e5bac87568bec392ee68f379589cb9de514b6871152
+  metadata.gz: e997a9a92a04e7b8eaeb759762e39be31bb36af02db1fa61f65637c984f6e88f
+  data.tar.gz: 50b74a6a63e254b540af52e18e7c1b32275e4069ed1e71ceb3edea81824532be
 SHA512:
-  metadata.gz: c9c41809479101fc003e24371dc49de667b566329208c656f653977cc7548a174f482c90978d3bcc62800771c173dc374406cbcfc973365f72ecdf6f5d6f2457
-  data.tar.gz: 51775f90a82bb42c0a6ce063b3a834c665f8adfa2e8acfd14dca4925adf65cd835e0fb8a79b108cb567daeccf6f477fe02be3b20848fbf42ea5854ad63e7a7e9
+  metadata.gz: 1a60aa7099efbb3871f29e3f4ea86c7095fa3495fb62c3f25bdc23c0640425291626c173b923f5baf07126f304ead67c79c970a99ce6244405c3150947b942e3
+  data.tar.gz: 6ef873b90d45b59c89829065d1d70b225c30e7feb116698a545347c2563580f9fe44fa0fde50378b8bf87052c0ba109d017fd11c52d200dcf55000d57d4f7649

data/.travis.yml

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

data/AGENTS.md

@@ -90,5 +90,5 @@ keeps it.
 
 - 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.
+  version. The model leaves out a response field added to the API after this release. An enum value added after this release comes
+  back as the API sent it: handle values you don't recognize.

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+### 4.3.0 [October 31, 2026]
+
+- New: get_template_model_code takes `rust` as its `lang`, for Rust structs that serde reads and writes.
+- New: Word templates (`template_type` `docx`). create_template makes one from a Word document (.docx, up to 50 MB)
+  that you upload and pass as a `cache_id`, or pass as a `document_url` or `document_base64`; upload_template takes the
+  file itself. update_template_document and upload_template_document replace its document the same ways. Each tag in
+  the document, such as `{{ customer.name }}`, becomes a field. Each of them takes an OpenDocument text file (.odt)
+  too, which DocSpring converts to a Word document.
+- New: a Word template's `output_format`, what its submissions make unless they set `output_formats`: `docx` (a Word
+  document), `odt` (an OpenDocument file) or `pdf`. create_template and upload_template require it, and
+  update_template changes it. A Word template that encrypts its PDFs makes PDFs, because Word documents and
+  OpenDocument files can't be password-protected.
+- New: the `docx` and `odt` output formats, a Word template's filled-in Word document (`files.docx`) and OpenDocument
+  file (`files.odt`, converted from the Word document). Add them to `output_formats` in create_submission or
+  create_submission_batch to get more than one file, such as the Word document and the PDF.
+- generate_submission_files takes `pdf`, the PDF of a Word template's submission that didn't make one (converted from
+  its Word document), `docx`, the Word document of one that made only its PDF (made again from its data and the
+  template version it used), and `odt`, its OpenDocument file. None of them uses credits again. Until the new file is
+  ready, its `state` in `files` is `pending`, and when it couldn't be made, its `error_message` says why.
+- A Word template's `document` is its Word document: `document.permanent_url` downloads it. Its `state` is `processed`
+  once it's uploaded or downloaded (`downloading` or `download_failed` while a `document_url` downloads, `converting`
+  or `conversion_failed` while an OpenDocument file is converted), and get_template_diff's `document_changed` says
+  whether it was edited.
+- get_template_page_images returns a 409 for a Word template, whose pages are only laid out when a document is made.
+- create_template_preview previews Word templates too: images of the pages of the PDF that the template's Word
+  document makes with your data. A DocSpring server that can't convert Word documents to PDF returns a 409.
+
 ### 4.2.0 [October 29, 2026]
 
 - **BREAKING CHANGE**: list_templates returns a shorter `TemplateSummary`: a template's name, description, type, folder

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (4.2.0)
+    docspring (4.3.0)
       logger
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -100,11 +100,12 @@ DEPENDENCIES
 
 CHECKSUMS
   ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  bundler (4.0.23) sha256=407ba8a1d928f412847f819aa5f8b6aef7c59fb51feb517112af8a165487287b
   byebug (13.0.0) sha256=d2263efe751941ca520fa29744b71972d39cbc41839496706f5d9b22e92ae05d
   coderay (1.1.3) sha256=dc530018a4684512f8f38143cd2a096c9f02a1fc2459edcfe534787a7fc77d4b
   date (3.6.0) sha256=18ac945c4e24ebd93534f8eab8c2fd8c5604b3e977105b3798d62a1e8d27b580
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
-  docspring (4.2.0)
+  docspring (4.3.0)
   ethon (0.19.1) sha256=f309dec67cfdefaf96b3d1ee0ed4f186eac518f131340f607bb3df3b4e13ddc4
   ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf
   ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df
@@ -142,4 +143,4 @@ CHECKSUMS
   unicode-display_width (1.5.0) sha256=9890eebd24feb4cb0e0542c9b8c6beecb40cda27be8c7afe49312625b36156eb
 
 BUNDLED WITH
-  4.0.20
+  4.0.23

data/README.md

@@ -1,7 +1,8 @@
 # DocSpring Ruby SDK
 
 The official Ruby client for the [DocSpring API](https://docspring.com/docs/api/). DocSpring fills PDF
-templates with your data, generates PDFs from HTML templates, combines PDFs and collects e-signatures.
+forms with your data, generates PDFs and Word documents from HTML and Word templates, combines PDFs and collects
+e-signatures.
 
 [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)
@@ -9,7 +10,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.2.0. Requires Ruby >= 2.7.
+Version 4.3.0. Requires Ruby >= 2.7.
 
 ## Install and configure
 
@@ -138,11 +139,11 @@ Ruby code for every method.
 | [`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_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_template_document) | Replace a template's document |
 | [`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 |
+| [`upload_template`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template) | Create a template from an uploaded PDF or Word document |
+| [`upload_template_document`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#upload_template_document) | Replace a template's document with an uploaded file |
 | [`validate_submission`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#validate_submission) | Check a submission without creating it |
 
 ## Errors
@@ -160,7 +161,7 @@ existing code, such as removing or renaming a field, go in a new API version
 responses that are newer than it is:
 
 - The model leaves out a response field added to the API after this release.
-- 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.
+- An enum value added to the API after this release comes back as the API sent it: 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.