@knowledge-stack/ksapi 1.81.0 → 1.83.0

package/src/models/InstructionSnapshot.ts

@@ -0,0 +1,125 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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 { PartType } from './PartType';
+import {
+    PartTypeFromJSON,
+    PartTypeFromJSONTyped,
+    PartTypeToJSON,
+    PartTypeToJSONTyped,
+} from './PartType';
+
+/**
+ * Snapshot of one instruction document, pinned at trigger time.
+ * 
+ * The instruction file is the workflow's **contract**: the agent reads
+ * this exact ``document_version_id`` for the duration of the run, even
+ * if the document is edited mid-flight or after the run completes.
+ * Reproducibility and audit replay depend on this pinning.
+ * @export
+ * @interface InstructionSnapshot
+ */
+export interface InstructionSnapshot {
+    /**
+     * 
+     * @type {string}
+     * @memberof InstructionSnapshot
+     */
+    pathPartId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof InstructionSnapshot
+     */
+    materializedPath: string;
+    /**
+     * 
+     * @type {PartType}
+     * @memberof InstructionSnapshot
+     */
+    partType: PartType;
+    /**
+     * 
+     * @type {string}
+     * @memberof InstructionSnapshot
+     */
+    documentVersionId: string;
+}
+
+
+export const InstructionSnapshotPropertyValidationAttributesMap: {
+    [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 InstructionSnapshot interface.
+ */
+export function instanceOfInstructionSnapshot(value: object): value is InstructionSnapshot {
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
+    if (!('partType' in value) || value['partType'] === undefined) return false;
+    if (!('documentVersionId' in value) || value['documentVersionId'] === undefined) return false;
+    return true;
+}
+
+export function InstructionSnapshotFromJSON(json: any): InstructionSnapshot {
+    return InstructionSnapshotFromJSONTyped(json, false);
+}
+
+export function InstructionSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): InstructionSnapshot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pathPartId': json['path_part_id'],
+        'materializedPath': json['materialized_path'],
+        'partType': PartTypeFromJSON(json['part_type']),
+        'documentVersionId': json['document_version_id'],
+    };
+}
+
+export function InstructionSnapshotToJSON(json: any): InstructionSnapshot {
+    return InstructionSnapshotToJSONTyped(json, false);
+}
+
+export function InstructionSnapshotToJSONTyped(value?: InstructionSnapshot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'path_part_id': value['pathPartId'],
+        'materialized_path': value['materializedPath'],
+        'part_type': PartTypeToJSON(value['partType']),
+        'document_version_id': value['documentVersionId'],
+    };
+}
+

package/src/models/InvokeWorkflowRequest.ts

@@ -25,6 +25,12 @@ export interface InvokeWorkflowRequest {
      * @memberof InvokeWorkflowRequest
      */
     idempotencyKey?: string | null;
+    /**
+     * Path part IDs of input documents to pin to this run. Each path_part must be a DOCUMENT readable by the caller. Active document_version_id is captured at trigger time.
+     * @type {Array<string>}
+     * @memberof InvokeWorkflowRequest
+     */
+    inputPathPartIds?: Array<string>;
 }
 export const InvokeWorkflowRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -44,6 +50,10 @@ export const InvokeWorkflowRequestPropertyValidationAttributesMap: {
     idempotencyKey: {
         maxLength: 255,
     },
+    inputPathPartIds: {
+        maxItems: 50,
+        uniqueItems: false,
+    },
 }
 
 
@@ -65,6 +75,7 @@ export function InvokeWorkflowRequestFromJSONTyped(json: any, ignoreDiscriminato
     return {
         
         'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
+        'inputPathPartIds': json['input_path_part_ids'] == null ? undefined : json['input_path_part_ids'],
     };
 }
 
@@ -80,6 +91,7 @@ export function InvokeWorkflowRequestToJSONTyped(value?: InvokeWorkflowRequest |
     return {
         
         'idempotency_key': value['idempotencyKey'],
+        'input_path_part_ids': value['inputPathPartIds'],
     };
 }
 

package/src/models/PathPartApprovalDecision.ts

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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.
+ */
+
+
+/**
+ * Per-file review status within a run (SeaHonor pilot).
+ * 
+ * Now retained as the audit-history record (one row per (run, file));
+ * the current state of truth is ``path_part.approval_state``. The
+ * service dual-writes both.
+ * @export
+ */
+export const PathPartApprovalDecision = {
+    Pending: 'pending',
+    Approved: 'approved',
+    Rejected: 'rejected'
+} as const;
+export type PathPartApprovalDecision = typeof PathPartApprovalDecision[keyof typeof PathPartApprovalDecision];
+
+
+export function instanceOfPathPartApprovalDecision(value: any): boolean {
+    for (const key in PathPartApprovalDecision) {
+        if (Object.prototype.hasOwnProperty.call(PathPartApprovalDecision, key)) {
+            if (PathPartApprovalDecision[key as keyof typeof PathPartApprovalDecision] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PathPartApprovalDecisionFromJSON(json: any): PathPartApprovalDecision {
+    return PathPartApprovalDecisionFromJSONTyped(json, false);
+}
+
+export function PathPartApprovalDecisionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PathPartApprovalDecision {
+    return json as PathPartApprovalDecision;
+}
+
+export function PathPartApprovalDecisionToJSON(value?: PathPartApprovalDecision | null): any {
+    return value as any;
+}
+
+export function PathPartApprovalDecisionToJSONTyped(value: any, ignoreDiscriminator: boolean): PathPartApprovalDecision {
+    return value as PathPartApprovalDecision;
+}
+

package/src/models/PathPartApprovalResponse.ts

@@ -0,0 +1,186 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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 { PathPartApprovalDecision } from './PathPartApprovalDecision';
+import {
+    PathPartApprovalDecisionFromJSON,
+    PathPartApprovalDecisionFromJSONTyped,
+    PathPartApprovalDecisionToJSON,
+    PathPartApprovalDecisionToJSONTyped,
+} from './PathPartApprovalDecision';
+
+/**
+ * Approval audit-history row over any path_part (file or folder).
+ * 
+ * ``run_id`` is optional — None when the path_part was approved directly
+ * without a workflow-run context.
+ * @export
+ * @interface PathPartApprovalResponse
+ */
+export interface PathPartApprovalResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof PathPartApprovalResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PathPartApprovalResponse
+     */
+    runId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PathPartApprovalResponse
+     */
+    pathPartId: string;
+    /**
+     * 
+     * @type {PathPartApprovalDecision}
+     * @memberof PathPartApprovalResponse
+     */
+    status: PathPartApprovalDecision;
+    /**
+     * 
+     * @type {string}
+     * @memberof PathPartApprovalResponse
+     */
+    reviewerId: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PathPartApprovalResponse
+     */
+    reviewedAt: Date | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PathPartApprovalResponse
+     */
+    rejectionReason: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PathPartApprovalResponse
+     */
+    unapprovedBy: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PathPartApprovalResponse
+     */
+    unapprovedAt: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PathPartApprovalResponse
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof PathPartApprovalResponse
+     */
+    updatedAt: Date;
+}
+
+
+export const PathPartApprovalResponsePropertyValidationAttributesMap: {
+    [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 PathPartApprovalResponse interface.
+ */
+export function instanceOfPathPartApprovalResponse(value: object): value is PathPartApprovalResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('runId' in value) || value['runId'] === undefined) return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('reviewerId' in value) || value['reviewerId'] === undefined) return false;
+    if (!('reviewedAt' in value) || value['reviewedAt'] === undefined) return false;
+    if (!('rejectionReason' in value) || value['rejectionReason'] === undefined) return false;
+    if (!('unapprovedBy' in value) || value['unapprovedBy'] === undefined) return false;
+    if (!('unapprovedAt' in value) || value['unapprovedAt'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function PathPartApprovalResponseFromJSON(json: any): PathPartApprovalResponse {
+    return PathPartApprovalResponseFromJSONTyped(json, false);
+}
+
+export function PathPartApprovalResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PathPartApprovalResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'runId': json['run_id'],
+        'pathPartId': json['path_part_id'],
+        'status': PathPartApprovalDecisionFromJSON(json['status']),
+        'reviewerId': json['reviewer_id'],
+        'reviewedAt': (json['reviewed_at'] == null ? null : new Date(json['reviewed_at'])),
+        'rejectionReason': json['rejection_reason'],
+        'unapprovedBy': json['unapproved_by'],
+        'unapprovedAt': (json['unapproved_at'] == null ? null : new Date(json['unapproved_at'])),
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function PathPartApprovalResponseToJSON(json: any): PathPartApprovalResponse {
+    return PathPartApprovalResponseToJSONTyped(json, false);
+}
+
+export function PathPartApprovalResponseToJSONTyped(value?: PathPartApprovalResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'run_id': value['runId'],
+        'path_part_id': value['pathPartId'],
+        'status': PathPartApprovalDecisionToJSON(value['status']),
+        'reviewer_id': value['reviewerId'],
+        'reviewed_at': value['reviewedAt'] == null ? value['reviewedAt'] : value['reviewedAt'].toISOString(),
+        'rejection_reason': value['rejectionReason'],
+        'unapproved_by': value['unapprovedBy'],
+        'unapproved_at': value['unapprovedAt'] == null ? value['unapprovedAt'] : value['unapprovedAt'].toISOString(),
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+

package/src/models/RejectFileRequest.ts

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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';
+/**
+ * Body for ``POST /workflow-runs/{run}/files/{file}/reject``.
+ * @export
+ * @interface RejectFileRequest
+ */
+export interface RejectFileRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RejectFileRequest
+     */
+    reason: string;
+}
+export const RejectFileRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    reason: {
+        maxLength: 2048,
+        minLength: 1,
+    },
+}
+
+
+/**
+ * Check if a given object implements the RejectFileRequest interface.
+ */
+export function instanceOfRejectFileRequest(value: object): value is RejectFileRequest {
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function RejectFileRequestFromJSON(json: any): RejectFileRequest {
+    return RejectFileRequestFromJSONTyped(json, false);
+}
+
+export function RejectFileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RejectFileRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reason': json['reason'],
+    };
+}
+
+export function RejectFileRequestToJSON(json: any): RejectFileRequest {
+    return RejectFileRequestToJSONTyped(json, false);
+}
+
+export function RejectFileRequestToJSONTyped(value?: RejectFileRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'reason': value['reason'],
+    };
+}
+

package/src/models/RunLockResponse.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * 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';
+/**
+ * Reviewer-lock state on a workflow run.
+ * @export
+ * @interface RunLockResponse
+ */
+export interface RunLockResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof RunLockResponse
+     */
+    runId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RunLockResponse
+     */
+    lockUserId: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof RunLockResponse
+     */
+    lockAcquiredAt: Date | null;
+}
+export const RunLockResponsePropertyValidationAttributesMap: {
+    [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 RunLockResponse interface.
+ */
+export function instanceOfRunLockResponse(value: object): value is RunLockResponse {
+    if (!('runId' in value) || value['runId'] === undefined) return false;
+    if (!('lockUserId' in value) || value['lockUserId'] === undefined) return false;
+    if (!('lockAcquiredAt' in value) || value['lockAcquiredAt'] === undefined) return false;
+    return true;
+}
+
+export function RunLockResponseFromJSON(json: any): RunLockResponse {
+    return RunLockResponseFromJSONTyped(json, false);
+}
+
+export function RunLockResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunLockResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'runId': json['run_id'],
+        'lockUserId': json['lock_user_id'],
+        'lockAcquiredAt': (json['lock_acquired_at'] == null ? null : new Date(json['lock_acquired_at'])),
+    };
+}
+
+export function RunLockResponseToJSON(json: any): RunLockResponse {
+    return RunLockResponseToJSONTyped(json, false);
+}
+
+export function RunLockResponseToJSONTyped(value?: RunLockResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'run_id': value['runId'],
+        'lock_user_id': value['lockUserId'],
+        'lock_acquired_at': value['lockAcquiredAt'] == null ? value['lockAcquiredAt'] : value['lockAcquiredAt'].toISOString(),
+    };
+}
+

