@wix/auto_sdk_blog_posts 1.0.138 → 1.0.140

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 +433 -43
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +540 -351
  5. package/build/cjs/index.typings.js +286 -40
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +541 -352
  8. package/build/cjs/meta.js +286 -40
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +1 -1
  11. package/build/es/index.mjs +426 -43
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +540 -351
  14. package/build/es/index.typings.mjs +279 -40
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +541 -352
  17. package/build/es/meta.mjs +279 -40
  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 +433 -43
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +540 -351
  23. package/build/internal/cjs/index.typings.js +286 -40
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +541 -352
  26. package/build/internal/cjs/meta.js +286 -40
  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 +426 -43
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +540 -351
  32. package/build/internal/es/index.typings.mjs +279 -40
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +541 -352
  35. package/build/internal/es/meta.mjs +279 -40
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -323,6 +323,8 @@ interface Node extends NodeDataOneOf {
323
323
  layoutCellData?: LayoutCellData;
324
324
  /** Data for a shape node. */
325
325
  shapeData?: ShapeData;
326
+ /** Data for a card node. */
327
+ cardData?: CardData;
326
328
  /** 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. */
327
329
  type?: NodeTypeWithLiterals;
328
330
  /** Node ID. */
@@ -392,6 +394,8 @@ interface NodeDataOneOf {
392
394
  layoutCellData?: LayoutCellData;
393
395
  /** Data for a shape node. */
394
396
  shapeData?: ShapeData;
397
+ /** Data for a card node. */
398
+ cardData?: CardData;
395
399
  }
396
400
  declare enum NodeType {
397
401
  PARAGRAPH = "PARAGRAPH",
@@ -428,10 +432,11 @@ declare enum NodeType {
428
432
  CAPTION = "CAPTION",
429
433
  LAYOUT = "LAYOUT",
430
434
  LAYOUT_CELL = "LAYOUT_CELL",
431
- SHAPE = "SHAPE"
435
+ SHAPE = "SHAPE",
436
+ CARD = "CARD"
432
437
  }
433
438
  /** @enumType */
434
- 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' | 'SHAPE';
439
+ 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' | 'SHAPE' | 'CARD';
435
440
  interface NodeStyle {
436
441
  /** The top padding value in pixels. */
437
442
  paddingTop?: string | null;
@@ -452,6 +457,55 @@ interface ButtonData {
452
457
  /** Button link details. */
453
458
  link?: Link;
454
459
  }
460
+ /** Background type */
461
+ declare enum BackgroundType {
462
+ /** Solid color background */
463
+ COLOR = "COLOR",
464
+ /** Gradient background */
465
+ GRADIENT = "GRADIENT"
466
+ }
467
+ /** @enumType */
468
+ type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'GRADIENT';
469
+ interface Gradient {
470
+ /** Gradient type. */
471
+ type?: GradientTypeWithLiterals;
472
+ /**
473
+ * Color stops for the gradient.
474
+ * @maxSize 1000
475
+ */
476
+ stops?: Stop[];
477
+ /** Angle in degrees for linear gradient (0-360). */
478
+ angle?: number | null;
479
+ /**
480
+ * Horizontal center position for radial gradient (0-100).
481
+ * @max 100
482
+ */
483
+ centerX?: number | null;
484
+ /**
485
+ * Vertical center position for radial gradient (0-100).
486
+ * @max 100
487
+ */
488
+ centerY?: number | null;
489
+ }
490
+ /** Gradient type. */
491
+ declare enum GradientType {
492
+ /** Linear gradient. */
493
+ LINEAR = "LINEAR",
494
+ /** Radial gradient. */
495
+ RADIAL = "RADIAL"
496
+ }
497
+ /** @enumType */
498
+ type GradientTypeWithLiterals = GradientType | 'LINEAR' | 'RADIAL';
499
+ /** A single color stop in the gradient. */
500
+ interface Stop {
501
+ /**
502
+ * Stop color as hex value.
503
+ * @format COLOR_HEX
504
+ */
505
+ color?: string | null;
506
+ /** Stop position (0-1). */
507
+ position?: number | null;
508
+ }
455
509
  interface Border {
456
510
  /**
457
511
  * Deprecated: Use `borderWidth` in `styles` instead.
@@ -481,6 +535,18 @@ interface Colors {
481
535
  */
482
536
  background?: string | null;
483
537
  }
538
+ /** Background styling (color or gradient) */
539
+ interface Background {
540
+ /** Background type. */
541
+ type?: BackgroundTypeWithLiterals;
542
+ /**
543
+ * Background color as a hexadecimal value.
544
+ * @format COLOR_HEX
545
+ */
546
+ color?: string | null;
547
+ /** Gradient configuration. */
548
+ gradient?: Gradient;
549
+ }
484
550
  interface PluginContainerData {
485
551
  /** The width of the node when it's displayed. */
486
552
  width?: PluginContainerDataWidth;
@@ -601,17 +667,23 @@ interface Styles {
601
667
  */
602
668
  textColorHover?: string | null;
603
669
  /**
604
- * Background color as a hexadecimal value.
670
+ * Deprecated: Use `background` instead.
605
671
  * @format COLOR_HEX
672
+ * @deprecated
606
673
  */
607
674
  backgroundColor?: string | null;
608
675
  /**
609
- * Background color as a hexadecimal value (hover state).
676
+ * Deprecated: Use `backgroundHover` instead.
610
677
  * @format COLOR_HEX
678
+ * @deprecated
611
679
  */
612
680
  backgroundColorHover?: string | null;
613
681
  /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
614
682
  buttonSize?: string | null;
683
+ /** Background styling (color or gradient). */
684
+ background?: Background;
685
+ /** Background styling for hover state (color or gradient). */
686
+ backgroundHover?: Background;
615
687
  }
616
688
  interface Link extends LinkDataOneOf {
617
689
  /** The absolute URL for the linked document. */
@@ -1248,7 +1320,7 @@ interface OptionLayout {
1248
1320
  /** Sets whether to display option images. Defaults to `false`. */
1249
1321
  enableImage?: boolean | null;
1250
1322
  }
1251
- declare enum BackgroundType {
1323
+ declare enum PollDesignBackgroundType {
1252
1324
  /** Color background type */
1253
1325
  COLOR = "COLOR",
1254
1326
  /** Image background type */
@@ -1257,8 +1329,8 @@ declare enum BackgroundType {
1257
1329
  GRADIENT = "GRADIENT"
1258
1330
  }
1259
1331
  /** @enumType */
1260
- type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1261
- interface Gradient {
1332
+ type PollDesignBackgroundTypeWithLiterals = PollDesignBackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1333
+ interface BackgroundGradient {
1262
1334
  /** The gradient angle in degrees. */
1263
1335
  angle?: number | null;
1264
1336
  /**
@@ -1272,7 +1344,7 @@ interface Gradient {
1272
1344
  */
1273
1345
  lastColor?: string | null;
1274
1346
  }
1275
- interface Background extends BackgroundBackgroundOneOf {
1347
+ interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
1276
1348
  /**
1277
1349
  * The background color as a hexademical value.
1278
1350
  * @format COLOR_HEX
@@ -1281,12 +1353,12 @@ interface Background extends BackgroundBackgroundOneOf {
1281
1353
  /** An image to use for the background. */
1282
1354
  image?: V1Media;
1283
1355
  /** Details for a gradient background. */
1284
- gradient?: Gradient;
1356
+ gradient?: BackgroundGradient;
1285
1357
  /** Background type. For each option, include the relevant details. */
1286
- type?: BackgroundTypeWithLiterals;
1358
+ type?: PollDesignBackgroundTypeWithLiterals;
1287
1359
  }
1288
1360
  /** @oneof */
1289
- interface BackgroundBackgroundOneOf {
1361
+ interface PollDesignBackgroundBackgroundOneOf {
1290
1362
  /**
1291
1363
  * The background color as a hexademical value.
1292
1364
  * @format COLOR_HEX
@@ -1295,11 +1367,11 @@ interface BackgroundBackgroundOneOf {
1295
1367
  /** An image to use for the background. */
1296
1368
  image?: V1Media;
1297
1369
  /** Details for a gradient background. */
1298
- gradient?: Gradient;
1370
+ gradient?: BackgroundGradient;
1299
1371
  }
1300
1372
  interface PollDesign {
1301
1373
  /** Background styling. */
1302
- background?: Background;
1374
+ background?: PollDesignBackground;
1303
1375
  /** Border radius in pixels. */
1304
1376
  borderRadius?: number | null;
1305
1377
  }
@@ -1982,12 +2054,13 @@ interface CaptionData {
1982
2054
  }
1983
2055
  interface LayoutData {
1984
2056
  /**
1985
- * Background color as a hexadecimal value.
2057
+ * Deprecated: Use `background` instead.
1986
2058
  * @format COLOR_HEX
2059
+ * @deprecated
1987
2060
  */
1988
2061
  backgroundColor?: string | null;
1989
2062
  /** Background image. */
1990
- backgroundImage?: BackgroundImage;
2063
+ backgroundImage?: LayoutDataBackgroundImage;
1991
2064
  /**
1992
2065
  * Border color as a hexadecimal value.
1993
2066
  * @format COLOR_HEX
@@ -1995,15 +2068,16 @@ interface LayoutData {
1995
2068
  borderColor?: string | null;
1996
2069
  /** Border width in pixels. */
1997
2070
  borderWidth?: number | null;
1998
- /** Border */
2071
+ /** Border radius in pixels. */
1999
2072
  borderRadius?: number | null;
2000
2073
  /**
2001
- * Backdrop color as a hexadecimal value.
2074
+ * Deprecated: Use `backdrop` instead.
2002
2075
  * @format COLOR_HEX
2076
+ * @deprecated
2003
2077
  */
2004
2078
  backdropColor?: string | null;
2005
- /** Backdrop image.radius in pixels. */
2006
- backdropImage?: BackgroundImage;
2079
+ /** Backdrop image. */
2080
+ backdropImage?: LayoutDataBackgroundImage;
2007
2081
  /** Backdrop top padding. */
2008
2082
  backdropPaddingTop?: number | null;
2009
2083
  /** Backdrop bottom padding */
@@ -2027,8 +2101,12 @@ interface LayoutData {
2027
2101
  designTarget?: DesignTargetWithLiterals;
2028
2102
  /** Banner configuration. When present, this layout is displayed as a banner. */
2029
2103
  banner?: Banner;
2104
+ /** Background styling (color or gradient). */
2105
+ background?: LayoutDataBackground;
2106
+ /** Backdrop styling (color or gradient). */
2107
+ backdrop?: Backdrop;
2030
2108
  }
2031
- declare enum Scaling {
2109
+ declare enum ImageScalingScaling {
2032
2110
  /** Auto image scaling */
2033
2111
  AUTO = "AUTO",
2034
2112
  /** Contain image scaling */
@@ -2037,7 +2115,7 @@ declare enum Scaling {
2037
2115
  COVER = "COVER"
2038
2116
  }
2039
2117
  /** @enumType */
2040
- type ScalingWithLiterals = Scaling | 'AUTO' | 'CONTAIN' | 'COVER';
2118
+ type ImageScalingScalingWithLiterals = ImageScalingScaling | 'AUTO' | 'CONTAIN' | 'COVER';
2041
2119
  declare enum ImagePosition {
2042
2120
  /** Image positioned at the center */
2043
2121
  CENTER = "CENTER",
@@ -2068,13 +2146,31 @@ declare enum BannerOrigin {
2068
2146
  }
2069
2147
  /** @enumType */
2070
2148
  type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
2071
- interface BackgroundImage {
2149
+ /** Background type */
2150
+ declare enum LayoutDataBackgroundType {
2151
+ /** Solid color background */
2152
+ COLOR = "COLOR",
2153
+ /** Gradient background */
2154
+ GRADIENT = "GRADIENT"
2155
+ }
2156
+ /** @enumType */
2157
+ type LayoutDataBackgroundTypeWithLiterals = LayoutDataBackgroundType | 'COLOR' | 'GRADIENT';
2158
+ /** Backdrop type */
2159
+ declare enum BackdropType {
2160
+ /** Solid color backdrop */
2161
+ COLOR = "COLOR",
2162
+ /** Gradient backdrop */
2163
+ GRADIENT = "GRADIENT"
2164
+ }
2165
+ /** @enumType */
2166
+ type BackdropTypeWithLiterals = BackdropType | 'COLOR' | 'GRADIENT';
2167
+ interface LayoutDataBackgroundImage {
2072
2168
  /** Background image. */
2073
2169
  media?: V1Media;
2074
2170
  /** Background image opacity. */
2075
2171
  opacity?: number | null;
2076
2172
  /** Background image scaling. */
2077
- scaling?: ScalingWithLiterals;
2173
+ scaling?: ImageScalingScalingWithLiterals;
2078
2174
  /** Position of background. Defaults to `CENTER`. */
2079
2175
  position?: ImagePositionWithLiterals;
2080
2176
  }
@@ -2108,6 +2204,30 @@ interface Banner {
2108
2204
  /** Origin of the banner */
2109
2205
  origin?: BannerOriginWithLiterals;
2110
2206
  }
2207
+ /** Background styling (color or gradient) */
2208
+ interface LayoutDataBackground {
2209
+ /** Background type. */
2210
+ type?: LayoutDataBackgroundTypeWithLiterals;
2211
+ /**
2212
+ * Background color as a hexadecimal value.
2213
+ * @format COLOR_HEX
2214
+ */
2215
+ color?: string | null;
2216
+ /** Gradient configuration. */
2217
+ gradient?: Gradient;
2218
+ }
2219
+ /** Backdrop styling (color or gradient) */
2220
+ interface Backdrop {
2221
+ /** Backdrop type. */
2222
+ type?: BackdropTypeWithLiterals;
2223
+ /**
2224
+ * Backdrop color as a hexadecimal value.
2225
+ * @format COLOR_HEX
2226
+ */
2227
+ color?: string | null;
2228
+ /** Gradient configuration. */
2229
+ gradient?: Gradient;
2230
+ }
2111
2231
  interface LayoutCellData {
2112
2232
  /** Size of the cell in 12 columns grid. */
2113
2233
  colSpan?: number | null;
@@ -2129,6 +2249,75 @@ interface ShapeDataStyles {
2129
2249
  /** Map of original color keys to their new color values. */
2130
2250
  colors?: Record<string, string>;
2131
2251
  }
2252
+ interface CardData {
2253
+ /** Background styling (color or gradient). */
2254
+ background?: CardDataBackground;
2255
+ /** Background image. */
2256
+ backgroundImage?: BackgroundImage;
2257
+ }
2258
+ declare enum Scaling {
2259
+ /** Auto image scaling */
2260
+ AUTO = "AUTO",
2261
+ /** Contain image scaling */
2262
+ CONTAIN = "CONTAIN",
2263
+ /** Cover image scaling */
2264
+ COVER = "COVER"
2265
+ }
2266
+ /** @enumType */
2267
+ type ScalingWithLiterals = Scaling | 'AUTO' | 'CONTAIN' | 'COVER';
2268
+ declare enum ImagePositionPosition {
2269
+ /** Image positioned at the center */
2270
+ CENTER = "CENTER",
2271
+ /** Image positioned on the left */
2272
+ CENTER_LEFT = "CENTER_LEFT",
2273
+ /** Image positioned on the right */
2274
+ CENTER_RIGHT = "CENTER_RIGHT",
2275
+ /** Image positioned at the center top */
2276
+ TOP = "TOP",
2277
+ /** Image positioned at the top left */
2278
+ TOP_LEFT = "TOP_LEFT",
2279
+ /** Image positioned at the top right */
2280
+ TOP_RIGHT = "TOP_RIGHT",
2281
+ /** Image positioned at the center bottom */
2282
+ BOTTOM = "BOTTOM",
2283
+ /** Image positioned at the bottom left */
2284
+ BOTTOM_LEFT = "BOTTOM_LEFT",
2285
+ /** Image positioned at the bottom right */
2286
+ BOTTOM_RIGHT = "BOTTOM_RIGHT"
2287
+ }
2288
+ /** @enumType */
2289
+ type ImagePositionPositionWithLiterals = ImagePositionPosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
2290
+ /** Background type */
2291
+ declare enum CardDataBackgroundType {
2292
+ /** Solid color background */
2293
+ COLOR = "COLOR",
2294
+ /** Gradient background */
2295
+ GRADIENT = "GRADIENT"
2296
+ }
2297
+ /** @enumType */
2298
+ type CardDataBackgroundTypeWithLiterals = CardDataBackgroundType | 'COLOR' | 'GRADIENT';
2299
+ /** Background styling (color or gradient) */
2300
+ interface CardDataBackground {
2301
+ /** Background type. */
2302
+ type?: CardDataBackgroundTypeWithLiterals;
2303
+ /**
2304
+ * Background color as a hexadecimal value.
2305
+ * @format COLOR_HEX
2306
+ */
2307
+ color?: string | null;
2308
+ /** Gradient configuration. */
2309
+ gradient?: Gradient;
2310
+ }
2311
+ interface BackgroundImage {
2312
+ /** Background image. */
2313
+ media?: V1Media;
2314
+ /** Background image opacity. */
2315
+ opacity?: number | null;
2316
+ /** Background image scaling. */
2317
+ scaling?: ScalingWithLiterals;
2318
+ /** Position of background. Defaults to `CENTER`. */
2319
+ position?: ImagePositionPositionWithLiterals;
2320
+ }
2132
2321
  interface Metadata {
2133
2322
  /** Schema version. */
2134
2323
  version?: number;
@@ -2396,78 +2585,351 @@ interface PostUnlikedInitiatorOneOf {
2396
2585
  */
2397
2586
  anonymousVisitorId?: string | null;
2398
2587
  }
2399
- interface ListTemplatesRequest {
2400
- /**
2401
- * Filter post templates by given template category ids
2402
- * @maxSize 50
2403
- * @format GUID
2404
- */
2405
- categoryIds?: string[];
2588
+ /** Get Blog Publications Count Stats request */
2589
+ interface QueryPublicationsCountStatsRequest {
2590
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2591
+ rangeStart?: Date | null;
2592
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2593
+ rangeEnd?: Date | null;
2594
+ /** Order of the returned results. */
2595
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2596
+ /** Number of months to include in the response. */
2597
+ months?: number;
2406
2598
  /**
2407
- * Filter post templates by provided language
2599
+ * Language filter
2600
+ *
2601
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2408
2602
  * @format LANGUAGE_TAG
2409
2603
  */
2410
2604
  language?: string | null;
2411
- /** Returns post template categories when set to TRUE */
2412
- listTemplateCategories?: boolean;
2413
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2414
- sort?: GetPostTemplatesSortWithLiterals;
2415
- /** Pagination options. */
2416
- paging?: BlogPaging;
2605
+ /**
2606
+ * Timezone of the client.
2607
+ * @minLength 3
2608
+ * @maxLength 100
2609
+ */
2610
+ timeZone?: string | null;
2417
2611
  }
2418
- declare enum GetPostTemplatesSort {
2419
- /** Sort by ascending publishing date. */
2420
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2421
- /** Sort by descending publishing date. */
2422
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2612
+ declare enum QueryPublicationsCountStatsRequestOrder {
2613
+ UNKNOWN = "UNKNOWN",
2614
+ OLDEST = "OLDEST",
2615
+ NEWEST = "NEWEST"
2423
2616
  }
2424
2617
  /** @enumType */
2425
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2426
- interface BlogPaging {
2618
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2619
+ /** Get Blog Publications Count Stats response */
2620
+ interface QueryPublicationsCountStatsResponse {
2621
+ /** Chronologically ordered list of publications. */
2622
+ stats?: PeriodPublicationsCount[];
2623
+ }
2624
+ /** Publications count for a specific time period */
2625
+ interface PeriodPublicationsCount {
2626
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2627
+ periodStart?: Date | null;
2628
+ /** Number of posts published during this month. */
2629
+ publicationsCount?: number;
2630
+ }
2631
+ /** Get Blog Post Count Stats request */
2632
+ interface QueryPostCountStatsRequest {
2633
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2634
+ rangeStart?: Date | null;
2427
2635
  /**
2428
- * Number of items to skip in the current sort order.
2636
+ * Order of returned results.
2429
2637
  *
2638
+ * - `OLDEST`: posts by date in ascending order.
2639
+ * - `NEWEST`: posts by date in descending order.
2430
2640
  *
2431
- * Default: `0`
2641
+ * Default: `OLDEST`
2432
2642
  */
2433
- offset?: number;
2643
+ order?: OrderWithLiterals;
2644
+ /** Number of months to include in response. */
2645
+ months?: number;
2434
2646
  /**
2435
- * Number of items to return.
2436
- *
2647
+ * Language filter.
2437
2648
  *
2438
- * Default:`50`
2439
- * @min 1
2440
- * @max 100
2649
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2650
+ * Pass a language to only receive the period post count for that specified language.
2651
+ * @format LANGUAGE_TAG
2441
2652
  */
2442
- limit?: number;
2653
+ language?: string | null;
2443
2654
  /**
2444
- * Pointer to the next or previous page in the list of results.
2445
- * @maxLength 2000
2655
+ * Time zone to use when calculating the start of the month.
2656
+ *
2657
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2658
+ * @minLength 3
2659
+ * @maxLength 100
2446
2660
  */
2447
- cursor?: string | null;
2661
+ timeZone?: string | null;
2448
2662
  }
2449
- interface ListTemplatesResponse {
2450
- /** Available post templates */
2451
- postTemplates?: Post[];
2452
- /** Details on the paged set of posts templates returned. */
2453
- postTemplatesMetaData?: MetaData;
2454
- /** Post template categories. This value is returned empty unless asked explicitly */
2455
- templateCategories?: Category[];
2663
+ declare enum Order {
2664
+ UNKNOWN = "UNKNOWN",
2665
+ OLDEST = "OLDEST",
2666
+ NEWEST = "NEWEST"
2456
2667
  }
2457
- interface MetaData {
2458
- /** Number of items returned in this response. */
2459
- count?: number;
2460
- /** Requested offset. */
2461
- offset?: number;
2462
- /** Total number of items that match the query. */
2463
- total?: number;
2464
- /**
2465
- * Pointer to the next or previous page in the list of results.
2466
- * @maxLength 2000
2467
- */
2468
- cursor?: string | null;
2668
+ /** @enumType */
2669
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2670
+ /** Get Blog Post Count Stats response */
2671
+ interface QueryPostCountStatsResponse {
2672
+ /** List of published post counts by month. */
2673
+ stats?: PeriodPostCount[];
2469
2674
  }
2470
- interface Category {
2675
+ /** Post count for a specific time period */
2676
+ interface PeriodPostCount {
2677
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2678
+ periodStart?: Date | null;
2679
+ /** Number of posts published during this month. */
2680
+ postCount?: number;
2681
+ }
2682
+ interface GetTotalPublicationsRequest {
2683
+ /**
2684
+ * Language filter
2685
+ * @minLength 2
2686
+ * @format LANGUAGE_TAG
2687
+ */
2688
+ language?: string | null;
2689
+ }
2690
+ interface GetTotalPublicationsResponse {
2691
+ /** Total amount of publications. */
2692
+ total?: number;
2693
+ }
2694
+ interface GetTotalPostsRequest {
2695
+ /**
2696
+ * Language filter.
2697
+ *
2698
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2699
+ * Pass a language to receive the total amount of posts in that specified language.
2700
+ * @format LANGUAGE_TAG
2701
+ */
2702
+ language?: string | null;
2703
+ }
2704
+ interface GetTotalPostsResponse {
2705
+ /** Total amount of published posts. */
2706
+ total?: number;
2707
+ }
2708
+ interface DomainEvent extends DomainEventBodyOneOf {
2709
+ createdEvent?: EntityCreatedEvent;
2710
+ updatedEvent?: EntityUpdatedEvent;
2711
+ deletedEvent?: EntityDeletedEvent;
2712
+ actionEvent?: ActionEvent;
2713
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2714
+ _id?: string;
2715
+ /**
2716
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2717
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2718
+ */
2719
+ entityFqdn?: string;
2720
+ /**
2721
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2722
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2723
+ */
2724
+ slug?: string;
2725
+ /** ID of the entity associated with the event. */
2726
+ entityId?: string;
2727
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2728
+ eventTime?: Date | null;
2729
+ /**
2730
+ * Whether the event was triggered as a result of a privacy regulation application
2731
+ * (for example, GDPR).
2732
+ */
2733
+ triggeredByAnonymizeRequest?: boolean | null;
2734
+ /** If present, indicates the action that triggered the event. */
2735
+ originatedFrom?: string | null;
2736
+ /**
2737
+ * 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.
2738
+ * 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.
2739
+ */
2740
+ entityEventSequence?: string | null;
2741
+ }
2742
+ /** @oneof */
2743
+ interface DomainEventBodyOneOf {
2744
+ createdEvent?: EntityCreatedEvent;
2745
+ updatedEvent?: EntityUpdatedEvent;
2746
+ deletedEvent?: EntityDeletedEvent;
2747
+ actionEvent?: ActionEvent;
2748
+ }
2749
+ interface EntityCreatedEvent {
2750
+ entity?: string;
2751
+ }
2752
+ interface RestoreInfo {
2753
+ deletedDate?: Date | null;
2754
+ }
2755
+ interface EntityUpdatedEvent {
2756
+ /**
2757
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2758
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2759
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2760
+ */
2761
+ currentEntity?: string;
2762
+ }
2763
+ interface EntityDeletedEvent {
2764
+ /** Entity that was deleted. */
2765
+ deletedEntity?: string | null;
2766
+ }
2767
+ interface ActionEvent {
2768
+ body?: string;
2769
+ }
2770
+ interface MessageEnvelope {
2771
+ /**
2772
+ * App instance ID.
2773
+ * @format GUID
2774
+ */
2775
+ instanceId?: string | null;
2776
+ /**
2777
+ * Event type.
2778
+ * @maxLength 150
2779
+ */
2780
+ eventType?: string;
2781
+ /** The identification type and identity data. */
2782
+ identity?: IdentificationData;
2783
+ /** Stringify payload. */
2784
+ data?: string;
2785
+ /** Details related to the account */
2786
+ accountInfo?: AccountInfo;
2787
+ }
2788
+ interface IdentificationData extends IdentificationDataIdOneOf {
2789
+ /**
2790
+ * ID of a site visitor that has not logged in to the site.
2791
+ * @format GUID
2792
+ */
2793
+ anonymousVisitorId?: string;
2794
+ /**
2795
+ * ID of a site visitor that has logged in to the site.
2796
+ * @format GUID
2797
+ */
2798
+ memberId?: string;
2799
+ /**
2800
+ * ID of a Wix user (site owner, contributor, etc.).
2801
+ * @format GUID
2802
+ */
2803
+ wixUserId?: string;
2804
+ /**
2805
+ * ID of an app.
2806
+ * @format GUID
2807
+ */
2808
+ appId?: string;
2809
+ /** @readonly */
2810
+ identityType?: WebhookIdentityTypeWithLiterals;
2811
+ }
2812
+ /** @oneof */
2813
+ interface IdentificationDataIdOneOf {
2814
+ /**
2815
+ * ID of a site visitor that has not logged in to the site.
2816
+ * @format GUID
2817
+ */
2818
+ anonymousVisitorId?: string;
2819
+ /**
2820
+ * ID of a site visitor that has logged in to the site.
2821
+ * @format GUID
2822
+ */
2823
+ memberId?: string;
2824
+ /**
2825
+ * ID of a Wix user (site owner, contributor, etc.).
2826
+ * @format GUID
2827
+ */
2828
+ wixUserId?: string;
2829
+ /**
2830
+ * ID of an app.
2831
+ * @format GUID
2832
+ */
2833
+ appId?: string;
2834
+ }
2835
+ declare enum WebhookIdentityType {
2836
+ UNKNOWN = "UNKNOWN",
2837
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2838
+ MEMBER = "MEMBER",
2839
+ WIX_USER = "WIX_USER",
2840
+ APP = "APP"
2841
+ }
2842
+ /** @enumType */
2843
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2844
+ interface AccountInfo {
2845
+ /**
2846
+ * ID of the Wix account associated with the event.
2847
+ * @format GUID
2848
+ */
2849
+ accountId?: string | null;
2850
+ /**
2851
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
2852
+ * @format GUID
2853
+ */
2854
+ parentAccountId?: string | null;
2855
+ /**
2856
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2857
+ * @format GUID
2858
+ */
2859
+ siteId?: string | null;
2860
+ }
2861
+ interface ListTemplatesRequest {
2862
+ /**
2863
+ * Filter post templates by given template category ids
2864
+ * @maxSize 50
2865
+ * @format GUID
2866
+ */
2867
+ categoryIds?: string[];
2868
+ /**
2869
+ * Filter post templates by provided language
2870
+ * @format LANGUAGE_TAG
2871
+ */
2872
+ language?: string | null;
2873
+ /** Returns post template categories when set to TRUE */
2874
+ listTemplateCategories?: boolean;
2875
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2876
+ sort?: GetPostTemplatesSortWithLiterals;
2877
+ /** Pagination options. */
2878
+ paging?: BlogPaging;
2879
+ }
2880
+ declare enum GetPostTemplatesSort {
2881
+ /** Sort by ascending publishing date. */
2882
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2883
+ /** Sort by descending publishing date. */
2884
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2885
+ }
2886
+ /** @enumType */
2887
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2888
+ interface BlogPaging {
2889
+ /**
2890
+ * Number of items to skip in the current sort order.
2891
+ *
2892
+ *
2893
+ * Default: `0`
2894
+ */
2895
+ offset?: number;
2896
+ /**
2897
+ * Number of items to return.
2898
+ *
2899
+ *
2900
+ * Default:`50`
2901
+ * @min 1
2902
+ * @max 100
2903
+ */
2904
+ limit?: number;
2905
+ /**
2906
+ * Pointer to the next or previous page in the list of results.
2907
+ * @maxLength 2000
2908
+ */
2909
+ cursor?: string | null;
2910
+ }
2911
+ interface ListTemplatesResponse {
2912
+ /** Available post templates */
2913
+ postTemplates?: Post[];
2914
+ /** Details on the paged set of posts templates returned. */
2915
+ postTemplatesMetaData?: MetaData;
2916
+ /** Post template categories. This value is returned empty unless asked explicitly */
2917
+ templateCategories?: Category[];
2918
+ }
2919
+ interface MetaData {
2920
+ /** Number of items returned in this response. */
2921
+ count?: number;
2922
+ /** Requested offset. */
2923
+ offset?: number;
2924
+ /** Total number of items that match the query. */
2925
+ total?: number;
2926
+ /**
2927
+ * Pointer to the next or previous page in the list of results.
2928
+ * @maxLength 2000
2929
+ */
2930
+ cursor?: string | null;
2931
+ }
2932
+ interface Category {
2471
2933
  /**
2472
2934
  * Category ID.
2473
2935
  * @immutable
@@ -2824,279 +3286,6 @@ interface DraftPostTranslation {
2824
3286
  /** Post URL. */
2825
3287
  url?: string;
2826
3288
  }
2827
- interface DomainEvent extends DomainEventBodyOneOf {
2828
- createdEvent?: EntityCreatedEvent;
2829
- updatedEvent?: EntityUpdatedEvent;
2830
- deletedEvent?: EntityDeletedEvent;
2831
- actionEvent?: ActionEvent;
2832
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2833
- _id?: string;
2834
- /**
2835
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2836
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2837
- */
2838
- entityFqdn?: string;
2839
- /**
2840
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2841
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2842
- */
2843
- slug?: string;
2844
- /** ID of the entity associated with the event. */
2845
- entityId?: string;
2846
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2847
- eventTime?: Date | null;
2848
- /**
2849
- * Whether the event was triggered as a result of a privacy regulation application
2850
- * (for example, GDPR).
2851
- */
2852
- triggeredByAnonymizeRequest?: boolean | null;
2853
- /** If present, indicates the action that triggered the event. */
2854
- originatedFrom?: string | null;
2855
- /**
2856
- * 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.
2857
- * 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.
2858
- */
2859
- entityEventSequence?: string | null;
2860
- }
2861
- /** @oneof */
2862
- interface DomainEventBodyOneOf {
2863
- createdEvent?: EntityCreatedEvent;
2864
- updatedEvent?: EntityUpdatedEvent;
2865
- deletedEvent?: EntityDeletedEvent;
2866
- actionEvent?: ActionEvent;
2867
- }
2868
- interface EntityCreatedEvent {
2869
- entity?: string;
2870
- }
2871
- interface RestoreInfo {
2872
- deletedDate?: Date | null;
2873
- }
2874
- interface EntityUpdatedEvent {
2875
- /**
2876
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2877
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2878
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2879
- */
2880
- currentEntity?: string;
2881
- }
2882
- interface EntityDeletedEvent {
2883
- /** Entity that was deleted. */
2884
- deletedEntity?: string | null;
2885
- }
2886
- interface ActionEvent {
2887
- body?: string;
2888
- }
2889
- interface MessageEnvelope {
2890
- /**
2891
- * App instance ID.
2892
- * @format GUID
2893
- */
2894
- instanceId?: string | null;
2895
- /**
2896
- * Event type.
2897
- * @maxLength 150
2898
- */
2899
- eventType?: string;
2900
- /** The identification type and identity data. */
2901
- identity?: IdentificationData;
2902
- /** Stringify payload. */
2903
- data?: string;
2904
- /** Details related to the account */
2905
- accountInfo?: AccountInfo;
2906
- }
2907
- interface IdentificationData extends IdentificationDataIdOneOf {
2908
- /**
2909
- * ID of a site visitor that has not logged in to the site.
2910
- * @format GUID
2911
- */
2912
- anonymousVisitorId?: string;
2913
- /**
2914
- * ID of a site visitor that has logged in to the site.
2915
- * @format GUID
2916
- */
2917
- memberId?: string;
2918
- /**
2919
- * ID of a Wix user (site owner, contributor, etc.).
2920
- * @format GUID
2921
- */
2922
- wixUserId?: string;
2923
- /**
2924
- * ID of an app.
2925
- * @format GUID
2926
- */
2927
- appId?: string;
2928
- /** @readonly */
2929
- identityType?: WebhookIdentityTypeWithLiterals;
2930
- }
2931
- /** @oneof */
2932
- interface IdentificationDataIdOneOf {
2933
- /**
2934
- * ID of a site visitor that has not logged in to the site.
2935
- * @format GUID
2936
- */
2937
- anonymousVisitorId?: string;
2938
- /**
2939
- * ID of a site visitor that has logged in to the site.
2940
- * @format GUID
2941
- */
2942
- memberId?: string;
2943
- /**
2944
- * ID of a Wix user (site owner, contributor, etc.).
2945
- * @format GUID
2946
- */
2947
- wixUserId?: string;
2948
- /**
2949
- * ID of an app.
2950
- * @format GUID
2951
- */
2952
- appId?: string;
2953
- }
2954
- declare enum WebhookIdentityType {
2955
- UNKNOWN = "UNKNOWN",
2956
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2957
- MEMBER = "MEMBER",
2958
- WIX_USER = "WIX_USER",
2959
- APP = "APP"
2960
- }
2961
- /** @enumType */
2962
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2963
- interface AccountInfo {
2964
- /**
2965
- * ID of the Wix account associated with the event.
2966
- * @format GUID
2967
- */
2968
- accountId?: string | null;
2969
- /**
2970
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
2971
- * @format GUID
2972
- */
2973
- parentAccountId?: string | null;
2974
- /**
2975
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2976
- * @format GUID
2977
- */
2978
- siteId?: string | null;
2979
- }
2980
- /** Get Blog Publications Count Stats request */
2981
- interface QueryPublicationsCountStatsRequest {
2982
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2983
- rangeStart?: Date | null;
2984
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2985
- rangeEnd?: Date | null;
2986
- /** Order of the returned results. */
2987
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2988
- /** Number of months to include in the response. */
2989
- months?: number;
2990
- /**
2991
- * Language filter
2992
- *
2993
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2994
- * @format LANGUAGE_TAG
2995
- */
2996
- language?: string | null;
2997
- /**
2998
- * Timezone of the client.
2999
- * @minLength 3
3000
- * @maxLength 100
3001
- */
3002
- timeZone?: string | null;
3003
- }
3004
- declare enum QueryPublicationsCountStatsRequestOrder {
3005
- UNKNOWN = "UNKNOWN",
3006
- OLDEST = "OLDEST",
3007
- NEWEST = "NEWEST"
3008
- }
3009
- /** @enumType */
3010
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3011
- /** Get Blog Publications Count Stats response */
3012
- interface QueryPublicationsCountStatsResponse {
3013
- /** Chronologically ordered list of publications. */
3014
- stats?: PeriodPublicationsCount[];
3015
- }
3016
- /** Publications count for a specific time period */
3017
- interface PeriodPublicationsCount {
3018
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3019
- periodStart?: Date | null;
3020
- /** Number of posts published during this month. */
3021
- publicationsCount?: number;
3022
- }
3023
- /** Get Blog Post Count Stats request */
3024
- interface QueryPostCountStatsRequest {
3025
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3026
- rangeStart?: Date | null;
3027
- /**
3028
- * Order of returned results.
3029
- *
3030
- * - `OLDEST`: posts by date in ascending order.
3031
- * - `NEWEST`: posts by date in descending order.
3032
- *
3033
- * Default: `OLDEST`
3034
- */
3035
- order?: OrderWithLiterals;
3036
- /** Number of months to include in response. */
3037
- months?: number;
3038
- /**
3039
- * Language filter.
3040
- *
3041
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3042
- * Pass a language to only receive the period post count for that specified language.
3043
- * @format LANGUAGE_TAG
3044
- */
3045
- language?: string | null;
3046
- /**
3047
- * Time zone to use when calculating the start of the month.
3048
- *
3049
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3050
- * @minLength 3
3051
- * @maxLength 100
3052
- */
3053
- timeZone?: string | null;
3054
- }
3055
- declare enum Order {
3056
- UNKNOWN = "UNKNOWN",
3057
- OLDEST = "OLDEST",
3058
- NEWEST = "NEWEST"
3059
- }
3060
- /** @enumType */
3061
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3062
- /** Get Blog Post Count Stats response */
3063
- interface QueryPostCountStatsResponse {
3064
- /** List of published post counts by month. */
3065
- stats?: PeriodPostCount[];
3066
- }
3067
- /** Post count for a specific time period */
3068
- interface PeriodPostCount {
3069
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3070
- periodStart?: Date | null;
3071
- /** Number of posts published during this month. */
3072
- postCount?: number;
3073
- }
3074
- interface GetTotalPublicationsRequest {
3075
- /**
3076
- * Language filter
3077
- * @minLength 2
3078
- * @format LANGUAGE_TAG
3079
- */
3080
- language?: string | null;
3081
- }
3082
- interface GetTotalPublicationsResponse {
3083
- /** Total amount of publications. */
3084
- total?: number;
3085
- }
3086
- interface GetTotalPostsRequest {
3087
- /**
3088
- * Language filter.
3089
- *
3090
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3091
- * Pass a language to receive the total amount of posts in that specified language.
3092
- * @format LANGUAGE_TAG
3093
- */
3094
- language?: string | null;
3095
- }
3096
- interface GetTotalPostsResponse {
3097
- /** Total amount of published posts. */
3098
- total?: number;
3099
- }
3100
3289
  interface GetTotalLikesPerMemberRequest {
3101
3290
  /**
3102
3291
  * Member ID.
@@ -4386,7 +4575,7 @@ type PostQuery = {
4386
4575
  };
4387
4576
  declare const utils: {
4388
4577
  query: {
4389
- /** @enumType */
4578
+ /** Data for a spoiler decoration. */
4390
4579
  QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
4391
4580
  Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
4392
4581
  Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
@@ -4405,4 +4594,4 @@ declare const utils: {
4405
4594
  */
4406
4595
  declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
4407
4596
 
4408
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, 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 GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, type ImagePositionWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, 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, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, 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 PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, 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, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };
4597
+ export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Backdrop, BackdropType, type BackdropTypeWithLiterals, type Background, type BackgroundGradient, type BackgroundImage, BackgroundType, type BackgroundTypeWithLiterals, type Banner, BannerOrigin, type BannerOriginWithLiterals, type BaseEventMetadata, type BlockquoteData, type BlogPaging, type BookingData, type Border, type BorderColors, type BorderWidths, type BulkDeletePostsRequest, type BulkDeletePostsResponse, type BulkGetPostReactionsRequest, type BulkGetPostReactionsResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CaptionData, type CardData, type CardDataBackground, CardDataBackgroundType, type CardDataBackgroundTypeWithLiterals, type CardStyles, type Category, type CategoryTranslation, type CellStyle, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonQueryWithEntityContext, type ConvertDraftJsToRichContentRequest, type ConvertDraftJsToRichContentResponse, type ConvertRichContentToDraftJsRequest, type ConvertRichContentToDraftJsResponse, type CreateDraftPostFromTemplateRequest, type CreateDraftPostFromTemplateResponse, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeletePostRequest, type DeletePostResponse, type Design, DesignTarget, type DesignTargetWithLiterals, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type DraftPost, type DraftPostTranslation, 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 GetPostBySlugOptions, type GetPostBySlugRequest, type GetPostBySlugResponse, type GetPostCountPerMonthRequest, type GetPostCountPerMonthResponse, type GetPostCountsRequest, type GetPostCountsResponse, type GetPostMetricsRequest, type GetPostMetricsResponse, type GetPostOptions, type GetPostRequest, type GetPostResponse, GetPostTemplatesSort, type GetPostTemplatesSortWithLiterals, GetPostsSort, type GetPostsSortWithLiterals, type GetTemplateRequest, type GetTemplateResponse, type GetTotalLikesPerMemberRequest, type GetTotalLikesPerMemberResponse, type GetTotalPostsOptions, type GetTotalPostsRequest, type GetTotalPostsResponse, type GetTotalPublicationsRequest, type GetTotalPublicationsResponse, type Gradient, GradientType, type GradientTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, ImagePosition, ImagePositionPosition, type ImagePositionPositionWithLiterals, type ImagePositionWithLiterals, ImageScalingScaling, type ImageScalingScalingWithLiterals, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, type InitialPostsCopied, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, Layout, type LayoutCellData, type LayoutData, type LayoutDataBackground, type LayoutDataBackgroundImage, LayoutDataBackgroundType, type LayoutDataBackgroundTypeWithLiterals, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, type LikePostRequest, type LikePostResponse, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListDemoPostsRequest, type ListDemoPostsResponse, type ListPostsArchiveRequest, type ListPostsArchiveResponse, type ListPostsOptions, type ListPostsRequest, type ListPostsResponse, type ListTemplatesRequest, type ListTemplatesResponse, type ListValue, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MediaMediaOneOf, type MentionData, type MessageEnvelope, type MetaData, type Metadata, type Metrics, 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, Order, type OrderWithLiterals, type OrderedListData, Orientation, type OrientationWithLiterals, Origin, type OriginWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type PeriodPostCount, type PeriodPublicationsCount, type Permissions, type PinPostRequest, type PinPostResponse, 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 Post, type PostCategoriesUpdated, type PostCount, type PostCountInfo, type PostCountPerMonth, type PostCountersUpdated, type PostCountersUpdatedInitiatorOneOf, type PostCreatedEnvelope, type PostDeletedEnvelope, PostFieldField, type PostFieldFieldWithLiterals, type PostLiked, type PostLikedEnvelope, type PostLikedInitiatorOneOf, type PostOwnerChanged, type PostQuery, type PostQuerySpec, type PostTagsUpdated, type PostTranslation, type PostUnliked, type PostUnlikedEnvelope, type PostUnlikedInitiatorOneOf, type PostUpdatedEnvelope, type PostsQueryBuilder, type PostsQueryResult, type PricingData, type QueryPostCountStatsOptions, type QueryPostCountStatsRequest, type QueryPostCountStatsResponse, type QueryPostsOptions, type QueryPostsRequest, type QueryPostsResponse, type QueryPublicationsCountStatsRequest, QueryPublicationsCountStatsRequestOrder, type QueryPublicationsCountStatsRequestOrderWithLiterals, type QueryPublicationsCountStatsResponse, type Reactions, type Rel, Resizing, type ResizingWithLiterals, ResponsivenessBehaviour, type ResponsivenessBehaviourWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, Scaling, type ScalingWithLiterals, type ScheduledPostPublished, type SeoSchema, type Settings, type ShapeData, type ShapeDataStyles, 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, type TypeWithLiterals, type UnlikePostRequest, type UnlikePostResponse, type UnpinPostRequest, type UnpinPostResponse, type V1Media, VerticalAlignment, VerticalAlignmentAlignment, type VerticalAlignmentAlignmentWithLiterals, type VerticalAlignmentWithLiterals, type Video, type VideoData, type VideoResolution, ViewMode, type ViewModeWithLiterals, type ViewPostRequest, type ViewPostResponse, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, type WixMedia, getPost, getPostBySlug, getPostMetrics, getTotalPosts, listPosts, onPostCreated, onPostDeleted, onPostLiked, onPostUnliked, onPostUpdated, queryPostCountStats, queryPosts, typedQueryPosts, utils };