@knowledge-stack/ksapi 1.63.0 → 1.64.0

package/src/models/WorkflowRunSnapshot.ts

@@ -0,0 +1,172 @@
+/* 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 { ABCDPathSnapshot } from './ABCDPathSnapshot';
+import {
+    ABCDPathSnapshotFromJSON,
+    ABCDPathSnapshotFromJSONTyped,
+    ABCDPathSnapshotToJSON,
+    ABCDPathSnapshotToJSONTyped,
+} from './ABCDPathSnapshot';
+import type { WorkflowRunnerType } from './WorkflowRunnerType';
+import {
+    WorkflowRunnerTypeFromJSON,
+    WorkflowRunnerTypeFromJSONTyped,
+    WorkflowRunnerTypeToJSON,
+    WorkflowRunnerTypeToJSONTyped,
+} from './WorkflowRunnerType';
+
+/**
+ * Frozen ABCD configuration captured at workflow trigger time.
+ * @export
+ * @interface WorkflowRunSnapshot
+ */
+export interface WorkflowRunSnapshot {
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowRunSnapshot
+     */
+    workflowDefinitionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowRunSnapshot
+     */
+    workflowName: string;
+    /**
+     * 
+     * @type {WorkflowRunnerType}
+     * @memberof WorkflowRunSnapshot
+     */
+    runnerType: WorkflowRunnerType;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowRunSnapshot
+     */
+    userId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof WorkflowRunSnapshot
+     */
+    maxRunDurationSeconds: number;
+    /**
+     * 
+     * @type {Array<ABCDPathSnapshot>}
+     * @memberof WorkflowRunSnapshot
+     */
+    sources: Array<ABCDPathSnapshot>;
+    /**
+     * 
+     * @type {Array<ABCDPathSnapshot>}
+     * @memberof WorkflowRunSnapshot
+     */
+    instructions: Array<ABCDPathSnapshot>;
+    /**
+     * 
+     * @type {Array<ABCDPathSnapshot>}
+     * @memberof WorkflowRunSnapshot
+     */
+    outputs: Array<ABCDPathSnapshot>;
+    /**
+     * 
+     * @type {ABCDPathSnapshot}
+     * @memberof WorkflowRunSnapshot
+     */
+    template: ABCDPathSnapshot;
+}
+
+
+
+/**
+ * Check if a given object implements the WorkflowRunSnapshot interface.
+ */
+export function instanceOfWorkflowRunSnapshot(value: object): value is WorkflowRunSnapshot {
+    if (!('workflowDefinitionId' in value) || value['workflowDefinitionId'] === undefined) return false;
+    if (!('workflowName' in value) || value['workflowName'] === undefined) return false;
+    if (!('runnerType' in value) || value['runnerType'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('maxRunDurationSeconds' in value) || value['maxRunDurationSeconds'] === undefined) return false;
+    if (!('sources' in value) || value['sources'] === undefined) return false;
+    if (!('instructions' in value) || value['instructions'] === undefined) return false;
+    if (!('outputs' in value) || value['outputs'] === undefined) return false;
+    if (!('template' in value) || value['template'] === undefined) return false;
+    return true;
+}
+
+export function WorkflowRunSnapshotFromJSON(json: any): WorkflowRunSnapshot {
+    return WorkflowRunSnapshotFromJSONTyped(json, false);
+}
+
+export function WorkflowRunSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunSnapshot {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'workflowDefinitionId': json['workflow_definition_id'],
+        'workflowName': json['workflow_name'],
+        'runnerType': WorkflowRunnerTypeFromJSON(json['runner_type']),
+        'userId': json['user_id'],
+        'maxRunDurationSeconds': json['max_run_duration_seconds'],
+        'sources': ((json['sources'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
+        'instructions': ((json['instructions'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
+        'outputs': ((json['outputs'] as Array<any>).map(ABCDPathSnapshotFromJSON)),
+        'template': ABCDPathSnapshotFromJSON(json['template']),
+    };
+}
+
+export function WorkflowRunSnapshotToJSON(json: any): WorkflowRunSnapshot {
+    return WorkflowRunSnapshotToJSONTyped(json, false);
+}
+
+export function WorkflowRunSnapshotToJSONTyped(value?: WorkflowRunSnapshot | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'workflow_definition_id': value['workflowDefinitionId'],
+        'workflow_name': value['workflowName'],
+        'runner_type': WorkflowRunnerTypeToJSON(value['runnerType']),
+        'user_id': value['userId'],
+        'max_run_duration_seconds': value['maxRunDurationSeconds'],
+        'sources': ((value['sources'] as Array<any>).map(ABCDPathSnapshotToJSON)),
+        'instructions': ((value['instructions'] as Array<any>).map(ABCDPathSnapshotToJSON)),
+        'outputs': ((value['outputs'] as Array<any>).map(ABCDPathSnapshotToJSON)),
+        'template': ABCDPathSnapshotToJSON(value['template']),
+    };
+}
+
+export const WorkflowRunSnapshotPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+

package/src/models/WorkflowRunStatus.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+
+/**
+ * Lifecycle status of a workflow run.
+ * @export
+ */
+export const WorkflowRunStatus = {
+    Pending: 'PENDING',
+    Running: 'RUNNING',
+    Completed: 'COMPLETED',
+    Failed: 'FAILED'
+} as const;
+export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];
+
+
+export function instanceOfWorkflowRunStatus(value: any): boolean {
+    for (const key in WorkflowRunStatus) {
+        if (Object.prototype.hasOwnProperty.call(WorkflowRunStatus, key)) {
+            if (WorkflowRunStatus[key as keyof typeof WorkflowRunStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function WorkflowRunStatusFromJSON(json: any): WorkflowRunStatus {
+    return WorkflowRunStatusFromJSONTyped(json, false);
+}
+
+export function WorkflowRunStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunStatus {
+    return json as WorkflowRunStatus;
+}
+
+export function WorkflowRunStatusToJSON(value?: WorkflowRunStatus | null): any {
+    return value as any;
+}
+
+export function WorkflowRunStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowRunStatus {
+    return value as WorkflowRunStatus;
+}
+

package/src/models/WorkflowRunnerType.ts

@@ -0,0 +1,52 @@
+/* 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.
+ */
+
+
+/**
+ * Runner that executes the workflow.
+ * @export
+ */
+export const WorkflowRunnerType = {
+    SelfHosted: 'SELF_HOSTED'
+} as const;
+export type WorkflowRunnerType = typeof WorkflowRunnerType[keyof typeof WorkflowRunnerType];
+
+
+export function instanceOfWorkflowRunnerType(value: any): boolean {
+    for (const key in WorkflowRunnerType) {
+        if (Object.prototype.hasOwnProperty.call(WorkflowRunnerType, key)) {
+            if (WorkflowRunnerType[key as keyof typeof WorkflowRunnerType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function WorkflowRunnerTypeFromJSON(json: any): WorkflowRunnerType {
+    return WorkflowRunnerTypeFromJSONTyped(json, false);
+}
+
+export function WorkflowRunnerTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunnerType {
+    return json as WorkflowRunnerType;
+}
+
+export function WorkflowRunnerTypeToJSON(value?: WorkflowRunnerType | null): any {
+    return value as any;
+}
+
+export function WorkflowRunnerTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowRunnerType {
+    return value as WorkflowRunnerType;
+}
+

package/src/models/index.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './ABCDPathSnapshot';
 export * from './AcceptInviteResponse';
 export * from './AddMemberRequest';
 export * from './AncestryResponse';
@@ -35,6 +36,7 @@ export * from './CreateTagRequest';
 export * from './CreateTenantRequest';
 export * from './CreateThreadMessageRequest';
 export * from './CreateThreadRequest';
+export * from './CreateWorkflowDefinitionRequest';
 export * from './DissolveSectionResponse';
 export * from './DocumentOrigin';
 export * from './DocumentResponse';
@@ -70,6 +72,7 @@ export * from './IngestionMode';
 export * from './InviteResponse';
 export * from './InviteStatus';
 export * from './InviteUserRequest';
+export * from './InvokeWorkflowRequest';
 export * from './LineageEdgeResponse';
 export * from './LineageGraphResponse';
 export * from './LineageNodeResponse';
@@ -95,6 +98,8 @@ export * from './PaginatedResponseTenantResponse';
 export * from './PaginatedResponseTenantUserResponse';
 export * from './PaginatedResponseThreadMessageResponse';
 export * from './PaginatedResponseThreadResponse';
+export * from './PaginatedResponseWorkflowDefinitionResponse';
+export * from './PaginatedResponseWorkflowRunResponse';
 export * from './PaginatedResponseWorkflowSummaryResponse';
 export * from './PartType';
 export * from './PasswordResetRequest';
@@ -122,6 +127,8 @@ export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';
 export * from './SectionSystemMetadata';
+export * from './SelfHostedRunnerConfig';
+export * from './SelfHostedRunnerConfigResponse';
 export * from './SignInRequest';
 export * from './StepInput';
 export * from './StepKind';
@@ -156,12 +163,20 @@ export * from './UpdateTagRequest';
 export * from './UpdateTenantRequest';
 export * from './UpdateThreadRequest';
 export * from './UpdateUserRequest';
+export * from './UpdateWorkflowDefinitionRequest';
 export * from './UserMessageRequest';
 export * from './UserMessageResponse';
 export * from './UserResponse';
 export * from './ValidationError';
 export * from './VersionChunkIdsResponse';
 export * from './WorkflowActionResponse';
+export * from './WorkflowCallbackResponse';
 export * from './WorkflowCancelResponse';
+export * from './WorkflowDefinitionResponse';
 export * from './WorkflowDetailResponse';
+export * from './WorkflowRunCallbackRequest';
+export * from './WorkflowRunResponse';
+export * from './WorkflowRunSnapshot';
+export * from './WorkflowRunStatus';
+export * from './WorkflowRunnerType';
 export * from './WorkflowSummaryResponse';