@shieldiot/pulse-lib 1.0.1

package/src/lib/entities/Integration.js

@@ -0,0 +1,47 @@
+import { BaseEntity } from '../entities';
+// Integration specifications
+export class Integration extends BaseEntity {
+    // Account Id 
+    accountId;
+    // Stream Id (leave empty to apply integration on all streams) 
+    streamId;
+    // Integration type (HTTP | SMTP | EMAIL ...) 
+    type;
+    // Integration trigger (EVENT | ACTION ...) 
+    trigger;
+    // Integration name 
+    name;
+    // Is integration enabled 
+    enabled;
+    // Host name or ip address (applicable for all protocols) 
+    host;
+    // Port number (applicable for all protocols) 
+    port;
+    // User (applicable for all protocols) 
+    user;
+    // Password (applicable for all protocols) 
+    password;
+    // HTTP protocol URL path (applicable for http/https protocols) 
+    url;
+    // HTTP protocol method: GET | POST | PUT | PATCH | DELETE (applicable for http/https protocols) 
+    method;
+    // HTTP protocol Headers (applicable for http/https protocols) 
+    headers;
+    // Message content mime type 
+    mimeType;
+    // SMTP/EMAIL protocol List of recipients 
+    recipients;
+    // SMTP/EMAIL protocol Message subject template 
+    subject;
+    // Message body template 
+    body;
+    // SMTP/EMAIL sender (will be: system@pulseiot.io if it is empty) 
+    from;
+    // Activate integration only if the event object type code is in the list (empty list means no filter) 
+    eventTypes;
+    // Activate integration only if the event severity matching this value 
+    eventSeverity;
+    // Activate integration only for specific action (applicable for Trigger = ACTION) 
+    preventiveAction;
+}
+//# sourceMappingURL=Integration.js.map

package/src/lib/entities/Integration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Integration.js","sourceRoot":"","sources":["Integration.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AASzC,6BAA6B;AAC7B,MAAM,OAAO,WAAY,SAAQ,UAAU;IAEvC,cAAc;IACP,SAAS,CAAS;IAEzB,+DAA+D;IACxD,QAAQ,CAAS;IAExB,8CAA8C;IACvC,IAAI,CAAsB;IAEjC,4CAA4C;IACrC,OAAO,CAAyB;IAEvC,oBAAoB;IACb,IAAI,CAAS;IAEpB,0BAA0B;IACnB,OAAO,CAAU;IAExB,0DAA0D;IACnD,IAAI,CAAS;IAEpB,8CAA8C;IACvC,IAAI,CAAS;IAEpB,uCAAuC;IAChC,IAAI,CAAS;IAEpB,2CAA2C;IACpC,QAAQ,CAAS;IAExB,gEAAgE;IACzD,GAAG,CAAS;IAEnB,iGAAiG;IAC1F,MAAM,CAAiB;IAE9B,+DAA+D;IACxD,OAAO,CAAmB;IAEjC,6BAA6B;IACtB,QAAQ,CAAS;IAExB,0CAA0C;IACnC,UAAU,CAAW;IAE5B,gDAAgD;IACzC,OAAO,CAAS;IAEvB,yBAAyB;IAClB,IAAI,CAAS;IAEpB,kEAAkE;IAC3D,IAAI,CAAS;IAEpB,uGAAuG;IAChG,UAAU,CAAkB;IAEnC,uEAAuE;IAChE,aAAa,CAAmB;IAEvC,mFAAmF;IAC5E,gBAAgB,CAAmB;CAG7C"}

package/src/lib/entities/Integration.ts

