@coveo/relay-event-types 7.1.6 → 7.3.0

package/package.json

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

@@ -16,61 +16,11 @@ interface Base {
 }
 
 /**
- * The ecCartAction event is emitted when a user adds or removes a product from the cart or changes a product's quantity.
+ * A document suggestion.
  */
-export interface EcCartAction extends Base {
-    /**
-     * Specifies the action. Use "add" to increase quantity and "remove" to decrease it.
-     */
-    action: "add" | "remove";
-    currency: CurrencyCodeISO4217;
-    product: Product;
-    /**
-     * Represents the change in product quantity, not the total quantity. Can be decimal. Must be greater than 0.
-     */
-    quantity: number;
-}
-
-/**
- * The ecProductClick event is emitted when a user clicks a product, be it on a search page, listing page, or recommendation carousel.
- */
-export interface EcProductClick extends Base {
-    /**
-     * Indicates the product's position using a 1-based index. Maximum possible value is 32767.
-     */
-    position: number;
-    /**
-     * Response ID linked to the commerce API request that returned the clicked item.
-     */
-    responseId: UuidNotNull;
-    currency: CurrencyCodeISO4217;
-    product: Product;
-}
-
-/**
- * The ecProductView event is emitted when a user explores a product's details on a Product Detail Page (PDP) or previews the item in a modal from a Product Listing Page (PLP).
- */
-export interface EcProductView extends Base {
-    currency: CurrencyCodeISO4217;
-    product: Product;
-}
-
-/**
- * The ecPurchase event is emitted when the user completes a purchase.
- */
-export interface EcPurchase extends Base {
-    currency: CurrencyCodeISO4217;
-    products: ProductQuantity[];
-    transaction: {
-        /**
-         * The transaction ID. You can use it to cross-reference any orders you've exported from Coveo against records in your own system.
-         */
-        id: string;
-        /**
-         * Total revenue from the transaction, including tax, shipping, and discounts.
-         */
-        revenue: number;
-    };
+interface DocumentSuggestion {
+    id: string;
+    responseId: string;
 }
 
 interface Feedback {
@@ -205,4 +155,166 @@ export interface Search extends Base {
     queryText: string;
     numberOfResults?: number;
     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;
+    }
+}
+
+export namespace Ec {
+    /**
+     * The ec.cartAction event is emitted when a user adds or removes a product from the cart or changes a product's quantity.
+     */
+    export interface CartAction extends Base {
+        /**
+         * Specifies the action. Use "add" to increase quantity and "remove" to decrease it.
+         */
+        action: "add" | "remove";
+        currency: CurrencyCodeISO4217;
+        product: Product;
+        /**
+         * Represents the change in product quantity, not the total quantity. Can be decimal. Must be greater than 0.
+         */
+        quantity: number;
+    }
+    
+    /**
+     * The ec.productClick event is emitted when a user clicks a product, be it on a search page, listing page, or recommendation carousel.
+     */
+    export interface ProductClick extends Base {
+        /**
+         * Indicates the product's position using a 1-based index. Maximum possible value is 32767.
+         */
+        position: number;
+        /**
+         * Response ID linked to the commerce API request that returned the clicked item.
+         */
+        responseId: UuidNotNull;
+        currency: CurrencyCodeISO4217;
+        product: Product;
+    }
+    
+    /**
+     * The ec.productView event is emitted when a user explores a product's details on a Product Detail Page (PDP) or previews the item in a modal from a Product Listing Page (PLP).
+     */
+    export interface ProductView extends Base {
+        currency: CurrencyCodeISO4217;
+        product: Product;
+    }
+    
+    /**
+     * The ec.purchase event is emitted when the user completes a purchase.
+     */
+    export interface Purchase extends Base {
+        currency: CurrencyCodeISO4217;
+        products: ProductQuantity[];
+        transaction: {
+            /**
+             * The transaction ID. You can use it to cross-reference any orders you've exported from Coveo against records in your own system.
+             */
+            id: string;
+            /**
+             * Total revenue from the transaction, including tax, shipping, and discounts.
+             */
+            revenue: number;
+        };
+    }
 }