@knowledge-stack/ksapi 1.11.1 → 1.12.0

package/src/apis/TagsApi.ts

@@ -0,0 +1,517 @@
+/* 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 {
+  CreateTagRequest,
+  HTTPValidationError,
+  PaginatedResponseTagResponse,
+  TagPathPartRequest,
+  TagResponse,
+  UpdateTagRequest,
+} from '../models/index';
+import {
+    CreateTagRequestFromJSON,
+    CreateTagRequestToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    PaginatedResponseTagResponseFromJSON,
+    PaginatedResponseTagResponseToJSON,
+    TagPathPartRequestFromJSON,
+    TagPathPartRequestToJSON,
+    TagResponseFromJSON,
+    TagResponseToJSON,
+    UpdateTagRequestFromJSON,
+    UpdateTagRequestToJSON,
+} from '../models/index';
+
+export interface AttachTagToPathPartRequest {
+    tagId: string;
+    tagPathPartRequest: TagPathPartRequest;
+    ksUat?: string;
+}
+
+export interface CreateTagOperationRequest {
+    createTagRequest: CreateTagRequest;
+    ksUat?: string;
+}
+
+export interface DeleteTagRequest {
+    tagId: string;
+    ksUat?: string;
+}
+
+export interface DetachTagFromPathPartRequest {
+    tagId: string;
+    pathPartId: string;
+    ksUat?: string;
+}
+
+export interface GetTagRequest {
+    tagId: string;
+    ksUat?: string;
+}
+
+export interface ListTagsRequest {
+    limit?: number;
+    offset?: number;
+    ksUat?: string;
+}
+
+export interface UpdateTagOperationRequest {
+    tagId: string;
+    updateTagRequest: UpdateTagRequest;
+    ksUat?: string;
+}
+
+/**
+ * TagsApi - interface
+ * 
+ * @export
+ * @interface TagsApiInterface
+ */
+export interface TagsApiInterface {
+    /**
+     * Attach a tag to a path part.
+     * @summary Attach Tag Handler
+     * @param {string} tagId 
+     * @param {TagPathPartRequest} tagPathPartRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    attachTagToPathPartRaw(requestParameters: AttachTagToPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+
+    /**
+     * Attach a tag to a path part.
+     * Attach Tag Handler
+     */
+    attachTagToPathPart(requestParameters: AttachTagToPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+
+    /**
+     * Create a new tag for the current tenant.
+     * @summary Create Tag Handler
+     * @param {CreateTagRequest} createTagRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    createTagRaw(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+
+    /**
+     * Create a new tag for the current tenant.
+     * Create Tag Handler
+     */
+    createTag(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+
+    /**
+     * Delete a tag and all its path_part associations.
+     * @summary Delete Tag Handler
+     * @param {string} tagId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    deleteTagRaw(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Delete a tag and all its path_part associations.
+     * Delete Tag Handler
+     */
+    deleteTag(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Detach a tag from a path part.
+     * @summary Detach Tag Handler
+     * @param {string} tagId 
+     * @param {string} pathPartId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    detachTagFromPathPartRaw(requestParameters: DetachTagFromPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Detach a tag from a path part.
+     * Detach Tag Handler
+     */
+    detachTagFromPathPart(requestParameters: DetachTagFromPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Get a tag by its ID.
+     * @summary Get Tag Handler
+     * @param {string} tagId 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    getTagRaw(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+
+    /**
+     * Get a tag by its ID.
+     * Get Tag Handler
+     */
+    getTag(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+
+    /**
+     * List all tags for the current tenant.
+     * @summary List Tags Handler
+     * @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 TagsApiInterface
+     */
+    listTagsRaw(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseTagResponse>>;
+
+    /**
+     * List all tags for the current tenant.
+     * List Tags Handler
+     */
+    listTags(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseTagResponse>;
+
+    /**
+     * Update a tag (name, color, and/or description).
+     * @summary Update Tag Handler
+     * @param {string} tagId 
+     * @param {UpdateTagRequest} updateTagRequest 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    updateTagRaw(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+
+    /**
+     * Update a tag (name, color, and/or description).
+     * Update Tag Handler
+     */
+    updateTag(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+
+}
+
+/**
+ * 
+ */
+export class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
+
+    /**
+     * Attach a tag to a path part.
+     * Attach Tag Handler
+     */
+    async attachTagToPathPartRaw(requestParameters: AttachTagToPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+        if (requestParameters['tagId'] == null) {
+            throw new runtime.RequiredError(
+                'tagId',
+                'Required parameter "tagId" was null or undefined when calling attachTagToPathPart().'
+            );
+        }
+
+        if (requestParameters['tagPathPartRequest'] == null) {
+            throw new runtime.RequiredError(
+                'tagPathPartRequest',
+                'Required parameter "tagPathPartRequest" was null or undefined when calling attachTagToPathPart().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/tags/{tag_id}/path-parts`;
+        urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: TagPathPartRequestToJSON(requestParameters['tagPathPartRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TagResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Attach a tag to a path part.
+     * Attach Tag Handler
+     */
+    async attachTagToPathPart(requestParameters: AttachTagToPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse> {
+        const response = await this.attachTagToPathPartRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create a new tag for the current tenant.
+     * Create Tag Handler
+     */
+    async createTagRaw(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+        if (requestParameters['createTagRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createTagRequest',
+                'Required parameter "createTagRequest" was null or undefined when calling createTag().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/tags`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateTagRequestToJSON(requestParameters['createTagRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TagResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new tag for the current tenant.
+     * Create Tag Handler
+     */
+    async createTag(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse> {
+        const response = await this.createTagRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a tag and all its path_part associations.
+     * Delete Tag Handler
+     */
+    async deleteTagRaw(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['tagId'] == null) {
+            throw new runtime.RequiredError(
+                'tagId',
+                'Required parameter "tagId" was null or undefined when calling deleteTag().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/tags/{tag_id}`;
+        urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a tag and all its path_part associations.
+     * Delete Tag Handler
+     */
+    async deleteTag(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteTagRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Detach a tag from a path part.
+     * Detach Tag Handler
+     */
+    async detachTagFromPathPartRaw(requestParameters: DetachTagFromPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['tagId'] == null) {
+            throw new runtime.RequiredError(
+                'tagId',
+                'Required parameter "tagId" was null or undefined when calling detachTagFromPathPart().'
+            );
+        }
+
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling detachTagFromPathPart().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/tags/{tag_id}/path-parts/{path_part_id}`;
+        urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Detach a tag from a path part.
+     * Detach Tag Handler
+     */
+    async detachTagFromPathPart(requestParameters: DetachTagFromPathPartRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.detachTagFromPathPartRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a tag by its ID.
+     * Get Tag Handler
+     */
+    async getTagRaw(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+        if (requestParameters['tagId'] == null) {
+            throw new runtime.RequiredError(
+                'tagId',
+                'Required parameter "tagId" was null or undefined when calling getTag().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/tags/{tag_id}`;
+        urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TagResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a tag by its ID.
+     * Get Tag Handler
+     */
+    async getTag(requestParameters: GetTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse> {
+        const response = await this.getTagRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all tags for the current tenant.
+     * List Tags Handler
+     */
+    async listTagsRaw(requestParameters: ListTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseTagResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/tags`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseTagResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List all tags for the current tenant.
+     * List Tags Handler
+     */
+    async listTags(requestParameters: ListTagsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseTagResponse> {
+        const response = await this.listTagsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update a tag (name, color, and/or description).
+     * Update Tag Handler
+     */
+    async updateTagRaw(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>> {
+        if (requestParameters['tagId'] == null) {
+            throw new runtime.RequiredError(
+                'tagId',
+                'Required parameter "tagId" was null or undefined when calling updateTag().'
+            );
+        }
+
+        if (requestParameters['updateTagRequest'] == null) {
+            throw new runtime.RequiredError(
+                'updateTagRequest',
+                'Required parameter "updateTagRequest" was null or undefined when calling updateTag().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/tags/{tag_id}`;
+        urlPath = urlPath.replace(`{${"tag_id"}}`, encodeURIComponent(String(requestParameters['tagId'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdateTagRequestToJSON(requestParameters['updateTagRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TagResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a tag (name, color, and/or description).
+     * Update Tag Handler
+     */
+    async updateTag(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse> {
+        const response = await this.updateTagRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

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

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,
+    },
+}
+