package/src/models/UpdateWorkflowDefinitionRequest.ts

@@ -29,7 +29,12 @@ import {
 } from './WorkflowRunnerType';
 
 /**
- * Full replacement (PUT semantics). All fields are required.
+ * Full replacement (PUT semantics).
+ * 
+ * ``instruction_path_part_ids``:
+ * 
+ * - ``KS_INTERNAL``: must remain ``len == 1`` (the auto-provisioned doc).
+ * - ``SELF_HOSTED``: ``len ≥ 1``; callers may swap or add documents.
  * @export
  * @interface UpdateWorkflowDefinitionRequest
  */
@@ -94,6 +99,12 @@ export interface UpdateWorkflowDefinitionRequest {
      * @memberof UpdateWorkflowDefinitionRequest
      */
     isActive?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    approvalRequired?: boolean;
 }
 
 
@@ -171,6 +182,7 @@ export function UpdateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDi
         'outputPathPartIds': json['output_path_part_ids'],
         'templatePathPartId': json['template_path_part_id'] == null ? undefined : json['template_path_part_id'],
         'isActive': json['is_active'] == null ? undefined : json['is_active'],
+        'approvalRequired': json['approval_required'] == null ? undefined : json['approval_required'],
     };
 }
 
@@ -195,6 +207,7 @@ export function UpdateWorkflowDefinitionRequestToJSONTyped(value?: UpdateWorkflo
         'output_path_part_ids': value['outputPathPartIds'],
         'template_path_part_id': value['templatePathPartId'],
         'is_active': value['isActive'],
+        'approval_required': value['approvalRequired'],
     };
 }
 

package/src/models/WorkflowDefinitionResponse.ts

@@ -100,6 +100,12 @@ export interface WorkflowDefinitionResponse {
      * @memberof WorkflowDefinitionResponse
      */
     isActive: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WorkflowDefinitionResponse
+     */
+    approvalRequired: boolean;
     /**
      * 
      * @type {Date}
@@ -148,6 +154,7 @@ export function instanceOfWorkflowDefinitionResponse(value: object): value is Wo
     if (!('outputPathPartIds' in value) || value['outputPathPartIds'] === undefined) return false;
     if (!('templatePathPartId' in value) || value['templatePathPartId'] === undefined) return false;
     if (!('isActive' in value) || value['isActive'] === undefined) return false;
+    if (!('approvalRequired' in value) || value['approvalRequired'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -174,6 +181,7 @@ export function WorkflowDefinitionResponseFromJSONTyped(json: any, ignoreDiscrim
         'outputPathPartIds': json['output_path_part_ids'],
         'templatePathPartId': json['template_path_part_id'],
         'isActive': json['is_active'],
+        'approvalRequired': json['approval_required'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -201,6 +209,7 @@ export function WorkflowDefinitionResponseToJSONTyped(value?: WorkflowDefinition
         'output_path_part_ids': value['outputPathPartIds'],
         'template_path_part_id': value['templatePathPartId'],
         'is_active': value['isActive'],
+        'approval_required': value['approvalRequired'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };