testaugnitoambientsdk2 2.1.24 → 2.1.25

package/README.md

@@ -625,7 +625,25 @@ Used to fetch Transcription for any note that is recorded. It is essential to en
 | 500        | Unable to extract transcript data. Please try again.  | Failed to complete the operation. Please try again later.                    | Received when generated SOAP note can not be retrieved                                                  |
 | 500        | Internal Marshaling Error                             | Failed to complete the operation. Please try again later.                    | Received when generated transcript is not in expected readable format                                   |
 
-### 18-Check for Internet Connectivity
+### 18- Send Feedback
+
+Used to submit feedback for a generated note.
+
+```js
+/**
+ * @param JobId the job identifier for which feedback is being submitted
+ * @param Ratings a numeric rating from 1 to 5, value representing user satisfaction with the generated note
+ * @param Comment optional text comment providing additional feedback details
+ * @param Type optional string to specify the feedback category, defaults to 'SOAPFeedBack'
+ * @returns success response on successful submission of feedback else fail response
+ */
+public async sendFeedback(JobId: string, Ratings: number, Comment?: string, Type?: string): Promise<any>
+
+//Usage
+var response = await augnitoAmbient.sendFeedback("job-id", 4, "Good note quality", "SOAPFeedBack");
+```
+
+### 19-Check for Internet Connectivity
 
 Used to check if browser has access to internet connection or not
 

package/dist/AugnitoAmbient.d.ts

@@ -134,6 +134,13 @@ export declare class AugnitoAmbient {
      * @returns JSON object contains Time in seconds, Text spoken at that time and also array of MedicalData to highlight on success else fail response.
      */
     fetchTranscriptionForNote(JobId: string): Promise<any>;
+    /**
+     * @param JobId the job identifier for which feedback is being submitted
+     * @param Ratings a numeric rating from 1 to 5, value representing user satisfaction with the generated note
+     * @param Comment optional text comment providing additional feedback details
+     * @param Type optional string to specify the feedback category, defaults to 'SOAPFeedBack'
+     * @returns success response on successful submission of feedback else fail response
+     */
     sendFeedback(JobId: string, Ratings: number, Comment?: string, Type?: string): Promise<any>;
     /**
      * @param ConfigId to retrieve user config list for speciality type, visit type etc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaugnitoambientsdk2",
-  "version": "2.1.24",
+  "version": "2.1.25",
   "description": "Use this typescript SDK to integrate Augnito’s Ambient Tech within your EMR. To get access credentials or know more about how Augnito Ambient can benefit you, please visit our website and connect with our sales team: https://augnito.ai/",
   "main": "dist/augnitoambientsdk.js",
   "types": "dist/index.d.ts",

package/src/AugnitoAmbient.ts

@@ -505,6 +505,13 @@ export class AugnitoAmbient {
     }
   }
 
+  /**
+   * @param JobId the job identifier for which feedback is being submitted
+   * @param Ratings a numeric rating from 1 to 5, value representing user satisfaction with the generated note
+   * @param Comment optional text comment providing additional feedback details
+   * @param Type optional string to specify the feedback category, defaults to 'SOAPFeedBack'
+   * @returns success response on successful submission of feedback else fail response
+   */
   public async sendFeedback(JobId: string, Ratings: number, Comment?: string, Type?: string): Promise<any> {
     try {
       if (!this._ambientRestAPI) {