@wix/redirects 1.0.69 → 1.0.70

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/redirects",
-  "version": "1.0.69",
+  "version": "1.0.70",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,7 +21,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/redirects_redirects": "1.0.38"
+    "@wix/redirects_redirects": "1.0.39"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -46,5 +46,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "f040d5124ea9c54b9cf1c4b66b9c9014709e32e86d70273fde6ea2e8"
+  "falconPackageHash": "2a404887fac18b65166eedcf4483bb5df8fbe666aadfe483744407f2"
 }

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

@@ -485,7 +485,7 @@ interface RedirectSession {
      * @readonly
      */
     fullUrl?: string;
-    /** Details about the URL of the RedirectSession */
+    /** Details about the URL of the redirect session. */
     urlDetails?: URLDetails;
     /**
      * The session token to pass to the Wix page to maintain the visitor's identity.
@@ -500,12 +500,12 @@ interface RedirectSession {
 }
 interface URLDetails {
     /**
-     * The endpoint of the url (includes the base url and the path to the endpoint, without the query parameters)
-     * For example: `https://mysite.com/_api/oauth2/authorize`
+     * Endpoint of the url. This includes the base URL and the path to the endpoint, without query parameters.
+     * For example: `https://mysite.com/_api/oauth2/authorize`.
      * @readonly
      */
     endpoint?: string;
-    /** The query parameters of the url */
+    /** URL query parameters. */
     searchParams?: Record<string, string>;
 }
 interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestIntentOneOf {
@@ -517,7 +517,7 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
     /** 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;
@@ -529,8 +529,10 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
     bookingsBook?: RedirectSessionBookingsBookParams;
     /**
      * Details of pages to redirect the visitor back to on the Wix Headless client site.
+     * When redirecting to any callback URL, Wix specifies the boolean `wixMemberLoggedIn` parameter.
+     * If `true`, a member logged in during the preceding Wix-managed process.
      *
-     * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `auth.authRequest.redirectUri`.
      */
     callbacks?: CallbackParams;
     /** Optional preferences for customizing redirection to Wix pages. */
@@ -546,7 +548,7 @@ interface CreateRedirectSessionRequestIntentOneOf {
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
     /** 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;
@@ -564,7 +566,6 @@ interface RedirectSessionBookingsCheckoutParams {
      * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
      */
     timezone?: string;
-    /** __Required.__ The calendar slot to check out. */
     slotAvailability?: SlotAvailability;
 }
 interface SlotAvailability {
@@ -614,7 +615,7 @@ interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `startDate` is ignored.
+     * in the `start_date` is ignored.
      */
     startDate?: string | null;
     /**
@@ -623,13 +624,13 @@ interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `endDate` is ignored.
+     * in the `end_date` is ignored.
      */
     endDate?: string | null;
     /**
      * The timezone for which slot availability is to be calculated.
      *
-     * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/sdk/bookings/availabilitycalendar/queryavailability#bookings_availabilitycalendar_queryavailability_handling-daylight-savings-time-dst-for-local-time-zones)
+     * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_handling-daylight-savings-time-dst-for-local-time-zones)
      * when calculating availability.
      */
     timezone?: string | null;
@@ -704,17 +705,17 @@ interface NestedTimeSlot {
     scheduleId?: string;
 }
 interface RedirectSessionEcomCheckoutParams {
-    /** __Required.__ ID of the checkout to process. Use [`createCheckout()`](https://dev.wix.com/api/sdk/ecom/checkout/createcheckout) or [`createCheckoutFromCurrentCart()`](https://dev.wix.com/api/sdk/ecom/currentcart/createcheckoutfromcurrentcart) to create a checkout and obtain an ID. */
+    /**
+     * - SDK: Use [Create Checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/create-checkout) or [Create Checkout From Current Cart](https://dev.wix.com/docs/sdk/backend-modules/ecom/current-cart/create-checkout-from-current-cart).
+     * - REST: Use [Create Checkout From Cart](https://dev.wix.com/docs/rest/business-solutions/e-commerce/cart/create-checkout-from-cart).
+     */
     checkoutId?: string;
 }
 interface RedirectSessionEventsCheckoutParams {
-    /** __Required.__ ID of the temporary event reservation. Use [`createReservation()`](https://dev.wix.com/api/sdk/events/checkout/createreservation) to reserve a ticket temporarily and obtain a reservation ID. */
     reservationId?: string;
-    /** __Required.__ URL-friendly event slug, generated from the event title of the event. For example, `my-event-4`. Use [`listEvents()`](https://dev.wix.com/api/sdk/events/wixevents/listevents) to obtain an event slug. */
     eventSlug?: string;
 }
 interface RedirectSessionPaidPlansCheckoutParams {
-    /** __Required.__ ID of the paid plan selected. Use [`queryPublicPlans()`](https://dev.wix.com/api/sdk/pricing-plans/plans/querypublicplans) to obtain a paid plan ID. */
     planId?: string;
     /**
      * For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
@@ -725,12 +726,11 @@ interface RedirectSessionPaidPlansCheckoutParams {
 interface RedirectSessionLoginParams {
 }
 interface RedirectSessionLogoutParams {
-    /** __Required.__ ID of the OAuth app authorizing the client. */
     clientId?: string;
 }
 interface RedirectSessionAuthParams {
-    /** __Required.__ The authorization request to send to the authorization server. */
     authRequest?: AuthorizeRequest;
+    /** prompt type */
     prompt?: Prompt;
 }
 /**
@@ -817,7 +817,6 @@ declare enum MembersAccountSection {
     EVENTS = "EVENTS"
 }
 interface RedirectSessionStoresProductParams {
-    /** *Required.** Slug of the product to navigate to. */
     productSlug?: string;
 }
 interface RedirectSessionBookingsBookParams {
@@ -835,45 +834,45 @@ interface CallbackParams {
      * After an eCommerce checkout:
      * + `orderId`: ID of an eCommerce order.
      *
-     * After an Events checkout
+     * After an Events checkout:
      * + `orderNumber`: Unique order number for the transaction.
      * + `eventId`: ID of the event.
      *
      * If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
      *
-     * Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
+     * Default: If you don't specify a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
      */
     thankYouPageUrl?: string | null;
     /**
      * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
      *
-     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
      */
     postFlowUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix login page is used.
      */
     loginUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix bookings services page is used.
      */
     bookingsServiceListUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix cart page is used.
      */
     cartPageUrl?: string | null;
     /**
-     * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix passes the following query parameters:
+     * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix specifies the following query parameters:
      * + `planIds`:  IDs of the pricing plans on the custom page.
-     * + `checkoutData`: Pass this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
+     * + `checkoutData`: Specify this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
      *
-     *  Default: If you don't pass a URL, a Wix pricing plans page is used.
+     *  Default: If you don't specify a URL, a Wix pricing plans page is used.
      */
     planListUrl?: string | null;
 }
@@ -885,14 +884,14 @@ interface RedirectSessionPreferences {
      */
     useGenericWixPages?: boolean | null;
     /**
-     * Whether to maintain the identity used in the redirect to wix (not relevant for "logout" and "auth" intents), or to use a new visitor identity.
+     * Whether to maintain the identity used in the redirect to Wix (not relevant for `logout` and `auth` intents), or to use a new visitor identity.
      *
      * Default: `true`
      */
     maintainIdentity?: boolean | null;
     /**
-     * A map of additional query parameters to pass to the created Wix URL.
-     * Global query parameters to be passed to Wix, for example campaign parameters (UTM params).
+     * Map of additional global query parameters to add to the created Wix URL.
+     * For example, [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters).
      */
     additionalQueryParameters?: Record<string, string>;
 }
@@ -1190,7 +1189,7 @@ interface CreateRedirectSessionOptions extends CreateRedirectSessionRequestInten
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
     /** 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;
@@ -1201,9 +1200,9 @@ interface CreateRedirectSessionOptions extends CreateRedirectSessionRequestInten
     /** Information required for generating a custom URL for Wix bookings book page. */
     bookingsBook?: RedirectSessionBookingsBookParams;
     /**
-     * Details of pages to redirect the visitor back to on the Wix Headless client site.
+     * Details of pages to redirect back to on the Wix Headless client site.
      *
-     * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
      */
     callbacks?: CallbackParams;
     /** Optional preferences for customizing redirection to Wix pages. */
@@ -1215,13 +1214,12 @@ interface CreateRedirectSessionSignature {
     /**
      * Creates a URL for redirecting a visitor from an external client site to a Wix page for Wix-managed functionality.
      *
-     *
-     * The `createRedirectSession()` function enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
-     * For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
+     * The Create Redirect Session method enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
+     * For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for bookings, eCommerce, events, or paid plans transactions.
      *
      * To initiate a redirect session:
      *
-     * 1. Call `createRedirectSession()` with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect the user back to your site as appropriate when the process is over.
+     * 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect the visitor back to your site as appropriate when the process is over.
      * 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
      * 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
      * @param - Options for creating a redirect session.
@@ -1235,7 +1233,9 @@ declare function createEventModule<T extends EventDefinition<any, string>>(event
 declare const createRedirectSession: MaybeContext<BuildRESTFunction<typeof createRedirectSession$1> & typeof createRedirectSession$1>;
 
 type _publicOnRedirectSessionCreatedType = typeof onRedirectSessionCreated$1;
-/** */
+/**
+ * Triggerd when a redirect session is created
+ */
 declare const onRedirectSessionCreated: ReturnType<typeof createEventModule<_publicOnRedirectSessionCreatedType>>;
 
 type context_ActionEvent = ActionEvent;

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

@@ -485,7 +485,7 @@ interface RedirectSession {
      * @readonly
      */
     fullUrl?: string;
-    /** Details about the URL of the RedirectSession */
+    /** Details about the URL of the redirect session. */
     urlDetails?: URLDetails;
     /**
      * The session token to pass to the Wix page to maintain the visitor's identity.
@@ -500,12 +500,12 @@ interface RedirectSession {
 }
 interface URLDetails {
     /**
-     * The endpoint of the url (includes the base url and the path to the endpoint, without the query parameters)
-     * For example: `https://mysite.com/_api/oauth2/authorize`
+     * Endpoint of the url. This includes the base URL and the path to the endpoint, without query parameters.
+     * For example: `https://mysite.com/_api/oauth2/authorize`.
      * @readonly
      */
     endpoint?: string;
-    /** The query parameters of the url */
+    /** URL query parameters. */
     searchParams?: Record<string, string>;
 }
 interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestIntentOneOf {
@@ -517,7 +517,7 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
     /** 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;
@@ -529,8 +529,10 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
     bookingsBook?: RedirectSessionBookingsBookParams;
     /**
      * Details of pages to redirect the visitor back to on the Wix Headless client site.
+     * When redirecting to any callback URL, Wix specifies the boolean `wixMemberLoggedIn` parameter.
+     * If `true`, a member logged in during the preceding Wix-managed process.
      *
-     * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `auth.authRequest.redirectUri`.
      */
     callbacks?: CallbackParams;
     /** Optional preferences for customizing redirection to Wix pages. */
@@ -546,7 +548,7 @@ interface CreateRedirectSessionRequestIntentOneOf {
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
     /** 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;
@@ -564,7 +566,6 @@ interface RedirectSessionBookingsCheckoutParams {
      * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
      */
     timezone?: string;
-    /** __Required.__ The calendar slot to check out. */
     slotAvailability?: SlotAvailability;
 }
 interface SlotAvailability {
@@ -614,7 +615,7 @@ interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `startDate` is ignored.
+     * in the `start_date` is ignored.
      */
     startDate?: string | null;
     /**
@@ -623,13 +624,13 @@ interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `endDate` is ignored.
+     * in the `end_date` is ignored.
      */
     endDate?: string | null;
     /**
      * The timezone for which slot availability is to be calculated.
      *
-     * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/sdk/bookings/availabilitycalendar/queryavailability#bookings_availabilitycalendar_queryavailability_handling-daylight-savings-time-dst-for-local-time-zones)
+     * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_handling-daylight-savings-time-dst-for-local-time-zones)
      * when calculating availability.
      */
     timezone?: string | null;
@@ -704,17 +705,17 @@ interface NestedTimeSlot {
     scheduleId?: string;
 }
 interface RedirectSessionEcomCheckoutParams {
-    /** __Required.__ ID of the checkout to process. Use [`createCheckout()`](https://dev.wix.com/api/sdk/ecom/checkout/createcheckout) or [`createCheckoutFromCurrentCart()`](https://dev.wix.com/api/sdk/ecom/currentcart/createcheckoutfromcurrentcart) to create a checkout and obtain an ID. */
+    /**
+     * - SDK: Use [Create Checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/create-checkout) or [Create Checkout From Current Cart](https://dev.wix.com/docs/sdk/backend-modules/ecom/current-cart/create-checkout-from-current-cart).
+     * - REST: Use [Create Checkout From Cart](https://dev.wix.com/docs/rest/business-solutions/e-commerce/cart/create-checkout-from-cart).
+     */
     checkoutId?: string;
 }
 interface RedirectSessionEventsCheckoutParams {
-    /** __Required.__ ID of the temporary event reservation. Use [`createReservation()`](https://dev.wix.com/api/sdk/events/checkout/createreservation) to reserve a ticket temporarily and obtain a reservation ID. */
     reservationId?: string;
-    /** __Required.__ URL-friendly event slug, generated from the event title of the event. For example, `my-event-4`. Use [`listEvents()`](https://dev.wix.com/api/sdk/events/wixevents/listevents) to obtain an event slug. */
     eventSlug?: string;
 }
 interface RedirectSessionPaidPlansCheckoutParams {
-    /** __Required.__ ID of the paid plan selected. Use [`queryPublicPlans()`](https://dev.wix.com/api/sdk/pricing-plans/plans/querypublicplans) to obtain a paid plan ID. */
     planId?: string;
     /**
      * For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
@@ -725,12 +726,11 @@ interface RedirectSessionPaidPlansCheckoutParams {
 interface RedirectSessionLoginParams {
 }
 interface RedirectSessionLogoutParams {
-    /** __Required.__ ID of the OAuth app authorizing the client. */
     clientId?: string;
 }
 interface RedirectSessionAuthParams {
-    /** __Required.__ The authorization request to send to the authorization server. */
     authRequest?: AuthorizeRequest;
+    /** prompt type */
     prompt?: Prompt;
 }
 /**
@@ -817,7 +817,6 @@ declare enum MembersAccountSection {
     EVENTS = "EVENTS"
 }
 interface RedirectSessionStoresProductParams {
-    /** *Required.** Slug of the product to navigate to. */
     productSlug?: string;
 }
 interface RedirectSessionBookingsBookParams {
@@ -835,45 +834,45 @@ interface CallbackParams {
      * After an eCommerce checkout:
      * + `orderId`: ID of an eCommerce order.
      *
-     * After an Events checkout
+     * After an Events checkout:
      * + `orderNumber`: Unique order number for the transaction.
      * + `eventId`: ID of the event.
      *
      * If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
      *
-     * Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
+     * Default: If you don't specify a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
      */
     thankYouPageUrl?: string | null;
     /**
      * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
      *
-     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
      */
     postFlowUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix login page is used.
      */
     loginUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix bookings services page is used.
      */
     bookingsServiceListUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix cart page is used.
      */
     cartPageUrl?: string | null;
     /**
-     * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix passes the following query parameters:
+     * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix specifies the following query parameters:
      * + `planIds`:  IDs of the pricing plans on the custom page.
-     * + `checkoutData`: Pass this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
+     * + `checkoutData`: Specify this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
      *
-     *  Default: If you don't pass a URL, a Wix pricing plans page is used.
+     *  Default: If you don't specify a URL, a Wix pricing plans page is used.
      */
     planListUrl?: string | null;
 }
@@ -885,14 +884,14 @@ interface RedirectSessionPreferences {
      */
     useGenericWixPages?: boolean | null;
     /**
-     * Whether to maintain the identity used in the redirect to wix (not relevant for "logout" and "auth" intents), or to use a new visitor identity.
+     * Whether to maintain the identity used in the redirect to Wix (not relevant for `logout` and `auth` intents), or to use a new visitor identity.
      *
      * Default: `true`
      */
     maintainIdentity?: boolean | null;
     /**
-     * A map of additional query parameters to pass to the created Wix URL.
-     * Global query parameters to be passed to Wix, for example campaign parameters (UTM params).
+     * Map of additional global query parameters to add to the created Wix URL.
+     * For example, [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters).
      */
     additionalQueryParameters?: Record<string, string>;
 }
@@ -1190,7 +1189,7 @@ interface CreateRedirectSessionOptions extends CreateRedirectSessionRequestInten
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
     /** 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;
@@ -1201,9 +1200,9 @@ interface CreateRedirectSessionOptions extends CreateRedirectSessionRequestInten
     /** Information required for generating a custom URL for Wix bookings book page. */
     bookingsBook?: RedirectSessionBookingsBookParams;
     /**
-     * Details of pages to redirect the visitor back to on the Wix Headless client site.
+     * Details of pages to redirect back to on the Wix Headless client site.
      *
-     * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
      */
     callbacks?: CallbackParams;
     /** Optional preferences for customizing redirection to Wix pages. */
@@ -1215,13 +1214,12 @@ interface CreateRedirectSessionSignature {
     /**
      * Creates a URL for redirecting a visitor from an external client site to a Wix page for Wix-managed functionality.
      *
-     *
-     * The `createRedirectSession()` function enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
-     * For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for a bookings, eCommerce, events, or paid plans transaction.
+     * The Create Redirect Session method enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
+     * For example, your site can temporarily redirect a visitor to Wix for authentication, or for a checkout process for bookings, eCommerce, events, or paid plans transactions.
      *
      * To initiate a redirect session:
      *
-     * 1. Call `createRedirectSession()` with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect the user back to your site as appropriate when the process is over.
+     * 1. Call Create Redirect Session with the details required for Wix to take care of one specific process (for example, authentication or a bookings checkout). Provide one or more callback URLs, so Wix can redirect the visitor back to your site as appropriate when the process is over.
      * 1. Redirect your visitor to the URL provided in the response. This URL includes query parameters informing Wix where to redirect the visitor back to on your external site.
      * 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
      * @param - Options for creating a redirect session.
@@ -1235,7 +1233,9 @@ declare function createEventModule<T extends EventDefinition<any, string>>(event
 declare const createRedirectSession: MaybeContext<BuildRESTFunction<typeof createRedirectSession$1> & typeof createRedirectSession$1>;
 
 type _publicOnRedirectSessionCreatedType = typeof onRedirectSessionCreated$1;
-/** */
+/**
+ * Triggerd when a redirect session is created
+ */
 declare const onRedirectSessionCreated: ReturnType<typeof createEventModule<_publicOnRedirectSessionCreatedType>>;
 
 type index_d_ActionEvent = ActionEvent;

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

@@ -7,7 +7,7 @@ interface RedirectSession$1 {
      * @readonly
      */
     fullUrl?: string;
-    /** Details about the URL of the RedirectSession */
+    /** Details about the URL of the redirect session. */
     urlDetails?: URLDetails$1;
     /**
      * The session token to pass to the Wix page to maintain the visitor's identity.
@@ -22,12 +22,12 @@ interface RedirectSession$1 {
 }
 interface URLDetails$1 {
     /**
-     * The endpoint of the url (includes the base url and the path to the endpoint, without the query parameters)
-     * For example: `https://mysite.com/_api/oauth2/authorize`
+     * Endpoint of the url. This includes the base URL and the path to the endpoint, without query parameters.
+     * For example: `https://mysite.com/_api/oauth2/authorize`.
      * @readonly
      */
     endpoint?: string;
-    /** The query parameters of the url */
+    /** URL query parameters. */
     searchParams?: Record<string, string>;
 }
 interface CreateRedirectSessionRequest$1 extends CreateRedirectSessionRequestIntentOneOf$1 {
@@ -39,7 +39,7 @@ interface CreateRedirectSessionRequest$1 extends CreateRedirectSessionRequestInt
     eventsCheckout?: RedirectSessionEventsCheckoutParams$1;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams$1;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams$1;
     /** 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$1;
@@ -51,10 +51,10 @@ interface CreateRedirectSessionRequest$1 extends CreateRedirectSessionRequestInt
     bookingsBook?: RedirectSessionBookingsBookParams$1;
     /**
      * Details of pages to redirect the visitor back to on the Wix Headless client site.
-     * When redirecting to any callback URL, Wix passes the boolean `wixMemberLoggedIn` query parameter.
+     * When redirecting to any callback URL, Wix specifies the boolean `wixMemberLoggedIn` parameter.
      * If `true`, a member logged in during the preceding Wix-managed process.
      *
-     * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `auth.authRequest.redirectUri`.
      */
     callbacks?: CallbackParams$1;
     /** Optional preferences for customizing redirection to Wix pages. */
@@ -70,7 +70,7 @@ interface CreateRedirectSessionRequestIntentOneOf$1 {
     eventsCheckout?: RedirectSessionEventsCheckoutParams$1;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams$1;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams$1;
     /** 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$1;
@@ -88,7 +88,6 @@ interface RedirectSessionBookingsCheckoutParams$1 {
      * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
      */
     timezone?: string;
-    /** *Required.** The calendar slot to check out. */
     slotAvailability?: SlotAvailability$1;
 }
 interface SlotAvailability$1 {
@@ -220,17 +219,17 @@ interface BookingPolicyViolations$1 {
     bookOnlineDisabled?: boolean | null;
 }
 interface RedirectSessionEcomCheckoutParams$1 {
-    /** *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. */
+    /**
+     * - SDK: Use [Create Checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/create-checkout) or [Create Checkout From Current Cart](https://dev.wix.com/docs/sdk/backend-modules/ecom/current-cart/create-checkout-from-current-cart).
+     * - REST: Use [Create Checkout From Cart](https://dev.wix.com/docs/rest/business-solutions/e-commerce/cart/create-checkout-from-cart).
+     */
     checkoutId?: string;
 }
 interface RedirectSessionEventsCheckoutParams$1 {
-    /** *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.** 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;
 }
 interface RedirectSessionPaidPlansCheckoutParams$1 {
-    /** *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;
     /**
      * For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
@@ -241,12 +240,11 @@ interface RedirectSessionPaidPlansCheckoutParams$1 {
 interface RedirectSessionLoginParams$1 {
 }
 interface RedirectSessionLogoutParams$1 {
-    /** *Required.** ID of the OAuth app authorizing the client. */
     clientId?: string;
 }
 interface RedirectSessionAuthParams$1 {
-    /** *Required.** The authorization request to send to the authorization server. */
     authRequest?: AuthorizeRequest$1;
+    /** prompt type */
     prompt?: Prompt$1;
 }
 /**
@@ -313,7 +311,6 @@ declare enum Prompt$1 {
     select_account = "select_account"
 }
 interface RedirectSessionStoresProductParams$1 {
-    /** *Required.** Slug of the product to navigate to. */
     productSlug?: string;
 }
 interface RedirectSessionBookingsBookParams$1 {
@@ -331,46 +328,46 @@ interface CallbackParams$1 {
      * After an eCommerce checkout:
      * + `orderId`: ID of an eCommerce order.
      *
-     * After an Events checkout
+     * After an Events checkout:
      * + `orderNumber`: Unique order number for the transaction.
      * + `eventId`: ID of the event.
      *
      * If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
      *
-     * Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
+     * Default: If you don't specify a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
      */
     thankYouPageUrl?: string | null;
     /**
      * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
      *
-     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a URL here. Instead, specify one in `auth.authRequest.redirectUri`.
      */
     postFlowUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix login page is used.
      */
     loginUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix bookings services page is used.
      */
     bookingsServiceListUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix cart page is used.
      */
     cartPageUrl?: string | null;
     /**
      * The URL for a custom pricing plans page implemented outside of Wix.
-     * When redirecting to this URL, Wix passes the following query parameters:
+     * When redirecting to this URL, Wix specifies the following query parameters:
      * + `planIds`:  IDs of the pricing plans on the custom page.
      * + `checkoutData`: Pass this string back in `paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
      *
-     * Default: If you don't pass a URL, a Wix pricing plans page is used.
+     * Default: If you don't specify a URL, a Wix pricing plans page is used.
      */
     planListUrl?: string | null;
 }
@@ -382,14 +379,14 @@ interface RedirectSessionPreferences$1 {
      */
     useGenericWixPages?: boolean | null;
     /**
-     * Whether to maintain the identity used in the redirect to wix (not relevant for "logout" and "auth" intents), or to use a new visitor identity.
+     * Whether to maintain the identity used in the redirect to Wix (not relevant for `logout` and `auth` intents), or to use a new visitor identity.
      *
      * Default: `true`
      */
     maintainIdentity?: boolean | null;
     /**
-     * A map of additional query parameters to pass to the created Wix URL.
-     * Global query parameters to be passed to Wix, for example campaign parameters (UTM params).
+     * Map of additional global query parameters to add to the created Wix URL.
+     * For example, [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters).
      */
     additionalQueryParameters?: Record<string, string>;
 }
@@ -419,7 +416,7 @@ interface RedirectSession {
      * @readonly
      */
     fullUrl?: string;
-    /** Details about the URL of the RedirectSession */
+    /** Details about the URL of the redirect session. */
     urlDetails?: URLDetails;
     /**
      * The session token to pass to the Wix page to maintain the visitor's identity.
@@ -434,12 +431,12 @@ interface RedirectSession {
 }
 interface URLDetails {
     /**
-     * The endpoint of the url (includes the base url and the path to the endpoint, without the query parameters)
-     * For example: `https://mysite.com/_api/oauth2/authorize`
+     * Endpoint of the url. This includes the base URL and the path to the endpoint, without query parameters.
+     * For example: `https://mysite.com/_api/oauth2/authorize`.
      * @readonly
      */
     endpoint?: string;
-    /** The query parameters of the url */
+    /** URL query parameters. */
     searchParams?: Record<string, string>;
 }
 interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestIntentOneOf {
@@ -451,7 +448,7 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
     /** 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;
@@ -463,8 +460,10 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
     bookingsBook?: RedirectSessionBookingsBookParams;
     /**
      * Details of pages to redirect the visitor back to on the Wix Headless client site.
+     * When redirecting to any callback URL, Wix specifies the boolean `wixMemberLoggedIn` parameter.
+     * If `true`, a member logged in during the preceding Wix-managed process.
      *
-     * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `auth.authRequest.redirectUri`.
      */
     callbacks?: CallbackParams;
     /** Optional preferences for customizing redirection to Wix pages. */
@@ -480,7 +479,7 @@ interface CreateRedirectSessionRequestIntentOneOf {
     eventsCheckout?: RedirectSessionEventsCheckoutParams;
     /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
     paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
-    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    /** Specify an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
     login?: RedirectSessionLoginParams;
     /** 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;
@@ -498,7 +497,6 @@ interface RedirectSessionBookingsCheckoutParams {
      * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
      */
     timezone?: string;
-    /** __Required.__ The calendar slot to check out. */
     slotAvailability?: SlotAvailability;
 }
 interface SlotAvailability {
@@ -548,7 +546,7 @@ interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `startDate` is ignored.
+     * in the `start_date` is ignored.
      */
     startDate?: string | null;
     /**
@@ -557,13 +555,13 @@ interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `endDate` is ignored.
+     * in the `end_date` is ignored.
      */
     endDate?: string | null;
     /**
      * The timezone for which slot availability is to be calculated.
      *
-     * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/sdk/bookings/availabilitycalendar/queryavailability#bookings_availabilitycalendar_queryavailability_handling-daylight-savings-time-dst-for-local-time-zones)
+     * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_handling-daylight-savings-time-dst-for-local-time-zones)
      * when calculating availability.
      */
     timezone?: string | null;
@@ -630,17 +628,17 @@ interface BookingPolicyViolations {
     bookOnlineDisabled?: boolean | null;
 }
 interface RedirectSessionEcomCheckoutParams {
-    /** __Required.__ ID of the checkout to process. Use [`createCheckout()`](https://dev.wix.com/api/sdk/ecom/checkout/createcheckout) or [`createCheckoutFromCurrentCart()`](https://dev.wix.com/api/sdk/ecom/currentcart/createcheckoutfromcurrentcart) to create a checkout and obtain an ID. */
+    /**
+     * - SDK: Use [Create Checkout](https://dev.wix.com/docs/sdk/backend-modules/ecom/checkout/create-checkout) or [Create Checkout From Current Cart](https://dev.wix.com/docs/sdk/backend-modules/ecom/current-cart/create-checkout-from-current-cart).
+     * - REST: Use [Create Checkout From Cart](https://dev.wix.com/docs/rest/business-solutions/e-commerce/cart/create-checkout-from-cart).
+     */
     checkoutId?: string;
 }
 interface RedirectSessionEventsCheckoutParams {
-    /** __Required.__ ID of the temporary event reservation. Use [`createReservation()`](https://dev.wix.com/api/sdk/events/checkout/createreservation) to reserve a ticket temporarily and obtain a reservation ID. */
     reservationId?: string;
-    /** __Required.__ URL-friendly event slug, generated from the event title of the event. For example, `my-event-4`. Use [`listEvents()`](https://dev.wix.com/api/sdk/events/wixevents/listevents) to obtain an event slug. */
     eventSlug?: string;
 }
 interface RedirectSessionPaidPlansCheckoutParams {
-    /** __Required.__ ID of the paid plan selected. Use [`queryPublicPlans()`](https://dev.wix.com/api/sdk/pricing-plans/plans/querypublicplans) to obtain a paid plan ID. */
     planId?: string;
     /**
      * For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
@@ -651,12 +649,11 @@ interface RedirectSessionPaidPlansCheckoutParams {
 interface RedirectSessionLoginParams {
 }
 interface RedirectSessionLogoutParams {
-    /** __Required.__ ID of the OAuth app authorizing the client. */
     clientId?: string;
 }
 interface RedirectSessionAuthParams {
-    /** __Required.__ The authorization request to send to the authorization server. */
     authRequest?: AuthorizeRequest;
+    /** prompt type */
     prompt?: Prompt;
 }
 /**
@@ -723,7 +720,6 @@ declare enum Prompt {
     select_account = "select_account"
 }
 interface RedirectSessionStoresProductParams {
-    /** *Required.** Slug of the product to navigate to. */
     productSlug?: string;
 }
 interface RedirectSessionBookingsBookParams {
@@ -741,45 +737,45 @@ interface CallbackParams {
      * After an eCommerce checkout:
      * + `orderId`: ID of an eCommerce order.
      *
-     * After an Events checkout
+     * After an Events checkout:
      * + `orderNumber`: Unique order number for the transaction.
      * + `eventId`: ID of the event.
      *
      * If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
      *
-     * Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
+     * Default: If you don't specify a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
      */
     thankYouPageUrl?: string | null;
     /**
      * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
      *
-     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     * **Note**: For an authentication redirect, don't specify a URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
      */
     postFlowUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix login page is used.
      */
     loginUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix bookings services page is used.
      */
     bookingsServiceListUrl?: string | null;
     /**
      * 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.
+     * Default: If you don't specify a URL, a Wix cart page is used.
      */
     cartPageUrl?: string | null;
     /**
-     * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix passes the following query parameters:
+     * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix specifies the following query parameters:
      * + `planIds`:  IDs of the pricing plans on the custom page.
-     * + `checkoutData`: Pass this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
+     * + `checkoutData`: Specify this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
      *
-     *  Default: If you don't pass a URL, a Wix pricing plans page is used.
+     *  Default: If you don't specify a URL, a Wix pricing plans page is used.
      */
     planListUrl?: string | null;
 }
@@ -791,14 +787,14 @@ interface RedirectSessionPreferences {
      */
     useGenericWixPages?: boolean | null;
     /**
-     * Whether to maintain the identity used in the redirect to wix (not relevant for "logout" and "auth" intents), or to use a new visitor identity.
+     * Whether to maintain the identity used in the redirect to Wix (not relevant for `logout` and `auth` intents), or to use a new visitor identity.
      *
      * Default: `true`
      */
     maintainIdentity?: boolean | null;
     /**
-     * A map of additional query parameters to pass to the created Wix URL.
-     * Global query parameters to be passed to Wix, for example campaign parameters (UTM params).
+     * Map of additional global query parameters to add to the created Wix URL.
+     * For example, [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters).
      */
     additionalQueryParameters?: Record<string, string>;
 }