@shieldiot/pulse-lib 1.0.10 → 1.0.12

package/dist/cjs/lib/services/sysKeysService.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SysKeysService = void 0;
+// List of API keys 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 
+class SysKeysService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/keys';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new API key
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing API key in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete API key from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single API key by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of API keys by free test search
+     */
+    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 services for the ACL
+     */
+    listServices() {
+        return this.rest.get(`${this.baseUrl}/services`);
+    }
+}
+exports.SysKeysService = SysKeysService;

package/dist/cjs/lib/services/sysMembersService.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SysMembersService = void 0;
+// List of members 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 
+class SysMembersService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/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(accountId, userId, role, sort, page, size) {
+        const params = [];
+        if (accountId != null) {
+            params.push(`accountId=${accountId}`);
+        }
+        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);
+    }
+}
+exports.SysMembersService = SysMembersService;

package/dist/cjs/lib/services/sysRuleTemplatesService.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SysRuleTemplatesService = void 0;
+// List of rule templates 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 
+class SysRuleTemplatesService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/rule-templates';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new rule template
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing rule template
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete a rule template from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single rule template by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of rule templates 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);
+    }
+}
+exports.SysRuleTemplatesService = SysRuleTemplatesService;

package/dist/cjs/lib/services/sysRulesService.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SysRulesService = void 0;
+// List of rules 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 
+class SysRulesService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/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(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);
+    }
+    /**
+     * 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);
+    }
+}
+exports.SysRulesService = SysRulesService;

package/dist/cjs/lib/services/sysStatisticsService.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SysStatisticsService = void 0;
+// List of system statistics information 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 
+class SysStatisticsService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/statistics';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Get accounts distribution by field
+     */
+    getAccountsCount(field) {
+        return this.rest.get(`${this.baseUrl}/accounts/${field}`);
+    }
+    /**
+     * Get streams distribution by field
+     */
+    getStreamsCount(field) {
+        return this.rest.get(`${this.baseUrl}/streams/${field}`);
+    }
+    /**
+     * Get devices distribution by field
+     */
+    getDevicesCount(field) {
+        return this.rest.get(`${this.baseUrl}/devices/${field}`);
+    }
+    /**
+     * Get users distribution by field
+     */
+    getUsersCount(field) {
+        return this.rest.get(`${this.baseUrl}/users/${field}`);
+    }
+}
+exports.SysStatisticsService = SysStatisticsService;

package/dist/cjs/lib/services/sysStreamsService.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SysStreamsService = void 0;
+// List of stream 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 
+class SysStreamsService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/streams';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new stream
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing stream in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete a stream from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single stream by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of streams 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);
+    }
+}
+exports.SysStreamsService = SysStreamsService;

package/dist/cjs/lib/services/sysUsersService.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SysUsersService = void 0;
+// List of users 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 
+class SysUsersService {
+    // Class constructor
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
+        this.rest = rest;
+        // URL to web api
+        this.baseUrl = '/sys/users';
+        this.baseUrl = apiUrl + this.baseUrl;
+    }
+    /**
+     * Create new user
+     */
+    create(body) {
+        return this.rest.put(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update existing user in the system
+     */
+    update(body) {
+        return this.rest.patch(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Delete a user from the system
+     */
+    delete(id) {
+        return this.rest.delete(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Get single user by id
+     */
+    get(id) {
+        return this.rest.get(`${this.baseUrl}/${id}`);
+    }
+    /**
+     * Find list of users 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);
+    }
+    /**
+     * Create new user with all its accounts memberships
+     */
+    createMembership(body) {
+        return this.rest.post(`${this.baseUrl}/memberships`, typeof body === 'object' ? JSON.stringify(body) : body);
+    }
+    /**
+     * Update user's default account
+     */
+    setDefaultAccount(id, accountId) {
+        return this.rest.patch(`${this.baseUrl}/${id}/${accountId}`, '');
+    }
+    /**
+     * Update access token
+     */
+    getAccessToken(id) {
+        return this.rest.get(`${this.baseUrl}/${id}/access-token`);
+    }
+}
+exports.SysUsersService = SysUsersService;