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