edge-impulse-api 1.93.26 → 1.93.27
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.
- package/build/browser/edge-impulse-api.d.ts +2385 -12
- package/build/browser/edge-impulse-api.js +7228 -803
- package/build/browser/edge-impulse-api.js.map +1 -1
- package/build/library/sdk/api/adminApi.d.ts +297 -0
- package/build/library/sdk/api/adminApi.js +891 -99
- package/build/library/sdk/api/adminApi.js.map +1 -1
- package/build/library/sdk/api/authApi.d.ts +3 -0
- package/build/library/sdk/api/authApi.js +9 -1
- package/build/library/sdk/api/authApi.js.map +1 -1
- package/build/library/sdk/api/cDNApi.d.ts +3 -0
- package/build/library/sdk/api/cDNApi.js +9 -1
- package/build/library/sdk/api/cDNApi.js.map +1 -1
- package/build/library/sdk/api/canaryApi.d.ts +3 -0
- package/build/library/sdk/api/canaryApi.js +9 -1
- package/build/library/sdk/api/canaryApi.js.map +1 -1
- package/build/library/sdk/api/classifyApi.d.ts +30 -0
- package/build/library/sdk/api/classifyApi.js +90 -10
- package/build/library/sdk/api/classifyApi.js.map +1 -1
- package/build/library/sdk/api/dSPApi.d.ts +57 -0
- package/build/library/sdk/api/dSPApi.js +171 -19
- package/build/library/sdk/api/dSPApi.js.map +1 -1
- package/build/library/sdk/api/datasetVersionsApi.d.ts +18 -0
- package/build/library/sdk/api/datasetVersionsApi.js +54 -6
- package/build/library/sdk/api/datasetVersionsApi.js.map +1 -1
- package/build/library/sdk/api/deploymentApi.d.ts +51 -0
- package/build/library/sdk/api/deploymentApi.js +153 -17
- package/build/library/sdk/api/deploymentApi.js.map +1 -1
- package/build/library/sdk/api/devicesApi.d.ts +48 -0
- package/build/library/sdk/api/devicesApi.js +144 -16
- package/build/library/sdk/api/devicesApi.js.map +1 -1
- package/build/library/sdk/api/emailVerificationApi.d.ts +12 -0
- package/build/library/sdk/api/emailVerificationApi.js +36 -4
- package/build/library/sdk/api/emailVerificationApi.js.map +1 -1
- package/build/library/sdk/api/exportApi.d.ts +6 -0
- package/build/library/sdk/api/exportApi.js +18 -2
- package/build/library/sdk/api/exportApi.js.map +1 -1
- package/build/library/sdk/api/featureFlagsApi.d.ts +3 -0
- package/build/library/sdk/api/featureFlagsApi.js +9 -1
- package/build/library/sdk/api/featureFlagsApi.js.map +1 -1
- package/build/library/sdk/api/healthApi.d.ts +6 -0
- package/build/library/sdk/api/healthApi.js +18 -2
- package/build/library/sdk/api/healthApi.js.map +1 -1
- package/build/library/sdk/api/impulseApi.d.ts +54 -0
- package/build/library/sdk/api/impulseApi.js +162 -18
- package/build/library/sdk/api/impulseApi.js.map +1 -1
- package/build/library/sdk/api/integrationsApi.d.ts +6 -0
- package/build/library/sdk/api/integrationsApi.js +18 -2
- package/build/library/sdk/api/integrationsApi.js.map +1 -1
- package/build/library/sdk/api/jobsApi.d.ts +135 -0
- package/build/library/sdk/api/jobsApi.js +409 -45
- package/build/library/sdk/api/jobsApi.js.map +1 -1
- package/build/library/sdk/api/learnApi.d.ts +87 -0
- package/build/library/sdk/api/learnApi.js +261 -29
- package/build/library/sdk/api/learnApi.js.map +1 -1
- package/build/library/sdk/api/loginApi.d.ts +6 -0
- package/build/library/sdk/api/loginApi.js +18 -2
- package/build/library/sdk/api/loginApi.js.map +1 -1
- package/build/library/sdk/api/metricsApi.d.ts +9 -0
- package/build/library/sdk/api/metricsApi.js +27 -3
- package/build/library/sdk/api/metricsApi.js.map +1 -1
- package/build/library/sdk/api/monitoringApi.d.ts +39 -0
- package/build/library/sdk/api/monitoringApi.js +117 -13
- package/build/library/sdk/api/monitoringApi.js.map +1 -1
- package/build/library/sdk/api/optimizationApi.d.ts +51 -0
- package/build/library/sdk/api/optimizationApi.js +153 -17
- package/build/library/sdk/api/optimizationApi.js.map +1 -1
- package/build/library/sdk/api/organizationBlocksApi.d.ts +105 -0
- package/build/library/sdk/api/organizationBlocksApi.js +315 -35
- package/build/library/sdk/api/organizationBlocksApi.js.map +1 -1
- package/build/library/sdk/api/organizationCreateProjectApi.d.ts +45 -0
- package/build/library/sdk/api/organizationCreateProjectApi.js +135 -15
- package/build/library/sdk/api/organizationCreateProjectApi.js.map +1 -1
- package/build/library/sdk/api/organizationDataApi.d.ts +120 -0
- package/build/library/sdk/api/organizationDataApi.js +360 -40
- package/build/library/sdk/api/organizationDataApi.js.map +1 -1
- package/build/library/sdk/api/organizationDataCampaignsApi.d.ts +36 -0
- package/build/library/sdk/api/organizationDataCampaignsApi.js +108 -12
- package/build/library/sdk/api/organizationDataCampaignsApi.js.map +1 -1
- package/build/library/sdk/api/organizationJobsApi.d.ts +24 -0
- package/build/library/sdk/api/organizationJobsApi.js +72 -8
- package/build/library/sdk/api/organizationJobsApi.js.map +1 -1
- package/build/library/sdk/api/organizationPipelinesApi.d.ts +24 -0
- package/build/library/sdk/api/organizationPipelinesApi.js +72 -8
- package/build/library/sdk/api/organizationPipelinesApi.js.map +1 -1
- package/build/library/sdk/api/organizationPortalsApi.d.ts +21 -0
- package/build/library/sdk/api/organizationPortalsApi.js +63 -7
- package/build/library/sdk/api/organizationPortalsApi.js.map +1 -1
- package/build/library/sdk/api/organizationsApi.d.ts +242 -2
- package/build/library/sdk/api/organizationsApi.js +722 -82
- package/build/library/sdk/api/organizationsApi.js.map +1 -1
- package/build/library/sdk/api/performanceCalibrationApi.d.ts +33 -0
- package/build/library/sdk/api/performanceCalibrationApi.js +99 -11
- package/build/library/sdk/api/performanceCalibrationApi.js.map +1 -1
- package/build/library/sdk/api/postProcessingApi.d.ts +15 -0
- package/build/library/sdk/api/postProcessingApi.js +45 -5
- package/build/library/sdk/api/postProcessingApi.js.map +1 -1
- package/build/library/sdk/api/projectsApi.d.ts +282 -1
- package/build/library/sdk/api/projectsApi.js +991 -66
- package/build/library/sdk/api/projectsApi.js.map +1 -1
- package/build/library/sdk/api/rawDataApi.d.ts +207 -0
- package/build/library/sdk/api/rawDataApi.js +621 -69
- package/build/library/sdk/api/rawDataApi.js.map +1 -1
- package/build/library/sdk/api/testApi.d.ts +12 -0
- package/build/library/sdk/api/testApi.js +36 -4
- package/build/library/sdk/api/testApi.js.map +1 -1
- package/build/library/sdk/api/themesApi.d.ts +18 -0
- package/build/library/sdk/api/themesApi.js +54 -6
- package/build/library/sdk/api/themesApi.js.map +1 -1
- package/build/library/sdk/api/thirdPartyAuthApi.d.ts +21 -0
- package/build/library/sdk/api/thirdPartyAuthApi.js +63 -7
- package/build/library/sdk/api/thirdPartyAuthApi.js.map +1 -1
- package/build/library/sdk/api/uploadPortalApi.d.ts +21 -0
- package/build/library/sdk/api/uploadPortalApi.js +63 -7
- package/build/library/sdk/api/uploadPortalApi.js.map +1 -1
- package/build/library/sdk/api/userApi.d.ts +147 -0
- package/build/library/sdk/api/userApi.js +441 -49
- package/build/library/sdk/api/userApi.js.map +1 -1
- package/build/library/sdk/api/vlmApi.d.ts +15 -0
- package/build/library/sdk/api/vlmApi.js +45 -5
- package/build/library/sdk/api/vlmApi.js.map +1 -1
- package/build/library/sdk/api/whitelabelsApi.d.ts +24 -0
- package/build/library/sdk/api/whitelabelsApi.js +72 -8
- package/build/library/sdk/api/whitelabelsApi.js.map +1 -1
- package/build/library/sdk/model/getExtensionSharedStateListResponse.d.ts +14 -0
- package/build/library/sdk/model/getExtensionSharedStateListResponse.js +4 -0
- package/build/library/sdk/model/getExtensionSharedStateListResponse.js.map +1 -0
- package/build/library/sdk/model/models.d.ts +3 -0
- package/build/library/sdk/model/models.js +3 -0
- package/build/library/sdk/model/models.js.map +1 -1
- package/build/library/sdk/model/oAuthScope.d.ts +1 -1
- package/build/library/sdk/model/oAuthScope.js +1 -1
- package/build/library/sdk/model/oAuthScope.js.map +1 -1
- package/build/library/sdk/model/setExtensionSharedStateRequest.d.ts +13 -0
- package/build/library/sdk/model/setExtensionSharedStateRequest.js +4 -0
- package/build/library/sdk/model/setExtensionSharedStateRequest.js.map +1 -0
- package/build/library/sdk/model/setExtensionSharedStateResponse.d.ts +11 -0
- package/build/library/sdk/model/setExtensionSharedStateResponse.js +4 -0
- package/build/library/sdk/model/setExtensionSharedStateResponse.js.map +1 -0
- package/package.json +1 -1
|
@@ -257,6 +257,9 @@ export declare class AdminApi {
|
|
|
257
257
|
headers: {
|
|
258
258
|
[name: string]: string;
|
|
259
259
|
};
|
|
260
|
+
responseHeadersCallback?: (headers: {
|
|
261
|
+
[name: string]: string;
|
|
262
|
+
}) => void;
|
|
260
263
|
}): Promise<GenericApiResponse>;
|
|
261
264
|
/**
|
|
262
265
|
* Admin-only API to set the list of identity provider for a given domain.
|
|
@@ -268,6 +271,9 @@ export declare class AdminApi {
|
|
|
268
271
|
headers: {
|
|
269
272
|
[name: string]: string;
|
|
270
273
|
};
|
|
274
|
+
responseHeadersCallback?: (headers: {
|
|
275
|
+
[name: string]: string;
|
|
276
|
+
}) => void;
|
|
271
277
|
}): Promise<GenericApiResponse>;
|
|
272
278
|
/**
|
|
273
279
|
* Admin-only API to add a user to an organization. If no user is provided, the current user is used.
|
|
@@ -279,6 +285,9 @@ export declare class AdminApi {
|
|
|
279
285
|
headers: {
|
|
280
286
|
[name: string]: string;
|
|
281
287
|
};
|
|
288
|
+
responseHeadersCallback?: (headers: {
|
|
289
|
+
[name: string]: string;
|
|
290
|
+
}) => void;
|
|
282
291
|
}): Promise<GenericApiResponse>;
|
|
283
292
|
/**
|
|
284
293
|
* Admin-only API to add a user to a project. If no user is provided, the current user is used.
|
|
@@ -290,6 +299,9 @@ export declare class AdminApi {
|
|
|
290
299
|
headers: {
|
|
291
300
|
[name: string]: string;
|
|
292
301
|
};
|
|
302
|
+
responseHeadersCallback?: (headers: {
|
|
303
|
+
[name: string]: string;
|
|
304
|
+
}) => void;
|
|
293
305
|
}): Promise<GenericApiResponse>;
|
|
294
306
|
/**
|
|
295
307
|
* DEPRECATED. Admin-only API to add the current user to a project.
|
|
@@ -300,6 +312,9 @@ export declare class AdminApi {
|
|
|
300
312
|
headers: {
|
|
301
313
|
[name: string]: string;
|
|
302
314
|
};
|
|
315
|
+
responseHeadersCallback?: (headers: {
|
|
316
|
+
[name: string]: string;
|
|
317
|
+
}) => void;
|
|
303
318
|
}): Promise<GenericApiResponse>;
|
|
304
319
|
/**
|
|
305
320
|
* Admin-only API to create a new global metrics report. A job is created to process the report request and the job details are returned in the response.
|
|
@@ -311,6 +326,9 @@ export declare class AdminApi {
|
|
|
311
326
|
headers: {
|
|
312
327
|
[name: string]: string;
|
|
313
328
|
};
|
|
329
|
+
responseHeadersCallback?: (headers: {
|
|
330
|
+
[name: string]: string;
|
|
331
|
+
}) => void;
|
|
314
332
|
}): Promise<StartJobResponse>;
|
|
315
333
|
/**
|
|
316
334
|
* Create a new OAuth client in the system. This endpoint generates a unique client ID and secret that will be used for OAuth authentication. The client can be configured with specific redirect URIs, allowed grant types, and scopes. By default, the authorization_code grant type is enabled. Requires admin:oauth:write permission.
|
|
@@ -321,6 +339,9 @@ export declare class AdminApi {
|
|
|
321
339
|
headers: {
|
|
322
340
|
[name: string]: string;
|
|
323
341
|
};
|
|
342
|
+
responseHeadersCallback?: (headers: {
|
|
343
|
+
[name: string]: string;
|
|
344
|
+
}) => void;
|
|
324
345
|
}): Promise<AdminCreateOauthClientResponse>;
|
|
325
346
|
/**
|
|
326
347
|
* Admin-only API to create a new organization.
|
|
@@ -331,6 +352,9 @@ export declare class AdminApi {
|
|
|
331
352
|
headers: {
|
|
332
353
|
[name: string]: string;
|
|
333
354
|
};
|
|
355
|
+
responseHeadersCallback?: (headers: {
|
|
356
|
+
[name: string]: string;
|
|
357
|
+
}) => void;
|
|
334
358
|
}): Promise<CreateOrganizationResponse>;
|
|
335
359
|
/**
|
|
336
360
|
* Admin-only API to create a new data export for an organization. A job is created to process the export request and the job details are returned in the response.
|
|
@@ -342,6 +366,9 @@ export declare class AdminApi {
|
|
|
342
366
|
headers: {
|
|
343
367
|
[name: string]: string;
|
|
344
368
|
};
|
|
369
|
+
responseHeadersCallback?: (headers: {
|
|
370
|
+
[name: string]: string;
|
|
371
|
+
}) => void;
|
|
345
372
|
}): Promise<StartJobResponse>;
|
|
346
373
|
/**
|
|
347
374
|
* Admin-only API to create a new project for an organization.
|
|
@@ -353,6 +380,9 @@ export declare class AdminApi {
|
|
|
353
380
|
headers: {
|
|
354
381
|
[name: string]: string;
|
|
355
382
|
};
|
|
383
|
+
responseHeadersCallback?: (headers: {
|
|
384
|
+
[name: string]: string;
|
|
385
|
+
}) => void;
|
|
356
386
|
}): Promise<CreateProjectResponse>;
|
|
357
387
|
/**
|
|
358
388
|
* Admin-only API to create a new usage report for an organization. A job is created to process the report request and the job details are returned in the response.
|
|
@@ -365,6 +395,9 @@ export declare class AdminApi {
|
|
|
365
395
|
headers: {
|
|
366
396
|
[name: string]: string;
|
|
367
397
|
};
|
|
398
|
+
responseHeadersCallback?: (headers: {
|
|
399
|
+
[name: string]: string;
|
|
400
|
+
}) => void;
|
|
368
401
|
}): Promise<StartJobResponse>;
|
|
369
402
|
/**
|
|
370
403
|
* Admin-only API to create a new free tier project.
|
|
@@ -375,6 +408,9 @@ export declare class AdminApi {
|
|
|
375
408
|
headers: {
|
|
376
409
|
[name: string]: string;
|
|
377
410
|
};
|
|
411
|
+
responseHeadersCallback?: (headers: {
|
|
412
|
+
[name: string]: string;
|
|
413
|
+
}) => void;
|
|
378
414
|
}): Promise<CreateProjectResponse>;
|
|
379
415
|
/**
|
|
380
416
|
* Admin-only API to create a new signup approval request for a user. This operation will also send a verification code to the specified approver email address.
|
|
@@ -386,6 +422,9 @@ export declare class AdminApi {
|
|
|
386
422
|
headers: {
|
|
387
423
|
[name: string]: string;
|
|
388
424
|
};
|
|
425
|
+
responseHeadersCallback?: (headers: {
|
|
426
|
+
[name: string]: string;
|
|
427
|
+
}) => void;
|
|
389
428
|
}): Promise<EntityCreatedResponse>;
|
|
390
429
|
/**
|
|
391
430
|
* Admin-only API to create an enterprise trial for a user.
|
|
@@ -396,6 +435,9 @@ export declare class AdminApi {
|
|
|
396
435
|
headers: {
|
|
397
436
|
[name: string]: string;
|
|
398
437
|
};
|
|
438
|
+
responseHeadersCallback?: (headers: {
|
|
439
|
+
[name: string]: string;
|
|
440
|
+
}) => void;
|
|
399
441
|
}): Promise<EntityCreatedResponse>;
|
|
400
442
|
/**
|
|
401
443
|
* Admin-only API to delete an email domain from the list of disallowed email domains.
|
|
@@ -406,6 +448,9 @@ export declare class AdminApi {
|
|
|
406
448
|
headers: {
|
|
407
449
|
[name: string]: string;
|
|
408
450
|
};
|
|
451
|
+
responseHeadersCallback?: (headers: {
|
|
452
|
+
[name: string]: string;
|
|
453
|
+
}) => void;
|
|
409
454
|
}): Promise<GenericApiResponse>;
|
|
410
455
|
/**
|
|
411
456
|
* Admin-only API to delete a global metrics report.
|
|
@@ -416,6 +461,9 @@ export declare class AdminApi {
|
|
|
416
461
|
headers: {
|
|
417
462
|
[name: string]: string;
|
|
418
463
|
};
|
|
464
|
+
responseHeadersCallback?: (headers: {
|
|
465
|
+
[name: string]: string;
|
|
466
|
+
}) => void;
|
|
419
467
|
}): Promise<GenericApiResponse>;
|
|
420
468
|
/**
|
|
421
469
|
* Deactivate an existing OAuth client. This operation performs a soft delete, marking the client as inactive while preserving its historical data. The client\'s credentials will no longer be valid for new OAuth flows. Requires admin:oauth:write permission.
|
|
@@ -426,6 +474,9 @@ export declare class AdminApi {
|
|
|
426
474
|
headers: {
|
|
427
475
|
[name: string]: string;
|
|
428
476
|
};
|
|
477
|
+
responseHeadersCallback?: (headers: {
|
|
478
|
+
[name: string]: string;
|
|
479
|
+
}) => void;
|
|
429
480
|
}): Promise<GenericApiResponse>;
|
|
430
481
|
/**
|
|
431
482
|
* Delete the logo for an existing OAuth client. This endpoint allows deleting the client\'s logo.
|
|
@@ -436,6 +487,9 @@ export declare class AdminApi {
|
|
|
436
487
|
headers: {
|
|
437
488
|
[name: string]: string;
|
|
438
489
|
};
|
|
490
|
+
responseHeadersCallback?: (headers: {
|
|
491
|
+
[name: string]: string;
|
|
492
|
+
}) => void;
|
|
439
493
|
}): Promise<GenericApiResponse>;
|
|
440
494
|
/**
|
|
441
495
|
* Admin-only API to delete an organization. The deletion process varies based on the `fullDelete` parameter: **Soft Delete** (default, `fullDelete=false`): - Organization is marked as deleted in the database - Organization remains hidden from the product - All data is preserved and recoverable - No data is removed from S3 or FSx **Full Delete** (`fullDelete=true`): 1. Immediate soft deletion - Organization is marked as deleted and hidden from the product - Access is immediately revoked for all organization members 2. Data preservation - S3 and FSx assets are moved to a trash bin 3. Scheduled permanent deletion - A 30-day grace period begins - After 30 days, all organization data and S3 and FSx assets are permanently deleted - During the grace period: - Deletion can be cancelled by administrators - Data can be recovered if needed - Progress can be monitored via admin API
|
|
@@ -447,6 +501,9 @@ export declare class AdminApi {
|
|
|
447
501
|
headers: {
|
|
448
502
|
[name: string]: string;
|
|
449
503
|
};
|
|
504
|
+
responseHeadersCallback?: (headers: {
|
|
505
|
+
[name: string]: string;
|
|
506
|
+
}) => void;
|
|
450
507
|
}): Promise<StartJobResponse>;
|
|
451
508
|
/**
|
|
452
509
|
* Admin-only API to delete a data export for an organization.
|
|
@@ -458,6 +515,9 @@ export declare class AdminApi {
|
|
|
458
515
|
headers: {
|
|
459
516
|
[name: string]: string;
|
|
460
517
|
};
|
|
518
|
+
responseHeadersCallback?: (headers: {
|
|
519
|
+
[name: string]: string;
|
|
520
|
+
}) => void;
|
|
461
521
|
}): Promise<GenericApiResponse>;
|
|
462
522
|
/**
|
|
463
523
|
* Admin-only API to delete a usage report for an organization.
|
|
@@ -469,6 +529,9 @@ export declare class AdminApi {
|
|
|
469
529
|
headers: {
|
|
470
530
|
[name: string]: string;
|
|
471
531
|
};
|
|
532
|
+
responseHeadersCallback?: (headers: {
|
|
533
|
+
[name: string]: string;
|
|
534
|
+
}) => void;
|
|
472
535
|
}): Promise<GenericApiResponse>;
|
|
473
536
|
/**
|
|
474
537
|
* Admin-only API to delete a project.
|
|
@@ -480,6 +543,9 @@ export declare class AdminApi {
|
|
|
480
543
|
headers: {
|
|
481
544
|
[name: string]: string;
|
|
482
545
|
};
|
|
546
|
+
responseHeadersCallback?: (headers: {
|
|
547
|
+
[name: string]: string;
|
|
548
|
+
}) => void;
|
|
483
549
|
}): Promise<GenericApiResponse>;
|
|
484
550
|
/**
|
|
485
551
|
* Admin-only API to delete the list of identity providers for a given domain.
|
|
@@ -490,6 +556,9 @@ export declare class AdminApi {
|
|
|
490
556
|
headers: {
|
|
491
557
|
[name: string]: string;
|
|
492
558
|
};
|
|
559
|
+
responseHeadersCallback?: (headers: {
|
|
560
|
+
[name: string]: string;
|
|
561
|
+
}) => void;
|
|
493
562
|
}): Promise<GenericApiResponse>;
|
|
494
563
|
/**
|
|
495
564
|
* Admin-only API to delete a studio config item.
|
|
@@ -500,6 +569,9 @@ export declare class AdminApi {
|
|
|
500
569
|
headers: {
|
|
501
570
|
[name: string]: string;
|
|
502
571
|
};
|
|
572
|
+
responseHeadersCallback?: (headers: {
|
|
573
|
+
[name: string]: string;
|
|
574
|
+
}) => void;
|
|
503
575
|
}): Promise<GenericApiResponse>;
|
|
504
576
|
/**
|
|
505
577
|
* Admin-only API to delete an enterprise trial.
|
|
@@ -510,6 +582,9 @@ export declare class AdminApi {
|
|
|
510
582
|
headers: {
|
|
511
583
|
[name: string]: string;
|
|
512
584
|
};
|
|
585
|
+
responseHeadersCallback?: (headers: {
|
|
586
|
+
[name: string]: string;
|
|
587
|
+
}) => void;
|
|
513
588
|
}): Promise<GenericApiResponse>;
|
|
514
589
|
/**
|
|
515
590
|
* Admin-only API to delete a user. The deletion process varies based on the `fullDelete` parameter: **Soft Delete** (default, `fullDelete=false`): - User is marked as deleted in the database - User remains hidden from the product - All data is preserved and recoverable - No data is removed from S3 or FSx - User is unsubscribed from marketing communications - Any active subscriptions are cancelled **Full Delete** (`fullDelete=true`): 1. Immediate soft deletion - User is marked as deleted and hidden from the product - Access is immediately revoked - User is unsubscribed from marketing communications - Any active subscriptions are cancelled 2. Data preservation - S3 and FSx assets are moved to a trash bin 3. Scheduled permanent deletion - A 30-day grace period begins - After 30 days, all user data and S3 and FSx assets are permanently deleted - During the grace period: - Deletion can be cancelled by administrators - Data can be recovered if needed - Progress can be monitored via admin API
|
|
@@ -522,6 +597,9 @@ export declare class AdminApi {
|
|
|
522
597
|
headers: {
|
|
523
598
|
[name: string]: string;
|
|
524
599
|
};
|
|
600
|
+
responseHeadersCallback?: (headers: {
|
|
601
|
+
[name: string]: string;
|
|
602
|
+
}) => void;
|
|
525
603
|
}): Promise<StartJobResponse>;
|
|
526
604
|
/**
|
|
527
605
|
* Admin-only API to delete a feature flag. Deleting a feature flag essentially disables the feature for all users.
|
|
@@ -532,6 +610,9 @@ export declare class AdminApi {
|
|
|
532
610
|
headers: {
|
|
533
611
|
[name: string]: string;
|
|
534
612
|
};
|
|
613
|
+
responseHeadersCallback?: (headers: {
|
|
614
|
+
[name: string]: string;
|
|
615
|
+
}) => void;
|
|
535
616
|
}): Promise<GenericApiResponse>;
|
|
536
617
|
/**
|
|
537
618
|
* Admin-only API to download a global metrics report.
|
|
@@ -542,6 +623,9 @@ export declare class AdminApi {
|
|
|
542
623
|
headers: {
|
|
543
624
|
[name: string]: string;
|
|
544
625
|
};
|
|
626
|
+
responseHeadersCallback?: (headers: {
|
|
627
|
+
[name: string]: string;
|
|
628
|
+
}) => void;
|
|
545
629
|
}): Promise<any>;
|
|
546
630
|
/**
|
|
547
631
|
* Admin-only API to download a usage report for an organization.
|
|
@@ -553,6 +637,9 @@ export declare class AdminApi {
|
|
|
553
637
|
headers: {
|
|
554
638
|
[name: string]: string;
|
|
555
639
|
};
|
|
640
|
+
responseHeadersCallback?: (headers: {
|
|
641
|
+
[name: string]: string;
|
|
642
|
+
}) => void;
|
|
556
643
|
}): Promise<any>;
|
|
557
644
|
/**
|
|
558
645
|
* ⚠️ DANGER: This is a highly destructive maintenance endpoint that forcefully deletes all content from the trash bin, regardless of grace period status. This should only be used for: - Internal testing purposes - Manual maintenance tasks - Emergency cleanup operations Unlike the normal automatic deletion process which respects the 30-day grace period, this endpoint: - Immediately and permanently deletes ALL data in the trash bin - Bypasses the standard grace period checks - Cannot be undone - May delete data that would otherwise be recoverable The normal trash bin system works as follows: 1. When users/organizations are deleted with `fullDelete=true`: - Their data is moved to the trash bin - A 30-day grace period begins - The data remains recoverable during this period 2. During the 30-day grace period: - Data is preserved in its original structure - Administrators can recover data if needed - The deletion can be cancelled - Storage costs continue to accrue ⚠️ WARNING: - This endpoint bypasses all safety mechanisms - Data deletion is immediate and irreversible - Should not be used in normal operations - Requires explicit admin permissions - Consider using targeted deletion endpoints instead (i.e. /api/admin/trashbin/organizations/:id) Note: The system runs automated cleanup jobs periodically for normal maintenance. This endpoint should only be used in exceptional circumstances by authorized administrators.
|
|
@@ -562,6 +649,9 @@ export declare class AdminApi {
|
|
|
562
649
|
headers: {
|
|
563
650
|
[name: string]: string;
|
|
564
651
|
};
|
|
652
|
+
responseHeadersCallback?: (headers: {
|
|
653
|
+
[name: string]: string;
|
|
654
|
+
}) => void;
|
|
565
655
|
}): Promise<StartJobResponse>;
|
|
566
656
|
/**
|
|
567
657
|
* Admin-only API to set a feature flag ON. Setting a feature flag ON essentially enables the feature for all users.
|
|
@@ -572,6 +662,9 @@ export declare class AdminApi {
|
|
|
572
662
|
headers: {
|
|
573
663
|
[name: string]: string;
|
|
574
664
|
};
|
|
665
|
+
responseHeadersCallback?: (headers: {
|
|
666
|
+
[name: string]: string;
|
|
667
|
+
}) => void;
|
|
575
668
|
}): Promise<GenericApiResponse>;
|
|
576
669
|
/**
|
|
577
670
|
* DEPRECATED. Admin-only API to find a user by username or email address.
|
|
@@ -582,6 +675,9 @@ export declare class AdminApi {
|
|
|
582
675
|
headers: {
|
|
583
676
|
[name: string]: string;
|
|
584
677
|
};
|
|
678
|
+
responseHeadersCallback?: (headers: {
|
|
679
|
+
[name: string]: string;
|
|
680
|
+
}) => void;
|
|
585
681
|
}): Promise<FindUserResponse>;
|
|
586
682
|
/**
|
|
587
683
|
* DEPRECATED. Admin-only API to get list of all users that have been active in the past 30 days.
|
|
@@ -591,6 +687,9 @@ export declare class AdminApi {
|
|
|
591
687
|
headers: {
|
|
592
688
|
[name: string]: string;
|
|
593
689
|
};
|
|
690
|
+
responseHeadersCallback?: (headers: {
|
|
691
|
+
[name: string]: string;
|
|
692
|
+
}) => void;
|
|
594
693
|
}): Promise<AdminGetUserIdsResponse>;
|
|
595
694
|
/**
|
|
596
695
|
* DEPRECATED. Admin-only API to get list of all users.
|
|
@@ -600,6 +699,9 @@ export declare class AdminApi {
|
|
|
600
699
|
headers: {
|
|
601
700
|
[name: string]: string;
|
|
602
701
|
};
|
|
702
|
+
responseHeadersCallback?: (headers: {
|
|
703
|
+
[name: string]: string;
|
|
704
|
+
}) => void;
|
|
603
705
|
}): Promise<AdminGetUserIdsResponse>;
|
|
604
706
|
/**
|
|
605
707
|
* Admin-only API to get a data migration.
|
|
@@ -610,6 +712,9 @@ export declare class AdminApi {
|
|
|
610
712
|
headers: {
|
|
611
713
|
[name: string]: string;
|
|
612
714
|
};
|
|
715
|
+
responseHeadersCallback?: (headers: {
|
|
716
|
+
[name: string]: string;
|
|
717
|
+
}) => void;
|
|
613
718
|
}): Promise<AdminGetDataMigrationResponse>;
|
|
614
719
|
/**
|
|
615
720
|
* Admin-only API to get data migrations.
|
|
@@ -619,6 +724,9 @@ export declare class AdminApi {
|
|
|
619
724
|
headers: {
|
|
620
725
|
[name: string]: string;
|
|
621
726
|
};
|
|
727
|
+
responseHeadersCallback?: (headers: {
|
|
728
|
+
[name: string]: string;
|
|
729
|
+
}) => void;
|
|
622
730
|
}): Promise<AdminGetDataMigrationsResponse>;
|
|
623
731
|
/**
|
|
624
732
|
* Admin-only API to get the list of disallowed email domains.
|
|
@@ -628,6 +736,9 @@ export declare class AdminApi {
|
|
|
628
736
|
headers: {
|
|
629
737
|
[name: string]: string;
|
|
630
738
|
};
|
|
739
|
+
responseHeadersCallback?: (headers: {
|
|
740
|
+
[name: string]: string;
|
|
741
|
+
}) => void;
|
|
631
742
|
}): Promise<AdminGetDisallowedEmailDomainsResponse>;
|
|
632
743
|
/**
|
|
633
744
|
* Get the enterprise trial verification code of the specified email.
|
|
@@ -638,6 +749,9 @@ export declare class AdminApi {
|
|
|
638
749
|
headers: {
|
|
639
750
|
[name: string]: string;
|
|
640
751
|
};
|
|
752
|
+
responseHeadersCallback?: (headers: {
|
|
753
|
+
[name: string]: string;
|
|
754
|
+
}) => void;
|
|
641
755
|
}): Promise<GetEmailVerificationCodeResponse>;
|
|
642
756
|
/**
|
|
643
757
|
* Admin-only API to get all feature flags.
|
|
@@ -647,6 +761,9 @@ export declare class AdminApi {
|
|
|
647
761
|
headers: {
|
|
648
762
|
[name: string]: string;
|
|
649
763
|
};
|
|
764
|
+
responseHeadersCallback?: (headers: {
|
|
765
|
+
[name: string]: string;
|
|
766
|
+
}) => void;
|
|
650
767
|
}): Promise<GetFeatureFlagsResponse>;
|
|
651
768
|
/**
|
|
652
769
|
* Get the job execution details including inner jobs
|
|
@@ -659,6 +776,9 @@ export declare class AdminApi {
|
|
|
659
776
|
headers: {
|
|
660
777
|
[name: string]: string;
|
|
661
778
|
};
|
|
779
|
+
responseHeadersCallback?: (headers: {
|
|
780
|
+
[name: string]: string;
|
|
781
|
+
}) => void;
|
|
662
782
|
}): Promise<JobDetailsResponse>;
|
|
663
783
|
/**
|
|
664
784
|
* Get the logs for a job.
|
|
@@ -672,6 +792,9 @@ export declare class AdminApi {
|
|
|
672
792
|
headers: {
|
|
673
793
|
[name: string]: string;
|
|
674
794
|
};
|
|
795
|
+
responseHeadersCallback?: (headers: {
|
|
796
|
+
[name: string]: string;
|
|
797
|
+
}) => void;
|
|
675
798
|
}): Promise<JobLogsResponse>;
|
|
676
799
|
/**
|
|
677
800
|
* Get cpu/memory usage metrics, if the job is a Kubernetes job
|
|
@@ -683,6 +806,9 @@ export declare class AdminApi {
|
|
|
683
806
|
headers: {
|
|
684
807
|
[name: string]: string;
|
|
685
808
|
};
|
|
809
|
+
responseHeadersCallback?: (headers: {
|
|
810
|
+
[name: string]: string;
|
|
811
|
+
}) => void;
|
|
686
812
|
}): Promise<JobMetricsResponse>;
|
|
687
813
|
/**
|
|
688
814
|
* Admin-only API to get global metrics.
|
|
@@ -692,6 +818,9 @@ export declare class AdminApi {
|
|
|
692
818
|
headers: {
|
|
693
819
|
[name: string]: string;
|
|
694
820
|
};
|
|
821
|
+
responseHeadersCallback?: (headers: {
|
|
822
|
+
[name: string]: string;
|
|
823
|
+
}) => void;
|
|
695
824
|
}): Promise<AdminGetMetricsResponse>;
|
|
696
825
|
/**
|
|
697
826
|
* Admin-only API to get a global metrics report.
|
|
@@ -702,6 +831,9 @@ export declare class AdminApi {
|
|
|
702
831
|
headers: {
|
|
703
832
|
[name: string]: string;
|
|
704
833
|
};
|
|
834
|
+
responseHeadersCallback?: (headers: {
|
|
835
|
+
[name: string]: string;
|
|
836
|
+
}) => void;
|
|
705
837
|
}): Promise<AdminGetReportResponse>;
|
|
706
838
|
/**
|
|
707
839
|
* Admin-only API to get global metrics reports.
|
|
@@ -713,6 +845,9 @@ export declare class AdminApi {
|
|
|
713
845
|
headers: {
|
|
714
846
|
[name: string]: string;
|
|
715
847
|
};
|
|
848
|
+
responseHeadersCallback?: (headers: {
|
|
849
|
+
[name: string]: string;
|
|
850
|
+
}) => void;
|
|
716
851
|
}): Promise<AdminGetReportsResponse>;
|
|
717
852
|
/**
|
|
718
853
|
* Retrieve detailed information about a specific OAuth client, including its configuration, allowed grant types, redirect URIs, and creation metadata. The response includes the creator\'s information (name and email) who registered the client. Requires admin:oauth:read permission.
|
|
@@ -723,6 +858,9 @@ export declare class AdminApi {
|
|
|
723
858
|
headers: {
|
|
724
859
|
[name: string]: string;
|
|
725
860
|
};
|
|
861
|
+
responseHeadersCallback?: (headers: {
|
|
862
|
+
[name: string]: string;
|
|
863
|
+
}) => void;
|
|
726
864
|
}): Promise<AdminGetOauthClientResponse>;
|
|
727
865
|
/**
|
|
728
866
|
* Retrieve a paginated list of all registered OAuth clients in the system. The response includes client metadata such as name, redirect URIs, allowed grant types, and creation information. Results can be filtered, sorted, and searched using query parameters. Requires admin:oauth:read permission.
|
|
@@ -737,6 +875,9 @@ export declare class AdminApi {
|
|
|
737
875
|
headers: {
|
|
738
876
|
[name: string]: string;
|
|
739
877
|
};
|
|
878
|
+
responseHeadersCallback?: (headers: {
|
|
879
|
+
[name: string]: string;
|
|
880
|
+
}) => void;
|
|
740
881
|
}): Promise<AdminGetOauthClientsResponse>;
|
|
741
882
|
/**
|
|
742
883
|
* Admin-only API to get compute time usage for an organization over a period of time.
|
|
@@ -749,6 +890,9 @@ export declare class AdminApi {
|
|
|
749
890
|
headers: {
|
|
750
891
|
[name: string]: string;
|
|
751
892
|
};
|
|
893
|
+
responseHeadersCallback?: (headers: {
|
|
894
|
+
[name: string]: string;
|
|
895
|
+
}) => void;
|
|
752
896
|
}): Promise<AdminGetOrganizationComputeTimeUsageResponse>;
|
|
753
897
|
/**
|
|
754
898
|
* Admin-only API to get a data export for an organization.
|
|
@@ -760,6 +904,9 @@ export declare class AdminApi {
|
|
|
760
904
|
headers: {
|
|
761
905
|
[name: string]: string;
|
|
762
906
|
};
|
|
907
|
+
responseHeadersCallback?: (headers: {
|
|
908
|
+
[name: string]: string;
|
|
909
|
+
}) => void;
|
|
763
910
|
}): Promise<GetOrganizationDataExportResponse>;
|
|
764
911
|
/**
|
|
765
912
|
* Admin-only API to get the list of all data exports for an organization.
|
|
@@ -772,6 +919,9 @@ export declare class AdminApi {
|
|
|
772
919
|
headers: {
|
|
773
920
|
[name: string]: string;
|
|
774
921
|
};
|
|
922
|
+
responseHeadersCallback?: (headers: {
|
|
923
|
+
[name: string]: string;
|
|
924
|
+
}) => void;
|
|
775
925
|
}): Promise<GetOrganizationDataExportsResponse>;
|
|
776
926
|
/**
|
|
777
927
|
* Admin-only API to list all information about this organization.
|
|
@@ -783,6 +933,9 @@ export declare class AdminApi {
|
|
|
783
933
|
headers: {
|
|
784
934
|
[name: string]: string;
|
|
785
935
|
};
|
|
936
|
+
responseHeadersCallback?: (headers: {
|
|
937
|
+
[name: string]: string;
|
|
938
|
+
}) => void;
|
|
786
939
|
}): Promise<AdminOrganizationInfoResponse>;
|
|
787
940
|
/**
|
|
788
941
|
* Admin-only API to get the list of all jobs for a organization.
|
|
@@ -795,6 +948,9 @@ export declare class AdminApi {
|
|
|
795
948
|
headers: {
|
|
796
949
|
[name: string]: string;
|
|
797
950
|
};
|
|
951
|
+
responseHeadersCallback?: (headers: {
|
|
952
|
+
[name: string]: string;
|
|
953
|
+
}) => void;
|
|
798
954
|
}): Promise<ListJobsResponse>;
|
|
799
955
|
/**
|
|
800
956
|
* Admin-only API to get a usage report for an organization.
|
|
@@ -806,6 +962,9 @@ export declare class AdminApi {
|
|
|
806
962
|
headers: {
|
|
807
963
|
[name: string]: string;
|
|
808
964
|
};
|
|
965
|
+
responseHeadersCallback?: (headers: {
|
|
966
|
+
[name: string]: string;
|
|
967
|
+
}) => void;
|
|
809
968
|
}): Promise<AdminGetReportResponse>;
|
|
810
969
|
/**
|
|
811
970
|
* Admin-only API to get all usage reports for an organization.
|
|
@@ -818,6 +977,9 @@ export declare class AdminApi {
|
|
|
818
977
|
headers: {
|
|
819
978
|
[name: string]: string;
|
|
820
979
|
};
|
|
980
|
+
responseHeadersCallback?: (headers: {
|
|
981
|
+
[name: string]: string;
|
|
982
|
+
}) => void;
|
|
821
983
|
}): Promise<AdminGetReportsResponse>;
|
|
822
984
|
/**
|
|
823
985
|
* Admin-only API to get the list of all organizations.
|
|
@@ -834,6 +996,9 @@ export declare class AdminApi {
|
|
|
834
996
|
headers: {
|
|
835
997
|
[name: string]: string;
|
|
836
998
|
};
|
|
999
|
+
responseHeadersCallback?: (headers: {
|
|
1000
|
+
[name: string]: string;
|
|
1001
|
+
}) => void;
|
|
837
1002
|
}): Promise<AdminGetOrganizationsResponse>;
|
|
838
1003
|
/**
|
|
839
1004
|
* Admin-only API to get project information.
|
|
@@ -844,6 +1009,9 @@ export declare class AdminApi {
|
|
|
844
1009
|
headers: {
|
|
845
1010
|
[name: string]: string;
|
|
846
1011
|
};
|
|
1012
|
+
responseHeadersCallback?: (headers: {
|
|
1013
|
+
[name: string]: string;
|
|
1014
|
+
}) => void;
|
|
847
1015
|
}): Promise<AdminProjectInfoResponse>;
|
|
848
1016
|
/**
|
|
849
1017
|
* Admin-only API to get the list of all data samples for a project. The response is paginated and returns up to 1000 samples per request. To retrieve additional pages: 1. Use the `limit` parameter to specify how many samples to return (max 1000) 2. Use the `offset` parameter to skip a number of samples 3. Make subsequent requests with increasing offset values to retrieve all samples For example: - First request: limit=1000, offset=0 (samples 1-1000) - Second request: limit=1000, offset=1000 (samples 1001-2000) - And so on
|
|
@@ -856,6 +1024,9 @@ export declare class AdminApi {
|
|
|
856
1024
|
headers: {
|
|
857
1025
|
[name: string]: string;
|
|
858
1026
|
};
|
|
1027
|
+
responseHeadersCallback?: (headers: {
|
|
1028
|
+
[name: string]: string;
|
|
1029
|
+
}) => void;
|
|
859
1030
|
}): Promise<ListSamplesResponse>;
|
|
860
1031
|
/**
|
|
861
1032
|
* Admin-only API to get the list of all jobs for a project.
|
|
@@ -868,6 +1039,9 @@ export declare class AdminApi {
|
|
|
868
1039
|
headers: {
|
|
869
1040
|
[name: string]: string;
|
|
870
1041
|
};
|
|
1042
|
+
responseHeadersCallback?: (headers: {
|
|
1043
|
+
[name: string]: string;
|
|
1044
|
+
}) => void;
|
|
871
1045
|
}): Promise<ListJobsResponse>;
|
|
872
1046
|
/**
|
|
873
1047
|
* Admin-only API to get the list of all projects.
|
|
@@ -883,6 +1057,9 @@ export declare class AdminApi {
|
|
|
883
1057
|
headers: {
|
|
884
1058
|
[name: string]: string;
|
|
885
1059
|
};
|
|
1060
|
+
responseHeadersCallback?: (headers: {
|
|
1061
|
+
[name: string]: string;
|
|
1062
|
+
}) => void;
|
|
886
1063
|
}): Promise<AdminListProjectsResponse>;
|
|
887
1064
|
/**
|
|
888
1065
|
* Admin-only API to get the SSO settings.
|
|
@@ -892,6 +1069,9 @@ export declare class AdminApi {
|
|
|
892
1069
|
headers: {
|
|
893
1070
|
[name: string]: string;
|
|
894
1071
|
};
|
|
1072
|
+
responseHeadersCallback?: (headers: {
|
|
1073
|
+
[name: string]: string;
|
|
1074
|
+
}) => void;
|
|
895
1075
|
}): Promise<AdminGetSSOSettingsResponse>;
|
|
896
1076
|
/**
|
|
897
1077
|
* Admin-only API to get the signup approval request for a user.
|
|
@@ -902,6 +1082,9 @@ export declare class AdminApi {
|
|
|
902
1082
|
headers: {
|
|
903
1083
|
[name: string]: string;
|
|
904
1084
|
};
|
|
1085
|
+
responseHeadersCallback?: (headers: {
|
|
1086
|
+
[name: string]: string;
|
|
1087
|
+
}) => void;
|
|
905
1088
|
}): Promise<AdminGetSignupApprovalRequestResponse>;
|
|
906
1089
|
/**
|
|
907
1090
|
* Admin-only API to get all studio config.
|
|
@@ -911,6 +1094,9 @@ export declare class AdminApi {
|
|
|
911
1094
|
headers: {
|
|
912
1095
|
[name: string]: string;
|
|
913
1096
|
};
|
|
1097
|
+
responseHeadersCallback?: (headers: {
|
|
1098
|
+
[name: string]: string;
|
|
1099
|
+
}) => void;
|
|
914
1100
|
}): Promise<GetStudioConfigResponse>;
|
|
915
1101
|
/**
|
|
916
1102
|
* Admin-only API to get a studio config item.
|
|
@@ -921,6 +1107,9 @@ export declare class AdminApi {
|
|
|
921
1107
|
headers: {
|
|
922
1108
|
[name: string]: string;
|
|
923
1109
|
};
|
|
1110
|
+
responseHeadersCallback?: (headers: {
|
|
1111
|
+
[name: string]: string;
|
|
1112
|
+
}) => void;
|
|
924
1113
|
}): Promise<GetStudioConfigResponse>;
|
|
925
1114
|
/**
|
|
926
1115
|
* Retrieves a list of all organizations, projects and users that have been moved to the trash bin and are awaiting permanent deletion. The trash bin system works as follows: 1. When entities are deleted with `fullDelete=true`: - They are moved to the trash bin - A 30-day grace period begins - Data remains recoverable during this period 2. During the grace period: - Entities are hidden from normal operations - Administrators can monitor deletion progress - Data can be recovered if needed - Storage costs continue to accrue 3. After 30 days: - Entities are permanently deleted - All associated data is removed - The deletion becomes irreversible
|
|
@@ -935,6 +1124,9 @@ export declare class AdminApi {
|
|
|
935
1124
|
headers: {
|
|
936
1125
|
[name: string]: string;
|
|
937
1126
|
};
|
|
1127
|
+
responseHeadersCallback?: (headers: {
|
|
1128
|
+
[name: string]: string;
|
|
1129
|
+
}) => void;
|
|
938
1130
|
}): Promise<AdminGetTrashBinResponse>;
|
|
939
1131
|
/**
|
|
940
1132
|
* Admin-only API to retrieve a paginated list of trash bin related jobs. Jobs can be filtered by job key The response is paginated and can be controlled using: - limit: Maximum number of jobs to return - offset: Number of jobs to skip Results are ordered by creation date (newest first), or custom sort. Note: This endpoint requires admin:jobs:read permission.
|
|
@@ -950,6 +1142,9 @@ export declare class AdminApi {
|
|
|
950
1142
|
headers: {
|
|
951
1143
|
[name: string]: string;
|
|
952
1144
|
};
|
|
1145
|
+
responseHeadersCallback?: (headers: {
|
|
1146
|
+
[name: string]: string;
|
|
1147
|
+
}) => void;
|
|
953
1148
|
}): Promise<ListJobsResponse>;
|
|
954
1149
|
/**
|
|
955
1150
|
* Admin-only API to get a specific enterprise trial.
|
|
@@ -960,6 +1155,9 @@ export declare class AdminApi {
|
|
|
960
1155
|
headers: {
|
|
961
1156
|
[name: string]: string;
|
|
962
1157
|
};
|
|
1158
|
+
responseHeadersCallback?: (headers: {
|
|
1159
|
+
[name: string]: string;
|
|
1160
|
+
}) => void;
|
|
963
1161
|
}): Promise<AdminGetTrialResponse>;
|
|
964
1162
|
/**
|
|
965
1163
|
* Admin-only API to get information about a user.
|
|
@@ -970,6 +1168,9 @@ export declare class AdminApi {
|
|
|
970
1168
|
headers: {
|
|
971
1169
|
[name: string]: string;
|
|
972
1170
|
};
|
|
1171
|
+
responseHeadersCallback?: (headers: {
|
|
1172
|
+
[name: string]: string;
|
|
1173
|
+
}) => void;
|
|
973
1174
|
}): Promise<AdminGetUserResponse>;
|
|
974
1175
|
/**
|
|
975
1176
|
* Admin-only API to get the list of all project jobs for a user.
|
|
@@ -982,6 +1183,9 @@ export declare class AdminApi {
|
|
|
982
1183
|
headers: {
|
|
983
1184
|
[name: string]: string;
|
|
984
1185
|
};
|
|
1186
|
+
responseHeadersCallback?: (headers: {
|
|
1187
|
+
[name: string]: string;
|
|
1188
|
+
}) => void;
|
|
985
1189
|
}): Promise<ListJobsResponse>;
|
|
986
1190
|
/**
|
|
987
1191
|
* Admin-only API to get marketing metrics about a user.
|
|
@@ -992,6 +1196,9 @@ export declare class AdminApi {
|
|
|
992
1196
|
headers: {
|
|
993
1197
|
[name: string]: string;
|
|
994
1198
|
};
|
|
1199
|
+
responseHeadersCallback?: (headers: {
|
|
1200
|
+
[name: string]: string;
|
|
1201
|
+
}) => void;
|
|
995
1202
|
}): Promise<AdminGetUserMetricsResponse>;
|
|
996
1203
|
/**
|
|
997
1204
|
* Admin-only API to get the list of all registered users.
|
|
@@ -1009,6 +1216,9 @@ export declare class AdminApi {
|
|
|
1009
1216
|
headers: {
|
|
1010
1217
|
[name: string]: string;
|
|
1011
1218
|
};
|
|
1219
|
+
responseHeadersCallback?: (headers: {
|
|
1220
|
+
[name: string]: string;
|
|
1221
|
+
}) => void;
|
|
1012
1222
|
}): Promise<AdminGetUsersResponse>;
|
|
1013
1223
|
/**
|
|
1014
1224
|
* Admin-only API to list all data items from an organization. The response is paginated and returns up to 1000 samples per request. To retrieve additional pages: 1. Use the `limit` parameter to specify how many samples to return (max 1000) 2. Use the `offset` parameter to skip a number of samples 3. Make subsequent requests with increasing offset values to retrieve all samples For example: - First request: limit=1000, offset=0 (samples 1-1000) - Second request: limit=1000, offset=1000 (samples 1001-2000) - And so on
|
|
@@ -1022,6 +1232,9 @@ export declare class AdminApi {
|
|
|
1022
1232
|
headers: {
|
|
1023
1233
|
[name: string]: string;
|
|
1024
1234
|
};
|
|
1235
|
+
responseHeadersCallback?: (headers: {
|
|
1236
|
+
[name: string]: string;
|
|
1237
|
+
}) => void;
|
|
1025
1238
|
}): Promise<ListOrganizationDataResponse>;
|
|
1026
1239
|
/**
|
|
1027
1240
|
* List files in the trashbin FSx for a given organization.
|
|
@@ -1032,6 +1245,9 @@ export declare class AdminApi {
|
|
|
1032
1245
|
headers: {
|
|
1033
1246
|
[name: string]: string;
|
|
1034
1247
|
};
|
|
1248
|
+
responseHeadersCallback?: (headers: {
|
|
1249
|
+
[name: string]: string;
|
|
1250
|
+
}) => void;
|
|
1035
1251
|
}): Promise<ListPortalFilesInFolderResponse>;
|
|
1036
1252
|
/**
|
|
1037
1253
|
* Lists files in the trash bin S3 bucket for a given organization. Files are organized by their original source bucket. The `sourceBucket` parameter specifies which bucket to list files from: - ingestion: Lists files from the ingestion bucket - cdn: Lists files from the CDN bucket - user-data: Lists files from the user data bucket Optionally, use the `filePrefix` parameter to filter results to a specific path or filename pattern. The response is paginated and returns up to 1000 files per request. To retrieve additional pages: 1. Make the initial request without a continuation token 2. If more files exist, the response will include a `continuationToken` 3. Make subsequent requests with the provided token to retrieve the next page 4. Repeat until no continuation token is returned Note: Files remain in the trash bin for 30 days before permanent deletion.
|
|
@@ -1045,6 +1261,9 @@ export declare class AdminApi {
|
|
|
1045
1261
|
headers: {
|
|
1046
1262
|
[name: string]: string;
|
|
1047
1263
|
};
|
|
1264
|
+
responseHeadersCallback?: (headers: {
|
|
1265
|
+
[name: string]: string;
|
|
1266
|
+
}) => void;
|
|
1048
1267
|
}): Promise<ListPortalFilesInFolderResponse>;
|
|
1049
1268
|
/**
|
|
1050
1269
|
* List files in the trashbin FSx for a given project.
|
|
@@ -1055,6 +1274,9 @@ export declare class AdminApi {
|
|
|
1055
1274
|
headers: {
|
|
1056
1275
|
[name: string]: string;
|
|
1057
1276
|
};
|
|
1277
|
+
responseHeadersCallback?: (headers: {
|
|
1278
|
+
[name: string]: string;
|
|
1279
|
+
}) => void;
|
|
1058
1280
|
}): Promise<ListPortalFilesInFolderResponse>;
|
|
1059
1281
|
/**
|
|
1060
1282
|
* Lists files in the trash bin S3 bucket for a given project. Files are organized by their original source bucket. The `sourceBucket` parameter specifies which bucket to list files from: - ingestion: Lists files from the ingestion bucket - cdn: Lists files from the CDN bucket - user-data: Lists files from the user data bucket Optionally, use the `filePrefix` parameter to filter results to a specific path or filename pattern. The response is paginated and returns up to 1000 files per request. To retrieve additional pages: 1. Make the initial request without a continuation token 2. If more files exist, the response will include a `continuationToken` 3. Make subsequent requests with the provided token to retrieve the next page 4. Repeat until no continuation token is returned Note: Files remain in the trash bin for 30 days before permanent deletion.
|
|
@@ -1068,6 +1290,9 @@ export declare class AdminApi {
|
|
|
1068
1290
|
headers: {
|
|
1069
1291
|
[name: string]: string;
|
|
1070
1292
|
};
|
|
1293
|
+
responseHeadersCallback?: (headers: {
|
|
1294
|
+
[name: string]: string;
|
|
1295
|
+
}) => void;
|
|
1071
1296
|
}): Promise<ListPortalFilesInFolderResponse>;
|
|
1072
1297
|
/**
|
|
1073
1298
|
* List files in the trashbin FSx for a given user.
|
|
@@ -1078,6 +1303,9 @@ export declare class AdminApi {
|
|
|
1078
1303
|
headers: {
|
|
1079
1304
|
[name: string]: string;
|
|
1080
1305
|
};
|
|
1306
|
+
responseHeadersCallback?: (headers: {
|
|
1307
|
+
[name: string]: string;
|
|
1308
|
+
}) => void;
|
|
1081
1309
|
}): Promise<ListPortalFilesInFolderResponse>;
|
|
1082
1310
|
/**
|
|
1083
1311
|
* Lists files in the trash bin S3 bucket for a given user. Files are organized by their original source bucket. The `sourceBucket` parameter specifies which bucket to list files from: - ingestion: Lists files from the ingestion bucket - cdn: Lists files from the CDN bucket - user-data: Lists files from the user data bucket Optionally, use the `filePrefix` parameter to filter results to a specific path or filename pattern. The response is paginated and returns up to 1000 files per request. To retrieve additional pages: 1. Make the initial request without a continuation token 2. If more files exist, the response will include a `continuationToken` 3. Make subsequent requests with the provided token to retrieve the next page 4. Repeat until no continuation token is returned Note: Files remain in the trash bin for 30 days before permanent deletion.
|
|
@@ -1091,6 +1319,9 @@ export declare class AdminApi {
|
|
|
1091
1319
|
headers: {
|
|
1092
1320
|
[name: string]: string;
|
|
1093
1321
|
};
|
|
1322
|
+
responseHeadersCallback?: (headers: {
|
|
1323
|
+
[name: string]: string;
|
|
1324
|
+
}) => void;
|
|
1094
1325
|
}): Promise<ListPortalFilesInFolderResponse>;
|
|
1095
1326
|
/**
|
|
1096
1327
|
* Permanently delete an organization from the trash bin. This is the final step in the deletion process and cannot be undone. The trash bin process works as follows: 1. When an organization is initially deleted with `fullDelete=true`, its data is moved to the trash bin 2. The organization remains in the trash bin for 30 days 3. During this period: - Data can be recovered if needed - The deletion can be cancelled - All files remain in their original structure 4. Using this endpoint will: - Permanently delete all organization data - Remove all files from S3/FSx storage - This action is irreversible Note: Only use this endpoint after the 30-day grace period or when permanent deletion is absolutely necessary.
|
|
@@ -1101,6 +1332,9 @@ export declare class AdminApi {
|
|
|
1101
1332
|
headers: {
|
|
1102
1333
|
[name: string]: string;
|
|
1103
1334
|
};
|
|
1335
|
+
responseHeadersCallback?: (headers: {
|
|
1336
|
+
[name: string]: string;
|
|
1337
|
+
}) => void;
|
|
1104
1338
|
}): Promise<StartJobResponse>;
|
|
1105
1339
|
/**
|
|
1106
1340
|
* Permanently delete a project from the trash bin. This is the final step in the deletion process and cannot be undone. The trash bin process works as follows: 1. When a project is initially deleted with `fullDelete=true`, its data is moved to the trash bin 2. The project remains in the trash bin for 30 days 3. During this period: - Data can be recovered if needed - The deletion can be cancelled - All files remain in their original structure 4. Using this endpoint will: - Permanently delete all project data - Remove all files from S3/FSx storage - This action is irreversible Note: Only use this endpoint after the 30-day grace period or when permanent deletion is absolutely necessary.
|
|
@@ -1111,6 +1345,9 @@ export declare class AdminApi {
|
|
|
1111
1345
|
headers: {
|
|
1112
1346
|
[name: string]: string;
|
|
1113
1347
|
};
|
|
1348
|
+
responseHeadersCallback?: (headers: {
|
|
1349
|
+
[name: string]: string;
|
|
1350
|
+
}) => void;
|
|
1114
1351
|
}): Promise<StartJobResponse>;
|
|
1115
1352
|
/**
|
|
1116
1353
|
* Permanently delete a user from the trash bin. This is the final step in the deletion process and cannot be undone. The trash bin process works as follows: 1. When a user is initially deleted with `fullDelete=true`, their data is moved to the trash bin 2. The user remains in the trash bin for 30 days 3. During this period: - Data can be recovered if needed - The deletion can be cancelled - All files remain in their original structure 4. Using this endpoint will: - Permanently delete all user data - Remove all files from S3/FSx storage - This action is irreversible Note: Only use this endpoint after the 30-day grace period or when permanent deletion is absolutely necessary.
|
|
@@ -1121,6 +1358,9 @@ export declare class AdminApi {
|
|
|
1121
1358
|
headers: {
|
|
1122
1359
|
[name: string]: string;
|
|
1123
1360
|
};
|
|
1361
|
+
responseHeadersCallback?: (headers: {
|
|
1362
|
+
[name: string]: string;
|
|
1363
|
+
}) => void;
|
|
1124
1364
|
}): Promise<StartJobResponse>;
|
|
1125
1365
|
/**
|
|
1126
1366
|
* Admin-only API to cancel all active jobs for a project and revoke all project API keys, useful for projects with excessive usage or malicious activity.
|
|
@@ -1132,6 +1372,9 @@ export declare class AdminApi {
|
|
|
1132
1372
|
headers: {
|
|
1133
1373
|
[name: string]: string;
|
|
1134
1374
|
};
|
|
1375
|
+
responseHeadersCallback?: (headers: {
|
|
1376
|
+
[name: string]: string;
|
|
1377
|
+
}) => void;
|
|
1135
1378
|
}): Promise<AdminProjectKillSwitchResponse>;
|
|
1136
1379
|
/**
|
|
1137
1380
|
* Admin-only API to remove a user from an organization.
|
|
@@ -1143,6 +1386,9 @@ export declare class AdminApi {
|
|
|
1143
1386
|
headers: {
|
|
1144
1387
|
[name: string]: string;
|
|
1145
1388
|
};
|
|
1389
|
+
responseHeadersCallback?: (headers: {
|
|
1390
|
+
[name: string]: string;
|
|
1391
|
+
}) => void;
|
|
1146
1392
|
}): Promise<GenericApiResponse>;
|
|
1147
1393
|
/**
|
|
1148
1394
|
* Admin-only API to remove a user from a project.
|
|
@@ -1154,6 +1400,9 @@ export declare class AdminApi {
|
|
|
1154
1400
|
headers: {
|
|
1155
1401
|
[name: string]: string;
|
|
1156
1402
|
};
|
|
1403
|
+
responseHeadersCallback?: (headers: {
|
|
1404
|
+
[name: string]: string;
|
|
1405
|
+
}) => void;
|
|
1157
1406
|
}): Promise<GenericApiResponse>;
|
|
1158
1407
|
/**
|
|
1159
1408
|
* DEPRECATED. Admin-only API to remove the current user from a project.
|
|
@@ -1164,6 +1413,9 @@ export declare class AdminApi {
|
|
|
1164
1413
|
headers: {
|
|
1165
1414
|
[name: string]: string;
|
|
1166
1415
|
};
|
|
1416
|
+
responseHeadersCallback?: (headers: {
|
|
1417
|
+
[name: string]: string;
|
|
1418
|
+
}) => void;
|
|
1167
1419
|
}): Promise<GenericApiResponse>;
|
|
1168
1420
|
/**
|
|
1169
1421
|
* Admin-only API to restore a soft deleted organization. All organization projects sharing the same deletion date as that of the organization will also be restored. If this is a trial organization that was never upgraded to a paid plan then the organization will be restored to its original trial state.
|
|
@@ -1174,6 +1426,9 @@ export declare class AdminApi {
|
|
|
1174
1426
|
headers: {
|
|
1175
1427
|
[name: string]: string;
|
|
1176
1428
|
};
|
|
1429
|
+
responseHeadersCallback?: (headers: {
|
|
1430
|
+
[name: string]: string;
|
|
1431
|
+
}) => void;
|
|
1177
1432
|
}): Promise<GenericApiResponse>;
|
|
1178
1433
|
/**
|
|
1179
1434
|
* Admin-only API to restore a soft-deleted project. A soft-deleted project has been marked as deleted in the database but data has not been moved to the trash bin yet. To restore projects from the trash bin, use adminRestoreTrashbinProject.
|
|
@@ -1184,6 +1439,9 @@ export declare class AdminApi {
|
|
|
1184
1439
|
headers: {
|
|
1185
1440
|
[name: string]: string;
|
|
1186
1441
|
};
|
|
1442
|
+
responseHeadersCallback?: (headers: {
|
|
1443
|
+
[name: string]: string;
|
|
1444
|
+
}) => void;
|
|
1187
1445
|
}): Promise<GenericApiResponse>;
|
|
1188
1446
|
/**
|
|
1189
1447
|
* Starts a job to restore a project that has been moved to the trash bin. This: 1. Restores all S3 data 2. Restores all FSx data 3. Restores access to the project 4. Unschedules permanent deletion
|
|
@@ -1194,6 +1452,9 @@ export declare class AdminApi {
|
|
|
1194
1452
|
headers: {
|
|
1195
1453
|
[name: string]: string;
|
|
1196
1454
|
};
|
|
1455
|
+
responseHeadersCallback?: (headers: {
|
|
1456
|
+
[name: string]: string;
|
|
1457
|
+
}) => void;
|
|
1197
1458
|
}): Promise<StartJobResponse>;
|
|
1198
1459
|
/**
|
|
1199
1460
|
* Rotate the client secret for an existing OAuth client. This operation invalidates the previous secret and generates a new one, which must be used for future OAuth authentication flows. Requires admin:oauth:write permission.
|
|
@@ -1204,6 +1465,9 @@ export declare class AdminApi {
|
|
|
1204
1465
|
headers: {
|
|
1205
1466
|
[name: string]: string;
|
|
1206
1467
|
};
|
|
1468
|
+
responseHeadersCallback?: (headers: {
|
|
1469
|
+
[name: string]: string;
|
|
1470
|
+
}) => void;
|
|
1207
1471
|
}): Promise<AdminRotateOauthClientSecretResponse>;
|
|
1208
1472
|
/**
|
|
1209
1473
|
* Admin-only API to update a studio config item.
|
|
@@ -1215,6 +1479,9 @@ export declare class AdminApi {
|
|
|
1215
1479
|
headers: {
|
|
1216
1480
|
[name: string]: string;
|
|
1217
1481
|
};
|
|
1482
|
+
responseHeadersCallback?: (headers: {
|
|
1483
|
+
[name: string]: string;
|
|
1484
|
+
}) => void;
|
|
1218
1485
|
}): Promise<GenericApiResponse>;
|
|
1219
1486
|
/**
|
|
1220
1487
|
* Admin-only API to run or pause a data migration.
|
|
@@ -1226,6 +1493,9 @@ export declare class AdminApi {
|
|
|
1226
1493
|
headers: {
|
|
1227
1494
|
[name: string]: string;
|
|
1228
1495
|
};
|
|
1496
|
+
responseHeadersCallback?: (headers: {
|
|
1497
|
+
[name: string]: string;
|
|
1498
|
+
}) => void;
|
|
1229
1499
|
}): Promise<GenericApiResponse>;
|
|
1230
1500
|
/**
|
|
1231
1501
|
* Update an existing OAuth client\'s configuration. This endpoint allows updating the client\'s properties such as name, description, redirect URIs, allowed grant types, and scopes. The client ID and secret cannot be modified. Requires admin:oauth:write permission.
|
|
@@ -1237,6 +1507,9 @@ export declare class AdminApi {
|
|
|
1237
1507
|
headers: {
|
|
1238
1508
|
[name: string]: string;
|
|
1239
1509
|
};
|
|
1510
|
+
responseHeadersCallback?: (headers: {
|
|
1511
|
+
[name: string]: string;
|
|
1512
|
+
}) => void;
|
|
1240
1513
|
}): Promise<GenericApiResponse>;
|
|
1241
1514
|
/**
|
|
1242
1515
|
* Admin-only API to update organization properties such as name and logo.
|
|
@@ -1248,6 +1521,9 @@ export declare class AdminApi {
|
|
|
1248
1521
|
headers: {
|
|
1249
1522
|
[name: string]: string;
|
|
1250
1523
|
};
|
|
1524
|
+
responseHeadersCallback?: (headers: {
|
|
1525
|
+
[name: string]: string;
|
|
1526
|
+
}) => void;
|
|
1251
1527
|
}): Promise<GenericApiResponse>;
|
|
1252
1528
|
/**
|
|
1253
1529
|
* Admin-only API to update a data export for an organization.
|
|
@@ -1260,6 +1536,9 @@ export declare class AdminApi {
|
|
|
1260
1536
|
headers: {
|
|
1261
1537
|
[name: string]: string;
|
|
1262
1538
|
};
|
|
1539
|
+
responseHeadersCallback?: (headers: {
|
|
1540
|
+
[name: string]: string;
|
|
1541
|
+
}) => void;
|
|
1263
1542
|
}): Promise<GenericApiResponse>;
|
|
1264
1543
|
/**
|
|
1265
1544
|
* Admin-only API to update project properties.
|
|
@@ -1271,6 +1550,9 @@ export declare class AdminApi {
|
|
|
1271
1550
|
headers: {
|
|
1272
1551
|
[name: string]: string;
|
|
1273
1552
|
};
|
|
1553
|
+
responseHeadersCallback?: (headers: {
|
|
1554
|
+
[name: string]: string;
|
|
1555
|
+
}) => void;
|
|
1274
1556
|
}): Promise<GenericApiResponse>;
|
|
1275
1557
|
/**
|
|
1276
1558
|
* Admin-only API to update an enterprise trial.
|
|
@@ -1282,6 +1564,9 @@ export declare class AdminApi {
|
|
|
1282
1564
|
headers: {
|
|
1283
1565
|
[name: string]: string;
|
|
1284
1566
|
};
|
|
1567
|
+
responseHeadersCallback?: (headers: {
|
|
1568
|
+
[name: string]: string;
|
|
1569
|
+
}) => void;
|
|
1285
1570
|
}): Promise<GenericApiResponse>;
|
|
1286
1571
|
/**
|
|
1287
1572
|
* Admin-only API to update user properties.
|
|
@@ -1293,6 +1578,9 @@ export declare class AdminApi {
|
|
|
1293
1578
|
headers: {
|
|
1294
1579
|
[name: string]: string;
|
|
1295
1580
|
};
|
|
1581
|
+
responseHeadersCallback?: (headers: {
|
|
1582
|
+
[name: string]: string;
|
|
1583
|
+
}) => void;
|
|
1296
1584
|
}): Promise<GenericApiResponse>;
|
|
1297
1585
|
/**
|
|
1298
1586
|
* Admin-only API to update the list of permissions for a user.
|
|
@@ -1304,6 +1592,9 @@ export declare class AdminApi {
|
|
|
1304
1592
|
headers: {
|
|
1305
1593
|
[name: string]: string;
|
|
1306
1594
|
};
|
|
1595
|
+
responseHeadersCallback?: (headers: {
|
|
1596
|
+
[name: string]: string;
|
|
1597
|
+
}) => void;
|
|
1307
1598
|
}): Promise<GenericApiResponse>;
|
|
1308
1599
|
/**
|
|
1309
1600
|
* Admin-only API to upgrade a specific enterprise trial to a full enterprise account.
|
|
@@ -1314,6 +1605,9 @@ export declare class AdminApi {
|
|
|
1314
1605
|
headers: {
|
|
1315
1606
|
[name: string]: string;
|
|
1316
1607
|
};
|
|
1608
|
+
responseHeadersCallback?: (headers: {
|
|
1609
|
+
[name: string]: string;
|
|
1610
|
+
}) => void;
|
|
1317
1611
|
}): Promise<GenericApiResponse>;
|
|
1318
1612
|
/**
|
|
1319
1613
|
* Upload a logo for an existing OAuth client. This endpoint allows updating the client\'s logo.
|
|
@@ -1325,6 +1619,9 @@ export declare class AdminApi {
|
|
|
1325
1619
|
headers: {
|
|
1326
1620
|
[name: string]: string;
|
|
1327
1621
|
};
|
|
1622
|
+
responseHeadersCallback?: (headers: {
|
|
1623
|
+
[name: string]: string;
|
|
1624
|
+
}) => void;
|
|
1328
1625
|
}): Promise<GenericApiResponse>;
|
|
1329
1626
|
}
|
|
1330
1627
|
export {};
|