@coveo/relay-event-types 7.8.1 → 7.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay-event-types",
-  "version": "7.8.1",
+  "version": "7.9.1",
   "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

@@ -125,19 +125,6 @@ interface QnaCitation {
     id: string;
 }
 
-/**
- * Represents the Coveo Analytics Search Event. Send this schema exclusively when conducting A/B tests against a competitor's search solution.
- */
-export interface Search extends Base {
-    /**
-     * A unique identifier identifying the query made to a search system.
-     */
-    searchUid: string;
-    queryText: string;
-    numberOfResults?: number;
-    responseTimeInMs?: number;
-}
-
 /**
  * A support ticket.
  */
@@ -166,12 +153,12 @@ interface Ticket {
 
 export namespace CaseAssist {
     /**
-     * The CaseAssist.Start event is emitted when Coveo Case Assist support ticket creation flow is initiated.
+     * The caseAssist.start event is emitted when a user initiates a Case Assist flow.
      */
     export type Start = Base;
     
     /**
-     * The CaseAssist.Cancel event is emitted when Coveo Case Assist support ticket creation flow is canceled by the user.
+     * The caseAssist.cancel event is emitted when a user cancels the Case Assist flow.
      */
     export interface Cancel extends Base {
         /**
@@ -181,21 +168,21 @@ export namespace CaseAssist {
     }
     
     /**
-     * The CaseAssist.CreateTicket event is emitted when a support ticket is created in Coveo Case Assist.
+     * The caseAssist.createTicket event is emitted when a user creates support ticket is created with Case Assist.
      */
     export interface CreateTicket extends Base {
         ticket: Ticket;
     }
     
     /**
-     * The CaseAssist.DocumentSuggestionClick event is emitted when a Coveo Case Assist document suggestion is clicked.
+     * The caseAssist.documentSuggestionClick event is emitted when a user clicks on a Case Assist document suggestion.
      */
     export interface DocumentSuggestionClick extends Base {
         documentSuggestion: DocumentSuggestion;
     }
     
     /**
-     * The CaseAssist.DocumentSuggestionFeedback event is emitted when feedback is given on a Coveo Case Assist document suggestion.
+     * The caseAssist.documentSuggestionFeedback event is emitted when a user gives feedback on a Case Assist document suggestion.
      */
     export interface DocumentSuggestionFeedback extends Base {
         documentSuggestion: DocumentSuggestion;
@@ -206,7 +193,7 @@ export namespace CaseAssist {
     }
     
     /**
-     * The CaseAssist.selectFieldClassification event is emitted when a support ticket field recommendation is selected in Coveo Case Assist.
+     * The caseAssist.selectFieldClassification event is emitted when a user selects a Case Assist field recommendation.
      */
     export interface SelectFieldClassification extends Base {
         fieldClassification: {
@@ -226,7 +213,7 @@ export namespace CaseAssist {
     }
     
     /**
-     * The CaseAssist.UpdateField event is emitted when an end-user edits a Coveo Case Assist form field.
+     * The caseAssist.updateField event is emitted when a user edits a Case Assist form field.
      */
     export interface UpdateField extends Base {
         /**
@@ -282,7 +269,7 @@ export namespace Ec {
     }
     
     /**
-     * The ec.purchase event is emitted when the user completes a purchase.
+     * The ec.purchase event is emitted when a user completes a purchase.
      */
     export interface Purchase extends Base {
         currency: CurrencyCodeISO4217;
@@ -302,7 +289,7 @@ export namespace Ec {
 
 export namespace InsightPanel {
     /**
-     * The context in which the insight panel is used. Generally, this will be a support case.
+     * The context in which Insight Panel is used. Generally, this will be a support case.
      */
     interface Context {
         /**
@@ -316,11 +303,11 @@ export namespace InsightPanel {
     }
     
     /**
-     * Insight Panel event signaling that the agent created an article from a case.
+     * The insightPanel.createArticle event is emitted when the agent creates an article from a support case.
      */
     export interface CreateArticle extends Base {
         /**
-         * The context in which the insight panel is used.
+         * The context in which Insight Panel is used.
          */
         context: Context;
         /**
@@ -330,28 +317,28 @@ export namespace InsightPanel {
     }
     
     /**
-     * Insight Panel event signaling that an item was detached from a record
+     * The insightPanel.detachItem event is emitted when the agent detaches an item from a record.
      */
     export interface DetachItem extends Base {
         /**
-         * The context in which the insight panel is used.
+         * The context in which Insight Panel is used.
          */
         context: Context;
         itemMetadata: ItemMetaData;
     }
     
     /**
-     * Insight Panel event signaling that the agent expanded the panel.
+     * The insightPanel.expandToFullUI event is emitted when the agent expands an Insight Panel view to full UI.
      */
     export interface ExpandToFullUI extends Base {
         /**
-         * The context in which the insight panel is used.
+         * The context in which Insight Panel is used.
          */
         context: Context;
     }
     
     /**
-     * Interaction on a search item inside an insight panel.
+     * The insightPanel.itemAction event is emited when the agent interacts with a search item.
      */
     export interface ItemAction extends BaseItemClick {
         /**
@@ -359,7 +346,7 @@ export namespace InsightPanel {
          */
         action: "attach" | "open" | "copyToClipboard" | "sendEmail" | "postToFeed";
         /**
-         * The context in which the insight panel is used.
+         * The context in which Insight Panel is used.
          */
         context: Context;
         /**