@knowledge-stack/ksapi 3.11.0 → 3.12.0

package/dist/esm/models/index.js

@@ -3,8 +3,10 @@
 export * from './AcceptDisclaimerRequest';
 export * from './AcceptInviteResponse';
 export * from './AccessCheckResponse';
+export * from './AccessRequestResponse';
 export * from './ActivateSkillVersionRequest';
 export * from './AddMemberRequest';
+export * from './AddedBy';
 export * from './AncestryResponse';
 export * from './ApiAuthConfig';
 export * from './ApiConnectionRequestRequest';
@@ -158,6 +160,9 @@ export * from './GroupMemberOrder';
 export * from './GroupPermissionOrder';
 export * from './GroupPermissionResponse';
 export * from './GroupResponse';
+export * from './GuideModuleProgress';
+export * from './GuideModuleStatus';
+export * from './GuideModules';
 export * from './HTTPValidationError';
 export * from './HealthCheckResponse';
 export * from './HourHistogramResponse';
@@ -177,6 +182,9 @@ export * from './InstructionSnapshot';
 export * from './InviteLinkSettingsRequest';
 export * from './InviteLinkSettingsResponse';
 export * from './InviteOrder';
+export * from './InvitePreviewResponse';
+export * from './InvitePreviewState';
+export * from './InviteRejection';
 export * from './InviteResponse';
 export * from './InviteStatus';
 export * from './InviteUserRequest';
@@ -203,8 +211,9 @@ export * from './ModelTableRequest';
 export * from './ModelTableResult';
 export * from './NetworkClass';
 export * from './NonFilesystemReferenceType';
-export * from './OnboardingCompanyRequest';
-export * from './OnboardingProfileRequest';
+export * from './OnboardingState';
+export * from './OnboardingStateUpdate';
+export * from './OnboardingStep';
 export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat';
 export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
 export * from './PaginatedResponseBillingPaymentResponse';
@@ -288,6 +297,7 @@ export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';
 export * from './SheetVisibilityChange';
 export * from './SignInRequest';
+export * from './SignUpResponse';
 export * from './SkillFile';
 export * from './SkillOrder';
 export * from './SkillResponse';
@@ -321,6 +331,7 @@ export * from './TenantSettingsResponse';
 export * from './TenantSettingsUpdate';
 export * from './TenantSubscriptionResponse';
 export * from './TenantUserEditRequest';
+export * from './TenantUserJoinMethod';
 export * from './TenantUserOrder';
 export * from './TenantUserResponse';
 export * from './TenantUserRole';

package/dist/models/{OnboardingProfileRequest.d.ts → AccessRequestResponse.d.ts}

@@ -10,31 +10,19 @@
  * Do not edit the class manually.
  */
 /**
- * Step 2 of onboarding — per-user info for the current tenant.
+ *
  * @export
- * @interface OnboardingProfileRequest
+ * @interface AccessRequestResponse
  */
