@knowledge-stack/ksapi 1.83.0 → 1.85.0

package/docs/AppendMemoryChunkRequest.md

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

@@ -0,0 +1,233 @@
+# DocumentCheckoutApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**acquireDocumentCheckout**](DocumentCheckoutApi.md#acquiredocumentcheckout) | **POST** /v1/documents/{path_part_id}/checkout | Acquire Document Checkout Handler |
+| [**getDocumentCheckout**](DocumentCheckoutApi.md#getdocumentcheckout) | **GET** /v1/documents/{path_part_id}/checkout | Get Document Checkout Handler |
+| [**releaseDocumentCheckout**](DocumentCheckoutApi.md#releasedocumentcheckout) | **DELETE** /v1/documents/{path_part_id}/checkout | Release Document Checkout Handler |
+
+
+
+## acquireDocumentCheckout
+
+> DocumentCheckoutResponse acquireDocumentCheckout(pathPartId, authorization, ksUat)
+
+Acquire Document Checkout Handler
+
+Acquire a write lock on the document.  If the caller already holds the lock, re-acquire refreshes ``acquired_at``; the response is 200 in both cases. If another user holds the lock, returns 409. Locks have no TTL — they persist until released by the holder.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { AcquireDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies AcquireDocumentCheckoutRequest;
+
+  try {
+    const data = await api.acquireDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DocumentCheckoutResponse**](DocumentCheckoutResponse.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)
+
+
+## getDocumentCheckout
+
+> DocumentCheckoutResponse getDocumentCheckout(pathPartId, authorization, ksUat)
+
+Get Document Checkout Handler
+
+Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { GetDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetDocumentCheckoutRequest;
+
+  try {
+    const data = await api.getDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**DocumentCheckoutResponse**](DocumentCheckoutResponse.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)
+
+
+## releaseDocumentCheckout
+
+> releaseDocumentCheckout(pathPartId, authorization, ksUat)
+
+Release Document Checkout Handler
+
+Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentCheckoutApi,
+} from '@knowledge-stack/ksapi';
+import type { ReleaseDocumentCheckoutRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DocumentCheckoutApi();
+
+  const body = {
+    // string | Document\'s PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ReleaseDocumentCheckoutRequest;
+
+  try {
+    const data = await api.releaseDocumentCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Document\'s PathPart ID | [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)
+

package/docs/DocumentCheckoutResponse.md

@@ -0,0 +1,41 @@
+
+# DocumentCheckoutResponse
+
+Active checkout state on a document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tenantId` | string
+`pathPartId` | string
+`userId` | string
+`acquiredAt` | Date
+
+## Example
+
+```typescript
+import type { DocumentCheckoutResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tenantId": null,
+  "pathPartId": null,
+  "userId": null,
+  "acquiredAt": null,
+} satisfies DocumentCheckoutResponse
+
+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 DocumentCheckoutResponse
+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/DocumentResponse.md

@@ -25,6 +25,7 @@ Name | Type
 `updatedAt` | Date
 `tags` | [Array<TagResponse>](TagResponse.md)
 `canWrite` | boolean
+`checkout` | [DocumentCheckoutResponse](DocumentCheckoutResponse.md)
 
 ## Example
 
@@ -51,6 +52,7 @@ const example = {
   "updatedAt": null,
   "tags": null,
   "canWrite": null,
+  "checkout": null,
 } satisfies DocumentResponse
 
 console.log(example)

package/docs/EditMemoryChunkRequest.md

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

@@ -0,0 +1,45 @@
+
+# EventResponse
+
+One event row, anchored to a path_part subject.  ``kind`` is namespaced ``domain.action`` (e.g. ``workflow.approval``, ``document.created``). ``payload`` is the domain-specific structured JSON associated with the event.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`subjectPathPartId` | string
+`kind` | string
+`ts` | Date
+`actorUserId` | string
+`payload` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { EventResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "subjectPathPartId": null,
+  "kind": null,
+  "ts": null,
+  "actorUserId": null,
+  "payload": null,
+} satisfies EventResponse
+
+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 EventResponse
+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/FolderResponseOrDocumentResponse.md

@@ -24,6 +24,7 @@ Name | Type
 `activeVersionId` | string
 `activeVersion` | [DocumentVersionResponse](DocumentVersionResponse.md)
 `ownerTenantUserId` | string
+`checkout` | [DocumentCheckoutResponse](DocumentCheckoutResponse.md)
 
 ## Example
 
@@ -50,6 +51,7 @@ const example = {
   "activeVersionId": null,
   "activeVersion": null,
   "ownerTenantUserId": null,
+  "checkout": null,
 } satisfies FolderResponseOrDocumentResponse
 
 console.log(example)

package/docs/ListMemoryChunksResponse.md

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

@@ -0,0 +1,39 @@
+
+# MemoryChunkResponse
+
+Parsed view of one fenced chunk in MEMORY.md.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`chunkId` | string
+`kind` | [MemoryKind](MemoryKind.md)
+`body` | string
+
+## Example
+
+```typescript
+import type { MemoryChunkResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "chunkId": null,
+  "kind": null,
+  "body": null,
+} satisfies MemoryChunkResponse
+
+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 MemoryChunkResponse
+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/MemoryKind.md

@@ -0,0 +1,33 @@
+
+# MemoryKind
+
+Category of a memory chunk inside a MEMORY.md document.  Stored inside the chunk\'s HTML-comment fence as ``kind=<value>``. Not a Postgres enum — memory is file-backed, not table-backed.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MemoryKind } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MemoryKind
+
+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 MemoryKind
+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/PaginatedResponseEventResponse.md

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