@crowdstrike/foundry-js 0.2.2 → 0.5.1

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 (36) hide show
  1. package/dist/abstraction/api-integration.d.ts +23 -0
  2. package/dist/abstraction/cloud-function.d.ts +49 -0
  3. package/dist/abstraction/collection.d.ts +20 -0
  4. package/dist/abstraction/logscale.d.ts +14 -0
  5. package/dist/api.d.ts +32 -2
  6. package/dist/apis/actors/index.d.ts +77 -0
  7. package/dist/apis/alerts/index.d.ts +126 -0
  8. package/dist/apis/available-apis.d.ts +1 -1
  9. package/dist/apis/customobjects/index.d.ts +89 -0
  10. package/dist/apis/detects/index.d.ts +93 -0
  11. package/dist/apis/devices/index.d.ts +270 -0
  12. package/dist/apis/faas-gateway/index.d.ts +41 -0
  13. package/dist/apis/fwmgr/index.d.ts +407 -0
  14. package/dist/apis/incidents/index.d.ts +112 -0
  15. package/dist/apis/loggingapi/index.d.ts +68 -0
  16. package/dist/apis/mitre/index.d.ts +31 -0
  17. package/dist/apis/plugins/index.d.ts +52 -0
  18. package/dist/apis/public-api.d.ts +25 -3
  19. package/dist/apis/remote-response/index.d.ts +74 -0
  20. package/dist/apis/types-response-for.d.ts +29 -0
  21. package/dist/apis/types.d.ts +30 -2
  22. package/dist/apis/workflows/index.d.ts +58 -0
  23. package/dist/bridge.d.ts +8 -3
  24. package/dist/index.d.ts +2 -1
  25. package/dist/index.js +2210 -332
  26. package/dist/index.js.map +1 -1
  27. package/dist/lib/navigation.d.ts +18 -0
  28. package/dist/lib/resize-tracker.d.ts +9 -0
  29. package/dist/lib/ui.d.ts +8 -0
  30. package/dist/types.d.ts +129 -10
  31. package/dist/utils.d.ts +2 -2
  32. package/package.json +5 -1
  33. package/dist/apis/incidents/bridge.d.ts +0 -15
  34. package/dist/apis/incidents/types.d.ts +0 -33
  35. package/dist/apis/remote-response/bridge.d.ts +0 -15
  36. package/dist/apis/remote-response/types.d.ts +0 -33
@@ -0,0 +1,23 @@
1
+ import type FalconApi from '../api';
2
+ import type { LocalData } from '../types';
3
+ interface ApiIntegrationDefinition {
4
+ definitionId: string;
5
+ operationId: string;
6
+ }
7
+ interface ExecuteParameters {
8
+ request?: {
9
+ params?: {
10
+ path?: Record<any, unknown>;
11
+ query?: Record<any, unknown>;
12
+ header?: Record<any, unknown>;
13
+ };
14
+ json?: Record<any, unknown> | Record<any, unknown>[];
15
+ };
16
+ }
17
+ export declare class ApiIntegration<DATA extends LocalData = LocalData> {
18
+ private readonly falcon;
19
+ private readonly definition;
20
+ constructor(falcon: FalconApi<DATA>, definition: ApiIntegrationDefinition);
21
+ execute({ request }?: ExecuteParameters): Promise<import("../apis/plugins").PostEntitiesExecuteV1ApiResponse>;
22
+ }
23
+ export {};
@@ -0,0 +1,49 @@
1
+ import type FalconApi from '../api';
2
+ import type { LocalData } from '../types';
3
+ interface FunctionDefinition {
4
+ id: string;
5
+ version: number;
6
+ }
7
+ interface PostParameters {
8
+ path: string;
9
+ body?: Record<string, unknown>;
10
+ queryParams?: Record<string, unknown>;
11
+ headers?: Record<string, unknown>;
12
+ }
13
+ type PatchParameters = PostParameters;
14
+ type DeleteParameters = PostParameters;
15
+ interface GetParameters {
16
+ path: string;
17
+ queryParams?: Record<string, unknown>;
18
+ headers?: Record<string, unknown>;
19
+ }
20
+ export declare class CloudFunction<DATA extends LocalData = LocalData> {
21
+ private readonly falcon;
22
+ private readonly definition;
23
+ static GET: "GET";
24
+ static POST: "POST";
25
+ static PATCH: "PATCH";
26
+ static DELETE: "DELETE";
27
+ pollTimeout: number;
28
+ intervalId?: number;
29
+ constructor(falcon: FalconApi<DATA>, definition: FunctionDefinition);
30
+ private execute;
31
+ private getExecutionResult;
32
+ private pollForResult;
33
+ path(pathEntry: string): {
34
+ path: string;
35
+ queryParams: {
36
+ [x: string]: string[];
37
+ }[];
38
+ get: (queryParams?: GetParameters['queryParams']) => Promise<unknown>;
39
+ post: (body: PostParameters['body'], queryParams?: PostParameters['queryParams'], headers?: PostParameters['headers']) => Promise<unknown>;
40
+ patch: (body: PatchParameters['body'], queryParams?: PatchParameters['queryParams'], headers?: PatchParameters['headers']) => Promise<unknown>;
41
+ delete: (body: DeleteParameters['body'], queryParams?: DeleteParameters['queryParams'], headers?: DeleteParameters['headers']) => Promise<unknown>;
42
+ };
43
+ get({ path, queryParams, headers }: GetParameters): Promise<unknown>;
44
+ post({ path, queryParams, body, headers }: PostParameters): Promise<unknown>;
45
+ patch({ path, queryParams, body, headers }: PatchParameters): Promise<unknown>;
46
+ delete({ path, queryParams, body, headers }: DeleteParameters): Promise<unknown>;
47
+ destroy(): void;
48
+ }
49
+ export {};
@@ -0,0 +1,20 @@
1
+ import type FalconApi from '../api';
2
+ import type { LocalData } from '../types';
3
+ interface CollectionDefinition {
4
+ collection: string;
5
+ }
6
+ interface CollectionSearchDefinition {
7
+ startKey: string;
8
+ endKey: string;
9
+ limit: string;
10
+ }
11
+ export declare class Collection<DATA extends LocalData = LocalData> {
12
+ private readonly falcon;
13
+ private readonly definition;
14
+ constructor(falcon: FalconApi<DATA>, definition: CollectionDefinition);
15
+ write(key: string, data: Record<string, unknown>): Promise<any>;
16
+ read(key: string): Promise<any>;
17
+ delete(key: string): Promise<any>;
18
+ search({ startKey, endKey, limit }: CollectionSearchDefinition): Promise<any>;
19
+ }
20
+ export {};
@@ -0,0 +1,14 @@
1
+ import type FalconApi from '../api';
2
+ import type { LocalData, LogscaleRequestMessage } from '../types';
3
+ interface WriteProperties {
4
+ tag: LogscaleRequestMessage['payload']['tag'];
5
+ tagSource: LogscaleRequestMessage['payload']['tagSource'];
6
+ testData: LogscaleRequestMessage['payload']['testData'];
7
+ }
8
+ export declare class Logscale<DATA extends LocalData = LocalData> {
9
+ private readonly falcon;
10
+ constructor(falcon: FalconApi<DATA>);
11
+ write(data: LogscaleRequestMessage['payload']['data'], properties: WriteProperties): Promise<any>;
12
+ query(data: LogscaleRequestMessage['payload']['data']): Promise<any>;
13
+ }
14
+ export {};
package/dist/api.d.ts CHANGED
@@ -1,16 +1,46 @@
1
- import { LocalData } from 'types';
2
- import FalconPublicApis from './apis/public-api';
3
1
  import Emittery from 'emittery';
2
+ import FalconPublicApis from './apis/public-api';
3
+ import { ApiIntegration } from './abstraction/api-integration';
4
4
  import { Bridge } from './bridge';
5
+ import { CloudFunction } from './abstraction/cloud-function';
6
+ import { Collection } from './abstraction/collection';
7
+ import { Logscale } from './abstraction/logscale';
8
+ import { Navigation } from './lib/navigation';
9
+ import { UI } from './lib/ui';
10
+ import type { FileUploadType, LocalData, PayloadForFileUploadType, ResponseForFileUploadType } from './types';
5
11
  interface EventMap<DATA extends LocalData> {
6
12
  data: DATA;
13
+ broadcast: unknown;
7
14
  }
8
15
  export default class FalconApi<DATA extends LocalData = LocalData> extends FalconPublicApis {
9
16
  events: Emittery<EventMap<DATA>, EventMap<DATA> & import("emittery").OmnipresentEventData, DATA extends undefined ? "data" : never>;
10
17
  data?: DATA;
11
18
  bridge: Bridge<DATA>;
19
+ ui: UI<DATA>;
20
+ private resizeTracker?;
21
+ private cloudFunctions;
22
+ private apiIntegrations;
23
+ private collections;
12
24
  connect(): Promise<void>;
25
+ sendBroadcast(payload: unknown): void;
26
+ uploadFile<TYPE extends FileUploadType>(fileUploadType: TYPE, initialData?: PayloadForFileUploadType<TYPE>): Promise<ResponseForFileUploadType<TYPE> | undefined>;
13
27
  private handleDataUpdate;
28
+ private handleBroadcastMessage;
29
+ private handleLivereloadMessage;
30
+ private updateTheme;
31
+ cloudFunction({ id, version }: {
32
+ id: string;
33
+ version: number;
34
+ }): CloudFunction<DATA>;
35
+ apiIntegration({ definitionId, operationId }: {
36
+ operationId: string;
37
+ definitionId: string;
38
+ }): ApiIntegration<DATA>;
39
+ collection({ collection }: {
40
+ collection: string;
41
+ }): Collection<DATA>;
42
+ get navigation(): Navigation<DATA>;
43
+ get logscale(): Logscale<DATA>;
14
44
  destroy(): void;
15
45
  }
16
46
  export {};
@@ -0,0 +1,77 @@
1
+ /**
2
+ *
3
+ * This file is autogenerated.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ **/
8
+ import type { Bridge } from '../../bridge';
9
+ import type { ApiResponsePayload, BaseApiRequestMessage, BaseApiResponseMessage, BaseUrlParams, QueryParam } from '../../types';
10
+ export type ActorsRequestApi = 'actors';
11
+ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload>;
12
+ export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
13
+ api: ActorsRequestApi;
14
+ }
15
+ export interface GetEntitiesActorsGetV2QueryParams extends BaseUrlParams {
16
+ ids?: QueryParam;
17
+ }
18
+ export type GetEntitiesActorsGetV2ApiResponse = ApiResponsePayload;
19
+ export type GetEntitiesActorsGetV2ResponseMessage = BaseApiResponseMessage<GetEntitiesActorsGetV2ApiResponse>;
20
+ export interface GetEntitiesActorsGetV2RequestMessage extends BaseApiRequestMessage<GetEntitiesActorsGetV2QueryParams> {
21
+ api: ActorsRequestApi;
22
+ method: 'getEntitiesActorsGetV2';
23
+ }
24
+ export interface GetQueriesActorsV2QueryParams extends BaseUrlParams {
25
+ filter?: string;
26
+ limit?: QueryParam;
27
+ offset?: QueryParam;
28
+ q?: QueryParam;
29
+ sort?: QueryParam;
30
+ }
31
+ export type GetQueriesActorsV2ApiResponse = ApiResponsePayload;
32
+ export type GetQueriesActorsV2ResponseMessage = BaseApiResponseMessage<GetQueriesActorsV2ApiResponse>;
33
+ export interface GetQueriesActorsV2RequestMessage extends BaseApiRequestMessage<GetQueriesActorsV2QueryParams> {
34
+ api: ActorsRequestApi;
35
+ method: 'getQueriesActorsV2';
36
+ }
37
+ export type PostAggregatesActorsGetV2QueryParams = BaseUrlParams;
38
+ export type PostAggregatesActorsGetV2ApiResponse = ApiResponsePayload;
39
+ export interface PostAggregatesActorsGetV2PostData {
40
+ }
41
+ export type PostAggregatesActorsGetV2ResponseMessage = BaseApiResponseMessage<PostAggregatesActorsGetV2ApiResponse>;
42
+ export interface PostAggregatesActorsGetV2RequestMessage extends BaseApiRequestMessage<PostAggregatesActorsGetV2QueryParams, PostAggregatesActorsGetV2PostData> {
43
+ api: ActorsRequestApi;
44
+ method: 'postAggregatesActorsGetV2';
45
+ }
46
+ export interface PostEntitiesActorsGetV2QueryParams extends BaseUrlParams {
47
+ ids?: QueryParam;
48
+ }
49
+ export type PostEntitiesActorsGetV2ApiResponse = ApiResponsePayload;
50
+ export interface PostEntitiesActorsGetV2PostData {
51
+ }
52
+ export type PostEntitiesActorsGetV2ResponseMessage = BaseApiResponseMessage<PostEntitiesActorsGetV2ApiResponse>;
53
+ export interface PostEntitiesActorsGetV2RequestMessage extends BaseApiRequestMessage<PostEntitiesActorsGetV2QueryParams, PostEntitiesActorsGetV2PostData> {
54
+ api: ActorsRequestApi;
55
+ method: 'postEntitiesActorsGetV2';
56
+ }
57
+ export type PostEntitiesMitreV1QueryParams = BaseUrlParams;
58
+ export type PostEntitiesMitreV1ApiResponse = ApiResponsePayload;
59
+ export interface PostEntitiesMitreV1PostData {
60
+ }
61
+ export type PostEntitiesMitreV1ResponseMessage = BaseApiResponseMessage<PostEntitiesMitreV1ApiResponse>;
62
+ export interface PostEntitiesMitreV1RequestMessage extends BaseApiRequestMessage<PostEntitiesMitreV1QueryParams, PostEntitiesMitreV1PostData> {
63
+ api: ActorsRequestApi;
64
+ method: 'postEntitiesMitreV1';
65
+ }
66
+ export type ActorsApiRequestMessage = GetEntitiesActorsGetV2RequestMessage | GetQueriesActorsV2RequestMessage | PostAggregatesActorsGetV2RequestMessage | PostEntitiesActorsGetV2RequestMessage | PostEntitiesMitreV1RequestMessage;
67
+ export type ActorsApiResponseMessage = GetEntitiesActorsGetV2ResponseMessage | GetQueriesActorsV2ResponseMessage | PostAggregatesActorsGetV2ResponseMessage | PostEntitiesActorsGetV2ResponseMessage | PostEntitiesMitreV1ResponseMessage;
68
+ export declare class ActorsApiBridge {
69
+ private bridge;
70
+ constructor(bridge: Bridge);
71
+ getBridge(): Bridge<import("../../types").LocalData>;
72
+ getEntitiesActorsGetV2(urlParams?: GetEntitiesActorsGetV2QueryParams): Promise<GetEntitiesActorsGetV2ApiResponse>;
73
+ getQueriesActorsV2(urlParams?: GetQueriesActorsV2QueryParams): Promise<GetQueriesActorsV2ApiResponse>;
74
+ postAggregatesActorsGetV2(postBody: PostAggregatesActorsGetV2PostData, urlParams?: PostAggregatesActorsGetV2QueryParams): Promise<PostAggregatesActorsGetV2ApiResponse>;
75
+ postEntitiesActorsGetV2(postBody: PostEntitiesActorsGetV2PostData, urlParams?: PostEntitiesActorsGetV2QueryParams): Promise<PostEntitiesActorsGetV2ApiResponse>;
76
+ postEntitiesMitreV1(postBody: PostEntitiesMitreV1PostData, urlParams?: PostEntitiesMitreV1QueryParams): Promise<PostEntitiesMitreV1ApiResponse>;
77
+ }
@@ -0,0 +1,126 @@
1
+ /**
2
+ *
3
+ * This file is autogenerated.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ **/
8
+ import type { Bridge } from '../../bridge';
9
+ import type { ApiResponsePayload, BaseApiRequestMessage, BaseApiResponseMessage, BaseUrlParams, QueryParam } from '../../types';
10
+ export type AlertsRequestApi = 'alerts';
11
+ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload>;
12
+ export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
13
+ api: AlertsRequestApi;
14
+ }
15
+ export interface DeleteEntitiesSuppressedDevicesV1QueryParams extends BaseUrlParams {
16
+ ids?: QueryParam;
17
+ }
18
+ export type DeleteEntitiesSuppressedDevicesV1ApiResponse = ApiResponsePayload;
19
+ export type DeleteEntitiesSuppressedDevicesV1ResponseMessage = BaseApiResponseMessage<DeleteEntitiesSuppressedDevicesV1ApiResponse>;
20
+ export interface DeleteEntitiesSuppressedDevicesV1RequestMessage extends BaseApiRequestMessage<DeleteEntitiesSuppressedDevicesV1QueryParams> {
21
+ api: AlertsRequestApi;
22
+ method: 'deleteEntitiesSuppressedDevicesV1';
23
+ }
24
+ export interface GetQueriesAlertsV1QueryParams extends BaseUrlParams {
25
+ filter?: string;
26
+ limit?: QueryParam;
27
+ offset?: QueryParam;
28
+ q?: QueryParam;
29
+ sort?: QueryParam;
30
+ }
31
+ export type GetQueriesAlertsV1ApiResponse = ApiResponsePayload;
32
+ export type GetQueriesAlertsV1ResponseMessage = BaseApiResponseMessage<GetQueriesAlertsV1ApiResponse>;
33
+ export interface GetQueriesAlertsV1RequestMessage extends BaseApiRequestMessage<GetQueriesAlertsV1QueryParams> {
34
+ api: AlertsRequestApi;
35
+ method: 'getQueriesAlertsV1';
36
+ }
37
+ export type PatchCombinedAlertsV2QueryParams = BaseUrlParams;
38
+ export type PatchCombinedAlertsV2ApiResponse = ApiResponsePayload;
39
+ export interface PatchCombinedAlertsV2PostData {
40
+ }
41
+ export type PatchCombinedAlertsV2ResponseMessage = BaseApiResponseMessage<PatchCombinedAlertsV2ApiResponse>;
42
+ export interface PatchCombinedAlertsV2RequestMessage extends BaseApiRequestMessage<PatchCombinedAlertsV2QueryParams, PatchCombinedAlertsV2PostData> {
43
+ api: AlertsRequestApi;
44
+ method: 'patchCombinedAlertsV2';
45
+ }
46
+ export type PatchEntitiesAlertsV2QueryParams = BaseUrlParams;
47
+ export type PatchEntitiesAlertsV2ApiResponse = ApiResponsePayload;
48
+ export interface PatchEntitiesAlertsV2PostData {
49
+ }
50
+ export type PatchEntitiesAlertsV2ResponseMessage = BaseApiResponseMessage<PatchEntitiesAlertsV2ApiResponse>;
51
+ export interface PatchEntitiesAlertsV2RequestMessage extends BaseApiRequestMessage<PatchEntitiesAlertsV2QueryParams, PatchEntitiesAlertsV2PostData> {
52
+ api: AlertsRequestApi;
53
+ method: 'patchEntitiesAlertsV2';
54
+ }
55
+ export interface PatchEntitiesSuppressedDevicesV1QueryParams extends BaseUrlParams {
56
+ ids?: QueryParam;
57
+ }
58
+ export type PatchEntitiesSuppressedDevicesV1ApiResponse = ApiResponsePayload;
59
+ export interface PatchEntitiesSuppressedDevicesV1PostData {
60
+ }
61
+ export type PatchEntitiesSuppressedDevicesV1ResponseMessage = BaseApiResponseMessage<PatchEntitiesSuppressedDevicesV1ApiResponse>;
62
+ export interface PatchEntitiesSuppressedDevicesV1RequestMessage extends BaseApiRequestMessage<PatchEntitiesSuppressedDevicesV1QueryParams, PatchEntitiesSuppressedDevicesV1PostData> {
63
+ api: AlertsRequestApi;
64
+ method: 'patchEntitiesSuppressedDevicesV1';
65
+ }
66
+ export interface PostAggregatesAlertsV1QueryParams extends BaseUrlParams {
67
+ dateRanges?: QueryParam;
68
+ field?: QueryParam;
69
+ filter?: string;
70
+ from?: QueryParam;
71
+ include?: QueryParam;
72
+ interval?: QueryParam;
73
+ minDocCount?: QueryParam;
74
+ missing?: QueryParam;
75
+ name?: QueryParam;
76
+ q?: QueryParam;
77
+ ranges?: QueryParam;
78
+ size?: QueryParam;
79
+ sort?: QueryParam;
80
+ subAggregates?: QueryParam;
81
+ timeZone?: QueryParam;
82
+ type?: QueryParam;
83
+ }
84
+ export type PostAggregatesAlertsV1ApiResponse = ApiResponsePayload;
85
+ export interface PostAggregatesAlertsV1PostData {
86
+ }
87
+ export type PostAggregatesAlertsV1ResponseMessage = BaseApiResponseMessage<PostAggregatesAlertsV1ApiResponse>;
88
+ export interface PostAggregatesAlertsV1RequestMessage extends BaseApiRequestMessage<PostAggregatesAlertsV1QueryParams, PostAggregatesAlertsV1PostData> {
89
+ api: AlertsRequestApi;
90
+ method: 'postAggregatesAlertsV1';
91
+ }
92
+ export interface PostEntitiesAlertsV1QueryParams extends BaseUrlParams {
93
+ ids?: QueryParam;
94
+ }
95
+ export type PostEntitiesAlertsV1ApiResponse = ApiResponsePayload;
96
+ export interface PostEntitiesAlertsV1PostData {
97
+ }
98
+ export type PostEntitiesAlertsV1ResponseMessage = BaseApiResponseMessage<PostEntitiesAlertsV1ApiResponse>;
99
+ export interface PostEntitiesAlertsV1RequestMessage extends BaseApiRequestMessage<PostEntitiesAlertsV1QueryParams, PostEntitiesAlertsV1PostData> {
100
+ api: AlertsRequestApi;
101
+ method: 'postEntitiesAlertsV1';
102
+ }
103
+ export type PostEntitiesSuppressedDevicesV1QueryParams = BaseUrlParams;
104
+ export type PostEntitiesSuppressedDevicesV1ApiResponse = ApiResponsePayload;
105
+ export interface PostEntitiesSuppressedDevicesV1PostData {
106
+ }
107
+ export type PostEntitiesSuppressedDevicesV1ResponseMessage = BaseApiResponseMessage<PostEntitiesSuppressedDevicesV1ApiResponse>;
108
+ export interface PostEntitiesSuppressedDevicesV1RequestMessage extends BaseApiRequestMessage<PostEntitiesSuppressedDevicesV1QueryParams, PostEntitiesSuppressedDevicesV1PostData> {
109
+ api: AlertsRequestApi;
110
+ method: 'postEntitiesSuppressedDevicesV1';
111
+ }
112
+ export type AlertsApiRequestMessage = DeleteEntitiesSuppressedDevicesV1RequestMessage | GetQueriesAlertsV1RequestMessage | PatchCombinedAlertsV2RequestMessage | PatchEntitiesAlertsV2RequestMessage | PatchEntitiesSuppressedDevicesV1RequestMessage | PostAggregatesAlertsV1RequestMessage | PostEntitiesAlertsV1RequestMessage | PostEntitiesSuppressedDevicesV1RequestMessage;
113
+ export type AlertsApiResponseMessage = DeleteEntitiesSuppressedDevicesV1ResponseMessage | GetQueriesAlertsV1ResponseMessage | PatchCombinedAlertsV2ResponseMessage | PatchEntitiesAlertsV2ResponseMessage | PatchEntitiesSuppressedDevicesV1ResponseMessage | PostAggregatesAlertsV1ResponseMessage | PostEntitiesAlertsV1ResponseMessage | PostEntitiesSuppressedDevicesV1ResponseMessage;
114
+ export declare class AlertsApiBridge {
115
+ private bridge;
116
+ constructor(bridge: Bridge);
117
+ getBridge(): Bridge<import("../../types").LocalData>;
118
+ deleteEntitiesSuppressedDevicesV1(urlParams?: DeleteEntitiesSuppressedDevicesV1QueryParams): Promise<DeleteEntitiesSuppressedDevicesV1ApiResponse>;
119
+ getQueriesAlertsV1(urlParams?: GetQueriesAlertsV1QueryParams): Promise<GetQueriesAlertsV1ApiResponse>;
120
+ patchCombinedAlertsV2(postBody: PatchCombinedAlertsV2PostData, urlParams?: PatchCombinedAlertsV2QueryParams): Promise<PatchCombinedAlertsV2ApiResponse>;
121
+ patchEntitiesAlertsV2(postBody: PatchEntitiesAlertsV2PostData, urlParams?: PatchEntitiesAlertsV2QueryParams): Promise<PatchEntitiesAlertsV2ApiResponse>;
122
+ patchEntitiesSuppressedDevicesV1(postBody: PatchEntitiesSuppressedDevicesV1PostData, urlParams?: PatchEntitiesSuppressedDevicesV1QueryParams): Promise<PatchEntitiesSuppressedDevicesV1ApiResponse>;
123
+ postAggregatesAlertsV1(postBody: PostAggregatesAlertsV1PostData, urlParams?: PostAggregatesAlertsV1QueryParams): Promise<PostAggregatesAlertsV1ApiResponse>;
124
+ postEntitiesAlertsV1(postBody: PostEntitiesAlertsV1PostData, urlParams?: PostEntitiesAlertsV1QueryParams): Promise<PostEntitiesAlertsV1ApiResponse>;
125
+ postEntitiesSuppressedDevicesV1(postBody: PostEntitiesSuppressedDevicesV1PostData, urlParams?: PostEntitiesSuppressedDevicesV1QueryParams): Promise<PostEntitiesSuppressedDevicesV1ApiResponse>;
126
+ }
@@ -12,4 +12,4 @@
12
12
  * ```
13
13
  *
14
14
  **/
15
- export type ApiIdentifier = 'incidents' | 'remoteResponse';
15
+ export type ApiIdentifier = 'actors' | 'alerts' | 'detects' | 'devices' | 'fwmgr' | 'incidents' | 'mitre' | 'plugins' | 'remoteResponse' | 'workflows' | 'customobjects' | 'faasGateway' | 'loggingapi';
@@ -0,0 +1,89 @@
1
+ /**
2
+ *
3
+ * This file is autogenerated.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ **/
8
+ import type { Bridge } from '../../bridge';
9
+ import type { ApiResponsePayload, BaseApiRequestMessage, BaseApiResponseMessage, BaseUrlParams, QueryParam } from '../../types';
10
+ export type CustomobjectsRequestApi = 'customobjects';
11
+ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload>;
12
+ export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
13
+ api: CustomobjectsRequestApi;
14
+ }
15
+ export type DeleteV1CollectionsCollectionNameObjectsObjectKeyQueryParams = BaseUrlParams;
16
+ export type DeleteV1CollectionsCollectionNameObjectsObjectKeyApiResponse = ApiResponsePayload;
17
+ export type DeleteV1CollectionsCollectionNameObjectsObjectKeyResponseMessage = BaseApiResponseMessage<DeleteV1CollectionsCollectionNameObjectsObjectKeyApiResponse>;
18
+ export interface DeleteV1CollectionsCollectionNameObjectsObjectKeyRequestMessage extends BaseApiRequestMessage<DeleteV1CollectionsCollectionNameObjectsObjectKeyQueryParams> {
19
+ api: CustomobjectsRequestApi;
20
+ method: 'deleteV1CollectionsCollectionNameObjectsObjectKey';
21
+ }
22
+ export interface GetV1CollectionsQueryParams extends BaseUrlParams {
23
+ startKey?: QueryParam;
24
+ endKey?: QueryParam;
25
+ limit?: QueryParam;
26
+ }
27
+ export type GetV1CollectionsApiResponse = ApiResponsePayload;
28
+ export type GetV1CollectionsResponseMessage = BaseApiResponseMessage<GetV1CollectionsApiResponse>;
29
+ export interface GetV1CollectionsRequestMessage extends BaseApiRequestMessage<GetV1CollectionsQueryParams> {
30
+ api: CustomobjectsRequestApi;
31
+ method: 'getV1Collections';
32
+ }
33
+ export interface GetV1CollectionsCollectionNameObjectsQueryParams extends BaseUrlParams {
34
+ startKey?: QueryParam;
35
+ endKey?: QueryParam;
36
+ limit?: QueryParam;
37
+ }
38
+ export type GetV1CollectionsCollectionNameObjectsApiResponse = ApiResponsePayload;
39
+ export type GetV1CollectionsCollectionNameObjectsResponseMessage = BaseApiResponseMessage<GetV1CollectionsCollectionNameObjectsApiResponse>;
40
+ export interface GetV1CollectionsCollectionNameObjectsRequestMessage extends BaseApiRequestMessage<GetV1CollectionsCollectionNameObjectsQueryParams> {
41
+ api: CustomobjectsRequestApi;
42
+ method: 'getV1CollectionsCollectionNameObjects';
43
+ }
44
+ export type GetV1CollectionsCollectionNameObjectsObjectKeyQueryParams = BaseUrlParams;
45
+ export type GetV1CollectionsCollectionNameObjectsObjectKeyApiResponse = ApiResponsePayload;
46
+ export type GetV1CollectionsCollectionNameObjectsObjectKeyResponseMessage = BaseApiResponseMessage<GetV1CollectionsCollectionNameObjectsObjectKeyApiResponse>;
47
+ export interface GetV1CollectionsCollectionNameObjectsObjectKeyRequestMessage extends BaseApiRequestMessage<GetV1CollectionsCollectionNameObjectsObjectKeyQueryParams> {
48
+ api: CustomobjectsRequestApi;
49
+ method: 'getV1CollectionsCollectionNameObjectsObjectKey';
50
+ }
51
+ export type GetV1CollectionsCollectionNameObjectsObjectKeyMetadataQueryParams = BaseUrlParams;
52
+ export type GetV1CollectionsCollectionNameObjectsObjectKeyMetadataApiResponse = ApiResponsePayload;
53
+ export type GetV1CollectionsCollectionNameObjectsObjectKeyMetadataResponseMessage = BaseApiResponseMessage<GetV1CollectionsCollectionNameObjectsObjectKeyMetadataApiResponse>;
54
+ export interface GetV1CollectionsCollectionNameObjectsObjectKeyMetadataRequestMessage extends BaseApiRequestMessage<GetV1CollectionsCollectionNameObjectsObjectKeyMetadataQueryParams> {
55
+ api: CustomobjectsRequestApi;
56
+ method: 'getV1CollectionsCollectionNameObjectsObjectKeyMetadata';
57
+ }
58
+ export type PostV1CollectionsCollectionNameObjectsQueryParams = BaseUrlParams;
59
+ export type PostV1CollectionsCollectionNameObjectsApiResponse = ApiResponsePayload;
60
+ export interface PostV1CollectionsCollectionNameObjectsPostData {
61
+ }
62
+ export type PostV1CollectionsCollectionNameObjectsResponseMessage = BaseApiResponseMessage<PostV1CollectionsCollectionNameObjectsApiResponse>;
63
+ export interface PostV1CollectionsCollectionNameObjectsRequestMessage extends BaseApiRequestMessage<PostV1CollectionsCollectionNameObjectsQueryParams, PostV1CollectionsCollectionNameObjectsPostData> {
64
+ api: CustomobjectsRequestApi;
65
+ method: 'postV1CollectionsCollectionNameObjects';
66
+ }
67
+ export type PutV1CollectionsCollectionNameObjectsObjectKeyQueryParams = BaseUrlParams;
68
+ export type PutV1CollectionsCollectionNameObjectsObjectKeyApiResponse = ApiResponsePayload;
69
+ export interface PutV1CollectionsCollectionNameObjectsObjectKeyPostData {
70
+ }
71
+ export type PutV1CollectionsCollectionNameObjectsObjectKeyResponseMessage = BaseApiResponseMessage<PutV1CollectionsCollectionNameObjectsObjectKeyApiResponse>;
72
+ export interface PutV1CollectionsCollectionNameObjectsObjectKeyRequestMessage extends BaseApiRequestMessage<PutV1CollectionsCollectionNameObjectsObjectKeyQueryParams, PutV1CollectionsCollectionNameObjectsObjectKeyPostData> {
73
+ api: CustomobjectsRequestApi;
74
+ method: 'putV1CollectionsCollectionNameObjectsObjectKey';
75
+ }
76
+ export type CustomobjectsApiRequestMessage = DeleteV1CollectionsCollectionNameObjectsObjectKeyRequestMessage | GetV1CollectionsRequestMessage | GetV1CollectionsCollectionNameObjectsRequestMessage | GetV1CollectionsCollectionNameObjectsObjectKeyRequestMessage | GetV1CollectionsCollectionNameObjectsObjectKeyMetadataRequestMessage | PostV1CollectionsCollectionNameObjectsRequestMessage | PutV1CollectionsCollectionNameObjectsObjectKeyRequestMessage;
77
+ export type CustomobjectsApiResponseMessage = DeleteV1CollectionsCollectionNameObjectsObjectKeyResponseMessage | GetV1CollectionsResponseMessage | GetV1CollectionsCollectionNameObjectsResponseMessage | GetV1CollectionsCollectionNameObjectsObjectKeyResponseMessage | GetV1CollectionsCollectionNameObjectsObjectKeyMetadataResponseMessage | PostV1CollectionsCollectionNameObjectsResponseMessage | PutV1CollectionsCollectionNameObjectsObjectKeyResponseMessage;
78
+ export declare class CustomobjectsApiBridge {
79
+ private bridge;
80
+ constructor(bridge: Bridge);
81
+ getBridge(): Bridge<import("../../types").LocalData>;
82
+ deleteV1CollectionsCollectionNameObjectsObjectKey(urlParams?: DeleteV1CollectionsCollectionNameObjectsObjectKeyQueryParams): Promise<DeleteV1CollectionsCollectionNameObjectsObjectKeyApiResponse>;
83
+ getV1Collections(urlParams?: GetV1CollectionsQueryParams): Promise<GetV1CollectionsApiResponse>;
84
+ getV1CollectionsCollectionNameObjects(urlParams?: GetV1CollectionsCollectionNameObjectsQueryParams): Promise<GetV1CollectionsCollectionNameObjectsApiResponse>;
85
+ getV1CollectionsCollectionNameObjectsObjectKey(urlParams?: GetV1CollectionsCollectionNameObjectsObjectKeyQueryParams): Promise<GetV1CollectionsCollectionNameObjectsObjectKeyApiResponse>;
86
+ getV1CollectionsCollectionNameObjectsObjectKeyMetadata(urlParams?: GetV1CollectionsCollectionNameObjectsObjectKeyMetadataQueryParams): Promise<GetV1CollectionsCollectionNameObjectsObjectKeyMetadataApiResponse>;
87
+ postV1CollectionsCollectionNameObjects(postBody: PostV1CollectionsCollectionNameObjectsPostData, urlParams?: PostV1CollectionsCollectionNameObjectsQueryParams): Promise<PostV1CollectionsCollectionNameObjectsApiResponse>;
88
+ putV1CollectionsCollectionNameObjectsObjectKey(postBody: PutV1CollectionsCollectionNameObjectsObjectKeyPostData, urlParams?: PutV1CollectionsCollectionNameObjectsObjectKeyQueryParams): Promise<PutV1CollectionsCollectionNameObjectsObjectKeyApiResponse>;
89
+ }
@@ -0,0 +1,93 @@
1
+ /**
2
+ *
3
+ * This file is autogenerated.
4
+ *
5
+ * DO NOT EDIT DIRECTLY
6
+ *
7
+ **/
8
+ import type { Bridge } from '../../bridge';
9
+ import type { ApiResponsePayload, BaseApiRequestMessage, BaseApiResponseMessage, BaseUrlParams, QueryParam } from '../../types';
10
+ export type DetectsRequestApi = 'detects';
11
+ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload>;
12
+ export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
13
+ api: DetectsRequestApi;
14
+ }
15
+ export interface GetEntitiesSuppressedDevicesV1QueryParams extends BaseUrlParams {
16
+ ids?: QueryParam;
17
+ }
18
+ export type GetEntitiesSuppressedDevicesV1ApiResponse = ApiResponsePayload;
19
+ export type GetEntitiesSuppressedDevicesV1ResponseMessage = BaseApiResponseMessage<GetEntitiesSuppressedDevicesV1ApiResponse>;
20
+ export interface GetEntitiesSuppressedDevicesV1RequestMessage extends BaseApiRequestMessage<GetEntitiesSuppressedDevicesV1QueryParams> {
21
+ api: DetectsRequestApi;
22
+ method: 'getEntitiesSuppressedDevicesV1';
23
+ }
24
+ export type PatchEntitiesDetectsV2QueryParams = BaseUrlParams;
25
+ export type PatchEntitiesDetectsV2ApiResponse = ApiResponsePayload;
26
+ export interface PatchEntitiesDetectsV2PostData {
27
+ }
28
+ export type PatchEntitiesDetectsV2ResponseMessage = BaseApiResponseMessage<PatchEntitiesDetectsV2ApiResponse>;
29
+ export interface PatchEntitiesDetectsV2RequestMessage extends BaseApiRequestMessage<PatchEntitiesDetectsV2QueryParams, PatchEntitiesDetectsV2PostData> {
30
+ api: DetectsRequestApi;
31
+ method: 'patchEntitiesDetectsV2';
32
+ }
33
+ export type PatchQueriesDetectsV1QueryParams = BaseUrlParams;
34
+ export type PatchQueriesDetectsV1ApiResponse = ApiResponsePayload;
35
+ export interface PatchQueriesDetectsV1PostData {
36
+ }
37
+ export type PatchQueriesDetectsV1ResponseMessage = BaseApiResponseMessage<PatchQueriesDetectsV1ApiResponse>;
38
+ export interface PatchQueriesDetectsV1RequestMessage extends BaseApiRequestMessage<PatchQueriesDetectsV1QueryParams, PatchQueriesDetectsV1PostData> {
39
+ api: DetectsRequestApi;
40
+ method: 'patchQueriesDetectsV1';
41
+ }
42
+ export type PatchQueriesDetectsV2QueryParams = BaseUrlParams;
43
+ export type PatchQueriesDetectsV2ApiResponse = ApiResponsePayload;
44
+ export interface PatchQueriesDetectsV2PostData {
45
+ }
46
+ export type PatchQueriesDetectsV2ResponseMessage = BaseApiResponseMessage<PatchQueriesDetectsV2ApiResponse>;
47
+ export interface PatchQueriesDetectsV2RequestMessage extends BaseApiRequestMessage<PatchQueriesDetectsV2QueryParams, PatchQueriesDetectsV2PostData> {
48
+ api: DetectsRequestApi;
49
+ method: 'patchQueriesDetectsV2';
50
+ }
51
+ export type PostAggregatesDetectsGetV1QueryParams = BaseUrlParams;
52
+ export type PostAggregatesDetectsGetV1ApiResponse = ApiResponsePayload;
53
+ export interface PostAggregatesDetectsGetV1PostData {
54
+ }
55
+ export type PostAggregatesDetectsGetV1ResponseMessage = BaseApiResponseMessage<PostAggregatesDetectsGetV1ApiResponse>;
56
+ export interface PostAggregatesDetectsGetV1RequestMessage extends BaseApiRequestMessage<PostAggregatesDetectsGetV1QueryParams, PostAggregatesDetectsGetV1PostData> {
57
+ api: DetectsRequestApi;
58
+ method: 'postAggregatesDetectsGetV1';
59
+ }
60
+ export type PostEntitiesSummariesGetV1QueryParams = BaseUrlParams;
61
+ export type PostEntitiesSummariesGetV1ApiResponse = ApiResponsePayload;
62
+ export interface PostEntitiesSummariesGetV1PostData {
63
+ }
64
+ export type PostEntitiesSummariesGetV1ResponseMessage = BaseApiResponseMessage<PostEntitiesSummariesGetV1ApiResponse>;
65
+ export interface PostEntitiesSummariesGetV1RequestMessage extends BaseApiRequestMessage<PostEntitiesSummariesGetV1QueryParams, PostEntitiesSummariesGetV1PostData> {
66
+ api: DetectsRequestApi;
67
+ method: 'postEntitiesSummariesGetV1';
68
+ }
69
+ export interface PostEntitiesSuppressedDevicesV1QueryParams extends BaseUrlParams {
70
+ ids?: QueryParam;
71
+ }
72
+ export type PostEntitiesSuppressedDevicesV1ApiResponse = ApiResponsePayload;
73
+ export interface PostEntitiesSuppressedDevicesV1PostData {
74
+ }
75
+ export type PostEntitiesSuppressedDevicesV1ResponseMessage = BaseApiResponseMessage<PostEntitiesSuppressedDevicesV1ApiResponse>;
76
+ export interface PostEntitiesSuppressedDevicesV1RequestMessage extends BaseApiRequestMessage<PostEntitiesSuppressedDevicesV1QueryParams, PostEntitiesSuppressedDevicesV1PostData> {
77
+ api: DetectsRequestApi;
78
+ method: 'postEntitiesSuppressedDevicesV1';
79
+ }
80
+ export type DetectsApiRequestMessage = GetEntitiesSuppressedDevicesV1RequestMessage | PatchEntitiesDetectsV2RequestMessage | PatchQueriesDetectsV1RequestMessage | PatchQueriesDetectsV2RequestMessage | PostAggregatesDetectsGetV1RequestMessage | PostEntitiesSummariesGetV1RequestMessage | PostEntitiesSuppressedDevicesV1RequestMessage;
81
+ export type DetectsApiResponseMessage = GetEntitiesSuppressedDevicesV1ResponseMessage | PatchEntitiesDetectsV2ResponseMessage | PatchQueriesDetectsV1ResponseMessage | PatchQueriesDetectsV2ResponseMessage | PostAggregatesDetectsGetV1ResponseMessage | PostEntitiesSummariesGetV1ResponseMessage | PostEntitiesSuppressedDevicesV1ResponseMessage;
82
+ export declare class DetectsApiBridge {
83
+ private bridge;
84
+ constructor(bridge: Bridge);
85
+ getBridge(): Bridge<import("../../types").LocalData>;
86
+ getEntitiesSuppressedDevicesV1(urlParams?: GetEntitiesSuppressedDevicesV1QueryParams): Promise<GetEntitiesSuppressedDevicesV1ApiResponse>;
87
+ patchEntitiesDetectsV2(postBody: PatchEntitiesDetectsV2PostData, urlParams?: PatchEntitiesDetectsV2QueryParams): Promise<PatchEntitiesDetectsV2ApiResponse>;
88
+ patchQueriesDetectsV1(postBody: PatchQueriesDetectsV1PostData, urlParams?: PatchQueriesDetectsV1QueryParams): Promise<PatchQueriesDetectsV1ApiResponse>;
89
+ patchQueriesDetectsV2(postBody: PatchQueriesDetectsV2PostData, urlParams?: PatchQueriesDetectsV2QueryParams): Promise<PatchQueriesDetectsV2ApiResponse>;
90
+ postAggregatesDetectsGetV1(postBody: PostAggregatesDetectsGetV1PostData, urlParams?: PostAggregatesDetectsGetV1QueryParams): Promise<PostAggregatesDetectsGetV1ApiResponse>;
91
+ postEntitiesSummariesGetV1(postBody: PostEntitiesSummariesGetV1PostData, urlParams?: PostEntitiesSummariesGetV1QueryParams): Promise<PostEntitiesSummariesGetV1ApiResponse>;
92
+ postEntitiesSuppressedDevicesV1(postBody: PostEntitiesSuppressedDevicesV1PostData, urlParams?: PostEntitiesSuppressedDevicesV1QueryParams): Promise<PostEntitiesSuppressedDevicesV1ApiResponse>;
93
+ }