@shieldiot/pulse-lib 1.0.2 → 1.0.4

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

@@ -0,0 +1,12 @@
+import { BaseEntity } from '../entities';
+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/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/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/lib/entities/Device.d.ts

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

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

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

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

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

package/dist/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/lib/entities/Event.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/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/lib/entities/Integration.d.ts

@@ -0,0 +1,31 @@
+import { SeverityTypeCode } from '../enums';
+import { DeviceActionCode } from '../enums';
+import { BaseEntity } from '../entities';
+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/lib/entities/Member.d.ts

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

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

@@ -0,0 +1,15 @@
+import { StringKeyValue } from '../common';
+import { BaseEntity } from '../entities';
+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/lib/entities/Report.d.ts

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

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

@@ -0,0 +1,25 @@
+import { SeverityTypeCode } from '../enums';
+import { BaseEntity } from '../entities';
+import { RuleTypeCode } from '../enums';
+import { DataSourceCode } from '../enums';
+import { Condition } from '../entities';
+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: Condition[];
+    matchAny: Condition[];
+    excludeIDs: string[];
+    excludeTags: string[];
+    excludeTypes: DeviceTypeCode[];
+    timeWindowSec: number;
+    setEventType: EventTypeCode;
+    setEventSeverity: SeverityTypeCode;
+}

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

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

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

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

@@ -0,0 +1,22 @@
+import { BaseEntity } from '../entities';
+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/lib/entities/Shieldex.d.ts

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

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

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

package/dist/lib/entities/StreamAnalyticsConfig.d.ts

@@ -0,0 +1,12 @@
+import { Thresholds } from '../common';
+import { ShieldexConfig } from '../common';
+import { EventSeverityConfig } from '../common';
+import { DeviceConfig } from '../common';
+import { BaseEntity } from '../entities';
+export declare class StreamAnalyticsConfig extends BaseEntity {
+    accountId: string;
+    thresholds: Thresholds;
+    shieldexConfig: ShieldexConfig;
+    eventSeverityConfig: EventSeverityConfig;
+    deviceConfig: DeviceConfig;
+}

package/dist/lib/entities/StreamConfig.d.ts

@@ -0,0 +1,19 @@
+import { DeviceActionCode } from '../enums';
+import { DeviceConfig } from '../common';
+import { DataIngestion } from '../entities';
+import { SessionTransform } from '../common';
+import { UsageTransform } from '../common';
+import { Thresholds } from '../common';
+import { ShieldexConfig } from '../common';
+import { EventSeverityConfig } from '../common';
+export declare class StreamConfig {
+    ingest: DataIngestion;
+    sessionTransform: SessionTransform;
+    usageTransform: UsageTransform;
+    thresholds: Thresholds;
+    shieldexConfig: ShieldexConfig;
+    eventSeverityConfig: EventSeverityConfig;
+    preventiveActions: DeviceActionCode[];
+    deviceConfig: DeviceConfig;
+    constructor(ingest?: DataIngestion, sessionTransform?: SessionTransform, usageTransform?: UsageTransform, thresholds?: Thresholds, shieldexConfig?: ShieldexConfig, eventSeverityConfig?: EventSeverityConfig, preventiveActions?: DeviceActionCode[], deviceConfig?: DeviceConfig);
+}

package/dist/lib/entities/TeaserPopUpSettings.d.ts

@@ -0,0 +1,6 @@
+export declare class TeaserPopUpSettings {
+    header: string;
+    content: string;
+    notificationContent: string;
+    constructor(header?: string, content?: string, notificationContent?: string);
+}

package/dist/lib/entities/TimeSeriesOfDeviceReport.d.ts

@@ -0,0 +1,8 @@
+import { TimeFrame } from '../common';
+import { DataPointOfDeviceReport } from '../entities';
+export declare class TimeSeriesOfDeviceReport {
+    name: string;
+    range: TimeFrame;
+    values: DataPointOfDeviceReport[];
+    constructor(name?: string, range?: TimeFrame, values?: DataPointOfDeviceReport[]);
+}

package/dist/lib/entities/UsageRecord.d.ts

