@knowledge-stack/ksapi 1.11.2 → 1.13.0

package/src/apis/UserPermissionsApi.ts

@@ -0,0 +1,362 @@
+/* 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 {
+  CreatePermissionRequest,
+  HTTPValidationError,
+  PaginatedResponsePermissionResponse,
+  PermissionResponse,
+  UpdatePermissionRequest,
+} from '../models/index';
+import {
+    CreatePermissionRequestFromJSON,
+    CreatePermissionRequestToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    PaginatedResponsePermissionResponseFromJSON,
+    PaginatedResponsePermissionResponseToJSON,
+    PermissionResponseFromJSON,
+    PermissionResponseToJSON,
+    UpdatePermissionRequestFromJSON,
+    UpdatePermissionRequestToJSON,
+} from '../models/index';
+
+export interface CreateUserPermissionRequest {
+    createPermissionRequest: CreatePermissionRequest;
+    ksUat?: string;
+}
+
+export interface DeleteUserPermissionRequest {
+    permissionId: string;
+    tenantId: string;
+    ksUat?: string;
+}
+
+export interface ListUserPermissionsRequest {
+    tenantId: string;
+    userId: string;
+    limit?: number;
+    offset?: number;
+    ksUat?: string;
+}
+
+export interface UpdateUserPermissionRequest {
+    permissionId: string;
+    tenantId: string;
+    updatePermissionRequest: UpdatePermissionRequest;
+    ksUat?: string;
+}
+
+/**
+ * UserPermissionsApi - interface
+ * 
+ * @export
+ * @interface UserPermissionsApiInterface
+ */
+export interface UserPermissionsApiInterface {
+    /**
+     * Create a path permission for a user in a tenant (admin/owner only).
+     * @summary Create User Permission Handler
+     * @param {CreatePermissionRequest} createPermissionRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserPermissionsApiInterface
+     */
+    createUserPermissionRaw(requestParameters: CreateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionResponse>>;
+
+    /**
+     * Create a path permission for a user in a tenant (admin/owner only).
+     * Create User Permission Handler
+     */
+    createUserPermission(requestParameters: CreateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PermissionResponse>;
+
+    /**
+     * Delete a path permission (admin/owner only).
+     * @summary Delete User Permission Handler
+     * @param {string} permissionId 
+     * @param {string} tenantId Tenant ID the permission belongs to
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserPermissionsApiInterface
+     */
+    deleteUserPermissionRaw(requestParameters: DeleteUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete a path permission (admin/owner only).
+     * Delete User Permission Handler
+     */
+    deleteUserPermission(requestParameters: DeleteUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * List path permissions for a user in a tenant (admin/owner only).
+     * @summary List User Permissions Handler
+     * @param {string} tenantId Tenant ID to list permissions for
+     * @param {string} userId User ID to list permissions 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 UserPermissionsApiInterface
+     */
+    listUserPermissionsRaw(requestParameters: ListUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePermissionResponse>>;
+
+    /**
+     * List path permissions for a user in a tenant (admin/owner only).
+     * List User Permissions Handler
+     */
+    listUserPermissions(requestParameters: ListUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePermissionResponse>;
+
+    /**
+     * Update a path permission (admin/owner only).
+     * @summary Update User Permission Handler
+     * @param {string} permissionId 
+     * @param {string} tenantId Tenant ID the permission belongs to
+     * @param {UpdatePermissionRequest} updatePermissionRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserPermissionsApiInterface
+     */
+    updateUserPermissionRaw(requestParameters: UpdateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionResponse>>;
+
+    /**
+     * Update a path permission (admin/owner only).
+     * Update User Permission Handler
+     */
+    updateUserPermission(requestParameters: UpdateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PermissionResponse>;
+
+}
+
+/**
+ * 
+ */
+export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissionsApiInterface {
+
+    /**
+     * Create a path permission for a user in a tenant (admin/owner only).
+     * Create User Permission Handler
+     */
+    async createUserPermissionRaw(requestParameters: CreateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionResponse>> {
+        if (requestParameters['createPermissionRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createPermissionRequest',
+                'Required parameter "createPermissionRequest" was null or undefined when calling createUserPermission().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/user-permissions`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreatePermissionRequestToJSON(requestParameters['createPermissionRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PermissionResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a path permission for a user in a tenant (admin/owner only).
+     * Create User Permission Handler
+     */
+    async createUserPermission(requestParameters: CreateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PermissionResponse> {
+        const response = await this.createUserPermissionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a path permission (admin/owner only).
+     * Delete User Permission Handler
+     */
+    async deleteUserPermissionRaw(requestParameters: DeleteUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['permissionId'] == null) {
+            throw new runtime.RequiredError(
+                'permissionId',
+                'Required parameter "permissionId" was null or undefined when calling deleteUserPermission().'
+            );
+        }
+
+        if (requestParameters['tenantId'] == null) {
+            throw new runtime.RequiredError(
+                'tenantId',
+                'Required parameter "tenantId" was null or undefined when calling deleteUserPermission().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['tenantId'] != null) {
+            queryParameters['tenant_id'] = requestParameters['tenantId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/user-permissions/{permission_id}`;
+        urlPath = urlPath.replace(`{${"permission_id"}}`, encodeURIComponent(String(requestParameters['permissionId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a path permission (admin/owner only).
+     * Delete User Permission Handler
+     */
+    async deleteUserPermission(requestParameters: DeleteUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteUserPermissionRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * List path permissions for a user in a tenant (admin/owner only).
+     * List User Permissions Handler
+     */
+    async listUserPermissionsRaw(requestParameters: ListUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePermissionResponse>> {
+        if (requestParameters['tenantId'] == null) {
+            throw new runtime.RequiredError(
+                'tenantId',
+                'Required parameter "tenantId" was null or undefined when calling listUserPermissions().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling listUserPermissions().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['tenantId'] != null) {
+            queryParameters['tenant_id'] = requestParameters['tenantId'];
+        }
+
+        if (requestParameters['userId'] != null) {
+            queryParameters['user_id'] = requestParameters['userId'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/user-permissions`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponsePermissionResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List path permissions for a user in a tenant (admin/owner only).
+     * List User Permissions Handler
+     */
+    async listUserPermissions(requestParameters: ListUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePermissionResponse> {
+        const response = await this.listUserPermissionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update a path permission (admin/owner only).
+     * Update User Permission Handler
+     */
+    async updateUserPermissionRaw(requestParameters: UpdateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionResponse>> {
+        if (requestParameters['permissionId'] == null) {
+            throw new runtime.RequiredError(
+                'permissionId',
+                'Required parameter "permissionId" was null or undefined when calling updateUserPermission().'
+            );
+        }
+
+        if (requestParameters['tenantId'] == null) {
+            throw new runtime.RequiredError(
+                'tenantId',
+                'Required parameter "tenantId" was null or undefined when calling updateUserPermission().'
+            );
+        }
+
+        if (requestParameters['updatePermissionRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updatePermissionRequest',
+                'Required parameter "updatePermissionRequest" was null or undefined when calling updateUserPermission().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['tenantId'] != null) {
+            queryParameters['tenant_id'] = requestParameters['tenantId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/user-permissions/{permission_id}`;
+        urlPath = urlPath.replace(`{${"permission_id"}}`, encodeURIComponent(String(requestParameters['permissionId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdatePermissionRequestToJSON(requestParameters['updatePermissionRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PermissionResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a path permission (admin/owner only).
+     * Update User Permission Handler
+     */
+    async updateUserPermission(requestParameters: UpdateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PermissionResponse> {
+        const response = await this.updateUserPermissionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -10,7 +10,9 @@ export * from './FoldersApi';
 export * from './InvitesApi';
 export * from './PathPartsApi';
 export * from './SectionsApi';
+export * from './TagsApi';
 export * from './TenantsApi';
 export * from './ThreadMessagesApi';
 export * from './ThreadsApi';
+export * from './UserPermissionsApi';
 export * from './UsersApi';

package/src/models/ChunkResponse.ts

@@ -88,6 +88,12 @@ export interface ChunkResponse {
      * @memberof ChunkResponse
      */
     nextSiblingId?: string;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    materializedPath: string;
     /**
      * Tenant ID
      * @type {string}
@@ -121,6 +127,7 @@ export function instanceOfChunkResponse(value: object): value is ChunkResponse {
     if (!('chunkType' in value) || value['chunkType'] === undefined) return false;
     if (!('chunkMetadata' in value) || value['chunkMetadata'] === undefined) return false;
     if (!('parentId' in value) || value['parentId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
     if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
@@ -146,6 +153,7 @@ export function ChunkResponseFromJSONTyped(json: any, ignoreDiscriminator: boole
         'parentId': json['parent_id'],
         'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
         'nextSiblingId': json['next_sibling_id'] == null ? undefined : json['next_sibling_id'],
+        'materializedPath': json['materialized_path'],
         'tenantId': json['tenant_id'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
@@ -172,6 +180,7 @@ export function ChunkResponseToJSONTyped(value?: ChunkResponse | null, ignoreDis
         'parent_id': value['parentId'],
         'prev_sibling_path_id': value['prevSiblingPathId'],
         'next_sibling_id': value['nextSiblingId'],
+        'materialized_path': value['materializedPath'],
         'tenant_id': value['tenantId'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),

package/src/models/CreatePermissionRequest.ts

@@ -0,0 +1,120 @@
+/* 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 { PermissionCapability } from './PermissionCapability';
+import {
+    PermissionCapabilityFromJSON,
+    PermissionCapabilityFromJSONTyped,
+    PermissionCapabilityToJSON,
+    PermissionCapabilityToJSONTyped,
+} from './PermissionCapability';
+
+/**
+ * 
+ * @export
+ * @interface CreatePermissionRequest
+ */
+export interface CreatePermissionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePermissionRequest
+     */
+    tenantId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePermissionRequest
+     */
+    userId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePermissionRequest
+     */
+    path: string;
+    /**
+     * 
+     * @type {PermissionCapability}
+     * @memberof CreatePermissionRequest
+     */
+    capability: PermissionCapability;
+}
+
+
+
+/**
+ * Check if a given object implements the CreatePermissionRequest interface.
+ */
+export function instanceOfCreatePermissionRequest(value: object): value is CreatePermissionRequest {
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('capability' in value) || value['capability'] === undefined) return false;
+    return true;
+}
+
+export function CreatePermissionRequestFromJSON(json: any): CreatePermissionRequest {
+    return CreatePermissionRequestFromJSONTyped(json, false);
+}
+
+export function CreatePermissionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePermissionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tenantId': json['tenant_id'],
+        'userId': json['user_id'],
+        'path': json['path'],
+        'capability': PermissionCapabilityFromJSON(json['capability']),
+    };
+}
+
+export function CreatePermissionRequestToJSON(json: any): CreatePermissionRequest {
+    return CreatePermissionRequestToJSONTyped(json, false);
+}
+
+export function CreatePermissionRequestToJSONTyped(value?: CreatePermissionRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tenant_id': value['tenantId'],
+        'user_id': value['userId'],
+        'path': value['path'],
+        'capability': PermissionCapabilityToJSON(value['capability']),
+    };
+}
+
+export const CreatePermissionRequestPropertyValidationAttributesMap: {
+    [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/src/models/CreateTagRequest.ts

@@ -0,0 +1,111 @@
+/* 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';
+/**
+ * Request to create a new tag.
+ * @export
+ * @interface CreateTagRequest
+ */
+export interface CreateTagRequest {
+    /**
+     * Tag name
+     * @type {string}
+     * @memberof CreateTagRequest
+     */
+    name: string;
+    /**
+     * Tag color as 6-character hex string (e.g. 'FF5733')
+     * @type {string}
+     * @memberof CreateTagRequest
+     */
+    color?: string;
+    /**
+     * Optional tag description
+     * @type {string}
+     * @memberof CreateTagRequest
+     */
+    description?: string;
+}
+
+/**
+ * Check if a given object implements the CreateTagRequest interface.
+ */
+export function instanceOfCreateTagRequest(value: object): value is CreateTagRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreateTagRequestFromJSON(json: any): CreateTagRequest {
+    return CreateTagRequestFromJSONTyped(json, false);
+}
+
+export function CreateTagRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateTagRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'color': json['color'] == null ? undefined : json['color'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+
+export function CreateTagRequestToJSON(json: any): CreateTagRequest {
+    return CreateTagRequestToJSONTyped(json, false);
+}
+
+export function CreateTagRequestToJSONTyped(value?: CreateTagRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'color': value['color'],
+        'description': value['description'],
+    };
+}
+
+export const CreateTagRequestPropertyValidationAttributesMap: {
+    [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: 100,
+        minLength: 1,
+    },
+    color: {
+        maxLength: 6,
+        minLength: 6,
+        pattern: '/^[0-9A-Fa-f]{6}$/',
+    },
+    description: {
+        maxLength: 500,
+    },
+}
+

package/src/models/DocumentContentPathPart.ts

@@ -104,6 +104,12 @@ export interface DocumentContentPathPart {
      * @memberof DocumentContentPathPart
      */
     pageNumber?: number;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof DocumentContentPathPart
+     */
+    materializedPath: string;
     /**
      * Creation timestamp
      * @type {Date}
@@ -130,6 +136,7 @@ export function instanceOfDocumentContentPathPart(value: object): value is Docum
     if (!('parentId' in value) || value['parentId'] === undefined) return false;
     if (!('metadataObjId' in value) || value['metadataObjId'] === undefined) return false;
     if (!('depth' in value) || value['depth'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -155,6 +162,7 @@ export function DocumentContentPathPartFromJSONTyped(json: any, ignoreDiscrimina
         'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
         'chunkMetadata': json['chunk_metadata'] == null ? undefined : ChunkMetadataOutputFromJSON(json['chunk_metadata']),
         'pageNumber': json['page_number'] == null ? undefined : json['page_number'],
+        'materializedPath': json['materialized_path'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -181,6 +189,7 @@ export function DocumentContentPathPartToJSONTyped(value?: DocumentContentPathPa
         'chunk_type': ChunkTypeToJSON(value['chunkType']),
         'chunk_metadata': ChunkMetadataOutputToJSON(value['chunkMetadata']),
         'page_number': value['pageNumber'],
+        'materialized_path': value['materializedPath'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };