whio-api-sdk 1.1.27 → 1.1.29

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

@@ -13,51 +13,112 @@ export class SessionModule extends BaseClient {
     // ======================
     // USER METHODS (own sessions only)
     // ======================
+    /**
+     * Create a new session.
+     *
+     * @param sessionData - The session payload to create.
+     * @returns The created session.
+     */
     createSession(sessionData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.sessions, 'POST', sessionData);
         });
     }
+    /**
+     * Retrieve the authenticated user's own sessions.
+     *
+     * @returns The current user's sessions.
+     */
     getSessions() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/my-sessions`, 'GET');
         });
     }
+    /**
+     * Retrieve a single session by its id.
+     *
+     * @param id - UUID of the session to fetch.
+     * @returns The requested session.
+     */
     getSession(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${id}`, 'GET');
         });
     }
+    /**
+     * Update a session.
+     *
+     * @param id - UUID of the session to update.
+     * @param sessionData - Fields to update on the session.
+     * @returns The updated session.
+     */
     updateSession(id, sessionData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${id}`, 'PATCH', sessionData);
         });
     }
+    /**
+     * Delete a session.
+     *
+     * @param id - UUID of the session to delete.
+     * @returns The deleted session.
+     */
     deleteSession(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.sessions}/${id}`, 'DELETE');
+            return this.request(`${urls.sessions}/${id}`, 'DELETE');
         });
     }
+    /**
+     * Set the primary transcription summary for a session.
+     *
+     * @param sessionId - UUID of the session.
+     * @param summaryId - UUID of the transcription summary to mark as primary.
+     * @returns The updated session.
+     */
     setPrimaryTranscriptionSummary(sessionId, summaryId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
         });
     }
+    /**
+     * Re-run transcription for a session.
+     *
+     * @param sessionId - UUID of the session to re-transcribe.
+     * @returns A confirmation message with the session id.
+     */
     rerunTranscription(sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${sessionId}/rerun-transcription`, 'POST');
         });
     }
+    /**
+     * Update the audio stream status of a session.
+     *
+     * @param data - The session id and the new audio stream status.
+     * @returns The updated session.
+     */
     setAudioStreamStatus(data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/set-audio-stream-status`, 'PATCH', data);
         });
     }
+    /**
+     * Forward a session to Tiaki.
+     *
+     * @param sessionId - UUID of the session to forward.
+     * @returns A response containing a status message.
+     */
     forwardToTiaki(sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/forward-to-tiaki/${sessionId}`, 'POST');
         });
     }
+    /**
+     * Search the authenticated user's sessions using the provided filters.
+     *
+     * @param filters - Optional search filters (date range, user, template, pagination, etc.).
+     * @returns A paginated search response of matching sessions.
+     */
     searchSessions(filters = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = this.buildSearchParams(filters);
@@ -69,11 +130,24 @@ export class SessionModule extends BaseClient {
     // ======================
     // SUPERUSER METHODS
     // ======================
+    /**
+     * Retrieve all sessions belonging to a specific user (superuser scope).
+     *
+     * @param userId - UUID of the user whose sessions to fetch.
+     * @returns The user's sessions.
+     */
     superuserGetSessionsByUser(userId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(`${urls.sessions}/superuser/user/${userId}`, 'GET');
+            return this.request(`${urls.sessions}/user/${userId}`, 'GET');
         });
     }
+    /**
+     * Retrieve a paginated list of sessions for the organization (superuser scope).
+     *
+     * @param limit - Maximum number of sessions to return (default 100).
+     * @param offset - Number of sessions to skip for pagination (default 0).
+     * @returns A paginated sessions response.
+     */
     superuserGetSessionsByOrganization(limit = 100, offset = 0) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = new URLSearchParams();
@@ -82,66 +156,131 @@ export class SessionModule extends BaseClient {
             return this.request(`${urls.sessions}/organization?${params.toString()}`, 'GET');
         });
     }
+    /**
+     * Search sessions using the provided filters (superuser scope).
+     *
+     * @param filters - Optional search filters (date range, user, template, pagination, etc.).
+     * @returns A paginated search response of matching sessions.
+     */
     superuserSearchSessions(filters = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = this.buildSearchParams(filters);
             const queryString = params.toString();
-            const url = queryString ? `${urls.sessions}/superuser/search?${queryString}` : `${urls.sessions}/superuser/search`;
+            const url = queryString ? `${urls.sessions}/search?${queryString}` : `${urls.sessions}/search`;
             return this.request(url, 'GET');
         });
     }
+    /**
+     * Update a session (superuser scope).
+     *
+     * @param id - UUID of the session to update.
+     * @param sessionData - Fields to update on the session.
+     * @returns The updated session.
+     */
     superuserUpdateSession(id, sessionData) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(`${urls.sessions}/superuser/${id}`, 'PATCH', sessionData);
+            return this.request(`${urls.sessions}/${id}`, 'PATCH', sessionData);
         });
     }
+    /**
+     * Delete a session (superuser scope).
+     *
+     * @param id - UUID of the session to delete.
+     * @returns The deleted session.
+     */
     superuserDeleteSession(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.sessions}/superuser/${id}`, 'DELETE');
