@shieldiot/pulse-lib 1.0.412 → 2.0.1409

package/dist/types/lib/entities/Device.d.ts

@@ -1,32 +0,0 @@
-import { SIM } from '../entities';
-import { GeoData } from '../common';
-import { BaseEntity } from '../base';
-import { DeviceTypeCode } from '../enums';
-import { DeviceStatusCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { DeviceActionCode } from '../enums';
-export declare class Device extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    externalId: string;
-    name: string;
-    description: string;
-    country: string;
-    operator: string;
-    type: DeviceTypeCode;
-    status: DeviceStatusCode;
-    lastActivity: number;
-    mac: string;
-    ip: string;
-    sid: string;
-    eid: string;
-    score: number;
-    tags: string[];
-    labels: StringKeyValue[];
-    eventCount: number;
-    actionApplied: DeviceActionCode;
-    actionAppliedBy: string;
-    actionAppliedOn: number;
-    simCards: SIM[];
-    address: GeoData;
-}

package/dist/types/lib/entities/DeviceReport.d.ts

@@ -1,9 +0,0 @@
-import { BaseEntity } from '../base';
-export declare class DeviceReport extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    totalDevices: number;
-    activeDevices: number;
-    devicesAtRisk: number;
-    affectedDevices: number;
-}

package/dist/types/lib/entities/DeviceWithEvents.d.ts

@@ -1,34 +0,0 @@
-import { Event } from '../entities';
-import { GeoData } from '../common';
-import { BaseEntity } from '../base';
-import { DeviceTypeCode } from '../enums';
-import { DeviceStatusCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { DeviceActionCode } from '../enums';
-import { SIM } from '../entities';
-export declare class DeviceWithEvents extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    externalId: string;
-    name: string;
-    description: string;
-    country: string;
-    operator: string;
-    type: DeviceTypeCode;
-    status: DeviceStatusCode;
-    lastActivity: number;
-    mac: string;
-    ip: string;
-    sid: string;
-    eid: string;
-    score: number;
-    tags: string[];
-    labels: StringKeyValue[];
-    eventCount: number;
-    actionApplied: DeviceActionCode;
-    actionAppliedBy: string;
-    actionAppliedOn: number;
-    simCards: SIM[];
-    events: Event[];
-    address: GeoData;
-}

package/dist/types/lib/entities/Distribution.d.ts

@@ -1,7 +0,0 @@
-import { Tuple } from '../common';
-export declare class Distribution {
-    name: string;
-    total: number;
-    values: Tuple[];
-    constructor(name?: string, total?: number, values?: Tuple[]);
-}

package/dist/types/lib/entities/Event.d.ts

