@knowledge-stack/ksapi 1.95.4 → 1.97.0

package/docs/AgentApi.md

@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## agentAsk
 
-> AskResponse agentAsk(askRequest, authorization, ksUat)
+> AskResponse agentAsk(askRequest)
 
 Agent Ask Handler
 
@@ -28,15 +28,17 @@ import type { AgentAskRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new AgentApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AgentApi(config);
 
   const body = {
     // AskRequest
     askRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies AgentAskRequest;
 
   try {
@@ -57,8 +59,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **askRequest** | [AskRequest](AskRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -66,7 +66,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -85,7 +85,7 @@ No authorization required
 
 ## agentExtract
 
-> ExtractResponse agentExtract(extractRequest, authorization, ksUat)
+> ExtractResponse agentExtract(extractRequest)
 
 Agent Extract Handler
 
@@ -102,15 +102,17 @@ import type { AgentExtractRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new AgentApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AgentApi(config);
 
   const body = {
     // ExtractRequest
     extractRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies AgentExtractRequest;
 
   try {
@@ -131,8 +133,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **extractRequest** | [ExtractRequest](ExtractRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -140,7 +140,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 

package/docs/ApiKeysApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## createApiKey
 
-> CreateApiKeyResponse createApiKey(createApiKeyRequest, ksUat)
+> CreateApiKeyResponse createApiKey(createApiKeyRequest)
 
 Create Api Key Handler
 
@@ -30,13 +30,15 @@ import type { CreateApiKeyOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new ApiKeysApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new ApiKeysApi(config);
 
   const body = {
     // CreateApiKeyRequest
     createApiKeyRequest: ...,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies CreateApiKeyOperationRequest;
 
   try {
@@ -57,7 +59,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **createApiKeyRequest** | [CreateApiKeyRequest](CreateApiKeyRequest.md) |  | |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -65,7 +66,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth)
 
 ### HTTP request headers
 
@@ -84,7 +85,7 @@ No authorization required
 
 ## deleteApiKey
 
-> deleteApiKey(apiKeyId, ksUat)
+> deleteApiKey(apiKeyId)
 
 Delete Api Key Handler
 
@@ -101,13 +102,15 @@ import type { DeleteApiKeyRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new ApiKeysApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new ApiKeysApi(config);
 
   const body = {
     // string
     apiKeyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies DeleteApiKeyRequest;
 
   try {
@@ -128,7 +131,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **apiKeyId** | `string` |  | [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -136,7 +138,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth)
 
 ### HTTP request headers
 
@@ -155,7 +157,7 @@ No authorization required
 
 ## getApiKey
 
-> ApiKeyResponse getApiKey(apiKeyId, ksUat)
+> ApiKeyResponse getApiKey(apiKeyId)
 
 Get Api Key Handler
 
@@ -172,13 +174,15 @@ import type { GetApiKeyRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new ApiKeysApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new ApiKeysApi(config);
 
   const body = {
     // string
     apiKeyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies GetApiKeyRequest;
 
   try {
@@ -199,7 +203,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **apiKeyId** | `string` |  | [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -207,7 +210,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth)
 
 ### HTTP request headers
 
@@ -226,7 +229,7 @@ No authorization required
 
 ## listApiKeys
 
-> Array<ApiKeyResponse> listApiKeys(ksUat)
+> Array<ApiKeyResponse> listApiKeys()
 
 List Api Keys Handler
 
@@ -243,15 +246,14 @@ import type { ListApiKeysRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new ApiKeysApi();
-
-  const body = {
-    // string (optional)
-    ksUat: ksUat_example,
-  } satisfies ListApiKeysRequest;
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new ApiKeysApi(config);
 
   try {
-    const data = await api.listApiKeys(body);
+    const data = await api.listApiKeys();
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -264,10 +266,7 @@ example().catch(console.error);
 
 ### Parameters
 
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+This endpoint does not need any parameter.
 
 ### Return type
 
@@ -275,7 +274,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth)
 
 ### HTTP request headers
 
@@ -287,7 +286,6 @@ No authorization required
 | 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/AuditEventsApi.md

@@ -0,0 +1,104 @@
+# AuditEventsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listAuditEvents**](AuditEventsApi.md#listauditevents) | **GET** /v1/audit-events | List Audit Events Handler |
+
+
+
+## listAuditEvents
+
+> PaginatedResponseEventResponse listAuditEvents(actorUserId, kind, since, until, subjectPathPartId, recursive, limit, offset)
+
+List Audit Events Handler
+
+List the tenant\'s audit events, newest first (admin/owner only).  Returns every event in the caller\'s own tenant — ADMIN/OWNER bypass path permissions by design. Filter by actor, kind, time window, and/or a subject subtree. Each event carries its resolved actor name.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuditEventsApi,
+} from '@knowledge-stack/ksapi';
+import type { ListAuditEventsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AuditEventsApi(config);
+
+  const body = {
+    // string | Filter to one actor (optional)
+    actorUserId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Filter to one event kind (optional)
+    kind: kind_example,
+    // Date | Only events at or after this timestamp (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Only events strictly before this timestamp (optional)
+    until: 2013-10-20T19:20:30+01:00,
+    // string | Scope to one document/folder/run subject (optional)
+    subjectPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Include the subject\'s descendants (needs subject) (optional)
+    recursive: true,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+  } satisfies ListAuditEventsRequest;
+
+  try {
+    const data = await api.listAuditEvents(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **actorUserId** | `string` | Filter to one actor | [Optional] [Defaults to `undefined`] |
+| **kind** | `string` | Filter to one event kind | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Only events at or after this timestamp | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Only events strictly before this timestamp | [Optional] [Defaults to `undefined`] |
+| **subjectPathPartId** | `string` | Scope to one document/folder/run subject | [Optional] [Defaults to `undefined`] |
+| **recursive** | `boolean` | Include the subject\'s descendants (needs subject) | [Optional] [Defaults to `false`] |
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+
+### Return type
+
+[**PaginatedResponseEventResponse**](PaginatedResponseEventResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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/AuthApi.md

@@ -27,7 +27,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## changePhoneNumber
 
-> UserResponse changePhoneNumber(changePhoneNumberRequest, authorization, ksUat)
+> UserResponse changePhoneNumber(changePhoneNumberRequest)
 
 Change Phone Number Handler
 
@@ -44,15 +44,17 @@ import type { ChangePhoneNumberOperationRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new AuthApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AuthApi(config);
 
   const body = {
     // ChangePhoneNumberRequest
     changePhoneNumberRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies ChangePhoneNumberOperationRequest;
 
   try {
@@ -73,8 +75,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **changePhoneNumberRequest** | [ChangePhoneNumberRequest](ChangePhoneNumberRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -82,7 +82,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -741,7 +741,7 @@ No authorization required
 
 ## refreshUat
 
-> UserResponse refreshUat(tenantId, authorization, ksUat)
+> UserResponse refreshUat(tenantId)
 
 Refresh Uat Handler
 
@@ -758,15 +758,17 @@ import type { RefreshUatRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new AuthApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AuthApi(config);
 
   const body = {
     // string | Target tenant ID to switch to. None=refresh current tenant (optional)
     tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies RefreshUatRequest;
 
   try {
@@ -787,8 +789,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **tenantId** | `string` | Target tenant ID to switch to. None=refresh current tenant | [Optional] [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -796,7 +796,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -815,7 +815,7 @@ No authorization required
 
 ## requestPhoneChange
 
-> PhoneValidationResponse requestPhoneChange(requestPhoneChangeRequest, authorization, ksUat)
+> PhoneValidationResponse requestPhoneChange(requestPhoneChangeRequest)
 
 Request Phone Change Handler
 
@@ -832,15 +832,17 @@ import type { RequestPhoneChangeOperationRequest } from '@knowledge-stack/ksapi'
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new AuthApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AuthApi(config);
 
   const body = {
     // RequestPhoneChangeRequest
     requestPhoneChangeRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies RequestPhoneChangeOperationRequest;
 
   try {
@@ -861,8 +863,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **requestPhoneChangeRequest** | [RequestPhoneChangeRequest](RequestPhoneChangeRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -870,7 +870,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -889,7 +889,7 @@ No authorization required
 
 ## resetPassword
 
-> UserResponse resetPassword(passwordResetRequest, authorization, ksUat)
+> UserResponse resetPassword(passwordResetRequest)
 
 Reset Password Handler
 
@@ -906,15 +906,17 @@ import type { ResetPasswordRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new AuthApi();
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AuthApi(config);
 
   const body = {
     // PasswordResetRequest
     passwordResetRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies ResetPasswordRequest;
 
   try {
@@ -935,8 +937,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **passwordResetRequest** | [PasswordResetRequest](PasswordResetRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -944,7 +944,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 

package/docs/CatalogColumnResponse.md

@@ -0,0 +1,38 @@
+
+# CatalogColumnResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`dataType` | string
+`isPk` | boolean
+
+## Example
+
+```typescript
+import type { CatalogColumnResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "dataType": null,
+  "isPk": null,
+} satisfies CatalogColumnResponse
+
+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 CatalogColumnResponse
+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/CatalogTableResponse.md

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