@wix/auto_sdk_comments_comments 1.0.20 → 1.0.22

package/build/cjs/meta.d.ts

@@ -1,4 +1,5 @@
-import { c7 as CreateCommentRequest$1, c9 as CreateCommentResponse$1, cb as GetCommentRequest$1, cc as GetCommentResponse$1, cd as UpdateCommentRequest$1, ce as UpdateCommentResponse$1, cg as DeleteCommentRequest$1, ch as DeleteCommentResponse$1, cj as ModerateDraftContentRequest$1, a as ModerateDraftContentResponse$1, cm as QueryCommentsRequest$1, cr as QueryCommentsResponse$1, cu as MarkCommentRequest$1, c as MarkCommentResponse$1, cw as UnmarkCommentRequest$1, d as UnmarkCommentResponse$1, cy as HideCommentRequest$1, H as HideCommentResponse$1, cz as PublishCommentRequest$1, P as PublishCommentResponse$1, cA as CountCommentsRequest$1, f as CountCommentsResponse$1, cB as ListCommentsByResourceRequest$1, g as ListCommentsByResourceResponse$1, cG as GetCommentThreadRequest$1, h as GetCommentThreadResponse$1, cH as BulkPublishCommentRequest$1, i as BulkPublishCommentResponse$1, cI as BulkHideCommentRequest$1, k as BulkHideCommentResponse$1, cJ as BulkDeleteCommentRequest$1, m as BulkDeleteCommentResponse$1, cK as BulkModerateDraftContentRequest$1, o as BulkModerateDraftContentResponse$1, cL as BulkMoveCommentByFilterRequest$1, q as BulkMoveCommentByFilterResponse$1 } from './comments-v2-comment-comments.universal-kzUoSqmO.js';
+import { CreateCommentRequest as CreateCommentRequest$1, CreateCommentResponse as CreateCommentResponse$1, GetCommentRequest as GetCommentRequest$1, GetCommentResponse as GetCommentResponse$1, UpdateCommentRequest as UpdateCommentRequest$1, UpdateCommentResponse as UpdateCommentResponse$1, DeleteCommentRequest as DeleteCommentRequest$1, DeleteCommentResponse as DeleteCommentResponse$1, ModerateDraftContentRequest as ModerateDraftContentRequest$1, ModerateDraftContentResponse as ModerateDraftContentResponse$1, QueryCommentsRequest as QueryCommentsRequest$1, QueryCommentsResponse as QueryCommentsResponse$1, MarkCommentRequest as MarkCommentRequest$1, MarkCommentResponse as MarkCommentResponse$1, UnmarkCommentRequest as UnmarkCommentRequest$1, UnmarkCommentResponse as UnmarkCommentResponse$1, HideCommentRequest as HideCommentRequest$1, HideCommentResponse as HideCommentResponse$1, PublishCommentRequest as PublishCommentRequest$1, PublishCommentResponse as PublishCommentResponse$1, CountCommentsRequest as CountCommentsRequest$1, CountCommentsResponse as CountCommentsResponse$1, ListCommentsByResourceRequest as ListCommentsByResourceRequest$1, ListCommentsByResourceResponse as ListCommentsByResourceResponse$1, GetCommentThreadRequest as GetCommentThreadRequest$1, GetCommentThreadResponse as GetCommentThreadResponse$1, BulkPublishCommentRequest as BulkPublishCommentRequest$1, BulkPublishCommentResponse as BulkPublishCommentResponse$1, BulkHideCommentRequest as BulkHideCommentRequest$1, BulkHideCommentResponse as BulkHideCommentResponse$1, BulkDeleteCommentRequest as BulkDeleteCommentRequest$1, BulkDeleteCommentResponse as BulkDeleteCommentResponse$1, BulkModerateDraftContentRequest as BulkModerateDraftContentRequest$1, BulkModerateDraftContentResponse as BulkModerateDraftContentResponse$1, BulkMoveCommentByFilterRequest as BulkMoveCommentByFilterRequest$1, BulkMoveCommentByFilterResponse as BulkMoveCommentByFilterResponse$1 } from './index.typings.js';
+import '@wix/sdk-types';
 
 /**
  * A comment is a user-generated message in response to a specific resource. It allows site visitors
@@ -310,7 +311,7 @@ interface ButtonData {
     /** Styling for the button's container. */
     containerData?: PluginContainerData;
     /** The button type. */
-    type?: TypeWithLiterals;
+    type?: ButtonDataTypeWithLiterals;
     /** Styling for the button. */
     styles?: Styles;
     /** The text to display on the button. */
@@ -418,14 +419,14 @@ interface Height {
     /** A custom height value in pixels. */
     custom?: string | null;
 }
