@binalyze/air-sdk 5.6.1 → 5.7.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.
@@ -138,6 +138,10 @@ export type FilterEndpointDto = {
138
138
  * Filter by asset type (endpoint or disk-image only)
139
139
  */
140
140
  assetType?: Array<'disk-image' | 'endpoint' | 'cloud-asset'>;
141
+ /**
142
+ * Filter by maintenance mode
143
+ */
144
+ maintenanceMode?: boolean;
141
145
  };
142
146
  export type UpdateEndpointTagsDto = {
143
147
  [key: string]: unknown;
@@ -303,6 +307,10 @@ export type FilterEndpointWithTaskCountDto = {
303
307
  * Filter by asset type (endpoint or disk-image only)
304
308
  */
305
309
  assetType?: Array<'disk-image' | 'endpoint' | 'cloud-asset'>;
310
+ /**
311
+ * Filter by maintenance mode
312
+ */
313
+ maintenanceMode?: boolean;
306
314
  };
307
315
  export type ImportPpcasEndpointDto = {
308
316
  [key: string]: unknown;
@@ -345,6 +353,12 @@ export type DeployCloudAssetsDto = {
345
353
  export type UpdateEndpointConnectionRouteDto = {
346
354
  [key: string]: unknown;
347
355
  };
356
+ export type SetMaintenanceModeDto = {
357
+ /**
358
+ * Whether maintenance mode should be enabled (true) or disabled (false)
359
+ */
360
+ enabled: boolean;
361
+ };
348
362
  export type FilterTagsDto = {
349
363
  [key: string]: unknown;
350
364
  };
@@ -1061,6 +1075,9 @@ export type ChangePasswordRequestDto = {
1061
1075
  export type UpdateUserDto = {
1062
1076
  [key: string]: unknown;
1063
1077
  };
1078
+ export type PartialUpdateUserDto = {
1079
+ [key: string]: unknown;
1080
+ };
1064
1081
  export type FilterUsersRequestDto = {
1065
1082
  /**
1066
1083
  * Free-text search across username, email and profile fields
@@ -3193,6 +3210,10 @@ export type ApiTokenResponseDto = {
3193
3210
  * The last used date of the API token
3194
3211
  */
3195
3212
  lastUsedAt: string | null;
3213
+ /**
3214
+ * Usage count of the API token
3215
+ */
3216
+ usageCount: number;
3196
3217
  /**
3197
3218
  * The role ID of the API token
3198
3219
  */
@@ -3215,6 +3236,10 @@ export type CreateApiTokenRequestDto = {
3215
3236
  * The role ID of the API token
3216
3237
  */
3217
3238
  roleId?: string;
3239
+ /**
3240
+ * The role tag of the API token
3241
+ */
3242
+ roleTag?: string;
3218
3243
  };
3219
3244
  export type UpdateApiTokenRequestDto = {
3220
3245
  /**
@@ -3229,6 +3254,10 @@ export type UpdateApiTokenRequestDto = {
3229
3254
  * The role ID of the API token
3230
3255
  */
3231
3256
  roleId?: string;
3257
+ /**
3258
+ * The role tag of the API token
3259
+ */
3260
+ roleTag?: string;
3232
3261
  };
3233
3262
  export type BulkDeleteApiTokensRequestDto = {
3234
3263
  /**
@@ -3287,7 +3316,7 @@ export type CloudVendor = 'aws' | 'azure';
3287
3316
  export type UpdateInvestigationDto = {
3288
3317
  [key: string]: unknown;
3289
3318
  };
3290
- export type FilterInvestigationSectionDataDto = {
3319
+ export type FilterInvestigationEvidenceDataDto = {
3291
3320
  [key: string]: unknown;
3292
3321
  };
3293
3322
  export type ExportInvestigationFlaggedEvidenceDto = {
@@ -3810,6 +3839,12 @@ export type AutomationDto = {
3810
3839
  export type FilterAutomationsDto = {
3811
3840
  [key: string]: unknown;
3812
3841
  };
3842
+ export type SendHttpRequestConfigDto = {
3843
+ [key: string]: unknown;
3844
+ };
3845
+ export type TestSendEmailDto = {
3846
+ [key: string]: unknown;
3847
+ };
3813
3848
  export type CreateFullTextSearchProfileRequestDto = {
3814
3849
  /**
3815
3850
  * The name of the full text search profile
@@ -4033,11 +4068,11 @@ export type ImageAcquisitionEvidencesDto = {
4033
4068
  };
4034
4069
  export type CreateImageEvidenceAcquisitionProfileRequestDto = {
4035
4070
  /**
4036
- * The name of the image evidence acquisition profile
4071
+ * The name of the disk image acquisition profile
4037
4072
  */
4038
4073
  name: string;
4039
4074
  /**
4040
- * The organization IDs to associate with the image evidence acquisition profile
4075
+ * The organization IDs to associate with the disk image acquisition profile
4041
4076
  */
4042
4077
  organizationIds: Array<string>;
4043
4078
  /**
@@ -4059,7 +4094,7 @@ export type ImageEvidenceAcquisitionProfileResponseDto = {
4059
4094
  */
4060
4095
  _id: string;
4061
4096
  /**
4062
- * The name of the image evidence acquisition profile
4097
+ * The name of the disk image acquisition profile
4063
4098
  */
4064
4099
  name: string;
4065
4100
  /**
@@ -4109,11 +4144,11 @@ export type ImageEvidenceAcquisitionProfileResponseDto = {
4109
4144
  };
4110
4145
  export type UpdateImageEvidenceAcquisitionProfileRequestDto = {
4111
4146
  /**
4112
- * The name of the image evidence acquisition profile
4147
+ * The name of the disk image acquisition profile
4113
4148
  */
4114
4149
  name: string;
4115
4150
  /**
4116
- * The organization IDs to associate with the image evidence acquisition profile
4151
+ * The organization IDs to associate with the disk image acquisition profile
4117
4152
  */
4118
4153
  organizationIds: Array<string>;
4119
4154
  /**
@@ -4131,17 +4166,17 @@ export type UpdateImageEvidenceAcquisitionProfileRequestDto = {
4131
4166
  };
4132
4167
  export type BulkDeleteImageEvidenceAcquisitionProfileRequestDto = {
4133
4168
  /**
4134
- * Array of image evidence acquisition profile IDs to delete
4169
+ * Array of disk image acquisition profile IDs to delete
4135
4170
  */
4136
4171
  ids: Array<string>;
4137
4172
  };
4138
4173
  export type ImageEvidenceAcquisitionProfileFilterRequestDto = {
4139
4174
  /**
4140
- * Filter image evidence acquisition profiles by name
4175
+ * Filter disk image acquisition profiles by name
4141
4176
  */
4142
4177
  name?: string;
4143
4178
  /**
4144
- * Search term to filter image evidence acquisition profiles
4179
+ * Search term to filter disk image acquisition profiles
4145
4180
  */
4146
4181
  searchTerm?: string;
4147
4182
  /**
@@ -4380,6 +4415,9 @@ export type CreateUserDtoWritable = {
4380
4415
  export type UpdateUserDtoWritable = {
4381
4416
  [key: string]: unknown;
4382
4417
  };
4418
+ export type PartialUpdateUserDtoWritable = {
4419
+ [key: string]: unknown;
4420
+ };
4383
4421
  export type CreateApiUserDtoWritable = {
4384
4422
  [key: string]: unknown;
4385
4423
  };
@@ -4539,7 +4577,7 @@ export type FilterCloudAccountsDtoWritable = {
4539
4577
  export type UpdateInvestigationDtoWritable = {
4540
4578
  [key: string]: unknown;
4541
4579
  };
4542
- export type FilterInvestigationSectionDataDtoWritable = {
4580
+ export type FilterInvestigationEvidenceDataDtoWritable = {
4543
4581
  [key: string]: unknown;
4544
4582
  };
4545
4583
  export type ExportInvestigationFlaggedEvidenceDtoWritable = {
@@ -4740,6 +4778,12 @@ export type AutomationDtoWritable = {
4740
4778
  export type FilterAutomationsDtoWritable = {
4741
4779
  [key: string]: unknown;
4742
4780
  };
4781
+ export type SendHttpRequestConfigDtoWritable = {
4782
+ [key: string]: unknown;
4783
+ };
4784
+ export type TestSendEmailDtoWritable = {
4785
+ [key: string]: unknown;
4786
+ };
4743
4787
  export type KeywordInfoDtoWritable = {
4744
4788
  [key: string]: unknown;
4745
4789
  };
@@ -5519,6 +5563,28 @@ export type EndpointUpdateEndpointConnectionRoute1Data = {
5519
5563
  export type EndpointUpdateEndpointConnectionRoute1Responses = {
5520
5564
  200: unknown;
5521
5565
  };
5566
+ export type EndpointSetMaintenanceModeData = {
5567
+ body: SetMaintenanceModeDto;
5568
+ path: {
5569
+ endpointId: string;
5570
+ };
5571
+ query?: never;
5572
+ url: '/api/public/endpoints/{endpointId}/maintenance-mode';
5573
+ };
5574
+ export type EndpointSetMaintenanceModeResponses = {
5575
+ 201: unknown;
5576
+ };
5577
+ export type EndpointSetMaintenanceMode1Data = {
5578
+ body: SetMaintenanceModeDto;
5579
+ path: {
5580
+ endpointId: string;
5581
+ };
5582
+ query?: never;
5583
+ url: '/api/public/assets/{endpointId}/maintenance-mode';
5584
+ };
5585
+ export type EndpointSetMaintenanceMode1Responses = {
5586
+ 201: unknown;
5587
+ };
5522
5588
  export type EndpointTagFilterTagsData = {
5523
5589
  body?: never;
5524
5590
  path?: never;
@@ -6530,6 +6596,20 @@ export type UserManagementUsersGetResponses = {
6530
6596
  200: UserDto;
6531
6597
  };
6532
6598
  export type UserManagementUsersGetResponse = UserManagementUsersGetResponses[keyof UserManagementUsersGetResponses];
6599
+ export type UserPatchUserData = {
6600
+ body: PartialUpdateUserDtoWritable;
6601
+ path: {
6602
+ /**
6603
+ * User ID
6604
+ */
6605
+ id: string;
6606
+ };
6607
+ query?: never;
6608
+ url: '/api/public/user-management/users/{id}';
6609
+ };
6610
+ export type UserPatchUserResponses = {
6611
+ 200: unknown;
6612
+ };
6533
6613
  export type UserUpdateUserData = {
6534
6614
  body: UpdateUserDtoWritable;
6535
6615
  path: {
@@ -9308,7 +9388,7 @@ export type InvestigationGetInvestigationMigrationsSummaryData = {
9308
9388
  export type InvestigationGetInvestigationMigrationsSummaryResponses = {
9309
9389
  200: unknown;
9310
9390
  };
9311
- export type InvestigationGetSectionDataStructureData = {
9391
+ export type InvestigationGetEvidenceDataStructureData = {
9312
9392
  body?: never;
9313
9393
  path: {
9314
9394
  investigationId: string;
@@ -9318,11 +9398,11 @@ export type InvestigationGetSectionDataStructureData = {
9318
9398
  query?: never;
9319
9399
  url: '/api/public/investigation-hub/investigations/{investigationId}/platform/{platform}/evidence-category/{evidenceCategory}/structure';
9320
9400
  };
9321
- export type InvestigationGetSectionDataStructureResponses = {
9401
+ export type InvestigationGetEvidenceDataStructureResponses = {
9322
9402
  200: unknown;
9323
9403
  };
9324
- export type InvestigationGetSectionDataData = {
9325
- body: FilterInvestigationSectionDataDtoWritable;
9404
+ export type InvestigationGetEvidenceDataData = {
9405
+ body: FilterInvestigationEvidenceDataDtoWritable;
9326
9406
  path: {
9327
9407
  investigationId: string;
9328
9408
  platform: string;
@@ -9331,7 +9411,20 @@ export type InvestigationGetSectionDataData = {
9331
9411
  query?: never;
9332
9412
  url: '/api/public/investigation-hub/investigations/{investigationId}/platform/{platform}/evidence-category/{evidenceCategory}';
9333
9413
  };
9334
- export type InvestigationGetSectionDataResponses = {
9414
+ export type InvestigationGetEvidenceDataResponses = {
9415
+ 201: unknown;
9416
+ };
9417
+ export type InvestigationGetEvidenceRelationDataData = {
9418
+ body: FilterInvestigationEvidenceDataDtoWritable;
9419
+ path: {
9420
+ investigationId: string;
9421
+ platform: string;
9422
+ evidenceCategory: string;
9423
+ };
9424
+ query?: never;
9425
+ url: '/api/public/investigation-hub/investigations/{investigationId}/platforms/{platform}/evidence-categories/{evidenceCategory}/relation-data';
9426
+ };
9427
+ export type InvestigationGetEvidenceRelationDataResponses = {
9335
9428
  201: unknown;
9336
9429
  };
9337
9430
  export type InvestigationExportFlagsData = {
@@ -9358,7 +9451,7 @@ export type InvestigationCreateExportRequestForFlagsData = {
9358
9451
  export type InvestigationCreateExportRequestForFlagsResponses = {
9359
9452
  201: unknown;
9360
9453
  };
9361
- export type InvestigationExportSectionDataData = {
9454
+ export type InvestigationExportEvidenceDataData = {
9362
9455
  body?: never;
9363
9456
  path: {
9364
9457
  investigationId: string;
@@ -9370,7 +9463,7 @@ export type InvestigationExportSectionDataData = {
9370
9463
  };
9371
9464
  url: '/api/public/investigation-hub/investigations/{investigationId}/platform/{platform}/evidence-category/{evidenceCategory}/export';
9372
9465
  };
9373
- export type InvestigationExportSectionDataResponses = {
9466
+ export type InvestigationExportEvidenceDataResponses = {
9374
9467
  200: unknown;
9375
9468
  };
9376
9469
  export type InvestigationCreateExportRequestForSectionDataData = {
@@ -10799,6 +10892,42 @@ export type AutomationHubGetActionTypesData = {
10799
10892
  export type AutomationHubGetActionTypesResponses = {
10800
10893
  200: unknown;
10801
10894
  };
10895
+ export type AutomationHubTestSendHttpRequestData = {
10896
+ body: SendHttpRequestConfigDtoWritable;
10897
+ path?: never;
10898
+ query?: never;
10899
+ url: '/api/public/automation-hub/types/action/send-http-request/test';
10900
+ };
10901
+ export type AutomationHubTestSendHttpRequestErrors = {
10902
+ /**
10903
+ * HTTP request failed
10904
+ */
10905
+ 400: unknown;
10906
+ };
10907
+ export type AutomationHubTestSendHttpRequestResponses = {
10908
+ /**
10909
+ * HTTP request test succeeded
10910
+ */
10911
+ 200: unknown;
10912
+ };
10913
+ export type AutomationHubTestSendEmailData = {
10914
+ body: TestSendEmailDtoWritable;
10915
+ path?: never;
10916
+ query?: never;
10917
+ url: '/api/public/automation-hub/types/action/send-email/test';
10918
+ };
10919
+ export type AutomationHubTestSendEmailErrors = {
10920
+ /**
10921
+ * Email test failed
10922
+ */
10923
+ 400: unknown;
10924
+ };
10925
+ export type AutomationHubTestSendEmailResponses = {
10926
+ /**
10927
+ * Email test succeeded
10928
+ */
10929
+ 200: unknown;
10930
+ };
10802
10931
  export type AutomationHubGetTriggerTypesData = {
10803
10932
  body?: never;
10804
10933
  path?: never;
@@ -11118,11 +11247,11 @@ export type ImageEvidenceAcquisitionProfilesGetManyData = {
11118
11247
  sortBy?: string;
11119
11248
  filter: ImageEvidenceAcquisitionProfileFilterRequestDto;
11120
11249
  };
11121
- url: '/api/public/image-evidence-acquisition-profiles';
11250
+ url: '/api/public/disk-image-acquisition-profiles';
11122
11251
  };
11123
11252
  export type ImageEvidenceAcquisitionProfilesGetManyResponses = {
11124
11253
  /**
11125
- * The image evidence acquisition profiles have been successfully retrieved.
11254
+ * The disk image acquisition profiles have been successfully retrieved.
11126
11255
  */
11127
11256
  200: PagingQueryResultDto;
11128
11257
  };
@@ -11131,11 +11260,11 @@ export type ImageEvidenceAcquisitionProfilesCreateData = {
11131
11260
  body: CreateImageEvidenceAcquisitionProfileRequestDto;
11132
11261
  path?: never;
11133
11262
  query?: never;
11134
- url: '/api/public/image-evidence-acquisition-profiles';
11263
+ url: '/api/public/disk-image-acquisition-profiles';
11135
11264
  };
11136
11265
  export type ImageEvidenceAcquisitionProfilesCreateResponses = {
11137
11266
  /**
11138
- * The image evidence acquisition profile has been successfully created.
11267
+ * The disk image acquisition profile has been successfully created.
11139
11268
  */
11140
11269
  200: ImageEvidenceAcquisitionProfileResponseDto;
11141
11270
  };
@@ -11144,16 +11273,16 @@ export type ImageEvidenceAcquisitionProfilesDeleteData = {
11144
11273
  body?: never;
11145
11274
  path: {
11146
11275
  /**
11147
- * The unique identifier of the image evidence acquisition profile
11276
+ * The unique identifier of the disk image acquisition profile
11148
11277
  */
11149
11278
  id: string;
11150
11279
  };
11151
11280
  query?: never;
11152
- url: '/api/public/image-evidence-acquisition-profiles/{id}';
11281
+ url: '/api/public/disk-image-acquisition-profiles/{id}';
11153
11282
  };
11154
11283
  export type ImageEvidenceAcquisitionProfilesDeleteResponses = {
11155
11284
  /**
11156
- * The image evidence acquisition profile by ID has been successfully deleted.
11285
+ * The disk image acquisition profile by ID has been successfully deleted.
11157
11286
  */
11158
11287
  200: unknown;
11159
11288
  };
@@ -11161,16 +11290,16 @@ export type ImageEvidenceAcquisitionProfilesGetOneData = {
11161
11290
  body?: never;
11162
11291
  path: {
11163
11292
  /**
11164
- * The unique identifier of the image evidence acquisition profile
11293
+ * The unique identifier of the disk image acquisition profile
11165
11294
  */
11166
11295
  id: string;
11167
11296
  };
11168
11297
  query?: never;
11169
- url: '/api/public/image-evidence-acquisition-profiles/{id}';
11298
+ url: '/api/public/disk-image-acquisition-profiles/{id}';
11170
11299
  };
11171
11300
  export type ImageEvidenceAcquisitionProfilesGetOneResponses = {
11172
11301
  /**
11173
- * The image evidence acquisition profile has been successfully retrieved.
11302
+ * The disk image acquisition profile has been successfully retrieved.
11174
11303
  */
11175
11304
  200: ImageEvidenceAcquisitionProfileResponseDto;
11176
11305
  };
@@ -11179,16 +11308,16 @@ export type ImageEvidenceAcquisitionProfilesUpdateData = {
11179
11308
  body: UpdateImageEvidenceAcquisitionProfileRequestDto;
11180
11309
  path: {
11181
11310
  /**
11182
- * The unique identifier of the image evidence acquisition profile
11311
+ * The unique identifier of the disk image acquisition profile
11183
11312
  */
11184
11313
  id: string;
11185
11314
  };
11186
11315
  query?: never;
11187
- url: '/api/public/image-evidence-acquisition-profiles/{id}';
11316
+ url: '/api/public/disk-image-acquisition-profiles/{id}';
11188
11317
  };
11189
11318
  export type ImageEvidenceAcquisitionProfilesUpdateResponses = {
11190
11319
  /**
11191
- * The image evidence acquisition profile has been successfully updated.
11320
+ * The disk image acquisition profile has been successfully updated.
11192
11321
  */
11193
11322
  200: ImageEvidenceAcquisitionProfileResponseDto;
11194
11323
  };
@@ -11197,11 +11326,11 @@ export type ImageEvidenceAcquisitionProfilesDeleteBulkData = {
11197
11326
  body: BulkDeleteImageEvidenceAcquisitionProfileRequestDto;
11198
11327
  path?: never;
11199
11328
  query?: never;
11200
- url: '/api/public/image-evidence-acquisition-profiles/bulk-delete';
11329
+ url: '/api/public/disk-image-acquisition-profiles/bulk-delete';
11201
11330
  };
11202
11331
  export type ImageEvidenceAcquisitionProfilesDeleteBulkResponses = {
11203
11332
  /**
11204
- * The image evidence acquisition profiles have been successfully deleted.
11333
+ * The disk image acquisition profiles have been successfully deleted.
11205
11334
  */
11206
11335
  200: unknown;
11207
11336
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@binalyze/air-sdk",
3
- "version": "5.6.1",
3
+ "version": "5.7.1",
4
4
  "private": false,
5
5
  "description": "Binalyze AIR - Typescript Axios SDK",
6
6
  "license": "MIT",