@knowledge-stack/ksapi 1.101.1 → 1.102.0

package/docs/ThreadsApi.md

@@ -84,6 +84,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **201** | 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)
 
@@ -158,6 +159,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **204** | 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)
 
@@ -232,13 +234,14 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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)
 
 
 ## listThreads
 
-> PaginatedResponseThreadResponse listThreads(parentPathPartId, limit, offset)
+> PaginatedResponseThreadResponse listThreads(parentPathPartId, sortBy, sortDir, titleLike, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
 
 List Threads Handler
 
@@ -266,10 +269,24 @@ async function example() {
   const body = {
     // string | Parent PathPart ID. Omit to list user\'s conversation threads. (optional)
     parentPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ThreadOrder | Field to sort threads by (default: CREATED_AT) (optional)
+    sortBy: ...,
+    // SortDirection | Sort direction; overrides the field\'s natural default (optional)
+    sortDir: ...,
+    // string | Case-insensitive substring filter on title (optional)
+    titleLike: titleLike_example,
     // number | Number of items per page (optional)
     limit: 56,
     // number | Number of items to skip (optional)
     offset: 56,
+    // Date | Only items created at or after this timestamp (inclusive) (optional)
+    createdAfter: 2013-10-20T19:20:30+01:00,
+    // Date | Only items created strictly before this timestamp (optional)
+    createdBefore: 2013-10-20T19:20:30+01:00,
+    // Date | Only items updated at or after this timestamp (inclusive) (optional)
+    updatedAfter: 2013-10-20T19:20:30+01:00,
+    // Date | Only items updated strictly before this timestamp (optional)
+    updatedBefore: 2013-10-20T19:20:30+01:00,
   } satisfies ListThreadsRequest;
 
   try {
@@ -290,8 +307,15 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **parentPathPartId** | `string` | Parent PathPart ID. Omit to list user\'s conversation threads. | [Optional] [Defaults to `undefined`] |
+| **sortBy** | `ThreadOrder` | Field to sort threads by (default: CREATED_AT) | [Optional] [Defaults to `undefined`] [Enum: CREATED_AT, UPDATED_AT] |
+| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
+| **titleLike** | `string` | Case-insensitive substring filter on title | [Optional] [Defaults to `undefined`] |
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
+| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
+| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
+| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -312,6 +336,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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)
 
@@ -389,6 +414,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **202** | 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)
 
@@ -469,6 +495,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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)
 
@@ -546,6 +573,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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/TransferOwnerRequest.md

@@ -0,0 +1,35 @@
+
+# TransferOwnerRequest
+
+Transfer a path_part\'s ownership to another tenant member.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`newOwnerUserId` | string
+
+## Example
+
+```typescript
+import type { TransferOwnerRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "newOwnerUserId": null,
+} satisfies TransferOwnerRequest
+
+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 TransferOwnerRequest
+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/TransferOwnerResponse.md

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

@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## listTrash
 
-> PaginatedResponseTrashItemResponse listTrash(limit, offset)
+> PaginatedResponseTrashItemResponse listTrash(sortOrder, sortDir, deletedBy, partType, ownerId, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
 
 List Trash Handler
 
@@ -38,10 +38,28 @@ async function example() {
   const api = new TrashApi(config);
 
   const body = {
+    // PathOrder | Sort order (default: LOGICAL = deletion recency) (optional)
+    sortOrder: ...,
+    // SortDirection | Sort direction; overrides the column\'s natural default (optional)
+    sortDir: ...,
+    // string | Filter to items deleted by this user (optional)
+    deletedBy: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Array<PartType> | Filter to these path-part types (folders, documents, ...) (optional)
+    partType: ...,
+    // string | Filter to items owned (created) by this user (optional)
+    ownerId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // number | Number of items per page (optional)
     limit: 56,
     // number | Number of items to skip (optional)
     offset: 56,
+    // Date | Only items created at or after this timestamp (inclusive) (optional)
+    createdAfter: 2013-10-20T19:20:30+01:00,
+    // Date | Only items created strictly before this timestamp (optional)
+    createdBefore: 2013-10-20T19:20:30+01:00,
+    // Date | Only items updated at or after this timestamp (inclusive) (optional)
+    updatedAfter: 2013-10-20T19:20:30+01:00,
+    // Date | Only items updated strictly before this timestamp (optional)
+    updatedBefore: 2013-10-20T19:20:30+01:00,
   } satisfies ListTrashRequest;
 
   try {
@@ -61,8 +79,17 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **sortOrder** | `PathOrder` | Sort order (default: LOGICAL &#x3D; deletion recency) | [Optional] [Defaults to `undefined`] [Enum: LOGICAL, NAME, UPDATED_AT, CREATED_AT] |
+| **sortDir** | `SortDirection` | Sort direction; overrides the column\&#39;s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
+| **deletedBy** | `string` | Filter to items deleted by this user | [Optional] [Defaults to `undefined`] |
+| **partType** | `Array<PartType>` | Filter to these path-part types (folders, documents, ...) | [Optional] |
+| **ownerId** | `string` | Filter to items owned (created) by this user | [Optional] [Defaults to `undefined`] |
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+| **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
+| **createdBefore** | `Date` | Only items created strictly before this timestamp | [Optional] [Defaults to `undefined`] |
+| **updatedAfter** | `Date` | Only items updated at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |
+| **updatedBefore** | `Date` | Only items updated strictly before this timestamp | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -83,6 +110,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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)
 
@@ -157,6 +185,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **204** | 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)
 
@@ -231,6 +260,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **204** | 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/TrashItemResponse.md

@@ -15,6 +15,7 @@ Name | Type
 `materializedPath` | string
 `deletedAt` | Date
 `deletedBy` | string
+`owner` | [UserInfo](UserInfo.md)
 
 ## Example
 
@@ -31,6 +32,7 @@ const example = {
   "materializedPath": null,
   "deletedAt": null,
   "deletedBy": null,
+  "owner": null,
 } satisfies TrashItemResponse
 
 console.log(example)

package/docs/UpdateApiConnectionRequest.md

@@ -0,0 +1,43 @@
+
+# UpdateApiConnectionRequest
+
+Partial update (PATCH). A risk-increasing change re-arms the disclaimer.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`baseUrl` | string
+`networkClass` | [NetworkClass](NetworkClass.md)
+`verifyTls` | boolean
+`authConfig` | [ApiAuthConfig](ApiAuthConfig.md)
+`apiDocs` | string
+
+## Example
+
+```typescript
+import type { UpdateApiConnectionRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "baseUrl": null,
+  "networkClass": null,
+  "verifyTls": null,
+  "authConfig": null,
+  "apiDocs": null,
+} satisfies UpdateApiConnectionRequest
+
+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 UpdateApiConnectionRequest
+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/UserPermissionOrder.md

