@keboola/api-client 41.0.0 → 43.0.0

package/dist/{validateConnectionStatus-BEYkQpu9.cjs → validateConnectionStatus-Ca1uEizv.cjs}

@@ -1,5 +1,5 @@
-const require_createFetchClient = require("./createFetchClient-Cwp8max9.cjs");
-const require_isLoginPageRedirect = require("./isLoginPageRedirect-jQHiLrG7.cjs");
+const require_createFetchClient = require("./createFetchClient-BgihytBn.cjs");
+const require_isLoginPageRedirect = require("./isLoginPageRedirect-c451CoWW.cjs");
 //#region src/errors/HtmlResponseError.ts
 /**
 * A successful response that carried an HTML page instead of the endpoint's payload.
@@ -50,4 +50,4 @@ Object.defineProperty(exports, "validateConnectionStatus", {
 	}
 });
 
-//# sourceMappingURL=validateConnectionStatus-BEYkQpu9.cjs.map
+//# sourceMappingURL=validateConnectionStatus-Ca1uEizv.cjs.map

package/dist/{validateConnectionStatus-BEYkQpu9.cjs.map → validateConnectionStatus-Ca1uEizv.cjs.map}

@@ -1 +1 @@
-{"version":3,"file":"validateConnectionStatus-BEYkQpu9.cjs","names":["ApiError","defaultValidateStatus","isLoginPageRedirect"],"sources":["../src/errors/HtmlResponseError.ts","../src/clients/validateConnectionStatus.ts"],"sourcesContent":["import type { ApiResponse } from '../fetchClient/createFetchClient/types';\n\nimport { ApiError } from './ApiError';\n\n/**\n * A successful response that carried an HTML page instead of the endpoint's payload.\n *\n * - An expired session 302s to the login page; `fetch` follows it to `200 text/html`.\n * - Constant message so Sentry groups it; `request`/`response` carry the detail.\n * - Opt-in per client: some APIs serve HTML from a 200 on purpose.\n */\nexport class HtmlResponseError extends ApiError {\n  constructor(res: ApiResponse) {\n    super(res);\n    this.name = 'HtmlResponseError';\n    this.message = 'Expected data, got an HTML page. The session has most likely expired.';\n  }\n}\n\nexport const isHtmlResponseError = (error: unknown): error is HtmlResponseError =>\n  error instanceof HtmlResponseError;\n","import { HtmlResponseError } from '../errors';\nimport { defaultValidateStatus, type ValidateStatusFn } from '../fetchClient';\n\nimport { isLoginPageRedirect } from './isLoginPageRedirect';\n\n/**\n * Status validation for the APIs Connection serves off its own host — storage and auth.\n *\n * - Rejects a successful login page; `HtmlResponseError` says why.\n * - HTML on a *failed* response is a real error page and stays an `ApiError`.\n * - Management answers the same condition with its own session-expiry error instead.\n */\nexport const validateConnectionStatus: ValidateStatusFn = (apiResponse) => {\n  const isValid = defaultValidateStatus(apiResponse);\n\n  if (isValid && isLoginPageRedirect(apiResponse)) {\n    return new HtmlResponseError(apiResponse);\n  }\n\n  return isValid;\n};\n"],"mappings":";;;;;;;;;;AAWA,IAAa,oBAAb,cAAuCA,0BAAAA,SAAS;CAC9C,YAAY,KAAkB;EAC5B,MAAM,GAAG;EACT,KAAK,OAAO;EACZ,KAAK,UAAU;CACjB;AACF;AAEA,MAAa,uBAAuB,UAClC,iBAAiB;;;;;;;;;;ACRnB,MAAa,4BAA8C,gBAAgB;CACzE,MAAM,UAAUC,0BAAAA,sBAAsB,WAAW;CAEjD,IAAI,WAAWC,4BAAAA,oBAAoB,WAAW,GAC5C,OAAO,IAAI,kBAAkB,WAAW;CAG1C,OAAO;AACT"}
+{"version":3,"file":"validateConnectionStatus-Ca1uEizv.cjs","names":["ApiError","defaultValidateStatus","isLoginPageRedirect"],"sources":["../src/errors/HtmlResponseError.ts","../src/clients/validateConnectionStatus.ts"],"sourcesContent":["import type { ApiResponse } from '../fetchClient/createFetchClient/types';\n\nimport { ApiError } from './ApiError';\n\n/**\n * A successful response that carried an HTML page instead of the endpoint's payload.\n *\n * - An expired session 302s to the login page; `fetch` follows it to `200 text/html`.\n * - Constant message so Sentry groups it; `request`/`response` carry the detail.\n * - Opt-in per client: some APIs serve HTML from a 200 on purpose.\n */\nexport class HtmlResponseError extends ApiError {\n  constructor(res: ApiResponse) {\n    super(res);\n    this.name = 'HtmlResponseError';\n    this.message = 'Expected data, got an HTML page. The session has most likely expired.';\n  }\n}\n\nexport const isHtmlResponseError = (error: unknown): error is HtmlResponseError =>\n  error instanceof HtmlResponseError;\n","import { HtmlResponseError } from '../errors';\nimport { defaultValidateStatus, type ValidateStatusFn } from '../fetchClient';\n\nimport { isLoginPageRedirect } from './isLoginPageRedirect';\n\n/**\n * Status validation for the APIs Connection serves off its own host — storage and auth.\n *\n * - Rejects a successful login page; `HtmlResponseError` says why.\n * - HTML on a *failed* response is a real error page and stays an `ApiError`.\n * - Management answers the same condition with its own session-expiry error instead.\n */\nexport const validateConnectionStatus: ValidateStatusFn = (apiResponse) => {\n  const isValid = defaultValidateStatus(apiResponse);\n\n  if (isValid && isLoginPageRedirect(apiResponse)) {\n    return new HtmlResponseError(apiResponse);\n  }\n\n  return isValid;\n};\n"],"mappings":";;;;;;;;;;AAWA,IAAa,oBAAb,cAAuCA,0BAAAA,SAAS;CAC9C,YAAY,KAAkB;EAC5B,MAAM,GAAG;EACT,KAAK,OAAO;EACZ,KAAK,UAAU;CACjB;AACF;AAEA,MAAa,uBAAuB,UAClC,iBAAiB;;;;;;;;;;ACRnB,MAAa,4BAA8C,gBAAgB;CACzE,MAAM,UAAUC,0BAAAA,sBAAsB,WAAW;CAEjD,IAAI,WAAWC,4BAAAA,oBAAoB,WAAW,GAC5C,OAAO,IAAI,kBAAkB,WAAW;CAG1C,OAAO;AACT"}

package/dist/{validateConnectionStatus-BEGu8wXT.js → validateConnectionStatus-gFsBi5FV.js}

