@shieldiot/pulse-lib 1.0.10 → 1.0.11

package/dist/types/lib/services/services.export.d.ts

@@ -0,0 +1,26 @@
+import { SupportStreamAnalyticsConfig } from './supportStreamAnalyticsConfig';
+import { SysAccountsService } from './sysAccountsService';
+import { SysAuditLogService } from './sysAuditLogService';
+import { SysCheckpointsService } from './sysCheckpointsService';
+import { SysConfigService } from './sysConfigService';
+import { SysFeaturesService } from './sysFeaturesService';
+import { SysGroupsService } from './sysGroupsService';
+import { SysInsightsService } from './sysInsightsService';
+import { SysKeysService } from './sysKeysService';
+import { SysMembersService } from './sysMembersService';
+import { SysRuleTemplatesService } from './sysRuleTemplatesService';
+import { SysRulesService } from './sysRulesService';
+import { SysStatisticsService } from './sysStatisticsService';
+import { SysStreamsService } from './sysStreamsService';
+import { SysUsersService } from './sysUsersService';
+import { UsrInsightsService } from './usrInsightsService';
+import { UsrIntegrationsService } from './usrIntegrationsService';
+import { UsrMembersService } from './usrMembersService';
+import { UsrUserService } from './usrUserService';
+import { UsrAlertsService } from './usrAlertsService';
+import { UsrDevicesService } from './usrDevicesService';
+import { UsrEventsService } from './usrEventsService';
+import { UsrNetworkService } from './usrNetworkService';
+import { UsrReportsService } from './usrReportsService';
+import { UsrRulesService } from './usrRulesService';
+export declare const Services: (typeof SupportStreamAnalyticsConfig | typeof SysAccountsService | typeof SysAuditLogService | typeof SysCheckpointsService | typeof SysConfigService | typeof SysFeaturesService | typeof SysGroupsService | typeof SysInsightsService | typeof SysKeysService | typeof SysMembersService | typeof SysRuleTemplatesService | typeof SysRulesService | typeof SysStatisticsService | typeof SysStreamsService | typeof SysUsersService | typeof UsrInsightsService | typeof UsrIntegrationsService | typeof UsrMembersService | typeof UsrUserService | typeof UsrAlertsService | typeof UsrDevicesService | typeof UsrEventsService | typeof UsrNetworkService | typeof UsrReportsService | typeof UsrRulesService)[];

package/dist/types/lib/services/supportStreamAnalyticsConfig.d.ts

@@ -0,0 +1,29 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { StreamAnalyticsConfig } from '../entities';
+export declare class SupportStreamAnalyticsConfig {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new stream analytics configuration
+     */
+    create(body?: StreamAnalyticsConfig): import("rxjs").Observable<EntityResponse<StreamAnalyticsConfig>>;
+    /**
+     * Update existing stream analytics configuration
+     */
+    update(body?: StreamAnalyticsConfig): import("rxjs").Observable<EntityResponse<StreamAnalyticsConfig>>;
+    /**
+     * Delete stream analytics configuration from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single stream analytics configuration by stream id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<StreamAnalyticsConfig>>;
+    /**
+     * Find list of stream analytics configurations by query
+     */
+    find(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<StreamAnalyticsConfig>>;
+}

package/dist/types/lib/services/sysAccountsService.d.ts

@@ -0,0 +1,45 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Account } from '../entities';
+import { AccountSettings } from '../entities';
+import { AccountTypeCode } from '../enums';
+import { AccountStatusCode } from '../enums';
+import { Image } from '../entities';
+export declare class SysAccountsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new account
+     */
+    create(body?: Account): import("rxjs").Observable<EntityResponse<Account>>;
+    /**
+     * Update existing account in the system
+     */
+    update(body?: Account): import("rxjs").Observable<EntityResponse<Account>>;
+    /**
+     * Update existing account settings in the system
+     */
+    updateSettings(body?: AccountSettings): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Delete account from the system and all its related content
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single account by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Account>>;
+    /**
+     * Find list of accounts by query
+     */
+    find(search?: string, type?: AccountTypeCode[], status?: AccountStatusCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Account>>;
+    /**
+     * Save account's logo image
+     */
+    saveLogo(): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get account's logo image
+     */
+    getLogo(id?: string): import("rxjs").Observable<EntityResponse<Image>>;
+}

