@edgeiq/edgeiq-api-js 1.9.9 → 1.10.0

package/dist/constants.d.ts

@@ -64,6 +64,7 @@ export declare const BaseEndpoints: {
     configuration: string;
     deviceConfig: string;
     deviceError: string;
+    deviceEvent: string;
     deviceTransferRequest: string;
     deviceTemplate: string;
     deviceType: string;
@@ -118,6 +119,7 @@ export declare const Endpoints: {
     company: string;
     configuration: string;
     deviceConfig: string;
+    deviceEvent: string;
     deviceError: string;
     deviceTransferRequest: string;
     deviceTemplate: string;

package/dist/constants.js

@@ -66,6 +66,7 @@ export const BaseEndpoints = {
     configuration: 'configurations',
     deviceConfig: 'device_configs',
     deviceError: 'device_errors',
+    deviceEvent: 'device_events',
     deviceTransferRequest: 'device_transfer_requests',
     deviceTemplate: 'device_templates',
     deviceType: 'device_types',
@@ -120,6 +121,7 @@ export const Endpoints = {
     company: `${BaseEndpoints.company}`,
     configuration: `${BaseEndpoints.configuration}`,
     deviceConfig: `${BaseEndpoints.deviceConfig}`,
+    deviceEvent: `${BaseEndpoints.deviceEvent}`,
     deviceError: `${BaseEndpoints.deviceError}`,
     deviceTransferRequest: `${BaseEndpoints.deviceTransferRequest}`,
     deviceTemplate: `${BaseEndpoints.deviceTemplate}`,

package/dist/deviceEvents/index.d.ts

@@ -0,0 +1,8 @@
+import { PaginationFilter } from '../models';
+import { DeviceEvent, DeviceEventsFilters, PaginatedDeviceEvents } from './models';
+interface DeviceEventsInterface {
+    list(filters?: DeviceEventsFilters, pagination?: PaginationFilter): Promise<PaginatedDeviceEvents>;
+    getOneById(id: string): Promise<DeviceEvent>;
+}
+export declare const DeviceEvents: DeviceEventsInterface;
+export {};

package/dist/deviceEvents/index.js

@@ -0,0 +1,58 @@
+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());
+    });
+};
+import { EdgeIQAPI } from '..';
+import { Endpoints } from '../constants';
+import { BaseModelClass } from '../core/ModelClass';
+import { parseFilters } from '../filtersParser';
+import { isApiError } from '../helpers';
+export const DeviceEvents = class extends BaseModelClass {
+    static list(filters, pagination) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this.logAction(`Listing device events with following filters: ${filters !== null && filters !== void 0 ? filters : '{}'}.\n And pagination ${pagination !== null && pagination !== void 0 ? pagination : '{}'}`);
+                const axios = EdgeIQAPI.getAxios();
+                const result = yield axios.get(Endpoints.deviceEvent, {
+                    params: parseFilters(filters, pagination),
+                });
+                return {
+                    deviceEvents: (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources,
+                    pagination: {
+                        page: (_b = result === null || result === void 0 ? void 0 : result.data) === null || _b === void 0 ? void 0 : _b.page,
+                        itemsPerPage: (_c = result === null || result === void 0 ? void 0 : result.data) === null || _c === void 0 ? void 0 : _c.per_page,
+                        total: (_d = result === null || result === void 0 ? void 0 : result.data) === null || _d === void 0 ? void 0 : _d.total,
+                    },
+                };
+            }
+            catch (error) {
+                if (isApiError(error)) {
+                    throw error;
+                }
+                throw error;
+            }
+        });
+    }
+    static getOneById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                this.logAction(`Getting DeviceEvent with id: ${id}`);
+                const axios = EdgeIQAPI.getAxios();
+                const result = yield axios.get(`${Endpoints.deviceEvent}/${id}`);
+                return result === null || result === void 0 ? void 0 : result.data;
+            }
+            catch (error) {
+                if (isApiError(error)) {
+                    throw error;
+                }
+                throw error;
+            }
+        });
+    }
+};

package/dist/deviceEvents/models.d.ts

@@ -0,0 +1,16 @@
+import { DeviceClass } from '../devices/models';
+import { Base, Filter, Filters, Pagination } from '../models';
+export declare type DeviceEventType = 'create' | 'connect' | 'delete' | 'disconnect' | 'heartbeat_status_change' | 'password_change_successful' | 'register' | 'touch' | 'update_edge_version';
+export interface DeviceEvent extends Base {
+    device_class: DeviceClass;
+    device_event_type: DeviceEventType;
+    unique_id: string;
+}
+export interface DeviceEventsFilters extends Filters {
+    device_event_type?: Filter;
+    unique_id?: Filter;
+}
+export interface PaginatedDeviceEvents {
+    deviceEvents: DeviceEvent[];
+    pagination: Pagination;
+}

package/dist/deviceEvents/models.js

@@ -0,0 +1 @@
+export {};

package/dist/devices/models.d.ts

@@ -1,4 +1,5 @@
 import { Base, Filter, Filters, Pagination } from '../models';
+export declare type DeviceClass = 'discovered' | 'escrow' | 'standard';
 export declare type BoundingBox = {
     topLeft: string;
     bottomRight: string;

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export { DeviceConfigs } from './deviceConfigs';
 export { DeviceLocationObservations } from './deviceLocationObservations';
 export { Devices } from './devices';
 export { DeviceErrors } from './deviceErrors';
+export { DeviceEvents } from './deviceEvents';
 export { DeviceTemplates } from './deviceTemplates';
 export { DeviceTransferRequests } from './deviceTransferRequests';
 export { DeviceTypes } from './deviceTypes';
@@ -53,6 +54,7 @@ export * from './deviceLocationObservations/models';
 export * from './devices/models';
 export * from './discoveredDevices/models';
 export * from './deviceErrors/models';
+export * from './deviceEvents/models';
 export * from './deviceTemplates/models';
 export * from './deviceTransferRequests/models';
 export * from './deviceTypes/models';

package/dist/index.js

@@ -9,6 +9,7 @@ export { DeviceConfigs } from './deviceConfigs';
 export { DeviceLocationObservations } from './deviceLocationObservations';
 export { Devices } from './devices';
 export { DeviceErrors } from './deviceErrors';
+export { DeviceEvents } from './deviceEvents';
 export { DeviceTemplates } from './deviceTemplates';
 export { DeviceTransferRequests } from './deviceTransferRequests';
 export { DeviceTypes } from './deviceTypes';
@@ -53,6 +54,7 @@ export * from './deviceLocationObservations/models';
 export * from './devices/models';
 export * from './discoveredDevices/models';
 export * from './deviceErrors/models';
+export * from './deviceEvents/models';
 export * from './deviceTemplates/models';
 export * from './deviceTransferRequests/models';
 export * from './deviceTypes/models';

package/package.json

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