@knowledge-stack/ksapi 1.23.5 → 1.25.0

package/dist/apis/FoldersApi.js

@@ -30,10 +30,9 @@ const index_1 = require("../models/index");
  */
 class FoldersApi extends runtime.BaseAPI {
     /**
-     * Create a new folder.  The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
-     * Create Folder Handler
+     * Creates request options for createFolder without sending the request
      */
-    createFolderRaw(requestParameters, initOverrides) {
+    createFolderRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['createFolderRequest'] == null) {
                 throw new runtime.RequiredError('createFolderRequest', 'Required parameter "createFolderRequest" was null or undefined when calling createFolder().');
@@ -42,13 +41,23 @@ class FoldersApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/v1/folders`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.CreateFolderRequestToJSON)(requestParameters['createFolderRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Create a new folder.  The folder is created as a child of the specified parent folder. It is automatically added to the end of the parent\'s children list.
+     * Create Folder Handler
+     */
+    createFolderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createFolderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FolderResponseFromJSON)(jsonValue));
         });
     }
@@ -63,10 +72,9 @@ class FoldersApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Delete a folder and all its contents.  WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
-     * Delete Folder Handler
+     * Creates request options for deleteFolder without sending the request
      */
-    deleteFolderRaw(requestParameters, initOverrides) {
+    deleteFolderRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['folderId'] == null) {
                 throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling deleteFolder().');
@@ -75,12 +83,22 @@ class FoldersApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/folders/{folder_id}`;
             urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'DELETE',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Delete a folder and all its contents.  WARNING: This cascades to all children due to parent_id ON DELETE CASCADE. The root folder cannot be deleted.
+     * Delete Folder Handler
+     */
+    deleteFolderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteFolderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -94,10 +112,9 @@ class FoldersApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a folder by its folder ID.
-     * Get Folder Handler
+     * Creates request options for getFolder without sending the request
      */
-    getFolderRaw(requestParameters, initOverrides) {
+    getFolderRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['folderId'] == null) {
                 throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling getFolder().');
@@ -109,12 +126,22 @@ class FoldersApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/folders/{folder_id}`;
             urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Get a folder by its folder ID.
+     * Get Folder Handler
+     */
+    getFolderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getFolderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FolderResponseFromJSON)(jsonValue));
         });
     }
@@ -129,10 +156,9 @@ class FoldersApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
-     * List Folder Contents Handler
+     * Creates request options for listFolderContents without sending the request
      */
-    listFolderContentsRaw(requestParameters, initOverrides) {
+    listFolderContentsRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['folderId'] == null) {
                 throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling listFolderContents().');
@@ -156,17 +182,27 @@ class FoldersApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/folders/{folder_id}/contents`;
             urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseFolderDocumentResponseFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * List all contents (folders and documents) under a folder.  Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\").  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
+     * List Folder Contents Handler
+     */
+    listFolderContentsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listFolderContentsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminatorFromJSON)(jsonValue));
         });
     }
     /**
-     * List all contents (folders and documents) under a folder.  Returns enriched responses with: - Folders: basic folder metadata - Documents: full document metadata including document_type, document_origin, active_version  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
+     * List all contents (folders and documents) under a folder.  Returns a discriminated union of FolderResponse and DocumentResponse items, distinguished by the `part_type` field (\"FOLDER\" or \"DOCUMENT\").  When with_tags=true, each item includes a tags field with the full tag objects.  This is the preferred way to list folder contents when you need document metadata. For generic path traversal of folders only, use GET /path-parts.
      * List Folder Contents Handler
      */
     listFolderContents(requestParameters, initOverrides) {
@@ -176,10 +212,9 @@ class FoldersApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders.  At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
-     * List Folders Handler
+     * Creates request options for listFolders without sending the request
      */
-    listFoldersRaw(requestParameters, initOverrides) {
+    listFoldersRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['parentPathPartId'] != null) {
@@ -199,12 +234,22 @@ class FoldersApi extends runtime.BaseAPI {
             }
             const headerParameters = {};
             let urlPath = `/v1/folders`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders.  At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
+     * List Folders Handler
+     */
+    listFoldersRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listFoldersRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseFolderResponseFromJSON)(jsonValue));
         });
     }
@@ -219,10 +264,9 @@ class FoldersApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Update a folder (rename and/or move).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. Both can be done in a single request.
-     * Update Folder Handler
+     * Creates request options for updateFolder without sending the request
      */
