@knowledge-stack/ksapi 1.101.2 → 1.102.0

package/docs/ApiConnectionsApi.md

@@ -0,0 +1,397 @@
+# ApiConnectionsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**acceptApiConnectionDisclaimer**](ApiConnectionsApi.md#acceptapiconnectiondisclaimer) | **POST** /v1/api-connections/{connection_id}/disclaimer | Accept Api Connection Disclaimer Handler |
+| [**createApiConnection**](ApiConnectionsApi.md#createapiconnectionoperation) | **POST** /v1/api-connections | Create Api Connection Handler |
+| [**executeApiConnectionRequest**](ApiConnectionsApi.md#executeapiconnectionrequest) | **POST** /v1/api-connections/{connection_id}/request | Execute Api Connection Request Handler |
+| [**getApiConnection**](ApiConnectionsApi.md#getapiconnection) | **GET** /v1/api-connections/{connection_id} | Get Api Connection Handler |
+| [**updateApiConnection**](ApiConnectionsApi.md#updateapiconnectionoperation) | **PATCH** /v1/api-connections/{connection_id} | Update Api Connection Handler |
+
+
+
+## acceptApiConnectionDisclaimer
+
+> ApiConnectionResponse acceptApiConnectionDisclaimer(connectionId, acceptDisclaimerRequest)
+
+Accept Api Connection Disclaimer Handler
+
+Accept the egress disclaimer (Admin/Owner).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiConnectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { AcceptApiConnectionDisclaimerRequest } 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 ApiConnectionsApi(config);
+
+  const body = {
+    // string
+    connectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AcceptDisclaimerRequest
+    acceptDisclaimerRequest: ...,
+  } satisfies AcceptApiConnectionDisclaimerRequest;
+
+  try {
+    const data = await api.acceptApiConnectionDisclaimer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **connectionId** | `string` |  | [Defaults to `undefined`] |
+| **acceptDisclaimerRequest** | [AcceptDisclaimerRequest](AcceptDisclaimerRequest.md) |  | |
+
+### Return type
+
+[**ApiConnectionResponse**](ApiConnectionResponse.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)
+
+
+## createApiConnection
+
+> ApiConnectionResponse createApiConnection(createApiConnectionRequest)
+
+Create Api Connection Handler
+
+Create a connection under a writable folder (Admin/Owner; egress on).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiConnectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { CreateApiConnectionOperationRequest } 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 ApiConnectionsApi(config);
+
+  const body = {
+    // CreateApiConnectionRequest
+    createApiConnectionRequest: ...,
+  } satisfies CreateApiConnectionOperationRequest;
+
+  try {
+    const data = await api.createApiConnection(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createApiConnectionRequest** | [CreateApiConnectionRequest](CreateApiConnectionRequest.md) |  | |
+
+### Return type
+
+[**ApiConnectionResponse**](ApiConnectionResponse.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 |
+|-------------|-------------|------------------|
+| **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)
+
+
+## executeApiConnectionRequest
+
+> ApiConnectionRequestResponse executeApiConnectionRequest(connectionId, apiConnectionRequestRequest)
+
+Execute Api Connection Request Handler
+
+Execute a safe, audited outbound request (all gates run in the service).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiConnectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { ExecuteApiConnectionRequestRequest } 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 ApiConnectionsApi(config);
+
+  const body = {
+    // string
+    connectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ApiConnectionRequestRequest
+    apiConnectionRequestRequest: ...,
+  } satisfies ExecuteApiConnectionRequestRequest;
+
+  try {
+    const data = await api.executeApiConnectionRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **connectionId** | `string` |  | [Defaults to `undefined`] |
+| **apiConnectionRequestRequest** | [ApiConnectionRequestRequest](ApiConnectionRequestRequest.md) |  | |
+
+### Return type
+
+[**ApiConnectionRequestResponse**](ApiConnectionRequestResponse.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)
+
+
+## getApiConnection
+
+> ApiConnectionResponse getApiConnection(connectionId)
+
+Get Api Connection Handler
+
+Get a connection (no secret); requires read access.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiConnectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { GetApiConnectionRequest } 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 ApiConnectionsApi(config);
+
+  const body = {
+    // string
+    connectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetApiConnectionRequest;
+
+  try {
+    const data = await api.getApiConnection(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **connectionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiConnectionResponse**](ApiConnectionResponse.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 |  -  |
+| **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)
+
+
+## updateApiConnection
+
+> ApiConnectionResponse updateApiConnection(connectionId, updateApiConnectionRequest)
+
+Update Api Connection Handler
+
+Update a connection (Admin/Owner). A risk-up change re-arms the disclaimer.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiConnectionsApi,
+} from '@knowledge-stack/ksapi';
+import type { UpdateApiConnectionOperationRequest } 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 ApiConnectionsApi(config);
+
+  const body = {
+    // string
+    connectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateApiConnectionRequest
+    updateApiConnectionRequest: ...,
+  } satisfies UpdateApiConnectionOperationRequest;
+
+  try {
+    const data = await api.updateApiConnection(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **connectionId** | `string` |  | [Defaults to `undefined`] |
+| **updateApiConnectionRequest** | [UpdateApiConnectionRequest](UpdateApiConnectionRequest.md) |  | |
+
+### Return type
+
+[**ApiConnectionResponse**](ApiConnectionResponse.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/ApiKeyResponse.md

@@ -11,6 +11,8 @@ Name | Type
 `name` | string
 `keySuffix` | string
 `createdAt` | Date
+`expiresAt` | Date
+`lastUsedAt` | Date
 
 ## Example
 
@@ -23,6 +25,8 @@ const example = {
   "name": null,
   "keySuffix": null,
   "createdAt": null,
+  "expiresAt": null,
+  "lastUsedAt": null,
 } satisfies ApiKeyResponse
 
 console.log(example)

package/docs/ApiKeysApi.md

@@ -79,6 +79,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)
 
@@ -151,6 +152,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)
 
@@ -223,6 +225,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 @@ 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)
 

package/docs/AuditEventsApi.md

@@ -4,13 +4,104 @@ All URIs are relative to *http://localhost:8000*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**exportAuditEvents**](AuditEventsApi.md#exportauditevents) | **GET** /v1/audit-events/export | Export Audit Events Handler |
 | [**listAuditEvents**](AuditEventsApi.md#listauditevents) | **GET** /v1/audit-events | List Audit Events Handler |
 
 
 
+## exportAuditEvents
+
+> Blob exportAuditEvents(actorUserId, kind, since, until, subjectPathPartId, recursive)
+
+Export Audit Events Handler
+
+Export the tenant\'s audit events as a CSV download (admin/owner only).  Same filters as ``list_audit_events`` but unpaginated — streams every matching event newest-first. Each row resolves the actor\'s name and the subject\'s name + path so an auditor can read the file directly in Excel.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuditEventsApi,
+} from '@knowledge-stack/ksapi';
+import type { ExportAuditEventsRequest } 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 AuditEventsApi(config);
+
+  const body = {
+    // string | Filter to one actor (optional)
+    actorUserId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Filter to one event kind (optional)
+    kind: kind_example,
+    // Date | Only events at or after this timestamp (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Only events strictly before this timestamp (optional)
+    until: 2013-10-20T19:20:30+01:00,
+    // string | Scope to one document/folder/run subject (optional)
+    subjectPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // boolean | Include the subject\'s descendants (needs subject) (optional)
+    recursive: true,
+  } satisfies ExportAuditEventsRequest;
+
+  try {
+    const data = await api.exportAuditEvents(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **actorUserId** | `string` | Filter to one actor | [Optional] [Defaults to `undefined`] |
+| **kind** | `string` | Filter to one event kind | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Only events at or after this timestamp | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Only events strictly before this timestamp | [Optional] [Defaults to `undefined`] |
+| **subjectPathPartId** | `string` | Scope to one document/folder/run subject | [Optional] [Defaults to `undefined`] |
+| **recursive** | `boolean` | Include the subject\'s descendants (needs subject) | [Optional] [Defaults to `false`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/csv`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Audit events as a UTF-8 CSV download (BOM-prefixed so Excel renders Chinese and English correctly). |  -  |
+| **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)
+
+
 ## listAuditEvents
 
-> PaginatedResponseEventResponse listAuditEvents(actorUserId, kind, since, until, subjectPathPartId, recursive, limit, offset)
+> PaginatedResponseEventResponse listAuditEvents(actorUserId, kind, since, until, subjectPathPartId, recursive, sortDir, limit, offset)
 
 List Audit Events Handler
 
@@ -48,6 +139,8 @@ async function example() {
     subjectPathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // boolean | Include the subject\'s descendants (needs subject) (optional)
     recursive: true,
+    // SortDirection | Sort by timestamp (default: DESC, newest first) (optional)
+    sortDir: ...,
     // number | Number of items per page (optional)
     limit: 56,
     // number | Number of items to skip (optional)
@@ -77,6 +170,7 @@ example().catch(console.error);
 | **until** | `Date` | Only events strictly before this timestamp | [Optional] [Defaults to `undefined`] |
 | **subjectPathPartId** | `string` | Scope to one document/folder/run subject | [Optional] [Defaults to `undefined`] |
 | **recursive** | `boolean` | Include the subject\'s descendants (needs subject) | [Optional] [Defaults to `false`] |
+| **sortDir** | `SortDirection` | Sort by timestamp (default: DESC, newest first) | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
 
@@ -99,6 +193,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)