@@ -1,38 +0,0 @@
-import { Indicator } from '../common';
-import { RuleTypeCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { EventOccurrence } from '../entities';
-import { BaseEntity } from '../base';
-import { EventTypeCode } from '../enums';
-import { EventStatusCode } from '../enums';
-import { GeoData } from '../common';
-import { EventCategoryCode } from '../enums';
-import { TrafficDirectionCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-export declare class Event extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    deviceId: string;
-    startTime: number;
-    endTime: number;
-    type: EventTypeCode;
-    severity: SeverityTypeCode;
-    score: number;
-    probability: number;
-    status: EventStatusCode;
-    indicators: Indicator[];
-    ruleType: RuleTypeCode;
-    ruleId: string;
-    sourceIp: string;
-    targetIp: string;
-    targetLocation: GeoData;
-    description: string;
-    tags: string[];
-    labels: StringKeyValue[];
-    category: EventCategoryCode;
-    recommendedAction: string;
-    occurrences: EventOccurrence[];
-    trafficDirection: TrafficDirectionCode;
-    confidenceScore: number;
-    occurrencesCount: boolean;
-}

package/dist/types/lib/entities/EventOccurrence.d.ts

@@ -1,10 +0,0 @@
-import { Indicator } from '../common';
-import { TrafficDirectionCode } from '../enums';
-export declare class EventOccurrence {
-    timestamp: number;
-    source: string;
-    sourceIp: string;
-    indicators: Indicator[];
-    trafficDirection: TrafficDirectionCode;
-    constructor(timestamp?: number, source?: string, sourceIp?: string, indicators?: Indicator[], trafficDirection?: TrafficDirectionCode);
-}

package/dist/types/lib/entities/EventWithDevice.d.ts

@@ -1,39 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-import { RuleTypeCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { EventOccurrence } from '../entities';
-import { TrafficDirectionCode } from '../enums';
-import { Device } from '../entities';
-import { EventTypeCode } from '../enums';
-import { Indicator } from '../common';
-import { GeoData } from '../common';
-import { EventCategoryCode } from '../enums';
-import { BaseEntity } from '../base';
-import { EventStatusCode } from '../enums';
-export declare class EventWithDevice extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    deviceId: string;
-    startTime: number;
-    endTime: number;
-    type: EventTypeCode;
-    severity: SeverityTypeCode;
-    score: number;
-    probability: number;
-    status: EventStatusCode;
-    indicators: Indicator[];
-    ruleType: RuleTypeCode;
-    ruleId: string;
-    targetIp: string;
-    targetLocation: GeoData;
-    description: string;
-    tags: string[];
-    labels: StringKeyValue[];
-    category: EventCategoryCode;
-    recommendedAction: string;
-    occurrences: EventOccurrence[];
-    trafficDirection: TrafficDirectionCode;
-    confidenceScore: number;
-    occurrencesCount: boolean;
-    device: Device;
-}

package/dist/types/lib/entities/Feature.d.ts

@@ -1,6 +0,0 @@
-import { FeatureCode } from '../enums';
-import { BaseEntity } from '../base';
-export declare class Feature extends BaseEntity {
-    code: FeatureCode;
-    name: string;
-}

package/dist/types/lib/entities/FeaturesGroup.d.ts

@@ -1,6 +0,0 @@
-import { BaseEntity } from '../base';
-import { FeatureCode } from '../enums';
-export declare class FeaturesGroup extends BaseEntity {
-    name: string;
-    features: FeatureCode[];
-}

package/dist/types/lib/entities/FlowRecord.d.ts

@@ -1,20 +0,0 @@
-import { BaseEntity } from '../base';
-export declare class FlowRecord extends BaseEntity {
-    rec_id: string;
-    flow_id: number;
-    streamId: string;
-    device_id: string;
-    start_time: number;
-    end_time: number;
-    src_ip: string;
-    src_port: number;
-    dst_ip: string;
-    dst_port: number;
-    pckt_to_srv: number;
-    pckt_to_client: number;
-    bytes_to_srv: number;
-    bytes_to_client: number;
-    protocol: string;
-    pcap: string;
-    alerted: boolean;
-}

package/dist/types/lib/entities/Group.d.ts

@@ -1,8 +0,0 @@
-import { AccountRole } from '../common';
-import { BaseEntity } from '../base';
-export declare class Group extends BaseEntity {
-    name: string;
-    externalId: string;
-    email: string;
-    accountRoles: AccountRole[];
-}

package/dist/types/lib/entities/IdsConfig.d.ts

@@ -1,10 +0,0 @@
-import { IdsList } from '../entities';
-export declare class IdsConfig {
-    authorizedDnsServers: string[];
-    authorizedFtpServers: string[];
-    modbusMasters: string[];
-    modbusPorts: number[];
-    longSessionsPorts: number[];
-    idsLists: IdsList[];
-    constructor(authorizedDnsServers?: string[], authorizedFtpServers?: string[], modbusMasters?: string[], modbusPorts?: number[], longSessionsPorts?: number[], idsLists?: IdsList[]);
-}

package/dist/types/lib/entities/IdsList.d.ts

@@ -1,6 +0,0 @@
-export declare class IdsList {
-    codeName: string;
-    description: string;
-    values: string[];
-    constructor(codeName?: string, description?: string, values?: string[]);
-}

package/dist/types/lib/entities/IdsRule.d.ts

@@ -1,31 +0,0 @@
-import { DeviceTypeCode } from '../enums';
-import { EventTypeCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-import { BaseEntity } from '../base';
-import { RuleTypeCode } from '../enums';
-import { DataSourceCode } from '../enums';
-import { ConditionDescription } from '../common';
-export declare class IdsRule extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    name: string;
-    type: RuleTypeCode;
-    description: string;
-    isSystemRule: boolean;
-    isActiveRule: boolean;
-    context: DataSourceCode;
-    matchAll: ConditionDescription[];
-    matchAny: ConditionDescription[];
-    excludeIDs: string[];
-    excludeTags: string[];
-    excludeTypes: DeviceTypeCode[];
-    timeWindowSec: number;
-    setEventType: EventTypeCode;
-    setEventSeverity: SeverityTypeCode;
-    lastAlertTimestamp: number;
-    alertsCount: number;
-    sql: string;
-    includeIDs: string[];
-    includeTags: string[];
-    includeTypes: DeviceTypeCode[];
-}

package/dist/types/lib/entities/Image.d.ts

@@ -1,5 +0,0 @@
-import { BaseEntity } from '../base';
-export declare class Image extends BaseEntity {
-    content: string;
-    contentType: string;
-}

package/dist/types/lib/entities/Insight.d.ts

@@ -1,27 +0,0 @@
-import { BaseEntity } from '../base';
-import { InsightTypeCode } from '../enums';
-import { InsightStatusCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-import { DirectionContextCode } from '../enums';
-import { RegulatoryViolation } from '../entities';
-import { MitreAttackCategory } from '../entities';
-export declare class Insight extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    specId: string;
-    dayId: number;
-    type: InsightTypeCode;
-    status: InsightStatusCode;
-    description: string;
-    links: string[];
-    severity: SeverityTypeCode;
-    title: string;
-    insightDirectionContext: DirectionContextCode;
-    detailedDescription: string;
-    affectedDeviceIds: string[];
-    affectedAlertIds: string[];
-    recommendedActions: string[];
-    regulatoryViolations: RegulatoryViolation[];
-    mitreAttackCategories: MitreAttackCategory[];
-    affectedDeviceCount: number;
-}

package/dist/types/lib/entities/InsightQuery.d.ts

@@ -1,11 +0,0 @@
-import { InsightTypeCode } from '../enums';
-import { DirectionContextCode } from '../enums';
-import { BaseEntity } from '../base';
-export declare class InsightQuery extends BaseEntity {
-    type: InsightTypeCode;
-    description: string;
-    query: string;
-    insightDirectionContext: DirectionContextCode;
-    uIQuery: string;
-    isDefault: boolean;
-}

package/dist/types/lib/entities/InsightSpec.d.ts

@@ -1,9 +0,0 @@
-import { InsightStatusCode } from '../enums';
-import { BaseEntity } from '../base';
-export declare class InsightSpec extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    queryId: string;
-    enabled: boolean;
-    status: InsightStatusCode;
-}

