@binalyze/air-sdk 5.23.0 → 5.24.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -149,7 +149,7 @@ export type BulkAssetActionV2RequestDto = {
149
149
  */
150
150
  assets: Array<string>;
151
151
  /**
152
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
152
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
153
153
  */
154
154
  organizations?: number | string | Array<number | string> | 'all';
155
155
  };
@@ -167,7 +167,7 @@ export type BulkAssetDeleteV2RequestDto = {
167
167
  */
168
168
  mode: 'purge' | 'uninstall' | 'purge-and-uninstall';
169
169
  /**
170
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
170
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
171
171
  */
172
172
  organizations?: number | string | Array<number | string> | 'all';
173
173
  };
@@ -177,7 +177,7 @@ export type BulkAssetMaintenanceV2RequestDto = {
177
177
  */
178
178
  assets: Array<string>;
179
179
  /**
180
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
180
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
181
181
  */
182
182
  organizations?: number | string | Array<number | string> | 'all';
183
183
  };
@@ -191,7 +191,7 @@ export type BulkAssetTagsV2RequestDto = {
191
191
  */
192
192
  tags: Array<string>;
193
193
  /**
194
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
194
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
195
195
  */
196
196
  organizations?: number | string | Array<number | string> | 'all';
197
197
  };
@@ -208,6 +208,10 @@ export type BulkAssetTriageV2RequestDto = {
208
208
  * Triage rules to run, referenced by id or exact name (at most 100).
209
209
  */
210
210
  ruleIds: Array<string>;
211
+ /**
212
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
213
+ */
214
+ organizations?: number | string | Array<number | string> | 'all';
211
215
  /**
212
216
  * CPU usage cap for the triage task (percent).
213
217
  */
@@ -235,7 +239,7 @@ export type BulkAssetVersionUpdateV2RequestDto = {
235
239
  */
236
240
  assets: Array<string>;
237
241
  /**
238
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
242
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
239
243
  */
240
244
  organizations?: number | string | Array<number | string> | 'all';
241
245
  };
@@ -717,7 +721,7 @@ export type CreateInvestigationFlagV2RequestDto = {
717
721
  */
718
722
  description?: string;
719
723
  /**
720
- * Owning organization as id or exact name. Optional: defaults to the caller organization when the caller has exactly one, otherwise to the default organization.
724
+ * Owning organization as id or exact name. Optional: defaults to the caller organization when the caller has exactly one. Multi-organization and all-organization callers must pass it explicitly.
721
725
  */
722
726
  organization?: number | string;
723
727
  /**
@@ -955,52 +959,24 @@ export type InteractMessageV2FilterRequestDto = {
955
959
  * Filter by session UUIDs.
956
960
  */
957
961
  sessionId?: Array<string>;
958
- /**
959
- * Filter by message status.
960
- */
961
- status?: Array<'queued' | 'running' | 'completed' | 'failed' | 'cancelled'>;
962
- /**
963
- * Filter by detected command type.
964
- */
965
- detectedType?: Array<'airNative' | 'osquery' | 'exec'>;
966
- /**
967
- * Snippet UUID or name; reserved value "none" matches messages with no snippet.
968
- */
969
- snippetId?: Array<string>;
970
962
  /**
971
963
  * Filter by message creation time range.
972
964
  */
973
965
  createdAt?: InteractDateRangeV2FilterDto;
974
- /**
975
- * Filter by message completion time range.
976
- */
977
- completedAt?: InteractDateRangeV2FilterDto;
978
966
  };
979
967
  export type InteractSessionV2FilterRequestDto = {
980
968
  /**
981
969
  * Filter by session UUIDs.
982
970
  */
983
971
  sessionId?: Array<string>;
984
- /**
985
- * Filter by derived activity state.
986
- */
987
- activityState?: Array<'active' | 'idle'>;
988
972
  /**
989
973
  * Filter by session creator username.
990
974
  */
991
975
  createdBy?: Array<string>;
992
- /**
993
- * Case UUID or name.
994
- */
995
- caseId?: Array<string>;
996
976
  /**
997
977
  * Filter by session creation time range.
998
978
  */
999
979
  createdAt?: InteractDateRangeV2FilterDto;
1000
- /**
1001
- * Filter by last-activity time range.
1002
- */
1003
- lastActivityAt?: InteractDateRangeV2FilterDto;
1004
980
  };
1005
981
  export type InvestigationSqlQueryV2RequestDto = {
1006
982
  /**
@@ -1295,7 +1271,7 @@ export type ReplaceAssetTagsV2RequestDto = {
1295
1271
  */
1296
1272
  tags: Array<string>;
1297
1273
  /**
1298
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
1274
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
1299
1275
  */
1300
1276
  organizations?: number | string | Array<number | string> | 'all';
1301
1277
  };
@@ -1389,7 +1365,7 @@ export type SetAssetConnectionRouteV2RequestDto = {
1389
1365
  */
1390
1366
  relayServerId: number | null;
1391
1367
  /**
1392
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
1368
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
1393
1369
  */
1394
1370
  organizations?: number | string | Array<number | string> | 'all';
1395
1371
  };
@@ -1403,7 +1379,7 @@ export type SetAssetMitreDatabaseVersionV2RequestDto = {
1403
1379
  */
1404
1380
  version: string;
1405
1381
  /**
1406
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
1382
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
1407
1383
  */
1408
1384
  organizations?: number | string | Array<number | string> | 'all';
1409
1385
  };
@@ -1417,19 +1393,19 @@ export type SetAssetUpdateExclusionV2RequestDto = {
1417
1393
  */
1418
1394
  excludedFromUpdates: boolean;
1419
1395
  /**
1420
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
1396
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
1421
1397
  */
1422
1398
  organizations?: number | string | Array<number | string> | 'all';
1423
1399
  };
1424
1400
  export type SingleAssetActionV2RequestDto = {
1425
1401
  /**
1426
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
1402
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
1427
1403
  */
1428
1404
  organizations?: number | string | Array<number | string> | 'all';
1429
1405
  };
1430
1406
  export type SingleAssetVersionUpdateV2RequestDto = {
1431
1407
  /**
1432
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
1408
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
1433
1409
  */
1434
1410
  organizations?: number | string | Array<number | string> | 'all';
1435
1411
  };
@@ -1493,7 +1469,7 @@ export type UpdateAssetLabelV2RequestDto = {
1493
1469
  */
1494
1470
  label: string | null;
1495
1471
  /**
1496
- * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omit to default to organization id 0. Empty arrays are rejected.
1472
+ * Organizations scope. Polymorphic: pass a single number id, a single string name, an array mixing ids and names, or the literal string "all". Omission follows the endpoint-specific organization policy. Empty arrays are rejected.
1497
1473
  */
1498
1474
  organizations?: number | string | Array<number | string> | 'all';
1499
1475
  };
@@ -1960,10 +1936,6 @@ export type TasksV2ApiControllerListTaskAssetsData = {
1960
1936
  * Deep-object asset filter, e.g. filter[searchTerm], filter[status][], filter[subtype][], filter[platform][], filter[os][], filter[tagIds][].
1961
1937
  */
1962
1938
  filter?: ListAssetsV2RequestDto;
1963
- /**
1964
- * Organization scope: "all" or comma-separated numeric organization ids. Defaults to all accessible organizations when omitted.
1965
- */
1966
- organizations?: unknown;
1967
1939
  };
1968
1940
  url: '/api/v2/tasks/{taskId}/assets';
1969
1941
  };