@@ -1,5 +1,5 @@
-import { c as defaultValidateStatus, g as ApiError } from "./createFetchClient-DXHQK63w.js";
-import { t as isLoginPageRedirect } from "./isLoginPageRedirect-XPwAOKK3.js";
+import { c as defaultValidateStatus, g as ApiError } from "./createFetchClient-cgWkwgAQ.js";
+import { t as isLoginPageRedirect } from "./isLoginPageRedirect-CsjF95_P.js";
 //#region src/errors/HtmlResponseError.ts
 /**
 * A successful response that carried an HTML page instead of the endpoint's payload.
@@ -33,4 +33,4 @@ const validateConnectionStatus = (apiResponse) => {
 //#endregion
 export { HtmlResponseError as n, isHtmlResponseError as r, validateConnectionStatus as t };
 
-//# sourceMappingURL=validateConnectionStatus-BEGu8wXT.js.map
+//# sourceMappingURL=validateConnectionStatus-gFsBi5FV.js.map

package/dist/{validateConnectionStatus-BEGu8wXT.js.map → validateConnectionStatus-gFsBi5FV.js.map}

@@ -1 +1 @@
-{"version":3,"file":"validateConnectionStatus-BEGu8wXT.js","names":[],"sources":["../src/errors/HtmlResponseError.ts","../src/clients/validateConnectionStatus.ts"],"sourcesContent":["import type { ApiResponse } from '../fetchClient/createFetchClient/types';\n\nimport { ApiError } from './ApiError';\n\n/**\n * A successful response that carried an HTML page instead of the endpoint's payload.\n *\n * - An expired session 302s to the login page; `fetch` follows it to `200 text/html`.\n * - Constant message so Sentry groups it; `request`/`response` carry the detail.\n * - Opt-in per client: some APIs serve HTML from a 200 on purpose.\n */\nexport class HtmlResponseError extends ApiError {\n  constructor(res: ApiResponse) {\n    super(res);\n    this.name = 'HtmlResponseError';\n    this.message = 'Expected data, got an HTML page. The session has most likely expired.';\n  }\n}\n\nexport const isHtmlResponseError = (error: unknown): error is HtmlResponseError =>\n  error instanceof HtmlResponseError;\n","import { HtmlResponseError } from '../errors';\nimport { defaultValidateStatus, type ValidateStatusFn } from '../fetchClient';\n\nimport { isLoginPageRedirect } from './isLoginPageRedirect';\n\n/**\n * Status validation for the APIs Connection serves off its own host — storage and auth.\n *\n * - Rejects a successful login page; `HtmlResponseError` says why.\n * - HTML on a *failed* response is a real error page and stays an `ApiError`.\n * - Management answers the same condition with its own session-expiry error instead.\n */\nexport const validateConnectionStatus: ValidateStatusFn = (apiResponse) => {\n  const isValid = defaultValidateStatus(apiResponse);\n\n  if (isValid && isLoginPageRedirect(apiResponse)) {\n    return new HtmlResponseError(apiResponse);\n  }\n\n  return isValid;\n};\n"],"mappings":";;;;;;;;;;AAWA,IAAa,oBAAb,cAAuC,SAAS;CAC9C,YAAY,KAAkB;EAC5B,MAAM,GAAG;EACT,KAAK,OAAO;EACZ,KAAK,UAAU;CACjB;AACF;AAEA,MAAa,uBAAuB,UAClC,iBAAiB;;;;;;;;;;ACRnB,MAAa,4BAA8C,gBAAgB;CACzE,MAAM,UAAU,sBAAsB,WAAW;CAEjD,IAAI,WAAW,oBAAoB,WAAW,GAC5C,OAAO,IAAI,kBAAkB,WAAW;CAG1C,OAAO;AACT"}
+{"version":3,"file":"validateConnectionStatus-gFsBi5FV.js","names":[],"sources":["../src/errors/HtmlResponseError.ts","../src/clients/validateConnectionStatus.ts"],"sourcesContent":["import type { ApiResponse } from '../fetchClient/createFetchClient/types';\n\nimport { ApiError } from './ApiError';\n\n/**\n * A successful response that carried an HTML page instead of the endpoint's payload.\n *\n * - An expired session 302s to the login page; `fetch` follows it to `200 text/html`.\n * - Constant message so Sentry groups it; `request`/`response` carry the detail.\n * - Opt-in per client: some APIs serve HTML from a 200 on purpose.\n */\nexport class HtmlResponseError extends ApiError {\n  constructor(res: ApiResponse) {\n    super(res);\n    this.name = 'HtmlResponseError';\n    this.message = 'Expected data, got an HTML page. The session has most likely expired.';\n  }\n}\n\nexport const isHtmlResponseError = (error: unknown): error is HtmlResponseError =>\n  error instanceof HtmlResponseError;\n","import { HtmlResponseError } from '../errors';\nimport { defaultValidateStatus, type ValidateStatusFn } from '../fetchClient';\n\nimport { isLoginPageRedirect } from './isLoginPageRedirect';\n\n/**\n * Status validation for the APIs Connection serves off its own host — storage and auth.\n *\n * - Rejects a successful login page; `HtmlResponseError` says why.\n * - HTML on a *failed* response is a real error page and stays an `ApiError`.\n * - Management answers the same condition with its own session-expiry error instead.\n */\nexport const validateConnectionStatus: ValidateStatusFn = (apiResponse) => {\n  const isValid = defaultValidateStatus(apiResponse);\n\n  if (isValid && isLoginPageRedirect(apiResponse)) {\n    return new HtmlResponseError(apiResponse);\n  }\n\n  return isValid;\n};\n"],"mappings":";;;;;;;;;;AAWA,IAAa,oBAAb,cAAuC,SAAS;CAC9C,YAAY,KAAkB;EAC5B,MAAM,GAAG;EACT,KAAK,OAAO;EACZ,KAAK,UAAU;CACjB;AACF;AAEA,MAAa,uBAAuB,UAClC,iBAAiB;;;;;;;;;;ACRnB,MAAa,4BAA8C,gBAAgB;CACzE,MAAM,UAAU,sBAAsB,WAAW;CAEjD,IAAI,WAAW,oBAAoB,WAAW,GAC5C,OAAO,IAAI,kBAAkB,WAAW;CAG1C,OAAO;AACT"}

package/dist/vault/index.cjs

@@ -1,10 +1,13 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_collect = require("../collect-B5TCNiT1.cjs");
 const require_UserError = require("../UserError-CSGO1qII.cjs");
-require("../createFetchClient-Cwp8max9.cjs");
-const require_createGenericFetchClient = require("../createGenericFetchClient-Dl9cqTvR.cjs");
-const require_createOpenapiFetchClient = require("../createOpenapiFetchClient-BYqW-9tm.cjs");
-const require_auth = require("../auth-Dm0F2rOh.cjs");
+require("../createFetchClient-BgihytBn.cjs");
+const require_createGenericFetchClient = require("../createGenericFetchClient-C7Y0YVfc.cjs");
+const require_createOpenapiFetchClient = require("../createOpenapiFetchClient-DY5s-aH6.cjs");
+const require_auth = require("../auth-zfI04oj7.cjs");
 //#region src/clients/vault/vaultClient.ts