-export interface OnboardingProfileRequest {
-    /**
-     * User's first name
-     * @type {string}
-     * @memberof OnboardingProfileRequest
-     */
-    firstName?: string | null;
-    /**
-     * User's last name
-     * @type {string}
-     * @memberof OnboardingProfileRequest
-     */
-    lastName?: string | null;
+export interface AccessRequestResponse {
     /**
-     * What the user does at this tenant
-     * @type {string}
-     * @memberof OnboardingProfileRequest
+     * When this member's request was recorded. A repeat inside the daily window returns the original request and sends no second email.
+     * @type {Date}
+     * @memberof AccessRequestResponse
      */
-    jobTitle?: string | null;
+    requestedAt: Date;
 }
-export declare const OnboardingProfileRequestPropertyValidationAttributesMap: {
+export declare const AccessRequestResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number;
         minLength?: number;
@@ -50,10 +38,10 @@ export declare const OnboardingProfileRequestPropertyValidationAttributesMap: {
     };
 };
 /**
- * Check if a given object implements the OnboardingProfileRequest interface.
+ * Check if a given object implements the AccessRequestResponse interface.
  */
-export declare function instanceOfOnboardingProfileRequest(value: object): value is OnboardingProfileRequest;
-export declare function OnboardingProfileRequestFromJSON(json: any): OnboardingProfileRequest;
-export declare function OnboardingProfileRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingProfileRequest;
-export declare function OnboardingProfileRequestToJSON(json: any): OnboardingProfileRequest;
-export declare function OnboardingProfileRequestToJSONTyped(value?: OnboardingProfileRequest | null, ignoreDiscriminator?: boolean): any;
+export declare function instanceOfAccessRequestResponse(value: object): value is AccessRequestResponse;
+export declare function AccessRequestResponseFromJSON(json: any): AccessRequestResponse;
+export declare function AccessRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccessRequestResponse;
+export declare function AccessRequestResponseToJSON(json: any): AccessRequestResponse;
+export declare function AccessRequestResponseToJSONTyped(value?: AccessRequestResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/{OnboardingCompanyRequest.js → AccessRequestResponse.js}

@@ -13,47 +13,40 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnboardingCompanyRequestPropertyValidationAttributesMap = void 0;
-exports.instanceOfOnboardingCompanyRequest = instanceOfOnboardingCompanyRequest;
-exports.OnboardingCompanyRequestFromJSON = OnboardingCompanyRequestFromJSON;
-exports.OnboardingCompanyRequestFromJSONTyped = OnboardingCompanyRequestFromJSONTyped;
-exports.OnboardingCompanyRequestToJSON = OnboardingCompanyRequestToJSON;
-exports.OnboardingCompanyRequestToJSONTyped = OnboardingCompanyRequestToJSONTyped;
-exports.OnboardingCompanyRequestPropertyValidationAttributesMap = {
-    description: {
-        maxLength: 5000,
-    },
-    industry: {
-        maxLength: 120,
-    },
-};
+exports.AccessRequestResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfAccessRequestResponse = instanceOfAccessRequestResponse;
+exports.AccessRequestResponseFromJSON = AccessRequestResponseFromJSON;
+exports.AccessRequestResponseFromJSONTyped = AccessRequestResponseFromJSONTyped;
+exports.AccessRequestResponseToJSON = AccessRequestResponseToJSON;
+exports.AccessRequestResponseToJSONTyped = AccessRequestResponseToJSONTyped;
+exports.AccessRequestResponsePropertyValidationAttributesMap = {};
 /**
- * Check if a given object implements the OnboardingCompanyRequest interface.
+ * Check if a given object implements the AccessRequestResponse interface.
  */
-function instanceOfOnboardingCompanyRequest(value) {
+function instanceOfAccessRequestResponse(value) {
+    if (!('requestedAt' in value) || value['requestedAt'] === undefined)
+        return false;
     return true;
 }
-function OnboardingCompanyRequestFromJSON(json) {
-    return OnboardingCompanyRequestFromJSONTyped(json, false);
+function AccessRequestResponseFromJSON(json) {
+    return AccessRequestResponseFromJSONTyped(json, false);
 }
-function OnboardingCompanyRequestFromJSONTyped(json, ignoreDiscriminator) {
+function AccessRequestResponseFromJSONTyped(json, ignoreDiscriminator) {
     if (json == null) {
         return json;
     }
     return {
-        'description': json['description'] == null ? undefined : json['description'],
-        'industry': json['industry'] == null ? undefined : json['industry'],
+        'requestedAt': (new Date(json['requested_at'])),
     };
 }
-function OnboardingCompanyRequestToJSON(json) {
-    return OnboardingCompanyRequestToJSONTyped(json, false);
+function AccessRequestResponseToJSON(json) {
+    return AccessRequestResponseToJSONTyped(json, false);
 }
-function OnboardingCompanyRequestToJSONTyped(value, ignoreDiscriminator = false) {
+function AccessRequestResponseToJSONTyped(value, ignoreDiscriminator = false) {
     if (value == null) {
         return value;
     }
     return {
-        'description': value['description'],
-        'industry': value['industry'],
+        'requested_at': value['requestedAt'].toISOString(),
     };
 }

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

@@ -0,0 +1,51 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AddedBy = void 0;
+exports.instanceOfAddedBy = instanceOfAddedBy;
+exports.AddedByFromJSON = AddedByFromJSON;
+exports.AddedByFromJSONTyped = AddedByFromJSONTyped;
+exports.AddedByToJSON = AddedByToJSON;
+exports.AddedByToJSONTyped = AddedByToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.AddedBy = {
+    DirectorySync: 'directory_sync',
+    Operator: 'operator'
+};
+function instanceOfAddedBy(value) {
+    for (const key in exports.AddedBy) {
+        if (Object.prototype.hasOwnProperty.call(exports.AddedBy, key)) {
+            if (exports.AddedBy[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function AddedByFromJSON(json) {
+    return AddedByFromJSONTyped(json, false);
+}
+function AddedByFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function AddedByToJSON(value) {
+    return value;
+}
+function AddedByToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -46,6 +46,7 @@ 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'],
     };
 }
 function CreatePasswordUserRequestToJSON(json) {
@@ -60,5 +61,6 @@ function CreatePasswordUserRequestToJSONTyped(value, ignoreDiscriminator = false
         'email_token': value['emailToken'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
+        'invite_id': value['inviteId'],
     };
 }

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

@@ -28,8 +28,10 @@ exports.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/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/models/FeaturesResponse.js

@@ -21,6 +21,7 @@ exports.FeaturesResponseToJSON = FeaturesResponseToJSON;
 exports.FeaturesResponseToJSONTyped = FeaturesResponseToJSONTyped;
 const SupportedLanguage_1 = require("./SupportedLanguage");
 const UploadConstraints_1 = require("./UploadConstraints");
+const DataSourceEngine_1 = require("./DataSourceEngine");
 exports.FeaturesResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the FeaturesResponse interface.
@@ -38,6 +39,8 @@ 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;
 }
 function FeaturesResponseFromJSON(json) {
@@ -54,6 +57,7 @@ function FeaturesResponseFromJSONTyped(json, ignoreDiscriminator) {
         'smsLoginEnabled': json['sms_login_enabled'],
         'defaultFrontendLanguage': (0, SupportedLanguage_1.SupportedLanguageFromJSON)(json['default_frontend_language']),
         'upload': (0, UploadConstraints_1.UploadConstraintsFromJSON)(json['upload']),
+        'dataSourceEngines': (json['data_source_engines'].map(DataSourceEngine_1.DataSourceEngineFromJSON)),
     };
 }
 function FeaturesResponseToJSON(json) {
@@ -70,5 +74,6 @@ function FeaturesResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'sms_login_enabled': value['smsLoginEnabled'],
         'default_frontend_language': (0, SupportedLanguage_1.SupportedLanguageToJSON)(value['defaultFrontendLanguage']),
         'upload': (0, UploadConstraints_1.UploadConstraintsToJSON)(value['upload']),
+        'data_source_engines': (value['dataSourceEngines'].map(DataSourceEngine_1.DataSourceEngineToJSON)),
     };
 }

package/dist/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/GuideModuleProgress.js

@@ -0,0 +1,72 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GuideModuleProgressPropertyValidationAttributesMap = void 0;
+exports.instanceOfGuideModuleProgress = instanceOfGuideModuleProgress;
+exports.GuideModuleProgressFromJSON = GuideModuleProgressFromJSON;
+exports.GuideModuleProgressFromJSONTyped = GuideModuleProgressFromJSONTyped;
+exports.GuideModuleProgressToJSON = GuideModuleProgressToJSON;
+exports.GuideModuleProgressToJSONTyped = GuideModuleProgressToJSONTyped;
+const GuideModuleStatus_1 = require("./GuideModuleStatus");
+exports.GuideModuleProgressPropertyValidationAttributesMap = {
+    step: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    version: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+};
+/**
+ * Check if a given object implements the GuideModuleProgress interface.
+ */
+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 GuideModuleProgressFromJSON(json) {
+    return GuideModuleProgressFromJSONTyped(json, false);
+}
+function GuideModuleProgressFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': (0, GuideModuleStatus_1.GuideModuleStatusFromJSON)(json['status']),
+        'step': json['step'],
+        'version': json['version'],
+        'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
+    };
+}
+function GuideModuleProgressToJSON(json) {
+    return GuideModuleProgressToJSONTyped(json, false);
+}
+function GuideModuleProgressToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': (0, GuideModuleStatus_1.GuideModuleStatusToJSON)(value['status']),
+        'step': value['step'],
+        'version': value['version'],
+        'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,52 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GuideModuleStatus = void 0;
+exports.instanceOfGuideModuleStatus = instanceOfGuideModuleStatus;
+exports.GuideModuleStatusFromJSON = GuideModuleStatusFromJSON;
+exports.GuideModuleStatusFromJSONTyped = GuideModuleStatusFromJSONTyped;
+exports.GuideModuleStatusToJSON = GuideModuleStatusToJSON;
+exports.GuideModuleStatusToJSONTyped = GuideModuleStatusToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.GuideModuleStatus = {
+    InProgress: 'IN_PROGRESS',
+    Completed: 'COMPLETED',
+    Dismissed: 'DISMISSED'
+};
+function instanceOfGuideModuleStatus(value) {
+    for (const key in exports.GuideModuleStatus) {
+        if (Object.prototype.hasOwnProperty.call(exports.GuideModuleStatus, key)) {
+            if (exports.GuideModuleStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function GuideModuleStatusFromJSON(json) {
+    return GuideModuleStatusFromJSONTyped(json, false);
+}
+function GuideModuleStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function GuideModuleStatusToJSON(value) {
+    return value;
+}
+function GuideModuleStatusToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}