@nvisy/sdk 0.4.0 → 0.5.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.
- package/CHANGELOG.md +29 -1
- package/README.md +0 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/{client-yLrhST0r.d.ts → client-DAxwkjk3.d.ts} +137 -147
- package/dist/client-DAxwkjk3.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/{index-Cmm2g3SG.d.ts → index-DfNB2LNT.d.ts} +564 -1409
- package/dist/index-DfNB2LNT.d.ts.map +1 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -7
- package/dist/index.js.map +1 -1
- package/dist/services/index.d.ts +2 -2
- package/dist/services/index.js +2 -2
- package/dist/{services-Dh0FMDzU.js → services-DXP-jsLt.js} +298 -251
- package/dist/services-DXP-jsLt.js.map +1 -0
- package/package.json +3 -3
- package/dist/client-yLrhST0r.d.ts.map +0 -1
- package/dist/index-Cmm2g3SG.d.ts.map +0 -1
- package/dist/services-Dh0FMDzU.js.map +0 -1
|
@@ -200,7 +200,7 @@ interface paths {
|
|
|
200
200
|
};
|
|
201
201
|
trace?: never;
|
|
202
202
|
};
|
|
203
|
-
"/accounts/{
|
|
203
|
+
"/accounts/{username}/": {
|
|
204
204
|
parameters: {
|
|
205
205
|
query?: never;
|
|
206
206
|
header?: never;
|
|
@@ -208,28 +208,33 @@ interface paths {
|
|
|
208
208
|
cookie?: never;
|
|
209
209
|
};
|
|
210
210
|
/**
|
|
211
|
-
* Get account by
|
|
212
|
-
* @description Returns an account's
|
|
211
|
+
* Get account by username
|
|
212
|
+
* @description Returns an account's public profile by its handle. The requester must share at least one workspace with the target account.
|
|
213
213
|
*/
|
|
214
214
|
get: {
|
|
215
215
|
parameters: {
|
|
216
216
|
query?: never;
|
|
217
217
|
header?: never;
|
|
218
218
|
path: {
|
|
219
|
-
/** @description
|
|
220
|
-
|
|
219
|
+
/** @description Public handle of the account. */
|
|
220
|
+
username: components["schemas"]["Username"];
|
|
221
221
|
};
|
|
222
222
|
cookie?: never;
|
|
223
223
|
};
|
|
224
224
|
requestBody?: never;
|
|
225
225
|
responses: {
|
|
226
|
-
/**
|
|
226
|
+
/**
|
|
227
|
+
* @description Public view of an account, returned when looking up someone other than the
|
|
228
|
+
* authenticated caller. Carries only the fields safe to share with a
|
|
229
|
+
* workspace peer; private details (email, account flags) are omitted
|
|
230
|
+
* and remain available solely through the caller's own `/account/` view.
|
|
231
|
+
*/
|
|
227
232
|
200: {
|
|
228
233
|
headers: {
|
|
229
234
|
[name: string]: unknown;
|
|
230
235
|
};
|
|
231
236
|
content: {
|
|
232
|
-
"application/json": components["schemas"]["
|
|
237
|
+
"application/json": components["schemas"]["PublicAccount"];
|
|
233
238
|
};
|
|
234
239
|
};
|
|
235
240
|
/**
|
|
@@ -830,7 +835,7 @@ interface paths {
|
|
|
830
835
|
patch?: never;
|
|
831
836
|
trace?: never;
|
|
832
837
|
};
|
|
833
|
-
"/workspaces/{
|
|
838
|
+
"/workspaces/{workspaceSlug}/": {
|
|
834
839
|
parameters: {
|
|
835
840
|
query?: never;
|
|
836
841
|
header?: never;
|
|
@@ -846,8 +851,8 @@ interface paths {
|
|
|
846
851
|
query?: never;
|
|
847
852
|
header?: never;
|
|
848
853
|
path: {
|
|
849
|
-
/** @description
|
|
850
|
-
|
|
854
|
+
/** @description URL-safe workspace identifier. */
|
|
855
|
+
workspaceSlug: string;
|
|
851
856
|
};
|
|
852
857
|
cookie?: never;
|
|
853
858
|
};
|
|
@@ -920,8 +925,8 @@ interface paths {
|
|
|
920
925
|
query?: never;
|
|
921
926
|
header?: never;
|
|
922
927
|
path: {
|
|
923
|
-
/** @description
|
|
924
|
-
|
|
928
|
+
/** @description URL-safe workspace identifier. */
|
|
929
|
+
workspaceSlug: string;
|
|
925
930
|
};
|
|
926
931
|
cookie?: never;
|
|
927
932
|
};
|
|
@@ -992,15 +997,16 @@ interface paths {
|
|
|
992
997
|
query?: never;
|
|
993
998
|
header?: never;
|
|
994
999
|
path: {
|
|
995
|
-
/** @description
|
|
996
|
-
|
|
1000
|
+
/** @description URL-safe workspace identifier. */
|
|
1001
|
+
workspaceSlug: string;
|
|
997
1002
|
};
|
|
998
1003
|
cookie?: never;
|
|
999
1004
|
};
|
|
1000
1005
|
/**
|
|
1001
1006
|
* @description Request payload to update an existing workspace.
|
|
1002
1007
|
*
|
|
1003
|
-
* All fields are optional; only provided fields will be updated.
|
|
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.
|
|
1004
1010
|
*/
|
|
1005
1011
|
requestBody: {
|
|
1006
1012
|
content: {
|
|
@@ -1084,7 +1090,7 @@ interface paths {
|
|
|
1084
1090
|
};
|
|
1085
1091
|
trace?: never;
|
|
1086
1092
|
};
|
|
1087
|
-
"/workspaces/{
|
|
1093
|
+
"/workspaces/{workspaceSlug}/notifications/": {
|
|
1088
1094
|
parameters: {
|
|
1089
1095
|
query?: never;
|
|
1090
1096
|
header?: never;
|
|
@@ -1100,8 +1106,8 @@ interface paths {
|
|
|
1100
1106
|
query?: never;
|
|
1101
1107
|
header?: never;
|
|
1102
1108
|
path: {
|
|
1103
|
-
/** @description
|
|
1104
|
-
|
|
1109
|
+
/** @description URL-safe workspace identifier. */
|
|
1110
|
+
workspaceSlug: string;
|
|
1105
1111
|
};
|
|
1106
1112
|
cookie?: never;
|
|
1107
1113
|
};
|
|
@@ -1162,8 +1168,8 @@ interface paths {
|
|
|
1162
1168
|
query?: never;
|
|
1163
1169
|
header?: never;
|
|
1164
1170
|
path: {
|
|
1165
|
-
/** @description
|
|
1166
|
-
|
|
1171
|
+
/** @description URL-safe workspace identifier. */
|
|
1172
|
+
workspaceSlug: string;
|
|
1167
1173
|
};
|
|
1168
1174
|
cookie?: never;
|
|
1169
1175
|
};
|
|
@@ -1250,7 +1256,7 @@ interface paths {
|
|
|
1250
1256
|
};
|
|
1251
1257
|
trace?: never;
|
|
1252
1258
|
};
|
|
1253
|
-
"/workspaces/{
|
|
1259
|
+
"/workspaces/{workspaceSlug}/activities/": {
|
|
1254
1260
|
parameters: {
|
|
1255
1261
|
query?: never;
|
|
1256
1262
|
header?: never;
|
|
@@ -1274,8 +1280,8 @@ interface paths {
|
|
|
1274
1280
|
};
|
|
1275
1281
|
header?: never;
|
|
1276
1282
|
path: {
|
|
1277
|
-
/** @description
|
|
1278
|
-
|
|
1283
|
+
/** @description URL-safe workspace identifier. */
|
|
1284
|
+
workspaceSlug: string;
|
|
1279
1285
|
};
|
|
1280
1286
|
cookie?: never;
|
|
1281
1287
|
};
|
|
@@ -1336,7 +1342,7 @@ interface paths {
|
|
|
1336
1342
|
patch?: never;
|
|
1337
1343
|
trace?: never;
|
|
1338
1344
|
};
|
|
1339
|
-
"/workspaces/{
|
|
1345
|
+
"/workspaces/{workspaceSlug}/connections/": {
|
|
1340
1346
|
parameters: {
|
|
1341
1347
|
query?: never;
|
|
1342
1348
|
header?: never;
|
|
@@ -1362,8 +1368,8 @@ interface paths {
|
|
|
1362
1368
|
};
|
|
1363
1369
|
header?: never;
|
|
1364
1370
|
path: {
|
|
1365
|
-
/** @description
|
|
1366
|
-
|
|
1371
|
+
/** @description URL-safe workspace identifier. */
|
|
1372
|
+
workspaceSlug: string;
|
|
1367
1373
|
};
|
|
1368
1374
|
cookie?: never;
|
|
1369
1375
|
};
|
|
@@ -1426,8 +1432,8 @@ interface paths {
|
|
|
1426
1432
|
query?: never;
|
|
1427
1433
|
header?: never;
|
|
1428
1434
|
path: {
|
|
1429
|
-
/** @description
|
|
1430
|
-
|
|
1435
|
+
/** @description URL-safe workspace identifier. */
|
|
1436
|
+
workspaceSlug: string;
|
|
1431
1437
|
};
|
|
1432
1438
|
cookie?: never;
|
|
1433
1439
|
};
|
|
@@ -1523,7 +1529,7 @@ interface paths {
|
|
|
1523
1529
|
patch?: never;
|
|
1524
1530
|
trace?: never;
|
|
1525
1531
|
};
|
|
1526
|
-
"/connections/{connectionId}/": {
|
|
1532
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/": {
|
|
1527
1533
|
parameters: {
|
|
1528
1534
|
query?: never;
|
|
1529
1535
|
header?: never;
|
|
@@ -1539,8 +1545,10 @@ interface paths {
|
|
|
1539
1545
|
query?: never;
|
|
1540
1546
|
header?: never;
|
|
1541
1547
|
path: {
|
|
1542
|
-
/** @description
|
|
1543
|
-
|
|
1548
|
+
/** @description URL-safe workspace identifier. */
|
|
1549
|
+
workspaceSlug: string;
|
|
1550
|
+
/** @description Opaque identifier of the connection. */
|
|
1551
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
1544
1552
|
};
|
|
1545
1553
|
cookie?: never;
|
|
1546
1554
|
};
|
|
@@ -1616,8 +1624,10 @@ interface paths {
|
|
|
1616
1624
|
query?: never;
|
|
1617
1625
|
header?: never;
|
|
1618
1626
|
path: {
|
|
1619
|
-
/** @description
|
|
1620
|
-
|
|
1627
|
+
/** @description URL-safe workspace identifier. */
|
|
1628
|
+
workspaceSlug: string;
|
|
1629
|
+
/** @description Opaque identifier of the connection. */
|
|
1630
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
1621
1631
|
};
|
|
1622
1632
|
cookie?: never;
|
|
1623
1633
|
};
|
|
@@ -1639,462 +1649,7 @@ interface paths {
|
|
|
1639
1649
|
[name: string]: unknown;
|
|
1640
1650
|
};
|
|
1641
1651
|
content: {
|
|
1642
|
-
"application/json": components["schemas"]["Connection"];
|
|
1643
|
-
};
|
|
1644
|
-
};
|
|
1645
|
-
/**
|
|
1646
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1647
|
-
*
|
|
1648
|
-
* This struct contains all the information needed to serialize an error
|
|
1649
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1650
|
-
* information, and user-friendly messages.
|
|
1651
|
-
*/
|
|
1652
|
-
400: {
|
|
1653
|
-
headers: {
|
|
1654
|
-
[name: string]: unknown;
|
|
1655
|
-
};
|
|
1656
|
-
content: {
|
|
1657
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1658
|
-
};
|
|
1659
|
-
};
|
|
1660
|
-
/**
|
|
1661
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1662
|
-
*
|
|
1663
|
-
* This struct contains all the information needed to serialize an error
|
|
1664
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1665
|
-
* information, and user-friendly messages.
|
|
1666
|
-
*/
|
|
1667
|
-
401: {
|
|
1668
|
-
headers: {
|
|
1669
|
-
[name: string]: unknown;
|
|
1670
|
-
};
|
|
1671
|
-
content: {
|
|
1672
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1673
|
-
};
|
|
1674
|
-
};
|
|
1675
|
-
/**
|
|
1676
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1677
|
-
*
|
|
1678
|
-
* This struct contains all the information needed to serialize an error
|
|
1679
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1680
|
-
* information, and user-friendly messages.
|
|
1681
|
-
*/
|
|
1682
|
-
403: {
|
|
1683
|
-
headers: {
|
|
1684
|
-
[name: string]: unknown;
|
|
1685
|
-
};
|
|
1686
|
-
content: {
|
|
1687
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1688
|
-
};
|
|
1689
|
-
};
|
|
1690
|
-
/**
|
|
1691
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1692
|
-
*
|
|
1693
|
-
* This struct contains all the information needed to serialize an error
|
|
1694
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1695
|
-
* information, and user-friendly messages.
|
|
1696
|
-
*/
|
|
1697
|
-
404: {
|
|
1698
|
-
headers: {
|
|
1699
|
-
[name: string]: unknown;
|
|
1700
|
-
};
|
|
1701
|
-
content: {
|
|
1702
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1703
|
-
};
|
|
1704
|
-
};
|
|
1705
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
1706
|
-
415: {
|
|
1707
|
-
headers: {
|
|
1708
|
-
[name: string]: unknown;
|
|
1709
|
-
};
|
|
1710
|
-
content: {
|
|
1711
|
-
"text/plain": string;
|
|
1712
|
-
};
|
|
1713
|
-
};
|
|
1714
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
1715
|
-
422: {
|
|
1716
|
-
headers: {
|
|
1717
|
-
[name: string]: unknown;
|
|
1718
|
-
};
|
|
1719
|
-
content: {
|
|
1720
|
-
"text/plain": string;
|
|
1721
|
-
};
|
|
1722
|
-
};
|
|
1723
|
-
};
|
|
1724
|
-
};
|
|
1725
|
-
post?: never;
|
|
1726
|
-
/**
|
|
1727
|
-
* Delete connection
|
|
1728
|
-
* @description Soft-deletes the connection from the workspace.
|
|
1729
|
-
*/
|
|
1730
|
-
delete: {
|
|
1731
|
-
parameters: {
|
|
1732
|
-
query?: never;
|
|
1733
|
-
header?: never;
|
|
1734
|
-
path: {
|
|
1735
|
-
/** @description Unique identifier of the connection. */
|
|
1736
|
-
connectionId: string;
|
|
1737
|
-
};
|
|
1738
|
-
cookie?: never;
|
|
1739
|
-
};
|
|
1740
|
-
requestBody?: never;
|
|
1741
|
-
responses: {
|
|
1742
|
-
/** @description no content */
|
|
1743
|
-
204: {
|
|
1744
|
-
headers: {
|
|
1745
|
-
[name: string]: unknown;
|
|
1746
|
-
};
|
|
1747
|
-
content?: never;
|
|
1748
|
-
};
|
|
1749
|
-
/**
|
|
1750
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1751
|
-
*
|
|
1752
|
-
* This struct contains all the information needed to serialize an error
|
|
1753
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1754
|
-
* information, and user-friendly messages.
|
|
1755
|
-
*/
|
|
1756
|
-
401: {
|
|
1757
|
-
headers: {
|
|
1758
|
-
[name: string]: unknown;
|
|
1759
|
-
};
|
|
1760
|
-
content: {
|
|
1761
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1762
|
-
};
|
|
1763
|
-
};
|
|
1764
|
-
/**
|
|
1765
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1766
|
-
*
|
|
1767
|
-
* This struct contains all the information needed to serialize an error
|
|
1768
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1769
|
-
* information, and user-friendly messages.
|
|
1770
|
-
*/
|
|
1771
|
-
403: {
|
|
1772
|
-
headers: {
|
|
1773
|
-
[name: string]: unknown;
|
|
1774
|
-
};
|
|
1775
|
-
content: {
|
|
1776
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1777
|
-
};
|
|
1778
|
-
};
|
|
1779
|
-
/**
|
|
1780
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1781
|
-
*
|
|
1782
|
-
* This struct contains all the information needed to serialize an error
|
|
1783
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1784
|
-
* information, and user-friendly messages.
|
|
1785
|
-
*/
|
|
1786
|
-
404: {
|
|
1787
|
-
headers: {
|
|
1788
|
-
[name: string]: unknown;
|
|
1789
|
-
};
|
|
1790
|
-
content: {
|
|
1791
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1792
|
-
};
|
|
1793
|
-
};
|
|
1794
|
-
};
|
|
1795
|
-
};
|
|
1796
|
-
options?: never;
|
|
1797
|
-
head?: never;
|
|
1798
|
-
patch?: never;
|
|
1799
|
-
trace?: never;
|
|
1800
|
-
};
|
|
1801
|
-
"/workspaces/{workspaceId}/contexts/": {
|
|
1802
|
-
parameters: {
|
|
1803
|
-
query?: never;
|
|
1804
|
-
header?: never;
|
|
1805
|
-
path?: never;
|
|
1806
|
-
cookie?: never;
|
|
1807
|
-
};
|
|
1808
|
-
/**
|
|
1809
|
-
* List contexts
|
|
1810
|
-
* @description Returns all contexts for the workspace.
|
|
1811
|
-
*/
|
|
1812
|
-
get: {
|
|
1813
|
-
parameters: {
|
|
1814
|
-
query?: {
|
|
1815
|
-
/**
|
|
1816
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
1817
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
1818
|
-
*/
|
|
1819
|
-
after?: string;
|
|
1820
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1821
|
-
limit?: number;
|
|
1822
|
-
};
|
|
1823
|
-
header?: never;
|
|
1824
|
-
path: {
|
|
1825
|
-
/** @description Unique identifier of the workspace. */
|
|
1826
|
-
workspaceId: string;
|
|
1827
|
-
};
|
|
1828
|
-
cookie?: never;
|
|
1829
|
-
};
|
|
1830
|
-
requestBody?: never;
|
|
1831
|
-
responses: {
|
|
1832
|
-
/**
|
|
1833
|
-
* @description Generic paginated response wrapper.
|
|
1834
|
-
*
|
|
1835
|
-
* Provides a consistent structure for all paginated API responses with
|
|
1836
|
-
* cursor-based pagination support. When `next_cursor` is present, there
|
|
1837
|
-
* are more items to fetch.
|
|
1838
|
-
*/
|
|
1839
|
-
200: {
|
|
1840
|
-
headers: {
|
|
1841
|
-
[name: string]: unknown;
|
|
1842
|
-
};
|
|
1843
|
-
content: {
|
|
1844
|
-
"application/json": components["schemas"]["ContextsPage"];
|
|
1845
|
-
};
|
|
1846
|
-
};
|
|
1847
|
-
/**
|
|
1848
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1849
|
-
*
|
|
1850
|
-
* This struct contains all the information needed to serialize an error
|
|
1851
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1852
|
-
* information, and user-friendly messages.
|
|
1853
|
-
*/
|
|
1854
|
-
401: {
|
|
1855
|
-
headers: {
|
|
1856
|
-
[name: string]: unknown;
|
|
1857
|
-
};
|
|
1858
|
-
content: {
|
|
1859
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1860
|
-
};
|
|
1861
|
-
};
|
|
1862
|
-
/**
|
|
1863
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1864
|
-
*
|
|
1865
|
-
* This struct contains all the information needed to serialize an error
|
|
1866
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1867
|
-
* information, and user-friendly messages.
|
|
1868
|
-
*/
|
|
1869
|
-
403: {
|
|
1870
|
-
headers: {
|
|
1871
|
-
[name: string]: unknown;
|
|
1872
|
-
};
|
|
1873
|
-
content: {
|
|
1874
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1875
|
-
};
|
|
1876
|
-
};
|
|
1877
|
-
};
|
|
1878
|
-
};
|
|
1879
|
-
put?: never;
|
|
1880
|
-
/**
|
|
1881
|
-
* Create context
|
|
1882
|
-
* @description Creates a structured reference-data context for the workspace.
|
|
1883
|
-
*/
|
|
1884
|
-
post: {
|
|
1885
|
-
parameters: {
|
|
1886
|
-
query?: never;
|
|
1887
|
-
header?: never;
|
|
1888
|
-
path: {
|
|
1889
|
-
/** @description Unique identifier of the workspace. */
|
|
1890
|
-
workspaceId: string;
|
|
1891
|
-
};
|
|
1892
|
-
cookie?: never;
|
|
1893
|
-
};
|
|
1894
|
-
/**
|
|
1895
|
-
* @description Request payload for creating a new workspace context.
|
|
1896
|
-
*
|
|
1897
|
-
* The `definition` is a structured context the redaction engine consumes;
|
|
1898
|
-
* its `name`, `description`, and `version` drive the stored columns unless
|
|
1899
|
-
* overridden here.
|
|
1900
|
-
*/
|
|
1901
|
-
requestBody: {
|
|
1902
|
-
content: {
|
|
1903
|
-
"application/json": components["schemas"]["CreateContext"];
|
|
1904
|
-
};
|
|
1905
|
-
};
|
|
1906
|
-
responses: {
|
|
1907
|
-
/** @description Response type for a workspace context. */
|
|
1908
|
-
201: {
|
|
1909
|
-
headers: {
|
|
1910
|
-
[name: string]: unknown;
|
|
1911
|
-
};
|
|
1912
|
-
content: {
|
|
1913
|
-
"application/json": components["schemas"]["Context2"];
|
|
1914
|
-
};
|
|
1915
|
-
};
|
|
1916
|
-
/**
|
|
1917
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1918
|
-
*
|
|
1919
|
-
* This struct contains all the information needed to serialize an error
|
|
1920
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1921
|
-
* information, and user-friendly messages.
|
|
1922
|
-
*/
|
|
1923
|
-
400: {
|
|
1924
|
-
headers: {
|
|
1925
|
-
[name: string]: unknown;
|
|
1926
|
-
};
|
|
1927
|
-
content: {
|
|
1928
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1929
|
-
};
|
|
1930
|
-
};
|
|
1931
|
-
/**
|
|
1932
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1933
|
-
*
|
|
1934
|
-
* This struct contains all the information needed to serialize an error
|
|
1935
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1936
|
-
* information, and user-friendly messages.
|
|
1937
|
-
*/
|
|
1938
|
-
401: {
|
|
1939
|
-
headers: {
|
|
1940
|
-
[name: string]: unknown;
|
|
1941
|
-
};
|
|
1942
|
-
content: {
|
|
1943
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1944
|
-
};
|
|
1945
|
-
};
|
|
1946
|
-
/**
|
|
1947
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1948
|
-
*
|
|
1949
|
-
* This struct contains all the information needed to serialize an error
|
|
1950
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1951
|
-
* information, and user-friendly messages.
|
|
1952
|
-
*/
|
|
1953
|
-
403: {
|
|
1954
|
-
headers: {
|
|
1955
|
-
[name: string]: unknown;
|
|
1956
|
-
};
|
|
1957
|
-
content: {
|
|
1958
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1959
|
-
};
|
|
1960
|
-
};
|
|
1961
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
1962
|
-
415: {
|
|
1963
|
-
headers: {
|
|
1964
|
-
[name: string]: unknown;
|
|
1965
|
-
};
|
|
1966
|
-
content: {
|
|
1967
|
-
"text/plain": string;
|
|
1968
|
-
};
|
|
1969
|
-
};
|
|
1970
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
1971
|
-
422: {
|
|
1972
|
-
headers: {
|
|
1973
|
-
[name: string]: unknown;
|
|
1974
|
-
};
|
|
1975
|
-
content: {
|
|
1976
|
-
"text/plain": string;
|
|
1977
|
-
};
|
|
1978
|
-
};
|
|
1979
|
-
};
|
|
1980
|
-
};
|
|
1981
|
-
delete?: never;
|
|
1982
|
-
options?: never;
|
|
1983
|
-
head?: never;
|
|
1984
|
-
patch?: never;
|
|
1985
|
-
trace?: never;
|
|
1986
|
-
};
|
|
1987
|
-
"/contexts/{contextId}/": {
|
|
1988
|
-
parameters: {
|
|
1989
|
-
query?: never;
|
|
1990
|
-
header?: never;
|
|
1991
|
-
path?: never;
|
|
1992
|
-
cookie?: never;
|
|
1993
|
-
};
|
|
1994
|
-
/**
|
|
1995
|
-
* Get context
|
|
1996
|
-
* @description Returns a single context.
|
|
1997
|
-
*/
|
|
1998
|
-
get: {
|
|
1999
|
-
parameters: {
|
|
2000
|
-
query?: never;
|
|
2001
|
-
header?: never;
|
|
2002
|
-
path: {
|
|
2003
|
-
/** @description Unique identifier of the context. */
|
|
2004
|
-
contextId: string;
|
|
2005
|
-
};
|
|
2006
|
-
cookie?: never;
|
|
2007
|
-
};
|
|
2008
|
-
requestBody?: never;
|
|
2009
|
-
responses: {
|
|
2010
|
-
/** @description Response type for a workspace context. */
|
|
2011
|
-
200: {
|
|
2012
|
-
headers: {
|
|
2013
|
-
[name: string]: unknown;
|
|
2014
|
-
};
|
|
2015
|
-
content: {
|
|
2016
|
-
"application/json": components["schemas"]["Context2"];
|
|
2017
|
-
};
|
|
2018
|
-
};
|
|
2019
|
-
/**
|
|
2020
|
-
* @description HTTP error response representation with security-conscious design.
|
|
2021
|
-
*
|
|
2022
|
-
* This struct contains all the information needed to serialize an error
|
|
2023
|
-
* response, including the error name, message, HTTP status code, resource
|
|
2024
|
-
* information, and user-friendly messages.
|
|
2025
|
-
*/
|
|
2026
|
-
401: {
|
|
2027
|
-
headers: {
|
|
2028
|
-
[name: string]: unknown;
|
|
2029
|
-
};
|
|
2030
|
-
content: {
|
|
2031
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
2032
|
-
};
|
|
2033
|
-
};
|
|
2034
|
-
/**
|
|
2035
|
-
* @description HTTP error response representation with security-conscious design.
|
|
2036
|
-
*
|
|
2037
|
-
* This struct contains all the information needed to serialize an error
|
|
2038
|
-
* response, including the error name, message, HTTP status code, resource
|
|
2039
|
-
* information, and user-friendly messages.
|
|
2040
|
-
*/
|
|
2041
|
-
403: {
|
|
2042
|
-
headers: {
|
|
2043
|
-
[name: string]: unknown;
|
|
2044
|
-
};
|
|
2045
|
-
content: {
|
|
2046
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
2047
|
-
};
|
|
2048
|
-
};
|
|
2049
|
-
/**
|
|
2050
|
-
* @description HTTP error response representation with security-conscious design.
|
|
2051
|
-
*
|
|
2052
|
-
* This struct contains all the information needed to serialize an error
|
|
2053
|
-
* response, including the error name, message, HTTP status code, resource
|
|
2054
|
-
* information, and user-friendly messages.
|
|
2055
|
-
*/
|
|
2056
|
-
404: {
|
|
2057
|
-
headers: {
|
|
2058
|
-
[name: string]: unknown;
|
|
2059
|
-
};
|
|
2060
|
-
content: {
|
|
2061
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
2062
|
-
};
|
|
2063
|
-
};
|
|
2064
|
-
};
|
|
2065
|
-
};
|
|
2066
|
-
/**
|
|
2067
|
-
* Update context
|
|
2068
|
-
* @description Updates context fields. Replacing the definition replaces the whole body.
|
|
2069
|
-
*/
|
|
2070
|
-
put: {
|
|
2071
|
-
parameters: {
|
|
2072
|
-
query?: never;
|
|
2073
|
-
header?: never;
|
|
2074
|
-
path: {
|
|
2075
|
-
/** @description Unique identifier of the context. */
|
|
2076
|
-
contextId: string;
|
|
2077
|
-
};
|
|
2078
|
-
cookie?: never;
|
|
2079
|
-
};
|
|
2080
|
-
/**
|
|
2081
|
-
* @description Request payload for updating an existing workspace context.
|
|
2082
|
-
*
|
|
2083
|
-
* Replacing the `definition` replaces the whole context body.
|
|
2084
|
-
*/
|
|
2085
|
-
requestBody: {
|
|
2086
|
-
content: {
|
|
2087
|
-
"application/json": components["schemas"]["UpdateContext"];
|
|
2088
|
-
};
|
|
2089
|
-
};
|
|
2090
|
-
responses: {
|
|
2091
|
-
/** @description Response type for a workspace context. */
|
|
2092
|
-
200: {
|
|
2093
|
-
headers: {
|
|
2094
|
-
[name: string]: unknown;
|
|
2095
|
-
};
|
|
2096
|
-
content: {
|
|
2097
|
-
"application/json": components["schemas"]["Context2"];
|
|
1652
|
+
"application/json": components["schemas"]["Connection"];
|
|
2098
1653
|
};
|
|
2099
1654
|
};
|
|
2100
1655
|
/**
|
|
@@ -2179,16 +1734,18 @@ interface paths {
|
|
|
2179
1734
|
};
|
|
2180
1735
|
post?: never;
|
|
2181
1736
|
/**
|
|
2182
|
-
* Delete
|
|
2183
|
-
* @description Soft-deletes the
|
|
1737
|
+
* Delete connection
|
|
1738
|
+
* @description Soft-deletes the connection from the workspace.
|
|
2184
1739
|
*/
|
|
2185
1740
|
delete: {
|
|
2186
1741
|
parameters: {
|
|
2187
1742
|
query?: never;
|
|
2188
1743
|
header?: never;
|
|
2189
1744
|
path: {
|
|
2190
|
-
/** @description
|
|
2191
|
-
|
|
1745
|
+
/** @description URL-safe workspace identifier. */
|
|
1746
|
+
workspaceSlug: string;
|
|
1747
|
+
/** @description Opaque identifier of the connection. */
|
|
1748
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
2192
1749
|
};
|
|
2193
1750
|
cookie?: never;
|
|
2194
1751
|
};
|
|
@@ -2253,7 +1810,7 @@ interface paths {
|
|
|
2253
1810
|
patch?: never;
|
|
2254
1811
|
trace?: never;
|
|
2255
1812
|
};
|
|
2256
|
-
"/workspaces/{
|
|
1813
|
+
"/workspaces/{workspaceSlug}/invites/": {
|
|
2257
1814
|
parameters: {
|
|
2258
1815
|
query?: never;
|
|
2259
1816
|
header?: never;
|
|
@@ -2283,8 +1840,8 @@ interface paths {
|
|
|
2283
1840
|
};
|
|
2284
1841
|
header?: never;
|
|
2285
1842
|
path: {
|
|
2286
|
-
/** @description
|
|
2287
|
-
|
|
1843
|
+
/** @description URL-safe workspace identifier. */
|
|
1844
|
+
workspaceSlug: string;
|
|
2288
1845
|
};
|
|
2289
1846
|
cookie?: never;
|
|
2290
1847
|
};
|
|
@@ -2340,15 +1897,15 @@ interface paths {
|
|
|
2340
1897
|
put?: never;
|
|
2341
1898
|
/**
|
|
2342
1899
|
* Send invitation
|
|
2343
|
-
* @description
|
|
1900
|
+
* @description Invites an existing platform user to the workspace and delivers an in-app notification. No email is sent by this server. The response is identical whether or not the address belongs to a known account, so it cannot be used to determine whether an account exists.
|
|
2344
1901
|
*/
|
|
2345
1902
|
post: {
|
|
2346
1903
|
parameters: {
|
|
2347
1904
|
query?: never;
|
|
2348
1905
|
header?: never;
|
|
2349
1906
|
path: {
|
|
2350
|
-
/** @description
|
|
2351
|
-
|
|
1907
|
+
/** @description URL-safe workspace identifier. */
|
|
1908
|
+
workspaceSlug: string;
|
|
2352
1909
|
};
|
|
2353
1910
|
cookie?: never;
|
|
2354
1911
|
};
|
|
@@ -2360,18 +1917,18 @@ interface paths {
|
|
|
2360
1917
|
};
|
|
2361
1918
|
responses: {
|
|
2362
1919
|
/**
|
|
2363
|
-
* @description
|
|
1920
|
+
* @description Acknowledgement returned after sending a workspace invitation.
|
|
2364
1921
|
*
|
|
2365
|
-
*
|
|
2366
|
-
*
|
|
2367
|
-
*
|
|
1922
|
+
* The response is deliberately uniform: it carries no invite identifier or
|
|
1923
|
+
* status, so it is identical whether or not the address belonged to a known
|
|
1924
|
+
* account and cannot be used to probe for account existence.
|
|
2368
1925
|
*/
|
|
2369
|
-
|
|
1926
|
+
200: {
|
|
2370
1927
|
headers: {
|
|
2371
1928
|
[name: string]: unknown;
|
|
2372
1929
|
};
|
|
2373
1930
|
content: {
|
|
2374
|
-
"application/json": components["schemas"]["
|
|
1931
|
+
"application/json": components["schemas"]["InviteSent"];
|
|
2375
1932
|
};
|
|
2376
1933
|
};
|
|
2377
1934
|
/**
|
|
@@ -2460,7 +2017,7 @@ interface paths {
|
|
|
2460
2017
|
patch?: never;
|
|
2461
2018
|
trace?: never;
|
|
2462
2019
|
};
|
|
2463
|
-
"/workspaces/{
|
|
2020
|
+
"/workspaces/{workspaceSlug}/invites/code/": {
|
|
2464
2021
|
parameters: {
|
|
2465
2022
|
query?: never;
|
|
2466
2023
|
header?: never;
|
|
@@ -2478,8 +2035,8 @@ interface paths {
|
|
|
2478
2035
|
query?: never;
|
|
2479
2036
|
header?: never;
|
|
2480
2037
|
path: {
|
|
2481
|
-
/** @description
|
|
2482
|
-
|
|
2038
|
+
/** @description URL-safe workspace identifier. */
|
|
2039
|
+
workspaceSlug: string;
|
|
2483
2040
|
};
|
|
2484
2041
|
cookie?: never;
|
|
2485
2042
|
};
|
|
@@ -2570,7 +2127,7 @@ interface paths {
|
|
|
2570
2127
|
patch?: never;
|
|
2571
2128
|
trace?: never;
|
|
2572
2129
|
};
|
|
2573
|
-
"/invites/{inviteId}/": {
|
|
2130
|
+
"/workspaces/{workspaceSlug}/invites/{inviteId}/": {
|
|
2574
2131
|
parameters: {
|
|
2575
2132
|
query?: never;
|
|
2576
2133
|
header?: never;
|
|
@@ -2588,6 +2145,8 @@ interface paths {
|
|
|
2588
2145
|
query?: never;
|
|
2589
2146
|
header?: never;
|
|
2590
2147
|
path: {
|
|
2148
|
+
/** @description URL-safe workspace identifier. */
|
|
2149
|
+
workspaceSlug: string;
|
|
2591
2150
|
/** @description Unique identifier of the invite. */
|
|
2592
2151
|
inviteId: string;
|
|
2593
2152
|
};
|
|
@@ -2689,6 +2248,8 @@ interface paths {
|
|
|
2689
2248
|
query?: never;
|
|
2690
2249
|
header?: never;
|
|
2691
2250
|
path: {
|
|
2251
|
+
/** @description URL-safe workspace identifier. */
|
|
2252
|
+
workspaceSlug: string;
|
|
2692
2253
|
/** @description Unique identifier of the invite. */
|
|
2693
2254
|
inviteId: string;
|
|
2694
2255
|
};
|
|
@@ -2948,7 +2509,7 @@ interface paths {
|
|
|
2948
2509
|
patch?: never;
|
|
2949
2510
|
trace?: never;
|
|
2950
2511
|
};
|
|
2951
|
-
"/workspaces/{
|
|
2512
|
+
"/workspaces/{workspaceSlug}/members/": {
|
|
2952
2513
|
parameters: {
|
|
2953
2514
|
query?: never;
|
|
2954
2515
|
header?: never;
|
|
@@ -2980,8 +2541,8 @@ interface paths {
|
|
|
2980
2541
|
};
|
|
2981
2542
|
header?: never;
|
|
2982
2543
|
path: {
|
|
2983
|
-
/** @description
|
|
2984
|
-
|
|
2544
|
+
/** @description URL-safe workspace identifier. */
|
|
2545
|
+
workspaceSlug: string;
|
|
2985
2546
|
};
|
|
2986
2547
|
cookie?: never;
|
|
2987
2548
|
};
|
|
@@ -3057,7 +2618,7 @@ interface paths {
|
|
|
3057
2618
|
patch?: never;
|
|
3058
2619
|
trace?: never;
|
|
3059
2620
|
};
|
|
3060
|
-
"/workspaces/{
|
|
2621
|
+
"/workspaces/{workspaceSlug}/members/leave/": {
|
|
3061
2622
|
parameters: {
|
|
3062
2623
|
query?: never;
|
|
3063
2624
|
header?: never;
|
|
@@ -3075,8 +2636,8 @@ interface paths {
|
|
|
3075
2636
|
query?: never;
|
|
3076
2637
|
header?: never;
|
|
3077
2638
|
path: {
|
|
3078
|
-
/** @description
|
|
3079
|
-
|
|
2639
|
+
/** @description URL-safe workspace identifier. */
|
|
2640
|
+
workspaceSlug: string;
|
|
3080
2641
|
};
|
|
3081
2642
|
cookie?: never;
|
|
3082
2643
|
};
|
|
@@ -3142,7 +2703,7 @@ interface paths {
|
|
|
3142
2703
|
patch?: never;
|
|
3143
2704
|
trace?: never;
|
|
3144
2705
|
};
|
|
3145
|
-
"/workspaces/{
|
|
2706
|
+
"/workspaces/{workspaceSlug}/members/{username}/": {
|
|
3146
2707
|
parameters: {
|
|
3147
2708
|
query?: never;
|
|
3148
2709
|
header?: never;
|
|
@@ -3158,10 +2719,10 @@ interface paths {
|
|
|
3158
2719
|
query?: never;
|
|
3159
2720
|
header?: never;
|
|
3160
2721
|
path: {
|
|
3161
|
-
/** @description
|
|
3162
|
-
|
|
3163
|
-
/** @description
|
|
3164
|
-
|
|
2722
|
+
/** @description URL-safe workspace identifier. */
|
|
2723
|
+
workspaceSlug: string;
|
|
2724
|
+
/** @description Public handle of the member's account. */
|
|
2725
|
+
username: components["schemas"]["Username"];
|
|
3165
2726
|
};
|
|
3166
2727
|
cookie?: never;
|
|
3167
2728
|
};
|
|
@@ -3234,10 +2795,10 @@ interface paths {
|
|
|
3234
2795
|
query?: never;
|
|
3235
2796
|
header?: never;
|
|
3236
2797
|
path: {
|
|
3237
|
-
/** @description
|
|
3238
|
-
|
|
3239
|
-
/** @description
|
|
3240
|
-
|
|
2798
|
+
/** @description URL-safe workspace identifier. */
|
|
2799
|
+
workspaceSlug: string;
|
|
2800
|
+
/** @description Public handle of the member's account. */
|
|
2801
|
+
username: components["schemas"]["Username"];
|
|
3241
2802
|
};
|
|
3242
2803
|
cookie?: never;
|
|
3243
2804
|
};
|
|
@@ -3323,10 +2884,10 @@ interface paths {
|
|
|
3323
2884
|
query?: never;
|
|
3324
2885
|
header?: never;
|
|
3325
2886
|
path: {
|
|
3326
|
-
/** @description
|
|
3327
|
-
|
|
3328
|
-
/** @description
|
|
3329
|
-
|
|
2887
|
+
/** @description URL-safe workspace identifier. */
|
|
2888
|
+
workspaceSlug: string;
|
|
2889
|
+
/** @description Public handle of the member's account. */
|
|
2890
|
+
username: components["schemas"]["Username"];
|
|
3330
2891
|
};
|
|
3331
2892
|
cookie?: never;
|
|
3332
2893
|
};
|
|
@@ -3428,7 +2989,7 @@ interface paths {
|
|
|
3428
2989
|
};
|
|
3429
2990
|
trace?: never;
|
|
3430
2991
|
};
|
|
3431
|
-
"/workspaces/{
|
|
2992
|
+
"/workspaces/{workspaceSlug}/webhooks/": {
|
|
3432
2993
|
parameters: {
|
|
3433
2994
|
query?: never;
|
|
3434
2995
|
header?: never;
|
|
@@ -3452,8 +3013,8 @@ interface paths {
|
|
|
3452
3013
|
};
|
|
3453
3014
|
header?: never;
|
|
3454
3015
|
path: {
|
|
3455
|
-
/** @description
|
|
3456
|
-
|
|
3016
|
+
/** @description URL-safe workspace identifier. */
|
|
3017
|
+
workspaceSlug: string;
|
|
3457
3018
|
};
|
|
3458
3019
|
cookie?: never;
|
|
3459
3020
|
};
|
|
@@ -3516,8 +3077,8 @@ interface paths {
|
|
|
3516
3077
|
query?: never;
|
|
3517
3078
|
header?: never;
|
|
3518
3079
|
path: {
|
|
3519
|
-
/** @description
|
|
3520
|
-
|
|
3080
|
+
/** @description URL-safe workspace identifier. */
|
|
3081
|
+
workspaceSlug: string;
|
|
3521
3082
|
};
|
|
3522
3083
|
cookie?: never;
|
|
3523
3084
|
};
|
|
@@ -3614,7 +3175,7 @@ interface paths {
|
|
|
3614
3175
|
patch?: never;
|
|
3615
3176
|
trace?: never;
|
|
3616
3177
|
};
|
|
3617
|
-
"/webhooks/{webhookId}/": {
|
|
3178
|
+
"/workspaces/{workspaceSlug}/webhooks/{webhookId}/": {
|
|
3618
3179
|
parameters: {
|
|
3619
3180
|
query?: never;
|
|
3620
3181
|
header?: never;
|
|
@@ -3630,8 +3191,10 @@ interface paths {
|
|
|
3630
3191
|
query?: never;
|
|
3631
3192
|
header?: never;
|
|
3632
3193
|
path: {
|
|
3633
|
-
/** @description
|
|
3634
|
-
|
|
3194
|
+
/** @description URL-safe workspace identifier. */
|
|
3195
|
+
workspaceSlug: string;
|
|
3196
|
+
/** @description Opaque identifier of the webhook. */
|
|
3197
|
+
webhookId: components["schemas"]["WebhookId"];
|
|
3635
3198
|
};
|
|
3636
3199
|
cookie?: never;
|
|
3637
3200
|
};
|
|
@@ -3702,8 +3265,10 @@ interface paths {
|
|
|
3702
3265
|
query?: never;
|
|
3703
3266
|
header?: never;
|
|
3704
3267
|
path: {
|
|
3705
|
-
/** @description
|
|
3706
|
-
|
|
3268
|
+
/** @description URL-safe workspace identifier. */
|
|
3269
|
+
workspaceSlug: string;
|
|
3270
|
+
/** @description Opaque identifier of the webhook. */
|
|
3271
|
+
webhookId: components["schemas"]["WebhookId"];
|
|
3707
3272
|
};
|
|
3708
3273
|
cookie?: never;
|
|
3709
3274
|
};
|
|
@@ -3813,8 +3378,10 @@ interface paths {
|
|
|
3813
3378
|
query?: never;
|
|
3814
3379
|
header?: never;
|
|
3815
3380
|
path: {
|
|
3816
|
-
/** @description
|
|
3817
|
-
|
|
3381
|
+
/** @description URL-safe workspace identifier. */
|
|
3382
|
+
workspaceSlug: string;
|
|
3383
|
+
/** @description Opaque identifier of the webhook. */
|
|
3384
|
+
webhookId: components["schemas"]["WebhookId"];
|
|
3818
3385
|
};
|
|
3819
3386
|
cookie?: never;
|
|
3820
3387
|
};
|
|
@@ -3879,7 +3446,7 @@ interface paths {
|
|
|
3879
3446
|
patch?: never;
|
|
3880
3447
|
trace?: never;
|
|
3881
3448
|
};
|
|
3882
|
-
"/webhooks/{webhookId}/test/": {
|
|
3449
|
+
"/workspaces/{workspaceSlug}/webhooks/{webhookId}/test/": {
|
|
3883
3450
|
parameters: {
|
|
3884
3451
|
query?: never;
|
|
3885
3452
|
header?: never;
|
|
@@ -3897,8 +3464,10 @@ interface paths {
|
|
|
3897
3464
|
query?: never;
|
|
3898
3465
|
header?: never;
|
|
3899
3466
|
path: {
|
|
3900
|
-
/** @description
|
|
3901
|
-
|
|
3467
|
+
/** @description URL-safe workspace identifier. */
|
|
3468
|
+
workspaceSlug: string;
|
|
3469
|
+
/** @description Opaque identifier of the webhook. */
|
|
3470
|
+
webhookId: components["schemas"]["WebhookId"];
|
|
3902
3471
|
};
|
|
3903
3472
|
cookie?: never;
|
|
3904
3473
|
};
|
|
@@ -3998,7 +3567,7 @@ interface paths {
|
|
|
3998
3567
|
patch?: never;
|
|
3999
3568
|
trace?: never;
|
|
4000
3569
|
};
|
|
4001
|
-
"/workspaces/{
|
|
3570
|
+
"/workspaces/{workspaceSlug}/files/": {
|
|
4002
3571
|
parameters: {
|
|
4003
3572
|
query?: never;
|
|
4004
3573
|
header?: never;
|
|
@@ -4026,8 +3595,8 @@ interface paths {
|
|
|
4026
3595
|
};
|
|
4027
3596
|
header?: never;
|
|
4028
3597
|
path: {
|
|
4029
|
-
/** @description
|
|
4030
|
-
|
|
3598
|
+
/** @description URL-safe workspace identifier. */
|
|
3599
|
+
workspaceSlug: string;
|
|
4031
3600
|
};
|
|
4032
3601
|
cookie?: never;
|
|
4033
3602
|
};
|
|
@@ -4090,8 +3659,8 @@ interface paths {
|
|
|
4090
3659
|
query?: never;
|
|
4091
3660
|
header?: never;
|
|
4092
3661
|
path: {
|
|
4093
|
-
/** @description
|
|
4094
|
-
|
|
3662
|
+
/** @description URL-safe workspace identifier. */
|
|
3663
|
+
workspaceSlug: string;
|
|
4095
3664
|
};
|
|
4096
3665
|
cookie?: never;
|
|
4097
3666
|
};
|
|
@@ -4163,7 +3732,7 @@ interface paths {
|
|
|
4163
3732
|
patch?: never;
|
|
4164
3733
|
trace?: never;
|
|
4165
3734
|
};
|
|
4166
|
-
"/files/{fileId}/": {
|
|
3735
|
+
"/workspaces/{workspaceSlug}/files/{fileId}/": {
|
|
4167
3736
|
parameters: {
|
|
4168
3737
|
query?: never;
|
|
4169
3738
|
header?: never;
|
|
@@ -4179,6 +3748,8 @@ interface paths {
|
|
|
4179
3748
|
query?: never;
|
|
4180
3749
|
header?: never;
|
|
4181
3750
|
path: {
|
|
3751
|
+
/** @description URL-safe workspace identifier. */
|
|
3752
|
+
workspaceSlug: string;
|
|
4182
3753
|
/** @description Unique identifier of the file. */
|
|
4183
3754
|
fileId: string;
|
|
4184
3755
|
};
|
|
@@ -4253,6 +3824,8 @@ interface paths {
|
|
|
4253
3824
|
query?: never;
|
|
4254
3825
|
header?: never;
|
|
4255
3826
|
path: {
|
|
3827
|
+
/** @description URL-safe workspace identifier. */
|
|
3828
|
+
workspaceSlug: string;
|
|
4256
3829
|
/** @description Unique identifier of the file. */
|
|
4257
3830
|
fileId: string;
|
|
4258
3831
|
};
|
|
@@ -4318,13 +3891,15 @@ interface paths {
|
|
|
4318
3891
|
head?: never;
|
|
4319
3892
|
/**
|
|
4320
3893
|
* Update file
|
|
4321
|
-
* @description Updates file metadata such as display name or
|
|
3894
|
+
* @description Updates file metadata such as display name, tags, or metadata.
|
|
4322
3895
|
*/
|
|
4323
3896
|
patch: {
|
|
4324
3897
|
parameters: {
|
|
4325
3898
|
query?: never;
|
|
4326
3899
|
header?: never;
|
|
4327
3900
|
path: {
|
|
3901
|
+
/** @description URL-safe workspace identifier. */
|
|
3902
|
+
workspaceSlug: string;
|
|
4328
3903
|
/** @description Unique identifier of the file. */
|
|
4329
3904
|
fileId: string;
|
|
4330
3905
|
};
|
|
@@ -4428,7 +4003,7 @@ interface paths {
|
|
|
4428
4003
|
};
|
|
4429
4004
|
trace?: never;
|
|
4430
4005
|
};
|
|
4431
|
-
"/files/{fileId}/content/": {
|
|
4006
|
+
"/workspaces/{workspaceSlug}/files/{fileId}/content/": {
|
|
4432
4007
|
parameters: {
|
|
4433
4008
|
query?: never;
|
|
4434
4009
|
header?: never;
|
|
@@ -4444,6 +4019,8 @@ interface paths {
|
|
|
4444
4019
|
query?: never;
|
|
4445
4020
|
header?: never;
|
|
4446
4021
|
path: {
|
|
4022
|
+
/** @description URL-safe workspace identifier. */
|
|
4023
|
+
workspaceSlug: string;
|
|
4447
4024
|
/** @description Unique identifier of the file. */
|
|
4448
4025
|
fileId: string;
|
|
4449
4026
|
};
|
|
@@ -4513,7 +4090,7 @@ interface paths {
|
|
|
4513
4090
|
patch?: never;
|
|
4514
4091
|
trace?: never;
|
|
4515
4092
|
};
|
|
4516
|
-
"/workspaces/{
|
|
4093
|
+
"/workspaces/{workspaceSlug}/pipelines/": {
|
|
4517
4094
|
parameters: {
|
|
4518
4095
|
query?: never;
|
|
4519
4096
|
header?: never;
|
|
@@ -4541,8 +4118,8 @@ interface paths {
|
|
|
4541
4118
|
};
|
|
4542
4119
|
header?: never;
|
|
4543
4120
|
path: {
|
|
4544
|
-
/** @description
|
|
4545
|
-
|
|
4121
|
+
/** @description URL-safe workspace identifier. */
|
|
4122
|
+
workspaceSlug: string;
|
|
4546
4123
|
};
|
|
4547
4124
|
cookie?: never;
|
|
4548
4125
|
};
|
|
@@ -4605,8 +4182,8 @@ interface paths {
|
|
|
4605
4182
|
query?: never;
|
|
4606
4183
|
header?: never;
|
|
4607
4184
|
path: {
|
|
4608
|
-
/** @description
|
|
4609
|
-
|
|
4185
|
+
/** @description URL-safe workspace identifier. */
|
|
4186
|
+
workspaceSlug: string;
|
|
4610
4187
|
};
|
|
4611
4188
|
cookie?: never;
|
|
4612
4189
|
};
|
|
@@ -4702,7 +4279,7 @@ interface paths {
|
|
|
4702
4279
|
patch?: never;
|
|
4703
4280
|
trace?: never;
|
|
4704
4281
|
};
|
|
4705
|
-
"/pipelines/{
|
|
4282
|
+
"/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/": {
|
|
4706
4283
|
parameters: {
|
|
4707
4284
|
query?: never;
|
|
4708
4285
|
header?: never;
|
|
@@ -4718,8 +4295,10 @@ interface paths {
|
|
|
4718
4295
|
query?: never;
|
|
4719
4296
|
header?: never;
|
|
4720
4297
|
path: {
|
|
4721
|
-
/** @description
|
|
4722
|
-
|
|
4298
|
+
/** @description URL-safe workspace identifier. */
|
|
4299
|
+
workspaceSlug: string;
|
|
4300
|
+
/** @description URL slug of the pipeline, unique within its workspace. */
|
|
4301
|
+
pipelineSlug: string;
|
|
4723
4302
|
};
|
|
4724
4303
|
cookie?: never;
|
|
4725
4304
|
};
|
|
@@ -4792,8 +4371,10 @@ interface paths {
|
|
|
4792
4371
|
query?: never;
|
|
4793
4372
|
header?: never;
|
|
4794
4373
|
path: {
|
|
4795
|
-
/** @description
|
|
4796
|
-
|
|
4374
|
+
/** @description URL-safe workspace identifier. */
|
|
4375
|
+
workspaceSlug: string;
|
|
4376
|
+
/** @description URL slug of the pipeline, unique within its workspace. */
|
|
4377
|
+
pipelineSlug: string;
|
|
4797
4378
|
};
|
|
4798
4379
|
cookie?: never;
|
|
4799
4380
|
};
|
|
@@ -4864,8 +4445,10 @@ interface paths {
|
|
|
4864
4445
|
query?: never;
|
|
4865
4446
|
header?: never;
|
|
4866
4447
|
path: {
|
|
4867
|
-
/** @description
|
|
4868
|
-
|
|
4448
|
+
/** @description URL-safe workspace identifier. */
|
|
4449
|
+
workspaceSlug: string;
|
|
4450
|
+
/** @description URL slug of the pipeline, unique within its workspace. */
|
|
4451
|
+
pipelineSlug: string;
|
|
4869
4452
|
};
|
|
4870
4453
|
cookie?: never;
|
|
4871
4454
|
};
|
|
@@ -4972,7 +4555,110 @@ interface paths {
|
|
|
4972
4555
|
};
|
|
4973
4556
|
trace?: never;
|
|
4974
4557
|
};
|
|
4975
|
-
"/
|
|
4558
|
+
"/workspaces/{workspaceSlug}/pipelines/runs/": {
|
|
4559
|
+
parameters: {
|
|
4560
|
+
query?: never;
|
|
4561
|
+
header?: never;
|
|
4562
|
+
path?: never;
|
|
4563
|
+
cookie?: never;
|
|
4564
|
+
};
|
|
4565
|
+
/**
|
|
4566
|
+
* List workspace runs
|
|
4567
|
+
* @description Returns all pipeline runs across the workspace, most recent first, with optional status and pipeline filters.
|
|
4568
|
+
*/
|
|
4569
|
+
get: {
|
|
4570
|
+
parameters: {
|
|
4571
|
+
query?: {
|
|
4572
|
+
/**
|
|
4573
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
4574
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
4575
|
+
*/
|
|
4576
|
+
after?: string;
|
|
4577
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
4578
|
+
limit?: number;
|
|
4579
|
+
/** @description Filter by run status. */
|
|
4580
|
+
status?: components["schemas"]["PipelineRunStatus"];
|
|
4581
|
+
};
|
|
4582
|
+
header?: never;
|
|
4583
|
+
path: {
|
|
4584
|
+
/** @description URL-safe workspace identifier. */
|
|
4585
|
+
workspaceSlug: string;
|
|
4586
|
+
};
|
|
4587
|
+
cookie?: never;
|
|
4588
|
+
};
|
|
4589
|
+
requestBody?: never;
|
|
4590
|
+
responses: {
|
|
4591
|
+
/**
|
|
4592
|
+
* @description Generic paginated response wrapper.
|
|
4593
|
+
*
|
|
4594
|
+
* Provides a consistent structure for all paginated API responses with
|
|
4595
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
4596
|
+
* are more items to fetch.
|
|
4597
|
+
*/
|
|
4598
|
+
200: {
|
|
4599
|
+
headers: {
|
|
4600
|
+
[name: string]: unknown;
|
|
4601
|
+
};
|
|
4602
|
+
content: {
|
|
4603
|
+
"application/json": components["schemas"]["PipelineRunsPage"];
|
|
4604
|
+
};
|
|
4605
|
+
};
|
|
4606
|
+
/**
|
|
4607
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4608
|
+
*
|
|
4609
|
+
* This struct contains all the information needed to serialize an error
|
|
4610
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4611
|
+
* information, and user-friendly messages.
|
|
4612
|
+
*/
|
|
4613
|
+
401: {
|
|
4614
|
+
headers: {
|
|
4615
|
+
[name: string]: unknown;
|
|
4616
|
+
};
|
|
4617
|
+
content: {
|
|
4618
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4619
|
+
};
|
|
4620
|
+
};
|
|
4621
|
+
/**
|
|
4622
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4623
|
+
*
|
|
4624
|
+
* This struct contains all the information needed to serialize an error
|
|
4625
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4626
|
+
* information, and user-friendly messages.
|
|
4627
|
+
*/
|
|
4628
|
+
403: {
|
|
4629
|
+
headers: {
|
|
4630
|
+
[name: string]: unknown;
|
|
4631
|
+
};
|
|
4632
|
+
content: {
|
|
4633
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4634
|
+
};
|
|
4635
|
+
};
|
|
4636
|
+
/**
|
|
4637
|
+
* @description HTTP error response representation with security-conscious design.
|
|
4638
|
+
*
|
|
4639
|
+
* This struct contains all the information needed to serialize an error
|
|
4640
|
+
* response, including the error name, message, HTTP status code, resource
|
|
4641
|
+
* information, and user-friendly messages.
|
|
4642
|
+
*/
|
|
4643
|
+
404: {
|
|
4644
|
+
headers: {
|
|
4645
|
+
[name: string]: unknown;
|
|
4646
|
+
};
|
|
4647
|
+
content: {
|
|
4648
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4649
|
+
};
|
|
4650
|
+
};
|
|
4651
|
+
};
|
|
4652
|
+
};
|
|
4653
|
+
put?: never;
|
|
4654
|
+
post?: never;
|
|
4655
|
+
delete?: never;
|
|
4656
|
+
options?: never;
|
|
4657
|
+
head?: never;
|
|
4658
|
+
patch?: never;
|
|
4659
|
+
trace?: never;
|
|
4660
|
+
};
|
|
4661
|
+
"/workspaces/{workspaceSlug}/pipelines/{pipelineSlug}/runs/": {
|
|
4976
4662
|
parameters: {
|
|
4977
4663
|
query?: never;
|
|
4978
4664
|
header?: never;
|
|
@@ -4996,8 +4682,10 @@ interface paths {
|
|
|
4996
4682
|
};
|
|
4997
4683
|
header?: never;
|
|
4998
4684
|
path: {
|
|
4999
|
-
/** @description
|
|
5000
|
-
|
|
4685
|
+
/** @description URL-safe workspace identifier. */
|
|
4686
|
+
workspaceSlug: string;
|
|
4687
|
+
/** @description URL slug of the pipeline, unique within its workspace. */
|
|
4688
|
+
pipelineSlug: string;
|
|
5001
4689
|
};
|
|
5002
4690
|
cookie?: never;
|
|
5003
4691
|
};
|
|
@@ -5075,8 +4763,10 @@ interface paths {
|
|
|
5075
4763
|
query?: never;
|
|
5076
4764
|
header?: never;
|
|
5077
4765
|
path: {
|
|
5078
|
-
/** @description
|
|
5079
|
-
|
|
4766
|
+
/** @description URL-safe workspace identifier. */
|
|
4767
|
+
workspaceSlug: string;
|
|
4768
|
+
/** @description URL slug of the pipeline, unique within its workspace. */
|
|
4769
|
+
pipelineSlug: string;
|
|
5080
4770
|
};
|
|
5081
4771
|
cookie?: never;
|
|
5082
4772
|
};
|
|
@@ -5092,7 +4782,12 @@ interface paths {
|
|
|
5092
4782
|
};
|
|
5093
4783
|
};
|
|
5094
4784
|
responses: {
|
|
5095
|
-
/**
|
|
4785
|
+
/**
|
|
4786
|
+
* @description Response type for a pipeline run.
|
|
4787
|
+
*
|
|
4788
|
+
* A run is addressed by its own opaque id; the owning pipeline and workspace
|
|
4789
|
+
* slugs are carried for context.
|
|
4790
|
+
*/
|
|
5096
4791
|
201: {
|
|
5097
4792
|
headers: {
|
|
5098
4793
|
[name: string]: unknown;
|
|
@@ -5187,7 +4882,7 @@ interface paths {
|
|
|
5187
4882
|
patch?: never;
|
|
5188
4883
|
trace?: never;
|
|
5189
4884
|
};
|
|
5190
|
-
"/runs/{runId}/": {
|
|
4885
|
+
"/workspaces/{workspaceSlug}/runs/{runId}/": {
|
|
5191
4886
|
parameters: {
|
|
5192
4887
|
query?: never;
|
|
5193
4888
|
header?: never;
|
|
@@ -5203,14 +4898,21 @@ interface paths {
|
|
|
5203
4898
|
query?: never;
|
|
5204
4899
|
header?: never;
|
|
5205
4900
|
path: {
|
|
5206
|
-
/** @description
|
|
5207
|
-
|
|
4901
|
+
/** @description URL-safe workspace identifier. */
|
|
4902
|
+
workspaceSlug: string;
|
|
4903
|
+
/** @description Opaque identifier of the run. */
|
|
4904
|
+
runId: components["schemas"]["RunId"];
|
|
5208
4905
|
};
|
|
5209
4906
|
cookie?: never;
|
|
5210
4907
|
};
|
|
5211
4908
|
requestBody?: never;
|
|
5212
4909
|
responses: {
|
|
5213
|
-
/**
|
|
4910
|
+
/**
|
|
4911
|
+
* @description Response type for a pipeline run.
|
|
4912
|
+
*
|
|
4913
|
+
* A run is addressed by its own opaque id; the owning pipeline and workspace
|
|
4914
|
+
* slugs are carried for context.
|
|
4915
|
+
*/
|
|
5214
4916
|
200: {
|
|
5215
4917
|
headers: {
|
|
5216
4918
|
[name: string]: unknown;
|
|
@@ -5274,7 +4976,7 @@ interface paths {
|
|
|
5274
4976
|
patch?: never;
|
|
5275
4977
|
trace?: never;
|
|
5276
4978
|
};
|
|
5277
|
-
"/runs/{runId}/detections/": {
|
|
4979
|
+
"/workspaces/{workspaceSlug}/runs/{runId}/detections/": {
|
|
5278
4980
|
parameters: {
|
|
5279
4981
|
query?: never;
|
|
5280
4982
|
header?: never;
|
|
@@ -5290,8 +4992,10 @@ interface paths {
|
|
|
5290
4992
|
query?: never;
|
|
5291
4993
|
header?: never;
|
|
5292
4994
|
path: {
|
|
5293
|
-
/** @description
|
|
5294
|
-
|
|
4995
|
+
/** @description URL-safe workspace identifier. */
|
|
4996
|
+
workspaceSlug: string;
|
|
4997
|
+
/** @description Opaque identifier of the run. */
|
|
4998
|
+
runId: components["schemas"]["RunId"];
|
|
5295
4999
|
};
|
|
5296
5000
|
cookie?: never;
|
|
5297
5001
|
};
|
|
@@ -5312,9 +5016,10 @@ interface paths {
|
|
|
5312
5016
|
*
|
|
5313
5017
|
* `correlation_id` on the persisted scope is always `None`; the
|
|
5314
5018
|
* anonymize call supplies a fresh id from the passed
|
|
5315
|
-
* [`Document`]
|
|
5316
|
-
*
|
|
5019
|
+
* [`Document`] so anonymize-side tracing spans are distinct
|
|
5020
|
+
* from the analyze-side ones.
|
|
5317
5021
|
*
|
|
5022
|
+
* [`Document`]: nvisy_schema::file::Document
|
|
5318
5023
|
* [`Scope`]: elide::recognition::Scope
|
|
5319
5024
|
*/
|
|
5320
5025
|
200: {
|
|
@@ -5395,7 +5100,7 @@ interface paths {
|
|
|
5395
5100
|
patch?: never;
|
|
5396
5101
|
trace?: never;
|
|
5397
5102
|
};
|
|
5398
|
-
"/runs/{runId}/redactions/": {
|
|
5103
|
+
"/workspaces/{workspaceSlug}/runs/{runId}/redactions/": {
|
|
5399
5104
|
parameters: {
|
|
5400
5105
|
query?: never;
|
|
5401
5106
|
header?: never;
|
|
@@ -5413,14 +5118,21 @@ interface paths {
|
|
|
5413
5118
|
query?: never;
|
|
5414
5119
|
header?: never;
|
|
5415
5120
|
path: {
|
|
5416
|
-
/** @description
|
|
5417
|
-
|
|
5121
|
+
/** @description URL-safe workspace identifier. */
|
|
5122
|
+
workspaceSlug: string;
|
|
5123
|
+
/** @description Opaque identifier of the run. */
|
|
5124
|
+
runId: components["schemas"]["RunId"];
|
|
5418
5125
|
};
|
|
5419
5126
|
cookie?: never;
|
|
5420
5127
|
};
|
|
5421
5128
|
requestBody?: never;
|
|
5422
5129
|
responses: {
|
|
5423
|
-
/**
|
|
5130
|
+
/**
|
|
5131
|
+
* @description Response type for a pipeline run.
|
|
5132
|
+
*
|
|
5133
|
+
* A run is addressed by its own opaque id; the owning pipeline and workspace
|
|
5134
|
+
* slugs are carried for context.
|
|
5135
|
+
*/
|
|
5424
5136
|
200: {
|
|
5425
5137
|
headers: {
|
|
5426
5138
|
[name: string]: unknown;
|
|
@@ -5497,7 +5209,7 @@ interface paths {
|
|
|
5497
5209
|
patch?: never;
|
|
5498
5210
|
trace?: never;
|
|
5499
5211
|
};
|
|
5500
|
-
"/workspaces/{
|
|
5212
|
+
"/workspaces/{workspaceSlug}/policies/": {
|
|
5501
5213
|
parameters: {
|
|
5502
5214
|
query?: never;
|
|
5503
5215
|
header?: never;
|
|
@@ -5521,8 +5233,8 @@ interface paths {
|
|
|
5521
5233
|
};
|
|
5522
5234
|
header?: never;
|
|
5523
5235
|
path: {
|
|
5524
|
-
/** @description
|
|
5525
|
-
|
|
5236
|
+
/** @description URL-safe workspace identifier. */
|
|
5237
|
+
workspaceSlug: string;
|
|
5526
5238
|
};
|
|
5527
5239
|
cookie?: never;
|
|
5528
5240
|
};
|
|
@@ -5585,8 +5297,8 @@ interface paths {
|
|
|
5585
5297
|
query?: never;
|
|
5586
5298
|
header?: never;
|
|
5587
5299
|
path: {
|
|
5588
|
-
/** @description
|
|
5589
|
-
|
|
5300
|
+
/** @description URL-safe workspace identifier. */
|
|
5301
|
+
workspaceSlug: string;
|
|
5590
5302
|
};
|
|
5591
5303
|
cookie?: never;
|
|
5592
5304
|
};
|
|
@@ -5683,7 +5395,7 @@ interface paths {
|
|
|
5683
5395
|
patch?: never;
|
|
5684
5396
|
trace?: never;
|
|
5685
5397
|
};
|
|
5686
|
-
"/policies/{
|
|
5398
|
+
"/workspaces/{workspaceSlug}/policies/{policySlug}/": {
|
|
5687
5399
|
parameters: {
|
|
5688
5400
|
query?: never;
|
|
5689
5401
|
header?: never;
|
|
@@ -5699,8 +5411,10 @@ interface paths {
|
|
|
5699
5411
|
query?: never;
|
|
5700
5412
|
header?: never;
|
|
5701
5413
|
path: {
|
|
5702
|
-
/** @description
|
|
5703
|
-
|
|
5414
|
+
/** @description URL-safe workspace identifier. */
|
|
5415
|
+
workspaceSlug: string;
|
|
5416
|
+
/** @description URL slug of the policy, unique within its workspace. */
|
|
5417
|
+
policySlug: string;
|
|
5704
5418
|
};
|
|
5705
5419
|
cookie?: never;
|
|
5706
5420
|
};
|
|
@@ -5771,8 +5485,10 @@ interface paths {
|
|
|
5771
5485
|
query?: never;
|
|
5772
5486
|
header?: never;
|
|
5773
5487
|
path: {
|
|
5774
|
-
/** @description
|
|
5775
|
-
|
|
5488
|
+
/** @description URL-safe workspace identifier. */
|
|
5489
|
+
workspaceSlug: string;
|
|
5490
|
+
/** @description URL slug of the policy, unique within its workspace. */
|
|
5491
|
+
policySlug: string;
|
|
5776
5492
|
};
|
|
5777
5493
|
cookie?: never;
|
|
5778
5494
|
};
|
|
@@ -5886,8 +5602,10 @@ interface paths {
|
|
|
5886
5602
|
query?: never;
|
|
5887
5603
|
header?: never;
|
|
5888
5604
|
path: {
|
|
5889
|
-
/** @description
|
|
5890
|
-
|
|
5605
|
+
/** @description URL-safe workspace identifier. */
|
|
5606
|
+
workspaceSlug: string;
|
|
5607
|
+
/** @description URL slug of the policy, unique within its workspace. */
|
|
5608
|
+
policySlug: string;
|
|
5891
5609
|
};
|
|
5892
5610
|
cookie?: never;
|
|
5893
5611
|
};
|
|
@@ -6371,20 +6089,13 @@ interface components {
|
|
|
6371
6089
|
schemas: {
|
|
6372
6090
|
/** @description Represents an account. */
|
|
6373
6091
|
Account: {
|
|
6374
|
-
/**
|
|
6375
|
-
* Format: uuid
|
|
6376
|
-
* @description Unique identifier of the account.
|
|
6377
|
-
*/
|
|
6378
|
-
accountId: string;
|
|
6379
|
-
/** @description Company name (optional). */
|
|
6380
|
-
companyName?: string;
|
|
6381
6092
|
/**
|
|
6382
6093
|
* Format: date-time
|
|
6383
6094
|
* @description Timestamp when the account was created.
|
|
6384
6095
|
*/
|
|
6385
6096
|
createdAt: string;
|
|
6386
|
-
/** @description Display name of the account holder. */
|
|
6387
|
-
displayName
|
|
6097
|
+
/** @description Display name of the account holder, when set. */
|
|
6098
|
+
displayName?: string;
|
|
6388
6099
|
/** @description Email address associated with the account. */
|
|
6389
6100
|
emailAddress: string;
|
|
6390
6101
|
/** @description Whether the account email has been verified. */
|
|
@@ -6398,29 +6109,25 @@ interface components {
|
|
|
6398
6109
|
* @description Timestamp when the account was last updated.
|
|
6399
6110
|
*/
|
|
6400
6111
|
updatedAt: string;
|
|
6112
|
+
/** @description Public handle of the account. */
|
|
6113
|
+
username: components["schemas"]["Username"];
|
|
6401
6114
|
};
|
|
6402
6115
|
/**
|
|
6403
6116
|
* @description Path parameters for account operations.
|
|
6404
6117
|
*
|
|
6405
|
-
* Used when retrieving account information by
|
|
6118
|
+
* Used when retrieving account information by handle. Access is granted
|
|
6406
6119
|
* if the requester shares at least one workspace with the target account.
|
|
6407
6120
|
*/
|
|
6408
6121
|
AccountPathParams: {
|
|
6409
|
-
/**
|
|
6410
|
-
|
|
6411
|
-
* @description Unique identifier of the account.
|
|
6412
|
-
*/
|
|
6413
|
-
accountId: string;
|
|
6122
|
+
/** @description Public handle of the account. */
|
|
6123
|
+
username: components["schemas"]["Username"];
|
|
6414
6124
|
};
|
|
6415
6125
|
/** @description Response type for a workspace activity. */
|
|
6416
6126
|
Activity: {
|
|
6417
|
-
/**
|
|
6418
|
-
* Format: uuid
|
|
6419
|
-
* @description Account that performed the activity.
|
|
6420
|
-
*/
|
|
6421
|
-
accountId?: string;
|
|
6422
6127
|
/** @description Type of activity. */
|
|
6423
6128
|
activityType: components["schemas"]["ActivityType"];
|
|
6129
|
+
/** @description Handle of the account that performed the activity, if any. */
|
|
6130
|
+
actorUsername?: components["schemas"]["Username"];
|
|
6424
6131
|
/**
|
|
6425
6132
|
* Format: date-time
|
|
6426
6133
|
* @description When the activity occurred.
|
|
@@ -6433,11 +6140,8 @@ interface components {
|
|
|
6433
6140
|
* @description Unique activity identifier.
|
|
6434
6141
|
*/
|
|
6435
6142
|
id: string;
|
|
6436
|
-
/**
|
|
6437
|
-
|
|
6438
|
-
* @description Workspace ID.
|
|
6439
|
-
*/
|
|
6440
|
-
workspaceId: string;
|
|
6143
|
+
/** @description Slug of the workspace this activity belongs to. */
|
|
6144
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
6441
6145
|
};
|
|
6442
6146
|
/**
|
|
6443
6147
|
* @description Defines the type of activity performed in a workspace for audit logging.
|
|
@@ -6446,7 +6150,7 @@ interface components {
|
|
|
6446
6150
|
* to categorize different types of activities that occur within workspaces for comprehensive
|
|
6447
6151
|
* audit trail and activity tracking.
|
|
6448
6152
|
*/
|
|
6449
|
-
ActivityType: "workspace:created" | "workspace:updated" | "workspace:deleted" | "workspace:exported" | "workspace:imported" | "member:deleted" | "member:updated" | "invite:created" | "invite:accepted" | "invite:declined" | "invite:canceled" | "connection:created" | "connection:updated" | "connection:deleted" | "connection:synced" | "webhook:created" | "webhook:updated" | "webhook:deleted" | "webhook:triggered" | "
|
|
6153
|
+
ActivityType: "workspace:created" | "workspace:updated" | "workspace:deleted" | "workspace:exported" | "workspace:imported" | "member:deleted" | "member:updated" | "invite:created" | "invite:accepted" | "invite:declined" | "invite:canceled" | "connection:created" | "connection:updated" | "connection:deleted" | "connection:synced" | "webhook:created" | "webhook:updated" | "webhook:deleted" | "webhook:triggered" | "file:created" | "file:updated" | "file:deleted" | "file:verified" | "custom";
|
|
6450
6154
|
/**
|
|
6451
6155
|
* @description Generic paginated response wrapper.
|
|
6452
6156
|
*
|
|
@@ -6465,31 +6169,6 @@ interface components {
|
|
|
6465
6169
|
*/
|
|
6466
6170
|
total?: number;
|
|
6467
6171
|
};
|
|
6468
|
-
/** @description Structured address reference. */
|
|
6469
|
-
AddressData: {
|
|
6470
|
-
/** @description City name. */
|
|
6471
|
-
city?: string;
|
|
6472
|
-
/** @description ISO 3166-1 alpha-2 country code. */
|
|
6473
|
-
country?: string;
|
|
6474
|
-
/** @description Additional free-form address fields. */
|
|
6475
|
-
extra?: {
|
|
6476
|
-
[key: string]: string;
|
|
6477
|
-
};
|
|
6478
|
-
/** @description Postal / ZIP code. */
|
|
6479
|
-
postalCode?: string;
|
|
6480
|
-
/** @description State, province, or administrative area. */
|
|
6481
|
-
state?: string;
|
|
6482
|
-
/** @description Street line (e.g. `"123 Main St"`). */
|
|
6483
|
-
street?: string;
|
|
6484
|
-
};
|
|
6485
|
-
/** @description Analytic computation variants. */
|
|
6486
|
-
AnalyticVariant: ({
|
|
6487
|
-
/** @constant */
|
|
6488
|
-
kind: "embedding";
|
|
6489
|
-
} & components["schemas"]["EmbeddingData"]) | ({
|
|
6490
|
-
/** @constant */
|
|
6491
|
-
kind: "pattern";
|
|
6492
|
-
} & components["schemas"]["PatternData"]);
|
|
6493
6172
|
/**
|
|
6494
6173
|
* @description What detection found in one document.
|
|
6495
6174
|
*
|
|
@@ -6505,9 +6184,10 @@ interface components {
|
|
|
6505
6184
|
*
|
|
6506
6185
|
* `correlation_id` on the persisted scope is always `None`; the
|
|
6507
6186
|
* anonymize call supplies a fresh id from the passed
|
|
6508
|
-
* [`Document`]
|
|
6509
|
-
*
|
|
6187
|
+
* [`Document`] so anonymize-side tracing spans are distinct
|
|
6188
|
+
* from the analyze-side ones.
|
|
6510
6189
|
*
|
|
6190
|
+
* [`Document`]: nvisy_schema::file::Document
|
|
6511
6191
|
* [`Scope`]: elide::recognition::Scope
|
|
6512
6192
|
*/
|
|
6513
6193
|
AnalyzedDocument: {
|
|
@@ -6550,11 +6230,6 @@ interface components {
|
|
|
6550
6230
|
};
|
|
6551
6231
|
/** @description API token response structure. */
|
|
6552
6232
|
ApiToken: {
|
|
6553
|
-
/**
|
|
6554
|
-
* Format: uuid
|
|
6555
|
-
* @description Reference to the account this token belongs to.
|
|
6556
|
-
*/
|
|
6557
|
-
accountId: string;
|
|
6558
6233
|
/**
|
|
6559
6234
|
* Format: date-time
|
|
6560
6235
|
* @description Timestamp when the token expires (None = never expires).
|
|
@@ -6589,11 +6264,6 @@ interface components {
|
|
|
6589
6264
|
ApiTokenType: "web" | "api" | "cli";
|
|
6590
6265
|
/** @description API token with JWT token string (only returned on creation). */
|
|
6591
6266
|
ApiTokenWithJWT: {
|
|
6592
|
-
/**
|
|
6593
|
-
* Format: uuid
|
|
6594
|
-
* @description Reference to the account this token belongs to.
|
|
6595
|
-
*/
|
|
6596
|
-
accountId: string;
|
|
6597
6267
|
/**
|
|
6598
6268
|
* Format: date-time
|
|
6599
6269
|
* @description Timestamp when the token expires (omitted = never expires).
|
|
@@ -6766,11 +6436,6 @@ interface components {
|
|
|
6766
6436
|
};
|
|
6767
6437
|
/** @description Response returned after successful authentication (login/signup). */
|
|
6768
6438
|
AuthToken: {
|
|
6769
|
-
/**
|
|
6770
|
-
* Format: uuid
|
|
6771
|
-
* @description ID of the authenticated account.
|
|
6772
|
-
*/
|
|
6773
|
-
accountId: string;
|
|
6774
6439
|
/** @description The JWT API token for authentication. */
|
|
6775
6440
|
apiToken: string;
|
|
6776
6441
|
/**
|
|
@@ -6783,20 +6448,9 @@ interface components {
|
|
|
6783
6448
|
* @description Timestamp when the token was issued.
|
|
6784
6449
|
*/
|
|
6785
6450
|
issuedAt: string;
|
|
6786
|
-
/**
|
|
6787
|
-
|
|
6788
|
-
* @description ID of the token.
|
|
6789
|
-
*/
|
|
6790
|
-
tokenId: string;
|
|
6451
|
+
/** @description Handle of the authenticated account. */
|
|
6452
|
+
username: components["schemas"]["Username"];
|
|
6791
6453
|
};
|
|
6792
|
-
/** @description Biometric identity verification variants. */
|
|
6793
|
-
BiometricVariant: ({
|
|
6794
|
-
/** @constant */
|
|
6795
|
-
kind: "face";
|
|
6796
|
-
} & components["schemas"]["FaceData"]) | ({
|
|
6797
|
-
/** @constant */
|
|
6798
|
-
kind: "voice";
|
|
6799
|
-
} & components["schemas"]["VoiceData"]);
|
|
6800
6454
|
/**
|
|
6801
6455
|
* @description Axis-aligned rectangle, given by its minimum and maximum corners.
|
|
6802
6456
|
*
|
|
@@ -6891,21 +6545,20 @@ interface components {
|
|
|
6891
6545
|
* Only metadata about the connection is returned.
|
|
6892
6546
|
*/
|
|
6893
6547
|
Connection: {
|
|
6894
|
-
/**
|
|
6895
|
-
* Format: uuid
|
|
6896
|
-
* @description Account that created this connection.
|
|
6897
|
-
*/
|
|
6898
|
-
accountId: string;
|
|
6899
6548
|
/**
|
|
6900
6549
|
* Format: date-time
|
|
6901
6550
|
* @description When the connection was created.
|
|
6902
6551
|
*/
|
|
6903
6552
|
createdAt: string;
|
|
6553
|
+
/** @description Handle of the account that created this connection. */
|
|
6554
|
+
creatorUsername: components["schemas"]["Username"];
|
|
6555
|
+
/** @description Opaque identifier of the connection. */
|
|
6556
|
+
id: components["schemas"]["ConnectionId"];
|
|
6904
6557
|
/**
|
|
6905
|
-
* Format:
|
|
6906
|
-
* @description
|
|
6558
|
+
* Format: date-time
|
|
6559
|
+
* @description When the connection last synced successfully, if ever.
|
|
6907
6560
|
*/
|
|
6908
|
-
|
|
6561
|
+
lastSynced?: string;
|
|
6909
6562
|
/** @description Human-readable connection name. */
|
|
6910
6563
|
name: string;
|
|
6911
6564
|
/** @description Provider type (e.g., "openai", "postgres", "s3"). */
|
|
@@ -6915,19 +6568,22 @@ interface components {
|
|
|
6915
6568
|
* @description When the connection was last updated.
|
|
6916
6569
|
*/
|
|
6917
6570
|
updatedAt: string;
|
|
6918
|
-
/**
|
|
6919
|
-
|
|
6920
|
-
* @description Workspace this connection belongs to.
|
|
6921
|
-
*/
|
|
6922
|
-
workspaceId: string;
|
|
6571
|
+
/** @description Slug of the workspace this connection belongs to. */
|
|
6572
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
6923
6573
|
};
|
|
6924
|
-
/** @description
|
|
6574
|
+
/** @description Opaque conn identifier (conn_<uuid>). */
|
|
6575
|
+
ConnectionId: string;
|
|
6576
|
+
/**
|
|
6577
|
+
* @description Path parameters for connection operations.
|
|
6578
|
+
*
|
|
6579
|
+
* The workspace is resolved separately from the `{workspaceSlug}` segment by
|
|
6580
|
+
* the [`WorkspaceContext`] extractor.
|
|
6581
|
+
*
|
|
6582
|
+
* [`WorkspaceContext`]: crate::extract::WorkspaceContext
|
|
6583
|
+
*/
|
|
6925
6584
|
ConnectionPathParams: {
|
|
6926
|
-
/**
|
|
6927
|
-
|
|
6928
|
-
* @description Unique identifier of the connection.
|
|
6929
|
-
*/
|
|
6930
|
-
connectionId: string;
|
|
6585
|
+
/** @description Opaque identifier of the connection. */
|
|
6586
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
6931
6587
|
};
|
|
6932
6588
|
/**
|
|
6933
6589
|
* @description Generic paginated response wrapper.
|
|
@@ -6952,126 +6608,6 @@ interface components {
|
|
|
6952
6608
|
/** @description Filter by provider type. */
|
|
6953
6609
|
provider?: string;
|
|
6954
6610
|
};
|
|
6955
|
-
/** @description A persistent, reusable collection of reference data for detection. */
|
|
6956
|
-
Context: {
|
|
6957
|
-
/** @description Optional longer description. */
|
|
6958
|
-
description?: string;
|
|
6959
|
-
/** @description Reference-data entries. */
|
|
6960
|
-
entries: components["schemas"]["ContextEntry"][];
|
|
6961
|
-
/**
|
|
6962
|
-
* Format: uuid
|
|
6963
|
-
* @description Unique identifier for this context.
|
|
6964
|
-
*/
|
|
6965
|
-
id: string;
|
|
6966
|
-
/** @description Human-readable label for this context. */
|
|
6967
|
-
name: string;
|
|
6968
|
-
/** @description Context version. */
|
|
6969
|
-
version: string;
|
|
6970
|
-
};
|
|
6971
|
-
/** @description Response type for a workspace context. */
|
|
6972
|
-
Context2: {
|
|
6973
|
-
/**
|
|
6974
|
-
* Format: uuid
|
|
6975
|
-
* @description Account that created this context.
|
|
6976
|
-
*/
|
|
6977
|
-
accountId: string;
|
|
6978
|
-
/**
|
|
6979
|
-
* Format: date-time
|
|
6980
|
-
* @description When the context was created.
|
|
6981
|
-
*/
|
|
6982
|
-
createdAt: string;
|
|
6983
|
-
/** @description The structured context body consumed by the engine. */
|
|
6984
|
-
definition: components["schemas"]["Context"];
|
|
6985
|
-
/** @description Context description. */
|
|
6986
|
-
description?: string;
|
|
6987
|
-
/**
|
|
6988
|
-
* Format: uuid
|
|
6989
|
-
* @description Unique context identifier.
|
|
6990
|
-
*/
|
|
6991
|
-
id: string;
|
|
6992
|
-
/** @description Human-readable context name. */
|
|
6993
|
-
name: string;
|
|
6994
|
-
/**
|
|
6995
|
-
* Format: date-time
|
|
6996
|
-
* @description When the context was last updated.
|
|
6997
|
-
*/
|
|
6998
|
-
updatedAt: string;
|
|
6999
|
-
/** @description Semver of the context body. */
|
|
7000
|
-
version: string;
|
|
7001
|
-
/**
|
|
7002
|
-
* Format: uuid
|
|
7003
|
-
* @description Workspace this context belongs to.
|
|
7004
|
-
*/
|
|
7005
|
-
workspaceId: string;
|
|
7006
|
-
};
|
|
7007
|
-
/**
|
|
7008
|
-
* @description A single reference-data entry within a [`Context`].
|
|
7009
|
-
*
|
|
7010
|
-
* [`Context`]: super::Context
|
|
7011
|
-
*/
|
|
7012
|
-
ContextEntry: {
|
|
7013
|
-
/** @description When this entry was created. */
|
|
7014
|
-
createdAt: string;
|
|
7015
|
-
/** @description When this entry should stop being used. */
|
|
7016
|
-
expiresAt?: string;
|
|
7017
|
-
/**
|
|
7018
|
-
* Format: uuid
|
|
7019
|
-
* @description Unique identifier for this entry.
|
|
7020
|
-
*/
|
|
7021
|
-
id: string;
|
|
7022
|
-
/** @description Human-readable label. */
|
|
7023
|
-
label?: string;
|
|
7024
|
-
} & ({
|
|
7025
|
-
data: components["schemas"]["BiometricVariant"];
|
|
7026
|
-
/** @constant */
|
|
7027
|
-
domain: "biometric";
|
|
7028
|
-
} | {
|
|
7029
|
-
data: components["schemas"]["GeospatialVariant"];
|
|
7030
|
-
/** @constant */
|
|
7031
|
-
domain: "geospatial";
|
|
7032
|
-
} | {
|
|
7033
|
-
data: components["schemas"]["AnalyticVariant"];
|
|
7034
|
-
/** @constant */
|
|
7035
|
-
domain: "analytic";
|
|
7036
|
-
} | {
|
|
7037
|
-
data: components["schemas"]["ReferenceVariant"];
|
|
7038
|
-
/** @constant */
|
|
7039
|
-
domain: "reference";
|
|
7040
|
-
} | {
|
|
7041
|
-
data: components["schemas"]["TemporalVariant"];
|
|
7042
|
-
/** @constant */
|
|
7043
|
-
domain: "temporal";
|
|
7044
|
-
} | {
|
|
7045
|
-
data: components["schemas"]["DocumentVariant"];
|
|
7046
|
-
/** @constant */
|
|
7047
|
-
domain: "document";
|
|
7048
|
-
});
|
|
7049
|
-
/** @description Path parameters for context operations. */
|
|
7050
|
-
ContextPathParams: {
|
|
7051
|
-
/**
|
|
7052
|
-
* Format: uuid
|
|
7053
|
-
* @description Unique identifier of the context.
|
|
7054
|
-
*/
|
|
7055
|
-
contextId: string;
|
|
7056
|
-
};
|
|
7057
|
-
/**
|
|
7058
|
-
* @description Generic paginated response wrapper.
|
|
7059
|
-
*
|
|
7060
|
-
* Provides a consistent structure for all paginated API responses with
|
|
7061
|
-
* cursor-based pagination support. When `next_cursor` is present, there
|
|
7062
|
-
* are more items to fetch.
|
|
7063
|
-
*/
|
|
7064
|
-
ContextsPage: {
|
|
7065
|
-
/** @description Items in this page. */
|
|
7066
|
-
items: components["schemas"]["Context2"][];
|
|
7067
|
-
/** @description Cursor to fetch the next page. Present only when more items exist. */
|
|
7068
|
-
nextCursor?: string;
|
|
7069
|
-
/**
|
|
7070
|
-
* Format: int64
|
|
7071
|
-
* @description Total count of items matching the query (if requested).
|
|
7072
|
-
*/
|
|
7073
|
-
total?: number;
|
|
7074
|
-
};
|
|
7075
6611
|
/**
|
|
7076
6612
|
* @description [ISO 3166-1] country, identified by its code.
|
|
7077
6613
|
*
|
|
@@ -7107,21 +6643,6 @@ interface components {
|
|
|
7107
6643
|
/** @description Provider type (e.g., "openai", "postgres", "s3"). */
|
|
7108
6644
|
provider: string;
|
|
7109
6645
|
};
|
|
7110
|
-
/**
|
|
7111
|
-
* @description Request payload for creating a new workspace context.
|
|
7112
|
-
*
|
|
7113
|
-
* The `definition` is a structured context the redaction engine consumes;
|
|
7114
|
-
* its `name`, `description`, and `version` drive the stored columns unless
|
|
7115
|
-
* overridden here.
|
|
7116
|
-
*/
|
|
7117
|
-
CreateContext: {
|
|
7118
|
-
/** @description The structured context body consumed by the engine. */
|
|
7119
|
-
definition: components["schemas"]["Context"];
|
|
7120
|
-
/** @description Optional description override. Defaults to the context's own description. */
|
|
7121
|
-
description?: string;
|
|
7122
|
-
/** @description Optional display name override. Defaults to the context's own name. */
|
|
7123
|
-
name?: string;
|
|
7124
|
-
};
|
|
7125
6646
|
/** @description Request payload for creating a new workspace invite. */
|
|
7126
6647
|
CreateInvite: {
|
|
7127
6648
|
/** @description When the invitation expires. */
|
|
@@ -7150,6 +6671,8 @@ interface components {
|
|
|
7150
6671
|
description?: string;
|
|
7151
6672
|
/** @description Pipeline name (3-100 characters). */
|
|
7152
6673
|
name: string;
|
|
6674
|
+
/** @description URL slug, unique within the workspace and immutable after creation. */
|
|
6675
|
+
slug: components["schemas"]["Slug"];
|
|
7153
6676
|
};
|
|
7154
6677
|
/**
|
|
7155
6678
|
* @description Request payload to start a run (detect) over a file.
|
|
@@ -7185,6 +6708,8 @@ interface components {
|
|
|
7185
6708
|
description?: string;
|
|
7186
6709
|
/** @description Optional display name override. Defaults to the policy's own name. */
|
|
7187
6710
|
name?: string;
|
|
6711
|
+
/** @description URL slug, unique within the workspace and immutable after creation. */
|
|
6712
|
+
slug: components["schemas"]["Slug"];
|
|
7188
6713
|
};
|
|
7189
6714
|
/** @description Request payload for creating a new workspace webhook. */
|
|
7190
6715
|
CreateWebhook: {
|
|
@@ -7215,35 +6740,13 @@ interface components {
|
|
|
7215
6740
|
CreateWorkspace: {
|
|
7216
6741
|
/** @description Optional description of the workspace (max 200 characters). */
|
|
7217
6742
|
description?: string;
|
|
7218
|
-
/** @description Display name of the workspace (3-
|
|
7219
|
-
displayName: string;
|
|
7220
|
-
/** @description Whether
|
|
7221
|
-
|
|
7222
|
-
/** @description
|
|
7223
|
-
|
|
7224
|
-
};
|
|
7225
|
-
/**
|
|
7226
|
-
* @description A reference credential for detecting leaked secrets.
|
|
7227
|
-
*
|
|
7228
|
-
* The `value` field is intentionally excluded from serialization to
|
|
7229
|
-
* prevent plaintext secrets from appearing in logs or API responses.
|
|
7230
|
-
* It is only accepted during deserialization (ingest).
|
|
7231
|
-
*/
|
|
7232
|
-
CredentialData: {
|
|
7233
|
-
/** @description Classification of this credential. */
|
|
7234
|
-
credentialKind?: components["schemas"]["CredentialKind"];
|
|
7235
|
-
/** @description Service or provider this credential belongs to. */
|
|
7236
|
-
provider?: string;
|
|
7237
|
-
/**
|
|
7238
|
-
* @description The credential value (API key, token, etc.).
|
|
7239
|
-
*
|
|
7240
|
-
* Excluded from serialization output to prevent leaking secrets.
|
|
7241
|
-
* Round-trip deserialization yields an empty string.
|
|
7242
|
-
*/
|
|
7243
|
-
value?: string;
|
|
6743
|
+
/** @description Display name of the workspace (3-32 characters). */
|
|
6744
|
+
displayName: string;
|
|
6745
|
+
/** @description Whether approval is required for processed files to be visible. */
|
|
6746
|
+
requireApproval?: boolean;
|
|
6747
|
+
/** @description Optional URL slug. Derived from the display name when omitted. */
|
|
6748
|
+
slug?: components["schemas"]["Slug"];
|
|
7244
6749
|
};
|
|
7245
|
-
/** @description Classification of credential secrets. */
|
|
7246
|
-
CredentialKind: "api_key" | "oauth_token" | "password" | "private_key" | "other";
|
|
7247
6750
|
/**
|
|
7248
6751
|
* @description Cursor-based pagination query parameters.
|
|
7249
6752
|
*
|
|
@@ -7414,29 +6917,6 @@ interface components {
|
|
|
7414
6917
|
*/
|
|
7415
6918
|
validator?: string;
|
|
7416
6919
|
};
|
|
7417
|
-
/** @description A date or date-range reference for temporal matching. */
|
|
7418
|
-
DateData: {
|
|
7419
|
-
/** @description End date for a range. When `None` this represents a single date. */
|
|
7420
|
-
end?: string;
|
|
7421
|
-
/** @description Start (or only) date. */
|
|
7422
|
-
start: string;
|
|
7423
|
-
};
|
|
7424
|
-
/**
|
|
7425
|
-
* @description A date-time or date-time range reference for temporal matching.
|
|
7426
|
-
*
|
|
7427
|
-
* Uses naive (timezone-unaware) date-times from [`DateTime`].
|
|
7428
|
-
* For timezone-aware timestamps, use the entry-level `created_at` /
|
|
7429
|
-
* `expires_at` fields on [`ContextEntry`].
|
|
7430
|
-
*
|
|
7431
|
-
* [`ContextEntry`]: crate::ContextEntry
|
|
7432
|
-
* [`DateTime`]: jiff::civil::DateTime
|
|
7433
|
-
*/
|
|
7434
|
-
DateTimeData: {
|
|
7435
|
-
/** @description End date-time for a range. When `None` this represents a single instant. */
|
|
7436
|
-
end?: string;
|
|
7437
|
-
/** @description Start (or only) date-time. */
|
|
7438
|
-
start: string;
|
|
7439
|
-
};
|
|
7440
6920
|
/**
|
|
7441
6921
|
* @description Dedup pipeline applied after recognition.
|
|
7442
6922
|
*
|
|
@@ -7501,8 +6981,6 @@ interface components {
|
|
|
7501
6981
|
*/
|
|
7502
6982
|
width: number;
|
|
7503
6983
|
};
|
|
7504
|
-
/** @description Distance metric for vector similarity comparison. */
|
|
7505
|
-
DistanceMetric: "cosine" | "euclidean" | "dot_product" | "manhattan";
|
|
7506
6984
|
/** @description Predicate over document-level facts. */
|
|
7507
6985
|
DocumentPredicate: {
|
|
7508
6986
|
/** @constant */
|
|
@@ -7532,23 +7010,6 @@ interface components {
|
|
|
7532
7010
|
/** @description Negated predicate. */
|
|
7533
7011
|
not: components["schemas"]["DocumentPredicate"];
|
|
7534
7012
|
};
|
|
7535
|
-
/** @description Document-related reference variants. */
|
|
7536
|
-
DocumentVariant: ({
|
|
7537
|
-
/** @constant */
|
|
7538
|
-
kind: "template";
|
|
7539
|
-
} & components["schemas"]["TemplateData"]) | ({
|
|
7540
|
-
/** @constant */
|
|
7541
|
-
kind: "signature";
|
|
7542
|
-
} & components["schemas"]["SignatureData"]);
|
|
7543
|
-
/** @description Pre-computed embedding vector for similarity comparison. */
|
|
7544
|
-
EmbeddingData: {
|
|
7545
|
-
/** @description Identifier of the model/algorithm that produced this embedding. */
|
|
7546
|
-
algorithm?: string;
|
|
7547
|
-
/** @description Distance metric to use for comparison. */
|
|
7548
|
-
distanceMetric?: components["schemas"]["DistanceMetric"];
|
|
7549
|
-
/** @description The embedding vector values. */
|
|
7550
|
-
vector: number[];
|
|
7551
|
-
};
|
|
7552
7013
|
/**
|
|
7553
7014
|
* @description Enricher slots an analyzer can fill.
|
|
7554
7015
|
*
|
|
@@ -8539,20 +8000,6 @@ interface components {
|
|
|
8539
8000
|
/** @description Which operator (name + version) ran. */
|
|
8540
8001
|
operator: components["schemas"]["OperatorId"];
|
|
8541
8002
|
};
|
|
8542
|
-
/** @description Reference face data for identity matching. */
|
|
8543
|
-
FaceData: {
|
|
8544
|
-
/** @description Algorithm that produced the template (e.g. `"arcface"`, `"facenet"`). */
|
|
8545
|
-
algorithm?: string;
|
|
8546
|
-
/**
|
|
8547
|
-
* Format: uuid
|
|
8548
|
-
* @description Id of the file holding the reference face image.
|
|
8549
|
-
*/
|
|
8550
|
-
imageSource: string;
|
|
8551
|
-
/** @description Bounding box of the face within the image. */
|
|
8552
|
-
region?: components["schemas"]["BoundingBox"];
|
|
8553
|
-
/** @description Base64-encoded face embedding / template. */
|
|
8554
|
-
template?: string;
|
|
8555
|
-
};
|
|
8556
8003
|
/** @description Represents a file in responses. */
|
|
8557
8004
|
File: {
|
|
8558
8005
|
/**
|
|
@@ -8592,37 +8039,18 @@ interface components {
|
|
|
8592
8039
|
* @description Last update timestamp.
|
|
8593
8040
|
*/
|
|
8594
8041
|
updatedAt: string;
|
|
8595
|
-
/**
|
|
8596
|
-
|
|
8597
|
-
* @description Account ID of the user who uploaded/created the file.
|
|
8598
|
-
*/
|
|
8599
|
-
uploadedBy: string;
|
|
8042
|
+
/** @description Handle of the account that uploaded/created the file. */
|
|
8043
|
+
uploadedBy: components["schemas"]["Username"];
|
|
8600
8044
|
/**
|
|
8601
8045
|
* Format: int32
|
|
8602
8046
|
* @description Version number (1 for original, higher for newer versions).
|
|
8603
8047
|
*/
|
|
8604
8048
|
versionNumber: number;
|
|
8605
|
-
/**
|
|
8606
|
-
|
|
8607
|
-
* @description Workspace this file belongs to.
|
|
8608
|
-
*/
|
|
8609
|
-
workspaceId: string;
|
|
8049
|
+
/** @description Slug of the workspace this file belongs to. */
|
|
8050
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
8610
8051
|
};
|
|
8611
8052
|
/** @description File format categories for filtering. */
|
|
8612
8053
|
FileFormat: "pdf" | "doc" | "txt" | "md" | "csv" | "json" | "png" | "jpeg";
|
|
8613
|
-
/**
|
|
8614
|
-
* @description Path parameters for file operations (file ID only).
|
|
8615
|
-
*
|
|
8616
|
-
* Since file IDs are globally unique UUIDs, workspace context can be
|
|
8617
|
-
* derived from the file record itself for authorization purposes.
|
|
8618
|
-
*/
|
|
8619
|
-
FilePathParams: {
|
|
8620
|
-
/**
|
|
8621
|
-
* Format: uuid
|
|
8622
|
-
* @description Unique identifier of the file.
|
|
8623
|
-
*/
|
|
8624
|
-
fileId: string;
|
|
8625
|
-
};
|
|
8626
8054
|
/**
|
|
8627
8055
|
* @description Defines how a file was created in the system.
|
|
8628
8056
|
*
|
|
@@ -8656,39 +8084,6 @@ interface components {
|
|
|
8656
8084
|
/** @description Role to assign when someone joins via this invite code. */
|
|
8657
8085
|
invitedRole: components["schemas"]["WorkspaceRole"];
|
|
8658
8086
|
};
|
|
8659
|
-
/** @description A geographic bounding box defined by its south-west and north-east corners. */
|
|
8660
|
-
GeoBounds: {
|
|
8661
|
-
/** @description North-east corner. */
|
|
8662
|
-
northEast: components["schemas"]["GeoCoordinate"];
|
|
8663
|
-
/** @description South-west corner. */
|
|
8664
|
-
southWest: components["schemas"]["GeoCoordinate"];
|
|
8665
|
-
};
|
|
8666
|
-
/** @description A geographic coordinate (latitude/longitude). */
|
|
8667
|
-
GeoCoordinate: {
|
|
8668
|
-
/**
|
|
8669
|
-
* Format: double
|
|
8670
|
-
* @description Latitude in decimal degrees (−90 to 90).
|
|
8671
|
-
*/
|
|
8672
|
-
lat: number;
|
|
8673
|
-
/**
|
|
8674
|
-
* Format: double
|
|
8675
|
-
* @description Longitude in decimal degrees (−180 to 180).
|
|
8676
|
-
*/
|
|
8677
|
-
lng: number;
|
|
8678
|
-
};
|
|
8679
|
-
/** @description Geospatial location variants. */
|
|
8680
|
-
GeospatialVariant: ({
|
|
8681
|
-
/** @constant */
|
|
8682
|
-
kind: "region";
|
|
8683
|
-
} & components["schemas"]["RegionData"]) | ({
|
|
8684
|
-
/** @constant */
|
|
8685
|
-
kind: "address";
|
|
8686
|
-
} & components["schemas"]["AddressData"]);
|
|
8687
|
-
/** @description A shell-style glob pattern. */
|
|
8688
|
-
GlobPattern: {
|
|
8689
|
-
/** @description The glob expression string. */
|
|
8690
|
-
expression: string;
|
|
8691
|
-
};
|
|
8692
8087
|
/**
|
|
8693
8088
|
* @description SHA-2 variant for the [`TextRedaction::Hash`] operator.
|
|
8694
8089
|
*
|
|
@@ -8727,7 +8122,7 @@ interface components {
|
|
|
8727
8122
|
*/
|
|
8728
8123
|
Hint: {
|
|
8729
8124
|
/** @description The hint text itself (a column header, a field name). */
|
|
8730
|
-
data: components["schemas"]["
|
|
8125
|
+
data: components["schemas"]["TextData"];
|
|
8731
8126
|
/** @description Where the hint text sits in the source (the header cell, the key). */
|
|
8732
8127
|
location: components["schemas"]["TextLocation"];
|
|
8733
8128
|
};
|
|
@@ -8750,7 +8145,7 @@ interface components {
|
|
|
8750
8145
|
*/
|
|
8751
8146
|
Hint2: {
|
|
8752
8147
|
/** @description The hint text itself (a column header, a field name). */
|
|
8753
|
-
data: components["schemas"]["
|
|
8148
|
+
data: components["schemas"]["TextData"];
|
|
8754
8149
|
/** @description Where the hint text sits in the source (the header cell, the key). */
|
|
8755
8150
|
location: components["schemas"]["TabularLocation"];
|
|
8756
8151
|
};
|
|
@@ -8773,7 +8168,7 @@ interface components {
|
|
|
8773
8168
|
*/
|
|
8774
8169
|
Hint3: {
|
|
8775
8170
|
/** @description The hint text itself (a column header, a field name). */
|
|
8776
|
-
data: components["schemas"]["
|
|
8171
|
+
data: components["schemas"]["ImageData"];
|
|
8777
8172
|
/** @description Where the hint text sits in the source (the header cell, the key). */
|
|
8778
8173
|
location: components["schemas"]["ImageLocation"];
|
|
8779
8174
|
};
|
|
@@ -8800,16 +8195,6 @@ interface components {
|
|
|
8800
8195
|
/** @description Where the hint text sits in the source (the header cell, the key). */
|
|
8801
8196
|
location: components["schemas"]["AudioLocation"];
|
|
8802
8197
|
};
|
|
8803
|
-
/** @description Reference image for object/scene matching. */
|
|
8804
|
-
ImageData: {
|
|
8805
|
-
/**
|
|
8806
|
-
* Format: uuid
|
|
8807
|
-
* @description Id of the file holding the reference image.
|
|
8808
|
-
*/
|
|
8809
|
-
imageSource: string;
|
|
8810
|
-
/** @description Optional sub-region within the image. */
|
|
8811
|
-
region?: components["schemas"]["BoundingBox"];
|
|
8812
|
-
};
|
|
8813
8198
|
/**
|
|
8814
8199
|
* @description Per-call payload a recognizer inspects for the [`Image`] modality.
|
|
8815
8200
|
*
|
|
@@ -8820,7 +8205,7 @@ interface components {
|
|
|
8820
8205
|
*
|
|
8821
8206
|
* [`Image`]: super::Image
|
|
8822
8207
|
*/
|
|
8823
|
-
|
|
8208
|
+
ImageData: {
|
|
8824
8209
|
/** @description Pixel dimensions of the encoded image. */
|
|
8825
8210
|
dimensions: components["schemas"]["Dimensions"];
|
|
8826
8211
|
/** @description Original filename, when known. */
|
|
@@ -8924,11 +8309,8 @@ interface components {
|
|
|
8924
8309
|
* @description When the invitation was last updated.
|
|
8925
8310
|
*/
|
|
8926
8311
|
updatedAt: string;
|
|
8927
|
-
/**
|
|
8928
|
-
|
|
8929
|
-
* @description ID of the workspace the invitation is for.
|
|
8930
|
-
*/
|
|
8931
|
-
workspaceId: string;
|
|
8312
|
+
/** @description Slug of the workspace the invitation is for. */
|
|
8313
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
8932
8314
|
};
|
|
8933
8315
|
/** @description Response containing a generated shareable invite code. */
|
|
8934
8316
|
InviteCode: {
|
|
@@ -8941,11 +8323,8 @@ interface components {
|
|
|
8941
8323
|
inviteCode: string;
|
|
8942
8324
|
/** @description Role assigned when someone joins via this code. */
|
|
8943
8325
|
role: components["schemas"]["WorkspaceRole"];
|
|
8944
|
-
/**
|
|
8945
|
-
|
|
8946
|
-
* @description ID of the workspace this invite code is for.
|
|
8947
|
-
*/
|
|
8948
|
-
workspaceId: string;
|
|
8326
|
+
/** @description Slug of the workspace this invite code is for. */
|
|
8327
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
8949
8328
|
};
|
|
8950
8329
|
/** @description Path parameters for joining via invite code. */
|
|
8951
8330
|
InviteCodePathParams: {
|
|
@@ -8954,12 +8333,7 @@ interface components {
|
|
|
8954
8333
|
};
|
|
8955
8334
|
/** @description Expiration options for invite codes. */
|
|
8956
8335
|
InviteExpiration: "in24Hours" | "in7Days" | "in30Days";
|
|
8957
|
-
/**
|
|
8958
|
-
* @description Path parameters for invite operations (invite ID only).
|
|
8959
|
-
*
|
|
8960
|
-
* Since invite IDs are globally unique UUIDs, workspace context can be
|
|
8961
|
-
* derived from the invite record itself for authorization purposes.
|
|
8962
|
-
*/
|
|
8336
|
+
/** @description Path parameters for invite operations. */
|
|
8963
8337
|
InvitePathParams: {
|
|
8964
8338
|
/**
|
|
8965
8339
|
* Format: uuid
|
|
@@ -8992,11 +8366,19 @@ interface components {
|
|
|
8992
8366
|
invitedRole: components["schemas"]["WorkspaceRole"];
|
|
8993
8367
|
/** @description Tags associated with the workspace. */
|
|
8994
8368
|
tags: string[];
|
|
8995
|
-
/**
|
|
8996
|
-
|
|
8997
|
-
|
|
8998
|
-
|
|
8999
|
-
|
|
8369
|
+
/** @description Slug of the workspace. */
|
|
8370
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
8371
|
+
};
|
|
8372
|
+
/**
|
|
8373
|
+
* @description Acknowledgement returned after sending a workspace invitation.
|
|
8374
|
+
*
|
|
8375
|
+
* The response is deliberately uniform: it carries no invite identifier or
|
|
8376
|
+
* status, so it is identical whether or not the address belonged to a known
|
|
8377
|
+
* account and cannot be used to probe for account existence.
|
|
8378
|
+
*/
|
|
8379
|
+
InviteSent: {
|
|
8380
|
+
/** @description Human-readable confirmation message. */
|
|
8381
|
+
detail: string;
|
|
9000
8382
|
};
|
|
9001
8383
|
/** @description Fields available for sorting workspace invites. */
|
|
9002
8384
|
InviteSortField: "email" | "date";
|
|
@@ -9233,49 +8615,38 @@ interface components {
|
|
|
9233
8615
|
};
|
|
9234
8616
|
/** @description Request payload for login. */
|
|
9235
8617
|
Login: {
|
|
9236
|
-
/**
|
|
9237
|
-
|
|
9238
|
-
* @description Email address of the account.
|
|
9239
|
-
*/
|
|
9240
|
-
emailAddress: string;
|
|
8618
|
+
/** @description Email address or username of the account. */
|
|
8619
|
+
identifier: string;
|
|
9241
8620
|
/** @description Password of the account. */
|
|
9242
8621
|
password: string;
|
|
9243
|
-
/**
|
|
8622
|
+
/**
|
|
8623
|
+
* @description Whether to remember this device for extended session. Defaults to false.
|
|
8624
|
+
* @default false
|
|
8625
|
+
*/
|
|
9244
8626
|
rememberMe: boolean;
|
|
9245
8627
|
};
|
|
9246
8628
|
/** @description Represents a workspace member. */
|
|
9247
8629
|
Member: {
|
|
9248
|
-
/**
|
|
9249
|
-
* Format: uuid
|
|
9250
|
-
* @description Account ID of the member.
|
|
9251
|
-
*/
|
|
9252
|
-
accountId: string;
|
|
9253
8630
|
/**
|
|
9254
8631
|
* Format: date-time
|
|
9255
8632
|
* @description Timestamp when the member joined the workspace.
|
|
9256
8633
|
*/
|
|
9257
8634
|
createdAt: string;
|
|
9258
|
-
/** @description Display name of the member. */
|
|
9259
|
-
displayName
|
|
8635
|
+
/** @description Display name of the member, when set. */
|
|
8636
|
+
displayName?: string;
|
|
9260
8637
|
/** @description Email address of the member. */
|
|
9261
8638
|
emailAddress: string;
|
|
9262
8639
|
/** @description Whether the member has two-factor authentication enabled. */
|
|
9263
8640
|
has2fa: boolean;
|
|
9264
8641
|
/** @description Role of the member in the workspace. */
|
|
9265
8642
|
memberRole: components["schemas"]["WorkspaceRole"];
|
|
8643
|
+
/** @description Handle of the member's account. */
|
|
8644
|
+
username: components["schemas"]["Username"];
|
|
9266
8645
|
};
|
|
9267
8646
|
/** @description Path parameters for workspace member operations. */
|
|
9268
8647
|
MemberPathParams: {
|
|
9269
|
-
/**
|
|
9270
|
-
|
|
9271
|
-
* @description Unique identifier of the member account.
|
|
9272
|
-
*/
|
|
9273
|
-
accountId: string;
|
|
9274
|
-
/**
|
|
9275
|
-
* Format: uuid
|
|
9276
|
-
* @description Unique identifier of the workspace.
|
|
9277
|
-
*/
|
|
9278
|
-
workspaceId: string;
|
|
8648
|
+
/** @description Public handle of the member's account. */
|
|
8649
|
+
username: components["schemas"]["Username"];
|
|
9279
8650
|
};
|
|
9280
8651
|
/** @description Fields available for sorting workspace members. */
|
|
9281
8652
|
MemberSortField: "name" | "date";
|
|
@@ -9376,9 +8747,9 @@ interface components {
|
|
|
9376
8747
|
* @description Defines the type of notification event sent to a user.
|
|
9377
8748
|
*
|
|
9378
8749
|
* This enumeration corresponds to the `NOTIFICATION_EVENT` PostgreSQL enum and is used
|
|
9379
|
-
* for various user notifications including
|
|
8750
|
+
* for various user notifications including file, member, connection, and system events.
|
|
9380
8751
|
*/
|
|
9381
|
-
NotificationEvent: "
|
|
8752
|
+
NotificationEvent: "file:uploaded" | "file:downloaded" | "file:verified" | "member:invited" | "member:joined" | "connection:synced" | "connection:desynced" | "system:announcement" | "system:report";
|
|
9382
8753
|
/** @description Response for notification settings within a workspace. */
|
|
9383
8754
|
NotificationSettings: {
|
|
9384
8755
|
/** @description Notification events to receive in-app. */
|
|
@@ -9436,22 +8807,6 @@ interface components {
|
|
|
9436
8807
|
/** @description Operator's version at the time it was applied. */
|
|
9437
8808
|
version: string;
|
|
9438
8809
|
};
|
|
9439
|
-
/**
|
|
9440
|
-
* @description A named pattern for detection matching.
|
|
9441
|
-
*
|
|
9442
|
-
* `label` describes the intent (for humans/LLMs); `pattern` carries
|
|
9443
|
-
* the expression and its type.
|
|
9444
|
-
*/
|
|
9445
|
-
PatternData: {
|
|
9446
|
-
/** @description Human-readable label describing what this pattern matches. */
|
|
9447
|
-
label: string;
|
|
9448
|
-
} & (({
|
|
9449
|
-
/** @constant */
|
|
9450
|
-
syntax: "regex";
|
|
9451
|
-
} & components["schemas"]["RegexPattern"]) | ({
|
|
9452
|
-
/** @constant */
|
|
9453
|
-
syntax: "glob";
|
|
9454
|
-
} & components["schemas"]["GlobPattern"]));
|
|
9455
8810
|
/** @description Detail of a pattern/dictionary recognition. */
|
|
9456
8811
|
PatternEvent: {
|
|
9457
8812
|
/**
|
|
@@ -9508,11 +8863,6 @@ interface components {
|
|
|
9508
8863
|
};
|
|
9509
8864
|
/** @description Pipeline response. */
|
|
9510
8865
|
Pipeline: {
|
|
9511
|
-
/**
|
|
9512
|
-
* Format: uuid
|
|
9513
|
-
* @description Account that created this pipeline.
|
|
9514
|
-
*/
|
|
9515
|
-
accountId: string;
|
|
9516
8866
|
/** @description Artifacts produced by pipeline runs. */
|
|
9517
8867
|
artifacts: components["schemas"]["Artifact"][];
|
|
9518
8868
|
/**
|
|
@@ -9520,17 +8870,16 @@ interface components {
|
|
|
9520
8870
|
* @description Timestamp when the pipeline was created.
|
|
9521
8871
|
*/
|
|
9522
8872
|
createdAt: string;
|
|
8873
|
+
/** @description Handle of the account that created this pipeline. */
|
|
8874
|
+
creatorUsername: components["schemas"]["Username"];
|
|
9523
8875
|
/** @description Detection + redaction configuration. */
|
|
9524
8876
|
definition: components["schemas"]["PipelineDefinition"];
|
|
9525
8877
|
/** @description Pipeline description. */
|
|
9526
8878
|
description?: string;
|
|
9527
8879
|
/** @description Pipeline name. */
|
|
9528
8880
|
name: string;
|
|
9529
|
-
/**
|
|
9530
|
-
|
|
9531
|
-
* @description Unique pipeline identifier.
|
|
9532
|
-
*/
|
|
9533
|
-
pipelineId: string;
|
|
8881
|
+
/** @description URL slug of the pipeline, unique within its workspace. */
|
|
8882
|
+
slug: components["schemas"]["Slug"];
|
|
9534
8883
|
/** @description Pipeline lifecycle status. */
|
|
9535
8884
|
status: components["schemas"]["PipelineStatus"];
|
|
9536
8885
|
/**
|
|
@@ -9538,11 +8887,8 @@ interface components {
|
|
|
9538
8887
|
* @description Timestamp when the pipeline was last updated.
|
|
9539
8888
|
*/
|
|
9540
8889
|
updatedAt: string;
|
|
9541
|
-
/**
|
|
9542
|
-
|
|
9543
|
-
* @description Workspace this pipeline belongs to.
|
|
9544
|
-
*/
|
|
9545
|
-
workspaceId: string;
|
|
8890
|
+
/** @description Slug of the workspace this pipeline belongs to. */
|
|
8891
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
9546
8892
|
};
|
|
9547
8893
|
/**
|
|
9548
8894
|
* @description Reusable detection + redaction configuration for a pipeline.
|
|
@@ -9557,17 +8903,10 @@ interface components {
|
|
|
9557
8903
|
* - `recognizers` / `enrichers` / `deduplication` / `label_catalog` — the
|
|
9558
8904
|
* detection machinery, assembled into an engine `AnalyzerParams` per request.
|
|
9559
8905
|
* - `default_scope` — optional pipeline-wide scope a document may override.
|
|
9560
|
-
* - `
|
|
9561
|
-
*
|
|
8906
|
+
* - `policy_slugs` — references to the workspace's policies, resolved at run
|
|
8907
|
+
* time.
|
|
9562
8908
|
*/
|
|
9563
8909
|
PipelineDefinition: {
|
|
9564
|
-
/**
|
|
9565
|
-
* @description Workspace contexts supplied to detection, resolved live by id.
|
|
9566
|
-
*
|
|
9567
|
-
* Stored relationally in the `workspace_pipeline_contexts` join table, not the JSON
|
|
9568
|
-
* definition; surfaced here so the API exposes one coherent object.
|
|
9569
|
-
*/
|
|
9570
|
-
contextIds?: string[];
|
|
9571
8910
|
/**
|
|
9572
8911
|
* @description Post-recognition deduplication pipeline.
|
|
9573
8912
|
* @default {
|
|
@@ -9597,12 +8936,12 @@ interface components {
|
|
|
9597
8936
|
*/
|
|
9598
8937
|
labelCatalog: components["schemas"]["LabelCatalogParams"];
|
|
9599
8938
|
/**
|
|
9600
|
-
* @description
|
|
8939
|
+
* @description Slugs of workspace policies applied at redaction.
|
|
9601
8940
|
*
|
|
9602
8941
|
* Stored relationally in the `workspace_pipeline_policies` join table, not the JSON
|
|
9603
8942
|
* definition; surfaced here so the API exposes one coherent object.
|
|
9604
8943
|
*/
|
|
9605
|
-
|
|
8944
|
+
policySlugs?: components["schemas"]["Slug"][];
|
|
9606
8945
|
/**
|
|
9607
8946
|
* @description Recognizer lineup: pattern (incl. inline custom rules and
|
|
9608
8947
|
* dictionaries), plus the NER and LLM toggles.
|
|
@@ -9617,26 +8956,18 @@ interface components {
|
|
|
9617
8956
|
/** @description Filter by pipeline status. */
|
|
9618
8957
|
status?: components["schemas"]["PipelineStatus"];
|
|
9619
8958
|
};
|
|
8959
|
+
/** @description Path parameters for pipeline operations. */
|
|
8960
|
+
PipelinePathParams: {
|
|
8961
|
+
/** @description URL slug of the pipeline, unique within its workspace. */
|
|
8962
|
+
pipelineSlug: string;
|
|
8963
|
+
};
|
|
9620
8964
|
/**
|
|
9621
|
-
* @description
|
|
8965
|
+
* @description Response type for a pipeline run.
|
|
9622
8966
|
*
|
|
9623
|
-
*
|
|
9624
|
-
*
|
|
8967
|
+
* A run is addressed by its own opaque id; the owning pipeline and workspace
|
|
8968
|
+
* slugs are carried for context.
|
|
9625
8969
|
*/
|
|
9626
|
-
PipelinePathParams: {
|
|
9627
|
-
/**
|
|
9628
|
-
* Format: uuid
|
|
9629
|
-
* @description Unique identifier of the pipeline.
|
|
9630
|
-
*/
|
|
9631
|
-
pipelineId: string;
|
|
9632
|
-
};
|
|
9633
|
-
/** @description Response type for a pipeline run. */
|
|
9634
8970
|
PipelineRun: {
|
|
9635
|
-
/**
|
|
9636
|
-
* Format: uuid
|
|
9637
|
-
* @description Account that triggered the run (optional).
|
|
9638
|
-
*/
|
|
9639
|
-
accountId?: string;
|
|
9640
8971
|
/**
|
|
9641
8972
|
* Format: date-time
|
|
9642
8973
|
* @description When the run completed.
|
|
@@ -9647,18 +8978,12 @@ interface components {
|
|
|
9647
8978
|
* @description File this run analyzes / redacts.
|
|
9648
8979
|
*/
|
|
9649
8980
|
fileId: string;
|
|
9650
|
-
/**
|
|
9651
|
-
|
|
9652
|
-
* @description Unique run identifier.
|
|
9653
|
-
*/
|
|
9654
|
-
id: string;
|
|
8981
|
+
/** @description Opaque identifier of the run. */
|
|
8982
|
+
id: components["schemas"]["RunId"];
|
|
9655
8983
|
/** @description Non-encrypted metadata for filtering/display. */
|
|
9656
8984
|
metadata: unknown;
|
|
9657
|
-
/**
|
|
9658
|
-
|
|
9659
|
-
* @description Pipeline this run belongs to.
|
|
9660
|
-
*/
|
|
9661
|
-
pipelineId: string;
|
|
8985
|
+
/** @description Slug of the pipeline this run belongs to. */
|
|
8986
|
+
pipelineSlug: components["schemas"]["Slug"];
|
|
9662
8987
|
/**
|
|
9663
8988
|
* Format: date-time
|
|
9664
8989
|
* @description When the run started.
|
|
@@ -9667,20 +8992,21 @@ interface components {
|
|
|
9667
8992
|
/**
|
|
9668
8993
|
* @description Current run status.
|
|
9669
8994
|
*
|
|
9670
|
-
* The
|
|
9671
|
-
* once this reaches `analyzed`.
|
|
8995
|
+
* The detections are available to fetch from the run's `detections`
|
|
8996
|
+
* endpoint once this reaches `analyzed`.
|
|
9672
8997
|
*/
|
|
9673
8998
|
status: components["schemas"]["PipelineRunStatus"];
|
|
9674
8999
|
/** @description How the run was triggered. */
|
|
9675
9000
|
triggerType: components["schemas"]["PipelineTriggerType"];
|
|
9001
|
+
/** @description Handle of the account that triggered the run, if any. */
|
|
9002
|
+
triggerUsername?: components["schemas"]["Username"];
|
|
9003
|
+
/** @description Slug of the workspace this run belongs to. */
|
|
9004
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
9676
9005
|
};
|
|
9677
9006
|
/** @description Path parameters for pipeline run operations. */
|
|
9678
9007
|
PipelineRunPathParams: {
|
|
9679
|
-
/**
|
|
9680
|
-
|
|
9681
|
-
* @description Unique identifier of the pipeline run.
|
|
9682
|
-
*/
|
|
9683
|
-
runId: string;
|
|
9008
|
+
/** @description Opaque identifier of the run. */
|
|
9009
|
+
runId: components["schemas"]["RunId"];
|
|
9684
9010
|
};
|
|
9685
9011
|
/**
|
|
9686
9012
|
* @description Defines the execution status of a pipeline run.
|
|
@@ -9725,11 +9051,8 @@ interface components {
|
|
|
9725
9051
|
description?: string;
|
|
9726
9052
|
/** @description Pipeline name. */
|
|
9727
9053
|
name: string;
|
|
9728
|
-
/**
|
|
9729
|
-
|
|
9730
|
-
* @description Unique pipeline identifier.
|
|
9731
|
-
*/
|
|
9732
|
-
pipelineId: string;
|
|
9054
|
+
/** @description URL slug of the pipeline, unique within its workspace. */
|
|
9055
|
+
slug: components["schemas"]["Slug"];
|
|
9733
9056
|
/** @description Pipeline lifecycle status. */
|
|
9734
9057
|
status: components["schemas"]["PipelineStatus"];
|
|
9735
9058
|
/**
|
|
@@ -9838,27 +9161,21 @@ interface components {
|
|
|
9838
9161
|
};
|
|
9839
9162
|
/** @description Response type for a workspace policy. */
|
|
9840
9163
|
Policy2: {
|
|
9841
|
-
/**
|
|
9842
|
-
* Format: uuid
|
|
9843
|
-
* @description Account that created this policy.
|
|
9844
|
-
*/
|
|
9845
|
-
accountId: string;
|
|
9846
9164
|
/**
|
|
9847
9165
|
* Format: date-time
|
|
9848
9166
|
* @description When the policy was created.
|
|
9849
9167
|
*/
|
|
9850
9168
|
createdAt: string;
|
|
9169
|
+
/** @description Handle of the account that created this policy. */
|
|
9170
|
+
creatorUsername: components["schemas"]["Username"];
|
|
9851
9171
|
/** @description The structured policy body consumed by the engine. */
|
|
9852
9172
|
definition: components["schemas"]["Policy"];
|
|
9853
9173
|
/** @description Policy description. */
|
|
9854
9174
|
description?: string;
|
|
9855
|
-
/**
|
|
9856
|
-
* Format: uuid
|
|
9857
|
-
* @description Unique policy identifier.
|
|
9858
|
-
*/
|
|
9859
|
-
id: string;
|
|
9860
9175
|
/** @description Human-readable policy name. */
|
|
9861
9176
|
name: string;
|
|
9177
|
+
/** @description URL slug of the policy, unique within its workspace. */
|
|
9178
|
+
slug: components["schemas"]["Slug"];
|
|
9862
9179
|
/**
|
|
9863
9180
|
* Format: date-time
|
|
9864
9181
|
* @description When the policy was last updated.
|
|
@@ -9866,22 +9183,21 @@ interface components {
|
|
|
9866
9183
|
updatedAt: string;
|
|
9867
9184
|
/** @description Semver of the policy body. */
|
|
9868
9185
|
version: string;
|
|
9869
|
-
/**
|
|
9870
|
-
|
|
9871
|
-
* @description Workspace this policy belongs to.
|
|
9872
|
-
*/
|
|
9873
|
-
workspaceId: string;
|
|
9186
|
+
/** @description Slug of the workspace this policy belongs to. */
|
|
9187
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
9874
9188
|
};
|
|
9875
9189
|
/**
|
|
9876
|
-
* @description What a rule does when its [`predicate`]
|
|
9877
|
-
*
|
|
9190
|
+
* @description What a rule does when its [`predicate`] matches.
|
|
9191
|
+
*
|
|
9192
|
+
* Three verbs: [`Redact`] transforms the entity with one operator
|
|
9193
|
+
* per modality; [`Suppress`] drops the entity entirely (false-positive
|
|
9194
|
+
* marker) and stamps a reason onto the audit; [`Audit`] flags it for
|
|
9195
|
+
* human review without transforming.
|
|
9878
9196
|
*
|
|
9879
|
-
*
|
|
9880
|
-
*
|
|
9881
|
-
* [`Suppress`]
|
|
9882
|
-
*
|
|
9883
|
-
* [`Audit`](PolicyAction::Audit) flags it for human review without
|
|
9884
|
-
* transforming.
|
|
9197
|
+
* [`predicate`]: PolicyRule::predicate
|
|
9198
|
+
* [`Redact`]: PolicyAction::Redact
|
|
9199
|
+
* [`Suppress`]: PolicyAction::Suppress
|
|
9200
|
+
* [`Audit`]: PolicyAction::Audit
|
|
9885
9201
|
*/
|
|
9886
9202
|
PolicyAction: ({
|
|
9887
9203
|
/** @constant */
|
|
@@ -9893,13 +9209,17 @@ interface components {
|
|
|
9893
9209
|
/** @constant */
|
|
9894
9210
|
kind: "audit";
|
|
9895
9211
|
} & components["schemas"]["AuditAction"]);
|
|
9896
|
-
/**
|
|
9212
|
+
/**
|
|
9213
|
+
* @description Path parameters for policy operations.
|
|
9214
|
+
*
|
|
9215
|
+
* The workspace is resolved by the [`WorkspaceContext`] extractor from the
|
|
9216
|
+
* `{workspaceSlug}` path segment.
|
|
9217
|
+
*
|
|
9218
|
+
* [`WorkspaceContext`]: crate::extract::WorkspaceContext
|
|
9219
|
+
*/
|
|
9897
9220
|
PolicyPathParams: {
|
|
9898
|
-
/**
|
|
9899
|
-
|
|
9900
|
-
* @description Unique identifier of the policy.
|
|
9901
|
-
*/
|
|
9902
|
-
policyId: string;
|
|
9221
|
+
/** @description URL slug of the policy, unique within its workspace. */
|
|
9222
|
+
policySlug: string;
|
|
9903
9223
|
};
|
|
9904
9224
|
/**
|
|
9905
9225
|
* @description One rule inside a [`Policy`]. Identity is the UUID; `name` /
|
|
@@ -10105,6 +9425,23 @@ interface components {
|
|
|
10105
9425
|
/** @description Events, in the order they happened. */
|
|
10106
9426
|
events: components["schemas"]["Event4"][];
|
|
10107
9427
|
};
|
|
9428
|
+
/**
|
|
9429
|
+
* @description Public view of an account, returned when looking up someone other than the
|
|
9430
|
+
* authenticated caller. Carries only the fields safe to share with a
|
|
9431
|
+
* workspace peer; private details (email, account flags) are omitted
|
|
9432
|
+
* and remain available solely through the caller's own `/account/` view.
|
|
9433
|
+
*/
|
|
9434
|
+
PublicAccount: {
|
|
9435
|
+
/**
|
|
9436
|
+
* Format: date-time
|
|
9437
|
+
* @description Timestamp when the account was created.
|
|
9438
|
+
*/
|
|
9439
|
+
createdAt: string;
|
|
9440
|
+
/** @description Display name of the account holder, when set. */
|
|
9441
|
+
displayName?: string;
|
|
9442
|
+
/** @description Public handle of the account. */
|
|
9443
|
+
username: components["schemas"]["Username"];
|
|
9444
|
+
};
|
|
10108
9445
|
Range_of_uint: {
|
|
10109
9446
|
/** Format: uint */
|
|
10110
9447
|
end: number;
|
|
@@ -10182,48 +9519,6 @@ interface components {
|
|
|
10182
9519
|
*/
|
|
10183
9520
|
pattern?: components["schemas"]["PatternRecognizerParams"];
|
|
10184
9521
|
};
|
|
10185
|
-
/** @description Direct comparison reference variants. */
|
|
10186
|
-
ReferenceVariant: ({
|
|
10187
|
-
/** @constant */
|
|
10188
|
-
kind: "text";
|
|
10189
|
-
} & components["schemas"]["TextData"]) | ({
|
|
10190
|
-
/** @constant */
|
|
10191
|
-
kind: "tag";
|
|
10192
|
-
} & components["schemas"]["TagData"]) | ({
|
|
10193
|
-
/** @constant */
|
|
10194
|
-
kind: "credential";
|
|
10195
|
-
} & components["schemas"]["CredentialData"]) | ({
|
|
10196
|
-
/** @constant */
|
|
10197
|
-
kind: "image";
|
|
10198
|
-
} & components["schemas"]["ImageData"]);
|
|
10199
|
-
/** @description A regular expression pattern. */
|
|
10200
|
-
RegexPattern: {
|
|
10201
|
-
/** @description The regex expression string. */
|
|
10202
|
-
expression: string;
|
|
10203
|
-
};
|
|
10204
|
-
/** @description Geospatial region reference data for location-based detection. */
|
|
10205
|
-
RegionData: {
|
|
10206
|
-
/** @description Optional human-readable name for this region. */
|
|
10207
|
-
name?: string;
|
|
10208
|
-
} & (({
|
|
10209
|
-
/** @constant */
|
|
10210
|
-
shape: "bounds";
|
|
10211
|
-
} & components["schemas"]["GeoBounds"]) | {
|
|
10212
|
-
/** @description Center of the circle. */
|
|
10213
|
-
center: components["schemas"]["GeoCoordinate"];
|
|
10214
|
-
/**
|
|
10215
|
-
* Format: double
|
|
10216
|
-
* @description Radius in meters.
|
|
10217
|
-
*/
|
|
10218
|
-
radius_m: number;
|
|
10219
|
-
/** @constant */
|
|
10220
|
-
shape: "circle";
|
|
10221
|
-
} | {
|
|
10222
|
-
/** @description Boundary vertices in order (x = lng, y = lat). */
|
|
10223
|
-
boundary: components["schemas"]["Polygon"];
|
|
10224
|
-
/** @constant */
|
|
10225
|
-
shape: "polygon";
|
|
10226
|
-
});
|
|
10227
9522
|
/** @description Request to respond to a workspace invitation. */
|
|
10228
9523
|
ReplyInvite: {
|
|
10229
9524
|
/** @description Whether to accept or decline the invitation. */
|
|
@@ -10285,6 +9580,8 @@ interface components {
|
|
|
10285
9580
|
} | {
|
|
10286
9581
|
tag: string;
|
|
10287
9582
|
} | "predicate" | "fallback";
|
|
9583
|
+
/** @description Opaque run identifier (run_<uuid>). */
|
|
9584
|
+
RunId: string;
|
|
10288
9585
|
/**
|
|
10289
9586
|
* @description Caller-asserted scope shared across every payload of one analysis.
|
|
10290
9587
|
*
|
|
@@ -10405,24 +9702,10 @@ interface components {
|
|
|
10405
9702
|
*/
|
|
10406
9703
|
tags?: string[];
|
|
10407
9704
|
};
|
|
10408
|
-
/** @description Reference handwritten signature for verification. */
|
|
10409
|
-
SignatureData: {
|
|
10410
|
-
/** @description Algorithm used for signature verification. */
|
|
10411
|
-
algorithm?: string;
|
|
10412
|
-
/**
|
|
10413
|
-
* Format: uuid
|
|
10414
|
-
* @description Id of the file holding the reference signature image.
|
|
10415
|
-
*/
|
|
10416
|
-
imageSource: string;
|
|
10417
|
-
/** @description Bounding box of the signature within the image. */
|
|
10418
|
-
region?: components["schemas"]["BoundingBox"];
|
|
10419
|
-
/** @description Identity of the signer this signature belongs to. */
|
|
10420
|
-
signerId?: string;
|
|
10421
|
-
};
|
|
10422
9705
|
/** @description Request payload for signup. */
|
|
10423
9706
|
Signup: {
|
|
10424
|
-
/** @description
|
|
10425
|
-
displayName
|
|
9707
|
+
/** @description Optional display name of the account. */
|
|
9708
|
+
displayName?: string;
|
|
10426
9709
|
/**
|
|
10427
9710
|
* Format: email
|
|
10428
9711
|
* @description Email address of the account.
|
|
@@ -10430,8 +9713,23 @@ interface components {
|
|
|
10430
9713
|
emailAddress: string;
|
|
10431
9714
|
/** @description Password of the account. */
|
|
10432
9715
|
password: string;
|
|
10433
|
-
/**
|
|
9716
|
+
/**
|
|
9717
|
+
* @description Whether to remember the device for extended session. Defaults to false.
|
|
9718
|
+
* @default false
|
|
9719
|
+
*/
|
|
10434
9720
|
rememberMe: boolean;
|
|
9721
|
+
/** @description Public account handle, unique across all accounts. */
|
|
9722
|
+
username: components["schemas"]["Username"];
|
|
9723
|
+
};
|
|
9724
|
+
/** @description Lowercase, dash-separated resource identifier used in URLs. */
|
|
9725
|
+
Slug: string;
|
|
9726
|
+
/**
|
|
9727
|
+
* @description The `{workspaceSlug}` path segment. Named to match the OpenAPI parameter and
|
|
9728
|
+
* the route definition.
|
|
9729
|
+
*/
|
|
9730
|
+
SlugParam: {
|
|
9731
|
+
/** @description URL-safe workspace identifier. */
|
|
9732
|
+
workspaceSlug: string;
|
|
10435
9733
|
};
|
|
10436
9734
|
/** @description Sort order direction. */
|
|
10437
9735
|
SortOrder: "asc" | "desc";
|
|
@@ -10523,44 +9821,6 @@ interface components {
|
|
|
10523
9821
|
/** @constant */
|
|
10524
9822
|
kind: "drop_column";
|
|
10525
9823
|
};
|
|
10526
|
-
/** @description A keyword tag for classification and routing. */
|
|
10527
|
-
TagData: {
|
|
10528
|
-
/** @description Optional category grouping related tags. */
|
|
10529
|
-
category?: string;
|
|
10530
|
-
/** @description The tag value (e.g. `"pii"`, `"financial"`, `"hipaa"`). */
|
|
10531
|
-
value: string;
|
|
10532
|
-
};
|
|
10533
|
-
/**
|
|
10534
|
-
* @description Reference document template for layout/type classification.
|
|
10535
|
-
*
|
|
10536
|
-
* Used to detect documents of a known type (ID cards, passports, forms,
|
|
10537
|
-
* invoices) by comparing their visual layout against this reference.
|
|
10538
|
-
*/
|
|
10539
|
-
TemplateData: {
|
|
10540
|
-
/** @description Document type label (e.g. `"passport"`, `"drivers_license"`, `"invoice"`). */
|
|
10541
|
-
documentType?: string;
|
|
10542
|
-
/**
|
|
10543
|
-
* Format: uuid
|
|
10544
|
-
* @description Id of the file holding the reference template image.
|
|
10545
|
-
*/
|
|
10546
|
-
imageSource: string;
|
|
10547
|
-
/** @description Optional sub-region of interest within the template. */
|
|
10548
|
-
region?: components["schemas"]["BoundingBox"];
|
|
10549
|
-
};
|
|
10550
|
-
/** @description Temporal matching variants. */
|
|
10551
|
-
TemporalVariant: ({
|
|
10552
|
-
/** @constant */
|
|
10553
|
-
kind: "date";
|
|
10554
|
-
} & components["schemas"]["DateData"]) | ({
|
|
10555
|
-
/** @constant */
|
|
10556
|
-
kind: "time";
|
|
10557
|
-
} & components["schemas"]["TimeData"]) | ({
|
|
10558
|
-
/** @constant */
|
|
10559
|
-
kind: "date_time";
|
|
10560
|
-
} & components["schemas"]["DateTimeData"]) | ({
|
|
10561
|
-
/** @constant */
|
|
10562
|
-
kind: "time_span";
|
|
10563
|
-
} & components["schemas"]["TimeSpanData"]);
|
|
10564
9824
|
/** @description Request payload for testing a webhook. */
|
|
10565
9825
|
TestWebhook: {
|
|
10566
9826
|
/**
|
|
@@ -10569,18 +9829,6 @@ interface components {
|
|
|
10569
9829
|
*/
|
|
10570
9830
|
payload?: unknown;
|
|
10571
9831
|
};
|
|
10572
|
-
/**
|
|
10573
|
-
* @description Textual reference data as key-value pairs.
|
|
10574
|
-
*
|
|
10575
|
-
* Keys describe *what* a value represents (for humans and LLMs);
|
|
10576
|
-
* values are the literal strings used for matching.
|
|
10577
|
-
*/
|
|
10578
|
-
TextData: {
|
|
10579
|
-
/** @description Key-value pairs for matching. */
|
|
10580
|
-
entries?: components["schemas"]["TextEntry"][];
|
|
10581
|
-
/** @description BCP-47 language tag for locale-sensitive matching. */
|
|
10582
|
-
language?: components["schemas"]["LanguageTag"];
|
|
10583
|
-
};
|
|
10584
9832
|
/**
|
|
10585
9833
|
* @description Run of text.
|
|
10586
9834
|
*
|
|
@@ -10591,20 +9839,7 @@ interface components {
|
|
|
10591
9839
|
* refcounted buffer, making cheap clones when one payload is passed to
|
|
10592
9840
|
* several recognizers.
|
|
10593
9841
|
*/
|
|
10594
|
-
|
|
10595
|
-
/**
|
|
10596
|
-
* @description A labeled text value for reference matching.
|
|
10597
|
-
*
|
|
10598
|
-
* The `key` is a human/LLM-readable label describing what this value
|
|
10599
|
-
* represents (e.g. `"full_name"`, `"account_number"`). The `value` is
|
|
10600
|
-
* the literal string used for pattern matching.
|
|
10601
|
-
*/
|
|
10602
|
-
TextEntry: {
|
|
10603
|
-
/** @description Human/LLM-readable label. */
|
|
10604
|
-
key: string;
|
|
10605
|
-
/** @description Literal value for pattern matching. */
|
|
10606
|
-
value: string;
|
|
10607
|
-
};
|
|
9842
|
+
TextData: string;
|
|
10608
9843
|
/**
|
|
10609
9844
|
* @description Half-open `[start, end)` byte range within text content.
|
|
10610
9845
|
*
|
|
@@ -10688,20 +9923,6 @@ interface components {
|
|
|
10688
9923
|
* labels.
|
|
10689
9924
|
*/
|
|
10690
9925
|
TiebreakerParams: "highest_confidence" | "longest_span";
|
|
10691
|
-
/**
|
|
10692
|
-
* @description A time-of-day or time range reference for temporal matching.
|
|
10693
|
-
*
|
|
10694
|
-
* Uses naive (timezone-unaware) times from [`Time`].
|
|
10695
|
-
* Useful for matching recurring time patterns (e.g. business hours).
|
|
10696
|
-
*
|
|
10697
|
-
* [`Time`]: jiff::civil::Time
|
|
10698
|
-
*/
|
|
10699
|
-
TimeData: {
|
|
10700
|
-
/** @description End time for a range. When `None` this represents a single time. */
|
|
10701
|
-
end?: string;
|
|
10702
|
-
/** @description Start (or only) time. */
|
|
10703
|
-
start: string;
|
|
10704
|
-
};
|
|
10705
9926
|
/**
|
|
10706
9927
|
* @description Half-open `[start, end)` stream interval, measured in microseconds.
|
|
10707
9928
|
*
|
|
@@ -10734,13 +9955,6 @@ interface components {
|
|
|
10734
9955
|
*/
|
|
10735
9956
|
start_us: number;
|
|
10736
9957
|
};
|
|
10737
|
-
/** @description A time span reference for matching audio/video segments. */
|
|
10738
|
-
TimeSpanData: {
|
|
10739
|
-
/** @description Optional human-readable label (e.g. `"intro"`, `"closing remarks"`). */
|
|
10740
|
-
label?: string;
|
|
10741
|
-
/** @description The time interval to match. */
|
|
10742
|
-
span: components["schemas"]["TimeSpan"];
|
|
10743
|
-
};
|
|
10744
9958
|
/** @description Expiration options for API tokens. */
|
|
10745
9959
|
TokenExpiration: "never" | "in7Days" | "in30Days" | "in90Days" | "in1Year";
|
|
10746
9960
|
/**
|
|
@@ -10766,9 +9980,7 @@ interface components {
|
|
|
10766
9980
|
};
|
|
10767
9981
|
/** @description Request payload to update an account. */
|
|
10768
9982
|
UpdateAccount: {
|
|
10769
|
-
/** @description
|
|
10770
|
-
companyName?: string;
|
|
10771
|
-
/** @description New display name (2-100 characters). */
|
|
9983
|
+
/** @description New display name (2-32 characters). */
|
|
10772
9984
|
displayName?: string;
|
|
10773
9985
|
/**
|
|
10774
9986
|
* Format: email
|
|
@@ -10777,6 +9989,8 @@ interface components {
|
|
|
10777
9989
|
emailAddress?: string;
|
|
10778
9990
|
/** @description New password (will be hashed before storage). */
|
|
10779
9991
|
password?: string;
|
|
9992
|
+
/** @description New account handle. */
|
|
9993
|
+
username?: components["schemas"]["Username"];
|
|
10780
9994
|
};
|
|
10781
9995
|
/** @description Request to update an existing API token. */
|
|
10782
9996
|
UpdateApiToken: {
|
|
@@ -10793,19 +10007,6 @@ interface components {
|
|
|
10793
10007
|
/** @description Human-readable connection name. */
|
|
10794
10008
|
name?: string;
|
|
10795
10009
|
};
|
|
10796
|
-
/**
|
|
10797
|
-
* @description Request payload for updating an existing workspace context.
|
|
10798
|
-
*
|
|
10799
|
-
* Replacing the `definition` replaces the whole context body.
|
|
10800
|
-
*/
|
|
10801
|
-
UpdateContext: {
|
|
10802
|
-
/** @description New context body (replaces the stored definition). */
|
|
10803
|
-
definition?: components["schemas"]["Context"];
|
|
10804
|
-
/** @description Context description. */
|
|
10805
|
-
description?: string;
|
|
10806
|
-
/** @description Human-readable context name. */
|
|
10807
|
-
name?: string;
|
|
10808
|
-
};
|
|
10809
10010
|
/** @description Request to update file metadata. */
|
|
10810
10011
|
UpdateFile: {
|
|
10811
10012
|
/** @description New display name for the file. */
|
|
@@ -10881,18 +10082,19 @@ interface components {
|
|
|
10881
10082
|
/**
|
|
10882
10083
|
* @description Request payload to update an existing workspace.
|
|
10883
10084
|
*
|
|
10884
|
-
* All fields are optional; only provided fields will be updated.
|
|
10085
|
+
* All fields are optional; only provided fields will be updated. The slug is
|
|
10086
|
+
* immutable and set at creation, so it cannot be changed here.
|
|
10885
10087
|
*/
|
|
10886
10088
|
UpdateWorkspace: {
|
|
10887
10089
|
/** @description New description for the workspace (max 500 characters). */
|
|
10888
10090
|
description?: string;
|
|
10889
|
-
/** @description New display name for the workspace (3-
|
|
10091
|
+
/** @description New display name for the workspace (3-32 characters). */
|
|
10890
10092
|
displayName?: string;
|
|
10891
|
-
/** @description Whether comments are enabled for this workspace. */
|
|
10892
|
-
enableComments?: boolean;
|
|
10893
10093
|
/** @description Whether approval is required for processed files to be visible. */
|
|
10894
10094
|
requireApproval?: boolean;
|
|
10895
10095
|
};
|
|
10096
|
+
/** @description Public account handle used in URLs (e.g. /accounts/{username}). */
|
|
10097
|
+
Username: string;
|
|
10896
10098
|
/** @description Validation error details for field-specific errors. */
|
|
10897
10099
|
ValidationErrorDetail: {
|
|
10898
10100
|
/** @description Error code for the validation failure */
|
|
@@ -10911,20 +10113,6 @@ interface components {
|
|
|
10911
10113
|
/** @description The API version string (e.g., "v1", "v2"). */
|
|
10912
10114
|
version: string;
|
|
10913
10115
|
};
|
|
10914
|
-
/** @description Reference voice data for speaker identification. */
|
|
10915
|
-
VoiceData: {
|
|
10916
|
-
/** @description Algorithm that produced the voiceprint (e.g. `"ecapa-tdnn"`, `"x-vector"`). */
|
|
10917
|
-
algorithm?: string;
|
|
10918
|
-
/**
|
|
10919
|
-
* Format: uuid
|
|
10920
|
-
* @description Id of the file holding the reference audio.
|
|
10921
|
-
*/
|
|
10922
|
-
audioSource: string;
|
|
10923
|
-
/** @description Segment within the audio used for enrollment. */
|
|
10924
|
-
segment?: components["schemas"]["TimeSpan"];
|
|
10925
|
-
/** @description Base64-encoded speaker embedding / voiceprint. */
|
|
10926
|
-
template?: string;
|
|
10927
|
-
};
|
|
10928
10116
|
/** @description Shape of a synthesized tone. */
|
|
10929
10117
|
Waveform: "sine" | "square";
|
|
10930
10118
|
/** @description Workspace webhook response. */
|
|
@@ -10934,11 +10122,8 @@ interface components {
|
|
|
10934
10122
|
* @description Timestamp when this webhook was first created.
|
|
10935
10123
|
*/
|
|
10936
10124
|
createdAt: string;
|
|
10937
|
-
/**
|
|
10938
|
-
|
|
10939
|
-
* @description Account that originally created this webhook.
|
|
10940
|
-
*/
|
|
10941
|
-
createdBy: string;
|
|
10125
|
+
/** @description Handle of the account that created this webhook. */
|
|
10126
|
+
creatorUsername: components["schemas"]["Username"];
|
|
10942
10127
|
/** @description Detailed description of the webhook's purpose. */
|
|
10943
10128
|
description: string;
|
|
10944
10129
|
/** @description Human-readable name for the webhook. */
|
|
@@ -10949,6 +10134,8 @@ interface components {
|
|
|
10949
10134
|
headers: {
|
|
10950
10135
|
[key: string]: string;
|
|
10951
10136
|
};
|
|
10137
|
+
/** @description Opaque identifier of the webhook. */
|
|
10138
|
+
id: components["schemas"]["WebhookId"];
|
|
10952
10139
|
/**
|
|
10953
10140
|
* Format: date-time
|
|
10954
10141
|
* @description Timestamp of the most recent webhook trigger.
|
|
@@ -10963,16 +10150,8 @@ interface components {
|
|
|
10963
10150
|
updatedAt: string;
|
|
10964
10151
|
/** @description The URL to send webhook payloads to. */
|
|
10965
10152
|
url: string;
|
|
10966
|
-
/**
|
|
10967
|
-
|
|
10968
|
-
* @description Unique webhook identifier.
|
|
10969
|
-
*/
|
|
10970
|
-
webhookId: string;
|
|
10971
|
-
/**
|
|
10972
|
-
* Format: uuid
|
|
10973
|
-
* @description Reference to the workspace this webhook belongs to.
|
|
10974
|
-
*/
|
|
10975
|
-
workspaceId: string;
|
|
10153
|
+
/** @description Slug of the workspace this webhook belongs to. */
|
|
10154
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
10976
10155
|
};
|
|
10977
10156
|
/**
|
|
10978
10157
|
* @description Webhook creation response that includes the secret (visible only once).
|
|
@@ -10987,11 +10166,8 @@ interface components {
|
|
|
10987
10166
|
* @description Timestamp when this webhook was first created.
|
|
10988
10167
|
*/
|
|
10989
10168
|
createdAt: string;
|
|
10990
|
-
/**
|
|
10991
|
-
|
|
10992
|
-
* @description Account that originally created this webhook.
|
|
10993
|
-
*/
|
|
10994
|
-
createdBy: string;
|
|
10169
|
+
/** @description Handle of the account that created this webhook. */
|
|
10170
|
+
creatorUsername: components["schemas"]["Username"];
|
|
10995
10171
|
/** @description Detailed description of the webhook's purpose. */
|
|
10996
10172
|
description: string;
|
|
10997
10173
|
/** @description Human-readable name for the webhook. */
|
|
@@ -11002,6 +10178,8 @@ interface components {
|
|
|
11002
10178
|
headers: {
|
|
11003
10179
|
[key: string]: string;
|
|
11004
10180
|
};
|
|
10181
|
+
/** @description Opaque identifier of the webhook. */
|
|
10182
|
+
id: components["schemas"]["WebhookId"];
|
|
11005
10183
|
/**
|
|
11006
10184
|
* Format: date-time
|
|
11007
10185
|
* @description Timestamp of the most recent webhook trigger.
|
|
@@ -11023,16 +10201,8 @@ interface components {
|
|
|
11023
10201
|
updatedAt: string;
|
|
11024
10202
|
/** @description The URL to send webhook payloads to. */
|
|
11025
10203
|
url: string;
|
|
11026
|
-
/**
|
|
11027
|
-
|
|
11028
|
-
* @description Unique webhook identifier.
|
|
11029
|
-
*/
|
|
11030
|
-
webhookId: string;
|
|
11031
|
-
/**
|
|
11032
|
-
* Format: uuid
|
|
11033
|
-
* @description Reference to the workspace this webhook belongs to.
|
|
11034
|
-
*/
|
|
11035
|
-
workspaceId: string;
|
|
10204
|
+
/** @description Slug of the workspace this webhook belongs to. */
|
|
10205
|
+
workspaceSlug: components["schemas"]["Slug"];
|
|
11036
10206
|
};
|
|
11037
10207
|
/**
|
|
11038
10208
|
* @description Defines the types of events that can trigger webhook delivery.
|
|
@@ -11040,19 +10210,13 @@ interface components {
|
|
|
11040
10210
|
* This enumeration corresponds to the `WEBHOOK_EVENT` PostgreSQL enum and is used
|
|
11041
10211
|
* to configure which events a webhook should receive notifications for.
|
|
11042
10212
|
*/
|
|
11043
|
-
WebhookEvent: "
|
|
11044
|
-
/**
|
|
11045
|
-
|
|
11046
|
-
|
|
11047
|
-
* Since webhook IDs are globally unique UUIDs, workspace context can be
|
|
11048
|
-
* derived from the webhook record itself for authorization purposes.
|
|
11049
|
-
*/
|
|
10213
|
+
WebhookEvent: "file:created" | "file:updated" | "file:deleted" | "member:added" | "member:deleted" | "member:updated" | "connection:created" | "connection:updated" | "connection:deleted" | "connection:synced" | "connection:desynced";
|
|
10214
|
+
/** @description Opaque whk identifier (whk_<uuid>). */
|
|
10215
|
+
WebhookId: string;
|
|
10216
|
+
/** @description Path parameters for webhook operations. */
|
|
11050
10217
|
WebhookPathParams: {
|
|
11051
|
-
/**
|
|
11052
|
-
|
|
11053
|
-
* @description Unique identifier of the webhook.
|
|
11054
|
-
*/
|
|
11055
|
-
webhookId: string;
|
|
10218
|
+
/** @description Opaque identifier of the webhook. */
|
|
10219
|
+
webhookId: components["schemas"]["WebhookId"];
|
|
11056
10220
|
};
|
|
11057
10221
|
/** @description Result of a webhook delivery attempt. */
|
|
11058
10222
|
WebhookResult: {
|
|
@@ -11099,21 +10263,18 @@ interface components {
|
|
|
11099
10263
|
* @description Timestamp when the workspace was created.
|
|
11100
10264
|
*/
|
|
11101
10265
|
createdAt: string;
|
|
11102
|
-
/**
|
|
11103
|
-
|
|
11104
|
-
* @description ID of the account that created the workspace.
|
|
11105
|
-
*/
|
|
11106
|
-
createdBy: string;
|
|
10266
|
+
/** @description Handle of the account that created this workspace. */
|
|
10267
|
+
creatorUsername: components["schemas"]["Username"];
|
|
11107
10268
|
/** @description Description of the workspace. */
|
|
11108
10269
|
description?: string;
|
|
11109
10270
|
/** @description Display name of the workspace. */
|
|
11110
10271
|
displayName: string;
|
|
11111
|
-
/** @description Whether comments are enabled for this workspace. */
|
|
11112
|
-
enableComments: boolean;
|
|
11113
10272
|
/** @description Role of the member in the workspace. */
|
|
11114
10273
|
memberRole: components["schemas"]["WorkspaceRole"];
|
|
11115
10274
|
/** @description Whether approval is required to processed files to be visible. */
|
|
11116
10275
|
requireApproval: boolean;
|
|
10276
|
+
/** @description URL-safe workspace identifier. */
|
|
10277
|
+
slug: components["schemas"]["Slug"];
|
|
11117
10278
|
/** @description Tags associated with the workspace. */
|
|
11118
10279
|
tags: string[];
|
|
11119
10280
|
/**
|
|
@@ -11121,19 +10282,14 @@ interface components {
|
|
|
11121
10282
|
* @description Timestamp when the workspace was last updated.
|
|
11122
10283
|
*/
|
|
11123
10284
|
updatedAt: string;
|
|
11124
|
-
/**
|
|
11125
|
-
* Format: uuid
|
|
11126
|
-
* @description ID of the workspace.
|
|
11127
|
-
*/
|
|
11128
|
-
workspaceId: string;
|
|
11129
10285
|
};
|
|
11130
|
-
/** @description Path parameters for workspace
|
|
11131
|
-
|
|
10286
|
+
/** @description Path parameters for file operations within a workspace context. */
|
|
10287
|
+
WorkspaceFilePathParams: {
|
|
11132
10288
|
/**
|
|
11133
10289
|
* Format: uuid
|
|
11134
|
-
* @description Unique identifier of the
|
|
10290
|
+
* @description Unique identifier of the file.
|
|
11135
10291
|
*/
|
|
11136
|
-
|
|
10292
|
+
fileId: string;
|
|
11137
10293
|
};
|
|
11138
10294
|
/**
|
|
11139
10295
|
* @description Defines the role and permission level of a workspace member.
|
|
@@ -11142,6 +10298,11 @@ interface components {
|
|
|
11142
10298
|
* hierarchical access control for workspace members with clearly defined capabilities.
|
|
11143
10299
|
*/
|
|
11144
10300
|
WorkspaceRole: "owner" | "admin" | "member" | "guest";
|
|
10301
|
+
/** @description Query parameters for listing runs across a workspace. */
|
|
10302
|
+
WorkspaceRunsQuery: {
|
|
10303
|
+
/** @description Filter by run status. */
|
|
10304
|
+
status?: components["schemas"]["PipelineRunStatus"];
|
|
10305
|
+
};
|
|
11145
10306
|
/**
|
|
11146
10307
|
* @description Generic paginated response wrapper.
|
|
11147
10308
|
*
|
|
@@ -11169,48 +10330,40 @@ interface components {
|
|
|
11169
10330
|
}
|
|
11170
10331
|
//#endregion
|
|
11171
10332
|
//#region src/datatypes/account.d.ts
|
|
11172
|
-
type Schemas$17 = components["schemas"];
|
|
11173
|
-
type Account = Schemas$17["Account"];
|
|
11174
|
-
type UpdateAccount = Schemas$17["UpdateAccount"];
|
|
11175
|
-
//#endregion
|
|
11176
|
-
//#region src/datatypes/activity.d.ts
|
|
11177
10333
|
type Schemas$16 = components["schemas"];
|
|
11178
|
-
type
|
|
11179
|
-
type
|
|
11180
|
-
type
|
|
10334
|
+
type Account = Schemas$16["Account"];
|
|
10335
|
+
type PublicAccount = Schemas$16["PublicAccount"];
|
|
10336
|
+
type UpdateAccount = Schemas$16["UpdateAccount"];
|
|
11181
10337
|
//#endregion
|
|
11182
|
-
//#region src/datatypes/
|
|
10338
|
+
//#region src/datatypes/activity.d.ts
|
|
11183
10339
|
type Schemas$15 = components["schemas"];
|
|
11184
|
-
type
|
|
11185
|
-
type
|
|
11186
|
-
type
|
|
11187
|
-
type CreateApiToken = Schemas$15["CreateApiToken"];
|
|
11188
|
-
type UpdateApiToken = Schemas$15["UpdateApiToken"];
|
|
11189
|
-
type TokenExpiration = Schemas$15["TokenExpiration"];
|
|
11190
|
-
type ApiTokensPage = Schemas$15["ApiTokensPage"];
|
|
10340
|
+
type Activity = Schemas$15["Activity"];
|
|
10341
|
+
type ActivityType = Schemas$15["ActivityType"];
|
|
10342
|
+
type ActivitiesPage = Schemas$15["ActivitysPage"];
|
|
11191
10343
|
//#endregion
|
|
11192
|
-
//#region src/datatypes/
|
|
10344
|
+
//#region src/datatypes/api-token.d.ts
|
|
11193
10345
|
type Schemas$14 = components["schemas"];
|
|
11194
|
-
type
|
|
11195
|
-
type
|
|
11196
|
-
type
|
|
10346
|
+
type ApiToken = Schemas$14["ApiToken"];
|
|
10347
|
+
type ApiTokenWithJWT = Schemas$14["ApiTokenWithJWT"];
|
|
10348
|
+
type ApiTokenType = Schemas$14["ApiTokenType"];
|
|
10349
|
+
type CreateApiToken = Schemas$14["CreateApiToken"];
|
|
10350
|
+
type UpdateApiToken = Schemas$14["UpdateApiToken"];
|
|
10351
|
+
type TokenExpiration = Schemas$14["TokenExpiration"];
|
|
10352
|
+
type ApiTokensPage = Schemas$14["ApiTokensPage"];
|
|
11197
10353
|
//#endregion
|
|
11198
|
-
//#region src/datatypes/
|
|
10354
|
+
//#region src/datatypes/auth.d.ts
|
|
11199
10355
|
type Schemas$13 = components["schemas"];
|
|
11200
|
-
type
|
|
11201
|
-
type
|
|
11202
|
-
type
|
|
11203
|
-
type ConnectionsQuery = Schemas$13["ConnectionsQuery"];
|
|
11204
|
-
type ConnectionsPage = Schemas$13["ConnectionsPage"];
|
|
10356
|
+
type Login = Schemas$13["Login"];
|
|
10357
|
+
type Signup = Schemas$13["Signup"];
|
|
10358
|
+
type AuthToken = Schemas$13["AuthToken"];
|
|
11205
10359
|
//#endregion
|
|
11206
|
-
//#region src/datatypes/
|
|
10360
|
+
//#region src/datatypes/connection.d.ts
|
|
11207
10361
|
type Schemas$12 = components["schemas"];
|
|
11208
|
-
type
|
|
11209
|
-
type
|
|
11210
|
-
type
|
|
11211
|
-
type
|
|
11212
|
-
type
|
|
11213
|
-
type ContextsPage = Schemas$12["ContextsPage"];
|
|
10362
|
+
type Connection = Schemas$12["Connection"];
|
|
10363
|
+
type CreateConnection = Schemas$12["CreateConnection"];
|
|
10364
|
+
type UpdateConnection = Schemas$12["UpdateConnection"];
|
|
10365
|
+
type ConnectionsQuery = Schemas$12["ConnectionsQuery"];
|
|
10366
|
+
type ConnectionsPage = Schemas$12["ConnectionsPage"];
|
|
11214
10367
|
//#endregion
|
|
11215
10368
|
//#region src/datatypes/error.d.ts
|
|
11216
10369
|
type Schemas$11 = components["schemas"];
|
|
@@ -11236,6 +10389,7 @@ type CheckHealth = Schemas$9["CheckHealth"];
|
|
|
11236
10389
|
//#region src/datatypes/invite.d.ts
|
|
11237
10390
|
type Schemas$8 = components["schemas"];
|
|
11238
10391
|
type Invite = Schemas$8["Invite"];
|
|
10392
|
+
type InviteSent = Schemas$8["InviteSent"];
|
|
11239
10393
|
type CreateInvite = Schemas$8["CreateInvite"];
|
|
11240
10394
|
type ReplyInvite = Schemas$8["ReplyInvite"];
|
|
11241
10395
|
type GenerateInviteCode = Schemas$8["GenerateInviteCode"];
|
|
@@ -11302,6 +10456,7 @@ type AnalyzedDocument = Schemas$2["AnalyzedDocument"];
|
|
|
11302
10456
|
//#region src/datatypes/webhook.d.ts
|
|
11303
10457
|
type Schemas$1 = components["schemas"];
|
|
11304
10458
|
type Webhook = Schemas$1["Webhook"];
|
|
10459
|
+
type WebhookCreated = Schemas$1["WebhookCreated"];
|
|
11305
10460
|
type CreateWebhook = Schemas$1["CreateWebhook"];
|
|
11306
10461
|
type UpdateWebhook = Schemas$1["UpdateWebhook"];
|
|
11307
10462
|
type TestWebhook = Schemas$1["TestWebhook"];
|
|
@@ -11318,5 +10473,5 @@ type UpdateWorkspace = Schemas["UpdateWorkspace"];
|
|
|
11318
10473
|
type WorkspaceRole = Schemas["WorkspaceRole"];
|
|
11319
10474
|
type WorkspacesPage = Schemas["WorkspacesPage"];
|
|
11320
10475
|
//#endregion
|
|
11321
|
-
export {
|
|
11322
|
-
//# sourceMappingURL=index-
|
|
10476
|
+
export { InvitePreview as $, PipelineFilter as A, ApiTokensPage as At, NotificationsPage as B, paths as Bt, PolicyAction as C, UpdateConnection as Ct, CreatePipeline as D, ApiToken as Dt, UpdatePolicy as E, Signup as Et, UpdatePipeline as F, Activity as Ft, MemberSortField as G, UpdateNotificationSettings as H, CursorPagination as I, ActivityType as It, CreateInvite as J, MembersPage as K, Notification as L, Account as Lt, PipelineSummariesPage as M, TokenExpiration as Mt, PipelineSummary as N, UpdateApiToken as Nt, Pipeline as O, ApiTokenType as Ot, PipelineTriggerType as P, ActivitiesPage as Pt, InviteExpiration as Q, NotificationEvent as R, PublicAccount as Rt, Policy as S, CreateConnection as St, PolicyRule as T, Login as Tt, ListMembers as U, UnreadStatus as V, Member as W, Invite as X, GenerateInviteCode as Y, InviteCode as Z, PipelineRun as _, ErrorResponse as _t, WorkspacesPage as a, ReplyInvite as at, CreatePolicy as b, ConnectionsPage as bt, UpdateWebhook as c, ComponentHealth as ct, WebhookEvent as d, File as dt, InviteSent as et, WebhookResult as f, FileFormat as ft, CreatePipelineRun as g, UpdateFile as gt, AnalyzedDocument as h, ListFiles as ht, WorkspaceRole as i, ListInvites as it, PipelineStatus as j, CreateApiToken as jt, PipelineDefinition as k, ApiTokenWithJWT as kt, Webhook as l, Health as lt, WebhooksPage as m, FilesPage as mt, UpdateWorkspace as n, InviteStatus as nt, CreateWebhook as o, SortOrder as ot, WebhookStatus as p, FileSource as pt, UpdateMember as q, Workspace as r, InvitesPage as rt, TestWebhook as s, CheckHealth as st, CreateWorkspace as t, InviteSortField as tt, WebhookCreated as u, HealthStatus as ut, PipelineRunStatus as v, ValidationErrorDetail as vt, PolicyDefinition as w, AuthToken as wt, PoliciesPage as x, ConnectionsQuery as xt, PipelineRunsPage as y, Connection as yt, NotificationSettings as z, UpdateAccount as zt };
|
|
10477
|
+
//# sourceMappingURL=index-DfNB2LNT.d.ts.map
|