@@ -0,0 +1,33 @@
+
+# UserPermissionOrder
+
+Sortable fields for user permission listings.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { UserPermissionOrder } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies UserPermissionOrder
+
+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 UserPermissionOrder
+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/UserPermissionsApi.md

@@ -81,6 +81,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **201** | 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)
 
@@ -158,13 +159,14 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **204** | 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)
 
 
 ## listUserPermissions
 
-> PaginatedResponsePermissionResponse listUserPermissions(tenantId, userId, limit, offset)
+> PaginatedResponsePermissionResponse listUserPermissions(tenantId, userId, sortBy, sortDir, capability, limit, offset)
 
 List User Permissions Handler
 
@@ -194,6 +196,12 @@ async function example() {
     tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string | User ID to list permissions for
     userId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UserPermissionOrder | Field to sort permissions by (default: CREATED_AT) (optional)
+    sortBy: ...,
+    // SortDirection | Sort direction; overrides the field\'s natural default (optional)
+    sortDir: ...,
+    // PermissionCapability | Filter to a single capability level (optional)
+    capability: ...,
     // number | Number of items per page (optional)
     limit: 56,
     // number | Number of items to skip (optional)
@@ -219,6 +227,9 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **tenantId** | `string` | Tenant ID to list permissions for | [Defaults to `undefined`] |
 | **userId** | `string` | User ID to list permissions for | [Defaults to `undefined`] |
+| **sortBy** | `UserPermissionOrder` | Field to sort permissions by (default: CREATED_AT) | [Optional] [Defaults to `undefined`] [Enum: CREATED_AT, CAPABILITY] |
+| **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
+| **capability** | `PermissionCapability` | Filter to a single capability level | [Optional] [Defaults to `undefined`] [Enum: READ_ONLY, READ_WRITE, READ_WRITE_DELETE] |
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
 
@@ -241,6 +252,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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)
 
@@ -321,6 +333,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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/UsersApi.md

@@ -73,6 +73,7 @@ This endpoint does not need any parameter.
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
+| **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)
 
@@ -138,6 +139,7 @@ This endpoint does not need any parameter.
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Successful Response |  -  |
+| **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)
 
@@ -212,6 +214,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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)
 
@@ -286,6 +289,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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)
 
@@ -360,6 +364,7 @@ example().catch(console.error);
 |-------------|-------------|------------------|
 | **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/WorkflowAdoptionStats.md

@@ -0,0 +1,39 @@
+
+# WorkflowAdoptionStats
+
+Adoption proxies for a workflow-runs summary.  These are deliberately labelled \"adoption\", not \"value\" — they measure how much the system is used, not the business value it produced (which is not derivable from any column we store).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`runs` | number
+`activeDefinitions` | number
+`distinctTriggerers` | number
+
+## Example
+
+```typescript
+import type { WorkflowAdoptionStats } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "runs": null,
+  "activeDefinitions": null,
+  "distinctTriggerers": null,
+} satisfies WorkflowAdoptionStats
+
+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 WorkflowAdoptionStats
+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/WorkflowDefinitionOrder.md

@@ -0,0 +1,33 @@
+
+# WorkflowDefinitionOrder
+
+Sortable fields for workflow-definition listings (time only for now).
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { WorkflowDefinitionOrder } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies WorkflowDefinitionOrder
+
+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 WorkflowDefinitionOrder
+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/WorkflowDefinitionResponse.md

@@ -19,7 +19,11 @@ Name | Type
 `instructionPathPartId` | string
 `isActive` | boolean
 `approvalRequired` | boolean
+`isTemplate` | boolean
+`createdFromId` | string
+`copyCount` | number
 `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
+`owner` | [UserInfo](UserInfo.md)
 `createdAt` | Date
 `updatedAt` | Date
 `permissions` | [ItemPermissions](ItemPermissions.md)
@@ -43,7 +47,11 @@ const example = {
   "instructionPathPartId": null,
   "isActive": null,
   "approvalRequired": null,
+  "isTemplate": null,
+  "createdFromId": null,
+  "copyCount": null,
   "approvalState": null,
+  "owner": null,
   "createdAt": null,
   "updatedAt": null,
   "permissions": null,