@knowledge-stack/ksapi 1.83.0 → 1.84.0

package/dist/models/SectionSystemMetadata.d.ts

@@ -21,7 +21,7 @@ export interface SectionSystemMetadata {
      * @type {InformationStatistics}
      * @memberof SectionSystemMetadata
      */
-    informationStatistics?: InformationStatistics;
+    informationStatistics?: InformationStatistics | null;
 }
 export declare const SectionSystemMetadataPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/TenantSettingsUpdate.d.ts

@@ -62,11 +62,11 @@ export interface TenantSettingsUpdate {
         [key: string]: string;
     } | null;
     /**
-     *
+     * Tenant-wide invite-link configuration
      * @type {InviteLinkSettingsRequest}
      * @memberof TenantSettingsUpdate
      */
-    inviteLink?: InviteLinkSettingsRequest;
+    inviteLink?: InviteLinkSettingsRequest | null;
 }
 export declare const TenantSettingsUpdatePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/ThreadMessageDetailsInput.d.ts

@@ -24,11 +24,11 @@ export interface ThreadMessageDetailsInput {
      */
     steps?: Array<StepInput>;
     /**
-     *
+     * Agent history checkpoint. Present only on role=SYSTEM messages written by the agent's archival path.
      * @type {CheckpointDetails}
      * @memberof ThreadMessageDetailsInput
      */
-    checkpoint?: CheckpointDetails;
+    checkpoint?: CheckpointDetails | null;
 }
 export declare const ThreadMessageDetailsInputPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/ThreadMessageDetailsOutput.d.ts

@@ -24,11 +24,11 @@ export interface ThreadMessageDetailsOutput {
      */
     steps?: Array<StepOutput>;
     /**
-     *
+     * Agent history checkpoint. Present only on role=SYSTEM messages written by the agent's archival path.
      * @type {CheckpointDetails}
      * @memberof ThreadMessageDetailsOutput
      */
-    checkpoint?: CheckpointDetails;
+    checkpoint?: CheckpointDetails | null;
 }
 export declare const ThreadMessageDetailsOutputPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/ThreadMessageResponse.d.ts

