docspring 4.2.0 → 4.4.0

data/lib/docspring/models/update_template_request.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 
@@ -22,6 +22,9 @@ module DocSpring
     # Shown under the template's name at the top of its hosted forms, and used as their meta description. Not shown on embedded forms or signature requests.
     attr_accessor :description
 
+    # What each submission makes unless its request sets `output_formats`: `docx` (a Word document), `odt` (an OpenDocument file, converted from the Word document) or `pdf`. A Word template's is chosen when it's created; other templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
+    attr_accessor :output_format
+
     # The ID of the folder the template is in. Null for a template at the root. Setting it moves the template and all of its published versions.
     attr_accessor :parent_folder_id
 
@@ -40,13 +43,13 @@ module DocSpring
     # Visual forms and signature request forms show the Continue button as soon as the required fields are filled in, without visiting each optional field. The `allowSkippingOptionalFields` embed option overrides it.
     attr_accessor :allow_skipping_optional_fields
 
-    # The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). HTML templates have no visual form, so `web` is the only value they accept.
+    # The hosted form that /templates/{template_id}/form shows when its URL has no `mode` parameter: `web` (the web form), `visual` (the visual form, where fields are filled in on the PDF) or `dual` (both, in tabs). Only PDF templates have a visual form, so other templates accept only `web`.
     attr_accessor :default_form_mode
 
     # 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). 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. 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).
@@ -58,7 +61,7 @@ module DocSpring
     # Allow the embedded template editor to replace the template's PDF.
     attr_accessor :embed_edit_allow_document_replacement
 
-    # Encrypt generated PDFs with `encrypt_pdfs_password`.
+    # Encrypt generated PDFs with `encrypt_pdfs_password`. A Word template can only encrypt its PDFs when its `output_format` is `pdf`, because Word documents and OpenDocument files can't be password-protected.
     attr_accessor :encrypt_pdfs
 
     # The password that opens encrypted PDFs. It's never returned; `has_encrypt_pdfs_password` says if it's set.
@@ -76,7 +79,7 @@ module DocSpring
     # Add the audit trail to the end of PDFs signed through signature requests.
     attr_accessor :merge_audit_trail_pdf
 
-    # Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
+    # Date fields also accept NN/NN/YYYY dates (with slashes, dashes or dots), read in the order of the template's default date format: month first for %m/%d/%Y, day first for %d/%m/%Y. When false, date fields only accept YYYY-MM-DD. Applies to PDF templates: an HTML or Word template's date fields only accept YYYY-MM-DD. Date fields that include a time take RFC 3339 date-times either way.
     attr_accessor :parse_dates_using_template_date_format
 
     # Allow anyone with a submission's ID to download its PDF.
@@ -88,6 +91,27 @@ module DocSpring
     # Where the web form sends people after they submit it.
     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.
+    attr_accessor :signature_request_email_attachments
+
+    # The address DocSpring's emails to your signers come from: an address at one of your verified email domains, on the Growth plan or higher. Null sends them from DocSpring's shared address, with "via DocSpring" after the sender name. PDF templates only.
+    attr_accessor :signature_request_from_address
+
+    # Puts a signing token in `signature_request_signing_url`, as `{{ token_id }}` and `{{ token_secret }}`, so your page can open the signing form without creating a token itself. The email then carries a credential: anyone who has it can open the form and sign. PDF templates only.
+    attr_accessor :signature_request_include_signing_token
+
+    # The sender name on the emails DocSpring sends your signers, as in "Acme via DocSpring". It can't contain an email address, a website or quotes. Null uses your account's name. PDF templates only.
+    attr_accessor :signature_request_from_name
+
+    # Who DocSpring tells when a signature request's document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Empty means your account's owner. A submission's `notification_emails` replaces them. PDF templates only.
+    attr_accessor :signature_request_notification_emails
+
+    # Where your signers' replies to DocSpring's emails go: a member of your DocSpring team or an address at one of your verified email domains. Null means your account's owner. A submission's `reply_to` replaces it. PDF templates only.
+    attr_accessor :signature_request_reply_to
+
+    # 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
+
     # 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
 
