@edgeiq/edgeiq-api-js 1.3.22 → 1.3.25

package/dist/commandExecutions/index.d.ts

@@ -0,0 +1,7 @@
+import { CommandExecution, CommandExecutionsStatus } from './models';
+interface CommandExecutionsInterface {
+    get(): Promise<CommandExecution[]>;
+    getStatuses(id: string): Promise<CommandExecutionsStatus[]>;
+}
+export declare const CommandExecutions: CommandExecutionsInterface;
+export {};

package/dist/commandExecutions/index.js

@@ -0,0 +1,112 @@
+"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 __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.CommandExecutions = void 0;
+var constants_1 = require("../constants");
+var ModelClass_1 = require("../core/ModelClass");
+var helpers_1 = require("../helpers");
+var core_1 = require("../core");
+exports.CommandExecutions = (function (_super) {
+    __extends(class_1, _super);
+    function class_1() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    class_1.get = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        axios = core_1.EdgeIQAPI.getAxios();
+                        return [4, axios.get("" + constants_1.Endpoints.commandExecution)];
+                    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.getStatuses = function (id) {
+        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("Getting statuses attached to command executions with id " + id);
+                        axios = core_1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.commandExecution + "/" + id + "/command_execution_statuses")];
+                    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];
+                }
+            });
+        });
+    };
+    return class_1;
+}(ModelClass_1.BaseModelClass));

package/dist/commandExecutions/models.d.ts

@@ -0,0 +1,21 @@
+import { Base, Filter, Filters, Pagination } from '../models';
+export interface CommandExecutionsInput {
+    commandId: string;
+    execution_statuses: CommandExecutionsStatus[];
+}
+export declare type CommandExecutionStatus = 'initiated' | 'info' | 'success' | 'error';
+export interface CommandExecutionsStatus extends Base {
+    execution_id: string;
+    status: CommandExecutionStatus;
+    message?: string;
+}
+export interface CommandExecution extends CommandExecutionsInput, Base {
+}
+export interface CommandExecutionsFilters extends Filters {
+    command_id?: Filter;
+    status?: Filter;
+}
+export interface PaginatedCommandExecutions {
+    commandExecutions: CommandExecution[];
+    pagination: Pagination;
+}

package/dist/commandExecutions/models.js

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

package/dist/commands/index.d.ts

@@ -1,6 +1,7 @@
 import { BaseModelInterface } from '../core/ModelClass';
-import { BulkActionResponse } from '../models';
+import { BulkActionResponse, PaginationFilter } from '../models';
 import { Command, CommandInput, CommandsFilters, PaginatedCommands } from './models';
+import { CommandExecutionsFilters, PaginatedCommandExecutions } from '../commandExecutions/models';
 interface CommandsInterface extends BaseModelInterface<Command, CommandInput, CommandsFilters, PaginatedCommands> {
     update(command: Command): Promise<Command>;
     deleteMultiple(ids: string[]): Promise<BulkActionResponse>;
@@ -14,6 +15,7 @@ interface CommandsInterface extends BaseModelInterface<Command, CommandInput, Co
             type: string;
         };
     }): Promise<string>;
+    getCommandExecutions(id: string, filters: CommandExecutionsFilters, pagination: PaginationFilter): Promise<PaginatedCommandExecutions>;
 }
 export declare const Commands: CommandsInterface;
 export {};

package/dist/commands/index.js

@@ -340,5 +340,39 @@ exports.Commands = (function (_super) {
             });
         });
     };
