@knowledge-stack/ksapi 1.153.0 → 1.155.0

package/dist/esm/models/BulkTrashRequest.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ * Restore or permanently delete the selected trashed objects by PDO id.
+ * @export
+ * @interface BulkTrashRequest
+ */
+export interface BulkTrashRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkTrashRequest
+     */
+    objectIds?: Array<string>;
+}
+export declare const BulkTrashRequestPropertyValidationAttributesMap: {
+    [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 BulkTrashRequest interface.
+ */
+export declare function instanceOfBulkTrashRequest(value: object): value is BulkTrashRequest;
+export declare function BulkTrashRequestFromJSON(json: any): BulkTrashRequest;
+export declare function BulkTrashRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkTrashRequest;
+export declare function BulkTrashRequestToJSON(json: any): BulkTrashRequest;
+export declare function BulkTrashRequestToJSONTyped(value?: BulkTrashRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/BulkTrashRequest.js

@@ -0,0 +1,42 @@
+/* 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.
+ */
+export const BulkTrashRequestPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkTrashRequest interface.
+ */
+export function instanceOfBulkTrashRequest(value) {
+    return true;
+}
+export function BulkTrashRequestFromJSON(json) {
+    return BulkTrashRequestFromJSONTyped(json, false);
+}
+export function BulkTrashRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'objectIds': json['object_ids'] == null ? undefined : json['object_ids'],
+    };
+}
+export function BulkTrashRequestToJSON(json) {
+    return BulkTrashRequestToJSONTyped(json, false);
+}
+export function BulkTrashRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'object_ids': value['objectIds'],
+    };
+}

package/dist/esm/models/CreateUploadRequest.d.ts

@@ -39,6 +39,12 @@ export interface CreateUploadRequest {
      * @memberof CreateUploadRequest
      */
     sizeBytes: number;
+    /**
+     * Tags applied to the document on completion (mirrors the buffered ingest endpoints so a mixed submit tags recordings too)
+     * @type {Array<string>}
+     * @memberof CreateUploadRequest
+     */
+    tagIds?: Array<string>;
 }
 export declare const CreateUploadRequestPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/CreateUploadRequest.js

@@ -38,6 +38,7 @@ export function CreateUploadRequestFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'filename': json['filename'],
         'sizeBytes': json['size_bytes'],
+        'tagIds': json['tag_ids'] == null ? undefined : json['tag_ids'],
     };
 }
 export function CreateUploadRequestToJSON(json) {
@@ -52,5 +53,6 @@ export function CreateUploadRequestToJSONTyped(value, ignoreDiscriminator = fals
         'name': value['name'],
         'filename': value['filename'],
         'size_bytes': value['sizeBytes'],
+        'tag_ids': value['tagIds'],
     };
 }

package/dist/esm/models/DocumentVersionMetadata.d.ts

