whio-api-sdk 1.1.28 → 1.1.33

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

@@ -1,42 +1,101 @@
 import { BaseClient } from './base-client';
-import { Organization, CreateOrganizationDto, UpdateOrganizationDto } from '../types';
+import { Organization, CreateOrganizationDto, UpdateOrganizationDto, User } from '../types';
 import urls from '../urls';
 
 export class OrganizationModule extends BaseClient {
+  /**
+   * Create a new organization.
+   *
+   * @param name - Display name of the organization.
+   * @param description - Optional description of the organization.
+   * @returns The newly created organization.
+   */
   public async createOrganization(name: string, description?: string): Promise<Organization> {
     const dto: CreateOrganizationDto = { name, description };
     return this.request<Organization>(urls.organizations, 'POST', dto);
   }
 
+  /**
+   * List all organizations the current user can access.
+   *
+   * @returns An array of organizations.
+   */
   public async getOrganizations(): Promise<Organization[]> {
     return this.request<Organization[]>(urls.organizations, 'GET');
   }
 
+  /**
+   * Get a single organization by ID.
+   *
+   * @param id - UUID of the organization.
+   * @returns The requested organization.
+   */
   public async getOrganization(id: string): Promise<Organization> {
     return this.request<Organization>(`${urls.organizations}/${id}`, 'GET');
   }
 
+  /**
+   * Update an organization's name and/or description.
+   *
+   * @param id - UUID of the organization to update.
+   * @param name - New display name for the organization.
+   * @param description - New description for the organization.
+   * @returns The updated organization.
+   */
   public async updateOrganization(id: string, name?: string, description?: string): Promise<Organization> {
     const dto: UpdateOrganizationDto = { name, description };
     return this.request<Organization>(`${urls.organizations}/${id}`, 'PATCH', dto);
   }
 
+  /**
+   * Delete an organization by ID.
+   *
+   * @param id - UUID of the organization to delete.
+   * @returns A promise that resolves when the organization is deleted.
+   */
   public async deleteOrganization(id: string): Promise<void> {
     await this.request(`${urls.organizations}/${id}`, 'DELETE');
   }
 
-  public async addUserToOrganization(organizationId: string, userId: string): Promise<void> {
-    await this.request(`${urls.organizations}/${organizationId}/users/${userId}`, 'POST');
+  /**
+   * Add a user to an organization.
+   *
+   * @param organizationId - UUID of the organization.
+   * @param userId - UUID of the user to add.
+   * @returns The user as a member of the organization.
+   */
+  public async addUserToOrganization(organizationId: string, userId: string): Promise<User> {
+    return this.request<User>(`${urls.organizations}/${organizationId}/users/${userId}`, 'POST');
   }
 
-  public async removeUserFromOrganization(organizationId: string, userId: string): Promise<void> {
-    await this.request(`${urls.organizations}/${organizationId}/users/${userId}`, 'DELETE');
+  /**
+   * Remove a user from an organization.
+   *
+   * @param organizationId - UUID of the organization.
+   * @param userId - UUID of the user to remove.
+   * @returns The removed organization member.
+   */
+  public async removeUserFromOrganization(organizationId: string, userId: string): Promise<User> {
+    return this.request<User>(`${urls.organizations}/${organizationId}/users/${userId}`, 'DELETE');
   }
 
+  /**
+   * Link an external integration to an organization.
+   *
+   * @param organizationId - UUID of the organization.
+   * @param integrationId - UUID of the external integration to link.
+   * @returns The updated organization.
+   */
   public async linkExternalIntegration(organizationId: string, integrationId: string): Promise<Organization> {
     return this.request<Organization>(`${urls.organizations}/${organizationId}/external-integration/${integrationId}`, 'POST');
   }
 
+  /**
+   * Unlink the external integration from an organization.
+   *
+   * @param organizationId - UUID of the organization.
+   * @returns The updated organization.
+   */
   public async unlinkExternalIntegration(organizationId: string): Promise<Organization> {
     return this.request<Organization>(`${urls.organizations}/${organizationId}/external-integration`, 'DELETE');
   }

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

@@ -8,8 +8,11 @@ import urls from '../urls';
 export class PatientModule extends BaseClient {
   
   /**
-   * Get patients from external integration (Tiaki)
-   * Returns an empty array if no integration is configured
+   * Get patients from the external integration (Tiaki).
+   *
+   * The API strips sensitive fields (e.g. national id), so only safe fields are returned.
+   *
+   * @returns An array of safe patient records, or an empty array if no integration is configured.
    */
   async getPatientsFromIntegration(): Promise<PatientsFromIntegrationResponse> {
     return this.request<PatientsFromIntegrationResponse>(`${urls.patients}/from-integration`, 'GET');

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

@@ -4,19 +4,19 @@ import urls from '../urls';
 export class ReportsModule extends BaseClient {
   /**
    * Get company daily report as CSV
-   * @param companyId - The organization/company ID to generate the report for
+   * @param organizationId - The organization/company ID to generate the report for
    * @returns Promise<string> - CSV content with daily user counts and session counts
    */
-  public async getCompanyDailyReportCsv(companyId: string): Promise<string> {
-    return this.textRequest(`${urls.reports}/company-daily?companyId=${companyId}`);
+  public async getCompanyDailyReportCsv(organizationId: string): Promise<string> {
+    return this.textRequest(`${urls.reports}/company-daily?organizationId=${organizationId}`);
   }
 
   /**
    * Download company daily report as CSV file
-   * @param companyId - The organization/company ID to generate the report for
+   * @param organizationId - The organization/company ID to generate the report for
    * @returns Promise<Blob> - CSV file as blob for download
    */
-  public async downloadCompanyDailyReport(companyId: string): Promise<Blob> {
-    return this.downloadRequest(`${urls.reports}/company-daily?companyId=${companyId}`);
+  public async downloadCompanyDailyReport(organizationId: string): Promise<Blob> {
+    return this.downloadRequest(`${urls.reports}/company-daily?organizationId=${organizationId}`);
   }
 }

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

@@ -12,36 +12,81 @@ import urls from '../../urls';
  * Session module for organization admins - provides access to sessions within their organization
  */
 export class OrgAdminSessionModule extends BaseClient {
+  /**
+   * Retrieve all sessions belonging to a specific user.
+   *
+   * @param userId - UUID of the user whose sessions to fetch.
+   * @returns The user's sessions.
+   */
   public async getSessionsByUser(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.
+   *
+   * @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 getSessionsByOrganization(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.
+   *
+   * @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();
-    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.
+   *
+   * @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}/orgadmin/${id}`, 'PATCH', sessionData);
+    return this.request<Session>(`${urls.sessions}/${id}`, 'PATCH', sessionData);
   }
 
-  public async deleteSession(id: string): Promise<void> {
-    await this.request(`${urls.sessions}/orgadmin/${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}/orgadmin/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
+    return this.request<Session>(`${urls.sessions}/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
   }
 
+  /**
+   * 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');
   }
@@ -57,6 +102,7 @@ export class OrgAdminSessionModule 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/session/session.module.ts

@@ -14,42 +14,103 @@ import urls from '../../urls';
  * Session module for regular users - provides access to own sessions only
  */
 export class SessionModule extends BaseClient {
+  /**
+   * 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();
@@ -68,6 +129,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/session/superuser-session.module.ts

@@ -12,10 +12,23 @@ import urls from '../../urls';
  * Session module for superusers - provides access to all sessions across the system
  */
 export class SuperuserSessionModule extends BaseClient {
+  /**
+   * Retrieve all sessions belonging to a specific user.
+   *
+   * @param userId - UUID of the user whose sessions to fetch.
+   * @returns The user's sessions.
+   */
   public async getSessionsByUser(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.
+   *
+   * @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 getSessionsByOrganization(limit = 100, offset = 0): Promise<SessionsResponse> {
     const params = new URLSearchParams();
     params.append('limit', limit.toString());
@@ -23,25 +36,57 @@ export class SuperuserSessionModule extends BaseClient {
     return this.request<SessionsResponse>(`${urls.sessions}/organization?${params.toString()}`, 'GET');
   }
 
+  /**
+   * Search 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();
-    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.
+   *
+   * @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}/superuser/${id}`, 'PATCH', sessionData);
+    return this.request<Session>(`${urls.sessions}/${id}`, 'PATCH', sessionData);
   }
 
-  public async deleteSession(id: string): Promise<void> {
-    await this.request(`${urls.sessions}/superuser/${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}/superuser/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
+    return this.request<Session>(`${urls.sessions}/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
   }
 
+  /**
+   * 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');
   }
@@ -57,6 +102,7 @@ export class SuperuserSessionModule 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;