whio-api-sdk 1.1.28 → 1.1.29

package/src/sdk/modules/template.module.ts

@@ -6,7 +6,6 @@ import {
   UpdateTemplateDto,
   CreateTemplateCategoryDto,
   UpdateTemplateCategoryDto,
-  TranscriptionAudioUploadResponse,
   SummaryQueueType,
 } from '../types';
 import urls from '../urls';
@@ -16,6 +15,17 @@ export class TemplateModule extends BaseClient {
   // TEMPLATE METHODS
   // ======================
 
+  /**
+   * Create a template for the current user's organization, defaulting to the first category if none is given.
+   *
+   * @param title - Title of the template.
+   * @param content - Body content of the template.
+   * @param categoryId - Optional category UUID; the first available category is used when omitted.
+   * @param workflowId - Optional workflow UUID to associate with the template.
+   * @param agentId - Optional agent UUID to associate with the template.
+   * @param summaryQueueType - Optional queue type (PRIMARY or SECONDARY) for generated summaries.
+   * @returns The created template.
+   */
   public async createTemplate(title: string, content: string, categoryId?: string, workflowId?: string, agentId?: string, summaryQueueType?: SummaryQueueType): Promise<Template> {
     let finalCategoryId = categoryId;
     if (!finalCategoryId) {
@@ -43,6 +53,17 @@ export class TemplateModule extends BaseClient {
     return this.request<Template>(urls.templates, 'POST', createTemplateDto);
   }
 
+  /**
+   * Update an existing template.
+   *
+   * @param title - New title of the template.
+   * @param content - New body content of the template.
+   * @param id - UUID of the template to update.
+   * @param workflowId - Optional workflow UUID to associate with the template.
+   * @param agentId - Optional agent UUID to associate with the template.
+   * @param summaryQueueType - Optional queue type (PRIMARY or SECONDARY), or null to clear it.
+   * @returns The updated template.
+   */
   public async updateTemplate(title: string, content: string, id: string, workflowId?: string, agentId?: string, summaryQueueType?: SummaryQueueType | null): Promise<Template> {
     const templateDto: UpdateTemplateDto = {
       title,
@@ -56,18 +77,40 @@ export class TemplateModule extends BaseClient {
     return this.request<Template>(`${urls.templates}/${id}`, 'PATCH', templateDto);
   }
 
+  /**
+   * Retrieve all templates accessible to the current user.
+   *
+   * @returns An array of templates.
+   */
   public async getTemplates(): Promise<Template[]> {
     return this.request<Template[]>(urls.templates, 'GET');
   }
 
+  /**
+   * Retrieve all templates belonging to the current user's organization.
+   *
+   * @returns An array of templates.
+   */
   public async getTemplatesByOrganization(): Promise<Template[]> {
     return this.request<Template[]>(`${urls.templates}/organization`, 'GET');
   }
 
+  /**
+   * Retrieve a single template by id.
+   *
+   * @param id - UUID of the template.
+   * @returns The requested template.
+   */
   public async getTemplate(id: string): Promise<Template> {
     return this.request<Template>(`${urls.templates}/${id}`, 'GET');
   }
 
+  /**
+   * Delete a template by id.
+   *
+   * @param id - UUID of the template to delete.
+   * @returns A promise that resolves once the template is deleted.
+   */
   public async deleteTemplate(id: string): Promise<void> {
     await this.request(`${urls.templates}/${id}`, 'DELETE');
   }
@@ -76,6 +119,13 @@ export class TemplateModule extends BaseClient {
   // TEMPLATE INTEGRATION ACTION METHODS
   // ======================
 
+  /**
+   * Replace the full set of integration actions linked to a template.
+   *
+   * @param templateId - UUID of the template.
+   * @param integrationActionIds - The complete list of integration action UUIDs to set.
+   * @returns The updated template.
+   */
   public async setTemplateIntegrationActions(templateId: string, integrationActionIds: string[]): Promise<Template> {
     return this.request<Template>(
       `${urls.templates}/${templateId}/integration-actions`,
@@ -84,6 +134,13 @@ export class TemplateModule extends BaseClient {
     );
   }
 
+  /**
+   * Add integration actions to a template without removing existing ones.
+   *
+   * @param templateId - UUID of the template.
+   * @param integrationActionIds - The integration action UUIDs to add.
+   * @returns The updated template.
+   */
   public async addTemplateIntegrationActions(templateId: string, integrationActionIds: string[]): Promise<Template> {
     return this.request<Template>(
       `${urls.templates}/${templateId}/integration-actions`,
@@ -92,6 +149,13 @@ export class TemplateModule extends BaseClient {
     );
   }
 
+  /**
+   * Remove integration actions from a template.
+   *
+   * @param templateId - UUID of the template.
+   * @param integrationActionIds - The integration action UUIDs to remove.
+   * @returns The updated template.
+   */
   public async removeTemplateIntegrationActions(templateId: string, integrationActionIds: string[]): Promise<Template> {
     return this.request<Template>(
       `${urls.templates}/${templateId}/integration-actions`,
@@ -104,56 +168,55 @@ export class TemplateModule extends BaseClient {
   // TEMPLATE CATEGORY METHODS
   // ======================
 
+  /**
+   * Retrieve all template categories.
+   *
+   * @returns An array of template categories.
+   */
   public async getTemplateCategories(): Promise<TemplateCategory[]> {
     return this.request<TemplateCategory[]>(urls.templateCategories, 'GET');
   }
 
+  /**
+   * Retrieve a single template category by id.
+   *
+   * @param id - UUID of the template category.
+   * @returns The requested template category.
+   */
   public async getTemplateCategory(id: string): Promise<TemplateCategory> {
     return this.request<TemplateCategory>(`${urls.templateCategories}/${id}`, 'GET');
   }
 
+  /**
+   * Create a template category.
+   *
+   * @param name - Name of the new category.
+   * @returns The created template category.
+   */
   public async createTemplateCategory(name: string): Promise<TemplateCategory> {
     const dto: CreateTemplateCategoryDto = { name };
     return this.request<TemplateCategory>(urls.templateCategories, 'POST', dto);
   }
 
+  /**
+   * Update a template category's name.
+   *
+   * @param id - UUID of the template category to update.
+   * @param name - New name for the category.
+   * @returns The updated template category.
+   */
   public async updateTemplateCategory(id: string, name: string): Promise<TemplateCategory> {
     const dto: UpdateTemplateCategoryDto = { name };
     return this.request<TemplateCategory>(`${urls.templateCategories}/${id}`, 'PATCH', dto);
   }
 
+  /**
+   * Delete a template category by id.
+   *
+   * @param id - UUID of the template category to delete.
+   * @returns A promise that resolves once the category is deleted.
+   */
   public async deleteTemplateCategory(id: string): Promise<void> {
     await this.request(`${urls.templateCategories}/${id}`, 'DELETE');
   }
-
-  // ======================
-  // AUDIO UPLOAD METHODS (for transcription)
-  // ======================
-
-  public async uploadLargeAudioFile(formData: FormData, onProgress?: (percentage: number) => void): Promise<string> {
-    const uploadId: string = await this.fileUploadRequest(urls.uploadAudioLarge, formData, {}, onProgress);
-    const uploadIds: string = await this.storage!.getItem('uploadIds') || '[]';
-    const uploadIdsArray = JSON.parse(uploadIds);
-    await this.storage!.setItem('uploadIds', JSON.stringify([...uploadIdsArray, uploadId]));
-    return uploadId;
-  }
-
-  public async uploadAudioFile(formData: FormData, onProgress?: (percentage: number) => void): Promise<TranscriptionAudioUploadResponse | null> {
-    const data: TranscriptionAudioUploadResponse = await this.fileUploadRequest(
-      urls.uploadAudio,
-      formData,
-      {},
-      onProgress
-    );
-    return data;
-  }
-
-  public async transcribeBase64Audio(base64String: string): Promise<string> {
-    const transcript = await this.request<any>(
-      urls.transcribeBase64Audio,
-      'POST',
-      { base64Audio: base64String }
-    );
-    return transcript.transcript;
-  }
 }

package/src/sdk/modules/transcription-summary.module.ts

@@ -2,6 +2,7 @@ import { BaseClient } from './base-client';
 import {
   TranscriptionSummary,
   GenerateTranscriptionSummaryDto,
+  GenerateSummaryResponse,
   CreateTranscriptionSummaryDto,
   UpdateTranscriptionSummaryDto,
   CloneTranscriptionSummaryDto,
@@ -13,48 +14,95 @@ export class TranscriptionSummaryModule extends BaseClient {
   // TRANSCRIPTION SUMMARY METHODS
   // ======================
 
-  public async generateTranscriptionSummary(templateId: string, sessionId: string): Promise<TranscriptionSummary> {
+  /**
+   * Queue a transcription summary for generation, or update the template if no transcription exists yet.
+   *
+   * @param templateId - UUID of the template to apply.
+   * @param sessionId - UUID of the session whose transcription is summarised.
+   * @returns Either a queued-job response (`{ message, jobId, sessionId }`) or a template-updated
+   *          response (`{ message, sessionId }`).
+   */
+  public async generateTranscriptionSummary(templateId: string, sessionId: string): Promise<GenerateSummaryResponse> {
     const user = this.validateUser();
     const generateSummaryDto: GenerateTranscriptionSummaryDto = {
       templateId,
       userId: user.id,
       sessionId: sessionId,
     };
-    const transcriptionSummary: TranscriptionSummary = await this.request(
+    return this.request<GenerateSummaryResponse>(
       urls.transcriptionSummary,
       'POST',
       generateSummaryDto
     );
-    return transcriptionSummary;
   }
 
+  /**
+   * Create a transcription summary record; the current user is supplied server-side.
+   *
+   * @param dto - Summary fields (template, content, optional session and anonymised transcript).
+   * @returns The created transcription summary.
+   */
   public async createTranscriptionSummary(dto: Omit<CreateTranscriptionSummaryDto, 'userId'>): Promise<TranscriptionSummary> {
     return this.request<TranscriptionSummary>(urls.transcriptionSummaryCreate, 'POST', dto);
   }
 
-  public async updateTranscriptionSummary(id: string, content: string): Promise<TranscriptionSummary> {
-    const updateSummaryDto: UpdateTranscriptionSummaryDto = {
-      content,
-    };
-    return this.request<TranscriptionSummary>(`${urls.transcriptionSummaries}/${id}`, 'PATCH', updateSummaryDto);
+  /**
+   * Update a transcription summary.
+   *
+   * @param id - UUID of the transcription summary to update.
+   * @param dto - Fields to update (content, anonymised transcript, and/or template).
+   * @returns The updated transcription summary.
+   */
+  public async updateTranscriptionSummary(id: string, dto: UpdateTranscriptionSummaryDto): Promise<TranscriptionSummary> {
+    return this.request<TranscriptionSummary>(`${urls.transcriptionSummaries}/${id}`, 'PATCH', dto);
   }
 
+  /**
+   * Retrieve all transcription summaries accessible to the current user.
+   *
+   * @returns An array of transcription summaries.
+   */
   public async getTranscriptionSummaries(): Promise<TranscriptionSummary[]> {
     return this.request<TranscriptionSummary[]>(urls.transcriptionSummaries, 'GET');
   }
 
+  /**
+   * Retrieve a single transcription summary by id.
+   *
+   * @param id - UUID of the transcription summary.
+   * @returns The requested transcription summary.
+   */
   public async getTranscriptionSummary(id: string): Promise<TranscriptionSummary> {
     return this.request<TranscriptionSummary>(`${urls.transcriptionSummaries}/${id}`, 'GET');
   }
 
+  /**
+   * Retrieve all transcription summaries belonging to a specific user.
+   *
+   * @param userId - UUID of the user whose summaries are returned.
+   * @returns An array of transcription summaries.
+   */
   public async getTranscriptionSummariesByUser(userId: string): Promise<TranscriptionSummary[]> {
     return this.request<TranscriptionSummary[]>(`${urls.transcriptionSummaries}/user/${userId}`, 'GET');
   }
 
+  /**
+   * Retrieve all transcription summaries belonging to a specific organization.
+   *
+   * @param organizationId - UUID of the organization whose summaries are returned.
+   * @returns An array of transcription summaries.
+   */
   public async getByOrganizationTranscriptionSummaries(organizationId: string): Promise<TranscriptionSummary[]> {
     return this.request<TranscriptionSummary[]>(`${urls.transcriptionSummaries}/organization/${organizationId}`, 'GET');
   }
 
+  /**
+   * Clone an existing transcription summary with new content.
+   *
+   * @param id - UUID of the transcription summary to clone.
+   * @param content - Content for the cloned summary.
+   * @returns The newly created clone.
+   */
   public async cloneTranscriptionSummary(id: string, content: string): Promise<TranscriptionSummary> {
     const cloneDto: CloneTranscriptionSummaryDto = {
       content,
@@ -62,6 +110,12 @@ export class TranscriptionSummaryModule extends BaseClient {
     return this.request<TranscriptionSummary>(`${urls.transcriptionSummaries}/${id}/clone`, 'POST', cloneDto);
   }
 
+  /**
+   * Delete a transcription summary by id.
+   *
+   * @param id - UUID of the transcription summary to delete.
+   * @returns A promise that resolves once the summary is deleted.
+   */
   public async deleteTranscriptionSummary(id: string): Promise<void> {
     await this.request(`${urls.transcriptionSummaries}/${id}`, 'DELETE');
   }

package/src/sdk/modules/user.module.ts

@@ -1,8 +1,17 @@
 import { BaseClient } from './base-client';
-import { User, CreateUserDto, UpdateUserDto, UpdateUserNamesDto, AddExpoPushTokenDto, Organization, AssignOrganizationRoleDto, OrganizationRoleType } from '../types';
+import { User, CreateUserDto, UpdateUserDto, UpdateUserNamesDto, AddExpoPushTokenDto, Organization, AssignOrganizationRoleDto, OrganizationRoleType, UserOrganizationRole } from '../types';
 import urls from '../urls';
 
 export class UserModule extends BaseClient {
+  /**
+   * Create a user in the current user's organization.
+   *
+   * @param firstName - First name of the new user.
+   * @param lastName - Last name of the new user.
+   * @param email - Email address of the new user.
+   * @param password - Initial password for the new user.
+   * @returns The newly created user.
+   */
   public async createUser(
     firstName: string,
     lastName: string,
@@ -35,69 +44,166 @@ export class UserModule extends BaseClient {
       userId: userId,
       organizationRoleId: orgRoleEditor.id,
     };
-    this.request(urls.userOrganizationRoles, 'POST', assignRoleDto);
+    await this.request<UserOrganizationRole>(urls.userOrganizationRoles, 'POST', assignRoleDto);
     const userWithOrgRole = await this.request<User>(`${urls.user}/${userId}`, 'GET');
     return userWithOrgRole;
   }
 
+  /**
+   * Assign the editor organization role to a user.
+   *
+   * @param userId - UUID of the user to assign the role to.
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns The user with the assigned organization role.
+   */
   public async assignEditorToRoleToUser(userId: string, organizationId?: string): Promise<User> {
     return this.assignRoleToUser(userId, OrganizationRoleType.EDITOR, organizationId);
   }
 
+  /**
+   * Assign the admin organization role to a user.
+   *
+   * @param userId - UUID of the user to assign the role to.
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns The user with the assigned organization role.
+   */
   public async assignAdminToRoleToUser(userId: string, organizationId?: string): Promise<User> {
     return this.assignRoleToUser(userId, OrganizationRoleType.ADMIN, organizationId);
   }
 
+  /**
+   * Assign the disabled organization role to a user.
+   *
+   * @param userId - UUID of the user to assign the role to.
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns The user with the assigned organization role.
+   */
   public async assignDisabledToRoleToUser(userId: string, organizationId?: string): Promise<User> {
     return this.assignRoleToUser(userId, OrganizationRoleType.DISABLED, organizationId);
   }
 
+  /**
+   * Remove an organization role from a user.
+   *
+   * @param userId - UUID of the user.
+   * @param organizationRoleId - UUID of the organization role to remove.
+   * @returns A promise that resolves when the role is removed.
+   */
   public async removeRoleFromUser(userId: string, organizationRoleId: string): Promise<void> {
     await this.request(`${urls.userOrganizationRoles}/${userId}/${organizationRoleId}`, 'DELETE');
   }
 
+  /**
+   * Create a user and assign them the editor organization role.
+   *
+   * @param firstName - First name of the new user.
+   * @param lastName - Last name of the new user.
+   * @param email - Email address of the new user.
+   * @param password - Initial password for the new user.
+   * @returns The newly created user with the editor role assigned.
+   */
   public async createEditorUser(firstName: string, lastName: string, email: string, password: string): Promise<User> {
     const user = await this.createUser(firstName, lastName, email, password);
     const userWithOrgRole = await this.assignEditorToRoleToUser(user.id);
     return userWithOrgRole;
   }
 
+  /**
+   * Create a user and assign them the admin organization role.
+   *
+   * @param firstName - First name of the new user.
+   * @param lastName - Last name of the new user.
+   * @param email - Email address of the new user.
+   * @param password - Initial password for the new user.
+   * @returns The newly created user with the admin role assigned.
+   */
   public async createAdminUser(firstName: string, lastName: string, email: string, password: string): Promise<User> {
     const user = await this.createUser(firstName, lastName, email, password);
     const userWithOrgRole = await this.assignAdminToRoleToUser(user.id);
     return userWithOrgRole;
   }
 
+  /**
+   * Create a user and assign them the disabled organization role.
+   *
+   * @param firstName - First name of the new user.
+   * @param lastName - Last name of the new user.
+   * @param email - Email address of the new user.
+   * @param password - Initial password for the new user.
+   * @returns The newly created user with the disabled role assigned.
+   */
   public async createDisabledUser(firstName: string, lastName: string, email: string, password: string): Promise<User> {
     const user = await this.createUser(firstName, lastName, email, password);
     const userWithOrgRole = await this.assignDisabledToRoleToUser(user.id);
     return userWithOrgRole;
   }
 
+  /**
+   * List all users the current user can access.
+   *
+   * @returns An array of users.
+   */
   public async getUsers(): Promise<User[]> {
     return this.request<User[]>(urls.users, 'GET');
   }
 
+  /**
+   * Get a single user by ID.
+   *
+   * @param id - UUID of the user.
+   * @returns The requested user.
+   */
   public async getUser(id: string): Promise<User> {
     return this.request<User>(`${urls.users}/${id}`, 'GET');
   }
 
+  /**
+   * List all users belonging to an organization.
+   *
+   * @param organizationId - UUID of the organization.
+   * @returns An array of users in the organization.
+   */
   public async getUsersByOrganization(organizationId: string): Promise<User[]> {
     return this.request<User[]>(`${urls.users}/organization/${organizationId}`, 'GET');
   }
 
+  /**
+   * Update a user by ID.
+   *
+   * @param id - UUID of the user to update.
+   * @param data - Fields to update on the user.
+   * @returns The updated user.
+   */
   public async updateUser(id: string, data: UpdateUserDto): Promise<User> {
     return this.request<User>(`${urls.users}/${id}`, 'PATCH', data);
   }
 
+  /**
+   * Delete a user by ID.
+   *
+   * @param id - UUID of the user to delete.
+   * @returns A promise that resolves when the user is deleted.
+   */
   public async deleteUser(id: string): Promise<void> {
     await this.request(`${urls.users}/${id}`, 'DELETE');
   }
 
+  /**
+   * Update the current user's first and/or last name.
+   *
+   * @param data - The name fields to update.
+   * @returns The updated user.
+   */
   public async updateNames(data: UpdateUserNamesDto): Promise<User> {
     return this.request<User>(`${urls.users}/names`, 'PATCH', data);
   }
 
+  /**
+   * Register an Expo push token for the current user.
+   *
+   * @param token - The Expo push token to add.
+   * @returns A confirmation message.
+   */
   public async addExpoPushToken(token: string): Promise<{ message: string }> {
     const dto: AddExpoPushTokenDto = { token };
     return this.request<{ message: string }>(`${urls.users}/expo-push-token`, 'POST', dto);

package/src/sdk/modules/websocket.module.ts

@@ -6,7 +6,8 @@ import {
   WebSocketEvents,
   AudioChunkPayload,
   AudioChunkOptions,
-  AudioStreamingOptions
+  AudioStreamingOptions,
+  SDKConfig
 } from '../types';
 
 /**
@@ -23,7 +24,7 @@ export class WebSocketModule extends BaseClient {
   private connectionStats: WebSocketConnectionStats;
   private eventHandlers: Map<keyof WebSocketEvents, Function[]> = new Map();
 
-  constructor(baseConfig: any) {
+  constructor(baseConfig: SDKConfig) {
     super(baseConfig);
     
     const wsConfig = baseConfig.websocket || {};
@@ -136,14 +137,18 @@ export class WebSocketModule extends BaseClient {
   }
 
   /**
-   * Check if WebSocket is connected
+   * Check if the WebSocket is currently connected.
+   *
+   * @returns `true` when the underlying socket is connected, otherwise `false`.
    */
   public isConnected(): boolean {
     return this.socket?.connected || false;
   }
 
   /**
-   * Get connection statistics
+   * Get a snapshot of the current connection statistics.
+   *
+   * @returns A copy of the connection stats (connection state, reconnect count, last connect/disconnect times).
    */
   public getConnectionStats(): WebSocketConnectionStats {
     return { ...this.connectionStats };
@@ -185,7 +190,12 @@ export class WebSocketModule extends BaseClient {
   }
 
   /**
-   * Stream multiple audio chunks
+   * Stream multiple audio chunks sequentially, with an optional delay between each.
+   *
+   * @param sessionId - Session ID to associate the chunks with.
+   * @param audioChunks - Ordered array of Base64 encoded audio data.
+   * @param options - Streaming options (e.g. `delayBetweenChunks` in ms, default 100).
+   * @throws Error if the WebSocket is not connected after token validation.
    */
   public async streamAudioChunks(
     sessionId: string,
@@ -213,7 +223,10 @@ export class WebSocketModule extends BaseClient {
   }
 
   /**
-   * Add event listener
+   * Register an event listener for a WebSocket event.
+   *
+   * @param event - The event name to listen for.
+   * @param handler - Callback invoked with the event payload.
    */
   public on<K extends keyof WebSocketEvents>(
     event: K,
@@ -226,7 +239,10 @@ export class WebSocketModule extends BaseClient {
   }
 
   /**
-   * Remove event listener
+   * Remove a previously registered event listener.
+   *
+   * @param event - The event name the handler was registered for.
+   * @param handler - The exact handler reference to remove.
    */
   public off<K extends keyof WebSocketEvents>(
     event: K,
@@ -384,7 +400,9 @@ export class WebSocketModule extends BaseClient {
   }
 
   /**
-   * Clean up resources
+   * Disconnect the socket and clear all registered event handlers.
+   *
+   * Call this when the client is no longer needed to release resources.
    */
   public destroy(): void {
     this.disconnect();

package/src/sdk/modules/workflow.module.ts

@@ -3,6 +3,13 @@ import { Workflow, CreateWorkflowDto, UpdateWorkflowDto } from '../types';
 import urls from '../urls';
 
 export class WorkflowModule extends BaseClient {
+  /**
+   * Create a workflow for an organization.
+   *
+   * @param name - Display name of the workflow.
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns The created workflow.
+   */
   public async createWorkflow(name: string, organizationId?: string): Promise<Workflow> {
     const dto: CreateWorkflowDto = {
       name,
@@ -11,20 +18,46 @@ export class WorkflowModule extends BaseClient {
     return this.request<Workflow>(urls.workflows, 'POST', dto);
   }
 
+  /**
+   * List workflows, optionally filtered by organization.
+   *
+   * @param organizationId - Optional organization UUID to filter by.
+   * @returns An array of workflows.
+   */
   public async getWorkflows(organizationId?: string): Promise<Workflow[]> {
     const params = organizationId ? `?organizationId=${organizationId}` : '';
     return this.request<Workflow[]>(`${urls.workflows}${params}`, 'GET');
   }
 
+  /**
+   * Get a single workflow by id.
+   *
+   * @param id - UUID of the workflow.
+   * @returns The workflow.
+   */
   public async getWorkflow(id: string): Promise<Workflow> {
     return this.request<Workflow>(`${urls.workflows}/${id}`, 'GET');
   }
 
+  /**
+   * Get the workflows for a specific organization.
+   *
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns An array of workflows for the organization.
+   */
   public async getWorkflowsByOrganization(organizationId?: string): Promise<Workflow[]> {
     const orgId = organizationId || this.user!.organizationId;
     return this.request<Workflow[]>(`${urls.workflows}?organizationId=${orgId}`, 'GET');
   }
 
+  /**
+   * Update a workflow.
+   *
+   * @param id - UUID of the workflow to update.
+   * @param name - New display name of the workflow.
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns The updated workflow.
+   */
   public async updateWorkflow(id: string, name: string, organizationId?: string): Promise<Workflow> {
     const dto: UpdateWorkflowDto = {
       name,
@@ -33,6 +66,12 @@ export class WorkflowModule extends BaseClient {
     return this.request<Workflow>(`${urls.workflows}/${id}`, 'PATCH', dto);
   }
 
+  /**
+   * Delete a workflow.
+   *
+   * @param id - UUID of the workflow to delete.
+   * @returns A promise that resolves when the workflow has been deleted.
+   */
   public async deleteWorkflow(id: string): Promise<void> {
     await this.request(`${urls.workflows}/${id}`, 'DELETE');
   }