@@ -87,6 +87,24 @@ export interface DocumentVersionMetadata {
      * @memberof DocumentVersionMetadata
      */
     totalChunks?: number | null;
+    /**
+     * Media (audio/video) duration in milliseconds; null for non-media
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    durationMs?: number | null;
+    /**
+     * ASR-detected language of the media transcript, as returned by the ASR provider; null for non-media or when the provider omits it
+     * @type {string}
+     * @memberof DocumentVersionMetadata
+     */
+    language?: string | null;
+    /**
+     * Number of transcript segments produced by ASR; null for non-media
+     * @type {number}
+     * @memberof DocumentVersionMetadata
+     */
+    segmentCount?: number | null;
     /**
      * Total formula cells in the workbook (XLSX only)
      * @type {number}

package/dist/esm/models/DocumentVersionMetadata.js

@@ -39,6 +39,9 @@ export function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator)
         'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
         'totalSections': json['total_sections'] == null ? undefined : json['total_sections'],
         'totalChunks': json['total_chunks'] == null ? undefined : json['total_chunks'],
+        'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
+        'language': json['language'] == null ? undefined : json['language'],
+        'segmentCount': json['segment_count'] == null ? undefined : json['segment_count'],
         'totalFormulas': json['total_formulas'] == null ? undefined : json['total_formulas'],
         'xlsxParseResultS3': json['xlsx_parse_result_s3'] == null ? undefined : json['xlsx_parse_result_s3'],
         'xlsxNamedRanges': json['xlsx_named_ranges'] == null ? undefined : json['xlsx_named_ranges'],
@@ -70,6 +73,9 @@ export function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator =
         'total_pages': value['totalPages'],
         'total_sections': value['totalSections'],
         'total_chunks': value['totalChunks'],
+        'duration_ms': value['durationMs'],
+        'language': value['language'],
+        'segment_count': value['segmentCount'],
         'total_formulas': value['totalFormulas'],
         'xlsx_parse_result_s3': value['xlsxParseResultS3'],
         'xlsx_named_ranges': value['xlsxNamedRanges'],

package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts

@@ -99,6 +99,24 @@ export interface DocumentVersionMetadataUpdate {
      * @memberof DocumentVersionMetadataUpdate
      */
     totalChunks?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    durationMs?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    language?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof DocumentVersionMetadataUpdate
+     */
+    segmentCount?: number | null;
     /**
      *
      * @type {number}

package/dist/esm/models/DocumentVersionMetadataUpdate.js

@@ -42,6 +42,9 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json, ignoreDiscrimin
         'totalPages': json['total_pages'] == null ? undefined : json['total_pages'],
         'totalSections': json['total_sections'] == null ? undefined : json['total_sections'],
         'totalChunks': json['total_chunks'] == null ? undefined : json['total_chunks'],
+        'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
+        'language': json['language'] == null ? undefined : json['language'],
+        'segmentCount': json['segment_count'] == null ? undefined : json['segment_count'],
         'totalFormulas': json['total_formulas'] == null ? undefined : json['total_formulas'],
         'xlsxParseResultS3': json['xlsx_parse_result_s3'] == null ? undefined : json['xlsx_parse_result_s3'],
         'xlsxNamedRanges': json['xlsx_named_ranges'] == null ? undefined : json['xlsx_named_ranges'],
@@ -75,6 +78,9 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value, ignoreDiscrimina
         'total_pages': value['totalPages'],
         'total_sections': value['totalSections'],
         'total_chunks': value['totalChunks'],
+        'duration_ms': value['durationMs'],
+        'language': value['language'],
+        'segment_count': value['segmentCount'],
         'total_formulas': value['totalFormulas'],
         'xlsx_parse_result_s3': value['xlsxParseResultS3'],
         'xlsx_named_ranges': value['xlsxNamedRanges'],

package/dist/esm/models/ErrorResponse.d.ts

@@ -40,6 +40,7 @@ export interface ErrorResponse {
 export declare const ErrorResponseCodeEnum: {
     readonly Error: 'error';
     readonly BadRequest: 'bad_request';
+    readonly PermissionLimit: 'permission_limit';
     readonly Unauthorized: 'unauthorized';
     readonly Forbidden: 'forbidden';
     readonly NotFound: 'not_found';

package/dist/esm/models/ErrorResponse.js

@@ -17,6 +17,7 @@
 export const ErrorResponseCodeEnum = {
     Error: 'error',
     BadRequest: 'bad_request',
+    PermissionLimit: 'permission_limit',
     Unauthorized: 'unauthorized',
     Forbidden: 'forbidden',
     NotFound: 'not_found',

package/dist/esm/models/index.d.ts

@@ -17,10 +17,22 @@ export * from './AskResponse';
 export * from './BlockChangeType';
 export * from './BlockKind';
 export * from './BrandingLogoType';
+export * from './BulkDeleteRequest';
 export * from './BulkDownloadRequest';
+export * from './BulkFailureReason';
+export * from './BulkGrantItem';
+export * from './BulkGrantItemFailure';
+export * from './BulkGrantRequest';
+export * from './BulkGrantResponse';
+export * from './BulkGrantSuccess';
+export * from './BulkItemFailure';
 export * from './BulkModelTablesRequest';
 export * from './BulkModelTablesResponse';
+export * from './BulkMoveRequest';
+export * from './BulkOperationResponse';
+export * from './BulkRevokeRequest';
 export * from './BulkTagRequest';
+export * from './BulkTrashRequest';
 export * from './CatalogColumnResponse';
 export * from './CatalogTableResponse';
 export * from './CellChange';

package/dist/esm/models/index.js

@@ -19,10 +19,22 @@ export * from './AskResponse';
 export * from './BlockChangeType';
 export * from './BlockKind';
 export * from './BrandingLogoType';
+export * from './BulkDeleteRequest';
 export * from './BulkDownloadRequest';
+export * from './BulkFailureReason';
+export * from './BulkGrantItem';
+export * from './BulkGrantItemFailure';
+export * from './BulkGrantRequest';
+export * from './BulkGrantResponse';
+export * from './BulkGrantSuccess';
+export * from './BulkItemFailure';
 export * from './BulkModelTablesRequest';
 export * from './BulkModelTablesResponse';
+export * from './BulkMoveRequest';
+export * from './BulkOperationResponse';
+export * from './BulkRevokeRequest';
 export * from './BulkTagRequest';
+export * from './BulkTrashRequest';
 export * from './CatalogColumnResponse';
 export * from './CatalogTableResponse';
 export * from './CellChange';

package/dist/models/BulkDeleteRequest.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+/**
+ * Soft-delete the selected folders and documents to Trash.
+ * @export
+ * @interface BulkDeleteRequest
+ */
+export interface BulkDeleteRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkDeleteRequest
+     */
+    folderIds?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkDeleteRequest
+     */
+    documentIds?: Array<string>;
+}
+export declare const BulkDeleteRequestPropertyValidationAttributesMap: {
+    [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 BulkDeleteRequest interface.
+ */
+export declare function instanceOfBulkDeleteRequest(value: object): value is BulkDeleteRequest;
+export declare function BulkDeleteRequestFromJSON(json: any): BulkDeleteRequest;
+export declare function BulkDeleteRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkDeleteRequest;
+export declare function BulkDeleteRequestToJSON(json: any): BulkDeleteRequest;
+export declare function BulkDeleteRequestToJSONTyped(value?: BulkDeleteRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BulkDeleteRequest.js

@@ -0,0 +1,52 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkDeleteRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkDeleteRequest = instanceOfBulkDeleteRequest;
+exports.BulkDeleteRequestFromJSON = BulkDeleteRequestFromJSON;
+exports.BulkDeleteRequestFromJSONTyped = BulkDeleteRequestFromJSONTyped;
+exports.BulkDeleteRequestToJSON = BulkDeleteRequestToJSON;
+exports.BulkDeleteRequestToJSONTyped = BulkDeleteRequestToJSONTyped;
+exports.BulkDeleteRequestPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkDeleteRequest interface.
+ */
+function instanceOfBulkDeleteRequest(value) {
+    return true;
+}
+function BulkDeleteRequestFromJSON(json) {
+    return BulkDeleteRequestFromJSONTyped(json, false);
+}
+function BulkDeleteRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'folderIds': json['folder_ids'] == null ? undefined : json['folder_ids'],
+        'documentIds': json['document_ids'] == null ? undefined : json['document_ids'],
+    };
+}
+function BulkDeleteRequestToJSON(json) {
+    return BulkDeleteRequestToJSONTyped(json, false);
+}
+function BulkDeleteRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'folder_ids': value['folderIds'],
+        'document_ids': value['documentIds'],
+    };
+}

