@blues-inc/notehub-js 6.7.0-beta.2 → 6.7.0-beta.20

package/dist/api/ProjectApi.js

@@ -56,7 +56,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * Project service.
  * @module api/ProjectApi
- * @version 6.7.0-beta.2
+ * @version 6.7.0-beta.20
  */
 var ProjectApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -1046,23 +1046,24 @@ var ProjectApi = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Get host or Notecard DFU history for all devices that match the filter criteria
+     * Get host or Notecard DFU history for all devices that match the filter criteria. With a `cursor`, changes made through fleet or project firmware settings will not appear until the device itself is next updated.
      * @param {String} projectOrProductUID
      * @param {module:model/String} firmwareType
      * @param {Object} opts Optional parameters
      * @param {Number} opts.pageSize  (default to 50)
      * @param {Number} opts.pageNum  (default to 1)
+     * @param {String} opts.cursor If supplied, the results will be returned in ascending order of modification time. To start from a specific time, specify cursor as Unix epoch microseconds (UTC) or 0 to start from the beginning. Or, to start where the last search left off, set cursor to the returned value of next_cursor (or the X-Next-Cursor header).
      * @param {module:model/String} opts.sortBy  (default to 'captured')
      * @param {module:model/String} opts.sortOrder  (default to 'asc')
