whio-api-sdk 1.1.28 → 1.1.33

package/dist/src/sdk/modules/external-integration.module.js

@@ -10,26 +10,56 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { BaseClient } from './base-client';
 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).
+     */
     createExternalIntegration(data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.externalIntegrations, 'POST', data);
         });
     }
+    /**
+     * List all external integrations.
+     *
+     * @returns An array of external integrations (each `apiKey` is returned masked).
+     */
     getExternalIntegrations() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.externalIntegrations, 'GET');
         });
     }
+    /**
+     * Get a single external integration by id.
+     *
+     * @param id - UUID of the external integration.
+     * @returns The external integration (its `apiKey` is returned masked).
+     */
     getExternalIntegration(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.externalIntegrations}/${id}`, 'GET');
         });
     }
+    /**
+     * 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).
+     */
     updateExternalIntegration(id, data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.externalIntegrations}/${id}`, 'PATCH', data);
         });
     }
+    /**
+     * Delete an external integration.
+     *
+     * @param id - UUID of the external integration to delete.
+     * @returns A promise that resolves when the integration has been deleted.
+     */
     deleteExternalIntegration(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.externalIntegrations}/${id}`, 'DELETE');

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

@@ -1,10 +1,49 @@
 import { BaseClient } from './base-client';
 import { IntegrationAction } from '../types';
 export declare 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.
+     */
     createIntegrationAction(name: string, organizationId?: string): Promise<IntegrationAction>;
+    /**
+     * List integration actions, optionally filtered by organization.
+     *
+     * @param organizationId - Optional organization UUID to filter by.
+     * @returns An array of integration actions.
+     */
     getIntegrationActions(organizationId?: string): Promise<IntegrationAction[]>;
+    /**
+     * Get a single integration action by id.
+     *
+     * @param id - UUID of the integration action.
+     * @returns The integration action.
+     */
     getIntegrationAction(id: string): Promise<IntegrationAction>;
+    /**
+     * 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.
+     */
     getIntegrationActionsByOrganization(organizationId?: string): Promise<IntegrationAction[]>;
+    /**
+     * 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.
+     */
     updateIntegrationAction(id: string, name: string, organizationId?: string): Promise<IntegrationAction>;
+    /**
+     * 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.
+     */
     deleteIntegrationAction(id: string): Promise<void>;
 }

package/dist/src/sdk/modules/integration-action.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 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.
+     */
     createIntegrationAction(name, organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = {
@@ -19,23 +26,49 @@ export class IntegrationActionModule extends BaseClient {
             return this.request(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.
+     */
     getIntegrationActions(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = organizationId ? `?organizationId=${organizationId}` : '';
             return this.request(`${urls.integrationActions}${params}`, 'GET');
         });
     }
+    /**
+     * Get a single integration action by id.
+     *
+     * @param id - UUID of the integration action.
+     * @returns The integration action.
+     */
     getIntegrationAction(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     getIntegrationActionsByOrganization(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             const orgId = organizationId || this.user.organizationId;
             return this.request(`${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.
+     */
     updateIntegrationAction(id, name, organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = {
@@ -45,6 +78,12 @@ export class IntegrationActionModule extends BaseClient {
             return this.request(`${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.
+     */
     deleteIntegrationAction(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.integrationActions}/${id}`, 'DELETE');

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

@@ -32,10 +32,10 @@ export declare class LogModule extends BaseClient {
     /**
      * Convenience methods for different log levels
      */
-    logInfo(message: string, context?: string, action?: string, data?: any): Promise<Log>;
-    logError(message: string, context?: string, action?: string, data?: any): Promise<Log>;
-    logWarn(message: string, context?: string, action?: string, data?: any): Promise<Log>;
-    logDebug(message: string, context?: string, action?: string, data?: any): Promise<Log>;
+    logInfo(message: string, context?: string, action?: string, data?: Record<string, unknown>): Promise<Log>;
+    logError(message: string, context?: string, action?: string, data?: Record<string, unknown>): Promise<Log>;
+    logWarn(message: string, context?: string, action?: string, data?: Record<string, unknown>): Promise<Log>;
+    logDebug(message: string, context?: string, action?: string, data?: Record<string, unknown>): Promise<Log>;
     /**
      * Get logs by role
      */

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

@@ -1,13 +1,72 @@
 import { BaseClient } from './base-client';
-import { Organization } from '../types';
+import { Organization, User } from '../types';
 export declare 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.
+     */
     createOrganization(name: string, description?: string): Promise<Organization>;
+    /**
+     * List all organizations the current user can access.
+     *
+     * @returns An array of organizations.
+     */
     getOrganizations(): Promise<Organization[]>;
+    /**
+     * Get a single organization by ID.
+     *
+     * @param id - UUID of the organization.
+     * @returns The requested organization.
+     */
     getOrganization(id: string): Promise<Organization>;
+    /**
+     * 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.
+     */
     updateOrganization(id: string, name?: string, description?: string): Promise<Organization>;
+    /**
+     * Delete an organization by ID.
+     *
+     * @param id - UUID of the organization to delete.
+     * @returns A promise that resolves when the organization is deleted.
+     */
     deleteOrganization(id: string): Promise<void>;
-    addUserToOrganization(organizationId: string, userId: string): Promise<void>;
-    removeUserFromOrganization(organizationId: string, userId: string): Promise<void>;
+    /**
+     * 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.
+     */
+    addUserToOrganization(organizationId: string, userId: string): Promise<User>;
+    /**
+     * 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.
+     */
+    removeUserFromOrganization(organizationId: string, userId: string): Promise<User>;
+    /**
+     * 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.
+     */
     linkExternalIntegration(organizationId: string, integrationId: string): Promise<Organization>;
+    /**
+     * Unlink the external integration from an organization.
+     *
+     * @param organizationId - UUID of the organization.
+     * @returns The updated organization.
+     */
     unlinkExternalIntegration(organizationId: string): Promise<Organization>;
 }

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

@@ -10,48 +10,107 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { BaseClient } from './base-client';
 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.
+     */
     createOrganization(name, description) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = { name, description };
             return this.request(urls.organizations, 'POST', dto);
         });
     }
+    /**
+     * List all organizations the current user can access.
+     *
+     * @returns An array of organizations.
+     */
     getOrganizations() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.organizations, 'GET');
         });
     }
