@knowledge-stack/ksapi 3.16.2 → 3.17.0

package/src/models/WorkflowRepoResponse.ts

@@ -0,0 +1,172 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { RepoCommitSummary } from './RepoCommitSummary';
+import {
+    RepoCommitSummaryFromJSON,
+    RepoCommitSummaryFromJSONTyped,
+    RepoCommitSummaryToJSON,
+    RepoCommitSummaryToJSONTyped,
+} from './RepoCommitSummary';
+
+/**
+ * The workflow's repository at its current ``main``.
+ * @export
+ * @interface WorkflowRepoResponse
+ */
+export interface WorkflowRepoResponse {
+    /**
+     * Directory name runs check the repository out under (`/work/<name>`); fixed by the first save.
+     * @type {string}
+     * @memberof WorkflowRepoResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WorkflowRepoResponse
+     */
+    _exists: boolean;
+    /**
+     * DocumentVersion holding the current main; null before any save.
+     * @type {string}
+     * @memberof WorkflowRepoResponse
+     */
+    versionId: string | null;
+    /**
+     * 
+     * @type {RepoCommitSummary}
+     * @memberof WorkflowRepoResponse
+     */
+    head: RepoCommitSummary | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof WorkflowRepoResponse
+     */
+    fileCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof WorkflowRepoResponse
+     */
+    totalBytes: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof WorkflowRepoResponse
+     */
+    commitCount: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof WorkflowRepoResponse
+     */
+    updatedAt: Date | null;
+    /**
+     * Whether the caller may save new versions (write on the workflow).
+     * @type {boolean}
+     * @memberof WorkflowRepoResponse
+     */
+    writableByMe: boolean;
+    /**
+     * Instruction version (DOCUMENT_VERSION path_part) the current main was saved against.
+     * @type {string}
+     * @memberof WorkflowRepoResponse
+     */
+    instructionVersionId: string | null;
+}
+export const WorkflowRepoResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the WorkflowRepoResponse interface.
+ */
+export function instanceOfWorkflowRepoResponse(value: object): value is WorkflowRepoResponse {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('_exists' in value) || value['_exists'] === undefined) return false;
+    if (!('versionId' in value) || value['versionId'] === undefined) return false;
+    if (!('head' in value) || value['head'] === undefined) return false;
+    if (!('fileCount' in value) || value['fileCount'] === undefined) return false;
+    if (!('totalBytes' in value) || value['totalBytes'] === undefined) return false;
+    if (!('commitCount' in value) || value['commitCount'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('writableByMe' in value) || value['writableByMe'] === undefined) return false;
+    if (!('instructionVersionId' in value) || value['instructionVersionId'] === undefined) return false;
+    return true;
+}
+
+export function WorkflowRepoResponseFromJSON(json: any): WorkflowRepoResponse {
+    return WorkflowRepoResponseFromJSONTyped(json, false);
+}
+
+export function WorkflowRepoResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRepoResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        '_exists': json['exists'],
+        'versionId': json['version_id'],
+        'head': RepoCommitSummaryFromJSON(json['head']),
+        'fileCount': json['file_count'],
+        'totalBytes': json['total_bytes'],
+        'commitCount': json['commit_count'],
+        'updatedAt': (json['updated_at'] == null ? null : new Date(json['updated_at'])),
+        'writableByMe': json['writable_by_me'],
+        'instructionVersionId': json['instruction_version_id'],
+    };
+}
+
+export function WorkflowRepoResponseToJSON(json: any): WorkflowRepoResponse {
+    return WorkflowRepoResponseToJSONTyped(json, false);
+}
+
+export function WorkflowRepoResponseToJSONTyped(value?: WorkflowRepoResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'exists': value['_exists'],
+        'version_id': value['versionId'],
+        'head': RepoCommitSummaryToJSON(value['head']),
+        'file_count': value['fileCount'],
+        'total_bytes': value['totalBytes'],
+        'commit_count': value['commitCount'],
+        'updated_at': value['updatedAt'] == null ? value['updatedAt'] : value['updatedAt'].toISOString(),
+        'writable_by_me': value['writableByMe'],
+        'instruction_version_id': value['instructionVersionId'],
+    };
+}
+

