@shieldiot/pulse-lib 1.0.9 → 1.0.11

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

@@ -0,0 +1,56 @@
+// List of AI support related actions for system support 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 SupportStreamAnalyticsConfig {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/support/stream-analytics-config';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Create new stream analytics configuration
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing stream analytics configuration
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete stream analytics configuration from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single stream analytics configuration by stream id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of stream analytics configurations by query
+     */
+    find(search, sort, page, size) {
+        const params = [];
+        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);
+    }
+}

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

@@ -0,0 +1,80 @@
+// List of account related actions for system 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 SysAccountsService {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/accounts';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Create new account
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing account in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing account settings in the system
+     */
+    updateSettings(body) {
+        return this.rest.patch(`${this.baseUrl}/{id}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete account from the system and all its related content
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single account by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of accounts by query
+     */
+    find(search, type, status, sort, page, size) {
+        const params = [];
+        if (search != null) {
+            params.push(`search=${search}`);
+        }
+        if (type != null) {
+            params.push(`type=${type}`);
+        }
+        if (status != null) {
+            params.push(`status=${status}`);
+        }
+        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);
+    }
+    /**
+     * Save account's logo image
+     */
+    saveLogo() {
+        return this.rest.patch(`${this.baseUrl}/logo`, '');
+    }
+    /**
+     * Get account's logo image
+     */
+    getLogo(id) {
+        return this.rest.get(`${this.baseUrl}/logo`);
+    }
+}

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

@@ -0,0 +1,105 @@
+// List of audit log queries for system 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 SysAuditLogService {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/audit-log';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Get single log entry by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of log entries by query
+     */
+    find(from, to, accountId, userId, action, itemType, itemId, itemName, search, sort, page, size) {
+        const params = [];
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (accountId != null) {
+            params.push(`accountId=${accountId}`);
+        }
+        if (userId != null) {
+            params.push(`userId=${userId}`);
+        }
+        if (action != null) {
+            params.push(`action=${action}`);
+        }
+        if (itemType != null) {
+            params.push(`itemType=${itemType}`);
+        }
+        if (itemId != null) {
+            params.push(`itemId=${itemId}`);
+        }
+        if (itemName != null) {
+            params.push(`itemName=${itemName}`);
+        }
+        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 histogram of audit log entries over time
+     */
+    getTimeline(from, to, accountId, userId, action, itemType, itemId, itemName, search, sort, page, size) {
+        const params = [];
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (accountId != null) {
+            params.push(`accountId=${accountId}`);
+        }
+        if (userId != null) {
+            params.push(`userId=${userId}`);
+        }
+        if (action != null) {
+            params.push(`action=${action}`);
+        }
+        if (itemType != null) {
+            params.push(`itemType=${itemType}`);
+        }
+        if (itemId != null) {
+            params.push(`itemId=${itemId}`);
+        }
+        if (itemName != null) {
+            params.push(`itemName=${itemName}`);
+        }
+        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}/timeline`, ...params);
+    }
+}

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

@@ -0,0 +1,75 @@
+// List of checkpoints queries for system 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 SysCheckpointsService {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/checkpoints';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Get a single checkpoint entry by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find a list of checkpoint entries by query
+     */
+    find(from, to, accountId, streamId, search, sort, page, size) {
+        const params = [];
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        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);
+    }
+    /**
+     * Get histogram of checkpoints over time
+     */
+    checkpointsTimeline(from, to, accountId, streamId, field, timeField) {
+        const params = [];
+        if (from != null) {
+            params.push(`from=${from}`);
+        }
+        if (to != null) {
+            params.push(`to=${to}`);
+        }
+        if (accountId != null) {
+            params.push(`accountId=${accountId}`);
+        }
+        if (streamId != null) {
+            params.push(`streamId=${streamId}`);
+        }
+        if (field != null) {
+            params.push(`field=${field}`);
+        }
+        if (timeField != null) {
+            params.push(`timeField=${timeField}`);
+        }
+        return this.rest.get(`${this.baseUrl}/timeline`, ...params);
+    }
+}

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

