@edgeiq/edgeiq-api-js 1.0.3 → 1.1.2

package/dist/constants.d.ts

@@ -73,6 +73,7 @@ export declare const BaseEndpoints: {
     rule: string;
     secret: string;
     softwareUpdate: string;
+    stats: string;
     systemCommand: string;
     systemCommandJob: string;
     translator: string;
@@ -105,6 +106,9 @@ export declare const Endpoints: {
     rule: string;
     secret: string;
     softwareUpdate: string;
+    statsDevicesByHeartbeat: string;
+    statsDevicesByType: string;
+    statsCellUsage: string;
     systemCommand: string;
     systemCommandJob: string;
     translator: string;

package/dist/constants.js

@@ -89,6 +89,7 @@ exports.BaseEndpoints = {
     rule: 'rules',
     secret: 'secrets',
     softwareUpdate: 'software_updates',
+    stats: 'stats',
     systemCommand: 'system_commands',
     systemCommandJob: 'system_command_jobs',
     translator: 'translators',
@@ -121,10 +122,13 @@ exports.Endpoints = {
     rule: "" + exports.BaseEndpoints.rule,
     secret: "" + exports.BaseEndpoints.secret,
     softwareUpdate: "" + exports.BaseEndpoints.softwareUpdate,
+    statsDevicesByHeartbeat: exports.BaseEndpoints.stats + "/devices/count_by_heartbeat_status",
+    statsDevicesByType: exports.BaseEndpoints.stats + "/devices/count_by_type",
+    statsCellUsage: exports.BaseEndpoints.stats + "/cumulative_cell_usage",
     systemCommand: "" + exports.BaseEndpoints.systemCommand,
     systemCommandJob: "" + exports.BaseEndpoints.systemCommandJob,
     translator: "" + exports.BaseEndpoints.translator,
-    userType: "" + exports.BaseEndpoints.report,
+    userType: "" + exports.BaseEndpoints.userType,
     user: "" + exports.BaseEndpoints.user,
 };
 exports.MethodsActions = {

package/dist/devices/models.d.ts

@@ -8,7 +8,7 @@ export interface LogConfig {
     forward_level?: string;
     forward_frequency_limit?: number;
 }
-export interface GeoJsonGeometry {
+export interface Geometry {
     type: string;
     coordinates: number[];
 }
@@ -20,13 +20,14 @@ export interface GeoJsonProperties {
 }
 export interface GeoJson {
     type: string;
-    geometry: GeoJsonGeometry;
+    geometry: Geometry;
     properties: GeoJsonProperties;
 }
 export interface DeviceInput {
     name: string;
     unique_id: string;
     company_id: string;
+    serial?: string;
     device_type_id: string;
     last_report_id?: string;
     last_location_observation_id?: string;

package/dist/filtersParser.js

@@ -13,12 +13,16 @@ var parseFilters = function (filters, pagination) {
                 if (filter) {
                     if (!Array.isArray(filter)) {
                         if (filter.operator) {
-                            result[key + "_" + filter.operator] = filter.value;
+                            result[key + "_" + filter.operator] = Array.isArray(filter.value)
+                                ? filter.value.toString()
+                                : filter.value;
                         }
                         else {
                             for (var subKey in filter) {
                                 if (Object.prototype.hasOwnProperty.call(filter, subKey)) {
-                                    result[key + "_" + subKey + "_" + filter.operator] = filter.value;
+                                    result[key + "_" + subKey + "_" + filter.operator] = Array.isArray(filter.value)
+                                        ? filter.value.toString()
+                                        : filter.value;
                                 }
                             }
                         }
@@ -27,7 +31,9 @@ var parseFilters = function (filters, pagination) {
                         filter.forEach(function (subFilter) {
                             if (subFilter.key) {
                                 result[subFilter.key + "_" + subFilter.operator] =
-                                    subFilter.value;
+                                    Array.isArray(subFilter.value)
+                                        ? subFilter.value.toString()
+                                        : subFilter.value;
                             }
                         });
                     }
@@ -38,6 +44,9 @@ var parseFilters = function (filters, pagination) {
     result['page'] = (pagination === null || pagination === void 0 ? void 0 : pagination.page) || constants_1.DefaultPagination.page;
     result['per_page'] =
         (pagination === null || pagination === void 0 ? void 0 : pagination.itemsPerPage) || constants_1.DefaultPagination.itemsPerPage;
+    if (pagination === null || pagination === void 0 ? void 0 : pagination.order_by) {
+        result['order_by'] = pagination === null || pagination === void 0 ? void 0 : pagination.order_by;
+    }
     return result;
 };
 exports.parseFilters = parseFilters;

package/dist/index.d.ts

@@ -25,6 +25,7 @@ export { SystemCommandJobs } from './systemCommandJobs';
 export { Translators } from './translators';
 export { Users } from './users';
 export { UserTypes } from './userTypes';
+export * from './models';
 export * from './bulkResponses/models';
 export * from './commands/models';
 export * from './companies/models';

package/dist/index.js

@@ -65,6 +65,7 @@ var users_1 = require("./users");
 Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
 var userTypes_1 = require("./userTypes");
 Object.defineProperty(exports, "UserTypes", { enumerable: true, get: function () { return userTypes_1.UserTypes; } });
+__exportStar(require("./models"), exports);
 __exportStar(require("./bulkResponses/models"), exports);
 __exportStar(require("./commands/models"), exports);
 __exportStar(require("./companies/models"), exports);

package/dist/models.d.ts

@@ -9,6 +9,7 @@ export interface Pagination {
 export interface PaginationFilter {
     page: number;
     itemsPerPage: number;
+    order_by?: string;
 }
 export interface Filter {
     operator: 'eq' | 'ne' | 'like' | 'gt' | 'gte' | 'lt' | 'lte' | 'between' | 'in' | 'nin' | 'incany' | 'incall';

package/dist/stats/index.d.ts

@@ -0,0 +1,7 @@
+import { CumulativeCellUsage, DevicesCountByHeartbeat, DevicesCountByType } from './models';
+declare const Stats: {
+    devicesByHeartbeat: () => Promise<DevicesCountByHeartbeat>;
+    devicesByType: () => Promise<DevicesCountByType>;
+    cellUsage: () => Promise<CumulativeCellUsage>;
+};
+export { Stats };

package/dist/stats/index.js

@@ -0,0 +1,111 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Stats = void 0;
+var __1 = require("..");
+var constants_1 = require("../constants");
+var helpers_1 = require("../helpers");
+var Stats = {
+    devicesByHeartbeat: function () { return __awaiter(void 0, void 0, void 0, function () {
+        var axios, result, error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    __1.EdgeIQAPI.logAction("Getting devices count by heartbeat status");
+                    axios = __1.EdgeIQAPI.getAxios();
+                    return [4, axios.get(constants_1.Endpoints.statsDevicesByHeartbeat)];
+                case 1:
+                    result = _a.sent();
+                    return [2, result === null || result === void 0 ? void 0 : result.data];
+                case 2:
+                    error_1 = _a.sent();
+                    if ((0, helpers_1.isApiError)(error_1)) {
+                        throw error_1;
+                    }
+                    throw error_1;
+                case 3: return [2];
+            }
+        });
+    }); },
+    devicesByType: function () { return __awaiter(void 0, void 0, void 0, function () {
+        var axios, result, error_2;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    __1.EdgeIQAPI.logAction("Getting devices count by type");
+                    axios = __1.EdgeIQAPI.getAxios();
+                    return [4, axios.get(constants_1.Endpoints.statsDevicesByType)];
+                case 1:
+                    result = _a.sent();
+                    return [2, result === null || result === void 0 ? void 0 : result.data];
+                case 2:
+                    error_2 = _a.sent();
+                    if ((0, helpers_1.isApiError)(error_2)) {
+                        throw error_2;
+                    }
+                    throw error_2;
+                case 3: return [2];
+            }
+        });
+    }); },
+    cellUsage: function () { return __awaiter(void 0, void 0, void 0, function () {
+        var axios, result, error_3;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    __1.EdgeIQAPI.logAction("Getting cumulative cell usage");
+                    axios = __1.EdgeIQAPI.getAxios();
+                    return [4, axios.get(constants_1.Endpoints.statsCellUsage)];
+                case 1:
+                    result = _a.sent();
+                    return [2, result === null || result === void 0 ? void 0 : result.data];
+                case 2:
+                    error_3 = _a.sent();
+                    if ((0, helpers_1.isApiError)(error_3)) {
+                        throw error_3;
+                    }
+                    throw error_3;
+                case 3: return [2];
+            }
+        });
+    }); },
+};
+exports.Stats = Stats;

package/dist/stats/models.d.ts

@@ -0,0 +1,27 @@
+export interface DevicesCountByHeartbeat {
+    online: number;
+    offline: number;
+    idle: number;
+    never_reported: number;
+}
+interface CountByType {
+    count: number;
+    name: string;
+}
+export interface DevicesCountByType {
+    cloud_native: {
+        [key: string]: CountByType;
+    };
+    gateway: {
+        [key: string]: CountByType;
+    };
+}
+export interface CumulativeCellUsage {
+    day: number;
+    last: number;
+    month: number;
+    total: number;
+    week: number;
+    year: number;
+}
+export {};

package/dist/stats/models.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edgeiq/edgeiq-api-js",
-  "version": "1.0.3",
+  "version": "1.1.2",
   "author": "EdgeIQ",
   "license": "ISC",
   "description": "This project presents EdgeIQ API SDK.",