+/** The vault's maximum `limit` on `GET /variables`. */
+const VARIABLES_PAGE_SIZE = 100;
 const createVaultClient = ({ baseUrl, middlewares, auth }) => {
 	const client = require_createOpenapiFetchClient.createOpenapiFetchClient({
 		baseUrl,
@@ -27,11 +30,32 @@ const createVaultClient = ({ baseUrl, middlewares, auth }) => {
 		const { data } = await client.post("/variables", { body }, { signal });
 		return data;
 	};
+	/**
+	* Every variable of exactly one scope, across all pages.
+	*
+	* - `null` is the project-wide scope: variables with no `branchId`.
+	* - A branch id returns that branch's variables only — project-wide ones are not merged in.
+	*/
+	const getVariablesInScope = (branchId, signal) => require_collect.collect({
+		pageSize: VARIABLES_PAGE_SIZE,
+		signal,
+		fetchFrom: (offset, limit, pageSignal) => getVariables({
+			attributes: { branchId: branchId ?? "" },
+			offset,
+			limit
+		}, pageSignal)
+	});
+	/**
+	* What `vault.<key>` resolves to in a branch: its variables plus the project-wide ones.
+	*
+	* - One variable per key — a branch variable hides a project-wide one with the same key.
+	* - Unpaginated: the vault returns at most 100 of each half.
+	*/
 	const getVariablesByBranchId = async (branchId, signal) => {
 		const { data } = await client.get("/variables/scoped/branch/{branchId}", { path: { branchId } }, { signal });
 		return data;
 	};
-	const getProjectWideVariables = (signal) => getVariablesByBranchId("null", signal);
+	const getProjectWideVariables = (signal) => getVariablesInScope(null, signal);
 	const healthCheck = async (signal) => {
 		const { data } = await genericClient.get("/health-check", {}, { signal });
 		return data;
@@ -42,7 +66,8 @@ const createVaultClient = ({ baseUrl, middlewares, auth }) => {
 		deleteVariable,
 		getProjectWideVariables,
 		getVariables,
-		getVariablesByBranchId
+		getVariablesByBranchId,
+		getVariablesInScope
 	};
 };
 //#endregion

package/dist/vault/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["createOpenapiFetchClient","createAuthHeaders","createGenericFetchClient","UserError"],"sources":["../../src/clients/vault/vaultClient.ts"],"sourcesContent":["import { UserError } from '../../errors';\nimport { createGenericFetchClient, createOpenapiFetchClient } from '../../fetchClient';\nimport { ENCRYPTED_VALUE_PREFIX } from '../../internal';\nimport { createAuthHeaders } from '../auth';\nimport type { ClientInitOptions } from '../types';\n\nimport type { paths } from './__generated__/schema';\nimport type {\n  CreateVariableBody,\n  DeleteVariablePath,\n  GetVariablesByBranchId,\n  GetVariablesQuery,\n  VariableWithHash,\n} from './types';\n\nexport const createVaultClient = ({ baseUrl, middlewares, auth }: ClientInitOptions) => {\n  const client = createOpenapiFetchClient<paths>({\n    baseUrl,\n    middlewares,\n    headers: createAuthHeaders(auth),\n  });\n  const genericClient = createGenericFetchClient({ baseUrl, middlewares });\n\n  const getVariables = async (query: GetVariablesQuery, signal?: AbortSignal) => {\n    const { data } = await client.get(\n      '/variables',\n      { query },\n      {\n        signal,\n      },\n    );\n\n    return data as VariableWithHash[];\n  };\n\n  const deleteVariable = async (hash: DeleteVariablePath['hash'], signal?: AbortSignal) => {\n    await client.delete(\n      '/variables/{hash}',\n      {\n        path: { hash },\n      },\n      { signal },\n    );\n  };\n\n  const createVariable = async (body: CreateVariableBody, signal?: AbortSignal) => {\n    if (body.flags.includes('encrypted') && !body.value.startsWith(ENCRYPTED_VALUE_PREFIX)) {\n      throw new UserError('Encryption of a value failed. Please contact our support.');\n    }\n    const { data } = await client.post('/variables', { body }, { signal });\n    return data;\n  };\n\n  const getVariablesByBranchId = async (\n    branchId: GetVariablesByBranchId['branchId'],\n    signal?: AbortSignal,\n  ) => {\n    const { data } = await client.get(\n      '/variables/scoped/branch/{branchId}',\n      {\n        path: { branchId },\n      },\n      { signal },\n    );\n    return data as VariableWithHash[];\n  };\n\n  const getProjectWideVariables = (signal?: AbortSignal) => getVariablesByBranchId('null', signal);\n\n  const healthCheck = async (signal?: AbortSignal) => {\n    const { data } = await genericClient.get('/health-check', {}, { signal });\n\n    return data;\n  };\n\n  return {\n    healthCheck,\n    createVariable,\n    deleteVariable,\n    getProjectWideVariables,\n    getVariables,\n    getVariablesByBranchId,\n  };\n};\n"],"mappings":";;;;;;;AAeA,MAAa,qBAAqB,EAAE,SAAS,aAAa,WAA8B;CACtF,MAAM,SAASA,iCAAAA,yBAAgC;EAC7C;EACA;EACA,SAASC,aAAAA,kBAAkB,IAAI;CACjC,CAAC;CACD,MAAM,gBAAgBC,iCAAAA,yBAAyB;EAAE;EAAS;CAAY,CAAC;CAEvE,MAAM,eAAe,OAAO,OAA0B,WAAyB;EAC7E,MAAM,EAAE,SAAS,MAAM,OAAO,IAC5B,cACA,EAAE,MAAM,GACR,EACE,OACF,CACF;EAEA,OAAO;CACT;CAEA,MAAM,iBAAiB,OAAO,MAAkC,WAAyB;EACvF,MAAM,OAAO,OACX,qBACA,EACE,MAAM,EAAE,KAAK,EACf,GACA,EAAE,OAAO,CACX;CACF;CAEA,MAAM,iBAAiB,OAAO,MAA0B,WAAyB;EAC/E,IAAI,KAAK,MAAM,SAAS,WAAW,KAAK,CAAC,KAAK,MAAM,WAAA,OAAiC,GACnF,MAAM,IAAIC,kBAAAA,UAAU,2DAA2D;EAEjF,MAAM,EAAE,SAAS,MAAM,OAAO,KAAK,cAAc,EAAE,KAAK,GAAG,EAAE,OAAO,CAAC;EACrE,OAAO;CACT;CAEA,MAAM,yBAAyB,OAC7B,UACA,WACG;EACH,MAAM,EAAE,SAAS,MAAM,OAAO,IAC5B,uCACA,EACE,MAAM,EAAE,SAAS,EACnB,GACA,EAAE,OAAO,CACX;EACA,OAAO;CACT;CAEA,MAAM,2BAA2B,WAAyB,uBAAuB,QAAQ,MAAM;CAE/F,MAAM,cAAc,OAAO,WAAyB;EAClD,MAAM,EAAE,SAAS,MAAM,cAAc,IAAI,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC;EAExE,OAAO;CACT;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}
+{"version":3,"file":"index.cjs","names":["createOpenapiFetchClient","createAuthHeaders","createGenericFetchClient","UserError","collect"],"sources":["../../src/clients/vault/vaultClient.ts"],"sourcesContent":["import { UserError } from '../../errors';\nimport { createGenericFetchClient, createOpenapiFetchClient } from '../../fetchClient';\nimport { ENCRYPTED_VALUE_PREFIX } from '../../internal';\nimport { collect } from '../../utils';\nimport { createAuthHeaders } from '../auth';\nimport type { ClientInitOptions } from '../types';\n\nimport type { paths } from './__generated__/schema';\nimport type {\n  CreateVariableBody,\n  DeleteVariablePath,\n  GetVariablesByBranchId,\n  GetVariablesQuery,\n  VariableWithHash,\n} from './types';\n\n/** The vault's maximum `limit` on `GET /variables`. */\nconst VARIABLES_PAGE_SIZE = 100;\n\nexport const createVaultClient = ({ baseUrl, middlewares, auth }: ClientInitOptions) => {\n  const client = createOpenapiFetchClient<paths>({\n    baseUrl,\n    middlewares,\n    headers: createAuthHeaders(auth),\n  });\n  const genericClient = createGenericFetchClient({ baseUrl, middlewares });\n\n  const getVariables = async (query: GetVariablesQuery, signal?: AbortSignal) => {\n    const { data } = await client.get(\n      '/variables',\n      { query },\n      {\n        signal,\n      },\n    );\n\n    return data as VariableWithHash[];\n  };\n\n  const deleteVariable = async (hash: DeleteVariablePath['hash'], signal?: AbortSignal) => {\n    await client.delete(\n      '/variables/{hash}',\n      {\n        path: { hash },\n      },\n      { signal },\n    );\n  };\n\n  const createVariable = async (body: CreateVariableBody, signal?: AbortSignal) => {\n    if (body.flags.includes('encrypted') && !body.value.startsWith(ENCRYPTED_VALUE_PREFIX)) {\n      throw new UserError('Encryption of a value failed. Please contact our support.');\n    }\n    const { data } = await client.post('/variables', { body }, { signal });\n    return data;\n  };\n\n  /**\n   * Every variable of exactly one scope, across all pages.\n   *\n   * - `null` is the project-wide scope: variables with no `branchId`.\n   * - A branch id returns that branch's variables only — project-wide ones are not merged in.\n   */\n  const getVariablesInScope = (branchId: string | null, signal?: AbortSignal) =>\n    collect({\n      pageSize: VARIABLES_PAGE_SIZE,\n      signal,\n      fetchFrom: (offset, limit, pageSignal) =>\n        getVariables({ attributes: { branchId: branchId ?? '' }, offset, limit }, pageSignal),\n    });\n\n  /**\n   * What `vault.<key>` resolves to in a branch: its variables plus the project-wide ones.\n   *\n   * - One variable per key — a branch variable hides a project-wide one with the same key.\n   * - Unpaginated: the vault returns at most 100 of each half.\n   */\n  const getVariablesByBranchId = async (\n    branchId: GetVariablesByBranchId['branchId'],\n    signal?: AbortSignal,\n  ) => {\n    const { data } = await client.get(\n      '/variables/scoped/branch/{branchId}',\n      {\n        path: { branchId },\n      },\n      { signal },\n    );\n    return data as VariableWithHash[];\n  };\n\n  const getProjectWideVariables = (signal?: AbortSignal) => getVariablesInScope(null, signal);\n\n  const healthCheck = async (signal?: AbortSignal) => {\n    const { data } = await genericClient.get('/health-check', {}, { signal });\n\n    return data;\n  };\n\n  return {\n    healthCheck,\n    createVariable,\n    deleteVariable,\n    getProjectWideVariables,\n    getVariables,\n    getVariablesByBranchId,\n    getVariablesInScope,\n  };\n};\n"],"mappings":";;;;;;;;;AAiBA,MAAM,sBAAsB;AAE5B,MAAa,qBAAqB,EAAE,SAAS,aAAa,WAA8B;CACtF,MAAM,SAASA,iCAAAA,yBAAgC;EAC7C;EACA;EACA,SAASC,aAAAA,kBAAkB,IAAI;CACjC,CAAC;CACD,MAAM,gBAAgBC,iCAAAA,yBAAyB;EAAE;EAAS;CAAY,CAAC;CAEvE,MAAM,eAAe,OAAO,OAA0B,WAAyB;EAC7E,MAAM,EAAE,SAAS,MAAM,OAAO,IAC5B,cACA,EAAE,MAAM,GACR,EACE,OACF,CACF;EAEA,OAAO;CACT;CAEA,MAAM,iBAAiB,OAAO,MAAkC,WAAyB;EACvF,MAAM,OAAO,OACX,qBACA,EACE,MAAM,EAAE,KAAK,EACf,GACA,EAAE,OAAO,CACX;CACF;CAEA,MAAM,iBAAiB,OAAO,MAA0B,WAAyB;EAC/E,IAAI,KAAK,MAAM,SAAS,WAAW,KAAK,CAAC,KAAK,MAAM,WAAA,OAAiC,GACnF,MAAM,IAAIC,kBAAAA,UAAU,2DAA2D;EAEjF,MAAM,EAAE,SAAS,MAAM,OAAO,KAAK,cAAc,EAAE,KAAK,GAAG,EAAE,OAAO,CAAC;EACrE,OAAO;CACT;;;;;;;CAQA,MAAM,uBAAuB,UAAyB,WACpDC,gBAAAA,QAAQ;EACN,UAAU;EACV;EACA,YAAY,QAAQ,OAAO,eACzB,aAAa;GAAE,YAAY,EAAE,UAAU,YAAY,GAAG;GAAG;GAAQ;EAAM,GAAG,UAAU;CACxF,CAAC;;;;;;;CAQH,MAAM,yBAAyB,OAC7B,UACA,WACG;EACH,MAAM,EAAE,SAAS,MAAM,OAAO,IAC5B,uCACA,EACE,MAAM,EAAE,SAAS,EACnB,GACA,EAAE,OAAO,CACX;EACA,OAAO;CACT;CAEA,MAAM,2BAA2B,WAAyB,oBAAoB,MAAM,MAAM;CAE1F,MAAM,cAAc,OAAO,WAAyB;EAClD,MAAM,EAAE,SAAS,MAAM,cAAc,IAAI,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC;EAExE,OAAO;CACT;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}

package/dist/vault/index.d.cts

@@ -1,2 +1,2 @@
-import { t as createVaultClient } from "../index-CcMHJcuP.cjs";
+import { t as createVaultClient } from "../index-BHWTa4YN.cjs";
 export { createVaultClient };

package/dist/vault/index.d.ts

@@ -1,2 +1,2 @@
-import { t as createVaultClient } from "../index-D_-4uQF8.js";
+import { t as createVaultClient } from "../index-zyxZVJnd.js";
 export { createVaultClient };

package/dist/vault/index.js

@@ -1,9 +1,12 @@
+import { t as collect } from "../collect-97WhfEpt.js";
 import { t as UserError } from "../UserError-By_Zckmc.js";
-import "../createFetchClient-DXHQK63w.js";
-import { t as createGenericFetchClient } from "../createGenericFetchClient-Dg1rgzmG.js";
-import { t as createOpenapiFetchClient } from "../createOpenapiFetchClient-DZUOVupy.js";
-import { t as createAuthHeaders } from "../auth-DworfoPy.js";
+import "../createFetchClient-cgWkwgAQ.js";
+import { t as createGenericFetchClient } from "../createGenericFetchClient-CX9Hn3Aq.js";
+import { t as createOpenapiFetchClient } from "../createOpenapiFetchClient-BxcLLU_N.js";
+import { t as createAuthHeaders } from "../auth-DUHTJTwS.js";
 //#region src/clients/vault/vaultClient.ts
+/** The vault's maximum `limit` on `GET /variables`. */
+const VARIABLES_PAGE_SIZE = 100;
 const createVaultClient = ({ baseUrl, middlewares, auth }) => {
 	const client = createOpenapiFetchClient({
 		baseUrl,
@@ -26,11 +29,32 @@ const createVaultClient = ({ baseUrl, middlewares, auth }) => {
 		const { data } = await client.post("/variables", { body }, { signal });
 		return data;
 	};
+	/**
+	* Every variable of exactly one scope, across all pages.
+	*
+	* - `null` is the project-wide scope: variables with no `branchId`.
+	* - A branch id returns that branch's variables only — project-wide ones are not merged in.
+	*/
+	const getVariablesInScope = (branchId, signal) => collect({
+		pageSize: VARIABLES_PAGE_SIZE,
+		signal,
+		fetchFrom: (offset, limit, pageSignal) => getVariables({
+			attributes: { branchId: branchId ?? "" },
+			offset,
+			limit
+		}, pageSignal)
+	});
+	/**
+	* What `vault.<key>` resolves to in a branch: its variables plus the project-wide ones.
+	*
+	* - One variable per key — a branch variable hides a project-wide one with the same key.
+	* - Unpaginated: the vault returns at most 100 of each half.
+	*/
 	const getVariablesByBranchId = async (branchId, signal) => {
 		const { data } = await client.get("/variables/scoped/branch/{branchId}", { path: { branchId } }, { signal });
 		return data;
 	};
-	const getProjectWideVariables = (signal) => getVariablesByBranchId("null", signal);
+	const getProjectWideVariables = (signal) => getVariablesInScope(null, signal);
 	const healthCheck = async (signal) => {
 		const { data } = await genericClient.get("/health-check", {}, { signal });
 		return data;
@@ -41,7 +65,8 @@ const createVaultClient = ({ baseUrl, middlewares, auth }) => {
 		deleteVariable,
 		getProjectWideVariables,
 		getVariables,
-		getVariablesByBranchId
+		getVariablesByBranchId,
+		getVariablesInScope
 	};
 };
 //#endregion

package/dist/vault/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/clients/vault/vaultClient.ts"],"sourcesContent":["import { UserError } from '../../errors';\nimport { createGenericFetchClient, createOpenapiFetchClient } from '../../fetchClient';\nimport { ENCRYPTED_VALUE_PREFIX } from '../../internal';\nimport { createAuthHeaders } from '../auth';\nimport type { ClientInitOptions } from '../types';\n\nimport type { paths } from './__generated__/schema';\nimport type {\n  CreateVariableBody,\n  DeleteVariablePath,\n  GetVariablesByBranchId,\n  GetVariablesQuery,\n  VariableWithHash,\n} from './types';\n\nexport const createVaultClient = ({ baseUrl, middlewares, auth }: ClientInitOptions) => {\n  const client = createOpenapiFetchClient<paths>({\n    baseUrl,\n    middlewares,\n    headers: createAuthHeaders(auth),\n  });\n  const genericClient = createGenericFetchClient({ baseUrl, middlewares });\n\n  const getVariables = async (query: GetVariablesQuery, signal?: AbortSignal) => {\n    const { data } = await client.get(\n      '/variables',\n      { query },\n      {\n        signal,\n      },\n    );\n\n    return data as VariableWithHash[];\n  };\n\n  const deleteVariable = async (hash: DeleteVariablePath['hash'], signal?: AbortSignal) => {\n    await client.delete(\n      '/variables/{hash}',\n      {\n        path: { hash },\n      },\n      { signal },\n    );\n  };\n\n  const createVariable = async (body: CreateVariableBody, signal?: AbortSignal) => {\n    if (body.flags.includes('encrypted') && !body.value.startsWith(ENCRYPTED_VALUE_PREFIX)) {\n      throw new UserError('Encryption of a value failed. Please contact our support.');\n    }\n    const { data } = await client.post('/variables', { body }, { signal });\n    return data;\n  };\n\n  const getVariablesByBranchId = async (\n    branchId: GetVariablesByBranchId['branchId'],\n    signal?: AbortSignal,\n  ) => {\n    const { data } = await client.get(\n      '/variables/scoped/branch/{branchId}',\n      {\n        path: { branchId },\n      },\n      { signal },\n    );\n    return data as VariableWithHash[];\n  };\n\n  const getProjectWideVariables = (signal?: AbortSignal) => getVariablesByBranchId('null', signal);\n\n  const healthCheck = async (signal?: AbortSignal) => {\n    const { data } = await genericClient.get('/health-check', {}, { signal });\n\n    return data;\n  };\n\n  return {\n    healthCheck,\n    createVariable,\n    deleteVariable,\n    getProjectWideVariables,\n    getVariables,\n    getVariablesByBranchId,\n  };\n};\n"],"mappings":";;;;;;AAeA,MAAa,qBAAqB,EAAE,SAAS,aAAa,WAA8B;CACtF,MAAM,SAAS,yBAAgC;EAC7C;EACA;EACA,SAAS,kBAAkB,IAAI;CACjC,CAAC;CACD,MAAM,gBAAgB,yBAAyB;EAAE;EAAS;CAAY,CAAC;CAEvE,MAAM,eAAe,OAAO,OAA0B,WAAyB;EAC7E,MAAM,EAAE,SAAS,MAAM,OAAO,IAC5B,cACA,EAAE,MAAM,GACR,EACE,OACF,CACF;EAEA,OAAO;CACT;CAEA,MAAM,iBAAiB,OAAO,MAAkC,WAAyB;EACvF,MAAM,OAAO,OACX,qBACA,EACE,MAAM,EAAE,KAAK,EACf,GACA,EAAE,OAAO,CACX;CACF;CAEA,MAAM,iBAAiB,OAAO,MAA0B,WAAyB;EAC/E,IAAI,KAAK,MAAM,SAAS,WAAW,KAAK,CAAC,KAAK,MAAM,WAAA,OAAiC,GACnF,MAAM,IAAI,UAAU,2DAA2D;EAEjF,MAAM,EAAE,SAAS,MAAM,OAAO,KAAK,cAAc,EAAE,KAAK,GAAG,EAAE,OAAO,CAAC;EACrE,OAAO;CACT;CAEA,MAAM,yBAAyB,OAC7B,UACA,WACG;EACH,MAAM,EAAE,SAAS,MAAM,OAAO,IAC5B,uCACA,EACE,MAAM,EAAE,SAAS,EACnB,GACA,EAAE,OAAO,CACX;EACA,OAAO;CACT;CAEA,MAAM,2BAA2B,WAAyB,uBAAuB,QAAQ,MAAM;CAE/F,MAAM,cAAc,OAAO,WAAyB;EAClD,MAAM,EAAE,SAAS,MAAM,cAAc,IAAI,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC;EAExE,OAAO;CACT;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/clients/vault/vaultClient.ts"],"sourcesContent":["import { UserError } from '../../errors';\nimport { createGenericFetchClient, createOpenapiFetchClient } from '../../fetchClient';\nimport { ENCRYPTED_VALUE_PREFIX } from '../../internal';\nimport { collect } from '../../utils';\nimport { createAuthHeaders } from '../auth';\nimport type { ClientInitOptions } from '../types';\n\nimport type { paths } from './__generated__/schema';\nimport type {\n  CreateVariableBody,\n  DeleteVariablePath,\n  GetVariablesByBranchId,\n  GetVariablesQuery,\n  VariableWithHash,\n} from './types';\n\n/** The vault's maximum `limit` on `GET /variables`. */\nconst VARIABLES_PAGE_SIZE = 100;\n\nexport const createVaultClient = ({ baseUrl, middlewares, auth }: ClientInitOptions) => {\n  const client = createOpenapiFetchClient<paths>({\n    baseUrl,\n    middlewares,\n    headers: createAuthHeaders(auth),\n  });\n  const genericClient = createGenericFetchClient({ baseUrl, middlewares });\n\n  const getVariables = async (query: GetVariablesQuery, signal?: AbortSignal) => {\n    const { data } = await client.get(\n      '/variables',\n      { query },\n      {\n        signal,\n      },\n    );\n\n    return data as VariableWithHash[];\n  };\n\n  const deleteVariable = async (hash: DeleteVariablePath['hash'], signal?: AbortSignal) => {\n    await client.delete(\n      '/variables/{hash}',\n      {\n        path: { hash },\n      },\n      { signal },\n    );\n  };\n\n  const createVariable = async (body: CreateVariableBody, signal?: AbortSignal) => {\n    if (body.flags.includes('encrypted') && !body.value.startsWith(ENCRYPTED_VALUE_PREFIX)) {\n      throw new UserError('Encryption of a value failed. Please contact our support.');\n    }\n    const { data } = await client.post('/variables', { body }, { signal });\n    return data;\n  };\n\n  /**\n   * Every variable of exactly one scope, across all pages.\n   *\n   * - `null` is the project-wide scope: variables with no `branchId`.\n   * - A branch id returns that branch's variables only — project-wide ones are not merged in.\n   */\n  const getVariablesInScope = (branchId: string | null, signal?: AbortSignal) =>\n    collect({\n      pageSize: VARIABLES_PAGE_SIZE,\n      signal,\n      fetchFrom: (offset, limit, pageSignal) =>\n        getVariables({ attributes: { branchId: branchId ?? '' }, offset, limit }, pageSignal),\n    });\n\n  /**\n   * What `vault.<key>` resolves to in a branch: its variables plus the project-wide ones.\n   *\n   * - One variable per key — a branch variable hides a project-wide one with the same key.\n   * - Unpaginated: the vault returns at most 100 of each half.\n   */\n  const getVariablesByBranchId = async (\n    branchId: GetVariablesByBranchId['branchId'],\n    signal?: AbortSignal,\n  ) => {\n    const { data } = await client.get(\n      '/variables/scoped/branch/{branchId}',\n      {\n        path: { branchId },\n      },\n      { signal },\n    );\n    return data as VariableWithHash[];\n  };\n\n  const getProjectWideVariables = (signal?: AbortSignal) => getVariablesInScope(null, signal);\n\n  const healthCheck = async (signal?: AbortSignal) => {\n    const { data } = await genericClient.get('/health-check', {}, { signal });\n\n    return data;\n  };\n\n  return {\n    healthCheck,\n    createVariable,\n    deleteVariable,\n    getProjectWideVariables,\n    getVariables,\n    getVariablesByBranchId,\n    getVariablesInScope,\n  };\n};\n"],"mappings":";;;;;;;;AAiBA,MAAM,sBAAsB;AAE5B,MAAa,qBAAqB,EAAE,SAAS,aAAa,WAA8B;CACtF,MAAM,SAAS,yBAAgC;EAC7C;EACA;EACA,SAAS,kBAAkB,IAAI;CACjC,CAAC;CACD,MAAM,gBAAgB,yBAAyB;EAAE;EAAS;CAAY,CAAC;CAEvE,MAAM,eAAe,OAAO,OAA0B,WAAyB;EAC7E,MAAM,EAAE,SAAS,MAAM,OAAO,IAC5B,cACA,EAAE,MAAM,GACR,EACE,OACF,CACF;EAEA,OAAO;CACT;CAEA,MAAM,iBAAiB,OAAO,MAAkC,WAAyB;EACvF,MAAM,OAAO,OACX,qBACA,EACE,MAAM,EAAE,KAAK,EACf,GACA,EAAE,OAAO,CACX;CACF;CAEA,MAAM,iBAAiB,OAAO,MAA0B,WAAyB;EAC/E,IAAI,KAAK,MAAM,SAAS,WAAW,KAAK,CAAC,KAAK,MAAM,WAAA,OAAiC,GACnF,MAAM,IAAI,UAAU,2DAA2D;EAEjF,MAAM,EAAE,SAAS,MAAM,OAAO,KAAK,cAAc,EAAE,KAAK,GAAG,EAAE,OAAO,CAAC;EACrE,OAAO;CACT;;;;;;;CAQA,MAAM,uBAAuB,UAAyB,WACpD,QAAQ;EACN,UAAU;EACV;EACA,YAAY,QAAQ,OAAO,eACzB,aAAa;GAAE,YAAY,EAAE,UAAU,YAAY,GAAG;GAAG;GAAQ;EAAM,GAAG,UAAU;CACxF,CAAC;;;;;;;CAQH,MAAM,yBAAyB,OAC7B,UACA,WACG;EACH,MAAM,EAAE,SAAS,MAAM,OAAO,IAC5B,uCACA,EACE,MAAM,EAAE,SAAS,EACnB,GACA,EAAE,OAAO,CACX;EACA,OAAO;CACT;CAEA,MAAM,2BAA2B,WAAyB,oBAAoB,MAAM,MAAM;CAE1F,MAAM,cAAc,OAAO,WAAyB;EAClD,MAAM,EAAE,SAAS,MAAM,cAAc,IAAI,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC;EAExE,OAAO;CACT;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}

package/dist/vault/types.d.cts

@@ -1,2 +1,2 @@
-import { a as GetVariablesQuery, i as GetVariablesByBranchId, n as CreateVariableBody, o as VariableWithHash, r as DeleteVariablePath, t as AnyVariable } from "../types-B61aCifg.cjs";
+import { a as GetVariablesQuery, i as GetVariablesByBranchId, n as CreateVariableBody, o as VariableWithHash, r as DeleteVariablePath, t as AnyVariable } from "../types-D9axmt5o.cjs";
 export { AnyVariable, CreateVariableBody, DeleteVariablePath, GetVariablesByBranchId, GetVariablesQuery, VariableWithHash };

package/dist/vault/types.d.ts

@@ -1,2 +1,2 @@
-import { a as GetVariablesQuery, i as GetVariablesByBranchId, n as CreateVariableBody, o as VariableWithHash, r as DeleteVariablePath, t as AnyVariable } from "../types-CZXPu3gn.js";
+import { a as GetVariablesQuery, i as GetVariablesByBranchId, n as CreateVariableBody, o as VariableWithHash, r as DeleteVariablePath, t as AnyVariable } from "../types-BBUZ9EHs.js";
 export { AnyVariable, CreateVariableBody, DeleteVariablePath, GetVariablesByBranchId, GetVariablesQuery, VariableWithHash };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keboola/api-client",
-  "version": "41.0.0",
+  "version": "43.0.0",
   "description": "TypeScript SDK for Keboola APIs",
   "license": "MIT",
   "type": "module",
@@ -972,6 +972,10 @@
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",
+    "@keboola/eslint-plugin-design": "^0.5.0",
+    "@keboola/oxlint-config": "^10.2.0",
+    "@keboola/tsconfig": "^0.2.1",
+    "@keboola/vitest-config": "^1.0.0",
     "@types/node": "24.12.0",
     "@types/qs": "^6",
     "@typescript/native": "npm:typescript@^7.0.2",
@@ -984,11 +988,7 @@
     "typescript": "npm:@typescript/typescript6@^6.0.2",
     "vite": "^8.3.0",
     "vitest": "^5.0.1",
-    "yaml": "^2.8.3",
-    "@keboola/eslint-plugin-design": "^0.5.0",
-    "@keboola/oxlint-config": "^10.2.0",
-    "@keboola/tsconfig": "^0.2.1",
-    "@keboola/vitest-config": "^1.0.0"
+    "yaml": "^2.8.3"
   },
   "scripts": {
     "gen:types": "node scripts/gen-types.mjs",
@@ -1005,7 +1005,7 @@
     "transit": "pnpm build",
     "build": "tsdown",
     "build:check": "node ../../tooling/check-dist-exports.mjs && attw --pack .",
-    "test": "vitest run --passWithNoTests --reporter=dot",
+    "test": "vitest run --reporter=dot",
     "test:integration": "vitest run --config vitest.integration.config.ts"
   }
 }

package/surface/auth.md

@@ -24,6 +24,13 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `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 | undefined; expiresAt?: string | null | undefined; lastUsedAt?: string | null | undefined; }[]; sessionTokens: { id: number; description: string; type: string; scopes: string[]; isSessionToken: boolean; isExpired: boolean; isDisabled: boolean; createdAt?: string | null | undefined; expiresAt?: string | null | undefined; lastUsedAt?: string | null | undefined; }[]; }>`
 - `api.auth.manageTokens.revoke(id: number, signal?: AbortSignal | undefined): Promise<void>`
 
+### `api.auth.me`
+
+- `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; }; }>`
+- `api.auth.me.getMaintainers(query?: { limit?: number | undefined; offset?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ count: number; items: Record<string, never>[]; limit: number; offset: number; hasMore: boolean; } & { items?: { id: number; name: string | null; }[] | undefined; }>`
+- `api.auth.me.getOrganizations(query?: { limit?: number | undefined; offset?: number | undefined; maintainerId?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ count: number; items: Record<string, never>[]; limit: number; offset: number; hasMore: boolean; } & { items?: { id: number; name: string; mfaRequired: boolean; maintainer: { id: number; name: string | null; }; isAdmin: boolean; hasAccess: boolean; canLeave: boolean; projectsCount: number; }[] | undefined; }>`
+- `api.auth.me.getProjects(query?: { limit?: number | undefined; offset?: number | undefined; organizationId?: number | undefined; q?: string | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ count: number; items: Record<string, never>[]; limit: number; offset: number; hasMore: boolean; } & { items?: { id: number; name: string; organizationId: number; role: string | null; isDisabled: boolean; disabledReason: string | null; }[] | undefined; }>`
+
 ### `api.auth.mfa`
 
 - `api.auth.mfa.regenerateRecoveryCodes(signal?: AbortSignal | undefined): Promise<{ codes: string[]; }>`

package/surface/dataScience.md

@@ -11,8 +11,8 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.dataScience.getAppLogsDownload(id: string, signal?: AbortSignal | undefined): Promise<{ logs: string; fileName: string; }>`
 - `api.dataScience.getAppLogsTail(id: string, { query, signal }?: { query?: { since?: string | undefined; lines?: number | undefined; } | undefined; signal?: AbortSignal | undefined; }): Promise<{ entries: LogEntry[]; nextLogTimestamp: string | null; }>`
 - `api.dataScience.getAppPassword(appId: string, signal?: AbortSignal | undefined): Promise<{ password?: string | undefined; }>`
-- `api.dataScience.getAppRun(appId: string, runId: string, signal?: AbortSignal | undefined): Promise<{ state: "failed" | "starting" | "running" | "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; configVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode: "dev" | "prod"; }>`
-- `api.dataScience.getAppRuns(appId: string, query?: { offset?: number | undefined; limit?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ state: "failed" | "starting" | "running" | "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; configVersion?: string | null | undefined; failureReason?: { reason?: string | null | undefined; message?: string | null | undefined; } | null | undefined; mode: "dev" | "prod"; }[]>`
+- `api.dataScience.getAppRun(appId: string, runId: string, signal?: AbortSignal | undefined): Promise<{ state: "failed" | "starting" | "running" | "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"; }>`
+- `api.dataScience.getAppRuns(appId: string, query?: { offset?: number | undefined; limit?: number | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ state: "failed" | "starting" | "running" | "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"; }[]>`
 - `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; }[]>`
 - `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; }[]>`
 - `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

@@ -7,11 +7,12 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `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>`
 - `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>`
 - `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; }>`
+- `api.kaiAgent.deleteUserMemory(memoryId: string, signal?: AbortSignal | undefined): Promise<void>`
 - `api.kaiAgent.downloadSandboxFile(chatId: string, path: string, signal?: AbortSignal | undefined): Promise<Blob>`
 - `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; }>`
-- `api.kaiAgent.getArtifact(artifactId: string, signal?: AbortSignal | undefined): Promise<{ id: string; chatId: string; messageId: string; kind: "chart" | "table" | "document"; title: string; summary: string | null; spec: { [key: string]: unknown; }; recipe: { [key: string]: unknown; }; createdAt: string; }>`
-- `api.kaiAgent.getArtifacts(chatId: string, signal?: AbortSignal | undefined): Promise<{ id: string; chatId: string; messageId: string; kind: "chart" | "table" | "document"; title: string; summary: string | null; spec: { [key: string]: unknown; }; recipe: { [key: string]: unknown; }; createdAt: string; }[]>`
-- `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; requestContext?: { path?: string | undefined; sqlEditorActive?: boolean | undefined; } | undefined; } | undefined; status?: "pending" | "completed" | "failed" | "interrupted" | undefined; }[]; }>`
+- `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; }>`
+- `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; }[]>`
+- `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" | "completed" | "failed" | "interrupted" | undefined; }[]; }>`
 - `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; }>`
 - `api.kaiAgent.getSandboxGitBranch(chatId: string, signal?: AbortSignal | undefined): Promise<{ branch: string | null; }>`
 - `api.kaiAgent.getSkillsList(signal?: AbortSignal | undefined): Promise<{ skills: { name: string; description: string | null; source: "first-party" | "vendored" | "project"; }[]; commands: { name: string; description: string; }[]; }>`
