@edgeiq/edgeiq-api-js 1.2.15 → 1.3.1

package/dist/deviceTransferRequests/index.d.ts

@@ -1,7 +1,10 @@
 import { BaseModelInterface } from '../core/ModelClass';
+import { BulkActionResponse } from '../models';
 import { DeviceTransferRequest, DeviceTransferRequestInput, DeviceTransferRequestsFilters, PaginatedDeviceTransferRequests } from './models';
 interface DeviceTransferRequestsInterface extends BaseModelInterface<DeviceTransferRequest, DeviceTransferRequestInput, DeviceTransferRequestsFilters, PaginatedDeviceTransferRequests> {
     update(deviceTransferRequest: DeviceTransferRequest): Promise<DeviceTransferRequest>;
+    accept(id: string, deviceTypeId: string): Promise<string>;
+    bulkAccept(ids: string[], deviceTypeId: string): Promise<BulkActionResponse>;
 }
 export declare const DeviceTransferRequests: DeviceTransferRequestsInterface;
 export {};

package/dist/deviceTransferRequests/index.js

@@ -194,5 +194,54 @@ exports.DeviceTransferRequests = (function (_super) {
             });
         });
     };
+    class_1.accept = function (id, deviceTypeId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, data, error_6;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Accepting device transfer request with id " + id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        data = JSON.stringify({ device_type_id: deviceTypeId });
+                        return [4, axios.post(constants_1.Endpoints.deviceTransferRequest + "/" + id + "/transfer", data)];
+                    case 1:
+                        _a.sent();
+                        return [2, 'Device transfer request accepted'];
+                    case 2:
+                        error_6 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_6)) {
+                            throw error_6;
+                        }
+                        throw error_6;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.bulkAccept = function (ids, deviceTypeId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_7;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Accepting " + ids.length + " device transfer requests with device type with ID: " + deviceTypeId);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.post(constants_1.Endpoints.deviceTransferRequest + "/bulk/transfer", { ids: ids, device_type_id: deviceTypeId })];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data];
+                    case 2:
+                        error_7 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_7)) {
+                            throw error_7;
+                        }
+                        throw error_7;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
     return class_1;
 }(ModelClass_1.BaseModelClass));

package/dist/devices/index.js

