@shieldiot/pulse-lib 1.0.10 → 1.0.12

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

@@ -0,0 +1,10 @@
+import { BaseEntity } from '../base';
+import { DeviceActionCode } from '../enums';
+export declare class Action extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    eventId: string;
+    deviceId: string;
+    action: DeviceActionCode;
+    userId: string;
+}

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

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

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

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

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

@@ -0,0 +1,11 @@
+import { StringKeyIntValue } from '../common';
+import { BaseEntity } from '../base';
+export declare class ApiKey extends BaseEntity {
+    name: string;
+    ttl: number;
+    acl: StringKeyIntValue[];
+    version: number;
+    systemKey: boolean;
+    enabled: boolean;
+    key: string;
+}

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

@@ -0,0 +1,13 @@
+import { UserTypeCode } from '../enums';
+import { BaseEntity } from '../base';
+export declare class AuditLog extends BaseEntity {
+    accountId: string;
+    userId: string;
+    userType: UserTypeCode;
+    action: string;
+    itemType: string;
+    itemId: string;
+    itemName: string;
+    beforeChange: string;
+    afterChange: string;
+}

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

@@ -0,0 +1,5 @@
+import { Device } from '../entities';
+export declare class BulkDevices {
+    values: Device[];
+    constructor(values?: Device[]);
+}

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

@@ -0,0 +1,23 @@
+import { BaseEntity } from '../base';
+export declare class Checkpoint extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    checkpoint: number;
+    firstPacketTime: number;
+    lastPacketTime: number;
+    label: string;
+    description: string;
+    elapsed: number;
+    totalFiles: number;
+    totalPackets: number;
+    totalUsage: number;
+    totalSession: number;
+    totalRadius: number;
+    overlappedPackets: number;
+    failedPackets: number;
+    irrelevantPackets: number;
+    unmappedPackets: number;
+    processedPackets: number;
+    state: number;
+    processedBy: string;
+}

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

@@ -0,0 +1,7 @@
+export declare class ComplianceReportSettings {
+    title: string;
+    subTitle: string;
+    header: string;
+    footer: string;
+    constructor(title?: string, subTitle?: string, header?: string, footer?: string);
+}

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

@@ -0,0 +1,8 @@
+import { OperatorCode } from '../enums';
+export declare class Condition {
+    field: string;
+    operator: OperatorCode;
+    values: number[];
+    strings: string[];
+    constructor(field?: string, operator?: OperatorCode, values?: number[], strings?: string[]);
+}

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

@@ -0,0 +1,6 @@
+import { BaseEntity } from '../base';
+export declare class ConfigParam extends BaseEntity {
+    inputType: string;
+    group: string;
+    value: string;
+}

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

@@ -0,0 +1,5 @@
+import { ConfigParam } from '../entities';
+import { BaseEntity } from '../base';
+export declare class ConfigParams extends BaseEntity {
+    params: ConfigParam[];
+}

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

@@ -0,0 +1,12 @@
+import { BaseEntity } from '../base';
+export declare class DNSRecord extends BaseEntity {
+    source: string;
+    deviceId: string;
+    deviceIp: string;
+    accountId: string;
+    streamId: string;
+    startTime: number;
+    endTime: number;
+    fqdn: string;
+    records: string[];
+}

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

@@ -0,0 +1,18 @@
+import { DeviceTypeCode } from '../enums';
+import { DeviceCreationCode } from '../enums';
+import { DeviceIdentityCode } from '../enums';
+export declare class DataIngestion {
+    inputURI: string;
+    format: string;
+    archiveURI: string;
+    inputFilesExt: string[];
+    subNets: string[];
+    exclude: string[];
+    usageTimeWindowSec: number;
+    sessionTimeWindowSec: number;
+    schedule: string;
+    defaultDeviceType: DeviceTypeCode;
+    deviceCreationPolicy: DeviceCreationCode;
+    deviceIdentityPolicy: DeviceIdentityCode;
+    constructor(inputURI?: string, format?: string, archiveURI?: string, inputFilesExt?: string[], subNets?: string[], exclude?: string[], usageTimeWindowSec?: number, sessionTimeWindowSec?: number, schedule?: string, defaultDeviceType?: DeviceTypeCode, deviceCreationPolicy?: DeviceCreationCode, deviceIdentityPolicy?: DeviceIdentityCode);
+}

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

