import { BulkCreateMessagesRequest as BulkCreateMessagesRequest$1, BulkCreateMessagesResponse as BulkCreateMessagesResponse$1, ListMessagesRequest as ListMessagesRequest$1, ListMessagesResponse as ListMessagesResponse$1, MediaAttachmentUploadUrlRequest as MediaAttachmentUploadUrlRequest$1, MediaAttachmentUploadUrlResponse as MediaAttachmentUploadUrlResponse$1, BulkGetByInboxMessagesRequest as BulkGetByInboxMessagesRequest$1, BulkGetByInboxMessagesResponse as BulkGetByInboxMessagesResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; interface Message { /** * Message ID. * @maxLength 40 * @readonly */ id?: string | null; /** * Date and time the message was created. * @readonly */ createdDate?: Date | null; /** Message sender type. */ sender?: SenderWithLiterals; /** * Conversation ID. * @format GUID * @readonly */ conversationId?: string | null; /** * ID of the message that this message is answering. * @maxLength 40 */ answerTo?: string | null; /** Message type. */ messageType?: MessageTypeWithLiterals; /** Message body. */ body?: Body; /** * Message Id in the Inbox * @maxLength 40 * @readonly */ inboxId?: string | null; /** * Options site visitor can choose from. * @maxSize 10 * @maxLength 500 */ visitorOptions?: string[]; /** * List of actions that ai assistant executed on the site visitor's behalf. * @maxSize 10 * @maxLength 500 */ assistantActions?: string[]; /** * List of detailed options the visitor can choose from. * @readonly * @maxSize 50 */ visitorOptionsFields?: Record[] | null; /** * Exact status message returned by ai site chat engine, * @maxLength 50 * @readonly */ engineStatus?: string | null; } declare enum Sender { /** AI assistant. */ ASSISTANT = "ASSISTANT", /** Wix user. For example, a site admin. */ USER = "USER", /** Message was sent automatically due to widget settings. For example, a contact form. */ SYSTEM = "SYSTEM", /** Site visitor. */ SITE_VISITOR = "SITE_VISITOR" } /** @enumType */ type SenderWithLiterals = Sender | 'ASSISTANT' | 'USER' | 'SYSTEM' | 'SITE_VISITOR'; declare enum MessageType { /** Question. */ QUESTION = "QUESTION", /** Answer. */ ANSWER = "ANSWER", /** Intro message, as defined in the widget settings. */ INTRO = "INTRO", /** Legal disclaimer, as defined in the widget settings. */ LEGAL = "LEGAL", /** Contact form. */ CONTACT_FORM = "CONTACT_FORM", /** Message confirms that a contact form was successfully submitted. */ CONTACT_FORM_SUBMITTED = "CONTACT_FORM_SUBMITTED", /** Notification for the site owner. */ SITE_OWNER_NOTIFICATION = "SITE_OWNER_NOTIFICATION", /** Message informing the site visitor that the AI assistant is offline, as defined in the widget settings. */ OFFLINE = "OFFLINE", /** Message that informs the Wix user that they have reached the maximum number of messages on their current plan. */ OUT_OF_QUOTA = "OUT_OF_QUOTA", /** User answer. */ USER_ANSWER = "USER_ANSWER", /** Site visitor site Navigation information. */ SITE_NAVIGATION = "SITE_NAVIGATION", /** Site visitor site Navigation information answer. */ NAVIGATION_ANSWER = "NAVIGATION_ANSWER", /** AI Site Chat ignored the question. */ IGNORED_ANSWER = "IGNORED_ANSWER", /** Site visitor selected an option from Message.visitor_options. */ VISITOR_OPTION_SELECTED = "VISITOR_OPTION_SELECTED", /** Site visitor added a product to the cart. */ ADD_TO_CART = "ADD_TO_CART", /** Site visitor booked a service. */ BOOK_SERVICE = "BOOK_SERVICE", /** AI assistant generated a question for the user to try. */ GENERATED_QUESTION = "GENERATED_QUESTION", /** Suggested question, as defined in the widget settings. */ SUGGESTED_QUESTION = "SUGGESTED_QUESTION", /** Wix user question for testing and training. */ USER_QUESTION = "USER_QUESTION", /** Wix assistant answer for testing and training. */ USER_QUESTION_ANSWER = "USER_QUESTION_ANSWER", /** Media uploaded by Wix user for visitor. */ WIX_USER_MEDIA = "WIX_USER_MEDIA", /** Media uploaded by visitor for Wix user. */ MEDIA = "MEDIA", /** Card template sent by the Wix User. */ WIX_USER_CARD = "WIX_USER_CARD", /** Simple template sent by the Wix User. */ WIX_USER_MINIMAL_BODY = "WIX_USER_MINIMAL_BODY", /** Form sent by the Wix User. */ WIX_USER_FORM = "WIX_USER_FORM", /** System message from comm channels. */ WIX_SYSTEM = "WIX_SYSTEM" } /** @enumType */ type MessageTypeWithLiterals = MessageType | 'QUESTION' | 'ANSWER' | 'INTRO' | 'LEGAL' | 'CONTACT_FORM' | 'CONTACT_FORM_SUBMITTED' | 'SITE_OWNER_NOTIFICATION' | 'OFFLINE' | 'OUT_OF_QUOTA' | 'USER_ANSWER' | 'SITE_NAVIGATION' | 'NAVIGATION_ANSWER' | 'IGNORED_ANSWER' | 'VISITOR_OPTION_SELECTED' | 'ADD_TO_CART' | 'BOOK_SERVICE' | 'GENERATED_QUESTION' | 'SUGGESTED_QUESTION' | 'USER_QUESTION' | 'USER_QUESTION_ANSWER' | 'WIX_USER_MEDIA' | 'MEDIA' | 'WIX_USER_CARD' | 'WIX_USER_MINIMAL_BODY' | 'WIX_USER_FORM' | 'WIX_SYSTEM'; interface Body { /** * Main text of the message. * @maxLength 4096 */ mainText?: string | null; /** * Footer text of the message. * @maxLength 4096 */ footerText?: string | null; /** * Additional data for the message. * @maxSize 30 */ additionalData?: Record[] | null; } declare enum ChatHandler { /** Unknown handler. */ UNKNOWN_HANDLER = "UNKNOWN_HANDLER", /** AI assistant. */ AI = "AI", /** Wix user, such as a site owner. */ WIX_USER = "WIX_USER" } /** @enumType */ type ChatHandlerWithLiterals = ChatHandler | 'UNKNOWN_HANDLER' | 'AI' | 'WIX_USER'; interface BulkCreateMessagesRequest { /** * Messages to be created. * @minSize 1 * @maxSize 25 */ messages?: Message[]; } interface BulkCreateMessagesResponse { /** Created messages. */ messages?: Message[]; } interface ListMessagesRequest { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; } interface CursorPaging { /** * Maximum number of items to return in the results. * @max 100 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. * @maxLength 16000 */ cursor?: string | null; } interface ListMessagesResponse { /** Retrieved messages. */ messages?: Message[]; /** Paging metadata. */ pagingMetadata?: PagingMetadataV2; } interface PagingMetadataV2 { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; } interface Cursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface MediaAttachmentUploadUrlRequest { /** @maxLength 100 */ mimeType: string; /** @maxLength 100 */ fileName?: string | null; /** @maxLength 100 */ parentFolderId?: string | null; /** @maxLength 100 */ filePath?: string | null; } interface MediaAttachmentUploadUrlResponse { /** @format WEB_URL */ uploadUrl?: string; } interface BulkGetByInboxMessagesRequest { /** * inboxConversationId of the conversation to get messages by. * @format GUID */ inboxConversationId: string | null; /** * InboxMessage.sequence * @maxLength 20 * @minSize 1 * @maxSize 100 */ inboxMessageSequences?: string[] | null; } interface BulkGetByInboxMessagesResponse { /** BulkGetByInboxMessagesResult */ results?: BulkGetByInboxMessagesResult[]; /** * BulkActionMetadata. * * If message was not found, still counts as success. * Failure to retrieve a message will result in a failure count. */ bulkActionMetadata?: BulkActionMetadata; } interface ItemMetadata { /** * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). * @format GUID */ id?: string | null; /** Index of the item within the request array. Allows for correlation between request and response items. */ originalIndex?: number; /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } interface BulkGetByInboxMessagesResult { /** ItemMetadata */ itemMetadata?: ItemMetadata; /** Message object if found, otherwise empty. */ message?: Message; } interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } interface ScheduleCreateInsightsRequest { /** @format GUID */ metaSiteId?: string; scheduleFor?: Date | null; } interface ScheduleCreateInsightsResponse { scheduledFor?: Date | null; } interface CancelCreateInsightsRequest { /** @format GUID */ metaSiteId?: string; } interface CancelCreateInsightsResponse { } interface SetupRequest { } interface SetupResponse { } interface TeardownRequest { } interface TeardownResponse { } interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; /** * A meta site id. * @format GUID */ metaSiteId?: string; /** A meta site version. Monotonically increasing. */ version?: string; /** A timestamp of the event. */ timestamp?: string; /** * TODO(meta-site): Change validation once validations are disabled for consumers * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659 * @maxSize 4000 */ assets?: Asset[]; } /** @oneof */ interface MetaSiteSpecialEventPayloadOneOf { /** Emitted on a meta site creation. */ siteCreated?: SiteCreated; /** Emitted on a meta site transfer completion. */ siteTransferred?: SiteTransferred; /** Emitted on a meta site deletion. */ siteDeleted?: SiteDeleted; /** Emitted on a meta site restoration. */ siteUndeleted?: SiteUndeleted; /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */ sitePublished?: SitePublished; /** Emitted on a meta site unpublish. */ siteUnpublished?: SiteUnpublished; /** Emitted when meta site is marked as template. */ siteMarkedAsTemplate?: SiteMarkedAsTemplate; /** Emitted when meta site is marked as a WixSite. */ siteMarkedAsWixSite?: SiteMarkedAsWixSite; /** Emitted when an application is provisioned (installed). */ serviceProvisioned?: ServiceProvisioned; /** Emitted when an application is removed (uninstalled). */ serviceRemoved?: ServiceRemoved; /** Emitted when meta site name (URL slug) is changed. */ siteRenamedPayload?: SiteRenamed; /** Emitted when meta site was permanently deleted. */ hardDeleted?: SiteHardDeleted; /** Emitted on a namespace change. */ namespaceChanged?: NamespaceChanged; /** Emitted when Studio is attached. */ studioAssigned?: StudioAssigned; /** Emitted when Studio is detached. */ studioUnassigned?: StudioUnassigned; /** * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch * the actual URL. * * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459 */ urlChanged?: SiteUrlChanged; /** Site is marked as PurgedExternally */ sitePurgedExternally?: SitePurgedExternally; /** Emitted when Odeditor is attached. */ odeditorAssigned?: OdeditorAssigned; /** Emitted when Odeditor is detached. */ odeditorUnassigned?: OdeditorUnassigned; /** Emitted when Picasso is attached. */ picassoAssigned?: PicassoAssigned; /** Emitted when Picasso is detached. */ picassoUnassigned?: PicassoUnassigned; /** Emitted when Wixel is attached. */ wixelAssigned?: WixelAssigned; /** Emitted when Wixel is detached. */ wixelUnassigned?: WixelUnassigned; /** Emitted when StudioTwo is attached. */ studioTwoAssigned?: StudioTwoAssigned; /** Emitted when StudioTwo is detached. */ studioTwoUnassigned?: StudioTwoUnassigned; /** Emitted when media from user domain is enabled. */ userDomainMediaEnabled?: UserDomainMediaEnabled; /** Emitted when media from user domain is disabled. */ userDomainMediaDisabled?: UserDomainMediaDisabled; /** Emitted when Editorless is attached. */ editorlessAssigned?: EditorlessAssigned; /** Emitted when Editorless is detached. */ editorlessUnassigned?: EditorlessUnassigned; } interface Asset { /** * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). * @maxLength 36 */ appDefId?: string; /** * An instance id. For legacy reasons may be UUID or a string. * @maxLength 200 */ instanceId?: string; /** An application state. */ state?: StateWithLiterals; } declare enum State { UNKNOWN = "UNKNOWN", ENABLED = "ENABLED", DISABLED = "DISABLED", PENDING = "PENDING", DEMO = "DEMO" } /** @enumType */ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO'; interface SiteCreated { /** * A template identifier (empty if not created from a template). * @maxLength 36 */ originTemplateId?: string; /** * An account id of the owner. * @format GUID */ ownerId?: string; /** A context in which meta site was created. */ context?: SiteCreatedContextWithLiterals; /** * A meta site id from which this site was created. * * In case of a creation from a template it's a template id. * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site. * @format GUID */ originMetaSiteId?: string | null; /** * A meta site name (URL slug). * @maxLength 20 */ siteName?: string; /** A namespace. */ namespace?: NamespaceWithLiterals; } declare enum SiteCreatedContext { /** A valid option, we don't expose all reasons why site might be created. */ OTHER = "OTHER", /** A meta site was created from template. */ FROM_TEMPLATE = "FROM_TEMPLATE", /** A meta site was created by copying of the transfferred meta site. */ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER", /** A copy of existing meta site. */ DUPLICATE = "DUPLICATE", /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER", /** deprecated A meta site was created for Flash editor. */ FLASH = "FLASH" } /** @enumType */ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH'; declare enum Namespace { UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE", /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */ WIX = "WIX", /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */ SHOUT_OUT = "SHOUT_OUT", /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ALBUMS = "ALBUMS", /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE", /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ HOTELS = "HOTELS", /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ CLUBS = "CLUBS", /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */ ONBOARDING_DRAFT = "ONBOARDING_DRAFT", /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_SITE = "DEV_SITE", /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */ LOGOS = "LOGOS", /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */ VIDEO_MAKER = "VIDEO_MAKER", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ PARTNER_DASHBOARD = "PARTNER_DASHBOARD", /** MetaSites with this namespace will *not* be shown in a user's site list by default. */ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY", /** * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain. * * Meta site with this namespace will *not* be shown in a user's site list by default. */ HTML_DRAFT = "HTML_DRAFT", /** * the user-journey for Fitness users who want to start from managing their business instead of designing their website. * Will be accessible from Site List and will not have a website app. * Once the user attaches a site, the site will become a regular wixsite. */ SITELESS_BUSINESS = "SITELESS_BUSINESS", /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */ CREATOR_ECONOMY = "CREATOR_ECONOMY", /** It is to be used in the Business First efforts. */ DASHBOARD_FIRST = "DASHBOARD_FIRST", /** Bookings business flow with no site. */ ANYWHERE = "ANYWHERE", /** Namespace for Headless Backoffice with no editor */ HEADLESS = "HEADLESS", /** * Namespace for master site that will exist in parent account that will be referenced by subaccounts * The site will be used for account level CSM feature for enterprise */ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS", /** Rise.ai Siteless account management for Gift Cards and Store Credit. */ RISE = "RISE", /** * As part of the branded app new funnel, users now can create a meta site that will be branded app first. * There's a blank site behind the scene but it's blank). * The Mobile company will be the owner of this namespace. */ BRANDED_FIRST = "BRANDED_FIRST", /** Nownia.com Siteless account management for Ai Scheduling Assistant. */ NOWNIA = "NOWNIA", /** * UGC Templates are templates that are created by users for personal use and to sale to other users. * The Partners company owns this namespace. */ UGC_TEMPLATE = "UGC_TEMPLATE", /** Codux Headless Sites */ CODUX = "CODUX", /** Bobb - AI Design Creator. */ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR", /** * Shared Blog Site is a unique single site across Enterprise account, * This site will hold all Blog posts related to the Marketing product. */ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE", /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_FORMS = "STANDALONE_FORMS", /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */ STANDALONE_EVENTS = "STANDALONE_EVENTS", /** MIMIR - Siteless account for MIMIR Ai Job runner. */ MIMIR = "MIMIR", /** Wix Twins platform. */ TWINS = "TWINS", /** Wix Nano. */ NANO = "NANO", /** Base44 headless sites. */ BASE44 = "BASE44", /** Wix Channels Sites */ CHANNELS = "CHANNELS" } /** @enumType */ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS'; /** Site transferred to another user. */ interface SiteTransferred { /** * A previous owner id (user that transfers meta site). * @format GUID */ oldOwnerId?: string; /** * A new owner id (user that accepts meta site). * @format GUID */ newOwnerId?: string; } /** Soft deletion of the meta site. Could be restored. */ interface SiteDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface DeleteContext { /** When the meta site was deleted. */ dateDeleted?: Date | null; /** A status. */ deleteStatus?: DeleteStatusWithLiterals; /** * A reason (flow). * @maxLength 255 */ deleteOrigin?: string; /** * A service that deleted it. * @maxLength 255 */ initiatorId?: string | null; } declare enum DeleteStatus { UNKNOWN = "UNKNOWN", TRASH = "TRASH", DELETED = "DELETED", PENDING_PURGE = "PENDING_PURGE", PURGED_EXTERNALLY = "PURGED_EXTERNALLY" } /** @enumType */ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY'; /** Restoration of the meta site. */ interface SiteUndeleted { } /** First publish of a meta site. Or subsequent publish after unpublish. */ interface SitePublished { } interface SiteUnpublished { /** * A list of URLs previously associated with the meta site. * @maxLength 4000 * @maxSize 10000 */ urls?: string[]; } interface SiteMarkedAsTemplate { } interface SiteMarkedAsWixSite { } /** * Represents a service provisioned a site. * * Note on `origin_instance_id`: * There is no guarantee that you will be able to find a meta site using `origin_instance_id`. * This is because of the following scenario: * * Imagine you have a template where a third-party application (TPA) includes some stub data, * such as a product catalog. When you create a site from this template, you inherit this * default product catalog. However, if the template's product catalog is modified, * your site will retain the catalog as it was at the time of site creation. This ensures that * your site remains consistent with what you initially received and does not include any * changes made to the original template afterward. * To ensure this, the TPA on the template gets a new instance_id. */ interface ServiceProvisioned { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * An instance id from which this instance is originated. * @maxLength 36 */ originInstanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; /** * The origin meta site id * @format GUID */ originMetaSiteId?: string | null; } interface ServiceRemoved { /** * Either UUID or EmbeddedServiceType. * @maxLength 36 */ appDefId?: string; /** * Not only UUID. Something here could be something weird. * @maxLength 36 */ instanceId?: string; /** * A version. * @maxLength 500 */ version?: string | null; } /** Rename of the site. Meaning, free public url has been changed as well. */ interface SiteRenamed { /** * A new meta site name (URL slug). * @maxLength 20 */ newSiteName?: string; /** * A previous meta site name (URL slug). * @maxLength 255 */ oldSiteName?: string; } /** * Hard deletion of the meta site. * * Could not be restored. Therefore it's desirable to cleanup data. */ interface SiteHardDeleted { /** A deletion context. */ deleteContext?: DeleteContext; } interface NamespaceChanged { /** A previous namespace. */ oldNamespace?: NamespaceWithLiterals; /** A new namespace. */ newNamespace?: NamespaceWithLiterals; } /** Assigned Studio editor */ interface StudioAssigned { } /** Unassigned Studio editor */ interface StudioUnassigned { } /** * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc. * * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up * with sites and its urls, you need to listen to another topic/event. Read about it: * * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service */ interface SiteUrlChanged { } /** * Used at the end of the deletion flow for both draft sites and when a user deletes a site. * Consumed by other teams to remove relevant data. */ interface SitePurgedExternally { /** * @maxLength 2048 * @maxSize 100 * @deprecated * @targetRemovalDate 2025-04-15 */ appDefId?: string[]; } /** Assigned Odeditor */ interface OdeditorAssigned { } /** Unassigned Odeditor */ interface OdeditorUnassigned { } /** Assigned Picasso editor */ interface PicassoAssigned { } /** Unassigned Picasso */ interface PicassoUnassigned { } /** Assigned Wixel */ interface WixelAssigned { } /** Unassigned Wixel */ interface WixelUnassigned { } /** Assigned StudioTwo */ interface StudioTwoAssigned { } /** Unassigned StudioTwo */ interface StudioTwoUnassigned { } /** Media from user domain is enabled. */ interface UserDomainMediaEnabled { } /** Media from user domain is disabled. */ interface UserDomainMediaDisabled { } /** Assigned Editorless */ interface EditorlessAssigned { } /** Unassigned Editorless */ interface EditorlessUnassigned { } interface Empty { } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } interface RestoreInfo { deletedDate?: Date | null; } 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; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } interface CommunicationsChannelsMessageReceived { /** @maxLength 100 */ externalMessageId?: string | null; inboxSequence?: string | null; } interface VisitorMappedToContact { /** visitor id */ visitorId?: string; /** contact id */ contactId?: string; /** previous visitor id */ previousContactId?: string | null; /** mapping valid starting on */ validFromDate?: Date | null; /** New/Existing contact */ allocationResultType?: AllocationResultTypeWithLiterals; } declare enum AllocationResultType { NEW_CONTACT = "NEW_CONTACT", EXISTING_CONTACT = "EXISTING_CONTACT" } /** @enumType */ type AllocationResultTypeWithLiterals = AllocationResultType | 'NEW_CONTACT' | 'EXISTING_CONTACT'; interface MessageEnvelope { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; /** Details related to the account */ accountInfo?: AccountInfo; } interface IdentificationData extends IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; /** @readonly */ identityType?: WebhookIdentityTypeWithLiterals; } /** @oneof */ interface IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function bulkCreateMessages(): __PublicMethodMetaInfo<'POST', {}, BulkCreateMessagesRequest$1, BulkCreateMessagesRequest, BulkCreateMessagesResponse$1, BulkCreateMessagesResponse>; declare function listMessages(): __PublicMethodMetaInfo<'GET', {}, ListMessagesRequest$1, ListMessagesRequest, ListMessagesResponse$1, ListMessagesResponse>; declare function mediaAttachmentUploadUrl(): __PublicMethodMetaInfo<'GET', {}, MediaAttachmentUploadUrlRequest$1, MediaAttachmentUploadUrlRequest, MediaAttachmentUploadUrlResponse$1, MediaAttachmentUploadUrlResponse>; declare function bulkGetByInboxMessages(): __PublicMethodMetaInfo<'GET', {}, BulkGetByInboxMessagesRequest$1, BulkGetByInboxMessagesRequest, BulkGetByInboxMessagesResponse$1, BulkGetByInboxMessagesResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, AllocationResultType as AllocationResultTypeOriginal, type AllocationResultTypeWithLiterals as AllocationResultTypeWithLiteralsOriginal, type ApplicationError as ApplicationErrorOriginal, type Asset as AssetOriginal, type Body as BodyOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateMessagesRequest as BulkCreateMessagesRequestOriginal, type BulkCreateMessagesResponse as BulkCreateMessagesResponseOriginal, type BulkGetByInboxMessagesRequest as BulkGetByInboxMessagesRequestOriginal, type BulkGetByInboxMessagesResponse as BulkGetByInboxMessagesResponseOriginal, type BulkGetByInboxMessagesResult as BulkGetByInboxMessagesResultOriginal, type CancelCreateInsightsRequest as CancelCreateInsightsRequestOriginal, type CancelCreateInsightsResponse as CancelCreateInsightsResponseOriginal, ChatHandler as ChatHandlerOriginal, type ChatHandlerWithLiterals as ChatHandlerWithLiteralsOriginal, type CommunicationsChannelsMessageReceived as CommunicationsChannelsMessageReceivedOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type ListMessagesRequest as ListMessagesRequestOriginal, type ListMessagesResponse as ListMessagesResponseOriginal, type MediaAttachmentUploadUrlRequest as MediaAttachmentUploadUrlRequestOriginal, type MediaAttachmentUploadUrlResponse as MediaAttachmentUploadUrlResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Message as MessageOriginal, MessageType as MessageTypeOriginal, type MessageTypeWithLiterals as MessageTypeWithLiteralsOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type RestoreInfo as RestoreInfoOriginal, type ScheduleCreateInsightsRequest as ScheduleCreateInsightsRequestOriginal, type ScheduleCreateInsightsResponse as ScheduleCreateInsightsResponseOriginal, Sender as SenderOriginal, type SenderWithLiterals as SenderWithLiteralsOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetupRequest as SetupRequestOriginal, type SetupResponse as SetupResponseOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type TeardownRequest as TeardownRequestOriginal, type TeardownResponse as TeardownResponseOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type VisitorMappedToContact as VisitorMappedToContactOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, bulkCreateMessages, bulkGetByInboxMessages, listMessages, mediaAttachmentUploadUrl };