@knowledge-stack/ksapi 3.13.1 → 3.14.0

package/src/models/PaginatedResponseUserInfo.ts

@@ -0,0 +1,130 @@
+/* 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 { mapValues } from '../runtime';
+import type { UserInfo } from './UserInfo';
+import {
+    UserInfoFromJSON,
+    UserInfoFromJSONTyped,
+    UserInfoToJSON,
+    UserInfoToJSONTyped,
+} from './UserInfo';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedResponseUserInfo
+ */
+export interface PaginatedResponseUserInfo {
+    /**
+     * List of items
+     * @type {Array<UserInfo>}
+     * @memberof PaginatedResponseUserInfo
+     */
+    items: Array<UserInfo>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseUserInfo
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseUserInfo
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseUserInfo
+     */
+    offset: number;
+}
+export const PaginatedResponseUserInfoPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the PaginatedResponseUserInfo interface.
+ */
+export function instanceOfPaginatedResponseUserInfo(value: object): value is PaginatedResponseUserInfo {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('limit' in value) || value['limit'] === undefined) return false;
+    if (!('offset' in value) || value['offset'] === undefined) return false;
+    return true;
+}
+
+export function PaginatedResponseUserInfoFromJSON(json: any): PaginatedResponseUserInfo {
+    return PaginatedResponseUserInfoFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseUserInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseUserInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(UserInfoFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+
+export function PaginatedResponseUserInfoToJSON(json: any): PaginatedResponseUserInfo {
+    return PaginatedResponseUserInfoToJSONTyped(json, false);
+}
+
+export function PaginatedResponseUserInfoToJSONTyped(value?: PaginatedResponseUserInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(UserInfoToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+

package/src/models/WorkflowDetailResponse.ts

@@ -20,6 +20,13 @@ import {
     PipelineStatusToJSON,
     PipelineStatusToJSONTyped,
 } from './PipelineStatus';
+import type { UserInfo } from './UserInfo';
+import {
+    UserInfoFromJSON,
+    UserInfoFromJSONTyped,
+    UserInfoToJSON,
+    UserInfoToJSONTyped,
+} from './UserInfo';
 
 /**
  * Single item - adds live Temporal fields.
@@ -39,12 +46,36 @@ export interface WorkflowDetailResponse {
      * @memberof WorkflowDetailResponse
      */
     documentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    documentName: string;
+    /**
+     * The document's path
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    materializedPath: string;
     /**
      * 
      * @type {string}
      * @memberof WorkflowDetailResponse
      */
     documentVersionId: string;
+    /**
+     * Whether this version is the document's active one; false for an unfinished newer upload and for a superseded older version
+     * @type {boolean}
+     * @memberof WorkflowDetailResponse
+     */
+    isActiveVersion: boolean;
+    /**
+     * 
+     * @type {UserInfo}
+     * @memberof WorkflowDetailResponse
+     */
+    uploader: UserInfo;
     /**
      * 
      * @type {PipelineStatus}
@@ -64,7 +95,7 @@ export interface WorkflowDetailResponse {
      */
     error?: string | null;
     /**
-     * 
+     * When the last run started; the upload time until a run has started
      * @type {Date}
      * @memberof WorkflowDetailResponse
      */
@@ -150,7 +181,11 @@ export const WorkflowDetailResponsePropertyValidationAttributesMap: {
 export function instanceOfWorkflowDetailResponse(value: object): value is WorkflowDetailResponse {
     if (!('workflowId' in value) || value['workflowId'] === undefined) return false;
     if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    if (!('documentName' in value) || value['documentName'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
     if (!('documentVersionId' in value) || value['documentVersionId'] === undefined) return false;
+    if (!('isActiveVersion' in value) || value['isActiveVersion'] === undefined) return false;
+    if (!('uploader' in value) || value['uploader'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('lastRunTimestamp' in value) || value['lastRunTimestamp'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
@@ -174,7 +209,11 @@ export function WorkflowDetailResponseFromJSONTyped(json: any, ignoreDiscriminat
         
         'workflowId': json['workflow_id'],
         'documentId': json['document_id'],
+        'documentName': json['document_name'],
+        'materializedPath': json['materialized_path'],
         'documentVersionId': json['document_version_id'],
+        'isActiveVersion': json['is_active_version'],
+        'uploader': UserInfoFromJSON(json['uploader']),
         'status': PipelineStatusFromJSON(json['status']),
         'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
         'error': json['error'] == null ? undefined : json['error'],
@@ -204,7 +243,11 @@ export function WorkflowDetailResponseToJSONTyped(value?: WorkflowDetailResponse
         
         'workflow_id': value['workflowId'],
         'document_id': value['documentId'],
+        'document_name': value['documentName'],
+        'materialized_path': value['materializedPath'],
         'document_version_id': value['documentVersionId'],
+        'is_active_version': value['isActiveVersion'],
+        'uploader': UserInfoToJSON(value['uploader']),
         'status': PipelineStatusToJSON(value['status']),
         'last_activity': value['lastActivity'],
         'error': value['error'],

package/src/models/WorkflowSummaryResponse.ts

@@ -20,6 +20,13 @@ import {
     PipelineStatusToJSON,
     PipelineStatusToJSONTyped,
 } from './PipelineStatus';
+import type { UserInfo } from './UserInfo';
+import {
+    UserInfoFromJSON,
+    UserInfoFromJSONTyped,
+    UserInfoToJSON,
+    UserInfoToJSONTyped,
+} from './UserInfo';
 
 /**
  * List item - DB-only fields, no Temporal call per item.
@@ -39,12 +46,36 @@ export interface WorkflowSummaryResponse {
      * @memberof WorkflowSummaryResponse
      */
     documentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowSummaryResponse
+     */
+    documentName: string;
+    /**
+     * The document's path
+     * @type {string}
+     * @memberof WorkflowSummaryResponse
+     */
+    materializedPath: string;
     /**
      * 
      * @type {string}
      * @memberof WorkflowSummaryResponse
      */
     documentVersionId: string;
+    /**
+     * Whether this version is the document's active one; false for an unfinished newer upload and for a superseded older version
+     * @type {boolean}
+     * @memberof WorkflowSummaryResponse
+     */
+    isActiveVersion: boolean;
+    /**
+     * 
+     * @type {UserInfo}
+     * @memberof WorkflowSummaryResponse
+     */
+    uploader: UserInfo;
     /**
      * 
      * @type {PipelineStatus}
@@ -64,7 +95,7 @@ export interface WorkflowSummaryResponse {
      */
     error?: string | null;
     /**
-     * 
+     * When the last run started; the upload time until a run has started
      * @type {Date}
      * @memberof WorkflowSummaryResponse
      */
@@ -108,7 +139,11 @@ export const WorkflowSummaryResponsePropertyValidationAttributesMap: {
 export function instanceOfWorkflowSummaryResponse(value: object): value is WorkflowSummaryResponse {
     if (!('workflowId' in value) || value['workflowId'] === undefined) return false;
     if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    if (!('documentName' in value) || value['documentName'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
     if (!('documentVersionId' in value) || value['documentVersionId'] === undefined) return false;
+    if (!('isActiveVersion' in value) || value['isActiveVersion'] === undefined) return false;
+    if (!('uploader' in value) || value['uploader'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('lastRunTimestamp' in value) || value['lastRunTimestamp'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
@@ -127,7 +162,11 @@ export function WorkflowSummaryResponseFromJSONTyped(json: any, ignoreDiscrimina
         
         'workflowId': json['workflow_id'],
         'documentId': json['document_id'],
+        'documentName': json['document_name'],
+        'materializedPath': json['materialized_path'],
         'documentVersionId': json['document_version_id'],
+        'isActiveVersion': json['is_active_version'],
+        'uploader': UserInfoFromJSON(json['uploader']),
         'status': PipelineStatusFromJSON(json['status']),
         'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
         'error': json['error'] == null ? undefined : json['error'],
@@ -150,7 +189,11 @@ export function WorkflowSummaryResponseToJSONTyped(value?: WorkflowSummaryRespon
         
         'workflow_id': value['workflowId'],
         'document_id': value['documentId'],
+        'document_name': value['documentName'],
+        'materialized_path': value['materializedPath'],
         'document_version_id': value['documentVersionId'],
+        'is_active_version': value['isActiveVersion'],
+        'uploader': UserInfoToJSON(value['uploader']),
         'status': PipelineStatusToJSON(value['status']),
         'last_activity': value['lastActivity'],
         'error': value['error'],

package/src/models/index.ts

@@ -37,6 +37,7 @@ export * from './BulkModelTablesRequest';
 export * from './BulkModelTablesResponse';
 export * from './BulkMoveRequest';
 export * from './BulkOperationResponse';
+export * from './BulkRerunRequest';
 export * from './BulkRevokeRequest';
 export * from './BulkTagRequest';
 export * from './BulkTrashRequest';
@@ -237,6 +238,7 @@ export * from './PaginatedResponseTenantUserResponse';
 export * from './PaginatedResponseThreadMessageResponse';
 export * from './PaginatedResponseThreadResponse';
 export * from './PaginatedResponseTrashItemResponse';
+export * from './PaginatedResponseUserInfo';
 export * from './PaginatedResponseWorkflowDefinitionResponse';
 export * from './PaginatedResponseWorkflowRunResponse';
 export * from './PaginatedResponseWorkflowSummaryResponse';