@wix/auto_sdk_faq_question-entry 1.0.10 → 1.0.12
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/{faq-question-entry-v2-question-entry-question-entry.universal-CN5rcTeE.d.mts → cjs/faq-question-entry-v2-question-entry-question-entry.universal-H7icQXKK.d.ts} +156 -90
- package/build/{internal → cjs}/index.d.ts +10 -8
- package/build/{internal → cjs}/index.js +83 -53
- package/build/cjs/index.js.map +1 -0
- package/build/{internal → cjs}/meta.d.ts +120 -40
- package/build/{faq-question-entry-v2-question-entry-question-entry.universal-CN5rcTeE.d.ts → es/faq-question-entry-v2-question-entry-question-entry.universal-H7icQXKK.d.mts} +156 -90
- package/build/{internal → es}/index.d.mts +10 -8
- package/build/{internal → es}/index.mjs +83 -53
- package/build/es/index.mjs.map +1 -0
- package/build/{internal → es}/meta.d.mts +120 -40
- package/build/es/package.json +3 -0
- package/build/internal/{faq-question-entry-v2-question-entry-question-entry.universal-CN5rcTeE.d.ts → cjs/faq-question-entry-v2-question-entry-question-entry.universal-H7icQXKK.d.ts} +156 -90
- package/build/{index.d.ts → internal/cjs/index.d.ts} +10 -8
- package/build/{index.js → internal/cjs/index.js} +83 -53
- package/build/internal/cjs/index.js.map +1 -0
- package/build/{meta.d.ts → internal/cjs/meta.d.ts} +120 -40
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/{faq-question-entry-v2-question-entry-question-entry.universal-CN5rcTeE.d.mts → es/faq-question-entry-v2-question-entry-question-entry.universal-H7icQXKK.d.mts} +156 -90
- package/build/{index.d.mts → internal/es/index.d.mts} +10 -8
- package/build/{index.mjs → internal/es/index.mjs} +83 -53
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{meta.d.mts → internal/es/meta.d.mts} +120 -40
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +12 -12
- package/build/index.js.map +0 -1
- package/build/index.mjs.map +0 -1
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs.map +0 -1
- package/build/meta.js.map +0 -1
- package/build/meta.mjs.map +0 -1
- /package/build/{internal → cjs}/meta.js +0 -0
- /package/build/{internal → cjs}/meta.js.map +0 -0
- /package/build/{internal → es}/meta.mjs +0 -0
- /package/build/{internal → es}/meta.mjs.map +0 -0
- /package/build/{meta.js → internal/cjs/meta.js} +0 -0
- /package/build/{meta.mjs → internal/es/meta.mjs} +0 -0
|
@@ -51,7 +51,7 @@ interface QuestionEntry extends QuestionEntryAnswerOneOf {
|
|
|
51
51
|
/** Order of question out of all questions (and not only in the category). */
|
|
52
52
|
sortOrder?: number | null;
|
|
53
53
|
/** Question's visibility status within the site. */
|
|
54
|
-
status?:
|
|
54
|
+
status?: QuestionStatusWithLiterals;
|
|
55
55
|
/**
|
|
56
56
|
* ID of the category to which this question belongs.
|
|
57
57
|
* @minLength 1
|
|
@@ -154,9 +154,9 @@ interface Node extends NodeDataOneOf {
|
|
|
154
154
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
155
155
|
layoutCellData?: LayoutCellData;
|
|
156
156
|
/** 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. */
|
|
157
|
-
type?:
|
|
157
|
+
type?: NodeTypeWithLiterals;
|
|
158
158
|
/** Node ID. */
|
|
159
|
-
|
|
159
|
+
id?: string;
|
|
160
160
|
/** A list of child nodes. */
|
|
161
161
|
nodes?: Node[];
|
|
162
162
|
/** Padding and background color styling for the node. */
|
|
@@ -255,6 +255,8 @@ declare enum NodeType {
|
|
|
255
255
|
LAYOUT = "LAYOUT",
|
|
256
256
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
257
257
|
}
|
|
258
|
+
/** @enumType */
|
|
259
|
+
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';
|
|
258
260
|
interface NodeStyle {
|
|
259
261
|
/** The top padding value in pixels. */
|
|
260
262
|
paddingTop?: string | null;
|
|
@@ -267,7 +269,7 @@ interface ButtonData {
|
|
|
267
269
|
/** Styling for the button's container. */
|
|
268
270
|
containerData?: PluginContainerData;
|
|
269
271
|
/** The button type. */
|
|
270
|
-
type?:
|
|
272
|
+
type?: TypeWithLiterals;
|
|
271
273
|
/** Styling for the button. */
|
|
272
274
|
styles?: Styles;
|
|
273
275
|
/** The text to display on the button. */
|
|
@@ -308,7 +310,7 @@ interface PluginContainerData {
|
|
|
308
310
|
/** The width of the node when it's displayed. */
|
|
309
311
|
width?: PluginContainerDataWidth;
|
|
310
312
|
/** The node's alignment within its container. */
|
|
311
|
-
alignment?:
|
|
313
|
+
alignment?: PluginContainerDataAlignmentWithLiterals;
|
|
312
314
|
/** Spoiler cover settings for the node. */
|
|
313
315
|
spoiler?: Spoiler;
|
|
314
316
|
/** The height of the node when it's displayed. */
|
|
@@ -326,6 +328,8 @@ declare enum WidthType {
|
|
|
326
328
|
/** coast-to-coast display */
|
|
327
329
|
FULL_WIDTH = "FULL_WIDTH"
|
|
328
330
|
}
|
|
331
|
+
/** @enumType */
|
|
332
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
329
333
|
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
330
334
|
/**
|
|
331
335
|
* One of the following predefined width options:
|
|
@@ -334,7 +338,7 @@ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
|
334
338
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
335
339
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
336
340
|
*/
|
|
337
|
-
size?:
|
|
341
|
+
size?: WidthTypeWithLiterals;
|
|
338
342
|
/** A custom width value in pixels. */
|
|
339
343
|
custom?: string | null;
|
|
340
344
|
}
|
|
@@ -347,7 +351,7 @@ interface PluginContainerDataWidthDataOneOf {
|
|
|
347
351
|
* `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
|
|
348
352
|
* `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
349
353
|
*/
|
|
350
|
-
size?:
|
|
354
|
+
size?: WidthTypeWithLiterals;
|
|
351
355
|
/** A custom width value in pixels. */
|
|
352
356
|
custom?: string | null;
|
|
353
357
|
}
|
|
@@ -359,6 +363,8 @@ declare enum PluginContainerDataAlignment {
|
|
|
359
363
|
/** Right Alignment */
|
|
360
364
|
RIGHT = "RIGHT"
|
|
361
365
|
}
|
|
366
|
+
/** @enumType */
|
|
367
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
362
368
|
interface Spoiler {
|
|
363
369
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
364
370
|
enabled?: boolean | null;
|
|
@@ -377,6 +383,8 @@ declare enum Type {
|
|
|
377
383
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
378
384
|
ACTION = "ACTION"
|
|
379
385
|
}
|
|
386
|
+
/** @enumType */
|
|
387
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
380
388
|
interface Styles {
|
|
381
389
|
/**
|
|
382
390
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
@@ -442,7 +450,7 @@ interface Link extends LinkDataOneOf {
|
|
|
442
450
|
* `PARENT` - Opens the linked document in the link's parent frame.
|
|
443
451
|
* `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
444
452
|
*/
|
|
445
|
-
target?:
|
|
453
|
+
target?: TargetWithLiterals;
|
|
446
454
|
/** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
|
|
447
455
|
rel?: Rel;
|
|
448
456
|
/** A serialized object used for a custom or external link panel. */
|
|
@@ -465,6 +473,8 @@ declare enum Target {
|
|
|
465
473
|
/** Opens the linked document in the full body of the window */
|
|
466
474
|
TOP = "TOP"
|
|
467
475
|
}
|
|
476
|
+
/** @enumType */
|
|
477
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
468
478
|
interface Rel {
|
|
469
479
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
470
480
|
nofollow?: boolean | null;
|
|
@@ -481,7 +491,7 @@ interface CodeBlockData {
|
|
|
481
491
|
}
|
|
482
492
|
interface TextStyle {
|
|
483
493
|
/** Text alignment. Defaults to `AUTO`. */
|
|
484
|
-
textAlignment?:
|
|
494
|
+
textAlignment?: TextAlignmentWithLiterals;
|
|
485
495
|
/** 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. */
|
|
486
496
|
lineHeight?: string | null;
|
|
487
497
|
}
|
|
@@ -497,15 +507,17 @@ declare enum TextAlignment {
|
|
|
497
507
|
/** 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 */
|
|
498
508
|
JUSTIFY = "JUSTIFY"
|
|
499
509
|
}
|
|
510
|
+
/** @enumType */
|
|
511
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
500
512
|
interface DividerData {
|
|
501
513
|
/** Styling for the divider's container. */
|
|
502
514
|
containerData?: PluginContainerData;
|
|
503
515
|
/** Divider line style. */
|
|
504
|
-
lineStyle?:
|
|
516
|
+
lineStyle?: LineStyleWithLiterals;
|
|
505
517
|
/** Divider width. */
|
|
506
|
-
width?:
|
|
518
|
+
width?: WidthWithLiterals;
|
|
507
519
|
/** Divider alignment. */
|
|
508
|
-
alignment?:
|
|
520
|
+
alignment?: AlignmentWithLiterals;
|
|
509
521
|
}
|
|
510
522
|
declare enum LineStyle {
|
|
511
523
|
/** Single Line */
|
|
@@ -517,6 +529,8 @@ declare enum LineStyle {
|
|
|
517
529
|
/** Dotted Line */
|
|
518
530
|
DOTTED = "DOTTED"
|
|
519
531
|
}
|
|
532
|
+
/** @enumType */
|
|
533
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
520
534
|
declare enum Width {
|
|
521
535
|
/** Large line */
|
|
522
536
|
LARGE = "LARGE",
|
|
@@ -525,6 +539,8 @@ declare enum Width {
|
|
|
525
539
|
/** Small line */
|
|
526
540
|
SMALL = "SMALL"
|
|
527
541
|
}
|
|
542
|
+
/** @enumType */
|
|
543
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
528
544
|
declare enum Alignment {
|
|
529
545
|
/** Center alignment */
|
|
530
546
|
CENTER = "CENTER",
|
|
@@ -533,6 +549,8 @@ declare enum Alignment {
|
|
|
533
549
|
/** Right alignment */
|
|
534
550
|
RIGHT = "RIGHT"
|
|
535
551
|
}
|
|
552
|
+
/** @enumType */
|
|
553
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
536
554
|
interface FileData {
|
|
537
555
|
/** Styling for the file's container. */
|
|
538
556
|
containerData?: PluginContainerData;
|
|
@@ -564,6 +582,8 @@ declare enum ViewMode {
|
|
|
564
582
|
/** Mini PDF view */
|
|
565
583
|
MINI = "MINI"
|
|
566
584
|
}
|
|
585
|
+
/** @enumType */
|
|
586
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
567
587
|
interface FileSource extends FileSourceDataOneOf {
|
|
568
588
|
/** The absolute URL for the file's source. */
|
|
569
589
|
url?: string | null;
|
|
@@ -573,7 +593,7 @@ interface FileSource extends FileSourceDataOneOf {
|
|
|
573
593
|
*/
|
|
574
594
|
custom?: string | null;
|
|
575
595
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
576
|
-
|
|
596
|
+
id?: string | null;
|
|
577
597
|
/** Indicates whether the file's source is private. Defaults to `false`. */
|
|
578
598
|
private?: boolean | null;
|
|
579
599
|
}
|
|
@@ -587,7 +607,7 @@ interface FileSourceDataOneOf {
|
|
|
587
607
|
*/
|
|
588
608
|
custom?: string | null;
|
|
589
609
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
590
|
-
|
|
610
|
+
id?: string | null;
|
|
591
611
|
}
|
|
592
612
|
interface PDFSettings {
|
|
593
613
|
/**
|
|
@@ -596,7 +616,7 @@ interface PDFSettings {
|
|
|
596
616
|
* `FULL` : A full page view of the PDF is displayed.
|
|
597
617
|
* `MINI` : A mini view of the PDF is displayed.
|
|
598
618
|
*/
|
|
599
|
-
viewMode?:
|
|
619
|
+
viewMode?: ViewModeWithLiterals;
|
|
600
620
|
/** Sets whether the PDF download button is disabled. Defaults to `false`. */
|
|
601
621
|
disableDownload?: boolean | null;
|
|
602
622
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
@@ -683,18 +703,24 @@ declare enum LayoutType {
|
|
|
683
703
|
/** Fullsize images type */
|
|
684
704
|
FULLSIZE = "FULLSIZE"
|
|
685
705
|
}
|
|
706
|
+
/** @enumType */
|
|
707
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
686
708
|
declare enum Orientation {
|
|
687
709
|
/** Rows Orientation */
|
|
688
710
|
ROWS = "ROWS",
|
|
689
711
|
/** Columns Orientation */
|
|
690
712
|
COLUMNS = "COLUMNS"
|
|
691
713
|
}
|
|
714
|
+
/** @enumType */
|
|
715
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
692
716
|
declare enum Crop {
|
|
693
717
|
/** Crop to fill */
|
|
694
718
|
FILL = "FILL",
|
|
695
719
|
/** Crop to fit */
|
|
696
720
|
FIT = "FIT"
|
|
697
721
|
}
|
|
722
|
+
/** @enumType */
|
|
723
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
698
724
|
declare enum ThumbnailsAlignment {
|
|
699
725
|
/** Top alignment */
|
|
700
726
|
TOP = "TOP",
|
|
@@ -707,13 +733,15 @@ declare enum ThumbnailsAlignment {
|
|
|
707
733
|
/** No thumbnail */
|
|
708
734
|
NONE = "NONE"
|
|
709
735
|
}
|
|
736
|
+
/** @enumType */
|
|
737
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
710
738
|
interface Layout {
|
|
711
739
|
/** Gallery layout type. */
|
|
712
|
-
type?:
|
|
740
|
+
type?: LayoutTypeWithLiterals;
|
|
713
741
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
714
742
|
horizontalScroll?: boolean | null;
|
|
715
743
|
/** Gallery orientation. */
|
|
716
|
-
orientation?:
|
|
744
|
+
orientation?: OrientationWithLiterals;
|
|
717
745
|
/** The number of columns to display on full size screens. */
|
|
718
746
|
numberOfColumns?: number | null;
|
|
719
747
|
/** The number of columns to display on mobile screens. */
|
|
@@ -725,13 +753,13 @@ interface ItemStyle {
|
|
|
725
753
|
/** Item ratio */
|
|
726
754
|
ratio?: number | null;
|
|
727
755
|
/** Sets how item images are cropped. */
|
|
728
|
-
crop?:
|
|
756
|
+
crop?: CropWithLiterals;
|
|
729
757
|
/** The spacing between items in pixels. */
|
|
730
758
|
spacing?: number | null;
|
|
731
759
|
}
|
|
732
760
|
interface Thumbnails {
|
|
733
761
|
/** Thumbnail alignment. */
|
|
734
|
-
placement?:
|
|
762
|
+
placement?: ThumbnailsAlignmentWithLiterals;
|
|
735
763
|
/** Spacing between thumbnails in pixels. */
|
|
736
764
|
spacing?: number | null;
|
|
737
765
|
}
|
|
@@ -747,7 +775,7 @@ interface GIFData {
|
|
|
747
775
|
/** Width in pixels. */
|
|
748
776
|
width?: number;
|
|
749
777
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
750
|
-
gifType?:
|
|
778
|
+
gifType?: GIFTypeWithLiterals;
|
|
751
779
|
}
|
|
752
780
|
interface GIF {
|
|
753
781
|
/**
|
|
@@ -770,6 +798,8 @@ declare enum GIFType {
|
|
|
770
798
|
NORMAL = "NORMAL",
|
|
771
799
|
STICKER = "STICKER"
|
|
772
800
|
}
|
|
801
|
+
/** @enumType */
|
|
802
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
773
803
|
interface HeadingData {
|
|
774
804
|
/** Heading level from 1-6. */
|
|
775
805
|
level?: number;
|
|
@@ -791,7 +821,7 @@ interface HTMLData extends HTMLDataDataOneOf {
|
|
|
791
821
|
/** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
|
|
792
822
|
containerData?: PluginContainerData;
|
|
793
823
|
/** The type of HTML code. */
|
|
794
|
-
source?:
|
|
824
|
+
source?: SourceWithLiterals;
|
|
795
825
|
/** If container height is aligned with its content height. Defaults to `true`. */
|
|
796
826
|
autoHeight?: boolean | null;
|
|
797
827
|
}
|
|
@@ -811,6 +841,8 @@ declare enum Source {
|
|
|
811
841
|
HTML = "HTML",
|
|
812
842
|
ADSENSE = "ADSENSE"
|
|
813
843
|
}
|
|
844
|
+
/** @enumType */
|
|
845
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
814
846
|
interface ImageData {
|
|
815
847
|
/** Styling for the image's container. */
|
|
816
848
|
containerData?: PluginContainerData;
|
|
@@ -875,6 +907,8 @@ declare enum Position {
|
|
|
875
907
|
/** Thumbnail hidden and not displayed */
|
|
876
908
|
HIDDEN = "HIDDEN"
|
|
877
909
|
}
|
|
910
|
+
/** @enumType */
|
|
911
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
878
912
|
interface LinkPreviewDataStyles {
|
|
879
913
|
/**
|
|
880
914
|
* Background color as a hexadecimal value.
|
|
@@ -906,7 +940,7 @@ interface LinkPreviewDataStyles {
|
|
|
906
940
|
*/
|
|
907
941
|
borderColor?: string | null;
|
|
908
942
|
/** Position of thumbnail. Defaults to `START`. */
|
|
909
|
-
thumbnailPosition?:
|
|
943
|
+
thumbnailPosition?: PositionWithLiterals;
|
|
910
944
|
}
|
|
911
945
|
interface MapData {
|
|
912
946
|
/** Styling for the map's container. */
|
|
@@ -936,7 +970,7 @@ interface MapSettings {
|
|
|
936
970
|
/** Initial zoom value. */
|
|
937
971
|
initialZoom?: number | null;
|
|
938
972
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
939
|
-
mapType?:
|
|
973
|
+
mapType?: MapTypeWithLiterals;
|
|
940
974
|
}
|
|
941
975
|
declare enum MapType {
|
|
942
976
|
/** Roadmap map type */
|
|
@@ -948,6 +982,8 @@ declare enum MapType {
|
|
|
948
982
|
/** Terrain map type */
|
|
949
983
|
TERRAIN = "TERRAIN"
|
|
950
984
|
}
|
|
985
|
+
/** @enumType */
|
|
986
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
951
987
|
interface ParagraphData {
|
|
952
988
|
/** Styling for the paragraph text. */
|
|
953
989
|
textStyle?: TextStyle;
|
|
@@ -974,23 +1010,27 @@ declare enum ViewRole {
|
|
|
974
1010
|
/** Anyone can see the results, even if one didn't vote */
|
|
975
1011
|
EVERYONE = "EVERYONE"
|
|
976
1012
|
}
|
|
1013
|
+
/** @enumType */
|
|
1014
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
977
1015
|
declare enum VoteRole {
|
|
978
1016
|
/** Logged in member */
|
|
979
1017
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
980
1018
|
/** Anyone */
|
|
981
1019
|
ALL = "ALL"
|
|
982
1020
|
}
|
|
1021
|
+
/** @enumType */
|
|
1022
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
983
1023
|
interface Permissions {
|
|
984
1024
|
/** Sets who can view the poll results. */
|
|
985
|
-
view?:
|
|
1025
|
+
view?: ViewRoleWithLiterals;
|
|
986
1026
|
/** Sets who can vote. */
|
|
987
|
-
vote?:
|
|
1027
|
+
vote?: VoteRoleWithLiterals;
|
|
988
1028
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
989
1029
|
allowMultipleVotes?: boolean | null;
|
|
990
1030
|
}
|
|
991
1031
|
interface Option {
|
|
992
1032
|
/** Option ID. */
|
|
993
|
-
|
|
1033
|
+
id?: string | null;
|
|
994
1034
|
/** Option title. */
|
|
995
1035
|
title?: string | null;
|
|
996
1036
|
/** The image displayed with the option. */
|
|
@@ -1010,17 +1050,21 @@ declare enum PollLayoutType {
|
|
|
1010
1050
|
/** Grid */
|
|
1011
1051
|
GRID = "GRID"
|
|
1012
1052
|
}
|
|
1053
|
+
/** @enumType */
|
|
1054
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
1013
1055
|
declare enum PollLayoutDirection {
|
|
1014
1056
|
/** Left-to-right */
|
|
1015
1057
|
LTR = "LTR",
|
|
1016
1058
|
/** Right-to-left */
|
|
1017
1059
|
RTL = "RTL"
|
|
1018
1060
|
}
|
|
1061
|
+
/** @enumType */
|
|
1062
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
1019
1063
|
interface PollLayout {
|
|
1020
1064
|
/** The layout for displaying the voting options. */
|
|
1021
|
-
type?:
|
|
1065
|
+
type?: PollLayoutTypeWithLiterals;
|
|
1022
1066
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
1023
|
-
direction?:
|
|
1067
|
+
direction?: PollLayoutDirectionWithLiterals;
|
|
1024
1068
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
1025
1069
|
enableImage?: boolean | null;
|
|
1026
1070
|
}
|
|
@@ -1036,6 +1080,8 @@ declare enum BackgroundType {
|
|
|
1036
1080
|
/** Gradiant background type */
|
|
1037
1081
|
GRADIENT = "GRADIENT"
|
|
1038
1082
|
}
|
|
1083
|
+
/** @enumType */
|
|
1084
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
1039
1085
|
interface Gradient {
|
|
1040
1086
|
/** The gradient angle in degrees. */
|
|
1041
1087
|
angle?: number | null;
|
|
@@ -1061,7 +1107,7 @@ interface Background extends BackgroundBackgroundOneOf {
|
|
|
1061
1107
|
/** Details for a gradient background. */
|
|
1062
1108
|
gradient?: Gradient;
|
|
1063
1109
|
/** Background type. For each option, include the relevant details. */
|
|
1064
|
-
type?:
|
|
1110
|
+
type?: BackgroundTypeWithLiterals;
|
|
1065
1111
|
}
|
|
1066
1112
|
/** @oneof */
|
|
1067
1113
|
interface BackgroundBackgroundOneOf {
|
|
@@ -1087,7 +1133,7 @@ interface OptionDesign {
|
|
|
1087
1133
|
}
|
|
1088
1134
|
interface Poll {
|
|
1089
1135
|
/** Poll ID. */
|
|
1090
|
-
|
|
1136
|
+
id?: string | null;
|
|
1091
1137
|
/** Poll title. */
|
|
1092
1138
|
title?: string | null;
|
|
1093
1139
|
/** Poll creator ID. */
|
|
@@ -1139,8 +1185,12 @@ interface Decoration extends DecorationDataOneOf {
|
|
|
1139
1185
|
spoilerData?: SpoilerData;
|
|
1140
1186
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1141
1187
|
strikethroughData?: boolean | null;
|
|
1188
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1189
|
+
superscriptData?: boolean | null;
|
|
1190
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1191
|
+
subscriptData?: boolean | null;
|
|
1142
1192
|
/** The type of decoration to apply. */
|
|
1143
|
-
type?:
|
|
1193
|
+
type?: DecorationTypeWithLiterals;
|
|
1144
1194
|
}
|
|
1145
1195
|
/** @oneof */
|
|
1146
1196
|
interface DecorationDataOneOf {
|
|
@@ -1164,6 +1214,10 @@ interface DecorationDataOneOf {
|
|
|
1164
1214
|
spoilerData?: SpoilerData;
|
|
1165
1215
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
1166
1216
|
strikethroughData?: boolean | null;
|
|
1217
|
+
/** Data for a superscript decoration. Defaults to `true`. */
|
|
1218
|
+
superscriptData?: boolean | null;
|
|
1219
|
+
/** Data for a subscript decoration. Defaults to `true`. */
|
|
1220
|
+
subscriptData?: boolean | null;
|
|
1167
1221
|
}
|
|
1168
1222
|
declare enum DecorationType {
|
|
1169
1223
|
BOLD = "BOLD",
|
|
@@ -1176,8 +1230,12 @@ declare enum DecorationType {
|
|
|
1176
1230
|
COLOR = "COLOR",
|
|
1177
1231
|
FONT_SIZE = "FONT_SIZE",
|
|
1178
1232
|
EXTERNAL = "EXTERNAL",
|
|
1179
|
-
STRIKETHROUGH = "STRIKETHROUGH"
|
|
1233
|
+
STRIKETHROUGH = "STRIKETHROUGH",
|
|
1234
|
+
SUPERSCRIPT = "SUPERSCRIPT",
|
|
1235
|
+
SUBSCRIPT = "SUBSCRIPT"
|
|
1180
1236
|
}
|
|
1237
|
+
/** @enumType */
|
|
1238
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT';
|
|
1181
1239
|
interface AnchorData {
|
|
1182
1240
|
/** The target node's ID. */
|
|
1183
1241
|
anchor?: string;
|
|
@@ -1198,11 +1256,11 @@ interface MentionData {
|
|
|
1198
1256
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
1199
1257
|
slug?: string;
|
|
1200
1258
|
/** Mentioned user's ID. */
|
|
1201
|
-
|
|
1259
|
+
id?: string | null;
|
|
1202
1260
|
}
|
|
1203
1261
|
interface FontSizeData {
|
|
1204
1262
|
/** The units used for the font size. */
|
|
1205
|
-
unit?:
|
|
1263
|
+
unit?: FontTypeWithLiterals;
|
|
1206
1264
|
/** Font size value. */
|
|
1207
1265
|
value?: number | null;
|
|
1208
1266
|
}
|
|
@@ -1210,9 +1268,11 @@ declare enum FontType {
|
|
|
1210
1268
|
PX = "PX",
|
|
1211
1269
|
EM = "EM"
|
|
1212
1270
|
}
|
|
1271
|
+
/** @enumType */
|
|
1272
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
1213
1273
|
interface SpoilerData {
|
|
1214
1274
|
/** Spoiler ID. */
|
|
1215
|
-
|
|
1275
|
+
id?: string | null;
|
|
1216
1276
|
}
|
|
1217
1277
|
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
1218
1278
|
/** Data for embedded Wix Bookings content. */
|
|
@@ -1220,7 +1280,7 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
1220
1280
|
/** Data for embedded Wix Events content. */
|
|
1221
1281
|
eventData?: EventData;
|
|
1222
1282
|
/** The type of Wix App content being embedded. */
|
|
1223
|
-
type?:
|
|
1283
|
+
type?: AppTypeWithLiterals;
|
|
1224
1284
|
/** The ID of the embedded content. */
|
|
1225
1285
|
itemId?: string | null;
|
|
1226
1286
|
/** The name of the embedded content. */
|
|
@@ -1247,6 +1307,8 @@ declare enum AppType {
|
|
|
1247
1307
|
EVENT = "EVENT",
|
|
1248
1308
|
BOOKING = "BOOKING"
|
|
1249
1309
|
}
|
|
1310
|
+
/** @enumType */
|
|
1311
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
1250
1312
|
interface BookingData {
|
|
1251
1313
|
/** Booking duration in minutes. */
|
|
1252
1314
|
durations?: string | null;
|
|
@@ -1325,9 +1387,9 @@ interface CollapsibleListData {
|
|
|
1325
1387
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
1326
1388
|
expandOnlyOne?: boolean | null;
|
|
1327
1389
|
/** Sets which items are expanded when the page loads. */
|
|
1328
|
-
initialExpandedItems?:
|
|
1390
|
+
initialExpandedItems?: InitialExpandedItemsWithLiterals;
|
|
1329
1391
|
/** The direction of the text in the list. Either left-to-right or right-to-left. */
|
|
1330
|
-
direction?:
|
|
1392
|
+
direction?: DirectionWithLiterals;
|
|
1331
1393
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
1332
1394
|
isQapageData?: boolean | null;
|
|
1333
1395
|
}
|
|
@@ -1339,12 +1401,16 @@ declare enum InitialExpandedItems {
|
|
|
1339
1401
|
/** All items collapsed initally */
|
|
1340
1402
|
NONE = "NONE"
|
|
1341
1403
|
}
|
|
1404
|
+
/** @enumType */
|
|
1405
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
1342
1406
|
declare enum Direction {
|
|
1343
1407
|
/** Left-to-right */
|
|
1344
1408
|
LTR = "LTR",
|
|
1345
1409
|
/** Right-to-left */
|
|
1346
1410
|
RTL = "RTL"
|
|
1347
1411
|
}
|
|
1412
|
+
/** @enumType */
|
|
1413
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
1348
1414
|
interface TableData {
|
|
1349
1415
|
/** Styling for the table's container. */
|
|
1350
1416
|
containerData?: PluginContainerData;
|
|
@@ -1382,9 +1448,11 @@ declare enum VerticalAlignment {
|
|
|
1382
1448
|
/** Bottom alignment */
|
|
1383
1449
|
BOTTOM = "BOTTOM"
|
|
1384
1450
|
}
|
|
1451
|
+
/** @enumType */
|
|
1452
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
1385
1453
|
interface CellStyle {
|
|
1386
1454
|
/** Vertical alignment for the cell's text. */
|
|
1387
|
-
verticalAlignment?:
|
|
1455
|
+
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
1388
1456
|
/**
|
|
1389
1457
|
* Cell background color as a hexadecimal value.
|
|
1390
1458
|
* @format COLOR_HEX
|
|
@@ -1534,6 +1602,8 @@ declare enum QuestionStatus {
|
|
|
1534
1602
|
VISIBLE = "VISIBLE",
|
|
1535
1603
|
HIDDEN = "HIDDEN"
|
|
1536
1604
|
}
|
|
1605
|
+
/** @enumType */
|
|
1606
|
+
type QuestionStatusWithLiterals = QuestionStatus | 'UNKNOWN' | 'VISIBLE' | 'HIDDEN';
|
|
1537
1607
|
interface ExtendedFields {
|
|
1538
1608
|
/**
|
|
1539
1609
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
@@ -1603,12 +1673,12 @@ interface ListQuestionEntriesRequest {
|
|
|
1603
1673
|
/** Not needed if `question_entry_id`s are provided in filter. */
|
|
1604
1674
|
paging?: CursorPaging;
|
|
1605
1675
|
/** Text output format. */
|
|
1606
|
-
contentFormat?:
|
|
1676
|
+
contentFormat?: ContentFormatWithLiterals;
|
|
1607
1677
|
/**
|
|
1608
1678
|
* Include fields inside question entries.
|
|
1609
1679
|
* @maxSize 100
|
|
1610
1680
|
*/
|
|
1611
|
-
fieldSet?:
|
|
1681
|
+
fieldSet?: FieldSetWithLiterals[];
|
|
1612
1682
|
}
|
|
1613
1683
|
interface CursorPaging {
|
|
1614
1684
|
/**
|
|
@@ -1630,11 +1700,15 @@ declare enum ContentFormat {
|
|
|
1630
1700
|
PLAIN_TEXT = "PLAIN_TEXT",
|
|
1631
1701
|
RICH_CONTENT = "RICH_CONTENT"
|
|
1632
1702
|
}
|
|
1703
|
+
/** @enumType */
|
|
1704
|
+
type ContentFormatWithLiterals = ContentFormat | 'DRAFTJS' | 'PLAIN_TEXT' | 'RICH_CONTENT';
|
|
1633
1705
|
declare enum FieldSet {
|
|
1634
1706
|
UNKNOWN = "UNKNOWN",
|
|
1635
1707
|
/** Include `share_link` fields inside question entries. */
|
|
1636
1708
|
SHARE_LINKS = "SHARE_LINKS"
|
|
1637
1709
|
}
|
|
1710
|
+
/** @enumType */
|
|
1711
|
+
type FieldSetWithLiterals = FieldSet | 'UNKNOWN' | 'SHARE_LINKS';
|
|
1638
1712
|
interface ListQuestionEntriesResponse {
|
|
1639
1713
|
/** List of question entries. */
|
|
1640
1714
|
questionEntries?: QuestionEntry[];
|
|
@@ -1669,12 +1743,12 @@ interface QueryQuestionEntriesRequest {
|
|
|
1669
1743
|
/** WQL expression. */
|
|
1670
1744
|
query?: CursorQuery;
|
|
1671
1745
|
/** Text output format. */
|
|
1672
|
-
contentFormat?:
|
|
1746
|
+
contentFormat?: QueryQuestionEntriesRequestContentFormatWithLiterals;
|
|
1673
1747
|
/**
|
|
1674
1748
|
* Include fields inside question entries.
|
|
1675
1749
|
* @maxSize 100
|
|
1676
1750
|
*/
|
|
1677
|
-
fieldSet?:
|
|
1751
|
+
fieldSet?: QueryQuestionEntriesRequestFieldSetWithLiterals[];
|
|
1678
1752
|
}
|
|
1679
1753
|
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
1680
1754
|
/**
|
|
@@ -1686,13 +1760,13 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
1686
1760
|
/**
|
|
1687
1761
|
* Filter object.
|
|
1688
1762
|
*
|
|
1689
|
-
* Learn more about
|
|
1763
|
+
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
1690
1764
|
*/
|
|
1691
1765
|
filter?: Record<string, any> | null;
|
|
1692
1766
|
/**
|
|
1693
1767
|
* Sort object.
|
|
1694
1768
|
*
|
|
1695
|
-
* Learn more about
|
|
1769
|
+
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
1696
1770
|
* @maxSize 5
|
|
1697
1771
|
*/
|
|
1698
1772
|
sort?: Sorting[];
|
|
@@ -1713,22 +1787,28 @@ interface Sorting {
|
|
|
1713
1787
|
*/
|
|
1714
1788
|
fieldName?: string;
|
|
1715
1789
|
/** Sort order. */
|
|
1716
|
-
order?:
|
|
1790
|
+
order?: SortOrderWithLiterals;
|
|
1717
1791
|
}
|
|
1718
1792
|
declare enum SortOrder {
|
|
1719
1793
|
ASC = "ASC",
|
|
1720
1794
|
DESC = "DESC"
|
|
1721
1795
|
}
|
|
1796
|
+
/** @enumType */
|
|
1797
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1722
1798
|
declare enum QueryQuestionEntriesRequestContentFormat {
|
|
1723
1799
|
DRAFTJS = "DRAFTJS",
|
|
1724
1800
|
PLAIN_TEXT = "PLAIN_TEXT",
|
|
1725
1801
|
RICH_CONTENT = "RICH_CONTENT"
|
|
1726
1802
|
}
|
|
1803
|
+
/** @enumType */
|
|
1804
|
+
type QueryQuestionEntriesRequestContentFormatWithLiterals = QueryQuestionEntriesRequestContentFormat | 'DRAFTJS' | 'PLAIN_TEXT' | 'RICH_CONTENT';
|
|
1727
1805
|
declare enum QueryQuestionEntriesRequestFieldSet {
|
|
1728
1806
|
UNKNOWN = "UNKNOWN",
|
|
1729
1807
|
/** Include `share_link` fields inside question entries. */
|
|
1730
1808
|
SHARE_LINKS = "SHARE_LINKS"
|
|
1731
1809
|
}
|
|
1810
|
+
/** @enumType */
|
|
1811
|
+
type QueryQuestionEntriesRequestFieldSetWithLiterals = QueryQuestionEntriesRequestFieldSet | 'UNKNOWN' | 'SHARE_LINKS';
|
|
1732
1812
|
interface QueryQuestionEntriesResponse {
|
|
1733
1813
|
/** List of Categories. */
|
|
1734
1814
|
questionEntries?: QuestionEntry[];
|
|
@@ -1855,25 +1935,21 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1855
1935
|
updatedEvent?: EntityUpdatedEvent;
|
|
1856
1936
|
deletedEvent?: EntityDeletedEvent;
|
|
1857
1937
|
actionEvent?: ActionEvent;
|
|
1858
|
-
/**
|
|
1859
|
-
* Unique event ID.
|
|
1860
|
-
* Allows clients to ignore duplicate webhooks.
|
|
1861
|
-
*/
|
|
1938
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1862
1939
|
_id?: string;
|
|
1863
1940
|
/**
|
|
1864
|
-
*
|
|
1865
|
-
*
|
|
1941
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1942
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1866
1943
|
*/
|
|
1867
1944
|
entityFqdn?: string;
|
|
1868
1945
|
/**
|
|
1869
|
-
*
|
|
1870
|
-
*
|
|
1871
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
1946
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1947
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1872
1948
|
*/
|
|
1873
1949
|
slug?: string;
|
|
1874
1950
|
/** ID of the entity associated with the event. */
|
|
1875
1951
|
entityId?: string;
|
|
1876
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
1952
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1877
1953
|
eventTime?: Date | null;
|
|
1878
1954
|
/**
|
|
1879
1955
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -1883,12 +1959,8 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1883
1959
|
/** If present, indicates the action that triggered the event. */
|
|
1884
1960
|
originatedFrom?: string | null;
|
|
1885
1961
|
/**
|
|
1886
|
-
* A sequence number
|
|
1887
|
-
*
|
|
1888
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1889
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1890
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1891
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1962
|
+
* 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.
|
|
1963
|
+
* 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.
|
|
1892
1964
|
*/
|
|
1893
1965
|
entityEventSequence?: string | null;
|
|
1894
1966
|
}
|
|
@@ -1914,7 +1986,7 @@ interface EntityUpdatedEvent {
|
|
|
1914
1986
|
currentEntity?: string;
|
|
1915
1987
|
}
|
|
1916
1988
|
interface EntityDeletedEvent {
|
|
1917
|
-
/** Entity that was deleted */
|
|
1989
|
+
/** Entity that was deleted. */
|
|
1918
1990
|
deletedEntity?: string | null;
|
|
1919
1991
|
}
|
|
1920
1992
|
interface ActionEvent {
|
|
@@ -1960,7 +2032,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1960
2032
|
*/
|
|
1961
2033
|
appId?: string;
|
|
1962
2034
|
/** @readonly */
|
|
1963
|
-
identityType?:
|
|
2035
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1964
2036
|
}
|
|
1965
2037
|
/** @oneof */
|
|
1966
2038
|
interface IdentificationDataIdOneOf {
|
|
@@ -1992,6 +2064,8 @@ declare enum WebhookIdentityType {
|
|
|
1992
2064
|
WIX_USER = "WIX_USER",
|
|
1993
2065
|
APP = "APP"
|
|
1994
2066
|
}
|
|
2067
|
+
/** @enumType */
|
|
2068
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1995
2069
|
interface BaseEventMetadata {
|
|
1996
2070
|
/**
|
|
1997
2071
|
* App instance ID.
|
|
@@ -2007,25 +2081,21 @@ interface BaseEventMetadata {
|
|
|
2007
2081
|
identity?: IdentificationData;
|
|
2008
2082
|
}
|
|
2009
2083
|
interface EventMetadata extends BaseEventMetadata {
|
|
2010
|
-
/**
|
|
2011
|
-
* Unique event ID.
|
|
2012
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2013
|
-
*/
|
|
2084
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
2014
2085
|
_id?: string;
|
|
2015
2086
|
/**
|
|
2016
|
-
*
|
|
2017
|
-
*
|
|
2087
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
2088
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
2018
2089
|
*/
|
|
2019
2090
|
entityFqdn?: string;
|
|
2020
2091
|
/**
|
|
2021
|
-
*
|
|
2022
|
-
*
|
|
2023
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2092
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
2093
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
2024
2094
|
*/
|
|
2025
2095
|
slug?: string;
|
|
2026
2096
|
/** ID of the entity associated with the event. */
|
|
2027
2097
|
entityId?: string;
|
|
2028
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
2098
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
2029
2099
|
eventTime?: Date | null;
|
|
2030
2100
|
/**
|
|
2031
2101
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -2035,12 +2105,8 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
2035
2105
|
/** If present, indicates the action that triggered the event. */
|
|
2036
2106
|
originatedFrom?: string | null;
|
|
2037
2107
|
/**
|
|
2038
|
-
* A sequence number
|
|
2039
|
-
*
|
|
2040
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2041
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2042
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2043
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2108
|
+
* 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.
|
|
2109
|
+
* 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.
|
|
2044
2110
|
*/
|
|
2045
2111
|
entityEventSequence?: string | null;
|
|
2046
2112
|
}
|
|
@@ -2108,7 +2174,7 @@ interface UpdateQuestionEntry {
|
|
|
2108
2174
|
/** Order of question out of all questions (and not only in the category). */
|
|
2109
2175
|
sortOrder?: number | null;
|
|
2110
2176
|
/** Question's visibility status within the site. */
|
|
2111
|
-
status?:
|
|
2177
|
+
status?: QuestionStatusWithLiterals;
|
|
2112
2178
|
/**
|
|
2113
2179
|
* ID of the category to which this question belongs.
|
|
2114
2180
|
* @minLength 1
|
|
@@ -2152,21 +2218,21 @@ interface ListQuestionEntriesOptions {
|
|
|
2152
2218
|
/** Not needed if `question_entry_id`s are provided in filter. */
|
|
2153
2219
|
paging?: CursorPaging;
|
|
2154
2220
|
/** Text output format. */
|
|
2155
|
-
contentFormat?:
|
|
2221
|
+
contentFormat?: ContentFormatWithLiterals;
|
|
2156
2222
|
/**
|
|
2157
2223
|
* Include fields inside question entries.
|
|
2158
2224
|
* @maxSize 100
|
|
2159
2225
|
*/
|
|
2160
|
-
fieldSet?:
|
|
2226
|
+
fieldSet?: FieldSetWithLiterals[];
|
|
2161
2227
|
}
|
|
2162
2228
|
interface QueryQuestionEntriesOptions {
|
|
2163
2229
|
/** Text output format. */
|
|
2164
|
-
contentFormat?:
|
|
2230
|
+
contentFormat?: QueryQuestionEntriesRequestContentFormatWithLiterals | undefined;
|
|
2165
2231
|
/**
|
|
2166
2232
|
* Include fields inside question entries.
|
|
2167
2233
|
* @maxSize 100
|
|
2168
2234
|
*/
|
|
2169
|
-
fieldSet?:
|
|
2235
|
+
fieldSet?: QueryQuestionEntriesRequestFieldSetWithLiterals[] | undefined;
|
|
2170
2236
|
}
|
|
2171
2237
|
interface QueryCursorResult {
|
|
2172
2238
|
cursors: Cursors;
|
|
@@ -2193,19 +2259,19 @@ interface QuestionEntriesQueryBuilder {
|
|
|
2193
2259
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2194
2260
|
* @param value - Value to compare against.
|
|
2195
2261
|
*/
|
|
2196
|
-
ge: (propertyName: 'sortOrder', value: any) => QuestionEntriesQueryBuilder;
|
|
2262
|
+
ge: (propertyName: '_id' | 'question' | 'sortOrder' | 'categoryId', value: any) => QuestionEntriesQueryBuilder;
|
|
2197
2263
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2198
2264
|
* @param value - Value to compare against.
|
|
2199
2265
|
*/
|
|
2200
|
-
gt: (propertyName: 'sortOrder', value: any) => QuestionEntriesQueryBuilder;
|
|
2266
|
+
gt: (propertyName: '_id' | 'question' | 'sortOrder' | 'categoryId', value: any) => QuestionEntriesQueryBuilder;
|
|
2201
2267
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2202
2268
|
* @param value - Value to compare against.
|
|
2203
2269
|
*/
|
|
2204
|
-
le: (propertyName: 'sortOrder', value: any) => QuestionEntriesQueryBuilder;
|
|
2270
|
+
le: (propertyName: '_id' | 'question' | 'sortOrder' | 'categoryId', value: any) => QuestionEntriesQueryBuilder;
|
|
2205
2271
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
2206
2272
|
* @param value - Value to compare against.
|
|
2207
2273
|
*/
|
|
2208
|
-
lt: (propertyName: 'sortOrder', value: any) => QuestionEntriesQueryBuilder;
|
|
2274
|
+
lt: (propertyName: '_id' | 'question' | 'sortOrder' | 'categoryId', value: any) => QuestionEntriesQueryBuilder;
|
|
2209
2275
|
/** @param propertyName - Property whose value is compared with `string`.
|
|
2210
2276
|
* @param string - String to compare against. Case-insensitive.
|
|
2211
2277
|
*/
|
|
@@ -2248,4 +2314,4 @@ interface BulkUpdateQuestionEntryOptions {
|
|
|
2248
2314
|
returnFullEntity?: boolean | null;
|
|
2249
2315
|
}
|
|
2250
2316
|
|
|
2251
|
-
export { type
|
|
2317
|
+
export { type QuestionEntryAnswerOneOf as $, Alignment as A, type BulkDeleteQuestionEntryResponse as B, Crop as C, DecorationType as D, VerticalAlignment as E, FontType as F, GIFType as G, NullValue as H, InitialExpandedItems as I, QuestionStatus as J, ContentFormat as K, type ListQuestionEntriesOptions as L, MapType as M, NodeType as N, Orientation as O, PluginContainerDataAlignment as P, type QuestionEntry as Q, FieldSet as R, type SetQuestionEntryLabelsOptions as S, Type as T, type UpdateQuestionEntry as U, ViewMode as V, WidthType as W, SortOrder as X, QueryQuestionEntriesRequestContentFormat as Y, QueryQuestionEntriesRequestFieldSet as Z, WebhookIdentityType as _, type ListQuestionEntriesResponse as a, type AnchorData as a$, type RichContent as a0, type Node as a1, type NodeDataOneOf as a2, type NodeStyle as a3, type ButtonData as a4, type Border as a5, type Colors as a6, type PluginContainerData as a7, type PluginContainerDataWidth as a8, type PluginContainerDataWidthDataOneOf as a9, type HTMLData as aA, type HTMLDataDataOneOf as aB, type ImageData as aC, type StylesBorder as aD, type ImageDataStyles as aE, type LinkPreviewData as aF, type LinkPreviewDataStyles as aG, type MapData as aH, type MapSettings as aI, type ParagraphData as aJ, type PollData as aK, type Permissions as aL, type Option as aM, type Settings as aN, type PollLayout as aO, type OptionLayout as aP, type Gradient as aQ, type Background as aR, type BackgroundBackgroundOneOf as aS, type PollDesign as aT, type OptionDesign as aU, type Poll as aV, type PollDataLayout as aW, type Design as aX, type TextData as aY, type Decoration as aZ, type DecorationDataOneOf as a_, type Spoiler as aa, type Height as ab, type Styles as ac, type Link as ad, type LinkDataOneOf as ae, type Rel as af, type CodeBlockData as ag, type TextStyle as ah, type DividerData as ai, type FileData as aj, type FileSource as ak, type FileSourceDataOneOf as al, type PDFSettings as am, type GalleryData as an, type Media as ao, type Image as ap, type Video as aq, type Item as ar, type ItemDataOneOf as as, type GalleryOptions as at, type Layout as au, type ItemStyle as av, type Thumbnails as aw, type GIFData as ax, type GIF as ay, type HeadingData as az, type QueryQuestionEntriesOptions as b, type EntityDeletedEvent as b$, type ColorData as b0, type LinkData as b1, type MentionData as b2, type FontSizeData as b3, type SpoilerData as b4, type AppEmbedData as b5, type AppEmbedDataAppDataOneOf as b6, type BookingData as b7, type EventData as b8, type VideoData as b9, type UpdateQuestionEntryResponse as bA, type DeleteQuestionEntryRequest as bB, type DeleteQuestionEntryResponse as bC, type ListQuestionEntriesRequest as bD, type CursorPaging as bE, type PagingMetadataV2 as bF, type Cursors as bG, type QueryQuestionEntriesRequest as bH, type CursorQuery as bI, type CursorQueryPagingMethodOneOf as bJ, type Sorting as bK, type QueryQuestionEntriesResponse as bL, type CursorPagingMetadata as bM, type BulkDeleteQuestionEntryRequest as bN, type ItemMetadata as bO, type ApplicationError as bP, type BulkActionMetadata as bQ, type UpdateExtendedFieldsRequest as bR, type SetQuestionEntryLabelsRequest as bS, type BulkUpdateQuestionEntryRequest as bT, type MaskedQuestionEntry as bU, type BulkUpdateQuestionEntryResult as bV, type DomainEvent as bW, type DomainEventBodyOneOf as bX, type EntityCreatedEvent as bY, type RestoreInfo as bZ, type EntityUpdatedEvent as b_, type PlaybackOptions as ba, type EmbedData as bb, type Oembed as bc, type CollapsibleListData as bd, type TableData as be, type Dimensions as bf, type TableCellData as bg, type CellStyle as bh, type BorderColors as bi, type ListValue as bj, type AudioData as bk, type OrderedListData as bl, type BulletedListData as bm, type BlockquoteData as bn, type CaptionData as bo, type LayoutCellData as bp, type Metadata as bq, type DocumentStyle as br, type TextNodeStyle as bs, type Label as bt, type ExtendedFields as bu, type CreateQuestionEntryRequest as bv, type CreateQuestionEntryResponse as bw, type GetQuestionEntryRequest as bx, type GetQuestionEntryResponse as by, type UpdateQuestionEntryRequest as bz, type QuestionEntriesQueryBuilder as c, type ActionEvent as c0, type Empty as c1, type MessageEnvelope as c2, type IdentificationData as c3, type IdentificationDataIdOneOf as c4, type BaseEventMetadata as c5, type EventMetadata as c6, type QuestionEntriesQueryResult as c7, type UpdateExtendedFieldsOptions as d, type UpdateExtendedFieldsResponse as e, type SetQuestionEntryLabelsResponse as f, type BulkUpdateQuestionEntryOptions as g, type BulkUpdateQuestionEntryResponse as h, type QuestionEntryCreatedEnvelope as i, type QuestionEntryDeletedEnvelope as j, type QuestionEntryUpdatedEnvelope as k, Target as l, TextAlignment as m, LineStyle as n, Width as o, LayoutType as p, ThumbnailsAlignment as q, Source as r, Position as s, ViewRole as t, VoteRole as u, PollLayoutType as v, PollLayoutDirection as w, BackgroundType as x, AppType as y, Direction as z };
|