docspring 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0d687b11706d412a3672e312f6692a173079a58a4b83ce336f8dd7a1df94230
-  data.tar.gz: c7848c09b5e8bae983300846564e1741b034bdb09f4a18732ff6400a589b5a76
+  metadata.gz: 3a11774c889c3f5f78b06ecc109d774135778e4a127e9231cca7c01c80646808
+  data.tar.gz: ba8a09b96fbd6136bab001bede610a25ad54ce945b8d4716db979c312d9f6bf9
 SHA512:
-  metadata.gz: 817c3f7a9e81959050e59a8786488f13762435109ec3db569d4d2887ffe95715765624569f4effbd6e89792f13de38a83c7cb0ba770ed144c00c0f6a2135d67f
-  data.tar.gz: 01a9c3e07d089e33f87315ed855c73cfe42fb67b8ec0d201efdc99375d1bedc72d279028b81d5d4418435b0776b4e4b7aa2eda8696b2216d4b6004f01f65080c
+  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.4.0.gem
+  - gem install ./docspring-3.5.0.gem

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (3.4.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.4.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

@@ -6,7 +6,7 @@ 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.4.0. Requires Ruby >= 2.7.
+Version 3.5.0. Requires Ruby >= 2.7.
 
 ## Install and configure
 

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

data/docs/CreateCustomFileResponse.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **status** | **String** |  |  |
 | **custom_file** | [**CustomFile**](CustomFile.md) |  |  |
+| **error** | **String** |  | [optional] |
 | **errors** | **Array<String>** |  | [optional] |
 
 ## Example
@@ -16,6 +17,7 @@ require 'docspring'
 instance = DocSpring::CreateCustomFileResponse.new(
   status: null,
   custom_file: null,
+  error: null,
   errors: null
 )
 ```

data/docs/CreatePdfSubmissionData.md

@@ -11,7 +11,7 @@
 | **field_overrides** | **Object** |  | [optional] |
 | **metadata** | **Object** |  | [optional] |
 | **password** | **String** |  | [optional] |
-| **test** | **Boolean** |  | [optional] |
+| **test** | **Boolean** | Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits. | [optional] |
 | **version** | **String** |  | [optional] |
 
 ## Example

data/docs/CreateSubmissionDataRequestEventResponse.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **status** | **String** |  |  |
 | **event** | [**SubmissionDataRequestEvent**](SubmissionDataRequestEvent.md) |  |  |
+| **error** | **String** |  | [optional] |
 | **errors** | **Array<String>** |  | [optional] |
 
 ## Example
@@ -16,6 +17,7 @@ require 'docspring'
 instance = DocSpring::CreateSubmissionDataRequestEventResponse.new(
   status: null,
   event: null,
+  error: null,
   errors: null
 )
 ```

data/docs/CreateSubmissionDataRequestResponse.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **status** | **String** |  |  |
 | **data_request** | [**SubmissionDataRequestShow**](SubmissionDataRequestShow.md) |  |  |
+| **error** | **String** |  | [optional] |
 | **errors** | **Array<String>** |  | [optional] |
 
 ## Example
@@ -16,6 +17,7 @@ require 'docspring'
 instance = DocSpring::CreateSubmissionDataRequestResponse.new(
   status: null,
   data_request: null,
+  error: null,
   errors: null
 )
 ```

data/docs/CreateSubmissionDataRequestTokenResponse.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **status** | **String** |  |  |
 | **token** | [**SubmissionDataRequestToken**](SubmissionDataRequestToken.md) |  |  |
+| **error** | **String** |  | [optional] |
 | **errors** | **Array<String>** |  | [optional] |
 
 ## Example
@@ -16,6 +17,7 @@ require 'docspring'
 instance = DocSpring::CreateSubmissionDataRequestTokenResponse.new(
   status: null,
   token: null,
+  error: null,
   errors: null
 )
 ```

data/docs/CreateSubmissionResponse.md

@@ -6,7 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **status** | **String** |  |  |
 | **submission** | [**SubmissionPreview**](SubmissionPreview.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::CreateSubmissionResponse.new(
   status: null,
   submission: null,
-  errors: null
+  error: null,
+  errors: null,
+  code: null
 )
 ```
 

data/docs/ForbiddenErrorResponse.md

@@ -0,0 +1,22 @@
+# DocSpring::ForbiddenErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **error** | **String** |  |  |
+| **code** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'docspring'
+
+instance = DocSpring::ForbiddenErrorResponse.new(
+  status: null,
+  error: null,
+  code: null
+)
+```
+

data/docs/SubmissionBatchData.md

@@ -8,7 +8,7 @@
 | **submissions** | **Array<Object>** |  |  |
 | **template_id** | **String** |  | [optional] |
 | **template_version** | **String** |  | [optional] |
-| **test** | **Boolean** |  | [optional] |
+| **test** | **Boolean** | Generate a watermarked test PDF. Test PDFs are free; live PDFs (the default) use credits. | [optional] |
 
 ## Example
 

data/docspring.gemspec

@@ -3,7 +3,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/api/client.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 
@@ -135,7 +135,7 @@ end
     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 
     # @param data [SubmissionBatchData] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :wait Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)
@@ -146,7 +146,7 @@ end
     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 
     # @param data [SubmissionBatchData] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :wait Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)
@@ -206,7 +206,7 @@ end
     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/). 
     # @param data [CombinePdfsData] 
     # @param [Hash] opts the optional parameters
     # @return [CreateCombinedSubmissionResponse]
@@ -216,7 +216,7 @@ end
     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/). 
     # @param data [CombinePdfsData] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateCombinedSubmissionResponse, Integer, Hash)>] CreateCombinedSubmissionResponse data, response status code and response headers