@@ -0,0 +1,81 @@
+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';
+
+
+
+// Integration specifications
+export class Integration extends BaseEntity {
+ 
+    // Account Id 
+    public accountId: string;
+ 
+    // Stream Id (leave empty to apply integration on all streams) 
+    public streamId: string;
+ 
+    // Integration type (HTTP | SMTP | EMAIL ...) 
+    public type: IntegrationTypeCode;
+ 
+    // Integration trigger (EVENT | ACTION ...) 
+    public trigger: IntegrationTriggerCode;
+ 
+    // Integration name 
+    public name: string;
+ 
+    // Is integration enabled 
+    public enabled: boolean;
+ 
+    // Host name or ip address (applicable for all protocols) 
+    public host: string;
+ 
+    // Port number (applicable for all protocols) 
+    public port: number;
+ 
+    // User (applicable for all protocols) 
+    public user: string;
+ 
+    // Password (applicable for all protocols) 
+    public password: string;
+ 
+    // HTTP protocol URL path (applicable for http/https protocols) 
+    public url: string;
+ 
+    // HTTP protocol method: GET | POST | PUT | PATCH | DELETE (applicable for http/https protocols) 
+    public method: HttpMethodCode;
+ 
+    // HTTP protocol Headers (applicable for http/https protocols) 
+    public headers: StringKeyValue[];
+ 
+    // Message content mime type 
+    public mimeType: string;
+ 
+    // SMTP/EMAIL protocol List of recipients 
+    public recipients: string[];
+ 
+    // SMTP/EMAIL protocol Message subject template 
+    public subject: string;
+ 
+    // Message body template 
+    public body: string;
+ 
+    // SMTP/EMAIL sender (will be: system@pulseiot.io if it is empty) 
+    public from: string;
+ 
+    // Activate integration only if the event object type code is in the list (empty list means no filter) 
+    public eventTypes: EventTypeCode[];
+ 
+    // Activate integration only if the event severity matching this value 
+    public eventSeverity: SeverityTypeCode;
+ 
+    // Activate integration only for specific action (applicable for Trigger = ACTION) 
+    public preventiveAction: DeviceActionCode;
+ 
+ 
+}
+
+

package/src/lib/entities/Member.d.ts

@@ -0,0 +1,8 @@
+import { MemberRoleCode } from '../enums';
+import { BaseEntity } from '../entities';
+export declare class Member extends BaseEntity {
+    userId: string;
+    accountId: string;
+    role: MemberRoleCode;
+}
+//# sourceMappingURL=Member.d.ts.map

package/src/lib/entities/Member.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Member.d.ts","sourceRoot":"","sources":["Member.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,qBAAa,MAAO,SAAQ,UAAU;IAG3B,MAAM,EAAE,MAAM,CAAC;IAGf,SAAS,EAAE,MAAM,CAAC;IAGlB,IAAI,EAAE,cAAc,CAAC;CAG/B"}

package/src/lib/entities/Member.js

@@ -0,0 +1,12 @@
+import { BaseEntity } from '../entities';
+// Member represents a user in the account and the role he has in this account
+// User may have several memberships for several accounts, each with a different role
+export class Member extends BaseEntity {
+    // User Id 
+    userId;
+    // Account Id 
+    accountId;
+    // Member role in the account 
+    role;
+}
+//# sourceMappingURL=Member.js.map

package/src/lib/entities/Member.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Member.js","sourceRoot":"","sources":["Member.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,8EAA8E;AAC9E,qFAAqF;AACrF,MAAM,OAAO,MAAO,SAAQ,UAAU;IAElC,WAAW;IACJ,MAAM,CAAS;IAEtB,cAAc;IACP,SAAS,CAAS;IAEzB,8BAA8B;IACvB,IAAI,CAAiB;CAG/B"}

package/src/lib/entities/Member.ts

@@ -0,0 +1,22 @@
+import { MemberRoleCode } from '../enums';
+import { BaseEntity } from '../entities';
+
+
+
+// Member represents a user in the account and the role he has in this account
+// User may have several memberships for several accounts, each with a different role
+export class Member extends BaseEntity {
+ 
+    // User Id 
+    public userId: string;
+ 
+    // Account Id 
+    public accountId: string;
+ 
+    // Member role in the account 
+    public role: MemberRoleCode;
+ 
+ 
+}
+
+

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

@@ -0,0 +1,16 @@
+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[];
+}
+//# sourceMappingURL=Radius.d.ts.map