@@ -20,6 +21,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.kaiAgent.getToolsList(signal?: AbortSignal | undefined): Promise<{ tools: { name: string; description: string; readOnly: boolean; }[]; }>`
 - `api.kaiAgent.getUsage(signal?: AbortSignal | undefined): Promise<UsageResponse>`
 - `api.kaiAgent.getUserAgentSettings(signal?: AbortSignal | undefined): Promise<{ projectId: string; userId: string; customInstructions: string | null; toolPermissions: Record<string, "blocked" | "always_ask" | "always_allow"> | null; createdAt: string; updatedAt: string; projectToolPermissions?: Record<string, ProjectToolPolicyValue> | null | undefined; }>`
+- `api.kaiAgent.getUserMemories(signal?: AbortSignal | undefined): Promise<{ id: string; content: string; createdAt: string; }[]>`
 - `api.kaiAgent.getVotes(chatId: string): Promise<{ chatId: string; messageId: string; isUpvoted: boolean; }[]>`
 - `api.kaiAgent.healthCheck(signal?: AbortSignal | undefined): Promise<unknown>`
 - `api.kaiAgent.listSandboxFiles(chatId: string, path?: string | undefined, signal?: AbortSignal | undefined): Promise<{ entries: { name: string; path: string; type: "file" | "dir"; size?: number | undefined; }[]; }>`

package/surface/management.md

@@ -34,8 +34,9 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 
 ### `api.management.deletedProjects`
 
-- `api.management.deletedProjects.getDeletedProject(projectId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; type: string; region: string; created?: string | null | undefined; expires?: string | null | undefined; 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 | undefined; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; fileStorageProvider?: string | null | undefined; payAsYouGo?: { purchasedCredits?: number | undefined; } | null | undefined; disabled?: { reason?: string | undefined; estimatedEndTime?: string | null | undefined; } | null | undefined; isPurged: boolean; isDeleted: boolean; deletedTime: string; purgedTime?: string | null | undefined; backends: { snowflake?: { id: number; } | undefined; synapse?: { id: number; } | undefined; exasol?: { id: number; } | undefined; teradata?: { id: number; } | undefined; bigquery?: { id: number; } | undefined; }; organization: { id?: number | undefined; name?: string | undefined; created?: string | undefined; allowAutoJoin?: boolean | undefined; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired?: boolean | undefined; }; }>`
-- `api.management.deletedProjects.getDeletedProjects(query?: { limit?: number | null | undefined; offset?: number | null | undefined; organizationId?: number | null | undefined; name?: string | null | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; type: string; region: string; created?: string | null | undefined; expires?: string | null | undefined; 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 | undefined; dataRetentionTimeInDays: number; isBYODB: boolean; assignedBackends: string[]; fileStorageProvider?: string | null | undefined; payAsYouGo?: { purchasedCredits?: number | undefined; } | null | undefined; disabled?: { reason?: string | undefined; estimatedEndTime?: string | null | undefined; } | null | undefined; isPurged: boolean; isDeleted: boolean; deletedTime: string; purgedTime?: string | null | undefined; backends: { snowflake?: { id: number; } | undefined; synapse?: { id: number; } | undefined; exasol?: { id: number; } | undefined; teradata?: { id: number; } | undefined; bigquery?: { id: number; } | undefined; }; organization: { id?: number | undefined; name?: string | undefined; created?: string | undefined; allowAutoJoin?: boolean | undefined; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired?: boolean | undefined; }; }[]>`
+- `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 | null | undefined; payAsYouGo?: { purchasedCredits?: number | undefined; } | null | undefined; disabled?: { reason?: string | undefined; estimatedEndTime?: string | null | undefined; } | 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 | undefined; name?: string | undefined; created?: string | undefined; allowAutoJoin?: boolean | undefined; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired?: boolean | undefined; }; }>`
+- `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 | null | undefined; payAsYouGo?: { purchasedCredits?: number | undefined; } | null | undefined; disabled?: { reason?: string | undefined; estimatedEndTime?: string | null | undefined; } | 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 | undefined; name?: string | undefined; created?: string | undefined; allowAutoJoin?: boolean | undefined; crmId?: string | null | undefined; activityCenterProjectId?: number | null | undefined; mfaRequired?: boolean | undefined; }; }[]; 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; }; }>`
+- `api.management.deletedProjects.getDeletedProjectsStats(signal?: AbortSignal | undefined): Promise<{ deleted: number; purged: number; overdue: number; }>`
 - `api.management.deletedProjects.purgeDeletedProject(projectId: number, ignoreBackendErrors?: boolean): Promise<{ commandExecutionId: string; }>`
 - `api.management.deletedProjects.restoreDeletedProject(projectId: number): Promise<void>`
 
@@ -61,6 +62,10 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.management.fileStorage.setFileStorageGcsDefault(fileStorageId: number): Promise<FileStorageGcs>`
 - `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; }; }>`
 
