@wix/auto_sdk_comments_comments 1.0.12 → 1.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/comments-v2-comment-comments.types.d.ts +124 -58
- package/build/cjs/src/comments-v2-comment-comments.types.js.map +1 -1
- package/build/cjs/src/comments-v2-comment-comments.universal.d.ts +135 -77
- package/build/cjs/src/comments-v2-comment-comments.universal.js.map +1 -1
- package/build/es/src/comments-v2-comment-comments.types.d.ts +124 -58
- package/build/es/src/comments-v2-comment-comments.types.js.map +1 -1
- package/build/es/src/comments-v2-comment-comments.universal.d.ts +135 -77
- package/build/es/src/comments-v2-comment-comments.universal.js.map +1 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.types.d.ts +124 -58
- package/build/internal/cjs/src/comments-v2-comment-comments.types.js.map +1 -1
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.d.ts +135 -77
- package/build/internal/cjs/src/comments-v2-comment-comments.universal.js.map +1 -1
- package/build/internal/es/src/comments-v2-comment-comments.types.d.ts +124 -58
- package/build/internal/es/src/comments-v2-comment-comments.types.js.map +1 -1
- package/build/internal/es/src/comments-v2-comment-comments.universal.d.ts +135 -77
- package/build/internal/es/src/comments-v2-comment-comments.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -83,7 +83,7 @@ export interface Comment {
|
|
|
83
83
|
* Comment status.
|
|
84
84
|
* @readonly
|
|
85
85
|
*/
|
|
86
|
-
status?:
|
|
86
|
+
status?: StatusWithLiterals;
|
|
87
87
|
/**
|
|
88
88
|
* Comment rating.
|
|
89
89
|
* @readonly
|
|
@@ -194,7 +194,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
194
194
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
195
195
|
layoutCellData?: LayoutCellData;
|
|
196
196
|
/** 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. */
|
|
197
|
-
type?:
|
|
197
|
+
type?: NodeTypeWithLiterals;
|
|
198
198
|
/** Node ID. */
|
|
199
199
|
id?: string;
|
|
200
200
|
/** A list of child nodes. */
|
|
@@ -295,6 +295,8 @@ export declare enum NodeType {
|
|
|
295
295
|
LAYOUT = "LAYOUT",
|
|
296
296
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
297
297
|
}
|
|
298
|
+
/** @enumType */
|
|
299
|
+
export 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';
|
|
298
300
|
export interface NodeStyle {
|
|
299
301
|
/** The top padding value in pixels. */
|
|
300
302
|
paddingTop?: string | null;
|
|
@@ -307,7 +309,7 @@ export interface ButtonData {
|
|
|
307
309
|
/** Styling for the button's container. */
|
|
308
310
|
containerData?: PluginContainerData;
|
|
309
311
|
/** The button type. */
|
|
310
|
-
type?:
|
|
312
|
+
type?: TypeWithLiterals;
|
|
311
313
|
/** Styling for the button. */
|
|
312
314
|
styles?: Styles;
|
|
313
315
|
/** The text to display on the button. */
|
|
@@ -348,7 +350,7 @@ export interface PluginContainerData {
|
|
|
348
350
|
/** The width of the node when it's displayed. */
|
|
349
351
|
width?: PluginContainerDataWidth;
|
|
350
352
|
/** The node's alignment within its container. */
|
|
351
|
-
alignment?:
|
|
353
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
352
354
|
/** Spoiler cover settings for the node. */
|
|
353
355
|
spoiler?: Spoiler;
|
|
354
356
|
/** The height of the node when it's displayed. */
|
|
@@ -366,6 +368,8 @@ export declare enum WidthType {
|
|
|
366
368
|
/** coast-to-coast display */
|
|
367
369
|
FULL_WIDTH = "FULL_WIDTH"
|
|
368
370
|
}
|
|
371
|
+
/** @enumType */
|
|
372
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
369
373
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
370
374
|
/**
|
|
371
375
|
* One of the following predefined width options:
|
|
@@ -374,7 +378,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
374
378
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
375
379
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
376
380
|
*/
|
|
377
|
-
size?:
|
|
381
|
+
size?: WidthTypeWithLiterals;
|
|
378
382
|
/** A custom width value in pixels. */
|
|
379
383
|
custom?: string | null;
|
|
380
384
|
}
|
|
@@ -387,7 +391,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
387
391
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
388
392
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
389
393
|
*/
|
|
390
|
-
size?:
|
|
394
|
+
size?: WidthTypeWithLiterals;
|
|
391
395
|
/** A custom width value in pixels. */
|
|
392
396
|
custom?: string | null;
|
|
393
397
|
}
|
|
@@ -399,6 +403,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
399
403
|
/** Right Alignment */
|
|
400
404
|
RIGHT = "RIGHT"
|
|
401
405
|
}
|
|
406
|
+
/** @enumType */
|
|
407
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
402
408
|
export interface Spoiler {
|
|
403
409
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
404
410
|
enabled?: boolean | null;
|
|
@@ -417,6 +423,8 @@ export declare enum Type {
|
|
|
417
423
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
418
424
|
ACTION = "ACTION"
|
|
419
425
|
}
|
|
426
|
+
/** @enumType */
|
|
427
|
+
export type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
420
428
|
export interface Styles {
|
|
421
429
|
/**
|
|
422
430
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -482,7 +490,7 @@ export interface Link extends LinkDataOneOf {
|
|
|
482
490
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
483
491
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
484
492
|
*/
|
|
485
|
-
target?:
|
|
493
|
+
target?: TargetWithLiterals;
|
|
486
494
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
487
495
|
rel?: Rel;
|
|
488
496
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -505,6 +513,8 @@ export declare enum Target {
|
|
|
505
513
|
/** Opens the linked document in the full body of the window */
|
|
506
514
|
TOP = "TOP"
|
|
507
515
|
}
|
|
516
|
+
/** @enumType */
|
|
517
|
+
export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
508
518
|
export interface Rel {
|
|
509
519
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
510
520
|
nofollow?: boolean | null;
|
|
@@ -521,7 +531,7 @@ export interface CodeBlockData {
|
|
|
521
531
|
}
|
|
522
532
|
export interface TextStyle {
|
|
523
533
|
/** Text alignment. Defaults to `AUTO`. */
|
|
524
|
-
textAlignment?:
|
|
534
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
525
535
|
/** 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. */
|
|
526
536
|
lineHeight?: string | null;
|
|
527
537
|
}
|
|
@@ -537,15 +547,17 @@ export declare enum TextAlignment {
|
|
|
537
547
|
/** 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 */
|
|
538
548
|
JUSTIFY = "JUSTIFY"
|
|
539
549
|
}
|
|
550
|
+
/** @enumType */
|
|
551
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
540
552
|
export interface DividerData {
|
|
541
553
|
/** Styling for the divider's container. */
|
|
542
554
|
containerData?: PluginContainerData;
|
|
543
555
|
/** Divider line style. */
|
|
544
|
-
lineStyle?:
|
|
556
|
+
lineStyle?: LineStyleWithLiterals;
|
|
545
557
|
/** Divider width. */
|
|
546
|
-
width?:
|
|
558
|
+
width?: WidthWithLiterals;
|
|
547
559
|
/** Divider alignment. */
|
|
548
|
-
alignment?:
|
|
560
|
+
alignment?: AlignmentWithLiterals;
|
|
549
561
|
}
|
|
550
562
|
export declare enum LineStyle {
|
|
551
563
|
/** Single Line */
|
|
@@ -557,6 +569,8 @@ export declare enum LineStyle {
|
|
|
557
569
|
/** Dotted Line */
|
|
558
570
|
DOTTED = "DOTTED"
|
|
559
571
|
}
|
|
572
|
+
/** @enumType */
|
|
573
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
560
574
|
export declare enum Width {
|
|
561
575
|
/** Large line */
|
|
562
576
|
LARGE = "LARGE",
|
|
@@ -565,6 +579,8 @@ export declare enum Width {
|
|
|
565
579
|
/** Small line */
|
|
566
580
|
SMALL = "SMALL"
|
|
567
581
|
}
|
|
582
|
+
/** @enumType */
|
|
583
|
+
export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
568
584
|
export declare enum Alignment {
|
|
569
585
|
/** Center alignment */
|
|
570
586
|
CENTER = "CENTER",
|
|
@@ -573,6 +589,8 @@ export declare enum Alignment {
|
|
|
573
589
|
/** Right alignment */
|
|
574
590
|
RIGHT = "RIGHT"
|
|
575
591
|
}
|
|
592
|
+
/** @enumType */
|
|
593
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
576
594
|
export interface FileData {
|
|
577
595
|
/** Styling for the file's container. */
|
|
578
596
|
containerData?: PluginContainerData;
|
|
@@ -604,6 +622,8 @@ export declare enum ViewMode {
|
|
|
604
622
|
/** Mini PDF view */
|
|
605
623
|
MINI = "MINI"
|
|
606
624
|
}
|
|
625
|
+
/** @enumType */
|
|
626
|
+
export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
607
627
|
export interface FileSource extends FileSourceDataOneOf {
|
|
608
628
|
/** The absolute URL for the file's source. */
|
|
609
629
|
url?: string | null;
|
|
@@ -636,7 +656,7 @@ export interface PDFSettings {
|
|
|
636
656
|
* `FULL` : A full page view of the PDF is displayed.
|
|
637
657
|
* `MINI` : A mini view of the PDF is displayed.
|
|
638
658
|
*/
|
|
639
|
-
viewMode?:
|
|
659
|
+
viewMode?: ViewModeWithLiterals;
|
|
640
660
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
641
661
|
disableDownload?: boolean | null;
|
|
642
662
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -723,18 +743,24 @@ export declare enum LayoutType {
|
|
|
723
743
|
/** Fullsize images type */
|
|
724
744
|
FULLSIZE = "FULLSIZE"
|
|
725
745
|
}
|
|
746
|
+
/** @enumType */
|
|
747
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
726
748
|
export declare enum Orientation {
|
|
727
749
|
/** Rows Orientation */
|
|
728
750
|
ROWS = "ROWS",
|
|
729
751
|
/** Columns Orientation */
|
|
730
752
|
COLUMNS = "COLUMNS"
|
|
731
753
|
}
|
|
754
|
+
/** @enumType */
|
|
755
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
732
756
|
export declare enum Crop {
|
|
733
757
|
/** Crop to fill */
|
|
734
758
|
FILL = "FILL",
|
|
735
759
|
/** Crop to fit */
|
|
736
760
|
FIT = "FIT"
|
|
737
761
|
}
|
|
762
|
+
/** @enumType */
|
|
763
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
738
764
|
export declare enum ThumbnailsAlignment {
|
|
739
765
|
/** Top alignment */
|
|
740
766
|
TOP = "TOP",
|
|
@@ -747,13 +773,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
747
773
|
/** No thumbnail */
|
|
748
774
|
NONE = "NONE"
|
|
749
775
|
}
|
|
776
|
+
/** @enumType */
|
|
777
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
750
778
|
export interface Layout {
|
|
751
779
|
/** Gallery layout type. */
|
|
752
|
-
type?:
|
|
780
|
+
type?: LayoutTypeWithLiterals;
|
|
753
781
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
754
782
|
horizontalScroll?: boolean | null;
|
|
755
783
|
/** Gallery orientation. */
|
|
756
|
-
orientation?:
|
|
784
|
+
orientation?: OrientationWithLiterals;
|
|
757
785
|
/** The number of columns to display on full size screens. */
|
|
758
786
|
numberOfColumns?: number | null;
|
|
759
787
|
/** The number of columns to display on mobile screens. */
|
|
@@ -765,13 +793,13 @@ export interface ItemStyle {
|
|
|
765
793
|
/** Item ratio */
|
|
766
794
|
ratio?: number | null;
|
|
767
795
|
/** Sets how item images are cropped. */
|
|
768
|
-
crop?:
|
|
796
|
+
crop?: CropWithLiterals;
|
|
769
797
|
/** The spacing between items in pixels. */
|
|
770
798
|
spacing?: number | null;
|
|
771
799
|
}
|
|
772
800
|
export interface Thumbnails {
|
|
773
801
|
/** Thumbnail alignment. */
|
|
774
|
-
placement?:
|
|
802
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
775
803
|
/** Spacing between thumbnails in pixels. */
|
|
776
804
|
spacing?: number | null;
|
|
777
805
|
}
|
|
@@ -787,7 +815,7 @@ export interface GIFData {
|
|
|
787
815
|
/** Width in pixels. */
|
|
788
816
|
width?: number;
|
|
789
817
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
790
|
-
gifType?:
|
|
818
|
+
gifType?: GIFTypeWithLiterals;
|
|
791
819
|
}
|
|
792
820
|
export interface GIF {
|
|
793
821
|
/**
|
|
@@ -810,6 +838,8 @@ export declare enum GIFType {
|
|
|
810
838
|
NORMAL = "NORMAL",
|
|
811
839
|
STICKER = "STICKER"
|
|
812
840
|
}
|
|
841
|
+
/** @enumType */
|
|
842
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
813
843
|
export interface HeadingData {
|
|
814
844
|
/** Heading level from 1-6. */
|
|
815
845
|
level?: number;
|
|
@@ -831,7 +861,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
831
861
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
832
862
|
containerData?: PluginContainerData;
|
|
833
863
|
/** The type of HTML code. */
|
|
834
|
-
source?:
|
|
864
|
+
source?: SourceWithLiterals;
|
|
835
865
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
836
866
|
autoHeight?: boolean | null;
|
|
837
867
|
}
|
|
@@ -851,6 +881,8 @@ export declare enum Source {
|
|
|
851
881
|
HTML = "HTML",
|
|
852
882
|
ADSENSE = "ADSENSE"
|
|
853
883
|
}
|
|
884
|
+
/** @enumType */
|
|
885
|
+
export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
854
886
|
export interface ImageData {
|
|
855
887
|
/** Styling for the image's container. */
|
|
856
888
|
containerData?: PluginContainerData;
|
|
@@ -915,6 +947,8 @@ export declare enum Position {
|
|
|
915
947
|
/** Thumbnail hidden and not displayed */
|
|
916
948
|
HIDDEN = "HIDDEN"
|
|
917
949
|
}
|
|
950
|
+
/** @enumType */
|
|
951
|
+
export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
918
952
|
export interface LinkPreviewDataStyles {
|
|
919
953
|
/**
|
|
920
954
|
* Background color as a hexadecimal value.
|
|
@@ -946,7 +980,7 @@ export interface LinkPreviewDataStyles {
|
|
|
946
980
|
*/
|
|
947
981
|
borderColor?: string | null;
|
|
948
982
|
/** Position of thumbnail. Defaults to `START`. */
|
|
949
|
-
thumbnailPosition?:
|
|
983
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
950
984
|
}
|
|
951
985
|
export interface MapData {
|
|
952
986
|
/** Styling for the map's container. */
|
|
@@ -976,7 +1010,7 @@ export interface MapSettings {
|
|
|
976
1010
|
/** Initial zoom value. */
|
|
977
1011
|
initialZoom?: number | null;
|
|
978
1012
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
979
|
-
mapType?:
|
|
1013
|
+
mapType?: MapTypeWithLiterals;
|
|
980
1014
|
}
|
|
981
1015
|
export declare enum MapType {
|
|
982
1016
|
/** Roadmap map type */
|
|
@@ -988,6 +1022,8 @@ export declare enum MapType {
|
|
|
988
1022
|
/** Terrain map type */
|
|
989
1023
|
TERRAIN = "TERRAIN"
|
|
990
1024
|
}
|
|
1025
|
+
/** @enumType */
|
|
1026
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
991
1027
|
export interface ParagraphData {
|
|
992
1028
|
/** Styling for the paragraph text. */
|
|
993
1029
|
textStyle?: TextStyle;
|
|
@@ -1014,17 +1050,21 @@ export declare enum ViewRole {
|
|
|
1014
1050
|
/** Anyone can see the results, even if one didn't vote */
|
|
1015
1051
|
EVERYONE = "EVERYONE"
|
|
1016
1052
|
}
|
|
1053
|
+
/** @enumType */
|
|
1054
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1017
1055
|
export declare enum VoteRole {
|
|
1018
1056
|
/** Logged in member */
|
|
1019
1057
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1020
1058
|
/** Anyone */
|
|
1021
1059
|
ALL = "ALL"
|
|
1022
1060
|
}
|
|
1061
|
+
/** @enumType */
|
|
1062
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1023
1063
|
export interface Permissions {
|
|
1024
1064
|
/** Sets who can view the poll results. */
|
|
1025
|
-
view?:
|
|
1065
|
+
view?: ViewRoleWithLiterals;
|
|
1026
1066
|
/** Sets who can vote. */
|
|
1027
|
-
vote?:
|
|
1067
|
+
vote?: VoteRoleWithLiterals;
|
|
1028
1068
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1029
1069
|
allowMultipleVotes?: boolean | null;
|
|
1030
1070
|
}
|
|
@@ -1050,17 +1090,21 @@ export declare enum PollLayoutType {
|
|
|
1050
1090
|
/** Grid */
|
|
1051
1091
|
GRID = "GRID"
|
|
1052
1092
|
}
|
|
1093
|
+
/** @enumType */
|
|
1094
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1053
1095
|
export declare enum PollLayoutDirection {
|
|
1054
1096
|
/** Left-to-right */
|
|
1055
1097
|
LTR = "LTR",
|
|
1056
1098
|
/** Right-to-left */
|
|
1057
1099
|
RTL = "RTL"
|
|
1058
1100
|
}
|
|
1101
|
+
/** @enumType */
|
|
1102
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1059
1103
|
export interface PollLayout {
|
|
1060
1104
|
/** The layout for displaying the voting options. */
|
|
1061
|
-
type?:
|
|
1105
|
+
type?: PollLayoutTypeWithLiterals;
|
|
1062
1106
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
1063
|
-
direction?:
|
|
1107
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
1064
1108
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1065
1109
|
enableImage?: boolean | null;
|
|
1066
1110
|
}
|
|
@@ -1076,6 +1120,8 @@ export declare enum BackgroundType {
|
|
|
1076
1120
|
/** Gradiant background type */
|
|
1077
1121
|
GRADIENT = "GRADIENT"
|
|
1078
1122
|
}
|
|
1123
|
+
/** @enumType */
|
|
1124
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1079
1125
|
export interface Gradient {
|
|
1080
1126
|
/** The gradient angle in degrees. */
|
|
1081
1127
|
angle?: number | null;
|
|
@@ -1101,7 +1147,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1101
1147
|
/** Details for a gradient background. */
|
|
1102
1148
|
gradient?: Gradient;
|
|
1103
1149
|
/** Background type. For each option, include the relevant details. */
|
|
1104
|
-
type?:
|
|
1150
|
+
type?: BackgroundTypeWithLiterals;
|
|
1105
1151
|
}
|
|
1106
1152
|
/** @oneof */
|
|
1107
1153
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -1180,7 +1226,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1180
1226
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1181
1227
|
strikethroughData?: boolean | null;
|
|
1182
1228
|
/** The type of decoration to apply. */
|
|
1183
|
-
type?:
|
|
1229
|
+
type?: DecorationTypeWithLiterals;
|
|
1184
1230
|
}
|
|
1185
1231
|
/** @oneof */
|
|
1186
1232
|
export interface DecorationDataOneOf {
|
|
@@ -1218,6 +1264,8 @@ export declare enum DecorationType {
|
|
|
1218
1264
|
EXTERNAL = "EXTERNAL",
|
|
1219
1265
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1220
1266
|
}
|
|
1267
|
+
/** @enumType */
|
|
1268
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1221
1269
|
export interface AnchorData {
|
|
1222
1270
|
/** The target node's ID. */
|
|
1223
1271
|
anchor?: string;
|
|
@@ -1242,7 +1290,7 @@ export interface MentionData {
|
|
|
1242
1290
|
}
|
|
1243
1291
|
export interface FontSizeData {
|
|
1244
1292
|
/** The units used for the font size. */
|
|
1245
|
-
unit?:
|
|
1293
|
+
unit?: FontTypeWithLiterals;
|
|
1246
1294
|
/** Font size value. */
|
|
1247
1295
|
value?: number | null;
|
|
1248
1296
|
}
|
|
@@ -1250,6 +1298,8 @@ export declare enum FontType {
|
|
|
1250
1298
|
PX = "PX",
|
|
1251
1299
|
EM = "EM"
|
|
1252
1300
|
}
|
|
1301
|
+
/** @enumType */
|
|
1302
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1253
1303
|
export interface SpoilerData {
|
|
1254
1304
|
/** Spoiler ID. */
|
|
1255
1305
|
id?: string | null;
|
|
@@ -1260,7 +1310,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1260
1310
|
/** Data for embedded Wix Events content. */
|
|
1261
1311
|
eventData?: EventData;
|
|
1262
1312
|
/** The type of Wix App content being embedded. */
|
|
1263
|
-
type?:
|
|
1313
|
+
type?: AppTypeWithLiterals;
|
|
1264
1314
|
/** The ID of the embedded content. */
|
|
1265
1315
|
itemId?: string | null;
|
|
1266
1316
|
/** The name of the embedded content. */
|
|
@@ -1287,6 +1337,8 @@ export declare enum AppType {
|
|
|
1287
1337
|
EVENT = "EVENT",
|
|
1288
1338
|
BOOKING = "BOOKING"
|
|
1289
1339
|
}
|
|
1340
|
+
/** @enumType */
|
|
1341
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1290
1342
|
export interface BookingData {
|
|
1291
1343
|
/** Booking duration in minutes. */
|
|
1292
1344
|
durations?: string | null;
|
|
@@ -1365,9 +1417,9 @@ export interface CollapsibleListData {
|
|
|
1365
1417
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
1366
1418
|
expandOnlyOne?: boolean | null;
|
|
1367
1419
|
/** Sets which items are expanded when the page loads. */
|
|
1368
|
-
initialExpandedItems?:
|
|
1420
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
1369
1421
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1370
|
-
direction?:
|
|
1422
|
+
direction?: DirectionWithLiterals;
|
|
1371
1423
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1372
1424
|
isQapageData?: boolean | null;
|
|
1373
1425
|
}
|
|
@@ -1379,12 +1431,16 @@ export declare enum InitialExpandedItems {
|
|
|
1379
1431
|
/** All items collapsed initally */
|
|
1380
1432
|
NONE = "NONE"
|
|
1381
1433
|
}
|
|
1434
|
+
/** @enumType */
|
|
1435
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1382
1436
|
export declare enum Direction {
|
|
1383
1437
|
/** Left-to-right */
|
|
1384
1438
|
LTR = "LTR",
|
|
1385
1439
|
/** Right-to-left */
|
|
1386
1440
|
RTL = "RTL"
|
|
1387
1441
|
}
|
|
1442
|
+
/** @enumType */
|
|
1443
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1388
1444
|
export interface TableData {
|
|
1389
1445
|
/** Styling for the table's container. */
|
|
1390
1446
|
containerData?: PluginContainerData;
|
|
@@ -1422,9 +1478,11 @@ export declare enum VerticalAlignment {
|
|
|
1422
1478
|
/** Bottom alignment */
|
|
1423
1479
|
BOTTOM = "BOTTOM"
|
|
1424
1480
|
}
|
|
1481
|
+
/** @enumType */
|
|
1482
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1425
1483
|
export interface CellStyle {
|
|
1426
1484
|
/** Vertical alignment for the cell's text. */
|
|
1427
|
-
verticalAlignment?:
|
|
1485
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1428
1486
|
/**
|
|
1429
1487
|
* Cell background color as a hexadecimal value.
|
|
1430
1488
|
* @format COLOR_HEX
|
|
@@ -1463,6 +1521,8 @@ export declare enum NullValue {
|
|
|
1463
1521
|
/** Null value. */
|
|
1464
1522
|
NULL_VALUE = "NULL_VALUE"
|
|
1465
1523
|
}
|
|
1524
|
+
/** @enumType */
|
|
1525
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1466
1526
|
/**
|
|
1467
1527
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
1468
1528
|
*
|
|
@@ -1764,7 +1824,7 @@ export interface ParentComment {
|
|
|
1764
1824
|
* Parent comment status.
|
|
1765
1825
|
* @readonly
|
|
1766
1826
|
*/
|
|
1767
|
-
status?:
|
|
1827
|
+
status?: StatusWithLiterals;
|
|
1768
1828
|
}
|
|
1769
1829
|
export declare enum Status {
|
|
1770
1830
|
/** Unknown status. */
|
|
@@ -1778,6 +1838,8 @@ export declare enum Status {
|
|
|
1778
1838
|
/** This comment has been hidden by a site moderator. */
|
|
1779
1839
|
HIDDEN = "HIDDEN"
|
|
1780
1840
|
}
|
|
1841
|
+
/** @enumType */
|
|
1842
|
+
export type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'DELETED' | 'PENDING' | 'HIDDEN';
|
|
1781
1843
|
export interface VoteSummary {
|
|
1782
1844
|
/** Number of upvotes less downvotes on this comment. */
|
|
1783
1845
|
netVoteCount?: number;
|
|
@@ -1882,7 +1944,7 @@ export interface VersionedDocumentUpdateOperation {
|
|
|
1882
1944
|
/** documents to create or overwrite */
|
|
1883
1945
|
documents?: InternalDocument[];
|
|
1884
1946
|
/** versioning mode to use instead of default */
|
|
1885
|
-
versioningMode?:
|
|
1947
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
1886
1948
|
}
|
|
1887
1949
|
export declare enum VersioningMode {
|
|
1888
1950
|
/** use default versioning mode agreed with search team */
|
|
@@ -1892,6 +1954,8 @@ export declare enum VersioningMode {
|
|
|
1892
1954
|
/** execute only if version is greater or equal to existing */
|
|
1893
1955
|
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
1894
1956
|
}
|
|
1957
|
+
/** @enumType */
|
|
1958
|
+
export type VersioningModeWithLiterals = VersioningMode | 'DEFAULT' | 'GREATER_THAN' | 'GREATER_OR_EQUAL';
|
|
1895
1959
|
export interface VersionedDeleteByIdsOperation {
|
|
1896
1960
|
/** ids with version of the documents to delete */
|
|
1897
1961
|
documentIds?: VersionedDocumentId[];
|
|
@@ -1902,11 +1966,11 @@ export interface VersionedDocumentId {
|
|
|
1902
1966
|
/** document version */
|
|
1903
1967
|
version?: string;
|
|
1904
1968
|
/** versioning mode to use instead of default */
|
|
1905
|
-
versioningMode?:
|
|
1969
|
+
versioningMode?: VersioningModeWithLiterals;
|
|
1906
1970
|
}
|
|
1907
1971
|
export interface CommentModerated {
|
|
1908
1972
|
comment?: Comment;
|
|
1909
|
-
moderationAction?:
|
|
1973
|
+
moderationAction?: ActionWithLiterals;
|
|
1910
1974
|
}
|
|
1911
1975
|
export declare enum Action {
|
|
1912
1976
|
/** Unknown content. */
|
|
@@ -1916,6 +1980,8 @@ export declare enum Action {
|
|
|
1916
1980
|
/** Reject draft content. */
|
|
1917
1981
|
REJECT = "REJECT"
|
|
1918
1982
|
}
|
|
1983
|
+
/** @enumType */
|
|
1984
|
+
export type ActionWithLiterals = Action | 'UNKNOWN' | 'APPROVE' | 'REJECT';
|
|
1919
1985
|
export interface CreateCommentRequest {
|
|
1920
1986
|
/** Comment to create. */
|
|
1921
1987
|
comment?: Comment;
|
|
@@ -1997,7 +2063,7 @@ export interface ModerateDraftContentRequest {
|
|
|
1997
2063
|
*/
|
|
1998
2064
|
revision: string | null;
|
|
1999
2065
|
/** Draft content action. */
|
|
2000
|
-
draftContentAction?:
|
|
2066
|
+
draftContentAction?: ActionWithLiterals;
|
|
2001
2067
|
}
|
|
2002
2068
|
export interface ModerateDraftContentResponse {
|
|
2003
2069
|
/** Moderated comment. */
|
|
@@ -2058,12 +2124,14 @@ export interface Sorting {
|
|
|
2058
2124
|
*/
|
|
2059
2125
|
fieldName?: string;
|
|
2060
2126
|
/** Sort order. */
|
|
2061
|
-
order?:
|
|
2127
|
+
order?: SortOrderWithLiterals;
|
|
2062
2128
|
}
|
|
2063
2129
|
export declare enum SortOrder {
|
|
2064
2130
|
ASC = "ASC",
|
|
2065
2131
|
DESC = "DESC"
|
|
2066
2132
|
}
|
|
2133
|
+
/** @enumType */
|
|
2134
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2067
2135
|
export interface CursorPaging {
|
|
2068
2136
|
/**
|
|
2069
2137
|
* Maximum number of items to return in the results.
|
|
@@ -2208,7 +2276,7 @@ export interface ListCommentsByResourceRequest {
|
|
|
2208
2276
|
}
|
|
2209
2277
|
export interface CommentSort {
|
|
2210
2278
|
/** Sort order. */
|
|
2211
|
-
order?:
|
|
2279
|
+
order?: OrderWithLiterals;
|
|
2212
2280
|
/**
|
|
2213
2281
|
* If set to `true`, marked comments appear in the original order, and not at the top of the list.
|
|
2214
2282
|
*
|
|
@@ -2234,9 +2302,11 @@ export declare enum Order {
|
|
|
2234
2302
|
/** Comments with the lowest rating appear at the top of the list. */
|
|
2235
2303
|
RATING_ASC = "RATING_ASC"
|
|
2236
2304
|
}
|
|
2305
|
+
/** @enumType */
|
|
2306
|
+
export type OrderWithLiterals = Order | 'UNKNOWN_ORDER' | 'OLDEST_FIRST' | 'NEWEST_FIRST' | 'REACTION_COUNT' | 'NET_VOTE_COUNT' | 'RATING' | 'NET_VOTE_COUNT_ASC' | 'RATING_ASC';
|
|
2237
2307
|
export interface ReplySort {
|
|
2238
2308
|
/** Sort order. */
|
|
2239
|
-
order?:
|
|
2309
|
+
order?: ReplySortOrderWithLiterals;
|
|
2240
2310
|
/**
|
|
2241
2311
|
* Whether the marked comments are listed in the original order.
|
|
2242
2312
|
*
|
|
@@ -2256,6 +2326,8 @@ export declare enum ReplySortOrder {
|
|
|
2256
2326
|
/** Comments with the highest reaction count appear at the top of the list. */
|
|
2257
2327
|
REACTION_COUNT = "REACTION_COUNT"
|
|
2258
2328
|
}
|
|
2329
|
+
/** @enumType */
|
|
2330
|
+
export type ReplySortOrderWithLiterals = ReplySortOrder | 'UNKNOWN_ORDER' | 'OLDEST_FIRST' | 'NEWEST_FIRST' | 'REACTION_COUNT';
|
|
2259
2331
|
export interface ListCommentsByResourceCursorPaging {
|
|
2260
2332
|
/** Pointer to the next or previous page in the list of results. */
|
|
2261
2333
|
cursor?: string | null;
|
|
@@ -2374,7 +2446,7 @@ export interface BulkModerateDraftContentRequest {
|
|
|
2374
2446
|
/** Filter to identify the comment content that needs to be moderated. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
2375
2447
|
filter: Record<string, any> | null;
|
|
2376
2448
|
/** Action to do regarding draft content */
|
|
2377
|
-
draftContentAction:
|
|
2449
|
+
draftContentAction: ActionWithLiterals;
|
|
2378
2450
|
}
|
|
2379
2451
|
export interface BulkModerateDraftContentResponse {
|
|
2380
2452
|
/**
|
|
@@ -2426,25 +2498,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2426
2498
|
updatedEvent?: EntityUpdatedEvent;
|
|
2427
2499
|
deletedEvent?: EntityDeletedEvent;
|
|
2428
2500
|
actionEvent?: ActionEvent;
|
|
2429
|
-
/**
|
|
2430
|
-
* Unique event ID.
|
|
2431
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2432
|
-
*/
|
|
2501
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2433
2502
|
_id?: string;
|
|
2434
2503
|
/**
|
|
2435
|
-
*
|
|
2436
|
-
*
|
|
2504
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2505
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2437
2506
|
*/
|
|
2438
2507
|
entityFqdn?: string;
|
|
2439
2508
|
/**
|
|
2440
|
-
*
|
|
2441
|
-
*
|
|
2442
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2509
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2510
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2443
2511
|
*/
|
|
2444
2512
|
slug?: string;
|
|
2445
2513
|
/** ID of the entity associated with the event. */
|
|
2446
2514
|
entityId?: string;
|
|
2447
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
2515
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2448
2516
|
eventTime?: Date | null;
|
|
2449
2517
|
/**
|
|
2450
2518
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -2454,12 +2522,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
2454
2522
|
/** If present, indicates the action that triggered the event. */
|
|
2455
2523
|
originatedFrom?: string | null;
|
|
2456
2524
|
/**
|
|
2457
|
-
* A sequence number
|
|
2458
|
-
*
|
|
2459
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2460
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2461
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2462
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2525
|
+
* 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.
|
|
2526
|
+
* 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.
|
|
2463
2527
|
*/
|
|
2464
2528
|
entityEventSequence?: string | null;
|
|
2465
2529
|
}
|
|
@@ -2485,7 +2549,7 @@ export interface EntityUpdatedEvent {
|
|
|
2485
2549
|
currentEntity?: string;
|
|
2486
2550
|
}
|
|
2487
2551
|
export interface EntityDeletedEvent {
|
|
2488
|
-
/** Entity that was deleted */
|
|
2552
|
+
/** Entity that was deleted. */
|
|
2489
2553
|
deletedEntity?: string | null;
|
|
2490
2554
|
}
|
|
2491
2555
|
export interface ActionEvent {
|
|
@@ -2529,7 +2593,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2529
2593
|
*/
|
|
2530
2594
|
appId?: string;
|
|
2531
2595
|
/** @readonly */
|
|
2532
|
-
identityType?:
|
|
2596
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2533
2597
|
}
|
|
2534
2598
|
/** @oneof */
|
|
2535
2599
|
export interface IdentificationDataIdOneOf {
|
|
@@ -2561,6 +2625,8 @@ export declare enum WebhookIdentityType {
|
|
|
2561
2625
|
WIX_USER = "WIX_USER",
|
|
2562
2626
|
APP = "APP"
|
|
2563
2627
|
}
|
|
2628
|
+
/** @enumType */
|
|
2629
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2564
2630
|
export interface BaseEventMetadata {
|
|
2565
2631
|
/**
|
|
2566
2632
|
* App instance ID.
|
|
@@ -2576,25 +2642,21 @@ export interface BaseEventMetadata {
|
|
|
2576
2642
|
identity?: IdentificationData;
|
|
2577
2643
|
}
|
|
2578
2644
|
export interface EventMetadata extends BaseEventMetadata {
|
|
2579
|
-
/**
|
|
2580
|
-
* Unique event ID.
|
|
2581
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2582
|
-
*/
|
|
2645
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2583
2646
|
_id?: string;
|
|
2584
2647
|
/**
|
|
2585
|
-
*
|
|
2586
|
-
*
|
|
2648
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2649
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2587
2650
|
*/
|
|
2588
2651
|
entityFqdn?: string;
|
|
2589
2652
|
/**
|
|
2590
|
-
*
|
|
2591
|
-
*
|
|
2592
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2653
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2654
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2593
2655
|
*/
|
|
2594
2656
|
slug?: string;
|
|
2595
2657
|
/** ID of the entity associated with the event. */
|
|
2596
2658
|
entityId?: string;
|
|
2597
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
2659
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2598
2660
|
eventTime?: Date | null;
|
|
2599
2661
|
/**
|
|
2600
2662
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -2604,12 +2666,8 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
2604
2666
|
/** If present, indicates the action that triggered the event. */
|
|
2605
2667
|
originatedFrom?: string | null;
|
|
2606
2668
|
/**
|
|
2607
|
-
* A sequence number
|
|
2608
|
-
*
|
|
2609
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2610
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2611
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2612
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2669
|
+
* 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.
|
|
2670
|
+
* 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.
|
|
2613
2671
|
*/
|
|
2614
2672
|
entityEventSequence?: string | null;
|
|
2615
2673
|
}
|
|
@@ -2912,7 +2970,7 @@ export interface UpdateComment {
|
|
|
2912
2970
|
* Comment status.
|
|
2913
2971
|
* @readonly
|
|
2914
2972
|
*/
|
|
2915
|
-
status?:
|
|
2973
|
+
status?: StatusWithLiterals;
|
|
2916
2974
|
/**
|
|
2917
2975
|
* Comment rating.
|
|
2918
2976
|
* @readonly
|
|
@@ -2974,7 +3032,7 @@ export declare function moderateDraftContent(commentId: string, revision: string
|
|
|
2974
3032
|
}[CommentNonNullablePaths]>>;
|
|
2975
3033
|
export interface ModerateDraftContentOptions {
|
|
2976
3034
|
/** Draft content action. */
|
|
2977
|
-
draftContentAction?:
|
|
3035
|
+
draftContentAction?: ActionWithLiterals;
|
|
2978
3036
|
}
|
|
2979
3037
|
/**
|
|
2980
3038
|
* Creates a query to retrieve a list of comments.
|
|
@@ -3296,7 +3354,7 @@ export interface BulkModerateDraftContentOptions {
|
|
|
3296
3354
|
/** Filter to identify the comment content that needs to be moderated. Each key corresponds to an option name, and its values correspond to the choices for this option. For example, {`"resourceId"`: `"64ad407e0bf87891bba7de3a"`, `"parentComment.id"`: `"726cb137-a9c3-408b-9cc2-2b64c6be8a95"`}. */
|
|
3297
3355
|
filter: Record<string, any> | null;
|
|
3298
3356
|
/** Action to do regarding draft content */
|
|
3299
|
-
draftContentAction:
|
|
3357
|
+
draftContentAction: ActionWithLiterals;
|
|
3300
3358
|
}
|
|
3301
3359
|
/**
|
|
3302
3360
|
* Moves multiple comments to another resource.
|