package/src/lib/entities/Radius.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Radius.d.ts","sourceRoot":"","sources":["Radius.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKzC,qBAAa,MAAO,SAAQ,UAAU;IAG3B,MAAM,EAAE,MAAM,CAAC;IAGf,SAAS,EAAE,MAAM,CAAC;IAGlB,QAAQ,EAAE,MAAM,CAAC;IAGjB,UAAU,EAAE,MAAM,CAAC;IAGnB,GAAG,EAAE,MAAM,CAAC;IAGZ,EAAE,EAAE,MAAM,CAAC;IAGX,GAAG,EAAE,MAAM,CAAC;IAGZ,GAAG,EAAE,MAAM,CAAC;IAGZ,OAAO,EAAE,MAAM,CAAC;IAGhB,QAAQ,EAAE,MAAM,CAAC;IAGjB,UAAU,EAAE,cAAc,EAAE,CAAC;CAGvC"}

package/src/lib/entities/Radius.js

@@ -0,0 +1,27 @@
+import { BaseEntity } from '../entities';
+// Radius entity is an IP allocation to device IMSI entry
+export class Radius extends BaseEntity {
+    // Indication to the source location of the record 
+    source;
+    // Account Id 
+    accountId;
+    // Stream Id 
+    streamId;
+    // When the IP was assigned to the subscriber [Epoch milliseconds Timestamp] 
+    assignedOn;
+    // Device MAC address 
+    mac;
+    // Device IP address (IPv4 or IPv6) 
+    ip;
+    // Device mobile subscriber id (IMSI or SUPI for 5G) 
+    sid;
+    // Device mobile equipment id (IMEI or PEI for 5G) 
+    eid;
+    // Country name 
+    country;
+    // Mobile network operator name 
+    operator;
+    // Custom attributes (key-value pairs) 
+    attributes;
+}
+//# sourceMappingURL=Radius.js.map

package/src/lib/entities/Radius.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Radius.js","sourceRoot":"","sources":["Radius.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,yDAAyD;AACzD,MAAM,OAAO,MAAO,SAAQ,UAAU;IAElC,mDAAmD;IAC5C,MAAM,CAAS;IAEtB,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,6EAA6E;IACtE,UAAU,CAAS;IAE1B,sBAAsB;IACf,GAAG,CAAS;IAEnB,oCAAoC;IAC7B,EAAE,CAAS;IAElB,qDAAqD;IAC9C,GAAG,CAAS;IAEnB,mDAAmD;IAC5C,GAAG,CAAS;IAEnB,gBAAgB;IACT,OAAO,CAAS;IAEvB,gCAAgC;IACzB,QAAQ,CAAS;IAExB,uCAAuC;IAChC,UAAU,CAAmB;CAGvC"}

package/src/lib/entities/Radius.ts

@@ -0,0 +1,45 @@
+import { StringKeyValue } from '../common';
+import { BaseEntity } from '../entities';
+
+
+
+// Radius entity is an IP allocation to device IMSI entry
+export class Radius extends BaseEntity {
+ 
+    // Indication to the source location of the record 
+    public source: string;
+ 
+    // Account Id 
+    public accountId: string;
+ 
+    // Stream Id 
+    public streamId: string;
+ 
+    // When the IP was assigned to the subscriber [Epoch milliseconds Timestamp] 
+    public assignedOn: number;
+ 
+    // Device MAC address 
+    public mac: string;
+ 
+    // Device IP address (IPv4 or IPv6) 
+    public ip: string;
+ 
+    // Device mobile subscriber id (IMSI or SUPI for 5G) 
+    public sid: string;
+ 
+    // Device mobile equipment id (IMEI or PEI for 5G) 
+    public eid: string;
+ 
+    // Country name 
+    public country: string;
+ 
+    // Mobile network operator name 
+    public operator: string;
+ 
+    // Custom attributes (key-value pairs) 
+    public attributes: StringKeyValue[];
+ 
+ 
+}
+
+

