@knowledge-stack/ksapi 3.10.2 → 3.12.0

package/docs/InvitePreviewState.md

@@ -0,0 +1,32 @@
+
+# InvitePreviewState
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { InvitePreviewState } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies InvitePreviewState
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as InvitePreviewState
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/InviteRejection.md

@@ -0,0 +1,32 @@
+
+# InviteRejection
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { InviteRejection } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies InviteRejection
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as InviteRejection
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/InvitesApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8000*
 | [**createInvite**](InvitesApi.md#createinvite) | **POST** /v1/invites | Create Invite |
 | [**deleteInvite**](InvitesApi.md#deleteinvite) | **DELETE** /v1/invites/{invite_id} | Delete Invite |
 | [**listInvites**](InvitesApi.md#listinvites) | **GET** /v1/invites | List Invites Handler |
+| [**previewInvite**](InvitesApi.md#previewinvite) | **GET** /v1/invites/{invite_id}/preview | Preview Invite Handler |
 | [**updateInvite**](InvitesApi.md#updateinviteoperation) | **PATCH** /v1/invites/{invite_id} | Update Invite Handler |
 
 
@@ -345,6 +346,75 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## previewInvite
+
+> InvitePreviewResponse previewInvite(inviteId)
+
+Preview Invite Handler
+
+Unauthenticated; the invite id in the emailed link is the only credential.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitesApi,
+} from '@knowledge-stack/ksapi';
+import type { PreviewInviteRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new InvitesApi();
+
+  const body = {
+    // string
+    inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PreviewInviteRequest;
+
+  try {
+    const data = await api.previewInvite(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **inviteId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**InvitePreviewResponse**](InvitePreviewResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## updateInvite
 
 > InviteResponse updateInvite(inviteId, updateInviteRequest)

package/docs/KbSummaryResponse.md

@@ -10,6 +10,7 @@ Name | Type
 `documentsTotal` | number
 `documentsByOrigin` | { [key: string]: number; }
 `documentsByType` | { [key: string]: number; }
+`documentsByIngestionStatus` | { [key: string]: number; }
 `documentVersionsTotal` | number
 `chunksTotal` | number
 `chunksByType` | { [key: string]: number; }
@@ -35,6 +36,7 @@ const example = {
   "documentsTotal": null,
   "documentsByOrigin": null,
   "documentsByType": null,
+  "documentsByIngestionStatus": null,
   "documentVersionsTotal": null,
   "chunksTotal": null,
   "chunksByType": null,

package/docs/OnboardingState.md

@@ -0,0 +1,39 @@
+
+# OnboardingState
+
+Stored state: keys and steps this release does not know are dropped.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`currentStep` | [OnboardingStep](OnboardingStep.md)
+`guideModules` | [GuideModules](GuideModules.md)
+`setupChecklistDismissed` | boolean
+
+## Example
+
+```typescript
+import type { OnboardingState } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "currentStep": null,
+  "guideModules": null,
+  "setupChecklistDismissed": null,
+} satisfies OnboardingState
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as OnboardingState
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/OnboardingStateUpdate.md

@@ -0,0 +1,38 @@
+
+# OnboardingStateUpdate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`currentStep` | [OnboardingStep](OnboardingStep.md)
+`guideModules` | [GuideModules](GuideModules.md)
+`setupChecklistDismissed` | boolean
+
+## Example
+
+```typescript
+import type { OnboardingStateUpdate } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "currentStep": null,
+  "guideModules": null,
+  "setupChecklistDismissed": null,
+} satisfies OnboardingStateUpdate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as OnboardingStateUpdate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/OnboardingStep.md

@@ -0,0 +1,32 @@
+
+# OnboardingStep
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { OnboardingStep } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies OnboardingStep
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as OnboardingStep
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SignUpResponse.md

@@ -0,0 +1,74 @@
+
+# SignUpResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`email` | string
+`phoneNumber` | string
+`firstName` | string
+`lastName` | string
+`idpType` | [IdpType](IdpType.md)
+`currentTenantId` | string
+`currentTenantRole` | [TenantUserRole](TenantUserRole.md)
+`defaultTenantId` | string
+`jobTitle` | string
+`department` | string
+`bio` | string
+`avatarUrl` | string
+`onboardingCompletedAt` | Date
+`joinMethod` | [TenantUserJoinMethod](TenantUserJoinMethod.md)
+`onboardingState` | [OnboardingState](OnboardingState.md)
+`invitedBy` | [UserInfo](UserInfo.md)
+`addedBy` | [AddedBy](AddedBy.md)
+`idpManagedFields` | Array<string>
+`onboardingEnabled` | boolean
+`inviteRejection` | [InviteRejection](InviteRejection.md)
+
+## Example
+
+```typescript
+import type { SignUpResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "email": null,
+  "phoneNumber": null,
+  "firstName": null,
+  "lastName": null,
+  "idpType": null,
+  "currentTenantId": null,
+  "currentTenantRole": null,
+  "defaultTenantId": null,
+  "jobTitle": null,
+  "department": null,
+  "bio": null,
+  "avatarUrl": null,
+  "onboardingCompletedAt": null,
+  "joinMethod": null,
+  "onboardingState": null,
+  "invitedBy": null,
+  "addedBy": null,
+  "idpManagedFields": null,
+  "onboardingEnabled": null,
+  "inviteRejection": null,
+} satisfies SignUpResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SignUpResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/TenantResponse.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `id` | string
 `name` | string
+`owner` | [UserInfo](UserInfo.md)
 `idpConfig` | { [key: string]: any; }
 `settings` | [TenantSettingsResponse](TenantSettingsResponse.md)
 `branding` | [TenantBrandingResponse](TenantBrandingResponse.md)
@@ -24,6 +25,7 @@ import type { TenantResponse } from '@knowledge-stack/ksapi'
 const example = {
   "id": null,
   "name": null,
+  "owner": null,
   "idpConfig": null,
   "settings": null,
   "branding": null,

package/docs/TenantUserJoinMethod.md

@@ -0,0 +1,32 @@
+
+# TenantUserJoinMethod
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { TenantUserJoinMethod } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies TenantUserJoinMethod
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as TenantUserJoinMethod
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UserResponse.md

@@ -20,6 +20,12 @@ Name | Type
 `bio` | string
 `avatarUrl` | string
 `onboardingCompletedAt` | Date
+`joinMethod` | [TenantUserJoinMethod](TenantUserJoinMethod.md)
+`onboardingState` | [OnboardingState](OnboardingState.md)
+`invitedBy` | [UserInfo](UserInfo.md)
+`addedBy` | [AddedBy](AddedBy.md)
+`idpManagedFields` | Array<string>
+`onboardingEnabled` | boolean
 
 ## Example
 
@@ -42,6 +48,12 @@ const example = {
   "bio": null,
   "avatarUrl": null,
   "onboardingCompletedAt": null,
+  "joinMethod": null,
+  "onboardingState": null,
+  "invitedBy": null,
+  "addedBy": null,
+  "idpManagedFields": null,
+  "onboardingEnabled": null,
 } satisfies UserResponse
 
 console.log(example)

package/docs/UsersApi.md

@@ -6,10 +6,10 @@ All URIs are relative to *http://localhost:8000*
 |------------- | ------------- | -------------|
 | [**deleteMyAvatar**](UsersApi.md#deletemyavatar) | **DELETE** /v1/users/me/avatar | Delete My Avatar Handler |
 | [**getMe**](UsersApi.md#getme) | **GET** /v1/users/me | Get Me Handler |
+| [**requestAccess**](UsersApi.md#requestaccess) | **POST** /v1/users/me/access_requests | Request Access Handler |
 | [**skipOnboarding**](UsersApi.md#skiponboarding) | **POST** /v1/users/me/onboarding/skip | Skip Onboarding Handler |
 | [**updateMe**](UsersApi.md#updateme) | **PATCH** /v1/users | Update Me Handler |
-| [**updateOnboardingCompany**](UsersApi.md#updateonboardingcompany) | **PATCH** /v1/users/me/onboarding/company | Update Onboarding Company Handler |
-| [**updateOnboardingProfile**](UsersApi.md#updateonboardingprofile) | **PATCH** /v1/users/me/onboarding/profile | Update Onboarding Profile Handler |
+| [**updateOnboardingState**](UsersApi.md#updateonboardingstate) | **PATCH** /v1/users/me/onboarding | Update Onboarding State Handler |
 | [**uploadMyAvatar**](UsersApi.md#uploadmyavatar) | **POST** /v1/users/me/avatar | Upload My Avatar Handler |
 
 
@@ -146,13 +146,13 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## skipOnboarding
+## requestAccess
 
-> UserResponse skipOnboarding()
+> AccessRequestResponse requestAccess()
 
-Skip Onboarding Handler
+Request Access 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).
+Email the owner and admins for access; one request per member per day.
 
 ### Example
 
@@ -161,7 +161,7 @@ import {
   Configuration,
   UsersApi,
 } from '@knowledge-stack/ksapi';
-import type { SkipOnboardingRequest } from '@knowledge-stack/ksapi';
+import type { RequestAccessRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -174,7 +174,7 @@ async function example() {
   const api = new UsersApi(config);
 
   try {
-    const data = await api.skipOnboarding();
+    const data = await api.requestAccess();
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -191,7 +191,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**UserResponse**](UserResponse.md)
+[**AccessRequestResponse**](AccessRequestResponse.md)
 
 ### Authorization
 
@@ -212,13 +212,13 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## updateMe
+## skipOnboarding
 
-> UserResponse updateMe(updateUserRequest)
+> UserResponse skipOnboarding()
 
-Update Me Handler
+Skip Onboarding 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.
+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).
 
 ### Example
 
@@ -227,7 +227,7 @@ import {
   Configuration,
   UsersApi,
 } from '@knowledge-stack/ksapi';
-import type { UpdateMeRequest } from '@knowledge-stack/ksapi';
+import type { SkipOnboardingRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -239,13 +239,8 @@ async function example() {
   });
   const api = new UsersApi(config);
 
-  const body = {
-    // UpdateUserRequest
-    updateUserRequest: ...,
-  } satisfies UpdateMeRequest;
-
   try {
-    const data = await api.updateMe(body);
+    const data = await api.skipOnboarding();
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -258,10 +253,7 @@ example().catch(console.error);
 
 ### Parameters
 
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **updateUserRequest** | [UpdateUserRequest](UpdateUserRequest.md) |  | |
+This endpoint does not need any parameter.
 
 ### Return type
 
@@ -273,7 +265,7 @@ example().catch(console.error);
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
+- **Content-Type**: Not defined
 - **Accept**: `application/json`
 
 
@@ -281,19 +273,18 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
-| **422** | Validation Error |  -  |
 | **0** | Error response. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## updateOnboardingCompany
+## updateMe
 
-> UserResponse updateOnboardingCompany(onboardingCompanyRequest)
+> UserResponse updateMe(updateUserRequest)
 
-Update Onboarding Company Handler
+Update Me Handler
 
-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 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.
 
 ### Example
 
@@ -302,7 +293,7 @@ import {
   Configuration,
   UsersApi,
 } from '@knowledge-stack/ksapi';
-import type { UpdateOnboardingCompanyRequest } from '@knowledge-stack/ksapi';
+import type { UpdateMeRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -315,12 +306,12 @@ async function example() {
   const api = new UsersApi(config);
 
   const body = {
-    // OnboardingCompanyRequest
-    onboardingCompanyRequest: ...,
-  } satisfies UpdateOnboardingCompanyRequest;
+    // UpdateUserRequest
+    updateUserRequest: ...,
+  } satisfies UpdateMeRequest;
 
   try {
-    const data = await api.updateOnboardingCompany(body);
+    const data = await api.updateMe(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -336,7 +327,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **onboardingCompanyRequest** | [OnboardingCompanyRequest](OnboardingCompanyRequest.md) |  | |
+| **updateUserRequest** | [UpdateUserRequest](UpdateUserRequest.md) |  | |
 
 ### Return type
 
@@ -362,13 +353,11 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## updateOnboardingProfile
-
-> UserResponse updateOnboardingProfile(onboardingProfileRequest)
+## updateOnboardingState
 
-Update Onboarding Profile Handler
+> UserResponse updateOnboardingState(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 State Handler
 
 ### Example
 
@@ -377,7 +366,7 @@ import {
   Configuration,
   UsersApi,
 } from '@knowledge-stack/ksapi';
-import type { UpdateOnboardingProfileRequest } from '@knowledge-stack/ksapi';
+import type { UpdateOnboardingStateRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
@@ -390,12 +379,12 @@ async function example() {
   const api = new UsersApi(config);
 
   const body = {
-    // OnboardingProfileRequest
-    onboardingProfileRequest: ...,
-  } satisfies UpdateOnboardingProfileRequest;
+    // OnboardingStateUpdate
+    onboardingStateUpdate: ...,
+  } satisfies UpdateOnboardingStateRequest;
 
   try {
-    const data = await api.updateOnboardingProfile(body);
+    const data = await api.updateOnboardingState(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -411,7 +400,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **onboardingProfileRequest** | [OnboardingProfileRequest](OnboardingProfileRequest.md) |  | |
+| **onboardingStateUpdate** | [OnboardingStateUpdate](OnboardingStateUpdate.md) |  | |
 
 ### Return type
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "3.10.2",
+  "version": "3.12.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {