whio-api-sdk 1.1.28 → 1.1.33

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,193 @@ 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);
   }
 
+  /**
+   * Activate (enable) a user by ID.
+   *
+   * Requires superuser or organization-admin privileges; an organization admin
+   * may only activate users within their own organization.
+   *
+   * @param id - UUID of the user to activate.
+   * @returns The updated user with `isActive` set to `true`.
+   */
+  public async activateUser(id: string): Promise<User> {
+    return this.request<User>(`${urls.users}/${id}/activate`, 'PATCH');
+  }
+
+  /**
+   * Deactivate (disable) a user by ID.
+   *
+   * Requires superuser or organization-admin privileges; an organization admin
+   * may only deactivate users within their own organization. Deactivation takes
+   * effect immediately: the user can no longer authenticate.
+   *
+   * @param id - UUID of the user to deactivate.
+   * @returns The updated user with `isActive` set to `false`.
+   */
+  public async deactivateUser(id: string): Promise<User> {
+    return this.request<User>(`${urls.users}/${id}/deactivate`, 'PATCH');
+  }
+
+  /**
+   * 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');
   }

package/src/sdk/sdk.ts

@@ -13,7 +13,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';
@@ -39,7 +38,6 @@ export class ApiSDK extends BaseClient {
   public readonly workflows: WorkflowModule;
   public readonly integrationActions: IntegrationActionModule;
   public readonly logs: LogModule;
-  public readonly debug: DebugModule;
   public readonly externalIntegrations: ExternalIntegrationModule;
   public readonly websocket: WebSocketModule | null;
   public readonly reports: ReportsModule;
@@ -68,7 +66,6 @@ export class ApiSDK extends BaseClient {
     this.workflows = new WorkflowModule(config);
     this.integrationActions = new IntegrationActionModule(config);
     this.logs = new LogModule(config);
-    this.debug = new DebugModule(config);
     this.externalIntegrations = new ExternalIntegrationModule(config);
     this.websocket = config.skipWebsocket ? null : new WebSocketModule(config);
     this.reports = new ReportsModule(config);
@@ -82,7 +79,7 @@ export class ApiSDK extends BaseClient {
     this.modules = [
       this.auth, this.users, this.organizations, this.teams, this.templates,
       this.transcriptionSummaries, this.sessions, this.agents, this.audio,
-      this.workflows, this.integrationActions, this.logs, this.debug, this.externalIntegrations,
+      this.workflows, this.integrationActions, this.logs, this.externalIntegrations,
       this.reports, this.patients, this.dataStrategies, this.systemSnapshots, this.ratings,
       this.tiaki,
       ...(this.websocket ? [this.websocket] : [])
@@ -183,6 +180,17 @@ export class ApiSDK extends BaseClient {
     return result;
   }
 
+  public async loginWithEntra(...args: Parameters<AuthModule['loginWithEntra']>) {
+    const result = await this.auth.loginWithEntra(...args);
+    // Sync user state across all modules after successful login
+    await this.syncUserState(result.user, result.access_token, result.refresh_token);
+    return result;
+  }
+
+  public async connectEntra(...args: Parameters<AuthModule['connectEntra']>) {
+    return this.auth.connectEntra(...args);
+  }
+
   // User methods
   public async createUser(...args: Parameters<UserModule['createUser']>) {
     return this.users.createUser(...args);
@@ -310,10 +318,6 @@ export class ApiSDK extends BaseClient {
     return this.teams.deleteTeam(...args);
   }
 
-  public async removeUserFromTeamFixed(...args: Parameters<TeamModule['removeUserFromTeamFixed']>) {
-    return this.teams.removeUserFromTeamFixed(...args);
-  }
-
   // Template methods
   public async createTemplate(...args: Parameters<TemplateModule['createTemplate']>) {
     return this.templates.createTemplate(...args);
@@ -391,18 +395,6 @@ export class ApiSDK extends BaseClient {
     return this.transcriptionSummaries.deleteTranscriptionSummary(...args);
   }
 
-  public async uploadLargeAudioFile(...args: Parameters<TemplateModule['uploadLargeAudioFile']>) {
-    return this.templates.uploadLargeAudioFile(...args);
-  }
-
-  public async uploadAudioFile(...args: Parameters<TemplateModule['uploadAudioFile']>) {
-    return this.templates.uploadAudioFile(...args);
-  }
-
-  public async transcribeBase64Audio(...args: Parameters<TemplateModule['transcribeBase64Audio']>) {
-    return this.templates.transcribeBase64Audio(...args);
-  }
-
   // Session methods (user - own sessions only)
   public async createSession(...args: Parameters<SessionModule['createSession']>) {
     return this.sessions.createSession(...args);
@@ -734,23 +726,6 @@ export class ApiSDK extends BaseClient {
     return this.logs.cleanupOldLogs(...args);
   }
 
-  // Debug methods
-  public async getSessionsWithoutMedicalTranscriptions(...args: Parameters<DebugModule['getSessionsWithoutMedicalTranscriptions']>) {
-    return this.debug.getSessionsWithoutMedicalTranscriptions(...args);
-  }
-
-  public async downloadSessionAsZip(...args: Parameters<DebugModule['downloadSessionAsZip']>) {
-    return this.debug.downloadSessionAsZip(...args);
-  }
-
-  public async downloadSessionAsZipUrl(...args: Parameters<DebugModule['downloadSessionAsZipUrl']>) {
-    return this.debug.downloadSessionAsZipUrl(...args);
-  }
-
-  public async downloadSessionAndTriggerDownload(...args: Parameters<DebugModule['downloadSessionAndTriggerDownload']>) {
-    return this.debug.downloadSessionAndTriggerDownload(...args);
-  }
-
   // External Integration methods
   public async createExternalIntegration(...args: Parameters<ExternalIntegrationModule['createExternalIntegration']>) {
     return this.externalIntegrations.createExternalIntegration(...args);

package/src/sdk/types/agent.types.ts

@@ -19,6 +19,11 @@ export interface AgentOrganization {
   organization?: Organization;
 }
 
+// Agent with guaranteed organizations relation (list/detail responses)
+export interface AgentWithOrganizations extends Agent {
+  organizations: AgentOrganization[];
+}
+
 // Agent DTOs
 export interface CreateAgentDto {
   name: string;

package/src/sdk/types/audio.types.ts

@@ -13,13 +13,17 @@ export interface AudioFile {
   id: string;
   originalName: string;
   fileName: string;
-  filePath: string;
-  fileSize: number;
+  filePath?: string;
+  fileSize?: number;
   mimeType: string;
   uploadId?: string;
   transcriptionUrl?: string;
-  transcription?: string;
-  cultural_transcription?: string;
+  taskId?: string;
+  uploadStatus?: string;
+  statusLink?: string;
+  cancelLink?: string;
+  downloadLink?: string;
+  progressPercent?: number;
   status: AudioFileStatus;
   createdAt: string;
   updatedAt: string;
@@ -44,15 +48,9 @@ export interface CreateAudioFileDto {
 
 export interface UpdateAudioFileDto {
   transcriptionUrl?: string;
-  transcription?: string;
-  cultural_transcription?: string;
   status?: AudioFileStatus;
 }
 
-export interface UploadAudioFileDto {
-  cultural_transcription?: string;
-}
-
 // Base64 Audio File types
 export interface Base64AudioFile {
   id: string;

package/src/sdk/types/data-strategy.types.ts

@@ -15,6 +15,9 @@ export interface DataStrategy {
   organization?: Organization;
 }
 
+// DataStrategy with guaranteed organization relation (API read responses always include it)
+export type DataStrategyWithOrganization = DataStrategy & { organization: Organization };
+
 // DataStrategy DTOs
 export interface CreateDataStrategyDto {
   organizationId: string;

package/src/sdk/types/external-integration.types.ts

@@ -7,6 +7,12 @@ export interface ExternalIntegration {
   getUserEndpoint: string;
   getPatientDataEndpoint: string;
   saveSummaryEndpoint: string;
+  /**
+   * The integration's API key.
+   *
+   * Sent as plaintext on write (create/update), stored encrypted at rest by the API,
+   * and returned MASKED on read (e.g. `****abcd`) — never the full plaintext value.
+   */
   apiKey: string;
   headerName: string;
   createdAt: string;