@@ -106,7 +130,7 @@ module DocSpring
     # Sample submission data that sets `predefined_fields`: each value becomes a predefined field, with a type that fits it (`string`, `number`, `boolean`, `date`, `email` or `url`) and `required_in_template` true. Nested objects and arrays become names with `/`, such as `customer/email`. Without `predefined_fields` in the same request, it replaces them; with them, it adds to them and sets the types of the ones it has values for.
     attr_accessor :predefined_fields_sample_data
 
-    # The HTML of an HTML template, as a Liquid template. Null for PDF templates.
+    # The HTML of an HTML template, as a Liquid template. Null for other templates.
     attr_accessor :html
 
     # The SCSS of an HTML template.
@@ -121,9 +145,12 @@ 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.
+    # 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 other templates.
     attr_accessor :html_escape_data
 
+    # A page design's layout: its page setup, its sections and the elements placed in them, in the Page Designer layout format (https://docspring.com/docs/page-designer/layout-format/). Its JSON Schema is at https://docspring.com/schemas/page-designer/layout.v1.json. Null for other templates. Setting it replaces the whole layout, and DocSpring adds a field for each value it reads. Left out when a page design is created, it starts with an empty page.
+    attr_accessor :layout
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -151,6 +178,7 @@ module DocSpring
       {
         :'name' => :'name',
         :'description' => :'description',
+        :'output_format' => :'output_format',
         :'parent_folder_id' => :'parent_folder_id',
         :'locked' => :'locked',
         :'add_signature_request_submission_id_footers' => :'add_signature_request_submission_id_footers',
@@ -173,6 +201,13 @@ module DocSpring
         :'public_submissions' => :'public_submissions',
         :'public_web_form' => :'public_web_form',
         :'redirect_url' => :'redirect_url',
+        :'signature_request_email_attachments' => :'signature_request_email_attachments',
+        :'signature_request_from_address' => :'signature_request_from_address',
+        :'signature_request_include_signing_token' => :'signature_request_include_signing_token',
+        :'signature_request_from_name' => :'signature_request_from_name',
+        :'signature_request_notification_emails' => :'signature_request_notification_emails',
+        :'signature_request_reply_to' => :'signature_request_reply_to',
+        :'signature_request_signing_url' => :'signature_request_signing_url',
         :'slack_webhook_url' => :'slack_webhook_url',
         :'defaults' => :'defaults',
         :'field_dependencies' => :'field_dependencies',
@@ -184,7 +219,8 @@ module DocSpring
         :'header_html' => :'header_html',
         :'footer_html' => :'footer_html',
         :'html_engine_options' => :'html_engine_options',
-        :'html_escape_data' => :'html_escape_data'
+        :'html_escape_data' => :'html_escape_data',
+        :'layout' => :'layout'
       }
     end
 
@@ -203,6 +239,7 @@ module DocSpring
       {
         :'name' => :'String',
         :'description' => :'String',
+        :'output_format' => :'OutputFormat',
         :'parent_folder_id' => :'String',
         :'locked' => :'Boolean',
         :'add_signature_request_submission_id_footers' => :'Boolean',
@@ -225,6 +262,13 @@ module DocSpring
         :'public_submissions' => :'Boolean',
         :'public_web_form' => :'Boolean',
         :'redirect_url' => :'String',
+        :'signature_request_email_attachments' => :'SignatureRequestEmailAttachments',
+        :'signature_request_from_address' => :'String',
+        :'signature_request_include_signing_token' => :'Boolean',
+        :'signature_request_from_name' => :'String',
+        :'signature_request_notification_emails' => :'Array<String>',
+        :'signature_request_reply_to' => :'String',
+        :'signature_request_signing_url' => :'String',
         :'slack_webhook_url' => :'String',
         :'defaults' => :'TemplateDefaultsInput',
         :'field_dependencies' => :'Array<TemplateFieldDependencyInput>',
@@ -236,7 +280,8 @@ module DocSpring
         :'header_html' => :'String',
         :'footer_html' => :'String',
         :'html_engine_options' => :'HtmlEngineOptionsInput',
-        :'html_escape_data' => :'Boolean'
+        :'html_escape_data' => :'Boolean',
+        :'layout' => :'Hash<String, Object>'
       }
     end
 
