@binalyze/air-sdk 5.4.0 → 5.4.2

package/dist/types/acquisitions.d.ts

@@ -1,7 +1,7 @@
 import type { AcquisitionProfileDto, AssignedTaskDto } from '../generated/bindings';
-export interface AssignedTask extends AssignedTaskDto {
+export interface IAssignedTask extends AssignedTaskDto {
 }
-export interface AcquisitionsAPI {
+export interface IAcquisitionsAPI {
     getProfile: (options: {
         id: string;
     }) => Promise<AcquisitionProfileDto>;
@@ -11,5 +11,5 @@ export interface AcquisitionsAPI {
         endpointId: string;
         caseId?: string;
         taskName?: string;
-    }) => Promise<Array<AssignedTask>>;
+    }) => Promise<Array<IAssignedTask>>;
 }

package/dist/types/api-tokens.d.ts

@@ -1,5 +1,5 @@
 import type { ApiTokensCreateData, ApiTokensDeleteResponses, ApiTokensUpdateData } from '../generated/bindings';
-export interface ApiToken {
+export interface IApiToken {
     _id: string;
     name: string;
     description?: string | null;
@@ -11,7 +11,7 @@ export interface ApiToken {
     createdAt?: string;
     updatedAt?: string;
 }
-export interface ApiTokensPage extends Array<ApiToken> {
+export interface IApiTokensPage extends Array<IApiToken> {
     _pagination?: {
         totalEntityCount?: number;
         pageSize?: number;
@@ -19,24 +19,24 @@ export interface ApiTokensPage extends Array<ApiToken> {
         totalPageCount?: number;
     };
 }
-export interface GetApiTokensOptions {
+export interface IGetApiTokensOptions {
     organizationIds?: number | number[];
     pageNumber?: number;
     pageSize?: number;
     searchTerm?: string;
 }
-export interface ApiTokensAPI {
+export interface IApiTokensAPI {
     get: (options: {
         id: string;
-    }) => Promise<ApiToken>;
-    getMany: (options?: GetApiTokensOptions) => Promise<ApiTokensPage>;
+    }) => Promise<IApiToken>;
+    getMany: (options?: IGetApiTokensOptions) => Promise<IApiTokensPage>;
     create: (options: {
         input: ApiTokensCreateData['body'];
-    }) => Promise<ApiToken>;
+    }) => Promise<IApiToken>;
     update: (options: {
         id: string;
         input?: ApiTokensUpdateData['body'];
-    }) => Promise<ApiToken>;
+    }) => Promise<IApiToken>;
     delete: (options: {
         id: string;
     }) => Promise<ApiTokensDeleteResponses[200]>;

package/dist/types/assets.d.ts

@@ -1,5 +1,6 @@
 import type { AddTagsToEndpointsByFilterDto, AssetsAddTagsData, AssetsAssignIsolationTaskData, AssetsAssignIsolationTaskResponses, AssetsAssignRebootTaskData, AssetsAssignRebootTaskResponses, AssetsAssignShutdownTaskData, AssetsAssignShutdownTaskResponses, AssetsGetManyData, AssetsGetMany4Data, AssetsGetTasksData, AssetsRemoveTagsData, FilterEndpointDto, FilterEndpointTasksDto, RemoveTagsFromEndpointsByFilterDto, RebootEndpointDto, SetIsolationOnEndpointDto, ShutdownEndpointDto } from '../generated/bindings';
-export interface AssetEntity {
+import type { IReadonlyPage, IPaginationMetadata } from './common';
+export interface IAssetEntity {
     _id: string;
     name?: string;
     buildArch?: string;
@@ -43,16 +44,12 @@ export interface AssetEntity {
     versionUpdating?: boolean;
     managedStatus?: string;
 }
-export interface AssetsPage extends Array<AssetEntity> {
-    _pagination?: {
-        totalEntityCount?: number;
-        pageSize?: number;
-        currentPage?: number;
-        totalPageCount?: number;
-    };
+export interface IAssetsPage extends Array<IAssetEntity> {
+    _pagination?: IPaginationMetadata;
 }
-export type Asset = AssetEntity;
-export interface AssetTaskEntity {
+export type IReadonlyAssetsPage = IReadonlyPage<IAssetEntity>;
+export type Asset = IAssetEntity;
+export interface IAssetTaskEntity {
     _id: string;
     taskId?: string;
     name?: string;
@@ -75,34 +72,25 @@ export interface AssetTaskEntity {
     response?: Record<string, unknown>;
     reportUrl?: string;
 }
-export interface AssetTasksPage extends Array<AssetTaskEntity> {
-    _pagination?: {
-        totalEntityCount?: number;
-        pageSize?: number;
-        currentPage?: number;
-        totalPageCount?: number;
-    };
+export interface IAssetTasksPage extends Array<IAssetTaskEntity> {
+    _pagination?: IPaginationMetadata;
 }
+export type IReadonlyAssetTasksPage = IReadonlyPage<IAssetTaskEntity>;
 export type AssetAssignedTask = (AssetsAssignRebootTaskResponses[201] extends Array<infer R> ? R : never) | (AssetsAssignShutdownTaskResponses[201] extends Array<infer R> ? R : never) | (AssetsAssignIsolationTaskResponses[201] extends Array<infer R> ? R : never);
-export interface AssetAssignedTasksPage extends Array<AssetAssignedTaskEntity> {
-    _pagination?: {
-        totalEntityCount?: number;
-        pageSize?: number;
-        currentPage?: number;
-        totalPageCount?: number;
-    };
+export interface IAssetAssignedTasksPage extends Array<IAssetAssignedTaskEntity> {
+    _pagination?: IPaginationMetadata;
 }
-export interface GetAssetsOptions {
+export interface IGetAssetsOptions {
     pageNumber?: number;
     pageSize?: number;
     sortBy?: NonNullable<AssetsGetManyData['query']>['sortBy'];
     sortType?: NonNullable<AssetsGetManyData['query']>['sortType'];
     filter?: Partial<FilterEndpointDto>;
 }
-export interface GetAssetOptions {
+export interface IGetAssetOptions {
     id: AssetsGetMany4Data['path']['id'];
 }
-export interface GetAssetTasksOptions {
+export interface IGetAssetTasksOptions {
     id: AssetsGetTasksData['path']['id'];
     pageNumber?: number;
     pageSize?: number;
@@ -110,13 +98,13 @@ export interface GetAssetTasksOptions {
     sortType?: NonNullable<AssetsGetTasksData['query']>['sortType'];
     filter?: FilterEndpointTasksDto;
 }
-export interface UpdateAssetTagsOptions {
+export interface IUpdateAssetTagsOptions {
     filter?: Partial<FilterEndpointDto> & {
         organizationIds?: number[];
     };
     tags: AddTagsToEndpointsByFilterDto['tags'];
 }
-export interface RemoveAssetTagsOptions {
+export interface IRemoveAssetTagsOptions {
     filter?: Partial<FilterEndpointDto> & {
         organizationIds?: number[];
     };
@@ -130,13 +118,13 @@ export type AssignIsolationTaskOptions = Omit<SetIsolationOnEndpointDto, 'organi
 };
 export type AssignRebootTaskOptions = RebootEndpointDto;
 export type AssignShutdownTaskOptions = ShutdownEndpointDto;
-export interface AssetsAPI {
-    get: (options: GetAssetOptions) => Promise<Asset>;
-    getMany: (options?: GetAssetsOptions) => Promise<AssetsPage>;
-    getTasks: (options: GetAssetTasksOptions) => Promise<AssetTasksPage>;
-    addTags: (options: UpdateAssetTagsOptions) => Promise<AddTagsResult>;
-    removeTags: (options: RemoveAssetTagsOptions) => Promise<RemoveTagsResult>;
-    assignIsolationTask: (options: AssignIsolationTaskOptions) => Promise<AssetAssignedTasksPage>;
+export interface IAssetsAPI {
+    get: (options: IGetAssetOptions) => Promise<Asset>;
+    getMany: (options?: IGetAssetsOptions) => Promise<IAssetsPage>;
+    getTasks: (options: IGetAssetTasksOptions) => Promise<IAssetTasksPage>;
+    addTags: (options: IUpdateAssetTagsOptions) => Promise<IAddTagsResult>;
+    removeTags: (options: IRemoveAssetTagsOptions) => Promise<RemoveTagsResult>;
+    assignIsolationTask: (options: AssignIsolationTaskOptions) => Promise<IAssetAssignedTasksPage>;
     assignRebootTask: (options: AssignRebootTaskOptions) => Promise<AssetAssignedTask[]>;
     assignShutdownTask: (options: AssignShutdownTaskOptions) => Promise<AssetAssignedTask[]>;
 }
@@ -145,14 +133,14 @@ export type AssetsRemoveTagsPayload = AssetsRemoveTagsData['body'];
 export type AssetsAssignIsolationTaskPayload = AssetsAssignIsolationTaskData['body'];
 export type AssetsAssignRebootTaskPayload = AssetsAssignRebootTaskData['body'];
 export type AssetsAssignShutdownTaskPayload = AssetsAssignShutdownTaskData['body'];
-export interface AddTagsResult {
+export interface IAddTagsResult {
     success: boolean;
     statusCode?: number;
     message?: string;
     matchedCount?: number;
 }
-export type RemoveTagsResult = AddTagsResult;
-export interface AssetAssignedTaskEntity {
+export type RemoveTagsResult = IAddTagsResult;
+export interface IAssetAssignedTaskEntity {
     _id: string;
     name: string;
     organizationId: number;

package/dist/types/baseline.d.ts

@@ -1,36 +1,36 @@
 import type { AssignedTaskDto } from '../generated/bindings';
-export interface BaselineAssignedTask extends AssignedTaskDto {
+export interface IBaselineAssignedTask extends AssignedTaskDto {
     taskId: string;
     taskName?: string;
 }
-export interface BaselineAcquireFilter {
+export interface IBaselineAcquireFilter {
     organizationIds?: number[];
     includedEndpointIds?: string[];
     excludedEndpointIds?: string[];
     [key: string]: unknown;
 }
-export interface BaselineAcquireOptions {
-    filter: BaselineAcquireFilter;
+export interface IBaselineAcquireOptions {
+    filter: IBaselineAcquireFilter;
     caseId?: string;
 }
-export interface BaselineCompareOptions {
+export interface IBaselineCompareOptions {
     taskIds: string[];
     endpointId?: string;
     vendorDeviceId?: string;
     taskName?: string;
     caseId?: string;
 }
-export interface BaselineComparisonReportOptions {
+export interface IBaselineComparisonReportOptions {
     endpointId: string;
     taskId: string;
 }
-export interface BaselineComparisonReportByVendorDeviceIdOptions {
+export interface IBaselineComparisonReportByVendorDeviceIdOptions {
     vendorDeviceId: string;
     taskId: string;
 }
-export interface BaselineAPI {
-    acquire: (options: BaselineAcquireOptions) => Promise<BaselineAssignedTask[]>;
-    compare: (options: BaselineCompareOptions) => Promise<BaselineAssignedTask>;
-    getComparisonReport: (options: BaselineComparisonReportOptions) => Promise<string>;
-    getComparisonReportByVendorDeviceId: (options: BaselineComparisonReportByVendorDeviceIdOptions) => Promise<string>;
+export interface IBaselineAPI {
+    acquire: (options: IBaselineAcquireOptions) => Promise<IBaselineAssignedTask[]>;
+    compare: (options: IBaselineCompareOptions) => Promise<IBaselineAssignedTask>;
+    getComparisonReport: (options: IBaselineComparisonReportOptions) => Promise<string>;
+    getComparisonReportByVendorDeviceId: (options: IBaselineComparisonReportByVendorDeviceIdOptions) => Promise<string>;
 }

package/dist/types/cases.d.ts

@@ -1,34 +1,27 @@
-import type { CaseDto, CreateCaseDto, FilterCaseActivitiesDto, FilterCaseTasksDto, FilterCaseUsersDto, FilterUserCasesDto, FilterEndpointDto } from '../generated/bindings';
-import type { AssetsPage } from './assets';
-import type { TaskAssignmentsPage } from './tasks';
-export interface CaseEntity {
-    createdAt?: string;
-    updatedAt?: string;
-}
-export type Case = CaseDto & CaseEntity;
-export interface CasesPage extends Array<Case> {
-    _pagination?: {
-        totalEntityCount?: number;
-        pageSize?: number;
-        currentPage?: number;
-        totalPageCount?: number;
-    };
+import type { CaseResponseDto, CreateCaseDto, FilterCaseActivitiesDto, FilterCaseTasksDto, FilterCaseUsersDto, FilterUserCasesDto, FilterEndpointDto } from '../generated/bindings';
+import type { IAssetsPage } from './assets';
+import type { IReadonlyPage, IPaginationMetadata } from './common';
+import type { ITaskAssignmentsPage } from './tasks';
+export type Case = CaseResponseDto;
+export interface ICasesPage extends Array<Case> {
+    _pagination?: IPaginationMetadata;
 }
-export interface GetCasesOptions {
+export type IReadonlyCasesPage = IReadonlyPage<Case>;
+export interface IGetCasesOptions {
     pageNumber?: number;
     pageSize?: number;
     sortBy?: string;
     sortType?: 'ASC' | 'DESC';
     filter?: Partial<FilterUserCasesDto>;
 }
-export interface CasesAPI {
+export interface ICasesAPI {
     checkName: (options: {
         name: string;
     }) => Promise<boolean>;
     get: (options: {
         id: string;
     }) => Promise<Case>;
-    getMany: (options?: GetCasesOptions) => Promise<CasesPage>;
+    getMany: (options?: IGetCasesOptions) => Promise<ICasesPage>;
     changeOwner: (options: {
         id: string;
         newOwnerId: string;
@@ -44,42 +37,42 @@ export interface CasesAPI {
         pageNumber?: number;
         pageSize?: number;
         filter?: FilterCaseActivitiesDto;
-    }) => Promise<CaseActivitiesPage>;
+    }) => Promise<ICaseActivitiesPage>;
     getEndpoints: (options: {
         id: string;
         pageNumber?: number;
         pageSize?: number;
         filter?: Partial<FilterEndpointDto>;
-    }) => Promise<AssetsPage>;
+    }) => Promise<IAssetsPage>;
     getTasks: (options: {
         id: string;
         pageNumber?: number;
         pageSize?: number;
         filter?: FilterCaseTasksDto;
-    }) => Promise<TaskAssignmentsPage>;
+    }) => Promise<ITaskAssignmentsPage>;
     getUsers: (options: {
         id: string;
         pageNumber?: number;
         pageSize?: number;
         filter?: FilterCaseUsersDto;
-    }) => Promise<CaseUsersPage>;
+    }) => Promise<ICaseUsersPage>;
 }
 export type CreateCaseInput = Omit<CreateCaseDto, 'organizationId' | 'visibility' | 'assignedUserIds'> & {
     organizationId?: number;
     visibility?: NonNullable<CreateCaseDto['visibility']>;
     assignedUserIds?: CreateCaseDto['assignedUserIds'];
 };
-export interface CaseActivityOptions {
+export interface ICaseActivityOptions {
     username?: string;
     apiTokenName?: string;
     eventOrigin?: string;
     organizationIds?: number[];
 }
-export interface CaseActivityData {
+export interface ICaseActivityData {
     [key: string]: unknown;
     name?: string;
     caseId?: string;
-    options?: CaseActivityOptions;
+    options?: ICaseActivityOptions;
     organizationId?: number;
     organizationIds?: number[];
     ownerUser?: string;
@@ -93,24 +86,20 @@ export interface CaseActivityData {
     endpointId?: string;
     endpointName?: string;
 }
-export interface CaseActivityEntity {
+export interface ICaseActivityEntity {
     id: number;
     caseId: string;
     type: string;
     performedBy: string;
-    data: CaseActivityData;
+    data: ICaseActivityData;
     createdAt: string;
     description?: string | null;
 }
-export interface CaseActivitiesPage extends Array<CaseActivityEntity> {
-    _pagination?: {
-        totalEntityCount?: number;
-        pageSize?: number;
-        currentPage?: number;
-        totalPageCount?: number;
-    };
+export interface ICaseActivitiesPage extends Array<ICaseActivityEntity> {
+    _pagination?: IPaginationMetadata;
 }
-export interface CaseUserEntity {
+export type IReadonlyCaseActivitiesPage = IReadonlyPage<ICaseActivityEntity>;
+export interface ICaseUserEntity {
     _id: string;
     email?: string;
     username?: string;
@@ -133,11 +122,7 @@ export interface CaseUserEntity {
     updatedAt?: string;
     strategy?: string;
 }
-export interface CaseUsersPage extends Array<CaseUserEntity> {
-    _pagination?: {
-        totalEntityCount?: number;
-        pageSize?: number;
-        currentPage?: number;
-        totalPageCount?: number;
-    };
+export interface ICaseUsersPage extends Array<ICaseUserEntity> {
+    _pagination?: IPaginationMetadata;
 }
+export type IReadonlyCaseUsersPage = IReadonlyPage<ICaseUserEntity>;

package/dist/types/common.d.ts

@@ -0,0 +1,27 @@
+export interface IPaginationMetadata {
+    totalEntityCount?: number;
+    pageSize?: number;
+    currentPage?: number;
+    totalPageCount?: number;
+}
+export type IReadonlyPage<T> = ReadonlyArray<T> & {
+    _pagination?: IPaginationMetadata;
+};
+export interface ISDKError {
+    message: string;
+    statusCode?: number;
+    code?: string;
+}
+export type ResultSuccess<T> = {
+    success: true;
+    result: T;
+    statusCode: number;
+};
+export type ResultFailure = {
+    success: false;
+    result: null;
+    statusCode: number;
+    message: string;
+    code?: string;
+};
+export type Result<T> = ResultSuccess<T> | ResultFailure;

package/dist/types/common.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

package/dist/types/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/types/common.ts"],"names":[],"mappings":""}

package/dist/types/index.d.ts

@@ -9,3 +9,5 @@ export * from './organization';
 export * from './repositories';
 export * from './tasks';
 export * from './triage';
+export * from './common';
+export * from './investigation';

package/dist/types/index.js

@@ -25,4 +25,6 @@ __exportStar(require("./organization"), exports);
 __exportStar(require("./repositories"), exports);
 __exportStar(require("./tasks"), exports);
 __exportStar(require("./triage"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./investigation"), exports);
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,iDAA+B;AAC/B,2CAAyB;AACzB,+CAA6B;AAC7B,6CAA2B;AAC3B,0CAAwB;AACxB,6CAA2B;AAC3B,iDAA+B;AAC/B,iDAA+B;AAC/B,0CAAwB;AACxB,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,iDAA+B;AAC/B,2CAAyB;AACzB,+CAA6B;AAC7B,6CAA2B;AAC3B,0CAAwB;AACxB,6CAA2B;AAC3B,iDAA+B;AAC/B,iDAA+B;AAC/B,0CAAwB;AACxB,2CAAyB;AACzB,2CAAyB;AACzB,kDAAgC"}

package/dist/types/interact.d.ts

@@ -1,14 +1,14 @@
 import type { InteractShellAssignTaskData, InteractShellAssignTaskResponses, InteractSessionCloseData, InteractSessionCloseResponses, InteractSessionExecuteAsyncCommandData, InteractSessionExecuteAsyncCommandResponses, InteractSessionExecuteCommandData, InteractSessionExecuteCommandResponses, InteractSessionGetCommandMessageData, InteractSessionGetCommandMessageResponses, InteractSessionInterruptCommandData, InteractSessionInterruptCommandResponses } from '../generated/bindings';
-export interface InteractCommandOption {
+export interface IInteractCommandOption {
     name: string;
     abbreviations: string[];
     effect: string;
     required: boolean;
 }
-export interface InteractCommand {
+export interface IInteractCommand {
     command: string[];
     description?: string;
-    options: InteractCommandOption[];
+    options: IInteractCommandOption[];
     privilege: string;
     usage: string[];
 }
@@ -18,7 +18,7 @@ export type InteractAsyncCommandResult = InteractSessionExecuteAsyncCommandRespo
 export type InteractCommandMessage = InteractSessionGetCommandMessageResponses[200];
 export type InteractInterruptCommandResult = InteractSessionInterruptCommandResponses[200];
 export type InteractCloseSessionResult = InteractSessionCloseResponses[200];
-export interface CloseSessionResult {
+export interface ICloseSessionResult {
     success: boolean;
     sessionId?: string;
     statusCode?: number;
@@ -39,24 +39,24 @@ export type ExecuteInteractCommandOptions = InteractSessionExecuteCommandData['b
 export type ExecuteInteractAsyncCommandOptions = InteractSessionExecuteAsyncCommandData['body'] & {
     sessionId: InteractSessionExecuteAsyncCommandData['path']['sessionId'];
 };
-export interface GetInteractCommandMessageOptions {
+export interface IGetInteractCommandMessageOptions {
     sessionId: InteractSessionGetCommandMessageData['path']['sessionId'];
     messageId: InteractSessionGetCommandMessageData['path']['messageId'];
 }
-export interface InterruptInteractCommandOptions {
+export interface IInterruptInteractCommandOptions {
     sessionId: InteractSessionInterruptCommandData['path']['sessionId'];
     messageId: InteractSessionInterruptCommandData['path']['messageId'];
 }
-export interface CloseInteractSessionOptions {
+export interface ICloseInteractSessionOptions {
     sessionId: InteractSessionCloseData['path']['sessionId'];
 }
-export interface InteractAPI {
-    getCommands: () => Promise<InteractCommand[]>;
+export interface IInteractAPI {
+    getCommands: () => Promise<IInteractCommand[]>;
     createShellSession: (options: CreateInteractShellSessionOptions) => Promise<InteractShellSession>;
     executeCommand: (options: ExecuteInteractCommandOptions) => Promise<InteractCommandExecutionResult>;
     executeAsyncCommand: (options: ExecuteInteractAsyncCommandOptions) => Promise<InteractAsyncCommandResult>;
-    getCommandMessage: (options: GetInteractCommandMessageOptions) => Promise<InteractCommandMessage>;
-    interruptCommand: (options: InterruptInteractCommandOptions) => Promise<InteractInterruptCommandResult>;
-    closeSession: (options: CloseInteractSessionOptions) => Promise<CloseSessionResult>;
+    getCommandMessage: (options: IGetInteractCommandMessageOptions) => Promise<InteractCommandMessage>;
+    interruptCommand: (options: IInterruptInteractCommandOptions) => Promise<InteractInterruptCommandResult>;
+    closeSession: (options: ICloseInteractSessionOptions) => Promise<ICloseSessionResult>;
 }
 export {};

package/dist/types/investigation.d.ts

@@ -0,0 +1,75 @@
+import type { FilterInvestigationFindingsDtoWritable, FilterInvestigationActivitiesDtoWritable, InvestigationFindingsStructureResponseDto, InvestigationFindingsSummaryResponseDto, InvestigationMitreTacticDto, InvestigationActivityDto, InvestigationFindingDto } from '../generated/bindings';
+import type { PageWithPagination } from '../utils';
+export type InvestigationHubFindingsStructure = InvestigationFindingsStructureResponseDto;
+export type InvestigationHubFinding = InvestigationFindingDto;
+export type InvestigationHubFindings = PageWithPagination<InvestigationHubFinding>;
+export type InvestigationHubFindingsSummary = InvestigationFindingsSummaryResponseDto;
+export type InvestigationHubMitreTactic = InvestigationMitreTacticDto;
+export type InvestigationActivityData = {
+    flagId?: number;
+    source?: string;
+    assetId?: string;
+    evidence?: string;
+    flagName?: string;
+    objectId?: number;
+    platform?: string;
+    username?: string;
+    assetName?: string;
+    flagDescription?: string;
+    taskAssignmentId?: string;
+} & Record<string, unknown>;
+export type InvestigationHubActivity = Omit<InvestigationActivityDto, 'data'> & {
+    data: InvestigationActivityData;
+};
+export type InvestigationActivitiesPage = PageWithPagination<InvestigationHubActivity>;
+export interface IGetFindingsStructureOptions {
+    investigationId: string;
+}
+export interface IGetFindingsOptions {
+    investigationId: string;
+    assignmentIds?: string[];
+    /** alias accepted by wrapper; mapped to assignmentIds */
+    includedEndpointIds?: string[];
+    filter?: FilterInvestigationFindingsDtoWritable['filter'];
+    onlyExcludedFindings?: boolean;
+    skip?: number;
+    take?: number;
+    sort?: NonNullable<FilterInvestigationFindingsDtoWritable['sort']>;
+}
+export interface IGetFindingsSummaryOptions {
+    investigationId: string;
+    assignmentIds?: string[];
+    includedEndpointIds?: string[];
+    findingTypes?: string[];
+    flagIds?: number[];
+    findingCreatedBy?: ('DRONE' | 'USER')[];
+    mitreTechniqueIds?: string[];
+    mitreTacticIds?: string[];
+    dateTimeRange?: unknown;
+}
+export interface IGetMitreMatchesOptions {
+    investigationId: string;
+    assignmentIds?: string[];
+    includedEndpointIds?: string[];
+    findingTypes?: string[];
+    flagIds?: number[];
+    findingCreatedBy?: ('DRONE' | 'USER')[];
+    mitreTechniqueIds?: string[];
+    mitreTacticIds?: string[];
+    dateTimeRange?: unknown;
+}
+export interface IGetActivitiesOptions {
+    investigationId: string;
+    filter?: Partial<FilterInvestigationActivitiesDtoWritable>;
+    pageNumber?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortType?: 'ASC' | 'DESC';
+}
+export interface IInvestigationHubAPI {
+    getFindingsStructure: (options: IGetFindingsStructureOptions) => Promise<InvestigationHubFindingsStructure>;
+    getFindings: (options: IGetFindingsOptions) => Promise<InvestigationHubFindings>;
+    getFindingsSummary: (options: IGetFindingsSummaryOptions) => Promise<InvestigationHubFindingsSummary>;
+    getMitreMatches: (options: IGetMitreMatchesOptions) => Promise<InvestigationHubMitreTactic[]>;
+    getActivities: (options: IGetActivitiesOptions) => Promise<InvestigationActivitiesPage>;
+}

package/dist/types/investigation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=investigation.js.map

package/dist/types/investigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"investigation.js","sourceRoot":"","sources":["../../src/types/investigation.ts"],"names":[],"mappings":""}

package/dist/types/organization.d.ts

@@ -1,32 +1,23 @@
 import type { OrganizationsGetManyData, OrganizationGetResponses, OrganizationGetData, OrganizationCreateData, OrganizationCreateResponses, OrganizationUpdateData, OrganizationRemoveUsersData, OrganizationAssignUsersData, OrganizationRemoveTagsData, OrganizationAddTagsData, OrganizationGetUsersResponses, OrganizationUpdateShareableDeploymentStatusData, OrganizationUpdateDeploymentTokenData, FilterOrganizationUsersDto } from '../generated/bindings';
+import type { IPaginationMetadata } from './common';
 export type Organization = OrganizationGetResponses[200];
-export type OrganizationsPage = (OrganizationListItem[]) & {
-    _pagination?: {
-        totalEntityCount?: number;
-        pageSize?: number;
-        currentPage?: number;
-        totalPageCount?: number;
-    };
-};
+export interface IOrganizationsPage extends Array<OrganizationListItem> {
+    _pagination?: IPaginationMetadata;
+}
 export type OrganizationUser = OrganizationGetUsersResponses[200] extends infer T ? T extends {
     entities: Array<infer U>;
 } ? U : unknown : unknown;
-export type OrganizationUsersPage = (OrganizationUser[]) & {
-    _pagination?: {
-        totalEntityCount?: number;
-        pageSize?: number;
-        currentPage?: number;
-        totalPageCount?: number;
-    };
-};
+export interface IOrganizationUsersPage extends Array<OrganizationUser> {
+    _pagination?: IPaginationMetadata;
+}
 export type OrganizationListItem = OrganizationCreateResponses[201];
-export type AssignUsersResult = {
+export interface IAssignUsersResult {
     organization: Organization;
     requestedUserIds: string[];
     assignedUserIds: string[];
     notAssignedUserIds: string[];
-};
-export interface OrganizationAPI {
+}
+export interface IOrganizationAPI {
     addTags: (options: {
         id?: number;
         tags: OrganizationAddTagsData['body']['tags'];
@@ -34,7 +25,7 @@ export interface OrganizationAPI {
     assignUsers: (options: {
         id?: number;
         userIds: OrganizationAssignUsersData['body']['userIds'];
-    }) => Promise<AssignUsersResult>;
+    }) => Promise<IAssignUsersResult>;
     checkNameExists: (options: {
         name: string;
     }) => Promise<boolean>;
@@ -42,7 +33,7 @@ export interface OrganizationAPI {
         input: OrganizationCreateData['body'];
     }) => Promise<OrganizationListItem>;
     get: (options?: OrganizationGetData['path']) => Promise<Organization>;
-    getMany: (options?: OrganizationsGetManyData['query']) => Promise<OrganizationsPage>;
+    getMany: (options?: OrganizationsGetManyData['query']) => Promise<IOrganizationsPage>;
     getUsers: (options?: {
         id?: number;
         pageNumber?: number;
@@ -50,7 +41,7 @@ export interface OrganizationAPI {
         sortType?: 'ASC' | 'DESC';
         sortBy?: string;
         filter?: FilterOrganizationUsersDto;
-    }) => Promise<OrganizationUsersPage>;
+    }) => Promise<IOrganizationUsersPage>;
     removeTags: (options: {
         id?: number;
         tags: OrganizationRemoveTagsData['body']['tags'];