@wix/redirects 1.0.0 → 1.0.2

package/build/cjs/src/headless-v1-redirect-session.http.d.ts

@@ -1,4 +1,15 @@
 import { RequestOptionsFactory } from '@wix/sdk-types';
 import { CreateRedirectSessionRequest, CreateRedirectSessionResponse } from './headless-v1-redirect-session.types';
-/** Creates a new WixUrl */
+/**
+ * Creates a URL for redirecting a visitor or member from an external Wix Headless client site to a Wix page for Wix-managed functionality.
+ *
+ *
+ * The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to let Wix take care of frontend functionality for specific processes,
+ * including authentication, as well as checkouts for bookings, eCommerce, events, and paid plans.
+ *
+ * For each purpose, call Create Redirect Session with the relevant information to enable Wix to take care of one specific process, and provide a callback URL, so Wix can redirect
+ * the user back to the appropriate page on your site.
+ *
+ * Redirect your visitor or member to the URL provided in the response, which includes query parameters informing Wix where to redirect the visitor or member back to on the Wix Headless client site
+ */
 export declare function createRedirectSession(payload: CreateRedirectSessionRequest): RequestOptionsFactory<CreateRedirectSessionResponse>;

package/build/cjs/src/headless-v1-redirect-session.http.js

@@ -22,7 +22,18 @@ function resolveWixHeadlessV1RedirectSessionServiceUrl(opts) {
     };
     return (0, metro_runtime_1.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
-/** Creates a new WixUrl */
+/**
+ * Creates a URL for redirecting a visitor or member from an external Wix Headless client site to a Wix page for Wix-managed functionality.
+ *
+ *
+ * The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to let Wix take care of frontend functionality for specific processes,
+ * including authentication, as well as checkouts for bookings, eCommerce, events, and paid plans.
+ *
+ * For each purpose, call Create Redirect Session with the relevant information to enable Wix to take care of one specific process, and provide a callback URL, so Wix can redirect
+ * the user back to the appropriate page on your site.
+ *
+ * Redirect your visitor or member to the URL provided in the response, which includes query parameters informing Wix where to redirect the visitor or member back to on the Wix Headless client site
+ */
 function createRedirectSession(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_createRedirectSessionRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_createRedirectSessionResponse, {});

package/build/cjs/src/headless-v1-redirect-session.http.js.map

@@ -1 +1 @@
-{"version":3,"file":"headless-v1-redirect-session.http.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAQhD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,2BAA2B;AAC3B,SAAgB,qBAAqB,CACnC,OAAqC;IAErC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,6BAA6B,EAC7B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IAE7E,SAAS,uBAAuB,CAAC,EAAE,IAAI,EAAO;QAC5C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,kCAAkC;YAC9C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,sBAAsB;gBACjC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,uBAAuB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1C,OAAO,uBAAuB,CAAC;AACjC,CAAC;AA9BD,sDA8BC"}
+{"version":3,"file":"headless-v1-redirect-session.http.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.http.ts"],"names":[],"mappings":";;;AAAA,8DAA2D;AAC3D,sDAAgD;AAQhD,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAE1C,SAAS,6CAA6C,CACpD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,qBAAqB,CACnC,OAAqC;IAErC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,6BAA6B,EAC7B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IAE7E,SAAS,uBAAuB,CAAC,EAAE,IAAI,EAAO;QAC5C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,kCAAkC;YAC9C,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8DAA8D;YACzE,GAAG,EAAE,6CAA6C,CAAC;gBACjD,SAAS,EAAE,sBAAsB;gBACjC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,uBAAuB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1C,OAAO,uBAAuB,CAAC;AACjC,CAAC;AA9BD,sDA8BC"}

package/build/cjs/src/headless-v1-redirect-session.public.d.ts

@@ -4,5 +4,5 @@ export declare const __metadata: {
     PACKAGE_NAME: string;
 };
 export declare function createRedirectSession(httpClient: HttpClient): (options?: CreateRedirectSessionOptions | undefined) => Promise<import("./headless-v1-redirect-session.universal").CreateRedirectSessionResponse>;
-export { LocationType, CallbackType, } from './headless-v1-redirect-session.universal';
-export { RedirectSession, CreateRedirectSessionRequest, CreateRedirectSessionRequestIntentOneOf, RedirectSessionBookingsCheckoutParams, SlotAvailability, Slot, SlotResource, Location, WaitingList, BookingPolicyViolations, RedirectSessionEcomCheckoutParams, RedirectSessionEventsCheckoutParams, RedirectSessionPaidPlansCheckoutParams, RedirectSessionLoginParams, RedirectSessionAuthorizeParams, AuthorizeRequest, RedirectSessionLogoutParams, RedirectSessionAuthParams, CallbackParams, RedirectSessionPreferences, CreateRedirectSessionResponse, ValidateCallbackURLRequest, ValidateCallbackURLResponse, SignInURLRequest, SignInURLResponse, CreateRedirectSessionOptions, } from './headless-v1-redirect-session.universal';
+export { LocationType, MembersAccountSection, CallbackType, } from './headless-v1-redirect-session.universal';
+export { RedirectSession, CreateRedirectSessionRequest, CreateRedirectSessionRequestIntentOneOf, RedirectSessionBookingsCheckoutParams, SlotAvailability, Slot, SlotResource, Location, WaitingList, BookingPolicyViolations, RedirectSessionEcomCheckoutParams, RedirectSessionEventsCheckoutParams, RedirectSessionPaidPlansCheckoutParams, RedirectSessionLoginParams, RedirectSessionAuthorizeParams, AuthorizeRequest, RedirectSessionLogoutParams, RedirectSessionAuthParams, RedirectSessionMembersAccountParams, CallbackParams, RedirectSessionPreferences, CustomMemberPaths, CreateRedirectSessionResponse, ValidateCallbackURLRequest, ValidateCallbackURLResponse, SignInURLRequest, SignInURLResponse, CreateRedirectSessionOptions, } from './headless-v1-redirect-session.universal';

package/build/cjs/src/headless-v1-redirect-session.public.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CallbackType = exports.LocationType = exports.createRedirectSession = exports.__metadata = void 0;
+exports.CallbackType = exports.MembersAccountSection = exports.LocationType = exports.createRedirectSession = exports.__metadata = void 0;
 const headless_v1_redirect_session_universal_1 = require("./headless-v1-redirect-session.universal");
 exports.__metadata = { PACKAGE_NAME: '@wix/redirects' };
 function createRedirectSession(httpClient) {
@@ -11,5 +11,6 @@ function createRedirectSession(httpClient) {
 exports.createRedirectSession = createRedirectSession;
 var headless_v1_redirect_session_universal_2 = require("./headless-v1-redirect-session.universal");
 Object.defineProperty(exports, "LocationType", { enumerable: true, get: function () { return headless_v1_redirect_session_universal_2.LocationType; } });
+Object.defineProperty(exports, "MembersAccountSection", { enumerable: true, get: function () { return headless_v1_redirect_session_universal_2.MembersAccountSection; } });
 Object.defineProperty(exports, "CallbackType", { enumerable: true, get: function () { return headless_v1_redirect_session_universal_2.CallbackType; } });
 //# sourceMappingURL=headless-v1-redirect-session.public.js.map

package/build/cjs/src/headless-v1-redirect-session.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"headless-v1-redirect-session.public.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.public.ts"],"names":[],"mappings":";;;AACA,qGAGkD;AAErC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC;AAE7D,SAAgB,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,CAAC,OAAsC,EAAE,EAAE,CAChD,IAAA,8DAA8B,EAC5B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sDAOC;AAED,mGAGkD;AAFhD,sIAAA,YAAY,OAAA;AACZ,sIAAA,YAAY,OAAA"}
+{"version":3,"file":"headless-v1-redirect-session.public.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.public.ts"],"names":[],"mappings":";;;AACA,qGAGkD;AAErC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC;AAE7D,SAAgB,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,CAAC,OAAsC,EAAE,EAAE,CAChD,IAAA,8DAA8B,EAC5B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sDAOC;AAED,mGAIkD;AAHhD,sIAAA,YAAY,OAAA;AACZ,+IAAA,qBAAqB,OAAA;AACrB,sIAAA,YAAY,OAAA"}

