@knowledge-stack/ksapi 1.66.1 → 1.66.3

package/dist/esm/apis/TagsApi.d.ts

@@ -0,0 +1,252 @@
+/**
+ * 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, PaginatedResponseTagResponse, TagResponse, UpdateTagRequest } from '../models/index';
+export interface CreateTagOperationRequest {
+    createTagRequest: CreateTagRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface DeleteTagRequest {
+    tagId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface GetTagRequest {
+    tagId: string;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface ListTagsRequest {
+    limit?: number;
+    offset?: number;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+export interface UpdateTagOperationRequest {
+    tagId: string;
+    updateTagRequest: UpdateTagRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+/**
+ * TagsApi - interface
+ *
+ * @export
+ * @interface TagsApiInterface
+ */
+export interface TagsApiInterface {
+    /**
+     * Creates request options for createTag without sending the request
+     * @param {CreateTagRequest} createTagRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    createTagRequestOpts(requestParameters: CreateTagOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
+     * @summary Create Tag Handler
+     * @param {CreateTagRequest} createTagRequest
+     * @param {string} [authorization]
+     * @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. Requires ADMIN or OWNER role.
+     * Create Tag Handler
+     */
+    createTag(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+    /**
+     * Creates request options for deleteTag without sending the request
+     * @param {string} tagId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    deleteTagRequestOpts(requestParameters: DeleteTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
+     * @summary Delete Tag Handler
+     * @param {string} tagId
+     * @param {string} [authorization]
+     * @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. Requires ADMIN or OWNER role.
+     * Delete Tag Handler
+     */
+    deleteTag(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getTag without sending the request
+     * @param {string} tagId
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    getTagRequestOpts(requestParameters: GetTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a tag by its ID.
+     * @summary Get Tag Handler
+     * @param {string} tagId
+     * @param {string} [authorization]
+     * @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>;
+    /**
+     * Creates request options for listTags without sending the request
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    listTagsRequestOpts(requestParameters: ListTagsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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} [authorization]
+     * @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>;
+    /**
+     * Creates request options for updateTag without sending the request
+     * @param {string} tagId
+     * @param {UpdateTagRequest} updateTagRequest
+     * @param {string} [authorization]
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof TagsApiInterface
+     */
+    updateTagRequestOpts(requestParameters: UpdateTagOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
+     * @summary Update Tag Handler
+     * @param {string} tagId
+     * @param {UpdateTagRequest} updateTagRequest
+     * @param {string} [authorization]
+     * @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). Requires ADMIN or OWNER role.
+     * Update Tag Handler
+     */
+    updateTag(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+}
+/**
+ *
+ */
+export declare class TagsApi extends runtime.BaseAPI implements TagsApiInterface {
+    /**
+     * Creates request options for createTag without sending the request
+     */
+    createTagRequestOpts(requestParameters: CreateTagOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
+     * Create Tag Handler
+     */
+    createTagRaw(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+    /**
+     * Create a new tag for the current tenant. Requires ADMIN or OWNER role.
+     * Create Tag Handler
+     */
+    createTag(requestParameters: CreateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+    /**
+     * Creates request options for deleteTag without sending the request
+     */
+    deleteTagRequestOpts(requestParameters: DeleteTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
+     * Delete Tag Handler
+     */
+    deleteTagRaw(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
+     * Delete Tag Handler
+     */
+    deleteTag(requestParameters: DeleteTagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getTag without sending the request
+     */
+    getTagRequestOpts(requestParameters: GetTagRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a tag by its ID.
+     * Get Tag Handler
+     */
+    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>;
+    /**
+     * Creates request options for listTags without sending the request
+     */
+    listTagsRequestOpts(requestParameters: ListTagsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List all tags for the current tenant.
+     * List Tags Handler
+     */
+    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>;
+    /**
+     * Creates request options for updateTag without sending the request
+     */
+    updateTagRequestOpts(requestParameters: UpdateTagOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
+     * Update Tag Handler
+     */
+    updateTagRaw(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TagResponse>>;
+    /**
+     * Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
+     * Update Tag Handler
+     */
+    updateTag(requestParameters: UpdateTagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TagResponse>;
+}