docspring 3.5.0 → 4.0.0

data/spec/api/client_spec.rb

@@ -1,12 +1,12 @@
 =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. 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/).
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: v2
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.16.0-DOCSPRING
+Generator version: 7.26.0-DOCSPRING
 
 =end
 
@@ -32,142 +32,118 @@ describe 'Client' do
     end
   end
 
-  # unit tests for add_fields_to_template
-  # Add new fields to a Template
-  # Adds fields to a PDF template. Configure field types, positions, defaults, and formatting options. 
-  # @param template_id 
-  # @param data 
-  # @param [Hash] opts the optional parameters
-  # @return [TemplateAddFieldsResponse]
-  describe 'add_fields_to_template test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for batch_generate_pdfs
-  # 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.  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 
-  # @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)
-  # @return [BatchGeneratePdfs201Response]
-  describe 'batch_generate_pdfs test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for combine_pdfs
-  # 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.  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 
+  # unit tests for copy_template
+  # Copy a template
+  # Copies a template (its draft, or a published version) into a new template.
+  # @param template_id The template's ID.
   # @param [Hash] opts the optional parameters
-  # @return [CreateCombinedSubmissionResponse]
-  describe 'combine_pdfs test' do
+  # @option opts [CopyTemplateRequest] :body Settings for the copy.
+  # @return [Template]
+  describe 'copy_template test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for copy_template
-  # Copy a template
-  # Creates a copy of an existing template with all its fields and configuration. Optionally specify a new name and target folder. The copied template starts as a new draft that can be modified independently of the original. 
-  # @param template_id 
+  # unit tests for create_combined_pdf
+  # Combine PDFs
+  # Merges PDFs into one: submissions, other combined PDFs, templates, custom files (POST /custom_files) and PDFs from URLs, in the order of `source_pdfs`. The PDF is generated in the background: on sync.api hosts the request waits for it (unless you pass `wait=false`), otherwise poll GET /combined_pdfs/{combined_pdf_id} until `state` isn't `pending`.  A template source merges the template's processed PDF by default: the PDF submissions are filled in on, decrypted and with its form fields removed. Pass `processed: false` to merge the PDF as it was uploaded. 
+  # @param body The PDFs to merge, and the combined PDF's settings.
   # @param [Hash] opts the optional parameters
-  # @option opts [CopyTemplateOptions] :options 
-  # @return [TemplatePreview]
-  describe 'copy_template test' do
+  # @option opts [Boolean] :wait Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+  # @return [CombinedPdf]
+  describe 'create_combined_pdf test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for create_custom_file_from_upload
-  # Create a new custom file from a cached S3 upload
-  # The Custom Files API endpoint allows you to upload PDFs to DocSpring and then merge them with other PDFs. First upload your file using the presigned URL endpoint, then use the returned cache_id to create the custom file. 
-  # @param data 
+  # Create a custom file from an upload
+  # Creates a custom file from a PDF you uploaded, so you can merge it with other PDFs. Upload the file with the presigned upload (GET /uploads/presign) first, then pass its `fields.key` as `cache_id`. 
+  # @param body The uploaded file to create the custom file from.
   # @param [Hash] opts the optional parameters
-  # @return [CreateCustomFileResponse]
+  # @return [CustomFile]
   describe 'create_custom_file_from_upload test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for create_data_request_event
-  # Create a new event for emailing a signee a request for signature
-  # Records user notification events for data requests. Use this to create an audit trail showing when and how users were notified about data request forms. Supports email, SMS, and other notification types. Records the notification time for compliance tracking.  See also: - [Embedded Data Requests Guide](https://docspring.com/docs/guides/embedded-forms/embedded-data-requests/) - User notification workflow 
-  # @param data_request_id 
-  # @param event 
+  # unit tests for create_folder
+  # Create a folder
+  # Creates a folder for organizing templates. Pass `parent_folder_id` to create it inside another folder. Folder names are unique within their parent folder. 
+  # @param body The folder to create.
   # @param [Hash] opts the optional parameters
-  # @return [CreateSubmissionDataRequestEventResponse]
-  describe 'create_data_request_event test' do
+  # @return [Folder]
+  describe 'create_folder test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for create_data_request_token
-  # Create a new data request token for form authentication
-  # Creates an authentication token for accessing a data request form. Returns a token and a pre-authenticated URL for the data request form. The token remains valid until the data request is completed.  See also: - [Embedded Data Requests Guide](https://docspring.com/docs/guides/embedded-forms/embedded-data-requests/) 
-  # @param data_request_id 
+  # unit tests for create_signature_request_event
+  # Record a signature request event
+  # Records something that happened outside DocSpring in the signature request's audit trail: you sent the request to the person (`send_request`). The audit trail shows it as reported by your account. 
+  # @param signature_request_id The signature request's ID.
+  # @param body The event to record.
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :type 
-  # @return [CreateSubmissionDataRequestTokenResponse]
-  describe 'create_data_request_token test' do
+  # @return [SignatureRequestEvent]
+  describe 'create_signature_request_event test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for create_folder
-  # Create a folder
-  # Creates a new folder for organizing templates. Folders can be nested within other folders by providing a `parent_folder_id`. Folder names must be unique within the same parent. 
-  # @param data 
+  # unit tests for create_signature_request_token
+  # Create a signature request token
+  # Creates a token that opens the signature request without signing in, in a form embedded in your app or from a link you send. The response is the only time the token's secret is returned. The link works for 24 hours, or 7 days for an `email` token, and a signing page that opened in time keeps working for 7 more days. A test API token can't create a token for a live signature request. 
+  # @param signature_request_id The signature request's ID.
   # @param [Hash] opts the optional parameters
