docspring 4.2.0 → 4.4.0

data/lib/docspring/models/template.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
 
@@ -25,13 +25,16 @@ 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
 
-    # `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. It can't be changed after the template is created.
+    # `pdf`: fields placed on an uploaded PDF. `html`: a PDF rendered from HTML and SCSS. `docx`: a Word document with tags where the data goes, which makes Word documents or PDFs. `page_designer`: a page design, a PDF laid out in the Page Designer from its `layout`. It can't be changed after the template is created.
     attr_accessor :template_type
 
-    # Whether the template can generate PDFs. HTML templates are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready.
+    # 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
+
+    # Whether the template can make documents. HTML templates and page designs are always ready. A PDF template is ready once DocSpring has stored its PDF, made an image of each page and finished looking for fields on each page, which can be after `document.state` becomes `processed`. A PDF template with no PDF (`document` is null) isn't ready. A Word template is ready once it has a Word document (a `document_url`'s has been downloaded).
     attr_accessor :ready
 
-    # The PDF of a PDF template. Null for HTML templates, and for a PDF template that has no PDF yet.
+    # The PDF of a PDF template, or the Word document of a Word template. Null for HTML templates, and for a PDF template that has no PDF yet. A template created from a `document_url` has one, with no file, while it's downloaded.
     attr_accessor :document
 
     # 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.
@@ -73,13 +76,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).
@@ -91,7 +94,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
 
     # Whether `encrypt_pdfs_password` is set.
@@ -109,7 +112,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.
@@ -121,6 +124,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
+
     # Whether `slack_webhook_url` is set.
     attr_accessor :has_slack_webhook_url
 
@@ -141,7 +165,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.
@@ -153,12 +177,15 @@ module DocSpring
     # The HTML printed at the bottom of each page of an HTML template.
     attr_accessor :footer_html
 
-    # How an HTML template's PDFs are printed. Null for PDF templates. Setting it replaces the whole object: options left out use their defaults.
+    # How an HTML template's PDFs are printed. Null for other templates. Setting it replaces the whole object: options left out use 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
+
     # The token that opens the template in the embedded template editor.
     attr_accessor :embed_edit_token
 
@@ -194,6 +221,7 @@ module DocSpring
         :'name' => :'name',
         :'description' => :'description',
         :'template_type' => :'template_type',
+        :'output_format' => :'output_format',
         :'ready' => :'ready',
         :'document' => :'document',
         :'parent_folder_id' => :'parent_folder_id',
@@ -225,6 +253,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',
         :'has_slack_webhook_url' => :'has_slack_webhook_url',
         :'last_changed_by' => :'last_changed_by',
         :'defaults' => :'defaults',
@@ -238,6 +273,7 @@ module DocSpring
         :'footer_html' => :'footer_html',
         :'html_engine_options' => :'html_engine_options',
         :'html_escape_data' => :'html_escape_data',
+        :'layout' => :'layout',
         :'embed_edit_token' => :'embed_edit_token',
         :'versions' => :'versions'
       }
@@ -260,6 +296,7 @@ module DocSpring
         :'name' => :'String',
         :'description' => :'String',
         :'template_type' => :'TemplateType',
+        :'output_format' => :'OutputFormat',
         :'ready' => :'Boolean',
         :'document' => :'TemplateDocument',
         :'parent_folder_id' => :'String',
@@ -291,6 +328,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',
         :'has_slack_webhook_url' => :'Boolean',
         :'last_changed_by' => :'TemplateActor',
         :'defaults' => :'TemplateDefaults',
@@ -304,6 +348,7 @@ module DocSpring
         :'footer_html' => :'String',
         :'html_engine_options' => :'HtmlEngineOptions',
         :'html_escape_data' => :'Boolean',
+        :'layout' => :'Hash<String, Object>',
         :'embed_edit_token' => :'String',
         :'versions' => :'Array<TemplateVersion>'
       }
@@ -322,6 +367,11 @@ module DocSpring
         :'version',
         :'ai_field_naming_language',
         :'redirect_url',
+        :'signature_request_email_attachments',
+        :'signature_request_from_address',
+        :'signature_request_from_name',
+        :'signature_request_reply_to',
+        :'signature_request_signing_url',
         :'last_changed_by',
         :'predefined_fields_sample_data',
         :'html',
