whio-api-sdk 1.1.28 → 1.1.33

package/src/sdk/modules/session.module.ts

@@ -7,42 +7,103 @@ 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.
+   */
   public async createSession(sessionData: CreateSessionDto): Promise<Session> {
     return this.request<Session>(urls.sessions, 'POST', sessionData);
   }
 
+  /**
+   * Retrieve the authenticated user's own sessions.
+   *
+   * @returns The current user's sessions.
+   */
   public async getSessions(): Promise<Session[]> {
     return this.request<Session[]>(`${urls.sessions}/my-sessions`, 'GET');
   }
 
+  /**
+   * Retrieve a single session by its id.
+   *
+   * @param id - UUID of the session to fetch.
+   * @returns The requested session.
+   */
   public async getSession(id: string): Promise<Session> {
     return this.request<Session>(`${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.
+   */
   public async updateSession(id: string, sessionData: UpdateSessionDto): Promise<Session> {
     return this.request<Session>(`${urls.sessions}/${id}`, 'PATCH', sessionData);
   }
 
-  public async deleteSession(id: string): Promise<void> {
-    await this.request(`${urls.sessions}/${id}`, 'DELETE');
+  /**
+   * Delete a session.
+   *
+   * @param id - UUID of the session to delete.
+   * @returns The deleted session.
+   */
+  public async deleteSession(id: string): Promise<Session> {
+    return this.request<Session>(`${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.
+   */
   public async setPrimaryTranscriptionSummary(sessionId: string, summaryId: string): Promise<Session> {
     return this.request<Session>(`${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.
+   */
   public async rerunTranscription(sessionId: string): Promise<{ message: string; sessionId: string }> {
     return this.request<{ message: string; sessionId: string }>(`${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.
+   */
   public async setAudioStreamStatus(data: SetAudioStreamStatusDto): Promise<Session> {
     return this.request<Session>(`${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.
+   */
   public async forwardToTiaki(sessionId: string): Promise<ForwardToTiakiResponse> {
     return this.request<ForwardToTiakiResponse>(`${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.
+   */
   public async searchSessions(filters: SearchSessionsDto = {}): Promise<SearchSessionsResponse> {
     const params = this.buildSearchParams(filters);
     const queryString = params.toString();
@@ -54,10 +115,23 @@ 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.
+   */
   public async superuserGetSessionsByUser(userId: string): Promise<Session[]> {
-    return this.request<Session[]>(`${urls.sessions}/superuser/user/${userId}`, 'GET');
+    return this.request<Session[]>(`${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.
+   */
   public async superuserGetSessionsByOrganization(limit = 100, offset = 0): Promise<SessionsResponse> {
     const params = new URLSearchParams();
     params.append('limit', limit.toString());
@@ -65,57 +139,122 @@ export class SessionModule extends BaseClient {
     return this.request<SessionsResponse>(`${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.
+   */
   public async superuserSearchSessions(filters: SearchSessionsDto = {}): Promise<SearchSessionsResponse> {
     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<SearchSessionsResponse>(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.
+   */
   public async superuserUpdateSession(id: string, sessionData: UpdateSessionDto): Promise<Session> {
-    return this.request<Session>(`${urls.sessions}/superuser/${id}`, 'PATCH', sessionData);
+    return this.request<Session>(`${urls.sessions}/${id}`, 'PATCH', sessionData);
   }
 
-  public async superuserDeleteSession(id: string): Promise<void> {
-    await this.request(`${urls.sessions}/superuser/${id}`, 'DELETE');
+  /**
+   * Delete a session (superuser scope).
+   *
+   * @param id - UUID of the session to delete.
+   * @returns The deleted session.
+   */
+  public async superuserDeleteSession(id: string): Promise<Session> {
+    return this.request<Session>(`${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.
+   */
   public async superuserSetPrimaryTranscriptionSummary(sessionId: string, summaryId: string): Promise<Session> {
-    return this.request<Session>(`${urls.sessions}/superuser/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
+    return this.request<Session>(`${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.
+   */
   public async orgAdminGetSessionsByUser(userId: string): Promise<Session[]> {
-    return this.request<Session[]>(`${urls.sessions}/orgadmin/user/${userId}`, 'GET');
+    return this.request<Session[]>(`${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.
+   */
   public async orgAdminGetSessionsByOrganization(limit = 100, offset = 0): Promise<SessionsResponse> {
     const params = new URLSearchParams();
     params.append('limit', limit.toString());
     params.append('offset', offset.toString());
-    return this.request<SessionsResponse>(`${urls.sessions}/orgadmin/organization?${params.toString()}`, 'GET');
+    return this.request<SessionsResponse>(`${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.
+   */
   public async orgAdminSearchSessions(filters: SearchSessionsDto = {}): Promise<SearchSessionsResponse> {
     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<SearchSessionsResponse>(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.
+   */
   public async orgAdminUpdateSession(id: string, sessionData: UpdateSessionDto): Promise<Session> {
-    return this.request<Session>(`${urls.sessions}/orgadmin/${id}`, 'PATCH', sessionData);
+    return this.request<Session>(`${urls.sessions}/${id}`, 'PATCH', sessionData);
   }
 
-  public async orgAdminDeleteSession(id: string): Promise<void> {
-    await this.request(`${urls.sessions}/orgadmin/${id}`, 'DELETE');
+  /**
+   * Delete a session (org admin scope).
+   *
+   * @param id - UUID of the session to delete.
+   * @returns The deleted session.
+   */
+  public async orgAdminDeleteSession(id: string): Promise<Session> {
+    return this.request<Session>(`${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.
+   */
   public async orgAdminSetPrimaryTranscriptionSummary(sessionId: string, summaryId: string): Promise<Session> {
-    return this.request<Session>(`${urls.sessions}/orgadmin/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
+    return this.request<Session>(`${urls.sessions}/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
   }
 
   // ======================
@@ -133,6 +272,7 @@ export class SessionModule extends BaseClient {
     if (filters.templateId) params.append('templateId', filters.templateId);
     if (filters.hasSummary !== undefined) 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) params.append('offset', filters.offset.toString());
     return params;

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

@@ -1,8 +1,15 @@
 import { BaseClient } from './base-client';
-import { Team, CreateTeamDto, UpdateTeamDto, AssignTeamRoleDto } from '../types';
+import { Team, CreateTeamDto, UpdateTeamDto, AssignTeamRoleDto, TeamRole, TeamRoleName } from '../types';
 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.
+   */
   public async createTeam(name: string, description: string): Promise<Team> {
     const teamDto: CreateTeamDto = {
       name,
@@ -12,6 +19,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.
+   */
   public async updateTeam(id: string, name: string, description: string): Promise<Team> {
     const teamDto: UpdateTeamDto = {
       name,
@@ -20,36 +35,70 @@ export class TeamModule extends BaseClient {
     return this.request<Team>(`${urls.teams}/${id}`, 'PATCH', teamDto);
   }
 
-  public async addUserToTeam(teamId: string, userId: string, roleName: string): Promise<any> {
+  /**
+   * 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.
+   */
+  public async addUserToTeam(teamId: string, userId: string, roleName: TeamRoleName): Promise<TeamRole> {
     const assignRoleDto: AssignTeamRoleDto = {
       teamId,
       userId,
       name: roleName,
     };
-    return this.request(urls.teamRoles, 'POST', assignRoleDto);
+    return this.request<TeamRole>(urls.teamRoles, 'POST', assignRoleDto);
   }
 
-  public async removeUserFromTeam(teamId: string, userId: string): Promise<void> {
-    await this.request(`${urls.teamRoles}/user/${userId}/team/${teamId}`, 'DELETE');
+  /**
+   * 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.
+   */
+  public async removeUserFromTeam(teamId: string, userId: string): Promise<TeamRole> {
+    return this.request<TeamRole>(`${urls.teamRoles}/user/${userId}/team/${teamId}`, 'DELETE');
   }
 
+  /**
+   * List all teams the current user can access.
+   *
+   * @returns An array of teams.
+   */
   public async getTeams(): Promise<Team[]> {
     return this.request<Team[]>(urls.teams, 'GET');
   }
 
+  /**
+   * Get a single team by ID.
+   *
+   * @param id - UUID of the team.
+   * @returns The requested team.
+   */
   public async getTeam(id: string): Promise<Team> {
     return this.request<Team>(`${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.
+   */
   public async getTeamsByOrganization(organizationId: string): Promise<Team[]> {
     return this.request<Team[]>(`${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.
+   */
   public async deleteTeam(id: string): Promise<void> {
     await this.request(`${urls.teams}/${id}`, 'DELETE');
   }
-
-  public async removeUserFromTeamFixed(teamId: string, userId: string): Promise<void> {
-    await this.request(`${urls.teamRoles}/user/${userId}/team/${teamId}`, 'DELETE');
-  }
 }

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

@@ -6,7 +6,6 @@ import {
   UpdateTemplateDto,
   CreateTemplateCategoryDto,
   UpdateTemplateCategoryDto,
-  TranscriptionAudioUploadResponse,
   SummaryQueueType,
 } from '../types';
 import urls from '../urls';
@@ -16,6 +15,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.
+   */
   public async createTemplate(title: string, content: string, categoryId?: string, workflowId?: string, agentId?: string, summaryQueueType?: SummaryQueueType): Promise<Template> {
     let finalCategoryId = categoryId;
     if (!finalCategoryId) {
@@ -43,6 +53,17 @@ export class TemplateModule extends BaseClient {
     return this.request<Template>(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.
+   */
   public async updateTemplate(title: string, content: string, id: string, workflowId?: string, agentId?: string, summaryQueueType?: SummaryQueueType | null): Promise<Template> {
     const templateDto: UpdateTemplateDto = {
       title,
@@ -56,18 +77,40 @@ export class TemplateModule extends BaseClient {
     return this.request<Template>(`${urls.templates}/${id}`, 'PATCH', templateDto);
   }
 
+  /**
+   * Retrieve all templates accessible to the current user.
+   *
+   * @returns An array of templates.
+   */
   public async getTemplates(): Promise<Template[]> {
     return this.request<Template[]>(urls.templates, 'GET');
   }
 
+  /**
+   * Retrieve all templates belonging to the current user's organization.
+   *
+   * @returns An array of templates.
+   */
   public async getTemplatesByOrganization(): Promise<Template[]> {
     return this.request<Template[]>(`${urls.templates}/organization`, 'GET');
   }
 
+  /**
+   * Retrieve a single template by id.
+   *
+   * @param id - UUID of the template.
+   * @returns The requested template.
+   */
   public async getTemplate(id: string): Promise<Template> {
     return this.request<Template>(`${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.
+   */
   public async deleteTemplate(id: string): Promise<void> {
     await this.request(`${urls.templates}/${id}`, 'DELETE');
   }
@@ -76,6 +119,13 @@ 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.
+   */
   public async setTemplateIntegrationActions(templateId: string, integrationActionIds: string[]): Promise<Template> {
     return this.request<Template>(
       `${urls.templates}/${templateId}/integration-actions`,
@@ -84,6 +134,13 @@ export class TemplateModule extends BaseClient {
     );
   }
 
+  /**
+   * 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.
+   */
   public async addTemplateIntegrationActions(templateId: string, integrationActionIds: string[]): Promise<Template> {
     return this.request<Template>(
       `${urls.templates}/${templateId}/integration-actions`,
@@ -92,6 +149,13 @@ export class TemplateModule extends BaseClient {
     );
   }
 
+  /**
+   * Remove integration actions from a template.
+   *
+   * @param templateId - UUID of the template.
+   * @param integrationActionIds - The integration action UUIDs to remove.
+   * @returns The updated template.
+   */
   public async removeTemplateIntegrationActions(templateId: string, integrationActionIds: string[]): Promise<Template> {
     return this.request<Template>(
       `${urls.templates}/${templateId}/integration-actions`,
@@ -104,56 +168,55 @@ export class TemplateModule extends BaseClient {
   // TEMPLATE CATEGORY METHODS
   // ======================
 
+  /**
+   * Retrieve all template categories.
+   *
+   * @returns An array of template categories.
+   */
   public async getTemplateCategories(): Promise<TemplateCategory[]> {
     return this.request<TemplateCategory[]>(urls.templateCategories, 'GET');
   }
 
+  /**
+   * Retrieve a single template category by id.
+   *
+   * @param id - UUID of the template category.
+   * @returns The requested template category.
+   */
   public async getTemplateCategory(id: string): Promise<TemplateCategory> {
     return this.request<TemplateCategory>(`${urls.templateCategories}/${id}`, 'GET');
   }
 
+  /**
+   * Create a template category.
+   *
+   * @param name - Name of the new category.
+   * @returns The created template category.
+   */
   public async createTemplateCategory(name: string): Promise<TemplateCategory> {
     const dto: CreateTemplateCategoryDto = { name };
     return this.request<TemplateCategory>(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.
+   */
   public async updateTemplateCategory(id: string, name: string): Promise<TemplateCategory> {
     const dto: UpdateTemplateCategoryDto = { name };
     return this.request<TemplateCategory>(`${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.
+   */
   public async deleteTemplateCategory(id: string): Promise<void> {
     await this.request(`${urls.templateCategories}/${id}`, 'DELETE');
   }
-
-  // ======================
-  // AUDIO UPLOAD METHODS (for transcription)
-  // ======================
-
-  public async uploadLargeAudioFile(formData: FormData, onProgress?: (percentage: number) => void): Promise<string> {
-    const uploadId: string = await this.fileUploadRequest(urls.uploadAudioLarge, formData, {}, onProgress);
-    const uploadIds: string = await this.storage!.getItem('uploadIds') || '[]';
-    const uploadIdsArray = JSON.parse(uploadIds);
-    await this.storage!.setItem('uploadIds', JSON.stringify([...uploadIdsArray, uploadId]));
-    return uploadId;
-  }
-
-  public async uploadAudioFile(formData: FormData, onProgress?: (percentage: number) => void): Promise<TranscriptionAudioUploadResponse | null> {
-    const data: TranscriptionAudioUploadResponse = await this.fileUploadRequest(
-      urls.uploadAudio,
-      formData,
-      {},
-      onProgress
-    );
-    return data;
-  }
-
-  public async transcribeBase64Audio(base64String: string): Promise<string> {
-    const transcript = await this.request<any>(
-      urls.transcribeBase64Audio,
-      'POST',
-      { base64Audio: base64String }
-    );
-    return transcript.transcript;
-  }
 }