@shieldiot/pulse-lib 1.0.10 → 1.0.12

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

@@ -0,0 +1,74 @@
+// List of integrations related actions for the operator 
+// @RequestHeader X-API-KEY The key to identify the application (console) 
+// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
+export class UsrIntegrationsService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/integrations';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new integration
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing integration
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete integration from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single integration by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of integrations by query
+     */
+    find(accountId, streamId, search, sort, page, size) {
+        const params = [];
+        if (accountId != null) {
+            params.push(`accountId=${accountId}`);
+        }
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        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}`, ...params);
+    }
+    /**
+     * Validate format of the templates in the fields
+     */
+    validate(body) {
+        return this.rest.post(`${this.baseUrl}/validate`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Test the integration with pseudo data
+     */
+    test(body) {
+        return this.rest.post(`${this.baseUrl}/test`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+}

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

@@ -0,0 +1,75 @@
+// List of members related actions for account administrator only 
+// @RequestHeader X-API-KEY The key to identify the application (console) 
+// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
+export class UsrMembersService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/members';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new member
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing member in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete member from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single member by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of members by query
+     */
+    find(userId, role, sort, page, size) {
+        const params = [];
+        if (userId != null) {
+            params.push(`userId=${userId}`);
+        }
+        if (role != null) {
+            params.push(`role=${role}`);
+        }
+        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}`, ...params);
+    }
+    /**
+     * Find list of registered emails by query
+     */
+    findEmails(search, page, size) {
+        const params = [];
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (page != null) {
+            params.push(`page=${page}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        return this.rest.get(`${this.baseUrl}/emails`, ...params);
+    }
+}

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

@@ -0,0 +1,81 @@
+// List of network statistics related queries for the operator 
+// @RequestHeader X-API-KEY The key to identify the application (console) 
+// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
+export class UsrNetworkService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/network';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Find list of usage records by query
+     */
+    findUsage(streamId, deviceId, simId, from, to, include, sort, page, size) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (simId != null) {
+            params.push(`simId=${simId}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (include != null) {
+            params.push(`include=${include}`);
+        }
+        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}/usage`, ...params);
+    }
+    /**
+     * Find list of session records by query
+     */
+    findSession(streamId, deviceId, simId, from, to, include, sort, page, size) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (deviceId != null) {
+            params.push(`deviceId=${deviceId}`);
+        }
+        if (simId != null) {
+            params.push(`simId=${simId}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (include != null) {
+            params.push(`include=${include}`);
+        }
+        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}/session`, ...params);
+    }
+}

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

@@ -0,0 +1,142 @@
+// List of events related actions for the operator 
+// @RequestHeader X-API-KEY The key to identify the application (console) 
+// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
+export class UsrReportsService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/reports';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new report
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing report in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete a report from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single report by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of reports by query
+     */
+    find(accountId, search, sort, page, size) {
+        const params = [];
+        if (accountId != null) {
+            params.push(`accountId=${accountId}`);
+        }
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        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}`, ...params);
+    }
+    /**
+     * Get compliance report
+     */
+    getComplianceReport(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.download(`reports`, `${this.baseUrl}/compliance`, ...params);
+    }
+    /**
+     * Create compliance report and send it by email
+     */
+    getComplianceReportByMail(streamId, from, to, addresses) {
+        const params = [];
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (addresses != null) {
+            params.push(`addresses=${addresses}`);
+        }
+        return this.rest.get(`${this.baseUrl}/compliance-by-mail`, ...params);
+    }
+    /**
+     * Get histogram of network activity over time
+     */
+    getNetworkActivityOverTime(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}/network-activity-over-time`, ...params);
+    }
+    /**
+     * Get histogram of device distribution by number of destinations
+     */
+    getDeviceDistributionByNumberOfDestinations(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}/device-distribution-by-number-of-destinations`, ...params);
+    }
+    /**
+     * Get histogram of device distribution by communication frequency
+     */
+    getDeviceGroupsByCommunicationFrequency(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}/device-groups-by-communication-frequency`, ...params);
+    }
+}

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

@@ -0,0 +1,176 @@
+// List of rules related actions 
+// @RequestHeader X-API-KEY The key to identify the application (console) 
+// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
+export class UsrRulesService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/rules';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new rule
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing rule in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete a rule from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single rule by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of rules by query
+     */
+    find(streamId, search, from, to, eventSeverity, activityStatus, eventType, includeSysRules, 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 (eventSeverity != null) {
+            params.push(`eventSeverity=${eventSeverity}`);
+        }
+        if (activityStatus != null) {
+            params.push(`activityStatus=${activityStatus}`);
+        }
+        if (eventType != null) {
+            params.push(`eventType=${eventType}`);
+        }
+        if (includeSysRules != null) {
+            params.push(`includeSysRules=${includeSysRules}`);
+        }
+        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}`, ...params);
+    }
+    /**
+     * Analyze rule configuration against historic data
+     */
+    analyze(from, to, interval, size, body) {
+        const params = [];
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (interval != null) {
+            params.push(`interval=${interval}`);
+        }
+        if (size != null) {
+            params.push(`size=${size}`);
+        }
+        return this.rest.post(`${this.baseUrl}/analyze`, typeof body === 'object' ? JSON.stringify(body) : body, ...params);
+    }
+    /**
+     * Find rule distribution by severity filtered by query
+     */
+    countBySeverity(streamId, search, from, to, eventSeverity, activityStatus, eventType, includeSysRules, 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 (eventSeverity != null) {
+            params.push(`eventSeverity=${eventSeverity}`);
+        }
+        if (activityStatus != null) {
+            params.push(`activityStatus=${activityStatus}`);
+        }
+        if (eventType != null) {
+            params.push(`eventType=${eventType}`);
+        }
+        if (includeSysRules != null) {
+            params.push(`includeSysRules=${includeSysRules}`);
+        }
+        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}/count/by-severity`, ...params);
+    }
+    /**
+     * Find alerts count distribution by rule filtered by query
+     */
+    countAlertsByRule(streamId, search, from, to, eventSeverity, activityStatus, eventType, includeSysRules, 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 (eventSeverity != null) {
+            params.push(`eventSeverity=${eventSeverity}`);
+        }
+        if (activityStatus != null) {
+            params.push(`activityStatus=${activityStatus}`);
+        }
+        if (eventType != null) {
+            params.push(`eventType=${eventType}`);
+        }
+        if (includeSysRules != null) {
+            params.push(`includeSysRules=${includeSysRules}`);
+        }
+        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}/count-alerts/by-rule-id`, ...params);
+    }
+}

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