+### `api.management.gcpPartner`
+
+- `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 | undefined; operationName: string; operationParams: { [key: string]: Record<string, never>; }; createdTime: string; startTime?: string | null | undefined; endTime?: string | null | undefined; runId?: string | null | undefined; results?: Record<string, never> | null | undefined; creatorToken: { id?: number | undefined; description?: string | null | undefined; }; metrics: { [key: string]: Record<string, never>; }; error?: { code?: string | null | undefined; message?: string | null | undefined; exceptionId?: string | null | undefined; } | null | undefined; }>`
+
 ### `api.management.maintainers`
 
 - `api.management.maintainers.addMaintainerUser({ maintainerId, ...body }: AddMaintainerUserInput): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
@@ -76,7 +81,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.management.maintainers.getMaintainer(maintainerId: number, signal?: AbortSignal | undefined): Promise<MaintainerDetail>`
 - `api.management.maintainers.getMaintainerInvitation({ maintainerId, invitationId }: MaintainerInvitationPath, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
 - `api.management.maintainers.getMaintainerInvitations(maintainerId: number, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
-- `api.management.maintainers.getMaintainerMetadata(maintainerId: number, signal?: AbortSignal | undefined): Promise<MetadataItem[]>`
+- `api.management.maintainers.getMaintainerMetadata(maintainerId: number, signal?: AbortSignal | undefined): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
 - `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; }[]>`
 - `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; }>`
 - `api.management.maintainers.getMaintainerSamlConfigs(maintainerId: number, signal?: AbortSignal | undefined): Promise<{ id: number; maintainerId: number; customerSlug: string; name: string; description: string | null; idpEntityId: string; membershipRestriction: "none" | "permittedDomains"; isActive: boolean; createdAt: string; updatedAt: string; }>`
@@ -84,7 +89,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.management.maintainers.getMaintainers(signal?: AbortSignal | undefined): Promise<Maintainer[]>`
 - `api.management.maintainers.joinMaintainer(maintainerId: number): Promise<void>`
 - `api.management.maintainers.removeMaintainerUser({ maintainerId, adminId }: MaintainerUserPath): Promise<void>`
-- `api.management.maintainers.setMaintainerMetadata({ maintainerId, ...body }: SetMaintainerMetadataInput): Promise<MetadataItem[]>`
+- `api.management.maintainers.setMaintainerMetadata({ maintainerId, ...body }: SetMaintainerMetadataInput): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
 - `api.management.maintainers.updateMaintainer({ maintainerId, ...body }: UpdateMaintainerInput): 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; }[]; }>`
 - `api.management.maintainers.updateMaintainerSamlConfig({ maintainerId, configId, ...body }: UpdateSamlConfigInput): Promise<{ id?: number | undefined; maintainerId?: number | undefined; customerSlug?: string | undefined; membershipRestriction?: "none" | "permittedDomains" | undefined; message?: string | undefined; warnings?: { code?: string | undefined; message?: string | undefined; organizationIds?: number[] | undefined; }[] | undefined; }>`
 
@@ -100,25 +105,25 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.management.organizations.getOrganization(organizationId: number, signal?: AbortSignal | undefined): Promise<OrganizationDetail>`
 - `api.management.organizations.getOrganizationInvitation({ organizationId, invitationId }: OrganizationInvitationPath, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
 - `api.management.organizations.getOrganizationInvitations(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
-- `api.management.organizations.getOrganizationMetadata(organizationId: number, signal?: AbortSignal | undefined): Promise<MetadataItem[]>`
+- `api.management.organizations.getOrganizationMetadata(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
 - `api.management.organizations.getOrganizationProjects(organizationId: number, signal?: AbortSignal | undefined): Promise<Project[]>`
 - `api.management.organizations.getOrganizationProjectsUsers(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }[]>`
 - `api.management.organizations.getOrganizationUsers(organizationId: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }[]>`
 - `api.management.organizations.getOrganizations(signal?: AbortSignal | undefined): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string; activityCenterProjectId?: number | null | undefined; mfaRequired: boolean; maintainer: { id?: number | undefined; name?: string | undefined; created?: string | undefined; defaultConnectionMysqlId?: number | null | undefined; defaultConnectionSnowflakeId?: number | null | undefined; defaultConnectionSynapseId?: number | null | undefined; defaultConnectionExasolId?: number | null | undefined; defaultConnectionBigqueryId?: number | null | undefined; defaultConnectionTeradataId?: number | null | undefined; defaultFileStorageId?: number | null | undefined; zendeskUrl?: string | null | undefined; }; }[]>`
 - `api.management.organizations.joinOrganization(organizationId: number): Promise<void>`
 - `api.management.organizations.removeOrganizationUser({ organizationId, userId }: OrganizationUserPath): Promise<void>`
-- `api.management.organizations.setOrganizationMetadata({ organizationId, ...body }: SetOrganizationMetadataInput): Promise<MetadataItem[]>`
+- `api.management.organizations.setOrganizationMetadata({ organizationId, ...body }: SetOrganizationMetadataInput): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
 - `api.management.organizations.updateOrganization({ organizationId, ...body }: UpdateOrganizationInput): Promise<{ id: number; name: string; created: string; allowAutoJoin: boolean; crmId: string | null; activityCenterProjectId: number | null; mfaRequired: boolean; }>`
 
 ### `api.management.payAsYouGo`
 