-  # @return [Folder]
-  describe 'create_folder test' do
+  # @option opts [CreateSignatureRequestTokenRequest] :body The kind of link to make. Send no body for an `api` token.
+  # @return [SignatureRequestToken]
+  describe 'create_signature_request_token test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for create_html_template
-  # Create a new HTML template
-  # Creates a new HTML template using HTML, CSS/SCSS, and Liquid templating. Allows complete control over PDF layout and styling. Supports headers, footers, and dynamic content using Liquid syntax for field values, conditions, loops, and filters. 
-  # @param data 
+  # unit tests for create_submission
+  # Generate a PDF
+  # Creates a submission: fills in a template with your data and generates a PDF. The PDF is generated in the background: on sync.api hosts the request waits for it (unless you pass `wait=false`), otherwise poll GET /submissions/{submission_id} until `state` isn't `pending`.  Data that doesn't match the template's fields returns a 422 with an `invalid_data` error. The submission is still saved, with its errors, so you can find it in DocSpring: the error's `submission_id` is its ID. 
+  # @param template_id The template's ID.
+  # @param body The submission's data and settings.
   # @param [Hash] opts the optional parameters
-  # @return [TemplatePreview]
-  describe 'create_html_template test' do
+  # @option opts [String] :version The template version to use: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published).
+  # @option opts [Boolean] :wait Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+  # @return [Submission]
+  describe 'create_submission test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for create_pdf_template
-  # Create a new PDF template with a form POST file upload
-  # Creates a new PDF template by uploading a PDF file. The uploaded PDF becomes the foundation for your template, and you can then add fillable fields using the template editor. Use the wait parameter to control whether the request waits for document processing to complete. 
-  # @param template_document 
-  # @param template_name 
+  # unit tests for create_submission_batch
+  # Generate PDFs in a batch
+  # Creates up to 50 submissions in one request, from one template or several. The PDFs are only generated when every submission is valid. On sync.api hosts the request waits until every PDF has been generated (unless you pass `wait=false`), otherwise poll GET /submissions/batches/{submission_batch_id} until `processed_at` is set.  When any submission is invalid, nothing is generated and the request returns a 422. Submissions whose data doesn't match their template's fields are still saved with their errors (an `invalid_data` error, with each one's `submission_id` in its details), so you can find them in DocSpring. The other submissions aren't saved. 
+  # @param body The submissions to create, and the settings they share.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :wait Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
-  # @option opts [String] :template_description 
-  # @option opts [String] :template_parent_folder_id 
-  # @return [TemplatePreview]
-  describe 'create_pdf_template test' do
+  # @option opts [Boolean] :wait Wait until every PDF in the batch has been generated before responding. Default true on sync.api hosts.
+  # @return [SubmissionBatch]
+  describe 'create_submission_batch test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for create_pdf_template_from_upload
-  # Create a new PDF template from a cached S3 file upload
-  # Creates a new PDF template from a file previously uploaded to S3 using a presigned URL. This two-step process allows for more reliable large file uploads by first uploading the file to S3, then creating the template using the cached upload ID. 
-  # @param data 
+  # unit tests for create_template
+  # Create a template
+  # Creates an HTML template, or a PDF template from a PDF you uploaded with the presigned upload (GET /uploads/presign): pass its `fields.key` as `cache_id`. To send the PDF with the request instead, use POST /templates/upload.  A PDF template is ready to generate PDFs once DocSpring has processed its PDF (`ready` is true). On sync.api hosts the request waits for that unless you pass `wait=false`. 
+  # @param body The template to create.
   # @param [Hash] opts the optional parameters
-  # @return [TemplatePreview]
-  describe 'create_pdf_template_from_upload test' do
+  # @option opts [Boolean] :wait Wait until the PDF has been processed before responding. Default true on sync.api hosts.
+  # @return [Template]
+  describe 'create_template test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
@@ -175,8 +151,8 @@ describe 'Client' do
 
   # unit tests for create_webhook
   # Create a webhook
-  # Creates a webhook that delivers a POST request to your endpoint whenever a subscribed event occurs. Optionally scope the webhook to specific API tokens, templates, or folders. 
-  # @param data 
+  # Creates a webhook that sends a POST request to your endpoint whenever a subscribed event happens. Scope it to API tokens, templates or folders to receive only their events. 
+  # @param body The webhook to create.
   # @param [Hash] opts the optional parameters
   # @return [Webhook]
   describe 'create_webhook test' do
@@ -185,10 +161,22 @@ describe 'Client' do
     end
   end
 
+  # unit tests for delete_custom_file
+  # Delete a custom file
+  # Deletes a custom file and returns it. Use a live API token: test tokens can't delete custom files. 
+  # @param custom_file_id The custom file's ID.
+  # @param [Hash] opts the optional parameters
+  # @return [CustomFile]
+  describe 'delete_custom_file test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for delete_folder
   # Delete a folder
-  # Deletes an empty folder. The folder must not contain any templates or subfolders. Move or delete all contents before attempting to delete the folder. 
-  # @param folder_id 
+  # Deletes an empty folder and returns it. A folder that still has templates or folders in it can't be deleted. 
+  # @param folder_id The folder's ID.
   # @param [Hash] opts the optional parameters
   # @return [Folder]
   describe 'delete_folder test' do
@@ -199,11 +187,11 @@ describe 'Client' do
 
   # unit tests for delete_template
   # Delete a template
-  # Deletes a template or a specific template version. When no version is specified, deletes the entire template including all versions. When a version is specified, deletes only that version while preserving others. Returns remaining version information. 
-  # @param template_id 
+  # Deletes a template's draft and all of its published versions, or one published version (`version`). Returns the template as it was before it was deleted. 
+  # @param template_id The template's ID.
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :version 
-  # @return [TemplateDeleteResponse]
+  # @option opts [String] :version Delete only this published version (`1.2.0`) or the draft (`draft`, when no version has been published). Without it, the draft and every published version are deleted.
+  # @return [Template]
   describe 'delete_template test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -212,8 +200,8 @@ describe 'Client' do
 
   # unit tests for delete_webhook
   # Delete a webhook
-  # Permanently deletes a webhook so it stops receiving events, and returns the deleted webhook.
-  # @param webhook_id 
+  # Deletes a webhook so it stops receiving events, and returns it.
+  # @param webhook_id The webhook's ID.
   # @param [Hash] opts the optional parameters
   # @return [Webhook]
   describe 'delete_webhook test' do
@@ -222,109 +210,106 @@ describe 'Client' do
     end
   end
 
-  # unit tests for expire_combined_submission
-  # Expire a combined submission
-  # Expiring a combined submission deletes the PDF from our system. This is useful for invalidating sensitive documents. 
-  # @param combined_submission_id 
+  # unit tests for expire_combined_pdf
+  # Expire a combined PDF
+  # Deletes a combined PDF's PDF and returns the expired combined PDF.
+  # @param combined_pdf_id The combined PDF's ID.
   # @param [Hash] opts the optional parameters
-  # @return [CombinedSubmission]
-  describe 'expire_combined_submission test' do
+  # @return [CombinedPdf]
+  describe 'expire_combined_pdf test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for expire_submission
-  # Expire a PDF submission
-  # Expiring a PDF submission deletes the PDF and removes the data from our database. This is useful for invalidating sensitive documents after they've been downloaded. You can also [configure a data retention policy for your submissions](https://docspring.com/docs/template-editor/settings/#expire-submissions) so that they automatically expire. 
-  # @param submission_id 
+  # Expire a submission
+  # Deletes a submission's data and PDF now, and returns the expired submission.
+  # @param submission_id The submission's ID.
   # @param [Hash] opts the optional parameters
-  # @return [SubmissionPreview]
+  # @return [Submission]
   describe 'expire_submission test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for generate_pdf
-  # 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.  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 
-  # @param submission 
+  # unit tests for generate_submission_preview
+  # Generate a preview PDF
+  # Generates a preview of a submission's PDF in the background, such as for a submission still waiting for its signature requests. It's in `files.preview` once `preview_generated_at` changes. 
+  # @param submission_id The submission's ID.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :wait Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain)
-  # @return [CreateSubmissionResponse]
-  describe 'generate_pdf test' do
+  # @return [Submission]
+  describe 'generate_submission_preview test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for generate_preview
-  # Generate a preview PDF for partially completed data requests
-  # Generates a preview PDF for a submission with partially completed data requests. Useful for showing users what the final document will look like before all signatures or data have been collected. The preview includes any data collected so far. 
-  # @param submission_id 
+  # unit tests for get_combined_pdf
+  # Get a combined PDF
+  # Returns a combined PDF, with a temporary link to download it once it has been generated.
+  # @param combined_pdf_id The combined PDF's ID.
   # @param [Hash] opts the optional parameters
