@binalyze/air-sdk 5.26.3 → 5.27.1

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.
@@ -879,22 +879,34 @@ export type SetMaintenanceModeDto = {
879
879
  };
880
880
  export type CreateAssetTagDto = {
881
881
  /**
882
- * Organization that owns the asset tag
882
+ * Organization scope. Empty array means Console-level (all Organizations). A single id means org-specific. Length greater than 1 is rejected.
883
883
  */
884
- organizationId: number;
884
+ organizationIds: Array<number>;
885
885
  /**
886
- * Unique asset tag name within the organization
886
+ * Unique asset tag name within the catalog scope
887
887
  */
888
888
  name: string;
889
+ /**
890
+ * When creating a Console-level tag whose name already exists as org-specific rows, set true to absorb those rows in the same request.
891
+ */
892
+ confirmAbsorb?: boolean;
889
893
  };
890
894
  export type FilterAssetTagsDto = {
891
895
  [key: string]: unknown;
892
896
  };
893
897
  export type RenameAssetTagDto = {
894
898
  /**
895
- * New unique asset tag name within the organization
899
+ * New unique asset tag name within the catalog scope
896
900
  */
897
901
  name: string;
902
+ /**
903
+ * Organization scope. Omit to keep the current scope. Empty array means Console-level (all Organizations). A single id means org-specific. Length greater than 1 is rejected.
904
+ */
905
+ organizationIds?: Array<number>;
906
+ /**
907
+ * When renaming or promoting a tag to Console-level onto a name that exists as org-specific rows, set true to absorb those rows in the same request.
908
+ */
909
+ confirmAbsorb?: boolean;
898
910
  };