@@ -2079,6 +2051,10 @@ export type TasksTriageV2ApiControllerListHuntTasksData = {
2079
2051
  * Deep-object hunt filter, e.g. filter[searchTerm], filter[status][], filter[executionType][], filter[ruleIds][], filter[taskCreatedBy][], filter[hasDroneData], filter[hasMatch].
2080
2052
  */
2081
2053
  filter?: HuntTaskFilterV2RequestDto;
2054
+ /**
2055
+ * Organization scope: id, name, mixed comma-separated list, or "all". Defaults to all accessible organizations when omitted.
2056
+ */
2057
+ organizations?: string;
2082
2058
  };
2083
2059
  url: '/api/v2/hunt';
2084
2060
  };
@@ -2333,12 +2309,7 @@ export type AcquisitionLibraryDeviceV2ApiControllerListResponse = AcquisitionLib
2333
2309
  export type AcquisitionLibraryDeviceV2ApiControllerCreateData = {
2334
2310
  body: CreateDeviceAcquisitionProfileV2RequestDto;
2335
2311
  path?: never;
2336
- query?: {
2337
- /**
2338
- * Organization scope: "all" or comma-separated numeric organization ids. Defaults to all accessible organizations when omitted.
2339
- */
2340
- organizations?: string;
2341
- };
2312
+ query?: never;
2342
2313
  url: '/api/v2/libraries/acquisition/device';
2343
2314
  };
2344
2315
  export type AcquisitionLibraryDeviceV2ApiControllerCreateErrors = {
@@ -5302,7 +5273,12 @@ export type InvestigationEvidenceFlagV2ApiControllerFlagEvidenceData = {
5302
5273
  */
5303
5274
  idOrName: string;
5304
5275
  };
5305
- query?: never;
5276
+ query?: {
5277
+ /**
5278
+ * Organization scope: id, name, mixed comma-separated list, or "all". Defaults to all accessible organizations when omitted.
5279
+ */
5280
+ organizations?: string;
5281
+ };
5306
5282
  url: '/api/v2/investigations/{idOrName}/flag';
5307
5283
  };
5308
5284
  export type InvestigationEvidenceFlagV2ApiControllerFlagEvidenceErrors = {
@@ -5344,7 +5320,12 @@ export type InvestigationEvidenceFlagV2ApiControllerUnflagEvidenceData = {
5344
5320
  */
5345
5321
  idOrName: string;
5346
5322
  };
5347
- query?: never;
5323
+ query?: {
5324
+ /**
5325
+ * Organization scope: id, name, mixed comma-separated list, or "all". Defaults to all accessible organizations when omitted.
5326
+ */
5327
+ organizations?: string;
5328
+ };
5348
5329
  url: '/api/v2/investigations/{idOrName}/unflag';
5349
5330
  };
5350
5331
  export type InvestigationEvidenceFlagV2ApiControllerUnflagEvidenceErrors = {
@@ -5386,7 +5367,12 @@ export type InvestigationSqlV2ApiControllerGetSchemaData = {
5386
5367
  */
5387
5368
  idOrName: string;
5388
5369
  };
5389
- query?: never;
5370
+ query?: {
5371
+ /**
5372
+ * Organization scope: id, name, mixed comma-separated list, or "all". Defaults to all accessible organizations when omitted.
5373
+ */
5374
+ organizations?: string;
5375
+ };
5390
5376
  url: '/api/v2/investigations/{idOrName}/schema';
5391
5377
  };
5392
5378
  export type InvestigationSqlV2ApiControllerGetSchemaErrors = {
@@ -5428,7 +5414,12 @@ export type InvestigationSqlV2ApiControllerExecuteSqlQueryData = {
5428
5414
  */
5429
5415
  idOrName: string;
5430
5416
  };
5431
- query?: never;
5417
+ query?: {
5418
+ /**
5419
+ * Organization scope: id, name, mixed comma-separated list, or "all". Defaults to all accessible organizations when omitted.
5420
+ */
5421
+ organizations?: string;
5422
+ };
5432
5423
  url: '/api/v2/investigations/{idOrName}/sql-query';
5433
5424
  };
5434
5425
  export type InvestigationSqlV2ApiControllerExecuteSqlQueryErrors = {
@@ -6538,7 +6529,7 @@ export type AssetInteractMessageV2ApiControllerListForAssetData = {
6538
6529
  sortType?: 'ASC' | 'DESC';
6539
6530
  sortBy?: 'createdAt';
6540
6531
  /**
6541
- * Deep-object filter, e.g. filter[sessionId]=<uuid>, filter[status][]=completed, filter[detectedType][]=terminal, filter[snippetId]=<uuid|none>, filter[createdAt][start]/[end], filter[completedAt][start]/[end].
6532
+ * Deep-object filter, e.g. filter[sessionId]=<uuid>, filter[createdAt][from]/[to].
6542
6533
  */
6543
6534
  filter?: InteractMessageV2FilterRequestDto;
6544
6535
  };
@@ -7478,7 +7469,7 @@ export type AssetInteractMessageV2ApiControllerListSessionsForAssetData = {
7478
7469
  sortType?: 'ASC' | 'DESC';
7479
7470
  sortBy?: 'createdAt';
7480
7471
  /**
7481
- * Deep-object filter, e.g. filter[sessionId]=<uuid>, filter[createdBy]=<username>, filter[createdAt][start]/[end].
7472
+ * Deep-object filter, e.g. filter[sessionId]=<uuid>, filter[createdBy]=<username>, filter[createdAt][from]/[to].
7482
7473
  */
7483
7474
  filter?: InteractSessionV2FilterRequestDto;
7484
7475
  };
@@ -7729,12 +7720,7 @@ export type CloudAcquisitionLibraryApiControllerListResponse = CloudAcquisitionL
7729
7720
  export type CloudAcquisitionLibraryApiControllerCreateData = {
7730
7721
  body: CreateCloudAcquisitionProfileV2RequestDto;
7731
7722
  path?: never;
7732
- query?: {
7733
- /**
7734
- * Organization scope: "all" or comma-separated numeric organization ids. Defaults to all accessible organizations when omitted.
7735
- */
7736
- organizations?: string;
7737
- };
7723
+ query?: never;
7738
7724
  url: '/api/v2/libraries/acquisition/cloud';
7739
7725
  };
7740
7726
  export type CloudAcquisitionLibraryApiControllerCreateErrors = {
@@ -8013,12 +7999,7 @@ export type DiskImageAcquisitionLibraryApiControllerListResponse = DiskImageAcqu
8013
7999
  export type DiskImageAcquisitionLibraryApiControllerCreateData = {
8014
8000
  body: CreateDiskImageAcquisitionProfileV2RequestDto;
8015
8001
  path?: never;
8016
- query?: {
8017
- /**
8018
- * Organization scope: "all" or comma-separated numeric organization ids. Defaults to all accessible organizations when omitted.
8019
- */
8020
- organizations?: string;
8021
- };
8002
+ query?: never;
8022
8003
  url: '/api/v2/libraries/acquisition/disk-image';
8023
8004
  };
8024
8005
  export type DiskImageAcquisitionLibraryApiControllerCreateErrors = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@binalyze/air-sdk",
3
- "version": "5.23.0",
3
+ "version": "5.24.3",
4
4
  "private": false,
5
5
  "description": "Binalyze AIR - Typescript Axios SDK",
6
6
  "license": "MIT",