@knowledge-stack/ksapi 1.81.0 → 1.83.0

package/dist/models/RejectFileRequest.js

@@ -0,0 +1,57 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RejectFileRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfRejectFileRequest = instanceOfRejectFileRequest;
+exports.RejectFileRequestFromJSON = RejectFileRequestFromJSON;
+exports.RejectFileRequestFromJSONTyped = RejectFileRequestFromJSONTyped;
+exports.RejectFileRequestToJSON = RejectFileRequestToJSON;
+exports.RejectFileRequestToJSONTyped = RejectFileRequestToJSONTyped;
+exports.RejectFileRequestPropertyValidationAttributesMap = {
+    reason: {
+        maxLength: 2048,
+        minLength: 1,
+    },
+};
+/**
+ * Check if a given object implements the RejectFileRequest interface.
+ */
+function instanceOfRejectFileRequest(value) {
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+function RejectFileRequestFromJSON(json) {
+    return RejectFileRequestFromJSONTyped(json, false);
+}
+function RejectFileRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reason': json['reason'],
+    };
+}
+function RejectFileRequestToJSON(json) {
+    return RejectFileRequestToJSONTyped(json, false);
+}
+function RejectFileRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'reason': value['reason'],
+    };
+}

package/dist/models/RunLockResponse.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare 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 declare function instanceOfRunLockResponse(value: object): value is RunLockResponse;
+export declare function RunLockResponseFromJSON(json: any): RunLockResponse;
+export declare function RunLockResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RunLockResponse;
+export declare function RunLockResponseToJSON(json: any): RunLockResponse;
+export declare function RunLockResponseToJSONTyped(value?: RunLockResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/RunLockResponse.js

@@ -0,0 +1,60 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RunLockResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfRunLockResponse = instanceOfRunLockResponse;
+exports.RunLockResponseFromJSON = RunLockResponseFromJSON;
+exports.RunLockResponseFromJSONTyped = RunLockResponseFromJSONTyped;
+exports.RunLockResponseToJSON = RunLockResponseToJSON;
+exports.RunLockResponseToJSONTyped = RunLockResponseToJSONTyped;
+exports.RunLockResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the RunLockResponse interface.
+ */
+function instanceOfRunLockResponse(value) {
+    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;
+}
+function RunLockResponseFromJSON(json) {
+    return RunLockResponseFromJSONTyped(json, false);
+}
+function RunLockResponseFromJSONTyped(json, ignoreDiscriminator) {
+    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'])),
+    };
+}
+function RunLockResponseToJSON(json) {
+    return RunLockResponseToJSONTyped(json, false);
+}
+function RunLockResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/UpdateWorkflowDefinitionRequest.d.ts

@@ -12,7 +12,12 @@
 import type { SelfHostedRunnerConfig } from './SelfHostedRunnerConfig';
 import type { WorkflowRunnerType } 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
  */
@@ -77,6 +82,12 @@ export interface UpdateWorkflowDefinitionRequest {
      * @memberof UpdateWorkflowDefinitionRequest
      */
     isActive?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    approvalRequired?: boolean;
 }
 export declare const UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/UpdateWorkflowDefinitionRequest.js

@@ -81,6 +81,7 @@ function UpdateWorkflowDefinitionRequestFromJSONTyped(json, ignoreDiscriminator)
         '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'],
     };
 }
 function UpdateWorkflowDefinitionRequestToJSON(json) {
@@ -101,5 +102,6 @@ function UpdateWorkflowDefinitionRequestToJSONTyped(value, ignoreDiscriminator =
         'output_path_part_ids': value['outputPathPartIds'],
         'template_path_part_id': value['templatePathPartId'],
         'is_active': value['isActive'],
+        'approval_required': value['approvalRequired'],
     };
 }

package/dist/models/WorkflowDefinitionResponse.d.ts

