@knowledge-stack/ksapi 1.72.4 → 1.78.0

package/docs/PublicApi.md

@@ -0,0 +1,68 @@
+# PublicApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listPublicSubscriptions**](PublicApi.md#listpublicsubscriptions) | **GET** /public/subscriptions | List Public Subscriptions Handler |
+
+
+
+## listPublicSubscriptions
+
+> Array<SubscriptionPlanResponse> listPublicSubscriptions()
+
+List Public Subscriptions Handler
+
+List publicly-visible subscription plans (no authentication required).  Filters to ``subscription_plan.public = true`` — custom enterprise tiers (created with ``public=False`` via ``POST /system/subscriptions``) are excluded. Tenants on a private plan can still read it via ``GET /v1/tenants/{tenant_id}/subscriptions``.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PublicApi,
+} from '@knowledge-stack/ksapi';
+import type { ListPublicSubscriptionsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new PublicApi();
+
+  try {
+    const data = await api.listPublicSubscriptions();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<SubscriptionPlanResponse>**](SubscriptionPlanResponse.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 |  -  |
+
+[[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/ScoredChunkResponse.md

@@ -12,7 +12,7 @@ Name | Type
 `contentId` | string
 `content` | string
 `chunkType` | [ChunkType](ChunkType.md)
-`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
 `numTokens` | number
 `parentPathId` | string
 `prevSiblingPathId` | string

package/docs/SeatQuotaStatus.md

@@ -0,0 +1,37 @@
+
+# SeatQuotaStatus
+
+Live seat count for the tenant.  ``used`` is the number of active (non-deactivated) ``TenantUser`` rows.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`used` | number
+`limit` | number
+
+## Example
+
+```typescript
+import type { SeatQuotaStatus } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "used": null,
+  "limit": null,
+} satisfies SeatQuotaStatus
+
+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 SeatQuotaStatus
+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/SectionContentItemOrChunkContentItem.md

@@ -19,7 +19,7 @@ Name | Type
 `updatedAt` | Date
 `content` | string
 `chunkType` | [ChunkType](ChunkType.md)
-`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
 
 ## Example
 

package/docs/SubscriptionPlanResponse.md

@@ -0,0 +1,51 @@
+
+# SubscriptionPlanResponse
+
+Public-facing plan description.  Surfaced via ``GET /public/subscriptions`` (unauth) so the FE can render the upgrade page even before sign-in. Field names line up 1:1 with ``SubscriptionPlan`` ORM attributes; callers build the response via ``SubscriptionPlanResponse.model_validate(plan)`` (``BaseResponse`` enables ``from_attributes=True``).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`ingestedPages` | number
+`messages` | number
+`searches` | number
+`maxSeats` | number
+`_public` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { SubscriptionPlanResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "ingestedPages": null,
+  "messages": null,
+  "searches": null,
+  "maxSeats": null,
+  "_public": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies SubscriptionPlanResponse
+
+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 SubscriptionPlanResponse
+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/SubscriptionsApi.md

@@ -0,0 +1,164 @@
+# SubscriptionsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**changeTenantSubscription**](SubscriptionsApi.md#changetenantsubscription) | **POST** /v1/tenants/{tenant_id}/subscriptions | Change Tenant Subscription Handler |
+| [**getTenantSubscription**](SubscriptionsApi.md#gettenantsubscription) | **GET** /v1/tenants/{tenant_id}/subscriptions | Get Tenant Subscription Handler |
+
+
+
+## changeTenantSubscription
+
+> TenantResponse changeTenantSubscription(tenantId, changeSubscriptionRequest, idempotencyKey, authorization, ksUat)
+
+Change Tenant Subscription Handler
+
+Change the tenant\'s subscription plan and/or seat count.  OWNER-only on the target tenant. Covers three scenarios with one shape:   - Plan change (with optional seat-count change).   - Pure seat-count change (same plan, different ``num_seats``).   - No-op (same plan, same seats) — returns 200, performs no DB or     Stripe writes.  Optional ``Idempotency-Key`` request header is forwarded to Stripe verbatim (clients that retry the same logical operation MUST send the same value across attempts; Stripe collapses duplicates server- side). Absent the header, the server generates a fresh ``uuid4()`` per call and emits a warning — retries in that case are NOT deduplicated. v1 mock-Stripe doesn\'t care, but the contract is in place for the real integration.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SubscriptionsApi,
+} from '@knowledge-stack/ksapi';
+import type { ChangeTenantSubscriptionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new SubscriptionsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ChangeSubscriptionRequest
+    changeSubscriptionRequest: ...,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ChangeTenantSubscriptionRequest;
+
+  try {
+    const data = await api.changeTenantSubscription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **changeSubscriptionRequest** | [ChangeSubscriptionRequest](ChangeSubscriptionRequest.md) |  | |
+| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TenantResponse**](TenantResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getTenantSubscription
+
+> SubscriptionPlanResponse getTenantSubscription(tenantId, authorization, ksUat)
+
+Get Tenant Subscription Handler
+
+Read the tenant\'s current subscription plan, including private tiers.  Any active member of the tenant can read. This is the only path that surfaces private (custom enterprise) plans to non-admin users — ``GET /public/subscriptions`` filters them out, but tenants on a private plan still need to see their own caps. Returns the full plan body (id, name, caps, max_seats, public flag, timestamps).  Returns 404 when the user is not a member of the tenant — same response shape as a non-existent tenant so we don\'t leak existence to outsiders.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SubscriptionsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetTenantSubscriptionRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new SubscriptionsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetTenantSubscriptionRequest;
+
+  try {
+    const data = await api.getTenantSubscription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**SubscriptionPlanResponse**](SubscriptionPlanResponse.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 |  -  |
+
+[[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/TenantQuotaStateResponse.md

@@ -0,0 +1,37 @@
+
+# TenantQuotaStateResponse
+
+Tenant\'s current quota state across all enforced caps.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`metered` | [Array<MeteredQuotaStatus>](MeteredQuotaStatus.md)
+`seats` | [SeatQuotaStatus](SeatQuotaStatus.md)
+
+## Example
+
+```typescript
+import type { TenantQuotaStateResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "metered": null,
+  "seats": null,
+} satisfies TenantQuotaStateResponse
+
+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 TenantQuotaStateResponse
+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

@@ -12,6 +12,8 @@ Name | Type
 `idpConfig` | { [key: string]: any; }
 `settings` | [TenantSettingsResponse](TenantSettingsResponse.md)
 `branding` | [TenantBrandingResponse](TenantBrandingResponse.md)
+`seats` | number
+`subscriptionId` | string
 
 ## Example
 
@@ -25,6 +27,8 @@ const example = {
   "idpConfig": null,
   "settings": null,
   "branding": null,
+  "seats": null,
+  "subscriptionId": null,
 } satisfies TenantResponse
 
 console.log(example)

package/docs/TenantSettingsResponse.md

@@ -10,6 +10,7 @@ Name | Type
 `language` | [SupportedLanguage](SupportedLanguage.md)
 `description` | string
 `timezone` | string
+`inviteLink` | [InviteLinkSettingsResponse](InviteLinkSettingsResponse.md)
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "language": null,
   "description": null,
   "timezone": null,
+  "inviteLink": null,
 } satisfies TenantSettingsResponse
 
 console.log(example)

package/docs/TenantSettingsUpdate.md

@@ -13,6 +13,7 @@ Name | Type
 `brandName` | string
 `brandColor` | string
 `themeOverrides` | { [key: string]: string; }
+`inviteLink` | [InviteLinkSettingsRequest](InviteLinkSettingsRequest.md)
 
 ## Example
 
@@ -27,6 +28,7 @@ const example = {
   "brandName": null,
   "brandColor": null,
   "themeOverrides": null,
+  "inviteLink": null,
 } satisfies TenantSettingsUpdate
 
 console.log(example)

package/docs/TenantsApi.md

@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost:8000*
 | [**deleteTenantLogo**](TenantsApi.md#deletetenantlogo) | **DELETE** /v1/tenants/{tenant_id}/branding/logo | Delete Tenant Logo |
 | [**deleteTenantUser**](TenantsApi.md#deletetenantuser) | **DELETE** /v1/tenants/{tenant_id}/users/{user_id} | Delete Tenant User Handler |
 | [**getTenant**](TenantsApi.md#gettenant) | **GET** /v1/tenants/{tenant_id} | Get Tenant |
+| [**getTenantQuotaState**](TenantsApi.md#gettenantquotastate) | **GET** /v1/tenants/{tenant_id}/quota | Get Tenant Quota State Handler |
 | [**listTenantUsers**](TenantsApi.md#listtenantusers) | **GET** /v1/tenants/{tenant_id}/users | List Tenant Users |
 | [**listTenants**](TenantsApi.md#listtenants) | **GET** /v1/tenants | List Tenants |
 | [**updateTenant**](TenantsApi.md#updatetenantoperation) | **PATCH** /v1/tenants/{tenant_id} | Update Tenant |
@@ -474,6 +475,80 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getTenantQuotaState
+
+> TenantQuotaStateResponse getTenantQuotaState(tenantId, authorization, ksUat)
+
+Get Tenant Quota State Handler
+
+Read the tenant\'s current quota state across all metered caps + seats.  Any active member of the tenant can read. Read-only — does not mutate quota state.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetTenantQuotaStateRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetTenantQuotaStateRequest;
+
+  try {
+    const data = await api.getTenantQuotaState(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TenantQuotaStateResponse**](TenantQuotaStateResponse.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 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listTenantUsers
 
 > PaginatedResponseTenantUserResponse listTenantUsers(tenantId, limit, offset, authorization, ksUat)

package/docs/ThreadMessageDetailsInput.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `steps` | [Array<StepInput>](StepInput.md)
+`checkpoint` | [CheckpointDetails](CheckpointDetails.md)
 
 ## Example
 
@@ -16,6 +17,7 @@ import type { ThreadMessageDetailsInput } from '@knowledge-stack/ksapi'
 // TODO: Update the object below with actual values
 const example = {
   "steps": null,
+  "checkpoint": null,
 } satisfies ThreadMessageDetailsInput
 
 console.log(example)

package/docs/ThreadMessageDetailsOutput.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `steps` | [Array<StepOutput>](StepOutput.md)
+`checkpoint` | [CheckpointDetails](CheckpointDetails.md)
 
 ## Example
 
@@ -16,6 +17,7 @@ import type { ThreadMessageDetailsOutput } from '@knowledge-stack/ksapi'
 // TODO: Update the object below with actual values
 const example = {
   "steps": null,
+  "checkpoint": null,
 } satisfies ThreadMessageDetailsOutput
 
 console.log(example)

package/docs/ThreadsApi.md

@@ -322,7 +322,7 @@ No authorization required
 
 Send User Message Handler
 
-Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
+Send a user message and trigger agent generation. Returns immediately with a workflow_id.  Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.  Quota: consumes one MESSAGE inside the same transaction that creates the user-message row and starts the workflow. Any failure on the consume, the workflow start, or anywhere in between rolls back the whole transaction via the session context manager — message insert, quota consume, and downstream side effects are all-or-nothing. No explicit refund path is needed because nothing commits until the workflow has been durably enqueued. Workflow failures observed asynchronously (after enqueue) do **not** refund — the consume stands, matching agent-ask\'s v1 simplification.
 
 ### Example
 

package/docs/UpdateChunkMetadataRequest.md

@@ -7,7 +7,7 @@ Request to update chunk metadata and/or move the chunk.
 
 Name | Type
 ------------ | -------------
-`chunkMetadata` | [ChunkMetadataInput](ChunkMetadataInput.md)
+`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
 `parentPathPartId` | string
 `prevSiblingPathId` | string
 `moveToHead` | boolean

package/docs/UpdateDocumentRequest.md

@@ -1,7 +1,7 @@
 
 # UpdateDocumentRequest
 
-Request to update a document (rename, move, and/or change active version).
+Request to update a document (rename, move, active version, qdrant exclusion).
 
 ## Properties
 
@@ -10,6 +10,7 @@ Name | Type
 `name` | string
 `parentPathPartId` | string
 `activeVersionId` | string
+`excludeFromQdrant` | boolean
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "name": null,
   "parentPathPartId": null,
   "activeVersionId": null,
+  "excludeFromQdrant": null,
 } satisfies UpdateDocumentRequest
 
 console.log(example)

package/docs/UpdateFolderRequest.md

@@ -1,7 +1,7 @@
 
 # UpdateFolderRequest
 
-Request to update a folder (rename and/or move).
+Request to update a folder (rename, move, and/or change qdrant exclusion).
 
 ## Properties
 
@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `name` | string
 `parentPathPartId` | string
+`excludeFromQdrant` | boolean
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { UpdateFolderRequest } from '@knowledge-stack/ksapi'
 const example = {
   "name": null,
   "parentPathPartId": null,
+  "excludeFromQdrant": null,
 } satisfies UpdateFolderRequest
 
 console.log(example)

package/docs/UpdateInviteRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateInviteRequest
+
+Partial update for an invite (admin/owner only).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`expiresAt` | Date
+`groups` | Array<string>
+
+## Example
+
+```typescript
+import type { UpdateInviteRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "expiresAt": null,
+  "groups": null,
+} satisfies UpdateInviteRequest
+
+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 UpdateInviteRequest
+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)
+
+