@@ -1231,7 +1231,7 @@ end
     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 
     # @param template_id [String] 
     # @param submission [CreatePdfSubmissionData] 
     # @param [Hash] opts the optional parameters
@@ -1243,7 +1243,7 @@ end
     end
 
     # Generate a PDF
-    # Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the &#x60;wait&#x3D;false&#x60; 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&#39;t fit in fields 
+    # Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Add the &#x60;wait&#x3D;false&#x60; query parameter to return immediately.  Live PDFs use credits; test PDFs (&#x60;test: true&#x60;) are free and watermarked. If your balance can&#39;t cover a live PDF, the API returns 402 and the submission waits in the &#x60;insufficient_credits&#x60; state until you add credits. See [Credits &amp; 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&#39;t fit in fields 
     # @param template_id [String] 
     # @param submission [CreatePdfSubmissionData] 
     # @param [Hash] opts the optional parameters
@@ -1371,7 +1371,7 @@ end
     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`. 
     # @param combined_submission_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [CombinedSubmission]
@@ -1381,7 +1381,7 @@ end
     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).  &#x60;insufficient_credits&#x60; means the combined submission is waiting for credits and is processed once you add them. If it&#39;s still waiting after 30 days, it moves to &#x60;error&#x60;. 
     # @param combined_submission_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CombinedSubmission, Integer, Hash)>] CombinedSubmission data, response status code and response headers
@@ -1617,7 +1617,7 @@ end
     end
 
     # 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`. 
     # @param submission_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_data 
@@ -1628,7 +1628,7 @@ end
     end
 
     # 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.  &#x60;insufficient_credits&#x60; means the submission is waiting for credits and is processed once you add them. If it&#39;s still waiting after 30 days, it moves to &#x60;error&#x60;. 
     # @param submission_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_data 
@@ -1683,7 +1683,7 @@ end
     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. 
     # @param submission_batch_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_submissions 
@@ -1694,7 +1694,7 @@ end
     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 &#x60;insufficient_credits&#x60; state and count as pending, so the batch stays &#x60;pending&#x60; until you add credits or they stop waiting after 30 days. 
     # @param submission_batch_id [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_submissions 

data/lib/docspring/api_client.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 
@@ -33,7 +33,7 @@ module DocSpring
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "docspring-ruby-3.4.0"
+      @user_agent = "docspring-ruby-3.5.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/docspring/api_error.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/configuration.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/add_fields_data.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 

data/lib/docspring/models/batch_generate_pdfs201_response.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 
@@ -25,6 +25,9 @@ module DocSpring
 
     attr_accessor :submissions
 
+    # `insufficient_credits` when the response is a 402.
+    attr_accessor :code
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -54,7 +57,8 @@ module DocSpring
         :'error' => :'error',
         :'errors' => :'errors',
         :'submission_batch' => :'submission_batch',
-        :'submissions' => :'submissions'
+        :'submissions' => :'submissions',
+        :'code' => :'code'
       }
     end
 
@@ -75,7 +79,8 @@ module DocSpring
         :'error' => :'String',
         :'errors' => :'Array<String>',
         :'submission_batch' => :'SubmissionBatch',
-        :'submissions' => :'Array<Object>'
+        :'submissions' => :'Array<Object>',
+        :'code' => :'String'
       }
     end
 
@@ -130,6 +135,10 @@ module DocSpring
       else
         self.submissions = nil
       end
+
+      if attributes.key?(:'code')
+        self.code = attributes[:'code']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -204,7 +213,8 @@ module DocSpring
           error == o.error &&
           errors == o.errors &&
           submission_batch == o.submission_batch &&
-          submissions == o.submissions
+          submissions == o.submissions &&
+          code == o.code
     end
 
     # @see the `==` method
@@ -216,7 +226,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, error, errors, submission_batch, submissions].hash
+      [status, error, errors, submission_batch, submissions, code].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/combine_pdfs_data.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 
@@ -26,7 +26,7 @@ module DocSpring
 
     attr_accessor :source_pdfs
 
-    # Deprecated, and has no effect. A combined PDF is a test or live document because of its source PDFs.
+    # Deprecated, and has no effect. Combining always uses credits, even with a test API token or watermarked source PDFs.
     attr_accessor :test
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docspring/models/combined_submission.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1
 
@@ -273,7 +273,7 @@ module DocSpring
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "error"])
+      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "error", "insufficient_credits"])
       return false unless state_validator.valid?(@state)
       return false if @expired.nil?
       return false if @submission_ids.nil?
@@ -286,7 +286,7 @@ module DocSpring
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ["pending", "processed", "error"])
+      validator = EnumAttributeValidator.new('String', ["pending", "processed", "error", "insufficient_credits"])
       # build_from_hash accepts enum values this client doesn't know about yet
       unless defined?(@_skip_enum_validation) || validator.valid?(state)
         fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."

data/lib/docspring/models/combined_submission_action.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
 
 The version of the OpenAPI document: v1