@knowledge-stack/ksapi 1.139.1 → 1.140.0

package/docs/LeaderboardEntry.md

@@ -0,0 +1,39 @@
+
+# LeaderboardEntry
+
+One ranked entry (a workflow definition or a user).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`count` | number
+
+## Example
+
+```typescript
+import type { LeaderboardEntry } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "count": null,
+} satisfies LeaderboardEntry
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as LeaderboardEntry
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RunTimeseriesResponse.md

@@ -0,0 +1,39 @@
+
+# RunTimeseriesResponse
+
+Workflow runs bucketed over time.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`timezone` | string
+`bucket` | [TimeBucket](TimeBucket.md)
+`points` | [Array<TimeseriesPoint>](TimeseriesPoint.md)
+
+## Example
+
+```typescript
+import type { RunTimeseriesResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "timezone": null,
+  "bucket": null,
+  "points": null,
+} satisfies RunTimeseriesResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RunTimeseriesResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TimeBucket.md

@@ -0,0 +1,33 @@
+
+# TimeBucket
+
+Granularity for a bucketed time series.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { TimeBucket } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies TimeBucket
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TimeBucket
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TimeseriesPoint.md

@@ -0,0 +1,37 @@
+
+# TimeseriesPoint
+
+One bucket of a time series.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`bucketStart` | Date
+`count` | number
+
+## Example
+
+```typescript
+import type { TimeseriesPoint } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "bucketStart": null,
+  "count": null,
+} satisfies TimeseriesPoint
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TimeseriesPoint
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WorkflowLeaderboardResponse.md

@@ -0,0 +1,37 @@
+
+# WorkflowLeaderboardResponse
+
+Top workflows and top users by run count over a window.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`topWorkflows` | [Array<LeaderboardEntry>](LeaderboardEntry.md)
+`topUsers` | [Array<LeaderboardEntry>](LeaderboardEntry.md)
+
+## Example
+
+```typescript
+import type { WorkflowLeaderboardResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "topWorkflows": null,
+  "topUsers": null,
+} satisfies WorkflowLeaderboardResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WorkflowLeaderboardResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WorkflowOutputStatsResponse.md

