@knowledge-stack/ksapi 1.153.0 → 1.155.0

package/docs/BulkDeleteApi.md

@@ -0,0 +1,84 @@
+# BulkDeleteApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**bulkDelete**](BulkDeleteApi.md#bulkdeleteoperation) | **POST** /v1/bulk-delete | Bulk Delete Handler |
+
+
+
+## bulkDelete
+
+> BulkOperationResponse bulkDelete(bulkDeleteRequest)
+
+Bulk Delete Handler
+
+Move the selected folders and documents to Trash, reporting per item.  Each id is soft-deleted in its own transaction: items the caller may not delete, that are approval-sealed, held by another user, contain an in-progress run, or sit inside another selected folder land in ``failed`` with a reason while the rest succeed. Over the selection cap returns ``400``.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BulkDeleteApi,
+} from '@knowledge-stack/ksapi';
+import type { BulkDeleteOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BulkDeleteApi(config);
+
+  const body = {
+    // BulkDeleteRequest
+    bulkDeleteRequest: ...,
+  } satisfies BulkDeleteOperationRequest;
+
+  try {
+    const data = await api.bulkDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **bulkDeleteRequest** | [BulkDeleteRequest](BulkDeleteRequest.md) |  | |
+
+### Return type
+
+[**BulkOperationResponse**](BulkOperationResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error 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/BulkDeleteRequest.md

@@ -0,0 +1,37 @@
+
+# BulkDeleteRequest
+
+Soft-delete the selected folders and documents to Trash.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`folderIds` | Array<string>
+`documentIds` | Array<string>
+
+## Example
+
+```typescript
+import type { BulkDeleteRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "folderIds": null,
+  "documentIds": null,
+} satisfies BulkDeleteRequest
+
+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 BulkDeleteRequest
+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/BulkFailureReason.md

@@ -0,0 +1,33 @@
+
+# BulkFailureReason
+
+Why a single item in a bulk operation was not applied.  Every value is produced by a specific, pre-checked gate — an *unexpected* per-item error is deliberately not caught (it surfaces as a 500) rather than hidden behind a vague catch-all.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { BulkFailureReason } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies BulkFailureReason
+
+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 BulkFailureReason
+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/BulkGrantItem.md

@@ -0,0 +1,41 @@
+
+# BulkGrantItem
+
+One requested grant: a capability on an object (PDO id) for a user.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`objectId` | string
+`capability` | [PermissionCapability](PermissionCapability.md)
+`canApprove` | boolean
+
+## Example
+
+```typescript
+import type { BulkGrantItem } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "objectId": null,
+  "capability": null,
+  "canApprove": null,
+} satisfies BulkGrantItem
+
+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 BulkGrantItem
+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/BulkGrantItemFailure.md

@@ -0,0 +1,39 @@
+
+# BulkGrantItemFailure
+
+A grant that could not be created, keyed on its (user, object) pair.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`objectId` | string
+`reason` | [BulkFailureReason](BulkFailureReason.md)
+
+## Example
+
+```typescript
+import type { BulkGrantItemFailure } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "objectId": null,
+  "reason": null,
+} satisfies BulkGrantItemFailure
+
+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 BulkGrantItemFailure
+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/BulkGrantRequest.md

@@ -0,0 +1,37 @@
+
+# BulkGrantRequest
+
+Grant many (user, object, capability) permissions in one request.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tenantId` | string
+`grants` | [Array<BulkGrantItem>](BulkGrantItem.md)
+
+## Example
+
+```typescript
+import type { BulkGrantRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tenantId": null,
+  "grants": null,
+} satisfies BulkGrantRequest
+
+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 BulkGrantRequest
+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/BulkGrantResponse.md

@@ -0,0 +1,37 @@
+
+# BulkGrantResponse
+
+Per-item outcome of a bulk grant (composite-keyed, unlike other bulks).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`succeeded` | [Array<BulkGrantSuccess>](BulkGrantSuccess.md)
+`failed` | [Array<BulkGrantItemFailure>](BulkGrantItemFailure.md)
+
+## Example
+
+```typescript
+import type { BulkGrantResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "succeeded": null,
+  "failed": null,
+} satisfies BulkGrantResponse
+
+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 BulkGrantResponse
+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/BulkGrantSuccess.md

@@ -0,0 +1,43 @@
+
+# BulkGrantSuccess
+
+A grant that was created, keyed on its (user, object) pair plus new id.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`objectId` | string
+`permissionId` | string
+`capability` | [PermissionCapability](PermissionCapability.md)
+`canApprove` | boolean
+
+## Example
+
+```typescript
+import type { BulkGrantSuccess } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "objectId": null,
+  "permissionId": null,
+  "capability": null,
+  "canApprove": null,
+} satisfies BulkGrantSuccess
+
+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 BulkGrantSuccess
+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/BulkItemFailure.md

@@ -0,0 +1,37 @@
+
+# BulkItemFailure
+
+A single id that could not be applied, and why.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`reason` | [BulkFailureReason](BulkFailureReason.md)
+
+## Example
+
+```typescript
+import type { BulkItemFailure } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "reason": null,
+} satisfies BulkItemFailure
+
+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 BulkItemFailure
+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/BulkMoveApi.md

@@ -0,0 +1,84 @@
+# BulkMoveApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**bulkMove**](BulkMoveApi.md#bulkmoveoperation) | **POST** /v1/bulk-move | Bulk Move Handler |
+
+
+
+## bulkMove
+
+> BulkOperationResponse bulkMove(bulkMoveRequest)
+
+Bulk Move Handler
+
+Move the selected folders and documents into ``target_folder_id``.  The destination is checked once up front — an invalid target returns ``400`` and a target the caller cannot write returns ``403``, before any item moves. Each source then moves in its own transaction; items the caller may not write, that are sealed, held by another user, that would form a cycle, hit a name collision, or sit inside another selected folder land in ``failed`` with a reason while the rest succeed.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BulkMoveApi,
+} from '@knowledge-stack/ksapi';
+import type { BulkMoveOperationRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BulkMoveApi(config);
+
+  const body = {
+    // BulkMoveRequest
+    bulkMoveRequest: ...,
+  } satisfies BulkMoveOperationRequest;
+
+  try {
+    const data = await api.bulkMove(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **bulkMoveRequest** | [BulkMoveRequest](BulkMoveRequest.md) |  | |
+
+### Return type
+
+[**BulkOperationResponse**](BulkOperationResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error 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/BulkMoveRequest.md

@@ -0,0 +1,39 @@
+
+# BulkMoveRequest
+
+Move the selected folders and documents into ``target_folder_id``.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`folderIds` | Array<string>
+`documentIds` | Array<string>
+`targetFolderId` | string
+
+## Example
+
+```typescript
+import type { BulkMoveRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "folderIds": null,
+  "documentIds": null,
+  "targetFolderId": null,
+} satisfies BulkMoveRequest
+
+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 BulkMoveRequest
+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/BulkOperationResponse.md

@@ -0,0 +1,37 @@
+
+# BulkOperationResponse
+
+Per-item outcome of a bulk operation keyed on a single PDO id.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`succeeded` | Array<string>
+`failed` | [Array<BulkItemFailure>](BulkItemFailure.md)
+
+## Example
+
+```typescript
+import type { BulkOperationResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "succeeded": null,
+  "failed": null,
+} satisfies BulkOperationResponse
+
+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 BulkOperationResponse
+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/BulkRevokeRequest.md

@@ -0,0 +1,37 @@
+
+# BulkRevokeRequest
+
+Revoke many permissions by their own permission-row ids.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tenantId` | string
+`permissionIds` | Array<string>
+
+## Example
+
+```typescript
+import type { BulkRevokeRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tenantId": null,
+  "permissionIds": null,
+} satisfies BulkRevokeRequest
+
+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 BulkRevokeRequest
+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/BulkTrashRequest.md

@@ -0,0 +1,35 @@
+
+# BulkTrashRequest
+
+Restore or permanently delete the selected trashed objects by PDO id.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`objectIds` | Array<string>
+
+## Example
+
+```typescript
+import type { BulkTrashRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "objectIds": null,
+} satisfies BulkTrashRequest
+
+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 BulkTrashRequest
+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/CreateUploadRequest.md

@@ -11,6 +11,7 @@ Name | Type
 `name` | string
 `filename` | string
 `sizeBytes` | number
+`tagIds` | Array<string>
 
 ## Example
 
@@ -23,6 +24,7 @@ const example = {
   "name": null,
   "filename": null,
   "sizeBytes": null,
+  "tagIds": null,
 } satisfies CreateUploadRequest
 
 console.log(example)

package/docs/DocumentVersionMetadata.md

@@ -17,6 +17,9 @@ Name | Type
 `totalPages` | number
 `totalSections` | number
 `totalChunks` | number
+`durationMs` | number
+`language` | string
+`segmentCount` | number
 `totalFormulas` | number
 `xlsxParseResultS3` | string
 `xlsxNamedRanges` | Array<{ [key: string]: any; }>
@@ -46,6 +49,9 @@ const example = {
   "totalPages": null,
   "totalSections": null,
   "totalChunks": null,
+  "durationMs": null,
+  "language": null,
+  "segmentCount": null,
   "totalFormulas": null,
   "xlsxParseResultS3": null,
   "xlsxNamedRanges": null,

package/docs/DocumentVersionMetadataUpdate.md

@@ -20,6 +20,9 @@ Name | Type
 `totalPages` | number
 `totalSections` | number
 `totalChunks` | number
+`durationMs` | number
+`language` | string
+`segmentCount` | number
 `totalFormulas` | number
 `xlsxParseResultS3` | string
 `xlsxNamedRanges` | Array<{ [key: string]: any; }>
@@ -51,6 +54,9 @@ const example = {
   "totalPages": null,
   "totalSections": null,
   "totalChunks": null,
+  "durationMs": null,
+  "language": null,
+  "segmentCount": null,
   "totalFormulas": null,
   "xlsxParseResultS3": null,
   "xlsxNamedRanges": null,