@@ -247,6 +292,11 @@ module DocSpring
         :'parent_folder_id',
         :'encrypt_pdfs_password',
         :'redirect_url',
+        :'signature_request_email_attachments',
+        :'signature_request_from_address',
+        :'signature_request_from_name',
+        :'signature_request_reply_to',
+        :'signature_request_signing_url',
         :'slack_webhook_url',
         :'predefined_fields_sample_data',
         :'html',
@@ -254,6 +304,7 @@ module DocSpring
         :'header_html',
         :'footer_html',
         :'html_engine_options',
+        :'layout'
       ])
     end
 
@@ -291,6 +342,10 @@ module DocSpring
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'output_format')
+        self.output_format = attributes[:'output_format']
+      end
+
       if attributes.key?(:'parent_folder_id')
         self.parent_folder_id = attributes[:'parent_folder_id']
       end
@@ -381,6 +436,36 @@ module DocSpring
         self.redirect_url = attributes[:'redirect_url']
       end
 
+      if attributes.key?(:'signature_request_email_attachments')
+        self.signature_request_email_attachments = attributes[:'signature_request_email_attachments']
+      end
+
+      if attributes.key?(:'signature_request_from_address')
+        self.signature_request_from_address = attributes[:'signature_request_from_address']
+      end
+
+      if attributes.key?(:'signature_request_include_signing_token')
+        self.signature_request_include_signing_token = attributes[:'signature_request_include_signing_token']
+      end
+
+      if attributes.key?(:'signature_request_from_name')
+        self.signature_request_from_name = attributes[:'signature_request_from_name']
+      end
+
+      if attributes.key?(:'signature_request_notification_emails')
+        if (value = attributes[:'signature_request_notification_emails']).is_a?(Array)
+          self.signature_request_notification_emails = value
+        end
+      end
+
+      if attributes.key?(:'signature_request_reply_to')
+        self.signature_request_reply_to = attributes[:'signature_request_reply_to']
+      end
+
+      if attributes.key?(:'signature_request_signing_url')
+        self.signature_request_signing_url = attributes[:'signature_request_signing_url']
+      end
+
       if attributes.key?(:'slack_webhook_url')
         self.slack_webhook_url = attributes[:'slack_webhook_url']
       end
@@ -436,6 +521,12 @@ module DocSpring
       if attributes.key?(:'html_escape_data')
         self.html_escape_data = attributes[:'html_escape_data']
       end
+
+      if attributes.key?(:'layout')
+        if (value = attributes[:'layout']).is_a?(Hash) || value.nil?
+          self.layout = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -453,6 +544,16 @@ module DocSpring
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] signature_request_notification_emails Value to be assigned
+    def signature_request_notification_emails=(signature_request_notification_emails)
+      if signature_request_notification_emails.nil?
+        fail ArgumentError, 'signature_request_notification_emails cannot be nil'
+      end
+
+      @signature_request_notification_emails = signature_request_notification_emails
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -460,6 +561,7 @@ module DocSpring
       self.class == o.class &&
           name == o.name &&
           description == o.description &&
+          output_format == o.output_format &&
           parent_folder_id == o.parent_folder_id &&
           locked == o.locked &&
           add_signature_request_submission_id_footers == o.add_signature_request_submission_id_footers &&
@@ -482,6 +584,13 @@ module DocSpring
           public_submissions == o.public_submissions &&
           public_web_form == o.public_web_form &&
           redirect_url == o.redirect_url &&
