@shieldiot/pulse-lib 1.0.10 → 1.0.12

package/dist/types/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 '../base';
+export declare class StreamAnalyticsConfig extends BaseEntity {
+    accountId: string;
+    thresholds: Thresholds;
+    shieldexConfig: ShieldexConfig;
+    eventSeverityConfig: EventSeverityConfig;
+    deviceConfig: DeviceConfig;
+}

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

@@ -0,0 +1,19 @@
+import { EventSeverityConfig } from '../common';
+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';
+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/types/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/types/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/types/lib/entities/UsageRecord.d.ts

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

@@ -0,0 +1,16 @@
+import { UserTypeCode } from '../enums';
+import { UserStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { BaseEntity } from '../base';
+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/types/lib/entities/UserMembership.d.ts

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

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

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

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

@@ -0,0 +1,51 @@
+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 './BulkDevices';
+export * from './Checkpoint';
+export * from './ComplianceReportSettings';
+export * from './Condition';
+export * from './ConfigParam';
+export * from './ConfigParams';
+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';

package/dist/types/lib/enums/AccountStatusCode.d.ts

@@ -0,0 +1,7 @@
+export declare enum AccountStatusCode {
+    UNDEFINED = 0,
+    ACTIVE = 1,
+    SUSPENDED = 2,
+    DELETED = 3
+}
+export declare function GetAccountStatusCodes(): Map<AccountStatusCode, string>;

package/dist/types/lib/enums/AccountTypeCode.d.ts

@@ -0,0 +1,8 @@
+export declare enum AccountTypeCode {
+    UNDEFINED = 0,
+    DEMO = 1,
+    TRIAL = 2,
+    PARTNER = 3,
+    CUSTOMER = 4
+}
+export declare function GetAccountTypeCodes(): Map<AccountTypeCode, string>;

package/dist/types/lib/enums/DataSourceCode.d.ts

@@ -0,0 +1,7 @@
+export declare enum DataSourceCode {
+    UNDEFINED = 0,
+    EVENT = 1,
+    USAGE = 2,
+    SESSION = 3
+}
+export declare function GetDataSourceCodes(): Map<DataSourceCode, string>;

package/dist/types/lib/enums/DeviceActionCode.d.ts

@@ -0,0 +1,8 @@
+export declare enum DeviceActionCode {
+    UNDEFINED = 0,
+    REDIRECT = 1,
+    SUSPEND = 2,
+    THROTTLE = 3,
+    BLOCK_IP = 4
+}
+export declare function GetDeviceActionCodes(): Map<DeviceActionCode, string>;

package/dist/types/lib/enums/DeviceCreationCode.d.ts

@@ -0,0 +1,8 @@
+export declare enum DeviceCreationCode {
+    UNDEFINED = 0,
+    NONE = 1,
+    IP = 2,
+    SID = 3,
+    EID = 4
+}
+export declare function GetDeviceCreationCodes(): Map<DeviceCreationCode, string>;

package/dist/types/lib/enums/DeviceIdentityCode.d.ts

@@ -0,0 +1,11 @@
+export declare enum DeviceIdentityCode {
+    UNDEFINED = 0,
+    AUTO = 1,
+    IP = 2,
+    IMSI = 3,
+    ICCID = 4,
+    MSISDN = 5,
+    IMEI = 6,
+    MAC = 7
+}
+export declare function GetDeviceIdentityCodes(): Map<DeviceIdentityCode, string>;

package/dist/types/lib/enums/DeviceStatusCode.d.ts

@@ -0,0 +1,8 @@
+export declare enum DeviceStatusCode {
+    UNDEFINED = 0,
+    PENDING = 1,
+    ACTIVE = 2,
+    INACTIVE = 3,
+    BLOCKED = 4
+}
+export declare function GetDeviceStatusCodes(): Map<DeviceStatusCode, string>;

package/dist/types/lib/enums/DeviceTypeCode.d.ts

@@ -0,0 +1,18 @@
+export declare enum DeviceTypeCode {
+    UNDEFINED = 0,
+    OTHER = 1,
+    CONTROLLER = 2,
+    METER = 3,
+    SENSOR = 4,
+    CAMERA = 5,
+    POS = 6,
+    PUMP = 7,
+    CHARGING_STATION = 8,
+    LIGHTNING = 9,
+    TEMPERATURE_SENSOR = 10,
+    AIR_QUALITY_SENSOR = 11,
+    VALVE = 12,
+    GATEWAY = 13,
+    ATM = 14
+}
+export declare function GetDeviceTypeCodes(): Map<DeviceTypeCode, string>;

package/dist/types/lib/enums/DirectionContextCode.d.ts

@@ -0,0 +1,8 @@
+export declare enum DirectionContextCode {
+    UNDEFINED = 0,
+    EVENT_LIST = 1,
+    DEVICE_LIST = 2,
+    EVENT_DETAILS = 3,
+    DEVICE_DETAILS = 4
+}
+export declare function GetDirectionContextCodes(): Map<DirectionContextCode, string>;

package/dist/types/lib/enums/EventCategoryCode.d.ts

@@ -0,0 +1,6 @@
+export declare enum EventCategoryCode {
+    UNDEFINED = 0,
+    SECURITY = 1,
+    OPERATIONS = 2
+}
+export declare function GetEventCategoryCodes(): Map<EventCategoryCode, string>;

package/dist/types/lib/enums/EventStatusCode.d.ts

@@ -0,0 +1,8 @@
+export declare enum EventStatusCode {
+    UNDEFINED = 0,
+    NEW = 1,
+    OPEN = 2,
+    CLOSED_TRUE = 3,
+    CLOSED_FALSE = 4
+}
+export declare function GetEventStatusCodes(): Map<EventStatusCode, string>;

package/dist/types/lib/enums/EventTypeCode.d.ts

@@ -0,0 +1,23 @@
+export declare enum EventTypeCode {
+    UNDEFINED = 0,
+    OTHER = 1,
+    DEVICE_TAKEOVER = 2,
+    DDOS = 3,
+    UNKNOWN_MALWARE = 4,
+    MAN_IN_THE_MIDDLE = 5,
+    DATA_THEFT = 6,
+    PORT_SCANNING = 7,
+    ABNORMAL_DOWNLOAD = 8,
+    ABNORMAL_INCOMING_CONNECTION = 9,
+    UNSUCCESSFUL_CONNECTION_ATTEMPTS = 10,
+    HIGH_VOLUME_TRANSIT = 11,
+    DEVICE_LEVEL_ATTACK = 12,
+    REPLAY_ATTACK = 13,
+    DEVICE_TAKEOVER_ATTEMPT = 14,
+    UNKNOWN_OPERATION = 15,
+    CRYPTO_MINING = 16,
+    SUSPICIOUS_IP = 17,
+    ABNORMAL_OUTBOUND_PORTS = 18,
+    ABNORMAL_OUTBOUND_ENDPOINTS = 19
+}
+export declare function GetEventTypeCodes(): Map<EventTypeCode, string>;

package/dist/types/lib/enums/FeatureCode.d.ts

@@ -0,0 +1,14 @@
+export declare enum FeatureCode {
+    UNDEFINED = 0,
+    EVENTS_EXPORT = 1,
+    EVENT_SOURCE_FILES = 2,
+    EVENT_ACTION = 3,
+    DEVICES_EXPORT = 4,
+    DEVICE_NETWORK_MAP = 5,
+    DEVICE_ACTIONS = 6,
+    NETWORK_MAP = 7,
+    COMPLIANCE_REPORTS = 8,
+    CUSTOM_RULES = 9,
+    INTEGRATIONS = 10
+}
+export declare function GetFeatureCodes(): Map<FeatureCode, string>;

package/dist/types/lib/enums/HomePageViewCode.d.ts

@@ -0,0 +1,7 @@
+export declare enum HomePageViewCode {
+    UNDEFINED = 0,
+    SYSTEM = 1,
+    DEVICES = 2,
+    MALICIOUS = 3
+}
+export declare function GetHomePageViewCodes(): Map<HomePageViewCode, string>;

package/dist/types/lib/enums/HttpMethodCode.d.ts

@@ -0,0 +1,9 @@
+export declare enum HttpMethodCode {
+    UNDEFINED = 0,
+    GET = 1,
+    POST = 2,
+    PUT = 3,
+    PATCH = 4,
+    DELETE = 5
+}
+export declare function GetHttpMethodCodes(): Map<HttpMethodCode, string>;

package/dist/types/lib/enums/InsightStatusCode.d.ts

@@ -0,0 +1,7 @@
+export declare enum InsightStatusCode {
+    UNDEFINED = 0,
+    INACTIVE = 1,
+    PENDING = 2,
+    ACTIVE = 3
+}
+export declare function GetInsightStatusCodes(): Map<InsightStatusCode, string>;

package/dist/types/lib/enums/InsightTypeCode.d.ts

@@ -0,0 +1,6 @@
+export declare enum InsightTypeCode {
+    UNDEFINED = 0,
+    EVENTS = 1,
+    STATISTICS = 2
+}
+export declare function GetInsightTypeCodes(): Map<InsightTypeCode, string>;

package/dist/types/lib/enums/IntegrationTriggerCode.d.ts

@@ -0,0 +1,6 @@
+export declare enum IntegrationTriggerCode {
+    UNDEFINED = 0,
+    EVENT = 1,
+    ACTION = 2
+}
+export declare function GetIntegrationTriggerCodes(): Map<IntegrationTriggerCode, string>;

package/dist/types/lib/enums/IntegrationTypeCode.d.ts

@@ -0,0 +1,8 @@
+export declare enum IntegrationTypeCode {
+    UNDEFINED = 0,
+    HTTP = 1,
+    SMTP = 2,
+    EMAIL = 3,
+    SMS = 4
+}
+export declare function GetIntegrationTypeCodes(): Map<IntegrationTypeCode, string>;

package/dist/types/lib/enums/MemberRoleCode.d.ts

@@ -0,0 +1,8 @@
+export declare enum MemberRoleCode {
+    UNDEFINED = 0,
+    ADMIN = 1,
+    SUPERVISOR = 2,
+    OPERATOR = 3,
+    VIEWER = 4
+}
+export declare function GetMemberRoleCodes(): Map<MemberRoleCode, string>;

package/dist/types/lib/enums/NetworkMapTypeCode.d.ts

@@ -0,0 +1,7 @@
+export declare enum NetworkMapTypeCode {
+    UNDEFINED = 0,
+    TOP_DEVICES = 1,
+    TOP_MALICIOUS_IPS = 2,
+    NETWORK = 3
+}
+export declare function GetNetworkMapTypeCodes(): Map<NetworkMapTypeCode, string>;

package/dist/types/lib/enums/OperatorCode.d.ts

@@ -0,0 +1,15 @@
+export declare enum OperatorCode {
+    UNDEFINED = 0,
+    EQ = 1,
+    NEQ = 2,
+    GT = 3,
+    GTE = 4,
+    LT = 5,
+    LTE = 6,
+    IN = 7,
+    NOTIN = 8,
+    RANGE = 9,
+    LIKE = 10,
+    CONTAINS = 11
+}
+export declare function GetOperatorCodes(): Map<OperatorCode, string>;

package/dist/types/lib/enums/PermissionCode.d.ts

@@ -0,0 +1,9 @@
+export declare enum PermissionCode {
+    UNDEFINED = 0,
+    READ = 1,
+    CREATE = 2,
+    UPDATE = 4,
+    DELETE = 8,
+    ACTION = 16
+}
+export declare function GetPermissionCodes(): Map<PermissionCode, string>;

package/dist/types/lib/enums/ReportTypeCode.d.ts

@@ -0,0 +1,7 @@
+export declare enum ReportTypeCode {
+    UNDEFINED = 0,
+    COMPLIANCE = 1,
+    DEVICES = 2,
+    EVENTS = 3
+}
+export declare function GetReportTypeCodes(): Map<ReportTypeCode, string>;

package/dist/types/lib/enums/RuleActivityStatusCode.d.ts

@@ -0,0 +1,5 @@
+export declare enum RuleActivityStatusCode {
+    ACTIVE = 0,
+    INACTIVE = 1
+}
+export declare function GetRuleActivityStatusCodes(): Map<RuleActivityStatusCode, string>;

package/dist/types/lib/enums/RuleTypeCode.d.ts

@@ -0,0 +1,7 @@
+export declare enum RuleTypeCode {
+    UNDEFINED = 0,
+    SUSPICIOUS_IP = 1,
+    STATIC = 2,
+    ANOMALY = 3
+}
+export declare function GetRuleTypeCodes(): Map<RuleTypeCode, string>;

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

@@ -0,0 +1,8 @@
+export declare enum SeverityTypeCode {
+    UNDEFINED = 0,
+    LOW = 1,
+    MEDIUM = 2,
+    HIGH = 3,
+    CRITICAL = 4
+}
+export declare function GetSeverityTypeCodes(): Map<SeverityTypeCode, string>;

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

@@ -0,0 +1,7 @@
+export declare enum TrafficDirectionCode {
+    UNDEFINED = 0,
+    INBOUND = 1,
+    OUTBOUND = 2,
+    INOUT = 3
+}
+export declare function GetTrafficDirectionCodes(): Map<TrafficDirectionCode, string>;

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

@@ -0,0 +1,8 @@
+export declare enum UserStatusCode {
+    UNDEFINED = 0,
+    PENDING = 1,
+    ACTIVE = 2,
+    BLOCKED = 3,
+    SUSPENDED = 4
+}
+export declare function GetUserStatusCodes(): Map<UserStatusCode, string>;

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

@@ -0,0 +1,8 @@
+export declare enum UserTypeCode {
+    UNDEFINED = 0,
+    SYSADMIN = 1,
+    SUPPORT = 2,
+    USER = 3,
+    SERVICE = 4
+}
+export declare function GetUserTypeCodes(): Map<UserTypeCode, string>;

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

@@ -0,0 +1,30 @@
+export * from './AccountStatusCode';
+export * from './AccountTypeCode';
+export * from './DataSourceCode';
+export * from './DeviceActionCode';
+export * from './DeviceCreationCode';
+export * from './DeviceIdentityCode';
+export * from './DeviceStatusCode';
+export * from './DeviceTypeCode';
+export * from './DirectionContextCode';
+export * from './EventCategoryCode';
+export * from './EventStatusCode';
+export * from './EventTypeCode';
+export * from './FeatureCode';
+export * from './HomePageViewCode';
+export * from './HttpMethodCode';
+export * from './InsightStatusCode';
+export * from './InsightTypeCode';
+export * from './IntegrationTriggerCode';
+export * from './IntegrationTypeCode';
+export * from './MemberRoleCode';
+export * from './NetworkMapTypeCode';
+export * from './OperatorCode';
+export * from './PermissionCode';
+export * from './ReportTypeCode';
+export * from './RuleActivityStatusCode';
+export * from './RuleTypeCode';
+export * from './SeverityTypeCode';
+export * from './TrafficDirectionCode';
+export * from './UserStatusCode';
+export * from './UserTypeCode';

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

@@ -0,0 +1,5 @@
+export * from './base';
+export * from './common';
+export * from './entities';
+export * from './enums';
+export * from './services';

package/dist/types/lib/pulse-client.d.ts

@@ -0,0 +1,55 @@
+import { UsrAlertsService } from "./services";
+import { UsrDevicesService } from "./services";
+import { UsrEventsService } from "./services";
+import { UsrNetworkService } from "./services";
+import { UsrReportsService } from "./services";
+import { UsrRulesService } from "./services";
+import { SupportStreamAnalyticsConfig } from "./services";
+import { SysAccountsService } from "./services";
+import { SysAuditLogService } from "./services";
+import { SysCheckpointsService } from "./services";
+import { SysConfigService } from "./services";
+import { SysFeaturesService } from "./services";
+import { SysGroupsService } from "./services";
+import { SysInsightsService } from "./services";
+import { SysKeysService } from "./services";
+import { SysMembersService } from "./services";
+import { SysRuleTemplatesService } from "./services";
+import { SysRulesService } from "./services";
+import { SysStatisticsService } from "./services";
+import { SysStreamsService } from "./services";
+import { SysUsersService } from "./services";
+import { UsrInsightsService } from "./services";
+import { UsrIntegrationsService } from "./services";
+import { UsrMembersService } from "./services";
+import { UsrUserService } from "./services";
+export declare class PulseClient {
+    private restSvc;
+    private axiosInst;
+    constructor(apiUrl: string, apiKey?: string, accessToken?: string);
+    readonly UsrAlertsService: UsrAlertsService;
+    readonly UsrDevicesService: UsrDevicesService;
+    readonly UsrEventsService: UsrEventsService;
+    readonly UsrNetworkService: UsrNetworkService;
+    readonly UsrReportsService: UsrReportsService;
+    readonly UsrRulesService: UsrRulesService;
+    readonly SupportStreamAnalyticsConfig: SupportStreamAnalyticsConfig;
+    readonly SysAccountsService: SysAccountsService;
+    readonly SysAuditLogService: SysAuditLogService;
+    readonly SysCheckpointsService: SysCheckpointsService;
+    readonly SysConfigService: SysConfigService;
+    readonly SysFeaturesService: SysFeaturesService;
+    readonly SysGroupsService: SysGroupsService;
+    readonly SysInsightsService: SysInsightsService;
+    readonly SysKeysService: SysKeysService;
+    readonly SysMembersService: SysMembersService;
+    readonly SysRuleTemplatesService: SysRuleTemplatesService;
+    readonly SysRulesService: SysRulesService;
+    readonly SysStatisticsService: SysStatisticsService;
+    readonly SysStreamsService: SysStreamsService;
+    readonly SysUsersService: SysUsersService;
+    readonly UsrInsightsService: UsrInsightsService;
+    readonly UsrIntegrationsService: UsrIntegrationsService;
+    readonly UsrMembersService: UsrMembersService;
+    readonly UsrUserService: UsrUserService;
+}

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

@@ -0,0 +1,26 @@
+export * from './services.export';
+export * from './supportStreamAnalyticsConfig';
+export * from './sysAccountsService';
+export * from './sysAuditLogService';
+export * from './sysCheckpointsService';
+export * from './sysConfigService';
+export * from './sysFeaturesService';
+export * from './sysGroupsService';
+export * from './sysInsightsService';
+export * from './sysKeysService';
+export * from './sysMembersService';
+export * from './sysRuleTemplatesService';
+export * from './sysRulesService';
+export * from './sysStatisticsService';
+export * from './sysStreamsService';
+export * from './sysUsersService';
+export * from './usrAlertsService';
+export * from './usrDevicesService';
+export * from './usrEventsService';
+export * from './usrInsightsService';
+export * from './usrIntegrationsService';
+export * from './usrMembersService';
+export * from './usrNetworkService';
+export * from './usrReportsService';
+export * from './usrRulesService';
+export * from './usrUserService';