@wix/auto_sdk_blog_posts 1.0.139 → 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 -39
  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 -36
  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 -36
  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 -39
  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 -36
  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 -36
  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 -39
  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 -36
  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 -36
  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 -39
  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 -36
  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 -36
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -316,6 +316,8 @@ interface Node extends NodeDataOneOf {
316
316
  layoutCellData?: LayoutCellData;
317
317
  /** Data for a shape node. */
318
318
  shapeData?: ShapeData;
319
+ /** Data for a card node. */
320
+ cardData?: CardData;
319
321
  /** 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. */
320
322
  type?: NodeTypeWithLiterals;
321
323
  /** Node ID. */
@@ -385,6 +387,8 @@ interface NodeDataOneOf {
385
387
  layoutCellData?: LayoutCellData;
386
388
  /** Data for a shape node. */
387
389
  shapeData?: ShapeData;
390
+ /** Data for a card node. */
391
+ cardData?: CardData;
388
392
  }
389
393
  declare enum NodeType {
390
394
  PARAGRAPH = "PARAGRAPH",
@@ -421,10 +425,11 @@ declare enum NodeType {
421
425
  CAPTION = "CAPTION",
422
426
  LAYOUT = "LAYOUT",
423
427
  LAYOUT_CELL = "LAYOUT_CELL",
424
- SHAPE = "SHAPE"
428
+ SHAPE = "SHAPE",
429
+ CARD = "CARD"
425
430
  }
426
431
  /** @enumType */
427
- 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';
432
+ 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';
428
433
  interface NodeStyle {
429
434
  /** The top padding value in pixels. */
430
435
  paddingTop?: string | null;
@@ -445,6 +450,55 @@ interface ButtonData {
445
450
  /** Button link details. */
446
451
  link?: Link;
447
452
  }
453
+ /** Background type */
454
+ declare enum BackgroundType {
455
+ /** Solid color background */
456
+ COLOR = "COLOR",
457
+ /** Gradient background */
458
+ GRADIENT = "GRADIENT"
459
+ }
460
+ /** @enumType */
461
+ type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'GRADIENT';
462
+ interface Gradient {
463
+ /** Gradient type. */
464
+ type?: GradientTypeWithLiterals;
465
+ /**
466
+ * Color stops for the gradient.
467
+ * @maxSize 1000
468
+ */
469
+ stops?: Stop[];
470
+ /** Angle in degrees for linear gradient (0-360). */
471
+ angle?: number | null;
472
+ /**
473
+ * Horizontal center position for radial gradient (0-100).
474
+ * @max 100
475
+ */
476
+ centerX?: number | null;
477
+ /**
478
+ * Vertical center position for radial gradient (0-100).
479
+ * @max 100
480
+ */
481
+ centerY?: number | null;
482
+ }
483
+ /** Gradient type. */
484
+ declare enum GradientType {
485
+ /** Linear gradient. */
486
+ LINEAR = "LINEAR",
487
+ /** Radial gradient. */
488
+ RADIAL = "RADIAL"
489
+ }
490
+ /** @enumType */
491
+ type GradientTypeWithLiterals = GradientType | 'LINEAR' | 'RADIAL';
492
+ /** A single color stop in the gradient. */
493
+ interface Stop {
494
+ /**
495
+ * Stop color as hex value.
496
+ * @format COLOR_HEX
497
+ */
498
+ color?: string | null;
499
+ /** Stop position (0-1). */
500
+ position?: number | null;
501
+ }
448
502
  interface Border {
449
503
  /**
450
504
  * Deprecated: Use `borderWidth` in `styles` instead.
@@ -474,6 +528,18 @@ interface Colors {
474
528
  */
475
529
  background?: string | null;
476
530
  }
531
+ /** Background styling (color or gradient) */
532
+ interface Background {
533
+ /** Background type. */
534
+ type?: BackgroundTypeWithLiterals;
535
+ /**
536
+ * Background color as a hexadecimal value.
537
+ * @format COLOR_HEX
538
+ */
539
+ color?: string | null;
540
+ /** Gradient configuration. */
541
+ gradient?: Gradient;
542
+ }
477
543
  interface PluginContainerData {
478
544
  /** The width of the node when it's displayed. */
479
545
  width?: PluginContainerDataWidth;
@@ -594,17 +660,23 @@ interface Styles {
594
660
  */
595
661
  textColorHover?: string | null;
596
662
  /**
597
- * Background color as a hexadecimal value.
663
+ * Deprecated: Use `background` instead.
598
664
  * @format COLOR_HEX
665
+ * @deprecated
599
666
  */
600
667
  backgroundColor?: string | null;
601
668
  /**
602
- * Background color as a hexadecimal value (hover state).
669
+ * Deprecated: Use `backgroundHover` instead.
603
670
  * @format COLOR_HEX
671
+ * @deprecated
604
672
  */
605
673
  backgroundColorHover?: string | null;
606
674
  /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
607
675
  buttonSize?: string | null;
676
+ /** Background styling (color or gradient). */
677
+ background?: Background;
678
+ /** Background styling for hover state (color or gradient). */
679
+ backgroundHover?: Background;
608
680
  }
609
681
  interface Link extends LinkDataOneOf {
610
682
  /** The absolute URL for the linked document. */
@@ -1241,7 +1313,7 @@ interface OptionLayout {
1241
1313
  /** Sets whether to display option images. Defaults to `false`. */
1242
1314
  enableImage?: boolean | null;
1243
1315
  }
1244
- declare enum BackgroundType {
1316
+ declare enum PollDesignBackgroundType {
1245
1317
  /** Color background type */
1246
1318
  COLOR = "COLOR",
1247
1319
  /** Image background type */
@@ -1250,8 +1322,8 @@ declare enum BackgroundType {
1250
1322
  GRADIENT = "GRADIENT"
1251
1323
  }
1252
1324
  /** @enumType */
1253
- type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1254
- interface Gradient {
1325
+ type PollDesignBackgroundTypeWithLiterals = PollDesignBackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
1326
+ interface BackgroundGradient {
1255
1327
  /** The gradient angle in degrees. */
1256
1328
  angle?: number | null;
1257
1329
  /**
@@ -1265,7 +1337,7 @@ interface Gradient {
1265
1337
  */
1266
1338
  lastColor?: string | null;
1267
1339
  }
1268
- interface Background extends BackgroundBackgroundOneOf {
1340
+ interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
1269
1341
  /**
1270
1342
  * The background color as a hexademical value.
1271
1343
  * @format COLOR_HEX
@@ -1274,12 +1346,12 @@ interface Background extends BackgroundBackgroundOneOf {
1274
1346
  /** An image to use for the background. */
1275
1347
  image?: V1Media;
1276
1348
  /** Details for a gradient background. */
1277
- gradient?: Gradient;
1349
+ gradient?: BackgroundGradient;
1278
1350
  /** Background type. For each option, include the relevant details. */
1279
- type?: BackgroundTypeWithLiterals;
1351
+ type?: PollDesignBackgroundTypeWithLiterals;
1280
1352
  }
1281
1353
  /** @oneof */
1282
- interface BackgroundBackgroundOneOf {
1354
+ interface PollDesignBackgroundBackgroundOneOf {
1283
1355
  /**
1284
1356
  * The background color as a hexademical value.
1285
1357
  * @format COLOR_HEX
@@ -1288,11 +1360,11 @@ interface BackgroundBackgroundOneOf {
1288
1360
  /** An image to use for the background. */
1289
1361
  image?: V1Media;
1290
1362
  /** Details for a gradient background. */
1291
- gradient?: Gradient;
1363
+ gradient?: BackgroundGradient;
1292
1364
  }
1293
1365
  interface PollDesign {
1294
1366
  /** Background styling. */
1295
- background?: Background;
1367
+ background?: PollDesignBackground;
1296
1368
  /** Border radius in pixels. */
1297
1369
  borderRadius?: number | null;
1298
1370
  }
@@ -1975,12 +2047,13 @@ interface CaptionData {
1975
2047
  }
1976
2048
  interface LayoutData {
1977
2049
  /**
1978
- * Background color as a hexadecimal value.
2050
+ * Deprecated: Use `background` instead.
1979
2051
  * @format COLOR_HEX
2052
+ * @deprecated
1980
2053
  */
1981
2054
  backgroundColor?: string | null;
1982
2055
  /** Background image. */
1983
- backgroundImage?: BackgroundImage;
2056
+ backgroundImage?: LayoutDataBackgroundImage;
1984
2057
  /**
1985
2058
  * Border color as a hexadecimal value.
1986
2059
  * @format COLOR_HEX
@@ -1988,15 +2061,16 @@ interface LayoutData {
1988
2061
  borderColor?: string | null;
1989
2062
  /** Border width in pixels. */
1990
2063
  borderWidth?: number | null;
1991
- /** Border */
2064
+ /** Border radius in pixels. */
1992
2065
  borderRadius?: number | null;
1993
2066
  /**
1994
- * Backdrop color as a hexadecimal value.
2067
+ * Deprecated: Use `backdrop` instead.
1995
2068
  * @format COLOR_HEX
2069
+ * @deprecated
1996
2070
  */
1997
2071
  backdropColor?: string | null;
1998
- /** Backdrop image.radius in pixels. */
1999
- backdropImage?: BackgroundImage;
2072
+ /** Backdrop image. */
2073
+ backdropImage?: LayoutDataBackgroundImage;
2000
2074
  /** Backdrop top padding. */
2001
2075
  backdropPaddingTop?: number | null;
2002
2076
  /** Backdrop bottom padding */
@@ -2020,8 +2094,12 @@ interface LayoutData {
2020
2094
  designTarget?: DesignTargetWithLiterals;
2021
2095
  /** Banner configuration. When present, this layout is displayed as a banner. */
2022
2096
  banner?: Banner;
2097
+ /** Background styling (color or gradient). */
2098
+ background?: LayoutDataBackground;
2099
+ /** Backdrop styling (color or gradient). */
2100
+ backdrop?: Backdrop;
2023
2101
  }
2024
- declare enum Scaling {
2102
+ declare enum ImageScalingScaling {
2025
2103
  /** Auto image scaling */
2026
2104
  AUTO = "AUTO",
2027
2105
  /** Contain image scaling */
@@ -2030,7 +2108,7 @@ declare enum Scaling {
2030
2108
  COVER = "COVER"
2031
2109
  }
2032
2110
  /** @enumType */
2033
- type ScalingWithLiterals = Scaling | 'AUTO' | 'CONTAIN' | 'COVER';
2111
+ type ImageScalingScalingWithLiterals = ImageScalingScaling | 'AUTO' | 'CONTAIN' | 'COVER';
2034
2112
  declare enum ImagePosition {
2035
2113
  /** Image positioned at the center */
2036
2114
  CENTER = "CENTER",
@@ -2061,13 +2139,31 @@ declare enum BannerOrigin {
2061
2139
  }
2062
2140
  /** @enumType */
2063
2141
  type BannerOriginWithLiterals = BannerOrigin | 'IMAGE' | 'LAYOUT';
2064
- interface BackgroundImage {
2142
+ /** Background type */
2143
+ declare enum LayoutDataBackgroundType {
2144
+ /** Solid color background */
2145
+ COLOR = "COLOR",
2146
+ /** Gradient background */
2147
+ GRADIENT = "GRADIENT"
2148
+ }
2149
+ /** @enumType */
2150
+ type LayoutDataBackgroundTypeWithLiterals = LayoutDataBackgroundType | 'COLOR' | 'GRADIENT';
2151
+ /** Backdrop type */
2152
+ declare enum BackdropType {
2153
+ /** Solid color backdrop */
2154
+ COLOR = "COLOR",
2155
+ /** Gradient backdrop */
2156
+ GRADIENT = "GRADIENT"
2157
+ }
2158
+ /** @enumType */
2159
+ type BackdropTypeWithLiterals = BackdropType | 'COLOR' | 'GRADIENT';
2160
+ interface LayoutDataBackgroundImage {
2065
2161
  /** Background image. */
2066
2162
  media?: V1Media;
2067
2163
  /** Background image opacity. */
2068
2164
  opacity?: number | null;
2069
2165
  /** Background image scaling. */
2070
- scaling?: ScalingWithLiterals;
2166
+ scaling?: ImageScalingScalingWithLiterals;
2071
2167
  /** Position of background. Defaults to `CENTER`. */
2072
2168
  position?: ImagePositionWithLiterals;
2073
2169
  }
@@ -2101,6 +2197,30 @@ interface Banner {
2101
2197
  /** Origin of the banner */
2102
2198
  origin?: BannerOriginWithLiterals;
2103
2199
  }
2200
+ /** Background styling (color or gradient) */
2201
+ interface LayoutDataBackground {
2202
+ /** Background type. */
2203
+ type?: LayoutDataBackgroundTypeWithLiterals;
2204
+ /**
2205
+ * Background color as a hexadecimal value.
2206
+ * @format COLOR_HEX
2207
+ */
2208
+ color?: string | null;
2209
+ /** Gradient configuration. */
2210
+ gradient?: Gradient;
2211
+ }
2212
+ /** Backdrop styling (color or gradient) */
2213
+ interface Backdrop {
2214
+ /** Backdrop type. */
2215
+ type?: BackdropTypeWithLiterals;
2216
+ /**
2217
+ * Backdrop color as a hexadecimal value.
2218
+ * @format COLOR_HEX
2219
+ */
2220
+ color?: string | null;
2221
+ /** Gradient configuration. */
2222
+ gradient?: Gradient;
2223
+ }
2104
2224
  interface LayoutCellData {
2105
2225
  /** Size of the cell in 12 columns grid. */
2106
2226
  colSpan?: number | null;
@@ -2122,6 +2242,75 @@ interface ShapeDataStyles {
2122
2242
  /** Map of original color keys to their new color values. */
2123
2243
  colors?: Record<string, string>;
2124
2244
  }
2245
+ interface CardData {
2246
+ /** Background styling (color or gradient). */
2247
+ background?: CardDataBackground;
2248
+ /** Background image. */
2249
+ backgroundImage?: BackgroundImage;
2250
+ }
2251
+ declare enum Scaling {
2252
+ /** Auto image scaling */
2253
+ AUTO = "AUTO",
2254
+ /** Contain image scaling */
2255
+ CONTAIN = "CONTAIN",
2256
+ /** Cover image scaling */
2257
+ COVER = "COVER"
2258
+ }
2259
+ /** @enumType */
2260
+ type ScalingWithLiterals = Scaling | 'AUTO' | 'CONTAIN' | 'COVER';
2261
+ declare enum ImagePositionPosition {
2262
+ /** Image positioned at the center */
2263
+ CENTER = "CENTER",
2264
+ /** Image positioned on the left */
2265
+ CENTER_LEFT = "CENTER_LEFT",
2266
+ /** Image positioned on the right */
2267
+ CENTER_RIGHT = "CENTER_RIGHT",
2268
+ /** Image positioned at the center top */
2269
+ TOP = "TOP",
2270
+ /** Image positioned at the top left */
2271
+ TOP_LEFT = "TOP_LEFT",
2272
+ /** Image positioned at the top right */
2273
+ TOP_RIGHT = "TOP_RIGHT",
2274
+ /** Image positioned at the center bottom */
2275
+ BOTTOM = "BOTTOM",
2276
+ /** Image positioned at the bottom left */
2277
+ BOTTOM_LEFT = "BOTTOM_LEFT",
2278
+ /** Image positioned at the bottom right */
2279
+ BOTTOM_RIGHT = "BOTTOM_RIGHT"
2280
+ }
2281
+ /** @enumType */
2282
+ type ImagePositionPositionWithLiterals = ImagePositionPosition | 'CENTER' | 'CENTER_LEFT' | 'CENTER_RIGHT' | 'TOP' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT';
2283
+ /** Background type */
2284
+ declare enum CardDataBackgroundType {
2285
+ /** Solid color background */
2286
+ COLOR = "COLOR",
2287
+ /** Gradient background */
2288
+ GRADIENT = "GRADIENT"
2289
+ }
2290
+ /** @enumType */
2291
+ type CardDataBackgroundTypeWithLiterals = CardDataBackgroundType | 'COLOR' | 'GRADIENT';
2292
+ /** Background styling (color or gradient) */
2293
+ interface CardDataBackground {
2294
+ /** Background type. */
2295
+ type?: CardDataBackgroundTypeWithLiterals;
2296
+ /**
2297
+ * Background color as a hexadecimal value.
2298
+ * @format COLOR_HEX
2299
+ */
2300
+ color?: string | null;
2301
+ /** Gradient configuration. */
2302
+ gradient?: Gradient;
2303
+ }
2304
+ interface BackgroundImage {
2305
+ /** Background image. */
2306
+ media?: V1Media;
2307
+ /** Background image opacity. */
2308
+ opacity?: number | null;
2309
+ /** Background image scaling. */
2310
+ scaling?: ScalingWithLiterals;
2311
+ /** Position of background. Defaults to `CENTER`. */
2312
+ position?: ImagePositionPositionWithLiterals;
2313
+ }
2125
2314
  interface Metadata {
2126
2315
  /** Schema version. */
2127
2316
  version?: number;
@@ -2389,78 +2578,351 @@ interface PostUnlikedInitiatorOneOf {
2389
2578
  */
2390
2579
  anonymousVisitorId?: string | null;
2391
2580
  }
2392
- interface ListTemplatesRequest {
2393
- /**
2394
- * Filter post templates by given template category ids
2395
- * @maxSize 50
2396
- * @format GUID
2397
- */
2398
- categoryIds?: string[];
2581
+ /** Get Blog Publications Count Stats request */
2582
+ interface QueryPublicationsCountStatsRequest {
2583
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2584
+ rangeStart?: Date | null;
2585
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2586
+ rangeEnd?: Date | null;
2587
+ /** Order of the returned results. */
2588
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2589
+ /** Number of months to include in the response. */
2590
+ months?: number;
2399
2591
  /**
2400
- * Filter post templates by provided language
2592
+ * Language filter
2593
+ *
2594
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2401
2595
  * @format LANGUAGE_TAG
2402
2596
  */
2403
2597
  language?: string | null;
2404
- /** Returns post template categories when set to TRUE */
2405
- listTemplateCategories?: boolean;
2406
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2407
- sort?: GetPostTemplatesSortWithLiterals;
2408
- /** Pagination options. */
2409
- paging?: BlogPaging;
2598
+ /**
2599
+ * Timezone of the client.
2600
+ * @minLength 3
2601
+ * @maxLength 100
2602
+ */
2603
+ timeZone?: string | null;
2410
2604
  }
2411
- declare enum GetPostTemplatesSort {
2412
- /** Sort by ascending publishing date. */
2413
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2414
- /** Sort by descending publishing date. */
2415
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2605
+ declare enum QueryPublicationsCountStatsRequestOrder {
2606
+ UNKNOWN = "UNKNOWN",
2607
+ OLDEST = "OLDEST",
2608
+ NEWEST = "NEWEST"
2416
2609
  }
2417
2610
  /** @enumType */
2418
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2419
- interface BlogPaging {
2611
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2612
+ /** Get Blog Publications Count Stats response */
2613
+ interface QueryPublicationsCountStatsResponse {
2614
+ /** Chronologically ordered list of publications. */
2615
+ stats?: PeriodPublicationsCount[];
2616
+ }
2617
+ /** Publications count for a specific time period */
2618
+ interface PeriodPublicationsCount {
2619
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2620
+ periodStart?: Date | null;
2621
+ /** Number of posts published during this month. */
2622
+ publicationsCount?: number;
2623
+ }
2624
+ /** Get Blog Post Count Stats request */
2625
+ interface QueryPostCountStatsRequest {
2626
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2627
+ rangeStart?: Date | null;
2420
2628
  /**
2421
- * Number of items to skip in the current sort order.
2629
+ * Order of returned results.
2422
2630
  *
2631
+ * - `OLDEST`: posts by date in ascending order.
2632
+ * - `NEWEST`: posts by date in descending order.
2423
2633
  *
2424
- * Default: `0`
2634
+ * Default: `OLDEST`
2425
2635
  */
2426
- offset?: number;
2636
+ order?: OrderWithLiterals;
2637
+ /** Number of months to include in response. */
2638
+ months?: number;
2427
2639
  /**
2428
- * Number of items to return.
2429
- *
2640
+ * Language filter.
2430
2641
  *
2431
- * Default:`50`
2432
- * @min 1
2433
- * @max 100
2642
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2643
+ * Pass a language to only receive the period post count for that specified language.
2644
+ * @format LANGUAGE_TAG
2434
2645
  */
2435
- limit?: number;
2646
+ language?: string | null;
2436
2647
  /**
2437
- * Pointer to the next or previous page in the list of results.
2438
- * @maxLength 2000
2648
+ * Time zone to use when calculating the start of the month.
2649
+ *
2650
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2651
+ * @minLength 3
2652
+ * @maxLength 100
2439
2653
  */
2440
- cursor?: string | null;
2654
+ timeZone?: string | null;
2441
2655
  }
2442
- interface ListTemplatesResponse {
2443
- /** Available post templates */
2444
- postTemplates?: Post[];
2445
- /** Details on the paged set of posts templates returned. */
2446
- postTemplatesMetaData?: MetaData;
2447
- /** Post template categories. This value is returned empty unless asked explicitly */
2448
- templateCategories?: Category[];
2656
+ declare enum Order {
2657
+ UNKNOWN = "UNKNOWN",
2658
+ OLDEST = "OLDEST",
2659
+ NEWEST = "NEWEST"
2449
2660
  }
2450
- interface MetaData {
2451
- /** Number of items returned in this response. */
2452
- count?: number;
2453
- /** Requested offset. */
2454
- offset?: number;
2455
- /** Total number of items that match the query. */
2456
- total?: number;
2457
- /**
2458
- * Pointer to the next or previous page in the list of results.
2459
- * @maxLength 2000
2460
- */
2461
- cursor?: string | null;
2661
+ /** @enumType */
2662
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2663
+ /** Get Blog Post Count Stats response */
2664
+ interface QueryPostCountStatsResponse {
2665
+ /** List of published post counts by month. */
2666
+ stats?: PeriodPostCount[];
2462
2667
  }
2463
- interface Category {
2668
+ /** Post count for a specific time period */
2669
+ interface PeriodPostCount {
2670
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2671
+ periodStart?: Date | null;
2672
+ /** Number of posts published during this month. */
2673
+ postCount?: number;
2674
+ }
2675
+ interface GetTotalPublicationsRequest {
2676
+ /**
2677
+ * Language filter
2678
+ * @minLength 2
2679
+ * @format LANGUAGE_TAG
2680
+ */
2681
+ language?: string | null;
2682
+ }
2683
+ interface GetTotalPublicationsResponse {
2684
+ /** Total amount of publications. */
2685
+ total?: number;
2686
+ }
2687
+ interface GetTotalPostsRequest {
2688
+ /**
2689
+ * Language filter.
2690
+ *
2691
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2692
+ * Pass a language to receive the total amount of posts in that specified language.
2693
+ * @format LANGUAGE_TAG
2694
+ */
2695
+ language?: string | null;
2696
+ }
2697
+ interface GetTotalPostsResponse {
2698
+ /** Total amount of published posts. */
2699
+ total?: number;
2700
+ }
2701
+ interface DomainEvent extends DomainEventBodyOneOf {
2702
+ createdEvent?: EntityCreatedEvent;
2703
+ updatedEvent?: EntityUpdatedEvent;
2704
+ deletedEvent?: EntityDeletedEvent;
2705
+ actionEvent?: ActionEvent;
2706
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2707
+ _id?: string;
2708
+ /**
2709
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2710
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2711
+ */
2712
+ entityFqdn?: string;
2713
+ /**
2714
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2715
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2716
+ */
2717
+ slug?: string;
2718
+ /** ID of the entity associated with the event. */
2719
+ entityId?: string;
2720
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2721
+ eventTime?: Date | null;
2722
+ /**
2723
+ * Whether the event was triggered as a result of a privacy regulation application
2724
+ * (for example, GDPR).
2725
+ */
2726
+ triggeredByAnonymizeRequest?: boolean | null;
2727
+ /** If present, indicates the action that triggered the event. */
2728
+ originatedFrom?: string | null;
2729
+ /**
2730
+ * 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.
2731
+ * 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.
2732
+ */
2733
+ entityEventSequence?: string | null;
2734
+ }
2735
+ /** @oneof */
2736
+ interface DomainEventBodyOneOf {
2737
+ createdEvent?: EntityCreatedEvent;
2738
+ updatedEvent?: EntityUpdatedEvent;
2739
+ deletedEvent?: EntityDeletedEvent;
2740
+ actionEvent?: ActionEvent;
2741
+ }
2742
+ interface EntityCreatedEvent {
2743
+ entity?: string;
2744
+ }
2745
+ interface RestoreInfo {
2746
+ deletedDate?: Date | null;
2747
+ }
2748
+ interface EntityUpdatedEvent {
2749
+ /**
2750
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2751
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2752
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2753
+ */
2754
+ currentEntity?: string;
2755
+ }
2756
+ interface EntityDeletedEvent {
2757
+ /** Entity that was deleted. */
2758
+ deletedEntity?: string | null;
2759
+ }
2760
+ interface ActionEvent {
2761
+ body?: string;
2762
+ }
2763
+ interface MessageEnvelope {
2764
+ /**
2765
+ * App instance ID.
2766
+ * @format GUID
2767
+ */
2768
+ instanceId?: string | null;
2769
+ /**
2770
+ * Event type.
2771
+ * @maxLength 150
2772
+ */
2773
+ eventType?: string;
2774
+ /** The identification type and identity data. */
2775
+ identity?: IdentificationData;
2776
+ /** Stringify payload. */
2777
+ data?: string;
2778
+ /** Details related to the account */
2779
+ accountInfo?: AccountInfo;
2780
+ }
2781
+ interface IdentificationData extends IdentificationDataIdOneOf {
2782
+ /**
2783
+ * ID of a site visitor that has not logged in to the site.
2784
+ * @format GUID
2785
+ */
2786
+ anonymousVisitorId?: string;
2787
+ /**
2788
+ * ID of a site visitor that has logged in to the site.
2789
+ * @format GUID
2790
+ */
2791
+ memberId?: string;
2792
+ /**
2793
+ * ID of a Wix user (site owner, contributor, etc.).
2794
+ * @format GUID
2795
+ */
2796
+ wixUserId?: string;
2797
+ /**
2798
+ * ID of an app.
2799
+ * @format GUID
2800
+ */
2801
+ appId?: string;
2802
+ /** @readonly */
2803
+ identityType?: WebhookIdentityTypeWithLiterals;
2804
+ }
2805
+ /** @oneof */
2806
+ interface IdentificationDataIdOneOf {
2807
+ /**
2808
+ * ID of a site visitor that has not logged in to the site.
2809
+ * @format GUID
2810
+ */
2811
+ anonymousVisitorId?: string;
2812
+ /**
2813
+ * ID of a site visitor that has logged in to the site.
2814
+ * @format GUID
2815
+ */
2816
+ memberId?: string;
2817
+ /**
2818
+ * ID of a Wix user (site owner, contributor, etc.).
2819
+ * @format GUID
2820
+ */
2821
+ wixUserId?: string;
2822
+ /**
2823
+ * ID of an app.
2824
+ * @format GUID
2825
+ */
2826
+ appId?: string;
2827
+ }
2828
+ declare enum WebhookIdentityType {
2829
+ UNKNOWN = "UNKNOWN",
2830
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2831
+ MEMBER = "MEMBER",
2832
+ WIX_USER = "WIX_USER",
2833
+ APP = "APP"
2834
+ }
2835
+ /** @enumType */
2836
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2837
+ interface AccountInfo {
2838
+ /**
2839
+ * ID of the Wix account associated with the event.
2840
+ * @format GUID
2841
+ */
2842
+ accountId?: string | null;
2843
+ /**
2844
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
2845
+ * @format GUID
2846
+ */
2847
+ parentAccountId?: string | null;
2848
+ /**
2849
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2850
+ * @format GUID
2851
+ */
2852
+ siteId?: string | null;
2853
+ }
2854
+ interface ListTemplatesRequest {
2855
+ /**
2856
+ * Filter post templates by given template category ids
2857
+ * @maxSize 50
2858
+ * @format GUID
2859
+ */
2860
+ categoryIds?: string[];
2861
+ /**
2862
+ * Filter post templates by provided language
2863
+ * @format LANGUAGE_TAG
2864
+ */
2865
+ language?: string | null;
2866
+ /** Returns post template categories when set to TRUE */
2867
+ listTemplateCategories?: boolean;
2868
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2869
+ sort?: GetPostTemplatesSortWithLiterals;
2870
+ /** Pagination options. */
2871
+ paging?: BlogPaging;
2872
+ }
2873
+ declare enum GetPostTemplatesSort {
2874
+ /** Sort by ascending publishing date. */
2875
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2876
+ /** Sort by descending publishing date. */
2877
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2878
+ }
2879
+ /** @enumType */
2880
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2881
+ interface BlogPaging {
2882
+ /**
2883
+ * Number of items to skip in the current sort order.
2884
+ *
2885
+ *
2886
+ * Default: `0`
2887
+ */
2888
+ offset?: number;
2889
+ /**
2890
+ * Number of items to return.
2891
+ *
2892
+ *
2893
+ * Default:`50`
2894
+ * @min 1
2895
+ * @max 100
2896
+ */
2897
+ limit?: number;
2898
+ /**
2899
+ * Pointer to the next or previous page in the list of results.
2900
+ * @maxLength 2000
2901
+ */
2902
+ cursor?: string | null;
2903
+ }
2904
+ interface ListTemplatesResponse {
2905
+ /** Available post templates */
2906
+ postTemplates?: Post[];
2907
+ /** Details on the paged set of posts templates returned. */
2908
+ postTemplatesMetaData?: MetaData;
2909
+ /** Post template categories. This value is returned empty unless asked explicitly */
2910
+ templateCategories?: Category[];
2911
+ }
2912
+ interface MetaData {
2913
+ /** Number of items returned in this response. */
2914
+ count?: number;
2915
+ /** Requested offset. */
2916
+ offset?: number;
2917
+ /** Total number of items that match the query. */
2918
+ total?: number;
2919
+ /**
2920
+ * Pointer to the next or previous page in the list of results.
2921
+ * @maxLength 2000
2922
+ */
2923
+ cursor?: string | null;
2924
+ }
2925
+ interface Category {
2464
2926
  /**
2465
2927
  * Category ID.
2466
2928
  * @immutable
@@ -2817,279 +3279,6 @@ interface DraftPostTranslation {
2817
3279
  /** Post URL. */
2818
3280
  url?: string;
2819
3281
  }
2820
- interface DomainEvent extends DomainEventBodyOneOf {
2821
- createdEvent?: EntityCreatedEvent;
2822
- updatedEvent?: EntityUpdatedEvent;
2823
- deletedEvent?: EntityDeletedEvent;
2824
- actionEvent?: ActionEvent;
2825
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2826
- _id?: string;
2827
- /**
2828
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2829
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2830
- */
2831
- entityFqdn?: string;
2832
- /**
2833
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2834
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2835
- */
2836
- slug?: string;
2837
- /** ID of the entity associated with the event. */
2838
- entityId?: string;
2839
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2840
- eventTime?: Date | null;
2841
- /**
2842
- * Whether the event was triggered as a result of a privacy regulation application
2843
- * (for example, GDPR).
2844
- */
2845
- triggeredByAnonymizeRequest?: boolean | null;
2846
- /** If present, indicates the action that triggered the event. */
2847
- originatedFrom?: string | null;
2848
- /**
2849
- * 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.
2850
- * 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.
2851
- */
2852
- entityEventSequence?: string | null;
2853
- }
2854
- /** @oneof */
2855
- interface DomainEventBodyOneOf {
2856
- createdEvent?: EntityCreatedEvent;
2857
- updatedEvent?: EntityUpdatedEvent;
2858
- deletedEvent?: EntityDeletedEvent;
2859
- actionEvent?: ActionEvent;
2860
- }
2861
- interface EntityCreatedEvent {
2862
- entity?: string;
2863
- }
2864
- interface RestoreInfo {
2865
- deletedDate?: Date | null;
2866
- }
2867
- interface EntityUpdatedEvent {
2868
- /**
2869
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2870
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2871
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2872
- */
2873
- currentEntity?: string;
2874
- }
2875
- interface EntityDeletedEvent {
2876
- /** Entity that was deleted. */
2877
- deletedEntity?: string | null;
2878
- }
2879
- interface ActionEvent {
2880
- body?: string;
2881
- }
2882
- interface MessageEnvelope {
2883
- /**
2884
- * App instance ID.
2885
- * @format GUID
2886
- */
2887
- instanceId?: string | null;
2888
- /**
2889
- * Event type.
2890
- * @maxLength 150
2891
- */
2892
- eventType?: string;
2893
- /** The identification type and identity data. */
2894
- identity?: IdentificationData;
2895
- /** Stringify payload. */
2896
- data?: string;
2897
- /** Details related to the account */
2898
- accountInfo?: AccountInfo;
2899
- }
2900
- interface IdentificationData extends IdentificationDataIdOneOf {
2901
- /**
2902
- * ID of a site visitor that has not logged in to the site.
2903
- * @format GUID
2904
- */
2905
- anonymousVisitorId?: string;
2906
- /**
2907
- * ID of a site visitor that has logged in to the site.
2908
- * @format GUID
2909
- */
2910
- memberId?: string;
2911
- /**
2912
- * ID of a Wix user (site owner, contributor, etc.).
2913
- * @format GUID
2914
- */
2915
- wixUserId?: string;
2916
- /**
2917
- * ID of an app.
2918
- * @format GUID
2919
- */
2920
- appId?: string;
2921
- /** @readonly */
2922
- identityType?: WebhookIdentityTypeWithLiterals;
2923
- }
2924
- /** @oneof */
2925
- interface IdentificationDataIdOneOf {
2926
- /**
2927
- * ID of a site visitor that has not logged in to the site.
2928
- * @format GUID
2929
- */
2930
- anonymousVisitorId?: string;
2931
- /**
2932
- * ID of a site visitor that has logged in to the site.
2933
- * @format GUID
2934
- */
2935
- memberId?: string;
2936
- /**
2937
- * ID of a Wix user (site owner, contributor, etc.).
2938
- * @format GUID
2939
- */
2940
- wixUserId?: string;
2941
- /**
2942
- * ID of an app.
2943
- * @format GUID
2944
- */
2945
- appId?: string;
2946
- }
2947
- declare enum WebhookIdentityType {
2948
- UNKNOWN = "UNKNOWN",
2949
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2950
- MEMBER = "MEMBER",
2951
- WIX_USER = "WIX_USER",
2952
- APP = "APP"
2953
- }
2954
- /** @enumType */
2955
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2956
- interface AccountInfo {
2957
- /**
2958
- * ID of the Wix account associated with the event.
2959
- * @format GUID
2960
- */
2961
- accountId?: string | null;
2962
- /**
2963
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
2964
- * @format GUID
2965
- */
2966
- parentAccountId?: string | null;
2967
- /**
2968
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2969
- * @format GUID
2970
- */
2971
- siteId?: string | null;
2972
- }
2973
- /** Get Blog Publications Count Stats request */
2974
- interface QueryPublicationsCountStatsRequest {
2975
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2976
- rangeStart?: Date | null;
2977
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2978
- rangeEnd?: Date | null;
2979
- /** Order of the returned results. */
2980
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2981
- /** Number of months to include in the response. */
2982
- months?: number;
2983
- /**
2984
- * Language filter
2985
- *
2986
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2987
- * @format LANGUAGE_TAG
2988
- */
2989
- language?: string | null;
2990
- /**
2991
- * Timezone of the client.
2992
- * @minLength 3
2993
- * @maxLength 100
2994
- */
2995
- timeZone?: string | null;
2996
- }
2997
- declare enum QueryPublicationsCountStatsRequestOrder {
2998
- UNKNOWN = "UNKNOWN",
2999
- OLDEST = "OLDEST",
3000
- NEWEST = "NEWEST"
3001
- }
3002
- /** @enumType */
3003
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3004
- /** Get Blog Publications Count Stats response */
3005
- interface QueryPublicationsCountStatsResponse {
3006
- /** Chronologically ordered list of publications. */
3007
- stats?: PeriodPublicationsCount[];
3008
- }
3009
- /** Publications count for a specific time period */
3010
- interface PeriodPublicationsCount {
3011
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3012
- periodStart?: Date | null;
3013
- /** Number of posts published during this month. */
3014
- publicationsCount?: number;
3015
- }
3016
- /** Get Blog Post Count Stats request */
3017
- interface QueryPostCountStatsRequest {
3018
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3019
- rangeStart?: Date | null;
3020
- /**
3021
- * Order of returned results.
3022
- *
3023
- * - `OLDEST`: posts by date in ascending order.
3024
- * - `NEWEST`: posts by date in descending order.
3025
- *
3026
- * Default: `OLDEST`
3027
- */
3028
- order?: OrderWithLiterals;
3029
- /** Number of months to include in response. */
3030
- months?: number;
3031
- /**
3032
- * Language filter.
3033
- *
3034
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3035
- * Pass a language to only receive the period post count for that specified language.
3036
- * @format LANGUAGE_TAG
3037
- */
3038
- language?: string | null;
3039
- /**
3040
- * Time zone to use when calculating the start of the month.
3041
- *
3042
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3043
- * @minLength 3
3044
- * @maxLength 100
3045
- */
3046
- timeZone?: string | null;
3047
- }
3048
- declare enum Order {
3049
- UNKNOWN = "UNKNOWN",
3050
- OLDEST = "OLDEST",
3051
- NEWEST = "NEWEST"
3052
- }
3053
- /** @enumType */
3054
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3055
- /** Get Blog Post Count Stats response */
3056
- interface QueryPostCountStatsResponse {
3057
- /** List of published post counts by month. */
3058
- stats?: PeriodPostCount[];
3059
- }
3060
- /** Post count for a specific time period */
3061
- interface PeriodPostCount {
3062
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3063
- periodStart?: Date | null;
3064
- /** Number of posts published during this month. */
3065
- postCount?: number;
3066
- }
3067
- interface GetTotalPublicationsRequest {
3068
- /**
3069
- * Language filter
3070
- * @minLength 2
3071
- * @format LANGUAGE_TAG
3072
- */
3073
- language?: string | null;
3074
- }
3075
- interface GetTotalPublicationsResponse {
3076
- /** Total amount of publications. */
3077
- total?: number;
3078
- }
3079
- interface GetTotalPostsRequest {
3080
- /**
3081
- * Language filter.
3082
- *
3083
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3084
- * Pass a language to receive the total amount of posts in that specified language.
3085
- * @format LANGUAGE_TAG
3086
- */
3087
- language?: string | null;
3088
- }
3089
- interface GetTotalPostsResponse {
3090
- /** Total amount of published posts. */
3091
- total?: number;
3092
- }
3093
3282
  interface GetTotalLikesPerMemberRequest {
3094
3283
  /**
3095
3284
  * Member ID.
@@ -4379,7 +4568,7 @@ type PostQuery = {
4379
4568
  };
4380
4569
  declare const utils: {
4381
4570
  query: {
4382
- /** @enumType */
4571
+ /** Data for a spoiler decoration. */
4383
4572
  QueryBuilder: () => _wix_sdk_types.QueryBuilder<Post, PostQuerySpec, PostQuery>;
4384
4573
  Filter: _wix_sdk_types.FilterFactory<Post, PostQuerySpec>;
4385
4574
  Sort: _wix_sdk_types.SortFactory<PostQuerySpec>;
@@ -4398,4 +4587,4 @@ declare const utils: {
4398
4587
  */
4399
4588
  declare function getPostMetrics(postId: string): Promise<NonNullablePaths<GetPostMetricsResponse, `metrics.comments` | `metrics.likes` | `metrics.views`, 3>>;
4400
4589
 
4401
- 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 };
4590
+ 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 };