@@ -0,0 +1,87 @@
+// List of user related actions 
+// @RequestHeader X-API-KEY The key to identify the application (console) 
+// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
+export class UsrUserService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/user';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Authorize user, verify user exists in the system (user was already authenticated by OAuth provider)
+     * The response includes access token valid for 20 minutes. The client side should renew the token before expiration using refresh-token method
+     */
+    authorize(body) {
+        return this.rest.post(`${this.baseUrl}/authorize`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Refresh token (set new expiration time) and associate with new account if required
+     * The response includes the account details and the newly refreshed token in the HTTP header X-ACCESS-TOKEN
+     */
+    setAccount(id) {
+        return this.rest.post(`${this.baseUrl}/set-account/${id}`, '');
+    }
+    /**
+     * Get the user's current account details
+     */
+    getAccount() {
+        return this.rest.get(`${this.baseUrl}/get-account`);
+    }
+    /**
+     * Get user's current account logo
+     */
+    getAccountLogo() {
+        return this.rest.get(`${this.baseUrl}/get-account-logo`);
+    }
+    /**
+     * Get the user's current account features (aggregated list of all features in all the account's features groups)
+     */
+    getAccountFeatures() {
+        return this.rest.get(`${this.baseUrl}/get-account-features`);
+    }
+    /**
+     * Get the user's current account streams (accessible by the user)
+     */
+    getAccountStreams() {
+        return this.rest.get(`${this.baseUrl}/get-account-streams`);
+    }
+    /**
+     * Get all the user memberships (all accounts that the current user has access to)
+     */
+    getMemberships() {
+        return this.rest.get(`${this.baseUrl}/memberships`);
+    }
+    /**
+     * Save user's avatar image
+     */
+    saveAvatar(body) {
+        return this.rest.patch(`${this.baseUrl}/avatar`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Get user's avatar image
+     */
+    getAvatar() {
+        return this.rest.get(`${this.baseUrl}/avatar`);
+    }
+    /**
+     * Get arbitrary image by Id
+     */
+    getImage(id) {
+        return this.rest.get(`${this.baseUrl}/images`);
+    }
+    /**
+     * Get arbitrary image by Id as stream of bytes
+     */
+    getImageBytes(id) {
+        return this.rest.download(`usr-user`, `${this.baseUrl}/image-bytes`);
+    }
+    /**
+     * Get personal access token
+     */
+    getAccessToken() {
+        return this.rest.get(`${this.baseUrl}/access-token`);
+    }
+}

package/dist/esm/utils/ActionResponse.js

@@ -0,0 +1,11 @@
+import { BaseRestResponse } from './BaseRestResponse';
+// ActionResponse message is returned for any action on entity with no return data (e.d. delete)
+export class ActionResponse extends BaseRestResponse {
+    constructor() {
+        super(...arguments);
+        // Entity key
+        this.key = '';
+        // Additional data
+        this.data = '';
+    }
+}

package/dist/esm/utils/BaseRestResponse.js

@@ -0,0 +1,9 @@
+// BaseRestResponse is a common structure for all response types
+export class BaseRestResponse {
+    constructor() {
+        // Error code (0 for success)
+        this.code = 0;
+        // Error message
+        this.error = '';
+    }
+}

package/dist/esm/utils/EntitiesResponse.js

@@ -0,0 +1,17 @@
+import { BaseRestResponse } from './BaseRestResponse';
+// EntitiesResponse message is returned for any action returning multiple entities
+export class EntitiesResponse extends BaseRestResponse {
+    constructor() {
+        super(...arguments);
+        // Current page (Bulk) number
+        this.page = 0;
+        // Size of page (items in bulk)
+        this.size = 0;
+        // Total number of pages
+        this.pages = 0;
+        // Total number of items in the query
+        this.total = 0;
+        // List of entities
+        this.list = [];
+    }
+}

package/dist/esm/utils/EntityResponse.js

@@ -0,0 +1,15 @@
+import { BaseRestResponse } from './BaseRestResponse';
+// EntitiesResponse message is returned for any action returning multiple entities
+export class EntityResponse extends BaseRestResponse {
+    constructor() {
+        super(...arguments);
+        // Current page (Bulk) number
+        this.page = 0;
+        // Size of page (items in bulk)
+        this.size = 0;
+        // Total number of pages
+        this.pages = 0;
+        // Total number of items in the query
+        this.total = 0;
+    }
+}

package/dist/esm/utils/index.js

@@ -0,0 +1,5 @@
+export * from './ActionResponse';
+export * from './BaseRestResponse';
+export * from './EntityResponse';
+export * from './EntitiesResponse';
+export * from './rest-util';