@knowledge-stack/ksapi 1.20.1 → 1.21.0

package/dist/esm/models/PathPartTagsResponse.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.
+ */
+import { TagResponseFromJSON, TagResponseToJSON, } from './TagResponse';
+/**
+ * Check if a given object implements the PathPartTagsResponse interface.
+ */
+export function instanceOfPathPartTagsResponse(value) {
+    if (!('tags' in value) || value['tags'] === undefined)
+        return false;
+    return true;
+}
+export function PathPartTagsResponseFromJSON(json) {
+    return PathPartTagsResponseFromJSONTyped(json, false);
+}
+export function PathPartTagsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'tags': (json['tags'].map(TagResponseFromJSON)),
+    };
+}
+export function PathPartTagsResponseToJSON(json) {
+    return PathPartTagsResponseToJSONTyped(json, false);
+}
+export function PathPartTagsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'tags': (value['tags'].map(TagResponseToJSON)),
+    };
+}
+export const PathPartTagsResponsePropertyValidationAttributesMap = {};

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

@@ -1,3 +1,4 @@
+export * from './BulkTagRequest';
 export * from './ChunkLineageResponse';
 export * from './ChunkMetadataInput';
 export * from './ChunkMetadataOutput';
@@ -60,6 +61,7 @@ export * from './PasswordResetRequest';
 export * from './PasswordResetWithTokenRequest';
 export * from './PathOrder';
 export * from './PathPartResponse';
+export * from './PathPartTagsResponse';
 export * from './PermissionCapability';
 export * from './PermissionResponse';
 export * from './PipelineState';
@@ -70,7 +72,6 @@ export * from './RootResponse';
 export * from './ScoredChunkResponse';
 export * from './SectionResponse';
 export * from './SignInRequest';
-export * from './TagPathPartRequest';
 export * from './TagResponse';
 export * from './TenantResponse';
 export * from './TenantUserInTenantResponse';

package/dist/esm/models/index.js

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './BulkTagRequest';
 export * from './ChunkLineageResponse';
 export * from './ChunkMetadataInput';
 export * from './ChunkMetadataOutput';
@@ -62,6 +63,7 @@ export * from './PasswordResetRequest';
 export * from './PasswordResetWithTokenRequest';
 export * from './PathOrder';
 export * from './PathPartResponse';
+export * from './PathPartTagsResponse';
 export * from './PermissionCapability';
 export * from './PermissionResponse';
 export * from './PipelineState';
@@ -72,7 +74,6 @@ export * from './RootResponse';
 export * from './ScoredChunkResponse';
 export * from './SectionResponse';
 export * from './SignInRequest';
-export * from './TagPathPartRequest';
 export * from './TagResponse';
 export * from './TenantResponse';
 export * from './TenantUserInTenantResponse';

package/dist/models/BulkTagRequest.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ * Request to bulk add or remove tags from a path part.
+ * @export
+ * @interface BulkTagRequest
+ */
+export interface BulkTagRequest {
+    /**
+     * List of tag IDs to add/remove
+     * @type {Array<string>}
+     * @memberof BulkTagRequest
+     */
+    tagIds: Array<string>;
+}
+/**
+ * Check if a given object implements the BulkTagRequest interface.
+ */
+export declare function instanceOfBulkTagRequest(value: object): value is BulkTagRequest;
+export declare function BulkTagRequestFromJSON(json: any): BulkTagRequest;
+export declare function BulkTagRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkTagRequest;
+export declare function BulkTagRequestToJSON(json: any): BulkTagRequest;
+export declare function BulkTagRequestToJSONTyped(value?: BulkTagRequest | null, ignoreDiscriminator?: boolean): any;
+export declare const BulkTagRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/models/BulkTagRequest.js

@@ -0,0 +1,57 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkTagRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkTagRequest = instanceOfBulkTagRequest;
+exports.BulkTagRequestFromJSON = BulkTagRequestFromJSON;
+exports.BulkTagRequestFromJSONTyped = BulkTagRequestFromJSONTyped;
+exports.BulkTagRequestToJSON = BulkTagRequestToJSON;
+exports.BulkTagRequestToJSONTyped = BulkTagRequestToJSONTyped;
+/**
+ * Check if a given object implements the BulkTagRequest interface.
+ */
+function instanceOfBulkTagRequest(value) {
+    if (!('tagIds' in value) || value['tagIds'] === undefined)
+        return false;
+    return true;
+}
+function BulkTagRequestFromJSON(json) {
+    return BulkTagRequestFromJSONTyped(json, false);
+}
+function BulkTagRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'tagIds': json['tag_ids'],
+    };
+}
+function BulkTagRequestToJSON(json) {
+    return BulkTagRequestToJSONTyped(json, false);
+}
+function BulkTagRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'tag_ids': value['tagIds'],
+    };
+}
+exports.BulkTagRequestPropertyValidationAttributesMap = {
+    tagIds: {
+        maxItems: 10,
+        uniqueItems: false,
+    },
+};