package/dist/types/lib/entities/IntDistribution.d.ts

@@ -1,7 +0,0 @@
-import { IntKeyValue } from '../common';
-export declare class IntDistribution {
-    name: string;
-    total: number;
-    values: IntKeyValue[];
-    constructor(name?: string, total?: number, values?: IntKeyValue[]);
-}

package/dist/types/lib/entities/Integration.d.ts

@@ -1,31 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-import { DeviceActionCode } from '../enums';
-import { BaseEntity } from '../base';
-import { IntegrationTypeCode } from '../enums';
-import { IntegrationTriggerCode } from '../enums';
-import { HttpMethodCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { EventTypeCode } from '../enums';
-export declare class Integration extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    type: IntegrationTypeCode;
-    trigger: IntegrationTriggerCode;
-    name: string;
-    enabled: boolean;
-    host: string;
-    port: number;
-    user: string;
-    password: string;
-    url: string;
-    method: HttpMethodCode;
-    headers: StringKeyValue[];
-    mimeType: string;
-    recipients: string[];
-    subject: string;
-    body: string;
-    from: string;
-    eventTypes: EventTypeCode[];
-    eventSeverity: SeverityTypeCode;
-    preventiveAction: DeviceActionCode;
-}

package/dist/types/lib/entities/Member.d.ts

@@ -1,7 +0,0 @@
-import { MemberRoleCode } from '../enums';
-import { BaseEntity } from '../base';
-export declare class Member extends BaseEntity {
-    userId: string;
-    accountId: string;
-    role: MemberRoleCode;
-}

package/dist/types/lib/entities/MitreAttackCategory.d.ts

@@ -1,6 +0,0 @@
-export declare class MitreAttackCategory {
-    id: string;
-    name: string;
-    sourceLink: string;
-    constructor(id?: string, name?: string, sourceLink?: string);
-}

package/dist/types/lib/entities/NetworkTopologyRecord.d.ts

@@ -1,18 +0,0 @@
-import { BaseEntity } from '../base';
-export declare class NetworkTopologyRecord extends BaseEntity {
-    stream_id: string;
-    dst_ip: string;
-    dst_dns: string;
-    dst_port: number;
-    protocol: string;
-    app_protocol: string;
-    app_name: string;
-    devices: number;
-    geo: string;
-    name: string;
-    addr: string;
-    malicious: boolean;
-    tags: string[];
-    country: string;
-    blocked: boolean;
-}

