@shieldiot/pulse-lib 1.0.411 → 2.0.1409

package/dist/types/lib/model/SeverityTypeCode.d.ts

@@ -0,0 +1,10 @@
+import { Tuple } from '.';
+export declare enum SeverityTypeCode {
+    UNDEFINED = 0,
+    LOW = 1,
+    MEDIUM = 2,
+    HIGH = 3,
+    CRITICAL = 4
+}
+export declare function GetSeverityTypeCodes(): Tuple<SeverityTypeCode, string>[];
+export declare function MapSeverityTypeCodes(): Map<SeverityTypeCode, string>;

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

@@ -0,0 +1,8 @@
+import { BaseEntity } from './BaseEntity';
+export declare class Shieldex extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    eventCount: number;
+    score: number;
+}
+export declare function NewShieldex(): Shieldex;

package/dist/types/lib/model/ShieldexConfig.d.ts

@@ -0,0 +1,10 @@
+export declare class ShieldexConfig {
+    alphaWeightFactor: number;
+    percentFactor: number;
+    lowRiskWeight: number;
+    mediumRiskWeight: number;
+    highRiskWeight: number;
+    criticalRiskWeight: number;
+    constructor(alphaWeightFactor?: number, percentFactor?: number, lowRiskWeight?: number, mediumRiskWeight?: number, highRiskWeight?: number, criticalRiskWeight?: number);
+}
+export declare function NewShieldexConfig(): ShieldexConfig;

package/dist/types/lib/model/SimpleEntity.d.ts

@@ -0,0 +1,4 @@
+export declare class SimpleEntity<T> {
+    value: T;
+    constructor(value?: T);
+}

package/dist/types/lib/model/StixCollection.d.ts

@@ -0,0 +1,11 @@
+import { BaseEntity } from './BaseEntity';
+export declare class StixCollection extends BaseEntity {
+    accountId: string;
+    title: string;
+    description: string;
+    mediaTypes: string[];
+    bearerTokenHash: string;
+    tokenPrefix: string;
+    apiRoot: string;
+}
+export declare function NewStixCollection(): StixCollection;

package/dist/types/lib/model/StixCollectionView.d.ts

@@ -0,0 +1,10 @@
+import { BaseEntity } from './BaseEntity';
+export declare class StixCollectionView extends BaseEntity {
+    accountId: string;
+    title: string;
+    description: string;
+    mediaTypes: string[];
+    apiRoot: string;
+    publicUrl: string;
+}
+export declare function NewStixCollectionView(): StixCollectionView;

package/dist/types/lib/model/StixIndicator.d.ts

@@ -0,0 +1,21 @@
+import { BaseEntity } from './BaseEntity';
+export declare class StixIndicator extends BaseEntity {
+    accountId: string;
+    collectionId: string;
+    ipValue: string;
+    ipVersion: number;
+    pattern: string;
+    sourceEventId: string;
+    sourceDeviceId: string;
+    dateAdded: number;
+    modified: number;
+    validFrom: number;
+    validUntil: number;
+    revoked: boolean;
+    revokedAt: number;
+    version: number;
+    name: string;
+    description: string;
+    indicatorTypes: string;
+}
+export declare function NewStixIndicator(): StixIndicator;

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

@@ -0,0 +1,13 @@
+import { BaseEntity } from './BaseEntity';
+import { Tuple } from './Tuple';
+import { StreamConfig } from './StreamConfig';
+export declare class Stream extends BaseEntity {
+    accountId: string;
+    name: string;
+    description: string;
+    providerAPN: string;
+    enabled: boolean;
+    labels: Tuple<string, string>[];
+    config: StreamConfig;
+}
+export declare function NewStream(): Stream;

package/dist/types/lib/model/StreamAnalyticsConfig.d.ts

