@knowledge-stack/ksapi 3.11.0 → 3.13.0

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

@@ -0,0 +1,80 @@
+/**
+ * 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 { TenantUserRole } from './TenantUserRole';
+import type { UserInfo } from './UserInfo';
+import type { InvitePreviewState } from './InvitePreviewState';
+/**
+ *
+ * @export
+ * @interface InvitePreviewResponse
+ */
+export interface InvitePreviewResponse {
+    /**
+     *
+     * @type {InvitePreviewState}
+     * @memberof InvitePreviewResponse
+     */
+    state: InvitePreviewState;
+    /**
+     * Invitee email, to lock the form
+     * @type {string}
+     * @memberof InvitePreviewResponse
+     */
+    email?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof InvitePreviewResponse
+     */
+    tenantName?: string | null;
+    /**
+     *
+     * @type {TenantUserRole}
+     * @memberof InvitePreviewResponse
+     */
+    role?: TenantUserRole;
+    /**
+     *
+     * @type {Date}
+     * @memberof InvitePreviewResponse
+     */
+    expiresAt?: Date | null;
+    /**
+     * Display name only, no email
+     * @type {UserInfo}
+     * @memberof InvitePreviewResponse
+     */
+    invitedBy?: UserInfo | null;
+}
+export declare const InvitePreviewResponsePropertyValidationAttributesMap: {
+    [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 InvitePreviewResponse interface.
+ */
+export declare function instanceOfInvitePreviewResponse(value: object): value is InvitePreviewResponse;
+export declare function InvitePreviewResponseFromJSON(json: any): InvitePreviewResponse;
+export declare function InvitePreviewResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvitePreviewResponse;
+export declare function InvitePreviewResponseToJSON(json: any): InvitePreviewResponse;
+export declare function InvitePreviewResponseToJSONTyped(value?: InvitePreviewResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/InvitePreviewResponse.js

@@ -0,0 +1,57 @@
+/* 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 { TenantUserRoleFromJSON, TenantUserRoleToJSON, } from './TenantUserRole';
+import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
+import { InvitePreviewStateFromJSON, InvitePreviewStateToJSON, } from './InvitePreviewState';
+export const InvitePreviewResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the InvitePreviewResponse interface.
+ */
+export function instanceOfInvitePreviewResponse(value) {
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    return true;
+}
+export function InvitePreviewResponseFromJSON(json) {
+    return InvitePreviewResponseFromJSONTyped(json, false);
+}
+export function InvitePreviewResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'state': InvitePreviewStateFromJSON(json['state']),
+        'email': json['email'] == null ? undefined : json['email'],
+        'tenantName': json['tenant_name'] == null ? undefined : json['tenant_name'],
+        'role': json['role'] == null ? undefined : TenantUserRoleFromJSON(json['role']),
+        'expiresAt': json['expires_at'] == null ? undefined : (new Date(json['expires_at'])),
+        'invitedBy': json['invited_by'] == null ? undefined : UserInfoFromJSON(json['invited_by']),
+    };
+}
+export function InvitePreviewResponseToJSON(json) {
+    return InvitePreviewResponseToJSONTyped(json, false);
+}
+export function InvitePreviewResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'state': InvitePreviewStateToJSON(value['state']),
+        'email': value['email'],
+        'tenant_name': value['tenantName'],
+        'role': TenantUserRoleToJSON(value['role']),
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
+        'invited_by': UserInfoToJSON(value['invitedBy']),
+    };
+}

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

@@ -0,0 +1,28 @@
+/**
+ * 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
+ */
+export declare const InvitePreviewState: {
+    readonly Valid: 'valid';
+    readonly Expired: 'expired';
+    readonly Accepted: 'accepted';
+    readonly NotFound: 'not_found';
+    readonly TenantUnavailable: 'tenant_unavailable';
+};
+export type InvitePreviewState = typeof InvitePreviewState[keyof typeof InvitePreviewState];
+export declare function instanceOfInvitePreviewState(value: any): boolean;
+export declare function InvitePreviewStateFromJSON(json: any): InvitePreviewState;
+export declare function InvitePreviewStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvitePreviewState;
+export declare function InvitePreviewStateToJSON(value?: InvitePreviewState | null): any;
+export declare function InvitePreviewStateToJSONTyped(value: any, ignoreDiscriminator: boolean): InvitePreviewState;

