@keboola/api-client 45.0.0 → 47.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/AGENTS.md +86 -21
- package/API-SURFACE.md +49 -29
- package/CHANGELOG.md +69 -0
- package/README.md +47 -37
- package/dist/ManagementSessionMintError-4Pkn5Oob.js +36 -0
- package/dist/ManagementSessionMintError-4Pkn5Oob.js.map +1 -0
- package/dist/ManagementSessionMintError-Cu9beG7j.cjs +47 -0
- package/dist/ManagementSessionMintError-Cu9beG7j.cjs.map +1 -0
- package/dist/QueryJobError-ZZZ043Nm.js +22 -0
- package/dist/QueryJobError-ZZZ043Nm.js.map +1 -0
- package/dist/{QueryJobTimeoutError-CVNPdCWX.cjs → QueryJobError-irGiP5zh.cjs} +1 -29
- package/dist/QueryJobError-irGiP5zh.cjs.map +1 -0
- package/dist/QueueJobError-6qSEizWo.cjs +30 -0
- package/dist/QueueJobError-6qSEizWo.cjs.map +1 -0
- package/dist/QueueJobError-8bThS_Mc.js +19 -0
- package/dist/QueueJobError-8bThS_Mc.js.map +1 -0
- package/dist/adminRoles-B40yBcmq.js.map +1 -1
- package/dist/adminRoles-CO7J5qAy.cjs.map +1 -1
- package/dist/{adminRoles-C696kD_U.d.cts → adminRoles-CvdIUkiC.d.ts} +4 -2
- package/dist/{adminRoles-C696kD_U.d.ts → adminRoles-DGM8SuuF.d.cts} +4 -2
- package/dist/ai/index.cjs +2 -2
- package/dist/ai/index.d.cts +2 -2
- package/dist/ai/index.d.ts +2 -2
- package/dist/ai/index.js +2 -2
- package/dist/ai/types.d.cts +1 -1
- package/dist/ai/types.d.ts +1 -1
- package/dist/{appLogs-BG9ueGxA.cjs → appLogs-Cix2KWra.cjs} +2 -2
- package/dist/{appLogs-BG9ueGxA.cjs.map → appLogs-Cix2KWra.cjs.map} +1 -1
- package/dist/{appLogs-C9YlJ2g8.d.cts → appLogs-Cxhm2Rkn.d.cts} +2 -2
- package/dist/{appLogs-CEKz68bE.js → appLogs-KslK7qHr.js} +2 -2
- package/dist/{appLogs-CEKz68bE.js.map → appLogs-KslK7qHr.js.map} +1 -1
- package/dist/{appLogs-BS6ViVGR.d.ts → appLogs-xW0-JQXg.d.ts} +2 -2
- package/dist/apps/index.cjs +3 -3
- package/dist/apps/index.d.cts +3 -3
- package/dist/apps/index.d.ts +3 -3
- package/dist/apps/index.js +3 -3
- package/dist/apps/types.d.cts +2 -2
- package/dist/apps/types.d.ts +2 -2
- package/dist/assets/index.cjs +1 -1
- package/dist/assets/index.d.cts +1 -1
- package/dist/assets/index.d.ts +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-C6cHWIWx.js → auth-4coY1uwo.js} +2 -2
- package/dist/{auth-C6cHWIWx.js.map → auth-4coY1uwo.js.map} +1 -1
- package/dist/{auth-C9o_0bft.cjs → auth-C8Pjl0Mu.cjs} +2 -2
- package/dist/{auth-C9o_0bft.cjs.map → auth-C8Pjl0Mu.cjs.map} +1 -1
- package/dist/{authClient-CACOwVt0.js → authClient-2e8ZmzSP.js} +71 -7
- package/dist/authClient-2e8ZmzSP.js.map +1 -0
- package/dist/{authClient-CBVAT3v9.d.cts → authClient-Bso5UaXS.d.ts} +45 -33
- package/dist/{authClient-DZcAR-eW.cjs → authClient-DfkKlc-2.cjs} +82 -6
- package/dist/authClient-DfkKlc-2.cjs.map +1 -0
- package/dist/{authClient-CRumc934.d.ts → authClient-aud2dUZd.d.cts} +45 -33
- package/dist/billing/index.cjs +2 -2
- package/dist/billing/index.d.cts +1 -1
- package/dist/billing/index.d.ts +1 -1
- package/dist/billing/index.js +2 -2
- package/dist/billing/types.d.cts +1 -1
- package/dist/billing/types.d.ts +1 -1
- package/dist/chat/index.cjs +3 -3
- package/dist/chat/index.d.cts +2 -2
- package/dist/chat/index.d.ts +2 -2
- package/dist/chat/index.js +3 -3
- package/dist/chat/types.d.cts +1 -1
- package/dist/chat/types.d.ts +1 -1
- package/dist/{collect-97WhfEpt.js → collectByOffset-2XzJqmvr.js} +6 -6
- package/dist/collectByOffset-2XzJqmvr.js.map +1 -0
- package/dist/{collect-B5TCNiT1.cjs → collectByOffset-DQsqtmJg.cjs} +7 -7
- package/dist/collectByOffset-DQsqtmJg.cjs.map +1 -0
- package/dist/componentsMcp/index.cjs +3 -0
- package/dist/componentsMcp/index.d.cts +2 -0
- package/dist/componentsMcp/index.d.ts +2 -0
- package/dist/componentsMcp/index.js +2 -0
- package/dist/componentsMcp/types.cjs +0 -0
- package/dist/componentsMcp/types.d.cts +2 -0
- package/dist/componentsMcp/types.d.ts +2 -0
- package/dist/componentsMcp/types.js +1 -0
- package/dist/componentsMcp-CHobIsuU.js +57 -0
- package/dist/componentsMcp-CHobIsuU.js.map +1 -0
- package/dist/componentsMcp-pG-PcQrg.cjs +62 -0
- package/dist/componentsMcp-pG-PcQrg.cjs.map +1 -0
- package/dist/configurations-BTRHVSRq.cjs.map +1 -1
- package/dist/configurations-Chg_JwJ1.js.map +1 -1
- package/dist/constants/index.cjs +1 -1
- package/dist/constants/index.d.cts +2 -3
- package/dist/constants/index.d.ts +2 -3
- package/dist/constants/index.js +1 -1
- package/dist/{constants-Cifrqsls.js → constants-CA4UN2Xv.js} +11 -10
- package/dist/constants-CA4UN2Xv.js.map +1 -0
- package/dist/{constants-BDGRQqij.cjs → constants-a0jswUeK.cjs} +10 -9
- package/dist/constants-a0jswUeK.cjs.map +1 -0
- package/dist/{createFetchClient-DITkTV2k.js → createFetchClient-CkHdS_IG.js} +5 -5
- package/dist/createFetchClient-CkHdS_IG.js.map +1 -0
- package/dist/{createFetchClient-ClWD4ua3.cjs → createFetchClient-lZ_93Yrb.cjs} +5 -5
- package/dist/createFetchClient-lZ_93Yrb.cjs.map +1 -0
- package/dist/{createGenericFetchClient-KqiJhw8G.js → createGenericFetchClient-CQdNcPC3.js} +2 -2
- package/dist/{createGenericFetchClient-KqiJhw8G.js.map → createGenericFetchClient-CQdNcPC3.js.map} +1 -1
- package/dist/{createGenericFetchClient-B81Iezpb.cjs → createGenericFetchClient-MOx97wi-.cjs} +2 -2
- package/dist/{createGenericFetchClient-B81Iezpb.cjs.map → createGenericFetchClient-MOx97wi-.cjs.map} +1 -1
- package/dist/{createOpenapiFetchClient-CioTX11-.cjs → createOpenapiFetchClient-DHYo_k3t.cjs} +2 -2
- package/dist/{createOpenapiFetchClient-CioTX11-.cjs.map → createOpenapiFetchClient-DHYo_k3t.cjs.map} +1 -1
- package/dist/{createOpenapiFetchClient-wq8iGLZM.js → createOpenapiFetchClient-DXiMv9WL.js} +2 -2
- package/dist/{createOpenapiFetchClient-wq8iGLZM.js.map → createOpenapiFetchClient-DXiMv9WL.js.map} +1 -1
- package/dist/dataScience/index.cjs +2 -2
- package/dist/dataScience/index.d.cts +2 -2
- package/dist/dataScience/index.d.ts +2 -2
- package/dist/dataScience/index.js +2 -2
- package/dist/dataScience/types.d.cts +2 -2
- package/dist/dataScience/types.d.ts +2 -2
- package/dist/{dataScience-BwHmDoQb.js → dataScience-AwPMeGfz.js} +5 -5
- package/dist/{dataScience-BwHmDoQb.js.map → dataScience-AwPMeGfz.js.map} +1 -1
- package/dist/{dataScience-Hhoqoql_.cjs → dataScience-BjS1p8WO.cjs} +5 -5
- package/dist/{dataScience-Hhoqoql_.cjs.map → dataScience-BjS1p8WO.cjs.map} +1 -1
- package/dist/developerPortal/index.cjs +1 -1
- package/dist/developerPortal/index.d.cts +2 -2
- package/dist/developerPortal/index.d.ts +2 -2
- package/dist/developerPortal/index.js +1 -1
- package/dist/developerPortal/types.d.cts +1 -1
- package/dist/developerPortal/types.d.ts +1 -1
- package/dist/{developerPortalClient-loKq7X_U.js → developerPortalClient-Bb2suezr.js} +13 -5
- package/dist/{developerPortalClient-loKq7X_U.js.map → developerPortalClient-Bb2suezr.js.map} +1 -1
- package/dist/{developerPortalClient-COm7wJxS.cjs → developerPortalClient-DUerKw-7.cjs} +13 -5
- package/dist/{developerPortalClient-COm7wJxS.cjs.map → developerPortalClient-DUerKw-7.cjs.map} +1 -1
- package/dist/domain/permissions/index.cjs +1 -1
- package/dist/domain/permissions/index.d.cts +1 -2
- package/dist/domain/permissions/index.d.ts +1 -2
- package/dist/domain/permissions/index.js +1 -1
- package/dist/editor/index.cjs +2 -2
- package/dist/editor/index.d.cts +2 -2
- package/dist/editor/index.d.ts +2 -2
- package/dist/editor/index.js +2 -2
- package/dist/editor/types.d.cts +1 -1
- package/dist/editor/types.d.ts +1 -1
- 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.d.cts +3 -3
- package/dist/import/index.d.ts +3 -3
- package/dist/import/index.js +1 -1
- package/dist/{import-B5DcJGMI.cjs → import-BahNYv91.cjs} +3 -3
- package/dist/{import-B5DcJGMI.cjs.map → import-BahNYv91.cjs.map} +1 -1
- package/dist/{import-JlH_QaDd.js → import-FWy_wQZ1.js} +3 -3
- package/dist/{import-JlH_QaDd.js.map → import-FWy_wQZ1.js.map} +1 -1
- package/dist/{index-DeQDdut6.d.ts → index-8ZjY7YD8.d.cts} +34 -2
- package/dist/{index-CA6QxbhZ.d.ts → index-BGEuaZqI.d.cts} +238 -252
- package/dist/{index-R-w0Zncz.d.ts → index-BIP0PoMW.d.ts} +4 -4
- package/dist/index-B_MzjCeE.d.ts +46 -0
- package/dist/{index-CGCXR_6Q.d.ts → index-BeOd45XE.d.ts} +4 -4
- package/dist/{index-DeQDdut6.d.cts → index-BnPmXDVP.d.ts} +34 -2
- package/dist/{index-Cvkrjh--.d.cts → index-C2OAOK0s.d.ts} +30 -4
- package/dist/{index-Bl2EloC0.d.ts → index-CAWy1qjR.d.ts} +22482 -17133
- package/dist/{index-CGFGd3tF.d.cts → index-CkwZ5x7E.d.cts} +22482 -17133
- package/dist/{index-D9UsQOuT.d.cts → index-DTysQ_yn.d.cts} +5 -5
- package/dist/{index-CX8GAP2g.d.ts → index-DUB0BwQv.d.cts} +30 -4
- package/dist/{index-zyxZVJnd.d.ts → index-DloFSSj3.d.ts} +3 -3
- package/dist/{index-DtuwWYDR.d.ts → index-Dp-a2DdI.d.ts} +4 -4
- package/dist/{index-BHWTa4YN.d.cts → index-Ds0tViQS.d.cts} +3 -3
- package/dist/{index-BCgmwncs.d.ts → index-HSkjm3QW.d.ts} +5 -5
- package/dist/index-URgNfi5L.d.cts +46 -0
- package/dist/{index-04pgr-EO.d.cts → index-XG5cO-4H.d.cts} +4 -4
- package/dist/{types-BhEx9iRx.d.ts → index-XaPb6unB.d.cts} +4813 -1757
- package/dist/{index-DINB7vsV.d.cts → index-ZYvgoqgW.d.cts} +4 -4
- package/dist/{index-DkvrbR2i.d.cts → index-_Va9wynk.d.ts} +238 -252
- package/dist/{types-sV9OaqTI.d.cts → index-r6YSe8B-.d.ts} +4813 -1757
- package/dist/{index-BKOFRmTB.d.cts → index-x_kS_5x_.d.cts} +4 -4
- package/dist/index.cjs +171 -163
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +7 -7
- package/dist/index.d.ts +7 -7
- package/dist/index.js +100 -97
- package/dist/index.js.map +1 -1
- package/dist/{isLoginPageRedirect-CsyRa3_v.js → isLoginPageRedirect-B4QKSiSa.js} +2 -2
- package/dist/{isLoginPageRedirect-CsyRa3_v.js.map → isLoginPageRedirect-B4QKSiSa.js.map} +1 -1
- package/dist/{isLoginPageRedirect-iNbwl3iz.cjs → isLoginPageRedirect-r0Opgc1n.cjs} +2 -2
- package/dist/{isLoginPageRedirect-iNbwl3iz.cjs.map → isLoginPageRedirect-r0Opgc1n.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/types.d.cts +1 -1
- package/dist/kaiAgent/types.d.ts +1 -1
- package/dist/{kaiAgent-BhcUsBDk.cjs → kaiAgent-BmfUG8bB.cjs} +5 -5
- package/dist/{kaiAgent-BhcUsBDk.cjs.map → kaiAgent-BmfUG8bB.cjs.map} +1 -1
- package/dist/{kaiAgent-CUeT53-K.js → kaiAgent-CBPbMwBh.js} +5 -5
- package/dist/{kaiAgent-CUeT53-K.js.map → kaiAgent-CBPbMwBh.js.map} +1 -1
- package/dist/{kaiMemory-DaOh0zVn.js → kaiMemory-C9di17bd.js} +2 -2
- package/dist/{kaiMemory-DaOh0zVn.js.map → kaiMemory-C9di17bd.js.map} +1 -1
- package/dist/{kaiMemory-Cf81ghNd.cjs → kaiMemory-Qch09f-m.cjs} +2 -2
- package/dist/{kaiMemory-Cf81ghNd.cjs.map → kaiMemory-Qch09f-m.cjs.map} +1 -1
- package/dist/management/index.cjs +2 -1
- package/dist/management/index.d.cts +2 -2
- package/dist/management/index.d.ts +2 -2
- package/dist/management/index.js +2 -2
- package/dist/management/types.d.cts +2 -2
- package/dist/management/types.d.ts +2 -2
- package/dist/{management-C5lf9nsU.cjs → management-BUGPJ1Bu.cjs} +46 -10
- package/dist/management-BUGPJ1Bu.cjs.map +1 -0
- package/dist/{management-WAtKH6Tu.js → management-DAg2obYt.js} +39 -9
- package/dist/management-DAg2obYt.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 +1 -1
- package/dist/metastore/types.d.ts +1 -1
- package/dist/{metastore-YPHUK3jJ.cjs → metastore-BXHg33ku.cjs} +4 -4
- package/dist/{metastore-YPHUK3jJ.cjs.map → metastore-BXHg33ku.cjs.map} +1 -1
- package/dist/{metastore-D0C6uaPX.js → metastore-Ywq08DBz.js} +4 -4
- package/dist/{metastore-D0C6uaPX.js.map → metastore-Ywq08DBz.js.map} +1 -1
- package/dist/microsoftGraph/index.cjs +2 -2
- package/dist/microsoftGraph/index.d.cts +3 -3
- package/dist/microsoftGraph/index.d.ts +3 -3
- package/dist/microsoftGraph/index.js +2 -2
- package/dist/microsoftGraph/types.d.cts +2 -2
- package/dist/microsoftGraph/types.d.ts +2 -2
- package/dist/{middleware-DmR6OhTY.js → middleware-CWaLMlG1.js} +2 -2
- package/dist/{middleware-DmR6OhTY.js.map → middleware-CWaLMlG1.js.map} +1 -1
- package/dist/{middleware-D_p5TctO.cjs → middleware-DU_5pFDW.cjs} +2 -2
- package/dist/{middleware-D_p5TctO.cjs.map → middleware-DU_5pFDW.cjs.map} +1 -1
- package/dist/notifications/index.cjs +3 -3
- package/dist/notifications/index.d.cts +2 -2
- package/dist/notifications/index.d.ts +2 -2
- package/dist/notifications/index.js +3 -3
- package/dist/notifications/types.d.cts +1 -1
- package/dist/notifications/types.d.ts +1 -1
- package/dist/oauth/index.cjs +1 -1
- package/dist/oauth/index.d.cts +6 -2
- package/dist/oauth/index.d.ts +6 -2
- package/dist/oauth/index.js +1 -1
- package/dist/oauth/types.d.cts +2 -2
- package/dist/oauth/types.d.ts +2 -2
- package/dist/{oauth-DyUwTqHJ.cjs → oauth-DKZPuUlt.cjs} +17 -6
- package/dist/{oauth-DyUwTqHJ.cjs.map → oauth-DKZPuUlt.cjs.map} +1 -1
- package/dist/{oauth-Ck_Fe14o.js → oauth-GXmZ9agP.js} +17 -6
- package/dist/{oauth-Ck_Fe14o.js.map → oauth-GXmZ9agP.js.map} +1 -1
- package/dist/omnisearch/index.cjs +2 -2
- package/dist/omnisearch/index.d.cts +2 -2
- package/dist/omnisearch/index.d.ts +2 -2
- package/dist/omnisearch/index.js +2 -2
- package/dist/omnisearch/types.d.cts +1 -1
- package/dist/omnisearch/types.d.ts +1 -1
- package/dist/project-BMmfPhXg.d.ts +74 -0
- package/dist/{project-DWwZv66D.js → project-BXLFrWJ6.js} +7 -1
- package/dist/project-BXLFrWJ6.js.map +1 -0
- package/dist/{project-BvFi19K_.cjs → project-CpgplgCr.cjs} +7 -1
- package/dist/project-CpgplgCr.cjs.map +1 -0
- package/dist/project-dxCJbFay.d.cts +74 -0
- 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/types.d.cts +2 -2
- package/dist/queryService/types.d.ts +2 -2
- package/dist/{queryService-Blfz59Ms.js → queryService-C-pZha5p.js} +36 -27
- package/dist/queryService-C-pZha5p.js.map +1 -0
- package/dist/{queryService-RlNYw7LG.cjs → queryService-CzK53q94.cjs} +36 -27
- package/dist/queryService-CzK53q94.cjs.map +1 -0
- package/dist/queue/index.cjs +1 -1
- package/dist/queue/index.d.cts +75 -7
- package/dist/queue/index.d.ts +75 -7
- package/dist/queue/index.js +1 -1
- package/dist/queue/types.d.cts +1 -1
- package/dist/queue/types.d.ts +1 -1
- package/dist/{queue-BrgRdtOr.cjs → queue-BJvDWriM.cjs} +35 -25
- package/dist/queue-BJvDWriM.cjs.map +1 -0
- package/dist/{queue-CNvR-M23.js → queue-D6-x4OGF.js} +35 -25
- package/dist/queue-D6-x4OGF.js.map +1 -0
- package/dist/scheduler/index.cjs +3 -3
- package/dist/scheduler/index.d.cts +2 -2
- package/dist/scheduler/index.d.ts +2 -2
- package/dist/scheduler/index.js +3 -3
- package/dist/scheduler/types.d.cts +1 -1
- package/dist/scheduler/types.d.ts +1 -1
- package/dist/{schema-DJa9WBjR.d.cts → schema-BUyMwQnM.d.cts} +7 -1
- package/dist/{schema-DJa9WBjR.d.ts → schema-BUyMwQnM.d.ts} +7 -1
- package/dist/sdk/configurations/index.d.cts +2 -4
- package/dist/sdk/configurations/index.d.ts +2 -4
- package/dist/sdk/developerPortal/index.cjs +3 -3
- package/dist/sdk/developerPortal/index.d.cts +29 -3
- package/dist/sdk/developerPortal/index.d.ts +29 -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.cjs +34 -55
- package/dist/sdk/queryService/index.cjs.map +1 -1
- package/dist/sdk/queryService/index.d.cts +2 -2
- package/dist/sdk/queryService/index.d.ts +2 -2
- package/dist/sdk/queryService/index.js +34 -55
- package/dist/sdk/queryService/index.js.map +1 -1
- package/dist/sdk/semanticLayer/index.d.cts +1 -1
- package/dist/sdk/semanticLayer/index.d.ts +1 -1
- package/dist/sdk/semanticLayer/types.d.cts +1 -1
- package/dist/sdk/semanticLayer/types.d.ts +1 -1
- package/dist/sdk/storage/index.cjs +0 -119
- package/dist/sdk/storage/index.cjs.map +1 -1
- package/dist/sdk/storage/index.d.cts +103 -2
- package/dist/sdk/storage/index.d.ts +103 -2
- package/dist/sdk/storage/index.js +1 -119
- 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/status/index.cjs +1 -1
- package/dist/status/index.d.cts +1 -1
- package/dist/status/index.d.ts +1 -1
- package/dist/status/index.js +1 -1
- package/dist/storage/index.cjs +15 -10
- package/dist/storage/index.d.cts +3 -3
- package/dist/storage/index.d.ts +3 -3
- package/dist/storage/index.js +7 -6
- package/dist/storage/types.d.cts +6 -5
- package/dist/storage/types.d.ts +6 -5
- package/dist/{storage-RkNaOFJ-.js → storage-DyR7hDdv.js} +347 -168
- package/dist/storage-DyR7hDdv.js.map +1 -0
- package/dist/{storage-76Sf_z_H.cjs → storage-yovv11k6.cjs} +366 -169
- package/dist/storage-yovv11k6.cjs.map +1 -0
- package/dist/stream/index.cjs +3 -3
- package/dist/stream/index.d.cts +2 -2
- package/dist/stream/index.d.ts +2 -2
- package/dist/stream/index.js +3 -3
- package/dist/stream/types.d.cts +1 -1
- package/dist/stream/types.d.ts +1 -1
- package/dist/syncActions/index.cjs +1 -1
- package/dist/syncActions/index.d.cts +2 -2
- package/dist/syncActions/index.d.ts +2 -2
- package/dist/syncActions/index.js +1 -1
- package/dist/syncActions/types.d.cts +1 -1
- package/dist/syncActions/types.d.ts +1 -1
- package/dist/{syncActions-DlNPhZY4.cjs → syncActions-C1rE4R3f.cjs} +5 -5
- package/dist/{syncActions-DlNPhZY4.cjs.map → syncActions-C1rE4R3f.cjs.map} +1 -1
- package/dist/{syncActions-BvFUa9xV.js → syncActions-DM8vP7p3.js} +5 -5
- package/dist/{syncActions-BvFUa9xV.js.map → syncActions-DM8vP7p3.js.map} +1 -1
- package/dist/telemetry/index.cjs +3 -6
- package/dist/telemetry/index.cjs.map +1 -1
- package/dist/telemetry/index.d.cts +2 -5
- package/dist/telemetry/index.d.ts +2 -5
- package/dist/telemetry/index.js +3 -6
- package/dist/telemetry/index.js.map +1 -1
- package/dist/telemetry/types.d.cts +1 -1
- package/dist/telemetry/types.d.ts +1 -1
- package/dist/{jobStatus-BJdbZ72V.js → transientRetries-B4iusp69.js} +79 -37
- package/dist/transientRetries-B4iusp69.js.map +1 -0
- package/dist/{jobStatus-B0E-MZ9I.cjs → transientRetries-DdJfH9QK.cjs} +82 -40
- package/dist/transientRetries-DdJfH9QK.cjs.map +1 -0
- package/dist/{types-tgU8XvPs.d.cts → types--qQPfxWt.d.cts} +2 -2
- package/dist/types-4CjbcUdD.d.cts +1536 -0
- package/dist/{types-DaMmgW-O.d.ts → types-4HmtNuJf.d.ts} +2 -2
- package/dist/types-4bSZLxq3.d.cts +1973 -0
- package/dist/{types-BaSlU0uo.d.ts → types-7DBpH7Rf.d.ts} +2 -2
- package/dist/types-B2ZLjagf.d.ts +1536 -0
- package/dist/{types-DgPt4LY_.d.cts → types-B6ozaDkl.d.cts} +192 -78
- package/dist/{types-YHUEArkR.d.cts → types-BBbzWczQ.d.cts} +2 -2
- package/dist/{types-CgBzm1YR.d.cts → types-BG0oWq8u.d.cts} +2 -2
- package/dist/types-BIDKSQdc.d.ts +1973 -0
- package/dist/{types-ByLH46Dt.d.cts → types-BKIcow3B.d.cts} +2 -2
- package/dist/{types-CfwqVkEA.d.ts → types-BNPvFLgC.d.ts} +2 -2
- package/dist/{types-DlQw6FCi.d.ts → types-BXgINefw.d.ts} +2 -2
- package/dist/{types-CalDJHCX.d.cts → types-BZBU3mwz.d.cts} +3 -3
- package/dist/{types-Bydx6ga_.d.cts → types-B_1plf0y.d.cts} +2 -2
- package/dist/{types-Ccd9O6ca.d.cts → types-B_3zoXA1.d.cts} +3 -3
- package/dist/{types-BBUZ9EHs.d.ts → types-BcQ3j8xK.d.ts} +8 -2
- package/dist/{types-B8N_k79M.d.cts → types-BdF6NDvo.d.cts} +2 -2
- package/dist/{types-CABWhTa9.d.ts → types-BiBBKcin.d.ts} +3 -3
- package/dist/{types-DVt0qlzI.d.cts → types-BiTn_JVW.d.cts} +736 -289
- package/dist/{types-CN6huo55.d.ts → types-BjEiUOL6.d.ts} +192 -78
- package/dist/{types-z82gSTx8.d.ts → types-BoH7NFCh.d.ts} +3 -3
- package/dist/{types-CcYxlqtB.d.cts → types-BwsE-pFo.d.cts} +2 -2
- package/dist/{types-DrvKfXXd.d.cts → types-Bx0TSdwF.d.cts} +2 -2
- package/dist/{types-DazRtukc.d.ts → types-C2JMisvL.d.ts} +736 -289
- package/dist/{types-DVZpKGBJ.d.ts → types-C2j6Jsie.d.ts} +3 -3
- package/dist/{types-BZDV8DZk.d.ts → types-C3IQu1gV.d.ts} +11 -6
- package/dist/{types-WZBztugL.d.ts → types-C7t_6FLh.d.ts} +2 -2
- package/dist/{types-Fs4a3mVs.d.ts → types-CBrNIgEy.d.ts} +64 -5
- package/dist/{types-CZJlLCbA.d.ts → types-CEw2IzWk.d.ts} +2 -2
- package/dist/{types-DdsYv2WG.d.cts → types-CMKIdreQ.d.cts} +3 -3
- package/dist/{types-AYX7VtS6.d.ts → types-COQOzyac.d.ts} +212 -2
- package/dist/{types-BiEh5c_t.d.cts → types-CZCPdPqv.d.cts} +132 -5
- package/dist/{types-B2w2TtSA.d.ts → types-Cw9UISvM.d.ts} +2 -2
- package/dist/{types-D9axmt5o.d.cts → types-D51g4h9w.d.cts} +8 -2
- package/dist/{types-CBPKpLTf.d.cts → types-D8w9lyb8.d.cts} +212 -2
- package/dist/{types-Dd31Lw4S.d.cts → types-DBJ8c3hN.d.cts} +2 -2
- package/dist/{types-DzV6LaZq.d.ts → types-DHlXKVEM.d.ts} +132 -5
- package/dist/{types-c_bsDkV6.d.cts → types-DPDq8C4q.d.cts} +16 -4
- package/dist/{types-D3wcs4tp.d.ts → types-DWJVbskE.d.ts} +2 -2
- package/dist/{types-CAp1VexS.d.ts → types-Dg8a7m7f.d.ts} +16 -4
- package/dist/{types-CoJVrRAD.d.ts → types-DgIzXY-Y.d.ts} +2 -2
- package/dist/{types-pvQzbgNE.d.cts → types-L50Y6ATu.d.cts} +11 -6
- package/dist/{types-DoZtE9tz.d.cts → types-OkQWmonU.d.cts} +2 -2
- package/dist/{types-BPy5Ozee.d.cts → types-TRJiPqJr.d.cts} +2 -2
- package/dist/{types-B-5ya_L5.d.ts → types-ij6BpTzR.d.ts} +2 -2
- package/dist/{types-DicSaNwq.d.ts → types-ituiCs8g.d.ts} +2 -2
- package/dist/{types-CGm2fQKK.d.cts → types-kbyIaA7p.d.cts} +64 -5
- package/dist/{validateConnectionStatus-DR-0h35y.cjs → validateConnectionStatus-BalWEyRk.cjs} +3 -3
- package/dist/{validateConnectionStatus-DR-0h35y.cjs.map → validateConnectionStatus-BalWEyRk.cjs.map} +1 -1
- package/dist/{validateConnectionStatus-CdTV3gsP.js → validateConnectionStatus-DyrYpn0G.js} +3 -3
- package/dist/{validateConnectionStatus-CdTV3gsP.js.map → validateConnectionStatus-DyrYpn0G.js.map} +1 -1
- package/dist/vault/index.cjs +6 -6
- package/dist/vault/index.cjs.map +1 -1
- package/dist/vault/index.d.cts +1 -1
- package/dist/vault/index.d.ts +1 -1
- package/dist/vault/index.js +6 -6
- package/dist/vault/index.js.map +1 -1
- package/dist/vault/types.d.cts +1 -1
- package/dist/vault/types.d.ts +1 -1
- package/package.json +27 -1
- package/surface/apps.md +5 -5
- package/surface/auth.md +21 -19
- package/surface/chat.md +2 -2
- package/surface/componentsMcp.md +9 -0
- package/surface/dataScience.md +2 -2
- package/surface/kaiAgent.md +2 -2
- package/surface/management.md +43 -41
- package/surface/oauth.md +1 -0
- package/surface/queryService.md +4 -4
- package/surface/queue.md +2 -2
- package/surface/sdk.md +0 -24
- package/surface/storage.md +101 -71
- package/dist/ManagementClientAuthError-BcPYxAWZ.js +0 -16
- package/dist/ManagementClientAuthError-BcPYxAWZ.js.map +0 -1
- package/dist/ManagementClientAuthError-DHuykEPF.cjs +0 -21
- package/dist/ManagementClientAuthError-DHuykEPF.cjs.map +0 -1
- package/dist/QueryJobTimeoutError-C7JbNGOM.js +0 -38
- package/dist/QueryJobTimeoutError-C7JbNGOM.js.map +0 -1
- package/dist/QueryJobTimeoutError-CVNPdCWX.cjs.map +0 -1
- package/dist/authClient-CACOwVt0.js.map +0 -1
- package/dist/authClient-DZcAR-eW.cjs.map +0 -1
- package/dist/collect-97WhfEpt.js.map +0 -1
- package/dist/collect-B5TCNiT1.cjs.map +0 -1
- package/dist/constants-BDGRQqij.cjs.map +0 -1
- package/dist/constants-Cifrqsls.js.map +0 -1
- package/dist/createFetchClient-ClWD4ua3.cjs.map +0 -1
- package/dist/createFetchClient-DITkTV2k.js.map +0 -1
- package/dist/index-BVhHt5lx.d.cts +0 -241
- package/dist/index-Bf8dr2KQ.d.ts +0 -16
- package/dist/index-BgR5zcjJ.d.ts +0 -241
- package/dist/index-CWPi7lBF.d.ts +0 -77
- package/dist/index-Dd40ojPr.d.cts +0 -77
- package/dist/index-DkCXaYsn.d.cts +0 -16
- package/dist/jobStatus-B0E-MZ9I.cjs.map +0 -1
- package/dist/jobStatus-BJdbZ72V.js.map +0 -1
- package/dist/management-C5lf9nsU.cjs.map +0 -1
- package/dist/management-WAtKH6Tu.js.map +0 -1
- package/dist/project-B8wtlstY.d.cts +0 -18
- package/dist/project-BCc3mpAy.d.ts +0 -18
- package/dist/project-BvFi19K_.cjs.map +0 -1
- package/dist/project-DWwZv66D.js.map +0 -1
- package/dist/queryService-Blfz59Ms.js.map +0 -1
- package/dist/queryService-RlNYw7LG.cjs.map +0 -1
- package/dist/queue-BrgRdtOr.cjs.map +0 -1
- package/dist/queue-CNvR-M23.js.map +0 -1
- package/dist/serviceIds-DRcoTnSd.d.cts +0 -32
- package/dist/serviceIds-DRcoTnSd.d.ts +0 -32
- package/dist/storage-76Sf_z_H.cjs.map +0 -1
- package/dist/storage-RkNaOFJ-.js.map +0 -1
- package/dist/types-9SEE4icc.d.ts +0 -1298
- package/dist/types-BhOUS9j1.d.cts +0 -749
- package/dist/types-BjR8Yodc.d.cts +0 -1298
- package/dist/types-CLHaZv9f.d.cts +0 -1868
- package/dist/types-CaOtNjSZ.d.ts +0 -957
- package/dist/types-D1A4mAG0.d.cts +0 -66
- package/dist/types-D8pGSkRe.d.ts +0 -1868
- package/dist/types-DxN2siRW.d.ts +0 -66
- package/dist/types-ePSqbXRr.d.cts +0 -957
- package/dist/types-gcAb6olM.d.ts +0 -749
package/surface/dataScience.md
CHANGED
|
@@ -12,8 +12,8 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
12
12
|
- `api.dataScience.getAppLogsDownload(id: string, signal?: AbortSignal | undefined): Promise<{ logs: string; fileName: string; }>`
|
|
13
13
|
- `api.dataScience.getAppLogsTail(id: string, { query, signal }?: { query?: { since?: string | undefined; lines?: number | undefined; } | undefined; signal?: AbortSignal | undefined; }): Promise<{ entries: LogEntry[]; nextLogTimestamp: string | null; }>`
|
|
14
14
|
- `api.dataScience.getAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ password?: string | undefined; }>`
|
|
15
|
-
- `api.dataScience.getAppRun(appId: string, runId: string, signal?: AbortSignal | undefined): Promise<{ state: "
|
|
16
|
-
- `api.dataScience.getAppRuns(appId: string, query?: { offset?: number | undefined; limit?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ state: "
|
|
15
|
+
- `api.dataScience.getAppRun(appId: string, runId: string, signal?: AbortSignal | undefined): Promise<{ state: "starting" | "running" | "failed" | "finished"; id: string; appId: string; createdAt?: string | null | undefined; startedAt?: string | null | undefined; stoppedAt?: string | null | undefined; startupLogs?: string | null | undefined; runtimeSize?: string | null | undefined; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode: "dev" | "prod"; }>`
|
|
16
|
+
- `api.dataScience.getAppRuns(appId: string, query?: { offset?: number | undefined; limit?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ state: "starting" | "running" | "failed" | "finished"; id: string; appId: string; createdAt?: string | null | undefined; startedAt?: string | null | undefined; stoppedAt?: string | null | undefined; startupLogs?: string | null | undefined; runtimeSize?: string | null | undefined; runtimeBackendType?: string | null | undefined; configVersion?: string | null | undefined; imageVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode: "dev" | "prod"; }[]>`
|
|
17
17
|
- `api.dataScience.getApps(query: { offset?: number | undefined; limit?: number | undefined; componentId?: string | undefined; type?: ("snowflake" | "bigquery" | "python" | "r" | "streamlit" | "python-js")[] | undefined; branchId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; type?: string | null | undefined; projectId: string; componentId: string; branchId: string | null; configId: string; configVersion: string; state: "created" | "starting" | "running" | "restarting" | "stopping" | "stopped" | "deleting" | "deleted"; desiredState: "running" | "stopped" | "deleted"; mode: "dev" | "prod"; lastRequestTimestamp: string | null; lastStartTimestamp?: string | null | undefined; url?: string | null | undefined; autoSuspendAfterSeconds?: number | undefined; autoRestartEnabled?: boolean | undefined; size?: string | null | undefined; hasManagedGitRepo?: boolean | undefined; }[]>`
|
|
18
18
|
- `api.dataScience.getRuntimes(signal?: AbortSignal | undefined): Promise<{ description: string; type: string; isTypeDefault: boolean; releaseDate: string; endOfLifeDate?: string | null | undefined; imageName?: string | null | undefined; imageTag?: string | null | undefined; transformationComponentId?: string | null | undefined; transformationComponentTag?: string | null | undefined; sandboxImageName?: string | null | undefined; sandboxImageTag?: string | null | undefined; }[]>`
|
|
19
19
|
- `api.dataScience.getSandbox(appId: string, signal?: AbortSignal | undefined): Promise<{ id?: string | undefined; projectId?: string | undefined; tokenId?: string | undefined; branchId?: string | null | undefined; configurationId?: string | undefined; physicalId?: string | undefined; type?: string | undefined; active?: boolean | undefined; createdTimestamp?: string | undefined; startTimestamp?: string | undefined; updatedTimestamp?: string | undefined; persistentStorage?: { pvcName?: string | null | undefined; k8sManifest?: string | null | undefined; isEnabled?: boolean | undefined; ready?: boolean | null | undefined; k8sStorageClassName?: string | null | undefined; } | undefined; shared?: boolean | undefined; componentId?: string | undefined; configurationVersion?: string | undefined; size?: string | null | undefined; lastAutosaveTimestamp?: string | null | undefined; expirationTimestamp?: string | null | undefined; autoSuspendAfterSeconds?: number | undefined; expirationAfterHours?: number | undefined; user?: string | null | undefined; url?: string | null | undefined; password?: string | null | undefined; autosaveTokenId?: string | null | undefined; host?: string | null | undefined; imageVersion?: string | null | undefined; packages?: string[] | null | undefined; sizeParameters?: unknown; stagingWorkspaceId?: unknown; stagingWorkspaceType?: unknown; workspaceDetails?: unknown; databricks?: unknown; credentials?: unknown; }>`
|
package/surface/kaiAgent.md
CHANGED
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
6
6
|
|
|
7
7
|
- `api.kaiAgent.approveToolCall(chatId: string, body: { toolUseId: string; approved: boolean; reason?: string | undefined; dismissed?: boolean | undefined; updatedInput?: { [key: string]: unknown; } | undefined; answers?: { [key: string]: string; } | undefined; }): Promise<void>`
|
|
8
|
-
- `api.kaiAgent.createChat(request: { id: string; message: { id: string; role: "user" | "assistant"; parts: { [key: string]: unknown; }[]; metadata?: { hidden?: boolean | undefined; autoForwarded?: boolean | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; tableContext?: { tableName: string; tableId: string; bucketId: string; fileName: string; }[] | undefined; } | undefined; }; selectedChatModel?: string | undefined; selectedVisibilityType?: "public" | "private" | undefined; branchId?: number | undefined; model?: string | undefined; toolRestrictions?: { allowedTools?: string[] | undefined; disallowedTools?: string[] | undefined; readOnlyMode?: boolean | undefined; } | undefined; telemetryMetadata?: { [key: string]: string | number | boolean; } | undefined; supportsApprovalRequestedEvent?: boolean | undefined; client?: "kbc-ui" | "business-chat" | undefined; }): Promise<Response>`
|
|
8
|
+
- `api.kaiAgent.createChat(request: { id: string; message: { id: string; role: "user" | "assistant"; parts: { [key: string]: unknown; }[]; metadata?: { hidden?: boolean | undefined; autoForwarded?: boolean | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; deployPreapproval?: { configurationId: string; } | undefined; tableContext?: { tableName: string; tableId: string; bucketId: string; fileName: string; }[] | undefined; previewSelections?: { source: string | null; sourceTrail: string[]; selector: string; tag: string; text: string; html: string; rect: { x: number; y: number; width: number; height: number; }; page: string; viewport: { width: number; height: number; }; area?: { inside: { source: string | null; tag: string; text: string; }[]; within: { source: string | null; tag: string; text: string; } | null; above: { source: string | null; tag: string; text: string; } | null; below: { source: string | null; tag: string; text: string; } | null; } | undefined; }[] | undefined; previewIntent?: "data-source" | undefined; } | undefined; }; selectedChatModel?: string | undefined; selectedVisibilityType?: "public" | "private" | undefined; branchId?: number | undefined; model?: string | undefined; toolRestrictions?: { allowedTools?: string[] | undefined; disallowedTools?: string[] | undefined; readOnlyMode?: boolean | undefined; } | undefined; telemetryMetadata?: { [key: string]: string | number | boolean; } | undefined; supportsApprovalRequestedEvent?: boolean | undefined; client?: "kbc-ui" | "business-chat" | undefined; }): Promise<Response>`
|
|
9
9
|
- `api.kaiAgent.deleteChat(chatId: string): Promise<{ id?: string | undefined; title?: string | undefined; userId?: string | undefined; createdAt?: string | undefined; visibility?: "public" | "private" | undefined; branchId?: number | null | undefined; }>`
|
|
10
10
|
- `api.kaiAgent.deleteUserMemory(memoryId: string, signal?: AbortSignal | undefined): Promise<void>`
|
|
11
11
|
- `api.kaiAgent.downloadSandboxFile(chatId: string, path: string, signal?: AbortSignal | undefined): Promise<Blob>`
|
|
12
12
|
- `api.kaiAgent.getAgentSettings(signal?: AbortSignal | undefined): Promise<{ projectId: string; customInstructions: string | null; createdAt: string; updatedAt: string; toolPermissions?: Record<string, ProjectToolPolicyValue> | null | undefined; canWriteToolPolicy?: boolean | undefined; }>`
|
|
13
13
|
- `api.kaiAgent.getArtifact(artifactId: string, signal?: AbortSignal | undefined): Promise<{ id: string; chatId: string; messageId: string; kind: "table" | "chart" | "document"; title: string; summary: string | null; spec: { [key: string]: unknown; }; recipe: { [key: string]: unknown; }; createdAt: string; }>`
|
|
14
14
|
- `api.kaiAgent.getArtifacts(chatId: string, signal?: AbortSignal | undefined): Promise<{ id: string; chatId: string; messageId: string; kind: "table" | "chart" | "document"; title: string; summary: string | null; spec: { [key: string]: unknown; }; recipe: { [key: string]: unknown; }; createdAt: string; }[]>`
|
|
15
|
-
- `api.kaiAgent.getChat(chatId: string, signal?: AbortSignal | undefined): Promise<{ id: string; title: string; userId: string; createdAt: string; lastMessageAt: string; visibility: "public" | "private"; branchId?: number | null | undefined; contextWindow?: { usedTokens: number; maxTokens: number; percentage: number; } | null | undefined; ppuUsed: number | null; ppuPercentage: number | null; model: string | null; effort: "medium" | "low" | "high" | "xhigh" | "max" | null; effectiveModel: string | null; messages: { id: string; role: "user" | "assistant"; parts: ({ type: "text"; text: string; state?: "done" | undefined; } | { type: "tool-result"; toolCallId: string; toolName: string; result: string; } | { type: "step-start"; } | { type: "data-compact-boundary"; data: { trigger: "manual" | "auto"; preTokens: number; preservedSegment?: { headUuid: string; anchorUuid: string; tailUuid: string; } | undefined; summary: string; sdkSessionId: string; }; } | { type: string; toolCallId: string; state: "output-available" | "output-error" | "output-denied" | "input-available" | "input-streaming" | "approval-requested" | "approval-responded"; input?: { [key: string]: unknown; } | undefined; output?: unknown; errorText?: string | undefined; approval?: { id: string; approved: boolean; reason?: string | undefined; } | undefined; })[]; metadata?: { createdAt?: string | undefined; hidden?: boolean | undefined; autoForwarded?: boolean | undefined; pausedReason?: "turn-budget" | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; } | undefined; status?: "pending" | "
|
|
15
|
+
- `api.kaiAgent.getChat(chatId: string, signal?: AbortSignal | undefined): Promise<{ id: string; title: string; userId: string; createdAt: string; lastMessageAt: string; visibility: "public" | "private"; branchId?: number | null | undefined; contextWindow?: { usedTokens: number; maxTokens: number; percentage: number; } | null | undefined; ppuUsed: number | null; ppuPercentage: number | null; model: string | null; effort: "medium" | "low" | "high" | "xhigh" | "max" | null; effectiveModel: string | null; messages: { id: string; role: "user" | "assistant"; parts: ({ type: "text"; text: string; state?: "done" | undefined; } | { type: "tool-result"; toolCallId: string; toolName: string; result: string; } | { type: "step-start"; } | { type: "data-compact-boundary"; data: { trigger: "manual" | "auto"; preTokens: number; preservedSegment?: { headUuid: string; anchorUuid: string; tailUuid: string; } | undefined; summary: string; sdkSessionId: string; }; } | { type: string; toolCallId: string; state: "output-available" | "output-error" | "output-denied" | "input-available" | "input-streaming" | "approval-requested" | "approval-responded"; input?: { [key: string]: unknown; } | undefined; output?: unknown; errorText?: string | undefined; approval?: { id: string; approved: boolean; reason?: string | undefined; } | undefined; })[]; metadata?: { createdAt?: string | undefined; hidden?: boolean | undefined; autoForwarded?: boolean | undefined; pausedReason?: "turn-budget" | undefined; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; } | undefined; status?: "pending" | "failed" | "completed" | "interrupted" | undefined; }[]; }>`
|
|
16
16
|
- `api.kaiAgent.getHistory(params?: { limit?: number | undefined; starting_after?: string | undefined; ending_before?: string | undefined; client?: "kbc-ui" | "business-chat" | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ chats: { id?: string | undefined; title?: string | undefined; userId?: string | undefined; createdAt?: string | undefined; lastMessageAt?: string | undefined; visibility?: "public" | "private" | undefined; branchId?: number | null | undefined; client?: "kbc-ui" | "business-chat" | null | undefined; }[]; hasMore: boolean; }>`
|
|
17
17
|
- `api.kaiAgent.getSandboxGitBranch(chatId: string, signal?: AbortSignal | undefined): Promise<{ branch: string | null; }>`
|
|
18
18
|
- `api.kaiAgent.getSkillsList(signal?: AbortSignal | undefined): Promise<{ skills: { name: string; description: string | null; source: "first-party" | "vendored" | "project"; }[]; commands: { name: string; description: string; }[]; }>`
|
package/surface/management.md
CHANGED
|
@@ -5,14 +5,14 @@
|
|
|
5
5
|
Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
6
6
|
|
|
7
7
|
- `api.management.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
|
|
8
|
-
- `api.management.verifyToken(signal?: AbortSignal | undefined): Promise<{ id: number; description: string; created: string; lastUsed: string | null; expires: string | null; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; scopes: string[]; type: string; creator: { id: number; name: string; }; user?: { id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; } |
|
|
8
|
+
- `api.management.verifyToken(signal?: AbortSignal | undefined): Promise<{ id: number; description: string; created: string; lastUsed: string | null; expires: string | null; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; scopes: string[]; type: string; creator: { id: number; name: string; }; user?: { id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; } | undefined; }>`
|
|
9
9
|
|
|
10
10
|
### `api.management.applicationTokens`
|
|
11
11
|
|
|
12
|
-
- `api.management.applicationTokens.createApplicationToken(body: { description: string; scopes?: string[] | null | undefined; expiresIn?: number | null | undefined; }): Promise<{ id: number; description: string; created: string; lastUsed
|
|
12
|
+
- `api.management.applicationTokens.createApplicationToken(body: { description: string; scopes?: string[] | null | undefined; expiresIn?: number | null | undefined; }): Promise<{ id: number; description: string; created: string; lastUsed: string | null; expires: string | null; scopes: string[]; creator: { id: number; name: string; }; token: string; }>`
|
|
13
13
|
- `api.management.applicationTokens.deleteApplicationToken(tokenId: number): Promise<void>`
|
|
14
14
|
- `api.management.applicationTokens.getApplicationTokenScopes(signal?: AbortSignal | undefined): Promise<string[]>`
|
|
15
|
-
- `api.management.applicationTokens.getApplicationTokens(signal?: AbortSignal | undefined): Promise<{ id: number; description: string; created
|
|
15
|
+
- `api.management.applicationTokens.getApplicationTokens(signal?: AbortSignal | undefined): Promise<{ id: number; description: string; created: string | null; lastUsed: string | null; expires: string | null; isDisabled: boolean; isExpired: boolean; scopes: string[]; creator: { id: number | null; name: string | null; }; }[]>`
|
|
16
16
|
|
|
17
17
|
### `api.management.currentUser`
|
|
18
18
|
|
|
@@ -20,22 +20,22 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
20
20
|
- `api.management.currentUser.acceptOrganizationInvitation(id: number): Promise<void>`
|
|
21
21
|
- `api.management.currentUser.acceptProjectInvitation(id: number): Promise<void>`
|
|
22
22
|
- `api.management.currentUser.deleteProjectJoinRequest(id: number): Promise<void>`
|
|
23
|
-
- `api.management.currentUser.getMaintainerInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; maintainer: { id
|
|
24
|
-
- `api.management.currentUser.getMaintainerInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; maintainer: { id
|
|
25
|
-
- `api.management.currentUser.getOrganizationInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; organization: { id
|
|
26
|
-
- `api.management.currentUser.getOrganizationInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; organization: { id
|
|
27
|
-
- `api.management.currentUser.getProjectInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires
|
|
28
|
-
- `api.management.currentUser.getProjectInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires
|
|
29
|
-
- `api.management.currentUser.getProjectJoinRequest(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires
|
|
30
|
-
- `api.management.currentUser.getProjectJoinRequests(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires
|
|
23
|
+
- `api.management.currentUser.getMaintainerInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; maintainer: { id: number; name: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
24
|
+
- `api.management.currentUser.getMaintainerInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; maintainer: { id: number; name: string; }; creator: { id: number; name: string; email: string; }; }[]>`
|
|
25
|
+
- `api.management.currentUser.getOrganizationInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; organization: { id: number; name: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
26
|
+
- `api.management.currentUser.getOrganizationInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; organization: { id: number; name: string; }; creator: { id: number; name: string; email: string; }; }[]>`
|
|
27
|
+
- `api.management.currentUser.getProjectInvitation(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires: string | null; reason: string | null; role: string | null; project: { id: number; name: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
28
|
+
- `api.management.currentUser.getProjectInvitations(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires: string | null; reason: string | null; role: string | null; project: { id: number; name: string; }; creator: { id: number; name: string; email: string; }; }[]>`
|
|
29
|
+
- `api.management.currentUser.getProjectJoinRequest(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires: string | null; reason: string | null; project: { id: number; name: string; }; }>`
|
|
30
|
+
- `api.management.currentUser.getProjectJoinRequests(signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires: string | null; reason: string | null; project: { id: number; name: string; }; }[]>`
|
|
31
31
|
- `api.management.currentUser.rejectMaintainerInvitation(id: number): Promise<void>`
|
|
32
32
|
- `api.management.currentUser.rejectOrganizationInvitation(id: number): Promise<void>`
|
|
33
33
|
- `api.management.currentUser.rejectProjectInvitation(id: number): Promise<void>`
|
|
34
34
|
|
|
35
35
|
### `api.management.deletedProjects`
|
|
36
36
|
|
|
37
|
-
- `api.management.deletedProjects.getDeletedProject(projectId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; type: string; region: string; created: string | null; expires: string | null; features: string[]; dataSizeBytes: number; rowsCount: number; hasMysql: boolean; hasSynapse: boolean; hasSnowflake: boolean; hasExasol: boolean; hasTeradata: boolean; hasBigquery: boolean; defaultBackend: string; hasTryModeOn: string; limits: { [key: string]: Record<string, never>; }; metrics: { [key: string]: Record<string, never>; }; isDisabled: boolean; billedMonthlyPrice: number | null; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; usersCount: number; fileStorageProvider?: string |
|
|
38
|
-
- `api.management.deletedProjects.getDeletedProjects(query?: { page?: { after?: string | undefined; limit?: number | undefined; } | undefined; filter?: { organizationId?: number | undefined; name?: string | undefined; status?: "deleted" | "all" | "purged" | undefined; overdue?: boolean | undefined; } | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ data: { id: number; name: string; type: string; region: string; created: string | null; expires: string | null; features: string[]; dataSizeBytes: number; rowsCount: number; hasMysql: boolean; hasSynapse: boolean; hasSnowflake: boolean; hasExasol: boolean; hasTeradata: boolean; hasBigquery: boolean; defaultBackend: string; hasTryModeOn: string; limits: { [key: string]: Record<string, never>; }; metrics: { [key: string]: Record<string, never>; }; isDisabled: boolean; billedMonthlyPrice: number | null; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; usersCount: number; fileStorageProvider?: string |
|
|
37
|
+
- `api.management.deletedProjects.getDeletedProject(projectId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; type: string; region: string; created: string | null; expires: string | null; features: string[]; dataSizeBytes: number; rowsCount: number; hasMysql: boolean; hasSynapse: boolean; hasSnowflake: boolean; hasExasol: boolean; hasTeradata: boolean; hasBigquery: boolean; defaultBackend: string; hasTryModeOn: string; limits: { [key: string]: Record<string, never>; }; metrics: { [key: string]: Record<string, never>; }; isDisabled: boolean; billedMonthlyPrice: number | null; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; usersCount: number; fileStorageProvider?: string | undefined; payAsYouGo?: { purchasedCredits: number; } | undefined; disabled?: { reason: string; estimatedEndTime: string | null; } | undefined; isPurged: boolean; isDeleted: boolean; deletedTime: string | null; purgedTime: string | null; scheduledPurgeTime: string | null; isPurgeOverdue: boolean; backends: { snowflake?: { id: number; } | undefined; synapse?: { id: number; } | undefined; exasol?: { id: number; } | undefined; teradata?: { id: number; } | undefined; bigquery?: { id: number; } | undefined; }; organization: { id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId: number | null; mfaRequired: boolean; }; }>`
|
|
38
|
+
- `api.management.deletedProjects.getDeletedProjects(query?: { page?: { after?: string | undefined; limit?: number | undefined; } | undefined; filter?: { organizationId?: number | undefined; name?: string | undefined; status?: "deleted" | "all" | "purged" | undefined; overdue?: boolean | undefined; } | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ data: { id: number; name: string; type: string; region: string; created: string | null; expires: string | null; features: string[]; dataSizeBytes: number; rowsCount: number; hasMysql: boolean; hasSynapse: boolean; hasSnowflake: boolean; hasExasol: boolean; hasTeradata: boolean; hasBigquery: boolean; defaultBackend: string; hasTryModeOn: string; limits: { [key: string]: Record<string, never>; }; metrics: { [key: string]: Record<string, never>; }; isDisabled: boolean; billedMonthlyPrice: number | null; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; usersCount: number; fileStorageProvider?: string | undefined; payAsYouGo?: { purchasedCredits: number; } | undefined; disabled?: { reason: string; estimatedEndTime: string | null; } | undefined; isPurged: boolean; isDeleted: boolean; deletedTime: string | null; purgedTime: string | null; scheduledPurgeTime: string | null; isPurgeOverdue: boolean; backends: { snowflake?: { id: number; } | undefined; synapse?: { id: number; } | undefined; exasol?: { id: number; } | undefined; teradata?: { id: number; } | undefined; bigquery?: { id: number; } | undefined; }; organization: { id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId: number | null; mfaRequired: boolean; }; }[]; meta: { total: number; limit: number; cursor: { param: string; encoding: string; fields: { name: string; type: "string" | "integer" | "date-time"; nullable: boolean; }[]; order: string; }; }; links: { self: string; first: string; next: string | null; }; }>`
|
|
39
39
|
- `api.management.deletedProjects.getDeletedProjectsStats(signal?: AbortSignal | undefined): Promise<{ deleted: number; purged: number; overdue: number; }>`
|
|
40
40
|
- `api.management.deletedProjects.purgeDeletedProject(projectId: number, ignoreBackendErrors?: boolean): Promise<{ commandExecutionId: string; }>`
|
|
41
41
|
- `api.management.deletedProjects.restoreDeletedProject(projectId: number): Promise<void>`
|
|
@@ -62,27 +62,27 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
62
62
|
- `api.management.fileStorage.setFileStorageAbsDefault(fileStorageId: number): Promise<{ id: number; accountName: string; region: string; containerName: string; provider: string; owner: string; isDefault: boolean; created: string; creator: { id: number | null; name: string | null; }; }>`
|
|
63
63
|
- `api.management.fileStorage.setFileStorageGcsDefault(fileStorageId: number): Promise<FileStorageGcs>`
|
|
64
64
|
- `api.management.fileStorage.setFileStorageS3Default(fileStorageId: number): Promise<{ id: number; awsKey: string; region: string; filesBucket: string; provider: string; owner: string; isDefault: boolean; created: string; creator: { id: number | null; name: string | null; }; }>`
|
|
65
|
-
- `api.management.fileStorage.updateFileStorage(fileStorageId: number, body: { owner?: string |
|
|
65
|
+
- `api.management.fileStorage.updateFileStorage(fileStorageId: number, body: { owner?: string | undefined; region?: string | undefined; }): Promise<FileStorage>`
|
|
66
66
|
|
|
67
67
|
### `api.management.gcpPartner`
|
|
68
68
|
|
|
69
|
-
- `api.management.gcpPartner.setUpBigQuery(projectId: number, body: { serviceAccountKey: { type: string; project_id: string; private_key_id: string; private_key: string; client_email: string; client_id: string; auth_uri: string; token_uri: string; auth_provider_x509_cert_url: string; client_x509_cert_url: string; }; folderId: number; gcsBucketId: string; }, signal?: AbortSignal | undefined): Promise<{ id: number; status: string; url: string; tableId
|
|
69
|
+
- `api.management.gcpPartner.setUpBigQuery(projectId: number, body: { serviceAccountKey: { type: string; project_id: string; private_key_id: string; private_key: string; client_email: string; client_id: string; auth_uri: string; token_uri: string; auth_provider_x509_cert_url: string; client_x509_cert_url: string; }; folderId: number; gcsBucketId: string; }, signal?: AbortSignal | undefined): Promise<{ id: number; status: string; url: string; tableId: string | null; operationName: string; operationParams: { [key: string]: Record<string, never>; }; createdTime: string; startTime: string | null; endTime: string | null; runId: string | null; results: Record<string, never> | null; creatorToken: { id: number; description: string | null; }; metrics: { [key: string]: Record<string, never>; }; error?: { code: string; message: string; exceptionId: string; } | undefined; }>`
|
|
70
70
|
|
|
71
71
|
### `api.management.maintainers`
|
|
72
72
|
|
|
73
73
|
- `api.management.maintainers.addMaintainerUser({ maintainerId, ...body }: AddMaintainerUserInput): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
|
|
74
74
|
- `api.management.maintainers.completeMaintainerSamlSetup({ maintainerId, configId, ...body }: CompleteSamlSetupInput): Promise<{ id?: number | undefined; maintainerId?: number | undefined; customerSlug?: string | undefined; name?: string | undefined; isActive?: boolean | undefined; membershipRestriction?: "none" | "permittedDomains" | undefined; message?: string | undefined; loginUrl?: string | undefined; warnings?: { code?: string | undefined; message?: string | undefined; organizationIds?: number[] | undefined; }[] | undefined; }>`
|
|
75
75
|
- `api.management.maintainers.createMaintainer(body: { name: string; defaultConnectionMysqlId?: number | null | undefined; defaultConnectionSnowflakeId?: number | null | undefined; defaultConnectionSynapseId?: number | null | undefined; defaultConnectionExasolId?: number | null | undefined; defaultConnectionBigqueryId?: number | null | undefined; defaultConnectionTeradataId?: number | null | undefined; zendeskUrl?: string | null | undefined; defaultFileStorageId?: number | null | undefined; }): Promise<{ id: number; name: string; created: string; defaultConnectionMysqlId: number | null; defaultConnectionSnowflakeId: number | null; defaultConnectionSynapseId: number | null; defaultConnectionExasolId: number | null; defaultConnectionBigqueryId: number | null; defaultConnectionTeradataId: number | null; defaultFileStorageId: number | null; zendeskUrl: string | null; } & { organizations: { id: number; name: string; }[]; }>`
|
|
76
|
-
- `api.management.maintainers.createMaintainerInvitation({ maintainerId, ...body }: CreateMaintainerInvitationInput): Promise<{ id: number; created
|
|
77
|
-
- `api.management.maintainers.createMaintainerOrganization({ maintainerId, ...body }: CreateMaintainerOrganizationInput): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string
|
|
76
|
+
- `api.management.maintainers.createMaintainerInvitation({ maintainerId, ...body }: CreateMaintainerInvitationInput): Promise<{ id: number; created: string; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
77
|
+
- `api.management.maintainers.createMaintainerOrganization({ maintainerId, ...body }: CreateMaintainerOrganizationInput): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId: number | null; mfaRequired: boolean; }>`
|
|
78
78
|
- `api.management.maintainers.createMaintainerSamlConfig({ maintainerId, ...body }: CreateSamlConfigInput): Promise<{ id?: number | undefined; maintainerId?: number | undefined; customerSlug?: string | undefined; name?: string | undefined; isActive?: boolean | undefined; membershipRestriction?: "none" | "permittedDomains" | undefined; spConfiguration?: { entityId?: string | undefined; acsUrl?: string | undefined; slsUrl?: string | undefined; metadataUrl?: string | undefined; x509Certificate?: string | undefined; } | undefined; nextSteps?: { instructions?: string | undefined; curlCommand?: string | undefined; } | undefined; }>`
|
|
79
79
|
- `api.management.maintainers.deleteMaintainer(maintainerId: number): Promise<void>`
|
|
80
80
|
- `api.management.maintainers.deleteMaintainerInvitation({ maintainerId, invitationId, }: MaintainerInvitationPath): Promise<void>`
|
|
81
81
|
- `api.management.maintainers.deleteMaintainerMetadata({ maintainerId, metadataId, }: MaintainerMetadataItemPath): Promise<void>`
|
|
82
82
|
- `api.management.maintainers.deleteMaintainerSamlConfig({ maintainerId, configId }: { maintainerId: number; configId: number; }): Promise<void>`
|
|
83
83
|
- `api.management.maintainers.getMaintainer(maintainerId: number, signal?: AbortSignal | undefined): Promise<MaintainerDetail>`
|
|
84
|
-
- `api.management.maintainers.getMaintainerInvitation({ maintainerId, invitationId }: MaintainerInvitationPath, signal?: AbortSignal | undefined): Promise<{ id: number; created
|
|
85
|
-
- `api.management.maintainers.getMaintainerInvitations(maintainerId: number, signal?: AbortSignal | undefined): Promise<{ id: number; created
|
|
84
|
+
- `api.management.maintainers.getMaintainerInvitation({ maintainerId, invitationId }: MaintainerInvitationPath, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
85
|
+
- `api.management.maintainers.getMaintainerInvitations(maintainerId: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }[]>`
|
|
86
86
|
- `api.management.maintainers.getMaintainerMetadata(maintainerId: number, signal?: AbortSignal | undefined): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
|
|
87
87
|
- `api.management.maintainers.getMaintainerOrganizations(maintainerId: number, signal?: AbortSignal | undefined): Promise<{ id?: number | undefined; name?: string | undefined; created?: string | undefined; allowAutoJoin?: boolean | undefined; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired?: boolean | undefined; }[]>`
|
|
88
88
|
- `api.management.maintainers.getMaintainerSamlConfig({ maintainerId, configId }: { maintainerId: number; configId: number; }, signal?: AbortSignal | undefined): Promise<{ id: number; maintainerId: number; customerSlug: string; name: string; description: string | null; idpEntityId: string; idpSsoUrl: string | null; idpSloUrl: string | null; idpX509Cert: string | null; spX509Cert: string; spEntityIdSuffix: string | null; attributeEmail: string; attributeFirstName: string; attributeLastName: string; attributeRoles: string | null; roleRequiredToLogin: string | null; roleProjectPrefix: string | null; roleOrgAdminPrefix: string | null; designAdminEmail: string | null; loginUrlParams: { [key: string]: string; } | null; permittedEmailDomains: string[]; membershipRestriction: "none" | "permittedDomains"; isActive: boolean; createdAt: string; updatedAt: string; }>`
|
|
@@ -98,24 +98,24 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
98
98
|
### `api.management.organizations`
|
|
99
99
|
|
|
100
100
|
- `api.management.organizations.addOrganizationUser({ organizationId, ...body }: AddOrganizationUserInput): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
|
|
101
|
-
- `api.management.organizations.createOrganizationInvitation({ organizationId, ...body }: CreateOrganizationInvitationInput): Promise<{ id: number; created
|
|
102
|
-
- `api.management.organizations.createOrganizationProject({ organizationId, ...body }: CreateOrganizationProjectInput): Promise<{ id: number; name: string; type: string; region: string; created: string | null; expires: string | null; features: string[]; dataSizeBytes: number; rowsCount: number; hasMysql: boolean; hasSynapse: boolean; hasSnowflake: boolean; hasExasol: boolean; hasTeradata: boolean; hasBigquery: boolean; defaultBackend: string; hasTryModeOn: string; limits: { [key: string]: { name: string; value: number; }; }; metrics: { [key: string]: { name: string; value: number; }; }; isDisabled: boolean; billedMonthlyPrice: number | null; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; fileStorageProvider?: string |
|
|
101
|
+
- `api.management.organizations.createOrganizationInvitation({ organizationId, ...body }: CreateOrganizationInvitationInput): Promise<{ id: number; created: string; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
102
|
+
- `api.management.organizations.createOrganizationProject({ organizationId, ...body }: CreateOrganizationProjectInput): Promise<{ id: number; name: string; type: string; region: string; created: string | null; expires: string | null; features: string[]; dataSizeBytes: number; rowsCount: number; hasMysql: boolean; hasSynapse: boolean; hasSnowflake: boolean; hasExasol: boolean; hasTeradata: boolean; hasBigquery: boolean; defaultBackend: string; hasTryModeOn: string; limits: { [key: string]: { name: string; value: number; }; }; metrics: { [key: string]: { name: string; value: number; }; }; isDisabled: boolean; billedMonthlyPrice: number | null; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; fileStorageProvider?: string | undefined; usersCount: number; timezone: string | null; payAsYouGo?: { purchasedCredits: number; } | undefined; disabled?: { reason: string; estimatedEndTime: string | null; } | undefined; } & { fileStorage: Record<string, never>; backends: Record<string, never>; }>`
|
|
103
103
|
- `api.management.organizations.deleteOrganization(organizationId: number): Promise<void>`
|
|
104
104
|
- `api.management.organizations.deleteOrganizationInvitation({ organizationId, invitationId, }: OrganizationInvitationPath): Promise<void>`
|
|
105
105
|
- `api.management.organizations.deleteOrganizationMetadata({ organizationId, metadataId, }: OrganizationMetadataItemPath): Promise<void>`
|
|
106
|
-
- `api.management.organizations.forceMfa(organizationId: number): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string
|
|
106
|
+
- `api.management.organizations.forceMfa(organizationId: number): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId: number | null; mfaRequired: boolean; }>`
|
|
107
107
|
- `api.management.organizations.getOrganization(organizationId: number, signal?: AbortSignal | undefined): Promise<OrganizationDetail>`
|
|
108
|
-
- `api.management.organizations.getOrganizationInvitation({ organizationId, invitationId }: OrganizationInvitationPath, signal?: AbortSignal | undefined): Promise<{ id: number; created
|
|
109
|
-
- `api.management.organizations.getOrganizationInvitations(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; created
|
|
108
|
+
- `api.management.organizations.getOrganizationInvitation({ organizationId, invitationId }: OrganizationInvitationPath, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
109
|
+
- `api.management.organizations.getOrganizationInvitations(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }[]>`
|
|
110
110
|
- `api.management.organizations.getOrganizationMetadata(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
|
|
111
111
|
- `api.management.organizations.getOrganizationProjects(organizationId: number, signal?: AbortSignal | undefined): Promise<Project[]>`
|
|
112
112
|
- `api.management.organizations.getOrganizationProjectsUsers(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }[]>`
|
|
113
113
|
- `api.management.organizations.getOrganizationUsers(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }[]>`
|
|
114
|
-
- `api.management.organizations.getOrganizations(signal?: AbortSignal | undefined): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId
|
|
114
|
+
- `api.management.organizations.getOrganizations(signal?: AbortSignal | undefined): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId: number | null; mfaRequired: boolean; maintainer: { id: number; name: string; created: string; defaultConnectionMysqlId: number | null; defaultConnectionSnowflakeId: number | null; defaultConnectionSynapseId: number | null; defaultConnectionExasolId: number | null; defaultConnectionBigqueryId: number | null; defaultConnectionTeradataId: number | null; defaultFileStorageId: number | null; zendeskUrl: string | null; }; }[]>`
|
|
115
115
|
- `api.management.organizations.joinOrganization(organizationId: number): Promise<void>`
|
|
116
116
|
- `api.management.organizations.removeOrganizationUser({ organizationId, userId }: OrganizationUserPath): Promise<void>`
|
|
117
117
|
- `api.management.organizations.setOrganizationMetadata({ organizationId, ...body }: SetOrganizationMetadataInput): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
|
|
118
|
-
- `api.management.organizations.updateOrganization({ organizationId, ...body }: UpdateOrganizationInput): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string
|
|
118
|
+
- `api.management.organizations.updateOrganization({ organizationId, ...body }: UpdateOrganizationInput): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId: number | null; mfaRequired: boolean; }>`
|
|
119
119
|
|
|
120
120
|
### `api.management.payAsYouGo`
|
|
121
121
|
|
|
@@ -138,20 +138,20 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
138
138
|
- `api.management.projects.addProjectUser({ projectId, ...body }: AddProjectUserPath & AddProjectUserBody): Promise<null>`
|
|
139
139
|
- `api.management.projects.approveProjectJoinRequest({ projectId, joinRequestId, }: ProjectJoinRequestPath): Promise<null>`
|
|
140
140
|
- `api.management.projects.changeProjectUserRole({ projectId, userId, role }: ChangeProjectUserRoleInput): Promise<User>`
|
|
141
|
-
- `api.management.projects.createProjectInvitation({ projectId, ...body }: CreateProjectInvitationPath & CreateProjectInvitationBody): Promise<{ id: number; created
|
|
141
|
+
- `api.management.projects.createProjectInvitation({ projectId, ...body }: CreateProjectInvitationPath & CreateProjectInvitationBody): Promise<{ id: number; created: string; expires: string | null; reason: string | null; role: string | null; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
142
142
|
- `api.management.projects.deleteProject(projectId: number): Promise<null>`
|
|
143
143
|
- `api.management.projects.deleteProjectInvitation({ projectId, invitationId, }: DeleteProjectInvitationPath): Promise<null>`
|
|
144
144
|
- `api.management.projects.deleteProjectMetadata({ projectId, metadataId }: { projectId: number; metadataId: number; }): Promise<void>`
|
|
145
145
|
- `api.management.projects.getProject(projectId: string | number, signal?: AbortSignal | undefined): Promise<Project>`
|
|
146
|
-
- `api.management.projects.getProjectInvitation({ projectId, invitationId }: DeleteProjectInvitationPath, signal?: AbortSignal | undefined): Promise<{ id: number; created
|
|
147
|
-
- `api.management.projects.getProjectInvitations(projectId: string | number, signal?: AbortSignal | undefined): Promise<{ id: number; created
|
|
148
|
-
- `api.management.projects.getProjectJoinRequest({ projectId, joinRequestId }: ProjectJoinRequestPath, signal?: AbortSignal | undefined): Promise<{ id: number; created
|
|
149
|
-
- `api.management.projects.getProjectJoinRequests(projectId: string | number, signal?: AbortSignal | undefined): Promise<{ id: number; created
|
|
146
|
+
- `api.management.projects.getProjectInvitation({ projectId, invitationId }: DeleteProjectInvitationPath, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires: string | null; reason: string | null; role: string | null; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }>`
|
|
147
|
+
- `api.management.projects.getProjectInvitations(projectId: string | number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires: string | null; reason: string | null; role: string | null; user: { id: number; name: string; email: string; }; creator: { id: number; name: string; email: string; }; }[]>`
|
|
148
|
+
- `api.management.projects.getProjectJoinRequest({ projectId, joinRequestId }: ProjectJoinRequestPath, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires: string | null; reason: string | null; user?: { id: number; name: string; email: string; } | undefined; }>`
|
|
149
|
+
- `api.management.projects.getProjectJoinRequests(projectId: string | number, signal?: AbortSignal | undefined): Promise<{ id: number; created: string; expires: string | null; reason: string | null; user?: { id: number; name: string; email: string; } | undefined; }[]>`
|
|
150
150
|
- `api.management.projects.getProjectMetadata(projectId: number, signal?: AbortSignal | undefined): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
|
|
151
151
|
- `api.management.projects.getProjectReviewers(projectId: number, signal?: AbortSignal | undefined): Promise<Reviewer[]>`
|
|
152
|
-
- `api.management.projects.getProjectTemplate(templateId: string, signal?: AbortSignal | undefined): Promise<{ id: string; name: string; description: string; expirationDays
|
|
152
|
+
- `api.management.projects.getProjectTemplate(templateId: string, signal?: AbortSignal | undefined): Promise<{ id: string; name: string; description: string; expirationDays: number | null; billedMonthlyPrice: number | null; hasTryModeOn: boolean; defaultBackend: string; }>`
|
|
153
153
|
- `api.management.projects.getProjectTemplateFeatures(templateId: string, signal?: AbortSignal | undefined): Promise<{ id?: number | undefined; name?: string | undefined; type?: string | undefined; title?: string | undefined; description?: string | undefined; created?: string | undefined; }[]>`
|
|
154
|
-
- `api.management.projects.getProjectTemplates(signal?: AbortSignal | undefined): Promise<{ id: string; name: string; description: string; expirationDays
|
|
154
|
+
- `api.management.projects.getProjectTemplates(signal?: AbortSignal | undefined): Promise<{ id: string; name: string; description: string; expirationDays: number | null; billedMonthlyPrice: number | null; hasTryModeOn: boolean; defaultBackend: string; }[]>`
|
|
155
155
|
- `api.management.projects.getProjectUsers(projectId: string | number, signal?: AbortSignal | undefined): Promise<User[]>`
|
|
156
156
|
- `api.management.projects.joinProject({ projectId, ...body }: JoinProjectInput): Promise<void>`
|
|
157
157
|
- `api.management.projects.moveProject({ projectId, organizationId }: MoveProjectInput): Promise<ProjectBase>`
|
|
@@ -160,7 +160,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
160
160
|
- `api.management.projects.removeProjectLimit({ projectId, limitName }: { projectId: number; limitName: string; }): Promise<void>`
|
|
161
161
|
- `api.management.projects.removeProjectTemplateFeature({ templateId, featureName, }: { templateId: string; featureName: string; }): Promise<void>`
|
|
162
162
|
- `api.management.projects.removeProjectUser({ projectId, idOrEmail }: RemoveProjectUserPath): Promise<null>`
|
|
163
|
-
- `api.management.projects.requestProjectAccess({ projectId, ...body }: RequestProjectAccessInput): Promise<{ id: number; created
|
|
163
|
+
- `api.management.projects.requestProjectAccess({ projectId, ...body }: RequestProjectAccessInput): Promise<{ id: number; created: string; expires: string | null; reason: string | null; user?: { id: number; name: string; email: string; } | undefined; }>`
|
|
164
164
|
- `api.management.projects.setProjectDisabled({ projectId, ...body }: SetProjectDisabledInput): Promise<ProjectBase>`
|
|
165
165
|
- `api.management.projects.setProjectLimits({ projectId, ...body }: SetProjectLimitsInput): Promise<Project>`
|
|
166
166
|
- `api.management.projects.setProjectMetadata({ projectId, provider, metadata, }: SetProjectMetadataPath & { provider: "user" | "system"; metadata: { key: string; value: string; }[]; }): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
|
|
@@ -170,20 +170,22 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
170
170
|
### `api.management.snowflakePartnerConnect`
|
|
171
171
|
|
|
172
172
|
- `api.management.snowflakePartnerConnect.check(projectId: number, signal?: AbortSignal | undefined): Promise<{ testPassed: boolean; queriesToRun: string[]; }>`
|
|
173
|
-
- `api.management.snowflakePartnerConnect.unlock(projectId: number, signal?: AbortSignal | undefined): Promise<{ status: "error" | "ok" | "test-failed"; message: string; exceptionId?: string |
|
|
173
|
+
- `api.management.snowflakePartnerConnect.unlock(projectId: number, signal?: AbortSignal | undefined): Promise<{ status: "error" | "ok" | "test-failed"; message: string; exceptionId?: string | undefined; }>`
|
|
174
174
|
|
|
175
175
|
### `api.management.storageBackends`
|
|
176
176
|
|
|
177
|
-
- `api.management.storageBackends.activateStorageBackend(backendId: number): Promise<{ id: number; backend: string; region: string; owner
|
|
178
|
-
- `api.management.storageBackends.
|
|
179
|
-
- `api.management.storageBackends.
|
|
177
|
+
- `api.management.storageBackends.activateStorageBackend(backendId: number): Promise<{ id: number; backend: string; region: string; owner: string | null; technicalOwner: string; technicalOwnerContactEmails: string[]; host?: string | undefined; credentials?: Record<string, never> | undefined; folderId?: string | null | undefined; useDynamicBackends?: boolean | undefined; useNetworkPolicies?: boolean | undefined; useSso?: boolean | undefined; isSsoEnabled?: boolean | undefined; isSsoConfigured?: boolean | undefined; isEnabled?: boolean | undefined; }>`
|
|
178
|
+
- `api.management.storageBackends.createBigqueryServerSideStorageBackend(body: { adminCredentials: { [key: string]: unknown; }; masterServiceAccountResourceName: string; folderId: string; region: string; owner: "client" | "keboola"; technicalOwner: "keboola" | "internal" | "kbdb" | "byodb"; bqExternalSharingRoleName?: string | null | undefined; }): Promise<StorageBackendBigquery>`
|
|
179
|
+
- `api.management.storageBackends.createBigqueryStorageBackend(body: { owner: "client" | "keboola"; technicalOwner: "keboola" | "internal" | "kbdb" | "byodb"; folderId: string; region: string; credentials: { type: string; project_id: string; private_key_id: string; private_key: string; client_email: string; client_id: string; auth_uri: string; token_uri: string; auth_provider_x509_cert_url: string; client_x509_cert_url: string; }; bqExternalSharingRoleName?: string | null | undefined; }): Promise<StorageBackendBigquery>`
|
|
180
|
+
- `api.management.storageBackends.createSnowflakeStorageBackend(body: { host: string; warehouse: string; username: string; region: string; owner: string; technicalOwner: "keboola" | "internal" | "kbdb" | "byodb"; technicalOwnerContactEmails?: string[] | null | undefined; useDynamicBackends?: boolean | null | undefined; useNetworkPolicies?: boolean | null | undefined; useSso?: boolean | null | undefined; edition?: "standard" | "enterprise" | null | undefined; }): Promise<{ id: number; host: string; warehouse: string; username: string; owner: string; technicalOwner: string; region: string; created: string; creatorId: number; creatorName: string; useDynamicBackends: boolean; useNetworkPolicies: boolean; useSso: boolean; isSsoEnabled: boolean; isSsoConfigured: boolean; edition: string; sqlTemplate: string; isEnabled: boolean; userPublicKey: string; securityIntegrationKey: string | null; }>`
|
|
180
181
|
- `api.management.storageBackends.deleteStorageBackend(id: number): Promise<void>`
|
|
182
|
+
- `api.management.storageBackends.getPolicyTagEnablementGuide({ id, ...query }: PolicyTagEnablementGuideInput, signal?: AbortSignal | undefined): Promise<{ format: "markdown" | "terraform"; content: string; }>`
|
|
181
183
|
- `api.management.storageBackends.getStorageBackend(id: number, signal?: AbortSignal | undefined): Promise<StorageBackend>`
|
|
182
184
|
- `api.management.storageBackends.getStorageBackendMaintainers(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; }[]>`
|
|
183
185
|
- `api.management.storageBackends.getStorageBackendProjects(id: number, query?: { limit?: number | undefined; offset?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; }[]>`
|
|
184
186
|
- `api.management.storageBackends.getStorageBackends(signal?: AbortSignal | undefined): Promise<StorageBackend[]>`
|
|
185
|
-
- `api.management.storageBackends.updateBigqueryStorageBackend({ id, ...body }: UpdateBigqueryStorageBackendInput): Promise<
|
|
186
|
-
- `api.management.storageBackends.updateStorageBackend({ id, ...body }: UpdateStorageBackendInput): Promise<{ id: number; backend: string; region: string; owner
|
|
187
|
+
- `api.management.storageBackends.updateBigqueryStorageBackend({ id, ...body }: UpdateBigqueryStorageBackendInput): Promise<StorageBackendBigquery>`
|
|
188
|
+
- `api.management.storageBackends.updateStorageBackend({ id, ...body }: UpdateStorageBackendInput): Promise<{ id: number; backend: string; region: string; owner: string | null; technicalOwner: string; technicalOwnerContactEmails: string[]; host?: string | undefined; credentials?: Record<string, never> | undefined; folderId?: string | null | undefined; useDynamicBackends?: boolean | undefined; useNetworkPolicies?: boolean | undefined; useSso?: boolean | undefined; isSsoEnabled?: boolean | undefined; isSsoConfigured?: boolean | undefined; isEnabled?: boolean | undefined; }>`
|
|
187
189
|
|
|
188
190
|
### `api.management.uiApps`
|
|
189
191
|
|
|
@@ -191,7 +193,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
191
193
|
- `api.management.uiApps.deleteUiApp(stringId: string): Promise<void>`
|
|
192
194
|
- `api.management.uiApps.getUiApp(stringId: string, signal?: AbortSignal | undefined): Promise<UiAppDetail>`
|
|
193
195
|
- `api.management.uiApps.getUiApps(query?: { includeInactive?: boolean | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<UiApp[]>`
|
|
194
|
-
- `api.management.uiApps.registerUiApp(body: { manifestUrl: string; activate?: boolean | null | undefined; }): Promise<{ app: { id
|
|
196
|
+
- `api.management.uiApps.registerUiApp(body: { manifestUrl: string; activate?: boolean | null | undefined; }): Promise<{ app: { id: string; stringId: string; name: string; created: string; }; version: { id: string; version: string; isActive: boolean; isCritical: boolean; commitSha: string | null; }; }>`
|
|
195
197
|
- `api.management.uiApps.renameUiApp({ stringId, ...body }: { stringId: string; } & { name: string; }): Promise<void>`
|
|
196
198
|
|
|
197
199
|
### `api.management.users`
|
package/surface/oauth.md
CHANGED
|
@@ -8,4 +8,5 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
8
8
|
- `api.oauth.deleteCredential({ componentId, id }: CredentialInput, signal?: AbortSignal | undefined): Promise<void>`
|
|
9
9
|
- `api.oauth.getCredential({ componentId, id }: CredentialInput, signal?: AbortSignal | undefined): Promise<{ id: string; branchId: string | null; authorizedFor: string; creator: { id: string; description: string | null; }; created: string; oauthVersion: string; appKey: string; '#appSecret': string; '#data': string; }>`
|
|
10
10
|
- `api.oauth.getCredentials(scope: GetCredentialsInput, signal?: AbortSignal | undefined): Promise<{ id: string; branchId: string | null; authorizedFor: string; creator: { id: string; description: string | null; }; created: string; oauthVersion: string; appKey: string; '#appSecret': string; '#data': string; }[]>`
|
|
11
|
+
- `api.oauth.getOrganizationConnections(signal?: AbortSignal | undefined): Promise<{ accountLogin: string; host: string; }[]>`
|
|
11
12
|
- `api.oauth.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
|
package/surface/queryService.md
CHANGED
|
@@ -7,8 +7,8 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
7
7
|
- `api.queryService.cancelQueryJob(queryJobId: string): Promise<{ queryJobId: string; }>`
|
|
8
8
|
- `api.queryService.createQueryJob(branchId: string, workspaceId: string, body: { actorType?: "user" | "system" | undefined; refreshMetadataOnSuccess?: boolean | undefined; sessionId?: string | undefined; statements: string[]; timeout?: string | undefined; transactional: boolean; }): Promise<{ queryJobId: string; sessionId?: string | undefined; }>`
|
|
9
9
|
- `api.queryService.exportResults(queryJobId: string, statementId: string, query: { fileType: "csv" | "parquet"; gzip?: boolean | undefined; }, signal?: AbortSignal | undefined): Promise<ExportResultsResponse>`
|
|
10
|
-
- `api.queryService.getQueryHistory(branchId: string, workspaceId: string, query?: { afterId?: string | undefined; pageSize?: number | undefined; } | undefined): Promise<{ statements: { backendSize?: string | undefined; completedAt?: string | undefined; createdAt?: string | undefined; error?: string | undefined; executedAt?: string | undefined; id: string; numberOfRows?: number | undefined; query: string; queryId?: string | undefined; queryJobId: string; rowsAffected?: number | undefined; status: "waiting" | "processing" | "
|
|
11
|
-
- `api.queryService.getQueryJob(queryJobId: string, signal?: AbortSignal | undefined): Promise<{ actorType: "user" | "system"; canceledAt?: string | undefined; cancellationReason?: string | undefined; changedAt: string; createdAt: string; expiration?: string | undefined; queryJobId: string; statements: { completedAt?: string | undefined; createdAt?: string | undefined; error?: string | undefined; executedAt?: string | undefined; id: string; numberOfRows?: number | undefined; query: string; queryId?: string | undefined; rowsAffected?: number | undefined; status: "waiting" | "processing" | "
|
|
12
|
-
- `api.queryService.getQueryResults(queryJobId: string, statementId: string, query?: { offset?: number | undefined; pageSize?: number | undefined; } | undefined): Promise<{ columns?: { length: number; name: string; nullable: boolean; type: string; }[] | undefined; data?: string[][] | undefined; message?: string | undefined; numberOfRows?: number | undefined; rowsAffected?: number | undefined; status: "waiting" | "processing" | "
|
|
10
|
+
- `api.queryService.getQueryHistory(branchId: string, workspaceId: string, query?: { afterId?: string | undefined; pageSize?: number | undefined; } | undefined): Promise<{ statements: { backendSize?: string | undefined; completedAt?: string | undefined; createdAt?: string | undefined; error?: string | undefined; executedAt?: string | undefined; id: string; numberOfRows?: number | undefined; query: string; queryId?: string | undefined; queryJobId: string; rowsAffected?: number | undefined; status: "waiting" | "processing" | "failed" | "canceled" | "completed" | "notExecuted"; warehouse?: string | undefined; }[]; }>`
|
|
11
|
+
- `api.queryService.getQueryJob(queryJobId: string, signal?: AbortSignal | undefined): Promise<{ actorType: "user" | "system"; canceledAt?: string | undefined; cancellationReason?: string | undefined; changedAt: string; createdAt: string; expiration?: string | undefined; queryJobId: string; statements: { completedAt?: string | undefined; createdAt?: string | undefined; error?: string | undefined; executedAt?: string | undefined; id: string; numberOfRows?: number | undefined; query: string; queryId?: string | undefined; rowsAffected?: number | undefined; status: "waiting" | "processing" | "failed" | "canceled" | "completed" | "notExecuted"; }[]; status: "created" | "processing" | "failed" | "enqueued" | "canceled" | "completed"; }>`
|
|
12
|
+
- `api.queryService.getQueryResults(queryJobId: string, statementId: string, query?: { offset?: number | undefined; pageSize?: number | undefined; } | undefined): Promise<{ columns?: { length: number; name: string; nullable: boolean; type: string; }[] | undefined; data?: string[][] | undefined; message?: string | undefined; numberOfRows?: number | undefined; rowsAffected?: number | undefined; status: "waiting" | "processing" | "failed" | "canceled" | "completed" | "notExecuted"; }>`
|
|
13
13
|
- `api.queryService.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
|
|
14
|
-
- `api.queryService.poller({
|
|
14
|
+
- `api.queryService.poller({ init, interval, maxAttempts, timeout, signal, }: QueryJobPollOptions & { init: JobRef | ((signal: AbortSignal) => Promise<JobRef>); }): Poller<{ actorType: "user" | "system"; canceledAt?: string | undefined; cancellationReason?: string | undefined; changedAt: string; createdAt: string; expiration?: string | undefined; queryJobId: string; statements: { completedAt?: string | undefined; createdAt?: string | undefined; error?: string | undefined; executedAt?: string | undefined; id: string; numberOfRows?: number | undefined; query: string; queryId?: string | undefined; rowsAffected?: number | undefined; status: "waiting" | "processing" | "failed" | "canceled" | "completed" | "notExecuted"; }[]; status: "created" | "processing" | "failed" | "enqueued" | "canceled" | "completed"; }, { actorType: "user" | "system"; canceledAt?: string | undefined; cancellationReason?: string | undefined; changedAt: string; createdAt: string; expiration?: string | undefined; queryJobId: string; statements: { completedAt?: string | undefined; createdAt?: string | undefined; error?: string | undefined; executedAt?: string | undefined; id: string; numberOfRows?: number | undefined; query: string; queryId?: string | undefined; rowsAffected?: number | undefined; status: "waiting" | "processing" | "failed" | "canceled" | "completed" | "notExecuted"; }[]; status: "created" | "processing" | "failed" | "enqueued" | "canceled" | "completed"; }>`
|
package/surface/queue.md
CHANGED
|
@@ -9,7 +9,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
9
9
|
- `api.queue.getOrchestrationRerunPlan(jobId: string, signal?: AbortSignal | undefined): Promise<{ jobId?: string | undefined; configId?: string | null | undefined; matchedTasks?: { taskId?: string | undefined; matched?: boolean | undefined; jobId?: string | null | undefined; componentId?: string | null | undefined; configId?: string | null | undefined; status?: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled" | undefined; }[] | undefined; }>`
|
|
10
10
|
- `api.queue.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
|
|
11
11
|
- `api.queue.killJob(jobId: string, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; isSuccess: boolean | null; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }>`
|
|
12
|
-
- `api.queue.poller({
|
|
13
|
-
- `api.queue.searchAllJobs(query: { branchId?: string[] | undefined; runId?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; componentId?: string[] | undefined; configId?: string[] | undefined; id?: string[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; config?: string[] | undefined;
|
|
12
|
+
- `api.queue.poller({ init, interval, maxAttempts, timeout, signal, }: QueueJobPollOptions & { init: JobRef | ((signal: AbortSignal) => Promise<JobRef>); }): Poller<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; isSuccess: boolean | null; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }, { id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; isSuccess: boolean | null; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }>`
|
|
13
|
+
- `api.queue.searchAllJobs(query: { branchId?: string[] | undefined; runId?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; componentId?: string[] | undefined; configId?: string[] | undefined; id?: string[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; config?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; component?: string[] | undefined; configRowIds?: string[] | undefined; status?: ("error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | undefined; componentProps?: { type?: string | undefined; } | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; limit?: number | undefined; sortBy?: "branchId" | "runId" | "componentId" | "projectId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; isSuccess: boolean | null; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }[]>`
|
|
14
14
|
- `api.queue.searchGroupedJobs(query: { groupBy: ("branchId" | "componentId" | "projectId" | "configId")[]; jobsPerGroup?: number | undefined; sortBy?: "branchId" | "runId" | "componentId" | "projectId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; limit?: number | undefined; id?: number[] | undefined; runId?: string[] | undefined; branchId?: string[] | undefined; configId?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; projectId?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; componentId?: string[] | undefined; component?: string[] | undefined; status?: string[] | undefined; desiredStatus?: string[] | undefined; mode?: string[] | undefined; tag?: string[] | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; variableValuesId?: string[] | undefined; parentRunId?: string[] | undefined; type?: string[] | undefined; componentProps?: { type?: string | undefined; } | undefined; }, signal?: AbortSignal | undefined): Promise<{ group?: { [key: string]: string; } | undefined; jobs?: { id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; isSuccess: boolean | null; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }[] | undefined; }[]>`
|
|
15
15
|
- `api.queue.searchJobs(query?: { id?: string[] | undefined; runId?: string[] | undefined; branchId?: string[] | undefined; tokenId?: string[] | undefined; tokenDescription?: string[] | undefined; componentId?: string[] | undefined; component?: string[] | undefined; configId?: string[] | undefined; config?: string[] | undefined; configRowIds?: string[] | undefined; mode?: ("run" | "debug")[] | undefined; status?: ("error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled")[] | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; componentProps?: { type?: string | undefined; } | undefined; createdTimeFrom?: string | undefined; createdTimeTo?: string | undefined; startTimeFrom?: string | undefined; startTimeTo?: string | undefined; endTimeFrom?: string | undefined; endTimeTo?: string | undefined; durationSecondsFrom?: number | undefined; durationSecondsTo?: number | undefined; offset?: number | undefined; limit?: number | undefined; sortBy?: "branchId" | "runId" | "componentId" | "projectId" | "configId" | "id" | "tokenDescription" | "status" | "createdTime" | "durationSeconds" | "startTime" | "endTime" | "updatedTime" | undefined; sortOrder?: "asc" | "desc" | undefined; parentRunId?: string | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: string; runId: string; branchId?: string | undefined; project: { id: string; }; token: { id?: string | undefined; description?: string | undefined; }; status: "error" | "success" | "warning" | "created" | "waiting" | "processing" | "terminating" | "terminated" | "cancelled"; desiredStatus?: "processing" | "terminating" | null | undefined; component: string; mode: "run" | "debug"; tag?: string | null | undefined; config?: string | null | undefined; configRow?: string | null | undefined; configData?: Record<string, never> | null | undefined; result?: { images?: { digests?: string[] | undefined; id?: string | undefined; }[] | undefined; configVersion?: number | undefined; message?: string | undefined; } | null | undefined; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; delayedStartTime?: string | null | undefined; durationSeconds?: number | null | undefined; isFinished: boolean; isSuccess: boolean | null; url: string; variableValuesId?: string | null | undefined; variableValuesData?: { values?: { name?: string | undefined; value?: string | undefined; }[] | undefined; } | null | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | null | undefined; metrics?: { storage?: { inputTablesBytesSum?: number | undefined; outputTablesBytesSum?: number | undefined; } | undefined; backend?: { type?: string | undefined; containerType?: string | undefined; context?: string | undefined; } | undefined; } | null | undefined; type?: "standard" | "container" | "phaseContainer" | "orchestrationContainer" | "retryContainer" | undefined; orchestrationTaskId?: string | null | undefined; previousJobId?: string | null | undefined; onlyOrchestrationTaskIds?: string[] | null | undefined; onlyFlowTaskIds?: string[] | null | undefined; }[]>`
|
package/surface/sdk.md
CHANGED
|
@@ -43,30 +43,6 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
43
43
|
- `api.sdk.semanticLayer.updateObject<T extends SemanticChildObjectType>(objectType: T, objectUUID: string, data: Partial<SemanticChildObjectDataMap[T]>, meta?: UpdateSemanticObjectMeta): Promise<SemanticObject<SemanticChildObjectDataMap[T]>>`
|
|
44
44
|
- `api.sdk.semanticLayer.withdrawScopeElevationRequest(objectType: SemanticObjectType, objectUUID: string): Promise<void>`
|
|
45
45
|
|
|
46
|
-
### `api.sdk.storage`
|
|
47
|
-
|
|
48
|
-
- `api.sdk.storage.addTableColumn(input: AddTableColumnInput, options?: Options | undefined): Promise<AddTableColumnJob>`
|
|
49
|
-
- `api.sdk.storage.createBucketListing(input: CreateBucketListingInput, options?: Options | undefined): Promise<BucketListingCreateJob>`
|
|
50
|
-
- `api.sdk.storage.createSnapshot(input: CreateSnapshotInput, options?: Options | undefined): Promise<CreateSnapshotJob>`
|
|
51
|
-
- `api.sdk.storage.createTable(input: CreateTableAsyncInput, options?: Options | undefined): Promise<TableCreateJob>`
|
|
52
|
-
- `api.sdk.storage.createTableDefinition(input: CreateTableDefinitionInput, options?: Options | undefined): Promise<TableDefinitionCreateJob>`
|
|
53
|
-
- `api.sdk.storage.createTablePrimaryKey(input: CreateTablePrimaryKeyInput, options?: Options | undefined): Promise<CreateTablePrimaryKeyJob>`
|
|
54
|
-
- `api.sdk.storage.deleteBucketListing(input: { bucketId: string; branchId: string; }, options?: Options | undefined): Promise<BucketListingDeleteJob>`
|
|
55
|
-
- `api.sdk.storage.deleteTableColumn(input: DeleteTableColumnInput, options?: Options | undefined): Promise<DeleteTableColumnJob>`
|
|
56
|
-
- `api.sdk.storage.exportToFile(input: ExportAsyncInput, options?: Options | undefined): Promise<TableExportJob>`
|
|
57
|
-
- `api.sdk.storage.forceUnlinkBucket(input: { bucketId: string; linkedProjectId: number; branchId: string; }, options?: Options | undefined): Promise<ForceUnlinkBucketJob>`
|
|
58
|
-
- `api.sdk.storage.importFromFile(input: ImportAsyncInput, options?: Options | undefined): Promise<TableImportJob>`
|
|
59
|
-
- `api.sdk.storage.pullTable(input: PullTableAsyncPath, options?: Options | undefined): Promise<PullTableJob>`
|
|
60
|
-
- `api.sdk.storage.refreshExternalBucket(input: RefreshExternalBucketInput, options?: Options | undefined): Promise<RefreshBucketJob>`
|
|
61
|
-
- `api.sdk.storage.registerBucket(input: RegisterBucketInput, options?: Options | undefined): Promise<RegisterBucketJob>`
|
|
62
|
-
- `api.sdk.storage.removeTablePrimaryKey(input: { tableId: string; branchId: string; }, options?: Options | undefined): Promise<RemoveTablePrimaryKeyJob>`
|
|
63
|
-
- `api.sdk.storage.shareBucketToOrganization(input: { bucketId: string; branchId: string; }, options?: Options | undefined): Promise<ShareBucketToOrganizationJob>`
|
|
64
|
-
- `api.sdk.storage.shareBucketToOrganizationProject(input: { bucketId: string; branchId: string; }, options?: Options | undefined): Promise<ShareBucketToOrganizationProjectJob>`
|
|
65
|
-
- `api.sdk.storage.shareBucketToProjects(input: ShareBucketToProjectsInput, options?: Options | undefined): Promise<ShareBucketToProjectsJob>`
|
|
66
|
-
- `api.sdk.storage.shareBucketToUsers(input: ShareBucketToUsersInput, options?: Options | undefined): Promise<ShareBucketToAdminsJob>`
|
|
67
|
-
- `api.sdk.storage.unshareBucket(input: { bucketId: string; branchId: string; }, options?: Options | undefined): Promise<RemoveBucketShareJob>`
|
|
68
|
-
- `api.sdk.storage.updateBucketListing(input: UpdateBucketListingInput, options?: Options | undefined): Promise<BucketListingUpdateJob>`
|
|
69
|
-
|
|
70
46
|
### `api.sdk.tag`
|
|
71
47
|
|
|
72
48
|
- `api.sdk.tag.assignTags(tagUUIDs: string[], objectId: KeboolaObjectId, meta?: CreateMetaObjectMetaDataInput): Promise<void>`
|