@wix/auto_sdk_members_members-about 1.0.17 → 1.0.19

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.
Files changed (21) hide show
  1. package/build/cjs/src/members-about-v2-member-about-members-about.types.d.ts +105 -49
  2. package/build/cjs/src/members-about-v2-member-about-members-about.types.js.map +1 -1
  3. package/build/cjs/src/members-about-v2-member-about-members-about.universal.d.ts +140 -72
  4. package/build/cjs/src/members-about-v2-member-about-members-about.universal.js +21 -18
  5. package/build/cjs/src/members-about-v2-member-about-members-about.universal.js.map +1 -1
  6. package/build/es/src/members-about-v2-member-about-members-about.types.d.ts +105 -49
  7. package/build/es/src/members-about-v2-member-about-members-about.types.js.map +1 -1
  8. package/build/es/src/members-about-v2-member-about-members-about.universal.d.ts +140 -72
  9. package/build/es/src/members-about-v2-member-about-members-about.universal.js +21 -18
  10. package/build/es/src/members-about-v2-member-about-members-about.universal.js.map +1 -1
  11. package/build/internal/cjs/src/members-about-v2-member-about-members-about.types.d.ts +105 -49
  12. package/build/internal/cjs/src/members-about-v2-member-about-members-about.types.js.map +1 -1
  13. package/build/internal/cjs/src/members-about-v2-member-about-members-about.universal.d.ts +140 -72
  14. package/build/internal/cjs/src/members-about-v2-member-about-members-about.universal.js +21 -18
  15. package/build/internal/cjs/src/members-about-v2-member-about-members-about.universal.js.map +1 -1
  16. package/build/internal/es/src/members-about-v2-member-about-members-about.types.d.ts +105 -49
  17. package/build/internal/es/src/members-about-v2-member-about-members-about.types.js.map +1 -1
  18. package/build/internal/es/src/members-about-v2-member-about-members-about.universal.d.ts +140 -72
  19. package/build/internal/es/src/members-about-v2-member-about-members-about.universal.js +21 -18
  20. package/build/internal/es/src/members-about-v2-member-about-members-about.universal.js.map +1 -1
  21. package/package.json +4 -4
