@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/docs/FoldersApi.md

@@ -0,0 +1,473 @@
+# FoldersApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createFolder**](FoldersApi.md#createfolderoperation) | **POST** /v1/folders | Create Folder Handler |
+| [**deleteFolder**](FoldersApi.md#deletefolder) | **DELETE** /v1/folders/{folder_id} | Delete Folder Handler |
+| [**getFolder**](FoldersApi.md#getfolder) | **GET** /v1/folders/{folder_id} | Get Folder Handler |
+| [**listFolderContents**](FoldersApi.md#listfoldercontents) | **GET** /v1/folders/{folder_id}/contents | List Folder Contents Handler |
+| [**listFolders**](FoldersApi.md#listfolders) | **GET** /v1/folders | List Folders Handler |
+| [**updateFolder**](FoldersApi.md#updatefolderoperation) | **PATCH** /v1/folders/{folder_id} | Update Folder Handler |
+
+
+
+## createFolder
+
+> FolderResponse createFolder(createFolderRequest, ksUat)
+
+Create Folder Handler
+
+Create a new folder.  The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoldersApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateFolderOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FoldersApi();
+
+  const body = {
+    // CreateFolderRequest
+    createFolderRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies CreateFolderOperationRequest;
+
+  try {
+    const data = await api.createFolder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createFolderRequest** | [CreateFolderRequest](CreateFolderRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FolderResponse**](FolderResponse.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)
+
+
+## deleteFolder
+
+> deleteFolder(folderId, ksUat)
+
+Delete Folder Handler
+
+Delete a folder and all its contents.  WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoldersApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteFolderRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FoldersApi();
+
+  const body = {
+    // string
+    folderId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteFolderRequest;
+
+  try {
+    const data = await api.deleteFolder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | `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)
+
+
+## getFolder
+
+> FolderResponse getFolder(folderId, withTags, ksUat)
+
+Get Folder Handler
+
+Get a folder by its folder ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoldersApi,
+} from '@knowledge-stack/ksapi';
+import type { GetFolderRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FoldersApi();
+
+  const body = {
+    // string
+    folderId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Include tags in the response (default: false) (optional)
+    withTags: true,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies GetFolderRequest;
+
+  try {
+    const data = await api.getFolder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | `string` |  | [Defaults to `undefined`] |
+| **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FolderResponse**](FolderResponse.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)
+
+
+## listFolderContents
+
+> PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator listFolderContents(folderId, maxDepth, sortOrder, withTags, limit, offset, ksUat)
+
+List Folder Contents Handler
+
+List all contents (folders and documents) under a folder.  Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\").  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoldersApi,
+} from '@knowledge-stack/ksapi';
+import type { ListFolderContentsRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FoldersApi();
+
+  const body = {
+    // string
+    folderId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number | Maximum depth to traverse (1=direct children, default: 1) (optional)
+    maxDepth: 56,
+    // PathOrder | Sort order for results (default: LOGICAL) (optional)
+    sortOrder: ...,
+    // boolean | Include tag IDs for each item (default: false) (optional)
+    withTags: true,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListFolderContentsRequest;
+
+  try {
+    const data = await api.listFolderContents(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | `string` |  | [Defaults to `undefined`] |
+| **maxDepth** | `number` | Maximum depth to traverse (1=direct children, default: 1) | [Optional] [Defaults to `1`] |
+| **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
+| **withTags** | `boolean` | Include tag IDs for each item (default: false) | [Optional] [Defaults to `false`] |
+| **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
+
+[**PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator**](PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.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)
+
+
+## listFolders
+
+> PaginatedResponseFolderResponse listFolders(parentPathPartId, sortOrder, withTags, limit, offset, ksUat)
+
+List Folders Handler
+
+List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders.  At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoldersApi,
+} from '@knowledge-stack/ksapi';
+import type { ListFoldersRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FoldersApi();
+
+  const body = {
+    // string | Parent PathPart ID (defaults to root) (optional)
+    parentPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PathOrder | Sort order for results (default: LOGICAL) (optional)
+    sortOrder: ...,
+    // boolean | Include tags in the response (default: false) (optional)
+    withTags: true,
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies ListFoldersRequest;
+
+  try {
+    const data = await api.listFolders(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **parentPathPartId** | `string` | Parent PathPart ID (defaults to root) | [Optional] [Defaults to `undefined`] |
+| **sortOrder** | `PathOrder` | Sort order for results (default: LOGICAL) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
+| **withTags** | `boolean` | Include tags in the response (default: false) | [Optional] [Defaults to `false`] |
+| **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
+
+[**PaginatedResponseFolderResponse**](PaginatedResponseFolderResponse.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)
+
+
+## updateFolder
+
+> FolderResponse updateFolder(folderId, updateFolderRequest, ksUat)
+
+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.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoldersApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateFolderOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new FoldersApi();
+
+  const body = {
+    // string
+    folderId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateFolderRequest
+    updateFolderRequest: ...,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies UpdateFolderOperationRequest;
+
+  try {
+    const data = await api.updateFolder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **folderId** | `string` |  | [Defaults to `undefined`] |
+| **updateFolderRequest** | [UpdateFolderRequest](UpdateFolderRequest.md) |  | |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**FolderResponse**](FolderResponse.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/HTTPValidationError.md

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

@@ -0,0 +1,36 @@
+
+# HealthCheckResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`databaseTs` | Date
+
+## Example
+
+```typescript
+import type { HealthCheckResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "databaseTs": null,
+} satisfies HealthCheckResponse
+
+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 HealthCheckResponse
+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/IdpType.md

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

@@ -0,0 +1,39 @@
+
+# IngestDocumentResponse
+
+Response with workflow execution details.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`workflowId` | string
+`documentId` | string
+`documentVersionId` | string
+
+## Example
+
+```typescript
+import type { IngestDocumentResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "workflowId": null,
+  "documentId": null,
+  "documentVersionId": null,
+} satisfies IngestDocumentResponse
+
+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 IngestDocumentResponse
+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

@@ -0,0 +1,53 @@
+
+# InviteResponse
+
+Invite response model.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`tenantId` | string
+`email` | string
+`role` | [TenantUserRole](TenantUserRole.md)
+`expiresAt` | Date
+`acceptedAt` | Date
+`createdAt` | Date
+`updatedAt` | Date
+`inviteLink` | string
+`emailId` | string
+
+## Example
+
+```typescript
+import type { InviteResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "tenantId": null,
+  "email": null,
+  "role": null,
+  "expiresAt": null,
+  "acceptedAt": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "inviteLink": null,
+  "emailId": null,
+} satisfies InviteResponse
+
+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 InviteResponse
+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/InviteStatus.md

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