package/dist/types/lib/entities/NetworkTopologyReport.d.ts

@@ -1,15 +0,0 @@
-import { BaseEntity } from '../base';
-import { NetworkTopologyReportKPIs } from '../entities';
-import { StringDistribution } from '../entities';
-import { IntDistribution } from '../entities';
-import { NetworkTopologyReportParams } from '../entities';
-export declare class NetworkTopologyReport extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    KPIs: NetworkTopologyReportKPIs;
-    byAppProtocol: StringDistribution;
-    byCountry: StringDistribution;
-    byName: StringDistribution;
-    byRisk: IntDistribution;
-    filter: NetworkTopologyReportParams;
-}

package/dist/types/lib/entities/NetworkTopologyReportKPIs.d.ts

@@ -1,11 +0,0 @@
-export declare class NetworkTopologyReportKPIs {
-    publicIPCount: number;
-    publicDNSCount: number;
-    countriesCount: number;
-    locationsCount: number;
-    portsCount: number;
-    applicationsCount: number;
-    suspiciousCount: number;
-    protocolsCount: number;
-    constructor(publicIPCount?: number, publicDNSCount?: number, countriesCount?: number, locationsCount?: number, portsCount?: number, applicationsCount?: number, suspiciousCount?: number, protocolsCount?: number);
-}

package/dist/types/lib/entities/NetworkTopologyReportParams.d.ts

@@ -1,17 +0,0 @@
-import { BoolTypeCode } from '../enums';
-export declare class NetworkTopologyReportParams {
-    streamId: string;
-    dst_ip: string[];
-    det_dns: string[];
-    dst_port: number[];
-    protocol: string[];
-    app_protocol: string[];
-    name: string[];
-    country: string[];
-    malicious: BoolTypeCode;
-    blocked: BoolTypeCode;
-    sort: string;
-    page: number;
-    size: number;
-    constructor(streamId?: string, dstIP?: string[], dstDNS?: string[], dstPort?: number[], protocol?: string[], appProtocol?: string[], name?: string[], country?: string[], malicious?: BoolTypeCode, blocked?: BoolTypeCode, sort?: string, page?: number, size?: number);
-}

package/dist/types/lib/entities/NotificationMessage.d.ts

@@ -1,8 +0,0 @@
-import { NotificationTypeCode } from '../enums';
-import { BaseEntity } from '../base';
-export declare class NotificationMessage extends BaseEntity {
-    accountId: string;
-    description: string;
-    actionParts: string[];
-    type: NotificationTypeCode;
-}

package/dist/types/lib/entities/NotificationMessageDTO.d.ts

@@ -1,11 +0,0 @@
-import { NotificationTypeCode } from '../enums';
-import { BaseEntity } from '../base';
-export declare class NotificationMessageDTO extends BaseEntity {
-    accountId: string;
-    description: string;
-    actionParts: string[];
-    type: NotificationTypeCode;
-    userId: string;
-    isRead: boolean;
-    readAt: number;
-}

package/dist/types/lib/entities/NotificationMessageStats.d.ts

@@ -1,5 +0,0 @@
-export declare class NotificationMessageStats {
-    unreadCount: number;
-    totalCount: number;
-    constructor(unreadCount?: number, totalCount?: number);
-}

package/dist/types/lib/entities/Radius.d.ts

@@ -1,15 +0,0 @@
-import { StringKeyValue } from '../common';
-import { BaseEntity } from '../base';
-export declare class Radius extends BaseEntity {
-    source: string;
-    accountId: string;
-    streamId: string;
-    assignedOn: number;
-    mac: string;
-    ip: string;
-    sid: string;
-    eid: string;
-    country: string;
-    operator: string;
-    attributes: StringKeyValue[];
-}

package/dist/types/lib/entities/RegulatoryViolation.d.ts

@@ -1,7 +0,0 @@
-export declare class RegulatoryViolation {
-    title: string;
-    clause: string;
-    description: string;
-    sourceLink: string;
-    constructor(title?: string, clause?: string, description?: string, sourceLink?: string);
-}

package/dist/types/lib/entities/Report.d.ts

@@ -1,14 +0,0 @@
-import { ReportTypeCode } from '../enums';
-import { TimeFrame } from '../common';
-import { BaseEntity } from '../base';
-export declare class Report extends BaseEntity {
-    accountId: string;
-    userId: string;
-    name: string;
-    cron: string;
-    recipients: string[];
-    reportType: ReportTypeCode;
-    timeFrame: TimeFrame;
-    status: boolean;
-    receiveViaMail: boolean;
-}

