coveo.analytics 2.26.7 → 2.27.2

package/dist/definitions/react-native/react-native-runtime.d.ts

@@ -1,18 +1,18 @@
-import { WebStorage } from '../storage';
-import { AnalyticsFetchClient } from '../client/analyticsFetchClient';
-import { IRuntimeEnvironment } from '../client/runtimeEnvironment';
-import { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
-export declare type ReactNativeStorage = WebStorage;
-export interface ReactNativeRuntimeOptions {
-    storage: ReactNativeStorage;
-    visitorIdKey?: string;
-    token?: string;
-    version?: string;
-    endpoint?: string;
-    preprocessRequest?: PreprocessAnalyticsRequest;
-}
-export declare class ReactNativeRuntime implements IRuntimeEnvironment {
-    client: AnalyticsFetchClient;
-    storage: ReactNativeStorage;
-    constructor(options: ReactNativeRuntimeOptions);
-}
+import { WebStorage } from '../storage';
+import { AnalyticsFetchClient } from '../client/analyticsFetchClient';
+import { IRuntimeEnvironment } from '../client/runtimeEnvironment';
+import { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
+export type ReactNativeStorage = WebStorage;
+export interface ReactNativeRuntimeOptions {
+    storage: ReactNativeStorage;
+    visitorIdKey?: string;
+    token?: string;
+    version?: string;
+    endpoint?: string;
+    preprocessRequest?: PreprocessAnalyticsRequest;
+}
+export declare class ReactNativeRuntime implements IRuntimeEnvironment {
+    client: AnalyticsFetchClient;
+    storage: ReactNativeStorage;
+    constructor(options: ReactNativeRuntimeOptions);
+}

package/dist/definitions/react-native/react-native-utils.d.ts

@@ -1,2 +1,2 @@
-export declare const ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please use the \"coveo.analytics/react-native\" subpackage.\n        Follow the Readme on how to set it up: https://github.com/coveo/coveo.analytics.js#using-react-native\n    ";
-export declare function isReactNative(): boolean;
+export declare const ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please use the \"coveo.analytics/react-native\" subpackage.\n        Follow the Readme on how to set it up: https://github.com/coveo/coveo.analytics.js#using-react-native\n    ";
+export declare function isReactNative(): boolean;

package/dist/definitions/searchPage/searchPageClient.d.ts

@@ -1,188 +1,188 @@
-import { ClientOptions, AnalyticsClient } from '../client/analytics';
-import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } from '../events';
-import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata, SmartSnippetLinkMeta } from './searchPageEvents';
-export interface SearchPageClientProvider {
-    getBaseMetadata: () => Record<string, any>;
-    getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
-    getSearchUID: () => string;
-    getPipeline: () => string;
-    getOriginContext?: () => string;
-    getOriginLevel1: () => string;
-    getOriginLevel2: () => string;
-    getOriginLevel3: () => string;
-    getLanguage: () => string;
-    getIsAnonymous: () => boolean;
-    getFacetState?: () => FacetStateMetadata[];
-    getSplitTestRunName?: () => string | undefined;
-    getSplitTestRunVersion?: () => string | undefined;
-}
-export interface SearchPageClientOptions extends ClientOptions {
-    enableAnalytics: boolean;
-}
-export declare type EventDescription = Pick<SearchEventRequest, 'actionCause' | 'customData'>;
-export interface EventBuilder<T extends AnyEventResponse = AnyEventResponse> {
-    description: EventDescription;
-    log(metadata: {
-        searchUID: string;
-    }): Promise<T | void>;
-}
-export declare class CoveoSearchPageClient {
-    private opts;
-    private provider;
-    coveoAnalyticsClient: AnalyticsClient;
-    constructor(opts: Partial<SearchPageClientOptions>, provider: SearchPageClientProvider);
-    disable(): void;
-    enable(): void;
-    makeInterfaceLoad(): Promise<EventBuilder<SearchEventResponse>>;
-    logInterfaceLoad(): Promise<void | SearchEventResponse>;
-    makeRecommendationInterfaceLoad(): Promise<EventBuilder<SearchEventResponse>>;
-    logRecommendationInterfaceLoad(): Promise<void | SearchEventResponse>;
-    makeRecommendation(): Promise<EventBuilder<CustomEventResponse>>;
-    logRecommendation(): Promise<void | CustomEventResponse>;
-    makeRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
-    logRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
-    makeStaticFilterClearAll(meta: StaticFilterMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logStaticFilterClearAll(meta: StaticFilterMetadata): Promise<void | SearchEventResponse>;
-    makeStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise<void | SearchEventResponse>;
-    makeStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<void | SearchEventResponse>;
-    makeFetchMoreResults(): Promise<EventBuilder<CustomEventResponse>>;
-    logFetchMoreResults(): Promise<void | CustomEventResponse>;
-    makeInterfaceChange(metadata: InterfaceChangeMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logInterfaceChange(metadata: InterfaceChangeMetadata): Promise<void | SearchEventResponse>;
-    makeDidYouMeanAutomatic(): Promise<EventBuilder<SearchEventResponse>>;
-    logDidYouMeanAutomatic(): Promise<void | SearchEventResponse>;
-    makeDidYouMeanClick(): Promise<EventBuilder<SearchEventResponse>>;
-    logDidYouMeanClick(): Promise<void | SearchEventResponse>;
-    makeResultsSort(metadata: ResultsSortMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logResultsSort(metadata: ResultsSortMetadata): Promise<void | SearchEventResponse>;
-    makeSearchboxSubmit(): Promise<EventBuilder<SearchEventResponse>>;
-    logSearchboxSubmit(): Promise<void | SearchEventResponse>;
-    makeSearchboxClear(): Promise<EventBuilder<SearchEventResponse>>;
-    logSearchboxClear(): Promise<void | SearchEventResponse>;
-    makeSearchboxAsYouType(): Promise<EventBuilder<SearchEventResponse>>;
-    logSearchboxAsYouType(): Promise<void | SearchEventResponse>;
-    makeBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<void | SearchEventResponse>;
-    makeBreadcrumbResetAll(): Promise<EventBuilder<SearchEventResponse>>;
-    logBreadcrumbResetAll(): Promise<void | SearchEventResponse>;
-    makeDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
-    logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
-    makeDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
-    logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
-    makeOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise<void | SearchEventResponse>;
-    makeOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise<void | SearchEventResponse>;
-    makeSearchFromLink(): Promise<EventBuilder<SearchEventResponse>>;
-    logSearchFromLink(): Promise<void | SearchEventResponse>;
-    makeTriggerNotify(meta: TriggerNotifyMetadata): Promise<EventBuilder<CustomEventResponse>>;
-    logTriggerNotify(meta: TriggerNotifyMetadata): Promise<void | CustomEventResponse>;
-    makeTriggerExecute(meta: TriggerExecuteMetadata): Promise<EventBuilder<CustomEventResponse>>;
-    logTriggerExecute(meta: TriggerExecuteMetadata): Promise<void | CustomEventResponse>;
-    makeTriggerQuery(): Promise<EventBuilder<CustomEventResponse>>;
-    logTriggerQuery(): Promise<void | CustomEventResponse>;
-    makeUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise<void | SearchEventResponse>;
-    makeTriggerRedirect(meta: TriggerRedirectMetadata): Promise<EventBuilder<CustomEventResponse>>;
-    logTriggerRedirect(meta: TriggerRedirectMetadata): Promise<void | CustomEventResponse>;
-    makePagerResize(meta: PagerResizeMetadata): Promise<EventBuilder<CustomEventResponse>>;
-    logPagerResize(meta: PagerResizeMetadata): Promise<void | CustomEventResponse>;
-    makePagerNumber(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
-    logPagerNumber(meta: PagerMetadata): Promise<void | CustomEventResponse>;
-    makePagerNext(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
-    logPagerNext(meta: PagerMetadata): Promise<void | CustomEventResponse>;
-    makePagerPrevious(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
-    logPagerPrevious(meta: PagerMetadata): Promise<void | CustomEventResponse>;
-    makePagerScrolling(): Promise<EventBuilder<CustomEventResponse>>;
-    logPagerScrolling(): Promise<void | CustomEventResponse>;
-    makeFacetClearAll(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
-    logFacetClearAll(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
-    makeFacetSearch(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
-    logFacetSearch(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
-    makeFacetSelect(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logFacetSelect(meta: FacetMetadata): Promise<void | SearchEventResponse>;
-    makeFacetDeselect(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logFacetDeselect(meta: FacetMetadata): Promise<void | SearchEventResponse>;
-    makeFacetExclude(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logFacetExclude(meta: FacetMetadata): Promise<void | SearchEventResponse>;
-    makeFacetUnexclude(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
-    logFacetUnexclude(meta: FacetMetadata): Promise<void | SearchEventResponse>;
-    makeFacetSelectAll(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
-    logFacetSelectAll(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
-    makeFacetUpdateSort(meta: FacetSortMeta): Promise<EventBuilder<SearchEventResponse>>;
-    logFacetUpdateSort(meta: FacetSortMeta): Promise<void | SearchEventResponse>;
-    makeFacetShowMore(meta: FacetBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
-    logFacetShowMore(meta: FacetBaseMeta): Promise<void | CustomEventResponse>;
-    makeFacetShowLess(meta: FacetBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
-    logFacetShowLess(meta: FacetBaseMeta): Promise<void | CustomEventResponse>;
-    makeQueryError(meta: QueryErrorMeta): Promise<EventBuilder<CustomEventResponse>>;
-    logQueryError(meta: QueryErrorMeta): Promise<void | CustomEventResponse>;
-    makeQueryErrorBack(): Promise<EventBuilder<SearchEventResponse>>;
-    logQueryErrorBack(): Promise<void | SearchEventResponse>;
-    makeQueryErrorRetry(): Promise<EventBuilder<SearchEventResponse>>;
-    logQueryErrorRetry(): Promise<void | SearchEventResponse>;
-    makeQueryErrorClear(): Promise<EventBuilder<SearchEventResponse>>;
-    logQueryErrorClear(): Promise<void | SearchEventResponse>;
-    makeLikeSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
-    logLikeSmartSnippet(): Promise<void | CustomEventResponse>;
-    makeDislikeSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
-    logDislikeSmartSnippet(): Promise<void | CustomEventResponse>;
-    makeExpandSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
-    logExpandSmartSnippet(): Promise<void | CustomEventResponse>;
-    makeCollapseSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
-    logCollapseSmartSnippet(): Promise<void | CustomEventResponse>;
-    makeOpenSmartSnippetFeedbackModal(): Promise<EventBuilder<CustomEventResponse>>;
-    logOpenSmartSnippetFeedbackModal(): Promise<void | CustomEventResponse>;
-    makeCloseSmartSnippetFeedbackModal(): Promise<EventBuilder<CustomEventResponse>>;
-    logCloseSmartSnippetFeedbackModal(): Promise<void | CustomEventResponse>;
-    makeSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<EventBuilder<CustomEventResponse>>;
-    logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<void | CustomEventResponse>;
-    makeExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
-    logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | CustomEventResponse>;
-    makeCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
-    logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | CustomEventResponse>;
-    private makeShowMoreSmartSnippetSuggestion;
-    logShowMoreSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | CustomEventResponse>;
-    private makeShowLessSmartSnippetSuggestion;
-    logShowLessSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | CustomEventResponse>;
-    makeOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
-    logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
-    makeOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<EventBuilder<ClickEventResponse>>;
-    makeCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
-    logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
-    logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<void | ClickEventResponse>;
-    makeOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<EventBuilder<ClickEventResponse>>;
-    logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;
-    makeOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise<EventBuilder<ClickEventResponse>>;
-    logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;
-    makeRecentQueryClick(): Promise<EventBuilder<SearchEventResponse>>;
-    logRecentQueryClick(): Promise<void | SearchEventResponse>;
-    makeClearRecentQueries(): Promise<EventBuilder<CustomEventResponse>>;
-    logClearRecentQueries(): Promise<void | CustomEventResponse>;
-    makeRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
-    logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | CustomEventResponse>;
-    makeClearRecentResults(): Promise<EventBuilder<CustomEventResponse>>;
-    logClearRecentResults(): Promise<void | CustomEventResponse>;
-    makeNoResultsBack(): Promise<EventBuilder<SearchEventResponse>>;
-    logNoResultsBack(): Promise<void | SearchEventResponse>;
-    makeShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
-    logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
-    makeShowLessFoldedResults(): Promise<EventBuilder<CustomEventResponse>>;
-    logShowLessFoldedResults(): Promise<void | CustomEventResponse>;
-    private makeEventDescription;
-    makeCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<EventBuilder<CustomEventResponse>>;
-    logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<void | CustomEventResponse>;
-    makeCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<EventBuilder<CustomEventResponse>>;
-    logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<void | CustomEventResponse>;
-    logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | SearchEventResponse>;
-    makeSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<EventBuilder<SearchEventResponse>>;
-    makeClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<EventBuilder<ClickEventResponse>>;
-    logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | ClickEventResponse>;
-    private getBaseSearchEventRequest;
-    private getBaseEventRequest;
-    private getOrigins;
-    private getClientId;
-    private getSplitTestRun;
-}
+import { ClientOptions, AnalyticsClient } from '../client/analytics';
+import { SearchEventRequest, SearchEventResponse, AnyEventResponse, ClickEventResponse, CustomEventResponse } from '../events';
+import { SearchPageEvents, OmniboxSuggestionsMetadata, FacetMetadata, FacetRangeMetadata, CategoryFacetMetadata, DocumentIdentifier, InterfaceChangeMetadata, ResultsSortMetadata, PartialDocumentInformation, TriggerNotifyMetadata, TriggerExecuteMetadata, TriggerRedirectMetadata, PagerResizeMetadata, PagerMetadata, FacetBaseMeta, FacetSortMeta, QueryErrorMeta, FacetStateMetadata, SmartSnippetFeedbackReason, SmartSnippetSuggestionMeta, SmartSnippetDocumentIdentifier, StaticFilterMetadata, StaticFilterToggleValueMetadata, UndoTriggerRedirectMetadata, SmartSnippetLinkMeta } from './searchPageEvents';
+export interface SearchPageClientProvider {
+    getBaseMetadata: () => Record<string, any>;
+    getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
+    getSearchUID: () => string;
+    getPipeline: () => string;
+    getOriginContext?: () => string;
+    getOriginLevel1: () => string;
+    getOriginLevel2: () => string;
+    getOriginLevel3: () => string;
+    getLanguage: () => string;
+    getIsAnonymous: () => boolean;
+    getFacetState?: () => FacetStateMetadata[];
+    getSplitTestRunName?: () => string | undefined;
+    getSplitTestRunVersion?: () => string | undefined;
+}
+export interface SearchPageClientOptions extends ClientOptions {
+    enableAnalytics: boolean;
+}
+export type EventDescription = Pick<SearchEventRequest, 'actionCause' | 'customData'>;
+export interface EventBuilder<T extends AnyEventResponse = AnyEventResponse> {
+    description: EventDescription;
+    log(metadata: {
+        searchUID: string;
+    }): Promise<T | void>;
+}
+export declare class CoveoSearchPageClient {
+    private opts;
+    private provider;
+    coveoAnalyticsClient: AnalyticsClient;
+    constructor(opts: Partial<SearchPageClientOptions>, provider: SearchPageClientProvider);
+    disable(): void;
+    enable(): void;
+    makeInterfaceLoad(): Promise<EventBuilder<SearchEventResponse>>;
+    logInterfaceLoad(): Promise<void | SearchEventResponse>;
+    makeRecommendationInterfaceLoad(): Promise<EventBuilder<SearchEventResponse>>;
+    logRecommendationInterfaceLoad(): Promise<void | SearchEventResponse>;
+    makeRecommendation(): Promise<EventBuilder<CustomEventResponse>>;
+    logRecommendation(): Promise<void | CustomEventResponse>;
+    makeRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
+    logRecommendationOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
+    makeStaticFilterClearAll(meta: StaticFilterMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logStaticFilterClearAll(meta: StaticFilterMetadata): Promise<void | SearchEventResponse>;
+    makeStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logStaticFilterSelect(meta: StaticFilterToggleValueMetadata): Promise<void | SearchEventResponse>;
+    makeStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logStaticFilterDeselect(meta: StaticFilterToggleValueMetadata): Promise<void | SearchEventResponse>;
+    makeFetchMoreResults(): Promise<EventBuilder<CustomEventResponse>>;
+    logFetchMoreResults(): Promise<void | CustomEventResponse>;
+    makeInterfaceChange(metadata: InterfaceChangeMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logInterfaceChange(metadata: InterfaceChangeMetadata): Promise<void | SearchEventResponse>;
+    makeDidYouMeanAutomatic(): Promise<EventBuilder<SearchEventResponse>>;
+    logDidYouMeanAutomatic(): Promise<void | SearchEventResponse>;
+    makeDidYouMeanClick(): Promise<EventBuilder<SearchEventResponse>>;
+    logDidYouMeanClick(): Promise<void | SearchEventResponse>;
+    makeResultsSort(metadata: ResultsSortMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logResultsSort(metadata: ResultsSortMetadata): Promise<void | SearchEventResponse>;
+    makeSearchboxSubmit(): Promise<EventBuilder<SearchEventResponse>>;
+    logSearchboxSubmit(): Promise<void | SearchEventResponse>;
+    makeSearchboxClear(): Promise<EventBuilder<SearchEventResponse>>;
+    logSearchboxClear(): Promise<void | SearchEventResponse>;
+    makeSearchboxAsYouType(): Promise<EventBuilder<SearchEventResponse>>;
+    logSearchboxAsYouType(): Promise<void | SearchEventResponse>;
+    makeBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logBreadcrumbFacet(metadata: FacetMetadata | FacetRangeMetadata | CategoryFacetMetadata): Promise<void | SearchEventResponse>;
+    makeBreadcrumbResetAll(): Promise<EventBuilder<SearchEventResponse>>;
+    logBreadcrumbResetAll(): Promise<void | SearchEventResponse>;
+    makeDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
+    logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
+    makeDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
+    logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
+    makeOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logOmniboxAnalytics(meta: OmniboxSuggestionsMetadata): Promise<void | SearchEventResponse>;
+    makeOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logOmniboxFromLink(meta: OmniboxSuggestionsMetadata): Promise<void | SearchEventResponse>;
+    makeSearchFromLink(): Promise<EventBuilder<SearchEventResponse>>;
+    logSearchFromLink(): Promise<void | SearchEventResponse>;
+    makeTriggerNotify(meta: TriggerNotifyMetadata): Promise<EventBuilder<CustomEventResponse>>;
+    logTriggerNotify(meta: TriggerNotifyMetadata): Promise<void | CustomEventResponse>;
+    makeTriggerExecute(meta: TriggerExecuteMetadata): Promise<EventBuilder<CustomEventResponse>>;
+    logTriggerExecute(meta: TriggerExecuteMetadata): Promise<void | CustomEventResponse>;
+    makeTriggerQuery(): Promise<EventBuilder<CustomEventResponse>>;
+    logTriggerQuery(): Promise<void | CustomEventResponse>;
+    makeUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logUndoTriggerQuery(meta: UndoTriggerRedirectMetadata): Promise<void | SearchEventResponse>;
+    makeTriggerRedirect(meta: TriggerRedirectMetadata): Promise<EventBuilder<CustomEventResponse>>;
+    logTriggerRedirect(meta: TriggerRedirectMetadata): Promise<void | CustomEventResponse>;
+    makePagerResize(meta: PagerResizeMetadata): Promise<EventBuilder<CustomEventResponse>>;
+    logPagerResize(meta: PagerResizeMetadata): Promise<void | CustomEventResponse>;
+    makePagerNumber(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
+    logPagerNumber(meta: PagerMetadata): Promise<void | CustomEventResponse>;
+    makePagerNext(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
+    logPagerNext(meta: PagerMetadata): Promise<void | CustomEventResponse>;
+    makePagerPrevious(meta: PagerMetadata): Promise<EventBuilder<CustomEventResponse>>;
+    logPagerPrevious(meta: PagerMetadata): Promise<void | CustomEventResponse>;
+    makePagerScrolling(): Promise<EventBuilder<CustomEventResponse>>;
+    logPagerScrolling(): Promise<void | CustomEventResponse>;
+    makeFacetClearAll(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
+    logFacetClearAll(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
+    makeFacetSearch(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
+    logFacetSearch(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
+    makeFacetSelect(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logFacetSelect(meta: FacetMetadata): Promise<void | SearchEventResponse>;
+    makeFacetDeselect(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logFacetDeselect(meta: FacetMetadata): Promise<void | SearchEventResponse>;
+    makeFacetExclude(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logFacetExclude(meta: FacetMetadata): Promise<void | SearchEventResponse>;
+    makeFacetUnexclude(meta: FacetMetadata): Promise<EventBuilder<SearchEventResponse>>;
+    logFacetUnexclude(meta: FacetMetadata): Promise<void | SearchEventResponse>;
+    makeFacetSelectAll(meta: FacetBaseMeta): Promise<EventBuilder<SearchEventResponse>>;
+    logFacetSelectAll(meta: FacetBaseMeta): Promise<void | SearchEventResponse>;
+    makeFacetUpdateSort(meta: FacetSortMeta): Promise<EventBuilder<SearchEventResponse>>;
+    logFacetUpdateSort(meta: FacetSortMeta): Promise<void | SearchEventResponse>;
+    makeFacetShowMore(meta: FacetBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logFacetShowMore(meta: FacetBaseMeta): Promise<void | CustomEventResponse>;
+    makeFacetShowLess(meta: FacetBaseMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logFacetShowLess(meta: FacetBaseMeta): Promise<void | CustomEventResponse>;
+    makeQueryError(meta: QueryErrorMeta): Promise<EventBuilder<CustomEventResponse>>;
+    logQueryError(meta: QueryErrorMeta): Promise<void | CustomEventResponse>;
+    makeQueryErrorBack(): Promise<EventBuilder<SearchEventResponse>>;
+    logQueryErrorBack(): Promise<void | SearchEventResponse>;
+    makeQueryErrorRetry(): Promise<EventBuilder<SearchEventResponse>>;
+    logQueryErrorRetry(): Promise<void | SearchEventResponse>;
+    makeQueryErrorClear(): Promise<EventBuilder<SearchEventResponse>>;
+    logQueryErrorClear(): Promise<void | SearchEventResponse>;
+    makeLikeSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
+    logLikeSmartSnippet(): Promise<void | CustomEventResponse>;
+    makeDislikeSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
+    logDislikeSmartSnippet(): Promise<void | CustomEventResponse>;
+    makeExpandSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
+    logExpandSmartSnippet(): Promise<void | CustomEventResponse>;
+    makeCollapseSmartSnippet(): Promise<EventBuilder<CustomEventResponse>>;
+    logCollapseSmartSnippet(): Promise<void | CustomEventResponse>;
+    makeOpenSmartSnippetFeedbackModal(): Promise<EventBuilder<CustomEventResponse>>;
+    logOpenSmartSnippetFeedbackModal(): Promise<void | CustomEventResponse>;
+    makeCloseSmartSnippetFeedbackModal(): Promise<EventBuilder<CustomEventResponse>>;
+    logCloseSmartSnippetFeedbackModal(): Promise<void | CustomEventResponse>;
+    makeSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<EventBuilder<CustomEventResponse>>;
+    logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string): Promise<void | CustomEventResponse>;
+    makeExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
+    logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | CustomEventResponse>;
+    makeCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
+    logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier): Promise<void | CustomEventResponse>;
+    private makeShowMoreSmartSnippetSuggestion;
+    logShowMoreSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | CustomEventResponse>;
+    private makeShowLessSmartSnippetSuggestion;
+    logShowLessSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | CustomEventResponse>;
+    makeOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
+    logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
+    makeOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<EventBuilder<ClickEventResponse>>;
+    makeCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
+    logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
+    logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<void | ClickEventResponse>;
+    makeOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<EventBuilder<ClickEventResponse>>;
+    logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;
+    makeOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise<EventBuilder<ClickEventResponse>>;
+    logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta): Promise<void | ClickEventResponse>;
+    makeRecentQueryClick(): Promise<EventBuilder<SearchEventResponse>>;
+    logRecentQueryClick(): Promise<void | SearchEventResponse>;
+    makeClearRecentQueries(): Promise<EventBuilder<CustomEventResponse>>;
+    logClearRecentQueries(): Promise<void | CustomEventResponse>;
+    makeRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<CustomEventResponse>>;
+    logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | CustomEventResponse>;
+    makeClearRecentResults(): Promise<EventBuilder<CustomEventResponse>>;
+    logClearRecentResults(): Promise<void | CustomEventResponse>;
+    makeNoResultsBack(): Promise<EventBuilder<SearchEventResponse>>;
+    logNoResultsBack(): Promise<void | SearchEventResponse>;
+    makeShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<EventBuilder<ClickEventResponse>>;
+    logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | ClickEventResponse>;
+    makeShowLessFoldedResults(): Promise<EventBuilder<CustomEventResponse>>;
+    logShowLessFoldedResults(): Promise<void | CustomEventResponse>;
+    private makeEventDescription;
+    makeCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<EventBuilder<CustomEventResponse>>;
+    logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>, eventType?: string): Promise<void | CustomEventResponse>;
+    makeCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<EventBuilder<CustomEventResponse>>;
+    logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<void | CustomEventResponse>;
+    logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | SearchEventResponse>;
+    makeSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<EventBuilder<SearchEventResponse>>;
+    makeClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<EventBuilder<ClickEventResponse>>;
+    logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | ClickEventResponse>;
+    private getBaseSearchEventRequest;
+    private getBaseEventRequest;
+    private getOrigins;
+    private getClientId;
+    private getSplitTestRun;
+}