@knowledge-stack/ksapi 1.72.4 → 1.77.1

package/docs/ExtractRequest.md

@@ -0,0 +1,39 @@
+
+# ExtractRequest
+
+Request body for POST /v1/agent/extract.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`prompt` | string
+`schemaPathPartId` | string
+`outputSchema` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { ExtractRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "prompt": null,
+  "schemaPathPartId": null,
+  "outputSchema": null,
+} satisfies ExtractRequest
+
+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 ExtractRequest
+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/ExtractResponse.md

@@ -0,0 +1,35 @@
+
+# ExtractResponse
+
+Response body for POST /v1/agent/extract.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`structured` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { ExtractResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "structured": null,
+} satisfies ExtractResponse
+
+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 ExtractResponse
+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/FolderResponse.md

@@ -14,6 +14,7 @@ Name | Type
 `parentPathPartId` | string
 `materializedPath` | string
 `systemManaged` | boolean
+`excludeFromQdrant` | boolean
 `tenantId` | string
 `createdAt` | Date
 `updatedAt` | Date
@@ -33,6 +34,7 @@ const example = {
   "parentPathPartId": null,
   "materializedPath": null,
   "systemManaged": null,
+  "excludeFromQdrant": null,
   "tenantId": null,
   "createdAt": null,
   "updatedAt": null,

package/docs/FolderResponseOrDocumentResponse.md

@@ -13,6 +13,7 @@ Name | Type
 `parentPathPartId` | string
 `materializedPath` | string
 `systemManaged` | boolean
+`excludeFromQdrant` | boolean
 `tenantId` | string
 `createdAt` | Date
 `updatedAt` | Date
@@ -36,6 +37,7 @@ const example = {
   "parentPathPartId": null,
   "materializedPath": null,
   "systemManaged": null,
+  "excludeFromQdrant": null,
   "tenantId": null,
   "createdAt": null,
   "updatedAt": null,

package/docs/FoldersApi.md

@@ -590,7 +590,7 @@ No authorization required
 
 Update Folder Handler
 
-Update a folder (rename and/or move).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. Both can be done in a single request.
+Update a folder (rename, move, and/or toggle Qdrant exclusion).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. To toggle Qdrant exclusion for this folder and its descendants: provide `exclude_from_qdrant` field. Any combination can be sent in a single request.
 
 ### Example
 

package/docs/InviteLinkSettingsRequest.md

@@ -0,0 +1,39 @@
+
+# InviteLinkSettingsRequest
+
+Partial invite-link settings update.  ``role`` is constrained to USER/ADMIN by the shared ``InviteLinkRole`` Literal — Pydantic raises a 422 for any other value.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`role` | string
+`groups` | Array<string>
+
+## Example
+
+```typescript
+import type { InviteLinkSettingsRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "role": null,
+  "groups": null,
+} satisfies InviteLinkSettingsRequest
+
+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 InviteLinkSettingsRequest
+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/InviteLinkSettingsResponse.md

@@ -0,0 +1,39 @@
+
+# InviteLinkSettingsResponse
+
+Tenant-wide invite-link settings (exposed via API).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`role` | string
+`groups` | Array<string>
+
+## Example
+
+```typescript
+import type { InviteLinkSettingsResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "role": null,
+  "groups": null,
+} satisfies InviteLinkSettingsResponse
+
+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 InviteLinkSettingsResponse
+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/InviteResponse.md

@@ -11,6 +11,7 @@ Name | Type
 `tenantId` | string
 `email` | string
 `role` | [TenantUserRole](TenantUserRole.md)
+`groups` | Array<string>
 `expiresAt` | Date
 `acceptedAt` | Date
 `createdAt` | Date
@@ -29,6 +30,7 @@ const example = {
   "tenantId": null,
   "email": null,
   "role": null,
+  "groups": null,
   "expiresAt": null,
   "acceptedAt": null,
   "createdAt": null,

package/docs/InviteUserRequest.md

@@ -9,6 +9,7 @@ Name | Type
 `tenantId` | string
 `email` | string
 `role` | [TenantUserRole](TenantUserRole.md)
+`groups` | Array<string>
 
 ## Example
 
@@ -20,6 +21,7 @@ const example = {
   "tenantId": null,
   "email": null,
   "role": null,
+  "groups": null,
 } satisfies InviteUserRequest
 
 console.log(example)

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 |
+| [**updateInvite**](InvitesApi.md#updateinviteoperation) | **PATCH** /v1/invites/{invite_id} | Update Invite Handler |
 
 
 
@@ -17,7 +18,7 @@ All URIs are relative to *http://localhost:8000*
 
 Accept Invite
 
-Update an invite to accepted status and create tenant user.
+Accept an invite OR a tenant invite-link.  The path parameter ``invite_id`` may be either:   * a Tenant ID (when an admin has enabled ``invite_link`` on the tenant), OR   * an Invite ID (the traditional per-email invite flow).  Tenant lookup is tried first. If the row is found, the request is treated as an invite-link request — both 400 paths below have *distinct* messages so the frontend can branch on copy:   * \"does not have invite link enabled\" → admin hasn\'t turned it on   * \"does not support inviting users\"   → tenant kill-switch ``system_metadata.can_invite`` is honored on this path too — it\'s a hard kill switch for self-serve onboarding. Only when no tenant matches do we look up an Invite row.
 
 ### Example
 
@@ -33,7 +34,7 @@ async function example() {
   const api = new InvitesApi();
 
   const body = {
-    // string
+    // string | Either an Invite ID (traditional per-email invite) OR a Tenant ID (when the tenant has ``invite_link.enabled``). Tenant lookup is tried first.
     inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string (optional)
     authorization: authorization_example,
@@ -58,7 +59,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **inviteId** | `string` |  | [Defaults to `undefined`] |
+| **inviteId** | `string` | Either an Invite ID (traditional per-email invite) OR a Tenant ID (when the tenant has ``invite_link.enabled``). Tenant lookup is tried first. | [Defaults to `undefined`] |
 | **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
@@ -315,3 +316,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)
 
+
+## updateInvite
+
+> InviteResponse updateInvite(inviteId, updateInviteRequest, authorization, ksUat)
+
+Update Invite Handler
+
+Update an invite\'s expiry or groups (admin/owner only).  The invite must belong to the caller\'s current tenant. Any provided groups are validated to belong to the same tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitesApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateInviteOperationRequest } 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,
+    // UpdateInviteRequest
+    updateInviteRequest: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateInviteOperationRequest;
+
+  try {
+    const data = await api.updateInvite(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`] |
+| **updateInviteRequest** | [UpdateInviteRequest](UpdateInviteRequest.md) |  | |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**InviteResponse**](InviteResponse.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)
+

package/docs/LineageNodeResponse.md

@@ -10,7 +10,7 @@ Name | Type
 `id` | string
 `content` | string
 `chunkType` | [ChunkType](ChunkType.md)
-`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
 `tenantId` | string
 `createdAt` | Date
 `updatedAt` | Date

package/docs/MeteredQuotaStatus.md

@@ -0,0 +1,43 @@
+
+# MeteredQuotaStatus
+
+Per-metric usage snapshot for the active period.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`metric` | [UsageMetric](UsageMetric.md)
+`used` | number
+`limit` | number
+`periodStart` | Date
+`periodEnd` | Date
+
+## Example
+
+```typescript
+import type { MeteredQuotaStatus } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "metric": null,
+  "used": null,
+  "limit": null,
+  "periodStart": null,
+  "periodEnd": null,
+} satisfies MeteredQuotaStatus
+
+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 MeteredQuotaStatus
+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/PathPartAncestorItem.md

@@ -14,6 +14,7 @@ Name | Type
 `metadataObjId` | string
 `materializedPath` | string
 `systemManaged` | boolean
+`excludeFromQdrant` | boolean
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -31,6 +32,7 @@ const example = {
   "metadataObjId": null,
   "materializedPath": null,
   "systemManaged": null,
+  "excludeFromQdrant": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies PathPartAncestorItem

package/docs/PathPartResponse.md

@@ -14,6 +14,7 @@ Name | Type
 `metadataObjId` | string
 `materializedPath` | string
 `systemManaged` | boolean
+`excludeFromQdrant` | boolean
 `tags` | [Array<TagResponse>](TagResponse.md)
 `canRead` | boolean
 `canWrite` | boolean
@@ -34,6 +35,7 @@ const example = {
   "metadataObjId": null,
   "materializedPath": null,
   "systemManaged": null,
+  "excludeFromQdrant": null,
   "tags": null,
   "canRead": null,
   "canWrite": null,

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)
+
+