@edgeiq/edgeiq-api-js 1.0.0

package/dist/gatewayCommands/index.js

@@ -0,0 +1,261 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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.GatewayCommands = void 0;
+var __1 = require("..");
+var constants_1 = require("../constants");
+var ModelClass_1 = require("../core/ModelClass");
+var filtersParser_1 = require("../filtersParser");
+var helpers_1 = require("../helpers");
+exports.GatewayCommands = (function (_super) {
+    __extends(class_1, _super);
+    function class_1() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    class_1.create = function (gatewayCommand) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, data, result, error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Creating gateway command of type: " + gatewayCommand.command_type);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        data = JSON.stringify(gatewayCommand);
+                        return [4, axios.post(constants_1.Endpoints.gatewayCommand, data)];
+                    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];
+                }
+            });
+        });
+    };
+    class_1.bulkCreate = function (ids, gatewayCommand) {
+        return __awaiter(this, 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]);
+                        this.logAction("Creating " + ids.length + " gateway commands with type " + gatewayCommand.command_type);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.post(constants_1.Endpoints.device + "/bulk", {
+                                data: __assign({ ids: ids }, gatewayCommand),
+                            })];
+                    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];
+                }
+            });
+        });
+    };
+    class_1.update = function (gatewayCommand) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, data, result, error_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Updating gateway command with ID: " + gatewayCommand._id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        data = JSON.stringify(gatewayCommand);
+                        return [4, axios.put(constants_1.Endpoints.gatewayCommand + "/" + gatewayCommand._id, data)];
+                    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];
+                }
+            });
+        });
+    };
+    class_1.list = function (filters, pagination) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_4;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        _e.trys.push([0, 2, , 3]);
+                        this.logAction("Listing gateway commands with following filters: " + (filters !== null && filters !== void 0 ? filters : '{}') + ".\n And pagination " + (pagination !== null && pagination !== void 0 ? pagination : '{}'));
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.gatewayCommand, {
+                                params: (0, filtersParser_1.parseFilters)(filters, pagination),
+                            })];
+                    case 1:
+                        result = _e.sent();
+                        return [2, {
+                                gatewayCommands: (_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,
+                                },
+                            }];
+                    case 2:
+                        error_4 = _e.sent();
+                        if ((0, helpers_1.isApiError)(error_4)) {
+                            throw error_4;
+                        }
+                        throw error_4;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.getOneById = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_5;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Getting gateway command with id: " + id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.gatewayCommand + "/" + id)];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data];
+                    case 2:
+                        error_5 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_5)) {
+                            throw error_5;
+                        }
+                        throw error_5;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
+    class_1.delete = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, error_6;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Deleting gatewayCommand with id " + id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.delete(constants_1.Endpoints.gatewayCommand + "/" + id)];
+                    case 1:
+                        _a.sent();
+                        return [2, (0, helpers_1.getReturnDeleteMessage)('gatewayCommand')];
+                    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.deleteMultiple = function (ids) {
+        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("Deleting gateway commands with ids " + ids.join(', '));
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.delete(constants_1.Endpoints.gatewayCommand + "/bulk", {
+                                data: { ids: ids },
+                            })];
+                    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/gatewayCommands/models.d.ts

@@ -0,0 +1,41 @@
+import { Base, Filter, Filters, Pagination } from '../models';
+export declare type GatewayCommandType = 'send_config' | 'data_restriction' | 'backup' | 'restore_backup' | 'log_level' | 'log_upload' | 'reboot' | 'heartbeat' | 'software_update' | 'status';
+export interface CommandSchedule {
+    start_datetime: string;
+    end_datetime: string;
+    retry_interval?: string;
+}
+export interface GatewayCommandStatus {
+    status: string;
+    status_message?: string;
+}
+export interface GatewayCommandInput {
+    command_type: GatewayCommandType;
+    payload: {
+        [key: string]: unknown;
+    };
+    schedule?: CommandSchedule;
+    timeout?: number;
+    statuses: {
+        [key: string]: GatewayCommandStatus;
+    };
+    device_config_id?: string;
+    device_id?: string;
+    device_unique_id?: string;
+    device_type_id?: string;
+    software_update_id?: string;
+    attached_device_ids: string[];
+    attached_device_unique_ids: string[];
+}
+export interface GatewayCommand extends GatewayCommandInput, Base {
+}
+export interface GatewayCommandsFilters extends Filters {
+    command_type?: Filter;
+    device_id?: Filter;
+    device_unique_id?: Filter;
+    device_type_id?: Filter;
+}
+export interface PaginatedGatewayCommands {
+    gatewayCommands: GatewayCommand[];
+    pagination: Pagination;
+}

package/dist/gatewayCommands/models.js

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

package/dist/helpers.d.ts

@@ -0,0 +1,3 @@
+declare const getReturnDeleteMessage: (model: string) => string;
+declare const isApiError: (error: unknown) => error is Error;
+export { getReturnDeleteMessage, isApiError };

