docspring 4.3.0 → 4.5.0

package/dist/model/CreateTemplateRequest.js

@@ -13,6 +13,7 @@ var _FieldSetupSource = _interopRequireDefault(require("./FieldSetupSource"));
 var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
 var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
+var _SignatureRequestEmailAttachments = _interopRequireDefault(require("./SignatureRequestEmailAttachments"));
 var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
 var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
 var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
@@ -41,14 +42,14 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateTemplateRequest model module.
  * @module model/CreateTemplateRequest
- * @version 4.3.0
+ * @version 4.5.0
  */
 var CreateTemplateRequest = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CreateTemplateRequest</code>.
    * The template to create.
    * @alias module:model/CreateTemplateRequest
-   * @param template_type {module:model/TemplateType} `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. It can't be changed after the template is created.
+   * @param template_type {module:model/TemplateType} `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.
    */
   function CreateTemplateRequest(template_type) {
     _classCallCheck(this, CreateTemplateRequest);
@@ -156,6 +157,36 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('redirect_url')) {
           obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
         }
+        if (data.hasOwnProperty('signature_request_email_attachments')) {
+          obj['signature_request_email_attachments'] = _ApiClient["default"].convertToType(data['signature_request_email_attachments'], _SignatureRequestEmailAttachments["default"]);
+        }
+        if (data.hasOwnProperty('signature_request_from_address')) {
+          obj['signature_request_from_address'] = _ApiClient["default"].convertToType(data['signature_request_from_address'], 'String');
+        }
+        if (data.hasOwnProperty('signature_request_include_signing_token')) {
+          obj['signature_request_include_signing_token'] = _ApiClient["default"].convertToType(data['signature_request_include_signing_token'], 'Boolean');
+        }
+        if (data.hasOwnProperty('signature_request_from_name')) {
+          obj['signature_request_from_name'] = _ApiClient["default"].convertToType(data['signature_request_from_name'], 'String');
+        }
+        if (data.hasOwnProperty('signature_request_notification_emails')) {
+          obj['signature_request_notification_emails'] = _ApiClient["default"].convertToType(data['signature_request_notification_emails'], ['String']);
+        }
+        if (data.hasOwnProperty('signature_request_reply_to')) {
+          obj['signature_request_reply_to'] = _ApiClient["default"].convertToType(data['signature_request_reply_to'], 'String');
+        }
+        if (data.hasOwnProperty('signature_request_signing_url')) {
+          obj['signature_request_signing_url'] = _ApiClient["default"].convertToType(data['signature_request_signing_url'], 'String');
+        }
+        if (data.hasOwnProperty('success_title')) {
+          obj['success_title'] = _ApiClient["default"].convertToType(data['success_title'], 'String');
+        }
+        if (data.hasOwnProperty('success_message')) {
+          obj['success_message'] = _ApiClient["default"].convertToType(data['success_message'], 'String');
+        }
+        if (data.hasOwnProperty('show_fill_again_button')) {
+          obj['show_fill_again_button'] = _ApiClient["default"].convertToType(data['show_fill_again_button'], 'Boolean');
+        }
         if (data.hasOwnProperty('slack_webhook_url')) {
           obj['slack_webhook_url'] = _ApiClient["default"].convertToType(data['slack_webhook_url'], 'String');
         }
@@ -191,6 +222,11 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('html_escape_data')) {
           obj['html_escape_data'] = _ApiClient["default"].convertToType(data['html_escape_data'], 'Boolean');
         }
+        if (data.hasOwnProperty('layout')) {
+          obj['layout'] = _ApiClient["default"].convertToType(data['layout'], {
+            'String': Object
+          });
+        }
         if (data.hasOwnProperty('cache_id')) {
           obj['cache_id'] = _ApiClient["default"].convertToType(data['cache_id'], 'String');
         }
@@ -215,6 +251,9 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('field_logic')) {
           obj['field_logic'] = _ApiClient["default"].convertToType(data['field_logic'], _FieldSetupLogic["default"]);
         }
+        if (data.hasOwnProperty('include_office_use_fields')) {
+          obj['include_office_use_fields'] = _ApiClient["default"].convertToType(data['include_office_use_fields'], 'Boolean');
+        }
       }
       return obj;
     }
@@ -267,6 +306,34 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         throw new Error("Expected the field `redirect_url` to be a primitive type in the JSON string but got " + data['redirect_url']);
       }
       // ensure the json data is a string
