@wix/auto_sdk_standalone-forms_standalone-forms 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,1409 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface StandaloneForm {
+    /**
+     * Standalone form ID. Automatically generated when the standalone form is created.
+     *
+     * Together with `accountSlug`, this ID forms part of the standalone form's public URL.
+     * @maxLength 36
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * ID of the form, managed through the Wix Forms API, that this record marks as standalone.
+     *
+     * A form doesn't itself indicate whether it's standalone. The existence of a standalone form
+     * record that references it is what makes the form standalone.
+     * @format GUID
+     */
+    formId?: string | null;
+    /**
+     * ID of the meta site that owns the standalone form.
+     *
+     * The meta site owns the form. Because this service doesn't use meta site tenancy, the owning
+     * meta site is stored explicitly in this field. Set from the calling context when the form is created.
+     * @format GUID
+     * @readonly
+     */
+    metaSiteId?: string | null;
+    /**
+     * Date and time the standalone form was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the standalone form was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Account slug of the site owner, captured when the standalone form was created.
+     *
+     * Together with `id`, the slug forms part of the standalone form's public URL. May be empty
+     * if it couldn't be resolved at creation time.
+     * @maxLength 50
+     * @readonly
+     */
+    accountSlug?: string | null;
+}
+interface GetOrCreateFormStandaloneMetaSiteRequest {
+}
+interface GetOrCreateFormStandaloneMetaSiteResponse {
+    /**
+     * MetaSiteId
+     * @format GUID
+     */
+    metaSiteId?: string;
+}
+interface CreateStandaloneFormRequest {
+    /** Standalone form */
+    standaloneForm: StandaloneForm;
+}
+interface CreateStandaloneFormResponse {
+    /** Standalone form */
+    standaloneForm?: StandaloneForm;
+}
+interface GetStandaloneFormRequest {
+    /**
+     * Standalone form id
+     * @maxLength 36
+     */
+    standaloneFormId: string;
+}
+interface GetStandaloneFormResponse {
+    /** Standalone form */
+    standaloneForm?: StandaloneForm;
+}
+interface DeleteStandaloneFormRequest {
+    /**
+     * Standalone form id
+     * @maxLength 36
+     */
+    standaloneFormId: string;
+    /**
+     * Whether to permanently delete a standalone form bypassing the trash bin.
+     *
+     * Default: `false`
+     */
+    permanent?: boolean;
+}
+interface DeleteStandaloneFormResponse {
+}
+interface RemoveStandaloneFormFromTrashBinRequest {
+    /**
+     * Standalone form id
+     * @maxLength 36
+     */
+    standaloneFormId: string;
+}
+interface RemoveStandaloneFormFromTrashBinResponse {
+}
+interface RestoreStandaloneFormFromTrashBinRequest {
+    /**
+     * Standalone form id
+     * @maxLength 36
+     */
+    standaloneFormId: string;
+}
+interface RestoreStandaloneFormFromTrashBinResponse {
+    /** Standalone form */
+    standaloneForm?: StandaloneForm;
+}
+interface GetDeletedStandaloneFormRequest {
+    /**
+     * Standalone form id
+     * @maxLength 36
+     */
+    standaloneFormId: string;
+}
+interface GetDeletedStandaloneFormResponse {
+    /** Standalone form */
+    standaloneForm?: StandaloneForm;
+}
+interface ListDeletedStandaloneFormsRequest {
+    /**
+     * Standalone Form ids.
+     * @maxSize 100
+     * @maxLength 36
+     */
+    standaloneFormIds?: string[];
+    /** Cursor token pointing to a page of results. Not used in the first request. */
+    paging?: CursorPaging;
+}
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get 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 ListDeletedStandaloneFormsResponse {
+    /**
+     * The retrieved standalone forms
+     * @maxSize 100
+     */
+    standaloneForms?: StandaloneForm[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor pointing to next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface QueryStandaloneFormsRequest {
+    /** WQL expression. */
+    query: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** 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;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 3
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** 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 Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface QueryStandaloneFormsResponse {
+    /**
+     * The retrieved standalone forms
+     * @maxSize 100
+     */
+    standaloneForms?: StandaloneForm[];
+    /** Details on the paged set of results returned. */
+    metadata?: CursorPagingMetadata;
+}
+interface GetSitePropertiesRequest {
+}
+interface GetSitePropertiesResponse {
+    /** Standalone MetaSite properties */
+    siteProperties?: StandaloneMetaSiteProperties;
+}
+interface StandaloneMetaSiteProperties {
+    /** Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. */
+    paymentCurrency?: string | null;
+    /**
+     * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     *
+     * Empty if the site's locale isn't set.
+     * @maxLength 2
+     */
+    localeLanguageCode?: string;
+    /**
+     * Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
+     *
+     * Empty if the site's locale isn't set.
+     * @maxLength 2
+     */
+    localeCountry?: string;
+}
+/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
+interface SitePropertiesNotification {
+    /** The site ID for which this update notification applies. */
+    metasiteId?: string;
+    /** The actual update event. */
+    event?: SitePropertiesEvent;
+    /**
+     * A convenience set of mappings from the MetaSite ID to its constituent services.
+     * @maxSize 500
+     */
+    translations?: Translation[];
+    /** Context of the notification */
+    changeContext?: ChangeContext;
+}
+/** The actual update event for a particular notification. */
+interface SitePropertiesEvent {
+    /** Version of the site's properties represented by this update. */
+    version?: number;
+    /** Set of properties that were updated - corresponds to the fields in "properties". */
+    fields?: string[];
+    /** Updated properties. */
+    properties?: Properties;
+}
+interface Properties {
+    /** Site categories. */
+    categories?: Categories;
+    /** Site locale. */
+    locale?: Locale;
+    /**
+     * Site language.
+     *
+     * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     */
+    language?: string | null;
+    /**
+     * Site currency used to bill customers.
+     *
+     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    paymentCurrency?: string | null;
+    /** Site time zone in IANA time zone database format. For example, `America/New_York`. */
+    timeZone?: string | null;
+    /** Email address. */
+    email?: string | null;
+    /** Phone number. */
+    phone?: string | null;
+    /** Fax number. */
+    fax?: string | null;
+    /** Address. */
+    address?: Address;
+    /** Site display name. */
+    siteDisplayName?: string | null;
+    /** Business name. */
+    businessName?: string | null;
+    /** Path to the site's logo in Wix Media (without Wix Media base URL). */
+    logo?: string | null;
+    /** Site description. */
+    description?: string | null;
+    /**
+     * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
+     *
+     * __Note:__ Not supported by Wix Bookings.
+     */
+    businessSchedule?: BusinessSchedule;
+    /** Supported languages of a site and the primary language. */
+    multilingual?: Multilingual;
+    /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
+    consentPolicy?: ConsentPolicy;
+    /**
+     * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
+     *
+     * Site business type.
+     */
+    businessConfig?: string | null;
+    /** External site URL that uses Wix as its headless business solution. */
+    externalSiteUrl?: string | null;
+    /** Track clicks analytics. */
+    trackClicksAnalytics?: boolean;
+    /**
+     * Company ID issued to the business by local authorities. Appears on invoices and price quotes.
+     * @maxLength 50
+     */
+    companyId?: string | null;
+}
+interface Categories {
+    /** Primary site category. */
+    primary?: string;
+    /**
+     * Secondary site category.
+     * @maxSize 50
+     */
+    secondary?: string[];
+    /** Business Term Id */
+    businessTermId?: string | null;
+}
+interface Locale {
+    /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
+    languageCode?: string;
+    /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
+    country?: string;
+}
+interface Address {
+    /** Street name. */
+    street?: string;
+    /** City name. */
+    city?: string;
+    /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
+    country?: string;
+    /** State. */
+    state?: string;
+    /**
+     * Zip or postal code.
+     * @maxLength 20
+     */
+    zip?: string;
+    /** Extra information to be displayed in the address. */
+    hint?: AddressHint;
+    /** Whether this address represents a physical location. */
+    isPhysical?: boolean;
+    /** Google-formatted version of this address. */
+    googleFormattedAddress?: string;
+    /** Street number. */
+    streetNumber?: string;
+    /** Apartment number. */
+    apartmentNumber?: string;
+    /** Geographic coordinates of location. */
+    coordinates?: GeoCoordinates;
+}
+/**
+ * Extra information on displayed addresses.
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
+ */
+interface AddressHint {
+    /** Extra text displayed next to, or instead of, the actual address. */
+    text?: string;
+    /** Where the extra text should be displayed. */
+    placement?: PlacementTypeWithLiterals;
+}
+/** Where the extra text should be displayed: before, after or instead of the actual address. */
+declare enum PlacementType {
+    BEFORE = "BEFORE",
+    AFTER = "AFTER",
+    REPLACE = "REPLACE"
+}
+/** @enumType */
+type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
+/** Geocoordinates for a particular address. */
+interface GeoCoordinates {
+    /** Latitude of the location. Must be between -90 and 90. */
+    latitude?: number;
+    /** Longitude of the location. Must be between -180 and 180. */
+    longitude?: number;
+}
+/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
+interface BusinessSchedule {
+    /**
+     * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
+     * @maxSize 100
+     */
+    periods?: TimePeriod[];
+    /**
+     * Exceptions to the business's regular hours. The business can be open or closed during the exception.
+     * @maxSize 100
+     */
+    specialHourPeriod?: SpecialHourPeriod[];
+}
+/** Weekly recurring time periods when the business is regularly open or the service is available. */
+interface TimePeriod {
+    /** Day of the week the period starts on. */
+    openDay?: DayOfWeekWithLiterals;
+    /**
+     * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
+     * midnight at the end of the specified day.
+     */
+    openTime?: string;
+    /** Day of the week the period ends on. */
+    closeDay?: DayOfWeekWithLiterals;
+    /**
+     * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
+     * midnight at the end of the specified day.
+     *
+     * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
+     */
+    closeTime?: string;
+}
+/** Enumerates the days of the week. */
+declare enum DayOfWeek {
+    MONDAY = "MONDAY",
+    TUESDAY = "TUESDAY",
+    WEDNESDAY = "WEDNESDAY",
+    THURSDAY = "THURSDAY",
+    FRIDAY = "FRIDAY",
+    SATURDAY = "SATURDAY",
+    SUNDAY = "SUNDAY"
+}
+/** @enumType */
+type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+/** Exception to the business's regular hours. The business can be open or closed during the exception. */
+interface SpecialHourPeriod {
+    /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
+    startDate?: string;
+    /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
+    endDate?: string;
+    /**
+     * Whether the business is closed (or the service is not available) during the exception.
+     *
+     * Default: `true`.
+     */
+    isClosed?: boolean;
+    /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
+    comment?: string;
+}
+interface Multilingual {
+    /**
+     * Supported languages list.
+     * @maxSize 200
+     */
+    supportedLanguages?: SupportedLanguage[];
+    /** Whether to redirect to user language. */
+    autoRedirect?: boolean;
+}
+interface SupportedLanguage {
+    /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
+    languageCode?: string;
+    /** Locale. */
+    locale?: Locale;
+    /** Whether the supported language is the primary language for the site. */
+    isPrimary?: boolean;
+    /** Language icon. */
+    countryCode?: string;
+    /** How the language will be resolved. For internal use. */
+    resolutionMethod?: ResolutionMethodWithLiterals;
+    /** Whether the supported language is the primary language for site visitors. */
+    isVisitorPrimary?: boolean | null;
+}
+declare enum ResolutionMethod {
+    QUERY_PARAM = "QUERY_PARAM",
+    SUBDOMAIN = "SUBDOMAIN",
+    SUBDIRECTORY = "SUBDIRECTORY"
+}
+/** @enumType */
+type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
+interface ConsentPolicy {
+    /** Whether the site uses cookies that are essential to site operation. Always `true`. */
+    essential?: boolean | null;
+    /** Whether the site uses cookies that affect site performance and other functional measurements. */
+    functional?: boolean | null;
+    /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
+    analytics?: boolean | null;
+    /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
+    advertising?: boolean | null;
+    /** CCPA compliance flag. */
+    dataToThirdParty?: boolean | null;
+}
+/** A single mapping from the MetaSite ID to a particular service. */
+interface Translation {
+    /** The service type. */
+    serviceType?: string;
+    /** The application definition ID; this only applies to services of type ThirdPartyApps. */
+    appDefId?: string;
+    /** The instance ID of the service. */
+    instanceId?: string;
+}
+interface ChangeContext extends ChangeContextPayloadOneOf {
+    /** Properties were updated. */
+    propertiesChange?: PropertiesChange;
+    /** Default properties were created on site creation. */
+    siteCreated?: V4SiteCreated;
+    /** Properties were cloned on site cloning. */
+    siteCloned?: SiteCloned;
+}
+/** @oneof */
+interface ChangeContextPayloadOneOf {
+    /** Properties were updated. */
+    propertiesChange?: PropertiesChange;
+    /** Default properties were created on site creation. */
+    siteCreated?: V4SiteCreated;
+    /** Properties were cloned on site cloning. */
+    siteCloned?: SiteCloned;
+}
+interface PropertiesChange {
+}
+interface V4SiteCreated {
+    /** Origin template site id. */
+    originTemplateId?: string | null;
+}
+interface SiteCloned {
+    /** Origin site id. */
+    originMetaSiteId?: string;
+}
+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 {
+    entity?: string;
+}
+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.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+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.
+     * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
+     */
+    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",
+    /** Nautilus platform. */
+    NAUTILUS = "NAUTILUS",
+    /**
+     * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
+     * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
+     */
+    SYMPHONY = "SYMPHONY",
+    /** Nautilus platform app. */
+    NAUTILUS_APPS = "NAUTILUS_APPS",
+    /**
+     * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
+     * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
+     */
+    VIBU = "VIBU",
+    /**
+     * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
+     * (an Enterprise account may have several), holding that BrandKit's brand definition
+     * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
+     * MetaSites with this namespace will *not* be shown in a user's site list by default.
+     */
+    ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
+    /**
+     * Dev-center development sites (com.wixpress.devcenter.dsm).
+     * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
+     */
+    DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
+}
+/** @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' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
+/** 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 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;
+}
+/** @docsIgnore */
+type CreateStandaloneFormApplicationErrors = {
+    code?: 'FAILED_PRECONDITION';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetSitePropertiesApplicationErrors = {
+    code?: 'SITE_PROPERTIES_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Returns the standalone meta site owned by the caller's account, provisioning a new siteless
+ * meta site if one doesn't exist yet.
+ *
+ * Use this when the caller doesn't already have a meta site, for example when a form is built
+ * before the user becomes a Wix user. The returned meta site can then own standalone forms.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId MetaSite.Create
+ * @fqn wix.forms.v1.FormStandaloneService.GetOrCreateFormStandaloneMetaSite
+ */
+declare function getOrCreateFormStandaloneMetaSite(): Promise<NonNullablePaths<GetOrCreateFormStandaloneMetaSiteResponse, `metaSiteId`, 0>>;
+/**
+ * Marks an existing form as standalone by creating a standalone form record that binds the form
+ * to the meta site that owns it.
+ *
+ * The form referenced by `formId` must already exist. The owning meta site is taken from the
+ * calling context. A given form can be marked standalone by only one record per meta site.
+ * @param standaloneForm - Standalone form
+ * @public
+ * @documentationMaturity preview
+ * @requiredField standaloneForm
+ * @requiredField standaloneForm.formId
+ * @permissionId WIX_FORMS.STANDALONE_FORM_CREATE
+ * @applicableIdentity APP
+ * @returns Standalone form
+ * @fqn wix.forms.v1.FormStandaloneService.CreateStandaloneForm
+ */
+declare function createStandaloneForm(standaloneForm: NonNullablePaths<StandaloneForm, `formId`, 0>): Promise<StandaloneForm & {
+    __applicationErrorsType?: CreateStandaloneFormApplicationErrors;
+}>;
+/**
+ * Retrieves a standalone form by ID.
+ * @param standaloneFormId - Standalone form id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField standaloneFormId
+ * @permissionId WIX_FORMS.STANDALONE_FORM_READ
+ * @applicableIdentity APP
+ * @returns Standalone form
+ * @fqn wix.forms.v1.FormStandaloneService.GetStandaloneForm
+ */
+declare function getStandaloneForm(standaloneFormId: string): Promise<StandaloneForm>;
+/**
+ * Deletes a standalone form record
+ *
+ * By default the record is moved to the trash bin. Set `permanent` to `true` to delete it permanently.
+ * @param standaloneFormId - Standalone form id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField standaloneFormId
+ * @permissionId WIX_FORMS.STANDALONE_FORM_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.forms.v1.FormStandaloneService.DeleteStandaloneForm
+ */
+declare function deleteStandaloneForm(standaloneFormId: string, options?: DeleteStandaloneFormOptions): Promise<void>;
+interface DeleteStandaloneFormOptions {
+    /**
+     * Whether to permanently delete a standalone form bypassing the trash bin.
+     *
+     * Default: `false`
+     */
+    permanent?: boolean;
+}
+/**
+ * Permanently deletes a standalone form record that is in the trash bin.
+ * @param standaloneFormId - Standalone form id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField standaloneFormId
+ * @permissionId WIX_FORMS.STANDALONE_FORM_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.forms.v1.FormStandaloneService.RemoveStandaloneFormFromTrashBin
+ */
+declare function removeStandaloneFormFromTrashBin(standaloneFormId: string): Promise<void>;
+/**
+ * Restores a standalone form record from the trash bin.
+ * @param standaloneFormId - Standalone form id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField standaloneFormId
+ * @permissionId WIX_FORMS.STANDALONE_FORM_CREATE
+ * @applicableIdentity APP
+ * @fqn wix.forms.v1.FormStandaloneService.RestoreStandaloneFormFromTrashBin
+ */
+declare function restoreStandaloneFormFromTrashBin(standaloneFormId: string): Promise<RestoreStandaloneFormFromTrashBinResponse>;
+/**
+ * Retrieves a standalone form record from the trash bin by ID.
+ * @param standaloneFormId - Standalone form id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField standaloneFormId
+ * @permissionId WIX_FORMS.STANDALONE_FORM_READ
+ * @applicableIdentity APP
+ * @fqn wix.forms.v1.FormStandaloneService.GetDeletedStandaloneForm
+ */
+declare function getDeletedStandaloneForm(standaloneFormId: string): Promise<GetDeletedStandaloneFormResponse>;
+/**
+ * Retrieves a list of standalone form records that are in the trash bin.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId WIX_FORMS.STANDALONE_FORM_READ
+ * @applicableIdentity APP
+ * @fqn wix.forms.v1.FormStandaloneService.ListDeletedStandaloneForms
+ */
+declare function listDeletedStandaloneForms(options?: ListDeletedStandaloneFormsOptions): Promise<NonNullablePaths<ListDeletedStandaloneFormsResponse, `standaloneForms`, 0>>;
+interface ListDeletedStandaloneFormsOptions {
+    /**
+     * Standalone Form ids.
+     * @maxSize 100
+     * @maxLength 36
+     */
+    standaloneFormIds?: string[];
+    /** Cursor token pointing to a page of results. Not used in the first request. */
+    paging?: CursorPaging;
+}
+/**
+ * Retrieves a list of standalone forms, given the provided filtering, sorting, and paging.
+ *
+ * Supported filterable and sortable fields: `id`, `formId`, `metaSiteId`, `createdDate`, `updatedDate`.
+ * @param query - WQL expression.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField query
+ * @permissionId WIX_FORMS.STANDALONE_FORM_READ
+ * @applicableIdentity APP
+ * @fqn wix.forms.v1.FormStandaloneService.QueryStandaloneForms
+ */
+declare function queryStandaloneForms(query: CursorQuery): Promise<NonNullablePaths<QueryStandaloneFormsResponse, `standaloneForms`, 0>>;
+/**
+ * Gets site properties (currency and locale) for the caller's standalone meta site.
+ *
+ * Results may be cached and are not guaranteed to reflect real-time changes.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId WIX_FORMS.STANDALONE_FORM_READ
+ * @applicableIdentity APP
+ * @fqn wix.forms.v1.FormStandaloneService.GetSiteProperties
+ */
+declare function getSiteProperties(): Promise<NonNullablePaths<GetSitePropertiesResponse, `siteProperties.localeLanguageCode` | `siteProperties.localeCountry`, 1> & {
+    __applicationErrorsType?: GetSitePropertiesApplicationErrors;
+}>;
+
+export { type AccountInfo, type ActionEvent, type Address, type AddressHint, type Asset, type BusinessSchedule, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, type ConsentPolicy, type CreateStandaloneFormApplicationErrors, type CreateStandaloneFormRequest, type CreateStandaloneFormResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, DayOfWeek, type DayOfWeekWithLiterals, type DeleteContext, type DeleteStandaloneFormOptions, type DeleteStandaloneFormRequest, type DeleteStandaloneFormResponse, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type EditorlessAssigned, type EditorlessUnassigned, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GeoCoordinates, type GetDeletedStandaloneFormRequest, type GetDeletedStandaloneFormResponse, type GetOrCreateFormStandaloneMetaSiteRequest, type GetOrCreateFormStandaloneMetaSiteResponse, type GetSitePropertiesApplicationErrors, type GetSitePropertiesRequest, type GetSitePropertiesResponse, type GetStandaloneFormRequest, type GetStandaloneFormResponse, type IdentificationData, type IdentificationDataIdOneOf, type ListDeletedStandaloneFormsOptions, type ListDeletedStandaloneFormsRequest, type ListDeletedStandaloneFormsResponse, type Locale, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type Multilingual, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PicassoAssigned, type PicassoUnassigned, PlacementType, type PlacementTypeWithLiterals, type Properties, type PropertiesChange, type QueryStandaloneFormsRequest, type QueryStandaloneFormsResponse, type RemoveStandaloneFormFromTrashBinRequest, type RemoveStandaloneFormFromTrashBinResponse, ResolutionMethod, type ResolutionMethodWithLiterals, type RestoreInfo, type RestoreStandaloneFormFromTrashBinRequest, type RestoreStandaloneFormFromTrashBinResponse, type ServiceProvisioned, type ServiceRemoved, type SiteCloned, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePropertiesEvent, type SitePropertiesNotification, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, type SpecialHourPeriod, type StandaloneForm, type StandaloneMetaSiteProperties, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SupportedLanguage, type TimePeriod, type Translation, type UserDomainMediaDisabled, type UserDomainMediaEnabled, type V4SiteCreated, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, createStandaloneForm, deleteStandaloneForm, getDeletedStandaloneForm, getOrCreateFormStandaloneMetaSite, getSiteProperties, getStandaloneForm, listDeletedStandaloneForms, queryStandaloneForms, removeStandaloneFormFromTrashBin, restoreStandaloneFormFromTrashBin };