@@ -0,0 +1,81 @@
+// List of system configuration parameters related actions for system 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 SysConfigService {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/config';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Create new configuration parameter
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing configuration parameter in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update group of configuration parameters in the system in a bulk
+     */
+    updateGroup(body) {
+        return this.rest.patch(`${this.baseUrl}/update-group`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete a configuration parameter from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single configuration parameter by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get list of configuration parameters keys and their description
+     */
+    keys(search, sort, page, size) {
+        const params = [];
+        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}/keys`, ...params);
+    }
+    /**
+     * Find list of configuration parameters by query
+     */
+    find(search, sort, page, size) {
+        const params = [];
+        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);
+    }
+}

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

@@ -0,0 +1,75 @@
+// List of features actions for system 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 SysFeaturesService {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/features';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Find list of feature
+     */
+    findFeatures(search, sort, page, size) {
+        const params = [];
+        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);
+    }
+    /**
+     * Create new features group
+     */
+    createFeaturesGroup(body) {
+        return this.rest.put(`${this.baseUrl}/groups`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing features group
+     */
+    updateFeaturesGroup(body) {
+        return this.rest.patch(`${this.baseUrl}/groups`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete features group from the system
+     */
+    deleteFeaturesGroup(id) {
+        return this.rest.delete(`${this.baseUrl}/groups/${id}`);
+    }
+    /**
+     * Get single features group by id
+     */
+    getFeaturesGroup(id) {
+        return this.rest.get(`${this.baseUrl}/groups/${id}`);
+    }
+    /**
+     * Find list of features groups
+     */
+    findFeaturesGroups(search, sort, page, size) {
+        const params = [];
+        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}/groups`, ...params);
+    }
+}

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

@@ -0,0 +1,74 @@
+// List of groups related actions for system 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 SysGroupsService {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/groups';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Create new groups
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing group in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete a group from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single group by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of groups by query
+     */
+    find(search, sort, page, size) {
+        const params = [];
+        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 list of all users in the group
+     */
+    getUsers(id) {
+        return this.rest.get(`${this.baseUrl}/${id}/users`);
+    }
+    /**
+     * Add user to the group
+     */
+    setDefaultAccount(id, userId) {
+        return this.rest.put(`${this.baseUrl}/${id}/users/${userId}`, '');
+    }
+    /**
+     * Remove user from the group
+     */
+    getAccessToken(id, userId) {
+        return this.rest.delete(`${this.baseUrl}/${id}/users/${userId}`);
+    }
+}

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

@@ -0,0 +1,130 @@
+// List of insight queries related actions for system 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 SysInsightsService {
+    // Class constructor
+    constructor(config, rest) {
+        this.config = config;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/insights';
+        this.baseUrl = this.config.api + this.baseUrl;
+    }
+    /**
+     * Create new insight query
+     */
+    createQuery(body) {
+        return this.rest.put(`${this.baseUrl}/query`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing insight query
+     */
+    updateQuery(body) {
+        return this.rest.patch(`${this.baseUrl}/query`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete insight query from the system
+     */
+    deleteQuery(id) {
+        return this.rest.delete(`${this.baseUrl}/query/${id}`);
+    }
+    /**
+     * Get single insight query by id
+     */
+    getQuery(id) {
+        return this.rest.get(`${this.baseUrl}/query/${id}`);
+    }
+    /**
+     * Find list of insight queries
+     */
+    findQueries(search, sort, page, size) {
+        const params = [];
+        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}/query`, ...params);
+    }
+    /**
+     * Create new insight spec
+     */
+    createSpec(body) {
+        return this.rest.put(`${this.baseUrl}/spec`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing insight spec
+     */
+    updateSpec(body) {
+        return this.rest.patch(`${this.baseUrl}/spec`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete insight spec from the system
+     */
+    deleteSpec(id) {
+        return this.rest.delete(`${this.baseUrl}/spec/${id}`);
+    }
+    /**
+     * Get single insight spec by id
+     */
+    getSpec(id) {
+        return this.rest.get(`${this.baseUrl}/spec/${id}`);
+    }
+    /**
+     * Find list of insight specs
+     */
+    findSpecs(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}/spec`, ...params);
+    }
+    /**
+     * Find list of insight specs
+     */
+    findSpecsQueries(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}/spec-queries`, ...params);
+    }
+}