@coveo/usage-analytics-event-types 6.24.2 → 6.25.0

package/README.md

@@ -0,0 +1,22 @@
+# Coveo Usage Analytics Event Types
+
+This package contains automatically generated TypeScript types for Coveo [Usage Analytics Events](https://docs.coveo.com/en/1373/build-a-search-ui/log-usage-analytics-events), and is intended to be used in combination with [coveo.analytics.js](https://github.com/coveo/coveo.analytics.js) or other integrations which communicate with the usage analytics service.
+
+## Installation
+
+Install using `npm install @coveo/usage-analytics-event-types`
+
+## Usage
+
+Import desired event type, e.g. for an `UsageAnalyticsCustom` event:
+
+```
+import {UsageAnalyticsCustom} from '@coveo/usage-analytics-event-types';
+
+const myCustomEvent:UsageAnalyticsCustom = {
+    eventType: 'clickButton',
+    eventValue: 'back',
+    clientId: '2ce196c1-5859-42da-b051-63e77ae2b406',
+    language: 'en-us'
+}
+```

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@coveo/usage-analytics-event-types",
-  "version": "6.24.2",
+  "version": "6.25.0",
   "description": "Typescript types for Coveo Usage Analytics Events",
-  "types": "./usage-analytics-types.d.ts",
+  "types": "./usage-analytics-event-types.d.ts",
   "author": "Coveo",
   "license": "Apache-2.0",
   "keywords": [

package/{usage-analytics-types.d.ts → usage-analytics-event-types.d.ts}

@@ -101,7 +101,7 @@ interface SearchResult {
 export interface UsageAnalyticsClick {
     actionCause: "interfaceLoad" | "interfaceChange" | "contextRemove" | "didyoumeanAutomatic" | "didyoumeanClick" | "resultsSort" | "searchboxSubmit" | "searchboxClear" | "searchboxAsYouType" | "breadcrumbFacet" | "breadcrumbAdvancedSearch" | "breadcrumbResetAll" | "documentTag" | "documentField" | "documentQuickview" | "documentOpen" | "omniboxFacetSelect" | "omniboxFacetExclude" | "omniboxFacetDeselect" | "omniboxFacetUnexclude" | "omniboxAnalytics" | "omniboxFromLink" | "omniboxField" | "facetClearAll" | "facetSearch" | "facetToggle" | "facetRangeSlider" | "facetRangeGraph" | "facetSelect" | "facetSelectAll" | "facetDeselect" | "facetExclude" | "facetUnexclude" | "facetUpdateSort" | "showMoreFacetResults" | "showLessFacetResults" | "categoryFacetSelect" | "categoryFacetReload" | "categoryFacetClear" | "categoryFacetBreadcrumb" | "categoryFacetSearch" | "errorBack" | "errorClearQuery" | "errorRetry" | "noResultsBack" | "expandToFullUI" | "inputChange" | "submitButton" | "cancelButton" | "unloadPage" | "casecontextAdd" | "casecontextRemove" | "contextChanged" | "preferencesChange" | "getUserHistory" | "userActionDocumentClick" | "caseAttach" | "caseDetach" | "customfiltersChange" | "pagerNumber" | "pagerNext" | "pagerPrevious" | "pagerScrolling" | "pagerResize" | "positionSet" | "searchFromLink" | "notify" | "execute" | "query" | "redirect" | "exportToExcel" | "recommendation" | "recommendationInterfaceLoad" | "recommendationOpen" | "advancedSearch" | "followDocument" | "followQuery" | "updateSubscription" | "deleteSubscription" | "unfollowDocument" | "unfollowQuery" | "selectValue" | "deselectValue" | "clearAll" | "changeResultsLayout" | "showMoreFoldedResults" | "showLessFoldedResults" | "addMissingTerm" | "removeMissingTerm" | "showQuerySuggestPreview" | "clickQuerySuggestPreview" | "likeSmartSnippet" | "dislikeSmartSnippet" | "expandSmartSnippet" | "collapseSmartSnippet" | "openSmartSnippetFeedbackModal" | "closeSmartSnippetFeedbackModal" | "sendSmartSnippetReason" | "openSmartSnippetSource" | "expandSmartSnippetSuggestion" | "collapseSmartSnippetSuggestion" | "openSmartSnippetSuggestionSource" | "staticFilterClearAll" | "staticFilterSelect" | "staticFilterDeselect" | "recentQueriesClick" | "clearRecentQueries" | "recentResultClick" | "clearRecentResults" | "copyToClipboard" | "topQueriesClick" | "userActionLoad" | "userActionsSubmit" | "openUserActions" | "historyBackward" | "enterOnSearchbox" | "quickviewLoaded" | "openQuickview" | "sendAsEmail" | "postToFeed" | "sendToLiveAgent" | "attachToCaseStateChanged" | "attachedResultsLoad" | "CaseInputChange" | "attachedResultsChange" | "openSmartSnippetInlineLink" | "openSmartSnippetSuggestionInlineLink" | "Case.SendEmail" | "FeedItem.TextPost";
     /**
-     * The 1-based index position of the item that was clicked in the result list. This number must take into consideration pagination settings. If the pages contain ten results each, the third item of the second page is at the position 23.
+     * The 1-based index position of the item that was clicked in the result list. This number must take into consideration pagination settings. If the pages contain ten results each, the third item of the second page is at the position 23. Can be no larger than 32767.
      */
     documentPosition: number;
     /**