@knowledge-stack/ksapi 1.4.0 → 1.6.0

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,8 @@
 /* eslint-disable */
 export * from './AuthApi';
 export * from './DefaultApi';
+export * from './DocumentVersionsApi';
+export * from './DocumentsApi';
 export * from './FoldersApi';
 export * from './InvitesApi';
 export * from './PathPartsApi';

package/src/models/CreateDocumentRequest.ts

@@ -0,0 +1,131 @@
+/* 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 { mapValues } from '../runtime';
+import type { DocumentOrigin } from './DocumentOrigin';
+import {
+    DocumentOriginFromJSON,
+    DocumentOriginFromJSONTyped,
+    DocumentOriginToJSON,
+    DocumentOriginToJSONTyped,
+} from './DocumentOrigin';
+import type { DocumentType } from './DocumentType';
+import {
+    DocumentTypeFromJSON,
+    DocumentTypeFromJSONTyped,
+    DocumentTypeToJSON,
+    DocumentTypeToJSONTyped,
+} from './DocumentType';
+
+/**
+ * Request to create a new document.
+ * @export
+ * @interface CreateDocumentRequest
+ */
+export interface CreateDocumentRequest {
+    /**
+     * Document name
+     * @type {string}
+     * @memberof CreateDocumentRequest
+     */
+    name: string;
+    /**
+     * Parent folder PathPart ID
+     * @type {string}
+     * @memberof CreateDocumentRequest
+     */
+    parentId: string;
+    /**
+     * Type of document (PDF, UNKNOWN, etc.)
+     * @type {DocumentType}
+     * @memberof CreateDocumentRequest
+     */
+    documentType: DocumentType;
+    /**
+     * Origin of document (SOURCE, GENERATED)
+     * @type {DocumentOrigin}
+     * @memberof CreateDocumentRequest
+     */
+    documentOrigin: DocumentOrigin;
+}
+
+
+
+/**
+ * Check if a given object implements the CreateDocumentRequest interface.
+ */
+export function instanceOfCreateDocumentRequest(value: object): value is CreateDocumentRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('documentType' in value) || value['documentType'] === undefined) return false;
+    if (!('documentOrigin' in value) || value['documentOrigin'] === undefined) return false;
+    return true;
+}
+
+export function CreateDocumentRequestFromJSON(json: any): CreateDocumentRequest {
+    return CreateDocumentRequestFromJSONTyped(json, false);
+}
+
+export function CreateDocumentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDocumentRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'parentId': json['parent_id'],
+        'documentType': DocumentTypeFromJSON(json['document_type']),
+        'documentOrigin': DocumentOriginFromJSON(json['document_origin']),
+    };
+}
+
+export function CreateDocumentRequestToJSON(json: any): CreateDocumentRequest {
+    return CreateDocumentRequestToJSONTyped(json, false);
+}
+
+export function CreateDocumentRequestToJSONTyped(value?: CreateDocumentRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'parent_id': value['parentId'],
+        'document_type': DocumentTypeToJSON(value['documentType']),
+        'document_origin': DocumentOriginToJSON(value['documentOrigin']),
+    };
+}
+
+export const CreateDocumentRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    name: {
+        maxLength: 255,
+        minLength: 1,
+    },
+}
+

package/src/models/DocumentOrigin.ts

@@ -0,0 +1,53 @@
+/* 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.
+ */
+
+
+/**
+ * Origin of document - source/purpose (all origins are first-class).
+ * @export
+ */
+export const DocumentOrigin = {
+    Source: 'SOURCE',
+    Generated: 'GENERATED'
+} as const;
+export type DocumentOrigin = typeof DocumentOrigin[keyof typeof DocumentOrigin];
+
+
+export function instanceOfDocumentOrigin(value: any): boolean {
+    for (const key in DocumentOrigin) {
+        if (Object.prototype.hasOwnProperty.call(DocumentOrigin, key)) {
+            if (DocumentOrigin[key as keyof typeof DocumentOrigin] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function DocumentOriginFromJSON(json: any): DocumentOrigin {
+    return DocumentOriginFromJSONTyped(json, false);
+}
+
+export function DocumentOriginFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentOrigin {
+    return json as DocumentOrigin;
+}
+
+export function DocumentOriginToJSON(value?: DocumentOrigin | null): any {
+    return value as any;
+}
+
+export function DocumentOriginToJSONTyped(value: any, ignoreDiscriminator: boolean): DocumentOrigin {
+    return value as DocumentOrigin;
+}
+