@knowledge-stack/ksapi 1.6.0 → 1.8.0

package/src/apis/ChunksApi.ts

@@ -0,0 +1,381 @@
+/* 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 {
+  ChunkResponse,
+  CreateChunkRequest,
+  HTTPValidationError,
+  UpdateChunkContentRequest,
+  UpdateChunkMetadataRequest,
+} from '../models/index';
+import {
+    ChunkResponseFromJSON,
+    ChunkResponseToJSON,
+    CreateChunkRequestFromJSON,
+    CreateChunkRequestToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    UpdateChunkContentRequestFromJSON,
+    UpdateChunkContentRequestToJSON,
+    UpdateChunkMetadataRequestFromJSON,
+    UpdateChunkMetadataRequestToJSON,
+} from '../models/index';
+
+export interface CreateChunkOperationRequest {
+    createChunkRequest: CreateChunkRequest;
+    ksUat?: string;
+}
+
+export interface DeleteChunkRequest {
+    chunkId: string;
+    ksUat?: string;
+}
+
+export interface GetChunkRequest {
+    chunkId: string;
+    ksUat?: string;
+}
+
+export interface UpdateChunkContentOperationRequest {
+    chunkId: string;
+    updateChunkContentRequest: UpdateChunkContentRequest;
+    ksUat?: string;
+}
+
+export interface UpdateChunkMetadataOperationRequest {
+    chunkId: string;
+    updateChunkMetadataRequest: UpdateChunkMetadataRequest;
+    ksUat?: string;
+}
+
+/**
+ * ChunksApi - interface
+ * 
+ * @export
+ * @interface ChunksApiInterface
+ */
+export interface ChunksApiInterface {
+    /**
+     * Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+     * @summary Create Chunk Handler
+     * @param {CreateChunkRequest} createChunkRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    createChunkRaw(requestParameters: CreateChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>>;
+
+    /**
+     * Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+     * Create Chunk Handler
+     */
+    createChunk(requestParameters: CreateChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse>;
+
+    /**
+     * Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+     * @summary Delete Chunk Handler
+     * @param {string} chunkId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    deleteChunkRaw(requestParameters: DeleteChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+     * Delete Chunk Handler
+     */
+    deleteChunk(requestParameters: DeleteChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Get a chunk by its ID, including content.
+     * @summary Get Chunk Handler
+     * @param {string} chunkId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    getChunkRaw(requestParameters: GetChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>>;
+
+    /**
+     * Get a chunk by its ID, including content.
+     * Get Chunk Handler
+     */
+    getChunk(requestParameters: GetChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse>;
+
+    /**
+     * Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+     * @summary Update Chunk Content Handler
+     * @param {string} chunkId 
+     * @param {UpdateChunkContentRequest} updateChunkContentRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    updateChunkContentRaw(requestParameters: UpdateChunkContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>>;
+
+    /**
+     * Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+     * Update Chunk Content Handler
+     */
+    updateChunkContent(requestParameters: UpdateChunkContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse>;
+
+    /**
+     * Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+     * @summary Update Chunk Metadata Handler
+     * @param {string} chunkId 
+     * @param {UpdateChunkMetadataRequest} updateChunkMetadataRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChunksApiInterface
+     */
+    updateChunkMetadataRaw(requestParameters: UpdateChunkMetadataOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>>;
+
+    /**
+     * Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+     * Update Chunk Metadata Handler
+     */
+    updateChunkMetadata(requestParameters: UpdateChunkMetadataOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse>;
+
+}
+
+/**
+ * 
+ */
+export class ChunksApi extends runtime.BaseAPI implements ChunksApiInterface {
+
+    /**
+     * Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+     * Create Chunk Handler
+     */
+    async createChunkRaw(requestParameters: CreateChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>> {
+        if (requestParameters['createChunkRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createChunkRequest',
+                'Required parameter "createChunkRequest" was null or undefined when calling createChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/chunks`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateChunkRequestToJSON(requestParameters['createChunkRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new chunk with content.  The chunk is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). Content is deduplicated by SHA256 hash.
+     * Create Chunk Handler
+     */
+    async createChunk(requestParameters: CreateChunkOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse> {
+        const response = await this.createChunkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+     * Delete Chunk Handler
+     */
+    async deleteChunkRaw(requestParameters: DeleteChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling deleteChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/chunks/{chunk_id}`;
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a chunk.  The chunk is deleted via its PathPart (cascading delete). The associated ChunkContent may remain if shared by other chunks.
+     * Delete Chunk Handler
+     */
+    async deleteChunk(requestParameters: DeleteChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteChunkRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a chunk by its ID, including content.
+     * Get Chunk Handler
+     */
+    async getChunkRaw(requestParameters: GetChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling getChunk().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/chunks/{chunk_id}`;
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a chunk by its ID, including content.
+     * Get Chunk Handler
+     */
+    async getChunk(requestParameters: GetChunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse> {
+        const response = await this.getChunkRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+     * Update Chunk Content Handler
+     */
+    async updateChunkContentRaw(requestParameters: UpdateChunkContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling updateChunkContent().'
+            );
+        }
+
+        if (requestParameters['updateChunkContentRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateChunkContentRequest',
+                'Required parameter "updateChunkContentRequest" was null or undefined when calling updateChunkContent().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/chunks/{chunk_id}/content`;
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateChunkContentRequestToJSON(requestParameters['updateChunkContentRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update chunk content by creating a new content row.  The old content row is preserved (not deleted). If the new content matches an existing content hash, it will be deduplicated.
+     * Update Chunk Content Handler
+     */
+    async updateChunkContent(requestParameters: UpdateChunkContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse> {
+        const response = await this.updateChunkContentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+     * Update Chunk Metadata Handler
+     */
+    async updateChunkMetadataRaw(requestParameters: UpdateChunkMetadataOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChunkResponse>> {
+        if (requestParameters['chunkId'] == null) {
+            throw new runtime.RequiredError(
+                'chunkId',
+                'Required parameter "chunkId" was null or undefined when calling updateChunkMetadata().'
+            );
+        }
+
+        if (requestParameters['updateChunkMetadataRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateChunkMetadataRequest',
+                'Required parameter "updateChunkMetadataRequest" was null or undefined when calling updateChunkMetadata().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/chunks/{chunk_id}/metadata`;
+        urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateChunkMetadataRequestToJSON(requestParameters['updateChunkMetadataRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChunkResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update chunk metadata by merging with existing metadata.  The provided metadata is shallow-merged into the existing chunk_metadata.
+     * Update Chunk Metadata Handler
+     */
+    async updateChunkMetadata(requestParameters: UpdateChunkMetadataOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChunkResponse> {
+        const response = await this.updateChunkMetadataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/PathPartsApi.ts

@@ -18,6 +18,7 @@ import type {
   HTTPValidationError,
   PaginatedResponsePathPartResponse,
   PathOrder,
+  PathPartResponse,
 } from '../models/index';
 import {
     HTTPValidationErrorFromJSON,
@@ -26,8 +27,15 @@ import {
     PaginatedResponsePathPartResponseToJSON,
     PathOrderFromJSON,
     PathOrderToJSON,
+    PathPartResponseFromJSON,
+    PathPartResponseToJSON,
 } from '../models/index';
 
+export interface GetPathPartRequest {
+    pathPartId: string;
+    ksUat?: string;
+}
+
 export interface ListPathPartsRequest {
     parentId?: string;
     includeDocuments?: boolean;
@@ -45,6 +53,23 @@ export interface ListPathPartsRequest {
  * @interface PathPartsApiInterface
  */
 export interface PathPartsApiInterface {
+    /**
+     * Get a path part by its ID.  Returns the path part if it exists and belongs to the user\'s tenant.
+     * @summary Get Path Part Handler
+     * @param {string} pathPartId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    getPathPartRaw(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>>;
+
+    /**
+     * Get a path part by its ID.  Returns the path part if it exists and belongs to the user\'s tenant.
+     * Get Path Part Handler
+     */
+    getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
+
     /**
      * List path parts under a parent with flexible filtering and traversal.  This is a generic endpoint for traversing the path hierarchy. It can return folders, documents, or both depending on the filters provided.  - If parent_id is not provided, lists contents of the root folder. - If include_documents is True, includes both FOLDER and DOCUMENT types.   Documents act as traversal boundaries (their children are not traversed). - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.
      * @summary List Path Parts Handler
@@ -74,6 +99,45 @@ export interface PathPartsApiInterface {
  */
 export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterface {
 
+    /**
+     * Get a path part by its ID.  Returns the path part if it exists and belongs to the user\'s tenant.
+     * Get Path Part Handler
+     */
+    async getPathPartRaw(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>> {
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling getPathPart().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/path-parts/{path_part_id}`;
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PathPartResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a path part by its ID.  Returns the path part if it exists and belongs to the user\'s tenant.
+     * Get Path Part Handler
+     */
+    async getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse> {
+        const response = await this.getPathPartRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * List path parts under a parent with flexible filtering and traversal.  This is a generic endpoint for traversing the path hierarchy. It can return folders, documents, or both depending on the filters provided.  - If parent_id is not provided, lists contents of the root folder. - If include_documents is True, includes both FOLDER and DOCUMENT types.   Documents act as traversal boundaries (their children are not traversed). - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.
      * List Path Parts Handler