@wix/autocms-folders-service 1.0.0

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

@@ -0,0 +1,908 @@
+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;
+
+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;
+	}
+}
+
+/**
+ * Folder is a container for other folders and collection references
+ * There's always 1 root folder with empty ID
+ */
+interface Folder {
+    /**
+     * unique ID, not present for root folder, mandatory for nested folders
+     * @readonly
+     */
+    _id?: string | null;
+    /** display name */
+    displayName?: string;
+    /** folder description if any */
+    description?: string | null;
+    /** additional information */
+    info?: Record<string, any> | null;
+    /** collections in current folder */
+    collections?: CollectionReference[];
+    /** nested folders */
+    folders?: Folder[];
+}
+/**
+ * Reference to a collection, contained in a folder
+ * Collection may have up to 1 reference per folder
+ * and exactly 1 non-shortcut reference overall
+ */
+interface CollectionReference {
+    /** collection unique name (ID) */
+    collectionName?: string;
+    /**
+     * same collection may have many shortcut references across folders
+     * but only one non-shortcut reference
+     * by default any collection will have reference at root folder
+     */
+    shortcut?: boolean;
+    /** additional information */
+    info?: Record<string, any> | null;
+}
+interface GetFolderRequest {
+    /** missing means root */
+    folderId?: string | null;
+    /**
+     * nesting depth to return
+     * - 0 means no nested elements, only folder details
+     * - none means full folder tree
+     */
+    depth?: number | null;
+    /**
+     * if true CollectionReference.schema are not returned,
+     * but call is much faster.
+     * ignored for root folder request
+     * @deprecated
+     * @targetRemovalDate 2025-01-01
+     */
+    skipSchemas?: boolean;
+}
+interface GetFolderResponse {
+    /** requested folder details */
+    folder?: Folder;
+    /** depth value requested */
+    depth?: number | null;
+}
+interface CreateFolderRequest {
+    /** parent folder ID or none if root */
+    parentFolderId?: string | null;
+    /** folder info to create */
+    folderInfo?: FolderInfo;
+}
+interface FolderInfo {
+    /** display name */
+    displayName?: string | null;
+    /** description */
+    description?: string | null;
+    /** additional info */
+    info?: Record<string, any> | null;
+}
+interface CreateFolderResponse {
+    /** parent of created folder or none for root */
+    parentFolderId?: string | null;
+    /** created folder */
+    folder?: Folder;
+}
+interface UpdateFolderRequest {
+    /** Folder ID */
+    folderId: string;
+    /** Fields to update, partial */
+    folderInfo?: FolderInfo;
+}
+interface UpdateFolderResponse {
+    /**
+     * updated folder
+     * folder contents (folders and collections) would not be returned
+     */
+    folder?: Folder;
+}
+interface DeleteFolderRequest {
+    /** folder ID to delete */
+    folderId: string;
+}
+interface DeleteFolderResponse {
+}
+interface MoveFolderRequest {
+    /** folder ID to move */
+    folderId: string;
+    /** destination folder ID (new parent), none if root */
+    parentFolderId?: string | null;
+}
+interface MoveFolderResponse {
+}
+interface ReferenceCollectionRequest {
+    /** collection name to reference (ID) */
+    collectionName: string;
+    /** target folder ID or none if root */
+    folderId?: string | null;
+    /**
+     * if false then single non-shortcut reference to this
+     * collection is moved to target folder
+     * otherwise new shortcut reference is created
+     */
+    shortcut?: boolean;
+    /**
+     * additional information for shortcut reference
+     * ignored for non-shortcut reference
+     */
+    info?: Record<string, any> | null;
+}
+interface ReferenceCollectionResponse {
+    /** Folder ID that contains reference or none if root */
+    folderId?: string | null;
+    /** reference details */
+    collectionReference?: CollectionReference;
+}
+interface GetReferencesRequest {
+    /** collection name (ID) to get */
+    collectionName: string;
+    /**
+     * if true schema would not be loaded and reference may not be found if collection is in root folder
+     * loading schema has performance impact
+     * @deprecated
+     * @targetRemovalDate 2025-01-01
+     */
+    skipSchemas?: boolean;
+}
+interface GetReferencesResponse {
+    /** list of references */
+    references?: ReferenceLocation[];
+}
+interface ReferenceLocation {
+    /** folder where reference is located */
+    folderId?: string | null;
+    /** reference details */
+    reference?: CollectionReference;
+}
+interface UpdateReferenceInfoRequest {
+    /** folder where reference is located, none for root */
+    folderId?: string | null;
+    /** referenced collection name (ID) */
+    collectionName: string;
+    /** additional information to set */
+    info?: Record<string, any> | null;
+}
+interface UpdateReferenceInfoResponse {
+    /** Folder ID that contains reference or none if root */
+    folderId?: string | null;
+    /** reference details */
+    collectionReference?: CollectionReference;
+}
+interface DeleteReferenceRequest {
+    /** collection name (ID) to delete */
+    collectionName: string;
+    /** folder ID where to delete reference or none if root */
+    folderId?: string | null;
+}
+interface DeleteReferenceResponse {
+}
+interface SearchRequest {
+    /** Search string, matched ignoring case */
+    searchTerm?: string;
+}
+interface SearchResponse {
+    /** folders found, no contents are returned */
+    folders?: Folder[];
+    /**
+     * collections found
+     * @deprecated
+     * @replacedBy references
+     * @targetRemovalDate 2025-01-01
+     */
+    collections?: CollectionReference[];
+    /** collection references found */
+    references?: ReferenceLocation[];
+}
+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 CollectionReferenceNonNullableFields {
+    collectionName: string;
+    shortcut: boolean;
+}
+interface FolderNonNullableFields {
+    displayName: string;
+    collections: CollectionReferenceNonNullableFields[];
+    folders: FolderNonNullableFields[];
+}
+interface GetFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+interface CreateFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+interface UpdateFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+interface ReferenceCollectionResponseNonNullableFields {
+    collectionReference?: CollectionReferenceNonNullableFields;
+}
+interface ReferenceLocationNonNullableFields {
+    reference?: CollectionReferenceNonNullableFields;
+}
+interface GetReferencesResponseNonNullableFields {
+    references: ReferenceLocationNonNullableFields[];
+}
+interface UpdateReferenceInfoResponseNonNullableFields {
+    collectionReference?: CollectionReferenceNonNullableFields;
+}
+interface SearchResponseNonNullableFields {
+    folders: FolderNonNullableFields[];
+    collections: CollectionReferenceNonNullableFields[];
+    references: ReferenceLocationNonNullableFields[];
+}
+interface GetFolderOptions {
+    /** missing means root */
+    folderId?: string | null;
+    /**
+     * nesting depth to return
+     * - 0 means no nested elements, only folder details
+     * - none means full folder tree
+     */
+    depth?: number | null;
+    /**
+     * if true CollectionReference.schema are not returned,
+     * but call is much faster.
+     * ignored for root folder request
+     * @deprecated
+     * @targetRemovalDate 2025-01-01
+     */
+    skipSchemas?: boolean;
+}
+interface CreateFolderOptions {
+    /** parent folder ID or none if root */
+    parentFolderId?: string | null;
+    /** folder info to create */
+    folderInfo?: FolderInfo;
+}
+interface UpdateFolderOptions {
+    /** Fields to update, partial */
+    folderInfo?: FolderInfo;
+}
+interface MoveFolderOptions {
+    /** destination folder ID (new parent), none if root */
+    parentFolderId?: string | null;
+}
+interface ReferenceCollectionOptions {
+    /** target folder ID or none if root */
+    folderId?: string | null;
+    /**
+     * if false then single non-shortcut reference to this
+     * collection is moved to target folder
+     * otherwise new shortcut reference is created
+     */
+    shortcut?: boolean;
+    /**
+     * additional information for shortcut reference
+     * ignored for non-shortcut reference
+     */
+    info?: Record<string, any> | null;
+}
+interface GetReferencesOptions {
+    /**
+     * if true schema would not be loaded and reference may not be found if collection is in root folder
+     * loading schema has performance impact
+     * @deprecated
+     * @targetRemovalDate 2025-01-01
+     */
+    skipSchemas?: boolean;
+}
+interface UpdateReferenceInfoOptions {
+    /** folder where reference is located, none for root */
+    folderId?: string | null;
+    /** referenced collection name (ID) */
+    collectionName: string;
+    /** additional information to set */
+    info?: Record<string, any> | null;
+}
+interface DeleteReferenceOptions {
+    /** folder ID where to delete reference or none if root */
+    folderId?: string | null;
+}
+interface SearchOptions {
+    /** Search string, matched ignoring case */
+    searchTerm?: string;
+}
+
+declare function getFolder$1(httpClient: HttpClient): GetFolderSignature;
+interface GetFolderSignature {
+    /**
+     * Get folder by ID
+     * @returns requested folder details
+     */
+    (options?: GetFolderOptions | undefined): Promise<Folder & FolderNonNullableFields>;
+}
+declare function createFolder$1(httpClient: HttpClient): CreateFolderSignature;
+interface CreateFolderSignature {
+    /**
+     * Create new folder
+     */
+    (options?: CreateFolderOptions | undefined): Promise<CreateFolderResponse & CreateFolderResponseNonNullableFields>;
+}
+declare function updateFolder$1(httpClient: HttpClient): UpdateFolderSignature;
+interface UpdateFolderSignature {
+    /**
+     * Update nested folder details.
+     * Root folder can't be updated.
+     * @param - Folder ID
+     */
+    (folderId: string, options?: UpdateFolderOptions | undefined): Promise<UpdateFolderResponse & UpdateFolderResponseNonNullableFields>;
+}
+declare function deleteFolder$1(httpClient: HttpClient): DeleteFolderSignature;
+interface DeleteFolderSignature {
+    /**
+     * Delete nested folder.
+     * - any nested folder would be deleted recursively
+     * - any shortcut collection references will be deleted
+     * - any non-shortcut collection references will be moved to root folder
+     * Root folder can't be deleted.
+     * @param - folder ID to delete
+     */
+    (folderId: string): Promise<void>;
+}
+declare function moveFolder$1(httpClient: HttpClient): MoveFolderSignature;
+interface MoveFolderSignature {
+    /**
+     * Move nested folder to different parent with all it's contents
+     * @param - folder ID to move
+     */
+    (folderId: string, options?: MoveFolderOptions | undefined): Promise<void>;
+}
+declare function referenceCollection$1(httpClient: HttpClient): ReferenceCollectionSignature;
+interface ReferenceCollectionSignature {
+    /**
+     * Create collection reference.
+     * If reference is non-shortcut it is moved from previous location.
+     * @param - collection name to reference (ID)
+     */
+    (collectionName: string, options?: ReferenceCollectionOptions | undefined): Promise<ReferenceCollectionResponse & ReferenceCollectionResponseNonNullableFields>;
+}
+declare function getReferences$1(httpClient: HttpClient): GetReferencesSignature;
+interface GetReferencesSignature {
+    /**
+     * Return all references to given collection.
+     * @param - collection name (ID) to get
+     */
+    (collectionName: string, options?: GetReferencesOptions | undefined): Promise<GetReferencesResponse & GetReferencesResponseNonNullableFields>;
+}
+declare function updateReferenceInfo$1(httpClient: HttpClient): UpdateReferenceInfoSignature;
+interface UpdateReferenceInfoSignature {
+    /**
+     * Update reference info.
+     */
+    (options?: UpdateReferenceInfoOptions | undefined): Promise<UpdateReferenceInfoResponse & UpdateReferenceInfoResponseNonNullableFields>;
+}
+declare function deleteReference$1(httpClient: HttpClient): DeleteReferenceSignature;
+interface DeleteReferenceSignature {
+    /**
+     * Delete shortcut reference.
+     * @param - collection name (ID) to delete
+     */
+    (collectionName: string, options?: DeleteReferenceOptions | undefined): Promise<void>;
+}
+declare function search$1(httpClient: HttpClient): SearchSignature;
+interface SearchSignature {
+    /**
+     * Search folders and collections by name.
+     */
+    (options?: SearchOptions | undefined): Promise<SearchResponse & SearchResponseNonNullableFields>;
+}
+
+declare const getFolder: BuildRESTFunction<typeof getFolder$1> & typeof getFolder$1;
+declare const createFolder: BuildRESTFunction<typeof createFolder$1> & typeof createFolder$1;
+declare const updateFolder: BuildRESTFunction<typeof updateFolder$1> & typeof updateFolder$1;
+declare const deleteFolder: BuildRESTFunction<typeof deleteFolder$1> & typeof deleteFolder$1;
+declare const moveFolder: BuildRESTFunction<typeof moveFolder$1> & typeof moveFolder$1;
+declare const referenceCollection: BuildRESTFunction<typeof referenceCollection$1> & typeof referenceCollection$1;
+declare const getReferences: BuildRESTFunction<typeof getReferences$1> & typeof getReferences$1;
+declare const updateReferenceInfo: BuildRESTFunction<typeof updateReferenceInfo$1> & typeof updateReferenceInfo$1;
+declare const deleteReference: BuildRESTFunction<typeof deleteReference$1> & typeof deleteReference$1;
+declare const search: BuildRESTFunction<typeof search$1> & typeof search$1;
+
+type index_d_ActionEvent = ActionEvent;
+type index_d_Asset = Asset;
+type index_d_CollectionReference = CollectionReference;
+type index_d_CreateFolderOptions = CreateFolderOptions;
+type index_d_CreateFolderRequest = CreateFolderRequest;
+type index_d_CreateFolderResponse = CreateFolderResponse;
+type index_d_CreateFolderResponseNonNullableFields = CreateFolderResponseNonNullableFields;
+type index_d_DeleteContext = DeleteContext;
+type index_d_DeleteFolderRequest = DeleteFolderRequest;
+type index_d_DeleteFolderResponse = DeleteFolderResponse;
+type index_d_DeleteReferenceOptions = DeleteReferenceOptions;
+type index_d_DeleteReferenceRequest = DeleteReferenceRequest;
+type index_d_DeleteReferenceResponse = DeleteReferenceResponse;
+type index_d_DeleteStatus = DeleteStatus;
+declare const index_d_DeleteStatus: typeof DeleteStatus;
+type index_d_DomainEvent = DomainEvent;
+type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type index_d_Empty = Empty;
+type index_d_EntityCreatedEvent = EntityCreatedEvent;
+type index_d_EntityDeletedEvent = EntityDeletedEvent;
+type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
+type index_d_Folder = Folder;
+type index_d_FolderInfo = FolderInfo;
+type index_d_FolderNonNullableFields = FolderNonNullableFields;
+type index_d_GetFolderOptions = GetFolderOptions;
+type index_d_GetFolderRequest = GetFolderRequest;
+type index_d_GetFolderResponse = GetFolderResponse;
+type index_d_GetFolderResponseNonNullableFields = GetFolderResponseNonNullableFields;
+type index_d_GetReferencesOptions = GetReferencesOptions;
+type index_d_GetReferencesRequest = GetReferencesRequest;
+type index_d_GetReferencesResponse = GetReferencesResponse;
+type index_d_GetReferencesResponseNonNullableFields = GetReferencesResponseNonNullableFields;
+type index_d_IdentificationData = IdentificationData;
+type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type index_d_MessageEnvelope = MessageEnvelope;
+type index_d_MetaSiteSpecialEvent = MetaSiteSpecialEvent;
+type index_d_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;
+type index_d_MoveFolderOptions = MoveFolderOptions;
+type index_d_MoveFolderRequest = MoveFolderRequest;
+type index_d_MoveFolderResponse = MoveFolderResponse;
+type index_d_Namespace = Namespace;
+declare const index_d_Namespace: typeof Namespace;
+type index_d_NamespaceChanged = NamespaceChanged;
+type index_d_ReferenceCollectionOptions = ReferenceCollectionOptions;
+type index_d_ReferenceCollectionRequest = ReferenceCollectionRequest;
+type index_d_ReferenceCollectionResponse = ReferenceCollectionResponse;
+type index_d_ReferenceCollectionResponseNonNullableFields = ReferenceCollectionResponseNonNullableFields;
+type index_d_ReferenceLocation = ReferenceLocation;
+type index_d_RestoreInfo = RestoreInfo;
+type index_d_SearchOptions = SearchOptions;
+type index_d_SearchRequest = SearchRequest;
+type index_d_SearchResponse = SearchResponse;
+type index_d_SearchResponseNonNullableFields = SearchResponseNonNullableFields;
+type index_d_ServiceProvisioned = ServiceProvisioned;
+type index_d_ServiceRemoved = ServiceRemoved;
+type index_d_SiteCreated = SiteCreated;
+type index_d_SiteCreatedContext = SiteCreatedContext;
+declare const index_d_SiteCreatedContext: typeof SiteCreatedContext;
+type index_d_SiteDeleted = SiteDeleted;
+type index_d_SiteHardDeleted = SiteHardDeleted;
+type index_d_SiteMarkedAsTemplate = SiteMarkedAsTemplate;
+type index_d_SiteMarkedAsWixSite = SiteMarkedAsWixSite;
+type index_d_SitePublished = SitePublished;
+type index_d_SiteRenamed = SiteRenamed;
+type index_d_SiteTransferred = SiteTransferred;
+type index_d_SiteUndeleted = SiteUndeleted;
+type index_d_SiteUnpublished = SiteUnpublished;
+type index_d_State = State;
+declare const index_d_State: typeof State;
+type index_d_StudioAssigned = StudioAssigned;
+type index_d_StudioUnassigned = StudioUnassigned;
+type index_d_UpdateFolderOptions = UpdateFolderOptions;
+type index_d_UpdateFolderRequest = UpdateFolderRequest;
+type index_d_UpdateFolderResponse = UpdateFolderResponse;
+type index_d_UpdateFolderResponseNonNullableFields = UpdateFolderResponseNonNullableFields;
+type index_d_UpdateReferenceInfoOptions = UpdateReferenceInfoOptions;
+type index_d_UpdateReferenceInfoRequest = UpdateReferenceInfoRequest;
+type index_d_UpdateReferenceInfoResponse = UpdateReferenceInfoResponse;
+type index_d_UpdateReferenceInfoResponseNonNullableFields = UpdateReferenceInfoResponseNonNullableFields;
+type index_d_WebhookIdentityType = WebhookIdentityType;
+declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
+declare const index_d_createFolder: typeof createFolder;
+declare const index_d_deleteFolder: typeof deleteFolder;
+declare const index_d_deleteReference: typeof deleteReference;
+declare const index_d_getFolder: typeof getFolder;
+declare const index_d_getReferences: typeof getReferences;
+declare const index_d_moveFolder: typeof moveFolder;
+declare const index_d_referenceCollection: typeof referenceCollection;
+declare const index_d_search: typeof search;
+declare const index_d_updateFolder: typeof updateFolder;
+declare const index_d_updateReferenceInfo: typeof updateReferenceInfo;
+declare namespace index_d {
+  export { type index_d_ActionEvent as ActionEvent, type index_d_Asset as Asset, type index_d_CollectionReference as CollectionReference, type index_d_CreateFolderOptions as CreateFolderOptions, type index_d_CreateFolderRequest as CreateFolderRequest, type index_d_CreateFolderResponse as CreateFolderResponse, type index_d_CreateFolderResponseNonNullableFields as CreateFolderResponseNonNullableFields, type index_d_DeleteContext as DeleteContext, type index_d_DeleteFolderRequest as DeleteFolderRequest, type index_d_DeleteFolderResponse as DeleteFolderResponse, type index_d_DeleteReferenceOptions as DeleteReferenceOptions, type index_d_DeleteReferenceRequest as DeleteReferenceRequest, type index_d_DeleteReferenceResponse as DeleteReferenceResponse, index_d_DeleteStatus as DeleteStatus, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_Folder as Folder, type index_d_FolderInfo as FolderInfo, type index_d_FolderNonNullableFields as FolderNonNullableFields, type index_d_GetFolderOptions as GetFolderOptions, type index_d_GetFolderRequest as GetFolderRequest, type index_d_GetFolderResponse as GetFolderResponse, type index_d_GetFolderResponseNonNullableFields as GetFolderResponseNonNullableFields, type index_d_GetReferencesOptions as GetReferencesOptions, type index_d_GetReferencesRequest as GetReferencesRequest, type index_d_GetReferencesResponse as GetReferencesResponse, type index_d_GetReferencesResponseNonNullableFields as GetReferencesResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_MessageEnvelope as MessageEnvelope, type index_d_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type index_d_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, type index_d_MoveFolderOptions as MoveFolderOptions, type index_d_MoveFolderRequest as MoveFolderRequest, type index_d_MoveFolderResponse as MoveFolderResponse, index_d_Namespace as Namespace, type index_d_NamespaceChanged as NamespaceChanged, type index_d_ReferenceCollectionOptions as ReferenceCollectionOptions, type index_d_ReferenceCollectionRequest as ReferenceCollectionRequest, type index_d_ReferenceCollectionResponse as ReferenceCollectionResponse, type index_d_ReferenceCollectionResponseNonNullableFields as ReferenceCollectionResponseNonNullableFields, type index_d_ReferenceLocation as ReferenceLocation, type index_d_RestoreInfo as RestoreInfo, type index_d_SearchOptions as SearchOptions, type index_d_SearchRequest as SearchRequest, type index_d_SearchResponse as SearchResponse, type index_d_SearchResponseNonNullableFields as SearchResponseNonNullableFields, type index_d_ServiceProvisioned as ServiceProvisioned, type index_d_ServiceRemoved as ServiceRemoved, type index_d_SiteCreated as SiteCreated, index_d_SiteCreatedContext as SiteCreatedContext, type index_d_SiteDeleted as SiteDeleted, type index_d_SiteHardDeleted as SiteHardDeleted, type index_d_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type index_d_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type index_d_SitePublished as SitePublished, type index_d_SiteRenamed as SiteRenamed, type index_d_SiteTransferred as SiteTransferred, type index_d_SiteUndeleted as SiteUndeleted, type index_d_SiteUnpublished as SiteUnpublished, index_d_State as State, type index_d_StudioAssigned as StudioAssigned, type index_d_StudioUnassigned as StudioUnassigned, type index_d_UpdateFolderOptions as UpdateFolderOptions, type index_d_UpdateFolderRequest as UpdateFolderRequest, type index_d_UpdateFolderResponse as UpdateFolderResponse, type index_d_UpdateFolderResponseNonNullableFields as UpdateFolderResponseNonNullableFields, type index_d_UpdateReferenceInfoOptions as UpdateReferenceInfoOptions, type index_d_UpdateReferenceInfoRequest as UpdateReferenceInfoRequest, type index_d_UpdateReferenceInfoResponse as UpdateReferenceInfoResponse, type index_d_UpdateReferenceInfoResponseNonNullableFields as UpdateReferenceInfoResponseNonNullableFields, index_d_WebhookIdentityType as WebhookIdentityType, index_d_createFolder as createFolder, index_d_deleteFolder as deleteFolder, index_d_deleteReference as deleteReference, index_d_getFolder as getFolder, index_d_getReferences as getReferences, index_d_moveFolder as moveFolder, index_d_referenceCollection as referenceCollection, index_d_search as search, index_d_updateFolder as updateFolder, index_d_updateReferenceInfo as updateReferenceInfo };
+}
+
+export { index_d as autocms };