-  # @return [SuccessErrorResponse]
-  describe 'generate_preview test' do
+  # @return [CombinedPdf]
+  describe 'get_combined_pdf test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for get_combined_submission
-  # 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).  `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 
+  # unit tests for get_custom_file
+  # Get a custom file
+  # Returns a custom file, with a temporary URL to download it.
+  # @param custom_file_id The custom file's ID.
   # @param [Hash] opts the optional parameters
-  # @return [CombinedSubmission]
-  describe 'get_combined_submission test' do
+  # @return [CustomFile]
+  describe 'get_custom_file test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for get_data_request
-  # Look up a submission data request
-  # Retrieves the details and status of a data request. Returns information about the request state (pending, viewed, completed), authentication details, and metadata. Includes audit information like IP address, browseruser agent, and timestamps.  See also: - [Embedded Data Requests Guide](https://docspring.com/docs/guides/embedded-forms/embedded-data-requests/) - Complete guide to data request workflow 
-  # @param data_request_id 
+  # unit tests for get_folder
+  # Get a folder
+  # Returns a folder.
+  # @param folder_id The folder's ID.
   # @param [Hash] opts the optional parameters
-  # @return [SubmissionDataRequestShow]
-  describe 'get_data_request test' do
+  # @return [Folder]
+  describe 'get_folder test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for get_full_template
-  # Fetch the full attributes for a PDF template
-  # Retrieves complete template information including fields, defaults, settings, and HTML/SCSS content. Use this to get all template data needed for automated updates or analysis. Returns more detailed information than the basic `getTemplate` endpoint. 
-  # @param template_id 
+  # unit tests for get_presign_url
+  # Get a presigned URL to upload a file
+  # Returns a presigned S3 form for uploading a file directly to DocSpring, for files too large to send in a request body. POST the `fields` and the file (as `file`) to `url` as multipart/form-data, then pass `fields.key` as the `cache_id` when you create a custom file. 
   # @param [Hash] opts the optional parameters
-  # @return [Template]
-  describe 'get_full_template test' do
+  # @return [UploadPresign]
+  describe 'get_presign_url test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for get_presign_url
-  # Get a presigned S3 URL for direct file upload
-  # Returns a presigned S3 URL for uploading files directly to our S3 bucket. Use this endpoint to upload large files before creating templates or custom files. S3 will respond with a JSON object that you can include in your DocSpring API request.  Uploaded files can be used to: - [Create templates](https://docspring.com/docs/api/#tag/templates/post/templates?endpoint_variant=create_template_from_cached_upload) - [Update templates](https://docspring.com/docs/api/#tag/templates/put/templates/{template_id}?endpoint_variant=update_template_pdf_with_cached_upload) - [Create custom files](https://docspring.com/docs/api/#tag/custom-files/post/custom_files) and then [merge them with other PDFs](https://docspring.com/docs/api/#tag/combine-pdfs/post/combined_submissions) 
+  # unit tests for get_signature_request
+  # Get a signature request
+  # Returns a signature request, with the values the person has entered so far.
+  # @param signature_request_id The signature request's ID.
   # @param [Hash] opts the optional parameters
-  # @return [UploadPresignResponse]
-  describe 'get_presign_url test' do
+  # @return [SignatureRequest]
+  describe 'get_signature_request test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for get_submission
-  # 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.  `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 
+  # Get a submission
+  # Returns a submission, with its data and links to download its PDF.
+  # @param submission_id The submission's ID.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :include_data 
   # @return [Submission]
   describe 'get_submission test' do
     it 'should work' do
@@ -333,12 +318,12 @@ describe 'Client' do
   end
 
   # unit tests for get_submission_batch
-  # 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.  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 
+  # Get a batch
+  # Returns a batch with its submissions. The batch has finished once `processed_at` is set: its `state` is `processed` when every PDF was generated, or `error` when any submission failed. 
+  # @param submission_batch_id The batch's ID.
   # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :include_submissions 
-  # @return [SubmissionBatchWithSubmissions]
+  # @option opts [Boolean] :include_data Include each submission's `data` (null without it).
+  # @return [SubmissionBatch]
   describe 'get_submission_batch test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -346,11 +331,12 @@ describe 'Client' do
   end
 
   # unit tests for get_template
-  # Check the status of an uploaded template
-  # Retrieves information about a template including processing status and document URL. Use this to check if template is ready to view in the template editor or generate PDFs. 
-  # @param template_id 
+  # Get a template
+  # Returns a template: its draft, or one of its published versions.
+  # @param template_id The template's ID.
   # @param [Hash] opts the optional parameters
-  # @return [TemplatePreview]
+  # @option opts [String] :version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+  # @return [Template]
   describe 'get_template test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -358,12 +344,13 @@ describe 'Client' do
   end
 
   # unit tests for get_template_model_code