package/src/lib/entities/Report.d.ts

@@ -0,0 +1,14 @@
+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;
+}
+//# sourceMappingURL=Report.d.ts.map

package/src/lib/entities/Report.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Report.d.ts","sourceRoot":"","sources":["Report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKzC,qBAAa,MAAO,SAAQ,UAAU;IAG3B,SAAS,EAAE,MAAM,CAAC;IAGlB,MAAM,EAAE,MAAM,CAAC;IAGf,IAAI,EAAE,MAAM,CAAC;IAGb,IAAI,EAAE,MAAM,CAAC;IAGb,UAAU,EAAE,MAAM,EAAE,CAAC;IAGrB,OAAO,EAAE,MAAM,CAAC;IAGhB,UAAU,EAAE,cAAc,CAAC;IAG3B,SAAS,EAAE,SAAS,CAAC;CAG/B"}

package/src/lib/entities/Report.js

@@ -0,0 +1,21 @@
+import { BaseEntity } from '../entities';
+// Report entity represents a system generated and scheduled report data
+export class Report extends BaseEntity {
+    // Account Id 
+    accountId;
+    // User who owns the report 
+    userId;
+    // Report name 
+    name;
+    // Report scheduler in Crontab format (6 space-separated fields: sec, min, hour, day, month, dayOfWeek) see syntax (https://en.wikipedia.org/wiki/Cron) Empty string means no scheduling 
+    cron;
+    // Email recipients list 
+    recipients;
+    // Email subject 
+    subject;
+    // Report type (COMPLIANCE | DEVICES | EVENTS ...) 
+    reportType;
+    // Absolute or relative time (epoch time milliseconds) to define start time and end time 
+    timeFrame;
+}
+//# sourceMappingURL=Report.js.map

package/src/lib/entities/Report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Report.js","sourceRoot":"","sources":["Report.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,wEAAwE;AACxE,MAAM,OAAO,MAAO,SAAQ,UAAU;IAElC,cAAc;IACP,SAAS,CAAS;IAEzB,4BAA4B;IACrB,MAAM,CAAS;IAEtB,eAAe;IACR,IAAI,CAAS;IAEpB,yLAAyL;IAClL,IAAI,CAAS;IAEpB,yBAAyB;IAClB,UAAU,CAAW;IAE5B,iBAAiB;IACV,OAAO,CAAS;IAEvB,mDAAmD;IAC5C,UAAU,CAAiB;IAElC,yFAAyF;IAClF,SAAS,CAAY;CAG/B"}

package/src/lib/entities/Report.ts

@@ -0,0 +1,37 @@
+import { ReportTypeCode } from '../enums';
+import { TimeFrame } from '../common';
+import { BaseEntity } from '../entities';
+
+
+
+// Report entity represents a system generated and scheduled report data
+export class Report extends BaseEntity {
+ 
+    // Account Id 
+    public accountId: string;
+ 
+    // User who owns the report 
+    public userId: string;
+ 
+    // Report name 
+    public name: string;
+ 
+    // Report scheduler in Crontab format (6 space-separated fields: sec, min, hour, day, month, dayOfWeek) see syntax (https://en.wikipedia.org/wiki/Cron) Empty string means no scheduling 
+    public cron: string;
+ 
+    // Email recipients list 
+    public recipients: string[];
+ 
+    // Email subject 
+    public subject: string;
+ 
+    // Report type (COMPLIANCE | DEVICES | EVENTS ...) 
+    public reportType: ReportTypeCode;
+ 
+    // Absolute or relative time (epoch time milliseconds) to define start time and end time 
+    public timeFrame: TimeFrame;
+ 
+ 
+}
+
+

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

@@ -0,0 +1,26 @@
+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;
+}
+//# sourceMappingURL=Rule.d.ts.map