-declare enum Type {
+declare enum ButtonDataType {
     /** Regular link button */
     LINK = "LINK",
     /** Triggers custom action that is defined in plugin configuration by the consumer */
     ACTION = "ACTION"
 }
 /** @enumType */
-type TypeWithLiterals = Type | 'LINK' | 'ACTION';
+type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
 interface Styles {
     /**
      * Deprecated: Use `borderWidth` and `borderRadius` instead.
@@ -558,7 +559,7 @@ interface DividerData {
     /** Divider width. */
     width?: WidthWithLiterals;
     /** Divider alignment. */
-    alignment?: AlignmentWithLiterals;
+    alignment?: DividerDataAlignmentWithLiterals;
 }
 declare enum LineStyle {
     /** Single Line */
@@ -582,7 +583,7 @@ declare enum Width {
 }
 /** @enumType */
 type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
-declare enum Alignment {
+declare enum DividerDataAlignment {
     /** Center alignment */
     CENTER = "CENTER",
     /** Left alignment */
@@ -591,7 +592,7 @@ declare enum Alignment {
     RIGHT = "RIGHT"
 }
 /** @enumType */
-type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
+type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
 interface FileData {
     /** Styling for the file's container. */
     containerData?: PluginContainerData;
@@ -716,7 +717,7 @@ interface ItemDataOneOf {
 }
 interface GalleryOptions {
     /** Gallery layout. */
-    layout?: Layout;
+    layout?: GalleryOptionsLayout;
     /** Styling for gallery items. */
     item?: ItemStyle;
     /** Styling for gallery thumbnail images. */
@@ -776,7 +777,7 @@ declare enum ThumbnailsAlignment {
 }
 /** @enumType */
 type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
-interface Layout {
+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`. */
@@ -938,7 +939,7 @@ interface LinkPreviewData {
     /** Styling for the link preview. */
     styles?: LinkPreviewDataStyles;
 }
-declare enum Position {
+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) */
@@ -949,7 +950,7 @@ declare enum Position {
     HIDDEN = "HIDDEN"
 }
 /** @enumType */
-type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
+type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
 interface LinkPreviewDataStyles {
     /**
      * Background color as a hexadecimal value.
@@ -981,7 +982,7 @@ interface LinkPreviewDataStyles {
      */
     borderColor?: string | null;
     /** Position of thumbnail. Defaults to `START`. */
-    thumbnailPosition?: PositionWithLiterals;
+    thumbnailPosition?: StylesPositionWithLiterals;
 }
 interface MapData {
     /** Styling for the map's container. */
@@ -1226,6 +1227,10 @@ interface Decoration extends DecorationDataOneOf {
     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;
     /** The type of decoration to apply. */
     type?: DecorationTypeWithLiterals;
 }
@@ -1251,6 +1256,10 @@ interface DecorationDataOneOf {
     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;
 }
 declare enum DecorationType {
     BOLD = "BOLD",
@@ -1263,10 +1272,12 @@ declare enum DecorationType {
     COLOR = "COLOR",
     FONT_SIZE = "FONT_SIZE",
     EXTERNAL = "EXTERNAL",
-    STRIKETHROUGH = "STRIKETHROUGH"
+    STRIKETHROUGH = "STRIKETHROUGH",
+    SUPERSCRIPT = "SUPERSCRIPT",
+    SUBSCRIPT = "SUBSCRIPT"
 }
 /** @enumType */
-type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
+type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT';
 interface AnchorData {
     /** The target node's ID. */
     anchor?: string;
@@ -1325,6 +1336,32 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
     url?: string | null;
     /** An image for the embedded content. */
     image?: Media;
+    /** 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;
 }
 /** @oneof */
 interface AppEmbedDataAppDataOneOf {
@@ -1333,6 +1370,66 @@ interface AppEmbedDataAppDataOneOf {
     /** 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",
@@ -1350,6 +1447,122 @@ interface EventData {
     /** 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.
+     * @format COLOR_HEX
+     */
+    borderColor?: string | null;
+    /**
+     * Text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Background color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Border color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    borderColorHover?: string | null;
+    /**
+     * Text color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    textColorHover?: string | null;
+    /**
+     * Background color as a hexadecimal value (hover state).
+     * @format COLOR_HEX
+     */
+    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.
+     * @format COLOR_HEX
+     */
+    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.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Ribbon text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+    /**
+     * Ribbon border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    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.
+     * @format COLOR_HEX
+     */
+    backgroundColor?: string | null;
+    /**
+     * Card border color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    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.
+     * @format COLOR_HEX
+     */
+    titleColor?: string | null;
+    /**
+     * Text color as a hexadecimal value.
+     * @format COLOR_HEX
+     */
+    textColor?: string | null;
+}
 interface VideoData {
     /** Styling for the video's container. */
     containerData?: PluginContainerData;
@@ -2020,13 +2233,13 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Filter object.
      *
-     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
      */
     filter?: Record<string, any> | null;
     /**
      * Sort object.
      *
-     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -2313,7 +2526,7 @@ interface BulkPublishCommentResponse {
     /**
      * Job ID.
      *
-     * Pass this ID to Get Async Job to retrieve job details and metadata.
+     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
      * @format GUID
      */
     jobId?: string;
@@ -2331,7 +2544,7 @@ interface BulkHideCommentResponse {
     /**
      * Job ID.
      *
-     * Pass this ID to Get Async Job to retrieve job details and metadata.
+     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
      * @format GUID
      */
     jobId?: string;
@@ -2349,7 +2562,7 @@ interface BulkDeleteCommentResponse {
     /**
      * Job ID.
      *
-     * Pass this ID to Get Async Job to retrieve job details and metadata.
+     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
      * @format GUID
      */
     jobId?: string;
@@ -2369,7 +2582,7 @@ interface BulkModerateDraftContentResponse {
     /**
      * Job ID.
      *
-     * Pass this ID to Get Async Job to retrieve job details and metadata.
+     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
      * @format GUID
      */
     jobId?: string;
@@ -2401,7 +2614,7 @@ interface BulkMoveCommentByFilterResponse {
     /**
      * Job ID.
      *
-     * Pass this ID to Get Async Job to retrieve job details and metadata.
+     * Pass this ID to Get Async Job, in the Async Jobs API, to retrieve job details and metadata.
      * @format GUID
      */
     jobId?: string;