@@ -0,0 +1,13 @@
+import { Thresholds } from './Thresholds';
+import { ShieldexConfig } from './ShieldexConfig';
+import { EventSeverityConfig } from './EventSeverityConfig';
+import { DeviceConfig } from './DeviceConfig';
+import { BaseEntity } from './BaseEntity';
+export declare class StreamAnalyticsConfig extends BaseEntity {
+    accountId: string;
+    thresholds: Thresholds;
+    shieldexConfig: ShieldexConfig;
+    eventSeverityConfig: EventSeverityConfig;
+    deviceConfig: DeviceConfig;
+}
+export declare function NewStreamAnalyticsConfig(): StreamAnalyticsConfig;

package/dist/types/lib/model/StreamConfig.d.ts

@@ -0,0 +1,23 @@
+import { DeviceConfig } from './DeviceConfig';
+import { DataIngestion } from './DataIngestion';
+import { SessionTransform } from './SessionTransform';
+import { UsageTransform } from './UsageTransform';
+import { Thresholds } from './Thresholds';
+import { ShieldexConfig } from './ShieldexConfig';
+import { DeviceActionCode } from './DeviceActionCode';
+import { IdsConfig } from './IdsConfig';
+import { EventSeverityConfig } from './EventSeverityConfig';
+export declare class StreamConfig {
+    ingest: DataIngestion;
+    sessionTransform: SessionTransform;
+    usageTransform: UsageTransform;
+    thresholds: Thresholds;
+    shieldexConfig: ShieldexConfig;
+    eventSeverityConfig: EventSeverityConfig;
+    preventiveActions: DeviceActionCode[];
+    deviceConfig: DeviceConfig;
+    parserRules: string[];
+    idsConfig: IdsConfig;
+    constructor(ingest?: DataIngestion, sessionTransform?: SessionTransform, usageTransform?: UsageTransform, thresholds?: Thresholds, shieldexConfig?: ShieldexConfig, eventSeverityConfig?: EventSeverityConfig, preventiveActions?: DeviceActionCode[], deviceConfig?: DeviceConfig, parserRules?: string[], idsConfig?: IdsConfig);
+}
+export declare function NewStreamConfig(): StreamConfig;

package/dist/types/lib/model/StringIntValue.d.ts

@@ -0,0 +1,6 @@
+export declare class StringIntValue {
+    key: string;
+    value: number;
+    constructor(key?: string, value?: number);
+}
+export declare function NewStringIntValue(): StringIntValue;

package/dist/types/lib/model/StringKeyValue.d.ts

@@ -0,0 +1,6 @@
+export declare class StringKeyValue {
+    key: string;
+    value: string;
+    constructor(key?: string, value?: string);
+}
+export declare function NewStringKeyValue(): StringKeyValue;

package/dist/types/lib/model/TemplateParameter.d.ts

@@ -0,0 +1,9 @@
+export declare class TemplateParameter {
+    name: string;
+    label: string;
+    type: string;
+    required: boolean;
+    defaultVal: string;
+    constructor(name?: string, label?: string, type?: string, required?: boolean, defaultVal?: string);
+}
+export declare function NewTemplateParameter(): TemplateParameter;

package/dist/types/lib/model/TemplateStep.d.ts

@@ -0,0 +1,16 @@
+import { HttpMethodCode } from './HttpMethodCode';
+import { Tuple } from './Tuple';
+import { ResponseExtraction } from './ResponseExtraction';
+export declare class TemplateStep {
+    name: string;
+    order: number;
+    isMain: boolean;
+    isCleanup: boolean;
+    method: HttpMethodCode;
+    url: string;
+    headers: Tuple<string, string>[];
+    body: string;
+    extractions: ResponseExtraction[];
+    constructor(name?: string, order?: number, isMain?: boolean, isCleanup?: boolean, method?: HttpMethodCode, url?: string, headers?: Tuple<string, string>[], body?: string, extractions?: ResponseExtraction[]);
+}
+export declare function NewTemplateStep(): TemplateStep;

package/dist/types/lib/model/Thresholds.d.ts