@@ -330,6 +380,7 @@ module DocSpring
         :'footer_html',
         :'html_engine_options',
         :'html_escape_data',
+        :'layout',
         :'embed_edit_token',
       ])
     end
@@ -384,6 +435,12 @@ module DocSpring
         self.template_type = nil
       end
 
+      if attributes.key?(:'output_format')
+        self.output_format = attributes[:'output_format']
+      else
+        self.output_format = nil
+      end
+
       if attributes.key?(:'ready')
         self.ready = attributes[:'ready']
       else
@@ -572,6 +629,50 @@ module DocSpring
         self.redirect_url = nil
       end
 
+      if attributes.key?(:'signature_request_email_attachments')
+        self.signature_request_email_attachments = attributes[:'signature_request_email_attachments']
+      else
+        self.signature_request_email_attachments = nil
+      end
+
+      if attributes.key?(:'signature_request_from_address')
+        self.signature_request_from_address = attributes[:'signature_request_from_address']
+      else
+        self.signature_request_from_address = nil
+      end
+
+      if attributes.key?(:'signature_request_include_signing_token')
+        self.signature_request_include_signing_token = attributes[:'signature_request_include_signing_token']
+      else
+        self.signature_request_include_signing_token = nil
+      end
+
+      if attributes.key?(:'signature_request_from_name')
+        self.signature_request_from_name = attributes[:'signature_request_from_name']
+      else
+        self.signature_request_from_name = nil
+      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
+      else
+        self.signature_request_notification_emails = nil
+      end
+
+      if attributes.key?(:'signature_request_reply_to')
+        self.signature_request_reply_to = attributes[:'signature_request_reply_to']
+      else
+        self.signature_request_reply_to = nil
+      end
+
+      if attributes.key?(:'signature_request_signing_url')
+        self.signature_request_signing_url = attributes[:'signature_request_signing_url']
+      else
+        self.signature_request_signing_url = nil
+      end
+
       if attributes.key?(:'has_slack_webhook_url')
         self.has_slack_webhook_url = attributes[:'has_slack_webhook_url']
       else
@@ -658,6 +759,14 @@ module DocSpring
         self.html_escape_data = nil
       end
 
+      if attributes.key?(:'layout')
+        if (value = attributes[:'layout']).is_a?(Hash) || value.nil?
+          self.layout = value
+        end
+      else
+        self.layout = nil
+      end
+
       if attributes.key?(:'embed_edit_token')
         self.embed_edit_token = attributes[:'embed_edit_token']
       else
@@ -686,6 +795,10 @@ module DocSpring
         invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
       end
 
+      if @output_format.nil?
+        invalid_properties.push('invalid value for "output_format", output_format cannot be nil.')
+      end
+
       if @ready.nil?
         invalid_properties.push('invalid value for "ready", ready cannot be nil.')
       end
@@ -778,6 +891,14 @@ module DocSpring
         invalid_properties.push('invalid value for "public_web_form", public_web_form cannot be nil.')
       end
 
+      if @signature_request_include_signing_token.nil?
+        invalid_properties.push('invalid value for "signature_request_include_signing_token", signature_request_include_signing_token cannot be nil.')
+      end
+
+      if @signature_request_notification_emails.nil?
+        invalid_properties.push('invalid value for "signature_request_notification_emails", signature_request_notification_emails 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
@@ -811,6 +932,7 @@ module DocSpring
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @template_type.nil?
+      return false if @output_format.nil?
       return false if @ready.nil?
       return false if @path.nil?
       return false if @locked.nil?
@@ -834,6 +956,8 @@ module DocSpring
       return false if @parse_dates_using_template_date_format.nil?
       return false if @public_submissions.nil?
       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 @has_slack_webhook_url.nil?
       return false if @defaults.nil?
       return false if @field_dependencies.nil?
@@ -863,6 +987,16 @@ module DocSpring
       @template_type = template_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] output_format Value to be assigned
+    def output_format=(output_format)
+      if output_format.nil?
+        fail ArgumentError, 'output_format cannot be nil'
+      end
+
+      @output_format = output_format
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] ready Value to be assigned
     def ready=(ready)