-     * @param {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.tag Tag filter
-     * @param {Array.<String>} opts.serialNumber Serial number filter
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.tag Tag filter. Matches the whole tag, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally. For example, `51*` matches tags starting with `51`.
+     * @param {Array.<String>} opts.serialNumber Serial number filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @param {String} opts.fleetUID
-     * @param {Array.<String>} opts.notecardFirmware Firmware version filter
-     * @param {Array.<String>} opts.location Location filter
-     * @param {Array.<String>} opts.hostFirmware Host firmware filter
-     * @param {Array.<String>} opts.productUID
-     * @param {Array.<String>} opts.sku SKU filter
+     * @param {Array.<String>} opts.notecardFirmware Firmware version filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.location Location filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.hostFirmware Host firmware filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.productUID ProductUID filter. Matches any value containing the filter text, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.sku SKU filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeviceDfuHistoryPage} and HTTP response
      */
   }, {
@@ -1085,6 +1086,7 @@ var ProjectApi = exports["default"] = /*#__PURE__*/function () {
       var queryParams = {
         pageSize: opts["pageSize"],
         pageNum: opts["pageNum"],
+        cursor: opts["cursor"],
         sortBy: opts["sortBy"],
         sortOrder: opts["sortOrder"],
         deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
@@ -1107,23 +1109,24 @@ var ProjectApi = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Get host or Notecard DFU history for all devices that match the filter criteria
+     * Get host or Notecard DFU history for all devices that match the filter criteria. With a `cursor`, changes made through fleet or project firmware settings will not appear until the device itself is next updated.
      * @param {String} projectOrProductUID
      * @param {module:model/String} firmwareType
      * @param {Object} opts Optional parameters
      * @param {Number} opts.pageSize  (default to 50)
      * @param {Number} opts.pageNum  (default to 1)
+     * @param {String} opts.cursor If supplied, the results will be returned in ascending order of modification time. To start from a specific time, specify cursor as Unix epoch microseconds (UTC) or 0 to start from the beginning. Or, to start where the last search left off, set cursor to the returned value of next_cursor (or the X-Next-Cursor header).
      * @param {module:model/String} opts.sortBy  (default to 'captured')
      * @param {module:model/String} opts.sortOrder  (default to 'asc')
-     * @param {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.tag Tag filter
-     * @param {Array.<String>} opts.serialNumber Serial number filter
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.tag Tag filter. Matches the whole tag, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally. For example, `51*` matches tags starting with `51`.
+     * @param {Array.<String>} opts.serialNumber Serial number filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @param {String} opts.fleetUID
-     * @param {Array.<String>} opts.notecardFirmware Firmware version filter
-     * @param {Array.<String>} opts.location Location filter
-     * @param {Array.<String>} opts.hostFirmware Host firmware filter
-     * @param {Array.<String>} opts.productUID
-     * @param {Array.<String>} opts.sku SKU filter
+     * @param {Array.<String>} opts.notecardFirmware Firmware version filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.location Location filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.hostFirmware Host firmware filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.productUID ProductUID filter. Matches any value containing the filter text, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.sku SKU filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeviceDfuHistoryPage}
      */
   }, {
@@ -1135,23 +1138,24 @@ var ProjectApi = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Get host or Notecard DFU history for all devices that match the filter criteria
+     * Get host or Notecard DFU history for all devices that match the filter criteria. With a `cursor`, changes made through fleet or project firmware settings will not appear until the device itself is next updated.
      * @param {String} projectOrProductUID
      * @param {module:model/String} firmwareType
      * @param {Object} opts Optional parameters
      * @param {Number} opts.pageSize  (default to 50)
      * @param {Number} opts.pageNum  (default to 1)
+     * @param {String} opts.cursor If supplied, the results will be returned in ascending order of modification time. To start from a specific time, specify cursor as Unix epoch microseconds (UTC) or 0 to start from the beginning. Or, to start where the last search left off, set cursor to the returned value of next_cursor (or the X-Next-Cursor header).
      * @param {module:model/String} opts.sortBy  (default to 'captured')
      * @param {module:model/String} opts.sortOrder  (default to 'asc')
-     * @param {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.tag Tag filter
-     * @param {Array.<String>} opts.serialNumber Serial number filter
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.tag Tag filter. Matches the whole tag, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally. For example, `51*` matches tags starting with `51`.
+     * @param {Array.<String>} opts.serialNumber Serial number filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @param {String} opts.fleetUID
-     * @param {Array.<String>} opts.notecardFirmware Firmware version filter
-     * @param {Array.<String>} opts.location Location filter
-     * @param {Array.<String>} opts.hostFirmware Host firmware filter
-     * @param {Array.<String>} opts.productUID
-     * @param {Array.<String>} opts.sku SKU filter
+     * @param {Array.<String>} opts.notecardFirmware Firmware version filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.location Location filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.hostFirmware Host firmware filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.productUID ProductUID filter. Matches any value containing the filter text, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.sku SKU filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeviceDfuStatusPage} and HTTP response
      */
   }, {
@@ -1174,6 +1178,7 @@ var ProjectApi = exports["default"] = /*#__PURE__*/function () {
       var queryParams = {
         pageSize: opts["pageSize"],
         pageNum: opts["pageNum"],
+        cursor: opts["cursor"],
         sortBy: opts["sortBy"],
         sortOrder: opts["sortOrder"],
         deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
@@ -1196,23 +1201,24 @@ var ProjectApi = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Get host or Notecard DFU history for all devices that match the filter criteria
+     * Get host or Notecard DFU history for all devices that match the filter criteria. With a `cursor`, changes made through fleet or project firmware settings will not appear until the device itself is next updated.
      * @param {String} projectOrProductUID
      * @param {module:model/String} firmwareType
      * @param {Object} opts Optional parameters
      * @param {Number} opts.pageSize  (default to 50)
      * @param {Number} opts.pageNum  (default to 1)
+     * @param {String} opts.cursor If supplied, the results will be returned in ascending order of modification time. To start from a specific time, specify cursor as Unix epoch microseconds (UTC) or 0 to start from the beginning. Or, to start where the last search left off, set cursor to the returned value of next_cursor (or the X-Next-Cursor header).
      * @param {module:model/String} opts.sortBy  (default to 'captured')
      * @param {module:model/String} opts.sortOrder  (default to 'asc')
-     * @param {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.tag Tag filter
-     * @param {Array.<String>} opts.serialNumber Serial number filter
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.tag Tag filter. Matches the whole tag, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally. For example, `51*` matches tags starting with `51`.
+     * @param {Array.<String>} opts.serialNumber Serial number filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @param {String} opts.fleetUID
-     * @param {Array.<String>} opts.notecardFirmware Firmware version filter
-     * @param {Array.<String>} opts.location Location filter
-     * @param {Array.<String>} opts.hostFirmware Host firmware filter
-     * @param {Array.<String>} opts.productUID
-     * @param {Array.<String>} opts.sku SKU filter
+     * @param {Array.<String>} opts.notecardFirmware Firmware version filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.location Location filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.hostFirmware Host firmware filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.productUID ProductUID filter. Matches any value containing the filter text, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.sku SKU filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeviceDfuStatusPage}
      */
   }, {
@@ -1819,15 +1825,15 @@ var ProjectApi = exports["default"] = /*#__PURE__*/function () {
      * @param {module:model/String} firmwareType
      * @param {module:model/String} action
      * @param {Object} opts Optional parameters
-     * @param {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.tag Tag filter
-     * @param {Array.<String>} opts.serialNumber Serial number filter
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.tag Tag filter. Matches the whole tag, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally. For example, `51*` matches tags starting with `51`.
+     * @param {Array.<String>} opts.serialNumber Serial number filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @param {String} opts.fleetUID
-     * @param {Array.<String>} opts.notecardFirmware Firmware version filter
-     * @param {Array.<String>} opts.location Location filter
-     * @param {Array.<String>} opts.hostFirmware Host firmware filter
-     * @param {Array.<String>} opts.productUID
-     * @param {Array.<String>} opts.sku SKU filter
+     * @param {Array.<String>} opts.notecardFirmware Firmware version filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.location Location filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.hostFirmware Host firmware filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.productUID ProductUID filter. Matches any value containing the filter text, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.sku SKU filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @param {module:model/DfuActionRequest} opts.dfuActionRequest Which firmware in the case of an update action
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
@@ -1879,15 +1885,15 @@ var ProjectApi = exports["default"] = /*#__PURE__*/function () {
      * @param {module:model/String} firmwareType
      * @param {module:model/String} action
      * @param {Object} opts Optional parameters
-     * @param {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.tag Tag filter
-     * @param {Array.<String>} opts.serialNumber Serial number filter
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.tag Tag filter. Matches the whole tag, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally. For example, `51*` matches tags starting with `51`.
+     * @param {Array.<String>} opts.serialNumber Serial number filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @param {String} opts.fleetUID
-     * @param {Array.<String>} opts.notecardFirmware Firmware version filter
-     * @param {Array.<String>} opts.location Location filter
-     * @param {Array.<String>} opts.hostFirmware Host firmware filter
-     * @param {Array.<String>} opts.productUID
-     * @param {Array.<String>} opts.sku SKU filter
+     * @param {Array.<String>} opts.notecardFirmware Firmware version filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.location Location filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.hostFirmware Host firmware filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.productUID ProductUID filter. Matches any value containing the filter text, case-insensitive. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
+     * @param {Array.<String>} opts.sku SKU filter. Matches any value containing the filter text. Use `*` as a wildcard and `\\*` to match a literal `*`; all other characters, including `%` and `_`, match literally.
      * @param {module:model/DfuActionRequest} opts.dfuActionRequest Which firmware in the case of an update action
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */

package/dist/api/RouteApi.js

@@ -30,7 +30,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * Route service.
  * @module api/RouteApi
- * @version 6.7.0-beta.2
+ * @version 6.7.0-beta.20
  */
 var RouteApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -183,13 +183,14 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Get Route Logs by Route UID
+     * Get Route Logs by 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)
-     * @param {Array.<String>} opts.deviceUID A Device UID.
+     * @param {String} opts.cursor If supplied, the results will be returned in ascending order of modification time. To start from a specific time, specify cursor as Unix epoch microseconds (UTC) or 0 to start from the beginning. Or, to start where the last search left off, set cursor to the returned value of next_cursor (or the X-Next-Cursor header).
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
      * @param {module:model/String} opts.sortBy  (default to 'date')
      * @param {module:model/String} opts.sortOrder  (default to 'desc')
      * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp
@@ -221,6 +222,7 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
       var queryParams = {
         pageSize: opts["pageSize"],
         pageNum: opts["pageNum"],
+        cursor: opts["cursor"],
         deviceUID: this.apiClient.buildCollectionParam(opts["deviceUID"], "multi"),
         sortBy: opts["sortBy"],
         sortOrder: opts["sortOrder"],
@@ -242,13 +244,14 @@ var RouteApi = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Get Route Logs by Route UID
+     * Get Route Logs by 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)
-     * @param {Array.<String>} opts.deviceUID A Device UID.
+     * @param {String} opts.cursor If supplied, the results will be returned in ascending order of modification time. To start from a specific time, specify cursor as Unix epoch microseconds (UTC) or 0 to start from the beginning. Or, to start where the last search left off, set cursor to the returned value of next_cursor (or the X-Next-Cursor header).
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
      * @param {module:model/String} opts.sortBy  (default to 'date')
      * @param {module:model/String} opts.sortOrder  (default to 'desc')
      * @param {Number} opts.startDate Start date for filtering results, specified as a Unix timestamp

package/dist/api/UsageApi.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _Error = _interopRequireDefault(require("../model/Error"));
+var _GetApiUsage200Response = _interopRequireDefault(require("../model/GetApiUsage200Response"));
 var _GetDataUsage200Response = _interopRequireDefault(require("../model/GetDataUsage200Response"));
 var _GetRouteLogsUsage200Response = _interopRequireDefault(require("../model/GetRouteLogsUsage200Response"));
 var _GetSessionsUsage200Response = _interopRequireDefault(require("../model/GetSessionsUsage200Response"));
@@ -31,7 +32,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * Usage service.
  * @module api/UsageApi
- * @version 6.7.0-beta.2
+ * @version 6.7.0-beta.20
  */
 var UsageApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -47,19 +48,78 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
   }
 
   /**
-   * Get data usage in bytes for a project with time range and period aggregation
+   * Get billable Notehub API request usage for a project, broken down by endpoint and time period, when endDate is 0 or unspecified the current time is implied. Only requests that are billed against the project's plan are counted
    * @param {String} projectOrProductUID
    * @param {module:model/String} period Period type for aggregation
    * @param {Object} opts Optional parameters
    * @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 {Array.<String>} opts.deviceUID A Device UID.
-   * @param {Array.<String>} opts.fleetUID Filter by Fleet UID
    * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
-   * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
-   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDataUsage200Response} and HTTP response
+   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetApiUsage200Response} and HTTP response
    */
   return _createClass(UsageApi, [{
+    key: "getApiUsageWithHttpInfo",
+    value: function getApiUsageWithHttpInfo(projectOrProductUID, period, opts) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getApiUsage");
+      }
+      // verify the required parameter 'period' is set
+      if (period === undefined || period === null) {
+        throw new _Error["default"]("Missing the required parameter 'period' when calling getApiUsage");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID
+      };
+      var queryParams = {
+        startDate: opts["startDate"],
+        endDate: opts["endDate"],
+        limit: opts["limit"],
+        period: period
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = [];
+      var accepts = ["application/json"];
+      var returnType = _GetApiUsage200Response["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/usage/api", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Get billable Notehub API request usage for a project, broken down by endpoint and time period, when endDate is 0 or unspecified the current time is implied. Only requests that are billed against the project's plan are counted
+     * @param {String} projectOrProductUID
+     * @param {module:model/String} period Period type for aggregation
+     * @param {Object} opts Optional parameters
+     * @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 {Number} opts.limit Limit the number of data points returned (default to 200000)
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetApiUsage200Response}
+     */
+  }, {
+    key: "getApiUsage",
+    value: function getApiUsage(projectOrProductUID, period, opts) {
+      return this.getApiUsageWithHttpInfo(projectOrProductUID, period, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Get data usage in bytes for a project with time range and period aggregation
+     * @param {String} projectOrProductUID
+     * @param {module:model/String} period Period type for aggregation
+     * @param {Object} opts Optional parameters
+     * @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 {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.fleetUID Filter by FleetUID
+     * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
+     * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetDataUsage200Response} and HTTP response
+     */
+  }, {
     key: "getDataUsageWithHttpInfo",
     value: function getDataUsageWithHttpInfo(projectOrProductUID, period, opts) {
       opts = opts || {};
@@ -100,8 +160,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @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 {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.fleetUID Filter by Fleet UID
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.fleetUID Filter by FleetUID
      * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
      * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetDataUsage200Response}
@@ -121,8 +181,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @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 {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.fleetUID Filter by Fleet UID
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.fleetUID Filter by FleetUID
      * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
      * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
      * @param {Array.<String>} opts.notefile Filter to specific notefiles
@@ -174,8 +234,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @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 {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.fleetUID Filter by Fleet UID
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.fleetUID Filter by FleetUID
      * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
      * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
      * @param {Array.<String>} opts.notefile Filter to specific notefiles
@@ -198,7 +258,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @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 {Array.<String>} opts.routeUID A Route UID.
+     * @param {Array.<String>} opts.routeUID A RouteUID.
      * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
      * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'route')
      * @param {Boolean} opts.skipRecentData When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (default to false)
@@ -245,7 +305,7 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @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 {Array.<String>} opts.routeUID A Route UID.
+     * @param {Array.<String>} opts.routeUID A RouteUID.
      * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
      * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'route')
      * @param {Boolean} opts.skipRecentData When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (default to false)
@@ -266,8 +326,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @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 {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.fleetUID Filter by Fleet UID
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.fleetUID Filter by FleetUID
      * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
      * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
      * @param {Boolean} opts.skipRecentData When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (default to false)
@@ -315,8 +375,8 @@ var UsageApi = exports["default"] = /*#__PURE__*/function () {
      * @param {Object} opts Optional parameters
      * @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 {Array.<String>} opts.deviceUID A Device UID.
-     * @param {Array.<String>} opts.fleetUID Filter by Fleet UID
+     * @param {Array.<String>} opts.deviceUID A DeviceUID.
+     * @param {Array.<String>} opts.fleetUID Filter by FleetUID
      * @param {Number} opts.limit Limit the number of data points returned (default to 200000)
      * @param {module:model/String} opts.aggregate Aggregation level for results (default to 'device')
      * @param {Boolean} opts.skipRecentData When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (default to false)

package/dist/api/WebhookApi.js

@@ -29,7 +29,7 @@ function _toPrimitive(t, e) { if ("object" != _typeof(t) || !t) return t; var r;
 /**
  * Webhook service.
  * @module api/WebhookApi
- * @version 6.7.0-beta.2
+ * @version 6.7.0-beta.20
  */
 var WebhookApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -99,7 +99,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Creates a webhook for the specified product with the given name. The name | must be unique within the project.
      * @param {String} projectOrProductUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {module:model/WebhookSettings} webhookSettings
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
@@ -136,7 +136,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Creates a webhook for the specified product with the given name. The name | must be unique within the project.
      * @param {String} projectOrProductUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {module:model/WebhookSettings} webhookSettings
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
@@ -151,7 +151,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Sends an event to be processed by the specified webhook, addressed by productUID, associated with the given device (provisioning it if necessary). The entire request body becomes the event body. The webhook's configured JSONata transform, if any, is applied before routing.
      * @param {String} productUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {String} deviceUID
      * @param {Object.<String, {String: Object}>} requestBody The event body (arbitrary JSON)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
@@ -194,7 +194,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Sends an event to be processed by the specified webhook, addressed by productUID, associated with the given device (provisioning it if necessary). The entire request body becomes the event body. The webhook's configured JSONata transform, if any, is applied before routing.
      * @param {String} productUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {String} deviceUID
      * @param {Object.<String, {String: Object}>} requestBody The event body (arbitrary JSON)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
@@ -210,7 +210,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Sends an event to be processed by the specified webhook, addressed by productUID. The entire request body becomes the event body. The webhook's configured JSONata transform, if any, is applied before routing. The event is not associated with a specific device.
      * @param {String} productUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {Object.<String, {String: Object}>} requestBody The event body (arbitrary JSON)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
@@ -247,7 +247,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Sends an event to be processed by the specified webhook, addressed by productUID. The entire request body becomes the event body. The webhook's configured JSONata transform, if any, is applied before routing. The event is not associated with a specific device.
      * @param {String} productUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {Object.<String, {String: Object}>} requestBody The event body (arbitrary JSON)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
@@ -262,7 +262,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Deletes the specified webhook
      * @param {String} projectOrProductUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
   }, {
@@ -294,7 +294,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Deletes the specified webhook
      * @param {String} projectOrProductUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
   }, {
@@ -308,7 +308,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Retrieves the configuration settings for the specified webhook
      * @param {String} projectOrProductUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/WebhookSettings} and HTTP response
      */
   }, {
@@ -340,7 +340,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Retrieves the configuration settings for the specified webhook
      * @param {String} projectOrProductUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WebhookSettings}
      */
   }, {
@@ -354,7 +354,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Retrieves the configuration settings for the specified webhook, addressed by productUID.
      * @param {String} productUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/WebhookSettings} and HTTP response
      */
   }, {
@@ -386,7 +386,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Retrieves the configuration settings for the specified webhook, addressed by productUID.
      * @param {String} productUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WebhookSettings}
      */
   }, {
@@ -490,7 +490,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Updates the configuration settings for the specified webhook. | Webhook will be created if it does not exist. Update body will completely replace the existing settings.
      * @param {String} projectOrProductUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {module:model/WebhookSettings} webhookSettings
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
@@ -527,7 +527,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Updates the configuration settings for the specified webhook. | Webhook will be created if it does not exist. Update body will completely replace the existing settings.
      * @param {String} projectOrProductUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {module:model/WebhookSettings} webhookSettings
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
@@ -542,7 +542,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Updates the configuration settings for the specified webhook, addressed by productUID. Update body will completely replace the existing settings.
      * @param {String} productUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {module:model/WebhookSettings} webhookSettings
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
      */
@@ -579,7 +579,7 @@ var WebhookApi = exports["default"] = /*#__PURE__*/function () {
     /**
      * Updates the configuration settings for the specified webhook, addressed by productUID. Update body will completely replace the existing settings.
      * @param {String} productUID
-     * @param {String} webhookUID Webhook UID
+     * @param {String} webhookUID WebhookUID
      * @param {module:model/WebhookSettings} webhookSettings
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */