docspring 3.3.0 → 4.0.0

package/dist/model/UpdateTemplateRequest.js

@@ -0,0 +1,450 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _AiFieldNamingLanguage = _interopRequireDefault(require("./AiFieldNamingLanguage"));
+var _ExpirationInterval = _interopRequireDefault(require("./ExpirationInterval"));
+var _HtmlEngineOptionsInput = _interopRequireDefault(require("./HtmlEngineOptionsInput"));
+var _TemplateDefaultsInput = _interopRequireDefault(require("./TemplateDefaultsInput"));
+var _TemplateFieldDependencyInput = _interopRequireDefault(require("./TemplateFieldDependencyInput"));
+var _TemplateFormMode = _interopRequireDefault(require("./TemplateFormMode"));
+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; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+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 _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 programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or 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.
+ *
+ */
+/**
+ * The UpdateTemplateRequest model module.
+ * @module model/UpdateTemplateRequest
+ * @version 4.0.0
+ */
+var UpdateTemplateRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>UpdateTemplateRequest</code>.
+   * The settings to change. Properties left out keep their values.
+   * @alias module:model/UpdateTemplateRequest
+   */
+  function UpdateTemplateRequest() {
+    _classCallCheck(this, UpdateTemplateRequest);
+    UpdateTemplateRequest.initialize(this);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(UpdateTemplateRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>UpdateTemplateRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/UpdateTemplateRequest} obj Optional instance to populate.
+     * @return {module:model/UpdateTemplateRequest} The populated <code>UpdateTemplateRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new UpdateTemplateRequest();
+        if (data.hasOwnProperty('name')) {
+          obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
+        }
+        if (data.hasOwnProperty('description')) {
+          obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
+        }
+        if (data.hasOwnProperty('parent_folder_id')) {
+          obj['parent_folder_id'] = _ApiClient["default"].convertToType(data['parent_folder_id'], 'String');
+        }
+        if (data.hasOwnProperty('locked')) {
+          obj['locked'] = _ApiClient["default"].convertToType(data['locked'], 'Boolean');
+        }
+        if (data.hasOwnProperty('add_signature_request_submission_id_footers')) {
+          obj['add_signature_request_submission_id_footers'] = _ApiClient["default"].convertToType(data['add_signature_request_submission_id_footers'], 'Boolean');
+        }
+        if (data.hasOwnProperty('ai_field_naming_language')) {
+          obj['ai_field_naming_language'] = _ApiClient["default"].convertToType(data['ai_field_naming_language'], _AiFieldNamingLanguage["default"]);
+        }
+        if (data.hasOwnProperty('allow_additional_properties')) {
+          obj['allow_additional_properties'] = _ApiClient["default"].convertToType(data['allow_additional_properties'], 'Boolean');
+        }
+        if (data.hasOwnProperty('allow_skipping_optional_fields')) {
+          obj['allow_skipping_optional_fields'] = _ApiClient["default"].convertToType(data['allow_skipping_optional_fields'], 'Boolean');
+        }
+        if (data.hasOwnProperty('default_form_mode')) {
+          obj['default_form_mode'] = _ApiClient["default"].convertToType(data['default_form_mode'], _TemplateFormMode["default"]);
+        }
+        if (data.hasOwnProperty('editable_submissions')) {
+          obj['editable_submissions'] = _ApiClient["default"].convertToType(data['editable_submissions'], 'Boolean');
+        }
+        if (data.hasOwnProperty('embed_domains')) {
+          obj['embed_domains'] = _ApiClient["default"].convertToType(data['embed_domains'], ['String']);
+        }
+        if (data.hasOwnProperty('embed_edit_allow_settings')) {
+          obj['embed_edit_allow_settings'] = _ApiClient["default"].convertToType(data['embed_edit_allow_settings'], 'Boolean');
+        }
+        if (data.hasOwnProperty('embed_edit_allow_versioning')) {
+          obj['embed_edit_allow_versioning'] = _ApiClient["default"].convertToType(data['embed_edit_allow_versioning'], 'Boolean');
+        }
+        if (data.hasOwnProperty('embed_edit_allow_document_replacement')) {
+          obj['embed_edit_allow_document_replacement'] = _ApiClient["default"].convertToType(data['embed_edit_allow_document_replacement'], 'Boolean');
+        }
+        if (data.hasOwnProperty('encrypt_pdfs')) {
+          obj['encrypt_pdfs'] = _ApiClient["default"].convertToType(data['encrypt_pdfs'], 'Boolean');
+        }
+        if (data.hasOwnProperty('encrypt_pdfs_password')) {
+          obj['encrypt_pdfs_password'] = _ApiClient["default"].convertToType(data['encrypt_pdfs_password'], 'String');
+        }
+        if (data.hasOwnProperty('expire_submissions')) {
+          obj['expire_submissions'] = _ApiClient["default"].convertToType(data['expire_submissions'], 'Boolean');
+        }
+        if (data.hasOwnProperty('expire_after')) {
+          obj['expire_after'] = _ApiClient["default"].convertToType(data['expire_after'], 'Number');
+        }
+        if (data.hasOwnProperty('expiration_interval')) {
+          obj['expiration_interval'] = _ApiClient["default"].convertToType(data['expiration_interval'], _ExpirationInterval["default"]);
+        }
+        if (data.hasOwnProperty('merge_audit_trail_pdf')) {
+          obj['merge_audit_trail_pdf'] = _ApiClient["default"].convertToType(data['merge_audit_trail_pdf'], 'Boolean');
+        }
+        if (data.hasOwnProperty('parse_dates_using_template_date_format')) {
+          obj['parse_dates_using_template_date_format'] = _ApiClient["default"].convertToType(data['parse_dates_using_template_date_format'], 'Boolean');
+        }
+        if (data.hasOwnProperty('public_submissions')) {
+          obj['public_submissions'] = _ApiClient["default"].convertToType(data['public_submissions'], 'Boolean');
+        }
+        if (data.hasOwnProperty('public_web_form')) {
+          obj['public_web_form'] = _ApiClient["default"].convertToType(data['public_web_form'], 'Boolean');
+        }
+        if (data.hasOwnProperty('redirect_url')) {
+          obj['redirect_url'] = _ApiClient["default"].convertToType(data['redirect_url'], 'String');
+        }
+        if (data.hasOwnProperty('slack_webhook_url')) {
+          obj['slack_webhook_url'] = _ApiClient["default"].convertToType(data['slack_webhook_url'], 'String');
+        }
+        if (data.hasOwnProperty('defaults')) {
+          obj['defaults'] = _ApiClient["default"].convertToType(data['defaults'], _TemplateDefaultsInput["default"]);
+        }
+        if (data.hasOwnProperty('field_dependencies')) {
+          obj['field_dependencies'] = _ApiClient["default"].convertToType(data['field_dependencies'], [_TemplateFieldDependencyInput["default"]]);
+        }
+        if (data.hasOwnProperty('html')) {
+          obj['html'] = _ApiClient["default"].convertToType(data['html'], 'String');
+        }
+        if (data.hasOwnProperty('scss')) {
+          obj['scss'] = _ApiClient["default"].convertToType(data['scss'], 'String');
+        }
+        if (data.hasOwnProperty('header_html')) {
+          obj['header_html'] = _ApiClient["default"].convertToType(data['header_html'], 'String');
+        }
+        if (data.hasOwnProperty('footer_html')) {
+          obj['footer_html'] = _ApiClient["default"].convertToType(data['footer_html'], 'String');
+        }
+        if (data.hasOwnProperty('html_engine_options')) {
+          obj['html_engine_options'] = _ApiClient["default"].convertToType(data['html_engine_options'], _HtmlEngineOptionsInput["default"]);
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UpdateTemplateRequest</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateTemplateRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
+        throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
+      }
+      // ensure the json data is a string
+      if (data['description'] && !(typeof data['description'] === 'string' || data['description'] instanceof String)) {
+        throw new Error("Expected the field `description` to be a primitive type in the JSON string but got " + data['description']);
+      }
+      // ensure the json data is a string
+      if (data['parent_folder_id'] && !(typeof data['parent_folder_id'] === 'string' || data['parent_folder_id'] instanceof String)) {
+        throw new Error("Expected the field `parent_folder_id` to be a primitive type in the JSON string but got " + data['parent_folder_id']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['embed_domains'])) {
+        throw new Error("Expected the field `embed_domains` to be an array in the JSON data but got " + data['embed_domains']);
+      }
+      // ensure the json data is a string
+      if (data['encrypt_pdfs_password'] && !(typeof data['encrypt_pdfs_password'] === 'string' || data['encrypt_pdfs_password'] instanceof String)) {
+        throw new Error("Expected the field `encrypt_pdfs_password` to be a primitive type in the JSON string but got " + data['encrypt_pdfs_password']);
+      }
+      // ensure the json data is a string
+      if (data['redirect_url'] && !(typeof data['redirect_url'] === 'string' || data['redirect_url'] instanceof String)) {
+        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['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']);
+      }
+      // validate the optional field `defaults`
+      if (data['defaults']) {
+        // data not null
+        _TemplateDefaultsInput["default"].validateJSON(data['defaults']);
+      }
+      if (data['field_dependencies']) {
+        // data not null
+        // ensure the json data is an array
+        if (!Array.isArray(data['field_dependencies'])) {
+          throw new Error("Expected the field `field_dependencies` to be an array in the JSON data but got " + data['field_dependencies']);
+        }
+        // validate the optional field `field_dependencies` (array)
+        var _iterator = _createForOfIteratorHelper(data['field_dependencies']),
+          _step;
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var item = _step.value;
+            _TemplateFieldDependencyInput["default"].validateJSON(item);
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.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']);
+      }
+      // ensure the json data is a string
+      if (data['scss'] && !(typeof data['scss'] === 'string' || data['scss'] instanceof String)) {
+        throw new Error("Expected the field `scss` to be a primitive type in the JSON string but got " + data['scss']);
+      }
+      // ensure the json data is a string
+      if (data['header_html'] && !(typeof data['header_html'] === 'string' || data['header_html'] instanceof String)) {
+        throw new Error("Expected the field `header_html` to be a primitive type in the JSON string but got " + data['header_html']);
+      }
+      // ensure the json data is a string
+      if (data['footer_html'] && !(typeof data['footer_html'] === 'string' || data['footer_html'] instanceof String)) {
+        throw new Error("Expected the field `footer_html` to be a primitive type in the JSON string but got " + data['footer_html']);
+      }
+      // validate the optional field `html_engine_options`
+      if (data['html_engine_options']) {
+        // data not null
+        _HtmlEngineOptionsInput["default"].validateJSON(data['html_engine_options']);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * The template's name.
+ * @member {String} name
+ */
+UpdateTemplateRequest.prototype['name'] = undefined;
+
+/**
+ * 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.
+ * @member {String} description
+ */
+UpdateTemplateRequest.prototype['description'] = undefined;
+
+/**
+ * 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.
+ * @member {String} parent_folder_id
+ */
+UpdateTemplateRequest.prototype['parent_folder_id'] = undefined;
+
+/**
+ * A locked template can't be changed or deleted until it's unlocked (`locked` can always be changed).
+ * @member {Boolean} locked
+ */
+UpdateTemplateRequest.prototype['locked'] = undefined;
+
+/**
+ * Print the submission ID in the footer of each page of PDFs signed through signature requests.
+ * @member {Boolean} add_signature_request_submission_id_footers
+ */
+UpdateTemplateRequest.prototype['add_signature_request_submission_id_footers'] = undefined;
+
+/**
+ * The language AI field setup names fields in: `auto` uses the form's language when it's written in the Latin alphabet without accents, and English otherwise; `english` always uses English; `form_language` uses the form's language and script. New templates take it from your account's template settings. Null for HTML templates.
+ * @member {module:model/AiFieldNamingLanguage} ai_field_naming_language
+ */
+UpdateTemplateRequest.prototype['ai_field_naming_language'] = undefined;
+
+/**
+ * Accept submission data with properties that aren't fields of the template.
+ * @member {Boolean} allow_additional_properties
+ */
+UpdateTemplateRequest.prototype['allow_additional_properties'] = undefined;
+
+/**
+ * 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.
+ * @member {Boolean} allow_skipping_optional_fields
+ */
+UpdateTemplateRequest.prototype['allow_skipping_optional_fields'] = undefined;
+
+/**
+ * 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.
+ * @member {module:model/TemplateFormMode} default_form_mode
+ */
+UpdateTemplateRequest.prototype['default_form_mode'] = undefined;
+
+/**
+ * Generate PDFs whose text and check fields stay fillable ("Generate Editable PDFs"). A submission's `editable` overrides it.
+ * @member {Boolean} editable_submissions
+ */
+UpdateTemplateRequest.prototype['editable_submissions'] = undefined;
+
+/**
+ * The sites where the template's signature requests, forms and embedded template editor can be loaded: 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). When it's empty, live signature requests don't load on any site, and the embedded template editor loads on every site.
+ * @member {Array.<String>} embed_domains
+ */
+UpdateTemplateRequest.prototype['embed_domains'] = undefined;
+
+/**
+ * Allow the embedded template editor to change sensitive template settings (webhooks, redirect URL, encryption, public access, expiration and so on).
+ * @member {Boolean} embed_edit_allow_settings
+ */
+UpdateTemplateRequest.prototype['embed_edit_allow_settings'] = undefined;
+
+/**
+ * Allow the embedded template editor to publish, restore, compare and delete published versions.
+ * @member {Boolean} embed_edit_allow_versioning
+ */
+UpdateTemplateRequest.prototype['embed_edit_allow_versioning'] = undefined;
+
+/**
+ * Allow the embedded template editor to replace the template's PDF.
+ * @member {Boolean} embed_edit_allow_document_replacement
+ */
+UpdateTemplateRequest.prototype['embed_edit_allow_document_replacement'] = undefined;
+
+/**
+ * Encrypt generated PDFs with `encrypt_pdfs_password`.
+ * @member {Boolean} encrypt_pdfs
+ */
+UpdateTemplateRequest.prototype['encrypt_pdfs'] = undefined;
+
+/**
+ * The password that opens encrypted PDFs. It's never returned; `has_encrypt_pdfs_password` says if it's set.
+ * @member {String} encrypt_pdfs_password
+ */
+UpdateTemplateRequest.prototype['encrypt_pdfs_password'] = undefined;
+
+/**
+ * Delete each submission's data and PDF after `expire_after` `expiration_interval`.
+ * @member {Boolean} expire_submissions
+ */
+UpdateTemplateRequest.prototype['expire_submissions'] = undefined;
+
+/**
+ * How many `expiration_interval`s a submission's data and PDF are kept for, when `expire_submissions` is on. At most 5256000 (10 years in minutes).
+ * @member {Number} expire_after
+ */
+UpdateTemplateRequest.prototype['expire_after'] = undefined;
+
+/**
+ * The unit of `expire_after`.
+ * @member {module:model/ExpirationInterval} expiration_interval
+ */
+UpdateTemplateRequest.prototype['expiration_interval'] = undefined;
+
+/**
+ * Add the audit trail to the end of PDFs signed through signature requests.
+ * @member {Boolean} merge_audit_trail_pdf
+ */
+UpdateTemplateRequest.prototype['merge_audit_trail_pdf'] = undefined;
+
+/**
+ * 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.
+ * @member {Boolean} parse_dates_using_template_date_format
+ */
+UpdateTemplateRequest.prototype['parse_dates_using_template_date_format'] = undefined;
+
+/**
+ * Allow anyone with a submission's ID to download its PDF.
+ * @member {Boolean} public_submissions
+ */
+UpdateTemplateRequest.prototype['public_submissions'] = undefined;
+
+/**
+ * Allow anyone to fill in the template's web form.
+ * @member {Boolean} public_web_form
+ */
+UpdateTemplateRequest.prototype['public_web_form'] = undefined;
+
+/**
+ * Where the web form sends people after they submit it.
+ * @member {String} redirect_url
+ */
+UpdateTemplateRequest.prototype['redirect_url'] = 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
+ */
+UpdateTemplateRequest.prototype['slack_webhook_url'] = undefined;
+
+/**
+ * The default style of the template's fields. Setting it replaces the whole object.
+ * @member {module:model/TemplateDefaultsInput} defaults
+ */
+UpdateTemplateRequest.prototype['defaults'] = undefined;
+
+/**
+ * The template's conditional logic rules. Setting them replaces all of the rules.
+ * @member {Array.<module:model/TemplateFieldDependencyInput>} field_dependencies
+ */
+UpdateTemplateRequest.prototype['field_dependencies'] = undefined;
+
+/**
+ * The HTML of an HTML template, as a Liquid template. Null for PDF templates.
+ * @member {String} html
+ */
+UpdateTemplateRequest.prototype['html'] = undefined;
+
+/**
+ * The SCSS of an HTML template.
+ * @member {String} scss
+ */
+UpdateTemplateRequest.prototype['scss'] = undefined;
+
+/**
+ * The HTML printed at the top of each page of an HTML template.
+ * @member {String} header_html
+ */
+UpdateTemplateRequest.prototype['header_html'] = undefined;
+
+/**
+ * The HTML printed at the bottom of each page of an HTML template.
+ * @member {String} footer_html
+ */
+UpdateTemplateRequest.prototype['footer_html'] = undefined;
+
+/**
+ * Null resets the options to their defaults.
+ * @member {module:model/HtmlEngineOptionsInput} html_engine_options
+ */
+UpdateTemplateRequest.prototype['html_engine_options'] = undefined;
+var _default = exports["default"] = UpdateTemplateRequest;

package/dist/model/UpdateWebhookRequest.js

@@ -0,0 +1,209 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _WebhookEventType = _interopRequireDefault(require("./WebhookEventType"));
+var _WebhookMode = _interopRequireDefault(require("./WebhookMode"));
+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 _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 programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or 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.
+ *
+ */
+/**
+ * The UpdateWebhookRequest model module.
+ * @module model/UpdateWebhookRequest
+ * @version 4.0.0
+ */
+var UpdateWebhookRequest = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>UpdateWebhookRequest</code>.
+   * The settings to change. Properties left out keep their values.
+   * @alias module:model/UpdateWebhookRequest
+   */
+  function UpdateWebhookRequest() {
+    _classCallCheck(this, UpdateWebhookRequest);
+    UpdateWebhookRequest.initialize(this);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(UpdateWebhookRequest, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>UpdateWebhookRequest</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/UpdateWebhookRequest} obj Optional instance to populate.
+     * @return {module:model/UpdateWebhookRequest} The populated <code>UpdateWebhookRequest</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new UpdateWebhookRequest();
+        if (data.hasOwnProperty('name')) {
+          obj['name'] = _ApiClient["default"].convertToType(data['name'], 'String');
+        }
+        if (data.hasOwnProperty('url')) {
+          obj['url'] = _ApiClient["default"].convertToType(data['url'], 'String');
+        }
+        if (data.hasOwnProperty('enabled')) {
+          obj['enabled'] = _ApiClient["default"].convertToType(data['enabled'], 'Boolean');
+        }
+        if (data.hasOwnProperty('event_types')) {
+          obj['event_types'] = _ApiClient["default"].convertToType(data['event_types'], [_WebhookEventType["default"]]);
+        }
+        if (data.hasOwnProperty('mode')) {
+          obj['mode'] = _ApiClient["default"].convertToType(data['mode'], _WebhookMode["default"]);
+        }
+        if (data.hasOwnProperty('api_token_ids')) {
+          obj['api_token_ids'] = _ApiClient["default"].convertToType(data['api_token_ids'], ['String']);
+        }
+        if (data.hasOwnProperty('template_ids')) {
+          obj['template_ids'] = _ApiClient["default"].convertToType(data['template_ids'], ['String']);
+        }
+        if (data.hasOwnProperty('folder_ids')) {
+          obj['folder_ids'] = _ApiClient["default"].convertToType(data['folder_ids'], ['String']);
+        }
+        if (data.hasOwnProperty('include_submission_data')) {
+          obj['include_submission_data'] = _ApiClient["default"].convertToType(data['include_submission_data'], 'Boolean');
+        }
+        if (data.hasOwnProperty('strip_fields')) {
+          obj['strip_fields'] = _ApiClient["default"].convertToType(data['strip_fields'], ['String']);
+        }
+        if (data.hasOwnProperty('headers')) {
+          obj['headers'] = _ApiClient["default"].convertToType(data['headers'], {
+            'String': 'String'
+          });
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>UpdateWebhookRequest</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>UpdateWebhookRequest</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data['name'] && !(typeof data['name'] === 'string' || data['name'] instanceof String)) {
+        throw new Error("Expected the field `name` to be a primitive type in the JSON string but got " + data['name']);
+      }
+      // ensure the json data is a string
+      if (data['url'] && !(typeof data['url'] === 'string' || data['url'] instanceof String)) {
+        throw new Error("Expected the field `url` to be a primitive type in the JSON string but got " + data['url']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['event_types'])) {
+        throw new Error("Expected the field `event_types` to be an array in the JSON data but got " + data['event_types']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['api_token_ids'])) {
+        throw new Error("Expected the field `api_token_ids` to be an array in the JSON data but got " + data['api_token_ids']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['template_ids'])) {
+        throw new Error("Expected the field `template_ids` to be an array in the JSON data but got " + data['template_ids']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['folder_ids'])) {
+        throw new Error("Expected the field `folder_ids` to be an array in the JSON data but got " + data['folder_ids']);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data['strip_fields'])) {
+        throw new Error("Expected the field `strip_fields` to be an array in the JSON data but got " + data['strip_fields']);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * A name for the webhook, shown in the dashboard.
+ * @member {String} name
+ */
+UpdateWebhookRequest.prototype['name'] = undefined;
+
+/**
+ * The endpoint that receives webhook POST requests.
+ * @member {String} url
+ */
+UpdateWebhookRequest.prototype['url'] = undefined;
+
+/**
+ * Whether DocSpring sends events to the webhook. Webhooks are disabled after repeated failures.
+ * @member {Boolean} enabled
+ */
+UpdateWebhookRequest.prototype['enabled'] = undefined;
+
+/**
+ * The events the webhook subscribes to. A webhook made in the dashboard can also subscribe to API token, account integration and user events, which are listed with their own names.
+ * @member {Array.<module:model/WebhookEventType>} event_types
+ */
+UpdateWebhookRequest.prototype['event_types'] = undefined;
+
+/**
+ * Only send events for test or live submissions. Null sends both.
+ * @member {module:model/WebhookMode} mode
+ */
+UpdateWebhookRequest.prototype['mode'] = undefined;
+
+/**
+ * Only send events from these API tokens. Combined with the other scope lists using OR. Applies to submission, signature request, combined PDF, submission batch and custom file events.
+ * @member {Array.<String>} api_token_ids
+ */
+UpdateWebhookRequest.prototype['api_token_ids'] = undefined;
+
+/**
+ * Only send events for these templates. Combined with the other scope lists using OR. Applies to submission, signature request and template events.
+ * @member {Array.<String>} template_ids
+ */
+UpdateWebhookRequest.prototype['template_ids'] = undefined;
+
+/**
+ * Only send events for templates in these folders, including their subfolders. Combined with the other scope lists using OR. Applies to submission, signature request, template and folder events.
+ * @member {Array.<String>} folder_ids
+ */
+UpdateWebhookRequest.prototype['folder_ids'] = undefined;
+
+/**
+ * Include the submission's field data in the payload. When false, the submission's data and truncated_text, and each signature request's data, ip_address and user_agent, are null.
+ * @member {Boolean} include_submission_data
+ */
+UpdateWebhookRequest.prototype['include_submission_data'] = undefined;
+
+/**
+ * Dot-separated paths to remove from the event's data object. Form fields live under `data` (`data.ssn` removes the ssn field). A bare name removes a top-level key (`metadata` removes the whole metadata object).
+ * @member {Array.<String>} strip_fields
+ */
+UpdateWebhookRequest.prototype['strip_fields'] = undefined;
+
+/**
+ * Headers to send with each request.
+ * @member {Object.<String, String>} headers
+ */
+UpdateWebhookRequest.prototype['headers'] = undefined;
+var _default = exports["default"] = UpdateWebhookRequest;