@knowledge-stack/ksapi 1.83.0 → 1.84.0

package/src/apis/PathPartsApi.ts

@@ -16,8 +16,11 @@
 import * as runtime from '../runtime';
 import type {
   AncestryResponse,
+  AppendEventRequest,
   BulkTagRequest,
+  EventResponse,
   HTTPValidationError,
+  PaginatedResponseEventResponse,
   PaginatedResponsePathPartResponse,
   PathOrder,
   PathPartResponse,
@@ -27,10 +30,16 @@ import type {
 import {
     AncestryResponseFromJSON,
     AncestryResponseToJSON,
+    AppendEventRequestFromJSON,
+    AppendEventRequestToJSON,
     BulkTagRequestFromJSON,
     BulkTagRequestToJSON,
+    EventResponseFromJSON,
+    EventResponseToJSON,
     HTTPValidationErrorFromJSON,
     HTTPValidationErrorToJSON,
+    PaginatedResponseEventResponseFromJSON,
+    PaginatedResponseEventResponseToJSON,
     PaginatedResponsePathPartResponseFromJSON,
     PaginatedResponsePathPartResponseToJSON,
     PathOrderFromJSON,
@@ -43,6 +52,13 @@ import {
     SubtreeChunksResponseToJSON,
 } from '../models/index';
 
+export interface AppendPathPartEventRequest {
+    pathPartId: string;
+    appendEventRequest: AppendEventRequest;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
 export interface BulkRemovePathPartTagsRequest {
     pathPartId: string;
     bulkTagRequest: BulkTagRequest;
@@ -75,6 +91,18 @@ export interface GetPathPartTagsRequest {
     ksUat?: string | null;
 }
 
+export interface ListPathPartEventsRequest {
+    pathPartId: string;
+    kind?: string | null;
+    since?: Date | null;
+    until?: Date | null;
+    recursive?: boolean;
+    limit?: number;
+    offset?: number;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
 export interface ListPathPartsRequest {
     parentPathId?: string | null;
     maxDepth?: number;
@@ -99,6 +127,36 @@ export interface SetPathPartTagsRequest {
  * @interface PathPartsApiInterface
  */
 export interface PathPartsApiInterface {
+    /**
+     * Creates request options for appendPathPartEvent without sending the request
+     * @param {string} pathPartId 
+     * @param {AppendEventRequest} appendEventRequest 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    appendPathPartEventRequestOpts(requestParameters: AppendPathPartEventRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Record an event for a subject path_part from the frontend.  Auth: caller must hold ``can_write`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Server stamps ``actor_user_id`` from the caller\'s identity — callers cannot impersonate other users on the audit trail.  ``kind`` is free-form text but reserved server namespaces (``workflow.``, ``document.``, ``folder.``, ``permission.``, ``connector.``, ``query.``, ``auth.``, ``tenant.``) are rejected at 422 so clients cannot forge server-emitted audit events. Clients should namespace under ``client.*``. ``payload`` is capped at 64KB encoded JSON.
+     * @summary Append Path Part Event Handler
+     * @param {string} pathPartId 
+     * @param {AppendEventRequest} appendEventRequest 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    appendPathPartEventRaw(requestParameters: AppendPathPartEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EventResponse>>;
+
+    /**
+     * Record an event for a subject path_part from the frontend.  Auth: caller must hold ``can_write`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Server stamps ``actor_user_id`` from the caller\'s identity — callers cannot impersonate other users on the audit trail.  ``kind`` is free-form text but reserved server namespaces (``workflow.``, ``document.``, ``folder.``, ``permission.``, ``connector.``, ``query.``, ``auth.``, ``tenant.``) are rejected at 422 so clients cannot forge server-emitted audit events. Clients should namespace under ``client.*``. ``payload`` is capped at 64KB encoded JSON.
+     * Append Path Part Event Handler
+     */
+    appendPathPartEvent(requestParameters: AppendPathPartEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EventResponse>;
+
     /**
      * Creates request options for bulkRemovePathPartTags without sending the request
      * @param {string} pathPartId 
@@ -243,6 +301,46 @@ export interface PathPartsApiInterface {
      */
     getPathPartTags(requestParameters: GetPathPartTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PathPartTagsResponse>;
 
+    /**
+     * Creates request options for listPathPartEvents without sending the request
+     * @param {string} pathPartId 
+     * @param {string} [kind] Filter to a single event kind
+     * @param {Date} [since] Only events at or after this timestamp
+     * @param {Date} [until] Only events strictly before this timestamp
+     * @param {boolean} [recursive] Include events from descendant path_parts as well as the subject itself
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    listPathPartEventsRequestOpts(requestParameters: ListPathPartEventsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * List events anchored to a specific path_part subject.  Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated.  When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
+     * @summary List Path Part Events Handler
+     * @param {string} pathPartId 
+     * @param {string} [kind] Filter to a single event kind
+     * @param {Date} [since] Only events at or after this timestamp
+     * @param {Date} [until] Only events strictly before this timestamp
+     * @param {boolean} [recursive] Include events from descendant path_parts as well as the subject itself
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PathPartsApiInterface
+     */
+    listPathPartEventsRaw(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseEventResponse>>;
+
+    /**
+     * List events anchored to a specific path_part subject.  Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated.  When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
+     * List Path Part Events Handler
+     */
+    listPathPartEvents(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseEventResponse>;
+
     /**
      * Creates request options for listPathParts without sending the request
      * @param {string} [parentPathId] Parent PathPart ID (defaults to root)
@@ -316,6 +414,67 @@ export interface PathPartsApiInterface {
  */
 export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterface {
 
+    /**
+     * Creates request options for appendPathPartEvent without sending the request
+     */
+    async appendPathPartEventRequestOpts(requestParameters: AppendPathPartEventRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling appendPathPartEvent().'
+            );
+        }
+
+        if (requestParameters['appendEventRequest'] == null) {
+            throw new runtime.RequiredError(
+                'appendEventRequest',
+                'Required parameter "appendEventRequest" was null or undefined when calling appendPathPartEvent().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/path-parts/{path_part_id}/events`;
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AppendEventRequestToJSON(requestParameters['appendEventRequest']),
+        };
+    }
+
+    /**
+     * Record an event for a subject path_part from the frontend.  Auth: caller must hold ``can_write`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Server stamps ``actor_user_id`` from the caller\'s identity — callers cannot impersonate other users on the audit trail.  ``kind`` is free-form text but reserved server namespaces (``workflow.``, ``document.``, ``folder.``, ``permission.``, ``connector.``, ``query.``, ``auth.``, ``tenant.``) are rejected at 422 so clients cannot forge server-emitted audit events. Clients should namespace under ``client.*``. ``payload`` is capped at 64KB encoded JSON.
+     * Append Path Part Event Handler
+     */
+    async appendPathPartEventRaw(requestParameters: AppendPathPartEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EventResponse>> {
+        const requestOptions = await this.appendPathPartEventRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => EventResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Record an event for a subject path_part from the frontend.  Auth: caller must hold ``can_write`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Server stamps ``actor_user_id`` from the caller\'s identity — callers cannot impersonate other users on the audit trail.  ``kind`` is free-form text but reserved server namespaces (``workflow.``, ``document.``, ``folder.``, ``permission.``, ``connector.``, ``query.``, ``auth.``, ``tenant.``) are rejected at 422 so clients cannot forge server-emitted audit events. Clients should namespace under ``client.*``. ``payload`` is capped at 64KB encoded JSON.
+     * Append Path Part Event Handler
+     */
+    async appendPathPartEvent(requestParameters: AppendPathPartEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EventResponse> {
+        const response = await this.appendPathPartEventRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for bulkRemovePathPartTags without sending the request
      */
@@ -585,6 +744,81 @@ export class PathPartsApi extends runtime.BaseAPI implements PathPartsApiInterfa
         return await response.value();
     }
 
+    /**
+     * Creates request options for listPathPartEvents without sending the request
+     */
+    async listPathPartEventsRequestOpts(requestParameters: ListPathPartEventsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling listPathPartEvents().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['kind'] != null) {
+            queryParameters['kind'] = requestParameters['kind'];
+        }
+
+        if (requestParameters['since'] != null) {
+            queryParameters['since'] = (requestParameters['since'] as any).toISOString();
+        }
+
+        if (requestParameters['until'] != null) {
+            queryParameters['until'] = (requestParameters['until'] as any).toISOString();
+        }
+
+        if (requestParameters['recursive'] != null) {
+            queryParameters['recursive'] = requestParameters['recursive'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/path-parts/{path_part_id}/events`;
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List events anchored to a specific path_part subject.  Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated.  When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
+     * List Path Part Events Handler
+     */
+    async listPathPartEventsRaw(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseEventResponse>> {
+        const requestOptions = await this.listPathPartEventsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseEventResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List events anchored to a specific path_part subject.  Subject permission is enforced via the existing ``PathPermissionService`` — caller must have ``can_read`` on the subject\'s materialized_path (OWNER/ADMIN bypass). Events are ordered newest-first by ``ts`` and paginated.  When ``recursive=True``, events on any descendant of the subject are included — useful for \"all events under this folder\" or \"all events under this workflow definition\".
+     * List Path Part Events Handler
+     */
+    async listPathPartEvents(requestParameters: ListPathPartEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseEventResponse> {
+        const response = await this.listPathPartEventsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listPathParts without sending the request
      */