-- `api.management.payAsYouGo.createPaymentRequest(body: { idProject: number; amount: number; saveCard?: boolean | null | undefined; }): Promise<CreditPaymentRequest>`
+- `api.management.payAsYouGo.createPaymentRequest(body: { idProject: number; amount: number; saveCard?: boolean | null | undefined; } & { _token?: string | undefined; }): Promise<CreditPaymentRequest>`
 - `api.management.payAsYouGo.getBillingConfiguration(signal?: AbortSignal | undefined): Promise<PayAsYouGoBillingConfiguration>`
 - `api.management.payAsYouGo.getCreditPurchases(idProject: number, signal?: AbortSignal | undefined): Promise<CreditPurchase[]>`
 - `api.management.payAsYouGo.getStripeCustomer(idProject: number, signal?: AbortSignal | undefined): Promise<{ email: string | null; name: string | null; address?: { line1?: string | null | undefined; line2?: string | null | undefined; city?: string | null | undefined; state?: string | null | undefined; postal_code?: string | null | undefined; country?: string | null | undefined; } | undefined; vat_id?: string | undefined; cards: { id: string; brand: string; exp_month: number; exp_year: number; last4: string; funding: string; }[]; } | null>`
 - `api.management.payAsYouGo.getTopUpSetting(projectId: number, signal?: AbortSignal | undefined): Promise<TopUpSetting>`
-- `api.management.payAsYouGo.updateStripeCustomer(body: { idProject: number; email?: string | null | undefined; name?: string | null | undefined; vatId?: string | null | undefined; addressLine1?: string | null | undefined; addressLine2?: string | null | undefined; addressCity?: string | null | undefined; addressState?: string | null | undefined; addressPostalCode?: string | null | undefined; addressCountry?: string | null | undefined; dropCardId?: string | null | undefined; }): Promise<{ email: string | null; name: string | null; address?: { line1?: string | null | undefined; line2?: string | null | undefined; city?: string | null | undefined; state?: string | null | undefined; postal_code?: string | null | undefined; country?: string | null | undefined; } | undefined; vat_id?: string | undefined; cards: { id: string; brand: string; exp_month: number; exp_year: number; last4: string; funding: string; }[]; }>`
-- `api.management.payAsYouGo.updateTopUpSetting(body: { idProject: number; amount: number; limit: number; enabled: boolean; }): Promise<void>`
+- `api.management.payAsYouGo.updateStripeCustomer(body: { idProject: number; email?: string | null | undefined; name?: string | null | undefined; vatId?: string | null | undefined; addressLine1?: string | null | undefined; addressLine2?: string | null | undefined; addressCity?: string | null | undefined; addressState?: string | null | undefined; addressPostalCode?: string | null | undefined; addressCountry?: string | null | undefined; dropCardId?: string | null | undefined; } & { _token?: string | undefined; }): Promise<{ email: string | null; name: string | null; address?: { line1?: string | null | undefined; line2?: string | null | undefined; city?: string | null | undefined; state?: string | null | undefined; postal_code?: string | null | undefined; country?: string | null | undefined; } | undefined; vat_id?: string | undefined; cards: { id: string; brand: string; exp_month: number; exp_year: number; last4: string; funding: string; }[]; }>`
+- `api.management.payAsYouGo.updateTopUpSetting(body: { idProject: number; amount: number; limit: number; enabled: boolean; } & { _token?: string | undefined; }): Promise<void>`
 
 ### `api.management.programmaticProjects`
 
