@keboola/api-client 40.0.0 → 42.0.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/API-SURFACE.md +47 -3
- package/CHANGELOG.md +167 -0
- package/README.md +1 -1
- package/dist/{ManagementClientAuthError-DE7lNGZQ.cjs → ManagementClientAuthError-BFZOtLgj.cjs} +2 -2
- package/dist/{ManagementClientAuthError-DE7lNGZQ.cjs.map → ManagementClientAuthError-BFZOtLgj.cjs.map} +1 -1
- package/dist/{ManagementClientAuthError-H30lti_Q.js → ManagementClientAuthError-DUbXlry2.js} +2 -2
- package/dist/{ManagementClientAuthError-H30lti_Q.js.map → ManagementClientAuthError-DUbXlry2.js.map} +1 -1
- package/dist/ai/index.cjs +2 -2
- package/dist/ai/index.js +2 -2
- package/dist/{appLogs-BBkkUOW1.js → appLogs-DfkItQCO.js} +2 -2
- package/dist/{appLogs-BBkkUOW1.js.map → appLogs-DfkItQCO.js.map} +1 -1
- package/dist/{appLogs-B9zFJIuy.cjs → appLogs-oZvt59mk.cjs} +2 -2
- package/dist/{appLogs-B9zFJIuy.cjs.map → appLogs-oZvt59mk.cjs.map} +1 -1
- package/dist/apps/index.cjs +3 -3
- package/dist/apps/index.js +3 -3
- package/dist/assets/index.cjs +1 -1
- package/dist/assets/index.js +1 -1
- package/dist/auth/index.cjs +1 -1
- package/dist/auth/index.d.cts +1 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/auth/index.js +1 -1
- package/dist/auth/types.d.cts +2 -2
- package/dist/auth/types.d.ts +2 -2
- package/dist/{auth-DworfoPy.js → auth-DUHTJTwS.js} +2 -2
- package/dist/{auth-DworfoPy.js.map → auth-DUHTJTwS.js.map} +1 -1
- package/dist/{auth-Dm0F2rOh.cjs → auth-zfI04oj7.cjs} +2 -2
- package/dist/{auth-Dm0F2rOh.cjs.map → auth-zfI04oj7.cjs.map} +1 -1
- package/dist/{authClient-BmuUo0J4.cjs → authClient-BxqRGR5c.cjs} +39 -5
- package/dist/authClient-BxqRGR5c.cjs.map +1 -0
- package/dist/{authClient-vEt_7_uk.d.cts → authClient-CBVAT3v9.d.cts} +49 -2
- package/dist/{authClient-CHXWJ9x3.d.ts → authClient-CRumc934.d.ts} +49 -2
- package/dist/{authClient-CgcDGd30.js → authClient-CX4buUMc.js} +39 -5
- package/dist/authClient-CX4buUMc.js.map +1 -0
- package/dist/billing/index.cjs +2 -2
- package/dist/billing/index.js +2 -2
- package/dist/businessWorkspaceApi/index.cjs +1 -1
- package/dist/businessWorkspaceApi/index.js +1 -1
- package/dist/{businessWorkspaceApi-BLUdefRF.js → businessWorkspaceApi-DFky1k61.js} +3 -3
- package/dist/{businessWorkspaceApi-BLUdefRF.js.map → businessWorkspaceApi-DFky1k61.js.map} +1 -1
- package/dist/{businessWorkspaceApi-6tCDdpnY.cjs → businessWorkspaceApi-Uzqu0PJM.cjs} +3 -3
- package/dist/{businessWorkspaceApi-6tCDdpnY.cjs.map → businessWorkspaceApi-Uzqu0PJM.cjs.map} +1 -1
- package/dist/chat/index.cjs +3 -3
- package/dist/chat/index.js +3 -3
- package/dist/{componentId-57vjsa2i.cjs → componentId-D4jp6a13.cjs} +19 -1
- package/dist/componentId-D4jp6a13.cjs.map +1 -0
- package/dist/{componentId-C6WZa_R1.js → componentId-DmHwHG5V.js} +19 -1
- package/dist/componentId-DmHwHG5V.js.map +1 -0
- package/dist/{configurations-IYyOvhI3.cjs → configurations-D_Rbs0Wl.cjs} +2 -2
- package/dist/{configurations-IYyOvhI3.cjs.map → configurations-D_Rbs0Wl.cjs.map} +1 -1
- package/dist/{configurations-BPKGGy-M.js → configurations-DcpUlC8I.js} +2 -2
- package/dist/{configurations-BPKGGy-M.js.map → configurations-DcpUlC8I.js.map} +1 -1
- package/dist/constants/index.cjs +1 -1
- package/dist/constants/index.d.cts +1 -1
- package/dist/constants/index.d.ts +1 -1
- package/dist/constants/index.js +1 -1
- package/dist/{createFetchClient-Cwp8max9.cjs → createFetchClient-BgihytBn.cjs} +2 -1
- package/dist/createFetchClient-BgihytBn.cjs.map +1 -0
- package/dist/{createFetchClient-DXHQK63w.js → createFetchClient-cgWkwgAQ.js} +2 -1
- package/dist/createFetchClient-cgWkwgAQ.js.map +1 -0
- package/dist/{createGenericFetchClient-Dl9cqTvR.cjs → createGenericFetchClient-C7Y0YVfc.cjs} +2 -2
- package/dist/{createGenericFetchClient-Dl9cqTvR.cjs.map → createGenericFetchClient-C7Y0YVfc.cjs.map} +1 -1
- package/dist/{createGenericFetchClient-Dg1rgzmG.js → createGenericFetchClient-CX9Hn3Aq.js} +2 -2
- package/dist/{createGenericFetchClient-Dg1rgzmG.js.map → createGenericFetchClient-CX9Hn3Aq.js.map} +1 -1
- package/dist/{createOpenapiFetchClient-DZUOVupy.js → createOpenapiFetchClient-BxcLLU_N.js} +2 -2
- package/dist/{createOpenapiFetchClient-DZUOVupy.js.map → createOpenapiFetchClient-BxcLLU_N.js.map} +1 -1
- package/dist/{createOpenapiFetchClient-BYqW-9tm.cjs → createOpenapiFetchClient-DY5s-aH6.cjs} +2 -2
- package/dist/{createOpenapiFetchClient-BYqW-9tm.cjs.map → createOpenapiFetchClient-DY5s-aH6.cjs.map} +1 -1
- package/dist/dataScience/index.cjs +2 -2
- package/dist/dataScience/index.js +2 -2
- package/dist/{dataScience-B5QxZnvW.cjs → dataScience-BoS8Xfvx.cjs} +5 -5
- package/dist/{dataScience-B5QxZnvW.cjs.map → dataScience-BoS8Xfvx.cjs.map} +1 -1
- package/dist/{dataScience-OXcwdk1p.js → dataScience-BxRoGfnG.js} +5 -5
- package/dist/{dataScience-OXcwdk1p.js.map → dataScience-BxRoGfnG.js.map} +1 -1
- package/dist/developerPortal/index.cjs +1 -1
- package/dist/developerPortal/index.js +1 -1
- package/dist/{developerPortalClient-B1QZ1rYi.js → developerPortalClient-C7s0kpjK.js} +3 -3
- package/dist/{developerPortalClient-B1QZ1rYi.js.map → developerPortalClient-C7s0kpjK.js.map} +1 -1
- package/dist/{developerPortalClient-CLPpBksD.cjs → developerPortalClient-DFHEsrlt.cjs} +3 -3
- package/dist/{developerPortalClient-CLPpBksD.cjs.map → developerPortalClient-DFHEsrlt.cjs.map} +1 -1
- package/dist/domain/permissions/index.d.cts +2 -2
- package/dist/domain/permissions/index.d.ts +2 -2
- package/dist/domain/storageTable/index.cjs +7 -1
- package/dist/domain/storageTable/index.d.cts +2 -2
- package/dist/domain/storageTable/index.d.ts +2 -2
- package/dist/domain/storageTable/index.js +2 -2
- package/dist/editor/index.cjs +2 -2
- package/dist/editor/index.js +2 -2
- package/dist/encryption/index.cjs +1 -1
- package/dist/encryption/index.d.cts +1 -1
- package/dist/encryption/index.d.ts +1 -1
- package/dist/encryption/index.js +1 -1
- package/dist/encryption/types.d.cts +1 -1
- package/dist/encryption/types.d.ts +1 -1
- package/dist/import/index.cjs +1 -1
- package/dist/import/index.js +1 -1
- package/dist/{import-CNk89mqy.cjs → import-BSYvG3Uy.cjs} +3 -3
- package/dist/{import-CNk89mqy.cjs.map → import-BSYvG3Uy.cjs.map} +1 -1
- package/dist/{import-DiMQCzLa.js → import-CXBcFVbk.js} +3 -3
- package/dist/{import-DiMQCzLa.js.map → import-CXBcFVbk.js.map} +1 -1
- package/dist/{index-DCRKjihs.d.ts → index-B03vhWSX.d.ts} +117 -90
- package/dist/{index-DXYASsPP.d.cts → index-B2-7WJ-E.d.cts} +599 -78
- package/dist/{index-BDZvaRud.d.ts → index-B72LTF-k.d.ts} +6 -3
- package/dist/{index-DOAZmWvh.d.cts → index-BMiZx-4_.d.cts} +6 -3
- package/dist/{index--ZpnE3YT.d.cts → index-BUsLHNOA.d.cts} +2 -2
- package/dist/{index-D7-o-oGa.d.ts → index-CBWfpd-0.d.ts} +2 -2
- package/dist/index-CGCXR_6Q.d.ts +273 -0
- package/dist/{index-Cvbjp3jx.d.cts → index-CKENwClW.d.cts} +4 -4
- package/dist/{index-BkqackZf.d.ts → index-CpE_NWuq.d.ts} +599 -78
- package/dist/{index-DnQTuc6t.d.ts → index-Cw-d6vV3.d.ts} +4 -4
- package/dist/{index-ByRpNVcs.d.cts → index-D3HFMfJJ.d.cts} +117 -90
- package/dist/index-DINB7vsV.d.cts +273 -0
- package/dist/{index-C8gRRWHL.d.cts → index-DeQDdut6.d.cts} +19 -1
- package/dist/{index-C8gRRWHL.d.ts → index-DeQDdut6.d.ts} +19 -1
- package/dist/{index-Qb7X6-ph.d.ts → index-DwM1EpnZ.d.ts} +12 -2
- package/dist/{index-CXcWpZQ2.d.ts → index-P1vR966i.d.cts} +74 -2
- package/dist/{index-CXcWpZQ2.d.cts → index-P1vR966i.d.ts} +74 -2
- package/dist/{index-DNThyEej.d.cts → index-VnJCp8IL.d.cts} +12 -2
- package/dist/index.cjs +65 -39
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +65 -40
- package/dist/index.js.map +1 -1
- package/dist/{isLoginPageRedirect-XPwAOKK3.js → isLoginPageRedirect-CsjF95_P.js} +2 -2
- package/dist/{isLoginPageRedirect-XPwAOKK3.js.map → isLoginPageRedirect-CsjF95_P.js.map} +1 -1
- package/dist/{isLoginPageRedirect-jQHiLrG7.cjs → isLoginPageRedirect-c451CoWW.cjs} +2 -2
- package/dist/{isLoginPageRedirect-jQHiLrG7.cjs.map → isLoginPageRedirect-c451CoWW.cjs.map} +1 -1
- package/dist/kaiAgent/index.cjs +1 -1
- package/dist/kaiAgent/index.d.cts +2 -2
- package/dist/kaiAgent/index.d.ts +2 -2
- package/dist/kaiAgent/index.js +1 -1
- package/dist/{kaiAgent-QNoeVKPs.cjs → kaiAgent-ph4DRKlT.cjs} +21 -5
- package/dist/kaiAgent-ph4DRKlT.cjs.map +1 -0
- package/dist/{kaiAgent-Dp20HLTh.js → kaiAgent-xBpUwLeQ.js} +21 -5
- package/dist/kaiAgent-xBpUwLeQ.js.map +1 -0
- package/dist/{kaiMemory-D0Y_16U4.js → kaiMemory-BAniZZAN.js} +2 -2
- package/dist/{kaiMemory-D0Y_16U4.js.map → kaiMemory-BAniZZAN.js.map} +1 -1
- package/dist/{kaiMemory-CClSPInt.cjs → kaiMemory-U0DG-CpY.cjs} +2 -2
- package/dist/{kaiMemory-CClSPInt.cjs.map → kaiMemory-U0DG-CpY.cjs.map} +1 -1
- package/dist/management/index.cjs +1 -1
- package/dist/management/index.d.cts +1 -1
- package/dist/management/index.d.ts +1 -1
- package/dist/management/index.js +1 -1
- package/dist/management/types.d.cts +2 -2
- package/dist/management/types.d.ts +2 -2
- package/dist/{management-CCY0IYnq.cjs → management-5597SiC7.cjs} +79 -11
- package/dist/management-5597SiC7.cjs.map +1 -0
- package/dist/{management-DvmPiG64.js → management-D46KlXts.js} +79 -11
- package/dist/management-D46KlXts.js.map +1 -0
- package/dist/metastore/index.cjs +1 -1
- package/dist/metastore/index.d.cts +1 -1
- package/dist/metastore/index.d.ts +1 -1
- package/dist/metastore/index.js +1 -1
- package/dist/metastore/types.d.cts +2 -2
- package/dist/metastore/types.d.ts +2 -2
- package/dist/{metastore-XtWciCZT.cjs → metastore-DwMFlP2d.cjs} +52 -7
- package/dist/metastore-DwMFlP2d.cjs.map +1 -0
- package/dist/{metastore-BycJxe7A.js → metastore-_OskcLGz.js} +52 -7
- package/dist/metastore-_OskcLGz.js.map +1 -0
- package/dist/microsoftGraph/index.cjs +2 -2
- package/dist/microsoftGraph/index.js +2 -2
- package/dist/{middleware-CBwrtgQd.js → middleware-Drbo_UIZ.js} +2 -2
- package/dist/{middleware-CBwrtgQd.js.map → middleware-Drbo_UIZ.js.map} +1 -1
- package/dist/{middleware-IjYx3d5u.cjs → middleware-xhg2r2fE.cjs} +2 -2
- package/dist/{middleware-IjYx3d5u.cjs.map → middleware-xhg2r2fE.cjs.map} +1 -1
- package/dist/notifications/index.cjs +3 -3
- package/dist/notifications/index.js +3 -3
- package/dist/oauth/index.cjs +1 -1
- package/dist/oauth/index.js +1 -1
- package/dist/{oauth--2p8jkJf.cjs → oauth-L0Uic3YA.cjs} +5 -5
- package/dist/{oauth--2p8jkJf.cjs.map → oauth-L0Uic3YA.cjs.map} +1 -1
- package/dist/{oauth-l5zE39cD.js → oauth-TWwAv-va.js} +5 -5
- package/dist/{oauth-l5zE39cD.js.map → oauth-TWwAv-va.js.map} +1 -1
- package/dist/omnisearch/index.cjs +2 -2
- package/dist/omnisearch/index.js +2 -2
- package/dist/{project-cHKuGvqJ.d.cts → project-B8wtlstY.d.cts} +2 -2
- package/dist/{project-B15gStbM.d.ts → project-BCc3mpAy.d.ts} +2 -2
- package/dist/queryService/index.cjs +1 -1
- package/dist/queryService/index.d.cts +1 -1
- package/dist/queryService/index.d.ts +1 -1
- package/dist/queryService/index.js +1 -1
- package/dist/{queryService-CCOYbRbw.js → queryService-CdtogGr7.js} +5 -5
- package/dist/{queryService-CCOYbRbw.js.map → queryService-CdtogGr7.js.map} +1 -1
- package/dist/{queryService-CQzclHdL.cjs → queryService-Dx6AdxOl.cjs} +5 -5
- package/dist/{queryService-CQzclHdL.cjs.map → queryService-Dx6AdxOl.cjs.map} +1 -1
- package/dist/queue/index.cjs +1 -1
- package/dist/queue/index.d.cts +1 -1
- package/dist/queue/index.d.ts +1 -1
- package/dist/queue/index.js +1 -1
- package/dist/{queue-Cowbg6bR.js → queue-f2xsjy0o.js} +4 -4
- package/dist/{queue-Cowbg6bR.js.map → queue-f2xsjy0o.js.map} +1 -1
- package/dist/{queue-UG_BWKIC.cjs → queue-wIdnMtaZ.cjs} +4 -4
- package/dist/{queue-UG_BWKIC.cjs.map → queue-wIdnMtaZ.cjs.map} +1 -1
- package/dist/scheduler/index.cjs +3 -3
- package/dist/scheduler/index.js +3 -3
- package/dist/sdk/configurations/index.cjs +1 -1
- package/dist/sdk/configurations/index.d.cts +4 -4
- package/dist/sdk/configurations/index.d.ts +4 -4
- package/dist/sdk/configurations/index.js +1 -1
- package/dist/sdk/developerPortal/index.cjs +3 -3
- package/dist/sdk/developerPortal/index.js +3 -3
- package/dist/sdk/kaiMemory/index.cjs +1 -1
- package/dist/sdk/kaiMemory/index.d.cts +1 -1
- package/dist/sdk/kaiMemory/index.d.ts +1 -1
- package/dist/sdk/kaiMemory/index.js +1 -1
- package/dist/sdk/kaiMemory/types.d.cts +1 -1
- package/dist/sdk/kaiMemory/types.d.ts +1 -1
- package/dist/sdk/queryService/index.d.cts +1 -1
- package/dist/sdk/queryService/index.d.ts +1 -1
- package/dist/sdk/semanticLayer/index.cjs +2 -1
- package/dist/sdk/semanticLayer/index.d.cts +10 -3
- package/dist/sdk/semanticLayer/index.d.ts +10 -3
- package/dist/sdk/semanticLayer/index.js +2 -2
- package/dist/sdk/semanticLayer/types.d.cts +2 -2
- package/dist/sdk/semanticLayer/types.d.ts +2 -2
- package/dist/sdk/storage/index.cjs +12 -24
- package/dist/sdk/storage/index.cjs.map +1 -1
- package/dist/sdk/storage/index.d.cts +1 -1
- package/dist/sdk/storage/index.d.ts +1 -1
- package/dist/sdk/storage/index.js +12 -24
- package/dist/sdk/storage/index.js.map +1 -1
- package/dist/sdk/tag/index.d.cts +2 -2
- package/dist/sdk/tag/index.d.ts +2 -2
- package/dist/sdk/tag/types.d.cts +1 -1
- package/dist/sdk/tag/types.d.ts +1 -1
- package/dist/sdk/vault/index.d.cts +1 -1
- package/dist/sdk/vault/index.d.ts +1 -1
- package/dist/{semanticLayer-CKDVkU56.cjs → semanticLayer-D3NDh_QH.cjs} +115 -20
- package/dist/semanticLayer-D3NDh_QH.cjs.map +1 -0
- package/dist/{semanticLayer-pYy082Ju.js → semanticLayer-Ddg0LSnt.js} +110 -21
- package/dist/semanticLayer-Ddg0LSnt.js.map +1 -0
- package/dist/status/index.cjs +1 -1
- package/dist/status/index.js +1 -1
- package/dist/storage/index.cjs +4 -4
- package/dist/storage/index.d.cts +2 -2
- package/dist/storage/index.d.ts +2 -2
- package/dist/storage/index.js +4 -4
- package/dist/storage/types.d.cts +3 -3
- package/dist/storage/types.d.ts +3 -3
- package/dist/{storage-CZQHZcXG.js → storage-BkdjgtCU.js} +272 -134
- package/dist/storage-BkdjgtCU.js.map +1 -0
- package/dist/{storage-JinL1y1s.cjs → storage-CXQTTVXl.cjs} +272 -134
- package/dist/storage-CXQTTVXl.cjs.map +1 -0
- package/dist/{storageTable-C9crh4Ef.cjs → storageTable-BNOR2FCh.cjs} +137 -5
- package/dist/storageTable-BNOR2FCh.cjs.map +1 -0
- package/dist/{storageTable-DslXtqNL.js → storageTable-BldTNyEk.js} +102 -6
- package/dist/storageTable-BldTNyEk.js.map +1 -0
- package/dist/stream/index.cjs +3 -3
- package/dist/stream/index.js +3 -3
- package/dist/syncActions/index.cjs +4 -1
- package/dist/syncActions/index.d.cts +3 -2
- package/dist/syncActions/index.d.ts +3 -2
- package/dist/syncActions/index.js +2 -2
- package/dist/syncActions/types.d.cts +2 -2
- package/dist/syncActions/types.d.ts +2 -2
- package/dist/syncActions-BQ8kMgL6.js +1191 -0
- package/dist/syncActions-BQ8kMgL6.js.map +1 -0
- package/dist/syncActions-DyxNmbUR.cjs +1216 -0
- package/dist/syncActions-DyxNmbUR.cjs.map +1 -0
- package/dist/telemetry/index.cjs +3 -3
- package/dist/telemetry/index.js +3 -3
- package/dist/{types-DWiLcrxt.d.cts → types-04GTqleJ.d.cts} +3 -3
- package/dist/{types-DRCMBt89.d.ts → types-2Do0DZ60.d.ts} +3 -3
- package/dist/{types-Dtuvhm3K.d.cts → types-BWmLo73i.d.cts} +749 -186
- package/dist/types-BaSlU0uo.d.ts +1313 -0
- package/dist/{types-DEzW1CfI.d.cts → types-BgHtMe8s.d.cts} +3 -3
- package/dist/{types-BiMahEK8.d.cts → types-BgVt8SUY.d.cts} +126 -62
- package/dist/{types-BS4jwuMi.d.ts → types-BhEx9iRx.d.ts} +3068 -621
- package/dist/{types-CMzQSHAQ.d.cts → types-BzPuxmaR.d.cts} +3 -3
- package/dist/{types-CKmTZSPG.d.ts → types-C0rVtqz2.d.ts} +126 -62
- package/dist/{types-Bl03Cg2n.d.cts → types-CAAgCRmE.d.cts} +31 -5
- package/dist/{types-BIECJYun.d.ts → types-CN6huo55.d.ts} +406 -5
- package/dist/{types-Cg14ncdV.d.ts → types-CV7jmgtX.d.ts} +3 -3
- package/dist/types-CcYxlqtB.d.cts +1313 -0
- package/dist/{types-FwRmjsNN.d.ts → types-CigD_EF5.d.ts} +18 -6
- package/dist/{types-B_iLJlp4.d.ts → types-CwZgZqrA.d.ts} +31 -5
- package/dist/{types-BTK7Bv3n.d.cts → types-DgPt4LY_.d.cts} +406 -5
- package/dist/{types-bc-4z_gc.d.cts → types-DyArI_Jq.d.cts} +18 -6
- package/dist/{types-DekYAlA-.d.ts → types-QSchmyvO.d.ts} +3 -3
- package/dist/{types-DKc1gmd9.d.ts → types-R3AFJD6r.d.ts} +749 -186
- package/dist/{types-DDOa07rU.d.cts → types-sV9OaqTI.d.cts} +3068 -621
- package/dist/{validateConnectionStatus-BEYkQpu9.cjs → validateConnectionStatus-Ca1uEizv.cjs} +3 -3
- package/dist/{validateConnectionStatus-BEYkQpu9.cjs.map → validateConnectionStatus-Ca1uEizv.cjs.map} +1 -1
- package/dist/{validateConnectionStatus-BEGu8wXT.js → validateConnectionStatus-gFsBi5FV.js} +3 -3
- package/dist/{validateConnectionStatus-BEGu8wXT.js.map → validateConnectionStatus-gFsBi5FV.js.map} +1 -1
- package/dist/vault/index.cjs +4 -4
- package/dist/vault/index.js +4 -4
- package/package.json +7 -7
- package/surface/auth.md +7 -0
- package/surface/kaiAgent.md +4 -2
- package/surface/management.md +28 -13
- package/surface/metastore.md +4 -1
- package/surface/queue.md +1 -1
- package/surface/sdk.md +13 -8
- package/surface/storage.md +27 -24
- package/surface/syncActions.md +55 -1
- package/dist/authClient-BmuUo0J4.cjs.map +0 -1
- package/dist/authClient-CgcDGd30.js.map +0 -1
- package/dist/componentId-57vjsa2i.cjs.map +0 -1
- package/dist/componentId-C6WZa_R1.js.map +0 -1
- package/dist/createFetchClient-Cwp8max9.cjs.map +0 -1
- package/dist/createFetchClient-DXHQK63w.js.map +0 -1
- package/dist/index-CPu4Nezo.d.cts +0 -90
- package/dist/index-Dazy-meb.d.ts +0 -90
- package/dist/kaiAgent-Dp20HLTh.js.map +0 -1
- package/dist/kaiAgent-QNoeVKPs.cjs.map +0 -1
- package/dist/management-CCY0IYnq.cjs.map +0 -1
- package/dist/management-DvmPiG64.js.map +0 -1
- package/dist/metastore-BycJxe7A.js.map +0 -1
- package/dist/metastore-XtWciCZT.cjs.map +0 -1
- package/dist/semanticLayer-CKDVkU56.cjs.map +0 -1
- package/dist/semanticLayer-pYy082Ju.js.map +0 -1
- package/dist/storage-CZQHZcXG.js.map +0 -1
- package/dist/storage-JinL1y1s.cjs.map +0 -1
- package/dist/storageTable-C9crh4Ef.cjs.map +0 -1
- package/dist/storageTable-DslXtqNL.js.map +0 -1
- package/dist/syncActions-BmmoqZO_.js +0 -516
- package/dist/syncActions-BmmoqZO_.js.map +0 -1
- package/dist/syncActions-CtcLGQiy.cjs +0 -523
- package/dist/syncActions-CtcLGQiy.cjs.map +0 -1
- package/dist/types-BYM9Ptz5.d.ts +0 -671
- package/dist/types-CFeZCQ9p.d.cts +0 -671
|
@@ -227,7 +227,17 @@ type paths = {
|
|
|
227
227
|
* @description Obtains information about a bucket, including its metadata, tables, scheduled tasks, listing and buckets linked to it.
|
|
228
228
|
*/
|
|
229
229
|
get: operations['get_/v2/storage/branch/{branchId}/buckets/{bucketId}::BucketDetailAction'];
|
|
230
|
-
|
|
230
|
+
/**
|
|
231
|
+
* Update a bucket
|
|
232
|
+
* @description Updates the display name and the color of a bucket. With `async=true` the update is enqueued as a job (202). The synchronous variant is deprecated.
|
|
233
|
+
*
|
|
234
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [BucketUpdateJobResult](#model-BucketUpdateJobResult).
|
|
235
|
+
*
|
|
236
|
+
* Parameters of job will be [BucketUpdateJobParams](#components-schemas-BucketUpdateJobParams).
|
|
237
|
+
*
|
|
238
|
+
* [Deprecated] This endpoint can be used synchronously as well. In that case, the final result is returned directly in the response [BucketUpdateResponse](#model-BucketUpdateResponse).
|
|
239
|
+
*/
|
|
240
|
+
put: operations['put_/v2/storage/branch/{branchId}/buckets/{bucketId}::BucketUpdateAction'];
|
|
231
241
|
post?: never;
|
|
232
242
|
/**
|
|
233
243
|
* Drop Bucket
|
|
@@ -257,7 +267,17 @@ type paths = {
|
|
|
257
267
|
* @description Obtains information about a bucket, including its metadata, tables, scheduled tasks, listing and buckets linked to it.
|
|
258
268
|
*/
|
|
259
269
|
get: operations['get_/v2/storage/buckets/{bucketId}::BucketDetailAction'];
|
|
260
|
-
|
|
270
|
+
/**
|
|
271
|
+
* Update a bucket
|
|
272
|
+
* @description Updates the display name and the color of a bucket. With `async=true` the update is enqueued as a job (202). The synchronous variant is deprecated.
|
|
273
|
+
*
|
|
274
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [BucketUpdateJobResult](#model-BucketUpdateJobResult).
|
|
275
|
+
*
|
|
276
|
+
* Parameters of job will be [BucketUpdateJobParams](#components-schemas-BucketUpdateJobParams).
|
|
277
|
+
*
|
|
278
|
+
* [Deprecated] This endpoint can be used synchronously as well. In that case, the final result is returned directly in the response [BucketUpdateResponse](#model-BucketUpdateResponse).
|
|
279
|
+
*/
|
|
280
|
+
put: operations['put_/v2/storage/buckets/{bucketId}::BucketUpdateAction'];
|
|
261
281
|
post?: never;
|
|
262
282
|
/**
|
|
263
283
|
* Drop Bucket
|
|
@@ -525,6 +545,72 @@ type paths = {
|
|
|
525
545
|
patch?: never;
|
|
526
546
|
trace?: never;
|
|
527
547
|
};
|
|
548
|
+
'/v2/storage/branch/{branchId}/buckets/{bucketId}/table-aliases': {
|
|
549
|
+
parameters: {
|
|
550
|
+
query?: never;
|
|
551
|
+
header?: never;
|
|
552
|
+
path?: never;
|
|
553
|
+
cookie?: never;
|
|
554
|
+
};
|
|
555
|
+
get?: never;
|
|
556
|
+
put?: never;
|
|
557
|
+
/**
|
|
558
|
+
* Create a table alias in a bucket
|
|
559
|
+
* @description Creates an alias table in the given bucket over a table from another bucket. The alias can
|
|
560
|
+
* expose a subset of the source columns and can be restricted by a filter. On backends that
|
|
561
|
+
* keep a persisted VIEW for aliases the work is delegated to an asynchronous job, otherwise the
|
|
562
|
+
* alias is created directly and returned with 201.
|
|
563
|
+
*
|
|
564
|
+
* An alias cannot be created from a table that lives in an external bucket or in a development
|
|
565
|
+
* branch. Additionally, the destination bucket itself cannot be an external bucket or a
|
|
566
|
+
* development branch bucket.
|
|
567
|
+
*
|
|
568
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [AliasCreateJobResult](#model-AliasCreateJobResult).
|
|
569
|
+
*
|
|
570
|
+
* Parameters of job will be [AliasCreateJobParams](#components-schemas-AliasCreateJobParams).
|
|
571
|
+
*
|
|
572
|
+
* This endpoint can be used synchronously as well. In that case, the final result is returned directly in the response [CreateTableAliasResponse](#model-CreateTableAliasResponse).
|
|
573
|
+
*/
|
|
574
|
+
post: operations['post_/v2/storage/branch/{branchId}/buckets/{bucketId}/table-aliases::CreateTableAliasAction'];
|
|
575
|
+
delete?: never;
|
|
576
|
+
options?: never;
|
|
577
|
+
head?: never;
|
|
578
|
+
patch?: never;
|
|
579
|
+
trace?: never;
|
|
580
|
+
};
|
|
581
|
+
'/v2/storage/buckets/{bucketId}/table-aliases': {
|
|
582
|
+
parameters: {
|
|
583
|
+
query?: never;
|
|
584
|
+
header?: never;
|
|
585
|
+
path?: never;
|
|
586
|
+
cookie?: never;
|
|
587
|
+
};
|
|
588
|
+
get?: never;
|
|
589
|
+
put?: never;
|
|
590
|
+
/**
|
|
591
|
+
* Create a table alias in a bucket
|
|
592
|
+
* @description Creates an alias table in the given bucket over a table from another bucket. The alias can
|
|
593
|
+
* expose a subset of the source columns and can be restricted by a filter. On backends that
|
|
594
|
+
* keep a persisted VIEW for aliases the work is delegated to an asynchronous job, otherwise the
|
|
595
|
+
* alias is created directly and returned with 201.
|
|
596
|
+
*
|
|
597
|
+
* An alias cannot be created from a table that lives in an external bucket or in a development
|
|
598
|
+
* branch. Additionally, the destination bucket itself cannot be an external bucket or a
|
|
599
|
+
* development branch bucket.
|
|
600
|
+
*
|
|
601
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [AliasCreateJobResult](#model-AliasCreateJobResult).
|
|
602
|
+
*
|
|
603
|
+
* Parameters of job will be [AliasCreateJobParams](#components-schemas-AliasCreateJobParams).
|
|
604
|
+
*
|
|
605
|
+
* This endpoint can be used synchronously as well. In that case, the final result is returned directly in the response [CreateTableAliasResponse](#model-CreateTableAliasResponse).
|
|
606
|
+
*/
|
|
607
|
+
post: operations['post_/v2/storage/buckets/{bucketId}/table-aliases::CreateTableAliasAction'];
|
|
608
|
+
delete?: never;
|
|
609
|
+
options?: never;
|
|
610
|
+
head?: never;
|
|
611
|
+
patch?: never;
|
|
612
|
+
trace?: never;
|
|
613
|
+
};
|
|
528
614
|
'/v2/storage/branch/{branchId}/buckets/{id}/tables-async': {
|
|
529
615
|
parameters: {
|
|
530
616
|
query?: never;
|
|
@@ -955,7 +1041,13 @@ type paths = {
|
|
|
955
1041
|
post?: never;
|
|
956
1042
|
/**
|
|
957
1043
|
* Stop Bucket Sharing
|
|
958
|
-
* @description Disables sharing of a bucket.
|
|
1044
|
+
* @description Disables sharing of a bucket.
|
|
1045
|
+
*
|
|
1046
|
+
* While other projects link the bucket, Storage refuses the request with `409 Conflict` and changes nothing: every link stays and the consumer projects observe no interruption. The refusal lists the blocking projects in its `linkedProjects` param.
|
|
1047
|
+
*
|
|
1048
|
+
* Removing those links is a separate act, never a side effect of unsharing - use Drop Bucket in the linking project, or Force Unlink from this one. Reading the bucket stops working in a consumer project the moment its link is gone.
|
|
1049
|
+
*
|
|
1050
|
+
* This operation is available only for organization administrators. Sharing is removed in a background job; to see the job detail use the Job Detail endpoint.
|
|
959
1051
|
*/
|
|
960
1052
|
delete: operations['delete_/v2/storage/branch/{branchId}/buckets/{bucketId}/share::BucketShareDeleteAction'];
|
|
961
1053
|
options?: never;
|
|
@@ -979,7 +1071,13 @@ type paths = {
|
|
|
979
1071
|
post?: never;
|
|
980
1072
|
/**
|
|
981
1073
|
* Stop Bucket Sharing
|
|
982
|
-
* @description Disables sharing of a bucket.
|
|
1074
|
+
* @description Disables sharing of a bucket.
|
|
1075
|
+
*
|
|
1076
|
+
* While other projects link the bucket, Storage refuses the request with `409 Conflict` and changes nothing: every link stays and the consumer projects observe no interruption. The refusal lists the blocking projects in its `linkedProjects` param.
|
|
1077
|
+
*
|
|
1078
|
+
* Removing those links is a separate act, never a side effect of unsharing - use Drop Bucket in the linking project, or Force Unlink from this one. Reading the bucket stops working in a consumer project the moment its link is gone.
|
|
1079
|
+
*
|
|
1080
|
+
* This operation is available only for organization administrators. Sharing is removed in a background job; to see the job detail use the Job Detail endpoint.
|
|
983
1081
|
*/
|
|
984
1082
|
delete: operations['delete_/v2/storage/buckets/{bucketId}/share::BucketShareDeleteAction'];
|
|
985
1083
|
options?: never;
|
|
@@ -1313,6 +1411,162 @@ type paths = {
|
|
|
1313
1411
|
patch?: never;
|
|
1314
1412
|
trace?: never;
|
|
1315
1413
|
};
|
|
1414
|
+
'/v2/storage/branch/{branchId}/components/configs/batch-purge': {
|
|
1415
|
+
parameters: {
|
|
1416
|
+
query?: never;
|
|
1417
|
+
header?: never;
|
|
1418
|
+
path?: never;
|
|
1419
|
+
cookie?: never;
|
|
1420
|
+
};
|
|
1421
|
+
get?: never;
|
|
1422
|
+
put?: never;
|
|
1423
|
+
/**
|
|
1424
|
+
* Purge Deleted Configurations
|
|
1425
|
+
* @description Permanently removes a list of configurations from the trash in one request, including all their versions,
|
|
1426
|
+
* rows and metadata. This cannot be undone. Returns a `componentConfigurationsBatchPurge` job.
|
|
1427
|
+
*
|
|
1428
|
+
* Every item carries the `version` the configuration was read at — the per-item equivalent of the `If-Match`
|
|
1429
|
+
* header of [the single-configuration purge](#tag/Components-and-Configurations). An item whose configuration
|
|
1430
|
+
* has moved on is reported in `failed` with `storage.components.configurations.versionMismatch` and the rest
|
|
1431
|
+
* of the batch still runs. The same holds for every other per-item rule: a configuration that is not in the
|
|
1432
|
+
* trash, one that no longer exists, or one the token may not manage fails alone.
|
|
1433
|
+
*
|
|
1434
|
+
* The job's `results` say per item what happened: `purged` lists the configurations that are gone, `failed`
|
|
1435
|
+
* lists the ones left in the trash with the reason. The job itself ends as `error` when at least one item
|
|
1436
|
+
* failed, so a caller that only polls the status still learns the batch was partial.
|
|
1437
|
+
*
|
|
1438
|
+
* Only available in the **default branch**; development branch configurations cannot be permanently removed,
|
|
1439
|
+
* and in a development branch every item fails with `storage.components.cannotDeleteConfiguration`. Requires
|
|
1440
|
+
* the `canPurgeTrash` token permission.
|
|
1441
|
+
*
|
|
1442
|
+
* The variant without `branch/{branchId}` in the URL behaves the same as the branch endpoint with `branch/default`.
|
|
1443
|
+
*
|
|
1444
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [BatchPurgeJobResult](#model-BatchPurgeJobResult).
|
|
1445
|
+
*
|
|
1446
|
+
* Parameters of job will be [BatchPurgeJobParams](#components-schemas-BatchPurgeJobParams).
|
|
1447
|
+
*/
|
|
1448
|
+
post: operations['post_/v2/storage/branch/{branchId}/components/configs/batch-purge::ConfigurationBatchPurgeAction'];
|
|
1449
|
+
delete?: never;
|
|
1450
|
+
options?: never;
|
|
1451
|
+
head?: never;
|
|
1452
|
+
patch?: never;
|
|
1453
|
+
trace?: never;
|
|
1454
|
+
};
|
|
1455
|
+
'/v2/storage/components/configs/batch-purge': {
|
|
1456
|
+
parameters: {
|
|
1457
|
+
query?: never;
|
|
1458
|
+
header?: never;
|
|
1459
|
+
path?: never;
|
|
1460
|
+
cookie?: never;
|
|
1461
|
+
};
|
|
1462
|
+
get?: never;
|
|
1463
|
+
put?: never;
|
|
1464
|
+
/**
|
|
1465
|
+
* Purge Deleted Configurations
|
|
1466
|
+
* @description Permanently removes a list of configurations from the trash in one request, including all their versions,
|
|
1467
|
+
* rows and metadata. This cannot be undone. Returns a `componentConfigurationsBatchPurge` job.
|
|
1468
|
+
*
|
|
1469
|
+
* Every item carries the `version` the configuration was read at — the per-item equivalent of the `If-Match`
|
|
1470
|
+
* header of [the single-configuration purge](#tag/Components-and-Configurations). An item whose configuration
|
|
1471
|
+
* has moved on is reported in `failed` with `storage.components.configurations.versionMismatch` and the rest
|
|
1472
|
+
* of the batch still runs. The same holds for every other per-item rule: a configuration that is not in the
|
|
1473
|
+
* trash, one that no longer exists, or one the token may not manage fails alone.
|
|
1474
|
+
*
|
|
1475
|
+
* The job's `results` say per item what happened: `purged` lists the configurations that are gone, `failed`
|
|
1476
|
+
* lists the ones left in the trash with the reason. The job itself ends as `error` when at least one item
|
|
1477
|
+
* failed, so a caller that only polls the status still learns the batch was partial.
|
|
1478
|
+
*
|
|
1479
|
+
* Only available in the **default branch**; development branch configurations cannot be permanently removed,
|
|
1480
|
+
* and in a development branch every item fails with `storage.components.cannotDeleteConfiguration`. Requires
|
|
1481
|
+
* the `canPurgeTrash` token permission.
|
|
1482
|
+
*
|
|
1483
|
+
* The variant without `branch/{branchId}` in the URL behaves the same as the branch endpoint with `branch/default`.
|
|
1484
|
+
*
|
|
1485
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [BatchPurgeJobResult](#model-BatchPurgeJobResult).
|
|
1486
|
+
*
|
|
1487
|
+
* Parameters of job will be [BatchPurgeJobParams](#components-schemas-BatchPurgeJobParams).
|
|
1488
|
+
*/
|
|
1489
|
+
post: operations['post_/v2/storage/components/configs/batch-purge::ConfigurationBatchPurgeAction'];
|
|
1490
|
+
delete?: never;
|
|
1491
|
+
options?: never;
|
|
1492
|
+
head?: never;
|
|
1493
|
+
patch?: never;
|
|
1494
|
+
trace?: never;
|
|
1495
|
+
};
|
|
1496
|
+
'/v2/storage/branch/{branchId}/components/configs/batch-restore': {
|
|
1497
|
+
parameters: {
|
|
1498
|
+
query?: never;
|
|
1499
|
+
header?: never;
|
|
1500
|
+
path?: never;
|
|
1501
|
+
cookie?: never;
|
|
1502
|
+
};
|
|
1503
|
+
get?: never;
|
|
1504
|
+
put?: never;
|
|
1505
|
+
/**
|
|
1506
|
+
* Restore Deleted Configurations
|
|
1507
|
+
* @description Moves a list of configurations out of the trash in one request. Returns a
|
|
1508
|
+
* `componentConfigurationsBatchRestore` job.
|
|
1509
|
+
*
|
|
1510
|
+
* Items carry no `version`: restoring is reversible and makes a new version rather than destroying one, so
|
|
1511
|
+
* there is nothing to guard against a concurrent write. Every per-item rule is applied per item — a
|
|
1512
|
+
* configuration that no longer exists, one belonging to an unknown component, or one the token may not
|
|
1513
|
+
* manage fails alone and the rest of the batch still runs.
|
|
1514
|
+
*
|
|
1515
|
+
* The job's `results` say per item what happened: `restored` lists the configurations that are back, each
|
|
1516
|
+
* with the new `version` the restore created, and `failed` lists the ones still in the trash with the
|
|
1517
|
+
* reason. The job itself ends as `error` when at least one item failed, so a caller that only polls the
|
|
1518
|
+
* status still learns the batch was partial.
|
|
1519
|
+
*
|
|
1520
|
+
* The variant without `branch/{branchId}` in the URL behaves the same as the branch endpoint with `branch/default`.
|
|
1521
|
+
*
|
|
1522
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [BatchRestoreJobResult](#model-BatchRestoreJobResult).
|
|
1523
|
+
*
|
|
1524
|
+
* Parameters of job will be [BatchRestoreJobParams](#components-schemas-BatchRestoreJobParams).
|
|
1525
|
+
*/
|
|
1526
|
+
post: operations['post_/v2/storage/branch/{branchId}/components/configs/batch-restore::ConfigurationBatchRestoreAction'];
|
|
1527
|
+
delete?: never;
|
|
1528
|
+
options?: never;
|
|
1529
|
+
head?: never;
|
|
1530
|
+
patch?: never;
|
|
1531
|
+
trace?: never;
|
|
1532
|
+
};
|
|
1533
|
+
'/v2/storage/components/configs/batch-restore': {
|
|
1534
|
+
parameters: {
|
|
1535
|
+
query?: never;
|
|
1536
|
+
header?: never;
|
|
1537
|
+
path?: never;
|
|
1538
|
+
cookie?: never;
|
|
1539
|
+
};
|
|
1540
|
+
get?: never;
|
|
1541
|
+
put?: never;
|
|
1542
|
+
/**
|
|
1543
|
+
* Restore Deleted Configurations
|
|
1544
|
+
* @description Moves a list of configurations out of the trash in one request. Returns a
|
|
1545
|
+
* `componentConfigurationsBatchRestore` job.
|
|
1546
|
+
*
|
|
1547
|
+
* Items carry no `version`: restoring is reversible and makes a new version rather than destroying one, so
|
|
1548
|
+
* there is nothing to guard against a concurrent write. Every per-item rule is applied per item — a
|
|
1549
|
+
* configuration that no longer exists, one belonging to an unknown component, or one the token may not
|
|
1550
|
+
* manage fails alone and the rest of the batch still runs.
|
|
1551
|
+
*
|
|
1552
|
+
* The job's `results` say per item what happened: `restored` lists the configurations that are back, each
|
|
1553
|
+
* with the new `version` the restore created, and `failed` lists the ones still in the trash with the
|
|
1554
|
+
* reason. The job itself ends as `error` when at least one item failed, so a caller that only polls the
|
|
1555
|
+
* status still learns the batch was partial.
|
|
1556
|
+
*
|
|
1557
|
+
* The variant without `branch/{branchId}` in the URL behaves the same as the branch endpoint with `branch/default`.
|
|
1558
|
+
*
|
|
1559
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [BatchRestoreJobResult](#model-BatchRestoreJobResult).
|
|
1560
|
+
*
|
|
1561
|
+
* Parameters of job will be [BatchRestoreJobParams](#components-schemas-BatchRestoreJobParams).
|
|
1562
|
+
*/
|
|
1563
|
+
post: operations['post_/v2/storage/components/configs/batch-restore::ConfigurationBatchRestoreAction'];
|
|
1564
|
+
delete?: never;
|
|
1565
|
+
options?: never;
|
|
1566
|
+
head?: never;
|
|
1567
|
+
patch?: never;
|
|
1568
|
+
trace?: never;
|
|
1569
|
+
};
|
|
1316
1570
|
'/v2/storage/branch/{branchId}/components/{componentId}/configs': {
|
|
1317
1571
|
parameters: {
|
|
1318
1572
|
query?: never;
|
|
@@ -3388,7 +3642,12 @@ type paths = {
|
|
|
3388
3642
|
};
|
|
3389
3643
|
/**
|
|
3390
3644
|
* Search component configurations by metadata
|
|
3391
|
-
* @description Search
|
|
3645
|
+
* @description Search all component configurations accessible by the token by any combination of
|
|
3646
|
+
* `idComponent`, `configurationId` and `metadataKeys`. Available only in branch context.
|
|
3647
|
+
*
|
|
3648
|
+
* By default, each matching configuration is returned with just its `idComponent` and
|
|
3649
|
+
* `configurationId`. Pass `include=filteredMetadata` to also return the metadata entries that
|
|
3650
|
+
* matched the search.
|
|
3392
3651
|
*/
|
|
3393
3652
|
get: operations['get_/v2/storage/branch/{branchId}/search/component-configurations::SearchComponentConfigurationsAction'];
|
|
3394
3653
|
put?: never;
|
|
@@ -3514,7 +3773,9 @@ type paths = {
|
|
|
3514
3773
|
};
|
|
3515
3774
|
/**
|
|
3516
3775
|
* Storage API index
|
|
3517
|
-
* @description Returns information about the stack: services, features and available components.
|
|
3776
|
+
* @description Returns information about the stack: services, features and available components. See the
|
|
3777
|
+
* [Keboola Developers documentation](https://developers.keboola.com/overview/) for more about
|
|
3778
|
+
* the component architecture.
|
|
3518
3779
|
*
|
|
3519
3780
|
* In case the system, or a project is under maintenance, you will receive a `503` response. Maintenance typically applies to a single project, for example due to migration. Be sure to use the `Retry-After` header when accessing the API programatically.
|
|
3520
3781
|
*/
|
|
@@ -4023,6 +4284,60 @@ type paths = {
|
|
|
4023
4284
|
patch?: never;
|
|
4024
4285
|
trace?: never;
|
|
4025
4286
|
};
|
|
4287
|
+
'/v2/storage/branch/{branchId}/tables/{tableId}/import': {
|
|
4288
|
+
parameters: {
|
|
4289
|
+
query?: never;
|
|
4290
|
+
header?: never;
|
|
4291
|
+
path?: never;
|
|
4292
|
+
cookie?: never;
|
|
4293
|
+
};
|
|
4294
|
+
get?: never;
|
|
4295
|
+
put?: never;
|
|
4296
|
+
/**
|
|
4297
|
+
* Import data into a table (synchronous, deprecated)
|
|
4298
|
+
* @description Imports an uploaded CSV file into an existing table and waits for the import to finish.
|
|
4299
|
+
* This endpoint is deprecated; use the asynchronous
|
|
4300
|
+
* `POST /v2/storage/tables/{id}/import-async` endpoint instead.
|
|
4301
|
+
*
|
|
4302
|
+
* The CSV file must have a header row with column names, unless `withoutHeaders` is used.
|
|
4303
|
+
* Every column already present in the table must also be present in the CSV; any CSV column
|
|
4304
|
+
* not yet on the table is created automatically. The file may be compressed - a `.gz`,
|
|
4305
|
+
* `.gzip` or `.zip` extension makes it unpacked before the import.
|
|
4306
|
+
*/
|
|
4307
|
+
post: operations['post_/v2/storage/branch/{branchId}/tables/{tableId}/import::ImportSyncAction'];
|
|
4308
|
+
delete?: never;
|
|
4309
|
+
options?: never;
|
|
4310
|
+
head?: never;
|
|
4311
|
+
patch?: never;
|
|
4312
|
+
trace?: never;
|
|
4313
|
+
};
|
|
4314
|
+
'/v2/storage/tables/{tableId}/import': {
|
|
4315
|
+
parameters: {
|
|
4316
|
+
query?: never;
|
|
4317
|
+
header?: never;
|
|
4318
|
+
path?: never;
|
|
4319
|
+
cookie?: never;
|
|
4320
|
+
};
|
|
4321
|
+
get?: never;
|
|
4322
|
+
put?: never;
|
|
4323
|
+
/**
|
|
4324
|
+
* Import data into a table (synchronous, deprecated)
|
|
4325
|
+
* @description Imports an uploaded CSV file into an existing table and waits for the import to finish.
|
|
4326
|
+
* This endpoint is deprecated; use the asynchronous
|
|
4327
|
+
* `POST /v2/storage/tables/{id}/import-async` endpoint instead.
|
|
4328
|
+
*
|
|
4329
|
+
* The CSV file must have a header row with column names, unless `withoutHeaders` is used.
|
|
4330
|
+
* Every column already present in the table must also be present in the CSV; any CSV column
|
|
4331
|
+
* not yet on the table is created automatically. The file may be compressed - a `.gz`,
|
|
4332
|
+
* `.gzip` or `.zip` extension makes it unpacked before the import.
|
|
4333
|
+
*/
|
|
4334
|
+
post: operations['post_/v2/storage/tables/{tableId}/import::ImportSyncAction'];
|
|
4335
|
+
delete?: never;
|
|
4336
|
+
options?: never;
|
|
4337
|
+
head?: never;
|
|
4338
|
+
patch?: never;
|
|
4339
|
+
trace?: never;
|
|
4340
|
+
};
|
|
4026
4341
|
'/v2/storage/branch/{branchId}/tables/{tableId}/primary-key': {
|
|
4027
4342
|
parameters: {
|
|
4028
4343
|
query?: never;
|
|
@@ -4665,6 +4980,58 @@ type paths = {
|
|
|
4665
4980
|
patch?: never;
|
|
4666
4981
|
trace?: never;
|
|
4667
4982
|
};
|
|
4983
|
+
'/v2/storage/branch/{branchId}/tables/{tableId}': {
|
|
4984
|
+
parameters: {
|
|
4985
|
+
query?: never;
|
|
4986
|
+
header?: never;
|
|
4987
|
+
path?: never;
|
|
4988
|
+
cookie?: never;
|
|
4989
|
+
};
|
|
4990
|
+
get?: never;
|
|
4991
|
+
/**
|
|
4992
|
+
* Update a table
|
|
4993
|
+
* @description Renames a table by setting a new display name. With `async=true` the rename is enqueued as a storage job (202). The synchronous variant is deprecated and returns the updated table directly. Linked copies of the table in other projects are renamed as well.
|
|
4994
|
+
*
|
|
4995
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [TableUpdateJobResult](#model-TableUpdateJobResult).
|
|
4996
|
+
*
|
|
4997
|
+
* Parameters of job will be [TableUpdateJobParams](#components-schemas-TableUpdateJobParams).
|
|
4998
|
+
*
|
|
4999
|
+
* [Deprecated] This endpoint can be used synchronously as well. In that case, the final result is returned directly in the response [TableUpdateResponse](#model-TableUpdateResponse).
|
|
5000
|
+
*/
|
|
5001
|
+
put: operations['put_/v2/storage/branch/{branchId}/tables/{tableId}::TableUpdateAction'];
|
|
5002
|
+
post?: never;
|
|
5003
|
+
delete?: never;
|
|
5004
|
+
options?: never;
|
|
5005
|
+
head?: never;
|
|
5006
|
+
patch?: never;
|
|
5007
|
+
trace?: never;
|
|
5008
|
+
};
|
|
5009
|
+
'/v2/storage/tables/{tableId}': {
|
|
5010
|
+
parameters: {
|
|
5011
|
+
query?: never;
|
|
5012
|
+
header?: never;
|
|
5013
|
+
path?: never;
|
|
5014
|
+
cookie?: never;
|
|
5015
|
+
};
|
|
5016
|
+
get?: never;
|
|
5017
|
+
/**
|
|
5018
|
+
* Update a table
|
|
5019
|
+
* @description Renames a table by setting a new display name. With `async=true` the rename is enqueued as a storage job (202). The synchronous variant is deprecated and returns the updated table directly. Linked copies of the table in other projects are renamed as well.
|
|
5020
|
+
*
|
|
5021
|
+
* Initial response returns job details [JobResponse](#model-JobResponse). The result of the asynchronous job can be fetched via `/v2/storage/jobs/{id}`. When the job completes, final result is [TableUpdateJobResult](#model-TableUpdateJobResult).
|
|
5022
|
+
*
|
|
5023
|
+
* Parameters of job will be [TableUpdateJobParams](#components-schemas-TableUpdateJobParams).
|
|
5024
|
+
*
|
|
5025
|
+
* [Deprecated] This endpoint can be used synchronously as well. In that case, the final result is returned directly in the response [TableUpdateResponse](#model-TableUpdateResponse).
|
|
5026
|
+
*/
|
|
5027
|
+
put: operations['put_/v2/storage/tables/{tableId}::TableUpdateAction'];
|
|
5028
|
+
post?: never;
|
|
5029
|
+
delete?: never;
|
|
5030
|
+
options?: never;
|
|
5031
|
+
head?: never;
|
|
5032
|
+
patch?: never;
|
|
5033
|
+
trace?: never;
|
|
5034
|
+
};
|
|
4668
5035
|
'/v2/storage/tickets': {
|
|
4669
5036
|
parameters: {
|
|
4670
5037
|
query?: never;
|
|
@@ -4749,6 +5116,8 @@ type paths = {
|
|
|
4749
5116
|
* @description Returns all properties of a token, including the project it belongs to (`owner`). You can obtain the token ID, for example, using the Token verification call.
|
|
4750
5117
|
*
|
|
4751
5118
|
* Requesting the token used for authorization is always allowed; requesting any other token requires the `canManageTokens` permission.
|
|
5119
|
+
*
|
|
5120
|
+
* Available both with and without a development branch prefix; the returned token properties and permission rules are the same in either case.
|
|
4752
5121
|
*/
|
|
4753
5122
|
get: operations['get_/v2/storage/tokens/{id}::TokenDetailAction'];
|
|
4754
5123
|
/**
|
|
@@ -4780,6 +5149,8 @@ type paths = {
|
|
|
4780
5149
|
* @description Returns all properties of a token, including the project it belongs to (`owner`). You can obtain the token ID, for example, using the Token verification call.
|
|
4781
5150
|
*
|
|
4782
5151
|
* Requesting the token used for authorization is always allowed; requesting any other token requires the `canManageTokens` permission.
|
|
5152
|
+
*
|
|
5153
|
+
* Available both with and without a development branch prefix; the returned token properties and permission rules are the same in either case.
|
|
4783
5154
|
*/
|
|
4784
5155
|
get: operations['get_/v2/storage/branch/{branchId}/tokens/{id}::TokenDetailAction'];
|
|
4785
5156
|
put?: never;
|
|
@@ -4899,6 +5270,13 @@ type paths = {
|
|
|
4899
5270
|
*
|
|
4900
5271
|
* Token has to be [*master*](https://help.keboola.com/storage/tokens/) (then `runWithTokenId` can be also master). If it isn't master, it has to have `canManageBuckets` permission or `componentAccess` permission for the component which you want to trigger. This also applies when updating and deleting triggers.
|
|
4901
5272
|
* When updating the component of trigger you need permissions for both the current component and the component you're updating the trigger to.
|
|
5273
|
+
*
|
|
5274
|
+
* Without `runWithTokenId`, the trigger creates the token it runs with, in the same request, and owns it:
|
|
5275
|
+
* - The token never expires and is named `[_internal] Token for triggering <configurationId>`.
|
|
5276
|
+
* - In a project with a protected default branch it can only create jobs; elsewhere it can manage buckets and read all file uploads.
|
|
5277
|
+
* - Your token has to be able to create that token.
|
|
5278
|
+
* - If the trigger cannot be created, no token is left behind.
|
|
5279
|
+
* - Deleting the trigger, or giving it another token, revokes the token.
|
|
4902
5280
|
*/
|
|
4903
5281
|
post: operations['post_/v2/storage/triggers::TriggerCreateAction'];
|
|
4904
5282
|
delete?: never;
|
|
@@ -4926,6 +5304,13 @@ type paths = {
|
|
|
4926
5304
|
*
|
|
4927
5305
|
* Token has to be [*master*](https://help.keboola.com/storage/tokens/) (then `runWithTokenId` can be also master). If it isn't master, it has to have `canManageBuckets` permission or `componentAccess` permission for the component which you want to trigger. This also applies when updating and deleting triggers.
|
|
4928
5306
|
* When updating the component of trigger you need permissions for both the current component and the component you're updating the trigger to.
|
|
5307
|
+
*
|
|
5308
|
+
* Without `runWithTokenId`, the trigger creates the token it runs with, in the same request, and owns it:
|
|
5309
|
+
* - The token never expires and is named `[_internal] Token for triggering <configurationId>`.
|
|
5310
|
+
* - In a project with a protected default branch it can only create jobs; elsewhere it can manage buckets and read all file uploads.
|
|
5311
|
+
* - Your token has to be able to create that token.
|
|
5312
|
+
* - If the trigger cannot be created, no token is left behind.
|
|
5313
|
+
* - Deleting the trigger, or giving it another token, revokes the token.
|
|
4929
5314
|
*/
|
|
4930
5315
|
post: operations['post_/v2/storage/triggers/::TriggerCreateAction'];
|
|
4931
5316
|
delete?: never;
|
|
@@ -4951,12 +5336,14 @@ type paths = {
|
|
|
4951
5336
|
* @description Updates an existing trigger. All attributes are optional; only the provided ones are changed.
|
|
4952
5337
|
*
|
|
4953
5338
|
* When updating the component of trigger you need permissions for both the current component and the component you're updating the trigger to.
|
|
5339
|
+
*
|
|
5340
|
+
* Giving a trigger another `runWithTokenId` revokes the token the trigger created for itself, unless another trigger still runs with it.
|
|
4954
5341
|
*/
|
|
4955
5342
|
put: operations['put_/v2/storage/triggers/{triggerId}::TriggerUpdateAction'];
|
|
4956
5343
|
post?: never;
|
|
4957
5344
|
/**
|
|
4958
5345
|
* Delete
|
|
4959
|
-
* @description Deletes an existing trigger.
|
|
5346
|
+
* @description Deletes an existing trigger. The token the trigger created for itself is revoked with it, unless another trigger still runs with it.
|
|
4960
5347
|
*/
|
|
4961
5348
|
delete: operations['delete_/v2/storage/triggers/{triggerId}::TriggerDeleteAction'];
|
|
4962
5349
|
options?: never;
|
|
@@ -4981,12 +5368,14 @@ type paths = {
|
|
|
4981
5368
|
* @description Updates an existing trigger. All attributes are optional; only the provided ones are changed.
|
|
4982
5369
|
*
|
|
4983
5370
|
* When updating the component of trigger you need permissions for both the current component and the component you're updating the trigger to.
|
|
5371
|
+
*
|
|
5372
|
+
* Giving a trigger another `runWithTokenId` revokes the token the trigger created for itself, unless another trigger still runs with it.
|
|
4984
5373
|
*/
|
|
4985
5374
|
put: operations['put_/v2/storage/triggers/{triggerId}/::TriggerUpdateAction'];
|
|
4986
5375
|
post?: never;
|
|
4987
5376
|
/**
|
|
4988
5377
|
* Delete
|
|
4989
|
-
* @description Deletes an existing trigger.
|
|
5378
|
+
* @description Deletes an existing trigger. The token the trigger created for itself is revoked with it, unless another trigger still runs with it.
|
|
4990
5379
|
*/
|
|
4991
5380
|
delete: operations['delete_/v2/storage/triggers/{triggerId}/::TriggerDeleteAction'];
|
|
4992
5381
|
options?: never;
|
|
@@ -5485,6 +5874,10 @@ type paths = {
|
|
|
5485
5874
|
* submitted with `dryRun=false` will not be rejected by validation (modulo source state changing between calls).
|
|
5486
5875
|
* It returns HTTP 200 (not 202) with `loadType` (the type `LoadTypeDecider` would pick) and `possibleLoadTypes`
|
|
5487
5876
|
* (all types acceptable for the item; useful for driving a UI dropdown) per input item.
|
|
5877
|
+
*
|
|
5878
|
+
* This operation is also available scoped to a [Development Branch](#tag/Development-Branches),
|
|
5879
|
+
* at `/branch/{branchId}/workspaces/{workspaceId}/input-mapping-load`. The `dryRun` query
|
|
5880
|
+
* parameter and both response shapes behave identically there.
|
|
5488
5881
|
*/
|
|
5489
5882
|
post: operations['post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/input-mapping-load::WorkspaceInputMappingLoadAction'];
|
|
5490
5883
|
delete?: never;
|
|
@@ -5520,6 +5913,10 @@ type paths = {
|
|
|
5520
5913
|
* submitted with `dryRun=false` will not be rejected by validation (modulo source state changing between calls).
|
|
5521
5914
|
* It returns HTTP 200 (not 202) with `loadType` (the type `LoadTypeDecider` would pick) and `possibleLoadTypes`
|
|
5522
5915
|
* (all types acceptable for the item; useful for driving a UI dropdown) per input item.
|
|
5916
|
+
*
|
|
5917
|
+
* This operation is also available scoped to a [Development Branch](#tag/Development-Branches),
|
|
5918
|
+
* at `/branch/{branchId}/workspaces/{workspaceId}/input-mapping-load`. The `dryRun` query
|
|
5919
|
+
* parameter and both response shapes behave identically there.
|
|
5523
5920
|
*/
|
|
5524
5921
|
post: operations['post_/v2/storage/workspaces/{workspaceId}/input-mapping-load::WorkspaceInputMappingLoadAction'];
|
|
5525
5922
|
delete?: never;
|
|
@@ -5686,6 +6083,7 @@ type paths = {
|
|
|
5686
6083
|
* with `loginType=none` do not contain direct connection credentials; create them with this endpoint when a client needs
|
|
5687
6084
|
* to connect directly. Snowflake credentials use key-pair authentication (the private key is returned in
|
|
5688
6085
|
* `connection.privateKey`), BigQuery credentials return a service account key in `connection.credentials`.
|
|
6086
|
+
* The credentials hold the same direct grants as the workspace itself, resolved from the workspace's configuration.
|
|
5689
6087
|
*/
|
|
5690
6088
|
post: operations['post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/credentials::WorkspaceStorageCredentialsCreateAction'];
|
|
5691
6089
|
delete?: never;
|
|
@@ -5709,6 +6107,7 @@ type paths = {
|
|
|
5709
6107
|
* with `loginType=none` do not contain direct connection credentials; create them with this endpoint when a client needs
|
|
5710
6108
|
* to connect directly. Snowflake credentials use key-pair authentication (the private key is returned in
|
|
5711
6109
|
* `connection.privateKey`), BigQuery credentials return a service account key in `connection.credentials`.
|
|
6110
|
+
* The credentials hold the same direct grants as the workspace itself, resolved from the workspace's configuration.
|
|
5712
6111
|
*/
|
|
5713
6112
|
post: operations['post_/v2/storage/workspaces/{workspaceId}/credentials::WorkspaceStorageCredentialsCreateAction'];
|
|
5714
6113
|
delete?: never;
|
|
@@ -5735,7 +6134,8 @@ type paths = {
|
|
|
5735
6134
|
/**
|
|
5736
6135
|
* Delete credential
|
|
5737
6136
|
* @description Delete the specified workspace credential from both the database and the backend (BigQuery or Snowflake).
|
|
5738
|
-
* The backend user will be invalidated.
|
|
6137
|
+
* The backend user will be invalidated, and on BigQuery its table-level direct grants are stripped first.
|
|
6138
|
+
* Retry the call when it reports a concurrent action on the workspace.
|
|
5739
6139
|
*/
|
|
5740
6140
|
delete: operations['delete_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/credentials/{id}::WorkspaceStorageCredentialsDeleteAction'];
|
|
5741
6141
|
options?: never;
|
|
@@ -5761,7 +6161,8 @@ type paths = {
|
|
|
5761
6161
|
/**
|
|
5762
6162
|
* Delete credential
|
|
5763
6163
|
* @description Delete the specified workspace credential from both the database and the backend (BigQuery or Snowflake).
|
|
5764
|
-
* The backend user will be invalidated.
|
|
6164
|
+
* The backend user will be invalidated, and on BigQuery its table-level direct grants are stripped first.
|
|
6165
|
+
* Retry the call when it reports a concurrent action on the workspace.
|
|
5765
6166
|
*/
|
|
5766
6167
|
delete: operations['delete_/v2/storage/workspaces/{workspaceId}/credentials/{id}::WorkspaceStorageCredentialsDeleteAction'];
|
|
5767
6168
|
options?: never;
|
|
@@ -5832,7 +6233,11 @@ type paths = {
|
|
|
5832
6233
|
put?: never;
|
|
5833
6234
|
/**
|
|
5834
6235
|
* Unload workspace
|
|
5835
|
-
* @description
|
|
6236
|
+
* @description Validates the workspace's component configuration (transformation, data app, or SQL workspace) and
|
|
6237
|
+
* examines its output mapping for tables using the direct-grant strategy, then enqueues a refresh job
|
|
6238
|
+
* for them.
|
|
6239
|
+
*
|
|
6240
|
+
* Returns an array of jobs instead of a single job.
|
|
5836
6241
|
*/
|
|
5837
6242
|
post: operations['post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/unload::WorkspaceUnloadAction'];
|
|
5838
6243
|
delete?: never;
|
|
@@ -5945,13 +6350,31 @@ type components = {
|
|
|
5945
6350
|
*/
|
|
5946
6351
|
isSnowflakeSharedDatabase?: boolean | null;
|
|
5947
6352
|
};
|
|
6353
|
+
/**
|
|
6354
|
+
* @description The name of a bucket or a table.
|
|
6355
|
+
*
|
|
6356
|
+
* - Allowed characters: `A-Z`, `a-z`, `0-9`, dash `-` and underscore `_`. Anything else — a
|
|
6357
|
+
* space, a dot, an accented letter — is rejected, not transliterated.
|
|
6358
|
+
* - 1 to 96 characters.
|
|
6359
|
+
* - Cannot start with an underscore. A dash or a digit as the first character is fine.
|
|
6360
|
+
* - Registered (external) buckets follow this same rule, dashes included.
|
|
6361
|
+
* - Uniqueness is case-insensitive within a stage: creating `MyBucket` next to `mybucket`
|
|
6362
|
+
* fails with `storage.buckets.alreadyExists`, and for tables with
|
|
6363
|
+
* `storage.buckets.tableAlreadyExists` or `storage.validation.tableAlreadyExists`.
|
|
6364
|
+
* - To turn arbitrary user input into a name that satisfies this rule, call
|
|
6365
|
+
* `POST /v2/storage/webalize/display-name` instead of reimplementing the transformation. It
|
|
6366
|
+
* unaccents the input, replaces every run of disallowed characters with a single `-`, trims
|
|
6367
|
+
* `-` from both ends, strips leading underscores, and truncates to 96 characters.
|
|
6368
|
+
* @example my-bucket
|
|
6369
|
+
*/
|
|
6370
|
+
StorageName: string;
|
|
5948
6371
|
/** @description Creates a new bucket in the project. */
|
|
5949
6372
|
CreateBucketRequest: {
|
|
5950
6373
|
/**
|
|
5951
|
-
* @description
|
|
6374
|
+
* @description Name of the new bucket.
|
|
5952
6375
|
* @example my-new-bucket
|
|
5953
6376
|
*/
|
|
5954
|
-
name: string;
|
|
6377
|
+
name: string & components['schemas']['StorageName'];
|
|
5955
6378
|
/**
|
|
5956
6379
|
* @description Assigns the bucket to one of the stages.
|
|
5957
6380
|
* @default in
|
|
@@ -5972,10 +6395,10 @@ type components = {
|
|
|
5972
6395
|
*/
|
|
5973
6396
|
backend: 'snowflake' | 'bigquery';
|
|
5974
6397
|
/**
|
|
5975
|
-
* @description
|
|
6398
|
+
* @description Display name shown in the UI; can be changed anytime. Defaults to `name`.
|
|
5976
6399
|
* @example my-new-bucket
|
|
5977
6400
|
*/
|
|
5978
|
-
displayName: string;
|
|
6401
|
+
displayName: string & components['schemas']['StorageName'];
|
|
5979
6402
|
/**
|
|
5980
6403
|
* @description Bucket color. Accepts valid CSS color values (max 20 characters).
|
|
5981
6404
|
* @example #FF5733
|
|
@@ -5985,15 +6408,15 @@ type components = {
|
|
|
5985
6408
|
/** @description Links a shared bucket from another project. Recognized by the presence of `sourceProjectId`. */
|
|
5986
6409
|
LinkBucketRequest: {
|
|
5987
6410
|
/**
|
|
5988
|
-
* @description
|
|
6411
|
+
* @description Name of the linked bucket in this project.
|
|
5989
6412
|
* @example organizationData
|
|
5990
6413
|
*/
|
|
5991
|
-
name: string;
|
|
6414
|
+
name: string & components['schemas']['StorageName'];
|
|
5992
6415
|
/**
|
|
5993
|
-
* @description
|
|
6416
|
+
* @description Display name shown in the UI. Defaults to `name`.
|
|
5994
6417
|
* @example organizationData
|
|
5995
6418
|
*/
|
|
5996
|
-
displayName: string;
|
|
6419
|
+
displayName: string & components['schemas']['StorageName'];
|
|
5997
6420
|
/**
|
|
5998
6421
|
* @description ID of the source project from which the bucket is being shared.
|
|
5999
6422
|
* @example 123
|
|
@@ -6012,7 +6435,7 @@ type components = {
|
|
|
6012
6435
|
*/
|
|
6013
6436
|
stage: 'in' | 'out' | 'sys';
|
|
6014
6437
|
};
|
|
6015
|
-
|
|
6438
|
+
BackendConfiguration: {
|
|
6016
6439
|
context?: string | null;
|
|
6017
6440
|
};
|
|
6018
6441
|
CreateMetadataWithProviderRequest: {
|
|
@@ -6046,6 +6469,8 @@ type components = {
|
|
|
6046
6469
|
subscribers?: string[];
|
|
6047
6470
|
};
|
|
6048
6471
|
};
|
|
6472
|
+
/** @description The bucketUpdate job produces no results - the value is always null. */
|
|
6473
|
+
BucketUpdateJobResult: Record<string, never> | null;
|
|
6049
6474
|
BucketListingCreateJobResult: {
|
|
6050
6475
|
/** @description Identifier of the bucket the listing was created on. */
|
|
6051
6476
|
idBucket: number;
|
|
@@ -6166,6 +6591,157 @@ type components = {
|
|
|
6166
6591
|
exceptionId?: string | null;
|
|
6167
6592
|
} | null;
|
|
6168
6593
|
};
|
|
6594
|
+
/** @description Single metadata record. */
|
|
6595
|
+
MetadataItemResponse: {
|
|
6596
|
+
/**
|
|
6597
|
+
* @description Metadata record identifier
|
|
6598
|
+
* @example 19509
|
|
6599
|
+
*/
|
|
6600
|
+
id: string;
|
|
6601
|
+
/**
|
|
6602
|
+
* @description Metadata key
|
|
6603
|
+
* @example some-key
|
|
6604
|
+
*/
|
|
6605
|
+
key: string;
|
|
6606
|
+
/**
|
|
6607
|
+
* @description Metadata value
|
|
6608
|
+
* @example Some value
|
|
6609
|
+
*/
|
|
6610
|
+
value: string | null;
|
|
6611
|
+
/**
|
|
6612
|
+
* @description Id of the component that created the metadata
|
|
6613
|
+
* @example test-component
|
|
6614
|
+
*/
|
|
6615
|
+
provider: string;
|
|
6616
|
+
/**
|
|
6617
|
+
* Format: date-time
|
|
6618
|
+
* @description When the metadata was created or last updated
|
|
6619
|
+
* @example 2017-02-13T23:36:10+0100
|
|
6620
|
+
*/
|
|
6621
|
+
timestamp: string;
|
|
6622
|
+
};
|
|
6623
|
+
/** @description Shared bucket as seen from another project (also used as `sourceBucket` of a linked bucket). */
|
|
6624
|
+
SharedBucketResponse: {
|
|
6625
|
+
/**
|
|
6626
|
+
* @description Bucket identifier in the source project.
|
|
6627
|
+
* @example in.c-main
|
|
6628
|
+
*/
|
|
6629
|
+
id: string;
|
|
6630
|
+
/**
|
|
6631
|
+
* @description Bucket name.
|
|
6632
|
+
* @example c-main
|
|
6633
|
+
*/
|
|
6634
|
+
name: string;
|
|
6635
|
+
/**
|
|
6636
|
+
* @description Bucket display name.
|
|
6637
|
+
* @example main
|
|
6638
|
+
*/
|
|
6639
|
+
displayName: string;
|
|
6640
|
+
/**
|
|
6641
|
+
* @description Bucket stage.
|
|
6642
|
+
* @example in
|
|
6643
|
+
* @enum {string}
|
|
6644
|
+
*/
|
|
6645
|
+
stage: 'in' | 'out' | 'sys';
|
|
6646
|
+
/**
|
|
6647
|
+
* @description Bucket description.
|
|
6648
|
+
* @example Organization shared data
|
|
6649
|
+
*/
|
|
6650
|
+
description: string;
|
|
6651
|
+
/**
|
|
6652
|
+
* @description Sharing type.
|
|
6653
|
+
* @example organization-project
|
|
6654
|
+
* @enum {string|null}
|
|
6655
|
+
*/
|
|
6656
|
+
sharing?: 'organization' | 'organization-project' | 'specific-projects' | 'specific-users' | null;
|
|
6657
|
+
/**
|
|
6658
|
+
* Format: date-time
|
|
6659
|
+
* @example 2020-01-12T18:28:31+0100
|
|
6660
|
+
*/
|
|
6661
|
+
created: string;
|
|
6662
|
+
/**
|
|
6663
|
+
* Format: date-time
|
|
6664
|
+
* @example 2020-01-12T18:31:49+0100
|
|
6665
|
+
*/
|
|
6666
|
+
lastChangeDate?: string | null;
|
|
6667
|
+
/** @example 1536 */
|
|
6668
|
+
dataSizeBytes: number;
|
|
6669
|
+
/** @example 32 */
|
|
6670
|
+
rowsCount: number;
|
|
6671
|
+
/**
|
|
6672
|
+
* @example snowflake
|
|
6673
|
+
* @enum {string}
|
|
6674
|
+
*/
|
|
6675
|
+
backend: 'snowflake' | 'bigquery';
|
|
6676
|
+
/**
|
|
6677
|
+
* @description Whether the bucket is an external (registered) bucket.
|
|
6678
|
+
* @example false
|
|
6679
|
+
*/
|
|
6680
|
+
hasExternalSchema: boolean;
|
|
6681
|
+
/**
|
|
6682
|
+
* @description Database name of an external bucket.
|
|
6683
|
+
* @example null
|
|
6684
|
+
*/
|
|
6685
|
+
databaseName?: string | null;
|
|
6686
|
+
/**
|
|
6687
|
+
* @description Dot-separated path of the bucket on the backend.
|
|
6688
|
+
* @example database_name.c-main
|
|
6689
|
+
*/
|
|
6690
|
+
path: string;
|
|
6691
|
+
/** @description Project owning the bucket. */
|
|
6692
|
+
project: {
|
|
6693
|
+
/** @example 123 */
|
|
6694
|
+
id?: number;
|
|
6695
|
+
/** @example Project name */
|
|
6696
|
+
name?: string;
|
|
6697
|
+
};
|
|
6698
|
+
/** @example null */
|
|
6699
|
+
color?: string | null;
|
|
6700
|
+
/** @description Tables in the shared bucket (filtered aliases are omitted). */
|
|
6701
|
+
tables: {
|
|
6702
|
+
/** @example in.c-main.languages */
|
|
6703
|
+
id?: string;
|
|
6704
|
+
/** @example languages */
|
|
6705
|
+
name?: string;
|
|
6706
|
+
/** @example languages-display-name */
|
|
6707
|
+
displayName?: string;
|
|
6708
|
+
/**
|
|
6709
|
+
* @description Dot-separated path of the table on the backend.
|
|
6710
|
+
* @example database_name.c-main.languages
|
|
6711
|
+
*/
|
|
6712
|
+
path?: string;
|
|
6713
|
+
}[];
|
|
6714
|
+
/**
|
|
6715
|
+
* @description Sharing parameters.
|
|
6716
|
+
* @example []
|
|
6717
|
+
*/
|
|
6718
|
+
sharingParameters: {
|
|
6719
|
+
[key: string]: Record<string, never>;
|
|
6720
|
+
};
|
|
6721
|
+
/** @description Token that shared the bucket. */
|
|
6722
|
+
sharedBy: {
|
|
6723
|
+
/** @example 5 */
|
|
6724
|
+
id?: number | null;
|
|
6725
|
+
/** @example dev@keboola.com */
|
|
6726
|
+
name?: string | null;
|
|
6727
|
+
/**
|
|
6728
|
+
* Format: date-time
|
|
6729
|
+
* @example 2020-02-03T14:58:29+0100
|
|
6730
|
+
*/
|
|
6731
|
+
date?: string | null;
|
|
6732
|
+
};
|
|
6733
|
+
/** @description Bucket owner; `null` when no owner is set. */
|
|
6734
|
+
owner?: {
|
|
6735
|
+
/** @example 123 */
|
|
6736
|
+
id?: number;
|
|
6737
|
+
/** @example Jan Developer */
|
|
6738
|
+
name?: string;
|
|
6739
|
+
/** @example jan.dev@keboola.com */
|
|
6740
|
+
email?: string;
|
|
6741
|
+
} | null;
|
|
6742
|
+
/** @description Bucket metadata. Present only when `include` contains `metadata`. */
|
|
6743
|
+
metadata: components['schemas']['MetadataItemResponse'][];
|
|
6744
|
+
};
|
|
6169
6745
|
RefreshJobResponse: {
|
|
6170
6746
|
uri: string;
|
|
6171
6747
|
id: string;
|
|
@@ -6189,20 +6765,94 @@ type components = {
|
|
|
6189
6765
|
path: string;
|
|
6190
6766
|
isSnowflakeSharedDatabase: boolean;
|
|
6191
6767
|
color?: string | null;
|
|
6192
|
-
|
|
6768
|
+
/** @description Sharing parameters. Present only when the bucket is shared; empty object when the sharing type is `organization`. */
|
|
6769
|
+
sharingParameters?: {
|
|
6770
|
+
/** @description Present only when the sharing type is `specific-projects`. */
|
|
6771
|
+
projects?: {
|
|
6772
|
+
id?: number;
|
|
6773
|
+
name?: string;
|
|
6774
|
+
}[];
|
|
6775
|
+
/** @description Present only when the sharing type is `specific-users`. */
|
|
6776
|
+
users?: {
|
|
6777
|
+
id?: number;
|
|
6778
|
+
name?: string;
|
|
6779
|
+
email?: string;
|
|
6780
|
+
}[];
|
|
6781
|
+
} | null;
|
|
6193
6782
|
sharedBy?: {
|
|
6194
6783
|
id?: number | null;
|
|
6195
6784
|
name?: string | null;
|
|
6196
6785
|
date?: string | null;
|
|
6197
6786
|
} | null;
|
|
6198
|
-
owner
|
|
6199
|
-
|
|
6787
|
+
/** @description Bucket owner; `null` when no owner is set. */
|
|
6788
|
+
owner?: {
|
|
6789
|
+
id?: number;
|
|
6790
|
+
name?: string;
|
|
6791
|
+
email?: string;
|
|
6792
|
+
} | null;
|
|
6793
|
+
/** @description Source bucket of a linked bucket. Present only for linked buckets. */
|
|
6794
|
+
sourceBucket?: components['schemas']['SharedBucketResponse'] | null;
|
|
6200
6795
|
/** @description List of warnings related to the refresh operation. */
|
|
6201
6796
|
warnings: {
|
|
6202
6797
|
message?: string;
|
|
6203
6798
|
context?: string | null;
|
|
6204
6799
|
}[];
|
|
6205
6800
|
};
|
|
6801
|
+
/** @description Per-item outcome of a `componentConfigurationsBatchPurge` job. Present on both a successful job and a failed one — a failed job is one where at least one item is in `failed`, and the items in `purged` are permanently gone. */
|
|
6802
|
+
BatchPurgeJobResult: {
|
|
6803
|
+
/** @description Configurations that were permanently removed. This cannot be undone. */
|
|
6804
|
+
purged: {
|
|
6805
|
+
/** @example keboola.ex-db-mysql */
|
|
6806
|
+
componentId?: string;
|
|
6807
|
+
/** @example main-1 */
|
|
6808
|
+
configurationId?: string;
|
|
6809
|
+
}[];
|
|
6810
|
+
/** @description Configurations that were not purged, each with the reason. The one exception is `storage.components.configurations.batchPurgeItemFailed`, which says the purge did not finish and the configuration may or may not be gone — re-read the trash to find out. */
|
|
6811
|
+
failed: {
|
|
6812
|
+
/** @example keboola.ex-db-mysql */
|
|
6813
|
+
componentId?: string;
|
|
6814
|
+
/** @example main-2 */
|
|
6815
|
+
configurationId?: string;
|
|
6816
|
+
error?: {
|
|
6817
|
+
/**
|
|
6818
|
+
* @description The string code the single-configuration purge would have returned, e.g. `storage.components.configurations.versionMismatch` when the item's `version` no longer matches. `storage.components.configurations.batchPurgeItemFailed` is the batch's own code for an item that failed outside the purge itself.
|
|
6819
|
+
* @example storage.components.configurations.versionMismatch
|
|
6820
|
+
*/
|
|
6821
|
+
code?: string;
|
|
6822
|
+
message?: string;
|
|
6823
|
+
};
|
|
6824
|
+
}[];
|
|
6825
|
+
};
|
|
6826
|
+
/** @description Per-item outcome of a `componentConfigurationsBatchRestore` job. Present on both a successful job and a failed one — a failed job is one where at least one item is in `failed`. */
|
|
6827
|
+
BatchRestoreJobResult: {
|
|
6828
|
+
/** @description Configurations that are live again. */
|
|
6829
|
+
restored: {
|
|
6830
|
+
/** @example keboola.ex-db-mysql */
|
|
6831
|
+
componentId?: string;
|
|
6832
|
+
/** @example main-1 */
|
|
6833
|
+
configurationId?: string;
|
|
6834
|
+
/**
|
|
6835
|
+
* @description Version the restore made. Restoring is a change, so this is one higher than the version the configuration had in the trash.
|
|
6836
|
+
* @example 5
|
|
6837
|
+
*/
|
|
6838
|
+
version?: number;
|
|
6839
|
+
}[];
|
|
6840
|
+
/** @description Configurations that were not restored, each with the reason. The one exception is `storage.components.configurations.batchRestoreItemFailed`, which says the restore did not finish and the configuration may or may not be back — re-read the trash to find out. */
|
|
6841
|
+
failed: {
|
|
6842
|
+
/** @example keboola.ex-db-mysql */
|
|
6843
|
+
componentId?: string;
|
|
6844
|
+
/** @example main-2 */
|
|
6845
|
+
configurationId?: string;
|
|
6846
|
+
error?: {
|
|
6847
|
+
/**
|
|
6848
|
+
* @description The string code the single-configuration restore would have returned, e.g. `storage.configuration.notFound`. `storage.components.configurations.batchRestoreItemFailed` is the batch's own code for an item that failed outside the restore itself.
|
|
6849
|
+
* @example storage.configuration.notFound
|
|
6850
|
+
*/
|
|
6851
|
+
code?: string;
|
|
6852
|
+
message?: string;
|
|
6853
|
+
};
|
|
6854
|
+
}[];
|
|
6855
|
+
};
|
|
6206
6856
|
/** @description The fileDelete job produces no results - the value is always null. */
|
|
6207
6857
|
FileDeleteJobResult: Record<string, never> | null;
|
|
6208
6858
|
TableSnapshotCreateJobResult: {
|
|
@@ -6261,6 +6911,18 @@ type components = {
|
|
|
6261
6911
|
/** @description Whether the source table is itself an alias */
|
|
6262
6912
|
isAlias: boolean;
|
|
6263
6913
|
};
|
|
6914
|
+
/** @description Row filter of a filtered simple alias, as returned by Model_Row_MetadataTable::getAliasFilter(). */
|
|
6915
|
+
AliasFilterResponse: {
|
|
6916
|
+
/** @description Filtered column name. */
|
|
6917
|
+
column: string | null;
|
|
6918
|
+
/**
|
|
6919
|
+
* @description Filter operator: `eq` (can be used with multiple values) or `ne`.
|
|
6920
|
+
* @enum {string|null}
|
|
6921
|
+
*/
|
|
6922
|
+
operator: 'eq' | 'ne' | null;
|
|
6923
|
+
/** @description Values compared against the filtered column. */
|
|
6924
|
+
values: string[] | null;
|
|
6925
|
+
};
|
|
6264
6926
|
TableCreateResponse: {
|
|
6265
6927
|
/** @description Table API URI */
|
|
6266
6928
|
uri: string;
|
|
@@ -6320,10 +6982,12 @@ type components = {
|
|
|
6320
6982
|
/** @description Alias columns auto sync (for simple aliases) */
|
|
6321
6983
|
aliasColumnsAutoSync?: boolean | null;
|
|
6322
6984
|
/** @description Alias filter (for filtered aliases) */
|
|
6323
|
-
aliasFilter?:
|
|
6985
|
+
aliasFilter?: components['schemas']['AliasFilterResponse'] | null;
|
|
6324
6986
|
/** @description Custom SQL for alias (for custom SQL aliases) */
|
|
6325
6987
|
selectSql?: string | null;
|
|
6326
6988
|
};
|
|
6989
|
+
/** @description The tableUpdate job produces no results - the value is always null. */
|
|
6990
|
+
TableUpdateJobResult: Record<string, never> | null;
|
|
6327
6991
|
/** @description The tableColumnAdd job produces no results - the value is always null. */
|
|
6328
6992
|
ColumnCreateJobResult: Record<string, never> | null;
|
|
6329
6993
|
/** @description The tableColumnDelete job produces no results - the value is always null. */
|
|
@@ -6401,7 +7065,7 @@ type components = {
|
|
|
6401
7065
|
endTime?: string | null;
|
|
6402
7066
|
/** @description Run ID for the job. */
|
|
6403
7067
|
runId: string;
|
|
6404
|
-
results?: components['schemas']['BucketForceUnlinkJobResult'] | components['schemas']['BucketListingUpdateJobResponse'] | components['schemas']['BucketListingCreateJobResult'] | components['schemas']['BucketListingDeleteResponse'] | components['schemas']['BucketDeleteResponse'] | components['schemas']['RefreshJobResponse'] | components['schemas']['FileDeleteJobResult'] | components['schemas']['TableSnapshotCreateJobResult'] | components['schemas']['TableDeleteJobResult'] | components['schemas']['DeleteRowsJobResult'] | components['schemas']['TableExportAsyncJobResponse'] | components['schemas']['PrimaryKeyCreateJobResult'] | components['schemas']['PrimaryKeyDeleteJobResult'] | components['schemas']['TableSwapResult'] | components['schemas']['TableCreateResponse'] | components['schemas']['ColumnCreateJobResult'] | components['schemas']['ColumnDeleteJobResult'] | components['schemas']['TableExportJobResponse'];
|
|
7068
|
+
results?: components['schemas']['BucketForceUnlinkJobResult'] | components['schemas']['BucketListingUpdateJobResponse'] | components['schemas']['BucketUpdateJobResult'] | components['schemas']['BucketListingCreateJobResult'] | components['schemas']['BucketListingDeleteResponse'] | components['schemas']['BucketDeleteResponse'] | components['schemas']['RefreshJobResponse'] | components['schemas']['BatchPurgeJobResult'] | components['schemas']['BatchRestoreJobResult'] | components['schemas']['FileDeleteJobResult'] | components['schemas']['TableSnapshotCreateJobResult'] | components['schemas']['TableDeleteJobResult'] | components['schemas']['DeleteRowsJobResult'] | components['schemas']['TableExportAsyncJobResponse'] | components['schemas']['PrimaryKeyCreateJobResult'] | components['schemas']['PrimaryKeyDeleteJobResult'] | components['schemas']['TableSwapResult'] | components['schemas']['TableCreateResponse'] | components['schemas']['TableUpdateJobResult'] | components['schemas']['ColumnCreateJobResult'] | components['schemas']['ColumnDeleteJobResult'] | components['schemas']['TableExportJobResponse'];
|
|
6405
7069
|
/** @description Creator token info. */
|
|
6406
7070
|
creatorToken: {
|
|
6407
7071
|
/** @description Access token ID. */
|
|
@@ -6447,8 +7111,9 @@ type components = {
|
|
|
6447
7111
|
force: boolean;
|
|
6448
7112
|
/** @default null */
|
|
6449
7113
|
backendConfiguration: components['schemas']['BackendConfigurationJobParams'] | null;
|
|
6450
|
-
|
|
6451
|
-
|
|
7114
|
+
};
|
|
7115
|
+
BackendConfigurationRequest: {
|
|
7116
|
+
context?: string | null;
|
|
6452
7117
|
};
|
|
6453
7118
|
BucketDetailRequest: {
|
|
6454
7119
|
/**
|
|
@@ -6489,8 +7154,6 @@ type components = {
|
|
|
6489
7154
|
BucketForceUnlinkJobParams: {
|
|
6490
7155
|
linkedIdProject: number;
|
|
6491
7156
|
linkedIdBucket: number;
|
|
6492
|
-
jobParams: unknown[];
|
|
6493
|
-
jobOperationParams: unknown[];
|
|
6494
7157
|
};
|
|
6495
7158
|
BucketGetTablesRequest: {
|
|
6496
7159
|
/** @description Comma-separated list of data to include. Allowed values: attributes, buckets, bucketsWithoutSourceTables, columns, metadata, columnMetadata, sourceMetadata, sourceColumnMetadata. */
|
|
@@ -6510,11 +7173,700 @@ type components = {
|
|
|
6510
7173
|
*/
|
|
6511
7174
|
email?: string | null;
|
|
6512
7175
|
};
|
|
7176
|
+
/** @description Bucket properties to update, as stored in the job operation params. */
|
|
7177
|
+
BucketUpdateJobParamsValues: {
|
|
7178
|
+
/** @description New display name; null when not changed. */
|
|
7179
|
+
displayName: string | null;
|
|
7180
|
+
/** @description New CSS color code; null when not changed or when `deleteColor` is true. */
|
|
7181
|
+
color: string | null;
|
|
7182
|
+
/** @description Whether the color should be removed (an explicit `null` color was sent). */
|
|
7183
|
+
deleteColor: boolean;
|
|
7184
|
+
};
|
|
7185
|
+
BucketUpdateJobParams: {
|
|
7186
|
+
values: components['schemas']['BucketUpdateJobParamsValues'];
|
|
7187
|
+
/** @default null */
|
|
7188
|
+
idBucket: number | null;
|
|
7189
|
+
};
|
|
7190
|
+
/** @description The bucket as it looks after the synchronous update. */
|
|
7191
|
+
BucketUpdateResponse: {
|
|
7192
|
+
/** @description URI of the bucket */
|
|
7193
|
+
uri: string;
|
|
7194
|
+
/** @description Unique identifier of the bucket */
|
|
7195
|
+
id: string;
|
|
7196
|
+
/** @description Name of the bucket */
|
|
7197
|
+
name: string;
|
|
7198
|
+
/** @description Human-readable display name of the bucket */
|
|
7199
|
+
displayName: string;
|
|
7200
|
+
/** @description ID of the branch the bucket belongs to */
|
|
7201
|
+
idBranch: number;
|
|
7202
|
+
/** @description Stage of the bucket (in, out, or sys) */
|
|
7203
|
+
stage: string;
|
|
7204
|
+
/** @description Description of the bucket */
|
|
7205
|
+
description: string;
|
|
7206
|
+
/** @description URI to access bucket tables */
|
|
7207
|
+
tables: string;
|
|
7208
|
+
/**
|
|
7209
|
+
* Format: date-time
|
|
7210
|
+
* @description Creation timestamp
|
|
7211
|
+
*/
|
|
7212
|
+
created: string;
|
|
7213
|
+
/**
|
|
7214
|
+
* Format: date-time
|
|
7215
|
+
* @description Last modification timestamp
|
|
7216
|
+
*/
|
|
7217
|
+
lastChangeDate?: string | null;
|
|
7218
|
+
/**
|
|
7219
|
+
* Format: date-time
|
|
7220
|
+
* @description Last update timestamp
|
|
7221
|
+
*/
|
|
7222
|
+
updated?: string | null;
|
|
7223
|
+
/** @description Whether the bucket is read-only */
|
|
7224
|
+
isReadOnly: boolean;
|
|
7225
|
+
/** @description Total data size in bytes */
|
|
7226
|
+
dataSizeBytes?: number | null;
|
|
7227
|
+
/** @description Total number of rows */
|
|
7228
|
+
rowsCount?: number | null;
|
|
7229
|
+
/** @description Whether the bucket is in maintenance mode */
|
|
7230
|
+
isMaintenance: boolean;
|
|
7231
|
+
/** @description Storage backend used by the bucket */
|
|
7232
|
+
backend: string;
|
|
7233
|
+
/** @description Sharing configuration */
|
|
7234
|
+
sharing?: string | null;
|
|
7235
|
+
/** @description Whether the bucket has an external schema */
|
|
7236
|
+
hasExternalSchema: boolean;
|
|
7237
|
+
/** @description Database name */
|
|
7238
|
+
databaseName?: string | null;
|
|
7239
|
+
/** @description Full path to the bucket */
|
|
7240
|
+
path: string;
|
|
7241
|
+
/** @description Whether it is a Snowflake shared database */
|
|
7242
|
+
isSnowflakeSharedDatabase: boolean;
|
|
7243
|
+
/** @description Whether this bucket is linked from another project */
|
|
7244
|
+
isLinkedBucket: boolean;
|
|
7245
|
+
/** @description CSS color code of the bucket */
|
|
7246
|
+
color?: string | null;
|
|
7247
|
+
/** @description Whether the bucket may be shared */
|
|
7248
|
+
bucketSharingAllowed: boolean;
|
|
7249
|
+
/** @description Bucket owner; `null` when no owner is set. */
|
|
7250
|
+
owner?: {
|
|
7251
|
+
id?: number;
|
|
7252
|
+
name?: string;
|
|
7253
|
+
email?: string;
|
|
7254
|
+
} | null;
|
|
7255
|
+
/** @description Backend path components */
|
|
7256
|
+
backendPath: string[];
|
|
7257
|
+
};
|
|
7258
|
+
UpdateBucketRequest: {
|
|
7259
|
+
/** @description New human-readable display name. */
|
|
7260
|
+
displayName: string & components['schemas']['StorageName'];
|
|
7261
|
+
/** @description New CSS color code of the bucket (e.g. `#FF5733`, `red`, `rgb(255, 0, 0)`). Pass null to remove the color. */
|
|
7262
|
+
color?: string | null;
|
|
7263
|
+
};
|
|
6513
7264
|
ListBucketsRequest: Record<string, never>;
|
|
6514
|
-
|
|
6515
|
-
|
|
6516
|
-
|
|
7265
|
+
/** @description Detail of the created alias table, including a flat list of its column names. */
|
|
7266
|
+
AliasCreateJobResult: components['schemas']['TableCreateResponse'] & {
|
|
7267
|
+
/** @description Names of the columns exposed by the alias. */
|
|
7268
|
+
columns?: string[];
|
|
7269
|
+
};
|
|
7270
|
+
WhereFilterJobParams: {
|
|
7271
|
+
/** @default null */
|
|
7272
|
+
column: string | null;
|
|
7273
|
+
/** @default null */
|
|
7274
|
+
operator: string | null;
|
|
7275
|
+
/** @default null */
|
|
7276
|
+
values: string[] | null;
|
|
7277
|
+
};
|
|
7278
|
+
AliasCreateJobParams: {
|
|
7279
|
+
sourceTable: string;
|
|
7280
|
+
name: string;
|
|
7281
|
+
/** @default null */
|
|
7282
|
+
idBucket: number | null;
|
|
7283
|
+
/** @default null */
|
|
7284
|
+
aliasFilter: components['schemas']['WhereFilterJobParams'] | null;
|
|
7285
|
+
/** @default null */
|
|
7286
|
+
aliasColumns: string[] | null;
|
|
7287
|
+
};
|
|
7288
|
+
/** @description The bucket a table lives in, as embedded in table responses. Built by Model_Row_Bucket::toApiResponse() and extended with `metadata` by the table response provider. Unlike the standalone bucket detail response, `tables` here is the URI of the tables listing, not a list of table objects, and there is no `scheduledTasks`, `listing` or `linkedBy`. */
|
|
7289
|
+
TableBucketResponse: {
|
|
7290
|
+
/**
|
|
7291
|
+
* @description API URI of the bucket.
|
|
7292
|
+
* @example https://connection.keboola.com/v2/storage/buckets/in.c-my-new-bucket
|
|
7293
|
+
*/
|
|
7294
|
+
uri: string;
|
|
7295
|
+
/**
|
|
7296
|
+
* @description Bucket identifier (`{stage}.{name}`).
|
|
7297
|
+
* @example in.c-my-new-bucket
|
|
7298
|
+
*/
|
|
7299
|
+
id: string;
|
|
7300
|
+
/**
|
|
7301
|
+
* @description Bucket name (prefixed with `c-`).
|
|
7302
|
+
* @example c-my-new-bucket
|
|
7303
|
+
*/
|
|
7304
|
+
name: string;
|
|
7305
|
+
/**
|
|
7306
|
+
* @description Human-readable display name shown in the UI.
|
|
7307
|
+
* @example my-new-bucket
|
|
7308
|
+
*/
|
|
7309
|
+
displayName: string;
|
|
7310
|
+
/**
|
|
7311
|
+
* @description ID of the branch the bucket belongs to.
|
|
7312
|
+
* @example 1234
|
|
7313
|
+
*/
|
|
7314
|
+
idBranch: number;
|
|
7315
|
+
/**
|
|
7316
|
+
* @description Bucket stage.
|
|
7317
|
+
* @example in
|
|
7318
|
+
* @enum {string}
|
|
7319
|
+
*/
|
|
7320
|
+
stage: 'in' | 'out' | 'sys';
|
|
7321
|
+
/**
|
|
7322
|
+
* @description Bucket description.
|
|
7323
|
+
* @example Some Description
|
|
7324
|
+
*/
|
|
7325
|
+
description: string;
|
|
7326
|
+
/**
|
|
7327
|
+
* @description URI to list the tables in the bucket.
|
|
7328
|
+
* @example https://connection.keboola.com/v2/storage/buckets/in.c-my-new-bucket/tables
|
|
7329
|
+
*/
|
|
7330
|
+
tables: string;
|
|
7331
|
+
/**
|
|
7332
|
+
* Format: date-time
|
|
7333
|
+
* @description Creation timestamp.
|
|
7334
|
+
* @example 2017-02-13T12:01:05+0100
|
|
7335
|
+
*/
|
|
7336
|
+
created: string;
|
|
7337
|
+
/**
|
|
7338
|
+
* Format: date-time
|
|
7339
|
+
* @description Timestamp of the last data change in the bucket.
|
|
7340
|
+
* @example null
|
|
7341
|
+
*/
|
|
7342
|
+
lastChangeDate?: string | null;
|
|
7343
|
+
/**
|
|
7344
|
+
* Format: date-time
|
|
7345
|
+
* @description Timestamp of the last bucket update.
|
|
7346
|
+
* @example 2024-11-28T13:03:13+0100
|
|
7347
|
+
*/
|
|
7348
|
+
updated?: string | null;
|
|
7349
|
+
/**
|
|
7350
|
+
* @description Whether the bucket is read-only (linked or external buckets).
|
|
7351
|
+
* @example false
|
|
7352
|
+
*/
|
|
7353
|
+
isReadOnly: boolean;
|
|
7354
|
+
/**
|
|
7355
|
+
* @description Total data size in bytes.
|
|
7356
|
+
* @example 0
|
|
7357
|
+
*/
|
|
7358
|
+
dataSizeBytes: number;
|
|
7359
|
+
/**
|
|
7360
|
+
* @description Total number of rows.
|
|
7361
|
+
* @example 0
|
|
7362
|
+
*/
|
|
7363
|
+
rowsCount: number;
|
|
7364
|
+
/**
|
|
7365
|
+
* @description Whether the bucket is in maintenance mode.
|
|
7366
|
+
* @example false
|
|
7367
|
+
*/
|
|
7368
|
+
isMaintenance: boolean;
|
|
7369
|
+
/**
|
|
7370
|
+
* @description Storage backend of the bucket.
|
|
7371
|
+
* @example snowflake
|
|
7372
|
+
* @enum {string}
|
|
7373
|
+
*/
|
|
7374
|
+
backend: 'snowflake' | 'bigquery';
|
|
7375
|
+
/**
|
|
7376
|
+
* @description Sharing type of the bucket; `null` when the bucket is not shared.
|
|
7377
|
+
* @example null
|
|
7378
|
+
* @enum {string|null}
|
|
7379
|
+
*/
|
|
7380
|
+
sharing?: 'organization' | 'organization-project' | 'specific-projects' | 'specific-users' | null;
|
|
7381
|
+
/**
|
|
7382
|
+
* @description Whether the bucket is an external (registered) bucket.
|
|
7383
|
+
* @example false
|
|
7384
|
+
*/
|
|
7385
|
+
hasExternalSchema: boolean;
|
|
7386
|
+
/**
|
|
7387
|
+
* @description Database name of an external bucket.
|
|
7388
|
+
* @example null
|
|
7389
|
+
*/
|
|
7390
|
+
databaseName?: string | null;
|
|
7391
|
+
/**
|
|
7392
|
+
* @description Dot-separated path of the bucket on the backend.
|
|
7393
|
+
* @example database_name.c-my-new-bucket
|
|
7394
|
+
*/
|
|
7395
|
+
path: string;
|
|
7396
|
+
/**
|
|
7397
|
+
* @description Whether the external bucket uses a Snowflake Secure Data Share.
|
|
7398
|
+
* @example false
|
|
7399
|
+
*/
|
|
7400
|
+
isSnowflakeSharedDatabase: boolean;
|
|
7401
|
+
/**
|
|
7402
|
+
* @description Whether this bucket is linked from another project.
|
|
7403
|
+
* @example false
|
|
7404
|
+
*/
|
|
7405
|
+
isLinkedBucket: boolean;
|
|
7406
|
+
/**
|
|
7407
|
+
* @description CSS color of the bucket.
|
|
7408
|
+
* @example null
|
|
7409
|
+
*/
|
|
7410
|
+
color?: string | null;
|
|
7411
|
+
/**
|
|
7412
|
+
* @description Whether the bucket can be shared.
|
|
7413
|
+
* @example true
|
|
7414
|
+
*/
|
|
7415
|
+
bucketSharingAllowed: boolean;
|
|
7416
|
+
/** @description Sharing parameters. Present only when the bucket is shared. */
|
|
7417
|
+
sharingParameters?: {
|
|
7418
|
+
[key: string]: Record<string, never>;
|
|
7419
|
+
} | null;
|
|
7420
|
+
/** @description Token that shared the bucket. Present only when the bucket is shared. */
|
|
7421
|
+
sharedBy?: {
|
|
7422
|
+
/** @example 5 */
|
|
7423
|
+
id?: number | null;
|
|
7424
|
+
/** @example dev@keboola.com */
|
|
7425
|
+
name?: string | null;
|
|
7426
|
+
/**
|
|
7427
|
+
* Format: date-time
|
|
7428
|
+
* @example 2020-02-03T14:58:29+0100
|
|
7429
|
+
*/
|
|
7430
|
+
date?: string | null;
|
|
7431
|
+
} | null;
|
|
7432
|
+
/** @description Bucket owner; `null` when no owner is set. */
|
|
7433
|
+
owner?: {
|
|
7434
|
+
/** @example 123 */
|
|
7435
|
+
id?: number;
|
|
7436
|
+
/** @example Jan Developer */
|
|
7437
|
+
name?: string;
|
|
7438
|
+
/** @example jan.dev@keboola.com */
|
|
7439
|
+
email?: string;
|
|
7440
|
+
} | null;
|
|
7441
|
+
/** @description Source bucket of a linked bucket. Present only for linked buckets. */
|
|
7442
|
+
sourceBucket?: components['schemas']['SharedBucketResponse'] | null;
|
|
7443
|
+
/**
|
|
7444
|
+
* @description Full path of the bucket on the backend (e.g. database and schema).
|
|
7445
|
+
* @example [
|
|
7446
|
+
* "KBC_PRJ_123",
|
|
7447
|
+
* "in.c-my-new-bucket"
|
|
7448
|
+
* ]
|
|
7449
|
+
*/
|
|
7450
|
+
backendPath: string[];
|
|
7451
|
+
/** @description Bucket metadata records. */
|
|
7452
|
+
metadata: components['schemas']['MetadataItemResponse'][];
|
|
7453
|
+
};
|
|
7454
|
+
/** @description Column metadata of a table, keyed by column name. Built by Model_Row_MetadataTable::getTableColumnMetadataApiResponse(). */
|
|
7455
|
+
TableColumnMetadataResponse: {
|
|
7456
|
+
[key: string]: components['schemas']['MetadataItemResponse'][];
|
|
7457
|
+
};
|
|
7458
|
+
/** @description Native table definition, in the same shape as the create-table-from-definition endpoint. Built by Keboola\Connection\Storage\Service\Metadata\MetadataConvertor::createTableDefinitionResponseFromMetadata() for a typed table, or ::createUntypedTableDefinitionResponseFromMetadata() for an untyped one - for an untyped table, `basetype`, `canBeFiltered`, `distribution` and `index` are never present, and each column `definition` only ever carries `description`. A storage driver may add further backend-specific keys via its extendTableDefinitionResponse() hook, e.g. BigQuery adds `timePartitioning`, `clustering`, `rangePartitioning` and `requirePartitionFilter`. */
|
|
7459
|
+
TableDefinitionResponse: {
|
|
7460
|
+
/** @description Primary key column names. */
|
|
7461
|
+
primaryKeysNames: string[];
|
|
7462
|
+
columns: {
|
|
7463
|
+
/** @description Column name. */
|
|
7464
|
+
name: string;
|
|
7465
|
+
/** @description Whether the column type can be used in a `where` filter. Absent for an untyped table. */
|
|
7466
|
+
canBeFiltered?: boolean;
|
|
7467
|
+
/** @description Column type definition. An empty object (`{}`) for an untyped column without a description. */
|
|
7468
|
+
definition: {
|
|
7469
|
+
/** @description Backend-native column type. Absent for an untyped table. */
|
|
7470
|
+
type?: string;
|
|
7471
|
+
/** @description Whether the column accepts NULL. Absent for an untyped table. */
|
|
7472
|
+
nullable?: boolean;
|
|
7473
|
+
/** @description Backend-native type length/precision, for example `38,9`. Absent when not applicable. */
|
|
7474
|
+
length?: string | null;
|
|
7475
|
+
/** @description Default value of the column. Absent when not set. */
|
|
7476
|
+
default?: string | null;
|
|
7477
|
+
/** @description Column description. */
|
|
7478
|
+
description?: string;
|
|
7479
|
+
};
|
|
7480
|
+
/** @description Keboola base type. Absent for an untyped table. */
|
|
7481
|
+
basetype?: string | null;
|
|
7482
|
+
}[];
|
|
7483
|
+
/** @description Table description, when set. */
|
|
7484
|
+
description: string;
|
|
7485
|
+
/** @description Present only when the table has a distribution type set. Absent for an untyped table. */
|
|
7486
|
+
distribution: {
|
|
7487
|
+
type?: string;
|
|
7488
|
+
distributionColumnsNames?: string[];
|
|
6517
7489
|
};
|
|
7490
|
+
/** @description Present only when the table has an index type set. Absent for an untyped table. */
|
|
7491
|
+
index: {
|
|
7492
|
+
type?: string;
|
|
7493
|
+
indexColumnsNames?: string[];
|
|
7494
|
+
};
|
|
7495
|
+
} & {
|
|
7496
|
+
[key: string]: unknown;
|
|
7497
|
+
};
|
|
7498
|
+
/** @description Source table of an alias, extended with the metadata that propagates from the root source table for a simple alias with column auto-sync enabled. */
|
|
7499
|
+
TableSourceTableResponse: components['schemas']['SourceTableResponse'] & {
|
|
7500
|
+
/** @description Metadata of the root source table. Present only when requested via `include=sourceMetadata`. */
|
|
7501
|
+
metadata?: components['schemas']['MetadataItemResponse'][];
|
|
7502
|
+
columnMetadata?: components['schemas']['TableColumnMetadataResponse'];
|
|
7503
|
+
definition?: components['schemas']['TableDefinitionResponse'];
|
|
7504
|
+
};
|
|
7505
|
+
/** @description A table as returned by the table list, and (identically) as an item of a bucket detail's `tables`. Built by Storage_Service_Metadata::getTablesResponseForApi() from Model_Row_MetadataTable::toApiResponse(); `attributes`, `columns`, `bucket`, `metadata` and `columnMetadata` are added only when requested via the endpoint's `include` parameter (`bucket` is never present inside a bucket detail's `tables`, since the containing bucket is already known there). Unlike the table detail response, there is no `definition`. */
|
|
7506
|
+
TableListItemResponse: {
|
|
7507
|
+
/** @description Table detail URI */
|
|
7508
|
+
uri: string;
|
|
7509
|
+
/** @description Table identifier */
|
|
7510
|
+
id: string;
|
|
7511
|
+
/** @description Table name */
|
|
7512
|
+
name: string;
|
|
7513
|
+
/** @description Display name of the table */
|
|
7514
|
+
displayName: string;
|
|
7515
|
+
/** @description Transactional flag */
|
|
7516
|
+
transactional: boolean;
|
|
7517
|
+
primaryKey: string[];
|
|
7518
|
+
indexType?: string | null;
|
|
7519
|
+
indexKey: string[];
|
|
7520
|
+
distributionType?: string | null;
|
|
7521
|
+
distributionKey: string[];
|
|
7522
|
+
syntheticPrimaryKeyEnabled: boolean;
|
|
7523
|
+
/** Format: date-time */
|
|
7524
|
+
created?: string | null;
|
|
7525
|
+
/** Format: date-time */
|
|
7526
|
+
lastImportDate?: string | null;
|
|
7527
|
+
/** Format: date-time */
|
|
7528
|
+
lastChangeDate?: string | null;
|
|
7529
|
+
rowsCount?: number | null;
|
|
7530
|
+
dataSizeBytes?: number | null;
|
|
7531
|
+
isAlias: boolean;
|
|
7532
|
+
isAliasable: boolean;
|
|
7533
|
+
isTyped: boolean;
|
|
7534
|
+
/** @description True when the table description is managed by the system. */
|
|
7535
|
+
isDescriptionSystemManaged: boolean;
|
|
7536
|
+
/**
|
|
7537
|
+
* @description How the `_timestamp` column is managed.
|
|
7538
|
+
* @enum {string}
|
|
7539
|
+
*/
|
|
7540
|
+
timestampType: 'MANAGED' | 'SELFMANAGED' | 'NONE';
|
|
7541
|
+
tableType: string;
|
|
7542
|
+
path: string;
|
|
7543
|
+
/** @description Always an empty array, kept for backward compatibility. Present with `include=attributes` (the default). */
|
|
7544
|
+
attributes: Record<string, never>[];
|
|
7545
|
+
/** @description Column names. Present with `include=columns`. */
|
|
7546
|
+
columns: string[];
|
|
7547
|
+
bucket: components['schemas']['TableBucketResponse'];
|
|
7548
|
+
/** @description Table metadata records. Present with `include=metadata`. */
|
|
7549
|
+
metadata: components['schemas']['MetadataItemResponse'][];
|
|
7550
|
+
columnMetadata: components['schemas']['TableColumnMetadataResponse'];
|
|
7551
|
+
/** @description Source table info, present for alias tables. */
|
|
7552
|
+
sourceTable?: components['schemas']['TableSourceTableResponse'] | null;
|
|
7553
|
+
/** @description Present for simple aliases. */
|
|
7554
|
+
aliasColumnsAutoSync?: boolean | null;
|
|
7555
|
+
/** @description Present for filtered simple aliases. */
|
|
7556
|
+
aliasFilter?: components['schemas']['AliasFilterResponse'] | null;
|
|
7557
|
+
/** @description Present for custom SQL aliases. */
|
|
7558
|
+
selectSql?: string | null;
|
|
7559
|
+
/** @description Alias tables only - whether the alias is persisted as a table in the backend. */
|
|
7560
|
+
isPersisted?: boolean | null;
|
|
7561
|
+
};
|
|
7562
|
+
/** @description Scheduled task attached to a bucket. */
|
|
7563
|
+
ScheduledTaskResponse: {
|
|
7564
|
+
/**
|
|
7565
|
+
* Format: uuid
|
|
7566
|
+
* @description Identifier of the scheduled task.
|
|
7567
|
+
* @example 0197e22b-379d-7c62-bc6d-88e50c3d0c75
|
|
7568
|
+
*/
|
|
7569
|
+
uuid: string;
|
|
7570
|
+
/**
|
|
7571
|
+
* @description Job the task runs.
|
|
7572
|
+
* @example bucketRefresh
|
|
7573
|
+
* @enum {string}
|
|
7574
|
+
*/
|
|
7575
|
+
job: 'bucketRefresh';
|
|
7576
|
+
/**
|
|
7577
|
+
* @description Type of the entity the task is attached to.
|
|
7578
|
+
* @example bucket
|
|
7579
|
+
* @enum {string}
|
|
7580
|
+
*/
|
|
7581
|
+
relatedEntity: 'bucket';
|
|
7582
|
+
/**
|
|
7583
|
+
* @description Identifier of the related entity (bucket ID).
|
|
7584
|
+
* @example in.c-bucket-name
|
|
7585
|
+
*/
|
|
7586
|
+
relatedId: string;
|
|
7587
|
+
/**
|
|
7588
|
+
* @description Cron expression of the schedule.
|
|
7589
|
+
* @example 42 13 * * *
|
|
7590
|
+
*/
|
|
7591
|
+
cronExpression: string;
|
|
7592
|
+
/**
|
|
7593
|
+
* Format: date-time
|
|
7594
|
+
* @description Creation timestamp of the task.
|
|
7595
|
+
* @example 2025-07-01T00:08:00+02:00
|
|
7596
|
+
*/
|
|
7597
|
+
createdAt: string;
|
|
7598
|
+
};
|
|
7599
|
+
BigQueryBucketListingDetailResponse: {
|
|
7600
|
+
/** @description User-defined listing ID (unique within the exchange). */
|
|
7601
|
+
listingId: string;
|
|
7602
|
+
/** @description GCP listing resource name. Omitted from the response when the listing has not yet been provisioned (the async job is still running or has failed). */
|
|
7603
|
+
listingResourceName?: string | null;
|
|
7604
|
+
/** @description IAM principals with subscriber access (each prefixed with `user:` or `group:`). */
|
|
7605
|
+
subscribers: string[];
|
|
7606
|
+
};
|
|
7607
|
+
BucketListingDetailResponse: {
|
|
7608
|
+
/** @description Human-readable listing name (used as the backend listing displayName). */
|
|
7609
|
+
name: string;
|
|
7610
|
+
/** @description Listing description. Omitted from the response when not set. */
|
|
7611
|
+
description?: string | null;
|
|
7612
|
+
/**
|
|
7613
|
+
* @description Backend of the listed bucket.
|
|
7614
|
+
* @enum {string}
|
|
7615
|
+
*/
|
|
7616
|
+
backend: 'bigquery';
|
|
7617
|
+
/** @description BigQuery-specific listing details. Present only for BigQuery buckets. */
|
|
7618
|
+
bigquery?: components['schemas']['BigQueryBucketListingDetailResponse'] | null;
|
|
7619
|
+
/**
|
|
7620
|
+
* Format: date-time
|
|
7621
|
+
* @description Listing creation timestamp.
|
|
7622
|
+
*/
|
|
7623
|
+
createdAt: string;
|
|
7624
|
+
};
|
|
7625
|
+
/** @description Bucket detail: the bucket object extended with metadata, tables, scheduled tasks, listing and links. */
|
|
7626
|
+
BucketDetailResponse: {
|
|
7627
|
+
/**
|
|
7628
|
+
* @description API URI of the bucket.
|
|
7629
|
+
* @example https://connection.keboola.com/v2/storage/buckets/in.c-my-new-bucket
|
|
7630
|
+
*/
|
|
7631
|
+
uri: string;
|
|
7632
|
+
/**
|
|
7633
|
+
* @description Bucket identifier (`{stage}.{name}`).
|
|
7634
|
+
* @example in.c-my-new-bucket
|
|
7635
|
+
*/
|
|
7636
|
+
id: string;
|
|
7637
|
+
/**
|
|
7638
|
+
* @description Bucket name (prefixed with `c-`).
|
|
7639
|
+
* @example c-my-new-bucket
|
|
7640
|
+
*/
|
|
7641
|
+
name: string;
|
|
7642
|
+
/**
|
|
7643
|
+
* @description Human-readable display name shown in the UI.
|
|
7644
|
+
* @example my-new-bucket
|
|
7645
|
+
*/
|
|
7646
|
+
displayName: string;
|
|
7647
|
+
/**
|
|
7648
|
+
* @description ID of the branch the bucket belongs to.
|
|
7649
|
+
* @example 1234
|
|
7650
|
+
*/
|
|
7651
|
+
idBranch: number;
|
|
7652
|
+
/**
|
|
7653
|
+
* @description Bucket stage.
|
|
7654
|
+
* @example in
|
|
7655
|
+
* @enum {string}
|
|
7656
|
+
*/
|
|
7657
|
+
stage: 'in' | 'out' | 'sys';
|
|
7658
|
+
/**
|
|
7659
|
+
* @description Bucket description.
|
|
7660
|
+
* @example Some Description
|
|
7661
|
+
*/
|
|
7662
|
+
description: string;
|
|
7663
|
+
/** @description Tables in the bucket. Each item is a table object as returned by the table list; columns, metadata and column metadata are added according to `include`. */
|
|
7664
|
+
tables: components['schemas']['TableListItemResponse'][];
|
|
7665
|
+
/**
|
|
7666
|
+
* Format: date-time
|
|
7667
|
+
* @description Creation timestamp.
|
|
7668
|
+
* @example 2017-02-13T12:01:05+0100
|
|
7669
|
+
*/
|
|
7670
|
+
created: string;
|
|
7671
|
+
/**
|
|
7672
|
+
* Format: date-time
|
|
7673
|
+
* @description Timestamp of the last data change in the bucket.
|
|
7674
|
+
* @example null
|
|
7675
|
+
*/
|
|
7676
|
+
lastChangeDate?: string | null;
|
|
7677
|
+
/**
|
|
7678
|
+
* Format: date-time
|
|
7679
|
+
* @description Timestamp of the last bucket update.
|
|
7680
|
+
* @example 2024-11-28T13:03:13+0100
|
|
7681
|
+
*/
|
|
7682
|
+
updated?: string | null;
|
|
7683
|
+
/**
|
|
7684
|
+
* @description Whether the bucket is read-only (linked or external buckets).
|
|
7685
|
+
* @example false
|
|
7686
|
+
*/
|
|
7687
|
+
isReadOnly: boolean;
|
|
7688
|
+
/**
|
|
7689
|
+
* @description Total data size in bytes.
|
|
7690
|
+
* @example 0
|
|
7691
|
+
*/
|
|
7692
|
+
dataSizeBytes: number;
|
|
7693
|
+
/**
|
|
7694
|
+
* @description Total number of rows.
|
|
7695
|
+
* @example 0
|
|
7696
|
+
*/
|
|
7697
|
+
rowsCount: number;
|
|
7698
|
+
/**
|
|
7699
|
+
* @description Whether the bucket is in maintenance mode.
|
|
7700
|
+
* @example false
|
|
7701
|
+
*/
|
|
7702
|
+
isMaintenance: boolean;
|
|
7703
|
+
/**
|
|
7704
|
+
* @description Storage backend of the bucket.
|
|
7705
|
+
* @example snowflake
|
|
7706
|
+
* @enum {string}
|
|
7707
|
+
*/
|
|
7708
|
+
backend: 'snowflake' | 'bigquery';
|
|
7709
|
+
/**
|
|
7710
|
+
* @description Sharing type of the bucket; `null` when the bucket is not shared.
|
|
7711
|
+
* @example null
|
|
7712
|
+
* @enum {string|null}
|
|
7713
|
+
*/
|
|
7714
|
+
sharing?: 'organization' | 'organization-project' | 'specific-projects' | 'specific-users' | null;
|
|
7715
|
+
/**
|
|
7716
|
+
* @description Whether the bucket is an external (registered) bucket.
|
|
7717
|
+
* @example false
|
|
7718
|
+
*/
|
|
7719
|
+
hasExternalSchema: boolean;
|
|
7720
|
+
/**
|
|
7721
|
+
* @description Database name of an external bucket.
|
|
7722
|
+
* @example null
|
|
7723
|
+
*/
|
|
7724
|
+
databaseName?: string | null;
|
|
7725
|
+
/**
|
|
7726
|
+
* @description Dot-separated path of the bucket on the backend.
|
|
7727
|
+
* @example database_name.c-my-new-bucket
|
|
7728
|
+
*/
|
|
7729
|
+
path: string;
|
|
7730
|
+
/**
|
|
7731
|
+
* @description Whether the external bucket uses a Snowflake Secure Data Share.
|
|
7732
|
+
* @example false
|
|
7733
|
+
*/
|
|
7734
|
+
isSnowflakeSharedDatabase: boolean;
|
|
7735
|
+
/**
|
|
7736
|
+
* @description Whether this bucket is linked from another project.
|
|
7737
|
+
* @example false
|
|
7738
|
+
*/
|
|
7739
|
+
isLinkedBucket: boolean;
|
|
7740
|
+
/**
|
|
7741
|
+
* @description CSS color of the bucket.
|
|
7742
|
+
* @example null
|
|
7743
|
+
*/
|
|
7744
|
+
color?: string | null;
|
|
7745
|
+
/**
|
|
7746
|
+
* @description Whether the bucket can be shared.
|
|
7747
|
+
* @example true
|
|
7748
|
+
*/
|
|
7749
|
+
bucketSharingAllowed: boolean;
|
|
7750
|
+
/** @description Sharing parameters. Present only when the bucket is shared. */
|
|
7751
|
+
sharingParameters?: {
|
|
7752
|
+
[key: string]: Record<string, never>;
|
|
7753
|
+
} | null;
|
|
7754
|
+
/** @description Token that shared the bucket. Present only when the bucket is shared. */
|
|
7755
|
+
sharedBy?: {
|
|
7756
|
+
/** @example 5 */
|
|
7757
|
+
id?: number | null;
|
|
7758
|
+
/** @example dev@keboola.com */
|
|
7759
|
+
name?: string | null;
|
|
7760
|
+
/**
|
|
7761
|
+
* Format: date-time
|
|
7762
|
+
* @example 2020-02-03T14:58:29+0100
|
|
7763
|
+
*/
|
|
7764
|
+
date?: string | null;
|
|
7765
|
+
} | null;
|
|
7766
|
+
/** @description Bucket owner; `null` when no owner is set. */
|
|
7767
|
+
owner?: {
|
|
7768
|
+
/** @example 123 */
|
|
7769
|
+
id?: number;
|
|
7770
|
+
/** @example Jan Developer */
|
|
7771
|
+
name?: string;
|
|
7772
|
+
/** @example jan.dev@keboola.com */
|
|
7773
|
+
email?: string;
|
|
7774
|
+
} | null;
|
|
7775
|
+
/** @description Source bucket of a linked bucket. Present only for linked buckets. */
|
|
7776
|
+
sourceBucket?: components['schemas']['SharedBucketResponse'] | null;
|
|
7777
|
+
/**
|
|
7778
|
+
* @description Full path of the bucket on the backend (e.g. database and schema).
|
|
7779
|
+
* @example [
|
|
7780
|
+
* "KBC_PRJ_123",
|
|
7781
|
+
* "in.c-my-new-bucket"
|
|
7782
|
+
* ]
|
|
7783
|
+
*/
|
|
7784
|
+
backendPath: string[];
|
|
7785
|
+
/**
|
|
7786
|
+
* @description Deprecated, always an empty array. Kept for backward compatibility.
|
|
7787
|
+
* @example []
|
|
7788
|
+
*/
|
|
7789
|
+
attributes: Record<string, never>[];
|
|
7790
|
+
/** @description Bucket metadata records. */
|
|
7791
|
+
metadata: components['schemas']['MetadataItemResponse'][];
|
|
7792
|
+
/** @description Scheduled tasks (e.g. scheduled refresh of an external bucket). */
|
|
7793
|
+
scheduledTasks: components['schemas']['ScheduledTaskResponse'][];
|
|
7794
|
+
/** @description Bucket listing payload (Analytics Hub on BigQuery). Null when the bucket is not listed. */
|
|
7795
|
+
listing?: components['schemas']['BucketListingDetailResponse'] | null;
|
|
7796
|
+
/** @description Buckets in other projects linked to this bucket. Present only when the bucket is linked somewhere. */
|
|
7797
|
+
linkedBy: {
|
|
7798
|
+
/**
|
|
7799
|
+
* @description ID of the linked bucket in the target project.
|
|
7800
|
+
* @example in.c-linked-bucket
|
|
7801
|
+
*/
|
|
7802
|
+
id?: string;
|
|
7803
|
+
/**
|
|
7804
|
+
* Format: date-time
|
|
7805
|
+
* @example 2017-02-13T12:01:05+0100
|
|
7806
|
+
*/
|
|
7807
|
+
created?: string;
|
|
7808
|
+
project?: {
|
|
7809
|
+
/** @example 321 */
|
|
7810
|
+
id?: string;
|
|
7811
|
+
/** @example Some Project */
|
|
7812
|
+
name?: string;
|
|
7813
|
+
};
|
|
7814
|
+
}[];
|
|
7815
|
+
};
|
|
7816
|
+
/** @description Detail of the created alias table together with the bucket it was created in. */
|
|
7817
|
+
CreateTableAliasResponse: components['schemas']['AliasCreateJobResult'] & {
|
|
7818
|
+
bucket?: components['schemas']['BucketDetailResponse'];
|
|
7819
|
+
};
|
|
7820
|
+
/** @description Request body of POST /buckets/{bucket_id}/table-aliases. */
|
|
7821
|
+
CreateTableAliasRequest: {
|
|
7822
|
+
/** @description Id of the table the alias reads from (e.g. `in.c-main.users`). */
|
|
7823
|
+
sourceTable: string;
|
|
7824
|
+
/** @description Name of the new alias table. Defaults to the source table name. */
|
|
7825
|
+
name?: string | null;
|
|
7826
|
+
/** @description Columns exposed by the alias. When omitted the alias mirrors all source columns and keeps them in sync. */
|
|
7827
|
+
aliasColumns?: string[] | null;
|
|
7828
|
+
/**
|
|
7829
|
+
* @deprecated
|
|
7830
|
+
* @description Deprecated and ignored - auto-sync is derived from whether aliasColumns is given.
|
|
7831
|
+
*/
|
|
7832
|
+
aliasColumnsAutosync?: boolean | null;
|
|
7833
|
+
/** @description Restricts the alias to rows matching a single column filter. */
|
|
7834
|
+
aliasFilter?: {
|
|
7835
|
+
column?: string;
|
|
7836
|
+
values?: string[];
|
|
7837
|
+
/**
|
|
7838
|
+
* @default eq
|
|
7839
|
+
* @enum {string}
|
|
7840
|
+
*/
|
|
7841
|
+
operator: 'eq' | 'ne';
|
|
7842
|
+
} | null;
|
|
7843
|
+
};
|
|
7844
|
+
/** @description Source of the created table, as stored in the job operation params. */
|
|
7845
|
+
TableCreateJobParamsSource: {
|
|
7846
|
+
/**
|
|
7847
|
+
* @description Kind of source the table is created from.
|
|
7848
|
+
* @enum {string}
|
|
7849
|
+
*/
|
|
7850
|
+
type: 'file' | 'snapshot' | 'workspace' | 'timeTravel';
|
|
7851
|
+
/** @description Source file ID. Present when `type` is `file`. */
|
|
7852
|
+
fileId: string;
|
|
7853
|
+
/** @description Source snapshot ID. Present when `type` is `snapshot`. */
|
|
7854
|
+
snapshotId: string;
|
|
7855
|
+
/** @description Source workspace table/object name; duplicates `dataObject` for backward compatibility. Present when `type` is `workspace`. */
|
|
7856
|
+
tableName: string;
|
|
7857
|
+
/** @description Source workspace table/object name. Present when `type` is `workspace`. */
|
|
7858
|
+
dataObject: string;
|
|
7859
|
+
/** @description Source workspace ID. Present when `type` is `workspace`. */
|
|
7860
|
+
workspaceId: number;
|
|
7861
|
+
/** @description Point in time to travel to. Present when `type` is `timeTravel`. */
|
|
7862
|
+
timestamp: string;
|
|
7863
|
+
/** @description Name of the table being created. Present when `type` is `timeTravel`. */
|
|
7864
|
+
destinationTableName: string;
|
|
7865
|
+
/** @description Source table ID the time travel is taken from. Present when `type` is `timeTravel`. */
|
|
7866
|
+
sourceTableId: string;
|
|
7867
|
+
};
|
|
7868
|
+
TableCreateJobParams: {
|
|
7869
|
+
source: components['schemas']['TableCreateJobParamsSource'];
|
|
6518
7870
|
params: {
|
|
6519
7871
|
[key: string]: unknown;
|
|
6520
7872
|
};
|
|
@@ -6522,15 +7874,13 @@ type components = {
|
|
|
6522
7874
|
backendConfiguration: components['schemas']['BackendConfigurationJobParams'] | null;
|
|
6523
7875
|
/** @default null */
|
|
6524
7876
|
idBucket: number | null;
|
|
6525
|
-
jobParams: unknown[];
|
|
6526
|
-
jobOperationParams: unknown[];
|
|
6527
7877
|
};
|
|
6528
7878
|
/** @description Request body for creating a table from a file. Some parameters are optional or only used for specific backends. */
|
|
6529
7879
|
CreateTableAsyncFromFileRequest: {
|
|
6530
7880
|
/** @description ID of the source data file. */
|
|
6531
7881
|
dataFileId: number;
|
|
6532
7882
|
/** @description Name of the new table. */
|
|
6533
|
-
name: string;
|
|
7883
|
+
name: string & components['schemas']['StorageName'];
|
|
6534
7884
|
/** @description CSV delimiter character. */
|
|
6535
7885
|
delimiter?: string | null;
|
|
6536
7886
|
/** @description CSV enclosure character. */
|
|
@@ -6554,7 +7904,7 @@ type components = {
|
|
|
6554
7904
|
/** @description ID of the source snapshot. */
|
|
6555
7905
|
snapshotId: number;
|
|
6556
7906
|
/** @description Name of the new table. */
|
|
6557
|
-
name: string;
|
|
7907
|
+
name: string & components['schemas']['StorageName'];
|
|
6558
7908
|
/** @description CSV delimiter character. */
|
|
6559
7909
|
delimiter?: string | null;
|
|
6560
7910
|
/** @description CSV enclosure character. */
|
|
@@ -6578,7 +7928,7 @@ type components = {
|
|
|
6578
7928
|
/** @description ID of the source table for time travel. */
|
|
6579
7929
|
sourceTableId: string;
|
|
6580
7930
|
/** @description Name of the new table. */
|
|
6581
|
-
name: string;
|
|
7931
|
+
name: string & components['schemas']['StorageName'];
|
|
6582
7932
|
/** @description Timestamp for time travel (ISO8601 or unix timestamp). */
|
|
6583
7933
|
timestamp: string;
|
|
6584
7934
|
/** @description CSV delimiter character. */
|
|
@@ -6608,7 +7958,7 @@ type components = {
|
|
|
6608
7958
|
/** @description Deprecated: use dataObject. Name of the table in the workspace. */
|
|
6609
7959
|
dataTableName?: string | null;
|
|
6610
7960
|
/** @description Name of the new table. */
|
|
6611
|
-
name: string;
|
|
7961
|
+
name: string & components['schemas']['StorageName'];
|
|
6612
7962
|
/** @description CSV delimiter character. */
|
|
6613
7963
|
delimiter?: string | null;
|
|
6614
7964
|
/** @description CSV enclosure character. */
|
|
@@ -6627,37 +7977,110 @@ type components = {
|
|
|
6627
7977
|
*/
|
|
6628
7978
|
timestampType: string | null;
|
|
6629
7979
|
};
|
|
7980
|
+
/** @description A single column definition, as stored in the job operation params. */
|
|
7981
|
+
TableDefinitionCreateColumnObject: {
|
|
7982
|
+
/** @description Name of the column. */
|
|
7983
|
+
name: string;
|
|
7984
|
+
/** @description Native column definition. Mutually exclusive with `basetype`. */
|
|
7985
|
+
definition?: {
|
|
7986
|
+
/** @description Backend-native column type. */
|
|
7987
|
+
type?: string;
|
|
7988
|
+
/** @description Length of the column type, e.g. `38,9` for a numeric type. */
|
|
7989
|
+
length?: string | null;
|
|
7990
|
+
/**
|
|
7991
|
+
* @description Whether the column is nullable.
|
|
7992
|
+
* @default true
|
|
7993
|
+
*/
|
|
7994
|
+
nullable: boolean;
|
|
7995
|
+
/** @description Default value of the column. */
|
|
7996
|
+
default?: string | null;
|
|
7997
|
+
/** @description Column description, stored as column metadata. */
|
|
7998
|
+
description?: string | null;
|
|
7999
|
+
} | null;
|
|
8000
|
+
/** @description Keboola base type of the column. Mutually exclusive with `definition.type`. */
|
|
8001
|
+
basetype?: string | null;
|
|
8002
|
+
};
|
|
8003
|
+
/** @description Time based partitioning configuration, as stored in the job operation params. */
|
|
8004
|
+
TableDefinitionTimePartitioningObject: {
|
|
8005
|
+
/** @description Type of the time partitioning, e.g. `DAY`. */
|
|
8006
|
+
type: string;
|
|
8007
|
+
/** @description Column used for the time partitioning; null when the table is partitioned by ingestion time. */
|
|
8008
|
+
field?: string | null;
|
|
8009
|
+
/** @description Number of milliseconds for which to keep the storage for a partition. */
|
|
8010
|
+
expirationMs?: string | null;
|
|
8011
|
+
};
|
|
8012
|
+
/** @description Integer range partitioning configuration, as stored in the job operation params. */
|
|
8013
|
+
TableDefinitionRangePartitioningObject: {
|
|
8014
|
+
/** @description Column used for the range partitioning. */
|
|
8015
|
+
field: string;
|
|
8016
|
+
/** @description Definition of the ranges. */
|
|
8017
|
+
range: {
|
|
8018
|
+
/** @description Start of the range, inclusive. */
|
|
8019
|
+
start: string;
|
|
8020
|
+
/** @description End of the range, exclusive. */
|
|
8021
|
+
end: string;
|
|
8022
|
+
/** @description Width of each interval. */
|
|
8023
|
+
interval: string;
|
|
8024
|
+
};
|
|
8025
|
+
};
|
|
8026
|
+
/** @description Clustering configuration, as stored in the job operation params. */
|
|
8027
|
+
TableDefinitionClusteringObject: {
|
|
8028
|
+
/** @description Columns used for the clustering. */
|
|
8029
|
+
fields: string[];
|
|
8030
|
+
};
|
|
8031
|
+
/** @description Source table the new table definition is created from. */
|
|
8032
|
+
TableDefinitionCreateSourceObject: {
|
|
8033
|
+
/**
|
|
8034
|
+
* @description Identifier of the source table.
|
|
8035
|
+
* @example in.c-main.users
|
|
8036
|
+
*/
|
|
8037
|
+
tableId: string;
|
|
8038
|
+
/** @description Branch the source table is read from. Omitted when it is the current branch. */
|
|
8039
|
+
branchId: number;
|
|
8040
|
+
};
|
|
6630
8041
|
TableDefinitionCreateJobParams: {
|
|
6631
8042
|
name: string;
|
|
6632
8043
|
primaryKeysNames: string[];
|
|
6633
|
-
columns:
|
|
6634
|
-
|
|
6635
|
-
|
|
8044
|
+
columns: components['schemas']['TableDefinitionCreateColumnObject'][];
|
|
8045
|
+
/** @default null */
|
|
8046
|
+
idBucket: number | null;
|
|
6636
8047
|
/** @default null */
|
|
6637
8048
|
description: string | null;
|
|
8049
|
+
isDescriptionSystemManaged?: boolean | null;
|
|
6638
8050
|
/** @default null */
|
|
6639
8051
|
timestampType: string | null;
|
|
6640
8052
|
/** @default null */
|
|
6641
|
-
timePartitioning:
|
|
6642
|
-
[key: string]: unknown;
|
|
6643
|
-
} | null;
|
|
8053
|
+
timePartitioning: components['schemas']['TableDefinitionTimePartitioningObject'] | null;
|
|
6644
8054
|
/** @default null */
|
|
6645
|
-
rangePartitioning:
|
|
6646
|
-
[key: string]: unknown;
|
|
6647
|
-
} | null;
|
|
8055
|
+
rangePartitioning: components['schemas']['TableDefinitionRangePartitioningObject'] | null;
|
|
6648
8056
|
/** @default null */
|
|
6649
|
-
clustering:
|
|
6650
|
-
[key: string]: unknown;
|
|
6651
|
-
} | null;
|
|
8057
|
+
clustering: components['schemas']['TableDefinitionClusteringObject'] | null;
|
|
6652
8058
|
/** @default null */
|
|
6653
8059
|
requirePartitionFilter: boolean | null;
|
|
6654
8060
|
/** @default null */
|
|
6655
|
-
source:
|
|
8061
|
+
source: components['schemas']['TableDefinitionCreateSourceObject'] | null;
|
|
6656
8062
|
/** @default null */
|
|
6657
8063
|
backendConfiguration: components['schemas']['BackendConfigurationJobParams'] | null;
|
|
6658
|
-
jobParams: unknown[];
|
|
6659
|
-
jobOperationParams: unknown[];
|
|
6660
8064
|
};
|
|
8065
|
+
/**
|
|
8066
|
+
* @description The name of a table column.
|
|
8067
|
+
*
|
|
8068
|
+
* - Allowed characters: `A-Z`, `a-z`, `0-9` and underscore `_`. Unlike a bucket or table name,
|
|
8069
|
+
* a column name may **not** contain a dash.
|
|
8070
|
+
* - 1 to 64 characters.
|
|
8071
|
+
* - Must start with a letter or a digit.
|
|
8072
|
+
* - To turn arbitrary user input into a name that satisfies this rule, call
|
|
8073
|
+
* `POST /v2/storage/webalize/column-names` instead of reimplementing the transformation. In
|
|
8074
|
+
* order, it strips emoji, transliterates the rest to ASCII, replaces every run of disallowed
|
|
8075
|
+
* characters with a single `_`, trims `_` from both ends, truncates to 64 characters, and
|
|
8076
|
+
* strips any leading `_` the truncation left behind. Input with no usable character left
|
|
8077
|
+
* webalizes to an empty string, which is *not* a valid column name.
|
|
8078
|
+
* - `POST /v2/storage/validate/column-names` applies one rule the creation endpoints do not:
|
|
8079
|
+
* it also rejects the backend system columns `oid`, `tableoid`, `xmin`, `cmin`, `xmax`,
|
|
8080
|
+
* `cmax` and `ctid`.
|
|
8081
|
+
* @example created_at
|
|
8082
|
+
*/
|
|
8083
|
+
StorageColumnName: string;
|
|
6661
8084
|
SnowflakeCreateTableDefinitionRequest: {
|
|
6662
8085
|
/** @description Name of the new table. Required. */
|
|
6663
8086
|
name: string;
|
|
@@ -6686,7 +8109,7 @@ type components = {
|
|
|
6686
8109
|
/** @description List of table columns. At least one column is required. */
|
|
6687
8110
|
columns: {
|
|
6688
8111
|
/** @description Name of the column. Required. */
|
|
6689
|
-
name:
|
|
8112
|
+
name: components['schemas']['StorageColumnName'];
|
|
6690
8113
|
/** @description Optional native column definition. Mutually exclusive with basetype. */
|
|
6691
8114
|
definition?: {
|
|
6692
8115
|
/** @description Snowflake native column type. Optional, defaults to VARCHAR. */
|
|
@@ -6735,7 +8158,7 @@ type components = {
|
|
|
6735
8158
|
/** @description List of table columns. Required unless `source` is set; must not be supplied together with `source` (the column definition is then derived from the source table). */
|
|
6736
8159
|
columns: {
|
|
6737
8160
|
/** @description Name of the column. Required. */
|
|
6738
|
-
name:
|
|
8161
|
+
name: components['schemas']['StorageColumnName'];
|
|
6739
8162
|
/** @description Optional native column definition. Mutually exclusive with basetype. */
|
|
6740
8163
|
definition?: {
|
|
6741
8164
|
/** @description BigQuery native column type. Optional, defaults to STRING. */
|
|
@@ -6795,11 +8218,12 @@ type components = {
|
|
|
6795
8218
|
idBucket: number;
|
|
6796
8219
|
/** @description Human-readable listing name carried over from the request. */
|
|
6797
8220
|
listingName: string;
|
|
6798
|
-
/**
|
|
6799
|
-
|
|
8221
|
+
/**
|
|
8222
|
+
* @description Optional listing description (null when not provided).
|
|
8223
|
+
* @default null
|
|
8224
|
+
*/
|
|
8225
|
+
listingDescription: string | null;
|
|
6800
8226
|
bigquery: components['schemas']['BigQueryListingSection'];
|
|
6801
|
-
jobOperationParams: unknown[];
|
|
6802
|
-
jobParams: unknown[];
|
|
6803
8227
|
};
|
|
6804
8228
|
CreateBucketListingRequest: {
|
|
6805
8229
|
/** @description Human-readable listing name (maps to the backend listing displayName). */
|
|
@@ -6810,17 +8234,18 @@ type components = {
|
|
|
6810
8234
|
};
|
|
6811
8235
|
BucketListingDeleteJobParams: {
|
|
6812
8236
|
idBucket: number;
|
|
6813
|
-
jobOperationParams: unknown[];
|
|
6814
|
-
jobParams: unknown[];
|
|
6815
8237
|
};
|
|
6816
8238
|
BucketListingUpdateJobParams: {
|
|
6817
|
-
|
|
6818
|
-
|
|
6819
|
-
|
|
6820
|
-
|
|
6821
|
-
|
|
6822
|
-
|
|
6823
|
-
|
|
8239
|
+
idBucket: number;
|
|
8240
|
+
/** @default null */
|
|
8241
|
+
exposureName: string | null;
|
|
8242
|
+
/**
|
|
8243
|
+
* @description Absent when not provided; `null` clears the stored value.
|
|
8244
|
+
* @default null
|
|
8245
|
+
*/
|
|
8246
|
+
exposureDescription: string | null;
|
|
8247
|
+
/** @default null */
|
|
8248
|
+
bigquerySubscribers: string[] | null;
|
|
6824
8249
|
};
|
|
6825
8250
|
UpdateBucketListingRequest: {
|
|
6826
8251
|
/** @description New human-readable exposure name (max 63 bytes). */
|
|
@@ -6839,20 +8264,18 @@ type components = {
|
|
|
6839
8264
|
force: boolean;
|
|
6840
8265
|
/** @default null */
|
|
6841
8266
|
lastChangeDate: string | null;
|
|
6842
|
-
jobOperationParams: unknown[];
|
|
6843
|
-
jobParams: unknown[];
|
|
6844
8267
|
};
|
|
6845
8268
|
RegisterExistingBucketRequest: {
|
|
6846
8269
|
/**
|
|
6847
|
-
* @description
|
|
8270
|
+
* @description Name of the registered bucket in this project.
|
|
6848
8271
|
* @example organizationData
|
|
6849
8272
|
*/
|
|
6850
|
-
name: string;
|
|
8273
|
+
name: string & components['schemas']['StorageName'];
|
|
6851
8274
|
/**
|
|
6852
|
-
* @description
|
|
8275
|
+
* @description Display name shown in the UI; can be changed anytime. Defaults to `name`.
|
|
6853
8276
|
* @example organization-members
|
|
6854
8277
|
*/
|
|
6855
|
-
displayName?: string | null;
|
|
8278
|
+
displayName?: (string & components['schemas']['StorageName']) | null;
|
|
6856
8279
|
/**
|
|
6857
8280
|
* @description Assigns the bucket to one of the stages.
|
|
6858
8281
|
* @default in
|
|
@@ -6931,6 +8354,53 @@ type components = {
|
|
|
6931
8354
|
/** @description Whether to list deleted components instead of active ones. Accepts booleanish values. */
|
|
6932
8355
|
isDeleted?: string | null;
|
|
6933
8356
|
};
|
|
8357
|
+
BatchPurgeJobParams: {
|
|
8358
|
+
configurations: string;
|
|
8359
|
+
};
|
|
8360
|
+
BatchPurgeRequest: {
|
|
8361
|
+
/**
|
|
8362
|
+
* @description Configurations to purge from the trash.
|
|
8363
|
+
* @default []
|
|
8364
|
+
*/
|
|
8365
|
+
configurations: {
|
|
8366
|
+
/**
|
|
8367
|
+
* @description Id of the component.
|
|
8368
|
+
* @example keboola.ex-db-mysql
|
|
8369
|
+
*/
|
|
8370
|
+
componentId: string;
|
|
8371
|
+
/**
|
|
8372
|
+
* @description Id of the configuration.
|
|
8373
|
+
* @example main-1
|
|
8374
|
+
*/
|
|
8375
|
+
configurationId: string;
|
|
8376
|
+
/**
|
|
8377
|
+
* @description Version the configuration was read at. The per-item equivalent of the `If-Match` header of the single-configuration purge: the item is purged only if the configuration is still at this version, otherwise it is reported as failed and the rest of the batch still runs.
|
|
8378
|
+
* @example 5
|
|
8379
|
+
*/
|
|
8380
|
+
version: number;
|
|
8381
|
+
}[];
|
|
8382
|
+
};
|
|
8383
|
+
BatchRestoreJobParams: {
|
|
8384
|
+
configurations: string;
|
|
8385
|
+
};
|
|
8386
|
+
BatchRestoreRequest: {
|
|
8387
|
+
/**
|
|
8388
|
+
* @description Configurations to restore from the trash.
|
|
8389
|
+
* @default []
|
|
8390
|
+
*/
|
|
8391
|
+
configurations: {
|
|
8392
|
+
/**
|
|
8393
|
+
* @description Id of the component.
|
|
8394
|
+
* @example keboola.ex-db-mysql
|
|
8395
|
+
*/
|
|
8396
|
+
componentId: string;
|
|
8397
|
+
/**
|
|
8398
|
+
* @description Id of the configuration.
|
|
8399
|
+
* @example main-1
|
|
8400
|
+
*/
|
|
8401
|
+
configurationId: string;
|
|
8402
|
+
}[];
|
|
8403
|
+
};
|
|
6934
8404
|
CreateConfigurationRequest: {
|
|
6935
8405
|
/**
|
|
6936
8406
|
* @description Configuration name.
|
|
@@ -7329,8 +8799,6 @@ type components = {
|
|
|
7329
8799
|
FileDeleteJobParams: {
|
|
7330
8800
|
branchId: number;
|
|
7331
8801
|
fileId: number;
|
|
7332
|
-
jobOperationParams: unknown[];
|
|
7333
|
-
jobParams: unknown[];
|
|
7334
8802
|
};
|
|
7335
8803
|
ListFilesRequest: {
|
|
7336
8804
|
/**
|
|
@@ -7587,12 +9055,23 @@ type components = {
|
|
|
7587
9055
|
*/
|
|
7588
9056
|
operator: 'eq' | 'ne' | null;
|
|
7589
9057
|
};
|
|
9058
|
+
/** @description Column definition, as stored in the job operation params. */
|
|
9059
|
+
TableColumnAddJobParamsDefinition: {
|
|
9060
|
+
/** @description Backend-specific column data type. Present only for typed-table columns. */
|
|
9061
|
+
type: string;
|
|
9062
|
+
/** @description Column length. Present only for typed-table columns. */
|
|
9063
|
+
length: string;
|
|
9064
|
+
/** @description Whether the column allows NULL values. Present only for typed-table columns. */
|
|
9065
|
+
nullable: boolean;
|
|
9066
|
+
/** @description Default value of the column. Present only for typed-table columns. */
|
|
9067
|
+
default: string;
|
|
9068
|
+
/** @description Column description. */
|
|
9069
|
+
description: string;
|
|
9070
|
+
};
|
|
7590
9071
|
TableColumnAddJobParams: {
|
|
7591
9072
|
name: string;
|
|
7592
9073
|
/** @default null */
|
|
7593
|
-
definition:
|
|
7594
|
-
[key: string]: unknown;
|
|
7595
|
-
} | null;
|
|
9074
|
+
definition: components['schemas']['TableColumnAddJobParamsDefinition'] | null;
|
|
7596
9075
|
/** @default null */
|
|
7597
9076
|
basetype: string | null;
|
|
7598
9077
|
/** @default null */
|
|
@@ -7601,13 +9080,11 @@ type components = {
|
|
|
7601
9080
|
tableStringId: string | null;
|
|
7602
9081
|
/** @default null */
|
|
7603
9082
|
idBucket: number | null;
|
|
7604
|
-
jobParams: unknown[];
|
|
7605
|
-
jobOperationParams: unknown[];
|
|
7606
9083
|
};
|
|
7607
9084
|
/** @description Request for adding a column to a BigQuery table. */
|
|
7608
9085
|
BigqueryAddColumnToTableRequest: {
|
|
7609
9086
|
/** @description Name of the column to add. */
|
|
7610
|
-
name: string;
|
|
9087
|
+
name: string & components['schemas']['StorageColumnName'];
|
|
7611
9088
|
/** @description Column definition for BigQuery. */
|
|
7612
9089
|
definition: {
|
|
7613
9090
|
/** @description BigQuery column type. Must be one of allowed types. */
|
|
@@ -7623,7 +9100,7 @@ type components = {
|
|
|
7623
9100
|
/** @description Request for adding a column to a Snowflake table. */
|
|
7624
9101
|
SnowflakeAddColumnToTableRequest: {
|
|
7625
9102
|
/** @description Name of the column to add. */
|
|
7626
|
-
name: string;
|
|
9103
|
+
name: string & components['schemas']['StorageColumnName'];
|
|
7627
9104
|
/** @description Column definition for Snowflake. */
|
|
7628
9105
|
definition: {
|
|
7629
9106
|
/** @description Snowflake column type. Must be one of allowed types. */
|
|
@@ -7639,7 +9116,7 @@ type components = {
|
|
|
7639
9116
|
/** @description Request for adding a column to a table. */
|
|
7640
9117
|
ColumnCreateRequest: {
|
|
7641
9118
|
/** @description Name of the column to add. */
|
|
7642
|
-
name: string;
|
|
9119
|
+
name: string & components['schemas']['StorageColumnName'];
|
|
7643
9120
|
/** @description Column definition. For untyped tables only "description" is allowed. */
|
|
7644
9121
|
definition?: {
|
|
7645
9122
|
/** @description Column description. */
|
|
@@ -7648,25 +9125,37 @@ type components = {
|
|
|
7648
9125
|
};
|
|
7649
9126
|
TableColumnDeleteJobParams: {
|
|
7650
9127
|
name: string;
|
|
9128
|
+
/** @default null */
|
|
9129
|
+
tableStringId: string | null;
|
|
9130
|
+
/** @default null */
|
|
9131
|
+
idBucket: number | null;
|
|
7651
9132
|
/** @default false */
|
|
7652
9133
|
force: boolean;
|
|
7653
9134
|
/** @default null */
|
|
7654
9135
|
backendConfiguration: components['schemas']['BackendConfigurationJobParams'] | null;
|
|
7655
|
-
|
|
7656
|
-
|
|
9136
|
+
};
|
|
9137
|
+
/** @description Column definition patch carried by the tableColumnDefinitionUpdate job. */
|
|
9138
|
+
TableColumnsDefinitionUpdateColumnDefinition: {
|
|
9139
|
+
/**
|
|
9140
|
+
* @description New column length.
|
|
9141
|
+
* @example 10
|
|
9142
|
+
*/
|
|
9143
|
+
length: string;
|
|
9144
|
+
/** @description Whether the column becomes nullable. */
|
|
9145
|
+
nullable: boolean;
|
|
9146
|
+
/** @description New column default. */
|
|
9147
|
+
default?: string | null;
|
|
9148
|
+
/** @description New column description. */
|
|
9149
|
+
description?: string | null;
|
|
9150
|
+
/** @description True when the request sent `default: null`, asking for the existing default to be dropped. */
|
|
9151
|
+
removeDefault: boolean;
|
|
7657
9152
|
};
|
|
7658
9153
|
TableColumnsDefinitionUpdateJobParams: {
|
|
7659
9154
|
branchId: number;
|
|
7660
9155
|
idBucket: number;
|
|
7661
9156
|
tableStringId: string;
|
|
7662
9157
|
columnName: string;
|
|
7663
|
-
columnDefinition:
|
|
7664
|
-
jobParams: {
|
|
7665
|
-
[key: string]: unknown;
|
|
7666
|
-
};
|
|
7667
|
-
jobOperationParams: {
|
|
7668
|
-
[key: string]: unknown;
|
|
7669
|
-
};
|
|
9158
|
+
columnDefinition: components['schemas']['TableColumnsDefinitionUpdateColumnDefinition'];
|
|
7670
9159
|
};
|
|
7671
9160
|
/** @description Request for updating the definition of a Snowflake table column. */
|
|
7672
9161
|
SnowflakeColumnsDefinitionUpdateRequest: {
|
|
@@ -7690,28 +9179,134 @@ type components = {
|
|
|
7690
9179
|
/** @description New column description, stored as table metadata. */
|
|
7691
9180
|
description?: string | null;
|
|
7692
9181
|
};
|
|
9182
|
+
/** @description A single row filter for row deletion, joined with other filters by AND. */
|
|
9183
|
+
WhereFiltersDeleteRowsObject: {
|
|
9184
|
+
/** @description Column to filter by. */
|
|
9185
|
+
column: string;
|
|
9186
|
+
/**
|
|
9187
|
+
* @description `eq`/`ne` support multiple `values` (IN/NOT IN semantics); `gt`/`ge`/`lt`/`le` accept a single value only.
|
|
9188
|
+
* @default eq
|
|
9189
|
+
* @enum {string}
|
|
9190
|
+
*/
|
|
9191
|
+
operator: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
|
|
9192
|
+
/** @description Values to compare against. Mutually exclusive with `valuesByTableInWorkspace`. */
|
|
9193
|
+
values?: string[] | null;
|
|
9194
|
+
/** @description Cast the column to this data type before comparing (e.g. `INTEGER`, `DOUBLE`, `BIGINT`, `REAL`, `DECIMAL` on Snowflake; backend-specific choices on BigQuery). */
|
|
9195
|
+
dataType?: string | null;
|
|
9196
|
+
/**
|
|
9197
|
+
* @description How `values` are interpreted. `SCALAR` compares raw values; `TIME_STRING` interprets them as date/time strings or unix timestamps.
|
|
9198
|
+
* @default SCALAR
|
|
9199
|
+
* @enum {string}
|
|
9200
|
+
*/
|
|
9201
|
+
type: 'SCALAR' | 'TIME_STRING';
|
|
9202
|
+
/** @description Filter by the current values of a column in a workspace table instead of a literal list. Mutually exclusive with `values`. */
|
|
9203
|
+
valuesByTableInWorkspace?: {
|
|
9204
|
+
/** @description Workspace ID holding the comparison table. */
|
|
9205
|
+
workspaceId?: number;
|
|
9206
|
+
/** @description Name of the comparison table inside the workspace. */
|
|
9207
|
+
table?: string;
|
|
9208
|
+
/** @description Column in the comparison table whose values are used. */
|
|
9209
|
+
column?: string;
|
|
9210
|
+
} | null;
|
|
9211
|
+
};
|
|
9212
|
+
/** @description The delete-rows request, as stored in the job operation params. */
|
|
9213
|
+
TableRowsDeleteJobParamsRequest: {
|
|
9214
|
+
/** @description Never populated by the current request mapping; always null on the wire. */
|
|
9215
|
+
changedSince?: string | null;
|
|
9216
|
+
/** @description Never populated by the current request mapping; always null on the wire. */
|
|
9217
|
+
changedUntil?: string | null;
|
|
9218
|
+
/** @description Row filters, joined by AND; null when no filters were given. */
|
|
9219
|
+
whereFilters?: components['schemas']['WhereFiltersDeleteRowsObject'][] | null;
|
|
9220
|
+
/** @description Whether the table may be truncated when no filters narrow the deletion. */
|
|
9221
|
+
allowTruncate: boolean;
|
|
9222
|
+
};
|
|
7693
9223
|
TableRowsDeleteJobParams: {
|
|
7694
|
-
request:
|
|
7695
|
-
[key: string]: unknown;
|
|
7696
|
-
};
|
|
9224
|
+
request: components['schemas']['TableRowsDeleteJobParamsRequest'];
|
|
7697
9225
|
/** @default null */
|
|
7698
9226
|
backendConfiguration: components['schemas']['BackendConfigurationJobParams'] | null;
|
|
7699
9227
|
/** @default null */
|
|
7700
9228
|
tableStringId: string | null;
|
|
7701
9229
|
/** @default null */
|
|
7702
9230
|
idBucket: number | null;
|
|
7703
|
-
|
|
7704
|
-
|
|
9231
|
+
};
|
|
9232
|
+
/** @description A single row filter; multiple filters are joined by AND. */
|
|
9233
|
+
WhereFiltersObject: {
|
|
9234
|
+
/** @description Column to filter by. */
|
|
9235
|
+
column: string;
|
|
9236
|
+
/**
|
|
9237
|
+
* @description `eq`/`ne` support multiple `values` (IN/NOT IN semantics); `gt`/`ge`/`lt`/`le` accept a single value only.
|
|
9238
|
+
* @default eq
|
|
9239
|
+
* @enum {string}
|
|
9240
|
+
*/
|
|
9241
|
+
operator: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
|
|
9242
|
+
/** @description Values to compare against. */
|
|
9243
|
+
values: string[];
|
|
9244
|
+
/** @description Cast the column to this data type before comparing (e.g. `INTEGER`, `DOUBLE`, `BIGINT`, `REAL`, `DECIMAL` on Snowflake; backend-specific choices on BigQuery). Required for `gt`/`ge`/`lt`/`le` on numeric values; must be empty or `TIMESTAMP` when `type` is `TIME_STRING`. */
|
|
9245
|
+
dataType?: string | null;
|
|
9246
|
+
/**
|
|
9247
|
+
* @description How `values` are interpreted. `SCALAR` compares raw values; `TIME_STRING` interprets them as date/time strings or unix timestamps.
|
|
9248
|
+
* @default SCALAR
|
|
9249
|
+
* @enum {string}
|
|
9250
|
+
*/
|
|
9251
|
+
type: 'SCALAR' | 'TIME_STRING';
|
|
9252
|
+
};
|
|
9253
|
+
/** @description A single sort condition. */
|
|
9254
|
+
OrderByObject: {
|
|
9255
|
+
/** @description Column to sort by. */
|
|
9256
|
+
column: string;
|
|
9257
|
+
/**
|
|
9258
|
+
* @description Sort direction.
|
|
9259
|
+
* @default ASC
|
|
9260
|
+
* @enum {string}
|
|
9261
|
+
*/
|
|
9262
|
+
order: 'ASC' | 'DESC';
|
|
9263
|
+
/** @description Cast the column to this data type before sorting (e.g. `INTEGER`, `DOUBLE`, `BIGINT`, `REAL`, `DECIMAL` on Snowflake; backend-specific choices on BigQuery). Required when sorting a numeric column; disallowed for typed tables. */
|
|
9264
|
+
dataType?: string | null;
|
|
9265
|
+
};
|
|
9266
|
+
/** @description Resolved export options, as stored in the job operation params. */
|
|
9267
|
+
TableExportJobParamsExport: {
|
|
9268
|
+
/** @description Name of the exported table. */
|
|
9269
|
+
tableName: string;
|
|
9270
|
+
/** @description Columns to export; empty when all columns are exported. */
|
|
9271
|
+
columns: string[];
|
|
9272
|
+
/** @description Row limit. */
|
|
9273
|
+
limit?: number | null;
|
|
9274
|
+
/** @description Unix timestamp; export only rows imported since this time. */
|
|
9275
|
+
changedSince?: number | null;
|
|
9276
|
+
/** @description Unix timestamp; export only rows imported until this time. */
|
|
9277
|
+
changedUntil?: number | null;
|
|
9278
|
+
/** @description Whether the exported file is gzipped. */
|
|
9279
|
+
gzipOutput: boolean;
|
|
9280
|
+
/**
|
|
9281
|
+
* @description Output format.
|
|
9282
|
+
* @enum {string}
|
|
9283
|
+
*/
|
|
9284
|
+
format: 'rfc' | 'json';
|
|
9285
|
+
/** @description Resolved row filters. */
|
|
9286
|
+
whereFilters: components['schemas']['WhereFiltersObject'][];
|
|
9287
|
+
/** @description Resolved sort conditions. */
|
|
9288
|
+
orderBy: components['schemas']['OrderByObject'][];
|
|
9289
|
+
/** @description Fulltext search key. */
|
|
9290
|
+
fulltextSearch?: string | null;
|
|
9291
|
+
/** @description Whether the internal `_timestamp` column is included in the export. */
|
|
9292
|
+
includeInternalTimestamp: boolean;
|
|
9293
|
+
/**
|
|
9294
|
+
* @description File type created in File Storage.
|
|
9295
|
+
* @enum {string}
|
|
9296
|
+
*/
|
|
9297
|
+
fileType: 'csv' | 'parquet';
|
|
9298
|
+
/** @description IANA timezone the Snowflake session was set to for the export; present only when set. */
|
|
9299
|
+
timezone?: string | null;
|
|
7705
9300
|
};
|
|
7706
9301
|
TableExportJobParams: {
|
|
7707
9302
|
destinationBranchId: number;
|
|
7708
|
-
export:
|
|
7709
|
-
|
|
7710
|
-
|
|
9303
|
+
export: components['schemas']['TableExportJobParamsExport'];
|
|
9304
|
+
/** @default null */
|
|
9305
|
+
tableStringId: string | null;
|
|
9306
|
+
/** @default null */
|
|
9307
|
+
idBucket: number | null;
|
|
7711
9308
|
/** @default null */
|
|
7712
9309
|
backendConfiguration: components['schemas']['BackendConfigurationJobParams'] | null;
|
|
7713
|
-
jobParams: unknown[];
|
|
7714
|
-
jobOperationParams: unknown[];
|
|
7715
9310
|
};
|
|
7716
9311
|
/** @description Parameters for an asynchronous table export. */
|
|
7717
9312
|
ExportTableRequest: {
|
|
@@ -7860,11 +9455,13 @@ type components = {
|
|
|
7860
9455
|
TablePrimaryKeyAddJobParams: {
|
|
7861
9456
|
columns: string[];
|
|
7862
9457
|
/** @default null */
|
|
9458
|
+
tableStringId: string | null;
|
|
9459
|
+
/** @default null */
|
|
9460
|
+
idBucket: number | null;
|
|
9461
|
+
/** @default null */
|
|
7863
9462
|
skipDuplicatesCheck: boolean | null;
|
|
7864
9463
|
/** @default null */
|
|
7865
9464
|
backendConfiguration: components['schemas']['BackendConfigurationJobParams'] | null;
|
|
7866
|
-
jobParams: unknown[];
|
|
7867
|
-
jobOperationParams: unknown[];
|
|
7868
9465
|
};
|
|
7869
9466
|
/** @description Request for creating a table primary key. */
|
|
7870
9467
|
CreatePrimaryKeyRequest: {
|
|
@@ -7887,8 +9484,6 @@ type components = {
|
|
|
7887
9484
|
tableStringId: string | null;
|
|
7888
9485
|
/** @default null */
|
|
7889
9486
|
idBucket: number | null;
|
|
7890
|
-
jobParams: unknown[];
|
|
7891
|
-
jobOperationParams: unknown[];
|
|
7892
9487
|
};
|
|
7893
9488
|
TableSnapshotCreateJobParams: {
|
|
7894
9489
|
/** @default null */
|
|
@@ -7899,8 +9494,6 @@ type components = {
|
|
|
7899
9494
|
tableStringId: string | null;
|
|
7900
9495
|
/** @default null */
|
|
7901
9496
|
idBucket: number | null;
|
|
7902
|
-
jobParams: unknown[];
|
|
7903
|
-
jobOperationParams: unknown[];
|
|
7904
9497
|
};
|
|
7905
9498
|
CreateSnapshotRequest: {
|
|
7906
9499
|
/**
|
|
@@ -8024,10 +9617,10 @@ type components = {
|
|
|
8024
9617
|
* @enum {string|null}
|
|
8025
9618
|
*/
|
|
8026
9619
|
format: 'rfc' | 'json' | null;
|
|
8027
|
-
/** @description Row filters
|
|
8028
|
-
whereFilters?:
|
|
8029
|
-
/** @description Sort specification
|
|
8030
|
-
orderBy?:
|
|
9620
|
+
/** @description Row filters (see the asynchronous export for the filter description). Sent as `whereFilters[0][column]=...`. */
|
|
9621
|
+
whereFilters?: components['schemas']['WhereFiltersObject'][] | null;
|
|
9622
|
+
/** @description Sort specification. Sent as `orderBy[0][column]=...`. */
|
|
9623
|
+
orderBy?: components['schemas']['OrderByObject'][] | null;
|
|
8031
9624
|
/**
|
|
8032
9625
|
* @description Fulltext search over all data in the table. Cannot be combined with `whereFilters`. Snowflake/BigQuery only.
|
|
8033
9626
|
* @example czech
|
|
@@ -8040,27 +9633,47 @@ type components = {
|
|
|
8040
9633
|
*/
|
|
8041
9634
|
cache: boolean;
|
|
8042
9635
|
};
|
|
9636
|
+
/** @description A single column patch, as stored in the job operation params. */
|
|
9637
|
+
TableDefinitionUpdateColumnObject: {
|
|
9638
|
+
/** @description Name of the column being patched. */
|
|
9639
|
+
name: string;
|
|
9640
|
+
/** @description New length of the column type. Present only when supplied. */
|
|
9641
|
+
length: string;
|
|
9642
|
+
/** @description New nullable flag. Present only when `nullableSet` is true. */
|
|
9643
|
+
nullable?: boolean | null;
|
|
9644
|
+
/** @description Whether `nullable` was explicitly supplied (including an explicit null). */
|
|
9645
|
+
nullableSet: boolean;
|
|
9646
|
+
/** @description New default value. Present only when `defaultSet` is true. */
|
|
9647
|
+
default?: string | null;
|
|
9648
|
+
/** @description Whether `default` was explicitly supplied (including an explicit null). */
|
|
9649
|
+
defaultSet: boolean;
|
|
9650
|
+
/** @description New column description. Present only when `descriptionSet` is true. */
|
|
9651
|
+
description?: string | null;
|
|
9652
|
+
/** @description Whether `description` was explicitly supplied (including an explicit null). */
|
|
9653
|
+
descriptionSet: boolean;
|
|
9654
|
+
};
|
|
8043
9655
|
TableDefinitionUpdateJobParams: {
|
|
8044
9656
|
branchId: number;
|
|
8045
9657
|
idBucket: number;
|
|
8046
9658
|
tableStringId: string;
|
|
8047
|
-
|
|
8048
|
-
|
|
8049
|
-
|
|
8050
|
-
|
|
8051
|
-
|
|
8052
|
-
/** @default null */
|
|
9659
|
+
columns: components['schemas']['TableDefinitionUpdateColumnObject'][];
|
|
9660
|
+
/**
|
|
9661
|
+
* @description Absent when not provided; `null` clears the stored value.
|
|
9662
|
+
* @default null
|
|
9663
|
+
*/
|
|
8053
9664
|
displayName: string | null;
|
|
8054
|
-
/**
|
|
9665
|
+
/**
|
|
9666
|
+
* @description Absent when not provided; `null` clears the stored value.
|
|
9667
|
+
* @default null
|
|
9668
|
+
*/
|
|
8055
9669
|
description: string | null;
|
|
8056
|
-
|
|
8057
|
-
|
|
8058
|
-
|
|
8059
|
-
|
|
8060
|
-
|
|
8061
|
-
|
|
8062
|
-
|
|
8063
|
-
};
|
|
9670
|
+
/**
|
|
9671
|
+
* @description Absent when not provided; `null` clears the stored value.
|
|
9672
|
+
* @default null
|
|
9673
|
+
*/
|
|
9674
|
+
isDescriptionSystemManaged: boolean | null;
|
|
9675
|
+
/** @default null */
|
|
9676
|
+
backendConfiguration: components['schemas']['BackendConfigurationJobParams'] | null;
|
|
8064
9677
|
};
|
|
8065
9678
|
/** @description At least one table or column patch must be provided. */
|
|
8066
9679
|
TableDefinitionUpdateRequest: {
|
|
@@ -8068,7 +9681,7 @@ type components = {
|
|
|
8068
9681
|
* @description New table display name. Omit to keep unchanged; must not be blank.
|
|
8069
9682
|
* @example Orders
|
|
8070
9683
|
*/
|
|
8071
|
-
displayName: string;
|
|
9684
|
+
displayName: string & components['schemas']['StorageName'];
|
|
8072
9685
|
/**
|
|
8073
9686
|
* @description Table description; null or an empty string clears the description.
|
|
8074
9687
|
* @example Orders fact table
|
|
@@ -8108,8 +9721,6 @@ type components = {
|
|
|
8108
9721
|
branchId: number | null;
|
|
8109
9722
|
/** @default null */
|
|
8110
9723
|
apiVersion: string | null;
|
|
8111
|
-
jobParams: unknown[];
|
|
8112
|
-
jobOperationParams: unknown[];
|
|
8113
9724
|
};
|
|
8114
9725
|
/** @description Query parameters for listing table events. */
|
|
8115
9726
|
TableEventsListRequest: {
|
|
@@ -8142,8 +9753,12 @@ type components = {
|
|
|
8142
9753
|
};
|
|
8143
9754
|
SwapJobParams: {
|
|
8144
9755
|
targetTableStringId: string;
|
|
8145
|
-
|
|
8146
|
-
|
|
9756
|
+
/** @default null */
|
|
9757
|
+
tableStringId: string | null;
|
|
9758
|
+
/** @default null */
|
|
9759
|
+
branchId: number | null;
|
|
9760
|
+
/** @default null */
|
|
9761
|
+
apiVersion: string | null;
|
|
8147
9762
|
};
|
|
8148
9763
|
TableSwapRequest: {
|
|
8149
9764
|
/**
|
|
@@ -8152,6 +9767,124 @@ type components = {
|
|
|
8152
9767
|
*/
|
|
8153
9768
|
targetTableId: string;
|
|
8154
9769
|
};
|
|
9770
|
+
/** @description Table properties to update, as stored in the job operation params. */
|
|
9771
|
+
TableUpdateJobParamsValues: {
|
|
9772
|
+
/** @description New display name of the table. */
|
|
9773
|
+
displayName: string;
|
|
9774
|
+
};
|
|
9775
|
+
TableUpdateJobParams: {
|
|
9776
|
+
values: components['schemas']['TableUpdateJobParamsValues'];
|
|
9777
|
+
/** @default null */
|
|
9778
|
+
tableStringId: string | null;
|
|
9779
|
+
/** @default null */
|
|
9780
|
+
idBucket: number | null;
|
|
9781
|
+
};
|
|
9782
|
+
/** @description The updated table with its columns, metadata and bucket payload. Returned only by the deprecated synchronous variant of the endpoint. */
|
|
9783
|
+
TableUpdateResponse: {
|
|
9784
|
+
/** @description Table API URI */
|
|
9785
|
+
uri: string;
|
|
9786
|
+
/** @description Table ID */
|
|
9787
|
+
id: string;
|
|
9788
|
+
/** @description Table name */
|
|
9789
|
+
name: string;
|
|
9790
|
+
/** @description Table display name */
|
|
9791
|
+
displayName: string;
|
|
9792
|
+
/** @description Is transactional */
|
|
9793
|
+
transactional: boolean;
|
|
9794
|
+
/** @description Primary key columns */
|
|
9795
|
+
primaryKey: string[];
|
|
9796
|
+
/** @description Index type */
|
|
9797
|
+
indexType: string | null;
|
|
9798
|
+
/** @description Index key columns */
|
|
9799
|
+
indexKey: string[];
|
|
9800
|
+
/** @description Distribution type */
|
|
9801
|
+
distributionType: string | null;
|
|
9802
|
+
/** @description Distribution key columns */
|
|
9803
|
+
distributionKey: string[];
|
|
9804
|
+
/** @description Synthetic primary key enabled */
|
|
9805
|
+
syntheticPrimaryKeyEnabled: boolean;
|
|
9806
|
+
/**
|
|
9807
|
+
* Format: date-time
|
|
9808
|
+
* @description Created timestamp
|
|
9809
|
+
*/
|
|
9810
|
+
created: string | null;
|
|
9811
|
+
/**
|
|
9812
|
+
* Format: date-time
|
|
9813
|
+
* @description Last import date
|
|
9814
|
+
*/
|
|
9815
|
+
lastImportDate: string | null;
|
|
9816
|
+
/**
|
|
9817
|
+
* Format: date-time
|
|
9818
|
+
* @description Last change date
|
|
9819
|
+
*/
|
|
9820
|
+
lastChangeDate: string | null;
|
|
9821
|
+
/** @description Rows count (null for a filtered alias) */
|
|
9822
|
+
rowsCount: number | null;
|
|
9823
|
+
/** @description Data size in bytes (null for a filtered alias) */
|
|
9824
|
+
dataSizeBytes: number | null;
|
|
9825
|
+
/** @description Is alias */
|
|
9826
|
+
isAlias: boolean;
|
|
9827
|
+
/** @description Is aliasable */
|
|
9828
|
+
isAliasable: boolean;
|
|
9829
|
+
/** @description Is typed table */
|
|
9830
|
+
isTyped: boolean;
|
|
9831
|
+
/** @description Whether the description is managed by the system */
|
|
9832
|
+
isDescriptionSystemManaged: boolean;
|
|
9833
|
+
/** @description Timestamp column type */
|
|
9834
|
+
timestampType: string;
|
|
9835
|
+
/** @description Table type */
|
|
9836
|
+
tableType: string;
|
|
9837
|
+
/** @description Table path */
|
|
9838
|
+
path: string;
|
|
9839
|
+
/** @description Column names */
|
|
9840
|
+
columns: string[];
|
|
9841
|
+
/** @description Metadata entries per column, keyed by column name */
|
|
9842
|
+
columnMetadata: {
|
|
9843
|
+
[key: string]: Record<string, never>[];
|
|
9844
|
+
};
|
|
9845
|
+
/** @description Always an empty array, kept for backward compatibility */
|
|
9846
|
+
attributes: Record<string, never>[];
|
|
9847
|
+
/** @description Table metadata entries */
|
|
9848
|
+
metadata: components['schemas']['MetadataItemResponse'][];
|
|
9849
|
+
bucket: components['schemas']['TableBucketResponse'];
|
|
9850
|
+
/** @description Source table info, present for aliases with a resolved source table. Carries the source table `columnMetadata` when the alias propagates metadata. */
|
|
9851
|
+
sourceTable?: {
|
|
9852
|
+
/** @description Source table ID */
|
|
9853
|
+
id: string;
|
|
9854
|
+
/** @description Source table URI */
|
|
9855
|
+
uri: string;
|
|
9856
|
+
project: {
|
|
9857
|
+
/** @description Project ID */
|
|
9858
|
+
id: number;
|
|
9859
|
+
/** @description Project name */
|
|
9860
|
+
name: string;
|
|
9861
|
+
};
|
|
9862
|
+
/** @description Metadata entries of the root source table, keyed by column name */
|
|
9863
|
+
columnMetadata?: {
|
|
9864
|
+
[key: string]: Record<string, never>[];
|
|
9865
|
+
};
|
|
9866
|
+
} | null;
|
|
9867
|
+
/** @description Alias columns auto sync (for simple aliases) */
|
|
9868
|
+
aliasColumnsAutoSync?: boolean | null;
|
|
9869
|
+
/** @description The filter applied to the alias (for filtered simple aliases) */
|
|
9870
|
+
aliasFilter?: {
|
|
9871
|
+
/** @description Filtered column name */
|
|
9872
|
+
column: string;
|
|
9873
|
+
/** @description Filter operator (eq or ne) */
|
|
9874
|
+
operator: string;
|
|
9875
|
+
/** @description Filter values */
|
|
9876
|
+
values: string[];
|
|
9877
|
+
} | null;
|
|
9878
|
+
/** @description The alias SQL (for custom SQL aliases) */
|
|
9879
|
+
selectSql?: string | null;
|
|
9880
|
+
/** @description Whether the alias is persisted */
|
|
9881
|
+
isPersisted?: boolean | null;
|
|
9882
|
+
};
|
|
9883
|
+
/** @description Table properties to update. The display name is the only updatable property. */
|
|
9884
|
+
TableUpdateRequest: {
|
|
9885
|
+
/** @description New display name of the table. No other table in the same bucket may already use it. */
|
|
9886
|
+
displayName: string & components['schemas']['StorageName'];
|
|
9887
|
+
};
|
|
8155
9888
|
TablesListRequest: {
|
|
8156
9889
|
/** @description Comma-separated list of data to include. Allowed values: attributes, buckets, bucketsWithoutSourceTables, columns, metadata, columnMetadata, sourceMetadata, sourceColumnMetadata. Default: attributes,buckets. */
|
|
8157
9890
|
include?: string | null;
|
|
@@ -8275,10 +10008,10 @@ type components = {
|
|
|
8275
10008
|
};
|
|
8276
10009
|
CreateTriggerRequest: {
|
|
8277
10010
|
/**
|
|
8278
|
-
* @description ID of token
|
|
10011
|
+
* @description ID of the token that runs the configured component. When omitted or `null`, the trigger creates a non-expiring token `[_internal] Token for triggering <configurationId>` and owns it: deleting the trigger, or giving it another token, revokes that token.
|
|
8279
10012
|
* @example 123
|
|
8280
10013
|
*/
|
|
8281
|
-
runWithTokenId
|
|
10014
|
+
runWithTokenId?: number | null;
|
|
8282
10015
|
/**
|
|
8283
10016
|
* @description Component ID of the triggered configuration (typically `orchestration`).
|
|
8284
10017
|
* @example orchestration
|
|
@@ -8317,7 +10050,7 @@ type components = {
|
|
|
8317
10050
|
};
|
|
8318
10051
|
UpdateTriggerRequest: {
|
|
8319
10052
|
/**
|
|
8320
|
-
* @description ID of token
|
|
10053
|
+
* @description ID of the token that runs the configured component. Replacing the token the trigger created for itself revokes that token.
|
|
8321
10054
|
* @example 100
|
|
8322
10055
|
*/
|
|
8323
10056
|
runWithTokenId: number;
|
|
@@ -8346,7 +10079,7 @@ type components = {
|
|
|
8346
10079
|
};
|
|
8347
10080
|
ValidateColumnNamesRequest: {
|
|
8348
10081
|
/**
|
|
8349
|
-
* @description
|
|
10082
|
+
* @description Candidate column names to check against the `StorageColumnName` rule. The items are deliberately plain strings — an invalid candidate is the point of the call.
|
|
8350
10083
|
* @example [
|
|
8351
10084
|
* "First$$Column-Name",
|
|
8352
10085
|
* "Second Column-Name"
|
|
@@ -8433,7 +10166,7 @@ type components = {
|
|
|
8433
10166
|
*/
|
|
8434
10167
|
networkPolicy?: 'system' | 'user' | 'not-defined' | null;
|
|
8435
10168
|
/**
|
|
8436
|
-
* @description Preferred login type. Use "none" to create a workspace without credentials for QueryService. Create direct connection credentials later using the workspace credentials endpoint.
|
|
10169
|
+
* @description Preferred login type. Use "none" to create a workspace without credentials for QueryService. Create direct connection credentials later using the workspace credentials endpoint. For the "snowflake" backend, "default" and "snowflake-legacy-service" are rejected because they resolve to password authentication, which Snowflake no longer supports; use "snowflake-service-keypair" or "snowflake-person-keypair" with "publicKey", or "none".
|
|
8437
10170
|
* @enum {string|null}
|
|
8438
10171
|
*/
|
|
8439
10172
|
loginType?: null | 'default' | 'snowflake-legacy-service' | 'snowflake-person-sso' | 'snowflake-person-keypair' | 'snowflake-service-keypair' | 'none';
|
|
@@ -8689,6 +10422,11 @@ type components = {
|
|
|
8689
10422
|
* @example 123
|
|
8690
10423
|
*/
|
|
8691
10424
|
id?: number | null;
|
|
10425
|
+
/**
|
|
10426
|
+
* Format: date-time
|
|
10427
|
+
* @description Creation time of the organization. Null when the creation time is unavailable.
|
|
10428
|
+
*/
|
|
10429
|
+
created?: string | null;
|
|
8692
10430
|
};
|
|
8693
10431
|
/** @description Administrator the token belongs to. Present only for master tokens. */
|
|
8694
10432
|
admin: {
|
|
@@ -8698,11 +10436,16 @@ type components = {
|
|
|
8698
10436
|
id?: number;
|
|
8699
10437
|
features?: string[];
|
|
8700
10438
|
isOrganizationMember?: boolean;
|
|
8701
|
-
/**
|
|
8702
|
-
|
|
10439
|
+
/**
|
|
10440
|
+
* @description Null when the project membership has no role stored.
|
|
10441
|
+
* @example admin
|
|
10442
|
+
*/
|
|
10443
|
+
role?: string | null;
|
|
8703
10444
|
isActivated?: boolean;
|
|
8704
|
-
/** @description Present only when SAML is enabled on the stack. */
|
|
8705
|
-
samlParameters?:
|
|
10445
|
+
/** @description Raw SAML attribute statement asserted by the IdP on last login, keyed by IdP-defined attribute name (e.g. a role or group claim); attribute names and count vary per IdP configuration. Present only when SAML is enabled on the stack. */
|
|
10446
|
+
samlParameters?: {
|
|
10447
|
+
[key: string]: string[];
|
|
10448
|
+
} | null;
|
|
8706
10449
|
};
|
|
8707
10450
|
/** @description Administrator who owns the token. Present when an owner can be resolved. */
|
|
8708
10451
|
adminOwner: {
|
|
@@ -8718,157 +10461,6 @@ type components = {
|
|
|
8718
10461
|
/** @description Registration guide in Markdown format. */
|
|
8719
10462
|
markdown: string;
|
|
8720
10463
|
};
|
|
8721
|
-
/** @description Single metadata record. */
|
|
8722
|
-
MetadataItemResponse: {
|
|
8723
|
-
/**
|
|
8724
|
-
* @description Metadata record identifier
|
|
8725
|
-
* @example 19509
|
|
8726
|
-
*/
|
|
8727
|
-
id: string;
|
|
8728
|
-
/**
|
|
8729
|
-
* @description Metadata key
|
|
8730
|
-
* @example some-key
|
|
8731
|
-
*/
|
|
8732
|
-
key: string;
|
|
8733
|
-
/**
|
|
8734
|
-
* @description Metadata value
|
|
8735
|
-
* @example Some value
|
|
8736
|
-
*/
|
|
8737
|
-
value: string | null;
|
|
8738
|
-
/**
|
|
8739
|
-
* @description Id of the component that created the metadata
|
|
8740
|
-
* @example test-component
|
|
8741
|
-
*/
|
|
8742
|
-
provider: string;
|
|
8743
|
-
/**
|
|
8744
|
-
* Format: date-time
|
|
8745
|
-
* @description When the metadata was created or last updated
|
|
8746
|
-
* @example 2017-02-13T23:36:10+0100
|
|
8747
|
-
*/
|
|
8748
|
-
timestamp: string;
|
|
8749
|
-
};
|
|
8750
|
-
/** @description Shared bucket as seen from another project (also used as `sourceBucket` of a linked bucket). */
|
|
8751
|
-
SharedBucketResponse: {
|
|
8752
|
-
/**
|
|
8753
|
-
* @description Bucket identifier in the source project.
|
|
8754
|
-
* @example in.c-main
|
|
8755
|
-
*/
|
|
8756
|
-
id: string;
|
|
8757
|
-
/**
|
|
8758
|
-
* @description Bucket name.
|
|
8759
|
-
* @example c-main
|
|
8760
|
-
*/
|
|
8761
|
-
name: string;
|
|
8762
|
-
/**
|
|
8763
|
-
* @description Bucket display name.
|
|
8764
|
-
* @example main
|
|
8765
|
-
*/
|
|
8766
|
-
displayName: string;
|
|
8767
|
-
/**
|
|
8768
|
-
* @description Bucket stage.
|
|
8769
|
-
* @example in
|
|
8770
|
-
* @enum {string}
|
|
8771
|
-
*/
|
|
8772
|
-
stage: 'in' | 'out' | 'sys';
|
|
8773
|
-
/**
|
|
8774
|
-
* @description Bucket description.
|
|
8775
|
-
* @example Organization shared data
|
|
8776
|
-
*/
|
|
8777
|
-
description: string;
|
|
8778
|
-
/**
|
|
8779
|
-
* @description Sharing type.
|
|
8780
|
-
* @example organization-project
|
|
8781
|
-
* @enum {string|null}
|
|
8782
|
-
*/
|
|
8783
|
-
sharing?: 'organization' | 'organization-project' | 'specific-projects' | 'specific-users' | null;
|
|
8784
|
-
/**
|
|
8785
|
-
* Format: date-time
|
|
8786
|
-
* @example 2020-01-12T18:28:31+0100
|
|
8787
|
-
*/
|
|
8788
|
-
created: string;
|
|
8789
|
-
/**
|
|
8790
|
-
* Format: date-time
|
|
8791
|
-
* @example 2020-01-12T18:31:49+0100
|
|
8792
|
-
*/
|
|
8793
|
-
lastChangeDate?: string | null;
|
|
8794
|
-
/** @example 1536 */
|
|
8795
|
-
dataSizeBytes: number;
|
|
8796
|
-
/** @example 32 */
|
|
8797
|
-
rowsCount: number;
|
|
8798
|
-
/**
|
|
8799
|
-
* @example snowflake
|
|
8800
|
-
* @enum {string}
|
|
8801
|
-
*/
|
|
8802
|
-
backend: 'snowflake' | 'bigquery';
|
|
8803
|
-
/**
|
|
8804
|
-
* @description Whether the bucket is an external (registered) bucket.
|
|
8805
|
-
* @example false
|
|
8806
|
-
*/
|
|
8807
|
-
hasExternalSchema: boolean;
|
|
8808
|
-
/**
|
|
8809
|
-
* @description Database name of an external bucket.
|
|
8810
|
-
* @example null
|
|
8811
|
-
*/
|
|
8812
|
-
databaseName?: string | null;
|
|
8813
|
-
/**
|
|
8814
|
-
* @description Dot-separated path of the bucket on the backend.
|
|
8815
|
-
* @example database_name.c-main
|
|
8816
|
-
*/
|
|
8817
|
-
path: string;
|
|
8818
|
-
/** @description Project owning the bucket. */
|
|
8819
|
-
project: {
|
|
8820
|
-
/** @example 123 */
|
|
8821
|
-
id?: number;
|
|
8822
|
-
/** @example Project name */
|
|
8823
|
-
name?: string;
|
|
8824
|
-
};
|
|
8825
|
-
/** @example null */
|
|
8826
|
-
color?: string | null;
|
|
8827
|
-
/** @description Tables in the shared bucket (filtered aliases are omitted). */
|
|
8828
|
-
tables: {
|
|
8829
|
-
/** @example in.c-main.languages */
|
|
8830
|
-
id?: string;
|
|
8831
|
-
/** @example languages */
|
|
8832
|
-
name?: string;
|
|
8833
|
-
/** @example languages-display-name */
|
|
8834
|
-
displayName?: string;
|
|
8835
|
-
/**
|
|
8836
|
-
* @description Dot-separated path of the table on the backend.
|
|
8837
|
-
* @example database_name.c-main.languages
|
|
8838
|
-
*/
|
|
8839
|
-
path?: string;
|
|
8840
|
-
}[];
|
|
8841
|
-
/**
|
|
8842
|
-
* @description Sharing parameters.
|
|
8843
|
-
* @example []
|
|
8844
|
-
*/
|
|
8845
|
-
sharingParameters: {
|
|
8846
|
-
[key: string]: Record<string, never>;
|
|
8847
|
-
};
|
|
8848
|
-
/** @description Token that shared the bucket. */
|
|
8849
|
-
sharedBy: {
|
|
8850
|
-
/** @example 5 */
|
|
8851
|
-
id?: number | null;
|
|
8852
|
-
/** @example dev@keboola.com */
|
|
8853
|
-
name?: string | null;
|
|
8854
|
-
/**
|
|
8855
|
-
* Format: date-time
|
|
8856
|
-
* @example 2020-02-03T14:58:29+0100
|
|
8857
|
-
*/
|
|
8858
|
-
date?: string | null;
|
|
8859
|
-
};
|
|
8860
|
-
/** @description Bucket owner; `null` when no owner is set. */
|
|
8861
|
-
owner?: {
|
|
8862
|
-
/** @example 123 */
|
|
8863
|
-
id?: number;
|
|
8864
|
-
/** @example Jan Developer */
|
|
8865
|
-
name?: string;
|
|
8866
|
-
/** @example jan.dev@keboola.com */
|
|
8867
|
-
email?: string;
|
|
8868
|
-
} | null;
|
|
8869
|
-
/** @description Bucket metadata. Present only when `include` contains `metadata`. */
|
|
8870
|
-
metadata: components['schemas']['MetadataItemResponse'][];
|
|
8871
|
-
};
|
|
8872
10464
|
/** @description Bucket object as returned by the create and link endpoints. */
|
|
8873
10465
|
BucketCreateResponse: {
|
|
8874
10466
|
/**
|
|
@@ -9062,260 +10654,6 @@ type components = {
|
|
|
9062
10654
|
};
|
|
9063
10655
|
}[];
|
|
9064
10656
|
};
|
|
9065
|
-
/** @description Scheduled task attached to a bucket. */
|
|
9066
|
-
ScheduledTaskResponse: {
|
|
9067
|
-
/**
|
|
9068
|
-
* Format: uuid
|
|
9069
|
-
* @description Identifier of the scheduled task.
|
|
9070
|
-
* @example 0197e22b-379d-7c62-bc6d-88e50c3d0c75
|
|
9071
|
-
*/
|
|
9072
|
-
uuid: string;
|
|
9073
|
-
/**
|
|
9074
|
-
* @description Job the task runs.
|
|
9075
|
-
* @example bucketRefresh
|
|
9076
|
-
* @enum {string}
|
|
9077
|
-
*/
|
|
9078
|
-
job: 'bucketRefresh';
|
|
9079
|
-
/**
|
|
9080
|
-
* @description Type of the entity the task is attached to.
|
|
9081
|
-
* @example bucket
|
|
9082
|
-
* @enum {string}
|
|
9083
|
-
*/
|
|
9084
|
-
relatedEntity: 'bucket';
|
|
9085
|
-
/**
|
|
9086
|
-
* @description Identifier of the related entity (bucket ID).
|
|
9087
|
-
* @example in.c-bucket-name
|
|
9088
|
-
*/
|
|
9089
|
-
relatedId: string;
|
|
9090
|
-
/**
|
|
9091
|
-
* @description Cron expression of the schedule.
|
|
9092
|
-
* @example 42 13 * * *
|
|
9093
|
-
*/
|
|
9094
|
-
cronExpression: string;
|
|
9095
|
-
/**
|
|
9096
|
-
* Format: date-time
|
|
9097
|
-
* @description Creation timestamp of the task.
|
|
9098
|
-
* @example 2025-07-01T00:08:00+02:00
|
|
9099
|
-
*/
|
|
9100
|
-
createdAt: string;
|
|
9101
|
-
};
|
|
9102
|
-
BigQueryBucketListingDetailResponse: {
|
|
9103
|
-
/** @description User-defined listing ID (unique within the exchange). */
|
|
9104
|
-
listingId: string;
|
|
9105
|
-
/** @description GCP listing resource name. Omitted from the response when the listing has not yet been provisioned (the async job is still running or has failed). */
|
|
9106
|
-
listingResourceName?: string | null;
|
|
9107
|
-
/** @description IAM principals with subscriber access (each prefixed with `user:` or `group:`). */
|
|
9108
|
-
subscribers: string[];
|
|
9109
|
-
};
|
|
9110
|
-
BucketListingDetailResponse: {
|
|
9111
|
-
/** @description Human-readable listing name (used as the backend listing displayName). */
|
|
9112
|
-
name: string;
|
|
9113
|
-
/** @description Listing description. Omitted from the response when not set. */
|
|
9114
|
-
description?: string | null;
|
|
9115
|
-
/**
|
|
9116
|
-
* @description Backend of the listed bucket.
|
|
9117
|
-
* @enum {string}
|
|
9118
|
-
*/
|
|
9119
|
-
backend: 'bigquery';
|
|
9120
|
-
/** @description BigQuery-specific listing details. Present only for BigQuery buckets. */
|
|
9121
|
-
bigquery?: components['schemas']['BigQueryBucketListingDetailResponse'] | null;
|
|
9122
|
-
/**
|
|
9123
|
-
* Format: date-time
|
|
9124
|
-
* @description Listing creation timestamp.
|
|
9125
|
-
*/
|
|
9126
|
-
createdAt: string;
|
|
9127
|
-
};
|
|
9128
|
-
/** @description Bucket detail: the bucket object extended with metadata, tables, scheduled tasks, listing and links. */
|
|
9129
|
-
BucketDetailResponse: {
|
|
9130
|
-
/**
|
|
9131
|
-
* @description API URI of the bucket.
|
|
9132
|
-
* @example https://connection.keboola.com/v2/storage/buckets/in.c-my-new-bucket
|
|
9133
|
-
*/
|
|
9134
|
-
uri: string;
|
|
9135
|
-
/**
|
|
9136
|
-
* @description Bucket identifier (`{stage}.{name}`).
|
|
9137
|
-
* @example in.c-my-new-bucket
|
|
9138
|
-
*/
|
|
9139
|
-
id: string;
|
|
9140
|
-
/**
|
|
9141
|
-
* @description Bucket name (prefixed with `c-`).
|
|
9142
|
-
* @example c-my-new-bucket
|
|
9143
|
-
*/
|
|
9144
|
-
name: string;
|
|
9145
|
-
/**
|
|
9146
|
-
* @description Human-readable display name shown in the UI.
|
|
9147
|
-
* @example my-new-bucket
|
|
9148
|
-
*/
|
|
9149
|
-
displayName: string;
|
|
9150
|
-
/**
|
|
9151
|
-
* @description ID of the branch the bucket belongs to.
|
|
9152
|
-
* @example 1234
|
|
9153
|
-
*/
|
|
9154
|
-
idBranch: number;
|
|
9155
|
-
/**
|
|
9156
|
-
* @description Bucket stage.
|
|
9157
|
-
* @example in
|
|
9158
|
-
* @enum {string}
|
|
9159
|
-
*/
|
|
9160
|
-
stage: 'in' | 'out' | 'sys';
|
|
9161
|
-
/**
|
|
9162
|
-
* @description Bucket description.
|
|
9163
|
-
* @example Some Description
|
|
9164
|
-
*/
|
|
9165
|
-
description: string;
|
|
9166
|
-
/** @description Tables in the bucket. Each item is a table object as returned by the table list; columns, metadata and column metadata are added according to `include`. */
|
|
9167
|
-
tables: Record<string, never>[];
|
|
9168
|
-
/**
|
|
9169
|
-
* Format: date-time
|
|
9170
|
-
* @description Creation timestamp.
|
|
9171
|
-
* @example 2017-02-13T12:01:05+0100
|
|
9172
|
-
*/
|
|
9173
|
-
created: string;
|
|
9174
|
-
/**
|
|
9175
|
-
* Format: date-time
|
|
9176
|
-
* @description Timestamp of the last data change in the bucket.
|
|
9177
|
-
* @example null
|
|
9178
|
-
*/
|
|
9179
|
-
lastChangeDate?: string | null;
|
|
9180
|
-
/**
|
|
9181
|
-
* Format: date-time
|
|
9182
|
-
* @description Timestamp of the last bucket update.
|
|
9183
|
-
* @example 2024-11-28T13:03:13+0100
|
|
9184
|
-
*/
|
|
9185
|
-
updated?: string | null;
|
|
9186
|
-
/**
|
|
9187
|
-
* @description Whether the bucket is read-only (linked or external buckets).
|
|
9188
|
-
* @example false
|
|
9189
|
-
*/
|
|
9190
|
-
isReadOnly: boolean;
|
|
9191
|
-
/**
|
|
9192
|
-
* @description Total data size in bytes.
|
|
9193
|
-
* @example 0
|
|
9194
|
-
*/
|
|
9195
|
-
dataSizeBytes: number;
|
|
9196
|
-
/**
|
|
9197
|
-
* @description Total number of rows.
|
|
9198
|
-
* @example 0
|
|
9199
|
-
*/
|
|
9200
|
-
rowsCount: number;
|
|
9201
|
-
/**
|
|
9202
|
-
* @description Whether the bucket is in maintenance mode.
|
|
9203
|
-
* @example false
|
|
9204
|
-
*/
|
|
9205
|
-
isMaintenance: boolean;
|
|
9206
|
-
/**
|
|
9207
|
-
* @description Storage backend of the bucket.
|
|
9208
|
-
* @example snowflake
|
|
9209
|
-
* @enum {string}
|
|
9210
|
-
*/
|
|
9211
|
-
backend: 'snowflake' | 'bigquery';
|
|
9212
|
-
/**
|
|
9213
|
-
* @description Sharing type of the bucket; `null` when the bucket is not shared.
|
|
9214
|
-
* @example null
|
|
9215
|
-
* @enum {string|null}
|
|
9216
|
-
*/
|
|
9217
|
-
sharing?: 'organization' | 'organization-project' | 'specific-projects' | 'specific-users' | null;
|
|
9218
|
-
/**
|
|
9219
|
-
* @description Whether the bucket is an external (registered) bucket.
|
|
9220
|
-
* @example false
|
|
9221
|
-
*/
|
|
9222
|
-
hasExternalSchema: boolean;
|
|
9223
|
-
/**
|
|
9224
|
-
* @description Database name of an external bucket.
|
|
9225
|
-
* @example null
|
|
9226
|
-
*/
|
|
9227
|
-
databaseName?: string | null;
|
|
9228
|
-
/**
|
|
9229
|
-
* @description Dot-separated path of the bucket on the backend.
|
|
9230
|
-
* @example database_name.c-my-new-bucket
|
|
9231
|
-
*/
|
|
9232
|
-
path: string;
|
|
9233
|
-
/**
|
|
9234
|
-
* @description Whether the external bucket uses a Snowflake Secure Data Share.
|
|
9235
|
-
* @example false
|
|
9236
|
-
*/
|
|
9237
|
-
isSnowflakeSharedDatabase: boolean;
|
|
9238
|
-
/**
|
|
9239
|
-
* @description Whether this bucket is linked from another project.
|
|
9240
|
-
* @example false
|
|
9241
|
-
*/
|
|
9242
|
-
isLinkedBucket: boolean;
|
|
9243
|
-
/**
|
|
9244
|
-
* @description CSS color of the bucket.
|
|
9245
|
-
* @example null
|
|
9246
|
-
*/
|
|
9247
|
-
color?: string | null;
|
|
9248
|
-
/**
|
|
9249
|
-
* @description Whether the bucket can be shared.
|
|
9250
|
-
* @example true
|
|
9251
|
-
*/
|
|
9252
|
-
bucketSharingAllowed: boolean;
|
|
9253
|
-
/** @description Sharing parameters. Present only when the bucket is shared. */
|
|
9254
|
-
sharingParameters?: {
|
|
9255
|
-
[key: string]: Record<string, never>;
|
|
9256
|
-
} | null;
|
|
9257
|
-
/** @description Token that shared the bucket. Present only when the bucket is shared. */
|
|
9258
|
-
sharedBy?: {
|
|
9259
|
-
/** @example 5 */
|
|
9260
|
-
id?: number | null;
|
|
9261
|
-
/** @example dev@keboola.com */
|
|
9262
|
-
name?: string | null;
|
|
9263
|
-
/**
|
|
9264
|
-
* Format: date-time
|
|
9265
|
-
* @example 2020-02-03T14:58:29+0100
|
|
9266
|
-
*/
|
|
9267
|
-
date?: string | null;
|
|
9268
|
-
} | null;
|
|
9269
|
-
/** @description Bucket owner; `null` when no owner is set. */
|
|
9270
|
-
owner?: {
|
|
9271
|
-
/** @example 123 */
|
|
9272
|
-
id?: number;
|
|
9273
|
-
/** @example Jan Developer */
|
|
9274
|
-
name?: string;
|
|
9275
|
-
/** @example jan.dev@keboola.com */
|
|
9276
|
-
email?: string;
|
|
9277
|
-
} | null;
|
|
9278
|
-
/** @description Source bucket of a linked bucket. Present only for linked buckets. */
|
|
9279
|
-
sourceBucket?: components['schemas']['SharedBucketResponse'] | null;
|
|
9280
|
-
/**
|
|
9281
|
-
* @description Full path of the bucket on the backend (e.g. database and schema).
|
|
9282
|
-
* @example [
|
|
9283
|
-
* "KBC_PRJ_123",
|
|
9284
|
-
* "in.c-my-new-bucket"
|
|
9285
|
-
* ]
|
|
9286
|
-
*/
|
|
9287
|
-
backendPath: string[];
|
|
9288
|
-
/**
|
|
9289
|
-
* @description Deprecated, always an empty array. Kept for backward compatibility.
|
|
9290
|
-
* @example []
|
|
9291
|
-
*/
|
|
9292
|
-
attributes: Record<string, never>[];
|
|
9293
|
-
/** @description Bucket metadata records. */
|
|
9294
|
-
metadata: components['schemas']['MetadataItemResponse'][];
|
|
9295
|
-
/** @description Scheduled tasks (e.g. scheduled refresh of an external bucket). */
|
|
9296
|
-
scheduledTasks: components['schemas']['ScheduledTaskResponse'][];
|
|
9297
|
-
/** @description Bucket listing payload (Analytics Hub on BigQuery). Null when the bucket is not listed. */
|
|
9298
|
-
listing?: components['schemas']['BucketListingDetailResponse'] | null;
|
|
9299
|
-
/** @description Buckets in other projects linked to this bucket. Present only when the bucket is linked somewhere. */
|
|
9300
|
-
linkedBy: {
|
|
9301
|
-
/**
|
|
9302
|
-
* @description ID of the linked bucket in the target project.
|
|
9303
|
-
* @example in.c-linked-bucket
|
|
9304
|
-
*/
|
|
9305
|
-
id?: string;
|
|
9306
|
-
/**
|
|
9307
|
-
* Format: date-time
|
|
9308
|
-
* @example 2017-02-13T12:01:05+0100
|
|
9309
|
-
*/
|
|
9310
|
-
created?: string;
|
|
9311
|
-
project?: {
|
|
9312
|
-
/** @example 321 */
|
|
9313
|
-
id?: number;
|
|
9314
|
-
/** @example Some Project */
|
|
9315
|
-
name?: string;
|
|
9316
|
-
};
|
|
9317
|
-
}[];
|
|
9318
|
-
};
|
|
9319
10657
|
BucketEventAttachmentResponse: {
|
|
9320
10658
|
/** @description Attachment file ID. */
|
|
9321
10659
|
id: number;
|
|
@@ -9410,10 +10748,7 @@ type components = {
|
|
|
9410
10748
|
BucketEventsListResponse: components['schemas']['BucketEventResponse'][];
|
|
9411
10749
|
/** @description Detail of the created table extended with the parent bucket detail. */
|
|
9412
10750
|
CreateTableSyncResponse: components['schemas']['TableCreateResponse'] & {
|
|
9413
|
-
|
|
9414
|
-
bucket: {
|
|
9415
|
-
[key: string]: unknown;
|
|
9416
|
-
};
|
|
10751
|
+
bucket: components['schemas']['TableBucketResponse'];
|
|
9417
10752
|
};
|
|
9418
10753
|
BucketOwnerDetailResponse: {
|
|
9419
10754
|
/** @description Owner identifier. */
|
|
@@ -9950,6 +11285,11 @@ type components = {
|
|
|
9950
11285
|
readOnlyStorageAccess: boolean;
|
|
9951
11286
|
/** @description Platform usage type. */
|
|
9952
11287
|
platformUsageType?: string | null;
|
|
11288
|
+
/**
|
|
11289
|
+
* @description Lifecycle state of the workspace. A deactivated workspace is kept listed so its owner can delete it, but its backend identity is disabled and cannot be connected to; contact support to reactivate it.
|
|
11290
|
+
* @enum {string}
|
|
11291
|
+
*/
|
|
11292
|
+
state: 'active' | 'deactivated';
|
|
9953
11293
|
};
|
|
9954
11294
|
/** @description Workspace detail extended with the freshly created secret. The secret is not stored and is returned only once, right after the workspace is created. */
|
|
9955
11295
|
WorkspaceCreatedResponse: components['schemas']['WorkspaceDetailResponse'] & {
|
|
@@ -10829,6 +12169,107 @@ type components = {
|
|
|
10829
12169
|
token_type?: string;
|
|
10830
12170
|
} | null;
|
|
10831
12171
|
};
|
|
12172
|
+
/** @description Identifier and display name of an object on the path to a search hit. */
|
|
12173
|
+
GlobalSearchIdName: {
|
|
12174
|
+
/** @description Identifier of the object. */
|
|
12175
|
+
id: string | number;
|
|
12176
|
+
/** @description Display name of the object. */
|
|
12177
|
+
name: string;
|
|
12178
|
+
};
|
|
12179
|
+
/** @description Branch a search hit belongs to. */
|
|
12180
|
+
GlobalSearchItemBranch: {
|
|
12181
|
+
/** @description Branch id. */
|
|
12182
|
+
id: number;
|
|
12183
|
+
/** @description Branch name. */
|
|
12184
|
+
name: string;
|
|
12185
|
+
/** @description Whether this is the project default branch. */
|
|
12186
|
+
isDefault: boolean;
|
|
12187
|
+
/** @description False when the branch was resolved from a fake branch rather than being a real development branch. */
|
|
12188
|
+
isNative: boolean;
|
|
12189
|
+
};
|
|
12190
|
+
/** @description Where a search hit lives. Which members are present depends on the hit `type`. */
|
|
12191
|
+
GlobalSearchItemFullPath: {
|
|
12192
|
+
project: components['schemas']['GlobalSearchIdName'];
|
|
12193
|
+
branch: components['schemas']['GlobalSearchItemBranch'];
|
|
12194
|
+
bucket: components['schemas']['GlobalSearchIdName'];
|
|
12195
|
+
component: components['schemas']['GlobalSearchIdName'];
|
|
12196
|
+
configuration: components['schemas']['GlobalSearchIdName'];
|
|
12197
|
+
};
|
|
12198
|
+
/** @description Token stamp IndexDataHydrator records on create and update. */
|
|
12199
|
+
GlobalSearchItemToken: {
|
|
12200
|
+
/** @description Token id. */
|
|
12201
|
+
id: number;
|
|
12202
|
+
/** @description Token description. */
|
|
12203
|
+
name: string;
|
|
12204
|
+
};
|
|
12205
|
+
/** @description One global search hit. */
|
|
12206
|
+
GlobalSearchItem: {
|
|
12207
|
+
/**
|
|
12208
|
+
* @description Identifier within its type — bucket or table string id, configuration id, configuration row id.
|
|
12209
|
+
* @example in.c-main.users
|
|
12210
|
+
*/
|
|
12211
|
+
id: string;
|
|
12212
|
+
/**
|
|
12213
|
+
* @description Kind of the matched object.
|
|
12214
|
+
* @enum {string}
|
|
12215
|
+
*/
|
|
12216
|
+
type: 'bucket' | 'table' | 'configuration' | 'configuration-row';
|
|
12217
|
+
/** @description Display name of the object. */
|
|
12218
|
+
name: string;
|
|
12219
|
+
fullPath: components['schemas']['GlobalSearchItemFullPath'];
|
|
12220
|
+
/**
|
|
12221
|
+
* @description API detail URL. Present for buckets and tables only.
|
|
12222
|
+
* @example https://connection.keboola.com/v2/storage/tables/in.c-main.users
|
|
12223
|
+
*/
|
|
12224
|
+
uri: string;
|
|
12225
|
+
/** @description Component the configuration belongs to. Present for configurations and configuration rows. */
|
|
12226
|
+
componentId: string;
|
|
12227
|
+
/** @description Column names that matched, taken from the search highlight. Present for tables matched by a column name; the full column list is never returned. */
|
|
12228
|
+
matchedColumns: string[];
|
|
12229
|
+
/** @description Organization the object belongs to. */
|
|
12230
|
+
organizationId: number;
|
|
12231
|
+
/** @description Project the object belongs to. */
|
|
12232
|
+
projectId: number;
|
|
12233
|
+
/** @description Name of that project. */
|
|
12234
|
+
projectName: string;
|
|
12235
|
+
/**
|
|
12236
|
+
* Format: date-time
|
|
12237
|
+
* @description When the object was created.
|
|
12238
|
+
*/
|
|
12239
|
+
created: string;
|
|
12240
|
+
createdByToken: components['schemas']['GlobalSearchItemToken'];
|
|
12241
|
+
lastUpdatedByToken: components['schemas']['GlobalSearchItemToken'];
|
|
12242
|
+
};
|
|
12243
|
+
/** @description Global search results with per-type and per-project match counts. */
|
|
12244
|
+
GlobalSearchResponse: {
|
|
12245
|
+
/**
|
|
12246
|
+
* @description Total number of matches across the organization, ignoring `limit` and `offset`.
|
|
12247
|
+
* @example 42
|
|
12248
|
+
*/
|
|
12249
|
+
all: number;
|
|
12250
|
+
/** @description Matches for the requested page. */
|
|
12251
|
+
items: components['schemas']['GlobalSearchItem'][];
|
|
12252
|
+
/**
|
|
12253
|
+
* @description Match counts per object type, plus `total`. Only types with at least one match are present.
|
|
12254
|
+
* @example {
|
|
12255
|
+
* "total": 42,
|
|
12256
|
+
* "table": 30,
|
|
12257
|
+
* "configuration": 12
|
|
12258
|
+
* }
|
|
12259
|
+
*/
|
|
12260
|
+
byType: {
|
|
12261
|
+
[key: string]: number;
|
|
12262
|
+
};
|
|
12263
|
+
/**
|
|
12264
|
+
* @description Names of the projects the matches come from, keyed by project id.
|
|
12265
|
+
* @example {
|
|
12266
|
+
* "10": "Project name"
|
|
12267
|
+
* }
|
|
12268
|
+
*/
|
|
12269
|
+
byProject: {
|
|
12270
|
+
[key: string]: string;
|
|
12271
|
+
};
|
|
12272
|
+
};
|
|
10832
12273
|
MergeRequestResponse: {
|
|
10833
12274
|
id: number;
|
|
10834
12275
|
creator: {
|
|
@@ -10871,7 +12312,20 @@ type components = {
|
|
|
10871
12312
|
}[];
|
|
10872
12313
|
};
|
|
10873
12314
|
MergeRequestWithChangeLogResponse: components['schemas']['MergeRequestResponse'] & {
|
|
10874
|
-
|
|
12315
|
+
/** @description Configurations the merge request carries, as recorded by MergeRequest::updateChangeLog(). */
|
|
12316
|
+
changeLog?: {
|
|
12317
|
+
configurations?: {
|
|
12318
|
+
componentId: string;
|
|
12319
|
+
configurationId: string;
|
|
12320
|
+
/**
|
|
12321
|
+
* @description Version of the configuration on the source branch at the time the change log was built.
|
|
12322
|
+
* @example 01H5M1BDJHD1K6N3G14EZ8XDE2
|
|
12323
|
+
*/
|
|
12324
|
+
lastVersionIdentifier: string;
|
|
12325
|
+
/** @description Whether the configuration is deleted on the source branch. */
|
|
12326
|
+
isDeleted: boolean;
|
|
12327
|
+
}[];
|
|
12328
|
+
};
|
|
10875
12329
|
};
|
|
10876
12330
|
MergeRequestDetailResponse: components['schemas']['MergeRequestWithChangeLogResponse'] & {
|
|
10877
12331
|
/** @description Chronological list of lifecycle events. Only present when `?include=activityLog` is provided. */
|
|
@@ -10934,19 +12388,17 @@ type components = {
|
|
|
10934
12388
|
/** @example kbc_578.c-application-testing.cashier-data */
|
|
10935
12389
|
path?: string | null;
|
|
10936
12390
|
/** @description Present for alias tables. */
|
|
10937
|
-
sourceTable?:
|
|
12391
|
+
sourceTable?: components['schemas']['TableSourceTableResponse'] | null;
|
|
10938
12392
|
/** @description Present for alias tables. */
|
|
10939
12393
|
aliasColumnsAutoSync: boolean;
|
|
10940
12394
|
/** @description Deprecated, always empty. Present with `include=attributes` (default). */
|
|
10941
12395
|
attributes: Record<string, never>[];
|
|
10942
12396
|
/** @description Present with `include=columns`. */
|
|
10943
12397
|
columns: string[];
|
|
10944
|
-
|
|
10945
|
-
bucket: Record<string, never>;
|
|
12398
|
+
bucket: components['schemas']['TableBucketResponse'];
|
|
10946
12399
|
/** @description Table metadata. Present with `include=metadata`. */
|
|
10947
|
-
metadata:
|
|
10948
|
-
|
|
10949
|
-
columnMetadata: Record<string, never>;
|
|
12400
|
+
metadata: components['schemas']['MetadataItemResponse'][];
|
|
12401
|
+
columnMetadata: components['schemas']['TableColumnMetadataResponse'];
|
|
10950
12402
|
};
|
|
10951
12403
|
/** @description Table snapshot with the snapshotted table settings. */
|
|
10952
12404
|
SnapshotDetailResponse: {
|
|
@@ -11207,7 +12659,7 @@ type components = {
|
|
|
11207
12659
|
*/
|
|
11208
12660
|
format: 'rfc' | 'json' | null;
|
|
11209
12661
|
/**
|
|
11210
|
-
* @description Row filters, joined by AND.
|
|
12662
|
+
* @description Row filters, joined by AND.
|
|
11211
12663
|
* @example [
|
|
11212
12664
|
* {
|
|
11213
12665
|
* "column": "UserID",
|
|
@@ -11219,9 +12671,9 @@ type components = {
|
|
|
11219
12671
|
* }
|
|
11220
12672
|
* ]
|
|
11221
12673
|
*/
|
|
11222
|
-
whereFilters?:
|
|
12674
|
+
whereFilters?: components['schemas']['WhereFiltersObject'][] | null;
|
|
11223
12675
|
/**
|
|
11224
|
-
* @description Sort conditions.
|
|
12676
|
+
* @description Sort conditions.
|
|
11225
12677
|
* @example [
|
|
11226
12678
|
* {
|
|
11227
12679
|
* "column": "Price",
|
|
@@ -11230,7 +12682,7 @@ type components = {
|
|
|
11230
12682
|
* }
|
|
11231
12683
|
* ]
|
|
11232
12684
|
*/
|
|
11233
|
-
orderBy?:
|
|
12685
|
+
orderBy?: components['schemas']['OrderByObject'][] | null;
|
|
11234
12686
|
/**
|
|
11235
12687
|
* @description Branch id to load the source from. If not provided, the default branch is used. Honoured only for JSON requests.
|
|
11236
12688
|
* @example 1234
|
|
@@ -11260,6 +12712,19 @@ type components = {
|
|
|
11260
12712
|
/** @default null */
|
|
11261
12713
|
legacyTimestampFilterKind: string | null;
|
|
11262
12714
|
};
|
|
12715
|
+
/** @description Result of a synchronous table import. */
|
|
12716
|
+
ImportSyncResponse: {
|
|
12717
|
+
transaction?: string | null;
|
|
12718
|
+
warnings: string[];
|
|
12719
|
+
/** @description Columns the data was imported into. */
|
|
12720
|
+
importedColumns: string[];
|
|
12721
|
+
totalRowsCount: number;
|
|
12722
|
+
totalDataSizeBytes: number;
|
|
12723
|
+
/** @description For a full load this equals `totalRowsCount`; for an incremental load it is the number of imported rows. */
|
|
12724
|
+
importedRowsCount: number;
|
|
12725
|
+
/** @description Columns added to the table by the import. */
|
|
12726
|
+
newColumns: string[];
|
|
12727
|
+
};
|
|
11263
12728
|
ProfileResponse: {
|
|
11264
12729
|
/**
|
|
11265
12730
|
* @description Profile identifier (UUID v7).
|
|
@@ -11281,7 +12746,7 @@ type components = {
|
|
|
11281
12746
|
* @example 2025-06-02 11:55:00
|
|
11282
12747
|
*/
|
|
11283
12748
|
createdAt: string;
|
|
11284
|
-
/** @description Table-level profile metrics (
|
|
12749
|
+
/** @description Table-level profile metrics. Produced by the storage driver (`CreateProfileTableCommand`); the metric set is backend-specific and passed through unchanged. */
|
|
11285
12750
|
profile: {
|
|
11286
12751
|
[key: string]: unknown;
|
|
11287
12752
|
};
|
|
@@ -11292,7 +12757,7 @@ type components = {
|
|
|
11292
12757
|
* @example id
|
|
11293
12758
|
*/
|
|
11294
12759
|
name: string;
|
|
11295
|
-
/** @description Column-level profile metrics (
|
|
12760
|
+
/** @description Column-level profile metrics. Produced by the storage driver (`CreateProfileTableCommand`); the metric set is backend-specific and passed through unchanged. */
|
|
11296
12761
|
profile: {
|
|
11297
12762
|
[key: string]: unknown;
|
|
11298
12763
|
};
|
|
@@ -11364,17 +12829,22 @@ type components = {
|
|
|
11364
12829
|
tableType: string;
|
|
11365
12830
|
path: string;
|
|
11366
12831
|
columns: string[];
|
|
11367
|
-
columnMetadata:
|
|
12832
|
+
columnMetadata: components['schemas']['TableColumnMetadataResponse'];
|
|
12833
|
+
/** @description Always an empty array, kept for backward compatibility. */
|
|
11368
12834
|
attributes: Record<string, never>[];
|
|
11369
|
-
metadata
|
|
11370
|
-
|
|
11371
|
-
|
|
12835
|
+
/** @description Table metadata records. */
|
|
12836
|
+
metadata: components['schemas']['MetadataItemResponse'][];
|
|
12837
|
+
bucket: components['schemas']['TableBucketResponse'];
|
|
12838
|
+
/** @description Source table info, present for alias tables. */
|
|
12839
|
+
sourceTable?: components['schemas']['TableSourceTableResponse'] | null;
|
|
11372
12840
|
aliasColumnsAutoSync?: boolean | null;
|
|
11373
|
-
|
|
12841
|
+
/** @description Present for filtered simple aliases. */
|
|
12842
|
+
aliasFilter?: components['schemas']['AliasFilterResponse'] | null;
|
|
11374
12843
|
selectSql?: string | null;
|
|
11375
12844
|
/** @description Alias tables only - whether the alias is persisted as a table in the backend. */
|
|
11376
12845
|
isPersisted?: boolean | null;
|
|
11377
|
-
|
|
12846
|
+
/** @description Native table definition. */
|
|
12847
|
+
definition?: components['schemas']['TableDefinitionResponse'] | null;
|
|
11378
12848
|
};
|
|
11379
12849
|
TableEventAttachmentResponse: {
|
|
11380
12850
|
/** @description Attachment file ID. */
|
|
@@ -11541,8 +13011,8 @@ type components = {
|
|
|
11541
13011
|
name?: string;
|
|
11542
13012
|
/** @description Admin ID. */
|
|
11543
13013
|
id?: number;
|
|
11544
|
-
/** @description Admin role. */
|
|
11545
|
-
role?: string;
|
|
13014
|
+
/** @description Admin role. Null when the project membership has no role stored. */
|
|
13015
|
+
role?: string | null;
|
|
11546
13016
|
} | null;
|
|
11547
13017
|
};
|
|
11548
13018
|
TokensListResponse: components['schemas']['TokenListResponse'][];
|
|
@@ -11792,7 +13262,7 @@ type components = {
|
|
|
11792
13262
|
};
|
|
11793
13263
|
WebalizeColumnNamesResponse: {
|
|
11794
13264
|
/**
|
|
11795
|
-
* @description Webalized column names.
|
|
13265
|
+
* @description Webalized column names, in the order they were sent. Each one satisfies `StorageColumnName` unless the input had no usable character left, in which case it is an empty string — so the items are deliberately not `$ref`ed to that component.
|
|
11796
13266
|
* @example [
|
|
11797
13267
|
* "First_Column_Name",
|
|
11798
13268
|
* "Second_Column_Name"
|
|
@@ -11802,10 +13272,10 @@ type components = {
|
|
|
11802
13272
|
};
|
|
11803
13273
|
WebalizeDisplayNameResponse: {
|
|
11804
13274
|
/**
|
|
11805
|
-
* @description
|
|
13275
|
+
* @description The input normalised into a name the create and update endpoints accept.
|
|
11806
13276
|
* @example My-Display-Name
|
|
11807
13277
|
*/
|
|
11808
|
-
displayName: string;
|
|
13278
|
+
displayName: string & components['schemas']['StorageName'];
|
|
11809
13279
|
};
|
|
11810
13280
|
InputMappingLoadPreviewResponse: {
|
|
11811
13281
|
input: {
|
|
@@ -12734,7 +14204,7 @@ interface operations {
|
|
|
12734
14204
|
};
|
|
12735
14205
|
content?: never;
|
|
12736
14206
|
};
|
|
12737
|
-
/** @description The token cannot manage buckets,
|
|
14207
|
+
/** @description The token cannot manage buckets, access to the shared bucket was denied (`accessDenied`), or the acting admin has no project membership role (`manage.users.membershipRoleMissing`). */
|
|
12738
14208
|
403: {
|
|
12739
14209
|
headers: {
|
|
12740
14210
|
[name: string]: unknown;
|
|
@@ -12755,6 +14225,13 @@ interface operations {
|
|
|
12755
14225
|
};
|
|
12756
14226
|
content?: never;
|
|
12757
14227
|
};
|
|
14228
|
+
/** @description The project is disabled (`manage.project.disabled`). The body carries `reason` and, when known and still in the future, `estimatedEndTime` together with a `Retry-After` header. */
|
|
14229
|
+
503: {
|
|
14230
|
+
headers: {
|
|
14231
|
+
[name: string]: unknown;
|
|
14232
|
+
};
|
|
14233
|
+
content?: never;
|
|
14234
|
+
};
|
|
12758
14235
|
};
|
|
12759
14236
|
};
|
|
12760
14237
|
'get_/v2/storage/buckets::BucketsListAction': {
|
|
@@ -13025,7 +14502,7 @@ interface operations {
|
|
|
13025
14502
|
};
|
|
13026
14503
|
content?: never;
|
|
13027
14504
|
};
|
|
13028
|
-
/** @description The token cannot manage buckets,
|
|
14505
|
+
/** @description The token cannot manage buckets, access to the shared bucket was denied (`accessDenied`), or the acting admin has no project membership role (`manage.users.membershipRoleMissing`). */
|
|
13029
14506
|
403: {
|
|
13030
14507
|
headers: {
|
|
13031
14508
|
[name: string]: unknown;
|
|
@@ -13046,6 +14523,13 @@ interface operations {
|
|
|
13046
14523
|
};
|
|
13047
14524
|
content?: never;
|
|
13048
14525
|
};
|
|
14526
|
+
/** @description The project is disabled (`manage.project.disabled`). The body carries `reason` and, when known and still in the future, `estimatedEndTime` together with a `Retry-After` header. */
|
|
14527
|
+
503: {
|
|
14528
|
+
headers: {
|
|
14529
|
+
[name: string]: unknown;
|
|
14530
|
+
};
|
|
14531
|
+
content?: never;
|
|
14532
|
+
};
|
|
13049
14533
|
};
|
|
13050
14534
|
};
|
|
13051
14535
|
'get_/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata::BucketMetadataAction': {
|
|
@@ -13357,7 +14841,7 @@ interface operations {
|
|
|
13357
14841
|
* "id": "in.c-linked-bucket",
|
|
13358
14842
|
* "created": "2017-02-13T12:01:05+0100",
|
|
13359
14843
|
* "project": {
|
|
13360
|
-
* "id": 321,
|
|
14844
|
+
* "id": "321",
|
|
13361
14845
|
* "name": "Some Project"
|
|
13362
14846
|
* }
|
|
13363
14847
|
* }
|
|
@@ -13383,6 +14867,74 @@ interface operations {
|
|
|
13383
14867
|
};
|
|
13384
14868
|
};
|
|
13385
14869
|
};
|
|
14870
|
+
'put_/v2/storage/branch/{branchId}/buckets/{bucketId}::BucketUpdateAction': {
|
|
14871
|
+
parameters: {
|
|
14872
|
+
query?: {
|
|
14873
|
+
/** @description When true, the update is performed asynchronously as a job. */
|
|
14874
|
+
async?: boolean;
|
|
14875
|
+
};
|
|
14876
|
+
header?: never;
|
|
14877
|
+
path: {
|
|
14878
|
+
/** @description Identifier of the bucket to update. */
|
|
14879
|
+
bucketId: string;
|
|
14880
|
+
branchId: string;
|
|
14881
|
+
};
|
|
14882
|
+
cookie?: never;
|
|
14883
|
+
};
|
|
14884
|
+
requestBody: {
|
|
14885
|
+
content: {
|
|
14886
|
+
'application/json': components['schemas']['UpdateBucketRequest'];
|
|
14887
|
+
};
|
|
14888
|
+
};
|
|
14889
|
+
responses: {
|
|
14890
|
+
/** @description The updated bucket (synchronous, deprecated). */
|
|
14891
|
+
200: {
|
|
14892
|
+
headers: {
|
|
14893
|
+
[name: string]: unknown;
|
|
14894
|
+
};
|
|
14895
|
+
content: {
|
|
14896
|
+
'application/json': components['schemas']['BucketUpdateResponse'];
|
|
14897
|
+
};
|
|
14898
|
+
};
|
|
14899
|
+
/** @description Job accepted; returns job details. */
|
|
14900
|
+
202: {
|
|
14901
|
+
headers: {
|
|
14902
|
+
[name: string]: unknown;
|
|
14903
|
+
};
|
|
14904
|
+
content: {
|
|
14905
|
+
'application/json': components['schemas']['JobResponse'];
|
|
14906
|
+
};
|
|
14907
|
+
};
|
|
14908
|
+
/** @description The payload is invalid or the display name is already used in the project. */
|
|
14909
|
+
400: {
|
|
14910
|
+
headers: {
|
|
14911
|
+
[name: string]: unknown;
|
|
14912
|
+
};
|
|
14913
|
+
content?: never;
|
|
14914
|
+
};
|
|
14915
|
+
/** @description Access to the bucket was denied. */
|
|
14916
|
+
403: {
|
|
14917
|
+
headers: {
|
|
14918
|
+
[name: string]: unknown;
|
|
14919
|
+
};
|
|
14920
|
+
content?: never;
|
|
14921
|
+
};
|
|
14922
|
+
/** @description The bucket was not found. */
|
|
14923
|
+
404: {
|
|
14924
|
+
headers: {
|
|
14925
|
+
[name: string]: unknown;
|
|
14926
|
+
};
|
|
14927
|
+
content?: never;
|
|
14928
|
+
};
|
|
14929
|
+
/** @description The bucket or its backend is under maintenance. */
|
|
14930
|
+
503: {
|
|
14931
|
+
headers: {
|
|
14932
|
+
[name: string]: unknown;
|
|
14933
|
+
};
|
|
14934
|
+
content?: never;
|
|
14935
|
+
};
|
|
14936
|
+
};
|
|
14937
|
+
};
|
|
13386
14938
|
'delete_/v2/storage/branch/{branchId}/buckets/{bucketId}::BucketDeleteAction': {
|
|
13387
14939
|
parameters: {
|
|
13388
14940
|
query?: {
|
|
@@ -13451,6 +15003,13 @@ interface operations {
|
|
|
13451
15003
|
};
|
|
13452
15004
|
content?: never;
|
|
13453
15005
|
};
|
|
15006
|
+
/** @description A workspace of the project held its direct-grant lock for the whole wait budget, so the grants on the bucket could not be revoked (`storage.workspace.lockFailedToAcquire`). Retry. */
|
|
15007
|
+
409: {
|
|
15008
|
+
headers: {
|
|
15009
|
+
[name: string]: unknown;
|
|
15010
|
+
};
|
|
15011
|
+
content?: never;
|
|
15012
|
+
};
|
|
13454
15013
|
/** @description Deleting a linked bucket is not supported in a development branch (`storage.buckets.linkedBucketDeleteNotSupportedInDevBranch`). */
|
|
13455
15014
|
501: {
|
|
13456
15015
|
headers: {
|
|
@@ -13554,7 +15113,7 @@ interface operations {
|
|
|
13554
15113
|
* "id": "in.c-linked-bucket",
|
|
13555
15114
|
* "created": "2017-02-13T12:01:05+0100",
|
|
13556
15115
|
* "project": {
|
|
13557
|
-
* "id": 321,
|
|
15116
|
+
* "id": "321",
|
|
13558
15117
|
* "name": "Some Project"
|
|
13559
15118
|
* }
|
|
13560
15119
|
* }
|
|
@@ -13580,6 +15139,73 @@ interface operations {
|
|
|
13580
15139
|
};
|
|
13581
15140
|
};
|
|
13582
15141
|
};
|
|
15142
|
+
'put_/v2/storage/buckets/{bucketId}::BucketUpdateAction': {
|
|
15143
|
+
parameters: {
|
|
15144
|
+
query?: {
|
|
15145
|
+
/** @description When true, the update is performed asynchronously as a job. */
|
|
15146
|
+
async?: boolean;
|
|
15147
|
+
};
|
|
15148
|
+
header?: never;
|
|
15149
|
+
path: {
|
|
15150
|
+
/** @description Identifier of the bucket to update. */
|
|
15151
|
+
bucketId: string;
|
|
15152
|
+
};
|
|
15153
|
+
cookie?: never;
|
|
15154
|
+
};
|
|
15155
|
+
requestBody: {
|
|
15156
|
+
content: {
|
|
15157
|
+
'application/json': components['schemas']['UpdateBucketRequest'];
|
|
15158
|
+
};
|
|
15159
|
+
};
|
|
15160
|
+
responses: {
|
|
15161
|
+
/** @description The updated bucket (synchronous, deprecated). */
|
|
15162
|
+
200: {
|
|
15163
|
+
headers: {
|
|
15164
|
+
[name: string]: unknown;
|
|
15165
|
+
};
|
|
15166
|
+
content: {
|
|
15167
|
+
'application/json': components['schemas']['BucketUpdateResponse'];
|
|
15168
|
+
};
|
|
15169
|
+
};
|
|
15170
|
+
/** @description Job accepted; returns job details. */
|
|
15171
|
+
202: {
|
|
15172
|
+
headers: {
|
|
15173
|
+
[name: string]: unknown;
|
|
15174
|
+
};
|
|
15175
|
+
content: {
|
|
15176
|
+
'application/json': components['schemas']['JobResponse'];
|
|
15177
|
+
};
|
|
15178
|
+
};
|
|
15179
|
+
/** @description The payload is invalid or the display name is already used in the project. */
|
|
15180
|
+
400: {
|
|
15181
|
+
headers: {
|
|
15182
|
+
[name: string]: unknown;
|
|
15183
|
+
};
|
|
15184
|
+
content?: never;
|
|
15185
|
+
};
|
|
15186
|
+
/** @description Access to the bucket was denied. */
|
|
15187
|
+
403: {
|
|
15188
|
+
headers: {
|
|
15189
|
+
[name: string]: unknown;
|
|
15190
|
+
};
|
|
15191
|
+
content?: never;
|
|
15192
|
+
};
|
|
15193
|
+
/** @description The bucket was not found. */
|
|
15194
|
+
404: {
|
|
15195
|
+
headers: {
|
|
15196
|
+
[name: string]: unknown;
|
|
15197
|
+
};
|
|
15198
|
+
content?: never;
|
|
15199
|
+
};
|
|
15200
|
+
/** @description The bucket or its backend is under maintenance. */
|
|
15201
|
+
503: {
|
|
15202
|
+
headers: {
|
|
15203
|
+
[name: string]: unknown;
|
|
15204
|
+
};
|
|
15205
|
+
content?: never;
|
|
15206
|
+
};
|
|
15207
|
+
};
|
|
15208
|
+
};
|
|
13583
15209
|
'delete_/v2/storage/buckets/{bucketId}::BucketDeleteAction': {
|
|
13584
15210
|
parameters: {
|
|
13585
15211
|
query?: {
|
|
@@ -13647,6 +15273,13 @@ interface operations {
|
|
|
13647
15273
|
};
|
|
13648
15274
|
content?: never;
|
|
13649
15275
|
};
|
|
15276
|
+
/** @description A workspace of the project held its direct-grant lock for the whole wait budget, so the grants on the bucket could not be revoked (`storage.workspace.lockFailedToAcquire`). Retry. */
|
|
15277
|
+
409: {
|
|
15278
|
+
headers: {
|
|
15279
|
+
[name: string]: unknown;
|
|
15280
|
+
};
|
|
15281
|
+
content?: never;
|
|
15282
|
+
};
|
|
13650
15283
|
/** @description Deleting a linked bucket is not supported in a development branch (`storage.buckets.linkedBucketDeleteNotSupportedInDevBranch`). */
|
|
13651
15284
|
501: {
|
|
13652
15285
|
headers: {
|
|
@@ -14144,7 +15777,7 @@ interface operations {
|
|
|
14144
15777
|
* @description New table name.
|
|
14145
15778
|
* @example my_table_name
|
|
14146
15779
|
*/
|
|
14147
|
-
name: string;
|
|
15780
|
+
name: string & components['schemas']['StorageName'];
|
|
14148
15781
|
/**
|
|
14149
15782
|
* Format: binary
|
|
14150
15783
|
* @description CSV file containing data for import. The data have to be encoded in UTF-8. The file can be raw or gzipped; gzipped files must have the extension `.gz`. Required unless `dataString` is provided.
|
|
@@ -14384,7 +16017,7 @@ interface operations {
|
|
|
14384
16017
|
* @description New table name.
|
|
14385
16018
|
* @example my_table_name
|
|
14386
16019
|
*/
|
|
14387
|
-
name: string;
|
|
16020
|
+
name: string & components['schemas']['StorageName'];
|
|
14388
16021
|
/**
|
|
14389
16022
|
* Format: binary
|
|
14390
16023
|
* @description CSV file containing data for import. The data have to be encoded in UTF-8. The file can be raw or gzipped; gzipped files must have the extension `.gz`. Required unless `dataString` is provided.
|
|
@@ -14675,6 +16308,135 @@ interface operations {
|
|
|
14675
16308
|
};
|
|
14676
16309
|
};
|
|
14677
16310
|
};
|
|
16311
|
+
'post_/v2/storage/branch/{branchId}/buckets/{bucketId}/table-aliases::CreateTableAliasAction': {
|
|
16312
|
+
parameters: {
|
|
16313
|
+
query?: never;
|
|
16314
|
+
header?: never;
|
|
16315
|
+
path: {
|
|
16316
|
+
/** @description Identifier of the bucket the alias is created in. */
|
|
16317
|
+
bucketId: string;
|
|
16318
|
+
branchId: string;
|
|
16319
|
+
};
|
|
16320
|
+
cookie?: never;
|
|
16321
|
+
};
|
|
16322
|
+
requestBody: {
|
|
16323
|
+
content: {
|
|
16324
|
+
'application/json': components['schemas']['CreateTableAliasRequest'];
|
|
16325
|
+
};
|
|
16326
|
+
};
|
|
16327
|
+
responses: {
|
|
16328
|
+
/** @description The created alias detail, including its columns and the destination bucket detail. */
|
|
16329
|
+
201: {
|
|
16330
|
+
headers: {
|
|
16331
|
+
[name: string]: unknown;
|
|
16332
|
+
};
|
|
16333
|
+
content: {
|
|
16334
|
+
'application/json': components['schemas']['CreateTableAliasResponse'];
|
|
16335
|
+
};
|
|
16336
|
+
};
|
|
16337
|
+
/** @description Job accepted; returns job details. */
|
|
16338
|
+
202: {
|
|
16339
|
+
headers: {
|
|
16340
|
+
[name: string]: unknown;
|
|
16341
|
+
};
|
|
16342
|
+
content: {
|
|
16343
|
+
'application/json': components['schemas']['JobResponse'];
|
|
16344
|
+
};
|
|
16345
|
+
};
|
|
16346
|
+
/** @description The alias cannot be created - invalid request body, an external bucket on either side, a bucket in a development branch, or a filter the source table does not support. */
|
|
16347
|
+
400: {
|
|
16348
|
+
headers: {
|
|
16349
|
+
[name: string]: unknown;
|
|
16350
|
+
};
|
|
16351
|
+
content?: never;
|
|
16352
|
+
};
|
|
16353
|
+
/** @description Write access to the destination bucket or read access to the source bucket was denied. */
|
|
16354
|
+
403: {
|
|
16355
|
+
headers: {
|
|
16356
|
+
[name: string]: unknown;
|
|
16357
|
+
};
|
|
16358
|
+
content?: never;
|
|
16359
|
+
};
|
|
16360
|
+
/** @description The destination bucket, the source bucket or the source table was not found. */
|
|
16361
|
+
404: {
|
|
16362
|
+
headers: {
|
|
16363
|
+
[name: string]: unknown;
|
|
16364
|
+
};
|
|
16365
|
+
content?: never;
|
|
16366
|
+
};
|
|
16367
|
+
/** @description The destination bucket or its backend is under maintenance. */
|
|
16368
|
+
503: {
|
|
16369
|
+
headers: {
|
|
16370
|
+
[name: string]: unknown;
|
|
16371
|
+
};
|
|
16372
|
+
content?: never;
|
|
16373
|
+
};
|
|
16374
|
+
};
|
|
16375
|
+
};
|
|
16376
|
+
'post_/v2/storage/buckets/{bucketId}/table-aliases::CreateTableAliasAction': {
|
|
16377
|
+
parameters: {
|
|
16378
|
+
query?: never;
|
|
16379
|
+
header?: never;
|
|
16380
|
+
path: {
|
|
16381
|
+
/** @description Identifier of the bucket the alias is created in. */
|
|
16382
|
+
bucketId: string;
|
|
16383
|
+
};
|
|
16384
|
+
cookie?: never;
|
|
16385
|
+
};
|
|
16386
|
+
requestBody: {
|
|
16387
|
+
content: {
|
|
16388
|
+
'application/json': components['schemas']['CreateTableAliasRequest'];
|
|
16389
|
+
};
|
|
16390
|
+
};
|
|
16391
|
+
responses: {
|
|
16392
|
+
/** @description The created alias detail, including its columns and the destination bucket detail. */
|
|
16393
|
+
201: {
|
|
16394
|
+
headers: {
|
|
16395
|
+
[name: string]: unknown;
|
|
16396
|
+
};
|
|
16397
|
+
content: {
|
|
16398
|
+
'application/json': components['schemas']['CreateTableAliasResponse'];
|
|
16399
|
+
};
|
|
16400
|
+
};
|
|
16401
|
+
/** @description Job accepted; returns job details. */
|
|
16402
|
+
202: {
|
|
16403
|
+
headers: {
|
|
16404
|
+
[name: string]: unknown;
|
|
16405
|
+
};
|
|
16406
|
+
content: {
|
|
16407
|
+
'application/json': components['schemas']['JobResponse'];
|
|
16408
|
+
};
|
|
16409
|
+
};
|
|
16410
|
+
/** @description The alias cannot be created - invalid request body, an external bucket on either side, a bucket in a development branch, or a filter the source table does not support. */
|
|
16411
|
+
400: {
|
|
16412
|
+
headers: {
|
|
16413
|
+
[name: string]: unknown;
|
|
16414
|
+
};
|
|
16415
|
+
content?: never;
|
|
16416
|
+
};
|
|
16417
|
+
/** @description Write access to the destination bucket or read access to the source bucket was denied. */
|
|
16418
|
+
403: {
|
|
16419
|
+
headers: {
|
|
16420
|
+
[name: string]: unknown;
|
|
16421
|
+
};
|
|
16422
|
+
content?: never;
|
|
16423
|
+
};
|
|
16424
|
+
/** @description The destination bucket, the source bucket or the source table was not found. */
|
|
16425
|
+
404: {
|
|
16426
|
+
headers: {
|
|
16427
|
+
[name: string]: unknown;
|
|
16428
|
+
};
|
|
16429
|
+
content?: never;
|
|
16430
|
+
};
|
|
16431
|
+
/** @description The destination bucket or its backend is under maintenance. */
|
|
16432
|
+
503: {
|
|
16433
|
+
headers: {
|
|
16434
|
+
[name: string]: unknown;
|
|
16435
|
+
};
|
|
16436
|
+
content?: never;
|
|
16437
|
+
};
|
|
16438
|
+
};
|
|
16439
|
+
};
|
|
14678
16440
|
'post_/v2/storage/branch/{branchId}/buckets/{id}/tables-async::CreateTableAsyncAction': {
|
|
14679
16441
|
parameters: {
|
|
14680
16442
|
query?: never;
|
|
@@ -16001,6 +17763,13 @@ interface operations {
|
|
|
16001
17763
|
'application/json': components['schemas']['BucketShareDeleteResponse'];
|
|
16002
17764
|
};
|
|
16003
17765
|
};
|
|
17766
|
+
/** @description The bucket is not shared (`storage.buckets.notShared`). */
|
|
17767
|
+
400: {
|
|
17768
|
+
headers: {
|
|
17769
|
+
[name: string]: unknown;
|
|
17770
|
+
};
|
|
17771
|
+
content?: never;
|
|
17772
|
+
};
|
|
16004
17773
|
/** @description The token cannot manage the bucket or is not an organization administrator (`accessDenied`). */
|
|
16005
17774
|
403: {
|
|
16006
17775
|
headers: {
|
|
@@ -16015,6 +17784,41 @@ interface operations {
|
|
|
16015
17784
|
};
|
|
16016
17785
|
content?: never;
|
|
16017
17786
|
};
|
|
17787
|
+
/** @description Other projects still link the bucket (`storage.buckets.alreadyLinked`). Nothing changed: every link is intact and the consumer projects observe no interruption. `linkedProjects` names the projects that block the request; unlink them first, which stops their reads and cannot be undone from this project. */
|
|
17788
|
+
409: {
|
|
17789
|
+
headers: {
|
|
17790
|
+
[name: string]: unknown;
|
|
17791
|
+
};
|
|
17792
|
+
content: {
|
|
17793
|
+
/**
|
|
17794
|
+
* @example {
|
|
17795
|
+
* "error": "The bucket is already linked in other projects.",
|
|
17796
|
+
* "code": "storage.buckets.alreadyLinked",
|
|
17797
|
+
* "uuid": "019f47e0-d5d6-76c4-8da6-e2e60bebdd05",
|
|
17798
|
+
* "params": {
|
|
17799
|
+
* "linkedProjects": [
|
|
17800
|
+
* {
|
|
17801
|
+
* "id": 123,
|
|
17802
|
+
* "name": "Marketing analytics"
|
|
17803
|
+
* },
|
|
17804
|
+
* {
|
|
17805
|
+
* "id": 456,
|
|
17806
|
+
* "name": "Finance reporting"
|
|
17807
|
+
* }
|
|
17808
|
+
* ]
|
|
17809
|
+
* }
|
|
17810
|
+
* }
|
|
17811
|
+
*/
|
|
17812
|
+
'application/json': unknown;
|
|
17813
|
+
};
|
|
17814
|
+
};
|
|
17815
|
+
/** @description The bucket (`storage.buckets.maintenance`) or its backend (`storage.backend.maintenance`) is under maintenance. */
|
|
17816
|
+
503: {
|
|
17817
|
+
headers: {
|
|
17818
|
+
[name: string]: unknown;
|
|
17819
|
+
};
|
|
17820
|
+
content?: never;
|
|
17821
|
+
};
|
|
16018
17822
|
};
|
|
16019
17823
|
};
|
|
16020
17824
|
'put_/v2/storage/buckets/{bucketId}/share::BucketShareUpdateAction': {
|
|
@@ -16151,6 +17955,13 @@ interface operations {
|
|
|
16151
17955
|
'application/json': components['schemas']['BucketShareDeleteResponse'];
|
|
16152
17956
|
};
|
|
16153
17957
|
};
|
|
17958
|
+
/** @description The bucket is not shared (`storage.buckets.notShared`). */
|
|
17959
|
+
400: {
|
|
17960
|
+
headers: {
|
|
17961
|
+
[name: string]: unknown;
|
|
17962
|
+
};
|
|
17963
|
+
content?: never;
|
|
17964
|
+
};
|
|
16154
17965
|
/** @description The token cannot manage the bucket or is not an organization administrator (`accessDenied`). */
|
|
16155
17966
|
403: {
|
|
16156
17967
|
headers: {
|
|
@@ -16165,6 +17976,41 @@ interface operations {
|
|
|
16165
17976
|
};
|
|
16166
17977
|
content?: never;
|
|
16167
17978
|
};
|
|
17979
|
+
/** @description Other projects still link the bucket (`storage.buckets.alreadyLinked`). Nothing changed: every link is intact and the consumer projects observe no interruption. `linkedProjects` names the projects that block the request; unlink them first, which stops their reads and cannot be undone from this project. */
|
|
17980
|
+
409: {
|
|
17981
|
+
headers: {
|
|
17982
|
+
[name: string]: unknown;
|
|
17983
|
+
};
|
|
17984
|
+
content: {
|
|
17985
|
+
/**
|
|
17986
|
+
* @example {
|
|
17987
|
+
* "error": "The bucket is already linked in other projects.",
|
|
17988
|
+
* "code": "storage.buckets.alreadyLinked",
|
|
17989
|
+
* "uuid": "019f47e0-d5d6-76c4-8da6-e2e60bebdd05",
|
|
17990
|
+
* "params": {
|
|
17991
|
+
* "linkedProjects": [
|
|
17992
|
+
* {
|
|
17993
|
+
* "id": 123,
|
|
17994
|
+
* "name": "Marketing analytics"
|
|
17995
|
+
* },
|
|
17996
|
+
* {
|
|
17997
|
+
* "id": 456,
|
|
17998
|
+
* "name": "Finance reporting"
|
|
17999
|
+
* }
|
|
18000
|
+
* ]
|
|
18001
|
+
* }
|
|
18002
|
+
* }
|
|
18003
|
+
*/
|
|
18004
|
+
'application/json': unknown;
|
|
18005
|
+
};
|
|
18006
|
+
};
|
|
18007
|
+
/** @description The bucket (`storage.buckets.maintenance`) or its backend (`storage.backend.maintenance`) is under maintenance. */
|
|
18008
|
+
503: {
|
|
18009
|
+
headers: {
|
|
18010
|
+
[name: string]: unknown;
|
|
18011
|
+
};
|
|
18012
|
+
content?: never;
|
|
18013
|
+
};
|
|
16168
18014
|
};
|
|
16169
18015
|
};
|
|
16170
18016
|
'post_/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization::BucketShareOrganizationAction': {
|
|
@@ -17458,6 +19304,194 @@ interface operations {
|
|
|
17458
19304
|
};
|
|
17459
19305
|
};
|
|
17460
19306
|
};
|
|
19307
|
+
'post_/v2/storage/branch/{branchId}/components/configs/batch-purge::ConfigurationBatchPurgeAction': {
|
|
19308
|
+
parameters: {
|
|
19309
|
+
query?: never;
|
|
19310
|
+
header?: never;
|
|
19311
|
+
path: {
|
|
19312
|
+
branchId: string;
|
|
19313
|
+
};
|
|
19314
|
+
cookie?: never;
|
|
19315
|
+
};
|
|
19316
|
+
requestBody: {
|
|
19317
|
+
content: {
|
|
19318
|
+
/**
|
|
19319
|
+
* @example {
|
|
19320
|
+
* "configurations": [
|
|
19321
|
+
* {
|
|
19322
|
+
* "componentId": "keboola.ex-db-mysql",
|
|
19323
|
+
* "configurationId": "main-1",
|
|
19324
|
+
* "version": 5
|
|
19325
|
+
* },
|
|
19326
|
+
* {
|
|
19327
|
+
* "componentId": "keboola.ex-db-mysql",
|
|
19328
|
+
* "configurationId": "main-2",
|
|
19329
|
+
* "version": 2
|
|
19330
|
+
* }
|
|
19331
|
+
* ]
|
|
19332
|
+
* }
|
|
19333
|
+
*/
|
|
19334
|
+
'application/json': components['schemas']['BatchPurgeRequest'];
|
|
19335
|
+
};
|
|
19336
|
+
};
|
|
19337
|
+
responses: {
|
|
19338
|
+
/** @description Job accepted; returns job details. */
|
|
19339
|
+
202: {
|
|
19340
|
+
headers: {
|
|
19341
|
+
[name: string]: unknown;
|
|
19342
|
+
};
|
|
19343
|
+
content: {
|
|
19344
|
+
'application/json': components['schemas']['JobResponse'];
|
|
19345
|
+
};
|
|
19346
|
+
};
|
|
19347
|
+
/** @description Request body is invalid — a `configurations` list that is empty or longer than 1000 items, or an item missing `componentId`, `configurationId` or `version`. */
|
|
19348
|
+
400: {
|
|
19349
|
+
headers: {
|
|
19350
|
+
[name: string]: unknown;
|
|
19351
|
+
};
|
|
19352
|
+
content?: never;
|
|
19353
|
+
};
|
|
19354
|
+
};
|
|
19355
|
+
};
|
|
19356
|
+
'post_/v2/storage/components/configs/batch-purge::ConfigurationBatchPurgeAction': {
|
|
19357
|
+
parameters: {
|
|
19358
|
+
query?: never;
|
|
19359
|
+
header?: never;
|
|
19360
|
+
path?: never;
|
|
19361
|
+
cookie?: never;
|
|
19362
|
+
};
|
|
19363
|
+
requestBody: {
|
|
19364
|
+
content: {
|
|
19365
|
+
/**
|
|
19366
|
+
* @example {
|
|
19367
|
+
* "configurations": [
|
|
19368
|
+
* {
|
|
19369
|
+
* "componentId": "keboola.ex-db-mysql",
|
|
19370
|
+
* "configurationId": "main-1",
|
|
19371
|
+
* "version": 5
|
|
19372
|
+
* },
|
|
19373
|
+
* {
|
|
19374
|
+
* "componentId": "keboola.ex-db-mysql",
|
|
19375
|
+
* "configurationId": "main-2",
|
|
19376
|
+
* "version": 2
|
|
19377
|
+
* }
|
|
19378
|
+
* ]
|
|
19379
|
+
* }
|
|
19380
|
+
*/
|
|
19381
|
+
'application/json': components['schemas']['BatchPurgeRequest'];
|
|
19382
|
+
};
|
|
19383
|
+
};
|
|
19384
|
+
responses: {
|
|
19385
|
+
/** @description Job accepted; returns job details. */
|
|
19386
|
+
202: {
|
|
19387
|
+
headers: {
|
|
19388
|
+
[name: string]: unknown;
|
|
19389
|
+
};
|
|
19390
|
+
content: {
|
|
19391
|
+
'application/json': components['schemas']['JobResponse'];
|
|
19392
|
+
};
|
|
19393
|
+
};
|
|
19394
|
+
/** @description Request body is invalid — a `configurations` list that is empty or longer than 1000 items, or an item missing `componentId`, `configurationId` or `version`. */
|
|
19395
|
+
400: {
|
|
19396
|
+
headers: {
|
|
19397
|
+
[name: string]: unknown;
|
|
19398
|
+
};
|
|
19399
|
+
content?: never;
|
|
19400
|
+
};
|
|
19401
|
+
};
|
|
19402
|
+
};
|
|
19403
|
+
'post_/v2/storage/branch/{branchId}/components/configs/batch-restore::ConfigurationBatchRestoreAction': {
|
|
19404
|
+
parameters: {
|
|
19405
|
+
query?: never;
|
|
19406
|
+
header?: never;
|
|
19407
|
+
path: {
|
|
19408
|
+
branchId: string;
|
|
19409
|
+
};
|
|
19410
|
+
cookie?: never;
|
|
19411
|
+
};
|
|
19412
|
+
requestBody: {
|
|
19413
|
+
content: {
|
|
19414
|
+
/**
|
|
19415
|
+
* @example {
|
|
19416
|
+
* "configurations": [
|
|
19417
|
+
* {
|
|
19418
|
+
* "componentId": "keboola.ex-db-mysql",
|
|
19419
|
+
* "configurationId": "main-1"
|
|
19420
|
+
* },
|
|
19421
|
+
* {
|
|
19422
|
+
* "componentId": "keboola.ex-db-mysql",
|
|
19423
|
+
* "configurationId": "main-2"
|
|
19424
|
+
* }
|
|
19425
|
+
* ]
|
|
19426
|
+
* }
|
|
19427
|
+
*/
|
|
19428
|
+
'application/json': components['schemas']['BatchRestoreRequest'];
|
|
19429
|
+
};
|
|
19430
|
+
};
|
|
19431
|
+
responses: {
|
|
19432
|
+
/** @description Job accepted; returns job details. */
|
|
19433
|
+
202: {
|
|
19434
|
+
headers: {
|
|
19435
|
+
[name: string]: unknown;
|
|
19436
|
+
};
|
|
19437
|
+
content: {
|
|
19438
|
+
'application/json': components['schemas']['JobResponse'];
|
|
19439
|
+
};
|
|
19440
|
+
};
|
|
19441
|
+
/** @description Request body is invalid — a `configurations` list that is empty or longer than 1000 items, or an item missing `componentId` or `configurationId`. */
|
|
19442
|
+
400: {
|
|
19443
|
+
headers: {
|
|
19444
|
+
[name: string]: unknown;
|
|
19445
|
+
};
|
|
19446
|
+
content?: never;
|
|
19447
|
+
};
|
|
19448
|
+
};
|
|
19449
|
+
};
|
|
19450
|
+
'post_/v2/storage/components/configs/batch-restore::ConfigurationBatchRestoreAction': {
|
|
19451
|
+
parameters: {
|
|
19452
|
+
query?: never;
|
|
19453
|
+
header?: never;
|
|
19454
|
+
path?: never;
|
|
19455
|
+
cookie?: never;
|
|
19456
|
+
};
|
|
19457
|
+
requestBody: {
|
|
19458
|
+
content: {
|
|
19459
|
+
/**
|
|
19460
|
+
* @example {
|
|
19461
|
+
* "configurations": [
|
|
19462
|
+
* {
|
|
19463
|
+
* "componentId": "keboola.ex-db-mysql",
|
|
19464
|
+
* "configurationId": "main-1"
|
|
19465
|
+
* },
|
|
19466
|
+
* {
|
|
19467
|
+
* "componentId": "keboola.ex-db-mysql",
|
|
19468
|
+
* "configurationId": "main-2"
|
|
19469
|
+
* }
|
|
19470
|
+
* ]
|
|
19471
|
+
* }
|
|
19472
|
+
*/
|
|
19473
|
+
'application/json': components['schemas']['BatchRestoreRequest'];
|
|
19474
|
+
};
|
|
19475
|
+
};
|
|
19476
|
+
responses: {
|
|
19477
|
+
/** @description Job accepted; returns job details. */
|
|
19478
|
+
202: {
|
|
19479
|
+
headers: {
|
|
19480
|
+
[name: string]: unknown;
|
|
19481
|
+
};
|
|
19482
|
+
content: {
|
|
19483
|
+
'application/json': components['schemas']['JobResponse'];
|
|
19484
|
+
};
|
|
19485
|
+
};
|
|
19486
|
+
/** @description Request body is invalid — a `configurations` list that is empty or longer than 1000 items, or an item missing `componentId` or `configurationId`. */
|
|
19487
|
+
400: {
|
|
19488
|
+
headers: {
|
|
19489
|
+
[name: string]: unknown;
|
|
19490
|
+
};
|
|
19491
|
+
content?: never;
|
|
19492
|
+
};
|
|
19493
|
+
};
|
|
19494
|
+
};
|
|
17461
19495
|
'get_/v2/storage/branch/{branchId}/components/{componentId}/configs::ConfigurationListAction': {
|
|
17462
19496
|
parameters: {
|
|
17463
19497
|
query?: {
|
|
@@ -22295,6 +24329,13 @@ interface operations {
|
|
|
22295
24329
|
'application/json': components['schemas']['DevBranchResponse'][];
|
|
22296
24330
|
};
|
|
22297
24331
|
};
|
|
24332
|
+
/** @description Returned when the token is not allowed to view development branches. */
|
|
24333
|
+
403: {
|
|
24334
|
+
headers: {
|
|
24335
|
+
[name: string]: unknown;
|
|
24336
|
+
};
|
|
24337
|
+
content?: never;
|
|
24338
|
+
};
|
|
22298
24339
|
};
|
|
22299
24340
|
};
|
|
22300
24341
|
'post_/v2/storage/dev-branches::DevBranchCreateAction': {
|
|
@@ -23003,12 +25044,27 @@ interface operations {
|
|
|
23003
25044
|
};
|
|
23004
25045
|
requestBody?: never;
|
|
23005
25046
|
responses: {
|
|
23006
|
-
/** @description Raw file content
|
|
25047
|
+
/** @description Raw file content. The `Content-Type` is guessed from the file extension by FileContentService; an unrecognized extension falls back to `application/octet-stream`. The response is always served with `X-Content-Type-Options: nosniff`. */
|
|
23007
25048
|
200: {
|
|
23008
25049
|
headers: {
|
|
23009
25050
|
[name: string]: unknown;
|
|
23010
25051
|
};
|
|
23011
|
-
content
|
|
25052
|
+
content: {
|
|
25053
|
+
'text/csv': string;
|
|
25054
|
+
'application/json': string;
|
|
25055
|
+
'application/xml': string;
|
|
25056
|
+
'text/plain': string;
|
|
25057
|
+
'text/markdown': string;
|
|
25058
|
+
'text/yaml': string;
|
|
25059
|
+
'image/png': string;
|
|
25060
|
+
'image/jpeg': string;
|
|
25061
|
+
'image/gif': string;
|
|
25062
|
+
'image/webp': string;
|
|
25063
|
+
'image/avif': string;
|
|
25064
|
+
'image/bmp': string;
|
|
25065
|
+
'image/x-icon': string;
|
|
25066
|
+
'application/octet-stream': string;
|
|
25067
|
+
};
|
|
23012
25068
|
};
|
|
23013
25069
|
/** @description Returned when the file is sliced (`storage.files.contentNotAvailable`) or exceeds the 10 MB size limit (`storage.files.contentTooLarge`). */
|
|
23014
25070
|
400: {
|
|
@@ -23048,12 +25104,27 @@ interface operations {
|
|
|
23048
25104
|
};
|
|
23049
25105
|
requestBody?: never;
|
|
23050
25106
|
responses: {
|
|
23051
|
-
/** @description Raw file content
|
|
25107
|
+
/** @description Raw file content. The `Content-Type` is guessed from the file extension by FileContentService; an unrecognized extension falls back to `application/octet-stream`. The response is always served with `X-Content-Type-Options: nosniff`. */
|
|
23052
25108
|
200: {
|
|
23053
25109
|
headers: {
|
|
23054
25110
|
[name: string]: unknown;
|
|
23055
25111
|
};
|
|
23056
|
-
content
|
|
25112
|
+
content: {
|
|
25113
|
+
'text/csv': string;
|
|
25114
|
+
'application/json': string;
|
|
25115
|
+
'application/xml': string;
|
|
25116
|
+
'text/plain': string;
|
|
25117
|
+
'text/markdown': string;
|
|
25118
|
+
'text/yaml': string;
|
|
25119
|
+
'image/png': string;
|
|
25120
|
+
'image/jpeg': string;
|
|
25121
|
+
'image/gif': string;
|
|
25122
|
+
'image/webp': string;
|
|
25123
|
+
'image/avif': string;
|
|
25124
|
+
'image/bmp': string;
|
|
25125
|
+
'image/x-icon': string;
|
|
25126
|
+
'application/octet-stream': string;
|
|
25127
|
+
};
|
|
23057
25128
|
};
|
|
23058
25129
|
/** @description Returned when the file is sliced (`storage.files.contentNotAvailable`) or exceeds the 10 MB size limit (`storage.files.contentTooLarge`). */
|
|
23059
25130
|
400: {
|
|
@@ -24041,7 +26112,7 @@ interface operations {
|
|
|
24041
26112
|
[name: string]: unknown;
|
|
24042
26113
|
};
|
|
24043
26114
|
content: {
|
|
24044
|
-
'application/json':
|
|
26115
|
+
'application/json': components['schemas']['GlobalSearchResponse'];
|
|
24045
26116
|
};
|
|
24046
26117
|
};
|
|
24047
26118
|
/** @description Invalid query, invalid regex pattern, or pattern exceeds the maximum allowed length. */
|
|
@@ -25081,7 +27152,7 @@ interface operations {
|
|
|
25081
27152
|
parameters: {
|
|
25082
27153
|
query?: {
|
|
25083
27154
|
/**
|
|
25084
|
-
* @description Comma-separated list of items to exclude from the response. `components` omits the `components` field; `componentDetails`
|
|
27155
|
+
* @description Comma-separated list of items to exclude from the response. `components` omits the `components` field; `componentDetails` reduces each component to `id`, `name`, `type`, `ico64`, `ico128`, `features`, `flags`, `description` and `categories`.
|
|
25085
27156
|
* @example componentDetails
|
|
25086
27157
|
*/
|
|
25087
27158
|
exclude?: string;
|
|
@@ -25097,7 +27168,37 @@ interface operations {
|
|
|
25097
27168
|
headers: {
|
|
25098
27169
|
[name: string]: unknown;
|
|
25099
27170
|
};
|
|
25100
|
-
content
|
|
27171
|
+
content: {
|
|
27172
|
+
'application/json': {
|
|
27173
|
+
/** @description Identifier of the stack the project runs on. */
|
|
27174
|
+
stack?: string;
|
|
27175
|
+
/** @description Hostname of the API node that served the request. */
|
|
27176
|
+
host?: string;
|
|
27177
|
+
/** @example storage */
|
|
27178
|
+
api?: string;
|
|
27179
|
+
/**
|
|
27180
|
+
* @description API version resolved from the request.
|
|
27181
|
+
* @example v2
|
|
27182
|
+
*/
|
|
27183
|
+
version?: string;
|
|
27184
|
+
/** @description Deployed application revision. */
|
|
27185
|
+
revision?: string;
|
|
27186
|
+
/** @example https://api.keboola.com/?service=storage */
|
|
27187
|
+
documentation?: string;
|
|
27188
|
+
services?: {
|
|
27189
|
+
/** @example docker-runner */
|
|
27190
|
+
id?: string;
|
|
27191
|
+
/** @example https://docker-runner.keboola.com */
|
|
27192
|
+
url?: string;
|
|
27193
|
+
}[];
|
|
27194
|
+
features?: string[];
|
|
27195
|
+
urlTemplates?: {
|
|
27196
|
+
orchestrationJob?: string;
|
|
27197
|
+
};
|
|
27198
|
+
/** @description Present unless excluded via `exclude=components`. Reduced to `id`, `name`, `type`, `ico64`, `ico128`, `features`, `flags`, `description` and `categories` per component when `exclude=componentDetails` is used. */
|
|
27199
|
+
components?: components['schemas']['ComponentArrayRead'][] | null;
|
|
27200
|
+
};
|
|
27201
|
+
};
|
|
25101
27202
|
};
|
|
25102
27203
|
/** @description Returned by any Storage API endpoint when the authenticated project is under maintenance (disabled, e.g. during a migration). Use the `Retry-After` header when accessing the API programmatically. */
|
|
25103
27204
|
503: {
|
|
@@ -25164,6 +27265,13 @@ interface operations {
|
|
|
25164
27265
|
};
|
|
25165
27266
|
content?: never;
|
|
25166
27267
|
};
|
|
27268
|
+
/** @description Another operation holds the alias lock (`core.lock.lockIsAlreadyUsed`); retry. */
|
|
27269
|
+
409: {
|
|
27270
|
+
headers: {
|
|
27271
|
+
[name: string]: unknown;
|
|
27272
|
+
};
|
|
27273
|
+
content?: never;
|
|
27274
|
+
};
|
|
25167
27275
|
/** @description The bucket or its backend is under maintenance. */
|
|
25168
27276
|
503: {
|
|
25169
27277
|
headers: {
|
|
@@ -25217,6 +27325,13 @@ interface operations {
|
|
|
25217
27325
|
};
|
|
25218
27326
|
content?: never;
|
|
25219
27327
|
};
|
|
27328
|
+
/** @description Another operation holds the alias lock (`core.lock.lockIsAlreadyUsed`); retry. */
|
|
27329
|
+
409: {
|
|
27330
|
+
headers: {
|
|
27331
|
+
[name: string]: unknown;
|
|
27332
|
+
};
|
|
27333
|
+
content?: never;
|
|
27334
|
+
};
|
|
25220
27335
|
/** @description The bucket or its backend is under maintenance. */
|
|
25221
27336
|
503: {
|
|
25222
27337
|
headers: {
|
|
@@ -25269,6 +27384,13 @@ interface operations {
|
|
|
25269
27384
|
};
|
|
25270
27385
|
content?: never;
|
|
25271
27386
|
};
|
|
27387
|
+
/** @description Another operation holds the alias lock (`core.lock.lockIsAlreadyUsed`); retry. */
|
|
27388
|
+
409: {
|
|
27389
|
+
headers: {
|
|
27390
|
+
[name: string]: unknown;
|
|
27391
|
+
};
|
|
27392
|
+
content?: never;
|
|
27393
|
+
};
|
|
25272
27394
|
/** @description The bucket or its backend is under maintenance. */
|
|
25273
27395
|
503: {
|
|
25274
27396
|
headers: {
|
|
@@ -25321,6 +27443,13 @@ interface operations {
|
|
|
25321
27443
|
};
|
|
25322
27444
|
content?: never;
|
|
25323
27445
|
};
|
|
27446
|
+
/** @description Another operation holds the alias lock (`core.lock.lockIsAlreadyUsed`); retry. */
|
|
27447
|
+
409: {
|
|
27448
|
+
headers: {
|
|
27449
|
+
[name: string]: unknown;
|
|
27450
|
+
};
|
|
27451
|
+
content?: never;
|
|
27452
|
+
};
|
|
25324
27453
|
/** @description The bucket or its backend is under maintenance. */
|
|
25325
27454
|
503: {
|
|
25326
27455
|
headers: {
|
|
@@ -26452,6 +28581,157 @@ interface operations {
|
|
|
26452
28581
|
};
|
|
26453
28582
|
};
|
|
26454
28583
|
};
|
|
28584
|
+
'post_/v2/storage/branch/{branchId}/tables/{tableId}/import::ImportSyncAction': {
|
|
28585
|
+
parameters: {
|
|
28586
|
+
query?: never;
|
|
28587
|
+
header?: never;
|
|
28588
|
+
path: {
|
|
28589
|
+
/** @description Table string id (e.g. `in.c-main.users`). */
|
|
28590
|
+
tableId: string;
|
|
28591
|
+
branchId: string;
|
|
28592
|
+
};
|
|
28593
|
+
cookie?: never;
|
|
28594
|
+
};
|
|
28595
|
+
requestBody: {
|
|
28596
|
+
content: {
|
|
28597
|
+
'multipart/form-data': {
|
|
28598
|
+
/**
|
|
28599
|
+
* Format: binary
|
|
28600
|
+
* @description CSV file to import. Used when "dataString" is empty, unset, or "0".
|
|
28601
|
+
*/
|
|
28602
|
+
data?: string;
|
|
28603
|
+
/** @description Inline CSV data. Takes precedence over "data" unless it is empty or "0". */
|
|
28604
|
+
dataString?: string;
|
|
28605
|
+
/** @description When true, the data is appended to the table instead of replacing it. */
|
|
28606
|
+
incremental?: boolean;
|
|
28607
|
+
/** @description Field delimiter, default ",". */
|
|
28608
|
+
delimiter?: string;
|
|
28609
|
+
/** @description Field enclosure, default '"'. */
|
|
28610
|
+
enclosure?: string;
|
|
28611
|
+
/** @description Escape character, default none. */
|
|
28612
|
+
escapedBy?: string;
|
|
28613
|
+
/** @description Comma separated list of column names, used when the file has no header. */
|
|
28614
|
+
columns?: string;
|
|
28615
|
+
/** @description When true, the first row is treated as data and the table column order is used. */
|
|
28616
|
+
withoutHeaders?: boolean;
|
|
28617
|
+
};
|
|
28618
|
+
};
|
|
28619
|
+
};
|
|
28620
|
+
responses: {
|
|
28621
|
+
/** @description The import result. */
|
|
28622
|
+
200: {
|
|
28623
|
+
headers: {
|
|
28624
|
+
[name: string]: unknown;
|
|
28625
|
+
};
|
|
28626
|
+
content: {
|
|
28627
|
+
'application/json': components['schemas']['ImportSyncResponse'];
|
|
28628
|
+
};
|
|
28629
|
+
};
|
|
28630
|
+
/** @description Validation error in the upload, CSV or import. */
|
|
28631
|
+
400: {
|
|
28632
|
+
headers: {
|
|
28633
|
+
[name: string]: unknown;
|
|
28634
|
+
};
|
|
28635
|
+
content?: never;
|
|
28636
|
+
};
|
|
28637
|
+
/** @description Write access to the table bucket was denied. */
|
|
28638
|
+
403: {
|
|
28639
|
+
headers: {
|
|
28640
|
+
[name: string]: unknown;
|
|
28641
|
+
};
|
|
28642
|
+
content?: never;
|
|
28643
|
+
};
|
|
28644
|
+
/** @description The table was not found, or synchronous import is disabled on this stack. */
|
|
28645
|
+
404: {
|
|
28646
|
+
headers: {
|
|
28647
|
+
[name: string]: unknown;
|
|
28648
|
+
};
|
|
28649
|
+
content?: never;
|
|
28650
|
+
};
|
|
28651
|
+
/** @description The bucket or its backend is under maintenance. */
|
|
28652
|
+
503: {
|
|
28653
|
+
headers: {
|
|
28654
|
+
[name: string]: unknown;
|
|
28655
|
+
};
|
|
28656
|
+
content?: never;
|
|
28657
|
+
};
|
|
28658
|
+
};
|
|
28659
|
+
};
|
|
28660
|
+
'post_/v2/storage/tables/{tableId}/import::ImportSyncAction': {
|
|
28661
|
+
parameters: {
|
|
28662
|
+
query?: never;
|
|
28663
|
+
header?: never;
|
|
28664
|
+
path: {
|
|
28665
|
+
/** @description Table string id (e.g. `in.c-main.users`). */
|
|
28666
|
+
tableId: string;
|
|
28667
|
+
};
|
|
28668
|
+
cookie?: never;
|
|
28669
|
+
};
|
|
28670
|
+
requestBody: {
|
|
28671
|
+
content: {
|
|
28672
|
+
'multipart/form-data': {
|
|
28673
|
+
/**
|
|
28674
|
+
* Format: binary
|
|
28675
|
+
* @description CSV file to import. Used when "dataString" is empty, unset, or "0".
|
|
28676
|
+
*/
|
|
28677
|
+
data?: string;
|
|
28678
|
+
/** @description Inline CSV data. Takes precedence over "data" unless it is empty or "0". */
|
|
28679
|
+
dataString?: string;
|
|
28680
|
+
/** @description When true, the data is appended to the table instead of replacing it. */
|
|
28681
|
+
incremental?: boolean;
|
|
28682
|
+
/** @description Field delimiter, default ",". */
|
|
28683
|
+
delimiter?: string;
|
|
28684
|
+
/** @description Field enclosure, default '"'. */
|
|
28685
|
+
enclosure?: string;
|
|
28686
|
+
/** @description Escape character, default none. */
|
|
28687
|
+
escapedBy?: string;
|
|
28688
|
+
/** @description Comma separated list of column names, used when the file has no header. */
|
|
28689
|
+
columns?: string;
|
|
28690
|
+
/** @description When true, the first row is treated as data and the table column order is used. */
|
|
28691
|
+
withoutHeaders?: boolean;
|
|
28692
|
+
};
|
|
28693
|
+
};
|
|
28694
|
+
};
|
|
28695
|
+
responses: {
|
|
28696
|
+
/** @description The import result. */
|
|
28697
|
+
200: {
|
|
28698
|
+
headers: {
|
|
28699
|
+
[name: string]: unknown;
|
|
28700
|
+
};
|
|
28701
|
+
content: {
|
|
28702
|
+
'application/json': components['schemas']['ImportSyncResponse'];
|
|
28703
|
+
};
|
|
28704
|
+
};
|
|
28705
|
+
/** @description Validation error in the upload, CSV or import. */
|
|
28706
|
+
400: {
|
|
28707
|
+
headers: {
|
|
28708
|
+
[name: string]: unknown;
|
|
28709
|
+
};
|
|
28710
|
+
content?: never;
|
|
28711
|
+
};
|
|
28712
|
+
/** @description Write access to the table bucket was denied. */
|
|
28713
|
+
403: {
|
|
28714
|
+
headers: {
|
|
28715
|
+
[name: string]: unknown;
|
|
28716
|
+
};
|
|
28717
|
+
content?: never;
|
|
28718
|
+
};
|
|
28719
|
+
/** @description The table was not found, or synchronous import is disabled on this stack. */
|
|
28720
|
+
404: {
|
|
28721
|
+
headers: {
|
|
28722
|
+
[name: string]: unknown;
|
|
28723
|
+
};
|
|
28724
|
+
content?: never;
|
|
28725
|
+
};
|
|
28726
|
+
/** @description The bucket or its backend is under maintenance. */
|
|
28727
|
+
503: {
|
|
28728
|
+
headers: {
|
|
28729
|
+
[name: string]: unknown;
|
|
28730
|
+
};
|
|
28731
|
+
content?: never;
|
|
28732
|
+
};
|
|
28733
|
+
};
|
|
28734
|
+
};
|
|
26455
28735
|
'post_/v2/storage/branch/{branchId}/tables/{tableId}/primary-key::PrimaryKeyCreateAction': {
|
|
26456
28736
|
parameters: {
|
|
26457
28737
|
query?: never;
|
|
@@ -27800,10 +30080,10 @@ interface operations {
|
|
|
27800
30080
|
* @example json
|
|
27801
30081
|
*/
|
|
27802
30082
|
format?: 'rfc' | 'json' | null;
|
|
27803
|
-
/** @description Row filters
|
|
27804
|
-
'whereFilters[]'?:
|
|
27805
|
-
/** @description Sort specification
|
|
27806
|
-
'orderBy[]'?:
|
|
30083
|
+
/** @description Row filters (see the asynchronous export for the filter description). Sent as `whereFilters[0][column]=...`. */
|
|
30084
|
+
'whereFilters[]'?: components['schemas']['WhereFiltersObject'][] | null;
|
|
30085
|
+
/** @description Sort specification. Sent as `orderBy[0][column]=...`. */
|
|
30086
|
+
'orderBy[]'?: components['schemas']['OrderByObject'][] | null;
|
|
27807
30087
|
/**
|
|
27808
30088
|
* @description Fulltext search over all data in the table. Cannot be combined with `whereFilters`. Snowflake/BigQuery only.
|
|
27809
30089
|
* @example czech
|
|
@@ -27947,10 +30227,10 @@ interface operations {
|
|
|
27947
30227
|
* @example json
|
|
27948
30228
|
*/
|
|
27949
30229
|
format?: 'rfc' | 'json' | null;
|
|
27950
|
-
/** @description Row filters
|
|
27951
|
-
'whereFilters[]'?:
|
|
27952
|
-
/** @description Sort specification
|
|
27953
|
-
'orderBy[]'?:
|
|
30230
|
+
/** @description Row filters (see the asynchronous export for the filter description). Sent as `whereFilters[0][column]=...`. */
|
|
30231
|
+
'whereFilters[]'?: components['schemas']['WhereFiltersObject'][] | null;
|
|
30232
|
+
/** @description Sort specification. Sent as `orderBy[0][column]=...`. */
|
|
30233
|
+
'orderBy[]'?: components['schemas']['OrderByObject'][] | null;
|
|
27954
30234
|
/**
|
|
27955
30235
|
* @description Fulltext search over all data in the table. Cannot be combined with `whereFilters`. Snowflake/BigQuery only.
|
|
27956
30236
|
* @example czech
|
|
@@ -28392,6 +30672,13 @@ interface operations {
|
|
|
28392
30672
|
};
|
|
28393
30673
|
content?: never;
|
|
28394
30674
|
};
|
|
30675
|
+
/** @description Another operation holds a dependent alias' lock (`core.lock.lockIsAlreadyUsed`); retry. */
|
|
30676
|
+
409: {
|
|
30677
|
+
headers: {
|
|
30678
|
+
[name: string]: unknown;
|
|
30679
|
+
};
|
|
30680
|
+
content?: never;
|
|
30681
|
+
};
|
|
28395
30682
|
};
|
|
28396
30683
|
};
|
|
28397
30684
|
'get_/v2/storage/tables/{id}::TableDetailAction': {
|
|
@@ -28613,6 +30900,13 @@ interface operations {
|
|
|
28613
30900
|
};
|
|
28614
30901
|
content?: never;
|
|
28615
30902
|
};
|
|
30903
|
+
/** @description Another operation holds a dependent alias' lock (`core.lock.lockIsAlreadyUsed`); retry. */
|
|
30904
|
+
409: {
|
|
30905
|
+
headers: {
|
|
30906
|
+
[name: string]: unknown;
|
|
30907
|
+
};
|
|
30908
|
+
content?: never;
|
|
30909
|
+
};
|
|
28616
30910
|
};
|
|
28617
30911
|
};
|
|
28618
30912
|
'delete_/v2/storage/branch/{branchId}/tables/{id}/metadata/{metadataId}::TableDeleteMetadataAction': {
|
|
@@ -28926,6 +31220,141 @@ interface operations {
|
|
|
28926
31220
|
};
|
|
28927
31221
|
};
|
|
28928
31222
|
};
|
|
31223
|
+
'put_/v2/storage/branch/{branchId}/tables/{tableId}::TableUpdateAction': {
|
|
31224
|
+
parameters: {
|
|
31225
|
+
query?: {
|
|
31226
|
+
/** @description When true, the update is performed asynchronously as a job. */
|
|
31227
|
+
async?: boolean;
|
|
31228
|
+
};
|
|
31229
|
+
header?: never;
|
|
31230
|
+
path: {
|
|
31231
|
+
/** @description Table string id (e.g. `in.c-main.orders`). */
|
|
31232
|
+
tableId: string;
|
|
31233
|
+
branchId: string;
|
|
31234
|
+
};
|
|
31235
|
+
cookie?: never;
|
|
31236
|
+
};
|
|
31237
|
+
requestBody: {
|
|
31238
|
+
content: {
|
|
31239
|
+
'application/json': components['schemas']['TableUpdateRequest'];
|
|
31240
|
+
};
|
|
31241
|
+
};
|
|
31242
|
+
responses: {
|
|
31243
|
+
/** @description The updated table (synchronous, deprecated). */
|
|
31244
|
+
200: {
|
|
31245
|
+
headers: {
|
|
31246
|
+
[name: string]: unknown;
|
|
31247
|
+
};
|
|
31248
|
+
content: {
|
|
31249
|
+
'application/json': components['schemas']['TableUpdateResponse'];
|
|
31250
|
+
};
|
|
31251
|
+
};
|
|
31252
|
+
/** @description Job accepted; returns job details. */
|
|
31253
|
+
202: {
|
|
31254
|
+
headers: {
|
|
31255
|
+
[name: string]: unknown;
|
|
31256
|
+
};
|
|
31257
|
+
content: {
|
|
31258
|
+
'application/json': components['schemas']['JobResponse'];
|
|
31259
|
+
};
|
|
31260
|
+
};
|
|
31261
|
+
/** @description The display name failed validation (`storage.tables.validation`) or another table in the same bucket already uses it (`storage.buckets.tableAlreadyExists`). */
|
|
31262
|
+
400: {
|
|
31263
|
+
headers: {
|
|
31264
|
+
[name: string]: unknown;
|
|
31265
|
+
};
|
|
31266
|
+
content?: never;
|
|
31267
|
+
};
|
|
31268
|
+
/** @description Write access to the table was denied. */
|
|
31269
|
+
403: {
|
|
31270
|
+
headers: {
|
|
31271
|
+
[name: string]: unknown;
|
|
31272
|
+
};
|
|
31273
|
+
content?: never;
|
|
31274
|
+
};
|
|
31275
|
+
/** @description The table or its bucket was not found. */
|
|
31276
|
+
404: {
|
|
31277
|
+
headers: {
|
|
31278
|
+
[name: string]: unknown;
|
|
31279
|
+
};
|
|
31280
|
+
content?: never;
|
|
31281
|
+
};
|
|
31282
|
+
/** @description The bucket or its backend is under maintenance. */
|
|
31283
|
+
503: {
|
|
31284
|
+
headers: {
|
|
31285
|
+
[name: string]: unknown;
|
|
31286
|
+
};
|
|
31287
|
+
content?: never;
|
|
31288
|
+
};
|
|
31289
|
+
};
|
|
31290
|
+
};
|
|
31291
|
+
'put_/v2/storage/tables/{tableId}::TableUpdateAction': {
|
|
31292
|
+
parameters: {
|
|
31293
|
+
query?: {
|
|
31294
|
+
/** @description When true, the update is performed asynchronously as a job. */
|
|
31295
|
+
async?: boolean;
|
|
31296
|
+
};
|
|
31297
|
+
header?: never;
|
|
31298
|
+
path: {
|
|
31299
|
+
/** @description Table string id (e.g. `in.c-main.orders`). */
|
|
31300
|
+
tableId: string;
|
|
31301
|
+
};
|
|
31302
|
+
cookie?: never;
|
|
31303
|
+
};
|
|
31304
|
+
requestBody: {
|
|
31305
|
+
content: {
|
|
31306
|
+
'application/json': components['schemas']['TableUpdateRequest'];
|
|
31307
|
+
};
|
|
31308
|
+
};
|
|
31309
|
+
responses: {
|
|
31310
|
+
/** @description The updated table (synchronous, deprecated). */
|
|
31311
|
+
200: {
|
|
31312
|
+
headers: {
|
|
31313
|
+
[name: string]: unknown;
|
|
31314
|
+
};
|
|
31315
|
+
content: {
|
|
31316
|
+
'application/json': components['schemas']['TableUpdateResponse'];
|
|
31317
|
+
};
|
|
31318
|
+
};
|
|
31319
|
+
/** @description Job accepted; returns job details. */
|
|
31320
|
+
202: {
|
|
31321
|
+
headers: {
|
|
31322
|
+
[name: string]: unknown;
|
|
31323
|
+
};
|
|
31324
|
+
content: {
|
|
31325
|
+
'application/json': components['schemas']['JobResponse'];
|
|
31326
|
+
};
|
|
31327
|
+
};
|
|
31328
|
+
/** @description The display name failed validation (`storage.tables.validation`) or another table in the same bucket already uses it (`storage.buckets.tableAlreadyExists`). */
|
|
31329
|
+
400: {
|
|
31330
|
+
headers: {
|
|
31331
|
+
[name: string]: unknown;
|
|
31332
|
+
};
|
|
31333
|
+
content?: never;
|
|
31334
|
+
};
|
|
31335
|
+
/** @description Write access to the table was denied. */
|
|
31336
|
+
403: {
|
|
31337
|
+
headers: {
|
|
31338
|
+
[name: string]: unknown;
|
|
31339
|
+
};
|
|
31340
|
+
content?: never;
|
|
31341
|
+
};
|
|
31342
|
+
/** @description The table or its bucket was not found. */
|
|
31343
|
+
404: {
|
|
31344
|
+
headers: {
|
|
31345
|
+
[name: string]: unknown;
|
|
31346
|
+
};
|
|
31347
|
+
content?: never;
|
|
31348
|
+
};
|
|
31349
|
+
/** @description The bucket or its backend is under maintenance. */
|
|
31350
|
+
503: {
|
|
31351
|
+
headers: {
|
|
31352
|
+
[name: string]: unknown;
|
|
31353
|
+
};
|
|
31354
|
+
content?: never;
|
|
31355
|
+
};
|
|
31356
|
+
};
|
|
31357
|
+
};
|
|
28929
31358
|
'post_/v2/storage/tickets::GenerateNewId': {
|
|
28930
31359
|
parameters: {
|
|
28931
31360
|
query?: never;
|
|
@@ -30215,7 +32644,7 @@ interface operations {
|
|
|
30215
32644
|
};
|
|
30216
32645
|
content?: never;
|
|
30217
32646
|
};
|
|
30218
|
-
/** @description Cool down period shorter than 1 minute (`storage.triggers.missingParam`), table from an external bucket (`storage.triggers.triggerOnTableFromExternalBucket`),
|
|
32647
|
+
/** @description Cool down period shorter than 1 minute (`storage.triggers.missingParam`), table from an external bucket (`storage.triggers.triggerOnTableFromExternalBucket`), insufficient privilege for the component (`storage.triggers.insufficientPrivilege`), or no `runWithTokenId` and your token may not create the token the trigger runs with (`storage.triggers.runWithTokenNotCreatable`). */
|
|
30219
32648
|
422: {
|
|
30220
32649
|
headers: {
|
|
30221
32650
|
[name: string]: unknown;
|
|
@@ -30381,7 +32810,7 @@ interface operations {
|
|
|
30381
32810
|
};
|
|
30382
32811
|
content?: never;
|
|
30383
32812
|
};
|
|
30384
|
-
/** @description Cool down period shorter than 1 minute (`storage.triggers.missingParam`), table from an external bucket (`storage.triggers.triggerOnTableFromExternalBucket`),
|
|
32813
|
+
/** @description Cool down period shorter than 1 minute (`storage.triggers.missingParam`), table from an external bucket (`storage.triggers.triggerOnTableFromExternalBucket`), insufficient privilege for the component (`storage.triggers.insufficientPrivilege`), or no `runWithTokenId` and your token may not create the token the trigger runs with (`storage.triggers.runWithTokenNotCreatable`). */
|
|
30385
32814
|
422: {
|
|
30386
32815
|
headers: {
|
|
30387
32816
|
[name: string]: unknown;
|
|
@@ -30450,7 +32879,7 @@ interface operations {
|
|
|
30450
32879
|
};
|
|
30451
32880
|
content?: never;
|
|
30452
32881
|
};
|
|
30453
|
-
/** @description At least one column name is invalid (e.g. contains characters other than alphanumeric
|
|
32882
|
+
/** @description At least one column name is invalid (e.g. contains characters other than alphanumeric and underscore); the validation error lists the offending names. */
|
|
30454
32883
|
422: {
|
|
30455
32884
|
headers: {
|
|
30456
32885
|
[name: string]: unknown;
|
|
@@ -30479,7 +32908,7 @@ interface operations {
|
|
|
30479
32908
|
};
|
|
30480
32909
|
content?: never;
|
|
30481
32910
|
};
|
|
30482
|
-
/** @description At least one column name is invalid (e.g. contains characters other than alphanumeric
|
|
32911
|
+
/** @description At least one column name is invalid (e.g. contains characters other than alphanumeric and underscore); the validation error lists the offending names. */
|
|
30483
32912
|
422: {
|
|
30484
32913
|
headers: {
|
|
30485
32914
|
[name: string]: unknown;
|
|
@@ -31084,7 +33513,7 @@ interface operations {
|
|
|
31084
33513
|
* "tableId": null,
|
|
31085
33514
|
* "operationName": "workspaceBatchDeleteObjects",
|
|
31086
33515
|
* "operationParams": {
|
|
31087
|
-
* "workspaceId":
|
|
33516
|
+
* "workspaceId": 456,
|
|
31088
33517
|
* "objects": "[\"MY_TABLE\",\"MY_VIEW\"]"
|
|
31089
33518
|
* },
|
|
31090
33519
|
* "createdTime": "2013-05-31T16:11:05+0200",
|
|
@@ -31101,7 +33530,7 @@ interface operations {
|
|
|
31101
33530
|
'application/json': components['schemas']['JobResponse'];
|
|
31102
33531
|
};
|
|
31103
33532
|
};
|
|
31104
|
-
/** @description Returned when the request body is invalid (e.g. empty `objects` list). */
|
|
33533
|
+
/** @description Returned when the request body is invalid (e.g. empty `objects` list), or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
31105
33534
|
400: {
|
|
31106
33535
|
headers: {
|
|
31107
33536
|
[name: string]: unknown;
|
|
@@ -31158,7 +33587,7 @@ interface operations {
|
|
|
31158
33587
|
* "tableId": null,
|
|
31159
33588
|
* "operationName": "workspaceBatchDeleteObjects",
|
|
31160
33589
|
* "operationParams": {
|
|
31161
|
-
* "workspaceId":
|
|
33590
|
+
* "workspaceId": 456,
|
|
31162
33591
|
* "objects": "[\"MY_TABLE\",\"MY_VIEW\"]"
|
|
31163
33592
|
* },
|
|
31164
33593
|
* "createdTime": "2013-05-31T16:11:05+0200",
|
|
@@ -31175,7 +33604,7 @@ interface operations {
|
|
|
31175
33604
|
'application/json': components['schemas']['JobResponse'];
|
|
31176
33605
|
};
|
|
31177
33606
|
};
|
|
31178
|
-
/** @description Returned when the request body is invalid (e.g. empty `objects` list). */
|
|
33607
|
+
/** @description Returned when the request body is invalid (e.g. empty `objects` list), or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
31179
33608
|
400: {
|
|
31180
33609
|
headers: {
|
|
31181
33610
|
[name: string]: unknown;
|
|
@@ -31343,7 +33772,8 @@ interface operations {
|
|
|
31343
33772
|
* "description": "martin@keboola.com"
|
|
31344
33773
|
* },
|
|
31345
33774
|
* "readOnlyStorageAccess": true,
|
|
31346
|
-
* "platformUsageType": "user"
|
|
33775
|
+
* "platformUsageType": "user",
|
|
33776
|
+
* "state": "active"
|
|
31347
33777
|
* }
|
|
31348
33778
|
* ]
|
|
31349
33779
|
*/
|
|
@@ -31542,7 +33972,8 @@ interface operations {
|
|
|
31542
33972
|
* "description": "martin@keboola.com"
|
|
31543
33973
|
* },
|
|
31544
33974
|
* "readOnlyStorageAccess": true,
|
|
31545
|
-
* "platformUsageType": "user"
|
|
33975
|
+
* "platformUsageType": "user",
|
|
33976
|
+
* "state": "active"
|
|
31546
33977
|
* }
|
|
31547
33978
|
* ]
|
|
31548
33979
|
*/
|
|
@@ -31746,7 +34177,8 @@ interface operations {
|
|
|
31746
34177
|
* "description": "martin@keboola.com"
|
|
31747
34178
|
* },
|
|
31748
34179
|
* "readOnlyStorageAccess": true,
|
|
31749
|
-
* "platformUsageType": "user"
|
|
34180
|
+
* "platformUsageType": "user",
|
|
34181
|
+
* "state": "active"
|
|
31750
34182
|
* }
|
|
31751
34183
|
*/
|
|
31752
34184
|
'application/json': components['schemas']['WorkspaceDetailResponse'];
|
|
@@ -31897,7 +34329,8 @@ interface operations {
|
|
|
31897
34329
|
* "description": "martin@keboola.com"
|
|
31898
34330
|
* },
|
|
31899
34331
|
* "readOnlyStorageAccess": true,
|
|
31900
|
-
* "platformUsageType": "user"
|
|
34332
|
+
* "platformUsageType": "user",
|
|
34333
|
+
* "state": "active"
|
|
31901
34334
|
* }
|
|
31902
34335
|
*/
|
|
31903
34336
|
'application/json': components['schemas']['WorkspaceDetailResponse'];
|
|
@@ -32124,7 +34557,7 @@ interface operations {
|
|
|
32124
34557
|
'application/json': components['schemas']['JobResponse'];
|
|
32125
34558
|
};
|
|
32126
34559
|
};
|
|
32127
|
-
/** @description Invalid request — validation error (`workspace.loadRequestBadInput`), unsupported option, load type not available for the item, duplicate destination,
|
|
34560
|
+
/** @description Invalid request — validation error (`workspace.loadRequestBadInput`), unsupported option, load type not available for the item, duplicate destination, `where_column` without `where_values`, or a deactivated workspace (`workspace.workspaceDeactivated`). */
|
|
32128
34561
|
400: {
|
|
32129
34562
|
headers: {
|
|
32130
34563
|
[name: string]: unknown;
|
|
@@ -32280,7 +34713,7 @@ interface operations {
|
|
|
32280
34713
|
'application/json': components['schemas']['JobResponse'];
|
|
32281
34714
|
};
|
|
32282
34715
|
};
|
|
32283
|
-
/** @description Invalid request — validation error (`workspace.loadRequestBadInput`), unsupported option, load type not available for the item, duplicate destination,
|
|
34716
|
+
/** @description Invalid request — validation error (`workspace.loadRequestBadInput`), unsupported option, load type not available for the item, duplicate destination, `where_column` without `where_values`, or a deactivated workspace (`workspace.workspaceDeactivated`). */
|
|
32284
34717
|
400: {
|
|
32285
34718
|
headers: {
|
|
32286
34719
|
[name: string]: unknown;
|
|
@@ -32372,7 +34805,7 @@ interface operations {
|
|
|
32372
34805
|
'application/json': components['schemas']['JobResponse'];
|
|
32373
34806
|
};
|
|
32374
34807
|
};
|
|
32375
|
-
/** @description Returned when the input mapping is invalid (`workspace.loadRequestBadInput`), the load type is not supported or combined incorrectly, destinations are duplicated, `overwrite` conflicts with `preserve`/`incremental`, the source branch does not exist,
|
|
34808
|
+
/** @description Returned when the input mapping is invalid (`workspace.loadRequestBadInput`), the load type is not supported or combined incorrectly, destinations are duplicated, `overwrite` conflicts with `preserve`/`incremental`, the source branch does not exist, the table does not support timestamp based filtering, or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
32376
34809
|
400: {
|
|
32377
34810
|
headers: {
|
|
32378
34811
|
[name: string]: unknown;
|
|
@@ -32463,7 +34896,7 @@ interface operations {
|
|
|
32463
34896
|
'application/json': components['schemas']['JobResponse'];
|
|
32464
34897
|
};
|
|
32465
34898
|
};
|
|
32466
|
-
/** @description Returned when the input mapping is invalid (`workspace.loadRequestBadInput`), the load type is not supported or combined incorrectly, destinations are duplicated, `overwrite` conflicts with `preserve`/`incremental`, the source branch does not exist,
|
|
34899
|
+
/** @description Returned when the input mapping is invalid (`workspace.loadRequestBadInput`), the load type is not supported or combined incorrectly, destinations are duplicated, `overwrite` conflicts with `preserve`/`incremental`, the source branch does not exist, the table does not support timestamp based filtering, or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
32467
34900
|
400: {
|
|
32468
34901
|
headers: {
|
|
32469
34902
|
[name: string]: unknown;
|
|
@@ -32523,7 +34956,7 @@ interface operations {
|
|
|
32523
34956
|
'application/json': components['schemas']['WorkspacePasswordResetResponse'];
|
|
32524
34957
|
};
|
|
32525
34958
|
};
|
|
32526
|
-
/** @description Returned when password reset is not supported for the workspace login type (`workspace.resetPasswordNotSupportedForLoginType`), file storage or backend (`workspace.backendNotSupported`). */
|
|
34959
|
+
/** @description Returned when password reset is not supported for the workspace login type (`workspace.resetPasswordNotSupportedForLoginType`), file storage or backend (`workspace.backendNotSupported`), or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
32527
34960
|
400: {
|
|
32528
34961
|
headers: {
|
|
32529
34962
|
[name: string]: unknown;
|
|
@@ -32568,7 +35001,7 @@ interface operations {
|
|
|
32568
35001
|
'application/json': components['schemas']['WorkspacePasswordResetResponse'];
|
|
32569
35002
|
};
|
|
32570
35003
|
};
|
|
32571
|
-
/** @description Returned when password reset is not supported for the workspace login type (`workspace.resetPasswordNotSupportedForLoginType`), file storage or backend (`workspace.backendNotSupported`). */
|
|
35004
|
+
/** @description Returned when password reset is not supported for the workspace login type (`workspace.resetPasswordNotSupportedForLoginType`), file storage or backend (`workspace.backendNotSupported`), or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
32572
35005
|
400: {
|
|
32573
35006
|
headers: {
|
|
32574
35007
|
[name: string]: unknown;
|
|
@@ -32699,7 +35132,7 @@ interface operations {
|
|
|
32699
35132
|
'application/json': components['schemas']['WorkspaceDetailResponseWithSecret'];
|
|
32700
35133
|
};
|
|
32701
35134
|
};
|
|
32702
|
-
/** @description Returned when the workspace backend is not supported (`workspace.backendNotSupported`); only BigQuery and Snowflake are supported. */
|
|
35135
|
+
/** @description Returned when the workspace backend is not supported (`workspace.backendNotSupported`); only BigQuery and Snowflake are supported. Also returned when the workspace is deactivated (`workspace.workspaceDeactivated`), or when the configuration declares more linked-dataset tables than a BigQuery identity can be bound to (`workspace.directGrantLinkedDatasetTableLimitExceeded`). */
|
|
32703
35136
|
400: {
|
|
32704
35137
|
headers: {
|
|
32705
35138
|
[name: string]: unknown;
|
|
@@ -32787,7 +35220,7 @@ interface operations {
|
|
|
32787
35220
|
'application/json': components['schemas']['WorkspaceDetailResponseWithSecret'];
|
|
32788
35221
|
};
|
|
32789
35222
|
};
|
|
32790
|
-
/** @description Returned when the workspace backend is not supported (`workspace.backendNotSupported`); only BigQuery and Snowflake are supported. */
|
|
35223
|
+
/** @description Returned when the workspace backend is not supported (`workspace.backendNotSupported`); only BigQuery and Snowflake are supported. Also returned when the workspace is deactivated (`workspace.workspaceDeactivated`), or when the configuration declares more linked-dataset tables than a BigQuery identity can be bound to (`workspace.directGrantLinkedDatasetTableLimitExceeded`). */
|
|
32791
35224
|
400: {
|
|
32792
35225
|
headers: {
|
|
32793
35226
|
[name: string]: unknown;
|
|
@@ -32920,6 +35353,13 @@ interface operations {
|
|
|
32920
35353
|
};
|
|
32921
35354
|
content?: never;
|
|
32922
35355
|
};
|
|
35356
|
+
/** @description Returned when the workspace lock could not be acquired because another credentials or direct-grant operation is in progress (`storage.workspace.lockFailedToAcquire`). */
|
|
35357
|
+
409: {
|
|
35358
|
+
headers: {
|
|
35359
|
+
[name: string]: unknown;
|
|
35360
|
+
};
|
|
35361
|
+
content?: never;
|
|
35362
|
+
};
|
|
32923
35363
|
};
|
|
32924
35364
|
};
|
|
32925
35365
|
'get_/v2/storage/workspaces/{workspaceId}/credentials/{id}::WorkspaceStorageCredentialsDetailAction': {
|
|
@@ -33030,6 +35470,13 @@ interface operations {
|
|
|
33030
35470
|
};
|
|
33031
35471
|
content?: never;
|
|
33032
35472
|
};
|
|
35473
|
+
/** @description Returned when the workspace lock could not be acquired because another credentials or direct-grant operation is in progress (`storage.workspace.lockFailedToAcquire`). */
|
|
35474
|
+
409: {
|
|
35475
|
+
headers: {
|
|
35476
|
+
[name: string]: unknown;
|
|
35477
|
+
};
|
|
35478
|
+
content?: never;
|
|
35479
|
+
};
|
|
33033
35480
|
};
|
|
33034
35481
|
};
|
|
33035
35482
|
'post_/v2/storage/branch/{branchId}/workspaces/{workspaceId}/table-export::WorkspaceTableExportAction': {
|
|
@@ -33165,7 +35612,7 @@ interface operations {
|
|
|
33165
35612
|
'application/json': Record<string, never>[];
|
|
33166
35613
|
};
|
|
33167
35614
|
};
|
|
33168
|
-
/** @description Returned when configuration is not found, pinned configuration version no longer exists,
|
|
35615
|
+
/** @description Returned when configuration is not found, pinned configuration version no longer exists, a table referenced in pinned version no longer exists, or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
33169
35616
|
400: {
|
|
33170
35617
|
headers: {
|
|
33171
35618
|
[name: string]: unknown;
|
|
@@ -33256,7 +35703,7 @@ interface operations {
|
|
|
33256
35703
|
'application/json': components['schemas']['JobResponse'];
|
|
33257
35704
|
};
|
|
33258
35705
|
};
|
|
33259
|
-
/** @description Returned when the input is invalid (`workspace.loadRequestBadInput`), clone is not supported for the workspace backend or source (external bucket, linked bucket on BigQuery), destinations are duplicated, `overwrite` conflicts with `preserve`,
|
|
35706
|
+
/** @description Returned when the input is invalid (`workspace.loadRequestBadInput`), clone is not supported for the workspace backend or source (external bucket, linked bucket on BigQuery), destinations are duplicated, `overwrite` conflicts with `preserve`, the source branch does not exist, or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
33260
35707
|
400: {
|
|
33261
35708
|
headers: {
|
|
33262
35709
|
[name: string]: unknown;
|
|
@@ -33346,7 +35793,7 @@ interface operations {
|
|
|
33346
35793
|
'application/json': components['schemas']['JobResponse'];
|
|
33347
35794
|
};
|
|
33348
35795
|
};
|
|
33349
|
-
/** @description Returned when the input is invalid (`workspace.loadRequestBadInput`), clone is not supported for the workspace backend or source (external bucket, linked bucket on BigQuery), destinations are duplicated, `overwrite` conflicts with `preserve`,
|
|
35796
|
+
/** @description Returned when the input is invalid (`workspace.loadRequestBadInput`), clone is not supported for the workspace backend or source (external bucket, linked bucket on BigQuery), destinations are duplicated, `overwrite` conflicts with `preserve`, the source branch does not exist, or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
33350
35797
|
400: {
|
|
33351
35798
|
headers: {
|
|
33352
35799
|
[name: string]: unknown;
|
|
@@ -33424,7 +35871,7 @@ interface operations {
|
|
|
33424
35871
|
'application/json': components['schemas']['ExecuteQueryResponse'];
|
|
33425
35872
|
};
|
|
33426
35873
|
};
|
|
33427
|
-
/** @description Returned when query execution is not supported for the workspace backend, login type or reader workspace. */
|
|
35874
|
+
/** @description Returned when query execution is not supported for the workspace backend, login type or reader workspace, or the workspace is deactivated (`workspace.workspaceDeactivated`). */
|
|
33428
35875
|
400: {
|
|
33429
35876
|
headers: {
|
|
33430
35877
|
[name: string]: unknown;
|
|
@@ -33547,4 +35994,4 @@ type ShareTokenInput = {
|
|
|
33547
35994
|
} & ShareTokenBody;
|
|
33548
35995
|
//#endregion
|
|
33549
35996
|
export { ProjectId as a, ShareTokenSchemaBody as c, TokenListItem as d, UpdateTokenBody as f, paths as g, components as h, GetTokenEventsInput as i, StorageToken as l, UpdateTokenSchemaBody as m, CreateTokenResponse as n, ShareTokenBody as o, UpdateTokenInput as p, CreateTokenSchemaBody as r, ShareTokenInput as s, CreateTokenBody as t, StorageTokenRaw as u };
|
|
33550
|
-
//# sourceMappingURL=types-
|
|
35997
|
+
//# sourceMappingURL=types-sV9OaqTI.d.cts.map
|