@wix/redirects 1.0.6 → 1.0.7

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

@@ -4,12 +4,12 @@ import { CreateRedirectSessionRequest, CreateRedirectSessionResponse } from './h
  * Creates a URL for redirecting a visitor from an external 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 integrate Wix-managed frontend functionality for specific processes.
+ * 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.
  *
  * To initiate a redirect session:
  *
- * 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 user back to your site as appropriate when the process is over.
+ * 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. 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.
  */

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

@@ -26,12 +26,12 @@ function resolveWixHeadlessV1RedirectSessionServiceUrl(opts) {
  * Creates a URL for redirecting a visitor from an external 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 integrate Wix-managed frontend functionality for specific processes.
+ * 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.
  *
  * To initiate a redirect session:
  *
- * 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 user back to your site as appropriate when the process is over.
+ * 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. 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.
  */

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

@@ -62,9 +62,9 @@ export interface RedirectSessionBookingsCheckoutParams {
      * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
      */
     timezone?: string;
-    /** *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. */
+    /** **Required.**. ID of the service for which to select the slot. Use [`queryServices()`](https://dev.wix.com/api/sdk/bookings/services/queryservices) to obtain a service ID. */
     serviceId?: string;
-    /** *Required.** The calendar slot to check out. */
+    /** **Required.** The calendar slot to check out. */
     slotAvailability?: SlotAvailability;
 }
 export interface SlotAvailability {
@@ -113,7 +113,7 @@ export interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `start_date` is ignored.
+     * in the `startDate` is ignored.
      */
     startDate?: string | null;
     /**
@@ -122,13 +122,13 @@ export interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `end_date` is ignored.
+     * in the `endDate` 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/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_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/sdk/bookings/availabilitycalendar/queryavailability#bookings_availabilitycalendar_queryavailability_handling-daylight-savings-time-dst-for-local-time-zones)
      * when calculating availability.
      */
     timezone?: string | null;
@@ -193,17 +193,17 @@ export interface BookingPolicyViolations {
     bookOnlineDisabled?: boolean | null;
 }
 export interface RedirectSessionEcomCheckoutParams {
-    /** *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. */
+    /** **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. */
     checkoutId?: string;
 }
 export interface RedirectSessionEventsCheckoutParams {
-    /** *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. */
+    /** **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 [Query Events](https://dev.wix.com/api/rest/wix-events/wix-events/event/query-events) to obtain an event slug. */
+    /** **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;
 }
 export interface RedirectSessionPaidPlansCheckoutParams {
-    /** *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. */
+    /** **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.
@@ -268,11 +268,11 @@ export interface AuthorizeRequest {
     errorDescription?: string | null;
 }
 export interface RedirectSessionLogoutParams {
-    /** *Required.** ID of the OAuth app authorizing the client. */
+    /** **Required.** ID of the OAuth app authorizing the client. */
     clientId?: string;
 }
 export interface RedirectSessionAuthParams {
-    /** *Required.** The authorization request to send to the authorization server. */
+    /** **Required.** The authorization request to send to the authorization server. */
     authRequest?: AuthorizeRequest;
 }
 export interface RedirectSessionMembersAccountParams {
@@ -386,12 +386,12 @@ export interface SignInURLResponse {
  * Creates a URL for redirecting a visitor from an external 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 integrate Wix-managed frontend functionality for specific processes.
+ * 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.
  *
  * To initiate a redirect session:
  *
- * 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 user back to your site as appropriate when the process is over.
+ * 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. 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.
  * @public

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

@@ -83,12 +83,12 @@ const _createRedirectSessionResponse = {};
  * Creates a URL for redirecting a visitor from an external 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 integrate Wix-managed frontend functionality for specific processes.
+ * 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.
  *
  * To initiate a redirect session:
  *
- * 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 user back to your site as appropriate when the process is over.
+ * 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. 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.
  * @public

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

@@ -4,12 +4,12 @@ import { CreateRedirectSessionRequest, CreateRedirectSessionResponse } from './h
  * Creates a URL for redirecting a visitor from an external 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 integrate Wix-managed frontend functionality for specific processes.
+ * 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.
  *
  * To initiate a redirect session:
  *
- * 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 user back to your site as appropriate when the process is over.
+ * 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. 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.
  */

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

@@ -23,12 +23,12 @@ function resolveWixHeadlessV1RedirectSessionServiceUrl(opts) {
  * Creates a URL for redirecting a visitor from an external 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 integrate Wix-managed frontend functionality for specific processes.
+ * 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.
  *
  * To initiate a redirect session:
  *
- * 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 user back to your site as appropriate when the process is over.
+ * 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. 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.
  */

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

@@ -62,9 +62,9 @@ export interface RedirectSessionBookingsCheckoutParams {
      * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
      */
     timezone?: string;
-    /** *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. */
+    /** **Required.**. ID of the service for which to select the slot. Use [`queryServices()`](https://dev.wix.com/api/sdk/bookings/services/queryservices) to obtain a service ID. */
     serviceId?: string;
-    /** *Required.** The calendar slot to check out. */
+    /** **Required.** The calendar slot to check out. */
     slotAvailability?: SlotAvailability;
 }
 export interface SlotAvailability {
@@ -113,7 +113,7 @@ export interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `start_date` is ignored.
+     * in the `startDate` is ignored.
      */
     startDate?: string | null;
     /**
@@ -122,13 +122,13 @@ export interface Slot {
      *
      * If `timezone` is specified,
      * dates are based on the local date/time. This means that the timezone offset
-     * in the `end_date` is ignored.
+     * in the `endDate` 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/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_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/sdk/bookings/availabilitycalendar/queryavailability#bookings_availabilitycalendar_queryavailability_handling-daylight-savings-time-dst-for-local-time-zones)
      * when calculating availability.
      */
     timezone?: string | null;
@@ -193,17 +193,17 @@ export interface BookingPolicyViolations {
     bookOnlineDisabled?: boolean | null;
 }
 export interface RedirectSessionEcomCheckoutParams {
-    /** *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. */
+    /** **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. */
     checkoutId?: string;
 }
 export interface RedirectSessionEventsCheckoutParams {
-    /** *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. */
+    /** **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 [Query Events](https://dev.wix.com/api/rest/wix-events/wix-events/event/query-events) to obtain an event slug. */
+    /** **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;
 }
 export interface RedirectSessionPaidPlansCheckoutParams {
-    /** *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. */
+    /** **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.
@@ -268,11 +268,11 @@ export interface AuthorizeRequest {
     errorDescription?: string | null;
 }
 export interface RedirectSessionLogoutParams {
-    /** *Required.** ID of the OAuth app authorizing the client. */
+    /** **Required.** ID of the OAuth app authorizing the client. */
     clientId?: string;
 }
 export interface RedirectSessionAuthParams {
-    /** *Required.** The authorization request to send to the authorization server. */
+    /** **Required.** The authorization request to send to the authorization server. */
     authRequest?: AuthorizeRequest;
 }
 export interface RedirectSessionMembersAccountParams {
@@ -386,12 +386,12 @@ export interface SignInURLResponse {
  * Creates a URL for redirecting a visitor from an external 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 integrate Wix-managed frontend functionality for specific processes.
+ * 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.
  *
  * To initiate a redirect session:
  *
- * 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 user back to your site as appropriate when the process is over.
+ * 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. 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.
  * @public

package/build/es/src/headless-v1-redirect-session.universal.js

@@ -61,12 +61,12 @@ const _createRedirectSessionResponse = {};
  * Creates a URL for redirecting a visitor from an external 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 integrate Wix-managed frontend functionality for specific processes.
+ * 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.
  *
  * To initiate a redirect session:
  *
- * 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 user back to your site as appropriate when the process is over.
+ * 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. 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.
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/redirects",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -33,5 +33,5 @@
       "groupId": "com.wixpress.public-sdk-autogen"
     }
   },
-  "falconPackageHash": "a74a67c990c0c234cda33d3003415f726c512aa418860ecffc78e13f"
+  "falconPackageHash": "b5220ae9722216ca90271d9aa83aaad3c9f3f4766386babe53a0cb90"
 }