@knowledge-stack/ksapi 1.4.0 → 1.6.0

package/dist/models/index.js

@@ -16,9 +16,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
+__exportStar(require("./CreateDocumentRequest"), exports);
 __exportStar(require("./CreateFolderRequest"), exports);
 __exportStar(require("./CreatePasswordUserRequest"), exports);
 __exportStar(require("./CreateTenantRequest"), exports);
+__exportStar(require("./DocumentOrigin"), exports);
+__exportStar(require("./DocumentResponse"), exports);
+__exportStar(require("./DocumentType"), exports);
+__exportStar(require("./DocumentVersionResponse"), exports);
 __exportStar(require("./EmailSentResponse"), exports);
 __exportStar(require("./EmailVerificationRequest"), exports);
 __exportStar(require("./FolderResponse"), exports);
@@ -29,6 +34,8 @@ __exportStar(require("./InviteResponse"), exports);
 __exportStar(require("./InviteStatus"), exports);
 __exportStar(require("./InviteUserRequest"), exports);
 __exportStar(require("./OAuth2Config"), exports);
+__exportStar(require("./PaginatedResponseDocumentResponse"), exports);
+__exportStar(require("./PaginatedResponseDocumentVersionResponse"), exports);
 __exportStar(require("./PaginatedResponseFolderResponse"), exports);
 __exportStar(require("./PaginatedResponseInviteResponse"), exports);
 __exportStar(require("./PaginatedResponsePathPartResponse"), exports);
@@ -44,6 +51,7 @@ __exportStar(require("./SignInRequest"), exports);
 __exportStar(require("./TenantResponse"), exports);
 __exportStar(require("./TenantUserInTenantResponse"), exports);
 __exportStar(require("./TenantUserRole"), exports);
+__exportStar(require("./UpdateDocumentRequest"), exports);
 __exportStar(require("./UpdateFolderRequest"), exports);
 __exportStar(require("./UpdateTenantRequest"), exports);
 __exportStar(require("./UpdateUserRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DocumentVersionsApi.ts

@@ -0,0 +1,303 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  DocumentVersionResponse,
+  HTTPValidationError,
+  PaginatedResponseDocumentVersionResponse,
+} from '../models/index';
+import {
+    DocumentVersionResponseFromJSON,
+    DocumentVersionResponseToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    PaginatedResponseDocumentVersionResponseFromJSON,
+    PaginatedResponseDocumentVersionResponseToJSON,
+} 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 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
+     */
+    async createDocumentVersionRaw(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
+        if (requestParameters['documentId'] == null) {
+            throw new runtime.RequiredError(
+                'documentId',
+                'Required parameter "documentId" was null or undefined when calling createDocumentVersion().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/documents/{document_id}/versions`;
+        urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+
+        const response = await 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
+     */
+    async createDocumentVersion(requestParameters: CreateDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse> {
+        const response = await this.createDocumentVersionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a document version by its ID.  Cannot delete the active version of a document.
+     * Delete Document Version Handler
+     */
+    async deleteDocumentVersionRaw(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling deleteDocumentVersion().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/document_versions/{version_id}`;
+        urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+
+        const response = await 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
+     */
+    async deleteDocumentVersion(requestParameters: DeleteDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteDocumentVersionRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a document version by its ID.
+     * Get Document Version Handler
+     */
+    async getDocumentVersionRaw(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentVersionResponse>> {
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling getDocumentVersion().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/document_versions/{version_id}`;
+        urlPath = urlPath.replace(`{${"version_id"}}`, encodeURIComponent(String(requestParameters['versionId'])));
+
+        const response = await 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
+     */
+    async getDocumentVersion(requestParameters: GetDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentVersionResponse> {
+        const response = await this.getDocumentVersionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all versions for a document.  Returns versions ordered by version number ascending (v0, v1, v2...).
+     * List Document Versions Handler
+     */
+    async listDocumentVersionsRaw(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentVersionResponse>> {
+        if (requestParameters['documentId'] == null) {
+            throw new runtime.RequiredError(
+                'documentId',
+                'Required parameter "documentId" was null or undefined when calling listDocumentVersions().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        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: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/document_versions`;
+
+        const response = await 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
+     */
+    async listDocumentVersions(requestParameters: ListDocumentVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentVersionResponse> {
+        const response = await this.listDocumentVersionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}