@nvisy/sdk 0.6.0 → 0.8.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.
@@ -217,7 +217,7 @@ interface paths {
217
217
  header?: never;
218
218
  path: {
219
219
  /** @description Public handle of the account. */
220
- username: components["schemas"]["Username"];
220
+ username: components["schemas"]["Handle"];
221
221
  };
222
222
  cookie?: never;
223
223
  };
@@ -1615,11 +1615,87 @@ interface paths {
1615
1615
  };
1616
1616
  };
1617
1617
  };
1618
+ put?: never;
1619
+ post?: never;
1620
+ /**
1621
+ * Delete connection
1622
+ * @description Soft-deletes the connection from the workspace.
1623
+ */
1624
+ delete: {
1625
+ parameters: {
1626
+ query?: never;
1627
+ header?: never;
1628
+ path: {
1629
+ /** @description URL-safe workspace identifier. */
1630
+ workspaceSlug: string;
1631
+ /** @description Opaque identifier of the connection. */
1632
+ connectionId: components["schemas"]["ConnectionId"];
1633
+ };
1634
+ cookie?: never;
1635
+ };
1636
+ requestBody?: never;
1637
+ responses: {
1638
+ /** @description no content */
1639
+ 204: {
1640
+ headers: {
1641
+ [name: string]: unknown;
1642
+ };
1643
+ content?: never;
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
+ 401: {
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
+ 403: {
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
+ 404: {
1683
+ headers: {
1684
+ [name: string]: unknown;
1685
+ };
1686
+ content: {
1687
+ "application/json": components["schemas"]["ErrorResponse"];
1688
+ };
1689
+ };
1690
+ };
1691
+ };
1692
+ options?: never;
1693
+ head?: never;
1618
1694
  /**
1619
1695
  * Update connection
1620
1696
  * @description Updates connection name or encrypted data.
1621
1697
  */
1622
- put: {
1698
+ patch: {
1623
1699
  parameters: {
1624
1700
  query?: never;
1625
1701
  header?: never;
@@ -1732,12 +1808,440 @@ interface paths {
1732
1808
  };
1733
1809
  };
1734
1810
  };
1735
- post?: never;
1811
+ trace?: never;
1812
+ };
1813
+ "/workspaces/{workspaceSlug}/connections/{connectionId}/verify/": {
1814
+ parameters: {
1815
+ query?: never;
1816
+ header?: never;
1817
+ path?: never;
1818
+ cookie?: never;
1819
+ };
1820
+ get?: never;
1821
+ put?: never;
1822
+ /**
1823
+ * Verify connection
1824
+ * @description Checks whether the connection's backing store is reachable with its stored credentials.
1825
+ */
1826
+ post: {
1827
+ parameters: {
1828
+ query?: never;
1829
+ header?: never;
1830
+ path: {
1831
+ /** @description URL-safe workspace identifier. */
1832
+ workspaceSlug: string;
1833
+ /** @description Opaque identifier of the connection. */
1834
+ connectionId: components["schemas"]["ConnectionId"];
1835
+ };
1836
+ cookie?: never;
1837
+ };
1838
+ requestBody?: never;
1839
+ responses: {
1840
+ /** @description Result of a connection reachability check. */
1841
+ 200: {
1842
+ headers: {
1843
+ [name: string]: unknown;
1844
+ };
1845
+ content: {
1846
+ "application/json": components["schemas"]["ConnectionVerification"];
1847
+ };
1848
+ };
1849
+ /**
1850
+ * @description HTTP error response representation with security-conscious design.
1851
+ *
1852
+ * This struct contains all the information needed to serialize an error
1853
+ * response, including the error name, message, HTTP status code, resource
1854
+ * information, and user-friendly messages.
1855
+ */
1856
+ 401: {
1857
+ headers: {
1858
+ [name: string]: unknown;
1859
+ };
1860
+ content: {
1861
+ "application/json": components["schemas"]["ErrorResponse"];
1862
+ };
1863
+ };
1864
+ /**
1865
+ * @description HTTP error response representation with security-conscious design.
1866
+ *
1867
+ * This struct contains all the information needed to serialize an error
1868
+ * response, including the error name, message, HTTP status code, resource
1869
+ * information, and user-friendly messages.
1870
+ */
1871
+ 403: {
1872
+ headers: {
1873
+ [name: string]: unknown;
1874
+ };
1875
+ content: {
1876
+ "application/json": components["schemas"]["ErrorResponse"];
1877
+ };
1878
+ };
1879
+ /**
1880
+ * @description HTTP error response representation with security-conscious design.
1881
+ *
1882
+ * This struct contains all the information needed to serialize an error
1883
+ * response, including the error name, message, HTTP status code, resource
1884
+ * information, and user-friendly messages.
1885
+ */
1886
+ 404: {
1887
+ headers: {
1888
+ [name: string]: unknown;
1889
+ };
1890
+ content: {
1891
+ "application/json": components["schemas"]["ErrorResponse"];
1892
+ };
1893
+ };
1894
+ };
1895
+ };
1896
+ delete?: never;
1897
+ options?: never;
1898
+ head?: never;
1899
+ patch?: never;
1900
+ trace?: never;
1901
+ };
1902
+ "/workspaces/{workspaceSlug}/connections/{connectionId}/sync/": {
1903
+ parameters: {
1904
+ query?: never;
1905
+ header?: never;
1906
+ path?: never;
1907
+ cookie?: never;
1908
+ };
1909
+ get?: never;
1910
+ put?: never;
1911
+ /**
1912
+ * Sync connection
1913
+ * @description Imports an object from or exports a file to the connection. Returns the created sync; poll it for completion.
1914
+ */
1915
+ post: {
1916
+ parameters: {
1917
+ query?: never;
1918
+ header?: never;
1919
+ path: {
1920
+ /** @description URL-safe workspace identifier. */
1921
+ workspaceSlug: string;
1922
+ /** @description Opaque identifier of the connection. */
1923
+ connectionId: components["schemas"]["ConnectionId"];
1924
+ };
1925
+ cookie?: never;
1926
+ };
1927
+ /**
1928
+ * @description Request payload to trigger a connection sync.
1929
+ *
1930
+ * The direction is determined by the connection's configured `sync_mode`.
1931
+ * - Import connections need no body: the sync fetches every not-yet-imported
1932
+ * object under the connection's root path.
1933
+ * - Export connections push one workspace file (`file_id`) to one object
1934
+ * `key`; both are required for export and ignored for import.
1935
+ */
1936
+ requestBody: {
1937
+ content: {
1938
+ "application/json": components["schemas"]["SyncConnection"];
1939
+ };
1940
+ };
1941
+ responses: {
1942
+ /** @description A connection sync run (import or export). */
1943
+ 202: {
1944
+ headers: {
1945
+ [name: string]: unknown;
1946
+ };
1947
+ content: {
1948
+ "application/json": components["schemas"]["ConnectionSync"];
1949
+ };
1950
+ };
1951
+ /**
1952
+ * @description HTTP error response representation with security-conscious design.
1953
+ *
1954
+ * This struct contains all the information needed to serialize an error
1955
+ * response, including the error name, message, HTTP status code, resource
1956
+ * information, and user-friendly messages.
1957
+ */
1958
+ 400: {
1959
+ headers: {
1960
+ [name: string]: unknown;
1961
+ };
1962
+ content: {
1963
+ "application/json": components["schemas"]["ErrorResponse"];
1964
+ };
1965
+ };
1966
+ /**
1967
+ * @description HTTP error response representation with security-conscious design.
1968
+ *
1969
+ * This struct contains all the information needed to serialize an error
1970
+ * response, including the error name, message, HTTP status code, resource
1971
+ * information, and user-friendly messages.
1972
+ */
1973
+ 401: {
1974
+ headers: {
1975
+ [name: string]: unknown;
1976
+ };
1977
+ content: {
1978
+ "application/json": components["schemas"]["ErrorResponse"];
1979
+ };
1980
+ };
1981
+ /**
1982
+ * @description HTTP error response representation with security-conscious design.
1983
+ *
1984
+ * This struct contains all the information needed to serialize an error
1985
+ * response, including the error name, message, HTTP status code, resource
1986
+ * information, and user-friendly messages.
1987
+ */
1988
+ 403: {
1989
+ headers: {
1990
+ [name: string]: unknown;
1991
+ };
1992
+ content: {
1993
+ "application/json": components["schemas"]["ErrorResponse"];
1994
+ };
1995
+ };
1996
+ /**
1997
+ * @description HTTP error response representation with security-conscious design.
1998
+ *
1999
+ * This struct contains all the information needed to serialize an error
2000
+ * response, including the error name, message, HTTP status code, resource
2001
+ * information, and user-friendly messages.
2002
+ */
2003
+ 404: {
2004
+ headers: {
2005
+ [name: string]: unknown;
2006
+ };
2007
+ content: {
2008
+ "application/json": components["schemas"]["ErrorResponse"];
2009
+ };
2010
+ };
2011
+ /** @description Expected request with `Content-Type: application/json` */
2012
+ 415: {
2013
+ headers: {
2014
+ [name: string]: unknown;
2015
+ };
2016
+ content: {
2017
+ "text/plain": string;
2018
+ };
2019
+ };
2020
+ /** @description Failed to deserialize the JSON body into the target type */
2021
+ 422: {
2022
+ headers: {
2023
+ [name: string]: unknown;
2024
+ };
2025
+ content: {
2026
+ "text/plain": string;
2027
+ };
2028
+ };
2029
+ };
2030
+ };
2031
+ delete?: never;
2032
+ options?: never;
2033
+ head?: never;
2034
+ patch?: never;
2035
+ trace?: never;
2036
+ };
2037
+ "/workspaces/{workspaceSlug}/connections/{connectionId}/syncs/": {
2038
+ parameters: {
2039
+ query?: never;
2040
+ header?: never;
2041
+ path?: never;
2042
+ cookie?: never;
2043
+ };
2044
+ /**
2045
+ * List connection syncs
2046
+ * @description Returns the connection's sync history, most recent first.
2047
+ */
2048
+ get: {
2049
+ parameters: {
2050
+ query?: {
2051
+ /**
2052
+ * @description Cursor pointing to the last item of the previous page.
2053
+ * Obtain this from the `nextCursor` field in the response.
2054
+ */
2055
+ after?: string;
2056
+ /** @description The maximum number of records to return (1-100, default: 20). */
2057
+ limit?: number;
2058
+ };
2059
+ header?: never;
2060
+ path: {
2061
+ /** @description URL-safe workspace identifier. */
2062
+ workspaceSlug: string;
2063
+ /** @description Opaque identifier of the connection. */
2064
+ connectionId: components["schemas"]["ConnectionId"];
2065
+ };
2066
+ cookie?: never;
2067
+ };
2068
+ requestBody?: never;
2069
+ responses: {
2070
+ /**
2071
+ * @description Generic paginated response wrapper.
2072
+ *
2073
+ * Provides a consistent structure for all paginated API responses with
2074
+ * cursor-based pagination support. When `next_cursor` is present, there
2075
+ * are more items to fetch.
2076
+ */
2077
+ 200: {
2078
+ headers: {
2079
+ [name: string]: unknown;
2080
+ };
2081
+ content: {
2082
+ "application/json": components["schemas"]["ConnectionSyncsPage"];
2083
+ };
2084
+ };
2085
+ /**
2086
+ * @description HTTP error response representation with security-conscious design.
2087
+ *
2088
+ * This struct contains all the information needed to serialize an error
2089
+ * response, including the error name, message, HTTP status code, resource
2090
+ * information, and user-friendly messages.
2091
+ */
2092
+ 401: {
2093
+ headers: {
2094
+ [name: string]: unknown;
2095
+ };
2096
+ content: {
2097
+ "application/json": components["schemas"]["ErrorResponse"];
2098
+ };
2099
+ };
2100
+ /**
2101
+ * @description HTTP error response representation with security-conscious design.
2102
+ *
2103
+ * This struct contains all the information needed to serialize an error
2104
+ * response, including the error name, message, HTTP status code, resource
2105
+ * information, and user-friendly messages.
2106
+ */
2107
+ 403: {
2108
+ headers: {
2109
+ [name: string]: unknown;
2110
+ };
2111
+ content: {
2112
+ "application/json": components["schemas"]["ErrorResponse"];
2113
+ };
2114
+ };
2115
+ /**
2116
+ * @description HTTP error response representation with security-conscious design.
2117
+ *
2118
+ * This struct contains all the information needed to serialize an error
2119
+ * response, including the error name, message, HTTP status code, resource
2120
+ * information, and user-friendly messages.
2121
+ */
2122
+ 404: {
2123
+ headers: {
2124
+ [name: string]: unknown;
2125
+ };
2126
+ content: {
2127
+ "application/json": components["schemas"]["ErrorResponse"];
2128
+ };
2129
+ };
2130
+ };
2131
+ };
2132
+ put?: never;
2133
+ post?: never;
2134
+ delete?: never;
2135
+ options?: never;
2136
+ head?: never;
2137
+ patch?: never;
2138
+ trace?: never;
2139
+ };
2140
+ "/workspaces/{workspaceSlug}/connections/{connectionId}/syncs/{syncId}/": {
2141
+ parameters: {
2142
+ query?: never;
2143
+ header?: never;
2144
+ path?: never;
2145
+ cookie?: never;
2146
+ };
2147
+ /**
2148
+ * Get connection sync
2149
+ * @description Returns a single sync run for the connection.
2150
+ */
2151
+ get: {
2152
+ parameters: {
2153
+ query?: never;
2154
+ header?: never;
2155
+ path: {
2156
+ /** @description URL-safe workspace identifier. */
2157
+ workspaceSlug: string;
2158
+ /** @description Opaque identifier of the connection. */
2159
+ connectionId: components["schemas"]["ConnectionId"];
2160
+ /** @description Unique identifier of the sync run. */
2161
+ syncId: string;
2162
+ };
2163
+ cookie?: never;
2164
+ };
2165
+ requestBody?: never;
2166
+ responses: {
2167
+ /** @description A connection sync run (import or export). */
2168
+ 200: {
2169
+ headers: {
2170
+ [name: string]: unknown;
2171
+ };
2172
+ content: {
2173
+ "application/json": components["schemas"]["ConnectionSync"];
2174
+ };
2175
+ };
2176
+ /**
2177
+ * @description HTTP error response representation with security-conscious design.
2178
+ *
2179
+ * This struct contains all the information needed to serialize an error
2180
+ * response, including the error name, message, HTTP status code, resource
2181
+ * information, and user-friendly messages.
2182
+ */
2183
+ 401: {
2184
+ headers: {
2185
+ [name: string]: unknown;
2186
+ };
2187
+ content: {
2188
+ "application/json": components["schemas"]["ErrorResponse"];
2189
+ };
2190
+ };
2191
+ /**
2192
+ * @description HTTP error response representation with security-conscious design.
2193
+ *
2194
+ * This struct contains all the information needed to serialize an error
2195
+ * response, including the error name, message, HTTP status code, resource
2196
+ * information, and user-friendly messages.
2197
+ */
2198
+ 403: {
2199
+ headers: {
2200
+ [name: string]: unknown;
2201
+ };
2202
+ content: {
2203
+ "application/json": components["schemas"]["ErrorResponse"];
2204
+ };
2205
+ };
2206
+ /**
2207
+ * @description HTTP error response representation with security-conscious design.
2208
+ *
2209
+ * This struct contains all the information needed to serialize an error
2210
+ * response, including the error name, message, HTTP status code, resource
2211
+ * information, and user-friendly messages.
2212
+ */
2213
+ 404: {
2214
+ headers: {
2215
+ [name: string]: unknown;
2216
+ };
2217
+ content: {
2218
+ "application/json": components["schemas"]["ErrorResponse"];
2219
+ };
2220
+ };
2221
+ };
2222
+ };
2223
+ put?: never;
2224
+ post?: never;
2225
+ delete?: never;
2226
+ options?: never;
2227
+ head?: never;
2228
+ patch?: never;
2229
+ trace?: never;
2230
+ };
2231
+ "/workspaces/{workspaceSlug}/connections/{connectionId}/syncs/{syncId}/cancel/": {
2232
+ parameters: {
2233
+ query?: never;
2234
+ header?: never;
2235
+ path?: never;
2236
+ cookie?: never;
2237
+ };
2238
+ get?: never;
2239
+ put?: never;
1736
2240
  /**
1737
- * Delete connection
1738
- * @description Soft-deletes the connection from the workspace.
2241
+ * Cancel connection sync
2242
+ * @description Cancels an in-progress sync run. A run that already finished returns 409.
1739
2243
  */
1740
- delete: {
2244
+ post: {
1741
2245
  parameters: {
1742
2246
  query?: never;
1743
2247
  header?: never;
@@ -1746,17 +2250,21 @@ interface paths {
1746
2250
  workspaceSlug: string;
1747
2251
  /** @description Opaque identifier of the connection. */
1748
2252
  connectionId: components["schemas"]["ConnectionId"];
2253
+ /** @description Unique identifier of the sync run. */
2254
+ syncId: string;
1749
2255
  };
1750
2256
  cookie?: never;
1751
2257
  };
1752
2258
  requestBody?: never;
1753
2259
  responses: {
1754
- /** @description no content */
1755
- 204: {
2260
+ /** @description A connection sync run (import or export). */
2261
+ 200: {
1756
2262
  headers: {
1757
2263
  [name: string]: unknown;
1758
2264
  };
1759
- content?: never;
2265
+ content: {
2266
+ "application/json": components["schemas"]["ConnectionSync"];
2267
+ };
1760
2268
  };
1761
2269
  /**
1762
2270
  * @description HTTP error response representation with security-conscious design.
@@ -1803,8 +2311,24 @@ interface paths {
1803
2311
  "application/json": components["schemas"]["ErrorResponse"];
1804
2312
  };
1805
2313
  };
2314
+ /**
2315
+ * @description HTTP error response representation with security-conscious design.
2316
+ *
2317
+ * This struct contains all the information needed to serialize an error
2318
+ * response, including the error name, message, HTTP status code, resource
2319
+ * information, and user-friendly messages.
2320
+ */
2321
+ 409: {
2322
+ headers: {
2323
+ [name: string]: unknown;
2324
+ };
2325
+ content: {
2326
+ "application/json": components["schemas"]["ErrorResponse"];
2327
+ };
2328
+ };
1806
2329
  };
1807
2330
  };
2331
+ delete?: never;
1808
2332
  options?: never;
1809
2333
  head?: never;
1810
2334
  patch?: never;
@@ -2138,7 +2662,7 @@ interface paths {
2138
2662
  put?: never;
2139
2663
  /**
2140
2664
  * Reply to invitation
2141
- * @description Allows the invitee to accept or decline a workspace invitation.
2665
+ * @description Accepts or declines a workspace invitation. On accept the user becomes a member and the new membership is returned; on decline no membership is created.
2142
2666
  */
2143
2667
  post: {
2144
2668
  parameters: {
@@ -2159,19 +2683,21 @@ interface paths {
2159
2683
  };
2160
2684
  };
2161
2685
  responses: {
2162
- /**
2163
- * @description Workspace invite with complete information.
2164
- *
2165
- * This response includes all the essential information about an
2166
- * invitation, including the unique invite ID that can be used to track or cancel
2167
- * the invitation later.
2168
- */
2169
2686
  200: {
2170
2687
  headers: {
2171
2688
  [name: string]: unknown;
2172
2689
  };
2173
2690
  content: {
2174
- "application/json": components["schemas"]["Invite"];
2691
+ "application/json": components["schemas"]["Member"] | null;
2692
+ };
2693
+ };
2694
+ /** @description Represents a workspace member. */
2695
+ 201: {
2696
+ headers: {
2697
+ [name: string]: unknown;
2698
+ };
2699
+ content: {
2700
+ "application/json": components["schemas"]["Member"];
2175
2701
  };
2176
2702
  };
2177
2703
  /**
@@ -2219,6 +2745,21 @@ interface paths {
2219
2745
  "application/json": components["schemas"]["ErrorResponse"];
2220
2746
  };
2221
2747
  };
2748
+ /**
2749
+ * @description HTTP error response representation with security-conscious design.
2750
+ *
2751
+ * This struct contains all the information needed to serialize an error
2752
+ * response, including the error name, message, HTTP status code, resource
2753
+ * information, and user-friendly messages.
2754
+ */
2755
+ 409: {
2756
+ headers: {
2757
+ [name: string]: unknown;
2758
+ };
2759
+ content: {
2760
+ "application/json": components["schemas"]["ErrorResponse"];
2761
+ };
2762
+ };
2222
2763
  /** @description Expected request with `Content-Type: application/json` */
2223
2764
  415: {
2224
2765
  headers: {
@@ -2722,7 +3263,7 @@ interface paths {
2722
3263
  /** @description URL-safe workspace identifier. */
2723
3264
  workspaceSlug: string;
2724
3265
  /** @description Public handle of the member's account. */
2725
- username: components["schemas"]["Username"];
3266
+ username: components["schemas"]["Handle"];
2726
3267
  };
2727
3268
  cookie?: never;
2728
3269
  };
@@ -2798,7 +3339,7 @@ interface paths {
2798
3339
  /** @description URL-safe workspace identifier. */
2799
3340
  workspaceSlug: string;
2800
3341
  /** @description Public handle of the member's account. */
2801
- username: components["schemas"]["Username"];
3342
+ username: components["schemas"]["Handle"];
2802
3343
  };
2803
3344
  cookie?: never;
2804
3345
  };
@@ -2887,7 +3428,7 @@ interface paths {
2887
3428
  /** @description URL-safe workspace identifier. */
2888
3429
  workspaceSlug: string;
2889
3430
  /** @description Public handle of the member's account. */
2890
- username: components["schemas"]["Username"];
3431
+ username: components["schemas"]["Handle"];
2891
3432
  };
2892
3433
  cookie?: never;
2893
3434
  };
@@ -3256,11 +3797,13 @@ interface paths {
3256
3797
  };
3257
3798
  };
3258
3799
  };
3800
+ put?: never;
3801
+ post?: never;
3259
3802
  /**
3260
- * Update webhook
3261
- * @description Updates webhook configuration such as URL or event subscriptions.
3803
+ * Delete webhook
3804
+ * @description Permanently removes the webhook from the workspace.
3262
3805
  */
3263
- put: {
3806
+ delete: {
3264
3807
  parameters: {
3265
3808
  query?: never;
3266
3809
  header?: never;
@@ -3272,36 +3815,14 @@ interface paths {
3272
3815
  };
3273
3816
  cookie?: never;
3274
3817
  };
3275
- /** @description Request payload for updating an existing workspace webhook. */
3276
- requestBody: {
3277
- content: {
3278
- "application/json": components["schemas"]["UpdateWebhook"];
3279
- };
3280
- };
3818
+ requestBody?: never;
3281
3819
  responses: {
3282
- /** @description Workspace webhook response. */
3283
- 200: {
3284
- headers: {
3285
- [name: string]: unknown;
3286
- };
3287
- content: {
3288
- "application/json": components["schemas"]["Webhook"];
3289
- };
3290
- };
3291
- /**
3292
- * @description HTTP error response representation with security-conscious design.
3293
- *
3294
- * This struct contains all the information needed to serialize an error
3295
- * response, including the error name, message, HTTP status code, resource
3296
- * information, and user-friendly messages.
3297
- */
3298
- 400: {
3820
+ /** @description no content */
3821
+ 204: {
3299
3822
  headers: {
3300
3823
  [name: string]: unknown;
3301
3824
  };
3302
- content: {
3303
- "application/json": components["schemas"]["ErrorResponse"];
3304
- };
3825
+ content?: never;
3305
3826
  };
3306
3827
  /**
3307
3828
  * @description HTTP error response representation with security-conscious design.
@@ -3348,32 +3869,15 @@ interface paths {
3348
3869
  "application/json": components["schemas"]["ErrorResponse"];
3349
3870
  };
3350
3871
  };
3351
- /** @description Expected request with `Content-Type: application/json` */
3352
- 415: {
3353
- headers: {
3354
- [name: string]: unknown;
3355
- };
3356
- content: {
3357
- "text/plain": string;
3358
- };
3359
- };
3360
- /** @description Failed to deserialize the JSON body into the target type */
3361
- 422: {
3362
- headers: {
3363
- [name: string]: unknown;
3364
- };
3365
- content: {
3366
- "text/plain": string;
3367
- };
3368
- };
3369
3872
  };
3370
3873
  };
3371
- post?: never;
3874
+ options?: never;
3875
+ head?: never;
3372
3876
  /**
3373
- * Delete webhook
3374
- * @description Permanently removes the webhook from the workspace.
3877
+ * Update webhook
3878
+ * @description Updates webhook configuration such as URL or event subscriptions.
3375
3879
  */
3376
- delete: {
3880
+ patch: {
3377
3881
  parameters: {
3378
3882
  query?: never;
3379
3883
  header?: never;
@@ -3385,14 +3889,36 @@ interface paths {
3385
3889
  };
3386
3890
  cookie?: never;
3387
3891
  };
3388
- requestBody?: never;
3892
+ /** @description Request payload for updating an existing workspace webhook. */
3893
+ requestBody: {
3894
+ content: {
3895
+ "application/json": components["schemas"]["UpdateWebhook"];
3896
+ };
3897
+ };
3389
3898
  responses: {
3390
- /** @description no content */
3391
- 204: {
3899
+ /** @description Workspace webhook response. */
3900
+ 200: {
3392
3901
  headers: {
3393
3902
  [name: string]: unknown;
3394
3903
  };
3395
- content?: never;
3904
+ content: {
3905
+ "application/json": components["schemas"]["Webhook"];
3906
+ };
3907
+ };
3908
+ /**
3909
+ * @description HTTP error response representation with security-conscious design.
3910
+ *
3911
+ * This struct contains all the information needed to serialize an error
3912
+ * response, including the error name, message, HTTP status code, resource
3913
+ * information, and user-friendly messages.
3914
+ */
3915
+ 400: {
3916
+ headers: {
3917
+ [name: string]: unknown;
3918
+ };
3919
+ content: {
3920
+ "application/json": components["schemas"]["ErrorResponse"];
3921
+ };
3396
3922
  };
3397
3923
  /**
3398
3924
  * @description HTTP error response representation with security-conscious design.
@@ -3439,11 +3965,26 @@ interface paths {
3439
3965
  "application/json": components["schemas"]["ErrorResponse"];
3440
3966
  };
3441
3967
  };
3968
+ /** @description Expected request with `Content-Type: application/json` */
3969
+ 415: {
3970
+ headers: {
3971
+ [name: string]: unknown;
3972
+ };
3973
+ content: {
3974
+ "text/plain": string;
3975
+ };
3976
+ };
3977
+ /** @description Failed to deserialize the JSON body into the target type */
3978
+ 422: {
3979
+ headers: {
3980
+ [name: string]: unknown;
3981
+ };
3982
+ content: {
3983
+ "text/plain": string;
3984
+ };
3985
+ };
3442
3986
  };
3443
3987
  };
3444
- options?: never;
3445
- head?: never;
3446
- patch?: never;
3447
3988
  trace?: never;
3448
3989
  };
3449
3990
  "/workspaces/{workspaceSlug}/webhooks/{webhookId}/test/": {
@@ -3581,8 +4122,13 @@ interface paths {
3581
4122
  get: {
3582
4123
  parameters: {
3583
4124
  query?: {
3584
- /** @description Filter by file formats. */
3585
- formats?: components["schemas"]["FileFormat"][];
4125
+ /**
4126
+ * @description Filter by file extension. Each entry expands to its format's full
4127
+ * extension set (so `jpg` also matches `jpeg`).
4128
+ */
4129
+ formats?: components["schemas"]["FormatToken"][];
4130
+ /** @description Filter by modality (`text`, `tabular`, `image`, `audio`). */
4131
+ modality?: components["schemas"]["ModalityToken"][];
3586
4132
  /** @description Search by file name (case-insensitive, partial match). */
3587
4133
  search?: string;
3588
4134
  /**
@@ -5425,9 +5971,83 @@ interface paths {
5425
5971
  headers: {
5426
5972
  [name: string]: unknown;
5427
5973
  };
5428
- content: {
5429
- "application/json": components["schemas"]["Policy2"];
5430
- };
5974
+ content: {
5975
+ "application/json": components["schemas"]["Policy2"];
5976
+ };
5977
+ };
5978
+ /**
5979
+ * @description HTTP error response representation with security-conscious design.
5980
+ *
5981
+ * This struct contains all the information needed to serialize an error
5982
+ * response, including the error name, message, HTTP status code, resource
5983
+ * information, and user-friendly messages.
5984
+ */
5985
+ 401: {
5986
+ headers: {
5987
+ [name: string]: unknown;
5988
+ };
5989
+ content: {
5990
+ "application/json": components["schemas"]["ErrorResponse"];
5991
+ };
5992
+ };
5993
+ /**
5994
+ * @description HTTP error response representation with security-conscious design.
5995
+ *
5996
+ * This struct contains all the information needed to serialize an error
5997
+ * response, including the error name, message, HTTP status code, resource
5998
+ * information, and user-friendly messages.
5999
+ */
6000
+ 403: {
6001
+ headers: {
6002
+ [name: string]: unknown;
6003
+ };
6004
+ content: {
6005
+ "application/json": components["schemas"]["ErrorResponse"];
6006
+ };
6007
+ };
6008
+ /**
6009
+ * @description HTTP error response representation with security-conscious design.
6010
+ *
6011
+ * This struct contains all the information needed to serialize an error
6012
+ * response, including the error name, message, HTTP status code, resource
6013
+ * information, and user-friendly messages.
6014
+ */
6015
+ 404: {
6016
+ headers: {
6017
+ [name: string]: unknown;
6018
+ };
6019
+ content: {
6020
+ "application/json": components["schemas"]["ErrorResponse"];
6021
+ };
6022
+ };
6023
+ };
6024
+ };
6025
+ put?: never;
6026
+ post?: never;
6027
+ /**
6028
+ * Delete policy
6029
+ * @description Soft-deletes the policy from the workspace.
6030
+ */
6031
+ delete: {
6032
+ parameters: {
6033
+ query?: never;
6034
+ header?: never;
6035
+ path: {
6036
+ /** @description URL-safe workspace identifier. */
6037
+ workspaceSlug: string;
6038
+ /** @description URL slug of the policy, unique within its workspace. */
6039
+ policySlug: string;
6040
+ };
6041
+ cookie?: never;
6042
+ };
6043
+ requestBody?: never;
6044
+ responses: {
6045
+ /** @description no content */
6046
+ 204: {
6047
+ headers: {
6048
+ [name: string]: unknown;
6049
+ };
6050
+ content?: never;
5431
6051
  };
5432
6052
  /**
5433
6053
  * @description HTTP error response representation with security-conscious design.
@@ -5476,11 +6096,13 @@ interface paths {
5476
6096
  };
5477
6097
  };
5478
6098
  };
6099
+ options?: never;
6100
+ head?: never;
5479
6101
  /**
5480
6102
  * Update policy
5481
6103
  * @description Updates policy fields. Replacing the definition replaces the whole body.
5482
6104
  */
5483
- put: {
6105
+ patch: {
5484
6106
  parameters: {
5485
6107
  query?: never;
5486
6108
  header?: never;
@@ -5592,82 +6214,6 @@ interface paths {
5592
6214
  };
5593
6215
  };
5594
6216
  };
5595
- post?: never;
5596
- /**
5597
- * Delete policy
5598
- * @description Soft-deletes the policy from the workspace.
5599
- */
5600
- delete: {
5601
- parameters: {
5602
- query?: never;
5603
- header?: never;
5604
- path: {
5605
- /** @description URL-safe workspace identifier. */
5606
- workspaceSlug: string;
5607
- /** @description URL slug of the policy, unique within its workspace. */
5608
- policySlug: string;
5609
- };
5610
- cookie?: never;
5611
- };
5612
- requestBody?: never;
5613
- responses: {
5614
- /** @description no content */
5615
- 204: {
5616
- headers: {
5617
- [name: string]: unknown;
5618
- };
5619
- content?: never;
5620
- };
5621
- /**
5622
- * @description HTTP error response representation with security-conscious design.
5623
- *
5624
- * This struct contains all the information needed to serialize an error
5625
- * response, including the error name, message, HTTP status code, resource
5626
- * information, and user-friendly messages.
5627
- */
5628
- 401: {
5629
- headers: {
5630
- [name: string]: unknown;
5631
- };
5632
- content: {
5633
- "application/json": components["schemas"]["ErrorResponse"];
5634
- };
5635
- };
5636
- /**
5637
- * @description HTTP error response representation with security-conscious design.
5638
- *
5639
- * This struct contains all the information needed to serialize an error
5640
- * response, including the error name, message, HTTP status code, resource
5641
- * information, and user-friendly messages.
5642
- */
5643
- 403: {
5644
- headers: {
5645
- [name: string]: unknown;
5646
- };
5647
- content: {
5648
- "application/json": components["schemas"]["ErrorResponse"];
5649
- };
5650
- };
5651
- /**
5652
- * @description HTTP error response representation with security-conscious design.
5653
- *
5654
- * This struct contains all the information needed to serialize an error
5655
- * response, including the error name, message, HTTP status code, resource
5656
- * information, and user-friendly messages.
5657
- */
5658
- 404: {
5659
- headers: {
5660
- [name: string]: unknown;
5661
- };
5662
- content: {
5663
- "application/json": components["schemas"]["ErrorResponse"];
5664
- };
5665
- };
5666
- };
5667
- };
5668
- options?: never;
5669
- head?: never;
5670
- patch?: never;
5671
6217
  trace?: never;
5672
6218
  };
5673
6219
  "/notifications/": {
@@ -6049,12 +6595,7 @@ interface paths {
6049
6595
  };
6050
6596
  cookie?: never;
6051
6597
  };
6052
- /** @description Request payload for monitoring status endpoint. */
6053
- requestBody: {
6054
- content: {
6055
- "application/json": components["schemas"]["CheckHealth"];
6056
- };
6057
- };
6598
+ requestBody?: never;
6058
6599
  responses: {
6059
6600
  /** @description Response body for `GET /health/`. */
6060
6601
  200: {
@@ -6110,7 +6651,7 @@ interface components {
6110
6651
  */
6111
6652
  updatedAt: string;
6112
6653
  /** @description Public handle of the account. */
6113
- username: components["schemas"]["Username"];
6654
+ username: components["schemas"]["Handle"];
6114
6655
  };
6115
6656
  /**
6116
6657
  * @description Path parameters for account operations.
@@ -6120,14 +6661,14 @@ interface components {
6120
6661
  */
6121
6662
  AccountPathParams: {
6122
6663
  /** @description Public handle of the account. */
6123
- username: components["schemas"]["Username"];
6664
+ username: components["schemas"]["Handle"];
6124
6665
  };
6125
6666
  /** @description Response type for a workspace activity. */
6126
6667
  Activity: {
6127
6668
  /** @description Type of activity. */
6128
6669
  activityType: components["schemas"]["ActivityType"];
6129
6670
  /** @description Handle of the account that performed the activity, if any. */
6130
- actorUsername?: components["schemas"]["Username"];
6671
+ actorUsername?: components["schemas"]["Handle"];
6131
6672
  /**
6132
6673
  * Format: date-time
6133
6674
  * @description When the activity occurred.
@@ -6140,8 +6681,8 @@ interface components {
6140
6681
  * @description Unique activity identifier.
6141
6682
  */
6142
6683
  id: string;
6143
- /** @description Slug of the workspace this activity belongs to. */
6144
- workspaceSlug: components["schemas"]["Slug"];
6684
+ /** @description Handle of the workspace this activity belongs to. */
6685
+ workspaceSlug: components["schemas"]["Handle"];
6145
6686
  };
6146
6687
  /**
6147
6688
  * @description Defines the type of activity performed in a workspace for audit logging.
@@ -6237,6 +6778,8 @@ interface components {
6237
6778
  * `false`; the listing handler sets it for the matching token.
6238
6779
  */
6239
6780
  current: boolean;
6781
+ /** @description Human-readable display name for the API token. */
6782
+ displayName: string;
6240
6783
  /**
6241
6784
  * Format: date-time
6242
6785
  * @description Timestamp when the token expires (None = never expires).
@@ -6257,8 +6800,6 @@ interface components {
6257
6800
  * @description Timestamp of most recent token activity.
6258
6801
  */
6259
6802
  lastUsedAt?: string;
6260
- /** @description Human-readable name for the API token. */
6261
- name: string;
6262
6803
  /** @description Type of token (web, api, etc.). */
6263
6804
  sessionType: components["schemas"]["ApiTokenType"];
6264
6805
  };
@@ -6271,6 +6812,8 @@ interface components {
6271
6812
  ApiTokenType: "web" | "api" | "cli";
6272
6813
  /** @description API token with JWT token string (only returned on creation). */
6273
6814
  ApiTokenWithJWT: {
6815
+ /** @description Human-readable display name for the API token. */
6816
+ displayName: string;
6274
6817
  /**
6275
6818
  * Format: date-time
6276
6819
  * @description Timestamp when the token expires (omitted = never expires).
@@ -6286,8 +6829,6 @@ interface components {
6286
6829
  * @description Timestamp of token creation.
6287
6830
  */
6288
6831
  issuedAt: string;
6289
- /** @description Human-readable name for the API token. */
6290
- name: string;
6291
6832
  /** @description Type of token (web, mobile, api, etc.). */
6292
6833
  sessionType: components["schemas"]["ApiTokenType"];
6293
6834
  /** @description The JWT token string (only shown once on creation). */
@@ -6456,7 +6997,7 @@ interface components {
6456
6997
  */
6457
6998
  issuedAt: string;
6458
6999
  /** @description Handle of the authenticated account. */
6459
- username: components["schemas"]["Username"];
7000
+ username: components["schemas"]["Handle"];
6460
7001
  };
6461
7002
  /**
6462
7003
  * @description Axis-aligned rectangle, given by its minimum and maximum corners.
@@ -6476,11 +7017,6 @@ interface components {
6476
7017
  /** @description Minimum corner (top-left, conventionally). */
6477
7018
  min: components["schemas"]["Point"];
6478
7019
  };
6479
- /** @description Request payload for monitoring status endpoint. */
6480
- CheckHealth: {
6481
- /** @description Whether to return cached results if available. */
6482
- useCache?: boolean;
6483
- };
6484
7020
  /**
6485
7021
  * @description Color as 8-bit RGB.
6486
7022
  *
@@ -6506,11 +7042,6 @@ interface components {
6506
7042
  };
6507
7043
  /** @description Health of a single service component. */
6508
7044
  ComponentHealth: {
6509
- /**
6510
- * Format: uint64
6511
- * @description How long the health check took, when measured.
6512
- */
6513
- latency?: number;
6514
7045
  /** @description Component name (e.g. `"postgres"`, `"nats"`). */
6515
7046
  name: string;
6516
7047
  /** @description Status of this component. */
@@ -6558,7 +7089,11 @@ interface components {
6558
7089
  */
6559
7090
  createdAt: string;
6560
7091
  /** @description Handle of the account that created this connection. */
6561
- creatorUsername: components["schemas"]["Username"];
7092
+ creatorUsername: components["schemas"]["Handle"];
7093
+ /** @description How an import reconciles files whose source object was deleted. */
7094
+ deletionPolicy: components["schemas"]["SyncDeletionPolicy"];
7095
+ /** @description Human-readable connection display name. */
7096
+ displayName: string;
6562
7097
  /** @description Opaque identifier of the connection. */
6563
7098
  id: components["schemas"]["ConnectionId"];
6564
7099
  /**
@@ -6566,17 +7101,19 @@ interface components {
6566
7101
  * @description When the connection last synced successfully, if ever.
6567
7102
  */
6568
7103
  lastSynced?: string;
6569
- /** @description Human-readable connection name. */
6570
- name: string;
6571
- /** @description Provider type (e.g., "openai", "postgres", "s3"). */
7104
+ /** @description Object store provider (`s3`, `azure`, `gcs`). */
6572
7105
  provider: string;
7106
+ /** @description Cron expression for scheduled imports, if configured. */
7107
+ scheduleCron?: string;
7108
+ /** @description Whether the connection imports data in or exports data out. */
7109
+ syncMode: components["schemas"]["SyncMode"];
6573
7110
  /**
6574
7111
  * Format: date-time
6575
7112
  * @description When the connection was last updated.
6576
7113
  */
6577
7114
  updatedAt: string;
6578
- /** @description Slug of the workspace this connection belongs to. */
6579
- workspaceSlug: components["schemas"]["Slug"];
7115
+ /** @description Handle of the workspace this connection belongs to. */
7116
+ workspaceSlug: components["schemas"]["Handle"];
6580
7117
  };
6581
7118
  /** @description Opaque conn identifier (conn_<uuid>). */
6582
7119
  ConnectionId: string;
@@ -6592,6 +7129,77 @@ interface components {
6592
7129
  /** @description Opaque identifier of the connection. */
6593
7130
  connectionId: components["schemas"]["ConnectionId"];
6594
7131
  };
7132
+ /** @description A connection sync run (import or export). */
7133
+ ConnectionSync: {
7134
+ /**
7135
+ * Format: int32
7136
+ * @description 1-based attempt number; scheduled syncs may be retried on failure.
7137
+ */
7138
+ attempt: number;
7139
+ /**
7140
+ * Format: date-time
7141
+ * @description When the sync finished, if it has.
7142
+ */
7143
+ completedAt?: string;
7144
+ /** @description The connection this sync belongs to. */
7145
+ connectionId: components["schemas"]["ConnectionId"];
7146
+ /** @description Failure reason when the sync failed; omitted otherwise. */
7147
+ errorMessage?: string;
7148
+ /**
7149
+ * Format: uuid
7150
+ * @description Unique sync identifier.
7151
+ */
7152
+ id: string;
7153
+ /**
7154
+ * Format: int64
7155
+ * @description Number of objects transferred so far.
7156
+ */
7157
+ recordsSynced: number;
7158
+ /**
7159
+ * Format: date-time
7160
+ * @description When the sync started.
7161
+ */
7162
+ startedAt: string;
7163
+ /** @description Current status of the sync. */
7164
+ status: components["schemas"]["SyncStatus"];
7165
+ /** @description How the sync was triggered. */
7166
+ triggerType: components["schemas"]["SyncTriggerType"];
7167
+ };
7168
+ /** @description Path parameters for a specific connection sync. */
7169
+ ConnectionSyncPathParams: {
7170
+ /** @description Opaque identifier of the connection. */
7171
+ connectionId: components["schemas"]["ConnectionId"];
7172
+ /**
7173
+ * Format: uuid
7174
+ * @description Unique identifier of the sync run.
7175
+ */
7176
+ syncId: string;
7177
+ };
7178
+ /**
7179
+ * @description Generic paginated response wrapper.
7180
+ *
7181
+ * Provides a consistent structure for all paginated API responses with
7182
+ * cursor-based pagination support. When `next_cursor` is present, there
7183
+ * are more items to fetch.
7184
+ */
7185
+ ConnectionSyncsPage: {
7186
+ /** @description Items in this page. */
7187
+ items: components["schemas"]["ConnectionSync"][];
7188
+ /** @description Cursor to fetch the next page. Present only when more items exist. */
7189
+ nextCursor?: string;
7190
+ /**
7191
+ * Format: int64
7192
+ * @description Total count of items matching the query (if requested).
7193
+ */
7194
+ total?: number;
7195
+ };
7196
+ /** @description Result of a connection reachability check. */
7197
+ ConnectionVerification: {
7198
+ /** @description Failure reason when not reachable; omitted on success. */
7199
+ error?: string;
7200
+ /** @description Whether the backing store was reachable with the stored credentials. */
7201
+ reachable: boolean;
7202
+ };
6595
7203
  /**
6596
7204
  * @description Generic paginated response wrapper.
6597
7205
  *
@@ -6633,22 +7241,34 @@ interface components {
6633
7241
  CountryCode: string;
6634
7242
  /** @description Request to create a new API token. */
6635
7243
  CreateApiToken: {
7244
+ /** @description Human-readable display name for the API token (1-100 characters). */
7245
+ displayName: string;
6636
7246
  /** @description When the token expires. */
6637
7247
  expiresIn: components["schemas"]["TokenExpiration"];
6638
- /** @description Human-readable name for the API token (1-100 characters). */
6639
- name: string;
6640
7248
  };
6641
7249
  /** @description Request payload for creating a new workspace connection. */
6642
7250
  CreateConnection: {
6643
7251
  /**
6644
- * @description Connection data to be encrypted (credentials + context).
6645
- * The structure depends on the provider type.
7252
+ * @description Connection data to be encrypted (provider credentials + optional root
7253
+ * path). The structure depends on the provider type.
6646
7254
  */
6647
7255
  data: unknown;
6648
- /** @description Human-readable connection name. */
6649
- name: string;
6650
- /** @description Provider type (e.g., "openai", "postgres", "s3"). */
7256
+ /**
7257
+ * @description How an import reconciles files whose source object was deleted.
7258
+ * @default ignore
7259
+ */
7260
+ deletionPolicy: components["schemas"]["SyncDeletionPolicy"];
7261
+ /** @description Human-readable connection display name. */
7262
+ displayName: string;
7263
+ /** @description Object store provider (`s3`, `azure`, `gcs`). */
6651
7264
  provider: string;
7265
+ /** @description Cron expression for scheduled imports; omit for manual-only. */
7266
+ scheduleCron?: string;
7267
+ /**
7268
+ * @description Whether the connection imports data in or exports data out.
7269
+ * @default import
7270
+ */
7271
+ syncMode: components["schemas"]["SyncMode"];
6652
7272
  };
6653
7273
  /** @description Request payload for creating a new workspace invite. */
6654
7274
  CreateInvite: {
@@ -6676,10 +7296,10 @@ interface components {
6676
7296
  definition?: components["schemas"]["PipelineDefinition"];
6677
7297
  /** @description Optional description of the pipeline (max 500 characters). */
6678
7298
  description?: string;
6679
- /** @description Pipeline name (3-100 characters). */
6680
- name: string;
7299
+ /** @description Pipeline display name (2-128 characters). */
7300
+ displayName: string;
6681
7301
  /** @description URL slug, unique within the workspace and immutable after creation. */
6682
- slug: components["schemas"]["Slug"];
7302
+ slug: components["schemas"]["Handle"];
6683
7303
  };
6684
7304
  /**
6685
7305
  * @description Request payload to start a run (detect) over a file.
@@ -6714,15 +7334,15 @@ interface components {
6714
7334
  /** @description Optional description override. Defaults to the policy's own description. */
6715
7335
  description?: string;
6716
7336
  /** @description Optional display name override. Defaults to the policy's own name. */
6717
- name?: string;
7337
+ displayName?: string;
6718
7338
  /** @description URL slug, unique within the workspace and immutable after creation. */
6719
- slug: components["schemas"]["Slug"];
7339
+ slug: components["schemas"]["Handle"];
6720
7340
  };
6721
7341
  /** @description Request payload for creating a new workspace webhook. */
6722
7342
  CreateWebhook: {
6723
7343
  /** @description Detailed description of the webhook's purpose (max 500 characters). */
6724
7344
  description: string;
6725
- /** @description Human-readable name for the webhook (1-100 characters). */
7345
+ /** @description Human-readable name for the webhook (1-128 characters). */
6726
7346
  displayName: string;
6727
7347
  /** @description List of event types this webhook should receive. */
6728
7348
  events: components["schemas"]["WebhookEvent"][];
@@ -6745,14 +7365,14 @@ interface components {
6745
7365
  * automatically added as an owner of the workspace.
6746
7366
  */
6747
7367
  CreateWorkspace: {
6748
- /** @description Optional description of the workspace (max 200 characters). */
7368
+ /** @description Optional description of the workspace (max 500 characters). */
6749
7369
  description?: string;
6750
- /** @description Display name of the workspace (3-32 characters). */
7370
+ /** @description Display name of the workspace (2-32 characters). */
6751
7371
  displayName: string;
6752
7372
  /** @description Whether approval is required for processed files to be visible. */
6753
7373
  requireApproval?: boolean;
6754
7374
  /** @description Optional URL slug. Derived from the display name when omitted. */
6755
- slug?: components["schemas"]["Slug"];
7375
+ slug?: components["schemas"]["Handle"];
6756
7376
  };
6757
7377
  /**
6758
7378
  * @description Cursor-based pagination query parameters.
@@ -6924,47 +7544,6 @@ interface components {
6924
7544
  */
6925
7545
  validator?: string;
6926
7546
  };
6927
- /**
6928
- * @description Dedup pipeline applied after recognition.
6929
- *
6930
- * Layers run in the canonical order: calibrate → reconcile
6931
- * (merging) → reconcile (tiebreaking) → filter.
6932
- */
6933
- DeduplicationParams: {
6934
- /**
6935
- * @description Per-recognizer confidence weights.
6936
- *
6937
- * An empty map skips the calibrate layer. The engine
6938
- * converts this into elide's `CalibrationMap` at compile
6939
- * time.
6940
- */
6941
- calibration?: {
6942
- [key: string]: number;
6943
- };
6944
- /**
6945
- * @description How same-label overlapping findings are merged into one.
6946
- *
6947
- * Defaults to [`MergingStrategyParams::Max`].
6948
- * @default max
6949
- */
6950
- merging: components["schemas"]["MergingStrategyParams"];
6951
- /**
6952
- * @description Minimum confidence the filter layer admits.
6953
- *
6954
- * `None` falls back to [`ConfidenceThreshold::BASELINE`] at
6955
- * compile time. Wire form is an `f32` in `0.0..=1.0`;
6956
- * out-of-range values reject at deserialize, not silently
6957
- * clamp.
6958
- */
6959
- minConfidence?: components["schemas"]["ConfidenceThreshold"];
6960
- /**
6961
- * @description How cross-label overlaps pick a winner.
6962
- *
6963
- * Defaults to [`TiebreakerParams::HighestConfidence`].
6964
- * @default highest_confidence
6965
- */
6966
- tiebreaker: components["schemas"]["TiebreakerParams"];
6967
- };
6968
7547
  /**
6969
7548
  * @description Pixel dimensions of an image or any 2-D canvas.
6970
7549
  *
@@ -7017,42 +7596,6 @@ interface components {
7017
7596
  /** @description Negated predicate. */
7018
7597
  not: components["schemas"]["DocumentPredicate"];
7019
7598
  };
7020
- /**
7021
- * @description Enricher slots an analyzer can fill.
7022
- *
7023
- * Each slot is at-most-one; the slot name is the kind.
7024
- */
7025
- EnricherParams: {
7026
- /**
7027
- * @description Language-detection enricher.
7028
- *
7029
- * Detects the document's primary language(s) and writes them
7030
- * into the recognizer context. Drives jurisdiction-aware
7031
- * recognizer dispatch downstream.
7032
- */
7033
- language?: components["schemas"]["LanguageEnricherParams"];
7034
- /**
7035
- * @description OCR enricher (image modality only).
7036
- *
7037
- * OCRs the image (or PDF page raster) and stamps the
7038
- * recognised [`Layout`] onto the recognizer context, so
7039
- * downstream text recognizers can match on the OCR'd text.
7040
- *
7041
- * [`Layout`]: elide_core::modality::image::Layout
7042
- */
7043
- ocr?: components["schemas"]["OcrEnricherParams"];
7044
- /**
7045
- * @description Speech-to-text enricher (audio modality only).
7046
- *
7047
- * Transcribes the audio stream and stamps the resulting
7048
- * [`TranscriptSegment`]s onto the recognizer context, so
7049
- * downstream text recognizers can match against the
7050
- * transcript.
7051
- *
7052
- * [`TranscriptSegment`]: elide_core::modality::audio::TranscriptSegment
7053
- */
7054
- stt?: components["schemas"]["SttEnricherParams"];
7055
- };
7056
7599
  /**
7057
7600
  * @description Detected piece of sensitive information within some medium.
7058
7601
  *
@@ -8047,17 +8590,15 @@ interface components {
8047
8590
  */
8048
8591
  updatedAt: string;
8049
8592
  /** @description Handle of the account that uploaded/created the file. */
8050
- uploadedBy: components["schemas"]["Username"];
8593
+ uploadedBy: components["schemas"]["Handle"];
8051
8594
  /**
8052
8595
  * Format: int32
8053
8596
  * @description Version number (1 for original, higher for newer versions).
8054
8597
  */
8055
8598
  versionNumber: number;
8056
- /** @description Slug of the workspace this file belongs to. */
8057
- workspaceSlug: components["schemas"]["Slug"];
8599
+ /** @description Handle of the workspace this file belongs to. */
8600
+ workspaceSlug: components["schemas"]["Handle"];
8058
8601
  };
8059
- /** @description File format categories for filtering. */
8060
- FileFormat: "pdf" | "doc" | "txt" | "md" | "csv" | "json" | "png" | "jpeg";
8061
8602
  /**
8062
8603
  * @description Defines how a file was created in the system.
8063
8604
  *
@@ -8084,6 +8625,11 @@ interface components {
8084
8625
  */
8085
8626
  total?: number;
8086
8627
  };
8628
+ /**
8629
+ * @description A supported file extension.
8630
+ * @enum {string}
8631
+ */
8632
+ FormatToken: "csv" | "docx" | "htm" | "html" | "jpeg" | "jpg" | "json" | "log" | "pdf" | "png" | "rtf" | "tif" | "tiff" | "txt" | "wav" | "xlsx" | "xml";
8087
8633
  /** @description Request to generate a shareable invite code for a workspace. */
8088
8634
  GenerateInviteCode: {
8089
8635
  /** @description When the invite code expires. */
@@ -8091,6 +8637,8 @@ interface components {
8091
8637
  /** @description Role to assign when someone joins via this invite code. */
8092
8638
  invitedRole: components["schemas"]["WorkspaceRole"];
8093
8639
  };
8640
+ /** @description Lowercase, dash-separated identifier used in URLs and as account handles. */
8641
+ Handle: string;
8094
8642
  /**
8095
8643
  * @description SHA-2 variant for the [`TextRedaction::Hash`] operator.
8096
8644
  *
@@ -8316,8 +8864,8 @@ interface components {
8316
8864
  * @description When the invitation was last updated.
8317
8865
  */
8318
8866
  updatedAt: string;
8319
- /** @description Slug of the workspace the invitation is for. */
8320
- workspaceSlug: components["schemas"]["Slug"];
8867
+ /** @description Handle of the workspace the invitation is for. */
8868
+ workspaceSlug: components["schemas"]["Handle"];
8321
8869
  };
8322
8870
  /** @description Response containing a generated shareable invite code. */
8323
8871
  InviteCode: {
@@ -8330,8 +8878,8 @@ interface components {
8330
8878
  inviteCode: string;
8331
8879
  /** @description Role assigned when someone joins via this code. */
8332
8880
  role: components["schemas"]["WorkspaceRole"];
8333
- /** @description Slug of the workspace this invite code is for. */
8334
- workspaceSlug: components["schemas"]["Slug"];
8881
+ /** @description Handle of the workspace this invite code is for. */
8882
+ workspaceSlug: components["schemas"]["Handle"];
8335
8883
  };
8336
8884
  /** @description Path parameters for joining via invite code. */
8337
8885
  InviteCodePathParams: {
@@ -8373,8 +8921,8 @@ interface components {
8373
8921
  invitedRole: components["schemas"]["WorkspaceRole"];
8374
8922
  /** @description Tags associated with the workspace. */
8375
8923
  tags: string[];
8376
- /** @description Slug of the workspace. */
8377
- workspaceSlug: components["schemas"]["Slug"];
8924
+ /** @description Handle of the workspace. */
8925
+ workspaceSlug: components["schemas"]["Handle"];
8378
8926
  };
8379
8927
  /**
8380
8928
  * @description Acknowledgement returned after sending a workspace invitation.
@@ -8507,27 +9055,6 @@ interface components {
8507
9055
  */
8508
9056
  span?: components["schemas"]["LanguageSpan"];
8509
9057
  };
8510
- /**
8511
- * @description Params for the language-detection enricher.
8512
- *
8513
- * Backed by [`elide_lingua::LinguaEnricher`]: the `candidates` set
8514
- * scopes the detector to a candidate language pool. An empty list
8515
- * asks lingua to consider every language compiled into its
8516
- * feature set.
8517
- *
8518
- * [`elide_lingua::LinguaEnricher`]: https://docs.rs/elide-lingua/latest/elide_lingua/struct.LinguaEnricher.html
8519
- */
8520
- LanguageEnricherParams: {
8521
- /**
8522
- * @description Candidate language pool the detector picks from.
8523
- *
8524
- * Empty means "every language lingua was compiled with"; a
8525
- * non-empty list restricts detection to those languages and
8526
- * is a real speed + accuracy win when the caller knows what
8527
- * languages their documents are in.
8528
- */
8529
- candidates?: components["schemas"]["LanguageTag"][];
8530
- };
8531
9058
  /**
8532
9059
  * @description How a [`Language`]'s language was obtained.
8533
9060
  *
@@ -8595,8 +9122,13 @@ interface components {
8595
9122
  LeakProfile: "recoverable" | "partial" | "irrecoverable";
8596
9123
  /** @description Query parameters for listing files. */
8597
9124
  ListFiles: {
8598
- /** @description Filter by file formats. */
8599
- formats?: components["schemas"]["FileFormat"][];
9125
+ /**
9126
+ * @description Filter by file extension. Each entry expands to its format's full
9127
+ * extension set (so `jpg` also matches `jpeg`).
9128
+ */
9129
+ formats?: components["schemas"]["FormatToken"][];
9130
+ /** @description Filter by modality (`text`, `tabular`, `image`, `audio`). */
9131
+ modality?: components["schemas"]["ModalityToken"][];
8600
9132
  /** @description Search by file name (case-insensitive, partial match). */
8601
9133
  search?: string;
8602
9134
  };
@@ -8648,12 +9180,12 @@ interface components {
8648
9180
  /** @description Role of the member in the workspace. */
8649
9181
  memberRole: components["schemas"]["WorkspaceRole"];
8650
9182
  /** @description Handle of the member's account. */
8651
- username: components["schemas"]["Username"];
9183
+ username: components["schemas"]["Handle"];
8652
9184
  };
8653
9185
  /** @description Path parameters for workspace member operations. */
8654
9186
  MemberPathParams: {
8655
9187
  /** @description Public handle of the member's account. */
8656
- username: components["schemas"]["Username"];
9188
+ username: components["schemas"]["Handle"];
8657
9189
  };
8658
9190
  /** @description Fields available for sorting workspace members. */
8659
9191
  MemberSortField: "name" | "date";
@@ -8703,6 +9235,11 @@ interface components {
8703
9235
  /** @description Operator for text-modality entities. */
8704
9236
  text?: components["schemas"]["TextRedaction"];
8705
9237
  };
9238
+ /**
9239
+ * @description A supported document modality.
9240
+ * @enum {string}
9241
+ */
9242
+ ModalityToken: "audio" | "image" | "tabular" | "text";
8706
9243
  /** @description Detail of a model/NER recognition. */
8707
9244
  ModelEvent: {
8708
9245
  /** @description Whether contextual analysis adjusted the score for this match. */
@@ -8784,20 +9321,6 @@ interface components {
8784
9321
  */
8785
9322
  total?: number;
8786
9323
  };
8787
- /**
8788
- * @description Params for the OCR enricher (image modality).
8789
- *
8790
- * The backend `kind` and its per-kind fields sit inline, no
8791
- * nested `backend = { ... }` table. Serde routes on `kind`.
8792
- */
8793
- OcrEnricherParams: {
8794
- /** @description Base URL of the BentoML service. */
8795
- base_url: string;
8796
- /** @constant */
8797
- kind: "bento";
8798
- /** @description Model identifier the backend should target. */
8799
- model: string;
8800
- };
8801
9324
  /**
8802
9325
  * @description Identifies a redaction operator, for the redaction audit a higher
8803
9326
  * layer assembles.
@@ -8878,15 +9401,15 @@ interface components {
8878
9401
  */
8879
9402
  createdAt: string;
8880
9403
  /** @description Handle of the account that created this pipeline. */
8881
- creatorUsername: components["schemas"]["Username"];
9404
+ creatorUsername: components["schemas"]["Handle"];
8882
9405
  /** @description Detection + redaction configuration. */
8883
9406
  definition: components["schemas"]["PipelineDefinition"];
8884
9407
  /** @description Pipeline description. */
8885
9408
  description?: string;
8886
- /** @description Pipeline name. */
8887
- name: string;
9409
+ /** @description Pipeline display name. */
9410
+ displayName: string;
8888
9411
  /** @description URL slug of the pipeline, unique within its workspace. */
8889
- slug: components["schemas"]["Slug"];
9412
+ slug: components["schemas"]["Handle"];
8890
9413
  /** @description Pipeline lifecycle status. */
8891
9414
  status: components["schemas"]["PipelineStatus"];
8892
9415
  /**
@@ -8894,34 +9417,47 @@ interface components {
8894
9417
  * @description Timestamp when the pipeline was last updated.
8895
9418
  */
8896
9419
  updatedAt: string;
8897
- /** @description Slug of the workspace this pipeline belongs to. */
8898
- workspaceSlug: components["schemas"]["Slug"];
9420
+ /** @description Handle of the workspace this pipeline belongs to. */
9421
+ workspaceSlug: components["schemas"]["Handle"];
9422
+ };
9423
+ /**
9424
+ * @description A pipeline's deduplication intent.
9425
+ *
9426
+ * Each field is optional: when a pipeline omits one, it inherits the
9427
+ * deployment default from the engine config. Per-recognizer calibration is
9428
+ * operator-only and never set here.
9429
+ */
9430
+ PipelineDeduplication: {
9431
+ /** @description How same-label overlapping findings are merged into one. */
9432
+ merging?: components["schemas"]["MergingStrategyParams"];
9433
+ /** @description Minimum confidence the filter layer admits. */
9434
+ minConfidence?: components["schemas"]["ConfidenceThreshold"];
9435
+ /** @description How cross-label overlaps pick a winner. */
9436
+ tiebreaker?: components["schemas"]["TiebreakerParams"];
8899
9437
  };
8900
9438
  /**
8901
- * @description Reusable detection + redaction configuration for a pipeline.
9439
+ * @description A pipeline's detection + governance intent.
8902
9440
  *
8903
- * The pipeline holds the "how to detect and redact" configuration the engine
8904
- * consumes, minus the per-document assertions (which travel with a document at
8905
- * detect time). Stored as JSON in the pipeline's `definition` column but
8906
- * validated against this schema at the API boundary.
9441
+ * Holds what a pipeline author decides which recognizers to run, the entity
9442
+ * labels, the default scope, and the policies to apply. Infrastructure config
9443
+ * (enrichment backends, deduplication calibration) is server-wide and lives in
9444
+ * the engine config, not here. Stored as JSON in the pipeline's `definition`
9445
+ * column but validated against this schema at the API boundary.
8907
9446
  *
8908
9447
  * The split:
8909
9448
  *
8910
- * - `recognizers` / `enrichers` / `deduplication` / `label_catalog` — the
8911
- * detection machinery, assembled into an engine `AnalyzerParams` per request.
9449
+ * - `recognizers` / `deduplication` / `label_catalog` — the detection intent,
9450
+ * merged with the server-wide engine defaults into an `AnalyzerParams`.
8912
9451
  * - `default_scope` — optional pipeline-wide scope a document may override.
8913
9452
  * - `policy_slugs` — references to the workspace's policies, resolved at run
8914
9453
  * time.
8915
9454
  */
8916
9455
  PipelineDefinition: {
8917
9456
  /**
8918
- * @description Post-recognition deduplication pipeline.
8919
- * @default {
8920
- * "merging": "max",
8921
- * "tiebreaker": "highest_confidence"
8922
- * }
9457
+ * @description Post-recognition deduplication behavior.
9458
+ * @default {}
8923
9459
  */
8924
- deduplication: components["schemas"]["DeduplicationParams"];
9460
+ deduplication: components["schemas"]["PipelineDeduplication"];
8925
9461
  /**
8926
9462
  * @description Optional pipeline-wide scope (languages, jurisdictions, document labels).
8927
9463
  *
@@ -8929,11 +9465,6 @@ interface components {
8929
9465
  * the document must assert its own.
8930
9466
  */
8931
9467
  defaultScope?: components["schemas"]["ScopeParams"];
8932
- /**
8933
- * @description Enrichers run before recognition: language, OCR, STT.
8934
- * @default {}
8935
- */
8936
- enrichers: components["schemas"]["EnricherParams"];
8937
9468
  /**
8938
9469
  * @description Entity-label catalog: which entity types the recognizers emit.
8939
9470
  *
@@ -8948,7 +9479,7 @@ interface components {
8948
9479
  * Stored relationally in the `workspace_pipeline_policies` join table, not the JSON
8949
9480
  * definition; surfaced here so the API exposes one coherent object.
8950
9481
  */
8951
- policySlugs?: components["schemas"]["Slug"][];
9482
+ policySlugs?: components["schemas"]["Handle"][];
8952
9483
  /**
8953
9484
  * @description Recognizer lineup: pattern (incl. inline custom rules and
8954
9485
  * dictionaries), plus the NER and LLM toggles.
@@ -8989,8 +9520,8 @@ interface components {
8989
9520
  id: components["schemas"]["RunId"];
8990
9521
  /** @description Non-encrypted metadata for filtering/display. */
8991
9522
  metadata: unknown;
8992
- /** @description Slug of the pipeline this run belongs to. */
8993
- pipelineSlug: components["schemas"]["Slug"];
9523
+ /** @description Handle of the pipeline this run belongs to. */
9524
+ pipelineSlug: components["schemas"]["Handle"];
8994
9525
  /**
8995
9526
  * Format: date-time
8996
9527
  * @description When the run started.
@@ -9006,9 +9537,9 @@ interface components {
9006
9537
  /** @description How the run was triggered. */
9007
9538
  triggerType: components["schemas"]["PipelineTriggerType"];
9008
9539
  /** @description Handle of the account that triggered the run, if any. */
9009
- triggerUsername?: components["schemas"]["Username"];
9010
- /** @description Slug of the workspace this run belongs to. */
9011
- workspaceSlug: components["schemas"]["Slug"];
9540
+ triggerUsername?: components["schemas"]["Handle"];
9541
+ /** @description Handle of the workspace this run belongs to. */
9542
+ workspaceSlug: components["schemas"]["Handle"];
9012
9543
  };
9013
9544
  /** @description Path parameters for pipeline run operations. */
9014
9545
  PipelineRunPathParams: {
@@ -9056,10 +9587,10 @@ interface components {
9056
9587
  createdAt: string;
9057
9588
  /** @description Pipeline description. */
9058
9589
  description?: string;
9059
- /** @description Pipeline name. */
9060
- name: string;
9590
+ /** @description Pipeline display name. */
9591
+ displayName: string;
9061
9592
  /** @description URL slug of the pipeline, unique within its workspace. */
9062
- slug: components["schemas"]["Slug"];
9593
+ slug: components["schemas"]["Handle"];
9063
9594
  /** @description Pipeline lifecycle status. */
9064
9595
  status: components["schemas"]["PipelineStatus"];
9065
9596
  /**
@@ -9174,15 +9705,15 @@ interface components {
9174
9705
  */
9175
9706
  createdAt: string;
9176
9707
  /** @description Handle of the account that created this policy. */
9177
- creatorUsername: components["schemas"]["Username"];
9708
+ creatorUsername: components["schemas"]["Handle"];
9178
9709
  /** @description The structured policy body consumed by the engine. */
9179
9710
  definition: components["schemas"]["Policy"];
9180
9711
  /** @description Policy description. */
9181
9712
  description?: string;
9182
- /** @description Human-readable policy name. */
9183
- name: string;
9713
+ /** @description Human-readable policy display name. */
9714
+ displayName: string;
9184
9715
  /** @description URL slug of the policy, unique within its workspace. */
9185
- slug: components["schemas"]["Slug"];
9716
+ slug: components["schemas"]["Handle"];
9186
9717
  /**
9187
9718
  * Format: date-time
9188
9719
  * @description When the policy was last updated.
@@ -9190,8 +9721,8 @@ interface components {
9190
9721
  updatedAt: string;
9191
9722
  /** @description Semver of the policy body. */
9192
9723
  version: string;
9193
- /** @description Slug of the workspace this policy belongs to. */
9194
- workspaceSlug: components["schemas"]["Slug"];
9724
+ /** @description Handle of the workspace this policy belongs to. */
9725
+ workspaceSlug: components["schemas"]["Handle"];
9195
9726
  };
9196
9727
  /**
9197
9728
  * @description What a rule does when its [`predicate`] matches.
@@ -9432,6 +9963,19 @@ interface components {
9432
9963
  /** @description Events, in the order they happened. */
9433
9964
  events: components["schemas"]["Event4"][];
9434
9965
  };
9966
+ /**
9967
+ * @description How to pick recognizers out of a deployment-configured lineup.
9968
+ *
9969
+ * Untagged on the wire: `true` / `false` / a list of names.
9970
+ *
9971
+ * - `All(true)`: explicit opt-in. Attaches every configured
9972
+ * recognizer; fails the analyzer compile if the lineup is
9973
+ * empty.
9974
+ * - `All(false)`: explicit opt-out. Skips the lineup entirely.
9975
+ * - `Only(names)`: attach only the named recognizers. An empty
9976
+ * list and any unknown name fail the analyzer compile.
9977
+ */
9978
+ ProviderSelection: boolean | string[];
9435
9979
  /**
9436
9980
  * @description Public view of an account, returned when looking up someone other than the
9437
9981
  * authenticated caller. Carries only the fields safe to share with a
@@ -9447,7 +9991,7 @@ interface components {
9447
9991
  /** @description Display name of the account holder, when set. */
9448
9992
  displayName?: string;
9449
9993
  /** @description Public handle of the account. */
9450
- username: components["schemas"]["Username"];
9994
+ username: components["schemas"]["Handle"];
9451
9995
  };
9452
9996
  Range_of_uint: {
9453
9997
  /** Format: uint */
@@ -9491,34 +10035,28 @@ interface components {
9491
10035
  * @description Recognizer slots an analyzer can fill.
9492
10036
  *
9493
10037
  * Pattern is at-most-one (per-request); NER and LLM are
9494
- * deployment-owned lineups each gated by a three-state
9495
- * [`Option<bool>`] toggle.
10038
+ * deployment-owned lineups each selected by a
10039
+ * [`ProviderSelection`].
9496
10040
  */
9497
10041
  RecognizerParams: {
9498
10042
  /**
9499
- * @description Run the deployment's LLM recognizer lineup.
10043
+ * @description Select which of the deployment's LLM recognizers to run.
9500
10044
  *
9501
- * Same three-state semantics as [`ner`]. The lineup is
9502
- * filtered by declared modality — only recognizers whose
9503
- * `modalities` list contains the analyzer's modality
9504
- * attach.
10045
+ * Same shape as [`ner`]. The lineup is additionally filtered
10046
+ * by declared modality — only recognizers whose `modalities`
10047
+ * list contains the analyzer's modality attach.
9505
10048
  *
9506
10049
  * [`ner`]: RecognizerParams::ner
9507
10050
  */
9508
- llm?: boolean;
10051
+ llm?: components["schemas"]["ProviderSelection"];
9509
10052
  /**
9510
- * @description Run the deployment's NER recognizer lineup.
10053
+ * @description Select which of the deployment's NER recognizers to run.
9511
10054
  *
9512
- * - `Some(true)`: explicit opt-in. Attaches every
9513
- * deployment-configured recognizer. Fails the analyzer
9514
- * compile with a `Validation` error when the deployment
9515
- * has no NER recognizers configured.
9516
- * - `Some(false)`: explicit opt-out. Skips NER entirely.
9517
- * - `None`: softly-on default. Attaches every configured
9518
- * recognizer if the deployment has any; skips silently
9519
- * otherwise.
10055
+ * See [`ProviderSelection`] for the shape. `None` is the
10056
+ * softly-on default: attach every configured recognizer if
10057
+ * the deployment has any, skip silently otherwise.
9520
10058
  */
9521
- ner?: boolean;
10059
+ ner?: components["schemas"]["ProviderSelection"];
9522
10060
  /**
9523
10061
  * @description Built-in pattern + dictionary recognizer (`elide-pattern`).
9524
10062
  *
@@ -9726,10 +10264,8 @@ interface components {
9726
10264
  */
9727
10265
  rememberMe: boolean;
9728
10266
  /** @description Public account handle, unique across all accounts. */
9729
- username: components["schemas"]["Username"];
10267
+ username: components["schemas"]["Handle"];
9730
10268
  };
9731
- /** @description Lowercase, dash-separated resource identifier used in URLs. */
9732
- Slug: string;
9733
10269
  /**
9734
10270
  * @description The `{workspaceSlug}` path segment. Named to match the OpenAPI parameter and
9735
10271
  * the route definition.
@@ -9740,20 +10276,6 @@ interface components {
9740
10276
  };
9741
10277
  /** @description Sort order direction. */
9742
10278
  SortOrder: "asc" | "desc";
9743
- /**
9744
- * @description Params for the STT enricher (audio modality).
9745
- *
9746
- * The backend `kind` and its per-kind fields sit inline, no
9747
- * nested `backend = { ... }` table. Serde routes on `kind`.
9748
- */
9749
- SttEnricherParams: {
9750
- /** @description Base URL of the BentoML service. */
9751
- base_url: string;
9752
- /** @constant */
9753
- kind: "bento";
9754
- /** @description Model identifier the backend should target. */
9755
- model: string;
9756
- };
9757
10279
  /** @description Payload for the `suppress` action. */
9758
10280
  SuppressAction: {
9759
10281
  /**
@@ -9764,6 +10286,53 @@ interface components {
9764
10286
  */
9765
10287
  reason?: string;
9766
10288
  };
10289
+ /**
10290
+ * @description Request payload to trigger a connection sync.
10291
+ *
10292
+ * The direction is determined by the connection's configured `sync_mode`.
10293
+ * - Import connections need no body: the sync fetches every not-yet-imported
10294
+ * object under the connection's root path.
10295
+ * - Export connections push one workspace file (`file_id`) to one object
10296
+ * `key`; both are required for export and ignored for import.
10297
+ */
10298
+ SyncConnection: {
10299
+ /**
10300
+ * Format: uuid
10301
+ * @description The workspace file to export (export connections only).
10302
+ */
10303
+ fileId?: string;
10304
+ /** @description The destination object key for an export, relative to the root path. */
10305
+ key?: string;
10306
+ };
10307
+ /**
10308
+ * @description What an import does with a file whose source object no longer exists.
10309
+ *
10310
+ * Corresponds to the `SYNC_DELETION_POLICY` PostgreSQL enum. Deletion is opt-in
10311
+ * per connection: the default `Ignore` keeps imports strictly additive so a
10312
+ * transient listing error or a misconfigured root path can never remove files.
10313
+ */
10314
+ SyncDeletionPolicy: "ignore" | "delete";
10315
+ /**
10316
+ * @description The direction a connection syncs data.
10317
+ *
10318
+ * Corresponds to the `SYNC_MODE` PostgreSQL enum: `Import` fetches objects from
10319
+ * the connection into the workspace; `Export` pushes workspace files out.
10320
+ */
10321
+ SyncMode: "import" | "export";
10322
+ /**
10323
+ * @description Defines the execution status of a connection sync run.
10324
+ *
10325
+ * This enumeration corresponds to the `SYNC_STATUS` PostgreSQL enum and tracks
10326
+ * the state of an individual synchronization run.
10327
+ */
10328
+ SyncStatus: "pending" | "running" | "completed" | "failed" | "cancelled";
10329
+ /**
10330
+ * @description Defines how a connection sync run was initiated.
10331
+ *
10332
+ * This enumeration corresponds to the `SYNC_TRIGGER_TYPE` PostgreSQL enum and is used
10333
+ * to track whether a run was manually triggered, scheduled, or triggered by a webhook.
10334
+ */
10335
+ SyncTriggerType: "manual" | "scheduled" | "webhook";
9767
10336
  /**
9768
10337
  * @description Cell-addressed location within tabular content.
9769
10338
  *
@@ -9997,22 +10566,31 @@ interface components {
9997
10566
  /** @description New password (will be hashed before storage). */
9998
10567
  password?: string;
9999
10568
  /** @description New account handle. */
10000
- username?: components["schemas"]["Username"];
10569
+ username?: components["schemas"]["Handle"];
10001
10570
  };
10002
10571
  /** @description Request to update an existing API token. */
10003
10572
  UpdateApiToken: {
10004
- /** @description Updated name for the API token (1-100 characters). */
10005
- name?: string;
10573
+ /** @description Updated display name for the API token (1-100 characters). */
10574
+ displayName?: string;
10006
10575
  };
10007
10576
  /** @description Request payload for updating an existing workspace connection. */
10008
10577
  UpdateConnection: {
10009
10578
  /**
10010
- * @description Connection data to be encrypted (credentials + context).
10011
- * If provided, replaces the existing encrypted data.
10579
+ * @description Connection data to be encrypted (provider credentials + optional root
10580
+ * path). If provided, replaces the existing encrypted data.
10012
10581
  */
10013
10582
  data?: unknown;
10014
- /** @description Human-readable connection name. */
10015
- name?: string;
10583
+ /** @description How an import reconciles files whose source object was deleted. */
10584
+ deletionPolicy?: components["schemas"]["SyncDeletionPolicy"];
10585
+ /** @description Human-readable connection display name. */
10586
+ displayName?: string;
10587
+ /**
10588
+ * @description Cron expression for scheduled imports. Omit to leave unchanged; send
10589
+ * `null` to clear it (make the connection manual-only).
10590
+ */
10591
+ scheduleCron?: string;
10592
+ /** @description Whether the connection imports data in or exports data out. */
10593
+ syncMode?: components["schemas"]["SyncMode"];
10016
10594
  };
10017
10595
  /** @description Request to update file metadata. */
10018
10596
  UpdateFile: {
@@ -10048,8 +10626,8 @@ interface components {
10048
10626
  definition?: components["schemas"]["PipelineDefinition"];
10049
10627
  /** @description New description for the pipeline (max 500 characters). */
10050
10628
  description?: string;
10051
- /** @description New name for the pipeline (3-100 characters). */
10052
- name?: string;
10629
+ /** @description New display name for the pipeline (2-128 characters). */
10630
+ displayName?: string;
10053
10631
  /** @description New status for the pipeline. */
10054
10632
  status?: components["schemas"]["PipelineStatus"];
10055
10633
  };
@@ -10063,14 +10641,14 @@ interface components {
10063
10641
  definition?: components["schemas"]["Policy"];
10064
10642
  /** @description Policy description. */
10065
10643
  description?: string;
10066
- /** @description Human-readable policy name. */
10067
- name?: string;
10644
+ /** @description Human-readable policy display name. */
10645
+ displayName?: string;
10068
10646
  };
10069
10647
  /** @description Request payload for updating an existing workspace webhook. */
10070
10648
  UpdateWebhook: {
10071
10649
  /** @description Updated description of the webhook's purpose (max 500 characters). */
10072
10650
  description?: string;
10073
- /** @description Updated human-readable name for the webhook (1-100 characters). */
10651
+ /** @description Updated human-readable name for the webhook (1-128 characters). */
10074
10652
  displayName?: string;
10075
10653
  /** @description Updated list of event types this webhook should receive. */
10076
10654
  events?: components["schemas"]["WebhookEvent"][];
@@ -10095,13 +10673,11 @@ interface components {
10095
10673
  UpdateWorkspace: {
10096
10674
  /** @description New description for the workspace (max 500 characters). */
10097
10675
  description?: string;
10098
- /** @description New display name for the workspace (3-32 characters). */
10676
+ /** @description New display name for the workspace (2-32 characters). */
10099
10677
  displayName?: string;
10100
10678
  /** @description Whether approval is required for processed files to be visible. */
10101
10679
  requireApproval?: boolean;
10102
10680
  };
10103
- /** @description Public account handle used in URLs (e.g. /accounts/{username}). */
10104
- Username: string;
10105
10681
  /** @description Validation error details for field-specific errors. */
10106
10682
  ValidationErrorDetail: {
10107
10683
  /** @description Error code for the validation failure */
@@ -10130,7 +10706,7 @@ interface components {
10130
10706
  */
10131
10707
  createdAt: string;
10132
10708
  /** @description Handle of the account that created this webhook. */
10133
- creatorUsername: components["schemas"]["Username"];
10709
+ creatorUsername: components["schemas"]["Handle"];
10134
10710
  /** @description Detailed description of the webhook's purpose. */
10135
10711
  description: string;
10136
10712
  /** @description Human-readable name for the webhook. */
@@ -10157,8 +10733,8 @@ interface components {
10157
10733
  updatedAt: string;
10158
10734
  /** @description The URL to send webhook payloads to. */
10159
10735
  url: string;
10160
- /** @description Slug of the workspace this webhook belongs to. */
10161
- workspaceSlug: components["schemas"]["Slug"];
10736
+ /** @description Handle of the workspace this webhook belongs to. */
10737
+ workspaceSlug: components["schemas"]["Handle"];
10162
10738
  };
10163
10739
  /**
10164
10740
  * @description Webhook creation response that includes the secret (visible only once).
@@ -10174,7 +10750,7 @@ interface components {
10174
10750
  */
10175
10751
  createdAt: string;
10176
10752
  /** @description Handle of the account that created this webhook. */
10177
- creatorUsername: components["schemas"]["Username"];
10753
+ creatorUsername: components["schemas"]["Handle"];
10178
10754
  /** @description Detailed description of the webhook's purpose. */
10179
10755
  description: string;
10180
10756
  /** @description Human-readable name for the webhook. */
@@ -10208,8 +10784,8 @@ interface components {
10208
10784
  updatedAt: string;
10209
10785
  /** @description The URL to send webhook payloads to. */
10210
10786
  url: string;
10211
- /** @description Slug of the workspace this webhook belongs to. */
10212
- workspaceSlug: components["schemas"]["Slug"];
10787
+ /** @description Handle of the workspace this webhook belongs to. */
10788
+ workspaceSlug: components["schemas"]["Handle"];
10213
10789
  };
10214
10790
  /**
10215
10791
  * @description Defines the types of events that can trigger webhook delivery.
@@ -10271,7 +10847,7 @@ interface components {
10271
10847
  */
10272
10848
  createdAt: string;
10273
10849
  /** @description Handle of the account that created this workspace. */
10274
- creatorUsername: components["schemas"]["Username"];
10850
+ creatorUsername: components["schemas"]["Handle"];
10275
10851
  /** @description Description of the workspace. */
10276
10852
  description?: string;
10277
10853
  /** @description Display name of the workspace. */
@@ -10281,7 +10857,7 @@ interface components {
10281
10857
  /** @description Whether approval is required to processed files to be visible. */
10282
10858
  requireApproval: boolean;
10283
10859
  /** @description URL-safe workspace identifier. */
10284
- slug: components["schemas"]["Slug"];
10860
+ slug: components["schemas"]["Handle"];
10285
10861
  /** @description Tags associated with the workspace. */
10286
10862
  tags: string[];
10287
10863
  /**
@@ -10371,6 +10947,10 @@ type CreateConnection = Schemas$12["CreateConnection"];
10371
10947
  type UpdateConnection = Schemas$12["UpdateConnection"];
10372
10948
  type ConnectionsQuery = Schemas$12["ConnectionsQuery"];
10373
10949
  type ConnectionsPage = Schemas$12["ConnectionsPage"];
10950
+ type SyncConnection = Schemas$12["SyncConnection"];
10951
+ type ConnectionSync = Schemas$12["ConnectionSync"];
10952
+ type ConnectionSyncsPage = Schemas$12["ConnectionSyncsPage"];
10953
+ type ConnectionVerification = Schemas$12["ConnectionVerification"];
10374
10954
  //#endregion
10375
10955
  //#region src/datatypes/error.d.ts
10376
10956
  type Schemas$11 = components["schemas"];
@@ -10381,8 +10961,9 @@ type ValidationErrorDetail = Schemas$11["ValidationErrorDetail"];
10381
10961
  type Schemas$10 = components["schemas"];
10382
10962
  type File = Schemas$10["File"];
10383
10963
  type UpdateFile = Schemas$10["UpdateFile"];
10384
- type FileFormat = Schemas$10["FileFormat"];
10385
10964
  type FileSource = Schemas$10["FileSource"];
10965
+ type FormatToken = Schemas$10["FormatToken"];
10966
+ type ModalityToken = Schemas$10["ModalityToken"];
10386
10967
  type ListFiles = Schemas$10["ListFiles"];
10387
10968
  type FilesPage = Schemas$10["FilesPage"];
10388
10969
  //#endregion
@@ -10391,7 +10972,6 @@ type Schemas$9 = components["schemas"];
10391
10972
  type Health = Schemas$9["Health"];
10392
10973
  type HealthStatus = Schemas$9["HealthStatus"];
10393
10974
  type ComponentHealth = Schemas$9["ComponentHealth"];
10394
- type CheckHealth = Schemas$9["CheckHealth"];
10395
10975
  //#endregion
10396
10976
  //#region src/datatypes/invite.d.ts
10397
10977
  type Schemas$8 = components["schemas"];
@@ -10480,5 +11060,5 @@ type UpdateWorkspace = Schemas["UpdateWorkspace"];
10480
11060
  type WorkspaceRole = Schemas["WorkspaceRole"];
10481
11061
  type WorkspacesPage = Schemas["WorkspacesPage"];
10482
11062
  //#endregion
10483
- 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 };
10484
- //# sourceMappingURL=index-D-y57n8p.d.ts.map
11063
+ export { InvitePreview as $, PipelineFilter as A, Signup as At, NotificationsPage as B, ActivityType as Bt, PolicyAction as C, ConnectionsPage as Ct, CreatePipeline as D, UpdateConnection as Dt, UpdatePolicy as E, SyncConnection as Et, UpdatePipeline as F, CreateApiToken as Ft, MemberSortField as G, UpdateNotificationSettings as H, PublicAccount as Ht, CursorPagination as I, TokenExpiration as It, CreateInvite as J, MembersPage as K, Notification as L, UpdateApiToken as Lt, PipelineSummariesPage as M, ApiTokenType as Mt, PipelineSummary as N, ApiTokenWithJWT as Nt, Pipeline as O, AuthToken as Ot, PipelineTriggerType as P, ApiTokensPage as Pt, InviteExpiration as Q, NotificationEvent as R, ActivitiesPage as Rt, Policy as S, ConnectionVerification as St, PolicyRule as T, CreateConnection as Tt, ListMembers as U, UpdateAccount as Ut, UnreadStatus as V, Account as Vt, Member as W, paths as Wt, Invite as X, GenerateInviteCode as Y, InviteCode as Z, PipelineRun as _, ErrorResponse as _t, WorkspacesPage as a, ReplyInvite as at, CreatePolicy as b, ConnectionSync as bt, UpdateWebhook as c, Health as ct, WebhookEvent as d, FileSource as dt, InviteSent as et, WebhookResult as f, FilesPage as ft, CreatePipelineRun as g, UpdateFile as gt, AnalyzedDocument as h, ModalityToken as ht, WorkspaceRole as i, ListInvites as it, PipelineStatus as j, ApiToken as jt, PipelineDefinition as k, Login as kt, Webhook as l, HealthStatus as lt, WebhooksPage as m, ListFiles as mt, UpdateWorkspace as n, InviteStatus as nt, CreateWebhook as o, SortOrder as ot, WebhookStatus as p, FormatToken as pt, UpdateMember as q, Workspace as r, InvitesPage as rt, TestWebhook as s, ComponentHealth as st, CreateWorkspace as t, InviteSortField as tt, WebhookCreated as u, File as ut, PipelineRunStatus as v, ValidationErrorDetail as vt, PolicyDefinition as w, ConnectionsQuery as wt, PoliciesPage as x, ConnectionSyncsPage as xt, PipelineRunsPage as y, Connection as yt, NotificationSettings as z, Activity as zt };
11064
+ //# sourceMappingURL=index-D1bAc98R.d.ts.map