+      if (data['signature_request_from_address'] && !(typeof data['signature_request_from_address'] === 'string' || data['signature_request_from_address'] instanceof String)) {
+        throw new Error("Expected the field `signature_request_from_address` to be a primitive type in the JSON string but got " + data['signature_request_from_address']);
+      }
+      // ensure the json data is a string
+      if (data['signature_request_from_name'] && !(typeof data['signature_request_from_name'] === 'string' || data['signature_request_from_name'] instanceof String)) {
+        throw new Error("Expected the field `signature_request_from_name` to be a primitive type in the JSON string but got " + data['signature_request_from_name']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['signature_request_notification_emails'])) {
+        throw new Error("Expected the field `signature_request_notification_emails` to be an array in the JSON data but got " + data['signature_request_notification_emails']);
+      }
+      // ensure the json data is a string
+      if (data['signature_request_reply_to'] && !(typeof data['signature_request_reply_to'] === 'string' || data['signature_request_reply_to'] instanceof String)) {
+        throw new Error("Expected the field `signature_request_reply_to` to be a primitive type in the JSON string but got " + data['signature_request_reply_to']);
+      }
+      // ensure the json data is a string
+      if (data['signature_request_signing_url'] && !(typeof data['signature_request_signing_url'] === 'string' || data['signature_request_signing_url'] instanceof String)) {
+        throw new Error("Expected the field `signature_request_signing_url` to be a primitive type in the JSON string but got " + data['signature_request_signing_url']);
+      }
+      // ensure the json data is a string
+      if (data['success_title'] && !(typeof data['success_title'] === 'string' || data['success_title'] instanceof String)) {
+        throw new Error("Expected the field `success_title` to be a primitive type in the JSON string but got " + data['success_title']);
+      }
+      // ensure the json data is a string
+      if (data['success_message'] && !(typeof data['success_message'] === 'string' || data['success_message'] instanceof String)) {
+        throw new Error("Expected the field `success_message` to be a primitive type in the JSON string but got " + data['success_message']);
+      }
+      // ensure the json data is a string
       if (data['slack_webhook_url'] && !(typeof data['slack_webhook_url'] === 'string' || data['slack_webhook_url'] instanceof String)) {
         throw new Error("Expected the field `slack_webhook_url` to be a primitive type in the JSON string but got " + data['slack_webhook_url']);
       }
@@ -373,13 +440,13 @@ CreateTemplateRequest.prototype['name'] = undefined;
 CreateTemplateRequest.prototype['description'] = undefined;
 
 /**
- * `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. 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.
  * @member {module:model/TemplateType} template_type
  */
 CreateTemplateRequest.prototype['template_type'] = undefined;
 
 /**
- * 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; PDF and HTML templates always make PDFs. A Word template that encrypts its PDFs makes PDFs, because Word documents and OpenDocument files can't be password-protected.
+ * 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.
  * @member {module:model/OutputFormat} output_format
  */
 CreateTemplateRequest.prototype['output_format'] = undefined;
@@ -433,7 +500,7 @@ CreateTemplateRequest.prototype['default_form_mode'] = undefined;
 CreateTemplateRequest.prototype['editable_submissions'] = undefined;
 
 /**
- * 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. 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.
  * @member {Array.<String>} embed_domains
  */
 CreateTemplateRequest.prototype['embed_domains'] = undefined;
@@ -511,11 +578,71 @@ CreateTemplateRequest.prototype['public_submissions'] = undefined;
 CreateTemplateRequest.prototype['public_web_form'] = undefined;
 
 /**
- * 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.
  * @member {String} redirect_url
  */
 CreateTemplateRequest.prototype['redirect_url'] = undefined;
 
+/**
+ * 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.
+ * @member {module:model/SignatureRequestEmailAttachments} signature_request_email_attachments
+ */
+CreateTemplateRequest.prototype['signature_request_email_attachments'] = undefined;
+
+/**
+ * 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.
+ * @member {String} signature_request_from_address
+ */
+CreateTemplateRequest.prototype['signature_request_from_address'] = undefined;
+
+/**
+ * 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.
+ * @member {Boolean} signature_request_include_signing_token
+ */
+CreateTemplateRequest.prototype['signature_request_include_signing_token'] = undefined;
+
+/**
+ * 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.
+ * @member {String} signature_request_from_name
+ */
+CreateTemplateRequest.prototype['signature_request_from_name'] = undefined;
+
+/**
+ * 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.
+ * @member {Array.<String>} signature_request_notification_emails
+ */
+CreateTemplateRequest.prototype['signature_request_notification_emails'] = undefined;
+
+/**
+ * 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.
+ * @member {String} signature_request_reply_to
+ */
+CreateTemplateRequest.prototype['signature_request_reply_to'] = undefined;
+
+/**
+ * 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.
+ * @member {String} signature_request_signing_url
+ */
+CreateTemplateRequest.prototype['signature_request_signing_url'] = undefined;
+
+/**
+ * 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 }}`.
+ * @member {String} success_title
+ */
+CreateTemplateRequest.prototype['success_title'] = undefined;
+
+/**
+ * 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 }}`.
+ * @member {String} success_message
+ */
+CreateTemplateRequest.prototype['success_message'] = undefined;
+
+/**
+ * Whether the web form's success screen has a "Fill out again" button, which clears the form so someone can fill it in again.
+ * @member {Boolean} show_fill_again_button
+ */
+CreateTemplateRequest.prototype['show_fill_again_button'] = undefined;
+
 /**
  * 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.
  * @member {String} slack_webhook_url
@@ -547,7 +674,7 @@ CreateTemplateRequest.prototype['predefined_fields'] = undefined;
 CreateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
 
 /**
- * The HTML of an HTML template, as a Liquid template. Null for PDF and Word templates.
+ * The HTML of an HTML template, as a Liquid template. Null for other templates.
  * @member {String} html
  */
 CreateTemplateRequest.prototype['html'] = undefined;
@@ -577,11 +704,17 @@ CreateTemplateRequest.prototype['footer_html'] = undefined;
 CreateTemplateRequest.prototype['html_engine_options'] = undefined;
 
 /**
- * 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.
  * @member {Boolean} html_escape_data
  */
 CreateTemplateRequest.prototype['html_escape_data'] = undefined;
 
+/**
+ * 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.
+ * @member {Object.<String, Object>} layout
+ */
+CreateTemplateRequest.prototype['layout'] = undefined;
+
 /**
  * The template's document, a PDF or a Word document (.docx or .odt): the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). PDF and Word templates need one of `cache_id`, `document_url` and `document_base64`. To upload the file with the request, use POST /templates/upload.
  * @member {String} cache_id
@@ -595,7 +728,7 @@ CreateTemplateRequest.prototype['cache_id'] = undefined;
 CreateTemplateRequest.prototype['document_url'] = undefined;
 
 /**
- * The template's document (a PDF, or a Word template's Word document), encoded as base64 (a `data:` URI works too), instead of `cache_id`. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
+ * The template's document (a PDF, or a Word template's Word document), encoded as base64 (a `data:` URI works too), instead of `cache_id`. Line breaks and spaces in it are ignored. Up to 7 MB before it's encoded: send a larger file with `cache_id` or `document_url`.
  * @member {String} document_base64
  */
 CreateTemplateRequest.prototype['document_base64'] = undefined;
@@ -629,4 +762,10 @@ CreateTemplateRequest.prototype['field_naming'] = undefined;
  * @member {module:model/FieldSetupLogic} field_logic
  */
 CreateTemplateRequest.prototype['field_logic'] = undefined;
+
+/**
+ * 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.
+ * @member {Boolean} include_office_use_fields
+ */
+CreateTemplateRequest.prototype['include_office_use_fields'] = undefined;
 var _default = exports["default"] = CreateTemplateRequest;

package/dist/model/CreateWebhookRequest.js

@@ -31,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateWebhookRequest model module.
  * @module model/CreateWebhookRequest
- * @version 4.3.0
+ * @version 4.5.0
  */
 var CreateWebhookRequest = /*#__PURE__*/function () {
   /**

package/dist/model/CustomFile.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CustomFile model module.
  * @module model/CustomFile
- * @version 4.3.0
+ * @version 4.5.0
  */
 var CustomFile = /*#__PURE__*/function () {
   /**

package/dist/model/CustomFileList.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CustomFileList model module.
  * @module model/CustomFileList
- * @version 4.3.0
+ * @version 4.5.0
  */
 var CustomFileList = /*#__PURE__*/function () {
   /**

package/dist/model/CustomFileSourcePdf.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CustomFileSourcePdf model module.
  * @module model/CustomFileSourcePdf
- * @version 4.3.0
+ * @version 4.5.0
  */
 var CustomFileSourcePdf = /*#__PURE__*/function () {
   /**

package/dist/model/DnsRecordType.js

@@ -0,0 +1,64 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r; if ("undefined" != typeof Symbol && void 0 !== (r = t[Symbol.toPrimitive])) { var i = r.call(t, e || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === e ? String : Number)(t); } /**
+ * DocSpring API
+ * 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
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+* Enum class DnsRecordType.
+* @enum {}
+* @readonly
+*/
+var DnsRecordType = exports["default"] = /*#__PURE__*/function () {
+  function DnsRecordType() {
+    _classCallCheck(this, DnsRecordType);
+  }
+  return _createClass(DnsRecordType, null, [{
+    key: "constructFromObject",
+    value:
+    /**
+    * Returns a <code>DnsRecordType</code> enum value from a Javascript object name.
+    * @param {Object} data The plain JavaScript object containing the name of the enum value.
+    * @return {module:model/DnsRecordType} The enum <code>DnsRecordType</code> value.
+    */
+    function constructFromObject(object) {
+      // Any value, including one added to the API after this client was released
+      return object;
+    }
+  }]);
+}();
+/**
+ * value: "CNAME"
+ * @const
+ */
+_defineProperty(DnsRecordType, "CNAME", "CNAME");
+/**
+ * value: "MX"
+ * @const
+ */
+_defineProperty(DnsRecordType, "MX", "MX");
+/**
+ * value: "TXT"
+ * @const
+ */
+_defineProperty(DnsRecordType, "TXT", "TXT");