package/dist/helpers.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isApiError = exports.getReturnDeleteMessage = void 0;
+var getReturnDeleteMessage = function (model) {
+    return "The " + model + " has been deleted correctly.";
+};
+exports.getReturnDeleteMessage = getReturnDeleteMessage;
+var isApiError = function (error) {
+    return error.message !== undefined;
+};
+exports.isApiError = isApiError;

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+export { EdgeIQAPI, EdgeIQAPIOptions } from './core';
+export { Authentication } from './auth';
+export { BulkResponses } from './bulkResponses';
+export { Commands } from './commands';
+export { Companies } from './companies';
+export { DeviceConfigs } from './deviceConfigs';
+export { DeviceLocationObservations } from './deviceLocationObservations';
+export { Devices } from './devices';
+export { DeviceTemplates } from './deviceTemplates';
+export { DeviceTransferRequests } from './deviceTransferRequests';
+export { DeviceTypes } from './deviceTypes';
+export { DownstreamSystems } from './downstreamSystems';
+export { EscrowDevices } from './escrowDevices';
+export { GatewayCommands } from './gatewayCommands';
+export { Ingestors } from './ingestors';
+export { Integrations } from './integrations';
+export { PollableAttributes } from './pollableAttributes';
+export { Regions } from './regions';
+export { Reports } from './reports';
+export { Rules } from './rules';
+export { Secrets } from './secrets';
+export { SoftwareUpdates } from './softwareUpdates';
+export { SystemCommands } from './systemCommands';
+export { SystemCommandJobs } from './systemCommandJobs';
+export { Translators } from './translators';
+export { Users } from './users';
+export { UserTypes } from './userTypes';
+export * from './bulkResponses/models';
+export * from './commands/models';
+export * from './companies/models';
+export * from './deviceConfigs/models';
+export * from './deviceLocationObservations/models';
+export * from './devices/models';
+export * from './deviceTemplates/models';
+export * from './deviceTransferRequests/models';
+export * from './deviceTypes/models';
+export * from './downstreamSystems/models';
+export * from './escrowDevices/models';
+export * from './gatewayCommands/models';
+export * from './ingestors/models';
+export * from './integrations/models';
+export * from './pollableAttributes/models';
+export * from './reports/models';
+export * from './regions/models';
+export * from './rules/models';
+export * from './secrets/models';
+export * from './softwareUpdates/models';
+export * from './systemCommands/models';
+export * from './systemCommandJobs/models';
+export * from './translators/models';
+export * from './users/models';
+export * from './userTypes/models';

package/dist/index.js

