@nvisy/sdk 0.9.0 → 0.11.0

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.
@@ -292,6 +292,236 @@ interface paths {
292
292
  patch?: never;
293
293
  trace?: never;
294
294
  };
295
+ "/accounts/{username}/avatar/": {
296
+ parameters: {
297
+ query?: never;
298
+ header?: never;
299
+ path?: never;
300
+ cookie?: never;
301
+ };
302
+ /**
303
+ * Get account avatar
304
+ * @description Returns the account's avatar image (WebP). 404 when unset.
305
+ */
306
+ get: {
307
+ parameters: {
308
+ query?: never;
309
+ header?: never;
310
+ path: {
311
+ /** @description Public handle of the account. */
312
+ username: components["schemas"]["Handle"];
313
+ };
314
+ cookie?: never;
315
+ };
316
+ requestBody?: never;
317
+ responses: {
318
+ /** @description no content */
319
+ 200: {
320
+ headers: {
321
+ [name: string]: unknown;
322
+ };
323
+ content?: never;
324
+ };
325
+ /**
326
+ * @description HTTP error response representation with security-conscious design.
327
+ *
328
+ * This struct contains all the information needed to serialize an error
329
+ * response, including the error name, message, HTTP status code, resource
330
+ * information, and user-friendly messages.
331
+ */
332
+ 401: {
333
+ headers: {
334
+ [name: string]: unknown;
335
+ };
336
+ content: {
337
+ "application/json": components["schemas"]["ErrorResponse"];
338
+ };
339
+ };
340
+ /**
341
+ * @description HTTP error response representation with security-conscious design.
342
+ *
343
+ * This struct contains all the information needed to serialize an error
344
+ * response, including the error name, message, HTTP status code, resource
345
+ * information, and user-friendly messages.
346
+ */
347
+ 404: {
348
+ headers: {
349
+ [name: string]: unknown;
350
+ };
351
+ content: {
352
+ "application/json": components["schemas"]["ErrorResponse"];
353
+ };
354
+ };
355
+ };
356
+ };
357
+ /**
358
+ * Upload account avatar
359
+ * @description Uploads and normalizes the account's avatar. Only the account itself may set it.
360
+ */
361
+ put: {
362
+ parameters: {
363
+ query?: never;
364
+ header?: never;
365
+ path: {
366
+ /** @description Public handle of the account. */
367
+ username: components["schemas"]["Handle"];
368
+ };
369
+ cookie?: never;
370
+ };
371
+ /** @description multipart form data */
372
+ requestBody: {
373
+ content: {
374
+ "multipart/form-data": unknown[];
375
+ };
376
+ };
377
+ responses: {
378
+ /** @description Represents an account. */
379
+ 200: {
380
+ headers: {
381
+ [name: string]: unknown;
382
+ };
383
+ content: {
384
+ "application/json": components["schemas"]["Account"];
385
+ };
386
+ };
387
+ /**
388
+ * @description HTTP error response representation with security-conscious design.
389
+ *
390
+ * This struct contains all the information needed to serialize an error
391
+ * response, including the error name, message, HTTP status code, resource
392
+ * information, and user-friendly messages.
393
+ */
394
+ 400: {
395
+ headers: {
396
+ [name: string]: unknown;
397
+ };
398
+ content: {
399
+ "application/json": components["schemas"]["ErrorResponse"];
400
+ };
401
+ };
402
+ /**
403
+ * @description HTTP error response representation with security-conscious design.
404
+ *
405
+ * This struct contains all the information needed to serialize an error
406
+ * response, including the error name, message, HTTP status code, resource
407
+ * information, and user-friendly messages.
408
+ */
409
+ 401: {
410
+ headers: {
411
+ [name: string]: unknown;
412
+ };
413
+ content: {
414
+ "application/json": components["schemas"]["ErrorResponse"];
415
+ };
416
+ };
417
+ /**
418
+ * @description HTTP error response representation with security-conscious design.
419
+ *
420
+ * This struct contains all the information needed to serialize an error
421
+ * response, including the error name, message, HTTP status code, resource
422
+ * information, and user-friendly messages.
423
+ */
424
+ 403: {
425
+ headers: {
426
+ [name: string]: unknown;
427
+ };
428
+ content: {
429
+ "application/json": components["schemas"]["ErrorResponse"];
430
+ };
431
+ };
432
+ /**
433
+ * @description HTTP error response representation with security-conscious design.
434
+ *
435
+ * This struct contains all the information needed to serialize an error
436
+ * response, including the error name, message, HTTP status code, resource
437
+ * information, and user-friendly messages.
438
+ */
439
+ 404: {
440
+ headers: {
441
+ [name: string]: unknown;
442
+ };
443
+ content: {
444
+ "application/json": components["schemas"]["ErrorResponse"];
445
+ };
446
+ };
447
+ };
448
+ };
449
+ post?: never;
450
+ /**
451
+ * Delete account avatar
452
+ * @description Removes the account's avatar. Only the account itself may delete it.
453
+ */
454
+ delete: {
455
+ parameters: {
456
+ query?: never;
457
+ header?: never;
458
+ path: {
459
+ /** @description Public handle of the account. */
460
+ username: components["schemas"]["Handle"];
461
+ };
462
+ cookie?: never;
463
+ };
464
+ requestBody?: never;
465
+ responses: {
466
+ /** @description no content */
467
+ 204: {
468
+ headers: {
469
+ [name: string]: unknown;
470
+ };
471
+ content?: never;
472
+ };
473
+ /**
474
+ * @description HTTP error response representation with security-conscious design.
475
+ *
476
+ * This struct contains all the information needed to serialize an error
477
+ * response, including the error name, message, HTTP status code, resource
478
+ * information, and user-friendly messages.
479
+ */
480
+ 401: {
481
+ headers: {
482
+ [name: string]: unknown;
483
+ };
484
+ content: {
485
+ "application/json": components["schemas"]["ErrorResponse"];
486
+ };
487
+ };
488
+ /**
489
+ * @description HTTP error response representation with security-conscious design.
490
+ *
491
+ * This struct contains all the information needed to serialize an error
492
+ * response, including the error name, message, HTTP status code, resource
493
+ * information, and user-friendly messages.
494
+ */
495
+ 403: {
496
+ headers: {
497
+ [name: string]: unknown;
498
+ };
499
+ content: {
500
+ "application/json": components["schemas"]["ErrorResponse"];
501
+ };
502
+ };
503
+ /**
504
+ * @description HTTP error response representation with security-conscious design.
505
+ *
506
+ * This struct contains all the information needed to serialize an error
507
+ * response, including the error name, message, HTTP status code, resource
508
+ * information, and user-friendly messages.
509
+ */
510
+ 404: {
511
+ headers: {
512
+ [name: string]: unknown;
513
+ };
514
+ content: {
515
+ "application/json": components["schemas"]["ErrorResponse"];
516
+ };
517
+ };
518
+ };
519
+ };
520
+ options?: never;
521
+ head?: never;
522
+ patch?: never;
523
+ trace?: never;
524
+ };
295
525
  "/api-tokens/": {
296
526
  parameters: {
297
527
  query?: never;
@@ -1090,6 +1320,249 @@ interface paths {
1090
1320
  };
1091
1321
  trace?: never;
1092
1322
  };
1323
+ "/workspaces/{workspaceSlug}/avatar/": {
1324
+ parameters: {
1325
+ query?: never;
1326
+ header?: never;
1327
+ path?: never;
1328
+ cookie?: never;
1329
+ };
1330
+ /**
1331
+ * Get workspace avatar
1332
+ * @description Returns the workspace's avatar image (WebP). 404 when unset.
1333
+ */
1334
+ get: {
1335
+ parameters: {
1336
+ query?: never;
1337
+ header?: never;
1338
+ path: {
1339
+ /** @description URL-safe workspace identifier. */
1340
+ workspaceSlug: string;
1341
+ };
1342
+ cookie?: never;
1343
+ };
1344
+ requestBody?: never;
1345
+ responses: {
1346
+ /** @description no content */
1347
+ 200: {
1348
+ headers: {
1349
+ [name: string]: unknown;
1350
+ };
1351
+ content?: never;
1352
+ };
1353
+ /**
1354
+ * @description HTTP error response representation with security-conscious design.
1355
+ *
1356
+ * This struct contains all the information needed to serialize an error
1357
+ * response, including the error name, message, HTTP status code, resource
1358
+ * information, and user-friendly messages.
1359
+ */
1360
+ 401: {
1361
+ headers: {
1362
+ [name: string]: unknown;
1363
+ };
1364
+ content: {
1365
+ "application/json": components["schemas"]["ErrorResponse"];
1366
+ };
1367
+ };
1368
+ /**
1369
+ * @description HTTP error response representation with security-conscious design.
1370
+ *
1371
+ * This struct contains all the information needed to serialize an error
1372
+ * response, including the error name, message, HTTP status code, resource
1373
+ * information, and user-friendly messages.
1374
+ */
1375
+ 403: {
1376
+ headers: {
1377
+ [name: string]: unknown;
1378
+ };
1379
+ content: {
1380
+ "application/json": components["schemas"]["ErrorResponse"];
1381
+ };
1382
+ };
1383
+ /**
1384
+ * @description HTTP error response representation with security-conscious design.
1385
+ *
1386
+ * This struct contains all the information needed to serialize an error
1387
+ * response, including the error name, message, HTTP status code, resource
1388
+ * information, and user-friendly messages.
1389
+ */
1390
+ 404: {
1391
+ headers: {
1392
+ [name: string]: unknown;
1393
+ };
1394
+ content: {
1395
+ "application/json": components["schemas"]["ErrorResponse"];
1396
+ };
1397
+ };
1398
+ };
1399
+ };
1400
+ /**
1401
+ * Upload workspace avatar
1402
+ * @description Uploads and normalizes the workspace's avatar. Requires UpdateWorkspace.
1403
+ */
1404
+ put: {
1405
+ parameters: {
1406
+ query?: never;
1407
+ header?: never;
1408
+ path: {
1409
+ /** @description URL-safe workspace identifier. */
1410
+ workspaceSlug: string;
1411
+ };
1412
+ cookie?: never;
1413
+ };
1414
+ /** @description multipart form data */
1415
+ requestBody: {
1416
+ content: {
1417
+ "multipart/form-data": unknown[];
1418
+ };
1419
+ };
1420
+ responses: {
1421
+ /** @description no content */
1422
+ 200: {
1423
+ headers: {
1424
+ [name: string]: unknown;
1425
+ };
1426
+ content?: never;
1427
+ };
1428
+ /**
1429
+ * @description HTTP error response representation with security-conscious design.
1430
+ *
1431
+ * This struct contains all the information needed to serialize an error
1432
+ * response, including the error name, message, HTTP status code, resource
1433
+ * information, and user-friendly messages.
1434
+ */
1435
+ 400: {
1436
+ headers: {
1437
+ [name: string]: unknown;
1438
+ };
1439
+ content: {
1440
+ "application/json": components["schemas"]["ErrorResponse"];
1441
+ };
1442
+ };
1443
+ /**
1444
+ * @description HTTP error response representation with security-conscious design.
1445
+ *
1446
+ * This struct contains all the information needed to serialize an error
1447
+ * response, including the error name, message, HTTP status code, resource
1448
+ * information, and user-friendly messages.
1449
+ */
1450
+ 401: {
1451
+ headers: {
1452
+ [name: string]: unknown;
1453
+ };
1454
+ content: {
1455
+ "application/json": components["schemas"]["ErrorResponse"];
1456
+ };
1457
+ };
1458
+ /**
1459
+ * @description HTTP error response representation with security-conscious design.
1460
+ *
1461
+ * This struct contains all the information needed to serialize an error
1462
+ * response, including the error name, message, HTTP status code, resource
1463
+ * information, and user-friendly messages.
1464
+ */
1465
+ 403: {
1466
+ headers: {
1467
+ [name: string]: unknown;
1468
+ };
1469
+ content: {
1470
+ "application/json": components["schemas"]["ErrorResponse"];
1471
+ };
1472
+ };
1473
+ /**
1474
+ * @description HTTP error response representation with security-conscious design.
1475
+ *
1476
+ * This struct contains all the information needed to serialize an error
1477
+ * response, including the error name, message, HTTP status code, resource
1478
+ * information, and user-friendly messages.
1479
+ */
1480
+ 404: {
1481
+ headers: {
1482
+ [name: string]: unknown;
1483
+ };
1484
+ content: {
1485
+ "application/json": components["schemas"]["ErrorResponse"];
1486
+ };
1487
+ };
1488
+ };
1489
+ };
1490
+ post?: never;
1491
+ /**
1492
+ * Delete workspace avatar
1493
+ * @description Removes the workspace's avatar. Requires UpdateWorkspace.
1494
+ */
1495
+ delete: {
1496
+ parameters: {
1497
+ query?: never;
1498
+ header?: never;
1499
+ path: {
1500
+ /** @description URL-safe workspace identifier. */
1501
+ workspaceSlug: string;
1502
+ };
1503
+ cookie?: never;
1504
+ };
1505
+ requestBody?: never;
1506
+ responses: {
1507
+ /** @description no content */
1508
+ 204: {
1509
+ headers: {
1510
+ [name: string]: unknown;
1511
+ };
1512
+ content?: never;
1513
+ };
1514
+ /**
1515
+ * @description HTTP error response representation with security-conscious design.
1516
+ *
1517
+ * This struct contains all the information needed to serialize an error
1518
+ * response, including the error name, message, HTTP status code, resource
1519
+ * information, and user-friendly messages.
1520
+ */
1521
+ 401: {
1522
+ headers: {
1523
+ [name: string]: unknown;
1524
+ };
1525
+ content: {
1526
+ "application/json": components["schemas"]["ErrorResponse"];
1527
+ };
1528
+ };
1529
+ /**
1530
+ * @description HTTP error response representation with security-conscious design.
1531
+ *
1532
+ * This struct contains all the information needed to serialize an error
1533
+ * response, including the error name, message, HTTP status code, resource
1534
+ * information, and user-friendly messages.
1535
+ */
1536
+ 403: {
1537
+ headers: {
1538
+ [name: string]: unknown;
1539
+ };
1540
+ content: {
1541
+ "application/json": components["schemas"]["ErrorResponse"];
1542
+ };
1543
+ };
1544
+ /**
1545
+ * @description HTTP error response representation with security-conscious design.
1546
+ *
1547
+ * This struct contains all the information needed to serialize an error
1548
+ * response, including the error name, message, HTTP status code, resource
1549
+ * information, and user-friendly messages.
1550
+ */
1551
+ 404: {
1552
+ headers: {
1553
+ [name: string]: unknown;
1554
+ };
1555
+ content: {
1556
+ "application/json": components["schemas"]["ErrorResponse"];
1557
+ };
1558
+ };
1559
+ };
1560
+ };
1561
+ options?: never;
1562
+ head?: never;
1563
+ patch?: never;
1564
+ trace?: never;
1565
+ };
1093
1566
  "/workspaces/{workspaceSlug}/notifications/": {
1094
1567
  parameters: {
1095
1568
  query?: never;
@@ -1363,8 +1836,11 @@ interface paths {
1363
1836
  after?: string;
1364
1837
  /** @description The maximum number of records to return (1-100, default: 20). */
1365
1838
  limit?: number;
1366
- /** @description Filter by provider type. */
1367
- provider?: string;
1839
+ /**
1840
+ * @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
1841
+ * matches if it uses any of the given providers. Empty means no filter.
1842
+ */
1843
+ provider?: string[];
1368
1844
  };
1369
1845
  header?: never;
1370
1846
  path: {
@@ -1899,6 +2375,115 @@ interface paths {
1899
2375
  patch?: never;
1900
2376
  trace?: never;
1901
2377
  };
2378
+ "/workspaces/{workspaceSlug}/syncs/": {
2379
+ parameters: {
2380
+ query?: never;
2381
+ header?: never;
2382
+ path?: never;
2383
+ cookie?: never;
2384
+ };
2385
+ /**
2386
+ * List workspace syncs
2387
+ * @description Returns all sync runs across the workspace's connections, most recent first, with optional status and provider filters.
2388
+ */
2389
+ get: {
2390
+ parameters: {
2391
+ query?: {
2392
+ /**
2393
+ * @description Cursor pointing to the last item of the previous page.
2394
+ * Obtain this from the `nextCursor` field in the response.
2395
+ */
2396
+ after?: string;
2397
+ /** @description The maximum number of records to return (1-100, default: 20). */
2398
+ limit?: number;
2399
+ /**
2400
+ * @description Filter by connection provider (`s3`, `azure`, `gcs`). Repeatable; a sync
2401
+ * matches if its connection uses any of the given providers. Empty means no
2402
+ * provider filter.
2403
+ */
2404
+ provider?: string[];
2405
+ /** @description Filter by sync status. */
2406
+ status?: components["schemas"]["SyncStatus"];
2407
+ };
2408
+ header?: never;
2409
+ path: {
2410
+ /** @description URL-safe workspace identifier. */
2411
+ workspaceSlug: string;
2412
+ };
2413
+ cookie?: never;
2414
+ };
2415
+ requestBody?: never;
2416
+ responses: {
2417
+ /**
2418
+ * @description Generic paginated response wrapper.
2419
+ *
2420
+ * Provides a consistent structure for all paginated API responses with
2421
+ * cursor-based pagination support. When `next_cursor` is present, there
2422
+ * are more items to fetch.
2423
+ */
2424
+ 200: {
2425
+ headers: {
2426
+ [name: string]: unknown;
2427
+ };
2428
+ content: {
2429
+ "application/json": components["schemas"]["ConnectionSyncPage"];
2430
+ };
2431
+ };
2432
+ /**
2433
+ * @description HTTP error response representation with security-conscious design.
2434
+ *
2435
+ * This struct contains all the information needed to serialize an error
2436
+ * response, including the error name, message, HTTP status code, resource
2437
+ * information, and user-friendly messages.
2438
+ */
2439
+ 401: {
2440
+ headers: {
2441
+ [name: string]: unknown;
2442
+ };
2443
+ content: {
2444
+ "application/json": components["schemas"]["ErrorResponse"];
2445
+ };
2446
+ };
2447
+ /**
2448
+ * @description HTTP error response representation with security-conscious design.
2449
+ *
2450
+ * This struct contains all the information needed to serialize an error
2451
+ * response, including the error name, message, HTTP status code, resource
2452
+ * information, and user-friendly messages.
2453
+ */
2454
+ 403: {
2455
+ headers: {
2456
+ [name: string]: unknown;
2457
+ };
2458
+ content: {
2459
+ "application/json": components["schemas"]["ErrorResponse"];
2460
+ };
2461
+ };
2462
+ /**
2463
+ * @description HTTP error response representation with security-conscious design.
2464
+ *
2465
+ * This struct contains all the information needed to serialize an error
2466
+ * response, including the error name, message, HTTP status code, resource
2467
+ * information, and user-friendly messages.
2468
+ */
2469
+ 404: {
2470
+ headers: {
2471
+ [name: string]: unknown;
2472
+ };
2473
+ content: {
2474
+ "application/json": components["schemas"]["ErrorResponse"];
2475
+ };
2476
+ };
2477
+ };
2478
+ };
2479
+ put?: never;
2480
+ post?: never;
2481
+ delete?: never;
2482
+ options?: never;
2483
+ head?: never;
2484
+ patch?: never;
2485
+ trace?: never;
2486
+ };
1902
2487
  "/workspaces/{workspaceSlug}/connections/{connectionId}/sync/": {
1903
2488
  parameters: {
1904
2489
  query?: never;
@@ -5798,7 +6383,7 @@ interface paths {
5798
6383
  [name: string]: unknown;
5799
6384
  };
5800
6385
  content: {
5801
- "application/json": components["schemas"]["PolicyPage"];
6386
+ "application/json": components["schemas"]["PolicySummaryPage"];
5802
6387
  };
5803
6388
  };
5804
6389
  /**
@@ -5852,8 +6437,8 @@ interface paths {
5852
6437
  * @description Request payload for creating a new workspace policy.
5853
6438
  *
5854
6439
  * The `definition` is a structured policy the redaction engine consumes;
5855
- * its `name`, `description`, and `version` drive the stored columns unless
5856
- * overridden here.
6440
+ * its `name` and `description` drive the stored columns unless overridden
6441
+ * here.
5857
6442
  */
5858
6443
  requestBody: {
5859
6444
  content: {
@@ -5867,7 +6452,7 @@ interface paths {
5867
6452
  [name: string]: unknown;
5868
6453
  };
5869
6454
  content: {
5870
- "application/json": components["schemas"]["Policy2"];
6455
+ "application/json": components["schemas"]["Policy"];
5871
6456
  };
5872
6457
  };
5873
6458
  /**
@@ -5972,7 +6557,7 @@ interface paths {
5972
6557
  [name: string]: unknown;
5973
6558
  };
5974
6559
  content: {
5975
- "application/json": components["schemas"]["Policy2"];
6560
+ "application/json": components["schemas"]["Policy"];
5976
6561
  };
5977
6562
  };
5978
6563
  /**
@@ -6131,7 +6716,7 @@ interface paths {
6131
6716
  [name: string]: unknown;
6132
6717
  };
6133
6718
  content: {
6134
- "application/json": components["schemas"]["Policy2"];
6719
+ "application/json": components["schemas"]["Policy"];
6135
6720
  };
6136
6721
  };
6137
6722
  /**
@@ -6630,6 +7215,8 @@ interface components {
6630
7215
  schemas: {
6631
7216
  /** @description Represents an account. */
6632
7217
  Account: {
7218
+ /** @description Serve path of the account's avatar, when set. */
7219
+ avatarUrl?: string;
6633
7220
  /**
6634
7221
  * Format: date-time
6635
7222
  * @description Timestamp when the account was created.
@@ -7013,7 +7600,7 @@ interface components {
7013
7600
  * `None` means "use the policy's decision"; `Some(action)`
7014
7601
  * overrides it for this specific entity at apply time.
7015
7602
  */
7016
- reviewerOverride?: components["schemas"]["PolicyAction"];
7603
+ reviewerOverride?: components["schemas"]["ModalityRedactions"];
7017
7604
  };
7018
7605
  /**
7019
7606
  * @description One thing that happened to an entity, with its effect on confidence.
@@ -7251,15 +7838,6 @@ interface components {
7251
7838
  */
7252
7839
  waveform: components["schemas"]["Waveform"];
7253
7840
  };
7254
- /** @description Payload for the `audit` action. */
7255
- AuditAction: {
7256
- /**
7257
- * @description Severity hint propagated into the audit entry (e.g.
7258
- * `"low"`, `"medium"`, `"high"`). Free-form for now; downstream
7259
- * review tooling decides how to render or filter.
7260
- */
7261
- severity?: string;
7262
- };
7263
7841
  /** @description Response returned after successful authentication (login/signup). */
7264
7842
  AuthToken: {
7265
7843
  /** @description The JWT API token for authentication. */
@@ -7402,6 +7980,8 @@ interface components {
7402
7980
  displayName: string;
7403
7981
  /** @description Opaque identifier of the connection. */
7404
7982
  id: components["schemas"]["ConnectionId"];
7983
+ /** @description Whether the connection is enabled for syncing. */
7984
+ isActive: boolean;
7405
7985
  /**
7406
7986
  * Format: date-time
7407
7987
  * @description When the connection last synced successfully, if ever.
@@ -7560,8 +8140,12 @@ interface components {
7560
8140
  };
7561
8141
  /** @description Query parameters for listing connections. */
7562
8142
  ConnectionsQuery: {
7563
- /** @description Filter by provider type. */
7564
- provider?: string;
8143
+ /**
8144
+ * @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
8145
+ * matches if it uses any of the given providers. Empty means no filter.
8146
+ * @default []
8147
+ */
8148
+ provider: string[];
7565
8149
  };
7566
8150
  /**
7567
8151
  * @description [ISO 3166-1] country, identified by its code.
@@ -7601,6 +8185,11 @@ interface components {
7601
8185
  deletionPolicy: components["schemas"]["SyncDeletionPolicy"];
7602
8186
  /** @description Human-readable connection display name. */
7603
8187
  displayName: string;
8188
+ /**
8189
+ * @description Whether the connection is enabled for syncing. Omit to default to active;
8190
+ * set `false` to create it disabled.
8191
+ */
8192
+ isActive?: boolean;
7604
8193
  /** @description Cron expression for scheduled imports; omit for manual-only. */
7605
8194
  scheduleCron?: string;
7606
8195
  /**
@@ -7664,12 +8253,12 @@ interface components {
7664
8253
  * @description Request payload for creating a new workspace policy.
7665
8254
  *
7666
8255
  * The `definition` is a structured policy the redaction engine consumes;
7667
- * its `name`, `description`, and `version` drive the stored columns unless
7668
- * overridden here.
8256
+ * its `name` and `description` drive the stored columns unless overridden
8257
+ * here.
7669
8258
  */
7670
8259
  CreatePolicy: {
7671
8260
  /** @description The structured policy body consumed by the engine. */
7672
- definition: components["schemas"]["Policy"];
8261
+ definition: components["schemas"]["PolicyDefinition"];
7673
8262
  /** @description Optional description override. Defaults to the policy's own description. */
7674
8263
  description?: string;
7675
8264
  /** @description Optional display name override. Defaults to the policy's own name. */
@@ -8209,7 +8798,7 @@ interface components {
8209
8798
  * `None` means "use the policy's decision"; `Some(action)`
8210
8799
  * overrides it for this specific entity at apply time.
8211
8800
  */
8212
- reviewerOverride?: components["schemas"]["PolicyAction"];
8801
+ reviewerOverride?: components["schemas"]["ModalityRedactions"];
8213
8802
  };
8214
8803
  /**
8215
8804
  * @description One thing that happened to an entity, with its effect on confidence.
@@ -9275,20 +9864,37 @@ interface components {
9275
9864
  */
9276
9865
  y: number;
9277
9866
  };
9278
- /**
9279
- * @description A named, versioned governance policy.
9280
- *
9281
- * Identity is the UUID; `name` is display-only. `version` is the
9282
- * policy body's semver: two submissions of the same
9283
- * `(id, version)` pair should produce identical decisions.
9284
- */
9867
+ /** @description Response type for a workspace policy. */
9285
9868
  Policy: {
9286
9869
  /**
9287
- * @description Document-level gate. The whole policy (rules + fallback)
9288
- * is skipped when this is `Some(...)` and the predicate is
9289
- * false for the document. Evaluated once per document.
9870
+ * Format: date-time
9871
+ * @description When the policy was created.
9872
+ */
9873
+ createdAt: string;
9874
+ /** @description Handle of the account that created this policy. */
9875
+ creatorUsername: components["schemas"]["Handle"];
9876
+ /** @description The structured policy body consumed by the engine. */
9877
+ definition: components["schemas"]["PolicyDefinition"];
9878
+ /** @description Policy description. */
9879
+ description?: string;
9880
+ /** @description Human-readable policy display name. */
9881
+ displayName: string;
9882
+ /** @description URL slug of the policy, unique within its workspace. */
9883
+ slug: components["schemas"]["Handle"];
9884
+ /**
9885
+ * Format: date-time
9886
+ * @description When the policy was last updated.
9290
9887
  */
9291
- appliesWhen?: components["schemas"]["DocumentPredicate"];
9888
+ updatedAt: string;
9889
+ /** @description Handle of the workspace this policy belongs to. */
9890
+ workspaceSlug: components["schemas"]["Handle"];
9891
+ };
9892
+ /**
9893
+ * @description A named governance policy.
9894
+ *
9895
+ * Identity is the UUID; `name` is display-only.
9896
+ */
9897
+ PolicyDefinition: {
9292
9898
  /** @description Optional description for reviewers. */
9293
9899
  description?: string;
9294
9900
  /**
@@ -9297,7 +9903,7 @@ interface components {
9297
9903
  * to the next policy. [`Option`] enforces "at most one
9298
9904
  * fallback per policy" at the type level.
9299
9905
  */
9300
- fallback?: components["schemas"]["PolicyAction"];
9906
+ fallback?: components["schemas"]["ModalityRedactions"];
9301
9907
  /**
9302
9908
  * Format: uuid
9303
9909
  * @description Stable identifier. UUIDv7 recommended (time-ordered);
@@ -9325,76 +9931,12 @@ interface components {
9325
9931
  retention?: components["schemas"]["RetentionPolicy"][];
9326
9932
  /** @description Ordered rules. First match wins within this policy. */
9327
9933
  rules?: components["schemas"]["PolicyRule"][];
9328
- /** @description Semver of the policy body. */
9329
- version: string;
9330
- };
9331
- /** @description Response type for a workspace policy. */
9332
- Policy2: {
9333
- /**
9334
- * Format: date-time
9335
- * @description When the policy was created.
9336
- */
9337
- createdAt: string;
9338
- /** @description Handle of the account that created this policy. */
9339
- creatorUsername: components["schemas"]["Handle"];
9340
- /** @description The structured policy body consumed by the engine. */
9341
- definition: components["schemas"]["Policy"];
9342
- /** @description Policy description. */
9343
- description?: string;
9344
- /** @description Human-readable policy display name. */
9345
- displayName: string;
9346
- /** @description URL slug of the policy, unique within its workspace. */
9347
- slug: components["schemas"]["Handle"];
9348
- /**
9349
- * Format: date-time
9350
- * @description When the policy was last updated.
9351
- */
9352
- updatedAt: string;
9353
- /** @description Semver of the policy body. */
9354
- version: string;
9355
- /** @description Handle of the workspace this policy belongs to. */
9356
- workspaceSlug: components["schemas"]["Handle"];
9357
- };
9358
- /**
9359
- * @description What a rule does when its [`predicate`] matches.
9360
- *
9361
- * Three verbs: [`Redact`] transforms the entity with one operator
9362
- * per modality; [`Suppress`] drops the entity entirely (false-positive
9363
- * marker) and stamps a reason onto the audit; [`Audit`] flags it for
9364
- * human review without transforming.
9365
- *
9366
- * [`predicate`]: PolicyRule::predicate
9367
- * [`Redact`]: PolicyAction::Redact
9368
- * [`Suppress`]: PolicyAction::Suppress
9369
- * [`Audit`]: PolicyAction::Audit
9370
- */
9371
- PolicyAction: ({
9372
- /** @constant */
9373
- kind: "redact";
9374
- } & components["schemas"]["ModalityRedactions"]) | ({
9375
- /** @constant */
9376
- kind: "suppress";
9377
- } & components["schemas"]["SuppressAction"]) | ({
9378
- /** @constant */
9379
- kind: "audit";
9380
- } & components["schemas"]["AuditAction"]);
9381
- /**
9382
- * @description Generic paginated response wrapper.
9383
- *
9384
- * Provides a consistent structure for all paginated API responses with
9385
- * cursor-based pagination support. When `next_cursor` is present, there
9386
- * are more items to fetch.
9387
- */
9388
- PolicyPage: {
9389
- /** @description Items in this page. */
9390
- items: components["schemas"]["Policy2"][];
9391
- /** @description Cursor to fetch the next page. Present only when more items exist. */
9392
- nextCursor?: string;
9393
9934
  /**
9394
- * Format: int64
9395
- * @description Total count of items matching the query (if requested).
9935
+ * @description Document-level gate. The whole policy (rules + fallback)
9936
+ * is skipped when this is `Some(...)` and the predicate is
9937
+ * false for the document. Evaluated once per document.
9396
9938
  */
9397
- total?: number;
9939
+ when?: components["schemas"]["DocumentPredicate"];
9398
9940
  };
9399
9941
  /**
9400
9942
  * @description Path parameters for policy operations.
@@ -9409,14 +9951,19 @@ interface components {
9409
9951
  policySlug: string;
9410
9952
  };
9411
9953
  /**
9412
- * @description One rule inside a [`Policy`]. Identity is the UUID; `name` /
9954
+ * @description One rule inside a [`PolicyDefinition`]. Identity is the UUID; `name` /
9413
9955
  * `description` are display-only.
9414
9956
  *
9415
- * [`Policy`]: super::Policy
9957
+ * [`PolicyDefinition`]: super::PolicyDefinition
9416
9958
  */
9417
9959
  PolicyRule: {
9418
- /** @description What to do on match. */
9419
- action: components["schemas"]["PolicyAction"];
9960
+ /**
9961
+ * @description Per-modality redaction operators applied when the
9962
+ * predicate matches. Modalities the rule doesn't cover fall
9963
+ * through to the policy fallback (or the next policy in the
9964
+ * chain).
9965
+ */
9966
+ action: components["schemas"]["ModalityRedactions"];
9420
9967
  /** @description Optional description for reviewers. */
9421
9968
  description?: string;
9422
9969
  /**
@@ -9439,6 +9986,53 @@ interface components {
9439
9986
  */
9440
9987
  predicate: components["schemas"]["Predicate"];
9441
9988
  };
9989
+ /**
9990
+ * @description Lightweight policy view for lists.
9991
+ *
9992
+ * Carries only the metadata available without decrypting the policy body, so a
9993
+ * page of policies costs no per-item decryption. The full [`Policy`] (with its
9994
+ * `definition`) is returned by the single-policy endpoint.
9995
+ */
9996
+ PolicySummary: {
9997
+ /**
9998
+ * Format: date-time
9999
+ * @description When the policy was created.
10000
+ */
10001
+ createdAt: string;
10002
+ /** @description Handle of the account that created this policy. */
10003
+ creatorUsername: components["schemas"]["Handle"];
10004
+ /** @description Policy description. */
10005
+ description?: string;
10006
+ /** @description Human-readable policy display name. */
10007
+ displayName: string;
10008
+ /** @description URL slug of the policy, unique within its workspace. */
10009
+ slug: components["schemas"]["Handle"];
10010
+ /**
10011
+ * Format: date-time
10012
+ * @description When the policy was last updated.
10013
+ */
10014
+ updatedAt: string;
10015
+ /** @description Handle of the workspace this policy belongs to. */
10016
+ workspaceSlug: components["schemas"]["Handle"];
10017
+ };
10018
+ /**
10019
+ * @description Generic paginated response wrapper.
10020
+ *
10021
+ * Provides a consistent structure for all paginated API responses with
10022
+ * cursor-based pagination support. When `next_cursor` is present, there
10023
+ * are more items to fetch.
10024
+ */
10025
+ PolicySummaryPage: {
10026
+ /** @description Items in this page. */
10027
+ items: components["schemas"]["PolicySummary"][];
10028
+ /** @description Cursor to fetch the next page. Present only when more items exist. */
10029
+ nextCursor?: string;
10030
+ /**
10031
+ * Format: int64
10032
+ * @description Total count of items matching the query (if requested).
10033
+ */
10034
+ total?: number;
10035
+ };
9442
10036
  /**
9443
10037
  * @description Closed polygon, given by its ordered vertices.
9444
10038
  *
@@ -9458,11 +10052,8 @@ interface components {
9458
10052
  Predicate: {
9459
10053
  /** @constant */
9460
10054
  kind: "confidence";
9461
- /**
9462
- * Format: float
9463
- * @description Minimum confidence in `[0.0, 1.0]`.
9464
- */
9465
- min: number;
10055
+ /** @description Minimum confidence cutoff. */
10056
+ min: components["schemas"]["ConfidenceThreshold"];
9466
10057
  } | {
9467
10058
  /** @constant */
9468
10059
  kind: "labelOneOf";
@@ -9514,6 +10105,8 @@ interface components {
9514
10105
  * and remain available solely through the caller's own `/account/` view.
9515
10106
  */
9516
10107
  PublicAccount: {
10108
+ /** @description Serve path of the account's avatar, when set. */
10109
+ avatarUrl?: string;
9517
10110
  /**
9518
10111
  * Format: date-time
9519
10112
  * @description Timestamp when the account was created.
@@ -9844,16 +10437,6 @@ interface components {
9844
10437
  };
9845
10438
  /** @description Sort order direction. */
9846
10439
  SortOrder: "asc" | "desc";
9847
- /** @description Payload for the `suppress` action. */
9848
- SuppressAction: {
9849
- /**
9850
- * @description Human-readable reason the entity is being suppressed. Surfaced
9851
- * verbatim in the audit entry so reviewers can tell apart
9852
- * "synthetic test data," "incident response," and "known false
9853
- * positive" without re-reading the policy.
9854
- */
9855
- reason?: string;
9856
- };
9857
10440
  /**
9858
10441
  * @description Request payload to trigger a connection sync.
9859
10442
  *
@@ -9991,7 +10574,7 @@ interface components {
9991
10574
  * `None` means "use the policy's decision"; `Some(action)`
9992
10575
  * overrides it for this specific entity at apply time.
9993
10576
  */
9994
- reviewerOverride?: components["schemas"]["PolicyAction"];
10577
+ reviewerOverride?: components["schemas"]["ModalityRedactions"];
9995
10578
  };
9996
10579
  /**
9997
10580
  * @description One thing that happened to an entity, with its effect on confidence.
@@ -10352,7 +10935,7 @@ interface components {
10352
10935
  * `None` means "use the policy's decision"; `Some(action)`
10353
10936
  * overrides it for this specific entity at apply time.
10354
10937
  */
10355
- reviewerOverride?: components["schemas"]["PolicyAction"];
10938
+ reviewerOverride?: components["schemas"]["ModalityRedactions"];
10356
10939
  };
10357
10940
  /**
10358
10941
  * @description One thing that happened to an entity, with its effect on confidence.
@@ -10609,6 +11192,31 @@ interface components {
10609
11192
  kind: "hash";
10610
11193
  /** @description Salt prepended to the value before hashing. */
10611
11194
  salt?: string;
11195
+ } | {
11196
+ /**
11197
+ * @description BCP-47 tag used when the entity carries no language of
11198
+ * its own. Defaults to English (`"en"`).
11199
+ */
11200
+ default_language?: components["schemas"]["LanguageTag"];
11201
+ /**
11202
+ * @description Template used for entity labels outside the built-in
11203
+ * PII catalogue (which `Fake` can't generate for).
11204
+ * Supports the same `{label}` / `{value}` / `{coref}`
11205
+ * placeholders as [`Replace`]. Defaults to `[{label}]`.
11206
+ *
11207
+ * [`Replace`]: TextRedaction::Replace
11208
+ * @default [{label}]
11209
+ */
11210
+ fallback_template: string;
11211
+ /** @constant */
11212
+ kind: "fake";
11213
+ /**
11214
+ * Format: uint64
11215
+ * @description Seed mixed into per-entity RNG state. Two runs with the
11216
+ * same seed and the same input entities produce the same
11217
+ * surrogates. Defaults to `0`.
11218
+ */
11219
+ seed?: number;
10612
11220
  } | {
10613
11221
  /** @constant */
10614
11222
  kind: "pseudonymize";
@@ -10708,6 +11316,12 @@ interface components {
10708
11316
  deletionPolicy?: components["schemas"]["SyncDeletionPolicy"];
10709
11317
  /** @description Human-readable connection display name. */
10710
11318
  displayName?: string;
11319
+ /**
11320
+ * @description Whether the connection is enabled for syncing. `false` disables it
11321
+ * (pausing scheduled syncs and rejecting manual ones); omit to leave
11322
+ * unchanged.
11323
+ */
11324
+ isActive?: boolean;
10711
11325
  /**
10712
11326
  * @description Cron expression for scheduled imports. Omit to leave unchanged; send
10713
11327
  * `null` to clear it (make the connection manual-only).
@@ -10762,7 +11376,7 @@ interface components {
10762
11376
  */
10763
11377
  UpdatePolicy: {
10764
11378
  /** @description New policy body (replaces the stored definition). */
10765
- definition?: components["schemas"]["Policy"];
11379
+ definition?: components["schemas"]["PolicyDefinition"];
10766
11380
  /** @description Policy description. */
10767
11381
  description?: string;
10768
11382
  /** @description Human-readable policy display name. */
@@ -10965,6 +11579,8 @@ interface components {
10965
11579
  WebhookStatus: "active" | "paused" | "disabled";
10966
11580
  /** @description Workspace response. */
10967
11581
  Workspace: {
11582
+ /** @description Serve path of the workspace's avatar (logo), when set. */
11583
+ avatarUrl?: string;
10968
11584
  /**
10969
11585
  * Format: date-time
10970
11586
  * @description Timestamp when the workspace was created.
@@ -11028,6 +11644,18 @@ interface components {
11028
11644
  /** @description Filter by run status. */
11029
11645
  status?: components["schemas"]["PipelineRunStatus"];
11030
11646
  };
11647
+ /** @description Query parameters for listing all syncs across a workspace. */
11648
+ WorkspaceSyncsQuery: {
11649
+ /**
11650
+ * @description Filter by connection provider (`s3`, `azure`, `gcs`). Repeatable; a sync
11651
+ * matches if its connection uses any of the given providers. Empty means no
11652
+ * provider filter.
11653
+ * @default []
11654
+ */
11655
+ provider: string[];
11656
+ /** @description Filter by sync status. */
11657
+ status?: components["schemas"]["SyncStatus"];
11658
+ };
11031
11659
  };
11032
11660
  responses: never;
11033
11661
  parameters: never;
@@ -11156,13 +11784,13 @@ type PipelineSummaryPage = Schemas$4["PipelineSummaryPage"];
11156
11784
  //#endregion
11157
11785
  //#region src/datatypes/policy.d.ts
11158
11786
  type Schemas$3 = components["schemas"];
11159
- type Policy = Schemas$3["Policy2"];
11160
- type PolicyDefinition = Schemas$3["Policy"];
11787
+ type Policy = Schemas$3["Policy"];
11788
+ type PolicySummary = Schemas$3["PolicySummary"];
11789
+ type PolicySummaryPage = Schemas$3["PolicySummaryPage"];
11790
+ type PolicyDefinition = Schemas$3["PolicyDefinition"];
11161
11791
  type CreatePolicy = Schemas$3["CreatePolicy"];
11162
11792
  type UpdatePolicy = Schemas$3["UpdatePolicy"];
11163
11793
  type PolicyRule = Schemas$3["PolicyRule"];
11164
- type PolicyAction = Schemas$3["PolicyAction"];
11165
- type PolicyPage = Schemas$3["PolicyPage"];
11166
11794
  //#endregion
11167
11795
  //#region src/datatypes/run.d.ts
11168
11796
  type Schemas$2 = components["schemas"];
@@ -11193,5 +11821,5 @@ type UpdateWorkspace = Schemas["UpdateWorkspace"];
11193
11821
  type WorkspaceRole = Schemas["WorkspaceRole"];
11194
11822
  type WorkspacePage = Schemas["WorkspacePage"];
11195
11823
  //#endregion
11196
- export { InviteExpiration as $, paths as $t, PipelineDefinition as A, S3Credentials as At, NotificationPage as B, ApiToken as Bt, PolicyAction as C, ConnectionPage as Ct, UpdatePolicy as D, ConnectionsQuery as Dt, PolicyRule as E, ConnectionVerification as Et, PipelineTriggerType as F, SyncTriggerType as Ft, Member as G, TokenExpiration as Gt, UnreadStatus as H, ApiTokenType as Ht, UpdatePipeline as I, UpdateConnection as It, UpdateMember as J, ActivityPage as Jt, MemberPage as K, UpdateApiToken as Kt, CursorPagination as L, AuthToken as Lt, PipelineStatus as M, SyncDeletionPolicy as Mt, PipelineSummary as N, SyncMode as Nt, CreatePipeline as O, CreateConnection as Ot, PipelineSummaryPage as P, SyncStatus as Pt, InviteCode as Q, UpdateAccount as Qt, Notification as R, Login as Rt, Policy as S, ConnectionConfig as St, PolicyPage as T, ConnectionSyncPage as Tt, UpdateNotificationSettings as U, ApiTokenWithJWT as Ut, NotificationSettings as V, ApiTokenPage as Vt, ListMembers as W, CreateApiToken as Wt, GenerateInviteCode as X, Account as Xt, CreateInvite as Y, ActivityType as Yt, Invite as Z, PublicAccount as Zt, CreatePipelineRun as _, UpdateFile as _t, WorkspaceRole as a, ListInvites as at, PipelineRunStatus as b, AzureCredentials as bt, UpdateWebhook as c, ComponentHealth as ct, WebhookEvent as d, File as dt, InvitePage as et, WebhookPage as f, FilePage as ft, Artifact as g, ModalityToken as gt, AnalyzedDocument as h, ListFiles as ht, WorkspacePage as i, InviteStatus as it, PipelineFilter as j, SyncConnection as jt, Pipeline as k, GcsCredentials as kt, Webhook as l, Health as lt, WebhookStatus as m, FormatToken as mt, UpdateWorkspace as n, InviteSent as nt, CreateWebhook as o, ReplyInvite as ot, WebhookResult as p, FileSource as pt, MemberSortField as q, Activity as qt, Workspace as r, InviteSortField as rt, TestWebhook as s, SortOrder as st, CreateWorkspace as t, InvitePreview as tt, WebhookCreated as u, HealthStatus as ut, PipelineRun as v, ErrorResponse as vt, PolicyDefinition as w, ConnectionSync as wt, CreatePolicy as x, Connection as xt, PipelineRunPage as y, ValidationErrorDetail as yt, NotificationEvent as z, Signup as zt };
11197
- //# sourceMappingURL=index-BHXlYpCf.d.ts.map
11824
+ export { InviteExpiration as $, paths as $t, PipelineDefinition as A, S3Credentials as At, NotificationPage as B, ApiToken as Bt, PolicyDefinition as C, ConnectionPage as Ct, UpdatePolicy as D, ConnectionsQuery as Dt, PolicySummaryPage as E, ConnectionVerification as Et, PipelineTriggerType as F, SyncTriggerType as Ft, Member as G, TokenExpiration as Gt, UnreadStatus as H, ApiTokenType as Ht, UpdatePipeline as I, UpdateConnection as It, UpdateMember as J, ActivityPage as Jt, MemberPage as K, UpdateApiToken as Kt, CursorPagination as L, AuthToken as Lt, PipelineStatus as M, SyncDeletionPolicy as Mt, PipelineSummary as N, SyncMode as Nt, CreatePipeline as O, CreateConnection as Ot, PipelineSummaryPage as P, SyncStatus as Pt, InviteCode as Q, UpdateAccount as Qt, Notification as R, Login as Rt, Policy as S, ConnectionConfig as St, PolicySummary as T, ConnectionSyncPage as Tt, UpdateNotificationSettings as U, ApiTokenWithJWT as Ut, NotificationSettings as V, ApiTokenPage as Vt, ListMembers as W, CreateApiToken as Wt, GenerateInviteCode as X, Account as Xt, CreateInvite as Y, ActivityType as Yt, Invite as Z, PublicAccount as Zt, CreatePipelineRun as _, UpdateFile as _t, WorkspaceRole as a, ListInvites as at, PipelineRunStatus as b, AzureCredentials as bt, UpdateWebhook as c, ComponentHealth as ct, WebhookEvent as d, File as dt, InvitePage as et, WebhookPage as f, FilePage as ft, Artifact as g, ModalityToken as gt, AnalyzedDocument as h, ListFiles as ht, WorkspacePage as i, InviteStatus as it, PipelineFilter as j, SyncConnection as jt, Pipeline as k, GcsCredentials as kt, Webhook as l, Health as lt, WebhookStatus as m, FormatToken as mt, UpdateWorkspace as n, InviteSent as nt, CreateWebhook as o, ReplyInvite as ot, WebhookResult as p, FileSource as pt, MemberSortField as q, Activity as qt, Workspace as r, InviteSortField as rt, TestWebhook as s, SortOrder as st, CreateWorkspace as t, InvitePreview as tt, WebhookCreated as u, HealthStatus as ut, PipelineRun as v, ErrorResponse as vt, PolicyRule as w, ConnectionSync as wt, CreatePolicy as x, Connection as xt, PipelineRunPage as y, ValidationErrorDetail as yt, NotificationEvent as z, Signup as zt };
11825
+ //# sourceMappingURL=index-BAyMQmm6.d.ts.map