-  # Generate typed model code for a template
-  # Generates typed model code for a template's submission data from its JSON schema, in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go. Build your submission data with the generated types so your app catches mistakes before it calls the API.  `root_type_name` is the type that describes the whole submission data object, qualified with its namespace or package where there is one. Java returns every class in `code`, each under a `// ClassName.java` comment: split them into one file per class.  A template with no named fields returns 422, since there are no types to generate.  See also: - [Generate Model Code](https://docspring.com/docs/template-editor/generate-model-code/) - Use the generated types 
-  # @param template_id 
-  # @param lang The language to generate code for
+  # Generate typed code for a template's submission data
+  # Generates types for a template's submission data in TypeScript, JavaScript, Ruby, Python, PHP, Java, C#, Elixir or Go, so your app catches mistakes before it calls the API. `root_type_name` is the type of the whole `data` object. Java returns every class in `code`, each under a `// ClassName.java` comment. A template with no named fields returns 422. 
+  # @param template_id The template's ID.
+  # @param lang The language to generate the code in.
   # @param [Hash] opts the optional parameters
-  # @return [TemplateModelCodeResponse]
+  # @option opts [String] :version The template version: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published), the version a submission uses by default.
+  # @return [TemplateModelCode]
   describe 'get_template_model_code test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -371,11 +358,12 @@ describe 'Client' do
   end
 
   # unit tests for get_template_schema
-  # Fetch the JSON schema for a template
-  # Retrieves the JSON Schema definition for a template's fields. Use this to validate data before submitting it for PDF generation, or to build dynamic forms that match the template's field structure and validation requirements.  See also: - [Generate PDFs Guide](https://docspring.com/docs/api-guide/generate-pdfs/generate-pdfs-via-api/) - Use schema to validate submission data 
-  # @param template_id 
+  # Get the JSON Schema of a template's submission data
+  # Returns the JSON Schema that a submission's `data` must match. Use it to check data before you create submissions, or to build a form for the template's fields. 
+  # @param template_id The template's ID.
   # @param [Hash] opts the optional parameters
-  # @return [JsonSchema]
+  # @option opts [String] :version The template version: a published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `latest` (the draft when no version has been published), the version a submission uses by default.
+  # @return [Hash<String, Object>]
   describe 'get_template_schema test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -384,8 +372,8 @@ describe 'Client' do
 
   # unit tests for get_webhook
   # Get a webhook
-  # Retrieves a single webhook by its ID.
-  # @param webhook_id 
+  # Returns a webhook.
+  # @param webhook_id The webhook's ID.
   # @param [Hash] opts the optional parameters
   # @return [Webhook]
   describe 'get_webhook test' do
@@ -394,25 +382,40 @@ describe 'Client' do
     end
   end
 
-  # unit tests for list_combined_submissions
-  # Get a list of all combined submissions
-  # Returns a paginated list of combined submissions (merged PDFs) for your account. Includes processing status, expiration details, and download URLs for processed PDFs. 
+  # unit tests for list_combined_pdfs
+  # List combined PDFs
+  # Returns the combined PDFs in your account, newest first, one page at a time.
   # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Default: 1
-  # @option opts [Integer] :per_page Default: 50
-  # @return [Array<CombinedSubmission>]
-  describe 'list_combined_submissions test' do
+  # @option opts [Integer] :limit How many items to return (1-100, default 50).
+  # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @return [CombinedPdfList]
+  describe 'list_combined_pdfs test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_custom_files
+  # List custom files
+  # Returns the custom files in your account, newest first, one page at a time.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit How many items to return (1-100, default 50).
+  # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @return [CustomFileList]
+  describe 'list_custom_files test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for list_folders
-  # Get a list of all folders
-  # Returns a list of folders in your account. Can be filtered by parent folder ID to retrieve subfolders. Folders help organize templates and maintain a hierarchical structure. 
+  # List folders
+  # Returns the folders in your account, newest first, one page at a time. Pass `parent_folder_id` to list the folders in one folder. 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :parent_folder_id Filter By Folder Id
-  # @return [Array<Folder>]
+  # @option opts [String] :parent_folder_id Only list the folders in this folder. Without it, the list has every folder, at any depth.
+  # @option opts [Integer] :limit How many items to return (1-100, default 50).
+  # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @return [FolderList]
   describe 'list_folders test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -420,16 +423,17 @@ describe 'Client' do
   end
 
   # unit tests for list_submissions
