whio-api-sdk 1.1.15 → 1.1.17

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

@@ -1,2 +1,3 @@
 export { ApiSDK } from "./sdk";
 export * from "./types";
+export { AxiosError } from 'axios';

package/dist/src/sdk/index.js

@@ -1,2 +1,3 @@
 export { ApiSDK } from "./sdk";
 export * from "./types";
+export { AxiosError } from 'axios';

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

@@ -3,13 +3,13 @@ import { SummaryRating, CreateSummaryRatingDto, FilterSummaryRatingsDto, Summary
 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
+     * @param ratingData - The rating data including datetime, rating (0-5), and optional fields: notes, transcriptionSummaryId, sessionId, templateId, templateName
+     * @returns The created SummaryRating with user, transcriptionSummary, session, and template 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
+     * @param filters - Optional filters including userId, transcriptionSummaryId, sessionId, templateId, date range, and pagination
      * @returns Paginated response with ratings array, total count, limit, and offset
      */
     getRatings(filters?: FilterSummaryRatingsDto): Promise<SummaryRatingsResponse>;
@@ -38,4 +38,20 @@ export declare class RatingModule extends BaseClient {
      * @returns Paginated response with ratings within the specified date range
      */
     getRatingsByDateRange(startDate: string, endDate: string, limit?: number, offset?: number): Promise<SummaryRatingsResponse>;
+    /**
+     * Get ratings by session ID (Superuser only)
+     * @param sessionId - The session 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 session
+     */
+    getRatingsBySession(sessionId: string, limit?: number, offset?: number): Promise<SummaryRatingsResponse>;
+    /**
+     * Get ratings by template ID (Superuser only)
+     * @param templateId - The template 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 template
+     */
+    getRatingsByTemplate(templateId: string, limit?: number, offset?: number): Promise<SummaryRatingsResponse>;
 }

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

@@ -12,8 +12,8 @@ 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
+     * @param ratingData - The rating data including datetime, rating (0-5), and optional fields: notes, transcriptionSummaryId, sessionId, templateId, templateName
+     * @returns The created SummaryRating with user, transcriptionSummary, session, and template relations
      */
     createRating(ratingData) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -22,7 +22,7 @@ export class RatingModule extends BaseClient {
     }
     /**
      * Get all ratings with optional filters (Superuser only)
-     * @param filters - Optional filters including userId, transcriptionSummaryId, date range, and pagination
+     * @param filters - Optional filters including userId, transcriptionSummaryId, sessionId, templateId, date range, and pagination
      * @returns Paginated response with ratings array, total count, limit, and offset
      */
     getRatings(filters) {
@@ -37,6 +37,12 @@ export class RatingModule extends BaseClient {
             if (filters.transcriptionSummaryId) {
                 params.append('transcriptionSummaryId', filters.transcriptionSummaryId);
             }
+            if (filters.sessionId) {
+                params.append('sessionId', filters.sessionId);
+            }
+            if (filters.templateId) {
+                params.append('templateId', filters.templateId);
+            }
             if (filters.startDate) {
                 params.append('startDate', filters.startDate);
             }
@@ -91,4 +97,28 @@ export class RatingModule extends BaseClient {
             return this.getRatings({ startDate, endDate, limit, offset });
         });
     }
+    /**
+     * Get ratings by session ID (Superuser only)
+     * @param sessionId - The session 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 session
+     */
+    getRatingsBySession(sessionId, limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getRatings({ sessionId, limit, offset });
+        });
+    }
+    /**
+     * Get ratings by template ID (Superuser only)
+     * @param templateId - The template 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 template
+     */
+    getRatingsByTemplate(templateId, limit, offset) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getRatings({ templateId, limit, offset });
+        });
+    }
 }

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

@@ -242,4 +242,6 @@ export declare class ApiSDK extends BaseClient {
     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>;
+    getRatingsBySession(...args: Parameters<RatingModule['getRatingsBySession']>): Promise<import("./types").SummaryRatingsResponse>;
+    getRatingsByTemplate(...args: Parameters<RatingModule['getRatingsByTemplate']>): Promise<import("./types").SummaryRatingsResponse>;
 }

package/dist/src/sdk/sdk.js

@@ -1002,4 +1002,14 @@ export class ApiSDK extends BaseClient {
             return this.ratings.getRatingsByDateRange(...args);
         });
     }
+    getRatingsBySession(...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.ratings.getRatingsBySession(...args);
+        });
+    }
+    getRatingsByTemplate(...args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.ratings.getRatingsByTemplate(...args);
+        });
+    }
 }

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

@@ -1,26 +1,37 @@
 import { User } from './user.types';
