@wix/auto_sdk_blog_draft-posts 1.0.89 → 1.0.91

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +1 -1
  2. package/build/cjs/index.js +63 -13
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +463 -274
  5. package/build/cjs/index.typings.js +63 -13
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +465 -276
  8. package/build/cjs/meta.js +63 -13
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +1 -1
  11. package/build/es/index.mjs +60 -13
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +463 -274
  14. package/build/es/index.typings.mjs +60 -13
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +465 -276
  17. package/build/es/meta.mjs +60 -13
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +1 -1
  20. package/build/internal/cjs/index.js +63 -13
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +905 -395
  23. package/build/internal/cjs/index.typings.js +63 -13
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +879 -334
  26. package/build/internal/cjs/meta.js +63 -13
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +1 -1
  29. package/build/internal/es/index.mjs +60 -13
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +905 -395
  32. package/build/internal/es/index.typings.mjs +60 -13
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +879 -334
  35. package/build/internal/es/meta.mjs +60 -13
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +4 -4
@@ -82,6 +82,25 @@ interface DraftPost {
82
82
  * @format LANGUAGE_TAG
83
83
  */
84
84
  language?: string | null;
85
+ /**
86
+ * Reserved for internal use.
87
+ * @internal
88
+ * @readonly
89
+ */
90
+ changeOrigin?: OriginWithLiterals;
91
+ /**
92
+ * Reserved for internal use.
93
+ * @internal
94
+ * @readonly
95
+ * @maxLength 24
96
+ */
97
+ contentId?: string | null;
98
+ /**
99
+ * Reserved for internal use.
100
+ * @internal
101
+ * @format GUID
102
+ */
103
+ editingSessionId?: string | null;
85
104
  /**
86
105
  * Draft Post rich content.
87
106
  *
@@ -97,6 +116,13 @@ interface DraftPost {
97
116
  status?: StatusWithLiterals;
98
117
  /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
99
118
  moderationDetails?: ModerationDetails;
119
+ /**
120
+ * Reserved for internal use.
121
+ * @internal
122
+ * @readonly
123
+ * @format GUID
124
+ */
125
+ mostRecentContributorId?: string | null;
100
126
  /**
101
127
  * Indicates if there are changes made to the draft post that have not yet been published.
102
128
  * @readonly
@@ -112,10 +138,23 @@ interface DraftPost {
112
138
  * @readonly
113
139
  */
114
140
  scheduledPublishDate?: Date | null;
141
+ /**
142
+ * Reserved for internal use.
143
+ * @internal
144
+ */
145
+ content?: Record<string, any> | null;
115
146
  /** Date the post was first published. */
116
147
  firstPublishedDate?: Date | null;
117
148
  /** SEO data. */
118
149
  seoData?: SeoSchema;
150
+ /**
151
+ * Reserved for internal use.
152
+ * @internal
153
+ * @readonly
154
+ * @maxSize 5000
155
+ * @maxLength 100
156
+ */
157
+ slugs?: string[];
119
158
  /**
120
159
  * Draft post URL preview. What the URL will look like once the post is published.
121
160
  * @readonly
@@ -135,6 +174,32 @@ interface DraftPost {
135
174
  media?: Media;
136
175
  /** Number of paragraphs to display in a paid content preview for non-paying users. */
137
176
  previewTextParagraph?: number | null;
177
+ /**
178
+ * List of the post's translated posts.
179
+ * @internal
180
+ * @readonly
181
+ * @maxSize 1000
182
+ */
183
+ translations?: DraftPostTranslation[];
184
+ /**
185
+ * Reserved for internal use, not included in base response.
186
+ * @internal
187
+ * @format GUID
188
+ */
189
+ originPostId?: string | null;
190
+ /**
191
+ * Reserved for internal use, not included in base response.
192
+ * @internal
193
+ * @format GUID
194
+ */
195
+ originPostInstanceId?: string | null;
196
+ /**
197
+ * Reserved for internal use.
198
+ * @internal
199
+ * @readonly
200
+ * @maxLength 24
201
+ */
202
+ internalId?: string | null;
138
203
  }