package/dist/models/BulkFailureReason.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+/**
+ * Why a single item in a bulk operation was not applied.
+ *
+ * Every value is produced by a specific, pre-checked gate — an *unexpected*
+ * per-item error is deliberately not caught (it surfaces as a 500) rather than
+ * hidden behind a vague catch-all.
+ * @export
+ */
+export declare const BulkFailureReason: {
+    readonly NotFound: 'not_found';
+    readonly Forbidden: 'forbidden';
+    readonly SystemManaged: 'system_managed';
+    readonly Subsumed: 'subsumed';
+    readonly Cycle: 'cycle';
+    readonly Sealed: 'sealed';
+    readonly CheckedOut: 'checked_out';
+    readonly NameConflict: 'name_conflict';
+    readonly InProgressWorkflow: 'in_progress_workflow';
+    readonly PermissionLimit: 'permission_limit';
+};
+export type BulkFailureReason = typeof BulkFailureReason[keyof typeof BulkFailureReason];
+export declare function instanceOfBulkFailureReason(value: any): boolean;
+export declare function BulkFailureReasonFromJSON(json: any): BulkFailureReason;
+export declare function BulkFailureReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkFailureReason;
+export declare function BulkFailureReasonToJSON(value?: BulkFailureReason | null): any;
+export declare function BulkFailureReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): BulkFailureReason;

package/dist/models/BulkFailureReason.js