package/src/lib/entities/Rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rule.d.ts","sourceRoot":"","sources":["Rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAKzC,qBAAa,IAAK,SAAQ,UAAU;IAGzB,SAAS,EAAE,MAAM,CAAC;IAGlB,QAAQ,EAAE,MAAM,CAAC;IAGjB,IAAI,EAAE,MAAM,CAAC;IAGb,IAAI,EAAE,YAAY,CAAC;IAGnB,WAAW,EAAE,MAAM,CAAC;IAGpB,YAAY,EAAE,OAAO,CAAC;IAGtB,YAAY,EAAE,OAAO,CAAC;IAGtB,OAAO,EAAE,cAAc,CAAC;IAGxB,QAAQ,EAAE,SAAS,EAAE,CAAC;IAGtB,QAAQ,EAAE,SAAS,EAAE,CAAC;IAGtB,UAAU,EAAE,MAAM,EAAE,CAAC;IAGrB,WAAW,EAAE,MAAM,EAAE,CAAC;IAGtB,YAAY,EAAE,cAAc,EAAE,CAAC;IAG/B,aAAa,EAAE,MAAM,CAAC;IAGtB,YAAY,EAAE,aAAa,CAAC;IAG5B,gBAAgB,EAAE,gBAAgB,CAAC;CAG7C"}

package/src/lib/entities/Rule.js

@@ -0,0 +1,37 @@
+import { BaseEntity } from '../entities';
+// Deterministic Rule definition
+export class Rule extends BaseEntity {
+    // Account Id 
+    accountId;
+    // Stream Id 
+    streamId;
+    // Rule name 
+    name;
+    // Rule type 
+    type;
+    // Rule description 
+    description;
+    // Flag to indicate if this is a system rule (read-only) or user-defined rule 
+    isSystemRule;
+    // Flag to indicate if this rule is active (true) or suspended (false), only active rules are evaluated 
+    isActiveRule;
+    // Rule context - what is the data source to evaluate the rule on 
+    context;
+    // List of AND conditions, all of them must be true for the rule to trigger event 
+    matchAll;
+    // List of OR conditions, at least one of them must be true for the rule to trigger event} 
+    matchAny;
+    // Exclude devices with ID included in this list 
+    excludeIDs;
+    // Exclude devices with type included in this list 
+    excludeTags;
+    // Exclude devices with this type 
+    excludeTypes;
+    // The time duration (in seconds) for consecutive aggregations 
+    timeWindowSec;
+    // Set the event type on events generated by this rule 
+    setEventType;
+    // Set the event severity on events generated by this rule 
+    setEventSeverity;
+}
+//# sourceMappingURL=Rule.js.map

package/src/lib/entities/Rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rule.js","sourceRoot":"","sources":["Rule.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AASzC,gCAAgC;AAChC,MAAM,OAAO,IAAK,SAAQ,UAAU;IAEhC,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,aAAa;IACN,IAAI,CAAS;IAEpB,aAAa;IACN,IAAI,CAAe;IAE1B,oBAAoB;IACb,WAAW,CAAS;IAE3B,8EAA8E;IACvE,YAAY,CAAU;IAE7B,wGAAwG;IACjG,YAAY,CAAU;IAE7B,kEAAkE;IAC3D,OAAO,CAAiB;IAE/B,kFAAkF;IAC3E,QAAQ,CAAc;IAE7B,2FAA2F;IACpF,QAAQ,CAAc;IAE7B,iDAAiD;IAC1C,UAAU,CAAW;IAE5B,mDAAmD;IAC5C,WAAW,CAAW;IAE7B,kCAAkC;IAC3B,YAAY,CAAmB;IAEtC,+DAA+D;IACxD,aAAa,CAAS;IAE7B,uDAAuD;IAChD,YAAY,CAAgB;IAEnC,2DAA2D;IACpD,gBAAgB,CAAmB;CAG7C"}

package/src/lib/entities/Rule.ts

