@knowledge-stack/ksapi 1.62.2 → 1.64.0

package/docs/FeedbackApi.md

@@ -0,0 +1,245 @@
+# FeedbackApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteFeedback**](FeedbackApi.md#deletefeedback) | **DELETE** /v1/feedback/{feedback_id} | Delete Feedback Handler |
+| [**listFeedback**](FeedbackApi.md#listfeedback) | **GET** /v1/feedback | List Feedback Handler |
+| [**submitFeedback**](FeedbackApi.md#submitfeedbackoperation) | **POST** /v1/feedback | Submit Feedback Handler |
+
+
+
+## deleteFeedback
+
+> deleteFeedback(feedbackId, authorization, ksUat)
+
+Delete Feedback Handler
+
+Delete a feedback entry.  USER role: can only delete their own feedback. OWNER/ADMIN role: can delete any feedback. Returns 404 if the feedback does not exist. Returns 403 if the user does not own the feedback and is not OWNER/ADMIN.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FeedbackApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteFeedbackRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FeedbackApi();
+
+  const body = {
+    // string
+    feedbackId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteFeedbackRequest;
+
+  try {
+    const data = await api.deleteFeedback(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **feedbackId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `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 |
+|-------------|-------------|------------------|
+| **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)
+
+
+## listFeedback
+
+> PaginatedResponseFeedbackEventResponse listFeedback(targetType, targetId, rating, limit, offset, authorization, ksUat)
+
+List Feedback Handler
+
+List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FeedbackApi,
+} from '@knowledge-stack/ksapi';
+import type { ListFeedbackRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FeedbackApi();
+
+  const body = {
+    // FeedbackTargetType (optional)
+    targetType: ...,
+    // string (optional)
+    targetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // FeedbackRating (optional)
+    rating: ...,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListFeedbackRequest;
+
+  try {
+    const data = await api.listFeedback(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **targetType** | `FeedbackTargetType` |  | [Optional] [Defaults to `undefined`] [Enum: THREAD, MESSAGE, DOCUMENT, DOCUMENT_VERSION, CHUNK] |
+| **targetId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **rating** | `FeedbackRating` |  | [Optional] [Defaults to `undefined`] [Enum: UP, DOWN] |
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedResponseFeedbackEventResponse**](PaginatedResponseFeedbackEventResponse.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)
+
+
+## submitFeedback
+
+> FeedbackEventResponse submitFeedback(submitFeedbackRequest, authorization, ksUat)
+
+Submit Feedback Handler
+
+Create or update feedback on a knowledge entity (upsert).  Returns 201 when feedback is newly created, 200 when updated. Validates that the target entity exists and the user can read it.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FeedbackApi,
+} from '@knowledge-stack/ksapi';
+import type { SubmitFeedbackOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FeedbackApi();
+
+  const body = {
+    // SubmitFeedbackRequest
+    submitFeedbackRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies SubmitFeedbackOperationRequest;
+
+  try {
+    const data = await api.submitFeedback(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **submitFeedbackRequest** | [SubmitFeedbackRequest](SubmitFeedbackRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FeedbackEventResponse**](FeedbackEventResponse.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)
+

package/docs/FeedbackEventResponse.md

@@ -0,0 +1,53 @@
+
+# FeedbackEventResponse
+
+Response schema for a single FeedbackEvent.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`targetType` | [FeedbackTargetType](FeedbackTargetType.md)
+`targetId` | string
+`userId` | string
+`rating` | [FeedbackRating](FeedbackRating.md)
+`reason` | [FeedbackReason](FeedbackReason.md)
+`comment` | string
+`extraMetadata` | { [key: string]: any; }
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { FeedbackEventResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "targetType": null,
+  "targetId": null,
+  "userId": null,
+  "rating": null,
+  "reason": null,
+  "comment": null,
+  "extraMetadata": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies FeedbackEventResponse
+
+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 FeedbackEventResponse
+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/FeedbackRating.md

@@ -0,0 +1,32 @@
+
+# FeedbackRating
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { FeedbackRating } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies FeedbackRating
+
+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 FeedbackRating
+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/FeedbackReason.md

@@ -0,0 +1,32 @@
+
+# FeedbackReason
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { FeedbackReason } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies FeedbackReason
+
+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 FeedbackReason
+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/FeedbackTargetType.md

@@ -0,0 +1,32 @@
+
+# FeedbackTargetType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { FeedbackTargetType } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies FeedbackTargetType
+
+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 FeedbackTargetType
+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/InvokeWorkflowRequest.md

@@ -0,0 +1,35 @@
+
+# InvokeWorkflowRequest
+
+Request body for invoking a workflow definition.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`idempotencyKey` | string
+
+## Example
+
+```typescript
+import type { InvokeWorkflowRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "idempotencyKey": null,
+} satisfies InvokeWorkflowRequest
+
+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 InvokeWorkflowRequest
+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/PaginatedResponseFeedbackEventResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseFeedbackEventResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<FeedbackEventResponse>](FeedbackEventResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseFeedbackEventResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseFeedbackEventResponse
+
+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 PaginatedResponseFeedbackEventResponse
+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/PaginatedResponseWorkflowDefinitionResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseWorkflowDefinitionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<WorkflowDefinitionResponse>](WorkflowDefinitionResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseWorkflowDefinitionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseWorkflowDefinitionResponse
+
+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 PaginatedResponseWorkflowDefinitionResponse
+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/PaginatedResponseWorkflowRunResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseWorkflowRunResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<WorkflowRunResponse>](WorkflowRunResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseWorkflowRunResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseWorkflowRunResponse
+
+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 PaginatedResponseWorkflowRunResponse
+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/SelfHostedRunnerConfig.md

@@ -0,0 +1,37 @@
+
+# SelfHostedRunnerConfig
+
+Configuration for self-hosted workflow runner.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`webhookSecret` | string
+
+## Example
+
+```typescript
+import type { SelfHostedRunnerConfig } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": null,
+  "webhookSecret": null,
+} satisfies SelfHostedRunnerConfig
+
+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 SelfHostedRunnerConfig
+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/SelfHostedRunnerConfigResponse.md

@@ -0,0 +1,35 @@
+
+# SelfHostedRunnerConfigResponse
+
+Response-safe version of runner config — excludes webhook_secret.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+
+## Example
+
+```typescript
+import type { SelfHostedRunnerConfigResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": null,
+} satisfies SelfHostedRunnerConfigResponse
+
+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 SelfHostedRunnerConfigResponse
+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/SubmitFeedbackRequest.md

@@ -0,0 +1,45 @@
+
+# SubmitFeedbackRequest
+
+Request to create or update feedback on a knowledge entity.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`targetType` | [FeedbackTargetType](FeedbackTargetType.md)
+`targetId` | string
+`rating` | [FeedbackRating](FeedbackRating.md)
+`reason` | [FeedbackReason](FeedbackReason.md)
+`comment` | string
+`extraMetadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SubmitFeedbackRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "targetType": null,
+  "targetId": null,
+  "rating": null,
+  "reason": null,
+  "comment": null,
+  "extraMetadata": null,
+} satisfies SubmitFeedbackRequest
+
+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 SubmitFeedbackRequest
+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)
+
+