@@ -83,6 +83,12 @@ export interface WorkflowDefinitionResponse {
      * @memberof WorkflowDefinitionResponse
      */
     isActive: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof WorkflowDefinitionResponse
+     */
+    approvalRequired: boolean;
     /**
      *
      * @type {Date}

package/dist/models/WorkflowDefinitionResponse.js

@@ -48,6 +48,8 @@ function instanceOfWorkflowDefinitionResponse(value) {
         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)
@@ -73,6 +75,7 @@ function WorkflowDefinitionResponseFromJSONTyped(json, ignoreDiscriminator) {
         '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'])),
     };
@@ -96,6 +99,7 @@ function WorkflowDefinitionResponseToJSONTyped(value, ignoreDiscriminator = fals
         '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/dist/models/WorkflowRunResponse.d.ts

@@ -14,6 +14,11 @@ import type { WorkflowRunStatus } from './WorkflowRunStatus';
 import type { WorkflowRunnerType } from './WorkflowRunnerType';
 /**
  * Workflow run response.
+ *
+ * Note: ``run_token_jti`` is intentionally NOT exposed. It's an
+ * internal token identifier persisted on the run row for callback
+ * auth — clients should treat run dispatch state as observable via
+ * ``status`` (RUNNING => dispatched), not via JTI presence.
  * @export
  * @interface WorkflowRunResponse
  */
@@ -72,6 +77,18 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     error: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof WorkflowRunResponse
+     */
+    inputPathPartIds: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof WorkflowRunResponse
+     */
+    inputVersionIds: Array<string>;
     /**
      *
      * @type {Date}

package/dist/models/WorkflowRunResponse.js

@@ -45,6 +45,10 @@ function instanceOfWorkflowRunResponse(value) {
         return false;
     if (!('error' in value) || value['error'] === undefined)
         return false;
+    if (!('inputPathPartIds' in value) || value['inputPathPartIds'] === undefined)
+        return false;
+    if (!('inputVersionIds' in value) || value['inputVersionIds'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -68,6 +72,8 @@ function WorkflowRunResponseFromJSONTyped(json, ignoreDiscriminator) {
         'completedAt': (json['completed_at'] == null ? null : new Date(json['completed_at'])),
         'runSnapshot': (0, WorkflowRunSnapshot_1.WorkflowRunSnapshotFromJSON)(json['run_snapshot']),
         'error': json['error'],
+        'inputPathPartIds': json['input_path_part_ids'],
+        'inputVersionIds': json['input_version_ids'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -89,6 +95,8 @@ function WorkflowRunResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
         'run_snapshot': (0, WorkflowRunSnapshot_1.WorkflowRunSnapshotToJSON)(value['runSnapshot']),
         'error': value['error'],
+        'input_path_part_ids': value['inputPathPartIds'],
+        'input_version_ids': value['inputVersionIds'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/dist/models/WorkflowRunSnapshot.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { ABCDPathSnapshot } from './ABCDPathSnapshot';
+import type { InstructionSnapshot } from './InstructionSnapshot';
 import type { WorkflowRunnerType } from './WorkflowRunnerType';
 /**
  * Frozen ABCD configuration captured at workflow trigger time.
@@ -55,10 +56,10 @@ export interface WorkflowRunSnapshot {
     sources: Array<ABCDPathSnapshot>;
     /**
      *
-     * @type {Array<ABCDPathSnapshot>}
+     * @type {Array<InstructionSnapshot>}
      * @memberof WorkflowRunSnapshot
      */
-    instructions: Array<ABCDPathSnapshot>;
+    instructions: Array<InstructionSnapshot>;
     /**
      *
      * @type {Array<ABCDPathSnapshot>}

package/dist/models/WorkflowRunSnapshot.js

@@ -20,6 +20,7 @@ exports.WorkflowRunSnapshotFromJSONTyped = WorkflowRunSnapshotFromJSONTyped;
 exports.WorkflowRunSnapshotToJSON = WorkflowRunSnapshotToJSON;
 exports.WorkflowRunSnapshotToJSONTyped = WorkflowRunSnapshotToJSONTyped;
 const ABCDPathSnapshot_1 = require("./ABCDPathSnapshot");
+const InstructionSnapshot_1 = require("./InstructionSnapshot");
 const WorkflowRunnerType_1 = require("./WorkflowRunnerType");
 exports.WorkflowRunSnapshotPropertyValidationAttributesMap = {};
 /**
@@ -60,7 +61,7 @@ function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
         'userId': json['user_id'],
         'maxRunDurationSeconds': json['max_run_duration_seconds'],
         'sources': (json['sources'].map(ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)),
-        'instructions': (json['instructions'].map(ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)),
+        'instructions': (json['instructions'].map(InstructionSnapshot_1.InstructionSnapshotFromJSON)),
         'outputs': (json['outputs'].map(ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)),
         'template': (0, ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)(json['template']),
     };
@@ -79,7 +80,7 @@ function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
         'user_id': value['userId'],
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
         'sources': (value['sources'].map(ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)),
-        'instructions': (value['instructions'].map(ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)),
+        'instructions': (value['instructions'].map(InstructionSnapshot_1.InstructionSnapshotToJSON)),
         'outputs': (value['outputs'].map(ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)),
         'template': (0, ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)(value['template']),
     };

package/dist/models/WorkflowRunStatus.d.ts

@@ -10,13 +10,31 @@
  * Do not edit the class manually.
  */
 /**
- * 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 declare const WorkflowRunStatus: {
     readonly Pending: "PENDING";
-    readonly Running: "RUNNING";
+    readonly InProgress: "IN_PROGRESS";
     readonly Completed: "COMPLETED";
+    readonly NeedsApproval: "NEEDS_APPROVAL";
+    readonly Approved: "APPROVED";
+    readonly Rejected: "REJECTED";
     readonly Failed: "FAILED";
 };
 export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];

package/dist/models/WorkflowRunStatus.js

@@ -20,13 +20,31 @@ exports.WorkflowRunStatusFromJSONTyped = WorkflowRunStatusFromJSONTyped;
 exports.WorkflowRunStatusToJSON = WorkflowRunStatusToJSON;
 exports.WorkflowRunStatusToJSONTyped = WorkflowRunStatusToJSONTyped;
 /**
- * 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
  */
 exports.WorkflowRunStatus = {
     Pending: 'PENDING',
-    Running: 'RUNNING',
+    InProgress: 'IN_PROGRESS',
     Completed: 'COMPLETED',
+    NeedsApproval: 'NEEDS_APPROVAL',
+    Approved: 'APPROVED',
+    Rejected: 'REJECTED',
     Failed: 'FAILED'
 };
 function instanceOfWorkflowRunStatus(value) {

package/dist/models/WorkflowRunnerType.d.ts

@@ -15,6 +15,7 @@
  */
 export declare const WorkflowRunnerType: {
     readonly SelfHosted: "SELF_HOSTED";
+    readonly KsInternal: "KS_INTERNAL";
 };
 export type WorkflowRunnerType = typeof WorkflowRunnerType[keyof typeof WorkflowRunnerType];
 export declare function instanceOfWorkflowRunnerType(value: any): boolean;

package/dist/models/WorkflowRunnerType.js

@@ -24,7 +24,8 @@ exports.WorkflowRunnerTypeToJSONTyped = WorkflowRunnerTypeToJSONTyped;
  * @export
  */
 exports.WorkflowRunnerType = {
-    SelfHosted: 'SELF_HOSTED'
+    SelfHosted: 'SELF_HOSTED',
+    KsInternal: 'KS_INTERNAL'
 };
 function instanceOfWorkflowRunnerType(value) {
     for (const key in exports.WorkflowRunnerType) {

package/dist/models/index.d.ts

@@ -74,6 +74,7 @@ export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
 export * from './IngestionMode';
+export * from './InstructionSnapshot';
 export * from './InviteLinkSettingsRequest';
 export * from './InviteLinkSettingsResponse';
 export * from './InviteResponse';
@@ -115,6 +116,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';
@@ -124,9 +127,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';

package/dist/models/index.js

@@ -92,6 +92,7 @@ __exportStar(require("./ImageTaxonomy"), exports);
 __exportStar(require("./InformationStatistics"), exports);
 __exportStar(require("./IngestDocumentResponse"), exports);
 __exportStar(require("./IngestionMode"), exports);
+__exportStar(require("./InstructionSnapshot"), exports);
 __exportStar(require("./InviteLinkSettingsRequest"), exports);
 __exportStar(require("./InviteLinkSettingsResponse"), exports);
 __exportStar(require("./InviteResponse"), exports);
@@ -133,6 +134,8 @@ __exportStar(require("./PasswordResetRequest"), exports);
 __exportStar(require("./PasswordResetWithTokenRequest"), exports);
 __exportStar(require("./PathOrder"), exports);
 __exportStar(require("./PathPartAncestorItem"), exports);
+__exportStar(require("./PathPartApprovalDecision"), exports);
+__exportStar(require("./PathPartApprovalResponse"), exports);
 __exportStar(require("./PathPartResponse"), exports);
 __exportStar(require("./PathPartTagsResponse"), exports);
 __exportStar(require("./PermissionCapability"), exports);
@@ -142,9 +145,11 @@ __exportStar(require("./PipelineStatus"), exports);
 __exportStar(require("./Polygon"), exports);
 __exportStar(require("./PolygonReference"), exports);
 __exportStar(require("./ReferenceType"), exports);
+__exportStar(require("./RejectFileRequest"), exports);
 __exportStar(require("./ResolvedReferenceInput"), exports);
 __exportStar(require("./ResolvedReferenceOutput"), exports);
 __exportStar(require("./RootResponse"), exports);
+__exportStar(require("./RunLockResponse"), exports);
 __exportStar(require("./SSOInitiateResponse"), exports);
 __exportStar(require("./ScoredChunkResponse"), exports);
 __exportStar(require("./SearchSortOrder"), exports);

package/docs/CreateWorkflowDefinitionRequest.md

@@ -1,7 +1,7 @@
 
 # CreateWorkflowDefinitionRequest
 
-Create a new workflow definition.
+Create a new workflow definition.  ``instruction_path_part_ids`` semantics depend on ``runner_type``:  - ``KS_INTERNAL``: must be empty (``[]``); the server auto-provisions a   single ``instruction.md`` and stores ``[doc.path_part_id]``. - ``SELF_HOSTED``: caller-supplied list of one-or-more document   PathPart IDs. Must contain at least one entry.
 
 ## Properties
 
@@ -16,6 +16,7 @@ Name | Type
 `instructionPathPartIds` | Array<string>
 `outputPathPartIds` | Array<string>
 `templatePathPartId` | string
+`approvalRequired` | boolean
 
 ## Example
 
@@ -33,6 +34,7 @@ const example = {
   "instructionPathPartIds": null,
   "outputPathPartIds": null,
   "templatePathPartId": null,
+  "approvalRequired": null,
 } satisfies CreateWorkflowDefinitionRequest
 
 console.log(example)

package/docs/InstructionSnapshot.md

@@ -0,0 +1,41 @@
+
+# InstructionSnapshot
+
+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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pathPartId` | string
+`materializedPath` | string
+`partType` | [PartType](PartType.md)
+`documentVersionId` | string
+
+## Example
+
+```typescript
+import type { InstructionSnapshot } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pathPartId": null,
+  "materializedPath": null,
+  "partType": null,
+  "documentVersionId": null,
+} satisfies InstructionSnapshot
+
+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 InstructionSnapshot
+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/InvokeWorkflowRequest.md

@@ -8,6 +8,7 @@ Request body for invoking a workflow definition.
 Name | Type
 ------------ | -------------
 `idempotencyKey` | string
+`inputPathPartIds` | Array<string>
 
 ## Example
 
@@ -17,6 +18,7 @@ import type { InvokeWorkflowRequest } from '@knowledge-stack/ksapi'
 // TODO: Update the object below with actual values
 const example = {
   "idempotencyKey": null,
+  "inputPathPartIds": null,
 } satisfies InvokeWorkflowRequest
 
 console.log(example)

package/docs/PathPartApprovalDecision.md

@@ -0,0 +1,33 @@
+
+# PathPartApprovalDecision
+
+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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PathPartApprovalDecision } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PathPartApprovalDecision
+
+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 PathPartApprovalDecision
+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)
+
+