@shieldiot/pulse-lib 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/dist/config.d.ts +5 -0
  2. package/dist/index.d.ts +2 -0
  3. package/dist/lib/common/AccountRole.d.ts +7 -0
  4. package/dist/lib/common/ConsumptionData.d.ts +6 -0
  5. package/dist/lib/common/ConsumptionTimeDataPoint.d.ts +6 -0
  6. package/dist/lib/common/DeviceConfig.d.ts +7 -0
  7. package/dist/lib/common/DeviceScoreConfig.d.ts +6 -0
  8. package/dist/lib/common/DevicesAtRiskConfig.d.ts +4 -0
  9. package/dist/lib/common/EventSeverityConfig.d.ts +5 -0
  10. package/dist/lib/common/FloatKeyValue.d.ts +5 -0
  11. package/dist/lib/common/GeoData.d.ts +10 -0
  12. package/dist/lib/common/GraphSeries.d.ts +6 -0
  13. package/dist/lib/common/Indicator.d.ts +8 -0
  14. package/dist/lib/common/IntKeySeriesDataValue.d.ts +6 -0
  15. package/dist/lib/common/IntKeyValue.d.ts +5 -0
  16. package/dist/lib/common/Interval.d.ts +5 -0
  17. package/dist/lib/common/Link.d.ts +11 -0
  18. package/dist/lib/common/Location.d.ts +5 -0
  19. package/dist/lib/common/LoginParams.d.ts +6 -0
  20. package/dist/lib/common/MaliciousIPCard.d.ts +12 -0
  21. package/dist/lib/common/MaliciousIPData.d.ts +7 -0
  22. package/dist/lib/common/NetworkMap.d.ts +7 -0
  23. package/dist/lib/common/Node.d.ts +15 -0
  24. package/dist/lib/common/SeriesData.d.ts +7 -0
  25. package/dist/lib/common/SessionTransform.d.ts +8 -0
  26. package/dist/lib/common/SeverityIntervalTuple.d.ts +7 -0
  27. package/dist/lib/common/ShieldexConfig.d.ts +9 -0
  28. package/dist/lib/common/StringIntValue.d.ts +5 -0
  29. package/dist/lib/common/StringKeyIntValue.d.ts +5 -0
  30. package/dist/lib/common/StringKeyValue.d.ts +5 -0
  31. package/dist/lib/common/Thresholds.d.ts +4 -0
  32. package/dist/lib/common/TimeDataPoint.d.ts +5 -0
  33. package/dist/lib/common/TimeDataPoint2D.d.ts +6 -0
  34. package/dist/lib/common/TimeDataPointFloat.d.ts +5 -0
  35. package/dist/lib/common/TimeFrame.d.ts +5 -0
  36. package/dist/lib/common/TimeSeries.d.ts +8 -0
  37. package/dist/lib/common/TimeSeriesOf2D.d.ts +8 -0
  38. package/dist/lib/common/TimeSeriesOfDataConsumption.d.ts +8 -0
  39. package/dist/lib/common/TimeSeriesOfFloat.d.ts +8 -0
  40. package/dist/lib/common/TokenData.d.ts +12 -0
  41. package/dist/lib/common/Tuple.d.ts +5 -0
  42. package/dist/lib/common/UsageTransform.d.ts +10 -0
  43. package/dist/lib/common/ZScore.d.ts +5 -0
  44. package/dist/lib/common/index.d.ts +42 -0
  45. package/dist/lib/entities/Account.d.ts +17 -0
  46. package/dist/lib/entities/AccountDTO.d.ts +19 -0
  47. package/dist/lib/entities/AccountSettings.d.ts +10 -0
  48. package/dist/lib/entities/Action.d.ts +10 -0
  49. package/dist/lib/entities/Alert.d.ts +34 -0
  50. package/dist/lib/entities/AlertWithDevice.d.ts +36 -0
  51. package/dist/lib/entities/ApiKey.d.ts +11 -0
  52. package/dist/lib/entities/AuditLog.d.ts +13 -0
  53. package/dist/lib/entities/BaseEntity.d.ts +6 -0
  54. package/dist/lib/entities/BulkDevices.d.ts +5 -0
  55. package/dist/lib/entities/Checkpoint.d.ts +23 -0
  56. package/dist/lib/entities/ComplianceReportSettings.d.ts +7 -0
  57. package/dist/lib/entities/Condition.d.ts +8 -0
  58. package/dist/lib/entities/ConfigParam.d.ts +4 -0
  59. package/dist/lib/entities/DNSRecord.d.ts +12 -0
  60. package/dist/lib/entities/DataIngestion.d.ts +18 -0
  61. package/dist/lib/entities/DataPointOfDeviceReport.d.ts +6 -0
  62. package/dist/lib/entities/Device.d.ts +30 -0
  63. package/dist/lib/entities/DeviceReport.d.ts +9 -0
  64. package/dist/lib/entities/DeviceWithEvents.d.ts +32 -0
  65. package/dist/lib/entities/Distribution.d.ts +7 -0
  66. package/dist/lib/entities/Event.d.ts +38 -0
  67. package/dist/lib/entities/EventOccurrence.d.ts +10 -0
  68. package/dist/lib/entities/EventWithDevice.d.ts +39 -0
  69. package/dist/lib/entities/Feature.d.ts +6 -0
  70. package/dist/lib/entities/FeaturesGroup.d.ts +6 -0
  71. package/dist/lib/entities/Group.d.ts +8 -0
  72. package/dist/lib/entities/Image.d.ts +5 -0
  73. package/dist/lib/entities/Insight.d.ts +18 -0
  74. package/dist/lib/entities/InsightQuery.d.ts +10 -0
  75. package/dist/lib/entities/InsightSpec.d.ts +9 -0
  76. package/dist/lib/entities/IntDistribution.d.ts +7 -0
  77. package/dist/lib/entities/Integration.d.ts +31 -0
  78. package/dist/lib/entities/Member.d.ts +7 -0
  79. package/dist/lib/entities/Radius.d.ts +15 -0
  80. package/dist/lib/entities/Report.d.ts +13 -0
  81. package/dist/lib/entities/Rule.d.ts +25 -0
  82. package/dist/lib/entities/RuleTemplate.d.ts +14 -0
  83. package/dist/lib/entities/SIM.d.ts +8 -0
  84. package/dist/lib/entities/ServiceStatus.d.ts +8 -0
  85. package/dist/lib/entities/SessionRecord.d.ts +22 -0
  86. package/dist/lib/entities/Shieldex.d.ts +7 -0
  87. package/dist/lib/entities/Stream.d.ts +11 -0
  88. package/dist/lib/entities/StreamAnalyticsConfig.d.ts +12 -0
  89. package/dist/lib/entities/StreamConfig.d.ts +19 -0
  90. package/dist/lib/entities/TeaserPopUpSettings.d.ts +6 -0
  91. package/dist/lib/entities/TimeSeriesOfDeviceReport.d.ts +8 -0
  92. package/dist/lib/entities/UsageRecord.d.ts +32 -0
  93. package/dist/lib/entities/User.d.ts +16 -0
  94. package/dist/lib/entities/UserMembership.d.ts +14 -0
  95. package/dist/lib/entities/UserMemberships.d.ts +14 -0
  96. package/dist/lib/entities/index.d.ts +52 -0
  97. package/dist/lib/enums/AccountStatusCode.d.ts +7 -0
  98. package/dist/lib/enums/AccountTypeCode.d.ts +8 -0
  99. package/dist/lib/enums/DataSourceCode.d.ts +7 -0
  100. package/dist/lib/enums/DeviceActionCode.d.ts +8 -0
  101. package/dist/lib/enums/DeviceCreationCode.d.ts +8 -0
  102. package/dist/lib/enums/DeviceIdentityCode.d.ts +11 -0
  103. package/dist/lib/enums/DeviceStatusCode.d.ts +8 -0
  104. package/dist/lib/enums/DeviceTypeCode.d.ts +18 -0
  105. package/dist/lib/enums/DirectionContextCode.d.ts +8 -0
  106. package/dist/lib/enums/EventCategoryCode.d.ts +6 -0
  107. package/dist/lib/enums/EventStatusCode.d.ts +8 -0
  108. package/dist/lib/enums/EventTypeCode.d.ts +23 -0
  109. package/dist/lib/enums/FeatureCode.d.ts +14 -0
  110. package/dist/lib/enums/HomePageViewCode.d.ts +7 -0
  111. package/dist/lib/enums/HttpMethodCode.d.ts +9 -0
  112. package/dist/lib/enums/InsightStatusCode.d.ts +7 -0
  113. package/dist/lib/enums/InsightTypeCode.d.ts +6 -0
  114. package/dist/lib/enums/IntegrationTriggerCode.d.ts +6 -0
  115. package/dist/lib/enums/IntegrationTypeCode.d.ts +8 -0
  116. package/dist/lib/enums/MemberRoleCode.d.ts +8 -0
  117. package/dist/lib/enums/NetworkMapTypeCode.d.ts +7 -0
  118. package/dist/lib/enums/OperatorCode.d.ts +15 -0
  119. package/dist/lib/enums/PermissionCode.d.ts +9 -0
  120. package/dist/lib/enums/ReportTypeCode.d.ts +7 -0
  121. package/dist/lib/enums/RuleTypeCode.d.ts +7 -0
  122. package/dist/lib/enums/SeverityTypeCode.d.ts +8 -0
  123. package/dist/lib/enums/TrafficDirectionCode.d.ts +7 -0
  124. package/dist/lib/enums/UserStatusCode.d.ts +8 -0
  125. package/dist/lib/enums/UserTypeCode.d.ts +8 -0
  126. package/dist/lib/enums/index.d.ts +30 -0
  127. package/dist/lib/index.d.ts +4 -0
  128. package/dist/lib/pulse-client.d.ts +59 -0
  129. package/dist/lib/services/index.d.ts +27 -0
  130. package/dist/lib/services/services.export.d.ts +26 -0
  131. package/dist/lib/services/supportStreamAnalyticsConfig.d.ts +29 -0
  132. package/dist/lib/services/sysAccountsService.d.ts +45 -0
  133. package/dist/lib/services/sysAuditLogService.d.ts +22 -0
  134. package/dist/lib/services/sysCheckpointsService.d.ts +22 -0
  135. package/dist/lib/services/sysConfigService.d.ts +29 -0
  136. package/dist/lib/services/sysFeaturesService.d.ts +34 -0
  137. package/dist/lib/services/sysGroupsService.d.ts +42 -0
  138. package/dist/lib/services/sysInsightsService.d.ts +54 -0
  139. package/dist/lib/services/sysKeysService.d.ts +34 -0
  140. package/dist/lib/services/sysMembersService.d.ts +30 -0
  141. package/dist/lib/services/sysRuleTemplatesService.d.ts +29 -0
  142. package/dist/lib/services/sysRulesService.d.ts +34 -0
  143. package/dist/lib/services/sysStatisticsService.d.ts +25 -0
  144. package/dist/lib/services/sysStreamsService.d.ts +29 -0
  145. package/dist/lib/services/sysUsersService.d.ts +44 -0
  146. package/dist/lib/services/usrAlertsService.d.ts +110 -0
  147. package/dist/lib/services/usrDevicesService.d.ts +109 -0
  148. package/dist/lib/services/usrEventsService.d.ts +93 -0
  149. package/dist/lib/services/usrInsightsService.d.ts +13 -0
  150. package/dist/lib/services/usrIntegrationsService.d.ts +37 -0
  151. package/dist/lib/services/usrMembersService.d.ts +34 -0
  152. package/dist/lib/services/usrNetworkService.d.ts +18 -0
  153. package/dist/lib/services/usrReportsService.d.ts +47 -0
  154. package/dist/lib/services/usrRulesService.d.ts +34 -0
  155. package/dist/lib/services/usrUserService.d.ts +65 -0
  156. package/dist/public-api.d.ts +3 -0
  157. package/dist/utils/ActionResponse.d.ts +5 -0
  158. package/dist/utils/BaseRestResponse.d.ts +4 -0
  159. package/dist/utils/EntitiesResponse.d.ts +8 -0
  160. package/dist/utils/EntityResponse.d.ts +8 -0
  161. package/dist/utils/index.d.ts +5 -0
  162. package/dist/utils/rest-axios-setup.d.ts +3 -0
  163. package/dist/utils/rest-util.d.ts +15 -0
  164. package/package.json +1 -1
  165. package/tsconfig.json +2 -2