@@ -1093,6 +1227,26 @@ module DocSpring
       @public_web_form = public_web_form
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] signature_request_include_signing_token Value to be assigned
+    def signature_request_include_signing_token=(signature_request_include_signing_token)
+      if signature_request_include_signing_token.nil?
+        fail ArgumentError, 'signature_request_include_signing_token cannot be nil'
+      end
+
+      @signature_request_include_signing_token = signature_request_include_signing_token
+    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
+
     # 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)
@@ -1162,6 +1316,7 @@ module DocSpring
           name == o.name &&
           description == o.description &&
           template_type == o.template_type &&
+          output_format == o.output_format &&
           ready == o.ready &&
           document == o.document &&
           parent_folder_id == o.parent_folder_id &&
@@ -1193,6 +1348,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 &&
           has_slack_webhook_url == o.has_slack_webhook_url &&
           last_changed_by == o.last_changed_by &&
           defaults == o.defaults &&
@@ -1206,6 +1368,7 @@ module DocSpring
           footer_html == o.footer_html &&
           html_engine_options == o.html_engine_options &&
           html_escape_data == o.html_escape_data &&
+          layout == o.layout &&
           embed_edit_token == o.embed_edit_token &&
           versions == o.versions
     end
@@ -1219,7 +1382,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, template_type, 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, 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, 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, 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
     end
 
     # Builds the object from hash

data/lib/docspring/models/template_actor.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/template_actor_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
 

data/lib/docspring/models/template_defaults.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/template_defaults_input.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/template_diff.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
 
@@ -31,10 +31,10 @@ module DocSpring
     # The fields that changed.
     attr_accessor :fields
 
-    # The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `expire_after`, ...). Values aren't included, and secrets like `encrypt_pdfs_password` are named when they change.
+    # The names of the template's settings that changed, as they're named on the Template (`name`, `html`, `defaults`, `merge_audit_trail_pdf`, ...). Values aren't included. Settings that apply to every version, such as `webhook_url` and `encrypt_pdfs_password`, are the same on every version, so they're named only when there's no earlier version to compare with; a secret is named without its value.
     attr_accessor :changed_settings
 
-    # The template's PDF was replaced (or added, when there's no `from_version`).
+    # The template's PDF was replaced, or its Word document replaced or edited (or added, when there's no `from_version`).
     attr_accessor :document_changed
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docspring/models/template_diff_summary.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/template_document.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
 
@@ -14,21 +14,21 @@ require 'date'
 require 'time'
 
 module DocSpring
-  # A PDF template's PDF.
+  # A PDF template's PDF, or a Word template's Word document.
   class TemplateDocument < ApiModelBase
-    # The PDF's file name. Null until a `document_url` has been downloaded.
+    # The file's name. Null until a `document_url` has been downloaded or an OpenDocument file converted.
     attr_accessor :filename
 
-    # `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
+    # `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. `converting` while DocSpring converts an OpenDocument file (.odt) uploaded to a Word template to a Word document, and `conversion_failed` when it couldn't, with `error_message` saying why. A template keeps its document while a new one is downloaded or converted, and when it couldn't be. A Word document is `processed` once it's uploaded, downloaded or converted.
     attr_accessor :state
 
-    # Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
+    # Why the PDF couldn't be processed, or the document downloaded or converted, and how to fix it. Null unless `state` is an error.
     attr_accessor :error_message
 
-    # 0 until the PDF has been processed.
+    # 0 until the PDF has been processed. 0 for a Word document, whose pages depend on the data.
     attr_accessor :page_count
 
-    # The MD5 hash of the PDF.
+    # The MD5 hash of the PDF. Null for a Word document.
     attr_accessor :md5
 
     # Whether the fields are being re-imported from this PDF (`reimport_fields` when the PDF was replaced): `requested` while DocSpring processes the PDF, then `imported`, or `no_fields` when the PDF had no fillable fields and the template kept its fields. `none` when no re-import was asked for, or when it couldn't run (the PDF couldn't be processed, or the template was locked or published while it was).
@@ -37,19 +37,19 @@ module DocSpring
     # Each page's width and height in PDF points. Null until the PDF has been processed.
     attr_accessor :page_dimensions
 
-    # Whether the PDF has fillable form fields. Null until DocSpring has read the PDF.
+    # Whether the PDF has fillable form fields. Null until DocSpring has read the PDF, and for a Word document.
     attr_accessor :has_fillable_fields
 