package/dist/models/FolderDocumentResponse.d.ts

@@ -11,6 +11,7 @@
  */
 import type { DocumentOrigin } from './DocumentOrigin';
 import type { PartType } from './PartType';
+import type { TagResponse } from './TagResponse';
 import type { DocumentType } from './DocumentType';
 import type { DocumentVersionResponse } from './DocumentVersionResponse';
 /**
@@ -70,6 +71,12 @@ export interface FolderDocumentResponse {
      * @memberof FolderDocumentResponse
      */
     systemManaged: boolean;
+    /**
+     * Tags attached to this path part
+     * @type {Array<TagResponse>}
+     * @memberof FolderDocumentResponse
+     */
+    tags?: Array<TagResponse> | null;
     /**
      * Creation timestamp
      * @type {Date}

package/dist/models/FolderDocumentResponse.js

@@ -21,6 +21,7 @@ exports.FolderDocumentResponseToJSON = FolderDocumentResponseToJSON;
 exports.FolderDocumentResponseToJSONTyped = FolderDocumentResponseToJSONTyped;
 const DocumentOrigin_1 = require("./DocumentOrigin");
 const PartType_1 = require("./PartType");
+const TagResponse_1 = require("./TagResponse");
 const DocumentType_1 = require("./DocumentType");
 const DocumentVersionResponse_1 = require("./DocumentVersionResponse");
 /**
@@ -64,6 +65,7 @@ function FolderDocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
         'metadataObjId': json['metadata_obj_id'],
         'materializedPath': json['materialized_path'],
         'systemManaged': json['system_managed'],
+        'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
         'folderId': json['folder_id'] == null ? undefined : json['folder_id'],
@@ -90,6 +92,7 @@ function FolderDocumentResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'metadata_obj_id': value['metadataObjId'],
         'materialized_path': value['materializedPath'],
         'system_managed': value['systemManaged'],
+        'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponse_1.TagResponseToJSON)),
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
         'folder_id': value['folderId'],

package/dist/models/PathPartResponse.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { PartType } from './PartType';
+import type { TagResponse } from './TagResponse';
 /**
  * Generic path part response model.
  * @export
@@ -58,6 +59,12 @@ export interface PathPartResponse {
      * @memberof PathPartResponse
      */
     systemManaged: boolean;
+    /**
+     * Tags attached to this path part
+     * @type {Array<TagResponse>}
+     * @memberof PathPartResponse
+     */
+    tags?: Array<TagResponse> | null;
     /**
      * Creation timestamp
      * @type {Date}

package/dist/models/PathPartResponse.js

@@ -20,6 +20,7 @@ exports.PathPartResponseFromJSONTyped = PathPartResponseFromJSONTyped;
 exports.PathPartResponseToJSON = PathPartResponseToJSON;
 exports.PathPartResponseToJSONTyped = PathPartResponseToJSONTyped;
 const PartType_1 = require("./PartType");
+const TagResponse_1 = require("./TagResponse");
 /**
  * Check if a given object implements the PathPartResponse interface.
  */
@@ -59,6 +60,7 @@ function PathPartResponseFromJSONTyped(json, ignoreDiscriminator) {
         'metadataObjId': json['metadata_obj_id'],
         'materializedPath': json['materialized_path'],
         'systemManaged': json['system_managed'],
+        'tags': json['tags'] == null ? undefined : (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -78,6 +80,7 @@ function PathPartResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'metadata_obj_id': value['metadataObjId'],
         'materialized_path': value['materializedPath'],
         'system_managed': value['systemManaged'],
+        'tags': value['tags'] == null ? undefined : (value['tags'].map(TagResponse_1.TagResponseToJSON)),
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/dist/models/PathPartTagsResponse.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { TagResponse } from './TagResponse';
+/**
+ * Response containing the current tags for a path part.
+ * @export
+ * @interface PathPartTagsResponse
+ */
+export interface PathPartTagsResponse {
+    /**
+     * Tags attached to the path part
+     * @type {Array<TagResponse>}
+     * @memberof PathPartTagsResponse
+     */
+    tags: Array<TagResponse>;
+}
+/**
+ * Check if a given object implements the PathPartTagsResponse interface.
+ */
+export declare function instanceOfPathPartTagsResponse(value: object): value is PathPartTagsResponse;
+export declare function PathPartTagsResponseFromJSON(json: any): PathPartTagsResponse;
+export declare function PathPartTagsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PathPartTagsResponse;
+export declare function PathPartTagsResponseToJSON(json: any): PathPartTagsResponse;
+export declare function PathPartTagsResponseToJSONTyped(value?: PathPartTagsResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const PathPartTagsResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/models/PathPartTagsResponse.js

@@ -0,0 +1,53 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathPartTagsResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfPathPartTagsResponse = instanceOfPathPartTagsResponse;
+exports.PathPartTagsResponseFromJSON = PathPartTagsResponseFromJSON;
+exports.PathPartTagsResponseFromJSONTyped = PathPartTagsResponseFromJSONTyped;
+exports.PathPartTagsResponseToJSON = PathPartTagsResponseToJSON;
+exports.PathPartTagsResponseToJSONTyped = PathPartTagsResponseToJSONTyped;
+const TagResponse_1 = require("./TagResponse");
+/**
+ * Check if a given object implements the PathPartTagsResponse interface.
+ */
+function instanceOfPathPartTagsResponse(value) {
+    if (!('tags' in value) || value['tags'] === undefined)
+        return false;
+    return true;
+}
+function PathPartTagsResponseFromJSON(json) {
+    return PathPartTagsResponseFromJSONTyped(json, false);
+}
+function PathPartTagsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'tags': (json['tags'].map(TagResponse_1.TagResponseFromJSON)),
+    };
+}
+function PathPartTagsResponseToJSON(json) {
+    return PathPartTagsResponseToJSONTyped(json, false);
+}
+function PathPartTagsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'tags': (value['tags'].map(TagResponse_1.TagResponseToJSON)),
+    };
+}
+exports.PathPartTagsResponsePropertyValidationAttributesMap = {};