package/src/models/WorkflowRunSnapshot.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { RepoSnapshot } from './RepoSnapshot';
+import {
+    RepoSnapshotFromJSON,
+    RepoSnapshotFromJSONTyped,
+    RepoSnapshotToJSON,
+    RepoSnapshotToJSONTyped,
+} from './RepoSnapshot';
 import type { InputSnapshot } from './InputSnapshot';
 import {
     InputSnapshotFromJSON,
@@ -91,6 +98,12 @@ export interface WorkflowRunSnapshot {
      * @memberof WorkflowRunSnapshot
      */
     selectedSkillIds?: Array<string>;
+    /**
+     * The workflow repository's main when the run started; absent when the workflow had no repository.
+     * @type {RepoSnapshot}
+     * @memberof WorkflowRunSnapshot
+     */
+    repo?: RepoSnapshot | null;
 }
 export const WorkflowRunSnapshotPropertyValidationAttributesMap: {
     [property: string]: {
@@ -141,6 +154,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json: any, ignoreDiscriminator:
         'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : ((json['excluded_common_files'] as Array<any>).map(ExcludedCommonFileFromJSON)),
         'userMessage': json['user_message'] == null ? undefined : json['user_message'],
         'selectedSkillIds': json['selected_skill_ids'] == null ? undefined : json['selected_skill_ids'],
+        'repo': json['repo'] == null ? undefined : RepoSnapshotFromJSON(json['repo']),
     };
 }
 
@@ -162,6 +176,7 @@ export function WorkflowRunSnapshotToJSONTyped(value?: WorkflowRunSnapshot | nul
         'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : ((value['excludedCommonFiles'] as Array<any>).map(ExcludedCommonFileToJSON)),
         'user_message': value['userMessage'],
         'selected_skill_ids': value['selectedSkillIds'],
+        'repo': RepoSnapshotToJSON(value['repo']),
     };
 }
 

package/src/models/index.ts

@@ -202,7 +202,7 @@ export * from './LineageNodeResponse';
 export * from './LocationInner';
 export * from './MembershipResponse';
 export * from './MemoryBodyResponse';
-export * from './MemoryChunkResponse';
+export * from './MemoryEntryResponse';
 export * from './MemoryKind';
 export * from './MemoryScope';
 export * from './MessageRole';
@@ -227,10 +227,11 @@ export * from './PaginatedResponseGroupPermissionResponse';
 export * from './PaginatedResponseGroupResponse';
 export * from './PaginatedResponseInviteResponse';
 export * from './PaginatedResponseMembershipResponse';
-export * from './PaginatedResponseMemoryChunkResponse';
+export * from './PaginatedResponseMemoryEntryResponse';
 export * from './PaginatedResponsePathPartResponse';
 export * from './PaginatedResponsePendingMemoryChunkResponse';
 export * from './PaginatedResponsePermissionResponse';
+export * from './PaginatedResponseRepoVersionResponse';
 export * from './PaginatedResponseSkillResponse';
 export * from './PaginatedResponseTagResponse';
 export * from './PaginatedResponseTenantResponse';
@@ -265,8 +266,16 @@ export * from './Polygon';
 export * from './PolygonReference';
 export * from './ProposeMemoryChunkRequest';
 export * from './ReasoningPart';
+export * from './RecordRepoSaveSkipRequest';
 export * from './ReferenceType';
 export * from './ReorderPathPartRequest';
+export * from './RepoBranchResponse';
+export * from './RepoCommitSummary';
+export * from './RepoSaveSkipReason';
+export * from './RepoSnapshot';
+export * from './RepoTreeEntry';
+export * from './RepoTreeResponse';
+export * from './RepoVersionResponse';
 export * from './RequestPhoneChangeRequest';
 export * from './ResolvedRef';
 export * from './ResolvedReferenceInput';
@@ -402,6 +411,7 @@ export * from './WorkflowDetailResponse';
 export * from './WorkflowExecutionState';
 export * from './WorkflowLeaderboardResponse';
 export * from './WorkflowOutputStatsResponse';
+export * from './WorkflowRepoResponse';
 export * from './WorkflowRunAsset';
 export * from './WorkflowRunCallbackRequest';
 export * from './WorkflowRunOrder';