@wix/auto_sdk_analytics-session_analytics-session 1.0.5 → 1.0.7

package/build/internal/es/src/analytics-ng-v1-session-analytics-session.universal.js

@@ -1,256 +0,0 @@
-import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
-import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
-import * as ambassadorWixAnalyticsNgV1Session from './analytics-ng-v1-session-analytics-session.http.js';
-/**
- * Predefined time period.
- * `THIS_WEEK`begins with Monday.
- */
-export var PredefinedTimePeriod;
-(function (PredefinedTimePeriod) {
-    /** Today. */
-    PredefinedTimePeriod["TODAY"] = "TODAY";
-    /** Yesterday. */
-    PredefinedTimePeriod["YESTERDAY"] = "YESTERDAY";
-    /** Last 7 days. */
-    PredefinedTimePeriod["LAST_7_DAYS"] = "LAST_7_DAYS";
-    /** Last 14 days. */
-    PredefinedTimePeriod["LAST_14_DAYS"] = "LAST_14_DAYS";
-    /** Last 30 days. */
-    PredefinedTimePeriod["LAST_30_DAYS"] = "LAST_30_DAYS";
-    /** Last 90 days. */
-    PredefinedTimePeriod["LAST_90_DAYS"] = "LAST_90_DAYS";
-    /** Last 28 days. */
-    PredefinedTimePeriod["LAST_28_DAYS"] = "LAST_28_DAYS";
-    /** Last 180 days. */
-    PredefinedTimePeriod["LAST_180_DAYS"] = "LAST_180_DAYS";
-    /** Last 365 days. */
-    PredefinedTimePeriod["LAST_365_DAYS"] = "LAST_365_DAYS";
-    /** Current week, starting on Monday. */
-    PredefinedTimePeriod["THIS_WEEK"] = "THIS_WEEK";
-    /** Current month. */
-    PredefinedTimePeriod["THIS_MONTH"] = "THIS_MONTH";
-    /** Current quarter. */
-    PredefinedTimePeriod["THIS_QUARTER"] = "THIS_QUARTER";
-    /** This year. */
-    PredefinedTimePeriod["THIS_YEAR"] = "THIS_YEAR";
-    /** Last week (previous week). */
-    PredefinedTimePeriod["LAST_WEEK"] = "LAST_WEEK";
-    /** Last month. */
-    PredefinedTimePeriod["LAST_MONTH"] = "LAST_MONTH";
-    /** Last quarter. */
-    PredefinedTimePeriod["LAST_QUARTER"] = "LAST_QUARTER";
-    /** Last year. */
-    PredefinedTimePeriod["LAST_YEAR"] = "LAST_YEAR";
-    /** Last 12 months. */
-    PredefinedTimePeriod["LAST_12_MONTHS"] = "LAST_12_MONTHS";
-})(PredefinedTimePeriod || (PredefinedTimePeriod = {}));
-/** Funnel step. */
-export var FunnelStep;
-(function (FunnelStep) {
-    /** Not selected. */
-    FunnelStep["NOT_SELECTED_FUNNEL_STEP"] = "NOT_SELECTED_FUNNEL_STEP";
-    /** Site sessions. */
-    FunnelStep["SITE_SESSIONS"] = "SITE_SESSIONS";
-    /** Viewed product. */
-    FunnelStep["VIEWED_PRODUCT"] = "VIEWED_PRODUCT";
-    /** Added to cart. */
-    FunnelStep["ADDED_TO_CART"] = "ADDED_TO_CART";
-    /** Reached checkout. */
-    FunnelStep["REACHED_CHECKOUT"] = "REACHED_CHECKOUT";
-    /** Sessions converted. */
-    FunnelStep["SESSIONS_CONVERTED"] = "SESSIONS_CONVERTED";
-})(FunnelStep || (FunnelStep = {}));
-/** Device type. */
-export var DeviceType;
-(function (DeviceType) {
-    /** Not selected. */
-    DeviceType["NOT_SELECTED_DEVICE_TYPE"] = "NOT_SELECTED_DEVICE_TYPE";
-    /** Desktop. */
-    DeviceType["DESKTOP"] = "DESKTOP";
-    /** Mobile. */
-    DeviceType["MOBILE"] = "MOBILE";
-    /** Tablet. */
-    DeviceType["TABLET"] = "TABLET";
-    /** All. */
-    DeviceType["ALL"] = "ALL";
-})(DeviceType || (DeviceType = {}));
-/** Job status. */
-export var JobStatus;
-(function (JobStatus) {
-    /** Unknown. */
-    JobStatus["UNKNOWN_JOB_STATUS"] = "UNKNOWN_JOB_STATUS";
-    /** In progress. */
-    JobStatus["IN_PROGRESS"] = "IN_PROGRESS";
-    /** Finished. */
-    JobStatus["FINISHED"] = "FINISHED";
-    /** Error. */
-    JobStatus["ERROR"] = "ERROR";
-})(JobStatus || (JobStatus = {}));
-/**
- * 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.
- * @public
- * @requiredField options.params
- * @requiredField options.period
- * @param options - 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.
- * @permissionId ANALYTICS_AND_REPORTS.SESSIONS_READ
- * @permissionScope Manage Session Recording Analytics - all permissions
- * @permissionScopeId SCOPE.DC-ANALYTICS-AND-REPORTS.MANAGE-SESSIONS
- * @applicableIdentity APP
- * @returns List sessions async response.
- * @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.ListSessionsAsync
- */
-export async function listSessionsAsync(options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        customTimePeriod: options?.customTimePeriod,
-        predefinedTimePeriod: options?.predefinedTimePeriod,
-        timezone: options?.timezone,
-        navigationFlow: options?.navigationFlow,
-        conversionFunnel: options?.conversionFunnel,
-        deviceType: options?.deviceType,
-    });
-    const reqOpts = ambassadorWixAnalyticsNgV1Session.listSessionsAsync(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                customTimePeriod: '$[0].customTimePeriod',
-                predefinedTimePeriod: '$[0].predefinedTimePeriod',
-                timezone: '$[0].timezone',
-                navigationFlow: '$[0].navigationFlow',
-                conversionFunnel: '$[0].conversionFunnel',
-                deviceType: '$[0].deviceType',
-            },
-            singleArgumentUnchanged: false,
-        }, ['options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Retrieves the job status and a list of session IDs, if ready.
- * @param jobId - List sessions job ID.
- * @public
- * @requiredField jobId
- * @requiredField options
- * @requiredField options.limit
- * @requiredField options.offset
- * @param options - Field options. The `limit` and `offset` filters **must** be passed.
- * @permissionId ANALYTICS_AND_REPORTS.SESSIONS_READ
- * @permissionScope Manage Session Recording Analytics - all permissions
- * @permissionScopeId SCOPE.DC-ANALYTICS-AND-REPORTS.MANAGE-SESSIONS
- * @applicableIdentity APP
- * @returns Get list sessions job result response.
- * @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.GetListSessionsJobResult
- */
-export async function getListSessionsJobResult(jobId, options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        jobId: jobId,
-        limit: options?.limit,
-        offset: options?.offset,
-    });
-    const reqOpts = ambassadorWixAnalyticsNgV1Session.getListSessionsJobResult(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                jobId: '$[0]',
-                limit: '$[1].limit',
-                offset: '$[1].offset',
-            },
-            singleArgumentUnchanged: false,
-        }, ['jobId', 'options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Marks a browser session as recorded.
- * @param sessionId - Browser session ID.
- * @public
- * @requiredField sessionId
- * @permissionId ANALYTICS_AND_REPORTS.SESSIONS_UPDATE
- * @permissionScope Manage Session Recording Analytics - all permissions
- * @permissionScopeId SCOPE.DC-ANALYTICS-AND-REPORTS.MANAGE-SESSIONS
- * @applicableIdentity APP
- * @returns Mark a browser session as recorded.
- * @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.MarkSessionAsRecorded
- */
-export async function markSessionAsRecorded(sessionId) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        sessionId: sessionId,
-    });
-    const reqOpts = ambassadorWixAnalyticsNgV1Session.markSessionAsRecorded(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { sessionId: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['sessionId']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-/**
- * Marks browser session recordings as deleted.
- * @param sessionIds - Browser session IDs.
- * @public
- * @requiredField sessionIds
- * @permissionId ANALYTICS_AND_REPORTS.SESSIONS_UPDATE
- * @permissionScope Manage Session Recording Analytics - all permissions
- * @permissionScopeId SCOPE.DC-ANALYTICS-AND-REPORTS.MANAGE-SESSIONS
- * @applicableIdentity APP
- * @returns Marks browser session recordings as deleted.
- * @fqn wix.analytics_ng.session_ids.v1.SessionIdsService.MarkRecordingsAsDeleted
- */
-export async function markRecordingsAsDeleted(sessionIds) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[1];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        sessionIds: sessionIds,
-    });
-    const reqOpts = ambassadorWixAnalyticsNgV1Session.markRecordingsAsDeleted(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: { sessionIds: '$[0]' },
-            singleArgumentUnchanged: false,
-        }, ['sessionIds']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
-//# sourceMappingURL=analytics-ng-v1-session-analytics-session.universal.js.map