+            return this.request(`${urls.sessions}/${id}`, 'DELETE');
         });
     }
+    /**
+     * Set the primary transcription summary for a session (superuser scope).
+     *
+     * @param sessionId - UUID of the session.
+     * @param summaryId - UUID of the transcription summary to mark as primary.
+     * @returns The updated session.
+     */
     superuserSetPrimaryTranscriptionSummary(sessionId, summaryId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(`${urls.sessions}/superuser/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
+            return this.request(`${urls.sessions}/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
         });
     }
     // ======================
     // ORG ADMIN METHODS
     // ======================
+    /**
+     * Retrieve all sessions belonging to a specific user (org admin scope).
+     *
+     * @param userId - UUID of the user whose sessions to fetch.
+     * @returns The user's sessions.
+     */
     orgAdminGetSessionsByUser(userId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(`${urls.sessions}/orgadmin/user/${userId}`, 'GET');
+            return this.request(`${urls.sessions}/user/${userId}`, 'GET');
         });
     }
+    /**
+     * Retrieve a paginated list of sessions for the organization (org admin scope).
+     *
+     * @param limit - Maximum number of sessions to return (default 100).
+     * @param offset - Number of sessions to skip for pagination (default 0).
+     * @returns A paginated sessions response.
+     */
     orgAdminGetSessionsByOrganization(limit = 100, offset = 0) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = new URLSearchParams();
             params.append('limit', limit.toString());
             params.append('offset', offset.toString());
-            return this.request(`${urls.sessions}/orgadmin/organization?${params.toString()}`, 'GET');
+            return this.request(`${urls.sessions}/organization?${params.toString()}`, 'GET');
         });
     }
+    /**
+     * Search sessions using the provided filters (org admin scope).
+     *
+     * @param filters - Optional search filters (date range, user, template, pagination, etc.).
+     * @returns A paginated search response of matching sessions.
+     */
     orgAdminSearchSessions(filters = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = this.buildSearchParams(filters);
             const queryString = params.toString();
-            const url = queryString ? `${urls.sessions}/orgadmin/search?${queryString}` : `${urls.sessions}/orgadmin/search`;
+            const url = queryString ? `${urls.sessions}/search?${queryString}` : `${urls.sessions}/search`;
             return this.request(url, 'GET');
         });
     }
+    /**
+     * Update a session (org admin scope).
+     *
+     * @param id - UUID of the session to update.
+     * @param sessionData - Fields to update on the session.
+     * @returns The updated session.
+     */
     orgAdminUpdateSession(id, sessionData) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(`${urls.sessions}/orgadmin/${id}`, 'PATCH', sessionData);
+            return this.request(`${urls.sessions}/${id}`, 'PATCH', sessionData);
         });
     }
+    /**
+     * Delete a session (org admin scope).
+     *
+     * @param id - UUID of the session to delete.
+     * @returns The deleted session.
+     */
     orgAdminDeleteSession(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.sessions}/orgadmin/${id}`, 'DELETE');
+            return this.request(`${urls.sessions}/${id}`, 'DELETE');
         });
     }
+    /**
+     * Set the primary transcription summary for a session (org admin scope).
+     *
+     * @param sessionId - UUID of the session.
+     * @param summaryId - UUID of the transcription summary to mark as primary.
+     * @returns The updated session.
+     */
     orgAdminSetPrimaryTranscriptionSummary(sessionId, summaryId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(`${urls.sessions}/orgadmin/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
+            return this.request(`${urls.sessions}/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
         });
     }
     // ======================
@@ -167,6 +306,8 @@ export class SessionModule extends BaseClient {
             params.append('hasSummary', filters.hasSummary.toString());
         if (filters.includeTranscriptions !== undefined)
             params.append('includeTranscriptions', filters.includeTranscriptions.toString());
+        if (filters.includeArchived !== undefined)
+            params.append('includeArchived', filters.includeArchived.toString());
         if (filters.limit !== undefined)
             params.append('limit', filters.limit.toString());
         if (filters.offset !== undefined)

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

@@ -1,13 +1,65 @@
 import { BaseClient } from './base-client';
-import { Team } from '../types';
+import { Team, TeamRole, TeamRoleName } from '../types';
 export declare class TeamModule extends BaseClient {
+    /**
+     * Create a team within the current user's organization.
+     *
+     * @param name - Display name of the team.
+     * @param description - Description of the team.
+     * @returns The newly created team.
+     */
     createTeam(name: string, description: string): Promise<Team>;
+    /**
+     * Update a team's name and description.
+     *
+     * @param id - UUID of the team to update.
+     * @param name - New display name for the team.
+     * @param description - New description for the team.
+     * @returns The updated team.
+     */
     updateTeam(id: string, name: string, description: string): Promise<Team>;
-    addUserToTeam(teamId: string, userId: string, roleName: string): Promise<any>;
-    removeUserFromTeam(teamId: string, userId: string): Promise<void>;
+    /**
+     * Add a user to a team with the given role.
+     *
+     * @param teamId - UUID of the team.
+     * @param userId - UUID of the user to add.
+     * @param roleName - Role to assign within the team.
+     * @returns The created team role.
+     */
+    addUserToTeam(teamId: string, userId: string, roleName: TeamRoleName): Promise<TeamRole>;
+    /**
+     * Remove a user from a team.
+     *
+     * @param teamId - UUID of the team.
+     * @param userId - UUID of the user to remove.
+     * @returns The removed team role.
+     */
+    removeUserFromTeam(teamId: string, userId: string): Promise<TeamRole>;
+    /**
+     * List all teams the current user can access.
+     *
+     * @returns An array of teams.
+     */
     getTeams(): Promise<Team[]>;
+    /**
+     * Get a single team by ID.
+     *
+     * @param id - UUID of the team.
+     * @returns The requested team.
+     */
     getTeam(id: string): Promise<Team>;
+    /**
+     * List all teams belonging to an organization.
+     *
+     * @param organizationId - UUID of the organization.
+     * @returns An array of teams in the organization.
+     */
     getTeamsByOrganization(organizationId: string): Promise<Team[]>;
+    /**
+     * Delete a team by ID.
+     *
+     * @param id - UUID of the team to delete.
+     * @returns A promise that resolves when the team is deleted.
+     */
     deleteTeam(id: string): Promise<void>;
-    removeUserFromTeamFixed(teamId: string, userId: string): Promise<void>;
 }

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

@@ -10,6 +10,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { BaseClient } from './base-client';
 import urls from '../urls';
 export class TeamModule extends BaseClient {
+    /**
+     * Create a team within the current user's organization.
+     *
+     * @param name - Display name of the team.
+     * @param description - Description of the team.
+     * @returns The newly created team.
+     */
     createTeam(name, description) {
         return __awaiter(this, void 0, void 0, function* () {
             const teamDto = {
@@ -20,6 +27,14 @@ export class TeamModule extends BaseClient {
             return this.request(urls.teams, 'POST', teamDto);
         });
     }
+    /**
+     * Update a team's name and description.
+     *
+     * @param id - UUID of the team to update.
+     * @param name - New display name for the team.
+     * @param description - New description for the team.
+     * @returns The updated team.
+     */
     updateTeam(id, name, description) {
         return __awaiter(this, void 0, void 0, function* () {
             const teamDto = {
@@ -29,6 +44,14 @@ export class TeamModule extends BaseClient {
             return this.request(`${urls.teams}/${id}`, 'PATCH', teamDto);
         });
     }
+    /**
+     * Add a user to a team with the given role.
+     *
+     * @param teamId - UUID of the team.
+     * @param userId - UUID of the user to add.
+     * @param roleName - Role to assign within the team.
+     * @returns The created team role.
+     */
     addUserToTeam(teamId, userId, roleName) {
         return __awaiter(this, void 0, void 0, function* () {
             const assignRoleDto = {
@@ -39,34 +62,59 @@ export class TeamModule extends BaseClient {
             return this.request(urls.teamRoles, 'POST', assignRoleDto);
         });
     }
+    /**
+     * Remove a user from a team.
+     *
+     * @param teamId - UUID of the team.
+     * @param userId - UUID of the user to remove.
+     * @returns The removed team role.
+     */
     removeUserFromTeam(teamId, userId) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.teamRoles}/user/${userId}/team/${teamId}`, 'DELETE');
