@edgeiq/edgeiq-api-js 1.8.9 → 1.9.1

package/dist/constants.d.ts

@@ -89,6 +89,7 @@ export declare const BaseEndpoints: {
     setting: string;
     settingsApplicationRecord: string;
     softwareUpdate: string;
+    softwareVersion: string;
     stats: string;
     systemCommand: string;
     systemCommandJob: string;
@@ -142,6 +143,7 @@ export declare const Endpoints: {
     setting: string;
     settingsApplicationRecord: string;
     softwareUpdate: string;
+    softwareVersion: string;
     statsDevicesByHeartbeat: string;
     statsDiscoveredDevicesByHeartbeat: string;
     statsDevicesByType: string;

package/dist/constants.js

@@ -91,6 +91,7 @@ export const BaseEndpoints = {
     setting: 'settings',
     settingsApplicationRecord: 'settings_application_record',
     softwareUpdate: 'software_updates',
+    softwareVersion: 'software_versions',
     stats: 'stats',
     systemCommand: 'system_commands',
     systemCommandJob: 'system_command_jobs',
@@ -144,6 +145,7 @@ export const Endpoints = {
     setting: `${BaseEndpoints.setting}`,
     settingsApplicationRecord: `${BaseEndpoints.settingsApplicationRecord}`,
     softwareUpdate: `${BaseEndpoints.softwareUpdate}`,
+    softwareVersion: `${BaseEndpoints.softwareVersion}`,
     statsDevicesByHeartbeat: `${BaseEndpoints.stats}/devices/count_by_heartbeat_status`,
     statsDiscoveredDevicesByHeartbeat: `${BaseEndpoints.stats}/discovered_devices/count_by_heartbeat_status`,
     statsDevicesByType: `${BaseEndpoints.stats}/devices/count_by_type`,

package/dist/deviceTypes/index.d.ts

@@ -1,6 +1,6 @@
-import { Configuration, Command, Ingestor, PollableAttribute, Rule, Setting } from '..';
+import { Configuration, Command, Ingestor, PollableAttribute, Rule, SettingFilters, PaginatedSettings } from '..';
 import { BaseModelInterface } from '../core/ModelClass';
-import { BulkActionResponse } from '../models';
+import { BulkActionResponse, PaginationFilter } from '../models';
 import { DeviceType, DeviceTypeInput, DeviceTypesFilters, PaginatedDeviceTypes } from './models';
 interface DeviceTypesInterface extends BaseModelInterface<DeviceType, DeviceTypeInput, DeviceTypesFilters, PaginatedDeviceTypes> {
     update(deviceType: DeviceType): Promise<DeviceType>;
@@ -18,7 +18,7 @@ interface DeviceTypesInterface extends BaseModelInterface<DeviceType, DeviceType
     getConfigurations(id: string): Promise<Configuration[]>;
     attachConfiguration(id: string, configId: string): Promise<string>;
     detachConfiguration(id: string, configId: string): Promise<string>;
-    getSettings(id: string, configId?: string): Promise<Setting[]>;
+    getSettings(id: string, filters?: SettingFilters, pagination?: PaginationFilter): Promise<PaginatedSettings>;
     attachSettings(id: string, settingsId: string): Promise<string>;
     detachSettings(id: string, settingsId: string): Promise<string>;
 }

package/dist/deviceTypes/index.js

@@ -331,13 +331,23 @@ export const DeviceTypes = class extends BaseModelClass {
             }
         });
     }
-    static getSettings(id, configId) {
+    static getSettings(id, filters, pagination) {
+        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 this.logAction(`Getting settings attached to device type with id ${id}`);
                 const axios = EdgeIQAPI.getAxios();
-                const result = yield axios.get(`${Endpoints.deviceType}/${id}/${Endpoints.setting}${configId ? `?configuration_id=${configId}` : ''}`);
-                return result === null || result === void 0 ? void 0 : result.data;
+                const result = yield axios.get(`${Endpoints.deviceType}/${id}/${Endpoints.setting}`, {
+                    params: parseFilters(filters, pagination),
+                });
+                return {
+                    settings: (_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)) {

package/dist/deviceTypes/models.d.ts

@@ -55,6 +55,7 @@ export interface Actions {
     sms: boolean;
     sms_at_command_status_request: boolean;
     software_update: boolean;
+    software_version: boolean;
     status: boolean;
     tcp: boolean;
     tcp_modbus: boolean;

package/dist/devices/index.d.ts

@@ -1,4 +1,4 @@
-import { Command, EIQFile, Ingestor, Log, Rule, Setting } from '..';
+import { Command, EIQFile, Ingestor, Log, PaginatedSettings, Rule, SettingFilters } from '..';
 import { BaseModelInterface } from '../core/ModelClass';
 import { GatewayCommand, GatewayCommandRequest } from '../gatewayCommands/models';
 import { BulkActionResponse, PaginationFilter } from '../models';
@@ -32,10 +32,10 @@ interface DevicesInterface extends BaseModelInterface<Device, DeviceInput, Devic
         [key: string]: string | number;
     }, generateChildCommandExecutions?: boolean): Promise<BulkActionResponse>;
     getFiles(id: string): Promise<EIQFile[]>;
-    getCommandExecutions(id: string, filters: CommandExecutionsFilters, pagination: PaginationFilter): Promise<PaginatedCommandExecutions>;
+    getCommandExecutions(id: string, filters?: CommandExecutionsFilters, pagination?: PaginationFilter): Promise<PaginatedCommandExecutions>;
     startRemoteTerminal(id: string, executable?: string): Promise<string>;
     stopRemoteTerminal(id: string): Promise<string>;
-    getSettings(id: string, configId?: string): Promise<Setting[]>;
+    getSettings(id: string, filters?: SettingFilters, pagination?: PaginationFilter): Promise<PaginatedSettings>;
     attachSettings(id: string, settingsId: string): Promise<string>;
     detachSettings(id: string, settingsId: string): Promise<string>;
     dryRunCommand(id: string, commandId: string, data?: {

package/dist/devices/index.js

@@ -555,13 +555,23 @@ export const Devices = class extends BaseModelClass {
             }
         });
     }
-    static getSettings(id, configId) {
+    static getSettings(id, filters, pagination) {
+        var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 this.logAction(`Getting settings attached to device with id ${id}`);
                 const axios = EdgeIQAPI.getAxios();
-                const result = yield axios.get(`${Endpoints.device}/${id}/${Endpoints.setting}${configId ? `?configuration_id=${configId}` : ''}`);
-                return result === null || result === void 0 ? void 0 : result.data;
+                const result = yield axios.get(`${Endpoints.device}/${id}/${Endpoints.setting}`, {
+                    params: parseFilters(filters, pagination),
+                });
+                return {
+                    settings: (_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)) {

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' | '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' | '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

@@ -29,6 +29,7 @@ export { Secrets } from './secrets';
 export { Settings } from './settings';
 export { SettingApplicationRecords } from './settingsApplicationRecord';
 export { SoftwareUpdates } from './softwareUpdates';
+export { SoftwareVersions } from './softwareVersions';
 export { Stats } from './stats';
 export { SystemCommands } from './systemCommands';
 export { SystemCommandJobs } from './systemCommandJobs';
@@ -73,6 +74,7 @@ export * from './settings/models';
 export * from './settingsApplicationRecord/models';
 export * from './stats/models';
 export * from './softwareUpdates/models';
+export * from './softwareVersions/models';
 export * from './systemCommands/models';
 export * from './systemCommandJobs/models';
 export * from './translators/models';

package/dist/index.js

@@ -29,6 +29,7 @@ export { Secrets } from './secrets';
 export { Settings } from './settings';
 export { SettingApplicationRecords } from './settingsApplicationRecord';
 export { SoftwareUpdates } from './softwareUpdates';
+export { SoftwareVersions } from './softwareVersions';
 export { Stats } from './stats';
 export { SystemCommands } from './systemCommands';
 export { SystemCommandJobs } from './systemCommandJobs';
@@ -73,6 +74,7 @@ export * from './settings/models';
 export * from './settingsApplicationRecord/models';
 export * from './stats/models';
 export * from './softwareUpdates/models';
+export * from './softwareVersions/models';
 export * from './systemCommands/models';
 export * from './systemCommandJobs/models';
 export * from './translators/models';

package/dist/softwareVersions/index.d.ts

@@ -0,0 +1,6 @@
+import { PaginationFilter } from '..';
+import { PaginatedSoftwareVersions, SoftwareVersionsFilters } from './models';
+declare const SoftwareVersions: {
+    list: (filters?: SoftwareVersionsFilters | undefined, pagination?: PaginationFilter | undefined) => Promise<PaginatedSoftwareVersions>;
+};
+export { SoftwareVersions };

package/dist/softwareVersions/index.js

@@ -0,0 +1,40 @@
+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 { isApiError } from '../helpers';
+import { parseFilters } from '../filtersParser';
+const SoftwareVersions = {
+    list: (filters, pagination) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b, _c, _d;
+        try {
+            EdgeIQAPI.logAction(`Getting software versions`);
+            const axios = EdgeIQAPI.getAxios();
+            const result = yield axios.get(Endpoints.softwareVersion, {
+                params: parseFilters(filters, pagination),
+            });
+            return {
+                softwareVersions: (_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;
+        }
+    }),
+};
+export { SoftwareVersions };

package/dist/softwareVersions/models.d.ts

@@ -0,0 +1,26 @@
+import { Base, Filter, Filters, Pagination } from '../models';
+export declare type VersionSourceType = 'apt' | 'snap';
+export interface SoftwareVersion extends Base {
+    device_id: string;
+    name: string;
+    notes?: string;
+    source: VersionSourceType;
+    publisher?: string;
+    version_raw?: string;
+    version_major?: number;
+    version_minor?: number;
+    version_patch?: number;
+    version_prerelease?: string;
+    version_metadata?: string;
+    revision?: number;
+    track?: string;
+}
+export interface SoftwareVersionsFilters extends Filters {
+    device_id?: Filter;
+    name?: Filter;
+    source?: Filter;
+}
+export interface PaginatedSoftwareVersions {
+    softwareVersions: SoftwareVersion[];
+    pagination: Pagination;
+}

package/dist/softwareVersions/models.js

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

package/package.json

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