@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/docs/ThreadMessagesApi.md

@@ -0,0 +1,239 @@
+# ThreadMessagesApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createThreadMessage**](ThreadMessagesApi.md#createthreadmessageoperation) | **POST** /v1/threads/{thread_id}/messages | Create Thread Message Handler |
+| [**getThreadMessage**](ThreadMessagesApi.md#getthreadmessage) | **GET** /v1/threads/{thread_id}/messages/{message_id} | Get Thread Message Handler |
+| [**listThreadMessages**](ThreadMessagesApi.md#listthreadmessages) | **GET** /v1/threads/{thread_id}/messages | List Thread Messages Handler |
+
+
+
+## createThreadMessage
+
+> ThreadMessageResponse createThreadMessage(threadId, createThreadMessageRequest, ksUat)
+
+Create Thread Message Handler
+
+Create a new message in a thread.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadMessagesApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateThreadMessageOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadMessagesApi();
+
+  const body = {
+    // string
+    threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // CreateThreadMessageRequest
+    createThreadMessageRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateThreadMessageOperationRequest;
+
+  try {
+    const data = await api.createThreadMessage(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`] |
+| **createThreadMessageRequest** | [CreateThreadMessageRequest](CreateThreadMessageRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ThreadMessageResponse**](ThreadMessageResponse.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)
+
+
+## getThreadMessage
+
+> ThreadMessageResponse getThreadMessage(threadId, messageId, ksUat)
+
+Get Thread Message Handler
+
+Get a specific message by its ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadMessagesApi,
+} from '@knowledge-stack/ksapi';
+import type { GetThreadMessageRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadMessagesApi();
+
+  const body = {
+    // string
+    threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    messageId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetThreadMessageRequest;
+
+  try {
+    const data = await api.getThreadMessage(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`] |
+| **messageId** | `string` |  | [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ThreadMessageResponse**](ThreadMessageResponse.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)
+
+
+## listThreadMessages
+
+> PaginatedResponseThreadMessageResponse listThreadMessages(threadId, before, limit, offset, ksUat)
+
+List Thread Messages Handler
+
+List messages in a thread, ordered by created_at descending.  Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ThreadMessagesApi,
+} from '@knowledge-stack/ksapi';
+import type { ListThreadMessagesRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new ThreadMessagesApi();
+
+  const body = {
+    // string
+    threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Date | Cursor for keyset pagination: only return messages with created_at < this value (optional)
+    before: 2013-10-20T19:20:30+01:00,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListThreadMessagesRequest;
+
+  try {
+    const data = await api.listThreadMessages(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`] |
+| **before** | `Date` | Cursor for keyset pagination: only return messages with created_at &lt; this value | [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
+
+[**PaginatedResponseThreadMessageResponse**](PaginatedResponseThreadMessageResponse.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)
+

package/docs/ThreadResponse.md

@@ -0,0 +1,49 @@
+
+# ThreadResponse
+
+Thread response model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`pathPartId` | string
+`title` | string
+`parentThreadId` | string
+`materializedPath` | string
+`tenantId` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ThreadResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "pathPartId": null,
+  "title": null,
+  "parentThreadId": null,
+  "materializedPath": null,
+  "tenantId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ThreadResponse
+
+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 ThreadResponse
+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)
+
+