@coveo/usage-analytics-event-types 14.1.0 → 14.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/usage-analytics-event-types.d.ts +2 -2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/usage-analytics-event-types",
3
- "version": "14.1.0",
3
+ "version": "14.3.0",
4
4
  "description": "Typescript types for Coveo Usage Analytics Events",
5
5
  "types": "./usage-analytics-event-types.d.ts",
6
6
  "author": "Coveo",
package/usage-analytics-event-types.d.ts CHANGED
@@ -99,7 +99,7 @@ interface SearchResult {
99
99
  * UA analytics click request
100
100
  */
101
101
  export interface UsageAnalyticsClick {
102
- 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" | "generatedAnswerCitationClick";
102
+ 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" | "generatedAnswerCitationClick" | "documentSuggestionClick" | "documentSuggestionQuickview";
103
103
  /**
104
104
  * 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.
105
105
  */
@@ -568,7 +568,7 @@ export interface UsageAnalyticsCustom {
568
568
  * UA analytics search request
569
569
  */
570
570
  export interface UsageAnalyticsSearch {
571
- 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" | "retryGeneratedAnswer" | "rephraseGeneratedAnswer";
571
+ 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" | "retryGeneratedAnswer" | "rephraseGeneratedAnswer" | "documentSuggestion";
572
572
  /**
573
573
  * The content language. Prefix must be a valid ISO 639-1 code.
574
574
  */