whio-api-sdk 1.1.28 → 1.1.29

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

@@ -3,6 +3,12 @@ import { LoginCredentials, LoginResponse, PasswordChangeResponse, ChangePassword
 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.
+   */
   public async login(credentials: LoginCredentials): Promise<LoginResponse> {
     try {
       const response = await this.request<LoginResponse>(
@@ -20,6 +26,12 @@ 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.
+   */
   public async requestLoginCode(email: string): Promise<{ message: string }> {
     return this.request<{ message: string }>(
       '/auth/request-login-code',
@@ -30,6 +42,13 @@ export class AuthModule extends BaseClient {
     );
   }
 
+  /**
+   * 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.
+   */
   public async loginWithCode(email: string, code: string): Promise<LoginResponse> {
     try {
       const response = await this.request<LoginResponse>(
@@ -47,14 +66,31 @@ export class AuthModule extends BaseClient {
     }
   }
 
+  /**
+   * Clear the current session and any persisted authentication state.
+   *
+   * @returns A promise that resolves when the session is cleared.
+   */
   public async logout(): Promise<void> {
     await this.clearAuth();
   }
 
+  /**
+   * Fetch the authenticated user's profile.
+   *
+   * @returns The current user.
+   */
   public async getProfile(): Promise<User> {
     return this.request<User>(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.
+   */
   public async changePassword(currentPassword: string, newPassword: string): Promise<PasswordChangeResponse> {
     const dto: ChangePasswordDto = {
       currentPassword,
@@ -63,6 +99,13 @@ export class AuthModule extends BaseClient {
     return this.request<PasswordChangeResponse>(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.
+   */
   public async adminChangePassword(userId: string, newPassword: string): Promise<PasswordChangeResponse> {
     const dto: AdminChangePasswordDto = {
       userId,

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

@@ -1,38 +1,76 @@
 import { BaseClient } from './base-client';
-import { DataStrategy, CreateDataStrategyDto, UpdateDataStrategyDto } from '../types';
+import { DataStrategy, DataStrategyWithOrganization, CreateDataStrategyDto, UpdateDataStrategyDto } from '../types';
 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.
+   */
   public async createDataStrategy(
     organizationId?: string,
     options?: Omit<CreateDataStrategyDto, 'organizationId'>,
-  ): Promise<DataStrategy> {
+  ): Promise<DataStrategyWithOrganization> {
     const dto: CreateDataStrategyDto = {
       organizationId: organizationId || this.user!.organizationId,
       ...options,
     };
-    return this.request<DataStrategy>(urls.dataStrategies, 'POST', dto);
+    return this.request<DataStrategyWithOrganization>(urls.dataStrategies, 'POST', dto);
   }
 
-  public async getDataStrategies(organizationId?: string): Promise<DataStrategy[]> {
+  /**
+   * 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.
+   */
+  public async getDataStrategies(organizationId?: string): Promise<DataStrategyWithOrganization[]> {
     const params = organizationId ? `?organizationId=${organizationId}` : '';
-    return this.request<DataStrategy[]>(`${urls.dataStrategies}${params}`, 'GET');
+    return this.request<DataStrategyWithOrganization[]>(`${urls.dataStrategies}${params}`, 'GET');
   }
 
-  public async getDataStrategy(id: string): Promise<DataStrategy> {
-    return this.request<DataStrategy>(`${urls.dataStrategies}/${id}`, 'GET');
+  /**
+   * Get a single data strategy by id.
+   *
+   * @param id - UUID of the data strategy.
+   * @returns The data strategy with its organization populated.
+   */
+  public async getDataStrategy(id: string): Promise<DataStrategyWithOrganization> {
+    return this.request<DataStrategyWithOrganization>(`${urls.dataStrategies}/${id}`, 'GET');
   }
 
-  public async getDataStrategyByOrganization(organizationId?: string): Promise<DataStrategy> {
+  /**
+   * 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.
+   */
+  public async getDataStrategyByOrganization(organizationId?: string): Promise<DataStrategyWithOrganization> {
     const orgId = organizationId || this.user!.organizationId;
-    return this.request<DataStrategy>(`${urls.dataStrategies}?organizationId=${orgId}`, 'GET');
+    return this.request<DataStrategyWithOrganization>(`${urls.dataStrategies}?organizationId=${orgId}`, 'GET');
   }
 
-  public async updateDataStrategy(id: string, data: UpdateDataStrategyDto): Promise<DataStrategy> {
-    return this.request<DataStrategy>(`${urls.dataStrategies}/${id}`, 'PATCH', data);
+  /**
+   * 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.
+   */
+  public async updateDataStrategy(id: string, data: UpdateDataStrategyDto): Promise<DataStrategyWithOrganization> {
+    return this.request<DataStrategyWithOrganization>(`${urls.dataStrategies}/${id}`, 'PATCH', data);
   }
 
-  public async deleteDataStrategy(id: string): Promise<void> {
-    await this.request(`${urls.dataStrategies}/${id}`, 'DELETE');
+  /**
+   * Delete a data strategy.
+   *
+   * @param id - UUID of the data strategy to delete.
+   * @returns The deleted data strategy entity.
+   */
+  public async deleteDataStrategy(id: string): Promise<DataStrategy> {
+    return this.request<DataStrategy>(`${urls.dataStrategies}/${id}`, 'DELETE');
   }
 }

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

@@ -7,6 +7,12 @@ import {
 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).
+   */
   public async createExternalIntegration(
     data: CreateExternalIntegrationDto,
   ): Promise<ExternalIntegration> {
@@ -17,6 +23,11 @@ export class ExternalIntegrationModule extends BaseClient {
     );
   }
 
+  /**
+   * List all external integrations.
+   *
+   * @returns An array of external integrations (each `apiKey` is returned masked).
+   */
   public async getExternalIntegrations(): Promise<ExternalIntegration[]> {
     return this.request<ExternalIntegration[]>(
       urls.externalIntegrations,
@@ -24,6 +35,12 @@ export class ExternalIntegrationModule extends BaseClient {
     );
   }
 
+  /**
+   * Get a single external integration by id.
+   *
+   * @param id - UUID of the external integration.
+   * @returns The external integration (its `apiKey` is returned masked).
+   */
   public async getExternalIntegration(
     id: string,
   ): Promise<ExternalIntegration> {
@@ -33,6 +50,13 @@ export class ExternalIntegrationModule extends BaseClient {
     );
   }
 
+  /**
+   * 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).
+   */
   public async updateExternalIntegration(
     id: string,
     data: UpdateExternalIntegrationDto,
@@ -44,6 +68,12 @@ export class ExternalIntegrationModule extends BaseClient {
     );
   }
 
+  /**
+   * Delete an external integration.
+   *
+   * @param id - UUID of the external integration to delete.
+   * @returns A promise that resolves when the integration has been deleted.
+   */
   public async deleteExternalIntegration(id: string): Promise<void> {
     await this.request(`${urls.externalIntegrations}/${id}`, 'DELETE');
   }

package/src/sdk/modules/integration-action.module.ts

@@ -3,6 +3,13 @@ import { IntegrationAction, CreateIntegrationActionDto, UpdateIntegrationActionD
 import urls from '../urls';
 
 export class IntegrationActionModule extends BaseClient {
+  /**
+   * Create an integration action for an organization.
+   *
+   * @param name - Display name of the integration action.
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns The created integration action.
+   */
   public async createIntegrationAction(name: string, organizationId?: string): Promise<IntegrationAction> {
     const dto: CreateIntegrationActionDto = {
       name,
@@ -11,20 +18,46 @@ export class IntegrationActionModule extends BaseClient {
     return this.request<IntegrationAction>(urls.integrationActions, 'POST', dto);
   }
 
+  /**
+   * List integration actions, optionally filtered by organization.
+   *
+   * @param organizationId - Optional organization UUID to filter by.
+   * @returns An array of integration actions.
+   */
   public async getIntegrationActions(organizationId?: string): Promise<IntegrationAction[]> {
     const params = organizationId ? `?organizationId=${organizationId}` : '';
     return this.request<IntegrationAction[]>(`${urls.integrationActions}${params}`, 'GET');
   }
 
+  /**
+   * Get a single integration action by id.
+   *
+   * @param id - UUID of the integration action.
+   * @returns The integration action.
+   */
   public async getIntegrationAction(id: string): Promise<IntegrationAction> {
     return this.request<IntegrationAction>(`${urls.integrationActions}/${id}`, 'GET');
   }
 
+  /**
+   * Get the integration actions for a specific organization.
+   *
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns An array of integration actions for the organization.
+   */
   public async getIntegrationActionsByOrganization(organizationId?: string): Promise<IntegrationAction[]> {
     const orgId = organizationId || this.user!.organizationId;
     return this.request<IntegrationAction[]>(`${urls.integrationActions}?organizationId=${orgId}`, 'GET');
   }
 
+  /**
+   * Update an integration action.
+   *
+   * @param id - UUID of the integration action to update.
+   * @param name - New display name of the integration action.
+   * @param organizationId - Optional organization UUID; defaults to the current user's organization.
+   * @returns The updated integration action.
+   */
   public async updateIntegrationAction(id: string, name: string, organizationId?: string): Promise<IntegrationAction> {
     const dto: UpdateIntegrationActionDto = {
       name,
@@ -33,6 +66,12 @@ export class IntegrationActionModule extends BaseClient {
     return this.request<IntegrationAction>(`${urls.integrationActions}/${id}`, 'PATCH', dto);
   }
 
+  /**
+   * Delete an integration action.
+   *
+   * @param id - UUID of the integration action to delete.
+   * @returns A promise that resolves when the integration action has been deleted.
+   */
   public async deleteIntegrationAction(id: string): Promise<void> {
     await this.request(`${urls.integrationActions}/${id}`, 'DELETE');
   }

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

@@ -100,7 +100,7 @@ export class LogModule extends BaseClient {
   /**
    * Convenience methods for different log levels
    */
-  public async logInfo(message: string, context?: string, action?: string, data?: any): Promise<Log> {
+  public async logInfo(message: string, context?: string, action?: string, data?: Record<string, unknown>): Promise<Log> {
     return this.createLog({
       level: 'info',
       message,
@@ -110,7 +110,7 @@ export class LogModule extends BaseClient {
     });
   }
 
-  public async logError(message: string, context?: string, action?: string, data?: any): Promise<Log> {
+  public async logError(message: string, context?: string, action?: string, data?: Record<string, unknown>): Promise<Log> {
     return this.createLog({
       level: 'error',
       message,
@@ -120,7 +120,7 @@ export class LogModule extends BaseClient {
     });
   }
 
-  public async logWarn(message: string, context?: string, action?: string, data?: any): Promise<Log> {
+  public async logWarn(message: string, context?: string, action?: string, data?: Record<string, unknown>): Promise<Log> {
     return this.createLog({
       level: 'warn',
       message,
@@ -130,7 +130,7 @@ export class LogModule extends BaseClient {
     });
   }
 
-  public async logDebug(message: string, context?: string, action?: string, data?: any): Promise<Log> {
+  public async logDebug(message: string, context?: string, action?: string, data?: Record<string, unknown>): Promise<Log> {
     return this.createLog({
       level: 'debug',
       message,

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;