@crowdstrike/foundry-js 0.8.2 → 0.10.0

package/dist/abstraction/cloud-function.d.ts

@@ -19,13 +19,22 @@ interface GetParameters {
 export declare class CloudFunction<DATA extends LocalData = LocalData> {
     private readonly falcon;
     private readonly definition;
-    static GET: "GET";
-    static POST: "POST";
-    static PATCH: "PATCH";
-    static PUT: "PUT";
-    static DELETE: "DELETE";
+    private static GET;
+    private static POST;
+    private static PATCH;
+    private static PUT;
+    private static DELETE;
+    /**
+     * @internal
+     */
     pollTimeout: number;
+    /**
+     * @internal
+     */
     intervalId?: number;
+    /**
+     * @internal
+     */
     constructor(falcon: FalconApi<DATA>, definition: CloudFunctionDefinition);
     private execute;
     private getExecutionResult;

package/dist/abstraction/collection.d.ts

@@ -4,6 +4,10 @@ interface CollectionDefinition {
     collection: string;
 }
 interface CollectionSearchDefinition {
+    /**
+     * Falcon Query Language (FQL) to filter the requested collections
+     * @see https://falcon.crowdstrike.com/documentation/page/d3c84a1b/falcon-query-language-fql
+     */
     filter: string;
     offset: string;
     sort: string;
@@ -13,9 +17,34 @@ export declare class Collection<DATA extends LocalData = LocalData> {
     private readonly falcon;
     private readonly definition;
     constructor(falcon: FalconApi<DATA>, definition: CollectionDefinition);
+    /**
+     * Write data to the collection
+     *
+     * @param key
+     * @param data
+     * @returns
+     */
     write(key: string, data: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Read the data for the given `key`
+     *
+     * @param key
+     * @returns
+     */
     read(key: string): Promise<unknown>;
+    /**
+     * Delete the data for the given `key`
+     *
+     * @param key
+     * @returns
+     */
     delete(key: string): Promise<unknown>;
+    /**
+     * Search for data
+     *
+     * @param searchDefinition
+     * @returns
+     */
     search({ filter, offset, sort, limit, }: CollectionSearchDefinition): Promise<unknown>;
 }
 export {};

package/dist/abstraction/logscale.d.ts

@@ -8,8 +8,27 @@ interface WriteProperties {
 export declare class Logscale<DATA extends LocalData = LocalData> {
     private readonly falcon;
     constructor(falcon: FalconApi<DATA>);
+    /**
+     * Write data to LogScale
+     *
+     * @param data
+     * @param properties
+     * @returns
+     */
     write(data: LogscaleRequestMessage['payload']['data'], properties: WriteProperties): Promise<unknown>;
-    query(data: LogscaleRequestMessage['payload']['data']): Promise<unknown>;
-    savedQuery(data: LogscaleRequestMessage['payload']['data']): Promise<unknown>;
+    /**
+     * Execute a dynamic query
+     *
+     * @param query
+     * @returns Promise that resolves with the data
+     */
+    query(query: LogscaleRequestMessage['payload']['data']): Promise<unknown>;
+    /**
+     * Execute a saved query
+     *
+     * @param savedQuery
+     * @returns
+     */
+    savedQuery(savedQuery: LogscaleRequestMessage['payload']['data']): Promise<unknown>;
 }
 export {};

package/dist/api.d.ts

@@ -7,37 +7,120 @@ import { Collection } from './abstraction/collection';
 import { Logscale } from './abstraction/logscale';
 import { Navigation } from './lib/navigation';
 import { UI } from './lib/ui';
-import type { CloudFunctionDefinition, FileUploadType, LocalData, PayloadForFileUploadType, ResponseForFileUploadType } from './types';
+import type { CloudFunctionDefinition, LocalData } from './types';
 interface EventMap<DATA extends LocalData> {
     data: DATA;
     broadcast: unknown;
 }
-export default class FalconApi<DATA extends LocalData = LocalData> extends FalconPublicApis {
+/**
+ * This is the main class and only entrypoint for engaging with the Falcon APIs from an Foundry UI extension or page.
+ *
+ * At the very minimum, you would have to instantiate the class and connect to the Falcon Console:
+ *
+ * ```js
+ * import FalconApi from '@crowdstrike/foundry-js';
+ *
+ * const api = new FalconApi();
+ *
+ * await api.connect();
+ * ```
+ *
+ */
+export default class FalconApi<DATA extends LocalData = LocalData> {
+    /**
+     * @internal
+     */
+    isConnected: boolean;
+    /**
+     * An event emitter that allows you to subscribe to events issued by the Falcon Console.
+     *
+     * Currently supported event types:
+     * * `data`: fires when {@link data} is updated.
+     * * `broadcast`: this event is received when another extension of the same app has send a `broadcast` event via {@link sendBroadcast}.
+     *
+     * ```js
+     * api.events.on('data', (newData) => console.log('new data received:', newData));
+     * ```
+     */
     events: Emittery<EventMap<DATA>, EventMap<DATA> & import("emittery").OmnipresentEventData, DATA extends undefined ? "data" : never>;
+    /**
+     * The "local data" that your extension receives from the Falcon Console. This can vary depending on the state of the Falcon Console and the socket of the extension.
+     *
+     * At the very least it will contain the data specified by the {@link LocalData} interface.
+     */
     data?: DATA;
+    /**
+     * @internal
+     */
     bridge: Bridge<DATA>;
+    /**
+     * Namespace for all the {@link FalconPublicApis | Falcon Cloud APIs} you have access to with this SDK.
+     */
+    api: FalconPublicApis;
+    /**
+     * The {@link UI} class contains methods to invoke UI features within the main Falcon Console.
+     */
     ui: UI<DATA>;
     private resizeTracker?;
     private cloudFunctions;
     private apiIntegrations;
     private collections;
+    /**
+     * Connect to the main Falcon Console from within your UI extension.
+     *
+     * This establishes a connection to send messages between the extension and the Falcon Console. Only when established you will be able to call other APIs.
+     */
     connect(): Promise<void>;
+    /**
+     * The ID of the Foundry app this UI extension belongs to.
+     */
     get appId(): string | undefined;
+    /**
+     * Sending broadcast messages is a mechanism for allowing communication between different UI extensions, when they are displayed at the same time.
+     * When sending a broadcast message, other extensions need to listen for the `broadcast` event on the {@link events} event emitter.
+     *
+     * Note that broadcast messages are only dispatched between UI extensions of the same app!
+     *
+     * @param payload the data you want to send to other UI extensions
+     */
     sendBroadcast(payload: unknown): void;
-    uploadFile<TYPE extends FileUploadType>(fileUploadType: TYPE, initialData?: PayloadForFileUploadType<TYPE>): Promise<ResponseForFileUploadType<TYPE> | undefined>;
     private handleDataUpdate;
     private handleBroadcastMessage;
     private handleLivereloadMessage;
     private updateTheme;
+    /**
+     * Create a {@link CloudFunction} to integrate with Falcon's "Function as a Service" platform.
+     *
+     * @param definition
+     * @returns
+     */
     cloudFunction(definition: CloudFunctionDefinition): CloudFunction<DATA>;
+    /**
+     * Create an {@link ApiIntegration} to call external APIs.
+     *
+     * @param defintition
+     * @returns
+     */
     apiIntegration({ definitionId, operationId, }: {
         operationId: string;
         definitionId?: string;
     }): ApiIntegration<DATA>;
+    /**
+     * Create a {@link Collection} to write to and query Falcon's custom storage service.
+     *
+     * @param definition
+     * @returns
+     */
     collection({ collection }: {
         collection: string;
     }): Collection<DATA>;
+    /**
+     * The {@link Navigation} class provides functionality to navigate to other pages.
+     */
     get navigation(): Navigation<DATA>;
+    /**
+     * The {@link Logscale} class allows you to read and write to your custom LogScale repository.
+     */
     get logscale(): Logscale<DATA>;
     destroy(): void;
 }

package/dist/apis/available-apis.d.ts

@@ -5,4 +5,4 @@
  * DO NOT EDIT DIRECTLY
  *
  **/
-export type ApiIdentifier = 'actors' | 'alerts' | 'detects' | 'devices' | 'fwmgr' | 'incidents' | 'mitre' | 'plugins' | 'remoteResponse' | 'userManagement' | 'workflows' | 'customobjects' | 'faasGateway' | 'loggingapi';
+export type ApiIdentifier = 'alerts' | 'detects' | 'devices' | 'fwmgr' | 'incidents' | 'mitre' | 'plugins' | 'remoteResponse' | 'userManagement' | 'workflows' | 'customobjects' | 'faasGateway' | 'loggingapi';

package/dist/apis/devices/index.d.ts

@@ -36,6 +36,16 @@ export interface GetAggregatesBucketsV1RequestMessage extends BaseApiRequestMess
     api: DevicesRequestApi;
     method: 'getAggregatesBucketsV1';
 }
+export interface GetAggregatesFgaTagPrefixCountsV1QueryParams extends BaseUrlParams {
+    prefix: QueryParam;
+    limit?: QueryParam;
+}
+export type GetAggregatesFgaTagPrefixCountsV1ApiResponse = ApiResponsePayload;
+export type GetAggregatesFgaTagPrefixCountsV1ResponseMessage = BaseApiResponseMessage<GetAggregatesFgaTagPrefixCountsV1ApiResponse>;
+export interface GetAggregatesFgaTagPrefixCountsV1RequestMessage extends BaseApiRequestMessage<GetAggregatesFgaTagPrefixCountsV1QueryParams> {
+    api: DevicesRequestApi;
+    method: 'getAggregatesFgaTagPrefixCountsV1';
+}
 export interface GetAggregatesTagPrefixCountsV1QueryParams extends BaseUrlParams {
     prefix: QueryParam;
     limit?: QueryParam;
@@ -46,6 +56,15 @@ export interface GetAggregatesTagPrefixCountsV1RequestMessage extends BaseApiReq
     api: DevicesRequestApi;
     method: 'getAggregatesTagPrefixCountsV1';
 }
+export interface GetEntitiesFgaGroupsV1QueryParams extends BaseUrlParams {
+    ids: QueryParam;
+}
+export type GetEntitiesFgaGroupsV1ApiResponse = ApiResponsePayload;
+export type GetEntitiesFgaGroupsV1ResponseMessage = BaseApiResponseMessage<GetEntitiesFgaGroupsV1ApiResponse>;
+export interface GetEntitiesFgaGroupsV1RequestMessage extends BaseApiRequestMessage<GetEntitiesFgaGroupsV1QueryParams> {
+    api: DevicesRequestApi;
+    method: 'getEntitiesFgaGroupsV1';
+}
 export interface GetEntitiesGroupsV1QueryParams extends BaseUrlParams {
     ids: QueryParam;
 }
@@ -55,22 +74,6 @@ export interface GetEntitiesGroupsV1RequestMessage extends BaseApiRequestMessage
     api: DevicesRequestApi;
     method: 'getEntitiesGroupsV1';
 }
-export interface GetEntitiesReleasesV1QueryParams extends BaseUrlParams {
-    ids: QueryParam;
-}
-export type GetEntitiesReleasesV1ApiResponse = ApiResponsePayload;
-export type GetEntitiesReleasesV1ResponseMessage = BaseApiResponseMessage<GetEntitiesReleasesV1ApiResponse>;
-export interface GetEntitiesReleasesV1RequestMessage extends BaseApiRequestMessage<GetEntitiesReleasesV1QueryParams> {
-    api: DevicesRequestApi;
-    method: 'getEntitiesReleasesV1';
-}
-export type GetEntitiesRespondV1QueryParams = BaseUrlParams;
-export type GetEntitiesRespondV1ApiResponse = ApiResponsePayload;
-export type GetEntitiesRespondV1ResponseMessage = BaseApiResponseMessage<GetEntitiesRespondV1ApiResponse>;
-export interface GetEntitiesRespondV1RequestMessage extends BaseApiRequestMessage<GetEntitiesRespondV1QueryParams> {
-    api: DevicesRequestApi;
-    method: 'getEntitiesRespondV1';
-}
 export interface GetQueriesAvailableGroupsV1QueryParams extends BaseUrlParams {
     policyId?: QueryParam;
     policyType?: QueryParam;
@@ -133,6 +136,18 @@ export interface GetQueriesDevicesV2RequestMessage extends BaseApiRequestMessage
     api: DevicesRequestApi;
     method: 'getQueriesDevicesV2';
 }
+export interface GetQueriesFgaGroupsV1QueryParams extends BaseUrlParams {
+    filter?: string;
+    limit?: QueryParam;
+    offset?: QueryParam;
+    sort?: QueryParam;
+}
+export type GetQueriesFgaGroupsV1ApiResponse = ApiResponsePayload;
+export type GetQueriesFgaGroupsV1ResponseMessage = BaseApiResponseMessage<GetQueriesFgaGroupsV1ApiResponse>;
+export interface GetQueriesFgaGroupsV1RequestMessage extends BaseApiRequestMessage<GetQueriesFgaGroupsV1QueryParams> {
+    api: DevicesRequestApi;
+    method: 'getQueriesFgaGroupsV1';
+}
 export interface GetQueriesGroupsV1QueryParams extends BaseUrlParams {
     filter?: string;
     limit?: QueryParam;
@@ -174,6 +189,17 @@ export interface PostAggregatesDevicesGetV1RequestMessage extends BaseApiRequest
     api: DevicesRequestApi;
     method: 'postAggregatesDevicesGetV1';
 }
+export interface PostAggregatesFgaHostsGetV1QueryParams extends BaseUrlParams {
+    groupId?: QueryParam;
+}
+export type PostAggregatesFgaHostsGetV1ApiResponse = ApiResponsePayload;
+export interface PostAggregatesFgaHostsGetV1PostData {
+}
+export type PostAggregatesFgaHostsGetV1ResponseMessage = BaseApiResponseMessage<PostAggregatesFgaHostsGetV1ApiResponse>;
+export interface PostAggregatesFgaHostsGetV1RequestMessage extends BaseApiRequestMessage<PostAggregatesFgaHostsGetV1QueryParams, PostAggregatesFgaHostsGetV1PostData> {
+    api: DevicesRequestApi;
+    method: 'postAggregatesFgaHostsGetV1';
+}
 export type PostCombinedDevicesLoginHistoryV1QueryParams = BaseUrlParams;
 export type PostCombinedDevicesLoginHistoryV1ApiResponse = ApiResponsePayload;
 export interface PostCombinedDevicesLoginHistoryV1PostData {
@@ -183,6 +209,15 @@ export interface PostCombinedDevicesLoginHistoryV1RequestMessage extends BaseApi
     api: DevicesRequestApi;
     method: 'postCombinedDevicesLoginHistoryV1';
 }
+export type PostCombinedFgaHostsLoginHistoryV1QueryParams = BaseUrlParams;
+export type PostCombinedFgaHostsLoginHistoryV1ApiResponse = ApiResponsePayload;
+export interface PostCombinedFgaHostsLoginHistoryV1PostData {
+}
+export type PostCombinedFgaHostsLoginHistoryV1ResponseMessage = BaseApiResponseMessage<PostCombinedFgaHostsLoginHistoryV1ApiResponse>;
+export interface PostCombinedFgaHostsLoginHistoryV1RequestMessage extends BaseApiRequestMessage<PostCombinedFgaHostsLoginHistoryV1QueryParams, PostCombinedFgaHostsLoginHistoryV1PostData> {
+    api: DevicesRequestApi;
+    method: 'postCombinedFgaHostsLoginHistoryV1';
+}
 export interface PostEntitiesDevicesActionsV4QueryParams extends BaseUrlParams {
     actionName?: QueryParam;
 }
@@ -223,6 +258,24 @@ export interface PostEntitiesDevicesV2RequestMessage extends BaseApiRequestMessa
     api: DevicesRequestApi;
     method: 'postEntitiesDevicesV2';
 }
+export type PostEntitiesFgaHostsReportsV1QueryParams = BaseUrlParams;
+export type PostEntitiesFgaHostsReportsV1ApiResponse = ApiResponsePayload;
+export interface PostEntitiesFgaHostsReportsV1PostData {
+}
+export type PostEntitiesFgaHostsReportsV1ResponseMessage = BaseApiResponseMessage<PostEntitiesFgaHostsReportsV1ApiResponse>;
+export interface PostEntitiesFgaHostsReportsV1RequestMessage extends BaseApiRequestMessage<PostEntitiesFgaHostsReportsV1QueryParams, PostEntitiesFgaHostsReportsV1PostData> {
+    api: DevicesRequestApi;
+    method: 'postEntitiesFgaHostsReportsV1';
+}
+export type PostEntitiesFgaHostsV1QueryParams = BaseUrlParams;
+export type PostEntitiesFgaHostsV1ApiResponse = ApiResponsePayload;
+export interface PostEntitiesFgaHostsV1PostData {
+}
+export type PostEntitiesFgaHostsV1ResponseMessage = BaseApiResponseMessage<PostEntitiesFgaHostsV1ApiResponse>;
+export interface PostEntitiesFgaHostsV1RequestMessage extends BaseApiRequestMessage<PostEntitiesFgaHostsV1QueryParams, PostEntitiesFgaHostsV1PostData> {
+    api: DevicesRequestApi;
+    method: 'postEntitiesFgaHostsV1';
+}
 export interface PostEntitiesGroupActionsV1QueryParams extends BaseUrlParams {
     ids: QueryParam;
     actionName: QueryParam;
@@ -245,43 +298,36 @@ export interface PostEntitiesGroupsV1RequestMessage extends BaseApiRequestMessag
     api: DevicesRequestApi;
     method: 'postEntitiesGroupsV1';
 }
-export interface PostEntitiesReleasesV1QueryParams extends BaseUrlParams {
-    ids: QueryParam;
-}
-export type PostEntitiesReleasesV1ApiResponse = ApiResponsePayload;
-export interface PostEntitiesReleasesV1PostData {
-}
-export type PostEntitiesReleasesV1ResponseMessage = BaseApiResponseMessage<PostEntitiesReleasesV1ApiResponse>;
-export interface PostEntitiesReleasesV1RequestMessage extends BaseApiRequestMessage<PostEntitiesReleasesV1QueryParams, PostEntitiesReleasesV1PostData> {
-    api: DevicesRequestApi;
-    method: 'postEntitiesReleasesV1';
-}
-export type DevicesApiRequestMessage = DeleteEntitiesGroupsV1RequestMessage | GetAggregatesBucketsV1RequestMessage | GetAggregatesTagPrefixCountsV1RequestMessage | GetEntitiesGroupsV1RequestMessage | GetEntitiesReleasesV1RequestMessage | GetEntitiesRespondV1RequestMessage | GetQueriesAvailableGroupsV1RequestMessage | GetQueriesDevicesHiddenV2RequestMessage | GetQueriesDevicesV1RequestMessage | GetQueriesDevicesV2RequestMessage | GetQueriesGroupsV1RequestMessage | PatchEntitiesDevicesTagsV2RequestMessage | PatchEntitiesGroupsV1RequestMessage | PostAggregatesDevicesGetV1RequestMessage | PostCombinedDevicesLoginHistoryV1RequestMessage | PostEntitiesDevicesActionsV4RequestMessage | PostEntitiesDevicesHiddenActionsV4RequestMessage | PostEntitiesDevicesReportsV1RequestMessage | PostEntitiesDevicesV2RequestMessage | PostEntitiesGroupActionsV1RequestMessage | PostEntitiesGroupsV1RequestMessage | PostEntitiesReleasesV1RequestMessage;
-export type DevicesApiResponseMessage = DeleteEntitiesGroupsV1ResponseMessage | GetAggregatesBucketsV1ResponseMessage | GetAggregatesTagPrefixCountsV1ResponseMessage | GetEntitiesGroupsV1ResponseMessage | GetEntitiesReleasesV1ResponseMessage | GetEntitiesRespondV1ResponseMessage | GetQueriesAvailableGroupsV1ResponseMessage | GetQueriesDevicesHiddenV2ResponseMessage | GetQueriesDevicesV1ResponseMessage | GetQueriesDevicesV2ResponseMessage | GetQueriesGroupsV1ResponseMessage | PatchEntitiesDevicesTagsV2ResponseMessage | PatchEntitiesGroupsV1ResponseMessage | PostAggregatesDevicesGetV1ResponseMessage | PostCombinedDevicesLoginHistoryV1ResponseMessage | PostEntitiesDevicesActionsV4ResponseMessage | PostEntitiesDevicesHiddenActionsV4ResponseMessage | PostEntitiesDevicesReportsV1ResponseMessage | PostEntitiesDevicesV2ResponseMessage | PostEntitiesGroupActionsV1ResponseMessage | PostEntitiesGroupsV1ResponseMessage | PostEntitiesReleasesV1ResponseMessage;
+export type DevicesApiRequestMessage = DeleteEntitiesGroupsV1RequestMessage | GetAggregatesBucketsV1RequestMessage | GetAggregatesFgaTagPrefixCountsV1RequestMessage | GetAggregatesTagPrefixCountsV1RequestMessage | GetEntitiesFgaGroupsV1RequestMessage | GetEntitiesGroupsV1RequestMessage | GetQueriesAvailableGroupsV1RequestMessage | GetQueriesDevicesHiddenV2RequestMessage | GetQueriesDevicesV1RequestMessage | GetQueriesDevicesV2RequestMessage | GetQueriesFgaGroupsV1RequestMessage | GetQueriesGroupsV1RequestMessage | PatchEntitiesDevicesTagsV2RequestMessage | PatchEntitiesGroupsV1RequestMessage | PostAggregatesDevicesGetV1RequestMessage | PostAggregatesFgaHostsGetV1RequestMessage | PostCombinedDevicesLoginHistoryV1RequestMessage | PostCombinedFgaHostsLoginHistoryV1RequestMessage | PostEntitiesDevicesActionsV4RequestMessage | PostEntitiesDevicesHiddenActionsV4RequestMessage | PostEntitiesDevicesReportsV1RequestMessage | PostEntitiesDevicesV2RequestMessage | PostEntitiesFgaHostsReportsV1RequestMessage | PostEntitiesFgaHostsV1RequestMessage | PostEntitiesGroupActionsV1RequestMessage | PostEntitiesGroupsV1RequestMessage;
+export type DevicesApiResponseMessage = DeleteEntitiesGroupsV1ResponseMessage | GetAggregatesBucketsV1ResponseMessage | GetAggregatesFgaTagPrefixCountsV1ResponseMessage | GetAggregatesTagPrefixCountsV1ResponseMessage | GetEntitiesFgaGroupsV1ResponseMessage | GetEntitiesGroupsV1ResponseMessage | GetQueriesAvailableGroupsV1ResponseMessage | GetQueriesDevicesHiddenV2ResponseMessage | GetQueriesDevicesV1ResponseMessage | GetQueriesDevicesV2ResponseMessage | GetQueriesFgaGroupsV1ResponseMessage | GetQueriesGroupsV1ResponseMessage | PatchEntitiesDevicesTagsV2ResponseMessage | PatchEntitiesGroupsV1ResponseMessage | PostAggregatesDevicesGetV1ResponseMessage | PostAggregatesFgaHostsGetV1ResponseMessage | PostCombinedDevicesLoginHistoryV1ResponseMessage | PostCombinedFgaHostsLoginHistoryV1ResponseMessage | PostEntitiesDevicesActionsV4ResponseMessage | PostEntitiesDevicesHiddenActionsV4ResponseMessage | PostEntitiesDevicesReportsV1ResponseMessage | PostEntitiesDevicesV2ResponseMessage | PostEntitiesFgaHostsReportsV1ResponseMessage | PostEntitiesFgaHostsV1ResponseMessage | PostEntitiesGroupActionsV1ResponseMessage | PostEntitiesGroupsV1ResponseMessage;
 export declare class DevicesApiBridge {
     private bridge;
     constructor(bridge: Bridge);
     getBridge(): Bridge<import("../../types").LocalData>;
     deleteEntitiesGroupsV1(urlParams: DeleteEntitiesGroupsV1QueryParams): Promise<DeleteEntitiesGroupsV1ApiResponse>;
     getAggregatesBucketsV1(urlParams: GetAggregatesBucketsV1QueryParams): Promise<GetAggregatesBucketsV1ApiResponse>;
+    getAggregatesFgaTagPrefixCountsV1(urlParams: GetAggregatesFgaTagPrefixCountsV1QueryParams): Promise<GetAggregatesFgaTagPrefixCountsV1ApiResponse>;
     getAggregatesTagPrefixCountsV1(urlParams: GetAggregatesTagPrefixCountsV1QueryParams): Promise<GetAggregatesTagPrefixCountsV1ApiResponse>;
+    getEntitiesFgaGroupsV1(urlParams: GetEntitiesFgaGroupsV1QueryParams): Promise<GetEntitiesFgaGroupsV1ApiResponse>;
     getEntitiesGroupsV1(urlParams: GetEntitiesGroupsV1QueryParams): Promise<GetEntitiesGroupsV1ApiResponse>;
-    getEntitiesReleasesV1(urlParams: GetEntitiesReleasesV1QueryParams): Promise<GetEntitiesReleasesV1ApiResponse>;
-    getEntitiesRespondV1(urlParams?: GetEntitiesRespondV1QueryParams): Promise<GetEntitiesRespondV1ApiResponse>;
     getQueriesAvailableGroupsV1(urlParams?: GetQueriesAvailableGroupsV1QueryParams): Promise<GetQueriesAvailableGroupsV1ApiResponse>;
     getQueriesDevicesHiddenV2(urlParams?: GetQueriesDevicesHiddenV2QueryParams): Promise<GetQueriesDevicesHiddenV2ApiResponse>;
     getQueriesDevicesV1(urlParams?: GetQueriesDevicesV1QueryParams): Promise<GetQueriesDevicesV1ApiResponse>;
     getQueriesDevicesV2(urlParams?: GetQueriesDevicesV2QueryParams): Promise<GetQueriesDevicesV2ApiResponse>;
+    getQueriesFgaGroupsV1(urlParams?: GetQueriesFgaGroupsV1QueryParams): Promise<GetQueriesFgaGroupsV1ApiResponse>;
     getQueriesGroupsV1(urlParams?: GetQueriesGroupsV1QueryParams): Promise<GetQueriesGroupsV1ApiResponse>;
     patchEntitiesDevicesTagsV2(postBody: PatchEntitiesDevicesTagsV2PostData, urlParams?: PatchEntitiesDevicesTagsV2QueryParams): Promise<PatchEntitiesDevicesTagsV2ApiResponse>;
     patchEntitiesGroupsV1(postBody: PatchEntitiesGroupsV1PostData, urlParams?: PatchEntitiesGroupsV1QueryParams): Promise<PatchEntitiesGroupsV1ApiResponse>;
     postAggregatesDevicesGetV1(postBody: PostAggregatesDevicesGetV1PostData, urlParams?: PostAggregatesDevicesGetV1QueryParams): Promise<PostAggregatesDevicesGetV1ApiResponse>;
+    postAggregatesFgaHostsGetV1(postBody: PostAggregatesFgaHostsGetV1PostData, urlParams?: PostAggregatesFgaHostsGetV1QueryParams): Promise<PostAggregatesFgaHostsGetV1ApiResponse>;
     postCombinedDevicesLoginHistoryV1(postBody: PostCombinedDevicesLoginHistoryV1PostData, urlParams?: PostCombinedDevicesLoginHistoryV1QueryParams): Promise<PostCombinedDevicesLoginHistoryV1ApiResponse>;
+    postCombinedFgaHostsLoginHistoryV1(postBody: PostCombinedFgaHostsLoginHistoryV1PostData, urlParams?: PostCombinedFgaHostsLoginHistoryV1QueryParams): Promise<PostCombinedFgaHostsLoginHistoryV1ApiResponse>;
     postEntitiesDevicesActionsV4(postBody: PostEntitiesDevicesActionsV4PostData, urlParams?: PostEntitiesDevicesActionsV4QueryParams): Promise<PostEntitiesDevicesActionsV4ApiResponse>;
     postEntitiesDevicesHiddenActionsV4(postBody: PostEntitiesDevicesHiddenActionsV4PostData, urlParams?: PostEntitiesDevicesHiddenActionsV4QueryParams): Promise<PostEntitiesDevicesHiddenActionsV4ApiResponse>;
     postEntitiesDevicesReportsV1(postBody: PostEntitiesDevicesReportsV1PostData, urlParams?: PostEntitiesDevicesReportsV1QueryParams): Promise<PostEntitiesDevicesReportsV1ApiResponse>;
     postEntitiesDevicesV2(postBody: PostEntitiesDevicesV2PostData, urlParams?: PostEntitiesDevicesV2QueryParams): Promise<PostEntitiesDevicesV2ApiResponse>;
+    postEntitiesFgaHostsReportsV1(postBody: PostEntitiesFgaHostsReportsV1PostData, urlParams?: PostEntitiesFgaHostsReportsV1QueryParams): Promise<PostEntitiesFgaHostsReportsV1ApiResponse>;
+    postEntitiesFgaHostsV1(postBody: PostEntitiesFgaHostsV1PostData, urlParams?: PostEntitiesFgaHostsV1QueryParams): Promise<PostEntitiesFgaHostsV1ApiResponse>;
     postEntitiesGroupActionsV1(postBody: PostEntitiesGroupActionsV1PostData, urlParams: PostEntitiesGroupActionsV1QueryParams): Promise<PostEntitiesGroupActionsV1ApiResponse>;
     postEntitiesGroupsV1(postBody: PostEntitiesGroupsV1PostData, urlParams?: PostEntitiesGroupsV1QueryParams): Promise<PostEntitiesGroupsV1ApiResponse>;
-    postEntitiesReleasesV1(postBody: PostEntitiesReleasesV1PostData, urlParams: PostEntitiesReleasesV1QueryParams): Promise<PostEntitiesReleasesV1ApiResponse>;
 }

package/dist/apis/mitre/index.d.ts

@@ -12,20 +12,20 @@ export type CommonApiResponseMessage = BaseApiResponseMessage<ApiResponsePayload
 export interface CommonApiRequestMessage extends BaseApiRequestMessage<BaseUrlParams, unknown> {
     api: MitreRequestApi;
 }
-export interface GetEntitiesMatrixV1QueryParams extends BaseUrlParams {
+export interface GetIntelMitreEntitiesMatrixV1QueryParams extends BaseUrlParams {
     version?: QueryParam;
 }
-export type GetEntitiesMatrixV1ApiResponse = ApiResponsePayload;
-export type GetEntitiesMatrixV1ResponseMessage = BaseApiResponseMessage<GetEntitiesMatrixV1ApiResponse>;
-export interface GetEntitiesMatrixV1RequestMessage extends BaseApiRequestMessage<GetEntitiesMatrixV1QueryParams> {
+export type GetIntelMitreEntitiesMatrixV1ApiResponse = ApiResponsePayload;
+export type GetIntelMitreEntitiesMatrixV1ResponseMessage = BaseApiResponseMessage<GetIntelMitreEntitiesMatrixV1ApiResponse>;
+export interface GetIntelMitreEntitiesMatrixV1RequestMessage extends BaseApiRequestMessage<GetIntelMitreEntitiesMatrixV1QueryParams> {
     api: MitreRequestApi;
-    method: 'getEntitiesMatrixV1';
+    method: 'getIntelMitreEntitiesMatrixV1';
 }
-export type MitreApiRequestMessage = GetEntitiesMatrixV1RequestMessage;
-export type MitreApiResponseMessage = GetEntitiesMatrixV1ResponseMessage;
+export type MitreApiRequestMessage = GetIntelMitreEntitiesMatrixV1RequestMessage;
+export type MitreApiResponseMessage = GetIntelMitreEntitiesMatrixV1ResponseMessage;
 export declare class MitreApiBridge {
     private bridge;
     constructor(bridge: Bridge);
     getBridge(): Bridge<import("../../types").LocalData>;
-    getEntitiesMatrixV1(urlParams?: GetEntitiesMatrixV1QueryParams): Promise<GetEntitiesMatrixV1ApiResponse>;
+    getIntelMitreEntitiesMatrixV1(urlParams?: GetIntelMitreEntitiesMatrixV1QueryParams): Promise<GetIntelMitreEntitiesMatrixV1ApiResponse>;
 }

package/dist/apis/public-api.d.ts

@@ -5,7 +5,6 @@
  * DO NOT EDIT DIRECTLY
  *
  **/
-import { ActorsApiBridge } from './actors';
 import { AlertsApiBridge } from './alerts';
 import { CustomobjectsApiBridge } from './customobjects';
 import { DetectsApiBridge } from './detects';
@@ -19,22 +18,33 @@ import { PluginsApiBridge } from './plugins';
 import { RemoteResponseApiBridge } from './remote-response';
 import { UserManagementApiBridge } from './user-management';
 import { WorkflowsApiBridge } from './workflows';
-import type { Bridge } from '../bridge';
-export default abstract class FalconPublicApis {
-    isConnected: boolean;
-    abstract bridge: Bridge<any>;
-    get actors(): ActorsApiBridge;
+import type FalconApi from '../api';
+export default class FalconPublicApis {
+    private api;
+    constructor(api: FalconApi<any>);
     get alerts(): AlertsApiBridge;
     get detects(): DetectsApiBridge;
     get devices(): DevicesApiBridge;
     get fwmgr(): FwmgrApiBridge;
     get incidents(): IncidentsApiBridge;
     get mitre(): MitreApiBridge;
+    /**
+     * @internal
+     */
     get plugins(): PluginsApiBridge;
     get remoteResponse(): RemoteResponseApiBridge;
     get userManagement(): UserManagementApiBridge;
     get workflows(): WorkflowsApiBridge;
+    /**
+     * @internal
+     */
     get customobjects(): CustomobjectsApiBridge;
+    /**
+     * @internal
+     */
     get faasGateway(): FaasGatewayApiBridge;
+    /**
+     * @internal
+     */
     get loggingapi(): LoggingapiApiBridge;
 }

package/dist/apis/remote-response/index.d.ts

@@ -63,15 +63,6 @@ export interface PostEntitiesAppCommandV1RequestMessage extends BaseApiRequestMe
     api: RemoteResponseRequestApi;
     method: 'postEntitiesAppCommandV1';
 }
-export type PostEntitiesAppRefreshSessionsV1QueryParams = BaseUrlParams;
-export type PostEntitiesAppRefreshSessionsV1ApiResponse = ApiResponsePayload;
-export interface PostEntitiesAppRefreshSessionsV1PostData {
-}
-export type PostEntitiesAppRefreshSessionsV1ResponseMessage = BaseApiResponseMessage<PostEntitiesAppRefreshSessionsV1ApiResponse>;
-export interface PostEntitiesAppRefreshSessionsV1RequestMessage extends BaseApiRequestMessage<PostEntitiesAppRefreshSessionsV1QueryParams, PostEntitiesAppRefreshSessionsV1PostData> {
-    api: RemoteResponseRequestApi;
-    method: 'postEntitiesAppRefreshSessionsV1';
-}
 export interface PostEntitiesAppSessionsV1QueryParams extends BaseUrlParams {
     timeout?: QueryParam;
     timeoutDuration?: QueryParam;
@@ -93,8 +84,8 @@ export interface PostEntitiesPutFilesV1RequestMessage extends BaseApiRequestMess
     api: RemoteResponseRequestApi;
     method: 'postEntitiesPutFilesV1';
 }
-export type RemoteResponseApiRequestMessage = DeleteEntitiesPutFilesV1RequestMessage | GetEntitiesAppCommandV1RequestMessage | GetEntitiesPutFilesV2RequestMessage | GetQueriesPutFilesV1RequestMessage | PostEntitiesAppCommandV1RequestMessage | PostEntitiesAppRefreshSessionsV1RequestMessage | PostEntitiesAppSessionsV1RequestMessage;
-export type RemoteResponseApiResponseMessage = DeleteEntitiesPutFilesV1ResponseMessage | GetEntitiesAppCommandV1ResponseMessage | GetEntitiesPutFilesV2ResponseMessage | GetQueriesPutFilesV1ResponseMessage | PostEntitiesAppCommandV1ResponseMessage | PostEntitiesAppRefreshSessionsV1ResponseMessage | PostEntitiesAppSessionsV1ResponseMessage;
+export type RemoteResponseApiRequestMessage = DeleteEntitiesPutFilesV1RequestMessage | GetEntitiesAppCommandV1RequestMessage | GetEntitiesPutFilesV2RequestMessage | GetQueriesPutFilesV1RequestMessage | PostEntitiesAppCommandV1RequestMessage | PostEntitiesAppSessionsV1RequestMessage;
+export type RemoteResponseApiResponseMessage = DeleteEntitiesPutFilesV1ResponseMessage | GetEntitiesAppCommandV1ResponseMessage | GetEntitiesPutFilesV2ResponseMessage | GetQueriesPutFilesV1ResponseMessage | PostEntitiesAppCommandV1ResponseMessage | PostEntitiesAppSessionsV1ResponseMessage;
 export declare class RemoteResponseApiBridge {
     private bridge;
     constructor(bridge: Bridge);
@@ -104,6 +95,5 @@ export declare class RemoteResponseApiBridge {
     getEntitiesPutFilesV2(urlParams: GetEntitiesPutFilesV2QueryParams): Promise<GetEntitiesPutFilesV2ApiResponse>;
     getQueriesPutFilesV1(urlParams?: GetQueriesPutFilesV1QueryParams): Promise<GetQueriesPutFilesV1ApiResponse>;
     postEntitiesAppCommandV1(postBody: PostEntitiesAppCommandV1PostData, urlParams?: PostEntitiesAppCommandV1QueryParams): Promise<PostEntitiesAppCommandV1ApiResponse>;
-    postEntitiesAppRefreshSessionsV1(postBody: PostEntitiesAppRefreshSessionsV1PostData, urlParams?: PostEntitiesAppRefreshSessionsV1QueryParams): Promise<PostEntitiesAppRefreshSessionsV1ApiResponse>;
     postEntitiesAppSessionsV1(postBody: PostEntitiesAppSessionsV1PostData, urlParams?: PostEntitiesAppSessionsV1QueryParams): Promise<PostEntitiesAppSessionsV1ApiResponse>;
 }