@@ -389,7 +389,7 @@ exports.Devices = (function (_super) {
                         this.logAction("Attaching " + rulesIds.length + " rules with to device with id " + id);
                         axios = __1.EdgeIQAPI.getAxios();
                         return [4, axios.post(constants_1.Endpoints.device + "/" + id + "/rules/bulk", {
-                                data: { ids: rulesIds },
+                                ids: rulesIds,
                             })];
                     case 1:
                         result = _a.sent();

package/dist/ingestors/models.d.ts

@@ -2,6 +2,70 @@ import { Base, Filter, Filters, Pagination } from '../models';
 export declare type ListenerType = 'shell_polling' | 'icmp_polling' | 'snmp_polling' | 'tcp_server' | 'tcp_client' | 'udp_server' | 'udp_client' | 'http_server' | 'http_client' | 'dev' | 'tcp_modbus' | 'opcua' | 'bacnet' | 'dbus_signal' | 'cloud' | 'cloud_polling_inmarsat' | 'cloud_polling_orbcomm' | 'cloud_gcp_pubsub_jci' | 'cloud_polling_assetlink';
 export declare type IngestorType = 'edge' | 'cloud';
 export declare type HandlerType = 'fixed' | 'delimited' | 'router' | 'dbus' | 'passthrough';
+export interface ListenerParam {
+    address?: string;
+    request_type?: string;
+    quantity?: number;
+    value?: number | string;
+    and_mask?: number;
+    or_mask?: number;
+    node_id?: string;
+    object_instance?: number;
+    object_type?: string;
+    property_id?: string;
+}
+export interface ListenerFilter {
+    interface?: string;
+    member?: string;
+    path?: string;
+}
+export interface DeviceTypeMapping {
+    device_type_id?: string;
+    key?: string;
+    value?: string;
+}
+export interface IngestorRoute {
+    method?: string;
+    path?: string;
+}
+export interface IngestorListener {
+    access_id?: string;
+    password?: string;
+    address?: string;
+    port?: number;
+    timeout?: number;
+    poll_interval?: number;
+    host?: string;
+    slave_id?: number;
+    retries?: number;
+    community?: string;
+    version?: string;
+    oids?: string[];
+    url?: string;
+    method?: string;
+    dev?: string;
+    baud?: string;
+    command?: string;
+    min_timeout_seconds?: number;
+    subscription_id?: string;
+    integration_id?: string;
+    create_discovered_device?: boolean;
+    auto_promote_discovered_device?: boolean;
+    heartbeat_period?: string;
+    params: ListenerParam;
+    filters: ListenerFilter[];
+    device_type_mapping: DeviceTypeMapping[];
+}
+export interface IngestorHandler {
+    strip_delimited?: boolean;
+    delimited?: string;
+    dbus_map_key?: string;
+    index?: number;
+    length?: number;
+    map_keys?: string[];
+    type?: string;
+    routes: IngestorRoute[];
+}
 export interface IngestorInput {
     name: string;
     company_id: string;
@@ -11,13 +75,9 @@ export interface IngestorInput {
     };
     target_template?: string;
     listener_type: ListenerType;
-    listener?: {
-        [key: string]: unknown;
-    };
+    listener: IngestorListener;
     handler_type: HandlerType;
-    handler?: {
-        [key: string]: unknown;
-    };
+    handler: IngestorHandler;
     translator?: {
         [key: string]: unknown;
     };

package/dist/rules/models.d.ts

@@ -6,6 +6,35 @@ export declare type RuleActionBodyType = 'html' | 'text';
 export declare type LocationVia = 'gps' | 'cell_tower' | 'bluetooth' | 'wifi' | 'other';
 export declare type GeneratedAtFormat = 'rfc3339' | 'unix_timestamp';
 export declare type LocationTransitionDirectionType = 'arriving' | 'leaving';
+export declare type DerivedValuesTypes = [
+    'count',
+    'min',
+    'max',
+    'avg',
+    'sum',
+    'convert_indexed_keys'
+];
+export declare type WhereConditionTypes = ['where', 'or_where'];
+export declare type WhereConditionOperators = [
+    'equal',
+    'not_equal',
+    'greater_than',
+    'greater_than_equal',
+    'less_than',
+    'less_than_equal',
+    'in',
+    'not_in',
+    'starts_with',
+    'ends_with',
+    'contains',
+    'strict_contains',
+    'length_equals',
+    'length_not_equals',
+    'length_greater_than',
+    'length_greater_than_equal',
+    'length_less_than',
+    'length_less_than_equal'
+];
 export interface CredentialData {
     type?: string;
     value: string;
@@ -62,14 +91,30 @@ export interface RuleAction {
     channels?: PRTGChannel[];
     definition_id?: string;
 }
+export interface WhereCondition {
+    type?: WhereConditionTypes;
+    operator?: WhereConditionOperators;
+    property?: string;
+    value?: string | string[];
+}
+export interface DerivedValue {
+    name?: string;
+    type?: DerivedValuesTypes;
+    property?: string;
+    properties?: string[];
+    data_set?: string;
+    where_conditions?: WhereCondition[];
+}
 export interface RuleCondition {
     type: RuleConditionType;
     property?: string;
-    value?: unknown;
+    value?: string[];
     value_type?: string;
     rule_conditions?: (RuleCondition | undefined)[];
     error_type?: DeviceErrorType;
     location_transition_evaluator?: LocationTransitionEvaluator;
+    cold_start_trigger?: boolean;
+    derived_values?: DerivedValue[];
 }
 export interface LocationTransitionEvaluator {
     region_id: string;

package/dist/softwareUpdates/index.d.ts

@@ -1,9 +1,10 @@
 import { BaseModelInterface } from '../core/ModelClass';
 import { BulkActionResponse } from '../models';
-import { SoftwareUpdate, SoftwareUpdateInput, SoftwareUpdatesFilters, PaginatedSoftwareUpdates } from './models';
+import { SoftwareUpdate, SoftwareUpdateInput, SoftwareUpdatesFilters, PaginatedSoftwareUpdates, IssueSoftwareUpdateInput } from './models';
 interface SoftwareUpdatesInterface extends BaseModelInterface<SoftwareUpdate, SoftwareUpdateInput, SoftwareUpdatesFilters, PaginatedSoftwareUpdates> {
     update(softwareUpdate: SoftwareUpdate): Promise<SoftwareUpdate>;
     deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
+    bulkSoftwareUpdate(payload: IssueSoftwareUpdateInput): Promise<BulkActionResponse>;
 }
 export declare const SoftwareUpdates: SoftwareUpdatesInterface;
 export {};

package/dist/softwareUpdates/index.js

@@ -220,5 +220,29 @@ exports.SoftwareUpdates = (function (_super) {
             });
         });
     };
+    class_1.bulkSoftwareUpdate = function (payload) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_7;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Issuing software updates with payload " + payload);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.post(constants_1.Endpoints.device + "/bulk/software_update", payload)];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data];
+                    case 2:
+                        error_7 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_7)) {
+                            throw error_7;
+                        }
+                        throw error_7;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
     return class_1;
 }(ModelClass_1.BaseModelClass));

