@wix/auto_sdk_categories_categories 1.0.48 → 1.0.50
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/categories-v1-category-categories.types.d.ts +152 -72
- package/build/cjs/src/categories-v1-category-categories.types.js.map +1 -1
- package/build/cjs/src/categories-v1-category-categories.universal.d.ts +236 -108
- package/build/cjs/src/categories-v1-category-categories.universal.js +83 -56
- package/build/cjs/src/categories-v1-category-categories.universal.js.map +1 -1
- package/build/es/src/categories-v1-category-categories.types.d.ts +152 -72
- package/build/es/src/categories-v1-category-categories.types.js.map +1 -1
- package/build/es/src/categories-v1-category-categories.universal.d.ts +236 -108
- package/build/es/src/categories-v1-category-categories.universal.js +83 -56
- package/build/es/src/categories-v1-category-categories.universal.js.map +1 -1
- package/build/internal/cjs/src/categories-v1-category-categories.types.d.ts +152 -72
- package/build/internal/cjs/src/categories-v1-category-categories.types.js.map +1 -1
- package/build/internal/cjs/src/categories-v1-category-categories.universal.d.ts +236 -108
- package/build/internal/cjs/src/categories-v1-category-categories.universal.js +83 -56
- package/build/internal/cjs/src/categories-v1-category-categories.universal.js.map +1 -1
- package/build/internal/es/src/categories-v1-category-categories.types.d.ts +152 -72
- package/build/internal/es/src/categories-v1-category-categories.types.js.map +1 -1
- package/build/internal/es/src/categories-v1-category-categories.universal.d.ts +236 -108
- package/build/internal/es/src/categories-v1-category-categories.universal.js +83 -56
- package/build/internal/es/src/categories-v1-category-categories.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -296,7 +296,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
296
296
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
297
297
|
layoutCellData?: LayoutCellData;
|
|
298
298
|
/** 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. */
|
|
299
|
-
type?:
|
|
299
|
+
type?: NodeTypeWithLiterals;
|
|
300
300
|
/** Node ID. */
|
|
301
301
|
id?: string;
|
|
302
302
|
/** A list of child nodes. */
|
|
@@ -397,6 +397,8 @@ export declare enum NodeType {
|
|
|
397
397
|
LAYOUT = "LAYOUT",
|
|
398
398
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
399
399
|
}
|
|
400
|
+
/** @enumType */
|
|
401
|
+
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';
|
|
400
402
|
export interface NodeStyle {
|
|
401
403
|
/** The top padding value in pixels. */
|
|
402
404
|
paddingTop?: string | null;
|
|
@@ -409,7 +411,7 @@ export interface ButtonData {
|
|
|
409
411
|
/** Styling for the button's container. */
|
|
410
412
|
containerData?: PluginContainerData;
|
|
411
413
|
/** The button type. */
|
|
412
|
-
type?:
|
|
414
|
+
type?: TypeWithLiterals;
|
|
413
415
|
/** Styling for the button. */
|
|
414
416
|
styles?: Styles;
|
|
415
417
|
/** The text to display on the button. */
|
|
@@ -450,7 +452,7 @@ export interface PluginContainerData {
|
|
|
450
452
|
/** The width of the node when it's displayed. */
|
|
451
453
|
width?: PluginContainerDataWidth;
|
|
452
454
|
/** The node's alignment within its container. */
|
|
453
|
-
alignment?:
|
|
455
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
454
456
|
/** Spoiler cover settings for the node. */
|
|
455
457
|
spoiler?: Spoiler;
|
|
456
458
|
/** The height of the node when it's displayed. */
|
|
@@ -468,6 +470,8 @@ export declare enum WidthType {
|
|
|
468
470
|
/** coast-to-coast display */
|
|
469
471
|
FULL_WIDTH = "FULL_WIDTH"
|
|
470
472
|
}
|
|
473
|
+
/** @enumType */
|
|
474
|
+
export type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
471
475
|
export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
472
476
|
/**
|
|
473
477
|
* One of the following predefined width options:
|
|
@@ -476,7 +480,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
476
480
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
477
481
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
478
482
|
*/
|
|
479
|
-
size?:
|
|
483
|
+
size?: WidthTypeWithLiterals;
|
|
480
484
|
/** A custom width value in pixels. */
|
|
481
485
|
custom?: string | null;
|
|
482
486
|
}
|
|
@@ -489,7 +493,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
489
493
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
490
494
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
491
495
|
*/
|
|
492
|
-
size?:
|
|
496
|
+
size?: WidthTypeWithLiterals;
|
|
493
497
|
/** A custom width value in pixels. */
|
|
494
498
|
custom?: string | null;
|
|
495
499
|
}
|
|
@@ -501,6 +505,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
501
505
|
/** Right Alignment */
|
|
502
506
|
RIGHT = "RIGHT"
|
|
503
507
|
}
|
|
508
|
+
/** @enumType */
|
|
509
|
+
export type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
504
510
|
export interface Spoiler {
|
|
505
511
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
506
512
|
enabled?: boolean | null;
|
|
@@ -519,6 +525,8 @@ export declare enum Type {
|
|
|
519
525
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
520
526
|
ACTION = "ACTION"
|
|
521
527
|
}
|
|
528
|
+
/** @enumType */
|
|
529
|
+
export type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
522
530
|
export interface Styles {
|
|
523
531
|
/**
|
|
524
532
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -584,7 +592,7 @@ export interface Link extends LinkDataOneOf {
|
|
|
584
592
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
585
593
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
586
594
|
*/
|
|
587
|
-
target?:
|
|
595
|
+
target?: TargetWithLiterals;
|
|
588
596
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
589
597
|
rel?: Rel;
|
|
590
598
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -607,6 +615,8 @@ export declare enum Target {
|
|
|
607
615
|
/** Opens the linked document in the full body of the window */
|
|
608
616
|
TOP = "TOP"
|
|
609
617
|
}
|
|
618
|
+
/** @enumType */
|
|
619
|
+
export type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
610
620
|
export interface Rel {
|
|
611
621
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
612
622
|
nofollow?: boolean | null;
|
|
@@ -623,7 +633,7 @@ export interface CodeBlockData {
|
|
|
623
633
|
}
|
|
624
634
|
export interface TextStyle {
|
|
625
635
|
/** Text alignment. Defaults to `AUTO`. */
|
|
626
|
-
textAlignment?:
|
|
636
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
627
637
|
/** 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. */
|
|
628
638
|
lineHeight?: string | null;
|
|
629
639
|
}
|
|
@@ -639,15 +649,17 @@ export declare enum TextAlignment {
|
|
|
639
649
|
/** 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 */
|
|
640
650
|
JUSTIFY = "JUSTIFY"
|
|
641
651
|
}
|
|
652
|
+
/** @enumType */
|
|
653
|
+
export type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
642
654
|
export interface DividerData {
|
|
643
655
|
/** Styling for the divider's container. */
|
|
644
656
|
containerData?: PluginContainerData;
|
|
645
657
|
/** Divider line style. */
|
|
646
|
-
lineStyle?:
|
|
658
|
+
lineStyle?: LineStyleWithLiterals;
|
|
647
659
|
/** Divider width. */
|
|
648
|
-
width?:
|
|
660
|
+
width?: WidthWithLiterals;
|
|
649
661
|
/** Divider alignment. */
|
|
650
|
-
alignment?:
|
|
662
|
+
alignment?: AlignmentWithLiterals;
|
|
651
663
|
}
|
|
652
664
|
export declare enum LineStyle {
|
|
653
665
|
/** Single Line */
|
|
@@ -659,6 +671,8 @@ export declare enum LineStyle {
|
|
|
659
671
|
/** Dotted Line */
|
|
660
672
|
DOTTED = "DOTTED"
|
|
661
673
|
}
|
|
674
|
+
/** @enumType */
|
|
675
|
+
export type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
662
676
|
export declare enum Width {
|
|
663
677
|
/** Large line */
|
|
664
678
|
LARGE = "LARGE",
|
|
@@ -667,6 +681,8 @@ export declare enum Width {
|
|
|
667
681
|
/** Small line */
|
|
668
682
|
SMALL = "SMALL"
|
|
669
683
|
}
|
|
684
|
+
/** @enumType */
|
|
685
|
+
export type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
670
686
|
export declare enum Alignment {
|
|
671
687
|
/** Center alignment */
|
|
672
688
|
CENTER = "CENTER",
|
|
@@ -675,6 +691,8 @@ export declare enum Alignment {
|
|
|
675
691
|
/** Right alignment */
|
|
676
692
|
RIGHT = "RIGHT"
|
|
677
693
|
}
|
|
694
|
+
/** @enumType */
|
|
695
|
+
export type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
678
696
|
export interface FileData {
|
|
679
697
|
/** Styling for the file's container. */
|
|
680
698
|
containerData?: PluginContainerData;
|
|
@@ -706,6 +724,8 @@ export declare enum ViewMode {
|
|
|
706
724
|
/** Mini PDF view */
|
|
707
725
|
MINI = "MINI"
|
|
708
726
|
}
|
|
727
|
+
/** @enumType */
|
|
728
|
+
export type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
709
729
|
export interface FileSource extends FileSourceDataOneOf {
|
|
710
730
|
/** The absolute URL for the file's source. */
|
|
711
731
|
url?: string | null;
|
|
@@ -738,7 +758,7 @@ export interface PDFSettings {
|
|
|
738
758
|
* `FULL` : A full page view of the PDF is displayed.
|
|
739
759
|
* `MINI` : A mini view of the PDF is displayed.
|
|
740
760
|
*/
|
|
741
|
-
viewMode?:
|
|
761
|
+
viewMode?: ViewModeWithLiterals;
|
|
742
762
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
743
763
|
disableDownload?: boolean | null;
|
|
744
764
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -825,18 +845,24 @@ export declare enum LayoutType {
|
|
|
825
845
|
/** Fullsize images type */
|
|
826
846
|
FULLSIZE = "FULLSIZE"
|
|
827
847
|
}
|
|
848
|
+
/** @enumType */
|
|
849
|
+
export type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
828
850
|
export declare enum Orientation {
|
|
829
851
|
/** Rows Orientation */
|
|
830
852
|
ROWS = "ROWS",
|
|
831
853
|
/** Columns Orientation */
|
|
832
854
|
COLUMNS = "COLUMNS"
|
|
833
855
|
}
|
|
856
|
+
/** @enumType */
|
|
857
|
+
export type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
834
858
|
export declare enum Crop {
|
|
835
859
|
/** Crop to fill */
|
|
836
860
|
FILL = "FILL",
|
|
837
861
|
/** Crop to fit */
|
|
838
862
|
FIT = "FIT"
|
|
839
863
|
}
|
|
864
|
+
/** @enumType */
|
|
865
|
+
export type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
840
866
|
export declare enum ThumbnailsAlignment {
|
|
841
867
|
/** Top alignment */
|
|
842
868
|
TOP = "TOP",
|
|
@@ -849,13 +875,15 @@ export declare enum ThumbnailsAlignment {
|
|
|
849
875
|
/** No thumbnail */
|
|
850
876
|
NONE = "NONE"
|
|
851
877
|
}
|
|
878
|
+
/** @enumType */
|
|
879
|
+
export type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
852
880
|
export interface Layout {
|
|
853
881
|
/** Gallery layout type. */
|
|
854
|
-
type?:
|
|
882
|
+
type?: LayoutTypeWithLiterals;
|
|
855
883
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
856
884
|
horizontalScroll?: boolean | null;
|
|
857
885
|
/** Gallery orientation. */
|
|
858
|
-
orientation?:
|
|
886
|
+
orientation?: OrientationWithLiterals;
|
|
859
887
|
/** The number of columns to display on full size screens. */
|
|
860
888
|
numberOfColumns?: number | null;
|
|
861
889
|
/** The number of columns to display on mobile screens. */
|
|
@@ -867,13 +895,13 @@ export interface ItemStyle {
|
|
|
867
895
|
/** Item ratio */
|
|
868
896
|
ratio?: number | null;
|
|
869
897
|
/** Sets how item images are cropped. */
|
|
870
|
-
crop?:
|
|
898
|
+
crop?: CropWithLiterals;
|
|
871
899
|
/** The spacing between items in pixels. */
|
|
872
900
|
spacing?: number | null;
|
|
873
901
|
}
|
|
874
902
|
export interface Thumbnails {
|
|
875
903
|
/** Thumbnail alignment. */
|
|
876
|
-
placement?:
|
|
904
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
877
905
|
/** Spacing between thumbnails in pixels. */
|
|
878
906
|
spacing?: number | null;
|
|
879
907
|
}
|
|
@@ -889,7 +917,7 @@ export interface GIFData {
|
|
|
889
917
|
/** Width in pixels. */
|
|
890
918
|
width?: number;
|
|
891
919
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
892
|
-
gifType?:
|
|
920
|
+
gifType?: GIFTypeWithLiterals;
|
|
893
921
|
}
|
|
894
922
|
export interface GIF {
|
|
895
923
|
/**
|
|
@@ -912,6 +940,8 @@ export declare enum GIFType {
|
|
|
912
940
|
NORMAL = "NORMAL",
|
|
913
941
|
STICKER = "STICKER"
|
|
914
942
|
}
|
|
943
|
+
/** @enumType */
|
|
944
|
+
export type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
915
945
|
export interface HeadingData {
|
|
916
946
|
/** Heading level from 1-6. */
|
|
917
947
|
level?: number;
|
|
@@ -933,7 +963,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
933
963
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
934
964
|
containerData?: PluginContainerData;
|
|
935
965
|
/** The type of HTML code. */
|
|
936
|
-
source?:
|
|
966
|
+
source?: SourceWithLiterals;
|
|
937
967
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
938
968
|
autoHeight?: boolean | null;
|
|
939
969
|
}
|
|
@@ -953,6 +983,8 @@ export declare enum Source {
|
|
|
953
983
|
HTML = "HTML",
|
|
954
984
|
ADSENSE = "ADSENSE"
|
|
955
985
|
}
|
|
986
|
+
/** @enumType */
|
|
987
|
+
export type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
956
988
|
export interface ImageData {
|
|
957
989
|
/** Styling for the image's container. */
|
|
958
990
|
containerData?: PluginContainerData;
|
|
@@ -1017,6 +1049,8 @@ export declare enum StylesPosition {
|
|
|
1017
1049
|
/** Thumbnail hidden and not displayed */
|
|
1018
1050
|
HIDDEN = "HIDDEN"
|
|
1019
1051
|
}
|
|
1052
|
+
/** @enumType */
|
|
1053
|
+
export type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
1020
1054
|
export interface LinkPreviewDataStyles {
|
|
1021
1055
|
/**
|
|
1022
1056
|
* Background color as a hexadecimal value.
|
|
@@ -1048,7 +1082,7 @@ export interface LinkPreviewDataStyles {
|
|
|
1048
1082
|
*/
|
|
1049
1083
|
borderColor?: string | null;
|
|
1050
1084
|
/** Position of thumbnail. Defaults to `START`. */
|
|
1051
|
-
thumbnailPosition?:
|
|
1085
|
+
thumbnailPosition?: StylesPositionWithLiterals;
|
|
1052
1086
|
}
|
|
1053
1087
|
export interface MapData {
|
|
1054
1088
|
/** Styling for the map's container. */
|
|
@@ -1078,7 +1112,7 @@ export interface MapSettings {
|
|
|
1078
1112
|
/** Initial zoom value. */
|
|
1079
1113
|
initialZoom?: number | null;
|
|
1080
1114
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
1081
|
-
mapType?:
|
|
1115
|
+
mapType?: MapTypeWithLiterals;
|
|
1082
1116
|
}
|
|
1083
1117
|
export declare enum MapType {
|
|
1084
1118
|
/** Roadmap map type */
|
|
@@ -1090,6 +1124,8 @@ export declare enum MapType {
|
|
|
1090
1124
|
/** Terrain map type */
|
|
1091
1125
|
TERRAIN = "TERRAIN"
|
|
1092
1126
|
}
|
|
1127
|
+
/** @enumType */
|
|
1128
|
+
export type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
1093
1129
|
export interface ParagraphData {
|
|
1094
1130
|
/** Styling for the paragraph text. */
|
|
1095
1131
|
textStyle?: TextStyle;
|
|
@@ -1116,17 +1152,21 @@ export declare enum ViewRole {
|
|
|
1116
1152
|
/** Anyone can see the results, even if one didn't vote */
|
|
1117
1153
|
EVERYONE = "EVERYONE"
|
|
1118
1154
|
}
|
|
1155
|
+
/** @enumType */
|
|
1156
|
+
export type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
1119
1157
|
export declare enum VoteRole {
|
|
1120
1158
|
/** Logged in member */
|
|
1121
1159
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
1122
1160
|
/** Anyone */
|
|
1123
1161
|
ALL = "ALL"
|
|
1124
1162
|
}
|
|
1163
|
+
/** @enumType */
|
|
1164
|
+
export type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
1125
1165
|
export interface Permissions {
|
|
1126
1166
|
/** Sets who can view the poll results. */
|
|
1127
|
-
view?:
|
|
1167
|
+
view?: ViewRoleWithLiterals;
|
|
1128
1168
|
/** Sets who can vote. */
|
|
1129
|
-
vote?:
|
|
1169
|
+
vote?: VoteRoleWithLiterals;
|
|
1130
1170
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
1131
1171
|
allowMultipleVotes?: boolean | null;
|
|
1132
1172
|
}
|
|
@@ -1152,17 +1192,21 @@ export declare enum PollLayoutType {
|
|
|
1152
1192
|
/** Grid */
|
|
1153
1193
|
GRID = "GRID"
|
|
1154
1194
|
}
|
|
1195
|
+
/** @enumType */
|
|
1196
|
+
export type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1155
1197
|
export declare enum PollLayoutDirection {
|
|
1156
1198
|
/** Left-to-right */
|
|
1157
1199
|
LTR = "LTR",
|
|
1158
1200
|
/** Right-to-left */
|
|
1159
1201
|
RTL = "RTL"
|
|
1160
1202
|
}
|
|
1203
|
+
/** @enumType */
|
|
1204
|
+
export type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1161
1205
|
export interface PollLayout {
|
|
1162
1206
|
/** The layout for displaying the voting options. */
|
|
1163
|
-
type?:
|
|
1207
|
+
type?: PollLayoutTypeWithLiterals;
|
|
1164
1208
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
1165
|
-
direction?:
|
|
1209
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
1166
1210
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1167
1211
|
enableImage?: boolean | null;
|
|
1168
1212
|
}
|
|
@@ -1178,6 +1222,8 @@ export declare enum BackgroundType {
|
|
|
1178
1222
|
/** Gradiant background type */
|
|
1179
1223
|
GRADIENT = "GRADIENT"
|
|
1180
1224
|
}
|
|
1225
|
+
/** @enumType */
|
|
1226
|
+
export type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1181
1227
|
export interface Gradient {
|
|
1182
1228
|
/** The gradient angle in degrees. */
|
|
1183
1229
|
angle?: number | null;
|
|
@@ -1203,7 +1249,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1203
1249
|
/** Details for a gradient background. */
|
|
1204
1250
|
gradient?: Gradient;
|
|
1205
1251
|
/** Background type. For each option, include the relevant details. */
|
|
1206
|
-
type?:
|
|
1252
|
+
type?: BackgroundTypeWithLiterals;
|
|
1207
1253
|
}
|
|
1208
1254
|
/** @oneof */
|
|
1209
1255
|
export interface BackgroundBackgroundOneOf {
|
|
@@ -1282,7 +1328,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
1282
1328
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1283
1329
|
strikethroughData?: boolean | null;
|
|
1284
1330
|
/** The type of decoration to apply. */
|
|
1285
|
-
type?:
|
|
1331
|
+
type?: DecorationTypeWithLiterals;
|
|
1286
1332
|
}
|
|
1287
1333
|
/** @oneof */
|
|
1288
1334
|
export interface DecorationDataOneOf {
|
|
@@ -1320,6 +1366,8 @@ export declare enum DecorationType {
|
|
|
1320
1366
|
EXTERNAL = "EXTERNAL",
|
|
1321
1367
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1322
1368
|
}
|
|
1369
|
+
/** @enumType */
|
|
1370
|
+
export type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
1323
1371
|
export interface AnchorData {
|
|
1324
1372
|
/** The target node's ID. */
|
|
1325
1373
|
anchor?: string;
|
|
@@ -1344,7 +1392,7 @@ export interface MentionData {
|
|
|
1344
1392
|
}
|
|
1345
1393
|
export interface FontSizeData {
|
|
1346
1394
|
/** The units used for the font size. */
|
|
1347
|
-
unit?:
|
|
1395
|
+
unit?: FontTypeWithLiterals;
|
|
1348
1396
|
/** Font size value. */
|
|
1349
1397
|
value?: number | null;
|
|
1350
1398
|
}
|
|
@@ -1352,6 +1400,8 @@ export declare enum FontType {
|
|
|
1352
1400
|
PX = "PX",
|
|
1353
1401
|
EM = "EM"
|
|
1354
1402
|
}
|
|
1403
|
+
/** @enumType */
|
|
1404
|
+
export type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1355
1405
|
export interface SpoilerData {
|
|
1356
1406
|
/** Spoiler ID. */
|
|
1357
1407
|
id?: string | null;
|
|
@@ -1362,7 +1412,7 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1362
1412
|
/** Data for embedded Wix Events content. */
|
|
1363
1413
|
eventData?: EventData;
|
|
1364
1414
|
/** The type of Wix App content being embedded. */
|
|
1365
|
-
type?:
|
|
1415
|
+
type?: AppTypeWithLiterals;
|
|
1366
1416
|
/** The ID of the embedded content. */
|
|
1367
1417
|
itemId?: string | null;
|
|
1368
1418
|
/** The name of the embedded content. */
|
|
@@ -1389,6 +1439,8 @@ export declare enum AppType {
|
|
|
1389
1439
|
EVENT = "EVENT",
|
|
1390
1440
|
BOOKING = "BOOKING"
|
|
1391
1441
|
}
|
|
1442
|
+
/** @enumType */
|
|
1443
|
+
export type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1392
1444
|
export interface BookingData {
|
|
1393
1445
|
/** Booking duration in minutes. */
|
|
1394
1446
|
durations?: string | null;
|
|
@@ -1467,9 +1519,9 @@ export interface CollapsibleListData {
|
|
|
1467
1519
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
1468
1520
|
expandOnlyOne?: boolean | null;
|
|
1469
1521
|
/** Sets which items are expanded when the page loads. */
|
|
1470
|
-
initialExpandedItems?:
|
|
1522
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
1471
1523
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1472
|
-
direction?:
|
|
1524
|
+
direction?: DirectionWithLiterals;
|
|
1473
1525
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1474
1526
|
isQapageData?: boolean | null;
|
|
1475
1527
|
}
|
|
@@ -1481,12 +1533,16 @@ export declare enum InitialExpandedItems {
|
|
|
1481
1533
|
/** All items collapsed initally */
|
|
1482
1534
|
NONE = "NONE"
|
|
1483
1535
|
}
|
|
1536
|
+
/** @enumType */
|
|
1537
|
+
export type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1484
1538
|
export declare enum Direction {
|
|
1485
1539
|
/** Left-to-right */
|
|
1486
1540
|
LTR = "LTR",
|
|
1487
1541
|
/** Right-to-left */
|
|
1488
1542
|
RTL = "RTL"
|
|
1489
1543
|
}
|
|
1544
|
+
/** @enumType */
|
|
1545
|
+
export type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1490
1546
|
export interface TableData {
|
|
1491
1547
|
/** Styling for the table's container. */
|
|
1492
1548
|
containerData?: PluginContainerData;
|
|
@@ -1524,9 +1580,11 @@ export declare enum VerticalAlignment {
|
|
|
1524
1580
|
/** Bottom alignment */
|
|
1525
1581
|
BOTTOM = "BOTTOM"
|
|
1526
1582
|
}
|
|
1583
|
+
/** @enumType */
|
|
1584
|
+
export type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1527
1585
|
export interface CellStyle {
|
|
1528
1586
|
/** Vertical alignment for the cell's text. */
|
|
1529
|
-
verticalAlignment?:
|
|
1587
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1530
1588
|
/**
|
|
1531
1589
|
* Cell background color as a hexadecimal value.
|
|
1532
1590
|
* @format COLOR_HEX
|
|
@@ -1565,6 +1623,8 @@ export declare enum NullValue {
|
|
|
1565
1623
|
/** Null value. */
|
|
1566
1624
|
NULL_VALUE = "NULL_VALUE"
|
|
1567
1625
|
}
|
|
1626
|
+
/** @enumType */
|
|
1627
|
+
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
1568
1628
|
/**
|
|
1569
1629
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
1570
1630
|
*
|
|
@@ -1904,7 +1964,7 @@ export interface CreateCategoryRequest {
|
|
|
1904
1964
|
* Fields to include in the response.
|
|
1905
1965
|
* @maxSize 100
|
|
1906
1966
|
*/
|
|
1907
|
-
fields?:
|
|
1967
|
+
fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
|
|
1908
1968
|
}
|
|
1909
1969
|
export declare enum SingleEntityOpsRequestedFields {
|
|
1910
1970
|
/** Not implemented. */
|
|
@@ -1913,6 +1973,8 @@ export declare enum SingleEntityOpsRequestedFields {
|
|
|
1913
1973
|
DESCRIPTION = "DESCRIPTION",
|
|
1914
1974
|
RICH_CONTENT_DESCRIPTION = "RICH_CONTENT_DESCRIPTION"
|
|
1915
1975
|
}
|
|
1976
|
+
/** @enumType */
|
|
1977
|
+
export type SingleEntityOpsRequestedFieldsWithLiterals = SingleEntityOpsRequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'BREADCRUMBS_INFO' | 'DESCRIPTION' | 'RICH_CONTENT_DESCRIPTION';
|
|
1916
1978
|
export interface CreateCategoryResponse {
|
|
1917
1979
|
/** Created category. */
|
|
1918
1980
|
category?: Category;
|
|
@@ -1929,7 +1991,7 @@ export interface GetCategoryRequest {
|
|
|
1929
1991
|
* Fields to include in the response.
|
|
1930
1992
|
* @maxSize 100
|
|
1931
1993
|
*/
|
|
1932
|
-
fields?:
|
|
1994
|
+
fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
|
|
1933
1995
|
}
|
|
1934
1996
|
export interface GetCategoryResponse {
|
|
1935
1997
|
/** Category. */
|
|
@@ -1944,7 +2006,7 @@ export interface UpdateCategoryRequest {
|
|
|
1944
2006
|
* Fields to include in the response.
|
|
1945
2007
|
* @maxSize 100
|
|
1946
2008
|
*/
|
|
1947
|
-
fields?:
|
|
2009
|
+
fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
|
|
1948
2010
|
}
|
|
1949
2011
|
export interface UpdateCategoryResponse {
|
|
1950
2012
|
/** Updated category. */
|
|
@@ -1976,7 +2038,7 @@ export interface QueryCategoriesRequest {
|
|
|
1976
2038
|
* Fields to include in the response.
|
|
1977
2039
|
* @maxSize 100
|
|
1978
2040
|
*/
|
|
1979
|
-
fields?:
|
|
2041
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
1980
2042
|
}
|
|
1981
2043
|
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1982
2044
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -2009,7 +2071,7 @@ export interface Sorting {
|
|
|
2009
2071
|
*/
|
|
2010
2072
|
fieldName?: string;
|
|
2011
2073
|
/** Sort order. */
|
|
2012
|
-
order?:
|
|
2074
|
+
order?: SortOrderWithLiterals;
|
|
2013
2075
|
}
|
|
2014
2076
|
export declare enum SortOrder {
|
|
2015
2077
|
/** Ascending order. */
|
|
@@ -2017,6 +2079,8 @@ export declare enum SortOrder {
|
|
|
2017
2079
|
/** Descending order. */
|
|
2018
2080
|
DESC = "DESC"
|
|
2019
2081
|
}
|
|
2082
|
+
/** @enumType */
|
|
2083
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2020
2084
|
export interface CursorPaging {
|
|
2021
2085
|
/**
|
|
2022
2086
|
* Maximum number of items to return in the results.
|
|
@@ -2037,6 +2101,8 @@ export declare enum RequestedFields {
|
|
|
2037
2101
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
2038
2102
|
BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
|
|
2039
2103
|
}
|
|
2104
|
+
/** @enumType */
|
|
2105
|
+
export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'BREADCRUMBS_INFO';
|
|
2040
2106
|
export interface QueryCategoriesResponse {
|
|
2041
2107
|
/**
|
|
2042
2108
|
* List of categories.
|
|
@@ -2117,7 +2183,7 @@ export interface SearchCategoriesRequest {
|
|
|
2117
2183
|
* Fields to include in the response.
|
|
2118
2184
|
* @maxSize 100
|
|
2119
2185
|
*/
|
|
2120
|
-
fields?:
|
|
2186
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2121
2187
|
}
|
|
2122
2188
|
export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
2123
2189
|
/**
|
|
@@ -2176,7 +2242,7 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
2176
2242
|
*/
|
|
2177
2243
|
name?: string | null;
|
|
2178
2244
|
/** Type of aggregation, client must provide matching aggregation field below */
|
|
2179
|
-
type?:
|
|
2245
|
+
type?: AggregationTypeWithLiterals;
|
|
2180
2246
|
/**
|
|
2181
2247
|
* Field to aggregate by, use dot notation to specify json path
|
|
2182
2248
|
* @maxLength 200
|
|
@@ -2208,18 +2274,24 @@ export declare enum SortType {
|
|
|
2208
2274
|
/** Sort alphabetically by field value. */
|
|
2209
2275
|
VALUE = "VALUE"
|
|
2210
2276
|
}
|
|
2277
|
+
/** @enumType */
|
|
2278
|
+
export type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
2211
2279
|
export declare enum SortDirection {
|
|
2212
2280
|
/** Sort in descending order. */
|
|
2213
2281
|
DESC = "DESC",
|
|
2214
2282
|
/** Sort in ascending order. */
|
|
2215
2283
|
ASC = "ASC"
|
|
2216
2284
|
}
|
|
2285
|
+
/** @enumType */
|
|
2286
|
+
export type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
2217
2287
|
export declare enum MissingValues {
|
|
2218
2288
|
/** Exclude missing values from the aggregation results. */
|
|
2219
2289
|
EXCLUDE = "EXCLUDE",
|
|
2220
2290
|
/** Included missing values in the aggregation results. */
|
|
2221
2291
|
INCLUDE = "INCLUDE"
|
|
2222
2292
|
}
|
|
2293
|
+
/** @enumType */
|
|
2294
|
+
export type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
2223
2295
|
export interface IncludeMissingValuesOptions {
|
|
2224
2296
|
/**
|
|
2225
2297
|
* Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
@@ -2236,20 +2308,22 @@ export declare enum ScalarType {
|
|
|
2236
2308
|
/** Maximum value. */
|
|
2237
2309
|
MAX = "MAX"
|
|
2238
2310
|
}
|
|
2311
|
+
/** @enumType */
|
|
2312
|
+
export type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
2239
2313
|
export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
2240
2314
|
/** Options for including missing values */
|
|
2241
2315
|
includeOptions?: IncludeMissingValuesOptions;
|
|
2242
2316
|
/** Type of sort to perform. */
|
|
2243
|
-
sortType?:
|
|
2317
|
+
sortType?: SortTypeWithLiterals;
|
|
2244
2318
|
/** Direction to sort in. */
|
|
2245
|
-
sortDirection?:
|
|
2319
|
+
sortDirection?: SortDirectionWithLiterals;
|
|
2246
2320
|
/** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
|
|
2247
2321
|
limit?: number | null;
|
|
2248
2322
|
/**
|
|
2249
2323
|
* Whether missing values are included in the aggregation results.
|
|
2250
2324
|
* Default: `EXCLUDE`
|
|
2251
2325
|
*/
|
|
2252
|
-
missingValues?:
|
|
2326
|
+
missingValues?: MissingValuesWithLiterals;
|
|
2253
2327
|
}
|
|
2254
2328
|
/** @oneof */
|
|
2255
2329
|
export interface ValueAggregationOptionsOneOf {
|
|
@@ -2268,6 +2342,8 @@ export declare enum NestedAggregationType {
|
|
|
2268
2342
|
/** An aggregation, where result buckets are dynamically built - one per time interval such as hour, day, and week. */
|
|
2269
2343
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
2270
2344
|
}
|
|
2345
|
+
/** @enumType */
|
|
2346
|
+
export type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
2271
2347
|
export interface RangeAggregation {
|
|
2272
2348
|
/**
|
|
2273
2349
|
* List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
|
|
@@ -2277,11 +2353,11 @@ export interface RangeAggregation {
|
|
|
2277
2353
|
}
|
|
2278
2354
|
export interface ScalarAggregation {
|
|
2279
2355
|
/** Define the operator for the scalar aggregation */
|
|
2280
|
-
type?:
|
|
2356
|
+
type?: ScalarTypeWithLiterals;
|
|
2281
2357
|
}
|
|
2282
2358
|
export interface DateHistogramAggregation {
|
|
2283
2359
|
/** Interval for date histogram aggregation */
|
|
2284
|
-
interval?:
|
|
2360
|
+
interval?: IntervalWithLiterals;
|
|
2285
2361
|
}
|
|
2286
2362
|
export declare enum Interval {
|
|
2287
2363
|
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
@@ -2300,6 +2376,8 @@ export declare enum Interval {
|
|
|
2300
2376
|
/** Second interval */
|
|
2301
2377
|
SECOND = "SECOND"
|
|
2302
2378
|
}
|
|
2379
|
+
/** @enumType */
|
|
2380
|
+
export type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
2303
2381
|
export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
2304
2382
|
/** Value aggregation */
|
|
2305
2383
|
value?: ValueAggregation;
|
|
@@ -2315,7 +2393,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
|
2315
2393
|
*/
|
|
2316
2394
|
name?: string | null;
|
|
2317
2395
|
/** Type of aggregation client must provide matching aggregation field below */
|
|
2318
|
-
type?:
|
|
2396
|
+
type?: NestedAggregationTypeWithLiterals;
|
|
2319
2397
|
/**
|
|
2320
2398
|
* Field to aggregate by, use dont notation to specify json path
|
|
2321
2399
|
* @maxLength 200
|
|
@@ -2346,6 +2424,8 @@ export declare enum AggregationType {
|
|
|
2346
2424
|
/** Multi-level aggregation, where each next aggregation is nested within the previous one. */
|
|
2347
2425
|
NESTED = "NESTED"
|
|
2348
2426
|
}
|
|
2427
|
+
/** @enumType */
|
|
2428
|
+
export type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
2349
2429
|
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
2350
2430
|
export interface NestedAggregation {
|
|
2351
2431
|
/**
|
|
@@ -2357,7 +2437,7 @@ export interface NestedAggregation {
|
|
|
2357
2437
|
}
|
|
2358
2438
|
export interface SearchDetails {
|
|
2359
2439
|
/** Defines how separate search terms in `expression` are combined. */
|
|
2360
|
-
mode?:
|
|
2440
|
+
mode?: ModeWithLiterals;
|
|
2361
2441
|
/**
|
|
2362
2442
|
* Search term or expression.
|
|
2363
2443
|
* @maxLength 100
|
|
@@ -2380,6 +2460,8 @@ export declare enum Mode {
|
|
|
2380
2460
|
/** All search terms must be present. */
|
|
2381
2461
|
AND = "AND"
|
|
2382
2462
|
}
|
|
2463
|
+
/** @enumType */
|
|
2464
|
+
export type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
2383
2465
|
export interface SearchCategoriesResponse {
|
|
2384
2466
|
/**
|
|
2385
2467
|
* List of categories.
|
|
@@ -2428,7 +2510,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
|
|
|
2428
2510
|
*/
|
|
2429
2511
|
name?: string;
|
|
2430
2512
|
/** Type of aggregation that matches result */
|
|
2431
|
-
type?:
|
|
2513
|
+
type?: AggregationTypeWithLiterals;
|
|
2432
2514
|
/**
|
|
2433
2515
|
* Field to aggregate by, matches the one provided in request
|
|
2434
2516
|
* @maxLength 200
|
|
@@ -2460,7 +2542,7 @@ export interface RangeResults {
|
|
|
2460
2542
|
}
|
|
2461
2543
|
export interface AggregationResultsScalarResult {
|
|
2462
2544
|
/** Type of scalar aggregation */
|
|
2463
|
-
type?:
|
|
2545
|
+
type?: ScalarTypeWithLiterals;
|
|
2464
2546
|
/** Value of the scalar aggregation */
|
|
2465
2547
|
value?: number;
|
|
2466
2548
|
}
|
|
@@ -2572,7 +2654,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
|
2572
2654
|
*/
|
|
2573
2655
|
name?: string;
|
|
2574
2656
|
/** Type of aggregation that must match provided kind as derived from search request */
|
|
2575
|
-
type?:
|
|
2657
|
+
type?: AggregationTypeWithLiterals;
|
|
2576
2658
|
/**
|
|
2577
2659
|
* Field to aggregate by as derived from search request
|
|
2578
2660
|
* @maxLength 200
|
|
@@ -2605,7 +2687,7 @@ export interface DeprecatedSearchCategoriesWithOffsetRequest {
|
|
|
2605
2687
|
* Fields to include in the response.
|
|
2606
2688
|
* @maxSize 100
|
|
2607
2689
|
*/
|
|
2608
|
-
fields?:
|
|
2690
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2609
2691
|
}
|
|
2610
2692
|
export interface OffsetSearch extends OffsetSearchPagingMethodOneOf {
|
|
2611
2693
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
@@ -2715,7 +2797,7 @@ export interface MoveCategoryRequest {
|
|
|
2715
2797
|
* + `LAST`: Position the category as the last subcategory.
|
|
2716
2798
|
* + `AFTER`: Position the category after the category ID passed in `moveAfterCategoryId`.
|
|
2717
2799
|
*/
|
|
2718
|
-
position:
|
|
2800
|
+
position: PositionWithLiterals;
|
|
2719
2801
|
/**
|
|
2720
2802
|
* Required when passing `position: AFTER`.
|
|
2721
2803
|
* @format GUID
|
|
@@ -2728,6 +2810,8 @@ export declare enum Position {
|
|
|
2728
2810
|
LAST = "LAST",
|
|
2729
2811
|
AFTER = "AFTER"
|
|
2730
2812
|
}
|
|
2813
|
+
/** @enumType */
|
|
2814
|
+
export type PositionWithLiterals = Position | 'UNKNOWN_POSITION' | 'FIRST' | 'LAST' | 'AFTER';
|
|
2731
2815
|
export interface MoveCategoryResponse {
|
|
2732
2816
|
/**
|
|
2733
2817
|
* Parent category ID.
|
|
@@ -2760,7 +2844,7 @@ export interface BulkCreateCategoriesRequest {
|
|
|
2760
2844
|
* Fields to include in the response.
|
|
2761
2845
|
* @maxSize 100
|
|
2762
2846
|
*/
|
|
2763
|
-
fields?:
|
|
2847
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2764
2848
|
}
|
|
2765
2849
|
export interface BulkCreateCategoriesResponse {
|
|
2766
2850
|
/**
|
|
@@ -2830,7 +2914,7 @@ export interface BulkUpdateCategoriesRequest {
|
|
|
2830
2914
|
* Fields to include in the response.
|
|
2831
2915
|
* @maxSize 100
|
|
2832
2916
|
*/
|
|
2833
|
-
fields?:
|
|
2917
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2834
2918
|
}
|
|
2835
2919
|
export interface MaskedCategory {
|
|
2836
2920
|
/** Category to update. */
|
|
@@ -2870,7 +2954,7 @@ export interface UpdateCategoryVisibilityRequest {
|
|
|
2870
2954
|
* Fields to include in the response.
|
|
2871
2955
|
* @maxSize 100
|
|
2872
2956
|
*/
|
|
2873
|
-
fields?:
|
|
2957
|
+
fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
|
|
2874
2958
|
}
|
|
2875
2959
|
export interface UpdateCategoryVisibilityResponse {
|
|
2876
2960
|
/** Updated category. */
|
|
@@ -2896,7 +2980,7 @@ export interface BulkShowCategoriesRequest {
|
|
|
2896
2980
|
* Fields to include in the response.
|
|
2897
2981
|
* @maxSize 100
|
|
2898
2982
|
*/
|
|
2899
|
-
fields?:
|
|
2983
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
2900
2984
|
}
|
|
2901
2985
|
export interface BulkShowCategoriesResponse {
|
|
2902
2986
|
/**
|
|
@@ -3227,7 +3311,7 @@ export interface MoveItemInCategoryRequest {
|
|
|
3227
3311
|
* `BEFORE` - requires `before_item`, `item` will be moved before it. If `before_item` was 100th item in category it will be removed from list of items with manual arrangement.
|
|
3228
3312
|
* `NONE` - don't use manual arrangement for `item`, it will be shown after all items with manual arrangement according to default sorting.
|
|
3229
3313
|
*/
|
|
3230
|
-
position?:
|
|
3314
|
+
position?: MoveItemInCategoryRequestPositionWithLiterals;
|
|
3231
3315
|
/** Required when `position` is `BEFORE`. `before_item` must be manually arranged item. */
|
|
3232
3316
|
beforeItem?: ItemReference;
|
|
3233
3317
|
}
|
|
@@ -3238,6 +3322,8 @@ export declare enum MoveItemInCategoryRequestPosition {
|
|
|
3238
3322
|
BEFORE = "BEFORE",
|
|
3239
3323
|
NONE = "NONE"
|
|
3240
3324
|
}
|
|
3325
|
+
/** @enumType */
|
|
3326
|
+
export type MoveItemInCategoryRequestPositionWithLiterals = MoveItemInCategoryRequestPosition | 'UNKNOWN_POSITION' | 'FIRST' | 'LAST' | 'BEFORE' | 'NONE';
|
|
3241
3327
|
export interface MoveItemInCategoryResponse {
|
|
3242
3328
|
/**
|
|
3243
3329
|
* Information about manually arranged items after move.
|
|
@@ -3305,25 +3391,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3305
3391
|
updatedEvent?: EntityUpdatedEvent;
|
|
3306
3392
|
deletedEvent?: EntityDeletedEvent;
|
|
3307
3393
|
actionEvent?: ActionEvent;
|
|
3308
|
-
/**
|
|
3309
|
-
* Unique event ID.
|
|
3310
|
-
* Allows clients to ignore duplicate webhooks.
|
|
3311
|
-
*/
|
|
3394
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3312
3395
|
id?: string;
|
|
3313
3396
|
/**
|
|
3314
|
-
*
|
|
3315
|
-
*
|
|
3397
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3398
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3316
3399
|
*/
|
|
3317
3400
|
entityFqdn?: string;
|
|
3318
3401
|
/**
|
|
3319
|
-
*
|
|
3320
|
-
*
|
|
3321
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
3402
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3403
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3322
3404
|
*/
|
|
3323
3405
|
slug?: string;
|
|
3324
3406
|
/** ID of the entity associated with the event. */
|
|
3325
3407
|
entityId?: string;
|
|
3326
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
3408
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3327
3409
|
eventTime?: Date | null;
|
|
3328
3410
|
/**
|
|
3329
3411
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -3333,12 +3415,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
3333
3415
|
/** If present, indicates the action that triggered the event. */
|
|
3334
3416
|
originatedFrom?: string | null;
|
|
3335
3417
|
/**
|
|
3336
|
-
* A sequence number
|
|
3337
|
-
*
|
|
3338
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
3339
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
3340
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
3341
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
3418
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3419
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3342
3420
|
*/
|
|
3343
3421
|
entityEventSequence?: string | null;
|
|
3344
3422
|
}
|
|
@@ -3366,7 +3444,7 @@ export interface EntityUpdatedEvent {
|
|
|
3366
3444
|
currentEntityAsJson?: string;
|
|
3367
3445
|
}
|
|
3368
3446
|
export interface EntityDeletedEvent {
|
|
3369
|
-
/** Entity that was deleted */
|
|
3447
|
+
/** Entity that was deleted. */
|
|
3370
3448
|
deletedEntityAsJson?: string | null;
|
|
3371
3449
|
}
|
|
3372
3450
|
export interface ActionEvent {
|
|
@@ -3412,7 +3490,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
3412
3490
|
*/
|
|
3413
3491
|
appId?: string;
|
|
3414
3492
|
/** @readonly */
|
|
3415
|
-
identityType?:
|
|
3493
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3416
3494
|
}
|
|
3417
3495
|
/** @oneof */
|
|
3418
3496
|
export interface IdentificationDataIdOneOf {
|
|
@@ -3444,3 +3522,5 @@ export declare enum WebhookIdentityType {
|
|
|
3444
3522
|
WIX_USER = "WIX_USER",
|
|
3445
3523
|
APP = "APP"
|
|
3446
3524
|
}
|
|
3525
|
+
/** @enumType */
|
|
3526
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|