@knowledge-stack/ksapi 1.82.0 → 1.83.0

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

@@ -99,6 +99,12 @@ export interface UpdateWorkflowDefinitionRequest {
      * @memberof UpdateWorkflowDefinitionRequest
      */
     isActive?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    approvalRequired?: boolean;
 }
 
 
@@ -176,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'],
     };
 }
 
@@ -200,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(),
     };

package/src/models/WorkflowRunStatus.ts

@@ -14,13 +14,31 @@
 
 
 /**
- * Lifecycle status of a workflow run.
+ * Combined lifecycle + approval-rollup status of a workflow run.
+ * 
+ * Absorbs the prior split between ``status`` (PENDING/RUNNING/COMPLETED/
+ * FAILED) and ``approval_state`` (in_progress/awaiting_review/approved/
+ * rejected/failed). One state field per run.
+ * 
+ * Allowed transitions::
+ * 
+ *     PENDING        -> IN_PROGRESS              (agent dispatched)
+ *     IN_PROGRESS    -> COMPLETED                (workflow.approval_required=FALSE)
+ *     IN_PROGRESS    -> NEEDS_APPROVAL           (workflow.approval_required=TRUE, agent done)
+ *     NEEDS_APPROVAL -> APPROVED                 (run folder approved by reviewer)
+ *     NEEDS_APPROVAL -> REJECTED                 (run folder or any child rejected)
+ *     APPROVED       -> NEEDS_APPROVAL           (run folder unapproved)
+ *     REJECTED       -> NEEDS_APPROVAL           (rejection reversed; mutable)
+ *     any non-terminal -> FAILED                 (agent error)
  * @export
  */
 export const WorkflowRunStatus = {
     Pending: 'PENDING',
-    Running: 'RUNNING',
+    InProgress: 'IN_PROGRESS',
     Completed: 'COMPLETED',
+    NeedsApproval: 'NEEDS_APPROVAL',
+    Approved: 'APPROVED',
+    Rejected: 'REJECTED',
     Failed: 'FAILED'
 } as const;
 export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];

package/src/models/index.ts

@@ -118,6 +118,8 @@ export * from './PasswordResetRequest';
 export * from './PasswordResetWithTokenRequest';
 export * from './PathOrder';
 export * from './PathPartAncestorItem';
+export * from './PathPartApprovalDecision';
+export * from './PathPartApprovalResponse';
 export * from './PathPartResponse';
 export * from './PathPartTagsResponse';
 export * from './PermissionCapability';
@@ -127,9 +129,11 @@ export * from './PipelineStatus';
 export * from './Polygon';
 export * from './PolygonReference';
 export * from './ReferenceType';
+export * from './RejectFileRequest';
 export * from './ResolvedReferenceInput';
 export * from './ResolvedReferenceOutput';
 export * from './RootResponse';
+export * from './RunLockResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
 export * from './SearchSortOrder';