whio-api-sdk 1.1.28 → 1.1.29

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

@@ -1,17 +1,102 @@
 import { BaseClient } from './base-client';
-import { Agent, AgentSettings, CreateAgentSettingsDto, UpdateAgentSettingsDto } from '../types';
+import { Agent, AgentWithOrganizations, AgentOrganization, AgentSettings, CreateAgentSettingsDto, UpdateAgentSettingsDto } from '../types';
 export declare class AgentModule extends BaseClient {
+    /**
+     * 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.
+     */
     createAgent(name: string, templateTextReplacement?: string): Promise<Agent>;
-    getAgents(): Promise<Agent[]>;
-    getAgent(id: string): Promise<Agent>;
+    /**
+     * List all agents, each including its linked organizations.
+     *
+     * @returns An array of agents with their organizations relation populated.
+     */
+    getAgents(): Promise<AgentWithOrganizations[]>;
+    /**
+     * Get a single agent by id, including its linked organizations.
+     *
+     * @param id - UUID of the agent.
+     * @returns The agent with its organizations relation populated.
+     */
+    getAgent(id: string): Promise<AgentWithOrganizations>;
+    /**
+     * 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.
+     */
     updateAgent(id: string, name: string, templateTextReplacement?: string): Promise<Agent>;
+    /**
+     * Delete an agent.
+     *
+     * @param id - UUID of the agent to delete.
+     * @returns A promise that resolves when the agent has been deleted.
+     */
     deleteAgent(id: string): Promise<void>;
-    addAgentToOrganization(agentId: string, organizationId: string): Promise<void>;
-    removeAgentFromOrganization(agentId: string, organizationId: string): Promise<void>;
+    /**
+     * 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.
+     */
+    addAgentToOrganization(agentId: string, organizationId: string): Promise<AgentOrganization>;
+    /**
+     * 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.
+     */
+    removeAgentFromOrganization(agentId: string, organizationId: string): Promise<AgentOrganization>;
+    /**
+     * 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.
+     */
     createAgentSettings(settingsData: CreateAgentSettingsDto): Promise<AgentSettings>;
+    /**
+     * 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.
+     */
     getAgentSettings(organizationId?: string, agentId?: string): Promise<AgentSettings[]>;
+    /**
+     * Get a single agent settings record by id.
+     *
+     * @param id - UUID of the agent settings record.
+     * @returns The agent settings record.
+     */
     getAgentSettingsById(id: string): Promise<AgentSettings>;
+    /**
+     * 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.
+     */
     getAgentSettingsByAgentAndOrganization(agentId: string, organizationId: string): Promise<AgentSettings>;
+    /**
+     * 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.
+     */
     updateAgentSettings(id: string, settingsData: UpdateAgentSettingsDto): Promise<AgentSettings>;
+    /**
+     * 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.
+     */
     deleteAgentSettings(id: string): Promise<void>;
 }

package/dist/src/sdk/modules/agent.module.js

@@ -13,51 +13,110 @@ 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.
+     */
     createAgent(name, templateTextReplacement) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = { name, templateTextReplacement };
             return this.request(urls.agents, 'POST', dto);
         });
     }
+    /**
+     * List all agents, each including its linked organizations.
+     *
+     * @returns An array of agents with their organizations relation populated.
+     */
     getAgents() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.agents, '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.
+     */
     getAgent(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     updateAgent(id, name, templateTextReplacement) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = { name, templateTextReplacement };
             return this.request(`${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.
+     */
     deleteAgent(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.agents}/${id}`, 'DELETE');
         });
     }
+    /**
+     * 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.
+     */
     addAgentToOrganization(agentId, organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.agents}/${agentId}/organizations/${organizationId}`, 'POST');
+            return this.request(`${urls.agents}/${agentId}/organizations/${organizationId}`, 'POST');
         });
     }
+    /**
+     * 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.
+     */
     removeAgentFromOrganization(agentId, organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.agents}/${agentId}/organizations/${organizationId}`, 'DELETE');
+            return this.request(`${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.
+     */
     createAgentSettings(settingsData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(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.
+     */
     getAgentSettings(organizationId, agentId) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = new URLSearchParams();
@@ -70,21 +129,47 @@ export class AgentModule extends BaseClient {
             return this.request(endpoint, 'GET');
         });
     }
+    /**
+     * Get a single agent settings record by id.
+     *
+     * @param id - UUID of the agent settings record.
+     * @returns The agent settings record.
+     */
     getAgentSettingsById(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     getAgentSettingsByAgentAndOrganization(agentId, organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     updateAgentSettings(id, settingsData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     deleteAgentSettings(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.agentSettings}/${id}`, 'DELETE');

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