+            return this.request(`${urls.teamRoles}/user/${userId}/team/${teamId}`, 'DELETE');
         });
     }
+    /**
+     * List all teams the current user can access.
+     *
+     * @returns An array of teams.
+     */
     getTeams() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.teams, 'GET');
         });
     }
+    /**
+     * Get a single team by ID.
+     *
+     * @param id - UUID of the team.
+     * @returns The requested team.
+     */
     getTeam(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.teams}/${id}`, 'GET');
         });
     }
+    /**
+     * List all teams belonging to an organization.
+     *
+     * @param organizationId - UUID of the organization.
+     * @returns An array of teams in the organization.
+     */
     getTeamsByOrganization(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.teams}/organization/${organizationId}`, 'GET');
         });
     }
+    /**
+     * Delete a team by ID.
+     *
+     * @param id - UUID of the team to delete.
+     * @returns A promise that resolves when the team is deleted.
+     */
     deleteTeam(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.teams}/${id}`, 'DELETE');
         });
     }
-    removeUserFromTeamFixed(teamId, userId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.teamRoles}/user/${userId}/team/${teamId}`, 'DELETE');
-        });
-    }
 }

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

@@ -1,21 +1,113 @@
 import { BaseClient } from './base-client';
-import { Template, TemplateCategory, TranscriptionAudioUploadResponse, SummaryQueueType } from '../types';
+import { Template, TemplateCategory, SummaryQueueType } from '../types';
 export declare class TemplateModule extends BaseClient {
+    /**
+     * 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: string, content: string, categoryId?: string, workflowId?: string, agentId?: string, summaryQueueType?: SummaryQueueType): Promise<Template>;
+    /**
+     * 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: string, content: string, id: string, workflowId?: string, agentId?: string, summaryQueueType?: SummaryQueueType | null): Promise<Template>;
+    /**
+     * Retrieve all templates accessible to the current user.
+     *
+     * @returns An array of templates.
+     */
     getTemplates(): Promise<Template[]>;
+    /**
+     * Retrieve all templates belonging to the current user's organization.
+     *
+     * @returns An array of templates.
+     */
     getTemplatesByOrganization(): Promise<Template[]>;
+    /**
+     * Retrieve a single template by id.
+     *
+     * @param id - UUID of the template.
+     * @returns The requested template.
+     */
     getTemplate(id: string): Promise<Template>;
+    /**
+     * 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: string): Promise<void>;
+    /**
+     * 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: string, integrationActionIds: string[]): Promise<Template>;
+    /**
+     * 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: string, integrationActionIds: string[]): Promise<Template>;
+    /**
+     * 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: string, integrationActionIds: string[]): Promise<Template>;
+    /**
+     * Retrieve all template categories.
+     *
+     * @returns An array of template categories.
+     */
     getTemplateCategories(): Promise<TemplateCategory[]>;
+    /**
+     * Retrieve a single template category by id.
+     *
+     * @param id - UUID of the template category.
+     * @returns The requested template category.
+     */
     getTemplateCategory(id: string): Promise<TemplateCategory>;
+    /**
+     * Create a template category.
+     *
+     * @param name - Name of the new category.
+     * @returns The created template category.
+     */
     createTemplateCategory(name: string): Promise<TemplateCategory>;
+    /**
+     * 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: string, name: string): Promise<TemplateCategory>;
+    /**
+     * 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: string): Promise<void>;
-    uploadLargeAudioFile(formData: FormData, onProgress?: (percentage: number) => void): Promise<string>;
-    uploadAudioFile(formData: FormData, onProgress?: (percentage: number) => void): Promise<TranscriptionAudioUploadResponse | null>;
-    transcribeBase64Audio(base64String: string): Promise<string>;
 }