@binalyze/air-sdk 5.4.2 → 5.5.0

package/dist/sdk/typescript-axios/types.gen.d.ts

@@ -130,6 +130,10 @@ export type FilterEndpointDto = {
      * Filter endpoints excluded from updates
      */
     excludedFromUpdates?: boolean;
+    /**
+     * Filter by serial number
+     */
+    serialNumber?: string;
 };
 export type UpdateEndpointTagsDto = {
     [key: string]: unknown;
@@ -287,6 +291,10 @@ export type FilterEndpointWithTaskCountDto = {
      * Filter endpoints excluded from updates
      */
     excludedFromUpdates?: boolean;
+    /**
+     * Filter by serial number
+     */
+    serialNumber?: string;
 };
 export type ImportPpcasEndpointDto = {
     [key: string]: unknown;
@@ -428,36 +436,6 @@ export type TaskResponseDto = {
         [key: string]: unknown;
     } | null;
 };
-export type FilterTasksDto = {
-    /**
-     * Free text to search over tasks
-     */
-    searchTerm?: string;
-    /**
-     * Filter tasks by exact or partial name
-     */
-    name?: string;
-    /**
-     * Filter by task types
-     */
-    type?: Array<Array<unknown>>;
-    /**
-     * Filter by task source
-     */
-    source?: Array<Array<unknown>>;
-    /**
-     * Filter by task status
-     */
-    status?: Array<Array<unknown>>;
-    /**
-     * Filter by task execution type
-     */
-    executionType?: Array<Array<unknown>>;
-    /**
-     * Organization IDs to scope results
-     */
-    organizationIds: Array<Array<unknown>>;
-};
 export type TaskListItemDto = {
     /**
      * Unique task identifier
@@ -548,23 +526,38 @@ export type TaskListItemDto = {
      */
     updatedAt: string;
 };
-export type TasksPageDto = {
-    entities: Array<TaskListItemDto>;
-    totalEntityCount: number;
-    currentPage: number;
-    pageSize: number;
-    filters?: Array<{
-        [key: string]: unknown;
-    }> | null;
-    sortables: Array<string>;
-    organizations?: Array<{
-        [key: string]: unknown;
-    }> | null;
-    nextPage: number;
-    previousPage?: {
-        [key: string]: unknown;
-    } | null;
-    totalPageCount: number;
+export type PagingQueryResultDto = {
+    [key: string]: unknown;
+};
+export type FilterTasksDto = {
+    /**
+     * Free text to search over tasks
+     */
+    searchTerm?: string;
+    /**
+     * Filter tasks by exact or partial name
+     */
+    name?: string;
+    /**
+     * Filter by task types
+     */
+    type?: Array<Array<unknown>>;
+    /**
+     * Filter by task source
+     */
+    source?: Array<Array<unknown>>;
+    /**
+     * Filter by task status
+     */
+    status?: Array<Array<unknown>>;
+    /**
+     * Filter by task execution type
+     */
+    executionType?: Array<Array<unknown>>;
+    /**
+     * Organization IDs to scope results
+     */
+    organizationIds: Array<Array<unknown>>;
 };
 export type TaskNameDto = {
     [key: string]: unknown;
@@ -669,7 +662,7 @@ export type FilterEndpointTasksDto = {
     /**
      * Task type list
      */
-    type?: Array<'triage' | 'acquisition' | 'shutdown' | 'reboot' | 'uninstall' | 'isolation' | 'cancel' | 'investigation' | 'log-retrieval' | 'auto-tagging' | 'version-update' | 'offline-acquisition' | 'offline-triage' | 'migration' | 'interact-shell' | 'baseline-comparison' | 'baseline-acquisition' | 'agent-deployment' | 'acquire-image' | 'purge-local-data' | 'retry-upload' | 'calculate-hash' | 'drone-analysis' | 'full-text-search'>;
+    type?: Array<'triage' | 'acquisition' | 'shutdown' | 'reboot' | 'uninstall' | 'isolation' | 'cancel' | 'investigation' | 'log-retrieval' | 'auto-tagging' | 'version-update' | 'offline-acquisition' | 'offline-triage' | 'migration' | 'interact-shell' | 'baseline-comparison' | 'baseline-acquisition' | 'agent-deployment' | 'acquire-image' | 'purge-local-data' | 'retry-upload' | 'calculate-hash' | 'drone-analysis' | 'full-text-search' | 'image-evidence-acquisition'>;
     /**
      * Task status list
      */
@@ -717,7 +710,7 @@ export type FilterTaskAssignmentsDto = {
     /**
      * Limit assignments to specific endpoint identifiers
      */
-    endpointIds?: Array<string>;
+    droneAnalysisAssignmentId?: Array<string>;
 };
 export type TaskAssignmentListItemDto = {
     /**
@@ -1801,9 +1794,6 @@ export type FilterTriageRuleTagRequestDto = {
      */
     withCount?: boolean;
 };
-export type PagingQueryResultDto = {
-    [key: string]: unknown;
-};
 export type SmbRepositoryDto = {
     [key: string]: unknown;
 };
@@ -2964,6 +2954,44 @@ export type CreateInteractCommandSnippetRequestDto = {
      * The organization IDs that can access this snippet
      */
     organizationIds: Array<number>;
+    /**
+     * The tag IDs to associate with this snippet
+     */
+    tagIds?: Array<string>;
+};
+export type InteractCommandSnippetTagResponseDto = {
+    /**
+     * The ID of the tag
+     */
+    _id: string;
+    /**
+     * The name of the tag
+     */
+    name: string;
+    /**
+     * The organization IDs that can access this tag. Empty array means all organizations
+     */
+    organizationIds: Array<number>;
+    /**
+     * The username of the user who created the tag
+     */
+    createdBy: string;
+    /**
+     * The count of the tag
+     */
+    count: number | null;
+    /**
+     * The creation date of the tag
+     */
+    createdAt: string;
+    /**
+     * The last update date of the tag
+     */
+    updatedAt: string;
+    /**
+     * Whether the tag is deletable
+     */
+    deletable: boolean;
 };
 export type InteractCommandSnippetResponseDto = {
     /**
@@ -3006,6 +3034,10 @@ export type InteractCommandSnippetResponseDto = {
      * Whether the command snippet is deletable
      */
     deletable: boolean;
+    /**
+     * The tags associated with this snippet
+     */
+    tags: Array<InteractCommandSnippetTagResponseDto>;
 };
 export type FilterInteractCommandSnippetsRequestDto = {
     /**
@@ -3028,6 +3060,10 @@ export type FilterInteractCommandSnippetsRequestDto = {
      * Filter by organization IDs
      */
     organizationIds: Array<number>;
+    /**
+     * Filter by tag IDs
+     */
+    tagIds?: Array<string>;
 };
 export type UpdateInteractCommandSnippetRequestDto = {
     /**
@@ -3050,6 +3086,10 @@ export type UpdateInteractCommandSnippetRequestDto = {
      * The organization IDs that can access this snippet
      */
     organizationIds: Array<number>;
+    /**
+     * The tag IDs to associate with this snippet
+     */
+    tagIds?: Array<string>;
 };
 export type BulkDeleteInteractCommandSnippetsRequestDto = {
     /**
@@ -3057,6 +3097,25 @@ export type BulkDeleteInteractCommandSnippetsRequestDto = {
      */
     ids: Array<string>;
 };
+export type CreateInteractCommandSnippetTagRequestDto = {
+    /**
+     * The name of the tag
+     */
+    name: string;
+    /**
+     * The organization IDs that can access this tag. Empty array means all organizations
+     */
+    organizationIds?: Array<number>;
+};
+export type FilterInteractCommandSnippetTagsRequestDto = {
+    [key: string]: unknown;
+};
+export type UpdateInteractCommandSnippetTagRequestDto = {
+    /**
+     * The name of the tag
+     */
+    name: string;
+};
 export type UploadFilePartDto = {
     [key: string]: unknown;
 };
@@ -3536,6 +3595,9 @@ export type GetInvestigationTimelineCountByGlobalFilterDto = {
 export type ExportInvestigationTimelineEventsDto = {
     [key: string]: unknown;
 };
+export type FilterInvestigationTaskExecutionLogsDto = {
+    [key: string]: unknown;
+};
 export type UpdateRelayServerTagsDto = {
     [key: string]: unknown;
 };
@@ -3958,6 +4020,131 @@ export type CloudAcquisitionProfileFilterRequestDto = {
      */
     allOrganizations?: boolean;
 };
+export type ImageAcquisitionEvidencesDto = {
+    [key: string]: unknown;
+};
+export type CreateImageEvidenceAcquisitionProfileRequestDto = {
+    /**
+     * The name of the image evidence acquisition profile
+     */
+    name: string;
+    /**
+     * The organization IDs to associate with the image evidence acquisition profile
+     */
+    organizationIds: Array<string>;
+    /**
+     * Whether to acquire all available image evidence files
+     */
+    allFiles?: boolean;
+    /**
+     * List of image evidence paths to be acquired (ignored if allFiles is true)
+     */
+    paths?: Array<string>;
+    /**
+     * The image evidence types to acquire (ignored if allFiles is true)
+     */
+    imageAcquisitionEvidences?: ImageAcquisitionEvidencesDto;
+};
+export type ImageEvidenceAcquisitionProfileResponseDto = {
+    /**
+     * The ID of the item
+     */
+    _id: string;
+    /**
+     * The name of the image evidence acquisition profile
+     */
+    name: string;
+    /**
+     * Whether to acquire all available image evidence files
+     */
+    allFiles: boolean;
+    /**
+     * List of image evidence paths to be acquired
+     */
+    paths: Array<string>;
+    /**
+     * The selected image evidence types to acquire
+     */
+    imageAcquisitionEvidences: ImageAcquisitionEvidencesDto;
+    /**
+     * Username of the user who created the profile
+     */
+    createdBy: string;
+    /**
+     * List of organization IDs associated with the profile
+     */
+    organizationIds: Array<string>;
+    /**
+     * Average execution time in minutes
+     */
+    averageTime: number;
+    /**
+     * Username of the last user who used the profile
+     */
+    lastUsedBy?: string;
+    /**
+     * Timestamp when the profile was last used
+     */
+    lastUsedAt?: string;
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+    /**
+     * Whether the profile can be deleted
+     */
+    deletable: boolean;
+};
+export type UpdateImageEvidenceAcquisitionProfileRequestDto = {
+    /**
+     * The name of the image evidence acquisition profile
+     */
+    name: string;
+    /**
+     * The organization IDs to associate with the image evidence acquisition profile
+     */
+    organizationIds: Array<string>;
+    /**
+     * Whether to acquire all available image evidence files
+     */
+    allFiles?: boolean;
+    /**
+     * List of image evidence paths to be acquired (ignored if allFiles is true)
+     */
+    paths?: Array<string>;
+    /**
+     * The image evidence types to acquire (ignored if allFiles is true)
+     */
+    imageAcquisitionEvidences?: ImageAcquisitionEvidencesDto;
+};
+export type BulkDeleteImageEvidenceAcquisitionProfileRequestDto = {
+    /**
+     * Array of image evidence acquisition profile IDs to delete
+     */
+    ids: Array<string>;
+};
+export type ImageEvidenceAcquisitionProfileFilterRequestDto = {
+    /**
+     * Filter image evidence acquisition profiles by name
+     */
+    name?: string;
+    /**
+     * Search term to filter image evidence acquisition profiles
+     */
+    searchTerm?: string;
+    /**
+     * Filter by organization IDs
+     */
+    organizationIds?: Array<string>;
+    /**
+     * Include profiles from all organizations
+     */
+    allOrganizations?: boolean;
+};
 export type DateRangeDtoWritable = {
     [key: string]: unknown;
 };
@@ -3994,6 +4181,9 @@ export type UpdateEndpointConnectionRouteDtoWritable = {
 export type FilterTagsDtoWritable = {
     [key: string]: unknown;
 };
+export type PagingQueryResultDtoWritable = {
+    [key: string]: unknown;
+};
 export type TaskNameDtoWritable = {
     [key: string]: unknown;
 };
@@ -4239,9 +4429,6 @@ export type TriageEndpointFilterDtoWritable = {
 export type OffNetworkTriageTaskDtoWritable = {
     [key: string]: unknown;
 };
-export type PagingQueryResultDtoWritable = {
-    [key: string]: unknown;
-};
 export type SmbRepositoryDtoWritable = {
     [key: string]: unknown;
 };
@@ -4332,6 +4519,9 @@ export type FilterLibraryFilesDtoWritable = {
 export type UploadLibraryFileDtoWritable = {
     [key: string]: unknown;
 };
+export type FilterInteractCommandSnippetTagsRequestDtoWritable = {
+    [key: string]: unknown;
+};
 export type UploadFilePartDtoWritable = {
     [key: string]: unknown;
 };
@@ -4470,6 +4660,9 @@ export type GetInvestigationTimelineCountByGlobalFilterDtoWritable = {
 export type ExportInvestigationTimelineEventsDtoWritable = {
     [key: string]: unknown;
 };
+export type FilterInvestigationTaskExecutionLogsDtoWritable = {
+    [key: string]: unknown;
+};
 export type UpdateRelayServerTagsDtoWritable = {
     [key: string]: unknown;
 };
@@ -4551,6 +4744,9 @@ export type UpdateScheduledFullTextSearchTaskDtoWritable = {
 export type M365AcquisitionsDtoWritable = {
     [key: string]: unknown;
 };
+export type ImageAcquisitionEvidencesDtoWritable = {
+    [key: string]: unknown;
+};
 export type LoggerDownloadLogsDirData = {
     body?: never;
     path?: never;
@@ -5447,7 +5643,7 @@ export type TasksGetManyResponses = {
     /**
      * Tasks retrieved successfully
      */
-    200: TasksPageDto;
+    200: PagingQueryResultDto;
 };
 export type TasksGetManyResponse = TasksGetManyResponses[keyof TasksGetManyResponses];
 export type TaskRenameTaskData = {
@@ -8657,6 +8853,79 @@ export type InteractCommandSnippetsBulkDeleteResponses = {
      */
     200: unknown;
 };
+export type InteractCommandSnippetTagsGetManyData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Number of items per page
+         */
+        pageSize?: number;
+        /**
+         * Page number to retrieve
+         */
+        pageNumber?: number;
+        /**
+         * Sort direction
+         */
+        sortType?: 'ASC' | 'DESC';
+        /**
+         * Field name to sort by
+         */
+        sortBy?: string;
+        filter: FilterInteractCommandSnippetTagsRequestDtoWritable;
+    };
+    url: '/api/public/interact/command-snippet-tags';
+};
+export type InteractCommandSnippetTagsGetManyResponses = {
+    /**
+     * The records have been successfully retrieved.
+     */
+    200: PagingQueryResultDto;
+};
+export type InteractCommandSnippetTagsGetManyResponse = InteractCommandSnippetTagsGetManyResponses[keyof InteractCommandSnippetTagsGetManyResponses];
+export type InteractCommandSnippetTagsCreateData = {
+    body: CreateInteractCommandSnippetTagRequestDto;
+    path?: never;
+    query?: never;
+    url: '/api/public/interact/command-snippet-tags';
+};
+export type InteractCommandSnippetTagsCreateResponses = {
+    /**
+     * The record has been successfully created.
+     */
+    200: InteractCommandSnippetTagResponseDto;
+};
+export type InteractCommandSnippetTagsCreateResponse = InteractCommandSnippetTagsCreateResponses[keyof InteractCommandSnippetTagsCreateResponses];
+export type InteractCommandSnippetTagsDeleteData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/public/interact/command-snippet-tags/{id}';
+};
+export type InteractCommandSnippetTagsDeleteResponses = {
+    /**
+     * The record has been successfully deleted.
+     */
+    200: unknown;
+};
+export type InteractCommandSnippetTagsUpdateData = {
+    body: UpdateInteractCommandSnippetTagRequestDto;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/public/interact/command-snippet-tags/{id}';
+};
+export type InteractCommandSnippetTagsUpdateResponses = {
+    /**
+     * The record has been successfully updated.
+     */
+    200: InteractCommandSnippetTagResponseDto;
+};
+export type InteractCommandSnippetTagsUpdateResponse = InteractCommandSnippetTagsUpdateResponses[keyof InteractCommandSnippetTagsUpdateResponses];
 export type MultipartUploadInitializeHeadData = {
     body?: never;
     path?: never;
@@ -9869,6 +10138,30 @@ export type InvestigationTimelineCreateExportRequestForTimelineData = {
 export type InvestigationTimelineCreateExportRequestForTimelineResponses = {
     201: unknown;
 };
+export type InvestigationTaskExecutionLogGetTaskExecutionLogsData = {
+    body?: never;
+    path: {
+        investigationId: string;
+    };
+    query?: never;
+    url: '/api/public/investigation-hub/investigations/{investigationId}/task-execution-log-stats';
+};
+export type InvestigationTaskExecutionLogGetTaskExecutionLogsResponses = {
+    200: unknown;
+};
+export type InvestigationTaskExecutionLogFilterTaskExecutionLogsData = {
+    body: FilterInvestigationTaskExecutionLogsDtoWritable;
+    path: {
+        investigationId: string;
+        platform: string;
+        taskExecutionLogType: string;
+    };
+    query?: never;
+    url: '/api/public/investigation-hub/investigations/{investigationId}/{platform}/{taskExecutionLogType}/task-execution-logs';
+};
+export type InvestigationTaskExecutionLogFilterTaskExecutionLogsResponses = {
+    201: unknown;
+};
 export type RelayServerUpdateTagsData = {
     body: UpdateRelayServerTagsDtoWritable;
     path?: never;
@@ -10799,6 +11092,115 @@ export type CloudAcquisitionProfilesUpdateResponses = {
     200: CloudAcquisitionProfileResponseDto;
 };
 export type CloudAcquisitionProfilesUpdateResponse = CloudAcquisitionProfilesUpdateResponses[keyof CloudAcquisitionProfilesUpdateResponses];
+export type ImageEvidenceAcquisitionProfilesGetManyData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Number of items per page
+         */
+        pageSize?: number;
+        /**
+         * Page number to retrieve
+         */
+        pageNumber?: number;
+        /**
+         * Sort direction
+         */
+        sortType?: 'ASC' | 'DESC';
+        /**
+         * Field name to sort by
+         */
+        sortBy?: string;
+        filter: ImageEvidenceAcquisitionProfileFilterRequestDto;
+    };
+    url: '/api/public/image-evidence-acquisition-profiles';
+};
+export type ImageEvidenceAcquisitionProfilesGetManyResponses = {
+    /**
+     * The image evidence acquisition profiles have been successfully retrieved.
+     */
+    200: PagingQueryResultDto;
+};
+export type ImageEvidenceAcquisitionProfilesGetManyResponse = ImageEvidenceAcquisitionProfilesGetManyResponses[keyof ImageEvidenceAcquisitionProfilesGetManyResponses];
+export type ImageEvidenceAcquisitionProfilesCreateData = {
+    body: CreateImageEvidenceAcquisitionProfileRequestDto;
+    path?: never;
+    query?: never;
+    url: '/api/public/image-evidence-acquisition-profiles';
+};
+export type ImageEvidenceAcquisitionProfilesCreateResponses = {
+    /**
+     * The image evidence acquisition profile has been successfully created.
+     */
+    200: ImageEvidenceAcquisitionProfileResponseDto;
+};
+export type ImageEvidenceAcquisitionProfilesCreateResponse = ImageEvidenceAcquisitionProfilesCreateResponses[keyof ImageEvidenceAcquisitionProfilesCreateResponses];
+export type ImageEvidenceAcquisitionProfilesDeleteData = {
+    body?: never;
+    path: {
+        /**
+         * The unique identifier of the image evidence acquisition profile
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/public/image-evidence-acquisition-profiles/{id}';
+};
+export type ImageEvidenceAcquisitionProfilesDeleteResponses = {
+    /**
+     * The image evidence acquisition profile by ID has been successfully deleted.
+     */
+    200: unknown;
+};
+export type ImageEvidenceAcquisitionProfilesGetOneData = {
+    body?: never;
+    path: {
+        /**
+         * The unique identifier of the image evidence acquisition profile
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/public/image-evidence-acquisition-profiles/{id}';
+};
+export type ImageEvidenceAcquisitionProfilesGetOneResponses = {
+    /**
+     * The image evidence acquisition profile has been successfully retrieved.
+     */
+    200: ImageEvidenceAcquisitionProfileResponseDto;
+};
+export type ImageEvidenceAcquisitionProfilesGetOneResponse = ImageEvidenceAcquisitionProfilesGetOneResponses[keyof ImageEvidenceAcquisitionProfilesGetOneResponses];
+export type ImageEvidenceAcquisitionProfilesUpdateData = {
+    body: UpdateImageEvidenceAcquisitionProfileRequestDto;
+    path: {
+        /**
+         * The unique identifier of the image evidence acquisition profile
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/public/image-evidence-acquisition-profiles/{id}';
+};
+export type ImageEvidenceAcquisitionProfilesUpdateResponses = {
+    /**
+     * The image evidence acquisition profile has been successfully updated.
+     */
+    200: ImageEvidenceAcquisitionProfileResponseDto;
+};
+export type ImageEvidenceAcquisitionProfilesUpdateResponse = ImageEvidenceAcquisitionProfilesUpdateResponses[keyof ImageEvidenceAcquisitionProfilesUpdateResponses];
+export type ImageEvidenceAcquisitionProfilesDeleteBulkData = {
+    body: BulkDeleteImageEvidenceAcquisitionProfileRequestDto;
+    path?: never;
+    query?: never;
+    url: '/api/public/image-evidence-acquisition-profiles/bulk-delete';
+};
+export type ImageEvidenceAcquisitionProfilesDeleteBulkResponses = {
+    /**
+     * The image evidence acquisition profiles have been successfully deleted.
+     */
+    200: unknown;
+};
 export type ClientOptions = {
     baseURL: 'https://dev-air.com' | (string & {});
 };

package/dist/types/interact.d.ts

@@ -50,6 +50,31 @@ export interface IInterruptInteractCommandOptions {
 export interface ICloseInteractSessionOptions {
     sessionId: InteractSessionCloseData['path']['sessionId'];
 }
+export interface IWaitForSessionOptions {
+    sessionId: string;
+    taskId: string;
+    /**
+     * Timeout in seconds. If 0 or undefined, waits indefinitely.
+     */
+    timeoutSeconds?: number;
+    /**
+     * Poll interval in milliseconds. Defaults to 60000 (1 minute).
+     */
+    pollIntervalMs?: number;
+}
+export type WaitForSessionStatus = 'live' | 'completed' | 'cancelled' | 'failed' | 'timeout';
+export interface IWaitForSessionResult {
+    sessionId: string;
+    taskId: string;
+    status: WaitForSessionStatus;
+    message: string;
+    taskStatus?: string;
+    taskType?: string;
+    organizationId?: number;
+    createdAt?: string;
+    updatedAt?: string;
+    error?: string;
+}
 export interface IInteractAPI {
     getCommands: () => Promise<IInteractCommand[]>;
     createShellSession: (options: CreateInteractShellSessionOptions) => Promise<InteractShellSession>;
@@ -58,5 +83,6 @@ export interface IInteractAPI {
     getCommandMessage: (options: IGetInteractCommandMessageOptions) => Promise<InteractCommandMessage>;
     interruptCommand: (options: IInterruptInteractCommandOptions) => Promise<InteractInterruptCommandResult>;
     closeSession: (options: ICloseInteractSessionOptions) => Promise<ICloseSessionResult>;
+    waitForSession: (options: IWaitForSessionOptions) => Promise<IWaitForSessionResult>;
 }
 export {};