@@ -0,0 +1,5 @@
+export declare class Thresholds {
+    inactiveDeviceWindowMin: number;
+    constructor(inactiveDeviceWindowMin?: number);
+}
+export declare function NewThresholds(): Thresholds;

package/dist/types/lib/model/TimeDataPoint.d.ts

@@ -0,0 +1,5 @@
+export declare class TimeDataPoint<V> {
+    timestamp: number;
+    value: V;
+    constructor(timestamp?: number, value?: V);
+}

package/dist/types/lib/model/TimeFrame.d.ts

@@ -0,0 +1,6 @@
+export declare class TimeFrame {
+    from: number;
+    to: number;
+    constructor(from?: number, to?: number);
+}
+export declare function NewTimeFrame(): TimeFrame;

package/dist/types/lib/model/TimePeriodCode.d.ts

@@ -0,0 +1,11 @@
+import { Tuple } from '.';
+export declare enum TimePeriodCode {
+    UNDEFINED = 0,
+    MINUTE = 1,
+    HOUR = 2,
+    DAY = 3,
+    WEEK = 4,
+    MONTH = 5
+}
+export declare function GetTimePeriodCodes(): Tuple<TimePeriodCode, string>[];
+export declare function MapTimePeriodCodes(): Map<TimePeriodCode, string>;

package/dist/types/lib/model/TimeSeries.d.ts

@@ -0,0 +1,8 @@
+import { TimeFrame } from './TimeFrame';
+import { TimeDataPoint } from './TimeDataPoint';
+export declare class TimeSeries<T> {
+    name: string;
+    range: TimeFrame;
+    values: TimeDataPoint<T>[];
+    constructor(name?: string, range?: TimeFrame, values?: TimeDataPoint<T>[]);
+}

package/dist/types/lib/model/TimeSeriesConsumption.d.ts

@@ -0,0 +1,10 @@
+import { TimeFrame } from './TimeFrame';
+import { TimeDataPoint } from './TimeDataPoint';
+import { ConsumptionDataPoint } from './ConsumptionDataPoint';
+export declare class TimeSeriesConsumption {
+    name: string;
+    range: TimeFrame;
+    values: TimeDataPoint<ConsumptionDataPoint>[];
+    constructor(name?: string, range?: TimeFrame, values?: TimeDataPoint<ConsumptionDataPoint>[]);
+}
+export declare function NewTimeSeriesConsumption(): TimeSeriesConsumption;

package/dist/types/lib/model/Timestamp.d.ts

@@ -0,0 +1,4 @@
+export declare class Timestamp {
+    constructor();
+}
+export declare function NewTimestamp(): Timestamp;

package/dist/types/lib/model/TokenData.d.ts

@@ -0,0 +1,10 @@
+export declare class TokenData {
+    accountId: string;
+    subjectId: string;
+    subjectType: number;
+    subjectRole: number;
+    status: number;
+    expiresIn: number;
+    constructor(accountId?: string, subjectId?: string, subjectType?: number, subjectRole?: number, status?: number, expiresIn?: number);
+}
+export declare function NewTokenData(): TokenData;

package/dist/types/lib/model/TrafficDirectionCode.d.ts

@@ -0,0 +1,9 @@
+import { Tuple } from '.';
+export declare enum TrafficDirectionCode {
+    UNDEFINED = 0,
+    INBOUND = 1,
+    OUTBOUND = 2,
+    INOUT = 3
+}
+export declare function GetTrafficDirectionCodes(): Tuple<TrafficDirectionCode, string>[];
+export declare function MapTrafficDirectionCodes(): Map<TrafficDirectionCode, string>;

package/dist/types/lib/model/Tuple.d.ts

@@ -0,0 +1,5 @@
+export declare class Tuple<K, V> {
+    key: K;
+    value: V;
+    constructor(key?: K, value?: V);
+}

package/dist/types/lib/model/UsageRecord.d.ts