package/dist/softwareUpdates/models.d.ts

@@ -1,3 +1,4 @@
+import { CommandSchedule } from '../gatewayCommands/models';
 import { Base, Filter, Filters, Pagination } from '../models';
 export interface FileLocation {
     name: string;
@@ -20,3 +21,10 @@ export interface PaginatedSoftwareUpdates {
     softwareUpdates: SoftwareUpdate[];
     pagination: Pagination;
 }
+export declare type IssueSoftwareUpdateCommandType = 'software_update';
+export interface IssueSoftwareUpdateInput {
+    ids: Array<string>;
+    software_update_id: string;
+    command_type: IssueSoftwareUpdateCommandType;
+    schedule?: CommandSchedule;
+}

package/dist/testConstants.js

@@ -143,22 +143,104 @@ exports.TestIntegration2 = {
     from: 'test_from',
 };
 exports.NewIntegrationName = 'EIQSDK Integration Test Twilio';
-exports.EmptyIngestor = __assign(__assign({}, baseModel), { name: '', type: 'cloud', translator_id: '', handler_type: 'fixed', listener_type: 'cloud' });
+exports.EmptyIngestor = __assign(__assign({}, baseModel), { company_id: '', name: '', type: 'edge', listener_type: 'shell_polling', handler_type: 'fixed', translator_id: '', listener: {
+        version: '1',
+        params: {
+            address: '',
+        },
+        filters: [
+            {
+                interface: '',
+                member: '',
+                path: '',
+            },
+        ],
+        device_type_mapping: [
+            {
+                device_type_id: '',
+                key: '',
+                value: '',
+            },
+        ],
+    }, handler: {
+        routes: [
+            {
+                method: 'get',
+                path: '',
+            },
+        ],
+    } });
 exports.TestIngestor = {
     company_id: parentCompanyId,
     name: 'EIQSDK Ingestor Test',
-    handler_type: 'passthrough',
+    type: 'cloud',
     listener_type: 'cloud',
+    handler_type: 'passthrough',
     translator_id: '6091323844952b0001bf9b33',
-    type: 'cloud',
+    listener: {
+        version: '1',
+        params: {
+            address: '',
+        },
+        filters: [
+            {
+                interface: '',
+                member: '',
+                path: '',
+            },
+        ],
+        device_type_mapping: [
+            {
+                device_type_id: '',
+                key: '',
+                value: '',
+            },
+        ],
+    },
+    handler: {
+        routes: [
+            {
+                method: 'get',
+                path: '',
+            },
+        ],
+    },
 };
 exports.TestIngestor2 = {
     company_id: parentCompanyId,
     name: 'EIQSDK Ingestor Test 2',
-    handler_type: 'fixed',
+    type: 'edge',
     listener_type: 'shell_polling',
+    handler_type: 'fixed',
     translator_id: '618bcb593b04d60001358801',
-    type: 'edge',
+    listener: {
+        version: '1',
+        params: {
+            address: '',
+        },
+        filters: [
+            {
+                interface: '',
+                member: '',
+                path: '',
+            },
+        ],
+        device_type_mapping: [
+            {
+                device_type_id: '',
+                key: '',
+                value: '',
+            },
+        ],
+    },
+    handler: {
+        routes: [
+            {
+                method: 'get',
+                path: '',
+            },
+        ],
+    },
 };
 exports.NewTestIngestorName = 'EIQSDK Ingestor Test updated';
 exports.EmptyPollableAttribute = __assign(__assign({}, baseModel), { name: '', type: 'snmp_mib', attributes: [], defaults: {}, interval: 16 });

package/package.json

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