@wix/auto_sdk_redirects_redirects 1.0.0

package/build/internal/es/src/headless-v1-redirect-session-redirects.types.d.ts

@@ -0,0 +1,673 @@
+/** Information for redirecting a visitor from an external Wix Headless client site to a Wix page for Wix-managed functionality. */
+export 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 redirect session. */
+    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;
+}
+export interface URLDetails {
+    /**
+     * Endpoint of the url. This includes the base URL and the path to the endpoint, without query parameters.
+     * For example: `https://mysite.com/_api/oauth2/authorize`.
+     * @readonly
+     */
+    endpoint?: string;
+    /** URL query parameters. */
+    searchParams?: Record<string, string>;
+}
+export 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;
+    /** Specify 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.
+     * When redirecting to any callback URL, Wix specifies the boolean `wixMemberLoggedIn` parameter.
+     * If `true`, a member logged in during the preceding Wix-managed process.
+     *
+     * **Note**: For an authentication redirect, don't specify a post-flow URL here. Instead, specify one in `auth.authRequest.redirectUri`.
+     */
+    callbacks?: CallbackParams;
+    /** Optional preferences for customizing redirection to Wix pages. */
+    preferences?: RedirectSessionPreferences;
+}
+/** @oneof */
+export 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;
+    /** Specify 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;
+}
+export 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;
+    slotAvailability?: SlotAvailability;
+}
+export 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;
+}
+export 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.
+     *
+     * Deprecated. Please use `eventId` instead.
+     * @deprecated ID for the slot's corresponding session, when the session is either a single session
+     * or a specific session generated from a recurring session.
+     *
+     * Deprecated. Please use `eventId` instead.
+     * @replacedBy event_id
+     * @targetRemovalDate 2025-09-30
+     */
+    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 `start_date` 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 `end_date` is ignored.
+     */
+    endDate?: string | null;
+    /**
+     * The timezone for which slot availability is to be calculated.
+     *
+     * Learn more about [handling Daylight Savings Time (DST) for local time zones](https://dev.wix.com/api/rest/wix-bookings/availability-calendar/query-availability#wix-bookings_availability-calendar_query-availability_handling-daylight-savings-time-dst-for-local-time-zones)
+     * 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;
+    /**
+     * ID for the slot's corresponding event, when the event is either a single event
+     * or a specific event generated from a recurring event.
+     */
+    eventId?: string | null;
+}
+export interface SlotResource {
+    /**
+     * Resource ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** Resource name. Read only. */
+    name?: string | null;
+}
+export 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;
+    /** The full translated address of this location. */
+    formattedAddressTranslated?: 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;
+}
+export declare enum LocationType {
+    UNDEFINED = "UNDEFINED",
+    OWNER_BUSINESS = "OWNER_BUSINESS",
+    OWNER_CUSTOM = "OWNER_CUSTOM",
+    CUSTOM = "CUSTOM"
+}
+export 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;
+}
+export 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;
+}
+export interface NestedTimeSlot {
+    serviceId?: string;
+    start?: string;
+    end?: string;
+    resource?: SlotResource;
+    /** Schedule ID. */
+    scheduleId?: string;
+}
+export interface RedirectSessionEcomCheckoutParams {
+    /**
+     * - 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).
+     * - REST: Use [Create Checkout From Cart](https://dev.wix.com/docs/rest/business-solutions/e-commerce/cart/create-checkout-from-cart).
+     */
+    checkoutId?: string;
+}
+export interface RedirectSessionEventsCheckoutParams {
+    reservationId?: string;
+    eventSlug?: string;
+}
+export interface RedirectSessionPaidPlansCheckoutParams {
+    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;
+}
+export interface RedirectSessionLoginParams {
+}
+export interface RedirectSessionLogoutParams {
+    clientId?: string;
+}
+export interface RedirectSessionAuthParams {
+    authRequest?: AuthorizeRequest;
+    /** prompt type */
+    prompt?: Prompt;
+}
+/**
+ * AuthorizeRequest is sent by the client to the authorization server to initiate
+ * the authorization process.
+ */
+export 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;
+    /** URL to redirect user to sign in */
+    signInUrl?: string | null;
+}
+/** Currently only `none` and `login` are supported. */
+export declare enum Prompt {
+    login = "login",
+    none = "none",
+    consent = "consent",
+    select_account = "select_account"
+}
+export interface RedirectSessionMembersAccountParams {
+    /**
+     * The member account page to redirect to.
+     *
+     * Default: `ACCOUNT_INFO`
+     */
+    section?: MembersAccountSection;
+}
+export declare enum MembersAccountSection {
+    /** 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"
+}
+export interface RedirectSessionStoresProductParams {
+    productSlug?: string;
+}
+export interface RedirectSessionBookingsBookParams {
+    /** For use when filtering the bookings page by a specific resource. */
+    resourceId?: string;
+}
+export 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 specify 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 specify a URL here. Instead, specify one in `auth.authRequest.redirectUri`.
+     */
+    postFlowUrl?: string | null;
+    /**
+     * The URL for a custom login page implemented outside of Wix.
+     *
+     * Default: If you don't specify 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 specify 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 specify 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 specifies the following query parameters:
+     * + `planIds`:  IDs of the pricing plans on the custom page.
+     * + `checkoutData`: Pass this string back in `paidPlansCheckout.checkoutData` when redirecting back to Wix for checkout.
+     *
+     * Default: If you don't specify a URL, a Wix pricing plans page is used.
+     */
+    planListUrl?: string | null;
+}
+export 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;
+    /**
+     * Map of additional global query parameters to add to the created Wix URL.
+     * For example, [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters).
+     */
+    additionalQueryParameters?: Record<string, string>;
+}
+export 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;
+}
+export interface CreateRedirectSessionResponse {
+    /** Details for redirecting the visitor to a Wix page. */
+    redirectSession?: RedirectSession;
+}
+export 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 */
+export 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;
+}
+export interface CreateAnonymousRedirectSessionResponse {
+    /** Details for redirecting the visitor to a Wix page. */
+    redirectSession?: RedirectSession;
+}
+export interface AttachPagesRequest {
+    /** App ID that we want to inherit pages for. */
+    appDefId?: string;
+}
+export interface AttachPagesResponse {
+    /** The status of the operation. */
+    status?: AttachPagesResponseStatus;
+    /** A descriptive message about the operation */
+    message?: string;
+    /** True if pages were attached, false otherwise */
+    pagesAttached?: boolean;
+    /** True if the site was already published */
+    sitePublished?: boolean;
+}
+export declare enum AttachPagesResponseStatus {
+    /** Invalid value. */
+    UNKNOWN = "UNKNOWN",
+    /** Pages were successfully attached. */
+    SUCCESS = "SUCCESS",
+    /** No pages were attached because the site is already published. */
+    NO_ACTION = "NO_ACTION",
+    /** An error occurred, such as when the site or app is not found. */
+    ERROR = "ERROR"
+}
+export interface ValidateCallbackURLRequest {
+    /** An external URL to validate */
+    callbackUrl?: string;
+    /** 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;
+}
+export declare enum CallbackType {
+    /** Invalid value. */
+    UNKNOWN = "UNKNOWN",
+    /** Callback URL is used for the logout flow. */
+    LOGOUT = "LOGOUT",
+    /** Callback URL is used for a checkout flow. */
+    CHECKOUT = "CHECKOUT",
+    /** Callback URL is used for the authorize flow. */
+    AUTHORIZE = "AUTHORIZE"
+}
+export interface ValidateCallbackURLResponse {
+    /** Indicates if the provided URL is allowed for the given client id */
+    isValid?: boolean;
+}
+export 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;
+}
+export interface SignInURLResponse {
+    /** The Wix URL details to redirect into */
+    redirectSession?: RedirectSession;
+}
+export interface AttachAllTemplatesRequest {
+}
+export interface AttachAllTemplatesResponse {
+    /** The status of the operation. */
+    status?: Status;
+}
+export declare enum Status {
+    /** Invalid value. */
+    UNKNOWN = "UNKNOWN",
+    /** Templates were successfully attached. */
+    SUCCESS = "SUCCESS",
+    /** An error occurred. */
+    ERROR = "ERROR"
+}
+export 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 in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * 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 */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export 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 */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface URLDetailsNonNullableFields {
+    endpoint: string;
+}
+interface RedirectSessionNonNullableFields {
+    id: string;
+    fullUrl: string;
+    urlDetails?: URLDetailsNonNullableFields;
+    shortUrl: string;
+}
+export interface CreateRedirectSessionResponseNonNullableFields {
+    redirectSession?: RedirectSessionNonNullableFields;
+}
+export {};