whio-api-sdk 1.1.27 → 1.1.29

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

@@ -14,6 +14,15 @@ 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.
+     */
     uploadAudioFileToSession(sessionId, file, fileName, onProgress) {
         return __awaiter(this, void 0, void 0, function* () {
             const formData = new FormData();
@@ -21,56 +30,113 @@ export class AudioModule extends BaseClient {
             return this.fileUploadRequest(`${urls.audioFiles}/upload/${sessionId}`, formData, {}, onProgress);
         });
     }
+    /**
+     * 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, file, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const formData = new FormData();
             formData.append('file', file, options === null || options === void 0 ? void 0 : options.fileName);
-            if (options === null || options === void 0 ? void 0 : options.culturalTranscription) {
-                formData.append('cultural_transcription', options.culturalTranscription);
-            }
             return this.fileUploadRequest(`${urls.audioFiles}/upload/${sessionId}`, formData, {}, options === null || options === void 0 ? void 0 : options.onProgress);
         });
     }
+    /**
+     * Retrieve the current user's audio files.
+     *
+     * @returns An array of audio files belonging to the current user.
+     */
     getMyAudioFiles() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.audioFiles}/my-files`, 'GET');
         });
     }
+    /**
+     * Retrieve all audio files accessible to the current user.
+     *
+     * @returns An array of audio files.
+     */
     getAllAudioFiles() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.audioFiles}/all`, 'GET');
         });
     }
+    /**
+     * Retrieve all audio files belonging to the current user's organization.
+     *
+     * @returns An array of audio files.
+     */
     getOrganizationAudioFiles() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     getAudioFilesBySession(sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.audioFiles}/session/${sessionId}`, 'GET');
         });
     }
+    /**
+     * Retrieve a single audio file by id.
+     *
+     * @param id - UUID of the audio file.
+     * @returns The requested audio file.
+     */
     getAudioFile(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     updateAudioFile(id, updates) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.audioFiles}/${id}`, 'PATCH', updates);
         });
     }
