whio-api-sdk 1.1.27 → 1.1.29

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

@@ -13,6 +13,17 @@ export class TemplateModule extends BaseClient {
     // ======================
     // TEMPLATE METHODS
     // ======================
+    /**
+     * Create a template for the current user's organization, defaulting to the first category if none is given.
+     *
+     * @param title - Title of the template.
+     * @param content - Body content of the template.
+     * @param categoryId - Optional category UUID; the first available category is used when omitted.
+     * @param workflowId - Optional workflow UUID to associate with the template.
+     * @param agentId - Optional agent UUID to associate with the template.
+     * @param summaryQueueType - Optional queue type (PRIMARY or SECONDARY) for generated summaries.
+     * @returns The created template.
+     */
     createTemplate(title, content, categoryId, workflowId, agentId, summaryQueueType) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -38,6 +49,17 @@ export class TemplateModule extends BaseClient {
             return this.request(urls.templates, 'POST', createTemplateDto);
         });
     }
+    /**
+     * Update an existing template.
+     *
+     * @param title - New title of the template.
+     * @param content - New body content of the template.
+     * @param id - UUID of the template to update.
+     * @param workflowId - Optional workflow UUID to associate with the template.
+     * @param agentId - Optional agent UUID to associate with the template.
+     * @param summaryQueueType - Optional queue type (PRIMARY or SECONDARY), or null to clear it.
+     * @returns The updated template.
+     */
     updateTemplate(title, content, id, workflowId, agentId, summaryQueueType) {
         return __awaiter(this, void 0, void 0, function* () {
             const templateDto = {
@@ -52,21 +74,43 @@ export class TemplateModule extends BaseClient {
             return this.request(`${urls.templates}/${id}`, 'PATCH', templateDto);
         });
     }
+    /**
+     * Retrieve all templates accessible to the current user.
+     *
+     * @returns An array of templates.
+     */
     getTemplates() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.templates, 'GET');
         });
     }
+    /**
+     * Retrieve all templates belonging to the current user's organization.
+     *
+     * @returns An array of templates.
+     */
     getTemplatesByOrganization() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.templates}/organization`, 'GET');
         });
     }
+    /**
+     * Retrieve a single template by id.
+     *
+     * @param id - UUID of the template.
+     * @returns The requested template.
+     */
     getTemplate(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.templates}/${id}`, 'GET');
         });
     }
+    /**
+     * Delete a template by id.
+     *
+     * @param id - UUID of the template to delete.
+     * @returns A promise that resolves once the template is deleted.
+     */
     deleteTemplate(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.templates}/${id}`, 'DELETE');
@@ -75,16 +119,37 @@ export class TemplateModule extends BaseClient {
     // ======================
     // TEMPLATE INTEGRATION ACTION METHODS
     // ======================
+    /**
+     * Replace the full set of integration actions linked to a template.
+     *
+     * @param templateId - UUID of the template.
+     * @param integrationActionIds - The complete list of integration action UUIDs to set.
+     * @returns The updated template.
+     */
     setTemplateIntegrationActions(templateId, integrationActionIds) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.templates}/${templateId}/integration-actions`, 'PUT', { integrationActionIds });
         });
     }
+    /**
+     * Add integration actions to a template without removing existing ones.
+     *
+     * @param templateId - UUID of the template.
+     * @param integrationActionIds - The integration action UUIDs to add.
+     * @returns The updated template.
+     */
     addTemplateIntegrationActions(templateId, integrationActionIds) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.templates}/${templateId}/integration-actions`, 'POST', { integrationActionIds });
         });
     }
+    /**
+     * Remove integration actions from a template.
+     *
+     * @param templateId - UUID of the template.
+     * @param integrationActionIds - The integration action UUIDs to remove.
+     * @returns The updated template.
+     */
     removeTemplateIntegrationActions(templateId, integrationActionIds) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.templates}/${templateId}/integration-actions`, 'DELETE', { integrationActionIds });
@@ -93,55 +158,61 @@ export class TemplateModule extends BaseClient {
     // ======================
     // TEMPLATE CATEGORY METHODS
     // ======================
+    /**
+     * Retrieve all template categories.
+     *
+     * @returns An array of template categories.
+     */
     getTemplateCategories() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.templateCategories, 'GET');
         });
     }
