import * as _wix_sdk_types from '@wix/sdk-types';
import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
interface Post {
/**
* Post ID.
* @readonly
* @format GUID
*/
_id?: string;
/**
* Post title.
* @maxLength 200
*/
title?: string;
/**
* Post excerpt.
* Can be selected by a site contributor. By default, it is extracted from the content text's first characters.
*
* Max: 500 characters
* @maxLength 500
*/
excerpt?: string;
/**
* The post's content in plain text.
* @readonly
* @maxLength 400000
*/
contentText?: string | null;
/** Date the post was first published. */
firstPublishedDate?: Date | null;
/**
* Date the post was last published.
* @readonly
*/
lastPublishedDate?: Date | null;
/** Post URL. */
url?: string;
/**
* Post slug. For example, `'post-slug'`.
* @maxLength 100
*/
slug?: string;
/** Whether the post is marked as featured. */
featured?: boolean;
/** Whether the post is pinned. If `true`, the post is placed at the top of the post list. */
pinned?: boolean;
/**
* Category IDs of the post. See Blog Category API for more info.
* @maxSize 10
* @format GUID
*/
categoryIds?: string[];
/**
* Member ID of the post's owner.
* @format GUID
*/
memberId?: string;
/**
* Hashtags in the post.
* @readonly
* @maxSize 100
* @maxLength 100
*/
hashtags?: string[];
/** Whether commenting on the post is enabled. */
commentingEnabled?: boolean;
/** Estimated reading time (calculated automatically). */
minutesToRead?: number;
/** Image placed at the top of the blog page. Only displays on mobile devices. */
heroImage?: string;
/**
* IDs of tags the post is tagged with. See Blog Tags API for more info.
* @readonly
* @maxSize 30
* @format GUID
*/
tagIds?: string[];
/**
* IDs of posts related to the post.
* @readonly
* @maxSize 3
* @format GUID
*/
relatedPostIds?: string[];
/**
* Pricing plan IDs. See the Pricing Plans API for more info.
*
* Only relevant if a post is assigned to a specific pricing plan.
* @readonly
* @maxSize 100
* @format GUID
*/
pricingPlanIds?: string[];
/**
* ID of the translations of this post. All translations of a single post share the same `translationId`.
* @format GUID
*/
translationId?: string | null;
/**
* Language the post is written in.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* @format LANGUAGE_TAG
*/
language?: string | null;
/** SEO data. */
seoData?: SeoSchema;
/**
* Contact ID of the post's owner. See the Contacts API for more info.
* @format GUID
*/
contactId?: string | null;
/**
* Post rich content
*
*
* See Ricos document reference
*
* @readonly
*/
richContent?: RichContent;
/**
* Whether the returned content is a preview of premium content. Defaults to `false`.
* A preview displays a limited number of paragraphs of paid content to non-subscribed users.
* @readonly
*/
preview?: boolean;
/**
* Post moderation details. Only relevant to posts submitted by [guest writers](https://support.wix.com/en/article/wix-blog-moderating-blog-posts-from-your-guest-writers).
*
* Guest writers have the ability to write posts but not publish them. These posts can be rejected or approved for publishing by a blog editor or Wix user.
* @readonly
*/
moderationDetails?: ModerationDetails;
/** Post cover media. */
media?: Media;
/**
* Indicates if there is a draft post with changes that have not yet been published.
* @readonly
*/
hasUnpublishedChanges?: boolean;
/**
* Post reference ID. You can reference the post from other entities, for example, comments.
* @readonly
* @maxLength 24
*/
referenceId?: string | null;
}
interface PostCountInfo {
/**
* Total number of post comments.
* @readonly
*/
comments?: number;
/**
* Total number of post likes.
* @readonly
*/
likes?: number;
/**
* Total number of post views.
* @readonly
*/
views?: number;
}
interface FocalPoint {
/** X-coordinate of the focal point. */
x?: number;
/** Y-coordinate of the focal point. */
y?: number;
/** crop by height */
height?: number | null;
/** crop by width */
width?: number | null;
}
interface Metrics {
/**
* Total number of post comments.
* @readonly
*/
comments?: number;
/**
* Total number of post likes.
* @readonly
*/
likes?: number;
/**
* Total number of post views.
* @readonly
*/
views?: number;
}
/**
* 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 section of the HTML document, while not being displayed on the page itself.
*/
interface SeoSchema {
/** SEO tag information. */
tags?: Tag[];
/** SEO general settings. */
settings?: Settings;
}
interface Keyword {
/** Keyword value. */
term?: string;
/** Whether the keyword is the main focus keyword. */
isMain?: boolean;
/**
* The source that added the keyword terms to the SEO settings.
* @maxLength 1000
*/
origin?: string | null;
}
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 | null;
/** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
meta?: Record | null;
/** SEO tag inner content. For example, ` inner content `. */
children?: string;
/** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
custom?: boolean;
/** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
disabled?: boolean;
}
interface Settings {
/**
* Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
*
*
* Default: `false` (automatical redirect is enabled).
*/
preventAutoRedirect?: boolean;
/**
* User-selected keyword terms for a specific page.
* @maxSize 5
*/
keywords?: Keyword[];
}
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;
}
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;
/** @deprecated */
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 custom external node. */
externalData?: Record | 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;
/** Data for a caption node. */
captionData?: CaptionData;
/** Data for a layout node. Reserved for future use. */
layoutData?: LayoutData;
/** Data for a cell node. */
layoutCellData?: LayoutCellData;
/** Data for a shape node. */
shapeData?: ShapeData;
/** Data for a card node. */
cardData?: CardData;
/** Data for a table of contents node. */
tocData?: TocData;
/** Data for a smart block node. */
smartBlockData?: SmartBlockData;
/** Data for a smart block cell node. */
smartBlockCellData?: SmartBlockCellData;
/** 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?: NodeTypeWithLiterals;
/** Node ID. */
id?: string;
/** A list of child nodes. */
nodes?: Node[];
/** Padding and background color styling for the node. */
style?: NodeStyle;
}
/** @oneof */
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;
/** @deprecated */
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 custom external node. */
externalData?: Record | 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;
/** Data for a caption node. */
captionData?: CaptionData;
/** Data for a layout node. Reserved for future use. */
layoutData?: LayoutData;
/** Data for a cell node. */
layoutCellData?: LayoutCellData;
/** Data for a shape node. */
shapeData?: ShapeData;
/** Data for a card node. */
cardData?: CardData;
/** Data for a table of contents node. */
tocData?: TocData;
/** Data for a smart block node. */
smartBlockData?: SmartBlockData;
/** Data for a smart block cell node. */
smartBlockCellData?: SmartBlockCellData;
}
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",
/** @deprecated */
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",
CAPTION = "CAPTION",
LAYOUT = "LAYOUT",
LAYOUT_CELL = "LAYOUT_CELL",
SHAPE = "SHAPE",
CARD = "CARD",
TOC = "TOC",
SMART_BLOCK = "SMART_BLOCK",
SMART_BLOCK_CELL = "SMART_BLOCK_CELL"
}
/** @enumType */
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL' | 'SHAPE' | 'CARD' | 'TOC' | 'SMART_BLOCK' | 'SMART_BLOCK_CELL';
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;
}
interface ButtonData {
/** Styling for the button's container. */
containerData?: PluginContainerData;
/** The button type. */
type?: ButtonDataTypeWithLiterals;
/** Styling for the button. */
styles?: Styles;
/** The text to display on the button. */
text?: string | null;
/** Button link details. */
link?: Link;
}
/** Background type */
declare enum BackgroundType {
/** Solid color background */
COLOR = "COLOR",
/** Gradient background */
GRADIENT = "GRADIENT"
}
/** @enumType */
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'GRADIENT';
interface Gradient {
/** Gradient type. */
type?: GradientTypeWithLiterals;
/**
* Color stops for the gradient.
* @maxSize 1000
*/
stops?: Stop[];
/** Angle in degrees for linear gradient (0-360). */
angle?: number | null;
/**
* Horizontal center position for radial gradient (0-100).
* @max 100
*/
centerX?: number | null;
/**
* Vertical center position for radial gradient (0-100).
* @max 100
*/
centerY?: number | null;
}
/** Gradient type. */
declare enum GradientType {
/** Linear gradient. */
LINEAR = "LINEAR",
/** Radial gradient. */
RADIAL = "RADIAL"
}
/** @enumType */
type GradientTypeWithLiterals = GradientType | 'LINEAR' | 'RADIAL';
/** A single color stop in the gradient. */
interface Stop {
/**
* Stop color as hex value.
* @maxLength 19
*/
color?: string | null;
/** Stop position (0-1). */
position?: number | null;
}
interface Border {
/**
* Deprecated: Use `borderWidth` in `styles` instead.
* @deprecated
*/
width?: number | null;
/**
* Deprecated: Use `borderRadius` in `styles` instead.
* @deprecated
*/
radius?: number | null;
}
interface Colors {
/**
* Deprecated: Use `textColor` in `styles` instead.
* @deprecated
*/
text?: string | null;
/**
* Deprecated: Use `borderColor` in `styles` instead.
* @deprecated
*/
border?: string | null;
/**
* Deprecated: Use `backgroundColor` in `styles` instead.
* @deprecated
*/
background?: string | null;
}
/** Background styling (color or gradient) */
interface Background {
/** Background type. */
type?: BackgroundTypeWithLiterals;
/**
* Background color as a hexadecimal value.
* @maxLength 19
*/
color?: string | null;
/** Gradient configuration. */
gradient?: Gradient;
}
interface PluginContainerData {
/** The width of the node when it's displayed. */
width?: PluginContainerDataWidth;
/** The node's alignment within its container. */
alignment?: PluginContainerDataAlignmentWithLiterals;
/** 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. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
textWrap?: boolean | null;
}
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"
}
/** @enumType */
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
/**
* One of the following predefined width options:
* `CONTENT`: The width of the container matches the content width.
* `SMALL`: A small width.
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
*/
size?: WidthTypeWithLiterals;
/** A custom width value in pixels. */
custom?: string | null;
}
/** @oneof */
interface PluginContainerDataWidthDataOneOf {
/**
* One of the following predefined width options:
* `CONTENT`: The width of the container matches the content width.
* `SMALL`: A small width.
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
*/
size?: WidthTypeWithLiterals;
/** A custom width value in pixels. */
custom?: string | null;
}
declare enum PluginContainerDataAlignment {
/** Center Alignment */
CENTER = "CENTER",
/** Left Alignment */
LEFT = "LEFT",
/** Right Alignment */
RIGHT = "RIGHT"
}
/** @enumType */
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
interface Spoiler {
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
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;
}
interface Height {
/** A custom height value in pixels. */
custom?: string | null;
}
declare enum ButtonDataType {
/** Regular link button */
LINK = "LINK",
/** Triggers custom action that is defined in plugin configuration by the consumer */
ACTION = "ACTION"
}
/** @enumType */
type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
interface Styles {
/**
* Deprecated: Use `borderWidth` and `borderRadius` instead.
* @deprecated
*/
border?: Border;
/**
* Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
* @deprecated
*/
colors?: Colors;
/** Border width in pixels. */
borderWidth?: number | null;
/**
* Deprecated: Use `borderWidth` for normal/hover states instead.
* @deprecated
*/
borderWidthHover?: number | null;
/** Border radius in pixels. */
borderRadius?: number | null;
/**
* Border color as a hexadecimal value.
* @maxLength 19
*/
borderColor?: string | null;
/**
* Border color as a hexadecimal value (hover state).
* @maxLength 19
*/
borderColorHover?: string | null;
/**
* Text color as a hexadecimal value.
* @maxLength 19
*/
textColor?: string | null;
/**
* Text color as a hexadecimal value (hover state).
* @maxLength 19
*/
textColorHover?: string | null;
/**
* Deprecated: Use `background` instead.
* @maxLength 19
* @deprecated
*/
backgroundColor?: string | null;
/**
* Deprecated: Use `backgroundHover` instead.
* @maxLength 19
* @deprecated
*/
backgroundColorHover?: string | null;
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
buttonSize?: string | null;
/** Background styling (color or gradient). */
background?: Background;
/** Background styling for hover state (color or gradient). */
backgroundHover?: Background;
}
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?: TargetWithLiterals;
/** 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 */
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;
}
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"
}
/** @enumType */
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
interface Rel {
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
nofollow?: boolean | null;
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
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. Defaults to `false`. */
ugc?: boolean | null;
/** Indicates that this link protect referral information from being passed to the target website. */
noreferrer?: boolean | null;
}
interface CodeBlockData {
/** Styling for the code block's text. */
textStyle?: TextStyle;
}
interface TextStyle {
/** Text alignment. Defaults to `AUTO`. */
textAlignment?: TextAlignmentWithLiterals;
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
lineHeight?: string | null;
}
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"
}
/** @enumType */
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
interface DividerData {
/** Styling for the divider's container. */
containerData?: PluginContainerData;
/** Divider line style. */
lineStyle?: LineStyleWithLiterals;
/** Divider width. */
width?: WidthWithLiterals;
/** Divider alignment. */
alignment?: DividerDataAlignmentWithLiterals;
}
declare enum LineStyle {
/** Single Line */
SINGLE = "SINGLE",
/** Double Line */
DOUBLE = "DOUBLE",
/** Dashed Line */
DASHED = "DASHED",
/** Dotted Line */
DOTTED = "DOTTED"
}
/** @enumType */
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
declare enum Width {
/** Large line */
LARGE = "LARGE",
/** Medium line */
MEDIUM = "MEDIUM",
/** Small line */
SMALL = "SMALL"
}
/** @enumType */
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
declare enum DividerDataAlignment {
/** Center alignment */
CENTER = "CENTER",
/** Left alignment */
LEFT = "LEFT",
/** Right alignment */
RIGHT = "RIGHT"
}
/** @enumType */
type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
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;
/**
* Use `sizeInKb` instead.
* @deprecated
*/
size?: number | null;
/** Settings for PDF files. */
pdfSettings?: PDFSettings;
/** File MIME type. */
mimeType?: string | null;
/** File path. */
path?: string | null;
/** File size in KB. */
sizeInKb?: string | null;
}
declare enum ViewMode {
/** No PDF view */
NONE = "NONE",
/** Full PDF view */
FULL = "FULL",
/** Mini PDF view */
MINI = "MINI"
}
/** @enumType */
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
interface FileSource extends FileSourceDataOneOf {
/** The absolute URL for the file's source. */
url?: string | null;
/**
* Custom ID. Use `id` instead.
* @deprecated
*/
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. Defaults to `false`. */
private?: boolean | null;
}
/** @oneof */
interface FileSourceDataOneOf {
/** The absolute URL for the file's source. */
url?: string | null;
/**
* Custom ID. Use `id` instead.
* @deprecated
*/
custom?: string | null;
/** An ID that's resolved to a URL by a resolver function. */
id?: string | null;
}
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?: ViewModeWithLiterals;
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
disableDownload?: boolean | null;
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
disablePrint?: boolean | null;
}
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. Defaults to `false`. */
disableExpand?: boolean | null;
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
disableDownload?: boolean | null;
}
interface V1Media {
/** 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;
}
interface Image {
/** Image file details. */
media?: V1Media;
/** Link details for images that are links. */
link?: Link;
}
interface Video {
/** Video file details. */
media?: V1Media;
/** Video thumbnail file details. */
thumbnail?: V1Media;
}
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 */
interface ItemDataOneOf {
/** An image item. */
image?: Image;
/** A video item. */
video?: Video;
}
interface GalleryOptions {
/** Gallery layout. */
layout?: GalleryOptionsLayout;
/** Styling for gallery items. */
item?: ItemStyle;
/** Styling for gallery thumbnail images. */
thumbnails?: Thumbnails;
}
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"
}
/** @enumType */
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
declare enum Orientation {
/** Rows Orientation */
ROWS = "ROWS",
/** Columns Orientation */
COLUMNS = "COLUMNS"
}
/** @enumType */
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
declare enum Crop {
/** Crop to fill */
FILL = "FILL",
/** Crop to fit */
FIT = "FIT"
}
/** @enumType */
type CropWithLiterals = Crop | 'FILL' | 'FIT';
declare enum ThumbnailsAlignment {
/** Top alignment */
TOP = "TOP",
/** Right alignment */
RIGHT = "RIGHT",
/** Bottom alignment */
BOTTOM = "BOTTOM",
/** Left alignment */
LEFT = "LEFT",
/** No thumbnail */
NONE = "NONE"
}
/** @enumType */
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
interface GalleryOptionsLayout {
/** Gallery layout type. */
type?: LayoutTypeWithLiterals;
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
horizontalScroll?: boolean | null;
/** Gallery orientation. */
orientation?: OrientationWithLiterals;
/** 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;
}
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?: CropWithLiterals;
/** The spacing between items in pixels. */
spacing?: number | null;
}
interface Thumbnails {
/** Thumbnail alignment. */
placement?: ThumbnailsAlignmentWithLiterals;
/** Spacing between thumbnails in pixels. */
spacing?: number | null;
}
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;
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
gifType?: GIFTypeWithLiterals;
}
interface GIF {
/**
* GIF format URL.
* @format WEB_URL
*/
gif?: string | null;
/**
* MP4 format URL.
* @format WEB_URL
*/
mp4?: string | null;
/**
* Thumbnail URL.
* @format WEB_URL
*/
still?: string | null;
}
declare enum GIFType {
NORMAL = "NORMAL",
STICKER = "STICKER"
}
/** @enumType */
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
interface HeadingData {
/** Heading level from 1-6. */
level?: number;
/** Styling for the heading text. */
textStyle?: TextStyle;
/** Indentation level from 1-4. */
indentation?: number | null;
/** Rendered heading level for SEO/accessibility, overrides the HTML tag when set. */
renderedLevel?: number | null;
}
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.
* @deprecated
*/
isAdsense?: boolean | null;
/** The WixelWidget ID for AI_WIDGET source nodes. */
widgetId?: string;
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
containerData?: PluginContainerData;
/** The type of HTML code. */
source?: SourceWithLiterals;
/** If container height is aligned with its content height. Defaults to `true`. */
autoHeight?: boolean | null;
}
/** @oneof */
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.
* @deprecated
*/
isAdsense?: boolean | null;
/** The WixelWidget ID for AI_WIDGET source nodes. */
widgetId?: string;
}
declare enum Source {
HTML = "HTML",
ADSENSE = "ADSENSE",
AI = "AI",
AI_WIDGET = "AI_WIDGET"
}
/** @enumType */
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE' | 'AI' | 'AI_WIDGET';
interface ImageData {
/** Styling for the image's container. */
containerData?: PluginContainerData;
/** Image file details. */
image?: V1Media;
/** Link details for images that are links. */
link?: Link;
/** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
disableExpand?: boolean | null;
/** Image's alternative text. */
altText?: string | null;
/**
* Deprecated: use Caption node instead.
* @deprecated
*/
caption?: string | null;
/** Sets whether the image's download button is disabled. Defaults to `false`. */
disableDownload?: boolean | null;
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
decorative?: boolean | null;
/** Styling for the image. */
styles?: ImageDataStyles;
}
interface StylesBorder {
/** Border width in pixels. */
width?: number | null;
/**
* Border color as a hexadecimal value.
* @maxLength 19
*/
color?: string | null;
/** Border radius in pixels. */
radius?: number | null;
}
interface ImageDataStyles {
/** Border attributes. */
border?: StylesBorder;
}
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;
/** Styling for the link preview. */
styles?: LinkPreviewDataStyles;
}
declare enum StylesPosition {
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
START = "START",
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
END = "END",
/** Thumbnail positioned at the top */
TOP = "TOP",
/** Thumbnail hidden and not displayed */
HIDDEN = "HIDDEN"
}
/** @enumType */
type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
interface LinkPreviewDataStyles {
/**
* Background color as a hexadecimal value.
* @maxLength 19
*/
backgroundColor?: string | null;
/**
* Title color as a hexadecimal value.
* @maxLength 19
*/
titleColor?: string | null;
/**
* Subtitle color as a hexadecimal value.
* @maxLength 19
*/
subtitleColor?: string | null;
/**
* Link color as a hexadecimal value.
* @maxLength 19
*/
linkColor?: string | null;
/** Border width in pixels. */
borderWidth?: number | null;
/** Border radius in pixels. */
borderRadius?: number | null;
/**
* Border color as a hexadecimal value.
* @maxLength 19
*/
borderColor?: string | null;
/** Position of thumbnail. Defaults to `START`. */
thumbnailPosition?: StylesPositionWithLiterals;
}
interface MapData {
/** Styling for the map's container. */
containerData?: PluginContainerData;
/** Map settings. */
mapSettings?: MapSettings;
}
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?: MapTypeWithLiterals;
}
declare enum MapType {
/** Roadmap map type */
ROADMAP = "ROADMAP",
/** Satellite map type */
SATELITE = "SATELITE",
/** Hybrid map type */
HYBRID = "HYBRID",
/** Terrain map type */
TERRAIN = "TERRAIN"
}
/** @enumType */
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
interface ParagraphData {
/** Styling for the paragraph text. */
textStyle?: TextStyle;
/** Indentation level from 1-4. */
indentation?: number | null;
/** Paragraph level */
level?: number | null;
}
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;
}
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"
}
/** @enumType */
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
declare enum VoteRole {
/** Logged in member */
SITE_MEMBERS = "SITE_MEMBERS",
/** Anyone */
ALL = "ALL"
}
/** @enumType */
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
interface Permissions {
/** Sets who can view the poll results. */
view?: ViewRoleWithLiterals;
/** Sets who can vote. */
vote?: VoteRoleWithLiterals;
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
allowMultipleVotes?: boolean | null;
}
interface Option {
/** Option ID. */
id?: string | null;
/** Option title. */
title?: string | null;
/** The image displayed with the option. */
image?: V1Media;
}
interface PollSettings {
/** Permissions settings for voting. */
permissions?: Permissions;
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
showVoters?: boolean | null;
/** Sets whether the vote count is displayed. Defaults to `true`. */
showVotesCount?: boolean | null;
}
declare enum PollLayoutType {
/** List */
LIST = "LIST",
/** Grid */
GRID = "GRID"
}
/** @enumType */
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
declare enum PollLayoutDirection {
/** Left-to-right */
LTR = "LTR",
/** Right-to-left */
RTL = "RTL"
}
/** @enumType */
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
interface PollLayout {
/** The layout for displaying the voting options. */
type?: PollLayoutTypeWithLiterals;
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
direction?: PollLayoutDirectionWithLiterals;
/** Sets whether to display the main poll image. Defaults to `false`. */
enableImage?: boolean | null;
}
interface OptionLayout {
/** Sets whether to display option images. Defaults to `false`. */
enableImage?: boolean | null;
}
declare enum PollDesignBackgroundType {
/** Color background type */
COLOR = "COLOR",
/** Image background type */
IMAGE = "IMAGE",
/** Gradiant background type */
GRADIENT = "GRADIENT"
}
/** @enumType */
type PollDesignBackgroundTypeWithLiterals = PollDesignBackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
interface BackgroundGradient {
/** The gradient angle in degrees. */
angle?: number | null;
/**
* The start color as a hexademical value.
* @maxLength 19
*/
startColor?: string | null;
/**
* The end color as a hexademical value.
* @maxLength 19
*/
lastColor?: string | null;
}
interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
/**
* The background color as a hexademical value.
* @maxLength 19
*/
color?: string | null;
/** An image to use for the background. */
image?: V1Media;
/** Details for a gradient background. */
gradient?: BackgroundGradient;
/** Background type. For each option, include the relevant details. */
type?: PollDesignBackgroundTypeWithLiterals;
}
/** @oneof */
interface PollDesignBackgroundBackgroundOneOf {
/**
* The background color as a hexademical value.
* @maxLength 19
*/
color?: string | null;
/** An image to use for the background. */
image?: V1Media;
/** Details for a gradient background. */
gradient?: BackgroundGradient;
}
interface PollDesign {
/** Background styling. */
background?: PollDesignBackground;
/** Border radius in pixels. */
borderRadius?: number | null;
}
interface OptionDesign {
/** Border radius in pixels. */
borderRadius?: number | null;
}
interface Poll {
/** Poll ID. */
id?: string | null;
/** Poll title. */
title?: string | null;
/** Poll creator ID. */
creatorId?: string | null;
/** Main poll image. */
image?: V1Media;
/** Voting options. */
options?: Option[];
/** The poll's permissions and display settings. */
settings?: PollSettings;
}
interface PollDataLayout {
/** Poll layout settings. */
poll?: PollLayout;
/** Voting otpions layout settings. */
options?: OptionLayout;
}
interface Design {
/** Styling for the poll. */
poll?: PollDesign;
/** Styling for voting options. */
options?: OptionDesign;
}
interface TextData {
/** The text to apply decorations to. */
text?: string;
/** The decorations to apply. */
decorations?: Decoration[];
}
/** Adds appearence changes to text */
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. Defaults to `true`. */
italicData?: boolean | null;
/** Data for an underline decoration. Defaults to `true`. */
underlineData?: boolean | null;
/** Data for a spoiler decoration. */
spoilerData?: SpoilerData;
/** Data for a strikethrough decoration. Defaults to `true`. */
strikethroughData?: boolean | null;
/** Data for a superscript decoration. Defaults to `true`. */
superscriptData?: boolean | null;
/** Data for a subscript decoration. Defaults to `true`. */
subscriptData?: boolean | null;
/** Data for a font family decoration. */
fontFamilyData?: FontFamilyData;
/** The type of decoration to apply. */
type?: DecorationTypeWithLiterals;
}
/** @oneof */
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. Defaults to `true`. */
italicData?: boolean | null;
/** Data for an underline decoration. Defaults to `true`. */
underlineData?: boolean | null;
/** Data for a spoiler decoration. */
spoilerData?: SpoilerData;
/** Data for a strikethrough decoration. Defaults to `true`. */
strikethroughData?: boolean | null;
/** Data for a superscript decoration. Defaults to `true`. */
superscriptData?: boolean | null;
/** Data for a subscript decoration. Defaults to `true`. */
subscriptData?: boolean | null;
/** Data for a font family decoration. */
fontFamilyData?: FontFamilyData;
}
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",
STRIKETHROUGH = "STRIKETHROUGH",
SUPERSCRIPT = "SUPERSCRIPT",
SUBSCRIPT = "SUBSCRIPT",
FONT_FAMILY = "FONT_FAMILY"
}
/** @enumType */
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT' | 'FONT_FAMILY';
interface AnchorData {
/** The target node's ID. */
anchor?: string;
}
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;
}
interface LinkData {
/** Link details. */
link?: Link;
}
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;
}
interface FontSizeData {
/** The units used for the font size. */
unit?: FontTypeWithLiterals;
/** Font size value. */
value?: number | null;
}
declare enum FontType {
PX = "PX",
EM = "EM"
}
/** @enumType */
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
interface SpoilerData {
/** Spoiler ID. */
id?: string | null;
}
interface FontFamilyData {
/** @maxLength 1000 */
value?: string | null;
}
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?: AppTypeWithLiterals;
/** The ID of the embedded content. */
itemId?: string | null;
/** The name of the embedded content. */
name?: string | null;
/**
* Deprecated: Use `image` instead.
* @deprecated
*/
imageSrc?: string | null;
/** The URL for the embedded content. */
url?: string | null;
/** An image for the embedded content. */
image?: V1Media;
/** Whether to hide the image. */
hideImage?: boolean | null;
/** Whether to hide the title. */
hideTitle?: boolean | null;
/** Whether to hide the price. */
hidePrice?: boolean | null;
/** Whether to hide the description (Event and Booking). */
hideDescription?: boolean | null;
/** Whether to hide the date and time (Event). */
hideDateTime?: boolean | null;
/** Whether to hide the location (Event). */
hideLocation?: boolean | null;
/** Whether to hide the duration (Booking). */
hideDuration?: boolean | null;
/** Whether to hide the button. */
hideButton?: boolean | null;
/** Whether to hide the ribbon. */
hideRibbon?: boolean | null;
/** Button styling options. */
buttonStyles?: ButtonStyles;
/** Image styling options. */
imageStyles?: ImageStyles;
/** Ribbon styling options. */
ribbonStyles?: RibbonStyles;
/** Card styling options. */
cardStyles?: CardStyles;
/** Styling for the app embed's container. */
containerData?: PluginContainerData;
/** Pricing data for embedded Wix App content. */
pricingData?: PricingData;
}
/** @oneof */
interface AppEmbedDataAppDataOneOf {
/** Data for embedded Wix Bookings content. */
bookingData?: BookingData;
/** Data for embedded Wix Events content. */
eventData?: EventData;
}
declare enum Position {
/** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
START = "START",
/** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
END = "END",
/** Image positioned at the top */
TOP = "TOP"
}
/** @enumType */
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
declare enum AspectRatio {
/** 1:1 aspect ratio */
SQUARE = "SQUARE",
/** 16:9 aspect ratio */
RECTANGLE = "RECTANGLE"
}
/** @enumType */
type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
declare enum Resizing {
/** Fill the container, may crop the image */
FILL = "FILL",
/** Fit the image within the container */
FIT = "FIT"
}
/** @enumType */
type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
declare enum Placement {
/** Ribbon placed on the image */
IMAGE = "IMAGE",
/** Ribbon placed on the product information */
PRODUCT_INFO = "PRODUCT_INFO"
}
/** @enumType */
type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
declare enum Type {
/** Card with visible border and background */
CONTAINED = "CONTAINED",
/** Card without visible border */
FRAMELESS = "FRAMELESS"
}
/** @enumType */
type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
declare enum Alignment {
/** Content aligned to start (left in LTR layouts, right in RTL layouts) */
START = "START",
/** Content centered */
CENTER = "CENTER",
/** Content aligned to end (right in LTR layouts, left in RTL layouts) */
END = "END"
}
/** @enumType */
type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
declare enum Layout {
/** Elements stacked vertically */
STACKED = "STACKED",
/** Elements arranged horizontally */
SIDE_BY_SIDE = "SIDE_BY_SIDE"
}
/** @enumType */
type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
declare enum AppType {
PRODUCT = "PRODUCT",
EVENT = "EVENT",
BOOKING = "BOOKING"
}
/** @enumType */
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
interface BookingData {
/** Booking duration in minutes. */
durations?: string | null;
}
interface EventData {
/** Event schedule. */
scheduling?: string | null;
/** Event location. */
location?: string | null;
}
interface ButtonStyles {
/** Text to display on the button. */
buttonText?: string | null;
/** Border width in pixels. */
borderWidth?: number | null;
/** Border radius in pixels. */
borderRadius?: number | null;
/**
* Border color as a hexadecimal value.
* @maxLength 19
*/
borderColor?: string | null;
/**
* Text color as a hexadecimal value.
* @maxLength 19
*/
textColor?: string | null;
/**
* Background color as a hexadecimal value.
* @maxLength 19
*/
backgroundColor?: string | null;
/**
* Border color as a hexadecimal value (hover state).
* @maxLength 19
*/
borderColorHover?: string | null;
/**
* Text color as a hexadecimal value (hover state).
* @maxLength 19
*/
textColorHover?: string | null;
/**
* Background color as a hexadecimal value (hover state).
* @maxLength 19
*/
backgroundColorHover?: string | null;
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
buttonSize?: string | null;
}
interface ImageStyles {
/** Whether to hide the image. */
hideImage?: boolean | null;
/** Position of image. Defaults to `START`. */
imagePosition?: PositionWithLiterals;
/** Aspect ratio for the image. Defaults to `SQUARE`. */
aspectRatio?: AspectRatioWithLiterals;
/** How the image should be resized. Defaults to `FILL`. */
resizing?: ResizingWithLiterals;
/**
* Image border color as a hexadecimal value.
* @maxLength 19
*/
borderColor?: string | null;
/** Image border width in pixels. */
borderWidth?: number | null;
/** Image border radius in pixels. */
borderRadius?: number | null;
}
interface RibbonStyles {
/** Text to display on the ribbon. */
ribbonText?: string | null;
/**
* Ribbon background color as a hexadecimal value.
* @maxLength 19
*/
backgroundColor?: string | null;
/**
* Ribbon text color as a hexadecimal value.
* @maxLength 19
*/
textColor?: string | null;
/**
* Ribbon border color as a hexadecimal value.
* @maxLength 19
*/
borderColor?: string | null;
/** Ribbon border width in pixels. */
borderWidth?: number | null;
/** Ribbon border radius in pixels. */
borderRadius?: number | null;
/** Placement of the ribbon. Defaults to `IMAGE`. */
ribbonPlacement?: PlacementWithLiterals;
}
interface CardStyles {
/**
* Card background color as a hexadecimal value.
* @maxLength 19
*/
backgroundColor?: string | null;
/**
* Card border color as a hexadecimal value.
* @maxLength 19
*/
borderColor?: string | null;
/** Card border width in pixels. */
borderWidth?: number | null;
/** Card border radius in pixels. */
borderRadius?: number | null;
/** Card type. Defaults to `CONTAINED`. */
type?: TypeWithLiterals;
/** Content alignment. Defaults to `START`. */
alignment?: AlignmentWithLiterals;
/** Layout for title and price. Defaults to `STACKED`. */
titlePriceLayout?: LayoutWithLiterals;
/**
* Title text color as a hexadecimal value.
* @maxLength 19
*/
titleColor?: string | null;
/**
* Text color as a hexadecimal value.
* @maxLength 19
*/
textColor?: string | null;
}
interface PricingData {
/**
* Minimum numeric price value as string (e.g., "10.99").
* @decimalValue options { maxScale:2 }
*/
valueFrom?: string | null;
/**
* Maximum numeric price value as string (e.g., "19.99").
* @decimalValue options { maxScale:2 }
*/
valueTo?: string | null;
/**
* Numeric price value as string after discount application (e.g., "15.99").
* @decimalValue options { maxScale:2 }
*/
discountedValue?: string | null;
/**
* Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
* @format CURRENCY
*/
currency?: string | null;
/**
* Pricing plan ID.
* @format GUID
*/
pricingPlanId?: string | null;
}
interface VideoData {
/** Styling for the video's container. */
containerData?: PluginContainerData;
/** Video details. */
video?: V1Media;
/** Video thumbnail details. */
thumbnail?: V1Media;
/** Sets whether the video's download button is disabled. Defaults to `false`. */
disableDownload?: boolean | null;
/** Video title. */
title?: string | null;
/** Video options. */
options?: PlaybackOptions;
}
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;
}
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;
}
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;
}
interface CollapsibleListData {
/** Styling for the collapsible list's container. */
containerData?: PluginContainerData;
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
expandOnlyOne?: boolean | null;
/** Sets which items are expanded when the page loads. */
initialExpandedItems?: InitialExpandedItemsWithLiterals;
/** The direction of the text in the list. Either left-to-right or right-to-left. */
direction?: DirectionWithLiterals;
/** If `true`, The collapsible item will appear in search results as an FAQ. */
isQapageData?: boolean | null;
}
declare enum InitialExpandedItems {
/** First item will be expended initally */
FIRST = "FIRST",
/** All items will expended initally */
ALL = "ALL",
/** All items collapsed initally */
NONE = "NONE"
}
/** @enumType */
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
declare enum Direction {
/** Left-to-right */
LTR = "LTR",
/** Right-to-left */
RTL = "RTL"
}
/** @enumType */
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
interface TableData {
/** Styling for the table's container. */
containerData?: PluginContainerData;
/** The table's dimensions. */
dimensions?: Dimensions;
/**
* Deprecated: Use `rowHeader` and `columnHeader` instead.
* @deprecated
*/
header?: boolean | null;
/** Sets whether the table's first row is a header. Defaults to `false`. */
rowHeader?: boolean | null;
/** Sets whether the table's first column is a header. Defaults to `false`. */
columnHeader?: boolean | null;
/** The spacing between cells in pixels. Defaults to `0`. */
cellSpacing?: number | null;
/**
* Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
* @maxSize 4
*/
cellPadding?: number[];
/** Table's alternative text. */
altText?: string | null;
}
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[];
}
interface TableCellData {
/** Styling for the cell's background color and text alignment. */
cellStyle?: CellStyle;
/** The cell's border colors. */
borderColors?: BorderColors;
/** Defines how many columns the cell spans. Default: 1. */
colspan?: number | null;
/** Defines how many rows the cell spans. Default: 1. */
rowspan?: number | null;
/** The cell's border widths. */
borderWidths?: BorderWidths;
}
declare enum VerticalAlignment {
/** Top alignment */
TOP = "TOP",
/** Middle alignment */
MIDDLE = "MIDDLE",
/** Bottom alignment */
BOTTOM = "BOTTOM"
}
/** @enumType */
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
interface CellStyle {
/** Vertical alignment for the cell's text. */
verticalAlignment?: VerticalAlignmentWithLiterals;
/**
* Cell background color as a hexadecimal value.
* @maxLength 19
*/
backgroundColor?: string | null;
}
interface BorderColors {
/**
* Left border color as a hexadecimal value.
* @maxLength 19
*/
left?: string | null;
/**
* Right border color as a hexadecimal value.
* @maxLength 19
*/
right?: string | null;
/**
* Top border color as a hexadecimal value.
* @maxLength 19
*/
top?: string | null;
/**
* Bottom border color as a hexadecimal value.
* @maxLength 19
*/
bottom?: string | null;
}
interface BorderWidths {
/** Left border width in pixels. */
left?: number | null;
/** Right border width in pixels. */
right?: number | null;
/** Top border width in pixels. */
top?: number | null;
/** Bottom border width in pixels. */
bottom?: number | null;
}
/**
* `NullValue` is a singleton enumeration to represent the null value for the
* `Value` type union.
*
* The JSON representation for `NullValue` is JSON `null`.
*/
declare enum NullValue {
/** Null value. */
NULL_VALUE = "NULL_VALUE"
}
/** @enumType */
type NullValueWithLiterals = NullValue | 'NULL_VALUE';
/**
* `ListValue` is a wrapper around a repeated field of values.
*
* The JSON representation for `ListValue` is JSON array.
*/
interface ListValue {
/** Repeated field of dynamically typed values. */
values?: any[];
}
interface AudioData {
/** Styling for the audio node's container. */
containerData?: PluginContainerData;
/** Audio file details. */
audio?: V1Media;
/** Sets whether the audio node's download button is disabled. Defaults to `false`. */
disableDownload?: boolean | null;
/** Cover image. */
coverImage?: V1Media;
/** Track name. */
name?: string | null;
/** Author name. */
authorName?: string | null;
/** An HTML version of the audio node. */
html?: string | null;
}
interface OrderedListData {
/** Indentation level from 0-4. */
indentation?: number;
/** Offset level from 0-4. */
offset?: number | null;
/** List start number. */
start?: number | null;
}
interface BulletedListData {
/** Indentation level from 0-4. */
indentation?: number;
/** Offset level from 0-4. */
offset?: number | null;
}
interface BlockquoteData {
/** Indentation level from 1-4. */
indentation?: number;
}
interface CaptionData {
textStyle?: TextStyle;
}
interface LayoutData {
/**
* Deprecated: Use `background` instead.
* @maxLength 19
* @deprecated
*/
backgroundColor?: string | null;
/** Background image. */
backgroundImage?: LayoutDataBackgroundImage;
/**
* Border color as a hexadecimal value.
* @maxLength 19
*/
borderColor?: string | null;
/** Border width in pixels. */
borderWidth?: number | null;
/** Border radius in pixels. */
borderRadius?: number | null;
/**
* Deprecated: Use `backdrop` instead.
* @maxLength 19
* @deprecated
*/
backdropColor?: string | null;
/** Backdrop image. */
backdropImage?: LayoutDataBackgroundImage;
/** Backdrop top padding. */
backdropPaddingTop?: number | null;
/** Backdrop bottom padding */
backdropPaddingBottom?: number | null;
/** Horizontal and vertical gap between columns */
gap?: number | null;
/**
* Padding in pixels for cells. Follows CSS order: top, right, bottom, left
* @maxSize 4
*/
cellPadding?: number[];
/** Vertical alignment for the cell's items. */
cellVerticalAlignment?: VerticalAlignmentAlignmentWithLiterals;
/** Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers. */
responsivenessBehaviour?: ResponsivenessBehaviourWithLiterals;
/** Size in pixels when responsiveness_behaviour applies */
responsivenessBreakpoint?: number | null;
/** Styling for the layout's container. */
containerData?: PluginContainerData;
/** Defines where selected design propertied applies to */
designTarget?: DesignTargetWithLiterals;
/** Banner configuration. When present, this layout is attached to a document edge (top or bottom). */
banner?: Banner;
/** Background styling (color or gradient). */
background?: LayoutDataBackground;
/** Backdrop styling (color or gradient). */
backdrop?: Backdrop;
}
declare enum ImageScalingScaling {
/** Auto image scaling */
AUTO = "AUTO",
/** Contain image scaling */
CONTAIN = "CONTAIN",
/** Cover image scaling */
COVER = "COVER"
}
/** @enumType */
type ImageScalingScalingWithLiterals = ImageScalingScaling | 'AUTO' | 'CONTAIN' | 'COVER';
declare enum ImagePosition {
/** Image positioned at the center */
CENTER = "CENTER",
/** Image positioned on the left */
CENTER_LEFT = "CENTER_LEFT",
/** Image positioned on the right */
CENTER_RIGHT = "CENTER_RIGHT",
/** Image positioned at the center top */
TOP = "TOP",
/** Image positioned at the top left */
TOP_LEFT = "TOP_LEFT",
/** Image positioned at the top right */
TOP_RIGHT = "TOP_RIGHT",
/** Image positioned at the center bottom */
BOTTOM = "BOTTOM",
/** Image positioned at the bottom left */
BOTTOM_LEFT = "BOTTOM_LEFT",
/** Image positioned at the bottom right */
BOTTOM_RIGHT = "BOTTOM_RIGHT"
}
/** @enumType */
type ImagePositionWithLiterals = ImagePosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
declare enum BannerOrigin {
/** Banner originated from an image */
IMAGE = "IMAGE",
/** Banner originated from a layout */
LAYOUT = "LAYOUT"
}
/** @enumType */
type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
declare enum BannerPosition {
/** Attached to the top edge (banner) */
TOP = "TOP",
/** Attached to the bottom edge (footer) */
BOTTOM = "BOTTOM"
}
/** @enumType */
type BannerPositionWithLiterals = BannerPosition | 'TOP' | 'BOTTOM';
/** Background type */
declare enum LayoutDataBackgroundType {
/** Solid color background */
COLOR = "COLOR",
/** Gradient background */
GRADIENT = "GRADIENT"
}
/** @enumType */
type LayoutDataBackgroundTypeWithLiterals = LayoutDataBackgroundType | 'COLOR' | 'GRADIENT';
/** Backdrop type */
declare enum BackdropType {
/** Solid color backdrop */
COLOR = "COLOR",
/** Gradient backdrop */
GRADIENT = "GRADIENT"
}
/** @enumType */
type BackdropTypeWithLiterals = BackdropType | 'COLOR' | 'GRADIENT';
interface LayoutDataBackgroundImage {
/** Background image. */
media?: V1Media;
/** Background image opacity. */
opacity?: number | null;
/** Background image scaling. */
scaling?: ImageScalingScalingWithLiterals;
/** Position of background. Defaults to `CENTER`. */
position?: ImagePositionWithLiterals;
}
declare enum VerticalAlignmentAlignment {
/** Top alignment */
TOP = "TOP",
/** Middle alignment */
MIDDLE = "MIDDLE",
/** Bottom alignment */
BOTTOM = "BOTTOM"
}
/** @enumType */
type VerticalAlignmentAlignmentWithLiterals = VerticalAlignmentAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
declare enum ResponsivenessBehaviour {
/** Stacking of columns */
STACK = "STACK",
/** Wrapping of columns */
WRAP = "WRAP"
}
/** @enumType */
type ResponsivenessBehaviourWithLiterals = ResponsivenessBehaviour | 'STACK' | 'WRAP';
declare enum DesignTarget {
/** Design applied to layout */
LAYOUT = "LAYOUT",
/** Design applied to cells */
CELL = "CELL"
}
/** @enumType */
type DesignTargetWithLiterals = DesignTarget | 'LAYOUT' | 'CELL';
interface Banner {
/** Origin of the banner */
origin?: BannerOriginWithLiterals;
/** Position of the banner */
position?: BannerPositionWithLiterals;
}
/** Background styling (color or gradient) */
interface LayoutDataBackground {
/** Background type. */
type?: LayoutDataBackgroundTypeWithLiterals;
/**
* Background color as a hexadecimal value.
* @maxLength 19
*/
color?: string | null;
/** Gradient configuration. */
gradient?: Gradient;
}
/** Backdrop styling (color or gradient) */
interface Backdrop {
/** Backdrop type. */
type?: BackdropTypeWithLiterals;
/**
* Backdrop color as a hexadecimal value.
* @maxLength 19
*/
color?: string | null;
/** Gradient configuration. */
gradient?: Gradient;
}
interface LayoutCellData {
/** Size of the cell in 12 columns grid. */
colSpan?: number | null;
}
interface ShapeData {
/** Styling for the shape's container. */
containerData?: PluginContainerData;
/** Shape file details. */
shape?: V1Media;
/** Styling for the shape. */
styles?: ShapeDataStyles;
}
interface ShapeDataStyles {
/**
* Shape fill color as a hexadecimal value.
* @maxLength 19
*/
color?: string | null;
/** Map of original color keys to their new color values. */
colors?: Record;
}
interface CardData {
/** Background styling (color or gradient). */
background?: CardDataBackground;
/** Background image. */
backgroundImage?: BackgroundImage;
}
declare enum Scaling {
/** Auto image scaling */
AUTO = "AUTO",
/** Contain image scaling */
CONTAIN = "CONTAIN",
/** Cover image scaling */
COVER = "COVER"
}
/** @enumType */
type ScalingWithLiterals = Scaling | 'AUTO' | 'CONTAIN' | 'COVER';
declare enum ImagePositionPosition {
/** Image positioned at the center */
CENTER = "CENTER",
/** Image positioned on the left */
CENTER_LEFT = "CENTER_LEFT",
/** Image positioned on the right */
CENTER_RIGHT = "CENTER_RIGHT",
/** Image positioned at the center top */
TOP = "TOP",
/** Image positioned at the top left */
TOP_LEFT = "TOP_LEFT",
/** Image positioned at the top right */
TOP_RIGHT = "TOP_RIGHT",
/** Image positioned at the center bottom */
BOTTOM = "BOTTOM",
/** Image positioned at the bottom left */
BOTTOM_LEFT = "BOTTOM_LEFT",
/** Image positioned at the bottom right */
BOTTOM_RIGHT = "BOTTOM_RIGHT"
}
/** @enumType */
type ImagePositionPositionWithLiterals = ImagePositionPosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
/** Background type */
declare enum CardDataBackgroundType {
/** Solid color background */
COLOR = "COLOR",
/** Gradient background */
GRADIENT = "GRADIENT"
}
/** @enumType */
type CardDataBackgroundTypeWithLiterals = CardDataBackgroundType | 'COLOR' | 'GRADIENT';
/** Background styling (color or gradient) */
interface CardDataBackground {
/** Background type. */
type?: CardDataBackgroundTypeWithLiterals;
/**
* Background color as a hexadecimal value.
* @maxLength 19
*/
color?: string | null;
/** Gradient configuration. */
gradient?: Gradient;
}
interface BackgroundImage {
/** Background image. */
media?: V1Media;
/** Background image opacity. */
opacity?: number | null;
/** Background image scaling. */
scaling?: ScalingWithLiterals;
/** Position of background. Defaults to `CENTER`. */
position?: ImagePositionPositionWithLiterals;
}
interface TocData {
/** Heading levels included in the table of contents. Default: [1, 2, 3, 4, 5, 6]. */
includedHeadings?: number[];
/** List style. Default: PLAIN. */
listStyle?: ListStyleWithLiterals;
/** Optional override for the font size in pixels. */
fontSize?: number | null;
/** Optional override for the vertical spacing between items in pixels. */
itemSpacing?: number | null;
/**
* Optional override for the text color.
* @maxLength 19
*/
color?: string | null;
/** Indentation style. Default: NESTED. */
indentation?: IndentationWithLiterals;
}
/** List style. */
declare enum ListStyle {
/** No markers (default) */
PLAIN = "PLAIN",
/** Numbered list */
NUMBERED = "NUMBERED",
/** Alphabetic letters */
LETTERS = "LETTERS",
/** Roman numerals */
ROMAN = "ROMAN",
/** Bulleted list */
BULLETED = "BULLETED",
/** Alphabetical index */
ALPHABETICAL_INDEX = "ALPHABETICAL_INDEX",
/** Alphabetical index (compact top-row only) */
ALPHABETICAL_INDEX_COMPACT = "ALPHABETICAL_INDEX_COMPACT"
}
/** @enumType */
type ListStyleWithLiterals = ListStyle | 'PLAIN' | 'NUMBERED' | 'LETTERS' | 'ROMAN' | 'BULLETED' | 'ALPHABETICAL_INDEX' | 'ALPHABETICAL_INDEX_COMPACT';
/** Indentation style. */
declare enum Indentation {
/** Sub-headings indented under parents (default) */
NESTED = "NESTED",
/** All items at the same level */
FLAT = "FLAT"
}
/** @enumType */
type IndentationWithLiterals = Indentation | 'NESTED' | 'FLAT';
/** Data for a smart block node. */
interface SmartBlockData {
/** The type of the smart block. */
type?: SmartBlockDataTypeWithLiterals;
/** Layout orientation. HORIZONTAL or VERTICAL. Optional for variants with fixed orientation. */
orientation?: string | null;
/** Column size controlling cells per row. */
columnSize?: ColumnSizeWithLiterals;
/**
* Border color (for SOLID_JOINED_BOXES variant).
* @maxLength 19
*/
borderColor?: string | null;
/** Border width in pixels (for SOLID_JOINED_BOXES variant). */
borderWidth?: number | null;
/** Border radius in pixels (for SOLID_JOINED_BOXES variant). */
borderRadius?: number | null;
}
/** Layout type of the smart block */
declare enum SmartBlockDataType {
/** Grid-based layouts with solid box items containing title, body, and icon/image. */
SOLID_BOXES = "SOLID_BOXES",
/** Numbered boxes. */
NUMBERED_BOXES = "NUMBERED_BOXES",
/** Statistics display with large numbers/values. */
STATS = "STATS",
/** Statistics with circular visual elements. */
CIRCLE_STATS = "CIRCLE_STATS",
/** Staggered/zigzag grid layout with alternating box positions. */
SOLID_BOXES_ALTERNATING = "SOLID_BOXES_ALTERNATING",
/** Grid layout with boxes visually joined (no gaps, shared container border). */
SOLID_JOINED_BOXES = "SOLID_JOINED_BOXES",
/** Transparent cells with only a left side line. */
SIDE_LINE_TEXT = "SIDE_LINE_TEXT",
/** Transparent cells with only a top line. */
TOP_LINE_TEXT = "TOP_LINE_TEXT",
/** Outlined boxes with a numbered/icon circle at the top. */
OUTLINE_BOXES_WITH_TOP_CIRCLE = "OUTLINE_BOXES_WITH_TOP_CIRCLE",
/** Large icon bullets with text content. */
BIG_BULLETS = "BIG_BULLETS",
/** Small dot bullets with text content. */
SMALL_BULLETS = "SMALL_BULLETS",
/** Arrow icon bullets with text content. */
ARROW_BULLETS = "ARROW_BULLETS",
/** Process steps with numbered/icon labels above a horizontal line. */
PROCESS_STEPS = "PROCESS_STEPS",
/** Statistics with bar visual elements. */
BAR_STATS = "BAR_STATS",
/** Timeline layout with numbered chips on a connecting line; cells alternate around the line. */
TIMELINE = "TIMELINE",
/** Timeline layout with plain dot indicators; no numbers or shapes; cells alternate around the line. */
MINIMAL_TIMELINE = "MINIMAL_TIMELINE",
/** Numbered pill-shaped labels (stadium chips) with text content; supports HORIZONTAL (pill on top) and VERTICAL (pill on left) orientations. */
PILLS = "PILLS",
/** Star rating display with stars and a numeric value per cell. */
STAR_RATING = "STAR_RATING",
/** Outlined boxes with decorative quote glyphs at the top-left and bottom-right corners. */
QUOTE_BOXES = "QUOTE_BOXES"
}
/** @enumType */
type SmartBlockDataTypeWithLiterals = SmartBlockDataType | 'SOLID_BOXES' | 'NUMBERED_BOXES' | 'STATS' | 'CIRCLE_STATS' | 'SOLID_BOXES_ALTERNATING' | 'SOLID_JOINED_BOXES' | 'SIDE_LINE_TEXT' | 'TOP_LINE_TEXT' | 'OUTLINE_BOXES_WITH_TOP_CIRCLE' | 'BIG_BULLETS' | 'SMALL_BULLETS' | 'ARROW_BULLETS' | 'PROCESS_STEPS' | 'BAR_STATS' | 'TIMELINE' | 'MINIMAL_TIMELINE' | 'PILLS' | 'STAR_RATING' | 'QUOTE_BOXES';
/** Column size controlling how many cells appear per row. */
declare enum ColumnSize {
/** Up to 4 cells in a row. */
SMALL = "SMALL",
/** Up to 3 cells in a row (default). */
MEDIUM = "MEDIUM",
/** Up to 2 cells in a row. */
LARGE = "LARGE",
/** 1 cell in a row. */
EXTRA_LARGE = "EXTRA_LARGE"
}
/** @enumType */
type ColumnSizeWithLiterals = ColumnSize | 'SMALL' | 'MEDIUM' | 'LARGE' | 'EXTRA_LARGE';
/** Data for a smart block cell node. */
interface SmartBlockCellData {
/** Optional label text for the cell (e.g., for stats variants). */
label?: string | null;
/** Shape file details. */
shape?: V1Media;
/**
* Border color of the cell.
* @maxLength 19
*/
borderColor?: string | null;
/** Border width in pixels. */
borderWidth?: number | null;
/** Border radius in pixels. */
borderRadius?: number | null;
/** The type of the parent smart block (must match parent). */
type?: SmartBlockDataTypeWithLiterals;
/**
* Accent color for non-background variants (e.g., line, bullet, label color).
* @maxLength 19
*/
accentColor?: string | null;
/**
* Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES).
* @maxLength 19
*/
backgroundColor?: string | null;
/**
* Shape fill color as a hexadecimal value.
* @maxLength 19
*/
shapeColor?: string | null;
}
interface Metadata {
/** Schema version. */
version?: number;
/**
* When the object was created.
* @readonly
* @deprecated
*/
createdTimestamp?: Date | null;
/**
* When the object was most recently updated.
* @deprecated
*/
updatedTimestamp?: Date | null;
/** Object ID. */
_id?: string | null;
}
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;
}
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;
}
interface ModerationDetails {
/**
* Member ID of the person submitting the draft post for review.
* @format GUID
*/
submittedBy?: string;
/** Date the post was submitted for review. */
submittedDate?: Date | null;
/** Status indicating whether the submission was approved or rejected by the moderator. */
status?: ModerationStatusStatusWithLiterals;
/**
* Member ID of the person who approved or rejected the post.
* @format GUID
*/
moderatedBy?: string | null;
/** Date the post was approved or rejected. */
moderationDate?: Date | null;
}
declare enum ModerationStatusStatus {
UNKNOWN = "UNKNOWN",
APPROVED = "APPROVED",
REJECTED = "REJECTED"
}
/** @enumType */
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
interface Media extends MediaMediaOneOf {
/** Wix Media details. */
wixMedia?: WixMedia;
/** Embed media details. */
embedMedia?: EmbedMedia;
/** Whether cover media is displayed. */
displayed?: boolean;
/** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
custom?: boolean;
/**
* Media alternative text.
* @minLength 1
* @maxLength 1000
*/
altText?: string | null;
}
/** @oneof */
interface MediaMediaOneOf {
/** Wix Media details. */
wixMedia?: WixMedia;
/** Embed media details. */
embedMedia?: EmbedMedia;
}
interface WixMedia {
/** Image details. */
image?: string;
/** Video details. */
videoV2?: string;
}
interface VideoResolution {
/** Video URL. */
url?: string;
/** Video height. */
height?: number;
/** Video width. */
width?: number;
/** Video format for example, mp4, hls. */
format?: string;
}
interface EmbedMedia {
/** Thumbnail details. */
thumbnail?: EmbedThumbnail;
/** Video details. */
video?: EmbedVideo;
}
interface EmbedThumbnail {
/**
* Thumbnail url.
* @maxLength 2000
*/
url?: string;
/** Thumbnail width. */
width?: number;
/** Thumbnail height. */
height?: number;
}
interface EmbedVideo {
/**
* Video url.
* @maxLength 2000
*/
url?: string;
/** Video width. */
width?: number;
/** Video height. */
height?: number;
}
interface PostTranslation {
/**
* Post ID.
* @format GUID
*/
_id?: string;
/**
* Language the post is written in.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Post slug.
*
* The slug is the end of a post's URL that refers to a specific post.
* For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
* the slug is `my-post-slug`. The slug is case-sensitive.
* @maxLength 100
*/
slug?: string | null;
/** SEO data. */
seoData?: SeoSchema;
/** Post URL. */
url?: string;
}
interface PostCategoriesUpdated {
/**
* ID of the post which counters were updated.
* @format GUID
*/
postId?: string;
/**
* Current categories of the post.
* @maxSize 10
* @format GUID
*/
categories?: string[];
/**
* Previous categories of the post.
* @maxSize 10
* @format GUID
*/
previousCategories?: string[];
}
interface PostTagsUpdated {
/**
* ID of the post which counters were updated.
* @format GUID
*/
postId?: string;
/**
* Current tags of the post.
* @maxSize 30
* @format GUID
*/
tags?: string[];
/**
* Previous tags of the post.
* @maxSize 30
* @format GUID
*/
previousTags?: string[];
}
interface ScheduledPostPublished {
/**
* ID of the scheduled post which was published.
* @format GUID
*/
postId?: string;
}
interface PostLiked extends PostLikedInitiatorOneOf {
/**
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
* @format GUID
*/
memberId?: string | null;
/**
* Visitor ID of person who liked the post when they are not logged in.
* @format GUID
*/
anonymousVisitorId?: string | null;
/**
* ID of the liked post.
* @format GUID
*/
postId?: string;
}
/** @oneof */
interface PostLikedInitiatorOneOf {
/**
* Member ID of person who liked the post (only returned when the member was logged in when liking the post).
* @format GUID
*/
memberId?: string | null;
/**
* Visitor ID of person who liked the post when they are not logged in.
* @format GUID
*/
anonymousVisitorId?: string | null;
}
interface PostUnliked extends PostUnlikedInitiatorOneOf {
/**
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
* @format GUID
*/
memberId?: string | null;
/**
* Visitor ID of person who unliked the post when they are not logged in.
* @format GUID
*/
anonymousVisitorId?: string | null;
/**
* ID of the unliked post.
* @format GUID
*/
postId?: string;
}
/** @oneof */
interface PostUnlikedInitiatorOneOf {
/**
* Member ID of person who unliked the post (returned when the member was logged in when unliking the post).
* @format GUID
*/
memberId?: string | null;
/**
* Visitor ID of person who unliked the post when they are not logged in.
* @format GUID
*/
anonymousVisitorId?: string | null;
}
interface ListTemplatesRequest {
/**
* Filter post templates by given template category ids
* @maxSize 50
* @format GUID
*/
categoryIds?: string[];
/**
* Filter post templates by provided language
* @format LANGUAGE_TAG
*/
language?: string | null;
/** Returns post template categories when set to TRUE */
listTemplateCategories?: boolean;
/** Sort order by ascending/descending publish date. Default is ascending publish date sort */
sort?: GetPostTemplatesSortWithLiterals;
/** Pagination options. */
paging?: BlogPaging;
}
declare enum GetPostTemplatesSort {
/** Sort by ascending publishing date. */
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
/** Sort by descending publishing date. */
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
}
/** @enumType */
type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
interface BlogPaging {
/**
* Number of items to skip in the current sort order.
*
*
* Default: `0`
*/
offset?: number;
/**
* Number of items to return.
*
*
* Default:`50`
* @min 1
* @max 100
*/
limit?: number;
/**
* Pointer to the next or previous page in the list of results.
* @maxLength 2000
*/
cursor?: string | null;
}
interface ListTemplatesResponse {
/** Available post templates */
postTemplates?: Post[];
/** Details on the paged set of posts templates returned. */
postTemplatesMetaData?: MetaData;
/** Post template categories. This value is returned empty unless asked explicitly */
templateCategories?: Category[];
}
interface MetaData {
/** Number of items returned in this response. */
count?: number;
/** Requested offset. */
offset?: number;
/** Total number of items that match the query. */
total?: number;
/**
* Pointer to the next or previous page in the list of results.
* @maxLength 2000
*/
cursor?: string | null;
}
interface Category {
/**
* Category ID.
* @immutable
* @maxLength 38
*/
_id?: string;
/**
* Category label. Displayed in the Category Menu.
* @maxLength 35
*/
label?: string;
/**
* Number of posts in the category.
* @readonly
*/
postCount?: number;
/**
* The `url` of the page that lists every post with the specified category.
* @readonly
*/
url?: string;
/**
* Category description.
* @maxLength 500
*/
description?: string | null;
/**
* Category title.
* @maxLength 200
* @deprecated Category title.
* @targetRemovalDate 2025-07-16
*/
title?: string;
/**
* Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
* Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
*
* Default: `-1`
*/
displayPosition?: number | null;
/**
* ID of the category's translations. All translations of a single category share the same `translationId`.
* @format GUID
*/
translationId?: string | null;
/**
* Category language.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* @immutable
*/
language?: string | null;
/**
* Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
* @maxLength 100
*/
slug?: string;
/** SEO data. */
seoData?: SeoSchema;
/** Category cover image. */
coverImage?: string;
/**
* Date and time the Category was last updated.
* @readonly
*/
_updatedDate?: Date | null;
}
interface CategoryTranslation {
/**
* Category ID.
* @format GUID
*/
_id?: string;
/**
* Label displayed in the categories menu on the site.
* @maxLength 100
*/
label?: string | null;
/**
* Language of the category.
* @format LANGUAGE_TAG
*/
language?: string | null;
/** URL of this category page. */
url?: string;
}
interface GetTemplateRequest {
/**
* Post template id
* @format GUID
*/
postTemplateId?: string;
}
interface GetTemplateResponse {
/** Post template */
postTemplate?: Post;
}
interface CreateDraftPostFromTemplateRequest {
/**
* Post template id
* @format GUID
*/
postTemplateId?: string;
}
interface CreateDraftPostFromTemplateResponse {
/** Created draft post */
draftPost?: DraftPost;
}
interface DraftPost {
/**
* Draft post ID.
* @readonly
* @maxLength 38
*/
_id?: string;
/**
* Draft post title.
* @maxLength 200
*/
title?: string;
/**
* Draft post excerpt.
*
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
* @maxLength 500
*/
excerpt?: string | null;
/** Whether the draft post is marked as featured. */
featured?: boolean | null;
/**
* Category IDs of the draft post.
* @maxSize 10
* @maxLength 38
*/
categoryIds?: string[];
/**
* Draft post owner's member ID.
* @format GUID
*/
memberId?: string | null;
/**
* Hashtags in the post.
* @maxSize 100
* @maxLength 100
*/
hashtags?: string[];
/** Whether commenting on the draft post is enabled. */
commentingEnabled?: boolean | null;
/**
* Estimated reading time of the draft post (calculated automatically).
* @readonly
*/
minutesToRead?: number;
/** Image placed at the top of the blog page. */
heroImage?: string;
/**
* Tag IDs the draft post is tagged with.
* @maxSize 30
* @maxLength 38
*/
tagIds?: string[];
/**
* IDs of posts related to this draft post.
* @maxSize 3
* @maxLength 38
*/
relatedPostIds?: string[];
/**
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
* @maxSize 100
* @format GUID
*/
pricingPlanIds?: string[];
/**
* ID of the draft post's translations.
*
* All translations of a single post share the same `translationId`.
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
* @format GUID
*/
translationId?: string | null;
/**
* Language the draft post is written in.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Draft Post rich content.
*
*
* See Ricos document reference
*
*/
richContent?: RichContent;
/**
* Status of the draft post.
* @readonly
*/
status?: StatusWithLiterals;
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
moderationDetails?: ModerationDetails;
/**
* Indicates if there are changes made to the draft post that have not yet been published.
* @readonly
*/
hasUnpublishedChanges?: boolean;
/**
* Date the draft post was last edited.
* @readonly
*/
editedDate?: Date | null;
/**
* Date the draft post is scheduled to be published.
* @readonly
*/
scheduledPublishDate?: Date | null;
/** Date the post was first published. */
firstPublishedDate?: Date | null;
/** SEO data. */
seoData?: SeoSchema;
/**
* Draft post URL preview. What the URL will look like once the post is published.
* @readonly
*/
url?: string;
/**
* Date the draft post was first created.
* @readonly
*/
_createdDate?: Date | null;
/**
* SEO slug.
* @maxLength 100
*/
seoSlug?: string | null;
/** Post cover media. */
media?: Media;
/** Number of paragraphs to display in a paid content preview for non-paying users. */
previewTextParagraph?: number | null;
}
declare enum Origin {
UNKNOWN = "UNKNOWN",
/** Changed by admin */
ADMIN = "ADMIN",
/** Categories were changed */
ADD_CATEGORIES = "ADD_CATEGORIES",
/** Saved automatically */
AUTO_SAVE = "AUTO_SAVE",
/** Copied from template */
COPY_TEMPLATE = "COPY_TEMPLATE",
/** Imported */
IMPORT = "IMPORT",
/** Imported in bulk */
IMPORT_BULK = "IMPORT_BULK",
/** Imported with html import */
IMPORT_HTML = "IMPORT_HTML",
/** Patch import */
IMPORT_PATCH = "IMPORT_PATCH",
/** Changed language */
LANGUAGE_CHANGE = "LANGUAGE_CHANGE",
/** Saved manually */
MANUAL_SAVE = "MANUAL_SAVE",
/** Affected by migration */
MIGRATION = "MIGRATION",
/** Affected by moderation */
MODERATION = "MODERATION",
/** Moved to trash */
MOVE_TO_TRASH = "MOVE_TO_TRASH",
/** Pricing plans were changed */
PRICING_PLANS_CHANGE = "PRICING_PLANS_CHANGE",
/** Was provisioned */
PROVISION = "PROVISION",
/** Was published */
PUBLISH = "PUBLISH",
/** Owner was reassigned */
REASSIGN_OWNER = "REASSIGN_OWNER",
/** Was reblogged */
REBLOG = "REBLOG",
/** Was restored */
RESTORE = "RESTORE",
/** Reverted to draft */
REVERT_TO_DRAFT = "REVERT_TO_DRAFT",
/** Was translated */
TRANSLATION = "TRANSLATION",
/** Was unpublished */
UNPUBLISH = "UNPUBLISH",
/** Was unscheduled */
UNSCHEDULE = "UNSCHEDULE",
/** New edit session started which updated editing_session_id id */
NEW_EDIT_SESSION = "NEW_EDIT_SESSION",
/** Was scheduled by Later */
SCHEDULING_SERVICE_SCHEDULE = "SCHEDULING_SERVICE_SCHEDULE",
/** Was unscheduled by Later */
SCHEDULING_SERVICE_UNSCHEDULE = "SCHEDULING_SERVICE_UNSCHEDULE",
/** Was published by Later */
SCHEDULING_SERVICE_PUBLISH = "SCHEDULING_SERVICE_PUBLISH",
/** Was scheduled */
SCHEDULE = "SCHEDULE",
/** Was removed from moderation */
REMOVE_FROM_MODERATION = "REMOVE_FROM_MODERATION",
/** Was rejected from moderation */
REJECT_FROM_MODERATION = "REJECT_FROM_MODERATION",
/** Was approved in moderation */
APPROVE_IN_MODERATION = "APPROVE_IN_MODERATION",
/** Tag was deleted */
DELETE_TAG = "DELETE_TAG",
/** Post was pinned */
PIN = "PIN",
/** Post was unpinned */
UNPIN = "UNPIN",
/** Saved automatically by AI tool. */
AI_AUTO_SAVE = "AI_AUTO_SAVE"
}
/** @enumType */
type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
declare enum Status {
UNKNOWN = "UNKNOWN",
/** Status indicating the draft post is published. */
PUBLISHED = "PUBLISHED",
/** Status indicating the draft post is unpublished. */
UNPUBLISHED = "UNPUBLISHED",
/** Status indicating the draft post is scheduled for publication. */
SCHEDULED = "SCHEDULED",
/** Status indicating the draft post is deleted. */
DELETED = "DELETED",
/** Status indicating the draft post is in review. */
IN_REVIEW = "IN_REVIEW"
}
/** @enumType */
type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
interface DraftPostTranslation {
/**
* Post ID.
* @format GUID
*/
_id?: string;
/** Post status. */
status?: StatusWithLiterals;
/**
* Language the post is written in.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Post slug. For example, 'post-slug'.
* @maxLength 100
*/
slug?: string | null;
/** SEO data. */
seoData?: SeoSchema;
/** Post URL. */
url?: string;
}
interface DomainEvent extends DomainEventBodyOneOf {
createdEvent?: EntityCreatedEvent;
updatedEvent?: EntityUpdatedEvent;
deletedEvent?: EntityDeletedEvent;
actionEvent?: ActionEvent;
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
_id?: string;
/**
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
*/
entityFqdn?: string;
/**
* Event action name, placed at the top level to make it easier for users to dispatch messages.
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
*/
slug?: string;
/** ID of the entity associated with the event. */
entityId?: string;
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
eventTime?: Date | null;
/**
* Whether the event was triggered as a result of a privacy regulation application
* (for example, GDPR).
*/
triggeredByAnonymizeRequest?: boolean | null;
/** If present, indicates the action that triggered the event. */
originatedFrom?: string | null;
/**
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
*/
entityEventSequence?: string | null;
}
/** @oneof */
interface DomainEventBodyOneOf {
createdEvent?: EntityCreatedEvent;
updatedEvent?: EntityUpdatedEvent;
deletedEvent?: EntityDeletedEvent;
actionEvent?: ActionEvent;
}
interface EntityCreatedEvent {
entity?: string;
}
interface RestoreInfo {
deletedDate?: Date | null;
}
interface EntityUpdatedEvent {
/**
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
*/
currentEntity?: string;
}
interface EntityDeletedEvent {
/** Entity that was deleted. */
deletedEntity?: string | null;
}
interface ActionEvent {
body?: string;
}
interface MessageEnvelope {
/**
* App instance ID.
* @format GUID
*/
instanceId?: string | null;
/**
* Event type.
* @maxLength 150
*/
eventType?: string;
/** The identification type and identity data. */
identity?: IdentificationData;
/** Stringify payload. */
data?: string;
/** Details related to the account */
accountInfo?: AccountInfo;
}
interface IdentificationData extends IdentificationDataIdOneOf {
/**
* ID of a site visitor that has not logged in to the site.
* @format GUID
*/
anonymousVisitorId?: string;
/**
* ID of a site visitor that has logged in to the site.
* @format GUID
*/
memberId?: string;
/**
* ID of a Wix user (site owner, contributor, etc.).
* @format GUID
*/
wixUserId?: string;
/**
* ID of an app.
* @format GUID
*/
appId?: string;
/** @readonly */
identityType?: WebhookIdentityTypeWithLiterals;
}
/** @oneof */
interface IdentificationDataIdOneOf {
/**
* ID of a site visitor that has not logged in to the site.
* @format GUID
*/
anonymousVisitorId?: string;
/**
* ID of a site visitor that has logged in to the site.
* @format GUID
*/
memberId?: string;
/**
* ID of a Wix user (site owner, contributor, etc.).
* @format GUID
*/
wixUserId?: string;
/**
* ID of an app.
* @format GUID
*/
appId?: string;
}
declare enum WebhookIdentityType {
UNKNOWN = "UNKNOWN",
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
MEMBER = "MEMBER",
WIX_USER = "WIX_USER",
APP = "APP"
}
/** @enumType */
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
interface AccountInfo {
/**
* ID of the Wix account associated with the event.
* @format GUID
*/
accountId?: string | null;
/**
* ID of the parent Wix account. Only included when accountId belongs to a child account.
* @format GUID
*/
parentAccountId?: string | null;
/**
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
* @format GUID
*/
siteId?: string | null;
}
/** Get Blog Publications Count Stats request */
interface QueryPublicationsCountStatsRequest {
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
rangeStart?: Date | null;
/** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
rangeEnd?: Date | null;
/** Order of the returned results. */
order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
/** Number of months to include in the response. */
months?: number;
/**
* Language filter
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Timezone of the client.
* @minLength 3
* @maxLength 100
*/
timeZone?: string | null;
}
declare enum QueryPublicationsCountStatsRequestOrder {
UNKNOWN = "UNKNOWN",
OLDEST = "OLDEST",
NEWEST = "NEWEST"
}
/** @enumType */
type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
/** Get Blog Publications Count Stats response */
interface QueryPublicationsCountStatsResponse {
/** Chronologically ordered list of publications. */
stats?: PeriodPublicationsCount[];
}
/** Publications count for a specific time period */
interface PeriodPublicationsCount {
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
periodStart?: Date | null;
/** Number of posts published during this month. */
publicationsCount?: number;
}
/** Get Blog Post Count Stats request */
interface QueryPostCountStatsRequest {
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
rangeStart?: Date | null;
/**
* Order of returned results.
*
* - `OLDEST`: posts by date in ascending order.
* - `NEWEST`: posts by date in descending order.
*
* Default: `OLDEST`
*/
order?: OrderWithLiterals;
/** Number of months to include in response. */
months?: number;
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive the period post count for that specified language.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Time zone to use when calculating the start of the month.
*
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
* @minLength 3
* @maxLength 100
*/
timeZone?: string | null;
}
declare enum Order {
UNKNOWN = "UNKNOWN",
OLDEST = "OLDEST",
NEWEST = "NEWEST"
}
/** @enumType */
type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
/** Get Blog Post Count Stats response */
interface QueryPostCountStatsResponse {
/** List of published post counts by month. */
stats?: PeriodPostCount[];
}
/** Post count for a specific time period */
interface PeriodPostCount {
/** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
periodStart?: Date | null;
/** Number of posts published during this month. */
postCount?: number;
}
interface GetTotalPublicationsRequest {
/**
* Language filter
* @minLength 2
* @format LANGUAGE_TAG
*/
language?: string | null;
}
interface GetTotalPublicationsResponse {
/** Total amount of publications. */
total?: number;
}
interface GetTotalPostsRequest {
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to receive the total amount of posts in that specified language.
* @format LANGUAGE_TAG
*/
language?: string | null;
}
interface GetTotalPostsResponse {
/** Total amount of published posts. */
total?: number;
}
interface GetTotalLikesPerMemberRequest {
/**
* Member ID.
* @format GUID
*/
memberId?: string;
}
interface GetTotalLikesPerMemberResponse {
/** The total number of likes of the member. */
total?: number;
}
interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
/**
* Member ID of person who triggered the counter update
* @format GUID
*/
memberId?: string | null;
/**
* Visitor ID if person that liked the post is not logged in
* @format GUID
*/
anonymousVisitorId?: string | null;
/**
* ID of the post which counters were updated.
* @format GUID
*/
postId?: string;
/** Field of the updated counter. */
updatedCounterField?: FieldWithLiterals;
/** New counter value. */
counter?: number;
}
/** @oneof */
interface PostCountersUpdatedInitiatorOneOf {
/**
* Member ID of person who triggered the counter update
* @format GUID
*/
memberId?: string | null;
/**
* Visitor ID if person that liked the post is not logged in
* @format GUID
*/
anonymousVisitorId?: string | null;
}
declare enum Field {
/** Undefined field. */
UNKNOWN = "UNKNOWN",
/** Total comments field. */
TOTAL_COMMENTS = "TOTAL_COMMENTS",
/** Like count field. */
LIKE_COUNT = "LIKE_COUNT",
/** View count field. */
VIEW_COUNT = "VIEW_COUNT",
/** Rating count field. */
RATING_COUNT = "RATING_COUNT"
}
/** @enumType */
type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
interface PostOwnerChanged {
}
interface InitialPostsCopied {
/** Number of posts copied. */
count?: number;
}
interface GetPostRequest {
/**
* Post ID.
* @minLength 1
* @maxLength 38
*/
postId: string;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
declare enum PostFieldField {
UNKNOWN = "UNKNOWN",
/** Includes post URL when present. */
URL = "URL",
/** Includes post content text string when present. */
CONTENT_TEXT = "CONTENT_TEXT",
/** Includes post metrics when present. */
METRICS = "METRICS",
/** Includes SEO data. */
SEO = "SEO",
/** Includes post owner's contact ID. */
CONTACT_ID = "CONTACT_ID",
/** Includes post rich content. */
RICH_CONTENT = "RICH_CONTENT",
/** Includes post reference ID field. */
REFERENCE_ID = "REFERENCE_ID"
}
/** @enumType */
type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
interface GetPostResponse {
/** Retrieved post info. */
post?: Post;
}
interface GetPostBySlugRequest {
/**
* Slug of the post to retrieve.
* @minLength 1
* @maxLength 200
*/
slug: string;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
/**
* Language of the post.
* @format LANGUAGE_TAG
*/
language?: string | null;
}
interface GetPostBySlugResponse {
/** Retrieved post info. */
post?: Post;
}
interface ListPostsRequest {
/**
* Whether to return only featured posts.
*
* Default: `false`
*/
featured?: boolean;
/**
* Hashtag filter.
*
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
* If omitted, all posts with or without hashtags are returned.
* @maxSize 100
* @maxLength 100
*/
hashtags?: string[];
/**
* Category filter.
*
* Pass an array of category IDs to return only posts with any of the provided categories.
* If omitted, all posts with or without associated categories are returned.
* @maxSize 50
* @maxLength 38
*/
categoryIds?: string[];
/**
* Tag filter.
*
* Pass an array of tag IDs to return only posts with any of the provided tags.
* If omitted, all posts with or without tags are returned.
* @maxSize 50
* @maxLength 38
*/
tagIds?: string[];
/**
* Sorting options.
*
* Default: `FEED`
*/
sort?: GetPostsSortWithLiterals;
/** Pagination options. */
paging?: BlogPaging;
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive posts that are in that language.
* If omitted, posts in all languages are returned.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Post owner's member ID.
* @format GUID
*/
memberId?: string | null;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
declare enum GetPostsSort {
/** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
FEED = "FEED",
/** Ordered by `firstPublishedDate` in ascending order. */
PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
/** Ordered by `firstPublishedDate` in descending order. */
PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
/** Ordered by total number of views in descending order. */
VIEW_COUNT = "VIEW_COUNT",
/** Ordered by total number of likes in descending order. */
LIKE_COUNT = "LIKE_COUNT",
/** Ordered by `title` in ascending order. */
TITLE_ASC = "TITLE_ASC",
/** Ordered by `title` in descending order. */
TITLE_DESC = "TITLE_DESC"
}
/** @enumType */
type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
interface ListPostsResponse {
/** List of retrieved posts. */
posts?: Post[];
/** Details on the paged set of results returned. */
metaData?: MetaData;
}
interface QueryPostsRequest {
/** Query options. */
query?: PlatformQuery;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
interface Sorting {
/**
* Name of the field to sort by.
* @maxLength 512
*/
fieldName?: string;
/** Sort order. */
order?: SortOrderWithLiterals;
}
declare enum SortOrder {
ASC = "ASC",
DESC = "DESC"
}
/** @enumType */
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
/** Paging options to limit and skip the number of items. */
paging?: Paging;
/** 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 | null;
/**
* Sort object in the following format:
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
* @maxSize 3
*/
sort?: Sorting[];
}
/** @oneof */
interface PlatformQueryPagingMethodOneOf {
/** Paging options to limit and skip the number of items. */
paging?: Paging;
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
cursorPaging?: CursorPaging;
}
interface Paging {
/**
* Number of items to load.
* @max 100
*/
limit?: number | null;
/** Number of items to skip in the current sort order. */
offset?: number | null;
}
interface CursorPaging {
/**
* Number of items to load.
* @max 100
*/
limit?: number | null;
/**
* Pointer to the next or previous page in the list of results.
*
* You can get the relevant cursor token
* from the `pagingMetadata` object in the previous call's response.
* Not relevant for the first request.
* @maxLength 2000
*/
cursor?: string | null;
}
interface QueryPostsResponse {
/** List of retrieved posts. */
posts?: Post[];
/** Details on the paged set of results returned. */
pagingMetadata?: PagingMetadataV2;
}
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;
}
interface Cursors {
/**
* Cursor pointing to next page in the list of results.
* @maxLength 2000
*/
next?: string | null;
/**
* Cursor pointing to previous page in the list of results.
* @maxLength 2000
*/
prev?: string | null;
}
interface GetPostMetricsRequest {
/**
* Post ID to retrieve metrics for.
* @minLength 1
* @maxLength 38
*/
postId: string;
}
interface GetPostMetricsResponse {
/** Retrieved post metrics. */
metrics?: Metrics;
}
interface ViewPostRequest {
/**
* Post ID.
* @minLength 1
* @maxLength 38
*/
postId?: string;
}
interface ViewPostResponse {
/** Total number of post views */
views?: number;
}
interface LikePostRequest {
/**
* Post ID.
* @minLength 1
* @format GUID
*/
postId?: string;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
interface LikePostResponse {
/** Post info. */
post?: Post;
}
interface UnlikePostRequest {
/**
* Post ID.
* @minLength 1
* @format GUID
*/
postId?: string;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
interface UnlikePostResponse {
/** Post info. */
post?: Post;
}
interface PinPostRequest {
/**
* Post ID.
* @minLength 1
* @format GUID
*/
postId?: string;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
interface PinPostResponse {
/** Post info. */
post?: Post;
}
interface UnpinPostRequest {
/**
* Post ID.
* @minLength 1
* @format GUID
*/
postId?: string;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
interface UnpinPostResponse {
/** Post info. */
post?: Post;
}
interface ListPostsArchiveRequest {
/**
* Month
* @min 1
* @max 12
*/
month?: number | null;
/**
* Year
* @min 2000
* @max 3000
*/
year?: number;
/**
* Time zone
* @maxLength 50
*/
timeZone?: string | null;
/** Pagination options. */
paging?: BlogPaging;
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive posts that are in that language.
* If omitted, posts in all languages are returned.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
interface ListPostsArchiveResponse {
/** List of posts. */
posts?: Post[];
/** Details on the paged set of results returned. */
metaData?: MetaData;
/** Details on the paged set of results returned. */
pagingMetadata?: PagingMetadataV2;
}
interface GetPostCountPerMonthRequest {
/**
* Optional post language filter.
* @format LANGUAGE_TAG
*/
language?: string | null;
}
interface GetPostCountPerMonthResponse {
/** Post count per month information. */
postCountInfo?: PostCountPerMonth[];
}
interface PostCountPerMonth {
/** Month in a YYYY-MM format, for example "2025-04". */
month?: string;
/** Number of posts published in the month. */
posts?: number;
/** Latest firstPublishedDate in the month. */
latestFirstPublishedDate?: Date | null;
}
interface BulkGetPostReactionsRequest {
/**
* Post IDs.
* @maxSize 500
* @maxLength 38
*/
postIds?: string[];
}
interface BulkGetPostReactionsResponse {
/** Map of post.id to reactions */
reactionsMap?: Record;
}
interface Reactions {
/**
* Is post liked by the current user
* @readonly
*/
liked?: boolean;
}
interface DeletePostRequest {
/**
* Post id.
* @format GUID
*/
postId?: string | null;
}
interface DeletePostResponse {
}
interface BulkDeletePostsRequest {
/**
* Post IDs.
* @minSize 1
* @maxSize 100
* @maxLength 38
*/
postIds?: string[];
/** Should delete bypassing the trash-bin. */
permanent?: boolean;
}
interface BulkDeletePostsResponse {
}
interface GetPostCountsRequest {
/**
* Tag IDs to count posts for.
* @maxSize 50
* @format GUID
*/
tagIds?: string[];
/**
* Category IDs to count posts for.
* @maxSize 50
* @format GUID
*/
categoryIds?: string[];
}
interface GetPostCountsResponse {
/** Post counts per tag. */
tagPostCounts?: PostCount[];
/** Post counts per category. */
categoryPostCounts?: PostCount[];
}
interface PostCount {
/**
* Tag/Category ID.
* @format GUID
*/
_id?: string;
/** Number of posts. */
postCount?: number;
}
interface ListDemoPostsRequest {
/**
* Whether to return only featured posts.
*
* Default: `false`
*/
featured?: boolean;
/**
* Hashtag filter.
*
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
* If omitted, all posts with or without hashtags are returned.
* @maxSize 100
* @maxLength 100
*/
hashtags?: string[];
/**
* Category filter.
*
* Pass an array of category IDs to return only posts with any of the provided categories.
* If omitted, all posts with or without associated categories are returned.
* @maxSize 50
* @format GUID
*/
categoryIds?: string[];
/**
* Tag filter.
*
* Pass an array of tag IDs to return only posts with any of the provided tags.
* If omitted, all posts with or without tags are returned.
* @maxSize 50
* @format GUID
*/
tagIds?: string[];
/**
* Sorting options.
*
* - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
* - `VIEW_COUNT`: Ordered by total number of views in descending order.
* - `LIKE_COUNT`: Ordered by total number of likes in descending order.
* - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
* - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
* - `TITLE_ASC`: Ordered by `title` in ascending order.
* - `TITLE_DESC`: Ordered by `title` in descending order.
* - `RATING`: reserved for internal use.
*
* Default: `FEED`
*/
sort?: GetPostsSortWithLiterals;
/** Pagination options. */
paging?: BlogPaging;
/**
* __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of post fields to be included in the response.
* @maxSize 20
* @deprecated __Deprecated.__ Use `fieldsets` instead.
* This parameter will be removed on June 30, 2023.
*
* List of post fields to be included in the response.
* @replacedBy fieldsets
* @targetRemovalDate 2024-06-30
*/
fieldsToInclude?: PostFieldFieldWithLiterals[];
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive posts that are in that language.
* If omitted, posts in all languages are returned.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Post owner's member ID.
* @format GUID
*/
memberId?: string | null;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
interface ListDemoPostsResponse {
/** List of posts. */
posts?: Post[];
/** Details on the paged set of results returned. */
metaData?: MetaData;
}
interface ConvertDraftJsToRichContentRequest {
/** DraftJs content to convert to Rich content. */
content?: Record | null;
}
interface ConvertDraftJsToRichContentResponse {
/**
* Rich content converted from DraftJs content.
* @maxLength 2000000
*/
richContent?: string;
}
interface ConvertRichContentToDraftJsRequest {
/**
* Rich content to convert to DraftJs content.
* @maxLength 2000000
*/
richContent?: string;
}
interface ConvertRichContentToDraftJsResponse {
/** DraftJs content converted from Rich content. */
content?: Record | null;
}
interface BaseEventMetadata {
/**
* App instance ID.
* @format GUID
*/
instanceId?: string | null;
/**
* Event type.
* @maxLength 150
*/
eventType?: string;
/** The identification type and identity data. */
identity?: IdentificationData;
/** Details related to the account */
accountInfo?: AccountInfo;
}
interface EventMetadata extends BaseEventMetadata {
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
_id?: string;
/**
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
*/
entityFqdn?: string;
/**
* Event action name, placed at the top level to make it easier for users to dispatch messages.
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
*/
slug?: string;
/** ID of the entity associated with the event. */
entityId?: string;
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
eventTime?: Date | null;
/**
* Whether the event was triggered as a result of a privacy regulation application
* (for example, GDPR).
*/
triggeredByAnonymizeRequest?: boolean | null;
/** If present, indicates the action that triggered the event. */
originatedFrom?: string | null;
/**
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
*/
entityEventSequence?: string | null;
accountInfo?: AccountInfoMetadata;
}
interface AccountInfoMetadata {
/** ID of the Wix account associated with the event */
accountId: string;
/** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
siteId?: string;
/** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
parentAccountId?: string;
}
interface PostLikedEnvelope {
data: PostLiked;
metadata: EventMetadata;
}
/** @permissionScope Read Blog
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
* @permissionScope Manage Blog
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
* @permissionScope Read Draft Blog Posts
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-PUBLICATION
* @webhook
* @eventType wix.blog.v3.post_liked
* @slug liked
*/
declare function onPostLiked(handler: (event: PostLikedEnvelope) => void | Promise): void;
interface PostUnlikedEnvelope {
data: PostUnliked;
metadata: EventMetadata;
}
/** @permissionScope Read Blog
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
* @permissionScope Manage Blog
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
* @permissionScope Read Draft Blog Posts
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-PUBLICATION
* @webhook
* @eventType wix.blog.v3.post_unliked
* @slug unliked
*/
declare function onPostUnliked(handler: (event: PostUnlikedEnvelope) => void | Promise): void;
interface PostCreatedEnvelope {
entity: Post;
metadata: EventMetadata;
}
/**
* Triggered when a post is created.
* @permissionScope Read Blog
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
* @permissionScope Manage Blog
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
* @permissionScope Read Draft Blog Posts
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-PUBLICATION
* @webhook
* @eventType wix.blog.v3.post_created
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
* @slug created
*/
declare function onPostCreated(handler: (event: PostCreatedEnvelope) => void | Promise): void;
interface PostDeletedEnvelope {
entity: Post;
metadata: EventMetadata;
}
/**
* Triggered when a post is deleted.
* @permissionScope Read Blog
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
* @permissionScope Manage Blog
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
* @permissionScope Read Draft Blog Posts
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-PUBLICATION
* @webhook
* @eventType wix.blog.v3.post_deleted
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
* @slug deleted
*/
declare function onPostDeleted(handler: (event: PostDeletedEnvelope) => void | Promise): void;
interface PostUpdatedEnvelope {
entity: Post;
metadata: EventMetadata;
}
/**
* Triggered when a post is updated.
* @permissionScope Read Blog
* @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
* @permissionScope Manage Blog
* @permissionScopeId SCOPE.DC-BLOG.MANAGE-BLOG
* @permissionScope Read Draft Blog Posts
* @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
* @permissionId BLOG.READ-PUBLICATION
* @webhook
* @eventType wix.blog.v3.post_updated
* @serviceIdentifier com.wixpress.npm.communities.platformized.blog.v3.PostService
* @slug updated
*/
declare function onPostUpdated(handler: (event: PostUpdatedEnvelope) => void | Promise): void;
/**
* Retrieves the number of published posts per month within a specified time range.
*
* The time range is set using the `rangeStart` and `months` properties.
* The time range always starts on the 1st day of the month set in `rangeStart` and
* includes the number of `months` following `rangeStart`.
* For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
* the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
* > Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
* @public
* @permissionId BLOG.READ-PUBLICATION
* @applicableIdentity APP
* @returns Get Blog Post Count Stats response
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.QueryPostCountStats
*/
declare function queryPostCountStats(options?: QueryPostCountStatsOptions): Promise>;
interface QueryPostCountStatsOptions {
/** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
rangeStart?: Date | null;
/**
* Order of returned results.
*
* - `OLDEST`: posts by date in ascending order.
* - `NEWEST`: posts by date in descending order.
*
* Default: `OLDEST`
*/
order?: OrderWithLiterals;
/** Number of months to include in response. */
months?: number;
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive the period post count for that specified language.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Time zone to use when calculating the start of the month.
*
* [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
* @minLength 3
* @maxLength 100
*/
timeZone?: string | null;
}
/**
* Retrieves the total amount of published posts of the blog.
* @public
* @permissionId BLOG.READ-PUBLICATION
* @applicableIdentity APP
* @fqn com.wixpress.npm.communities.platformized.blog.BlogStatsService.GetTotalPosts
*/
declare function getTotalPosts(options?: GetTotalPostsOptions): Promise>;
interface GetTotalPostsOptions {
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to receive the total amount of posts in that specified language.
* @format LANGUAGE_TAG
*/
language?: string | null;
}
/**
* Retrieves a post by the specified ID.
* @param postId - Post ID.
* @public
* @requiredField postId
* @permissionId BLOG.READ-PUBLICATION
* @applicableIdentity APP
* @returns Retrieved post info.
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
*/
declare function getPost(postId: string, options?: GetPostOptions): Promise>;
interface GetPostOptions {
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
/**
* Retrieves a post with the provided slug.
*
* The slug is the end of a post's URL that refers to a specific post.
* For example, if a post's URL is `https:/example.com/blog/post/my-post-slug`,
* the slug is `my-post-slug`. The slug is case-sensitive, and is generally derived from the post title,
* unless specified otherwise.
* @param slug - Slug of the post to retrieve.
* @public
* @requiredField slug
* @permissionId BLOG.READ-PUBLICATION
* @applicableIdentity APP
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostBySlug
*/
declare function getPostBySlug(slug: string, options?: GetPostBySlugOptions): Promise>;
interface GetPostBySlugOptions {
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
/**
* Language of the post.
* @format LANGUAGE_TAG
*/
language?: string | null;
}
/**
* Retrieves a list of up to 100 published posts per request.
*
* List Posts runs with these defaults, which you can override:
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
* - `paging.limit` is `50`.
* - `paging.offset` is `0`.
* @public
* @permissionId BLOG.READ-PUBLICATION
* @applicableIdentity APP
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.ListPosts
*/
declare function listPosts(options?: ListPostsOptions): Promise>;
interface ListPostsOptions {
/**
* Whether to return only featured posts.
*
* Default: `false`
*/
featured?: boolean;
/**
* Hashtag filter.
*
* Pass an array of hashtags to return only posts containing any of the provided hashtags.
* If omitted, all posts with or without hashtags are returned.
* @maxSize 100
* @maxLength 100
*/
hashtags?: string[];
/**
* Category filter.
*
* Pass an array of category IDs to return only posts with any of the provided categories.
* If omitted, all posts with or without associated categories are returned.
* @maxSize 50
* @maxLength 38
*/
categoryIds?: string[];
/**
* Tag filter.
*
* Pass an array of tag IDs to return only posts with any of the provided tags.
* If omitted, all posts with or without tags are returned.
* @maxSize 50
* @maxLength 38
*/
tagIds?: string[];
/**
* Sorting options.
*
* Default: `FEED`
*/
sort?: GetPostsSortWithLiterals;
/** Pagination options. */
paging?: BlogPaging;
/**
* Language filter.
*
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
* Pass a language to only receive posts that are in that language.
* If omitted, posts in all languages are returned.
* @format LANGUAGE_TAG
*/
language?: string | null;
/**
* Post owner's member ID.
* @format GUID
*/
memberId?: string | null;
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[];
}
/**
* Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
*
* Query Posts runs with these defaults, which you can override:
* - `firstPublishedDate` is sorted in descending order, with pinned posts first.
* - `paging.limit` is `50`.
* - `paging.offset` is `0`.
*
* To learn about working with _Query_ endpoints, see
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
* [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
* @public
* @permissionId BLOG.READ-PUBLICATION
* @applicableIdentity APP
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
*/
declare function queryPosts(options?: QueryPostsOptions): PostsQueryBuilder;
interface QueryPostsOptions {
/**
* List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
* the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
* only the post’s base fields are returned.
* @maxSize 20
*/
fieldsets?: PostFieldFieldWithLiterals[] | undefined;
}
interface QueryCursorResult {
cursors: Cursors;
hasNext: () => boolean;
hasPrev: () => boolean;
length: number;
pageSize: number;
}
interface PostsQueryResult extends QueryCursorResult {
items: Post[];
query: PostsQueryBuilder;
next: () => Promise;
prev: () => Promise;
}
interface PostsQueryBuilder {
/** @param propertyName - Property whose value is compared with `value`.
* @param value - Value to compare against.
*/
eq: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views' | 'media.displayed', value: any) => PostsQueryBuilder;
/** @param propertyName - Property whose value is compared with `value`.
* @param value - Value to compare against.
*/
ne: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'memberId' | 'commentingEnabled' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views' | 'media.displayed', value: any) => PostsQueryBuilder;
/** @param propertyName - Property whose value is compared with `value`.
* @param value - Value to compare against.
*/
ge: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
/** @param propertyName - Property whose value is compared with `value`.
* @param value - Value to compare against.
*/
gt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
/** @param propertyName - Property whose value is compared with `value`.
* @param value - Value to compare against.
*/
le: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
/** @param propertyName - Property whose value is compared with `value`.
* @param value - Value to compare against.
*/
lt: (propertyName: 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
/** @param propertyName - Property whose value is compared with `string`.
* @param string - String to compare against. Case-insensitive.
*/
startsWith: (propertyName: 'title', value: string) => PostsQueryBuilder;
/** @param propertyName - Property whose value is compared with `values`.
* @param values - List of values to compare against.
*/
hasSome: (propertyName: '_id' | 'title' | 'slug' | 'categoryIds' | 'memberId' | 'hashtags' | 'tagIds' | 'pricingPlanIds' | 'language', value: any[]) => PostsQueryBuilder;
/** @param propertyName - Property whose value is compared with `values`.
* @param values - List of values to compare against.
*/
hasAll: (propertyName: 'categoryIds' | 'hashtags' | 'tagIds' | 'pricingPlanIds', value: any[]) => PostsQueryBuilder;
in: (propertyName: '_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'minutesToRead' | 'translationId' | 'language' | 'metrics.comments' | 'metrics.likes' | 'metrics.views', value: any) => PostsQueryBuilder;
exists: (propertyName: 'title' | 'translationId' | 'language', value: boolean) => PostsQueryBuilder;
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
ascending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
descending: (...propertyNames: Array<'_id' | 'title' | 'firstPublishedDate' | 'lastPublishedDate' | 'slug' | 'featured' | 'pinned' | 'commentingEnabled' | 'metrics.comments' | 'metrics.likes' | 'metrics.views'>) => PostsQueryBuilder;
/** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
limit: (limit: number) => PostsQueryBuilder;
/** @param cursor - A pointer to specific record */
skipTo: (cursor: string) => PostsQueryBuilder;
find: () => Promise;
}
/**
* @hidden
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.QueryPosts
* @requiredField query
*/
declare function typedQueryPosts(query: PostQuery, options?: QueryPostsOptions): Promise>;
interface PostQuerySpec extends QuerySpec {
paging: 'cursor';
wql: [
{
fields: ['_id'];
operators: ['$eq', '$hasSome', '$in', '$ne', '$nin'];
sort: 'BOTH';
},
{
fields: ['title'];
operators: [
'$eq',
'$exists',
'$gt',
'$gte',
'$hasSome',
'$in',
'$lt',
'$lte',
'$ne',
'$startsWith'
];
sort: 'BOTH';
},
{
fields: ['firstPublishedDate'];
operators: ['$eq', '$gt', '$gte', '$in', '$lt', '$lte', '$ne'];
sort: 'BOTH';
},
{
fields: ['lastPublishedDate'];
operators: ['$eq', '$gt', '$gte', '$in', '$lt', '$lte', '$ne'];
sort: 'BOTH';
},
{
fields: ['slug'];
operators: ['$eq', '$hasAll', '$hasSome', '$ne'];
sort: 'BOTH';
},
{
fields: ['featured'];
operators: ['$eq', '$ne'];
sort: 'BOTH';
},
{
fields: ['pinned'];
operators: ['$eq', '$ne'];
sort: 'BOTH';
},
{
fields: ['categoryIds'];
operators: ['$hasAll', '$hasSome'];
sort: 'NONE';
},
{
fields: ['memberId'];
operators: ['$eq', '$hasSome', '$ne'];
sort: 'NONE';
},
{
fields: ['hashtags'];
operators: ['$hasAll', '$hasSome'];
sort: 'NONE';
},
{
fields: ['commentingEnabled'];
operators: ['$eq', '$ne'];
sort: 'BOTH';
},
{
fields: ['minutesToRead'];
operators: ['$eq', '$gt', '$gte', '$in', '$lt', '$lte', '$ne'];
sort: 'NONE';
},
{
fields: ['tagIds'];
operators: ['$hasAll', '$hasSome'];
sort: 'NONE';
},
{
fields: ['pricingPlanIds'];
operators: ['$hasAll', '$hasSome'];
sort: 'NONE';
},
{
fields: ['language'];
operators: ['$eq', '$exists', '$hasSome', '$in', '$ne'];
sort: 'NONE';
},
{
fields: ['translationId'];
operators: ['$eq', '$exists', '$in', '$ne'];
sort: 'NONE';
},
{
fields: ['metrics.views'];
operators: ['$eq', '$gt', '$gte', '$in', '$lt', '$lte', '$ne'];
sort: 'BOTH';
},
{
fields: ['metrics.comments'];
operators: ['$eq', '$gt', '$gte', '$in', '$lt', '$lte', '$ne'];
sort: 'BOTH';
},
{
fields: ['metrics.likes'];
operators: ['$eq', '$gt', '$gte', '$in', '$lt', '$lte', '$ne'];
sort: 'BOTH';
},
{
fields: ['media.displayed'];
operators: ['$eq', '$ne'];
sort: 'NONE';
}
];
}
type CommonQueryWithEntityContext = Query;
type PostQuery = {
/**
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?: {
/**
Number of items to load.
@max: 100
*/
limit?: NonNullable['limit'] | null;
/**
Pointer to the next or previous page in the list of results.
You can get the relevant cursor token
from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.
@maxLength: 2000
*/
cursor?: NonNullable['cursor'] | null;
};
/**
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?: CommonQueryWithEntityContext['filter'] | null;
/**
Sort object in the following format:
`[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
@maxSize: 3
*/
sort?: {
/**
Name of the field to sort by.
@maxLength: 512
*/
fieldName?: NonNullable[number]['fieldName'];
/**
Sort order.
*/
order?: NonNullable[number]['order'];
}[];
};
declare const utils: {
query: {
QueryBuilder: () => _wix_sdk_types.QueryBuilder;
Filter: _wix_sdk_types.FilterFactory;
Sort: _wix_sdk_types.SortFactory;
};
};
/**
* Retrieves a post's metrics.
*
* A post's metrics include the comments, likes, and views the post receives.
* @param postId - Post ID to retrieve metrics for.
* @public
* @requiredField postId
* @permissionId BLOG.READ-PUBLICATION
* @applicableIdentity APP
* @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPostMetrics
*/
declare function getPostMetrics(postId: string): Promise>;
export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, ListStyle, type ListStyleWithLiterals, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, Type, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };