@wix/auto_sdk_blog_posts 1.0.26 → 1.0.28

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 (45) hide show
  1. package/build/cjs/src/blog-v3-post-posts.http.d.ts +19 -21
  2. package/build/cjs/src/blog-v3-post-posts.http.js +19 -21
  3. package/build/cjs/src/blog-v3-post-posts.http.js.map +1 -1
  4. package/build/cjs/src/blog-v3-post-posts.public.d.ts +22 -29
  5. package/build/cjs/src/blog-v3-post-posts.public.js +5 -5
  6. package/build/cjs/src/blog-v3-post-posts.public.js.map +1 -1
  7. package/build/cjs/src/blog-v3-post-posts.types.d.ts +134 -52
  8. package/build/cjs/src/blog-v3-post-posts.types.js.map +1 -1
  9. package/build/cjs/src/blog-v3-post-posts.universal.d.ts +161 -88
  10. package/build/cjs/src/blog-v3-post-posts.universal.js +24 -31
  11. package/build/cjs/src/blog-v3-post-posts.universal.js.map +1 -1
  12. package/build/es/src/blog-v3-post-posts.http.d.ts +19 -21
  13. package/build/es/src/blog-v3-post-posts.http.js +19 -21
  14. package/build/es/src/blog-v3-post-posts.http.js.map +1 -1
  15. package/build/es/src/blog-v3-post-posts.public.d.ts +22 -29
  16. package/build/es/src/blog-v3-post-posts.public.js +5 -5
  17. package/build/es/src/blog-v3-post-posts.public.js.map +1 -1
  18. package/build/es/src/blog-v3-post-posts.types.d.ts +134 -52
  19. package/build/es/src/blog-v3-post-posts.types.js.map +1 -1
  20. package/build/es/src/blog-v3-post-posts.universal.d.ts +161 -88
  21. package/build/es/src/blog-v3-post-posts.universal.js +24 -31
  22. package/build/es/src/blog-v3-post-posts.universal.js.map +1 -1
  23. package/build/internal/cjs/src/blog-v3-post-posts.http.d.ts +19 -21
  24. package/build/internal/cjs/src/blog-v3-post-posts.http.js +19 -21
  25. package/build/internal/cjs/src/blog-v3-post-posts.http.js.map +1 -1
  26. package/build/internal/cjs/src/blog-v3-post-posts.public.d.ts +22 -29
  27. package/build/internal/cjs/src/blog-v3-post-posts.public.js +5 -5
  28. package/build/internal/cjs/src/blog-v3-post-posts.public.js.map +1 -1
  29. package/build/internal/cjs/src/blog-v3-post-posts.types.d.ts +134 -52
  30. package/build/internal/cjs/src/blog-v3-post-posts.types.js.map +1 -1
  31. package/build/internal/cjs/src/blog-v3-post-posts.universal.d.ts +161 -88
  32. package/build/internal/cjs/src/blog-v3-post-posts.universal.js +24 -31
  33. package/build/internal/cjs/src/blog-v3-post-posts.universal.js.map +1 -1
  34. package/build/internal/es/src/blog-v3-post-posts.http.d.ts +19 -21
  35. package/build/internal/es/src/blog-v3-post-posts.http.js +19 -21
  36. package/build/internal/es/src/blog-v3-post-posts.http.js.map +1 -1
  37. package/build/internal/es/src/blog-v3-post-posts.public.d.ts +22 -29
  38. package/build/internal/es/src/blog-v3-post-posts.public.js +5 -5
  39. package/build/internal/es/src/blog-v3-post-posts.public.js.map +1 -1
  40. package/build/internal/es/src/blog-v3-post-posts.types.d.ts +134 -52
  41. package/build/internal/es/src/blog-v3-post-posts.types.js.map +1 -1
  42. package/build/internal/es/src/blog-v3-post-posts.universal.d.ts +161 -88
  43. package/build/internal/es/src/blog-v3-post-posts.universal.js +24 -31
  44. package/build/internal/es/src/blog-v3-post-posts.universal.js.map +1 -1
  45. package/package.json +3 -3
@@ -373,7 +373,7 @@ export interface Node extends NodeDataOneOf {
373
373
  /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
374
374
  layoutCellData?: LayoutCellData;
375
375
  /** 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. */
376
- type?: NodeType;
376
+ type?: NodeTypeWithLiterals;
377
377
  /** Node ID. */
378
378
  id?: string;
379
379
  /** A list of child nodes. */
@@ -474,6 +474,8 @@ export declare enum NodeType {
474
474
  LAYOUT = "LAYOUT",
475
475
  LAYOUT_CELL = "LAYOUT_CELL"
476
476
  }
477
+ /** @enumType */
478
+ 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';
477
479
  export interface NodeStyle {
478
480
  /** The top padding value in pixels. */
479
481
  paddingTop?: string | null;
@@ -486,7 +488,7 @@ export interface ButtonData {
486
488
  /** Styling for the button's container. */
487
489
  containerData?: PluginContainerData;
488
490
  /** The button type. */
489
- type?: Type;
491
+ type?: TypeWithLiterals;
490
492
  /** Styling for the button. */
491
493
  styles?: Styles;
492
494
  /** The text to display on the button. */
@@ -512,7 +514,7 @@ export interface PluginContainerData {
512
514
  /** The width of the node when it's displayed. */
513
515
  width?: PluginContainerDataWidth;
514
516
  /** The node's alignment within its container. */
515
- alignment?: PluginContainerDataAlignment;
517
+ alignment?: PluginContainerDataAlignmentWithLiterals;
516
518
  /** Spoiler cover settings for the node. */
517
519
  spoiler?: Spoiler;
518
520
  /** The height of the node when it's displayed. */
@@ -530,6 +532,8 @@ export declare enum WidthType {
530
532
  /** coast-to-coast display */
531
533
  FULL_WIDTH = "FULL_WIDTH"
532
534
  }
535
+ /** @enumType */
536
+ export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
533
537
  export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
534
538
  /**
535
539
  * One of the following predefined width options:
@@ -538,7 +542,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
538
542
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
539
543
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
540
544
  */
541
- size?: WidthType;
545
+ size?: WidthTypeWithLiterals;
542
546
  /** A custom width value in pixels. */
543
547
  custom?: string | null;
544
548
  }
@@ -551,7 +555,7 @@ export interface PluginContainerDataWidthDataOneOf {
551
555
  * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
552
556
  * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
553
557
  */
554
- size?: WidthType;
558
+ size?: WidthTypeWithLiterals;
555
559
  /** A custom width value in pixels. */
556
560
  custom?: string | null;
557
561
  }
@@ -563,6 +567,8 @@ export declare enum PluginContainerDataAlignment {
563
567
  /** Right Alignment */
564
568
  RIGHT = "RIGHT"
565
569
  }
570
+ /** @enumType */
571
+ export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
566
572
  export interface Spoiler {
567
573
  /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
568
574
  enabled?: boolean | null;
@@ -581,6 +587,8 @@ export declare enum Type {
581
587
  /** Triggers custom action that is defined in plugin configuration by the consumer */
582
588
  ACTION = "ACTION"
583
589
  }
590
+ /** @enumType */
591
+ export type TypeWithLiterals = Type | 'LINK' | 'ACTION';
584
592
  export interface Styles {
585
593
  /** Border attributes. */
586
594
  border?: Border;
@@ -599,7 +607,7 @@ export interface Link extends LinkDataOneOf {
599
607
  * `PARENT` - Opens the linked document in the link's parent frame.
600
608
  * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
601
609
  */
602
- target?: Target;
610
+ target?: TargetWithLiterals;
603
611
  /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
604
612
  rel?: Rel;
605
613
  /** A serialized object used for a custom or external link panel. */
@@ -622,6 +630,8 @@ export declare enum Target {
622
630
  /** Opens the linked document in the full body of the window */
623
631
  TOP = "TOP"
624
632
  }
633
+ /** @enumType */
634
+ export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
625
635
  export interface Rel {
626
636
  /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
627
637
  nofollow?: boolean | null;
@@ -638,7 +648,7 @@ export interface CodeBlockData {
638
648
  }
639
649
  export interface TextStyle {
640
650
  /** Text alignment. Defaults to `AUTO`. */
641
- textAlignment?: TextAlignment;
651
+ textAlignment?: TextAlignmentWithLiterals;
642
652
  /** 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. */
643
653
  lineHeight?: string | null;
644
654
  }
@@ -654,15 +664,17 @@ export declare enum TextAlignment {
654
664
  /** 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 */
655
665
  JUSTIFY = "JUSTIFY"
656
666
  }
667
+ /** @enumType */
668
+ export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
657
669
  export interface DividerData {
658
670
  /** Styling for the divider's container. */
659
671
  containerData?: PluginContainerData;
660
672
  /** Divider line style. */
661
- lineStyle?: LineStyle;
673
+ lineStyle?: LineStyleWithLiterals;
662
674
  /** Divider width. */
663
- width?: Width;
675
+ width?: WidthWithLiterals;
664
676
  /** Divider alignment. */
665
- alignment?: Alignment;
677
+ alignment?: AlignmentWithLiterals;
666
678
  }
667
679
  export declare enum LineStyle {
668
680
  /** Single Line */
@@ -674,6 +686,8 @@ export declare enum LineStyle {
674
686
  /** Dotted Line */
675
687
  DOTTED = "DOTTED"
676
688
  }
689
+ /** @enumType */
690
+ export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
677
691
  export declare enum Width {
678
692
  /** Large line */
679
693
  LARGE = "LARGE",
@@ -682,6 +696,8 @@ export declare enum Width {
682
696
  /** Small line */
683
697
  SMALL = "SMALL"
684
698
  }
699
+ /** @enumType */
700
+ export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
685
701
  export declare enum Alignment {
686
702
  /** Center alignment */
687
703
  CENTER = "CENTER",
@@ -690,6 +706,8 @@ export declare enum Alignment {
690
706
  /** Right alignment */
691
707
  RIGHT = "RIGHT"
692
708
  }
709
+ /** @enumType */
710
+ export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
693
711
  export interface FileData {
694
712
  /** Styling for the file's container. */
695
713
  containerData?: PluginContainerData;
@@ -721,6 +739,8 @@ export declare enum ViewMode {
721
739
  /** Mini PDF view */
722
740
  MINI = "MINI"
723
741
  }
742
+ /** @enumType */
743
+ export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
724
744
  export interface FileSource extends FileSourceDataOneOf {
725
745
  /** The absolute URL for the file's source. */
726
746
  url?: string | null;
@@ -753,7 +773,7 @@ export interface PDFSettings {
753
773
  * `FULL` : A full page view of the PDF is displayed.
754
774
  * `MINI` : A mini view of the PDF is displayed.
755
775
  */
756
- viewMode?: ViewMode;
776
+ viewMode?: ViewModeWithLiterals;
757
777
  /** Sets whether the PDF download button is disabled. Defaults to `false`. */
758
778
  disableDownload?: boolean | null;
759
779
  /** Sets whether the PDF print button is disabled. Defaults to `false`. */
@@ -840,18 +860,24 @@ export declare enum LayoutType {
840
860
  /** Fullsize images type */
841
861
  FULLSIZE = "FULLSIZE"
842
862
  }
863
+ /** @enumType */
864
+ export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
843
865
  export declare enum Orientation {
844
866
  /** Rows Orientation */
845
867
  ROWS = "ROWS",
846
868
  /** Columns Orientation */
847
869
  COLUMNS = "COLUMNS"
848
870
  }
871
+ /** @enumType */
872
+ export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
849
873
  export declare enum Crop {
850
874
  /** Crop to fill */
851
875
  FILL = "FILL",
852
876
  /** Crop to fit */
853
877
  FIT = "FIT"
854
878
  }
879
+ /** @enumType */
880
+ export type CropWithLiterals = Crop | 'FILL' | 'FIT';
855
881
  export declare enum ThumbnailsAlignment {
856
882
  /** Top alignment */
857
883
  TOP = "TOP",
@@ -864,13 +890,15 @@ export declare enum ThumbnailsAlignment {
864
890
  /** No thumbnail */
865
891
  NONE = "NONE"
866
892
  }
893
+ /** @enumType */
894
+ export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
867
895
  export interface Layout {
868
896
  /** Gallery layout type. */
869
- type?: LayoutType;
897
+ type?: LayoutTypeWithLiterals;
870
898
  /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
871
899
  horizontalScroll?: boolean | null;
872
900
  /** Gallery orientation. */
873
- orientation?: Orientation;
901
+ orientation?: OrientationWithLiterals;
874
902
  /** The number of columns to display on full size screens. */
875
903
  numberOfColumns?: number | null;
876
904
  /** The number of columns to display on mobile screens. */
@@ -882,13 +910,13 @@ export interface ItemStyle {
882
910
  /** Item ratio */
883
911
  ratio?: number | null;
884
912
  /** Sets how item images are cropped. */
885
- crop?: Crop;
913
+ crop?: CropWithLiterals;
886
914
  /** The spacing between items in pixels. */
887
915
  spacing?: number | null;
888
916
  }
889
917
  export interface Thumbnails {
890
918
  /** Thumbnail alignment. */
891
- placement?: ThumbnailsAlignment;
919
+ placement?: ThumbnailsAlignmentWithLiterals;
892
920
  /** Spacing between thumbnails in pixels. */
893
921
  spacing?: number | null;
894
922
  }
@@ -904,7 +932,7 @@ export interface GIFData {
904
932
  /** Width in pixels. */
905
933
  width?: number;
906
934
  /** Type of GIF (Sticker or GIF). Defaults to `GIF`. */
907
- gifType?: GIFType;
935
+ gifType?: GIFTypeWithLiterals;
908
936
  }
909
937
  export interface GIF {
910
938
  /**
@@ -927,6 +955,8 @@ export declare enum GIFType {
927
955
  GIF = "GIF",
928
956
  STICKER = "STICKER"
929
957
  }
958
+ /** @enumType */
959
+ export type GIFTypeWithLiterals = GIFType | 'GIF' | 'STICKER';
930
960
  export interface HeadingData {
931
961
  /** Heading level from 1-6. */
932
962
  level?: number;
@@ -948,7 +978,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
948
978
  /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
949
979
  containerData?: PluginContainerData;
950
980
  /** The type of HTML code. */
951
- source?: Source;
981
+ source?: SourceWithLiterals;
952
982
  /** If container height is aligned with its content height. Defaults to `true`. */
953
983
  autoHeight?: boolean | null;
954
984
  }
@@ -968,6 +998,8 @@ export declare enum Source {
968
998
  HTML = "HTML",
969
999
  ADSENSE = "ADSENSE"
970
1000
  }
1001
+ /** @enumType */
1002
+ export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
971
1003
  export interface ImageData {
972
1004
  /** Styling for the image's container. */
973
1005
  containerData?: PluginContainerData;
@@ -1026,6 +1058,8 @@ export declare enum Position {
1026
1058
  /** Thumbnail hidden and not displayed */
1027
1059
  HIDDEN = "HIDDEN"
1028
1060
  }
1061
+ /** @enumType */
1062
+ export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
1029
1063
  export interface LinkPreviewDataStyles {
1030
1064
  /**
1031
1065
  * Background color as a hexadecimal value.
@@ -1057,7 +1091,7 @@ export interface LinkPreviewDataStyles {
1057
1091
  */
1058
1092
  borderColor?: string | null;
1059
1093
  /** Position of thumbnail. Defaults to `START`. */
1060
- thumbnailPosition?: Position;
1094
+ thumbnailPosition?: PositionWithLiterals;
1061
1095
  }
1062
1096
  export interface MapData {
1063
1097
  /** Styling for the map's container. */
@@ -1087,7 +1121,7 @@ export interface MapSettings {
1087
1121
  /** Initial zoom value. */
1088
1122
  initialZoom?: number | null;
1089
1123
  /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
1090
- mapType?: MapType;
1124
+ mapType?: MapTypeWithLiterals;
1091
1125
  }
1092
1126
  export declare enum MapType {
1093
1127
  /** Roadmap map type */
@@ -1099,6 +1133,8 @@ export declare enum MapType {
1099
1133
  /** Terrain map type */
1100
1134
  TERRAIN = "TERRAIN"
1101
1135
  }
1136
+ /** @enumType */
1137
+ export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
1102
1138
  export interface ParagraphData {
1103
1139
  /** Styling for the paragraph text. */
1104
1140
  textStyle?: TextStyle;
@@ -1125,17 +1161,21 @@ export declare enum ViewRole {
1125
1161
  /** Anyone can see the results, even if one didn't vote */
1126
1162
  EVERYONE = "EVERYONE"
1127
1163
  }
1164
+ /** @enumType */
1165
+ export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
1128
1166
  export declare enum VoteRole {
1129
1167
  /** Logged in member */
1130
1168
  SITE_MEMBERS = "SITE_MEMBERS",
1131
1169
  /** Anyone */
1132
1170
  ALL = "ALL"
1133
1171
  }
1172
+ /** @enumType */
1173
+ export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
1134
1174
  export interface Permissions {
1135
1175
  /** Sets who can view the poll results. */
1136
- view?: ViewRole;
1176
+ view?: ViewRoleWithLiterals;
1137
1177
  /** Sets who can vote. */
1138
- vote?: VoteRole;
1178
+ vote?: VoteRoleWithLiterals;
1139
1179
  /** Sets whether one voter can vote multiple times. Defaults to `false`. */
1140
1180
  allowMultipleVotes?: boolean | null;
1141
1181
  }
@@ -1161,17 +1201,21 @@ export declare enum PollLayoutType {
1161
1201
  /** Grid */
1162
1202
  GRID = "GRID"
1163
1203
  }
1204
+ /** @enumType */
1205
+ export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
1164
1206
  export declare enum PollLayoutDirection {
1165
1207
  /** Left-to-right */
1166
1208
  LTR = "LTR",
1167
1209
  /** Right-to-left */
1168
1210
  RTL = "RTL"
1169
1211
  }
1212
+ /** @enumType */
1213
+ export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
1170
1214
  export interface PollLayout {
1171
1215
  /** The layout for displaying the voting options. */
1172
- type?: PollLayoutType;
1216
+ type?: PollLayoutTypeWithLiterals;
1173
1217
  /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
1174
- direction?: PollLayoutDirection;
1218
+ direction?: PollLayoutDirectionWithLiterals;
1175
1219
  /** Sets whether to display the main poll image. Defaults to `false`. */
1176
1220
  enableImage?: boolean | null;
1177
1221
  }
@@ -1187,6 +1231,8 @@ export declare enum BackgroundType {
1187
1231
  /** Gradiant background type */
1188
1232
  GRADIENT = "GRADIENT"
1189
1233
  }
1234
+ /** @enumType */
1235
+ export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1190
1236
  export interface Gradient {
1191
1237
  /** The gradient angle in degrees. */
1192
1238
  angle?: number | null;
@@ -1212,7 +1258,7 @@ export interface Background extends BackgroundBackgroundOneOf {
1212
1258
  /** Details for a gradient background. */
1213
1259
  gradient?: Gradient;
1214
1260
  /** Background type. For each option, include the relevant details. */
1215
- type?: BackgroundType;
1261
+ type?: BackgroundTypeWithLiterals;
1216
1262
  }
1217
1263
  /** @oneof */
1218
1264
  export interface BackgroundBackgroundOneOf {
@@ -1289,7 +1335,7 @@ export interface Decoration extends DecorationDataOneOf {
1289
1335
  /** Data for a spoiler decoration. */
1290
1336
  spoilerData?: SpoilerData;
1291
1337
  /** The type of decoration to apply. */
1292
- type?: DecorationType;
1338
+ type?: DecorationTypeWithLiterals;
1293
1339
  }
1294
1340
  /** @oneof */
1295
1341
  export interface DecorationDataOneOf {
@@ -1324,6 +1370,8 @@ export declare enum DecorationType {
1324
1370
  FONT_SIZE = "FONT_SIZE",
1325
1371
  EXTERNAL = "EXTERNAL"
1326
1372
  }
1373
+ /** @enumType */
1374
+ export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL';
1327
1375
  export interface AnchorData {
1328
1376
  /** The target node's ID. */
1329
1377
  anchor?: string;
@@ -1348,7 +1396,7 @@ export interface MentionData {
1348
1396
  }
1349
1397
  export interface FontSizeData {
1350
1398
  /** The units used for the font size. */
1351
- unit?: FontType;
1399
+ unit?: FontTypeWithLiterals;
1352
1400
  /** Font size value. */
1353
1401
  value?: number | null;
1354
1402
  }
@@ -1356,6 +1404,8 @@ export declare enum FontType {
1356
1404
  PX = "PX",
1357
1405
  EM = "EM"
1358
1406
  }
1407
+ /** @enumType */
1408
+ export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
1359
1409
  export interface SpoilerData {
1360
1410
  /** Spoiler ID. */
1361
1411
  id?: string | null;
@@ -1366,7 +1416,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1366
1416
  /** Data for embedded Wix Events content. */
1367
1417
  eventData?: EventData;
1368
1418
  /** The type of Wix App content being embedded. */
1369
- type?: AppType;
1419
+ type?: AppTypeWithLiterals;
1370
1420
  /** The ID of the embedded content. */
1371
1421
  itemId?: string | null;
1372
1422
  /** The name of the embedded content. */
@@ -1393,6 +1443,8 @@ export declare enum AppType {
1393
1443
  EVENT = "EVENT",
1394
1444
  BOOKING = "BOOKING"
1395
1445
  }
1446
+ /** @enumType */
1447
+ export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
1396
1448
  export interface BookingData {
1397
1449
  /** Booking duration in minutes. */
1398
1450
  durations?: string | null;
@@ -1471,9 +1523,9 @@ export interface CollapsibleListData {
1471
1523
  /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
1472
1524
  expandOnlyOne?: boolean | null;
1473
1525
  /** Sets which items are expanded when the page loads. */
1474
- initialExpandedItems?: InitialExpandedItems;
1526
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
1475
1527
  /** The direction of the text in the list. Either left-to-right or right-to-left. */
1476
- direction?: Direction;
1528
+ direction?: DirectionWithLiterals;
1477
1529
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
1478
1530
  isQapageData?: boolean | null;
1479
1531
  }
@@ -1485,12 +1537,16 @@ export declare enum InitialExpandedItems {
1485
1537
  /** All items collapsed initally */
1486
1538
  NONE = "NONE"
1487
1539
  }
1540
+ /** @enumType */
1541
+ export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
1488
1542
  export declare enum Direction {
1489
1543
  /** Left-to-right */
1490
1544
  LTR = "LTR",
1491
1545
  /** Right-to-left */
1492
1546
  RTL = "RTL"
1493
1547
  }
1548
+ /** @enumType */
1549
+ export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
1494
1550
  export interface TableData {
1495
1551
  /** Styling for the table's container. */
1496
1552
  containerData?: PluginContainerData;
@@ -1528,9 +1584,11 @@ export declare enum VerticalAlignment {
1528
1584
  /** Bottom alignment */
1529
1585
  BOTTOM = "BOTTOM"
1530
1586
  }
1587
+ /** @enumType */
1588
+ export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
1531
1589
  export interface CellStyle {
1532
1590
  /** Vertical alignment for the cell's text. */
1533
- verticalAlignment?: VerticalAlignment;
1591
+ verticalAlignment?: VerticalAlignmentWithLiterals;
1534
1592
  /**
1535
1593
  * Cell background color as a hexadecimal value.
1536
1594
  * @format COLOR_HEX
@@ -1569,6 +1627,8 @@ export declare enum NullValue {
1569
1627
  /** Null value. */
1570
1628
  NULL_VALUE = "NULL_VALUE"
1571
1629
  }
1630
+ /** @enumType */
1631
+ export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
1572
1632
  /**
1573
1633
  * `ListValue` is a wrapper around a repeated field of values.
1574
1634
  *
@@ -1673,7 +1733,7 @@ export interface ModerationDetails {
1673
1733
  /** Date the post was submitted for review. */
1674
1734
  submittedDate?: Date | null;
1675
1735
  /** Status indicating whether the submission was approved or rejected by the moderator. */
1676
- status?: ModerationStatusStatus;
1736
+ status?: ModerationStatusStatusWithLiterals;
1677
1737
  /**
1678
1738
  * Member ID of the person who approved or rejected the post.
1679
1739
  * @format GUID
@@ -1687,6 +1747,8 @@ export declare enum ModerationStatusStatus {
1687
1747
  APPROVED = "APPROVED",
1688
1748
  REJECTED = "REJECTED"
1689
1749
  }
1750
+ /** @enumType */
1751
+ export type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
1690
1752
  export interface Media extends MediaMediaOneOf {
1691
1753
  /** Wix Media details. */
1692
1754
  wixMedia?: WixMedia;
@@ -1827,7 +1889,7 @@ export interface QueryPublicationsCountStatsRequest {
1827
1889
  /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
1828
1890
  rangeEnd?: Date | null;
1829
1891
  /** Order of the returned results. */
1830
- order?: QueryPublicationsCountStatsRequestOrder;
1892
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
1831
1893
  /** Number of months to include in the response. */
1832
1894
  months?: number;
1833
1895
  /**
@@ -1849,6 +1911,8 @@ export declare enum QueryPublicationsCountStatsRequestOrder {
1849
1911
  OLDEST = "OLDEST",
1850
1912
  NEWEST = "NEWEST"
1851
1913
  }
1914
+ /** @enumType */
1915
+ export type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
1852
1916
  /** Get Blog Publications Count Stats response */
1853
1917
  export interface QueryPublicationsCountStatsResponse {
1854
1918
  /** Chronologically ordered list of publications. */
@@ -1873,7 +1937,7 @@ export interface QueryPostCountStatsRequest {
1873
1937
  *
1874
1938
  * Default: `OLDEST`
1875
1939
  */
1876
- order?: Order;
1940
+ order?: OrderWithLiterals;
1877
1941
  /** Number of months to include in response. */
1878
1942
  months?: number;
1879
1943
  /**
@@ -1898,6 +1962,8 @@ export declare enum Order {
1898
1962
  OLDEST = "OLDEST",
1899
1963
  NEWEST = "NEWEST"
1900
1964
  }
1965
+ /** @enumType */
1966
+ export type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
1901
1967
  /** Get Blog Post Count Stats response */
1902
1968
  export interface QueryPostCountStatsResponse {
1903
1969
  /** List of published post counts by month. */
@@ -2044,7 +2110,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
2044
2110
  */
2045
2111
  appId?: string;
2046
2112
  /** @readonly */
2047
- identityType?: WebhookIdentityType;
2113
+ identityType?: WebhookIdentityTypeWithLiterals;
2048
2114
  }
2049
2115
  /** @oneof */
2050
2116
  export interface IdentificationDataIdOneOf {
@@ -2076,6 +2142,8 @@ export declare enum WebhookIdentityType {
2076
2142
  WIX_USER = "WIX_USER",
2077
2143
  APP = "APP"
2078
2144
  }
2145
+ /** @enumType */
2146
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2079
2147
  export interface ListTemplatesRequest {
2080
2148
  /**
2081
2149
  * Filter post templates by given template category ids
@@ -2091,7 +2159,7 @@ export interface ListTemplatesRequest {
2091
2159
  /** Returns post template categories when set to TRUE */
2092
2160
  listTemplateCategories?: boolean;
2093
2161
  /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2094
- sort?: GetPostTemplatesSort;
2162
+ sort?: GetPostTemplatesSortWithLiterals;
2095
2163
  /** Pagination options. */
2096
2164
  paging?: BlogPaging;
2097
2165
  }
@@ -2101,6 +2169,8 @@ export declare enum GetPostTemplatesSort {
2101
2169
  /** Sort by descending publishing date. */
2102
2170
  PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2103
2171
  }
2172
+ /** @enumType */
2173
+ export type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2104
2174
  export interface BlogPaging {
2105
2175
  /**
2106
2176
  * Number of items to skip in the current sort order.
@@ -2347,7 +2417,7 @@ export interface DraftPost {
2347
2417
  * Status of the draft post.
2348
2418
  * @readonly
2349
2419
  */
2350
- status?: Status;
2420
+ status?: StatusWithLiterals;
2351
2421
  /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
2352
2422
  moderationDetails?: ModerationDetails;
2353
2423
  /**
@@ -2462,6 +2532,8 @@ export declare enum Origin {
2462
2532
  /** Saved automatically by AI tool. */
2463
2533
  AI_AUTO_SAVE = "AI_AUTO_SAVE"
2464
2534
  }
2535
+ /** @enumType */
2536
+ export type OriginWithLiterals = Origin | 'UNKNOWN' | 'ADMIN' | 'ADD_CATEGORIES' | 'AUTO_SAVE' | 'COPY_TEMPLATE' | 'IMPORT' | 'IMPORT_BULK' | 'IMPORT_HTML' | 'IMPORT_PATCH' | 'LANGUAGE_CHANGE' | 'MANUAL_SAVE' | 'MIGRATION' | 'MODERATION' | 'MOVE_TO_TRASH' | 'PRICING_PLANS_CHANGE' | 'PROVISION' | 'PUBLISH' | 'REASSIGN_OWNER' | 'REBLOG' | 'RESTORE' | 'REVERT_TO_DRAFT' | 'TRANSLATION' | 'UNPUBLISH' | 'UNSCHEDULE' | 'NEW_EDIT_SESSION' | 'SCHEDULING_SERVICE_SCHEDULE' | 'SCHEDULING_SERVICE_UNSCHEDULE' | 'SCHEDULING_SERVICE_PUBLISH' | 'SCHEDULE' | 'REMOVE_FROM_MODERATION' | 'REJECT_FROM_MODERATION' | 'APPROVE_IN_MODERATION' | 'DELETE_TAG' | 'PIN' | 'UNPIN' | 'AI_AUTO_SAVE';
2465
2537
  export declare enum Status {
2466
2538
  UNKNOWN = "UNKNOWN",
2467
2539
  /** Status indicating the draft post is published. */
@@ -2475,6 +2547,8 @@ export declare enum Status {
2475
2547
  /** Status indicating the draft post is in review. */
2476
2548
  IN_REVIEW = "IN_REVIEW"
2477
2549
  }
2550
+ /** @enumType */
2551
+ export type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
2478
2552
  export interface DraftPostTranslation {
2479
2553
  /**
2480
2554
  * Post ID.
@@ -2482,7 +2556,7 @@ export interface DraftPostTranslation {
2482
2556
  */
2483
2557
  _id?: string;
2484
2558
  /** Post status. */
2485
- status?: Status;
2559
+ status?: StatusWithLiterals;
2486
2560
  /**
2487
2561
  * Language the post is written in.
2488
2562
  * @format LANGUAGE_TAG
@@ -2586,7 +2660,7 @@ export interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
2586
2660
  */
2587
2661
  postId?: string;
2588
2662
  /** Field of the updated counter. */
2589
- updatedCounterField?: Field;
2663
+ updatedCounterField?: FieldWithLiterals;
2590
2664
  /** New counter value. */
2591
2665
  counter?: number;
2592
2666
  }
@@ -2615,6 +2689,8 @@ export declare enum Field {
2615
2689
  /** Rating count field. */
2616
2690
  RATING_COUNT = "RATING_COUNT"
2617
2691
  }
2692
+ /** @enumType */
2693
+ export type FieldWithLiterals = Field | 'UNKNOWN' | 'TOTAL_COMMENTS' | 'LIKE_COUNT' | 'VIEW_COUNT' | 'RATING_COUNT';
2618
2694
  export interface PostOwnerChanged {
2619
2695
  }
2620
2696
  export interface InitialPostsCopied {
@@ -2634,7 +2710,7 @@ export interface GetPostRequest {
2634
2710
  * only the post’s base fields are returned.
2635
2711
  * @maxSize 20
2636
2712
  */
2637
- fieldsets?: PostFieldField[];
2713
+ fieldsets?: PostFieldFieldWithLiterals[];
2638
2714
  }
2639
2715
  export declare enum PostFieldField {
2640
2716
  UNKNOWN = "UNKNOWN",
@@ -2653,6 +2729,8 @@ export declare enum PostFieldField {
2653
2729
  /** Includes post reference ID field. */
2654
2730
  REFERENCE_ID = "REFERENCE_ID"
2655
2731
  }
2732
+ /** @enumType */
2733
+ export type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
2656
2734
  export interface GetPostResponse {
2657
2735
  /** Retrieved post info. */
2658
2736
  post?: Post;
@@ -2670,7 +2748,7 @@ export interface GetPostBySlugRequest {
2670
2748
  * only the post’s base fields are returned.
2671
2749
  * @maxSize 20
2672
2750
  */
2673
- fieldsets?: PostFieldField[];
2751
+ fieldsets?: PostFieldFieldWithLiterals[];
2674
2752
  }
2675
2753
  export interface GetPostBySlugResponse {
2676
2754
  /** Retrieved post info. */
@@ -2715,7 +2793,7 @@ export interface ListPostsRequest {
2715
2793
  *
2716
2794
  * Default: `FEED`
2717
2795
  */
2718
- sort?: GetPostsSort;
2796
+ sort?: GetPostsSortWithLiterals;
2719
2797
  /** Pagination options. */
2720
2798
  paging?: BlogPaging;
2721
2799
  /**
@@ -2738,7 +2816,7 @@ export interface ListPostsRequest {
2738
2816
  * only the post’s base fields are returned.
2739
2817
  * @maxSize 20
2740
2818
  */
2741
- fieldsets?: PostFieldField[];
2819
+ fieldsets?: PostFieldFieldWithLiterals[];
2742
2820
  }
2743
2821
  export declare enum GetPostsSort {
2744
2822
  /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
@@ -2756,6 +2834,8 @@ export declare enum GetPostsSort {
2756
2834
  /** Ordered by `title` in descending order. */
2757
2835
  TITLE_DESC = "TITLE_DESC"
2758
2836
  }
2837
+ /** @enumType */
2838
+ export type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
2759
2839
  export interface ListPostsResponse {
2760
2840
  /** List of retrieved posts. */
2761
2841
  posts?: Post[];
@@ -2771,7 +2851,7 @@ export interface QueryPostsRequest {
2771
2851
  * only the post’s base fields are returned.
2772
2852
  * @maxSize 20
2773
2853
  */
2774
- fieldsets?: PostFieldField[];
2854
+ fieldsets?: PostFieldFieldWithLiterals[];
2775
2855
  }
2776
2856
  export interface Sorting {
2777
2857
  /**
@@ -2780,12 +2860,14 @@ export interface Sorting {
2780
2860
  */
2781
2861
  fieldName?: string;
2782
2862
  /** Sort order. */
2783
- order?: SortOrder;
2863
+ order?: SortOrderWithLiterals;
2784
2864
  }
2785
2865
  export declare enum SortOrder {
2786
2866
  ASC = "ASC",
2787
2867
  DESC = "DESC"
2788
2868
  }
2869
+ /** @enumType */
2870
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2789
2871
  export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2790
2872
  /** Paging options to limit and skip the number of items. */
2791
2873
  paging?: Paging;
@@ -2918,7 +3000,7 @@ export interface LikePostRequest {
2918
3000
  * only the post’s base fields are returned.
2919
3001
  * @maxSize 20
2920
3002
  */
2921
- fieldsets?: PostFieldField[];
3003
+ fieldsets?: PostFieldFieldWithLiterals[];
2922
3004
  }
2923
3005
  export interface LikePostResponse {
2924
3006
  /** Post info. */
@@ -2937,7 +3019,7 @@ export interface UnlikePostRequest {
2937
3019
  * only the post’s base fields are returned.
2938
3020
  * @maxSize 20
2939
3021
  */
2940
- fieldsets?: PostFieldField[];
3022
+ fieldsets?: PostFieldFieldWithLiterals[];
2941
3023
  }
2942
3024
  export interface UnlikePostResponse {
2943
3025
  /** Post info. */
@@ -2956,7 +3038,7 @@ export interface PinPostRequest {
2956
3038
  * only the post’s base fields are returned.
2957
3039
  * @maxSize 20
2958
3040
  */
2959
- fieldsets?: PostFieldField[];
3041
+ fieldsets?: PostFieldFieldWithLiterals[];
2960
3042
  }
2961
3043
  export interface PinPostResponse {
2962
3044
  /** Post info. */
@@ -2975,7 +3057,7 @@ export interface UnpinPostRequest {
2975
3057
  * only the post’s base fields are returned.
2976
3058
  * @maxSize 20
2977
3059
  */
2978
- fieldsets?: PostFieldField[];
3060
+ fieldsets?: PostFieldFieldWithLiterals[];
2979
3061
  }
2980
3062
  export interface UnpinPostResponse {
2981
3063
  /** Post info. */
@@ -3016,7 +3098,7 @@ export interface ListPostsArchiveRequest {
3016
3098
  * only the post’s base fields are returned.
3017
3099
  * @maxSize 20
3018
3100
  */
3019
- fieldsets?: PostFieldField[];
3101
+ fieldsets?: PostFieldFieldWithLiterals[];
3020
3102
  }
3021
3103
  export interface ListPostsArchiveResponse {
3022
3104
  /** List of posts. */
@@ -3093,7 +3175,7 @@ export interface ListDemoPostsRequest {
3093
3175
  *
3094
3176
  * Default: `FEED`
3095
3177
  */
3096
- sort?: GetPostsSort;
3178
+ sort?: GetPostsSortWithLiterals;
3097
3179
  /** Pagination options. */
3098
3180
  paging?: BlogPaging;
3099
3181
  /**
@@ -3109,7 +3191,7 @@ export interface ListDemoPostsRequest {
3109
3191
  * @replacedBy fieldsets
3110
3192
  * @targetRemovalDate 2024-06-30
3111
3193
  */
3112
- fieldsToInclude?: PostFieldField[];
3194
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3113
3195
  /**
3114
3196
  * Language filter.
3115
3197
  *
@@ -3130,7 +3212,7 @@ export interface ListDemoPostsRequest {
3130
3212
  * only the post’s base fields are returned.
3131
3213
  * @maxSize 20
3132
3214
  */
3133
- fieldsets?: PostFieldField[];
3215
+ fieldsets?: PostFieldFieldWithLiterals[];
3134
3216
  }
3135
3217
  export interface ListDemoPostsResponse {
3136
3218
  /** List of posts. */
@@ -3323,15 +3405,14 @@ type PostNonNullablePaths = `_id` | `title` | `excerpt` | `slug` | `featured` |
3323
3405
  /**
3324
3406
  * Retrieves the number of published posts per month within a specified time range.
3325
3407
  *
3326
- *
3327
- * The `queryPostCountStats()` function returns a Promise that resolves to the number of posts per month within the specified time range.
3328
- *
3329
- * You can set the time range using the `rangeStart` and `months` properties. The time range always starts on the 1st day of the month set in `rangeStart` and includes the number of `months` following `rangeStart`. For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`, the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range ends on the last day of the month.
3330
- *
3331
- * >**Note:** If there are no published posts in a specific month, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
3408
+ * The time range is set using the `rangeStart` and `months` properties.
3409
+ * The time range always starts on the 1st day of the month set in `rangeStart` and
3410
+ * includes the number of `months` following `rangeStart`.
3411
+ * For example, if `rangeStart` is set to `'2022-03-13'` and `months` is set to `4`,
3412
+ * the time range will be from `'2022-03-01'` until `'2022-06-30'`. The time range always ends on the last day of the month.
3413
+ * > Note: If there are no published posts in a month within the time range, that month is not included in the response. For example, let's say a blog has `0` posts dated in February 2022. If `rangeStart` is set to `'2022-01-01'` and `months` is set to `3`, the response includes `postCount` values for January and March, but not February.
3332
3414
  * @public
3333
3415
  * @documentationMaturity preview
3334
- * @param options - Options specifying time frame, sort, and filter.
3335
3416
  * @permissionId BLOG.READ-PUBLICATION
3336
3417
  * @permissionScope Read Blog
3337
3418
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3356,7 +3437,7 @@ export interface QueryPostCountStatsOptions {
3356
3437
  *
3357
3438
  * Default: `OLDEST`
3358
3439
  */
3359
- order?: Order;
3440
+ order?: OrderWithLiterals;
3360
3441
  /** Number of months to include in response. */
3361
3442
  months?: number;
3362
3443
  /**
@@ -3380,7 +3461,6 @@ export interface QueryPostCountStatsOptions {
3380
3461
  * Retrieves the total amount of published posts of the blog.
3381
3462
  * @public
3382
3463
  * @documentationMaturity preview
3383
- * @param options - Language Options.
3384
3464
  * @permissionId BLOG.READ-PUBLICATION
3385
3465
  * @permissionScope Read Blog
3386
3466
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3408,7 +3488,6 @@ export interface GetTotalPostsOptions {
3408
3488
  * @param postId - Post ID.
3409
3489
  * @public
3410
3490
  * @requiredField postId
3411
- * @param options - Options specifying which fields to return.
3412
3491
  * @permissionId BLOG.READ-PUBLICATION
3413
3492
  * @permissionScope Read Blog
3414
3493
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3418,11 +3497,10 @@ export interface GetTotalPostsOptions {
3418
3497
  * @permissionScopeId SCOPE.DC-BLOG.READ-DRAFT-POSTS
3419
3498
  * @applicableIdentity APP
3420
3499
  * @applicableIdentity VISITOR
3500
+ * @returns Retrieved post info.
3421
3501
  * @fqn com.wixpress.npm.communities.platformized.blog.v3.PostService.GetPost
3422
3502
  */
3423
- export declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<GetPostResponse, {
3424
- [P in PostNonNullablePaths]: `post.${P}`;
3425
- }[PostNonNullablePaths]>>;
3503
+ export declare function getPost(postId: string, options?: GetPostOptions): Promise<NonNullablePaths<Post, PostNonNullablePaths>>;
3426
3504
  export interface GetPostOptions {
3427
3505
  /**
3428
3506
  * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
@@ -3430,7 +3508,7 @@ export interface GetPostOptions {
3430
3508
  * only the post’s base fields are returned.
3431
3509
  * @maxSize 20
3432
3510
  */
3433
- fieldsets?: PostFieldField[];
3511
+ fieldsets?: PostFieldFieldWithLiterals[];
3434
3512
  }
3435
3513
  /**
3436
3514
  * Retrieves a post with the provided slug.
@@ -3442,7 +3520,6 @@ export interface GetPostOptions {
3442
3520
  * @param slug - Slug of the post to retrieve.
3443
3521
  * @public
3444
3522
  * @requiredField slug
3445
- * @param options - Options specifying which fields to return.
3446
3523
  * @permissionId BLOG.READ-PUBLICATION
3447
3524
  * @permissionScope Read Blog
3448
3525
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3464,7 +3541,7 @@ export interface GetPostBySlugOptions {
3464
3541
  * only the post’s base fields are returned.
3465
3542
  * @maxSize 20
3466
3543
  */
3467
- fieldsets?: PostFieldField[];
3544
+ fieldsets?: PostFieldFieldWithLiterals[];
3468
3545
  }
3469
3546
  /**
3470
3547
  * Retrieves a list of up to 100 published posts per request.
@@ -3474,7 +3551,6 @@ export interface GetPostBySlugOptions {
3474
3551
  * - `paging.limit` is `50`.
3475
3552
  * - `paging.offset` is `0`.
3476
3553
  * @public
3477
- * @param options - Sort, filter, and paging options.
3478
3554
  * @permissionId BLOG.READ-PUBLICATION
3479
3555
  * @permissionScope Read Blog
3480
3556
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
@@ -3528,7 +3604,7 @@ export interface ListPostsOptions {
3528
3604
  *
3529
3605
  * Default: `FEED`
3530
3606
  */
3531
- sort?: GetPostsSort;
3607
+ sort?: GetPostsSortWithLiterals;
3532
3608
  /** Pagination options. */
3533
3609
  paging?: BlogPaging;
3534
3610
  /**
@@ -3551,29 +3627,26 @@ export interface ListPostsOptions {
3551
3627
  * only the post’s base fields are returned.
3552
3628
  * @maxSize 20
3553
3629
  */
3554
- fieldsets?: PostFieldField[];
3630
+ fieldsets?: PostFieldFieldWithLiterals[];
3555
3631
  }
3556
3632
  /**
3557
- * Creates a query to retrieve a list of posts.
3558
- *
3559
- *
3560
- * The `queryPosts()` function builds a query to retrieve a list of up to 100 posts, and returns a `PostsQueryBuilder` object.
3633
+ * Retrieves a list of up to 100 posts, given the provided paging, filtering, and sorting.
3561
3634
  *
3562
- * The returned object contains the query definition which is typically used to run the query using the `find()` function.
3563
- *
3564
- * You can refine the query by chaining `PostsQueryBuilder` functions onto the query. `PostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryPosts()` returns.
3565
- *
3566
- * `queryPosts()` runs with these `PostsQueryBuilder` defaults that you can override:
3567
- * + `limit(50)`
3568
- * + `descending('firstPublishedDate')`
3569
- *
3570
- * Note that the default limit is `'50'`, but the max limit is `'100'`.
3635
+ * Query Posts runs with these defaults, which you can override:
3636
+ * - `firstPublishedDate` is sorted in descending order, with pinned posts first.
3637
+ * - `paging.limit` is `50`.
3638
+ * - `paging.offset` is `0`.
3571
3639
  *
3572
- * To learn how to query posts, refer to the table below.
3640
+ * For field support for filters and sorting, see
3641
+ * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
3573
3642
  *
3574
- * The following `PostsQueryBuilder` functions are supported for the `queryPosts()` function. For a full description of the Posts object, see the object returned for the `items` property in `PostsQueryResult`.
3643
+ * To learn about working with _Query_ endpoints, see
3644
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
3645
+ * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and
3646
+ * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
3647
+ * For a detailed list of supported filters and sortable fields, see
3648
+ * [Field Support for Filtering and Sorting](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats/filter-and-sort).
3575
3649
  * @public
3576
- * @param options - Options specifying which fields to return.
3577
3650
  * @permissionScope Read Blog
3578
3651
  * @permissionScopeId SCOPE.DC-BLOG.READ-BLOGS
3579
3652
  * @permissionScope Manage Blog
@@ -3593,7 +3666,7 @@ export interface QueryPostsOptions {
3593
3666
  * only the post’s base fields are returned.
3594
3667
  * @maxSize 20
3595
3668
  */
3596
- fieldsets?: PostFieldField[] | undefined;
3669
+ fieldsets?: PostFieldFieldWithLiterals[] | undefined;
3597
3670
  }
3598
3671
  interface QueryCursorResult {
3599
3672
  cursors: Cursors;