@wix/redirects 1.0.47 → 1.0.49

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

@@ -0,0 +1,791 @@
+/** Information for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
+interface RedirectSession {
+    /** ID of the redirect session created. */
+    _id?: string;
+    /**
+     * The full URL of the Wix page to redirect the visitor to. This URL includes query parameters informing Wix where to redirect the visitor back to on the Wix Headless client site.
+     * @readonly
+     */
+    fullUrl?: string;
+    /** Details about the URL of the RedirectSession */
+    urlDetails?: URLDetails;
+    /**
+     * The session token to pass to the Wix page to maintain the visitor's identity.
+     * @readonly
+     */
+    sessionToken?: string | null;
+    /**
+     * The short URL of the Wix page to redirect the visitor to. This URL includes query parameters informing Wix where to redirect the visitor back to on the Wix Headless client site.
+     * @readonly
+     */
+    shortUrl?: string;
+}
+interface URLDetails {
+    /**
+     * The endpoint of the url (includes the base url and the path to the endpoint, without the query parameters)
+     * For example: `https://mysite.com/_api/oauth2/authorize`
+     * @readonly
+     */
+    endpoint?: string;
+    /** The query parameters of the url */
+    searchParams?: Record<string, string>;
+}
+interface CreateRedirectSessionRequest extends CreateRedirectSessionRequestIntentOneOf {
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
+    bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
+    ecomCheckout?: RedirectSessionEcomCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Events checkout. */
+    eventsCheckout?: RedirectSessionEventsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
+    paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
+    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    login?: RedirectSessionLoginParams;
+    /** Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser. */
+    logout?: RedirectSessionLogoutParams;
+    /** Information required for generating a custom URL for Wix authentication. */
+    auth?: RedirectSessionAuthParams;
+    /** Information required for generating a custom URL for a Wix stores product page. */
+    storesProduct?: RedirectSessionStoresProductParams;
+    /** Information required for generating a custom URL for Wix bookings book page. */
+    bookingsBook?: RedirectSessionBookingsBookParams;
+    /**
+     * Details of pages to redirect the visitor back to on the Wix Headless client site.
+     *
+     * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     */
+    callbacks?: CallbackParams;
+    /** Optional preferences for customizing redirection to Wix pages. */
+    preferences?: RedirectSessionPreferences;
+}
+/** @oneof */
+interface CreateRedirectSessionRequestIntentOneOf {
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
+    bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
+    ecomCheckout?: RedirectSessionEcomCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Events checkout. */
+    eventsCheckout?: RedirectSessionEventsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
+    paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
+    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    login?: RedirectSessionLoginParams;
+    /** Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser. */
+    logout?: RedirectSessionLogoutParams;
+    /** Information required for generating a custom URL for Wix authentication. */
+    auth?: RedirectSessionAuthParams;
+    /** Information required for generating a custom URL for a Wix stores product page. */
+    storesProduct?: RedirectSessionStoresProductParams;
+    /** Information required for generating a custom URL for Wix bookings book page. */
+    bookingsBook?: RedirectSessionBookingsBookParams;
+}
+interface RedirectSessionBookingsCheckoutParams {
+    /**
+     * 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`.
+     *
+     * Default: If you don't specify a timezone, the timezone in `slotAvailability.slot.timezone` is used.
+     */
+    timezone?: string;
+    /** __Required.__ The calendar slot to check out. */
+    slotAvailability?: SlotAvailability;
+}
+interface SlotAvailability {
+    /**
+     * The slot for the corresponding session, when the session is either a single session
+     * or a specific session generated from a recurring session.
+     */
+    slot?: Slot;
+    /**
+     * Whether the slot is bookable. Bookability is determined by checking a
+     * session's open slots and booking policies. Locks are not taken into
+     * account.
+     */
+    bookable?: boolean;
+    /**
+     * Total number of spots for this slot.
+     * For example, if a session has a total of 10 spots and 3 spots are booked,
+     * `spotsTotal` is 10 and `openSpots` is 7.
+     */
+    totalSpots?: number | null;
+    /** Number of open spots for this slot. */
+    openSpots?: number | null;
+    /** An object describing the slot's waitlist and its occupancy. */
+    waitingList?: WaitingList;
+    /** Booking policy violations for the slot. */
+    bookingPolicyViolations?: BookingPolicyViolations;
+    /**
+     * Indicates whether the slot is locked because a waitlist exists.
+     * When a slot frees up, the slot is offered to the next customer on the waitlist. Read-only.
+     */
+    locked?: boolean | null;
+    isFromV2?: boolean;
+}
+interface Slot {
+    /**
+     * ID for the slot's corresponding session, when the session is either a single session
+     * or a specific session generated from a recurring session.
+     */
+    sessionId?: string | null;
+    /** Service ID. */
+    serviceId?: string;
+    /** Schedule ID. */
+    scheduleId?: string;
+    /**
+     * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
+     * format.
+     *
+     * If `timezone` is specified,
+     * dates are based on the local date/time. This means that the timezone offset
+     * in the `startDate` is ignored.
+     */
+    startDate?: string | null;
+    /**
+     * The end time of this slot in
+     * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) format.
+     *
+     * If `timezone` is specified,
+     * dates are based on the local date/time. This means that the timezone offset
+     * 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/sdk/bookings/availabilitycalendar/queryavailability#bookings_availabilitycalendar_queryavailability_handling-daylight-savings-time-dst-for-local-time-zones)
+     * when calculating availability.
+     */
+    timezone?: string | null;
+    /**
+     * The resource required for this slot. Currently, the only supported resource
+     * is the relevant staff member for the slot.
+     */
+    resource?: SlotResource;
+    /** Geographic location of the slot. */
+    location?: Location;
+}
+interface SlotResource {
+    /**
+     * Resource ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Resource name. Read only. */
+    name?: string | null;
+}
+interface Location {
+    /**
+     * Business location ID. Available only for locations that are business locations,
+     * meaning the `location_type` is `"OWNER_BUSINESS"`.
+     */
+    _id?: string | null;
+    /** Location name. */
+    name?: string | null;
+    /** The full address of this location. */
+    formattedAddress?: string | null;
+    /**
+     * Location type.
+     *
+     * - `"OWNER_BUSINESS"`: The business address, as set in the site’s general settings.
+     * - `"OWNER_CUSTOM"`: The address as set when creating the service.
+     * - `"CUSTOM"`: The address as set for the individual session.
+     */
+    locationType?: LocationType;
+}
+declare enum LocationType {
+    UNDEFINED = "UNDEFINED",
+    OWNER_BUSINESS = "OWNER_BUSINESS",
+    OWNER_CUSTOM = "OWNER_CUSTOM",
+    CUSTOM = "CUSTOM"
+}
+interface WaitingList {
+    /**
+     * Total number of spots and open spots for this waitlist.
+     * For example, a Yoga class with 10 waitlist spots and 3 registered
+     * on the waitlist has 10 `total_spots` and 7 `open_spots`.
+     */
+    totalSpots?: number | null;
+    /** Number of open spots for this waitlist. */
+    openSpots?: number | null;
+}
+interface BookingPolicyViolations {
+    /** Bookings policy violation. Too early to book this slot. */
+    tooEarlyToBook?: boolean | null;
+    /** Bookings policy violation. Too late to book this slot. */
+    tooLateToBook?: boolean | null;
+    /** Bookings policy violation. Online booking is disabled for this slot. */
+    bookOnlineDisabled?: boolean | null;
+}
+interface NestedTimeSlot {
+    serviceId?: string;
+    start?: string;
+    end?: string;
+    resource?: SlotResource;
+    /** Schedule ID. */
+    scheduleId?: string;
+}
+interface RedirectSessionEcomCheckoutParams {
+    /** __Required.__ ID of the checkout to process. Use [`createCheckout()`](https://dev.wix.com/api/sdk/ecom/checkout/createcheckout) or [`createCheckoutFromCurrentCart()`](https://dev.wix.com/api/sdk/ecom/currentcart/createcheckoutfromcurrentcart) to create a checkout and obtain an ID. */
+    checkoutId?: string;
+}
+interface RedirectSessionEventsCheckoutParams {
+    /** __Required.__ ID of the temporary event reservation. Use [`createReservation()`](https://dev.wix.com/api/sdk/events/checkout/createreservation) to reserve a ticket temporarily and obtain a reservation ID. */
+    reservationId?: string;
+    /** __Required.__ URL-friendly event slug, generated from the event title of the event. For example, `my-event-4`. Use [`listEvents()`](https://dev.wix.com/api/sdk/events/wixevents/listevents) to obtain an event slug. */
+    eventSlug?: string;
+}
+interface RedirectSessionPaidPlansCheckoutParams {
+    /** __Required.__ ID of the paid plan selected. Use [`queryPublicPlans()`](https://dev.wix.com/api/sdk/pricing-plans/plans/querypublicplans) to obtain a paid plan ID. */
+    planId?: string;
+    /**
+     * For use when pricing plan selection is part of a checkout flow, only if the paid plan selection page is implemented on an external Wix Headless client site.
+     * In this case, a string is received by the external pricing plans page as a `checkoutData` query parameter. Pass this string back here when redirecting back to Wix for checkout.
+     */
+    checkoutData?: string | null;
+}
+interface RedirectSessionLoginParams {
+}
+interface RedirectSessionLogoutParams {
+    /** __Required.__ ID of the OAuth app authorizing the client. */
+    clientId?: string;
+}
+interface RedirectSessionAuthParams {
+    /** __Required.__ The authorization request to send to the authorization server. */
+    authRequest?: AuthorizeRequest;
+    prompt?: Prompt;
+}
+/**
+ * AuthorizeRequest is sent by the client to the authorization server to initiate
+ * the authorization process.
+ */
+interface AuthorizeRequest {
+    /** ID of the Wix OAuth app requesting authorization. */
+    clientId?: string;
+    /**
+     * Desired authorization [grant type](https://auth0.com/docs/authenticate/protocols/oauth#grant-types).
+     *
+     * Supported values:
+     * + `code`: The endpoint returns an authorization code that can be used to obtain an access token.
+     */
+    responseType?: string;
+    /** URI to redirect the browser to after authentication and authorization. The browser is redirected to this URI whether the authentication and authorization process is successful or not. */
+    redirectUri?: string | null;
+    /**
+     * Desired scope of access. If this field is left empty, only an access token is granted.
+     * To received a refresh token, pass `offline_access` as the value of this field.
+     */
+    scope?: string | null;
+    /**
+     * A value used to confirm the state of an application before and after it makes an authorization
+     * request. If a value for this field is set in the request, it's added to the `redirectUri` when the browser
+     * is redirected there.
+     * Learn more about [using the state parameter](https://auth0.com/docs/secure/attack-protection/state-parameters).
+     */
+    state?: string;
+    /**
+     * esired response format.
+     *
+     * Supported values:
+     * + `query`: The response parameters are encoded as query string parameters and added to the `redirectUri` when redirecting.
+     * + `fragment`: The response parameters are encoded as URI fragment parameters and added to the `redirectUri` when redirecting.
+     * + `web_message`: The response parameters are encoded as a JSON object and added to the body of a [web message response](https://datatracker.ietf.org/doc/html/draft-sakimura-oauth-wmrm-00).
+     *
+     * Default value: `query`
+     */
+    responseMode?: string | null;
+    /**
+     * Code challenge to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
+     */
+    codeChallenge?: string | null;
+    /**
+     * Code challenge method to use for PKCE verification.
+     * This field is only used if `responseType` is set to `code`.
+     *
+     * Supported values:
+     * + `S256`: The code challenge is transformed using SHA-256 encyption.
+     * + `S512`: The code challenge is transformed using SHA-512 encyption.
+     */
+    codeChallengeMethod?: string | null;
+    /** Session token of the site visitor to authorize. */
+    sessionToken?: string | null;
+}
+/** Currently only `none` and `login` are supported. */
+declare enum Prompt {
+    login = "login",
+    none = "none",
+    consent = "consent",
+    select_account = "select_account"
+}
+interface RedirectSessionMembersAccountParams {
+    /**
+     * The member account page to redirect to.
+     *
+     * Default: `ACCOUNT_INFO`
+     */
+    section?: MembersAccountSection;
+}
+declare enum MembersAccountSection {
+    /** default - account info section in "my account" */
+    ACCOUNT_INFO = "ACCOUNT_INFO",
+    /** My Bookings section in "my account" */
+    BOOKINGS = "BOOKINGS",
+    /** My Orders section in "my account" */
+    ORDERS = "ORDERS",
+    /** Subscriptions section in "my account" */
+    SUBSCRIPTIONS = "SUBSCRIPTIONS",
+    /** Events section in "my account" */
+    EVENTS = "EVENTS"
+}
+interface RedirectSessionStoresProductParams {
+    /** *Required.** Slug of the product to navigate to. */
+    productSlug?: string;
+}
+interface RedirectSessionBookingsBookParams {
+    /** For use when filtering the bookings page by a specific resource. */
+    resourceId?: string;
+}
+interface CallbackParams {
+    /**
+     * 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.
+     * When redirecting to this URL, Wix passes different query parameters depending on the preceding transaction:
+     *
+     * After a pricing plans checkout:
+     * + `planOrderId`: ID of a pricing plan order.
+     *
+     * After an eCommerce checkout:
+     * + `orderId`: ID of an eCommerce order.
+     *
+     * After an Events checkout
+     * + `orderNumber`: Unique order number for the transaction.
+     * + `eventId`: ID of the event.
+     *
+     * If the process is abandoned or interrupted, the visitor is redirected to the URL specified in `postFlowUrl` instead.
+     *
+     * Default: If you don't pass a URL, the visitor is redirected to a Wix thank you page, and from there to the URL specified in `postFlowUrl`.
+     */
+    thankYouPageUrl?: string | null;
+    /**
+     * The URL Wix should redirect the visitor to when the Wix-managed process is completed, abandoned, or interrupted.
+     *
+     * **Note**: For an authentication redirect, don't pass a URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     */
+    postFlowUrl?: string | null;
+    /**
+     * The URL for a custom login page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix login page is used.
+     */
+    loginUrl?: string | null;
+    /**
+     * The URL for a custom bookings services page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix bookings services page is used.
+     */
+    bookingsServiceListUrl?: string | null;
+    /**
+     * The URL for a custom eCommerce cart page implemented outside of Wix.
+     *
+     * Default: If you don't pass a URL, a Wix cart page is used.
+     */
+    cartPageUrl?: string | null;
+    /**
+     * The URL for a custom pricing plans page implemented outside of Wix. When redirecting to this URL, Wix passes the following query parameters:
+     * + `planIds`:  IDs of the pricing plans on the custom page.
+     * + `checkoutData`: Pass this string back in `options.paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
+     *
+     *  Default: If you don't pass a URL, a Wix pricing plans page is used.
+     */
+    planListUrl?: string | null;
+}
+interface RedirectSessionPreferences {
+    /**
+     * 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.
+     *
+     * Default: `true`
+     */
+    useGenericWixPages?: boolean | null;
+    /**
+     * Whether to maintain the identity used in the redirect to wix (not relevant for "logout" and "auth" intents), or to use a new visitor identity.
+     *
+     * Default: `true`
+     */
+    maintainIdentity?: boolean | null;
+    /**
+     * A map of additional query parameters to pass to the created Wix URL.
+     * Global query parameters to be passed to Wix, for example campaign parameters (UTM params).
+     */
+    additionalQueryParameters?: Record<string, string>;
+}
+interface CustomMemberPaths {
+    /** 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. */
+    accountPagePath?: string | null;
+    /** Path of the member profile page in the site's members area. Required if `useGenericWixPages` is `false` and the member profile page path has been changed in the Wix editor. */
+    profilePagePath?: string | null;
+}
+interface CreateRedirectSessionResponse {
+    /** Details for redirecting the visitor to a Wix page. */
+    redirectSession?: RedirectSession;
+}
+interface CreateAnonymousRedirectSessionRequest extends CreateAnonymousRedirectSessionRequestIntentOneOf {
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
+    bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
+    ecomCheckout?: RedirectSessionEcomCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Events checkout. */
+    eventsCheckout?: RedirectSessionEventsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
+    paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
+    /** Information required for generating a custom URL for a Wix stores product page. */
+    storesProduct?: RedirectSessionStoresProductParams;
+    /** Information required for generating a custom URL for Wix bookings book page. */
+    bookingsBook?: RedirectSessionBookingsBookParams;
+    /** Optional preferences for customizing redirection to Wix pages. */
+    preferences?: RedirectSessionPreferences;
+}
+/** @oneof */
+interface CreateAnonymousRedirectSessionRequestIntentOneOf {
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
+    bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
+    ecomCheckout?: RedirectSessionEcomCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Events checkout. */
+    eventsCheckout?: RedirectSessionEventsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
+    paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
+    /** Information required for generating a custom URL for a Wix stores product page. */
+    storesProduct?: RedirectSessionStoresProductParams;
+    /** Information required for generating a custom URL for Wix bookings book page. */
+    bookingsBook?: RedirectSessionBookingsBookParams;
+}
+interface CreateAnonymousRedirectSessionResponse {
+    /** Details for redirecting the visitor to a Wix page. */
+    redirectSession?: RedirectSession;
+}
+interface ValidateCallbackURLRequest {
+    /** An external URL to validate */
+    callbackUrl?: string;
+    /** The type of the callback URL */
+    callbackType?: CallbackType;
+    /** 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 */
+    clientId?: string;
+}
+declare enum CallbackType {
+    /** Invalid value - default */
+    UNKNOWN = "UNKNOWN",
+    /** The callback URL is used for the logout flow */
+    LOGOUT = "LOGOUT",
+    /** The callback URL is used for a checkout flow */
+    CHECKOUT = "CHECKOUT",
+    /** The callback URL is used for the authorize flow */
+    AUTHORIZE = "AUTHORIZE"
+}
+interface ValidateCallbackURLResponse {
+    /** is the provided url allowed for the given client id */
+    isValid?: boolean;
+}
+interface SignInURLRequest {
+    /** 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 */
+    clientId?: string;
+}
+interface SignInURLResponse {
+    /** The Wix URL details to redirect into */
+    redirectSession?: RedirectSession;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface CreateRedirectSessionResponseNonNullableFields {
+    redirectSession?: {
+        _id: string;
+        fullUrl: string;
+        urlDetails?: {
+            endpoint: string;
+        };
+        shortUrl: string;
+    };
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface RedirectSessionCreatedEnvelope {
+    entity: RedirectSession;
+    metadata: EventMetadata;
+}
+interface CreateRedirectSessionOptions extends CreateRedirectSessionRequestIntentOneOf {
+    /** Information required for generating a custom URL for a Wix Bookings checkout. */
+    bookingsCheckout?: RedirectSessionBookingsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix eCommerce checkout. */
+    ecomCheckout?: RedirectSessionEcomCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Events checkout. */
+    eventsCheckout?: RedirectSessionEventsCheckoutParams;
+    /** Information required for generating a custom URL for a Wix Paid Plans checkout. */
+    paidPlansCheckout?: RedirectSessionPaidPlansCheckoutParams;
+    /** Pass an empty object in this parameter to generate a URL for Wix login without first checking whether the visitor is authenticated. */
+    login?: RedirectSessionLoginParams;
+    /** Information required for generating a custom URL to log out from a Wix account. This process invalidates the visitor or member token and clears cookies associated with the Wix domain from their browser. */
+    logout?: RedirectSessionLogoutParams;
+    /** Information required for generating a custom URL for Wix authentication. */
+    auth?: RedirectSessionAuthParams;
+    /** Information required for generating a custom URL for a Wix stores product page. */
+    storesProduct?: RedirectSessionStoresProductParams;
+    /** Information required for generating a custom URL for Wix bookings book page. */
+    bookingsBook?: RedirectSessionBookingsBookParams;
+    /**
+     * Details of pages to redirect the visitor back to on the Wix Headless client site.
+     *
+     * **Note**: For an authentication redirect, don't pass a post-flow URL here. Instead, pass one in `options.auth.authRequest.redirectUri`.
+     */
+    callbacks?: CallbackParams;
+    /** Optional preferences for customizing redirection to Wix pages. */
+    preferences?: RedirectSessionPreferences;
+}
+
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+
+declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+declare function createRedirectSession(httpClient: HttpClient): (options?: CreateRedirectSessionOptions) => Promise<CreateRedirectSessionResponse & CreateRedirectSessionResponseNonNullableFields>;
+declare const onRedirectSessionCreated: EventDefinition<RedirectSessionCreatedEnvelope, "wix.headless.v1.redirect_session_created">;
+
+type index_d_ActionEvent = ActionEvent;
+type index_d_AuthorizeRequest = AuthorizeRequest;
+type index_d_BaseEventMetadata = BaseEventMetadata;
+type index_d_BookingPolicyViolations = BookingPolicyViolations;
+type index_d_CallbackParams = CallbackParams;
+type index_d_CallbackType = CallbackType;
+declare const index_d_CallbackType: typeof CallbackType;
+type index_d_CreateAnonymousRedirectSessionRequest = CreateAnonymousRedirectSessionRequest;
+type index_d_CreateAnonymousRedirectSessionRequestIntentOneOf = CreateAnonymousRedirectSessionRequestIntentOneOf;
+type index_d_CreateAnonymousRedirectSessionResponse = CreateAnonymousRedirectSessionResponse;
+type index_d_CreateRedirectSessionOptions = CreateRedirectSessionOptions;
+type index_d_CreateRedirectSessionRequest = CreateRedirectSessionRequest;
+type index_d_CreateRedirectSessionRequestIntentOneOf = CreateRedirectSessionRequestIntentOneOf;
+type index_d_CreateRedirectSessionResponse = CreateRedirectSessionResponse;
+type index_d_CreateRedirectSessionResponseNonNullableFields = CreateRedirectSessionResponseNonNullableFields;
+type index_d_CustomMemberPaths = CustomMemberPaths;
+type index_d_DomainEvent = DomainEvent;
+type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type index_d_EntityCreatedEvent = EntityCreatedEvent;
+type index_d_EntityDeletedEvent = EntityDeletedEvent;
+type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
+type index_d_EventMetadata = EventMetadata;
+type index_d_IdentificationData = IdentificationData;
+type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type index_d_Location = Location;
+type index_d_LocationType = LocationType;
+declare const index_d_LocationType: typeof LocationType;
+type index_d_MembersAccountSection = MembersAccountSection;
+declare const index_d_MembersAccountSection: typeof MembersAccountSection;
+type index_d_MessageEnvelope = MessageEnvelope;
+type index_d_NestedTimeSlot = NestedTimeSlot;
+type index_d_Prompt = Prompt;
+declare const index_d_Prompt: typeof Prompt;
+type index_d_RedirectSession = RedirectSession;
+type index_d_RedirectSessionAuthParams = RedirectSessionAuthParams;
+type index_d_RedirectSessionBookingsBookParams = RedirectSessionBookingsBookParams;
+type index_d_RedirectSessionBookingsCheckoutParams = RedirectSessionBookingsCheckoutParams;
+type index_d_RedirectSessionCreatedEnvelope = RedirectSessionCreatedEnvelope;
+type index_d_RedirectSessionEcomCheckoutParams = RedirectSessionEcomCheckoutParams;
+type index_d_RedirectSessionEventsCheckoutParams = RedirectSessionEventsCheckoutParams;
+type index_d_RedirectSessionLoginParams = RedirectSessionLoginParams;
+type index_d_RedirectSessionLogoutParams = RedirectSessionLogoutParams;
+type index_d_RedirectSessionMembersAccountParams = RedirectSessionMembersAccountParams;
+type index_d_RedirectSessionPaidPlansCheckoutParams = RedirectSessionPaidPlansCheckoutParams;
+type index_d_RedirectSessionPreferences = RedirectSessionPreferences;
+type index_d_RedirectSessionStoresProductParams = RedirectSessionStoresProductParams;
+type index_d_SignInURLRequest = SignInURLRequest;
+type index_d_SignInURLResponse = SignInURLResponse;
+type index_d_Slot = Slot;
+type index_d_SlotAvailability = SlotAvailability;
+type index_d_SlotResource = SlotResource;
+type index_d_URLDetails = URLDetails;
+type index_d_ValidateCallbackURLRequest = ValidateCallbackURLRequest;
+type index_d_ValidateCallbackURLResponse = ValidateCallbackURLResponse;
+type index_d_WaitingList = WaitingList;
+type index_d_WebhookIdentityType = WebhookIdentityType;
+declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
+declare const index_d___metadata: typeof __metadata;
+declare const index_d_createRedirectSession: typeof createRedirectSession;
+declare const index_d_onRedirectSessionCreated: typeof onRedirectSessionCreated;
+declare namespace index_d {
+  export { type index_d_ActionEvent as ActionEvent, type index_d_AuthorizeRequest as AuthorizeRequest, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_BookingPolicyViolations as BookingPolicyViolations, type index_d_CallbackParams as CallbackParams, index_d_CallbackType as CallbackType, type index_d_CreateAnonymousRedirectSessionRequest as CreateAnonymousRedirectSessionRequest, type index_d_CreateAnonymousRedirectSessionRequestIntentOneOf as CreateAnonymousRedirectSessionRequestIntentOneOf, type index_d_CreateAnonymousRedirectSessionResponse as CreateAnonymousRedirectSessionResponse, type index_d_CreateRedirectSessionOptions as CreateRedirectSessionOptions, type index_d_CreateRedirectSessionRequest as CreateRedirectSessionRequest, type index_d_CreateRedirectSessionRequestIntentOneOf as CreateRedirectSessionRequestIntentOneOf, type index_d_CreateRedirectSessionResponse as CreateRedirectSessionResponse, type index_d_CreateRedirectSessionResponseNonNullableFields as CreateRedirectSessionResponseNonNullableFields, type index_d_CustomMemberPaths as CustomMemberPaths, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_Location as Location, index_d_LocationType as LocationType, index_d_MembersAccountSection as MembersAccountSection, type index_d_MessageEnvelope as MessageEnvelope, type index_d_NestedTimeSlot as NestedTimeSlot, index_d_Prompt as Prompt, type index_d_RedirectSession as RedirectSession, type index_d_RedirectSessionAuthParams as RedirectSessionAuthParams, type index_d_RedirectSessionBookingsBookParams as RedirectSessionBookingsBookParams, type index_d_RedirectSessionBookingsCheckoutParams as RedirectSessionBookingsCheckoutParams, type index_d_RedirectSessionCreatedEnvelope as RedirectSessionCreatedEnvelope, type index_d_RedirectSessionEcomCheckoutParams as RedirectSessionEcomCheckoutParams, type index_d_RedirectSessionEventsCheckoutParams as RedirectSessionEventsCheckoutParams, type index_d_RedirectSessionLoginParams as RedirectSessionLoginParams, type index_d_RedirectSessionLogoutParams as RedirectSessionLogoutParams, type index_d_RedirectSessionMembersAccountParams as RedirectSessionMembersAccountParams, type index_d_RedirectSessionPaidPlansCheckoutParams as RedirectSessionPaidPlansCheckoutParams, type index_d_RedirectSessionPreferences as RedirectSessionPreferences, type index_d_RedirectSessionStoresProductParams as RedirectSessionStoresProductParams, type index_d_SignInURLRequest as SignInURLRequest, type index_d_SignInURLResponse as SignInURLResponse, type index_d_Slot as Slot, type index_d_SlotAvailability as SlotAvailability, type index_d_SlotResource as SlotResource, type index_d_URLDetails as URLDetails, type index_d_ValidateCallbackURLRequest as ValidateCallbackURLRequest, type index_d_ValidateCallbackURLResponse as ValidateCallbackURLResponse, type index_d_WaitingList as WaitingList, index_d_WebhookIdentityType as WebhookIdentityType, index_d___metadata as __metadata, index_d_createRedirectSession as createRedirectSession, index_d_onRedirectSessionCreated as onRedirectSessionCreated };
+}
+
+export { index_d as redirects };