docspring 2.0.0 → 3.0.0

package/dist/model/SubmissionDataRequestShow.js

@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
  * DocSpring API
- * DocSpring provides an API that helps you fill out and sign PDF templates.
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The SubmissionDataRequestShow model module.
  * @module model/SubmissionDataRequestShow
- * @version 2.0.0
+ * @version 3.0.0
  */
 var SubmissionDataRequestShow = /*#__PURE__*/function () {
   /**
@@ -39,28 +39,28 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
    * @param email {String} 
    * @param name {String} 
    * @param order {Number} 
-   * @param sortOrder {Number} 
+   * @param sort_order {Number} 
    * @param fields {Array.<String>} 
    * @param metadata {Object} 
    * @param state {module:model/SubmissionDataRequestShow.StateEnum} 
-   * @param viewedAt {String} 
-   * @param completedAt {String} 
+   * @param viewed_at {String} 
+   * @param completed_at {String} 
    * @param data {Object} 
-   * @param authType {module:model/SubmissionDataRequestShow.AuthTypeEnum} 
-   * @param authSecondFactorType {module:model/SubmissionDataRequestShow.AuthSecondFactorTypeEnum} 
-   * @param authProvider {String} 
-   * @param authSessionStartedAt {String} 
-   * @param authSessionIdHash {String} 
-   * @param authUserIdHash {String} 
-   * @param authUsernameHash {String} 
-   * @param authPhoneNumberHash {String} 
-   * @param ipAddress {String} 
-   * @param userAgent {String} 
-   * @param submissionId {String} 
+   * @param auth_type {module:model/SubmissionDataRequestShow.AuthTypeEnum} 
+   * @param auth_second_factor_type {module:model/SubmissionDataRequestShow.AuthSecondFactorTypeEnum} 
+   * @param auth_provider {String} 
+   * @param auth_session_started_at {String} 
+   * @param auth_session_id_hash {String} 
+   * @param auth_user_id_hash {String} 
+   * @param auth_username_hash {String} 
+   * @param auth_phone_number_hash {String} 
+   * @param ip_address {String} 
+   * @param user_agent {String} 
+   * @param submission_id {String} 
    */
-  function SubmissionDataRequestShow(id, email, name, order, sortOrder, fields, metadata, state, viewedAt, completedAt, data, authType, authSecondFactorType, authProvider, authSessionStartedAt, authSessionIdHash, authUserIdHash, authUsernameHash, authPhoneNumberHash, ipAddress, userAgent, submissionId) {
+  function SubmissionDataRequestShow(id, email, name, order, sort_order, fields, metadata, state, viewed_at, completed_at, data, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, submission_id) {
     _classCallCheck(this, SubmissionDataRequestShow);
-    SubmissionDataRequestShow.initialize(this, id, email, name, order, sortOrder, fields, metadata, state, viewedAt, completedAt, data, authType, authSecondFactorType, authProvider, authSessionStartedAt, authSessionIdHash, authUserIdHash, authUsernameHash, authPhoneNumberHash, ipAddress, userAgent, submissionId);
+    SubmissionDataRequestShow.initialize(this, id, email, name, order, sort_order, fields, metadata, state, viewed_at, completed_at, data, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, submission_id);
   }
 
   /**
@@ -70,29 +70,29 @@ var SubmissionDataRequestShow = /*#__PURE__*/function () {
    */
   return _createClass(SubmissionDataRequestShow, null, [{
     key: "initialize",
-    value: function initialize(obj, id, email, name, order, sortOrder, fields, metadata, state, viewedAt, completedAt, data, authType, authSecondFactorType, authProvider, authSessionStartedAt, authSessionIdHash, authUserIdHash, authUsernameHash, authPhoneNumberHash, ipAddress, userAgent, submissionId) {
+    value: function initialize(obj, id, email, name, order, sort_order, fields, metadata, state, viewed_at, completed_at, data, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent, submission_id) {
       obj['id'] = id;
       obj['email'] = email;
       obj['name'] = name;
       obj['order'] = order;
-      obj['sort_order'] = sortOrder;
+      obj['sort_order'] = sort_order;
       obj['fields'] = fields;
       obj['metadata'] = metadata;
       obj['state'] = state;
-      obj['viewed_at'] = viewedAt;
-      obj['completed_at'] = completedAt;
+      obj['viewed_at'] = viewed_at;
+      obj['completed_at'] = completed_at;
       obj['data'] = data;
-      obj['auth_type'] = authType;
-      obj['auth_second_factor_type'] = authSecondFactorType;
-      obj['auth_provider'] = authProvider;
-      obj['auth_session_started_at'] = authSessionStartedAt;
-      obj['auth_session_id_hash'] = authSessionIdHash;
-      obj['auth_user_id_hash'] = authUserIdHash;
-      obj['auth_username_hash'] = authUsernameHash;
-      obj['auth_phone_number_hash'] = authPhoneNumberHash;
-      obj['ip_address'] = ipAddress;
-      obj['user_agent'] = userAgent;
-      obj['submission_id'] = submissionId;
+      obj['auth_type'] = auth_type;
+      obj['auth_second_factor_type'] = auth_second_factor_type;
+      obj['auth_provider'] = auth_provider;
+      obj['auth_session_started_at'] = auth_session_started_at;
+      obj['auth_session_id_hash'] = auth_session_id_hash;
+      obj['auth_user_id_hash'] = auth_user_id_hash;
+      obj['auth_username_hash'] = auth_username_hash;
+      obj['auth_phone_number_hash'] = auth_phone_number_hash;
+      obj['ip_address'] = ip_address;
+      obj['user_agent'] = user_agent;
+      obj['submission_id'] = submission_id;
     }
 
     /**

package/dist/model/SubmissionDataRequestToken.js

@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
  * DocSpring API
- * DocSpring provides an API that helps you fill out and sign PDF templates.
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The SubmissionDataRequestToken model module.
  * @module model/SubmissionDataRequestToken
- * @version 2.0.0
+ * @version 3.0.0
  */
 var SubmissionDataRequestToken = /*#__PURE__*/function () {
   /**
@@ -37,12 +37,12 @@ var SubmissionDataRequestToken = /*#__PURE__*/function () {
    * @alias module:model/SubmissionDataRequestToken
    * @param id {String} 
    * @param secret {String} 
-   * @param expiresAt {String} 
-   * @param dataRequestUrl {String} 
+   * @param expires_at {String} 
+   * @param data_request_url {String} 
    */
-  function SubmissionDataRequestToken(id, secret, expiresAt, dataRequestUrl) {
+  function SubmissionDataRequestToken(id, secret, expires_at, data_request_url) {
     _classCallCheck(this, SubmissionDataRequestToken);
-    SubmissionDataRequestToken.initialize(this, id, secret, expiresAt, dataRequestUrl);
+    SubmissionDataRequestToken.initialize(this, id, secret, expires_at, data_request_url);
   }
 
   /**
@@ -52,11 +52,11 @@ var SubmissionDataRequestToken = /*#__PURE__*/function () {
    */
   return _createClass(SubmissionDataRequestToken, null, [{
     key: "initialize",
-    value: function initialize(obj, id, secret, expiresAt, dataRequestUrl) {
+    value: function initialize(obj, id, secret, expires_at, data_request_url) {
       obj['id'] = id;
       obj['secret'] = secret;
-      obj['expires_at'] = expiresAt;
-      obj['data_request_url'] = dataRequestUrl;
+      obj['expires_at'] = expires_at;
+      obj['data_request_url'] = data_request_url;
     }
 
     /**

package/dist/model/SubmissionPreview.js

@@ -18,7 +18,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
  * DocSpring API
- * DocSpring provides an API that helps you fill out and sign PDF templates.
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -31,37 +31,39 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The SubmissionPreview model module.
  * @module model/SubmissionPreview
- * @version 2.0.0
+ * @version 3.0.0
  */
 var SubmissionPreview = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>SubmissionPreview</code>.
    * @alias module:model/SubmissionPreview
-   * @param batchId {String} 
-   * @param dataRequests {Array.<module:model/SubmissionDataRequest>} 
+   * @param batch_id {String} 
+   * @param data_requests {Array.<module:model/SubmissionDataRequest>} 
    * @param editable {Boolean} 
    * @param expired {Boolean} 
-   * @param expiresAt {String} 
+   * @param expires_at {String} 
    * @param id {String} 
-   * @param jsonSchemaErrors {Array.<String>} 
+   * @param json_schema_errors {Array.<String>} 
    * @param metadata {Object} 
    * @param password {String} 
-   * @param processedAt {String} 
+   * @param processed_at {String} 
    * @param state {module:model/SubmissionPreview.StateEnum} 
-   * @param templateId {String} 
+   * @param template_id {String} 
+   * @param template_type {module:model/SubmissionPreview.TemplateTypeEnum} 
+   * @param template_version {String} 
    * @param test {Boolean} 
-   * @param truncatedText {Object} 
-   * @param pdfHash {String} 
-   * @param downloadUrl {String} 
-   * @param permanentDownloadUrl {String} 
-   * @param previewDownloadUrl {String} 
-   * @param previewGeneratedAt {String} 
-   * @param auditTrailDownloadUrl {String} 
+   * @param truncated_text {Object} 
+   * @param pdf_hash {String} 
+   * @param download_url {String} 
+   * @param permanent_download_url {String} 
+   * @param preview_download_url {String} 
+   * @param preview_generated_at {String} 
+   * @param audit_trail_download_url {String} 
    * @param actions {Array.<module:model/SubmissionAction>} 
    */
-  function SubmissionPreview(batchId, dataRequests, editable, expired, expiresAt, id, jsonSchemaErrors, metadata, password, processedAt, state, templateId, test, truncatedText, pdfHash, downloadUrl, permanentDownloadUrl, previewDownloadUrl, previewGeneratedAt, auditTrailDownloadUrl, actions) {
+  function SubmissionPreview(batch_id, data_requests, editable, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions) {
     _classCallCheck(this, SubmissionPreview);
-    SubmissionPreview.initialize(this, batchId, dataRequests, editable, expired, expiresAt, id, jsonSchemaErrors, metadata, password, processedAt, state, templateId, test, truncatedText, pdfHash, downloadUrl, permanentDownloadUrl, previewDownloadUrl, previewGeneratedAt, auditTrailDownloadUrl, actions);
+    SubmissionPreview.initialize(this, batch_id, data_requests, editable, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions);
   }
 
   /**
@@ -71,27 +73,29 @@ var SubmissionPreview = /*#__PURE__*/function () {
    */
   return _createClass(SubmissionPreview, null, [{
     key: "initialize",
-    value: function initialize(obj, batchId, dataRequests, editable, expired, expiresAt, id, jsonSchemaErrors, metadata, password, processedAt, state, templateId, test, truncatedText, pdfHash, downloadUrl, permanentDownloadUrl, previewDownloadUrl, previewGeneratedAt, auditTrailDownloadUrl, actions) {
-      obj['batch_id'] = batchId;
-      obj['data_requests'] = dataRequests;
+    value: function initialize(obj, batch_id, data_requests, editable, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions) {
+      obj['batch_id'] = batch_id;
+      obj['data_requests'] = data_requests;
       obj['editable'] = editable;
       obj['expired'] = expired;
-      obj['expires_at'] = expiresAt;
+      obj['expires_at'] = expires_at;
       obj['id'] = id;
-      obj['json_schema_errors'] = jsonSchemaErrors;
+      obj['json_schema_errors'] = json_schema_errors;
       obj['metadata'] = metadata;
       obj['password'] = password;
-      obj['processed_at'] = processedAt;
+      obj['processed_at'] = processed_at;
       obj['state'] = state;
-      obj['template_id'] = templateId;
+      obj['template_id'] = template_id;
+      obj['template_type'] = template_type;
+      obj['template_version'] = template_version;
       obj['test'] = test;
-      obj['truncated_text'] = truncatedText;
-      obj['pdf_hash'] = pdfHash;
-      obj['download_url'] = downloadUrl;
-      obj['permanent_download_url'] = permanentDownloadUrl;
-      obj['preview_download_url'] = previewDownloadUrl;
-      obj['preview_generated_at'] = previewGeneratedAt;
-      obj['audit_trail_download_url'] = auditTrailDownloadUrl;
+      obj['truncated_text'] = truncated_text;
+      obj['pdf_hash'] = pdf_hash;
+      obj['download_url'] = download_url;
+      obj['permanent_download_url'] = permanent_download_url;
+      obj['preview_download_url'] = preview_download_url;
+      obj['preview_generated_at'] = preview_generated_at;
+      obj['audit_trail_download_url'] = audit_trail_download_url;
       obj['actions'] = actions;
     }
 
@@ -143,6 +147,12 @@ var SubmissionPreview = /*#__PURE__*/function () {
         if (data.hasOwnProperty('template_id')) {
           obj['template_id'] = _ApiClient["default"].convertToType(data['template_id'], 'String');
         }
+        if (data.hasOwnProperty('template_type')) {
+          obj['template_type'] = _ApiClient["default"].convertToType(data['template_type'], 'String');
+        }
+        if (data.hasOwnProperty('template_version')) {
+          obj['template_version'] = _ApiClient["default"].convertToType(data['template_version'], 'String');
+        }
         if (data.hasOwnProperty('test')) {
           obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
         }
@@ -251,6 +261,14 @@ var SubmissionPreview = /*#__PURE__*/function () {
         throw new Error("Expected the field `template_id` to be a primitive type in the JSON string but got " + data['template_id']);
       }
       // ensure the json data is a string
+      if (data['template_type'] && !(typeof data['template_type'] === 'string' || data['template_type'] instanceof String)) {
+        throw new Error("Expected the field `template_type` to be a primitive type in the JSON string but got " + data['template_type']);
+      }
+      // ensure the json data is a string
+      if (data['template_version'] && !(typeof data['template_version'] === 'string' || data['template_version'] instanceof String)) {
+        throw new Error("Expected the field `template_version` to be a primitive type in the JSON string but got " + data['template_version']);
+      }
+      // ensure the json data is a string
       if (data['pdf_hash'] && !(typeof data['pdf_hash'] === 'string' || data['pdf_hash'] instanceof String)) {
         throw new Error("Expected the field `pdf_hash` to be a primitive type in the JSON string but got " + data['pdf_hash']);
       }
@@ -299,7 +317,7 @@ var SubmissionPreview = /*#__PURE__*/function () {
     }
   }]);
 }();
-SubmissionPreview.RequiredProperties = ["batch_id", "data_requests", "editable", "expired", "expires_at", "id", "json_schema_errors", "metadata", "password", "processed_at", "state", "template_id", "test", "truncated_text", "pdf_hash", "download_url", "permanent_download_url", "preview_download_url", "preview_generated_at", "audit_trail_download_url", "actions"];
+SubmissionPreview.RequiredProperties = ["batch_id", "data_requests", "editable", "expired", "expires_at", "id", "json_schema_errors", "metadata", "password", "processed_at", "state", "template_id", "template_type", "template_version", "test", "truncated_text", "pdf_hash", "download_url", "permanent_download_url", "preview_download_url", "preview_generated_at", "audit_trail_download_url", "actions"];
 
 /**
  * @member {String} batch_id
@@ -361,6 +379,16 @@ SubmissionPreview.prototype['state'] = undefined;
  */
 SubmissionPreview.prototype['template_id'] = undefined;
 
+/**
+ * @member {module:model/SubmissionPreview.TemplateTypeEnum} template_type
+ */
+SubmissionPreview.prototype['template_type'] = undefined;
+
+/**
+ * @member {String} template_version
+ */
+SubmissionPreview.prototype['template_version'] = undefined;
+
 /**
  * @member {Boolean} test
  */
@@ -468,4 +496,22 @@ SubmissionPreview['StateEnum'] = {
    */
   "accidental": "accidental"
 };
+
+/**
+ * Allowed values for the <code>template_type</code> property.
+ * @enum {String}
+ * @readonly
+ */
+SubmissionPreview['TemplateTypeEnum'] = {
+  /**
+   * value: "pdf"
+   * @const
+   */
+  "pdf": "pdf",
+  /**
+   * value: "html"
+   * @const
+   */
+  "html": "html"
+};
 var _default = exports["default"] = SubmissionPreview;

package/dist/model/SuccessErrorResponse.js

@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
  * DocSpring API
- * DocSpring provides an API that helps you fill out and sign PDF templates.
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The SuccessErrorResponse model module.
  * @module model/SuccessErrorResponse
- * @version 2.0.0
+ * @version 3.0.0
  */
 var SuccessErrorResponse = /*#__PURE__*/function () {
   /**

package/dist/model/SuccessMultipleErrorsResponse.js

@@ -16,7 +16,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
  * DocSpring API
- * DocSpring provides an API that helps you fill out and sign PDF templates.
+ * Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
  * The SuccessMultipleErrorsResponse model module.
  * @module model/SuccessMultipleErrorsResponse
- * @version 2.0.0
+ * @version 3.0.0
  */
 var SuccessMultipleErrorsResponse = /*#__PURE__*/function () {
   /**