docspring 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38cd07210f52669a3a99ee5615b49d16a2e495b2f3ac99ab173b30fb26853ff0
-  data.tar.gz: 40c104f6b2803806db1b63efc2a28b2536d0dd28a175054f0d000950c33bddf7
+  metadata.gz: 3a11774c889c3f5f78b06ecc109d774135778e4a127e9231cca7c01c80646808
+  data.tar.gz: ba8a09b96fbd6136bab001bede610a25ad54ce945b8d4716db979c312d9f6bf9
 SHA512:
-  metadata.gz: 7614ebbf9e21cd24f4f0f226698722040a79fc102c100dd96106b6d12f93171fc76f50f4d8dad6770386712907c7e30b3383196b674fd16633bd219dd8bb22c9
-  data.tar.gz: 1e8eba3789174fb7e0f5602fae560740e3b054adae86743d199c753fa942dc0096068b544832d25bf1a5772cfc2079aed712e4817f9e7a4223af1f57ceb2c493
+  metadata.gz: 580764cb088cc7ba219e28565d191c94841074e686b386e405945eeac2542a1bdc9867ada62cac93cfa479e942339f8b3aba246eca4f4f43d94ae6c8d44cab2c
+  data.tar.gz: bf9881c8bfb725c6560bc742b26bb1983909536b7cf4c9c13aca70e3223021f983b67d256bd45a4153b854ce97307bf2417fea06bb440960454a4eb30ddbd929

data/.openapi-generator/FILES

@@ -31,6 +31,7 @@ docs/CustomFile.md
 docs/ErrorOrMultipleErrorsResponse.md
 docs/ErrorResponse.md
 docs/Folder.md
+docs/ForbiddenErrorResponse.md
 docs/JsonSchema.md
 docs/ListSubmissionsResponse.md
 docs/MoveFolderData.md
@@ -95,6 +96,7 @@ lib/docspring/models/custom_file.rb
 lib/docspring/models/error_or_multiple_errors_response.rb
 lib/docspring/models/error_response.rb
 lib/docspring/models/folder.rb
+lib/docspring/models/forbidden_error_response.rb
 lib/docspring/models/json_schema.rb
 lib/docspring/models/list_submissions_response.rb
 lib/docspring/models/move_folder_data.rb
@@ -154,6 +156,7 @@ spec/models/custom_file_spec.rb
 spec/models/error_or_multiple_errors_response_spec.rb
 spec/models/error_response_spec.rb
 spec/models/folder_spec.rb
+spec/models/forbidden_error_response_spec.rb
 spec/models/json_schema_spec.rb
 spec/models/list_submissions_response_spec.rb
 spec/models/move_folder_data_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-3.3.0.gem
+  - gem install ./docspring-3.5.0.gem

data/AGENTS.md

@@ -0,0 +1,33 @@
+# AGENTS.md
+
+Notes for AI coding agents working with the DocSpring Ruby SDK (`docspring`), in this repository or
+as a dependency of an app.
+
+## 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.
+
+## Where to look
+
+- [README.md](README.md): install, configuration, an example and how errors and API changes are handled.
+- [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.

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+### 3.5.0 [October 18, 2026]
+
+- Submissions and combined submissions can be in the new `insufficient_credits` state: a live PDF that your credit
+  balance can't cover is saved and processed once you add credits. See
+  https://docspring.com/docs/api-guide/credits-and-rate-limits/.
+- generate_pdf, batch_generate_pdfs and combine_pdfs document the 402 response for insufficient credits. Their
+  responses can include a `code`, which is `insufficient_credits` on a 402.
+- generate_pdf, batch_generate_pdfs, create_pdf_template, create_pdf_template_from_upload, create_html_template and
+  copy_template document a 403 response with a `code` of `upgrade_required` (the plan doesn't include it) or
+  `account_suspended`.
+
+### 3.4.0 [October 18, 2026]
+
+- Templates: new `parse_dates_using_template_date_format` setting, when you create or update a template. When it's
+  true, date values sent as NN/NN/YYYY (with slashes, dashes or dots) are read in the order of the template's default
+  date format: month first for `%m/%d/%Y`, day first for `%d/%m/%Y`. When it's false, they're read day first.
+- A new README: installing, a quick start, every API method, errors, and how API changes are handled. The repository
+  also has an AGENTS.md for coding agents.
+
 ### 3.3.0 [October 15, 2026]
 
 - Submissions and data requests can now be in the `declined` state, when a signer declines to sign. Data

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (3.3.0)
+    docspring (3.5.0)
       logger
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -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.3.0)
+  docspring (3.5.0)
   ethon (0.18.0) sha256=b598afc9f30448cb068b850714b7d6948e941476095d04f90a4ac65b8d6efcb2
   ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf
   ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df

data/README.md

@@ -1,203 +1,170 @@
-# docspring
+# DocSpring Ruby SDK
 
-DocSpring - the Ruby gem for the DocSpring API
+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.
 
-Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding 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)
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+Version 3.5.0. Requires Ruby >= 2.7.
 
