@coveo/relay-event-types 11.0.4 → 12.0.0

package/package.json

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

@@ -65,7 +65,7 @@ export interface ItemView extends Base {
 
 interface Product {
     /**
-     * A unique identifier for the product. The value must match the product id field configured in the catalog.
+     * The unique identifier of the product. The value must match exactly, including case, the values of the link:{site-baseurl}/n73f0502#define-a-unique-product-identifier[product identifier] and `permanentid` fields configured in the catalog.
      */
     productId: string;
     /**
@@ -114,7 +114,7 @@ interface Ticket {
 
 export namespace CaseAssist {
     /**
-     * The caseAssist.cancel event is emitted when a user cancels the Case Assist flow.
+     * The caseassist.cancel event is emitted when a user cancels the Case Assist flow.
      */
     export interface Cancel extends Base {
         /**
@@ -124,14 +124,14 @@ export namespace CaseAssist {
     }
     
     /**
-     * The caseAssist.createTicket event is emitted when a user creates support ticket is created with 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 user clicks on a Case Assist document suggestion.
+     * The caseassist.documentSuggestionClick event is emitted when a user clicks on a Case Assist document suggestion.
      */
     export interface DocumentSuggestionClick extends Base {
         /**
@@ -146,7 +146,7 @@ export namespace CaseAssist {
     }
     
     /**
-     * The caseAssist.documentSuggestionFeedback event is emitted when a user gives feedback on a 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 {
         /**
@@ -161,7 +161,7 @@ export namespace CaseAssist {
     }
     
     /**
-     * The caseAssist.selectFieldClassification event is emitted when a user selects a Case Assist field recommendation.
+     * The caseassist.selectFieldClassification event is emitted when a user selects a Case Assist field recommendation.
      */
     export interface SelectFieldClassification extends Base {
         /**
@@ -179,13 +179,13 @@ export namespace CaseAssist {
     }
     
     /**
-     * The caseAssist.start event is emitted when a user initiates a Case Assist flow.
+     * The caseassist.start event is emitted when a user initiates a Case Assist flow.
      */
     export interface Start extends Base {
     }
     
     /**
-     * The caseAssist.updateField event is emitted when a user edits a Case Assist form field.
+     * The caseassist.updateField event is emitted when a user edits a Case Assist form field.
      */
     export interface UpdateField extends Base {
         /**
@@ -275,7 +275,7 @@ export namespace InsightPanel {
     }
     
     /**
-     * The insightPanel.createArticle event is emitted when the agent creates an article from a support case.
+     * The insightpanel.createarticle event is emitted when the agent creates an article from a support case.
      */
     export interface CreateArticle extends Base {
         /**
@@ -289,7 +289,7 @@ export namespace InsightPanel {
     }
     
     /**
-     * The insightPanel.detachItem event is emitted when the agent detaches an item from a record.
+     * The insightpanel.detachItem event is emitted when the agent detaches an item from a record.
      */
     export interface DetachItem extends Base {
         /**
@@ -300,7 +300,7 @@ export namespace InsightPanel {
     }
     
     /**
-     * The insightPanel.expandToFullUI event is emitted when the agent expands an Insight Panel view to full UI.
+     * The insightpanel.expandtofullui event is emitted when the agent expands an Insight Panel view to full UI.
      */
     export interface ExpandToFullUI extends Base {
         /**
@@ -310,7 +310,7 @@ export namespace InsightPanel {
     }
     
     /**
-     * The insightPanel.itemAction event is emited when the agent interacts with a search item.
+     * The insightpanel.itemaction event is emited when the agent interacts with a search item.
      */
     export interface ItemAction extends BaseItemClick {
         /**