@knowledge-stack/ksapi 1.154.1 → 1.156.0

package/dist/models/BulkGrantRequest.js

@@ -0,0 +1,55 @@
+"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.BulkGrantRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkGrantRequest = instanceOfBulkGrantRequest;
+exports.BulkGrantRequestFromJSON = BulkGrantRequestFromJSON;
+exports.BulkGrantRequestFromJSONTyped = BulkGrantRequestFromJSONTyped;
+exports.BulkGrantRequestToJSON = BulkGrantRequestToJSON;
+exports.BulkGrantRequestToJSONTyped = BulkGrantRequestToJSONTyped;
+const BulkGrantItem_1 = require("./BulkGrantItem");
+exports.BulkGrantRequestPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkGrantRequest interface.
+ */
+function instanceOfBulkGrantRequest(value) {
+    if (!('tenantId' in value) || value['tenantId'] === undefined)
+        return false;
+    return true;
+}
+function BulkGrantRequestFromJSON(json) {
+    return BulkGrantRequestFromJSONTyped(json, false);
+}
+function BulkGrantRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'tenantId': json['tenant_id'],
+        'grants': json['grants'] == null ? undefined : (json['grants'].map(BulkGrantItem_1.BulkGrantItemFromJSON)),
+    };
+}
+function BulkGrantRequestToJSON(json) {
+    return BulkGrantRequestToJSONTyped(json, false);
+}
+function BulkGrantRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'tenant_id': value['tenantId'],
+        'grants': value['grants'] == null ? undefined : (value['grants'].map(BulkGrantItem_1.BulkGrantItemToJSON)),
+    };
+}

package/dist/models/BulkGrantResponse.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 { BulkGrantItemFailure } from './BulkGrantItemFailure';
+import type { BulkGrantSuccess } from './BulkGrantSuccess';
+/**
+ * Per-item outcome of a bulk grant (composite-keyed, unlike other bulks).
+ * @export
+ * @interface BulkGrantResponse
+ */
+export interface BulkGrantResponse {
+    /**
+     *
+     * @type {Array<BulkGrantSuccess>}
+     * @memberof BulkGrantResponse
+     */
+    succeeded?: Array<BulkGrantSuccess>;
+    /**
+     *
+     * @type {Array<BulkGrantItemFailure>}
+     * @memberof BulkGrantResponse
+     */
+    failed?: Array<BulkGrantItemFailure>;
+}
+export declare const BulkGrantResponsePropertyValidationAttributesMap: {
+    [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 BulkGrantResponse interface.
+ */
+export declare function instanceOfBulkGrantResponse(value: object): value is BulkGrantResponse;
+export declare function BulkGrantResponseFromJSON(json: any): BulkGrantResponse;
+export declare function BulkGrantResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkGrantResponse;
+export declare function BulkGrantResponseToJSON(json: any): BulkGrantResponse;
+export declare function BulkGrantResponseToJSONTyped(value?: BulkGrantResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BulkGrantResponse.js

@@ -0,0 +1,54 @@
+"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.BulkGrantResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkGrantResponse = instanceOfBulkGrantResponse;
+exports.BulkGrantResponseFromJSON = BulkGrantResponseFromJSON;
+exports.BulkGrantResponseFromJSONTyped = BulkGrantResponseFromJSONTyped;
+exports.BulkGrantResponseToJSON = BulkGrantResponseToJSON;
+exports.BulkGrantResponseToJSONTyped = BulkGrantResponseToJSONTyped;
+const BulkGrantItemFailure_1 = require("./BulkGrantItemFailure");
+const BulkGrantSuccess_1 = require("./BulkGrantSuccess");
+exports.BulkGrantResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkGrantResponse interface.
+ */
+function instanceOfBulkGrantResponse(value) {
+    return true;
+}
+function BulkGrantResponseFromJSON(json) {
+    return BulkGrantResponseFromJSONTyped(json, false);
+}
+function BulkGrantResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'succeeded': json['succeeded'] == null ? undefined : (json['succeeded'].map(BulkGrantSuccess_1.BulkGrantSuccessFromJSON)),
+        'failed': json['failed'] == null ? undefined : (json['failed'].map(BulkGrantItemFailure_1.BulkGrantItemFailureFromJSON)),
+    };
+}
+function BulkGrantResponseToJSON(json) {
+    return BulkGrantResponseToJSONTyped(json, false);
+}
+function BulkGrantResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'succeeded': value['succeeded'] == null ? undefined : (value['succeeded'].map(BulkGrantSuccess_1.BulkGrantSuccessToJSON)),
+        'failed': value['failed'] == null ? undefined : (value['failed'].map(BulkGrantItemFailure_1.BulkGrantItemFailureToJSON)),
+    };
+}

package/dist/models/BulkGrantSuccess.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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';
+/**
+ * A grant that was created, keyed on its (user, object) pair plus new id.
+ * @export
+ * @interface BulkGrantSuccess
+ */
+export interface BulkGrantSuccess {
+    /**
+     *
+     * @type {string}
+     * @memberof BulkGrantSuccess
+     */
+    userId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BulkGrantSuccess
+     */
+    objectId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BulkGrantSuccess
+     */
+    permissionId: string;
+    /**
+     *
+     * @type {PermissionCapability}
+     * @memberof BulkGrantSuccess
+     */
+    capability: PermissionCapability;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BulkGrantSuccess
+     */
+    canApprove: boolean;
+}
+export declare const BulkGrantSuccessPropertyValidationAttributesMap: {
+    [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 BulkGrantSuccess interface.
+ */
+export declare function instanceOfBulkGrantSuccess(value: object): value is BulkGrantSuccess;
+export declare function BulkGrantSuccessFromJSON(json: any): BulkGrantSuccess;
+export declare function BulkGrantSuccessFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkGrantSuccess;
+export declare function BulkGrantSuccessToJSON(json: any): BulkGrantSuccess;
+export declare function BulkGrantSuccessToJSONTyped(value?: BulkGrantSuccess | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BulkGrantSuccess.js

@@ -0,0 +1,69 @@
+"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.BulkGrantSuccessPropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkGrantSuccess = instanceOfBulkGrantSuccess;
+exports.BulkGrantSuccessFromJSON = BulkGrantSuccessFromJSON;
+exports.BulkGrantSuccessFromJSONTyped = BulkGrantSuccessFromJSONTyped;
+exports.BulkGrantSuccessToJSON = BulkGrantSuccessToJSON;
+exports.BulkGrantSuccessToJSONTyped = BulkGrantSuccessToJSONTyped;
+const PermissionCapability_1 = require("./PermissionCapability");
+exports.BulkGrantSuccessPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkGrantSuccess interface.
+ */
+function instanceOfBulkGrantSuccess(value) {
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('objectId' in value) || value['objectId'] === undefined)
+        return false;
+    if (!('permissionId' in value) || value['permissionId'] === undefined)
+        return false;
+    if (!('capability' in value) || value['capability'] === undefined)
+        return false;
+    if (!('canApprove' in value) || value['canApprove'] === undefined)
+        return false;
+    return true;
+}
+function BulkGrantSuccessFromJSON(json) {
+    return BulkGrantSuccessFromJSONTyped(json, false);
+}
+function BulkGrantSuccessFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['user_id'],
+        'objectId': json['object_id'],
+        'permissionId': json['permission_id'],
+        'capability': (0, PermissionCapability_1.PermissionCapabilityFromJSON)(json['capability']),
+        'canApprove': json['can_approve'],
+    };
+}
+function BulkGrantSuccessToJSON(json) {
+    return BulkGrantSuccessToJSONTyped(json, false);
+}
+function BulkGrantSuccessToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_id': value['userId'],
+        'object_id': value['objectId'],
+        'permission_id': value['permissionId'],
+        'capability': (0, PermissionCapability_1.PermissionCapabilityToJSON)(value['capability']),
+        'can_approve': value['canApprove'],
+    };
+}