@@ -0,0 +1,65 @@
+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';
+
+
+
+// Deterministic Rule definition
+export class Rule extends BaseEntity {
+ 
+    // Account Id 
+    public accountId: string;
+ 
+    // Stream Id 
+    public streamId: string;
+ 
+    // Rule name 
+    public name: string;
+ 
+    // Rule type 
+    public type: RuleTypeCode;
+ 
+    // Rule description 
+    public description: string;
+ 
+    // Flag to indicate if this is a system rule (read-only) or user-defined rule 
+    public isSystemRule: boolean;
+ 
+    // Flag to indicate if this rule is active (true) or suspended (false), only active rules are evaluated 
+    public isActiveRule: boolean;
+ 
+    // Rule context - what is the data source to evaluate the rule on 
+    public context: DataSourceCode;
+ 
+    // List of AND conditions, all of them must be true for the rule to trigger event 
+    public matchAll: Condition[];
+ 
+    // List of OR conditions, at least one of them must be true for the rule to trigger event} 
+    public matchAny: Condition[];
+ 
+    // Exclude devices with ID included in this list 
+    public excludeIDs: string[];
+ 
+    // Exclude devices with type included in this list 
+    public excludeTags: string[];
+ 
+    // Exclude devices with this type 
+    public excludeTypes: DeviceTypeCode[];
+ 
+    // The time duration (in seconds) for consecutive aggregations 
+    public timeWindowSec: number;
+ 
+    // Set the event type on events generated by this rule 
+    public setEventType: EventTypeCode;
+ 
+    // Set the event severity on events generated by this rule 
+    public setEventSeverity: SeverityTypeCode;
+ 
+ 
+}
+
+

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

@@ -0,0 +1,15 @@
+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;
+}
+//# sourceMappingURL=RuleTemplate.d.ts.map

package/src/lib/entities/RuleTemplate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RuleTemplate.d.ts","sourceRoot":"","sources":["RuleTemplate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAKzC,qBAAa,YAAa,SAAQ,UAAU;IAGjC,IAAI,EAAE,MAAM,CAAC;IAGb,WAAW,EAAE,MAAM,CAAC;IAGpB,OAAO,EAAE,cAAc,CAAC;IAGxB,QAAQ,EAAE,MAAM,EAAE,CAAC;IAGnB,QAAQ,EAAE,MAAM,EAAE,CAAC;IAGnB,aAAa,EAAE,MAAM,CAAC;IAGtB,YAAY,EAAE,aAAa,CAAC;IAG5B,gBAAgB,EAAE,gBAAgB,CAAC;CAG7C"}

package/src/lib/entities/RuleTemplate.js

@@ -0,0 +1,21 @@
+import { BaseEntity } from '../entities';
+// RuleTemplate entity is used to define rules quickly based on pre-defined templates
+export class RuleTemplate extends BaseEntity {
+    // Rule template name 
+    name;
+    // Rule template description 
+    description;
+    // Rule context - what is the data source to evaluate the rule on 
+    context;
+    // List of AND conditions, all of them must be true for the rule to trigger event 
+    matchAll;
+    // List of OR conditions, at least one of them must be true for the rule to trigger event 
+    matchAny;
+    // The time duration (in seconds) for consecutive aggregations 
+    timeWindowSec;
+    // Set the event type on events generated by this rule 
+    setEventType;
+    // Set the event severity on events generated by this rule 
+    setEventSeverity;
+}
+//# sourceMappingURL=RuleTemplate.js.map

package/src/lib/entities/RuleTemplate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RuleTemplate.js","sourceRoot":"","sources":["RuleTemplate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,qFAAqF;AACrF,MAAM,OAAO,YAAa,SAAQ,UAAU;IAExC,sBAAsB;IACf,IAAI,CAAS;IAEpB,6BAA6B;IACtB,WAAW,CAAS;IAE3B,kEAAkE;IAC3D,OAAO,CAAiB;IAE/B,kFAAkF;IAC3E,QAAQ,CAAW;IAE1B,0FAA0F;IACnF,QAAQ,CAAW;IAE1B,+DAA+D;IACxD,aAAa,CAAS;IAE7B,uDAAuD;IAChD,YAAY,CAAgB;IAEnC,2DAA2D;IACpD,gBAAgB,CAAmB;CAG7C"}

