@knowledge-stack/ksapi 1.154.1 → 1.156.0

package/dist/esm/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/esm/models/BulkGrantItem.js

@@ -0,0 +1,55 @@
+/* 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 { PermissionCapabilityFromJSON, PermissionCapabilityToJSON, } from './PermissionCapability';
+export const BulkGrantItemPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkGrantItem interface.
+ */
+export 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;
+}
+export function BulkGrantItemFromJSON(json) {
+    return BulkGrantItemFromJSONTyped(json, false);
+}
+export function BulkGrantItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['user_id'],
+        'objectId': json['object_id'],
+        'capability': PermissionCapabilityFromJSON(json['capability']),
+        'canApprove': json['can_approve'] == null ? undefined : json['can_approve'],
+    };
+}
+export function BulkGrantItemToJSON(json) {
+    return BulkGrantItemToJSONTyped(json, false);
+}
+export function BulkGrantItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_id': value['userId'],
+        'object_id': value['objectId'],
+        'capability': PermissionCapabilityToJSON(value['capability']),
+        'can_approve': value['canApprove'],
+    };
+}

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

@@ -0,0 +1,60 @@
+/**
+ * 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 grant that could not be created, keyed on its (user, object) pair.
+ * @export
+ * @interface BulkGrantItemFailure
+ */
+export interface BulkGrantItemFailure {
+    /**
+     *
+     * @type {string}
+     * @memberof BulkGrantItemFailure
+     */
+    userId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BulkGrantItemFailure
+     */
+    objectId: string;
+    /**
+     *
+     * @type {BulkFailureReason}
+     * @memberof BulkGrantItemFailure
+     */
+    reason: BulkFailureReason;
+}
+export declare const BulkGrantItemFailurePropertyValidationAttributesMap: {
+    [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 BulkGrantItemFailure interface.
+ */
+export declare function instanceOfBulkGrantItemFailure(value: object): value is BulkGrantItemFailure;
+export declare function BulkGrantItemFailureFromJSON(json: any): BulkGrantItemFailure;
+export declare function BulkGrantItemFailureFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkGrantItemFailure;
+export declare function BulkGrantItemFailureToJSON(json: any): BulkGrantItemFailure;
+export declare function BulkGrantItemFailureToJSONTyped(value?: BulkGrantItemFailure | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/BulkGrantItemFailure.js

@@ -0,0 +1,53 @@
+/* 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 { BulkFailureReasonFromJSON, BulkFailureReasonToJSON, } from './BulkFailureReason';
+export const BulkGrantItemFailurePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BulkGrantItemFailure interface.
+ */
+export function instanceOfBulkGrantItemFailure(value) {
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('objectId' in value) || value['objectId'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+export function BulkGrantItemFailureFromJSON(json) {
+    return BulkGrantItemFailureFromJSONTyped(json, false);
+}
+export function BulkGrantItemFailureFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['user_id'],
+        'objectId': json['object_id'],
+        'reason': BulkFailureReasonFromJSON(json['reason']),
+    };
+}
+export function BulkGrantItemFailureToJSON(json) {
+    return BulkGrantItemFailureToJSONTyped(json, false);
+}
+export function BulkGrantItemFailureToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_id': value['userId'],
+        'object_id': value['objectId'],
+        'reason': BulkFailureReasonToJSON(value['reason']),
+    };
+}

package/dist/esm/models/BulkGrantRequest.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 { BulkGrantItem } from './BulkGrantItem';
+/**
+ * Grant many (user, object, capability) permissions in one request.
+ * @export
+ * @interface BulkGrantRequest
+ */
+export interface BulkGrantRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BulkGrantRequest
+     */
+    tenantId: string;
+    /**
+     *
+     * @type {Array<BulkGrantItem>}
+     * @memberof BulkGrantRequest
+     */
+    grants?: Array<BulkGrantItem>;
+}
+export declare const BulkGrantRequestPropertyValidationAttributesMap: {
+    [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 BulkGrantRequest interface.
+ */
+export declare function instanceOfBulkGrantRequest(value: object): value is BulkGrantRequest;
+export declare function BulkGrantRequestFromJSON(json: any): BulkGrantRequest;
+export declare function BulkGrantRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkGrantRequest;
+export declare function BulkGrantRequestToJSON(json: any): BulkGrantRequest;
+export declare function BulkGrantRequestToJSONTyped(value?: BulkGrantRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/BulkGrantRequest.js

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

package/dist/esm/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/esm/models/BulkGrantResponse.js

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

package/dist/esm/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/esm/models/BulkGrantSuccess.js

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