package/dist/types/lib/services/sysAuditLogService.d.ts

@@ -0,0 +1,22 @@
+import { RestUtil, EntityResponse, EntitiesResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { AuditLog } from '../entities';
+import { TimeSeriesOfFloat } from '../common';
+export declare class SysAuditLogService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Get single log entry by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<AuditLog>>;
+    /**
+     * Find list of log entries by query
+     */
+    find(from?: number, to?: number, accountId?: string, userId?: string, action?: string, itemType?: string, itemId?: string, itemName?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<AuditLog>>;
+    /**
+     * Get histogram of audit log entries over time
+     */
+    getTimeline(from?: number, to?: number, accountId?: string, userId?: string, action?: string, itemType?: string, itemId?: string, itemName?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<TimeSeriesOfFloat>>;
+}

package/dist/types/lib/services/sysCheckpointsService.d.ts

@@ -0,0 +1,22 @@
+import { RestUtil, EntityResponse, EntitiesResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Checkpoint } from '../entities';
+import { TimeSeriesOfFloat } from '../common';
+export declare class SysCheckpointsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Get a single checkpoint entry by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Checkpoint>>;
+    /**
+     * Find a list of checkpoint entries by query
+     */
+    find(from?: number, to?: number, accountId?: string, streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Checkpoint>>;
+    /**
+     * Get histogram of checkpoints over time
+     */
+    checkpointsTimeline(from?: number, to?: number, accountId?: string, streamId?: string, field?: string, timeField?: string): import("rxjs").Observable<EntityResponse<TimeSeriesOfFloat>>;
+}

package/dist/types/lib/services/sysConfigService.d.ts

@@ -0,0 +1,38 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { ConfigParam } from '../entities';
+import { ConfigParams } from '../entities';
+export declare class SysConfigService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new configuration parameter
+     */
+    create(body?: ConfigParam): import("rxjs").Observable<EntityResponse<ConfigParam>>;
+    /**
+     * Update existing configuration parameter in the system
+     */
+    update(body?: ConfigParam): import("rxjs").Observable<EntityResponse<ConfigParam>>;
+    /**
+     * Update group of configuration parameters in the system in a bulk
+     */
+    updateGroup(body?: ConfigParams): import("rxjs").Observable<EntityResponse<ConfigParams>>;
+    /**
+     * Delete a configuration parameter from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single configuration parameter by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<ConfigParam>>;
+    /**
+     * Get list of configuration parameters keys and their description
+     */
+    keys(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<ConfigParam>>;
+    /**
+     * Find list of configuration parameters by query
+     */
+    find(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<ConfigParam>>;
+}

package/dist/types/lib/services/sysFeaturesService.d.ts

@@ -0,0 +1,34 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Feature } from '../entities';
+import { FeaturesGroup } from '../entities';
+export declare class SysFeaturesService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Find list of feature
+     */
+    findFeatures(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Feature>>;
+    /**
+     * Create new features group
+     */
+    createFeaturesGroup(body?: FeaturesGroup): import("rxjs").Observable<EntityResponse<FeaturesGroup>>;
+    /**
+     * Update existing features group
+     */
+    updateFeaturesGroup(body?: FeaturesGroup): import("rxjs").Observable<EntityResponse<FeaturesGroup>>;
+    /**
+     * Delete features group from the system
+     */
+    deleteFeaturesGroup(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single features group by id
+     */
+    getFeaturesGroup(id?: string): import("rxjs").Observable<EntityResponse<FeaturesGroup>>;
+    /**
+     * Find list of features groups
+     */
+    findFeaturesGroups(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<FeaturesGroup>>;
+}

package/dist/types/lib/services/sysGroupsService.d.ts

@@ -0,0 +1,42 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { User } from '../entities';
+import { Group } from '../entities';
+export declare class SysGroupsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new groups
+     */
+    create(body?: Group): import("rxjs").Observable<EntityResponse<Group>>;
+    /**
+     * Update existing group in the system
+     */
+    update(body?: Group): import("rxjs").Observable<EntityResponse<Group>>;
+    /**
+     * Delete a group from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single group by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Group>>;
+    /**
+     * Find list of groups by query
+     */
+    find(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Group>>;
+    /**
+     * Get list of all users in the group
+     */
+    getUsers(id?: string): import("rxjs").Observable<EntityResponse<User>>;
+    /**
+     * Add user to the group
+     */
+    setDefaultAccount(id?: string, userId?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Remove user from the group
+     */
+    getAccessToken(id?: string, userId?: string): import("rxjs").Observable<ActionResponse>;
+}

package/dist/types/lib/services/sysInsightsService.d.ts

@@ -0,0 +1,54 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { InsightQuery } from '../entities';
+import { InsightSpec } from '../entities';
+export declare class SysInsightsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new insight query
+     */
+    createQuery(body?: InsightQuery): import("rxjs").Observable<EntityResponse<InsightQuery>>;
+    /**
+     * Update existing insight query
+     */
+    updateQuery(body?: InsightQuery): import("rxjs").Observable<EntityResponse<InsightQuery>>;
+    /**
+     * Delete insight query from the system
+     */
+    deleteQuery(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single insight query by id
+     */
+    getQuery(id?: string): import("rxjs").Observable<EntityResponse<InsightQuery>>;
+    /**
+     * Find list of insight queries
+     */
+    findQueries(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<InsightQuery>>;
+    /**
+     * Create new insight spec
+     */
+    createSpec(body?: InsightSpec): import("rxjs").Observable<EntityResponse<InsightSpec>>;
+    /**
+     * Update existing insight spec
+     */
+    updateSpec(body?: InsightSpec): import("rxjs").Observable<EntityResponse<InsightSpec>>;
+    /**
+     * Delete insight spec from the system
+     */
+    deleteSpec(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single insight spec by id
+     */
+    getSpec(id?: string): import("rxjs").Observable<EntityResponse<InsightSpec>>;
+    /**
+     * Find list of insight specs
+     */
+    findSpecs(accountId?: string, streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<InsightSpec>>;
+    /**
+     * Find list of insight specs
+     */
+    findSpecsQueries(accountId?: string, streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<InsightQuery>>;
+}

package/dist/types/lib/services/sysKeysService.d.ts

@@ -0,0 +1,34 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { StringIntValue } from '../common';
+import { ApiKey } from '../entities';
+export declare class SysKeysService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new API key
+     */
+    create(body?: ApiKey): import("rxjs").Observable<EntityResponse<ApiKey>>;
+    /**
+     * Update existing API key in the system
+     */
+    update(body?: ApiKey): import("rxjs").Observable<EntityResponse<ApiKey>>;
+    /**
+     * Delete API key from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single API key by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<ApiKey>>;
+    /**
+     * Find list of API keys by free test search
+     */
+    find(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<ApiKey>>;
+    /**
+     * Get list of services for the ACL
+     */
+    listServices(): import("rxjs").Observable<EntitiesResponse<StringIntValue>>;
+}

package/dist/types/lib/services/sysMembersService.d.ts

@@ -0,0 +1,30 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Member } from '../entities';
+import { MemberRoleCode } from '../enums';
+export declare class SysMembersService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new member
+     */
+    create(body?: Member): import("rxjs").Observable<EntityResponse<Member>>;
+    /**
+     * Update existing member in the system
+     */
+    update(body?: Member): import("rxjs").Observable<EntityResponse<Member>>;
+    /**
+     * Delete member from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single member by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Member>>;
+    /**
+     * Find list of members by query
+     */
+    find(accountId?: string, userId?: string, role?: MemberRoleCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Member>>;
+}

package/dist/types/lib/services/sysRuleTemplatesService.d.ts

@@ -0,0 +1,29 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { RuleTemplate } from '../entities';
+export declare class SysRuleTemplatesService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new rule template
+     */
+    create(body?: RuleTemplate): import("rxjs").Observable<EntityResponse<RuleTemplate>>;
+    /**
+     * Update existing rule template
+     */
+    update(body?: RuleTemplate): import("rxjs").Observable<EntityResponse<RuleTemplate>>;
+    /**
+     * Delete a rule template from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single rule template by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<RuleTemplate>>;
+    /**
+     * Find list of rule templates by query
+     */
+    find(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<RuleTemplate>>;
+}

package/dist/types/lib/services/sysRulesService.d.ts

@@ -0,0 +1,34 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Rule } from '../entities';
+import { TimeSeriesOfFloat } from '../common';
+export declare class SysRulesService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new rule
+     */
+    create(body?: Rule): import("rxjs").Observable<EntityResponse<Rule>>;
+    /**
+     * Update existing rule in the system
+     */
+    update(body?: Rule): import("rxjs").Observable<EntityResponse<Rule>>;
+    /**
+     * Delete a rule from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single rule by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Rule>>;
+    /**
+     * Find list of rules by query
+     */
+    find(accountId?: string, streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Rule>>;
+    /**
+     * Analyze rule configuration against historic data
+     */
+    analyze(from?: number, to?: number, interval?: number, size?: number, body?: Rule): import("rxjs").Observable<EntityResponse<TimeSeriesOfFloat>>;
+}

package/dist/types/lib/services/sysStatisticsService.d.ts

@@ -0,0 +1,25 @@
+import { RestUtil, EntityResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Distribution } from '../entities';
+export declare class SysStatisticsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Get accounts distribution by field
+     */
+    getAccountsCount(field?: string): import("rxjs").Observable<EntityResponse<Distribution>>;
+    /**
+     * Get streams distribution by field
+     */
+    getStreamsCount(field?: string): import("rxjs").Observable<EntityResponse<Distribution>>;
+    /**
+     * Get devices distribution by field
+     */
+    getDevicesCount(field?: string): import("rxjs").Observable<EntityResponse<Distribution>>;
+    /**
+     * Get users distribution by field
+     */
+    getUsersCount(field?: string): import("rxjs").Observable<EntityResponse<Distribution>>;
+}

package/dist/types/lib/services/sysStreamsService.d.ts

@@ -0,0 +1,29 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Stream } from '../entities';
+export declare class SysStreamsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new stream
+     */
+    create(body?: Stream): import("rxjs").Observable<EntityResponse<Stream>>;
+    /**
+     * Update existing stream in the system
+     */
+    update(body?: Stream): import("rxjs").Observable<EntityResponse<Stream>>;
+    /**
+     * Delete a stream from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single stream by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Stream>>;
+    /**
+     * Find list of streams by query
+     */
+    find(accountId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Stream>>;
+}

package/dist/types/lib/services/sysUsersService.d.ts

@@ -0,0 +1,44 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { User } from '../entities';
+import { UserTypeCode } from '../enums';
+import { UserStatusCode } from '../enums';
+import { UserMemberships } from '../entities';
+export declare class SysUsersService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new user
+     */
+    create(body?: User): import("rxjs").Observable<EntityResponse<User>>;
+    /**
+     * Update existing user in the system
+     */
+    update(body?: User): import("rxjs").Observable<EntityResponse<User>>;
+    /**
+     * Delete a user from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single user by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<User>>;
+    /**
+     * Find list of users by query
+     */
+    find(search?: string, type?: UserTypeCode[], status?: UserStatusCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<User>>;
+    /**
+     * Create new user with all its accounts memberships
+     */
+    createMembership(body?: UserMemberships): import("rxjs").Observable<EntityResponse<UserMemberships>>;
+    /**
+     * Update user's default account
+     */
+    setDefaultAccount(id?: string, accountId?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Update access token
+     */
+    getAccessToken(id?: string): import("rxjs").Observable<ActionResponse>;
+}