@edgeiq/edgeiq-api-js 1.10.0 → 1.11.1

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

@@ -1,6 +1,6 @@
 import { Base, Filter, Filters, Pagination } from '../models';
 import { RetryOptions } from '../retryOptions/models';
-export declare type GatewayCommandType = 'activate_cloud_native_device' | 'backup' | 'data_restriction' | 'deactivate_cloud_native_device' | 'disable_data_restriction' | 'enable_data_restriction' | 'greengrass_initialize' | 'awsiot_attach_thing_groups' | 'awsiot_detach_thing_groups' | 'cancel_password_change' | 'file_from_device' | 'file_to_device' | 'heartbeat' | 'log_level' | 'log_upload' | 'lwm2m_request' | 'lwm2m_file' | 'restore_backup' | 'reboot' | 'reset' | 'send_config' | 'setting' | 'setting_fetch' | 'software_update' | 'software_version' | 'status';
+export declare type GatewayCommandType = 'activate_cloud_native_device' | 'backup' | 'data_restriction' | 'deactivate_cloud_native_device' | 'disable_data_restriction' | 'enable_data_restriction' | 'greengrass_initialize' | 'awsiot_attach_thing_groups' | 'awsiot_detach_thing_groups' | 'cancel_password_change' | 'file_from_device' | 'file_to_device' | 'heartbeat' | 'log_level' | 'log_upload' | 'lwm2m_request' | 'lwm2m_file' | 'network_connectivity_info' | 'network_connectivity_latency_test' | 'network_connectivity_performance_test' | 'restore_backup' | 'reboot' | 'reset' | 'send_config' | 'setting' | 'setting_fetch' | 'software_update' | 'software_version' | 'status';
 export declare type CommandType = 'download' | 'fileupload' | 'filedownload' | 'execute' | 'observe' | 'observe_stop' | 'read' | 'upload' | 'write';
 export interface CommandSchedule {
     start_datetime: string;

package/dist/index.d.ts

@@ -21,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';
@@ -66,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

@@ -21,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';
@@ -66,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, NetworkInterfaceLatencyReport, NetworkInterfacePerformanceReport, NetworkInterfaceReport } from './models';
+declare const NetworkInterfaceReports: {
+    getDeviceNetworkInterfaceReport: (id: string) => Promise<NetworkInterfaceReport>;
+    getDeviceNetworkInterfaceInfo: (device_id: string, interface_name?: string | undefined) => Promise<NetworkInterfaceInfo>;
+    getDeviceNetworkInterfaceLatency: (device_id: string, interface_name?: string | undefined) => Promise<NetworkInterfaceLatencyReport>;
+    getDeviceNetworkPerformance: (device_id: string) => Promise<NetworkInterfacePerformanceReport>;
+    getDeviceNetworkInterfaceAllReports: (device_id: string, interface_name: string) => Promise<NetworkInterfaceAllReports>;
+};
+export { NetworkInterfaceReports };

package/dist/networkInterfaceReports/index.js

@@ -0,0 +1,96 @@
+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* () {
+        try {
+            const axios = EdgeIQAPI.getAxios();
+            const result = yield axios.get(`network_interfaces_reports/${id}`);
+            return result === null || result === void 0 ? void 0 : result.data;
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+    getDeviceNetworkInterfaceInfo: (device_id, interface_name) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        try {
+            const axios = EdgeIQAPI.getAxios();
+            const result = yield axios.get(`network_interface_infos?device_id=${device_id}&interface_name=${interface_name}`);
+            return (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a[0];
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+    getDeviceNetworkInterfaceLatency: (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_latency_reports?device_id=${device_id}${interface_name ? `&interface_name=${interface_name}` : ''}`);
+            return (_b = result === null || result === void 0 ? void 0 : result.data) === null || _b === void 0 ? void 0 : _b[0];
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+    getDeviceNetworkPerformance: (device_id) => __awaiter(void 0, void 0, void 0, function* () {
+        var _c;
+        try {
+            const axios = EdgeIQAPI.getAxios();
+            const result = yield axios.get(`network_interface_performance_reports?device_id=${device_id}`);
+            return (_c = result === null || result === void 0 ? void 0 : result.data) === null || _c === void 0 ? void 0 : _c[0];
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+    getDeviceNetworkInterfaceAllReports: (device_id, interface_name) => __awaiter(void 0, void 0, void 0, function* () {
+        var _d, _e, _f, _g;
+        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}`);
+            if ((info === null || info === void 0 ? void 0 : info.data) && (info === null || info === void 0 ? void 0 : info.data[0])) {
+                const infoData = info === null || info === void 0 ? void 0 : info.data[0];
+                const report = yield axios.get(`network_interface_reports/${infoData.network_interfaces_report_id}`);
+                return {
+                    info: (_d = info === null || info === void 0 ? void 0 : info.data) === null || _d === void 0 ? void 0 : _d[0],
+                    latency: (_e = latency === null || latency === void 0 ? void 0 : latency.data) === null || _e === void 0 ? void 0 : _e[0],
+                    report: report === null || report === void 0 ? void 0 : report.data,
+                };
+            }
+            return {
+                info: (_f = info === null || info === void 0 ? void 0 : info.data) === null || _f === void 0 ? void 0 : _f[0],
+                latency: (_g = latency === null || latency === void 0 ? void 0 : latency.data) === null || _g === void 0 ? void 0 : _g[0],
+            };
+        }
+        catch (error) {
+            if (isApiError(error)) {
+                throw error;
+            }
+            throw error;
+        }
+    }),
+};
+export { NetworkInterfaceReports };

package/dist/networkInterfaceReports/models.d.ts

@@ -0,0 +1,92 @@
+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;
+    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;
+    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.10.0",
+  "version": "1.11.1",
   "author": "EdgeIQ",
   "license": "ISC",
   "description": "This project presents EdgeIQ API SDK.",