+          signature_request_email_attachments == o.signature_request_email_attachments &&
+          signature_request_from_address == o.signature_request_from_address &&
+          signature_request_include_signing_token == o.signature_request_include_signing_token &&
+          signature_request_from_name == o.signature_request_from_name &&
+          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 &&
           slack_webhook_url == o.slack_webhook_url &&
           defaults == o.defaults &&
           field_dependencies == o.field_dependencies &&
@@ -493,7 +602,8 @@ module DocSpring
           header_html == o.header_html &&
           footer_html == o.footer_html &&
           html_engine_options == o.html_engine_options &&
-          html_escape_data == o.html_escape_data
+          html_escape_data == o.html_escape_data &&
+          layout == o.layout
     end
 
     # @see the `==` method
@@ -505,7 +615,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, html_escape_data].hash
+      [name, description, 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, field_groups, predefined_fields, predefined_fields_sample_data, html, scss, header_html, footer_html, html_engine_options, html_escape_data, layout].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/update_webhook_request.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 

data/lib/docspring/models/upload_method.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 

data/lib/docspring/models/upload_presign.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 

data/lib/docspring/models/url_source_pdf.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 

data/lib/docspring/models/validate_submission_request.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 
@@ -16,25 +16,25 @@ require 'time'
 module DocSpring
   # The submission's data and settings.
   class ValidateSubmissionRequest < ApiModelBase
-    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions.
+    # Test PDFs have a watermark and are free. Live PDFs use credits. Submissions made with a test API token are always test submissions, and the demo API token's are always live.
     attr_accessor :test
 
     # `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 a PDF template, unless `signature_requests` collects the values.
+    # 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).
     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`).
     attr_accessor :metadata
 
-    # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set.
+    # A password that the PDF needs to be opened with. It's never returned; `has_password` says if it's set. Word documents and OpenDocument files can't be password-protected, so a submission with a password can't make them.
     attr_accessor :password
 
-    # What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+    # What the submission makes: `pdf`, `docx` (a Word document, from a Word template), `odt` (an OpenDocument file, the format LibreOffice uses, converted from a Word template's Word document), and `png` (an image of each page of the PDF, up to 100 pages, which adds `pdf`) when you ask for it. Default `["pdf"]`, or a Word template's `output_format`. POST /submissions/{submission_id}/generate_files adds `png`, and a Word template's submission's `pdf`, `docx` or `odt`, to a processed submission.
     attr_accessor :output_formats
 
-    # 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.
+    # 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`.
@@ -49,6 +49,55 @@ module DocSpring
     # 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`.
     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.
+    attr_accessor :send_email
+
+    # `parallel` (the default): everyone can sign at once. `sequential`: people sign one step at a time (`signing_step`), and DocSpring emails each step when the one before it is done. Needs `signature_requests`.
+    attr_accessor :signing_order
+
+    # The subject of the emails that ask people to sign. You can use `{{ signer.name }}`, `{{ signer.email }}`, `{{ document.name }}`, `{{ sender.name }}` and `{{ account.name }}`. Default "<sender> sent you <document> to sign" when you leave it out (a blank subject is a 422). Links and web addresses are shown as plain text (`example[.]com`).
+    attr_accessor :email_subject
+
+    # A message for the people who sign, shown above the signing button. It takes the same variables as `email_subject`. Links and web addresses are shown as plain text. Leave it out for none: a blank message is a 422.
+    attr_accessor :email_message
+
+    # People who get a copy of the completed document. They don't sign.
+    attr_accessor :cc
+
+    # Where replies to the emails go: a member of your DocSpring team, or an address at one of your verified email domains. Leave it out for the template's reply-to address (the account owner when it has none).
+    attr_accessor :reply_to
+
+    # Who DocSpring tells when the document is completed or declined, or an email bounces or can't be sent: members of your DocSpring team or addresses at your verified email domains. Leave it out for the template's notification addresses (the account owner when it has none); an empty list means the account owner.
+    attr_accessor :notification_emails
+
+    # Also email `notification_emails` each time someone signs. Default false.
+    attr_accessor :notify_when_signed
+
+    # Remind people who haven't signed: every `interval_days` days, up to `max_count` times. Each reminder has a new signing link. Without it, DocSpring sends no reminders.
+    attr_accessor :reminders
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -62,7 +111,16 @@ module DocSpring
         :'field_overrides' => :'field_overrides',
         :'html' => :'html',
         :'css' => :'css',
