@blues-inc/notehub-js 2.1.0 → 2.2.0-beta.2

package/dist/api/RouteApi.js

@@ -7,8 +7,8 @@ exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _Error = _interopRequireDefault(require("../model/Error"));
 var _NotehubRoute = _interopRequireDefault(require("../model/NotehubRoute"));
+var _NotehubRouteSummary = _interopRequireDefault(require("../model/NotehubRouteSummary"));
 var _RouteLog = _interopRequireDefault(require("../model/RouteLog"));
-var _UserDbRoute = _interopRequireDefault(require("../model/UserDbRoute"));
 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"); }
@@ -17,7 +17,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); } /**
  * Notehub API
- * The OpenAPI definition for the Notehub.io API.
+ * The OpenAPI definition for the Notehub.io API. 
  *
  * The version of the OpenAPI document: 1.2.0
  * Contact: engineering@blues.io
@@ -28,18 +28,18 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  *
  */
 /**
- * Route service.
- * @module api/RouteApi
- * @version 2.1.0
- */
+* Route service.
+* @module api/RouteApi
+* @version 2.2.0-beta.2
+*/
 var RouteApi = exports["default"] = /*#__PURE__*/function () {
   /**
-   * Constructs a new RouteApi.
-   * @alias module:api/RouteApi
-   * @class
-   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
-   * default to {@link module:ApiClient#instance} if unspecified.
-   */
+  * Constructs a new RouteApi. 
+  * @alias module:api/RouteApi
+  * @class
+  * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+  * default to {@link module:ApiClient#instance} if unspecified.
+  */
   function RouteApi(apiClient) {
     _classCallCheck(this, RouteApi);
     this.apiClient = apiClient || _ApiClient["default"].instance;
@@ -47,8 +47,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
 
   /**
    * Create Route within a Project
-   * @param {String} projectOrProductUID
-   * @param {module:model/NotehubRoute} notehubRoute Route to be Created
+   * @param {String} projectOrProductUID 
+   * @param {module:model/NotehubRoute} notehubRoute Route to be created
    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotehubRoute} and HTTP response
    */
   return _createClass(RouteApi, [{
@@ -64,22 +64,22 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'notehubRoute' when calling createRoute");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID
+        'projectOrProductUID': projectOrProductUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
-      var contentTypes = ["application/json"];
-      var accepts = ["application/json"];
+      var authNames = ['personalAccessToken'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
       var returnType = _NotehubRoute["default"];
-      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes", "POST", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+      return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
      * Create Route within a Project
-     * @param {String} projectOrProductUID
-     * @param {module:model/NotehubRoute} notehubRoute Route to be Created
+     * @param {String} projectOrProductUID 
+     * @param {module:model/NotehubRoute} notehubRoute Route to be created
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotehubRoute}
      */
   }, {
@@ -92,9 +92,9 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Delete single route within a project
-     * @param {String} projectOrProductUID
-     * @param {String} routeUID
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
+     * @param {String} projectOrProductUID 
+     * @param {String} routeUID 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
   }, {
     key: "deleteRouteWithHttpInfo",
@@ -109,24 +109,24 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'routeUID' when calling deleteRoute");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        routeUID: routeUID
+        'projectOrProductUID': projectOrProductUID,
+        'routeUID': routeUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
-      var returnType = Object;
-      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "DELETE", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+      var accepts = ['application/json'];
+      var returnType = null;
+      return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes/{routeUID}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
      * Delete single route within a project
-     * @param {String} projectOrProductUID
-     * @param {String} routeUID
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
+     * @param {String} projectOrProductUID 
+     * @param {String} routeUID 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
   }, {
     key: "deleteRoute",
@@ -138,8 +138,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Get single route within a project
-     * @param {String} projectOrProductUID
-     * @param {String} routeUID
+     * @param {String} projectOrProductUID 
+     * @param {String} routeUID 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotehubRoute} and HTTP response
      */
   }, {
@@ -155,23 +155,23 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'routeUID' when calling getRoute");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        routeUID: routeUID
+        'projectOrProductUID': projectOrProductUID,
+        'routeUID': routeUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
+      var accepts = ['application/json'];
       var returnType = _NotehubRoute["default"];
-      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+      return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes/{routeUID}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
      * Get single route within a project
-     * @param {String} projectOrProductUID
-     * @param {String} routeUID
+     * @param {String} projectOrProductUID 
+     * @param {String} routeUID 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotehubRoute}
      */
   }, {
@@ -184,8 +184,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Get Route Logs by Route UID
-     * @param {String} projectOrProductUID
-     * @param {String} routeUID
+     * @param {String} projectOrProductUID 
+     * @param {String} routeUID 
      * @param {Object} opts Optional parameters
      * @param {Number} opts.pageSize  (default to 50)
      * @param {Number} opts.pageNum  (default to 1)
@@ -194,9 +194,9 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
      * @param {module:model/String} opts.sortOrder  (default to 'desc')
      * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
      * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
-     * @param {Boolean} opts.systemFilesOnly
-     * @param {Boolean} opts.mostRecentOnly
-     * @param {String} opts.files
+     * @param {Boolean} opts.systemFilesOnly 
+     * @param {Boolean} opts.mostRecentOnly 
+     * @param {String} opts.files 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/RouteLog>} and HTTP response
      */
   }, {
@@ -213,34 +213,34 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'routeUID' when calling getRouteLogsByRoute");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        routeUID: routeUID
+        'projectOrProductUID': projectOrProductUID,
+        'routeUID': routeUID
       };
       var queryParams = {
-        pageSize: opts["pageSize"],
-        pageNum: opts["pageNum"],
-        deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
-        sortBy: opts["sortBy"],
-        sortOrder: opts["sortOrder"],
-        startDate: opts["startDate"],
-        endDate: opts["endDate"],
-        systemFilesOnly: opts["systemFilesOnly"],
-        mostRecentOnly: opts["mostRecentOnly"],
-        files: opts["files"]
+        'pageSize': opts['pageSize'],
+        'pageNum': opts['pageNum'],
+        'deviceUID': this.apiClient.buildCollectionParam(opts['deviceUID'], 'multi'),
+        'sortBy': opts['sortBy'],
+        'sortOrder': opts['sortOrder'],
+        'startDate': opts['startDate'],
+        'endDate': opts['endDate'],
+        'systemFilesOnly': opts['systemFilesOnly'],
+        'mostRecentOnly': opts['mostRecentOnly'],
+        'files': opts['files']
       };
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
+      var accepts = ['application/json'];
       var returnType = [_RouteLog["default"]];
-      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+      return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
      * Get Route Logs by Route UID
-     * @param {String} projectOrProductUID
-     * @param {String} routeUID
+     * @param {String} projectOrProductUID 
+     * @param {String} routeUID 
      * @param {Object} opts Optional parameters
      * @param {Number} opts.pageSize  (default to 50)
      * @param {Number} opts.pageNum  (default to 1)
@@ -249,9 +249,9 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
      * @param {module:model/String} opts.sortOrder  (default to 'desc')
      * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
      * @param {Number} opts.endDate End date for filtering results, specified as a Unix timestamp
-     * @param {Boolean} opts.systemFilesOnly
-     * @param {Boolean} opts.mostRecentOnly
-     * @param {String} opts.files
+     * @param {Boolean} opts.systemFilesOnly 
+     * @param {Boolean} opts.mostRecentOnly 
+     * @param {String} opts.files 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/RouteLog>}
      */
   }, {
@@ -264,8 +264,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Get all Routes within a Project
-     * @param {String} projectOrProductUID
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/UserDbRoute>} and HTTP response
+     * @param {String} projectOrProductUID 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.<module:model/NotehubRouteSummary>} and HTTP response
      */
   }, {
     key: "getRoutesWithHttpInfo",
@@ -276,22 +276,22 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getRoutes");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID
+        'projectOrProductUID': projectOrProductUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
-      var returnType = [_UserDbRoute["default"]];
-      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+      var accepts = ['application/json'];
+      var returnType = [_NotehubRouteSummary["default"]];
+      return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
      * Get all Routes within a Project
-     * @param {String} projectOrProductUID
-     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/UserDbRoute>}
+     * @param {String} projectOrProductUID 
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<module:model/NotehubRouteSummary>}
      */
   }, {
     key: "getRoutes",
@@ -303,8 +303,8 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Update route by UID
-     * @param {String} projectOrProductUID
-     * @param {String} routeUID
+     * @param {String} projectOrProductUID 
+     * @param {String} routeUID 
      * @param {module:model/NotehubRoute} notehubRoute Route settings to be updated
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/NotehubRoute} and HTTP response
      */
@@ -325,23 +325,23 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'notehubRoute' when calling updateRoute");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        routeUID: routeUID
+        'projectOrProductUID': projectOrProductUID,
+        'routeUID': routeUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
-      var contentTypes = ["application/json"];
-      var accepts = ["application/json"];
+      var authNames = ['personalAccessToken'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
       var returnType = _NotehubRoute["default"];
-      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/routes/{routeUID}", "PUT", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+      return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/routes/{routeUID}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
     }
 
     /**
      * Update route by UID
-     * @param {String} projectOrProductUID
-     * @param {String} routeUID
+     * @param {String} projectOrProductUID 
+     * @param {String} routeUID 
      * @param {module:model/NotehubRoute} notehubRoute Route settings to be updated
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/NotehubRoute}
      */