-  # List all submissions
-  # Returns a paginated list of all PDF submissions across all templates in your account. Can be filtered by date range and submission type (test/live). Supports cursor-based pagination and optionally includes submission data for each result. 
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :cursor 
-  # @option opts [Integer] :limit 
-  # @option opts [String] :created_after 
-  # @option opts [String] :created_before 
-  # @option opts [String] :type 
-  # @option opts [Boolean] :include_data 
-  # @return [ListSubmissionsResponse]
+  # List submissions
+  # Returns the submissions in your account, newest first, one page at a time. Lists leave out each submission's `data` unless you pass `include_data=true`. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :template_id Only list this template's submissions.
+  # @option opts [Boolean] :test Only list test submissions (true) or live submissions (false).
+  # @option opts [Time] :created_after Only list submissions created after this time (RFC 3339, such as `2025-01-31T09:00:00Z`).
+  # @option opts [Time] :created_before Only list submissions created before this time.
+  # @option opts [Boolean] :include_data Include each submission's `data` (null without it).
+  # @option opts [Integer] :limit How many items to return (1-100, default 50).
+  # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @return [SubmissionList]
   describe 'list_submissions test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -437,17 +441,17 @@ describe 'Client' do
   end
 
   # unit tests for list_template_submissions
-  # List all submissions for a given template
-  # Returns a paginated list of all submissions for a specific template. Can be filtered by date range, submission type (test/live), and optionally include submission data. Supports cursor-based pagination for efficient retrieval of large result sets. 
-  # @param template_id 
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :cursor 
-  # @option opts [Integer] :limit 
-  # @option opts [String] :created_after 
-  # @option opts [String] :created_before 
-  # @option opts [String] :type 
-  # @option opts [Boolean] :include_data 
-  # @return [ListSubmissionsResponse]
+  # List a template's submissions
+  # Returns a template's submissions (from every version of the template), newest first.
+  # @param template_id The template's ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :test Only list test submissions (true) or live submissions (false).
+  # @option opts [Time] :created_after Only list submissions created after this time (RFC 3339, such as `2025-01-31T09:00:00Z`).
+  # @option opts [Time] :created_before Only list submissions created before this time.
+  # @option opts [Boolean] :include_data Include each submission's `data` (null without it).
+  # @option opts [Integer] :limit How many items to return (1-100, default 50).
+  # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @return [SubmissionList]
   describe 'list_template_submissions test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -455,14 +459,14 @@ describe 'Client' do
   end
 
   # unit tests for list_templates
-  # Get a list of all templates
-  # Retrieves a list of your templates with search, filtering, and pagination options. Returns basic template information including ID, name, type (PDF or HTML), and folder location. Supports text search by name and filtering by parent folder. 
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :query Search By Name
-  # @option opts [String] :parent_folder_id Filter By Folder Id
-  # @option opts [Integer] :page Default: 1
-  # @option opts [Integer] :per_page Default: 50
-  # @return [Array<TemplatePreview>]
+  # List templates
+  # Returns the templates in your account (their drafts), newest first, one page at a time. Get a template by its ID for its HTML, defaults and published versions. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :query Only list templates whose name contains this text (ignoring case).
+  # @option opts [String] :parent_folder_id Only list the templates in this folder (not in its subfolders).
+  # @option opts [Integer] :limit How many items to return (1-100, default 50).
+  # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @return [TemplateSummaryList]
   describe 'list_templates test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -470,44 +474,44 @@ describe 'Client' do
   end
 
   # unit tests for list_webhooks
-  # Get a list of all webhooks
-  # Returns a list of the webhooks configured for your account. Supports pagination and filtering by event type, mode, and the API token, template, or folder a webhook is scoped to. 
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Default: 1
-  # @option opts [Integer] :per_page Default: 50
-  # @option opts [String] :event_type Filter by a subscribed event type
-  # @option opts [String] :mode Filter by mode (test or live)
-  # @option opts [String] :template_id Filter by a scoped template ID
-  # @option opts [String] :folder_id Filter by a scoped folder ID
-  # @option opts [String] :api_token_id Filter by a scoped API token ID
-  # @return [Array<Webhook>]
+  # List webhooks
+  # Returns the webhooks in your account, newest first, one page at a time. Filter them by event type, mode, or the API token, template or folder they're scoped to. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [WebhookEventType] :event_type Only list webhooks that subscribe to this event.
+  # @option opts [WebhookMode] :mode Only list webhooks set to this mode.
+  # @option opts [String] :template_id Only list webhooks scoped to this template.
+  # @option opts [String] :folder_id Only list webhooks scoped to this folder.
+  # @option opts [String] :api_token_id Only list webhooks scoped to this API token.
+  # @option opts [Integer] :limit How many items to return (1-100, default 50).
+  # @option opts [String] :cursor The previous page's `next_cursor`, to get the next page. It's the ID of that page's last item, so get the next page before you delete or change the items on this one.
+  # @return [WebhookList]
   describe 'list_webhooks test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for move_folder_to_folder
+  # unit tests for move_folder
   # Move a folder
-  # Moves a folder to a new parent folder or to the root level. All templates and subfolders within the folder are moved together. Cannot move a folder into one of its own subfolders. 
-  # @param folder_id 
-  # @param data 
+  # Moves a folder into another folder, or to the root with `parent_folder_id: null`. Its templates and folders move with it. A folder can't move into itself or one of its own folders. 
+  # @param folder_id The folder's ID.
+  # @param body Where to move the folder.
   # @param [Hash] opts the optional parameters
   # @return [Folder]
-  describe 'move_folder_to_folder test' do
+  describe 'move_folder test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for move_template_to_folder
-  # Move Template to folder
-  # Moves a template to a different folder or to the root level. Use this to organize templates within your folders. Provide a folder ID to move to a specific folder, or &#x60;null&#x60; to move to the root level. 
-  # @param template_id 
-  # @param data 
+  # unit tests for move_template
+  # Move a template to a folder
+  # Moves a template and all of its published versions to a folder, or to the root (`null`).
+  # @param template_id The template's ID.
+  # @param body Where to move the template.
   # @param [Hash] opts the optional parameters
-  # @return [TemplatePreview]
-  describe 'move_template_to_folder test' do
+  # @return [Template]
+  describe 'move_template test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
@@ -515,11 +519,11 @@ describe 'Client' do
 
   # unit tests for publish_template_version
   # Publish a template version
-  # Publishes the current draft version of a template and creates a new immutable version with semantic versioning (major.minor.patch). 
-  # @param template_id 
-  # @param data 
+  # Publishes the template's draft as a new version that doesn't change. `version_type` says which part of the latest version number goes up. 
+  # @param template_id The template's ID.
+  # @param body The version to publish.
   # @param [Hash] opts the optional parameters
-  # @return [TemplatePublishVersionResponse]
+  # @return [TemplateVersion]
   describe 'publish_template_version test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -528,9 +532,9 @@ describe 'Client' do
 
   # unit tests for rename_folder
   # Rename a folder
-  # Renames an existing folder. The new name must be unique within the same parent folder. This operation only changes the folder name, not its location or contents. 
-  # @param folder_id 
-  # @param data 
+  # Renames a folder. The name must be unique within its parent folder. 
+  # @param folder_id The folder's ID.
+  # @param body The folder's new name.
   # @param [Hash] opts the optional parameters
   # @return [Folder]
   describe 'rename_folder test' do
@@ -541,11 +545,11 @@ describe 'Client' do
 
   # unit tests for restore_template_version
   # Restore a template version
-  # Restores your template to a previously published version, copying that version&#39;s content and configuration to the current draft. Use this to revert changes or recover from an unwanted modification. 
-  # @param template_id 
-  # @param data 
+  # Replaces the template's draft with a copy of one of its published versions.
+  # @param template_id The template's ID.
+  # @param body The version to restore.
   # @param [Hash] opts the optional parameters
-  # @return [SuccessErrorResponse]
+  # @return [Template]
   describe 'restore_template_version test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -554,35 +558,35 @@ describe 'Client' do
 
   # unit tests for test_authentication
   # Test authentication
-  # Checks whether your API token is valid by making an authenticated request. Returns a success response if authentication passes. This endpoint is useful for verifying credentials during setup or troubleshooting issues. 
+  # Checks whether your API token is valid by making an authenticated request. This endpoint is useful for verifying credentials during setup or troubleshooting issues. 
   # @param [Hash] opts the optional parameters
-  # @return [SuccessErrorResponse]
+  # @return [AuthenticationCheck]
   describe 'test_authentication test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for update_data_request
-  # Update a submission data request
-  # Updates authentication details for a data request. Use this when a user logs in to record their authentication method, provider, session information, and hashed identifiers. Updates metadata and tracks authentication state changes for auditing and compliance. 
-  # @param data_request_id 
-  # @param data 
+  # unit tests for update_signature_request
+  # Update a signature request
+  # Changes a pending signature request's metadata, or how your app authenticated the person (for the audit trail). Once the person has opened it, only its metadata can be changed, and a completed or declined signature request can't be changed. 
+  # @param signature_request_id The signature request's ID.
+  # @param body The settings to change. Properties left out keep their values.
   # @param [Hash] opts the optional parameters
-  # @return [CreateSubmissionDataRequestResponse]
-  describe 'update_data_request test' do
+  # @return [SignatureRequest]
+  describe 'update_signature_request test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   # unit tests for update_template
-  # Update a Template
-  # Updates template content and properties. For HTML templates, you can modify the HTML, SCSS, headers, footers, name, and description. Changes are applied to your draft template and do not affect published template versions. The exception is &#x60;parent_folder_id&#x60;: moving the template to another folder moves its published versions too. 
-  # @param template_id 
-  # @param data 
+  # Update a template
+  # Changes a template's draft. Properties left out keep their values. `defaults` and `html_engine_options` replace the whole object. Setting `parent_folder_id` moves the template and all of its published versions. 
+  # @param template_id The template's ID.
+  # @param body The settings to change. Properties left out keep their values.
   # @param [Hash] opts the optional parameters
-  # @return [SuccessMultipleErrorsResponse]
+  # @return [Template]
   describe 'update_template test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -590,40 +594,63 @@ describe 'Client' do
   end
 
   # unit tests for update_template_document