-import { TranscriptionSummary } from './template.types';
+import { TranscriptionSummary, Template } from './template.types';
+import { Session } from './session.types';
 export interface SummaryRating {
     id: string;
     userId: string;
     datetime: string;
     transcriptionSummaryId: string | null;
+    sessionId: string | null;
+    templateId: string | null;
+    templateName: string | null;
     notes: string | null;
     rating: number;
     createdAt: string;
     updatedAt: string;
     user?: User;
     transcriptionSummary?: TranscriptionSummary;
+    session?: Session;
+    template?: Template;
 }
 export interface CreateSummaryRatingDto {
     datetime: string;
     transcriptionSummaryId?: string;
+    sessionId?: string;
+    templateId?: string;
+    templateName?: string;
     notes?: string;
     rating: number;
 }
 export interface FilterSummaryRatingsDto {
     userId?: string;
     transcriptionSummaryId?: string;
+    sessionId?: string;
+    templateId?: string;
     startDate?: string;
     endDate?: string;
     limit?: number;

package/package.json

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

package/src/sdk/index.ts

@@ -1,2 +1,3 @@
 export { ApiSDK } from "./sdk";
-export * from "./types";
+export * from "./types";
+export { AxiosError } from 'axios';

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

@@ -10,8 +10,8 @@ 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
+   * @param ratingData - The rating data including datetime, rating (0-5), and optional fields: notes, transcriptionSummaryId, sessionId, templateId, templateName
+   * @returns The created SummaryRating with user, transcriptionSummary, session, and template relations
    */
   public async createRating(
     ratingData: CreateSummaryRatingDto,
@@ -21,7 +21,7 @@ export class RatingModule extends BaseClient {
 
   /**
    * Get all ratings with optional filters (Superuser only)
-   * @param filters - Optional filters including userId, transcriptionSummaryId, date range, and pagination
+   * @param filters - Optional filters including userId, transcriptionSummaryId, sessionId, templateId, date range, and pagination
    * @returns Paginated response with ratings array, total count, limit, and offset
    */
   public async getRatings(
@@ -39,6 +39,12 @@ export class RatingModule extends BaseClient {
     if (filters.transcriptionSummaryId) {
       params.append('transcriptionSummaryId', filters.transcriptionSummaryId);
     }
+    if (filters.sessionId) {
+      params.append('sessionId', filters.sessionId);
+    }
+    if (filters.templateId) {
+      params.append('templateId', filters.templateId);
+    }
     if (filters.startDate) {
       params.append('startDate', filters.startDate);
     }
@@ -104,4 +110,34 @@ export class RatingModule extends BaseClient {
   ): Promise<SummaryRatingsResponse> {
     return this.getRatings({ startDate, endDate, limit, offset });
   }
+
+  /**
+   * Get ratings by session ID (Superuser only)
+   * @param sessionId - The session 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 session
+   */
+  public async getRatingsBySession(
+    sessionId: string,
+    limit?: number,
+    offset?: number,
+  ): Promise<SummaryRatingsResponse> {
+    return this.getRatings({ sessionId, limit, offset });
+  }
+
+  /**
+   * Get ratings by template ID (Superuser only)
+   * @param templateId - The template 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 template
+   */
+  public async getRatingsByTemplate(
+    templateId: string,
+    limit?: number,
+    offset?: number,
+  ): Promise<SummaryRatingsResponse> {
+    return this.getRatings({ templateId, limit, offset });
+  }
 }

package/src/sdk/sdk.ts

@@ -875,4 +875,12 @@ export class ApiSDK extends BaseClient {
     return this.ratings.getRatingsByDateRange(...args);
   }
 
+  public async getRatingsBySession(...args: Parameters<RatingModule['getRatingsBySession']>) {
+    return this.ratings.getRatingsBySession(...args);
+  }
+
+  public async getRatingsByTemplate(...args: Parameters<RatingModule['getRatingsByTemplate']>) {
+    return this.ratings.getRatingsByTemplate(...args);
+  }
+
 }

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

@@ -1,22 +1,31 @@
 import { User } from './user.types';
-import { TranscriptionSummary } from './template.types';
+import { TranscriptionSummary, Template } from './template.types';
+import { Session } from './session.types';
 
 export interface SummaryRating {
   id: string;
   userId: string;
   datetime: string;
   transcriptionSummaryId: string | null;
+  sessionId: string | null;
+  templateId: string | null;
+  templateName: string | null;
   notes: string | null;
   rating: number;
   createdAt: string;
   updatedAt: string;
   user?: User;
   transcriptionSummary?: TranscriptionSummary;
+  session?: Session;
+  template?: Template;
 }
 
 export interface CreateSummaryRatingDto {
   datetime: string;
   transcriptionSummaryId?: string;
+  sessionId?: string;
+  templateId?: string;
+  templateName?: string;
   notes?: string;
   rating: number;
 }
@@ -24,6 +33,8 @@ export interface CreateSummaryRatingDto {
 export interface FilterSummaryRatingsDto {
   userId?: string;
   transcriptionSummaryId?: string;
+  sessionId?: string;
+  templateId?: string;
   startDate?: string;
   endDate?: string;
   limit?: number;