@knowledge-stack/ksapi 3.11.0 → 3.12.0

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

@@ -0,0 +1,25 @@
+/**
+ * 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 AddedBy: {
+    readonly DirectorySync: 'directory_sync';
+    readonly Operator: 'operator';
+};
+export type AddedBy = typeof AddedBy[keyof typeof AddedBy];
+export declare function instanceOfAddedBy(value: any): boolean;
+export declare function AddedByFromJSON(json: any): AddedBy;
+export declare function AddedByFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddedBy;
+export declare function AddedByToJSON(value?: AddedBy | null): any;
+export declare function AddedByToJSONTyped(value: any, ignoreDiscriminator: boolean): AddedBy;

package/dist/esm/models/AddedBy.js

@@ -0,0 +1,43 @@
+/* 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 AddedBy = {
+    DirectorySync: 'directory_sync',
+    Operator: 'operator'
+};
+export function instanceOfAddedBy(value) {
+    for (const key in AddedBy) {
+        if (Object.prototype.hasOwnProperty.call(AddedBy, key)) {
+            if (AddedBy[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function AddedByFromJSON(json) {
+    return AddedByFromJSONTyped(json, false);
+}
+export function AddedByFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function AddedByToJSON(value) {
+    return value;
+}
+export function AddedByToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -39,6 +39,12 @@ export interface CreatePasswordUserRequest {
      * @memberof CreatePasswordUserRequest
      */
     lastName?: string | null;
+    /**
+     * Invite to resolve before any workspace is provisioned. When it is valid for the verified email the account joins that tenant only; otherwise sign-up proceeds as usual and invite_rejection says why.
+     * @type {string}
+     * @memberof CreatePasswordUserRequest
+     */
+    inviteId?: string | null;
 }
 export declare const CreatePasswordUserRequestPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/CreatePasswordUserRequest.js

