@knowledge-stack/ksapi 3.10.2 → 3.12.0

package/dist/esm/models/OnboardingStep.js

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

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

@@ -0,0 +1,107 @@
+/* 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 { TenantUserJoinMethodFromJSON, TenantUserJoinMethodToJSON, } from './TenantUserJoinMethod';
+import { IdpTypeFromJSON, IdpTypeToJSON, } from './IdpType';
+import { InviteRejectionFromJSON, InviteRejectionToJSON, } from './InviteRejection';
+import { TenantUserRoleFromJSON, TenantUserRoleToJSON, } from './TenantUserRole';
+import { OnboardingStateFromJSON, OnboardingStateToJSON, } from './OnboardingState';
+import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
+import { AddedByFromJSON, AddedByToJSON, } from './AddedBy';
+export const SignUpResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the SignUpResponse interface.
+ */
+export 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;
+}
+export function SignUpResponseFromJSON(json) {
+    return SignUpResponseFromJSONTyped(json, false);
+}
+export 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': IdpTypeFromJSON(json['idp_type']),
+        'currentTenantId': json['current_tenant_id'],
+        'currentTenantRole': 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': TenantUserJoinMethodFromJSON(json['join_method']),
+        'onboardingState': json['onboarding_state'] == null ? undefined : OnboardingStateFromJSON(json['onboarding_state']),
+        'invitedBy': json['invited_by'] == null ? undefined : UserInfoFromJSON(json['invited_by']),
+        'addedBy': json['added_by'] == null ? undefined : 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 : InviteRejectionFromJSON(json['invite_rejection']),
+    };
+}
+export function SignUpResponseToJSON(json) {
+    return SignUpResponseToJSONTyped(json, false);
+}
+export 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': IdpTypeToJSON(value['idpType']),
+        'current_tenant_id': value['currentTenantId'],
+        'current_tenant_role': 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': TenantUserJoinMethodToJSON(value['joinMethod']),
+        'onboarding_state': OnboardingStateToJSON(value['onboardingState']),
+        'invited_by': UserInfoToJSON(value['invitedBy']),
+        'added_by': AddedByToJSON(value['addedBy']),
+        'idp_managed_fields': value['idpManagedFields'],
+        'onboarding_enabled': value['onboardingEnabled'],
+        'invite_rejection': InviteRejectionToJSON(value['inviteRejection']),
+    };
+}

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

