@knowledge-stack/ksapi 1.66.2 → 1.67.0

package/dist/esm/apis/SectionsApi.js

@@ -0,0 +1,297 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CreateSectionRequestToJSON, DissolveSectionResponseFromJSON, SectionResponseFromJSON, UpdateSectionRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class SectionsApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createSection without sending the request
+     */
+    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().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/sections`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateSectionRequestToJSON(requestParameters['createSectionRequest']),
+            };
+        });
+    }
+    /**
+     * 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) => SectionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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
+     */
+    createSection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createSectionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for deleteSection without sending the request
+     */
+    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().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/sections/{section_id}`;
+            urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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);
+        });
+    }
+    /**
+     * Delete a section and all its children.  WARNING: This cascades to all child sections due to parent_id ON DELETE CASCADE.
+     * Delete Section Handler
+     */
+    deleteSection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteSectionRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for dissolveSection without sending the request
+     */
+    dissolveSectionRequestOpts(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 dissolveSection().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/sections/{section_id}/dissolve`;
+            urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Dissolve a section: convert it to a text chunk, reparent children, delete the section.  The section\'s name becomes the content of a new TEXT chunk. Any children of the section are reparented to the section\'s parent, preserving order. The section itself is then deleted.
+     * Dissolve Section Handler
+     */
+    dissolveSectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.dissolveSectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DissolveSectionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Dissolve a section: convert it to a text chunk, reparent children, delete the section.  The section\'s name becomes the content of a new TEXT chunk. Any children of the section are reparented to the section\'s parent, preserving order. The section itself is then deleted.
+     * Dissolve Section Handler
+     */
+    dissolveSection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.dissolveSectionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getSection without sending the request
+     */
+    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().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/sections/{section_id}`;
+            urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * 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) => SectionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a section by its ID.
+     * Get Section Handler
+     */
+    getSection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSectionRaw(requestParameters, initOverrides);
+            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
+     */
+    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().');
+            }
+            if (requestParameters['updateSectionRequest'] == null) {
+                throw new runtime.RequiredError('updateSectionRequest', 'Required parameter "updateSectionRequest" was null or undefined when calling updateSection().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['authorization'] != null) {
+                headerParameters['authorization'] = String(requestParameters['authorization']);
+            }
+            let urlPath = `/v1/sections/{section_id}`;
+            urlPath = urlPath.replace(`{${"section_id"}}`, encodeURIComponent(String(requestParameters['sectionId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateSectionRequestToJSON(requestParameters['updateSectionRequest']),
+            };
+        });
+    }
+    /**
+     * 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) => SectionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * 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
+     */
+    updateSection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateSectionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -0,0 +1,252 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CreateTagRequest, PaginatedResponseTagResponse, TagResponse, UpdateTagRequest } from '../models/index';
+export interface CreateTagOperationRequest {
+    createTagRequest: CreateTagRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface DeleteTagRequest {
+    tagId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface GetTagRequest {
+    tagId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface ListTagsRequest {
+    limit?: number;
+    offset?: number;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface UpdateTagOperationRequest {
+    tagId: string;
+    updateTagRequest: UpdateTagRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+/**
+ * TagsApi - interface
+ *
+ * @export
+ * @interface TagsApiInterface
+ */
+export interface TagsApiInterface {
+    /**
+     * Creates request options for createTag without sending the request
+     * @param {CreateTagRequest} createTagRequest
+     * @param {string} [authorization]
+     * @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
+     * @param {CreateTagRequest} createTagRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    createTagRaw(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+    /**
+     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
+     * 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} [authorization]
+     * @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
+     * @param {string} tagId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    deleteTagRaw(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
+     * 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} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    getTagRequestOpts(requestParameters: GetTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a tag by its ID.
+     * @summary Get Tag Handler
+     * @param {string} tagId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    getTagRaw(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+    /**
+     * Get a tag by its ID.
+     * 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} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    listTagsRequestOpts(requestParameters: ListTagsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List all tags for the current tenant.
+     * @summary List Tags Handler
+     * @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 TagsApiInterface
+     */
+    listTagsRaw(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseTagResponse>>;
+    /**
+     * List all tags for the current tenant.
+     * 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} [authorization]
+     * @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
+     * @param {string} tagId
+     * @param {UpdateTagRequest} updateTagRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    updateTagRaw(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+    /**
+     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
+     * Update Tag Handler
+     */
+    updateTag(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+}
+/**
+ *
+ */
+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
+     */
+    createTagRaw(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+    /**
+     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
+     * 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
+     */
+    deleteTagRaw(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
+     * 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
+     */
+    getTagRaw(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+    /**
+     * Get a tag by its ID.
+     * 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
+     */
+    listTagsRaw(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseTagResponse>>;
+    /**
+     * List all tags for the current tenant.
+     * 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
+     */
+    updateTagRaw(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+    /**
+     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
+     * Update Tag Handler
+     */
+    updateTag(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+}