package/dist/models/BulkItemFailure.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 { BulkFailureReason } from './BulkFailureReason';
+/**
+ * A single id that could not be applied, and why.
+ * @export
+ * @interface BulkItemFailure
+ */
+export interface BulkItemFailure {
+    /**
+     *
+     * @type {string}
+     * @memberof BulkItemFailure
+     */
+    id: string;
+    /**
+     *
+     * @type {BulkFailureReason}
+     * @memberof BulkItemFailure
+     */
+    reason: BulkFailureReason;
+}
+export declare const BulkItemFailurePropertyValidationAttributesMap: {
+    [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 BulkItemFailure interface.
+ */
+export declare function instanceOfBulkItemFailure(value: object): value is BulkItemFailure;
+export declare function BulkItemFailureFromJSON(json: any): BulkItemFailure;
+export declare function BulkItemFailureFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkItemFailure;
+export declare function BulkItemFailureToJSON(json: any): BulkItemFailure;
+export declare function BulkItemFailureToJSONTyped(value?: BulkItemFailure | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BulkItemFailure.js

@@ -0,0 +1,57 @@
+"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.BulkItemFailurePropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkItemFailure = instanceOfBulkItemFailure;
+exports.BulkItemFailureFromJSON = BulkItemFailureFromJSON;
+exports.BulkItemFailureFromJSONTyped = BulkItemFailureFromJSONTyped;
+exports.BulkItemFailureToJSON = BulkItemFailureToJSON;
+exports.BulkItemFailureToJSONTyped = BulkItemFailureToJSONTyped;
+const BulkFailureReason_1 = require("./BulkFailureReason");
+exports.BulkItemFailurePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkItemFailure interface.
+ */
+function instanceOfBulkItemFailure(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+function BulkItemFailureFromJSON(json) {
+    return BulkItemFailureFromJSONTyped(json, false);
+}
+function BulkItemFailureFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'reason': (0, BulkFailureReason_1.BulkFailureReasonFromJSON)(json['reason']),
+    };
+}
+function BulkItemFailureToJSON(json) {
+    return BulkItemFailureToJSONTyped(json, false);
+}
+function BulkItemFailureToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'reason': (0, BulkFailureReason_1.BulkFailureReasonToJSON)(value['reason']),
+    };
+}

package/dist/models/BulkMoveRequest.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+/**
+ * Move the selected folders and documents into ``target_folder_id``.
+ * @export
+ * @interface BulkMoveRequest
+ */
+export interface BulkMoveRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkMoveRequest
+     */
+    folderIds?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkMoveRequest
+     */
+    documentIds?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof BulkMoveRequest
+     */
+    targetFolderId: string;
+}
+export declare const BulkMoveRequestPropertyValidationAttributesMap: {
+    [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 BulkMoveRequest interface.
+ */
+export declare function instanceOfBulkMoveRequest(value: object): value is BulkMoveRequest;
+export declare function BulkMoveRequestFromJSON(json: any): BulkMoveRequest;
+export declare function BulkMoveRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkMoveRequest;
+export declare function BulkMoveRequestToJSON(json: any): BulkMoveRequest;
+export declare function BulkMoveRequestToJSONTyped(value?: BulkMoveRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BulkMoveRequest.js

@@ -0,0 +1,56 @@
+"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.BulkMoveRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkMoveRequest = instanceOfBulkMoveRequest;
+exports.BulkMoveRequestFromJSON = BulkMoveRequestFromJSON;
+exports.BulkMoveRequestFromJSONTyped = BulkMoveRequestFromJSONTyped;
+exports.BulkMoveRequestToJSON = BulkMoveRequestToJSON;
+exports.BulkMoveRequestToJSONTyped = BulkMoveRequestToJSONTyped;
+exports.BulkMoveRequestPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkMoveRequest interface.
+ */
+function instanceOfBulkMoveRequest(value) {
+    if (!('targetFolderId' in value) || value['targetFolderId'] === undefined)
+        return false;
+    return true;
+}
+function BulkMoveRequestFromJSON(json) {
+    return BulkMoveRequestFromJSONTyped(json, false);
+}
+function BulkMoveRequestFromJSONTyped(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'],
+        'targetFolderId': json['target_folder_id'],
+    };
+}
+function BulkMoveRequestToJSON(json) {
+    return BulkMoveRequestToJSONTyped(json, false);
+}
+function BulkMoveRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'folder_ids': value['folderIds'],
+        'document_ids': value['documentIds'],
+        'target_folder_id': value['targetFolderId'],
+    };
+}

package/dist/models/BulkOperationResponse.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 { BulkItemFailure } from './BulkItemFailure';
+/**
+ * Per-item outcome of a bulk operation keyed on a single PDO id.
+ * @export
+ * @interface BulkOperationResponse
+ */
+export interface BulkOperationResponse {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkOperationResponse
+     */
+    succeeded?: Array<string>;
+    /**
+     *
+     * @type {Array<BulkItemFailure>}
+     * @memberof BulkOperationResponse
+     */
+    failed?: Array<BulkItemFailure>;
+}
+export declare const BulkOperationResponsePropertyValidationAttributesMap: {
+    [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 BulkOperationResponse interface.
+ */
+export declare function instanceOfBulkOperationResponse(value: object): value is BulkOperationResponse;
+export declare function BulkOperationResponseFromJSON(json: any): BulkOperationResponse;
+export declare function BulkOperationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkOperationResponse;
+export declare function BulkOperationResponseToJSON(json: any): BulkOperationResponse;
+export declare function BulkOperationResponseToJSONTyped(value?: BulkOperationResponse | null, ignoreDiscriminator?: boolean): any;