@wix/auto_sdk_analytics-session_analytics-session 1.0.5 → 1.0.7
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.
- package/build/cjs/index.d.ts +54 -1
- package/build/cjs/index.js +528 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +401 -1
- package/build/cjs/index.typings.js +490 -15
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +251 -1
- package/build/cjs/meta.js +389 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +54 -0
- package/build/es/index.mjs +500 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{internal/cjs/src/analytics-ng-v1-session-analytics-session.universal.d.ts → es/index.typings.d.mts} +58 -55
- package/build/es/index.typings.mjs +462 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/{src/analytics-ng-v1-session-analytics-session.types.d.ts → meta.d.mts} +54 -94
- package/build/es/meta.mjs +362 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +54 -1
- package/build/internal/cjs/index.js +528 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +401 -1
- package/build/internal/cjs/index.typings.js +490 -15
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +251 -1
- package/build/internal/cjs/meta.js +389 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +54 -0
- package/build/internal/es/index.mjs +500 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/{src/analytics-ng-v1-session-analytics-session.universal.d.ts → index.typings.d.mts} +58 -55
- package/build/internal/es/index.typings.mjs +462 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/{cjs/src/analytics-ng-v1-session-analytics-session.types.d.ts → internal/es/meta.d.mts} +54 -94
- package/build/internal/es/meta.mjs +362 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +12 -10
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.context.d.ts +0 -8
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.context.js +0 -15
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.context.js.map +0 -1
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.http.d.ts +0 -13
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.http.js +0 -278
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.http.js.map +0 -1
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.meta.d.ts +0 -16
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.meta.js +0 -104
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.meta.js.map +0 -1
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.public.d.ts +0 -49
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.public.js +0 -35
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.public.js.map +0 -1
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.types.js +0 -89
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.types.js.map +0 -1
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.universal.d.ts +0 -398
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.universal.js +0 -286
- package/build/cjs/src/analytics-ng-v1-session-analytics-session.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/src/analytics-ng-v1-session-analytics-session.context.d.ts +0 -8
- package/build/es/src/analytics-ng-v1-session-analytics-session.context.js +0 -8
- package/build/es/src/analytics-ng-v1-session-analytics-session.context.js.map +0 -1
- package/build/es/src/analytics-ng-v1-session-analytics-session.http.d.ts +0 -13
- package/build/es/src/analytics-ng-v1-session-analytics-session.http.js +0 -271
- package/build/es/src/analytics-ng-v1-session-analytics-session.http.js.map +0 -1
- package/build/es/src/analytics-ng-v1-session-analytics-session.meta.d.ts +0 -16
- package/build/es/src/analytics-ng-v1-session-analytics-session.meta.js +0 -74
- package/build/es/src/analytics-ng-v1-session-analytics-session.meta.js.map +0 -1
- package/build/es/src/analytics-ng-v1-session-analytics-session.public.d.ts +0 -49
- package/build/es/src/analytics-ng-v1-session-analytics-session.public.js +0 -24
- package/build/es/src/analytics-ng-v1-session-analytics-session.public.js.map +0 -1
- package/build/es/src/analytics-ng-v1-session-analytics-session.types.js +0 -86
- package/build/es/src/analytics-ng-v1-session-analytics-session.types.js.map +0 -1
- package/build/es/src/analytics-ng-v1-session-analytics-session.universal.d.ts +0 -398
- package/build/es/src/analytics-ng-v1-session-analytics-session.universal.js +0 -256
- package/build/es/src/analytics-ng-v1-session-analytics-session.universal.js.map +0 -1
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.context.d.ts +0 -8
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.context.js +0 -15
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.context.js.map +0 -1
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.http.d.ts +0 -13
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.http.js +0 -278
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.http.js.map +0 -1
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.meta.d.ts +0 -16
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.meta.js +0 -104
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.meta.js.map +0 -1
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.public.d.ts +0 -49
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.public.js +0 -35
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.public.js.map +0 -1
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.types.d.ts +0 -291
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.types.js +0 -89
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.types.js.map +0 -1
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.universal.js +0 -286
- package/build/internal/cjs/src/analytics-ng-v1-session-analytics-session.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.context.d.ts +0 -8
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.context.js +0 -8
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.context.js.map +0 -1
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.http.d.ts +0 -13
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.http.js +0 -271
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.http.js.map +0 -1
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.meta.d.ts +0 -16
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.meta.js +0 -74
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.meta.js.map +0 -1
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.public.d.ts +0 -49
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.public.js +0 -24
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.public.js.map +0 -1
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.types.d.ts +0 -291
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.types.js +0 -86
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.types.js.map +0 -1
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.universal.js +0 -256
- package/build/internal/es/src/analytics-ng-v1-session-analytics-session.universal.js.map +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/analytics-ng-v1-session-analytics-session.universal.ts","../../../src/analytics-ng-v1-session-analytics-session.http.ts","../../../src/analytics-ng-v1-session-analytics-session.public.ts","../../../src/analytics-ng-v1-session-analytics-session.context.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n renameKeysFromSDKRequestToRESTRequest,\n renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixAnalyticsNgV1Session from './analytics-ng-v1-session-analytics-session.http.js';\n\nexport interface Session {\n /**\n * Session ID.\n * @format GUID\n */\n _id?: string;\n}\n\n/** List sessions async request. */\nexport interface ListSessionsAsyncRequest\n extends ListSessionsAsyncRequestPeriodOneOf,\n ListSessionsAsyncRequestParamsOneOf {\n /** Custom time period with start & end dates. */\n customTimePeriod?: CustomTimePeriod;\n /** Predefined time period. */\n predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;\n /** Navigation flow details. */\n navigationFlow?: NavigationFlowSessionsParams;\n /** Conversion funnel details. The steps in the journey the visitor has taken on the site. */\n conversionFunnel?: ConversionFunnelSessionsParams;\n /** Device type. */\n deviceType?: SessionsByDeviceParams;\n /**\n * 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).\n * @maxLength 100\n */\n timezone?: string | null;\n}\n\n/** @oneof */\nexport interface ListSessionsAsyncRequestPeriodOneOf {\n /** Custom time period with start & end dates. */\n customTimePeriod?: CustomTimePeriod;\n /** Predefined time period. */\n predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;\n}\n\n/** @oneof */\nexport interface ListSessionsAsyncRequestParamsOneOf {\n /** Navigation flow details. */\n navigationFlow?: NavigationFlowSessionsParams;\n /** Conversion funnel details. The steps in the journey the visitor has taken on the site. */\n conversionFunnel?: ConversionFunnelSessionsParams;\n /** Device type. */\n deviceType?: SessionsByDeviceParams;\n}\n\n/** Custom time period. */\nexport interface CustomTimePeriod {\n /**\n * Custom period start date in provided timezone.\n * @format LOCAL_DATE\n */\n startDate?: string;\n /**\n * Custom period end date in provided timezone. Returned data will include all dates until the requested end date.\n * For example, { startDate: '2024-01-01', endDate: '2024-01-03' } will return data for '2024-01-01' and '2024-01-02'\n * @format LOCAL_DATE\n */\n endDate?: string;\n}\n\n/**\n * Predefined time period.\n * `THIS_WEEK`begins with Monday.\n */\nexport enum PredefinedTimePeriod {\n /** Today. */\n TODAY = 'TODAY',\n /** Yesterday. */\n YESTERDAY = 'YESTERDAY',\n /** Last 7 days. */\n LAST_7_DAYS = 'LAST_7_DAYS',\n /** Last 14 days. */\n LAST_14_DAYS = 'LAST_14_DAYS',\n /** Last 30 days. */\n LAST_30_DAYS = 'LAST_30_DAYS',\n /** Last 90 days. */\n LAST_90_DAYS = 'LAST_90_DAYS',\n /** Last 28 days. */\n LAST_28_DAYS = 'LAST_28_DAYS',\n /** Last 180 days. */\n LAST_180_DAYS = 'LAST_180_DAYS',\n /** Last 365 days. */\n LAST_365_DAYS = 'LAST_365_DAYS',\n /** Current week, starting on Monday. */\n THIS_WEEK = 'THIS_WEEK',\n /** Current month. */\n THIS_MONTH = 'THIS_MONTH',\n /** Current quarter. */\n THIS_QUARTER = 'THIS_QUARTER',\n /** This year. */\n THIS_YEAR = 'THIS_YEAR',\n /** Last week (previous week). */\n LAST_WEEK = 'LAST_WEEK',\n /** Last month. */\n LAST_MONTH = 'LAST_MONTH',\n /** Last quarter. */\n LAST_QUARTER = 'LAST_QUARTER',\n /** Last year. */\n LAST_YEAR = 'LAST_YEAR',\n /** Last 12 months. */\n LAST_12_MONTHS = 'LAST_12_MONTHS',\n}\n\n/** @enumType */\nexport type PredefinedTimePeriodWithLiterals =\n | PredefinedTimePeriod\n | 'TODAY'\n | 'YESTERDAY'\n | 'LAST_7_DAYS'\n | 'LAST_14_DAYS'\n | 'LAST_30_DAYS'\n | 'LAST_90_DAYS'\n | 'LAST_28_DAYS'\n | 'LAST_180_DAYS'\n | 'LAST_365_DAYS'\n | 'THIS_WEEK'\n | 'THIS_MONTH'\n | 'THIS_QUARTER'\n | 'THIS_YEAR'\n | 'LAST_WEEK'\n | 'LAST_MONTH'\n | 'LAST_QUARTER'\n | 'LAST_YEAR'\n | 'LAST_12_MONTHS';\n\n/** Navigation flow details. */\nexport interface NavigationFlowSessionsParams {\n /**\n * Page interactions, including where the user dropped off. For example:\n * - [\"/{Homepage}\", \"__DROP__\"]: Sessions where a user visited the site's homepage and then dropped off.\n * - [\"\", \"__DROP__\"]: Sessions where a user visited (any page) and then dropped off.\n * - [\"\", \"\", \"__DROP__\"]: Session where a user visited any page, then navigated to any page, and then dropped off.\n * @minSize 1\n * @maxSize 5\n * @maxLength 255\n */\n pageInteractions?: string[] | null;\n}\n\n/** Conversion funnel details, meaning the steps in the journey the visitor has taken on the site. */\nexport interface ConversionFunnelSessionsParams {\n /** Funnel step to include. */\n include?: FunnelStepWithLiterals;\n /** Funnel step to exclude. */\n exclude?: FunnelStepWithLiterals;\n}\n\n/** Funnel step. */\nexport enum FunnelStep {\n /** Not selected. */\n NOT_SELECTED_FUNNEL_STEP = 'NOT_SELECTED_FUNNEL_STEP',\n /** Site sessions. */\n SITE_SESSIONS = 'SITE_SESSIONS',\n /** Viewed product. */\n VIEWED_PRODUCT = 'VIEWED_PRODUCT',\n /** Added to cart. */\n ADDED_TO_CART = 'ADDED_TO_CART',\n /** Reached checkout. */\n REACHED_CHECKOUT = 'REACHED_CHECKOUT',\n /** Sessions converted. */\n SESSIONS_CONVERTED = 'SESSIONS_CONVERTED',\n}\n\n/** @enumType */\nexport type FunnelStepWithLiterals =\n | FunnelStep\n | 'NOT_SELECTED_FUNNEL_STEP'\n | 'SITE_SESSIONS'\n | 'VIEWED_PRODUCT'\n | 'ADDED_TO_CART'\n | 'REACHED_CHECKOUT'\n | 'SESSIONS_CONVERTED';\n\n/** Device details. */\nexport interface SessionsByDeviceParams {\n /** Device type. */\n type?: DeviceTypeWithLiterals;\n}\n\n/** Device type. */\nexport enum DeviceType {\n /** Not selected. */\n NOT_SELECTED_DEVICE_TYPE = 'NOT_SELECTED_DEVICE_TYPE',\n /** Desktop. */\n DESKTOP = 'DESKTOP',\n /** Mobile. */\n MOBILE = 'MOBILE',\n /** Tablet. */\n TABLET = 'TABLET',\n /** All. */\n ALL = 'ALL',\n}\n\n/** @enumType */\nexport type DeviceTypeWithLiterals =\n | DeviceType\n | 'NOT_SELECTED_DEVICE_TYPE'\n | 'DESKTOP'\n | 'MOBILE'\n | 'TABLET'\n | 'ALL';\n\n/** List sessions async response. */\nexport interface ListSessionsAsyncResponse {\n /**\n * List sessions job ID.\n * Pass this ID to Get List Sessions Job Result to retrieve job details and metadata.\n * @format GUID\n */\n jobId?: string;\n}\n\n/** Get list sessions job result request. */\nexport interface GetListSessionsJobResultRequest {\n /**\n * List sessions job ID.\n * @format GUID\n */\n jobId: string;\n /**\n * Number of items to load.\n * @min 1\n * @max 1000\n */\n limit: number;\n /** Number of items to skip in the current sort order. */\n offset: number;\n}\n\n/** Get list sessions job result response. */\nexport interface GetListSessionsJobResultResponse {\n /** List sessions job result data. */\n result?: JobResult;\n}\n\n/** List sessions job result. */\nexport interface JobResult {\n /** Job status. */\n jobStatus?: JobStatusWithLiterals;\n /** Total number of sessions. */\n total?: number | null;\n /**\n * Session IDs.\n * @format GUID\n * @maxSize 1000\n */\n sessionIds?: string[];\n}\n\n/** Job status. */\nexport enum JobStatus {\n /** Unknown. */\n UNKNOWN_JOB_STATUS = 'UNKNOWN_JOB_STATUS',\n /** In progress. */\n IN_PROGRESS = 'IN_PROGRESS',\n /** Finished. */\n FINISHED = 'FINISHED',\n /** Error. */\n ERROR = 'ERROR',\n}\n\n/** @enumType */\nexport type JobStatusWithLiterals =\n | JobStatus\n | 'UNKNOWN_JOB_STATUS'\n | 'IN_PROGRESS'\n | 'FINISHED'\n | 'ERROR';\n\n/** Request for getting store conversion sessions. */\nexport interface CountFunnelSessionsRequest\n extends CountFunnelSessionsRequestPeriodOneOf {\n /** Custom time period with start & end dates. */\n customTimePeriod?: CustomTimePeriod;\n /** Predefined time period. */\n predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;\n /**\n * User timezone. If not provided it will be taken from site properties.\n * @maxLength 100\n */\n timezone?: string | null;\n}\n\n/** @oneof */\nexport interface CountFunnelSessionsRequestPeriodOneOf {\n /** Custom time period with start & end dates. */\n customTimePeriod?: CustomTimePeriod;\n /** Predefined time period. */\n predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;\n}\n\n/** Response for getting store conversion sessions. */\nexport interface CountFunnelSessionsResponse {\n /** Recordings. */\n recordings?: Recordings;\n}\n\n/** Recordings. */\nexport interface Recordings {\n /** Saved Session count. */\n siteSessions?: number | null;\n /** Saved Sessions with Product Views */\n productViewSessions?: number | null;\n /** Saved Sessions with Cart Views */\n cartViewSessions?: number | null;\n /** Saved Sessions with Checkouts */\n checkoutSessions?: number | null;\n /** Saved Converted Sessions */\n convertedSessions?: number | null;\n}\n\n/** Request for getting the total number of sessions. */\nexport interface CountSessionsRequest extends CountSessionsRequestPeriodOneOf {\n /** Custom time period with start & end dates. */\n customTimePeriod?: CustomTimePeriod;\n /** Predefined time period. */\n predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;\n /**\n * User timezone. If not provided it will be taken from site properties.\n * @maxLength 100\n */\n timezone?: string | null;\n}\n\n/** @oneof */\nexport interface CountSessionsRequestPeriodOneOf {\n /** Custom time period with start & end dates. */\n customTimePeriod?: CustomTimePeriod;\n /** Predefined time period. */\n predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;\n}\n\n/** Response for getting the total number of sessions. */\nexport interface CountSessionsResponse {\n /** Total number of sessions. */\n sessions?: number;\n}\n\n/** Mark a browser session as recorded. */\nexport interface MarkSessionAsRecordedRequest {\n /**\n * Browser session ID.\n * @minLength 1\n * @maxLength 100\n */\n sessionId: string;\n}\n\n/** Mark a browser session as recorded. */\nexport interface MarkSessionAsRecordedResponse {}\n\n/** Marks browser session recordings as deleted. */\nexport interface MarkRecordingsAsDeletedRequest {\n /**\n * Browser session IDs.\n * @minSize 1\n * @maxSize 100\n * @minLength 1\n * @maxLength 100\n */\n sessionIds: string[];\n}\n\n/** Marks browser session recordings as deleted. */\nexport interface MarkRecordingsAsDeletedResponse {}\n\n/**\n * Start an async job to retrieve a list of session IDs, given the specified filters. The following filters **must** be passed:\n * - Time period, either predefined or custom.\n * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.\n * @public\n * @requiredField options.params\n * @requiredField options.period\n * @param options - Filter options. The following filters **must** be passed:\n *\n * - Time period, either predefined or custom.\n *\n * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.\n * @permissionId ANALYTICS_AND_REPORTS.SESSIONS_READ\n * @applicableIdentity APP\n * @returns List sessions async response.\n * @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.ListSessionsAsync\n */\nexport async function listSessionsAsync(\n options?: ListSessionsAsyncOptions\n): Promise<NonNullablePaths<ListSessionsAsyncResponse, `jobId`, 2>> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[1] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({\n customTimePeriod: options?.customTimePeriod,\n predefinedTimePeriod: options?.predefinedTimePeriod,\n timezone: options?.timezone,\n navigationFlow: options?.navigationFlow,\n conversionFunnel: options?.conversionFunnel,\n deviceType: options?.deviceType,\n });\n\n const reqOpts = ambassadorWixAnalyticsNgV1Session.listSessionsAsync(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {\n customTimePeriod: '$[0].customTimePeriod',\n predefinedTimePeriod: '$[0].predefinedTimePeriod',\n timezone: '$[0].timezone',\n navigationFlow: '$[0].navigationFlow',\n conversionFunnel: '$[0].conversionFunnel',\n deviceType: '$[0].deviceType',\n },\n singleArgumentUnchanged: false,\n },\n ['options']\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n\nexport interface ListSessionsAsyncOptions\n extends ListSessionsAsyncOptionsPeriodOneOf,\n ListSessionsAsyncOptionsParamsOneOf {\n /** Custom time period with start & end dates. */\n customTimePeriod?: CustomTimePeriod;\n /** Predefined time period. */\n predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;\n /**\n * 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).\n * @maxLength 100\n */\n timezone?: string | null;\n /** Navigation flow details. */\n navigationFlow?: NavigationFlowSessionsParams;\n /** Conversion funnel details. The steps in the journey the visitor has taken on the site. */\n conversionFunnel?: ConversionFunnelSessionsParams;\n /** Device type. */\n deviceType?: SessionsByDeviceParams;\n}\n\n/** @oneof */\nexport interface ListSessionsAsyncOptionsPeriodOneOf {\n /** Custom time period with start & end dates. */\n customTimePeriod?: CustomTimePeriod;\n /** Predefined time period. */\n predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;\n}\n\n/** @oneof */\nexport interface ListSessionsAsyncOptionsParamsOneOf {\n /** Navigation flow details. */\n navigationFlow?: NavigationFlowSessionsParams;\n /** Conversion funnel details. The steps in the journey the visitor has taken on the site. */\n conversionFunnel?: ConversionFunnelSessionsParams;\n /** Device type. */\n deviceType?: SessionsByDeviceParams;\n}\n\n/**\n * Retrieves the job status and a list of session IDs, if ready.\n * @param jobId - List sessions job ID.\n * @public\n * @requiredField jobId\n * @requiredField options\n * @requiredField options.limit\n * @requiredField options.offset\n * @param options - Field options. The `limit` and `offset` filters **must** be passed.\n * @permissionId ANALYTICS_AND_REPORTS.SESSIONS_READ\n * @applicableIdentity APP\n * @returns Get list sessions job result response.\n * @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.GetListSessionsJobResult\n */\nexport async function getListSessionsJobResult(\n jobId: string,\n options: NonNullablePaths<\n GetListSessionsJobResultOptions,\n `limit` | `offset`,\n 2\n >\n): Promise<\n NonNullablePaths<\n GetListSessionsJobResultResponse,\n `result.jobStatus` | `result.sessionIds`,\n 3\n >\n> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[2] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({\n jobId: jobId,\n limit: options?.limit,\n offset: options?.offset,\n });\n\n const reqOpts =\n ambassadorWixAnalyticsNgV1Session.getListSessionsJobResult(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n\n return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: {\n jobId: '$[0]',\n limit: '$[1].limit',\n offset: '$[1].offset',\n },\n singleArgumentUnchanged: false,\n },\n ['jobId', 'options']\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n\nexport interface GetListSessionsJobResultOptions {\n /**\n * Number of items to load.\n * @min 1\n * @max 1000\n */\n limit: number;\n /** Number of items to skip in the current sort order. */\n offset: number;\n}\n\n/**\n * Marks a browser session as recorded.\n * @param sessionId - Browser session ID.\n * @public\n * @requiredField sessionId\n * @permissionId ANALYTICS_AND_REPORTS.SESSIONS_UPDATE\n * @applicableIdentity APP\n * @returns Mark a browser session as recorded.\n * @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.MarkSessionAsRecorded\n */\nexport async function markSessionAsRecorded(sessionId: string): Promise<void> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[1] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({\n sessionId: sessionId,\n });\n\n const reqOpts =\n ambassadorWixAnalyticsNgV1Session.markSessionAsRecorded(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: { sessionId: '$[0]' },\n singleArgumentUnchanged: false,\n },\n ['sessionId']\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n\n/**\n * Marks browser session recordings as deleted.\n * @param sessionIds - Browser session IDs.\n * @public\n * @requiredField sessionIds\n * @permissionId ANALYTICS_AND_REPORTS.SESSIONS_UPDATE\n * @applicableIdentity APP\n * @returns Marks browser session recordings as deleted.\n * @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.MarkRecordingsAsDeleted\n */\nexport async function markRecordingsAsDeleted(\n sessionIds: string[]\n): Promise<void> {\n // @ts-ignore\n const { httpClient, sideEffects } = arguments[1] as {\n httpClient: HttpClient;\n sideEffects?: any;\n };\n\n const payload = renameKeysFromSDKRequestToRESTRequest({\n sessionIds: sessionIds,\n });\n\n const reqOpts =\n ambassadorWixAnalyticsNgV1Session.markRecordingsAsDeleted(payload);\n\n sideEffects?.onSiteCall?.();\n try {\n const result = await httpClient.request(reqOpts);\n sideEffects?.onSuccess?.(result);\n } catch (err: any) {\n const transformedError = sdkTransformError(\n err,\n {\n spreadPathsToArguments: {},\n explicitPathsToArguments: { sessionIds: '$[0]' },\n singleArgumentUnchanged: false,\n },\n ['sessionIds']\n );\n sideEffects?.onError?.(err);\n\n throw transformedError;\n }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixAnalyticsNgSessionIdsV1SessionIdsServiceUrl(\n opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n const domainToMappings = {\n 'bo._base_domain_': [\n {\n srcPath: '/analytics-ng-bo/api',\n destPath: '/api',\n },\n {\n srcPath: '/analytics-ng-bo/v2',\n destPath: '/v2',\n },\n ],\n 'wixbo.ai': [\n {\n srcPath: '/analytics-ng-bo/api',\n destPath: '/api',\n },\n {\n srcPath: '/analytics-ng-bo/v2',\n destPath: '/v2',\n },\n ],\n 'wix-bo.com': [\n {\n srcPath: '/analytics-ng-bo/api',\n destPath: '/api',\n },\n {\n srcPath: '/analytics-ng-bo/v2',\n destPath: '/v2',\n },\n ],\n 'www._base_domain_': [\n {\n srcPath: '/analytics-ng/api',\n destPath: '/api',\n },\n {\n srcPath: '/analytics-ng/report',\n destPath: '/report',\n },\n {\n srcPath: '/analytics-ng/assets',\n destPath: '/assets',\n },\n {\n srcPath: '/analytics-ng/hook',\n destPath: '/hook',\n },\n {\n srcPath: '/analytics-ng/debug-permissions',\n destPath: '/_debug_/permissions',\n },\n {\n srcPath: '/analytics-ng/debug-digest-email',\n destPath: '/debug-digest-email',\n },\n {\n srcPath: '/analytics-ng/utils',\n destPath: '/utils',\n },\n {\n srcPath: '/analytics-ng/v1',\n destPath: '/v1',\n },\n {\n srcPath: '/analytics-ng/v2',\n destPath: '/v2',\n },\n {\n srcPath: '/analytics-ng/debug-partners-digest-email',\n destPath: '/debug-partners-digest-email',\n },\n ],\n 'manage._base_domain_': [\n {\n srcPath: '/analytics-ng/api',\n destPath: '/api',\n },\n {\n srcPath: '/analytics-ng/assets',\n destPath: '/assets',\n },\n {\n srcPath: '/analytics-ng/report',\n destPath: '/report',\n },\n {\n srcPath: '/analytics-ng/hook',\n destPath: '/hook',\n },\n {\n srcPath: '/analytics-ng/utils',\n destPath: '/utils',\n },\n {\n srcPath: '/analytics-ng/debug-digest-email',\n destPath: '/debug-digest-email',\n },\n {\n srcPath: '/analytics-ng/subscriptions/off',\n destPath: '/subscriptions/off',\n },\n {\n srcPath: '/analytics-ng/subscriptions/debug/get-unsubscribe-token',\n destPath: '/subscriptions/debug/get-unsubscribe-token',\n },\n {\n srcPath: '/analytics-ng/v1',\n destPath: '/v1',\n },\n {\n srcPath: '/analytics-ng/v2',\n destPath: '/v2',\n },\n {\n srcPath: '/analytics-ng/debug-partners-digest-email',\n destPath: '/debug-partners-digest-email',\n },\n {\n srcPath: '/analytics-ng/v3',\n destPath: '/v3',\n },\n {\n srcPath: '/analytics-ng/v5',\n destPath: '/v5',\n },\n {\n srcPath: '/analytics-ng/v4',\n destPath: '/v4',\n },\n ],\n 'api._api_base_domain_': [\n {\n srcPath: '/analytics-ng-server',\n destPath: '',\n },\n ],\n 'www.wixapis.com': [\n {\n srcPath: '/analytics/v1/sessions/',\n destPath: '/v1/sessions/',\n },\n {\n srcPath: '/analytics/v2/site-analytics/',\n destPath: '/v2/site-analytics/',\n },\n {\n srcPath: '/analytics/v2/site-analytics',\n destPath: '/v2/site-analytics',\n },\n {\n srcPath: '/analytics/v1/sessions',\n destPath: '/v1/sessions',\n },\n {\n srcPath: '/analytics-ng/v1/sessions',\n destPath: '/v1/sessions',\n },\n {\n srcPath: '/analytics-ng/v2/site-analytics/data',\n destPath: '/v2/site-analytics/data',\n },\n ],\n '*.dev.wix-code.com': [\n {\n srcPath: '/analytics-ng/v2/site-analytics/data',\n destPath: '/v2/site-analytics/data',\n },\n {\n srcPath: '/analytics-ng/v1/sessions',\n destPath: '/v1/sessions',\n },\n ],\n _: [\n {\n srcPath: '/analytics-ng/v2/site-analytics/data',\n destPath: '/v2/site-analytics/data',\n },\n {\n srcPath: '/analytics-ng/v1/sessions',\n destPath: '/v1/sessions',\n },\n ],\n 'editor._base_domain_': [\n {\n srcPath: '/_api/analytics-ng-server',\n destPath: '',\n },\n ],\n 'blocks._base_domain_': [\n {\n srcPath: '/_api/analytics-ng-server',\n destPath: '',\n },\n ],\n 'create.editorx': [\n {\n srcPath: '/_api/analytics-ng-server',\n destPath: '',\n },\n ],\n };\n\n return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_analytics-session_analytics-session';\n\n/**\n * Start an async job to retrieve a list of session IDs, given the specified filters. The following filters **must** be passed:\n * - Time period, either predefined or custom.\n * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.\n */\nexport function listSessionsAsync(payload: object): RequestOptionsFactory<any> {\n function __listSessionsAsync({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.analytics_ng.v1.session',\n method: 'POST' as any,\n methodFqn:\n 'wix.analytics_ng.session_ids.v1.SessionIdsService.ListSessionsAsync',\n packageName: PACKAGE_NAME,\n url: resolveWixAnalyticsNgSessionIdsV1SessionIdsServiceUrl({\n protoPath: '/v1/sessions/list/async',\n data: payload,\n host,\n }),\n data: payload,\n };\n\n return metadata;\n }\n\n return __listSessionsAsync;\n}\n\n/** Retrieves the job status and a list of session IDs, if ready. */\nexport function getListSessionsJobResult(\n payload: object\n): RequestOptionsFactory<any> {\n function __getListSessionsJobResult({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.analytics_ng.v1.session',\n method: 'GET' as any,\n methodFqn:\n 'wix.analytics_ng.session_ids.v1.SessionIdsService.GetListSessionsJobResult',\n packageName: PACKAGE_NAME,\n url: resolveWixAnalyticsNgSessionIdsV1SessionIdsServiceUrl({\n protoPath: '/v1/sessions/list/result',\n data: payload,\n host,\n }),\n params: toURLSearchParams(payload),\n };\n\n return metadata;\n }\n\n return __getListSessionsJobResult;\n}\n\n/** Marks a browser session as recorded. */\nexport function markSessionAsRecorded(\n payload: object\n): RequestOptionsFactory<any> {\n function __markSessionAsRecorded({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.analytics_ng.v1.session',\n method: 'POST' as any,\n methodFqn:\n 'wix.analytics_ng.session_ids.v1.SessionIdsService.MarkSessionAsRecorded',\n packageName: PACKAGE_NAME,\n url: resolveWixAnalyticsNgSessionIdsV1SessionIdsServiceUrl({\n protoPath: '/v1/sessions/session-recorded',\n data: payload,\n host,\n }),\n data: payload,\n };\n\n return metadata;\n }\n\n return __markSessionAsRecorded;\n}\n\n/** Marks browser session recordings as deleted. */\nexport function markRecordingsAsDeleted(\n payload: object\n): RequestOptionsFactory<any> {\n function __markRecordingsAsDeleted({ host }: any) {\n const metadata = {\n entityFqdn: 'wix.analytics_ng.v1.session',\n method: 'POST' as any,\n methodFqn:\n 'wix.analytics_ng.session_ids.v1.SessionIdsService.MarkRecordingsAsDeleted',\n packageName: PACKAGE_NAME,\n url: resolveWixAnalyticsNgSessionIdsV1SessionIdsServiceUrl({\n protoPath: '/v1/sessions/recordings-deleted',\n data: payload,\n host,\n }),\n data: payload,\n };\n\n return metadata;\n }\n\n return __markRecordingsAsDeleted;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n GetListSessionsJobResultOptions,\n GetListSessionsJobResultResponse,\n ListSessionsAsyncOptions,\n ListSessionsAsyncResponse,\n getListSessionsJobResult as universalGetListSessionsJobResult,\n listSessionsAsync as universalListSessionsAsync,\n markRecordingsAsDeleted as universalMarkRecordingsAsDeleted,\n markSessionAsRecorded as universalMarkSessionAsRecorded,\n} from './analytics-ng-v1-session-analytics-session.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/analytics-session' };\n\nexport function listSessionsAsync(\n httpClient: HttpClient\n): ListSessionsAsyncSignature {\n return (options?: ListSessionsAsyncOptions) =>\n universalListSessionsAsync(\n options,\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface ListSessionsAsyncSignature {\n /**\n * Start an async job to retrieve a list of session IDs, given the specified filters. The following filters **must** be passed:\n * - Time period, either predefined or custom.\n * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.\n * @param - Filter options. The following filters **must** be passed:\n *\n * - Time period, either predefined or custom.\n *\n * - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.\n * @returns List sessions async response.\n */\n (options?: ListSessionsAsyncOptions): Promise<\n NonNullablePaths<ListSessionsAsyncResponse, `jobId`, 2>\n >;\n}\n\nexport function getListSessionsJobResult(\n httpClient: HttpClient\n): GetListSessionsJobResultSignature {\n return (\n jobId: string,\n options: NonNullablePaths<\n GetListSessionsJobResultOptions,\n `limit` | `offset`,\n 2\n >\n ) =>\n universalGetListSessionsJobResult(\n jobId,\n options,\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface GetListSessionsJobResultSignature {\n /**\n * Retrieves the job status and a list of session IDs, if ready.\n * @param - List sessions job ID.\n * @param - Field options. The `limit` and `offset` filters **must** be passed.\n * @returns Get list sessions job result response.\n */\n (\n jobId: string,\n options: NonNullablePaths<\n GetListSessionsJobResultOptions,\n `limit` | `offset`,\n 2\n >\n ): Promise<\n NonNullablePaths<\n GetListSessionsJobResultResponse,\n `result.jobStatus` | `result.sessionIds`,\n 3\n >\n >;\n}\n\nexport function markSessionAsRecorded(\n httpClient: HttpClient\n): MarkSessionAsRecordedSignature {\n return (sessionId: string) =>\n universalMarkSessionAsRecorded(\n sessionId,\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface MarkSessionAsRecordedSignature {\n /**\n * Marks a browser session as recorded.\n * @param - Browser session ID.\n * @returns Mark a browser session as recorded.\n */\n (sessionId: string): Promise<void>;\n}\n\nexport function markRecordingsAsDeleted(\n httpClient: HttpClient\n): MarkRecordingsAsDeletedSignature {\n return (sessionIds: string[]) =>\n universalMarkRecordingsAsDeleted(\n sessionIds,\n // @ts-ignore\n { httpClient }\n );\n}\n\ninterface MarkRecordingsAsDeletedSignature {\n /**\n * Marks browser session recordings as deleted.\n * @param - Browser session IDs.\n * @returns Marks browser session recordings as deleted.\n */\n (sessionIds: string[]): Promise<void>;\n}\n\nexport {\n ConversionFunnelSessionsParams,\n CountFunnelSessionsRequest,\n CountFunnelSessionsRequestPeriodOneOf,\n CountFunnelSessionsResponse,\n CountSessionsRequest,\n CountSessionsRequestPeriodOneOf,\n CountSessionsResponse,\n CustomTimePeriod,\n DeviceType,\n FunnelStep,\n GetListSessionsJobResultOptions,\n GetListSessionsJobResultRequest,\n GetListSessionsJobResultResponse,\n JobResult,\n JobStatus,\n ListSessionsAsyncOptions,\n ListSessionsAsyncOptionsParamsOneOf,\n ListSessionsAsyncOptionsPeriodOneOf,\n ListSessionsAsyncRequest,\n ListSessionsAsyncRequestParamsOneOf,\n ListSessionsAsyncRequestPeriodOneOf,\n ListSessionsAsyncResponse,\n MarkRecordingsAsDeletedRequest,\n MarkRecordingsAsDeletedResponse,\n MarkSessionAsRecordedRequest,\n MarkSessionAsRecordedResponse,\n NavigationFlowSessionsParams,\n PredefinedTimePeriod,\n Recordings,\n Session,\n SessionsByDeviceParams,\n} from './analytics-ng-v1-session-analytics-session.universal.js';\n","import {\n listSessionsAsync as publicListSessionsAsync,\n getListSessionsJobResult as publicGetListSessionsJobResult,\n markSessionAsRecorded as publicMarkSessionAsRecorded,\n markRecordingsAsDeleted as publicMarkRecordingsAsDeleted,\n} from './analytics-ng-v1-session-analytics-session.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const listSessionsAsync: MaybeContext<\n BuildRESTFunction<typeof publicListSessionsAsync> &\n typeof publicListSessionsAsync\n> = /*#__PURE__*/ createRESTModule(publicListSessionsAsync);\nexport const getListSessionsJobResult: MaybeContext<\n BuildRESTFunction<typeof publicGetListSessionsJobResult> &\n typeof publicGetListSessionsJobResult\n> = /*#__PURE__*/ createRESTModule(publicGetListSessionsJobResult);\nexport const markSessionAsRecorded: MaybeContext<\n BuildRESTFunction<typeof publicMarkSessionAsRecorded> &\n typeof publicMarkSessionAsRecorded\n> = /*#__PURE__*/ createRESTModule(publicMarkSessionAsRecorded);\nexport const markRecordingsAsDeleted: MaybeContext<\n BuildRESTFunction<typeof publicMarkRecordingsAsDeleted> &\n typeof publicMarkRecordingsAsDeleted\n> = /*#__PURE__*/ createRESTModule(publicMarkRecordingsAsDeleted);\n\nexport {\n PredefinedTimePeriod,\n FunnelStep,\n DeviceType,\n JobStatus,\n} from './analytics-ng-v1-session-analytics-session.universal.js';\nexport {\n Session,\n ListSessionsAsyncRequest,\n ListSessionsAsyncRequestPeriodOneOf,\n ListSessionsAsyncRequestParamsOneOf,\n CustomTimePeriod,\n NavigationFlowSessionsParams,\n ConversionFunnelSessionsParams,\n SessionsByDeviceParams,\n ListSessionsAsyncResponse,\n GetListSessionsJobResultRequest,\n GetListSessionsJobResultResponse,\n JobResult,\n CountFunnelSessionsRequest,\n CountFunnelSessionsRequestPeriodOneOf,\n CountFunnelSessionsResponse,\n Recordings,\n CountSessionsRequest,\n CountSessionsRequestPeriodOneOf,\n CountSessionsResponse,\n MarkSessionAsRecordedRequest,\n MarkSessionAsRecordedResponse,\n MarkRecordingsAsDeletedRequest,\n MarkRecordingsAsDeletedResponse,\n ListSessionsAsyncOptions,\n ListSessionsAsyncOptionsPeriodOneOf,\n ListSessionsAsyncOptionsParamsOneOf,\n GetListSessionsJobResultOptions,\n} from './analytics-ng-v1-session-analytics-session.universal.js';\nexport {\n PredefinedTimePeriodWithLiterals,\n FunnelStepWithLiterals,\n DeviceTypeWithLiterals,\n JobStatusWithLiterals,\n} from './analytics-ng-v1-session-analytics-session.universal.js';\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACJP,SAAS,yBAAyB;AAClC,SAAS,kBAAkB;AAI3B,SAAS,sDACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,oBAAoB;AAAA,MAClB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,YAAY;AAAA,MACV;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,cAAc;AAAA,MACZ;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,kBAAkB;AAAA,MAChB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAOd,SAAS,kBAAkB,SAA6C;AAC7E,WAAS,oBAAoB,EAAE,KAAK,GAAQ;AAC1C,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,yBACd,SAC4B;AAC5B,WAAS,2BAA2B,EAAE,KAAK,GAAQ;AACjD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,IACnC;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,sBACd,SAC4B;AAC5B,WAAS,wBAAwB,EAAE,KAAK,GAAQ;AAC9C,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,wBACd,SAC4B;AAC5B,WAAS,0BAA0B,EAAE,KAAK,GAAQ;AAChD,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,sDAAsD;AAAA,QACzD,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADlPO,IAAK,uBAAL,kBAAKA,0BAAL;AAEL,EAAAA,sBAAA,WAAQ;AAER,EAAAA,sBAAA,eAAY;AAEZ,EAAAA,sBAAA,iBAAc;AAEd,EAAAA,sBAAA,kBAAe;AAEf,EAAAA,sBAAA,kBAAe;AAEf,EAAAA,sBAAA,kBAAe;AAEf,EAAAA,sBAAA,kBAAe;AAEf,EAAAA,sBAAA,mBAAgB;AAEhB,EAAAA,sBAAA,mBAAgB;AAEhB,EAAAA,sBAAA,eAAY;AAEZ,EAAAA,sBAAA,gBAAa;AAEb,EAAAA,sBAAA,kBAAe;AAEf,EAAAA,sBAAA,eAAY;AAEZ,EAAAA,sBAAA,eAAY;AAEZ,EAAAA,sBAAA,gBAAa;AAEb,EAAAA,sBAAA,kBAAe;AAEf,EAAAA,sBAAA,eAAY;AAEZ,EAAAA,sBAAA,oBAAiB;AApCP,SAAAA;AAAA,GAAA;AAoFL,IAAK,aAAL,kBAAKC,gBAAL;AAEL,EAAAA,YAAA,8BAA2B;AAE3B,EAAAA,YAAA,mBAAgB;AAEhB,EAAAA,YAAA,oBAAiB;AAEjB,EAAAA,YAAA,mBAAgB;AAEhB,EAAAA,YAAA,sBAAmB;AAEnB,EAAAA,YAAA,wBAAqB;AAZX,SAAAA;AAAA,GAAA;AAgCL,IAAK,aAAL,kBAAKC,gBAAL;AAEL,EAAAA,YAAA,8BAA2B;AAE3B,EAAAA,YAAA,aAAU;AAEV,EAAAA,YAAA,YAAS;AAET,EAAAA,YAAA,YAAS;AAET,EAAAA,YAAA,SAAM;AAVI,SAAAA;AAAA,GAAA;AAsEL,IAAK,YAAL,kBAAKC,eAAL;AAEL,EAAAA,WAAA,wBAAqB;AAErB,EAAAA,WAAA,iBAAc;AAEd,EAAAA,WAAA,cAAW;AAEX,EAAAA,WAAA,WAAQ;AARE,SAAAA;AAAA,GAAA;AAqIZ,eAAsBC,mBACpB,SACkE;AAElE,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD,kBAAkB,SAAS;AAAA,IAC3B,sBAAsB,SAAS;AAAA,IAC/B,UAAU,SAAS;AAAA,IACnB,gBAAgB,SAAS;AAAA,IACzB,kBAAkB,SAAS;AAAA,IAC3B,YAAY,SAAS;AAAA,EACvB,CAAC;AAED,QAAM,UAA4C,kBAAkB,OAAO;AAE3E,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,kBAAkB;AAAA,UAClB,sBAAsB;AAAA,UACtB,UAAU;AAAA,UACV,gBAAgB;AAAA,UAChB,kBAAkB;AAAA,UAClB,YAAY;AAAA,QACd;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,SAAS;AAAA,IACZ;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAsDA,eAAsBC,0BACpB,OACA,SAWA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,IACA,OAAO,SAAS;AAAA,IAChB,QAAQ,SAAS;AAAA,EACnB,CAAC;AAED,QAAM,UAC8B,yBAAyB,OAAO;AAEpE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B;AAAA,UACxB,OAAO;AAAA,UACP,OAAO;AAAA,UACP,QAAQ;AAAA,QACV;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,SAAS,SAAS;AAAA,IACrB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAuBA,eAAsBC,uBAAsB,WAAkC;AAE5E,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UAC8B,sBAAsB,OAAO;AAEjE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAAA,EACjC,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,WAAW,OAAO;AAAA,QAC9C,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,WAAW;AAAA,IACd;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAYA,eAAsBC,yBACpB,YACe;AAEf,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC;AAAA,IACpD;AAAA,EACF,CAAC;AAED,QAAM,UAC8B,wBAAwB,OAAO;AAEnE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAAA,EACjC,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,YAAY,OAAO;AAAA,QAC/C,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,YAAY;AAAA,IACf;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AE1nBO,SAASC,mBACd,YAC4B;AAC5B,SAAO,CAAC,YACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAmBO,SAASC,0BACd,YACmC;AACnC,SAAO,CACL,OACA,YAMAA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAyBO,SAASC,uBACd,YACgC;AAChC,SAAO,CAAC,cACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAWO,SAASC,yBACd,YACkC;AAClC,SAAO,CAAC,eACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;;;AC3GA,SAAS,wBAAwB;AAG1B,IAAMC,qBAGK,iCAAiBA,kBAAuB;AACnD,IAAMC,4BAGK,iCAAiBA,yBAA8B;AAC1D,IAAMC,yBAGK,iCAAiBA,sBAA2B;AACvD,IAAMC,2BAGK,iCAAiBA,wBAA6B;","names":["PredefinedTimePeriod","FunnelStep","DeviceType","JobStatus","listSessionsAsync","getListSessionsJobResult","markSessionAsRecorded","markRecordingsAsDeleted","listSessionsAsync","getListSessionsJobResult","markSessionAsRecorded","markRecordingsAsDeleted","listSessionsAsync","getListSessionsJobResult","markSessionAsRecorded","markRecordingsAsDeleted"]}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
-
|
|
2
|
+
|
|
3
|
+
interface Session {
|
|
3
4
|
/**
|
|
4
5
|
* Session ID.
|
|
5
6
|
* @format GUID
|
|
@@ -7,11 +8,11 @@ export interface Session {
|
|
|
7
8
|
_id?: string;
|
|
8
9
|
}
|
|
9
10
|
/** List sessions async request. */
|
|
10
|
-
|
|
11
|
+
interface ListSessionsAsyncRequest extends ListSessionsAsyncRequestPeriodOneOf, ListSessionsAsyncRequestParamsOneOf {
|
|
11
12
|
/** Custom time period with start & end dates. */
|
|
12
13
|
customTimePeriod?: CustomTimePeriod;
|
|
13
14
|
/** Predefined time period. */
|
|
14
|
-
predefinedTimePeriod?:
|
|
15
|
+
predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;
|
|
15
16
|
/** Navigation flow details. */
|
|
16
17
|
navigationFlow?: NavigationFlowSessionsParams;
|
|
17
18
|
/** Conversion funnel details. The steps in the journey the visitor has taken on the site. */
|
|
@@ -25,14 +26,14 @@ export interface ListSessionsAsyncRequest extends ListSessionsAsyncRequestPeriod
|
|
|
25
26
|
timezone?: string | null;
|
|
26
27
|
}
|
|
27
28
|
/** @oneof */
|
|
28
|
-
|
|
29
|
+
interface ListSessionsAsyncRequestPeriodOneOf {
|
|
29
30
|
/** Custom time period with start & end dates. */
|
|
30
31
|
customTimePeriod?: CustomTimePeriod;
|
|
31
32
|
/** Predefined time period. */
|
|
32
|
-
predefinedTimePeriod?:
|
|
33
|
+
predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;
|
|
33
34
|
}
|
|
34
35
|
/** @oneof */
|
|
35
|
-
|
|
36
|
+
interface ListSessionsAsyncRequestParamsOneOf {
|
|
36
37
|
/** Navigation flow details. */
|
|
37
38
|
navigationFlow?: NavigationFlowSessionsParams;
|
|
38
39
|
/** Conversion funnel details. The steps in the journey the visitor has taken on the site. */
|
|
@@ -41,7 +42,7 @@ export interface ListSessionsAsyncRequestParamsOneOf {
|
|
|
41
42
|
deviceType?: SessionsByDeviceParams;
|
|
42
43
|
}
|
|
43
44
|
/** Custom time period. */
|
|
44
|
-
|
|
45
|
+
interface CustomTimePeriod {
|
|
45
46
|
/**
|
|
46
47
|
* Custom period start date in provided timezone.
|
|
47
48
|
* @format LOCAL_DATE
|
|
@@ -58,7 +59,7 @@ export interface CustomTimePeriod {
|
|
|
58
59
|
* Predefined time period.
|
|
59
60
|
* `THIS_WEEK`begins with Monday.
|
|
60
61
|
*/
|
|
61
|
-
|
|
62
|
+
declare enum PredefinedTimePeriod {
|
|
62
63
|
/** Today. */
|
|
63
64
|
TODAY = "TODAY",
|
|
64
65
|
/** Yesterday. */
|
|
@@ -96,8 +97,10 @@ export declare enum PredefinedTimePeriod {
|
|
|
96
97
|
/** Last 12 months. */
|
|
97
98
|
LAST_12_MONTHS = "LAST_12_MONTHS"
|
|
98
99
|
}
|
|
100
|
+
/** @enumType */
|
|
101
|
+
type PredefinedTimePeriodWithLiterals = PredefinedTimePeriod | 'TODAY' | 'YESTERDAY' | 'LAST_7_DAYS' | 'LAST_14_DAYS' | 'LAST_30_DAYS' | 'LAST_90_DAYS' | 'LAST_28_DAYS' | 'LAST_180_DAYS' | 'LAST_365_DAYS' | 'THIS_WEEK' | 'THIS_MONTH' | 'THIS_QUARTER' | 'THIS_YEAR' | 'LAST_WEEK' | 'LAST_MONTH' | 'LAST_QUARTER' | 'LAST_YEAR' | 'LAST_12_MONTHS';
|
|
99
102
|
/** Navigation flow details. */
|
|
100
|
-
|
|
103
|
+
interface NavigationFlowSessionsParams {
|
|
101
104
|
/**
|
|
102
105
|
* Page interactions, including where the user dropped off. For example:
|
|
103
106
|
* - ["/{Homepage}", "__DROP__"]: Sessions where a user visited the site's homepage and then dropped off.
|
|
@@ -110,14 +113,14 @@ export interface NavigationFlowSessionsParams {
|
|
|
110
113
|
pageInteractions?: string[] | null;
|
|
111
114
|
}
|
|
112
115
|
/** Conversion funnel details, meaning the steps in the journey the visitor has taken on the site. */
|
|
113
|
-
|
|
116
|
+
interface ConversionFunnelSessionsParams {
|
|
114
117
|
/** Funnel step to include. */
|
|
115
|
-
include?:
|
|
118
|
+
include?: FunnelStepWithLiterals;
|
|
116
119
|
/** Funnel step to exclude. */
|
|
117
|
-
exclude?:
|
|
120
|
+
exclude?: FunnelStepWithLiterals;
|
|
118
121
|
}
|
|
119
122
|
/** Funnel step. */
|
|
120
|
-
|
|
123
|
+
declare enum FunnelStep {
|
|
121
124
|
/** Not selected. */
|
|
122
125
|
NOT_SELECTED_FUNNEL_STEP = "NOT_SELECTED_FUNNEL_STEP",
|
|
123
126
|
/** Site sessions. */
|
|
@@ -131,13 +134,15 @@ export declare enum FunnelStep {
|
|
|
131
134
|
/** Sessions converted. */
|
|
132
135
|
SESSIONS_CONVERTED = "SESSIONS_CONVERTED"
|
|
133
136
|
}
|
|
137
|
+
/** @enumType */
|
|
138
|
+
type FunnelStepWithLiterals = FunnelStep | 'NOT_SELECTED_FUNNEL_STEP' | 'SITE_SESSIONS' | 'VIEWED_PRODUCT' | 'ADDED_TO_CART' | 'REACHED_CHECKOUT' | 'SESSIONS_CONVERTED';
|
|
134
139
|
/** Device details. */
|
|
135
|
-
|
|
140
|
+
interface SessionsByDeviceParams {
|
|
136
141
|
/** Device type. */
|
|
137
|
-
type?:
|
|
142
|
+
type?: DeviceTypeWithLiterals;
|
|
138
143
|
}
|
|
139
144
|
/** Device type. */
|
|
140
|
-
|
|
145
|
+
declare enum DeviceType {
|
|
141
146
|
/** Not selected. */
|
|
142
147
|
NOT_SELECTED_DEVICE_TYPE = "NOT_SELECTED_DEVICE_TYPE",
|
|
143
148
|
/** Desktop. */
|
|
@@ -149,8 +154,10 @@ export declare enum DeviceType {
|
|
|
149
154
|
/** All. */
|
|
150
155
|
ALL = "ALL"
|
|
151
156
|
}
|
|
157
|
+
/** @enumType */
|
|
158
|
+
type DeviceTypeWithLiterals = DeviceType | 'NOT_SELECTED_DEVICE_TYPE' | 'DESKTOP' | 'MOBILE' | 'TABLET' | 'ALL';
|
|
152
159
|
/** List sessions async response. */
|
|
153
|
-
|
|
160
|
+
interface ListSessionsAsyncResponse {
|
|
154
161
|
/**
|
|
155
162
|
* List sessions job ID.
|
|
156
163
|
* Pass this ID to Get List Sessions Job Result to retrieve job details and metadata.
|
|
@@ -159,7 +166,7 @@ export interface ListSessionsAsyncResponse {
|
|
|
159
166
|
jobId?: string;
|
|
160
167
|
}
|
|
161
168
|
/** Get list sessions job result request. */
|
|
162
|
-
|
|
169
|
+
interface GetListSessionsJobResultRequest {
|
|
163
170
|
/**
|
|
164
171
|
* List sessions job ID.
|
|
165
172
|
* @format GUID
|
|
@@ -175,14 +182,14 @@ export interface GetListSessionsJobResultRequest {
|
|
|
175
182
|
offset: number;
|
|
176
183
|
}
|
|
177
184
|
/** Get list sessions job result response. */
|
|
178
|
-
|
|
185
|
+
interface GetListSessionsJobResultResponse {
|
|
179
186
|
/** List sessions job result data. */
|
|
180
187
|
result?: JobResult;
|
|
181
188
|
}
|
|
182
189
|
/** List sessions job result. */
|
|
183
|
-
|
|
190
|
+
interface JobResult {
|
|
184
191
|
/** Job status. */
|
|
185
|
-
jobStatus?:
|
|
192
|
+
jobStatus?: JobStatusWithLiterals;
|
|
186
193
|
/** Total number of sessions. */
|
|
187
194
|
total?: number | null;
|
|
188
195
|
/**
|
|
@@ -193,7 +200,7 @@ export interface JobResult {
|
|
|
193
200
|
sessionIds?: string[];
|
|
194
201
|
}
|
|
195
202
|
/** Job status. */
|
|
196
|
-
|
|
203
|
+
declare enum JobStatus {
|
|
197
204
|
/** Unknown. */
|
|
198
205
|
UNKNOWN_JOB_STATUS = "UNKNOWN_JOB_STATUS",
|
|
199
206
|
/** In progress. */
|
|
@@ -203,12 +210,14 @@ export declare enum JobStatus {
|
|
|
203
210
|
/** Error. */
|
|
204
211
|
ERROR = "ERROR"
|
|
205
212
|
}
|
|
213
|
+
/** @enumType */
|
|
214
|
+
type JobStatusWithLiterals = JobStatus | 'UNKNOWN_JOB_STATUS' | 'IN_PROGRESS' | 'FINISHED' | 'ERROR';
|
|
206
215
|
/** Request for getting store conversion sessions. */
|
|
207
|
-
|
|
216
|
+
interface CountFunnelSessionsRequest extends CountFunnelSessionsRequestPeriodOneOf {
|
|
208
217
|
/** Custom time period with start & end dates. */
|
|
209
218
|
customTimePeriod?: CustomTimePeriod;
|
|
210
219
|
/** Predefined time period. */
|
|
211
|
-
predefinedTimePeriod?:
|
|
220
|
+
predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;
|
|
212
221
|
/**
|
|
213
222
|
* User timezone. If not provided it will be taken from site properties.
|
|
214
223
|
* @maxLength 100
|
|
@@ -216,19 +225,19 @@ export interface CountFunnelSessionsRequest extends CountFunnelSessionsRequestPe
|
|
|
216
225
|
timezone?: string | null;
|
|
217
226
|
}
|
|
218
227
|
/** @oneof */
|
|
219
|
-
|
|
228
|
+
interface CountFunnelSessionsRequestPeriodOneOf {
|
|
220
229
|
/** Custom time period with start & end dates. */
|
|
221
230
|
customTimePeriod?: CustomTimePeriod;
|
|
222
231
|
/** Predefined time period. */
|
|
223
|
-
predefinedTimePeriod?:
|
|
232
|
+
predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;
|
|
224
233
|
}
|
|
225
234
|
/** Response for getting store conversion sessions. */
|
|
226
|
-
|
|
235
|
+
interface CountFunnelSessionsResponse {
|
|
227
236
|
/** Recordings. */
|
|
228
237
|
recordings?: Recordings;
|
|
229
238
|
}
|
|
230
239
|
/** Recordings. */
|
|
231
|
-
|
|
240
|
+
interface Recordings {
|
|
232
241
|
/** Saved Session count. */
|
|
233
242
|
siteSessions?: number | null;
|
|
234
243
|
/** Saved Sessions with Product Views */
|
|
@@ -241,11 +250,11 @@ export interface Recordings {
|
|
|
241
250
|
convertedSessions?: number | null;
|
|
242
251
|
}
|
|
243
252
|
/** Request for getting the total number of sessions. */
|
|
244
|
-
|
|
253
|
+
interface CountSessionsRequest extends CountSessionsRequestPeriodOneOf {
|
|
245
254
|
/** Custom time period with start & end dates. */
|
|
246
255
|
customTimePeriod?: CustomTimePeriod;
|
|
247
256
|
/** Predefined time period. */
|
|
248
|
-
predefinedTimePeriod?:
|
|
257
|
+
predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;
|
|
249
258
|
/**
|
|
250
259
|
* User timezone. If not provided it will be taken from site properties.
|
|
251
260
|
* @maxLength 100
|
|
@@ -253,19 +262,19 @@ export interface CountSessionsRequest extends CountSessionsRequestPeriodOneOf {
|
|
|
253
262
|
timezone?: string | null;
|
|
254
263
|
}
|
|
255
264
|
/** @oneof */
|
|
256
|
-
|
|
265
|
+
interface CountSessionsRequestPeriodOneOf {
|
|
257
266
|
/** Custom time period with start & end dates. */
|
|
258
267
|
customTimePeriod?: CustomTimePeriod;
|
|
259
268
|
/** Predefined time period. */
|
|
260
|
-
predefinedTimePeriod?:
|
|
269
|
+
predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;
|
|
261
270
|
}
|
|
262
271
|
/** Response for getting the total number of sessions. */
|
|
263
|
-
|
|
272
|
+
interface CountSessionsResponse {
|
|
264
273
|
/** Total number of sessions. */
|
|
265
274
|
sessions?: number;
|
|
266
275
|
}
|
|
267
276
|
/** Mark a browser session as recorded. */
|
|
268
|
-
|
|
277
|
+
interface MarkSessionAsRecordedRequest {
|
|
269
278
|
/**
|
|
270
279
|
* Browser session ID.
|
|
271
280
|
* @minLength 1
|
|
@@ -274,10 +283,10 @@ export interface MarkSessionAsRecordedRequest {
|
|
|
274
283
|
sessionId: string;
|
|
275
284
|
}
|
|
276
285
|
/** Mark a browser session as recorded. */
|
|
277
|
-
|
|
286
|
+
interface MarkSessionAsRecordedResponse {
|
|
278
287
|
}
|
|
279
288
|
/** Marks browser session recordings as deleted. */
|
|
280
|
-
|
|
289
|
+
interface MarkRecordingsAsDeletedRequest {
|
|
281
290
|
/**
|
|
282
291
|
* Browser session IDs.
|
|
283
292
|
* @minSize 1
|
|
@@ -288,7 +297,7 @@ export interface MarkRecordingsAsDeletedRequest {
|
|
|
288
297
|
sessionIds: string[];
|
|
289
298
|
}
|
|
290
299
|
/** Marks browser session recordings as deleted. */
|
|
291
|
-
|
|
300
|
+
interface MarkRecordingsAsDeletedResponse {
|
|
292
301
|
}
|
|
293
302
|
/**
|
|
294
303
|
* Start an async job to retrieve a list of session IDs, given the specified filters. The following filters **must** be passed:
|
|
@@ -303,18 +312,16 @@ export interface MarkRecordingsAsDeletedResponse {
|
|
|
303
312
|
*
|
|
304
313
|
* - Session filter, either navigation flow (page interactions), conversion funnel steps, or device type.
|
|
305
314
|
* @permissionId ANALYTICS_AND_REPORTS.SESSIONS_READ
|
|
306
|
-
* @permissionScope Manage Session Recording Analytics - all permissions
|
|
307
|
-
* @permissionScopeId SCOPE.DC-ANALYTICS-AND-REPORTS.MANAGE-SESSIONS
|
|
308
315
|
* @applicableIdentity APP
|
|
309
316
|
* @returns List sessions async response.
|
|
310
317
|
* @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.ListSessionsAsync
|
|
311
318
|
*/
|
|
312
|
-
|
|
313
|
-
|
|
319
|
+
declare function listSessionsAsync(options?: ListSessionsAsyncOptions): Promise<NonNullablePaths<ListSessionsAsyncResponse, `jobId`, 2>>;
|
|
320
|
+
interface ListSessionsAsyncOptions extends ListSessionsAsyncOptionsPeriodOneOf, ListSessionsAsyncOptionsParamsOneOf {
|
|
314
321
|
/** Custom time period with start & end dates. */
|
|
315
322
|
customTimePeriod?: CustomTimePeriod;
|
|
316
323
|
/** Predefined time period. */
|
|
317
|
-
predefinedTimePeriod?:
|
|
324
|
+
predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;
|
|
318
325
|
/**
|
|
319
326
|
* 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).
|
|
320
327
|
* @maxLength 100
|
|
@@ -328,14 +335,14 @@ export interface ListSessionsAsyncOptions extends ListSessionsAsyncOptionsPeriod
|
|
|
328
335
|
deviceType?: SessionsByDeviceParams;
|
|
329
336
|
}
|
|
330
337
|
/** @oneof */
|
|
331
|
-
|
|
338
|
+
interface ListSessionsAsyncOptionsPeriodOneOf {
|
|
332
339
|
/** Custom time period with start & end dates. */
|
|
333
340
|
customTimePeriod?: CustomTimePeriod;
|
|
334
341
|
/** Predefined time period. */
|
|
335
|
-
predefinedTimePeriod?:
|
|
342
|
+
predefinedTimePeriod?: PredefinedTimePeriodWithLiterals;
|
|
336
343
|
}
|
|
337
344
|
/** @oneof */
|
|
338
|
-
|
|
345
|
+
interface ListSessionsAsyncOptionsParamsOneOf {
|
|
339
346
|
/** Navigation flow details. */
|
|
340
347
|
navigationFlow?: NavigationFlowSessionsParams;
|
|
341
348
|
/** Conversion funnel details. The steps in the journey the visitor has taken on the site. */
|
|
@@ -353,14 +360,12 @@ export interface ListSessionsAsyncOptionsParamsOneOf {
|
|
|
353
360
|
* @requiredField options.offset
|
|
354
361
|
* @param options - Field options. The `limit` and `offset` filters **must** be passed.
|
|
355
362
|
* @permissionId ANALYTICS_AND_REPORTS.SESSIONS_READ
|
|
356
|
-
* @permissionScope Manage Session Recording Analytics - all permissions
|
|
357
|
-
* @permissionScopeId SCOPE.DC-ANALYTICS-AND-REPORTS.MANAGE-SESSIONS
|
|
358
363
|
* @applicableIdentity APP
|
|
359
364
|
* @returns Get list sessions job result response.
|
|
360
365
|
* @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.GetListSessionsJobResult
|
|
361
366
|
*/
|
|
362
|
-
|
|
363
|
-
|
|
367
|
+
declare function getListSessionsJobResult(jobId: string, options: NonNullablePaths<GetListSessionsJobResultOptions, `limit` | `offset`, 2>): Promise<NonNullablePaths<GetListSessionsJobResultResponse, `result.jobStatus` | `result.sessionIds`, 3>>;
|
|
368
|
+
interface GetListSessionsJobResultOptions {
|
|
364
369
|
/**
|
|
365
370
|
* Number of items to load.
|
|
366
371
|
* @min 1
|
|
@@ -376,23 +381,21 @@ export interface GetListSessionsJobResultOptions {
|
|
|
376
381
|
* @public
|
|
377
382
|
* @requiredField sessionId
|
|
378
383
|
* @permissionId ANALYTICS_AND_REPORTS.SESSIONS_UPDATE
|
|
379
|
-
* @permissionScope Manage Session Recording Analytics - all permissions
|
|
380
|
-
* @permissionScopeId SCOPE.DC-ANALYTICS-AND-REPORTS.MANAGE-SESSIONS
|
|
381
384
|
* @applicableIdentity APP
|
|
382
385
|
* @returns Mark a browser session as recorded.
|
|
383
386
|
* @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.MarkSessionAsRecorded
|
|
384
387
|
*/
|
|
385
|
-
|
|
388
|
+
declare function markSessionAsRecorded(sessionId: string): Promise<void>;
|
|
386
389
|
/**
|
|
387
390
|
* Marks browser session recordings as deleted.
|
|
388
391
|
* @param sessionIds - Browser session IDs.
|
|
389
392
|
* @public
|
|
390
393
|
* @requiredField sessionIds
|
|
391
394
|
* @permissionId ANALYTICS_AND_REPORTS.SESSIONS_UPDATE
|
|
392
|
-
* @permissionScope Manage Session Recording Analytics - all permissions
|
|
393
|
-
* @permissionScopeId SCOPE.DC-ANALYTICS-AND-REPORTS.MANAGE-SESSIONS
|
|
394
395
|
* @applicableIdentity APP
|
|
395
396
|
* @returns Marks browser session recordings as deleted.
|
|
396
397
|
* @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.MarkRecordingsAsDeleted
|
|
397
398
|
*/
|
|
398
|
-
|
|
399
|
+
declare function markRecordingsAsDeleted(sessionIds: string[]): Promise<void>;
|
|
400
|
+
|
|
401
|
+
export { type ConversionFunnelSessionsParams, type CountFunnelSessionsRequest, type CountFunnelSessionsRequestPeriodOneOf, type CountFunnelSessionsResponse, type CountSessionsRequest, type CountSessionsRequestPeriodOneOf, type CountSessionsResponse, type CustomTimePeriod, DeviceType, type DeviceTypeWithLiterals, FunnelStep, type FunnelStepWithLiterals, type GetListSessionsJobResultOptions, type GetListSessionsJobResultRequest, type GetListSessionsJobResultResponse, type JobResult, JobStatus, type JobStatusWithLiterals, type ListSessionsAsyncOptions, type ListSessionsAsyncOptionsParamsOneOf, type ListSessionsAsyncOptionsPeriodOneOf, type ListSessionsAsyncRequest, type ListSessionsAsyncRequestParamsOneOf, type ListSessionsAsyncRequestPeriodOneOf, type ListSessionsAsyncResponse, type MarkRecordingsAsDeletedRequest, type MarkRecordingsAsDeletedResponse, type MarkSessionAsRecordedRequest, type MarkSessionAsRecordedResponse, type NavigationFlowSessionsParams, PredefinedTimePeriod, type PredefinedTimePeriodWithLiterals, type Recordings, type Session, type SessionsByDeviceParams, getListSessionsJobResult, listSessionsAsync, markRecordingsAsDeleted, markSessionAsRecorded };
|