@@ -0,0 +1,34 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { Feature } from '../entities';
4
+ import { FeaturesGroup } from '../entities';
5
+ export declare class SysFeaturesService {
6
+ private config;
7
+ private rest;
8
+ private baseUrl;
9
+ constructor(config: PulseConfig, rest: RestUtil);
10
+ /**
11
+ * Find list of feature
12
+ */
13
+ findFeatures(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Feature>>;
14
+ /**
15
+ * Create new features group
16
+ */
17
+ createFeaturesGroup(body?: FeaturesGroup): import("rxjs").Observable<EntityResponse<FeaturesGroup>>;
18
+ /**
19
+ * Update existing features group
20
+ */
21
+ updateFeaturesGroup(body?: FeaturesGroup): import("rxjs").Observable<EntityResponse<FeaturesGroup>>;
22
+ /**
23
+ * Delete features group from the system
24
+ */
25
+ deleteFeaturesGroup(id?: string): import("rxjs").Observable<ActionResponse>;
26
+ /**
27
+ * Get single features group by id
28
+ */
29
+ getFeaturesGroup(id?: string): import("rxjs").Observable<EntityResponse<FeaturesGroup>>;
30
+ /**
31
+ * Find list of features groups
32
+ */
33
+ findFeaturesGroups(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<FeaturesGroup>>;
34
+ }
@@ -0,0 +1,42 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { Group } from '../entities';
4
+ import { User } from '../entities';
5
+ export declare class SysGroupsService {
6
+ private config;
7
+ private rest;
8
+ private baseUrl;
9
+ constructor(config: PulseConfig, rest: RestUtil);
10
+ /**
11
+ * Create new groups
12
+ */
13
+ create(body?: Group): import("rxjs").Observable<EntityResponse<Group>>;
14
+ /**
15
+ * Update existing group in the system
16
+ */
17
+ update(body?: Group): import("rxjs").Observable<EntityResponse<Group>>;
18
+ /**
19
+ * Delete a group from the system
20
+ */
21
+ delete(id?: string): import("rxjs").Observable<ActionResponse>;
22
+ /**
23
+ * Get single group by id
24
+ */
25
+ get(id?: string): import("rxjs").Observable<EntityResponse<Group>>;
26
+ /**
27
+ * Find list of groups by query
28
+ */
29
+ find(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Group>>;
30
+ /**
31
+ * Get list of all users in the group
32
+ */
33
+ getUsers(id?: string): import("rxjs").Observable<EntityResponse<User>>;
34
+ /**
35
+ * Add user to the group
36
+ */
37
+ setDefaultAccount(id?: string, userId?: string): import("rxjs").Observable<ActionResponse>;
38
+ /**
39
+ * Remove user from the group
40
+ */
41
+ getAccessToken(id?: string, userId?: string): import("rxjs").Observable<ActionResponse>;
42
+ }
@@ -0,0 +1,54 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { InsightQuery } from '../entities';
4
+ import { InsightSpec } from '../entities';
5
+ export declare class SysInsightsService {
6
+ private config;
7
+ private rest;
8
+ private baseUrl;
9
+ constructor(config: PulseConfig, rest: RestUtil);
10
+ /**
11
+ * Create new insight query
12
+ */
13
+ createQuery(body?: InsightQuery): import("rxjs").Observable<EntityResponse<InsightQuery>>;
14
+ /**
15
+ * Update existing insight query
16
+ */
17
+ updateQuery(body?: InsightQuery): import("rxjs").Observable<EntityResponse<InsightQuery>>;
18
+ /**
19
+ * Delete insight query from the system
20
+ */
21
+ deleteQuery(id?: string): import("rxjs").Observable<ActionResponse>;
22
+ /**
23
+ * Get single insight query by id
24
+ */
25
+ getQuery(id?: string): import("rxjs").Observable<EntityResponse<InsightQuery>>;
26
+ /**
27
+ * Find list of insight queries
28
+ */
29
+ findQueries(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<InsightQuery>>;
30
+ /**
31
+ * Create new insight spec
32
+ */
33
+ createSpec(body?: InsightSpec): import("rxjs").Observable<EntityResponse<InsightSpec>>;
34
+ /**
35
+ * Update existing insight spec
36
+ */
37
+ updateSpec(body?: InsightSpec): import("rxjs").Observable<EntityResponse<InsightSpec>>;
38
+ /**
39
+ * Delete insight spec from the system
40
+ */
41
+ deleteSpec(id?: string): import("rxjs").Observable<ActionResponse>;
42
+ /**
43
+ * Get single insight spec by id
44
+ */
45
+ getSpec(id?: string): import("rxjs").Observable<EntityResponse<InsightSpec>>;
46
+ /**
47
+ * Find list of insight specs
48
+ */
49
+ findSpecs(accountId?: string, streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<InsightSpec>>;
50
+ /**
51
+ * Find list of insight specs
52
+ */
53
+ findSpecsQueries(accountId?: string, streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<InsightQuery>>;
54
+ }
@@ -0,0 +1,34 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { ApiKey } from '../entities';
4
+ import { StringIntValue } from '../common';
5
+ export declare class SysKeysService {
6
+ private config;
7
+ private rest;
8
+ private baseUrl;
9
+ constructor(config: PulseConfig, rest: RestUtil);
10
+ /**
11
+ * Create new API key
12
+ */
13
+ create(body?: ApiKey): import("rxjs").Observable<EntityResponse<ApiKey>>;
14
+ /**
15
+ * Update existing API key in the system
16
+ */
17
+ update(body?: ApiKey): import("rxjs").Observable<EntityResponse<ApiKey>>;
18
+ /**
19
+ * Delete API key from the system
20
+ */
21
+ delete(id?: string): import("rxjs").Observable<ActionResponse>;
22
+ /**
23
+ * Get single API key by id
24
+ */
25
+ get(id?: string): import("rxjs").Observable<EntityResponse<ApiKey>>;
26
+ /**
27
+ * Find list of API keys by free test search
28
+ */
29
+ find(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<ApiKey>>;
30
+ /**
31
+ * Get list of services for the ACL
32
+ */
33
+ listServices(): import("rxjs").Observable<EntitiesResponse<StringIntValue>>;
34
+ }
@@ -0,0 +1,30 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { Member } from '../entities';
4
+ import { MemberRoleCode } from '../enums';
5
+ export declare class SysMembersService {
6
+ private config;
7
+ private rest;
8
+ private baseUrl;
9
+ constructor(config: PulseConfig, rest: RestUtil);
10
+ /**
11
+ * Create new member
12
+ */
13
+ create(body?: Member): import("rxjs").Observable<EntityResponse<Member>>;
14
+ /**
15
+ * Update existing member in the system
16
+ */
17
+ update(body?: Member): import("rxjs").Observable<EntityResponse<Member>>;
18
+ /**
19
+ * Delete member from the system
20
+ */
21
+ delete(id?: string): import("rxjs").Observable<ActionResponse>;
22
+ /**
23
+ * Get single member by id
24
+ */
25
+ get(id?: string): import("rxjs").Observable<EntityResponse<Member>>;
26
+ /**
27
+ * Find list of members by query
28
+ */
29
+ find(accountId?: string, userId?: string, role?: MemberRoleCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Member>>;
30
+ }
@@ -0,0 +1,29 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { RuleTemplate } from '../entities';
4
+ export declare class SysRuleTemplatesService {
5
+ private config;
6
+ private rest;
7
+ private baseUrl;
8
+ constructor(config: PulseConfig, rest: RestUtil);
9
+ /**
10
+ * Create new rule template
11
+ */
12
+ create(body?: RuleTemplate): import("rxjs").Observable<EntityResponse<RuleTemplate>>;
13
+ /**
14
+ * Update existing rule template
15
+ */
16
+ update(body?: RuleTemplate): import("rxjs").Observable<EntityResponse<RuleTemplate>>;
17
+ /**
18
+ * Delete a rule template from the system
19
+ */
20
+ delete(id?: string): import("rxjs").Observable<ActionResponse>;
21
+ /**
22
+ * Get single rule template by id
23
+ */
24
+ get(id?: string): import("rxjs").Observable<EntityResponse<RuleTemplate>>;
25
+ /**
26
+ * Find list of rule templates by query
27
+ */
28
+ find(search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<RuleTemplate>>;
29
+ }
@@ -0,0 +1,34 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { Rule } from '../entities';
4
+ import { TimeSeriesOfFloat } from '../common';
5
+ export declare class SysRulesService {
6
+ private config;
7
+ private rest;
8
+ private baseUrl;
9
+ constructor(config: PulseConfig, rest: RestUtil);
10
+ /**
11
+ * Create new rule
12
+ */
13
+ create(body?: Rule): import("rxjs").Observable<EntityResponse<Rule>>;
14
+ /**
15
+ * Update existing rule in the system
16
+ */
17
+ update(body?: Rule): import("rxjs").Observable<EntityResponse<Rule>>;
18
+ /**
19
+ * Delete a rule from the system
20
+ */
21
+ delete(id?: string): import("rxjs").Observable<ActionResponse>;
22
+ /**
23
+ * Get single rule by id
24
+ */
25
+ get(id?: string): import("rxjs").Observable<EntityResponse<Rule>>;
26
+ /**
27
+ * Find list of rules by query
28
+ */
29
+ find(accountId?: string, streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Rule>>;
30
+ /**
31
+ * Analyze rule configuration against historic data
32
+ */
33
+ analyze(from?: number, to?: number, interval?: number, size?: number, body?: Rule): import("rxjs").Observable<EntityResponse<TimeSeriesOfFloat>>;
34
+ }
@@ -0,0 +1,25 @@
1
+ import { RestUtil, EntityResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { Distribution } from '../entities';
4
+ export declare class SysStatisticsService {
5
+ private config;
6
+ private rest;
7
+ private baseUrl;
8
+ constructor(config: PulseConfig, rest: RestUtil);
9
+ /**
10
+ * Get accounts distribution by field
11
+ */
12
+ getAccountsCount(field?: string): import("rxjs").Observable<EntityResponse<Distribution>>;
13
+ /**
14
+ * Get streams distribution by field
15
+ */
16
+ getStreamsCount(field?: string): import("rxjs").Observable<EntityResponse<Distribution>>;
17
+ /**
18
+ * Get devices distribution by field
19
+ */
20
+ getDevicesCount(field?: string): import("rxjs").Observable<EntityResponse<Distribution>>;
21
+ /**
22
+ * Get users distribution by field
23
+ */
24
+ getUsersCount(field?: string): import("rxjs").Observable<EntityResponse<Distribution>>;
25
+ }
@@ -0,0 +1,29 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { Stream } from '../entities';
4
+ export declare class SysStreamsService {
5
+ private config;
6
+ private rest;
7
+ private baseUrl;
8
+ constructor(config: PulseConfig, rest: RestUtil);
9
+ /**
10
+ * Create new stream
11
+ */
12
+ create(body?: Stream): import("rxjs").Observable<EntityResponse<Stream>>;
13
+ /**
14
+ * Update existing stream in the system
15
+ */
16
+ update(body?: Stream): import("rxjs").Observable<EntityResponse<Stream>>;
17
+ /**
18
+ * Delete a stream from the system
19
+ */
20
+ delete(id?: string): import("rxjs").Observable<ActionResponse>;
21
+ /**
22
+ * Get single stream by id
23
+ */
24
+ get(id?: string): import("rxjs").Observable<EntityResponse<Stream>>;
25
+ /**
26
+ * Find list of streams by query
27
+ */
28
+ find(accountId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Stream>>;
29
+ }
@@ -0,0 +1,44 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { User } from '../entities';
4
+ import { UserTypeCode } from '../enums';
5
+ import { UserStatusCode } from '../enums';
6
+ import { UserMemberships } from '../entities';
7
+ export declare class SysUsersService {
8
+ private config;
9
+ private rest;
10
+ private baseUrl;
11
+ constructor(config: PulseConfig, rest: RestUtil);
12
+ /**
13
+ * Create new user
14
+ */
15
+ create(body?: User): import("rxjs").Observable<EntityResponse<User>>;
16
+ /**
17
+ * Update existing user in the system
18
+ */
19
+ update(body?: User): import("rxjs").Observable<EntityResponse<User>>;
20
+ /**
21
+ * Delete a user from the system
22
+ */
23
+ delete(id?: string): import("rxjs").Observable<ActionResponse>;
24
+ /**
25
+ * Get single user by id
26
+ */
27
+ get(id?: string): import("rxjs").Observable<EntityResponse<User>>;
28
+ /**
29
+ * Find list of users by query
30
+ */
31
+ find(search?: string, type?: UserTypeCode[], status?: UserStatusCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<User>>;
32
+ /**
33
+ * Create new user with all its accounts memberships
34
+ */
35
+ createMembership(body?: UserMemberships): import("rxjs").Observable<EntityResponse<UserMemberships>>;
36
+ /**
37
+ * Update user's default account
38
+ */
39
+ setDefaultAccount(id?: string, accountId?: string): import("rxjs").Observable<ActionResponse>;
40
+ /**
41
+ * Update access token
42
+ */
43
+ getAccessToken(id?: string): import("rxjs").Observable<ActionResponse>;
44
+ }
@@ -0,0 +1,110 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { SeverityTypeCode } from '../enums';
4
+ import { RuleTypeCode } from '../enums';
5
+ import { DeviceActionCode } from '../enums';
6
+ import { EventTypeCode } from '../enums';
7
+ import { AlertWithDevice } from '../entities';
8
+ import { TimeSeriesOfFloat } from '../common';
9
+ import { StringKeyValue } from '../common';
10
+ import { IntDistribution } from '../entities';
11
+ import { TimeSeriesOf2D } from '../common';
12
+ import { MaliciousIPCard } from '../common';
13
+ import { Alert } from '../entities';
14
+ import { EventCategoryCode } from '../enums';
15
+ import { EventStatusCode } from '../enums';
16
+ import { MaliciousIPData } from '../common';
17
+ export declare class UsrAlertsService {
18
+ private config;
19
+ private rest;
20
+ private baseUrl;
21
+ constructor(config: PulseConfig, rest: RestUtil);
22
+ /**
23
+ * Get single alert by id
24
+ */
25
+ get(id?: string): import("rxjs").Observable<EntityResponse<Alert>>;
26
+ /**
27
+ * Find list of alerts by query
28
+ */
29
+ find(streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number, withoutOccurrences?: boolean): import("rxjs").Observable<EntitiesResponse<Alert>>;
30
+ /**
31
+ * Export list of alerts by query to a file with the specified format
32
+ */
33
+ exportFormat(format?: string, streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number): void;
34
+ /**
35
+ * Find top 10 alerts by their severity filter by query
36
+ */
37
+ getTop(streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number, withoutOccurrences?: boolean): import("rxjs").Observable<EntitiesResponse<AlertWithDevice>>;
38
+ /**
39
+ * Get top malicious IPs
40
+ */
41
+ getTopMaliciousIPs(streamId?: string, top?: number, from?: number, to?: number): import("rxjs").Observable<EntitiesResponse<MaliciousIPData>>;
42
+ /**
43
+ * Find alerts distribution by type filtered by query
44
+ */
45
+ countByType(streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number, withoutOccurrences?: boolean): import("rxjs").Observable<EntityResponse<IntDistribution>>;
46
+ /**
47
+ * Find alerts distribution by status filtered by query
48
+ */
49
+ countByStatus(streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number, withoutOccurrences?: boolean): import("rxjs").Observable<EntityResponse<IntDistribution>>;
50
+ /**
51
+ * Find alerts distribution by severity filtered by query
52
+ */
53
+ countBySeverity(streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number, withoutOccurrences?: boolean): import("rxjs").Observable<EntityResponse<IntDistribution>>;
54
+ /**
55
+ * Find alerts distribution by rule filtered by query
56
+ */
57
+ countByRule(streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number, withoutOccurrences?: boolean): import("rxjs").Observable<EntityResponse<IntDistribution>>;
58
+ /**
59
+ * Find alerts distribution by category filtered by query
60
+ */
61
+ countByCategory(streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number, withoutOccurrences?: boolean): import("rxjs").Observable<EntityResponse<IntDistribution>>;
62
+ /**
63
+ * Add tag to an alert
64
+ */
65
+ addTag(id?: string, tag?: string): import("rxjs").Observable<EntityResponse<Alert>>;
66
+ /**
67
+ * Delete a tag from the alert
68
+ */
69
+ deleteTag(id?: string, tag?: string): import("rxjs").Observable<EntityResponse<Alert>>;
70
+ /**
71
+ * Apply action on an alert
72
+ */
73
+ applyAction(id?: string, action?: DeviceActionCode): import("rxjs").Observable<ActionResponse>;
74
+ /**
75
+ * Set alert status
76
+ */
77
+ setStatus(id?: string, status?: EventStatusCode): import("rxjs").Observable<ActionResponse>;
78
+ /**
79
+ * Get current shieldex value as ActionResponse, the Key contains the shield index and the data includes the trend
80
+ */
81
+ getShieldex(): import("rxjs").Observable<ActionResponse>;
82
+ /**
83
+ * Get histogram of alerts over time by dimension (type | severity | status | ruleType | category)
84
+ */
85
+ alertsTimeline(streamId?: string, deviceId?: string, dimension?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<TimeSeriesOf2D>>;
86
+ /**
87
+ * Get histogram of shieldex values over time
88
+ */
89
+ shieldexTimeline(streamId?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<TimeSeriesOfFloat>>;
90
+ /**
91
+ * Export alert source file
92
+ */
93
+ exportSource(id?: string): void;
94
+ /**
95
+ * Get total number devices at risk (affected by the alerts matching the query)
96
+ */
97
+ getTotalDevicesAtRisk(streamId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[]): import("rxjs").Observable<ActionResponse>;
98
+ /**
99
+ * Get malicious IP data card for specific malicious IP
100
+ */
101
+ getMaliciousIpCard(streamId?: string, targetIp?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<MaliciousIPCard>>;
102
+ /**
103
+ * Apply DNS lookup for each IP in the list
104
+ */
105
+ getIpLookup(ip?: string[]): import("rxjs").Observable<EntitiesResponse<StringKeyValue>>;
106
+ /**
107
+ * Find list of alerts by insight id query
108
+ */
109
+ findByInsightContext(): import("rxjs").Observable<EntitiesResponse<Alert>>;
110
+ }
@@ -0,0 +1,109 @@
1
+ import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
2
+ import { PulseConfig } from '../../config';
3
+ import { DeviceWithEvents } from '../entities';
4
+ import { IntDistribution } from '../entities';
5
+ import { NetworkMap } from '../common';
6
+ import { Device } from '../entities';
7
+ import { DeviceTypeCode } from '../enums';
8
+ import { DeviceStatusCode } from '../enums';
9
+ import { NetworkMapTypeCode } from '../enums';
10
+ import { TimeSeriesOfDeviceReport } from '../entities';
11
+ import { DeviceReport } from '../entities';
12
+ import { TimeSeriesOfDataConsumption } from '../common';
13
+ import { BulkDevices } from '../entities';
14
+ import { SeverityTypeCode } from '../enums';
15
+ import { DeviceActionCode } from '../enums';
16
+ export declare class UsrDevicesService {
17
+ private config;
18
+ private rest;
19
+ private baseUrl;
20
+ constructor(config: PulseConfig, rest: RestUtil);
21
+ /**
22
+ * Create new device
23
+ */
24
+ create(body?: Device): import("rxjs").Observable<EntityResponse<Device>>;
25
+ /**
26
+ * Create bulk of new device, returns list of inserted items
27
+ */
28
+ bulkCreate(body?: BulkDevices): import("rxjs").Observable<EntitiesResponse<Device>>;
29
+ /**
30
+ * Update existing device in the system
31
+ */
32
+ update(body?: Device): import("rxjs").Observable<EntityResponse<Device>>;
33
+ /**
34
+ * Update bulk of device, returns list of updated items
35
+ */
36
+ bulkUpdate(body?: BulkDevices): import("rxjs").Observable<EntitiesResponse<Device>>;
37
+ /**
38
+ * Delete device from the system
39
+ */
40
+ delete(id?: string): import("rxjs").Observable<ActionResponse>;
41
+ /**
42
+ * Get single device by id
43
+ */
44
+ get(id?: string): import("rxjs").Observable<EntityResponse<Device>>;
45
+ /**
46
+ * Find list of devices by query
47
+ */
48
+ find(streamId?: string, search?: string, type?: DeviceTypeCode[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Device>>;
49
+ /**
50
+ * Export list of devices by query to a file with the specified format
51
+ */
52
+ exportFormat(format?: string, streamId?: string, search?: string, type?: DeviceTypeCode[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], sort?: string, page?: number, size?: number): void;
53
+ /**
54
+ * Find top 10 devices by their score filter by query
55
+ */
56
+ findTop(streamId?: string, search?: string, type?: DeviceTypeCode[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<DeviceWithEvents>>;
57
+ /**
58
+ * Find device distribution by type filtered by query
59
+ */
60
+ countByType(streamId?: string, search?: string, type?: DeviceTypeCode[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<IntDistribution>>;
61
+ /**
62
+ * Find device distribution by status filtered by query
63
+ */
64
+ countByStatus(streamId?: string, search?: string, type?: DeviceTypeCode[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<IntDistribution>>;
65
+ /**
66
+ * Find device distribution by action filtered by query
67
+ */
68
+ countByAction(streamId?: string, search?: string, type?: DeviceTypeCode[], status?: DeviceStatusCode[], risk?: SeverityTypeCode[], scoreRange?: number[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<IntDistribution>>;
69
+ /**
70
+ * Add tag to a device
71
+ */
72
+ addTag(id?: string, tag?: string): import("rxjs").Observable<EntityResponse<Device>>;
73
+ /**
74
+ * Delete a tag from the device
75
+ */
76
+ deleteTag(id?: string, tag?: string): import("rxjs").Observable<EntityResponse<Device>>;
77
+ /**
78
+ * Apply action on a device
79
+ */
80
+ applyAction(id?: string, action?: DeviceActionCode): import("rxjs").Observable<ActionResponse>;
81
+ /**
82
+ * Get network map of devices
83
+ */
84
+ getNetworkMap(streamId?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], id?: string[], mapType?: NetworkMapTypeCode, ips?: string[]): import("rxjs").Observable<EntityResponse<NetworkMap>>;
85
+ /**
86
+ * Get daily device report over time (daily device report includes: total devices, active devices, devices at risk)
87
+ */
88
+ getDeviceReportTimeline(streamId?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<TimeSeriesOfDeviceReport>>;
89
+ /**
90
+ * Get latest device report, the Key contains latest devices at risk number (works in account level)
91
+ */
92
+ getLatestDeviceReport(): import("rxjs").Observable<EntityResponse<DeviceReport>>;
93
+ /**
94
+ * Get device / group of devices consumption over time
95
+ */
96
+ getConsumptionTimeline(streamId?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], id?: string[]): import("rxjs").Observable<EntityResponse<TimeSeriesOfDataConsumption>>;
97
+ /**
98
+ * Get device / group of devices consumption over time
99
+ */
100
+ getConsumptionTrend(streamId?: string, from?: number, to?: number, type?: DeviceTypeCode[], tag?: string[], id?: string[]): import("rxjs").Observable<ActionResponse>;
101
+ /**
102
+ * Upload list of devices
103
+ */
104
+ uploadDevices(file: File, streamId?: string, ip?: number, iccid?: number, imsi?: number, msisdn?: number, imei?: number, name?: number, operator?: number, label?: number[], tag?: number[]): void;
105
+ /**
106
+ * Find list of devices by Insight id query
107
+ */
108
+ findByInsightContext(streamId?: string, insightId?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Device>>;
109
+ }