@wix/categories 1.0.0

package/build/cjs/src/categories-v1-category.universal.d.ts

@@ -0,0 +1,2429 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Category {
+    /** Category ID. */
+    _id?: string | null;
+    /**
+     * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Represents the time this Category was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this Category was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Category name. */
+    name?: string | null;
+    /**
+     * Category image.
+     * Pass existing media ID for image previously saved in Wix media manager.
+     * Pass full image URL to upload an image to Wix media manager.
+     * In case of full url the image will be updated eventually.
+     */
+    image?: string;
+    /**
+     * Number of items in this category alone.
+     * @readonly
+     */
+    numberOfItems?: number;
+    /** Category description. */
+    description?: string | null;
+    /**
+     * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).
+     * Even if visible is `false`, it can still be added manually to static page.
+     * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.
+     * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.
+     */
+    visible?: boolean | null;
+    /**
+     * A category's breadcrumbs, Updated on moved to different parent or on renamed.
+     * This field will only be returned if request.fields contains `BREADCRUMBS`
+     * @readonly
+     */
+    breadcrumbs?: BreadcrumbItemValues;
+    /** The parent category. */
+    parentCategory?: ParentCategory;
+    /**
+     * A permanent, friendly URL name.
+     * If not provided, on create generated automatically.
+     * When provided, validated and must be unique.
+     */
+    slug?: string | null;
+    /**
+     * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.
+     * In order to use this field you have to integrate with "Ricos" on frontend side. To learn how to do it visit https://ricos.js.org/.
+     */
+    richContentDescription?: RichContent;
+    /**
+     * Optional - the ID of the app responsible for managing the items within this category.
+     * If provided, the update of items assigned to this category and the deletion of it will be allowed only to the managing app.
+     * The default is Empty.
+     */
+    managedByAppId?: string | null;
+    /** Extensions enabling users to save custom data related to the category. */
+    extendedFields?: ExtendedFields;
+}
+/** Wrapper for optional BreadcrumbItem values */
+export interface BreadcrumbItemValues {
+    /**
+     * The wrapped BreadcrumbItem values
+     * @readonly
+     */
+    values?: BreadcrumbItem[];
+}
+export interface BreadcrumbItem {
+    /** Represents the id of the category. */
+    categoryId?: string;
+    /** Represents the name of the category. Translatable */
+    categoryName?: string;
+    /** Represents the slug. A permanent, friendly URL name of the category. */
+    categorySlug?: string;
+}
+export interface ParentCategory {
+    /**
+     * Represents the id of the parent category.
+     * If not passed, the default is the root category.
+     */
+    _id?: string | null;
+    /**
+     * Represents the index of current category within the parent category.
+     * @readonly
+     */
+    index?: number | null;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tag information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Keyword {
+    /** Keyword value. */
+    term?: string;
+    /** Whether the keyword is the main focus keyword. */
+    isMain?: boolean;
+}
+export interface Tag {
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     */
+    type?: string;
+    /**
+     * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
+     * For example: `{'name': 'description', 'content': 'the description itself'}`.
+     */
+    props?: Record<string, any> | null;
+    /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
+    meta?: Record<string, any> | null;
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /**
+     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
+     *
+     *
+     * Default: `false` (Auto Redirect is enabled.)
+     */
+    preventAutoRedirect?: boolean;
+    /** User-selected keyword terms for a specific page. */
+    keywords?: Keyword[];
+}
+export interface RichContent {
+    /** Node objects representing a rich content document. */
+    nodes?: Node[];
+    /** Object metadata. */
+    metadata?: Metadata;
+    /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
+    documentStyle?: DocumentStyle;
+}
+export interface Node extends NodeDataOneOf {
+    /** Data for a button node. */
+    buttonData?: ButtonData;
+    /** Data for a code block node. */
+    codeBlockData?: CodeBlockData;
+    /** Data for a divider node. */
+    dividerData?: DividerData;
+    /** Data for a file node. */
+    fileData?: FileData;
+    /** Data for a gallery node. */
+    galleryData?: GalleryData;
+    /** Data for a GIF node. */
+    gifData?: GIFData;
+    /** Data for a heading node. */
+    headingData?: HeadingData;
+    /** Data for an embedded HTML node. */
+    htmlData?: HTMLData;
+    /** Data for an image node. */
+    imageData?: ImageData;
+    /** Data for a link preview node. */
+    linkPreviewData?: LinkPreviewData;
+    /** Data for a map node. */
+    mapData?: MapData;
+    /** Data for a paragraph node. */
+    paragraphData?: ParagraphData;
+    /** Data for a poll node. */
+    pollData?: PollData;
+    /** Data for a text node. Used to apply decorations to text. */
+    textData?: TextData;
+    /** Data for an app embed node. */
+    appEmbedData?: AppEmbedData;
+    /** Data for a video node. */
+    videoData?: VideoData;
+    /** Data for an oEmbed node. */
+    embedData?: EmbedData;
+    /** Data for a collapsible list node. */
+    collapsibleListData?: CollapsibleListData;
+    /** Data for a table node. */
+    tableData?: TableData;
+    /** Data for a table cell node. */
+    tableCellData?: TableCellData;
+    /** Data for a custon external node. */
+    externalData?: Record<string, any> | null;
+    /** Data for an audio node. */
+    audioData?: AudioData;
+    /** Data for an ordered list node. */
+    orderedListData?: OrderedListData;
+    /** Data for a bulleted list node. */
+    bulletedListData?: BulletedListData;
+    /** Data for a block quote node. */
+    blockquoteData?: BlockquoteData;
+    /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
+    type?: NodeType;
+    /** Node ID. */
+    _id?: string;
+    /** A list of child nodes. */
+    nodes?: Node[];
+    /** Padding and background color styling for the node. */
+    style?: NodeStyle;
+}
+/** @oneof */
+export interface NodeDataOneOf {
+    /** Data for a button node. */
+    buttonData?: ButtonData;
+    /** Data for a code block node. */
+    codeBlockData?: CodeBlockData;
+    /** Data for a divider node. */
+    dividerData?: DividerData;
+    /** Data for a file node. */
+    fileData?: FileData;
+    /** Data for a gallery node. */
+    galleryData?: GalleryData;
+    /** Data for a GIF node. */
+    gifData?: GIFData;
+    /** Data for a heading node. */
+    headingData?: HeadingData;
+    /** Data for an embedded HTML node. */
+    htmlData?: HTMLData;
+    /** Data for an image node. */
+    imageData?: ImageData;
+    /** Data for a link preview node. */
+    linkPreviewData?: LinkPreviewData;
+    /** Data for a map node. */
+    mapData?: MapData;
+    /** Data for a paragraph node. */
+    paragraphData?: ParagraphData;
+    /** Data for a poll node. */
+    pollData?: PollData;
+    /** Data for a text node. Used to apply decorations to text. */
+    textData?: TextData;
+    /** Data for an app embed node. */
+    appEmbedData?: AppEmbedData;
+    /** Data for a video node. */
+    videoData?: VideoData;
+    /** Data for an oEmbed node. */
+    embedData?: EmbedData;
+    /** Data for a collapsible list node. */
+    collapsibleListData?: CollapsibleListData;
+    /** Data for a table node. */
+    tableData?: TableData;
+    /** Data for a table cell node. */
+    tableCellData?: TableCellData;
+    /** Data for a custon external node. */
+    externalData?: Record<string, any> | null;
+    /** Data for an audio node. */
+    audioData?: AudioData;
+    /** Data for an ordered list node. */
+    orderedListData?: OrderedListData;
+    /** Data for a bulleted list node. */
+    bulletedListData?: BulletedListData;
+    /** Data for a block quote node. */
+    blockquoteData?: BlockquoteData;
+}
+export declare enum NodeType {
+    PARAGRAPH = "PARAGRAPH",
+    TEXT = "TEXT",
+    HEADING = "HEADING",
+    BULLETED_LIST = "BULLETED_LIST",
+    ORDERED_LIST = "ORDERED_LIST",
+    LIST_ITEM = "LIST_ITEM",
+    BLOCKQUOTE = "BLOCKQUOTE",
+    CODE_BLOCK = "CODE_BLOCK",
+    VIDEO = "VIDEO",
+    DIVIDER = "DIVIDER",
+    FILE = "FILE",
+    GALLERY = "GALLERY",
+    GIF = "GIF",
+    HTML = "HTML",
+    IMAGE = "IMAGE",
+    LINK_PREVIEW = "LINK_PREVIEW",
+    MAP = "MAP",
+    POLL = "POLL",
+    APP_EMBED = "APP_EMBED",
+    BUTTON = "BUTTON",
+    COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
+    TABLE = "TABLE",
+    EMBED = "EMBED",
+    COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
+    COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
+    COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
+    TABLE_CELL = "TABLE_CELL",
+    TABLE_ROW = "TABLE_ROW",
+    EXTERNAL = "EXTERNAL",
+    AUDIO = "AUDIO"
+}
+export interface NodeStyle {
+    /** The top padding value in pixels. */
+    paddingTop?: string | null;
+    /** The bottom padding value in pixels. */
+    paddingBottom?: string | null;
+    /** The background color as a hexadecimal value. */
+    backgroundColor?: string | null;
+}
+export interface ButtonData {
+    /** Styling for the button's container. */
+    containerData?: PluginContainerData;
+    /** The button type. */
+    type?: Type;
+    /** Styling for the button. */
+    styles?: Styles;
+    /** The text to display on the button. */
+    text?: string | null;
+    /** Button link details. */
+    link?: Link;
+}
+export interface Border {
+    /** Border width in pixels. */
+    width?: number | null;
+    /** Border radius in pixels. */
+    radius?: number | null;
+}
+export interface Colors {
+    /** The text color as a hexadecimal value. */
+    text?: string | null;
+    /** The border color as a hexadecimal value. */
+    border?: string | null;
+    /** The background color as a hexadecimal value. */
+    background?: string | null;
+}
+export interface PluginContainerData {
+    /** The width of the node when it's displayed. */
+    width?: PluginContainerDataWidth;
+    /** The node's alignment within its container. */
+    alignment?: PluginContainerDataAlignment;
+    /** Spoiler cover settings for the node. */
+    spoiler?: Spoiler;
+    /** The height of the node when it's displayed. */
+    height?: Height;
+    /** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. */
+    textWrap?: boolean | null;
+}
+export declare enum WidthType {
+    /** Width matches the content width */
+    CONTENT = "CONTENT",
+    /** Small Width */
+    SMALL = "SMALL",
+    /** Width will match the original asset width */
+    ORIGINAL = "ORIGINAL",
+    /** coast-to-coast display */
+    FULL_WIDTH = "FULL_WIDTH"
+}
+export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
+    /**
+     * One of the following predefined width options:
+     * `CONTENT`: The width of the container matches the content width.
+     * `SMALL`: Small width.
+     * `ORIGINAL`: The width of the container matches the original asset width.
+     * `FULL_WIDTH`: Full width.
+     */
+    size?: WidthType;
+    /** A custom width value in pixels. */
+    custom?: string | null;
+}
+/** @oneof */
+export interface PluginContainerDataWidthDataOneOf {
+    /**
+     * One of the following predefined width options:
+     * `CONTENT`: The width of the container matches the content width.
+     * `SMALL`: Small width.
+     * `ORIGINAL`: The width of the container matches the original asset width.
+     * `FULL_WIDTH`: Full width.
+     */
+    size?: WidthType;
+    /** A custom width value in pixels. */
+    custom?: string | null;
+}
+export declare enum PluginContainerDataAlignment {
+    /** Center Alignment */
+    CENTER = "CENTER",
+    /** Left Alignment */
+    LEFT = "LEFT",
+    /** Right Alignment */
+    RIGHT = "RIGHT"
+}
+export interface Spoiler {
+    /** Sets whether the spoiler cover is enabled for this node. */
+    enabled?: boolean | null;
+    /** The description displayed on top of the spoiler cover. */
+    description?: string | null;
+    /** The text for the button used to remove the spoiler cover. */
+    buttonText?: string | null;
+}
+export interface Height {
+    /** A custom height value in pixels. */
+    custom?: string | null;
+}
+export declare enum Type {
+    /** Regular link button */
+    LINK = "LINK",
+    /** Triggers custom action that is defined in plugin configuration by the consumer */
+    ACTION = "ACTION"
+}
+export interface Styles {
+    /** Border attributes. */
+    border?: Border;
+    /** Color attributes. */
+    colors?: Colors;
+}
+export interface Link extends LinkDataOneOf {
+    /** The absolute URL for the linked document. */
+    url?: string;
+    /** The target node's ID. Used for linking to another node in this object. */
+    anchor?: string;
+    /**
+     * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
+     * `SELF` - Default. Opens the linked document in the same frame as the link.
+     * `BLANK` - Opens the linked document in a new browser tab or window.
+     * `PARENT` - Opens the linked document in the link's parent frame.
+     * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
+     */
+    target?: Target;
+    /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
+    rel?: Rel;
+    /** A serialized object used for a custom or external link panel. */
+    customData?: string | null;
+}
+/** @oneof */
+export interface LinkDataOneOf {
+    /** The absolute URL for the linked document. */
+    url?: string;
+    /** The target node's ID. Used for linking to another node in this object. */
+    anchor?: string;
+}
+export declare enum Target {
+    /** Opens the linked document in the same frame as it was clicked (this is default) */
+    SELF = "SELF",
+    /** Opens the linked document in a new window or tab */
+    BLANK = "BLANK",
+    /** Opens the linked document in the parent frame */
+    PARENT = "PARENT",
+    /** Opens the linked document in the full body of the window */
+    TOP = "TOP"
+}
+export interface Rel {
+    /** Indicates to search engine crawlers not to follow the link. */
+    nofollow?: boolean | null;
+    /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. */
+    sponsored?: boolean | null;
+    /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. */
+    ugc?: boolean | null;
+    /** Indicates that this link protect referral information from being passed to the target website. */
+    noreferrer?: boolean | null;
+}
+export interface CodeBlockData {
+    /** Styling for the code block's text. */
+    textStyle?: TextStyle;
+}
+export interface TextStyle {
+    /** Text alignment. Defaults to `AUTO`. */
+    textAlignment?: TextAlignment;
+    /** A CSS `line-height` value for the text as a unitless ratio. */
+    lineHeight?: string | null;
+}
+export declare enum TextAlignment {
+    /** browser default, eqivalent to `initial` */
+    AUTO = "AUTO",
+    /** Left align */
+    LEFT = "LEFT",
+    /** Right align */
+    RIGHT = "RIGHT",
+    /** Center align */
+    CENTER = "CENTER",
+    /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
+    JUSTIFY = "JUSTIFY"
+}
+export interface DividerData {
+    /** Styling for the divider's container. */
+    containerData?: PluginContainerData;
+    /** Divider line style. */
+    lineStyle?: LineStyle;
+    /** Divider width. */
+    width?: Width;
+    /** Divider alignment. */
+    alignment?: Alignment;
+}
+export declare enum LineStyle {
+    /** Single Line */
+    SINGLE = "SINGLE",
+    /** Double Line */
+    DOUBLE = "DOUBLE",
+    /** Dashed Line */
+    DASHED = "DASHED",
+    /** Dotted Line */
+    DOTTED = "DOTTED"
+}
+export declare enum Width {
+    /** Large line */
+    LARGE = "LARGE",
+    /** Medium line */
+    MEDIUM = "MEDIUM",
+    /** Small line */
+    SMALL = "SMALL"
+}
+export declare enum Alignment {
+    /** Center alignment */
+    CENTER = "CENTER",
+    /** Left alignment */
+    LEFT = "LEFT",
+    /** Right alignment */
+    RIGHT = "RIGHT"
+}
+export interface FileData {
+    /** Styling for the file's container. */
+    containerData?: PluginContainerData;
+    /** The source for the file's data. */
+    src?: FileSource;
+    /** File name. */
+    name?: string | null;
+    /** File type. */
+    type?: string | null;
+    /** File size in KB. */
+    size?: number | null;
+    /** Settings for PDF files. */
+    pdfSettings?: PDFSettings;
+    /** File MIME type. */
+    mimeType?: string | null;
+    /** File path. */
+    path?: string | null;
+}
+export declare enum ViewMode {
+    /** No PDF view */
+    NONE = "NONE",
+    /** Full PDF view */
+    FULL = "FULL",
+    /** Mini PDF view */
+    MINI = "MINI"
+}
+export interface FileSource extends FileSourceDataOneOf {
+    /** The absolute URL for the file's source. */
+    url?: string | null;
+    /** Custom ID. Use `id` instead. */
+    custom?: string | null;
+    /** An ID that's resolved to a URL by a resolver function. */
+    _id?: string | null;
+    /** Indicates whether the file's source is private. */
+    private?: boolean | null;
+}
+/** @oneof */
+export interface FileSourceDataOneOf {
+    /** The absolute URL for the file's source. */
+    url?: string | null;
+    /** Custom ID. Use `id` instead. */
+    custom?: string | null;
+    /** An ID that's resolved to a URL by a resolver function. */
+    _id?: string | null;
+}
+export interface PDFSettings {
+    /**
+     * PDF view mode. One of the following:
+     * `NONE` : The PDF isn't displayed.
+     * `FULL` : A full page view of the PDF is displayed.
+     * `MINI` : A mini view of the PDF is displayed.
+     */
+    viewMode?: ViewMode;
+    /** Sets whether the PDF download button is disabled. */
+    disableDownload?: boolean | null;
+    /** Sets whether the PDF print button is disabled. */
+    disablePrint?: boolean | null;
+}
+export interface GalleryData {
+    /** Styling for the gallery's container. */
+    containerData?: PluginContainerData;
+    /** The items in the gallery. */
+    items?: Item[];
+    /** Options for defining the gallery's appearance. */
+    options?: GalleryOptions;
+    /** Sets whether the gallery's expand button is disabled. */
+    disableExpand?: boolean | null;
+    /** Sets whether the gallery's download button is disabled. */
+    disableDownload?: boolean | null;
+}
+export interface Media {
+    /** The source for the media's data. */
+    src?: FileSource;
+    /** Media width in pixels. */
+    width?: number | null;
+    /** Media height in pixels. */
+    height?: number | null;
+    /** Media duration in seconds. Only relevant for audio and video files. */
+    duration?: number | null;
+}
+export interface Image {
+    /** Image file details. */
+    media?: Media;
+    /** Link details for images that are links. */
+    link?: Link;
+}
+export interface Video {
+    /** Video file details. */
+    media?: Media;
+    /** Video thumbnail file details. */
+    thumbnail?: Media;
+}
+export interface Item extends ItemDataOneOf {
+    /** An image item. */
+    image?: Image;
+    /** A video item. */
+    video?: Video;
+    /** Item title. */
+    title?: string | null;
+    /** Item's alternative text. */
+    altText?: string | null;
+}
+/** @oneof */
+export interface ItemDataOneOf {
+    /** An image item. */
+    image?: Image;
+    /** A video item. */
+    video?: Video;
+}
+export interface GalleryOptions {
+    /** Gallery layout. */
+    layout?: Layout;
+    /** Styling for gallery items. */
+    item?: ItemStyle;
+    /** Styling for gallery thumbnail images. */
+    thumbnails?: Thumbnails;
+}
+export declare enum LayoutType {
+    /** Collage type */
+    COLLAGE = "COLLAGE",
+    /** Masonry type */
+    MASONRY = "MASONRY",
+    /** Grid type */
+    GRID = "GRID",
+    /** Thumbnail type */
+    THUMBNAIL = "THUMBNAIL",
+    /** Slider type */
+    SLIDER = "SLIDER",
+    /** Slideshow type */
+    SLIDESHOW = "SLIDESHOW",
+    /** Panorama type */
+    PANORAMA = "PANORAMA",
+    /** Column type */
+    COLUMN = "COLUMN",
+    /** Magic type */
+    MAGIC = "MAGIC",
+    /** Fullsize images type */
+    FULLSIZE = "FULLSIZE"
+}
+export declare enum Orientation {
+    /** Rows Orientation */
+    ROWS = "ROWS",
+    /** Columns Orientation */
+    COLUMNS = "COLUMNS"
+}
+export declare enum Crop {
+    /** Crop to fill */
+    FILL = "FILL",
+    /** Crop to fit */
+    FIT = "FIT"
+}
+export declare enum ThumbnailsAlignment {
+    /** Top alignment */
+    TOP = "TOP",
+    /** Right alignment */
+    RIGHT = "RIGHT",
+    /** Bottom alignment */
+    BOTTOM = "BOTTOM",
+    /** Left alignment */
+    LEFT = "LEFT",
+    /** No thumbnail */
+    NONE = "NONE"
+}
+export interface Layout {
+    /** Gallery layout type. */
+    type?: LayoutType;
+    /** Sets whether horizontal scroll is enabled. */
+    horizontalScroll?: boolean | null;
+    /** Gallery orientation. */
+    orientation?: Orientation;
+    /** The number of columns to display on full size screens. */
+    numberOfColumns?: number | null;
+    /** The number of columns to display on mobile screens. */
+    mobileNumberOfColumns?: number | null;
+}
+export interface ItemStyle {
+    /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
+    targetSize?: number | null;
+    /** Item ratio */
+    ratio?: number | null;
+    /** Sets how item images are cropped. */
+    crop?: Crop;
+    /** The spacing between items in pixels. */
+    spacing?: number | null;
+}
+export interface Thumbnails {
+    /** Thumbnail alignment. */
+    placement?: ThumbnailsAlignment;
+    /** Spacing between thumbnails in pixels. */
+    spacing?: number | null;
+}
+export interface GIFData {
+    /** Styling for the GIF's container. */
+    containerData?: PluginContainerData;
+    /** The source of the full size GIF. */
+    original?: GIF;
+    /** The source of the downsized GIF. */
+    downsized?: GIF;
+    /** Height in pixels. */
+    height?: number;
+    /** Width in pixels. */
+    width?: number;
+}
+export interface GIF {
+    /** GIF format URL. */
+    gif?: string | null;
+    /** MP4 format URL. */
+    mp4?: string | null;
+    /** Thumbnail URL. */
+    still?: string | null;
+}
+export interface HeadingData {
+    /** Heading level from 1-6. */
+    level?: number;
+    /** Styling for the heading text. */
+    textStyle?: TextStyle;
+    /** Indentation level from 1-6. */
+    indentation?: number | null;
+}
+export interface HTMLData extends HTMLDataDataOneOf {
+    /** The URL for the HTML code for the node. */
+    url?: string;
+    /** The HTML code for the node. */
+    html?: string;
+    /** Whether this is an AdSense element. Use `source` instead. */
+    isAdsense?: boolean | null;
+    /** Styling for the HTML node's container. */
+    containerData?: PluginContainerData;
+    /** The type of HTML code. */
+    source?: Source;
+}
+/** @oneof */
+export interface HTMLDataDataOneOf {
+    /** The URL for the HTML code for the node. */
+    url?: string;
+    /** The HTML code for the node. */
+    html?: string;
+    /** Whether this is an AdSense element. Use `source` instead. */
+    isAdsense?: boolean | null;
+}
+export declare enum Source {
+    HTML = "HTML",
+    ADSENSE = "ADSENSE"
+}
+export interface ImageData {
+    /** Styling for the image's container. */
+    containerData?: PluginContainerData;
+    /** Image file details. */
+    image?: Media;
+    /** Link details for images that are links. */
+    link?: Link;
+    /** Sets whether the image expands to full screen when clicked. */
+    disableExpand?: boolean | null;
+    /** Image's alternative text. */
+    altText?: string | null;
+    /** Image caption. */
+    caption?: string | null;
+    /** Sets whether the image's download button is disabled. */
+    disableDownload?: boolean | null;
+}
+export interface LinkPreviewData {
+    /** Styling for the link preview's container. */
+    containerData?: PluginContainerData;
+    /** Link details. */
+    link?: Link;
+    /** Preview title. */
+    title?: string | null;
+    /** Preview thumbnail URL. */
+    thumbnailUrl?: string | null;
+    /** Preview description. */
+    description?: string | null;
+    /** The preview content as HTML. */
+    html?: string | null;
+}
+export interface MapData {
+    /** Styling for the map's container. */
+    containerData?: PluginContainerData;
+    /** Map settings. */
+    mapSettings?: MapSettings;
+}
+export interface MapSettings {
+    /** The address to display on the map. */
+    address?: string | null;
+    /** Sets whether the map is draggable. */
+    draggable?: boolean | null;
+    /** Sets whether the location marker is visible. */
+    marker?: boolean | null;
+    /** Sets whether street view control is enabled. */
+    streetViewControl?: boolean | null;
+    /** Sets whether zoom control is enabled. */
+    zoomControl?: boolean | null;
+    /** Location latitude. */
+    lat?: number | null;
+    /** Location longitude. */
+    lng?: number | null;
+    /** Location name. */
+    locationName?: string | null;
+    /** Sets whether view mode control is enabled. */
+    viewModeControl?: boolean | null;
+    /** Initial zoom value. */
+    initialZoom?: number | null;
+    /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
+    mapType?: MapType;
+}
+export declare enum MapType {
+    /** Roadmap map type */
+    ROADMAP = "ROADMAP",
+    /** Satellite map type */
+    SATELITE = "SATELITE",
+    /** Hybrid map type */
+    HYBRID = "HYBRID",
+    /** Terrain map type */
+    TERRAIN = "TERRAIN"
+}
+export interface ParagraphData {
+    /** Styling for the paragraph text. */
+    textStyle?: TextStyle;
+    /** Indentation level from 1-6. */
+    indentation?: number | null;
+}
+export interface PollData {
+    /** Styling for the poll's container. */
+    containerData?: PluginContainerData;
+    /** Poll data. */
+    poll?: Poll;
+    /** Layout settings for the poll and voting options. */
+    layout?: PollDataLayout;
+    /** Styling for the poll and voting options. */
+    design?: Design;
+}
+export declare enum ViewRole {
+    /** Only Poll creator can view the results */
+    CREATOR = "CREATOR",
+    /** Anyone who voted can see the results */
+    VOTERS = "VOTERS",
+    /** Anyone can see the results, even if one didn't vote */
+    EVERYONE = "EVERYONE"
+}
+export declare enum VoteRole {
+    /** Logged in member */
+    SITE_MEMBERS = "SITE_MEMBERS",
+    /** Anyone */
+    ALL = "ALL"
+}
+export interface Permissions {
+    /** Sets who can view the poll results. */
+    view?: ViewRole;
+    /** Sets who can vote. */
+    vote?: VoteRole;
+    /** Sets whether one voter can vote multiple times. */
+    allowMultipleVotes?: boolean | null;
+}
+export interface Option {
+    /** Option ID. */
+    _id?: string | null;
+    /** Option title. */
+    title?: string | null;
+    /** The image displayed with the option. */
+    image?: Media;
+}
+export interface PollSettings {
+    /** Permissions settings for voting. */
+    permissions?: Permissions;
+    /** Sets whether voters are displayed in the vote results. */
+    showVoters?: boolean | null;
+    /** Sets whether the vote count is displayed. */
+    showVotesCount?: boolean | null;
+}
+export declare enum PollLayoutType {
+    /** List */
+    LIST = "LIST",
+    /** Grid */
+    GRID = "GRID"
+}
+export declare enum PollLayoutDirection {
+    /** Left-to-right */
+    LTR = "LTR",
+    /** Right-to-left */
+    RTL = "RTL"
+}
+export interface PollLayout {
+    /** The layout for displaying the voting options. */
+    type?: PollLayoutType;
+    /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
+    direction?: PollLayoutDirection;
+    /** Sets whether to display the main poll image. */
+    enableImage?: boolean | null;
+}
+export interface OptionLayout {
+    /** Sets whether to display option images. */
+    enableImage?: boolean | null;
+}
+export declare enum BackgroundType {
+    /** Color background type */
+    COLOR = "COLOR",
+    /** Image background type */
+    IMAGE = "IMAGE",
+    /** Gradiant background type */
+    GRADIENT = "GRADIENT"
+}
+export interface Gradient {
+    /** The gradient angle in degrees. */
+    angle?: number | null;
+    /** The start color as a hexademical value. */
+    startColor?: string | null;
+    /** The end color as a hexademical value. */
+    lastColor?: string | null;
+}
+export interface Background extends BackgroundBackgroundOneOf {
+    /** The background color as a hexademical value. */
+    color?: string | null;
+    /** An image to use for the background. */
+    image?: Media;
+    /** Details for a gradient background. */
+    gradient?: Gradient;
+    /** Background type. For each option, include the relevant details. */
+    type?: BackgroundType;
+}
+/** @oneof */
+export interface BackgroundBackgroundOneOf {
+    /** The background color as a hexademical value. */
+    color?: string | null;
+    /** An image to use for the background. */
+    image?: Media;
+    /** Details for a gradient background. */
+    gradient?: Gradient;
+}
+export interface PollDesign {
+    /** Background styling. */
+    background?: Background;
+    /** Border radius in pixels. */
+    borderRadius?: number | null;
+}
+export interface OptionDesign {
+    /** Border radius in pixels. */
+    borderRadius?: number | null;
+}
+export interface Poll {
+    /** Poll ID. */
+    _id?: string | null;
+    /** Poll title. */
+    title?: string | null;
+    /** Poll creator ID. */
+    creatorId?: string | null;
+    /** Main poll image. */
+    image?: Media;
+    /** Voting options. */
+    options?: Option[];
+    /** The poll's permissions and display settings. */
+    settings?: PollSettings;
+}
+export interface PollDataLayout {
+    /** Poll layout settings. */
+    poll?: PollLayout;
+    /** Voting otpions layout settings. */
+    options?: OptionLayout;
+}
+export interface Design {
+    /** Styling for the poll. */
+    poll?: PollDesign;
+    /** Styling for voting options. */
+    options?: OptionDesign;
+}
+export interface TextData {
+    /** The text to apply decorations to. */
+    text?: string;
+    /** The decorations to apply. */
+    decorations?: Decoration[];
+}
+/** Adds appearence changes to text */
+export interface Decoration extends DecorationDataOneOf {
+    /** Data for an anchor link decoration. */
+    anchorData?: AnchorData;
+    /** Data for a color decoration. */
+    colorData?: ColorData;
+    /** Data for an external link decoration. */
+    linkData?: LinkData;
+    /** Data for a mention decoration. */
+    mentionData?: MentionData;
+    /** Data for a font size decoration. */
+    fontSizeData?: FontSizeData;
+    /** Font weight for a bold decoration. */
+    fontWeightValue?: number | null;
+    /** Data for an italic decoration. */
+    italicData?: boolean | null;
+    /** Data for an underline decoration. */
+    underlineData?: boolean | null;
+    /** The type of decoration to apply. */
+    type?: DecorationType;
+}
+/** @oneof */
+export interface DecorationDataOneOf {
+    /** Data for an anchor link decoration. */
+    anchorData?: AnchorData;
+    /** Data for a color decoration. */
+    colorData?: ColorData;
+    /** Data for an external link decoration. */
+    linkData?: LinkData;
+    /** Data for a mention decoration. */
+    mentionData?: MentionData;
+    /** Data for a font size decoration. */
+    fontSizeData?: FontSizeData;
+    /** Font weight for a bold decoration. */
+    fontWeightValue?: number | null;
+    /** Data for an italic decoration. */
+    italicData?: boolean | null;
+    /** Data for an underline decoration. */
+    underlineData?: boolean | null;
+}
+export declare enum DecorationType {
+    BOLD = "BOLD",
+    ITALIC = "ITALIC",
+    UNDERLINE = "UNDERLINE",
+    SPOILER = "SPOILER",
+    ANCHOR = "ANCHOR",
+    MENTION = "MENTION",
+    LINK = "LINK",
+    COLOR = "COLOR",
+    FONT_SIZE = "FONT_SIZE",
+    EXTERNAL = "EXTERNAL"
+}
+export interface AnchorData {
+    /** The target node's ID. */
+    anchor?: string;
+}
+export interface ColorData {
+    /** The text's background color as a hexadecimal value. */
+    background?: string | null;
+    /** The text's foreground color as a hexadecimal value. */
+    foreground?: string | null;
+}
+export interface LinkData {
+    /** Link details. */
+    link?: Link;
+}
+export interface MentionData {
+    /** The mentioned user's name. */
+    name?: string;
+    /** The version of the user's name that appears after the `@` character in the mention. */
+    slug?: string;
+    /** Mentioned user's ID. */
+    _id?: string | null;
+}
+export interface FontSizeData {
+    /** The units used for the font size. */
+    unit?: FontType;
+    /** Font size value. */
+    value?: number | null;
+}
+export declare enum FontType {
+    PX = "PX",
+    EM = "EM"
+}
+export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
+    /** Data for embedded Wix Bookings content. */
+    bookingData?: BookingData;
+    /** Data for embedded Wix Events content. */
+    eventData?: EventData;
+    /** The type of Wix App content being embedded. */
+    type?: AppType;
+    /** The ID of the embedded content. */
+    itemId?: string | null;
+    /** The name of the embedded content. */
+    name?: string | null;
+    /** Deprecated: Use `image` instead. */
+    imageSrc?: string | null;
+    /** The URL for the embedded content. */
+    url?: string | null;
+    /** An image for the embedded content. */
+    image?: Media;
+}
+/** @oneof */
+export interface AppEmbedDataAppDataOneOf {
+    /** Data for embedded Wix Bookings content. */
+    bookingData?: BookingData;
+    /** Data for embedded Wix Events content. */
+    eventData?: EventData;
+}
+export declare enum AppType {
+    PRODUCT = "PRODUCT",
+    EVENT = "EVENT",
+    BOOKING = "BOOKING"
+}
+export interface BookingData {
+    /** Booking duration in minutes. */
+    durations?: string | null;
+}
+export interface EventData {
+    /** Event schedule. */
+    scheduling?: string | null;
+    /** Event location. */
+    location?: string | null;
+}
+export interface VideoData {
+    /** Styling for the video's container. */
+    containerData?: PluginContainerData;
+    /** Video details. */
+    video?: Media;
+    /** Video thumbnail details. */
+    thumbnail?: Media;
+    /** Sets whether the video's download button is disabled. */
+    disableDownload?: boolean | null;
+    /** Video title. */
+    title?: string | null;
+    /** Video options. */
+    options?: PlaybackOptions;
+}
+export interface PlaybackOptions {
+    /** Sets whether the media will automatically start playing. */
+    autoPlay?: boolean | null;
+    /** Sets whether media's will be looped. */
+    playInLoop?: boolean | null;
+    /** Sets whether media's controls will be shown. */
+    showControls?: boolean | null;
+}
+export interface EmbedData {
+    /** Styling for the oEmbed node's container. */
+    containerData?: PluginContainerData;
+    /** An [oEmbed](https://www.oembed.com) object. */
+    oembed?: Oembed;
+    /** Origin asset source. */
+    src?: string | null;
+}
+export interface Oembed {
+    /** The resource type. */
+    type?: string | null;
+    /** The width of the resource specified in the `url` property in pixels. */
+    width?: number | null;
+    /** The height of the resource specified in the `url` property in pixels. */
+    height?: number | null;
+    /** Resource title. */
+    title?: string | null;
+    /** The source URL for the resource. */
+    url?: string | null;
+    /** HTML for embedding a video player. The HTML should have no padding or margins. */
+    html?: string | null;
+    /** The name of the author or owner of the resource. */
+    authorName?: string | null;
+    /** The URL for the author or owner of the resource. */
+    authorUrl?: string | null;
+    /** The name of the resource provider. */
+    providerName?: string | null;
+    /** The URL for the resource provider. */
+    providerUrl?: string | null;
+    /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
+    thumbnailUrl?: string | null;
+    /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
+    thumbnailWidth?: string | null;
+    /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
+    thumbnailHeight?: string | null;
+    /** The URL for an embedded viedo. */
+    videoUrl?: string | null;
+    /** The oEmbed version number.  This value must be `1.0`. */
+    version?: string | null;
+}
+export interface CollapsibleListData {
+    /** Styling for the collapsible list's container. */
+    containerData?: PluginContainerData;
+    /** If `true`, only one item can be expanded at a time. */
+    expandOnlyOne?: boolean | null;
+    /** Sets which items are expanded when the page loads. */
+    initialExpandedItems?: InitialExpandedItems;
+    /** The direction of the text in the list. Either left-to-right or right-to-left. */
+    direction?: Direction;
+    /** If `true`, The collapsible item will appear in search results as an FAQ. */
+    isQapageData?: boolean | null;
+}
+export declare enum InitialExpandedItems {
+    /** First item will be expended initally */
+    FIRST = "FIRST",
+    /** All items will expended initally */
+    ALL = "ALL",
+    /** All items collapsed initally */
+    NONE = "NONE"
+}
+export declare enum Direction {
+    /** Left-to-right */
+    LTR = "LTR",
+    /** Right-to-left */
+    RTL = "RTL"
+}
+export interface TableData {
+    /** Styling for the table's container. */
+    containerData?: PluginContainerData;
+    /** The table's dimensions. */
+    dimensions?: Dimensions;
+    /** Deprecated: Use `rowHeader` and `columnHeader` instead. */
+    header?: boolean | null;
+    /** Sets whether the table's first row is a header. */
+    rowHeader?: boolean | null;
+    /** Sets whether the table's first column is a header. */
+    columnHeader?: boolean | null;
+}
+export interface Dimensions {
+    /** An array representing relative width of each column in relation to the other columns. */
+    colsWidthRatio?: number[];
+    /** An array representing the height of each row in pixels. */
+    rowsHeight?: number[];
+    /** An array representing the minimum width of each column in pixels. */
+    colsMinWidth?: number[];
+}
+export interface TableCellData {
+    /** Styling for the cell's background color and text alignment. */
+    cellStyle?: CellStyle;
+    /** The cell's border colors. */
+    borderColors?: BorderColors;
+}
+export declare enum VerticalAlignment {
+    /** Top alignment */
+    TOP = "TOP",
+    /** Middle alignment */
+    MIDDLE = "MIDDLE",
+    /** Bottom alignment */
+    BOTTOM = "BOTTOM"
+}
+export interface CellStyle {
+    /** Vertical alignment for the cell's text. */
+    verticalAlignment?: VerticalAlignment;
+    /** Cell background color as a hexadecimal value. */
+    backgroundColor?: string | null;
+}
+export interface BorderColors {
+    /** Left border color as a hexadecimal value. */
+    left?: string | null;
+    /** Right border color as a hexadecimal value. */
+    right?: string | null;
+    /** Top border color as a hexadecimal value. */
+    top?: string | null;
+    /** Bottom border color as a hexadecimal value. */
+    bottom?: string | null;
+}
+/**
+ * `NullValue` is a singleton enumeration to represent the null value for the
+ * `Value` type union.
+ *
+ * The JSON representation for `NullValue` is JSON `null`.
+ */
+export declare enum NullValue {
+    /** Null value. */
+    NULL_VALUE = "NULL_VALUE"
+}
+/**
+ * `ListValue` is a wrapper around a repeated field of values.
+ *
+ * The JSON representation for `ListValue` is JSON array.
+ */
+export interface ListValue {
+    /** Repeated field of dynamically typed values. */
+    values?: any[];
+}
+export interface AudioData {
+    /** Styling for the audio node's container. */
+    containerData?: PluginContainerData;
+    /** Audio file details. */
+    audio?: Media;
+    /** Sets whether the audio node's download button is disabled. */
+    disableDownload?: boolean | null;
+    /** Cover image. */
+    coverImage?: Media;
+    /** Track name. */
+    name?: string | null;
+    /** Author name. */
+    authorName?: string | null;
+    /** An HTML version of the audio node. */
+    html?: string | null;
+}
+export interface OrderedListData {
+    /** Indentation level. */
+    indentation?: number;
+}
+export interface BulletedListData {
+    /** Indentation level. */
+    indentation?: number;
+}
+export interface BlockquoteData {
+    /** Indentation level. */
+    indentation?: number;
+}
+export interface Metadata {
+    /** Schema version. */
+    version?: number;
+    /**
+     * When the object was created.
+     * @readonly
+     */
+    createdTimestamp?: Date;
+    /** When the object was most recently updated. */
+    updatedTimestamp?: Date;
+    /** Object ID. */
+    _id?: string | null;
+}
+export interface DocumentStyle {
+    /** Styling for H1 nodes. */
+    headerOne?: TextNodeStyle;
+    /** Styling for H2 nodes. */
+    headerTwo?: TextNodeStyle;
+    /** Styling for H3 nodes. */
+    headerThree?: TextNodeStyle;
+    /** Styling for H4 nodes. */
+    headerFour?: TextNodeStyle;
+    /** Styling for H5 nodes. */
+    headerFive?: TextNodeStyle;
+    /** Styling for H6 nodes. */
+    headerSix?: TextNodeStyle;
+    /** Styling for paragraph nodes. */
+    paragraph?: TextNodeStyle;
+    /** Styling for block quote nodes. */
+    blockquote?: TextNodeStyle;
+    /** Styling for code block nodes. */
+    codeBlock?: TextNodeStyle;
+}
+export interface TextNodeStyle {
+    /** The decorations to apply to the node. */
+    decorations?: Decoration[];
+    /** Padding and background color for the node. */
+    nodeStyle?: NodeStyle;
+    /** Line height for text in the node. */
+    lineHeight?: string | null;
+}
+export interface TreeReference {
+    /** The unique namespace of the app. */
+    appNamespace?: string;
+    /** Optional - The key of the tree. Must be provided when single app manages more than one tree. */
+    treeKey?: string | null;
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data as key:object pairs. 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 created.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface CreateCategoryRequest {
+    /** Category to be created. */
+    category: Category;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[];
+}
+export declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    BREADCRUMBS = "BREADCRUMBS"
+}
+export interface CreateCategoryResponse {
+    /** The created Category. */
+    category?: Category;
+}
+export interface GetCategoryRequest {
+    /** Id of the Category to retrieve. */
+    categoryId: string;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[];
+}
+export interface GetCategoryResponse {
+    /** The retrieved Category. */
+    category?: Category;
+}
+export interface UpdateCategoryRequest {
+    /** Category to be updated, may be partial. */
+    category: Category;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[];
+}
+export interface UpdateCategoryResponse {
+    /** The updated Category. */
+    category?: Category;
+}
+export interface DeleteCategoryRequest {
+    /** Id of the Category to delete. */
+    categoryId: string;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+}
+export interface DeleteCategoryResponse {
+}
+export interface QueryCategoriesRequest {
+    /** WQL query expression. */
+    query?: CursorQuery;
+    /**
+     * A reference to the tree that contains this category.
+     * Used only in the first request. Following requests use the cursor token.
+     */
+    treeReference: TreeReference;
+    /**
+     * Whether hidden categories should be included in the response. Default is `false`.
+     * Used only in the first request. Following requests use the cursor token.
+     */
+    includeHidden?: boolean;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[];
+}
+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"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    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. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryCategoriesResponse {
+    /** Categories which satisfy the provided query. */
+    categories?: Category[];
+    /** Paging metadata. Contains cursor which can be used in next query. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface PlaceCategoryInParentCategoryRequest {
+    /** ID of category to place. */
+    categoryId: string;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /**
+     * ID of parent category.
+     * Optional. When not passed it will fallback to the root category
+     */
+    parentCategoryId?: string | null;
+    /**
+     * Where to place the subcategory.
+     * `FIRST` - make category with `category_id` first subcategory with manual arrangement.
+     * `LAST` - make category with `category_id` last subcategory with manual arrangement.
+     * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.
+     */
+    position: PlaceCategoryInParentCategoryRequestPosition;
+    /** Required when `position` is `BEFORE`. Otherwise ignored */
+    moveBeforeCategoryId?: string | null;
+}
+export declare enum PlaceCategoryInParentCategoryRequestPosition {
+    UNKNOWN_POSITION = "UNKNOWN_POSITION",
+    FIRST = "FIRST",
+    LAST = "LAST",
+    BEFORE = "BEFORE"
+}
+export interface PlaceCategoryInParentCategoryResponse {
+    /** ID of parent category. */
+    parentCategoryId?: string | null;
+    /** Information about manually arranged categories after move. */
+    arrangedCategoriesAfterMove?: string[];
+}
+export interface BulkCreateCategoriesRequest {
+    /** List of categories to be created. */
+    categories?: Category[];
+    /** A reference to the tree that contains the categories. */
+    treeReference?: TreeReference;
+    /** Whether to return the category entity in the response. */
+    returnEntity?: boolean;
+}
+export interface BulkCreateCategoriesResponse {
+    /** Categories created by bulk action. */
+    results?: BulkCategoriesResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkCategoriesResult {
+    /** Information about successful action or error for failure. */
+    itemMetadata?: ItemMetadata;
+    /** Created or updated category. Optional - returned only if requested with `return_entity` set to `true`. */
+    category?: Category;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface BulkUpdateCategoriesRequest {
+    /** List of categories to be updated. */
+    categories: MaskedCategory[];
+    /** A reference to the tree that contains the categories. */
+    treeReference: TreeReference;
+    /** Whether to return the category entity in the response. */
+    returnEntity?: boolean;
+}
+export interface MaskedCategory {
+    /** Category to be updated, may be partial. */
+    category?: Category;
+}
+export interface BulkUpdateCategoriesResponse {
+    /** Categories updated by bulk action. */
+    results?: BulkCategoriesResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface UpdateCategoryVisibilityRequest {
+    /** ID of category to be updated */
+    categoryId: string;
+    /** value to set `visible` to */
+    visible: boolean;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Latest revision of the category. */
+    revision: string | null;
+}
+export interface UpdateCategoryVisibilityResponse {
+    /** The updated Category. */
+    category?: Category;
+}
+export interface BulkUpdateVisibilityRequest {
+    /** IDs of categories to be updated. */
+    categoryIds?: string[];
+    /** value to set `visible` to. This value will be set for all categories in the request */
+    visible?: boolean;
+    /** A reference to the tree that contains this category. */
+    treeReference?: TreeReference;
+    /** Whether to return the category entity in the response. */
+    returnEntity?: boolean;
+}
+export interface BulkUpdateVisibilityResponse {
+    /** Categories updated by bulk action. */
+    results?: BulkCategoriesResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkUpdateVisibilityByFilterRequest {
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /** A reference to the tree that contains the categories. */
+    treeReference?: TreeReference;
+    /** value to set `visible` to. This value will be set for all categories that match the filter */
+    visible?: boolean;
+}
+export interface BulkUpdateVisibilityByFilterResponse {
+    /** Token that can be used to query "AsyncJobService" */
+    jobId?: string;
+}
+export interface BulkDeleteCategoriesRequest {
+    /** IDs of categories to be deleted. */
+    categoryIds?: string[];
+}
+export interface BulkDeleteCategoriesResponse {
+    /** Categories deleted by bulk action. */
+    results?: BulkCategoriesResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkDeleteCategoriesByFilterRequest {
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /** A reference to the tree that contains the categories. */
+    treeReference?: TreeReference;
+}
+export interface BulkDeleteCategoriesByFilterResponse {
+    /** Token that can be used to query "AsyncJobService" */
+    jobId?: string;
+}
+export interface AddItemsToCategoryRequest {
+    /** Category id. */
+    categoryId: string;
+    /** List of catalog items with reference info. */
+    items: ItemReference[];
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+}
+export interface ItemReference {
+    /** ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores or `eventId` for Wix Events. */
+    catalogItemId?: string;
+    /** ID of the catalog app. For example, the Wix Stores `appId`, or the 3rd-party `appId`. */
+    appId?: string;
+}
+export interface AddItemsToCategoryResponse {
+    /** Items added by bulk action. */
+    results?: BulkItemsToCategoryResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkItemsToCategoryResult {
+    /** Information about items that were added successfully and errors for failed items. */
+    itemMetadata?: ItemReferenceMetadata;
+}
+export interface ItemReferenceMetadata {
+    /** Item reference from request. */
+    itemReference?: ItemReference;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ItemAddedToCategory {
+    /** Category ID. */
+    categoryId?: string;
+    /** Catalog item reference info. */
+    itemReference?: ItemReference;
+}
+export interface ItemsAddedToCategory {
+    /** Category ID. */
+    categoryId?: string;
+    /** List of catalog items with reference info. */
+    items?: ItemReference[];
+}
+export interface AddItemToCategoriesRequest {
+    /** Catalog item reference info */
+    itemReference: ItemReference;
+    /** Category ids. */
+    categoryIds: string[];
+    /** A reference to the tree that contains the categories. */
+    treeReference: TreeReference;
+}
+export interface AddItemToCategoriesResponse {
+    /** Items added by bulk action. */
+    results?: BulkItemToCategoriesResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkItemToCategoriesResult {
+    /** Information about categories to which item was added successfully and errors for failed items. `id` is ID of category. */
+    itemMetadata?: ItemMetadata;
+}
+export interface RemoveItemsFromCategoryRequest {
+    /** Category id */
+    categoryId: string;
+    /** List of catalog items with reference info. */
+    items: ItemReference[];
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+}
+export interface RemoveItemsFromCategoryResponse {
+    /** Items removed by bulk action. */
+    results?: BulkItemsToCategoryResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ItemRemovedFromCategory {
+    /** Category ID. */
+    categoryId?: string;
+    /** Catalog item reference info. */
+    itemReference?: ItemReference;
+}
+export interface ItemsRemovedFromCategory {
+    /** Category ID. */
+    categoryId?: string;
+    /** List of catalog items with reference info. */
+    items?: ItemReference[];
+}
+export interface RemoveItemFromCategoriesRequest {
+    /** Catalog item reference info */
+    itemReference: ItemReference;
+    /** Category ids. */
+    categoryIds: string[];
+    /** A reference to the tree that contains the categories. */
+    treeReference: TreeReference;
+}
+export interface RemoveItemFromCategoriesResponse {
+    /** Items removed by bulk action. */
+    results?: BulkItemToCategoriesResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ListItemsInCategoryRequest {
+    /** ID of category containing items. */
+    categoryId: string;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Default: `false`. When `true` items arranged by user will be return before all other items. */
+    useCategoryArrangement?: boolean;
+    /** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */
+    includeItemsFromSubcategories?: boolean;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
+    paging?: CursorPaging;
+}
+export interface ListItemsInCategoryResponse {
+    /** Items which satisfy query. */
+    items?: ItemReference[];
+    /** Paging metadata. Contains cursor which can be used in next query */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface ListCategoriesForItemRequest {
+    /** Catalog item reference info. */
+    itemReference: ItemReference;
+    /** A reference to the tree that contains the categories. */
+    treeReference: TreeReference;
+}
+export interface ListCategoriesForItemResponse {
+    /** A list of category IDs that contain this item directly. */
+    directCategoryIds?: string[];
+    /** A list of category IDs that contain this item directly and their parent category IDs. */
+    allCategoryIds?: string[];
+}
+export interface MoveItemInCategoryRequest {
+    /**
+     * ID of category.
+     * Item must be direct child of this category, otherwise error returned
+     */
+    categoryId: string;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Item to move. */
+    item: ItemReference;
+    /**
+     * Where to move item.
+     * `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.
+     * `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.
+     * `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.
+     * `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.
+     */
+    position: Position;
+    /** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */
+    beforeItem?: ItemReference;
+}
+export declare enum Position {
+    UNKNOWN_POSITION = "UNKNOWN_POSITION",
+    FIRST = "FIRST",
+    LAST = "LAST",
+    BEFORE = "BEFORE",
+    NONE = "NONE"
+}
+export interface MoveItemInCategoryResponse {
+    /** Information about manually arranged items after move. */
+    arrangedItemsAfterMove?: ItemReference[];
+}
+export interface SetArrangedItemsRequest {
+    /** ID of category. */
+    categoryId: string;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /**
+     * List of arranged items to set.
+     * All items must be direct children of category with `category_id`, otherwise error returned.
+     */
+    items?: ItemReference[];
+}
+export interface SetArrangedItemsResponse {
+    /** The updated list of arranged items in category. */
+    items?: ItemReference[];
+}
+export interface GetArrangedItemsRequest {
+    /** ID of category. */
+    categoryId: string;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+}
+export interface GetArrangedItemsResponse {
+    /** List of arranged items in category. */
+    items?: ItemReference[];
+}
+export interface GetCategoriesTreeRequest {
+    /** The ID of the tree. */
+    treeId?: string;
+}
+export interface GetCategoriesTreeResponse {
+    /** Categories tree. */
+    categoriesTree?: CategoryTreeNode[];
+}
+/** Represents a node in the view of categories tree */
+export interface CategoryTreeNode {
+    /** Category ID. */
+    _id?: Uint8Array;
+    /** A list of child categories. */
+    subcategories?: CategoryTreeNode[];
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+    /** random GUID so clients can tell if event was already handled */
+    _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;
+    /**
+     * Assuming that all messages including Actions have id
+     * Example: The id of the specific order, the id of a specific campaign
+     */
+    entityId?: string;
+    /** The time of the event. Useful if there was a delay in dispatching */
+    eventTime?: Date;
+    /**
+     * A field that should be set if this event was triggered by an anonymize request.
+     * For example you must set it to true when sending an event as a result of a GDPR right to be forgotten request.
+     * NOTE: This field is not relevant for `EntityCreatedEvent` but is located here for better ergonomics of consumers.
+     */
+    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 */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    extendedFieldsUpdatedEvent?: ExtendedFieldsUpdatedEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface ExtendedFieldsUpdatedEvent {
+    currentEntityAsJson?: string;
+}
+export interface Empty {
+}
+/**
+ * Creates a new Category.
+ * @param category - Category to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField category
+ * @requiredField category.name
+ * @requiredField category.parentCategory._id
+ * @requiredField options
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ * @returns The created Category.
+ */
+export declare function createCategory(category: Category, options: CreateCategoryOptions): Promise<Category>;
+export interface CreateCategoryOptions {
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[];
+}
+/**
+ * Retrieves a category with the provided ID.
+ * @param categoryId - Id of the Category to retrieve.
+ * @param treeReference - A reference to the tree that contains this category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField treeReference
+ * @requiredField treeReference.appNamespace
+ * @applicableIdentity VISITOR
+ * @returns The retrieved Category.
+ */
+export declare function getCategory(categoryId: string, treeReference: TreeReference, options?: GetCategoryOptions): Promise<Category>;
+export interface GetCategoryOptions {
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[];
+}
+/**
+ * Update a Category, supports partial update.
+ * Pass the latest `revision` for a successful update.
+ * Each time the category is updated, `revision` increments by 1.
+ * @param _id - Category ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField category
+ * @requiredField category.revision
+ * @requiredField options
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ * @returns The updated Category.
+ */
+export declare function updateCategory(_id: string | null, category: UpdateCategory, options: UpdateCategoryOptions): Promise<Category>;
+export interface UpdateCategory {
+    /** Category ID. */
+    _id?: string | null;
+    /**
+     * Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Represents the time this Category was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Represents the time this Category was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /** Category name. */
+    name?: string | null;
+    /**
+     * Category image.
+     * Pass existing media ID for image previously saved in Wix media manager.
+     * Pass full image URL to upload an image to Wix media manager.
+     * In case of full url the image will be updated eventually.
+     */
+    image?: string;
+    /**
+     * Number of items in this category alone.
+     * @readonly
+     */
+    numberOfItems?: number;
+    /** Category description. */
+    description?: string | null;
+    /**
+     * Whether the category is visible to site visitors in dynamic pages (If not passed, the default is `false`).
+     * Even if visible is `false`, it can still be added manually to static page.
+     * If parent visibility is updated to `false`, all the children visibility will be updated eventually to `false`.
+     * It is not allowed to set visible as `true` if at least one of the parent categories has visible `false`.
+     */
+    visible?: boolean | null;
+    /**
+     * A category's breadcrumbs, Updated on moved to different parent or on renamed.
+     * This field will only be returned if request.fields contains `BREADCRUMBS`
+     * @readonly
+     */
+    breadcrumbs?: BreadcrumbItemValues;
+    /** The parent category. */
+    parentCategory?: ParentCategory;
+    /**
+     * A permanent, friendly URL name.
+     * If not provided, on create generated automatically.
+     * When provided, validated and must be unique.
+     */
+    slug?: string | null;
+    /**
+     * Category description which supports rich content. It is independent from `description` field and can be used instead of it or in addition to it.
+     * In order to use this field you have to integrate with "Ricos" on frontend side. To learn how to do it visit https://ricos.js.org/.
+     */
+    richContentDescription?: RichContent;
+    /**
+     * Optional - the ID of the app responsible for managing the items within this category.
+     * If provided, the update of items assigned to this category and the deletion of it will be allowed only to the managing app.
+     * The default is Empty.
+     */
+    managedByAppId?: string | null;
+    /** Extensions enabling users to save custom data related to the category. */
+    extendedFields?: ExtendedFields;
+}
+export interface UpdateCategoryOptions {
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[];
+}
+/**
+ * Deletes a Category.
+ * @param categoryId - Id of the Category to delete.
+ * @param treeReference - A reference to the tree that contains this category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField treeReference
+ * @requiredField treeReference.appNamespace
+ */
+export declare function deleteCategory(categoryId: string, treeReference: TreeReference): Promise<void>;
+/**
+ * Query Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+ * @public
+ * @documentationMaturity preview
+ * @applicableIdentity VISITOR
+ */
+export declare function queryCategories(options: QueryCategoriesOptions): CategoriesQueryBuilder;
+export interface QueryCategoriesOptions {
+    /**
+     * A reference to the tree that contains this category.
+     * Used only in the first request. Following requests use the cursor token.
+     */
+    treeReference: TreeReference;
+    /**
+     * Whether hidden categories should be included in the response. Default is `false`.
+     * Used only in the first request. Following requests use the cursor token.
+     */
+    includeHidden?: boolean | undefined;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface CategoriesQueryResult extends QueryCursorResult {
+    items: Category[];
+    query: CategoriesQueryBuilder;
+    next: () => Promise<CategoriesQueryResult>;
+    prev: () => Promise<CategoriesQueryResult>;
+}
+export interface CategoriesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'name' | 'description' | 'slug', value: string) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any[]) => CategoriesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: boolean) => CategoriesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'slug'>) => CategoriesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'slug'>) => CategoriesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => CategoriesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => CategoriesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<CategoriesQueryResult>;
+}
+/**
+ * Places category in parent category.
+ * This operation updates `parentCategory` (`id` and `index`) for category with `categoryId` in tree with `treeId`.
+ * This endpoint can be used to move category to different parent in the same tree or to change it's position in current parent.
+ * @param categoryId - ID of category to place.
+ * @param treeReference - A reference to the tree that contains this category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField options
+ * @requiredField options.position
+ * @requiredField treeReference
+ * @requiredField treeReference.appNamespace
+ */
+export declare function placeCategoryInParentCategory(categoryId: string, treeReference: TreeReference, options: PlaceCategoryInParentCategoryOptions): Promise<PlaceCategoryInParentCategoryResponse>;
+export interface PlaceCategoryInParentCategoryOptions {
+    /**
+     * ID of parent category.
+     * Optional. When not passed it will fallback to the root category
+     */
+    parentCategoryId?: string | null;
+    /**
+     * Where to place the subcategory.
+     * `FIRST` - make category with `category_id` first subcategory with manual arrangement.
+     * `LAST` - make category with `category_id` last subcategory with manual arrangement.
+     * `BEFORE` - requires `move_before_category_id`, category with `category_id` will be moved before it.
+     */
+    position: PlaceCategoryInParentCategoryRequestPosition;
+    /** Required when `position` is `BEFORE`. Otherwise ignored */
+    moveBeforeCategoryId?: string | null;
+}
+/**
+ * Update multiple Categories, supports partial update.
+ * Pass the latest `revision` for a successful update.
+ * To update visibility, call the BulkUpdateCategoryVisibility endpoint.
+ * @param categories - List of categories to be updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categories
+ * @requiredField categories.category
+ * @requiredField categories.category._id
+ * @requiredField categories.category.revision
+ * @requiredField options
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ */
+export declare function bulkUpdateCategories(categories: MaskedCategory[], options: BulkUpdateCategoriesOptions): Promise<BulkUpdateCategoriesResponse>;
+export interface BulkUpdateCategoriesOptions {
+    /** A reference to the tree that contains the categories. */
+    treeReference: TreeReference;
+    /** Whether to return the category entity in the response. */
+    returnEntity?: boolean;
+}
+/**
+ * Update `visible` field. If visible is set to false, all subcategories will be set to `visible=false`
+ * @param categoryId - ID of category to be updated
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField options
+ * @requiredField options.revision
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ * @requiredField options.visible
+ */
+export declare function updateCategoryVisibility(categoryId: string, options: UpdateCategoryVisibilityOptions): Promise<UpdateCategoryVisibilityResponse>;
+export interface UpdateCategoryVisibilityOptions {
+    /** value to set `visible` to */
+    visible: boolean;
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+    /** Latest revision of the category. */
+    revision: string | null;
+}
+/**
+ * Adds multiple items to single category, fires as many domain events as many items successfully added.
+ * @param categoryId - Category id.
+ * @param items - List of catalog items with reference info.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField items
+ * @requiredField items.appId
+ * @requiredField items.catalogItemId
+ * @requiredField options
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ */
+export declare function addItemsToCategory(categoryId: string, items: ItemReference[], options: AddItemsToCategoryOptions): Promise<AddItemsToCategoryResponse>;
+export interface AddItemsToCategoryOptions {
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+}
+/**
+ * Adds single item to multiple categories, fires as many domain events as many categories were successfully added.
+ * @param itemReference - Catalog item reference info
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemReference
+ * @requiredField itemReference.appId
+ * @requiredField itemReference.catalogItemId
+ * @requiredField options
+ * @requiredField options.categoryIds
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ */
+export declare function addItemToCategories(itemReference: ItemReference, options: AddItemToCategoriesOptions): Promise<AddItemToCategoriesResponse>;
+export interface AddItemToCategoriesOptions {
+    /** Category ids. */
+    categoryIds: string[];
+    /** A reference to the tree that contains the categories. */
+    treeReference: TreeReference;
+}
+/**
+ * Removed multiple items from single category, fires as many domain events as many items successfully removed.
+ * @param categoryId - Category id
+ * @param items - List of catalog items with reference info.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField items
+ * @requiredField items.appId
+ * @requiredField items.catalogItemId
+ * @requiredField options
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ */
+export declare function removeItemsFromCategory(categoryId: string, items: ItemReference[], options: RemoveItemsFromCategoryOptions): Promise<RemoveItemsFromCategoryResponse>;
+export interface RemoveItemsFromCategoryOptions {
+    /** A reference to the tree that contains this category. */
+    treeReference: TreeReference;
+}
+/**
+ * Removes single item from multiple categories, fires as many domain events as many categories were successfully removed.
+ * @param itemReference - Catalog item reference info
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemReference
+ * @requiredField itemReference.appId
+ * @requiredField itemReference.catalogItemId
+ * @requiredField options
+ * @requiredField options.categoryIds
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ */
+export declare function removeItemFromCategories(itemReference: ItemReference, options: RemoveItemFromCategoriesOptions): Promise<RemoveItemFromCategoriesResponse>;
+export interface RemoveItemFromCategoriesOptions {
+    /** Category ids. */
+    categoryIds: string[];
+    /** A reference to the tree that contains the categories. */
+    treeReference: TreeReference;
+}
+/**
+ * Returns up to 100 items related to requested `category_id` sorted by time when item added to category, descending.
+ * When items added to category in bulk they considered as added at exactly same time so order will be random but always the same.
+ * @param categoryId - ID of category containing items.
+ * @param treeReference - A reference to the tree that contains this category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField treeReference
+ * @requiredField treeReference.appNamespace
+ * @applicableIdentity VISITOR
+ */
+export declare function listItemsInCategory(categoryId: string, treeReference: TreeReference, options?: ListItemsInCategoryOptions): Promise<ListItemsInCategoryResponse>;
+export interface ListItemsInCategoryOptions {
+    /** Default: `false`. When `true` items arranged by user will be return before all other items. */
+    useCategoryArrangement?: boolean;
+    /** Default: `false`. When `false` only direct items of category will be returned. When `true` response contains also items from all subcategories which current category contains */
+    includeItemsFromSubcategories?: boolean;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `use_category_arrangement` or `include_items_from_subcategories`. */
+    paging?: CursorPaging;
+}
+/**
+ * Returns all category IDs that contain the item and their parent category IDs.
+ * @param itemReference - Catalog item reference info.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemReference
+ * @requiredField options
+ * @requiredField options.treeReference
+ * @requiredField options.treeReference.appNamespace
+ * @applicableIdentity VISITOR
+ */
+export declare function listCategoriesForItem(itemReference: ItemReference, options: ListCategoriesForItemOptions): Promise<ListCategoriesForItemResponse>;
+export interface ListCategoriesForItemOptions {
+    /** A reference to the tree that contains the categories. */
+    treeReference: TreeReference;
+}
+/**
+ * Changes position of `item` in category. Will be used when sort items by manual arrangement
+ * @param categoryId - ID of category.
+ * Item must be direct child of this category, otherwise error returned
+ * @param treeReference - A reference to the tree that contains this category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField options
+ * @requiredField options.item
+ * @requiredField options.position
+ * @requiredField treeReference
+ * @requiredField treeReference.appNamespace
+ */
+export declare function moveItemInCategory(categoryId: string, treeReference: TreeReference, options: MoveItemInCategoryOptions): Promise<MoveItemInCategoryResponse>;
+export interface MoveItemInCategoryOptions {
+    /** Item to move. */
+    item: ItemReference;
+    /**
+     * Where to move item.
+     * `FIRST` - make `item` first item with manual arrangement. If before this operation category already has 100 manually arranged items, the 100th item will be removed from list of items with manual arrangement.
+     * `LAST` - make `item` last item with manual arrangement. If before this operation category already has 100 manually arranged items, moving item will be not last but 100th.
+     * `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.
+     * `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.
+     */
+    position: Position;
+    /** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */
+    beforeItem?: ItemReference;
+}
+/**
+ * Set arranged items in category. Will be used when sort items by manual arrangement.
+ * Calling this endpoint overrides existing list of arranged items in category.
+ * @param categoryId - ID of category.
+ * @param treeReference - A reference to the tree that contains this category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField treeReference
+ * @requiredField treeReference.appNamespace
+ */
+export declare function setArrangedItems(categoryId: string, treeReference: TreeReference, options?: SetArrangedItemsOptions): Promise<SetArrangedItemsResponse>;
+export interface SetArrangedItemsOptions {
+    /**
+     * List of arranged items to set.
+     * All items must be direct children of category with `category_id`, otherwise error returned.
+     */
+    items?: ItemReference[];
+}
+/**
+ * Returns arranged items in category
+ * @param categoryId - ID of category.
+ * @param treeReference - A reference to the tree that contains this category.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @requiredField treeReference
+ * @requiredField treeReference.appNamespace
+ * @applicableIdentity VISITOR
+ */
+export declare function getArrangedItems(categoryId: string, treeReference: TreeReference): Promise<GetArrangedItemsResponse>;
+export {};