@@ -38,6 +38,7 @@ export function CreatePasswordUserRequestFromJSONTyped(json, ignoreDiscriminator
         'emailToken': json['email_token'],
         'firstName': json['first_name'] == null ? undefined : json['first_name'],
         'lastName': json['last_name'] == null ? undefined : json['last_name'],
+        'inviteId': json['invite_id'] == null ? undefined : json['invite_id'],
     };
 }
 export function CreatePasswordUserRequestToJSON(json) {
@@ -52,5 +53,6 @@ export function CreatePasswordUserRequestToJSONTyped(value, ignoreDiscriminator
         'email_token': value['emailToken'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
+        'invite_id': value['inviteId'],
     };
 }

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

@@ -43,8 +43,10 @@ export declare const ErrorResponseCodeEnum: {
     readonly PermissionLimit: 'permission_limit';
     readonly Unauthorized: 'unauthorized';
     readonly Forbidden: 'forbidden';
+    readonly NoWorkspace: 'no_workspace';
     readonly NotFound: 'not_found';
     readonly Conflict: 'conflict';
+    readonly TenantDeactivated: 'tenant_deactivated';
     readonly RunBusy: 'run_busy';
     readonly PayloadTooLarge: 'payload_too_large';
     readonly UnsupportedMediaType: 'unsupported_media_type';

package/dist/esm/models/ErrorResponse.js

@@ -20,8 +20,10 @@ export const ErrorResponseCodeEnum = {
     PermissionLimit: 'permission_limit',
     Unauthorized: 'unauthorized',
     Forbidden: 'forbidden',
+    NoWorkspace: 'no_workspace',
     NotFound: 'not_found',
     Conflict: 'conflict',
+    TenantDeactivated: 'tenant_deactivated',
     RunBusy: 'run_busy',
     PayloadTooLarge: 'payload_too_large',
     UnsupportedMediaType: 'unsupported_media_type',

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

@@ -11,6 +11,7 @@
  */
 import type { SupportedLanguage } from './SupportedLanguage';
 import type { UploadConstraints } from './UploadConstraints';
+import type { DataSourceEngine } from './DataSourceEngine';
 /**
  *
  * @export
@@ -53,6 +54,12 @@ export interface FeaturesResponse {
      * @memberof FeaturesResponse
      */
     upload: UploadConstraints;
+    /**
+     *
+     * @type {Array<DataSourceEngine>}
+     * @memberof FeaturesResponse
+     */
+    dataSourceEngines: Array<DataSourceEngine>;
 }
 export declare const FeaturesResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/FeaturesResponse.js

@@ -13,6 +13,7 @@
  */
 import { SupportedLanguageFromJSON, SupportedLanguageToJSON, } from './SupportedLanguage';
 import { UploadConstraintsFromJSON, UploadConstraintsToJSON, } from './UploadConstraints';
+import { DataSourceEngineFromJSON, DataSourceEngineToJSON, } from './DataSourceEngine';
 export const FeaturesResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the FeaturesResponse interface.
@@ -30,6 +31,8 @@ export function instanceOfFeaturesResponse(value) {
         return false;
     if (!('upload' in value) || value['upload'] === undefined)
         return false;
+    if (!('dataSourceEngines' in value) || value['dataSourceEngines'] === undefined)
+        return false;
     return true;
 }
 export function FeaturesResponseFromJSON(json) {
@@ -46,6 +49,7 @@ export function FeaturesResponseFromJSONTyped(json, ignoreDiscriminator) {
         'smsLoginEnabled': json['sms_login_enabled'],
         'defaultFrontendLanguage': SupportedLanguageFromJSON(json['default_frontend_language']),
         'upload': UploadConstraintsFromJSON(json['upload']),
+        'dataSourceEngines': (json['data_source_engines'].map(DataSourceEngineFromJSON)),
     };
 }
 export function FeaturesResponseToJSON(json) {
@@ -62,5 +66,6 @@ export function FeaturesResponseToJSONTyped(value, ignoreDiscriminator = false)
         'sms_login_enabled': value['smsLoginEnabled'],
         'default_frontend_language': SupportedLanguageToJSON(value['defaultFrontendLanguage']),
         'upload': UploadConstraintsToJSON(value['upload']),
+        'data_source_engines': (value['dataSourceEngines'].map(DataSourceEngineToJSON)),
     };
 }

package/dist/esm/models/GuideModuleProgress.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 { GuideModuleStatus } from './GuideModuleStatus';
+/**
+ *
+ * @export
+ * @interface GuideModuleProgress
+ */
+export interface GuideModuleProgress {
+    /**
+     *
+     * @type {GuideModuleStatus}
+     * @memberof GuideModuleProgress
+     */
+    status: GuideModuleStatus;
+    /**
+     * Index of the last step the person reached
+     * @type {number}
+     * @memberof GuideModuleProgress
+     */
+    step: number;
+    /**
+     * Version of the module definition
+     * @type {number}
+     * @memberof GuideModuleProgress
+     */
+    version: number;
+    /**
+     * Server-stamped when the module first became COMPLETED; a client value is ignored. Null while not completed.
+     * @type {Date}
+     * @memberof GuideModuleProgress
+     */
+    completedAt?: Date | null;
+}
+export declare const GuideModuleProgressPropertyValidationAttributesMap: {
+    [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 GuideModuleProgress interface.
+ */
+export declare function instanceOfGuideModuleProgress(value: object): value is GuideModuleProgress;
+export declare function GuideModuleProgressFromJSON(json: any): GuideModuleProgress;
+export declare function GuideModuleProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): GuideModuleProgress;
+export declare function GuideModuleProgressToJSON(json: any): GuideModuleProgress;
+export declare function GuideModuleProgressToJSONTyped(value?: GuideModuleProgress | null, ignoreDiscriminator?: boolean): any;

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

@@ -1,4 +1,3 @@
-"use strict";
 /* tslint:disable */
 /* eslint-disable */
 /**
@@ -12,47 +11,54 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnboardingProfileRequestPropertyValidationAttributesMap = void 0;
-exports.instanceOfOnboardingProfileRequest = instanceOfOnboardingProfileRequest;
-exports.OnboardingProfileRequestFromJSON = OnboardingProfileRequestFromJSON;
-exports.OnboardingProfileRequestFromJSONTyped = OnboardingProfileRequestFromJSONTyped;
-exports.OnboardingProfileRequestToJSON = OnboardingProfileRequestToJSON;
-exports.OnboardingProfileRequestToJSONTyped = OnboardingProfileRequestToJSONTyped;
-exports.OnboardingProfileRequestPropertyValidationAttributesMap = {
-    jobTitle: {
-        maxLength: 120,
+import { GuideModuleStatusFromJSON, GuideModuleStatusToJSON, } from './GuideModuleStatus';
+export const GuideModuleProgressPropertyValidationAttributesMap = {
+    step: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    version: {
+        minimum: 1,
+        exclusiveMinimum: false,
     },
 };
 /**
- * Check if a given object implements the OnboardingProfileRequest interface.
+ * Check if a given object implements the GuideModuleProgress interface.
  */
-function instanceOfOnboardingProfileRequest(value) {
+export function instanceOfGuideModuleProgress(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('step' in value) || value['step'] === undefined)
+        return false;
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
     return true;
 }
-function OnboardingProfileRequestFromJSON(json) {
-    return OnboardingProfileRequestFromJSONTyped(json, false);
+export function GuideModuleProgressFromJSON(json) {
+    return GuideModuleProgressFromJSONTyped(json, false);
 }
-function OnboardingProfileRequestFromJSONTyped(json, ignoreDiscriminator) {
+export function GuideModuleProgressFromJSONTyped(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'],
+        'status': GuideModuleStatusFromJSON(json['status']),
+        'step': json['step'],
+        'version': json['version'],
+        'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
     };
 }
-function OnboardingProfileRequestToJSON(json) {
-    return OnboardingProfileRequestToJSONTyped(json, false);
+export function GuideModuleProgressToJSON(json) {
+    return GuideModuleProgressToJSONTyped(json, false);
 }
-function OnboardingProfileRequestToJSONTyped(value, ignoreDiscriminator = false) {
+export function GuideModuleProgressToJSONTyped(value, ignoreDiscriminator = false) {
     if (value == null) {
         return value;
     }
     return {
-        'first_name': value['firstName'],
-        'last_name': value['lastName'],
-        'job_title': value['jobTitle'],
+        'status': GuideModuleStatusToJSON(value['status']),
+        'step': value['step'],
+        'version': value['version'],
+        'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
     };
 }

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

@@ -0,0 +1,26 @@
+/**
+ * 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 GuideModuleStatus: {
+    readonly InProgress: 'IN_PROGRESS';
+    readonly Completed: 'COMPLETED';
+    readonly Dismissed: 'DISMISSED';
+};
+export type GuideModuleStatus = typeof GuideModuleStatus[keyof typeof GuideModuleStatus];
+export declare function instanceOfGuideModuleStatus(value: any): boolean;
+export declare function GuideModuleStatusFromJSON(json: any): GuideModuleStatus;
+export declare function GuideModuleStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): GuideModuleStatus;
+export declare function GuideModuleStatusToJSON(value?: GuideModuleStatus | null): any;
+export declare function GuideModuleStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): GuideModuleStatus;

package/dist/esm/models/GuideModuleStatus.js

@@ -0,0 +1,44 @@
+/* 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 GuideModuleStatus = {
+    InProgress: 'IN_PROGRESS',
+    Completed: 'COMPLETED',
+    Dismissed: 'DISMISSED'
+};
+export function instanceOfGuideModuleStatus(value) {
+    for (const key in GuideModuleStatus) {
+        if (Object.prototype.hasOwnProperty.call(GuideModuleStatus, key)) {
+            if (GuideModuleStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function GuideModuleStatusFromJSON(json) {
+    return GuideModuleStatusFromJSONTyped(json, false);
+}
+export function GuideModuleStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function GuideModuleStatusToJSON(value) {
+    return value;
+}
+export function GuideModuleStatusToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,126 @@
+/**
+ * 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 { GuideModuleProgress } from './GuideModuleProgress';
+/**
+ *
+ * @export
+ * @interface GuideModules
+ */
+export interface GuideModules {
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    core?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    groundedAnswers?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    knowledge?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    repeatableWork?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    access?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    administration?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    documents?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    workflowRuns?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    search?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    workflowSetup?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    skills?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    dashboard?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    groups?: GuideModuleProgress | null;
+    /**
+     *
+     * @type {GuideModuleProgress}
+     * @memberof GuideModules
+     */
+    auditLog?: GuideModuleProgress | null;
+}
+export declare const GuideModulesPropertyValidationAttributesMap: {
+    [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 GuideModules interface.
+ */
+export declare function instanceOfGuideModules(value: object): value is GuideModules;
+export declare function GuideModulesFromJSON(json: any): GuideModules;
+export declare function GuideModulesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GuideModules;
+export declare function GuideModulesToJSON(json: any): GuideModules;
+export declare function GuideModulesToJSONTyped(value?: GuideModules | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GuideModules.js

@@ -0,0 +1,69 @@
+/* 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 { GuideModuleProgressFromJSON, GuideModuleProgressToJSON, } from './GuideModuleProgress';
+export const GuideModulesPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the GuideModules interface.
+ */
+export function instanceOfGuideModules(value) {
+    return true;
+}
+export function GuideModulesFromJSON(json) {
+    return GuideModulesFromJSONTyped(json, false);
+}
+export function GuideModulesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'core': json['core'] == null ? undefined : GuideModuleProgressFromJSON(json['core']),
+        'groundedAnswers': json['grounded_answers'] == null ? undefined : GuideModuleProgressFromJSON(json['grounded_answers']),
+        'knowledge': json['knowledge'] == null ? undefined : GuideModuleProgressFromJSON(json['knowledge']),
+        'repeatableWork': json['repeatable_work'] == null ? undefined : GuideModuleProgressFromJSON(json['repeatable_work']),
+        'access': json['access'] == null ? undefined : GuideModuleProgressFromJSON(json['access']),
+        'administration': json['administration'] == null ? undefined : GuideModuleProgressFromJSON(json['administration']),
+        'documents': json['documents'] == null ? undefined : GuideModuleProgressFromJSON(json['documents']),
+        'workflowRuns': json['workflow_runs'] == null ? undefined : GuideModuleProgressFromJSON(json['workflow_runs']),
+        'search': json['search'] == null ? undefined : GuideModuleProgressFromJSON(json['search']),
+        'workflowSetup': json['workflow_setup'] == null ? undefined : GuideModuleProgressFromJSON(json['workflow_setup']),
+        'skills': json['skills'] == null ? undefined : GuideModuleProgressFromJSON(json['skills']),
+        'dashboard': json['dashboard'] == null ? undefined : GuideModuleProgressFromJSON(json['dashboard']),
+        'groups': json['groups'] == null ? undefined : GuideModuleProgressFromJSON(json['groups']),
+        'auditLog': json['audit_log'] == null ? undefined : GuideModuleProgressFromJSON(json['audit_log']),
+    };
+}
+export function GuideModulesToJSON(json) {
+    return GuideModulesToJSONTyped(json, false);
+}
+export function GuideModulesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'core': GuideModuleProgressToJSON(value['core']),
+        'grounded_answers': GuideModuleProgressToJSON(value['groundedAnswers']),
+        'knowledge': GuideModuleProgressToJSON(value['knowledge']),
+        'repeatable_work': GuideModuleProgressToJSON(value['repeatableWork']),
+        'access': GuideModuleProgressToJSON(value['access']),
+        'administration': GuideModuleProgressToJSON(value['administration']),
+        'documents': GuideModuleProgressToJSON(value['documents']),
+        'workflow_runs': GuideModuleProgressToJSON(value['workflowRuns']),
+        'search': GuideModuleProgressToJSON(value['search']),
+        'workflow_setup': GuideModuleProgressToJSON(value['workflowSetup']),
+        'skills': GuideModuleProgressToJSON(value['skills']),
+        'dashboard': GuideModuleProgressToJSON(value['dashboard']),
+        'groups': GuideModuleProgressToJSON(value['groups']),
+        'audit_log': GuideModuleProgressToJSON(value['auditLog']),
+    };
+}