@keboola/api-client 45.0.0 → 46.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/CHANGELOG.md +15 -0
- package/dist/ManagementSessionMintError-5FFyvBZi.js +36 -0
- package/dist/ManagementSessionMintError-5FFyvBZi.js.map +1 -0
- package/dist/ManagementSessionMintError-Bm8s6yDB.cjs +47 -0
- package/dist/ManagementSessionMintError-Bm8s6yDB.cjs.map +1 -0
- package/dist/ai/index.d.cts +2 -2
- package/dist/ai/index.d.ts +2 -2
- package/dist/ai/types.d.cts +1 -1
- package/dist/ai/types.d.ts +1 -1
- package/dist/{appLogs-BS6ViVGR.d.ts → appLogs-DGIctwbb.d.ts} +2 -2
- package/dist/{appLogs-C9YlJ2g8.d.cts → appLogs-Dl0v684o.d.cts} +2 -2
- package/dist/apps/index.d.cts +3 -3
- package/dist/apps/index.d.ts +3 -3
- package/dist/apps/types.d.cts +2 -2
- package/dist/apps/types.d.ts +2 -2
- package/dist/assets/index.d.cts +1 -1
- package/dist/assets/index.d.ts +1 -1
- package/dist/auth/index.d.cts +1 -1
- package/dist/auth/index.d.ts +1 -1
- package/dist/auth/types.d.cts +1 -1
- package/dist/auth/types.d.ts +1 -1
- package/dist/{authClient-CBVAT3v9.d.cts → authClient-DSa5t2Ft.d.cts} +27 -33
- package/dist/{authClient-CRumc934.d.ts → authClient-ZiaKSKpp.d.ts} +27 -33
- package/dist/billing/index.d.cts +1 -1
- package/dist/billing/index.d.ts +1 -1
- package/dist/billing/types.d.cts +1 -1
- package/dist/billing/types.d.ts +1 -1
- package/dist/chat/index.d.cts +2 -2
- package/dist/chat/index.d.ts +2 -2
- package/dist/chat/types.d.cts +1 -1
- package/dist/chat/types.d.ts +1 -1
- package/dist/dataScience/index.d.cts +2 -2
- package/dist/dataScience/index.d.ts +2 -2
- package/dist/dataScience/types.d.cts +2 -2
- package/dist/dataScience/types.d.ts +2 -2
- package/dist/developerPortal/index.d.cts +2 -2
- package/dist/developerPortal/index.d.ts +2 -2
- package/dist/developerPortal/types.d.cts +1 -1
- package/dist/developerPortal/types.d.ts +1 -1
- package/dist/domain/permissions/index.cjs +1 -1
- package/dist/domain/permissions/index.d.cts +2 -2
- package/dist/domain/permissions/index.d.ts +2 -2
- package/dist/domain/permissions/index.js +1 -1
- package/dist/editor/index.d.cts +2 -2
- package/dist/editor/index.d.ts +2 -2
- package/dist/editor/types.d.cts +1 -1
- package/dist/editor/types.d.ts +1 -1
- package/dist/encryption/index.d.cts +1 -1
- package/dist/encryption/index.d.ts +1 -1
- package/dist/encryption/types.d.cts +1 -1
- package/dist/encryption/types.d.ts +1 -1
- package/dist/import/index.d.cts +3 -3
- package/dist/import/index.d.ts +3 -3
- package/dist/{index-Bl2EloC0.d.ts → index-BP3choXr.d.ts} +572 -526
- package/dist/{index-04pgr-EO.d.cts → index-BhDxP0x4.d.cts} +4 -4
- package/dist/{index-zyxZVJnd.d.ts → index-BnPYPXGQ.d.ts} +3 -3
- package/dist/{index-D9UsQOuT.d.cts → index-Bt43tKyu.d.cts} +5 -5
- package/dist/{index-BVhHt5lx.d.cts → index-BzhLY7el.d.cts} +15 -2
- package/dist/{index-CWPi7lBF.d.ts → index-CH5Sg3rk.d.ts} +6 -6
- package/dist/{index-Cvkrjh--.d.cts → index-CTKC-mwi.d.cts} +30 -4
- package/dist/{index-DkCXaYsn.d.cts → index-CiwWDu-q.d.cts} +3 -3
- package/dist/{index-DINB7vsV.d.cts → index-D-4TT5yW.d.cts} +4 -4
- package/dist/{index-Bf8dr2KQ.d.ts → index-DCAnnlcL.d.ts} +3 -3
- package/dist/{index-CA6QxbhZ.d.ts → index-DCxVLGHH.d.ts} +239 -236
- package/dist/{index-Dd40ojPr.d.cts → index-DQwjlSJi.d.cts} +6 -6
- package/dist/{index-BCgmwncs.d.ts → index-DRaVzOLM.d.ts} +5 -5
- package/dist/{index-BKOFRmTB.d.cts → index-DS6O4UDB.d.cts} +4 -4
- package/dist/{index-DtuwWYDR.d.ts → index-DWFxcmVD.d.ts} +4 -4
- package/dist/{index-CGCXR_6Q.d.ts → index-DXcTukgn.d.ts} +4 -4
- package/dist/{index-DkvrbR2i.d.cts → index-GVxpBH6j.d.cts} +239 -236
- package/dist/{index-BgR5zcjJ.d.ts → index-PyTPrtaL.d.ts} +15 -2
- package/dist/{index-R-w0Zncz.d.ts → index-se5ee8U1.d.ts} +4 -4
- package/dist/{index-CGFGd3tF.d.cts → index-syAYY5LC.d.cts} +572 -526
- package/dist/{index-BHWTa4YN.d.cts → index-x8ET_BTN.d.cts} +3 -3
- package/dist/{index-CX8GAP2g.d.ts → index-yJ0HrxY6.d.ts} +30 -4
- package/dist/index.cjs +31 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +6 -6
- package/dist/index.d.ts +6 -6
- package/dist/index.js +28 -4
- package/dist/index.js.map +1 -1
- package/dist/kaiAgent/index.d.cts +2 -2
- package/dist/kaiAgent/index.d.ts +2 -2
- package/dist/kaiAgent/types.d.cts +1 -1
- package/dist/kaiAgent/types.d.ts +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 +1 -1
- package/dist/management/types.d.ts +1 -1
- package/dist/{management-C5lf9nsU.cjs → management-0cWVLHei.cjs} +25 -6
- package/dist/management-0cWVLHei.cjs.map +1 -0
- package/dist/{management-WAtKH6Tu.js → management-eg4Ig-Cx.js} +18 -5
- package/dist/management-eg4Ig-Cx.js.map +1 -0
- package/dist/metastore/index.d.cts +1 -1
- package/dist/metastore/index.d.ts +1 -1
- package/dist/metastore/types.d.cts +1 -1
- package/dist/metastore/types.d.ts +1 -1
- package/dist/microsoftGraph/index.d.cts +3 -3
- package/dist/microsoftGraph/index.d.ts +3 -3
- package/dist/microsoftGraph/types.d.cts +2 -2
- package/dist/microsoftGraph/types.d.ts +2 -2
- package/dist/notifications/index.d.cts +2 -2
- package/dist/notifications/index.d.ts +2 -2
- package/dist/notifications/types.d.cts +1 -1
- package/dist/notifications/types.d.ts +1 -1
- package/dist/oauth/index.d.cts +2 -2
- package/dist/oauth/index.d.ts +2 -2
- package/dist/oauth/types.d.cts +1 -1
- package/dist/oauth/types.d.ts +1 -1
- package/dist/omnisearch/index.d.cts +2 -2
- package/dist/omnisearch/index.d.ts +2 -2
- package/dist/omnisearch/types.d.cts +1 -1
- package/dist/omnisearch/types.d.ts +1 -1
- package/dist/{project-B8wtlstY.d.cts → project-BN7YRWFS.d.cts} +8 -2
- package/dist/{project-DWwZv66D.js → project-BXLFrWJ6.js} +7 -1
- package/dist/project-BXLFrWJ6.js.map +1 -0
- package/dist/{project-BCc3mpAy.d.ts → project-BpWTnoQ_.d.ts} +8 -2
- package/dist/{project-BvFi19K_.cjs → project-CpgplgCr.cjs} +7 -1
- package/dist/project-CpgplgCr.cjs.map +1 -0
- package/dist/queryService/index.d.cts +1 -1
- package/dist/queryService/index.d.ts +1 -1
- package/dist/queryService/types.d.cts +1 -1
- package/dist/queryService/types.d.ts +1 -1
- package/dist/queue/index.d.cts +3 -3
- package/dist/queue/index.d.ts +3 -3
- package/dist/queue/types.d.cts +1 -1
- package/dist/queue/types.d.ts +1 -1
- package/dist/scheduler/index.d.cts +2 -2
- package/dist/scheduler/index.d.ts +2 -2
- 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 +4 -4
- package/dist/sdk/configurations/index.d.ts +4 -4
- package/dist/sdk/developerPortal/index.d.cts +29 -3
- package/dist/sdk/developerPortal/index.d.ts +29 -3
- package/dist/sdk/kaiMemory/index.d.cts +1 -1
- package/dist/sdk/kaiMemory/index.d.ts +1 -1
- package/dist/sdk/kaiMemory/types.d.cts +1 -1
- package/dist/sdk/kaiMemory/types.d.ts +1 -1
- package/dist/sdk/queryService/index.d.cts +1 -1
- package/dist/sdk/queryService/index.d.ts +1 -1
- package/dist/sdk/semanticLayer/index.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.d.cts +1 -1
- package/dist/sdk/storage/index.d.ts +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.d.cts +1 -1
- package/dist/status/index.d.ts +1 -1
- package/dist/storage/index.cjs +3 -2
- package/dist/storage/index.d.cts +3 -3
- package/dist/storage/index.d.ts +3 -3
- package/dist/storage/index.js +2 -2
- package/dist/storage/types.d.cts +2 -2
- package/dist/storage/types.d.ts +2 -2
- package/dist/storage-76Sf_z_H.cjs.map +1 -1
- package/dist/storage-RkNaOFJ-.js.map +1 -1
- package/dist/stream/index.d.cts +2 -2
- package/dist/stream/index.d.ts +2 -2
- package/dist/stream/types.d.cts +1 -1
- package/dist/stream/types.d.ts +1 -1
- package/dist/syncActions/index.d.cts +2 -2
- package/dist/syncActions/index.d.ts +2 -2
- package/dist/syncActions/types.d.cts +1 -1
- package/dist/syncActions/types.d.ts +1 -1
- package/dist/telemetry/index.d.cts +2 -2
- package/dist/telemetry/index.d.ts +2 -2
- package/dist/telemetry/types.d.cts +1 -1
- package/dist/telemetry/types.d.ts +1 -1
- package/dist/{types-DgPt4LY_.d.cts → types--owScV0r.d.cts} +183 -77
- package/dist/{types-CLHaZv9f.d.cts → types-1B3ioN33.d.cts} +3 -3
- package/dist/{types-tgU8XvPs.d.cts → types-5HdT1rSH.d.cts} +2 -2
- package/dist/{types-DaMmgW-O.d.ts → types-B1GN_I06.d.ts} +2 -2
- package/dist/{types-DrvKfXXd.d.cts → types-B5kkD7h4.d.cts} +2 -2
- package/dist/{types-D9axmt5o.d.cts → types-BE7mRarT.d.ts} +8 -2
- package/dist/{types-CcYxlqtB.d.cts → types-BGICH80a.d.cts} +2 -2
- package/dist/{types-BaSlU0uo.d.ts → types-BHxsCu0f.d.ts} +2 -2
- package/dist/{types-z82gSTx8.d.ts → types-BMWeCO5M.d.ts} +3 -3
- package/dist/{types-CGm2fQKK.d.cts → types-BRvs3fXN.d.cts} +64 -5
- package/dist/{types-B-5ya_L5.d.ts → types-BTqxM-IN.d.ts} +2 -2
- package/dist/{types-DxN2siRW.d.ts → types-BjIuVrAZ.d.ts} +3 -3
- package/dist/{types-DoZtE9tz.d.cts → types-BksK2Eo0.d.cts} +2 -2
- package/dist/{types-DicSaNwq.d.ts → types-BoNqe_Lz.d.ts} +2 -2
- package/dist/{types-CAp1VexS.d.ts → types-Br04cEri.d.ts} +16 -4
- package/dist/{types-CN6huo55.d.ts → types-BtII5RSD.d.ts} +183 -77
- package/dist/types-Btb8r9iw.d.ts +1467 -0
- package/dist/{types-B2w2TtSA.d.ts → types-BuKviWct.d.ts} +2 -2
- package/dist/{types-CalDJHCX.d.cts → types-C05ALlV6.d.cts} +3 -3
- package/dist/{types-DzV6LaZq.d.ts → types-C4yryy-R.d.ts} +132 -5
- package/dist/{types-DdsYv2WG.d.cts → types-C8oZX0oP.d.cts} +3 -3
- package/dist/{types-BhEx9iRx.d.ts → types-CESP1ONj.d.ts} +1364 -1316
- package/dist/{types-ByLH46Dt.d.cts → types-CFurl1xe.d.cts} +2 -2
- package/dist/{types-BjR8Yodc.d.cts → types-CGhu0tID.d.cts} +2 -2
- package/dist/{types-DVZpKGBJ.d.ts → types-CaBhH99H.d.ts} +3 -3
- package/dist/{types-D1A4mAG0.d.cts → types-CclheyE7.d.cts} +3 -3
- package/dist/{types-CoJVrRAD.d.ts → types-CoQET4Ep.d.ts} +2 -2
- package/dist/{types-BiEh5c_t.d.cts → types-Csmy6qFk.d.cts} +132 -5
- package/dist/{types-CgBzm1YR.d.cts → types-CyO8qCKl.d.cts} +2 -2
- package/dist/{types-DlQw6FCi.d.ts → types-DDjp9lXD.d.ts} +2 -2
- package/dist/{types-CBPKpLTf.d.cts → types-DGu-wPPm.d.cts} +169 -2
- package/dist/{types-Ccd9O6ca.d.cts → types-DHdXufVf.d.cts} +3 -3
- package/dist/{types-BPy5Ozee.d.cts → types-DMWfdZ5C.d.cts} +2 -2
- package/dist/{types-WZBztugL.d.ts → types-DQauEri3.d.ts} +2 -2
- package/dist/{types-BZDV8DZk.d.ts → types-DSv1XS7s.d.ts} +11 -6
- package/dist/{types-YHUEArkR.d.cts → types-DUDQg4ry.d.cts} +2 -2
- package/dist/{types-CABWhTa9.d.ts → types-DiE081mn.d.ts} +3 -3
- package/dist/{types-CZJlLCbA.d.ts → types-Dvysi2Eo.d.ts} +2 -2
- package/dist/{types-sV9OaqTI.d.cts → types-GaOcVZ3d.d.cts} +1364 -1316
- package/dist/{types-Bydx6ga_.d.cts → types-LxDyOfdY.d.cts} +2 -2
- package/dist/{types-D8pGSkRe.d.ts → types-M9vU_ONp.d.ts} +3 -3
- package/dist/{types-CfwqVkEA.d.ts → types-Nwq1QtYe.d.ts} +2 -2
- package/dist/{types-9SEE4icc.d.ts → types-P_61P9Nd.d.ts} +2 -2
- package/dist/{types-pvQzbgNE.d.cts → types-QroFANIW.d.cts} +11 -6
- package/dist/{types-Fs4a3mVs.d.ts → types-UI2aZ74n.d.ts} +64 -5
- package/dist/{types-Dd31Lw4S.d.cts → types-XHNJRi3-.d.cts} +2 -2
- package/dist/{types-BBUZ9EHs.d.ts → types-YdE2VJzw.d.cts} +8 -2
- package/dist/{types-DVt0qlzI.d.cts → types-fAqPUl-a.d.ts} +521 -270
- package/dist/{types-c_bsDkV6.d.cts → types-ggpJFEWZ.d.cts} +16 -4
- package/dist/{types-CaOtNjSZ.d.ts → types-j30rKMe6.d.ts} +2 -2
- package/dist/{types-ePSqbXRr.d.cts → types-q5lgElyc.d.cts} +2 -2
- package/dist/{types-AYX7VtS6.d.ts → types-qGMVZGSB.d.ts} +169 -2
- package/dist/{types-D3wcs4tp.d.ts → types-qWA5iU0j.d.ts} +2 -2
- package/dist/{types-DazRtukc.d.ts → types-sI3K5t3w.d.cts} +521 -270
- package/dist/types-sg2xnYlr.d.cts +1467 -0
- package/dist/{types-B8N_k79M.d.cts → types-tJLoKlMX.d.cts} +2 -2
- package/dist/vault/index.d.cts +1 -1
- package/dist/vault/index.d.ts +1 -1
- package/dist/vault/types.d.cts +1 -1
- package/dist/vault/types.d.ts +1 -1
- package/package.json +1 -1
- package/surface/auth.md +19 -19
- package/surface/kaiAgent.md +1 -1
- package/surface/management.md +41 -41
- package/surface/storage.md +21 -21
- 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/management-C5lf9nsU.cjs.map +0 -1
- package/dist/management-WAtKH6Tu.js.map +0 -1
- package/dist/project-BvFi19K_.cjs.map +0 -1
- package/dist/project-DWwZv66D.js.map +0 -1
- package/dist/types-BhOUS9j1.d.cts +0 -749
- package/dist/types-gcAb6olM.d.ts +0 -749
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-
|
|
1
|
+
import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-BzhLY7el.cjs";
|
|
2
2
|
//#region src/clients/editor/__generated__/schema.d.ts
|
|
3
3
|
/**
|
|
4
4
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -1408,4 +1408,4 @@ type PostSqlSessionUnloadPath = OpenapiPathType<paths['/sql/sessions/{id}/unload
|
|
|
1408
1408
|
type PostSqlSessionUnloadBody = OpenapiBodyType<paths['/sql/sessions/{id}/unload']['post']>;
|
|
1409
1409
|
//#endregion
|
|
1410
1410
|
export { components as C, SqlSession as S, SessionSchema as _, GetSqlSessionTableDdlPath as a, SessionSchemaDatabase as b, PostSqlRunQueryBody as c, PostSqlSessionLoadPath as d, PostSqlSessionUnloadBody as f, Session as g, PostSqlTablePreviewPath as h, GetSqlSessionSchemaQuery as i, PostSqlRunQueryPath as l, PostSqlTablePreviewBody as m, GetSqlSessionPath as n, GetSqlSessionTableDdlQuery as o, PostSqlSessionUnloadPath as p, GetSqlSessionSchemaPath as r, GetSqlSessionsQuery as s, CreateSqlSessionBody as t, PostSqlSessionLoadBody as u, SessionSchemaBucket as v, SessionSchemaTable as x, SessionSchemaColumn as y };
|
|
1411
|
-
//# sourceMappingURL=types-
|
|
1411
|
+
//# sourceMappingURL=types-tJLoKlMX.d.cts.map
|
package/dist/vault/index.d.cts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { t as createVaultClient } from "../index-
|
|
1
|
+
import { t as createVaultClient } from "../index-x8ET_BTN.cjs";
|
|
2
2
|
export { createVaultClient };
|
package/dist/vault/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { t as createVaultClient } from "../index-
|
|
1
|
+
import { t as createVaultClient } from "../index-BnPYPXGQ.js";
|
|
2
2
|
export { createVaultClient };
|
package/dist/vault/types.d.cts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as GetVariablesQuery, i as GetVariablesByBranchId, n as CreateVariableBody, o as VariableWithHash, r as DeleteVariablePath, t as AnyVariable } from "../types-
|
|
1
|
+
import { a as GetVariablesQuery, i as GetVariablesByBranchId, n as CreateVariableBody, o as VariableWithHash, r as DeleteVariablePath, t as AnyVariable } from "../types-YdE2VJzw.cjs";
|
|
2
2
|
export { AnyVariable, CreateVariableBody, DeleteVariablePath, GetVariablesByBranchId, GetVariablesQuery, VariableWithHash };
|
package/dist/vault/types.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { a as GetVariablesQuery, i as GetVariablesByBranchId, n as CreateVariableBody, o as VariableWithHash, r as DeleteVariablePath, t as AnyVariable } from "../types-
|
|
1
|
+
import { a as GetVariablesQuery, i as GetVariablesByBranchId, n as CreateVariableBody, o as VariableWithHash, r as DeleteVariablePath, t as AnyVariable } from "../types-BE7mRarT.js";
|
|
2
2
|
export { AnyVariable, CreateVariableBody, DeleteVariablePath, GetVariablesByBranchId, GetVariablesQuery, VariableWithHash };
|
package/package.json
CHANGED
package/surface/auth.md
CHANGED
|
@@ -8,8 +8,8 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
8
8
|
|
|
9
9
|
### `api.auth.device`
|
|
10
10
|
|
|
11
|
-
- `api.auth.device.approve(body: { userCode: string; decision: "approve" | "deny"; projectScope?: "all" | null | undefined; projectIds?: string[] | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ status: "approved" | "denied"; idempotent: boolean; decision
|
|
12
|
-
- `api.auth.device.create(body: { clientId: string; scope
|
|
11
|
+
- `api.auth.device.approve(body: { userCode: string; decision: "approve" | "deny"; projectScope?: "all" | null | undefined; projectIds?: string[] | null | undefined; }, signal?: AbortSignal | undefined): Promise<{ status: "approved" | "denied"; idempotent: boolean; decision?: "approve" | "deny" | undefined; }>`
|
|
12
|
+
- `api.auth.device.create(body: { clientId: string; scope?: { credentialType?: "session" | undefined; } | undefined; requestedCredentialType?: string | undefined; }, signal?: AbortSignal | undefined): Promise<{ deviceCode: string; userCode: string; verificationUri: string; verificationUriComplete: string; expiresIn: number; interval: number; }>`
|
|
13
13
|
- `api.auth.device.getToken(body: { clientId: string; deviceCode: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken: string; tokenType: string; expiresIn: number; sessionId: string; user: { id: number; email: string; name: string; }; }>`
|
|
14
14
|
|
|
15
15
|
### `api.auth.login`
|
|
@@ -20,28 +20,28 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
20
20
|
|
|
21
21
|
### `api.auth.manageTokens`
|
|
22
22
|
|
|
23
|
-
- `api.auth.manageTokens.create(input: { description: string; expiresIn: number; }, signal?: AbortSignal | undefined): Promise<{ token: string; manageToken: { id: number; description: string; type: string; scopes: string[]; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; createdAt
|
|
24
|
-
- `api.auth.manageTokens.getAll(signal?: AbortSignal | undefined): Promise<{ tokens: { id: number; description: string; type: string; scopes: string[]; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; createdAt
|
|
23
|
+
- `api.auth.manageTokens.create(input: { description: string; expiresIn: number; }, signal?: AbortSignal | undefined): Promise<{ token: string; manageToken: { id: number; description: string; type: string; scopes: string[]; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; createdAt: string | null; expiresAt: string | null; lastUsedAt: string | null; }; }>`
|
|
24
|
+
- `api.auth.manageTokens.getAll(signal?: AbortSignal | undefined): Promise<{ tokens: { id: number; description: string; type: string; scopes: string[]; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; createdAt: string | null; expiresAt: string | null; lastUsedAt: string | null; }[]; sessionTokens: { id: number; description: string; type: string; scopes: string[]; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; createdAt: string | null; expiresAt: string | null; lastUsedAt: string | null; }[]; }>`
|
|
25
25
|
- `api.auth.manageTokens.revoke(id: number, signal?: AbortSignal | undefined): Promise<void>`
|
|
26
26
|
|
|
27
27
|
### `api.auth.me`
|
|
28
28
|
|
|
29
29
|
- `api.auth.me.get(signal?: AbortSignal | undefined): Promise<{ user: { id: number; name: string; email: string; isSuperAdmin: boolean; hasMfaEnabled: boolean; features: string[]; }; organizations: { count: number; preview: { id: number; name: string; mfaRequired: boolean; maintainer: { id: number; name: string | null; }; isAdmin: boolean; hasAccess: boolean; canLeave: boolean; projectsCount: number; }[]; hasMore: boolean; }; maintainers: { count: number; preview: { id: number; name: string | null; }[]; hasMore: boolean; }; projects: { count: number; preview: { id: number; name: string; organizationId: number; role: string | null; isDisabled: boolean; disabledReason: string | null; }[]; hasMore: boolean; }; }>`
|
|
30
|
-
- `api.auth.me.getMaintainers(query?: {
|
|
31
|
-
- `api.auth.me.getOrganizations(query?: {
|
|
32
|
-
- `api.auth.me.getProjects(query?: {
|
|
30
|
+
- `api.auth.me.getMaintainers(query?: { page?: { after?: string | undefined; limit?: number | undefined; } | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ data: Record<string, never>[]; 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; }; } & { data?: { id: number; name: string | null; }[] | undefined; }>`
|
|
31
|
+
- `api.auth.me.getOrganizations(query?: { page?: { after?: string | undefined; limit?: number | undefined; } | undefined; filter?: { maintainerId?: number | undefined; } | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ data: Record<string, never>[]; 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; }; } & { data?: { id: number; name: string; mfaRequired: boolean; maintainer: { id: number; name: string | null; }; isAdmin: boolean; hasAccess: boolean; canLeave: boolean; projectsCount: number; }[] | undefined; }>`
|
|
32
|
+
- `api.auth.me.getProjects(query?: { page?: { after?: string | undefined; limit?: number | undefined; } | undefined; filter?: { organizationId?: number | undefined; name?: string | undefined; } | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ data: Record<string, never>[]; 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; }; } & { data?: { id: number; name: string; organizationId: number; role: string | null; isDisabled: boolean; disabledReason: string | null; }[] | undefined; }>`
|
|
33
33
|
|
|
34
34
|
### `api.auth.mfa`
|
|
35
35
|
|
|
36
36
|
- `api.auth.mfa.regenerateRecoveryCodes(signal?: AbortSignal | undefined): Promise<{ codes: string[]; }>`
|
|
37
|
-
- `api.auth.mfa.verifyWithCode(input: { mfaToken: string; type: "totp" | "recovery_code"; code: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string |
|
|
38
|
-
- `api.auth.mfa.verifyWithWebauthn(input: { mfaToken: string; assertion: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string |
|
|
37
|
+
- `api.auth.mfa.verifyWithCode(input: { mfaToken: string; type: "totp" | "recovery_code"; code: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string | undefined; tokenType: string; expiresIn: number; sessionId: string; user: { id: number; email: string; name: string; }; }>`
|
|
38
|
+
- `api.auth.mfa.verifyWithWebauthn(input: { mfaToken: string; assertion: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string | undefined; tokenType: string; expiresIn: number; sessionId: string; user: { id: number; email: string; name: string; }; }>`
|
|
39
39
|
|
|
40
40
|
### `api.auth.mfa.totp`
|
|
41
41
|
|
|
42
42
|
- `api.auth.mfa.totp.disable(id: number, signal?: AbortSignal | undefined): Promise<void>`
|
|
43
43
|
- `api.auth.mfa.totp.setup(signal?: AbortSignal | undefined): Promise<{ secret: string; otpauthUri: string; expiresAt: string; }>`
|
|
44
|
-
- `api.auth.mfa.totp.verify(input: { code: string; revokeOtherSessions?: boolean | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: number; mfaType: string; recoveryCodes?: string[] |
|
|
44
|
+
- `api.auth.mfa.totp.verify(input: { code: string; revokeOtherSessions?: boolean | undefined; }, signal?: AbortSignal | undefined): Promise<{ id: number; mfaType: string; recoveryCodes?: string[] | undefined; }>`
|
|
45
45
|
|
|
46
46
|
### `api.auth.password`
|
|
47
47
|
|
|
@@ -51,9 +51,9 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
51
51
|
|
|
52
52
|
### `api.auth.pat`
|
|
53
53
|
|
|
54
|
-
- `api.auth.pat.create(input: CreatePatInput, signal?: AbortSignal | undefined): Promise<{ accessToken: string; tokenType: string; expiresIn: number; pat: { id: string; name: string; scope: Record<string, never>; projects: { id: number; name: string | null; role: string | null; }[]; readOnly: boolean; parentTokenId
|
|
55
|
-
- `api.auth.pat.exchange(input?: ExchangePatInput, signal?: AbortSignal | undefined): Promise<{ accessToken: string; tokenType: string; expiresIn: number; scope: Record<string, never>; readOnly: boolean; parentTokenId: string; parentTokenType: "session" | "pat"; expiresAt: string; pat: { id: string; name: string; scope: Record<string, never>; projects: { id: number; name: string | null; role: string | null; }[]; readOnly: boolean; parentTokenId
|
|
56
|
-
- `api.auth.pat.getAll(signal?: AbortSignal | undefined): Promise<{ items: { id: string; name: string; scope: Record<string, never>; projects: { id: number; name: string | null; role: string | null; }[]; readOnly: boolean; parentTokenId
|
|
54
|
+
- `api.auth.pat.create(input: CreatePatInput, signal?: AbortSignal | undefined): Promise<{ accessToken: string; tokenType: string; expiresIn: number; pat: { id: string; name: string; scope: Record<string, never>; projects: { id: number; name: string | null; role: string | null; }[]; readOnly: boolean; parentTokenId: string | null; parentTokenType: "session" | "pat" | null; expiresAt: string; lastUsedAt: string | null; createdAt: string; }; }>`
|
|
55
|
+
- `api.auth.pat.exchange(input?: ExchangePatInput, signal?: AbortSignal | undefined): Promise<{ accessToken: string; tokenType: string; expiresIn: number; scope: Record<string, never>; readOnly: boolean; parentTokenId: string; parentTokenType: "session" | "pat"; expiresAt: string; pat: { id: string; name: string; scope: Record<string, never>; projects: { id: number; name: string | null; role: string | null; }[]; readOnly: boolean; parentTokenId: string | null; parentTokenType: "session" | "pat" | null; expiresAt: string; lastUsedAt: string | null; createdAt: string; }; }>`
|
|
56
|
+
- `api.auth.pat.getAll(signal?: AbortSignal | undefined): Promise<{ items: { id: string; name: string; scope: Record<string, never>; projects: { id: number; name: string | null; role: string | null; }[]; readOnly: boolean; parentTokenId: string | null; parentTokenType: "session" | "pat" | null; expiresAt: string; lastUsedAt: string | null; createdAt: string; }[]; }>`
|
|
57
57
|
- `api.auth.pat.revoke(id: string, signal?: AbortSignal | undefined): Promise<void>`
|
|
58
58
|
|
|
59
59
|
### `api.auth.pkce`
|
|
@@ -62,12 +62,12 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
62
62
|
|
|
63
63
|
### `api.auth.saml`
|
|
64
64
|
|
|
65
|
-
- `api.auth.saml.assert(body: { samlResponse: string; requestHandle: string; customerSlug: string | null; browserMode: boolean; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string |
|
|
65
|
+
- `api.auth.saml.assert(body: { samlResponse: string; requestHandle: string; customerSlug: string | null; browserMode: boolean; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string | undefined; tokenType: string; expiresIn: number; sessionId: string; user: { id: number; email: string; name: string; }; } | { mfaRequired: boolean; mfaType: string; mfaToken: string; expiresIn: number; allowedMethods: string[]; webauthn: Record<string, never> | null; }>`
|
|
66
66
|
- `api.auth.saml.initiate(body?: { customerSlug: string | null; } | undefined, signal?: AbortSignal | undefined): Promise<{ ssoUrl: string; requestHandle: string; expiresIn: number; }>`
|
|
67
67
|
|
|
68
68
|
### `api.auth.session`
|
|
69
69
|
|
|
70
|
-
- `api.auth.session.getAll(signal?: AbortSignal | undefined): Promise<{ sessions?: { id: string; grantType: string; client
|
|
70
|
+
- `api.auth.session.getAll(signal?: AbortSignal | undefined): Promise<{ sessions?: { id: string; grantType: string; client: { id: string; name: string | null; } | null; allProjects: boolean; projects: { id: string; name: string | null; }[]; createdAt: string; lastUsedAt: string | null; lastUsedIp: string | null; userAgent: string | null; accessTokenExpiresAt: string; refreshTokenExpiresAt: string; isCurrent: boolean; }[] | undefined; oauthSessions?: { client: { id: string; name: string | null; }; project: { id: string; name: string | null; } | null; tokenId: number | null; allProjects: boolean; projects: { id: string; name: string | null; }[]; scopes: string[]; authorizedAt: string | null; expiresAt: string; }[] | undefined; }>`
|
|
71
71
|
- `api.auth.session.revoke(sessionId: string, signal?: AbortSignal | undefined): Promise<void>`
|
|
72
72
|
- `api.auth.session.revokeAll(signal?: AbortSignal | undefined): Promise<void>`
|
|
73
73
|
|
|
@@ -78,14 +78,14 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
78
78
|
|
|
79
79
|
### `api.auth.token`
|
|
80
80
|
|
|
81
|
-
- `api.auth.token.introspect(token?: string | undefined, signal?: AbortSignal | undefined): Promise<{ sessionId: string; user: { id: number; email: string; name: string; }; grantType: string; sudoVerified: boolean; createdAt: string; expiresAt: string; lastUsedAt
|
|
82
|
-
- `api.auth.token.refreshWithSession(input: { sessionId: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string |
|
|
83
|
-
- `api.auth.token.refreshWithToken(input: { refreshToken: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string |
|
|
81
|
+
- `api.auth.token.introspect(token?: string | undefined, signal?: AbortSignal | undefined): Promise<{ sessionId: string; user: { id: number; email: string; name: string; }; grantType: string; sudoVerified: boolean; createdAt: string; expiresAt: string; lastUsedAt: string | null; lastUsedIp: string | null; userAgent: string | null; projects: { id: number; name: string | null; role: string | null; }[]; }>`
|
|
82
|
+
- `api.auth.token.refreshWithSession(input: { sessionId: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string | undefined; tokenType: string; expiresIn: number; sessionId: string; user: { id: number; email: string; name: string; }; }>`
|
|
83
|
+
- `api.auth.token.refreshWithToken(input: { refreshToken: string; }, signal?: AbortSignal | undefined): Promise<{ accessToken: string; refreshToken?: string | undefined; tokenType: string; expiresIn: number; sessionId: string; user: { id: number; email: string; name: string; }; }>`
|
|
84
84
|
- `api.auth.token.revoke(body: { token: string; tokenTypeHint: "accessToken" | "refreshToken" | null; }, signal?: AbortSignal | undefined): Promise<void>`
|
|
85
85
|
|
|
86
86
|
### `api.auth.webauthn`
|
|
87
87
|
|
|
88
88
|
- `api.auth.webauthn.getAll(signal?: AbortSignal | undefined): Promise<{ webauthnCredentials?: { id: number; deviceName: string; created: string; }[] | undefined; }>`
|
|
89
|
-
- `api.auth.webauthn.register({ credential, deviceName, revokeOtherSessions }: RegisterWebauthnInput, signal?: AbortSignal | undefined): Promise<{ id: number; deviceName: string; created: string; recoveryCodes?: string[] |
|
|
89
|
+
- `api.auth.webauthn.register({ credential, deviceName, revokeOtherSessions }: RegisterWebauthnInput, signal?: AbortSignal | undefined): Promise<{ id: number; deviceName: string; created: string; recoveryCodes?: string[] | undefined; }>`
|
|
90
90
|
- `api.auth.webauthn.registerOptions(signal?: AbortSignal | undefined): Promise<RegisterWebauthnOptionsResult>`
|
|
91
91
|
- `api.auth.webauthn.remove({ id, ...query }: RemoveWebauthnInput, signal?: AbortSignal | undefined): Promise<void>`
|
package/surface/kaiAgent.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
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; } | 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>`
|
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,20 @@ 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.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<{ id: number; backend: string; region: string; owner: string; technicalOwner: string; technicalOwnerContactEmails: string[]; credentials
|
|
179
|
-
- `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
|
|
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.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<{ id: number; backend: string; region: string; owner: string; technicalOwner: string; technicalOwnerContactEmails: string[]; credentials: Record<string, never>; folderId: string | null; bqExternalSharingRoleName: string | null; policyTagsEnabled: boolean; }>`
|
|
179
|
+
- `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
180
|
- `api.management.storageBackends.deleteStorageBackend(id: number): Promise<void>`
|
|
181
181
|
- `api.management.storageBackends.getStorageBackend(id: number, signal?: AbortSignal | undefined): Promise<StorageBackend>`
|
|
182
182
|
- `api.management.storageBackends.getStorageBackendMaintainers(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; }[]>`
|
|
183
183
|
- `api.management.storageBackends.getStorageBackendProjects(id: number, query?: { limit?: number | undefined; offset?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; }[]>`
|
|
184
184
|
- `api.management.storageBackends.getStorageBackends(signal?: AbortSignal | undefined): Promise<StorageBackend[]>`
|
|
185
|
-
- `api.management.storageBackends.updateBigqueryStorageBackend({ id, ...body }: UpdateBigqueryStorageBackendInput): Promise<{ id: number; backend: string; region: string; owner: string; technicalOwner: string; technicalOwnerContactEmails: string[]; credentials
|
|
186
|
-
- `api.management.storageBackends.updateStorageBackend({ id, ...body }: UpdateStorageBackendInput): Promise<{ id: number; backend: string; region: string; owner
|
|
185
|
+
- `api.management.storageBackends.updateBigqueryStorageBackend({ id, ...body }: UpdateBigqueryStorageBackendInput): Promise<{ id: number; backend: string; region: string; owner: string; technicalOwner: string; technicalOwnerContactEmails: string[]; credentials: Record<string, never>; folderId: string | null; bqExternalSharingRoleName: string | null; policyTagsEnabled: boolean; }>`
|
|
186
|
+
- `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
187
|
|
|
188
188
|
### `api.management.uiApps`
|
|
189
189
|
|
|
@@ -191,7 +191,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
|
|
|
191
191
|
- `api.management.uiApps.deleteUiApp(stringId: string): Promise<void>`
|
|
192
192
|
- `api.management.uiApps.getUiApp(stringId: string, signal?: AbortSignal | undefined): Promise<UiAppDetail>`
|
|
193
193
|
- `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
|
|
194
|
+
- `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
195
|
- `api.management.uiApps.renameUiApp({ stringId, ...body }: { stringId: string; } & { name: string; }): Promise<void>`
|
|
196
196
|
|
|
197
197
|
### `api.management.users`
|