package/src/lib/entities/RuleTemplate.ts

@@ -0,0 +1,38 @@
+import { SeverityTypeCode } from '../enums';
+import { BaseEntity } from '../entities';
+import { DataSourceCode } from '../enums';
+import { EventTypeCode } from '../enums';
+
+
+
+// RuleTemplate entity is used to define rules quickly based on pre-defined templates
+export class RuleTemplate extends BaseEntity {
+ 
+    // Rule template name 
+    public name: string;
+ 
+    // Rule template description 
+    public description: string;
+ 
+    // Rule context - what is the data source to evaluate the rule on 
+    public context: DataSourceCode;
+ 
+    // List of AND conditions, all of them must be true for the rule to trigger event 
+    public matchAll: string[];
+ 
+    // List of OR conditions, at least one of them must be true for the rule to trigger event 
+    public matchAny: string[];
+ 
+    // The time duration (in seconds) for consecutive aggregations 
+    public timeWindowSec: number;
+ 
+    // Set the event type on events generated by this rule 
+    public setEventType: EventTypeCode;
+ 
+    // Set the event severity on events generated by this rule 
+    public setEventSeverity: SeverityTypeCode;
+ 
+ 
+}
+
+

package/src/lib/entities/SIM.d.ts

@@ -0,0 +1,9 @@
+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);
+}
+//# sourceMappingURL=SIM.d.ts.map

package/src/lib/entities/SIM.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SIM.d.ts","sourceRoot":"","sources":["SIM.ts"],"names":[],"mappings":"AAIA,qBAAa,GAAG;IAGL,EAAE,EAAE,MAAM,CAAC;IAGX,EAAE,EAAE,MAAM,CAAC;IAGX,KAAK,EAAE,MAAM,CAAC;IAGd,IAAI,EAAE,MAAM,CAAC;IAGb,MAAM,EAAE,MAAM,CAAC;gBAET,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAQxF"}

package/src/lib/entities/SIM.js

@@ -0,0 +1,31 @@
+// SIM entity represents a physical SIM (Subscriber Identity Module) card used in an IoT device to access the internet via a cellular provider
+export class SIM {
+    // Unique SIM Identity (ICCID or IMSI or MSISDN or IP in this order) 
+    id;
+    // The IP allocation of the SIM 
+    ip;
+    // The unique serial number, integrated circuit card identification 
+    iccid;
+    // The international mobile subscriber identity number 
+    imsi;
+    // Mobile Subscriber ISDN Number (the actual phone number with the country prefix) 
+    msisdn;
+    constructor(id, iP, iCCID, iMSI, mSISDN) {
+        if (id !== undefined) {
+            this.id = id;
+        }
+        if (iP !== undefined) {
+            this.ip = iP;
+        }
+        if (iCCID !== undefined) {
+            this.iccid = iCCID;
+        }
+        if (iMSI !== undefined) {
+            this.imsi = iMSI;
+        }
+        if (mSISDN !== undefined) {
+            this.msisdn = mSISDN;
+        }
+    }
+}
+//# sourceMappingURL=SIM.js.map

package/src/lib/entities/SIM.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SIM.js","sourceRoot":"","sources":["SIM.ts"],"names":[],"mappings":"AAGA,8IAA8I;AAC9I,MAAM,OAAO,GAAG;IAEZ,qEAAqE;IAC9D,EAAE,CAAS;IAElB,gCAAgC;IACzB,EAAE,CAAS;IAElB,oEAAoE;IAC7D,KAAK,CAAS;IAErB,uDAAuD;IAChD,IAAI,CAAS;IAEpB,mFAAmF;IAC5E,MAAM,CAAS;IAErB,YAAY,EAAW,EAAE,EAAW,EAAE,KAAc,EAAE,IAAa,EAAE,MAAe;QACjF,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QAAC,CAAC;QACvC,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QAAC,CAAC;QACvC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAAC,CAAC;QAChD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAAC,CAAC;QAC7C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAAC,CAAC;IACvD,CAAC;CAEJ"}