@keboola/api-client 42.0.0 → 43.0.0

package/dist/{types-n4PTnLii.d.ts → types-AYX7VtS6.d.ts}

@@ -352,6 +352,26 @@ type paths = {
             };
           };
         };
+        /** @description Request body exceeds `CHAT_BODY_LIMIT_BYTES`. A question carries its attachments inside this JSON as base64, so the raw-file ceiling is roughly three quarters of it. Answered before auth runs, so an unauthenticated caller sees this rather than a 401. */
+        413: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': {
+              error: {
+                /** @enum {string} */
+                type: 'bad_request' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'payload_too_large' | 'rate_limit' | 'offline' | 'bad_response' | 'internal';
+                /** @enum {string} */
+                surface: 'chat' | 'auth' | 'api' | 'stream' | 'database' | 'history' | 'vote' | 'artifact';
+                message: string;
+                /** @enum {string} */
+                subtype?: 'burst' | 'monthly_messages' | 'monthly_credits_user' | 'monthly_credits_project' | 'resolved' | 'timed_out' | 'chat_cancelled' | 'swept' | 'shutdown';
+                exceptionId?: string;
+              };
+            };
+          };
+        };
         /** @description Rate limit exceeded */
         429: {
           headers: {
@@ -992,6 +1012,8 @@ type paths = {
                   createdAt?: string;
                   hidden?: boolean;
                   autoForwarded?: boolean;
+                  /** @enum {string} */
+                  pausedReason?: 'turn-budget';
                   requestContext?: {
                     path?: string;
                     sqlEditorActive?: boolean;
@@ -1844,7 +1866,7 @@ type paths = {
             };
           };
         };
-        /** @description The approval slot existed and is gone. `error.subtype` carries the reason (resolved | timed_out | chat_cancelled | swept | shutdown); the decision is final, so the client must not retry. */
+        /** @description The approval cannot be applied here: the slot existed and is gone, or the pending turn is owned by another process (rolling deploy). `error.subtype` carries the reason (resolved | timed_out | chat_cancelled | swept | shutdown); the decision is final, so the client must not retry. */
         409: {
           headers: {
             [name: string]: unknown;
@@ -2604,6 +2626,11 @@ type paths = {
               /** @enum {string|null} */
               ppuLimitScope: 'user' | 'project' | null;
               projectPpuPercentage: number | null;
+              /** @description The organization's one-time free Kai allowance in PPU — shared by every project and user in the organization, non-expiring, granted once and never refilled. NOT the monthly spend cap (`ppuLimit`/`projectPpuPercentage` above), and clients must not blend the two. `null` when the organization has no allowance at all (created before the rollout boundary, or no billing account resolved); clients hide the allowance UI for null. `remainingPpu` is clamped at zero. */
+              freeAllowance: {
+                grantedPpu: number;
+                remainingPpu: number;
+              } | null;
               /** Format: date-time */
               resetDate: string;
             };
@@ -2708,6 +2735,10 @@ type paths = {
             'application/json': {
               projectId: string;
               customInstructions: string | null;
+              toolPermissions: {
+                [key: string]: 'always_ask' | 'blocked';
+              } | null;
+              canWriteToolPolicy: boolean;
               createdAt: string;
               updatedAt: string;
             };
@@ -2788,6 +2819,10 @@ type paths = {
             'application/json': {
               projectId: string;
               customInstructions: string | null;
+              toolPermissions: {
+                [key: string]: 'always_ask' | 'blocked';
+              } | null;
+              canWriteToolPolicy: boolean;
               createdAt: string;
               updatedAt: string;
             };
@@ -2877,6 +2912,142 @@ type paths = {
     };
     trace?: never;
   };
+  '/api/settings/tool-permissions': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    /**
+     * Replace the project Kai tool policy
+     * @description Organization-admin only. Replaces the project-level Kai tool policy.
+     */
+    put: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: {
+        content: {
+          'application/json': {
+            toolPermissions: {
+              [key: string]: 'always_ask' | 'blocked';
+            };
+          };
+        };
+      };
+      responses: {
+        /** @description Updated project tool policy */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': {
+              projectId: string;
+              customInstructions: string | null;
+              toolPermissions: {
+                [key: string]: 'always_ask' | 'blocked';
+              } | null;
+              canWriteToolPolicy: boolean;
+              createdAt: string;
+              updatedAt: string;
+            };
+          };
+        };
+        /** @description Bad request */
+        400: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': {
+              error: {
+                /** @enum {string} */
+                type: 'bad_request' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'payload_too_large' | 'rate_limit' | 'offline' | 'bad_response' | 'internal';
+                /** @enum {string} */
+                surface: 'chat' | 'auth' | 'api' | 'stream' | 'database' | 'history' | 'vote' | 'artifact';
+                message: string;
+                /** @enum {string} */
+                subtype?: 'burst' | 'monthly_messages' | 'monthly_credits_user' | 'monthly_credits_project' | 'resolved' | 'timed_out' | 'chat_cancelled' | 'swept' | 'shutdown';
+                exceptionId?: string;
+              };
+            };
+          };
+        };
+        /** @description Unauthorized */
+        401: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': {
+              error: {
+                /** @enum {string} */
+                type: 'bad_request' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'payload_too_large' | 'rate_limit' | 'offline' | 'bad_response' | 'internal';
+                /** @enum {string} */
+                surface: 'chat' | 'auth' | 'api' | 'stream' | 'database' | 'history' | 'vote' | 'artifact';
+                message: string;
+                /** @enum {string} */
+                subtype?: 'burst' | 'monthly_messages' | 'monthly_credits_user' | 'monthly_credits_project' | 'resolved' | 'timed_out' | 'chat_cancelled' | 'swept' | 'shutdown';
+                exceptionId?: string;
+              };
+            };
+          };
+        };
+        /** @description Forbidden — only an organization admin may write the project tool policy */
+        403: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': {
+              error: {
+                /** @enum {string} */
+                type: 'bad_request' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'payload_too_large' | 'rate_limit' | 'offline' | 'bad_response' | 'internal';
+                /** @enum {string} */
+                surface: 'chat' | 'auth' | 'api' | 'stream' | 'database' | 'history' | 'vote' | 'artifact';
+                message: string;
+                /** @enum {string} */
+                subtype?: 'burst' | 'monthly_messages' | 'monthly_credits_user' | 'monthly_credits_project' | 'resolved' | 'timed_out' | 'chat_cancelled' | 'swept' | 'shutdown';
+                exceptionId?: string;
+              };
+            };
+          };
+        };
+        /** @description Service unavailable — an upstream dependency is unreachable */
+        503: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': {
+              error: {
+                /** @enum {string} */
+                type: 'bad_request' | 'unauthorized' | 'forbidden' | 'not_found' | 'conflict' | 'payload_too_large' | 'rate_limit' | 'offline' | 'bad_response' | 'internal';
+                /** @enum {string} */
+                surface: 'chat' | 'auth' | 'api' | 'stream' | 'database' | 'history' | 'vote' | 'artifact';
+                message: string;
+                /** @enum {string} */
+                subtype?: 'burst' | 'monthly_messages' | 'monthly_credits_user' | 'monthly_credits_project' | 'resolved' | 'timed_out' | 'chat_cancelled' | 'swept' | 'shutdown';
+                exceptionId?: string;
+              };
+            };
+          };
+        };
+      };
+    };
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   '/api/settings/user': {
     parameters: {
       query?: never;
@@ -2910,6 +3081,9 @@ type paths = {
               toolPermissions: {
                 [key: string]: 'always_allow' | 'always_ask' | 'blocked';
               } | null;
+              projectToolPermissions: {
+                [key: string]: 'always_ask' | 'blocked';
+              } | null;
               createdAt: string;
               updatedAt: string;
             };
@@ -2997,6 +3171,9 @@ type paths = {
               toolPermissions: {
                 [key: string]: 'always_allow' | 'always_ask' | 'blocked';
               } | null;
+              projectToolPermissions: {
+                [key: string]: 'always_ask' | 'blocked';
+              } | null;
               createdAt: string;
               updatedAt: string;
             };
@@ -3945,4 +4122,4 @@ type ArtifactResponse = OpenapiReturnType<paths['/api/artifacts/{id}']['get']>;
 type ArtifactListResponse = OpenapiReturnType<paths['/api/artifacts']['get']>;
 //#endregion
 export { ChatWithMessages as a, GetChatPath as c, PrepareChatRequest as d, UsageResponse as f, ChatRequest as i, GetHistoryQuery as l, ArtifactListResponse as n, GetArtifactPath as o, VoteRequest as p, ArtifactResponse as r, GetArtifactsQuery as s, ApprovalBody as t, GetVotesQuery as u };
-//# sourceMappingURL=types-n4PTnLii.d.ts.map
+//# sourceMappingURL=types-AYX7VtS6.d.ts.map

package/dist/{types-DIiOMV-t.d.ts → types-B3P5yAuI.d.ts}

@@ -752,8 +752,12 @@ type components = {
       startupLogs?: string | null;
       /** @description Runtime size used for this app run (e.g., small, medium, large) */
       runtimeSize?: string | null;
+      /** @description Backend type the app run executed on */
+      runtimeBackendType?: string | null;
       /** @description Configuration version used for this app run */
       configVersion?: string | null;
+      /** @description Version of the image the app run executed */
+      imageVersion?: string | null;
       /** @description User-facing cause of a failed run. Set only when state is "failed". */
       failureReason?: {
         /** @description Short, stable, machine-readable identifier (UI i18n key) */
@@ -2159,4 +2163,4 @@ type PatchDataAppBodyStopped = {
 type PatchDataAppBody = PatchDataAppBodyRunning | PatchDataAppBodyStopped;
 //#endregion
 export { Sandbox as S, PatchDataAppPath as _, DeleteSandboxPath as a, Runtime as b, GetDataAppLogsTailPath as c, GetDataAppPath as d, GetDataAppRunPath as f, PatchDataAppBody as g, GetSandboxPath as h, DeleteDataAppPath as i, GetDataAppLogsTailQuery as l, GetDataAppRunsQuery as m, DataApp as n, GetAppsQuery as o, GetDataAppRunsPath as p, DataAppRun as r, GetDataAppLogsDownloadPath as s, CreateDataAppBody as t, GetDataAppPasswordPath as u, RawAppRun as v, RuntimeImageKey as x, ResetDataAppPasswordPath as y };
-//# sourceMappingURL=types-DIiOMV-t.d.ts.map
+//# sourceMappingURL=types-B3P5yAuI.d.ts.map

package/dist/{types-BLNB882w.d.cts → types-B3i04d_A.d.cts}

@@ -752,8 +752,12 @@ type components = {
       startupLogs?: string | null;
       /** @description Runtime size used for this app run (e.g., small, medium, large) */
       runtimeSize?: string | null;
+      /** @description Backend type the app run executed on */
+      runtimeBackendType?: string | null;
       /** @description Configuration version used for this app run */
       configVersion?: string | null;
+      /** @description Version of the image the app run executed */
+      imageVersion?: string | null;
       /** @description User-facing cause of a failed run. Set only when state is "failed". */
       failureReason?: {
         /** @description Short, stable, machine-readable identifier (UI i18n key) */
@@ -2159,4 +2163,4 @@ type PatchDataAppBodyStopped = {
 type PatchDataAppBody = PatchDataAppBodyRunning | PatchDataAppBodyStopped;
 //#endregion
 export { Sandbox as S, PatchDataAppPath as _, DeleteSandboxPath as a, Runtime as b, GetDataAppLogsTailPath as c, GetDataAppPath as d, GetDataAppRunPath as f, PatchDataAppBody as g, GetSandboxPath as h, DeleteDataAppPath as i, GetDataAppLogsTailQuery as l, GetDataAppRunsQuery as m, DataApp as n, GetAppsQuery as o, GetDataAppRunsPath as p, DataAppRun as r, GetDataAppLogsDownloadPath as s, CreateDataAppBody as t, GetDataAppPasswordPath as u, RawAppRun as v, RuntimeImageKey as x, ResetDataAppPasswordPath as y };
-//# sourceMappingURL=types-BLNB882w.d.cts.map
+//# sourceMappingURL=types-B3i04d_A.d.cts.map

package/dist/{types-CZXPu3gn.d.ts → types-BBUZ9EHs.d.ts}

@@ -150,6 +150,9 @@ type components = {
        *
        *     Attributes are part of the variable identity, so two variables with the same key but different attributes
        *     are considered different.
+       *
+       *     The attribute names `key` and `projectId` are reserved and are rejected with a 422 when creating a
+       *     variable. Existing variables that already contain such attributes are still returned unchanged.
        * @default {}
        */
       attributes: {
@@ -383,4 +386,4 @@ type VariableWithHash = Omit<VariableWithHashRaw, 'hash'> & {
 type AnyVariable = VariableWithHash | CreateVariableBody;
 //#endregion
 export { GetVariablesQuery as a, GetVariablesByBranchId as i, CreateVariableBody as n, VariableWithHash as o, DeleteVariablePath as r, AnyVariable as t };
-//# sourceMappingURL=types-CZXPu3gn.d.ts.map
+//# sourceMappingURL=types-BBUZ9EHs.d.ts.map

package/dist/{types-CP_LBmw3.d.cts → types-BhOUS9j1.d.cts}

@@ -199,6 +199,28 @@ type components = {
       status: 'error';
       context?: Record<string, never>;
     };
+    /** @description Returned when a request payload fails validation. The top-level `error` stays a short human-readable string; `context` lists every failing field exactly once. */
+    ValidationError: {
+      /** @example Request contents is not valid */
+      error: string;
+      /** @example 422 */
+      code: number;
+      exceptionId: string;
+      /** @enum {unknown} */
+      status: 'error';
+      /** @description One entry per payload field that failed mapping or validation, keyed by index ("0", "1", …). Each failing field appears exactly once. */
+      context: {
+        [key: string]: {
+          /**
+           * @description Name of the payload field that failed, as sent by the client — encrypted fields are reported under their `#`-prefixed key (e.g. `#data`).
+           * @example authorizedFor
+           */
+          path: string;
+          /** @example Value '' is not a valid non-empty string. */
+          message: string;
+        };
+      };
+    };
     Consumer: {
       componentId: string;
       friendlyName: string;
@@ -237,13 +259,13 @@ type components = {
         'application/json': components['schemas']['Error'];
       };
     };
-    /** @description Unprocessable entity */
+    /** @description Validation failed - see `context` for the list of failing fields */
     '422_UnprocessableEntity': {
       headers: {
         [name: string]: unknown;
       };
       content: {
-        'application/json': components['schemas']['Error'];
+        'application/json': components['schemas']['ValidationError'];
       };
     };
     /** @description Unauthorized */
@@ -385,6 +407,7 @@ interface operations {
           'application/json': components['schemas']['Credentials'][];
         };
       };
+      400: components['responses']['400_BadRequest'];
       401: components['responses']['401_Unauthorized'];
       403: components['responses']['403_Forbidden'];
     };
@@ -723,4 +746,4 @@ type CreateCredentialInput = ComponentPath & Omit<CreateCredentialBody, '#data'>
 };
 //#endregion
 export { CredentialInput as a, Credential as i, CreateCredentialBody as n, CredentialPath as o, CreateCredentialInput as r, GetCredentialsInput as s, ComponentPath as t };
-//# sourceMappingURL=types-CP_LBmw3.d.cts.map
+//# sourceMappingURL=types-BhOUS9j1.d.cts.map

package/dist/{types-tKkeLa2B.d.cts → types-BiEh5c_t.d.cts}

@@ -1116,7 +1116,29 @@ type paths = {
     put?: never;
     /**
      * Create app
-     * @description Create a new app under the vendor. After creation, the app id is prefixed by the vendor id (e.g. `keboola.ex-adwords`).
+     * @description Create a new app under the vendor. After creation, the app id is
+     *     prefixed by the vendor id (e.g. `keboola.ex-adwords`).
+     *
+     *     The body is open on purpose: alongside the properties below it takes every
+     *     other writable app field — the same set `PATCH /vendors/{vendor}/apps/{app}`
+     *     takes, with `id` additionally required — so an app can be registered fully
+     *     configured in one request. The properties below are the ones a registration
+     *     typically sets, not the limit.
+     *
+     *     Two things the open schema cannot express:
+     *
+     *     - These keys are **rejected with `422`**, not merely ignored — sending one
+     *       fails the whole request. Set by the service itself: `version`,
+     *       `isPublished`, `createdOn`, `createdBy`, `updatedOn`, `updatedBy`,
+     *       `icon32`, `icon64`, `icon128`, `publishRequestOn`, `publishRequestBy`,
+     *       `publishRequestRejectionReason`. Reserved to an admin, over
+     *       `PATCH /admin/apps/{id}`: `vendor`, `isPublic`, `legacyUri`,
+     *       `repository.digest`, `category`, `categories`, `complexity`, `features`,
+     *       `forwardToken`, `forwardTokenDetails`, `injectEnvironment`,
+     *       `processTimeout`, `requiredMemory`.
+     *
+     *     - Any other unrecognised key is **accepted and then dropped** — validation
+     *       lets it through, the insert filters it out, so it is never stored.
      */
     post: {
       parameters: {
@@ -1133,7 +1155,16 @@ type paths = {
            * @example {
            *       "id": "ex-adwords",
            *       "name": "AdWords Reports",
-           *       "shortDescription": "Reads reports defined by awql queries"
+           *       "type": "extractor",
+           *       "shortDescription": "Reads reports defined by awql queries",
+           *       "uiOptions": [
+           *         "genericDockerUI"
+           *       ],
+           *       "defaultBucket": true,
+           *       "defaultBucketStage": "in",
+           *       "repository": {
+           *         "type": "ecr"
+           *       }
            *     }
            */
           'application/json': {
@@ -1144,6 +1175,13 @@ type paths = {
             type: 'extractor' | 'application' | 'writer' | 'processor' | 'code-pattern' | 'other' | 'transformation' | 'data-app';
             shortDescription?: string;
             longDescription?: string;
+            /** @description Null clears the list, and reads back as `[]`. */
+            uiOptions?: string[] | null;
+            /** @description Null clears the list, and reads back as `[]`. */
+            actions?: string[] | null;
+            defaultBucket?: boolean;
+            /** @enum {string} */
+            defaultBucketStage?: 'in' | 'out';
             repository?: {
               /** @enum {string} */
               type?: 'dockerhub' | 'quay' | 'builder' | 'ecr';
@@ -1152,6 +1190,8 @@ type paths = {
             } & {
               [key: string]: unknown;
             };
+          } & {
+            [key: string]: unknown;
           };
         };
       };
@@ -2283,13 +2323,25 @@ type paths = {
           };
           content: {
             'application/json': ({
-              id?: string;
+              /** @description The app id the change belongs to. */
+              id: string;
               /** Format: date-time */
-              createdOn?: string;
-              createdBy?: string;
-              changes?: {
+              createdOn: string;
+              /** @description Who made the change. Null for a version stored without an author. */
+              createdBy: string | null;
+              /** @description One entry per attribute that differs from the previous version. Empty for a write that changed nothing — a save with no edits still produces a version. */
+              changes: ({
+                /** @description The `App` property that changed. */
+                attribute: string;
+                /** @description The value in the previous version, of whatever type that property has. Null when the attribute was added. */
+                oldValue: unknown;
+                /** @description The value in this version. Null when the attribute was deleted. */
+                newValue: unknown;
+                /** @description A ready-to-render sentence — `Attribute <name> added/changed/deleted`, or `App <id> created` for the synthetic first-version entry. */
+                description: string;
+              } & {
                 [key: string]: unknown;
-              }[];
+              })[];
             } & {
               [key: string]: unknown;
             })[];
@@ -2832,4 +2884,4 @@ type RefreshTokensResult = OpenapiReturnType<paths['/auth/token']['get']>;
 type MfaSetupResult = OpenapiReturnType<paths['/auth/mfa']['post']>;
 //#endregion
 export { ResetPasswordConfirmInput as A, UserRequest as B, MfaConfirmInput as C, Profile as D, PaginationQuery as E, UpdateAppAsAdminInput as F, paths as G, VendorListItem as H, UpdateAppInput as I, UpdateVendorAsAdminInput as L, ServiceIndex as M, SignUpInput as N, RefreshTokensResult as O, Stack as P, UpdateVendorInput as R, LoginSuccess as S, MfaSetupResult as T, Version as U, Vendor as V, components as W, GetVendorUsersQuery as _, AppRepository as a, LoginInput as b, ConfirmAccountInput as c, CreateVendorAsAdminInput as d, CreateVendorInput as f, GetChangesQuery as g, GetAppsQuery as h, AppChange as i, ServiceAccount as j, RejectAppInput as k, CreateAppInput as l, DeveloperPortalError as m, AdminVendor as n, AppVendor as o, DeprecateAppInput as p, App as r, ApproveVendorInput as s, AdminPaginationQuery as t, CreateServiceAccountInput as u, IconUploadLink as v, MfaSetupInput as w, LoginResult as x, LoginChallenge as y, User as z };
-//# sourceMappingURL=types-tKkeLa2B.d.cts.map
+//# sourceMappingURL=types-BiEh5c_t.d.cts.map

package/dist/{types-RbrfiY8T.d.ts → types-CAp1VexS.d.ts}

@@ -389,7 +389,7 @@ type components = {
   headers: never;
   pathItems: never;
 };
-type operations = {
+interface operations {
   _get_root_get: {
     parameters: {
       query?: never;
@@ -558,7 +558,7 @@ type operations = {
       };
     };
   };
-};
+}
 //#endregion
 //#region src/clients/omnisearch/types.d.ts
 type GetProjectsLineageQuery = OpenapiQueryType<paths['/v1/lineage/projects']['get']>;
@@ -599,4 +599,4 @@ type LineageTable = components['schemas']['TableNode'] & {
 };
 //#endregion
 export { LineageMetadata as a, LineageTable as c, ProjectsLineageResponse as d, TableLineageRelation as f, components as h, LineageConfiguration as i, ProjectLineageRelation as l, TablesLineageResponse as m, GetTablesLineageQuery as n, LineageProject as o, TablesLineage as p, LineageBucket as r, LineageSource as s, GetProjectsLineageQuery as t, ProjectsLineage as u };
-//# sourceMappingURL=types-RbrfiY8T.d.ts.map
+//# sourceMappingURL=types-CAp1VexS.d.ts.map