@knowledge-stack/ksapi 1.95.4 → 1.96.0

package/docs/MemoryScope.md

@@ -0,0 +1,33 @@
+
+# MemoryScope
+
+Owner scope for a memory document.  Lowercase values match the request-schema Literals so no mapping layer is needed. ``user`` resolves to /users/{user_id}; ``workflow`` to the workflow definition\'s path_part. (Tenant scope is deferred.)
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MemoryScope } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MemoryScope
+
+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 MemoryScope
+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/ModelTableRequest.md

@@ -0,0 +1,41 @@
+
+# ModelTableRequest
+
+Model a DB table as a queryable child of the connector.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tableName` | string
+`name` | string
+`description` | string
+`columnConfig` | [Array<ColumnConfig>](ColumnConfig.md)
+
+## Example
+
+```typescript
+import type { ModelTableRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tableName": null,
+  "name": null,
+  "description": null,
+  "columnConfig": null,
+} satisfies ModelTableRequest
+
+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 ModelTableRequest
+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/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator.md}

@@ -1,12 +1,12 @@
 
-# PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator
+# PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`items` | [Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse>](FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponse.md)
+`items` | [Array<FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse>](FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponse.md)
 `total` | number
 `limit` | number
 `offset` | number
@@ -14,7 +14,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator } from '@knowledge-stack/ksapi'
+import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
@@ -22,7 +22,7 @@ const example = {
   "total": null,
   "limit": null,
   "offset": null,
-} satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator
+} satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator
 
 console.log(example)
 
@@ -31,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDiscriminator
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseDiscriminator
 console.log(exampleParsed)
 ```
 

package/docs/PaginatedResponsePendingMemoryChunkResponse.md

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

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

@@ -11,7 +11,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## getPathPartApproval
 
-> PathPartApprovalResponse getPathPartApproval(pathPartId, authorization, ksUat)
+> PathPartApprovalResponse getPathPartApproval(pathPartId)
 
 Get Path Part Approval Handler
 
@@ -28,15 +28,17 @@ import type { GetPathPartApprovalRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new PathPartApprovalsApi();
+  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 PathPartApprovalsApi(config);
 
   const body = {
     // string
     pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies GetPathPartApprovalRequest;
 
   try {
@@ -57,8 +59,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **pathPartId** | `string` |  | [Defaults to `undefined`] |
-| **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
 
 ## setPathPartApproval
 
-> PathPartApprovalResponse setPathPartApproval(pathPartId, setApprovalStateRequest, authorization, ksUat)
+> PathPartApprovalResponse setPathPartApproval(pathPartId, setApprovalStateRequest)
 
 Set Path Part Approval Handler
 
@@ -102,17 +102,19 @@ import type { SetPathPartApprovalRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new PathPartApprovalsApi();
+  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 PathPartApprovalsApi(config);
 
   const body = {
     // string
     pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // SetApprovalStateRequest
     setApprovalStateRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies SetPathPartApprovalRequest;
 
   try {
@@ -134,8 +136,6 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **pathPartId** | `string` |  | [Defaults to `undefined`] |
 | **setApprovalStateRequest** | [SetApprovalStateRequest](SetApprovalStateRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -143,7 +143,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 

package/docs/PathPartResponse.md

@@ -16,8 +16,7 @@ Name | Type
 `systemManaged` | boolean
 `excludeFromQdrant` | boolean
 `tags` | [Array<TagResponse>](TagResponse.md)
-`canRead` | boolean
-`canWrite` | boolean
+`permissions` | [ItemPermissions](ItemPermissions.md)
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -37,8 +36,7 @@ const example = {
   "systemManaged": null,
   "excludeFromQdrant": null,
   "tags": null,
-  "canRead": null,
-  "canWrite": null,
+  "permissions": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies PathPartResponse