-    # How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, and for PDFs uploaded before DocSpring recorded page statuses.
+    # How processing is going on each page, in page order: its image, and its fields when DocSpring sets them up (`detect_fields` when the template was created). `state` becomes `processed` once every page is done. Empty until DocSpring has read the PDF, for PDFs uploaded before DocSpring recorded page statuses, and for a Word document.
     attr_accessor :page_processing_statuses
 
-    # AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields).
+    # AI field setup's last step, which reads the whole form once every page is done and can still rename fields and add conditional logic and required fields: `pending` or `processing` until it finishes, then `processed`, `failed` or `skipped`. Null until every page is done, and when there's no logic step to run (`field_logic` is `none`, or the PDF has no fields). Null for a Word document.
     attr_accessor :field_logic_status
 
-    # A temporary link to download the PDF.
+    # A temporary link to download the PDF. Null for a Word document (use `permanent_url`).
     attr_accessor :download_url
 
-    # A link to download the PDF that doesn't expire. Null until the PDF has been processed.
+    # A link to download the file that doesn't expire. Null until a PDF has been processed. A Word document's is built from the template's current document when it's downloaded.
     attr_accessor :permanent_url
 
     class EnumAttributeValidator

data/lib/docspring/models/template_document_state.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,9 +22,11 @@ module DocSpring
     UNKNOWN_ERROR = "unknown_error".freeze
     DOWNLOADING = "downloading".freeze
     DOWNLOAD_FAILED = "download_failed".freeze
+    CONVERTING = "converting".freeze
+    CONVERSION_FAILED = "conversion_failed".freeze
 
     def self.all_vars
-      @all_vars ||= [PENDING, PROCESSED, PASSWORD_REQUIRED, MALFORMED_PDF, UNKNOWN_ERROR, DOWNLOADING, DOWNLOAD_FAILED].freeze
+      @all_vars ||= [PENDING, PROCESSED, PASSWORD_REQUIRED, MALFORMED_PDF, UNKNOWN_ERROR, DOWNLOADING, DOWNLOAD_FAILED, CONVERTING, CONVERSION_FAILED].freeze
     end
 
     # Builds the enum from string

data/lib/docspring/models/template_document_summary.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
 
@@ -14,18 +14,18 @@ require 'date'
 require 'time'
 
 module DocSpring
-  # A PDF template's PDF, as template lists show it.
+  # A PDF template's PDF or a Word template's Word document, as template lists show it.
   class TemplateDocumentSummary < ApiModelBase
-    # The PDF's file name. Null until a `document_url` has been downloaded.
+    # The file's name. Null until a `document_url` has been downloaded or an OpenDocument file converted.
     attr_accessor :filename
 
-    # `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. A template keeps its PDF while a new one is downloaded, and when it couldn't be.
+    # `pending` while DocSpring processes the PDF, then `processed` (`ready` says when its pages are done too). `password_required`, `malformed_pdf` and `unknown_error` mean the PDF couldn't be processed, and `error_message` says why: upload it again or upload another one. `downloading` while DocSpring downloads a `document_url`, then as for an upload. `download_failed` means it couldn't be downloaded, and `error_message` says why. `converting` while DocSpring converts an OpenDocument file (.odt) uploaded to a Word template to a Word document, and `conversion_failed` when it couldn't, with `error_message` saying why. A template keeps its document while a new one is downloaded or converted, and when it couldn't be. A Word document is `processed` once it's uploaded, downloaded or converted.
     attr_accessor :state
 
-    # Why the PDF couldn't be processed or downloaded, and how to fix it. Null unless `state` is an error.
+    # Why the PDF couldn't be processed, or the document downloaded or converted, and how to fix it. Null unless `state` is an error.
     attr_accessor :error_message
 
-    # 0 until the PDF has been processed.
+    # 0 until the PDF has been processed. 0 for a Word document, whose pages depend on the data.
     attr_accessor :page_count
 
     class EnumAttributeValidator

data/lib/docspring/models/template_field_change.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/template_field_changes.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/template_field_dependency.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/template_field_dependency_action.rb

@@ -1,7 +1,7 @@
 =begin
 #DocSpring API
 
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
+#Use DocSpring's API to 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