docspring 4.0.0 → 4.1.0

package/dist/model/CreateSubmissionBatchRequest.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _SubmissionInput = _interopRequireDefault(require("./SubmissionInput"));
 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); }
@@ -30,7 +31,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateSubmissionBatchRequest model module.
  * @module model/CreateSubmissionBatchRequest
- * @version 4.0.0
+ * @version 4.1.0
  */
 var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
   /**
@@ -81,6 +82,9 @@ var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('test')) {
           obj['test'] = _ApiClient["default"].convertToType(data['test'], 'Boolean');
         }
+        if (data.hasOwnProperty('output_formats')) {
+          obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
+        }
         if (data.hasOwnProperty('submissions')) {
           obj['submissions'] = _ApiClient["default"].convertToType(data['submissions'], [_SubmissionInput["default"]]);
         }
@@ -119,6 +123,10 @@ var CreateSubmissionBatchRequest = /*#__PURE__*/function () {
       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 an array
+      if (!Array.isArray(data['output_formats'])) {
+        throw new Error("Expected the field `output_formats` to be an array in the JSON data but got " + data['output_formats']);
+      }
       if (data['submissions']) {
         // data not null
         // ensure the json data is an array
@@ -170,6 +178,12 @@ CreateSubmissionBatchRequest.prototype['template_version'] = undefined;
  */
 CreateSubmissionBatchRequest.prototype['test'] = undefined;
 
+/**
+ * The default `output_formats` for each submission that doesn't set its own.
+ * @member {Array.<module:model/OutputFormat>} output_formats
+ */
+CreateSubmissionBatchRequest.prototype['output_formats'] = undefined;
+
 /**
  * Up to 50 submissions. Each one takes the properties of POST /templates/{template_id}/submissions except `signature_requests`, plus `template_id` and `template_version` when it uses a different template from the batch.
  * @member {Array.<module:model/SubmissionInput>} submissions

package/dist/model/CreateSubmissionRequest.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _FieldOverride = _interopRequireDefault(require("./FieldOverride"));
+var _OutputFormat = _interopRequireDefault(require("./OutputFormat"));
 var _SignatureRequestInput = _interopRequireDefault(require("./SignatureRequestInput"));
 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); }
@@ -31,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateSubmissionRequest model module.
  * @module model/CreateSubmissionRequest
- * @version 4.0.0
+ * @version 4.1.0
  */
 var CreateSubmissionRequest = /*#__PURE__*/function () {
   /**
@@ -84,6 +85,9 @@ var CreateSubmissionRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('password')) {
           obj['password'] = _ApiClient["default"].convertToType(data['password'], 'String');
         }
+        if (data.hasOwnProperty('output_formats')) {
+          obj['output_formats'] = _ApiClient["default"].convertToType(data['output_formats'], [_OutputFormat["default"]]);
+        }
         if (data.hasOwnProperty('expires_in')) {
           obj['expires_in'] = _ApiClient["default"].convertToType(data['expires_in'], 'Number');
         }
@@ -117,6 +121,10 @@ var CreateSubmissionRequest = /*#__PURE__*/function () {
       if (data['password'] && !(typeof data['password'] === 'string' || data['password'] instanceof String)) {
         throw new Error("Expected the field `password` to be a primitive type in the JSON string but got " + data['password']);
       }
+      // ensure the json data is an array
+      if (!Array.isArray(data['output_formats'])) {
+        throw new Error("Expected the field `output_formats` to be an array in the JSON data but got " + data['output_formats']);
+      }
       // ensure the json data is a string
       if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
         throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
@@ -180,6 +188,12 @@ CreateSubmissionRequest.prototype['metadata'] = undefined;
  */
 CreateSubmissionRequest.prototype['password'] = undefined;
 
+/**
+ * What the submission makes: `pdf`, and `png` (an image of each page of the PDF, up to 100 pages) when you ask for it. Default `["pdf"]`. POST /submissions/{submission_id}/generate_files adds `png` to a processed submission.
+ * @member {Array.<module:model/OutputFormat>} output_formats
+ */
+CreateSubmissionRequest.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.
  * @member {Number} expires_in

package/dist/model/CreateTemplateRequest.js

@@ -11,6 +11,7 @@ var _FieldSetupLogic = _interopRequireDefault(require("./FieldSetupLogic"));
 var _FieldSetupNaming = _interopRequireDefault(require("./FieldSetupNaming"));
 var _FieldSetupSource = _interopRequireDefault(require("./FieldSetupSource"));
 var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
+var _PredefinedFieldInput = _interopRequireDefault(require("./PredefinedFieldInput"));
 var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
 var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
 var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
@@ -39,7 +40,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * The CreateTemplateRequest model module.
  * @module model/CreateTemplateRequest
- * @version 4.0.0
+ * @version 4.1.0
  */
 var CreateTemplateRequest = /*#__PURE__*/function () {
   /**
@@ -160,6 +161,14 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('field_dependencies')) {
           obj['field_dependencies'] = _ApiClient["default"].convertToType(data['field_dependencies'], [_TemplateFieldDependencyInput["default"]]);
         }
+        if (data.hasOwnProperty('predefined_fields')) {
+          obj['predefined_fields'] = _ApiClient["default"].convertToType(data['predefined_fields'], [_PredefinedFieldInput["default"]]);
+        }
+        if (data.hasOwnProperty('predefined_fields_sample_data')) {
+          obj['predefined_fields_sample_data'] = _ApiClient["default"].convertToType(data['predefined_fields_sample_data'], {
+            'String': Object
+          });
+        }
         if (data.hasOwnProperty('html')) {
           obj['html'] = _ApiClient["default"].convertToType(data['html'], 'String');
         }
@@ -178,6 +187,12 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         if (data.hasOwnProperty('cache_id')) {
           obj['cache_id'] = _ApiClient["default"].convertToType(data['cache_id'], 'String');
         }
+        if (data.hasOwnProperty('document_url')) {
+          obj['document_url'] = _ApiClient["default"].convertToType(data['document_url'], 'String');
+        }
+        if (data.hasOwnProperty('document_base64')) {
+          obj['document_base64'] = _ApiClient["default"].convertToType(data['document_base64'], 'String');
+        }
         if (data.hasOwnProperty('filename')) {
           obj['filename'] = _ApiClient["default"].convertToType(data['filename'], 'String');
         }
@@ -274,6 +289,27 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         }
         ;
       }
+      if (data['predefined_fields']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['predefined_fields'])) {
+          throw new Error("Expected the field `predefined_fields` to be an array in the JSON data but got " + data['predefined_fields']);
+        }
+        // validate the optional field `predefined_fields` (array)
+        var _iterator3 = _createForOfIteratorHelper(data['predefined_fields']),
+          _step3;
+        try {
+          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+            var _item = _step3.value;
+            _PredefinedFieldInput["default"].validateJSON(_item);
+          }
+        } catch (err) {
+          _iterator3.e(err);
+        } finally {
+          _iterator3.f();
+        }
+        ;
+      }
       // ensure the json data is a string
       if (data['html'] && !(typeof data['html'] === 'string' || data['html'] instanceof String)) {
         throw new Error("Expected the field `html` to be a primitive type in the JSON string but got " + data['html']);
@@ -300,6 +336,14 @@ var CreateTemplateRequest = /*#__PURE__*/function () {
         throw new Error("Expected the field `cache_id` to be a primitive type in the JSON string but got " + data['cache_id']);
       }
       // ensure the json data is a string
+      if (data['document_url'] && !(typeof data['document_url'] === 'string' || data['document_url'] instanceof String)) {
+        throw new Error("Expected the field `document_url` to be a primitive type in the JSON string but got " + data['document_url']);
+      }
+      // ensure the json data is a string
+      if (data['document_base64'] && !(typeof data['document_base64'] === 'string' || data['document_base64'] instanceof String)) {
+        throw new Error("Expected the field `document_base64` to be a primitive type in the JSON string but got " + data['document_base64']);
+      }
+      // ensure the json data is a string
       if (data['filename'] && !(typeof data['filename'] === 'string' || data['filename'] instanceof String)) {
         throw new Error("Expected the field `filename` to be a primitive type in the JSON string but got " + data['filename']);
       }
@@ -477,6 +521,18 @@ CreateTemplateRequest.prototype['defaults'] = undefined;
  */
 CreateTemplateRequest.prototype['field_dependencies'] = undefined;
 
+/**
+ * The field names that people using the embedded template editor choose from, each with the data type and settings a field gets when it's given that name. Setting it replaces the whole list; an empty list turns them off.
+ * @member {Array.<module:model/PredefinedFieldInput>} predefined_fields
+ */
+CreateTemplateRequest.prototype['predefined_fields'] = undefined;
+
+/**
+ * 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.
+ * @member {Object.<String, Object>} predefined_fields_sample_data
+ */
+CreateTemplateRequest.prototype['predefined_fields_sample_data'] = undefined;
+
 /**
  * The HTML of an HTML template, as a Liquid template. Null for PDF templates.
  * @member {String} html
@@ -508,13 +564,25 @@ CreateTemplateRequest.prototype['footer_html'] = undefined;
 CreateTemplateRequest.prototype['html_engine_options'] = undefined;
 
 /**
- * A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). Required for a PDF template. To upload the PDF with the request, use POST /templates/upload.
+ * A PDF template's document: the `fields.key` of a file you uploaded with the presigned upload (GET /uploads/presign). A PDF template needs one of `cache_id`, `document_url` and `document_base64`. To upload the PDF with the request, use POST /templates/upload.
  * @member {String} cache_id
  */
 CreateTemplateRequest.prototype['cache_id'] = undefined;
 
 /**
- * The PDF's file name, for a `cache_id` (presigned uploads don't send one).
+ * An https:// link to the template's PDF (up to 100 MB), instead of `cache_id`. DocSpring downloads it after responding, following redirects to other https:// links: the template's `document.state` is `downloading` until then (sync.api hosts wait for it). If it can't be downloaded, the state is `download_failed` and `document.error_message` says why.
+ * @member {String} document_url
+ */
+CreateTemplateRequest.prototype['document_url'] = undefined;
+
+/**
+ * The template's PDF, 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`.
+ * @member {String} document_base64
+ */
+CreateTemplateRequest.prototype['document_base64'] = undefined;
+
+/**
+ * The PDF's file name, for a `cache_id` (presigned uploads don't send one) or `document_base64`. A `document_url`'s is the last part of its path unless you set it.
  * @member {String} filename
  */
 CreateTemplateRequest.prototype['filename'] = undefined;

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.0.0
+ * @version 4.1.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.0.0
+ * @version 4.1.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.0.0
+ * @version 4.1.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.0.0
+ * @version 4.1.0
  */
 var CustomFileSourcePdf = /*#__PURE__*/function () {
   /**

package/dist/model/ErrorDetail.js

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

package/dist/model/ErrorInfo.js

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

package/dist/model/ErrorResponse.js

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