package/dist/types/lib/entities/ReportInstance.d.ts

@@ -1,17 +0,0 @@
-import { IntDistribution } from '../entities';
-import { DeviceReport } from '../entities';
-import { ReportTypeCode } from '../enums';
-import { BaseEntity } from '../base';
-export declare class ReportInstance extends BaseEntity {
-    accountId: string;
-    from: number;
-    to: number;
-    score: number;
-    devicesDistributionByStatus: IntDistribution;
-    deviceReport: DeviceReport;
-    alertsDistributionBySeverity: IntDistribution;
-    downloadLink: string;
-    reportTriggerSource: ReportTypeCode;
-    triggeredByUser: string;
-    triggeredByScheduler: string;
-}

package/dist/types/lib/entities/Rule.d.ts

@@ -1,30 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-import { BaseEntity } from '../base';
-import { RuleTypeCode } from '../enums';
-import { DataSourceCode } from '../enums';
-import { ConditionDescription } from '../common';
-import { DeviceTypeCode } from '../enums';
-import { EventTypeCode } from '../enums';
-export declare class Rule extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    name: string;
-    type: RuleTypeCode;
-    description: string;
-    isSystemRule: boolean;
-    isActiveRule: boolean;
-    context: DataSourceCode;
-    matchAll: ConditionDescription[];
-    matchAny: ConditionDescription[];
-    excludeIDs: string[];
-    excludeTags: string[];
-    excludeTypes: DeviceTypeCode[];
-    timeWindowSec: number;
-    setEventType: EventTypeCode;
-    setEventSeverity: SeverityTypeCode;
-    lastAlertTimestamp: number;
-    alertsCount: number;
-    includeIDs: string[];
-    includeTags: string[];
-    includeTypes: DeviceTypeCode[];
-}

package/dist/types/lib/entities/RuleTemplate.d.ts

@@ -1,14 +0,0 @@
-import { DataSourceCode } from '../enums';
-import { EventTypeCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-import { BaseEntity } from '../base';
-export declare class RuleTemplate extends BaseEntity {
-    name: string;
-    description: string;
-    context: DataSourceCode;
-    matchAll: string[];
-    matchAny: string[];
-    timeWindowSec: number;
-    setEventType: EventTypeCode;
-    setEventSeverity: SeverityTypeCode;
-}

package/dist/types/lib/entities/SIM.d.ts

@@ -1,8 +0,0 @@
-export declare class SIM {
-    id: string;
-    ip: string;
-    iccid: string;
-    imsi: string;
-    msisdn: string;
-    constructor(id?: string, iP?: string, iCCID?: string, iMSI?: string, mSISDN?: string);
-}

package/dist/types/lib/entities/ServiceStatus.d.ts

@@ -1,8 +0,0 @@
-import { BaseEntity } from '../base';
-export declare class ServiceStatus extends BaseEntity {
-    serviceName: string;
-    hostName: string;
-    startTime: number;
-    accountId: string;
-    metrics: any;
-}

package/dist/types/lib/entities/SessionRecord.d.ts

@@ -1,22 +0,0 @@
-import { BaseEntity } from '../base';
-export declare class SessionRecord extends BaseEntity {
-    source: string;
-    sessionId: string;
-    accountId: string;
-    streamId: string;
-    deviceId: string;
-    simId: string;
-    startTime: number;
-    endTime: number;
-    deviceIp: string;
-    devicePort: number;
-    dstIP: string;
-    dstPort: number;
-    dstDns: string;
-    protocol: string;
-    packetsIn: number;
-    packetsOut: number;
-    bytesIn: number;
-    bytesOut: number;
-    labels: string[];
-}

package/dist/types/lib/entities/Shieldex.d.ts

@@ -1,7 +0,0 @@
-import { BaseEntity } from '../base';
-export declare class Shieldex extends BaseEntity {
-    accountId: string;
-    streamId: string;
-    eventCount: number;
-    score: number;
-}

package/dist/types/lib/entities/Stream.d.ts

@@ -1,11 +0,0 @@
-import { StringKeyValue } from '../common';
-import { StreamConfig } from '../entities';
-import { BaseEntity } from '../base';
-export declare class Stream extends BaseEntity {
-    accountId: string;
-    name: string;
-    description: string;
-    enabled: boolean;
-    labels: StringKeyValue[];
-    config: StreamConfig;
-}