@knowledge-stack/ksapi 1.23.5 → 1.24.0

package/docs/ThreadsApi.md

@@ -0,0 +1,455 @@
+# ThreadsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createThread**](ThreadsApi.md#createthreadoperation) | **POST** /v1/threads | Create Thread Handler |
+| [**deleteThread**](ThreadsApi.md#deletethread) | **DELETE** /v1/threads/{thread_id} | Delete Thread Handler |
+| [**getThread**](ThreadsApi.md#getthread) | **GET** /v1/threads/{thread_id} | Get Thread Handler |
+| [**listThreads**](ThreadsApi.md#listthreads) | **GET** /v1/threads | List Threads Handler |
+| [**streamThread**](ThreadsApi.md#streamthread) | **GET** /v1/threads/{thread_id}/stream | Stream Thread Handler |
+| [**updateThread**](ThreadsApi.md#updatethreadoperation) | **PATCH** /v1/threads/{thread_id} | Update Thread Handler |
+
+
+
+## createThread
+
+> ThreadResponse createThread(createThreadRequest, ksUat)
+
+Create Thread Handler
+
+Create a new thread.  If parent_path_part_id is omitted, the thread is created under the user\'s /users/{user_id}/threads/ folder (auto-provisioned if needed).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadsApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateThreadOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadsApi();
+
+  const body = {
+    // CreateThreadRequest
+    createThreadRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateThreadOperationRequest;
+
+  try {
+    const data = await api.createThread(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createThreadRequest** | [CreateThreadRequest](CreateThreadRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ThreadResponse**](ThreadResponse.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)
+
+
+## deleteThread
+
+> deleteThread(threadId, ksUat)
+
+Delete Thread Handler
+
+Delete a thread.  Authorization: only conversation threads belonging to the current user (under /users/{user_id}/threads/) can be deleted. Asset threads (attached to documents/sections) are never deletable via this endpoint.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteThreadRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadsApi();
+
+  const body = {
+    // string
+    threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteThreadRequest;
+
+  try {
+    const data = await api.deleteThread(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | `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)
+
+
+## getThread
+
+> ThreadResponse getThread(threadId, ksUat)
+
+Get Thread Handler
+
+Get a thread by its thread ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetThreadRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadsApi();
+
+  const body = {
+    // string
+    threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetThreadRequest;
+
+  try {
+    const data = await api.getThread(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ThreadResponse**](ThreadResponse.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)
+
+
+## listThreads
+
+> PaginatedResponseThreadResponse listThreads(parentPathPartId, limit, offset, ksUat)
+
+List Threads Handler
+
+List threads under a parent path_part.  When parent_path_part_id is omitted, lists the authenticated user\'s conversation threads from /users/{user_id}/threads/.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListThreadsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadsApi();
+
+  const body = {
+    // string | Parent PathPart ID. Omit to list user\'s conversation threads. (optional)
+    parentPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListThreadsRequest;
+
+  try {
+    const data = await api.listThreads(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **parentPathPartId** | `string` | Parent PathPart ID. Omit to list user\'s conversation threads. | [Optional] [Defaults to `undefined`] |
+| **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
+
+[**PaginatedResponseThreadResponse**](PaginatedResponseThreadResponse.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)
+
+
+## streamThread
+
+> streamThread(threadId, lastMessageId, lastEntryId, ksUat)
+
+Stream Thread Handler
+
+SSE endpoint for streaming thread messages.  Opens a server-sent event stream for the given thread. Optionally replays missed entries if last_message_id and last_entry_id are provided.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadsApi,
+} from '@knowledge-stack/ksapi';
+import type { StreamThreadRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadsApi();
+
+  const body = {
+    // string
+    threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    lastMessageId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    lastEntryId: lastEntryId_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies StreamThreadRequest;
+
+  try {
+    const data = await api.streamThread(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | `string` |  | [Defaults to `undefined`] |
+| **lastMessageId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **lastEntryId** | `string` |  | [Optional] [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 |
+|-------------|-------------|------------------|
+| **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)
+
+
+## updateThread
+
+> ThreadResponse updateThread(threadId, updateThreadRequest, ksUat)
+
+Update Thread Handler
+
+Update a thread\'s title and/or parent_thread_id.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadsApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateThreadOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadsApi();
+
+  const body = {
+    // string
+    threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateThreadRequest
+    updateThreadRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateThreadOperationRequest;
+
+  try {
+    const data = await api.updateThread(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **threadId** | `string` |  | [Defaults to `undefined`] |
+| **updateThreadRequest** | [UpdateThreadRequest](UpdateThreadRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ThreadResponse**](ThreadResponse.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/UpdateChunkContentRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateChunkContentRequest
+
+Request to update chunk content (creates new content row).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`content` | string
+`chunkType` | [ChunkType](ChunkType.md)
+
+## Example
+
+```typescript
+import type { UpdateChunkContentRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "content": null,
+  "chunkType": null,
+} satisfies UpdateChunkContentRequest
+
+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 UpdateChunkContentRequest
+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/UpdateChunkMetadataRequest.md

@@ -0,0 +1,35 @@
+
+# UpdateChunkMetadataRequest
+
+Request to update chunk metadata (merge).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`chunkMetadata` | [ChunkMetadataInput](ChunkMetadataInput.md)
+
+## Example
+
+```typescript
+import type { UpdateChunkMetadataRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "chunkMetadata": null,
+} satisfies UpdateChunkMetadataRequest
+
+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 UpdateChunkMetadataRequest
+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/UpdateDocumentRequest.md

@@ -0,0 +1,39 @@
+
+# UpdateDocumentRequest
+
+Request to update a document (rename, move, and/or change active version).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`parentPathPartId` | string
+`activeVersionId` | string
+
+## Example
+
+```typescript
+import type { UpdateDocumentRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "parentPathPartId": null,
+  "activeVersionId": null,
+} satisfies UpdateDocumentRequest
+
+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 UpdateDocumentRequest
+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/UpdateFolderRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateFolderRequest
+
+Request to update a folder (rename and/or move).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`parentPathPartId` | string
+
+## Example
+
+```typescript
+import type { UpdateFolderRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "parentPathPartId": null,
+} satisfies UpdateFolderRequest
+
+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 UpdateFolderRequest
+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/UpdatePermissionRequest.md

@@ -0,0 +1,36 @@
+
+# UpdatePermissionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pathPartId` | string
+`capability` | [PermissionCapability](PermissionCapability.md)
+
+## Example
+
+```typescript
+import type { UpdatePermissionRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pathPartId": null,
+  "capability": null,
+} satisfies UpdatePermissionRequest
+
+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 UpdatePermissionRequest
+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/UpdateSectionRequest.md

@@ -0,0 +1,41 @@
+
+# UpdateSectionRequest
+
+Request to update a section.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`pageNumber` | number
+`prevSiblingPathId` | string
+`moveToHead` | boolean
+
+## Example
+
+```typescript
+import type { UpdateSectionRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "pageNumber": null,
+  "prevSiblingPathId": null,
+  "moveToHead": null,
+} satisfies UpdateSectionRequest
+
+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 UpdateSectionRequest
+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)
+
+