@knowledge-stack/ksapi 1.4.0 → 1.5.0

package/dist/models/UpdateDocumentRequest.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+/**
+ * Request to update a document (rename, move, and/or change active version).
+ * @export
+ * @interface UpdateDocumentRequest
+ */
+export interface UpdateDocumentRequest {
+    /**
+     * New document name
+     * @type {string}
+     * @memberof UpdateDocumentRequest
+     */
+    name?: string;
+    /**
+     * New parent folder PathPart ID (for move)
+     * @type {string}
+     * @memberof UpdateDocumentRequest
+     */
+    parentId?: string;
+    /**
+     * New active version ID
+     * @type {string}
+     * @memberof UpdateDocumentRequest
+     */
+    activeVersionId?: string;
+}
+/**
+ * Check if a given object implements the UpdateDocumentRequest interface.
+ */
+export declare function instanceOfUpdateDocumentRequest(value: object): value is UpdateDocumentRequest;
+export declare function UpdateDocumentRequestFromJSON(json: any): UpdateDocumentRequest;
+export declare function UpdateDocumentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateDocumentRequest;
+export declare function UpdateDocumentRequestToJSON(json: any): UpdateDocumentRequest;
+export declare function UpdateDocumentRequestToJSONTyped(value?: UpdateDocumentRequest | null, ignoreDiscriminator?: boolean): any;
+export declare const UpdateDocumentRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/models/UpdateDocumentRequest.js

@@ -0,0 +1,59 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateDocumentRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfUpdateDocumentRequest = instanceOfUpdateDocumentRequest;
+exports.UpdateDocumentRequestFromJSON = UpdateDocumentRequestFromJSON;
+exports.UpdateDocumentRequestFromJSONTyped = UpdateDocumentRequestFromJSONTyped;
+exports.UpdateDocumentRequestToJSON = UpdateDocumentRequestToJSON;
+exports.UpdateDocumentRequestToJSONTyped = UpdateDocumentRequestToJSONTyped;
+/**
+ * Check if a given object implements the UpdateDocumentRequest interface.
+ */
+function instanceOfUpdateDocumentRequest(value) {
+    return true;
+}
+function UpdateDocumentRequestFromJSON(json) {
+    return UpdateDocumentRequestFromJSONTyped(json, false);
+}
+function UpdateDocumentRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'parentId': json['parent_id'] == null ? undefined : json['parent_id'],
+        'activeVersionId': json['active_version_id'] == null ? undefined : json['active_version_id'],
+    };
+}
+function UpdateDocumentRequestToJSON(json) {
+    return UpdateDocumentRequestToJSONTyped(json, false);
+}
+function UpdateDocumentRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'parent_id': value['parentId'],
+        'active_version_id': value['activeVersionId'],
+    };
+}
+exports.UpdateDocumentRequestPropertyValidationAttributesMap = {
+    name: {
+        maxLength: 255,
+        minLength: 1,
+    },
+};

package/dist/models/index.d.ts

@@ -1,6 +1,11 @@
+export * from './CreateDocumentRequest';
 export * from './CreateFolderRequest';
 export * from './CreatePasswordUserRequest';
 export * from './CreateTenantRequest';
+export * from './DocumentOrigin';
+export * from './DocumentResponse';
+export * from './DocumentType';
+export * from './DocumentVersionResponse';
 export * from './EmailSentResponse';
 export * from './EmailVerificationRequest';
 export * from './FolderResponse';
@@ -11,6 +16,7 @@ export * from './InviteResponse';
 export * from './InviteStatus';
 export * from './InviteUserRequest';
 export * from './OAuth2Config';
+export * from './PaginatedResponseDocumentResponse';
 export * from './PaginatedResponseFolderResponse';
 export * from './PaginatedResponseInviteResponse';
 export * from './PaginatedResponsePathPartResponse';
@@ -26,6 +32,7 @@ export * from './SignInRequest';
 export * from './TenantResponse';
 export * from './TenantUserInTenantResponse';
 export * from './TenantUserRole';
+export * from './UpdateDocumentRequest';
 export * from './UpdateFolderRequest';
 export * from './UpdateTenantRequest';
 export * from './UpdateUserRequest';

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,7 @@ __exportStar(require("./InviteResponse"), exports);
 __exportStar(require("./InviteStatus"), exports);
 __exportStar(require("./InviteUserRequest"), exports);
 __exportStar(require("./OAuth2Config"), exports);
+__exportStar(require("./PaginatedResponseDocumentResponse"), exports);
 __exportStar(require("./PaginatedResponseFolderResponse"), exports);
 __exportStar(require("./PaginatedResponseInviteResponse"), exports);
 __exportStar(require("./PaginatedResponsePathPartResponse"), exports);