@@ -0,0 +1,37 @@
+
+# WorkflowOutputStatsResponse
+
+Avg documents generated per workflow definition (completed runs).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`perDefinition` | [Array<DefinitionOutputStat>](DefinitionOutputStat.md)
+`overallAvg` | number
+
+## Example
+
+```typescript
+import type { WorkflowOutputStatsResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "perDefinition": null,
+  "overallAvg": null,
+} satisfies WorkflowOutputStatsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WorkflowOutputStatsResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.139.1",
+  "version": "1.140.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AdminKbApi.ts

@@ -0,0 +1,237 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  ErrorResponse,
+  HTTPValidationError,
+  KbMetric,
+  KbSummaryResponse,
+  KbTimeseriesResponse,
+  TimeBucket,
+} from '../models/index';
+import {
+    ErrorResponseFromJSON,
+    ErrorResponseToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    KbMetricFromJSON,
+    KbMetricToJSON,
+    KbSummaryResponseFromJSON,
+    KbSummaryResponseToJSON,
+    KbTimeseriesResponseFromJSON,
+    KbTimeseriesResponseToJSON,
+    TimeBucketFromJSON,
+    TimeBucketToJSON,
+} from '../models/index';
+
+export interface GetAdminKbTimeseriesRequest {
+    metric: KbMetric;
+    since?: Date | null;
+    until?: Date | null;
+    bucket?: TimeBucket;
+    timezone?: string | null;
+}
+
+/**
+ * AdminKbApi - interface
+ * 
+ * @export
+ * @interface AdminKbApiInterface
+ */
+export interface AdminKbApiInterface {
+    /**
+     * Creates request options for getAdminKbSummary without sending the request
+     * @throws {RequiredError}
+     * @memberof AdminKbApiInterface
+     */
+    getAdminKbSummaryRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Point-in-time knowledge-base totals for the tenant.
+     * @summary Get Admin Kb Summary Handler
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminKbApiInterface
+     */
+    getAdminKbSummaryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KbSummaryResponse>>;
+
+    /**
+     * Point-in-time knowledge-base totals for the tenant.
+     * Get Admin Kb Summary Handler
+     */
+    getAdminKbSummary(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KbSummaryResponse>;
+
+    /**
+     * Creates request options for getAdminKbTimeseries without sending the request
+     * @param {KbMetric} metric Which KB metric to bucket.
+     * @param {Date} [since] Window start.
+     * @param {Date} [until] Window end.
+     * @param {TimeBucket} [bucket] Bucket size.
+     * @param {string} [timezone] IANA tz override; defaults to tenant setting.
+     * @throws {RequiredError}
+     * @memberof AdminKbApiInterface
+     */
+    getAdminKbTimeseriesRequestOpts(requestParameters: GetAdminKbTimeseriesRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * A knowledge-base metric bucketed over time, in the resolved timezone.
+     * @summary Get Admin Kb Timeseries Handler
+     * @param {KbMetric} metric Which KB metric to bucket.
+     * @param {Date} [since] Window start.
+     * @param {Date} [until] Window end.
+     * @param {TimeBucket} [bucket] Bucket size.
+     * @param {string} [timezone] IANA tz override; defaults to tenant setting.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminKbApiInterface
+     */
+    getAdminKbTimeseriesRaw(requestParameters: GetAdminKbTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KbTimeseriesResponse>>;
+
+    /**
+     * A knowledge-base metric bucketed over time, in the resolved timezone.
+     * Get Admin Kb Timeseries Handler
+     */
+    getAdminKbTimeseries(requestParameters: GetAdminKbTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KbTimeseriesResponse>;
+
+}
+
+/**
+ * 
+ */
+export class AdminKbApi extends runtime.BaseAPI implements AdminKbApiInterface {
+
+    /**
+     * Creates request options for getAdminKbSummary without sending the request
+     */
+    async getAdminKbSummaryRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/admin/kb/summary`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Point-in-time knowledge-base totals for the tenant.
+     * Get Admin Kb Summary Handler
+     */
+    async getAdminKbSummaryRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KbSummaryResponse>> {
+        const requestOptions = await this.getAdminKbSummaryRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => KbSummaryResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Point-in-time knowledge-base totals for the tenant.
+     * Get Admin Kb Summary Handler
+     */
+    async getAdminKbSummary(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KbSummaryResponse> {
+        const response = await this.getAdminKbSummaryRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getAdminKbTimeseries without sending the request
+     */
+    async getAdminKbTimeseriesRequestOpts(requestParameters: GetAdminKbTimeseriesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['metric'] == null) {
+            throw new runtime.RequiredError(
+                'metric',
+                'Required parameter "metric" was null or undefined when calling getAdminKbTimeseries().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['metric'] != null) {
+            queryParameters['metric'] = requestParameters['metric'];
+        }
+
+        if (requestParameters['since'] != null) {
+            queryParameters['since'] = (requestParameters['since'] as any).toISOString();
+        }
+
+        if (requestParameters['until'] != null) {
+            queryParameters['until'] = (requestParameters['until'] as any).toISOString();
+        }
+
+        if (requestParameters['bucket'] != null) {
+            queryParameters['bucket'] = requestParameters['bucket'];
+        }
+
+        if (requestParameters['timezone'] != null) {
+            queryParameters['timezone'] = requestParameters['timezone'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/admin/kb/timeseries`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * A knowledge-base metric bucketed over time, in the resolved timezone.
+     * Get Admin Kb Timeseries Handler
+     */
+    async getAdminKbTimeseriesRaw(requestParameters: GetAdminKbTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<KbTimeseriesResponse>> {
+        const requestOptions = await this.getAdminKbTimeseriesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => KbTimeseriesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * A knowledge-base metric bucketed over time, in the resolved timezone.
+     * Get Admin Kb Timeseries Handler
+     */
+    async getAdminKbTimeseries(requestParameters: GetAdminKbTimeseriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<KbTimeseriesResponse> {
+        const response = await this.getAdminKbTimeseriesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}