@@ -140,7 +145,7 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.management.projects.getProjectInvitations(projectId: string | number, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; expires?: string | null | undefined; reason?: string | null | undefined; role?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; creator: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
 - `api.management.projects.getProjectJoinRequest({ projectId, joinRequestId }: ProjectJoinRequestPath, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; expires?: string | null | undefined; reason?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
 - `api.management.projects.getProjectJoinRequests(projectId: string | number, signal?: AbortSignal | undefined): Promise<{ id: number; created?: string | null | undefined; expires?: string | null | undefined; reason?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }[]>`
-- `api.management.projects.getProjectMetadata(projectId: number, signal?: AbortSignal | undefined): Promise<ProjectMetadataItem[]>`
+- `api.management.projects.getProjectMetadata(projectId: number, signal?: AbortSignal | undefined): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
 - `api.management.projects.getProjectReviewers(projectId: number, signal?: AbortSignal | undefined): Promise<Reviewer[]>`
 - `api.management.projects.getProjectTemplate(templateId: string, signal?: AbortSignal | undefined): Promise<{ id: string; name: string; description: string; expirationDays?: number | null | undefined; billedMonthlyPrice?: number | null | undefined; hasTryModeOn: boolean; defaultBackend: string; }>`
 - `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; }[]>`
@@ -156,10 +161,15 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.management.projects.requestProjectAccess({ projectId, ...body }: RequestProjectAccessInput): Promise<{ id: number; created?: string | null | undefined; expires?: string | null | undefined; reason?: string | null | undefined; user: { id?: number | undefined; name?: string | undefined; email?: string | undefined; }; }>`
 - `api.management.projects.setProjectDisabled({ projectId, ...body }: SetProjectDisabledInput): Promise<ProjectBase>`
 - `api.management.projects.setProjectLimits({ projectId, ...body }: SetProjectLimitsInput): Promise<Project>`
-- `api.management.projects.setProjectMetadata({ projectId, provider, metadata, }: SetProjectMetadataPath & { provider: "user" | "system"; metadata: { key: string; value: string; }[]; }): Promise<ProjectMetadataItem[]>`
+- `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; }[]>`
 - `api.management.projects.setProjectReviewers({ projectId, adminIds, }: SetProjectReviewersPath & SetProjectReviewersBody): Promise<void>`
 - `api.management.projects.updateProject({ projectId, ...body }: UpdateProjectInput): Promise<ProjectBase>`
 
+### `api.management.snowflakePartnerConnect`
+
+- `api.management.snowflakePartnerConnect.check(projectId: number, signal?: AbortSignal | undefined): Promise<{ testPassed: boolean; queriesToRun: string[]; }>`
+- `api.management.snowflakePartnerConnect.unlock(projectId: number, signal?: AbortSignal | undefined): Promise<{ status: "error" | "ok" | "test-failed"; message: string; exceptionId?: string | null | undefined; }>`
+
 ### `api.management.storageBackends`
 
 - `api.management.storageBackends.activateStorageBackend(backendId: number): Promise<{ id: number; backend: string; region: string; owner?: string | null | undefined; technicalOwner: string; technicalOwnerContactEmails: string[]; host?: string | null | undefined; credentials?: Record<string, never> | null | undefined; folderId?: string | null | undefined; useDynamicBackends?: boolean | null | undefined; useNetworkPolicies?: boolean | null | undefined; useSso?: boolean | null | undefined; isSsoEnabled?: boolean | null | undefined; isSsoConfigured?: boolean | null | undefined; isEnabled?: boolean | null | undefined; }>`
@@ -190,12 +200,17 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.management.users.disableUserMfa(id: number, signal?: AbortSignal | undefined): Promise<void>`
 - `api.management.users.getUser(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
 - `api.management.users.getUserMaintainers(id: number, signal?: AbortSignal | undefined): Promise<{ maintainer: { id: number; name: string | null; }; }[]>`
-- `api.management.users.getUserMetadata(id: number, signal?: AbortSignal | undefined): Promise<{ id?: number | undefined; provider?: string | undefined; timestamp?: string | undefined; key?: string | undefined; value?: string | undefined; }[]>`
+- `api.management.users.getUserMetadata(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
 - `api.management.users.getUserOrganizations(id: number, signal?: AbortSignal | undefined): Promise<{ organization: { id: number; name: string; }; created: string | null; invitedBy: { id: number; name: string; email: string; } | null; maintainer: { id: number; name: string | null; }; }[]>`
 - `api.management.users.getUserProjects(id: number, signal?: AbortSignal | undefined): Promise<{ project: { id: number; name: string; }; role: string; status: string; expires: string | null; created: string | null; reason: string; invitedBy: { id: number; name: string; email: string; } | null; }[]>`
 - `api.management.users.getUsers(query?: { q?: string | null | undefined; limit?: number | null | undefined; offset?: number | null | undefined; } | undefined, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; organizationsCount: number; projectsCount: number; maintainersCount: number; }[]>`
 - `api.management.users.grantSuperAdmin(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
 - `api.management.users.removeSuperAdmin(id: number, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
 - `api.management.users.removeUserAdminFeature({ userIdOrMail, feature }: RemoveUserFeaturePath, signal?: AbortSignal | undefined): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
-- `api.management.users.setUserMetadata({ id, ...body }: SetUserMetadataInput): Promise<{ id?: number | undefined; provider?: string | undefined; timestamp?: string | undefined; key?: string | undefined; value?: string | undefined; }[]>`
+- `api.management.users.setUserMetadata({ id, ...body }: SetUserMetadataInput): Promise<{ id: number; provider: string; timestamp: string; key: string; value: string; }[]>`
 - `api.management.users.updateUser({ id, ...body }: UpdateUserInput): Promise<{ id: number; name: string; email: string; mfaEnabled: boolean; features: string[]; canAccessLogs: boolean; isSuperAdmin: boolean; }>`
+
+### `api.management.workspaces`
+
+- `api.management.workspaces.listProjectRetentionWorkspaces(projectId: number, params?: { state?: ProjectRetentionWorkspaceState | undefined; }, signal?: AbortSignal | undefined): Promise<ProjectRetentionWorkspace[]>`
+- `api.management.workspaces.reactivateWorkspace(workspaceId: number, signal?: AbortSignal | undefined): Promise<ReactivateWorkspaceResult>`

package/surface/metastore.md

@@ -14,10 +14,13 @@ Part of the [`@keboola/api-client` surface index](../API-SURFACE.md).
 - `api.metastore.repository.getMetaObject<TData extends Record<string, unknown>>(input: { objectType: string; UUID: string; }, signal?: AbortSignal | undefined): Promise<MetaStoreObjectResponse<TData>>`
 - `api.metastore.repository.getMetaObjectRevision<TData extends Record<string, unknown>>(input: { objectType: string; UUID: string; revision: number; }, signal?: AbortSignal | undefined): Promise<MetaStoreObjectResponse<TData>>`
 - `api.metastore.repository.getMetaObjectRevisions<TData extends Record<string, unknown>>({ query, ...path }: GetMetaObjectRevisionsInput, signal?: AbortSignal | undefined): Promise<MetaStoreListResponse<TData>>`
-- `api.metastore.repository.getMetaObjects<TData extends Record<string, unknown>>({ query, ...path }: GetMetaObjectsInput, signal?: AbortSignal | undefined): Promise<MetaStoreListResponse<TData>>`
+- `api.metastore.repository.getMetaObjects<TData extends Record<string, unknown>>({ objectType, modelUUID, pendingElevationOnly, sortByScope, query }: GetMetaObjectsInput, signal?: AbortSignal | undefined): Promise<MetaStoreListResponse<TData>>`
+- `api.metastore.repository.getPendingScopeElevationRequests<TData extends Record<string, unknown>>(input: { objectType: string; }, signal?: AbortSignal | undefined): Promise<MetaStoreListResponse<TData>>`
 - `api.metastore.repository.replaceMetaObject<TData extends Record<string, unknown>>({ objectType, UUID, data, ...body }: ReplaceMetaObjectInput<TData>): Promise<MetaStoreObjectResponse<TData>>`
 - `api.metastore.repository.replaceTargetProjects({ objectType, UUID, ...body }: ReplaceTargetProjectsInput): Promise<void>`
+- `api.metastore.repository.requestScopeElevation(input: { objectType: string; UUID: string; }): Promise<void>`
 - `api.metastore.repository.updateMetaObject<TData extends Record<string, unknown>>({ objectType, UUID, data, ...body }: UpdateMetaObjectInput<TData>): Promise<MetaStoreObjectResponse<TData>>`
+- `api.metastore.repository.withdrawScopeElevationRequest(input: { objectType: string; UUID: string; }): Promise<void>`
 
 ### `api.metastore.schema`