@knowledge-stack/ksapi 1.66.2 → 1.67.0

package/dist/esm/models/WorkflowRunSnapshot.js

@@ -0,0 +1,78 @@
+/* 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 { ABCDPathSnapshotFromJSON, ABCDPathSnapshotToJSON, } from './ABCDPathSnapshot';
+import { WorkflowRunnerTypeFromJSON, WorkflowRunnerTypeToJSON, } from './WorkflowRunnerType';
+export const WorkflowRunSnapshotPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the WorkflowRunSnapshot interface.
+ */
+export function instanceOfWorkflowRunSnapshot(value) {
+    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) {
+    return WorkflowRunSnapshotFromJSONTyped(json, false);
+}
+export function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
+    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'].map(ABCDPathSnapshotFromJSON)),
+        'instructions': (json['instructions'].map(ABCDPathSnapshotFromJSON)),
+        'outputs': (json['outputs'].map(ABCDPathSnapshotFromJSON)),
+        'template': ABCDPathSnapshotFromJSON(json['template']),
+    };
+}
+export function WorkflowRunSnapshotToJSON(json) {
+    return WorkflowRunSnapshotToJSONTyped(json, false);
+}
+export function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
+    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'].map(ABCDPathSnapshotToJSON)),
+        'instructions': (value['instructions'].map(ABCDPathSnapshotToJSON)),
+        'outputs': (value['outputs'].map(ABCDPathSnapshotToJSON)),
+        'template': ABCDPathSnapshotToJSON(value['template']),
+    };
+}

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

