@knowledge-stack/ksapi 1.23.5 → 1.25.0

package/docs/InviteUserRequest.md

@@ -0,0 +1,38 @@
+
+# InviteUserRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tenantId` | string
+`email` | string
+`role` | [TenantUserRole](TenantUserRole.md)
+
+## Example
+
+```typescript
+import type { InviteUserRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tenantId": null,
+  "email": null,
+  "role": null,
+} satisfies InviteUserRequest
+
+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 InviteUserRequest
+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

@@ -0,0 +1,305 @@
+# InvitesApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**acceptInvite**](InvitesApi.md#acceptinvite) | **POST** /v1/invites/{invite_id}/accept | Accept Invite |
+| [**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 |
+
+
+
+## acceptInvite
+
+> any acceptInvite(inviteId, ksUat)
+
+Accept Invite
+
+Update an invite to accepted status and create tenant user.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitesApi,
+} from '@knowledge-stack/ksapi';
+import type { AcceptInviteRequest } 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,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies AcceptInviteRequest;
+
+  try {
+    const data = await api.acceptInvite(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`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**any**
+
+### 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)
+
+
+## createInvite
+
+> InviteResponse createInvite(inviteUserRequest, ksUat)
+
+Create Invite
+
+Create an invite for a user to join a tenant (admin-only).  For external IdP tenants (idp_config is set), users are added directly if they exist. For shared IdP tenants (PASSWORD/GOOGLE), an email invite is sent that must be accepted.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitesApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateInviteRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new InvitesApi();
+
+  const body = {
+    // InviteUserRequest
+    inviteUserRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateInviteRequest;
+
+  try {
+    const data = await api.createInvite(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **inviteUserRequest** | [InviteUserRequest](InviteUserRequest.md) |  | |
+| **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 |
+|-------------|-------------|------------------|
+| **201** | 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)
+
+
+## deleteInvite
+
+> deleteInvite(inviteId, ksUat)
+
+Delete Invite
+
+Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitesApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteInviteRequest } 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,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteInviteRequest;
+
+  try {
+    const data = await api.deleteInvite(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`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | 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)
+
+
+## listInvites
+
+> PaginatedResponseInviteResponse listInvites(email, status, limit, offset, ksUat)
+
+List Invites Handler
+
+List invites with pagination, filtering, and sorting.  Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitesApi,
+} from '@knowledge-stack/ksapi';
+import type { ListInvitesRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new InvitesApi();
+
+  const body = {
+    // string | Filter by email (case-insensitive partial match) (optional)
+    email: email_example,
+    // InviteStatus | Filter by invite status (pending, accepted, expired) (optional)
+    status: ...,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListInvitesRequest;
+
+  try {
+    const data = await api.listInvites(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **email** | `string` | Filter by email (case-insensitive partial match) | [Optional] [Defaults to `undefined`] |
+| **status** | `InviteStatus` | Filter by invite status (pending, accepted, expired) | [Optional] [Defaults to `undefined`] [Enum: pending, accepted, expired] |
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedResponseInviteResponse**](PaginatedResponseInviteResponse.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/LineageEdgeResponse.md

@@ -0,0 +1,37 @@
+
+# LineageEdgeResponse
+
+An edge in the lineage graph.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentChunkId` | string
+`chunkId` | string
+
+## Example
+
+```typescript
+import type { LineageEdgeResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentChunkId": null,
+  "chunkId": null,
+} satisfies LineageEdgeResponse
+
+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 LineageEdgeResponse
+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/LineageGraphResponse.md

@@ -0,0 +1,37 @@
+
+# LineageGraphResponse
+
+Complete lineage graph with nodes and edges.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`nodes` | [Array<LineageNodeResponse>](LineageNodeResponse.md)
+`edges` | [Array<LineageEdgeResponse>](LineageEdgeResponse.md)
+
+## Example
+
+```typescript
+import type { LineageGraphResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "nodes": null,
+  "edges": null,
+} satisfies LineageGraphResponse
+
+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 LineageGraphResponse
+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/LineageNodeResponse.md

@@ -0,0 +1,47 @@
+
+# LineageNodeResponse
+
+A node in the lineage graph (enriched chunk).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`content` | string
+`chunkType` | [ChunkType](ChunkType.md)
+`chunkMetadata` | [ChunkMetadataOutput](ChunkMetadataOutput.md)
+`tenantId` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { LineageNodeResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "content": null,
+  "chunkType": null,
+  "chunkMetadata": null,
+  "tenantId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies LineageNodeResponse
+
+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 LineageNodeResponse
+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/LocationInner.md

@@ -0,0 +1,32 @@
+
+# LocationInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { LocationInner } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies LocationInner
+
+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 LocationInner
+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/MessageRole.md

@@ -0,0 +1,33 @@
+
+# MessageRole
+
+Role of message author in thread.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { MessageRole } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies MessageRole
+
+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 MessageRole
+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/OAuth2Config.md

@@ -0,0 +1,41 @@
+
+# OAuth2Config
+
+OAuth2 configuration.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clientId` | string
+`clientSecret` | string
+`serverMetadataUrl` | string
+`scope` | string
+
+## Example
+
+```typescript
+import type { OAuth2Config } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clientId": null,
+  "clientSecret": null,
+  "serverMetadataUrl": null,
+  "scope": null,
+} satisfies OAuth2Config
+
+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 OAuth2Config
+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/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<FolderResponseOrDocumentResponse>](FolderResponseOrDocumentResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator
+
+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 PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator
+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/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<SectionContentItemOrChunkContentItem>](SectionContentItemOrChunkContentItem.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator
+
+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 PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator
+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/PaginatedResponseDocumentResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseDocumentResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<DocumentResponse>](DocumentResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseDocumentResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseDocumentResponse
+
+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 PaginatedResponseDocumentResponse
+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)
+
+