docspring 4.3.0 → 4.5.0

package/dist/model/UrlSourcePdf.js

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

package/dist/model/ValidateSubmissionRequest.js

@@ -8,6 +8,8 @@ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
 var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _SignatureRequestInput = _interopRequireDefault(require("./SignatureRequestInput"));
+var _SignatureRequestReminders = _interopRequireDefault(require("./SignatureRequestReminders"));
+var _SigningOrder = _interopRequireDefault(require("./SigningOrder"));
 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 _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
@@ -32,7 +34,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The ValidateSubmissionRequest model module.
  * @module model/ValidateSubmissionRequest
- * @version 4.3.0
+ * @version 4.5.0
  */
 var ValidateSubmissionRequest = /*#__PURE__*/function () {
   /**
@@ -105,6 +107,33 @@ var ValidateSubmissionRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('signature_requests')) {
           obj['signature_requests'] = _ApiClient["default"].convertToType(data['signature_requests'], [_SignatureRequestInput["default"]]);
         }
+        if (data.hasOwnProperty('send_email')) {
+          obj['send_email'] = _ApiClient["default"].convertToType(data['send_email'], 'Boolean');
+        }
+        if (data.hasOwnProperty('signing_order')) {
+          obj['signing_order'] = _ApiClient["default"].convertToType(data['signing_order'], _SigningOrder["default"]);
+        }
+        if (data.hasOwnProperty('email_subject')) {
+          obj['email_subject'] = _ApiClient["default"].convertToType(data['email_subject'], 'String');
+        }
+        if (data.hasOwnProperty('email_message')) {
+          obj['email_message'] = _ApiClient["default"].convertToType(data['email_message'], 'String');
+        }
+        if (data.hasOwnProperty('cc')) {
+          obj['cc'] = _ApiClient["default"].convertToType(data['cc'], ['String']);
+        }
+        if (data.hasOwnProperty('reply_to')) {
+          obj['reply_to'] = _ApiClient["default"].convertToType(data['reply_to'], 'String');
+        }
+        if (data.hasOwnProperty('notification_emails')) {
+          obj['notification_emails'] = _ApiClient["default"].convertToType(data['notification_emails'], ['String']);
+        }
+        if (data.hasOwnProperty('notify_when_signed')) {
+          obj['notify_when_signed'] = _ApiClient["default"].convertToType(data['notify_when_signed'], 'Boolean');
+        }
+        if (data.hasOwnProperty('reminders')) {
+          obj['reminders'] = _ApiClient["default"].convertToType(data['reminders'], _SignatureRequestReminders["default"]);
+        }
       }
       return obj;
     }
@@ -154,12 +183,37 @@ var ValidateSubmissionRequest = /*#__PURE__*/function () {
         }
         ;
       }
+      // ensure the json data is a string
+      if (data['email_subject'] && !(typeof data['email_subject'] === 'string' || data['email_subject'] instanceof String)) {
+        throw new Error("Expected the field `email_subject` to be a primitive type in the JSON string but got " + data['email_subject']);
+      }
+      // ensure the json data is a string
+      if (data['email_message'] && !(typeof data['email_message'] === 'string' || data['email_message'] instanceof String)) {
+        throw new Error("Expected the field `email_message` to be a primitive type in the JSON string but got " + data['email_message']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['cc'])) {
+        throw new Error("Expected the field `cc` to be an array in the JSON data but got " + data['cc']);
+      }
+      // ensure the json data is a string
+      if (data['reply_to'] && !(typeof data['reply_to'] === 'string' || data['reply_to'] instanceof String)) {
+        throw new Error("Expected the field `reply_to` to be a primitive type in the JSON string but got " + data['reply_to']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['notification_emails'])) {
+        throw new Error("Expected the field `notification_emails` to be an array in the JSON data but got " + data['notification_emails']);
+      }
+      // validate the optional field `reminders`
+      if (data['reminders']) {
+        // data not null
+        _SignatureRequestReminders["default"].validateJSON(data['reminders']);
+      }
       return true;
     }
   }]);
 }();
 /**
- * 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.
  * @member {Boolean} test
  */
 ValidateSubmissionRequest.prototype['test'] = undefined;
@@ -171,7 +225,7 @@ ValidateSubmissionRequest.prototype['test'] = undefined;
 ValidateSubmissionRequest.prototype['editable'] = undefined;
 
 /**
- * The values of the template's fields, by field name. Required for PDF and Word templates, unless `signature_requests` collects them (PDF templates only).
+ * The values of the template's fields, by field name. Required for PDF templates, Word templates and page designs, unless `signature_requests` collects them (PDF templates only). Signatures come only from signature requests: a value for a signature or initials field makes the submission `invalid_data`, in test mode too. To print an image or a name you send, use an Image or Text field.
  * @member {Object.<String, Object>} data
  */
 ValidateSubmissionRequest.prototype['data'] = undefined;
