whio-api-sdk 1.1.28 → 1.1.29

package/dist/src/sdk/whio-superuser-sdk.d.ts

@@ -11,7 +11,6 @@ import { AgentModule } from './modules/agent.module';
 import { AudioModule } from './modules/audio.module';
 import { WorkflowModule } from './modules/workflow.module';
 import { LogModule } from './modules/log.module';
-import { DebugModule } from './modules/debug.module';
 import { ExternalIntegrationModule } from './modules/external-integration.module';
 import { ReportsModule } from './modules/reports.module';
 import { DataStrategyModule } from './modules/data-strategy.module';
@@ -33,7 +32,6 @@ export declare class WhioSuperuserSDK extends BaseClient {
     private readonly workflowsModule;
     private readonly integrationActionsModule;
     private readonly logsModule;
-    private readonly debugModule;
     private readonly externalIntegrationsModule;
     private readonly websocketModule;
     private readonly reportsModule;
@@ -59,7 +57,7 @@ export declare class WhioSuperuserSDK extends BaseClient {
     getSessionsByOrganization(...args: Parameters<SuperuserSessionModule['getSessionsByOrganization']>): Promise<import("./types").SessionsResponse>;
     searchSessions(...args: Parameters<SuperuserSessionModule['searchSessions']>): Promise<import("./types").SearchSessionsResponse>;
     updateSession(...args: Parameters<SuperuserSessionModule['updateSession']>): Promise<import("./types").Session>;
-    deleteSession(...args: Parameters<SuperuserSessionModule['deleteSession']>): Promise<void>;
+    deleteSession(...args: Parameters<SuperuserSessionModule['deleteSession']>): Promise<import("./types").Session>;
     setPrimaryTranscriptionSummary(...args: Parameters<SuperuserSessionModule['setPrimaryTranscriptionSummary']>): Promise<import("./types").Session>;
     getSession(...args: Parameters<SuperuserSessionModule['getSession']>): Promise<import("./types").Session>;
     createUser(...args: Parameters<UserModule['createUser']>): Promise<User>;
@@ -78,16 +76,16 @@ export declare class WhioSuperuserSDK extends BaseClient {
     getOrganization(...args: Parameters<OrganizationModule['getOrganization']>): Promise<import("./types").Organization>;
     updateOrganization(...args: Parameters<OrganizationModule['updateOrganization']>): Promise<import("./types").Organization>;
     deleteOrganization(...args: Parameters<OrganizationModule['deleteOrganization']>): Promise<void>;
-    addUserToOrganization(...args: Parameters<OrganizationModule['addUserToOrganization']>): Promise<void>;
-    removeUserFromOrganization(...args: Parameters<OrganizationModule['removeUserFromOrganization']>): Promise<void>;
+    addUserToOrganization(...args: Parameters<OrganizationModule['addUserToOrganization']>): Promise<User>;
+    removeUserFromOrganization(...args: Parameters<OrganizationModule['removeUserFromOrganization']>): Promise<User>;
     createTeam(...args: Parameters<TeamModule['createTeam']>): Promise<import("./types").Team>;
     getTeams(...args: Parameters<TeamModule['getTeams']>): Promise<import("./types").Team[]>;
     getTeam(...args: Parameters<TeamModule['getTeam']>): Promise<import("./types").Team>;
     getTeamsByOrganization(...args: Parameters<TeamModule['getTeamsByOrganization']>): Promise<import("./types").Team[]>;
     updateTeam(...args: Parameters<TeamModule['updateTeam']>): Promise<import("./types").Team>;
     deleteTeam(...args: Parameters<TeamModule['deleteTeam']>): Promise<void>;
-    addUserToTeam(...args: Parameters<TeamModule['addUserToTeam']>): Promise<any>;
-    removeUserFromTeam(...args: Parameters<TeamModule['removeUserFromTeam']>): Promise<void>;
+    addUserToTeam(...args: Parameters<TeamModule['addUserToTeam']>): Promise<import("./types").TeamRole>;
+    removeUserFromTeam(...args: Parameters<TeamModule['removeUserFromTeam']>): Promise<import("./types").TeamRole>;
     createTemplate(...args: Parameters<TemplateModule['createTemplate']>): Promise<import("./types").Template>;
     getTemplates(...args: Parameters<TemplateModule['getTemplates']>): Promise<import("./types").Template[]>;
     getTemplate(...args: Parameters<TemplateModule['getTemplate']>): Promise<import("./types").Template>;
@@ -102,8 +100,8 @@ export declare class WhioSuperuserSDK extends BaseClient {
     getTranscriptionSummariesByUser(...args: Parameters<TranscriptionSummaryModule['getTranscriptionSummariesByUser']>): Promise<import("./types").TranscriptionSummary[]>;
     getByOrganizationTranscriptionSummaries(...args: Parameters<TranscriptionSummaryModule['getByOrganizationTranscriptionSummaries']>): Promise<import("./types").TranscriptionSummary[]>;
     createAgent(...args: Parameters<AgentModule['createAgent']>): Promise<import("./types").Agent>;
-    getAgents(...args: Parameters<AgentModule['getAgents']>): Promise<import("./types").Agent[]>;
-    getAgent(...args: Parameters<AgentModule['getAgent']>): Promise<import("./types").Agent>;
+    getAgents(...args: Parameters<AgentModule['getAgents']>): Promise<import("./types").AgentWithOrganizations[]>;
+    getAgent(...args: Parameters<AgentModule['getAgent']>): Promise<import("./types").AgentWithOrganizations>;
     updateAgent(...args: Parameters<AgentModule['updateAgent']>): Promise<import("./types").Agent>;
     deleteAgent(...args: Parameters<AgentModule['deleteAgent']>): Promise<void>;
     createWorkflow(...args: Parameters<WorkflowModule['createWorkflow']>): Promise<import("./types").Workflow>;
@@ -116,8 +114,6 @@ export declare class WhioSuperuserSDK extends BaseClient {
     getLogs(...args: Parameters<LogModule['getLogs']>): Promise<import("./types").LogsResponse>;
     getLogsByUser(...args: Parameters<LogModule['getLogsByUser']>): Promise<import("./types").LogsResponse>;
     getLogStats(...args: Parameters<LogModule['getLogStats']>): Promise<import("./types").LogStats>;
-    getSessionsWithoutMedicalTranscriptions(...args: Parameters<DebugModule['getSessionsWithoutMedicalTranscriptions']>): Promise<import("./types").DebugSessionSummary[]>;
-    downloadSessionAsZip(...args: Parameters<DebugModule['downloadSessionAsZip']>): Promise<Blob>;
     getSystemSnapshots(...args: Parameters<SystemSnapshotModule['getSnapshots']>): Promise<import("./types").SystemSnapshotsResponse>;
     getLatestSystemSnapshot(...args: Parameters<SystemSnapshotModule['getLatestSnapshot']>): Promise<import("./types").SystemSnapshot | null>;
     getCurrentSystemMetrics(...args: Parameters<SystemSnapshotModule['getCurrentMetrics']>): Promise<import("./types").CurrentMetrics>;
@@ -125,11 +121,11 @@ export declare class WhioSuperuserSDK extends BaseClient {
     getExternalIntegrations(...args: Parameters<ExternalIntegrationModule['getExternalIntegrations']>): Promise<import("./types").ExternalIntegration[]>;
     updateExternalIntegration(...args: Parameters<ExternalIntegrationModule['updateExternalIntegration']>): Promise<import("./types").ExternalIntegration>;
     deleteExternalIntegration(...args: Parameters<ExternalIntegrationModule['deleteExternalIntegration']>): Promise<void>;
-    createDataStrategy(...args: Parameters<DataStrategyModule['createDataStrategy']>): Promise<import("./types").DataStrategy>;
-    getDataStrategies(...args: Parameters<DataStrategyModule['getDataStrategies']>): Promise<import("./types").DataStrategy[]>;
-    getDataStrategy(...args: Parameters<DataStrategyModule['getDataStrategy']>): Promise<import("./types").DataStrategy>;
-    updateDataStrategy(...args: Parameters<DataStrategyModule['updateDataStrategy']>): Promise<import("./types").DataStrategy>;
-    deleteDataStrategy(...args: Parameters<DataStrategyModule['deleteDataStrategy']>): Promise<void>;
+    createDataStrategy(...args: Parameters<DataStrategyModule['createDataStrategy']>): Promise<import("./types").DataStrategyWithOrganization>;
+    getDataStrategies(...args: Parameters<DataStrategyModule['getDataStrategies']>): Promise<import("./types").DataStrategyWithOrganization[]>;
+    getDataStrategy(...args: Parameters<DataStrategyModule['getDataStrategy']>): Promise<import("./types").DataStrategyWithOrganization>;
+    updateDataStrategy(...args: Parameters<DataStrategyModule['updateDataStrategy']>): Promise<import("./types").DataStrategyWithOrganization>;
+    deleteDataStrategy(...args: Parameters<DataStrategyModule['deleteDataStrategy']>): Promise<import("./types").DataStrategy>;
     getCompanyDailyReportCsv(...args: Parameters<ReportsModule['getCompanyDailyReportCsv']>): Promise<string>;
     downloadCompanyDailyReport(...args: Parameters<ReportsModule['downloadCompanyDailyReport']>): Promise<Blob>;
 }

package/dist/src/sdk/whio-superuser-sdk.js

@@ -20,7 +20,6 @@ import { AudioModule } from './modules/audio.module';
 import { WorkflowModule } from './modules/workflow.module';
 import { IntegrationActionModule } from './modules/integration-action.module';
 import { LogModule } from './modules/log.module';
-import { DebugModule } from './modules/debug.module';
 import { ExternalIntegrationModule } from './modules/external-integration.module';
 import { WebSocketModule } from './modules/websocket.module';
 import { ReportsModule } from './modules/reports.module';
@@ -49,7 +48,6 @@ export class WhioSuperuserSDK extends BaseClient {
         this.workflowsModule = new WorkflowModule(config);
         this.integrationActionsModule = new IntegrationActionModule(config);
         this.logsModule = new LogModule(config);
-        this.debugModule = new DebugModule(config);
         this.externalIntegrationsModule = new ExternalIntegrationModule(config);
         this.websocketModule = config.skipWebsocket ? null : new WebSocketModule(config);
         this.reportsModule = new ReportsModule(config);
@@ -61,7 +59,7 @@ export class WhioSuperuserSDK extends BaseClient {
         this.modules = [
             this.authModule, this.usersModule, this.organizationsModule, this.teamsModule, this.templatesModule,
             this.transcriptionSummariesModule, this.sessionsModule, this.agentsModule, this.audioModule,
-            this.workflowsModule, this.integrationActionsModule, this.logsModule, this.debugModule, this.externalIntegrationsModule,
+            this.workflowsModule, this.integrationActionsModule, this.logsModule, this.externalIntegrationsModule,
             this.reportsModule, this.patientsModule, this.dataStrategiesModule, this.systemSnapshotsModule, this.ratingsModule,
             this.tiakiModule,
             ...(this.websocketModule ? [this.websocketModule] : [])
@@ -479,19 +477,6 @@ export class WhioSuperuserSDK extends BaseClient {
         });
     }
     // ======================
-    // DEBUG METHODS
-    // ======================
-    getSessionsWithoutMedicalTranscriptions(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.debugModule.getSessionsWithoutMedicalTranscriptions(...args);
-        });
-    }
-    downloadSessionAsZip(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.debugModule.downloadSessionAsZip(...args);
-        });
-    }
-    // ======================
     // SYSTEM SNAPSHOT METHODS
     // ======================
     getSystemSnapshots(...args) {

package/dist/src/sdk/whio-teamadmin-sdk.d.ts

@@ -30,7 +30,6 @@ export declare class WhioTeamAdminSDK extends BaseClient {
     private readonly workflowsModule;
     private readonly integrationActionsModule;
     private readonly logsModule;
-    private readonly debugModule;
     private readonly externalIntegrationsModule;
     private readonly websocketModule;
     private readonly reportsModule;
@@ -58,7 +57,7 @@ export declare class WhioTeamAdminSDK extends BaseClient {
     getSessions(...args: Parameters<SessionModule['getSessions']>): Promise<import("./types").Session[]>;
     getSession(...args: Parameters<SessionModule['getSession']>): Promise<import("./types").Session>;
     updateSession(...args: Parameters<SessionModule['updateSession']>): Promise<import("./types").Session>;
-    deleteSession(...args: Parameters<SessionModule['deleteSession']>): Promise<void>;
+    deleteSession(...args: Parameters<SessionModule['deleteSession']>): Promise<import("./types").Session>;
     searchSessions(...args: Parameters<SessionModule['searchSessions']>): Promise<import("./types").SearchSessionsResponse>;
     setPrimaryTranscriptionSummary(...args: Parameters<SessionModule['setPrimaryTranscriptionSummary']>): Promise<import("./types").Session>;
     rerunTranscription(...args: Parameters<SessionModule['rerunTranscription']>): Promise<{
@@ -77,15 +76,12 @@ export declare class WhioTeamAdminSDK extends BaseClient {
     getTemplatesByOrganization(...args: Parameters<TemplateModule['getTemplatesByOrganization']>): Promise<import("./types").Template[]>;
     getTemplateCategories(...args: Parameters<TemplateModule['getTemplateCategories']>): Promise<import("./types").TemplateCategory[]>;
     getTemplateCategory(...args: Parameters<TemplateModule['getTemplateCategory']>): Promise<import("./types").TemplateCategory>;
-    generateTranscriptionSummary(...args: Parameters<TranscriptionSummaryModule['generateTranscriptionSummary']>): Promise<import("./types").TranscriptionSummary>;
+    generateTranscriptionSummary(...args: Parameters<TranscriptionSummaryModule['generateTranscriptionSummary']>): Promise<import("./types").GenerateSummaryResponse>;
     updateTranscriptionSummary(...args: Parameters<TranscriptionSummaryModule['updateTranscriptionSummary']>): Promise<import("./types").TranscriptionSummary>;
     getTranscriptionSummaries(...args: Parameters<TranscriptionSummaryModule['getTranscriptionSummaries']>): Promise<import("./types").TranscriptionSummary[]>;
     getTranscriptionSummary(...args: Parameters<TranscriptionSummaryModule['getTranscriptionSummary']>): Promise<import("./types").TranscriptionSummary>;
     cloneTranscriptionSummary(...args: Parameters<TranscriptionSummaryModule['cloneTranscriptionSummary']>): Promise<import("./types").TranscriptionSummary>;
     deleteTranscriptionSummary(...args: Parameters<TranscriptionSummaryModule['deleteTranscriptionSummary']>): Promise<void>;
-    uploadAudioFile(...args: Parameters<TemplateModule['uploadAudioFile']>): Promise<import("./types").TranscriptionAudioUploadResponse | null>;
-    uploadLargeAudioFile(...args: Parameters<TemplateModule['uploadLargeAudioFile']>): Promise<string>;
-    transcribeBase64Audio(...args: Parameters<TemplateModule['transcribeBase64Audio']>): Promise<string>;
     uploadAudioFileToSession(...args: Parameters<AudioModule['uploadAudioFileToSession']>): Promise<import("./types").AudioFile>;
     getMyAudioFiles(...args: Parameters<AudioModule['getMyAudioFiles']>): Promise<import("./types").AudioFile[]>;
     getAudioFilesBySession(...args: Parameters<AudioModule['getAudioFilesBySession']>): Promise<import("./types").AudioFile[]>;
@@ -95,8 +91,8 @@ export declare class WhioTeamAdminSDK extends BaseClient {
     getWorkflows(...args: Parameters<WorkflowModule['getWorkflows']>): Promise<import("./types").Workflow[]>;
     getWorkflow(...args: Parameters<WorkflowModule['getWorkflow']>): Promise<import("./types").Workflow>;
     getWorkflowsByOrganization(...args: Parameters<WorkflowModule['getWorkflowsByOrganization']>): Promise<import("./types").Workflow[]>;
-    getAgents(...args: Parameters<AgentModule['getAgents']>): Promise<import("./types").Agent[]>;
-    getAgent(...args: Parameters<AgentModule['getAgent']>): Promise<import("./types").Agent>;
+    getAgents(...args: Parameters<AgentModule['getAgents']>): Promise<import("./types").AgentWithOrganizations[]>;
+    getAgent(...args: Parameters<AgentModule['getAgent']>): Promise<import("./types").AgentWithOrganizations>;
     createRating(...args: Parameters<RatingModule['createRating']>): Promise<import("./types").SummaryRating>;
     getRatingsBySession(...args: Parameters<RatingModule['getRatingsBySession']>): Promise<import("./types").SummaryRatingsResponse>;
     createTiakiCalendarEvent(...args: Parameters<TiakiModule['createCalendarEvent']>): Promise<import("./types").TiakiCalendarEventResponse>;

package/dist/src/sdk/whio-teamadmin-sdk.js

@@ -20,7 +20,6 @@ import { AudioModule } from './modules/audio.module';
 import { WorkflowModule } from './modules/workflow.module';
 import { IntegrationActionModule } from './modules/integration-action.module';
 import { LogModule } from './modules/log.module';
-import { DebugModule } from './modules/debug.module';
 import { ExternalIntegrationModule } from './modules/external-integration.module';
 import { WebSocketModule } from './modules/websocket.module';
 import { ReportsModule } from './modules/reports.module';
@@ -51,7 +50,6 @@ export class WhioTeamAdminSDK extends BaseClient {
         this.workflowsModule = new WorkflowModule(config);
         this.integrationActionsModule = new IntegrationActionModule(config);
         this.logsModule = new LogModule(config);
-        this.debugModule = new DebugModule(config);
         this.externalIntegrationsModule = new ExternalIntegrationModule(config);
         this.websocketModule = config.skipWebsocket ? null : new WebSocketModule(config);
         this.reportsModule = new ReportsModule(config);
@@ -63,7 +61,7 @@ export class WhioTeamAdminSDK extends BaseClient {
         this.modules = [
             this.authModule, this.usersModule, this.organizationsModule, this.teamsModule, this.templatesModule,
             this.transcriptionSummariesModule, this.sessionsModule, this.agentsModule, this.audioModule,
-            this.workflowsModule, this.integrationActionsModule, this.logsModule, this.debugModule, this.externalIntegrationsModule,
+            this.workflowsModule, this.integrationActionsModule, this.logsModule, this.externalIntegrationsModule,
             this.reportsModule, this.patientsModule, this.dataStrategiesModule, this.systemSnapshotsModule, this.ratingsModule,
             this.tiakiModule,
             ...(this.websocketModule ? [this.websocketModule] : [])
@@ -280,21 +278,6 @@ export class WhioTeamAdminSDK extends BaseClient {
     // ======================
     // AUDIO METHODS
     // ======================
-    uploadAudioFile(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.templatesModule.uploadAudioFile(...args);
-        });
-    }
-    uploadLargeAudioFile(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.templatesModule.uploadLargeAudioFile(...args);
-        });
-    }
-    transcribeBase64Audio(...args) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.templatesModule.transcribeBase64Audio(...args);
-        });
-    }
     uploadAudioFileToSession(...args) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.audioModule.uploadAudioFileToSession(...args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whio-api-sdk",
-  "version": "1.1.28",
+  "version": "1.1.29",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

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

@@ -1,5 +1,5 @@
 import { BaseClient } from './base-client';
-import { Agent, CreateAgentDto, UpdateAgentDto, AgentSettings, CreateAgentSettingsDto, UpdateAgentSettingsDto } from '../types';
+import { Agent, AgentWithOrganizations, AgentOrganization, CreateAgentDto, UpdateAgentDto, AgentSettings, CreateAgentSettingsDto, UpdateAgentSettingsDto } from '../types';
 import urls from '../urls';
 
 export class AgentModule extends BaseClient {
@@ -7,44 +7,103 @@ export class AgentModule extends BaseClient {
   // AGENT METHODS
   // ======================
 
+  /**
+   * Create a new agent.
+   *
+   * @param name - Display name of the agent.
+   * @param templateTextReplacement - Optional template text-replacement string for the agent.
+   * @returns The created agent.
+   */
   public async createAgent(name: string, templateTextReplacement?: string): Promise<Agent> {
     const dto: CreateAgentDto = { name, templateTextReplacement };
     return this.request<Agent>(urls.agents, 'POST', dto);
   }
 
-  public async getAgents(): Promise<Agent[]> {
-    return this.request<Agent[]>(urls.agents, 'GET');
+  /**
+   * List all agents, each including its linked organizations.
+   *
+   * @returns An array of agents with their organizations relation populated.
+   */
+  public async getAgents(): Promise<AgentWithOrganizations[]> {
+    return this.request<AgentWithOrganizations[]>(urls.agents, 'GET');
   }
 
-  public async getAgent(id: string): Promise<Agent> {
-    return this.request<Agent>(`${urls.agents}/${id}`, 'GET');
+  /**
+   * Get a single agent by id, including its linked organizations.
+   *
+   * @param id - UUID of the agent.
+   * @returns The agent with its organizations relation populated.
+   */
+  public async getAgent(id: string): Promise<AgentWithOrganizations> {
+    return this.request<AgentWithOrganizations>(`${urls.agents}/${id}`, 'GET');
   }
 
+  /**
+   * Update an agent.
+   *
+   * @param id - UUID of the agent to update.
+   * @param name - New display name of the agent.
+   * @param templateTextReplacement - Optional template text-replacement string for the agent.
+   * @returns The updated agent.
+   */
   public async updateAgent(id: string, name: string, templateTextReplacement?: string): Promise<Agent> {
     const dto: UpdateAgentDto = { name, templateTextReplacement };
     return this.request<Agent>(`${urls.agents}/${id}`, 'PATCH', dto);
   }
 
+  /**
+   * Delete an agent.
+   *
+   * @param id - UUID of the agent to delete.
+   * @returns A promise that resolves when the agent has been deleted.
+   */
   public async deleteAgent(id: string): Promise<void> {
     await this.request(`${urls.agents}/${id}`, 'DELETE');
   }
 
-  public async addAgentToOrganization(agentId: string, organizationId: string): Promise<void> {
-    await this.request(`${urls.agents}/${agentId}/organizations/${organizationId}`, 'POST');
+  /**
+   * Link an agent to an organization.
+   *
+   * @param agentId - UUID of the agent.
+   * @param organizationId - UUID of the organization to link.
+   * @returns The created agent-organization association.
+   */
+  public async addAgentToOrganization(agentId: string, organizationId: string): Promise<AgentOrganization> {
+    return this.request<AgentOrganization>(`${urls.agents}/${agentId}/organizations/${organizationId}`, 'POST');
   }
 
-  public async removeAgentFromOrganization(agentId: string, organizationId: string): Promise<void> {
-    await this.request(`${urls.agents}/${agentId}/organizations/${organizationId}`, 'DELETE');
+  /**
+   * Unlink an agent from an organization.
+   *
+   * @param agentId - UUID of the agent.
+   * @param organizationId - UUID of the organization to unlink.
+   * @returns The removed agent-organization association.
+   */
+  public async removeAgentFromOrganization(agentId: string, organizationId: string): Promise<AgentOrganization> {
+    return this.request<AgentOrganization>(`${urls.agents}/${agentId}/organizations/${organizationId}`, 'DELETE');
   }
 
   // ======================
   // AGENT SETTINGS METHODS
   // ======================
 
+  /**
+   * Create agent settings for an agent within an organization.
+   *
+   * @param settingsData - The agent-settings payload (agentId, organizationId and tuning params).
+   * @returns The created agent settings.
+   */
   public async createAgentSettings(settingsData: CreateAgentSettingsDto): Promise<AgentSettings> {
     return this.request<AgentSettings>(urls.agentSettings, 'POST', settingsData);
   }
 
+  /**
+   * List agent settings, optionally filtered by organization and/or agent.
+   *
+   * @param organizationId - Optional organization UUID to filter by.
+   * @param agentId - Optional agent UUID to filter by.
+   * @returns An array of matching agent settings.
+   */
   public async getAgentSettings(organizationId?: string, agentId?: string): Promise<AgentSettings[]> {
     const params = new URLSearchParams();
     if (organizationId) params.append('organizationId', organizationId);
@@ -56,18 +115,44 @@ export class AgentModule extends BaseClient {
     return this.request<AgentSettings[]>(endpoint, 'GET');
   }
 
+  /**
+   * Get a single agent settings record by id.
+   *
+   * @param id - UUID of the agent settings record.
+   * @returns The agent settings record.
+   */
   public async getAgentSettingsById(id: string): Promise<AgentSettings> {
     return this.request<AgentSettings>(`${urls.agentSettings}/${id}`, 'GET');
   }
 
+  /**
+   * Get the agent settings for a specific agent within a specific organization.
+   *
+   * @param agentId - UUID of the agent.
+   * @param organizationId - UUID of the organization.
+   * @returns The agent settings record for the agent/organization pair.
+   */
   public async getAgentSettingsByAgentAndOrganization(agentId: string, organizationId: string): Promise<AgentSettings> {
     return this.request<AgentSettings>(`${urls.agentSettings}/agent/${agentId}/organization/${organizationId}`, 'GET');
   }
 
+  /**
+   * Update an agent settings record.
+   *
+   * @param id - UUID of the agent settings record to update.
+   * @param settingsData - The fields to update.
+   * @returns The updated agent settings record.
+   */
   public async updateAgentSettings(id: string, settingsData: UpdateAgentSettingsDto): Promise<AgentSettings> {
     return this.request<AgentSettings>(`${urls.agentSettings}/${id}`, 'PATCH', settingsData);
   }
 
+  /**
+   * Delete an agent settings record.
+   *
+   * @param id - UUID of the agent settings record to delete.
+   * @returns A promise that resolves when the record has been deleted.
+   */
   public async deleteAgentSettings(id: string): Promise<void> {
     await this.request(`${urls.agentSettings}/${id}`, 'DELETE');
   }

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

@@ -16,55 +16,120 @@ export class AudioModule extends BaseClient {
   // AUDIO FILE METHODS
   // ======================
 
+  /**
+   * Upload an audio file to a session via multipart form data.
+   *
+   * @param sessionId - UUID of the session to attach the audio file to.
+   * @param file - The audio file or blob to upload.
+   * @param fileName - Optional file name to send with the upload.
+   * @param onProgress - Optional callback invoked with the upload percentage (0-100).
+   * @returns The created audio file record.
+   */
   public async uploadAudioFileToSession(sessionId: string, file: File | Blob, fileName?: string, onProgress?: (percentage: number) => void): Promise<AudioFile> {
     const formData = new FormData();
     formData.append('file', file, fileName);
     return this.fileUploadRequest<AudioFile>(`${urls.audioFiles}/upload/${sessionId}`, formData, {}, onProgress);
   }
 
-  public async uploadAudioFileWithTranscriptionQueue(sessionId: string, file: File | Blob, options?: { fileName?: string; culturalTranscription?: string; onProgress?: (percentage: number) => void }): Promise<AudioFile> {
+  /**
+   * Upload an audio file to a session and queue it for transcription.
+   *
+   * @param sessionId - UUID of the session to attach the audio file to.
+   * @param file - The audio file or blob to upload.
+   * @param options - Optional settings: `fileName` and an `onProgress` callback (0-100).
+   * @returns The created audio file record.
+   */
+  public async uploadAudioFileWithTranscriptionQueue(sessionId: string, file: File | Blob, options?: { fileName?: string; onProgress?: (percentage: number) => void }): Promise<AudioFile> {
     const formData = new FormData();
     formData.append('file', file, options?.fileName);
 
-    if (options?.culturalTranscription) {
-      formData.append('cultural_transcription', options.culturalTranscription);
-    }
-
     return this.fileUploadRequest<AudioFile>(`${urls.audioFiles}/upload/${sessionId}`, formData, {}, options?.onProgress);
   }
 
+  /**
+   * Retrieve the current user's audio files.
+   *
+   * @returns An array of audio files belonging to the current user.
+   */
   public async getMyAudioFiles(): Promise<AudioFile[]> {
     return this.request<AudioFile[]>(`${urls.audioFiles}/my-files`, 'GET');
   }
 
+  /**
+   * Retrieve all audio files accessible to the current user.
+   *
+   * @returns An array of audio files.
+   */
   public async getAllAudioFiles(): Promise<AudioFile[]> {
     return this.request<AudioFile[]>(`${urls.audioFiles}/all`, 'GET');
   }
 
+  /**
+   * Retrieve all audio files belonging to the current user's organization.
+   *
+   * @returns An array of audio files.
+   */
   public async getOrganizationAudioFiles(): Promise<AudioFile[]> {
     return this.request<AudioFile[]>(`${urls.audioFiles}/organization`, 'GET');
   }
 
+  /**
+   * Retrieve all audio files for a given session.
+   *
+   * @param sessionId - UUID of the session.
+   * @returns An array of audio files for the session.
+   */
   public async getAudioFilesBySession(sessionId: string): Promise<AudioFile[]> {
     return this.request<AudioFile[]>(`${urls.audioFiles}/session/${sessionId}`, 'GET');
   }
 
+  /**
+   * Retrieve a single audio file by id.
+   *
+   * @param id - UUID of the audio file.
+   * @returns The requested audio file.
+   */
   public async getAudioFile(id: string): Promise<AudioFile> {
     return this.request<AudioFile>(`${urls.audioFiles}/${id}`, 'GET');
   }
 
+  /**
+   * Update an audio file's metadata.
+   *
+   * @param id - UUID of the audio file to update.
+   * @param updates - Fields to update (transcription URL and/or status).
+   * @returns The updated audio file.
+   */
   public async updateAudioFile(id: string, updates: UpdateAudioFileDto): Promise<AudioFile> {
     return this.request<AudioFile>(`${urls.audioFiles}/${id}`, 'PATCH', updates);
   }
 
-  public async deleteAudioFile(id: string): Promise<void> {
-    await this.request(`${urls.audioFiles}/${id}`, 'DELETE');
+  /**
+   * Delete an audio file by id.
+   *
+   * @param id - UUID of the audio file to delete.
+   * @returns The deleted audio file record.
+   */
+  public async deleteAudioFile(id: string): Promise<AudioFile> {
+    return this.request<AudioFile>(`${urls.audioFiles}/${id}`, 'DELETE');
   }
 
+  /**
+   * Download an audio file as a blob.
+   *
+   * @param id - UUID of the audio file to download.
+   * @returns The audio file contents as a Blob.
+   */
   public async downloadAudioFile(id: string): Promise<Blob> {
     return this.downloadRequest(`${urls.audioFiles}/${id}/download`);
   }
 
+  /**
+   * Download an audio file and return an object URL pointing to it.
+   *
+   * @param id - UUID of the audio file to download.
+   * @returns An object URL referencing the downloaded blob.
+   */
   public async downloadAudioFileAsUrl(id: string): Promise<string> {
     const blob = await this.downloadAudioFile(id);
     return URL.createObjectURL(blob);
@@ -74,16 +139,31 @@ export class AudioModule extends BaseClient {
   // TRANSCRIPTION QUEUE HELPER METHODS
   // ======================
 
+  /**
+   * Retrieve the current user's audio files that have finished transcription.
+   *
+   * @returns An array of transcribed audio files.
+   */
   public async getTranscribedAudioFiles(): Promise<AudioFile[]> {
     const audioFiles = await this.getMyAudioFiles();
-    return audioFiles.filter(file => file.status === AudioFileStatus.TRANSCRIBED && file.transcription);
+    return audioFiles.filter(file => file.status === AudioFileStatus.TRANSCRIBED);
   }
 
+  /**
+   * Retrieve the current user's audio files that are currently processing.
+   *
+   * @returns An array of processing audio files.
+   */
   public async getProcessingAudioFiles(): Promise<AudioFile[]> {
     const audioFiles = await this.getMyAudioFiles();
     return audioFiles.filter(file => file.status === AudioFileStatus.PROCESSING);
   }
 
+  /**
+   * Retrieve the current user's audio files that failed processing.
+   *
+   * @returns An array of failed audio files.
+   */
   public async getFailedAudioFiles(): Promise<AudioFile[]> {
     const audioFiles = await this.getMyAudioFiles();
     return audioFiles.filter(file => file.status === AudioFileStatus.FAILED);
@@ -93,34 +173,83 @@ export class AudioModule extends BaseClient {
   // BASE64 AUDIO FILE METHODS
   // ======================
 
+  /**
+   * Create a base64 audio file record.
+   *
+   * @param dto - The session id and initial base64 audio chunks.
+   * @returns The created base64 audio file.
+   */
   public async createBase64AudioFile(dto: CreateBase64AudioFileDto): Promise<Base64AudioFile> {
     return this.request<Base64AudioFile>(`${urls.audioFiles}/base64`, 'POST', dto);
   }
 
+  /**
+   * Retrieve all base64 audio files accessible to the current user.
+   *
+   * @returns An array of base64 audio files.
+   */
   public async getAllBase64AudioFiles(): Promise<Base64AudioFile[]> {
     return this.request<Base64AudioFile[]>(`${urls.audioFiles}/base64/all`, 'GET');
   }
 
+  /**
+   * Retrieve base64 audio files for a given session.
+   *
+   * @param sessionId - UUID of the session.
+   * @returns An array of base64 audio files for the session.
+   */
   public async getBase64AudioFilesBySession(sessionId: string): Promise<Base64AudioFile[]> {
     return this.request<Base64AudioFile[]>(`${urls.audioFiles}/base64/session/${sessionId}`, 'GET');
   }
 
+  /**
+   * Retrieve a single base64 audio file by id.
+   *
+   * @param id - UUID of the base64 audio file.
+   * @returns The requested base64 audio file.
+   */
   public async getBase64AudioFile(id: string): Promise<Base64AudioFile> {
     return this.request<Base64AudioFile>(`${urls.audioFiles}/base64/${id}`, 'GET');
   }
 
+  /**
+   * Update a base64 audio file record.
+   *
+   * @param id - UUID of the base64 audio file to update.
+   * @param updates - Fields to update (session id and/or audio chunks).
+   * @returns The updated base64 audio file.
+   */
   public async updateBase64AudioFile(id: string, updates: UpdateBase64AudioFileDto): Promise<Base64AudioFile> {
     return this.request<Base64AudioFile>(`${urls.audioFiles}/base64/${id}`, 'PATCH', updates);
   }
 
+  /**
+   * Delete a base64 audio file by id.
+   *
+   * @param id - UUID of the base64 audio file to delete.
+   * @returns A promise that resolves once the record is deleted.
+   */
   public async deleteBase64AudioFile(id: string): Promise<void> {
     await this.request(`${urls.audioFiles}/base64/${id}`, 'DELETE');
   }
 
+  /**
+   * Append base64 audio chunks to a session's base64 audio file.
+   *
+   * @param sessionId - UUID of the session.
+   * @param base64Chunks - The base64-encoded audio chunks to append.
+   * @returns The count of chunks now stored.
+   */
   public async addBase64Chunk(sessionId: string, base64Chunks: string[]): Promise<AddBase64ChunkResponse> {
     return this.request<AddBase64ChunkResponse>(`${urls.audioFiles}/base64/add-chunk/${sessionId}`, 'POST', { base64Chunks });
   }
 
+  /**
+   * Queue a session's accumulated base64 audio for transcription.
+   *
+   * @param sessionId - UUID of the session to transcribe.
+   * @returns An object indicating whether queuing succeeded.
+   */
   public async queueSessionBase64AudioForTranscription(sessionId: string): Promise<{ success: boolean }> {
     return this.request<{ success: boolean }>(`${urls.audioFiles}/session/${sessionId}/transcribe`, 'POST');
   }
@@ -129,6 +258,15 @@ export class AudioModule extends BaseClient {
   // DIRECT TRANSCRIPTION METHODS
   // ======================
 
+  /**
+   * Transcribe an audio file directly without persisting it to a session.
+   *
+   * @param file - The audio file or blob to transcribe.
+   * @param fileName - Optional file name to send with the upload.
+   * @param useFineTuned - Optional flag to use the fine-tuned transcription model.
+   * @param onProgress - Optional callback invoked with the upload percentage (0-100).
+   * @returns An object containing the resulting transcription text.
+   */
   public async transcribeAudioFileDirect(file: File | Blob, fileName?: string, useFineTuned?: boolean, onProgress?: (percentage: number) => void): Promise<{ transcription?: string }> {
     const formData = new FormData();
     formData.append('file', file, fileName);