@@ -0,0 +1,92 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserTypes = exports.Users = exports.Translators = exports.SystemCommandJobs = exports.SystemCommands = exports.SoftwareUpdates = exports.Secrets = exports.Rules = exports.Reports = exports.Regions = exports.PollableAttributes = exports.Integrations = exports.Ingestors = exports.GatewayCommands = exports.EscrowDevices = exports.DownstreamSystems = exports.DeviceTypes = exports.DeviceTransferRequests = exports.DeviceTemplates = exports.Devices = exports.DeviceLocationObservations = exports.DeviceConfigs = exports.Companies = exports.Commands = exports.BulkResponses = exports.Authentication = exports.EdgeIQAPI = void 0;
+var core_1 = require("./core");
+Object.defineProperty(exports, "EdgeIQAPI", { enumerable: true, get: function () { return core_1.EdgeIQAPI; } });
+var auth_1 = require("./auth");
+Object.defineProperty(exports, "Authentication", { enumerable: true, get: function () { return auth_1.Authentication; } });
+var bulkResponses_1 = require("./bulkResponses");
+Object.defineProperty(exports, "BulkResponses", { enumerable: true, get: function () { return bulkResponses_1.BulkResponses; } });
+var commands_1 = require("./commands");
+Object.defineProperty(exports, "Commands", { enumerable: true, get: function () { return commands_1.Commands; } });
+var companies_1 = require("./companies");
+Object.defineProperty(exports, "Companies", { enumerable: true, get: function () { return companies_1.Companies; } });
+var deviceConfigs_1 = require("./deviceConfigs");
+Object.defineProperty(exports, "DeviceConfigs", { enumerable: true, get: function () { return deviceConfigs_1.DeviceConfigs; } });
+var deviceLocationObservations_1 = require("./deviceLocationObservations");
+Object.defineProperty(exports, "DeviceLocationObservations", { enumerable: true, get: function () { return deviceLocationObservations_1.DeviceLocationObservations; } });
+var devices_1 = require("./devices");
+Object.defineProperty(exports, "Devices", { enumerable: true, get: function () { return devices_1.Devices; } });
+var deviceTemplates_1 = require("./deviceTemplates");
+Object.defineProperty(exports, "DeviceTemplates", { enumerable: true, get: function () { return deviceTemplates_1.DeviceTemplates; } });
+var deviceTransferRequests_1 = require("./deviceTransferRequests");
+Object.defineProperty(exports, "DeviceTransferRequests", { enumerable: true, get: function () { return deviceTransferRequests_1.DeviceTransferRequests; } });
+var deviceTypes_1 = require("./deviceTypes");
+Object.defineProperty(exports, "DeviceTypes", { enumerable: true, get: function () { return deviceTypes_1.DeviceTypes; } });
+var downstreamSystems_1 = require("./downstreamSystems");
+Object.defineProperty(exports, "DownstreamSystems", { enumerable: true, get: function () { return downstreamSystems_1.DownstreamSystems; } });
+var escrowDevices_1 = require("./escrowDevices");
+Object.defineProperty(exports, "EscrowDevices", { enumerable: true, get: function () { return escrowDevices_1.EscrowDevices; } });
+var gatewayCommands_1 = require("./gatewayCommands");
+Object.defineProperty(exports, "GatewayCommands", { enumerable: true, get: function () { return gatewayCommands_1.GatewayCommands; } });
+var ingestors_1 = require("./ingestors");
+Object.defineProperty(exports, "Ingestors", { enumerable: true, get: function () { return ingestors_1.Ingestors; } });
+var integrations_1 = require("./integrations");
+Object.defineProperty(exports, "Integrations", { enumerable: true, get: function () { return integrations_1.Integrations; } });
+var pollableAttributes_1 = require("./pollableAttributes");
+Object.defineProperty(exports, "PollableAttributes", { enumerable: true, get: function () { return pollableAttributes_1.PollableAttributes; } });
+var regions_1 = require("./regions");
+Object.defineProperty(exports, "Regions", { enumerable: true, get: function () { return regions_1.Regions; } });
+var reports_1 = require("./reports");
+Object.defineProperty(exports, "Reports", { enumerable: true, get: function () { return reports_1.Reports; } });
+var rules_1 = require("./rules");
+Object.defineProperty(exports, "Rules", { enumerable: true, get: function () { return rules_1.Rules; } });
+var secrets_1 = require("./secrets");
+Object.defineProperty(exports, "Secrets", { enumerable: true, get: function () { return secrets_1.Secrets; } });
+var softwareUpdates_1 = require("./softwareUpdates");
+Object.defineProperty(exports, "SoftwareUpdates", { enumerable: true, get: function () { return softwareUpdates_1.SoftwareUpdates; } });
+var systemCommands_1 = require("./systemCommands");
+Object.defineProperty(exports, "SystemCommands", { enumerable: true, get: function () { return systemCommands_1.SystemCommands; } });
+var systemCommandJobs_1 = require("./systemCommandJobs");
+Object.defineProperty(exports, "SystemCommandJobs", { enumerable: true, get: function () { return systemCommandJobs_1.SystemCommandJobs; } });
+var translators_1 = require("./translators");
+Object.defineProperty(exports, "Translators", { enumerable: true, get: function () { return translators_1.Translators; } });
+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("./bulkResponses/models"), exports);
+__exportStar(require("./commands/models"), exports);
+__exportStar(require("./companies/models"), exports);
+__exportStar(require("./deviceConfigs/models"), exports);
+__exportStar(require("./deviceLocationObservations/models"), exports);
+__exportStar(require("./devices/models"), exports);
+__exportStar(require("./deviceTemplates/models"), exports);
+__exportStar(require("./deviceTransferRequests/models"), exports);
+__exportStar(require("./deviceTypes/models"), exports);
+__exportStar(require("./downstreamSystems/models"), exports);
+__exportStar(require("./escrowDevices/models"), exports);
+__exportStar(require("./gatewayCommands/models"), exports);
+__exportStar(require("./ingestors/models"), exports);
+__exportStar(require("./integrations/models"), exports);
+__exportStar(require("./pollableAttributes/models"), exports);
+__exportStar(require("./reports/models"), exports);
+__exportStar(require("./regions/models"), exports);
+__exportStar(require("./rules/models"), exports);
+__exportStar(require("./secrets/models"), exports);
+__exportStar(require("./softwareUpdates/models"), exports);
+__exportStar(require("./systemCommands/models"), exports);
+__exportStar(require("./systemCommandJobs/models"), exports);
+__exportStar(require("./translators/models"), exports);
+__exportStar(require("./users/models"), exports);
+__exportStar(require("./userTypes/models"), exports);

package/dist/ingestors/index.d.ts

@@ -0,0 +1,9 @@
+import { BaseModelInterface } from '../core/ModelClass';
+import { BulkActionResponse } from '../models';
+import { Ingestor, IngestorInput, IngestorsFilters, PaginatedIngestors } from './models';
+interface IngestorsInterface extends BaseModelInterface<Ingestor, IngestorInput, IngestorsFilters, PaginatedIngestors> {
+    update(ingestor: Ingestor): Promise<Ingestor>;
+    deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
+}
+export declare const Ingestors: IngestorsInterface;
+export {};