@knowledge-stack/ksapi 3.11.0 → 3.12.0

package/dist/models/OnboardingState.js

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

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

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

package/dist/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;

package/dist/models/OnboardingStep.js

@@ -0,0 +1,53 @@
+"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.OnboardingStep = void 0;
+exports.instanceOfOnboardingStep = instanceOfOnboardingStep;
+exports.OnboardingStepFromJSON = OnboardingStepFromJSON;
+exports.OnboardingStepFromJSONTyped = OnboardingStepFromJSONTyped;
+exports.OnboardingStepToJSON = OnboardingStepToJSON;
+exports.OnboardingStepToJSONTyped = OnboardingStepToJSONTyped;
+/**
+ *
+ * @export
+ */
+exports.OnboardingStep = {
+    Workspace: 'WORKSPACE',
+    Knowledge: 'KNOWLEDGE',
+    Team: 'TEAM',
+    Destination: 'DESTINATION'
+};
+function instanceOfOnboardingStep(value) {
+    for (const key in exports.OnboardingStep) {
+        if (Object.prototype.hasOwnProperty.call(exports.OnboardingStep, key)) {
+            if (exports.OnboardingStep[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function OnboardingStepFromJSON(json) {
+    return OnboardingStepFromJSONTyped(json, false);
+}
+function OnboardingStepFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function OnboardingStepToJSON(value) {
+    return value;
+}
+function OnboardingStepToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/SignUpResponse.d.ts

@@ -0,0 +1,174 @@
+/**
+ * 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 { TenantUserJoinMethod } from './TenantUserJoinMethod';
+import type { IdpType } from './IdpType';
+import type { InviteRejection } from './InviteRejection';
+import type { TenantUserRole } from './TenantUserRole';
+import type { OnboardingState } from './OnboardingState';
+import type { UserInfo } from './UserInfo';
+import type { AddedBy } from './AddedBy';
+/**
+ *
+ * @export
+ * @interface SignUpResponse
+ */
+export interface SignUpResponse {
+    /**
+     * User ID
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    id: string;
+    /**
+     * Email address of the user
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    email: string | null;
+    /**
+     * Subscriber number as a string of digits (no country code). Returned as a string to avoid JS Number precision issues.
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    phoneNumber?: string | null;
+    /**
+     * First name of the user
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    firstName: string | null;
+    /**
+     * Last name of the user
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    lastName: string | null;
+    /**
+     *
+     * @type {IdpType}
+     * @memberof SignUpResponse
+     */
+    idpType: IdpType;
+    /**
+     * Current tenant ID the user is logged into
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    currentTenantId: string;
+    /**
+     *
+     * @type {TenantUserRole}
+     * @memberof SignUpResponse
+     */
+    currentTenantRole: TenantUserRole;
+    /**
+     * Default tenant ID the user shall be logged into
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    defaultTenantId: string;
+    /**
+     * User's job title at the current tenant (per-membership)
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    jobTitle?: string | null;
+    /**
+     * User's department at the current tenant (per-membership)
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    department?: string | null;
+    /**
+     * What the user wrote about themselves at the current tenant. The chat agent reads it on every turn.
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    bio?: string | null;
+    /**
+     * Presigned URL of the user's profile photo at the current tenant. Expires after six hours; read GET /v1/users/me again for a fresh one.
+     * @type {string}
+     * @memberof SignUpResponse
+     */
+    avatarUrl?: string | null;
+    /**
+     * When the user finished onboarding for the current tenant. NULL = wizard should be shown.
+     * @type {Date}
+     * @memberof SignUpResponse
+     */
+    onboardingCompletedAt?: Date | null;
+    /**
+     *
+     * @type {TenantUserJoinMethod}
+     * @memberof SignUpResponse
+     */
+    joinMethod: TenantUserJoinMethod;
+    /**
+     * Resume step and guide progress for the current membership.
+     * @type {OnboardingState}
+     * @memberof SignUpResponse
+     */
+    onboardingState?: OnboardingState | null;
+    /**
+     * Who sent the accepted invite that created the current membership. NULL when the membership did not come from an email invite, and on the sign-in and sign-up responses; read it from GET /v1/users/me.
+     * @type {UserInfo}
+     * @memberof SignUpResponse
+     */
+    invitedBy?: UserInfo | null;
+    /**
+     *
+     * @type {AddedBy}
+     * @memberof SignUpResponse
+     */
+    addedBy?: AddedBy;
+    /**
+     * Profile fields the identity provider overwrites on every sync, so clients render them read-only. Empty unless directory-managed.
+     * @type {Array<string>}
+     * @memberof SignUpResponse
+     */
+    idpManagedFields?: Array<string>;
+    /**
+     * The current tenant's onboarding switch: true forces the flow on, false hides it, NULL follows the deployment default.
+     * @type {boolean}
+     * @memberof SignUpResponse
+     */
+    onboardingEnabled?: boolean | null;
+    /**
+     *
+     * @type {InviteRejection}
+     * @memberof SignUpResponse
+     */
+    inviteRejection?: InviteRejection;
+}
+export declare const SignUpResponsePropertyValidationAttributesMap: {
+    [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 SignUpResponse interface.
+ */
+export declare function instanceOfSignUpResponse(value: object): value is SignUpResponse;
+export declare function SignUpResponseFromJSON(json: any): SignUpResponse;
+export declare function SignUpResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SignUpResponse;
+export declare function SignUpResponseToJSON(json: any): SignUpResponse;
+export declare function SignUpResponseToJSONTyped(value?: SignUpResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/SignUpResponse.js

@@ -0,0 +1,115 @@
+"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.SignUpResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfSignUpResponse = instanceOfSignUpResponse;
+exports.SignUpResponseFromJSON = SignUpResponseFromJSON;
+exports.SignUpResponseFromJSONTyped = SignUpResponseFromJSONTyped;
+exports.SignUpResponseToJSON = SignUpResponseToJSON;
+exports.SignUpResponseToJSONTyped = SignUpResponseToJSONTyped;
+const TenantUserJoinMethod_1 = require("./TenantUserJoinMethod");
+const IdpType_1 = require("./IdpType");
+const InviteRejection_1 = require("./InviteRejection");
+const TenantUserRole_1 = require("./TenantUserRole");
+const OnboardingState_1 = require("./OnboardingState");
+const UserInfo_1 = require("./UserInfo");
+const AddedBy_1 = require("./AddedBy");
+exports.SignUpResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the SignUpResponse interface.
+ */
+function instanceOfSignUpResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('idpType' in value) || value['idpType'] === undefined)
+        return false;
+    if (!('currentTenantId' in value) || value['currentTenantId'] === undefined)
+        return false;
+    if (!('currentTenantRole' in value) || value['currentTenantRole'] === undefined)
+        return false;
+    if (!('defaultTenantId' in value) || value['defaultTenantId'] === undefined)
+        return false;
+    if (!('joinMethod' in value) || value['joinMethod'] === undefined)
+        return false;
+    return true;
+}
+function SignUpResponseFromJSON(json) {
+    return SignUpResponseFromJSONTyped(json, false);
+}
+function SignUpResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'email': json['email'],
+        'phoneNumber': json['phone_number'] == null ? undefined : json['phone_number'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'idpType': (0, IdpType_1.IdpTypeFromJSON)(json['idp_type']),
+        'currentTenantId': json['current_tenant_id'],
+        'currentTenantRole': (0, TenantUserRole_1.TenantUserRoleFromJSON)(json['current_tenant_role']),
+        'defaultTenantId': json['default_tenant_id'],
+        'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
+        'department': json['department'] == null ? undefined : json['department'],
+        'bio': json['bio'] == null ? undefined : json['bio'],
+        'avatarUrl': json['avatar_url'] == null ? undefined : json['avatar_url'],
+        'onboardingCompletedAt': json['onboarding_completed_at'] == null ? undefined : (new Date(json['onboarding_completed_at'])),
+        'joinMethod': (0, TenantUserJoinMethod_1.TenantUserJoinMethodFromJSON)(json['join_method']),
+        'onboardingState': json['onboarding_state'] == null ? undefined : (0, OnboardingState_1.OnboardingStateFromJSON)(json['onboarding_state']),
+        'invitedBy': json['invited_by'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['invited_by']),
+        'addedBy': json['added_by'] == null ? undefined : (0, AddedBy_1.AddedByFromJSON)(json['added_by']),
+        'idpManagedFields': json['idp_managed_fields'] == null ? undefined : json['idp_managed_fields'],
+        'onboardingEnabled': json['onboarding_enabled'] == null ? undefined : json['onboarding_enabled'],
+        'inviteRejection': json['invite_rejection'] == null ? undefined : (0, InviteRejection_1.InviteRejectionFromJSON)(json['invite_rejection']),
+    };
+}
+function SignUpResponseToJSON(json) {
+    return SignUpResponseToJSONTyped(json, false);
+}
+function SignUpResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'email': value['email'],
+        'phone_number': value['phoneNumber'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'idp_type': (0, IdpType_1.IdpTypeToJSON)(value['idpType']),
+        'current_tenant_id': value['currentTenantId'],
+        'current_tenant_role': (0, TenantUserRole_1.TenantUserRoleToJSON)(value['currentTenantRole']),
+        'default_tenant_id': value['defaultTenantId'],
+        'job_title': value['jobTitle'],
+        'department': value['department'],
+        'bio': value['bio'],
+        'avatar_url': value['avatarUrl'],
+        'onboarding_completed_at': value['onboardingCompletedAt'] == null ? value['onboardingCompletedAt'] : value['onboardingCompletedAt'].toISOString(),
+        'join_method': (0, TenantUserJoinMethod_1.TenantUserJoinMethodToJSON)(value['joinMethod']),
+        'onboarding_state': (0, OnboardingState_1.OnboardingStateToJSON)(value['onboardingState']),
+        'invited_by': (0, UserInfo_1.UserInfoToJSON)(value['invitedBy']),
+        'added_by': (0, AddedBy_1.AddedByToJSON)(value['addedBy']),
+        'idp_managed_fields': value['idpManagedFields'],
+        'onboarding_enabled': value['onboardingEnabled'],
+        'invite_rejection': (0, InviteRejection_1.InviteRejectionToJSON)(value['inviteRejection']),
+    };
+}

package/dist/models/TenantResponse.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { TenantBrandingResponse } from './TenantBrandingResponse';
+import type { UserInfo } from './UserInfo';
 import type { TenantSettingsResponse } from './TenantSettingsResponse';
 /**
  * Tenant response model.
@@ -29,6 +30,12 @@ export interface TenantResponse {
      * @memberof TenantResponse
      */
     name: string;
+    /**
+     * The tenant OWNER's name, so a member knows who can grant access. Null only when the tenant has no OWNER membership.
+     * @type {UserInfo}
+     * @memberof TenantResponse
+     */
+    owner: UserInfo | null;
     /**
      * External IdP configuration
      * @type {{ [key: string]: any; }}

package/dist/models/TenantResponse.js

@@ -20,6 +20,7 @@ exports.TenantResponseFromJSONTyped = TenantResponseFromJSONTyped;
 exports.TenantResponseToJSON = TenantResponseToJSON;
 exports.TenantResponseToJSONTyped = TenantResponseToJSONTyped;
 const TenantBrandingResponse_1 = require("./TenantBrandingResponse");
+const UserInfo_1 = require("./UserInfo");
 const TenantSettingsResponse_1 = require("./TenantSettingsResponse");
 exports.TenantResponsePropertyValidationAttributesMap = {
     seats: {
@@ -35,6 +36,8 @@ function instanceOfTenantResponse(value) {
         return false;
     if (!('name' in value) || value['name'] === undefined)
         return false;
+    if (!('owner' in value) || value['owner'] === undefined)
+        return false;
     if (!('settings' in value) || value['settings'] === undefined)
         return false;
     if (!('seats' in value) || value['seats'] === undefined)
@@ -53,6 +56,7 @@ function TenantResponseFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
+        'owner': (0, UserInfo_1.UserInfoFromJSON)(json['owner']),
         'idpConfig': json['idp_config'] == null ? undefined : json['idp_config'],
         'settings': (0, TenantSettingsResponse_1.TenantSettingsResponseFromJSON)(json['settings']),
         'branding': json['branding'] == null ? undefined : (0, TenantBrandingResponse_1.TenantBrandingResponseFromJSON)(json['branding']),
@@ -70,6 +74,7 @@ function TenantResponseToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'owner': (0, UserInfo_1.UserInfoToJSON)(value['owner']),
         'idp_config': value['idpConfig'],
         'settings': (0, TenantSettingsResponse_1.TenantSettingsResponseToJSON)(value['settings']),
         'branding': (0, TenantBrandingResponse_1.TenantBrandingResponseToJSON)(value['branding']),

package/dist/models/TenantUserJoinMethod.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 TenantUserJoinMethod: {
+    readonly Creator: 'CREATOR';
+    readonly Invited: 'INVITED';
+    readonly Added: 'ADDED';
+};
+export type TenantUserJoinMethod = typeof TenantUserJoinMethod[keyof typeof TenantUserJoinMethod];
+export declare function instanceOfTenantUserJoinMethod(value: any): boolean;
+export declare function TenantUserJoinMethodFromJSON(json: any): TenantUserJoinMethod;
+export declare function TenantUserJoinMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantUserJoinMethod;
+export declare function TenantUserJoinMethodToJSON(value?: TenantUserJoinMethod | null): any;
+export declare function TenantUserJoinMethodToJSONTyped(value: any, ignoreDiscriminator: boolean): TenantUserJoinMethod;