whio-api-sdk 1.1.14 → 1.1.15

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

@@ -0,0 +1,41 @@
+import { BaseClient } from './base-client';
+import { SummaryRating, CreateSummaryRatingDto, FilterSummaryRatingsDto, SummaryRatingsResponse } from '../types';
+export declare class RatingModule extends BaseClient {
+    /**
+     * Create a new summary rating
+     * @param ratingData - The rating data including datetime, rating (0-5), optional notes and transcriptionSummaryId
+     * @returns The created SummaryRating with user and transcriptionSummary relations
+     */
+    createRating(ratingData: CreateSummaryRatingDto): Promise<SummaryRating>;
+    /**
+     * Get all ratings with optional filters (Superuser only)
+     * @param filters - Optional filters including userId, transcriptionSummaryId, date range, and pagination
+     * @returns Paginated response with ratings array, total count, limit, and offset
+     */
+    getRatings(filters?: FilterSummaryRatingsDto): Promise<SummaryRatingsResponse>;
+    /**
+     * Get ratings by user ID (Superuser only)
+     * @param userId - The user ID to filter ratings by
+     * @param limit - Maximum number of ratings to return
+     * @param offset - Number of ratings to skip
+     * @returns Paginated response with ratings for the specified user
+     */
+    getRatingsByUser(userId: string, limit?: number, offset?: number): Promise<SummaryRatingsResponse>;
+    /**
+     * Get ratings by transcription summary ID (Superuser only)
+     * @param transcriptionSummaryId - The transcription summary ID to filter ratings by
+     * @param limit - Maximum number of ratings to return
+     * @param offset - Number of ratings to skip
+     * @returns Paginated response with ratings for the specified transcription summary
+     */
+    getRatingsByTranscriptionSummary(transcriptionSummaryId: string, limit?: number, offset?: number): Promise<SummaryRatingsResponse>;
+    /**
+     * Get ratings within a date range (Superuser only)
+     * @param startDate - ISO date string for the start of the range
+     * @param endDate - ISO date string for the end of the range
+     * @param limit - Maximum number of ratings to return
+     * @param offset - Number of ratings to skip
+     * @returns Paginated response with ratings within the specified date range
+     */
+    getRatingsByDateRange(startDate: string, endDate: string, limit?: number, offset?: number): Promise<SummaryRatingsResponse>;
+}

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

@@ -0,0 +1,94 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { BaseClient } from './base-client';
+import urls from '../urls';
+export class RatingModule extends BaseClient {
+    /**
+     * Create a new summary rating
+     * @param ratingData - The rating data including datetime, rating (0-5), optional notes and transcriptionSummaryId
+     * @returns The created SummaryRating with user and transcriptionSummary relations
+     */
+    createRating(ratingData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request(urls.ratings, 'POST', ratingData);
+        });
+    }
+    /**
+     * Get all ratings with optional filters (Superuser only)
+     * @param filters - Optional filters including userId, transcriptionSummaryId, date range, and pagination
+     * @returns Paginated response with ratings array, total count, limit, and offset
+     */
+    getRatings(filters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!filters || Object.keys(filters).length === 0) {
+                return this.request(urls.ratings, 'GET');
+            }
+            const params = new URLSearchParams();
+            if (filters.userId) {
+                params.append('userId', filters.userId);
+            }
+            if (filters.transcriptionSummaryId) {
+                params.append('transcriptionSummaryId', filters.transcriptionSummaryId);
+            }
+            if (filters.startDate) {
+                params.append('startDate', filters.startDate);
+            }
+            if (filters.endDate) {
+                params.append('endDate', filters.endDate);
+            }
+            if (filters.limit !== undefined) {
+                params.append('limit', filters.limit.toString());
+            }
+            if (filters.offset !== undefined) {
+                params.append('offset', filters.offset.toString());
+            }
+            const queryString = params.toString();
+            const endpoint = `${urls.ratings}?${queryString}`;
+            return this.request(endpoint, 'GET');
+        });
+    }
+    /**
+     * Get ratings by user ID (Superuser only)
+     * @param userId - The user ID to filter ratings by
+     * @param limit - Maximum number of ratings to return
+     * @param offset - Number of ratings to skip
+     * @returns Paginated response with ratings for the specified user
+     */
+    getRatingsByUser(userId, limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getRatings({ userId, limit, offset });
+        });
+    }
+    /**
+     * Get ratings by transcription summary ID (Superuser only)
+     * @param transcriptionSummaryId - The transcription summary ID to filter ratings by
+     * @param limit - Maximum number of ratings to return
+     * @param offset - Number of ratings to skip
+     * @returns Paginated response with ratings for the specified transcription summary
+     */
+    getRatingsByTranscriptionSummary(transcriptionSummaryId, limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getRatings({ transcriptionSummaryId, limit, offset });
+        });
+    }
+    /**
+     * Get ratings within a date range (Superuser only)
+     * @param startDate - ISO date string for the start of the range
+     * @param endDate - ISO date string for the end of the range
+     * @param limit - Maximum number of ratings to return
+     * @param offset - Number of ratings to skip
+     * @returns Paginated response with ratings within the specified date range
+     */
+    getRatingsByDateRange(startDate, endDate, limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getRatings({ startDate, endDate, limit, offset });
+        });
+    }
+}