package/build/internal/es/src/analytics-ng-v1-session-analytics-session.universal.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"analytics-ng-v1-session-analytics-session.universal.js","sourceRoot":"","sources":["../../../../src/analytics-ng-v1-session-analytics-session.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,iCAAiC,MAAM,qDAAqD,CAAC;AAgEzG;;;GAGG;AACH,MAAM,CAAN,IAAY,oBAqCX;AArCD,WAAY,oBAAoB;IAC9B,aAAa;IACb,uCAAe,CAAA;IACf,iBAAiB;IACjB,+CAAuB,CAAA;IACvB,mBAAmB;IACnB,mDAA2B,CAAA;IAC3B,oBAAoB;IACpB,qDAA6B,CAAA;IAC7B,oBAAoB;IACpB,qDAA6B,CAAA;IAC7B,oBAAoB;IACpB,qDAA6B,CAAA;IAC7B,oBAAoB;IACpB,qDAA6B,CAAA;IAC7B,qBAAqB;IACrB,uDAA+B,CAAA;IAC/B,qBAAqB;IACrB,uDAA+B,CAAA;IAC/B,wCAAwC;IACxC,+CAAuB,CAAA;IACvB,qBAAqB;IACrB,iDAAyB,CAAA;IACzB,uBAAuB;IACvB,qDAA6B,CAAA;IAC7B,iBAAiB;IACjB,+CAAuB,CAAA;IACvB,iCAAiC;IACjC,+CAAuB,CAAA;IACvB,kBAAkB;IAClB,iDAAyB,CAAA;IACzB,oBAAoB;IACpB,qDAA6B,CAAA;IAC7B,iBAAiB;IACjB,+CAAuB,CAAA;IACvB,sBAAsB;IACtB,yDAAiC,CAAA;AACnC,CAAC,EArCW,oBAAoB,KAApB,oBAAoB,QAqC/B;AAwBD,mBAAmB;AACnB,MAAM,CAAN,IAAY,UAaX;AAbD,WAAY,UAAU;IACpB,oBAAoB;IACpB,mEAAqD,CAAA;IACrD,qBAAqB;IACrB,6CAA+B,CAAA;IAC/B,sBAAsB;IACtB,+CAAiC,CAAA;IACjC,qBAAqB;IACrB,6CAA+B,CAAA;IAC/B,wBAAwB;IACxB,mDAAqC,CAAA;IACrC,0BAA0B;IAC1B,uDAAyC,CAAA;AAC3C,CAAC,EAbW,UAAU,KAAV,UAAU,QAarB;AAQD,mBAAmB;AACnB,MAAM,CAAN,IAAY,UAWX;AAXD,WAAY,UAAU;IACpB,oBAAoB;IACpB,mEAAqD,CAAA;IACrD,eAAe;IACf,iCAAmB,CAAA;IACnB,cAAc;IACd,+BAAiB,CAAA;IACjB,cAAc;IACd,+BAAiB,CAAA;IACjB,WAAW;IACX,yBAAW,CAAA;AACb,CAAC,EAXW,UAAU,KAAV,UAAU,QAWrB;AAiDD,kBAAkB;AAClB,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,eAAe;IACf,sDAAyC,CAAA;IACzC,mBAAmB;IACnB,wCAA2B,CAAA;IAC3B,gBAAgB;IAChB,kCAAqB,CAAA;IACrB,aAAa;IACb,4BAAe,CAAA;AACjB,CAAC,EATW,SAAS,KAAT,SAAS,QASpB;AAmGD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAkC;IAElC,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;QAC3C,oBAAoB,EAAE,OAAO,EAAE,oBAAoB;QACnD,QAAQ,EAAE,OAAO,EAAE,QAAQ;QAC3B,cAAc,EAAE,OAAO,EAAE,cAAc;QACvC,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;QAC3C,UAAU,EAAE,OAAO,EAAE,UAAU;KAChC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,iCAAiC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE7E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,gBAAgB,EAAE,uBAAuB;gBACzC,oBAAoB,EAAE,2BAA2B;gBACjD,QAAQ,EAAE,eAAe;gBACzB,cAAc,EAAE,qBAAqB;gBACrC,gBAAgB,EAAE,uBAAuB;gBACzC,UAAU,EAAE,iBAAiB;aAC9B;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,SAAS,CAAC,CACZ,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAwCD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,KAAa,EACb,OAA8E;IAO9E,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,OAAO,EAAE,KAAK;QACrB,MAAM,EAAE,OAAO,EAAE,MAAM;KACxB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,iCAAiC,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAEtE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,KAAK,EAAE,MAAM;gBACb,KAAK,EAAE,YAAY;gBACnB,MAAM,EAAE,aAAa;aACtB;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,OAAO,EAAE,SAAS,CAAC,CACrB,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAaD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,SAAiB;IAC3D,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,iCAAiC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAEnE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE;YAC/C,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,WAAW,CAAC,CACd,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,UAAoB;IAEpB,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,UAAU,EAAE,UAAU;KACvB,CAAC,CAAC;IAEH,MAAM,OAAO,GACX,iCAAiC,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAErE,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE;YAChD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,YAAY,CAAC,CACf,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}