@binalyze/air-sdk 0.2.0 → 4.46.0

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

@@ -41,27 +41,27 @@ export type FilterEndpointDto = {
     /**
      * Managed status list
      */
-    managedStatus?: Array<string>;
+    managedStatus?: Array<Array<unknown>>;
     /**
      * Isolation status list
      */
-    isolationStatus?: Array<string>;
+    isolationStatus?: Array<Array<unknown>>;
     /**
      * Platform list
      */
-    platform?: Array<string>;
+    platform?: Array<Array<unknown>>;
     /**
      * Endpoint issue list
      */
-    issue?: Array<string>;
+    issue?: Array<Array<unknown>>;
     /**
      * Online status list
      */
-    onlineStatus?: Array<string>;
+    onlineStatus?: Array<Array<unknown>>;
     /**
      * Tags list
      */
-    tags?: Array<string>;
+    tags?: Array<Array<unknown>>;
     /**
      * Agent version
      */
@@ -73,15 +73,15 @@ export type FilterEndpointDto = {
     /**
      * Included endpoint IDs
      */
-    includedEndpointIds?: Array<string>;
+    includedEndpointIds?: Array<Array<unknown>>;
     /**
      * Excluded endpoint IDs
      */
-    excludedEndpointIds?: Array<string>;
+    excludedEndpointIds?: Array<Array<unknown>>;
     /**
      * Organization IDs (comma separated)
      */
-    organizationIds: string;
+    organizationIds: Array<string>;
     /**
      * Connection route id
      */
@@ -97,11 +97,11 @@ export type FilterEndpointDto = {
     /**
      * Filter by AWS regions
      */
-    awsRegions?: Array<string>;
+    awsRegions?: Array<Array<unknown>>;
     /**
      * Filter by Azure regions
      */
-    azureRegions?: Array<string>;
+    azureRegions?: Array<Array<unknown>>;
     /**
      * Filter by agent installation presence
      */
@@ -117,15 +117,15 @@ export type FilterEndpointDto = {
     /**
      * Filter by vendor IDs
      */
-    vendorIds?: Array<string>;
+    vendorIds?: Array<Array<unknown>>;
     /**
      * Filter by vendor device IDs
      */
-    vendorDeviceIds?: Array<string>;
+    vendorDeviceIds?: Array<Array<unknown>>;
     /**
      * Filter by build architecture
      */
-    buildArch?: Array<'386' | 'amd64' | 'arm64' | 'x86'>;
+    buildArch?: Array<Array<unknown>>;
     /**
      * Filter endpoints excluded from updates
      */
@@ -177,27 +177,27 @@ export type FilterEndpointWithTaskCountDto = {
     /**
      * Managed status list
      */
-    managedStatus?: Array<string>;
+    managedStatus?: Array<Array<unknown>>;
     /**
      * Isolation status list
      */
-    isolationStatus?: Array<string>;
+    isolationStatus?: Array<Array<unknown>>;
     /**
      * Platform list
      */
-    platform?: Array<string>;
+    platform?: Array<Array<unknown>>;
     /**
      * Endpoint issue list
      */
-    issue?: Array<string>;
+    issue?: Array<Array<unknown>>;
     /**
      * Online status list
      */
-    onlineStatus?: Array<string>;
+    onlineStatus?: Array<Array<unknown>>;
     /**
      * Tags list
      */
-    tags?: Array<string>;
+    tags?: Array<Array<unknown>>;
     /**
      * Agent version
      */
@@ -209,15 +209,15 @@ export type FilterEndpointWithTaskCountDto = {
     /**
      * Included endpoint IDs
      */
-    includedEndpointIds?: Array<string>;
+    includedEndpointIds?: Array<Array<unknown>>;
     /**
      * Excluded endpoint IDs
      */
-    excludedEndpointIds?: Array<string>;
+    excludedEndpointIds?: Array<Array<unknown>>;
     /**
      * Organization IDs (comma separated)
      */
-    organizationIds: string;
+    organizationIds: Array<string>;
     /**
      * Connection route id
      */
@@ -233,11 +233,11 @@ export type FilterEndpointWithTaskCountDto = {
     /**
      * Filter by AWS regions
      */
-    awsRegions?: Array<string>;
+    awsRegions?: Array<Array<unknown>>;
     /**
      * Filter by Azure regions
      */
-    azureRegions?: Array<string>;
+    azureRegions?: Array<Array<unknown>>;
     /**
      * Filter by agent installation presence
      */
@@ -253,15 +253,15 @@ export type FilterEndpointWithTaskCountDto = {
     /**
      * Filter by vendor IDs
      */
-    vendorIds?: Array<string>;
+    vendorIds?: Array<Array<unknown>>;
     /**
      * Filter by vendor device IDs
      */
-    vendorDeviceIds?: Array<string>;
+    vendorDeviceIds?: Array<Array<unknown>>;
     /**
      * Filter by build architecture
      */
-    buildArch?: Array<'386' | 'amd64' | 'arm64' | 'x86'>;
+    buildArch?: Array<Array<unknown>>;
     /**
      * Filter endpoints excluded from updates
      */
@@ -291,7 +291,7 @@ export type RemoveTagsFromEndpointsByFilterDto = {
     /**
      * Tags to remove from the selected assets/endpoints
      */
-    tags: Array<string>;
+    tags: Array<Array<unknown>>;
 };
 export type FilterEndpointsByPolicyFilterDto = {
     [key: string]: unknown;
@@ -581,7 +581,7 @@ export type FilterUsersDto = {
     /**
      * Limit to these organization IDs
      */
-    organizationIds?: Array<number>;
+    organizationIds: Array<number>;
     /**
      * Filter by role names
      */
@@ -652,19 +652,6 @@ export type AcquisitionProfileFilterDto = {
      */
     allOrganizations?: boolean;
 };
-export type AcquisitionProfileListItemDto = {
-    _id: string;
-    name: string;
-    organizationIds: Array<number>;
-    averageTime: number;
-    createdAt: string;
-    createdBy: string;
-    deletable: boolean;
-    hasEventLogRecordsEvidence: boolean;
-    profileTypes: Array<string>;
-    lastUsedAt: string | null;
-    lastUsedBy: string | null;
-};
 export type TaskConfig = {
     [key: string]: unknown;
 };
@@ -682,15 +669,15 @@ export type TaskSchedulerConfig = {
 };
 export type AcquireEvidenceDto = {
     /**
-     * Optional task name for the acquisition job
+     * Optional name for the acquisition task
      */
     taskName?: string;
     /**
      * Case ID to associate with the acquisition (required if mandatory case selection is enabled)
      */
-    caseId?: string;
+    caseId: string;
     /**
-     * Identifier of the acquisition profile to use
+     * Acquisition profile ID to associate with the acquisition
      */
     acquisitionProfileId: string;
     /**
@@ -698,17 +685,17 @@ export type AcquireEvidenceDto = {
      */
     taskConfig: TaskConfig;
     /**
-     * Filter object to select the target endpoints. At least one field must be provided.
+     * Filter object to select the target endpoints
      */
     filter: AcquisitionEndpointFilterDto;
     /**
      * Drone execution configuration
      */
-    droneConfig?: DroneConfig;
+    droneConfig: DroneConfig;
     /**
      * Windows Event Log records configuration
      */
-    eventLogRecordsConfig?: EventLogRecordsConfig;
+    eventLogRecordsConfig: EventLogRecordsConfig;
     /**
      * Scheduler configuration for when to run the task
      */
@@ -768,11 +755,11 @@ export type UpdateTriageRuleDto = {
     /**
      * Organization IDs this rule belongs to
      */
-    organizationIds?: Array<number>;
+    organizationIds?: Array<Array<unknown>>;
     /**
      * Tag IDs associated with the rule
      */
-    tagIds?: Array<string>;
+    tagIds?: Array<Array<unknown>>;
 };
 export type TriageRuleFilterDto = {
     [key: string]: unknown;
@@ -799,27 +786,27 @@ export type TriageDto = {
      */
     taskName?: string;
     /**
-     * Case ID to associate with the triage task (required if mandatory case selection is enabled)
+     * Case ID to associate with the triage task
      */
     caseId?: string;
     /**
      * List of triage rule IDs to execute
      */
-    triageRuleIds?: Array<string>;
+    triageRuleIds: Array<string>;
     /**
      * MITRE ATT&CK selection to run instead of explicit triage rules
      */
-    mitreAttack?: MitreAttackDto;
+    mitreAttack: MitreAttackDto;
     /**
      * Task configuration settings
      */
-    taskConfig?: TaskConfig;
+    taskConfig: TaskConfig;
     /**
      * Scheduler configuration for executing the task
      */
     schedulerConfig?: TaskSchedulerConfig;
     /**
-     * Endpoint filter to target assets for triage. At least one filter must be provided.
+     * Endpoint filter to target assets for triage
      */
     filter: TriageEndpointFilterDto;
 };
@@ -976,7 +963,7 @@ export type FilterOrganizationsDto = {
      */
     name?: string;
     /**
-     * Text search across organization fields
+     * Search across organization fields
      */
     searchTerm?: string;
 };
@@ -1121,7 +1108,7 @@ export type CreateCaseDto = {
     /**
      * IDs of users who can access the case when visibility is privateToUsers
      */
-    assignedUserIds?: Array<string>;
+    assignedUserIds: Array<string>;
     /**
      * Category ID of the case
      */
@@ -1170,7 +1157,7 @@ export type FilterCaseTasksDto = {
      */
     hasDroneData?: boolean;
     /**
-     * Endpoint names
+     * Asset names
      */
     assetNames?: Array<string>;
     /**
@@ -1180,11 +1167,11 @@ export type FilterCaseTasksDto = {
     /**
      * Filter by creator user ID
      */
-    taskCreatedBy?: string;
+    taskCreatedBy?: Array<string>;
     /**
      * Filter by creator full name
      */
-    taskCreatedByFullName?: string;
+    taskCreatedByFullName?: Array<string>;
 };
 export type FilterCaseTaskAssignmentsDto = {
     [key: string]: unknown;
@@ -1253,21 +1240,21 @@ export type InteractShellDto = {
      */
     taskName?: string;
     /**
-     * Vendor ID for the target system (required if assetId and vendorDeviceId are not provided)
+     * Vendor ID for the target system
      */
-    vendorId?: string;
+    vendorId: string;
     /**
-     * Asset ID for the target system (required if vendorId and vendorDeviceId are not provided)
+     * Asset ID for the target system
      */
-    assetId?: string;
+    assetId: string;
     /**
-     * Vendor device ID for the target system (required if vendorId and assetId are not provided)
+     * Vendor device ID for the target system
      */
-    vendorDeviceId?: string;
+    vendorDeviceId: string;
     /**
-     * Case ID to associate with the InterACT session (required if mandatory case selection is enabled)
+     * Case ID to associate with the InterACT session
      */
-    caseId?: string;
+    caseId: string;
     /**
      * Task configuration settings for the InterACT session
      */
@@ -1292,17 +1279,17 @@ export type BaselineCompareDto = {
      */
     taskName?: string;
     /**
-     * Case ID to associate with the comparison (required if mandatory case selection is enabled)
+     * Case ID to associate with the comparison
      */
-    caseId?: string;
+    caseId: string;
     /**
-     * Endpoint ID of the target where the two baseline tasks were executed (required if vendorDeviceId is not provided)
+     * Endpoint ID of the target where the two baseline tasks were executed
      */
-    endpointId?: string;
+    endpointId: string;
     /**
-     * Vendor device ID of the target where the two baseline tasks were executed (required if endpointId is not provided)
+     * Vendor device ID of the target where the two baseline tasks were executed
      */
-    vendorDeviceId?: string;
+    vendorDeviceId: string;
     /**
      * Exactly two task IDs corresponding to baseline acquisition tasks to compare
      */
@@ -1313,11 +1300,11 @@ export type BaselineCompareDto = {
 };
 export type AcquireBaselineEvidenceDto = {
     /**
-     * Case ID to associate with the baseline acquisition (required if mandatory case selection is enabled)
+     * Case ID to associate with the baseline acquisition
      */
-    caseId?: string;
+    caseId: string;
     /**
-     * Endpoint filter to select targets for baseline acquisition. At least one filter criterion must be provided.
+     * Endpoint filter to select targets for baseline acquisition.
      */
     filter: FilterEndpointDto;
 };
@@ -1329,15 +1316,15 @@ export type FilterApiTokenDto = {
 };
 export type CreateApiTokenDto = {
     /**
-     * Human-readable name of the API token
+     * The name of the API token
      */
     name: string;
     /**
-     * Optional description for the API token
+     * Description for the API token
      */
     description?: string;
     /**
-     * Expiration date of the token (ISO 8601)
+     * Expiration date for the API token
      */
     expirationDate?: string;
     /**
@@ -1347,15 +1334,15 @@ export type CreateApiTokenDto = {
 };
 export type UpdateApiTokenDto = {
     /**
-     * Optional description for the API token
+     * Description for the API token
      */
     description?: string;
     /**
-     * New expiration date for the token (ISO 8601)
+     * Expiration date for the token
      */
     expirationDate?: string;
     /**
-     * Role identifier for the token
+     * Role identifier that constrains the permissions of the token
      */
     roleId?: string;
 };
@@ -1422,12 +1409,18 @@ export type ExportInvestigationSectionDataDto = {
 export type GetSectionsByTaskAssignmentsDto = {
     [key: string]: unknown;
 };
+export type GetInvestigationFlagSummaryByFilterDto = {
+    [key: string]: unknown;
+};
 export type FilterInvestigationFindingsDto = {
     [key: string]: unknown;
 };
 export type GetInvestigationFindingsSummaryByFilterDto = {
     [key: string]: unknown;
 };
+export type GetInvestigationMitreMatchesByFilterDto = {
+    [key: string]: unknown;
+};
 export type InvestigationGlobalSearchDto = {
     [key: string]: unknown;
 };
@@ -1473,9 +1466,6 @@ export type ExportInvestigationFindingsForApiDto = {
 export type ImportTornadoEvidenceDto = {
     [key: string]: unknown;
 };
-export type ExecuteSqlQueryOnHubDto = {
-    [key: string]: unknown;
-};
 export type FindingExclusionRuleDto = {
     [key: string]: unknown;
 };
@@ -1881,7 +1871,7 @@ export type EndpointGetEndpointsStats1Data = {
 export type EndpointGetEndpointsStats1Responses = {
     200: unknown;
 };
-export type AssetsGetByIdData = {
+export type AssetsGetMany3Data = {
     body?: never;
     path: {
         /**
@@ -1892,10 +1882,10 @@ export type AssetsGetByIdData = {
     query?: never;
     url: '/api/public/endpoints/{id}';
 };
-export type AssetsGetByIdResponses = {
+export type AssetsGetMany3Responses = {
     200: unknown;
 };
-export type AssetsGetById2Data = {
+export type AssetsGetMany4Data = {
     body?: never;
     path: {
         /**
@@ -1906,7 +1896,7 @@ export type AssetsGetById2Data = {
     query?: never;
     url: '/api/public/assets/{id}';
 };
-export type AssetsGetById2Responses = {
+export type AssetsGetMany4Responses = {
     200: unknown;
 };
 export type EndpointImportPpcAsEndpointData = {
@@ -2445,7 +2435,7 @@ export type TaskDeleteData = {
     body?: never;
     path: {
         /**
-         * The unique identifier of the task
+         * The ID of the task
          */
         id: string;
     };
@@ -2459,7 +2449,7 @@ export type TasksGetByIdData = {
     body?: never;
     path: {
         /**
-         * The unique identifier of the task
+         * The ID of the task
          */
         id: string;
     };
@@ -2511,7 +2501,7 @@ export type TasksGetDataData = {
     body?: never;
     path: {
         /**
-         * The unique identifier of the task
+         * The ID of the task
          */
         id: string;
     };
@@ -2552,7 +2542,7 @@ export type TaskCancelData = {
     body?: never;
     path: {
         /**
-         * The unique identifier of the task
+         * The ID of the task
          */
         id: string;
     };
@@ -2820,7 +2810,7 @@ export type TaskAssignmentFilterData = {
     body?: never;
     path: {
         /**
-         * The unique identifier of the task
+         * The ID of the task
          */
         id: string;
     };
@@ -3562,7 +3552,7 @@ export type LicenseGetQuotaData = {
 export type LicenseGetQuotaResponses = {
     200: unknown;
 };
-export type AcquisitionProfilesGetManyData = {
+export type AcquisitionProfilesGetOneData = {
     body?: never;
     path?: never;
     query: {
@@ -3586,13 +3576,9 @@ export type AcquisitionProfilesGetManyData = {
     };
     url: '/api/public/acquisitions/profiles';
 };
-export type AcquisitionProfilesGetManyResponses = {
-    /**
-     * Acquisition profiles
-     */
-    200: Array<AcquisitionProfileListItemDto>;
+export type AcquisitionProfilesGetOneResponses = {
+    200: unknown;
 };
-export type AcquisitionProfilesGetManyResponse = AcquisitionProfilesGetManyResponses[keyof AcquisitionProfilesGetManyResponses];
 export type AcquisitionCreateData = {
     body: AcquisitionProfileDto;
     path?: never;
@@ -3616,7 +3602,7 @@ export type AcquisitionDeleteData = {
 export type AcquisitionDeleteResponses = {
     200: unknown;
 };
-export type AcquisitionProfilesGetOneData = {
+export type AcquisitionGetData = {
     body?: never;
     path: {
         /**
@@ -3627,7 +3613,7 @@ export type AcquisitionProfilesGetOneData = {
     query?: never;
     url: '/api/public/acquisitions/profiles/{id}';
 };
-export type AcquisitionProfilesGetOneResponses = {
+export type AcquisitionGetResponses = {
     200: unknown;
 };
 export type AcquisitionUpdateData = {
@@ -3644,22 +3630,22 @@ export type AcquisitionUpdateData = {
 export type AcquisitionUpdateResponses = {
     200: unknown;
 };
-export type AcquisitionsAssignEvidenceTaskData = {
+export type AcquisitionAssignEvidenceTaskData = {
     body: AcquireEvidenceDto;
     path?: never;
     query?: never;
     url: '/api/public/acquisitions/acquire';
 };
-export type AcquisitionsAssignEvidenceTaskResponses = {
+export type AcquisitionAssignEvidenceTaskResponses = {
     201: unknown;
 };
-export type AcquisitionsAssignEvidenceTask2Data = {
+export type AcquisitionAssignEvidenceTask2Data = {
     body: AcquireEvidenceDto;
     path?: never;
     query?: never;
     url: '/api/public/acquisitions/acquire/evidence';
 };
-export type AcquisitionsAssignEvidenceTask2Responses = {
+export type AcquisitionAssignEvidenceTask2Responses = {
     201: unknown;
 };
 export type AcquisitionCreateOffNetworkAcquisitionTaskFileData = {
@@ -4662,9 +4648,7 @@ export type CaseExportCaseEndpoints1Responses = {
 };
 export type CasesGetData = {
     body?: never;
-    path: {
-        id: string;
-    };
+    path?: never;
     query?: never;
     url: '/api/public/cases/{id}';
 };
@@ -5712,7 +5696,7 @@ export type InvestigationGetSectionsByEndpointsResponses = {
     201: unknown;
 };
 export type InvestigationGetSummaryData = {
-    body?: never;
+    body: GetInvestigationFlagSummaryByFilterDto;
     path: {
         investigationId: string;
     };
@@ -5756,7 +5740,7 @@ export type InvestigationGetFindingsSummaryResponses = {
     201: unknown;
 };
 export type InvestigationGetMitreMatchesData = {
-    body: GetInvestigationFindingsSummaryByFilterDto;
+    body: GetInvestigationMitreMatchesByFilterDto;
     path: {
         investigationId: string;
     };
@@ -6015,17 +5999,6 @@ export type InvestigationImportTornadoEvidenceToInvestigation1Data = {
 export type InvestigationImportTornadoEvidenceToInvestigation1Responses = {
     201: unknown;
 };
-export type InvestigationExecuteSqlQueryOnInvestigationData = {
-    body: ExecuteSqlQueryOnHubDto;
-    path: {
-        investigationId: string;
-    };
-    query?: never;
-    url: '/api/public/investigation-hub/investigations/{investigationId}/execute-sql-query';
-};
-export type InvestigationExecuteSqlQueryOnInvestigationResponses = {
-    201: unknown;
-};
 export type InvestigationExclusionAddFindingExclusionRuleData = {
     body: FindingExclusionRuleDto;
     path?: never;

package/dist/types/assets.d.ts

@@ -1,5 +1,4 @@
 export interface AssetsAPI {
-    get: (id: string) => Promise<any>;
     getMany: (organizationId: number, pageNumber?: number, pageSize?: number) => Promise<any>;
     getTasks: (id: string, pageNumber?: number, pageSize?: number) => Promise<any>;
     addTags: (organizationId: number, tags: string[]) => Promise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@binalyze/air-sdk",
-  "version": "0.2.0",
+  "version": "4.46.0",
   "private": false,
   "description": "Binalyze AIR Typescript Axios SDK",
   "license": "MIT",