@@ -0,0 +1,63 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkFailureReason = void 0;
+exports.instanceOfBulkFailureReason = instanceOfBulkFailureReason;
+exports.BulkFailureReasonFromJSON = BulkFailureReasonFromJSON;
+exports.BulkFailureReasonFromJSONTyped = BulkFailureReasonFromJSONTyped;
+exports.BulkFailureReasonToJSON = BulkFailureReasonToJSON;
+exports.BulkFailureReasonToJSONTyped = BulkFailureReasonToJSONTyped;
+/**
+ * Why a single item in a bulk operation was not applied.
+ *
+ * Every value is produced by a specific, pre-checked gate — an *unexpected*
+ * per-item error is deliberately not caught (it surfaces as a 500) rather than
+ * hidden behind a vague catch-all.
+ * @export
+ */
+exports.BulkFailureReason = {
+    NotFound: 'not_found',
+    Forbidden: 'forbidden',
+    SystemManaged: 'system_managed',
+    Subsumed: 'subsumed',
+    Cycle: 'cycle',
+    Sealed: 'sealed',
+    CheckedOut: 'checked_out',
+    NameConflict: 'name_conflict',
+    InProgressWorkflow: 'in_progress_workflow',
+    PermissionLimit: 'permission_limit'
+};
+function instanceOfBulkFailureReason(value) {
+    for (const key in exports.BulkFailureReason) {
+        if (Object.prototype.hasOwnProperty.call(exports.BulkFailureReason, key)) {
+            if (exports.BulkFailureReason[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function BulkFailureReasonFromJSON(json) {
+    return BulkFailureReasonFromJSONTyped(json, false);
+}
+function BulkFailureReasonFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function BulkFailureReasonToJSON(value) {
+    return value;
+}
+function BulkFailureReasonToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/BulkGrantItem.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 type { PermissionCapability } from './PermissionCapability';
+/**
+ * One requested grant: a capability on an object (PDO id) for a user.
+ * @export
+ * @interface BulkGrantItem
+ */
+export interface BulkGrantItem {
+    /**
+     *
+     * @type {string}
+     * @memberof BulkGrantItem
+     */
+    userId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BulkGrantItem
+     */
+    objectId: string;
+    /**
+     *
+     * @type {PermissionCapability}
+     * @memberof BulkGrantItem
+     */
+    capability: PermissionCapability;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BulkGrantItem
+     */
+    canApprove?: boolean;
+}
+export declare const BulkGrantItemPropertyValidationAttributesMap: {
+    [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 BulkGrantItem interface.
+ */
+export declare function instanceOfBulkGrantItem(value: object): value is BulkGrantItem;
+export declare function BulkGrantItemFromJSON(json: any): BulkGrantItem;
+export declare function BulkGrantItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkGrantItem;
+export declare function BulkGrantItemToJSON(json: any): BulkGrantItem;
+export declare function BulkGrantItemToJSONTyped(value?: BulkGrantItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BulkGrantItem.js

@@ -0,0 +1,63 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkGrantItemPropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkGrantItem = instanceOfBulkGrantItem;
+exports.BulkGrantItemFromJSON = BulkGrantItemFromJSON;
+exports.BulkGrantItemFromJSONTyped = BulkGrantItemFromJSONTyped;
+exports.BulkGrantItemToJSON = BulkGrantItemToJSON;
+exports.BulkGrantItemToJSONTyped = BulkGrantItemToJSONTyped;
+const PermissionCapability_1 = require("./PermissionCapability");
+exports.BulkGrantItemPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkGrantItem interface.
+ */
+function instanceOfBulkGrantItem(value) {
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('objectId' in value) || value['objectId'] === undefined)
+        return false;
+    if (!('capability' in value) || value['capability'] === undefined)
+        return false;
+    return true;
+}
+function BulkGrantItemFromJSON(json) {
+    return BulkGrantItemFromJSONTyped(json, false);
+}
+function BulkGrantItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['user_id'],
+        'objectId': json['object_id'],
+        'capability': (0, PermissionCapability_1.PermissionCapabilityFromJSON)(json['capability']),
+        'canApprove': json['can_approve'] == null ? undefined : json['can_approve'],
+    };
+}
+function BulkGrantItemToJSON(json) {
+    return BulkGrantItemToJSONTyped(json, false);
+}
+function BulkGrantItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_id': value['userId'],
+        'object_id': value['objectId'],
+        'capability': (0, PermissionCapability_1.PermissionCapabilityToJSON)(value['capability']),
+        'can_approve': value['canApprove'],
+    };
+}