+    /**
+     * Delete an audio file by id.
+     *
+     * @param id - UUID of the audio file to delete.
+     * @returns The deleted audio file record.
+     */
     deleteAudioFile(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.audioFiles}/${id}`, 'DELETE');
+            return this.request(`${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.
+     */
     downloadAudioFile(id) {
         return __awaiter(this, void 0, void 0, function* () {
             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.
+     */
     downloadAudioFileAsUrl(id) {
         return __awaiter(this, void 0, void 0, function* () {
             const blob = yield this.downloadAudioFile(id);
@@ -80,18 +146,33 @@ 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.
+     */
     getTranscribedAudioFiles() {
         return __awaiter(this, void 0, void 0, function* () {
             const audioFiles = yield 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.
+     */
     getProcessingAudioFiles() {
         return __awaiter(this, void 0, void 0, function* () {
             const audioFiles = yield 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.
+     */
     getFailedAudioFiles() {
         return __awaiter(this, void 0, void 0, function* () {
             const audioFiles = yield this.getMyAudioFiles();
@@ -101,41 +182,90 @@ 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.
+     */
     createBase64AudioFile(dto) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.audioFiles}/base64`, 'POST', dto);
         });
     }
+    /**
+     * Retrieve all base64 audio files accessible to the current user.
+     *
+     * @returns An array of base64 audio files.
+     */
     getAllBase64AudioFiles() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     getBase64AudioFilesBySession(sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     getBase64AudioFile(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     updateBase64AudioFile(id, updates) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     deleteBase64AudioFile(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield 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.
+     */
     addBase64Chunk(sessionId, base64Chunks) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     queueSessionBase64AudioForTranscription(sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.audioFiles}/session/${sessionId}/transcribe`, 'POST');
@@ -144,6 +274,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.
+     */
     transcribeAudioFileDirect(file, fileName, useFineTuned, onProgress) {
         return __awaiter(this, void 0, void 0, function* () {
             const formData = new FormData();

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

@@ -1,14 +1,57 @@
 import { BaseClient } from './base-client';
 import { LoginCredentials, LoginResponse, PasswordChangeResponse, User } from '../types';
 export declare class AuthModule extends BaseClient {
+    /**
+     * Authenticate with email and password and persist the resulting session.
+     *
+     * @param credentials - The login credentials (email and password).
+     * @returns The login response including access/refresh tokens and the user.
+     */
     login(credentials: LoginCredentials): Promise<LoginResponse>;
+    /**
+     * Request a one-time login code be sent to the given email address.
+     *
+     * @param email - The email address to send the login code to.
+     * @returns A confirmation message.
+     */
     requestLoginCode(email: string): Promise<{
         message: string;
     }>;
+    /**
+     * Authenticate with an email and one-time login code and persist the session.
+     *
+     * @param email - The email address the code was sent to.
+     * @param code - The one-time login code.
+     * @returns The login response including access/refresh tokens and the user.
+     */
     loginWithCode(email: string, code: string): Promise<LoginResponse>;
+    /**
+     * Clear the current session and any persisted authentication state.
+     *
+     * @returns A promise that resolves when the session is cleared.
+     */
     logout(): Promise<void>;
+    /**
+     * Fetch the authenticated user's profile.
+     *
+     * @returns The current user.
+     */
     getProfile(): Promise<User>;
+    /**
+     * Change the authenticated user's password.
+     *
+     * @param currentPassword - The user's current password.
+     * @param newPassword - The new password to set.
+     * @returns The password change response.
+     */
     changePassword(currentPassword: string, newPassword: string): Promise<PasswordChangeResponse>;
+    /**
+     * Change another user's password as an administrator.
+     *
+     * @param userId - UUID of the user whose password is being changed.
+     * @param newPassword - The new password to set.
+     * @returns The password change response.
+     */
     adminChangePassword(userId: string, newPassword: string): Promise<PasswordChangeResponse>;
     private updateAuthState;
 }

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

@@ -10,6 +10,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { BaseClient } from './base-client';
 import urls from '../urls';
 export class AuthModule extends BaseClient {
+    /**
+     * Authenticate with email and password and persist the resulting session.
+     *
+     * @param credentials - The login credentials (email and password).
+     * @returns The login response including access/refresh tokens and the user.
+     */
     login(credentials) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -23,11 +29,24 @@ export class AuthModule extends BaseClient {
             }
         });
     }
+    /**
+     * Request a one-time login code be sent to the given email address.
+     *
+     * @param email - The email address to send the login code to.
+     * @returns A confirmation message.
+     */
     requestLoginCode(email) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request('/auth/request-login-code', 'POST', { email }, {}, true);
         });
     }
+    /**
+     * Authenticate with an email and one-time login code and persist the session.
+     *
+     * @param email - The email address the code was sent to.
+     * @param code - The one-time login code.
+     * @returns The login response including access/refresh tokens and the user.
+     */
     loginWithCode(email, code) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -41,16 +60,33 @@ export class AuthModule extends BaseClient {
             }
         });
     }
+    /**
+     * Clear the current session and any persisted authentication state.
+     *
+     * @returns A promise that resolves when the session is cleared.
+     */
     logout() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.clearAuth();
         });
     }
+    /**
+     * Fetch the authenticated user's profile.
+     *
+     * @returns The current user.
+     */
     getProfile() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.profile, 'GET');
         });
     }
+    /**
+     * Change the authenticated user's password.
+     *
+     * @param currentPassword - The user's current password.
+     * @param newPassword - The new password to set.
+     * @returns The password change response.
+     */
     changePassword(currentPassword, newPassword) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = {
@@ -60,6 +96,13 @@ export class AuthModule extends BaseClient {
             return this.request(urls.changePassword, 'PATCH', dto);
         });
     }
+    /**
+     * Change another user's password as an administrator.
+     *
+     * @param userId - UUID of the user whose password is being changed.
+     * @param newPassword - The new password to set.
+     * @returns The password change response.
+     */
     adminChangePassword(userId, newPassword) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = {

package/dist/src/sdk/modules/data-strategy.module.d.ts

@@ -1,10 +1,48 @@
 import { BaseClient } from './base-client';
-import { DataStrategy, CreateDataStrategyDto, UpdateDataStrategyDto } from '../types';
+import { DataStrategy, DataStrategyWithOrganization, CreateDataStrategyDto, UpdateDataStrategyDto } from '../types';
 export declare class DataStrategyModule extends BaseClient {
-    createDataStrategy(organizationId?: string, options?: Omit<CreateDataStrategyDto, 'organizationId'>): Promise<DataStrategy>;
-    getDataStrategies(organizationId?: string): Promise<DataStrategy[]>;
-    getDataStrategy(id: string): Promise<DataStrategy>;
-    getDataStrategyByOrganization(organizationId?: string): Promise<DataStrategy>;
-    updateDataStrategy(id: string, data: UpdateDataStrategyDto): Promise<DataStrategy>;
-    deleteDataStrategy(id: string): Promise<void>;
+    /**
+     * Create a data strategy for an organization.
+     *
+     * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+     * @param options - Optional retention settings for the data strategy.
+     * @returns The created data strategy with its organization populated.
+     */
+    createDataStrategy(organizationId?: string, options?: Omit<CreateDataStrategyDto, 'organizationId'>): Promise<DataStrategyWithOrganization>;
+    /**
+     * List data strategies, optionally filtered by organization.
+     *
+     * @param organizationId - Optional organization UUID to filter by.
+     * @returns An array of data strategies, each with its organization populated.
+     */
+    getDataStrategies(organizationId?: string): Promise<DataStrategyWithOrganization[]>;
+    /**
+     * Get a single data strategy by id.
+     *
+     * @param id - UUID of the data strategy.
+     * @returns The data strategy with its organization populated.
+     */
+    getDataStrategy(id: string): Promise<DataStrategyWithOrganization>;
+    /**
+     * Get the data strategy for a specific organization.
+     *
+     * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+     * @returns The data strategy with its organization populated.
+     */
+    getDataStrategyByOrganization(organizationId?: string): Promise<DataStrategyWithOrganization>;
+    /**
+     * Update a data strategy.
+     *
+     * @param id - UUID of the data strategy to update.
+     * @param data - The retention settings to update.
+     * @returns The updated data strategy with its organization populated.
+     */
+    updateDataStrategy(id: string, data: UpdateDataStrategyDto): Promise<DataStrategyWithOrganization>;
+    /**
+     * Delete a data strategy.
+     *
+     * @param id - UUID of the data strategy to delete.
+     * @returns The deleted data strategy entity.
+     */
+    deleteDataStrategy(id: string): Promise<DataStrategy>;
 }

package/dist/src/sdk/modules/data-strategy.module.js

@@ -10,37 +10,75 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { BaseClient } from './base-client';
 import urls from '../urls';
 export class DataStrategyModule extends BaseClient {
+    /**
+     * Create a data strategy for an organization.
+     *
+     * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+     * @param options - Optional retention settings for the data strategy.
+     * @returns The created data strategy with its organization populated.
+     */
     createDataStrategy(organizationId, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = Object.assign({ organizationId: organizationId || this.user.organizationId }, options);
             return this.request(urls.dataStrategies, 'POST', dto);
         });
     }
+    /**
+     * List data strategies, optionally filtered by organization.
+     *
+     * @param organizationId - Optional organization UUID to filter by.
+     * @returns An array of data strategies, each with its organization populated.
+     */
     getDataStrategies(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = organizationId ? `?organizationId=${organizationId}` : '';
             return this.request(`${urls.dataStrategies}${params}`, 'GET');
         });
     }
