@knowledge-stack/ksapi 3.16.1 → 3.17.0

package/docs/RecordRepoSaveSkipRequest.md

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

@@ -0,0 +1,61 @@
+
+# RepoBranchResponse
+
+A retained run branch, independently of whether it reached main.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`versionId` | string
+`headSha` | string
+`previousHeadSha` | string
+`commitsAdded` | number
+`runId` | string
+`savedByUserId` | string
+`savedAt` | Date
+`instructionVersionId` | string
+`candidateVersionId` | string
+`branch` | string
+`baseVersionId` | string
+`integratedVersionId` | string
+`integratedHeadSha` | string
+`files` | [Array<RepoTreeEntry>](RepoTreeEntry.md)
+
+## Example
+
+```typescript
+import type { RepoBranchResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "versionId": null,
+  "headSha": null,
+  "previousHeadSha": null,
+  "commitsAdded": null,
+  "runId": null,
+  "savedByUserId": null,
+  "savedAt": null,
+  "instructionVersionId": null,
+  "candidateVersionId": null,
+  "branch": null,
+  "baseVersionId": null,
+  "integratedVersionId": null,
+  "integratedHeadSha": null,
+  "files": null,
+} satisfies RepoBranchResponse
+
+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 RepoBranchResponse
+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/RepoCommitSummary.md

@@ -0,0 +1,42 @@
+
+# RepoCommitSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sha` | string
+`subject` | string
+`authoredAt` | Date
+`runId` | string
+`savedByUserId` | string
+
+## Example
+
+```typescript
+import type { RepoCommitSummary } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sha": null,
+  "subject": null,
+  "authoredAt": null,
+  "runId": null,
+  "savedByUserId": null,
+} satisfies RepoCommitSummary
+
+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 RepoCommitSummary
+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/RepoSaveSkipReason.md

@@ -0,0 +1,33 @@
+
+# RepoSaveSkipReason
+
+Why retention or integration could not complete.  ``conflict``: integration failed; a retained branch remains recoverable. ``history_rewrite``: the run rewrote saved history. ``no_write``: the turn\'s user cannot write the workflow. ``uncommitted``: changes were never committed to the assigned branch. ``rejected``: the platform refused the bundle (too large, unsafe paths). ``failed``: the checkout or the save itself failed.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { RepoSaveSkipReason } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies RepoSaveSkipReason
+
+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 RepoSaveSkipReason
+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/RepoSnapshot.md

@@ -0,0 +1,39 @@
+
+# RepoSnapshot
+
+The workflow repository version a run was started against.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`commit` | string
+`versionId` | string
+`instructionVersionId` | string
+
+## Example
+
+```typescript
+import type { RepoSnapshot } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "commit": null,
+  "versionId": null,
+  "instructionVersionId": null,
+} satisfies RepoSnapshot
+
+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 RepoSnapshot
+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/RepoTreeEntry.md

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

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

@@ -0,0 +1,51 @@
+
+# RepoVersionResponse
+
+One saved version: a new main and the run that saved it.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`versionId` | string
+`headSha` | string
+`previousHeadSha` | string
+`commitsAdded` | number
+`runId` | string
+`savedByUserId` | string
+`savedAt` | Date
+`instructionVersionId` | string
+`candidateVersionId` | string
+
+## Example
+
+```typescript
+import type { RepoVersionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "versionId": null,
+  "headSha": null,
+  "previousHeadSha": null,
+  "commitsAdded": null,
+  "runId": null,
+  "savedByUserId": null,
+  "savedAt": null,
+  "instructionVersionId": null,
+  "candidateVersionId": null,
+} satisfies RepoVersionResponse
+
+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 RepoVersionResponse
+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/WorkflowMemoryApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## appendWorkflowMemoryChunk
 
-> MemoryChunkResponse appendWorkflowMemoryChunk(definitionId, appendMemoryChunkRequest)
+> MemoryEntryResponse appendWorkflowMemoryChunk(definitionId, appendMemoryChunkRequest)
 
 Append Workflow Memory Chunk Handler
 
@@ -66,7 +66,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**MemoryChunkResponse**](MemoryChunkResponse.md)
+[**MemoryEntryResponse**](MemoryEntryResponse.md)
 
 ### Authorization
 
@@ -90,7 +90,7 @@ example().catch(console.error);
 
 ## editWorkflowMemoryChunk
 
-> MemoryChunkResponse editWorkflowMemoryChunk(definitionId, chunkId, editMemoryChunkRequest)
+> MemoryEntryResponse editWorkflowMemoryChunk(definitionId, chunkId, editMemoryChunkRequest)
 
 Edit Workflow Memory Chunk Handler
 
@@ -145,7 +145,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**MemoryChunkResponse**](MemoryChunkResponse.md)
+[**MemoryEntryResponse**](MemoryEntryResponse.md)
 
 ### Authorization
 
@@ -245,7 +245,7 @@ example().catch(console.error);
 
 ## getWorkflowMemoryChunk
 
-> MemoryChunkResponse getWorkflowMemoryChunk(definitionId, chunkId)
+> MemoryEntryResponse getWorkflowMemoryChunk(definitionId, chunkId)
 
 Get Workflow Memory Chunk Handler
 
@@ -297,7 +297,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**MemoryChunkResponse**](MemoryChunkResponse.md)
+[**MemoryEntryResponse**](MemoryEntryResponse.md)
 
 ### Authorization
 
@@ -321,7 +321,7 @@ example().catch(console.error);
 
 ## listWorkflowMemoryChunks
 
-> PaginatedResponseMemoryChunkResponse listWorkflowMemoryChunks(definitionId, limit, offset)
+> PaginatedResponseMemoryEntryResponse listWorkflowMemoryChunks(definitionId, limit, offset)
 
 List Workflow Memory Chunks Handler
 
@@ -376,7 +376,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**PaginatedResponseMemoryChunkResponse**](PaginatedResponseMemoryChunkResponse.md)
+[**PaginatedResponseMemoryEntryResponse**](PaginatedResponseMemoryEntryResponse.md)
 
 ### Authorization
 

package/docs/WorkflowRepoResponse.md

@@ -0,0 +1,53 @@
+
+# WorkflowRepoResponse
+
+The workflow\'s repository at its current ``main``.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`_exists` | boolean
+`versionId` | string
+`head` | [RepoCommitSummary](RepoCommitSummary.md)
+`fileCount` | number
+`totalBytes` | number
+`commitCount` | number
+`updatedAt` | Date
+`writableByMe` | boolean
+`instructionVersionId` | string
+
+## Example
+
+```typescript
+import type { WorkflowRepoResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "_exists": null,
+  "versionId": null,
+  "head": null,
+  "fileCount": null,
+  "totalBytes": null,
+  "commitCount": null,
+  "updatedAt": null,
+  "writableByMe": null,
+  "instructionVersionId": null,
+} satisfies WorkflowRepoResponse
+
+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 WorkflowRepoResponse
+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)
+
+