+    /**
+     * Retrieve a single template category by id.
+     *
+     * @param id - UUID of the template category.
+     * @returns The requested template category.
+     */
     getTemplateCategory(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.templateCategories}/${id}`, 'GET');
         });
     }
+    /**
+     * Create a template category.
+     *
+     * @param name - Name of the new category.
+     * @returns The created template category.
+     */
     createTemplateCategory(name) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = { name };
             return this.request(urls.templateCategories, 'POST', dto);
         });
     }
+    /**
+     * Update a template category's name.
+     *
+     * @param id - UUID of the template category to update.
+     * @param name - New name for the category.
+     * @returns The updated template category.
+     */
     updateTemplateCategory(id, name) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = { name };
             return this.request(`${urls.templateCategories}/${id}`, 'PATCH', dto);
         });
     }
+    /**
+     * Delete a template category by id.
+     *
+     * @param id - UUID of the template category to delete.
+     * @returns A promise that resolves once the category is deleted.
+     */
     deleteTemplateCategory(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.templateCategories}/${id}`, 'DELETE');
         });
     }
-    // ======================
-    // AUDIO UPLOAD METHODS (for transcription)
-    // ======================
-    uploadLargeAudioFile(formData, onProgress) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const uploadId = yield this.fileUploadRequest(urls.uploadAudioLarge, formData, {}, onProgress);
-            const uploadIds = (yield this.storage.getItem('uploadIds')) || '[]';
-            const uploadIdsArray = JSON.parse(uploadIds);
-            yield this.storage.setItem('uploadIds', JSON.stringify([...uploadIdsArray, uploadId]));
-            return uploadId;
-        });
-    }
-    uploadAudioFile(formData, onProgress) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const data = yield this.fileUploadRequest(urls.uploadAudio, formData, {}, onProgress);
-            return data;
-        });
-    }
-    transcribeBase64Audio(base64String) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const transcript = yield this.request(urls.transcribeBase64Audio, 'POST', { base64Audio: base64String });
-            return transcript.transcript;
-        });
-    }
 }

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

@@ -1,13 +1,70 @@
 import { BaseClient } from './base-client';
-import { TranscriptionSummary, CreateTranscriptionSummaryDto } from '../types';
+import { TranscriptionSummary, GenerateSummaryResponse, CreateTranscriptionSummaryDto, UpdateTranscriptionSummaryDto } from '../types';
 export declare class TranscriptionSummaryModule extends BaseClient {
-    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 }`).
+     */
+    generateTranscriptionSummary(templateId: string, sessionId: string): Promise<GenerateSummaryResponse>;
+    /**
+     * 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.
+     */
     createTranscriptionSummary(dto: Omit<CreateTranscriptionSummaryDto, 'userId'>): Promise<TranscriptionSummary>;
-    updateTranscriptionSummary(id: string, content: string): Promise<TranscriptionSummary>;
+    /**
+     * 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.
+     */
+    updateTranscriptionSummary(id: string, dto: UpdateTranscriptionSummaryDto): Promise<TranscriptionSummary>;
+    /**
+     * Retrieve all transcription summaries accessible to the current user.
+     *
+     * @returns An array of transcription summaries.
+     */
     getTranscriptionSummaries(): Promise<TranscriptionSummary[]>;
+    /**
+     * Retrieve a single transcription summary by id.
+     *
+     * @param id - UUID of the transcription summary.
+     * @returns The requested transcription summary.
+     */
     getTranscriptionSummary(id: string): Promise<TranscriptionSummary>;
+    /**
+     * 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.
+     */
     getTranscriptionSummariesByUser(userId: string): Promise<TranscriptionSummary[]>;
+    /**
+     * 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.
+     */
     getByOrganizationTranscriptionSummaries(organizationId: string): Promise<TranscriptionSummary[]>;
+    /**
+     * 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.
+     */
     cloneTranscriptionSummary(id: string, content: string): Promise<TranscriptionSummary>;
+    /**
+     * 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.
+     */
     deleteTranscriptionSummary(id: string): Promise<void>;
 }

package/dist/src/sdk/modules/transcription-summary.module.js

@@ -13,6 +13,14 @@ export class TranscriptionSummaryModule extends BaseClient {
     // ======================
     // TRANSCRIPTION SUMMARY METHODS
     // ======================
+    /**
+     * 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 }`).
+     */
     generateTranscriptionSummary(templateId, sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             const user = this.validateUser();
@@ -21,43 +29,82 @@ export class TranscriptionSummaryModule extends BaseClient {
                 userId: user.id,
                 sessionId: sessionId,
             };
-            const transcriptionSummary = yield this.request(urls.transcriptionSummary, 'POST', generateSummaryDto);
-            return transcriptionSummary;
+            return this.request(urls.transcriptionSummary, 'POST', generateSummaryDto);
         });
     }