@@ -49,11 +49,11 @@ export interface ThreadMessageResponse {
      */
     content: EnrichedThreadMessageContent;
     /**
-     *
+     * Message details (None when not requested via with_details)
      * @type {ThreadMessageDetailsOutput}
      * @memberof ThreadMessageResponse
      */
-    details?: ThreadMessageDetailsOutput;
+    details?: ThreadMessageDetailsOutput | null;
     /**
      * Thread's PathPart ID
      * @type {string}

package/dist/models/UpdateChunkMetadataRequest.d.ts

@@ -17,11 +17,11 @@ import type { ChunkMetadata } from './ChunkMetadata';
  */
 export interface UpdateChunkMetadataRequest {
     /**
-     *
+     * Metadata to merge into existing chunk_metadata (optional)
      * @type {ChunkMetadata}
      * @memberof UpdateChunkMetadataRequest
      */
-    chunkMetadata?: ChunkMetadata;
+    chunkMetadata?: ChunkMetadata | null;
     /**
      * Reparent to this PathPart ID (must be DOCUMENT_VERSION or SECTION in the same document version)
      * @type {string}

package/dist/models/UpdateTenantRequest.d.ts

@@ -24,17 +24,17 @@ export interface UpdateTenantRequest {
      */
     name?: string | null;
     /**
-     *
+     * Optional external IdP configuration to update
      * @type {IdpConfig}
      * @memberof UpdateTenantRequest
      */
-    idpConfig?: IdpConfig;
+    idpConfig?: IdpConfig | null;
     /**
-     *
+     * Optional tenant settings to update
      * @type {TenantSettingsUpdate}
      * @memberof UpdateTenantRequest
      */
-    settings?: TenantSettingsUpdate;
+    settings?: TenantSettingsUpdate | null;
 }
 export declare const UpdateTenantRequestPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/UpdateWorkflowDefinitionRequest.d.ts

@@ -45,7 +45,7 @@ export interface UpdateWorkflowDefinitionRequest {
      * @type {SelfHostedRunnerConfig}
      * @memberof UpdateWorkflowDefinitionRequest
      */
-    runnerConfig?: SelfHostedRunnerConfig;
+    runnerConfig?: SelfHostedRunnerConfig | null;
     /**
      *
      * @type {number}

package/dist/models/WorkflowDefinitionResponse.d.ts

@@ -46,7 +46,7 @@ export interface WorkflowDefinitionResponse {
      * @type {SelfHostedRunnerConfigResponse}
      * @memberof WorkflowDefinitionResponse
      */
-    runnerConfig: SelfHostedRunnerConfigResponse;
+    runnerConfig: SelfHostedRunnerConfigResponse | null;
     /**
      *
      * @type {number}

package/dist/models/WorkflowRunSnapshot.d.ts

@@ -71,7 +71,7 @@ export interface WorkflowRunSnapshot {
      * @type {ABCDPathSnapshot}
      * @memberof WorkflowRunSnapshot
      */
-    template: ABCDPathSnapshot;
+    template: ABCDPathSnapshot | null;
 }
 export declare const WorkflowRunSnapshotPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/index.d.ts

@@ -3,6 +3,8 @@ export * from './AcceptInviteResponse';
 export * from './AddMemberRequest';
 export * from './AncestryResponse';
 export * from './ApiKeyResponse';
+export * from './AppendEventRequest';
+export * from './AppendMemoryChunkRequest';
 export * from './Args';
 export * from './AskRequest';
 export * from './AskResponse';
@@ -48,10 +50,12 @@ export * from './DocumentVersionContentTypeFilter';
 export * from './DocumentVersionMetadata';
 export * from './DocumentVersionMetadataUpdate';
 export * from './DocumentVersionResponse';
+export * from './EditMemoryChunkRequest';
 export * from './EmailSentResponse';
 export * from './EmailVerificationRequest';
 export * from './EnrichedCitation';
 export * from './EnrichedThreadMessageContent';
+export * from './EventResponse';
 export * from './ExtractRequest';
 export * from './ExtractResponse';
 export * from './FeaturesResponse';
@@ -84,8 +88,11 @@ export * from './InvokeWorkflowRequest';
 export * from './LineageEdgeResponse';
 export * from './LineageGraphResponse';
 export * from './LineageNodeResponse';
+export * from './ListMemoryChunksResponse';
 export * from './LocationInner';
 export * from './MembershipResponse';
+export * from './MemoryChunkResponse';
+export * from './MemoryKind';
 export * from './MessageRole';
 export * from './MeteredQuotaStatus';
 export * from './NonFilesystemReferenceType';
@@ -95,6 +102,7 @@ export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDi
 export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
 export * from './PaginatedResponseDocumentResponse';
 export * from './PaginatedResponseDocumentVersionResponse';
+export * from './PaginatedResponseEventResponse';
 export * from './PaginatedResponseFeedbackEventResponse';
 export * from './PaginatedResponseFolderResponse';
 export * from './PaginatedResponseGroupPermissionResponse';

package/dist/models/index.js

@@ -21,6 +21,8 @@ __exportStar(require("./AcceptInviteResponse"), exports);
 __exportStar(require("./AddMemberRequest"), exports);
 __exportStar(require("./AncestryResponse"), exports);
 __exportStar(require("./ApiKeyResponse"), exports);
+__exportStar(require("./AppendEventRequest"), exports);
+__exportStar(require("./AppendMemoryChunkRequest"), exports);
 __exportStar(require("./Args"), exports);
 __exportStar(require("./AskRequest"), exports);
 __exportStar(require("./AskResponse"), exports);
@@ -66,10 +68,12 @@ __exportStar(require("./DocumentVersionContentTypeFilter"), exports);
 __exportStar(require("./DocumentVersionMetadata"), exports);
 __exportStar(require("./DocumentVersionMetadataUpdate"), exports);
 __exportStar(require("./DocumentVersionResponse"), exports);
+__exportStar(require("./EditMemoryChunkRequest"), exports);
 __exportStar(require("./EmailSentResponse"), exports);
 __exportStar(require("./EmailVerificationRequest"), exports);
 __exportStar(require("./EnrichedCitation"), exports);
 __exportStar(require("./EnrichedThreadMessageContent"), exports);
+__exportStar(require("./EventResponse"), exports);
 __exportStar(require("./ExtractRequest"), exports);
 __exportStar(require("./ExtractResponse"), exports);
 __exportStar(require("./FeaturesResponse"), exports);
@@ -102,8 +106,11 @@ __exportStar(require("./InvokeWorkflowRequest"), exports);
 __exportStar(require("./LineageEdgeResponse"), exports);
 __exportStar(require("./LineageGraphResponse"), exports);
 __exportStar(require("./LineageNodeResponse"), exports);
+__exportStar(require("./ListMemoryChunksResponse"), exports);
 __exportStar(require("./LocationInner"), exports);
 __exportStar(require("./MembershipResponse"), exports);
+__exportStar(require("./MemoryChunkResponse"), exports);
+__exportStar(require("./MemoryKind"), exports);
 __exportStar(require("./MessageRole"), exports);
 __exportStar(require("./MeteredQuotaStatus"), exports);
 __exportStar(require("./NonFilesystemReferenceType"), exports);
@@ -113,6 +120,7 @@ __exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentRes
 __exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
 __exportStar(require("./PaginatedResponseDocumentResponse"), exports);
 __exportStar(require("./PaginatedResponseDocumentVersionResponse"), exports);
+__exportStar(require("./PaginatedResponseEventResponse"), exports);
 __exportStar(require("./PaginatedResponseFeedbackEventResponse"), exports);
 __exportStar(require("./PaginatedResponseFolderResponse"), exports);
 __exportStar(require("./PaginatedResponseGroupPermissionResponse"), exports);

package/docs/AppendEventRequest.md

@@ -0,0 +1,37 @@
+
+# AppendEventRequest
+
+Body for ``POST /v1/path-parts/{path_part_id}/events``.  The route requires ``can_write`` on the subject path_part. Server stamps ``id``/``tenant_id``/``actor_user_id``/``ts``/ ``subject_path_part_id``; frontend supplies only ``kind`` and ``payload``. ``kind`` must NOT use a reserved server namespace — those are emitted by service code so the audit trail can\'t be forged by an authenticated client.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`kind` | string
+`payload` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { AppendEventRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "kind": null,
+  "payload": null,
+} satisfies AppendEventRequest
+
+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 AppendEventRequest
+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/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/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/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)
+
+