@coveo/relay-event-types 7.1.5 → 7.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay-event-types",
-  "version": "7.1.5",
+  "version": "7.2.0",
   "description": "Typescript types for Coveo Events, intended to be used with the Relay package.",
   "types": "./relay-event-types.d.ts",
   "author": "Coveo",

package/relay-event-types.d.ts

@@ -15,6 +15,14 @@ type UuidNotNull = string;
 interface Base {
 }
 
+/**
+ * A document suggestion.
+ */
+interface DocumentSuggestion {
+    id: string;
+    responseId: string;
+}
+
 /**
  * The ecCartAction event is emitted when a user adds or removes a product from the cart or changes a product's quantity.
  */
@@ -207,3 +215,104 @@ export interface Search extends Base {
     responseTimeInMs?: number;
 }
 
+/**
+ * A support ticket.
+ */
+interface Ticket {
+    /**
+     * The support ticket unique id as identified by the origin system.
+     */
+    id: string;
+    /**
+     * The category of the support ticket.
+     */
+    category?: string;
+    /**
+     * The description of the support ticket.
+     */
+    description?: string;
+    /**
+     * The subject of the support ticket.
+     */
+    subject?: string;
+    /**
+     * The origin system of the support ticket.
+     */
+    system?: string;
+}
+
+export namespace CaseAssist {
+    /**
+     * The CaseAssist.Start event is emitted when Coveo Case Assist support ticket creation flow is initiated.
+     */
+    export type Start = Base;
+    
+    /**
+     * The CaseAssist.Cancel event is emitted when Coveo Case Assist support ticket creation flow is canceled by the user.
+     */
+    export interface Cancel extends Base {
+        /**
+         * The reason why the user canceled the ticket creation flow.
+         */
+        reason: "solved" | "quit";
+    }
+    
+    /**
+     * The CaseAssist.CreateTicket event is emitted when a support ticket is created in Coveo Case Assist.
+     */
+    export interface CreateTicket extends Base {
+        ticket: Ticket;
+    }
+    
+    /**
+     * The CaseAssist.DocumentSuggestionClick event is emitted when a Coveo Case Assist document suggestion is clicked.
+     */
+    export interface DocumentSuggestionClick extends Base {
+        documentSuggestion: DocumentSuggestion;
+    }
+    
+    /**
+     * The CaseAssist.DocumentSuggestionFeedback event is emitted when feedback is given on a Coveo Case Assist document suggestion.
+     */
+    export interface DocumentSuggestionFeedback extends Base {
+        documentSuggestion: DocumentSuggestion;
+        /**
+         * Whether the user liked the document suggestion or not.
+         */
+        liked: boolean;
+    }
+    
+    /**
+     * The CaseAssist.selectFieldClassification event is emitted when a support ticket field recommendation is selected in Coveo Case Assist.
+     */
+    export interface SelectFieldClassification extends Base {
+        fieldClassification: {
+            /**
+             * The unique identifier of the field classification.
+             */
+            id: string;
+            /**
+             * The unique identifier of the response that contains the field classification.
+             */
+            responseId: string;
+        };
+        /**
+         * Whether the field classification was automatically selected by Coveo Case Assist.
+         */
+        autoselected: boolean;
+    }
+    
+    /**
+     * The CaseAssist.UpdateField event is emitted when an end-user edits a Coveo Case Assist form field.
+     */
+    export interface UpdateField extends Base {
+        /**
+         * The name of the field that was updated.
+         */
+        fieldName: string;
+        /**
+         * The new value of the field.
+         */
+        fieldValue: string;
+    }
+}