@knowledge-stack/ksapi 1.66.2 → 1.67.0

package/dist/esm/models/WorkflowDetailResponse.d.ts

@@ -0,0 +1,138 @@
+/**
+ * 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 type { PipelineStatus } from './PipelineStatus';
+/**
+ * Single item - adds live Temporal fields.
+ * @export
+ * @interface WorkflowDetailResponse
+ */
+export interface WorkflowDetailResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    workflowId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    documentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    documentVersionId: string;
+    /**
+     *
+     * @type {PipelineStatus}
+     * @memberof WorkflowDetailResponse
+     */
+    status: PipelineStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    lastActivity?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    error?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowDetailResponse
+     */
+    lastRunTimestamp: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowDetailResponse
+     */
+    lastStateUpdateTimestamp?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowDetailResponse
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    temporalStatus: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowDetailResponse
+     */
+    startTime: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowDetailResponse
+     */
+    closeTime?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    workflowType: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    taskQueue: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowDetailResponse
+     */
+    runId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof WorkflowDetailResponse
+     */
+    chunksProcessed?: number | null;
+}
+export declare const WorkflowDetailResponsePropertyValidationAttributesMap: {
+    [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 WorkflowDetailResponse interface.
+ */
+export declare function instanceOfWorkflowDetailResponse(value: object): value is WorkflowDetailResponse;
+export declare function WorkflowDetailResponseFromJSON(json: any): WorkflowDetailResponse;
+export declare function WorkflowDetailResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowDetailResponse;
+export declare function WorkflowDetailResponseToJSON(json: any): WorkflowDetailResponse;
+export declare function WorkflowDetailResponseToJSONTyped(value?: WorkflowDetailResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WorkflowDetailResponse.js

@@ -0,0 +1,95 @@
+/* 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 { PipelineStatusFromJSON, PipelineStatusToJSON, } from './PipelineStatus';
+export const WorkflowDetailResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the WorkflowDetailResponse interface.
+ */
+export function instanceOfWorkflowDetailResponse(value) {
+    if (!('workflowId' in value) || value['workflowId'] === undefined)
+        return false;
+    if (!('documentId' in value) || value['documentId'] === undefined)
+        return false;
+    if (!('documentVersionId' in value) || value['documentVersionId'] === 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;
+    if (!('temporalStatus' in value) || value['temporalStatus'] === undefined)
+        return false;
+    if (!('startTime' in value) || value['startTime'] === undefined)
+        return false;
+    if (!('workflowType' in value) || value['workflowType'] === undefined)
+        return false;
+    if (!('taskQueue' in value) || value['taskQueue'] === undefined)
+        return false;
+    if (!('runId' in value) || value['runId'] === undefined)
+        return false;
+    return true;
+}
+export function WorkflowDetailResponseFromJSON(json) {
+    return WorkflowDetailResponseFromJSONTyped(json, false);
+}
+export function WorkflowDetailResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'workflowId': json['workflow_id'],
+        'documentId': json['document_id'],
+        'documentVersionId': json['document_version_id'],
+        'status': PipelineStatusFromJSON(json['status']),
+        'lastActivity': json['last_activity'] == null ? undefined : json['last_activity'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'lastRunTimestamp': (new Date(json['last_run_timestamp'])),
+        'lastStateUpdateTimestamp': json['last_state_update_timestamp'] == null ? undefined : (new Date(json['last_state_update_timestamp'])),
+        'createdAt': (new Date(json['created_at'])),
+        'temporalStatus': json['temporal_status'],
+        'startTime': (new Date(json['start_time'])),
+        'closeTime': json['close_time'] == null ? undefined : (new Date(json['close_time'])),
+        'workflowType': json['workflow_type'],
+        'taskQueue': json['task_queue'],
+        'runId': json['run_id'],
+        'chunksProcessed': json['chunks_processed'] == null ? undefined : json['chunks_processed'],
+    };
+}
+export function WorkflowDetailResponseToJSON(json) {
+    return WorkflowDetailResponseToJSONTyped(json, false);
+}
+export function WorkflowDetailResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'workflow_id': value['workflowId'],
+        'document_id': value['documentId'],
+        'document_version_id': value['documentVersionId'],
+        'status': PipelineStatusToJSON(value['status']),
+        'last_activity': value['lastActivity'],
+        'error': value['error'],
+        'last_run_timestamp': value['lastRunTimestamp'].toISOString(),
+        'last_state_update_timestamp': value['lastStateUpdateTimestamp'] == null ? value['lastStateUpdateTimestamp'] : value['lastStateUpdateTimestamp'].toISOString(),
+        'created_at': value['createdAt'].toISOString(),
+        'temporal_status': value['temporalStatus'],
+        'start_time': value['startTime'].toISOString(),
+        'close_time': value['closeTime'] == null ? value['closeTime'] : value['closeTime'].toISOString(),
+        'workflow_type': value['workflowType'],
+        'task_queue': value['taskQueue'],
+        'run_id': value['runId'],
+        'chunks_processed': value['chunksProcessed'],
+    };
+}

package/dist/esm/models/WorkflowRunCallbackRequest.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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.
+ */
+/**
+ * Request body for the runner callback endpoint.
+ * @export
+ * @interface WorkflowRunCallbackRequest
+ */
+export interface WorkflowRunCallbackRequest {
+    /**
+     *
+     * @type {WorkflowRunCallbackRequestStatusEnum}
+     * @memberof WorkflowRunCallbackRequest
+     */
+    status: WorkflowRunCallbackRequestStatusEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowRunCallbackRequest
+     */
+    error?: string | null;
+}
+/**
+ * @export
+ */
+export declare const WorkflowRunCallbackRequestStatusEnum: {
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+};
+export type WorkflowRunCallbackRequestStatusEnum = typeof WorkflowRunCallbackRequestStatusEnum[keyof typeof WorkflowRunCallbackRequestStatusEnum];
+export declare const WorkflowRunCallbackRequestPropertyValidationAttributesMap: {
+    [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 WorkflowRunCallbackRequest interface.
+ */
+export declare function instanceOfWorkflowRunCallbackRequest(value: object): value is WorkflowRunCallbackRequest;
+export declare function WorkflowRunCallbackRequestFromJSON(json: any): WorkflowRunCallbackRequest;
+export declare function WorkflowRunCallbackRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunCallbackRequest;
+export declare function WorkflowRunCallbackRequestToJSON(json: any): WorkflowRunCallbackRequest;
+export declare function WorkflowRunCallbackRequestToJSONTyped(value?: WorkflowRunCallbackRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WorkflowRunCallbackRequest.js

@@ -0,0 +1,57 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const WorkflowRunCallbackRequestStatusEnum = {
+    Completed: 'COMPLETED',
+    Failed: 'FAILED'
+};
+export const WorkflowRunCallbackRequestPropertyValidationAttributesMap = {
+    error: {
+        maxLength: 8192,
+    },
+};
+/**
+ * Check if a given object implements the WorkflowRunCallbackRequest interface.
+ */
+export function instanceOfWorkflowRunCallbackRequest(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function WorkflowRunCallbackRequestFromJSON(json) {
+    return WorkflowRunCallbackRequestFromJSONTyped(json, false);
+}
+export function WorkflowRunCallbackRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+export function WorkflowRunCallbackRequestToJSON(json) {
+    return WorkflowRunCallbackRequestToJSONTyped(json, false);
+}
+export function WorkflowRunCallbackRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'error': value['error'],
+    };
+}

package/dist/esm/models/WorkflowRunResponse.d.ts

@@ -0,0 +1,110 @@
+/**
+ * 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 type { WorkflowRunSnapshot } from './WorkflowRunSnapshot';
+import type { WorkflowRunStatus } from './WorkflowRunStatus';
+import type { WorkflowRunnerType } from './WorkflowRunnerType';
+/**
+ * Workflow run response.
+ * @export
+ * @interface WorkflowRunResponse
+ */
+export interface WorkflowRunResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    workflowDefinitionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    userId: string;
+    /**
+     *
+     * @type {WorkflowRunnerType}
+     * @memberof WorkflowRunResponse
+     */
+    runnerType: WorkflowRunnerType;
+    /**
+     *
+     * @type {WorkflowRunStatus}
+     * @memberof WorkflowRunResponse
+     */
+    status: WorkflowRunStatus;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowRunResponse
+     */
+    startedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowRunResponse
+     */
+    completedAt: Date | null;
+    /**
+     *
+     * @type {WorkflowRunSnapshot}
+     * @memberof WorkflowRunResponse
+     */
+    runSnapshot: WorkflowRunSnapshot;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    error: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowRunResponse
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowRunResponse
+     */
+    updatedAt: Date;
+}
+export declare const WorkflowRunResponsePropertyValidationAttributesMap: {
+    [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 WorkflowRunResponse interface.
+ */
+export declare function instanceOfWorkflowRunResponse(value: object): value is WorkflowRunResponse;
+export declare function WorkflowRunResponseFromJSON(json: any): WorkflowRunResponse;
+export declare function WorkflowRunResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunResponse;
+export declare function WorkflowRunResponseToJSON(json: any): WorkflowRunResponse;
+export declare function WorkflowRunResponseToJSONTyped(value?: WorkflowRunResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WorkflowRunResponse.js

@@ -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 { WorkflowRunSnapshotFromJSON, WorkflowRunSnapshotToJSON, } from './WorkflowRunSnapshot';
+import { WorkflowRunStatusFromJSON, WorkflowRunStatusToJSON, } from './WorkflowRunStatus';
+import { WorkflowRunnerTypeFromJSON, WorkflowRunnerTypeToJSON, } from './WorkflowRunnerType';
+export const WorkflowRunResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the WorkflowRunResponse interface.
+ */
+export function instanceOfWorkflowRunResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('workflowDefinitionId' in value) || value['workflowDefinitionId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('runnerType' in value) || value['runnerType'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('startedAt' in value) || value['startedAt'] === undefined)
+        return false;
+    if (!('completedAt' in value) || value['completedAt'] === undefined)
+        return false;
+    if (!('runSnapshot' in value) || value['runSnapshot'] === undefined)
+        return false;
+    if (!('error' in value) || value['error'] === 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 WorkflowRunResponseFromJSON(json) {
+    return WorkflowRunResponseFromJSONTyped(json, false);
+}
+export function WorkflowRunResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'workflowDefinitionId': json['workflow_definition_id'],
+        'userId': json['user_id'],
+        'runnerType': WorkflowRunnerTypeFromJSON(json['runner_type']),
+        'status': WorkflowRunStatusFromJSON(json['status']),
+        'startedAt': (new Date(json['started_at'])),
+        'completedAt': (json['completed_at'] == null ? null : new Date(json['completed_at'])),
+        'runSnapshot': WorkflowRunSnapshotFromJSON(json['run_snapshot']),
+        'error': json['error'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+export function WorkflowRunResponseToJSON(json) {
+    return WorkflowRunResponseToJSONTyped(json, false);
+}
+export function WorkflowRunResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'workflow_definition_id': value['workflowDefinitionId'],
+        'user_id': value['userId'],
+        'runner_type': WorkflowRunnerTypeToJSON(value['runnerType']),
+        'status': WorkflowRunStatusToJSON(value['status']),
+        'started_at': value['startedAt'].toISOString(),
+        'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+        'run_snapshot': WorkflowRunSnapshotToJSON(value['runSnapshot']),
+        'error': value['error'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}

package/dist/esm/models/WorkflowRunSnapshot.d.ts

@@ -0,0 +1,97 @@
+/**
+ * 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 type { ABCDPathSnapshot } from './ABCDPathSnapshot';
+import type { WorkflowRunnerType } 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;
+}
+export declare 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;
+    };
+};
+/**
+ * Check if a given object implements the WorkflowRunSnapshot interface.
+ */
+export declare function instanceOfWorkflowRunSnapshot(value: object): value is WorkflowRunSnapshot;
+export declare function WorkflowRunSnapshotFromJSON(json: any): WorkflowRunSnapshot;
+export declare function WorkflowRunSnapshotFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunSnapshot;
+export declare function WorkflowRunSnapshotToJSON(json: any): WorkflowRunSnapshot;
+export declare function WorkflowRunSnapshotToJSONTyped(value?: WorkflowRunSnapshot | null, ignoreDiscriminator?: boolean): any;