@wix/autocms-collection-metadata-service 1.0.0

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

@@ -0,0 +1,709 @@
+/** CollectionMetadata contains CM-specific metadata for a collection */
+interface CollectionMetadata {
+    /** ID of data collection */
+    dataCollectionId?: string;
+    /** active named view */
+    activeNamedViewId?: string | null;
+    /** if table view should be hidden */
+    hideTableView?: boolean | null;
+    /** named views */
+    namedViews?: Record<string, any>[] | null;
+    /** named view ID used for default site sort in datasets */
+    namedViewIdForSiteSort?: string | null;
+    /** Type of data permissions template used initially */
+    permissionsTemplate?: PermissionsTemplateType;
+}
+declare enum PermissionsTemplateType {
+    UNDEFINED = "UNDEFINED",
+    SHOW_CONTENT = "SHOW_CONTENT",
+    COLLECT_CONTENT = "COLLECT_CONTENT",
+    CUSTOM = "CUSTOM"
+}
+interface CreateCollectionMetadataRequest {
+    /** CollectionMetadata to be created */
+    collectionMetadata: CollectionMetadata;
+}
+interface CreateCollectionMetadataResponse {
+    /** The created CollectionMetadata */
+    collectionMetadata?: CollectionMetadata;
+}
+interface GetCollectionMetadataRequest {
+    /** Id of collection to retrieve metadata for */
+    dataCollectionId?: string;
+}
+interface GetCollectionMetadataResponse {
+    /** The retrieved CollectionMetadata */
+    collectionMetadata?: CollectionMetadata;
+}
+interface UpdateCollectionMetadataRequest {
+    /**
+     * ID of metadata to update, ignored if collection_metadata.data_collection_id is non-empty
+     * exists because of docs generation issue with nested fields and ** path variables
+     */
+    dataCollectionId?: string;
+    /** CollectionMetadata to be updated, may be partial */
+    collectionMetadata: CollectionMetadata;
+}
+interface UpdateCollectionMetadataResponse {
+    /** The updated CollectionMetadata */
+    collectionMetadata?: CollectionMetadata;
+}
+interface ReplaceCollectionMetadataRequest {
+    /** The updated CollectionMetadatas */
+    items?: CollectionMetadata[];
+}
+interface ReplaceCollectionMetadataResponse {
+}
+interface DeleteCollectionMetadataRequest {
+    /** Id of collection to delete metadata for */
+    dataCollectionId?: string;
+}
+interface DeleteCollectionMetadataResponse {
+}
+interface ListCollectionMetadataRequest {
+    /** paging info */
+    paging?: CursorPaging;
+}
+interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    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.
+     */
+    cursor?: string | null;
+}
+interface ListCollectionMetadataResponse {
+    /** The retrieved CollectionMetadatas */
+    items?: CollectionMetadata[];
+    /** paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+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;
+}
+interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date;
+}
+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 Empty {
+}
+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;
+    /** A meta site id. */
+    metaSiteId?: string;
+    /** A meta site version. Monotonically increasing. */
+    version?: string;
+    /** A timestamp of the event. */
+    timestamp?: string;
+    /** A list of "assets" (applications). The same as MetaSiteContext. */
+    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;
+}
+interface Asset {
+    /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
+    appDefId?: string;
+    /** An instance id. For legacy reasons may be UUID or a string. */
+    instanceId?: string;
+    /** An application state. */
+    state?: State;
+}
+declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+interface SiteCreated {
+    /** A template identifier (empty if not created from a template). */
+    originTemplateId?: string;
+    /** An account id of the owner. */
+    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.
+     */
+    originMetaSiteId?: string | null;
+    /** A meta site name (URL slug). */
+    siteName?: string;
+    /** A namespace. */
+    namespace?: Namespace;
+}
+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"
+}
+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"
+}
+/** Site transferred to another user. */
+interface SiteTransferred {
+    /** A previous owner id (user that transfers meta site). */
+    oldOwnerId?: string;
+    /** A new owner id (user that accepts meta site). */
+    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;
+    /** A status. */
+    deleteStatus?: DeleteStatus;
+    /** A reason (flow). */
+    deleteOrigin?: string;
+    /** A service that deleted it. */
+    initiatorId?: string | null;
+}
+declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE"
+}
+/** 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. */
+    urls?: string[];
+}
+interface SiteMarkedAsTemplate {
+}
+interface SiteMarkedAsWixSite {
+}
+interface ServiceProvisioned {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** An instance id from which this instance is originated. */
+    originInstanceId?: string;
+    /** A version. */
+    version?: string | null;
+}
+interface ServiceRemoved {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** A version. */
+    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). */
+    newSiteName?: string;
+    /** A previous meta site name (URL slug). */
+    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?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+interface StudioUnassigned {
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface CollectionMetadataNonNullableFields {
+    dataCollectionId: string;
+    permissionsTemplate: PermissionsTemplateType;
+}
+interface CreateCollectionMetadataResponseNonNullableFields {
+    collectionMetadata?: CollectionMetadataNonNullableFields;
+}
+interface GetCollectionMetadataResponseNonNullableFields {
+    collectionMetadata?: CollectionMetadataNonNullableFields;
+}
+interface UpdateCollectionMetadataResponseNonNullableFields {
+    collectionMetadata?: CollectionMetadataNonNullableFields;
+}
+interface ListCollectionMetadataResponseNonNullableFields {
+    items: CollectionMetadataNonNullableFields[];
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface CollectionMetadataCreatedEnvelope {
+    entity: CollectionMetadata;
+    metadata: EventMetadata;
+}
+interface CollectionMetadataUpdatedEnvelope {
+    entity: CollectionMetadata;
+    metadata: EventMetadata;
+}
+interface CollectionMetadataDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface ReplaceCollectionMetadataOptions {
+    /** The updated CollectionMetadatas */
+    items?: CollectionMetadata[];
+}
+interface ListCollectionMetadataOptions {
+    /** paging info */
+    paging?: CursorPaging;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
+
+declare const createCollectionMetadata: ReturnType<typeof createRESTModule<typeof publicCreateCollectionMetadata>>;
+declare const getCollectionMetadata: ReturnType<typeof createRESTModule<typeof publicGetCollectionMetadata>>;
+declare const updateCollectionMetadata: ReturnType<typeof createRESTModule<typeof publicUpdateCollectionMetadata>>;
+declare const replaceCollectionMetadata: ReturnType<typeof createRESTModule<typeof publicReplaceCollectionMetadata>>;
+declare const deleteCollectionMetadata: ReturnType<typeof createRESTModule<typeof publicDeleteCollectionMetadata>>;
+declare const listCollectionMetadata: ReturnType<typeof createRESTModule<typeof publicListCollectionMetadata>>;
+declare const onCollectionMetadataCreated: ReturnType<typeof createEventModule<typeof publicOnCollectionMetadataCreated>>;
+declare const onCollectionMetadataUpdated: ReturnType<typeof createEventModule<typeof publicOnCollectionMetadataUpdated>>;
+declare const onCollectionMetadataDeleted: ReturnType<typeof createEventModule<typeof publicOnCollectionMetadataDeleted>>;
+
+type context_ActionEvent = ActionEvent;
+type context_Asset = Asset;
+type context_BaseEventMetadata = BaseEventMetadata;
+type context_CollectionMetadata = CollectionMetadata;
+type context_CollectionMetadataCreatedEnvelope = CollectionMetadataCreatedEnvelope;
+type context_CollectionMetadataDeletedEnvelope = CollectionMetadataDeletedEnvelope;
+type context_CollectionMetadataNonNullableFields = CollectionMetadataNonNullableFields;
+type context_CollectionMetadataUpdatedEnvelope = CollectionMetadataUpdatedEnvelope;
+type context_CreateCollectionMetadataRequest = CreateCollectionMetadataRequest;
+type context_CreateCollectionMetadataResponse = CreateCollectionMetadataResponse;
+type context_CreateCollectionMetadataResponseNonNullableFields = CreateCollectionMetadataResponseNonNullableFields;
+type context_CursorPaging = CursorPaging;
+type context_CursorPagingMetadata = CursorPagingMetadata;
+type context_Cursors = Cursors;
+type context_DeleteCollectionMetadataRequest = DeleteCollectionMetadataRequest;
+type context_DeleteCollectionMetadataResponse = DeleteCollectionMetadataResponse;
+type context_DeleteContext = DeleteContext;
+type context_DeleteStatus = DeleteStatus;
+declare const context_DeleteStatus: typeof DeleteStatus;
+type context_DomainEvent = DomainEvent;
+type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type context_Empty = Empty;
+type context_EntityCreatedEvent = EntityCreatedEvent;
+type context_EntityDeletedEvent = EntityDeletedEvent;
+type context_EntityUpdatedEvent = EntityUpdatedEvent;
+type context_EventMetadata = EventMetadata;
+type context_GetCollectionMetadataRequest = GetCollectionMetadataRequest;
+type context_GetCollectionMetadataResponse = GetCollectionMetadataResponse;
+type context_GetCollectionMetadataResponseNonNullableFields = GetCollectionMetadataResponseNonNullableFields;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_ListCollectionMetadataOptions = ListCollectionMetadataOptions;
+type context_ListCollectionMetadataRequest = ListCollectionMetadataRequest;
+type context_ListCollectionMetadataResponse = ListCollectionMetadataResponse;
+type context_ListCollectionMetadataResponseNonNullableFields = ListCollectionMetadataResponseNonNullableFields;
+type context_MessageEnvelope = MessageEnvelope;
+type context_MetaSiteSpecialEvent = MetaSiteSpecialEvent;
+type context_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;
+type context_Namespace = Namespace;
+declare const context_Namespace: typeof Namespace;
+type context_NamespaceChanged = NamespaceChanged;
+type context_PermissionsTemplateType = PermissionsTemplateType;
+declare const context_PermissionsTemplateType: typeof PermissionsTemplateType;
+type context_ReplaceCollectionMetadataOptions = ReplaceCollectionMetadataOptions;
+type context_ReplaceCollectionMetadataRequest = ReplaceCollectionMetadataRequest;
+type context_ReplaceCollectionMetadataResponse = ReplaceCollectionMetadataResponse;
+type context_RestoreInfo = RestoreInfo;
+type context_ServiceProvisioned = ServiceProvisioned;
+type context_ServiceRemoved = ServiceRemoved;
+type context_SiteCreated = SiteCreated;
+type context_SiteCreatedContext = SiteCreatedContext;
+declare const context_SiteCreatedContext: typeof SiteCreatedContext;
+type context_SiteDeleted = SiteDeleted;
+type context_SiteHardDeleted = SiteHardDeleted;
+type context_SiteMarkedAsTemplate = SiteMarkedAsTemplate;
+type context_SiteMarkedAsWixSite = SiteMarkedAsWixSite;
+type context_SitePublished = SitePublished;
+type context_SiteRenamed = SiteRenamed;
+type context_SiteTransferred = SiteTransferred;
+type context_SiteUndeleted = SiteUndeleted;
+type context_SiteUnpublished = SiteUnpublished;
+type context_State = State;
+declare const context_State: typeof State;
+type context_StudioAssigned = StudioAssigned;
+type context_StudioUnassigned = StudioUnassigned;
+type context_UpdateCollectionMetadataRequest = UpdateCollectionMetadataRequest;
+type context_UpdateCollectionMetadataResponse = UpdateCollectionMetadataResponse;
+type context_UpdateCollectionMetadataResponseNonNullableFields = UpdateCollectionMetadataResponseNonNullableFields;
+type context_WebhookIdentityType = WebhookIdentityType;
+declare const context_WebhookIdentityType: typeof WebhookIdentityType;
+declare const context_createCollectionMetadata: typeof createCollectionMetadata;
+declare const context_deleteCollectionMetadata: typeof deleteCollectionMetadata;
+declare const context_getCollectionMetadata: typeof getCollectionMetadata;
+declare const context_listCollectionMetadata: typeof listCollectionMetadata;
+declare const context_onCollectionMetadataCreated: typeof onCollectionMetadataCreated;
+declare const context_onCollectionMetadataDeleted: typeof onCollectionMetadataDeleted;
+declare const context_onCollectionMetadataUpdated: typeof onCollectionMetadataUpdated;
+declare const context_replaceCollectionMetadata: typeof replaceCollectionMetadata;
+declare const context_updateCollectionMetadata: typeof updateCollectionMetadata;
+declare namespace context {
+  export { type context_ActionEvent as ActionEvent, type context_Asset as Asset, type context_BaseEventMetadata as BaseEventMetadata, type context_CollectionMetadata as CollectionMetadata, type context_CollectionMetadataCreatedEnvelope as CollectionMetadataCreatedEnvelope, type context_CollectionMetadataDeletedEnvelope as CollectionMetadataDeletedEnvelope, type context_CollectionMetadataNonNullableFields as CollectionMetadataNonNullableFields, type context_CollectionMetadataUpdatedEnvelope as CollectionMetadataUpdatedEnvelope, type context_CreateCollectionMetadataRequest as CreateCollectionMetadataRequest, type context_CreateCollectionMetadataResponse as CreateCollectionMetadataResponse, type context_CreateCollectionMetadataResponseNonNullableFields as CreateCollectionMetadataResponseNonNullableFields, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_Cursors as Cursors, type context_DeleteCollectionMetadataRequest as DeleteCollectionMetadataRequest, type context_DeleteCollectionMetadataResponse as DeleteCollectionMetadataResponse, type context_DeleteContext as DeleteContext, context_DeleteStatus as DeleteStatus, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_GetCollectionMetadataRequest as GetCollectionMetadataRequest, type context_GetCollectionMetadataResponse as GetCollectionMetadataResponse, type context_GetCollectionMetadataResponseNonNullableFields as GetCollectionMetadataResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_ListCollectionMetadataOptions as ListCollectionMetadataOptions, type context_ListCollectionMetadataRequest as ListCollectionMetadataRequest, type context_ListCollectionMetadataResponse as ListCollectionMetadataResponse, type context_ListCollectionMetadataResponseNonNullableFields as ListCollectionMetadataResponseNonNullableFields, type context_MessageEnvelope as MessageEnvelope, type context_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type context_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, context_Namespace as Namespace, type context_NamespaceChanged as NamespaceChanged, context_PermissionsTemplateType as PermissionsTemplateType, type context_ReplaceCollectionMetadataOptions as ReplaceCollectionMetadataOptions, type context_ReplaceCollectionMetadataRequest as ReplaceCollectionMetadataRequest, type context_ReplaceCollectionMetadataResponse as ReplaceCollectionMetadataResponse, type context_RestoreInfo as RestoreInfo, type context_ServiceProvisioned as ServiceProvisioned, type context_ServiceRemoved as ServiceRemoved, type context_SiteCreated as SiteCreated, context_SiteCreatedContext as SiteCreatedContext, type context_SiteDeleted as SiteDeleted, type context_SiteHardDeleted as SiteHardDeleted, type context_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type context_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type context_SitePublished as SitePublished, type context_SiteRenamed as SiteRenamed, type context_SiteTransferred as SiteTransferred, type context_SiteUndeleted as SiteUndeleted, type context_SiteUnpublished as SiteUnpublished, context_State as State, type context_StudioAssigned as StudioAssigned, type context_StudioUnassigned as StudioUnassigned, type context_UpdateCollectionMetadataRequest as UpdateCollectionMetadataRequest, type context_UpdateCollectionMetadataResponse as UpdateCollectionMetadataResponse, type context_UpdateCollectionMetadataResponseNonNullableFields as UpdateCollectionMetadataResponseNonNullableFields, context_WebhookIdentityType as WebhookIdentityType, context_createCollectionMetadata as createCollectionMetadata, context_deleteCollectionMetadata as deleteCollectionMetadata, context_getCollectionMetadata as getCollectionMetadata, context_listCollectionMetadata as listCollectionMetadata, context_onCollectionMetadataCreated as onCollectionMetadataCreated, context_onCollectionMetadataDeleted as onCollectionMetadataDeleted, context_onCollectionMetadataUpdated as onCollectionMetadataUpdated, context_replaceCollectionMetadata as replaceCollectionMetadata, context_updateCollectionMetadata as updateCollectionMetadata };
+}
+
+export { context as autocms };