899
911
  export type TaskResponseDto = {
900
912
  /**
@@ -3863,9 +3875,9 @@ export type AssignedTaskResponseDto = {
3863
3875
  };
3864
3876
  export type OffNetworkAcquisitionTaskDto = {
3865
3877
  /**
3866
- * Organization used to scope the selected DRONE Analyzer Profile
3878
+ * Organization the off-network task belongs to. Required: the caller is authorized against it and it scopes a selected DRONE Analyzer Profile. No policy gate is applied on this path — an off-network payload never resolves `usePolicy`.
3867
3879
  */
3868
- organizationId?: number;
3880
+ organizationId: number;
3869
3881
  /**
3870
3882
  * DRONE Analyzer Profile ID. Null explicitly disables DRONE; omitted uses legacy configuration.
3871
3883
  */
@@ -4785,9 +4797,13 @@ export type TaxiiFeedResponseDto = {
4785
4797
  */
4786
4798
  provider?: 'threatmon' | 'opencti' | 'custom';
4787
4799
  /**
4788
- * TAXII discovery endpoint URL
4800
+ * How indicators are ingested
4789
4801
  */
4790
- discoveryUrl: string;
4802
+ sourceType: 'taxii' | 'manual';
4803
+ /**
4804
+ * TAXII discovery endpoint URL (null for manual sources)
4805
+ */
4806
+ discoveryUrl?: string | null;
4791
4807
  /**
4792
4808
  * API root URL override
4793
4809
  */
@@ -5111,17 +5127,21 @@ export type CreateTaxiiFeedRequestDto = {
5111
5127
  */
5112
5128
  provider: 'threatmon' | 'opencti' | 'custom';
5113
5129
  /**
5114
- * URL of the TAXII 2.x discovery endpoint
5130
+ * How indicators are ingested. `taxii` pulls from a remote TAXII 2.x server; `manual` accepts uploaded STIX objects. Defaults to `taxii`. Immutable after creation.
5115
5131
  */
5116
- discoveryUrl: string;
5132
+ sourceType?: 'taxii' | 'manual';
5133
+ /**
5134
+ * URL of the TAXII 2.x discovery endpoint (required for `taxii` sources)
5135
+ */
5136
+ discoveryUrl?: string;
5117
5137
  /**
5118
5138
  * API root URL override (auto-detected from discovery when omitted)
5119
5139
  */
5120
5140
  apiRootUrl?: string;
5121
5141
  /**
5122
- * Authentication method for the TAXII server (use "none" for public servers)
5142
+ * Authentication method for the TAXII server (required for `taxii` sources; use "none" for public servers)
5123
5143
  */
5124
- authType: 'none' | 'basic' | 'bearer' | 'apikey';
5144
+ authType?: 'none' | 'basic' | 'bearer' | 'apikey';
5125
5145
  /**
5126
5146
  * Authentication credentials (bearer token, basic auth or API key headers)
5127
5147
  */
@@ -5173,6 +5193,54 @@ export type DiscoverTaxiiCollectionsRequestDto = {
5173
5193
  [key: string]: unknown;
5174
5194
  };
5175
5195
  };
5196
+ export type ImportTaxiiFeedStixObjectsRequestDto = {
5197
+ /**
5198
+ * STIX 2.x objects to merge into the feed. Each object must include the fields this module reads (at least `type` and `id`; indicators also need `pattern`). Maximum 5 000 objects per request. Manual sources only.
5199
+ */
5200
+ objects: Array<{
5201
+ [key: string]: unknown;
5202
+ }>;
5203
+ /**
5204
+ * Sync log from a previous batch of the same import. Omit on the first batch. Required to continue so the UI can split large files without creating one log per request.
5205
+ */
5206
+ syncLogId?: string;
5207
+ /**
5208
+ * When false, the import stays in progress and later batches must send the returned syncLogId. Defaults to true so a single request still completes the log.
5209
+ */
5210
+ lastBatch?: boolean;
5211
+ };
5212
+ export type ImportTaxiiFeedStixObjectsResponseDto = {
5213
+ /**
5214
+ * Sync log created for this import
5215
+ */
5216
+ syncLogId: string;
5217
+ /**
5218
+ * Number of STIX objects received in the request
5219
+ */
5220
+ objectsReceived: number;
5221
+ /**
5222
+ * New indicator states inserted
5223
+ */
5224
+ indicatorsAdded: number;
5225
+ /**
5226
+ * Existing indicator states updated by STIX id
5227
+ */
5228
+ indicatorsUpdated: number;
5229
+ /**
5230
+ * Received objects not persisted as indicator states (invalid patterns, filters, duplicates, non-indicators)
5231
+ */
5232
+ indicatorsSkipped: number;
5233
+ /**
5234
+ * Accepted indicators whose validity window had already elapsed
5235
+ */
5236
+ indicatorsExpired: number;
5237
+ /**
5238
+ * Aggregate skip reasons for objects that were not persisted
5239
+ */
5240
+ skippedByReason?: {
5241
+ [key: string]: unknown;
5242
+ };
5243
+ };
5176
5244
  export type UpdateTaxiiFeedStatusRequestDto = {
5177
5245
  /**
5178
5246
  * Whether the TAXII feed is enabled
@@ -5567,6 +5635,10 @@ export type UpdateScheduledTriageTaskRequestDto = {
5567
5635
  filter: TriageEndpointFilterDto;
5568
5636
  };
5569
5637
  export type OffNetworkTriageTaskDto = {
5638
+ /**
5639
+ * Organization the off-network task belongs to. Required so the caller declares — and is authorized for — the organization the file is built for.
5640
+ */
5641
+ organizationId: number;
5570
5642
  taskName?: string;
5571
5643
  triageRuleIds?: Array<string>;
5572
5644
  mitreAttack?: MitreAttackDto;
@@ -14960,6 +15032,35 @@ export type AutomationResponseDto = {
14960
15032
  export type GetAutomationExecutionsFilterDto = {
14961
15033
  [key: string]: unknown;
14962
15034
  };
15035
+ export type AutomationRunCountsDto = {
15036
+ total: number;
15037
+ pending: number;
15038
+ running: number;
15039
+ completed: number;
15040
+ failed: number;
15041
+ };
15042
+ export type AutomationRunResponseDto = {
15043
+ /**
15044
+ * Run id
15045
+ */
15046
+ id: string;
15047
+ automationId: string;
15048
+ triggerContextKey: string;
15049
+ status: 'pending' | 'running' | 'completed' | 'failed';
15050
+ counts: AutomationRunCountsDto;
15051
+ startedAt?: string | null;
15052
+ endedAt?: string | null;
15053
+ createdAt: string;
15054
+ /**
15055
+ * Saved run context: runtime global and trigger blocks plus the configuration snapshot.
15056
+ */
15057
+ context: {
15058
+ [key: string]: unknown;
15059
+ };
15060
+ };
15061
+ export type GetAutomationRunsFilterDto = {
15062
+ [key: string]: unknown;
15063
+ };
14963
15064
  export type GetAutomationChangeHistoryFilterDto = {
14964
15065
  [key: string]: unknown;
14965
15066
  };
@@ -16220,6 +16321,9 @@ export type IntegrationResponseDtoWritable = {
16220
16321
  export type GetAutomationExecutionsFilterDtoWritable = {
16221
16322
  [key: string]: unknown;
16222
16323
  };
16324
+ export type GetAutomationRunsFilterDtoWritable = {
16325
+ [key: string]: unknown;
16326
+ };
16223
16327
  export type GetAutomationChangeHistoryFilterDtoWritable = {
16224
16328
  [key: string]: unknown;
16225
16329
  };
@@ -28354,7 +28458,7 @@ export type TaxiiFeedsTriggerSyncData = {
28354
28458
  };
28355
28459
  export type TaxiiFeedsTriggerSyncErrors = {
28356
28460
  /**
28357
- * The request parameters are invalid.
28461
+ * The request is invalid.
28358
28462
  */
28359
28463
  400: ApiResponseFailV1Dto | NestHttpErrorV1Dto | NestValidationErrorV1Dto;
28360
28464
  /**
@@ -28385,6 +28489,55 @@ export type TaxiiFeedsTriggerSyncResponses = {
28385
28489
  */
28386
28490
  200: unknown;
28387
28491
  };
28492
+ export type TaxiiFeedsImportStixObjectsData = {
28493
+ body: ImportTaxiiFeedStixObjectsRequestDto;
28494
+ path: {
28495
+ /**
28496
+ * Identifier of the id addressed by this operation.
28497
+ */
28498
+ id: string;
28499
+ };
28500
+ query?: never;
28501
+ url: '/api/public/taxii-feeds/{id}/stix-objects';
28502
+ };
28503
+ export type TaxiiFeedsImportStixObjectsErrors = {
28504
+ /**
28505
+ * The request is invalid.
28506
+ */
28507
+ 400: ApiResponseFailV1Dto | NestHttpErrorV1Dto | NestValidationErrorV1Dto;
28508
+ /**
28509
+ * Authentication is required.
28510
+ */
28511
+ 401: ApiResponseFailV1Dto;
28512
+ /**
28513
+ * The caller is not allowed to perform this operation.
28514
+ */
28515
+ 403: ApiResponseFailV1Dto;
28516
+ /**
28517
+ * The requested resource was not found.
28518
+ */
28519
+ 404: ApiResponseFailV1Dto;
28520
+ /**
28521
+ * The request conflicts with the current resource state.
28522
+ */
28523
+ 409: ApiResponseFailV1Dto;
28524
+ /**
28525
+ * The request payload exceeds the configured limit.
28526
+ */
28527
+ 413: ApiResponseFailV1Dto;
28528
+ /**
28529
+ * The operation failed unexpectedly.
28530
+ */
28531
+ 500: ApiResponseFailV1Dto;
28532
+ };
28533
+ export type TaxiiFeedsImportStixObjectsError = TaxiiFeedsImportStixObjectsErrors[keyof TaxiiFeedsImportStixObjectsErrors];
28534
+ export type TaxiiFeedsImportStixObjectsResponses = {
28535
+ /**
28536
+ * The objects have been imported.
28537
+ */
28538
+ 200: ImportTaxiiFeedStixObjectsResponseDto;
28539
+ };
28540
+ export type TaxiiFeedsImportStixObjectsResponse = TaxiiFeedsImportStixObjectsResponses[keyof TaxiiFeedsImportStixObjectsResponses];
28388
28541
  export type TaxiiFeedsCancelSyncData = {
28389
28542
  body?: never;
28390
28543
  path: {
@@ -52607,6 +52760,169 @@ export type AutomationHubUpdateAutomationResponses = {
52607
52760
  */
52608
52761
  200: unknown;
52609
52762
  };
52763
+ export type AutomationHubGetAutomationRunExecutionsData = {
52764
+ body?: never;
52765
+ path: {
52766
+ /**
52767
+ * Identifier of the id addressed by this operation.
52768
+ */
52769
+ id: string;
52770
+ /**
52771
+ * Identifier of the run addressed by this operation.
52772
+ */
52773
+ runId: string;
52774
+ };
52775
+ query: {
52776
+ /**
52777
+ * Number of items per page
52778
+ */
52779
+ pageSize?: number;
52780
+ /**
52781
+ * Page number to retrieve
52782
+ */
52783
+ pageNumber?: number;
52784
+ /**
52785
+ * Sort direction
52786
+ */
52787
+ sortType?: 'ASC' | 'DESC';
52788
+ /**
52789
+ * Field name to sort by
52790
+ */
52791
+ sortBy?: string;
52792
+ /**
52793
+ * Structured filters encoded with bracketed deep-object query keys.
52794
+ */
52795
+ filter: {
52796
+ [key: string]: unknown;
52797
+ };
52798
+ };
52799
+ url: '/api/public/automation-hub/{id}/runs/{runId}/executions';
52800
+ };
52801
+ export type AutomationHubGetAutomationRunExecutionsErrors = {
52802
+ /**
52803
+ * The request parameters are invalid.
52804
+ */
52805
+ 400: ApiResponseFailV1Dto | NestHttpErrorV1Dto | NestValidationErrorV1Dto;
52806
+ /**
52807
+ * Authentication is required.
52808
+ */
52809
+ 401: ApiResponseFailV1Dto;
52810
+ /**
52811
+ * The caller is not allowed to perform this operation.
52812
+ */
52813
+ 403: ApiResponseFailV1Dto;
52814
+ /**
52815
+ * The operation failed unexpectedly.
52816
+ */
52817
+ 500: ApiResponseFailV1Dto;
52818
+ };
52819
+ export type AutomationHubGetAutomationRunExecutionsError = AutomationHubGetAutomationRunExecutionsErrors[keyof AutomationHubGetAutomationRunExecutionsErrors];
52820
+ export type AutomationHubGetAutomationRunExecutionsResponses = {
52821
+ /**
52822
+ * Successful response with no response body.
52823
+ */
52824
+ 200: unknown;
52825
+ };
52826
+ export type AutomationHubGetAutomationRunData = {
52827
+ body?: never;
52828
+ path: {
52829
+ /**
52830
+ * Identifier of the id addressed by this operation.
52831
+ */
52832
+ id: string;
52833
+ /**
52834
+ * Identifier of the run addressed by this operation.
52835
+ */
52836
+ runId: string;
52837
+ };
52838
+ query?: never;
52839
+ url: '/api/public/automation-hub/{id}/runs/{runId}';
52840
+ };
52841
+ export type AutomationHubGetAutomationRunErrors = {
52842
+ /**
52843
+ * The request parameters are invalid.
52844
+ */
52845
+ 400: ApiResponseFailV1Dto | NestHttpErrorV1Dto | NestValidationErrorV1Dto;
52846
+ /**
52847
+ * Authentication is required.
52848
+ */
52849
+ 401: ApiResponseFailV1Dto;
52850
+ /**
52851
+ * The caller is not allowed to perform this operation.
52852
+ */
52853
+ 403: ApiResponseFailV1Dto;
52854
+ /**
52855
+ * The operation failed unexpectedly.
52856
+ */
52857
+ 500: ApiResponseFailV1Dto;
52858
+ };
52859
+ export type AutomationHubGetAutomationRunError = AutomationHubGetAutomationRunErrors[keyof AutomationHubGetAutomationRunErrors];
52860
+ export type AutomationHubGetAutomationRunResponses = {
52861
+ /**
52862
+ * Request completed successfully.
52863
+ */
52864
+ 200: AutomationRunResponseDto;
52865
+ };
52866
+ export type AutomationHubGetAutomationRunResponse = AutomationHubGetAutomationRunResponses[keyof AutomationHubGetAutomationRunResponses];
52867
+ export type AutomationHubGetAutomationRunsData = {
52868
+ body?: never;
52869
+ path: {
52870
+ /**
52871
+ * Identifier of the id addressed by this operation.
52872
+ */
52873
+ id: string;
52874
+ };
52875
+ query: {
52876
+ /**
52877
+ * Number of items per page
52878
+ */
52879
+ pageSize?: number;
52880
+ /**
52881
+ * Page number to retrieve
52882
+ */
52883
+ pageNumber?: number;
52884
+ /**
52885
+ * Sort direction
52886
+ */
52887
+ sortType?: 'ASC' | 'DESC';
52888
+ /**
52889
+ * Field name to sort by
52890
+ */
52891
+ sortBy?: string;
52892
+ /**
52893
+ * Structured filters encoded with bracketed deep-object query keys.
52894
+ */
52895
+ filter: {
52896
+ [key: string]: unknown;
52897
+ };
52898
+ };
52899
+ url: '/api/public/automation-hub/{id}/runs';
52900
+ };
52901
+ export type AutomationHubGetAutomationRunsErrors = {
52902
+ /**
52903
+ * The request parameters are invalid.
52904
+ */
52905
+ 400: ApiResponseFailV1Dto | NestHttpErrorV1Dto | NestValidationErrorV1Dto;
52906
+ /**
52907
+ * Authentication is required.
52908
+ */
52909
+ 401: ApiResponseFailV1Dto;
52910
+ /**
52911
+ * The caller is not allowed to perform this operation.
52912
+ */
52913
+ 403: ApiResponseFailV1Dto;
52914
+ /**
52915
+ * The operation failed unexpectedly.
52916
+ */
52917
+ 500: ApiResponseFailV1Dto;
52918
+ };
52919
+ export type AutomationHubGetAutomationRunsError = AutomationHubGetAutomationRunsErrors[keyof AutomationHubGetAutomationRunsErrors];
52920
+ export type AutomationHubGetAutomationRunsResponses = {
52921
+ /**
52922
+ * Successful response with no response body.
52923
+ */
52924
+ 200: unknown;
52925
+ };
52610
52926
  export type AutomationHubGetAutomationExecutionData = {
52611
52927
  body?: never;
52612
52928
  path: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@binalyze/air-sdk",
3
- "version": "5.26.3",
3
+ "version": "5.27.1",
4
4
  "private": false,
5
5
  "description": "Binalyze AIR - Typescript Axios SDK",
6
6
  "license": "MIT",