docspring 4.4.0 → 4.5.0

data/lib/docspring/api_client.rb

@@ -34,7 +34,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-4.4.0"
+      @user_agent = "docspring-ruby-4.5.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/docspring/models/create_submission_request.rb

@@ -22,7 +22,7 @@ module DocSpring
     # `true` keeps the PDF's text and check fields fillable, and `false` flattens every field. Left out, the template decides: its `editable_submissions` setting, or each field's own Editable option. A response shows the template's setting when the request left this out. Can't be `true` with `signature_requests`.
     attr_accessor :editable
 
-    # The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them (PDF templates only).
+    # The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them (PDF templates only). Signatures come only from signature requests: a value for a signature or initials field makes the submission `invalid_data`, in test mode too. To print an image or a name you send, use an Image or Text field.
     attr_accessor :data
 
     # 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`).
@@ -37,7 +37,7 @@ module DocSpring
     # Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
     attr_accessor :expires_in
 
-    # Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
+    # Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. A `default` for a signature or initials field makes the submission `invalid_data`. With `signature_requests`, `editable: true` is a 422.
     attr_accessor :field_overrides
 
     # For an HTML template, HTML to use instead of the template's.
@@ -46,7 +46,7 @@ module DocSpring
     # 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`.
+    # 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.
     attr_accessor :signature_requests
 
     # Whether DocSpring emails the signers their signing links, and sends the reminders and the completed document. Default true. Each signature request's own `send_email` overrides it. A test submission only emails your DocSpring team: every other address is a 422. `true` needs `signature_requests`. DocSpring doesn't email the signers of a form library template: leave `send_email` out, and send them their links yourself.

data/lib/docspring/models/create_template_request.rb

@@ -52,7 +52,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 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), without a path. 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.
+    # 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), without a path. Each one is stored in lowercase, without a trailing slash. 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 Web Forms JS) 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).
@@ -91,7 +91,7 @@ module DocSpring
     # Allow anyone to fill in the template's web form.
     attr_accessor :public_web_form
 
-    # Where the web form sends people after they submit it.
+    # Where the web form sends people after they submit it, instead of showing its success screen. After its `?` or `#`, it can have variables such as `{{ data.first_name }}`, which the form fills in with what they submitted.
     attr_accessor :redirect_url
 
     # How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached. PDF templates only. A signature request uses the value it had when the request was created.
@@ -115,6 +115,15 @@ module DocSpring
     # A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page. PDF templates only.
     attr_accessor :signature_request_signing_url
 
+    # The title of the web form's success screen. When it's null or empty, the screen says "Thanks for filling out" and the template's name. It can have variables such as `{{ data.first_name }}`.
+    attr_accessor :success_title
+
+    # A message under the title of the web form's success screen, as plain text. Line breaks show, and web addresses become links. It can have variables such as `{{ data.first_name }}`.
+    attr_accessor :success_message
+
+    # Whether the web form's success screen has a "Fill out again" button, which clears the form so someone can fill it in again.
+    attr_accessor :show_fill_again_button
+
     # A Slack incoming webhook URL that is notified about the template's submissions. It's never returned; `has_slack_webhook_url` says if it's set.
     attr_accessor :slack_webhook_url
 
@@ -175,6 +184,9 @@ module DocSpring
     # 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.
     attr_accessor :field_logic
 
+    # With `detect_fields`, whether AI field setup keeps the fields that only the office receiving the form fills in, such as a "For office use only" box (`true`), or leaves them out (`false`). Default: your account's template settings.
+    attr_accessor :include_office_use_fields
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -233,6 +245,9 @@ module DocSpring
         :'signature_request_notification_emails' => :'signature_request_notification_emails',
         :'signature_request_reply_to' => :'signature_request_reply_to',
         :'signature_request_signing_url' => :'signature_request_signing_url',
+        :'success_title' => :'success_title',
+        :'success_message' => :'success_message',
+        :'show_fill_again_button' => :'show_fill_again_button',
         :'slack_webhook_url' => :'slack_webhook_url',
         :'defaults' => :'defaults',
         :'field_dependencies' => :'field_dependencies',
@@ -252,7 +267,8 @@ module DocSpring
         :'detect_fields' => :'detect_fields',
         :'field_source' => :'field_source',
         :'field_naming' => :'field_naming',
