@knowledge-stack/ksapi 1.23.4 → 1.24.0

package/src/apis/UserPermissionsApi.ts

@@ -67,6 +67,15 @@ export interface UpdateUserPermissionRequest {
  * @interface UserPermissionsApiInterface
  */
 export interface UserPermissionsApiInterface {
+    /**
+     * Creates request options for createUserPermission without sending the request
+     * @param {CreatePermissionRequest} createPermissionRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof UserPermissionsApiInterface
+     */
+    createUserPermissionRequestOpts(requestParameters: CreateUserPermissionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Create a path permission for a user in a tenant (admin/owner only).
      * @summary Create User Permission Handler
@@ -84,6 +93,16 @@ export interface UserPermissionsApiInterface {
      */
     createUserPermission(requestParameters: CreateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PermissionResponse>;
 
+    /**
+     * Creates request options for deleteUserPermission without sending the request
+     * @param {string} permissionId 
+     * @param {string} tenantId Tenant ID the permission belongs to
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof UserPermissionsApiInterface
+     */
+    deleteUserPermissionRequestOpts(requestParameters: DeleteUserPermissionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Delete a path permission (admin/owner only).
      * @summary Delete User Permission Handler
@@ -102,6 +121,18 @@ export interface UserPermissionsApiInterface {
      */
     deleteUserPermission(requestParameters: DeleteUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Creates request options for listUserPermissions without sending the request
+     * @param {string} tenantId Tenant ID to list permissions for
+     * @param {string} userId User ID to list permissions for
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof UserPermissionsApiInterface
+     */
+    listUserPermissionsRequestOpts(requestParameters: ListUserPermissionsRequest): Promise<runtime.RequestOpts>;
+
     /**
      * List path permissions for a user in a tenant (admin/owner only).
      * @summary List User Permissions Handler
@@ -122,6 +153,17 @@ export interface UserPermissionsApiInterface {
      */
     listUserPermissions(requestParameters: ListUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponsePermissionResponse>;
 
+    /**
+     * Creates request options for updateUserPermission without sending the request
+     * @param {string} permissionId 
+     * @param {string} tenantId Tenant ID the permission belongs to
+     * @param {UpdatePermissionRequest} updatePermissionRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof UserPermissionsApiInterface
+     */
+    updateUserPermissionRequestOpts(requestParameters: UpdateUserPermissionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Update a path permission (admin/owner only).
      * @summary Update User Permission Handler
@@ -149,10 +191,9 @@ export interface UserPermissionsApiInterface {
 export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissionsApiInterface {
 
     /**
-     * Create a path permission for a user in a tenant (admin/owner only).
-     * Create User Permission Handler
+     * Creates request options for createUserPermission without sending the request
      */
-    async createUserPermissionRaw(requestParameters: CreateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionResponse>> {
+    async createUserPermissionRequestOpts(requestParameters: CreateUserPermissionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['createPermissionRequest'] == null) {
             throw new runtime.RequiredError(
                 'createPermissionRequest',
@@ -169,13 +210,22 @@ export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissio
 
         let urlPath = `/v1/user-permissions`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: CreatePermissionRequestToJSON(requestParameters['createPermissionRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Create a path permission for a user in a tenant (admin/owner only).
+     * Create User Permission Handler
+     */
+    async createUserPermissionRaw(requestParameters: CreateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionResponse>> {
+        const requestOptions = await this.createUserPermissionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PermissionResponseFromJSON(jsonValue));
     }
@@ -190,10 +240,9 @@ export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissio
     }
 
     /**
-     * Delete a path permission (admin/owner only).
-     * Delete User Permission Handler
+     * Creates request options for deleteUserPermission without sending the request
      */
-    async deleteUserPermissionRaw(requestParameters: DeleteUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async deleteUserPermissionRequestOpts(requestParameters: DeleteUserPermissionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['permissionId'] == null) {
             throw new runtime.RequiredError(
                 'permissionId',
@@ -220,12 +269,21 @@ export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissio
         let urlPath = `/v1/user-permissions/{permission_id}`;
         urlPath = urlPath.replace(`{${"permission_id"}}`, encodeURIComponent(String(requestParameters['permissionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Delete a path permission (admin/owner only).
+     * Delete User Permission Handler
+     */
+    async deleteUserPermissionRaw(requestParameters: DeleteUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteUserPermissionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -239,10 +297,9 @@ export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissio
     }
 
     /**
-     * List path permissions for a user in a tenant (admin/owner only).
-     * List User Permissions Handler
+     * Creates request options for listUserPermissions without sending the request
      */
-    async listUserPermissionsRaw(requestParameters: ListUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePermissionResponse>> {
+    async listUserPermissionsRequestOpts(requestParameters: ListUserPermissionsRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['tenantId'] == null) {
             throw new runtime.RequiredError(
                 'tenantId',
@@ -280,12 +337,21 @@ export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissio
 
         let urlPath = `/v1/user-permissions`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * List path permissions for a user in a tenant (admin/owner only).
+     * List User Permissions Handler
+     */
+    async listUserPermissionsRaw(requestParameters: ListUserPermissionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponsePermissionResponse>> {
+        const requestOptions = await this.listUserPermissionsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponsePermissionResponseFromJSON(jsonValue));
     }
@@ -300,10 +366,9 @@ export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissio
     }
 
     /**
-     * Update a path permission (admin/owner only).
-     * Update User Permission Handler
+     * Creates request options for updateUserPermission without sending the request
      */
-    async updateUserPermissionRaw(requestParameters: UpdateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionResponse>> {
+    async updateUserPermissionRequestOpts(requestParameters: UpdateUserPermissionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['permissionId'] == null) {
             throw new runtime.RequiredError(
                 'permissionId',
@@ -339,13 +404,22 @@ export class UserPermissionsApi extends runtime.BaseAPI implements UserPermissio
         let urlPath = `/v1/user-permissions/{permission_id}`;
         urlPath = urlPath.replace(`{${"permission_id"}}`, encodeURIComponent(String(requestParameters['permissionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
             body: UpdatePermissionRequestToJSON(requestParameters['updatePermissionRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update a path permission (admin/owner only).
+     * Update User Permission Handler
+     */
+    async updateUserPermissionRaw(requestParameters: UpdateUserPermissionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PermissionResponse>> {
+        const requestOptions = await this.updateUserPermissionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PermissionResponseFromJSON(jsonValue));
     }

package/src/apis/UsersApi.ts

@@ -44,6 +44,14 @@ export interface UpdateMeRequest {
  * @interface UsersApiInterface
  */
 export interface UsersApiInterface {
+    /**
+     * Creates request options for getMe without sending the request
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    getMeRequestOpts(requestParameters: GetMeRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Get current user information including current tenant context.  Returns the authenticated user\'s profile along with their current tenant ID (from the UAT token) and default tenant ID (from user record).
      * @summary Get Me Handler
@@ -60,6 +68,15 @@ export interface UsersApiInterface {
      */
     getMe(requestParameters: GetMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
 
+    /**
+     * Creates request options for updateMe without sending the request
+     * @param {UpdateUserRequest} updateUserRequest 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof UsersApiInterface
+     */
+    updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Update the user\'s default tenant.  The user must belong to the specified tenant.
      * @summary Update Me Handler
@@ -85,10 +102,9 @@ export interface UsersApiInterface {
 export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
 
     /**
-     * Get current user information including current tenant context.  Returns the authenticated user\'s profile along with their current tenant ID (from the UAT token) and default tenant ID (from user record).
-     * Get Me Handler
+     * Creates request options for getMe without sending the request
      */
-    async getMeRaw(requestParameters: GetMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async getMeRequestOpts(requestParameters: GetMeRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -96,12 +112,21 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
 
         let urlPath = `/v1/users/me`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get current user information including current tenant context.  Returns the authenticated user\'s profile along with their current tenant ID (from the UAT token) and default tenant ID (from user record).
+     * Get Me Handler
+     */
+    async getMeRaw(requestParameters: GetMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.getMeRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }
@@ -116,10 +141,9 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
     }
 
     /**
-     * Update the user\'s default tenant.  The user must belong to the specified tenant.
-     * Update Me Handler
+     * Creates request options for updateMe without sending the request
      */
-    async updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['updateUserRequest'] == null) {
             throw new runtime.RequiredError(
                 'updateUserRequest',
@@ -136,13 +160,22 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
 
         let urlPath = `/v1/users`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
             body: UpdateUserRequestToJSON(requestParameters['updateUserRequest']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update the user\'s default tenant.  The user must belong to the specified tenant.
+     * Update Me Handler
+     */
+    async updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+        const requestOptions = await this.updateMeRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
     }

package/src/apis/WorkflowsApi.ts

@@ -58,6 +58,15 @@ export interface WorkflowActionRequest {
  * @interface WorkflowsApiInterface
  */
 export interface WorkflowsApiInterface {
+    /**
+     * Creates request options for getWorkflow without sending the request
+     * @param {string} workflowId 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    getWorkflowRequestOpts(requestParameters: GetWorkflowRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Get single workflow detail with live Temporal status.
      * @summary Get Workflow Handler
@@ -75,6 +84,16 @@ export interface WorkflowsApiInterface {
      */
     getWorkflow(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowDetailResponse>;
 
+    /**
+     * Creates request options for listWorkflows without sending the request
+     * @param {number} [limit] Number of items per page
+     * @param {number} [offset] Number of items to skip
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    listWorkflowsRequestOpts(requestParameters: ListWorkflowsRequest): Promise<runtime.RequestOpts>;
+
     /**
      * List all workflows for the current tenant (paginated, DB-backed).
      * @summary List Workflows Handler
@@ -93,6 +112,16 @@ export interface WorkflowsApiInterface {
      */
     listWorkflows(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseWorkflowSummaryResponse>;
 
+    /**
+     * Creates request options for workflowAction without sending the request
+     * @param {string} workflowId 
+     * @param {WorkflowAction} action Action to perform
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    workflowActionRequestOpts(requestParameters: WorkflowActionRequest): Promise<runtime.RequestOpts>;
+
     /**
      * Cancel or rerun a workflow (OWNER/ADMIN only).
      * @summary Workflow Action Handler
@@ -119,10 +148,9 @@ export interface WorkflowsApiInterface {
 export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterface {
 
     /**
-     * Get single workflow detail with live Temporal status.
-     * Get Workflow Handler
+     * Creates request options for getWorkflow without sending the request
      */
-    async getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>> {
+    async getWorkflowRequestOpts(requestParameters: GetWorkflowRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['workflowId'] == null) {
             throw new runtime.RequiredError(
                 'workflowId',
@@ -138,12 +166,21 @@ export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterfa
         let urlPath = `/v1/workflows/{workflow_id}`;
         urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get single workflow detail with live Temporal status.
+     * Get Workflow Handler
+     */
+    async getWorkflowRaw(requestParameters: GetWorkflowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowDetailResponse>> {
+        const requestOptions = await this.getWorkflowRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowDetailResponseFromJSON(jsonValue));
     }
@@ -158,10 +195,9 @@ export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterfa
     }
 
     /**
-     * List all workflows for the current tenant (paginated, DB-backed).
-     * List Workflows Handler
+     * Creates request options for listWorkflows without sending the request
      */
-    async listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>> {
+    async listWorkflowsRequestOpts(requestParameters: ListWorkflowsRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         if (requestParameters['limit'] != null) {
@@ -177,12 +213,21 @@ export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterfa
 
         let urlPath = `/v1/workflows`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * List all workflows for the current tenant (paginated, DB-backed).
+     * List Workflows Handler
+     */
+    async listWorkflowsRaw(requestParameters: ListWorkflowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseWorkflowSummaryResponse>> {
+        const requestOptions = await this.listWorkflowsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseWorkflowSummaryResponseFromJSON(jsonValue));
     }
@@ -197,10 +242,9 @@ export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterfa
     }
 
     /**
-     * Cancel or rerun a workflow (OWNER/ADMIN only).
-     * Workflow Action Handler
+     * Creates request options for workflowAction without sending the request
      */
-    async workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>> {
+    async workflowActionRequestOpts(requestParameters: WorkflowActionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['workflowId'] == null) {
             throw new runtime.RequiredError(
                 'workflowId',
@@ -227,12 +271,21 @@ export class WorkflowsApi extends runtime.BaseAPI implements WorkflowsApiInterfa
         let urlPath = `/v1/workflows/{workflow_id}`;
         urlPath = urlPath.replace(`{${"workflow_id"}}`, encodeURIComponent(String(requestParameters['workflowId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Cancel or rerun a workflow (OWNER/ADMIN only).
+     * Workflow Action Handler
+     */
+    async workflowActionRaw(requestParameters: WorkflowActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowActionResponse>> {
+        const requestOptions = await this.workflowActionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowActionResponseFromJSON(jsonValue));
     }