@blues-inc/notehub-js 6.2.0-beta.6 → 6.2.0-beta.61

package/dist/model/JobDefinition.js

@@ -0,0 +1,146 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _BatchJobRequests = _interopRequireDefault(require("./BatchJobRequests"));
+var _JobDefinitionReportOptions = _interopRequireDefault(require("./JobDefinitionReportOptions"));
+var _JobDefinitionSelect = _interopRequireDefault(require("./JobDefinitionSelect"));
+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, 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); } /**
+ * Notehub API
+ * The OpenAPI definition for the Notehub.io API.
+ *
+ * The version of the OpenAPI document: 1.2.0
+ * Contact: engineering@blues.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The JobDefinition model module.
+ * @module model/JobDefinition
+ * @version 6.2.0-beta.61
+ */
+var JobDefinition = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>JobDefinition</code>.
+   * Batch job definition
+   * @alias module:model/JobDefinition
+   */
+  function JobDefinition() {
+    _classCallCheck(this, JobDefinition);
+    JobDefinition.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(JobDefinition, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>JobDefinition</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/JobDefinition} obj Optional instance to populate.
+     * @return {module:model/JobDefinition} The populated <code>JobDefinition</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new JobDefinition();
+        if (data.hasOwnProperty("comment")) {
+          obj["comment"] = _ApiClient["default"].convertToType(data["comment"], "String");
+        }
+        if (data.hasOwnProperty("default_requests")) {
+          obj["default_requests"] = _BatchJobRequests["default"].constructFromObject(data["default_requests"]);
+        }
+        if (data.hasOwnProperty("device_requests")) {
+          obj["device_requests"] = _ApiClient["default"].convertToType(data["device_requests"], {
+            String: _BatchJobRequests["default"]
+          });
+        }
+        if (data.hasOwnProperty("report_options")) {
+          obj["report_options"] = _JobDefinitionReportOptions["default"].constructFromObject(data["report_options"]);
+        }
+        if (data.hasOwnProperty("select")) {
+          obj["select"] = _JobDefinitionSelect["default"].constructFromObject(data["select"]);
+        }
+      } else if (data === null) {
+        return null;
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>JobDefinition</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>JobDefinition</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data["comment"] && !(typeof data["comment"] === "string" || data["comment"] instanceof String)) {
+        throw new Error("Expected the field `comment` to be a primitive type in the JSON string but got " + data["comment"]);
+      }
+      // validate the optional field `default_requests`
+      if (data["default_requests"]) {
+        // data not null
+        _BatchJobRequests["default"].validateJSON(data["default_requests"]);
+      }
+      // validate the optional field `report_options`
+      if (data["report_options"]) {
+        // data not null
+        _JobDefinitionReportOptions["default"].validateJSON(data["report_options"]);
+      }
+      // validate the optional field `select`
+      if (data["select"]) {
+        // data not null
+        _JobDefinitionSelect["default"].validateJSON(data["select"]);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * Human-readable description of the job
+ * @member {String} comment
+ */
+JobDefinition.prototype["comment"] = undefined;
+
+/**
+ * @member {module:model/BatchJobRequests} default_requests
+ */
+JobDefinition.prototype["default_requests"] = undefined;
+
+/**
+ * Device-specific request overrides, keyed by device UID
+ * @member {Object.<String, module:model/BatchJobRequests>} device_requests
+ */
+JobDefinition.prototype["device_requests"] = undefined;
+
+/**
+ * @member {module:model/JobDefinitionReportOptions} report_options
+ */
+JobDefinition.prototype["report_options"] = undefined;
+
+/**
+ * @member {module:model/JobDefinitionSelect} select
+ */
+JobDefinition.prototype["select"] = undefined;
+var _default = exports["default"] = JobDefinition;

package/dist/model/JobDefinitionReportOptions.js

@@ -0,0 +1,155 @@
+"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 _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); } /**
+ * Notehub API
+ * The OpenAPI definition for the Notehub.io API.
+ *
+ * The version of the OpenAPI document: 1.2.0
+ * Contact: engineering@blues.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The JobDefinitionReportOptions model module.
+ * @module model/JobDefinitionReportOptions
+ * @version 6.2.0-beta.61
+ */
+var JobDefinitionReportOptions = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>JobDefinitionReportOptions</code>.
+   * Controls what data is included in the job report
+   * @alias module:model/JobDefinitionReportOptions
+   */
+  function JobDefinitionReportOptions() {
+    _classCallCheck(this, JobDefinitionReportOptions);
+    JobDefinitionReportOptions.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(JobDefinitionReportOptions, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>JobDefinitionReportOptions</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/JobDefinitionReportOptions} obj Optional instance to populate.
+     * @return {module:model/JobDefinitionReportOptions} The populated <code>JobDefinitionReportOptions</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new JobDefinitionReportOptions();
+        if (data.hasOwnProperty("app_fleets")) {
+          obj["app_fleets"] = _ApiClient["default"].convertToType(data["app_fleets"], "Boolean");
+        }
+        if (data.hasOwnProperty("app_info")) {
+          obj["app_info"] = _ApiClient["default"].convertToType(data["app_info"], "Boolean");
+        }
+        if (data.hasOwnProperty("app_vars")) {
+          obj["app_vars"] = _ApiClient["default"].convertToType(data["app_vars"], "Boolean");
+        }
+        if (data.hasOwnProperty("comment")) {
+          obj["comment"] = _ApiClient["default"].convertToType(data["comment"], "String");
+        }
+        if (data.hasOwnProperty("device_activity")) {
+          obj["device_activity"] = _ApiClient["default"].convertToType(data["device_activity"], "Boolean");
+        }
+        if (data.hasOwnProperty("device_health")) {
+          obj["device_health"] = _ApiClient["default"].convertToType(data["device_health"], "Boolean");
+        }
+        if (data.hasOwnProperty("device_info")) {
+          obj["device_info"] = _ApiClient["default"].convertToType(data["device_info"], "Boolean");
+        }
+        if (data.hasOwnProperty("device_vars")) {
+          obj["device_vars"] = _ApiClient["default"].convertToType(data["device_vars"], "Boolean");
+        }
+      } else if (data === null) {
+        return null;
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>JobDefinitionReportOptions</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>JobDefinitionReportOptions</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data["comment"] && !(typeof data["comment"] === "string" || data["comment"] instanceof String)) {
+        throw new Error("Expected the field `comment` to be a primitive type in the JSON string but got " + data["comment"]);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * Include project fleets in the report
+ * @member {Boolean} app_fleets
+ */
+JobDefinitionReportOptions.prototype["app_fleets"] = undefined;
+
+/**
+ * Include project info in the report
+ * @member {Boolean} app_info
+ */
+JobDefinitionReportOptions.prototype["app_info"] = undefined;
+
+/**
+ * Include project environment variables in the report
+ * @member {Boolean} app_vars
+ */
+JobDefinitionReportOptions.prototype["app_vars"] = undefined;
+
+/**
+ * @member {String} comment
+ */
+JobDefinitionReportOptions.prototype["comment"] = undefined;
+
+/**
+ * Include device activity data in the report
+ * @member {Boolean} device_activity
+ */
+JobDefinitionReportOptions.prototype["device_activity"] = undefined;
+
+/**
+ * Include device health data in the report
+ * @member {Boolean} device_health
+ */
+JobDefinitionReportOptions.prototype["device_health"] = undefined;
+
+/**
+ * Include device info in the report
+ * @member {Boolean} device_info
+ */
+JobDefinitionReportOptions.prototype["device_info"] = undefined;
+
+/**
+ * Include device environment variables in the report
+ * @member {Boolean} device_vars
+ */
+JobDefinitionReportOptions.prototype["device_vars"] = undefined;
+var _default = exports["default"] = JobDefinitionReportOptions;

package/dist/model/JobDefinitionSelect.js

@@ -0,0 +1,140 @@
+"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 _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); } /**
+ * Notehub API
+ * The OpenAPI definition for the Notehub.io API.
+ *
+ * The version of the OpenAPI document: 1.2.0
+ * Contact: engineering@blues.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The JobDefinitionSelect model module.
+ * @module model/JobDefinitionSelect
+ * @version 6.2.0-beta.61
+ */
+var JobDefinitionSelect = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>JobDefinitionSelect</code>.
+   * Device selection criteria
+   * @alias module:model/JobDefinitionSelect
+   */
+  function JobDefinitionSelect() {
+    _classCallCheck(this, JobDefinitionSelect);
+    JobDefinitionSelect.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(JobDefinitionSelect, null, [{
+    key: "initialize",
+    value: function initialize(obj) {}
+
+    /**
+     * Constructs a <code>JobDefinitionSelect</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/JobDefinitionSelect} obj Optional instance to populate.
+     * @return {module:model/JobDefinitionSelect} The populated <code>JobDefinitionSelect</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new JobDefinitionSelect();
+        if (data.hasOwnProperty("all_devices")) {
+          obj["all_devices"] = _ApiClient["default"].convertToType(data["all_devices"], "Boolean");
+        }
+        if (data.hasOwnProperty("comment")) {
+          obj["comment"] = _ApiClient["default"].convertToType(data["comment"], "String");
+        }
+        if (data.hasOwnProperty("devices")) {
+          obj["devices"] = _ApiClient["default"].convertToType(data["devices"], ["String"]);
+        }
+        if (data.hasOwnProperty("devices_by_sn")) {
+          obj["devices_by_sn"] = _ApiClient["default"].convertToType(data["devices_by_sn"], ["String"]);
+        }
+        if (data.hasOwnProperty("devices_in_fleets")) {
+          obj["devices_in_fleets"] = _ApiClient["default"].convertToType(data["devices_in_fleets"], ["String"]);
+        }
+      } else if (data === null) {
+        return null;
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>JobDefinitionSelect</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>JobDefinitionSelect</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // ensure the json data is a string
+      if (data["comment"] && !(typeof data["comment"] === "string" || data["comment"] instanceof String)) {
+        throw new Error("Expected the field `comment` to be a primitive type in the JSON string but got " + data["comment"]);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data["devices"])) {
+        throw new Error("Expected the field `devices` to be an array in the JSON data but got " + data["devices"]);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data["devices_by_sn"])) {
+        throw new Error("Expected the field `devices_by_sn` to be an array in the JSON data but got " + data["devices_by_sn"]);
+      }
+      // ensure the json data is an array
+      if (!Array.isArray(data["devices_in_fleets"])) {
+        throw new Error("Expected the field `devices_in_fleets` to be an array in the JSON data but got " + data["devices_in_fleets"]);
+      }
+      return true;
+    }
+  }]);
+}();
+/**
+ * Select all devices in the project
+ * @member {Boolean} all_devices
+ */
+JobDefinitionSelect.prototype["all_devices"] = undefined;
+
+/**
+ * @member {String} comment
+ */
+JobDefinitionSelect.prototype["comment"] = undefined;
+
+/**
+ * Specific device UIDs to include
+ * @member {Array.<String>} devices
+ */
+JobDefinitionSelect.prototype["devices"] = undefined;
+
+/**
+ * Serial number patterns to match (supports glob wildcards *, ?, [...])
+ * @member {Array.<String>} devices_by_sn
+ */
+JobDefinitionSelect.prototype["devices_by_sn"] = undefined;
+
+/**
+ * Fleet UIDs whose devices should be included
+ * @member {Array.<String>} devices_in_fleets
+ */
+JobDefinitionSelect.prototype["devices_in_fleets"] = undefined;
+var _default = exports["default"] = JobDefinitionSelect;