package/build/cjs/src/headless-v1-redirect-session.types.d.ts

@@ -1,56 +1,56 @@
-/** WixUrl is the main entity of WixUrlService that can be used for lorem ipsum dolor */
+/** Information for redirecting a visitor or member from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
 export interface RedirectSession {
-    /** A guid representing the redirect session (for future use) */
+    /** ID of the redirect session created. */
     id?: string;
     /**
-     * The Wix URL to redirect into
+     * The full URL of the Wix page to redirect the visitor or member to. This URL includes query parameters informing Wix where to redirect the visitor or member back to on the Wix Headless client site.
      * @readonly
      */
     fullUrl?: string;
 }
 export interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestIntentOneOf {
-    /** The parameters used in order to generate the URL into the Bookings checkout flow */
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
     bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
-    /** The parameters used in order to generate the URL into the Ecom checkout flow */
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
     ecomCheckout?: RedirectSessionEcomCheckoutParams;
-    /** The parameters used in order to generate the URL into the events checkout flow */
+    /** Information required for generating a custom URL for a Wix Events checkout. */
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
-    /** The parameters used in order to generate the URL into the paid plans checkout flow */
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** The parameters used in order to generate the URL into the Wix login page */
+    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
-    /** The parameters used in order to generate the URL to logout from Wix (invalidate token and clear cookies on wix domain) */
+    /** Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser. */
     logout?: RedirectSessionLogoutParams;
-    /** The parameters used in order to generate the URL into the authorize page */
+    /** Information required for generating a custom URL for Wix authentication. */
     auth?: RedirectSessionAuthParams;
-    /** The callbacks (URL) allowing the definition of the pages which should be redirected back to the original site during the flow initiated in Wix */
+    /** Details of pages to redirect the visitor or member back to on the Wix Headless client site. **Note:** When redirecting for authentication, do not pass a callback URL here. */
     callbacks?: CallbackParams;
-    /** Redirect sessions options */
+    /** Optional preferences for customizing redirection to Wix pages. */
     preferences?: RedirectSessionPreferences;
 }
 /** @oneof */
 export interface CreateRedirectSessionRequestIntentOneOf {
-    /** The parameters used in order to generate the URL into the Bookings checkout flow */
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
     bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
-    /** The parameters used in order to generate the URL into the Ecom checkout flow */
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
     ecomCheckout?: RedirectSessionEcomCheckoutParams;
-    /** The parameters used in order to generate the URL into the events checkout flow */
+    /** Information required for generating a custom URL for a Wix Events checkout. */
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
-    /** The parameters used in order to generate the URL into the paid plans checkout flow */
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** The parameters used in order to generate the URL into the Wix login page */
+    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
-    /** The parameters used in order to generate the URL to logout from Wix (invalidate token and clear cookies on wix domain) */
+    /** Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser. */
     logout?: RedirectSessionLogoutParams;
-    /** The parameters used in order to generate the URL into the authorize page */
+    /** Information required for generating a custom URL for Wix authentication. */
     auth?: RedirectSessionAuthParams;
 }
 export interface RedirectSessionBookingsCheckoutParams {
-    /** The timezone used for presentation and formatting when presenting the selected slot in a human readable format */
+    /** The timezone to use when presenting the selected slot to users. In [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. For example, `America/Santiago`. */
     timezone?: string;
-    /** (Required) The ID of the service used in order to select the slot */
+    /** *Required.** ID of the service for which to select the slot. Use [Query Services](https://dev.wix.com/api/rest/wix-bookings/services-v2/query-services) to obtain a service ID. */
     serviceId?: string;
-    /** (Required) The selected calendar slots to checkout */
+    /** *Required.** The calendar slot to check out. */
     slotAvailability?: SlotAvailability;
 }
 export interface SlotAvailability {
@@ -179,19 +179,22 @@ export interface BookingPolicyViolations {
     bookOnlineDisabled?: boolean | null;
 }
 export interface RedirectSessionEcomCheckoutParams {
-    /** (Required) The ID of the checkout entity used in order to start the checkout with */
+    /** *Required.** ID of the checkout to process. Use [Create Checkout From Cart](https://dev.wix.com/api/rest/wix-ecommerce/cart/create-checkout-from-cart) to create a checkout and obtain an ID. */
     checkoutId?: string;
 }
 export interface RedirectSessionEventsCheckoutParams {
-    /** (Required) The ID of the selected event */
+    /** *Required.** ID of the temporary event reservation. Use [Create Reservation](https://dev.wix.com/api/rest/wix-events/wix-events/checkout/create-reservation) to reserve a ticket temporarily and obtain a reservation ID. */
     reservationId?: string;
-    /** (Required) The slug of the selected event (url friendly name) */
+    /** *Required.** URL-friendly event slug, generated from the event title of the event. For example, `my-event-4`. Use [Query Events](https://dev.wix.com/api/rest/wix-events/wix-events/event/query-events) to obtain an event slug. */
     eventSlug?: string;
 }
 export interface RedirectSessionPaidPlansCheckoutParams {
-    /** (Required) The ID of the selected paid plan */
+    /** *Required.** ID of the paid plan selected. Use [Query Public Plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/query-public-plans) to obtain a paid plan ID. */
     planId?: string;
-    /** The encoded string representing the navigation defined for the end of the flow, probably received by wix site when navigating to headless */
+    /**
+     * For use when pricing plan selection is part of a checkout flow and the paid plan selection page is implemented on the external Wix Headless client site.
+     * In this case, a string is passed to the external pricing plans page as `checkoutData` query parameter. Pass this string here when redirecting back to Wix.
+     */
     checkoutData?: string | null;
 }
 export interface RedirectSessionLoginParams {
@@ -251,33 +254,88 @@ export interface AuthorizeRequest {
     errorDescription?: string | null;
 }
 export interface RedirectSessionLogoutParams {
-    /** (Required) The oauth app id used */
+    /** *Required.** ID of the OAuth app authorizing the client. */
     clientId?: string;
 }
 export interface RedirectSessionAuthParams {
-    /** (Required) The authorization request to be sent to the authorization server */
+    /** *Required.** The authorization request to send to the authorization server. */
     authRequest?: AuthorizeRequest;
 }
+export interface RedirectSessionMembersAccountParams {
+    /**
+     * The member account page to redirect to.
+     *
+     * Default: `ACCOUNT_INFO`
+     */
+    section?: MembersAccountSection;
+}
+export declare enum MembersAccountSection {
+    /** default - account info section in "my account" */
+    ACCOUNT_INFO = "ACCOUNT_INFO",
+    /** My Bookings section in "my account" */
+    BOOKINGS = "BOOKINGS",
+    /** My Orders section in "my account" */
+    ORDERS = "ORDERS",
+    /** Subscriptions section in "my account" */
+    SUBSCRIPTIONS = "SUBSCRIPTIONS",
+    /** Events section in "my account" */
+    EVENTS = "EVENTS"
+}
 export interface CallbackParams {
-    /** An external thank you page URL, used when the thank you page is implemented outside of Wix */
+    /**
+     * The URL for a custom thank you page implemented on a site outside of Wix. The visitor or member is directed to this page at the end of the Wix-managed process.
+     * If the process is abandoned or interrupted, the visitor or member is redirected to the URL specified in `postFlowUrl`.
+     *
+     * Default: If you don't pass a URL, the visitor or member is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
+     */
     thankYouPageUrl?: string | null;
-    /** The external home page URL, used in order to indicate where to redirect to at the end of the flow (after thank you page/error) */
+    /**
+     * The URL Wix should redirect the visitor or member to when the Wix-managed process is completed, abandoned, or interrupted.
+     *
+     * **Note**: For an authentication redirect, you don't need to pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
+     */
     postFlowUrl?: string | null;
-    /** An external pricing plans page URL, used in case the checkout allows payment with a paid plans */
-    plansListUrl?: string | null;
-    /** An external login page in case login form is implemented outside Wix */
+    /**
+     * The URL for a custom login page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix login page is used.
+     */
     loginUrl?: string | null;
-    /** An external service list page URL (Bookings Services), used when the services page is implemented outside of Wix */
+    /**
+     * The URL for a custom bookings services page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix bookings services page is used.
+     */
     bookingsServiceListUrl?: string | null;
-    /** An external cart page URL, used when the cart page is implemented outside of Wix */
+    /**
+     * The URL for a custom eCommerce cart page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix cart page is used.
+     */
     cartPageUrl?: string | null;
+    /**
+     * The URL for a custom pricing plans page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix pricing plans page is used.
+     */
+    planListUrl?: string | null;
 }
 export interface RedirectSessionPreferences {
-    /** (Default: true) - Define whether the base wix site should be used or the template site for all checkouts */
+    /**
+     * Whether to use a standard Wix template for Wix pages to which the visitor is redirected. Set to `false` only for a client of a Wix site with custom pages.
+     *
+     * Default: `true`
+     */
     useGenericWixPages?: boolean | null;
 }
+export interface CustomMemberPaths {
+    /** Path of the account page in the site's members area. Required if `useGenericWixPages` is `false` and the account page path has been changed in the Wix editor. */
+    accountPagePath?: string | null;
+    /** Path of the member profile page in the site's members area. Required if `useGenericWixPages` is `false` and the member profile page path has been changed in the Wix editor. */
+    profilePagePath?: string | null;
+}
 export interface CreateRedirectSessionResponse {
-    /** The Wix URL details to redirect into */
+    /** Details for redirecting the visitor or member to a Wix page. */
     redirectSession?: RedirectSession;
 }
 export interface ValidateCallbackURLRequest {

package/build/cjs/src/headless-v1-redirect-session.types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CallbackType = exports.LocationType = void 0;
+exports.CallbackType = exports.MembersAccountSection = exports.LocationType = void 0;
 var LocationType;
 (function (LocationType) {
     LocationType["UNDEFINED"] = "UNDEFINED";
@@ -8,6 +8,19 @@ var LocationType;
     LocationType["OWNER_CUSTOM"] = "OWNER_CUSTOM";
     LocationType["CUSTOM"] = "CUSTOM";
 })(LocationType = exports.LocationType || (exports.LocationType = {}));
+var MembersAccountSection;
+(function (MembersAccountSection) {
+    /** default - account info section in "my account" */
+    MembersAccountSection["ACCOUNT_INFO"] = "ACCOUNT_INFO";
+    /** My Bookings section in "my account" */
+    MembersAccountSection["BOOKINGS"] = "BOOKINGS";
+    /** My Orders section in "my account" */
+    MembersAccountSection["ORDERS"] = "ORDERS";
+    /** Subscriptions section in "my account" */
+    MembersAccountSection["SUBSCRIPTIONS"] = "SUBSCRIPTIONS";
+    /** Events section in "my account" */
+    MembersAccountSection["EVENTS"] = "EVENTS";
+})(MembersAccountSection = exports.MembersAccountSection || (exports.MembersAccountSection = {}));
 var CallbackType;
 (function (CallbackType) {
     /** Invalid value - default */

package/build/cjs/src/headless-v1-redirect-session.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":";;;AAqKA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AA+ID,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB"}
+{"version":3,"file":"headless-v1-redirect-session.types.js","sourceRoot":"","sources":["../../../src/headless-v1-redirect-session.types.ts"],"names":[],"mappings":";;;AAqKA,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAyHD,IAAY,qBAWX;AAXD,WAAY,qBAAqB;IAC/B,qDAAqD;IACrD,sDAA6B,CAAA;IAC7B,0CAA0C;IAC1C,8CAAqB,CAAA;IACrB,wCAAwC;IACxC,0CAAiB,CAAA;IACjB,4CAA4C;IAC5C,wDAA+B,CAAA;IAC/B,qCAAqC;IACrC,0CAAiB,CAAA;AACnB,CAAC,EAXW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAWhC;AAwED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8BAA8B;IAC9B,mCAAmB,CAAA;IACnB,mDAAmD;IACnD,iCAAiB,CAAA;IACjB,mDAAmD;IACnD,qCAAqB,CAAA;IACrB,sDAAsD;IACtD,uCAAuB,CAAA;AACzB,CAAC,EATW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QASvB"}

package/build/cjs/src/headless-v1-redirect-session.universal.d.ts

@@ -4,59 +4,59 @@ export declare const __debug: {
         off: () => boolean;
     };
 };
-/** WixUrl is the main entity of WixUrlService that can be used for lorem ipsum dolor */
+/** Information for redirecting a visitor or member from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
 export interface RedirectSession {
-    /** A guid representing the redirect session (for future use) */
+    /** ID of the redirect session created. */
     _id?: string;
     /**
-     * The Wix URL to redirect into
+     * The full URL of the Wix page to redirect the visitor or member to. This URL includes query parameters informing Wix where to redirect the visitor or member back to on the Wix Headless client site.
      * @readonly
      */
     fullUrl?: string;
 }
 export interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestIntentOneOf {
-    /** The parameters used in order to generate the URL into the Bookings checkout flow */
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
     bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
-    /** The parameters used in order to generate the URL into the Ecom checkout flow */
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
     ecomCheckout?: RedirectSessionEcomCheckoutParams;
-    /** The parameters used in order to generate the URL into the events checkout flow */
+    /** Information required for generating a custom URL for a Wix Events checkout. */
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
-    /** The parameters used in order to generate the URL into the paid plans checkout flow */
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** The parameters used in order to generate the URL into the Wix login page */
+    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
-    /** The parameters used in order to generate the URL to logout from Wix (invalidate token and clear cookies on wix domain) */
+    /** Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser. */
     logout?: RedirectSessionLogoutParams;
-    /** The parameters used in order to generate the URL into the authorize page */
+    /** Information required for generating a custom URL for Wix authentication. */
     auth?: RedirectSessionAuthParams;
-    /** The callbacks (URL) allowing the definition of the pages which should be redirected back to the original site during the flow initiated in Wix */
+    /** Details of pages to redirect the visitor or member back to on the Wix Headless client site. **Note:** When redirecting for authentication, do not pass a callback URL here. */
     callbacks?: CallbackParams;
-    /** Redirect sessions options */
+    /** Optional preferences for customizing redirection to Wix pages. */
     preferences?: RedirectSessionPreferences;
 }
 /** @oneof */
 export interface CreateRedirectSessionRequestIntentOneOf {
-    /** The parameters used in order to generate the URL into the Bookings checkout flow */
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
     bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
-    /** The parameters used in order to generate the URL into the Ecom checkout flow */
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
     ecomCheckout?: RedirectSessionEcomCheckoutParams;
-    /** The parameters used in order to generate the URL into the events checkout flow */
+    /** Information required for generating a custom URL for a Wix Events checkout. */
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
-    /** The parameters used in order to generate the URL into the paid plans checkout flow */
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** The parameters used in order to generate the URL into the Wix login page */
+    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
-    /** The parameters used in order to generate the URL to logout from Wix (invalidate token and clear cookies on wix domain) */
+    /** Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser. */
     logout?: RedirectSessionLogoutParams;
-    /** The parameters used in order to generate the URL into the authorize page */
+    /** Information required for generating a custom URL for Wix authentication. */
     auth?: RedirectSessionAuthParams;
 }
 export interface RedirectSessionBookingsCheckoutParams {
-    /** The timezone used for presentation and formatting when presenting the selected slot in a human readable format */
+    /** The timezone to use when presenting the selected slot to users. In [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. For example, `America/Santiago`. */
     timezone?: string;
-    /** (Required) The ID of the service used in order to select the slot */
+    /** *Required.** ID of the service for which to select the slot. Use [Query Services](https://dev.wix.com/api/rest/wix-bookings/services-v2/query-services) to obtain a service ID. */
     serviceId?: string;
-    /** (Required) The selected calendar slots to checkout */
+    /** *Required.** The calendar slot to check out. */
     slotAvailability?: SlotAvailability;
 }
 export interface SlotAvailability {
@@ -185,19 +185,22 @@ export interface BookingPolicyViolations {
     bookOnlineDisabled?: boolean | null;
 }
 export interface RedirectSessionEcomCheckoutParams {
-    /** (Required) The ID of the checkout entity used in order to start the checkout with */
+    /** *Required.** ID of the checkout to process. Use [Create Checkout From Cart](https://dev.wix.com/api/rest/wix-ecommerce/cart/create-checkout-from-cart) to create a checkout and obtain an ID. */
     checkoutId?: string;
 }
 export interface RedirectSessionEventsCheckoutParams {
-    /** (Required) The ID of the selected event */
+    /** *Required.** ID of the temporary event reservation. Use [Create Reservation](https://dev.wix.com/api/rest/wix-events/wix-events/checkout/create-reservation) to reserve a ticket temporarily and obtain a reservation ID. */
     reservationId?: string;
-    /** (Required) The slug of the selected event (url friendly name) */
+    /** *Required.** URL-friendly event slug, generated from the event title of the event. For example, `my-event-4`. Use [Query Events](https://dev.wix.com/api/rest/wix-events/wix-events/event/query-events) to obtain an event slug. */
     eventSlug?: string;
 }
 export interface RedirectSessionPaidPlansCheckoutParams {
-    /** (Required) The ID of the selected paid plan */
+    /** *Required.** ID of the paid plan selected. Use [Query Public Plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/query-public-plans) to obtain a paid plan ID. */
     planId?: string;
-    /** The encoded string representing the navigation defined for the end of the flow, probably received by wix site when navigating to headless */
+    /**
+     * For use when pricing plan selection is part of a checkout flow and the paid plan selection page is implemented on the external Wix Headless client site.
+     * In this case, a string is passed to the external pricing plans page as `checkoutData` query parameter. Pass this string here when redirecting back to Wix.
+     */
     checkoutData?: string | null;
 }
 export interface RedirectSessionLoginParams {
@@ -257,33 +260,88 @@ export interface AuthorizeRequest {
     errorDescription?: string | null;
 }
 export interface RedirectSessionLogoutParams {
-    /** (Required) The oauth app id used */
+    /** *Required.** ID of the OAuth app authorizing the client. */
     clientId?: string;
 }
 export interface RedirectSessionAuthParams {
-    /** (Required) The authorization request to be sent to the authorization server */
+    /** *Required.** The authorization request to send to the authorization server. */
     authRequest?: AuthorizeRequest;
 }
+export interface RedirectSessionMembersAccountParams {
+    /**
+     * The member account page to redirect to.
+     *
+     * Default: `ACCOUNT_INFO`
+     */
+    section?: MembersAccountSection;
+}
+export declare enum MembersAccountSection {
+    /** default - account info section in "my account" */
+    ACCOUNT_INFO = "ACCOUNT_INFO",
+    /** My Bookings section in "my account" */
+    BOOKINGS = "BOOKINGS",
+    /** My Orders section in "my account" */
+    ORDERS = "ORDERS",
+    /** Subscriptions section in "my account" */
+    SUBSCRIPTIONS = "SUBSCRIPTIONS",
+    /** Events section in "my account" */
+    EVENTS = "EVENTS"
+}
 export interface CallbackParams {
-    /** An external thank you page URL, used when the thank you page is implemented outside of Wix */
+    /**
+     * The URL for a custom thank you page implemented on a site outside of Wix. The visitor or member is directed to this page at the end of the Wix-managed process.
+     * If the process is abandoned or interrupted, the visitor or member is redirected to the URL specified in `postFlowUrl`.
+     *
+     * Default: If you don't pass a URL, the visitor or member is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
+     */
     thankYouPageUrl?: string | null;
-    /** The external home page URL, used in order to indicate where to redirect to at the end of the flow (after thank you page/error) */
+    /**
+     * The URL Wix should redirect the visitor or member to when the Wix-managed process is completed, abandoned, or interrupted.
+     *
+     * **Note**: For an authentication redirect, you don't need to pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
+     */
     postFlowUrl?: string | null;
-    /** An external pricing plans page URL, used in case the checkout allows payment with a paid plans */
-    plansListUrl?: string | null;
-    /** An external login page in case login form is implemented outside Wix */
+    /**
+     * The URL for a custom login page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix login page is used.
+     */
     loginUrl?: string | null;
-    /** An external service list page URL (Bookings Services), used when the services page is implemented outside of Wix */
+    /**
+     * The URL for a custom bookings services page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix bookings services page is used.
+     */
     bookingsServiceListUrl?: string | null;
-    /** An external cart page URL, used when the cart page is implemented outside of Wix */
+    /**
+     * The URL for a custom eCommerce cart page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix cart page is used.
+     */
     cartPageUrl?: string | null;
+    /**
+     * The URL for a custom pricing plans page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix pricing plans page is used.
+     */
+    planListUrl?: string | null;
 }
 export interface RedirectSessionPreferences {
-    /** (Default: true) - Define whether the base wix site should be used or the template site for all checkouts */
+    /**
+     * Whether to use a standard Wix template for Wix pages to which the visitor is redirected. Set to `false` only for a client of a Wix site with custom pages.
+     *
+     * Default: `true`
+     */
     useGenericWixPages?: boolean | null;
 }
+export interface CustomMemberPaths {
+    /** Path of the account page in the site's members area. Required if `useGenericWixPages` is `false` and the account page path has been changed in the Wix editor. */
+    accountPagePath?: string | null;
+    /** Path of the member profile page in the site's members area. Required if `useGenericWixPages` is `false` and the member profile page path has been changed in the Wix editor. */
+    profilePagePath?: string | null;
+}
 export interface CreateRedirectSessionResponse {
-    /** The Wix URL details to redirect into */
+    /** Details for redirecting the visitor or member to a Wix page. */
     redirectSession?: RedirectSession;
 }
 export interface ValidateCallbackURLRequest {
@@ -317,29 +375,38 @@ export interface SignInURLResponse {
     redirectSession?: RedirectSession;
 }
 /**
- * Creates a new WixUrl
+ * Creates a URL for redirecting a visitor or member from an external Wix Headless client site to a Wix page for Wix-managed functionality.
+ *
+ *
+ * The Create Redirect Session endpoint enables your external Wix Headless client site, built on any platform, to let Wix take care of frontend functionality for specific processes,
+ * including authentication, as well as checkouts for bookings, eCommerce, events, and paid plans.
+ *
+ * For each purpose, call Create Redirect Session with the relevant information to enable Wix to take care of one specific process, and provide a callback URL, so Wix can redirect
+ * the user back to the appropriate page on your site.
+ *
+ * Redirect your visitor or member to the URL provided in the response, which includes query parameters informing Wix where to redirect the visitor or member back to on the Wix Headless client site
  * @public
  * @documentationMaturity preview
  * @requiredField CreateRedirectSessionRequest
  */
 export declare function createRedirectSession(options?: CreateRedirectSessionOptions): Promise<CreateRedirectSessionResponse>;
 export interface CreateRedirectSessionOptions extends CreateRedirectSessionRequestIntentOneOf {
-    /** The parameters used in order to generate the URL into the Bookings checkout flow */
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
     bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
-    /** The parameters used in order to generate the URL into the Ecom checkout flow */
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
     ecomCheckout?: RedirectSessionEcomCheckoutParams;
-    /** The parameters used in order to generate the URL into the events checkout flow */
+    /** Information required for generating a custom URL for a Wix Events checkout. */
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
-    /** The parameters used in order to generate the URL into the paid plans checkout flow */
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** The parameters used in order to generate the URL into the Wix login page */
+    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
-    /** The parameters used in order to generate the URL to logout from Wix (invalidate token and clear cookies on wix domain) */
+    /** Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser. */
     logout?: RedirectSessionLogoutParams;
-    /** The parameters used in order to generate the URL into the authorize page */
+    /** Information required for generating a custom URL for Wix authentication. */
     auth?: RedirectSessionAuthParams;
-    /** The callbacks (URL) allowing the definition of the pages which should be redirected back to the original site during the flow initiated in Wix */
+    /** Details of pages to redirect the visitor or member back to on the Wix Headless client site. **Note:** When redirecting for authentication, do not pass a callback URL here. */
     callbacks?: CallbackParams;
-    /** Redirect sessions options */
+    /** Optional preferences for customizing redirection to Wix pages. */
     preferences?: RedirectSessionPreferences;
 }