@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/docs/CreatePermissionRequest.md

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

@@ -0,0 +1,41 @@
+
+# CreateSectionRequest
+
+Request to create a new section.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`parentPathId` | string
+`pageNumber` | number
+`prevSiblingPathId` | string
+
+## Example
+
+```typescript
+import type { CreateSectionRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "parentPathId": null,
+  "pageNumber": null,
+  "prevSiblingPathId": null,
+} satisfies CreateSectionRequest
+
+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 CreateSectionRequest
+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/CreateTagRequest.md

@@ -0,0 +1,39 @@
+
+# CreateTagRequest
+
+Request to create a new tag.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`color` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { CreateTagRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "color": null,
+  "description": null,
+} satisfies CreateTagRequest
+
+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 CreateTagRequest
+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/CreateTenantRequest.md

@@ -0,0 +1,37 @@
+
+# CreateTenantRequest
+
+Create tenant request model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`idpConfig` | [OAuth2Config](OAuth2Config.md)
+
+## Example
+
+```typescript
+import type { CreateTenantRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "idpConfig": null,
+} satisfies CreateTenantRequest
+
+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 CreateTenantRequest
+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/CreateThreadMessageRequest.md

@@ -0,0 +1,37 @@
+
+# CreateThreadMessageRequest
+
+Request to create a new thread message.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`role` | [MessageRole](MessageRole.md)
+`content` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { CreateThreadMessageRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "role": null,
+  "content": null,
+} satisfies CreateThreadMessageRequest
+
+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 CreateThreadMessageRequest
+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/CreateThreadRequest.md

@@ -0,0 +1,37 @@
+
+# CreateThreadRequest
+
+Request to create a new thread.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`parentPathPartId` | string
+`title` | string
+
+## Example
+
+```typescript
+import type { CreateThreadRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "parentPathPartId": null,
+  "title": null,
+} satisfies CreateThreadRequest
+
+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 CreateThreadRequest
+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/DefaultApi.md

@@ -0,0 +1,128 @@
+# DefaultApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**healthCheck**](DefaultApi.md#healthcheck) | **GET** /healthz | Health Check Handler |
+| [**hello**](DefaultApi.md#hello) | **GET** / | Root Handler |
+
+
+
+## healthCheck
+
+> HealthCheckResponse healthCheck()
+
+Health Check Handler
+
+Health check endpoint.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@knowledge-stack/ksapi';
+import type { HealthCheckRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DefaultApi();
+
+  try {
+    const data = await api.healthCheck();
+    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
+
+[**HealthCheckResponse**](HealthCheckResponse.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)
+
+
+## hello
+
+> RootResponse hello()
+
+Root Handler
+
+Root endpoint.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DefaultApi,
+} from '@knowledge-stack/ksapi';
+import type { HelloRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new DefaultApi();
+
+  try {
+    const data = await api.hello();
+    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
+
+[**RootResponse**](RootResponse.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/DocumentOrigin.md

@@ -0,0 +1,33 @@
+
+# DocumentOrigin
+
+Origin of document - source/purpose (all origins are first-class).
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DocumentOrigin } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DocumentOrigin
+
+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 DocumentOrigin
+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/DocumentResponse.md

@@ -0,0 +1,63 @@
+
+# DocumentResponse
+
+Document response model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`partType` | string
+`id` | string
+`pathPartId` | string
+`name` | string
+`parentPathPartId` | string
+`documentType` | [DocumentType](DocumentType.md)
+`documentOrigin` | [DocumentOrigin](DocumentOrigin.md)
+`activeVersionId` | string
+`activeVersion` | [DocumentVersionResponse](DocumentVersionResponse.md)
+`materializedPath` | string
+`systemManaged` | boolean
+`tenantId` | string
+`createdAt` | Date
+`updatedAt` | Date
+`tags` | [Array<TagResponse>](TagResponse.md)
+
+## Example
+
+```typescript
+import type { DocumentResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "partType": null,
+  "id": null,
+  "pathPartId": null,
+  "name": null,
+  "parentPathPartId": null,
+  "documentType": null,
+  "documentOrigin": null,
+  "activeVersionId": null,
+  "activeVersion": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "tenantId": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "tags": null,
+} satisfies DocumentResponse
+
+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 DocumentResponse
+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/DocumentType.md

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

@@ -0,0 +1,47 @@
+
+# DocumentVersionMetadata
+
+Schema for document_version.metadata JSONB field.  Tracks S3 URLs for generated artifacts, pipeline execution state, and document statistics. Convention-based paths (images, page screenshots) are derived from document_id/document_version_id via s3_paths helpers, using a flat S3 layout: documents/{document_id}/{document_version_id}/...
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sourceS3` | string
+`cleanedSourceS3` | string
+`doclingJsonS3` | string
+`pipelineState` | [PipelineState](PipelineState.md)
+`totalPages` | number
+`totalSections` | number
+`totalChunks` | number
+
+## Example
+
+```typescript
+import type { DocumentVersionMetadata } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sourceS3": null,
+  "cleanedSourceS3": null,
+  "doclingJsonS3": null,
+  "pipelineState": null,
+  "totalPages": null,
+  "totalSections": null,
+  "totalChunks": null,
+} satisfies DocumentVersionMetadata
+
+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 DocumentVersionMetadata
+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/DocumentVersionMetadataUpdate.md

@@ -0,0 +1,47 @@
+
+# DocumentVersionMetadataUpdate
+
+Partial update schema for document version metadata.  All fields are optional.  Only non-``None`` fields are merged into the existing metadata dict.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sourceS3` | string
+`cleanedSourceS3` | string
+`doclingJsonS3` | string
+`pipelineState` | [PipelineState](PipelineState.md)
+`totalPages` | number
+`totalSections` | number
+`totalChunks` | number
+
+## Example
+
+```typescript
+import type { DocumentVersionMetadataUpdate } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sourceS3": null,
+  "cleanedSourceS3": null,
+  "doclingJsonS3": null,
+  "pipelineState": null,
+  "totalPages": null,
+  "totalSections": null,
+  "totalChunks": null,
+} satisfies DocumentVersionMetadataUpdate
+
+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 DocumentVersionMetadataUpdate
+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/DocumentVersionResponse.md

@@ -0,0 +1,57 @@
+
+# DocumentVersionResponse
+
+DocumentVersion response model.  Shared schema for DocumentVersion responses, used by Document endpoints and DocumentVersion endpoints.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`pathPartId` | string
+`version` | number
+`name` | string
+`parentPathId` | string
+`materializedPath` | string
+`systemManaged` | boolean
+`tenantId` | string
+`createdAt` | Date
+`updatedAt` | Date
+`assetS3Url` | string
+`metadata` | [DocumentVersionMetadata](DocumentVersionMetadata.md)
+
+## Example
+
+```typescript
+import type { DocumentVersionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "pathPartId": null,
+  "version": null,
+  "name": null,
+  "parentPathId": null,
+  "materializedPath": null,
+  "systemManaged": null,
+  "tenantId": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "assetS3Url": null,
+  "metadata": null,
+} satisfies DocumentVersionResponse
+
+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 DocumentVersionResponse
+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)
+
+