-        :'field_logic' => :'field_logic'
+        :'field_logic' => :'field_logic',
+        :'include_office_use_fields' => :'include_office_use_fields'
       }
     end
 
@@ -302,6 +318,9 @@ module DocSpring
         :'signature_request_notification_emails' => :'Array<String>',
         :'signature_request_reply_to' => :'String',
         :'signature_request_signing_url' => :'String',
+        :'success_title' => :'String',
+        :'success_message' => :'String',
+        :'show_fill_again_button' => :'Boolean',
         :'slack_webhook_url' => :'String',
         :'defaults' => :'TemplateDefaultsInput',
         :'field_dependencies' => :'Array<TemplateFieldDependencyInput>',
@@ -321,7 +340,8 @@ module DocSpring
         :'detect_fields' => :'Boolean',
         :'field_source' => :'FieldSetupSource',
         :'field_naming' => :'FieldSetupNaming',
-        :'field_logic' => :'FieldSetupLogic'
+        :'field_logic' => :'FieldSetupLogic',
+        :'include_office_use_fields' => :'Boolean'
       }
     end
 
@@ -337,6 +357,8 @@ module DocSpring
         :'signature_request_from_name',
         :'signature_request_reply_to',
         :'signature_request_signing_url',
+        :'success_title',
+        :'success_message',
         :'slack_webhook_url',
         :'predefined_fields_sample_data',
         :'html',
@@ -512,6 +534,18 @@ module DocSpring
         self.signature_request_signing_url = attributes[:'signature_request_signing_url']
       end
 
+      if attributes.key?(:'success_title')
+        self.success_title = attributes[:'success_title']
+      end
+
+      if attributes.key?(:'success_message')
+        self.success_message = attributes[:'success_message']
+      end
+
+      if attributes.key?(:'show_fill_again_button')
+        self.show_fill_again_button = attributes[:'show_fill_again_button']
+      end
+
       if attributes.key?(:'slack_webhook_url')
         self.slack_webhook_url = attributes[:'slack_webhook_url']
       end
@@ -599,6 +633,10 @@ module DocSpring
       if attributes.key?(:'field_logic')
         self.field_logic = attributes[:'field_logic']
       end
+
+      if attributes.key?(:'include_office_use_fields')
+        self.include_office_use_fields = attributes[:'include_office_use_fields']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -679,6 +717,9 @@ module DocSpring
           signature_request_notification_emails == o.signature_request_notification_emails &&
           signature_request_reply_to == o.signature_request_reply_to &&
           signature_request_signing_url == o.signature_request_signing_url &&
+          success_title == o.success_title &&
+          success_message == o.success_message &&
+          show_fill_again_button == o.show_fill_again_button &&
           slack_webhook_url == o.slack_webhook_url &&
           defaults == o.defaults &&
           field_dependencies == o.field_dependencies &&
@@ -698,7 +739,8 @@ module DocSpring
           detect_fields == o.detect_fields &&
           field_source == o.field_source &&
           field_naming == o.field_naming &&
-          field_logic == o.field_logic
+          field_logic == o.field_logic &&
+          include_office_use_fields == o.include_office_use_fields
     end
 
     # @see the `==` method
@@ -710,7 +752,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, template_type, output_format, 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, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, slack_webhook_url, defaults, field_dependencies, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, cache_id, document_url, document_base64, filename, detect_fields, field_source, field_naming, field_logic].hash
+      [name, description, template_type, output_format, 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, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, success_title, success_message, show_fill_again_button, slack_webhook_url, defaults, field_dependencies, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, cache_id, document_url, document_base64, filename, detect_fields, field_source, field_naming, field_logic, include_office_use_fields].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/error_info.rb

@@ -16,7 +16,7 @@ require 'time'
 module DocSpring
   # What went wrong.
   class ErrorInfo < ApiModelBase
-    # A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept. When the first request created a record, its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id` or `webhook_id`. `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`).
+    # A machine-readable error code. Clients should handle codes they don't know: new codes can be added. `invalid_data`: a submission's data doesn't match its template's fields. The submission is still recorded. `insufficient_credits` (402): your credit balance can't cover a live PDF. The record was saved and waits for credits in the `insufficient_credits` state: its ID is in `submission_id`, `submission_batch_id` or `combined_pdf_id`. `insufficient_credits_to_send` (402): your credit balance can't cover a live signature request that DocSpring would email, so nothing was saved. Add credits and send the request again. `upgrade_required` (403): your plan doesn't include this, such as more templates, another active integration (webhooks count), the embedded template editor, email actions, or live signature requests before your account's first payment. `account_suspended` (403): the account is suspended, so it can't create submissions. `polling_timeout`: on a sync.api host, the files weren't ready in time. The record was created and is still being processed: its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id` or `template_id`. Without one of these IDs, the request itself got no answer in time, and the record may or may not have been created. `idempotency_key_in_use` (409): the first request with the same Idempotency-Key is still being processed, and the response has a `Retry-After` header: send the request again then. Without the header, the first request was processed but its response is no longer kept, or it failed after creating or changing a record, and the message says which. When the first request created a record, or changed a template's fields or published a version of it, the message names it, and its ID is in `submission_id`, `submission_batch_id`, `combined_pdf_id`, `template_id`, `folder_id`, `custom_file_id`, `webhook_id`, `email_action_id` or `email_domain_id` (a signature request's events and tokens have no member). `idempotency_key_reused` (422): the Idempotency-Key was already used for a different request. `rate_limited` (429): too many API requests. Wait for the `Retry-After` header's seconds. `daily_email_limit_reached` (429): a submission that DocSpring would email would take your account over its daily email limit, so nothing was saved. Send it again after the `Retry-After` header's seconds (midnight UTC), or send the signing links yourself (`send_email: false`).
     attr_accessor :code
 
     # A human-readable explanation, safe to show to developers.
@@ -37,7 +37,7 @@ module DocSpring
     # With `insufficient_credits`, the combined PDF that waits for credits. With `polling_timeout`, the combined PDF that's still being processed. With `idempotency_key_in_use`, the combined PDF the first request with the key created.
     attr_accessor :combined_pdf_id
 
-    # With `polling_timeout`, the template whose PDF is still being processed. With `idempotency_key_in_use`, the template the first request with the key created.
+    # With `polling_timeout`, the template whose PDF is still being processed. With `idempotency_key_in_use`, the template the first request with the key created, or whose fields it changed or whose version it published.
     attr_accessor :template_id
 
     # With `idempotency_key_in_use`, the folder the first request with the key created.
@@ -49,6 +49,12 @@ module DocSpring
     # With `idempotency_key_in_use`, the webhook the first request with the key created.
     attr_accessor :webhook_id
 
+    # With `idempotency_key_in_use`, the email action the first request with the key created.
+    attr_accessor :email_action_id
+
+    # With `idempotency_key_in_use`, the email domain the first request with the key created.
+    attr_accessor :email_domain_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -84,7 +90,9 @@ module DocSpring
         :'template_id' => :'template_id',
         :'folder_id' => :'folder_id',
         :'custom_file_id' => :'custom_file_id',
-        :'webhook_id' => :'webhook_id'
+        :'webhook_id' => :'webhook_id',
+        :'email_action_id' => :'email_action_id',
+        :'email_domain_id' => :'email_domain_id'
       }
     end
 
@@ -111,7 +119,9 @@ module DocSpring
         :'template_id' => :'String',
         :'folder_id' => :'String',
         :'custom_file_id' => :'String',
-        :'webhook_id' => :'String'
+        :'webhook_id' => :'String',
+        :'email_action_id' => :'String',
+        :'email_domain_id' => :'String'
       }
     end
 
@@ -201,6 +211,14 @@ module DocSpring
       if attributes.key?(:'webhook_id')
         self.webhook_id = attributes[:'webhook_id']
       end
+
+      if attributes.key?(:'email_action_id')
+        self.email_action_id = attributes[:'email_action_id']
+      end
+
+      if attributes.key?(:'email_domain_id')
+        self.email_domain_id = attributes[:'email_domain_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -278,7 +296,9 @@ module DocSpring
           template_id == o.template_id &&
           folder_id == o.folder_id &&
           custom_file_id == o.custom_file_id &&
-          webhook_id == o.webhook_id
+          webhook_id == o.webhook_id &&
+          email_action_id == o.email_action_id &&
+          email_domain_id == o.email_domain_id
     end
 
     # @see the `==` method
@@ -290,7 +310,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, message, details, request_id, submission_id, submission_batch_id, combined_pdf_id, template_id, folder_id, custom_file_id, webhook_id].hash
+      [code, message, details, request_id, submission_id, submission_batch_id, combined_pdf_id, template_id, folder_id, custom_file_id, webhook_id, email_action_id, email_domain_id].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/html_engine_options.rb