@@ -0,0 +1,36 @@
+import { BaseEntity } from './BaseEntity';
+export declare class UsageRecord extends BaseEntity {
+    source: string;
+    accountId: string;
+    streamId: string;
+    deviceId: string;
+    simId: string;
+    deviceIp: 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[];
+    srcPortsMap: Record<string, any>;
+    dstPortsMap: Record<string, any>;
+    endpointsMap: Record<string, any>;
+}
+export declare function NewUsageRecord(): UsageRecord;

package/dist/types/lib/model/UsageTransform.d.ts

@@ -0,0 +1,11 @@
+import { ZScore } from './ZScore';
+export declare class UsageTransform {
+    packetsIn: ZScore;
+    packetsOut: ZScore;
+    bytesIn: ZScore;
+    bytesOut: ZScore;
+    endpointsCount: ZScore;
+    portsCount: ZScore;
+    constructor(packetsIn?: ZScore, packetsOut?: ZScore, bytesIn?: ZScore, bytesOut?: ZScore, endpointsCount?: ZScore, portsCount?: ZScore);
+}
+export declare function NewUsageTransform(): UsageTransform;

package/dist/types/lib/model/User.d.ts

@@ -0,0 +1,18 @@
+import { UserStatusCode } from './UserStatusCode';
+import { Tuple } from './Tuple';
+import { BaseEntityEx } from './BaseEntityEx';
+import { UserTypeCode } from './UserTypeCode';
+export declare class User extends BaseEntityEx {
+    name: string;
+    externalId: string;
+    email: string;
+    mobile: string;
+    type: UserTypeCode;
+    status: UserStatusCode;
+    defaultAccount: string;
+    lastSignIn: number;
+    labels: Tuple<string, string>[];
+    groups: string[];
+    isTracked: boolean;
+}
+export declare function NewUser(): User;

package/dist/types/lib/model/UserMembership.d.ts

@@ -0,0 +1,6 @@
+import { AccountRole } from './AccountRole';
+import { User } from './User';
+export declare class UserMembership extends User {
+    accountRole: AccountRole;
+}
+export declare function NewUserMembership(): UserMembership;

package/dist/types/lib/model/UserMemberships.d.ts

@@ -0,0 +1,6 @@
+import { AccountRole } from './AccountRole';
+import { User } from './User';
+export declare class UserMemberships extends User {
+    accountRoles: AccountRole[];
+}
+export declare function NewUserMemberships(): UserMemberships;

package/dist/types/lib/model/UserNotificationMessage.d.ts

@@ -0,0 +1,8 @@
+import { BaseEntity } from './BaseEntity';
+export declare class UserNotificationMessage extends BaseEntity {
+    notificationId: string;
+    userId: string;
+    isRead: boolean;
+    readAt: number;
+}
+export declare function NewUserNotificationMessage(): UserNotificationMessage;

package/dist/types/lib/model/UserStatusCode.d.ts

@@ -0,0 +1,10 @@
+import { Tuple } from '.';
+export declare enum UserStatusCode {
+    UNDEFINED = 0,
+    PENDING = 1,
+    ACTIVE = 2,
+    BLOCKED = 3,
+    SUSPENDED = 4
+}
+export declare function GetUserStatusCodes(): Tuple<UserStatusCode, string>[];
+export declare function MapUserStatusCodes(): Map<UserStatusCode, string>;

package/dist/types/lib/model/UserTypeCode.d.ts

@@ -0,0 +1,10 @@
+import { Tuple } from '.';
+export declare enum UserTypeCode {
+    UNDEFINED = 0,
+    SYSADMIN = 1,
+    SUPPORT = 2,
+    USER = 3,
+    SERVICE = 4
+}
+export declare function GetUserTypeCodes(): Tuple<UserTypeCode, string>[];
+export declare function MapUserTypeCodes(): Map<UserTypeCode, string>;

package/dist/types/lib/model/WSOpCode.d.ts

