@knowledge-stack/ksapi 1.8.0 → 1.10.0

package/src/apis/ThreadsApi.ts

@@ -0,0 +1,377 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  CreateThreadRequest,
+  HTTPValidationError,
+  PaginatedResponseThreadResponse,
+  ThreadResponse,
+  UpdateThreadRequest,
+} from '../models/index';
+import {
+    CreateThreadRequestFromJSON,
+    CreateThreadRequestToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    PaginatedResponseThreadResponseFromJSON,
+    PaginatedResponseThreadResponseToJSON,
+    ThreadResponseFromJSON,
+    ThreadResponseToJSON,
+    UpdateThreadRequestFromJSON,
+    UpdateThreadRequestToJSON,
+} from '../models/index';
+
+export interface CreateThreadOperationRequest {
+    createThreadRequest: CreateThreadRequest;
+    ksUat?: string;
+}
+
+export interface DeleteThreadRequest {
+    threadId: string;
+    ksUat?: string;
+}
+
+export interface GetThreadRequest {
+    threadId: string;
+    ksUat?: string;
+}
+
+export interface ListThreadsRequest {
+    parentPathPartId?: string;
+    limit?: number;
+    offset?: number;
+    ksUat?: string;
+}
+
+export interface UpdateThreadOperationRequest {
+    threadId: string;
+    updateThreadRequest: UpdateThreadRequest;
+    ksUat?: string;
+}
+
+/**
+ * ThreadsApi - interface
+ * 
+ * @export
+ * @interface ThreadsApiInterface
+ */
+export interface 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).
+     * @summary Create Thread Handler
+     * @param {CreateThreadRequest} createThreadRequest 
+     * @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>;
+
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted.
+     * @summary Delete Thread Handler
+     * @param {string} threadId 
+     * @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.
+     * Delete Thread Handler
+     */
+    deleteThread(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Get a thread by its thread ID.
+     * @summary Get Thread Handler
+     * @param {string} threadId 
+     * @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>;
+
+    /**
+     * 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} [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>;
+
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * @summary Update Thread Handler
+     * @param {string} threadId 
+     * @param {UpdateThreadRequest} updateThreadRequest 
+     * @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 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
+     */
+    async createThreadRaw(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>> {
+        if (requestParameters['createThreadRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createThreadRequest',
+                'Required parameter "createThreadRequest" was null or undefined when calling createThread().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/threads`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateThreadRequestToJSON(requestParameters['createThreadRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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 createThread(requestParameters: CreateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse> {
+        const response = await this.createThreadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted.
+     * Delete Thread Handler
+     */
+    async deleteThreadRaw(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['threadId'] == null) {
+            throw new runtime.RequiredError(
+                'threadId',
+                'Required parameter "threadId" was null or undefined when calling deleteThread().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/threads/{thread_id}`;
+        urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted.
+     * Delete Thread Handler
+     */
+    async deleteThread(requestParameters: DeleteThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteThreadRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a thread by its thread ID.
+     * Get Thread Handler
+     */
+    async getThreadRaw(requestParameters: GetThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ThreadResponse>> {
+        if (requestParameters['threadId'] == null) {
+            throw new runtime.RequiredError(
+                'threadId',
+                'Required parameter "threadId" was null or undefined when calling getThread().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/threads/{thread_id}`;
+        urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a thread by its thread ID.
+     * Get Thread Handler
+     */
+    async getThread(requestParameters: GetThreadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse> {
+        const response = await this.getThreadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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 queryParameters: any = {};
+
+        if (requestParameters['parentPathPartId'] != null) {
+            queryParameters['parent_path_part_id'] = requestParameters['parentPathPartId'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/threads`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseThreadResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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 listThreads(requestParameters: ListThreadsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadResponse> {
+        const response = await this.listThreadsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * 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>> {
+        if (requestParameters['threadId'] == null) {
+            throw new runtime.RequiredError(
+                'threadId',
+                'Required parameter "threadId" was null or undefined when calling updateThread().'
+            );
+        }
+
+        if (requestParameters['updateThreadRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateThreadRequest',
+                'Required parameter "updateThreadRequest" was null or undefined when calling updateThread().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/threads/{thread_id}`;
+        urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateThreadRequestToJSON(requestParameters['updateThreadRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ThreadResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a thread\'s title and/or parent_thread_id.
+     * Update Thread Handler
+     */
+    async updateThread(requestParameters: UpdateThreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ThreadResponse> {
+        const response = await this.updateThreadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -10,4 +10,6 @@ export * from './InvitesApi';
 export * from './PathPartsApi';
 export * from './SectionsApi';
 export * from './TenantsApi';
+export * from './ThreadMessagesApi';
+export * from './ThreadsApi';
 export * from './UsersApi';

package/src/models/CreateThreadMessageRequest.ts

@@ -0,0 +1,105 @@
+/* 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 { MessageRole } from './MessageRole';
+import {
+    MessageRoleFromJSON,
+    MessageRoleFromJSONTyped,
+    MessageRoleToJSON,
+    MessageRoleToJSONTyped,
+} from './MessageRole';
+
+/**
+ * Request to create a new thread message.
+ * @export
+ * @interface CreateThreadMessageRequest
+ */
+export interface CreateThreadMessageRequest {
+    /**
+     * Role of the message author (USER, ASSISTANT, SYSTEM)
+     * @type {MessageRole}
+     * @memberof CreateThreadMessageRequest
+     */
+    role: MessageRole;
+    /**
+     * Structured message content (JSONB)
+     * @type {object}
+     * @memberof CreateThreadMessageRequest
+     */
+    content: object;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateThreadMessageRequest interface.
+ */
+export function instanceOfCreateThreadMessageRequest(value: object): value is CreateThreadMessageRequest {
+    if (!('role' in value) || value['role'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    return true;
+}
+
+export function CreateThreadMessageRequestFromJSON(json: any): CreateThreadMessageRequest {
+    return CreateThreadMessageRequestFromJSONTyped(json, false);
+}
+
+export function CreateThreadMessageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateThreadMessageRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'role': MessageRoleFromJSON(json['role']),
+        'content': json['content'],
+    };
+}
+
+export function CreateThreadMessageRequestToJSON(json: any): CreateThreadMessageRequest {
+    return CreateThreadMessageRequestToJSONTyped(json, false);
+}
+
+export function CreateThreadMessageRequestToJSONTyped(value?: CreateThreadMessageRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'role': MessageRoleToJSON(value['role']),
+        'content': value['content'],
+    };
+}
+
+export const CreateThreadMessageRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+export const CreateThreadMessageRequestAdditionalPropertiesValidationAttributes: { maxProperties?: number, minProperties?: number } = {
+}
+

package/src/models/CreateThreadRequest.ts

@@ -0,0 +1,94 @@
+/* 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';
+/**
+ * Request to create a new thread.
+ * @export
+ * @interface CreateThreadRequest
+ */
+export interface CreateThreadRequest {
+    /**
+     * Parent PathPart ID. When omitted, auto-provisions and uses the user's /users/{user_id}/threads/ folder.
+     * @type {string}
+     * @memberof CreateThreadRequest
+     */
+    parentPathPartId?: string;
+    /**
+     * Thread title
+     * @type {string}
+     * @memberof CreateThreadRequest
+     */
+    title?: string;
+}
+
+/**
+ * Check if a given object implements the CreateThreadRequest interface.
+ */
+export function instanceOfCreateThreadRequest(value: object): value is CreateThreadRequest {
+    return true;
+}
+
+export function CreateThreadRequestFromJSON(json: any): CreateThreadRequest {
+    return CreateThreadRequestFromJSONTyped(json, false);
+}
+
+export function CreateThreadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateThreadRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'parentPathPartId': json['parent_path_part_id'] == null ? undefined : json['parent_path_part_id'],
+        'title': json['title'] == null ? undefined : json['title'],
+    };
+}
+
+export function CreateThreadRequestToJSON(json: any): CreateThreadRequest {
+    return CreateThreadRequestToJSONTyped(json, false);
+}
+
+export function CreateThreadRequestToJSONTyped(value?: CreateThreadRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'parent_path_part_id': value['parentPathPartId'],
+        'title': value['title'],
+    };
+}
+
+export const CreateThreadRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    title: {
+        maxLength: 255,
+        minLength: 1,
+    },
+}
+