@nvisy/sdk 0.11.0 → 0.13.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 +37 -1
- package/README.md +1 -7
- package/dist/auth/index.d.ts +1 -1
- package/dist/auth/index.js +1 -1
- package/dist/{client-SOt0c3k7.d.ts → client-DN7ckSJH.d.ts} +2 -16
- package/dist/client-DN7ckSJH.d.ts.map +1 -0
- package/dist/datatypes/index.d.ts +2 -2
- package/dist/error-C_RvXw4Z.js +51 -0
- package/dist/error-C_RvXw4Z.js.map +1 -0
- package/dist/{error-DmkKaDjI.js → errors-BOLD8iC1.js} +2 -49
- package/dist/errors-BOLD8iC1.js.map +1 -0
- package/dist/errors-BfCfSpmA.d.ts +127 -0
- package/dist/errors-BfCfSpmA.d.ts.map +1 -0
- package/dist/{index-BAyMQmm6.d.ts → index-HUG77R_t.d.ts} +932 -884
- package/dist/index-HUG77R_t.d.ts.map +1 -0
- package/dist/index.d.ts +4 -128
- package/dist/index.js +3 -2
- package/dist/index.js.map +1 -1
- package/dist/services/index.d.ts +1 -1
- package/dist/services/index.js +1 -1
- package/dist/{services-CL2QOOlO.js → services-DjORFrh_.js} +1 -27
- package/dist/services-DjORFrh_.js.map +1 -0
- package/dist/webhooks/index.d.ts +144 -0
- package/dist/webhooks/index.d.ts.map +1 -0
- package/dist/webhooks/index.js +147 -0
- package/dist/webhooks/index.js.map +1 -0
- package/package.json +14 -4
- package/dist/client-SOt0c3k7.d.ts.map +0 -1
- package/dist/error-DmkKaDjI.js.map +0 -1
- package/dist/index-BAyMQmm6.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/services-CL2QOOlO.js.map +0 -1
|
@@ -299,61 +299,7 @@ interface paths {
|
|
|
299
299
|
path?: never;
|
|
300
300
|
cookie?: never;
|
|
301
301
|
};
|
|
302
|
-
|
|
303
|
-
* Get account avatar
|
|
304
|
-
* @description Returns the account's avatar image (WebP). 404 when unset.
|
|
305
|
-
*/
|
|
306
|
-
get: {
|
|
307
|
-
parameters: {
|
|
308
|
-
query?: never;
|
|
309
|
-
header?: never;
|
|
310
|
-
path: {
|
|
311
|
-
/** @description Public handle of the account. */
|
|
312
|
-
username: components["schemas"]["Handle"];
|
|
313
|
-
};
|
|
314
|
-
cookie?: never;
|
|
315
|
-
};
|
|
316
|
-
requestBody?: never;
|
|
317
|
-
responses: {
|
|
318
|
-
/** @description no content */
|
|
319
|
-
200: {
|
|
320
|
-
headers: {
|
|
321
|
-
[name: string]: unknown;
|
|
322
|
-
};
|
|
323
|
-
content?: never;
|
|
324
|
-
};
|
|
325
|
-
/**
|
|
326
|
-
* @description HTTP error response representation with security-conscious design.
|
|
327
|
-
*
|
|
328
|
-
* This struct contains all the information needed to serialize an error
|
|
329
|
-
* response, including the error name, message, HTTP status code, resource
|
|
330
|
-
* information, and user-friendly messages.
|
|
331
|
-
*/
|
|
332
|
-
401: {
|
|
333
|
-
headers: {
|
|
334
|
-
[name: string]: unknown;
|
|
335
|
-
};
|
|
336
|
-
content: {
|
|
337
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
338
|
-
};
|
|
339
|
-
};
|
|
340
|
-
/**
|
|
341
|
-
* @description HTTP error response representation with security-conscious design.
|
|
342
|
-
*
|
|
343
|
-
* This struct contains all the information needed to serialize an error
|
|
344
|
-
* response, including the error name, message, HTTP status code, resource
|
|
345
|
-
* information, and user-friendly messages.
|
|
346
|
-
*/
|
|
347
|
-
404: {
|
|
348
|
-
headers: {
|
|
349
|
-
[name: string]: unknown;
|
|
350
|
-
};
|
|
351
|
-
content: {
|
|
352
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
353
|
-
};
|
|
354
|
-
};
|
|
355
|
-
};
|
|
356
|
-
};
|
|
302
|
+
get?: never;
|
|
357
303
|
/**
|
|
358
304
|
* Upload account avatar
|
|
359
305
|
* @description Uploads and normalizes the account's avatar. Only the account itself may set it.
|
|
@@ -916,6 +862,128 @@ interface paths {
|
|
|
916
862
|
};
|
|
917
863
|
trace?: never;
|
|
918
864
|
};
|
|
865
|
+
"/notifications/": {
|
|
866
|
+
parameters: {
|
|
867
|
+
query?: never;
|
|
868
|
+
header?: never;
|
|
869
|
+
path?: never;
|
|
870
|
+
cookie?: never;
|
|
871
|
+
};
|
|
872
|
+
/**
|
|
873
|
+
* List notifications
|
|
874
|
+
* @description Returns all notifications for the authenticated account and marks them as read.
|
|
875
|
+
*/
|
|
876
|
+
get: {
|
|
877
|
+
parameters: {
|
|
878
|
+
query?: {
|
|
879
|
+
/**
|
|
880
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
881
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
882
|
+
*/
|
|
883
|
+
after?: string;
|
|
884
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
885
|
+
limit?: number;
|
|
886
|
+
};
|
|
887
|
+
header?: never;
|
|
888
|
+
path?: never;
|
|
889
|
+
cookie?: never;
|
|
890
|
+
};
|
|
891
|
+
requestBody?: never;
|
|
892
|
+
responses: {
|
|
893
|
+
/**
|
|
894
|
+
* @description Generic paginated response wrapper.
|
|
895
|
+
*
|
|
896
|
+
* Provides a consistent structure for all paginated API responses with
|
|
897
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
898
|
+
* are more items to fetch.
|
|
899
|
+
*/
|
|
900
|
+
200: {
|
|
901
|
+
headers: {
|
|
902
|
+
[name: string]: unknown;
|
|
903
|
+
};
|
|
904
|
+
content: {
|
|
905
|
+
"application/json": components["schemas"]["NotificationPage"];
|
|
906
|
+
};
|
|
907
|
+
};
|
|
908
|
+
/**
|
|
909
|
+
* @description HTTP error response representation with security-conscious design.
|
|
910
|
+
*
|
|
911
|
+
* This struct contains all the information needed to serialize an error
|
|
912
|
+
* response, including the error name, message, HTTP status code, resource
|
|
913
|
+
* information, and user-friendly messages.
|
|
914
|
+
*/
|
|
915
|
+
401: {
|
|
916
|
+
headers: {
|
|
917
|
+
[name: string]: unknown;
|
|
918
|
+
};
|
|
919
|
+
content: {
|
|
920
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
921
|
+
};
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
};
|
|
925
|
+
put?: never;
|
|
926
|
+
post?: never;
|
|
927
|
+
delete?: never;
|
|
928
|
+
options?: never;
|
|
929
|
+
head?: never;
|
|
930
|
+
patch?: never;
|
|
931
|
+
trace?: never;
|
|
932
|
+
};
|
|
933
|
+
"/notifications/unread/": {
|
|
934
|
+
parameters: {
|
|
935
|
+
query?: never;
|
|
936
|
+
header?: never;
|
|
937
|
+
path?: never;
|
|
938
|
+
cookie?: never;
|
|
939
|
+
};
|
|
940
|
+
/**
|
|
941
|
+
* Get unread notifications count
|
|
942
|
+
* @description Returns the number of unread notifications for the authenticated account.
|
|
943
|
+
*/
|
|
944
|
+
get: {
|
|
945
|
+
parameters: {
|
|
946
|
+
query?: never;
|
|
947
|
+
header?: never;
|
|
948
|
+
path?: never;
|
|
949
|
+
cookie?: never;
|
|
950
|
+
};
|
|
951
|
+
requestBody?: never;
|
|
952
|
+
responses: {
|
|
953
|
+
/** @description Response type for unread notifications status. */
|
|
954
|
+
200: {
|
|
955
|
+
headers: {
|
|
956
|
+
[name: string]: unknown;
|
|
957
|
+
};
|
|
958
|
+
content: {
|
|
959
|
+
"application/json": components["schemas"]["UnreadStatus"];
|
|
960
|
+
};
|
|
961
|
+
};
|
|
962
|
+
/**
|
|
963
|
+
* @description HTTP error response representation with security-conscious design.
|
|
964
|
+
*
|
|
965
|
+
* This struct contains all the information needed to serialize an error
|
|
966
|
+
* response, including the error name, message, HTTP status code, resource
|
|
967
|
+
* information, and user-friendly messages.
|
|
968
|
+
*/
|
|
969
|
+
401: {
|
|
970
|
+
headers: {
|
|
971
|
+
[name: string]: unknown;
|
|
972
|
+
};
|
|
973
|
+
content: {
|
|
974
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
975
|
+
};
|
|
976
|
+
};
|
|
977
|
+
};
|
|
978
|
+
};
|
|
979
|
+
put?: never;
|
|
980
|
+
post?: never;
|
|
981
|
+
delete?: never;
|
|
982
|
+
options?: never;
|
|
983
|
+
head?: never;
|
|
984
|
+
patch?: never;
|
|
985
|
+
trace?: never;
|
|
986
|
+
};
|
|
919
987
|
"/workspaces/": {
|
|
920
988
|
parameters: {
|
|
921
989
|
query?: never;
|
|
@@ -1327,76 +1395,7 @@ interface paths {
|
|
|
1327
1395
|
path?: never;
|
|
1328
1396
|
cookie?: never;
|
|
1329
1397
|
};
|
|
1330
|
-
|
|
1331
|
-
* Get workspace avatar
|
|
1332
|
-
* @description Returns the workspace's avatar image (WebP). 404 when unset.
|
|
1333
|
-
*/
|
|
1334
|
-
get: {
|
|
1335
|
-
parameters: {
|
|
1336
|
-
query?: never;
|
|
1337
|
-
header?: never;
|
|
1338
|
-
path: {
|
|
1339
|
-
/** @description URL-safe workspace identifier. */
|
|
1340
|
-
workspaceSlug: string;
|
|
1341
|
-
};
|
|
1342
|
-
cookie?: never;
|
|
1343
|
-
};
|
|
1344
|
-
requestBody?: never;
|
|
1345
|
-
responses: {
|
|
1346
|
-
/** @description no content */
|
|
1347
|
-
200: {
|
|
1348
|
-
headers: {
|
|
1349
|
-
[name: string]: unknown;
|
|
1350
|
-
};
|
|
1351
|
-
content?: never;
|
|
1352
|
-
};
|
|
1353
|
-
/**
|
|
1354
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1355
|
-
*
|
|
1356
|
-
* This struct contains all the information needed to serialize an error
|
|
1357
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1358
|
-
* information, and user-friendly messages.
|
|
1359
|
-
*/
|
|
1360
|
-
401: {
|
|
1361
|
-
headers: {
|
|
1362
|
-
[name: string]: unknown;
|
|
1363
|
-
};
|
|
1364
|
-
content: {
|
|
1365
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1366
|
-
};
|
|
1367
|
-
};
|
|
1368
|
-
/**
|
|
1369
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1370
|
-
*
|
|
1371
|
-
* This struct contains all the information needed to serialize an error
|
|
1372
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1373
|
-
* information, and user-friendly messages.
|
|
1374
|
-
*/
|
|
1375
|
-
403: {
|
|
1376
|
-
headers: {
|
|
1377
|
-
[name: string]: unknown;
|
|
1378
|
-
};
|
|
1379
|
-
content: {
|
|
1380
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1381
|
-
};
|
|
1382
|
-
};
|
|
1383
|
-
/**
|
|
1384
|
-
* @description HTTP error response representation with security-conscious design.
|
|
1385
|
-
*
|
|
1386
|
-
* This struct contains all the information needed to serialize an error
|
|
1387
|
-
* response, including the error name, message, HTTP status code, resource
|
|
1388
|
-
* information, and user-friendly messages.
|
|
1389
|
-
*/
|
|
1390
|
-
404: {
|
|
1391
|
-
headers: {
|
|
1392
|
-
[name: string]: unknown;
|
|
1393
|
-
};
|
|
1394
|
-
content: {
|
|
1395
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
1396
|
-
};
|
|
1397
|
-
};
|
|
1398
|
-
};
|
|
1399
|
-
};
|
|
1398
|
+
get?: never;
|
|
1400
1399
|
/**
|
|
1401
1400
|
* Upload workspace avatar
|
|
1402
1401
|
* @description Uploads and normalizes the workspace's avatar. Requires UpdateWorkspace.
|
|
@@ -1815,7 +1814,7 @@ interface paths {
|
|
|
1815
1814
|
patch?: never;
|
|
1816
1815
|
trace?: never;
|
|
1817
1816
|
};
|
|
1818
|
-
"/workspaces/{workspaceSlug}/
|
|
1817
|
+
"/workspaces/{workspaceSlug}/members/": {
|
|
1819
1818
|
parameters: {
|
|
1820
1819
|
query?: never;
|
|
1821
1820
|
header?: never;
|
|
@@ -1823,24 +1822,27 @@ interface paths {
|
|
|
1823
1822
|
cookie?: never;
|
|
1824
1823
|
};
|
|
1825
1824
|
/**
|
|
1826
|
-
* List
|
|
1827
|
-
* @description Returns
|
|
1825
|
+
* List members
|
|
1826
|
+
* @description Returns a paginated list of workspace members with their roles and status.
|
|
1828
1827
|
*/
|
|
1829
1828
|
get: {
|
|
1830
1829
|
parameters: {
|
|
1831
1830
|
query?: {
|
|
1831
|
+
/** @description Filter by 2FA status. */
|
|
1832
|
+
has2fa?: boolean;
|
|
1833
|
+
/** @description Sort order (asc or desc). */
|
|
1834
|
+
order?: components["schemas"]["SortOrder"];
|
|
1835
|
+
/** @description Filter by workspace role. */
|
|
1836
|
+
role?: components["schemas"]["WorkspaceRole"];
|
|
1837
|
+
/** @description Sort by field. */
|
|
1838
|
+
sortBy?: components["schemas"]["MemberSortField"];
|
|
1832
1839
|
/**
|
|
1833
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
1834
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
1835
|
-
*/
|
|
1836
|
-
after?: string;
|
|
1837
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1838
|
-
limit?: number;
|
|
1839
|
-
/**
|
|
1840
|
-
* @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
|
|
1841
|
-
* matches if it uses any of the given providers. Empty means no filter.
|
|
1840
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
1841
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
1842
1842
|
*/
|
|
1843
|
-
|
|
1843
|
+
after?: string;
|
|
1844
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
1845
|
+
limit?: number;
|
|
1844
1846
|
};
|
|
1845
1847
|
header?: never;
|
|
1846
1848
|
path: {
|
|
@@ -1863,7 +1865,7 @@ interface paths {
|
|
|
1863
1865
|
[name: string]: unknown;
|
|
1864
1866
|
};
|
|
1865
1867
|
content: {
|
|
1866
|
-
"application/json": components["schemas"]["
|
|
1868
|
+
"application/json": components["schemas"]["MemberPage"];
|
|
1867
1869
|
};
|
|
1868
1870
|
};
|
|
1869
1871
|
/**
|
|
@@ -1896,12 +1898,43 @@ interface paths {
|
|
|
1896
1898
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1897
1899
|
};
|
|
1898
1900
|
};
|
|
1901
|
+
/**
|
|
1902
|
+
* @description HTTP error response representation with security-conscious design.
|
|
1903
|
+
*
|
|
1904
|
+
* This struct contains all the information needed to serialize an error
|
|
1905
|
+
* response, including the error name, message, HTTP status code, resource
|
|
1906
|
+
* information, and user-friendly messages.
|
|
1907
|
+
*/
|
|
1908
|
+
404: {
|
|
1909
|
+
headers: {
|
|
1910
|
+
[name: string]: unknown;
|
|
1911
|
+
};
|
|
1912
|
+
content: {
|
|
1913
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1914
|
+
};
|
|
1915
|
+
};
|
|
1899
1916
|
};
|
|
1900
1917
|
};
|
|
1901
1918
|
put?: never;
|
|
1919
|
+
post?: never;
|
|
1920
|
+
delete?: never;
|
|
1921
|
+
options?: never;
|
|
1922
|
+
head?: never;
|
|
1923
|
+
patch?: never;
|
|
1924
|
+
trace?: never;
|
|
1925
|
+
};
|
|
1926
|
+
"/workspaces/{workspaceSlug}/members/leave/": {
|
|
1927
|
+
parameters: {
|
|
1928
|
+
query?: never;
|
|
1929
|
+
header?: never;
|
|
1930
|
+
path?: never;
|
|
1931
|
+
cookie?: never;
|
|
1932
|
+
};
|
|
1933
|
+
get?: never;
|
|
1934
|
+
put?: never;
|
|
1902
1935
|
/**
|
|
1903
|
-
*
|
|
1904
|
-
* @description
|
|
1936
|
+
* Leave workspace
|
|
1937
|
+
* @description Allows a member to voluntarily leave a workspace.
|
|
1905
1938
|
*/
|
|
1906
1939
|
post: {
|
|
1907
1940
|
parameters: {
|
|
@@ -1913,26 +1946,14 @@ interface paths {
|
|
|
1913
1946
|
};
|
|
1914
1947
|
cookie?: never;
|
|
1915
1948
|
};
|
|
1916
|
-
|
|
1917
|
-
requestBody: {
|
|
1918
|
-
content: {
|
|
1919
|
-
"application/json": components["schemas"]["CreateConnection"];
|
|
1920
|
-
};
|
|
1921
|
-
};
|
|
1949
|
+
requestBody?: never;
|
|
1922
1950
|
responses: {
|
|
1923
|
-
/**
|
|
1924
|
-
|
|
1925
|
-
*
|
|
1926
|
-
* Note: The encrypted connection data is never exposed in API responses.
|
|
1927
|
-
* Only metadata about the connection is returned.
|
|
1928
|
-
*/
|
|
1929
|
-
201: {
|
|
1951
|
+
/** @description no content */
|
|
1952
|
+
200: {
|
|
1930
1953
|
headers: {
|
|
1931
1954
|
[name: string]: unknown;
|
|
1932
1955
|
};
|
|
1933
|
-
content
|
|
1934
|
-
"application/json": components["schemas"]["Connection"];
|
|
1935
|
-
};
|
|
1956
|
+
content?: never;
|
|
1936
1957
|
};
|
|
1937
1958
|
/**
|
|
1938
1959
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -1971,7 +1992,7 @@ interface paths {
|
|
|
1971
1992
|
* response, including the error name, message, HTTP status code, resource
|
|
1972
1993
|
* information, and user-friendly messages.
|
|
1973
1994
|
*/
|
|
1974
|
-
|
|
1995
|
+
404: {
|
|
1975
1996
|
headers: {
|
|
1976
1997
|
[name: string]: unknown;
|
|
1977
1998
|
};
|
|
@@ -1979,24 +2000,6 @@ interface paths {
|
|
|
1979
2000
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
1980
2001
|
};
|
|
1981
2002
|
};
|
|
1982
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
1983
|
-
415: {
|
|
1984
|
-
headers: {
|
|
1985
|
-
[name: string]: unknown;
|
|
1986
|
-
};
|
|
1987
|
-
content: {
|
|
1988
|
-
"text/plain": string;
|
|
1989
|
-
};
|
|
1990
|
-
};
|
|
1991
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
1992
|
-
422: {
|
|
1993
|
-
headers: {
|
|
1994
|
-
[name: string]: unknown;
|
|
1995
|
-
};
|
|
1996
|
-
content: {
|
|
1997
|
-
"text/plain": string;
|
|
1998
|
-
};
|
|
1999
|
-
};
|
|
2000
2003
|
};
|
|
2001
2004
|
};
|
|
2002
2005
|
delete?: never;
|
|
@@ -2005,7 +2008,7 @@ interface paths {
|
|
|
2005
2008
|
patch?: never;
|
|
2006
2009
|
trace?: never;
|
|
2007
2010
|
};
|
|
2008
|
-
"/workspaces/{workspaceSlug}/
|
|
2011
|
+
"/workspaces/{workspaceSlug}/members/{username}/": {
|
|
2009
2012
|
parameters: {
|
|
2010
2013
|
query?: never;
|
|
2011
2014
|
header?: never;
|
|
@@ -2013,8 +2016,8 @@ interface paths {
|
|
|
2013
2016
|
cookie?: never;
|
|
2014
2017
|
};
|
|
2015
2018
|
/**
|
|
2016
|
-
* Get
|
|
2017
|
-
* @description Returns
|
|
2019
|
+
* Get member
|
|
2020
|
+
* @description Returns detailed information about a specific workspace member.
|
|
2018
2021
|
*/
|
|
2019
2022
|
get: {
|
|
2020
2023
|
parameters: {
|
|
@@ -2023,25 +2026,20 @@ interface paths {
|
|
|
2023
2026
|
path: {
|
|
2024
2027
|
/** @description URL-safe workspace identifier. */
|
|
2025
2028
|
workspaceSlug: string;
|
|
2026
|
-
/** @description
|
|
2027
|
-
|
|
2029
|
+
/** @description Public handle of the member's account. */
|
|
2030
|
+
username: components["schemas"]["Handle"];
|
|
2028
2031
|
};
|
|
2029
2032
|
cookie?: never;
|
|
2030
2033
|
};
|
|
2031
2034
|
requestBody?: never;
|
|
2032
2035
|
responses: {
|
|
2033
|
-
/**
|
|
2034
|
-
* @description Response type for a workspace connection.
|
|
2035
|
-
*
|
|
2036
|
-
* Note: The encrypted connection data is never exposed in API responses.
|
|
2037
|
-
* Only metadata about the connection is returned.
|
|
2038
|
-
*/
|
|
2036
|
+
/** @description Represents a workspace member. */
|
|
2039
2037
|
200: {
|
|
2040
2038
|
headers: {
|
|
2041
2039
|
[name: string]: unknown;
|
|
2042
2040
|
};
|
|
2043
2041
|
content: {
|
|
2044
|
-
"application/json": components["schemas"]["
|
|
2042
|
+
"application/json": components["schemas"]["Member"];
|
|
2045
2043
|
};
|
|
2046
2044
|
};
|
|
2047
2045
|
/**
|
|
@@ -2094,8 +2092,8 @@ interface paths {
|
|
|
2094
2092
|
put?: never;
|
|
2095
2093
|
post?: never;
|
|
2096
2094
|
/**
|
|
2097
|
-
*
|
|
2098
|
-
* @description
|
|
2095
|
+
* Remove member
|
|
2096
|
+
* @description Permanently removes a member from the workspace. Cannot remove owners or yourself.
|
|
2099
2097
|
*/
|
|
2100
2098
|
delete: {
|
|
2101
2099
|
parameters: {
|
|
@@ -2104,20 +2102,35 @@ interface paths {
|
|
|
2104
2102
|
path: {
|
|
2105
2103
|
/** @description URL-safe workspace identifier. */
|
|
2106
2104
|
workspaceSlug: string;
|
|
2107
|
-
/** @description
|
|
2108
|
-
|
|
2105
|
+
/** @description Public handle of the member's account. */
|
|
2106
|
+
username: components["schemas"]["Handle"];
|
|
2109
2107
|
};
|
|
2110
2108
|
cookie?: never;
|
|
2111
2109
|
};
|
|
2112
2110
|
requestBody?: never;
|
|
2113
2111
|
responses: {
|
|
2114
2112
|
/** @description no content */
|
|
2115
|
-
|
|
2113
|
+
200: {
|
|
2116
2114
|
headers: {
|
|
2117
2115
|
[name: string]: unknown;
|
|
2118
2116
|
};
|
|
2119
2117
|
content?: never;
|
|
2120
2118
|
};
|
|
2119
|
+
/**
|
|
2120
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2121
|
+
*
|
|
2122
|
+
* This struct contains all the information needed to serialize an error
|
|
2123
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2124
|
+
* information, and user-friendly messages.
|
|
2125
|
+
*/
|
|
2126
|
+
400: {
|
|
2127
|
+
headers: {
|
|
2128
|
+
[name: string]: unknown;
|
|
2129
|
+
};
|
|
2130
|
+
content: {
|
|
2131
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2132
|
+
};
|
|
2133
|
+
};
|
|
2121
2134
|
/**
|
|
2122
2135
|
* @description HTTP error response representation with security-conscious design.
|
|
2123
2136
|
*
|
|
@@ -2168,8 +2181,8 @@ interface paths {
|
|
|
2168
2181
|
options?: never;
|
|
2169
2182
|
head?: never;
|
|
2170
2183
|
/**
|
|
2171
|
-
* Update
|
|
2172
|
-
* @description Updates
|
|
2184
|
+
* Update member role
|
|
2185
|
+
* @description Updates a workspace member's role. Cannot update your own role or demote owners.
|
|
2173
2186
|
*/
|
|
2174
2187
|
patch: {
|
|
2175
2188
|
parameters: {
|
|
@@ -2178,30 +2191,25 @@ interface paths {
|
|
|
2178
2191
|
path: {
|
|
2179
2192
|
/** @description URL-safe workspace identifier. */
|
|
2180
2193
|
workspaceSlug: string;
|
|
2181
|
-
/** @description
|
|
2182
|
-
|
|
2194
|
+
/** @description Public handle of the member's account. */
|
|
2195
|
+
username: components["schemas"]["Handle"];
|
|
2183
2196
|
};
|
|
2184
2197
|
cookie?: never;
|
|
2185
2198
|
};
|
|
2186
|
-
/** @description Request
|
|
2199
|
+
/** @description Request to update a member's role. */
|
|
2187
2200
|
requestBody: {
|
|
2188
2201
|
content: {
|
|
2189
|
-
"application/json": components["schemas"]["
|
|
2202
|
+
"application/json": components["schemas"]["UpdateMember"];
|
|
2190
2203
|
};
|
|
2191
2204
|
};
|
|
2192
2205
|
responses: {
|
|
2193
|
-
/**
|
|
2194
|
-
* @description Response type for a workspace connection.
|
|
2195
|
-
*
|
|
2196
|
-
* Note: The encrypted connection data is never exposed in API responses.
|
|
2197
|
-
* Only metadata about the connection is returned.
|
|
2198
|
-
*/
|
|
2206
|
+
/** @description Represents a workspace member. */
|
|
2199
2207
|
200: {
|
|
2200
2208
|
headers: {
|
|
2201
2209
|
[name: string]: unknown;
|
|
2202
2210
|
};
|
|
2203
2211
|
content: {
|
|
2204
|
-
"application/json": components["schemas"]["
|
|
2212
|
+
"application/json": components["schemas"]["Member"];
|
|
2205
2213
|
};
|
|
2206
2214
|
};
|
|
2207
2215
|
/**
|
|
@@ -2286,40 +2294,56 @@ interface paths {
|
|
|
2286
2294
|
};
|
|
2287
2295
|
trace?: never;
|
|
2288
2296
|
};
|
|
2289
|
-
"/workspaces/{workspaceSlug}/
|
|
2297
|
+
"/workspaces/{workspaceSlug}/invites/": {
|
|
2290
2298
|
parameters: {
|
|
2291
2299
|
query?: never;
|
|
2292
2300
|
header?: never;
|
|
2293
2301
|
path?: never;
|
|
2294
2302
|
cookie?: never;
|
|
2295
2303
|
};
|
|
2296
|
-
get?: never;
|
|
2297
|
-
put?: never;
|
|
2298
2304
|
/**
|
|
2299
|
-
*
|
|
2300
|
-
* @description
|
|
2305
|
+
* List invitations
|
|
2306
|
+
* @description Returns a paginated list of workspace invitations with their current status.
|
|
2301
2307
|
*/
|
|
2302
|
-
|
|
2308
|
+
get: {
|
|
2303
2309
|
parameters: {
|
|
2304
|
-
query?:
|
|
2310
|
+
query?: {
|
|
2311
|
+
/** @description Sort order (asc or desc). */
|
|
2312
|
+
order?: components["schemas"]["SortOrder"];
|
|
2313
|
+
/** @description Filter by invited role. */
|
|
2314
|
+
role?: components["schemas"]["WorkspaceRole"];
|
|
2315
|
+
/** @description Sort by field. */
|
|
2316
|
+
sortBy?: components["schemas"]["InviteSortField"];
|
|
2317
|
+
/**
|
|
2318
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
2319
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
2320
|
+
*/
|
|
2321
|
+
after?: string;
|
|
2322
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2323
|
+
limit?: number;
|
|
2324
|
+
};
|
|
2305
2325
|
header?: never;
|
|
2306
2326
|
path: {
|
|
2307
2327
|
/** @description URL-safe workspace identifier. */
|
|
2308
2328
|
workspaceSlug: string;
|
|
2309
|
-
/** @description Opaque identifier of the connection. */
|
|
2310
|
-
connectionId: components["schemas"]["ConnectionId"];
|
|
2311
2329
|
};
|
|
2312
2330
|
cookie?: never;
|
|
2313
2331
|
};
|
|
2314
2332
|
requestBody?: never;
|
|
2315
2333
|
responses: {
|
|
2316
|
-
/**
|
|
2334
|
+
/**
|
|
2335
|
+
* @description Generic paginated response wrapper.
|
|
2336
|
+
*
|
|
2337
|
+
* Provides a consistent structure for all paginated API responses with
|
|
2338
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2339
|
+
* are more items to fetch.
|
|
2340
|
+
*/
|
|
2317
2341
|
200: {
|
|
2318
2342
|
headers: {
|
|
2319
2343
|
[name: string]: unknown;
|
|
2320
2344
|
};
|
|
2321
2345
|
content: {
|
|
2322
|
-
"application/json": components["schemas"]["
|
|
2346
|
+
"application/json": components["schemas"]["InvitePage"];
|
|
2323
2347
|
};
|
|
2324
2348
|
};
|
|
2325
2349
|
/**
|
|
@@ -2352,6 +2376,45 @@ interface paths {
|
|
|
2352
2376
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2353
2377
|
};
|
|
2354
2378
|
};
|
|
2379
|
+
};
|
|
2380
|
+
};
|
|
2381
|
+
put?: never;
|
|
2382
|
+
/**
|
|
2383
|
+
* Send invitation
|
|
2384
|
+
* @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.
|
|
2385
|
+
*/
|
|
2386
|
+
post: {
|
|
2387
|
+
parameters: {
|
|
2388
|
+
query?: never;
|
|
2389
|
+
header?: never;
|
|
2390
|
+
path: {
|
|
2391
|
+
/** @description URL-safe workspace identifier. */
|
|
2392
|
+
workspaceSlug: string;
|
|
2393
|
+
};
|
|
2394
|
+
cookie?: never;
|
|
2395
|
+
};
|
|
2396
|
+
/** @description Request payload for creating a new workspace invite. */
|
|
2397
|
+
requestBody: {
|
|
2398
|
+
content: {
|
|
2399
|
+
"application/json": components["schemas"]["CreateInvite"];
|
|
2400
|
+
};
|
|
2401
|
+
};
|
|
2402
|
+
responses: {
|
|
2403
|
+
/**
|
|
2404
|
+
* @description Acknowledgement returned after sending a workspace invitation.
|
|
2405
|
+
*
|
|
2406
|
+
* The response is deliberately uniform: it carries no invite identifier or
|
|
2407
|
+
* status, so it is identical whether or not the address belonged to a known
|
|
2408
|
+
* account and cannot be used to probe for account existence.
|
|
2409
|
+
*/
|
|
2410
|
+
200: {
|
|
2411
|
+
headers: {
|
|
2412
|
+
[name: string]: unknown;
|
|
2413
|
+
};
|
|
2414
|
+
content: {
|
|
2415
|
+
"application/json": components["schemas"]["InviteSent"];
|
|
2416
|
+
};
|
|
2417
|
+
};
|
|
2355
2418
|
/**
|
|
2356
2419
|
* @description HTTP error response representation with security-conscious design.
|
|
2357
2420
|
*
|
|
@@ -2359,7 +2422,7 @@ interface paths {
|
|
|
2359
2422
|
* response, including the error name, message, HTTP status code, resource
|
|
2360
2423
|
* information, and user-friendly messages.
|
|
2361
2424
|
*/
|
|
2362
|
-
|
|
2425
|
+
400: {
|
|
2363
2426
|
headers: {
|
|
2364
2427
|
[name: string]: unknown;
|
|
2365
2428
|
};
|
|
@@ -2367,68 +2430,6 @@ interface paths {
|
|
|
2367
2430
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2368
2431
|
};
|
|
2369
2432
|
};
|
|
2370
|
-
};
|
|
2371
|
-
};
|
|
2372
|
-
delete?: never;
|
|
2373
|
-
options?: never;
|
|
2374
|
-
head?: never;
|
|
2375
|
-
patch?: never;
|
|
2376
|
-
trace?: never;
|
|
2377
|
-
};
|
|
2378
|
-
"/workspaces/{workspaceSlug}/syncs/": {
|
|
2379
|
-
parameters: {
|
|
2380
|
-
query?: never;
|
|
2381
|
-
header?: never;
|
|
2382
|
-
path?: never;
|
|
2383
|
-
cookie?: never;
|
|
2384
|
-
};
|
|
2385
|
-
/**
|
|
2386
|
-
* List workspace syncs
|
|
2387
|
-
* @description Returns all sync runs across the workspace's connections, most recent first, with optional status and provider filters.
|
|
2388
|
-
*/
|
|
2389
|
-
get: {
|
|
2390
|
-
parameters: {
|
|
2391
|
-
query?: {
|
|
2392
|
-
/**
|
|
2393
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
2394
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
2395
|
-
*/
|
|
2396
|
-
after?: string;
|
|
2397
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2398
|
-
limit?: number;
|
|
2399
|
-
/**
|
|
2400
|
-
* @description Filter by connection provider (`s3`, `azure`, `gcs`). Repeatable; a sync
|
|
2401
|
-
* matches if its connection uses any of the given providers. Empty means no
|
|
2402
|
-
* provider filter.
|
|
2403
|
-
*/
|
|
2404
|
-
provider?: string[];
|
|
2405
|
-
/** @description Filter by sync status. */
|
|
2406
|
-
status?: components["schemas"]["SyncStatus"];
|
|
2407
|
-
};
|
|
2408
|
-
header?: never;
|
|
2409
|
-
path: {
|
|
2410
|
-
/** @description URL-safe workspace identifier. */
|
|
2411
|
-
workspaceSlug: string;
|
|
2412
|
-
};
|
|
2413
|
-
cookie?: never;
|
|
2414
|
-
};
|
|
2415
|
-
requestBody?: never;
|
|
2416
|
-
responses: {
|
|
2417
|
-
/**
|
|
2418
|
-
* @description Generic paginated response wrapper.
|
|
2419
|
-
*
|
|
2420
|
-
* Provides a consistent structure for all paginated API responses with
|
|
2421
|
-
* cursor-based pagination support. When `next_cursor` is present, there
|
|
2422
|
-
* are more items to fetch.
|
|
2423
|
-
*/
|
|
2424
|
-
200: {
|
|
2425
|
-
headers: {
|
|
2426
|
-
[name: string]: unknown;
|
|
2427
|
-
};
|
|
2428
|
-
content: {
|
|
2429
|
-
"application/json": components["schemas"]["ConnectionSyncPage"];
|
|
2430
|
-
};
|
|
2431
|
-
};
|
|
2432
2433
|
/**
|
|
2433
2434
|
* @description HTTP error response representation with security-conscious design.
|
|
2434
2435
|
*
|
|
@@ -2466,7 +2467,7 @@ interface paths {
|
|
|
2466
2467
|
* response, including the error name, message, HTTP status code, resource
|
|
2467
2468
|
* information, and user-friendly messages.
|
|
2468
2469
|
*/
|
|
2469
|
-
|
|
2470
|
+
409: {
|
|
2470
2471
|
headers: {
|
|
2471
2472
|
[name: string]: unknown;
|
|
2472
2473
|
};
|
|
@@ -2474,17 +2475,33 @@ interface paths {
|
|
|
2474
2475
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2475
2476
|
};
|
|
2476
2477
|
};
|
|
2478
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2479
|
+
415: {
|
|
2480
|
+
headers: {
|
|
2481
|
+
[name: string]: unknown;
|
|
2482
|
+
};
|
|
2483
|
+
content: {
|
|
2484
|
+
"text/plain": string;
|
|
2485
|
+
};
|
|
2486
|
+
};
|
|
2487
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2488
|
+
422: {
|
|
2489
|
+
headers: {
|
|
2490
|
+
[name: string]: unknown;
|
|
2491
|
+
};
|
|
2492
|
+
content: {
|
|
2493
|
+
"text/plain": string;
|
|
2494
|
+
};
|
|
2495
|
+
};
|
|
2477
2496
|
};
|
|
2478
2497
|
};
|
|
2479
|
-
put?: never;
|
|
2480
|
-
post?: never;
|
|
2481
2498
|
delete?: never;
|
|
2482
2499
|
options?: never;
|
|
2483
2500
|
head?: never;
|
|
2484
2501
|
patch?: never;
|
|
2485
2502
|
trace?: never;
|
|
2486
2503
|
};
|
|
2487
|
-
"/workspaces/{workspaceSlug}/
|
|
2504
|
+
"/workspaces/{workspaceSlug}/invites/code/": {
|
|
2488
2505
|
parameters: {
|
|
2489
2506
|
query?: never;
|
|
2490
2507
|
header?: never;
|
|
@@ -2494,8 +2511,8 @@ interface paths {
|
|
|
2494
2511
|
get?: never;
|
|
2495
2512
|
put?: never;
|
|
2496
2513
|
/**
|
|
2497
|
-
*
|
|
2498
|
-
* @description
|
|
2514
|
+
* Generate invite code
|
|
2515
|
+
* @description Creates a shareable invite code that can be used by anyone to join the workspace.
|
|
2499
2516
|
*/
|
|
2500
2517
|
post: {
|
|
2501
2518
|
parameters: {
|
|
@@ -2504,33 +2521,23 @@ interface paths {
|
|
|
2504
2521
|
path: {
|
|
2505
2522
|
/** @description URL-safe workspace identifier. */
|
|
2506
2523
|
workspaceSlug: string;
|
|
2507
|
-
/** @description Opaque identifier of the connection. */
|
|
2508
|
-
connectionId: components["schemas"]["ConnectionId"];
|
|
2509
2524
|
};
|
|
2510
2525
|
cookie?: never;
|
|
2511
2526
|
};
|
|
2512
|
-
/**
|
|
2513
|
-
* @description Request payload to trigger a connection sync.
|
|
2514
|
-
*
|
|
2515
|
-
* The direction is determined by the connection's configured `sync_mode`.
|
|
2516
|
-
* - Import connections need no body: the sync fetches every not-yet-imported
|
|
2517
|
-
* object under the connection's root path.
|
|
2518
|
-
* - Export connections push one workspace file (`file_id`) to one object
|
|
2519
|
-
* `key`; both are required for export and ignored for import.
|
|
2520
|
-
*/
|
|
2527
|
+
/** @description Request to generate a shareable invite code for a workspace. */
|
|
2521
2528
|
requestBody: {
|
|
2522
2529
|
content: {
|
|
2523
|
-
"application/json": components["schemas"]["
|
|
2530
|
+
"application/json": components["schemas"]["GenerateInviteCode"];
|
|
2524
2531
|
};
|
|
2525
2532
|
};
|
|
2526
2533
|
responses: {
|
|
2527
|
-
/** @description
|
|
2528
|
-
|
|
2534
|
+
/** @description Response containing a generated shareable invite code. */
|
|
2535
|
+
201: {
|
|
2529
2536
|
headers: {
|
|
2530
2537
|
[name: string]: unknown;
|
|
2531
2538
|
};
|
|
2532
2539
|
content: {
|
|
2533
|
-
"application/json": components["schemas"]["
|
|
2540
|
+
"application/json": components["schemas"]["InviteCode"];
|
|
2534
2541
|
};
|
|
2535
2542
|
};
|
|
2536
2543
|
/**
|
|
@@ -2578,21 +2585,6 @@ interface paths {
|
|
|
2578
2585
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2579
2586
|
};
|
|
2580
2587
|
};
|
|
2581
|
-
/**
|
|
2582
|
-
* @description HTTP error response representation with security-conscious design.
|
|
2583
|
-
*
|
|
2584
|
-
* This struct contains all the information needed to serialize an error
|
|
2585
|
-
* response, including the error name, message, HTTP status code, resource
|
|
2586
|
-
* information, and user-friendly messages.
|
|
2587
|
-
*/
|
|
2588
|
-
404: {
|
|
2589
|
-
headers: {
|
|
2590
|
-
[name: string]: unknown;
|
|
2591
|
-
};
|
|
2592
|
-
content: {
|
|
2593
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
2594
|
-
};
|
|
2595
|
-
};
|
|
2596
2588
|
/** @description Expected request with `Content-Type: application/json` */
|
|
2597
2589
|
415: {
|
|
2598
2590
|
headers: {
|
|
@@ -2619,52 +2611,68 @@ interface paths {
|
|
|
2619
2611
|
patch?: never;
|
|
2620
2612
|
trace?: never;
|
|
2621
2613
|
};
|
|
2622
|
-
"/workspaces/{workspaceSlug}/
|
|
2614
|
+
"/workspaces/{workspaceSlug}/invites/{inviteId}/": {
|
|
2623
2615
|
parameters: {
|
|
2624
2616
|
query?: never;
|
|
2625
2617
|
header?: never;
|
|
2626
2618
|
path?: never;
|
|
2627
2619
|
cookie?: never;
|
|
2628
2620
|
};
|
|
2621
|
+
get?: never;
|
|
2622
|
+
put?: never;
|
|
2629
2623
|
/**
|
|
2630
|
-
*
|
|
2631
|
-
* @description
|
|
2624
|
+
* Reply to invitation
|
|
2625
|
+
* @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.
|
|
2632
2626
|
*/
|
|
2633
|
-
|
|
2627
|
+
post: {
|
|
2634
2628
|
parameters: {
|
|
2635
|
-
query?:
|
|
2636
|
-
/**
|
|
2637
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
2638
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
2639
|
-
*/
|
|
2640
|
-
after?: string;
|
|
2641
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2642
|
-
limit?: number;
|
|
2643
|
-
};
|
|
2629
|
+
query?: never;
|
|
2644
2630
|
header?: never;
|
|
2645
2631
|
path: {
|
|
2646
2632
|
/** @description URL-safe workspace identifier. */
|
|
2647
2633
|
workspaceSlug: string;
|
|
2648
|
-
/** @description
|
|
2649
|
-
|
|
2634
|
+
/** @description Unique identifier of the invite. */
|
|
2635
|
+
inviteId: string;
|
|
2650
2636
|
};
|
|
2651
2637
|
cookie?: never;
|
|
2652
2638
|
};
|
|
2653
|
-
|
|
2639
|
+
/** @description Request to respond to a workspace invitation. */
|
|
2640
|
+
requestBody: {
|
|
2641
|
+
content: {
|
|
2642
|
+
"application/json": components["schemas"]["ReplyInvite"];
|
|
2643
|
+
};
|
|
2644
|
+
};
|
|
2654
2645
|
responses: {
|
|
2646
|
+
200: {
|
|
2647
|
+
headers: {
|
|
2648
|
+
[name: string]: unknown;
|
|
2649
|
+
};
|
|
2650
|
+
content: {
|
|
2651
|
+
"application/json": components["schemas"]["Member"] | null;
|
|
2652
|
+
};
|
|
2653
|
+
};
|
|
2654
|
+
/** @description Represents a workspace member. */
|
|
2655
|
+
201: {
|
|
2656
|
+
headers: {
|
|
2657
|
+
[name: string]: unknown;
|
|
2658
|
+
};
|
|
2659
|
+
content: {
|
|
2660
|
+
"application/json": components["schemas"]["Member"];
|
|
2661
|
+
};
|
|
2662
|
+
};
|
|
2655
2663
|
/**
|
|
2656
|
-
* @description
|
|
2664
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2657
2665
|
*
|
|
2658
|
-
*
|
|
2659
|
-
*
|
|
2660
|
-
*
|
|
2666
|
+
* This struct contains all the information needed to serialize an error
|
|
2667
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2668
|
+
* information, and user-friendly messages.
|
|
2661
2669
|
*/
|
|
2662
|
-
|
|
2670
|
+
400: {
|
|
2663
2671
|
headers: {
|
|
2664
2672
|
[name: string]: unknown;
|
|
2665
2673
|
};
|
|
2666
2674
|
content: {
|
|
2667
|
-
"application/json": components["schemas"]["
|
|
2675
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2668
2676
|
};
|
|
2669
2677
|
};
|
|
2670
2678
|
/**
|
|
@@ -2689,7 +2697,7 @@ interface paths {
|
|
|
2689
2697
|
* response, including the error name, message, HTTP status code, resource
|
|
2690
2698
|
* information, and user-friendly messages.
|
|
2691
2699
|
*/
|
|
2692
|
-
|
|
2700
|
+
404: {
|
|
2693
2701
|
headers: {
|
|
2694
2702
|
[name: string]: unknown;
|
|
2695
2703
|
};
|
|
@@ -2704,7 +2712,7 @@ interface paths {
|
|
|
2704
2712
|
* response, including the error name, message, HTTP status code, resource
|
|
2705
2713
|
* information, and user-friendly messages.
|
|
2706
2714
|
*/
|
|
2707
|
-
|
|
2715
|
+
409: {
|
|
2708
2716
|
headers: {
|
|
2709
2717
|
[name: string]: unknown;
|
|
2710
2718
|
};
|
|
@@ -2712,51 +2720,50 @@ interface paths {
|
|
|
2712
2720
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2713
2721
|
};
|
|
2714
2722
|
};
|
|
2723
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2724
|
+
415: {
|
|
2725
|
+
headers: {
|
|
2726
|
+
[name: string]: unknown;
|
|
2727
|
+
};
|
|
2728
|
+
content: {
|
|
2729
|
+
"text/plain": string;
|
|
2730
|
+
};
|
|
2731
|
+
};
|
|
2732
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2733
|
+
422: {
|
|
2734
|
+
headers: {
|
|
2735
|
+
[name: string]: unknown;
|
|
2736
|
+
};
|
|
2737
|
+
content: {
|
|
2738
|
+
"text/plain": string;
|
|
2739
|
+
};
|
|
2740
|
+
};
|
|
2715
2741
|
};
|
|
2716
2742
|
};
|
|
2717
|
-
put?: never;
|
|
2718
|
-
post?: never;
|
|
2719
|
-
delete?: never;
|
|
2720
|
-
options?: never;
|
|
2721
|
-
head?: never;
|
|
2722
|
-
patch?: never;
|
|
2723
|
-
trace?: never;
|
|
2724
|
-
};
|
|
2725
|
-
"/workspaces/{workspaceSlug}/connections/{connectionId}/syncs/{syncId}/": {
|
|
2726
|
-
parameters: {
|
|
2727
|
-
query?: never;
|
|
2728
|
-
header?: never;
|
|
2729
|
-
path?: never;
|
|
2730
|
-
cookie?: never;
|
|
2731
|
-
};
|
|
2732
2743
|
/**
|
|
2733
|
-
*
|
|
2734
|
-
* @description
|
|
2744
|
+
* Cancel invitation
|
|
2745
|
+
* @description Permanently cancels a pending invitation. The invitee will no longer be able to accept it.
|
|
2735
2746
|
*/
|
|
2736
|
-
|
|
2747
|
+
delete: {
|
|
2737
2748
|
parameters: {
|
|
2738
2749
|
query?: never;
|
|
2739
2750
|
header?: never;
|
|
2740
2751
|
path: {
|
|
2741
2752
|
/** @description URL-safe workspace identifier. */
|
|
2742
2753
|
workspaceSlug: string;
|
|
2743
|
-
/** @description
|
|
2744
|
-
|
|
2745
|
-
/** @description Unique identifier of the sync run. */
|
|
2746
|
-
syncId: string;
|
|
2754
|
+
/** @description Unique identifier of the invite. */
|
|
2755
|
+
inviteId: string;
|
|
2747
2756
|
};
|
|
2748
2757
|
cookie?: never;
|
|
2749
2758
|
};
|
|
2750
2759
|
requestBody?: never;
|
|
2751
2760
|
responses: {
|
|
2752
|
-
/** @description
|
|
2761
|
+
/** @description no content */
|
|
2753
2762
|
200: {
|
|
2754
2763
|
headers: {
|
|
2755
2764
|
[name: string]: unknown;
|
|
2756
2765
|
};
|
|
2757
|
-
content
|
|
2758
|
-
"application/json": components["schemas"]["ConnectionSync"];
|
|
2759
|
-
};
|
|
2766
|
+
content?: never;
|
|
2760
2767
|
};
|
|
2761
2768
|
/**
|
|
2762
2769
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -2805,50 +2812,46 @@ interface paths {
|
|
|
2805
2812
|
};
|
|
2806
2813
|
};
|
|
2807
2814
|
};
|
|
2808
|
-
put?: never;
|
|
2809
|
-
post?: never;
|
|
2810
|
-
delete?: never;
|
|
2811
2815
|
options?: never;
|
|
2812
2816
|
head?: never;
|
|
2813
2817
|
patch?: never;
|
|
2814
2818
|
trace?: never;
|
|
2815
2819
|
};
|
|
2816
|
-
"/
|
|
2820
|
+
"/invites/code/{inviteCode}/": {
|
|
2817
2821
|
parameters: {
|
|
2818
2822
|
query?: never;
|
|
2819
2823
|
header?: never;
|
|
2820
2824
|
path?: never;
|
|
2821
2825
|
cookie?: never;
|
|
2822
2826
|
};
|
|
2823
|
-
get?: never;
|
|
2824
|
-
put?: never;
|
|
2825
2827
|
/**
|
|
2826
|
-
*
|
|
2827
|
-
* @description
|
|
2828
|
+
* Preview invite
|
|
2829
|
+
* @description Returns workspace information for an invite code, allowing users to preview the workspace before joining. Does not require authentication.
|
|
2828
2830
|
*/
|
|
2829
|
-
|
|
2831
|
+
get: {
|
|
2830
2832
|
parameters: {
|
|
2831
2833
|
query?: never;
|
|
2832
2834
|
header?: never;
|
|
2833
2835
|
path: {
|
|
2834
|
-
/** @description
|
|
2835
|
-
|
|
2836
|
-
/** @description Opaque identifier of the connection. */
|
|
2837
|
-
connectionId: components["schemas"]["ConnectionId"];
|
|
2838
|
-
/** @description Unique identifier of the sync run. */
|
|
2839
|
-
syncId: string;
|
|
2836
|
+
/** @description The invite code to use for joining the workspace. */
|
|
2837
|
+
inviteCode: string;
|
|
2840
2838
|
};
|
|
2841
2839
|
cookie?: never;
|
|
2842
2840
|
};
|
|
2843
2841
|
requestBody?: never;
|
|
2844
2842
|
responses: {
|
|
2845
|
-
/**
|
|
2843
|
+
/**
|
|
2844
|
+
* @description Preview of an invite with workspace details for display before joining.
|
|
2845
|
+
*
|
|
2846
|
+
* This is a public-facing response that shows workspace information
|
|
2847
|
+
* to help users decide whether to join via an invite code.
|
|
2848
|
+
*/
|
|
2846
2849
|
200: {
|
|
2847
2850
|
headers: {
|
|
2848
2851
|
[name: string]: unknown;
|
|
2849
2852
|
};
|
|
2850
2853
|
content: {
|
|
2851
|
-
"application/json": components["schemas"]["
|
|
2854
|
+
"application/json": components["schemas"]["InvitePreview"];
|
|
2852
2855
|
};
|
|
2853
2856
|
};
|
|
2854
2857
|
/**
|
|
@@ -2858,7 +2861,7 @@ interface paths {
|
|
|
2858
2861
|
* response, including the error name, message, HTTP status code, resource
|
|
2859
2862
|
* information, and user-friendly messages.
|
|
2860
2863
|
*/
|
|
2861
|
-
|
|
2864
|
+
400: {
|
|
2862
2865
|
headers: {
|
|
2863
2866
|
[name: string]: unknown;
|
|
2864
2867
|
};
|
|
@@ -2873,7 +2876,77 @@ interface paths {
|
|
|
2873
2876
|
* response, including the error name, message, HTTP status code, resource
|
|
2874
2877
|
* information, and user-friendly messages.
|
|
2875
2878
|
*/
|
|
2876
|
-
|
|
2879
|
+
404: {
|
|
2880
|
+
headers: {
|
|
2881
|
+
[name: string]: unknown;
|
|
2882
|
+
};
|
|
2883
|
+
content: {
|
|
2884
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2885
|
+
};
|
|
2886
|
+
};
|
|
2887
|
+
};
|
|
2888
|
+
};
|
|
2889
|
+
put?: never;
|
|
2890
|
+
/**
|
|
2891
|
+
* Reply to invite code
|
|
2892
|
+
* @description Accepts or declines a workspace invite code. If accepted (the default when no body is provided), the user becomes a member with the role specified in the code. If declined, no action is taken.
|
|
2893
|
+
*/
|
|
2894
|
+
post: {
|
|
2895
|
+
parameters: {
|
|
2896
|
+
query?: never;
|
|
2897
|
+
header?: never;
|
|
2898
|
+
path: {
|
|
2899
|
+
/** @description The invite code to use for joining the workspace. */
|
|
2900
|
+
inviteCode: string;
|
|
2901
|
+
};
|
|
2902
|
+
cookie?: never;
|
|
2903
|
+
};
|
|
2904
|
+
requestBody: {
|
|
2905
|
+
content: {
|
|
2906
|
+
"application/json": components["schemas"]["ReplyInvite"] | null;
|
|
2907
|
+
};
|
|
2908
|
+
};
|
|
2909
|
+
responses: {
|
|
2910
|
+
200: {
|
|
2911
|
+
headers: {
|
|
2912
|
+
[name: string]: unknown;
|
|
2913
|
+
};
|
|
2914
|
+
content: {
|
|
2915
|
+
"application/json": components["schemas"]["Member"] | null;
|
|
2916
|
+
};
|
|
2917
|
+
};
|
|
2918
|
+
/** @description Represents a workspace member. */
|
|
2919
|
+
201: {
|
|
2920
|
+
headers: {
|
|
2921
|
+
[name: string]: unknown;
|
|
2922
|
+
};
|
|
2923
|
+
content: {
|
|
2924
|
+
"application/json": components["schemas"]["Member"];
|
|
2925
|
+
};
|
|
2926
|
+
};
|
|
2927
|
+
/**
|
|
2928
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2929
|
+
*
|
|
2930
|
+
* This struct contains all the information needed to serialize an error
|
|
2931
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2932
|
+
* information, and user-friendly messages.
|
|
2933
|
+
*/
|
|
2934
|
+
400: {
|
|
2935
|
+
headers: {
|
|
2936
|
+
[name: string]: unknown;
|
|
2937
|
+
};
|
|
2938
|
+
content: {
|
|
2939
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
2940
|
+
};
|
|
2941
|
+
};
|
|
2942
|
+
/**
|
|
2943
|
+
* @description HTTP error response representation with security-conscious design.
|
|
2944
|
+
*
|
|
2945
|
+
* This struct contains all the information needed to serialize an error
|
|
2946
|
+
* response, including the error name, message, HTTP status code, resource
|
|
2947
|
+
* information, and user-friendly messages.
|
|
2948
|
+
*/
|
|
2949
|
+
401: {
|
|
2877
2950
|
headers: {
|
|
2878
2951
|
[name: string]: unknown;
|
|
2879
2952
|
};
|
|
@@ -2911,6 +2984,24 @@ interface paths {
|
|
|
2911
2984
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
2912
2985
|
};
|
|
2913
2986
|
};
|
|
2987
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
2988
|
+
415: {
|
|
2989
|
+
headers: {
|
|
2990
|
+
[name: string]: unknown;
|
|
2991
|
+
};
|
|
2992
|
+
content: {
|
|
2993
|
+
"text/plain": string;
|
|
2994
|
+
};
|
|
2995
|
+
};
|
|
2996
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
2997
|
+
422: {
|
|
2998
|
+
headers: {
|
|
2999
|
+
[name: string]: unknown;
|
|
3000
|
+
};
|
|
3001
|
+
content: {
|
|
3002
|
+
"text/plain": string;
|
|
3003
|
+
};
|
|
3004
|
+
};
|
|
2914
3005
|
};
|
|
2915
3006
|
};
|
|
2916
3007
|
delete?: never;
|
|
@@ -2919,7 +3010,7 @@ interface paths {
|
|
|
2919
3010
|
patch?: never;
|
|
2920
3011
|
trace?: never;
|
|
2921
3012
|
};
|
|
2922
|
-
"/workspaces/{workspaceSlug}/
|
|
3013
|
+
"/workspaces/{workspaceSlug}/connections/": {
|
|
2923
3014
|
parameters: {
|
|
2924
3015
|
query?: never;
|
|
2925
3016
|
header?: never;
|
|
@@ -2927,18 +3018,12 @@ interface paths {
|
|
|
2927
3018
|
cookie?: never;
|
|
2928
3019
|
};
|
|
2929
3020
|
/**
|
|
2930
|
-
* List
|
|
2931
|
-
* @description Returns
|
|
3021
|
+
* List connections
|
|
3022
|
+
* @description Returns all configured connections for the workspace. Only metadata is returned; encrypted credentials are never exposed.
|
|
2932
3023
|
*/
|
|
2933
3024
|
get: {
|
|
2934
3025
|
parameters: {
|
|
2935
3026
|
query?: {
|
|
2936
|
-
/** @description Sort order (asc or desc). */
|
|
2937
|
-
order?: components["schemas"]["SortOrder"];
|
|
2938
|
-
/** @description Filter by invited role. */
|
|
2939
|
-
role?: components["schemas"]["WorkspaceRole"];
|
|
2940
|
-
/** @description Sort by field. */
|
|
2941
|
-
sortBy?: components["schemas"]["InviteSortField"];
|
|
2942
3027
|
/**
|
|
2943
3028
|
* @description Cursor pointing to the last item of the previous page.
|
|
2944
3029
|
* Obtain this from the `nextCursor` field in the response.
|
|
@@ -2946,6 +3031,11 @@ interface paths {
|
|
|
2946
3031
|
after?: string;
|
|
2947
3032
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
2948
3033
|
limit?: number;
|
|
3034
|
+
/**
|
|
3035
|
+
* @description Filter by provider (`s3`, `azure`, `gcs`). Repeatable; a connection
|
|
3036
|
+
* matches if it uses any of the given providers. Empty means no filter.
|
|
3037
|
+
*/
|
|
3038
|
+
provider?: string[];
|
|
2949
3039
|
};
|
|
2950
3040
|
header?: never;
|
|
2951
3041
|
path: {
|
|
@@ -2968,7 +3058,7 @@ interface paths {
|
|
|
2968
3058
|
[name: string]: unknown;
|
|
2969
3059
|
};
|
|
2970
3060
|
content: {
|
|
2971
|
-
"application/json": components["schemas"]["
|
|
3061
|
+
"application/json": components["schemas"]["ConnectionPage"];
|
|
2972
3062
|
};
|
|
2973
3063
|
};
|
|
2974
3064
|
/**
|
|
@@ -3005,8 +3095,8 @@ interface paths {
|
|
|
3005
3095
|
};
|
|
3006
3096
|
put?: never;
|
|
3007
3097
|
/**
|
|
3008
|
-
*
|
|
3009
|
-
* @description
|
|
3098
|
+
* Create connection
|
|
3099
|
+
* @description Creates a new provider connection for the workspace. Connection data is encrypted and stored securely. The response includes connection metadata but never exposes the encrypted credentials.
|
|
3010
3100
|
*/
|
|
3011
3101
|
post: {
|
|
3012
3102
|
parameters: {
|
|
@@ -3018,26 +3108,25 @@ interface paths {
|
|
|
3018
3108
|
};
|
|
3019
3109
|
cookie?: never;
|
|
3020
3110
|
};
|
|
3021
|
-
/** @description Request payload for creating a new workspace
|
|
3111
|
+
/** @description Request payload for creating a new workspace connection. */
|
|
3022
3112
|
requestBody: {
|
|
3023
3113
|
content: {
|
|
3024
|
-
"application/json": components["schemas"]["
|
|
3114
|
+
"application/json": components["schemas"]["CreateConnection"];
|
|
3025
3115
|
};
|
|
3026
3116
|
};
|
|
3027
3117
|
responses: {
|
|
3028
3118
|
/**
|
|
3029
|
-
* @description
|
|
3119
|
+
* @description Response type for a workspace connection.
|
|
3030
3120
|
*
|
|
3031
|
-
* The
|
|
3032
|
-
*
|
|
3033
|
-
* account and cannot be used to probe for account existence.
|
|
3121
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
3122
|
+
* Only metadata about the connection is returned.
|
|
3034
3123
|
*/
|
|
3035
|
-
|
|
3124
|
+
201: {
|
|
3036
3125
|
headers: {
|
|
3037
3126
|
[name: string]: unknown;
|
|
3038
3127
|
};
|
|
3039
3128
|
content: {
|
|
3040
|
-
"application/json": components["schemas"]["
|
|
3129
|
+
"application/json": components["schemas"]["Connection"];
|
|
3041
3130
|
};
|
|
3042
3131
|
};
|
|
3043
3132
|
/**
|
|
@@ -3085,21 +3174,6 @@ interface paths {
|
|
|
3085
3174
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3086
3175
|
};
|
|
3087
3176
|
};
|
|
3088
|
-
/**
|
|
3089
|
-
* @description HTTP error response representation with security-conscious design.
|
|
3090
|
-
*
|
|
3091
|
-
* This struct contains all the information needed to serialize an error
|
|
3092
|
-
* response, including the error name, message, HTTP status code, resource
|
|
3093
|
-
* information, and user-friendly messages.
|
|
3094
|
-
*/
|
|
3095
|
-
409: {
|
|
3096
|
-
headers: {
|
|
3097
|
-
[name: string]: unknown;
|
|
3098
|
-
};
|
|
3099
|
-
content: {
|
|
3100
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
3101
|
-
};
|
|
3102
|
-
};
|
|
3103
3177
|
/** @description Expected request with `Content-Type: application/json` */
|
|
3104
3178
|
415: {
|
|
3105
3179
|
headers: {
|
|
@@ -3126,43 +3200,43 @@ interface paths {
|
|
|
3126
3200
|
patch?: never;
|
|
3127
3201
|
trace?: never;
|
|
3128
3202
|
};
|
|
3129
|
-
"/workspaces/{workspaceSlug}/
|
|
3203
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/": {
|
|
3130
3204
|
parameters: {
|
|
3131
3205
|
query?: never;
|
|
3132
3206
|
header?: never;
|
|
3133
3207
|
path?: never;
|
|
3134
3208
|
cookie?: never;
|
|
3135
3209
|
};
|
|
3136
|
-
get?: never;
|
|
3137
|
-
put?: never;
|
|
3138
3210
|
/**
|
|
3139
|
-
*
|
|
3140
|
-
* @description
|
|
3211
|
+
* Get connection
|
|
3212
|
+
* @description Returns connection metadata without encrypted credentials.
|
|
3141
3213
|
*/
|
|
3142
|
-
|
|
3214
|
+
get: {
|
|
3143
3215
|
parameters: {
|
|
3144
3216
|
query?: never;
|
|
3145
3217
|
header?: never;
|
|
3146
3218
|
path: {
|
|
3147
3219
|
/** @description URL-safe workspace identifier. */
|
|
3148
3220
|
workspaceSlug: string;
|
|
3221
|
+
/** @description Opaque identifier of the connection. */
|
|
3222
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
3149
3223
|
};
|
|
3150
3224
|
cookie?: never;
|
|
3151
3225
|
};
|
|
3152
|
-
|
|
3153
|
-
requestBody: {
|
|
3154
|
-
content: {
|
|
3155
|
-
"application/json": components["schemas"]["GenerateInviteCode"];
|
|
3156
|
-
};
|
|
3157
|
-
};
|
|
3226
|
+
requestBody?: never;
|
|
3158
3227
|
responses: {
|
|
3159
|
-
/**
|
|
3160
|
-
|
|
3228
|
+
/**
|
|
3229
|
+
* @description Response type for a workspace connection.
|
|
3230
|
+
*
|
|
3231
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
3232
|
+
* Only metadata about the connection is returned.
|
|
3233
|
+
*/
|
|
3234
|
+
200: {
|
|
3161
3235
|
headers: {
|
|
3162
3236
|
[name: string]: unknown;
|
|
3163
3237
|
};
|
|
3164
3238
|
content: {
|
|
3165
|
-
"application/json": components["schemas"]["
|
|
3239
|
+
"application/json": components["schemas"]["Connection"];
|
|
3166
3240
|
};
|
|
3167
3241
|
};
|
|
3168
3242
|
/**
|
|
@@ -3172,7 +3246,7 @@ interface paths {
|
|
|
3172
3246
|
* response, including the error name, message, HTTP status code, resource
|
|
3173
3247
|
* information, and user-friendly messages.
|
|
3174
3248
|
*/
|
|
3175
|
-
|
|
3249
|
+
401: {
|
|
3176
3250
|
headers: {
|
|
3177
3251
|
[name: string]: unknown;
|
|
3178
3252
|
};
|
|
@@ -3187,7 +3261,7 @@ interface paths {
|
|
|
3187
3261
|
* response, including the error name, message, HTTP status code, resource
|
|
3188
3262
|
* information, and user-friendly messages.
|
|
3189
3263
|
*/
|
|
3190
|
-
|
|
3264
|
+
403: {
|
|
3191
3265
|
headers: {
|
|
3192
3266
|
[name: string]: unknown;
|
|
3193
3267
|
};
|
|
@@ -3202,7 +3276,7 @@ interface paths {
|
|
|
3202
3276
|
* response, including the error name, message, HTTP status code, resource
|
|
3203
3277
|
* information, and user-friendly messages.
|
|
3204
3278
|
*/
|
|
3205
|
-
|
|
3279
|
+
404: {
|
|
3206
3280
|
headers: {
|
|
3207
3281
|
[name: string]: unknown;
|
|
3208
3282
|
};
|
|
@@ -3210,95 +3284,34 @@ interface paths {
|
|
|
3210
3284
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3211
3285
|
};
|
|
3212
3286
|
};
|
|
3213
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
3214
|
-
415: {
|
|
3215
|
-
headers: {
|
|
3216
|
-
[name: string]: unknown;
|
|
3217
|
-
};
|
|
3218
|
-
content: {
|
|
3219
|
-
"text/plain": string;
|
|
3220
|
-
};
|
|
3221
|
-
};
|
|
3222
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
3223
|
-
422: {
|
|
3224
|
-
headers: {
|
|
3225
|
-
[name: string]: unknown;
|
|
3226
|
-
};
|
|
3227
|
-
content: {
|
|
3228
|
-
"text/plain": string;
|
|
3229
|
-
};
|
|
3230
|
-
};
|
|
3231
3287
|
};
|
|
3232
3288
|
};
|
|
3233
|
-
delete?: never;
|
|
3234
|
-
options?: never;
|
|
3235
|
-
head?: never;
|
|
3236
|
-
patch?: never;
|
|
3237
|
-
trace?: never;
|
|
3238
|
-
};
|
|
3239
|
-
"/workspaces/{workspaceSlug}/invites/{inviteId}/": {
|
|
3240
|
-
parameters: {
|
|
3241
|
-
query?: never;
|
|
3242
|
-
header?: never;
|
|
3243
|
-
path?: never;
|
|
3244
|
-
cookie?: never;
|
|
3245
|
-
};
|
|
3246
|
-
get?: never;
|
|
3247
3289
|
put?: never;
|
|
3290
|
+
post?: never;
|
|
3248
3291
|
/**
|
|
3249
|
-
*
|
|
3250
|
-
* @description
|
|
3292
|
+
* Delete connection
|
|
3293
|
+
* @description Soft-deletes the connection from the workspace.
|
|
3251
3294
|
*/
|
|
3252
|
-
|
|
3295
|
+
delete: {
|
|
3253
3296
|
parameters: {
|
|
3254
3297
|
query?: never;
|
|
3255
3298
|
header?: never;
|
|
3256
3299
|
path: {
|
|
3257
3300
|
/** @description URL-safe workspace identifier. */
|
|
3258
3301
|
workspaceSlug: string;
|
|
3259
|
-
/** @description
|
|
3260
|
-
|
|
3302
|
+
/** @description Opaque identifier of the connection. */
|
|
3303
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
3261
3304
|
};
|
|
3262
3305
|
cookie?: never;
|
|
3263
3306
|
};
|
|
3264
|
-
|
|
3265
|
-
requestBody: {
|
|
3266
|
-
content: {
|
|
3267
|
-
"application/json": components["schemas"]["ReplyInvite"];
|
|
3268
|
-
};
|
|
3269
|
-
};
|
|
3307
|
+
requestBody?: never;
|
|
3270
3308
|
responses: {
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
[name: string]: unknown;
|
|
3274
|
-
};
|
|
3275
|
-
content: {
|
|
3276
|
-
"application/json": components["schemas"]["Member"] | null;
|
|
3277
|
-
};
|
|
3278
|
-
};
|
|
3279
|
-
/** @description Represents a workspace member. */
|
|
3280
|
-
201: {
|
|
3281
|
-
headers: {
|
|
3282
|
-
[name: string]: unknown;
|
|
3283
|
-
};
|
|
3284
|
-
content: {
|
|
3285
|
-
"application/json": components["schemas"]["Member"];
|
|
3286
|
-
};
|
|
3287
|
-
};
|
|
3288
|
-
/**
|
|
3289
|
-
* @description HTTP error response representation with security-conscious design.
|
|
3290
|
-
*
|
|
3291
|
-
* This struct contains all the information needed to serialize an error
|
|
3292
|
-
* response, including the error name, message, HTTP status code, resource
|
|
3293
|
-
* information, and user-friendly messages.
|
|
3294
|
-
*/
|
|
3295
|
-
400: {
|
|
3309
|
+
/** @description no content */
|
|
3310
|
+
204: {
|
|
3296
3311
|
headers: {
|
|
3297
3312
|
[name: string]: unknown;
|
|
3298
3313
|
};
|
|
3299
|
-
content
|
|
3300
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
3301
|
-
};
|
|
3314
|
+
content?: never;
|
|
3302
3315
|
};
|
|
3303
3316
|
/**
|
|
3304
3317
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -3322,7 +3335,7 @@ interface paths {
|
|
|
3322
3335
|
* response, including the error name, message, HTTP status code, resource
|
|
3323
3336
|
* information, and user-friendly messages.
|
|
3324
3337
|
*/
|
|
3325
|
-
|
|
3338
|
+
403: {
|
|
3326
3339
|
headers: {
|
|
3327
3340
|
[name: string]: unknown;
|
|
3328
3341
|
};
|
|
@@ -3337,7 +3350,7 @@ interface paths {
|
|
|
3337
3350
|
* response, including the error name, message, HTTP status code, resource
|
|
3338
3351
|
* information, and user-friendly messages.
|
|
3339
3352
|
*/
|
|
3340
|
-
|
|
3353
|
+
404: {
|
|
3341
3354
|
headers: {
|
|
3342
3355
|
[name: string]: unknown;
|
|
3343
3356
|
};
|
|
@@ -3345,50 +3358,46 @@ interface paths {
|
|
|
3345
3358
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3346
3359
|
};
|
|
3347
3360
|
};
|
|
3348
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
3349
|
-
415: {
|
|
3350
|
-
headers: {
|
|
3351
|
-
[name: string]: unknown;
|
|
3352
|
-
};
|
|
3353
|
-
content: {
|
|
3354
|
-
"text/plain": string;
|
|
3355
|
-
};
|
|
3356
|
-
};
|
|
3357
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
3358
|
-
422: {
|
|
3359
|
-
headers: {
|
|
3360
|
-
[name: string]: unknown;
|
|
3361
|
-
};
|
|
3362
|
-
content: {
|
|
3363
|
-
"text/plain": string;
|
|
3364
|
-
};
|
|
3365
|
-
};
|
|
3366
3361
|
};
|
|
3367
3362
|
};
|
|
3363
|
+
options?: never;
|
|
3364
|
+
head?: never;
|
|
3368
3365
|
/**
|
|
3369
|
-
*
|
|
3370
|
-
* @description
|
|
3366
|
+
* Update connection
|
|
3367
|
+
* @description Updates connection name or encrypted data.
|
|
3371
3368
|
*/
|
|
3372
|
-
|
|
3369
|
+
patch: {
|
|
3373
3370
|
parameters: {
|
|
3374
3371
|
query?: never;
|
|
3375
3372
|
header?: never;
|
|
3376
3373
|
path: {
|
|
3377
3374
|
/** @description URL-safe workspace identifier. */
|
|
3378
3375
|
workspaceSlug: string;
|
|
3379
|
-
/** @description
|
|
3380
|
-
|
|
3376
|
+
/** @description Opaque identifier of the connection. */
|
|
3377
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
3381
3378
|
};
|
|
3382
3379
|
cookie?: never;
|
|
3383
3380
|
};
|
|
3384
|
-
|
|
3381
|
+
/** @description Request payload for updating an existing workspace connection. */
|
|
3382
|
+
requestBody: {
|
|
3383
|
+
content: {
|
|
3384
|
+
"application/json": components["schemas"]["UpdateConnection"];
|
|
3385
|
+
};
|
|
3386
|
+
};
|
|
3385
3387
|
responses: {
|
|
3386
|
-
/**
|
|
3388
|
+
/**
|
|
3389
|
+
* @description Response type for a workspace connection.
|
|
3390
|
+
*
|
|
3391
|
+
* Note: The encrypted connection data is never exposed in API responses.
|
|
3392
|
+
* Only metadata about the connection is returned.
|
|
3393
|
+
*/
|
|
3387
3394
|
200: {
|
|
3388
3395
|
headers: {
|
|
3389
3396
|
[name: string]: unknown;
|
|
3390
3397
|
};
|
|
3391
|
-
content
|
|
3398
|
+
content: {
|
|
3399
|
+
"application/json": components["schemas"]["Connection"];
|
|
3400
|
+
};
|
|
3392
3401
|
};
|
|
3393
3402
|
/**
|
|
3394
3403
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -3397,7 +3406,7 @@ interface paths {
|
|
|
3397
3406
|
* response, including the error name, message, HTTP status code, resource
|
|
3398
3407
|
* information, and user-friendly messages.
|
|
3399
3408
|
*/
|
|
3400
|
-
|
|
3409
|
+
400: {
|
|
3401
3410
|
headers: {
|
|
3402
3411
|
[name: string]: unknown;
|
|
3403
3412
|
};
|
|
@@ -3412,7 +3421,7 @@ interface paths {
|
|
|
3412
3421
|
* response, including the error name, message, HTTP status code, resource
|
|
3413
3422
|
* information, and user-friendly messages.
|
|
3414
3423
|
*/
|
|
3415
|
-
|
|
3424
|
+
401: {
|
|
3416
3425
|
headers: {
|
|
3417
3426
|
[name: string]: unknown;
|
|
3418
3427
|
};
|
|
@@ -3427,7 +3436,7 @@ interface paths {
|
|
|
3427
3436
|
* response, including the error name, message, HTTP status code, resource
|
|
3428
3437
|
* information, and user-friendly messages.
|
|
3429
3438
|
*/
|
|
3430
|
-
|
|
3439
|
+
403: {
|
|
3431
3440
|
headers: {
|
|
3432
3441
|
[name: string]: unknown;
|
|
3433
3442
|
};
|
|
@@ -3435,133 +3444,77 @@ interface paths {
|
|
|
3435
3444
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3436
3445
|
};
|
|
3437
3446
|
};
|
|
3438
|
-
};
|
|
3439
|
-
};
|
|
3440
|
-
options?: never;
|
|
3441
|
-
head?: never;
|
|
3442
|
-
patch?: never;
|
|
3443
|
-
trace?: never;
|
|
3444
|
-
};
|
|
3445
|
-
"/invites/code/{inviteCode}/": {
|
|
3446
|
-
parameters: {
|
|
3447
|
-
query?: never;
|
|
3448
|
-
header?: never;
|
|
3449
|
-
path?: never;
|
|
3450
|
-
cookie?: never;
|
|
3451
|
-
};
|
|
3452
|
-
/**
|
|
3453
|
-
* Preview invite
|
|
3454
|
-
* @description Returns workspace information for an invite code, allowing users to preview the workspace before joining. Does not require authentication.
|
|
3455
|
-
*/
|
|
3456
|
-
get: {
|
|
3457
|
-
parameters: {
|
|
3458
|
-
query?: never;
|
|
3459
|
-
header?: never;
|
|
3460
|
-
path: {
|
|
3461
|
-
/** @description The invite code to use for joining the workspace. */
|
|
3462
|
-
inviteCode: string;
|
|
3463
|
-
};
|
|
3464
|
-
cookie?: never;
|
|
3465
|
-
};
|
|
3466
|
-
requestBody?: never;
|
|
3467
|
-
responses: {
|
|
3468
3447
|
/**
|
|
3469
|
-
* @description
|
|
3448
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3470
3449
|
*
|
|
3471
|
-
* This
|
|
3472
|
-
*
|
|
3450
|
+
* This struct contains all the information needed to serialize an error
|
|
3451
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3452
|
+
* information, and user-friendly messages.
|
|
3473
3453
|
*/
|
|
3474
|
-
|
|
3454
|
+
404: {
|
|
3475
3455
|
headers: {
|
|
3476
3456
|
[name: string]: unknown;
|
|
3477
3457
|
};
|
|
3478
3458
|
content: {
|
|
3479
|
-
"application/json": components["schemas"]["
|
|
3459
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3480
3460
|
};
|
|
3481
3461
|
};
|
|
3482
|
-
/**
|
|
3483
|
-
|
|
3484
|
-
*
|
|
3485
|
-
* This struct contains all the information needed to serialize an error
|
|
3486
|
-
* response, including the error name, message, HTTP status code, resource
|
|
3487
|
-
* information, and user-friendly messages.
|
|
3488
|
-
*/
|
|
3489
|
-
400: {
|
|
3462
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
3463
|
+
415: {
|
|
3490
3464
|
headers: {
|
|
3491
3465
|
[name: string]: unknown;
|
|
3492
3466
|
};
|
|
3493
3467
|
content: {
|
|
3494
|
-
"
|
|
3468
|
+
"text/plain": string;
|
|
3495
3469
|
};
|
|
3496
3470
|
};
|
|
3497
|
-
/**
|
|
3498
|
-
|
|
3499
|
-
*
|
|
3500
|
-
* This struct contains all the information needed to serialize an error
|
|
3501
|
-
* response, including the error name, message, HTTP status code, resource
|
|
3502
|
-
* information, and user-friendly messages.
|
|
3503
|
-
*/
|
|
3504
|
-
404: {
|
|
3471
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
3472
|
+
422: {
|
|
3505
3473
|
headers: {
|
|
3506
3474
|
[name: string]: unknown;
|
|
3507
3475
|
};
|
|
3508
3476
|
content: {
|
|
3509
|
-
"
|
|
3477
|
+
"text/plain": string;
|
|
3510
3478
|
};
|
|
3511
3479
|
};
|
|
3512
3480
|
};
|
|
3513
3481
|
};
|
|
3482
|
+
trace?: never;
|
|
3483
|
+
};
|
|
3484
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/verify/": {
|
|
3485
|
+
parameters: {
|
|
3486
|
+
query?: never;
|
|
3487
|
+
header?: never;
|
|
3488
|
+
path?: never;
|
|
3489
|
+
cookie?: never;
|
|
3490
|
+
};
|
|
3491
|
+
get?: never;
|
|
3514
3492
|
put?: never;
|
|
3515
3493
|
/**
|
|
3516
|
-
*
|
|
3517
|
-
* @description
|
|
3494
|
+
* Verify connection
|
|
3495
|
+
* @description Checks whether the connection's backing store is reachable with its stored credentials.
|
|
3518
3496
|
*/
|
|
3519
3497
|
post: {
|
|
3520
3498
|
parameters: {
|
|
3521
3499
|
query?: never;
|
|
3522
3500
|
header?: never;
|
|
3523
3501
|
path: {
|
|
3524
|
-
/** @description
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
};
|
|
3529
|
-
requestBody: {
|
|
3530
|
-
content: {
|
|
3531
|
-
"application/json": components["schemas"]["ReplyInvite"] | null;
|
|
3532
|
-
};
|
|
3533
|
-
};
|
|
3534
|
-
responses: {
|
|
3535
|
-
200: {
|
|
3536
|
-
headers: {
|
|
3537
|
-
[name: string]: unknown;
|
|
3538
|
-
};
|
|
3539
|
-
content: {
|
|
3540
|
-
"application/json": components["schemas"]["Member"] | null;
|
|
3541
|
-
};
|
|
3542
|
-
};
|
|
3543
|
-
/** @description Represents a workspace member. */
|
|
3544
|
-
201: {
|
|
3545
|
-
headers: {
|
|
3546
|
-
[name: string]: unknown;
|
|
3547
|
-
};
|
|
3548
|
-
content: {
|
|
3549
|
-
"application/json": components["schemas"]["Member"];
|
|
3550
|
-
};
|
|
3502
|
+
/** @description URL-safe workspace identifier. */
|
|
3503
|
+
workspaceSlug: string;
|
|
3504
|
+
/** @description Opaque identifier of the connection. */
|
|
3505
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
3551
3506
|
};
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
*/
|
|
3559
|
-
400: {
|
|
3507
|
+
cookie?: never;
|
|
3508
|
+
};
|
|
3509
|
+
requestBody?: never;
|
|
3510
|
+
responses: {
|
|
3511
|
+
/** @description Result of a connection reachability check. */
|
|
3512
|
+
200: {
|
|
3560
3513
|
headers: {
|
|
3561
3514
|
[name: string]: unknown;
|
|
3562
3515
|
};
|
|
3563
3516
|
content: {
|
|
3564
|
-
"application/json": components["schemas"]["
|
|
3517
|
+
"application/json": components["schemas"]["ConnectionVerification"];
|
|
3565
3518
|
};
|
|
3566
3519
|
};
|
|
3567
3520
|
/**
|
|
@@ -3586,7 +3539,7 @@ interface paths {
|
|
|
3586
3539
|
* response, including the error name, message, HTTP status code, resource
|
|
3587
3540
|
* information, and user-friendly messages.
|
|
3588
3541
|
*/
|
|
3589
|
-
|
|
3542
|
+
403: {
|
|
3590
3543
|
headers: {
|
|
3591
3544
|
[name: string]: unknown;
|
|
3592
3545
|
};
|
|
@@ -3601,7 +3554,7 @@ interface paths {
|
|
|
3601
3554
|
* response, including the error name, message, HTTP status code, resource
|
|
3602
3555
|
* information, and user-friendly messages.
|
|
3603
3556
|
*/
|
|
3604
|
-
|
|
3557
|
+
404: {
|
|
3605
3558
|
headers: {
|
|
3606
3559
|
[name: string]: unknown;
|
|
3607
3560
|
};
|
|
@@ -3609,24 +3562,6 @@ interface paths {
|
|
|
3609
3562
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3610
3563
|
};
|
|
3611
3564
|
};
|
|
3612
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
3613
|
-
415: {
|
|
3614
|
-
headers: {
|
|
3615
|
-
[name: string]: unknown;
|
|
3616
|
-
};
|
|
3617
|
-
content: {
|
|
3618
|
-
"text/plain": string;
|
|
3619
|
-
};
|
|
3620
|
-
};
|
|
3621
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
3622
|
-
422: {
|
|
3623
|
-
headers: {
|
|
3624
|
-
[name: string]: unknown;
|
|
3625
|
-
};
|
|
3626
|
-
content: {
|
|
3627
|
-
"text/plain": string;
|
|
3628
|
-
};
|
|
3629
|
-
};
|
|
3630
3565
|
};
|
|
3631
3566
|
};
|
|
3632
3567
|
delete?: never;
|
|
@@ -3635,7 +3570,7 @@ interface paths {
|
|
|
3635
3570
|
patch?: never;
|
|
3636
3571
|
trace?: never;
|
|
3637
3572
|
};
|
|
3638
|
-
"/workspaces/{workspaceSlug}/
|
|
3573
|
+
"/workspaces/{workspaceSlug}/syncs/": {
|
|
3639
3574
|
parameters: {
|
|
3640
3575
|
query?: never;
|
|
3641
3576
|
header?: never;
|
|
@@ -3643,20 +3578,12 @@ interface paths {
|
|
|
3643
3578
|
cookie?: never;
|
|
3644
3579
|
};
|
|
3645
3580
|
/**
|
|
3646
|
-
* List
|
|
3647
|
-
* @description Returns
|
|
3581
|
+
* List workspace syncs
|
|
3582
|
+
* @description Returns all sync runs across the workspace's connections, most recent first, with optional status and provider filters.
|
|
3648
3583
|
*/
|
|
3649
3584
|
get: {
|
|
3650
3585
|
parameters: {
|
|
3651
3586
|
query?: {
|
|
3652
|
-
/** @description Filter by 2FA status. */
|
|
3653
|
-
has2fa?: boolean;
|
|
3654
|
-
/** @description Sort order (asc or desc). */
|
|
3655
|
-
order?: components["schemas"]["SortOrder"];
|
|
3656
|
-
/** @description Filter by workspace role. */
|
|
3657
|
-
role?: components["schemas"]["WorkspaceRole"];
|
|
3658
|
-
/** @description Sort by field. */
|
|
3659
|
-
sortBy?: components["schemas"]["MemberSortField"];
|
|
3660
3587
|
/**
|
|
3661
3588
|
* @description Cursor pointing to the last item of the previous page.
|
|
3662
3589
|
* Obtain this from the `nextCursor` field in the response.
|
|
@@ -3664,6 +3591,14 @@ interface paths {
|
|
|
3664
3591
|
after?: string;
|
|
3665
3592
|
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
3666
3593
|
limit?: number;
|
|
3594
|
+
/**
|
|
3595
|
+
* @description Filter by connection provider (`s3`, `azure`, `gcs`). Repeatable; a sync
|
|
3596
|
+
* matches if its connection uses any of the given providers. Empty means no
|
|
3597
|
+
* provider filter.
|
|
3598
|
+
*/
|
|
3599
|
+
provider?: string[];
|
|
3600
|
+
/** @description Filter by sync status. */
|
|
3601
|
+
status?: components["schemas"]["SyncStatus"];
|
|
3667
3602
|
};
|
|
3668
3603
|
header?: never;
|
|
3669
3604
|
path: {
|
|
@@ -3686,7 +3621,7 @@ interface paths {
|
|
|
3686
3621
|
[name: string]: unknown;
|
|
3687
3622
|
};
|
|
3688
3623
|
content: {
|
|
3689
|
-
"application/json": components["schemas"]["
|
|
3624
|
+
"application/json": components["schemas"]["ConnectionSyncPage"];
|
|
3690
3625
|
};
|
|
3691
3626
|
};
|
|
3692
3627
|
/**
|
|
@@ -3744,7 +3679,7 @@ interface paths {
|
|
|
3744
3679
|
patch?: never;
|
|
3745
3680
|
trace?: never;
|
|
3746
3681
|
};
|
|
3747
|
-
"/workspaces/{workspaceSlug}/
|
|
3682
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/sync/": {
|
|
3748
3683
|
parameters: {
|
|
3749
3684
|
query?: never;
|
|
3750
3685
|
header?: never;
|
|
@@ -3754,8 +3689,8 @@ interface paths {
|
|
|
3754
3689
|
get?: never;
|
|
3755
3690
|
put?: never;
|
|
3756
3691
|
/**
|
|
3757
|
-
*
|
|
3758
|
-
* @description
|
|
3692
|
+
* Sync connection
|
|
3693
|
+
* @description Imports an object from or exports a file to the connection. Returns the created sync; poll it for completion.
|
|
3759
3694
|
*/
|
|
3760
3695
|
post: {
|
|
3761
3696
|
parameters: {
|
|
@@ -3764,17 +3699,34 @@ interface paths {
|
|
|
3764
3699
|
path: {
|
|
3765
3700
|
/** @description URL-safe workspace identifier. */
|
|
3766
3701
|
workspaceSlug: string;
|
|
3702
|
+
/** @description Opaque identifier of the connection. */
|
|
3703
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
3767
3704
|
};
|
|
3768
3705
|
cookie?: never;
|
|
3769
3706
|
};
|
|
3770
|
-
|
|
3707
|
+
/**
|
|
3708
|
+
* @description Request payload to trigger a connection sync.
|
|
3709
|
+
*
|
|
3710
|
+
* The direction is determined by the connection's configured `sync_mode`.
|
|
3711
|
+
* - Import connections need no body: the sync fetches every not-yet-imported
|
|
3712
|
+
* object under the connection's root path.
|
|
3713
|
+
* - Export connections push one workspace file (`file_id`) to one object
|
|
3714
|
+
* `key`; both are required for export and ignored for import.
|
|
3715
|
+
*/
|
|
3716
|
+
requestBody: {
|
|
3717
|
+
content: {
|
|
3718
|
+
"application/json": components["schemas"]["SyncConnection"];
|
|
3719
|
+
};
|
|
3720
|
+
};
|
|
3771
3721
|
responses: {
|
|
3772
|
-
/** @description
|
|
3773
|
-
|
|
3722
|
+
/** @description A connection sync run (import or export). */
|
|
3723
|
+
202: {
|
|
3774
3724
|
headers: {
|
|
3775
3725
|
[name: string]: unknown;
|
|
3776
3726
|
};
|
|
3777
|
-
content
|
|
3727
|
+
content: {
|
|
3728
|
+
"application/json": components["schemas"]["ConnectionSync"];
|
|
3729
|
+
};
|
|
3778
3730
|
};
|
|
3779
3731
|
/**
|
|
3780
3732
|
* @description HTTP error response representation with security-conscious design.
|
|
@@ -3806,6 +3758,21 @@ interface paths {
|
|
|
3806
3758
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3807
3759
|
};
|
|
3808
3760
|
};
|
|
3761
|
+
/**
|
|
3762
|
+
* @description HTTP error response representation with security-conscious design.
|
|
3763
|
+
*
|
|
3764
|
+
* This struct contains all the information needed to serialize an error
|
|
3765
|
+
* response, including the error name, message, HTTP status code, resource
|
|
3766
|
+
* information, and user-friendly messages.
|
|
3767
|
+
*/
|
|
3768
|
+
403: {
|
|
3769
|
+
headers: {
|
|
3770
|
+
[name: string]: unknown;
|
|
3771
|
+
};
|
|
3772
|
+
content: {
|
|
3773
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3774
|
+
};
|
|
3775
|
+
};
|
|
3809
3776
|
/**
|
|
3810
3777
|
* @description HTTP error response representation with security-conscious design.
|
|
3811
3778
|
*
|
|
@@ -3821,6 +3788,24 @@ interface paths {
|
|
|
3821
3788
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
3822
3789
|
};
|
|
3823
3790
|
};
|
|
3791
|
+
/** @description Expected request with `Content-Type: application/json` */
|
|
3792
|
+
415: {
|
|
3793
|
+
headers: {
|
|
3794
|
+
[name: string]: unknown;
|
|
3795
|
+
};
|
|
3796
|
+
content: {
|
|
3797
|
+
"text/plain": string;
|
|
3798
|
+
};
|
|
3799
|
+
};
|
|
3800
|
+
/** @description Failed to deserialize the JSON body into the target type */
|
|
3801
|
+
422: {
|
|
3802
|
+
headers: {
|
|
3803
|
+
[name: string]: unknown;
|
|
3804
|
+
};
|
|
3805
|
+
content: {
|
|
3806
|
+
"text/plain": string;
|
|
3807
|
+
};
|
|
3808
|
+
};
|
|
3824
3809
|
};
|
|
3825
3810
|
};
|
|
3826
3811
|
delete?: never;
|
|
@@ -3829,7 +3814,7 @@ interface paths {
|
|
|
3829
3814
|
patch?: never;
|
|
3830
3815
|
trace?: never;
|
|
3831
3816
|
};
|
|
3832
|
-
"/workspaces/{workspaceSlug}/
|
|
3817
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/syncs/": {
|
|
3833
3818
|
parameters: {
|
|
3834
3819
|
query?: never;
|
|
3835
3820
|
header?: never;
|
|
@@ -3837,30 +3822,44 @@ interface paths {
|
|
|
3837
3822
|
cookie?: never;
|
|
3838
3823
|
};
|
|
3839
3824
|
/**
|
|
3840
|
-
*
|
|
3841
|
-
* @description Returns
|
|
3825
|
+
* List connection syncs
|
|
3826
|
+
* @description Returns the connection's sync history, most recent first.
|
|
3842
3827
|
*/
|
|
3843
3828
|
get: {
|
|
3844
3829
|
parameters: {
|
|
3845
|
-
query?:
|
|
3830
|
+
query?: {
|
|
3831
|
+
/**
|
|
3832
|
+
* @description Cursor pointing to the last item of the previous page.
|
|
3833
|
+
* Obtain this from the `nextCursor` field in the response.
|
|
3834
|
+
*/
|
|
3835
|
+
after?: string;
|
|
3836
|
+
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
3837
|
+
limit?: number;
|
|
3838
|
+
};
|
|
3846
3839
|
header?: never;
|
|
3847
3840
|
path: {
|
|
3848
3841
|
/** @description URL-safe workspace identifier. */
|
|
3849
3842
|
workspaceSlug: string;
|
|
3850
|
-
/** @description
|
|
3851
|
-
|
|
3843
|
+
/** @description Opaque identifier of the connection. */
|
|
3844
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
3852
3845
|
};
|
|
3853
3846
|
cookie?: never;
|
|
3854
3847
|
};
|
|
3855
3848
|
requestBody?: never;
|
|
3856
3849
|
responses: {
|
|
3857
|
-
/**
|
|
3850
|
+
/**
|
|
3851
|
+
* @description Generic paginated response wrapper.
|
|
3852
|
+
*
|
|
3853
|
+
* Provides a consistent structure for all paginated API responses with
|
|
3854
|
+
* cursor-based pagination support. When `next_cursor` is present, there
|
|
3855
|
+
* are more items to fetch.
|
|
3856
|
+
*/
|
|
3858
3857
|
200: {
|
|
3859
3858
|
headers: {
|
|
3860
3859
|
[name: string]: unknown;
|
|
3861
3860
|
};
|
|
3862
3861
|
content: {
|
|
3863
|
-
"application/json": components["schemas"]["
|
|
3862
|
+
"application/json": components["schemas"]["ConnectionSyncPage"];
|
|
3864
3863
|
};
|
|
3865
3864
|
};
|
|
3866
3865
|
/**
|
|
@@ -3912,44 +3911,46 @@ interface paths {
|
|
|
3912
3911
|
};
|
|
3913
3912
|
put?: never;
|
|
3914
3913
|
post?: never;
|
|
3914
|
+
delete?: never;
|
|
3915
|
+
options?: never;
|
|
3916
|
+
head?: never;
|
|
3917
|
+
patch?: never;
|
|
3918
|
+
trace?: never;
|
|
3919
|
+
};
|
|
3920
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/syncs/{syncId}/": {
|
|
3921
|
+
parameters: {
|
|
3922
|
+
query?: never;
|
|
3923
|
+
header?: never;
|
|
3924
|
+
path?: never;
|
|
3925
|
+
cookie?: never;
|
|
3926
|
+
};
|
|
3915
3927
|
/**
|
|
3916
|
-
*
|
|
3917
|
-
* @description
|
|
3928
|
+
* Get connection sync
|
|
3929
|
+
* @description Returns a single sync run for the connection.
|
|
3918
3930
|
*/
|
|
3919
|
-
|
|
3931
|
+
get: {
|
|
3920
3932
|
parameters: {
|
|
3921
3933
|
query?: never;
|
|
3922
3934
|
header?: never;
|
|
3923
3935
|
path: {
|
|
3924
3936
|
/** @description URL-safe workspace identifier. */
|
|
3925
3937
|
workspaceSlug: string;
|
|
3926
|
-
/** @description
|
|
3927
|
-
|
|
3938
|
+
/** @description Opaque identifier of the connection. */
|
|
3939
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
3940
|
+
/** @description Unique identifier of the sync run. */
|
|
3941
|
+
syncId: string;
|
|
3928
3942
|
};
|
|
3929
3943
|
cookie?: never;
|
|
3930
3944
|
};
|
|
3931
3945
|
requestBody?: never;
|
|
3932
3946
|
responses: {
|
|
3933
|
-
/** @description
|
|
3947
|
+
/** @description A connection sync run (import or export). */
|
|
3934
3948
|
200: {
|
|
3935
|
-
headers: {
|
|
3936
|
-
[name: string]: unknown;
|
|
3937
|
-
};
|
|
3938
|
-
content?: never;
|
|
3939
|
-
};
|
|
3940
|
-
/**
|
|
3941
|
-
* @description HTTP error response representation with security-conscious design.
|
|
3942
|
-
*
|
|
3943
|
-
* This struct contains all the information needed to serialize an error
|
|
3944
|
-
* response, including the error name, message, HTTP status code, resource
|
|
3945
|
-
* information, and user-friendly messages.
|
|
3946
|
-
*/
|
|
3947
|
-
400: {
|
|
3948
3949
|
headers: {
|
|
3949
3950
|
[name: string]: unknown;
|
|
3950
3951
|
};
|
|
3951
3952
|
content: {
|
|
3952
|
-
"application/json": components["schemas"]["
|
|
3953
|
+
"application/json": components["schemas"]["ConnectionSync"];
|
|
3953
3954
|
};
|
|
3954
3955
|
};
|
|
3955
3956
|
/**
|
|
@@ -3999,38 +4000,50 @@ interface paths {
|
|
|
3999
4000
|
};
|
|
4000
4001
|
};
|
|
4001
4002
|
};
|
|
4003
|
+
put?: never;
|
|
4004
|
+
post?: never;
|
|
4005
|
+
delete?: never;
|
|
4002
4006
|
options?: never;
|
|
4003
4007
|
head?: never;
|
|
4008
|
+
patch?: never;
|
|
4009
|
+
trace?: never;
|
|
4010
|
+
};
|
|
4011
|
+
"/workspaces/{workspaceSlug}/connections/{connectionId}/syncs/{syncId}/cancel/": {
|
|
4012
|
+
parameters: {
|
|
4013
|
+
query?: never;
|
|
4014
|
+
header?: never;
|
|
4015
|
+
path?: never;
|
|
4016
|
+
cookie?: never;
|
|
4017
|
+
};
|
|
4018
|
+
get?: never;
|
|
4019
|
+
put?: never;
|
|
4004
4020
|
/**
|
|
4005
|
-
*
|
|
4006
|
-
* @description
|
|
4021
|
+
* Cancel connection sync
|
|
4022
|
+
* @description Cancels an in-progress sync run. A run that already finished returns 409.
|
|
4007
4023
|
*/
|
|
4008
|
-
|
|
4024
|
+
post: {
|
|
4009
4025
|
parameters: {
|
|
4010
4026
|
query?: never;
|
|
4011
4027
|
header?: never;
|
|
4012
4028
|
path: {
|
|
4013
4029
|
/** @description URL-safe workspace identifier. */
|
|
4014
4030
|
workspaceSlug: string;
|
|
4015
|
-
/** @description
|
|
4016
|
-
|
|
4031
|
+
/** @description Opaque identifier of the connection. */
|
|
4032
|
+
connectionId: components["schemas"]["ConnectionId"];
|
|
4033
|
+
/** @description Unique identifier of the sync run. */
|
|
4034
|
+
syncId: string;
|
|
4017
4035
|
};
|
|
4018
4036
|
cookie?: never;
|
|
4019
4037
|
};
|
|
4020
|
-
|
|
4021
|
-
requestBody: {
|
|
4022
|
-
content: {
|
|
4023
|
-
"application/json": components["schemas"]["UpdateMember"];
|
|
4024
|
-
};
|
|
4025
|
-
};
|
|
4038
|
+
requestBody?: never;
|
|
4026
4039
|
responses: {
|
|
4027
|
-
/** @description
|
|
4040
|
+
/** @description A connection sync run (import or export). */
|
|
4028
4041
|
200: {
|
|
4029
4042
|
headers: {
|
|
4030
4043
|
[name: string]: unknown;
|
|
4031
4044
|
};
|
|
4032
4045
|
content: {
|
|
4033
|
-
"application/json": components["schemas"]["
|
|
4046
|
+
"application/json": components["schemas"]["ConnectionSync"];
|
|
4034
4047
|
};
|
|
4035
4048
|
};
|
|
4036
4049
|
/**
|
|
@@ -4040,7 +4053,7 @@ interface paths {
|
|
|
4040
4053
|
* response, including the error name, message, HTTP status code, resource
|
|
4041
4054
|
* information, and user-friendly messages.
|
|
4042
4055
|
*/
|
|
4043
|
-
|
|
4056
|
+
401: {
|
|
4044
4057
|
headers: {
|
|
4045
4058
|
[name: string]: unknown;
|
|
4046
4059
|
};
|
|
@@ -4055,7 +4068,7 @@ interface paths {
|
|
|
4055
4068
|
* response, including the error name, message, HTTP status code, resource
|
|
4056
4069
|
* information, and user-friendly messages.
|
|
4057
4070
|
*/
|
|
4058
|
-
|
|
4071
|
+
403: {
|
|
4059
4072
|
headers: {
|
|
4060
4073
|
[name: string]: unknown;
|
|
4061
4074
|
};
|
|
@@ -4070,7 +4083,7 @@ interface paths {
|
|
|
4070
4083
|
* response, including the error name, message, HTTP status code, resource
|
|
4071
4084
|
* information, and user-friendly messages.
|
|
4072
4085
|
*/
|
|
4073
|
-
|
|
4086
|
+
404: {
|
|
4074
4087
|
headers: {
|
|
4075
4088
|
[name: string]: unknown;
|
|
4076
4089
|
};
|
|
@@ -4085,7 +4098,7 @@ interface paths {
|
|
|
4085
4098
|
* response, including the error name, message, HTTP status code, resource
|
|
4086
4099
|
* information, and user-friendly messages.
|
|
4087
4100
|
*/
|
|
4088
|
-
|
|
4101
|
+
409: {
|
|
4089
4102
|
headers: {
|
|
4090
4103
|
[name: string]: unknown;
|
|
4091
4104
|
};
|
|
@@ -4093,26 +4106,12 @@ interface paths {
|
|
|
4093
4106
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
4094
4107
|
};
|
|
4095
4108
|
};
|
|
4096
|
-
/** @description Expected request with `Content-Type: application/json` */
|
|
4097
|
-
415: {
|
|
4098
|
-
headers: {
|
|
4099
|
-
[name: string]: unknown;
|
|
4100
|
-
};
|
|
4101
|
-
content: {
|
|
4102
|
-
"text/plain": string;
|
|
4103
|
-
};
|
|
4104
|
-
};
|
|
4105
|
-
/** @description Failed to deserialize the JSON body into the target type */
|
|
4106
|
-
422: {
|
|
4107
|
-
headers: {
|
|
4108
|
-
[name: string]: unknown;
|
|
4109
|
-
};
|
|
4110
|
-
content: {
|
|
4111
|
-
"text/plain": string;
|
|
4112
|
-
};
|
|
4113
|
-
};
|
|
4114
4109
|
};
|
|
4115
4110
|
};
|
|
4111
|
+
delete?: never;
|
|
4112
|
+
options?: never;
|
|
4113
|
+
head?: never;
|
|
4114
|
+
patch?: never;
|
|
4116
4115
|
trace?: never;
|
|
4117
4116
|
};
|
|
4118
4117
|
"/workspaces/{workspaceSlug}/webhooks/": {
|
|
@@ -6801,128 +6800,6 @@ interface paths {
|
|
|
6801
6800
|
};
|
|
6802
6801
|
trace?: never;
|
|
6803
6802
|
};
|
|
6804
|
-
"/notifications/": {
|
|
6805
|
-
parameters: {
|
|
6806
|
-
query?: never;
|
|
6807
|
-
header?: never;
|
|
6808
|
-
path?: never;
|
|
6809
|
-
cookie?: never;
|
|
6810
|
-
};
|
|
6811
|
-
/**
|
|
6812
|
-
* List notifications
|
|
6813
|
-
* @description Returns all notifications for the authenticated account and marks them as read.
|
|
6814
|
-
*/
|
|
6815
|
-
get: {
|
|
6816
|
-
parameters: {
|
|
6817
|
-
query?: {
|
|
6818
|
-
/**
|
|
6819
|
-
* @description Cursor pointing to the last item of the previous page.
|
|
6820
|
-
* Obtain this from the `nextCursor` field in the response.
|
|
6821
|
-
*/
|
|
6822
|
-
after?: string;
|
|
6823
|
-
/** @description The maximum number of records to return (1-100, default: 20). */
|
|
6824
|
-
limit?: number;
|
|
6825
|
-
};
|
|
6826
|
-
header?: never;
|
|
6827
|
-
path?: never;
|
|
6828
|
-
cookie?: never;
|
|
6829
|
-
};
|
|
6830
|
-
requestBody?: never;
|
|
6831
|
-
responses: {
|
|
6832
|
-
/**
|
|
6833
|
-
* @description Generic paginated response wrapper.
|
|
6834
|
-
*
|
|
6835
|
-
* Provides a consistent structure for all paginated API responses with
|
|
6836
|
-
* cursor-based pagination support. When `next_cursor` is present, there
|
|
6837
|
-
* are more items to fetch.
|
|
6838
|
-
*/
|
|
6839
|
-
200: {
|
|
6840
|
-
headers: {
|
|
6841
|
-
[name: string]: unknown;
|
|
6842
|
-
};
|
|
6843
|
-
content: {
|
|
6844
|
-
"application/json": components["schemas"]["NotificationPage"];
|
|
6845
|
-
};
|
|
6846
|
-
};
|
|
6847
|
-
/**
|
|
6848
|
-
* @description HTTP error response representation with security-conscious design.
|
|
6849
|
-
*
|
|
6850
|
-
* This struct contains all the information needed to serialize an error
|
|
6851
|
-
* response, including the error name, message, HTTP status code, resource
|
|
6852
|
-
* information, and user-friendly messages.
|
|
6853
|
-
*/
|
|
6854
|
-
401: {
|
|
6855
|
-
headers: {
|
|
6856
|
-
[name: string]: unknown;
|
|
6857
|
-
};
|
|
6858
|
-
content: {
|
|
6859
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
6860
|
-
};
|
|
6861
|
-
};
|
|
6862
|
-
};
|
|
6863
|
-
};
|
|
6864
|
-
put?: never;
|
|
6865
|
-
post?: never;
|
|
6866
|
-
delete?: never;
|
|
6867
|
-
options?: never;
|
|
6868
|
-
head?: never;
|
|
6869
|
-
patch?: never;
|
|
6870
|
-
trace?: never;
|
|
6871
|
-
};
|
|
6872
|
-
"/notifications/unread/": {
|
|
6873
|
-
parameters: {
|
|
6874
|
-
query?: never;
|
|
6875
|
-
header?: never;
|
|
6876
|
-
path?: never;
|
|
6877
|
-
cookie?: never;
|
|
6878
|
-
};
|
|
6879
|
-
/**
|
|
6880
|
-
* Get unread notifications count
|
|
6881
|
-
* @description Returns the number of unread notifications for the authenticated account.
|
|
6882
|
-
*/
|
|
6883
|
-
get: {
|
|
6884
|
-
parameters: {
|
|
6885
|
-
query?: never;
|
|
6886
|
-
header?: never;
|
|
6887
|
-
path?: never;
|
|
6888
|
-
cookie?: never;
|
|
6889
|
-
};
|
|
6890
|
-
requestBody?: never;
|
|
6891
|
-
responses: {
|
|
6892
|
-
/** @description Response type for unread notifications status. */
|
|
6893
|
-
200: {
|
|
6894
|
-
headers: {
|
|
6895
|
-
[name: string]: unknown;
|
|
6896
|
-
};
|
|
6897
|
-
content: {
|
|
6898
|
-
"application/json": components["schemas"]["UnreadStatus"];
|
|
6899
|
-
};
|
|
6900
|
-
};
|
|
6901
|
-
/**
|
|
6902
|
-
* @description HTTP error response representation with security-conscious design.
|
|
6903
|
-
*
|
|
6904
|
-
* This struct contains all the information needed to serialize an error
|
|
6905
|
-
* response, including the error name, message, HTTP status code, resource
|
|
6906
|
-
* information, and user-friendly messages.
|
|
6907
|
-
*/
|
|
6908
|
-
401: {
|
|
6909
|
-
headers: {
|
|
6910
|
-
[name: string]: unknown;
|
|
6911
|
-
};
|
|
6912
|
-
content: {
|
|
6913
|
-
"application/json": components["schemas"]["ErrorResponse"];
|
|
6914
|
-
};
|
|
6915
|
-
};
|
|
6916
|
-
};
|
|
6917
|
-
};
|
|
6918
|
-
put?: never;
|
|
6919
|
-
post?: never;
|
|
6920
|
-
delete?: never;
|
|
6921
|
-
options?: never;
|
|
6922
|
-
head?: never;
|
|
6923
|
-
patch?: never;
|
|
6924
|
-
trace?: never;
|
|
6925
|
-
};
|
|
6926
6803
|
"/auth/login/": {
|
|
6927
6804
|
parameters: {
|
|
6928
6805
|
query?: never;
|
|
@@ -7210,6 +7087,120 @@ interface paths {
|
|
|
7210
7087
|
patch?: never;
|
|
7211
7088
|
trace?: never;
|
|
7212
7089
|
};
|
|
7090
|
+
"/avatars/accounts/{id}/{version}/": {
|
|
7091
|
+
parameters: {
|
|
7092
|
+
query?: never;
|
|
7093
|
+
header?: never;
|
|
7094
|
+
path?: never;
|
|
7095
|
+
cookie?: never;
|
|
7096
|
+
};
|
|
7097
|
+
/**
|
|
7098
|
+
* Get avatar
|
|
7099
|
+
* @description Returns the owner's avatar image (WebP), publicly. 404 when unset.
|
|
7100
|
+
*/
|
|
7101
|
+
get: {
|
|
7102
|
+
parameters: {
|
|
7103
|
+
query?: never;
|
|
7104
|
+
header?: never;
|
|
7105
|
+
path: {
|
|
7106
|
+
/** @description Opaque id of the avatar's owner. */
|
|
7107
|
+
id: string;
|
|
7108
|
+
/** @description Content-hash version segment identifying the exact stored object. */
|
|
7109
|
+
version: string;
|
|
7110
|
+
};
|
|
7111
|
+
cookie?: never;
|
|
7112
|
+
};
|
|
7113
|
+
requestBody?: never;
|
|
7114
|
+
responses: {
|
|
7115
|
+
/** @description no content */
|
|
7116
|
+
200: {
|
|
7117
|
+
headers: {
|
|
7118
|
+
[name: string]: unknown;
|
|
7119
|
+
};
|
|
7120
|
+
content?: never;
|
|
7121
|
+
};
|
|
7122
|
+
/**
|
|
7123
|
+
* @description HTTP error response representation with security-conscious design.
|
|
7124
|
+
*
|
|
7125
|
+
* This struct contains all the information needed to serialize an error
|
|
7126
|
+
* response, including the error name, message, HTTP status code, resource
|
|
7127
|
+
* information, and user-friendly messages.
|
|
7128
|
+
*/
|
|
7129
|
+
404: {
|
|
7130
|
+
headers: {
|
|
7131
|
+
[name: string]: unknown;
|
|
7132
|
+
};
|
|
7133
|
+
content: {
|
|
7134
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7135
|
+
};
|
|
7136
|
+
};
|
|
7137
|
+
};
|
|
7138
|
+
};
|
|
7139
|
+
put?: never;
|
|
7140
|
+
post?: never;
|
|
7141
|
+
delete?: never;
|
|
7142
|
+
options?: never;
|
|
7143
|
+
head?: never;
|
|
7144
|
+
patch?: never;
|
|
7145
|
+
trace?: never;
|
|
7146
|
+
};
|
|
7147
|
+
"/avatars/workspaces/{id}/{version}/": {
|
|
7148
|
+
parameters: {
|
|
7149
|
+
query?: never;
|
|
7150
|
+
header?: never;
|
|
7151
|
+
path?: never;
|
|
7152
|
+
cookie?: never;
|
|
7153
|
+
};
|
|
7154
|
+
/**
|
|
7155
|
+
* Get avatar
|
|
7156
|
+
* @description Returns the owner's avatar image (WebP), publicly. 404 when unset.
|
|
7157
|
+
*/
|
|
7158
|
+
get: {
|
|
7159
|
+
parameters: {
|
|
7160
|
+
query?: never;
|
|
7161
|
+
header?: never;
|
|
7162
|
+
path: {
|
|
7163
|
+
/** @description Opaque id of the avatar's owner. */
|
|
7164
|
+
id: string;
|
|
7165
|
+
/** @description Content-hash version segment identifying the exact stored object. */
|
|
7166
|
+
version: string;
|
|
7167
|
+
};
|
|
7168
|
+
cookie?: never;
|
|
7169
|
+
};
|
|
7170
|
+
requestBody?: never;
|
|
7171
|
+
responses: {
|
|
7172
|
+
/** @description no content */
|
|
7173
|
+
200: {
|
|
7174
|
+
headers: {
|
|
7175
|
+
[name: string]: unknown;
|
|
7176
|
+
};
|
|
7177
|
+
content?: never;
|
|
7178
|
+
};
|
|
7179
|
+
/**
|
|
7180
|
+
* @description HTTP error response representation with security-conscious design.
|
|
7181
|
+
*
|
|
7182
|
+
* This struct contains all the information needed to serialize an error
|
|
7183
|
+
* response, including the error name, message, HTTP status code, resource
|
|
7184
|
+
* information, and user-friendly messages.
|
|
7185
|
+
*/
|
|
7186
|
+
404: {
|
|
7187
|
+
headers: {
|
|
7188
|
+
[name: string]: unknown;
|
|
7189
|
+
};
|
|
7190
|
+
content: {
|
|
7191
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
7192
|
+
};
|
|
7193
|
+
};
|
|
7194
|
+
};
|
|
7195
|
+
};
|
|
7196
|
+
put?: never;
|
|
7197
|
+
post?: never;
|
|
7198
|
+
delete?: never;
|
|
7199
|
+
options?: never;
|
|
7200
|
+
head?: never;
|
|
7201
|
+
patch?: never;
|
|
7202
|
+
trace?: never;
|
|
7203
|
+
};
|
|
7213
7204
|
}
|
|
7214
7205
|
interface components {
|
|
7215
7206
|
schemas: {
|
|
@@ -7250,12 +7241,25 @@ interface components {
|
|
|
7250
7241
|
/** @description Public handle of the account. */
|
|
7251
7242
|
username: components["schemas"]["Handle"];
|
|
7252
7243
|
};
|
|
7244
|
+
/**
|
|
7245
|
+
* @description Public reference to the account behind a resource — whoever created it,
|
|
7246
|
+
* uploaded it, triggered it, or performed it.
|
|
7247
|
+
*
|
|
7248
|
+
* Reused across resource responses so an account is always presented the same
|
|
7249
|
+
* way: a handle plus an optional avatar.
|
|
7250
|
+
*/
|
|
7251
|
+
AccountRef: {
|
|
7252
|
+
/** @description Serve path of the account's avatar, when set. */
|
|
7253
|
+
avatarUrl?: string;
|
|
7254
|
+
/** @description Human-readable display name, when set. */
|
|
7255
|
+
displayName?: string;
|
|
7256
|
+
/** @description Handle of the account. */
|
|
7257
|
+
username: components["schemas"]["Handle"];
|
|
7258
|
+
};
|
|
7253
7259
|
/** @description Response type for a workspace activity. */
|
|
7254
7260
|
Activity: {
|
|
7255
7261
|
/** @description Type of activity. */
|
|
7256
7262
|
activityType: components["schemas"]["ActivityType"];
|
|
7257
|
-
/** @description Handle of the account that performed the activity, if any. */
|
|
7258
|
-
actorUsername?: components["schemas"]["Handle"];
|
|
7259
7263
|
/**
|
|
7260
7264
|
* Format: date-time
|
|
7261
7265
|
* @description When the activity occurred.
|
|
@@ -7268,6 +7272,8 @@ interface components {
|
|
|
7268
7272
|
* @description Unique activity identifier.
|
|
7269
7273
|
*/
|
|
7270
7274
|
id: string;
|
|
7275
|
+
/** @description Account that performed the activity. */
|
|
7276
|
+
performedBy: components["schemas"]["AccountRef"];
|
|
7271
7277
|
/** @description Handle of the workspace this activity belongs to. */
|
|
7272
7278
|
workspaceSlug: components["schemas"]["Handle"];
|
|
7273
7279
|
};
|
|
@@ -7855,6 +7861,22 @@ interface components {
|
|
|
7855
7861
|
/** @description Handle of the authenticated account. */
|
|
7856
7862
|
username: components["schemas"]["Handle"];
|
|
7857
7863
|
};
|
|
7864
|
+
/**
|
|
7865
|
+
* @description Path parameters for a public avatar route: the owner id and the avatar's
|
|
7866
|
+
* content-hash version.
|
|
7867
|
+
*
|
|
7868
|
+
* Each version is a distinct stored object, so an unknown version simply does
|
|
7869
|
+
* not resolve — the version needs no separate validation.
|
|
7870
|
+
*/
|
|
7871
|
+
AvatarPathParams: {
|
|
7872
|
+
/**
|
|
7873
|
+
* Format: uuid
|
|
7874
|
+
* @description Opaque id of the avatar's owner.
|
|
7875
|
+
*/
|
|
7876
|
+
id: string;
|
|
7877
|
+
/** @description Content-hash version segment identifying the exact stored object. */
|
|
7878
|
+
version: string;
|
|
7879
|
+
};
|
|
7858
7880
|
/**
|
|
7859
7881
|
* @description Typed credentials for Azure Blob Storage.
|
|
7860
7882
|
*
|
|
@@ -7972,8 +7994,8 @@ interface components {
|
|
|
7972
7994
|
* @description When the connection was created.
|
|
7973
7995
|
*/
|
|
7974
7996
|
createdAt: string;
|
|
7975
|
-
/** @description
|
|
7976
|
-
|
|
7997
|
+
/** @description Account that created this connection. */
|
|
7998
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
7977
7999
|
/** @description How an import reconciles files whose source object was deleted. */
|
|
7978
8000
|
deletionPolicy: components["schemas"]["SyncDeletionPolicy"];
|
|
7979
8001
|
/** @description Human-readable connection display name. */
|
|
@@ -8102,6 +8124,8 @@ interface components {
|
|
|
8102
8124
|
status: components["schemas"]["SyncStatus"];
|
|
8103
8125
|
/** @description How the sync was triggered. */
|
|
8104
8126
|
triggerType: components["schemas"]["SyncTriggerType"];
|
|
8127
|
+
/** @description Account that triggered the sync. */
|
|
8128
|
+
triggeredBy: components["schemas"]["AccountRef"];
|
|
8105
8129
|
};
|
|
8106
8130
|
/**
|
|
8107
8131
|
* @description Generic paginated response wrapper.
|
|
@@ -8597,8 +8621,8 @@ interface components {
|
|
|
8597
8621
|
* @description Last update timestamp.
|
|
8598
8622
|
*/
|
|
8599
8623
|
updatedAt: string;
|
|
8600
|
-
/** @description
|
|
8601
|
-
uploadedBy: components["schemas"]["
|
|
8624
|
+
/** @description Account that uploaded/created the file. */
|
|
8625
|
+
uploadedBy: components["schemas"]["AccountRef"];
|
|
8602
8626
|
/**
|
|
8603
8627
|
* Format: int32
|
|
8604
8628
|
* @description Version number (1 for original, higher for newer versions).
|
|
@@ -9386,6 +9410,8 @@ interface components {
|
|
|
9386
9410
|
};
|
|
9387
9411
|
/** @description Represents a workspace member. */
|
|
9388
9412
|
Member: {
|
|
9413
|
+
/** @description Serve path of the member's avatar, when set. */
|
|
9414
|
+
avatarUrl?: string;
|
|
9389
9415
|
/**
|
|
9390
9416
|
* Format: date-time
|
|
9391
9417
|
* @description Timestamp when the member joined the workspace.
|
|
@@ -9620,8 +9646,8 @@ interface components {
|
|
|
9620
9646
|
* @description Timestamp when the pipeline was created.
|
|
9621
9647
|
*/
|
|
9622
9648
|
createdAt: string;
|
|
9623
|
-
/** @description
|
|
9624
|
-
|
|
9649
|
+
/** @description Account that created this pipeline. */
|
|
9650
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
9625
9651
|
/** @description Detection + redaction configuration. */
|
|
9626
9652
|
definition: components["schemas"]["PipelineDefinition"];
|
|
9627
9653
|
/** @description Pipeline description. */
|
|
@@ -9756,8 +9782,8 @@ interface components {
|
|
|
9756
9782
|
status: components["schemas"]["PipelineRunStatus"];
|
|
9757
9783
|
/** @description How the run was triggered. */
|
|
9758
9784
|
triggerType: components["schemas"]["PipelineTriggerType"];
|
|
9759
|
-
/** @description
|
|
9760
|
-
|
|
9785
|
+
/** @description Account that triggered the run. */
|
|
9786
|
+
triggeredBy: components["schemas"]["AccountRef"];
|
|
9761
9787
|
/** @description Handle of the workspace this run belongs to. */
|
|
9762
9788
|
workspaceSlug: components["schemas"]["Handle"];
|
|
9763
9789
|
};
|
|
@@ -9840,10 +9866,11 @@ interface components {
|
|
|
9840
9866
|
/**
|
|
9841
9867
|
* @description Defines how a pipeline run was initiated.
|
|
9842
9868
|
*
|
|
9843
|
-
* This enumeration corresponds to the `PIPELINE_TRIGGER_TYPE` PostgreSQL enum
|
|
9844
|
-
*
|
|
9869
|
+
* This enumeration corresponds to the `PIPELINE_TRIGGER_TYPE` PostgreSQL enum:
|
|
9870
|
+
* a run is either started directly by a user or automatically by the system
|
|
9871
|
+
* (for example, a file upload that the pipeline auto-redacts).
|
|
9845
9872
|
*/
|
|
9846
|
-
PipelineTriggerType: "
|
|
9873
|
+
PipelineTriggerType: "user" | "system";
|
|
9847
9874
|
/**
|
|
9848
9875
|
* @description Point in a 2-D coordinate space.
|
|
9849
9876
|
*
|
|
@@ -9871,8 +9898,8 @@ interface components {
|
|
|
9871
9898
|
* @description When the policy was created.
|
|
9872
9899
|
*/
|
|
9873
9900
|
createdAt: string;
|
|
9874
|
-
/** @description
|
|
9875
|
-
|
|
9901
|
+
/** @description Account that created this policy. */
|
|
9902
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
9876
9903
|
/** @description The structured policy body consumed by the engine. */
|
|
9877
9904
|
definition: components["schemas"]["PolicyDefinition"];
|
|
9878
9905
|
/** @description Policy description. */
|
|
@@ -9999,8 +10026,8 @@ interface components {
|
|
|
9999
10026
|
* @description When the policy was created.
|
|
10000
10027
|
*/
|
|
10001
10028
|
createdAt: string;
|
|
10002
|
-
/** @description
|
|
10003
|
-
|
|
10029
|
+
/** @description Account that created this policy. */
|
|
10030
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
10004
10031
|
/** @description Policy description. */
|
|
10005
10032
|
description?: string;
|
|
10006
10033
|
/** @description Human-readable policy display name. */
|
|
@@ -11438,13 +11465,18 @@ interface components {
|
|
|
11438
11465
|
Waveform: "sine" | "square";
|
|
11439
11466
|
/** @description Workspace webhook response. */
|
|
11440
11467
|
Webhook: {
|
|
11468
|
+
/**
|
|
11469
|
+
* Format: int32
|
|
11470
|
+
* @description Consecutive failed deliveries since the last success.
|
|
11471
|
+
*/
|
|
11472
|
+
consecutiveFailures: number;
|
|
11441
11473
|
/**
|
|
11442
11474
|
* Format: date-time
|
|
11443
11475
|
* @description Timestamp when this webhook was first created.
|
|
11444
11476
|
*/
|
|
11445
11477
|
createdAt: string;
|
|
11446
|
-
/** @description
|
|
11447
|
-
|
|
11478
|
+
/** @description Account that created this webhook. */
|
|
11479
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
11448
11480
|
/** @description Detailed description of the webhook's purpose. */
|
|
11449
11481
|
description: string;
|
|
11450
11482
|
/** @description Human-readable name for the webhook. */
|
|
@@ -11459,9 +11491,14 @@ interface components {
|
|
|
11459
11491
|
id: components["schemas"]["WebhookId"];
|
|
11460
11492
|
/**
|
|
11461
11493
|
* Format: date-time
|
|
11462
|
-
* @description Timestamp of the most recent
|
|
11494
|
+
* @description Timestamp of the most recent failed delivery.
|
|
11495
|
+
*/
|
|
11496
|
+
lastFailureAt?: string;
|
|
11497
|
+
/**
|
|
11498
|
+
* Format: date-time
|
|
11499
|
+
* @description Timestamp of the most recent successful delivery.
|
|
11463
11500
|
*/
|
|
11464
|
-
|
|
11501
|
+
lastSuccessAt?: string;
|
|
11465
11502
|
/** @description Current status of the webhook. */
|
|
11466
11503
|
status: components["schemas"]["WebhookStatus"];
|
|
11467
11504
|
/**
|
|
@@ -11482,13 +11519,18 @@ interface components {
|
|
|
11482
11519
|
* again. Store it securely.
|
|
11483
11520
|
*/
|
|
11484
11521
|
WebhookCreated: {
|
|
11522
|
+
/**
|
|
11523
|
+
* Format: int32
|
|
11524
|
+
* @description Consecutive failed deliveries since the last success.
|
|
11525
|
+
*/
|
|
11526
|
+
consecutiveFailures: number;
|
|
11485
11527
|
/**
|
|
11486
11528
|
* Format: date-time
|
|
11487
11529
|
* @description Timestamp when this webhook was first created.
|
|
11488
11530
|
*/
|
|
11489
11531
|
createdAt: string;
|
|
11490
|
-
/** @description
|
|
11491
|
-
|
|
11532
|
+
/** @description Account that created this webhook. */
|
|
11533
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
11492
11534
|
/** @description Detailed description of the webhook's purpose. */
|
|
11493
11535
|
description: string;
|
|
11494
11536
|
/** @description Human-readable name for the webhook. */
|
|
@@ -11503,9 +11545,14 @@ interface components {
|
|
|
11503
11545
|
id: components["schemas"]["WebhookId"];
|
|
11504
11546
|
/**
|
|
11505
11547
|
* Format: date-time
|
|
11506
|
-
* @description Timestamp of the most recent
|
|
11548
|
+
* @description Timestamp of the most recent failed delivery.
|
|
11549
|
+
*/
|
|
11550
|
+
lastFailureAt?: string;
|
|
11551
|
+
/**
|
|
11552
|
+
* Format: date-time
|
|
11553
|
+
* @description Timestamp of the most recent successful delivery.
|
|
11507
11554
|
*/
|
|
11508
|
-
|
|
11555
|
+
lastSuccessAt?: string;
|
|
11509
11556
|
/**
|
|
11510
11557
|
* @description HMAC-SHA256 signing secret for webhook verification.
|
|
11511
11558
|
*
|
|
@@ -11586,8 +11633,8 @@ interface components {
|
|
|
11586
11633
|
* @description Timestamp when the workspace was created.
|
|
11587
11634
|
*/
|
|
11588
11635
|
createdAt: string;
|
|
11589
|
-
/** @description
|
|
11590
|
-
|
|
11636
|
+
/** @description Account that created this workspace. */
|
|
11637
|
+
createdBy: components["schemas"]["AccountRef"];
|
|
11591
11638
|
/** @description Description of the workspace. */
|
|
11592
11639
|
description?: string;
|
|
11593
11640
|
/** @description Display name of the workspace. */
|
|
@@ -11669,6 +11716,7 @@ type Schemas$16 = components["schemas"];
|
|
|
11669
11716
|
type Account = Schemas$16["Account"];
|
|
11670
11717
|
type PublicAccount = Schemas$16["PublicAccount"];
|
|
11671
11718
|
type UpdateAccount = Schemas$16["UpdateAccount"];
|
|
11719
|
+
type AccountRef = Schemas$16["AccountRef"];
|
|
11672
11720
|
//#endregion
|
|
11673
11721
|
//#region src/datatypes/activity.d.ts
|
|
11674
11722
|
type Schemas$15 = components["schemas"];
|
|
@@ -11821,5 +11869,5 @@ type UpdateWorkspace = Schemas["UpdateWorkspace"];
|
|
|
11821
11869
|
type WorkspaceRole = Schemas["WorkspaceRole"];
|
|
11822
11870
|
type WorkspacePage = Schemas["WorkspacePage"];
|
|
11823
11871
|
//#endregion
|
|
11824
|
-
export { InviteExpiration as $,
|
|
11825
|
-
//# sourceMappingURL=index-
|
|
11872
|
+
export { InviteExpiration as $, UpdateAccount as $t, PipelineDefinition as A, S3Credentials as At, NotificationPage as B, ApiToken as Bt, PolicyDefinition as C, ConnectionPage as Ct, UpdatePolicy as D, ConnectionsQuery as Dt, PolicySummaryPage as E, ConnectionVerification as Et, PipelineTriggerType as F, SyncTriggerType as Ft, Member as G, TokenExpiration as Gt, UnreadStatus as H, ApiTokenType as Ht, UpdatePipeline as I, UpdateConnection as It, UpdateMember as J, ActivityPage as Jt, MemberPage as K, UpdateApiToken as Kt, CursorPagination as L, AuthToken as Lt, PipelineStatus as M, SyncDeletionPolicy as Mt, PipelineSummary as N, SyncMode as Nt, CreatePipeline as O, CreateConnection as Ot, PipelineSummaryPage as P, SyncStatus as Pt, InviteCode as Q, PublicAccount as Qt, Notification as R, Login as Rt, Policy as S, ConnectionConfig as St, PolicySummary as T, ConnectionSyncPage as Tt, UpdateNotificationSettings as U, ApiTokenWithJWT as Ut, NotificationSettings as V, ApiTokenPage as Vt, ListMembers as W, CreateApiToken as Wt, GenerateInviteCode as X, Account as Xt, CreateInvite as Y, ActivityType as Yt, Invite as Z, AccountRef as Zt, CreatePipelineRun as _, UpdateFile as _t, WorkspaceRole as a, ListInvites as at, PipelineRunStatus as b, AzureCredentials as bt, UpdateWebhook as c, ComponentHealth as ct, WebhookEvent as d, File as dt, paths as en, InvitePage as et, WebhookPage as f, FilePage as ft, Artifact as g, ModalityToken as gt, AnalyzedDocument as h, ListFiles as ht, WorkspacePage as i, InviteStatus as it, PipelineFilter as j, SyncConnection as jt, Pipeline as k, GcsCredentials as kt, Webhook as l, Health as lt, WebhookStatus as m, FormatToken as mt, UpdateWorkspace as n, InviteSent as nt, CreateWebhook as o, ReplyInvite as ot, WebhookResult as p, FileSource as pt, MemberSortField as q, Activity as qt, Workspace as r, InviteSortField as rt, TestWebhook as s, SortOrder as st, CreateWorkspace as t, InvitePreview as tt, WebhookCreated as u, HealthStatus as ut, PipelineRun as v, ErrorResponse as vt, PolicyRule as w, ConnectionSync as wt, CreatePolicy as x, Connection as xt, PipelineRunPage as y, ValidationErrorDetail as yt, NotificationEvent as z, Signup as zt };
|
|
11873
|
+
//# sourceMappingURL=index-HUG77R_t.d.ts.map
|