+    /**
+     * Get a single organization by ID.
+     *
+     * @param id - UUID of the organization.
+     * @returns The requested organization.
+     */
     getOrganization(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${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.
+     */
     updateOrganization(id, name, description) {
         return __awaiter(this, void 0, void 0, function* () {
             const dto = { name, description };
             return this.request(`${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.
+     */
     deleteOrganization(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.request(`${urls.organizations}/${id}`, 'DELETE');
         });
     }
+    /**
+     * 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.
+     */
     addUserToOrganization(organizationId, userId) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.organizations}/${organizationId}/users/${userId}`, 'POST');
+            return this.request(`${urls.organizations}/${organizationId}/users/${userId}`, 'POST');
         });
     }
+    /**
+     * 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.
+     */
     removeUserFromOrganization(organizationId, userId) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.organizations}/${organizationId}/users/${userId}`, 'DELETE');
+            return this.request(`${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.
+     */
     linkExternalIntegration(organizationId, integrationId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.organizations}/${organizationId}/external-integration/${integrationId}`, 'POST');
         });
     }
+    /**
+     * Unlink the external integration from an organization.
+     *
+     * @param organizationId - UUID of the organization.
+     * @returns The updated organization.
+     */
     unlinkExternalIntegration(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.organizations}/${organizationId}/external-integration`, 'DELETE');

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

@@ -5,8 +5,11 @@ import { PatientsFromIntegrationResponse } from '../types/patient.types';
  */
 export declare 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.
      */
     getPatientsFromIntegration(): Promise<PatientsFromIntegrationResponse>;
 }

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

@@ -14,8 +14,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.
      */
     getPatientsFromIntegration() {
         return __awaiter(this, void 0, void 0, function* () {

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

@@ -2,14 +2,14 @@ import { BaseClient } from './base-client';
 export declare 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
      */
-    getCompanyDailyReportCsv(companyId: string): Promise<string>;
+    getCompanyDailyReportCsv(organizationId: string): Promise<string>;
     /**
      * 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
      */
-    downloadCompanyDailyReport(companyId: string): Promise<Blob>;
+    downloadCompanyDailyReport(organizationId: string): Promise<Blob>;
 }

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

@@ -12,22 +12,22 @@ 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
      */
-    getCompanyDailyReportCsv(companyId) {
+    getCompanyDailyReportCsv(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.textRequest(`${urls.reports}/company-daily?companyId=${companyId}`);
+            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
      */
-    downloadCompanyDailyReport(companyId) {
+    downloadCompanyDailyReport(organizationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.downloadRequest(`${urls.reports}/company-daily?companyId=${companyId}`);
+            return this.downloadRequest(`${urls.reports}/company-daily?organizationId=${organizationId}`);
         });
     }
 }

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

@@ -4,12 +4,57 @@ import { Session, SessionsResponse, UpdateSessionDto, SearchSessionsDto, SearchS
  * Session module for organization admins - provides access to sessions within their organization
  */
 export declare 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.
+     */
     getSessionsByUser(userId: string): Promise<Session[]>;
+    /**
+     * 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.
+     */
     getSessionsByOrganization(limit?: number, offset?: number): Promise<SessionsResponse>;
+    /**
+     * 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.
+     */
     searchSessions(filters?: SearchSessionsDto): Promise<SearchSessionsResponse>;
+    /**
+     * 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: string, sessionData: UpdateSessionDto): Promise<Session>;
-    deleteSession(id: string): Promise<void>;
+    /**
+     * Delete a session.
+     *
+     * @param id - UUID of the session to delete.
+     * @returns The deleted session.
+     */
+    deleteSession(id: string): Promise<Session>;
+    /**
+     * 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: string, summaryId: string): Promise<Session>;
+    /**
+     * Retrieve a single session by its id.
+     *
+     * @param id - UUID of the session to fetch.
+     * @returns The requested session.
+     */
     getSession(id: string): Promise<Session>;
     private buildSearchParams;
 }

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

@@ -13,42 +13,87 @@ 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.
+     */
     getSessionsByUser(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.
+     *
+     * @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.
+     */
     getSessionsByOrganization(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.
+     *
+     * @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);
             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.
+     *
+     * @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}/orgadmin/${id}`, 'PATCH', sessionData);
+            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}/orgadmin/${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}/orgadmin/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
+            return this.request(`${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.
+     */
     getSession(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${id}`, 'GET');
@@ -74,6 +119,8 @@ export class OrgAdminSessionModule 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)