@@ -1,34 +1,175 @@
 import { BaseClient } from './base-client';
 import { AudioFile, UpdateAudioFileDto, Base64AudioFile, CreateBase64AudioFileDto, UpdateBase64AudioFileDto, AddBase64ChunkResponse } from '../types';
 export declare class AudioModule extends BaseClient {
+    /**
+     * 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.
+     */
     uploadAudioFileToSession(sessionId: string, file: File | Blob, fileName?: 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.
+     */
     uploadAudioFileWithTranscriptionQueue(sessionId: string, file: File | Blob, options?: {
         fileName?: string;
-        culturalTranscription?: string;
         onProgress?: (percentage: number) => void;
     }): Promise<AudioFile>;
+    /**
+     * Retrieve the current user's audio files.
+     *
+     * @returns An array of audio files belonging to the current user.
+     */
     getMyAudioFiles(): Promise<AudioFile[]>;
+    /**
+     * Retrieve all audio files accessible to the current user.
+     *
+     * @returns An array of audio files.
+     */
     getAllAudioFiles(): Promise<AudioFile[]>;
+    /**
+     * Retrieve all audio files belonging to the current user's organization.
+     *
+     * @returns An array of audio files.
+     */
     getOrganizationAudioFiles(): Promise<AudioFile[]>;
+    /**
+     * Retrieve all audio files for a given session.
+     *
+     * @param sessionId - UUID of the session.
+     * @returns An array of audio files for the session.
+     */
     getAudioFilesBySession(sessionId: string): Promise<AudioFile[]>;
+    /**
+     * Retrieve a single audio file by id.
+     *
+     * @param id - UUID of the audio file.
+     * @returns The requested audio file.
+     */
     getAudioFile(id: string): Promise<AudioFile>;
+    /**
+     * 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.
+     */
     updateAudioFile(id: string, updates: UpdateAudioFileDto): Promise<AudioFile>;
-    deleteAudioFile(id: string): Promise<void>;
+    /**
+     * Delete an audio file by id.
+     *
+     * @param id - UUID of the audio file to delete.
+     * @returns The deleted audio file record.
+     */
+    deleteAudioFile(id: string): Promise<AudioFile>;
+    /**
+     * Download an audio file as a blob.
+     *
+     * @param id - UUID of the audio file to download.
+     * @returns The audio file contents as a Blob.
+     */
     downloadAudioFile(id: string): Promise<Blob>;
+    /**
+     * 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.
+     */
     downloadAudioFileAsUrl(id: string): Promise<string>;
+    /**
+     * Retrieve the current user's audio files that have finished transcription.
+     *
+     * @returns An array of transcribed audio files.
+     */
     getTranscribedAudioFiles(): Promise<AudioFile[]>;
+    /**
+     * Retrieve the current user's audio files that are currently processing.
+     *
+     * @returns An array of processing audio files.
+     */
     getProcessingAudioFiles(): Promise<AudioFile[]>;
+    /**
+     * Retrieve the current user's audio files that failed processing.
+     *
+     * @returns An array of failed audio files.
+     */
     getFailedAudioFiles(): Promise<AudioFile[]>;
+    /**
+     * Create a base64 audio file record.
+     *
+     * @param dto - The session id and initial base64 audio chunks.
+     * @returns The created base64 audio file.
+     */
     createBase64AudioFile(dto: CreateBase64AudioFileDto): Promise<Base64AudioFile>;
+    /**
+     * Retrieve all base64 audio files accessible to the current user.
+     *
+     * @returns An array of base64 audio files.
+     */
     getAllBase64AudioFiles(): Promise<Base64AudioFile[]>;
+    /**
+     * Retrieve base64 audio files for a given session.
+     *
+     * @param sessionId - UUID of the session.
+     * @returns An array of base64 audio files for the session.
+     */
     getBase64AudioFilesBySession(sessionId: string): Promise<Base64AudioFile[]>;
+    /**
+     * Retrieve a single base64 audio file by id.
+     *
+     * @param id - UUID of the base64 audio file.
+     * @returns The requested base64 audio file.
+     */
     getBase64AudioFile(id: string): Promise<Base64AudioFile>;
+    /**
+     * 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.
+     */
     updateBase64AudioFile(id: string, updates: UpdateBase64AudioFileDto): Promise<Base64AudioFile>;
+    /**
+     * 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.
+     */
     deleteBase64AudioFile(id: string): Promise<void>;
+    /**
+     * 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.
+     */
     addBase64Chunk(sessionId: string, base64Chunks: string[]): Promise<AddBase64ChunkResponse>;
+    /**
+     * Queue a session's accumulated base64 audio for transcription.
+     *
+     * @param sessionId - UUID of the session to transcribe.
+     * @returns An object indicating whether queuing succeeded.
+     */
     queueSessionBase64AudioForTranscription(sessionId: string): Promise<{
         success: boolean;
     }>;
+    /**
+     * 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.
+     */
     transcribeAudioFileDirect(file: File | Blob, fileName?: string, useFineTuned?: boolean, onProgress?: (percentage: number) => void): Promise<{
         transcription?: string;
     }>;