@@ -0,0 +1,10 @@
+import { Tuple } from '.';
+export declare enum WSOpCode {
+    PING = 0,
+    NOTIFICATION_MESSAGE = 10,
+    NOTIFICATION_MESSAGE_ACK = 11,
+    SUSPICIOUS_IP_ANALYSIS_READY = 20,
+    SUSPICIOUS_IP_ANALYSIS_ERROR = 21
+}
+export declare function GetWSOpCodes(): Tuple<WSOpCode, string>[];
+export declare function MapWSOpCodes(): Map<WSOpCode, string>;

package/dist/types/lib/model/ZScore.d.ts

@@ -0,0 +1,6 @@
+export declare class ZScore {
+    mean: number;
+    sd: number;
+    constructor(mean?: number, sd?: number);
+}
+export declare function NewZScore(): ZScore;

package/dist/types/lib/model/errorStruct.d.ts

@@ -0,0 +1,6 @@
+export declare class errorStruct {
+    code: number;
+    text: string;
+    constructor(code?: number, text?: string);
+}
+export declare function NewerrorStruct(): errorStruct;

package/dist/types/lib/model/index.d.ts

@@ -0,0 +1,192 @@
+export * from './RuleActivityStatusCode';
+export * from './TrafficDirectionCode';
+export * from './UserTypeCode';
+export * from './TimePeriodCode';
+export * from './HomePageViewCode';
+export * from './IntegrationTypeCode';
+export * from './ParserTaskCompletionStatus';
+export * from './AITasksCode';
+export * from './AccountTypeCode';
+export * from './EventCategoryCode';
+export * from './HttpMethodCode';
+export * from './OperatorCode';
+export * from './ReportSourceCode';
+export * from './CheckPointStateCode';
+export * from './EventTypeCode';
+export * from './AccountStatusCode';
+export * from './DeviceIdentityCode';
+export * from './FeatureCode';
+export * from './InsightStatusCode';
+export * from './DeviceTypeCode';
+export * from './UserStatusCode';
+export * from './WSOpCode';
+export * from './DeviceCreationCode';
+export * from './DeviceStatusCode';
+export * from './NotificationTypeCode';
+export * from './ReportTypeCode';
+export * from './RuleTypeCode';
+export * from './SeverityTypeCode';
+export * from './NetworkMapTypeCode';
+export * from './DeviceActionCode';
+export * from './DirectionContextCode';
+export * from './EventStatusCode';
+export * from './InsightSourceCode';
+export * from './InsightTypeCode';
+export * from './IntegrationTriggerCode';
+export * from './PermissionCode';
+export * from './BoolTypeCode';
+export * from './DataSourceCode';
+export * from './MemberRoleCode';
+export * from './RuleCountThresholdConfig';
+export * from './AIRecommendedActions';
+export * from './Notification';
+export * from './Indicator';
+export * from './UsageTransform';
+export * from './BaseRestResponse';
+export * from './BaseEntity';
+export * from './Link';
+export * from './NetworkEndpoint';
+export * from './ConfigParams';
+export * from './InsightQuery';
+export * from './ResponseExtraction';
+export * from './NetworkTopologyReport';
+export * from './StixIndicator';
+export * from './LocalTime';
+export * from './DevicesMap';
+export * from './Image';
+export * from './NotificationMessageDTO';
+export * from './Stream';
+export * from './UserMemberships';
+export * from './Entities';
+export * from './GraphSeries';
+export * from './AuditLog';
+export * from './StreamAnalyticsConfig';
+export * from './AICrossCorrelationAnalysis';
+export * from './TemplateParameter';
+export * from './NotificationMessage';
+export * from './EntityResponse';
+export * from './Account';
+export * from './Feature';
+export * from './UserNotificationMessage';
+export * from './TimeSeries';
+export * from './StringKeyValue';
+export * from './IntKeyValue';
+export * from './IntFloatValue';
+export * from './NetworkTopologyRecord';
+export * from './ServiceStatus';
+export * from './IdsList';
+export * from './NotificationQueuePayload';
+export * from './BaseEntityEx';
+export * from './Node';
+export * from './Integration';
+export * from './Shieldex';
+export * from './StixCollection';
+export * from './Message';
+export * from './AccountRole';
+export * from './NetworkMap';
+export * from './SeriesData';
+export * from './AccountDTO';
+export * from './EventWithDevice';
+export * from './DeviceConfig';
+export * from './User';
+export * from './BaseMessage';
+export * from './AIEventDetail';
+export * from './TimeFrame';
+export * from './RuleWithSQL';
+export * from './IntegrationContext';
+export * from './AIContextReasoning';
+export * from './SIM';
+export * from './Json';
+export * from './AIEvidenceAgainstLegitimateScannerHypothesis';
+export * from './InsightSpec';
+export * from './Member';
+export * from './StixCollectionView';
+export * from './JsonDoc';
+export * from './Action';
+export * from './Device';
+export * from './Group';
+export * from './MaliciousIpCard';
+export * from './RuleTemplate';
+export * from './SessionTransform';
+export * from './EventSeverityConfig';
+export * from './FloatInterval';
+export * from './Alert';
+export * from './BatchJob';
+export * from './DataIngestion';
+export * from './EntityRequest';
+export * from './MapBounds';
+export * from './AccountSettings';
+export * from './AccountReportDTO';
+export * from './ConfigParam';
+export * from './DeploymentInfo';
+export * from './EventOccurrence';
+export * from './TemplateStep';
+export * from './Radius';
+export * from './Tuple';
+export * from './LoginParams';
+export * from './AIBehavioralPatterns';
+export * from './MitreAttackCategory';
+export * from './StreamConfig';
+export * from './IdsConfig';
+export * from './ShieldexConfig';
+export * from './ActionResponse';
+export * from './Insight';
+export * from './DeviceScoreConfig';
+export * from './MaliciousIPData';
+export * from './NetworkTopology';
+export * from './TokenData';
+export * from './AICheckpoint';
+export * from './SimpleEntity';
+export * from './ColumnDef';
+export * from './TimeSeriesConsumption';
+export * from './AIAttributionAssessment';
+export * from './AIExecutiveSummary';
+export * from './LlmPrompt';
+export * from './DevicesAtRiskConfig';
+export * from './EntitiesRequest';
+export * from './ConditionDescription';
+export * from './StringIntValue';
+export * from './DeviceWithEvents';
+export * from './NetworkTopologyReportParams';
+export * from './NotificationMessageStats';
+export * from './AIInfrastructureAnalysis';
+export * from './Rule';
+export * from './errorStruct';
+export * from './EntityAction';
+export * from './ConsumptionDataPoint';
+export * from './Checkpoint';
+export * from './RegulatoryViolation';
+export * from './AIEvidenceSupportingMaliciousC2Infrastructure';
+export * from './AINetworkPositionAndTrafficAnalysis';
+export * from './ReportInstance';
+export * from './SeverityConditionConfig';
+export * from './UserMembership';
+export * from './AccountInfo';
+export * from './DeviceReport';
+export * from './Distribution';
+export * from './FlowRecord';
+export * from './IntegrationTemplate';
+export * from './NetworkTopologyReportKPIs';
+export * from './IdsRule';
+export * from './Thresholds';
+export * from './Interval';
+export * from './Event';
+export * from './SeverityIntervalTuple';
+export * from './EntityMessage';
+export * from './TimeDataPoint';
+export * from './Timestamp';
+export * from './Location';
+export * from './ZScore';
+export * from './AlertWithDevice';
+export * from './ApiKey';
+export * from './UsageRecord';
+export * from './Report';
+export * from './AIHypothesis';
+export * from './BatchItem';
+export * from './DNSRecord';
+export * from './FeaturesGroup';
+export * from './RuleBasedSeverityConditionConfig';
+export * from './EntitiesResponse';
+export * from './DeviceNode';
+export * from './GeoData';
+export * from './SessionRecord';