@wix/analytics-session 1.0.19 → 1.0.21

package/type-bundles/context.bundle.d.ts

@@ -1,852 +0,0 @@
-type HostModule<T, H extends Host> = {
-    __type: 'host';
-    create(host: H): T;
-};
-type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
-type Host<Environment = unknown> = {
-    channel: {
-        observeState(callback: (props: unknown, environment: Environment) => unknown): {
-            disconnect: () => void;
-        } | Promise<{
-            disconnect: () => void;
-        }>;
-    };
-    environment?: Environment;
-    /**
-     * Optional name of the environment, use for logging
-     */
-    name?: string;
-    /**
-     * Optional bast url to use for API requests, for example `www.wixapis.com`
-     */
-    apiBaseUrl?: string;
-    /**
-     * Possible data to be provided by every host, for cross cutting concerns
-     * like internationalization, billing, etc.
-     */
-    essentials?: {
-        /**
-         * The language of the currently viewed session
-         */
-        language?: string;
-        /**
-         * The locale of the currently viewed session
-         */
-        locale?: string;
-        /**
-         * Any headers that should be passed through to the API requests
-         */
-        passThroughHeaders?: Record<string, string>;
-    };
-};
-
-type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
-interface HttpClient {
-    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
-    fetchWithAuth: typeof fetch;
-    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
-    getActiveToken?: () => string | undefined;
-}
-type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
-type HttpResponse<T = any> = {
-    data: T;
-    status: number;
-    statusText: string;
-    headers: any;
-    request?: any;
-};
-type RequestOptions<_TResponse = any, Data = any> = {
-    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
-    url: string;
-    data?: Data;
-    params?: URLSearchParams;
-} & APIMetadata;
-type APIMetadata = {
-    methodFqn?: string;
-    entityFqdn?: string;
-    packageName?: string;
-};
-type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
-type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
-type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
-
-type ServicePluginMethodInput = {
-    request: any;
-    metadata: any;
-};
-type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
-type ServicePluginMethodMetadata = {
-    name: string;
-    primaryHttpMappingPath: string;
-    transformations: {
-        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
-        toREST: (...args: unknown[]) => unknown;
-    };
-};
-type ServicePluginDefinition<Contract extends ServicePluginContract> = {
-    __type: 'service-plugin-definition';
-    componentType: string;
-    methods: ServicePluginMethodMetadata[];
-    __contract: Contract;
-};
-declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
-type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
-declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
-
-type RequestContext = {
-    isSSR: boolean;
-    host: string;
-    protocol?: string;
-};
-type ResponseTransformer = (data: any, headers?: any) => any;
-/**
- * Ambassador request options types are copied mostly from AxiosRequestConfig.
- * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
- * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
- */
-type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
-type AmbassadorRequestOptions<T = any> = {
-    _?: T;
-    url?: string;
-    method?: Method;
-    params?: any;
-    data?: any;
-    transformResponse?: ResponseTransformer | ResponseTransformer[];
-};
-type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
-    __isAmbassador: boolean;
-};
-type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
-type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
-}
-
-declare const emptyObjectSymbol: unique symbol;
-
-/**
-Represents a strictly empty plain object, the `{}` value.
-
-When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
-
-@example
-```
-import type {EmptyObject} from 'type-fest';
-
-// The following illustrates the problem with `{}`.
-const foo1: {} = {}; // Pass
-const foo2: {} = []; // Pass
-const foo3: {} = 42; // Pass
-const foo4: {} = {a: 1}; // Pass
-
-// With `EmptyObject` only the first case is valid.
-const bar1: EmptyObject = {}; // Pass
-const bar2: EmptyObject = 42; // Fail
-const bar3: EmptyObject = []; // Fail
-const bar4: EmptyObject = {a: 1}; // Fail
-```
-
-Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
-
-@category Object
-*/
-type EmptyObject = {[emptyObjectSymbol]?: never};
-
-/**
-Returns a boolean for whether the two given types are equal.
-
-@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
-@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
-
-Use-cases:
-- If you want to make a conditional branch based on the result of a comparison of two types.
-
-@example
-```
-import type {IsEqual} from 'type-fest';
-
-// This type returns a boolean for whether the given array includes the given item.
-// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
-type Includes<Value extends readonly any[], Item> =
-	Value extends readonly [Value[0], ...infer rest]
-		? IsEqual<Value[0], Item> extends true
-			? true
-			: Includes<rest, Item>
-		: false;
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IsEqual<A, B> =
-	(<G>() => G extends A ? 1 : 2) extends
-	(<G>() => G extends B ? 1 : 2)
-		? true
-		: false;
-
-/**
-Filter out keys from an object.
-
-Returns `never` if `Exclude` is strictly equal to `Key`.
-Returns `never` if `Key` extends `Exclude`.
-Returns `Key` otherwise.
-
-@example
-```
-type Filtered = Filter<'foo', 'foo'>;
-//=> never
-```
-
-@example
-```
-type Filtered = Filter<'bar', string>;
-//=> never
-```
-
-@example
-```
-type Filtered = Filter<'bar', 'foo'>;
-//=> 'bar'
-```
-
-@see {Except}
-*/
-type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
-
-type ExceptOptions = {
-	/**
-	Disallow assigning non-specified properties.
-
-	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
-
-	@default false
-	*/
-	requireExactProps?: boolean;
-};
-
-/**
-Create a type from an object type without certain keys.
-
-We recommend setting the `requireExactProps` option to `true`.
-
-This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
-
-This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
-
-@example
-```
-import type {Except} from 'type-fest';
-
-type Foo = {
-	a: number;
-	b: string;
-};
-
-type FooWithoutA = Except<Foo, 'a'>;
-//=> {b: string}
-
-const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
-//=> errors: 'a' does not exist in type '{ b: string; }'
-
-type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
-//=> {a: number} & Partial<Record<"b", never>>
-
-const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
-//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
-```
-
-@category Object
-*/
-type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
-	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
-} & (Options['requireExactProps'] extends true
-	? Partial<Record<KeysType, never>>
-	: {});
-
-/**
-Returns a boolean for whether the given type is `never`.
-
-@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
-@link https://stackoverflow.com/a/53984913/10292952
-@link https://www.zhenghao.io/posts/ts-never
-
-Useful in type utilities, such as checking if something does not occur.
-
-@example
-```
-import type {IsNever, And} from 'type-fest';
-
-// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
-type AreStringsEqual<A extends string, B extends string> =
-	And<
-		IsNever<Exclude<A, B>> extends true ? true : false,
-		IsNever<Exclude<B, A>> extends true ? true : false
-	>;
-
-type EndIfEqual<I extends string, O extends string> =
-	AreStringsEqual<I, O> extends true
-		? never
-		: void;
-
-function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
-	if (input === output) {
-		process.exit(0);
-	}
-}
-
-endIfEqual('abc', 'abc');
-//=> never
-
-endIfEqual('abc', '123');
-//=> void
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IsNever<T> = [T] extends [never] ? true : false;
-
-/**
-An if-else-like type that resolves depending on whether the given type is `never`.
-
-@see {@link IsNever}
-
-@example
-```
-import type {IfNever} from 'type-fest';
-
-type ShouldBeTrue = IfNever<never>;
-//=> true
-
-type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
-//=> 'bar'
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
-	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
-);
-
-/**
-Extract the keys from a type where the value type of the key extends the given `Condition`.
-
-Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
-
-@example
-```
-import type {ConditionalKeys} from 'type-fest';
-
-interface Example {
-	a: string;
-	b: string | number;
-	c?: string;
-	d: {};
-}
-
-type StringKeysOnly = ConditionalKeys<Example, string>;
-//=> 'a'
-```
-
-To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
-
-@example
-```
-import type {ConditionalKeys} from 'type-fest';
-
-type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
-//=> 'a' | 'c'
-```
-
-@category Object
-*/
-type ConditionalKeys<Base, Condition> =
-{
-	// Map through all the keys of the given base type.
-	[Key in keyof Base]-?:
-	// Pick only keys with types extending the given `Condition` type.
-	Base[Key] extends Condition
-	// Retain this key
-	// If the value for the key extends never, only include it if `Condition` also extends never
-		? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
-	// Discard this key since the condition fails.
-		: never;
-	// Convert the produced object into a union type of the keys which passed the conditional test.
-}[keyof Base];
-
-/**
-Exclude keys from a shape that matches the given `Condition`.
-
-This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
-
-@example
-```
-import type {Primitive, ConditionalExcept} from 'type-fest';
-
-class Awesome {
-	name: string;
-	successes: number;
-	failures: bigint;
-
-	run() {}
-}
-
-type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
-//=> {run: () => void}
-```
-
-@example
-```
-import type {ConditionalExcept} from 'type-fest';
-
-interface Example {
-	a: string;
-	b: string | number;
-	c: () => void;
-	d: {};
-}
-
-type NonStringKeysOnly = ConditionalExcept<Example, string>;
-//=> {b: string | number; c: () => void; d: {}}
-```
-
-@category Object
-*/
-type ConditionalExcept<Base, Condition> = Except<
-Base,
-ConditionalKeys<Base, Condition>
->;
-
-/**
- * Descriptors are objects that describe the API of a module, and the module
- * can either be a REST module or a host module.
- * This type is recursive, so it can describe nested modules.
- */
-type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
-    [key: string]: Descriptors | PublicMetadata | any;
-};
-/**
- * This type takes in a descriptors object of a certain Host (including an `unknown` host)
- * and returns an object with the same structure, but with all descriptors replaced with their API.
- * Any non-descriptor properties are removed from the returned object, including descriptors that
- * do not match the given host (as they will not work with the given host).
- */
-type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
-    done: T;
-    recurse: T extends {
-        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
-    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
-        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
-            -1,
-            0,
-            1,
-            2,
-            3,
-            4,
-            5
-        ][Depth]> : never;
-    }, EmptyObject>;
-}[Depth extends -1 ? 'done' : 'recurse'];
-type PublicMetadata = {
-    PACKAGE_NAME?: string;
-};
-
-declare global {
-    interface ContextualClient {
-    }
-}
-/**
- * A type used to create concerete types from SDK descriptors in
- * case a contextual client is available.
- */
-type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
-    host: Host;
-} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
-
-interface Session {
-    /** Session ID. */
-    _id?: string;
-}
-/** List sessions async request. */
-interface ListSessionsAsyncRequest extends ListSessionsAsyncRequestPeriodOneOf, ListSessionsAsyncRequestParamsOneOf {
-    /** Custom time period with start & end dates. */
-    customTimePeriod?: CustomTimePeriod;
-    /** Predefined time period. */
-    predefinedTimePeriod?: PredefinedTimePeriod;
-    /** Navigation flow details. */
-    navigationFlow?: NavigationFlowSessionsParams;
-    /** Conversion funnel details. The steps in the journey the visitor has taken on the site. */
-    conversionFunnel?: ConversionFunnelSessionsParams;
-    /** Device type. */
-    deviceType?: SessionsByDeviceParams;
-    /** User's timezone. Defaults to timezone as set in the [Site Properties API](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object). */
-    timezone?: string | null;
-}
-/** @oneof */
-interface ListSessionsAsyncRequestPeriodOneOf {
-    /** Custom time period with start & end dates. */
-    customTimePeriod?: CustomTimePeriod;
-    /** Predefined time period. */
-    predefinedTimePeriod?: PredefinedTimePeriod;
-}
-/** @oneof */
-interface ListSessionsAsyncRequestParamsOneOf {
-    /** Navigation flow details. */
-    navigationFlow?: NavigationFlowSessionsParams;
-    /** Conversion funnel details. The steps in the journey the visitor has taken on the site. */
-    conversionFunnel?: ConversionFunnelSessionsParams;
-    /** Device type. */
-    deviceType?: SessionsByDeviceParams;
-}
-/** Custom time period. */
-interface CustomTimePeriod {
-    /** Custom period start date in provided timezone. */
-    startDate?: string;
-    /**
-     * Custom period end date in provided timezone. Returned data will include all dates until the requested end date.
-     * For example, { startDate: '2024-01-01', endDate: '2024-01-03' } will return data for '2024-01-01' and '2024-01-02'
-     */
-    endDate?: string;
-}
-/**
- * Predefined time period.
- * `THIS_WEEK`begins with Monday.
- */
-declare enum PredefinedTimePeriod {
-    /** Today. */
-    TODAY = "TODAY",
-    /** Yesterday. */
-    YESTERDAY = "YESTERDAY",
-    /** Last 7 days. */
-    LAST_7_DAYS = "LAST_7_DAYS",
-    /** Last 14 days. */
-    LAST_14_DAYS = "LAST_14_DAYS",
-    /** Last 30 days. */
-    LAST_30_DAYS = "LAST_30_DAYS",
-    /** Last 90 days. */
-    LAST_90_DAYS = "LAST_90_DAYS",
-    /** Last 28 days. */
-    LAST_28_DAYS = "LAST_28_DAYS",
-    /** Last 180 days. */
-    LAST_180_DAYS = "LAST_180_DAYS",
-    /** Last 365 days. */
-    LAST_365_DAYS = "LAST_365_DAYS",
-    /** Current week, starting on Monday. */
-    THIS_WEEK = "THIS_WEEK",
-    /** Current month. */
-    THIS_MONTH = "THIS_MONTH",
-    /** Current quarter. */
-    THIS_QUARTER = "THIS_QUARTER",
-    /** This year. */
-    THIS_YEAR = "THIS_YEAR",
-    /** Last week (previous week). */
-    LAST_WEEK = "LAST_WEEK",
-    /** Last month. */
-    LAST_MONTH = "LAST_MONTH",
-    /** Last quarter. */
-    LAST_QUARTER = "LAST_QUARTER",
-    /** Last year. */
-    LAST_YEAR = "LAST_YEAR",
-    /** Last 12 months. */
-    LAST_12_MONTHS = "LAST_12_MONTHS"
-}
-/** Navigation flow details. */
-interface NavigationFlowSessionsParams {
-    /**
-     * Page interactions, including where the user dropped off. For example:
-     * - ["/{Homepage}", "__DROP__"]: Sessions where a user visited the site's homepage and then dropped off.
-     * - ["", "__DROP__"]: Sessions where a user visited (any page) and then dropped off.
-     * - ["", "", "__DROP__"]: Session where a user visited any page, then navigated to any page, and then dropped off.
-     */
-    pageInteractions?: string[] | null;
-}
-/** Conversion funnel details, meaning the steps in the journey the visitor has taken on the site. */
-interface ConversionFunnelSessionsParams {
-    /** Funnel step to include. */
-    include?: FunnelStep;
-    /** Funnel step to exclude. */
-    exclude?: FunnelStep;
-}
-/** Funnel step. */
-declare enum FunnelStep {
-    /** Not selected. */
-    NOT_SELECTED_FUNNEL_STEP = "NOT_SELECTED_FUNNEL_STEP",
-    /** Site sessions. */
-    SITE_SESSIONS = "SITE_SESSIONS",
-    /** Viewed product. */
-    VIEWED_PRODUCT = "VIEWED_PRODUCT",
-    /** Added to cart. */
-    ADDED_TO_CART = "ADDED_TO_CART",
-    /** Reached checkout. */
-    REACHED_CHECKOUT = "REACHED_CHECKOUT",
-    /** Sessions converted. */
-    SESSIONS_CONVERTED = "SESSIONS_CONVERTED"
-}
-/** Device details. */
-interface SessionsByDeviceParams {
-    /** Device type. */
-    type?: DeviceType;
-}
-/** Device type. */
-declare enum DeviceType {
-    /** Not selected. */
-    NOT_SELECTED_DEVICE_TYPE = "NOT_SELECTED_DEVICE_TYPE",
-    /** Desktop. */
-    DESKTOP = "DESKTOP",
-    /** Mobile. */
-    MOBILE = "MOBILE",
-    /** Tablet. */
-    TABLET = "TABLET",
-    /** All. */
-    ALL = "ALL"
-}
-/** List sessions async response. */
-interface ListSessionsAsyncResponse {
-    /**
-     * List sessions job ID.
-     * Pass this ID to Get List Sessions Job Result to retrieve job details and metadata.
-     */
-    jobId?: string;
-}
-/** Get list sessions job result request. */
-interface GetListSessionsJobResultRequest {
-    /** List sessions job ID. */
-    jobId: string;
-    /** Number of items to load. */
-    limit: number;
-    /** Number of items to skip in the current sort order. */
-    offset: number;
-}
-/** Get list sessions job result response. */
-interface GetListSessionsJobResultResponse {
-    /** List sessions job result data. */
-    result?: JobResult;
-}
-/** List sessions job result. */
-interface JobResult {
-    /** Job status. */
-    jobStatus?: JobStatus;
-    /** Total number of sessions. */
-    total?: number | null;
-    /** Session IDs. */
-    sessionIds?: string[];
-}
-/** Job status. */
-declare enum JobStatus {
-    /** Unknown. */
-    UNKNOWN_JOB_STATUS = "UNKNOWN_JOB_STATUS",
-    /** In progress. */
-    IN_PROGRESS = "IN_PROGRESS",
-    /** Finished. */
-    FINISHED = "FINISHED",
-    /** Error. */
-    ERROR = "ERROR"
-}
-/** Request for getting store conversion sessions. */
-interface CountFunnelSessionsRequest extends CountFunnelSessionsRequestPeriodOneOf {
-    /** Custom time period with start & end dates. */
-    customTimePeriod?: CustomTimePeriod;
-    /** Predefined time period. */
-    predefinedTimePeriod?: PredefinedTimePeriod;
-    /** User timezone. If not provided it will be taken from site properties. */
-    timezone?: string | null;
-}
-/** @oneof */
-interface CountFunnelSessionsRequestPeriodOneOf {
-    /** Custom time period with start & end dates. */
-    customTimePeriod?: CustomTimePeriod;
-    /** Predefined time period. */
-    predefinedTimePeriod?: PredefinedTimePeriod;
-}
-/** Response for getting store conversion sessions. */
-interface CountFunnelSessionsResponse {
-    /** Recordings. */
-    recordings?: Recordings;
-}
-/** Recordings. */
-interface Recordings {
-    /** Saved Session count. */
-    siteSessions?: number | null;
-    /** Saved Sessions with Product Views */
-    productViewSessions?: number | null;
-    /** Saved Sessions with Cart Views */
-    cartViewSessions?: number | null;
-    /** Saved Sessions with Checkouts */
-    checkoutSessions?: number | null;
-    /** Saved Converted Sessions */
-    convertedSessions?: number | null;
-}
-/** Request for getting the total number of sessions. */
-interface CountSessionsRequest extends CountSessionsRequestPeriodOneOf {
-    /** Custom time period with start & end dates. */
-    customTimePeriod?: CustomTimePeriod;
-    /** Predefined time period. */
-    predefinedTimePeriod?: PredefinedTimePeriod;
-    /** User timezone. If not provided it will be taken from site properties. */
-    timezone?: string | null;
-}
-/** @oneof */
-interface CountSessionsRequestPeriodOneOf {
-    /** Custom time period with start & end dates. */
-    customTimePeriod?: CustomTimePeriod;
-    /** Predefined time period. */
-    predefinedTimePeriod?: PredefinedTimePeriod;
-}
-/** Response for getting the total number of sessions. */
-interface CountSessionsResponse {
-    /** Total number of sessions. */
-    sessions?: number;
-}
-/** Mark a browser session as recorded. */
-interface MarkSessionAsRecordedRequest {
-    /** Browser session ID. */
-    sessionId: string;
-}
-/** Mark a browser session as recorded. */
-interface MarkSessionAsRecordedResponse {
-}
-/** Marks browser session recordings as deleted. */
-interface MarkRecordingsAsDeletedRequest {
-    /** Browser session IDs. */
-    sessionIds: string[];
-}
-/** Marks browser session recordings as deleted. */
-interface MarkRecordingsAsDeletedResponse {
-}
-interface ListSessionsAsyncResponseNonNullableFields {
-    jobId: string;
-}
-interface JobResultNonNullableFields {
-    jobStatus: JobStatus;
-    sessionIds: string[];
-}
-interface GetListSessionsJobResultResponseNonNullableFields {
-    result?: JobResultNonNullableFields;
-}
-interface ListSessionsAsyncOptions extends ListSessionsAsyncRequestPeriodOneOf, ListSessionsAsyncRequestParamsOneOf {
-    /** Custom time period with start & end dates. */
-    customTimePeriod?: CustomTimePeriod;
-    /** Predefined time period. */
-    predefinedTimePeriod?: PredefinedTimePeriod;
-    /** User's timezone. Defaults to timezone as set in the [Site Properties API](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object). */
-    timezone?: string | null;
-    /** Navigation flow details. */
-    navigationFlow?: NavigationFlowSessionsParams;
-    /** Conversion funnel details. The steps in the journey the visitor has taken on the site. */
-    conversionFunnel?: ConversionFunnelSessionsParams;
-    /** Device type. */
-    deviceType?: SessionsByDeviceParams;
-}
-interface GetListSessionsJobResultOptions {
-    /** Number of items to load. */
-    limit: number;
-    /** Number of items to skip in the current sort order. */
-    offset: number;
-}
-
-declare function listSessionsAsync$1(httpClient: HttpClient): ListSessionsAsyncSignature;
-interface ListSessionsAsyncSignature {
-    /**
-     * Start an async job to retrieve a list of session IDs, given the specified filters. The following filters **must** be passed:
-     * - Time period, either predefined or custom.
-     * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.
-     * @param - Filter options. The following filters **must** be passed:
-     *
-     * - Time period, either predefined or custom.
-     *
-     * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.
-     * @returns List sessions async response.
-     */
-    (options?: ListSessionsAsyncOptions | undefined): Promise<ListSessionsAsyncResponse & ListSessionsAsyncResponseNonNullableFields>;
-}
-declare function getListSessionsJobResult$1(httpClient: HttpClient): GetListSessionsJobResultSignature;
-interface GetListSessionsJobResultSignature {
-    /**
-     * Retrieves the job status and a list of session IDs, if ready.
-     * @param - List sessions job ID.
-     * @param - Field options. The `limit` and `offset` filters **must** be passed.
-     * @returns Get list sessions job result response.
-     */
-    (jobId: string, options: GetListSessionsJobResultOptions): Promise<GetListSessionsJobResultResponse & GetListSessionsJobResultResponseNonNullableFields>;
-}
-declare function markSessionAsRecorded$1(httpClient: HttpClient): MarkSessionAsRecordedSignature;
-interface MarkSessionAsRecordedSignature {
-    /**
-     * Marks a browser session as recorded.
-     * @param - Browser session ID.
-     * @returns Mark a browser session as recorded.
-     */
-    (sessionId: string): Promise<void>;
-}
-declare function markRecordingsAsDeleted$1(httpClient: HttpClient): MarkRecordingsAsDeletedSignature;
-interface MarkRecordingsAsDeletedSignature {
-    /**
-     * Marks browser session recordings as deleted.
-     * @param - Browser session IDs.
-     * @returns Marks browser session recordings as deleted.
-     */
-    (sessionIds: string[]): Promise<void>;
-}
-
-declare const listSessionsAsync: MaybeContext<BuildRESTFunction<typeof listSessionsAsync$1> & typeof listSessionsAsync$1>;
-declare const getListSessionsJobResult: MaybeContext<BuildRESTFunction<typeof getListSessionsJobResult$1> & typeof getListSessionsJobResult$1>;
-declare const markSessionAsRecorded: MaybeContext<BuildRESTFunction<typeof markSessionAsRecorded$1> & typeof markSessionAsRecorded$1>;
-declare const markRecordingsAsDeleted: MaybeContext<BuildRESTFunction<typeof markRecordingsAsDeleted$1> & typeof markRecordingsAsDeleted$1>;
-
-type context_ConversionFunnelSessionsParams = ConversionFunnelSessionsParams;
-type context_CountFunnelSessionsRequest = CountFunnelSessionsRequest;
-type context_CountFunnelSessionsRequestPeriodOneOf = CountFunnelSessionsRequestPeriodOneOf;
-type context_CountFunnelSessionsResponse = CountFunnelSessionsResponse;
-type context_CountSessionsRequest = CountSessionsRequest;
-type context_CountSessionsRequestPeriodOneOf = CountSessionsRequestPeriodOneOf;
-type context_CountSessionsResponse = CountSessionsResponse;
-type context_CustomTimePeriod = CustomTimePeriod;
-type context_DeviceType = DeviceType;
-declare const context_DeviceType: typeof DeviceType;
-type context_FunnelStep = FunnelStep;
-declare const context_FunnelStep: typeof FunnelStep;
-type context_GetListSessionsJobResultOptions = GetListSessionsJobResultOptions;
-type context_GetListSessionsJobResultRequest = GetListSessionsJobResultRequest;
-type context_GetListSessionsJobResultResponse = GetListSessionsJobResultResponse;
-type context_GetListSessionsJobResultResponseNonNullableFields = GetListSessionsJobResultResponseNonNullableFields;
-type context_JobResult = JobResult;
-type context_JobStatus = JobStatus;
-declare const context_JobStatus: typeof JobStatus;
-type context_ListSessionsAsyncOptions = ListSessionsAsyncOptions;
-type context_ListSessionsAsyncRequest = ListSessionsAsyncRequest;
-type context_ListSessionsAsyncRequestParamsOneOf = ListSessionsAsyncRequestParamsOneOf;
-type context_ListSessionsAsyncRequestPeriodOneOf = ListSessionsAsyncRequestPeriodOneOf;
-type context_ListSessionsAsyncResponse = ListSessionsAsyncResponse;
-type context_ListSessionsAsyncResponseNonNullableFields = ListSessionsAsyncResponseNonNullableFields;
-type context_MarkRecordingsAsDeletedRequest = MarkRecordingsAsDeletedRequest;
-type context_MarkRecordingsAsDeletedResponse = MarkRecordingsAsDeletedResponse;
-type context_MarkSessionAsRecordedRequest = MarkSessionAsRecordedRequest;
-type context_MarkSessionAsRecordedResponse = MarkSessionAsRecordedResponse;
-type context_NavigationFlowSessionsParams = NavigationFlowSessionsParams;
-type context_PredefinedTimePeriod = PredefinedTimePeriod;
-declare const context_PredefinedTimePeriod: typeof PredefinedTimePeriod;
-type context_Recordings = Recordings;
-type context_Session = Session;
-type context_SessionsByDeviceParams = SessionsByDeviceParams;
-declare const context_getListSessionsJobResult: typeof getListSessionsJobResult;
-declare const context_listSessionsAsync: typeof listSessionsAsync;
-declare const context_markRecordingsAsDeleted: typeof markRecordingsAsDeleted;
-declare const context_markSessionAsRecorded: typeof markSessionAsRecorded;
-declare namespace context {
-  export { type context_ConversionFunnelSessionsParams as ConversionFunnelSessionsParams, type context_CountFunnelSessionsRequest as CountFunnelSessionsRequest, type context_CountFunnelSessionsRequestPeriodOneOf as CountFunnelSessionsRequestPeriodOneOf, type context_CountFunnelSessionsResponse as CountFunnelSessionsResponse, type context_CountSessionsRequest as CountSessionsRequest, type context_CountSessionsRequestPeriodOneOf as CountSessionsRequestPeriodOneOf, type context_CountSessionsResponse as CountSessionsResponse, type context_CustomTimePeriod as CustomTimePeriod, context_DeviceType as DeviceType, context_FunnelStep as FunnelStep, type context_GetListSessionsJobResultOptions as GetListSessionsJobResultOptions, type context_GetListSessionsJobResultRequest as GetListSessionsJobResultRequest, type context_GetListSessionsJobResultResponse as GetListSessionsJobResultResponse, type context_GetListSessionsJobResultResponseNonNullableFields as GetListSessionsJobResultResponseNonNullableFields, type context_JobResult as JobResult, context_JobStatus as JobStatus, type context_ListSessionsAsyncOptions as ListSessionsAsyncOptions, type context_ListSessionsAsyncRequest as ListSessionsAsyncRequest, type context_ListSessionsAsyncRequestParamsOneOf as ListSessionsAsyncRequestParamsOneOf, type context_ListSessionsAsyncRequestPeriodOneOf as ListSessionsAsyncRequestPeriodOneOf, type context_ListSessionsAsyncResponse as ListSessionsAsyncResponse, type context_ListSessionsAsyncResponseNonNullableFields as ListSessionsAsyncResponseNonNullableFields, type context_MarkRecordingsAsDeletedRequest as MarkRecordingsAsDeletedRequest, type context_MarkRecordingsAsDeletedResponse as MarkRecordingsAsDeletedResponse, type context_MarkSessionAsRecordedRequest as MarkSessionAsRecordedRequest, type context_MarkSessionAsRecordedResponse as MarkSessionAsRecordedResponse, type context_NavigationFlowSessionsParams as NavigationFlowSessionsParams, context_PredefinedTimePeriod as PredefinedTimePeriod, type context_Recordings as Recordings, type context_Session as Session, type context_SessionsByDeviceParams as SessionsByDeviceParams, context_getListSessionsJobResult as getListSessionsJobResult, context_listSessionsAsync as listSessionsAsync, context_markRecordingsAsDeleted as markRecordingsAsDeleted, context_markSessionAsRecorded as markSessionAsRecorded };
-}
-
-export { context as analyticsSession };