@knowledge-stack/ksapi 1.57.0 → 1.59.0

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, UpdateFolderRequest } from '../models/index';
+import type { CreateFolderRequest, FolderAction, FolderActionResponse, FolderResponse, PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator, PaginatedResponseFolderResponse, PathOrder, SearchSortOrder, SearchablePartType, UpdateFolderRequest } from '../models/index';
 export interface CreateFolderOperationRequest {
     createFolderRequest: CreateFolderRequest;
     authorization?: string | null;
@@ -38,7 +38,6 @@ export interface ListFolderContentsRequest {
     maxDepth?: number;
     sortOrder?: PathOrder;
     withTags?: boolean;
-    nameLike?: string | null;
     limit?: number;
     offset?: number;
     authorization?: string | null;
@@ -53,6 +52,17 @@ export interface ListFoldersRequest {
     authorization?: string | null;
     ksUat?: string | null;
 }
+export interface SearchItemsRequest {
+    nameLike: string;
+    sortOrder?: SearchSortOrder;
+    partType?: SearchablePartType;
+    withTags?: boolean;
+    parentPathPartId?: string | null;
+    limit?: number;
+    offset?: number;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
 export interface UpdateFolderOperationRequest {
     folderId: string;
     updateFolderRequest: UpdateFolderRequest;
@@ -176,7 +186,6 @@ export interface FoldersApiInterface {
      * @param {number} [maxDepth] Maximum depth to traverse (1=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 {string} [nameLike] Case-insensitive partial name search filter
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [authorization]
@@ -192,7 +201,6 @@ export interface FoldersApiInterface {
      * @param {number} [maxDepth] Maximum depth to traverse (1=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 {string} [nameLike] Case-insensitive partial name search filter
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {string} [authorization]
@@ -240,6 +248,43 @@ export interface FoldersApiInterface {
      * List Folders Handler
      */
     listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
+    /**
+     * Creates request options for searchItems without sending the request
+     * @param {string} nameLike Case-insensitive partial name search
+     * @param {SearchSortOrder} [sortOrder] Sort order for results (default: NAME)
+     * @param {SearchablePartType} [partType] Filter by item type (default: both folders and documents)
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @param {string} [parentPathPartId] Scope search to descendants of this folder\&#39;s path part
+     * @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 FoldersApiInterface
+     */
+    searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * @summary Search Items Handler
+     * @param {string} nameLike Case-insensitive partial name search
+     * @param {SearchSortOrder} [sortOrder] Sort order for results (default: NAME)
+     * @param {SearchablePartType} [partType] Filter by item type (default: both folders and documents)
+     * @param {boolean} [withTags] Include tags in the response (default: false)
+     * @param {string} [parentPathPartId] Scope search to descendants of this folder\&#39;s path part
+     * @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 FoldersApiInterface
+     */
+    searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>>;
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * Search Items Handler
+     */
+    searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>;
     /**
      * Creates request options for updateFolder without sending the request
      * @param {string} folderId
@@ -356,6 +401,20 @@ export declare class FoldersApi extends runtime.BaseAPI implements FoldersApiInt
      * List Folders Handler
      */
     listFolders(requestParameters?: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
+    /**
+     * Creates request options for searchItems without sending the request
+     */
+    searchItemsRequestOpts(requestParameters: SearchItemsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * Search Items Handler
+     */
+    searchItemsRaw(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>>;
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * Search Items Handler
+     */
+    searchItems(requestParameters: SearchItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator>;
     /**
      * Creates request options for updateFolder without sending the request
      */

package/dist/esm/apis/FoldersApi.js

@@ -229,9 +229,6 @@ export class FoldersApi extends runtime.BaseAPI {
             if (requestParameters['withTags'] != null) {
                 queryParameters['with_tags'] = requestParameters['withTags'];
             }
-            if (requestParameters['nameLike'] != null) {
-                queryParameters['name_like'] = requestParameters['nameLike'];
-            }
             if (requestParameters['limit'] != null) {
                 queryParameters['limit'] = requestParameters['limit'];
             }
@@ -328,6 +325,70 @@ export class FoldersApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for searchItems without sending the request
+     */
+    searchItemsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['nameLike'] == null) {
+                throw new runtime.RequiredError('nameLike', 'Required parameter "nameLike" was null or undefined when calling searchItems().');
+            }
+            const queryParameters = {};
+            if (requestParameters['nameLike'] != null) {
+                queryParameters['name_like'] = requestParameters['nameLike'];
+            }
+            if (requestParameters['sortOrder'] != null) {
+                queryParameters['sort_order'] = requestParameters['sortOrder'];
+            }
+            if (requestParameters['partType'] != null) {
+                queryParameters['part_type'] = requestParameters['partType'];
+            }
+            if (requestParameters['withTags'] != null) {
+                queryParameters['with_tags'] = requestParameters['withTags'];
+            }
+            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 = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/folders/search`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * Search Items Handler
+     */
+    searchItemsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.searchItemsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminatorFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Search for folders and documents by name.  Performs a case-insensitive partial name match using trigram indexing. Results are filtered by the current user\'s path permissions.  When parent_path_part_id is provided, only items under that folder are searched. Otherwise, all accessible items across the tenant are searched.
+     * Search Items Handler
+     */
+    searchItems(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.searchItemsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for updateFolder without sending the request
      */

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { BulkTagRequest, PaginatedResponsePathPartResponse, PathOrder, PathPartResponse, PathPartTagsResponse, SubtreeChunksResponse } from '../models/index';
+import type { AncestryResponse, BulkTagRequest, PaginatedResponsePathPartResponse, PathOrder, PathPartResponse, PathPartTagsResponse, SubtreeChunksResponse } from '../models/index';
 export interface BulkAddPathPartTagsRequest {
     pathPartId: string;
     bulkTagRequest: BulkTagRequest;
@@ -28,6 +28,11 @@ export interface GetPathPartRequest {
     authorization?: string | null;
     ksUat?: string | null;
 }
+export interface GetPathPartAncestryRequest {
+    pathPartId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
 export interface GetPathPartSubtreeChunksRequest {
     pathPartId: string;
     authorization?: string | null;
@@ -134,6 +139,31 @@ export interface PathPartsApiInterface {
      * Get Path Part Handler
      */
     getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
+    /**
+     * Creates request options for getPathPartAncestry without sending the request
+     * @param {string} pathPartId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    getPathPartAncestryRequestOpts(requestParameters: GetPathPartAncestryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get the full ancestry chain for a path part (root to leaf, inclusive).  Returns all ancestors from the root down to and including the target path part. Authorization is checked on the leaf — if the user can read the leaf, they can navigate its ancestors.
+     * @summary Get Path Part Ancestry Handler
+     * @param {string} pathPartId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    getPathPartAncestryRaw(requestParameters: GetPathPartAncestryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AncestryResponse>>;
+    /**
+     * Get the full ancestry chain for a path part (root to leaf, inclusive).  Returns all ancestors from the root down to and including the target path part. Authorization is checked on the leaf — if the user can read the leaf, they can navigate its ancestors.
+     * Get Path Part Ancestry Handler
+     */
+    getPathPartAncestry(requestParameters: GetPathPartAncestryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AncestryResponse>;
     /**
      * Creates request options for getPathPartSubtreeChunks without sending the request
      * @param {string} pathPartId
@@ -266,6 +296,20 @@ export declare class PathPartsApi extends runtime.BaseAPI implements PathPartsAp
      * Get Path Part Handler
      */
     getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
+    /**
+     * Creates request options for getPathPartAncestry without sending the request
+     */
+    getPathPartAncestryRequestOpts(requestParameters: GetPathPartAncestryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get the full ancestry chain for a path part (root to leaf, inclusive).  Returns all ancestors from the root down to and including the target path part. Authorization is checked on the leaf — if the user can read the leaf, they can navigate its ancestors.
+     * Get Path Part Ancestry Handler
+     */
+    getPathPartAncestryRaw(requestParameters: GetPathPartAncestryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AncestryResponse>>;
+    /**
+     * Get the full ancestry chain for a path part (root to leaf, inclusive).  Returns all ancestors from the root down to and including the target path part. Authorization is checked on the leaf — if the user can read the leaf, they can navigate its ancestors.
+     * Get Path Part Ancestry Handler
+     */
+    getPathPartAncestry(requestParameters: GetPathPartAncestryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AncestryResponse>;
     /**
      * Creates request options for getPathPartSubtreeChunks without sending the request
      */

package/dist/esm/apis/PathPartsApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { BulkTagRequestToJSON, PaginatedResponsePathPartResponseFromJSON, PathPartResponseFromJSON, PathPartTagsResponseFromJSON, SubtreeChunksResponseFromJSON, } from '../models/index';
+import { AncestryResponseFromJSON, BulkTagRequestToJSON, PaginatedResponsePathPartResponseFromJSON, PathPartResponseFromJSON, PathPartTagsResponseFromJSON, SubtreeChunksResponseFromJSON, } from '../models/index';
 /**
  *
  */
@@ -168,6 +168,50 @@ export class PathPartsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getPathPartAncestry without sending the request
+     */
+    getPathPartAncestryRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['pathPartId'] == null) {
+                throw new runtime.RequiredError('pathPartId', 'Required parameter "pathPartId" was null or undefined when calling getPathPartAncestry().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/path-parts/{path_part_id}/ancestry`;
+            urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get the full ancestry chain for a path part (root to leaf, inclusive).  Returns all ancestors from the root down to and including the target path part. Authorization is checked on the leaf — if the user can read the leaf, they can navigate its ancestors.
+     * Get Path Part Ancestry Handler
+     */
+    getPathPartAncestryRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getPathPartAncestryRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AncestryResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get the full ancestry chain for a path part (root to leaf, inclusive).  Returns all ancestors from the root down to and including the target path part. Authorization is checked on the leaf — if the user can read the leaf, they can navigate its ancestors.
+     * Get Path Part Ancestry Handler
+     */
+    getPathPartAncestry(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getPathPartAncestryRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getPathPartSubtreeChunks without sending the request
      */

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

@@ -26,6 +26,11 @@ export interface GetSectionRequest {
     authorization?: string | null;
     ksUat?: string | null;
 }
+export interface GetSectionsBulkRequest {
+    sectionIds?: Array<string> | null;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
 export interface UpdateSectionOperationRequest {
     sectionId: string;
     updateSectionRequest: UpdateSectionRequest;
@@ -114,6 +119,31 @@ export interface SectionsApiInterface {
      * Get Section Handler
      */
     getSection(requestParameters: GetSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SectionResponse>;
+    /**
+     * Creates request options for getSectionsBulk without sending the request
+     * @param {Array<string>} [sectionIds] Section IDs to fetch (max 200)
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof SectionsApiInterface
+     */
+    getSectionsBulkRequestOpts(requestParameters: GetSectionsBulkRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Batch-fetch sections by ID.  Returns sections with system_metadata. Non-existent IDs are silently skipped. Limited to 200 IDs per call.
+     * @summary Get Sections Bulk Handler
+     * @param {Array<string>} [sectionIds] Section IDs to fetch (max 200)
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SectionsApiInterface
+     */
+    getSectionsBulkRaw(requestParameters: GetSectionsBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SectionResponse>>>;
+    /**
+     * Batch-fetch sections by ID.  Returns sections with system_metadata. Non-existent IDs are silently skipped. Limited to 200 IDs per call.
+     * Get Sections Bulk Handler
+     */
+    getSectionsBulk(requestParameters: GetSectionsBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SectionResponse>>;
     /**
      * Creates request options for updateSection without sending the request
      * @param {string} sectionId
@@ -188,6 +218,20 @@ export declare class SectionsApi extends runtime.BaseAPI implements SectionsApiI
      * Get Section Handler
      */
     getSection(requestParameters: GetSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SectionResponse>;
+    /**
+     * Creates request options for getSectionsBulk without sending the request
+     */
+    getSectionsBulkRequestOpts(requestParameters: GetSectionsBulkRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Batch-fetch sections by ID.  Returns sections with system_metadata. Non-existent IDs are silently skipped. Limited to 200 IDs per call.
+     * Get Sections Bulk Handler
+     */
+    getSectionsBulkRaw(requestParameters: GetSectionsBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SectionResponse>>>;
+    /**
+     * Batch-fetch sections by ID.  Returns sections with system_metadata. Non-existent IDs are silently skipped. Limited to 200 IDs per call.
+     * Get Sections Bulk Handler
+     */
+    getSectionsBulk(requestParameters?: GetSectionsBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SectionResponse>>;
     /**
      * Creates request options for updateSection without sending the request
      */

package/dist/esm/apis/SectionsApi.js

@@ -158,6 +158,49 @@ export class SectionsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getSectionsBulk without sending the request
+     */
+    getSectionsBulkRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['sectionIds'] != null) {
+                queryParameters['section_ids'] = requestParameters['sectionIds'];
+            }
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/sections/bulk`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Batch-fetch sections by ID.  Returns sections with system_metadata. Non-existent IDs are silently skipped. Limited to 200 IDs per call.
+     * Get Sections Bulk Handler
+     */
+    getSectionsBulkRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSectionsBulkRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SectionResponseFromJSON));
+        });
+    }
+    /**
+     * Batch-fetch sections by ID.  Returns sections with system_metadata. Non-existent IDs are silently skipped. Limited to 200 IDs per call.
+     * Get Sections Bulk Handler
+     */
+    getSectionsBulk() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getSectionsBulkRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for updateSection without sending the request
      */