@knowledge-stack/ksapi 1.139.1 → 1.140.0

package/dist/esm/apis/AdminWorkflowsApi.js

@@ -0,0 +1,300 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { HourHistogramResponseFromJSON, RunTimeseriesResponseFromJSON, WorkflowLeaderboardResponseFromJSON, WorkflowOutputStatsResponseFromJSON, WorkflowRunSummaryResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class AdminWorkflowsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getAdminWorkflowByHour without sending the request
+     */
+    getAdminWorkflowByHourRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['since'] != null) {
+                queryParameters['since'] = requestParameters['since'].toISOString();
+            }
+            if (requestParameters['until'] != null) {
+                queryParameters['until'] = requestParameters['until'].toISOString();
+            }
+            if (requestParameters['timezone'] != null) {
+                queryParameters['timezone'] = requestParameters['timezone'];
+            }
+            if (requestParameters['definitionId'] != null) {
+                queryParameters['definition_id'] = requestParameters['definitionId'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/admin/workflows/by-hour`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Runs per hour-of-day (0-23) in the resolved timezone.
+     * Get Admin Workflow By Hour Handler
+     */
+    getAdminWorkflowByHourRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAdminWorkflowByHourRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => HourHistogramResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Runs per hour-of-day (0-23) in the resolved timezone.
+     * Get Admin Workflow By Hour Handler
+     */
+    getAdminWorkflowByHour() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getAdminWorkflowByHourRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getAdminWorkflowLeaderboard without sending the request
+     */
+    getAdminWorkflowLeaderboardRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['since'] != null) {
+                queryParameters['since'] = requestParameters['since'].toISOString();
+            }
+            if (requestParameters['until'] != null) {
+                queryParameters['until'] = requestParameters['until'].toISOString();
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/admin/workflows/leaderboard`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Top workflows and top run owners by run count.
+     * Get Admin Workflow Leaderboard Handler
+     */
+    getAdminWorkflowLeaderboardRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAdminWorkflowLeaderboardRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowLeaderboardResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Top workflows and top run owners by run count.
+     * Get Admin Workflow Leaderboard Handler
+     */
+    getAdminWorkflowLeaderboard() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getAdminWorkflowLeaderboardRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getAdminWorkflowOutputStats without sending the request
+     */
+    getAdminWorkflowOutputStatsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['since'] != null) {
+                queryParameters['since'] = requestParameters['since'].toISOString();
+            }
+            if (requestParameters['until'] != null) {
+                queryParameters['until'] = requestParameters['until'].toISOString();
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/admin/workflows/output-stats`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Average output DOCUMENTs generated per workflow definition (completed runs).
+     * Get Admin Workflow Output Stats Handler
+     */
+    getAdminWorkflowOutputStatsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAdminWorkflowOutputStatsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowOutputStatsResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Average output DOCUMENTs generated per workflow definition (completed runs).
+     * Get Admin Workflow Output Stats Handler
+     */
+    getAdminWorkflowOutputStats() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getAdminWorkflowOutputStatsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getAdminWorkflowSummary without sending the request
+     */
+    getAdminWorkflowSummaryRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['since'] != null) {
+                queryParameters['since'] = requestParameters['since'].toISOString();
+            }
+            if (requestParameters['until'] != null) {
+                queryParameters['until'] = requestParameters['until'].toISOString();
+            }
+            if (requestParameters['definitionId'] != null) {
+                queryParameters['definition_id'] = requestParameters['definitionId'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/admin/workflows/summary`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Tenant-wide run health: counts, failure rate, durations, approval backlog.
+     * Get Admin Workflow Summary Handler
+     */
+    getAdminWorkflowSummaryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAdminWorkflowSummaryRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowRunSummaryResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Tenant-wide run health: counts, failure rate, durations, approval backlog.
+     * Get Admin Workflow Summary Handler
+     */
+    getAdminWorkflowSummary() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getAdminWorkflowSummaryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getAdminWorkflowTimeseries without sending the request
+     */
+    getAdminWorkflowTimeseriesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['since'] != null) {
+                queryParameters['since'] = requestParameters['since'].toISOString();
+            }
+            if (requestParameters['until'] != null) {
+                queryParameters['until'] = requestParameters['until'].toISOString();
+            }
+            if (requestParameters['bucket'] != null) {
+                queryParameters['bucket'] = requestParameters['bucket'];
+            }
+            if (requestParameters['timezone'] != null) {
+                queryParameters['timezone'] = requestParameters['timezone'];
+            }
+            if (requestParameters['definitionId'] != null) {
+                queryParameters['definition_id'] = requestParameters['definitionId'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/admin/workflows/timeseries`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Run counts bucketed over time, in the resolved timezone.
+     * Get Admin Workflow Timeseries Handler
+     */
+    getAdminWorkflowTimeseriesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAdminWorkflowTimeseriesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => RunTimeseriesResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Run counts bucketed over time, in the resolved timezone.
+     * Get Admin Workflow Timeseries Handler
+     */
+    getAdminWorkflowTimeseries() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getAdminWorkflowTimeseriesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/index.d.ts

@@ -1,3 +1,5 @@
+export * from './AdminKbApi';
+export * from './AdminWorkflowsApi';
 export * from './AgentApi';
 export * from './ApiConnectionsApi';
 export * from './ApiKeysApi';

package/dist/esm/apis/index.js

@@ -1,5 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AdminKbApi';
+export * from './AdminWorkflowsApi';
 export * from './AgentApi';
 export * from './ApiConnectionsApi';
 export * from './ApiKeysApi';

package/dist/esm/models/DefinitionOutputStat.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Average output-document count for one workflow definition.
+ * @export
+ * @interface DefinitionOutputStat
+ */
+export interface DefinitionOutputStat {
+    /**
+     *
+     * @type {string}
+     * @memberof DefinitionOutputStat
+     */
+    definitionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DefinitionOutputStat
+     */
+    name: string;
+    /**
+     * COMPLETED runs in the window.
+     * @type {number}
+     * @memberof DefinitionOutputStat
+     */
+    completedRuns: number;
+    /**
+     * Mean output DOCUMENTs generated per completed run.
+     * @type {number}
+     * @memberof DefinitionOutputStat
+     */
+    avgDocuments: number;
+}
+export declare const DefinitionOutputStatPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the DefinitionOutputStat interface.
+ */
+export declare function instanceOfDefinitionOutputStat(value: object): value is DefinitionOutputStat;
+export declare function DefinitionOutputStatFromJSON(json: any): DefinitionOutputStat;
+export declare function DefinitionOutputStatFromJSONTyped(json: any, ignoreDiscriminator: boolean): DefinitionOutputStat;
+export declare function DefinitionOutputStatToJSON(json: any): DefinitionOutputStat;
+export declare function DefinitionOutputStatToJSONTyped(value?: DefinitionOutputStat | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DefinitionOutputStat.js

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const DefinitionOutputStatPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DefinitionOutputStat interface.
+ */
+export function instanceOfDefinitionOutputStat(value) {
+    if (!('definitionId' in value) || value['definitionId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('completedRuns' in value) || value['completedRuns'] === undefined)
+        return false;
+    if (!('avgDocuments' in value) || value['avgDocuments'] === undefined)
+        return false;
+    return true;
+}
+export function DefinitionOutputStatFromJSON(json) {
+    return DefinitionOutputStatFromJSONTyped(json, false);
+}
+export function DefinitionOutputStatFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'definitionId': json['definition_id'],
+        'name': json['name'],
+        'completedRuns': json['completed_runs'],
+        'avgDocuments': json['avg_documents'],
+    };
+}
+export function DefinitionOutputStatToJSON(json) {
+    return DefinitionOutputStatToJSONTyped(json, false);
+}
+export function DefinitionOutputStatToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'definition_id': value['definitionId'],
+        'name': value['name'],
+        'completed_runs': value['completedRuns'],
+        'avg_documents': value['avgDocuments'],
+    };
+}

package/dist/esm/models/HourHistogramResponse.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Workflow runs by hour-of-day (0-23) in the resolved timezone.
+ * @export
+ * @interface HourHistogramResponse
+ */
+export interface HourHistogramResponse {
+    /**
+     * IANA timezone the hours are in.
+     * @type {string}
+     * @memberof HourHistogramResponse
+     */
+    timezone: string;
+    /**
+     * Exactly 24 entries; index i is the run count for hour i.
+     * @type {Array<number>}
+     * @memberof HourHistogramResponse
+     */
+    countsByHour: Array<number>;
+}
+export declare const HourHistogramResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the HourHistogramResponse interface.
+ */
+export declare function instanceOfHourHistogramResponse(value: object): value is HourHistogramResponse;
+export declare function HourHistogramResponseFromJSON(json: any): HourHistogramResponse;
+export declare function HourHistogramResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HourHistogramResponse;
+export declare function HourHistogramResponseToJSON(json: any): HourHistogramResponse;
+export declare function HourHistogramResponseToJSONTyped(value?: HourHistogramResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/HourHistogramResponse.js

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export const HourHistogramResponsePropertyValidationAttributesMap = {
+    countsByHour: {
+        maxItems: 24,
+        minItems: 24,
+        uniqueItems: false,
+    },
+};
+/**
+ * Check if a given object implements the HourHistogramResponse interface.
+ */
+export function instanceOfHourHistogramResponse(value) {
+    if (!('timezone' in value) || value['timezone'] === undefined)
+        return false;
+    if (!('countsByHour' in value) || value['countsByHour'] === undefined)
+        return false;
+    return true;
+}
+export function HourHistogramResponseFromJSON(json) {
+    return HourHistogramResponseFromJSONTyped(json, false);
+}
+export function HourHistogramResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'timezone': json['timezone'],
+        'countsByHour': json['counts_by_hour'],
+    };
+}
+export function HourHistogramResponseToJSON(json) {
+    return HourHistogramResponseToJSONTyped(json, false);
+}
+export function HourHistogramResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'timezone': value['timezone'],
+        'counts_by_hour': value['countsByHour'],
+    };
+}

package/dist/esm/models/KbMetric.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A knowledge-base time series the dashboard can request.
+ * @export
+ */
+export declare const KbMetric: {
+    readonly DocumentUploads: 'document_uploads';
+    readonly IngestionCompleted: 'ingestion_completed';
+    readonly IngestionFailed: 'ingestion_failed';
+};
+export type KbMetric = typeof KbMetric[keyof typeof KbMetric];
+export declare function instanceOfKbMetric(value: any): boolean;
+export declare function KbMetricFromJSON(json: any): KbMetric;
+export declare function KbMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): KbMetric;
+export declare function KbMetricToJSON(value?: KbMetric | null): any;
+export declare function KbMetricToJSONTyped(value: any, ignoreDiscriminator: boolean): KbMetric;

package/dist/esm/models/KbMetric.js

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A knowledge-base time series the dashboard can request.
+ * @export
+ */
+export const KbMetric = {
+    DocumentUploads: 'document_uploads',
+    IngestionCompleted: 'ingestion_completed',
+    IngestionFailed: 'ingestion_failed'
+};
+export function instanceOfKbMetric(value) {
+    for (const key in KbMetric) {
+        if (Object.prototype.hasOwnProperty.call(KbMetric, key)) {
+            if (KbMetric[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function KbMetricFromJSON(json) {
+    return KbMetricFromJSONTyped(json, false);
+}
+export function KbMetricFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function KbMetricToJSON(value) {
+    return value;
+}
+export function KbMetricToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}