@@ -19,10 +19,10 @@ module DocSpring
     # The paper size. `Custom` uses `width` and `height`.
     attr_accessor :format
 
-    # The page width for the `Custom` format, with a unit (`8.5in`, `210mm`).
+    # The page width for the `Custom` format, with a unit (`8.5in`, `210mm`), from 0.05in to 200in.
     attr_accessor :width
 
-    # The page height for the `Custom` format, with a unit.
+    # The page height for the `Custom` format, with a unit, from 0.05in to 200in.
     attr_accessor :height
 
     # How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size.
@@ -34,13 +34,13 @@ module DocSpring
     # Print background colors and images.
     attr_accessor :print_background
 
-    # The top margin, with a unit, such as `1in` or `20mm`.
+    # The top margin, with a unit, such as `1in` or `20mm`. The top and bottom margins together must be less than the page's height.
     attr_accessor :margin_top
 
     # The bottom margin, with a unit.
     attr_accessor :margin_bottom
 
-    # The left margin, with a unit.
+    # The left margin, with a unit. The left and right margins together must be less than the page's width.
     attr_accessor :margin_left
 
     # The right margin, with a unit.

data/lib/docspring/models/html_engine_options_input.rb

@@ -19,10 +19,10 @@ module DocSpring
     # The paper size. `Custom` uses `width` and `height`.
     attr_accessor :format
 
-    # The page width for the `Custom` format, with a unit (`8.5in`, `210mm`).
+    # The page width for the `Custom` format, with a unit (`8.5in`, `210mm`), from 0.05in to 200in.
     attr_accessor :width
 
-    # The page height for the `Custom` format, with a unit.
+    # The page height for the `Custom` format, with a unit, from 0.05in to 200in.
     attr_accessor :height
 
     # How much to scale the page, from 0.1 to 2, such as `0.8`. `1` prints it at its normal size.
@@ -34,13 +34,13 @@ module DocSpring
     # Print background colors and images.
     attr_accessor :print_background
 
-    # The top margin, with a unit, such as `1in` or `20mm`.
+    # The top margin, with a unit, such as `1in` or `20mm`. The top and bottom margins together must be less than the page's height.
     attr_accessor :margin_top
 
     # The bottom margin, with a unit.
     attr_accessor :margin_bottom
 
-    # The left margin, with a unit.
+    # The left margin, with a unit. The left and right margins together must be less than the page's width.
     attr_accessor :margin_left
 
     # The right margin, with a unit.

data/lib/docspring/models/submission_input.rb

@@ -37,7 +37,7 @@ module DocSpring
     # Seconds after the PDF is generated until the submission expires, up to 10 years (315360000). Default the template's expiration setting. A submission that isn't processed, such as one with invalid data, is kept for at least 48 hours. The demo API token's submissions expire within an hour: up to 3600, and that's their default.
     attr_accessor :expires_in
 
-    # Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
+    # Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. A `default` for a signature or initials field makes the submission `invalid_data`. With `signature_requests`, `editable: true` is a 422.
     attr_accessor :field_overrides
 
     # For an HTML template, HTML to use instead of the template's.

data/lib/docspring/models/template.rb

@@ -82,7 +82,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 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), without a path. 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.
+    # 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), without a path. Each one is stored in lowercase, without a trailing slash. 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 Web Forms JS) 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,7 +121,7 @@ module DocSpring
     # Allow anyone to fill in the template's web form.
     attr_accessor :public_web_form
 
-    # Where the web form sends people after they submit it.
+    # Where the web form sends people after they submit it, instead of showing its success screen. After its `?` or `#`, it can have variables such as `{{ data.first_name }}`, which the form fills in with what they submitted.
     attr_accessor :redirect_url
 
     # How DocSpring's completed emails send the signed PDF to your signers and CCs: `attachment` (attached, or a download link when it's too big to attach) or `link` (a download link). Null uses your account's rule: a link if your account has signed a BAA, otherwise attached. PDF templates only. A signature request uses the value it had when the request was created.
@@ -145,6 +145,15 @@ module DocSpring
     # A page on your own site that the button in DocSpring's email to a signer opens, instead of DocSpring's signing page: an https URL on one of your verified email domains or a subdomain of one, on the Growth plan or higher. It must include `{{ signature_request_id }}`. Your page authenticates the signer, creates a token for the signature request, and opens the signing form with it. Null links to DocSpring's signing page. PDF templates only.
     attr_accessor :signature_request_signing_url
 
+    # The title of the web form's success screen. When it's null or empty, the screen says "Thanks for filling out" and the template's name. It can have variables such as `{{ data.first_name }}`.
+    attr_accessor :success_title
+
+    # A message under the title of the web form's success screen, as plain text. Line breaks show, and web addresses become links. It can have variables such as `{{ data.first_name }}`.
+    attr_accessor :success_message
+
+    # Whether the web form's success screen has a "Fill out again" button, which clears the form so someone can fill it in again.
+    attr_accessor :show_fill_again_button
+
     # Whether `slack_webhook_url` is set.
     attr_accessor :has_slack_webhook_url
 
@@ -159,6 +168,9 @@ module DocSpring
     # The groups of the template's fields, with their settings. A field's name puts it in groups: `address/city` is in the group `address`, and `items/0/price` is in the list `items` and its items' group `items/~`.
     attr_accessor :field_groups
 
+    # The web form's sections, in order: Web Forms JS and the hosted web form show one section at a time. Empty when the template has none, and the web form shows all of its fields together, in the order the fields endpoint lists them. A field that no section lists (one added later) goes after the field before it in that order, in that field's section.
+    attr_accessor :form_sections
+
     # The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off.
     attr_accessor :predefined_fields
 
@@ -260,11 +272,15 @@ module DocSpring
         :'signature_request_notification_emails' => :'signature_request_notification_emails',
         :'signature_request_reply_to' => :'signature_request_reply_to',
         :'signature_request_signing_url' => :'signature_request_signing_url',
+        :'success_title' => :'success_title',
+        :'success_message' => :'success_message',
+        :'show_fill_again_button' => :'show_fill_again_button',
         :'has_slack_webhook_url' => :'has_slack_webhook_url',
         :'last_changed_by' => :'last_changed_by',
         :'defaults' => :'defaults',
         :'field_dependencies' => :'field_dependencies',
         :'field_groups' => :'field_groups',
+        :'form_sections' => :'form_sections',
         :'predefined_fields' => :'predefined_fields',
         :'predefined_fields_sample_data' => :'predefined_fields_sample_data',
         :'html' => :'html',
@@ -335,11 +351,15 @@ module DocSpring
         :'signature_request_notification_emails' => :'Array<String>',
         :'signature_request_reply_to' => :'String',
         :'signature_request_signing_url' => :'String',
+        :'success_title' => :'String',
+        :'success_message' => :'String',
+        :'show_fill_again_button' => :'Boolean',
         :'has_slack_webhook_url' => :'Boolean',
         :'last_changed_by' => :'TemplateActor',
         :'defaults' => :'TemplateDefaults',
         :'field_dependencies' => :'Array<TemplateFieldDependency>',
         :'field_groups' => :'Array<FieldGroup>',
+        :'form_sections' => :'Array<TemplateFormSection>',
         :'predefined_fields' => :'Array<PredefinedField>',
         :'predefined_fields_sample_data' => :'Hash<String, Object>',
         :'html' => :'String',
@@ -372,6 +392,8 @@ module DocSpring
         :'signature_request_from_name',
         :'signature_request_reply_to',
         :'signature_request_signing_url',
+        :'success_title',
+        :'success_message',
         :'last_changed_by',
         :'predefined_fields_sample_data',
         :'html',
@@ -673,6 +695,24 @@ module DocSpring
         self.signature_request_signing_url = nil
       end
 
+      if attributes.key?(:'success_title')
+        self.success_title = attributes[:'success_title']
+      else
+        self.success_title = nil
+      end
+
+      if attributes.key?(:'success_message')
+        self.success_message = attributes[:'success_message']
+      else
+        self.success_message = nil
+      end
+
+      if attributes.key?(:'show_fill_again_button')
+        self.show_fill_again_button = attributes[:'show_fill_again_button']
+      else
+        self.show_fill_again_button = nil
+      end
+
       if attributes.key?(:'has_slack_webhook_url')
         self.has_slack_webhook_url = attributes[:'has_slack_webhook_url']
       else