+    class_1.getCommandExecutions = function (id, filters, pagination) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_12;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        _e.trys.push([0, 2, , 3]);
+                        this.logAction("Getting command executions attached to command with id " + id + ".\n And pagination " + (pagination !== null && pagination !== void 0 ? pagination : '{}'));
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.command + "/" + id + "/command_executions", {
+                                params: (0, filtersParser_1.parseFilters)(filters, pagination),
+                            })];
+                    case 1:
+                        result = _e.sent();
+                        return [2, {
+                                commandExecutions: (_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_12 = _e.sent();
+                        if ((0, helpers_1.isApiError)(error_12)) {
+                            throw error_12;
+                        }
+                        throw error_12;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
     return class_1;
 }(ModelClass_1.BaseModelClass));

package/dist/constants.d.ts

@@ -55,6 +55,7 @@ export declare const BaseEndpoints: {
     bulkResponse: string;
     notification: string;
     command: string;
+    commandExecution: string;
     company: string;
     deviceConfig: string;
     deviceError: string;
@@ -98,6 +99,7 @@ export declare const Endpoints: {
     notification: string;
     file: string;
     command: string;
+    commandExecution: string;
     company: string;
     deviceConfig: string;
     deviceError: string;

package/dist/constants.js

@@ -71,6 +71,7 @@ exports.BaseEndpoints = {
     bulkResponse: 'bulk_responses',
     notification: 'notifications',
     command: 'commands',
+    commandExecution: 'commandExecutions',
     company: 'companies',
     deviceConfig: 'device_configs',
     deviceError: 'device_errors',
@@ -114,6 +115,7 @@ exports.Endpoints = {
     notification: "" + exports.BaseEndpoints.notification,
     file: "" + exports.BaseEndpoints.file,
     command: "" + exports.BaseEndpoints.command,
+    commandExecution: "" + exports.BaseEndpoints.commandExecution,
     company: "" + exports.BaseEndpoints.company,
     deviceConfig: "" + exports.BaseEndpoints.deviceConfig,
     deviceError: "" + exports.BaseEndpoints.deviceError,

package/dist/devices/index.d.ts

@@ -6,6 +6,7 @@ import { BulkActionResponse } from '../models';
 import { Lwm2mObjectLinks } from '../lwm2m/models';
 import { DeviceFile } from '../deviceFiles/models';
 import { DevicesFilters, Device, DeviceInput, PaginatedDevices } from './models';
+import { CommandExecution } from '../commandExecutions/models';
 interface DevicesInterface extends BaseModelInterface<Device, DeviceInput, DevicesFilters, PaginatedDevices> {
     bulkCreate(uniqueIds: string[], deviceTypeId: string, namePrefix: string): Promise<BulkActionResponse>;
     update(device: Device): Promise<Device>;
@@ -27,6 +28,7 @@ interface DevicesInterface extends BaseModelInterface<Device, DeviceInput, Devic
     processGatewayCommand(deviceId: string, gatewayCommandRequest: GatewayCommandRequest): Promise<GatewayCommand>;
     bulkExecuteGatewayCommand(ids: string[], gatewayCommandRequest: GatewayCommandRequest): Promise<BulkActionResponse>;
     getFiles(id: string): Promise<DeviceFile[]>;
+    getCommandExecutions(id: string): Promise<CommandExecution[]>;
 }
 export declare const Devices: DevicesInterface;
 export {};

package/dist/devices/index.js

@@ -684,5 +684,29 @@ exports.Devices = (function (_super) {
             });
         });
     };
+    class_1.getCommandExecutions = function (id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var axios, result, error_25;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        this.logAction("Getting command executions attached to device with id " + id);
+                        axios = __1.EdgeIQAPI.getAxios();
+                        return [4, axios.get(constants_1.Endpoints.command + "/" + id + "/command_executions")];
+                    case 1:
+                        result = _a.sent();
+                        return [2, result === null || result === void 0 ? void 0 : result.data];
+                    case 2:
+                        error_25 = _a.sent();
+                        if ((0, helpers_1.isApiError)(error_25)) {
+                            throw error_25;
+                        }
+                        throw error_25;
+                    case 3: return [2];
+                }
+            });
+        });
+    };
     return class_1;
 }(ModelClass_1.BaseModelClass));

package/dist/index.d.ts

@@ -3,10 +3,12 @@ export { Authentication } from './auth';
 export { BulkResponses } from './bulkResponses';
 export { Commands } from './commands';
 export { Companies } from './companies';
+export { CommandExecutions } from './commandExecutions';
 export { DeviceConfigs } from './deviceConfigs';
 export { DeviceLocationObservations } from './deviceLocationObservations';
 export { Devices } from './devices';
 export { DeviceErrors } from './deviceErrors';
+export { DeviceFiles } from './deviceFiles';
 export { DeviceTemplates } from './deviceTemplates';
 export { DeviceTransferRequests } from './deviceTransferRequests';
 export { DeviceTypes } from './deviceTypes';