-    updateFolderRaw(requestParameters, initOverrides) {
+    updateFolderRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['folderId'] == null) {
                 throw new runtime.RequiredError('folderId', 'Required parameter "folderId" was null or undefined when calling updateFolder().');
@@ -235,13 +279,23 @@ class FoldersApi extends runtime.BaseAPI {
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/v1/folders/{folder_id}`;
             urlPath = urlPath.replace(`{${"folder_id"}}`, encodeURIComponent(String(requestParameters['folderId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'PATCH',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.UpdateFolderRequestToJSON)(requestParameters['updateFolderRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Update a folder (rename and/or move).  To rename: provide `name` field. To move: provide `parent_path_part_id` field. Both can be done in a single request.
+     * Update Folder Handler
+     */
+    updateFolderRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateFolderRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FolderResponseFromJSON)(jsonValue));
         });
     }

package/dist/apis/InvitesApi.d.ts

@@ -37,6 +37,14 @@ export interface ListInvitesRequest {
  * @interface InvitesApiInterface
  */
 export interface InvitesApiInterface {
+    /**
+     * Creates request options for acceptInvite without sending the request
+     * @param {string} inviteId
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof InvitesApiInterface
+     */
+    acceptInviteRequestOpts(requestParameters: AcceptInviteRequest): Promise<runtime.RequestOpts>;
     /**
      * Update an invite to accepted status and create tenant user.
      * @summary Accept Invite
@@ -52,6 +60,14 @@ export interface InvitesApiInterface {
      * Accept Invite
      */
     acceptInvite(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * Creates request options for createInvite without sending the request
+     * @param {InviteUserRequest} inviteUserRequest
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof InvitesApiInterface
+     */
+    createInviteRequestOpts(requestParameters: CreateInviteRequest): Promise<runtime.RequestOpts>;
     /**
      * Create an invite for a user to join a tenant (admin-only).  For external IdP tenants (idp_config is set), users are added directly if they exist. For shared IdP tenants (PASSWORD/GOOGLE), an email invite is sent that must be accepted.
      * @summary Create Invite
@@ -67,6 +83,14 @@ export interface InvitesApiInterface {
      * Create Invite
      */
     createInvite(requestParameters: CreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteResponse>;
+    /**
+     * Creates request options for deleteInvite without sending the request
+     * @param {string} inviteId
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof InvitesApiInterface
+     */
+    deleteInviteRequestOpts(requestParameters: DeleteInviteRequest): Promise<runtime.RequestOpts>;
     /**
      * Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
      * @summary Delete Invite
@@ -82,6 +106,17 @@ export interface InvitesApiInterface {
      * Delete Invite
      */
     deleteInvite(requestParameters: DeleteInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listInvites without sending the request
+     * @param {string} [email] Filter by email (case-insensitive partial match)
+     * @param {InviteStatus} [status] Filter by invite status (pending, accepted, expired)
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat]
+     * @throws {RequiredError}
+     * @memberof InvitesApiInterface
+     */
+    listInvitesRequestOpts(requestParameters: ListInvitesRequest): Promise<runtime.RequestOpts>;
     /**
      * List invites with pagination, filtering, and sorting.  Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
      * @summary List Invites Handler
@@ -105,6 +140,10 @@ export interface InvitesApiInterface {
  *
  */
 export declare class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
+    /**
+     * Creates request options for acceptInvite without sending the request
+     */
+    acceptInviteRequestOpts(requestParameters: AcceptInviteRequest): Promise<runtime.RequestOpts>;
     /**
      * Update an invite to accepted status and create tenant user.
      * Accept Invite
@@ -115,6 +154,10 @@ export declare class InvitesApi extends runtime.BaseAPI implements InvitesApiInt
      * Accept Invite
      */
     acceptInvite(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * Creates request options for createInvite without sending the request
+     */
+    createInviteRequestOpts(requestParameters: CreateInviteRequest): Promise<runtime.RequestOpts>;
     /**
      * Create an invite for a user to join a tenant (admin-only).  For external IdP tenants (idp_config is set), users are added directly if they exist. For shared IdP tenants (PASSWORD/GOOGLE), an email invite is sent that must be accepted.
      * Create Invite
@@ -125,6 +168,10 @@ export declare class InvitesApi extends runtime.BaseAPI implements InvitesApiInt
      * Create Invite
      */
     createInvite(requestParameters: CreateInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteResponse>;
+    /**
+     * Creates request options for deleteInvite without sending the request
+     */
+    deleteInviteRequestOpts(requestParameters: DeleteInviteRequest): Promise<runtime.RequestOpts>;
     /**
      * Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
      * Delete Invite
@@ -135,6 +182,10 @@ export declare class InvitesApi extends runtime.BaseAPI implements InvitesApiInt
      * Delete Invite
      */
     deleteInvite(requestParameters: DeleteInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listInvites without sending the request
+     */
+    listInvitesRequestOpts(requestParameters: ListInvitesRequest): Promise<runtime.RequestOpts>;
     /**
      * List invites with pagination, filtering, and sorting.  Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
      * List Invites Handler

package/dist/apis/InvitesApi.js

@@ -30,10 +30,9 @@ const index_1 = require("../models/index");
  */
 class InvitesApi extends runtime.BaseAPI {
     /**
-     * Update an invite to accepted status and create tenant user.
-     * Accept Invite
+     * Creates request options for acceptInvite without sending the request
      */
-    acceptInviteRaw(requestParameters, initOverrides) {
+    acceptInviteRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['inviteId'] == null) {
                 throw new runtime.RequiredError('inviteId', 'Required parameter "inviteId" was null or undefined when calling acceptInvite().');
@@ -42,12 +41,22 @@ class InvitesApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/invites/{invite_id}/accept`;
             urlPath = urlPath.replace(`{${"invite_id"}}`, encodeURIComponent(String(requestParameters['inviteId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Update an invite to accepted status and create tenant user.
+     * Accept Invite
+     */
+    acceptInviteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.acceptInviteRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             if (this.isJsonMime(response.headers.get('content-type'))) {
                 return new runtime.JSONApiResponse(response);
             }
@@ -67,10 +76,9 @@ class InvitesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Create an invite for a user to join a tenant (admin-only).  For external IdP tenants (idp_config is set), users are added directly if they exist. For shared IdP tenants (PASSWORD/GOOGLE), an email invite is sent that must be accepted.
-     * Create Invite
+     * Creates request options for createInvite without sending the request
      */
-    createInviteRaw(requestParameters, initOverrides) {
+    createInviteRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['inviteUserRequest'] == null) {
                 throw new runtime.RequiredError('inviteUserRequest', 'Required parameter "inviteUserRequest" was null or undefined when calling createInvite().');
@@ -79,13 +87,23 @@ class InvitesApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/v1/invites`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.InviteUserRequestToJSON)(requestParameters['inviteUserRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Create an invite for a user to join a tenant (admin-only).  For external IdP tenants (idp_config is set), users are added directly if they exist. For shared IdP tenants (PASSWORD/GOOGLE), an email invite is sent that must be accepted.
+     * Create Invite
+     */
+    createInviteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createInviteRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.InviteResponseFromJSON)(jsonValue));
         });
     }
@@ -100,10 +118,9 @@ class InvitesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
-     * Delete Invite
+     * Creates request options for deleteInvite without sending the request
      */
-    deleteInviteRaw(requestParameters, initOverrides) {
+    deleteInviteRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['inviteId'] == null) {
                 throw new runtime.RequiredError('inviteId', 'Required parameter "inviteId" was null or undefined when calling deleteInvite().');
@@ -112,12 +129,22 @@ class InvitesApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/v1/invites/{invite_id}`;
             urlPath = urlPath.replace(`{${"invite_id"}}`, encodeURIComponent(String(requestParameters['inviteId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'DELETE',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Hard-delete an invite (admin/owner only).  Permanently removes the invite. The invite must belong to the caller\'s current tenant.
+     * Delete Invite
+     */
+    deleteInviteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteInviteRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -131,10 +158,9 @@ class InvitesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List invites with pagination, filtering, and sorting.  Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
-     * List Invites Handler
+     * Creates request options for listInvites without sending the request
      */
-    listInvitesRaw(requestParameters, initOverrides) {
+    listInvitesRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['email'] != null) {
@@ -151,12 +177,22 @@ class InvitesApi extends runtime.BaseAPI {
             }
             const headerParameters = {};
             let urlPath = `/v1/invites`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * List invites with pagination, filtering, and sorting.  Supports filtering by tenant_id (requires admin access), email, and status. Results can be sorted by created_at, updated_at, expires_at, or accepted_at.
+     * List Invites Handler
+     */
+    listInvitesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listInvitesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedResponseInviteResponseFromJSON)(jsonValue));
         });
     }