@@ -0,0 +1,6 @@
+import { DeviceReport } from '../entities';
+export declare class DataPointOfDeviceReport {
+    timestamp: number;
+    value: DeviceReport;
+    constructor(timestamp?: number, value?: DeviceReport);
+}

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

@@ -0,0 +1,30 @@
+import { DeviceTypeCode } from '../enums';
+import { DeviceStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { DeviceActionCode } from '../enums';
+import { SIM } from '../entities';
+import { BaseEntity } from '../base';
+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[];
+}

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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,32 @@
+import { StringKeyValue } from '../common';
+import { DeviceActionCode } from '../enums';
+import { SIM } from '../entities';
+import { Event } from '../entities';
+import { BaseEntity } from '../base';
+import { DeviceTypeCode } from '../enums';
+import { DeviceStatusCode } from '../enums';
+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[];
+}

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,38 @@
+import { EventTypeCode } from '../enums';
+import { GeoData } from '../common';
+import { StringKeyValue } from '../common';
+import { TrafficDirectionCode } from '../enums';
+import { BaseEntity } from '../base';
+import { EventOccurrence } from '../entities';
+import { SeverityTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { Indicator } from '../common';
+import { RuleTypeCode } from '../enums';
+import { EventCategoryCode } 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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,39 @@
+import { SeverityTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { RuleTypeCode } from '../enums';
+import { GeoData } from '../common';
+import { EventOccurrence } from '../entities';
+import { BaseEntity } from '../base';
+import { EventTypeCode } from '../enums';
+import { Indicator } from '../common';
+import { StringKeyValue } from '../common';
+import { EventCategoryCode } from '../enums';
+import { TrafficDirectionCode } from '../enums';
+import { Device } from '../entities';
+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

@@ -0,0 +1,6 @@
+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

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

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

@@ -0,0 +1,8 @@
+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/Image.d.ts

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

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

@@ -0,0 +1,18 @@
+import { SeverityTypeCode } from '../enums';
+import { DirectionContextCode } from '../enums';
+import { BaseEntity } from '../base';
+import { InsightTypeCode } from '../enums';
+import { InsightStatusCode } from '../enums';
+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;
+}

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

@@ -0,0 +1,10 @@
+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;
+}

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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,31 @@
+import { StringKeyValue } from '../common';
+import { EventTypeCode } from '../enums';
+import { SeverityTypeCode } from '../enums';
+import { DeviceActionCode } from '../enums';
+import { BaseEntity } from '../base';
+import { IntegrationTypeCode } from '../enums';
+import { IntegrationTriggerCode } from '../enums';
+import { HttpMethodCode } 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

@@ -0,0 +1,7 @@
+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/Radius.d.ts

@@ -0,0 +1,15 @@
+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/Report.d.ts

@@ -0,0 +1,13 @@
+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[];
+    subject: string;
+    reportType: ReportTypeCode;
+    timeFrame: TimeFrame;
+}

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

@@ -0,0 +1,27 @@
+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 { Condition } from '../entities';
+export declare class Rule extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    name: string;
+    type: RuleTypeCode;
+    description: string;
+    isSystemRule: boolean;
+    isActiveRule: boolean;
+    context: DataSourceCode;
+    matchAll: Condition[];
+    matchAny: Condition[];
+    excludeIDs: string[];
+    excludeTags: string[];
+    excludeTypes: DeviceTypeCode[];
+    timeWindowSec: number;
+    setEventType: EventTypeCode;
+    setEventSeverity: SeverityTypeCode;
+    lastAlertTimestamp: number;
+    alertsCount: number;
+}

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

@@ -0,0 +1,14 @@
+import { BaseEntity } from '../base';
+import { DataSourceCode } from '../enums';
+import { EventTypeCode } from '../enums';
+import { SeverityTypeCode } from '../enums';
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,11 @@
+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;
+}