@knowledge-stack/ksapi 1.4.0 → 1.6.0

package/dist/apis/DocumentsApi.js

@@ -0,0 +1,206 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class DocumentsApi extends runtime.BaseAPI {
+    /**
+     * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
+     * Create Document Handler
+     */
+    createDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createDocumentRequest'] == null) {
+                throw new runtime.RequiredError('createDocumentRequest', 'Required parameter "createDocumentRequest" was null or undefined when calling createDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/documents`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateDocumentRequestToJSON)(requestParameters['createDocumentRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create a new document with initial v0 version.  The document is created as a child of the specified parent folder. An initial version (v0) is automatically created.
+     * Create Document Handler
+     */
+    createDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * Delete Document Handler
+     */
+    deleteDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling deleteDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/documents/{document_id}`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * Delete Document Handler
+     */
+    deleteDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteDocumentRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    getDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling getDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/documents/{document_id}`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    getDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
+     * List Documents Handler
+     */
+    listDocumentsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['parentId'] != null) {
+                queryParameters['parent_id'] = requestParameters['parentId'];
+            }
+            if (requestParameters['sortOrder'] != null) {
+                queryParameters['sort_order'] = requestParameters['sortOrder'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            let urlPath = `/v1/documents`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseDocumentResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_id is not provided, lists documents in the root folder.
+     * List Documents Handler
+     */
+    listDocuments() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listDocumentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
+     * Update Document Handler
+     */
+    updateDocumentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling updateDocument().');
+            }
+            if (requestParameters['updateDocumentRequest'] == null) {
+                throw new runtime.RequiredError('updateDocumentRequest', 'Required parameter "updateDocumentRequest" was null or undefined when calling updateDocument().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/v1/documents/{document_id}`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateDocumentRequestToJSON)(requestParameters['updateDocumentRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DocumentResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Update a document (rename, move, and/or change active version).  To rename: provide `name` field. To move: provide `parent_id` field. To change active version: provide `active_version_id` field. All can be done in a single request.
+     * Update Document Handler
+     */
+    updateDocument(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateDocumentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.DocumentsApi = DocumentsApi;

package/dist/apis/index.d.ts

@@ -1,5 +1,7 @@
 export * from './AuthApi';
 export * from './DefaultApi';
+export * from './DocumentVersionsApi';
+export * from './DocumentsApi';
 export * from './FoldersApi';
 export * from './InvitesApi';
 export * from './PathPartsApi';

package/dist/apis/index.js

@@ -18,6 +18,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable */
 __exportStar(require("./AuthApi"), exports);
 __exportStar(require("./DefaultApi"), exports);
+__exportStar(require("./DocumentVersionsApi"), exports);
+__exportStar(require("./DocumentsApi"), exports);
 __exportStar(require("./FoldersApi"), exports);
 __exportStar(require("./InvitesApi"), exports);
 __exportStar(require("./PathPartsApi"), exports);

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

@@ -0,0 +1,146 @@
+/**
+ * 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 { DocumentVersionResponse, PaginatedResponseDocumentVersionResponse } from '../models/index';
+export interface CreateDocumentVersionRequest {
+    documentId: string;
+    ksUat?: string;
+}
+export interface DeleteDocumentVersionRequest {
+    versionId: string;
+    ksUat?: string;
+}
+export interface GetDocumentVersionRequest {
+    versionId: string;
+    ksUat?: string;
+}
+export interface ListDocumentVersionsRequest {
+    documentId: string;
+    limit?: number;
+    offset?: number;
+    ksUat?: string;
+}
+/**
+ * DocumentVersionsApi - interface
+ *
+ * @export
+ * @interface DocumentVersionsApiInterface
+ */
+export interface DocumentVersionsApiInterface {
+    /**
+     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+     * @summary Create Document Version Handler
+     * @param {string} documentId Document ID
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
+    /**
+     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+     * Create Document Version Handler
+     */
+    createDocumentVersion(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * @summary Delete Document Version Handler
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * Delete Document Version Handler
+     */
+    deleteDocumentVersion(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get a document version by its ID.
+     * @summary Get Document Version Handler
+     * @param {string} versionId DocumentVersion ID
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * @summary List Document Versions Handler
+     * @param {string} documentId Document ID to list versions for
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentVersionsApiInterface
+     */
+    listDocumentVersionsRaw(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentVersionResponse>>;
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * List Document Versions Handler
+     */
+    listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse>;
+}
+/**
+ *
+ */
+export declare class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVersionsApiInterface {
+    /**
+     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+     * Create Document Version Handler
+     */
+    createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
+    /**
+     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+     * Create Document Version Handler
+     */
+    createDocumentVersion(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * Delete Document Version Handler
+     */
+    deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * Delete Document Version Handler
+     */
+    deleteDocumentVersion(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>>;
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse>;
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * List Document Versions Handler
+     */
+    listDocumentVersionsRaw(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentVersionResponse>>;
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * List Document Versions Handler
+     */
+    listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse>;
+}

package/dist/esm/apis/DocumentVersionsApi.js

@@ -0,0 +1,164 @@
+/* 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 { DocumentVersionResponseFromJSON, PaginatedResponseDocumentVersionResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class DocumentVersionsApi extends runtime.BaseAPI {
+    /**
+     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+     * Create Document Version Handler
+     */
+    createDocumentVersionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling createDocumentVersion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/documents/{document_id}/versions`;
+            urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+     * Create Document Version Handler
+     */
+    createDocumentVersion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createDocumentVersionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * Delete Document Version Handler
+     */
+    deleteDocumentVersionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling deleteDocumentVersion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/document_versions/{version_id}`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * Delete Document Version Handler
+     */
+    deleteDocumentVersion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteDocumentVersionRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    getDocumentVersionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling getDocumentVersion().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/v1/document_versions/{version_id}`;
+            urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DocumentVersionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    getDocumentVersion(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDocumentVersionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * List Document Versions Handler
+     */
+    listDocumentVersionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['documentId'] == null) {
+                throw new runtime.RequiredError('documentId', 'Required parameter "documentId" was null or undefined when calling listDocumentVersions().');
+            }
+            const queryParameters = {};
+            if (requestParameters['documentId'] != null) {
+                queryParameters['document_id'] = requestParameters['documentId'];
+            }
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            const headerParameters = {};
+            let urlPath = `/v1/document_versions`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseDocumentVersionResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * List Document Versions Handler
+     */
+    listDocumentVersions(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listDocumentVersionsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}