@@ -44,6 +50,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.5.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DocumentsApi.ts

@@ -0,0 +1,386 @@
+/* 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 {
+  CreateDocumentRequest,
+  DocumentResponse,
+  HTTPValidationError,
+  PaginatedResponseDocumentResponse,
+  PathOrder,
+  UpdateDocumentRequest,
+} from '../models/index';
+import {
+    CreateDocumentRequestFromJSON,
+    CreateDocumentRequestToJSON,
+    DocumentResponseFromJSON,
+    DocumentResponseToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    PaginatedResponseDocumentResponseFromJSON,
+    PaginatedResponseDocumentResponseToJSON,
+    PathOrderFromJSON,
+    PathOrderToJSON,
+    UpdateDocumentRequestFromJSON,
+    UpdateDocumentRequestToJSON,
+} from '../models/index';
+
+export interface CreateDocumentOperationRequest {
+    createDocumentRequest: CreateDocumentRequest;
+    ksUat?: string;
+}
+
+export interface DeleteDocumentRequest {
+    documentId: string;
+    ksUat?: string;
+}
+
+export interface GetDocumentRequest {
+    documentId: string;
+    ksUat?: string;
+}
+
+export interface ListDocumentsRequest {
+    parentId?: string;
+    sortOrder?: PathOrder;
+    limit?: number;
+    offset?: number;
+    ksUat?: string;
+}
+
+export interface UpdateDocumentOperationRequest {
+    documentId: string;
+    updateDocumentRequest: UpdateDocumentRequest;
+    ksUat?: string;
+}
+
+/**
+ * DocumentsApi - interface
+ * 
+ * @export
+ * @interface DocumentsApiInterface
+ */
+export interface DocumentsApiInterface {
+    /**
+     * 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.
+     * @summary Create Document Handler
+     * @param {CreateDocumentRequest} createDocumentRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    createDocumentRaw(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+
+    /**
+     * 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: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+
+    /**
+     * Delete a document and all its contents.  WARNING: This cascades to all children (versions, sections, chunks, etc.) due to parent_id ON DELETE CASCADE.
+     * @summary Delete Document Handler
+     * @param {string} documentId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * 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: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Get a document by its document ID.
+     * @summary Get Document Handler
+     * @param {string} documentId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+
+    /**
+     * 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.
+     * @summary List Documents Handler
+     * @param {string} [parentId] Parent folder PathPart ID (defaults to root)
+     * @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] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
+
+    /**
+     * 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(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
+
+    /**
+     * 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.
+     * @summary Update Document Handler
+     * @param {string} documentId 
+     * @param {UpdateDocumentRequest} updateDocumentRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApiInterface
+     */
+    updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>>;
+
+    /**
+     * 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: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse>;
+
+}
+
+/**
+ * 
+ */
+export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterface {
+
+    /**
+     * 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
+     */
+    async createDocumentRaw(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+        if (requestParameters['createDocumentRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createDocumentRequest',
+                'Required parameter "createDocumentRequest" was null or undefined when calling createDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/documents`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateDocumentRequestToJSON(requestParameters['createDocumentRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => 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
+     */
+    async createDocument(requestParameters: CreateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse> {
+        const response = await this.createDocumentRaw(requestParameters, initOverrides);
+        return await 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
+     */
+    async deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['documentId'] == null) {
+            throw new runtime.RequiredError(
+                'documentId',
+                'Required parameter "documentId" was null or undefined when calling deleteDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/documents/{document_id}`;
+        urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+
+        const response = await 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
+     */
+    async deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteDocumentRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    async getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+        if (requestParameters['documentId'] == null) {
+            throw new runtime.RequiredError(
+                'documentId',
+                'Required parameter "documentId" was null or undefined when calling getDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/documents/{document_id}`;
+        urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a document by its document ID.
+     * Get Document Handler
+     */
+    async getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse> {
+        const response = await this.getDocumentRaw(requestParameters, initOverrides);
+        return await 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
+     */
+    async listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>> {
+        const queryParameters: any = {};
+
+        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: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/documents`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => 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
+     */
+    async listDocuments(requestParameters: ListDocumentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse> {
+        const response = await this.listDocumentsRaw(requestParameters, initOverrides);
+        return await 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
+     */
+    async updateDocumentRaw(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentResponse>> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/documents/{document_id}`;
+        urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateDocumentRequestToJSON(requestParameters['updateDocumentRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => 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
+     */
+    async updateDocument(requestParameters: UpdateDocumentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentResponse> {
+        const response = await this.updateDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -2,6 +2,7 @@
 /* eslint-disable */
 export * from './AuthApi';
 export * from './DefaultApi';
+export * from './DocumentsApi';
 export * from './FoldersApi';
 export * from './InvitesApi';
 export * from './PathPartsApi';