@edgeiq/edgeiq-api-js 1.9.9 → 1.11.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/deviceConfigs/models.d.ts

@@ -1,4 +1,5 @@
 import { Base, Filter, Filters, Pagination } from '../models';
+export declare type ConnectionType = 'cellular' | 'ethernet_lan' | 'ethernet_wan' | 'ethernet_wan_lan' | 'wifi';
 export declare type ModemPreferredNetworkType = '2G' | '3G' | '5G' | 'LTE' | 'AUTO';
 export declare type ApnAuthType = 'none' | 'PAP' | 'CHAP' | 'PAP_CHAP';
 export declare type ApnType = 'default' | 'MMS' | 'SUPL' | 'HIPRI' | 'FOTA' | 'CBS' | 'XCAP';
@@ -58,9 +59,9 @@ export interface ConnectionConfig {
     wifi_hidden?: number;
 }
 export interface Connection {
-    type: string;
     name: string;
-    config: ConnectionConfig;
+    type: ConnectionType;
+    config?: ConnectionConfig;
 }
 export interface IPTableAction {
     action?: string;
@@ -75,18 +76,43 @@ export interface IPTableAction {
     destination?: string;
     jump?: string;
 }
+export interface DataCollection {
+    enabled: boolean;
+    frequency_seconds: number;
+    interfaces: string[];
+}
+export interface LatencyTest extends DataCollection {
+    hosts: string[];
+    type: string;
+    options: {
+        count: number;
+        packet_size: number;
+        timeout_seconds: number;
+    };
+}
+export interface PerformanceTest extends DataCollection {
+    type: string;
+    options: {
+        servers: string[];
+        download: boolean;
+        upload: boolean;
+        timeout_seconds: number;
+    };
+}
 export interface DeviceConfigInput {
+    company_id: string;
     name: string;
-    device_type_id: string;
     connections?: Connection[];
     iptables?: (IPTableAction | undefined)[];
     last_notification_id?: string;
+    interface_data_collection?: DataCollection;
+    latency_test?: LatencyTest;
+    performance_test?: PerformanceTest;
 }
 export interface DeviceConfig extends DeviceConfigInput, Base {
 }
 export interface DeviceConfigsFilters extends Filters {
     name?: Filter;
-    device_type_id?: Filter;
 }
 export interface PaginatedDeviceConfigs {
     deviceConfigs: DeviceConfig[];

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/deviceTypes/models.d.ts

@@ -2,11 +2,6 @@ import { AwsThingGroup } from '../models';
 import { Base, Filter, Filters, Pagination } from '../models';
 export declare type TypeDeviceType = 'gateway' | 'sensor' | 'cloud_native' | 'modem' | 'lwm2m';
 export declare type DeviceTypeRole = 'gateway' | 'endpoint';
-export interface NetworkConnection {
-    type: string;
-    interface?: string;
-    name: string;
-}
 export interface Peripheral {
     type: string;
     device: string;
@@ -70,7 +65,6 @@ export interface SMSATCommands {
 export interface Capabilities {
     actions: Actions;
     iptables: boolean;
-    network_connections: NetworkConnection[];
     firmware: Firmware;
     peripherals: Peripheral[];
     sms_at_commands?: SMSATCommands;
@@ -102,6 +96,7 @@ export interface DeviceTypeInput {
     important_metadata?: ImportantMetadata[];
     device_integration_id?: string;
     cloud_native_integration_id?: string;
+    device_network_config_id?: string;
 }
 export interface DeviceType extends DeviceTypeInput, Base {
 }

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';
@@ -20,6 +21,7 @@ export { GatewayCommands } from './gatewayCommands';
 export { Ingestors } from './ingestors';
 export { Integrations } from './integrations';
 export { LWM2M } from './lwm2m';
+export { NetworkInterfaceReports } from './networkInterfaceReports';
 export { Notifications } from './notifications';
 export { PollableAttributes } from './pollableAttributes';
 export { Regions } from './regions';
@@ -53,6 +55,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';
@@ -64,6 +67,7 @@ export * from './ingestors/models';
 export * from './integrations/models';
 export * from './lwm2m/models';
 export * from './log/models';
+export * from './networkInterfaceReports/models';
 export * from './notifications/models';
 export * from './pollableAttributes/models';
 export * from './reports/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';
@@ -20,6 +21,7 @@ export { GatewayCommands } from './gatewayCommands';
 export { Ingestors } from './ingestors';
 export { Integrations } from './integrations';
 export { LWM2M } from './lwm2m';
+export { NetworkInterfaceReports } from './networkInterfaceReports';
 export { Notifications } from './notifications';
 export { PollableAttributes } from './pollableAttributes';
 export { Regions } from './regions';
@@ -53,6 +55,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';
@@ -64,6 +67,7 @@ export * from './ingestors/models';
 export * from './integrations/models';
 export * from './lwm2m/models';
 export * from './log/models';
+export * from './networkInterfaceReports/models';
 export * from './notifications/models';
 export * from './pollableAttributes/models';
 export * from './reports/models';

package/dist/networkInterfaceReports/index.d.ts

@@ -0,0 +1,9 @@
+import { NetworkInterfaceAllReports, NetworkInterfaceInfo, NetworkInterfaceReport } from './models';
+declare const NetworkInterfaceReports: {
+    getDeviceNetworkInterfaceReport: (id: string) => Promise<NetworkInterfaceReport>;
+    getDeviceNetworkInterfaceInfo: (device_id: string, interface_name: string) => Promise<NetworkInterfaceInfo>;
+    getDeviceNetworkInterfaceLatency: (device_id: string, interface_name: string) => Promise<NetworkInterfaceInfo>;
+    getDeviceNetworkInterfacePerformance: (device_id: string, interface_name: string) => Promise<NetworkInterfaceInfo>;
+    getDeviceNetworkInterfaceAllReports: (device_id: string, interface_name: string) => Promise<NetworkInterfaceAllReports>;
+};
+export { NetworkInterfaceReports };

package/dist/networkInterfaceReports/index.js

@@ -0,0 +1,100 @@
+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 { isApiError } from '../helpers';
+const NetworkInterfaceReports = {
+    getDeviceNetworkInterfaceReport: (id) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        try {
+            const axios = EdgeIQAPI.getAxios();
+            const result = yield axios.get(`network_interface_reports/${id}`);
+            return (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.resources;
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+    getDeviceNetworkInterfaceInfo: (device_id, interface_name) => __awaiter(void 0, void 0, void 0, function* () {
+        var _b;
+        try {
+            const axios = EdgeIQAPI.getAxios();
+            const result = yield axios.get(`network_interface_infos?device_id=${device_id}&interface_name=${interface_name}`);
+            return (_b = result === null || result === void 0 ? void 0 : result.data) === null || _b === void 0 ? void 0 : _b.resources;
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+    getDeviceNetworkInterfaceLatency: (device_id, interface_name) => __awaiter(void 0, void 0, void 0, function* () {
+        var _c;
+        try {
+            const axios = EdgeIQAPI.getAxios();
+            const result = yield axios.get(`network_interface_latency_reports?device_id=${device_id}&interface_name=${interface_name}`);
+            return (_c = result === null || result === void 0 ? void 0 : result.data) === null || _c === void 0 ? void 0 : _c.resources;
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+    getDeviceNetworkInterfacePerformance: (device_id, interface_name) => __awaiter(void 0, void 0, void 0, function* () {
+        var _d;
+        try {
+            const axios = EdgeIQAPI.getAxios();
+            const result = yield axios.get(`network_interface_performance_reports?device_id=${device_id}&interface_name=${interface_name}`);
+            return (_d = result === null || result === void 0 ? void 0 : result.data) === null || _d === void 0 ? void 0 : _d.resources;
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+    getDeviceNetworkInterfaceAllReports: (device_id, interface_name) => __awaiter(void 0, void 0, void 0, function* () {
+        var _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u;
+        try {
+            const axios = EdgeIQAPI.getAxios();
+            const info = yield axios.get(`network_interface_infos?device_id=${device_id}&interface_name=${interface_name}`);
+            const latency = yield axios.get(`network_interface_latency_reports?device_id=${device_id}&interface_name=${interface_name}`);
+            const performance = yield axios.get(`network_interface_performance_reports?device_id=${device_id}&interface_name=${interface_name}`);
+            if (((_e = info === null || info === void 0 ? void 0 : info.data) === null || _e === void 0 ? void 0 : _e.resources) && ((_f = info === null || info === void 0 ? void 0 : info.data) === null || _f === void 0 ? void 0 : _f.resources[0])) {
+                const infoData = (_g = info === null || info === void 0 ? void 0 : info.data) === null || _g === void 0 ? void 0 : _g.resources[0];
+                const report = yield axios.get(`network_interface_reports/${infoData.network_interfaces_report_id}`);
+                return {
+                    info: (_j = (_h = info === null || info === void 0 ? void 0 : info.data) === null || _h === void 0 ? void 0 : _h.resources) === null || _j === void 0 ? void 0 : _j[0],
+                    latency: (_l = (_k = latency === null || latency === void 0 ? void 0 : latency.data) === null || _k === void 0 ? void 0 : _k.resources) === null || _l === void 0 ? void 0 : _l[0],
+                    performance: (_o = (_m = performance === null || performance === void 0 ? void 0 : performance.data) === null || _m === void 0 ? void 0 : _m.resources) === null || _o === void 0 ? void 0 : _o[0],
+                    report: report === null || report === void 0 ? void 0 : report.data,
+                };
+            }
+            return {
+                info: (_q = (_p = info === null || info === void 0 ? void 0 : info.data) === null || _p === void 0 ? void 0 : _p.resources) === null || _q === void 0 ? void 0 : _q[0],
+                latency: (_s = (_r = latency === null || latency === void 0 ? void 0 : latency.data) === null || _r === void 0 ? void 0 : _r.resources) === null || _s === void 0 ? void 0 : _s[0],
+                performance: (_u = (_t = performance === null || performance === void 0 ? void 0 : performance.data) === null || _t === void 0 ? void 0 : _t.resources) === null || _u === void 0 ? void 0 : _u[0],
+            };
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+};
+export { NetworkInterfaceReports };

package/dist/networkInterfaceReports/models.d.ts

@@ -0,0 +1,94 @@
+import { Base, Filter, Filters } from '../models';
+export interface NetworkInterfaceReport extends Base {
+    device_id: string;
+    device_unique_id: string;
+    device_class: string;
+    device_type_id: string;
+    gateway_command_id: string;
+    traceparent: string;
+    arrived_at: string;
+    internet_reachable: boolean;
+    default_dns: string;
+    default_route_interface_name: string;
+    default_route_ip_address: string;
+    routing_table: {
+        [key: string]: unknown;
+    };
+}
+export interface NetworkInterfaceInfo extends Base {
+    network_interfaces_report_id: string;
+    device_id: string;
+    device_type_id: string;
+    gateway_command_id: string;
+    arrived_at: string;
+    traceparent: string;
+    default: boolean;
+    link_status: string;
+    interface_name: string;
+    interface_type: string;
+    interface_mac_address: string;
+    cellular_strength: string;
+    cellular_mode: string;
+    ipv4_enabled: boolean;
+    ipv4_address: string;
+    ipv4_netmask: string;
+    ipv4_gateway: string;
+    ipv4_dns: string;
+    ipv6_enabled: boolean;
+    ipv6_address: string;
+    ipv6_netmask: string;
+    ipv6_gateway: string;
+    ipv6_dns: string;
+    bytes_sent: number;
+    bytes_received: number;
+    packets_sent: number;
+    packets_received: number;
+    packets_sent_errors: number;
+    packets_received_errors: number;
+}
+export interface NetworkInterfaceLatencyReport extends Base {
+    device_id: string;
+    device_unique_id: string;
+    device_class: string;
+    device_type_id: string;
+    gateway_command_id: string;
+    interface_name: string;
+    arrived_at: string;
+    traceparent: string;
+    type: string;
+    host: string;
+    packets_sent: number;
+    packets_received: number;
+    packet_loss_percent: number;
+    min_latency_ms: number;
+    max_latency_ms: number;
+    avg_latency_ms: number;
+}
+export interface NetworkInterfacePerformanceReport extends Base {
+    device_id: string;
+    device_unique_id: string;
+    device_class: string;
+    device_type_id: string;
+    gateway_command_id: string;
+    interface_name: string;
+    arrived_at: string;
+    traceparent: string;
+    type: string;
+    server_id: string;
+    latency_ms: number;
+    jitter_ms: number;
+    packet_loss_percent: number;
+    download_speed_mbps: number;
+    upload_speed_mbps: number;
+    test_duration_seconds: number;
+}
+export interface NetworkInterfaceAllReports {
+    info: NetworkInterfaceInfo;
+    latency: NetworkInterfaceLatencyReport;
+    performance: NetworkInterfacePerformanceReport;
+    report?: NetworkInterfaceReport;
+}
+export interface NetworkInterfaceFilters extends Filters {
+    device_id?: Filter;
+    interface_name?: Filter;
+}

package/dist/networkInterfaceReports/models.js

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

package/dist/testConstants.js

@@ -160,7 +160,6 @@ const deviceTypeCapabilities = {
         upgrade: false,
     },
     iptables: false,
-    network_connections: [],
     peripherals: [],
 };
 export const EmptyDeviceType = Object.assign(Object.assign({}, baseModel), { capabilities: deviceTypeCapabilities, manufacturer: '', model: '', name: '', type: 'cloud_native', role: 'endpoint' });

package/package.json

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