@@ -0,0 +1,27 @@
+/**
+ * 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 declare const WorkflowRunStatus: {
+    readonly Pending: "PENDING";
+    readonly Running: "RUNNING";
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+};
+export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];
+export declare function instanceOfWorkflowRunStatus(value: any): boolean;
+export declare function WorkflowRunStatusFromJSON(json: any): WorkflowRunStatus;
+export declare function WorkflowRunStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunStatus;
+export declare function WorkflowRunStatusToJSON(value?: WorkflowRunStatus | null): any;
+export declare function WorkflowRunStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowRunStatus;

package/dist/esm/models/WorkflowRunStatus.js

@@ -0,0 +1,45 @@
+/* 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'
+};
+export function instanceOfWorkflowRunStatus(value) {
+    for (const key in WorkflowRunStatus) {
+        if (Object.prototype.hasOwnProperty.call(WorkflowRunStatus, key)) {
+            if (WorkflowRunStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function WorkflowRunStatusFromJSON(json) {
+    return WorkflowRunStatusFromJSONTyped(json, false);
+}
+export function WorkflowRunStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function WorkflowRunStatusToJSON(value) {
+    return value;
+}
+export function WorkflowRunStatusToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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 declare const WorkflowRunnerType: {
+    readonly SelfHosted: "SELF_HOSTED";
+};
+export type WorkflowRunnerType = typeof WorkflowRunnerType[keyof typeof WorkflowRunnerType];
+export declare function instanceOfWorkflowRunnerType(value: any): boolean;
+export declare function WorkflowRunnerTypeFromJSON(json: any): WorkflowRunnerType;
+export declare function WorkflowRunnerTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunnerType;
+export declare function WorkflowRunnerTypeToJSON(value?: WorkflowRunnerType | null): any;
+export declare function WorkflowRunnerTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowRunnerType;

package/dist/esm/models/WorkflowRunnerType.js

@@ -0,0 +1,42 @@
+/* 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'
+};
+export function instanceOfWorkflowRunnerType(value) {
+    for (const key in WorkflowRunnerType) {
+        if (Object.prototype.hasOwnProperty.call(WorkflowRunnerType, key)) {
+            if (WorkflowRunnerType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function WorkflowRunnerTypeFromJSON(json) {
+    return WorkflowRunnerTypeFromJSONTyped(json, false);
+}
+export function WorkflowRunnerTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function WorkflowRunnerTypeToJSON(value) {
+    return value;
+}
+export function WorkflowRunnerTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,96 @@
+/**
+ * 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';
+/**
+ * List item - DB-only fields, no Temporal call per item.
+ * @export
+ * @interface WorkflowSummaryResponse
+ */
+export interface WorkflowSummaryResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowSummaryResponse
+     */
+    workflowId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowSummaryResponse
+     */
+    documentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowSummaryResponse
+     */
+    documentVersionId: string;
+    /**
+     *
+     * @type {PipelineStatus}
+     * @memberof WorkflowSummaryResponse
+     */
+    status: PipelineStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowSummaryResponse
+     */
+    lastActivity?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof WorkflowSummaryResponse
+     */
+    error?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowSummaryResponse
+     */
+    lastRunTimestamp: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowSummaryResponse
+     */
+    lastStateUpdateTimestamp?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof WorkflowSummaryResponse
+     */
+    createdAt: Date;
+}
+export declare const WorkflowSummaryResponsePropertyValidationAttributesMap: {
+    [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 WorkflowSummaryResponse interface.
+ */
+export declare function instanceOfWorkflowSummaryResponse(value: object): value is WorkflowSummaryResponse;
+export declare function WorkflowSummaryResponseFromJSON(json: any): WorkflowSummaryResponse;
+export declare function WorkflowSummaryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowSummaryResponse;
+export declare function WorkflowSummaryResponseToJSON(json: any): WorkflowSummaryResponse;
+export declare function WorkflowSummaryResponseToJSONTyped(value?: WorkflowSummaryResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/WorkflowSummaryResponse.js

@@ -0,0 +1,71 @@
+/* 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 WorkflowSummaryResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the WorkflowSummaryResponse interface.
+ */
+export function instanceOfWorkflowSummaryResponse(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;
+    return true;
+}
+export function WorkflowSummaryResponseFromJSON(json) {
+    return WorkflowSummaryResponseFromJSONTyped(json, false);
+}
+export function WorkflowSummaryResponseFromJSONTyped(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'])),
+    };
+}
+export function WorkflowSummaryResponseToJSON(json) {
+    return WorkflowSummaryResponseToJSONTyped(json, false);
+}
+export function WorkflowSummaryResponseToJSONTyped(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(),
+    };
+}

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

@@ -0,0 +1,181 @@
+export * from './ABCDPathSnapshot';
+export * from './AcceptInviteResponse';
+export * from './AddMemberRequest';
+export * from './AncestryResponse';
+export * from './ApiKeyResponse';
+export * from './Args';
+export * from './BrandingLogoType';
+export * from './BulkTagRequest';
+export * from './ChunkBulkResponse';
+export * from './ChunkContentItem';
+export * from './ChunkDocumentResponse';
+export * from './ChunkDocumentVersionResponse';
+export * from './ChunkLineageResponse';
+export * from './ChunkMetadataInput';
+export * from './ChunkMetadataOutput';
+export * from './ChunkNeighborsResponse';
+export * from './ChunkResponse';
+export * from './ChunkSearchRequest';
+export * from './ChunkType';
+export * from './Citation';
+export * from './ClearVersionContentsResponse';
+export * from './CreateApiKeyRequest';
+export * from './CreateApiKeyResponse';
+export * from './CreateChunkLineageRequest';
+export * from './CreateChunkRequest';
+export * from './CreateDocumentRequest';
+export * from './CreateFolderRequest';
+export * from './CreateGroupPermissionRequest';
+export * from './CreateGroupRequest';
+export * from './CreatePasswordUserRequest';
+export * from './CreatePermissionRequest';
+export * from './CreateSectionRequest';
+export * from './CreateTagRequest';
+export * from './CreateThreadMessageRequest';
+export * from './CreateThreadRequest';
+export * from './CreateWorkflowDefinitionRequest';
+export * from './DirectorySyncResponse';
+export * from './DissolveSectionResponse';
+export * from './DocumentOrigin';
+export * from './DocumentResponse';
+export * from './DocumentType';
+export * from './DocumentVersionAction';
+export * from './DocumentVersionActionResponse';
+export * from './DocumentVersionContentTypeFilter';
+export * from './DocumentVersionMetadata';
+export * from './DocumentVersionMetadataUpdate';
+export * from './DocumentVersionResponse';
+export * from './EmailSentResponse';
+export * from './EmailVerificationRequest';
+export * from './EnrichedCitation';
+export * from './EnrichedThreadMessageContent';
+export * from './FeaturesResponse';
+export * from './FeedbackEventResponse';
+export * from './FeedbackRating';
+export * from './FeedbackReason';
+export * from './FeedbackTargetType';
+export * from './FolderAction';
+export * from './FolderActionResponse';
+export * from './FolderResponse';
+export * from './FolderResponseOrDocumentResponse';
+export * from './GroupPermissionResponse';
+export * from './GroupResponse';
+export * from './HTTPValidationError';
+export * from './HealthCheckResponse';
+export * from './IdpConfig';
+export * from './IdpType';
+export * from './ImageTaxonomy';
+export * from './InformationStatistics';
+export * from './IngestDocumentResponse';
+export * from './IngestionMode';
+export * from './InviteResponse';
+export * from './InviteStatus';
+export * from './InviteUserRequest';
+export * from './InvokeWorkflowRequest';
+export * from './LineageEdgeResponse';
+export * from './LineageGraphResponse';
+export * from './LineageNodeResponse';
+export * from './LocationInner';
+export * from './MembershipResponse';
+export * from './MessageRole';
+export * from './NonFilesystemReferenceType';
+export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator';
+export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
+export * from './PaginatedResponseDocumentResponse';
+export * from './PaginatedResponseDocumentVersionResponse';
+export * from './PaginatedResponseFeedbackEventResponse';
+export * from './PaginatedResponseFolderResponse';
+export * from './PaginatedResponseGroupPermissionResponse';
+export * from './PaginatedResponseGroupResponse';
+export * from './PaginatedResponseInviteResponse';
+export * from './PaginatedResponseMembershipResponse';
+export * from './PaginatedResponsePathPartResponse';
+export * from './PaginatedResponsePermissionResponse';
+export * from './PaginatedResponseTagResponse';
+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';
+export * from './PasswordResetWithTokenRequest';
+export * from './PathOrder';
+export * from './PathPartAncestorItem';
+export * from './PathPartResponse';
+export * from './PathPartTagsResponse';
+export * from './PermissionCapability';
+export * from './PermissionResponse';
+export * from './PipelineState';
+export * from './PipelineStatus';
+export * from './Polygon';
+export * from './PolygonReference';
+export * from './ReferenceType';
+export * from './ResolvedReferenceInput';
+export * from './ResolvedReferenceOutput';
+export * from './RootResponse';
+export * from './SSOInitiateResponse';
+export * from './ScoredChunkResponse';
+export * from './SearchSortOrder';
+export * from './SearchType';
+export * from './SearchablePartType';
+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';
+export * from './StepOutput';
+export * from './SubmitFeedbackRequest';
+export * from './SubtreeChunkGroup';
+export * from './SubtreeChunksResponse';
+export * from './SupportedIdP';
+export * from './SupportedLanguage';
+export * from './TagResponse';
+export * from './TemporalWorkflowStatusResponse';
+export * from './TenantBrandingResponse';
+export * from './TenantResponse';
+export * from './TenantSettingsResponse';
+export * from './TenantSettingsUpdate';
+export * from './TenantUserEditRequest';
+export * from './TenantUserResponse';
+export * from './TenantUserRole';
+export * from './ThreadMessageContent';
+export * from './ThreadMessageDetailsInput';
+export * from './ThreadMessageDetailsOutput';
+export * from './ThreadMessageResponse';
+export * from './ThreadResponse';
+export * from './UpdateChunkContentRequest';
+export * from './UpdateChunkMetadataRequest';
+export * from './UpdateDocumentRequest';
+export * from './UpdateFolderRequest';
+export * from './UpdateGroupPermissionRequest';
+export * from './UpdateGroupRequest';
+export * from './UpdatePermissionRequest';
+export * from './UpdateSectionRequest';
+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';