@knowledge-stack/ksapi 1.23.5 → 1.25.0

package/dist/apis/SectionsApi.js

@@ -30,10 +30,9 @@ const index_1 = require("../models/index");
  */
 class SectionsApi extends runtime.BaseAPI {
     /**
-     * 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
      */
-    createSectionRaw(requestParameters, initOverrides) {
+    createSectionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['createSectionRequest'] == null) {
                 throw new runtime.RequiredError('createSectionRequest', 'Required parameter "createSectionRequest" was null or undefined when calling createSection().');
@@ -42,13 +41,23 @@ class SectionsApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/v1/sections`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.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
+     */
+    createSectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createSectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SectionResponseFromJSON)(jsonValue));
         });
     }
@@ -63,10 +72,9 @@ class SectionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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
      */
-    deleteSectionRaw(requestParameters, initOverrides) {
+    deleteSectionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sectionId'] == null) {
                 throw new runtime.RequiredError('sectionId', 'Required parameter "sectionId" was null or undefined when calling deleteSection().');
@@ -75,12 +83,22 @@ class SectionsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/sections/{section_id}`;
             urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
-            const response = yield 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
+     */
+    deleteSectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteSectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -94,10 +112,9 @@ class SectionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a section by its ID.
-     * Get Section Handler
+     * Creates request options for getSection without sending the request
      */
-    getSectionRaw(requestParameters, initOverrides) {
+    getSectionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sectionId'] == null) {
                 throw new runtime.RequiredError('sectionId', 'Required parameter "sectionId" was null or undefined when calling getSection().');
@@ -106,12 +123,22 @@ class SectionsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/sections/{section_id}`;
             urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Get a section by its ID.
+     * Get Section Handler
+     */
+    getSectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SectionResponseFromJSON)(jsonValue));
         });
     }
@@ -126,10 +153,9 @@ class SectionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * 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
      */
-    updateSectionRaw(requestParameters, initOverrides) {
+    updateSectionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sectionId'] == null) {
                 throw new runtime.RequiredError('sectionId', 'Required parameter "sectionId" was null or undefined when calling updateSection().');
@@ -142,13 +168,23 @@ class SectionsApi extends runtime.BaseAPI {
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/v1/sections/{section_id}`;
             urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'PATCH',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.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
+     */
+    updateSectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateSectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SectionResponseFromJSON)(jsonValue));
         });
     }

package/dist/apis/TagsApi.d.ts

@@ -40,6 +40,14 @@ export interface UpdateTagOperationRequest {
  * @interface TagsApiInterface
  */
 export interface TagsApiInterface {
+    /**
+     * Creates request options for createTag without sending the request
+     * @param {CreateTagRequest} createTagRequest
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    createTagRequestOpts(requestParameters: CreateTagOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
      * @summary Create Tag Handler
@@ -55,6 +63,14 @@ export interface TagsApiInterface {
      * Create Tag Handler
      */
     createTag(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+    /**
+     * Creates request options for deleteTag without sending the request
+     * @param {string} tagId
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    deleteTagRequestOpts(requestParameters: DeleteTagRequest): Promise<runtime.RequestOpts>;
     /**
      * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
      * @summary Delete Tag Handler
@@ -70,6 +86,14 @@ export interface TagsApiInterface {
      * Delete Tag Handler
      */
     deleteTag(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getTag without sending the request
+     * @param {string} tagId
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    getTagRequestOpts(requestParameters: GetTagRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a tag by its ID.
      * @summary Get Tag Handler
@@ -85,6 +109,15 @@ export interface TagsApiInterface {
      * Get Tag Handler
      */
     getTag(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+    /**
+     * Creates request options for listTags without sending the request
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    listTagsRequestOpts(requestParameters: ListTagsRequest): Promise<runtime.RequestOpts>;
     /**
      * List all tags for the current tenant.
      * @summary List Tags Handler
@@ -101,6 +134,15 @@ export interface TagsApiInterface {
      * List Tags Handler
      */
     listTags(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseTagResponse>;
+    /**
+     * Creates request options for updateTag without sending the request
+     * @param {string} tagId
+     * @param {UpdateTagRequest} updateTagRequest
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    updateTagRequestOpts(requestParameters: UpdateTagOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
      * @summary Update Tag Handler
@@ -122,6 +164,10 @@ export interface TagsApiInterface {
  *
  */
 export declare class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
+    /**
+     * Creates request options for createTag without sending the request
+     */
+    createTagRequestOpts(requestParameters: CreateTagOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
      * Create Tag Handler
@@ -132,6 +178,10 @@ export declare class TagsApi extends runtime.BaseAPI implements TagsApiInterface
      * Create Tag Handler
      */
     createTag(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+    /**
+     * Creates request options for deleteTag without sending the request
+     */
+    deleteTagRequestOpts(requestParameters: DeleteTagRequest): Promise<runtime.RequestOpts>;
     /**
      * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
      * Delete Tag Handler
@@ -142,6 +192,10 @@ export declare class TagsApi extends runtime.BaseAPI implements TagsApiInterface
      * Delete Tag Handler
      */
     deleteTag(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getTag without sending the request
+     */
+    getTagRequestOpts(requestParameters: GetTagRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a tag by its ID.
      * Get Tag Handler
@@ -152,6 +206,10 @@ export declare class TagsApi extends runtime.BaseAPI implements TagsApiInterface
      * Get Tag Handler
      */
     getTag(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+    /**
+     * Creates request options for listTags without sending the request
+     */
+    listTagsRequestOpts(requestParameters: ListTagsRequest): Promise<runtime.RequestOpts>;
     /**
      * List all tags for the current tenant.
      * List Tags Handler
@@ -162,6 +220,10 @@ export declare class TagsApi extends runtime.BaseAPI implements TagsApiInterface
      * List Tags Handler
      */
     listTags(requestParameters?: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseTagResponse>;
+    /**
+     * Creates request options for updateTag without sending the request
+     */
+    updateTagRequestOpts(requestParameters: UpdateTagOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
      * Update Tag Handler

package/dist/apis/TagsApi.js

@@ -30,10 +30,9 @@ const index_1 = require("../models/index");
  */
 class TagsApi extends runtime.BaseAPI {
     /**
-     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
-     * Create Tag Handler
+     * Creates request options for createTag without sending the request
      */
-    createTagRaw(requestParameters, initOverrides) {
+    createTagRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['createTagRequest'] == null) {
                 throw new runtime.RequiredError('createTagRequest', 'Required parameter "createTagRequest" was null or undefined when calling createTag().');
@@ -42,13 +41,23 @@ class TagsApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/v1/tags`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.CreateTagRequestToJSON)(requestParameters['createTagRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
+     * Create Tag Handler
+     */
+    createTagRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createTagRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TagResponseFromJSON)(jsonValue));
         });
     }
@@ -63,10 +72,9 @@ class TagsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
-     * Delete Tag Handler
+     * Creates request options for deleteTag without sending the request
      */
-    deleteTagRaw(requestParameters, initOverrides) {
+    deleteTagRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['tagId'] == null) {
                 throw new runtime.RequiredError('tagId', 'Required parameter "tagId" was null or undefined when calling deleteTag().');
@@ -75,12 +83,22 @@ class TagsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/tags/{tag_id}`;
             urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'DELETE',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
+     * Delete Tag Handler
+     */
+    deleteTagRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteTagRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -94,10 +112,9 @@ class TagsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a tag by its ID.
-     * Get Tag Handler
+     * Creates request options for getTag without sending the request
      */
-    getTagRaw(requestParameters, initOverrides) {
+    getTagRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['tagId'] == null) {
                 throw new runtime.RequiredError('tagId', 'Required parameter "tagId" was null or undefined when calling getTag().');
@@ -106,12 +123,22 @@ class TagsApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/tags/{tag_id}`;
             urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Get a tag by its ID.
+     * Get Tag Handler
+     */
+    getTagRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getTagRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TagResponseFromJSON)(jsonValue));
         });
     }
@@ -126,10 +153,9 @@ class TagsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List all tags for the current tenant.
-     * List Tags Handler
+     * Creates request options for listTags without sending the request
      */
-    listTagsRaw(requestParameters, initOverrides) {
+    listTagsRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['limit'] != null) {
@@ -140,12 +166,22 @@ class TagsApi extends runtime.BaseAPI {
             }
             const headerParameters = {};
             let urlPath = `/v1/tags`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * List all tags for the current tenant.
+     * List Tags Handler
+     */
+    listTagsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listTagsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseTagResponseFromJSON)(jsonValue));
         });
     }
@@ -160,10 +196,9 @@ class TagsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
-     * Update Tag Handler
+     * Creates request options for updateTag without sending the request
      */
-    updateTagRaw(requestParameters, initOverrides) {
+    updateTagRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['tagId'] == null) {
                 throw new runtime.RequiredError('tagId', 'Required parameter "tagId" was null or undefined when calling updateTag().');
@@ -176,13 +211,23 @@ class TagsApi extends runtime.BaseAPI {
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/v1/tags/{tag_id}`;
             urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'PATCH',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.UpdateTagRequestToJSON)(requestParameters['updateTagRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
+     * Update Tag Handler
+     */
+    updateTagRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateTagRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TagResponseFromJSON)(jsonValue));
         });
     }