docspring 4.1.0 → 4.2.0

data/lib/docspring/models/update_template_request.rb

@@ -46,7 +46,7 @@ module DocSpring
     # Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
     attr_accessor :editable_submissions
 
-    # The sites where the template's signature requests, forms and embedded template editor can be loaded: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
+    # The sites that can embed the template's live signature requests and its embedded template editor: a host such as `app.example.com`, with an optional leading wildcard (`*.example.com`), port (`localhost:3000`) or scheme (`https://app.example.com`; without one, `http` and `https` both work). Browsers open a live signature request in a frame only on these sites (and DocSpring's), so with an empty list it can't be embedded anywhere; a test signature request can be embedded on any site. The embedded template editor loads only for a page on one of these sites (by its Referer or Origin header), and on any site when the list is empty. Forms embedded on a page (Visual Forms JS and the simple form) aren't restricted.
     attr_accessor :embed_domains
 
     # Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
@@ -121,6 +121,9 @@ module DocSpring
     # Null resets the options to their defaults.
     attr_accessor :html_engine_options
 
+    # Whether an HTML template HTML-escapes the values it prints. When true, `{{ value }}` prints a value as text, so a `<` or `&` in it is printed as that character, and `{{ value | raw }}` prints a value as HTML. New HTML templates default to true. Templates created before October 2026, or with API v1, default to false, which prints every value as HTML. Null for PDF templates.
+    attr_accessor :html_escape_data
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -180,7 +183,8 @@ module DocSpring
         :'scss' => :'scss',
         :'header_html' => :'header_html',
         :'footer_html' => :'footer_html',
-        :'html_engine_options' => :'html_engine_options'
+        :'html_engine_options' => :'html_engine_options',
+        :'html_escape_data' => :'html_escape_data'
       }
     end
 
@@ -231,7 +235,8 @@ module DocSpring
         :'scss' => :'String',
         :'header_html' => :'String',
         :'footer_html' => :'String',
-        :'html_engine_options' => :'HtmlEngineOptionsInput'
+        :'html_engine_options' => :'HtmlEngineOptionsInput',
+        :'html_escape_data' => :'Boolean'
       }
     end
 
@@ -248,7 +253,7 @@ module DocSpring
         :'scss',
         :'header_html',
         :'footer_html',
-        :'html_engine_options'
+        :'html_engine_options',
       ])
     end
 
@@ -427,6 +432,10 @@ module DocSpring
       if attributes.key?(:'html_engine_options')
         self.html_engine_options = attributes[:'html_engine_options']
       end
+
+      if attributes.key?(:'html_escape_data')
+        self.html_escape_data = attributes[:'html_escape_data']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -483,7 +492,8 @@ module DocSpring
           scss == o.scss &&
           header_html == o.header_html &&
           footer_html == o.footer_html &&
-          html_engine_options == o.html_engine_options
+          html_engine_options == o.html_engine_options &&
+          html_escape_data == o.html_escape_data
     end
 
     # @see the `==` method
