@shieldiot/pulse-lib 1.0.412 → 2.0.1409

package/dist/esm/lib/services/UsrDevicesService.d.ts

@@ -0,0 +1,125 @@
+import { RestUtils } from '../../rest-utils';
+import { Device } from '../model';
+import { EntityResponse } from '../model';
+import { Entities } from '../model';
+import { SeverityTypeCode } from '../model';
+import { Distribution } from '../model';
+import { MapBounds } from '../model';
+import { DeviceTypeCode } from '../model';
+import { DeviceReport } from '../model';
+import { DevicesMap } from '../model';
+import { DeviceStatusCode } from '../model';
+import { DeviceActionCode } from '../model';
+import { DeviceWithEvents } from '../model';
+import { NetworkMap } from '../model';
+import { TimeSeries } from '../model';
+import { EntitiesResponse } from '../model';
+import { ActionResponse } from '../model';
+import { NetworkMapTypeCode } from '../model';
+import { TimeSeriesConsumption } from '../model';
+export declare class UsrDevicesService {
+    private apiUrl;
+    private rest;
+    private baseUrl;
+    constructor(apiUrl: string, rest: RestUtils);
+    /**
+     * Create new device
+     */
+    create(body?: Device): import("rxjs").Observable<EntityResponse<Device>>;
+    /**
+     * Create bulk of new devices
+     */
+    bulkCreate(body?: Entities<Device>): import("rxjs").Observable<EntitiesResponse<Device>>;
+    /**
+     * Update existing device
+     */
+    update(body?: Device): import("rxjs").Observable<EntityResponse<Device>>;
+    /**
+     * Create bulk of new devices
+     */
+    bulkUpdate(body?: Entities<Device>): import("rxjs").Observable<EntitiesResponse<Device>>;
+    /**
+     * Delete device
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get a single device by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Device>>;
+    /**
+     * Find devices by query
+     */
+    find(streamId?: string, search?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[], sort?: string, page?: number, size?: number, ids?: string[]): import("rxjs").Observable<EntitiesResponse<Device>>;
+    /**
+     * Export devices by query to a file as a stream of CSV | JSON | XML | XLSX
+     */
+    export(format?: string, streamId?: string, search?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], sort?: string, page?: number, size?: number): void;
+    /**
+     * Upload device list from csv file
+     */
+    upload(file: File, streamId?: string, ip?: number[], iccid?: number[], imsi?: number[], msisdn?: number[], imei?: number, name?: number, operator?: number, label?: number[], tag?: number[], country?: number, city?: number, street?: number, postal?: number, lon?: number, lat?: number): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get list of all existing distinct tags on devices
+     */
+    getTags(streamId?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Add tag to a device
+     */
+    addTag(id?: string, tag?: string): import("rxjs").Observable<EntityResponse<Device>>;
+    /**
+     * Delete tag from a device
+     */
+    deleteTag(id?: string, tag?: string): import("rxjs").Observable<EntityResponse<Device>>;
+    /**
+     * Apply action on a device
+     */
+    applyAction(id?: string, action?: DeviceActionCode): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Find top 10 devices by their score and filter criteria
+     */
+    findTop(streamId?: string, search?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[], sort?: string, page?: number, size?: number, ids?: string[]): import("rxjs").Observable<EntitiesResponse<DeviceWithEvents>>;
+    /**
+     * Get device distribution by type filtered by query
+     */
+    countByType(streamId?: string, search?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
+    /**
+     * Get device distribution by status filtered by query
+     */
+    countByStatus(streamId?: string, search?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
+    /**
+     * Get device distribution by action filtered by query
+     */
+    countByAction(streamId?: string, search?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
+    /**
+     * Get network map of devices
+     */
+    getNetworkMap(streamId?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], id?: string[], mapType?: NetworkMapTypeCode, ips?: string[], limit?: number): import("rxjs").Observable<EntityResponse<NetworkMap>>;
+    /**
+     * Get latest device report, the Key contains latest devices at risk number (works in account level)
+     */
+    getLatestDeviceReport(): import("rxjs").Observable<EntityResponse<DeviceReport>>;
+    /**
+     * Get devicesAtRisk histogram over the provided time period
+     */
+    getDeviceReportTimeline(streamId?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<TimeSeries<DeviceReport>>>;
+    /**
+     * Get device / group of devices consumption over time
+     */
+    getConsumptionTimeline(streamId?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], id?: string[]): import("rxjs").Observable<EntityResponse<TimeSeriesConsumption>>;
+    /**
+     * Get device / group of devices consumption trend: 7 days consumption compared to the average of the previous weeks
+     */
+    getConsumptionTrend(streamId?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], id?: string[]): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Find devices by insight id query
+     */
+    findByInsightContext(streamId?: string, tag?: string[], from?: number, to?: number, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Device>>;
+    /**
+     * Find devices by query
+     */
+    findDevicesMap(streamId?: string, search?: string, type?: DeviceTypeCode[], tag?: string[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[], sort?: string, page?: number, size?: number, mapBounds?: MapBounds): import("rxjs").Observable<EntityResponse<DevicesMap>>;
+    /**
+     * Get device distribution by risk filtered by query
+     */
+    countByRisk(streamId?: string, search?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
+}

package/dist/esm/lib/services/UsrDevicesService.js

@@ -0,0 +1,567 @@
+// UsrDevicesEndPoint device related actions for the operator 
+export class UsrDevicesService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/devices';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new device
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Create bulk of new devices
+     */
+    bulkCreate(body) {
+        return this.rest.put(`${this.baseUrl}/bulk`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing device
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Create bulk of new devices
+     */
+    bulkUpdate(body) {
+        return this.rest.patch(`${this.baseUrl}/bulk`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete device
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get a single device by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find devices by query
+     */
+    find(streamId, search, from, to, type, tag, status, risk, scoreRange, sort, page, size, ids) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (risk != null) {
+            params.push(`risk=${risk}`);
+        }
+        if (scoreRange != null) {
+            params.push(`scoreRange=${scoreRange}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (ids != null) {
+            params.push(`ids=${ids}`);
+        }
+        return this.rest.get(`${this.baseUrl}`, ...params);
+    }
+    /**
+     * Export devices by query to a file as a stream of CSV | JSON | XML | XLSX
+     */
+    export(format, streamId, search, from, to, type, tag, status, risk, sort, page, size) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (risk != null) {
+            params.push(`risk=${risk}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        return this.rest.download(`usr-devices`, `${this.baseUrl}/export/${format}`, ...params);
+    }
+    /**
+     * Upload device list from csv file
+     */
+    upload(file, streamId, ip, iccid, imsi, msisdn, imei, name, operator, label, tag, country, city, street, postal, lon, lat) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (ip != null) {
+            params.push(`ip=${ip}`);
+        }
+        if (iccid != null) {
+            params.push(`iccid=${iccid}`);
+        }
+        if (imsi != null) {
+            params.push(`imsi=${imsi}`);
+        }
+        if (msisdn != null) {
+            params.push(`msisdn=${msisdn}`);
+        }
+        if (imei != null) {
+            params.push(`imei=${imei}`);
+        }
+        if (name != null) {
+            params.push(`name=${name}`);
+        }
+        if (operator != null) {
+            params.push(`operator=${operator}`);
+        }
+        if (label != null) {
+            params.push(`label=${label}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (country != null) {
+            params.push(`country=${country}`);
+        }
+        if (city != null) {
+            params.push(`city=${city}`);
+        }
+        if (street != null) {
+            params.push(`street=${street}`);
+        }
+        if (postal != null) {
+            params.push(`postal=${postal}`);
+        }
+        if (lon != null) {
+            params.push(`lon=${lon}`);
+        }
+        if (lat != null) {
+            params.push(`lat=${lat}`);
+        }
+        return this.rest.post(`${this.baseUrl}/upload`, '', ...params);
+    }
+    /**
+     * Get list of all existing distinct tags on devices
+     */
+    getTags(streamId) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        return this.rest.get(`${this.baseUrl}/tags`, ...params);
+    }
+    /**
+     * Add tag to a device
+     */
+    addTag(id, tag) {
+        return this.rest.post(`${this.baseUrl}/${id}/tags/${tag}`, '');
+    }
+    /**
+     * Delete tag from a device
+     */
+    deleteTag(id, tag) {
+        return this.rest.delete(`${this.baseUrl}/${id}/tags/${tag}`);
+    }
+    /**
+     * Apply action on a device
+     */
+    applyAction(id, action) {
+        return this.rest.post(`${this.baseUrl}/${id}/actions/${action}`, '');
+    }
+    /**
+     * Find top 10 devices by their score and filter criteria
+     */
+    findTop(streamId, search, from, to, type, tag, status, risk, scoreRange, sort, page, size, ids) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (risk != null) {
+            params.push(`risk=${risk}`);
+        }
+        if (scoreRange != null) {
+            params.push(`scoreRange=${scoreRange}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        if (ids != null) {
+            params.push(`ids=${ids}`);
+        }
+        return this.rest.get(`${this.baseUrl}/top`, ...params);
+    }
+    /**
+     * Get device distribution by type filtered by query
+     */
+    countByType(streamId, search, from, to, type, tag, status, risk, scoreRange) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (risk != null) {
+            params.push(`risk=${risk}`);
+        }
+        if (scoreRange != null) {
+            params.push(`scoreRange=${scoreRange}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-type`, ...params);
+    }
+    /**
+     * Get device distribution by status filtered by query
+     */
+    countByStatus(streamId, search, from, to, type, tag, status, risk, scoreRange) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (risk != null) {
+            params.push(`risk=${risk}`);
+        }
+        if (scoreRange != null) {
+            params.push(`scoreRange=${scoreRange}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-status`, ...params);
+    }
+    /**
+     * Get device distribution by action filtered by query
+     */
+    countByAction(streamId, search, from, to, type, tag, status, risk, scoreRange) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (risk != null) {
+            params.push(`risk=${risk}`);
+        }
+        if (scoreRange != null) {
+            params.push(`scoreRange=${scoreRange}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-action`, ...params);
+    }
+    /**
+     * Get network map of devices
+     */
+    getNetworkMap(streamId, from, to, type, tag, id, mapType, ips, limit) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (id != null) {
+            params.push(`id=${id}`);
+        }
+        if (mapType != null) {
+            params.push(`mapType=${mapType}`);
+        }
+        if (ips != null) {
+            params.push(`ips=${ips}`);
+        }
+        if (limit != null) {
+            params.push(`limit=${limit}`);
+        }
+        return this.rest.get(`${this.baseUrl}/network-map`, ...params);
+    }
+    /**
+     * Get latest device report, the Key contains latest devices at risk number (works in account level)
+     */
+    getLatestDeviceReport() {
+        return this.rest.get(`${this.baseUrl}/report/latest`);
+    }
+    /**
+     * Get devicesAtRisk histogram over the provided time period
+     */
+    getDeviceReportTimeline(streamId, from, to) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        return this.rest.get(`${this.baseUrl}/report/timeline`, ...params);
+    }
+    /**
+     * Get device / group of devices consumption over time
+     */
+    getConsumptionTimeline(streamId, from, to, type, tag, id) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (id != null) {
+            params.push(`id=${id}`);
+        }
+        return this.rest.get(`${this.baseUrl}/consumption/timeline`, ...params);
+    }
+    /**
+     * Get device / group of devices consumption trend: 7 days consumption compared to the average of the previous weeks
+     */
+    getConsumptionTrend(streamId, from, to, type, tag, id) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (id != null) {
+            params.push(`id=${id}`);
+        }
+        return this.rest.get(`${this.baseUrl}/consumption/trend`, ...params);
+    }
+    /**
+     * Find devices by insight id query
+     */
+    findByInsightContext(streamId, tag, from, to, sort, page, size) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        return this.rest.get(`${this.baseUrl}/find-by-insight-context`, ...params);
+    }
+    /**
+     * Find devices by query
+     */
+    findDevicesMap(streamId, search, type, tag, status, risk, scoreRange, sort, page, size, mapBounds) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (risk != null) {
+            params.push(`risk=${risk}`);
+        }
+        if (scoreRange != null) {
+            params.push(`scoreRange=${scoreRange}`);
+        }
+        if (sort != null) {
+            params.push(`sort=${sort}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        return this.rest.put(`${this.baseUrl}/find-devices-map`, typeof mapBounds === 'object' ? JSON.stringify(mapBounds) : mapBounds, ...params);
+    }
+    /**
+     * Get device distribution by risk filtered by query
+     */
+    countByRisk(streamId, search, from, to, type, tag, status, risk) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (tag != null) {
+            params.push(`tag=${tag}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        if (risk != null) {
+            params.push(`risk=${risk}`);
+        }
+        return this.rest.get(`${this.baseUrl}/count/by-risk`, ...params);
+    }
+}
+//# sourceMappingURL=UsrDevicesService.js.map