@wix/auto_sdk_editor-branches_branches 1.0.10 → 1.0.12

package/build/internal/es/src/editor-branches-v1-branch-branches.universal.d.ts

@@ -1,1151 +0,0 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-/**
- * A branch is a version of draft site content that can be edited independently. Also known as a test site.
- * Read more about branches in this [article](https://support.wix.com/en/article/about-test-sites).
- */
-export interface Branch extends BranchSourceOneOf {
-    /** Source branch properties. */
-    sourceBranchProperties?: SourceBranch;
-    /** Source template properties. */
-    sourceTemplateProperties?: SourceTemplate;
-    /**
-     * Branch ID.
-     * @format GUID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Revision number, which increments by 1 each time the branch is updated.
-     * To prevent conflicting changes,
-     * the current revision must be passed when updating the branch.
-     * @readonly
-     */
-    revision?: string | null;
-    /** Branch type. */
-    type?: Type;
-    /**
-     * Branch name.
-     * @maxLength 50
-     */
-    name?: string | null;
-    /** Source type. */
-    sourceType?: SourceType;
-    /**
-     * Date and time the branch was last published, if relevant.
-     * @readonly
-     */
-    lastPublishDate?: string | null;
-    /**
-     * Editor type.
-     * @readonly
-     */
-    editorType?: EditorType;
-    /**
-     * Date and time the branch was created.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /**
-     * Date and time the branch was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-    /**
-     * Custom field data for the branch.
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
-     */
-    extendedFields?: ExtendedFields;
-}
-/** @oneof */
-export interface BranchSourceOneOf {
-    /** Source branch properties. */
-    sourceBranchProperties?: SourceBranch;
-    /** Source template properties. */
-    sourceTemplateProperties?: SourceTemplate;
-}
-export declare enum Type {
-    /** Unknown branch type. */
-    UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    /** A branch created by a Wix user, that can be accessed for editing and publishing via the editor UI. */
-    USER = "USER",
-    /** A branch created for technical purposes, unrelated to the Wix user. For internal use, can't be accessed via the editor UI. */
-    TECHNICAL = "TECHNICAL",
-    /** The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor. */
-    ORIGINAL_BRANCH = "ORIGINAL_BRANCH"
-}
-export declare enum SourceType {
-    /** Unknown source type. */
-    UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
-    /** This branch's source was a branch. */
-    SOURCE_BRANCH = "SOURCE_BRANCH",
-    /** This branch's source was a template. For internal use. */
-    SOURCE_TEMPLATE = "SOURCE_TEMPLATE"
-}
-export interface EditorType {
-    /** Editor type */
-    editorTypeOptions?: EditorTypeOptions;
-}
-export declare enum EditorTypeOptions {
-    /** Unknown editor type */
-    UNKNOWN_EDITOR_TYPE = "UNKNOWN_EDITOR_TYPE",
-    /** STUDIO */
-    STUDIO = "STUDIO",
-    /** CLASSIC */
-    CLASSIC = "CLASSIC"
-}
-export interface SourceBranch {
-    /**
-     * Source branch ID.
-     * @format GUID
-     */
-    branchId?: string;
-    /** Source branch revision. */
-    branchRevision?: string | null;
-}
-export interface SourceTemplate {
-    /**
-     * Source template ID.
-     * @format GUID
-     */
-    templateId?: string;
-}
-export interface ExtendedFields {
-    /**
-     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
-     * The value of each key is structured according to the schema defined when the extended fields were configured.
-     *
-     * You can only access fields for which you have the appropriate permissions.
-     *
-     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
-     */
-    namespaces?: Record<string, Record<string, any>>;
-}
-export interface CreateBranchRequest {
-    /** Branch to be created. */
-    branch: Branch;
-}
-export interface CreateBranchResponse {
-    /** Created branch. */
-    branch?: Branch;
-}
-export interface GetBranchRequest {
-    /**
-     * ID of branch to retrieve.
-     * @format GUID
-     */
-    branchId: string;
-}
-export interface GetBranchResponse {
-    /** Requested branch. */
-    branch?: Branch;
-}
-export interface UpdateBranchRequest {
-    /** Branch to be updated. */
-    branch: Branch;
-}
-export interface UpdateBranchResponse {
-    /** Updated branch. */
-    branch?: Branch;
-}
-export interface DeleteBranchRequest {
-    /**
-     * ID of branch to delete.
-     * @format GUID
-     */
-    branchId: string;
-}
-export interface DeleteBranchResponse {
-}
-export interface QueryBranchesRequest {
-    /** WQL expression. */
-    query?: CursorQuery;
-}
-export 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"}}`.
-     *
-     * Filterable fields:
-     *
-     * `type`
-     * `name`
-     * `updatedDate`
-     * `createdDate`
-     * `lastPublishDate`
-     * `sourceBranchProperties.branchId`
-     * `sourceBranchProperties.branchRevision`
-     *
-     * All operators are valid.
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`.
-     *
-     * Sortable fields:
-     *
-     * `updatedDate`
-     * `createdDate`
-     * `lastPublishDate`
-     * @maxSize 5
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-export 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;
-}
-export interface Sorting {
-    /**
-     * Name of the field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export 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;
-}
-export interface QueryBranchesResponse {
-    /** List of branches. */
-    branches?: Branch[];
-    /** Paging metadata */
-    pagingMetadata?: CursorPagingMetadata;
-}
-export interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Cursor strings that point to the next page, previous page, or both. */
-    cursors?: Cursors;
-    /**
-     * Whether there are more pages to retrieve following the current page.
-     *
-     * + `true`: Another page of results can be retrieved.
-     * + `false`: This is the last page.
-     */
-    hasNext?: boolean | null;
-}
-export 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;
-}
-export interface UpdateExtendedFieldsRequest {
-    /** ID of the entity to update. */
-    _id?: string;
-    /** Identifier for the app whose extended fields are being updated. */
-    namespace?: string;
-    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
-    namespaceData?: Record<string, any> | null;
-}
-export interface UpdateExtendedFieldsResponse {
-    /** Updated branch. */
-    branch?: Branch;
-}
-export interface HtmlSitePublished {
-    /**
-     * Application instance ID
-     * @maxLength 50
-     */
-    appInstanceId?: string;
-    /**
-     * Application type
-     * @maxLength 100
-     */
-    appType?: string;
-    /** Revision */
-    revision?: string;
-    /**
-     * MSID
-     * @maxLength 100
-     */
-    metaSiteId?: string | null;
-    /**
-     * optional branch id if publish is done from branch
-     * @format GUID
-     */
-    branchId?: string | null;
-    /** The site's last transactionId */
-    lastTransactionId?: string | null;
-    /** A list of the site's pages */
-    pages?: Page[];
-    /** Site's publish date */
-    publishDate?: string;
-}
-export interface Page {
-    /**
-     * Page's Id
-     * @maxLength 100
-     */
-    _id?: string;
-}
-export interface Empty {
-}
-export 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;
-    /**
-     * 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 */
-export 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;
-}
-export 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?: State;
-}
-export declare enum State {
-    UNKNOWN = "UNKNOWN",
-    ENABLED = "ENABLED",
-    DISABLED = "DISABLED",
-    PENDING = "PENDING",
-    DEMO = "DEMO"
-}
-export 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?: SiteCreatedContext;
-    /**
-     * 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?: Namespace;
-}
-export 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"
-}
-export 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"
-}
-/** Site transferred to another user. */
-export 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. */
-export interface SiteDeleted {
-    /** A deletion context. */
-    deleteContext?: DeleteContext;
-}
-export interface DeleteContext {
-    /** When the meta site was deleted. */
-    dateDeleted?: Date | null;
-    /** A status. */
-    deleteStatus?: DeleteStatus;
-    /**
-     * A reason (flow).
-     * @maxLength 255
-     */
-    deleteOrigin?: string;
-    /**
-     * A service that deleted it.
-     * @maxLength 255
-     */
-    initiatorId?: string | null;
-}
-export declare enum DeleteStatus {
-    UNKNOWN = "UNKNOWN",
-    TRASH = "TRASH",
-    DELETED = "DELETED",
-    PENDING_PURGE = "PENDING_PURGE",
-    PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
-}
-/** Restoration of the meta site. */
-export interface SiteUndeleted {
-}
-/** First publish of a meta site. Or subsequent publish after unpublish. */
-export interface SitePublished {
-}
-export interface SiteUnpublished {
-    /**
-     * A list of URLs previously associated with the meta site.
-     * @maxLength 4000
-     * @maxSize 10000
-     */
-    urls?: string[];
-}
-export interface SiteMarkedAsTemplate {
-}
-export 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.
- */
-export 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;
-}
-export 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. */
-export 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.
- */
-export interface SiteHardDeleted {
-    /** A deletion context. */
-    deleteContext?: DeleteContext;
-}
-export interface NamespaceChanged {
-    /** A previous namespace. */
-    oldNamespace?: Namespace;
-    /** A new namespace. */
-    newNamespace?: Namespace;
-}
-/** Assigned Studio editor */
-export interface StudioAssigned {
-}
-/** Unassigned Studio editor */
-export 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
- */
-export 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.
- */
-export interface SitePurgedExternally {
-    /**
-     * @maxLength 2048
-     * @maxSize 100
-     * @deprecated
-     * @targetRemovalDate 2025-04-15
-     */
-    appDefId?: string[];
-}
-/** Assigned Odeditor */
-export interface OdeditorAssigned {
-}
-/** Unassigned Odeditor */
-export interface OdeditorUnassigned {
-}
-/** Assigned Picasso editor */
-export interface PicassoAssigned {
-}
-/** Unassigned Picasso */
-export interface PicassoUnassigned {
-}
-export 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 */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entity?: string;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntity?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntity?: string | null;
-}
-export interface ActionEvent {
-    body?: string;
-}
-export 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;
-}
-export 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?: WebhookIdentityType;
-}
-/** @oneof */
-export 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;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-export interface BaseEventMetadata {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-export interface EventMetadata extends BaseEventMetadata {
-    /** 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;
-}
-export interface BranchCreatedEnvelope {
-    entity: Branch;
-    metadata: EventMetadata;
-}
-/** @permissionId EDITOR.BRANCH_READ
- * @webhook
- * @eventType wix.editor.branches.v1.branch_created
- * @slug created
- */
-export declare function onBranchCreated(handler: (event: BranchCreatedEnvelope) => void | Promise<void>): void;
-export interface BranchDeletedEnvelope {
-    entity: Branch;
-    metadata: EventMetadata;
-}
-/** @permissionId EDITOR.BRANCH_READ
- * @webhook
- * @eventType wix.editor.branches.v1.branch_deleted
- * @slug deleted
- */
-export declare function onBranchDeleted(handler: (event: BranchDeletedEnvelope) => void | Promise<void>): void;
-export interface BranchUpdatedEnvelope {
-    entity: Branch;
-    metadata: EventMetadata;
-}
-/** @permissionId EDITOR.BRANCH_READ
- * @webhook
- * @eventType wix.editor.branches.v1.branch_updated
- * @slug updated
- */
-export declare function onBranchUpdated(handler: (event: BranchUpdatedEnvelope) => void | Promise<void>): void;
-type BranchNonNullablePaths = `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`;
-/**
- * Creates a branch.
- * If a source branch is not provided, the branch will include a blank website.
- * @param branch - Branch to be created.
- * @public
- * @documentationMaturity preview
- * @requiredField branch
- * @permissionId EDITOR.BRANCH_CREATE
- * @returns Created branch.
- * @fqn wix.editor.branches.v1.BranchesService.CreateBranch
- */
-export declare function createBranch(branch: Branch): Promise<NonNullablePaths<Branch, BranchNonNullablePaths>>;
-/**
- * Retrieves a branch.
- * @param branchId - ID of branch to retrieve.
- * @public
- * @documentationMaturity preview
- * @requiredField branchId
- * @permissionId EDITOR.BRANCH_READ
- * @returns Requested branch.
- * @fqn wix.editor.branches.v1.BranchesService.GetBranch
- */
-export declare function getBranch(branchId: string): Promise<NonNullablePaths<Branch, BranchNonNullablePaths>>;
-/**
- * Updates a branch.
- *
- * `ORIGINAL_BRANCH` types can't be updated.
- * @param _id - Branch ID.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField branch
- * @requiredField branch.revision
- * @permissionId EDITOR.BRANCH_UPDATE
- * @returns Updated branch.
- * @fqn wix.editor.branches.v1.BranchesService.UpdateBranch
- */
-export declare function updateBranch(_id: string, branch: NonNullablePaths<UpdateBranch, `revision`>): Promise<NonNullablePaths<Branch, BranchNonNullablePaths>>;
-export interface UpdateBranch {
-    /** Source branch properties. */
-    sourceBranchProperties?: SourceBranch;
-    /** Source template properties. */
-    sourceTemplateProperties?: SourceTemplate;
-    /**
-     * Branch ID.
-     * @format GUID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Revision number, which increments by 1 each time the branch is updated.
-     * To prevent conflicting changes,
-     * the current revision must be passed when updating the branch.
-     * @readonly
-     */
-    revision?: string | null;
-    /** Branch type. */
-    type?: Type;
-    /**
-     * Branch name.
-     * @maxLength 50
-     */
-    name?: string | null;
-    /** Source type. */
-    sourceType?: SourceType;
-    /**
-     * Date and time the branch was last published, if relevant.
-     * @readonly
-     */
-    lastPublishDate?: string | null;
-    /**
-     * Editor type.
-     * @readonly
-     */
-    editorType?: EditorType;
-    /**
-     * Date and time the branch was created.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /**
-     * Date and time the branch was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-    /**
-     * Custom field data for the branch.
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
-     */
-    extendedFields?: ExtendedFields;
-}
-/**
- * Permanently deletes a branch.
- * @param branchId - ID of branch to delete.
- * @public
- * @documentationMaturity preview
- * @requiredField branchId
- * @permissionId EDITOR.BRANCH_DELETE
- * @fqn wix.editor.branches.v1.BranchesService.DeleteBranch
- */
-export declare function deleteBranch(branchId: string): Promise<void>;
-/**
- * Retrieves a list of branches, given the specified [paging, filtering, and sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
- * @public
- * @documentationMaturity preview
- * @permissionId EDITOR.BRANCH_READ
- * @fqn wix.editor.branches.v1.BranchesService.QueryBranches
- */
-export declare function queryBranches(): BranchesQueryBuilder;
-interface QueryCursorResult {
-    cursors: Cursors;
-    hasNext: () => boolean;
-    hasPrev: () => boolean;
-    length: number;
-    pageSize: number;
-}
-export interface BranchesQueryResult extends QueryCursorResult {
-    items: Branch[];
-    query: BranchesQueryBuilder;
-    next: () => Promise<BranchesQueryResult>;
-    prev: () => Promise<BranchesQueryResult>;
-}
-export interface BranchesQueryBuilder {
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    eq: (propertyName: 'sourceBranchProperties.branchId' | 'sourceBranchProperties.branchRevision' | 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ne: (propertyName: 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ge: (propertyName: 'lastPublishDate' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    gt: (propertyName: 'lastPublishDate' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    le: (propertyName: 'lastPublishDate' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    lt: (propertyName: 'lastPublishDate' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `string`.
-     * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
-     */
-    startsWith: (propertyName: 'name', value: string) => BranchesQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `values`.
-     * @param values - List of values to compare against.
-     * @documentationMaturity preview
-     */
-    hasSome: (propertyName: 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: any[]) => BranchesQueryBuilder;
-    /** @documentationMaturity preview */
-    in: (propertyName: 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
-    /** @documentationMaturity preview */
-    exists: (propertyName: 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: boolean) => BranchesQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    ascending: (...propertyNames: Array<'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate'>) => BranchesQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
-    descending: (...propertyNames: Array<'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate'>) => BranchesQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
-    limit: (limit: number) => BranchesQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
-    skipTo: (cursor: string) => BranchesQueryBuilder;
-    /** @documentationMaturity preview */
-    find: () => Promise<BranchesQueryResult>;
-}
-export {};