@@ -80,9 +80,9 @@ export interface Node extends NodeDataOneOf {
80
80
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
81
81
  layoutCellData?: LayoutCellData;
82
82
  /** 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. */
83
- type?: NodeType;
83
+ type?: NodeTypeWithLiterals;
84
84
  /** Node ID. */
85
- _id?: string;
85
+ id?: string;
86
86
  /** A list of child nodes. */
87
87
  nodes?: Node[];
88
88
  /** Padding and background color styling for the node. */
@@ -181,6 +181,8 @@ export declare enum NodeType {
181
181
  LAYOUT = "LAYOUT",
182
182
  LAYOUT_CELL = "LAYOUT_CELL"
183
183
  }
184
+ /** @enumType */
185
+ 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';
184
186
  export interface NodeStyle {
185
187
  /** The top padding value in pixels. */
186
188
  paddingTop?: string | null;
@@ -193,7 +195,7 @@ export interface ButtonData {
193
195
  /** Styling for the button's container. */
194
196
  containerData?: PluginContainerData;
195
197
  /** The button type. */
196
- type?: Type;
198
+ type?: TypeWithLiterals;
197
199
  /** Styling for the button. */
198
200
  styles?: Styles;
199
201
  /** The text to display on the button. */
@@ -234,7 +236,7 @@ export interface PluginContainerData {
234
236
  /** The width of the node when it's displayed. */
235
237
  width?: PluginContainerDataWidth;
236
238
  /** The node's alignment within its container. */
237
- alignment?: PluginContainerDataAlignment;
239
+ alignment?: PluginContainerDataAlignmentWithLiterals;
238
240
  /** Spoiler cover settings for the node. */
239
241
  spoiler?: Spoiler;
240
242
  /** The height of the node when it's displayed. */
@@ -252,6 +254,8 @@ export declare enum WidthType {
252
254
  /** coast-to-coast display */
253
255
  FULL_WIDTH = "FULL_WIDTH"
254
256
  }
257
+ /** @enumType */
258
+ export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
255
259
  export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
256
260
  /**
257
261
  * One of the following predefined width options:
@@ -260,7 +264,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
260
264
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
261
265
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
262
266
  */
263
- size?: WidthType;
267
+ size?: WidthTypeWithLiterals;
264
268
  /** A custom width value in pixels. */
265
269
  custom?: string | null;
266
270
  }
@@ -273,7 +277,7 @@ export interface PluginContainerDataWidthDataOneOf {
273
277
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
274
278
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
275
279
  */
276
- size?: WidthType;
280
+ size?: WidthTypeWithLiterals;
277
281
  /** A custom width value in pixels. */
278
282
  custom?: string | null;
279
283
  }
@@ -285,6 +289,8 @@ export declare enum PluginContainerDataAlignment {
285
289
  /** Right Alignment */
286
290
  RIGHT = "RIGHT"
287
291
  }
292
+ /** @enumType */
293
+ export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
288
294
  export interface Spoiler {
289
295
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
290
296
  enabled?: boolean | null;
@@ -303,6 +309,8 @@ export declare enum Type {
303
309
  /** Triggers custom action that is defined in plugin configuration by the consumer */
304
310
  ACTION = "ACTION"
305
311
  }
312
+ /** @enumType */
313
+ export type TypeWithLiterals = Type | 'LINK' | 'ACTION';
306
314
  export interface Styles {
307
315
  /**
308
316
  * Deprecated: Use `borderWidth` and `borderRadius` instead.
@@ -368,7 +376,7 @@ export interface Link extends LinkDataOneOf {
368
376
  * `PARENT` - Opens the linked document in the link's parent frame.
369
377
  * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
370
378
  */
371
- target?: Target;
379
+ target?: TargetWithLiterals;
372
380
  /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
373
381
  rel?: Rel;
374
382
  /** A serialized object used for a custom or external link panel. */
@@ -391,6 +399,8 @@ export declare enum Target {
391
399
  /** Opens the linked document in the full body of the window */
392
400
  TOP = "TOP"
393
401
  }
402
+ /** @enumType */
403
+ export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
394
404
  export interface Rel {
395
405
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
396
406
  nofollow?: boolean | null;
@@ -407,7 +417,7 @@ export interface CodeBlockData {
407
417
  }
408
418
  export interface TextStyle {
409
419
  /** Text alignment. Defaults to `AUTO`. */
410
- textAlignment?: TextAlignment;
420
+ textAlignment?: TextAlignmentWithLiterals;
411
421
  /** 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. */
412
422
  lineHeight?: string | null;
413
423
  }
@@ -423,15 +433,17 @@ export declare enum TextAlignment {
423
433
  /** 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 */
424
434
  JUSTIFY = "JUSTIFY"
425
435
  }
436
+ /** @enumType */
437
+ export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
426
438
  export interface DividerData {
427
439
  /** Styling for the divider's container. */
428
440
  containerData?: PluginContainerData;
429
441
  /** Divider line style. */
430
- lineStyle?: LineStyle;
442
+ lineStyle?: LineStyleWithLiterals;
431
443
  /** Divider width. */
432
- width?: Width;
444
+ width?: WidthWithLiterals;
433
445
  /** Divider alignment. */
434
- alignment?: Alignment;
446
+ alignment?: AlignmentWithLiterals;
435
447
  }
436
448
  export declare enum LineStyle {
437
449
  /** Single Line */
@@ -443,6 +455,8 @@ export declare enum LineStyle {
443
455
  /** Dotted Line */
444
456
  DOTTED = "DOTTED"
445
457
  }
458
+ /** @enumType */
459
+ export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
446
460
  export declare enum Width {
447
461
  /** Large line */
448
462
  LARGE = "LARGE",
@@ -451,6 +465,8 @@ export declare enum Width {
451
465
  /** Small line */
452
466
  SMALL = "SMALL"
453
467
  }
468
+ /** @enumType */
469
+ export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
454
470
  export declare enum Alignment {
455
471
  /** Center alignment */
456
472
  CENTER = "CENTER",
@@ -459,6 +475,8 @@ export declare enum Alignment {
459
475
  /** Right alignment */
460
476
  RIGHT = "RIGHT"
461
477
  }
478
+ /** @enumType */
479
+ export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
462
480
  export interface FileData {
463
481
  /** Styling for the file's container. */
464
482
  containerData?: PluginContainerData;
@@ -490,6 +508,8 @@ export declare enum ViewMode {
490
508
  /** Mini PDF view */
491
509
  MINI = "MINI"
492
510
  }
511
+ /** @enumType */
512
+ export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
493
513
  export interface FileSource extends FileSourceDataOneOf {
494
514
  /** The absolute URL for the file's source. */
495
515
  url?: string | null;
@@ -499,7 +519,7 @@ export interface FileSource extends FileSourceDataOneOf {
499
519
  */
500
520
  custom?: string | null;
501
521
  /** An ID that's resolved to a URL by a resolver function. */
502
- _id?: string | null;
522
+ id?: string | null;
503
523
  /** Indicates whether the file's source is private. Defaults to `false`. */
504
524
  private?: boolean | null;
505
525
  }
@@ -513,7 +533,7 @@ export interface FileSourceDataOneOf {
513
533
  */
514
534
  custom?: string | null;
515
535
  /** An ID that's resolved to a URL by a resolver function. */
516
- _id?: string | null;
536
+ id?: string | null;
517
537
  }
518
538
  export interface PDFSettings {
519
539
  /**
@@ -522,7 +542,7 @@ export interface PDFSettings {
522
542
  * `FULL` : A full page view of the PDF is displayed.
523
543
  * `MINI` : A mini view of the PDF is displayed.
524
544
  */
525
- viewMode?: ViewMode;
545
+ viewMode?: ViewModeWithLiterals;
526
546
  /** Sets whether the PDF download button is disabled. Defaults to `false`. */
527
547
  disableDownload?: boolean | null;
528
548
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
@@ -609,18 +629,24 @@ export declare enum LayoutType {
609
629
  /** Fullsize images type */
610
630
  FULLSIZE = "FULLSIZE"
611
631
  }
632
+ /** @enumType */
633
+ export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
612
634
  export declare enum Orientation {
613
635
  /** Rows Orientation */
614
636
  ROWS = "ROWS",
615
637
  /** Columns Orientation */
616
638
  COLUMNS = "COLUMNS"
617
639
  }
640
+ /** @enumType */
641
+ export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
618
642
  export declare enum Crop {
619
643
  /** Crop to fill */
620
644
  FILL = "FILL",
621
645
  /** Crop to fit */
622
646
  FIT = "FIT"
623
647
  }
648
+ /** @enumType */
649
+ export type CropWithLiterals = Crop | 'FILL' | 'FIT';
624
650
  export declare enum ThumbnailsAlignment {
625
651
  /** Top alignment */
626
652
  TOP = "TOP",
@@ -633,13 +659,15 @@ export declare enum ThumbnailsAlignment {
633
659
  /** No thumbnail */
634
660
  NONE = "NONE"
635
661
  }
662
+ /** @enumType */
663
+ export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
636
664
  export interface Layout {
637
665
  /** Gallery layout type. */
638
- type?: LayoutType;
666
+ type?: LayoutTypeWithLiterals;
639
667
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
640
668
  horizontalScroll?: boolean | null;
641
669
  /** Gallery orientation. */
642
- orientation?: Orientation;
670
+ orientation?: OrientationWithLiterals;
643
671
  /** The number of columns to display on full size screens. */
644
672
  numberOfColumns?: number | null;
645
673
  /** The number of columns to display on mobile screens. */
@@ -651,13 +679,13 @@ export interface ItemStyle {
651
679
  /** Item ratio */
652
680
  ratio?: number | null;
653
681
  /** Sets how item images are cropped. */
654
- crop?: Crop;
682
+ crop?: CropWithLiterals;
655
683
  /** The spacing between items in pixels. */
656
684
  spacing?: number | null;
657
685
  }
658
686
  export interface Thumbnails {
659
687
  /** Thumbnail alignment. */
660
- placement?: ThumbnailsAlignment;
688
+ placement?: ThumbnailsAlignmentWithLiterals;
661
689
  /** Spacing between thumbnails in pixels. */
662
690
  spacing?: number | null;
663
691
  }
@@ -673,7 +701,7 @@ export interface GIFData {
673
701
  /** Width in pixels. */
674
702
  width?: number;
675
703
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
676
- gifType?: GIFType;
704
+ gifType?: GIFTypeWithLiterals;
677
705
  }
678
706
  export interface GIF {
679
707
  /**
@@ -696,6 +724,8 @@ export declare enum GIFType {
696
724
  NORMAL = "NORMAL",
697
725
  STICKER = "STICKER"
698
726
  }
727
+ /** @enumType */
728
+ export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
699
729
  export interface HeadingData {
700
730
  /** Heading level from 1-6. */
701
731
  level?: number;
@@ -717,7 +747,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
717
747
  /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
718
748
  containerData?: PluginContainerData;
719
749
  /** The type of HTML code. */
720
- source?: Source;
750
+ source?: SourceWithLiterals;
721
751
  /** If container height is aligned with its content height. Defaults to `true`. */
722
752
  autoHeight?: boolean | null;
723
753
  }
@@ -737,6 +767,8 @@ export declare enum Source {
737
767
  HTML = "HTML",
738
768
  ADSENSE = "ADSENSE"
739
769
  }
770
+ /** @enumType */
771
+ export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
740
772
  export interface ImageData {
741
773
  /** Styling for the image's container. */
742
774
  containerData?: PluginContainerData;
@@ -801,6 +833,8 @@ export declare enum Position {
801
833
  /** Thumbnail hidden and not displayed */
802
834
  HIDDEN = "HIDDEN"
803
835
  }
836
+ /** @enumType */
837
+ export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
804
838
  export interface LinkPreviewDataStyles {
805
839
  /**
806
840
  * Background color as a hexadecimal value.
@@ -832,7 +866,7 @@ export interface LinkPreviewDataStyles {
832
866
  */
833
867
  borderColor?: string | null;
834
868
  /** Position of thumbnail. Defaults to `START`. */
835
- thumbnailPosition?: Position;
869
+ thumbnailPosition?: PositionWithLiterals;
836
870
  }
837
871
  export interface MapData {
838
872
  /** Styling for the map's container. */
@@ -862,7 +896,7 @@ export interface MapSettings {
862
896
  /** Initial zoom value. */
863
897
  initialZoom?: number | null;
864
898
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
865
- mapType?: MapType;
899
+ mapType?: MapTypeWithLiterals;
866
900
  }
867
901
  export declare enum MapType {
868
902
  /** Roadmap map type */
@@ -874,6 +908,8 @@ export declare enum MapType {
874
908
  /** Terrain map type */
875
909
  TERRAIN = "TERRAIN"
876
910
  }
911
+ /** @enumType */
912
+ export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
877
913
  export interface ParagraphData {
878
914
  /** Styling for the paragraph text. */
879
915
  textStyle?: TextStyle;
@@ -900,23 +936,27 @@ export declare enum ViewRole {
900
936
  /** Anyone can see the results, even if one didn't vote */
901
937
  EVERYONE = "EVERYONE"
902
938
  }
939
+ /** @enumType */
940
+ export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
903
941
  export declare enum VoteRole {
904
942
  /** Logged in member */
905
943
  SITE_MEMBERS = "SITE_MEMBERS",
906
944
  /** Anyone */
907
945
  ALL = "ALL"
908
946
  }
947
+ /** @enumType */
948
+ export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
909
949
  export interface Permissions {
910
950
  /** Sets who can view the poll results. */
911
- view?: ViewRole;
951
+ view?: ViewRoleWithLiterals;
912
952
  /** Sets who can vote. */
913
- vote?: VoteRole;
953
+ vote?: VoteRoleWithLiterals;
914
954
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
915
955
  allowMultipleVotes?: boolean | null;
916
956
  }
917
957
  export interface Option {
918
958
  /** Option ID. */
919
- _id?: string | null;
959
+ id?: string | null;
920
960
  /** Option title. */
921
961
  title?: string | null;
922
962
  /** The image displayed with the option. */
@@ -936,17 +976,21 @@ export declare enum PollLayoutType {
936
976
  /** Grid */
937
977
  GRID = "GRID"
938
978
  }
979
+ /** @enumType */
980
+ export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
939
981
  export declare enum PollLayoutDirection {
940
982
  /** Left-to-right */
941
983
  LTR = "LTR",
942
984
  /** Right-to-left */
943
985
  RTL = "RTL"
944
986
  }
987
+ /** @enumType */
988
+ export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
945
989
  export interface PollLayout {
946
990
  /** The layout for displaying the voting options. */
947
- type?: PollLayoutType;
991
+ type?: PollLayoutTypeWithLiterals;
948
992
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
949
- direction?: PollLayoutDirection;
993
+ direction?: PollLayoutDirectionWithLiterals;
950
994
  /** Sets whether to display the main poll image. Defaults to `false`. */
951
995
  enableImage?: boolean | null;
952
996
  }
@@ -962,6 +1006,8 @@ export declare enum BackgroundType {
962
1006
  /** Gradiant background type */
963
1007
  GRADIENT = "GRADIENT"
964
1008
  }
1009
+ /** @enumType */
1010
+ export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
965
1011
  export interface Gradient {
966
1012
  /** The gradient angle in degrees. */
967
1013
  angle?: number | null;
@@ -987,7 +1033,7 @@ export interface Background extends BackgroundBackgroundOneOf {
987
1033
  /** Details for a gradient background. */
988
1034
  gradient?: Gradient;
989
1035
  /** Background type. For each option, include the relevant details. */
990
- type?: BackgroundType;
1036
+ type?: BackgroundTypeWithLiterals;
991
1037
  }
992
1038
  /** @oneof */
993
1039
  export interface BackgroundBackgroundOneOf {
@@ -1013,7 +1059,7 @@ export interface OptionDesign {
1013
1059
  }
1014
1060
  export interface Poll {
1015
1061
  /** Poll ID. */
1016
- _id?: string | null;
1062
+ id?: string | null;
1017
1063
  /** Poll title. */
1018
1064
  title?: string | null;
1019
1065
  /** Poll creator ID. */
@@ -1066,7 +1112,7 @@ export interface Decoration extends DecorationDataOneOf {
1066
1112
  /** Data for a strikethrough decoration. Defaults to `true`. */
1067
1113
  strikethroughData?: boolean | null;
1068
1114
  /** The type of decoration to apply. */
1069
- type?: DecorationType;
1115
+ type?: DecorationTypeWithLiterals;
1070
1116
  }
1071
1117
  /** @oneof */
1072
1118
  export interface DecorationDataOneOf {
@@ -1104,6 +1150,8 @@ export declare enum DecorationType {
1104
1150
  EXTERNAL = "EXTERNAL",
1105
1151
  STRIKETHROUGH = "STRIKETHROUGH"
1106
1152
  }
1153
+ /** @enumType */
1154
+ export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
1107
1155
  export interface AnchorData {
1108
1156
  /** The target node's ID. */
1109
1157
  anchor?: string;
@@ -1124,11 +1172,11 @@ export interface MentionData {
1124
1172
  /** The version of the user's name that appears after the `@` character in the mention. */
1125
1173
  slug?: string;
1126
1174
  /** Mentioned user's ID. */
1127
- _id?: string | null;
1175
+ id?: string | null;
1128
1176
  }
1129
1177
  export interface FontSizeData {
1130
1178
  /** The units used for the font size. */
1131
- unit?: FontType;
1179
+ unit?: FontTypeWithLiterals;
1132
1180
  /** Font size value. */
1133
1181
  value?: number | null;
1134
1182
  }
@@ -1136,9 +1184,11 @@ export declare enum FontType {
1136
1184
  PX = "PX",
1137
1185
  EM = "EM"
1138
1186
  }
1187
+ /** @enumType */
1188
+ export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1139
1189
  export interface SpoilerData {
1140
1190
  /** Spoiler ID. */
1141
- _id?: string | null;
1191
+ id?: string | null;
1142
1192
  }
1143
1193
  export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1144
1194
  /** Data for embedded Wix Bookings content. */
@@ -1146,7 +1196,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1146
1196
  /** Data for embedded Wix Events content. */
1147
1197
  eventData?: EventData;
1148
1198
  /** The type of Wix App content being embedded. */
1149
- type?: AppType;
1199
+ type?: AppTypeWithLiterals;
1150
1200
  /** The ID of the embedded content. */
1151
1201
  itemId?: string | null;
1152
1202
  /** The name of the embedded content. */
@@ -1173,6 +1223,8 @@ export declare enum AppType {
1173
1223
  EVENT = "EVENT",
1174
1224
  BOOKING = "BOOKING"
1175
1225
  }
1226
+ /** @enumType */
1227
+ export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
1176
1228
  export interface BookingData {
1177
1229
  /** Booking duration in minutes. */
1178
1230
  durations?: string | null;
@@ -1251,9 +1303,9 @@ export interface CollapsibleListData {
1251
1303
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1252
1304
  expandOnlyOne?: boolean | null;
1253
1305
  /** Sets which items are expanded when the page loads. */
1254
- initialExpandedItems?: InitialExpandedItems;
1306
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
1255
1307
  /** The direction of the text in the list. Either left-to-right or right-to-left. */
1256
- direction?: Direction;
1308
+ direction?: DirectionWithLiterals;
1257
1309
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
1258
1310
  isQapageData?: boolean | null;
1259
1311
  }
@@ -1265,12 +1317,16 @@ export declare enum InitialExpandedItems {
1265
1317
  /** All items collapsed initally */
1266
1318
  NONE = "NONE"
1267
1319
  }
1320
+ /** @enumType */
1321
+ export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
1268
1322
  export declare enum Direction {
1269
1323
  /** Left-to-right */
1270
1324
  LTR = "LTR",
1271
1325
  /** Right-to-left */
1272
1326
  RTL = "RTL"
1273
1327
  }
1328
+ /** @enumType */
1329
+ export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
1274
1330
  export interface TableData {
1275
1331
  /** Styling for the table's container. */
1276
1332
  containerData?: PluginContainerData;
@@ -1308,9 +1364,11 @@ export declare enum VerticalAlignment {
1308
1364
  /** Bottom alignment */
1309
1365
  BOTTOM = "BOTTOM"
1310
1366
  }
1367
+ /** @enumType */
1368
+ export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1311
1369
  export interface CellStyle {
1312
1370
  /** Vertical alignment for the cell's text. */
1313
- verticalAlignment?: VerticalAlignment;
1371
+ verticalAlignment?: VerticalAlignmentWithLiterals;
1314
1372
  /**
1315
1373
  * Cell background color as a hexadecimal value.
1316
1374
  * @format COLOR_HEX
@@ -1349,6 +1407,8 @@ export declare enum NullValue {
1349
1407
  /** Null value. */
1350
1408
  NULL_VALUE = "NULL_VALUE"
1351
1409
  }
1410
+ /** @enumType */
1411
+ export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
1352
1412
  /**
1353
1413
  * `ListValue` is a wrapper around a repeated field of values.
1354
1414
  *
@@ -1517,7 +1577,7 @@ export interface Sorting {
1517
1577
  /** Name of the field to sort by. */
1518
1578
  fieldName?: string;
1519
1579
  /** Sort order. */
1520
- order?: SortOrder;
1580
+ order?: SortOrderWithLiterals;
1521
1581
  }
1522
1582
  export declare enum SortOrder {
1523
1583
  /** Sort is in ascending order. */
@@ -1525,6 +1585,8 @@ export declare enum SortOrder {
1525
1585
  /** Sort is in the descending order. */
1526
1586
  DESC = "DESC"
1527
1587
  }
1588
+ /** @enumType */
1589
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1528
1590
  export interface CursorPaging {
1529
1591
  /**
1530
1592
  * Number of items to load.
@@ -1576,25 +1638,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1576
1638
  updatedEvent?: EntityUpdatedEvent;
1577
1639
  deletedEvent?: EntityDeletedEvent;
1578
1640
  actionEvent?: ActionEvent;
1579
- /**
1580
- * Unique event ID.
1581
- * Allows clients to ignore duplicate webhooks.
1582
- */
1641
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1583
1642
  _id?: string;
1584
1643
  /**
1585
- * Assumes actions are also always typed to an entity_type
1586
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1644
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1645
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1587
1646
  */
1588
1647
  entityFqdn?: string;
1589
1648
  /**
1590
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1591
- * This is although the created/updated/deleted notion is duplication of the oneof types
1592
- * Example: created/updated/deleted/started/completed/email_opened
1649
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1650
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1593
1651
  */
1594
1652
  slug?: string;
1595
1653
  /** ID of the entity associated with the event. */
1596
1654
  entityId?: string;
1597
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1655
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1598
1656
  eventTime?: Date | null;
1599
1657
  /**
1600
1658
  * Whether the event was triggered as a result of a privacy regulation application
@@ -1604,12 +1662,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1604
1662
  /** If present, indicates the action that triggered the event. */
1605
1663
  originatedFrom?: string | null;
1606
1664
  /**
1607
- * A sequence number defining the order of updates to the underlying entity.
1608
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1609
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1610
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1611
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1612
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1665
+ * 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.
1666
+ * 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.
1613
1667
  */
1614
1668
  entityEventSequence?: string | null;
1615
1669
  }
@@ -1635,7 +1689,7 @@ export interface EntityUpdatedEvent {
1635
1689
  currentEntity?: string;
1636
1690
  }
1637
1691
  export interface EntityDeletedEvent {
1638
- /** Entity that was deleted */
1692
+ /** Entity that was deleted. */
1639
1693
  deletedEntity?: string | null;
1640
1694
  }
1641
1695
  export interface ActionEvent {
@@ -1679,7 +1733,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1679
1733
  */
1680
1734
  appId?: string;
1681
1735
  /** @readonly */
1682
- identityType?: WebhookIdentityType;
1736
+ identityType?: WebhookIdentityTypeWithLiterals;
1683
1737
  }
1684
1738
  /** @oneof */
1685
1739
  export interface IdentificationDataIdOneOf {
@@ -1711,6 +1765,8 @@ export declare enum WebhookIdentityType {
1711
1765
  WIX_USER = "WIX_USER",
1712
1766
  APP = "APP"
1713
1767
  }
1768
+ /** @enumType */
1769
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1714
1770
  export interface BaseEventMetadata {
1715
1771
  /**
1716
1772
  * App instance ID.
@@ -1726,25 +1782,21 @@ export interface BaseEventMetadata {
1726
1782
  identity?: IdentificationData;
1727
1783
  }
1728
1784
  export interface EventMetadata extends BaseEventMetadata {
1729
- /**
1730
- * Unique event ID.
1731
- * Allows clients to ignore duplicate webhooks.
1732
- */
1785
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1733
1786
  _id?: string;
1734
1787
  /**
1735
- * Assumes actions are also always typed to an entity_type
1736
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1788
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1789
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1737
1790
  */
1738
1791
  entityFqdn?: string;
1739
1792
  /**
1740
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1741
- * This is although the created/updated/deleted notion is duplication of the oneof types
1742
- * Example: created/updated/deleted/started/completed/email_opened
1793
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1794
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1743
1795
  */
1744
1796
  slug?: string;
1745
1797
  /** ID of the entity associated with the event. */
1746
1798
  entityId?: string;
1747
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1799
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1748
1800
  eventTime?: Date | null;
1749
1801
  /**
1750
1802
  * Whether the event was triggered as a result of a privacy regulation application
@@ -1754,12 +1806,8 @@ export interface EventMetadata extends BaseEventMetadata {
1754
1806
  /** If present, indicates the action that triggered the event. */
1755
1807
  originatedFrom?: string | null;
1756
1808
  /**
1757
- * A sequence number defining the order of updates to the underlying entity.
1758
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1759
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1760
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1761
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1762
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1809
+ * 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.
1810
+ * 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.
1763
1811
  */
1764
1812
  entityEventSequence?: string | null;
1765
1813
  }
@@ -2001,6 +2049,26 @@ export interface MemberAboutsQueryBuilder {
2001
2049
  * @documentationMaturity preview
2002
2050
  */
2003
2051
  ne: (propertyName: '_id' | 'memberId', value: any) => MemberAboutsQueryBuilder;
2052
+ /** @param propertyName - Property whose value is compared with `value`.
2053
+ * @param value - Value to compare against.
2054
+ * @documentationMaturity preview
2055
+ */
2056
+ ge: (propertyName: '_id' | 'memberId', value: any) => MemberAboutsQueryBuilder;
2057
+ /** @param propertyName - Property whose value is compared with `value`.
2058
+ * @param value - Value to compare against.
2059
+ * @documentationMaturity preview
2060
+ */
2061
+ gt: (propertyName: '_id' | 'memberId', value: any) => MemberAboutsQueryBuilder;
2062
+ /** @param propertyName - Property whose value is compared with `value`.
2063
+ * @param value - Value to compare against.
2064
+ * @documentationMaturity preview
2065
+ */
2066
+ le: (propertyName: '_id' | 'memberId', value: any) => MemberAboutsQueryBuilder;
2067
+ /** @param propertyName - Property whose value is compared with `value`.
2068
+ * @param value - Value to compare against.
2069
+ * @documentationMaturity preview
2070
+ */
2071
+ lt: (propertyName: '_id' | 'memberId', value: any) => MemberAboutsQueryBuilder;
2004
2072
  /** @param propertyName - Property whose value is compared with `string`.
2005
2073
  * @param string - String to compare against. Case-insensitive.
2006
2074
  * @documentationMaturity preview