+    /**
+     * Get a single data strategy by id.
+     *
+     * @param id - UUID of the data strategy.
+     * @returns The data strategy with its organization populated.
+     */
     getDataStrategy(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.dataStrategies}/${id}`, 'GET');
         });
     }
+    /**
+     * Get the data strategy for a specific organization.
+     *
+     * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+     * @returns The data strategy with its organization populated.
+     */
     getDataStrategyByOrganization(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             const orgId = organizationId || this.user.organizationId;
             return this.request(`${urls.dataStrategies}?organizationId=${orgId}`, 'GET');
         });
     }
+    /**
+     * Update a data strategy.
+     *
+     * @param id - UUID of the data strategy to update.
+     * @param data - The retention settings to update.
+     * @returns The updated data strategy with its organization populated.
+     */
     updateDataStrategy(id, data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.dataStrategies}/${id}`, 'PATCH', data);
         });
     }
+    /**
+     * Delete a data strategy.
+     *
+     * @param id - UUID of the data strategy to delete.
+     * @returns The deleted data strategy entity.
+     */
     deleteDataStrategy(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.dataStrategies}/${id}`, 'DELETE');
+            return this.request(`${urls.dataStrategies}/${id}`, 'DELETE');
         });
     }
 }

package/dist/src/sdk/modules/external-integration.module.d.ts

@@ -1,9 +1,39 @@
 import { BaseClient } from './base-client';
 import { ExternalIntegration, CreateExternalIntegrationDto, UpdateExternalIntegrationDto } from '../types';
 export declare class ExternalIntegrationModule extends BaseClient {
+    /**
+     * Create an external integration. The `apiKey` is sent as plaintext and stored encrypted at rest.
+     *
+     * @param data - The external integration payload (endpoints, apiKey, headerName, etc.).
+     * @returns The created external integration (its `apiKey` is returned masked).
+     */
     createExternalIntegration(data: CreateExternalIntegrationDto): Promise<ExternalIntegration>;
+    /**
+     * List all external integrations.
+     *
+     * @returns An array of external integrations (each `apiKey` is returned masked).
+     */
     getExternalIntegrations(): Promise<ExternalIntegration[]>;
+    /**
+     * Get a single external integration by id.
+     *
+     * @param id - UUID of the external integration.
+     * @returns The external integration (its `apiKey` is returned masked).
+     */
     getExternalIntegration(id: string): Promise<ExternalIntegration>;
+    /**
+     * Update an external integration. A supplied `apiKey` is sent as plaintext and stored encrypted at rest.
+     *
+     * @param id - UUID of the external integration to update.
+     * @param data - The fields to update.
+     * @returns The updated external integration (its `apiKey` is returned masked).
+     */
     updateExternalIntegration(id: string, data: UpdateExternalIntegrationDto): Promise<ExternalIntegration>;
+    /**
+     * Delete an external integration.
+     *
+     * @param id - UUID of the external integration to delete.
+     * @returns A promise that resolves when the integration has been deleted.
+     */
     deleteExternalIntegration(id: string): Promise<void>;
 }

package/dist/src/sdk/modules/external-integration.module.js

@@ -10,26 +10,56 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { BaseClient } from './base-client';
 import urls from '../urls';
 export class ExternalIntegrationModule extends BaseClient {
+    /**
+     * Create an external integration. The `apiKey` is sent as plaintext and stored encrypted at rest.
+     *
+     * @param data - The external integration payload (endpoints, apiKey, headerName, etc.).
+     * @returns The created external integration (its `apiKey` is returned masked).
+     */
     createExternalIntegration(data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.externalIntegrations, 'POST', data);
         });
     }
+    /**
+     * List all external integrations.
+     *
+     * @returns An array of external integrations (each `apiKey` is returned masked).
+     */
     getExternalIntegrations() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.externalIntegrations, 'GET');
         });
     }
+    /**
+     * Get a single external integration by id.
+     *
+     * @param id - UUID of the external integration.
+     * @returns The external integration (its `apiKey` is returned masked).
+     */
     getExternalIntegration(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.externalIntegrations}/${id}`, 'GET');
         });
     }
+    /**
+     * Update an external integration. A supplied `apiKey` is sent as plaintext and stored encrypted at rest.
+     *
+     * @param id - UUID of the external integration to update.
+     * @param data - The fields to update.
+     * @returns The updated external integration (its `apiKey` is returned masked).
+     */
     updateExternalIntegration(id, data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.externalIntegrations}/${id}`, 'PATCH', data);
         });
     }
+    /**
+     * Delete an external integration.
+     *
+     * @param id - UUID of the external integration to delete.
+     * @returns A promise that resolves when the integration has been deleted.
+     */
     deleteExternalIntegration(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.externalIntegrations}/${id}`, 'DELETE');