139
204
  interface FocalPoint {
140
205
  /** X-coordinate of the focal point. */
@@ -445,6 +510,8 @@ interface ButtonData {
445
510
  text?: string | null;
446
511
  /** Button link details. */
447
512
  link?: Link;
513
+ /** Node animation. */
514
+ animation?: Animation;
448
515
  }
449
516
  /** Background type */
450
517
  declare enum BackgroundType {
@@ -721,9 +788,144 @@ interface Rel {
721
788
  /** Indicates that this link protect referral information from being passed to the target website. */
722
789
  noreferrer?: boolean | null;
723
790
  }
791
+ interface Animation {
792
+ /** Animation kind. */
793
+ type?: AnimationTypeWithLiterals;
794
+ /** Entrance animation, played once when the node first enters the viewport. */
795
+ entrance?: EntranceAnimation;
796
+ /** Looping animation, repeated indefinitely while the node is on the page. When combined with entrance, the loop starts after the entrance finishes. */
797
+ loop?: LoopAnimation;
798
+ }
799
+ declare enum AnimationType {
800
+ /** Animations that play while the node is in view. */
801
+ VIEW = "VIEW"
802
+ }
803
+ /** @enumType */
804
+ type AnimationTypeWithLiterals = AnimationType | 'VIEW';
805
+ interface EntranceAnimation {
806
+ /** The entrance effect to play. */
807
+ effect?: EntranceEffect;
808
+ /** Effect duration in milliseconds. Each effect has its own default. */
809
+ duration?: number | null;
810
+ /** Delay before the effect starts, in milliseconds. */
811
+ delay?: number | null;
812
+ }
813
+ interface EntranceEffect {
814
+ /** The entrance effect type. */
815
+ type?: EntranceEffectTypeWithLiterals;
816
+ /**
817
+ * Direction the effect enters from. Allowed values depend on the effect type (e.g. TOP/RIGHT/BOTTOM/LEFT, the diagonals with or without CENTER, corners, HORIZONTAL/VERTICAL, CLOCKWISE/COUNTER_CLOCKWISE).
818
+ * @maxLength 20
819
+ */
820
+ direction?: string | null;
821
+ /**
822
+ * Clip-path shape: ELLIPSE, CIRCLE, RECTANGLE, or DIAMOND (SHAPE).
823
+ * @maxLength 12
824
+ */
825
+ shape?: string | null;
826
+ /**
827
+ * Motion style: GENTLE, MODERATE, or INTENSE. Only the effects that expose one accept it.
828
+ * @maxLength 100
829
+ */
830
+ easing?: string | null;
831
+ }
832
+ declare enum EntranceEffectType {
833
+ /** Fades in from fully transparent to fully opaque. */
834
+ FADE = "FADE",
835
+ /** Enters along a 3D arc path. */
836
+ ARC = "ARC",
837
+ /** Transitions from blurred to sharp. */
838
+ BLUR = "BLUR",
839
+ /** Bounces into place with an elastic curve. */
840
+ BOUNCE = "BOUNCE",
841
+ /** Shrinks down from a larger size. */
842
+ DROP = "DROP",
843
+ /** Expands from a point, scaling to full size. */
844
+ EXPAND = "EXPAND",
845
+ /** Flips into view with a 3D rotation. */
846
+ FLIP = "FLIP",
847
+ /** Drifts gently into place. */
848
+ FLOAT = "FLOAT",
849
+ /** Unfolds from an edge as if hinged. */
850
+ FOLD = "FOLD",
851
+ /** Glides in smoothly from off-screen. */
852
+ GLIDE = "GLIDE",
853
+ /** Progressively revealed by an expanding clip-path. */
854
+ REVEAL = "REVEAL",
855
+ /** Appears through an expanding geometric clip-path shape. */
856
+ SHAPE = "SHAPE",
857
+ /** Revealed through shutter-like strips. */
858
+ SHUTTERS = "SHUTTERS",
859
+ /** Slides in from one side. */
860
+ SLIDE = "SLIDE",
861
+ /** Spins into view while scaling up. */
862
+ SPIN = "SPIN",
863
+ /** Tilts in from the side with 3D rotation. */
864
+ TILT = "TILT",
865
+ /** Rotates into view around a corner pivot. */
866
+ TURN = "TURN",
867
+ /** Expands from its horizontal or vertical center. */
868
+ WINK = "WINK"
869
+ }
870
+ /** @enumType */
871
+ type EntranceEffectTypeWithLiterals = EntranceEffectType | 'FADE' | 'ARC' | 'BLUR' | 'BOUNCE' | 'DROP' | 'EXPAND' | 'FLIP' | 'FLOAT' | 'FOLD' | 'GLIDE' | 'REVEAL' | 'SHAPE' | 'SHUTTERS' | 'SLIDE' | 'SPIN' | 'TILT' | 'TURN' | 'WINK';
872
+ interface LoopAnimation {
873
+ /** The looping effect to repeat. */
874
+ effect?: LoopEffect;
875
+ /** Duration of a single iteration in milliseconds. Each effect has its own default. */
876
+ duration?: number | null;
877
+ /** Pause between iterations in milliseconds. */
878
+ iterationDelay?: number | null;
879
+ }
880
+ interface LoopEffect {
881
+ /** The looping effect type. */
882
+ type?: LoopEffectTypeWithLiterals;
883
+ /**
884
+ * Direction of the effect. Allowed values depend on the effect type (e.g. TOP/RIGHT/BOTTOM/LEFT, LEFT/RIGHT, HORIZONTAL/VERTICAL with or without CENTER, CLOCKWISE/COUNTER_CLOCKWISE).
885
+ * @maxLength 20
886
+ */
887
+ direction?: string | null;
888
+ /**
889
+ * Motion style: GENTLE, MODERATE, or INTENSE. Only the effects that expose one accept it.
890
+ * @maxLength 100
891
+ */
892
+ easing?: string | null;
893
+ }
894
+ declare enum LoopEffectType {
895
+ /** Bounces up and down in place. */
896
+ BOUNCE = "BOUNCE",
897
+ /** Scales gently in and out along an axis. */
898
+ BREATHE = "BREATHE",
899
+ /** Drifts toward one side, then re-enters from the opposite side. */
900
+ CROSS = "CROSS",
901
+ /** Fades out to fully transparent and back in. */
902
+ FLASH = "FLASH",
903
+ /** Rotates a full turn around its horizontal or vertical axis. */
904
+ FLIP = "FLIP",
905
+ /** Folds back and forth around a hinged edge. */
906
+ FOLD = "FOLD",
907
+ /** Wobbles with a jelly-like skew. */
908
+ JELLO = "JELLO",
909
+ /** Nudges repeatedly toward a direction. */
910
+ POKE = "POKE",
911
+ /** Scales up and back down rhythmically. */
912
+ PULSE = "PULSE",
913
+ /** Stretches and squashes like a rubber band. */
914
+ RUBBER = "RUBBER",
915
+ /** Rotates continuously around its center. */
916
+ SPIN = "SPIN",
917
+ /** Swings back and forth around an edge pivot. */
918
+ SWING = "SWING",
919
+ /** Rocks side to side with an accumulating rotation. */
920
+ WIGGLE = "WIGGLE"
921
+ }
922
+ /** @enumType */
923
+ type LoopEffectTypeWithLiterals = LoopEffectType | 'BOUNCE' | 'BREATHE' | 'CROSS' | 'FLASH' | 'FLIP' | 'FOLD' | 'JELLO' | 'POKE' | 'PULSE' | 'RUBBER' | 'SPIN' | 'SWING' | 'WIGGLE';
724
924
  interface CodeBlockData {
725
925
  /** Styling for the code block's text. */
726
926
  textStyle?: TextStyle;
927
+ /** Node animation. */
928
+ animation?: Animation;
727
929
  }
728
930
  interface TextStyle {
729
931
  /** Text alignment. Defaults to `AUTO`. */
@@ -756,6 +958,8 @@ interface DividerData {
756
958
  alignment?: DividerDataAlignmentWithLiterals;
757
959
  /** Visual styling for the divider lines. */
758
960
  styles?: DividerDataStyles;
961
+ /** Node animation. */
962
+ animation?: Animation;
759
963
  }
760
964
  declare enum LineCap {
761
965
  /** Square line endings. */
@@ -810,9 +1014,9 @@ interface DividerDataStyles {
810
1014
  * @maxSize 10
811
1015
  */
812
1016
  lineThickness?: number[];
813
- /** Dash length in pixels for dashed dividers. */
1017
+ /** Visible dash length for dashed dividers, in pixels. The pattern is snapped to a whole number of dashes so that the first and last dash touch the divider's edges - narrower containers show fewer dashes at the same size. */
814
1018
  dashLength?: number | null;
815
- /** Gap between dashes or dots in pixels. */
1019
+ /** Visible gap between dashes or dots, in pixels. */
816
1020
  dashGap?: number | null;
817
1021
  /** Gap between divider lines in pixels. */
818
1022
  lineGap?: number | null;
@@ -839,6 +1043,8 @@ interface FileData {
839
1043
  path?: string | null;
840
1044
  /** File size in KB. */
841
1045
  sizeInKb?: string | null;
1046
+ /** Node animation. */
1047
+ animation?: Animation;
842
1048
  }
843
1049
  declare enum ViewMode {
844
1050
  /** No PDF view */
@@ -899,6 +1105,8 @@ interface GalleryData {
899
1105
  disableExpand?: boolean | null;
900
1106
  /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
901
1107
  disableDownload?: boolean | null;
1108
+ /** Node animation. */
1109
+ animation?: Animation;
902
1110
  }
903
1111
  interface V1Media {
904
1112
  /** The source for the media's data. */
@@ -1042,6 +1250,8 @@ interface GIFData {
1042
1250
  width?: number;
1043
1251
  /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
1044
1252
  gifType?: GIFTypeWithLiterals;
1253
+ /** Node animation. */
1254
+ animation?: Animation;
1045
1255
  }
1046
1256
  interface GIF {
1047
1257
  /**
@@ -1075,6 +1285,8 @@ interface HeadingData {
1075
1285
  indentation?: number | null;
1076
1286
  /** Rendered heading level for SEO/accessibility, overrides the HTML tag when set. */
1077
1287
  renderedLevel?: number | null;
1288
+ /** Node animation. */
1289
+ animation?: Animation;
1078
1290
  }
1079
1291
  interface HTMLData extends HTMLDataDataOneOf {
1080
1292
  /** The URL for the HTML code for the node. */
@@ -1094,6 +1306,8 @@ interface HTMLData extends HTMLDataDataOneOf {
1094
1306
  source?: SourceWithLiterals;
1095
1307
  /** If container height is aligned with its content height. Defaults to `true`. */
1096
1308
  autoHeight?: boolean | null;
1309
+ /** Node animation. */
1310
+ animation?: Animation;
1097
1311
  }
1098
1312
  /** @oneof */
1099
1313
  interface HTMLDataDataOneOf {
@@ -1143,6 +1357,8 @@ interface ImageData {
1143
1357
  crop?: ImageDataCrop;
1144
1358
  /** Optional shape mask applied to the visible crop. Supported values: CIRCLE, OVAL, STAR, PENTAGON, HEXAGON, TRIANGLE, HEART, RHOMBUS, FLUID, WINDOW. */
1145
1359
  cropShape?: string | null;
1360
+ /** Node animation. */
1361
+ animation?: Animation;
1146
1362
  }
1147
1363
  interface StylesBorder {
1148
1364
  /** Border width in pixels. */
@@ -1184,6 +1400,8 @@ interface LinkPreviewData {
1184
1400
  html?: string | null;
1185
1401
  /** Styling for the link preview. */
1186
1402
  styles?: LinkPreviewDataStyles;
1403
+ /** Node animation. */
1404
+ animation?: Animation;
1187
1405
  }
1188
1406
  declare enum StylesPosition {
1189
1407
  /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
@@ -1279,6 +1497,8 @@ interface ParagraphData {
1279
1497
  indentation?: number | null;
1280
1498
  /** Paragraph level */
1281
1499
  level?: number | null;
1500
+ /** Node animation. */
1501
+ animation?: Animation;
1282
1502
  }
1283
1503
  interface PollData {
1284
1504
  /** Styling for the poll's container. */
@@ -1289,6 +1509,8 @@ interface PollData {
1289
1509
  layout?: PollDataLayout;
1290
1510
  /** Styling for the poll and voting options. */
1291
1511
  design?: Design;
1512
+ /** Node animation. */
1513
+ animation?: Animation;
1292
1514
  }
1293
1515
  declare enum ViewRole {
1294
1516
  /** Only Poll creator can view the results */
@@ -1555,6 +1777,8 @@ interface MentionData {
1555
1777
  slug?: string;
1556
1778
  /** Mentioned user's ID. */
1557
1779
  id?: string | null;
1780
+ /** The kind of entity the mention refers to. Any value is accepted, and it's usually used to mark a mention as a group mention (for example, `group`). When empty, the mention refers to a member. */
1781
+ type?: string | null;
1558
1782
  }
1559
1783
  interface FontSizeData {
1560
1784
  /** The units used for the font size. */
@@ -1647,6 +1871,8 @@ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
1647
1871
  containerData?: PluginContainerData;
1648
1872
  /** Pricing data for embedded Wix App content. */
1649
1873
  pricingData?: PricingData;
1874
+ /** Node animation. */
1875
+ animation?: Animation;
1650
1876
  }
1651
1877
  /** @oneof */
1652
1878
  interface AppEmbedDataAppDataOneOf {
@@ -1888,6 +2114,8 @@ interface VideoData {
1888
2114
  title?: string | null;
1889
2115
  /** Video options. */
1890
2116
  options?: PlaybackOptions;
2117
+ /** Node animation. */
2118
+ animation?: Animation;
1891
2119
  }
1892
2120
  interface PlaybackOptions {
1893
2121
  /** Sets whether the media will automatically start playing. */
@@ -1904,6 +2132,8 @@ interface EmbedData {
1904
2132
  oembed?: Oembed;
1905
2133
  /** Origin asset source. */
1906
2134
  src?: string | null;
2135
+ /** Node animation. */
2136
+ animation?: Animation;
1907
2137
  }
1908
2138
  interface Oembed {
1909
2139
  /** The resource type. */
@@ -1948,6 +2178,8 @@ interface CollapsibleListData {
1948
2178
  direction?: DirectionWithLiterals;
1949
2179
  /** If `true`, The collapsible item will appear in search results as an FAQ. */
1950
2180
  isQapageData?: boolean | null;
2181
+ /** Node animation. */
2182
+ animation?: Animation;
1951
2183
  }
1952
2184
  declare enum InitialExpandedItems {
1953
2185
  /** First item will be expended initally */
@@ -1990,6 +2222,8 @@ interface TableData {
1990
2222
  cellPadding?: number[];
1991
2223
  /** Table's alternative text. */
1992
2224
  altText?: string | null;
2225
+ /** Node animation. */
2226
+ animation?: Animation;
1993
2227
  }
1994
2228
  interface Dimensions {
1995
2229
  /** An array representing relative width of each column in relation to the other columns. */
@@ -2098,6 +2332,8 @@ interface AudioData {
2098
2332
  authorName?: string | null;
2099
2333
  /** An HTML version of the audio node. */
2100
2334
  html?: string | null;
2335
+ /** Node animation. */
2336
+ animation?: Animation;
2101
2337
  }
2102
2338
  interface OrderedListData {
2103
2339
  /** Indentation level from 0-4. */
@@ -2106,16 +2342,22 @@ interface OrderedListData {
2106
2342
  offset?: number | null;
2107
2343
  /** List start number. */
2108
2344
  start?: number | null;
2345
+ /** Node animation. */
2346
+ animation?: Animation;
2109
2347
  }
2110
2348
  interface BulletedListData {
2111
2349
  /** Indentation level from 0-4. */
2112
2350
  indentation?: number;
2113
2351
  /** Offset level from 0-4. */
2114
2352
  offset?: number | null;
2353
+ /** Node animation. */
2354
+ animation?: Animation;
2115
2355
  }
2116
2356
  interface BlockquoteData {
2117
2357
  /** Indentation level from 1-4. */
2118
2358
  indentation?: number;
2359
+ /** Node animation. */
2360
+ animation?: Animation;
2119
2361
  }
2120
2362
  interface CaptionData {
2121
2363
  textStyle?: TextStyle;
@@ -2173,6 +2415,8 @@ interface LayoutData {
2173
2415
  background?: LayoutDataBackground;
2174
2416
  /** Backdrop styling (color or gradient). */
2175
2417
  backdrop?: Backdrop;
2418
+ /** Node animation. */
2419
+ animation?: Animation;
2176
2420
  }
2177
2421
  declare enum ImageScalingScaling {
2178
2422
  /** Auto image scaling */
@@ -2324,6 +2568,8 @@ interface ShapeData {
2324
2568
  shape?: V1Media;
2325
2569
  /** Styling for the shape. */
2326
2570
  styles?: ShapeDataStyles;
2571
+ /** Node animation. */
2572
+ animation?: Animation;
2327
2573
  }
2328
2574
  interface ShapeDataStyles {
2329
2575
  /**
@@ -2426,6 +2672,8 @@ interface TocData {
2426
2672
  color?: string | null;
2427
2673
  /** Indentation style. Default: NESTED. */
2428
2674
  indentation?: IndentationWithLiterals;
2675
+ /** Node animation. */
2676
+ animation?: Animation;
2429
2677
  }
2430
2678
  /** List style. */
2431
2679
  declare enum ListStyle {
@@ -2472,6 +2720,8 @@ interface SmartBlockData {
2472
2720
  borderWidth?: number | null;
2473
2721
  /** Border radius in pixels (for SOLID_JOINED_BOXES variant). */
2474
2722
  borderRadius?: number | null;
2723
+ /** Node animation. */
2724
+ animation?: Animation;
2475
2725
  }
2476
2726
  /** Layout type of the smart block */
2477
2727
  declare enum SmartBlockDataType {
@@ -2575,10 +2825,14 @@ interface CheckboxListData {
2575
2825
  indentation?: number;
2576
2826
  /** Offset level from 0-4. */
2577
2827
  offset?: number | null;
2828
+ /** Node animation. */
2829
+ animation?: Animation;
2578
2830
  }
2579
2831
  interface ListItemNodeData {
2580
2832
  /** Checkbox list item state. Defaults to `false`. */
2581
2833
  checked?: boolean | null;
2834
+ /** Node animation. */
2835
+ animation?: Animation;
2582
2836
  }
2583
2837
  interface Metadata {
2584
2838
  /** Schema version. */
@@ -2635,6 +2889,13 @@ declare enum Status {
2635
2889
  SCHEDULED = "SCHEDULED",
2636
2890
  /** Status indicating the draft post is deleted. */
2637
2891
  DELETED = "DELETED",
2892
+ /**
2893
+ * Deprecated. Use `IN_REVIEW` instead. Status indicating the draft post is in review.
2894
+ * Target removal date 2024-06-30
2895
+ * Reserved for internal use.
2896
+ * @internal
2897
+ */
2898
+ IN_MODERATION = "IN_MODERATION",
2638
2899
  /** Status indicating the draft post is in review. */
2639
2900
  IN_REVIEW = "IN_REVIEW"
2640
2901
  }
@@ -2759,8 +3020,68 @@ interface VideoResolution {
2759
3020
  height?: number;
2760
3021
  /** Video width. */
2761
3022
  width?: number;
3023
+ /**
3024
+ * Deprecated. Use the `posters` property in the parent entity instead.
3025
+ * @internal
3026
+ * @deprecated
3027
+ */
3028
+ poster?: string;
2762
3029
  /** Video format for example, mp4, hls. */
2763
3030
  format?: string;
3031
+ /**
3032
+ * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
3033
+ * @internal
3034
+ * @deprecated
3035
+ */
3036
+ urlExpirationDate?: Date | null;
3037
+ /**
3038
+ * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
3039
+ * @internal
3040
+ * @format DECIMAL_VALUE
3041
+ * @deprecated
3042
+ */
3043
+ sizeInBytes?: string | null;
3044
+ /**
3045
+ * Video quality. For example: 480p, 720p.
3046
+ * @internal
3047
+ */
3048
+ quality?: string | null;
3049
+ /**
3050
+ * Video filename.
3051
+ * @internal
3052
+ */
3053
+ filename?: string | null;
3054
+ /**
3055
+ * Video duration in seconds.
3056
+ * @internal
3057
+ * @readonly
3058
+ * @deprecated Video duration in seconds.
3059
+ * @replacedBy duration_in_milliseconds
3060
+ * @targetRemovalDate 2024-08-01
3061
+ */
3062
+ durationInSeconds?: number | null;
3063
+ /**
3064
+ * Video duration in milliseconds.
3065
+ * @internal
3066
+ * @readonly
3067
+ */
3068
+ durationInMilliseconds?: number | null;
3069
+ /**
3070
+ * When true, this is a protected asset, and calling the URL will return a 403 error.
3071
+ * In order to access private assets, make a request to:
3072
+ * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
3073
+ * @internal
3074
+ * @readonly
3075
+ */
3076
+ private?: boolean | null;
3077
+ /**
3078
+ * Key to identify the video resolution's relationship to the original media in WixMedia.
3079
+ * Can be used to request a download for the specific video resolution.
3080
+ * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
3081
+ * @internal
3082
+ * @readonly
3083
+ */
3084
+ assetKey?: string | null;
2764
3085
  }
2765
3086
  interface EmbedMedia {
2766
3087
  /** Thumbnail details. */
@@ -2813,6 +3134,10 @@ interface DraftPostTranslation {
2813
3134
  /** Post URL. */
2814
3135
  url?: string;
2815
3136
  }
3137
+ interface InitialDraftPostsCopied {
3138
+ /** Number of draft posts copied. */
3139
+ count?: number;
3140
+ }
2816
3141
  interface DraftCategoriesUpdated {
2817
3142
  /**
2818
3143
  * Draft post ID.
@@ -2851,298 +3176,125 @@ interface DraftTagsUpdated {
2851
3176
  */
2852
3177
  previousTags?: string[];
2853
3178
  }
2854
- interface GetDraftPostTotalsRequest {
3179
+ interface CreateDraftPostRequest {
3180
+ /** Draft post to create. */
3181
+ draftPost: DraftPost;
2855
3182
  /**
2856
- * Group results by fields (defaults to grouping by status).
2857
- * If, for example, grouping by language is passed, language values in response will be filled.
2858
- * If, for example, grouping by language is not passed, null values will be filled in language field in response.
2859
- * @maxSize 10
3183
+ * Whether the draft post should be published on creation.
3184
+ *
3185
+ * Default: `false`
2860
3186
  */
2861
- groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
3187
+ publish?: boolean;
2862
3188
  /**
2863
- * Optional language filter by provided language code. Useful in multilingual context.
2864
- * @format LANGUAGE_TAG
3189
+ * Save type.
3190
+ * @internal
2865
3191
  */
2866
- language?: string | null;
3192
+ saveType?: TypeWithLiterals;
3193
+ /**
3194
+ * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3195
+ * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3196
+ * only the draft post's base fields are returned.
3197
+ * @maxSize 10
3198
+ */
3199
+ fieldsets?: FieldWithLiterals[];
2867
3200
  }
2868
- declare enum TotalDraftPostsGroupingField {
2869
- /** Groups results by status. */
2870
- STATUS = "STATUS",
2871
- /** Groups results by language. */
2872
- LANGUAGE = "LANGUAGE"
3201
+ declare enum Type {
3202
+ UNKNOWN = "UNKNOWN",
3203
+ /** Manually saved. */
3204
+ MANUAL = "MANUAL",
3205
+ /** Triggered by autosave. */
3206
+ AUTO_SAVE = "AUTO_SAVE",
3207
+ /** Copied from template during provisioning flow. */
3208
+ PROVISIONING = "PROVISIONING",
3209
+ /** Imported from another blog. */
3210
+ IMPORT = "IMPORT",
3211
+ /** Triggered by autosave when post created by AI tool. */
3212
+ AI_AUTO_SAVE = "AI_AUTO_SAVE"
2873
3213
  }
2874
3214
  /** @enumType */
2875
- type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
2876
- interface GetDraftPostTotalsResponse {
2877
- /** Draft post totals. */
2878
- totalDraftPosts?: TotalDraftPosts[];
2879
- }
2880
- interface TotalDraftPosts {
2881
- /** Draft post totals in that group. */
2882
- total?: number;
2883
- /** Draft post status (only has value when grouping by status, otherwise null). */
2884
- status?: StatusWithLiterals;
3215
+ type TypeWithLiterals = Type | 'UNKNOWN' | 'MANUAL' | 'AUTO_SAVE' | 'PROVISIONING' | 'IMPORT' | 'AI_AUTO_SAVE';
3216
+ declare enum Field {
3217
+ /** Unknown field. */
3218
+ UNKNOWN = "UNKNOWN",
3219
+ /** Includes draft post preview URL. */
3220
+ URL = "URL",
2885
3221
  /**
2886
- * Draft post language code (only has value when grouping by language, otherwise null).
2887
- * @format LANGUAGE_TAG
3222
+ * Includes internal id field.
3223
+ * Reserved for internal use.
3224
+ * @internal
2888
3225
  */
2889
- language?: string | null;
2890
- }
2891
- interface DomainEvent extends DomainEventBodyOneOf {
2892
- createdEvent?: EntityCreatedEvent;
2893
- updatedEvent?: EntityUpdatedEvent;
2894
- deletedEvent?: EntityDeletedEvent;
2895
- actionEvent?: ActionEvent;
2896
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2897
- _id?: string;
3226
+ INTERNAL_ID = "INTERNAL_ID",
3227
+ /** Includes content field. */
3228
+ CONTENT = "CONTENT",
3229
+ /** Includes rich content field. */
3230
+ RICH_CONTENT = "RICH_CONTENT",
2898
3231
  /**
2899
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2900
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3232
+ * Includes draft post translations when present.
3233
+ * @internal
2901
3234
  */
2902
- entityFqdn?: string;
3235
+ TRANSLATIONS = "TRANSLATIONS",
3236
+ /** If the user has not set excerpt, returns the one autogenerated from content. */
3237
+ GENERATED_EXCERPT = "GENERATED_EXCERPT"
3238
+ }
3239
+ /** @enumType */
3240
+ type FieldWithLiterals = Field | 'UNKNOWN' | 'URL' | 'CONTENT' | 'RICH_CONTENT' | 'GENERATED_EXCERPT';
3241
+ interface CreateDraftPostResponse {
3242
+ /** Created draft post info. */
3243
+ draftPost?: DraftPost;
3244
+ }
3245
+ interface BulkCreateDraftPostsRequest {
2903
3246
  /**
2904
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2905
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3247
+ * Draft posts to create.
3248
+ * @minSize 1
3249
+ * @maxSize 20
2906
3250
  */
2907
- slug?: string;
2908
- /** ID of the entity associated with the event. */
2909
- entityId?: string;
2910
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2911
- eventTime?: Date | null;
3251
+ draftPosts: DraftPost[];
3252
+ /** Whether the draft post should be published after creation. */
3253
+ publish?: boolean;
2912
3254
  /**
2913
- * Whether the event was triggered as a result of a privacy regulation application
2914
- * (for example, GDPR).
3255
+ * Save type.
3256
+ * @internal
2915
3257
  */
2916
- triggeredByAnonymizeRequest?: boolean | null;
2917
- /** If present, indicates the action that triggered the event. */
2918
- originatedFrom?: string | null;
3258
+ saveType?: TypeWithLiterals;
3259
+ /** Whether to return the full created draft post entities in the response. */
3260
+ returnFullEntity?: boolean;
2919
3261
  /**
2920
- * 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.
2921
- * 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.
3262
+ * List of draft post fields to be included in the response if the entities are present.
3263
+ * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
3264
+ * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
3265
+ * @maxSize 10
2922
3266
  */
2923
- entityEventSequence?: string | null;
2924
- }
2925
- /** @oneof */
2926
- interface DomainEventBodyOneOf {
2927
- createdEvent?: EntityCreatedEvent;
2928
- updatedEvent?: EntityUpdatedEvent;
2929
- deletedEvent?: EntityDeletedEvent;
2930
- actionEvent?: ActionEvent;
2931
- }
2932
- interface EntityCreatedEvent {
2933
- entity?: string;
3267
+ fieldsets?: FieldWithLiterals[];
2934
3268
  }
2935
- interface RestoreInfo {
2936
- deletedDate?: Date | null;
3269
+ interface BulkCreateDraftPostsResponse {
3270
+ /** Draft posts created by bulk action. */
3271
+ results?: BulkDraftPostResult[];
3272
+ /** Bulk action metadata. */
3273
+ bulkActionMetadata?: BulkActionMetadata;
2937
3274
  }
2938
- interface EntityUpdatedEvent {
2939
- /**
2940
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2941
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2942
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2943
- */
2944
- currentEntity?: string;
3275
+ interface BulkDraftPostResult {
3276
+ /** Bulk actions metadata for draft post. */
3277
+ itemMetadata?: ItemMetadata;
3278
+ /** Optional full draft post. */
3279
+ item?: DraftPost;
2945
3280
  }
2946
- interface EntityDeletedEvent {
2947
- /** Entity that was deleted. */
2948
- deletedEntity?: string | null;
3281
+ interface ItemMetadata {
3282
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
3283
+ _id?: string | null;
3284
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
3285
+ originalIndex?: number;
3286
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
3287
+ success?: boolean;
3288
+ /** Details about the error in case of failure. */
3289
+ error?: ApplicationError;
2949
3290
  }
2950
- interface ActionEvent {
2951
- body?: string;
2952
- }
2953
- interface MessageEnvelope {
2954
- /**
2955
- * App instance ID.
2956
- * @format GUID
2957
- */
2958
- instanceId?: string | null;
2959
- /**
2960
- * Event type.
2961
- * @maxLength 150
2962
- */
2963
- eventType?: string;
2964
- /** The identification type and identity data. */
2965
- identity?: IdentificationData;
2966
- /** Stringify payload. */
2967
- data?: string;
2968
- /** Details related to the account */
2969
- accountInfo?: AccountInfo;
2970
- }
2971
- interface IdentificationData extends IdentificationDataIdOneOf {
2972
- /**
2973
- * ID of a site visitor that has not logged in to the site.
2974
- * @format GUID
2975
- */
2976
- anonymousVisitorId?: string;
2977
- /**
2978
- * ID of a site visitor that has logged in to the site.
2979
- * @format GUID
2980
- */
2981
- memberId?: string;
2982
- /**
2983
- * ID of a Wix user (site owner, contributor, etc.).
2984
- * @format GUID
2985
- */
2986
- wixUserId?: string;
2987
- /**
2988
- * ID of an app.
2989
- * @format GUID
2990
- */
2991
- appId?: string;
2992
- /** @readonly */
2993
- identityType?: WebhookIdentityTypeWithLiterals;
2994
- }
2995
- /** @oneof */
2996
- interface IdentificationDataIdOneOf {
2997
- /**
2998
- * ID of a site visitor that has not logged in to the site.
2999
- * @format GUID
3000
- */
3001
- anonymousVisitorId?: string;
3002
- /**
3003
- * ID of a site visitor that has logged in to the site.
3004
- * @format GUID
3005
- */
3006
- memberId?: string;
3007
- /**
3008
- * ID of a Wix user (site owner, contributor, etc.).
3009
- * @format GUID
3010
- */
3011
- wixUserId?: string;
3012
- /**
3013
- * ID of an app.
3014
- * @format GUID
3015
- */
3016
- appId?: string;
3017
- }
3018
- declare enum WebhookIdentityType {
3019
- UNKNOWN = "UNKNOWN",
3020
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3021
- MEMBER = "MEMBER",
3022
- WIX_USER = "WIX_USER",
3023
- APP = "APP"
3024
- }
3025
- /** @enumType */
3026
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3027
- interface AccountInfo {
3028
- /**
3029
- * ID of the Wix account associated with the event.
3030
- * @format GUID
3031
- */
3032
- accountId?: string | null;
3033
- /**
3034
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
3035
- * @format GUID
3036
- */
3037
- parentAccountId?: string | null;
3038
- /**
3039
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3040
- * @format GUID
3041
- */
3042
- siteId?: string | null;
3043
- }
3044
- interface InitialDraftPostsCopied {
3045
- /** Number of draft posts copied. */
3046
- count?: number;
3047
- }
3048
- interface CreateDraftPostRequest {
3049
- /** Draft post to create. */
3050
- draftPost: DraftPost;
3051
- /**
3052
- * Whether the draft post should be published on creation.
3053
- *
3054
- * Default: `false`
3055
- */
3056
- publish?: boolean;
3057
- /**
3058
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3059
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3060
- * only the draft post's base fields are returned.
3061
- * @maxSize 10
3062
- */
3063
- fieldsets?: FieldWithLiterals[];
3064
- }
3065
- declare enum Type {
3066
- UNKNOWN = "UNKNOWN",
3067
- /** Manually saved. */
3068
- MANUAL = "MANUAL",
3069
- /** Triggered by autosave. */
3070
- AUTO_SAVE = "AUTO_SAVE",
3071
- /** Copied from template during provisioning flow. */
3072
- PROVISIONING = "PROVISIONING",
3073
- /** Imported from another blog. */
3074
- IMPORT = "IMPORT",
3075
- /** Triggered by autosave when post created by AI tool. */
3076
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
3077
- }
3078
- /** @enumType */
3079
- type TypeWithLiterals = Type | 'UNKNOWN' | 'MANUAL' | 'AUTO_SAVE' | 'PROVISIONING' | 'IMPORT' | 'AI_AUTO_SAVE';
3080
- declare enum Field {
3081
- /** Unknown field. */
3082
- UNKNOWN = "UNKNOWN",
3083
- /** Includes draft post preview URL. */
3084
- URL = "URL",
3085
- /** Includes content field. */
3086
- CONTENT = "CONTENT",
3087
- /** Includes rich content field. */
3088
- RICH_CONTENT = "RICH_CONTENT",
3089
- /** If the user has not set excerpt, returns the one autogenerated from content. */
3090
- GENERATED_EXCERPT = "GENERATED_EXCERPT"
3091
- }
3092
- /** @enumType */
3093
- type FieldWithLiterals = Field | 'UNKNOWN' | 'URL' | 'CONTENT' | 'RICH_CONTENT' | 'GENERATED_EXCERPT';
3094
- interface CreateDraftPostResponse {
3095
- /** Created draft post info. */
3096
- draftPost?: DraftPost;
3097
- }
3098
- interface BulkCreateDraftPostsRequest {
3099
- /**
3100
- * Draft posts to create.
3101
- * @minSize 1
3102
- * @maxSize 20
3103
- */
3104
- draftPosts: DraftPost[];
3105
- /** Whether the draft post should be published after creation. */
3106
- publish?: boolean;
3107
- /** Whether to return the full created draft post entities in the response. */
3108
- returnFullEntity?: boolean;
3109
- /**
3110
- * List of draft post fields to be included in the response if the entities are present.
3111
- * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
3112
- * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
3113
- * @maxSize 10
3114
- */
3115
- fieldsets?: FieldWithLiterals[];
3116
- }
3117
- interface BulkCreateDraftPostsResponse {
3118
- /** Draft posts created by bulk action. */
3119
- results?: BulkDraftPostResult[];
3120
- /** Bulk action metadata. */
3121
- bulkActionMetadata?: BulkActionMetadata;
3122
- }
3123
- interface BulkDraftPostResult {
3124
- /** Bulk actions metadata for draft post. */
3125
- itemMetadata?: ItemMetadata;
3126
- /** Optional full draft post. */
3127
- item?: DraftPost;
3128
- }
3129
- interface ItemMetadata {
3130
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
3131
- _id?: string | null;
3132
- /** Index of the item within the request array. Allows for correlation between request and response items. */
3133
- originalIndex?: number;
3134
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
3135
- success?: boolean;
3136
- /** Details about the error in case of failure. */
3137
- error?: ApplicationError;
3138
- }
3139
- interface ApplicationError {
3140
- /** Error code. */
3141
- code?: string;
3142
- /** Description of the error. */
3143
- description?: string;
3144
- /** Data related to the error. */
3145
- data?: Record<string, any> | null;
3291
+ interface ApplicationError {
3292
+ /** Error code. */
3293
+ code?: string;
3294
+ /** Description of the error. */
3295
+ description?: string;
3296
+ /** Data related to the error. */
3297
+ data?: Record<string, any> | null;
3146
3298
  }
3147
3299
  interface BulkActionMetadata {
3148
3300
  /** Number of items that were successfully processed. */
@@ -3167,6 +3319,11 @@ interface BulkUpdateDraftPostsRequest {
3167
3319
  action?: ActionWithLiterals;
3168
3320
  /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
3169
3321
  scheduledPublishDate?: Date | null;
3322
+ /**
3323
+ * Save type.
3324
+ * @internal
3325
+ */
3326
+ saveType?: TypeWithLiterals;
3170
3327
  /** Whether to return the full updated draft post entities in the response. */
3171
3328
  returnFullEntity?: boolean;
3172
3329
  /**
@@ -3208,6 +3365,18 @@ interface BulkUpdateDraftPostsResponse {
3208
3365
  bulkActionMetadata?: BulkActionMetadata;
3209
3366
  }
3210
3367
  interface DraftPostOwnerChanged {
3368
+ /**
3369
+ * Member ID of the draft post's owner before the change.
3370
+ * @internal
3371
+ * @format GUID
3372
+ */
3373
+ oldMemberId?: string;
3374
+ /**
3375
+ * Member ID of the draft post's owner after the change.
3376
+ * @internal
3377
+ * @format GUID
3378
+ */
3379
+ newMemberId?: string;
3211
3380
  }
3212
3381
  interface ListDeletedDraftPostsRequest {
3213
3382
  /**
@@ -3288,6 +3457,13 @@ interface PagingMetadataV2 {
3288
3457
  tooManyToCount?: boolean | null;
3289
3458
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
3290
3459
  cursors?: Cursors;
3460
+ /**
3461
+ * Indicates if there are more results after the current page.
3462
+ * If `true`, another page of results can be retrieved.
3463
+ * If `false`, this is the last page.
3464
+ * @internal
3465
+ */
3466
+ hasNext?: boolean | null;
3291
3467
  }
3292
3468
  interface Cursors {
3293
3469
  /**
@@ -3344,6 +3520,16 @@ interface UpdateDraftPostContentResponse {
3344
3520
  interface UpdateDraftPostRequest {
3345
3521
  /** Draft post to update. */
3346
3522
  draftPost: DraftPost;
3523
+ /**
3524
+ * Field mask of fields to update.
3525
+ * @internal
3526
+ */
3527
+ fieldMask?: string[];
3528
+ /**
3529
+ * Save type.
3530
+ * @internal
3531
+ */
3532
+ saveType?: TypeWithLiterals;
3347
3533
  /**
3348
3534
  * Action to perform on the post.
3349
3535
  *
@@ -3524,6 +3710,20 @@ interface Sorting {
3524
3710
  fieldName?: string;
3525
3711
  /** Sort order. */
3526
3712
  order?: SortOrderWithLiterals;
3713
+ /**
3714
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
3715
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
3716
+ *
3717
+ * If multiple filters are provided, they are combined with AND operator.
3718
+ *
3719
+ * Example:
3720
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
3721
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
3722
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
3723
+ * @internal
3724
+ * @maxSize 10
3725
+ */
3726
+ selectItemsBy?: Record<string, any>[] | null;
3527
3727
  /**
3528
3728
  * Origin point for geo-distance sorting on a GEO field
3529
3729
  * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -3547,83 +3747,351 @@ interface Paging {
3547
3747
  * Number of items to load.
3548
3748
  * @max 100
3549
3749
  */
3550
- limit?: number | null;
3551
- /** Number of items to skip in the current sort order. */
3552
- offset?: number | null;
3750
+ limit?: number | null;
3751
+ /** Number of items to skip in the current sort order. */
3752
+ offset?: number | null;
3753
+ }
3754
+ interface CursorPaging {
3755
+ /**
3756
+ * Number of items to load.
3757
+ * @max 100
3758
+ */
3759
+ limit?: number | null;
3760
+ /**
3761
+ * Pointer to the next or previous page in the list of results.
3762
+ *
3763
+ * You can get the relevant cursor token
3764
+ * from the `pagingMetadata` object in the previous call's response.
3765
+ * Not relevant for the first request.
3766
+ * @maxLength 2000
3767
+ */
3768
+ cursor?: string | null;
3769
+ }
3770
+ interface QueryDraftPostsResponse {
3771
+ /** List of posts. */
3772
+ draftPosts?: DraftPost[];
3773
+ /** Details on the paged set of results returned. */
3774
+ pagingMetadata?: PagingMetadataV2;
3775
+ }
3776
+ interface PublishDraftPostRequest {
3777
+ /**
3778
+ * Draft post ID.
3779
+ * @maxLength 38
3780
+ */
3781
+ draftPostId: string;
3782
+ }
3783
+ interface PublishDraftPostResponse {
3784
+ /**
3785
+ * Published post ID.
3786
+ * @format GUID
3787
+ */
3788
+ postId?: string;
3789
+ }
3790
+ interface UnpublishPostRequest {
3791
+ /**
3792
+ * Draft post ID.
3793
+ * @maxLength 38
3794
+ */
3795
+ draftPostId?: string;
3796
+ }
3797
+ interface UnpublishPostResponse {
3798
+ }
3799
+ interface GetDraftPostCountsRequest {
3800
+ /**
3801
+ * Tag IDs to count draft posts for.
3802
+ * @maxSize 50
3803
+ * @format GUID
3804
+ */
3805
+ tagIds?: string[];
3806
+ /**
3807
+ * Category IDs to count draft posts for.
3808
+ * @maxSize 50
3809
+ * @format GUID
3810
+ */
3811
+ categoryIds?: string[];
3812
+ }
3813
+ interface GetDraftPostCountsResponse {
3814
+ /** Draft post counts per tag. */
3815
+ tagPostCounts?: DraftPostCount[];
3816
+ /** Draft post counts per category. */
3817
+ categoryPostCounts?: DraftPostCount[];
3818
+ }
3819
+ interface DraftPostCount {
3820
+ /**
3821
+ * Tag or Category ID.
3822
+ * @format GUID
3823
+ */
3824
+ _id?: string;
3825
+ /** Number of posts. */
3826
+ postCount?: number;
3827
+ }
3828
+ interface DomainEvent extends DomainEventBodyOneOf {
3829
+ createdEvent?: EntityCreatedEvent;
3830
+ updatedEvent?: EntityUpdatedEvent;
3831
+ deletedEvent?: EntityDeletedEvent;
3832
+ actionEvent?: ActionEvent;
3833
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3834
+ _id?: string;
3835
+ /**
3836
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3837
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3838
+ */
3839
+ entityFqdn?: string;
3840
+ /**
3841
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3842
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3843
+ */
3844
+ slug?: string;
3845
+ /** ID of the entity associated with the event. */
3846
+ entityId?: string;
3847
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3848
+ eventTime?: Date | null;
3849
+ /**
3850
+ * Whether the event was triggered as a result of a privacy regulation application
3851
+ * (for example, GDPR).
3852
+ */
3853
+ triggeredByAnonymizeRequest?: boolean | null;
3854
+ /** If present, indicates the action that triggered the event. */
3855
+ originatedFrom?: string | null;
3856
+ /**
3857
+ * 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.
3858
+ * 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.
3859
+ */
3860
+ entityEventSequence?: string | null;
3861
+ }
3862
+ /** @oneof */
3863
+ interface DomainEventBodyOneOf {
3864
+ createdEvent?: EntityCreatedEvent;
3865
+ updatedEvent?: EntityUpdatedEvent;
3866
+ deletedEvent?: EntityDeletedEvent;
3867
+ actionEvent?: ActionEvent;
3868
+ }
3869
+ interface EntityCreatedEvent {
3870
+ entity?: string;
3871
+ }
3872
+ interface RestoreInfo {
3873
+ deletedDate?: Date | null;
3874
+ }
3875
+ interface EntityUpdatedEvent {
3876
+ /**
3877
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3878
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3879
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3880
+ */
3881
+ currentEntity?: string;
3882
+ }
3883
+ interface EntityDeletedEvent {
3884
+ /** Entity that was deleted. */
3885
+ deletedEntity?: string | null;
3886
+ }
3887
+ interface ActionEvent {
3888
+ body?: string;
3889
+ }
3890
+ interface MessageEnvelope {
3891
+ /**
3892
+ * App instance ID.
3893
+ * @format GUID
3894
+ */
3895
+ instanceId?: string | null;
3896
+ /**
3897
+ * Event type.
3898
+ * @maxLength 150
3899
+ */
3900
+ eventType?: string;
3901
+ /** The identification type and identity data. */
3902
+ identity?: IdentificationData;
3903
+ /** Stringify payload. */
3904
+ data?: string;
3905
+ /** Details related to the account */
3906
+ accountInfo?: AccountInfo;
3907
+ }
3908
+ interface IdentificationData extends IdentificationDataIdOneOf {
3909
+ /**
3910
+ * ID of a site visitor that has not logged in to the site.
3911
+ * @format GUID
3912
+ */
3913
+ anonymousVisitorId?: string;
3914
+ /**
3915
+ * ID of a site visitor that has logged in to the site.
3916
+ * @format GUID
3917
+ */
3918
+ memberId?: string;
3919
+ /**
3920
+ * ID of a Wix user (site owner, contributor, etc.).
3921
+ * @format GUID
3922
+ */
3923
+ wixUserId?: string;
3924
+ /**
3925
+ * ID of an app.
3926
+ * @format GUID
3927
+ */
3928
+ appId?: string;
3929
+ /** @readonly */
3930
+ identityType?: WebhookIdentityTypeWithLiterals;
3931
+ }
3932
+ /** @oneof */
3933
+ interface IdentificationDataIdOneOf {
3934
+ /**
3935
+ * ID of a site visitor that has not logged in to the site.
3936
+ * @format GUID
3937
+ */
3938
+ anonymousVisitorId?: string;
3939
+ /**
3940
+ * ID of a site visitor that has logged in to the site.
3941
+ * @format GUID
3942
+ */
3943
+ memberId?: string;
3944
+ /**
3945
+ * ID of a Wix user (site owner, contributor, etc.).
3946
+ * @format GUID
3947
+ */
3948
+ wixUserId?: string;
3949
+ /**
3950
+ * ID of an app.
3951
+ * @format GUID
3952
+ */
3953
+ appId?: string;
3954
+ }
3955
+ declare enum WebhookIdentityType {
3956
+ UNKNOWN = "UNKNOWN",
3957
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3958
+ MEMBER = "MEMBER",
3959
+ WIX_USER = "WIX_USER",
3960
+ APP = "APP"
3961
+ }
3962
+ /** @enumType */
3963
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3964
+ interface AccountInfo {
3965
+ /**
3966
+ * ID of the Wix account associated with the event.
3967
+ * @format GUID
3968
+ */
3969
+ accountId?: string | null;
3970
+ /**
3971
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
3972
+ * @format GUID
3973
+ */
3974
+ parentAccountId?: string | null;
3975
+ /**
3976
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3977
+ * @format GUID
3978
+ */
3979
+ siteId?: string | null;
3553
3980
  }
3554
- interface CursorPaging {
3981
+ interface GetDraftPostTotalsRequest {
3555
3982
  /**
3556
- * Number of items to load.
3557
- * @max 100
3983
+ * Group results by fields (defaults to grouping by status).
3984
+ * If, for example, grouping by language is passed, language values in response will be filled.
3985
+ * If, for example, grouping by language is not passed, null values will be filled in language field in response.
3986
+ * @maxSize 10
3558
3987
  */
3559
- limit?: number | null;
3988
+ groupBy?: TotalDraftPostsGroupingFieldWithLiterals[];
3560
3989
  /**
3561
- * Pointer to the next or previous page in the list of results.
3562
- *
3563
- * You can get the relevant cursor token
3564
- * from the `pagingMetadata` object in the previous call's response.
3565
- * Not relevant for the first request.
3566
- * @maxLength 2000
3990
+ * Optional language filter by provided language code. Useful in multilingual context.
3991
+ * @format LANGUAGE_TAG
3567
3992
  */
3568
- cursor?: string | null;
3993
+ language?: string | null;
3569
3994
  }
3570
- interface QueryDraftPostsResponse {
3571
- /** List of posts. */
3572
- draftPosts?: DraftPost[];
3573
- /** Details on the paged set of results returned. */
3574
- pagingMetadata?: PagingMetadataV2;
3995
+ declare enum TotalDraftPostsGroupingField {
3996
+ /** Groups results by status. */
3997
+ STATUS = "STATUS",
3998
+ /** Groups results by language. */
3999
+ LANGUAGE = "LANGUAGE"
3575
4000
  }
3576
- interface PublishDraftPostRequest {
4001
+ /** @enumType */
4002
+ type TotalDraftPostsGroupingFieldWithLiterals = TotalDraftPostsGroupingField | 'STATUS' | 'LANGUAGE';
4003
+ interface GetDraftPostTotalsResponse {
4004
+ /** Draft post totals. */
4005
+ totalDraftPosts?: TotalDraftPosts[];
4006
+ }
4007
+ interface TotalDraftPosts {
4008
+ /** Draft post totals in that group. */
4009
+ total?: number;
4010
+ /** Draft post status (only has value when grouping by status, otherwise null). */
4011
+ status?: StatusWithLiterals;
3577
4012
  /**
3578
- * Draft post ID.
3579
- * @maxLength 38
4013
+ * Draft post language code (only has value when grouping by language, otherwise null).
4014
+ * @format LANGUAGE_TAG
3580
4015
  */
3581
- draftPostId: string;
4016
+ language?: string | null;
3582
4017
  }
3583
- interface PublishDraftPostResponse {
4018
+ interface TranslateDraftRequest {
3584
4019
  /**
3585
- * Published post ID.
4020
+ * Source post or draft ID
3586
4021
  * @format GUID
3587
4022
  */
3588
4023
  postId?: string;
3589
- }
3590
- interface UnpublishPostRequest {
3591
4024
  /**
3592
- * Draft post ID.
3593
- * @maxLength 38
4025
+ * Translation language
4026
+ * @format LANGUAGE_TAG
3594
4027
  */
3595
- draftPostId?: string;
4028
+ language?: string;
4029
+ /**
4030
+ * List of draft post fields to be included if entities are present in the response.
4031
+ * Base fieldset, which is default, will return all core draft post properties.
4032
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4033
+ * @maxSize 10
4034
+ */
4035
+ fieldsets?: FieldWithLiterals[];
4036
+ /**
4037
+ * Performs automatic translation of the title and the content of the draft post to the target language.
4038
+ * @internal
4039
+ */
4040
+ useAutoTranslation?: boolean;
3596
4041
  }
3597
- interface UnpublishPostResponse {
4042
+ interface TranslateDraftResponse {
4043
+ /** Draft post. */
4044
+ draftPost?: DraftPost;
3598
4045
  }
3599
- interface GetDraftPostCountsRequest {
4046
+ interface IsDraftPostAutoTranslatableRequest {
3600
4047
  /**
3601
- * Tag IDs to count draft posts for.
3602
- * @maxSize 50
4048
+ * Source post or draft ID.
3603
4049
  * @format GUID
3604
4050
  */
3605
- tagIds?: string[];
4051
+ draftPostId?: string;
4052
+ }
4053
+ interface IsDraftPostAutoTranslatableResponse {
3606
4054
  /**
3607
- * Category IDs to count draft posts for.
3608
- * @maxSize 50
4055
+ * Source draft post ID.
3609
4056
  * @format GUID
3610
4057
  */
3611
- categoryIds?: string[];
3612
- }
3613
- interface GetDraftPostCountsResponse {
3614
- /** Draft post counts per tag. */
3615
- tagPostCounts?: DraftPostCount[];
3616
- /** Draft post counts per category. */
3617
- categoryPostCounts?: DraftPostCount[];
4058
+ draftPostId?: string;
4059
+ /** Indicates if enough machine translation credits are available for the draft post translation. */
4060
+ translatable?: boolean;
4061
+ /** Draft post title word count. */
4062
+ titleWordCount?: number;
4063
+ /** Draft post content word count. */
4064
+ contentWordCount?: number;
4065
+ /** Word credits available for auto translation. */
4066
+ availableAutoTranslateWords?: number;
4067
+ /** Word credits available after auto translation would be done. */
4068
+ availableAutoTranslateWordsAfter?: number;
4069
+ /** Content text character count. */
4070
+ contentTextCharacterCount?: number;
3618
4071
  }
3619
- interface DraftPostCount {
4072
+ interface UpdateDraftPostLanguageRequest {
3620
4073
  /**
3621
- * Tag or Category ID.
4074
+ * Source draft post ID
3622
4075
  * @format GUID
3623
4076
  */
3624
- _id?: string;
3625
- /** Number of posts. */
3626
- postCount?: number;
4077
+ postId?: string;
4078
+ /**
4079
+ * New language to replace to
4080
+ * @minLength 2
4081
+ * @format LANGUAGE_TAG
4082
+ */
4083
+ language?: string;
4084
+ /**
4085
+ * List of draft post fields to be included if entities are present in the response.
4086
+ * Base fieldset, which is default, will return all core draft post properties.
4087
+ * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4088
+ * @maxSize 10
4089
+ */
4090
+ fieldsets?: FieldWithLiterals[];
4091
+ }
4092
+ interface UpdateDraftPostLanguageResponse {
4093
+ /** Draft post */
4094
+ draftPost?: DraftPost;
3627
4095
  }
3628
4096
  interface BulkRevertToUnpublishedRequest {
3629
4097
  /**
@@ -3665,6 +4133,15 @@ interface RevertToUnpublishedRequest {
3665
4133
  * @format GUID
3666
4134
  */
3667
4135
  postId?: string;
4136
+ /**
4137
+ * List of draft post fields to be included in the response.
4138
+ * @internal
4139
+ * @maxSize 10
4140
+ * @deprecated List of draft post fields to be included in the response.
4141
+ * @replacedBy fieldsets
4142
+ * @targetRemovalDate 2024-06-30
4143
+ */
4144
+ fieldsToInclude?: FieldWithLiterals[];
3668
4145
  /**
3669
4146
  * List of draft post fields to be included if entities are present in the response.
3670
4147
  * Base fieldset, which is default, will return all core draft post properties.
@@ -3683,6 +4160,15 @@ interface RejectDraftPostRequest {
3683
4160
  * @format GUID
3684
4161
  */
3685
4162
  postId?: string;
4163
+ /**
4164
+ * List of draft post fields to be included in the response.
4165
+ * @internal
4166
+ * @maxSize 10
4167
+ * @deprecated List of draft post fields to be included in the response.
4168
+ * @replacedBy fieldsets
4169
+ * @targetRemovalDate 2024-06-30
4170
+ */
4171
+ fieldsToInclude?: FieldWithLiterals[];
3686
4172
  /**
3687
4173
  * List of draft post fields to be included if entities are present in the response.
3688
4174
  * Base fieldset, which is default, will return all core draft post properties.
@@ -3706,6 +4192,15 @@ interface ApproveDraftPostRequest {
3706
4192
  * @maxLength 24
3707
4193
  */
3708
4194
  scheduledPublishDate?: string | null;
4195
+ /**
4196
+ * List of draft post fields to be included in the response.
4197
+ * @internal
4198
+ * @maxSize 10
4199
+ * @deprecated List of draft post fields to be included in the response.
4200
+ * @replacedBy fieldsets
4201
+ * @targetRemovalDate 2024-06-30
4202
+ */
4203
+ fieldsToInclude?: FieldWithLiterals[];
3709
4204
  /**
3710
4205
  * List of draft post fields to be included if entities are present in the response.
3711
4206
  * Base fieldset, which is default, will return all core draft post properties.
@@ -3725,78 +4220,14 @@ interface MarkPostAsInModerationRequest {
3725
4220
  */
3726
4221
  postId?: string;
3727
4222
  /**
3728
- * List of draft post fields to be included if entities are present in the response.
3729
- * Base fieldset, which is default, will return all core draft post properties.
3730
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
3731
- * @maxSize 10
3732
- */
3733
- fieldsets?: FieldWithLiterals[];
3734
- }
3735
- interface MarkPostAsInModerationResponse {
3736
- /** Updated post draft. */
3737
- draftPost?: DraftPost;
3738
- }
3739
- interface TranslateDraftRequest {
3740
- /**
3741
- * Source post or draft ID
3742
- * @format GUID
3743
- */
3744
- postId?: string;
3745
- /**
3746
- * Translation language
3747
- * @format LANGUAGE_TAG
3748
- */
3749
- language?: string;
3750
- /**
3751
- * List of draft post fields to be included if entities are present in the response.
3752
- * Base fieldset, which is default, will return all core draft post properties.
3753
- * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
4223
+ * List of draft post fields to be included in the response.
4224
+ * @internal
3754
4225
  * @maxSize 10
4226
+ * @deprecated List of draft post fields to be included in the response.
4227
+ * @replacedBy fieldsets
4228
+ * @targetRemovalDate 2024-06-30
3755
4229
  */
3756
- fieldsets?: FieldWithLiterals[];
3757
- }
3758
- interface TranslateDraftResponse {
3759
- /** Draft post. */
3760
- draftPost?: DraftPost;
3761
- }
3762
- interface IsDraftPostAutoTranslatableRequest {
3763
- /**
3764
- * Source post or draft ID.
3765
- * @format GUID
3766
- */
3767
- draftPostId?: string;
3768
- }
3769
- interface IsDraftPostAutoTranslatableResponse {
3770
- /**
3771
- * Source draft post ID.
3772
- * @format GUID
3773
- */
3774
- draftPostId?: string;
3775
- /** Indicates if enough machine translation credits are available for the draft post translation. */
3776
- translatable?: boolean;
3777
- /** Draft post title word count. */
3778
- titleWordCount?: number;
3779
- /** Draft post content word count. */
3780
- contentWordCount?: number;
3781
- /** Word credits available for auto translation. */
3782
- availableAutoTranslateWords?: number;
3783
- /** Word credits available after auto translation would be done. */
3784
- availableAutoTranslateWordsAfter?: number;
3785
- /** Content text character count. */
3786
- contentTextCharacterCount?: number;
3787
- }
3788
- interface UpdateDraftPostLanguageRequest {
3789
- /**
3790
- * Source draft post ID
3791
- * @format GUID
3792
- */
3793
- postId?: string;
3794
- /**
3795
- * New language to replace to
3796
- * @minLength 2
3797
- * @format LANGUAGE_TAG
3798
- */
3799
- language?: string;
4230
+ fieldsToInclude?: FieldWithLiterals[];
3800
4231
  /**
3801
4232
  * List of draft post fields to be included if entities are present in the response.
3802
4233
  * Base fieldset, which is default, will return all core draft post properties.
@@ -3805,8 +4236,8 @@ interface UpdateDraftPostLanguageRequest {
3805
4236
  */
3806
4237
  fieldsets?: FieldWithLiterals[];
3807
4238
  }
3808
- interface UpdateDraftPostLanguageResponse {
3809
- /** Draft post */
4239
+ interface MarkPostAsInModerationResponse {
4240
+ /** Updated post draft. */
3810
4241
  draftPost?: DraftPost;
3811
4242
  }
3812
4243
  interface BaseEventMetadata {
@@ -4191,6 +4622,25 @@ interface UpdateDraftPost {
4191
4622
  * @format LANGUAGE_TAG
4192
4623
  */
4193
4624
  language?: string | null;
4625
+ /**
4626
+ * Reserved for internal use.
4627
+ * @internal
4628
+ * @readonly
4629
+ */
4630
+ changeOrigin?: OriginWithLiterals;
4631
+ /**
4632
+ * Reserved for internal use.
4633
+ * @internal
4634
+ * @readonly
4635
+ * @maxLength 24
4636
+ */
4637
+ contentId?: string | null;
4638
+ /**
4639
+ * Reserved for internal use.
4640
+ * @internal
4641
+ * @format GUID
4642
+ */
4643
+ editingSessionId?: string | null;
4194
4644
  /**
4195
4645
  * Draft Post rich content.
4196
4646
  *
@@ -4206,6 +4656,13 @@ interface UpdateDraftPost {
4206
4656
  status?: StatusWithLiterals;
4207
4657
  /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
4208
4658
  moderationDetails?: ModerationDetails;
4659
+ /**
4660
+ * Reserved for internal use.
4661
+ * @internal
4662
+ * @readonly
4663
+ * @format GUID
4664
+ */
4665
+ mostRecentContributorId?: string | null;
4209
4666
  /**
4210
4667
  * Indicates if there are changes made to the draft post that have not yet been published.
4211
4668
  * @readonly
@@ -4221,10 +4678,23 @@ interface UpdateDraftPost {
4221
4678
  * @readonly
4222
4679
  */
4223
4680
  scheduledPublishDate?: Date | null;
4681
+ /**
4682
+ * Reserved for internal use.
4683
+ * @internal
4684
+ */
4685
+ content?: Record<string, any> | null;
4224
4686
  /** Date the post was first published. */
4225
4687
  firstPublishedDate?: Date | null;
4226
4688
  /** SEO data. */
4227
4689
  seoData?: SeoSchema;
4690
+ /**
4691
+ * Reserved for internal use.
4692
+ * @internal
4693
+ * @readonly
4694
+ * @maxSize 5000
4695
+ * @maxLength 100
4696
+ */
4697
+ slugs?: string[];
4228
4698
  /**
4229
4699
  * Draft post URL preview. What the URL will look like once the post is published.
4230
4700
  * @readonly
@@ -4244,6 +4714,32 @@ interface UpdateDraftPost {
4244
4714
  media?: Media;
4245
4715
  /** Number of paragraphs to display in a paid content preview for non-paying users. */
4246
4716
  previewTextParagraph?: number | null;
4717
+ /**
4718
+ * List of the post's translated posts.
4719
+ * @internal
4720
+ * @readonly
4721
+ * @maxSize 1000
4722
+ */
4723
+ translations?: DraftPostTranslation[];
4724
+ /**
4725
+ * Reserved for internal use, not included in base response.
4726
+ * @internal
4727
+ * @format GUID
4728
+ */
4729
+ originPostId?: string | null;
4730
+ /**
4731
+ * Reserved for internal use, not included in base response.
4732
+ * @internal
4733
+ * @format GUID
4734
+ */
4735
+ originPostInstanceId?: string | null;
4736
+ /**
4737
+ * Reserved for internal use.
4738
+ * @internal
4739
+ * @readonly
4740
+ * @maxLength 24
4741
+ */
4742
+ internalId?: string | null;
4247
4743
  }
4248
4744
  interface UpdateDraftPostOptions {
4249
4745
  /**
@@ -4581,6 +5077,20 @@ type DraftPostQuery = {
4581
5077
  */
4582
5078
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
4583
5079
  /**
5080
+ When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
5081
+ a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
5082
+
5083
+ If multiple filters are provided, they are combined with AND operator.
5084
+
5085
+ Example:
5086
+ Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
5087
+ and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
5088
+ { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
5089
+ @internal: undefined,
5090
+ @maxSize: 10
5091
+ */
5092
+ selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
5093
+ /**
4584
5094
  Origin point for geo-distance sorting on a GEO field
4585
5095
  results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
4586
5096
  */
@@ -4609,4 +5119,4 @@ declare const utils: {
4609
5119
  */
4610
5120
  declare function publishDraftPost(draftPostId: string): Promise<NonNullablePaths<PublishDraftPostResponse, `postId`, 2>>;
4611
5121
 
4612
- export { type AccountInfo, type AccountInfoMetadata, Action, type ActionEvent, type ActionWithLiterals, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type ApplicationError, type ApproveDraftPostRequest, type ApproveDraftPostResponse, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkActionMetadata, type BulkCreateDraftPostsOptions, type BulkCreateDraftPostsRequest, type BulkCreateDraftPostsResponse, type BulkDeleteDraftPostsOptions, type BulkDeleteDraftPostsRequest, type BulkDeleteDraftPostsResponse, type BulkDraftPostResult, type BulkRejectDraftPostRequest, type BulkRejectDraftPostResponse, type BulkRevertToUnpublishedRequest, type BulkRevertToUnpublishedResponse, type BulkUpdateDraftPostsOptions, type BulkUpdateDraftPostsRequest, type BulkUpdateDraftPostsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, type CreateDraftPostOptions, type CreateDraftPostRequest, type CreateDraftPostResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteDraftPostOptions, type DeleteDraftPostRequest, type DeleteDraftPostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftCategoriesUpdated, type DraftCreatedEnvelope, type DraftDeletedEnvelope, type DraftPost, type DraftPostCount, type DraftPostOwnerChanged, type DraftPostQuery, type DraftPostQuerySpec, type DraftPostTranslation, type DraftPostsQueryBuilder, type DraftPostsQueryResult, type DraftTagsUpdated, type DraftUpdatedEnvelope, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetDeletedDraftPostRequest, type GetDeletedDraftPostResponse, type GetDraftPostCountsRequest, type GetDraftPostCountsResponse, type GetDraftPostOptions, type GetDraftPostRequest, type GetDraftPostResponse, type GetDraftPostTotalsRequest, type GetDraftPostTotalsResponse, GetDraftPostsSort, type GetDraftPostsSortWithLiterals, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, type InitialDraftPostsCopied, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type IsDraftPostAutoTranslatableRequest, type IsDraftPostAutoTranslatableResponse, type Item, type ItemDataOneOf, type ItemMetadata, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDeletedDraftPostsOptions, type ListDeletedDraftPostsRequest, type ListDeletedDraftPostsResponse, type ListDraftPostsOptions, type ListDraftPostsRequest, type ListDraftPostsResponse, type ListItemNodeData, ListStyle, type ListStyleWithLiterals, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type MarkPostAsInModerationRequest, type MarkPostAsInModerationResponse, type MaskedDraftPosts, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type PricingData, type PublishDraftPostRequest, type PublishDraftPostResponse, type QueryDraftPostsOptions, type QueryDraftPostsRequest, type QueryDraftPostsResponse, type RejectDraftPostRequest, type RejectDraftPostResponse, type Rel, type RemoveFromTrashBinRequest, type RemoveFromTrashBinResponse, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreFromTrashBinRequest, type RestoreFromTrashBinResponse, type RestoreInfo, type RevertToUnpublishedRequest, type RevertToUnpublishedResponse, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, type TotalDraftPosts, TotalDraftPostsGroupingField, type TotalDraftPostsGroupingFieldWithLiterals, type TranslateDraftRequest, type TranslateDraftResponse, Type, type TypeWithLiterals, type UnpublishPostRequest, type UnpublishPostResponse, type UpdateDraftPost, type UpdateDraftPostContentRequest, type UpdateDraftPostContentResponse, type UpdateDraftPostLanguageRequest, type UpdateDraftPostLanguageResponse, type UpdateDraftPostOptions, type UpdateDraftPostRequest, type UpdateDraftPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, bulkCreateDraftPosts, bulkDeleteDraftPosts, bulkUpdateDraftPosts, createDraftPost, deleteDraftPost, getDeletedDraftPost, getDraftPost, listDeletedDraftPosts, listDraftPosts, onDraftCreated, onDraftDeleted, onDraftUpdated, publishDraftPost, queryDraftPosts, removeFromTrashBin, restoreFromTrashBin, typedQueryDraftPosts, updateDraftPost, utils };
5122
+ export { type AccountInfo, type AccountInfoMetadata, Action, type ActionEvent, type ActionWithLiterals, type AddressLocation, Alignment, type AlignmentWithLiterals, type AnchorData, type Animation, AnimationType, type AnimationTypeWithLiterals, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, type ApplicationError, type ApproveDraftPostRequest, type ApproveDraftPostResponse, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, BannerPosition, type BannerPositionWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkActionMetadata, type BulkCreateDraftPostsOptions, type BulkCreateDraftPostsRequest, type BulkCreateDraftPostsResponse, type BulkDeleteDraftPostsOptions, type BulkDeleteDraftPostsRequest, type BulkDeleteDraftPostsResponse, type BulkDraftPostResult, type BulkRejectDraftPostRequest, type BulkRejectDraftPostResponse, type BulkRevertToUnpublishedRequest, type BulkRevertToUnpublishedResponse, type BulkUpdateDraftPostsOptions, type BulkUpdateDraftPostsRequest, type BulkUpdateDraftPostsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckboxListData, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, ColumnSize, type ColumnSizeWithLiterals, type CommonQueryWithEntityContext, type CreateDraftPostOptions, type CreateDraftPostRequest, type CreateDraftPostResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteDraftPostOptions, type DeleteDraftPostRequest, type DeleteDraftPostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DividerDataStyles, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftCategoriesUpdated, type DraftCreatedEnvelope, type DraftDeletedEnvelope, type DraftPost, type DraftPostCount, type DraftPostOwnerChanged, type DraftPostQuery, type DraftPostQuerySpec, type DraftPostTranslation, type DraftPostsQueryBuilder, type DraftPostsQueryResult, type DraftTagsUpdated, type DraftUpdatedEnvelope, type EmbedData, type EmbedMedia, type EmbedThumbnail, type EmbedVideo, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntranceAnimation, type EntranceEffect, EntranceEffectType, type EntranceEffectTypeWithLiterals, type EventData, type EventMetadata, Field, type FieldWithLiterals, type FileData, type FileSource, type FileSourceDataOneOf, type FocalPoint, type FontFamilyData, type FontSizeData, FontType, type FontTypeWithLiterals, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetDeletedDraftPostRequest, type GetDeletedDraftPostResponse, type GetDraftPostCountsRequest, type GetDraftPostCountsResponse, type GetDraftPostOptions, type GetDraftPostRequest, type GetDraftPostResponse, type GetDraftPostTotalsRequest, type GetDraftPostTotalsResponse, GetDraftPostsSort, type GetDraftPostsSortWithLiterals, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataCrop, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, Indentation, type IndentationWithLiterals, type InitialDraftPostsCopied, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type IsDraftPostAutoTranslatableRequest, type IsDraftPostAutoTranslatableResponse, type Item, type ItemDataOneOf, type ItemMetadata, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineCap, type LineCapWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDeletedDraftPostsOptions, type ListDeletedDraftPostsRequest, type ListDeletedDraftPostsResponse, type ListDraftPostsOptions, type ListDraftPostsRequest, type ListDraftPostsResponse, type ListItemNodeData, ListStyle, type ListStyleWithLiterals, type ListValue, type LoopAnimation, type LoopEffect, LoopEffectType, type LoopEffectTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type MarkPostAsInModerationRequest, type MarkPostAsInModerationResponse, type MaskedDraftPosts, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type ModerationDetails, ModerationStatusStatus, type ModerationStatusStatusWithLiterals, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Oembed, type Option, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlatformQuery, type PlatformQueryPagingMethodOneOf, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollDesignBackground, type PollDesignBackgroundBackgroundOneOf, PollDesignBackgroundType, type PollDesignBackgroundTypeWithLiterals, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type PricingData, type PublishDraftPostRequest, type PublishDraftPostResponse, type QueryDraftPostsOptions, type QueryDraftPostsRequest, type QueryDraftPostsResponse, type RejectDraftPostRequest, type RejectDraftPostResponse, type Rel, type RemoveFromTrashBinRequest, type RemoveFromTrashBinResponse, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreFromTrashBinRequest, type RestoreFromTrashBinResponse, type RestoreInfo, type RevertToUnpublishedRequest, type RevertToUnpublishedResponse, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, type SketchData, type SmartBlockCellData, type SmartBlockData, SmartBlockDataType, type SmartBlockDataTypeWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type Stop, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type TocData, type TotalDraftPosts, TotalDraftPostsGroupingField, type TotalDraftPostsGroupingFieldWithLiterals, type TranslateDraftRequest, type TranslateDraftResponse, Type, type TypeWithLiterals, type UnpublishPostRequest, type UnpublishPostResponse, type UpdateDraftPost, type UpdateDraftPostContentRequest, type UpdateDraftPostContentResponse, type UpdateDraftPostLanguageRequest, type UpdateDraftPostLanguageResponse, type UpdateDraftPostOptions, type UpdateDraftPostRequest, type UpdateDraftPostResponse, type V1Media, Variant, type VariantWithLiterals, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, bulkCreateDraftPosts, bulkDeleteDraftPosts, bulkUpdateDraftPosts, createDraftPost, deleteDraftPost, getDeletedDraftPost, getDraftPost, listDeletedDraftPosts, listDraftPosts, onDraftCreated, onDraftDeleted, onDraftUpdated, publishDraftPost, queryDraftPosts, removeFromTrashBin, restoreFromTrashBin, typedQueryDraftPosts, updateDraftPost, utils };