@@ -495,7 +505,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, slack_webhook_url, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options].hash
+      [name, description, parent_folder_id, locked, add_signature_request_submission_id_footers, ai_field_naming_language, allow_additional_properties, allow_skipping_optional_fields, default_form_mode, editable_submissions, embed_domains, embed_edit_allow_settings, embed_edit_allow_versioning, embed_edit_allow_document_replacement, encrypt_pdfs, encrypt_pdfs_password, expire_submissions, expire_after, expiration_interval, merge_audit_trail_pdf, parse_dates_using_template_date_format, public_submissions, public_web_form, redirect_url, slack_webhook_url, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/validate_submission_request.rb

@@ -25,7 +25,7 @@ module DocSpring
     # The values of the template's fields, by field name. Required for a PDF template, unless `signature_requests` collects the values.
     attr_accessor :data
 
-    # Your own data about the submission, such as an ID from your app. It isn't printed on the PDF.
+    # Your own data about the submission, such as an ID from your app. It isn't printed on the PDF. Two keys also change the PDF: `pdf_filename` names its file (`files.pdf.filename`, and its download), and `pdf_title` is its title in the PDF's document properties (and an HTML template's `<title>`, unless its HTML has one). Without `pdf_title`, the title is the template's name. In `pdf_filename`, a `.pdf` ending is removed, each run of characters other than letters, digits, `-`, `_` and `.` becomes one `_`, and the first 128 characters are kept, then `.pdf` is added. Without it, the file is named after the submission's ID (`sub_1234567890abcdef01.pdf`).
     attr_accessor :metadata
 
     # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
@@ -43,7 +43,7 @@ module DocSpring
     # For an HTML template, HTML to use instead of the template's.
     attr_accessor :html
 
-    # For an HTML template, CSS to use instead of the template's.
+    # For an HTML template, SCSS (plain CSS works too) added after the template's styles, on the page and in its header and footer. It doesn't replace them: its rules come later, so they win over the template's rules of the same specificity.
     attr_accessor :css
 
     # The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`.

data/lib/docspring/request_schemas.json

@@ -635,7 +635,7 @@
             "name": {
               "type": "string",
               "minLength": 1,
-              "maxLength": 255
+              "maxLength": 512
             },
             "parent_folder_id": {
               "type": [
@@ -944,7 +944,7 @@
                       "string",
                       "null"
                     ],
-                    "maxLength": 255
+                    "maxLength": 254
                   },
                   "fields": {
                     "type": "array",
@@ -1172,7 +1172,7 @@
             "name": {
               "type": "string",
               "minLength": 1,
-              "maxLength": 255
+              "maxLength": 512
             },
             "description": {
               "type": [
@@ -1711,6 +1711,9 @@
               },
               "additionalProperties": false
             },
+            "html_escape_data": {
+              "type": "boolean"
+            },
             "cache_id": {
               "type": "string",
               "minLength": 1,
@@ -1765,6 +1768,34 @@
         }
       }
     },
+    "createTemplatePreview": {
+      "query": {
+        "version": {
+          "required": false,
+          "schema": {
+            "type": "string",
+            "pattern": "^(\\d+(\\.\\d+(\\.\\d+)?)?|latest|draft)$",
+            "x-pattern-message": "must be a version like 1.2.3 or 1, or latest or draft"
+          }
+        }
+      },
+      "body": {
+        "mediaType": "application/json",
+        "required": true,
+        "schema": {
+          "type": "object",
+          "required": [
+            "data"
+          ],
+          "properties": {
+            "data": {
+              "type": "object"
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    },
     "createWebhook": {
       "body": {
         "mediaType": "application/json",
@@ -1777,7 +1808,7 @@
                 "string",
                 "null"
               ],
-              "maxLength": 255
+              "maxLength": 512
             },
             "url": {
               "type": "string",
@@ -1995,6 +2026,12 @@
               "go"
             ]
           }
+        },
+        "just_types": {
+          "required": false,
+          "schema": {
+            "type": "boolean"
+          }
         }
       }
     },
@@ -2010,6 +2047,7 @@
         }
       }
     },
+    "getTemplatePreview": {},
     "getTemplateSchema": {
       "query": {
         "version": {
@@ -2130,6 +2168,33 @@
           "schema": {
             "type": "string"
           }
+        },
+        "state": {
+          "required": false,
+          "schema": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "processed",
+              "invalid_data",
+              "error",
+              "image_download_failed",
+              "image_processing_failed",
+              "waiting_for_signature_requests",
+              "syntax_error",
+              "insufficient_credits",
+              "account_suspended",
+              "license_revoked",
+              "accidental",
+              "declined"
+            ]
+          }
+        },
+        "include_files": {
+          "required": false,
+          "schema": {
+            "type": "boolean"
+          }
         }
       }
     },
@@ -2186,6 +2251,33 @@
           "schema": {
             "type": "string"
           }
+        },
+        "state": {
+          "required": false,
+          "schema": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "processed",
+              "invalid_data",
+              "error",
+              "image_download_failed",
+              "image_processing_failed",
+              "waiting_for_signature_requests",
+              "syntax_error",
+              "insufficient_credits",
+              "account_suspended",
+              "license_revoked",
+              "accidental",
+              "declined"
+            ]
+          }
+        },
+        "include_files": {
+          "required": false,
+          "schema": {
+            "type": "boolean"
+          }
         }
       }
     },
