@wix/auto_sdk_redirects_redirects 1.0.6 → 1.0.8
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/build/{internal/cjs/src/headless-v1-redirect-session-redirects.universal.d.ts → headless-v1-redirect-session-redirects.universal-B6Uucoxj.d.mts} +74 -134
- package/build/{cjs/src/headless-v1-redirect-session-redirects.universal.d.ts → headless-v1-redirect-session-redirects.universal-B6Uucoxj.d.ts} +74 -134
- package/build/index.d.mts +30 -0
- package/build/index.d.ts +30 -0
- package/build/index.js +223 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +191 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/headless-v1-redirect-session-redirects.universal.d.ts → headless-v1-redirect-session-redirects.universal-B6Uucoxj.d.mts} +74 -134
- package/build/{es/src/headless-v1-redirect-session-redirects.universal.d.ts → internal/headless-v1-redirect-session-redirects.universal-B6Uucoxj.d.ts} +74 -134
- package/build/internal/index.d.mts +30 -0
- package/build/internal/index.d.ts +30 -0
- package/build/internal/index.js +223 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +191 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{cjs/src/headless-v1-redirect-session-redirects.types.d.ts → internal/meta.d.mts} +49 -334
- package/build/{es/src/headless-v1-redirect-session-redirects.types.d.ts → internal/meta.d.ts} +49 -334
- package/build/internal/meta.js +93 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +66 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{internal/cjs/src/headless-v1-redirect-session-redirects.types.d.ts → meta.d.mts} +49 -334
- package/build/{internal/es/src/headless-v1-redirect-session-redirects.types.d.ts → meta.d.ts} +49 -334
- package/build/meta.js +93 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +66 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/headless-v1-redirect-session-redirects.context.d.ts +0 -11
- package/build/cjs/src/headless-v1-redirect-session-redirects.context.js +0 -21
- package/build/cjs/src/headless-v1-redirect-session-redirects.context.js.map +0 -1
- package/build/cjs/src/headless-v1-redirect-session-redirects.http.d.ts +0 -14
- package/build/cjs/src/headless-v1-redirect-session-redirects.http.js +0 -58
- package/build/cjs/src/headless-v1-redirect-session-redirects.http.js.map +0 -1
- package/build/cjs/src/headless-v1-redirect-session-redirects.meta.d.ts +0 -13
- package/build/cjs/src/headless-v1-redirect-session-redirects.meta.js +0 -47
- package/build/cjs/src/headless-v1-redirect-session-redirects.meta.js.map +0 -1
- package/build/cjs/src/headless-v1-redirect-session-redirects.public.d.ts +0 -24
- package/build/cjs/src/headless-v1-redirect-session-redirects.public.js +0 -30
- package/build/cjs/src/headless-v1-redirect-session-redirects.public.js.map +0 -1
- package/build/cjs/src/headless-v1-redirect-session-redirects.types.js +0 -75
- package/build/cjs/src/headless-v1-redirect-session-redirects.types.js.map +0 -1
- package/build/cjs/src/headless-v1-redirect-session-redirects.universal.js +0 -182
- package/build/cjs/src/headless-v1-redirect-session-redirects.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/headless-v1-redirect-session-redirects.context.d.ts +0 -11
- package/build/es/src/headless-v1-redirect-session-redirects.context.js +0 -11
- package/build/es/src/headless-v1-redirect-session-redirects.context.js.map +0 -1
- package/build/es/src/headless-v1-redirect-session-redirects.http.d.ts +0 -14
- package/build/es/src/headless-v1-redirect-session-redirects.http.js +0 -54
- package/build/es/src/headless-v1-redirect-session-redirects.http.js.map +0 -1
- package/build/es/src/headless-v1-redirect-session-redirects.meta.d.ts +0 -13
- package/build/es/src/headless-v1-redirect-session-redirects.meta.js +0 -20
- package/build/es/src/headless-v1-redirect-session-redirects.meta.js.map +0 -1
- package/build/es/src/headless-v1-redirect-session-redirects.public.d.ts +0 -24
- package/build/es/src/headless-v1-redirect-session-redirects.public.js +0 -19
- package/build/es/src/headless-v1-redirect-session-redirects.public.js.map +0 -1
- package/build/es/src/headless-v1-redirect-session-redirects.types.js +0 -72
- package/build/es/src/headless-v1-redirect-session-redirects.types.js.map +0 -1
- package/build/es/src/headless-v1-redirect-session-redirects.universal.js +0 -155
- package/build/es/src/headless-v1-redirect-session-redirects.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.context.d.ts +0 -11
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.context.js +0 -21
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.context.js.map +0 -1
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.http.d.ts +0 -14
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.http.js +0 -58
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.http.js.map +0 -1
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.meta.d.ts +0 -13
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.meta.js +0 -47
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.meta.js.map +0 -1
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.public.d.ts +0 -24
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.public.js +0 -30
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.public.js.map +0 -1
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.types.js +0 -75
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.types.js.map +0 -1
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.universal.js +0 -182
- package/build/internal/cjs/src/headless-v1-redirect-session-redirects.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/headless-v1-redirect-session-redirects.context.d.ts +0 -11
- package/build/internal/es/src/headless-v1-redirect-session-redirects.context.js +0 -11
- package/build/internal/es/src/headless-v1-redirect-session-redirects.context.js.map +0 -1
- package/build/internal/es/src/headless-v1-redirect-session-redirects.http.d.ts +0 -14
- package/build/internal/es/src/headless-v1-redirect-session-redirects.http.js +0 -54
- package/build/internal/es/src/headless-v1-redirect-session-redirects.http.js.map +0 -1
- package/build/internal/es/src/headless-v1-redirect-session-redirects.meta.d.ts +0 -13
- package/build/internal/es/src/headless-v1-redirect-session-redirects.meta.js +0 -20
- package/build/internal/es/src/headless-v1-redirect-session-redirects.meta.js.map +0 -1
- package/build/internal/es/src/headless-v1-redirect-session-redirects.public.d.ts +0 -24
- package/build/internal/es/src/headless-v1-redirect-session-redirects.public.js +0 -19
- package/build/internal/es/src/headless-v1-redirect-session-redirects.public.js.map +0 -1
- package/build/internal/es/src/headless-v1-redirect-session-redirects.types.js +0 -72
- package/build/internal/es/src/headless-v1-redirect-session-redirects.types.js.map +0 -1
- package/build/internal/es/src/headless-v1-redirect-session-redirects.universal.js +0 -155
- package/build/internal/es/src/headless-v1-redirect-session-redirects.universal.js.map +0 -1
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/** Information for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
|
|
3
|
-
|
|
2
|
+
interface RedirectSession {
|
|
4
3
|
/**
|
|
5
4
|
* ID of the redirect session created.
|
|
6
5
|
* @format GUID
|
|
@@ -27,7 +26,7 @@ export interface RedirectSession {
|
|
|
27
26
|
*/
|
|
28
27
|
shortUrl?: string;
|
|
29
28
|
}
|
|
30
|
-
|
|
29
|
+
interface URLDetails {
|
|
31
30
|
/**
|
|
32
31
|
* Endpoint of the url. This includes the base URL and the path to the endpoint, without query parameters.
|
|
33
32
|
* For example: `https://mysite.com/_api/oauth2/authorize`.
|
|
@@ -38,7 +37,7 @@ export interface URLDetails {
|
|
|
38
37
|
/** URL query parameters. */
|
|
39
38
|
searchParams?: Record<string, string>;
|
|
40
39
|
}
|
|
41
|
-
|
|
40
|
+
interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestIntentOneOf {
|
|
42
41
|
/** Information required for generating a custom URL for a Wix Bookings checkout. */
|
|
43
42
|
bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
|
|
44
43
|
/** Information required for generating a custom URL for a Wix eCommerce checkout. */
|
|
@@ -69,7 +68,7 @@ export interface CreateRedirectSessionRequest extends CreateRedirectSessionReque
|
|
|
69
68
|
preferences?: RedirectSessionPreferences;
|
|
70
69
|
}
|
|
71
70
|
/** @oneof */
|
|
72
|
-
|
|
71
|
+
interface CreateRedirectSessionRequestIntentOneOf {
|
|
73
72
|
/** Information required for generating a custom URL for a Wix Bookings checkout. */
|
|
74
73
|
bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
|
|
75
74
|
/** Information required for generating a custom URL for a Wix eCommerce checkout. */
|
|
@@ -89,7 +88,7 @@ export interface CreateRedirectSessionRequestIntentOneOf {
|
|
|
89
88
|
/** Information required for generating a custom URL for Wix bookings book page. */
|
|
90
89
|
bookingsBook?: RedirectSessionBookingsBookParams;
|
|
91
90
|
}
|
|
92
|
-
|
|
91
|
+
interface RedirectSessionBookingsCheckoutParams {
|
|
93
92
|
/**
|
|
94
93
|
* The timezone to use when presenting the selected slot to users, in [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format. For example, `America/Santiago`.
|
|
95
94
|
*
|
|
@@ -99,7 +98,7 @@ export interface RedirectSessionBookingsCheckoutParams {
|
|
|
99
98
|
timezone?: string;
|
|
100
99
|
slotAvailability?: SlotAvailability;
|
|
101
100
|
}
|
|
102
|
-
|
|
101
|
+
interface SlotAvailability {
|
|
103
102
|
/**
|
|
104
103
|
* The slot for the corresponding session, when the session is either a single session
|
|
105
104
|
* or a specific session generated from a recurring session.
|
|
@@ -130,7 +129,7 @@ export interface SlotAvailability {
|
|
|
130
129
|
locked?: boolean | null;
|
|
131
130
|
isFromV2?: boolean;
|
|
132
131
|
}
|
|
133
|
-
|
|
132
|
+
interface Slot {
|
|
134
133
|
/**
|
|
135
134
|
* ID for the slot's corresponding session, when the session is either a single session
|
|
136
135
|
* or a specific session generated from a recurring session.
|
|
@@ -188,7 +187,7 @@ export interface Slot {
|
|
|
188
187
|
*/
|
|
189
188
|
eventId?: string | null;
|
|
190
189
|
}
|
|
191
|
-
|
|
190
|
+
interface SlotResource {
|
|
192
191
|
/**
|
|
193
192
|
* Resource ID.
|
|
194
193
|
* @format GUID
|
|
@@ -201,7 +200,7 @@ export interface SlotResource {
|
|
|
201
200
|
*/
|
|
202
201
|
name?: string | null;
|
|
203
202
|
}
|
|
204
|
-
|
|
203
|
+
interface Location {
|
|
205
204
|
/**
|
|
206
205
|
* Business location ID. Available only for locations that are business locations,
|
|
207
206
|
* meaning the `location_type` is `"OWNER_BUSINESS"`.
|
|
@@ -226,15 +225,15 @@ export interface Location {
|
|
|
226
225
|
*/
|
|
227
226
|
locationType?: LocationTypeWithLiterals;
|
|
228
227
|
}
|
|
229
|
-
|
|
228
|
+
declare enum LocationType {
|
|
230
229
|
UNDEFINED = "UNDEFINED",
|
|
231
230
|
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
232
231
|
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
233
232
|
CUSTOM = "CUSTOM"
|
|
234
233
|
}
|
|
235
234
|
/** @enumType */
|
|
236
|
-
|
|
237
|
-
|
|
235
|
+
type LocationTypeWithLiterals = LocationType | 'UNDEFINED' | 'OWNER_BUSINESS' | 'OWNER_CUSTOM' | 'CUSTOM';
|
|
236
|
+
interface WaitingList {
|
|
238
237
|
/**
|
|
239
238
|
* Total number of spots and open spots for this waitlist.
|
|
240
239
|
* For example, a Yoga class with 10 waitlist spots and 3 registered
|
|
@@ -244,7 +243,7 @@ export interface WaitingList {
|
|
|
244
243
|
/** Number of open spots for this waitlist. */
|
|
245
244
|
openSpots?: number | null;
|
|
246
245
|
}
|
|
247
|
-
|
|
246
|
+
interface BookingPolicyViolations {
|
|
248
247
|
/** Bookings policy violation. Too early to book this slot. */
|
|
249
248
|
tooEarlyToBook?: boolean | null;
|
|
250
249
|
/** Bookings policy violation. Too late to book this slot. */
|
|
@@ -252,7 +251,7 @@ export interface BookingPolicyViolations {
|
|
|
252
251
|
/** Bookings policy violation. Online booking is disabled for this slot. */
|
|
253
252
|
bookOnlineDisabled?: boolean | null;
|
|
254
253
|
}
|
|
255
|
-
|
|
254
|
+
interface NestedTimeSlot {
|
|
256
255
|
/** @format GUID */
|
|
257
256
|
serviceId?: string;
|
|
258
257
|
/** @maxLength 30 */
|
|
@@ -263,7 +262,7 @@ export interface NestedTimeSlot {
|
|
|
263
262
|
/** Schedule ID. */
|
|
264
263
|
scheduleId?: string;
|
|
265
264
|
}
|
|
266
|
-
|
|
265
|
+
interface RedirectSessionEcomCheckoutParams {
|
|
267
266
|
/**
|
|
268
267
|
* - 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).
|
|
269
268
|
* - REST: Use [Create Checkout From Cart](https://dev.wix.com/docs/rest/business-solutions/e-commerce/cart/create-checkout-from-cart).
|
|
@@ -271,13 +270,13 @@ export interface RedirectSessionEcomCheckoutParams {
|
|
|
271
270
|
*/
|
|
272
271
|
checkoutId?: string;
|
|
273
272
|
}
|
|
274
|
-
|
|
273
|
+
interface RedirectSessionEventsCheckoutParams {
|
|
275
274
|
/** @format GUID */
|
|
276
275
|
reservationId?: string;
|
|
277
276
|
/** @maxLength 150 */
|
|
278
277
|
eventSlug?: string;
|
|
279
278
|
}
|
|
280
|
-
|
|
279
|
+
interface RedirectSessionPaidPlansCheckoutParams {
|
|
281
280
|
/** @format GUID */
|
|
282
281
|
planId?: string;
|
|
283
282
|
/**
|
|
@@ -287,13 +286,13 @@ export interface RedirectSessionPaidPlansCheckoutParams {
|
|
|
287
286
|
*/
|
|
288
287
|
checkoutData?: string | null;
|
|
289
288
|
}
|
|
290
|
-
|
|
289
|
+
interface RedirectSessionLoginParams {
|
|
291
290
|
}
|
|
292
|
-
|
|
291
|
+
interface RedirectSessionLogoutParams {
|
|
293
292
|
/** @format GUID */
|
|
294
293
|
clientId?: string;
|
|
295
294
|
}
|
|
296
|
-
|
|
295
|
+
interface RedirectSessionAuthParams {
|
|
297
296
|
authRequest?: AuthorizeRequest;
|
|
298
297
|
/** The type of prompt to use during the authorization process. */
|
|
299
298
|
prompt?: PromptWithLiterals;
|
|
@@ -302,7 +301,7 @@ export interface RedirectSessionAuthParams {
|
|
|
302
301
|
* AuthorizeRequest is sent by the client to the authorization server to initiate
|
|
303
302
|
* the authorization process.
|
|
304
303
|
*/
|
|
305
|
-
|
|
304
|
+
interface AuthorizeRequest {
|
|
306
305
|
/**
|
|
307
306
|
* ID of the Wix OAuth app requesting authorization.
|
|
308
307
|
* @format GUID
|
|
@@ -368,7 +367,7 @@ export interface AuthorizeRequest {
|
|
|
368
367
|
signInUrl?: string | null;
|
|
369
368
|
}
|
|
370
369
|
/** Specifies the behavior of the authorization flow regarding site member authentication and consent. */
|
|
371
|
-
|
|
370
|
+
declare enum Prompt {
|
|
372
371
|
/** Display the login page to the member, prompting them to enter their credentials. */
|
|
373
372
|
login = "login",
|
|
374
373
|
/**
|
|
@@ -379,8 +378,8 @@ export declare enum Prompt {
|
|
|
379
378
|
none = "none"
|
|
380
379
|
}
|
|
381
380
|
/** @enumType */
|
|
382
|
-
|
|
383
|
-
|
|
381
|
+
type PromptWithLiterals = Prompt | 'login' | 'none';
|
|
382
|
+
interface RedirectSessionMembersAccountParams {
|
|
384
383
|
/**
|
|
385
384
|
* The member account page to redirect to.
|
|
386
385
|
*
|
|
@@ -388,7 +387,7 @@ export interface RedirectSessionMembersAccountParams {
|
|
|
388
387
|
*/
|
|
389
388
|
section?: MembersAccountSectionWithLiterals;
|
|
390
389
|
}
|
|
391
|
-
|
|
390
|
+
declare enum MembersAccountSection {
|
|
392
391
|
/** Account info section in "my account". */
|
|
393
392
|
ACCOUNT_INFO = "ACCOUNT_INFO",
|
|
394
393
|
/** My Bookings section in "my account". */
|
|
@@ -401,19 +400,19 @@ export declare enum MembersAccountSection {
|
|
|
401
400
|
EVENTS = "EVENTS"
|
|
402
401
|
}
|
|
403
402
|
/** @enumType */
|
|
404
|
-
|
|
405
|
-
|
|
403
|
+
type MembersAccountSectionWithLiterals = MembersAccountSection | 'ACCOUNT_INFO' | 'BOOKINGS' | 'ORDERS' | 'SUBSCRIPTIONS' | 'EVENTS';
|
|
404
|
+
interface RedirectSessionStoresProductParams {
|
|
406
405
|
/** @maxLength 150 */
|
|
407
406
|
productSlug?: string;
|
|
408
407
|
}
|
|
409
|
-
|
|
408
|
+
interface RedirectSessionBookingsBookParams {
|
|
410
409
|
/**
|
|
411
410
|
* For use when filtering the bookings page by a specific resource.
|
|
412
411
|
* @format GUID
|
|
413
412
|
*/
|
|
414
413
|
resourceId?: string;
|
|
415
414
|
}
|
|
416
|
-
|
|
415
|
+
interface CallbackParams {
|
|
417
416
|
/**
|
|
418
417
|
* The URL for a custom thank you page implemented on a site outside of Wix. The visitor is directed to this page after the Wix-managed process is completed.
|
|
419
418
|
* When redirecting to this URL, Wix passes different query parameters depending on the preceding transaction:
|
|
@@ -472,7 +471,7 @@ export interface CallbackParams {
|
|
|
472
471
|
*/
|
|
473
472
|
planListUrl?: string | null;
|
|
474
473
|
}
|
|
475
|
-
|
|
474
|
+
interface RedirectSessionPreferences {
|
|
476
475
|
/**
|
|
477
476
|
* Whether to use a standard Wix template for Wix-managed pages the visitor is redirected to. Set to `false` only if your client site connects with a Wix site that has custom pages.
|
|
478
477
|
*
|
|
@@ -486,12 +485,16 @@ export interface RedirectSessionPreferences {
|
|
|
486
485
|
*/
|
|
487
486
|
maintainIdentity?: boolean | null;
|
|
488
487
|
/**
|
|
489
|
-
* Map of
|
|
490
|
-
*
|
|
488
|
+
* Map of global query parameters to append to the Wix URL.
|
|
489
|
+
*
|
|
490
|
+
* Common parameters include:
|
|
491
|
+
* - [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters): Use to track the source of site traffic.
|
|
492
|
+
*
|
|
493
|
+
* - `lang`: Use to control the displayed language of the Wix-managed page. For supported values, see [ISO 639 language codes](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).
|
|
491
494
|
*/
|
|
492
495
|
additionalQueryParameters?: Record<string, string>;
|
|
493
496
|
}
|
|
494
|
-
|
|
497
|
+
interface CustomMemberPaths {
|
|
495
498
|
/**
|
|
496
499
|
* Path of the account page in the site's members area. Required if `useGenericWixPages` is `false` and the account page path has been changed in the Wix editor.
|
|
497
500
|
* @format URL_SLUG
|
|
@@ -503,11 +506,11 @@ export interface CustomMemberPaths {
|
|
|
503
506
|
*/
|
|
504
507
|
profilePagePath?: string | null;
|
|
505
508
|
}
|
|
506
|
-
|
|
509
|
+
interface CreateRedirectSessionResponse {
|
|
507
510
|
/** Details for redirecting the visitor to a Wix page. */
|
|
508
511
|
redirectSession?: RedirectSession;
|
|
509
512
|
}
|
|
510
|
-
|
|
513
|
+
interface CreateAnonymousRedirectSessionRequest extends CreateAnonymousRedirectSessionRequestIntentOneOf {
|
|
511
514
|
/** Information required for generating a custom URL for a Wix Bookings checkout. */
|
|
512
515
|
bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
|
|
513
516
|
/** Information required for generating a custom URL for a Wix eCommerce checkout. */
|
|
@@ -524,7 +527,7 @@ export interface CreateAnonymousRedirectSessionRequest extends CreateAnonymousRe
|
|
|
524
527
|
preferences?: RedirectSessionPreferences;
|
|
525
528
|
}
|
|
526
529
|
/** @oneof */
|
|
527
|
-
|
|
530
|
+
interface CreateAnonymousRedirectSessionRequestIntentOneOf {
|
|
528
531
|
/** Information required for generating a custom URL for a Wix Bookings checkout. */
|
|
529
532
|
bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
|
|
530
533
|
/** Information required for generating a custom URL for a Wix eCommerce checkout. */
|
|
@@ -538,18 +541,18 @@ export interface CreateAnonymousRedirectSessionRequestIntentOneOf {
|
|
|
538
541
|
/** Information required for generating a custom URL for Wix bookings book page. */
|
|
539
542
|
bookingsBook?: RedirectSessionBookingsBookParams;
|
|
540
543
|
}
|
|
541
|
-
|
|
544
|
+
interface CreateAnonymousRedirectSessionResponse {
|
|
542
545
|
/** Details for redirecting the visitor to a Wix page. */
|
|
543
546
|
redirectSession?: RedirectSession;
|
|
544
547
|
}
|
|
545
|
-
|
|
548
|
+
interface AttachPagesRequest {
|
|
546
549
|
/**
|
|
547
550
|
* App ID that we want to inherit pages for.
|
|
548
551
|
* @format GUID
|
|
549
552
|
*/
|
|
550
553
|
appDefId?: string;
|
|
551
554
|
}
|
|
552
|
-
|
|
555
|
+
interface AttachPagesResponse {
|
|
553
556
|
/** The status of the operation. */
|
|
554
557
|
status?: AttachPagesResponseStatusWithLiterals;
|
|
555
558
|
/**
|
|
@@ -562,7 +565,7 @@ export interface AttachPagesResponse {
|
|
|
562
565
|
/** True if the site was already published */
|
|
563
566
|
sitePublished?: boolean;
|
|
564
567
|
}
|
|
565
|
-
|
|
568
|
+
declare enum AttachPagesResponseStatus {
|
|
566
569
|
/** Invalid value. */
|
|
567
570
|
UNKNOWN = "UNKNOWN",
|
|
568
571
|
/** Pages were successfully attached. */
|
|
@@ -573,8 +576,8 @@ export declare enum AttachPagesResponseStatus {
|
|
|
573
576
|
ERROR = "ERROR"
|
|
574
577
|
}
|
|
575
578
|
/** @enumType */
|
|
576
|
-
|
|
577
|
-
|
|
579
|
+
type AttachPagesResponseStatusWithLiterals = AttachPagesResponseStatus | 'UNKNOWN' | 'SUCCESS' | 'NO_ACTION' | 'ERROR';
|
|
580
|
+
interface ValidateCallbackURLRequest {
|
|
578
581
|
/**
|
|
579
582
|
* An external URL to validate
|
|
580
583
|
* @maxLength 2048
|
|
@@ -588,7 +591,7 @@ export interface ValidateCallbackURLRequest {
|
|
|
588
591
|
*/
|
|
589
592
|
clientId?: string;
|
|
590
593
|
}
|
|
591
|
-
|
|
594
|
+
declare enum CallbackType {
|
|
592
595
|
/** Invalid value. */
|
|
593
596
|
UNKNOWN = "UNKNOWN",
|
|
594
597
|
/** Callback URL is used for the logout flow. */
|
|
@@ -599,29 +602,29 @@ export declare enum CallbackType {
|
|
|
599
602
|
AUTHORIZE = "AUTHORIZE"
|
|
600
603
|
}
|
|
601
604
|
/** @enumType */
|
|
602
|
-
|
|
603
|
-
|
|
605
|
+
type CallbackTypeWithLiterals = CallbackType | 'UNKNOWN' | 'LOGOUT' | 'CHECKOUT' | 'AUTHORIZE';
|
|
606
|
+
interface ValidateCallbackURLResponse {
|
|
604
607
|
/** Indicates if the provided URL is allowed for the given client id */
|
|
605
608
|
isValid?: boolean;
|
|
606
609
|
}
|
|
607
|
-
|
|
610
|
+
interface SignInURLRequest {
|
|
608
611
|
/**
|
|
609
612
|
* The oauth app id used in order to pull the allowed domains from, has to correspond to the same metasite as the site in context
|
|
610
613
|
* @format GUID
|
|
611
614
|
*/
|
|
612
615
|
clientId?: string;
|
|
613
616
|
}
|
|
614
|
-
|
|
617
|
+
interface SignInURLResponse {
|
|
615
618
|
/** The Wix URL details to redirect into */
|
|
616
619
|
redirectSession?: RedirectSession;
|
|
617
620
|
}
|
|
618
|
-
|
|
621
|
+
interface AttachAllTemplatesRequest {
|
|
619
622
|
}
|
|
620
|
-
|
|
623
|
+
interface AttachAllTemplatesResponse {
|
|
621
624
|
/** The status of the operation. */
|
|
622
625
|
status?: StatusWithLiterals;
|
|
623
626
|
}
|
|
624
|
-
|
|
627
|
+
declare enum Status {
|
|
625
628
|
/** Invalid value. */
|
|
626
629
|
UNKNOWN = "UNKNOWN",
|
|
627
630
|
/** Templates were successfully attached. */
|
|
@@ -630,8 +633,8 @@ export declare enum Status {
|
|
|
630
633
|
ERROR = "ERROR"
|
|
631
634
|
}
|
|
632
635
|
/** @enumType */
|
|
633
|
-
|
|
634
|
-
|
|
636
|
+
type StatusWithLiterals = Status | 'UNKNOWN' | 'SUCCESS' | 'ERROR';
|
|
637
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
635
638
|
createdEvent?: EntityCreatedEvent;
|
|
636
639
|
updatedEvent?: EntityUpdatedEvent;
|
|
637
640
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -666,19 +669,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
666
669
|
entityEventSequence?: string | null;
|
|
667
670
|
}
|
|
668
671
|
/** @oneof */
|
|
669
|
-
|
|
672
|
+
interface DomainEventBodyOneOf {
|
|
670
673
|
createdEvent?: EntityCreatedEvent;
|
|
671
674
|
updatedEvent?: EntityUpdatedEvent;
|
|
672
675
|
deletedEvent?: EntityDeletedEvent;
|
|
673
676
|
actionEvent?: ActionEvent;
|
|
674
677
|
}
|
|
675
|
-
|
|
678
|
+
interface EntityCreatedEvent {
|
|
676
679
|
entity?: string;
|
|
677
680
|
}
|
|
678
|
-
|
|
681
|
+
interface RestoreInfo {
|
|
679
682
|
deletedDate?: Date | null;
|
|
680
683
|
}
|
|
681
|
-
|
|
684
|
+
interface EntityUpdatedEvent {
|
|
682
685
|
/**
|
|
683
686
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
684
687
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -686,14 +689,14 @@ export interface EntityUpdatedEvent {
|
|
|
686
689
|
*/
|
|
687
690
|
currentEntity?: string;
|
|
688
691
|
}
|
|
689
|
-
|
|
692
|
+
interface EntityDeletedEvent {
|
|
690
693
|
/** Entity that was deleted. */
|
|
691
694
|
deletedEntity?: string | null;
|
|
692
695
|
}
|
|
693
|
-
|
|
696
|
+
interface ActionEvent {
|
|
694
697
|
body?: string;
|
|
695
698
|
}
|
|
696
|
-
|
|
699
|
+
interface MessageEnvelope {
|
|
697
700
|
/**
|
|
698
701
|
* App instance ID.
|
|
699
702
|
* @format GUID
|
|
@@ -709,7 +712,7 @@ export interface MessageEnvelope {
|
|
|
709
712
|
/** Stringify payload. */
|
|
710
713
|
data?: string;
|
|
711
714
|
}
|
|
712
|
-
|
|
715
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
713
716
|
/**
|
|
714
717
|
* ID of a site visitor that has not logged in to the site.
|
|
715
718
|
* @format GUID
|
|
@@ -734,7 +737,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
734
737
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
735
738
|
}
|
|
736
739
|
/** @oneof */
|
|
737
|
-
|
|
740
|
+
interface IdentificationDataIdOneOf {
|
|
738
741
|
/**
|
|
739
742
|
* ID of a site visitor that has not logged in to the site.
|
|
740
743
|
* @format GUID
|
|
@@ -756,7 +759,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
756
759
|
*/
|
|
757
760
|
appId?: string;
|
|
758
761
|
}
|
|
759
|
-
|
|
762
|
+
declare enum WebhookIdentityType {
|
|
760
763
|
UNKNOWN = "UNKNOWN",
|
|
761
764
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
762
765
|
MEMBER = "MEMBER",
|
|
@@ -764,8 +767,8 @@ export declare enum WebhookIdentityType {
|
|
|
764
767
|
APP = "APP"
|
|
765
768
|
}
|
|
766
769
|
/** @enumType */
|
|
767
|
-
|
|
768
|
-
|
|
770
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
771
|
+
interface BaseEventMetadata {
|
|
769
772
|
/**
|
|
770
773
|
* App instance ID.
|
|
771
774
|
* @format GUID
|
|
@@ -779,7 +782,7 @@ export interface BaseEventMetadata {
|
|
|
779
782
|
/** The identification type and identity data. */
|
|
780
783
|
identity?: IdentificationData;
|
|
781
784
|
}
|
|
782
|
-
|
|
785
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
783
786
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
784
787
|
_id?: string;
|
|
785
788
|
/**
|
|
@@ -809,75 +812,11 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
809
812
|
*/
|
|
810
813
|
entityEventSequence?: string | null;
|
|
811
814
|
}
|
|
812
|
-
|
|
815
|
+
interface RedirectSessionCreatedEnvelope {
|
|
813
816
|
entity: RedirectSession;
|
|
814
817
|
metadata: EventMetadata;
|
|
815
818
|
}
|
|
816
|
-
|
|
817
|
-
* Triggered when a redirect session is created.
|
|
818
|
-
* @permissionScope Manage Stores
|
|
819
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
820
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
821
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
822
|
-
* @permissionScope Manage Events
|
|
823
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
824
|
-
* @permissionScope Manage Challenges
|
|
825
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
826
|
-
* @permissionScope Manage Portfolio
|
|
827
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
828
|
-
* @permissionScope Access Verticals by Automations
|
|
829
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
830
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
831
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
832
|
-
* @permissionScope Set Up Automations
|
|
833
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
834
|
-
* @permissionId WIX_HEADLESS.WIX_URL_CREATE
|
|
835
|
-
* @webhook
|
|
836
|
-
* @eventType wix.headless.v1.redirect_session_created
|
|
837
|
-
* @serviceIdentifier wix.headless.v1.RedirectSessionService
|
|
838
|
-
* @slug created
|
|
839
|
-
*/
|
|
840
|
-
export declare function onRedirectSessionCreated(handler: (event: RedirectSessionCreatedEnvelope) => void | Promise<void>): void;
|
|
841
|
-
type RedirectSessionNonNullablePaths = `_id` | `fullUrl` | `urlDetails.endpoint` | `shortUrl`;
|
|
842
|
-
/**
|
|
843
|
-
* Creates a URL for redirecting a visitor from an external client site to a Wix page for Wix-managed functionality.
|
|
844
|
-
*
|
|
845
|
-
* 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.
|
|
846
|
-
* 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.
|
|
847
|
-
*
|
|
848
|
-
* To initiate a redirect session:
|
|
849
|
-
*
|
|
850
|
-
* 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.
|
|
851
|
-
* 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.
|
|
852
|
-
* 1. Make sure the pages at the callback URLs you provided take care of the next stages in your visitor flow.
|
|
853
|
-
* @public
|
|
854
|
-
* @requiredField options.intent
|
|
855
|
-
* @param options - Options for creating a redirect session.
|
|
856
|
-
* @permissionId WIX_HEADLESS.WIX_URL_CREATE
|
|
857
|
-
* @permissionScope Manage Stores
|
|
858
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
859
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
860
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
861
|
-
* @permissionScope Manage Events
|
|
862
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
863
|
-
* @permissionScope Manage Challenges
|
|
864
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
865
|
-
* @permissionScope Manage Portfolio
|
|
866
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
867
|
-
* @permissionScope Access Verticals by Automations
|
|
868
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
869
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
870
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
871
|
-
* @permissionScope Set Up Automations
|
|
872
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
873
|
-
* @applicableIdentity APP
|
|
874
|
-
* @applicableIdentity VISITOR
|
|
875
|
-
* @fqn wix.headless.v1.RedirectSessionService.CreateRedirectSession
|
|
876
|
-
*/
|
|
877
|
-
export declare function createRedirectSession(options?: CreateRedirectSessionOptions): Promise<NonNullablePaths<CreateRedirectSessionResponse, {
|
|
878
|
-
[P in RedirectSessionNonNullablePaths]: `redirectSession.${P}`;
|
|
879
|
-
}[RedirectSessionNonNullablePaths]>>;
|
|
880
|
-
export interface CreateRedirectSessionOptions extends CreateRedirectSessionOptionsIntentOneOf {
|
|
819
|
+
interface CreateRedirectSessionOptions extends CreateRedirectSessionOptionsIntentOneOf {
|
|
881
820
|
/** Information required for generating a custom URL for a Wix Bookings checkout. */
|
|
882
821
|
bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
|
|
883
822
|
/** Information required for generating a custom URL for a Wix eCommerce checkout. */
|
|
@@ -906,7 +845,7 @@ export interface CreateRedirectSessionOptions extends CreateRedirectSessionOptio
|
|
|
906
845
|
preferences?: RedirectSessionPreferences;
|
|
907
846
|
}
|
|
908
847
|
/** @oneof */
|
|
909
|
-
|
|
848
|
+
interface CreateRedirectSessionOptionsIntentOneOf {
|
|
910
849
|
/** Information required for generating a custom URL for a Wix Bookings checkout. */
|
|
911
850
|
bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
|
|
912
851
|
/** Information required for generating a custom URL for a Wix eCommerce checkout. */
|
|
@@ -926,4 +865,5 @@ export interface CreateRedirectSessionOptionsIntentOneOf {
|
|
|
926
865
|
/** Information required for generating a custom URL for Wix bookings book page. */
|
|
927
866
|
bookingsBook?: RedirectSessionBookingsBookParams;
|
|
928
867
|
}
|
|
929
|
-
|
|
868
|
+
|
|
869
|
+
export { type MessageEnvelope as $, AttachPagesResponseStatus as A, type BookingPolicyViolations as B, type CreateRedirectSessionOptions as C, type CreateAnonymousRedirectSessionResponse as D, type AttachPagesRequest as E, type AttachPagesResponse as F, type ValidateCallbackURLResponse as G, type SignInURLRequest as H, type SignInURLResponse as I, type AttachAllTemplatesRequest as J, type AttachAllTemplatesResponse as K, LocationType as L, MembersAccountSection as M, type NestedTimeSlot as N, type DomainEvent as O, Prompt as P, type DomainEventBodyOneOf as Q, type RedirectSessionCreatedEnvelope as R, Status as S, type EntityCreatedEvent as T, type URLDetails as U, type ValidateCallbackURLRequest as V, WebhookIdentityType as W, type RestoreInfo as X, type EntityUpdatedEvent as Y, type EntityDeletedEvent as Z, type ActionEvent as _, type CreateRedirectSessionResponse as a, type IdentificationData as a0, type IdentificationDataIdOneOf as a1, type BaseEventMetadata as a2, type EventMetadata as a3, type CreateRedirectSessionOptionsIntentOneOf as a4, CallbackType as b, type RedirectSession as c, type CreateRedirectSessionRequest as d, type CreateRedirectSessionRequestIntentOneOf as e, type RedirectSessionBookingsCheckoutParams as f, type SlotAvailability as g, type Slot as h, type SlotResource as i, type Location as j, type WaitingList as k, type RedirectSessionEcomCheckoutParams as l, type RedirectSessionEventsCheckoutParams as m, type RedirectSessionPaidPlansCheckoutParams as n, type RedirectSessionLoginParams as o, type RedirectSessionLogoutParams as p, type RedirectSessionAuthParams as q, type AuthorizeRequest as r, type RedirectSessionMembersAccountParams as s, type RedirectSessionStoresProductParams as t, type RedirectSessionBookingsBookParams as u, type CallbackParams as v, type RedirectSessionPreferences as w, type CustomMemberPaths as x, type CreateAnonymousRedirectSessionRequest as y, type CreateAnonymousRedirectSessionRequestIntentOneOf as z };
|