@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/src/apis/PathPartsApi.ts

@@ -70,6 +70,16 @@ export interface ListPathPartsRequest {
  * @interface PathPartsApiInterface
  */
 export interface PathPartsApiInterface {
+    /**
+     * Creates request options for bulkAddPathPartTags without sending the request
+     * @param {string} pathPartId 
+     * @param {BulkTagRequest} bulkTagRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    bulkAddPathPartTagsRequestOpts(requestParameters: BulkAddPathPartTagsRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Bulk add tags to a path part.  Idempotent — already-attached tags are skipped. Returns 400 if any tag_id doesn\'t exist (FK violation). Requires write permission on the target path part.
      * @summary Bulk Add Path Part Tags Handler
@@ -88,6 +98,16 @@ export interface PathPartsApiInterface {
      */
     bulkAddPathPartTags(requestParameters: BulkAddPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartTagsResponse>;
 
+    /**
+     * Creates request options for bulkRemovePathPartTags without sending the request
+     * @param {string} pathPartId 
+     * @param {BulkTagRequest} bulkTagRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    bulkRemovePathPartTagsRequestOpts(requestParameters: BulkRemovePathPartTagsRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Bulk remove tags from a path part.  Silently ignores tags that aren\'t attached. Requires write permission on the target path part.
      * @summary Bulk Remove Path Part Tags Handler
@@ -106,6 +126,15 @@ export interface PathPartsApiInterface {
      */
     bulkRemovePathPartTags(requestParameters: BulkRemovePathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartTagsResponse>;
 
+    /**
+     * Creates request options for getPathPart without sending the request
+     * @param {string} pathPartId 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    getPathPartRequestOpts(requestParameters: GetPathPartRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Get a path part by its ID.  Returns the path part with its attached tag IDs.
      * @summary Get Path Part Handler
@@ -123,6 +152,19 @@ export interface PathPartsApiInterface {
      */
     getPathPart(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartResponse>;
 
+    /**
+     * Creates request options for listPathParts without sending the request
+     * @param {string} [parentPathId] Parent PathPart ID (defaults to root)
+     * @param {number} [maxDepth] Maximum depth to traverse (1 &#x3D; direct children, default: 1)
+     * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    listPathPartsRequestOpts(requestParameters: ListPathPartsRequest): Promise<runtime.RequestOpts>;
+
     /**
      * List path parts (folders) under a parent with traversal.  This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts.  - If parent_path_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.  For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
      * @summary List Path Parts Handler
@@ -152,10 +194,9 @@ export interface PathPartsApiInterface {
 export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterface {
 
     /**
-     * Bulk add tags to a path part.  Idempotent — already-attached tags are skipped. Returns 400 if any tag_id doesn\'t exist (FK violation). Requires write permission on the target path part.
-     * Bulk Add Path Part Tags Handler
+     * Creates request options for bulkAddPathPartTags without sending the request
      */
-    async bulkAddPathPartTagsRaw(requestParameters: BulkAddPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartTagsResponse>> {
+    async bulkAddPathPartTagsRequestOpts(requestParameters: BulkAddPathPartTagsRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['pathPartId'] == null) {
             throw new runtime.RequiredError(
                 'pathPartId',
@@ -180,13 +221,22 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
         let urlPath = `/v1/path-parts/{path_part_id}/tags`;
         urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: BulkTagRequestToJSON(requestParameters['bulkTagRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Bulk add tags to a path part.  Idempotent — already-attached tags are skipped. Returns 400 if any tag_id doesn\'t exist (FK violation). Requires write permission on the target path part.
+     * Bulk Add Path Part Tags Handler
+     */
+    async bulkAddPathPartTagsRaw(requestParameters: BulkAddPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartTagsResponse>> {
+        const requestOptions = await this.bulkAddPathPartTagsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PathPartTagsResponseFromJSON(jsonValue));
     }
@@ -201,10 +251,9 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
     }
 
     /**
-     * Bulk remove tags from a path part.  Silently ignores tags that aren\'t attached. Requires write permission on the target path part.
-     * Bulk Remove Path Part Tags Handler
+     * Creates request options for bulkRemovePathPartTags without sending the request
      */
-    async bulkRemovePathPartTagsRaw(requestParameters: BulkRemovePathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartTagsResponse>> {
+    async bulkRemovePathPartTagsRequestOpts(requestParameters: BulkRemovePathPartTagsRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['pathPartId'] == null) {
             throw new runtime.RequiredError(
                 'pathPartId',
@@ -229,13 +278,22 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
         let urlPath = `/v1/path-parts/{path_part_id}/tags`;
         urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
             body: BulkTagRequestToJSON(requestParameters['bulkTagRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Bulk remove tags from a path part.  Silently ignores tags that aren\'t attached. Requires write permission on the target path part.
+     * Bulk Remove Path Part Tags Handler
+     */
+    async bulkRemovePathPartTagsRaw(requestParameters: BulkRemovePathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartTagsResponse>> {
+        const requestOptions = await this.bulkRemovePathPartTagsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PathPartTagsResponseFromJSON(jsonValue));
     }
@@ -250,10 +308,9 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
     }
 
     /**
-     * Get a path part by its ID.  Returns the path part with its attached tag IDs.
-     * Get Path Part Handler
+     * Creates request options for getPathPart without sending the request
      */
-    async getPathPartRaw(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>> {
+    async getPathPartRequestOpts(requestParameters: GetPathPartRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['pathPartId'] == null) {
             throw new runtime.RequiredError(
                 'pathPartId',
@@ -269,12 +326,21 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
         let urlPath = `/v1/path-parts/{path_part_id}`;
         urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a path part by its ID.  Returns the path part with its attached tag IDs.
+     * Get Path Part Handler
+     */
+    async getPathPartRaw(requestParameters: GetPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PathPartResponse>> {
+        const requestOptions = await this.getPathPartRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PathPartResponseFromJSON(jsonValue));
     }
@@ -289,10 +355,9 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
     }
 
     /**
-     * List path parts (folders) under a parent with traversal.  This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts.  - If parent_path_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.  For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
-     * List Path Parts Handler
+     * Creates request options for listPathParts without sending the request
      */
-    async listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>> {
+    async listPathPartsRequestOpts(requestParameters: ListPathPartsRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         if (requestParameters['parentPathId'] != null) {
@@ -320,12 +385,21 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
 
         let urlPath = `/v1/path-parts`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * List path parts (folders) under a parent with traversal.  This is a generic endpoint for traversing the folder hierarchy. It returns only FOLDER type path parts.  - If parent_path_id is not provided, lists contents of the root folder. - max_depth controls how deep to traverse (1 = direct children only). - sort_order controls the ordering: LOGICAL (linked-list), NAME, UPDATED_AT, CREATED_AT.  For listing folder contents that includes documents with enriched metadata, use GET /folders/{folder_id}/contents instead.
+     * List Path Parts Handler
+     */
+    async listPathPartsRaw(requestParameters: ListPathPartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePathPartResponse>> {
+        const requestOptions = await this.listPathPartsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponsePathPartResponseFromJSON(jsonValue));
     }

package/src/apis/SectionsApi.ts

@@ -59,6 +59,15 @@ export interface UpdateSectionOperationRequest {
  * @interface SectionsApiInterface
  */
 export interface SectionsApiInterface {
+    /**
+     * Creates request options for createSection without sending the request
+     * @param {CreateSectionRequest} createSectionRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof SectionsApiInterface
+     */
+    createSectionRequestOpts(requestParameters: CreateSectionOperationRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Create a new section.  The section is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). If prev_sibling_path_id is provided, the section is inserted after that sibling; otherwise it is appended to the end of the sibling list.
      * @summary Create Section Handler
@@ -76,6 +85,15 @@ export interface SectionsApiInterface {
      */
     createSection(requestParameters: CreateSectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SectionResponse>;
 
+    /**
+     * Creates request options for deleteSection without sending the request
+     * @param {string} sectionId 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof SectionsApiInterface
+     */
+    deleteSectionRequestOpts(requestParameters: DeleteSectionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Delete a section and all its children.  WARNING: This cascades to all child sections due to parent_id ON DELETE CASCADE.
      * @summary Delete Section Handler
@@ -93,6 +111,15 @@ export interface SectionsApiInterface {
      */
     deleteSection(requestParameters: DeleteSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Creates request options for getSection without sending the request
+     * @param {string} sectionId 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof SectionsApiInterface
+     */
+    getSectionRequestOpts(requestParameters: GetSectionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Get a section by its ID.
      * @summary Get Section Handler
@@ -110,6 +137,16 @@ export interface SectionsApiInterface {
      */
     getSection(requestParameters: GetSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SectionResponse>;
 
+    /**
+     * Creates request options for updateSection without sending the request
+     * @param {string} sectionId 
+     * @param {UpdateSectionRequest} updateSectionRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof SectionsApiInterface
+     */
+    updateSectionRequestOpts(requestParameters: UpdateSectionOperationRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Update a section.  Can update name, page_number, and/or reorder within siblings. To move: provide prev_sibling_path_id OR move_to_head (not both). Moving is only allowed within the same document version.  Note: Section names can contain any characters. The corresponding path_part.name will be automatically normalized by a database trigger.
      * @summary Update Section Handler
@@ -136,10 +173,9 @@ export interface SectionsApiInterface {
 export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface {
 
     /**
-     * Create a new section.  The section is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). If prev_sibling_path_id is provided, the section is inserted after that sibling; otherwise it is appended to the end of the sibling list.
-     * Create Section Handler
+     * Creates request options for createSection without sending the request
      */
-    async createSectionRaw(requestParameters: CreateSectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
+    async createSectionRequestOpts(requestParameters: CreateSectionOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['createSectionRequest'] == null) {
             throw new runtime.RequiredError(
                 'createSectionRequest',
@@ -156,13 +192,22 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
 
         let urlPath = `/v1/sections`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: CreateSectionRequestToJSON(requestParameters['createSectionRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Create a new section.  The section is created as a child of the specified parent (must be DOCUMENT_VERSION or SECTION). If prev_sibling_path_id is provided, the section is inserted after that sibling; otherwise it is appended to the end of the sibling list.
+     * Create Section Handler
+     */
+    async createSectionRaw(requestParameters: CreateSectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
+        const requestOptions = await this.createSectionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => SectionResponseFromJSON(jsonValue));
     }
@@ -177,10 +222,9 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
     }
 
     /**
-     * Delete a section and all its children.  WARNING: This cascades to all child sections due to parent_id ON DELETE CASCADE.
-     * Delete Section Handler
+     * Creates request options for deleteSection without sending the request
      */
-    async deleteSectionRaw(requestParameters: DeleteSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async deleteSectionRequestOpts(requestParameters: DeleteSectionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['sectionId'] == null) {
             throw new runtime.RequiredError(
                 'sectionId',
@@ -196,12 +240,21 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
         let urlPath = `/v1/sections/{section_id}`;
         urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Delete a section and all its children.  WARNING: This cascades to all child sections due to parent_id ON DELETE CASCADE.
+     * Delete Section Handler
+     */
+    async deleteSectionRaw(requestParameters: DeleteSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteSectionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -215,10 +268,9 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
     }
 
     /**
-     * Get a section by its ID.
-     * Get Section Handler
+     * Creates request options for getSection without sending the request
      */
-    async getSectionRaw(requestParameters: GetSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
+    async getSectionRequestOpts(requestParameters: GetSectionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['sectionId'] == null) {
             throw new runtime.RequiredError(
                 'sectionId',
@@ -234,12 +286,21 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
         let urlPath = `/v1/sections/{section_id}`;
         urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a section by its ID.
+     * Get Section Handler
+     */
+    async getSectionRaw(requestParameters: GetSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
+        const requestOptions = await this.getSectionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => SectionResponseFromJSON(jsonValue));
     }
@@ -254,10 +315,9 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
     }
 
     /**
-     * Update a section.  Can update name, page_number, and/or reorder within siblings. To move: provide prev_sibling_path_id OR move_to_head (not both). Moving is only allowed within the same document version.  Note: Section names can contain any characters. The corresponding path_part.name will be automatically normalized by a database trigger.
-     * Update Section Handler
+     * Creates request options for updateSection without sending the request
      */
-    async updateSectionRaw(requestParameters: UpdateSectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
+    async updateSectionRequestOpts(requestParameters: UpdateSectionOperationRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['sectionId'] == null) {
             throw new runtime.RequiredError(
                 'sectionId',
@@ -282,13 +342,22 @@ export class SectionsApi extends runtime.BaseAPI implements SectionsApiInterface
         let urlPath = `/v1/sections/{section_id}`;
         urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
             body: UpdateSectionRequestToJSON(requestParameters['updateSectionRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update a section.  Can update name, page_number, and/or reorder within siblings. To move: provide prev_sibling_path_id OR move_to_head (not both). Moving is only allowed within the same document version.  Note: Section names can contain any characters. The corresponding path_part.name will be automatically normalized by a database trigger.
+     * Update Section Handler
+     */
+    async updateSectionRaw(requestParameters: UpdateSectionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SectionResponse>> {
+        const requestOptions = await this.updateSectionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => SectionResponseFromJSON(jsonValue));
     }