@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/src/apis/ThreadMessagesApi.ts

@@ -58,6 +58,16 @@ export interface ListThreadMessagesRequest {
  * @interface ThreadMessagesApiInterface
  */
 export interface ThreadMessagesApiInterface {
+    /**
+     * Creates request options for createThreadMessage without sending the request
+     * @param {string} threadId 
+     * @param {CreateThreadMessageRequest} createThreadMessageRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof ThreadMessagesApiInterface
+     */
+    createThreadMessageRequestOpts(requestParameters: CreateThreadMessageOperationRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Create a new message in a thread.
      * @summary Create Thread Message Handler
@@ -76,6 +86,16 @@ export interface ThreadMessagesApiInterface {
      */
     createThreadMessage(requestParameters: CreateThreadMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadMessageResponse>;
 
+    /**
+     * Creates request options for getThreadMessage without sending the request
+     * @param {string} threadId 
+     * @param {string} messageId 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof ThreadMessagesApiInterface
+     */
+    getThreadMessageRequestOpts(requestParameters: GetThreadMessageRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Get a specific message by its ID.
      * @summary Get Thread Message Handler
@@ -94,6 +114,18 @@ export interface ThreadMessagesApiInterface {
      */
     getThreadMessage(requestParameters: GetThreadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadMessageResponse>;
 
+    /**
+     * Creates request options for listThreadMessages without sending the request
+     * @param {string} threadId 
+     * @param {Date} [before] Cursor for keyset pagination: only return messages with created_at &lt; this value
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof ThreadMessagesApiInterface
+     */
+    listThreadMessagesRequestOpts(requestParameters: ListThreadMessagesRequest): Promise<runtime.RequestOpts>;
+
     /**
      * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.
      * @summary List Thread Messages Handler
@@ -122,10 +154,9 @@ export interface ThreadMessagesApiInterface {
 export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessagesApiInterface {
 
     /**
-     * Create a new message in a thread.
-     * Create Thread Message Handler
+     * Creates request options for createThreadMessage without sending the request
      */
-    async createThreadMessageRaw(requestParameters: CreateThreadMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadMessageResponse>> {
+    async createThreadMessageRequestOpts(requestParameters: CreateThreadMessageOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['threadId'] == null) {
             throw new runtime.RequiredError(
                 'threadId',
@@ -150,13 +181,22 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
         let urlPath = `/v1/threads/{thread_id}/messages`;
         urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: CreateThreadMessageRequestToJSON(requestParameters['createThreadMessageRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Create a new message in a thread.
+     * Create Thread Message Handler
+     */
+    async createThreadMessageRaw(requestParameters: CreateThreadMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadMessageResponse>> {
+        const requestOptions = await this.createThreadMessageRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ThreadMessageResponseFromJSON(jsonValue));
     }
@@ -171,10 +211,9 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
     }
 
     /**
-     * Get a specific message by its ID.
-     * Get Thread Message Handler
+     * Creates request options for getThreadMessage without sending the request
      */
-    async getThreadMessageRaw(requestParameters: GetThreadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadMessageResponse>> {
+    async getThreadMessageRequestOpts(requestParameters: GetThreadMessageRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['threadId'] == null) {
             throw new runtime.RequiredError(
                 'threadId',
@@ -198,12 +237,21 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
         urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
         urlPath = urlPath.replace(`{${"message_id"}}`, encodeURIComponent(String(requestParameters['messageId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a specific message by its ID.
+     * Get Thread Message Handler
+     */
+    async getThreadMessageRaw(requestParameters: GetThreadMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadMessageResponse>> {
+        const requestOptions = await this.getThreadMessageRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ThreadMessageResponseFromJSON(jsonValue));
     }
@@ -218,10 +266,9 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
     }
 
     /**
-     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.
-     * List Thread Messages Handler
+     * Creates request options for listThreadMessages without sending the request
      */
-    async listThreadMessagesRaw(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadMessageResponse>> {
+    async listThreadMessagesRequestOpts(requestParameters: ListThreadMessagesRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['threadId'] == null) {
             throw new runtime.RequiredError(
                 'threadId',
@@ -249,12 +296,21 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
         let urlPath = `/v1/threads/{thread_id}/messages`;
         urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.
+     * List Thread Messages Handler
+     */
+    async listThreadMessagesRaw(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadMessageResponse>> {
+        const requestOptions = await this.listThreadMessagesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseThreadMessageResponseFromJSON(jsonValue));
     }

package/src/apis/ThreadsApi.ts

@@ -76,6 +76,15 @@ export interface UpdateThreadOperationRequest {
  * @interface ThreadsApiInterface
  */
 export interface ThreadsApiInterface {
+    /**
+     * Creates request options for createThread without sending the request
+     * @param {CreateThreadRequest} createThreadRequest 
+     * @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
@@ -93,6 +102,15 @@ export interface ThreadsApiInterface {
      */
     createThread(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse>;
 
+    /**
+     * Creates request options for deleteThread without sending the request
+     * @param {string} threadId 
+     * @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
@@ -110,6 +128,15 @@ export interface ThreadsApiInterface {
      */
     deleteThread(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Creates request options for getThread without sending the request
+     * @param {string} threadId 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof ThreadsApiInterface
+     */
+    getThreadRequestOpts(requestParameters: GetThreadRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Get a thread by its thread ID.
      * @summary Get Thread Handler
@@ -127,6 +154,17 @@ export interface ThreadsApiInterface {
      */
     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} [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
@@ -146,6 +184,17 @@ export interface ThreadsApiInterface {
      */
     listThreads(requestParameters: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadResponse>;
 
+    /**
+     * Creates request options for streamThread without sending the request
+     * @param {string} threadId 
+     * @param {string} [lastMessageId] 
+     * @param {string} [lastEntryId] 
+     * @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
@@ -165,6 +214,16 @@ export interface ThreadsApiInterface {
      */
     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} [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
@@ -191,10 +250,9 @@ export interface ThreadsApiInterface {
 export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
 
     /**
-     * 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
+     * Creates request options for createThread without sending the request
      */
-    async createThreadRaw(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>> {
+    async createThreadRequestOpts(requestParameters: CreateThreadOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['createThreadRequest'] == null) {
             throw new runtime.RequiredError(
                 'createThreadRequest',
@@ -211,13 +269,22 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
 
         let urlPath = `/v1/threads`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: CreateThreadRequestToJSON(requestParameters['createThreadRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async createThreadRaw(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>> {
+        const requestOptions = await this.createThreadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
     }
@@ -232,10 +299,9 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
     }
 
     /**
-     * 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
+     * Creates request options for deleteThread without sending the request
      */
-    async deleteThreadRaw(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async deleteThreadRequestOpts(requestParameters: DeleteThreadRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['threadId'] == null) {
             throw new runtime.RequiredError(
                 'threadId',
@@ -251,12 +317,21 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
         let urlPath = `/v1/threads/{thread_id}`;
         urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async deleteThreadRaw(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteThreadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -270,10 +345,9 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
     }
 
     /**
-     * Get a thread by its thread ID.
-     * Get Thread Handler
+     * Creates request options for getThread without sending the request
      */
-    async getThreadRaw(requestParameters: GetThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>> {
+    async getThreadRequestOpts(requestParameters: GetThreadRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['threadId'] == null) {
             throw new runtime.RequiredError(
                 'threadId',
@@ -289,12 +363,21 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
         let urlPath = `/v1/threads/{thread_id}`;
         urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a thread by its thread ID.
+     * Get Thread Handler
+     */
+    async getThreadRaw(requestParameters: GetThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>> {
+        const requestOptions = await this.getThreadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
     }
@@ -309,10 +392,9 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
     }
 
     /**
-     * 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
+     * Creates request options for listThreads without sending the request
      */
-    async listThreadsRaw(requestParameters: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadResponse>> {
+    async listThreadsRequestOpts(requestParameters: ListThreadsRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         if (requestParameters['parentPathPartId'] != null) {
@@ -332,12 +414,21 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
 
         let urlPath = `/v1/threads`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async listThreadsRaw(requestParameters: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadResponse>> {
+        const requestOptions = await this.listThreadsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseThreadResponseFromJSON(jsonValue));
     }
@@ -352,10 +443,9 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
     }
 
     /**
-     * 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
+     * Creates request options for streamThread without sending the request
      */
-    async streamThreadRaw(requestParameters: StreamThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async streamThreadRequestOpts(requestParameters: StreamThreadRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['threadId'] == null) {
             throw new runtime.RequiredError(
                 'threadId',
@@ -379,12 +469,21 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
         let urlPath = `/v1/threads/{thread_id}/stream`;
         urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * 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
+     */
+    async streamThreadRaw(requestParameters: StreamThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.streamThreadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -398,10 +497,9 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
     }
 
     /**
-     * Update a thread\'s title and/or parent_thread_id.
-     * Update Thread Handler
+     * Creates request options for updateThread without sending the request
      */
-    async updateThreadRaw(requestParameters: UpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>> {
+    async updateThreadRequestOpts(requestParameters: UpdateThreadOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['threadId'] == null) {
             throw new runtime.RequiredError(
                 'threadId',
@@ -426,13 +524,22 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
         let urlPath = `/v1/threads/{thread_id}`;
         urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
             body: UpdateThreadRequestToJSON(requestParameters['updateThreadRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * Update Thread Handler
+     */
+    async updateThreadRaw(requestParameters: UpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>> {
+        const requestOptions = await this.updateThreadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
     }