@wix/redirects 1.0.66 → 1.0.68

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/redirects",
3
- "version": "1.0.66",
3
+ "version": "1.0.68",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -21,7 +21,7 @@
21
21
  "type-bundles"
22
22
  ],
23
23
  "dependencies": {
24
- "@wix/redirects_redirects": "1.0.35"
24
+ "@wix/redirects_redirects": "1.0.37"
25
25
  },
26
26
  "devDependencies": {
27
27
  "glob": "^10.4.1",
@@ -46,5 +46,5 @@
46
46
  "fqdn": ""
47
47
  }
48
48
  },
49
- "falconPackageHash": "a16aa54e32248d9a156144093b0aa8eb718a065c1be16866a7fa578b"
49
+ "falconPackageHash": "158f462ddc5880ebb6ba0d6ec2652bf0a21b460de5382d1d8b07dcd0"
50
50
  }
@@ -529,8 +529,10 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
529
529
  bookingsBook?: RedirectSessionBookingsBookParams;
530
530
  /**
531
531
  * Details of pages to redirect the visitor back to on the Wix Headless client site.
532
+ * When redirecting to any callback URL, Wix passes the boolean `wixMemberLoggedIn` query parameter.
533
+ * If `true`, a member logged in during the preceding Wix-managed process.
532
534
  *
533
- * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
535
+ * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
534
536
  */
535
537
  callbacks?: CallbackParams;
536
538
  /** Optional preferences for customizing redirection to Wix pages. */
@@ -564,7 +566,7 @@ interface RedirectSessionBookingsCheckoutParams {
564
566
  * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
565
567
  */
566
568
  timezone?: string;
567
- /** __Required.__ The calendar slot to check out. */
569
+ /** *Required.** The calendar slot to check out. */
568
570
  slotAvailability?: SlotAvailability;
569
571
  }