@@ -0,0 +1,32 @@
+import { BaseEntity } from '../entities';
+export declare class UsageRecord extends BaseEntity {
+    source: string;
+    accountId: string;
+    streamId: string;
+    deviceId: string;
+    deviceIp: string;
+    simId: string;
+    startTime: number;
+    endTime: number;
+    srcPortsList: number[];
+    srcPortsCount: number;
+    dstPortsList: number[];
+    dstPortsCount: number;
+    endpointsList: string[];
+    endpointsCount: number;
+    srcEndpoints: string[];
+    srcEndpointsCount: number;
+    dstEndpoints: string[];
+    dstEndpointsCount: number;
+    packetsIn: number;
+    packetsOut: number;
+    bytesIn: number;
+    bytesOut: number;
+    srcAckFlags: number;
+    dstAckFlags: number;
+    srcSynFlags: number;
+    dstSynFlags: number;
+    srcRstFlags: number;
+    dstRstFlags: number;
+    labels: string[];
+}

package/dist/lib/entities/User.d.ts

@@ -0,0 +1,16 @@
+import { UserTypeCode } from '../enums';
+import { UserStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { BaseEntity } from '../entities';
+export declare class User extends BaseEntity {
+    name: string;
+    externalId: string;
+    email: string;
+    mobile: string;
+    type: UserTypeCode;
+    status: UserStatusCode;
+    defaultAccount: string;
+    lastSignIn: number;
+    labels: StringKeyValue[];
+    groups: string;
+}

package/dist/lib/entities/UserMembership.d.ts

@@ -0,0 +1,14 @@
+import { UserTypeCode } from '../enums';
+import { UserStatusCode } from '../enums';
+import { AccountRole } from '../common';
+import { BaseEntity } from '../entities';
+export declare class UserMembership extends BaseEntity {
+    name: string;
+    email: string;
+    mobile: string;
+    type: UserTypeCode;
+    status: UserStatusCode;
+    defaultAccount: string;
+    lastSignIn: number;
+    accountRole: AccountRole;
+}

package/dist/lib/entities/UserMemberships.d.ts

@@ -0,0 +1,14 @@
+import { UserTypeCode } from '../enums';
+import { UserStatusCode } from '../enums';
+import { AccountRole } from '../common';
+import { BaseEntity } from '../entities';
+export declare class UserMemberships extends BaseEntity {
+    name: string;
+    email: string;
+    mobile: string;
+    type: UserTypeCode;
+    status: UserStatusCode;
+    defaultAccount: string;
+    lastSignIn: number;
+    accountRoles: AccountRole[];
+}

package/dist/lib/entities/index.d.ts

@@ -0,0 +1,52 @@
+export * from './Account';
+export * from './AccountDTO';
+export * from './AccountSettings';
+export * from './Action';
+export * from './Alert';
+export * from './AlertWithDevice';
+export * from './ApiKey';
+export * from './AuditLog';
+export * from './BaseEntity';
+export * from './BulkDevices';
+export * from './Checkpoint';
+export * from './ComplianceReportSettings';
+export * from './Condition';
+export * from './ConfigParam';
+export * from './DNSRecord';
+export * from './DataIngestion';
+export * from './DataPointOfDeviceReport';
+export * from './Device';
+export * from './DeviceReport';
+export * from './DeviceWithEvents';
+export * from './Distribution';
+export * from './Event';
+export * from './EventOccurrence';
+export * from './EventWithDevice';
+export * from './Feature';
+export * from './FeaturesGroup';
+export * from './Group';
+export * from './Image';
+export * from './Insight';
+export * from './InsightQuery';
+export * from './InsightSpec';
+export * from './IntDistribution';
+export * from './Integration';
+export * from './Member';
+export * from './Radius';
+export * from './Report';
+export * from './Rule';
+export * from './RuleTemplate';
+export * from './SIM';
+export * from './ServiceStatus';
+export * from './SessionRecord';
+export * from './Shieldex';
+export * from './Stream';
+export * from './StreamAnalyticsConfig';
+export * from './StreamConfig';
+export * from './TeaserPopUpSettings';
+export * from './TimeSeriesOfDeviceReport';
+export * from './UsageRecord';
+export * from './User';
+export * from './UserMembership';
+export * from './UserMemberships';
+export * from './index';