@@ -34,9 +36,11 @@ export * from './models';
 export * from './bulkResponses/models';
 export * from './commands/models';
 export * from './companies/models';
+export * from './commandExecutions/models';
 export * from './deviceConfigs/models';
 export * from './deviceLocationObservations/models';
 export * from './devices/models';
+export * from './deviceFiles/models';
 export * from './discoveredDevices/models';
 export * from './deviceErrors/models';
 export * from './deviceTemplates/models';

package/dist/index.js

@@ -10,7 +10,7 @@ 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.Stats = exports.SoftwareUpdates = exports.Secrets = exports.Rules = exports.Reports = exports.Regions = exports.PollableAttributes = exports.Notifications = exports.LWM2M = exports.Integrations = exports.Ingestors = exports.GatewayCommands = exports.EscrowDevices = exports.DownstreamSystems = exports.DiscoveredDevices = exports.DeviceTypes = exports.DeviceTransferRequests = exports.DeviceTemplates = exports.DeviceErrors = exports.Devices = exports.DeviceLocationObservations = exports.DeviceConfigs = exports.Companies = exports.Commands = exports.BulkResponses = exports.Authentication = exports.EdgeIQAPI = void 0;
+exports.UserTypes = exports.Users = exports.Translators = exports.SystemCommandJobs = exports.SystemCommands = exports.Stats = exports.SoftwareUpdates = exports.Secrets = exports.Rules = exports.Reports = exports.Regions = exports.PollableAttributes = exports.Notifications = exports.LWM2M = exports.Integrations = exports.Ingestors = exports.GatewayCommands = exports.EscrowDevices = exports.DownstreamSystems = exports.DiscoveredDevices = exports.DeviceTypes = exports.DeviceTransferRequests = exports.DeviceTemplates = exports.DeviceFiles = exports.DeviceErrors = exports.Devices = exports.DeviceLocationObservations = exports.DeviceConfigs = exports.CommandExecutions = 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");
@@ -21,6 +21,8 @@ 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 commandExecutions_1 = require("./commandExecutions");
+Object.defineProperty(exports, "CommandExecutions", { enumerable: true, get: function () { return commandExecutions_1.CommandExecutions; } });
 var deviceConfigs_1 = require("./deviceConfigs");
 Object.defineProperty(exports, "DeviceConfigs", { enumerable: true, get: function () { return deviceConfigs_1.DeviceConfigs; } });
 var deviceLocationObservations_1 = require("./deviceLocationObservations");
@@ -29,6 +31,8 @@ var devices_1 = require("./devices");
 Object.defineProperty(exports, "Devices", { enumerable: true, get: function () { return devices_1.Devices; } });
 var deviceErrors_1 = require("./deviceErrors");
 Object.defineProperty(exports, "DeviceErrors", { enumerable: true, get: function () { return deviceErrors_1.DeviceErrors; } });
+var deviceFiles_1 = require("./deviceFiles");
+Object.defineProperty(exports, "DeviceFiles", { enumerable: true, get: function () { return deviceFiles_1.DeviceFiles; } });
 var deviceTemplates_1 = require("./deviceTemplates");
 Object.defineProperty(exports, "DeviceTemplates", { enumerable: true, get: function () { return deviceTemplates_1.DeviceTemplates; } });
 var deviceTransferRequests_1 = require("./deviceTransferRequests");
@@ -79,9 +83,11 @@ __exportStar(require("./models"), exports);
 __exportStar(require("./bulkResponses/models"), exports);
 __exportStar(require("./commands/models"), exports);
 __exportStar(require("./companies/models"), exports);
+__exportStar(require("./commandExecutions/models"), exports);
 __exportStar(require("./deviceConfigs/models"), exports);
 __exportStar(require("./deviceLocationObservations/models"), exports);
 __exportStar(require("./devices/models"), exports);
+__exportStar(require("./deviceFiles/models"), exports);
 __exportStar(require("./discoveredDevices/models"), exports);
 __exportStar(require("./deviceErrors/models"), exports);
 __exportStar(require("./deviceTemplates/models"), exports);

package/package.json

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