@knowledge-stack/ksapi 1.23.5 → 1.24.0

package/docs/TagsApi.md

@@ -0,0 +1,374 @@
+# TagsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createTag**](TagsApi.md#createtagoperation) | **POST** /v1/tags | Create Tag Handler |
+| [**deleteTag**](TagsApi.md#deletetag) | **DELETE** /v1/tags/{tag_id} | Delete Tag Handler |
+| [**getTag**](TagsApi.md#gettag) | **GET** /v1/tags/{tag_id} | Get Tag Handler |
+| [**listTags**](TagsApi.md#listtags) | **GET** /v1/tags | List Tags Handler |
+| [**updateTag**](TagsApi.md#updatetagoperation) | **PATCH** /v1/tags/{tag_id} | Update Tag Handler |
+
+
+
+## createTag
+
+> TagResponse createTag(createTagRequest, ksUat)
+
+Create Tag Handler
+
+Create a new tag for the current tenant. Requires ADMIN or OWNER role.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TagsApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateTagOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TagsApi();
+
+  const body = {
+    // CreateTagRequest
+    createTagRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateTagOperationRequest;
+
+  try {
+    const data = await api.createTag(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createTagRequest** | [CreateTagRequest](CreateTagRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TagResponse**](TagResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteTag
+
+> deleteTag(tagId, ksUat)
+
+Delete Tag Handler
+
+Delete a tag and all its path_part associations. Requires ADMIN or OWNER role.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TagsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteTagRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TagsApi();
+
+  const body = {
+    // string
+    tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteTagRequest;
+
+  try {
+    const data = await api.deleteTag(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tagId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getTag
+
+> TagResponse getTag(tagId, ksUat)
+
+Get Tag Handler
+
+Get a tag by its ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TagsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetTagRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TagsApi();
+
+  const body = {
+    // string
+    tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetTagRequest;
+
+  try {
+    const data = await api.getTag(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tagId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TagResponse**](TagResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listTags
+
+> PaginatedResponseTagResponse listTags(limit, offset, ksUat)
+
+List Tags Handler
+
+List all tags for the current tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TagsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListTagsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TagsApi();
+
+  const body = {
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListTagsRequest;
+
+  try {
+    const data = await api.listTags(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedResponseTagResponse**](PaginatedResponseTagResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateTag
+
+> TagResponse updateTag(tagId, updateTagRequest, ksUat)
+
+Update Tag Handler
+
+Update a tag (name, color, and/or description). Requires ADMIN or OWNER role.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TagsApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateTagOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TagsApi();
+
+  const body = {
+    // string
+    tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateTagRequest
+    updateTagRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateTagOperationRequest;
+
+  try {
+    const data = await api.updateTag(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tagId** | `string` |  | [Defaults to `undefined`] |
+| **updateTagRequest** | [UpdateTagRequest](UpdateTagRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TagResponse**](TagResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/TenantResponse.md

@@ -0,0 +1,39 @@
+
+# TenantResponse
+
+Tenant response model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`idpConfig` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { TenantResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "idpConfig": null,
+} satisfies TenantResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TenantResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TenantUserEditRequest.md

@@ -0,0 +1,35 @@
+
+# TenantUserEditRequest
+
+Request to update a tenant user\'s role.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`role` | [TenantUserRole](TenantUserRole.md)
+
+## Example
+
+```typescript
+import type { TenantUserEditRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "role": null,
+} satisfies TenantUserEditRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TenantUserEditRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TenantUserResponse.md

@@ -0,0 +1,43 @@
+
+# TenantUserResponse
+
+Tenant member response model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`email` | string
+`role` | [TenantUserRole](TenantUserRole.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { TenantUserResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "email": null,
+  "role": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies TenantUserResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TenantUserResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TenantUserRole.md

@@ -0,0 +1,33 @@
+
+# TenantUserRole
+
+Tenant user role.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { TenantUserRole } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies TenantUserRole
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TenantUserRole
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+