@@ -195,13 +249,13 @@ ValidateSubmissionRequest.prototype['password'] = undefined;
 ValidateSubmissionRequest.prototype['output_formats'] = undefined;
 
 /**
- * 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.
  * @member {Number} expires_in
  */
 ValidateSubmissionRequest.prototype['expires_in'] = undefined;
 
 /**
- * Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. With `signature_requests`, `editable: true` is a 422, and a `default` for a signature or initials field makes the submission `invalid_data`.
+ * Changes to field settings for this submission only, by field name, such as `{"name": {"required": false, "font_size": 9}}`. A setting that identifies the field (`id`, `name`, `type`), that only the template sets (such as `description`), or that doesn't apply to the field's type and display type (such as `check_character` on a field displayed as text) is a 422. A `default` for a signature or initials field makes the submission `invalid_data`. With `signature_requests`, `editable: true` is a 422.
  * @member {Object.<String, module:model/FieldOverride>} field_overrides
  */
 ValidateSubmissionRequest.prototype['field_overrides'] = undefined;
@@ -219,8 +273,62 @@ ValidateSubmissionRequest.prototype['html'] = undefined;
 ValidateSubmissionRequest.prototype['css'] = undefined;
 
 /**
- * The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out. Only the signers sign: a value for a signature or initials field in `data` makes the submission `invalid_data`.
+ * The people who sign the PDF, and fill in their fields first. The PDF is generated once every signature request is completed. PDF templates only. Without `role`s, the first signature request is `Signer 1`, the second `Signer 2`, and so on. To leave a signer out, give every signature request its `role` and leave that one's out.
  * @member {Array.<module:model/SignatureRequestInput>} signature_requests
  */
 ValidateSubmissionRequest.prototype['signature_requests'] = undefined;
+
+/**
+ * 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.
+ * @member {Boolean} send_email
+ */
+ValidateSubmissionRequest.prototype['send_email'] = undefined;
+
+/**
+ * `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`.
+ * @member {module:model/SigningOrder} signing_order
+ */
+ValidateSubmissionRequest.prototype['signing_order'] = undefined;
+
+/**
+ * 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`).
+ * @member {String} email_subject
+ */
+ValidateSubmissionRequest.prototype['email_subject'] = undefined;
+
+/**
+ * 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.
+ * @member {String} email_message
+ */
+ValidateSubmissionRequest.prototype['email_message'] = undefined;
+
+/**
+ * People who get a copy of the completed document. They don't sign.
+ * @member {Array.<String>} cc
+ */
+ValidateSubmissionRequest.prototype['cc'] = undefined;
+
+/**
+ * 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).
+ * @member {String} reply_to
+ */
+ValidateSubmissionRequest.prototype['reply_to'] = undefined;
+
+/**
+ * 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.
+ * @member {Array.<String>} notification_emails
+ */
+ValidateSubmissionRequest.prototype['notification_emails'] = undefined;
+
+/**
+ * Also email `notification_emails` each time someone signs. Default false.
+ * @member {Boolean} notify_when_signed
+ */
+ValidateSubmissionRequest.prototype['notify_when_signed'] = undefined;
+
+/**
+ * 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.
+ * @member {module:model/SignatureRequestReminders} reminders
+ */
+ValidateSubmissionRequest.prototype['reminders'] = undefined;
 var _default = exports["default"] = ValidateSubmissionRequest;

package/dist/model/Webhook.js

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

package/dist/model/WebhookEventType.js

@@ -62,6 +62,11 @@ _defineProperty(WebhookEventType, "submission.failed", "submission.failed");
  * @const
  */
 _defineProperty(WebhookEventType, "submission.declined", "submission.declined");
+/**
+ * value: "signature_request.sent"
+ * @const
+ */
+_defineProperty(WebhookEventType, "signature_request.sent", "signature_request.sent");
 /**
  * value: "signature_request.viewed"
  * @const
@@ -77,6 +82,11 @@ _defineProperty(WebhookEventType, "signature_request.completed", "signature_requ
  * @const
  */
 _defineProperty(WebhookEventType, "signature_request.declined", "signature_request.declined");
+/**
+ * value: "signature_request.email_bounced"
+ * @const
+ */
+_defineProperty(WebhookEventType, "signature_request.email_bounced", "signature_request.email_bounced");
 /**
  * value: "combined_pdf.processed"
  * @const

package/dist/model/WebhookList.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docspring",
-  "version": "4.3.0",
+  "version": "4.5.0",
   "description": "An API client for DocSpring: fill PDF forms, generate PDFs and Word documents, and collect e-signatures",
   "license": "MIT",
   "main": "dist/index.js",