@@ -707,6 +747,14 @@ module DocSpring
         self.field_groups = nil
       end
 
+      if attributes.key?(:'form_sections')
+        if (value = attributes[:'form_sections']).is_a?(Array)
+          self.form_sections = value
+        end
+      else
+        self.form_sections = nil
+      end
+
       if attributes.key?(:'predefined_fields')
         if (value = attributes[:'predefined_fields']).is_a?(Array)
           self.predefined_fields = value
@@ -899,6 +947,10 @@ module DocSpring
         invalid_properties.push('invalid value for "signature_request_notification_emails", signature_request_notification_emails cannot be nil.')
       end
 
+      if @show_fill_again_button.nil?
+        invalid_properties.push('invalid value for "show_fill_again_button", show_fill_again_button cannot be nil.')
+      end
+
       if @has_slack_webhook_url.nil?
         invalid_properties.push('invalid value for "has_slack_webhook_url", has_slack_webhook_url cannot be nil.')
       end
@@ -915,6 +967,10 @@ module DocSpring
         invalid_properties.push('invalid value for "field_groups", field_groups cannot be nil.')
       end
 
+      if @form_sections.nil?
+        invalid_properties.push('invalid value for "form_sections", form_sections cannot be nil.')
+      end
+
       if @predefined_fields.nil?
         invalid_properties.push('invalid value for "predefined_fields", predefined_fields cannot be nil.')
       end
@@ -958,10 +1014,12 @@ module DocSpring
       return false if @public_web_form.nil?
       return false if @signature_request_include_signing_token.nil?
       return false if @signature_request_notification_emails.nil?
+      return false if @show_fill_again_button.nil?
       return false if @has_slack_webhook_url.nil?
       return false if @defaults.nil?
       return false if @field_dependencies.nil?
       return false if @field_groups.nil?
+      return false if @form_sections.nil?
       return false if @predefined_fields.nil?
       return false if @versions.nil?
       true
@@ -1247,6 +1305,16 @@ module DocSpring
       @signature_request_notification_emails = signature_request_notification_emails
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] show_fill_again_button Value to be assigned
+    def show_fill_again_button=(show_fill_again_button)
+      if show_fill_again_button.nil?
+        fail ArgumentError, 'show_fill_again_button cannot be nil'
+      end
+
+      @show_fill_again_button = show_fill_again_button
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] has_slack_webhook_url Value to be assigned
     def has_slack_webhook_url=(has_slack_webhook_url)
@@ -1287,6 +1355,16 @@ module DocSpring
       @field_groups = field_groups
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] form_sections Value to be assigned
+    def form_sections=(form_sections)
+      if form_sections.nil?
+        fail ArgumentError, 'form_sections cannot be nil'
+      end
+
+      @form_sections = form_sections
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] predefined_fields Value to be assigned
     def predefined_fields=(predefined_fields)
@@ -1355,11 +1433,15 @@ module DocSpring
           signature_request_notification_emails == o.signature_request_notification_emails &&
           signature_request_reply_to == o.signature_request_reply_to &&
           signature_request_signing_url == o.signature_request_signing_url &&
+          success_title == o.success_title &&
+          success_message == o.success_message &&
+          show_fill_again_button == o.show_fill_again_button &&
           has_slack_webhook_url == o.has_slack_webhook_url &&
           last_changed_by == o.last_changed_by &&
           defaults == o.defaults &&
           field_dependencies == o.field_dependencies &&
           field_groups == o.field_groups &&
+          form_sections == o.form_sections &&
           predefined_fields == o.predefined_fields &&
           predefined_fields_sample_data == o.predefined_fields_sample_data &&
           html == o.html &&
@@ -1382,7 +1464,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, 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, has_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, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, embed_edit_token, versions].hash
+      [id, name, description, template_type, output_format, ready, document, parent_folder_id, path, latest_version, version_published_at, locked, last_changed_at, created_at, updated_at, version, 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, has_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, signature_request_email_attachments, signature_request_from_address, signature_request_include_signing_token, signature_request_from_name, signature_request_notification_emails, signature_request_reply_to, signature_request_signing_url, success_title, success_message, show_fill_again_button, has_slack_webhook_url, last_changed_by, defaults, field_dependencies, field_groups, form_sections, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout, embed_edit_token, versions].hash
     end
 
     # Builds the object from hash