@knowledge-stack/ksapi 1.95.3 → 1.96.0

package/docs/TrashApi.md

@@ -0,0 +1,236 @@
+# TrashApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listTrash**](TrashApi.md#listtrash) | **GET** /v1/trash | List Trash Handler |
+| [**permanentlyDeleteTrashItem**](TrashApi.md#permanentlydeletetrashitem) | **DELETE** /v1/trash/{path_part_id} | Permanently Delete Trash Item Handler |
+| [**restoreTrashItem**](TrashApi.md#restoretrashitem) | **POST** /v1/trash/{path_part_id}/restore | Restore Trash Item Handler |
+
+
+
+## listTrash
+
+> PaginatedResponseTrashItemResponse listTrash(limit, offset)
+
+List Trash Handler
+
+List top-level trash items visible to the caller.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TrashApi,
+} from '@knowledge-stack/ksapi';
+import type { ListTrashRequest } 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 TrashApi(config);
+
+  const body = {
+    // number | Number of items per page (optional)
+    limit: 56,
+    // number | Number of items to skip (optional)
+    offset: 56,
+  } satisfies ListTrashRequest;
+
+  try {
+    const data = await api.listTrash(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
+
+### Return type
+
+[**PaginatedResponseTrashItemResponse**](PaginatedResponseTrashItemResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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)
+
+
+## permanentlyDeleteTrashItem
+
+> permanentlyDeleteTrashItem(pathPartId)
+
+Permanently Delete Trash Item Handler
+
+Permanently delete a top-level trash item.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TrashApi,
+} from '@knowledge-stack/ksapi';
+import type { PermanentlyDeleteTrashItemRequest } 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 TrashApi(config);
+
+  const body = {
+    // string | Trashed PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PermanentlyDeleteTrashItemRequest;
+
+  try {
+    const data = await api.permanentlyDeleteTrashItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Trashed PathPart ID | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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)
+
+
+## restoreTrashItem
+
+> restoreTrashItem(pathPartId)
+
+Restore Trash Item Handler
+
+Restore a top-level trash item.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TrashApi,
+} from '@knowledge-stack/ksapi';
+import type { RestoreTrashItemRequest } 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 TrashApi(config);
+
+  const body = {
+    // string | Trashed PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies RestoreTrashItemRequest;
+
+  try {
+    const data = await api.restoreTrashItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Trashed PathPart ID | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### 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)
+

package/docs/TrashItemResponse.md

@@ -0,0 +1,49 @@
+
+# TrashItemResponse
+
+A top-level item currently in trash.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pathPartId` | string
+`metadataObjId` | string
+`partType` | [PartType](PartType.md)
+`name` | string
+`parentPathPartId` | string
+`materializedPath` | string
+`deletedAt` | Date
+`deletedBy` | string
+
+## Example
+
+```typescript
+import type { TrashItemResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pathPartId": null,
+  "metadataObjId": null,
+  "partType": null,
+  "name": null,
+  "parentPathPartId": null,
+  "materializedPath": null,
+  "deletedAt": null,
+  "deletedBy": null,
+} satisfies TrashItemResponse
+
+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 TrashItemResponse
+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/UpdateGroupPermissionRequest.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `pathPartId` | string
 `capability` | [PermissionCapability](PermissionCapability.md)
+`canApprove` | boolean
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { UpdateGroupPermissionRequest } from '@knowledge-stack/ksapi'
 const example = {
   "pathPartId": null,
   "capability": null,
+  "canApprove": null,
 } satisfies UpdateGroupPermissionRequest
 
 console.log(example)

package/docs/UpdatePermissionRequest.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `pathPartId` | string
 `capability` | [PermissionCapability](PermissionCapability.md)
+`canApprove` | boolean
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { UpdatePermissionRequest } from '@knowledge-stack/ksapi'
 const example = {
   "pathPartId": null,
   "capability": null,
+  "canApprove": null,
 } satisfies UpdatePermissionRequest
 
 console.log(example)

package/docs/UpdateTableRequest.md

@@ -0,0 +1,37 @@
+
+# UpdateTableRequest
+
+Field-modeling update for a modeled table (PATCH).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`columnConfig` | [Array<ColumnConfig>](ColumnConfig.md)
+
+## Example
+
+```typescript
+import type { UpdateTableRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "columnConfig": null,
+} satisfies UpdateTableRequest
+
+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 UpdateTableRequest
+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

@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## createUserPermission
 
-> PermissionResponse createUserPermission(createPermissionRequest, authorization, ksUat)
+> PermissionResponse createUserPermission(createPermissionRequest)
 
 Create User Permission Handler
 
@@ -30,15 +30,17 @@ import type { CreateUserPermissionRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new UserPermissionsApi();
+  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 UserPermissionsApi(config);
 
   const body = {
     // CreatePermissionRequest
     createPermissionRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies CreateUserPermissionRequest;
 
   try {
@@ -59,8 +61,6 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **createPermissionRequest** | [CreatePermissionRequest](CreatePermissionRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -68,7 +68,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -87,7 +87,7 @@ No authorization required
 
 ## deleteUserPermission
 
-> deleteUserPermission(permissionId, tenantId, authorization, ksUat)
+> deleteUserPermission(permissionId, tenantId)
 
 Delete User Permission Handler
 
@@ -104,17 +104,19 @@ import type { DeleteUserPermissionRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new UserPermissionsApi();
+  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 UserPermissionsApi(config);
 
   const body = {
     // string
     permissionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // string | Tenant ID the permission belongs to
     tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies DeleteUserPermissionRequest;
 
   try {
@@ -136,8 +138,6 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **permissionId** | `string` |  | [Defaults to `undefined`] |
 | **tenantId** | `string` | Tenant ID the permission belongs to | [Defaults to `undefined`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -145,7 +145,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -164,7 +164,7 @@ No authorization required
 
 ## listUserPermissions
 
-> PaginatedResponsePermissionResponse listUserPermissions(tenantId, userId, limit, offset, authorization, ksUat)
+> PaginatedResponsePermissionResponse listUserPermissions(tenantId, userId, limit, offset)
 
 List User Permissions Handler
 
@@ -181,7 +181,13 @@ import type { ListUserPermissionsRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new UserPermissionsApi();
+  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 UserPermissionsApi(config);
 
   const body = {
     // string | Tenant ID to list permissions for
@@ -192,10 +198,6 @@ async function example() {
     limit: 56,
     // number | Number of items to skip (optional)
     offset: 56,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies ListUserPermissionsRequest;
 
   try {
@@ -219,8 +221,6 @@ example().catch(console.error);
 | **userId** | `string` | User ID to list permissions for | [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`] |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -228,7 +228,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers
 
@@ -247,7 +247,7 @@ No authorization required
 
 ## updateUserPermission
 
-> PermissionResponse updateUserPermission(permissionId, tenantId, updatePermissionRequest, authorization, ksUat)
+> PermissionResponse updateUserPermission(permissionId, tenantId, updatePermissionRequest)
 
 Update User Permission Handler
 
@@ -264,7 +264,13 @@ import type { UpdateUserPermissionRequest } from '@knowledge-stack/ksapi';
 
 async function example() {
   console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
-  const api = new UserPermissionsApi();
+  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 UserPermissionsApi(config);
 
   const body = {
     // string
@@ -273,10 +279,6 @@ async function example() {
     tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // UpdatePermissionRequest
     updatePermissionRequest: ...,
-    // string (optional)
-    authorization: authorization_example,
-    // string (optional)
-    ksUat: ksUat_example,
   } satisfies UpdateUserPermissionRequest;
 
   try {
@@ -299,8 +301,6 @@ example().catch(console.error);
 | **permissionId** | `string` |  | [Defaults to `undefined`] |
 | **tenantId** | `string` | Tenant ID the permission belongs to | [Defaults to `undefined`] |
 | **updatePermissionRequest** | [UpdatePermissionRequest](UpdatePermissionRequest.md) |  | |
-| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -308,7 +308,7 @@ example().catch(console.error);
 
 ### Authorization
 
-No authorization required
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
 
 ### HTTP request headers