570
572
  interface SlotAvailability {
@@ -614,7 +616,7 @@ interface Slot {
614
616
  *
615
617
  * If `timezone` is specified,
616
618
  * dates are based on the local date/time. This means that the timezone offset
617
- * in the `startDate` is ignored.
619
+ * in the `start_date` is ignored.
618
620
  */
619
621
  startDate?: string | null;
620
622
  /**
@@ -623,13 +625,13 @@ interface Slot {
623
625
  *
624
626
  * If `timezone` is specified,
625
627
  * dates are based on the local date/time. This means that the timezone offset
626
- * in the `endDate` is ignored.
628
+ * in the `end_date` is ignored.
627
629
  */
628
630
  endDate?: string | null;
629
631
  /**
630
632
  * The timezone for which slot availability is to be calculated.
631
633
  *
632
- * 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)
634
+ * 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)
633
635
  * when calculating availability.
634
636
  */
635
637
  timezone?: string | null;
@@ -704,17 +706,17 @@ interface NestedTimeSlot {
704
706
  scheduleId?: string;
705
707
  }
706
708
  interface RedirectSessionEcomCheckoutParams {
707
- /** __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. */
709
+ /** *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. */
708
710
  checkoutId?: string;
709
711
  }
710
712
  interface RedirectSessionEventsCheckoutParams {
711
- /** __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. */
713
+ /** *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. */
712
714
  reservationId?: string;
713
- /** __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. */
715
+ /** *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. */
714
716
  eventSlug?: string;
715
717
  }
716
718
  interface RedirectSessionPaidPlansCheckoutParams {
717
- /** __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. */
719
+ /** *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. */
718
720
  planId?: string;
719
721
  /**
720
722
  * 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,11 +727,11 @@ interface RedirectSessionPaidPlansCheckoutParams {
725
727
  interface RedirectSessionLoginParams {
726
728
  }
727
729
  interface RedirectSessionLogoutParams {
728
- /** __Required.__ ID of the OAuth app authorizing the client. */
730
+ /** *Required.** ID of the OAuth app authorizing the client. */
729
731
  clientId?: string;
730
732
  }
731
733
  interface RedirectSessionAuthParams {
732
- /** __Required.__ The authorization request to send to the authorization server. */
734
+ /** *Required.** The authorization request to send to the authorization server. */
733
735
  authRequest?: AuthorizeRequest;
734
736
  prompt?: Prompt;
735
737
  }
@@ -847,7 +849,7 @@ interface CallbackParams {
847
849
  /**
848
850
  * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
849
851
  *
850
- * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
852
+ * **Note**: For an authentication redirect, don't specify a URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
851
853
  */
852
854
  postFlowUrl?: string | null;
853
855
  /**
@@ -869,11 +871,11 @@ interface CallbackParams {
869
871
  */
870
872
  cartPageUrl?: string | null;
871
873
  /**
872
- * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix passes the following query parameters:
874
+ * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix specifies the following query parameters:
873
875
  * + `planIds`: IDs of the pricing plans on the custom page.
874
- * + `checkoutData`: Pass this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
876
+ * + `checkoutData`: Specify this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
875
877
  *
876
- * Default: If you don't pass a URL, a Wix pricing plans page is used.
878
+ * Default: If you don't specify a URL, a Wix pricing plans page is used.
877
879
  */
878
880
  planListUrl?: string | null;
879
881
  }
@@ -1201,9 +1203,9 @@ interface CreateRedirectSessionOptions extends CreateRedirectSessionRequestInten
1201
1203
  /** Information required for generating a custom URL for Wix bookings book page. */
1202
1204
  bookingsBook?: RedirectSessionBookingsBookParams;
1203
1205
  /**
1204
- * Details of pages to redirect the visitor back to on the Wix Headless client site.
1206
+ * Details of pages to redirect back to on the Wix Headless client site.
1205
1207
  *
1206
- * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
1208
+ * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
1207
1209
  */
1208
1210
  callbacks?: CallbackParams;
1209
1211
  /** Optional preferences for customizing redirection to Wix pages. */
@@ -1216,12 +1218,12 @@ interface CreateRedirectSessionSignature {
1216
1218
  * Creates a URL for redirecting a visitor from an external client site to a Wix page for Wix-managed functionality.
1217
1219
  *
1218
1220
  *
1219
- * The `createRedirectSession()` function enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
1221
+ * 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.
1220
1222
  * 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.
1221
1223
  *
1222
1224
  * To initiate a redirect session:
1223
1225
  *
1224
- * 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.
1226
+ * 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.
1225
1227
  * 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.
1226
1228
  * 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
1227
1229
  * @param - Options for creating a redirect session.
@@ -529,8 +529,10 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
529
529
  bookingsBook?: RedirectSessionBookingsBookParams;
530
530
  /**
531
531
  * Details of pages to redirect the visitor back to on the Wix Headless client site.
532
+ * When redirecting to any callback URL, Wix passes the boolean `wixMemberLoggedIn` query parameter.
533
+ * If `true`, a member logged in during the preceding Wix-managed process.
532
534
  *
533
- * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
535
+ * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
534
536
  */
535
537
  callbacks?: CallbackParams;
536
538
  /** Optional preferences for customizing redirection to Wix pages. */
@@ -564,7 +566,7 @@ interface RedirectSessionBookingsCheckoutParams {
564
566
  * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
565
567
  */
566
568
  timezone?: string;
567
- /** __Required.__ The calendar slot to check out. */
569
+ /** *Required.** The calendar slot to check out. */
568
570
  slotAvailability?: SlotAvailability;
569
571
  }
570
572
  interface SlotAvailability {
@@ -614,7 +616,7 @@ interface Slot {
614
616
  *
615
617
  * If `timezone` is specified,
616
618
  * dates are based on the local date/time. This means that the timezone offset
617
- * in the `startDate` is ignored.
619
+ * in the `start_date` is ignored.
618
620
  */
619
621
  startDate?: string | null;
620
622
  /**
@@ -623,13 +625,13 @@ interface Slot {
623
625
  *
624
626
  * If `timezone` is specified,
625
627
  * dates are based on the local date/time. This means that the timezone offset
626
- * in the `endDate` is ignored.
628
+ * in the `end_date` is ignored.
627
629
  */
628
630
  endDate?: string | null;
629
631
  /**
630
632
  * The timezone for which slot availability is to be calculated.
631
633
  *
632
- * 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)
634
+ * 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)
633
635
  * when calculating availability.
634
636
  */
635
637
  timezone?: string | null;
@@ -704,17 +706,17 @@ interface NestedTimeSlot {
704
706
  scheduleId?: string;
705
707
  }
706
708
  interface RedirectSessionEcomCheckoutParams {
707
- /** __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. */
709
+ /** *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. */
708
710
  checkoutId?: string;
709
711
  }
710
712
  interface RedirectSessionEventsCheckoutParams {
711
- /** __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. */
713
+ /** *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. */
712
714
  reservationId?: string;
713
- /** __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. */
715
+ /** *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. */
714
716
  eventSlug?: string;
715
717
  }
716
718
  interface RedirectSessionPaidPlansCheckoutParams {
717
- /** __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. */
719
+ /** *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. */
718
720
  planId?: string;
719
721
  /**
720
722
  * 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,11 +727,11 @@ interface RedirectSessionPaidPlansCheckoutParams {
725
727
  interface RedirectSessionLoginParams {
726
728
  }
727
729
  interface RedirectSessionLogoutParams {
728
- /** __Required.__ ID of the OAuth app authorizing the client. */
730
+ /** *Required.** ID of the OAuth app authorizing the client. */
729
731
  clientId?: string;
730
732
  }
731
733
  interface RedirectSessionAuthParams {
732
- /** __Required.__ The authorization request to send to the authorization server. */
734
+ /** *Required.** The authorization request to send to the authorization server. */
733
735
  authRequest?: AuthorizeRequest;
734
736
  prompt?: Prompt;
735
737
  }
@@ -847,7 +849,7 @@ interface CallbackParams {
847
849
  /**
848
850
  * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
849
851
  *
850
- * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
852
+ * **Note**: For an authentication redirect, don't specify a URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
851
853
  */
852
854
  postFlowUrl?: string | null;
853
855
  /**
@@ -869,11 +871,11 @@ interface CallbackParams {
869
871
  */
870
872
  cartPageUrl?: string | null;
871
873
  /**
872
- * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix passes the following query parameters:
874
+ * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix specifies the following query parameters:
873
875
  * + `planIds`: IDs of the pricing plans on the custom page.
874
- * + `checkoutData`: Pass this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
876
+ * + `checkoutData`: Specify this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
875
877
  *
876
- * Default: If you don't pass a URL, a Wix pricing plans page is used.
878
+ * Default: If you don't specify a URL, a Wix pricing plans page is used.
877
879
  */
878
880
  planListUrl?: string | null;
879
881
  }
@@ -1201,9 +1203,9 @@ interface CreateRedirectSessionOptions extends CreateRedirectSessionRequestInten
1201
1203
  /** Information required for generating a custom URL for Wix bookings book page. */
1202
1204
  bookingsBook?: RedirectSessionBookingsBookParams;
1203
1205
  /**
1204
- * Details of pages to redirect the visitor back to on the Wix Headless client site.
1206
+ * Details of pages to redirect back to on the Wix Headless client site.
1205
1207
  *
1206
- * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
1208
+ * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
1207
1209
  */
1208
1210
  callbacks?: CallbackParams;
1209
1211
  /** Optional preferences for customizing redirection to Wix pages. */
@@ -1216,12 +1218,12 @@ interface CreateRedirectSessionSignature {
1216
1218
  * Creates a URL for redirecting a visitor from an external client site to a Wix page for Wix-managed functionality.
1217
1219
  *
1218
1220
  *
1219
- * The `createRedirectSession()` function enables your external Wix Headless client site, built on any platform, to integrate Wix-managed frontend functionality for specific processes.
1221
+ * 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.
1220
1222
  * 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.
1221
1223
  *
1222
1224
  * To initiate a redirect session:
1223
1225
  *
1224
- * 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.
1226
+ * 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.
1225
1227
  * 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.
1226
1228
  * 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
1227
1229
  * @param - Options for creating a redirect session.
@@ -463,8 +463,10 @@ interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestInten
463
463
  bookingsBook?: RedirectSessionBookingsBookParams;
464
464
  /**
465
465
  * Details of pages to redirect the visitor back to on the Wix Headless client site.
466
+ * When redirecting to any callback URL, Wix passes the boolean `wixMemberLoggedIn` query parameter.
467
+ * If `true`, a member logged in during the preceding Wix-managed process.
466
468
  *
467
- * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
469
+ * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `auth.authRequest.redirectUri`.
468
470
  */
469
471
  callbacks?: CallbackParams;
470
472
  /** Optional preferences for customizing redirection to Wix pages. */
@@ -498,7 +500,7 @@ interface RedirectSessionBookingsCheckoutParams {
498
500
  * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
499
501
  */
500
502
  timezone?: string;
501
- /** __Required.__ The calendar slot to check out. */
503
+ /** *Required.** The calendar slot to check out. */
502
504
  slotAvailability?: SlotAvailability;
503
505
  }
504
506
  interface SlotAvailability {
@@ -548,7 +550,7 @@ interface Slot {
548
550
  *
549
551
  * If `timezone` is specified,
550
552
  * dates are based on the local date/time. This means that the timezone offset
551
- * in the `startDate` is ignored.
553
+ * in the `start_date` is ignored.
552
554
  */
553
555
  startDate?: string | null;
554
556
  /**
@@ -557,13 +559,13 @@ interface Slot {
557
559
  *
558
560
  * If `timezone` is specified,
559
561
  * dates are based on the local date/time. This means that the timezone offset
560
- * in the `endDate` is ignored.
562
+ * in the `end_date` is ignored.
561
563
  */
562
564
  endDate?: string | null;
563
565
  /**
564
566
  * The timezone for which slot availability is to be calculated.
565
567
  *
566
- * 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)
568
+ * 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)
567
569
  * when calculating availability.
568
570
  */
569
571
  timezone?: string | null;
@@ -630,17 +632,17 @@ interface BookingPolicyViolations {
630
632
  bookOnlineDisabled?: boolean | null;
631
633
  }
632
634
  interface RedirectSessionEcomCheckoutParams {
633
- /** __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. */
635
+ /** *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. */
634
636
  checkoutId?: string;
635
637
  }
636
638
  interface RedirectSessionEventsCheckoutParams {
637
- /** __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. */
639
+ /** *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. */
638
640
  reservationId?: string;
639
- /** __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. */
641
+ /** *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. */
640
642
  eventSlug?: string;
641
643
  }
642
644
  interface RedirectSessionPaidPlansCheckoutParams {
643
- /** __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. */
645
+ /** *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. */
644
646
  planId?: string;
645
647
  /**
646
648
  * 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,11 +653,11 @@ interface RedirectSessionPaidPlansCheckoutParams {
651
653
  interface RedirectSessionLoginParams {
652
654
  }
653
655
  interface RedirectSessionLogoutParams {
654
- /** __Required.__ ID of the OAuth app authorizing the client. */
656
+ /** *Required.** ID of the OAuth app authorizing the client. */
655
657
  clientId?: string;
656
658
  }
657
659
  interface RedirectSessionAuthParams {
658
- /** __Required.__ The authorization request to send to the authorization server. */
660
+ /** *Required.** The authorization request to send to the authorization server. */
659
661
  authRequest?: AuthorizeRequest;
660
662
  prompt?: Prompt;
661
663
  }
@@ -753,7 +755,7 @@ interface CallbackParams {
753
755
  /**
754
756
  * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
755
757
  *
756
- * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
758
+ * **Note**: For an authentication redirect, don't specify a URL here. Instead, specify one in `options.auth.authRequest.redirectUri`.
757
759
  */
758
760
  postFlowUrl?: string | null;
759
761
  /**
@@ -775,11 +777,11 @@ interface CallbackParams {
775
777
  */
776
778
  cartPageUrl?: string | null;
777
779
  /**
778
- * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix passes the following query parameters:
780
+ * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix specifies the following query parameters:
779
781
  * + `planIds`: IDs of the pricing plans on the custom page.
780
- * + `checkoutData`: Pass this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
782
+ * + `checkoutData`: Specify this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
781
783
  *
782
- * Default: If you don't pass a URL, a Wix pricing plans page is used.
784
+ * Default: If you don't specify a URL, a Wix pricing plans page is used.
783
785
  */
784
786
  planListUrl?: string | null;
785
787
  }