-  # Update a template&#39;s document with a form POST file upload
-  # Upload a new PDF file to update a PDF template&#39;s document. This replaces the template&#39;s PDF while preserving all of the existing fields. If you upload a PDF with fewer pages than the current document, any fields on the removed pages will be deleted. 
-  # @param template_id 
-  # @param template_document 
+  # Replace a template's PDF
+  # Replaces a PDF template's PDF with one you uploaded with the presigned upload (GET /uploads/presign). The fields stay where they are, unless `reimport_fields` replaces them with the new PDF's fillable fields. To send the PDF with the request instead, use PUT /templates/{template_id}/document/upload. 
+  # @param template_id The template's ID.
+  # @param body The new PDF.
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :template_name 
-  # @return [SuccessMultipleErrorsResponse]
+  # @option opts [Boolean] :wait Wait until the PDF has been processed before responding. Default true on sync.api hosts.
+  # @return [Template]
   describe 'update_template_document test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for update_template_document_from_upload
-  # Update a template&#39;s document with a cached S3 file upload
-  # Updates a PDF template&#39;s document using a cached file upload. This is a three-step process: First, request a presigned URL to upload your PDF file to our S3 bucket. Then, use that URL to upload your PDF file. Finally, submit the ID of the uploaded file to replace the template&#39;s document. 
-  # @param template_id 
-  # @param data 
+  # unit tests for update_webhook
+  # Update a webhook
+  # Updates a webhook. Only the properties you send change.
+  # @param webhook_id The webhook's ID.
+  # @param body The settings to change. Properties left out keep their values.
   # @param [Hash] opts the optional parameters
-  # @return [SuccessMultipleErrorsResponse]
-  describe 'update_template_document_from_upload test' do
+  # @return [Webhook]
+  describe 'update_webhook test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
-  # unit tests for update_webhook
-  # Update a webhook
-  # Updates the configuration of an existing webhook.
-  # @param webhook_id 
-  # @param data 
+  # unit tests for upload_template
+  # Create a PDF template from an uploaded PDF
+  # Creates a PDF template from a PDF sent with the request (`multipart/form-data`). For large files, upload the PDF with the presigned upload (GET /uploads/presign) and create the template with POST /templates. 
+  # @param document The PDF.
   # @param [Hash] opts the optional parameters
-  # @return [Webhook]
-  describe 'update_webhook test' do
+  # @option opts [Boolean] :wait Wait until the PDF has been processed before responding. Default true on sync.api hosts.
+  # @option opts [String] :name The template's name.
+  # @option opts [String] :description The template's description.
+  # @option opts [String] :parent_folder_id The folder to put the template in. Left out, it's created at the root.
+  # @option opts [AiFieldNamingLanguage] :ai_field_naming_language The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. Default: your account's template settings.
+  # @option opts [Boolean] :detect_fields Set up the PDF's fields as DocSpring's "Automatically detect fields" upload option does: import or detect the fields, name them with AI, and set up conditional logic. `field_source`, `field_naming` and `field_logic` choose how. Default false. `document.page_processing_statuses` and `document.field_logic_status` show how it's going, and `document.state` becomes `processed` once every page's fields are set up.
+  # @option opts [FieldSetupSource] :field_source With `detect_fields`, where the fields come from. `auto` (the default) imports the form fields of a fillable PDF and detects the fields of a PDF without them; `pdf_detection` detects the fields from the page layout, even on a fillable PDF; `pdf_form_fields` only imports the PDF's form fields.
+  # @option opts [FieldSetupNaming] :field_naming With `detect_fields`, how the fields are named. `ai` (the default) names them and sets their types and settings with AI; `preserve` keeps the names of the PDF's form fields, and AI only names the fields it detected. `preserve` needs `field_source` `auto` or `pdf_form_fields`.
+  # @option opts [FieldSetupLogic] :field_logic With `detect_fields`, whether AI reads the whole form once the fields are named and sets up conditional logic and required fields (`ai`) or not (`none`). Default: your account's template settings.
+  # @return [Template]
+  describe 'upload_template test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for upload_template_document
+  # Replace a template's PDF with an uploaded PDF
+  # Replaces a PDF template's PDF with one sent with the request (`multipart/form-data`). The fields stay where they are, unless `reimport_fields` replaces them with the new PDF's fillable fields. 
+  # @param template_id The template's ID.
+  # @param document The new PDF.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :wait Wait until the PDF has been processed before responding. Default true on sync.api hosts.
+  # @option opts [Boolean] :reimport_fields Replace all of the template's fields with the fillable fields in the new PDF, once DocSpring has processed it (`document.field_reimport_state`). As on a first upload, the default typeface, font size, bold and color are taken from the PDF's fields; the template's other settings are kept. If the PDF has no fillable fields, the template keeps its fields. A locked template can't re-import its fields.
+  # @return [Template]
+  describe 'upload_template_document test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end