@wix/auto_sdk_blog_draft-posts 1.0.20 → 1.0.22
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/blog-v3-draft-draft-posts.types.d.ts +139 -59
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +153 -73
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.types.d.ts +139 -59
- package/build/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.universal.d.ts +153 -73
- package/build/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.d.ts +139 -59
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +153 -73
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.d.ts +139 -59
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.d.ts +153 -73
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -92,7 +92,7 @@ export interface DraftPost {
|
|
|
92
92
|
* Status of the draft post.
|
|
93
93
|
* @readonly
|
|
94
94
|
*/
|
|
95
|
-
status?:
|
|
95
|
+
status?: StatusWithLiterals;
|
|
96
96
|
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
97
97
|
moderationDetails?: ModerationDetails;
|
|
98
98
|
/**
|
|
@@ -254,6 +254,8 @@ export declare enum Origin {
|
|
|
254
254
|
/** Saved automatically by AI tool. */
|
|
255
255
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
256
256
|
}
|
|
257
|
+
/** @enumType */
|
|
258
|
+
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';
|
|
257
259
|
export interface RichContent {
|
|
258
260
|
/** Node objects representing a rich content document. */
|
|
259
261
|
nodes?: Node[];
|
|
@@ -318,7 +320,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
318
320
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
319
321
|
layoutCellData?: LayoutCellData;
|
|
320
322
|
/** 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. */
|
|
321
|
-
type?:
|
|
323
|
+
type?: NodeTypeWithLiterals;
|
|
322
324
|
/** Node ID. */
|
|
323
325
|
id?: string;
|
|
324
326
|
/** A list of child nodes. */
|
|
@@ -419,6 +421,8 @@ export declare enum NodeType {
|
|
|
419
421
|
LAYOUT = "LAYOUT",
|
|
420
422
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
421
423
|
}
|
|
424
|
+
/** @enumType */
|
|
425
|
+
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';
|
|
422
426
|
export interface NodeStyle {
|
|
423
427
|
/** The top padding value in pixels. */
|
|
424
428
|
paddingTop?: string | null;
|
|
@@ -431,7 +435,7 @@ export interface ButtonData {
|
|
|
431
435
|
/** Styling for the button's container. */
|
|
432
436
|
containerData?: PluginContainerData;
|
|
433
437
|
/** The button type. */
|
|
434
|
-
type?:
|
|
438
|
+
type?: ButtonDataTypeWithLiterals;
|
|
435
439
|
/** Styling for the button. */
|
|
436
440
|
styles?: Styles;
|
|
437
441
|
/** The text to display on the button. */
|
|
@@ -472,7 +476,7 @@ export interface PluginContainerData {
|
|
|
472
476
|
/** The width of the node when it's displayed. */
|
|
473
477
|
width?: PluginContainerDataWidth;
|
|
474
478
|
/** The node's alignment within its container. */
|
|
475
|
-
alignment?:
|
|
479
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
476
480
|
/** Spoiler cover settings for the node. */
|
|
477
481
|
spoiler?: Spoiler;
|
|
478
482
|
/** The height of the node when it's displayed. */
|
|
@@ -490,6 +494,8 @@ export declare enum WidthType {
|
|
|
490
494
|
/** coast-to-coast display */
|
|
491
495
|
FULL_WIDTH = "FULL_WIDTH"
|
|
492
496
|
}
|
|
497
|
+
/** @enumType */
|
|
498
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
493
499
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
494
500
|
/**
|
|
495
501
|
* One of the following predefined width options:
|
|
@@ -498,7 +504,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
498
504
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
499
505
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
500
506
|
*/
|
|
501
|
-
size?:
|
|
507
|
+
size?: WidthTypeWithLiterals;
|
|
502
508
|
/** A custom width value in pixels. */
|
|
503
509
|
custom?: string | null;
|
|
504
510
|
}
|
|
@@ -511,7 +517,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
511
517
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
512
518
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
513
519
|
*/
|
|
514
|
-
size?:
|
|
520
|
+
size?: WidthTypeWithLiterals;
|
|
515
521
|
/** A custom width value in pixels. */
|
|
516
522
|
custom?: string | null;
|
|
517
523
|
}
|
|
@@ -523,6 +529,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
523
529
|
/** Right Alignment */
|
|
524
530
|
RIGHT = "RIGHT"
|
|
525
531
|
}
|
|
532
|
+
/** @enumType */
|
|
533
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
526
534
|
export interface Spoiler {
|
|
527
535
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
528
536
|
enabled?: boolean | null;
|
|
@@ -541,6 +549,8 @@ export declare enum ButtonDataType {
|
|
|
541
549
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
542
550
|
ACTION = "ACTION"
|
|
543
551
|
}
|
|
552
|
+
/** @enumType */
|
|
553
|
+
export type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
|
|
544
554
|
export interface Styles {
|
|
545
555
|
/**
|
|
546
556
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -606,7 +616,7 @@ export interface Link extends LinkDataOneOf {
|
|
|
606
616
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
607
617
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
608
618
|
*/
|
|
609
|
-
target?:
|
|
619
|
+
target?: TargetWithLiterals;
|
|
610
620
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
611
621
|
rel?: Rel;
|
|
612
622
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -629,6 +639,8 @@ export declare enum Target {
|
|
|
629
639
|
/** Opens the linked document in the full body of the window */
|
|
630
640
|
TOP = "TOP"
|
|
631
641
|
}
|
|
642
|
+
/** @enumType */
|
|
643
|
+
export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
632
644
|
export interface Rel {
|
|
633
645
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
634
646
|
nofollow?: boolean | null;
|
|
@@ -645,7 +657,7 @@ export interface CodeBlockData {
|
|
|
645
657
|
}
|
|
646
658
|
export interface TextStyle {
|
|
647
659
|
/** Text alignment. Defaults to `AUTO`. */
|
|
648
|
-
textAlignment?:
|
|
660
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
649
661
|
/** 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. */
|
|
650
662
|
lineHeight?: string | null;
|
|
651
663
|
}
|
|
@@ -661,15 +673,17 @@ export declare enum TextAlignment {
|
|
|
661
673
|
/** 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 */
|
|
662
674
|
JUSTIFY = "JUSTIFY"
|
|
663
675
|
}
|
|
676
|
+
/** @enumType */
|
|
677
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
664
678
|
export interface DividerData {
|
|
665
679
|
/** Styling for the divider's container. */
|
|
666
680
|
containerData?: PluginContainerData;
|
|
667
681
|
/** Divider line style. */
|
|
668
|
-
lineStyle?:
|
|
682
|
+
lineStyle?: LineStyleWithLiterals;
|
|
669
683
|
/** Divider width. */
|
|
670
|
-
width?:
|
|
684
|
+
width?: WidthWithLiterals;
|
|
671
685
|
/** Divider alignment. */
|
|
672
|
-
alignment?:
|
|
686
|
+
alignment?: AlignmentWithLiterals;
|
|
673
687
|
}
|
|
674
688
|
export declare enum LineStyle {
|
|
675
689
|
/** Single Line */
|
|
@@ -681,6 +695,8 @@ export declare enum LineStyle {
|
|
|
681
695
|
/** Dotted Line */
|
|
682
696
|
DOTTED = "DOTTED"
|
|
683
697
|
}
|
|
698
|
+
/** @enumType */
|
|
699
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
684
700
|
export declare enum Width {
|
|
685
701
|
/** Large line */
|
|
686
702
|
LARGE = "LARGE",
|
|
@@ -689,6 +705,8 @@ export declare enum Width {
|
|
|
689
705
|
/** Small line */
|
|
690
706
|
SMALL = "SMALL"
|
|
691
707
|
}
|
|
708
|
+
/** @enumType */
|
|
709
|
+
export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
692
710
|
export declare enum Alignment {
|
|
693
711
|
/** Center alignment */
|
|
694
712
|
CENTER = "CENTER",
|
|
@@ -697,6 +715,8 @@ export declare enum Alignment {
|
|
|
697
715
|
/** Right alignment */
|
|
698
716
|
RIGHT = "RIGHT"
|
|
699
717
|
}
|
|
718
|
+
/** @enumType */
|
|
719
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
700
720
|
export interface FileData {
|
|
701
721
|
/** Styling for the file's container. */
|
|
702
722
|
containerData?: PluginContainerData;
|
|
@@ -728,6 +748,8 @@ export declare enum ViewMode {
|
|
|
728
748
|
/** Mini PDF view */
|
|
729
749
|
MINI = "MINI"
|
|
730
750
|
}
|
|
751
|
+
/** @enumType */
|
|
752
|
+
export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
731
753
|
export interface FileSource extends FileSourceDataOneOf {
|
|
732
754
|
/** The absolute URL for the file's source. */
|
|
733
755
|
url?: string | null;
|
|
@@ -760,7 +782,7 @@ export interface PDFSettings {
|
|
|
760
782
|
* `FULL` : A full page view of the PDF is displayed.
|
|
761
783
|
* `MINI` : A mini view of the PDF is displayed.
|
|
762
784
|
*/
|
|
763
|
-
viewMode?:
|
|
785
|
+
viewMode?: ViewModeWithLiterals;
|
|
764
786
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
765
787
|
disableDownload?: boolean | null;
|
|
766
788
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -847,18 +869,24 @@ export declare enum LayoutType {
|
|
|
847
869
|
/** Fullsize images type */
|
|
848
870
|
FULLSIZE = "FULLSIZE"
|
|
849
871
|
}
|
|
872
|
+
/** @enumType */
|
|
873
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
850
874
|
export declare enum Orientation {
|
|
851
875
|
/** Rows Orientation */
|
|
852
876
|
ROWS = "ROWS",
|
|
853
877
|
/** Columns Orientation */
|
|
854
878
|
COLUMNS = "COLUMNS"
|
|
855
879
|
}
|
|
880
|
+
/** @enumType */
|
|
881
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
856
882
|
export declare enum Crop {
|
|
857
883
|
/** Crop to fill */
|
|
858
884
|
FILL = "FILL",
|
|
859
885
|
/** Crop to fit */
|
|
860
886
|
FIT = "FIT"
|
|
861
887
|
}
|
|
888
|
+
/** @enumType */
|
|
889
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
862
890
|
export declare enum ThumbnailsAlignment {
|
|
863
891
|
/** Top alignment */
|
|
864
892
|
TOP = "TOP",
|
|
@@ -871,13 +899,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
871
899
|
/** No thumbnail */
|
|
872
900
|
NONE = "NONE"
|
|
873
901
|
}
|
|
902
|
+
/** @enumType */
|
|
903
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
874
904
|
export interface Layout {
|
|
875
905
|
/** Gallery layout type. */
|
|
876
|
-
type?:
|
|
906
|
+
type?: LayoutTypeWithLiterals;
|
|
877
907
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
878
908
|
horizontalScroll?: boolean | null;
|
|
879
909
|
/** Gallery orientation. */
|
|
880
|
-
orientation?:
|
|
910
|
+
orientation?: OrientationWithLiterals;
|
|
881
911
|
/** The number of columns to display on full size screens. */
|
|
882
912
|
numberOfColumns?: number | null;
|
|
883
913
|
/** The number of columns to display on mobile screens. */
|
|
@@ -889,13 +919,13 @@ export interface ItemStyle {
|
|
|
889
919
|
/** Item ratio */
|
|
890
920
|
ratio?: number | null;
|
|
891
921
|
/** Sets how item images are cropped. */
|
|
892
|
-
crop?:
|
|
922
|
+
crop?: CropWithLiterals;
|
|
893
923
|
/** The spacing between items in pixels. */
|
|
894
924
|
spacing?: number | null;
|
|
895
925
|
}
|
|
896
926
|
export interface Thumbnails {
|
|
897
927
|
/** Thumbnail alignment. */
|
|
898
|
-
placement?:
|
|
928
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
899
929
|
/** Spacing between thumbnails in pixels. */
|
|
900
930
|
spacing?: number | null;
|
|
901
931
|
}
|
|
@@ -911,7 +941,7 @@ export interface GIFData {
|
|
|
911
941
|
/** Width in pixels. */
|
|
912
942
|
width?: number;
|
|
913
943
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
914
|
-
gifType?:
|
|
944
|
+
gifType?: GIFTypeWithLiterals;
|
|
915
945
|
}
|
|
916
946
|
export interface GIF {
|
|
917
947
|
/**
|
|
@@ -934,6 +964,8 @@ export declare enum GIFType {
|
|
|
934
964
|
NORMAL = "NORMAL",
|
|
935
965
|
STICKER = "STICKER"
|
|
936
966
|
}
|
|
967
|
+
/** @enumType */
|
|
968
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
937
969
|
export interface HeadingData {
|
|
938
970
|
/** Heading level from 1-6. */
|
|
939
971
|
level?: number;
|
|
@@ -955,7 +987,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
955
987
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
956
988
|
containerData?: PluginContainerData;
|
|
957
989
|
/** The type of HTML code. */
|
|
958
|
-
source?:
|
|
990
|
+
source?: SourceWithLiterals;
|
|
959
991
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
960
992
|
autoHeight?: boolean | null;
|
|
961
993
|
}
|
|
@@ -975,6 +1007,8 @@ export declare enum Source {
|
|
|
975
1007
|
HTML = "HTML",
|
|
976
1008
|
ADSENSE = "ADSENSE"
|
|
977
1009
|
}
|
|
1010
|
+
/** @enumType */
|
|
1011
|
+
export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
978
1012
|
export interface ImageData {
|
|
979
1013
|
/** Styling for the image's container. */
|
|
980
1014
|
containerData?: PluginContainerData;
|
|
@@ -1039,6 +1073,8 @@ export declare enum Position {
|
|
|
1039
1073
|
/** Thumbnail hidden and not displayed */
|
|
1040
1074
|
HIDDEN = "HIDDEN"
|
|
1041
1075
|
}
|
|
1076
|
+
/** @enumType */
|
|
1077
|
+
export type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
1042
1078
|
export interface LinkPreviewDataStyles {
|
|
1043
1079
|
/**
|
|
1044
1080
|
* Background color as a hexadecimal value.
|
|
@@ -1070,7 +1106,7 @@ export interface LinkPreviewDataStyles {
|
|
|
1070
1106
|
*/
|
|
1071
1107
|
borderColor?: string | null;
|
|
1072
1108
|
/** Position of thumbnail. Defaults to `START`. */
|
|
1073
|
-
thumbnailPosition?:
|
|
1109
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
1074
1110
|
}
|
|
1075
1111
|
export interface MapData {
|
|
1076
1112
|
/** Styling for the map's container. */
|
|
@@ -1100,7 +1136,7 @@ export interface MapSettings {
|
|
|
1100
1136
|
/** Initial zoom value. */
|
|
1101
1137
|
initialZoom?: number | null;
|
|
1102
1138
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1103
|
-
mapType?:
|
|
1139
|
+
mapType?: MapTypeWithLiterals;
|
|
1104
1140
|
}
|
|
1105
1141
|
export declare enum MapType {
|
|
1106
1142
|
/** Roadmap map type */
|
|
@@ -1112,6 +1148,8 @@ export declare enum MapType {
|
|
|
1112
1148
|
/** Terrain map type */
|
|
1113
1149
|
TERRAIN = "TERRAIN"
|
|
1114
1150
|
}
|
|
1151
|
+
/** @enumType */
|
|
1152
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1115
1153
|
export interface ParagraphData {
|
|
1116
1154
|
/** Styling for the paragraph text. */
|
|
1117
1155
|
textStyle?: TextStyle;
|
|
@@ -1138,17 +1176,21 @@ export declare enum ViewRole {
|
|
|
1138
1176
|
/** Anyone can see the results, even if one didn't vote */
|
|
1139
1177
|
EVERYONE = "EVERYONE"
|
|
1140
1178
|
}
|
|
1179
|
+
/** @enumType */
|
|
1180
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1141
1181
|
export declare enum VoteRole {
|
|
1142
1182
|
/** Logged in member */
|
|
1143
1183
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1144
1184
|
/** Anyone */
|
|
1145
1185
|
ALL = "ALL"
|
|
1146
1186
|
}
|
|
1187
|
+
/** @enumType */
|
|
1188
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1147
1189
|
export interface Permissions {
|
|
1148
1190
|
/** Sets who can view the poll results. */
|
|
1149
|
-
view?:
|
|
1191
|
+
view?: ViewRoleWithLiterals;
|
|
1150
1192
|
/** Sets who can vote. */
|
|
1151
|
-
vote?:
|
|
1193
|
+
vote?: VoteRoleWithLiterals;
|
|
1152
1194
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1153
1195
|
allowMultipleVotes?: boolean | null;
|
|
1154
1196
|
}
|
|
@@ -1174,17 +1216,21 @@ export declare enum PollLayoutType {
|
|
|
1174
1216
|
/** Grid */
|
|
1175
1217
|
GRID = "GRID"
|
|
1176
1218
|
}
|
|
1219
|
+
/** @enumType */
|
|
1220
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1177
1221
|
export declare enum PollLayoutDirection {
|
|
1178
1222
|
/** Left-to-right */
|
|
1179
1223
|
LTR = "LTR",
|
|
1180
1224
|
/** Right-to-left */
|
|
1181
1225
|
RTL = "RTL"
|
|
1182
1226
|
}
|
|
1227
|
+
/** @enumType */
|
|
1228
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1183
1229
|
export interface PollLayout {
|
|
1184
1230
|
/** The layout for displaying the voting options. */
|
|
1185
|
-
type?:
|
|
1231
|
+
type?: PollLayoutTypeWithLiterals;
|
|
1186
1232
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
1187
|
-
direction?:
|
|
1233
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
1188
1234
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1189
1235
|
enableImage?: boolean | null;
|
|
1190
1236
|
}
|
|
@@ -1200,6 +1246,8 @@ export declare enum BackgroundType {
|
|
|
1200
1246
|
/** Gradiant background type */
|
|
1201
1247
|
GRADIENT = "GRADIENT"
|
|
1202
1248
|
}
|
|
1249
|
+
/** @enumType */
|
|
1250
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1203
1251
|
export interface Gradient {
|
|
1204
1252
|
/** The gradient angle in degrees. */
|
|
1205
1253
|
angle?: number | null;
|
|
@@ -1225,7 +1273,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1225
1273
|
/** Details for a gradient background. */
|
|
1226
1274
|
gradient?: Gradient;
|
|
1227
1275
|
/** Background type. For each option, include the relevant details. */
|
|
1228
|
-
type?:
|
|
1276
|
+
type?: BackgroundTypeWithLiterals;
|
|
1229
1277
|
}
|
|
1230
1278
|
/** @oneof */
|
|
1231
1279
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -1304,7 +1352,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1304
1352
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1305
1353
|
strikethroughData?: boolean | null;
|
|
1306
1354
|
/** The type of decoration to apply. */
|
|
1307
|
-
type?:
|
|
1355
|
+
type?: DecorationTypeWithLiterals;
|
|
1308
1356
|
}
|
|
1309
1357
|
/** @oneof */
|
|
1310
1358
|
export interface DecorationDataOneOf {
|
|
@@ -1342,6 +1390,8 @@ export declare enum DecorationType {
|
|
|
1342
1390
|
EXTERNAL = "EXTERNAL",
|
|
1343
1391
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1344
1392
|
}
|
|
1393
|
+
/** @enumType */
|
|
1394
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1345
1395
|
export interface AnchorData {
|
|
1346
1396
|
/** The target node's ID. */
|
|
1347
1397
|
anchor?: string;
|
|
@@ -1366,7 +1416,7 @@ export interface MentionData {
|
|
|
1366
1416
|
}
|
|
1367
1417
|
export interface FontSizeData {
|
|
1368
1418
|
/** The units used for the font size. */
|
|
1369
|
-
unit?:
|
|
1419
|
+
unit?: FontTypeWithLiterals;
|
|
1370
1420
|
/** Font size value. */
|
|
1371
1421
|
value?: number | null;
|
|
1372
1422
|
}
|
|
@@ -1374,6 +1424,8 @@ export declare enum FontType {
|
|
|
1374
1424
|
PX = "PX",
|
|
1375
1425
|
EM = "EM"
|
|
1376
1426
|
}
|
|
1427
|
+
/** @enumType */
|
|
1428
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1377
1429
|
export interface SpoilerData {
|
|
1378
1430
|
/** Spoiler ID. */
|
|
1379
1431
|
id?: string | null;
|
|
@@ -1384,7 +1436,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1384
1436
|
/** Data for embedded Wix Events content. */
|
|
1385
1437
|
eventData?: EventData;
|
|
1386
1438
|
/** The type of Wix App content being embedded. */
|
|
1387
|
-
type?:
|
|
1439
|
+
type?: AppTypeWithLiterals;
|
|
1388
1440
|
/** The ID of the embedded content. */
|
|
1389
1441
|
itemId?: string | null;
|
|
1390
1442
|
/** The name of the embedded content. */
|
|
@@ -1411,6 +1463,8 @@ export declare enum AppType {
|
|
|
1411
1463
|
EVENT = "EVENT",
|
|
1412
1464
|
BOOKING = "BOOKING"
|
|
1413
1465
|
}
|
|
1466
|
+
/** @enumType */
|
|
1467
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1414
1468
|
export interface BookingData {
|
|
1415
1469
|
/** Booking duration in minutes. */
|
|
1416
1470
|
durations?: string | null;
|
|
@@ -1489,9 +1543,9 @@ export interface CollapsibleListData {
|
|
|
1489
1543
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
1490
1544
|
expandOnlyOne?: boolean | null;
|
|
1491
1545
|
/** Sets which items are expanded when the page loads. */
|
|
1492
|
-
initialExpandedItems?:
|
|
1546
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
1493
1547
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1494
|
-
direction?:
|
|
1548
|
+
direction?: DirectionWithLiterals;
|
|
1495
1549
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1496
1550
|
isQapageData?: boolean | null;
|
|
1497
1551
|
}
|
|
@@ -1503,12 +1557,16 @@ export declare enum InitialExpandedItems {
|
|
|
1503
1557
|
/** All items collapsed initally */
|
|
1504
1558
|
NONE = "NONE"
|
|
1505
1559
|
}
|
|
1560
|
+
/** @enumType */
|
|
1561
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1506
1562
|
export declare enum Direction {
|
|
1507
1563
|
/** Left-to-right */
|
|
1508
1564
|
LTR = "LTR",
|
|
1509
1565
|
/** Right-to-left */
|
|
1510
1566
|
RTL = "RTL"
|
|
1511
1567
|
}
|
|
1568
|
+
/** @enumType */
|
|
1569
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1512
1570
|
export interface TableData {
|
|
1513
1571
|
/** Styling for the table's container. */
|
|
1514
1572
|
containerData?: PluginContainerData;
|
|
@@ -1546,9 +1604,11 @@ export declare enum VerticalAlignment {
|
|
|
1546
1604
|
/** Bottom alignment */
|
|
1547
1605
|
BOTTOM = "BOTTOM"
|
|
1548
1606
|
}
|
|
1607
|
+
/** @enumType */
|
|
1608
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1549
1609
|
export interface CellStyle {
|
|
1550
1610
|
/** Vertical alignment for the cell's text. */
|
|
1551
|
-
verticalAlignment?:
|
|
1611
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1552
1612
|
/**
|
|
1553
1613
|
* Cell background color as a hexadecimal value.
|
|
1554
1614
|
* @format COLOR_HEX
|
|
@@ -1587,6 +1647,8 @@ export declare enum NullValue {
|
|
|
1587
1647
|
/** Null value. */
|
|
1588
1648
|
NULL_VALUE = "NULL_VALUE"
|
|
1589
1649
|
}
|
|
1650
|
+
/** @enumType */
|
|
1651
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1590
1652
|
/**
|
|
1591
1653
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
1592
1654
|
*
|
|
@@ -1695,6 +1757,8 @@ export declare enum Status {
|
|
|
1695
1757
|
/** Status indicating the draft post is in review. */
|
|
1696
1758
|
IN_REVIEW = "IN_REVIEW"
|
|
1697
1759
|
}
|
|
1760
|
+
/** @enumType */
|
|
1761
|
+
export type StatusWithLiterals = Status | 'UNKNOWN' | 'PUBLISHED' | 'UNPUBLISHED' | 'SCHEDULED' | 'DELETED' | 'IN_REVIEW';
|
|
1698
1762
|
export interface ModerationDetails {
|
|
1699
1763
|
/**
|
|
1700
1764
|
* Member ID of the person submitting the draft post for review.
|
|
@@ -1704,7 +1768,7 @@ export interface ModerationDetails {
|
|
|
1704
1768
|
/** Date the post was submitted for review. */
|
|
1705
1769
|
submittedDate?: Date | null;
|
|
1706
1770
|
/** Status indicating whether the submission was approved or rejected by the moderator. */
|
|
1707
|
-
status?:
|
|
1771
|
+
status?: ModerationStatusStatusWithLiterals;
|
|
1708
1772
|
/**
|
|
1709
1773
|
* Member ID of the person who approved or rejected the post.
|
|
1710
1774
|
* @format GUID
|
|
@@ -1718,6 +1782,8 @@ export declare enum ModerationStatusStatus {
|
|
|
1718
1782
|
APPROVED = "APPROVED",
|
|
1719
1783
|
REJECTED = "REJECTED"
|
|
1720
1784
|
}
|
|
1785
|
+
/** @enumType */
|
|
1786
|
+
export type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
|
1721
1787
|
/**
|
|
1722
1788
|
* The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
|
|
1723
1789
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
@@ -1850,7 +1916,7 @@ export interface DraftPostTranslation {
|
|
|
1850
1916
|
*/
|
|
1851
1917
|
_id?: string;
|
|
1852
1918
|
/** Post status. */
|
|
1853
|
-
status?:
|
|
1919
|
+
status?: StatusWithLiterals;
|
|
1854
1920
|
/**
|
|
1855
1921
|
* Language the post is written in.
|
|
1856
1922
|
* @format LANGUAGE_TAG
|
|
@@ -1911,7 +1977,7 @@ export interface GetDraftPostTotalsRequest {
|
|
|
1911
1977
|
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
1912
1978
|
* @maxSize 10
|
|
1913
1979
|
*/
|
|
1914
|
-
groupBy?:
|
|
1980
|
+
groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
|
|
1915
1981
|
/**
|
|
1916
1982
|
* Optional language filter by provided language code. Useful in multilingual context.
|
|
1917
1983
|
* @format LANGUAGE_TAG
|
|
@@ -1924,6 +1990,8 @@ export declare enum TotalDraftPostsGroupingField {
|
|
|
1924
1990
|
/** Groups results by language. */
|
|
1925
1991
|
LANGUAGE = "LANGUAGE"
|
|
1926
1992
|
}
|
|
1993
|
+
/** @enumType */
|
|
1994
|
+
export type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
|
|
1927
1995
|
export interface GetDraftPostTotalsResponse {
|
|
1928
1996
|
/** Draft post totals. */
|
|
1929
1997
|
totalDraftPosts?: TotalDraftPosts[];
|
|
@@ -1932,7 +2000,7 @@ export interface TotalDraftPosts {
|
|
|
1932
2000
|
/** Draft post totals in that group. */
|
|
1933
2001
|
total?: number;
|
|
1934
2002
|
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
1935
|
-
status?:
|
|
2003
|
+
status?: StatusWithLiterals;
|
|
1936
2004
|
/**
|
|
1937
2005
|
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
1938
2006
|
* @format LANGUAGE_TAG
|
|
@@ -2039,7 +2107,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
2039
2107
|
*/
|
|
2040
2108
|
appId?: string;
|
|
2041
2109
|
/** @readonly */
|
|
2042
|
-
identityType?:
|
|
2110
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
2043
2111
|
}
|
|
2044
2112
|
/** @oneof */
|
|
2045
2113
|
export interface IdentificationDataIdOneOf {
|
|
@@ -2071,6 +2139,8 @@ export declare enum WebhookIdentityType {
|
|
|
2071
2139
|
WIX_USER = "WIX_USER",
|
|
2072
2140
|
APP = "APP"
|
|
2073
2141
|
}
|
|
2142
|
+
/** @enumType */
|
|
2143
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
2074
2144
|
export interface InitialDraftPostsCopied {
|
|
2075
2145
|
/** Number of draft posts copied. */
|
|
2076
2146
|
count?: number;
|
|
@@ -2090,7 +2160,7 @@ export interface CreateDraftPostRequest {
|
|
|
2090
2160
|
* only the draft post's base fields are returned.
|
|
2091
2161
|
* @maxSize 10
|
|
2092
2162
|
*/
|
|
2093
|
-
fieldsets?:
|
|
2163
|
+
fieldsets?: FieldWithLiterals[];
|
|
2094
2164
|
}
|
|
2095
2165
|
export declare enum Type {
|
|
2096
2166
|
UNKNOWN = "UNKNOWN",
|
|
@@ -2105,6 +2175,8 @@ export declare enum Type {
|
|
|
2105
2175
|
/** Triggered by autosave when post created by AI tool. */
|
|
2106
2176
|
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2107
2177
|
}
|
|
2178
|
+
/** @enumType */
|
|
2179
|
+
export type TypeWithLiterals = Type | 'UNKNOWN' | 'MANUAL' | 'AUTO_SAVE' | 'PROVISIONING' | 'IMPORT' | 'AI_AUTO_SAVE';
|
|
2108
2180
|
export declare enum Field {
|
|
2109
2181
|
/** Unknown field. */
|
|
2110
2182
|
UNKNOWN = "UNKNOWN",
|
|
@@ -2117,6 +2189,8 @@ export declare enum Field {
|
|
|
2117
2189
|
/** If the user has not set excerpt, returns the one autogenerated from content. */
|
|
2118
2190
|
GENERATED_EXCERPT = "GENERATED_EXCERPT"
|
|
2119
2191
|
}
|
|
2192
|
+
/** @enumType */
|
|
2193
|
+
export type FieldWithLiterals = Field | 'UNKNOWN' | 'URL' | 'CONTENT' | 'RICH_CONTENT' | 'GENERATED_EXCERPT';
|
|
2120
2194
|
export interface CreateDraftPostResponse {
|
|
2121
2195
|
/** Created draft post info. */
|
|
2122
2196
|
draftPost?: DraftPost;
|
|
@@ -2138,7 +2212,7 @@ export interface BulkCreateDraftPostsRequest {
|
|
|
2138
2212
|
* For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
|
|
2139
2213
|
* @maxSize 10
|
|
2140
2214
|
*/
|
|
2141
|
-
fieldsets?:
|
|
2215
|
+
fieldsets?: FieldWithLiterals[];
|
|
2142
2216
|
}
|
|
2143
2217
|
export interface BulkCreateDraftPostsResponse {
|
|
2144
2218
|
/** Draft posts created by bulk action. */
|
|
@@ -2190,7 +2264,7 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
2190
2264
|
*
|
|
2191
2265
|
* Default: `UPDATE`
|
|
2192
2266
|
*/
|
|
2193
|
-
action?:
|
|
2267
|
+
action?: ActionWithLiterals;
|
|
2194
2268
|
/** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
|
|
2195
2269
|
scheduledPublishDate?: Date | null;
|
|
2196
2270
|
/** Whether to return the full updated draft post entities in the response. */
|
|
@@ -2201,7 +2275,7 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
2201
2275
|
* only the draft post's base fields are returned.
|
|
2202
2276
|
* @maxSize 10
|
|
2203
2277
|
*/
|
|
2204
|
-
fieldsets?:
|
|
2278
|
+
fieldsets?: FieldWithLiterals[];
|
|
2205
2279
|
}
|
|
2206
2280
|
export interface MaskedDraftPosts {
|
|
2207
2281
|
/** Draft post */
|
|
@@ -2225,6 +2299,8 @@ export declare enum Action {
|
|
|
2225
2299
|
/** Update a post that's already been published. This creates and updates a draft version of the post. The original post is still published. */
|
|
2226
2300
|
UPDATE_PUBLICATION = "UPDATE_PUBLICATION"
|
|
2227
2301
|
}
|
|
2302
|
+
/** @enumType */
|
|
2303
|
+
export type ActionWithLiterals = Action | 'UPDATE' | 'UPDATE_PUBLISH' | 'UPDATE_SCHEDULE' | 'UPDATE_REVERT_TO_DRAFT' | 'UPDATE_CANCEL_SCHEDULE' | 'UPDATE_REJECT' | 'UPDATE_PUBLICATION';
|
|
2228
2304
|
export interface BulkUpdateDraftPostsResponse {
|
|
2229
2305
|
/** Draft posts updated by bulk action. */
|
|
2230
2306
|
results?: BulkDraftPostResult[];
|
|
@@ -2247,7 +2323,7 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
2247
2323
|
*
|
|
2248
2324
|
* Default: `EDITING_DATE_DESCENDING`
|
|
2249
2325
|
*/
|
|
2250
|
-
sort?:
|
|
2326
|
+
sort?: GetDraftPostsSortWithLiterals;
|
|
2251
2327
|
/** Pagination options. */
|
|
2252
2328
|
paging?: BlogPaging;
|
|
2253
2329
|
/**
|
|
@@ -2256,7 +2332,7 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
2256
2332
|
* only the draft post's base fields are returned.
|
|
2257
2333
|
* @maxSize 10
|
|
2258
2334
|
*/
|
|
2259
|
-
fieldsets?:
|
|
2335
|
+
fieldsets?: FieldWithLiterals[];
|
|
2260
2336
|
/**
|
|
2261
2337
|
* Draft post ids.
|
|
2262
2338
|
* @maxSize 100
|
|
@@ -2270,6 +2346,8 @@ export declare enum GetDraftPostsSort {
|
|
|
2270
2346
|
/** Sort by `editedDate` in ascending order. */
|
|
2271
2347
|
EDITING_DATE_ASC = "EDITING_DATE_ASC"
|
|
2272
2348
|
}
|
|
2349
|
+
/** @enumType */
|
|
2350
|
+
export type GetDraftPostsSortWithLiterals = GetDraftPostsSort | 'EDITING_DATE_DESC' | 'EDITING_DATE_ASC';
|
|
2273
2351
|
export interface BlogPaging {
|
|
2274
2352
|
/**
|
|
2275
2353
|
* Number of items to skip in the current sort order.
|
|
@@ -2361,7 +2439,7 @@ export interface GetDraftPostRequest {
|
|
|
2361
2439
|
* only the draft post's base fields are returned.
|
|
2362
2440
|
* @maxSize 10
|
|
2363
2441
|
*/
|
|
2364
|
-
fieldsets?:
|
|
2442
|
+
fieldsets?: FieldWithLiterals[];
|
|
2365
2443
|
}
|
|
2366
2444
|
export interface GetDraftPostResponse {
|
|
2367
2445
|
/** Draft post info. */
|
|
@@ -2381,14 +2459,14 @@ export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentReq
|
|
|
2381
2459
|
*/
|
|
2382
2460
|
draftPostId?: string;
|
|
2383
2461
|
/** Change origin. */
|
|
2384
|
-
changeOrigin?:
|
|
2462
|
+
changeOrigin?: OriginWithLiterals;
|
|
2385
2463
|
/**
|
|
2386
2464
|
* List of draft post fields to be included if entities are present in the response.
|
|
2387
2465
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2388
2466
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2389
2467
|
* @maxSize 10
|
|
2390
2468
|
*/
|
|
2391
|
-
fieldsets?:
|
|
2469
|
+
fieldsets?: FieldWithLiterals[];
|
|
2392
2470
|
}
|
|
2393
2471
|
/** @oneof */
|
|
2394
2472
|
export interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
@@ -2412,7 +2490,7 @@ export interface UpdateDraftPostRequest {
|
|
|
2412
2490
|
*
|
|
2413
2491
|
* Default: `UPDATE`
|
|
2414
2492
|
*/
|
|
2415
|
-
action?:
|
|
2493
|
+
action?: ActionWithLiterals;
|
|
2416
2494
|
/** Post publish schedule date if `action` is set to `UPDATE_SCHEDULE`. */
|
|
2417
2495
|
scheduledPublishDate?: Date | null;
|
|
2418
2496
|
/**
|
|
@@ -2421,7 +2499,7 @@ export interface UpdateDraftPostRequest {
|
|
|
2421
2499
|
* only the draft post's base fields are returned.
|
|
2422
2500
|
* @maxSize 10
|
|
2423
2501
|
*/
|
|
2424
|
-
fieldsets?:
|
|
2502
|
+
fieldsets?: FieldWithLiterals[];
|
|
2425
2503
|
}
|
|
2426
2504
|
export interface UpdateDraftPostResponse {
|
|
2427
2505
|
/** Updated draft post info. */
|
|
@@ -2474,7 +2552,7 @@ export interface ListDraftPostsRequest {
|
|
|
2474
2552
|
*
|
|
2475
2553
|
* If omitted, draft posts with all statuses are returned.
|
|
2476
2554
|
*/
|
|
2477
|
-
status?:
|
|
2555
|
+
status?: StatusWithLiterals;
|
|
2478
2556
|
/**
|
|
2479
2557
|
* Language filter.
|
|
2480
2558
|
*
|
|
@@ -2488,7 +2566,7 @@ export interface ListDraftPostsRequest {
|
|
|
2488
2566
|
*
|
|
2489
2567
|
* Default: `EDITING_DATE_DESCENDING`
|
|
2490
2568
|
*/
|
|
2491
|
-
sort?:
|
|
2569
|
+
sort?: GetDraftPostsSortWithLiterals;
|
|
2492
2570
|
/** Pagination options. */
|
|
2493
2571
|
paging?: BlogPaging;
|
|
2494
2572
|
/**
|
|
@@ -2497,7 +2575,7 @@ export interface ListDraftPostsRequest {
|
|
|
2497
2575
|
* only the draft post's base fields are returned.
|
|
2498
2576
|
* @maxSize 10
|
|
2499
2577
|
*/
|
|
2500
|
-
fieldsets?:
|
|
2578
|
+
fieldsets?: FieldWithLiterals[];
|
|
2501
2579
|
}
|
|
2502
2580
|
export interface ListDraftPostsResponse {
|
|
2503
2581
|
/** List of draft posts. */
|
|
@@ -2534,7 +2612,7 @@ export interface QueryDraftPostsRequest {
|
|
|
2534
2612
|
* only the draft post's base fields are returned.
|
|
2535
2613
|
* @maxSize 10
|
|
2536
2614
|
*/
|
|
2537
|
-
fieldsets?:
|
|
2615
|
+
fieldsets?: FieldWithLiterals[];
|
|
2538
2616
|
/** Query options. */
|
|
2539
2617
|
query?: PlatformQuery;
|
|
2540
2618
|
}
|
|
@@ -2545,12 +2623,14 @@ export interface Sorting {
|
|
|
2545
2623
|
*/
|
|
2546
2624
|
fieldName?: string;
|
|
2547
2625
|
/** Sort order. */
|
|
2548
|
-
order?:
|
|
2626
|
+
order?: SortOrderWithLiterals;
|
|
2549
2627
|
}
|
|
2550
2628
|
export declare enum SortOrder {
|
|
2551
2629
|
ASC = "ASC",
|
|
2552
2630
|
DESC = "DESC"
|
|
2553
2631
|
}
|
|
2632
|
+
/** @enumType */
|
|
2633
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2554
2634
|
export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
2555
2635
|
/** Paging options to limit and skip the number of items. */
|
|
2556
2636
|
paging?: Paging;
|
|
@@ -2755,7 +2835,7 @@ export interface TranslateDraftRequest {
|
|
|
2755
2835
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2756
2836
|
* @maxSize 10
|
|
2757
2837
|
*/
|
|
2758
|
-
fieldsets?:
|
|
2838
|
+
fieldsets?: FieldWithLiterals[];
|
|
2759
2839
|
}
|
|
2760
2840
|
export interface TranslateDraftResponse {
|
|
2761
2841
|
/** Draft post. */
|
|
@@ -2805,7 +2885,7 @@ export interface UpdateDraftPostLanguageRequest {
|
|
|
2805
2885
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2806
2886
|
* @maxSize 10
|
|
2807
2887
|
*/
|
|
2808
|
-
fieldsets?:
|
|
2888
|
+
fieldsets?: FieldWithLiterals[];
|
|
2809
2889
|
}
|
|
2810
2890
|
export interface UpdateDraftPostLanguageResponse {
|
|
2811
2891
|
/** Draft post */
|
|
@@ -2831,7 +2911,7 @@ export interface BulkUpdateDraftPostLanguageRequest {
|
|
|
2831
2911
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2832
2912
|
* @maxSize 10
|
|
2833
2913
|
*/
|
|
2834
|
-
fieldsets?:
|
|
2914
|
+
fieldsets?: FieldWithLiterals[];
|
|
2835
2915
|
}
|
|
2836
2916
|
export interface BulkUpdateDraftPostLanguageResponse {
|
|
2837
2917
|
/** Bulk action results */
|
|
@@ -2910,7 +2990,7 @@ export interface RevertToUnpublishedRequest {
|
|
|
2910
2990
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2911
2991
|
* @maxSize 10
|
|
2912
2992
|
*/
|
|
2913
|
-
fieldsets?:
|
|
2993
|
+
fieldsets?: FieldWithLiterals[];
|
|
2914
2994
|
}
|
|
2915
2995
|
export interface RevertToUnpublishedResponse {
|
|
2916
2996
|
/** Updated post draft. */
|
|
@@ -2928,7 +3008,7 @@ export interface RejectDraftPostRequest {
|
|
|
2928
3008
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2929
3009
|
* @maxSize 10
|
|
2930
3010
|
*/
|
|
2931
|
-
fieldsets?:
|
|
3011
|
+
fieldsets?: FieldWithLiterals[];
|
|
2932
3012
|
}
|
|
2933
3013
|
export interface RejectDraftPostResponse {
|
|
2934
3014
|
/** Draft post. */
|
|
@@ -2951,7 +3031,7 @@ export interface ApproveDraftPostRequest {
|
|
|
2951
3031
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2952
3032
|
* @maxSize 10
|
|
2953
3033
|
*/
|
|
2954
|
-
fieldsets?:
|
|
3034
|
+
fieldsets?: FieldWithLiterals[];
|
|
2955
3035
|
}
|
|
2956
3036
|
export interface ApproveDraftPostResponse {
|
|
2957
3037
|
/** Updated post draft. */
|
|
@@ -2969,7 +3049,7 @@ export interface MarkPostAsInModerationRequest {
|
|
|
2969
3049
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2970
3050
|
* @maxSize 10
|
|
2971
3051
|
*/
|
|
2972
|
-
fieldsets?:
|
|
3052
|
+
fieldsets?: FieldWithLiterals[];
|
|
2973
3053
|
}
|
|
2974
3054
|
export interface MarkPostAsInModerationResponse {
|
|
2975
3055
|
/** Updated post draft. */
|
|
@@ -3129,7 +3209,7 @@ export interface CreateDraftPostOptions {
|
|
|
3129
3209
|
* only the draft post's base fields are returned.
|
|
3130
3210
|
* @maxSize 10
|
|
3131
3211
|
*/
|
|
3132
|
-
fieldsets?:
|
|
3212
|
+
fieldsets?: FieldWithLiterals[];
|
|
3133
3213
|
}
|
|
3134
3214
|
/**
|
|
3135
3215
|
* Creates multiple draft posts.
|
|
@@ -3158,7 +3238,7 @@ export interface BulkCreateDraftPostsOptions {
|
|
|
3158
3238
|
* For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
|
|
3159
3239
|
* @maxSize 10
|
|
3160
3240
|
*/
|
|
3161
|
-
fieldsets?:
|
|
3241
|
+
fieldsets?: FieldWithLiterals[];
|
|
3162
3242
|
}
|
|
3163
3243
|
/**
|
|
3164
3244
|
* Updates multiple draft posts.
|
|
@@ -3187,7 +3267,7 @@ export interface BulkUpdateDraftPostsOptions {
|
|
|
3187
3267
|
*
|
|
3188
3268
|
* Default: `UPDATE`
|
|
3189
3269
|
*/
|
|
3190
|
-
action?:
|
|
3270
|
+
action?: ActionWithLiterals;
|
|
3191
3271
|
/** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
|
|
3192
3272
|
scheduledPublishDate?: Date | null;
|
|
3193
3273
|
/** Whether to return the full updated draft post entities in the response. */
|
|
@@ -3198,7 +3278,7 @@ export interface BulkUpdateDraftPostsOptions {
|
|
|
3198
3278
|
* only the draft post's base fields are returned.
|
|
3199
3279
|
* @maxSize 10
|
|
3200
3280
|
*/
|
|
3201
|
-
fieldsets?:
|
|
3281
|
+
fieldsets?: FieldWithLiterals[];
|
|
3202
3282
|
}
|
|
3203
3283
|
/**
|
|
3204
3284
|
* Retrieves a list of up to 100 deleted draft posts.
|
|
@@ -3232,7 +3312,7 @@ export interface ListDeletedDraftPostsOptions {
|
|
|
3232
3312
|
*
|
|
3233
3313
|
* Default: `EDITING_DATE_DESCENDING`
|
|
3234
3314
|
*/
|
|
3235
|
-
sort?:
|
|
3315
|
+
sort?: GetDraftPostsSortWithLiterals;
|
|
3236
3316
|
/** Pagination options. */
|
|
3237
3317
|
paging?: BlogPaging;
|
|
3238
3318
|
/**
|
|
@@ -3241,7 +3321,7 @@ export interface ListDeletedDraftPostsOptions {
|
|
|
3241
3321
|
* only the draft post's base fields are returned.
|
|
3242
3322
|
* @maxSize 10
|
|
3243
3323
|
*/
|
|
3244
|
-
fieldsets?:
|
|
3324
|
+
fieldsets?: FieldWithLiterals[];
|
|
3245
3325
|
/**
|
|
3246
3326
|
* Draft post ids.
|
|
3247
3327
|
* @maxSize 100
|
|
@@ -3271,7 +3351,7 @@ export interface GetDraftPostOptions {
|
|
|
3271
3351
|
* only the draft post's base fields are returned.
|
|
3272
3352
|
* @maxSize 10
|
|
3273
3353
|
*/
|
|
3274
|
-
fieldsets?:
|
|
3354
|
+
fieldsets?: FieldWithLiterals[];
|
|
3275
3355
|
}
|
|
3276
3356
|
/**
|
|
3277
3357
|
* Updates a draft post.
|
|
@@ -3383,7 +3463,7 @@ export interface UpdateDraftPost {
|
|
|
3383
3463
|
* Status of the draft post.
|
|
3384
3464
|
* @readonly
|
|
3385
3465
|
*/
|
|
3386
|
-
status?:
|
|
3466
|
+
status?: StatusWithLiterals;
|
|
3387
3467
|
/** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
|
|
3388
3468
|
moderationDetails?: ModerationDetails;
|
|
3389
3469
|
/**
|
|
@@ -3431,7 +3511,7 @@ export interface UpdateDraftPostOptions {
|
|
|
3431
3511
|
*
|
|
3432
3512
|
* Default: `UPDATE`
|
|
3433
3513
|
*/
|
|
3434
|
-
action?:
|
|
3514
|
+
action?: ActionWithLiterals;
|
|
3435
3515
|
/** Post publish schedule date if `action` is set to `UPDATE_SCHEDULE`. */
|
|
3436
3516
|
scheduledPublishDate?: Date | null;
|
|
3437
3517
|
/**
|
|
@@ -3440,7 +3520,7 @@ export interface UpdateDraftPostOptions {
|
|
|
3440
3520
|
* only the draft post's base fields are returned.
|
|
3441
3521
|
* @maxSize 10
|
|
3442
3522
|
*/
|
|
3443
|
-
fieldsets?:
|
|
3523
|
+
fieldsets?: FieldWithLiterals[];
|
|
3444
3524
|
}
|
|
3445
3525
|
/**
|
|
3446
3526
|
* Moves a draft post to the trash bin.
|
|
@@ -3523,7 +3603,7 @@ export interface ListDraftPostsOptions {
|
|
|
3523
3603
|
*
|
|
3524
3604
|
* If omitted, draft posts with all statuses are returned.
|
|
3525
3605
|
*/
|
|
3526
|
-
status?:
|
|
3606
|
+
status?: StatusWithLiterals;
|
|
3527
3607
|
/**
|
|
3528
3608
|
* Language filter.
|
|
3529
3609
|
*
|
|
@@ -3537,7 +3617,7 @@ export interface ListDraftPostsOptions {
|
|
|
3537
3617
|
*
|
|
3538
3618
|
* Default: `EDITING_DATE_DESCENDING`
|
|
3539
3619
|
*/
|
|
3540
|
-
sort?:
|
|
3620
|
+
sort?: GetDraftPostsSortWithLiterals;
|
|
3541
3621
|
/** Pagination options. */
|
|
3542
3622
|
paging?: BlogPaging;
|
|
3543
3623
|
/**
|
|
@@ -3546,7 +3626,7 @@ export interface ListDraftPostsOptions {
|
|
|
3546
3626
|
* only the draft post's base fields are returned.
|
|
3547
3627
|
* @maxSize 10
|
|
3548
3628
|
*/
|
|
3549
|
-
fieldsets?:
|
|
3629
|
+
fieldsets?: FieldWithLiterals[];
|
|
3550
3630
|
}
|
|
3551
3631
|
/**
|
|
3552
3632
|
* Retrieves a deleted draft post from the trash bin by the provided ID.
|
|
@@ -3607,7 +3687,7 @@ export interface QueryDraftPostsOptions {
|
|
|
3607
3687
|
* only the draft post's base fields are returned.
|
|
3608
3688
|
* @maxSize 10
|
|
3609
3689
|
*/
|
|
3610
|
-
fieldsets?:
|
|
3690
|
+
fieldsets?: FieldWithLiterals[] | undefined;
|
|
3611
3691
|
}
|
|
3612
3692
|
interface QueryCursorResult {
|
|
3613
3693
|
cursors: Cursors;
|