@nvisy/sdk 0.10.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;
@@ -766,12 +996,256 @@ interface paths {
766
996
  */
767
997
  requestBody: {
768
998
  content: {
769
- "application/json": components["schemas"]["CreateWorkspace"];
999
+ "application/json": components["schemas"]["CreateWorkspace"];
1000
+ };
1001
+ };
1002
+ responses: {
1003
+ /** @description Workspace response. */
1004
+ 201: {
1005
+ headers: {
1006
+ [name: string]: unknown;
1007
+ };
1008
+ content: {
1009
+ "application/json": components["schemas"]["Workspace"];
1010
+ };
1011
+ };
1012
+ /**
1013
+ * @description HTTP error response representation with security-conscious design.
1014
+ *
1015
+ * This struct contains all the information needed to serialize an error
1016
+ * response, including the error name, message, HTTP status code, resource
1017
+ * information, and user-friendly messages.
1018
+ */
1019
+ 400: {
1020
+ headers: {
1021
+ [name: string]: unknown;
1022
+ };
1023
+ content: {
1024
+ "application/json": components["schemas"]["ErrorResponse"];
1025
+ };
1026
+ };
1027
+ /**
1028
+ * @description HTTP error response representation with security-conscious design.
1029
+ *
1030
+ * This struct contains all the information needed to serialize an error
1031
+ * response, including the error name, message, HTTP status code, resource
1032
+ * information, and user-friendly messages.
1033
+ */
1034
+ 401: {
1035
+ headers: {
1036
+ [name: string]: unknown;
1037
+ };
1038
+ content: {
1039
+ "application/json": components["schemas"]["ErrorResponse"];
1040
+ };
1041
+ };
1042
+ /** @description Expected request with `Content-Type: application/json` */
1043
+ 415: {
1044
+ headers: {
1045
+ [name: string]: unknown;
1046
+ };
1047
+ content: {
1048
+ "text/plain": string;
1049
+ };
1050
+ };
1051
+ /** @description Failed to deserialize the JSON body into the target type */
1052
+ 422: {
1053
+ headers: {
1054
+ [name: string]: unknown;
1055
+ };
1056
+ content: {
1057
+ "text/plain": string;
1058
+ };
1059
+ };
1060
+ };
1061
+ };
1062
+ delete?: never;
1063
+ options?: never;
1064
+ head?: never;
1065
+ patch?: never;
1066
+ trace?: never;
1067
+ };
1068
+ "/workspaces/{workspaceSlug}/": {
1069
+ parameters: {
1070
+ query?: never;
1071
+ header?: never;
1072
+ path?: never;
1073
+ cookie?: never;
1074
+ };
1075
+ /**
1076
+ * Get workspace
1077
+ * @description Returns details for a specific workspace.
1078
+ */
1079
+ get: {
1080
+ parameters: {
1081
+ query?: never;
1082
+ header?: never;
1083
+ path: {
1084
+ /** @description URL-safe workspace identifier. */
1085
+ workspaceSlug: string;
1086
+ };
1087
+ cookie?: never;
1088
+ };
1089
+ requestBody?: never;
1090
+ responses: {
1091
+ /** @description Workspace response. */
1092
+ 200: {
1093
+ headers: {
1094
+ [name: string]: unknown;
1095
+ };
1096
+ content: {
1097
+ "application/json": components["schemas"]["Workspace"];
1098
+ };
1099
+ };
1100
+ /**
1101
+ * @description HTTP error response representation with security-conscious design.
1102
+ *
1103
+ * This struct contains all the information needed to serialize an error
1104
+ * response, including the error name, message, HTTP status code, resource
1105
+ * information, and user-friendly messages.
1106
+ */
1107
+ 401: {
1108
+ headers: {
1109
+ [name: string]: unknown;
1110
+ };
1111
+ content: {
1112
+ "application/json": components["schemas"]["ErrorResponse"];
1113
+ };
1114
+ };
1115
+ /**
1116
+ * @description HTTP error response representation with security-conscious design.
1117
+ *
1118
+ * This struct contains all the information needed to serialize an error
1119
+ * response, including the error name, message, HTTP status code, resource
1120
+ * information, and user-friendly messages.
1121
+ */
1122
+ 403: {
1123
+ headers: {
1124
+ [name: string]: unknown;
1125
+ };
1126
+ content: {
1127
+ "application/json": components["schemas"]["ErrorResponse"];
1128
+ };
1129
+ };
1130
+ /**
1131
+ * @description HTTP error response representation with security-conscious design.
1132
+ *
1133
+ * This struct contains all the information needed to serialize an error
1134
+ * response, including the error name, message, HTTP status code, resource
1135
+ * information, and user-friendly messages.
1136
+ */
1137
+ 404: {
1138
+ headers: {
1139
+ [name: string]: unknown;
1140
+ };
1141
+ content: {
1142
+ "application/json": components["schemas"]["ErrorResponse"];
1143
+ };
1144
+ };
1145
+ };
1146
+ };
1147
+ put?: never;
1148
+ post?: never;
1149
+ /**
1150
+ * Delete workspace
1151
+ * @description Soft-deletes a workspace. Data is retained for potential recovery.
1152
+ */
1153
+ delete: {
1154
+ parameters: {
1155
+ query?: never;
1156
+ header?: never;
1157
+ path: {
1158
+ /** @description URL-safe workspace identifier. */
1159
+ workspaceSlug: string;
1160
+ };
1161
+ cookie?: never;
1162
+ };
1163
+ requestBody?: never;
1164
+ responses: {
1165
+ /** @description no content */
1166
+ 200: {
1167
+ headers: {
1168
+ [name: string]: unknown;
1169
+ };
1170
+ content?: never;
1171
+ };
1172
+ /**
1173
+ * @description HTTP error response representation with security-conscious design.
1174
+ *
1175
+ * This struct contains all the information needed to serialize an error
1176
+ * response, including the error name, message, HTTP status code, resource
1177
+ * information, and user-friendly messages.
1178
+ */
1179
+ 401: {
1180
+ headers: {
1181
+ [name: string]: unknown;
1182
+ };
1183
+ content: {
1184
+ "application/json": components["schemas"]["ErrorResponse"];
1185
+ };
1186
+ };
1187
+ /**
1188
+ * @description HTTP error response representation with security-conscious design.
1189
+ *
1190
+ * This struct contains all the information needed to serialize an error
1191
+ * response, including the error name, message, HTTP status code, resource
1192
+ * information, and user-friendly messages.
1193
+ */
1194
+ 403: {
1195
+ headers: {
1196
+ [name: string]: unknown;
1197
+ };
1198
+ content: {
1199
+ "application/json": components["schemas"]["ErrorResponse"];
1200
+ };
1201
+ };
1202
+ /**
1203
+ * @description HTTP error response representation with security-conscious design.
1204
+ *
1205
+ * This struct contains all the information needed to serialize an error
1206
+ * response, including the error name, message, HTTP status code, resource
1207
+ * information, and user-friendly messages.
1208
+ */
1209
+ 404: {
1210
+ headers: {
1211
+ [name: string]: unknown;
1212
+ };
1213
+ content: {
1214
+ "application/json": components["schemas"]["ErrorResponse"];
1215
+ };
1216
+ };
1217
+ };
1218
+ };
1219
+ options?: never;
1220
+ head?: never;
1221
+ /**
1222
+ * Update workspace
1223
+ * @description Updates an existing workspace's configuration. Only provided fields are updated.
1224
+ */
1225
+ patch: {
1226
+ parameters: {
1227
+ query?: never;
1228
+ header?: never;
1229
+ path: {
1230
+ /** @description URL-safe workspace identifier. */
1231
+ workspaceSlug: string;
1232
+ };
1233
+ cookie?: never;
1234
+ };
1235
+ /**
1236
+ * @description Request payload to update an existing workspace.
1237
+ *
1238
+ * All fields are optional; only provided fields will be updated. The slug is
1239
+ * immutable and set at creation, so it cannot be changed here.
1240
+ */
1241
+ requestBody: {
1242
+ content: {
1243
+ "application/json": components["schemas"]["UpdateWorkspace"];
770
1244
  };
771
1245
  };
772
1246
  responses: {
773
1247
  /** @description Workspace response. */
774
- 201: {
1248
+ 200: {
775
1249
  headers: {
776
1250
  [name: string]: unknown;
777
1251
  };
@@ -809,6 +1283,21 @@ interface paths {
809
1283
  "application/json": components["schemas"]["ErrorResponse"];
810
1284
  };
811
1285
  };
1286
+ /**
1287
+ * @description HTTP error response representation with security-conscious design.
1288
+ *
1289
+ * This struct contains all the information needed to serialize an error
1290
+ * response, including the error name, message, HTTP status code, resource
1291
+ * information, and user-friendly messages.
1292
+ */
1293
+ 403: {
1294
+ headers: {
1295
+ [name: string]: unknown;
1296
+ };
1297
+ content: {
1298
+ "application/json": components["schemas"]["ErrorResponse"];
1299
+ };
1300
+ };
812
1301
  /** @description Expected request with `Content-Type: application/json` */
813
1302
  415: {
814
1303
  headers: {
@@ -829,13 +1318,9 @@ interface paths {
829
1318
  };
830
1319
  };
831
1320
  };
832
- delete?: never;
833
- options?: never;
834
- head?: never;
835
- patch?: never;
836
1321
  trace?: never;
837
1322
  };
838
- "/workspaces/{workspaceSlug}/": {
1323
+ "/workspaces/{workspaceSlug}/avatar/": {
839
1324
  parameters: {
840
1325
  query?: never;
841
1326
  header?: never;
@@ -843,8 +1328,8 @@ interface paths {
843
1328
  cookie?: never;
844
1329
  };
845
1330
  /**
846
- * Get workspace
847
- * @description Returns details for a specific workspace.
1331
+ * Get workspace avatar
1332
+ * @description Returns the workspace's avatar image (WebP). 404 when unset.
848
1333
  */
849
1334
  get: {
850
1335
  parameters: {
@@ -858,14 +1343,12 @@ interface paths {
858
1343
  };
859
1344
  requestBody?: never;
860
1345
  responses: {
861
- /** @description Workspace response. */
1346
+ /** @description no content */
862
1347
  200: {
863
1348
  headers: {
864
1349
  [name: string]: unknown;
865
1350
  };
866
- content: {
867
- "application/json": components["schemas"]["Workspace"];
868
- };
1351
+ content?: never;
869
1352
  };
870
1353
  /**
871
1354
  * @description HTTP error response representation with security-conscious design.
@@ -914,13 +1397,11 @@ interface paths {
914
1397
  };
915
1398
  };
916
1399
  };
917
- put?: never;
918
- post?: never;
919
1400
  /**
920
- * Delete workspace
921
- * @description Soft-deletes a workspace. Data is retained for potential recovery.
1401
+ * Upload workspace avatar
1402
+ * @description Uploads and normalizes the workspace's avatar. Requires UpdateWorkspace.
922
1403
  */
923
- delete: {
1404
+ put: {
924
1405
  parameters: {
925
1406
  query?: never;
926
1407
  header?: never;
@@ -930,7 +1411,12 @@ interface paths {
930
1411
  };
931
1412
  cookie?: never;
932
1413
  };
933
- requestBody?: never;
1414
+ /** @description multipart form data */
1415
+ requestBody: {
1416
+ content: {
1417
+ "multipart/form-data": unknown[];
1418
+ };
1419
+ };
934
1420
  responses: {
935
1421
  /** @description no content */
936
1422
  200: {
@@ -939,6 +1425,21 @@ interface paths {
939
1425
  };
940
1426
  content?: never;
941
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
+ };
942
1443
  /**
943
1444
  * @description HTTP error response representation with security-conscious design.
944
1445
  *
@@ -986,13 +1487,12 @@ interface paths {
986
1487
  };
987
1488
  };
988
1489
  };
989
- options?: never;
990
- head?: never;
1490
+ post?: never;
991
1491
  /**
992
- * Update workspace
993
- * @description Updates an existing workspace's configuration. Only provided fields are updated.
1492
+ * Delete workspace avatar
1493
+ * @description Removes the workspace's avatar. Requires UpdateWorkspace.
994
1494
  */
995
- patch: {
1495
+ delete: {
996
1496
  parameters: {
997
1497
  query?: never;
998
1498
  header?: never;
@@ -1002,26 +1502,14 @@ interface paths {
1002
1502
  };
1003
1503
  cookie?: never;
1004
1504
  };
1005
- /**
1006
- * @description Request payload to update an existing workspace.
1007
- *
1008
- * All fields are optional; only provided fields will be updated. The slug is
1009
- * immutable and set at creation, so it cannot be changed here.
1010
- */
1011
- requestBody: {
1012
- content: {
1013
- "application/json": components["schemas"]["UpdateWorkspace"];
1014
- };
1015
- };
1505
+ requestBody?: never;
1016
1506
  responses: {
1017
- /** @description Workspace response. */
1018
- 200: {
1507
+ /** @description no content */
1508
+ 204: {
1019
1509
  headers: {
1020
1510
  [name: string]: unknown;
1021
1511
  };
1022
- content: {
1023
- "application/json": components["schemas"]["Workspace"];
1024
- };
1512
+ content?: never;
1025
1513
  };
1026
1514
  /**
1027
1515
  * @description HTTP error response representation with security-conscious design.
@@ -1030,7 +1518,7 @@ interface paths {
1030
1518
  * response, including the error name, message, HTTP status code, resource
1031
1519
  * information, and user-friendly messages.
1032
1520
  */
1033
- 400: {
1521
+ 401: {
1034
1522
  headers: {
1035
1523
  [name: string]: unknown;
1036
1524
  };
@@ -1045,7 +1533,7 @@ interface paths {
1045
1533
  * response, including the error name, message, HTTP status code, resource
1046
1534
  * information, and user-friendly messages.
1047
1535
  */
1048
- 401: {
1536
+ 403: {
1049
1537
  headers: {
1050
1538
  [name: string]: unknown;
1051
1539
  };
@@ -1060,7 +1548,7 @@ interface paths {
1060
1548
  * response, including the error name, message, HTTP status code, resource
1061
1549
  * information, and user-friendly messages.
1062
1550
  */
1063
- 403: {
1551
+ 404: {
1064
1552
  headers: {
1065
1553
  [name: string]: unknown;
1066
1554
  };
@@ -1068,26 +1556,11 @@ interface paths {
1068
1556
  "application/json": components["schemas"]["ErrorResponse"];
1069
1557
  };
1070
1558
  };
1071
- /** @description Expected request with `Content-Type: application/json` */
1072
- 415: {
1073
- headers: {
1074
- [name: string]: unknown;
1075
- };
1076
- content: {
1077
- "text/plain": string;
1078
- };
1079
- };
1080
- /** @description Failed to deserialize the JSON body into the target type */
1081
- 422: {
1082
- headers: {
1083
- [name: string]: unknown;
1084
- };
1085
- content: {
1086
- "text/plain": string;
1087
- };
1088
- };
1089
1559
  };
1090
1560
  };
1561
+ options?: never;
1562
+ head?: never;
1563
+ patch?: never;
1091
1564
  trace?: never;
1092
1565
  };
1093
1566
  "/workspaces/{workspaceSlug}/notifications/": {
@@ -5910,7 +6383,7 @@ interface paths {
5910
6383
  [name: string]: unknown;
5911
6384
  };
5912
6385
  content: {
5913
- "application/json": components["schemas"]["PolicyPage"];
6386
+ "application/json": components["schemas"]["PolicySummaryPage"];
5914
6387
  };
5915
6388
  };
5916
6389
  /**
@@ -5964,8 +6437,8 @@ interface paths {
5964
6437
  * @description Request payload for creating a new workspace policy.
5965
6438
  *
5966
6439
  * The `definition` is a structured policy the redaction engine consumes;
5967
- * its `name`, `description`, and `version` drive the stored columns unless
5968
- * overridden here.
6440
+ * its `name` and `description` drive the stored columns unless overridden
6441
+ * here.
5969
6442
  */
5970
6443
  requestBody: {
5971
6444
  content: {
@@ -5979,7 +6452,7 @@ interface paths {
5979
6452
  [name: string]: unknown;
5980
6453
  };
5981
6454
  content: {
5982
- "application/json": components["schemas"]["Policy2"];
6455
+ "application/json": components["schemas"]["Policy"];
5983
6456
  };
5984
6457
  };
5985
6458
  /**
@@ -6084,7 +6557,7 @@ interface paths {
6084
6557
  [name: string]: unknown;
6085
6558
  };
6086
6559
  content: {
6087
- "application/json": components["schemas"]["Policy2"];
6560
+ "application/json": components["schemas"]["Policy"];
6088
6561
  };
6089
6562
  };
6090
6563
  /**
@@ -6243,7 +6716,7 @@ interface paths {
6243
6716
  [name: string]: unknown;
6244
6717
  };
6245
6718
  content: {
6246
- "application/json": components["schemas"]["Policy2"];
6719
+ "application/json": components["schemas"]["Policy"];
6247
6720
  };
6248
6721
  };
6249
6722
  /**
@@ -6742,6 +7215,8 @@ interface components {
6742
7215
  schemas: {
6743
7216
  /** @description Represents an account. */
6744
7217
  Account: {
7218
+ /** @description Serve path of the account's avatar, when set. */
7219
+ avatarUrl?: string;
6745
7220
  /**
6746
7221
  * Format: date-time
6747
7222
  * @description Timestamp when the account was created.
@@ -7125,7 +7600,7 @@ interface components {
7125
7600
  * `None` means "use the policy's decision"; `Some(action)`
7126
7601
  * overrides it for this specific entity at apply time.
7127
7602
  */
7128
- reviewerOverride?: components["schemas"]["PolicyAction"];
7603
+ reviewerOverride?: components["schemas"]["ModalityRedactions"];
7129
7604
  };
7130
7605
  /**
7131
7606
  * @description One thing that happened to an entity, with its effect on confidence.
@@ -7363,15 +7838,6 @@ interface components {
7363
7838
  */
7364
7839
  waveform: components["schemas"]["Waveform"];
7365
7840
  };
7366
- /** @description Payload for the `audit` action. */
7367
- AuditAction: {
7368
- /**
7369
- * @description Severity hint propagated into the audit entry (e.g.
7370
- * `"low"`, `"medium"`, `"high"`). Free-form for now; downstream
7371
- * review tooling decides how to render or filter.
7372
- */
7373
- severity?: string;
7374
- };
7375
7841
  /** @description Response returned after successful authentication (login/signup). */
7376
7842
  AuthToken: {
7377
7843
  /** @description The JWT API token for authentication. */
@@ -7787,12 +8253,12 @@ interface components {
7787
8253
  * @description Request payload for creating a new workspace policy.
7788
8254
  *
7789
8255
  * The `definition` is a structured policy the redaction engine consumes;
7790
- * its `name`, `description`, and `version` drive the stored columns unless
7791
- * overridden here.
8256
+ * its `name` and `description` drive the stored columns unless overridden
8257
+ * here.
7792
8258
  */
7793
8259
  CreatePolicy: {
7794
8260
  /** @description The structured policy body consumed by the engine. */
7795
- definition: components["schemas"]["Policy"];
8261
+ definition: components["schemas"]["PolicyDefinition"];
7796
8262
  /** @description Optional description override. Defaults to the policy's own description. */
7797
8263
  description?: string;
7798
8264
  /** @description Optional display name override. Defaults to the policy's own name. */
@@ -8332,7 +8798,7 @@ interface components {
8332
8798
  * `None` means "use the policy's decision"; `Some(action)`
8333
8799
  * overrides it for this specific entity at apply time.
8334
8800
  */
8335
- reviewerOverride?: components["schemas"]["PolicyAction"];
8801
+ reviewerOverride?: components["schemas"]["ModalityRedactions"];
8336
8802
  };
8337
8803
  /**
8338
8804
  * @description One thing that happened to an entity, with its effect on confidence.
@@ -9398,20 +9864,37 @@ interface components {
9398
9864
  */
9399
9865
  y: number;
9400
9866
  };
9401
- /**
9402
- * @description A named, versioned governance policy.
9403
- *
9404
- * Identity is the UUID; `name` is display-only. `version` is the
9405
- * policy body's semver: two submissions of the same
9406
- * `(id, version)` pair should produce identical decisions.
9407
- */
9867
+ /** @description Response type for a workspace policy. */
9408
9868
  Policy: {
9409
9869
  /**
9410
- * @description Document-level gate. The whole policy (rules + fallback)
9411
- * is skipped when this is `Some(...)` and the predicate is
9412
- * 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.
9413
9887
  */
9414
- 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: {
9415
9898
  /** @description Optional description for reviewers. */
9416
9899
  description?: string;
9417
9900
  /**
@@ -9420,7 +9903,7 @@ interface components {
9420
9903
  * to the next policy. [`Option`] enforces "at most one
9421
9904
  * fallback per policy" at the type level.
9422
9905
  */
9423
- fallback?: components["schemas"]["PolicyAction"];
9906
+ fallback?: components["schemas"]["ModalityRedactions"];
9424
9907
  /**
9425
9908
  * Format: uuid
9426
9909
  * @description Stable identifier. UUIDv7 recommended (time-ordered);
@@ -9448,76 +9931,12 @@ interface components {
9448
9931
  retention?: components["schemas"]["RetentionPolicy"][];
9449
9932
  /** @description Ordered rules. First match wins within this policy. */
9450
9933
  rules?: components["schemas"]["PolicyRule"][];
9451
- /** @description Semver of the policy body. */
9452
- version: string;
9453
- };
9454
- /** @description Response type for a workspace policy. */
9455
- Policy2: {
9456
- /**
9457
- * Format: date-time
9458
- * @description When the policy was created.
9459
- */
9460
- createdAt: string;
9461
- /** @description Handle of the account that created this policy. */
9462
- creatorUsername: components["schemas"]["Handle"];
9463
- /** @description The structured policy body consumed by the engine. */
9464
- definition: components["schemas"]["Policy"];
9465
- /** @description Policy description. */
9466
- description?: string;
9467
- /** @description Human-readable policy display name. */
9468
- displayName: string;
9469
- /** @description URL slug of the policy, unique within its workspace. */
9470
- slug: components["schemas"]["Handle"];
9471
- /**
9472
- * Format: date-time
9473
- * @description When the policy was last updated.
9474
- */
9475
- updatedAt: string;
9476
- /** @description Semver of the policy body. */
9477
- version: string;
9478
- /** @description Handle of the workspace this policy belongs to. */
9479
- workspaceSlug: components["schemas"]["Handle"];
9480
- };
9481
- /**
9482
- * @description What a rule does when its [`predicate`] matches.
9483
- *
9484
- * Three verbs: [`Redact`] transforms the entity with one operator
9485
- * per modality; [`Suppress`] drops the entity entirely (false-positive
9486
- * marker) and stamps a reason onto the audit; [`Audit`] flags it for
9487
- * human review without transforming.
9488
- *
9489
- * [`predicate`]: PolicyRule::predicate
9490
- * [`Redact`]: PolicyAction::Redact
9491
- * [`Suppress`]: PolicyAction::Suppress
9492
- * [`Audit`]: PolicyAction::Audit
9493
- */
9494
- PolicyAction: ({
9495
- /** @constant */
9496
- kind: "redact";
9497
- } & components["schemas"]["ModalityRedactions"]) | ({
9498
- /** @constant */
9499
- kind: "suppress";
9500
- } & components["schemas"]["SuppressAction"]) | ({
9501
- /** @constant */
9502
- kind: "audit";
9503
- } & components["schemas"]["AuditAction"]);
9504
- /**
9505
- * @description Generic paginated response wrapper.
9506
- *
9507
- * Provides a consistent structure for all paginated API responses with
9508
- * cursor-based pagination support. When `next_cursor` is present, there
9509
- * are more items to fetch.
9510
- */
9511
- PolicyPage: {
9512
- /** @description Items in this page. */
9513
- items: components["schemas"]["Policy2"][];
9514
- /** @description Cursor to fetch the next page. Present only when more items exist. */
9515
- nextCursor?: string;
9516
9934
  /**
9517
- * Format: int64
9518
- * @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.
9519
9938
  */
9520
- total?: number;
9939
+ when?: components["schemas"]["DocumentPredicate"];
9521
9940
  };
9522
9941
  /**
9523
9942
  * @description Path parameters for policy operations.
@@ -9532,14 +9951,19 @@ interface components {
9532
9951
  policySlug: string;
9533
9952
  };
9534
9953
  /**
9535
- * @description One rule inside a [`Policy`]. Identity is the UUID; `name` /
9954
+ * @description One rule inside a [`PolicyDefinition`]. Identity is the UUID; `name` /
9536
9955
  * `description` are display-only.
9537
9956
  *
9538
- * [`Policy`]: super::Policy
9957
+ * [`PolicyDefinition`]: super::PolicyDefinition
9539
9958
  */
9540
9959
  PolicyRule: {
9541
- /** @description What to do on match. */
9542
- 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"];
9543
9967
  /** @description Optional description for reviewers. */
9544
9968
  description?: string;
9545
9969
  /**
@@ -9562,6 +9986,53 @@ interface components {
9562
9986
  */
9563
9987
  predicate: components["schemas"]["Predicate"];
9564
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
+ };
9565
10036
  /**
9566
10037
  * @description Closed polygon, given by its ordered vertices.
9567
10038
  *
@@ -9581,11 +10052,8 @@ interface components {
9581
10052
  Predicate: {
9582
10053
  /** @constant */
9583
10054
  kind: "confidence";
9584
- /**
9585
- * Format: float
9586
- * @description Minimum confidence in `[0.0, 1.0]`.
9587
- */
9588
- min: number;
10055
+ /** @description Minimum confidence cutoff. */
10056
+ min: components["schemas"]["ConfidenceThreshold"];
9589
10057
  } | {
9590
10058
  /** @constant */
9591
10059
  kind: "labelOneOf";
@@ -9637,6 +10105,8 @@ interface components {
9637
10105
  * and remain available solely through the caller's own `/account/` view.
9638
10106
  */
9639
10107
  PublicAccount: {
10108
+ /** @description Serve path of the account's avatar, when set. */
10109
+ avatarUrl?: string;
9640
10110
  /**
9641
10111
  * Format: date-time
9642
10112
  * @description Timestamp when the account was created.
@@ -9967,16 +10437,6 @@ interface components {
9967
10437
  };
9968
10438
  /** @description Sort order direction. */
9969
10439
  SortOrder: "asc" | "desc";
9970
- /** @description Payload for the `suppress` action. */
9971
- SuppressAction: {
9972
- /**
9973
- * @description Human-readable reason the entity is being suppressed. Surfaced
9974
- * verbatim in the audit entry so reviewers can tell apart
9975
- * "synthetic test data," "incident response," and "known false
9976
- * positive" without re-reading the policy.
9977
- */
9978
- reason?: string;
9979
- };
9980
10440
  /**
9981
10441
  * @description Request payload to trigger a connection sync.
9982
10442
  *
@@ -10114,7 +10574,7 @@ interface components {
10114
10574
  * `None` means "use the policy's decision"; `Some(action)`
10115
10575
  * overrides it for this specific entity at apply time.
10116
10576
  */
10117
- reviewerOverride?: components["schemas"]["PolicyAction"];
10577
+ reviewerOverride?: components["schemas"]["ModalityRedactions"];
10118
10578
  };
10119
10579
  /**
10120
10580
  * @description One thing that happened to an entity, with its effect on confidence.
@@ -10475,7 +10935,7 @@ interface components {
10475
10935
  * `None` means "use the policy's decision"; `Some(action)`
10476
10936
  * overrides it for this specific entity at apply time.
10477
10937
  */
10478
- reviewerOverride?: components["schemas"]["PolicyAction"];
10938
+ reviewerOverride?: components["schemas"]["ModalityRedactions"];
10479
10939
  };
10480
10940
  /**
10481
10941
  * @description One thing that happened to an entity, with its effect on confidence.
@@ -10732,6 +11192,31 @@ interface components {
10732
11192
  kind: "hash";
10733
11193
  /** @description Salt prepended to the value before hashing. */
10734
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;
10735
11220
  } | {
10736
11221
  /** @constant */
10737
11222
  kind: "pseudonymize";
@@ -10891,7 +11376,7 @@ interface components {
10891
11376
  */
10892
11377
  UpdatePolicy: {
10893
11378
  /** @description New policy body (replaces the stored definition). */
10894
- definition?: components["schemas"]["Policy"];
11379
+ definition?: components["schemas"]["PolicyDefinition"];
10895
11380
  /** @description Policy description. */
10896
11381
  description?: string;
10897
11382
  /** @description Human-readable policy display name. */
@@ -11094,6 +11579,8 @@ interface components {
11094
11579
  WebhookStatus: "active" | "paused" | "disabled";
11095
11580
  /** @description Workspace response. */
11096
11581
  Workspace: {
11582
+ /** @description Serve path of the workspace's avatar (logo), when set. */
11583
+ avatarUrl?: string;
11097
11584
  /**
11098
11585
  * Format: date-time
11099
11586
  * @description Timestamp when the workspace was created.
@@ -11297,13 +11784,13 @@ type PipelineSummaryPage = Schemas$4["PipelineSummaryPage"];
11297
11784
  //#endregion
11298
11785
  //#region src/datatypes/policy.d.ts
11299
11786
  type Schemas$3 = components["schemas"];
11300
- type Policy = Schemas$3["Policy2"];
11301
- 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"];
11302
11791
  type CreatePolicy = Schemas$3["CreatePolicy"];
11303
11792
  type UpdatePolicy = Schemas$3["UpdatePolicy"];
11304
11793
  type PolicyRule = Schemas$3["PolicyRule"];
11305
- type PolicyAction = Schemas$3["PolicyAction"];
11306
- type PolicyPage = Schemas$3["PolicyPage"];
11307
11794
  //#endregion
11308
11795
  //#region src/datatypes/run.d.ts
11309
11796
  type Schemas$2 = components["schemas"];
@@ -11334,5 +11821,5 @@ type UpdateWorkspace = Schemas["UpdateWorkspace"];
11334
11821
  type WorkspaceRole = Schemas["WorkspaceRole"];
11335
11822
  type WorkspacePage = Schemas["WorkspacePage"];
11336
11823
  //#endregion
11337
- 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 };
11338
- //# sourceMappingURL=index-DVds_8ZR.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