@knowledge-stack/ksapi 3.11.0 → 3.12.0

package/src/apis/UsersApi.ts

@@ -15,22 +15,22 @@
 
 import * as runtime from '../runtime';
 import type {
+  AccessRequestResponse,
   ErrorResponse,
   HTTPValidationError,
-  OnboardingCompanyRequest,
-  OnboardingProfileRequest,
+  OnboardingStateUpdate,
   UpdateUserRequest,
   UserResponse,
 } from '../models/index';
 import {
+    AccessRequestResponseFromJSON,
+    AccessRequestResponseToJSON,
     ErrorResponseFromJSON,
     ErrorResponseToJSON,
     HTTPValidationErrorFromJSON,
     HTTPValidationErrorToJSON,
-    OnboardingCompanyRequestFromJSON,
-    OnboardingCompanyRequestToJSON,
-    OnboardingProfileRequestFromJSON,
-    OnboardingProfileRequestToJSON,
+    OnboardingStateUpdateFromJSON,
+    OnboardingStateUpdateToJSON,
     UpdateUserRequestFromJSON,
     UpdateUserRequestToJSON,
     UserResponseFromJSON,
@@ -41,12 +41,8 @@ export interface UpdateMeRequest {
     updateUserRequest: UpdateUserRequest;
 }
 
-export interface UpdateOnboardingCompanyRequest {
-    onboardingCompanyRequest: OnboardingCompanyRequest;
-}
-
-export interface UpdateOnboardingProfileRequest {
-    onboardingProfileRequest: OnboardingProfileRequest;
+export interface UpdateOnboardingStateRequest {
+    onboardingStateUpdate: OnboardingStateUpdate;
 }
 
 export interface UploadMyAvatarRequest {
@@ -104,6 +100,28 @@ export interface UsersApiInterface {
      */
     getMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
 
+    /**
+     * Creates request options for requestAccess without sending the request
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    requestAccessRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Email the owner and admins for access; one request per member per day.
+     * @summary Request Access Handler
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    requestAccessRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessRequestResponse>>;
+
+    /**
+     * Email the owner and admins for access; one request per member per day.
+     * Request Access Handler
+     */
+    requestAccess(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessRequestResponse>;
+
     /**
      * Creates request options for skipOnboarding without sending the request
      * @throws {RequiredError}
@@ -151,52 +169,27 @@ export interface UsersApiInterface {
     updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
 
     /**
-     * Creates request options for updateOnboardingCompany without sending the request
-     * @param {OnboardingCompanyRequest} onboardingCompanyRequest 
-     * @throws {RequiredError}
-     * @memberof UsersApiInterface
-     */
-    updateOnboardingCompanyRequestOpts(requestParameters: UpdateOnboardingCompanyRequest): Promise<runtime.RequestOpts>;
-
-    /**
-     * Step 1 of onboarding: tenant-wide company info.  Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead.  Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
-     * @summary Update Onboarding Company Handler
-     * @param {OnboardingCompanyRequest} onboardingCompanyRequest 
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof UsersApiInterface
-     */
-    updateOnboardingCompanyRaw(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
-
-    /**
-     * Step 1 of onboarding: tenant-wide company info.  Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead.  Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
-     * Update Onboarding Company Handler
-     */
-    updateOnboardingCompany(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
-
-    /**
-     * Creates request options for updateOnboardingProfile without sending the request
-     * @param {OnboardingProfileRequest} onboardingProfileRequest 
+     * Creates request options for updateOnboardingState without sending the request
+     * @param {OnboardingStateUpdate} onboardingStateUpdate 
      * @throws {RequiredError}
      * @memberof UsersApiInterface
      */
-    updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
+    updateOnboardingStateRequestOpts(requestParameters: UpdateOnboardingStateRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Step 2 (final) of onboarding: per-user profile for the current tenant.  Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
-     * @summary Update Onboarding Profile Handler
-     * @param {OnboardingProfileRequest} onboardingProfileRequest 
+     * 
+     * @summary Update Onboarding State Handler
+     * @param {OnboardingStateUpdate} onboardingStateUpdate 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UsersApiInterface
      */
-    updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
+    updateOnboardingStateRaw(requestParameters: UpdateOnboardingStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
 
     /**
-     * Step 2 (final) of onboarding: per-user profile for the current tenant.  Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
-     * Update Onboarding Profile Handler
+     * Update Onboarding State Handler
      */
-    updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
+    updateOnboardingState(requestParameters: UpdateOnboardingStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
 
     /**
      * Creates request options for uploadMyAvatar without sending the request
@@ -324,9 +317,9 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
     }
 
     /**
-     * Creates request options for skipOnboarding without sending the request
+     * Creates request options for requestAccess without sending the request
      */
-    async skipOnboardingRequestOpts(): Promise<runtime.RequestOpts> {
+    async requestAccessRequestOpts(): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -340,7 +333,7 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
             }
         }
 
-        let urlPath = `/v1/users/me/onboarding/skip`;
+        let urlPath = `/v1/users/me/access_requests`;
 
         return {
             path: urlPath,
@@ -351,42 +344,33 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
     }
 
     /**
-     * Mark onboarding complete without writing any profile/company fields.  Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
-     * Skip Onboarding Handler
+     * Email the owner and admins for access; one request per member per day.
+     * Request Access Handler
      */
-    async skipOnboardingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
-        const requestOptions = await this.skipOnboardingRequestOpts();
+    async requestAccessRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessRequestResponse>> {
+        const requestOptions = await this.requestAccessRequestOpts();
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccessRequestResponseFromJSON(jsonValue));
     }
 
     /**
-     * Mark onboarding complete without writing any profile/company fields.  Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
-     * Skip Onboarding Handler
+     * Email the owner and admins for access; one request per member per day.
+     * Request Access Handler
      */
-    async skipOnboarding(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
-        const response = await this.skipOnboardingRaw(initOverrides);
+    async requestAccess(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessRequestResponse> {
+        const response = await this.requestAccessRaw(initOverrides);
         return await response.value();
     }
 
     /**
-     * Creates request options for updateMe without sending the request
+     * Creates request options for skipOnboarding without sending the request
      */
-    async updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['updateUserRequest'] == null) {
-            throw new runtime.RequiredError(
-                'updateUserRequest',
-                'Required parameter "updateUserRequest" was null or undefined when calling updateMe().'
-            );
-        }
-
+    async skipOnboardingRequestOpts(): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
 
-        headerParameters['Content-Type'] = 'application/json';
-
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
             const tokenString = await token("bearerAuth", []);
@@ -396,45 +380,44 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
             }
         }
 
-        let urlPath = `/v1/users`;
+        let urlPath = `/v1/users/me/onboarding/skip`;
 
         return {
             path: urlPath,
-            method: 'PATCH',
+            method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: UpdateUserRequestToJSON(requestParameters['updateUserRequest']),
         };
     }
 
     /**
-     * Update the user\'s name and default tenant, and the membership\'s profile.  When updating default_tenant_id, the user must belong to the specified tenant.
-     * Update Me Handler
+     * Mark onboarding complete without writing any profile/company fields.  Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
+     * Skip Onboarding Handler
      */
-    async updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
-        const requestOptions = await this.updateMeRequestOpts(requestParameters);
+    async skipOnboardingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.skipOnboardingRequestOpts();
         const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
 
     /**
-     * Update the user\'s name and default tenant, and the membership\'s profile.  When updating default_tenant_id, the user must belong to the specified tenant.
-     * Update Me Handler
+     * Mark onboarding complete without writing any profile/company fields.  Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
+     * Skip Onboarding Handler
      */
-    async updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
-        const response = await this.updateMeRaw(requestParameters, initOverrides);
+    async skipOnboarding(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
+        const response = await this.skipOnboardingRaw(initOverrides);
         return await response.value();
     }
 
     /**
-     * Creates request options for updateOnboardingCompany without sending the request
+     * Creates request options for updateMe without sending the request
      */
-    async updateOnboardingCompanyRequestOpts(requestParameters: UpdateOnboardingCompanyRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['onboardingCompanyRequest'] == null) {
+    async updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['updateUserRequest'] == null) {
             throw new runtime.RequiredError(
-                'onboardingCompanyRequest',
-                'Required parameter "onboardingCompanyRequest" was null or undefined when calling updateOnboardingCompany().'
+                'updateUserRequest',
+                'Required parameter "updateUserRequest" was null or undefined when calling updateMe().'
             );
         }
 
@@ -453,45 +436,45 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
             }
         }
 
-        let urlPath = `/v1/users/me/onboarding/company`;
+        let urlPath = `/v1/users`;
 
         return {
             path: urlPath,
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
-            body: OnboardingCompanyRequestToJSON(requestParameters['onboardingCompanyRequest']),
+            body: UpdateUserRequestToJSON(requestParameters['updateUserRequest']),
         };
     }
 
     /**
-     * Step 1 of onboarding: tenant-wide company info.  Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead.  Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
-     * Update Onboarding Company Handler
+     * Update the user\'s name and default tenant, and the membership\'s profile.  When updating default_tenant_id, the user must belong to the specified tenant.
+     * Update Me Handler
      */
-    async updateOnboardingCompanyRaw(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
-        const requestOptions = await this.updateOnboardingCompanyRequestOpts(requestParameters);
+    async updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.updateMeRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
 
     /**
-     * Step 1 of onboarding: tenant-wide company info.  Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead.  Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
-     * Update Onboarding Company Handler
+     * Update the user\'s name and default tenant, and the membership\'s profile.  When updating default_tenant_id, the user must belong to the specified tenant.
+     * Update Me Handler
      */
-    async updateOnboardingCompany(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
-        const response = await this.updateOnboardingCompanyRaw(requestParameters, initOverrides);
+    async updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
+        const response = await this.updateMeRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
     /**
-     * Creates request options for updateOnboardingProfile without sending the request
+     * Creates request options for updateOnboardingState without sending the request
      */
-    async updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['onboardingProfileRequest'] == null) {
+    async updateOnboardingStateRequestOpts(requestParameters: UpdateOnboardingStateRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['onboardingStateUpdate'] == null) {
             throw new runtime.RequiredError(
-                'onboardingProfileRequest',
-                'Required parameter "onboardingProfileRequest" was null or undefined when calling updateOnboardingProfile().'
+                'onboardingStateUpdate',
+                'Required parameter "onboardingStateUpdate" was null or undefined when calling updateOnboardingState().'
             );
         }
 
@@ -510,34 +493,32 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
             }
         }
 
-        let urlPath = `/v1/users/me/onboarding/profile`;
+        let urlPath = `/v1/users/me/onboarding`;
 
         return {
             path: urlPath,
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
-            body: OnboardingProfileRequestToJSON(requestParameters['onboardingProfileRequest']),
+            body: OnboardingStateUpdateToJSON(requestParameters['onboardingStateUpdate']),
         };
     }
 
     /**
-     * Step 2 (final) of onboarding: per-user profile for the current tenant.  Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
-     * Update Onboarding Profile Handler
+     * Update Onboarding State Handler
      */
-    async updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
-        const requestOptions = await this.updateOnboardingProfileRequestOpts(requestParameters);
+    async updateOnboardingStateRaw(requestParameters: UpdateOnboardingStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.updateOnboardingStateRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
 
     /**
-     * Step 2 (final) of onboarding: per-user profile for the current tenant.  Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
-     * Update Onboarding Profile Handler
+     * Update Onboarding State Handler
      */
-    async updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
-        const response = await this.updateOnboardingProfileRaw(requestParameters, initOverrides);
+    async updateOnboardingState(requestParameters: UpdateOnboardingStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
+        const response = await this.updateOnboardingStateRaw(requestParameters, initOverrides);
         return await response.value();
     }
 

package/src/models/{OnboardingCompanyRequest.ts → AccessRequestResponse.ts}

@@ -14,25 +14,19 @@
 
 import { mapValues } from '../runtime';
 /**
- * Step 1 of onboarding — tenant-wide company info. OWNER/ADMIN only.
+ * 
  * @export
- * @interface OnboardingCompanyRequest
+ * @interface AccessRequestResponse
  */
-export interface OnboardingCompanyRequest {
-    /**
-     * Brief company description (≤5000 chars)
-     * @type {string}
-     * @memberof OnboardingCompanyRequest
-     */
-    description?: string | null;
+export interface AccessRequestResponse {
     /**
-     * Industry / company type (free text)
-     * @type {string}
-     * @memberof OnboardingCompanyRequest
+     * 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
      */
-    industry?: string | null;
+    requestedAt: Date;
 }
-export const OnboardingCompanyRequestPropertyValidationAttributesMap: {
+export const AccessRequestResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
         minLength?: number,
@@ -47,50 +41,43 @@ export const OnboardingCompanyRequestPropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
-    description: {
-        maxLength: 5000,
-    },
-    industry: {
-        maxLength: 120,
-    },
 }
 
 
 /**
- * Check if a given object implements the OnboardingCompanyRequest interface.
+ * Check if a given object implements the AccessRequestResponse interface.
  */
-export function instanceOfOnboardingCompanyRequest(value: object): value is OnboardingCompanyRequest {
+export function instanceOfAccessRequestResponse(value: object): value is AccessRequestResponse {
+    if (!('requestedAt' in value) || value['requestedAt'] === undefined) return false;
     return true;
 }
 
-export function OnboardingCompanyRequestFromJSON(json: any): OnboardingCompanyRequest {
-    return OnboardingCompanyRequestFromJSONTyped(json, false);
+export function AccessRequestResponseFromJSON(json: any): AccessRequestResponse {
+    return AccessRequestResponseFromJSONTyped(json, false);
 }
 
-export function OnboardingCompanyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OnboardingCompanyRequest {
+export function AccessRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccessRequestResponse {
     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'])),
     };
 }
 
-export function OnboardingCompanyRequestToJSON(json: any): OnboardingCompanyRequest {
-    return OnboardingCompanyRequestToJSONTyped(json, false);
+export function AccessRequestResponseToJSON(json: any): AccessRequestResponse {
+    return AccessRequestResponseToJSONTyped(json, false);
 }
 
-export function OnboardingCompanyRequestToJSONTyped(value?: OnboardingCompanyRequest | null, ignoreDiscriminator: boolean = false): any {
+export function AccessRequestResponseToJSONTyped(value?: AccessRequestResponse | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
 
     return {
         
-        'description': value['description'],
-        'industry': value['industry'],
+        'requested_at': value['requestedAt'].toISOString(),
     };
 }
 

package/src/models/AddedBy.ts

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

package/src/models/CreatePasswordUserRequest.ts

@@ -43,6 +43,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 const CreatePasswordUserRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -88,6 +94,7 @@ export function CreatePasswordUserRequestFromJSONTyped(json: any, ignoreDiscrimi
         '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'],
     };
 }
 
@@ -106,6 +113,7 @@ export function CreatePasswordUserRequestToJSONTyped(value?: CreatePasswordUserR
         'email_token': value['emailToken'],
         'first_name': value['firstName'],
         'last_name': value['lastName'],
+        'invite_id': value['inviteId'],
     };
 }
 

package/src/models/ErrorResponse.ts

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

package/src/models/FeaturesResponse.ts

@@ -27,6 +27,13 @@ import {
     UploadConstraintsToJSON,
     UploadConstraintsToJSONTyped,
 } from './UploadConstraints';
+import type { DataSourceEngine } from './DataSourceEngine';
+import {
+    DataSourceEngineFromJSON,
+    DataSourceEngineFromJSONTyped,
+    DataSourceEngineToJSON,
+    DataSourceEngineToJSONTyped,
+} from './DataSourceEngine';
 
 /**
  * 
@@ -70,6 +77,12 @@ export interface FeaturesResponse {
      * @memberof FeaturesResponse
      */
     upload: UploadConstraints;
+    /**
+     * 
+     * @type {Array<DataSourceEngine>}
+     * @memberof FeaturesResponse
+     */
+    dataSourceEngines: Array<DataSourceEngine>;
 }
 
 
@@ -101,6 +114,7 @@ export function instanceOfFeaturesResponse(value: object): value is FeaturesResp
     if (!('smsLoginEnabled' in value) || value['smsLoginEnabled'] === undefined) return false;
     if (!('defaultFrontendLanguage' in value) || value['defaultFrontendLanguage'] === undefined) return false;
     if (!('upload' in value) || value['upload'] === undefined) return false;
+    if (!('dataSourceEngines' in value) || value['dataSourceEngines'] === undefined) return false;
     return true;
 }
 
@@ -120,6 +134,7 @@ export function FeaturesResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         'smsLoginEnabled': json['sms_login_enabled'],
         'defaultFrontendLanguage': SupportedLanguageFromJSON(json['default_frontend_language']),
         'upload': UploadConstraintsFromJSON(json['upload']),
+        'dataSourceEngines': ((json['data_source_engines'] as Array<any>).map(DataSourceEngineFromJSON)),
     };
 }
 
@@ -140,6 +155,7 @@ export function FeaturesResponseToJSONTyped(value?: FeaturesResponse | null, ign
         'sms_login_enabled': value['smsLoginEnabled'],
         'default_frontend_language': SupportedLanguageToJSON(value['defaultFrontendLanguage']),
         'upload': UploadConstraintsToJSON(value['upload']),
+        'data_source_engines': ((value['dataSourceEngines'] as Array<any>).map(DataSourceEngineToJSON)),
     };
 }