-        :'signature_requests' => :'signature_requests'
+        :'signature_requests' => :'signature_requests',
+        :'send_email' => :'send_email',
+        :'signing_order' => :'signing_order',
+        :'email_subject' => :'email_subject',
+        :'email_message' => :'email_message',
+        :'cc' => :'cc',
+        :'reply_to' => :'reply_to',
+        :'notification_emails' => :'notification_emails',
+        :'notify_when_signed' => :'notify_when_signed',
+        :'reminders' => :'reminders'
       }
     end
 
@@ -89,7 +147,16 @@ module DocSpring
         :'field_overrides' => :'Hash<String, FieldOverride>',
         :'html' => :'String',
         :'css' => :'String',
-        :'signature_requests' => :'Array<SignatureRequestInput>'
+        :'signature_requests' => :'Array<SignatureRequestInput>',
+        :'send_email' => :'Boolean',
+        :'signing_order' => :'SigningOrder',
+        :'email_subject' => :'String',
+        :'email_message' => :'String',
+        :'cc' => :'Array<String>',
+        :'reply_to' => :'String',
+        :'notification_emails' => :'Array<String>',
+        :'notify_when_signed' => :'Boolean',
+        :'reminders' => :'SignatureRequestReminders'
       }
     end
 
@@ -178,6 +245,46 @@ module DocSpring
           self.signature_requests = value
         end
       end
+
+      if attributes.key?(:'send_email')
+        self.send_email = attributes[:'send_email']
+      end
+
+      if attributes.key?(:'signing_order')
+        self.signing_order = attributes[:'signing_order']
+      end
+
+      if attributes.key?(:'email_subject')
+        self.email_subject = attributes[:'email_subject']
+      end
+
+      if attributes.key?(:'email_message')
+        self.email_message = attributes[:'email_message']
+      end
+
+      if attributes.key?(:'cc')
+        if (value = attributes[:'cc']).is_a?(Array)
+          self.cc = value
+        end
+      end
+
+      if attributes.key?(:'reply_to')
+        self.reply_to = attributes[:'reply_to']
+      end
+
+      if attributes.key?(:'notification_emails')
+        if (value = attributes[:'notification_emails']).is_a?(Array)
+          self.notification_emails = value
+        end
+      end
+
+      if attributes.key?(:'notify_when_signed')
+        self.notify_when_signed = attributes[:'notify_when_signed']
+      end
+
+      if attributes.key?(:'reminders')
+        self.reminders = attributes[:'reminders']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -205,6 +312,26 @@ module DocSpring
       @output_formats = output_formats
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] cc Value to be assigned
+    def cc=(cc)
+      if cc.nil?
+        fail ArgumentError, 'cc cannot be nil'
+      end
+
+      @cc = cc
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] notification_emails Value to be assigned
+    def notification_emails=(notification_emails)
+      if notification_emails.nil?
+        fail ArgumentError, 'notification_emails cannot be nil'
+      end
+
+      @notification_emails = notification_emails
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -220,7 +347,16 @@ module DocSpring
           field_overrides == o.field_overrides &&
           html == o.html &&
           css == o.css &&
-          signature_requests == o.signature_requests
+          signature_requests == o.signature_requests &&
+          send_email == o.send_email &&
+          signing_order == o.signing_order &&
+          email_subject == o.email_subject &&
+          email_message == o.email_message &&
+          cc == o.cc &&
+          reply_to == o.reply_to &&
+          notification_emails == o.notification_emails &&
+          notify_when_signed == o.notify_when_signed &&
+          reminders == o.reminders
     end
 
     # @see the `==` method
@@ -232,7 +368,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [test, editable, data, metadata, password, output_formats, expires_in, field_overrides, html, css, signature_requests].hash
+      [test, editable, data, metadata, password, output_formats, expires_in, field_overrides, html, css, signature_requests, send_email, signing_order, email_subject, email_message, cc, reply_to, notification_emails, notify_when_signed, reminders].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/webhook.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 

data/lib/docspring/models/webhook_event_type.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 
@@ -18,9 +18,11 @@ module DocSpring
     SUBMISSION_PROCESSED = "submission.processed".freeze
     SUBMISSION_FAILED = "submission.failed".freeze
     SUBMISSION_DECLINED = "submission.declined".freeze
+    SIGNATURE_REQUEST_SENT = "signature_request.sent".freeze
     SIGNATURE_REQUEST_VIEWED = "signature_request.viewed".freeze
     SIGNATURE_REQUEST_COMPLETED = "signature_request.completed".freeze
     SIGNATURE_REQUEST_DECLINED = "signature_request.declined".freeze
+    SIGNATURE_REQUEST_EMAIL_BOUNCED = "signature_request.email_bounced".freeze
     COMBINED_PDF_PROCESSED = "combined_pdf.processed".freeze
     COMBINED_PDF_FAILED = "combined_pdf.failed".freeze
     SUBMISSION_BATCH_PROCESSED = "submission_batch.processed".freeze
@@ -42,7 +44,7 @@ module DocSpring
     FOLDER_DELETED = "folder.deleted".freeze
 
     def self.all_vars
-      @all_vars ||= [SUBMISSION_PROCESSED, SUBMISSION_FAILED, SUBMISSION_DECLINED, SIGNATURE_REQUEST_VIEWED, SIGNATURE_REQUEST_COMPLETED, SIGNATURE_REQUEST_DECLINED, COMBINED_PDF_PROCESSED, COMBINED_PDF_FAILED, SUBMISSION_BATCH_PROCESSED, SUBMISSION_BATCH_FAILED, SUBMISSION_CREATED, SUBMISSION_UPDATED, SUBMISSION_EXPIRED, SIGNATURE_REQUEST_UPDATED, COMBINED_PDF_EXPIRED, TEMPLATE_CREATED, TEMPLATE_UPDATED, TEMPLATE_DELETED, WEBHOOK_CREATED, WEBHOOK_UPDATED, WEBHOOK_DELETED, CUSTOM_FILE_CREATED, FOLDER_CREATED, FOLDER_UPDATED, FOLDER_DELETED].freeze
+      @all_vars ||= [SUBMISSION_PROCESSED, SUBMISSION_FAILED, SUBMISSION_DECLINED, SIGNATURE_REQUEST_SENT, SIGNATURE_REQUEST_VIEWED, SIGNATURE_REQUEST_COMPLETED, SIGNATURE_REQUEST_DECLINED, SIGNATURE_REQUEST_EMAIL_BOUNCED, COMBINED_PDF_PROCESSED, COMBINED_PDF_FAILED, SUBMISSION_BATCH_PROCESSED, SUBMISSION_BATCH_FAILED, SUBMISSION_CREATED, SUBMISSION_UPDATED, SUBMISSION_EXPIRED, SIGNATURE_REQUEST_UPDATED, COMBINED_PDF_EXPIRED, TEMPLATE_CREATED, TEMPLATE_UPDATED, TEMPLATE_DELETED, WEBHOOK_CREATED, WEBHOOK_UPDATED, WEBHOOK_DELETED, CUSTOM_FILE_CREATED, FOLDER_CREATED, FOLDER_UPDATED, FOLDER_DELETED].freeze
     end
 
     # Builds the enum from string

data/lib/docspring/models/webhook_list.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2
 

data/lib/docspring/models/webhook_mode.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to fill PDF forms, generate PDFs and Word documents from HTML or Word templates, merge PDFs, and request legally binding e-signatures.
 
 The version of the OpenAPI document: v2