whio-api-sdk 1.1.28 → 1.1.29

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

@@ -13,51 +13,112 @@ 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.
+     */
     createSession(sessionData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(urls.sessions, 'POST', sessionData);
         });
     }
+    /**
+     * Retrieve the authenticated user's own sessions.
+     *
+     * @returns The current user's sessions.
+     */
     getSessions() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/my-sessions`, 'GET');
         });
     }
+    /**
+     * Retrieve a single session by its id.
+     *
+     * @param id - UUID of the session to fetch.
+     * @returns The requested session.
+     */
     getSession(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${id}`, 'GET');
         });
     }
+    /**
+     * Update a session.
+     *
+     * @param id - UUID of the session to update.
+     * @param sessionData - Fields to update on the session.
+     * @returns The updated session.
+     */
     updateSession(id, sessionData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${id}`, 'PATCH', sessionData);
         });
     }
+    /**
+     * Delete a session.
+     *
+     * @param id - UUID of the session to delete.
+     * @returns The deleted session.
+     */
     deleteSession(id) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.request(`${urls.sessions}/${id}`, 'DELETE');
+            return this.request(`${urls.sessions}/${id}`, 'DELETE');
         });
     }
+    /**
+     * Set the primary transcription summary for a session.
+     *
+     * @param sessionId - UUID of the session.
+     * @param summaryId - UUID of the transcription summary to mark as primary.
+     * @returns The updated session.
+     */
     setPrimaryTranscriptionSummary(sessionId, summaryId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${sessionId}/primary-summary/${summaryId}`, 'PATCH');
         });
     }
+    /**
+     * Re-run transcription for a session.
+     *
+     * @param sessionId - UUID of the session to re-transcribe.
+     * @returns A confirmation message with the session id.
+     */
     rerunTranscription(sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/${sessionId}/rerun-transcription`, 'POST');
         });
     }
+    /**
+     * Update the audio stream status of a session.
+     *
+     * @param data - The session id and the new audio stream status.
+     * @returns The updated session.
+     */
     setAudioStreamStatus(data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/set-audio-stream-status`, 'PATCH', data);
         });
     }
+    /**
+     * Forward a session to Tiaki.
+     *
+     * @param sessionId - UUID of the session to forward.
+     * @returns A response containing a status message.
+     */
     forwardToTiaki(sessionId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.request(`${urls.sessions}/forward-to-tiaki/${sessionId}`, 'POST');
         });
     }
+    /**
+     * Search the authenticated user's sessions using the provided filters.
+     *
+     * @param filters - Optional search filters (date range, user, template, pagination, etc.).
+     * @returns A paginated search response of matching sessions.
+     */
     searchSessions(filters = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             const params = this.buildSearchParams(filters);
@@ -86,6 +147,8 @@ export class SessionModule extends BaseClient {
             params.append('hasSummary', filters.hasSummary.toString());
         if (filters.includeTranscriptions !== undefined)
             params.append('includeTranscriptions', filters.includeTranscriptions.toString());
+        if (filters.includeArchived !== undefined)
+            params.append('includeArchived', filters.includeArchived.toString());
         if (filters.limit !== undefined)
             params.append('limit', filters.limit.toString());
         if (filters.offset !== undefined)

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

@@ -4,12 +4,57 @@ import { Session, SessionsResponse, UpdateSessionDto, SearchSessionsDto, SearchS
  * Session module for superusers - provides access to all sessions across the system
  */
 export declare 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.
+     */
     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/superuser-session.module.js

@@ -13,11 +13,24 @@ 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.
+     */
     getSessionsByUser(userId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(`${urls.sessions}/superuser/user/${userId}`, 'GET');
+            return this.request(`${urls.sessions}/user/${userId}`, 'GET');
         });
     }
+    /**
+     * Retrieve a paginated list of sessions for the organization.
+     *
+     * @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();
@@ -26,29 +39,61 @@ export class SuperuserSessionModule extends BaseClient {
             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}/superuser/search?${queryString}` : `${urls.sessions}/superuser/search`;
+            const url = queryString ? `${urls.sessions}/search?${queryString}` : `${urls.sessions}/search`;
             return this.request(url, 'GET');
         });
     }
+    /**
+     * Update a session.
+     *
+     * @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}/superuser/${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}/superuser/${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}/superuser/${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 SuperuserSessionModule extends BaseClient {
             params.append('hasSummary', filters.hasSummary.toString());
         if (filters.includeTranscriptions !== undefined)
             params.append('includeTranscriptions', filters.includeTranscriptions.toString());
+        if (filters.includeArchived !== undefined)
+            params.append('includeArchived', filters.includeArchived.toString());
         if (filters.limit !== undefined)
             params.append('limit', filters.limit.toString());
         if (filters.offset !== undefined)

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

@@ -1,30 +1,169 @@
 import { BaseClient } from './base-client';
 import { Session, SessionsResponse, CreateSessionDto, UpdateSessionDto, SetAudioStreamStatusDto, ForwardToTiakiResponse, SearchSessionsDto, SearchSessionsResponse } from '../types';
 export declare class SessionModule extends BaseClient {
+    /**
+     * Create a new session.
+     *
+     * @param sessionData - The session payload to create.
+     * @returns The created session.
+     */
     createSession(sessionData: CreateSessionDto): Promise<Session>;
+    /**
+     * Retrieve the authenticated user's own sessions.
+     *
+     * @returns The current user's sessions.
+     */
     getSessions(): 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>;
+    /**
+     * 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>;
+    /**
+     * Re-run transcription for a session.
+     *
+     * @param sessionId - UUID of the session to re-transcribe.
+     * @returns A confirmation message with the session id.
+     */
     rerunTranscription(sessionId: string): Promise<{
         message: string;
         sessionId: string;
     }>;
+    /**
+     * Update the audio stream status of a session.
+     *
+     * @param data - The session id and the new audio stream status.
+     * @returns The updated session.
+     */
     setAudioStreamStatus(data: SetAudioStreamStatusDto): Promise<Session>;
+    /**
+     * Forward a session to Tiaki.
+     *
+     * @param sessionId - UUID of the session to forward.
+     * @returns A response containing a status message.
+     */
     forwardToTiaki(sessionId: string): Promise<ForwardToTiakiResponse>;
+    /**
+     * Search the authenticated user's sessions using the provided filters.
+     *
+     * @param filters - Optional search filters (date range, user, template, pagination, etc.).
+     * @returns A paginated search response of matching sessions.
+     */
     searchSessions(filters?: SearchSessionsDto): Promise<SearchSessionsResponse>;
+    /**
+     * Retrieve all sessions belonging to a specific user (superuser scope).
+     *
+     * @param userId - UUID of the user whose sessions to fetch.
+     * @returns The user's sessions.
+     */
     superuserGetSessionsByUser(userId: string): Promise<Session[]>;
+    /**
+     * Retrieve a paginated list of sessions for the organization (superuser scope).
+     *
+     * @param limit - Maximum number of sessions to return (default 100).
+     * @param offset - Number of sessions to skip for pagination (default 0).
+     * @returns A paginated sessions response.
+     */
     superuserGetSessionsByOrganization(limit?: number, offset?: number): Promise<SessionsResponse>;
+    /**
+     * Search sessions using the provided filters (superuser scope).
+     *
+     * @param filters - Optional search filters (date range, user, template, pagination, etc.).
+     * @returns A paginated search response of matching sessions.
+     */
     superuserSearchSessions(filters?: SearchSessionsDto): Promise<SearchSessionsResponse>;
+    /**
+     * Update a session (superuser scope).
+     *
+     * @param id - UUID of the session to update.
+     * @param sessionData - Fields to update on the session.
+     * @returns The updated session.
+     */
     superuserUpdateSession(id: string, sessionData: UpdateSessionDto): Promise<Session>;
-    superuserDeleteSession(id: string): Promise<void>;
+    /**
+     * Delete a session (superuser scope).
+     *
+     * @param id - UUID of the session to delete.
+     * @returns The deleted session.
+     */
+    superuserDeleteSession(id: string): Promise<Session>;
+    /**
+     * Set the primary transcription summary for a session (superuser scope).
+     *
+     * @param sessionId - UUID of the session.
+     * @param summaryId - UUID of the transcription summary to mark as primary.
+     * @returns The updated session.
+     */
     superuserSetPrimaryTranscriptionSummary(sessionId: string, summaryId: string): Promise<Session>;
+    /**
+     * Retrieve all sessions belonging to a specific user (org admin scope).
+     *
+     * @param userId - UUID of the user whose sessions to fetch.
+     * @returns The user's sessions.
+     */
     orgAdminGetSessionsByUser(userId: string): Promise<Session[]>;
+    /**
+     * Retrieve a paginated list of sessions for the organization (org admin scope).
+     *
+     * @param limit - Maximum number of sessions to return (default 100).
+     * @param offset - Number of sessions to skip for pagination (default 0).
+     * @returns A paginated sessions response.
+     */
     orgAdminGetSessionsByOrganization(limit?: number, offset?: number): Promise<SessionsResponse>;
+    /**
+     * Search sessions using the provided filters (org admin scope).
+     *
+     * @param filters - Optional search filters (date range, user, template, pagination, etc.).
+     * @returns A paginated search response of matching sessions.
+     */
     orgAdminSearchSessions(filters?: SearchSessionsDto): Promise<SearchSessionsResponse>;
+    /**
+     * Update a session (org admin scope).
+     *
+     * @param id - UUID of the session to update.
+     * @param sessionData - Fields to update on the session.
+     * @returns The updated session.
+     */
     orgAdminUpdateSession(id: string, sessionData: UpdateSessionDto): Promise<Session>;
-    orgAdminDeleteSession(id: string): Promise<void>;
+    /**
+     * Delete a session (org admin scope).
+     *
+     * @param id - UUID of the session to delete.
+     * @returns The deleted session.
+     */
+    orgAdminDeleteSession(id: string): Promise<Session>;
+    /**
+     * Set the primary transcription summary for a session (org admin scope).
+     *
+     * @param sessionId - UUID of the session.
+     * @param summaryId - UUID of the transcription summary to mark as primary.
+     * @returns The updated session.
+     */
     orgAdminSetPrimaryTranscriptionSummary(sessionId: string, summaryId: string): Promise<Session>;
     private buildSearchParams;
 }