+    /**
+     * 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.
+     */
     createTranscriptionSummary(dto) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.transcriptionSummaryCreate, 'POST', dto);
         });
     }
-    updateTranscriptionSummary(id, content) {
+    /**
+     * 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.
+     */
+    updateTranscriptionSummary(id, dto) {
         return __awaiter(this, void 0, void 0, function* () {
-            const updateSummaryDto = {
-                content,
-            };
-            return this.request(`${urls.transcriptionSummaries}/${id}`, 'PATCH', updateSummaryDto);
+            return this.request(`${urls.transcriptionSummaries}/${id}`, 'PATCH', dto);
         });
     }
+    /**
+     * Retrieve all transcription summaries accessible to the current user.
+     *
+     * @returns An array of transcription summaries.
+     */
     getTranscriptionSummaries() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.transcriptionSummaries, 'GET');
         });
     }
+    /**
+     * Retrieve a single transcription summary by id.
+     *
+     * @param id - UUID of the transcription summary.
+     * @returns The requested transcription summary.
+     */
     getTranscriptionSummary(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     getTranscriptionSummariesByUser(userId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     getByOrganizationTranscriptionSummaries(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     cloneTranscriptionSummary(id, content) {
         return __awaiter(this, void 0, void 0, function* () {
             const cloneDto = {
@@ -66,6 +113,12 @@ export class TranscriptionSummaryModule extends BaseClient {
             return this.request(`${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.
+     */
     deleteTranscriptionSummary(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.transcriptionSummaries}/${id}`, 'DELETE');

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

@@ -1,21 +1,127 @@
 import { BaseClient } from './base-client';
 import { User, UpdateUserDto, UpdateUserNamesDto } from '../types';
 export declare 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.
+     */
     createUser(firstName: string, lastName: string, email: string, password: string): Promise<User>;
     private assignRoleToUser;
+    /**
+     * 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.
+     */
     assignEditorToRoleToUser(userId: string, organizationId?: string): Promise<User>;
+    /**
+     * 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.
+     */
     assignAdminToRoleToUser(userId: string, organizationId?: string): Promise<User>;
+    /**
+     * 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.
+     */
     assignDisabledToRoleToUser(userId: string, organizationId?: string): Promise<User>;
+    /**
+     * 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.
+     */
     removeRoleFromUser(userId: string, organizationRoleId: string): Promise<void>;
+    /**
+     * 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.
+     */
     createEditorUser(firstName: string, lastName: string, email: string, password: string): Promise<User>;
+    /**
+     * 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.
+     */
     createAdminUser(firstName: string, lastName: string, email: string, password: string): Promise<User>;
+    /**
+     * 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.
+     */
     createDisabledUser(firstName: string, lastName: string, email: string, password: string): Promise<User>;
+    /**
+     * List all users the current user can access.
+     *
+     * @returns An array of users.
+     */
     getUsers(): Promise<User[]>;
+    /**
+     * Get a single user by ID.
+     *
+     * @param id - UUID of the user.
+     * @returns The requested user.
+     */
     getUser(id: string): Promise<User>;
+    /**
+     * List all users belonging to an organization.
+     *
+     * @param organizationId - UUID of the organization.
+     * @returns An array of users in the organization.
+     */
     getUsersByOrganization(organizationId: string): Promise<User[]>;
+    /**
+     * 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.
+     */
     updateUser(id: string, data: UpdateUserDto): Promise<User>;
+    /**
+     * Delete a user by ID.
+     *
+     * @param id - UUID of the user to delete.
+     * @returns A promise that resolves when the user is deleted.
+     */
     deleteUser(id: string): Promise<void>;
+    /**
+     * Update the current user's first and/or last name.
+     *
+     * @param data - The name fields to update.
+     * @returns The updated user.
+     */
     updateNames(data: UpdateUserNamesDto): Promise<User>;
+    /**
+     * Register an Expo push token for the current user.
+     *
+     * @param token - The Expo push token to add.
+     * @returns A confirmation message.
+     */
     addExpoPushToken(token: string): Promise<{
         message: string;
     }>;