@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { TenantBrandingResponseFromJSON, TenantBrandingResponseToJSON, } from './TenantBrandingResponse';
+import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
 import { TenantSettingsResponseFromJSON, TenantSettingsResponseToJSON, } from './TenantSettingsResponse';
 export const TenantResponsePropertyValidationAttributesMap = {
     seats: {
@@ -27,6 +28,8 @@ export 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)
@@ -45,6 +48,7 @@ export function TenantResponseFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
+        'owner': UserInfoFromJSON(json['owner']),
         'idpConfig': json['idp_config'] == null ? undefined : json['idp_config'],
         'settings': TenantSettingsResponseFromJSON(json['settings']),
         'branding': json['branding'] == null ? undefined : TenantBrandingResponseFromJSON(json['branding']),
@@ -62,6 +66,7 @@ export function TenantResponseToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'owner': UserInfoToJSON(value['owner']),
         'idp_config': value['idpConfig'],
         'settings': TenantSettingsResponseToJSON(value['settings']),
         'branding': TenantBrandingResponseToJSON(value['branding']),

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

package/dist/esm/models/TenantUserJoinMethod.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 TenantUserJoinMethod = {
+    Creator: 'CREATOR',
+    Invited: 'INVITED',
+    Added: 'ADDED'
+};
+export function instanceOfTenantUserJoinMethod(value) {
+    for (const key in TenantUserJoinMethod) {
+        if (Object.prototype.hasOwnProperty.call(TenantUserJoinMethod, key)) {
+            if (TenantUserJoinMethod[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function TenantUserJoinMethodFromJSON(json) {
+    return TenantUserJoinMethodFromJSONTyped(json, false);
+}
+export function TenantUserJoinMethodFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function TenantUserJoinMethodToJSON(value) {
+    return value;
+}
+export function TenantUserJoinMethodToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -9,8 +9,12 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { TenantUserJoinMethod } from './TenantUserJoinMethod';
 import type { IdpType } from './IdpType';
 import type { TenantUserRole } from './TenantUserRole';
+import type { OnboardingState } from './OnboardingState';
+import type { UserInfo } from './UserInfo';
+import type { AddedBy } from './AddedBy';
 /**
  *
  * @export
@@ -101,6 +105,42 @@ export interface UserResponse {
      * @memberof UserResponse
      */
     onboardingCompletedAt?: Date | null;
+    /**
+     *
+     * @type {TenantUserJoinMethod}
+     * @memberof UserResponse
+     */
+    joinMethod: TenantUserJoinMethod;
+    /**
+     * Resume step and guide progress for the current membership.
+     * @type {OnboardingState}
+     * @memberof UserResponse
+     */
+    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 UserResponse
+     */
+    invitedBy?: UserInfo | null;
+    /**
+     *
+     * @type {AddedBy}
+     * @memberof UserResponse
+     */
+    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 UserResponse
+     */
+    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 UserResponse
+     */
+    onboardingEnabled?: boolean | null;
 }
 export declare const UserResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/esm/models/UserResponse.js

@@ -11,8 +11,12 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { TenantUserJoinMethodFromJSON, TenantUserJoinMethodToJSON, } from './TenantUserJoinMethod';
 import { IdpTypeFromJSON, IdpTypeToJSON, } from './IdpType';
 import { TenantUserRoleFromJSON, TenantUserRoleToJSON, } from './TenantUserRole';
+import { OnboardingStateFromJSON, OnboardingStateToJSON, } from './OnboardingState';
+import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
+import { AddedByFromJSON, AddedByToJSON, } from './AddedBy';
 export const UserResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the UserResponse interface.
@@ -34,6 +38,8 @@ export function instanceOfUserResponse(value) {
         return false;
     if (!('defaultTenantId' in value) || value['defaultTenantId'] === undefined)
         return false;
+    if (!('joinMethod' in value) || value['joinMethod'] === undefined)
+        return false;
     return true;
 }
 export function UserResponseFromJSON(json) {
@@ -58,6 +64,12 @@ export function UserResponseFromJSONTyped(json, ignoreDiscriminator) {
         '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': TenantUserJoinMethodFromJSON(json['join_method']),
+        'onboardingState': json['onboarding_state'] == null ? undefined : OnboardingStateFromJSON(json['onboarding_state']),
+        'invitedBy': json['invited_by'] == null ? undefined : UserInfoFromJSON(json['invited_by']),
+        'addedBy': json['added_by'] == null ? undefined : AddedByFromJSON(json['added_by']),
+        'idpManagedFields': json['idp_managed_fields'] == null ? undefined : json['idp_managed_fields'],
+        'onboardingEnabled': json['onboarding_enabled'] == null ? undefined : json['onboarding_enabled'],
     };
 }
 export function UserResponseToJSON(json) {
@@ -82,5 +94,11 @@ export function UserResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'bio': value['bio'],
         'avatar_url': value['avatarUrl'],
         'onboarding_completed_at': value['onboardingCompletedAt'] == null ? value['onboardingCompletedAt'] : value['onboardingCompletedAt'].toISOString(),
+        'join_method': TenantUserJoinMethodToJSON(value['joinMethod']),
+        'onboarding_state': OnboardingStateToJSON(value['onboardingState']),
+        'invited_by': UserInfoToJSON(value['invitedBy']),
+        'added_by': AddedByToJSON(value['addedBy']),
+        'idp_managed_fields': value['idpManagedFields'],
+        'onboarding_enabled': value['onboardingEnabled'],
     };
 }

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

@@ -1,8 +1,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';
@@ -156,6 +158,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';
@@ -175,6 +180,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';
@@ -201,8 +209,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';
@@ -286,6 +295,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';
@@ -319,6 +329,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';