package/dist/src/sdk/sdk.d.ts

@@ -19,6 +19,7 @@ import { ReportsModule } from './modules/reports.module';
 import { PatientModule } from './modules/patient.module';
 import { DataStrategyModule } from './modules/data-strategy.module';
 import { SystemSnapshotModule } from './modules/system-snapshot.module';
+import { RatingModule } from './modules/rating.module';
 /**
  * Main SDK class that provides access to all domain-specific modules
  */
@@ -42,6 +43,7 @@ export declare class ApiSDK extends BaseClient {
     readonly patients: PatientModule;
     readonly dataStrategies: DataStrategyModule;
     readonly systemSnapshots: SystemSnapshotModule;
+    readonly ratings: RatingModule;
     private modules;
     private sdkInitialized;
     constructor(config?: SDKConfig);
@@ -235,4 +237,9 @@ export declare class ApiSDK extends BaseClient {
     getSystemSnapshots(...args: Parameters<SystemSnapshotModule['getSnapshots']>): Promise<import("./types").SystemSnapshotsResponse>;
     getLatestSystemSnapshot(...args: Parameters<SystemSnapshotModule['getLatestSnapshot']>): Promise<import("./types").SystemSnapshot | null>;
     getCurrentSystemMetrics(...args: Parameters<SystemSnapshotModule['getCurrentMetrics']>): Promise<import("./types").CurrentMetrics>;
+    createRating(...args: Parameters<RatingModule['createRating']>): Promise<import("./types").SummaryRating>;
+    getRatings(...args: Parameters<RatingModule['getRatings']>): Promise<import("./types").SummaryRatingsResponse>;
+    getRatingsByUser(...args: Parameters<RatingModule['getRatingsByUser']>): Promise<import("./types").SummaryRatingsResponse>;
+    getRatingsByTranscriptionSummary(...args: Parameters<RatingModule['getRatingsByTranscriptionSummary']>): Promise<import("./types").SummaryRatingsResponse>;
+    getRatingsByDateRange(...args: Parameters<RatingModule['getRatingsByDateRange']>): Promise<import("./types").SummaryRatingsResponse>;
 }

package/dist/src/sdk/sdk.js

@@ -27,6 +27,7 @@ import { ReportsModule } from './modules/reports.module';
 import { PatientModule } from './modules/patient.module';
 import { DataStrategyModule } from './modules/data-strategy.module';
 import { SystemSnapshotModule } from './modules/system-snapshot.module';
+import { RatingModule } from './modules/rating.module';
 /**
  * Main SDK class that provides access to all domain-specific modules
  */
@@ -54,12 +55,13 @@ export class ApiSDK extends BaseClient {
         this.patients = new PatientModule(config);
         this.dataStrategies = new DataStrategyModule(config);
         this.systemSnapshots = new SystemSnapshotModule(config);
+        this.ratings = new RatingModule(config);
         // Store all modules for batch operations
         this.modules = [
             this.auth, this.users, this.organizations, this.teams, this.templates,
             this.transcriptionSummaries, this.sessions, this.agents, this.audio,
             this.workflows, this.integrationActions, this.logs, this.debug, this.externalIntegrations,
-            this.reports, this.patients, this.dataStrategies, this.systemSnapshots,
+            this.reports, this.patients, this.dataStrategies, this.systemSnapshots, this.ratings,
             ...(this.websocket ? [this.websocket] : [])
         ];
         // Auto-initialize the SDK
@@ -974,4 +976,30 @@ export class ApiSDK extends BaseClient {
             return this.systemSnapshots.getCurrentMetrics(...args);
         });
     }