@@ -2542,7 +2634,7 @@
             "name": {
               "type": "string",
               "minLength": 1,
-              "maxLength": 255
+              "maxLength": 512
             },
             "description": {
               "type": [
@@ -3115,6 +3207,9 @@
                 }
               },
               "additionalProperties": false
+            },
+            "html_escape_data": {
+              "type": "boolean"
             }
           },
           "additionalProperties": false
@@ -3802,7 +3897,7 @@
                 "string",
                 "null"
               ],
-              "maxLength": 255
+              "maxLength": 512
             },
             "url": {
               "type": "string",
@@ -3923,7 +4018,7 @@
             "name": {
               "type": "string",
               "minLength": 1,
-              "maxLength": 255
+              "maxLength": 512
             },
             "description": {
               "type": "string"
@@ -4080,7 +4175,7 @@
                       "string",
                       "null"
                     ],
-                    "maxLength": 255
+                    "maxLength": 254
                   },
                   "fields": {
                     "type": "array",
@@ -4202,6 +4297,7 @@
     "GET /templates/{template_id}/fields": "listTemplateFields",
     "GET /templates/{template_id}/model_code": "getTemplateModelCode",
     "GET /templates/{template_id}/page_images": "getTemplatePageImages",
+    "GET /templates/{template_id}/previews/{preview_id}": "getTemplatePreview",
     "GET /templates/{template_id}/schema": "getTemplateSchema",
     "GET /templates/{template_id}/submissions": "listTemplateSubmissions",
     "GET /uploads/presign": "getPresignUrl",
@@ -4224,6 +4320,7 @@
     "POST /templates/{template_id}/fields/remove": "removeTemplateFields",
     "POST /templates/{template_id}/fields/reorder": "reorderTemplateFields",
     "POST /templates/{template_id}/move": "moveTemplate",
+    "POST /templates/{template_id}/previews": "createTemplatePreview",
     "POST /templates/{template_id}/publish_version": "publishTemplateVersion",
     "POST /templates/{template_id}/restore_version": "restoreTemplateVersion",
     "POST /templates/{template_id}/submissions": "createSubmission",

data/lib/docspring/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.26.0-DOCSPRING
 =end
 
 module DocSpring
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end

data/lib/docspring/webhook_signature.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module DocSpring
+  # The number of seconds a webhook request's signature stays valid (verify_webhook_signature)
+  WEBHOOK_SIGNATURE_TOLERANCE = 300
+
+  # Checks a webhook request's X-DocSpring-Signature header (https://docspring.com/docs/webhooks/verifying-signatures/).
+  # Returns true when one of its v1 signatures is the HMAC-SHA256 of "{t}.{payload}" with the webhook's secret, and its
+  # timestamp t is at most `tolerance` seconds from `now`. Returns false for anything else, including a missing or
+  # malformed header.
+  #
+  # payload: the request body exactly as it was received (Rails: request.raw_post), not parsed JSON.
+  # signature_header: the X-DocSpring-Signature header.
+  # secret: the webhook's signing secret.
+  # tolerance: how many seconds old (or early) the timestamp can be. 5 minutes by default.
+  # now: the current Unix time in seconds, for tests. The system clock by default.
+  def self.verify_webhook_signature(payload, signature_header, secret, tolerance: WEBHOOK_SIGNATURE_TOLERANCE, now: nil)
+    return false unless payload.is_a?(String) && signature_header.is_a?(String) && secret.is_a?(String) && !secret.empty?
+
+    parts = signature_header.split(',').map { |part| part.strip.split('=', 2) }
+    timestamp = parts.find { |key, _value| key == 't' }&.last
+    signatures = parts.filter_map { |key, value| value if key == 'v1' && value && !value.empty? }
+    return false unless timestamp&.match?(/\A\d+\z/) && !signatures.empty?
+
+    now = Time.now.to_i if now.nil?
+    return false if (now.to_i - timestamp.to_i).abs > tolerance
+
+    expected = OpenSSL::HMAC.hexdigest('SHA256', secret, "#{timestamp}.#{payload}")
+    signatures.any? { |signature| webhook_signature_equal?(signature, expected) }
+  end
+
+  # Compares two signatures in constant time, so a timing attack can't find a valid one byte by byte
+  def self.webhook_signature_equal?(signature, expected)
+    return false unless signature.bytesize == expected.bytesize
+    # OpenSSL 2.2 (Ruby 3.0) and later
+    return OpenSSL.fixed_length_secure_compare(signature, expected) if OpenSSL.respond_to?(:fixed_length_secure_compare)
+
+    difference = 0
+    signature.bytes.zip(expected.bytes) { |a, b| difference |= a ^ b }
+    difference == 0
+  end
+  private_class_method :webhook_signature_equal?
+end

data/lib/docspring.rb

@@ -14,6 +14,7 @@ Generator version: 7.26.0-DOCSPRING
 require 'docspring/api_client'
 require 'docspring/api_error'
 require 'docspring/request_validator'
+require 'docspring/webhook_signature'
 require 'docspring/api_model_base'
 require 'docspring/version'
 require 'docspring/configuration'
@@ -41,6 +42,7 @@ require 'docspring/models/create_signature_request_event_request'
 require 'docspring/models/create_signature_request_token_request'
 require 'docspring/models/create_submission_batch_request'
 require 'docspring/models/create_submission_request'
+require 'docspring/models/create_template_preview_request'
 require 'docspring/models/create_template_request'
 require 'docspring/models/create_webhook_request'
 require 'docspring/models/custom_file'
@@ -122,6 +124,7 @@ require 'docspring/models/submission_list'
 require 'docspring/models/submission_source'
 require 'docspring/models/submission_source_pdf'
 require 'docspring/models/submission_state'
+require 'docspring/models/submission_summary'
 require 'docspring/models/submission_validation'
 require 'docspring/models/template'
 require 'docspring/models/template_actor'
@@ -132,6 +135,7 @@ require 'docspring/models/template_diff'
 require 'docspring/models/template_diff_summary'
 require 'docspring/models/template_document'
 require 'docspring/models/template_document_state'
+require 'docspring/models/template_document_summary'
 require 'docspring/models/template_field_change'
 require 'docspring/models/template_field_changes'
 require 'docspring/models/template_field_dependency'
@@ -152,6 +156,8 @@ require 'docspring/models/template_page_fields_status'
 require 'docspring/models/template_page_image_status'
 require 'docspring/models/template_page_images'
 require 'docspring/models/template_page_processing_status'
+require 'docspring/models/template_preview'
+require 'docspring/models/template_preview_state'
 require 'docspring/models/template_source_pdf'
 require 'docspring/models/template_summary'
 require 'docspring/models/template_summary_list'

data/spec/api/client_spec.rb

@@ -64,6 +64,7 @@ describe 'Client' do
   # @param body The PDFs to merge, and the combined PDF's settings.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :wait Wait until the PDF has been generated before responding. Default true on sync.api hosts.
+  # @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another combined PDF. Send a new key with each new combined PDF, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
   # @return [CombinedPdf]
   describe 'create_combined_pdf test' do
     it 'should work' do
@@ -97,7 +98,7 @@ describe 'Client' do
 
   # 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. 
+  # 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. A finished (completed, declined or expired) signature request's audit trail takes no more events, and a test API token can't record one for a live signature request. 
   # @param signature_request_id The signature request's ID.
   # @param body The event to record.
   # @param [Hash] opts the optional parameters
@@ -129,6 +130,7 @@ describe 'Client' do
   # @param [Hash] opts the optional parameters
   # @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 files have been generated before responding. Default true on sync.api hosts.
+  # @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another submission. Send a new key with each new submission, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
   # @return [Submission]
   describe 'create_submission test' do
     it 'should work' do
@@ -142,6 +144,7 @@ describe 'Client' do
   # @param body The submissions to create, and the settings they share.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :wait Wait until every PDF in the batch has been generated before responding. Default true on sync.api hosts.
+  # @option opts [String] :idempotency_key A key of your own, such as a UUID, that makes it safe to send this request again: for 24 hours, DocSpring answers a request with the same key from the same API token with the first request's response (and an `Idempotent-Replayed: true` header) instead of creating another batch. Send a new key with each new batch, and the same key each time you send the same request again, such as after a timeout, a network error or a 5xx. The same key with a different request is a 422 `idempotency_key_reused`. A 409 `idempotency_key_in_use` means the first request is still being processed: send the request again in a few seconds.
   # @return [SubmissionBatch]
   describe 'create_submission_batch test' do
     it 'should work' do
@@ -162,6 +165,20 @@ describe 'Client' do
     end
   end
 
+  # unit tests for create_template_preview
+  # Preview a template with data
+  # Makes PNG images of a template's pages filled in with the data you send (not a PDF), so you can check how an HTML or PDF template prints with your data before you publish a version or send live data. It renders the template's draft, or the published `version` you ask for. A preview makes no submission and uses no credits, and its pages are watermarked like a test submission's PDF. It's `pending` while it renders: get it with GET /templates/{template_id}/previews/{preview_id} until it's `processed`, with an image of each page, or `error`. 
+  # @param template_id The template's ID.
+  # @param body The data to render the template with.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :version A published version (`1.2.0`, or `1` for the latest 1.x.x), `latest` or `draft`. Default `draft`.
+  # @return [TemplatePreview]
+  describe 'create_template_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 create_webhook
   # Create a webhook
   # 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. 
@@ -385,11 +402,12 @@ describe 'Client' do
 
   # unit tests for get_template_model_code
   # 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. 
+  # 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, and `just_types=true` leaves out the code that converts JSON to and from the types. 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
   # @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.
+  # @option opts [Boolean] :just_types Return only the types (interfaces, classes or structs), without the code that converts JSON to and from them. Default false. JavaScript has no types and PHP no types-only code, so theirs is the same either way.
   # @return [TemplateModelCode]
   describe 'get_template_model_code test' do
     it 'should work' do
@@ -410,6 +428,19 @@ describe 'Client' do
     end
   end
 
+  # unit tests for get_template_preview
+  # Get a template preview
+  # Returns a preview made with POST /templates/{template_id}/previews. Once it's `processed`, `pages` has a PNG image of each page with a temporary link to download it: a preview has no PDF. Previews are deleted an hour after they're created. 
+  # @param template_id The template's ID.
+  # @param preview_id The preview's ID.
+  # @param [Hash] opts the optional parameters
+  # @return [TemplatePreview]
+  describe 'get_template_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 get_template_schema
   # 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. 
@@ -477,7 +508,7 @@ describe 'Client' do
 
   # unit tests for list_submissions
   # 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`. 
+  # Returns the submissions in your account, newest first, one page at a time. Each one is a summary: its `data` is null unless you pass `include_data=true`, and its `files` are empty unless you pass `include_files=true`. Get a submission by its ID for its signature requests, uploads and page images. 
   # @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).
@@ -486,6 +517,8 @@ describe 'Client' do
   # @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.
+  # @option opts [SubmissionState] :state Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+  # @option opts [Boolean] :include_files Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
   # @return [SubmissionList]
   describe 'list_submissions test' do
     it 'should work' do
@@ -517,6 +550,8 @@ describe 'Client' do
   # @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.
+  # @option opts [SubmissionState] :state Only list submissions in this state (one state per request). The ones that failed are `invalid_data`, `error`, `syntax_error`, `image_download_failed` and `image_processing_failed`, and one still `pending` an hour after it was created is stuck.
+  # @option opts [Boolean] :include_files Include each submission's generated files and their download links (`files`, empty without it), without the page images' links.
   # @return [SubmissionList]
   describe 'list_template_submissions test' do
     it 'should work' do
@@ -526,7 +561,7 @@ describe 'Client' do
 
   # unit tests for list_templates
   # 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. 
+  # Returns the templates in your account (their drafts), newest first, one page at a time. Each one is a summary: get a template by its ID for its settings, its PDF in full, 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).

data/spec/models/create_template_preview_request_spec.rb

@@ -0,0 +1,36 @@
+=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.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DocSpring::CreateTemplatePreviewRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe DocSpring::CreateTemplatePreviewRequest do
+  #let(:instance) { DocSpring::CreateTemplatePreviewRequest.new }
+
+  describe 'test an instance of CreateTemplatePreviewRequest' do
+    it 'should create an instance of CreateTemplatePreviewRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(DocSpring::CreateTemplatePreviewRequest)
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/create_template_request_spec.rb

@@ -237,6 +237,12 @@ describe DocSpring::CreateTemplateRequest do
     end
   end
 
+  describe 'test attribute "html_escape_data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "cache_id"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/