package/dist/models/index.d.ts

@@ -1,3 +1,4 @@
+export * from './BulkTagRequest';
 export * from './ChunkLineageResponse';
 export * from './ChunkMetadataInput';
 export * from './ChunkMetadataOutput';
@@ -60,6 +61,7 @@ export * from './PasswordResetRequest';
 export * from './PasswordResetWithTokenRequest';
 export * from './PathOrder';
 export * from './PathPartResponse';
+export * from './PathPartTagsResponse';
 export * from './PermissionCapability';
 export * from './PermissionResponse';
 export * from './PipelineState';
@@ -70,7 +72,6 @@ export * from './RootResponse';
 export * from './ScoredChunkResponse';
 export * from './SectionResponse';
 export * from './SignInRequest';
-export * from './TagPathPartRequest';
 export * from './TagResponse';
 export * from './TenantResponse';
 export * from './TenantUserInTenantResponse';

package/dist/models/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
+__exportStar(require("./BulkTagRequest"), exports);
 __exportStar(require("./ChunkLineageResponse"), exports);
 __exportStar(require("./ChunkMetadataInput"), exports);
 __exportStar(require("./ChunkMetadataOutput"), exports);
@@ -78,6 +79,7 @@ __exportStar(require("./PasswordResetRequest"), exports);
 __exportStar(require("./PasswordResetWithTokenRequest"), exports);
 __exportStar(require("./PathOrder"), exports);
 __exportStar(require("./PathPartResponse"), exports);
+__exportStar(require("./PathPartTagsResponse"), exports);
 __exportStar(require("./PermissionCapability"), exports);
 __exportStar(require("./PermissionResponse"), exports);
 __exportStar(require("./PipelineState"), exports);
@@ -88,7 +90,6 @@ __exportStar(require("./RootResponse"), exports);
 __exportStar(require("./ScoredChunkResponse"), exports);
 __exportStar(require("./SectionResponse"), exports);
 __exportStar(require("./SignInRequest"), exports);
-__exportStar(require("./TagPathPartRequest"), exports);
 __exportStar(require("./TagResponse"), exports);
 __exportStar(require("./TenantResponse"), exports);
 __exportStar(require("./TenantUserInTenantResponse"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.20.1",
+  "version": "1.21.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/FoldersApi.ts

@@ -59,6 +59,7 @@ export interface ListFolderContentsRequest {
     folderId: string;
     maxDepth?: number;
     sortOrder?: PathOrder;
+    withTags?: boolean;
     limit?: number;
     offset?: number;
     ksUat?: string | null;
@@ -137,11 +138,12 @@ export interface FoldersApiInterface {
     getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FolderResponse>;
 
     /**
-     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
+     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
      * @summary List Folder Contents Handler
      * @param {string} folderId 
      * @param {number} [maxDepth] Maximum depth to traverse (1&#x3D;direct children, default: 1)
      * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
+     * @param {boolean} [withTags] Include tag IDs for each item (default: false)
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [ksUat] 
@@ -152,7 +154,7 @@ export interface FoldersApiInterface {
     listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>>;
 
     /**
-     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
+     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
      * List Folder Contents Handler
      */
     listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
@@ -321,7 +323,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
     }
 
     /**
-     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
+     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
      * List Folder Contents Handler
      */
     async listFolderContentsRaw(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderDocumentResponse>> {
@@ -342,6 +344,10 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
             queryParameters['sort_order'] = requestParameters['sortOrder'];
         }
 
+        if (requestParameters['withTags'] != null) {
+            queryParameters['with_tags'] = requestParameters['withTags'];
+        }
+
         if (requestParameters['limit'] != null) {
             queryParameters['limit'] = requestParameters['limit'];
         }
@@ -367,7 +373,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
     }
 
     /**
-     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
+     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
      * List Folder Contents Handler
      */
     async listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse> {