@knowledge-stack/ksapi 1.66.2 → 1.67.0

package/dist/esm/apis/ThreadsApi.d.ts

@@ -0,0 +1,352 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { CreateThreadRequest, PaginatedResponseThreadResponse, ThreadResponse, UpdateThreadRequest, UserMessageRequest, UserMessageResponse } from '../models/index';
+export interface CreateThreadOperationRequest {
+    createThreadRequest: CreateThreadRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface DeleteThreadRequest {
+    threadId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface GetThreadRequest {
+    threadId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface ListThreadsRequest {
+    parentPathPartId?: string | null;
+    limit?: number;
+    offset?: number;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface SendUserMessageRequest {
+    threadId: string;
+    userMessageRequest: UserMessageRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface StreamThreadRequest {
+    threadId: string;
+    lastMessageId?: string | null;
+    lastEntryId?: string | null;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface UpdateThreadOperationRequest {
+    threadId: string;
+    updateThreadRequest: UpdateThreadRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+/**
+ * ThreadsApi - interface
+ *
+ * @export
+ * @interface ThreadsApiInterface
+ */
+export interface ThreadsApiInterface {
+    /**
+     * Creates request options for createThread without sending the request
+     * @param {CreateThreadRequest} createThreadRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    createThreadRequestOpts(requestParameters: CreateThreadOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new thread.  If parent_path_part_id is omitted, the thread is created under the user\'s /users/{user_id}/threads/ folder (auto-provisioned if needed).
+     * @summary Create Thread Handler
+     * @param {CreateThreadRequest} createThreadRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    createThreadRaw(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>>;
+    /**
+     * Create a new thread.  If parent_path_part_id is omitted, the thread is created under the user\'s /users/{user_id}/threads/ folder (auto-provisioned if needed).
+     * Create Thread Handler
+     */
+    createThread(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse>;
+    /**
+     * Creates request options for deleteThread without sending the request
+     * @param {string} threadId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    deleteThreadRequestOpts(requestParameters: DeleteThreadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted. Asset threads (attached to documents/sections) are never deletable via this endpoint.
+     * @summary Delete Thread Handler
+     * @param {string} threadId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    deleteThreadRaw(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted. Asset threads (attached to documents/sections) are never deletable via this endpoint.
+     * Delete Thread Handler
+     */
+    deleteThread(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getThread without sending the request
+     * @param {string} threadId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    getThreadRequestOpts(requestParameters: GetThreadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a thread by its thread ID.
+     * @summary Get Thread Handler
+     * @param {string} threadId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    getThreadRaw(requestParameters: GetThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>>;
+    /**
+     * Get a thread by its thread ID.
+     * Get Thread Handler
+     */
+    getThread(requestParameters: GetThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse>;
+    /**
+     * Creates request options for listThreads without sending the request
+     * @param {string} [parentPathPartId] Parent PathPart ID. Omit to list user\&#39;s conversation threads.
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    listThreadsRequestOpts(requestParameters: ListThreadsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List threads under a parent path_part.  When parent_path_part_id is omitted, lists the authenticated user\'s conversation threads from /users/{user_id}/threads/.
+     * @summary List Threads Handler
+     * @param {string} [parentPathPartId] Parent PathPart ID. Omit to list user\&#39;s conversation threads.
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    listThreadsRaw(requestParameters: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadResponse>>;
+    /**
+     * List threads under a parent path_part.  When parent_path_part_id is omitted, lists the authenticated user\'s conversation threads from /users/{user_id}/threads/.
+     * List Threads Handler
+     */
+    listThreads(requestParameters: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadResponse>;
+    /**
+     * Creates request options for sendUserMessage without sending the request
+     * @param {string} threadId
+     * @param {UserMessageRequest} userMessageRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    sendUserMessageRequestOpts(requestParameters: SendUserMessageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+     * @summary Send User Message Handler
+     * @param {string} threadId
+     * @param {UserMessageRequest} userMessageRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    sendUserMessageRaw(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserMessageResponse>>;
+    /**
+     * Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+     * Send User Message Handler
+     */
+    sendUserMessage(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserMessageResponse>;
+    /**
+     * Creates request options for streamThread without sending the request
+     * @param {string} threadId
+     * @param {string} [lastMessageId]
+     * @param {string} [lastEntryId]
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    streamThreadRequestOpts(requestParameters: StreamThreadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * SSE endpoint for streaming thread messages.  Opens a server-sent event stream for the given thread. Optionally replays missed entries if last_message_id and last_entry_id are provided.
+     * @summary Stream Thread Handler
+     * @param {string} threadId
+     * @param {string} [lastMessageId]
+     * @param {string} [lastEntryId]
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    streamThreadRaw(requestParameters: StreamThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * SSE endpoint for streaming thread messages.  Opens a server-sent event stream for the given thread. Optionally replays missed entries if last_message_id and last_entry_id are provided.
+     * Stream Thread Handler
+     */
+    streamThread(requestParameters: StreamThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateThread without sending the request
+     * @param {string} threadId
+     * @param {UpdateThreadRequest} updateThreadRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    updateThreadRequestOpts(requestParameters: UpdateThreadOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * @summary Update Thread Handler
+     * @param {string} threadId
+     * @param {UpdateThreadRequest} updateThreadRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    updateThreadRaw(requestParameters: UpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>>;
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * Update Thread Handler
+     */
+    updateThread(requestParameters: UpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse>;
+}
+/**
+ *
+ */
+export declare class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
+    /**
+     * Creates request options for createThread without sending the request
+     */
+    createThreadRequestOpts(requestParameters: CreateThreadOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new thread.  If parent_path_part_id is omitted, the thread is created under the user\'s /users/{user_id}/threads/ folder (auto-provisioned if needed).
+     * Create Thread Handler
+     */
+    createThreadRaw(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>>;
+    /**
+     * Create a new thread.  If parent_path_part_id is omitted, the thread is created under the user\'s /users/{user_id}/threads/ folder (auto-provisioned if needed).
+     * Create Thread Handler
+     */
+    createThread(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse>;
+    /**
+     * Creates request options for deleteThread without sending the request
+     */
+    deleteThreadRequestOpts(requestParameters: DeleteThreadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted. Asset threads (attached to documents/sections) are never deletable via this endpoint.
+     * Delete Thread Handler
+     */
+    deleteThreadRaw(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted. Asset threads (attached to documents/sections) are never deletable via this endpoint.
+     * Delete Thread Handler
+     */
+    deleteThread(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getThread without sending the request
+     */
+    getThreadRequestOpts(requestParameters: GetThreadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a thread by its thread ID.
+     * Get Thread Handler
+     */
+    getThreadRaw(requestParameters: GetThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>>;
+    /**
+     * Get a thread by its thread ID.
+     * Get Thread Handler
+     */
+    getThread(requestParameters: GetThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse>;
+    /**
+     * Creates request options for listThreads without sending the request
+     */
+    listThreadsRequestOpts(requestParameters: ListThreadsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List threads under a parent path_part.  When parent_path_part_id is omitted, lists the authenticated user\'s conversation threads from /users/{user_id}/threads/.
+     * List Threads Handler
+     */
+    listThreadsRaw(requestParameters: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadResponse>>;
+    /**
+     * List threads under a parent path_part.  When parent_path_part_id is omitted, lists the authenticated user\'s conversation threads from /users/{user_id}/threads/.
+     * List Threads Handler
+     */
+    listThreads(requestParameters?: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadResponse>;
+    /**
+     * Creates request options for sendUserMessage without sending the request
+     */
+    sendUserMessageRequestOpts(requestParameters: SendUserMessageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+     * Send User Message Handler
+     */
+    sendUserMessageRaw(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserMessageResponse>>;
+    /**
+     * Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+     * Send User Message Handler
+     */
+    sendUserMessage(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserMessageResponse>;
+    /**
+     * Creates request options for streamThread without sending the request
+     */
+    streamThreadRequestOpts(requestParameters: StreamThreadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * SSE endpoint for streaming thread messages.  Opens a server-sent event stream for the given thread. Optionally replays missed entries if last_message_id and last_entry_id are provided.
+     * Stream Thread Handler
+     */
+    streamThreadRaw(requestParameters: StreamThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * SSE endpoint for streaming thread messages.  Opens a server-sent event stream for the given thread. Optionally replays missed entries if last_message_id and last_entry_id are provided.
+     * Stream Thread Handler
+     */
+    streamThread(requestParameters: StreamThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateThread without sending the request
+     */
+    updateThreadRequestOpts(requestParameters: UpdateThreadOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * Update Thread Handler
+     */
+    updateThreadRaw(requestParameters: UpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>>;
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * Update Thread Handler
+     */
+    updateThread(requestParameters: UpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse>;
+}