package/dist/esm/models/InvitePreviewState.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.
+ */
+/**
+ *
+ * @export
+ */
+export const InvitePreviewState = {
+    Valid: 'valid',
+    Expired: 'expired',
+    Accepted: 'accepted',
+    NotFound: 'not_found',
+    TenantUnavailable: 'tenant_unavailable'
+};
+export function instanceOfInvitePreviewState(value) {
+    for (const key in InvitePreviewState) {
+        if (Object.prototype.hasOwnProperty.call(InvitePreviewState, key)) {
+            if (InvitePreviewState[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function InvitePreviewStateFromJSON(json) {
+    return InvitePreviewStateFromJSONTyped(json, false);
+}
+export function InvitePreviewStateFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function InvitePreviewStateToJSON(value) {
+    return value;
+}
+export function InvitePreviewStateToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,30 @@
+/**
+ * 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
+ */
+export declare const InviteRejection: {
+    readonly NotFound: 'not_found';
+    readonly Accepted: 'accepted';
+    readonly Expired: 'expired';
+    readonly TenantUnavailable: 'tenant_unavailable';
+    readonly InvitesDisabled: 'invites_disabled';
+    readonly EmailMismatch: 'email_mismatch';
+    readonly NoSeat: 'no_seat';
+};
+export type InviteRejection = typeof InviteRejection[keyof typeof InviteRejection];
+export declare function instanceOfInviteRejection(value: any): boolean;
+export declare function InviteRejectionFromJSON(json: any): InviteRejection;
+export declare function InviteRejectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): InviteRejection;
+export declare function InviteRejectionToJSON(value?: InviteRejection | null): any;
+export declare function InviteRejectionToJSONTyped(value: any, ignoreDiscriminator: boolean): InviteRejection;

package/dist/esm/models/InviteRejection.js

@@ -0,0 +1,48 @@
+/* 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
+ */
+export const InviteRejection = {
+    NotFound: 'not_found',
+    Accepted: 'accepted',
+    Expired: 'expired',
+    TenantUnavailable: 'tenant_unavailable',
+    InvitesDisabled: 'invites_disabled',
+    EmailMismatch: 'email_mismatch',
+    NoSeat: 'no_seat'
+};
+export function instanceOfInviteRejection(value) {
+    for (const key in InviteRejection) {
+        if (Object.prototype.hasOwnProperty.call(InviteRejection, key)) {
+            if (InviteRejection[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function InviteRejectionFromJSON(json) {
+    return InviteRejectionFromJSONTyped(json, false);
+}
+export function InviteRejectionFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function InviteRejectionToJSON(value) {
+    return value;
+}
+export function InviteRejectionToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -38,6 +38,14 @@ export interface KbSummaryResponse {
     documentsByType: {
         [key: string]: number;
     };
+    /**
+     * Live document count keyed by the active version's pipeline status (pending, processing, completed, failed, cancelled, quota_limit). Documents whose active version was never ingested are absent.
+     * @type {{ [key: string]: number; }}
+     * @memberof KbSummaryResponse
+     */
+    documentsByIngestionStatus: {
+        [key: string]: number;
+    };
     /**
      *
      * @type {number}

package/dist/esm/models/KbSummaryResponse.js

@@ -23,6 +23,8 @@ export function instanceOfKbSummaryResponse(value) {
         return false;
     if (!('documentsByType' in value) || value['documentsByType'] === undefined)
         return false;
+    if (!('documentsByIngestionStatus' in value) || value['documentsByIngestionStatus'] === undefined)
+        return false;
     if (!('documentVersionsTotal' in value) || value['documentVersionsTotal'] === undefined)
         return false;
     if (!('chunksTotal' in value) || value['chunksTotal'] === undefined)
@@ -64,6 +66,7 @@ export function KbSummaryResponseFromJSONTyped(json, ignoreDiscriminator) {
         'documentsTotal': json['documents_total'],
         'documentsByOrigin': json['documents_by_origin'],
         'documentsByType': json['documents_by_type'],
+        'documentsByIngestionStatus': json['documents_by_ingestion_status'],
         'documentVersionsTotal': json['document_versions_total'],
         'chunksTotal': json['chunks_total'],
         'chunksByType': json['chunks_by_type'],
@@ -91,6 +94,7 @@ export function KbSummaryResponseToJSONTyped(value, ignoreDiscriminator = false)
         'documents_total': value['documentsTotal'],
         'documents_by_origin': value['documentsByOrigin'],
         'documents_by_type': value['documentsByType'],
+        'documents_by_ingestion_status': value['documentsByIngestionStatus'],
         'document_versions_total': value['documentVersionsTotal'],
         'chunks_total': value['chunksTotal'],
         'chunks_by_type': value['chunksByType'],

package/dist/esm/models/{OnboardingCompanyRequest.d.ts → OnboardingState.d.ts}

@@ -9,26 +9,34 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GuideModules } from './GuideModules';
+import type { OnboardingStep } from './OnboardingStep';
 /**
- * Step 1 of onboarding — tenant-wide company info. OWNER/ADMIN only.
+ * Stored state: keys and steps this release does not know are dropped.
  * @export
- * @interface OnboardingCompanyRequest
+ * @interface OnboardingState
  */
-export interface OnboardingCompanyRequest {
+export interface OnboardingState {
     /**
-     * Brief company description (≤5000 chars)
-     * @type {string}
-     * @memberof OnboardingCompanyRequest
+     *
+     * @type {OnboardingStep}
+     * @memberof OnboardingState
      */
-    description?: string | null;
+    currentStep?: OnboardingStep;
     /**
-     * Industry / company type (free text)
-     * @type {string}
-     * @memberof OnboardingCompanyRequest
+     *
+     * @type {GuideModules}
+     * @memberof OnboardingState
      */
-    industry?: string | null;
+    guideModules?: GuideModules;
+    /**
+     *
+     * @type {boolean}
+     * @memberof OnboardingState
+     */
+    setupChecklistDismissed?: boolean;
 }
-export declare const OnboardingCompanyRequestPropertyValidationAttributesMap: {
+export declare const OnboardingStatePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number;
         minLength?: number;
@@ -44,10 +52,10 @@ export declare const OnboardingCompanyRequestPropertyValidationAttributesMap: {
     };
 };
 /**
- * Check if a given object implements the OnboardingCompanyRequest interface.
+ * Check if a given object implements the OnboardingState interface.
  */
-export declare function instanceOfOnboardingCompanyRequest(value: object): value is OnboardingCompanyRequest;
-export declare function OnboardingCompanyRequestFromJSON(json: any): OnboardingCompanyRequest;
-export declare function OnboardingCompanyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingCompanyRequest;
-export declare function OnboardingCompanyRequestToJSON(json: any): OnboardingCompanyRequest;
-export declare function OnboardingCompanyRequestToJSONTyped(value?: OnboardingCompanyRequest | null, ignoreDiscriminator?: boolean): any;
+export declare function instanceOfOnboardingState(value: object): value is OnboardingState;
+export declare function OnboardingStateFromJSON(json: any): OnboardingState;
+export declare function OnboardingStateFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingState;
+export declare function OnboardingStateToJSON(json: any): OnboardingState;
+export declare function OnboardingStateToJSONTyped(value?: OnboardingState | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/{OnboardingProfileRequest.js → OnboardingState.js}

@@ -11,40 +11,38 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-export const OnboardingProfileRequestPropertyValidationAttributesMap = {
-    jobTitle: {
-        maxLength: 120,
-    },
-};
+import { GuideModulesFromJSON, GuideModulesToJSON, } from './GuideModules';
+import { OnboardingStepFromJSON, OnboardingStepToJSON, } from './OnboardingStep';
+export const OnboardingStatePropertyValidationAttributesMap = {};
 /**
- * Check if a given object implements the OnboardingProfileRequest interface.
+ * Check if a given object implements the OnboardingState interface.
  */
-export function instanceOfOnboardingProfileRequest(value) {
+export function instanceOfOnboardingState(value) {
     return true;
 }
-export function OnboardingProfileRequestFromJSON(json) {
-    return OnboardingProfileRequestFromJSONTyped(json, false);
+export function OnboardingStateFromJSON(json) {
+    return OnboardingStateFromJSONTyped(json, false);
 }
-export function OnboardingProfileRequestFromJSONTyped(json, ignoreDiscriminator) {
+export function OnboardingStateFromJSONTyped(json, ignoreDiscriminator) {
     if (json == null) {
         return json;
     }
     return {
-        'firstName': json['first_name'] == null ? undefined : json['first_name'],
-        'lastName': json['last_name'] == null ? undefined : json['last_name'],
-        'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
+        'currentStep': json['current_step'] == null ? undefined : OnboardingStepFromJSON(json['current_step']),
+        'guideModules': json['guide_modules'] == null ? undefined : GuideModulesFromJSON(json['guide_modules']),
+        'setupChecklistDismissed': json['setup_checklist_dismissed'] == null ? undefined : json['setup_checklist_dismissed'],
     };
 }
-export function OnboardingProfileRequestToJSON(json) {
-    return OnboardingProfileRequestToJSONTyped(json, false);
+export function OnboardingStateToJSON(json) {
+    return OnboardingStateToJSONTyped(json, false);
 }
-export function OnboardingProfileRequestToJSONTyped(value, ignoreDiscriminator = false) {
+export function OnboardingStateToJSONTyped(value, ignoreDiscriminator = false) {
     if (value == null) {
         return value;
     }
     return {
-        'first_name': value['firstName'],
-        'last_name': value['lastName'],
-        'job_title': value['jobTitle'],
+        'current_step': OnboardingStepToJSON(value['currentStep']),
+        'guide_modules': GuideModulesToJSON(value['guideModules']),
+        'setup_checklist_dismissed': value['setupChecklistDismissed'],
     };
 }

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

@@ -0,0 +1,61 @@
+/**
+ * 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 { GuideModules } from './GuideModules';
+import type { OnboardingStep } from './OnboardingStep';
+/**
+ *
+ * @export
+ * @interface OnboardingStateUpdate
+ */
+export interface OnboardingStateUpdate {
+    /**
+     *
+     * @type {OnboardingStep}
+     * @memberof OnboardingStateUpdate
+     */
+    currentStep?: OnboardingStep;
+    /**
+     * Guide module progress to merge in. A completed or dismissed module only moves back to in progress under a newer module version.
+     * @type {GuideModules}
+     * @memberof OnboardingStateUpdate
+     */
+    guideModules?: GuideModules | null;
+    /**
+     * Whether the setup checklist is dismissed
+     * @type {boolean}
+     * @memberof OnboardingStateUpdate
+     */
+    setupChecklistDismissed?: boolean | null;
+}
+export declare const OnboardingStateUpdatePropertyValidationAttributesMap: {
+    [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 OnboardingStateUpdate interface.
+ */
+export declare function instanceOfOnboardingStateUpdate(value: object): value is OnboardingStateUpdate;
+export declare function OnboardingStateUpdateFromJSON(json: any): OnboardingStateUpdate;
+export declare function OnboardingStateUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingStateUpdate;
+export declare function OnboardingStateUpdateToJSON(json: any): OnboardingStateUpdate;
+export declare function OnboardingStateUpdateToJSONTyped(value?: OnboardingStateUpdate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/OnboardingStateUpdate.js

@@ -0,0 +1,48 @@
+/* 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 { GuideModulesFromJSON, GuideModulesToJSON, } from './GuideModules';
+import { OnboardingStepFromJSON, OnboardingStepToJSON, } from './OnboardingStep';
+export const OnboardingStateUpdatePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the OnboardingStateUpdate interface.
+ */
+export function instanceOfOnboardingStateUpdate(value) {
+    return true;
+}
+export function OnboardingStateUpdateFromJSON(json) {
+    return OnboardingStateUpdateFromJSONTyped(json, false);
+}
+export function OnboardingStateUpdateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'currentStep': json['current_step'] == null ? undefined : OnboardingStepFromJSON(json['current_step']),
+        'guideModules': json['guide_modules'] == null ? undefined : GuideModulesFromJSON(json['guide_modules']),
+        'setupChecklistDismissed': json['setup_checklist_dismissed'] == null ? undefined : json['setup_checklist_dismissed'],
+    };
+}
+export function OnboardingStateUpdateToJSON(json) {
+    return OnboardingStateUpdateToJSONTyped(json, false);
+}
+export function OnboardingStateUpdateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'current_step': OnboardingStepToJSON(value['currentStep']),
+        'guide_modules': GuideModulesToJSON(value['guideModules']),
+        'setup_checklist_dismissed': value['setupChecklistDismissed'],
+    };
+}

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

@@ -0,0 +1,27 @@
+/**
+ * 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
+ */
+export declare const OnboardingStep: {
+    readonly Workspace: 'WORKSPACE';
+    readonly Knowledge: 'KNOWLEDGE';
+    readonly Team: 'TEAM';
+    readonly Destination: 'DESTINATION';
+};
+export type OnboardingStep = typeof OnboardingStep[keyof typeof OnboardingStep];
+export declare function instanceOfOnboardingStep(value: any): boolean;
+export declare function OnboardingStepFromJSON(json: any): OnboardingStep;
+export declare function OnboardingStepFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingStep;
+export declare function OnboardingStepToJSON(value?: OnboardingStep | null): any;
+export declare function OnboardingStepToJSONTyped(value: any, ignoreDiscriminator: boolean): OnboardingStep;