+    // Rating methods
+    createRating(...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.ratings.createRating(...args);
+        });
+    }
+    getRatings(...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.ratings.getRatings(...args);
+        });
+    }
+    getRatingsByUser(...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.ratings.getRatingsByUser(...args);
+        });
+    }
+    getRatingsByTranscriptionSummary(...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.ratings.getRatingsByTranscriptionSummary(...args);
+        });
+    }
+    getRatingsByDateRange(...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.ratings.getRatingsByDateRange(...args);
+        });
+    }
 }

package/dist/src/sdk/types/index.d.ts

@@ -16,3 +16,4 @@ export * from './reports.types';
 export * from './patient.types';
 export * from './data-strategy.types';
 export * from './system-snapshot.types';
+export * from './rating.types';

package/dist/src/sdk/types/index.js

@@ -17,3 +17,4 @@ export * from './reports.types';
 export * from './patient.types';
 export * from './data-strategy.types';
 export * from './system-snapshot.types';
+export * from './rating.types';

package/dist/src/sdk/types/rating.types.d.ts

@@ -0,0 +1,34 @@
+import { User } from './user.types';
+import { TranscriptionSummary } from './template.types';
+export interface SummaryRating {
+    id: string;
+    userId: string;
+    datetime: string;
+    transcriptionSummaryId: string | null;
+    notes: string | null;
+    rating: number;
+    createdAt: string;
+    updatedAt: string;
+    user?: User;
+    transcriptionSummary?: TranscriptionSummary;
+}
+export interface CreateSummaryRatingDto {
+    datetime: string;
+    transcriptionSummaryId?: string;
+    notes?: string;
+    rating: number;
+}
+export interface FilterSummaryRatingsDto {
+    userId?: string;
+    transcriptionSummaryId?: string;
+    startDate?: string;
+    endDate?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface SummaryRatingsResponse {
+    ratings: SummaryRating[];
+    total: number;
+    limit: number;
+    offset: number;
+}

package/dist/src/sdk/types/rating.types.js

@@ -0,0 +1 @@
+export {};

package/dist/src/sdk/urls.d.ts

@@ -37,5 +37,6 @@ declare const urls: {
     patients: string;
     dataStrategies: string;
     systemSnapshots: string;
+    ratings: string;
 };
 export default urls;

package/dist/src/sdk/urls.js

@@ -57,5 +57,7 @@ const urls = {
     dataStrategies: '/data-strategies',
     // System Snapshots
     systemSnapshots: '/system-snapshots',
+    // Ratings
+    ratings: '/ratings',
 };
 export default urls;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whio-api-sdk",
-  "version": "1.1.14",
+  "version": "1.1.15",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

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

@@ -0,0 +1,107 @@
+import { BaseClient } from './base-client';
+import {
+  SummaryRating,
+  CreateSummaryRatingDto,
+  FilterSummaryRatingsDto,
+  SummaryRatingsResponse,
+} from '../types';
+import urls from '../urls';
+
+export class RatingModule extends BaseClient {
+  /**
+   * Create a new summary rating
+   * @param ratingData - The rating data including datetime, rating (0-5), optional notes and transcriptionSummaryId
+   * @returns The created SummaryRating with user and transcriptionSummary relations
+   */
+  public async createRating(
+    ratingData: CreateSummaryRatingDto,
+  ): Promise<SummaryRating> {
+    return this.request<SummaryRating>(urls.ratings, 'POST', ratingData);
+  }
+
+  /**
+   * Get all ratings with optional filters (Superuser only)
+   * @param filters - Optional filters including userId, transcriptionSummaryId, date range, and pagination
+   * @returns Paginated response with ratings array, total count, limit, and offset
+   */
+  public async getRatings(
+    filters?: FilterSummaryRatingsDto,
+  ): Promise<SummaryRatingsResponse> {
+    if (!filters || Object.keys(filters).length === 0) {
+      return this.request<SummaryRatingsResponse>(urls.ratings, 'GET');
+    }
+
+    const params = new URLSearchParams();
+
+    if (filters.userId) {
+      params.append('userId', filters.userId);
+    }
+    if (filters.transcriptionSummaryId) {
+      params.append('transcriptionSummaryId', filters.transcriptionSummaryId);
+    }
+    if (filters.startDate) {
+      params.append('startDate', filters.startDate);
+    }
+    if (filters.endDate) {
+      params.append('endDate', filters.endDate);
+    }
+    if (filters.limit !== undefined) {
+      params.append('limit', filters.limit.toString());
+    }
+    if (filters.offset !== undefined) {
+      params.append('offset', filters.offset.toString());
+    }
+
+    const queryString = params.toString();
+    const endpoint = `${urls.ratings}?${queryString}`;
+
+    return this.request<SummaryRatingsResponse>(endpoint, 'GET');
+  }
+
+  /**
+   * Get ratings by user ID (Superuser only)
+   * @param userId - The user ID to filter ratings by
+   * @param limit - Maximum number of ratings to return
+   * @param offset - Number of ratings to skip
+   * @returns Paginated response with ratings for the specified user
+   */
+  public async getRatingsByUser(
+    userId: string,
+    limit?: number,
+    offset?: number,
+  ): Promise<SummaryRatingsResponse> {
+    return this.getRatings({ userId, limit, offset });
+  }
+
+  /**
+   * Get ratings by transcription summary ID (Superuser only)
+   * @param transcriptionSummaryId - The transcription summary ID to filter ratings by
+   * @param limit - Maximum number of ratings to return
+   * @param offset - Number of ratings to skip
+   * @returns Paginated response with ratings for the specified transcription summary
+   */
+  public async getRatingsByTranscriptionSummary(
+    transcriptionSummaryId: string,
+    limit?: number,
+    offset?: number,
+  ): Promise<SummaryRatingsResponse> {
+    return this.getRatings({ transcriptionSummaryId, limit, offset });
+  }
+
+  /**
+   * Get ratings within a date range (Superuser only)
+   * @param startDate - ISO date string for the start of the range
+   * @param endDate - ISO date string for the end of the range
+   * @param limit - Maximum number of ratings to return
+   * @param offset - Number of ratings to skip
+   * @returns Paginated response with ratings within the specified date range
+   */
+  public async getRatingsByDateRange(
+    startDate: string,
+    endDate: string,
+    limit?: number,
+    offset?: number,
+  ): Promise<SummaryRatingsResponse> {
+    return this.getRatings({ startDate, endDate, limit, offset });
+  }
+}

package/src/sdk/sdk.ts

@@ -20,6 +20,7 @@ import { ReportsModule } from './modules/reports.module';
 import { PatientModule } from './modules/patient.module';
 import { DataStrategyModule } from './modules/data-strategy.module';
 import { SystemSnapshotModule } from './modules/system-snapshot.module';
+import { RatingModule } from './modules/rating.module';
 
 /**
  * Main SDK class that provides access to all domain-specific modules
@@ -44,6 +45,7 @@ export class ApiSDK extends BaseClient {
   public readonly patients: PatientModule;
   public readonly dataStrategies: DataStrategyModule;
   public readonly systemSnapshots: SystemSnapshotModule;
+  public readonly ratings: RatingModule;
 
   private modules: BaseClient[];
   private sdkInitialized: boolean = false;
@@ -71,13 +73,14 @@ export class ApiSDK extends BaseClient {
     this.patients = new PatientModule(config);
     this.dataStrategies = new DataStrategyModule(config);
     this.systemSnapshots = new SystemSnapshotModule(config);
+    this.ratings = new RatingModule(config);
 
     // Store all modules for batch operations
     this.modules = [
       this.auth, this.users, this.organizations, this.teams, this.templates,
       this.transcriptionSummaries, this.sessions, this.agents, this.audio,
       this.workflows, this.integrationActions, this.logs, this.debug, this.externalIntegrations,
-      this.reports, this.patients, this.dataStrategies, this.systemSnapshots,
+      this.reports, this.patients, this.dataStrategies, this.systemSnapshots, this.ratings,
       ...(this.websocket ? [this.websocket] : [])
     ];
     
@@ -851,4 +854,25 @@ export class ApiSDK extends BaseClient {
     return this.systemSnapshots.getCurrentMetrics(...args);
   }
 
+  // Rating methods
+  public async createRating(...args: Parameters<RatingModule['createRating']>) {
+    return this.ratings.createRating(...args);
+  }
+
+  public async getRatings(...args: Parameters<RatingModule['getRatings']>) {
+    return this.ratings.getRatings(...args);
+  }
+
+  public async getRatingsByUser(...args: Parameters<RatingModule['getRatingsByUser']>) {
+    return this.ratings.getRatingsByUser(...args);
+  }
+
+  public async getRatingsByTranscriptionSummary(...args: Parameters<RatingModule['getRatingsByTranscriptionSummary']>) {
+    return this.ratings.getRatingsByTranscriptionSummary(...args);
+  }
+
+  public async getRatingsByDateRange(...args: Parameters<RatingModule['getRatingsByDateRange']>) {
+    return this.ratings.getRatingsByDateRange(...args);
+  }
+
 }

package/src/sdk/types/index.ts

@@ -17,3 +17,4 @@ export * from './reports.types';
 export * from './patient.types';
 export * from './data-strategy.types';
 export * from './system-snapshot.types';
+export * from './rating.types';

package/src/sdk/types/rating.types.ts

@@ -0,0 +1,38 @@
+import { User } from './user.types';
+import { TranscriptionSummary } from './template.types';
+
+export interface SummaryRating {
+  id: string;
+  userId: string;
+  datetime: string;
+  transcriptionSummaryId: string | null;
+  notes: string | null;
+  rating: number;
+  createdAt: string;
+  updatedAt: string;
+  user?: User;
+  transcriptionSummary?: TranscriptionSummary;
+}
+
+export interface CreateSummaryRatingDto {
+  datetime: string;
+  transcriptionSummaryId?: string;
+  notes?: string;
+  rating: number;
+}
+
+export interface FilterSummaryRatingsDto {
+  userId?: string;
+  transcriptionSummaryId?: string;
+  startDate?: string;
+  endDate?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface SummaryRatingsResponse {
+  ratings: SummaryRating[];
+  total: number;
+  limit: number;
+  offset: number;
+}

package/src/sdk/urls.ts

@@ -76,6 +76,9 @@ const urls = {
 
   // System Snapshots
   systemSnapshots: '/system-snapshots',
+
+  // Ratings
+  ratings: '/ratings',
 }
 
 export default urls;