-- API version: v1
-- Package version: 3.3.0
-- Generator version: 7.16.0-DOCSPRING
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+## Install and configure
 
-## Installation
+Add the following line to your Gemfile:
 
-### Build a gem
-
-To build the Ruby code into a gem:
-
-```shell
-gem build docspring.gemspec
+```ruby
+gem "docspring"
 ```
 
-Then either install the gem locally:
+Then run:
 
-```shell
-gem install ./docspring-3.3.0.gem
+```bash
+bundle install
 ```
 
-(for development, run `gem install --dev ./docspring-3.3.0.gem` to install the development dependencies)
+Configure authentication via environment variables:
 
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
-
-Finally add this to the Gemfile:
-
-    gem 'docspring', '~> 3.3.0'
+```bash
+export DOCSPRING_TOKEN_ID="API_TOKEN_ID"
+export DOCSPRING_TOKEN_SECRET="API_TOKEN_SECRET"
+```
 
-### Install from Git
+You can also configure the region or host. The host takes priority over the region:
 
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+```bash
+export DOCSPRING_REGION="US" # US or EU (defaults to US)
+export DOCSPRING_HOST="docspring.yourcompany.com" # For on-premise deployments
+```
 
-    gem 'docspring', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+Initialize the DocSpring client with no arguments:
 
-### Include the Ruby code directly
+```ruby
+client = DocSpring::Client.new
+```
 
-Include the Ruby code directly using `-I` as follows:
+Or pass credentials directly as arguments:
 
-```shell
-ruby -Ilib script.rb
+```ruby
+client = DocSpring::Client.new(
+  api_token_id: 'API_TOKEN_ID',
+  api_token_secret: 'API_TOKEN_SECRET'
+)
 ```
 
-## Getting Started
+## Generate a PDF
 
-Please follow the [installation](#installation) procedure and then run the following code:
+Fill a template with data (use your template's ID in place of `tpl_1234567890abcdef01`):
 
 ```ruby
-# Load the gem
-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 | 
-data = DocSpring::AddFieldsData.new({fields: [3.56]}) # AddFieldsData | 
-
-begin
-  #Add new fields to a Template
-  result = api_instance.add_fields_to_template(template_id, data)
-  p result
-rescue DocSpring::ApiError => e
-  puts "Exception when calling Client->add_fields_to_template: #{e}"
-end
-
+template_id = 'tpl_1234567890abcdef01'
+submission = {
+  data: { first_name: 'John', last_name: 'Smith', phone_number: '+11234567890' },
+  metadata: { foo: 123, bar: :baz },
+}
+wait = nil
+
+response = client.generate_pdf(
+  template_id,
+  submission,
+  wait: wait
+)
+puts response
 ```
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://sync.api.docspring.com/api/v1*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*DocSpring::Client* | [**add_fields_to_template**](docs/Client.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
-*DocSpring::Client* | [**batch_generate_pdfs**](docs/Client.md#batch_generate_pdfs) | **POST** /submissions/batches | Generate multiple PDFs
-*DocSpring::Client* | [**combine_pdfs**](docs/Client.md#combine_pdfs) | **POST** /combined_submissions | Merge submission PDFs, template PDFs, or custom files
-*DocSpring::Client* | [**copy_template**](docs/Client.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a template
-*DocSpring::Client* | [**create_custom_file_from_upload**](docs/Client.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached S3 upload
-*DocSpring::Client* | [**create_data_request_event**](docs/Client.md#create_data_request_event) | **POST** /data_requests/{data_request_id}/events | Create a new event for emailing a signee a request for signature
-*DocSpring::Client* | [**create_data_request_token**](docs/Client.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Create a new data request token for form authentication
-*DocSpring::Client* | [**create_folder**](docs/Client.md#create_folder) | **POST** /folders/ | Create a folder
-*DocSpring::Client* | [**create_html_template**](docs/Client.md#create_html_template) | **POST** /templates?endpoint_variant=create_html_template | Create a new HTML template
-*DocSpring::Client* | [**create_pdf_template**](docs/Client.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload
-*DocSpring::Client* | [**create_pdf_template_from_upload**](docs/Client.md#create_pdf_template_from_upload) | **POST** /templates?endpoint_variant=create_template_from_cached_upload | Create a new PDF template from a cached S3 file upload
-*DocSpring::Client* | [**create_webhook**](docs/Client.md#create_webhook) | **POST** /webhooks | Create a webhook
-*DocSpring::Client* | [**delete_folder**](docs/Client.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
-*DocSpring::Client* | [**delete_template**](docs/Client.md#delete_template) | **DELETE** /templates/{template_id} | Delete a template
-*DocSpring::Client* | [**delete_webhook**](docs/Client.md#delete_webhook) | **DELETE** /webhooks/{webhook_id} | Delete a webhook
-*DocSpring::Client* | [**expire_combined_submission**](docs/Client.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
-*DocSpring::Client* | [**expire_submission**](docs/Client.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
-*DocSpring::Client* | [**generate_pdf**](docs/Client.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generate a PDF
-*DocSpring::Client* | [**generate_preview**](docs/Client.md#generate_preview) | **POST** /submissions/{submission_id}/generate_preview | Generate a preview PDF for partially completed data requests
-*DocSpring::Client* | [**get_combined_submission**](docs/Client.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
-*DocSpring::Client* | [**get_data_request**](docs/Client.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
-*DocSpring::Client* | [**get_full_template**](docs/Client.md#get_full_template) | **GET** /templates/{template_id}?full=true | Fetch the full attributes for a PDF template
-*DocSpring::Client* | [**get_presign_url**](docs/Client.md#get_presign_url) | **GET** /uploads/presign | Get a presigned S3 URL for direct file upload
-*DocSpring::Client* | [**get_submission**](docs/Client.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
-*DocSpring::Client* | [**get_submission_batch**](docs/Client.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
-*DocSpring::Client* | [**get_template**](docs/Client.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
-*DocSpring::Client* | [**get_template_model_code**](docs/Client.md#get_template_model_code) | **GET** /templates/{template_id}/model_code | Generate typed model code for a template
-*DocSpring::Client* | [**get_template_schema**](docs/Client.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
-*DocSpring::Client* | [**get_webhook**](docs/Client.md#get_webhook) | **GET** /webhooks/{webhook_id} | Get a webhook
-*DocSpring::Client* | [**list_combined_submissions**](docs/Client.md#list_combined_submissions) | **GET** /combined_submissions | Get a list of all combined submissions
-*DocSpring::Client* | [**list_folders**](docs/Client.md#list_folders) | **GET** /folders/ | Get a list of all folders
-*DocSpring::Client* | [**list_submissions**](docs/Client.md#list_submissions) | **GET** /submissions | List all submissions
-*DocSpring::Client* | [**list_template_submissions**](docs/Client.md#list_template_submissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
-*DocSpring::Client* | [**list_templates**](docs/Client.md#list_templates) | **GET** /templates | Get a list of all templates
-*DocSpring::Client* | [**list_webhooks**](docs/Client.md#list_webhooks) | **GET** /webhooks | Get a list of all webhooks
-*DocSpring::Client* | [**move_folder_to_folder**](docs/Client.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
-*DocSpring::Client* | [**move_template_to_folder**](docs/Client.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
-*DocSpring::Client* | [**publish_template_version**](docs/Client.md#publish_template_version) | **POST** /templates/{template_id}/publish_version | Publish a template version
-*DocSpring::Client* | [**rename_folder**](docs/Client.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
-*DocSpring::Client* | [**restore_template_version**](docs/Client.md#restore_template_version) | **POST** /templates/{template_id}/restore_version | Restore a template version
-*DocSpring::Client* | [**test_authentication**](docs/Client.md#test_authentication) | **GET** /authentication | Test authentication
-*DocSpring::Client* | [**update_data_request**](docs/Client.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
-*DocSpring::Client* | [**update_template**](docs/Client.md#update_template) | **PUT** /templates/{template_id} | Update a Template
-*DocSpring::Client* | [**update_template_document**](docs/Client.md#update_template_document) | **PUT** /templates/{template_id}?endpoint_variant=update_template_pdf_with_form_post | Update a template's document with a form POST file upload
-*DocSpring::Client* | [**update_template_document_from_upload**](docs/Client.md#update_template_document_from_upload) | **PUT** /templates/{template_id}?endpoint_variant=update_template_pdf_with_cached_upload | Update a template's document with a cached S3 file upload
-*DocSpring::Client* | [**update_webhook**](docs/Client.md#update_webhook) | **PUT** /webhooks/{webhook_id} | Update a webhook
-
-
-## Documentation for Models
-
- - [DocSpring::AddFieldsData](docs/AddFieldsData.md)
- - [DocSpring::BatchGeneratePdfs201Response](docs/BatchGeneratePdfs201Response.md)
- - [DocSpring::CombinePdfsData](docs/CombinePdfsData.md)
- - [DocSpring::CombinedSubmission](docs/CombinedSubmission.md)
- - [DocSpring::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
- - [DocSpring::CopyTemplateOptions](docs/CopyTemplateOptions.md)
- - [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
- - [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
- - [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
- - [DocSpring::CreateFolderData](docs/CreateFolderData.md)
- - [DocSpring::CreateHtmlTemplate](docs/CreateHtmlTemplate.md)
- - [DocSpring::CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)
- - [DocSpring::CreatePdfTemplate](docs/CreatePdfTemplate.md)
- - [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
- - [DocSpring::CreateSubmissionDataRequestEventRequest](docs/CreateSubmissionDataRequestEventRequest.md)
- - [DocSpring::CreateSubmissionDataRequestEventResponse](docs/CreateSubmissionDataRequestEventResponse.md)
- - [DocSpring::CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)
- - [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
- - [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
- - [DocSpring::CreateWebhookData](docs/CreateWebhookData.md)
- - [DocSpring::CustomFile](docs/CustomFile.md)
- - [DocSpring::ErrorOrMultipleErrorsResponse](docs/ErrorOrMultipleErrorsResponse.md)
- - [DocSpring::ErrorResponse](docs/ErrorResponse.md)
- - [DocSpring::Folder](docs/Folder.md)
- - [DocSpring::JsonSchema](docs/JsonSchema.md)
- - [DocSpring::ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
- - [DocSpring::MoveFolderData](docs/MoveFolderData.md)
- - [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
- - [DocSpring::MultipleErrorsResponse](docs/MultipleErrorsResponse.md)
- - [DocSpring::PublishVersionData](docs/PublishVersionData.md)
- - [DocSpring::RenameFolderData](docs/RenameFolderData.md)
- - [DocSpring::RestoreVersionData](docs/RestoreVersionData.md)
- - [DocSpring::Submission](docs/Submission.md)
- - [DocSpring::Submission422Response](docs/Submission422Response.md)
- - [DocSpring::SubmissionAction](docs/SubmissionAction.md)
- - [DocSpring::SubmissionBatch](docs/SubmissionBatch.md)
- - [DocSpring::SubmissionBatchData](docs/SubmissionBatchData.md)
- - [DocSpring::SubmissionBatchWithSubmissions](docs/SubmissionBatchWithSubmissions.md)
- - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
- - [DocSpring::SubmissionDataRequestEvent](docs/SubmissionDataRequestEvent.md)
- - [DocSpring::SubmissionDataRequestShow](docs/SubmissionDataRequestShow.md)
- - [DocSpring::SubmissionDataRequestToken](docs/SubmissionDataRequestToken.md)
- - [DocSpring::SubmissionPreview](docs/SubmissionPreview.md)
- - [DocSpring::SuccessErrorResponse](docs/SuccessErrorResponse.md)
- - [DocSpring::SuccessMultipleErrorsResponse](docs/SuccessMultipleErrorsResponse.md)
- - [DocSpring::Template](docs/Template.md)
- - [DocSpring::TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)
- - [DocSpring::TemplateDeleteResponse](docs/TemplateDeleteResponse.md)
- - [DocSpring::TemplateModelCodeResponse](docs/TemplateModelCodeResponse.md)
- - [DocSpring::TemplatePreview](docs/TemplatePreview.md)
- - [DocSpring::TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)
- - [DocSpring::UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)
- - [DocSpring::UpdatePdfTemplate](docs/UpdatePdfTemplate.md)
- - [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
- - [DocSpring::UpdateWebhookData](docs/UpdateWebhookData.md)
- - [DocSpring::UploadPresignResponse](docs/UploadPresignResponse.md)
- - [DocSpring::Webhook](docs/Webhook.md)
-
-
-## Documentation for Authorization
-
-
-Authentication schemes defined for the API:
-### api_token_basic
-
-- **Type**: HTTP basic authentication
-
+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.
+[Sync vs. async processing](https://docspring.com/docs/api-guide/synchronous-requests/) covers the time limit, status
+checks and webhooks.
+
+## Methods
+
+[docs/Client.md](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md) has each method's parameters and return type, and
+[docs/](https://github.com/DocSpring/docspring-ruby/tree/main/docs) has the models. The [API reference](https://docspring.com/docs/api/) has
+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 |
+| [`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_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_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#create_webhook) | Create a webhook |
+| [`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 |
+| [`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 |
+| [`publish_template_version`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#publish_template_version) | Publish a template version |
+| [`rename_folder`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#rename_folder) | Rename a folder |
+| [`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_webhook`](https://github.com/DocSpring/docspring-ruby/blob/main/docs/Client.md#update_webhook) | Update a webhook |
+
+## Errors
+
+Methods raise `DocSpring::ApiError` for an error response, with the HTTP status in `code` and the body in `response_body`.
+
+## API changes
+
+DocSpring adds fields and enum values to API v1 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.
+
+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.
+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.
+
+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`).
+
+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.
+
+## License
+
+MIT. See [LICENSE](https://github.com/DocSpring/docspring-ruby/blob/main/LICENSE).

data/docs/BatchGeneratePdfs201Response.md

@@ -9,6 +9,7 @@
 | **errors** | **Array<String>** |  | [optional] |
 | **submission_batch** | [**SubmissionBatch**](SubmissionBatch.md) |  |  |
 | **submissions** | **Array<Object>** |  |  |
+| **code** | **String** | `insufficient_credits` when the response is a 402. | [optional] |
 
 ## Example
 
@@ -20,7 +21,8 @@ instance = DocSpring::BatchGeneratePdfs201Response.new(
   error: null,
   errors: null,
   submission_batch: null,
-  submissions: null
+  submissions: null,
+  code: null
 )
 ```
 

data/docs/Client.md

@@ -130,7 +130,7 @@ end
 
 Generate multiple PDFs
 
-Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs.  See also: - [Batch Generate PDFs](https://docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Request format, responses, and limits 
+Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs.  Live PDFs use credits. If any live submission is waiting for credits, the API returns 402 and the others are still processed: check each submission's `state`. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).  See also: - [Batch Generate PDFs](https://docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Request format, responses, and limits 
 
 ### Examples
 
@@ -204,7 +204,7 @@ end
 
 Merge submission PDFs, template PDFs, or custom files
 
-Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided. 
+Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided.  Combining uses credits (4 per source PDF, plus 4 per unit of the combined PDF), even with a test API token or watermarked source PDFs. If your balance can't cover it, the API returns 402 and the combined submission waits in the `insufficient_credits` state until you add credits. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/). 
 
 ### Examples
 
@@ -1278,7 +1278,7 @@ end
 
 Generate a PDF
 
-Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the `wait=false` query parameter to return immediately.  See also: - [Customize the PDF Title and Filename](https://docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](https://docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn't fit in fields 
+Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the `wait=false` query parameter to return immediately.  Live PDFs use credits; test PDFs (`test: true`) are free and watermarked. If your balance can't cover a live PDF, the API returns 402 and the submission waits in the `insufficient_credits` state until you add credits. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).  See also: - [Customize the PDF Title and Filename](https://docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](https://docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn't fit in fields 
 
 ### Examples
 
@@ -1424,7 +1424,7 @@ end
 
 Check the status of a combined submission (merged PDFs)
 
-Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads). 
+Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads).  `insufficient_credits` means the combined submission is waiting for credits and is processed once you add them. If it's still waiting after 30 days, it moves to `error`. 
 
 ### Examples
 
@@ -1701,7 +1701,7 @@ This endpoint does not need any parameter.
 
 Check the status of a PDF
 
-Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing. 
+Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing.  `insufficient_credits` means the submission is waiting for credits and is processed once you add them. If it's still waiting after 30 days, it moves to `error`. 
 
 ### Examples
 
@@ -1775,7 +1775,7 @@ end
 
 Check the status of a submission batch job
 
-Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing. 
+Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing.  Submissions waiting for credits are in the `insufficient_credits` state and count as pending, so the batch stays `pending` until you add credits or they stop waiting after 30 days. 
 
 ### Examples
 

data/docs/CombinePdfsData.md

@@ -9,7 +9,7 @@
 | **metadata** | **Object** |  | [optional] |
 | **password** | **String** |  | [optional] |
 | **source_pdfs** | **Array<Object>** |  |  |
-| **test** | **Boolean** | Deprecated, and has no effect. A combined PDF is a test or live document because of its source PDFs. | [optional] |
+| **test** | **Boolean** | Deprecated, and has no effect. Combining always uses credits, even with a test API token or watermarked source PDFs. | [optional] |
 
 ## Example
 

data/docs/CreateCombinedSubmissionResponse.md

@@ -6,7 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **status** | **String** |  |  |
 | **combined_submission** | [**CombinedSubmission**](CombinedSubmission.md) |  |  |
+| **error** | **String** |  | [optional] |
 | **errors** | **Array<String>** |  | [optional] |
+| **code** | **String** | `insufficient_credits` when the response is a 402. | [optional] |
 
 ## Example
 
@@ -16,7 +18,9 @@ require 'docspring'
 instance = DocSpring::CreateCombinedSubmissionResponse.new(
   status: null,
   combined_submission: null,
-  errors: null
+  error: null,
+  errors: null,
+  code: null
 )
 ```