@wix/auto_sdk_blog_posts 1.0.149 → 1.0.151

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.js +38 -38
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +683 -668
  4. package/build/cjs/index.typings.js +38 -38
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +684 -669
  7. package/build/cjs/meta.js +38 -38
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.d.ts +2 -2
  10. package/build/es/index.mjs +38 -38
  11. package/build/es/index.mjs.map +1 -1
  12. package/build/es/index.typings.d.mts +683 -668
  13. package/build/es/index.typings.mjs +38 -38
  14. package/build/es/index.typings.mjs.map +1 -1
  15. package/build/es/meta.d.mts +684 -669
  16. package/build/es/meta.mjs +38 -38
  17. package/build/es/meta.mjs.map +1 -1
  18. package/build/es/schemas.d.mts +2 -2
  19. package/build/internal/cjs/index.js +38 -38
  20. package/build/internal/cjs/index.js.map +1 -1
  21. package/build/internal/cjs/index.typings.d.ts +683 -668
  22. package/build/internal/cjs/index.typings.js +38 -38
  23. package/build/internal/cjs/index.typings.js.map +1 -1
  24. package/build/internal/cjs/meta.d.ts +684 -669
  25. package/build/internal/cjs/meta.js +38 -38
  26. package/build/internal/cjs/meta.js.map +1 -1
  27. package/build/internal/cjs/schemas.d.ts +2 -2
  28. package/build/internal/es/index.mjs +38 -38
  29. package/build/internal/es/index.mjs.map +1 -1
  30. package/build/internal/es/index.typings.d.mts +683 -668
  31. package/build/internal/es/index.typings.mjs +38 -38
  32. package/build/internal/es/index.typings.mjs.map +1 -1
  33. package/build/internal/es/meta.d.mts +684 -669
  34. package/build/internal/es/meta.mjs +38 -38
  35. package/build/internal/es/meta.mjs.map +1 -1
  36. package/build/internal/es/schemas.d.mts +2 -2
  37. package/package.json +2 -2
@@ -515,7 +515,7 @@ type GradientTypeWithLiterals = GradientType | 'LINEAR' | 'RADIAL';
515
515
  interface Stop {
516
516
  /**
517
517
  * Stop color as hex value.
518
- * @format COLOR_HEX
518
+ * @maxLength 19
519
519
  */
520
520
  color?: string | null;
521
521
  /** Stop position (0-1). */
@@ -556,7 +556,7 @@ interface Background {
556
556
  type?: BackgroundTypeWithLiterals;
557
557
  /**
558
558
  * Background color as a hexadecimal value.
559
- * @format COLOR_HEX
559
+ * @maxLength 19
560
560
  */
561
561
  color?: string | null;
562
562
  /** Gradient configuration. */
@@ -663,33 +663,33 @@ interface Styles {
663
663
  borderRadius?: number | null;
664
664
  /**
665
665
  * Border color as a hexadecimal value.
666
- * @format COLOR_HEX
666
+ * @maxLength 19
667
667
  */
668
668
  borderColor?: string | null;
669
669
  /**
670
670
  * Border color as a hexadecimal value (hover state).
671
- * @format COLOR_HEX
671
+ * @maxLength 19
672
672
  */
673
673
  borderColorHover?: string | null;
674
674
  /**
675
675
  * Text color as a hexadecimal value.
676
- * @format COLOR_HEX
676
+ * @maxLength 19
677
677
  */
678
678
  textColor?: string | null;
679
679
  /**
680
680
  * Text color as a hexadecimal value (hover state).
681
- * @format COLOR_HEX
681
+ * @maxLength 19
682
682
  */
683
683
  textColorHover?: string | null;
684
684
  /**
685
685
  * Deprecated: Use `background` instead.
686
- * @format COLOR_HEX
686
+ * @maxLength 19
687
687
  * @deprecated
688
688
  */
689
689
  backgroundColor?: string | null;
690
690
  /**
691
691
  * Deprecated: Use `backgroundHover` instead.
692
- * @format COLOR_HEX
692
+ * @maxLength 19
693
693
  * @deprecated
694
694
  */
695
695
  backgroundColorHover?: string | null;
@@ -1141,7 +1141,7 @@ interface StylesBorder {
1141
1141
  width?: number | null;
1142
1142
  /**
1143
1143
  * Border color as a hexadecimal value.
1144
- * @format COLOR_HEX
1144
+ * @maxLength 19
1145
1145
  */
1146
1146
  color?: string | null;
1147
1147
  /** Border radius in pixels. */
@@ -1182,22 +1182,22 @@ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HI
1182
1182
  interface LinkPreviewDataStyles {
1183
1183
  /**
1184
1184
  * Background color as a hexadecimal value.
1185
- * @format COLOR_HEX
1185
+ * @maxLength 19
1186
1186
  */
1187
1187
  backgroundColor?: string | null;
1188
1188
  /**
1189
1189
  * Title color as a hexadecimal value.
1190
- * @format COLOR_HEX
1190
+ * @maxLength 19
1191
1191
  */
1192
1192
  titleColor?: string | null;
1193
1193
  /**
1194
1194
  * Subtitle color as a hexadecimal value.
1195
- * @format COLOR_HEX
1195
+ * @maxLength 19
1196
1196
  */
1197
1197
  subtitleColor?: string | null;
1198
1198
  /**
1199
1199
  * Link color as a hexadecimal value.
1200
- * @format COLOR_HEX
1200
+ * @maxLength 19
1201
1201
  */
1202
1202
  linkColor?: string | null;
1203
1203
  /** Border width in pixels. */
@@ -1206,7 +1206,7 @@ interface LinkPreviewDataStyles {
1206
1206
  borderRadius?: number | null;
1207
1207
  /**
1208
1208
  * Border color as a hexadecimal value.
1209
- * @format COLOR_HEX
1209
+ * @maxLength 19
1210
1210
  */
1211
1211
  borderColor?: string | null;
1212
1212
  /** Position of thumbnail. Defaults to `START`. */
@@ -1357,19 +1357,19 @@ interface BackgroundGradient {
1357
1357
  angle?: number | null;
1358
1358
  /**
1359
1359
  * The start color as a hexademical value.
1360
- * @format COLOR_HEX
1360
+ * @maxLength 19
1361
1361
  */
1362
1362
  startColor?: string | null;
1363
1363
  /**
1364
1364
  * The end color as a hexademical value.
1365
- * @format COLOR_HEX
1365
+ * @maxLength 19
1366
1366
  */
1367
1367
  lastColor?: string | null;
1368
1368
  }
1369
1369
  interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
1370
1370
  /**
1371
1371
  * The background color as a hexademical value.
1372
- * @format COLOR_HEX
1372
+ * @maxLength 19
1373
1373
  */
1374
1374
  color?: string | null;
1375
1375
  /** An image to use for the background. */
@@ -1383,7 +1383,7 @@ interface PollDesignBackground extends PollDesignBackgroundBackgroundOneOf {
1383
1383
  interface PollDesignBackgroundBackgroundOneOf {
1384
1384
  /**
1385
1385
  * The background color as a hexademical value.
1386
- * @format COLOR_HEX
1386
+ * @maxLength 19
1387
1387
  */
1388
1388
  color?: string | null;
1389
1389
  /** An image to use for the background. */
@@ -1697,32 +1697,32 @@ interface ButtonStyles {
1697
1697
  borderRadius?: number | null;
1698
1698
  /**
1699
1699
  * Border color as a hexadecimal value.
1700
- * @format COLOR_HEX
1700
+ * @maxLength 19
1701
1701
  */
1702
1702
  borderColor?: string | null;
1703
1703
  /**
1704
1704
  * Text color as a hexadecimal value.
1705
- * @format COLOR_HEX
1705
+ * @maxLength 19
1706
1706
  */
1707
1707
  textColor?: string | null;
1708
1708
  /**
1709
1709
  * Background color as a hexadecimal value.
1710
- * @format COLOR_HEX
1710
+ * @maxLength 19
1711
1711
  */
1712
1712
  backgroundColor?: string | null;
1713
1713
  /**
1714
1714
  * Border color as a hexadecimal value (hover state).
1715
- * @format COLOR_HEX
1715
+ * @maxLength 19
1716
1716
  */
1717
1717
  borderColorHover?: string | null;
1718
1718
  /**
1719
1719
  * Text color as a hexadecimal value (hover state).
1720
- * @format COLOR_HEX
1720
+ * @maxLength 19
1721
1721
  */
1722
1722
  textColorHover?: string | null;
1723
1723
  /**
1724
1724
  * Background color as a hexadecimal value (hover state).
1725
- * @format COLOR_HEX
1725
+ * @maxLength 19
1726
1726
  */
1727
1727
  backgroundColorHover?: string | null;
1728
1728
  /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
@@ -1739,7 +1739,7 @@ interface ImageStyles {
1739
1739
  resizing?: ResizingWithLiterals;
1740
1740
  /**
1741
1741
  * Image border color as a hexadecimal value.
1742
- * @format COLOR_HEX
1742
+ * @maxLength 19
1743
1743
  */
1744
1744
  borderColor?: string | null;
1745
1745
  /** Image border width in pixels. */
@@ -1752,17 +1752,17 @@ interface RibbonStyles {
1752
1752
  ribbonText?: string | null;
1753
1753
  /**
1754
1754
  * Ribbon background color as a hexadecimal value.
1755
- * @format COLOR_HEX
1755
+ * @maxLength 19
1756
1756
  */
1757
1757
  backgroundColor?: string | null;
1758
1758
  /**
1759
1759
  * Ribbon text color as a hexadecimal value.
1760
- * @format COLOR_HEX
1760
+ * @maxLength 19
1761
1761
  */
1762
1762
  textColor?: string | null;
1763
1763
  /**
1764
1764
  * Ribbon border color as a hexadecimal value.
1765
- * @format COLOR_HEX
1765
+ * @maxLength 19
1766
1766
  */
1767
1767
  borderColor?: string | null;
1768
1768
  /** Ribbon border width in pixels. */
@@ -1775,12 +1775,12 @@ interface RibbonStyles {
1775
1775
  interface CardStyles {
1776
1776
  /**
1777
1777
  * Card background color as a hexadecimal value.
1778
- * @format COLOR_HEX
1778
+ * @maxLength 19
1779
1779
  */
1780
1780
  backgroundColor?: string | null;
1781
1781
  /**
1782
1782
  * Card border color as a hexadecimal value.
1783
- * @format COLOR_HEX
1783
+ * @maxLength 19
1784
1784
  */
1785
1785
  borderColor?: string | null;
1786
1786
  /** Card border width in pixels. */
@@ -1795,12 +1795,12 @@ interface CardStyles {
1795
1795
  titlePriceLayout?: LayoutWithLiterals;
1796
1796
  /**
1797
1797
  * Title text color as a hexadecimal value.
1798
- * @format COLOR_HEX
1798
+ * @maxLength 19
1799
1799
  */
1800
1800
  titleColor?: string | null;
1801
1801
  /**
1802
1802
  * Text color as a hexadecimal value.
1803
- * @format COLOR_HEX
1803
+ * @maxLength 19
1804
1804
  */
1805
1805
  textColor?: string | null;
1806
1806
  }
@@ -1982,29 +1982,29 @@ interface CellStyle {
1982
1982
  verticalAlignment?: VerticalAlignmentWithLiterals;
1983
1983
  /**
1984
1984
  * Cell background color as a hexadecimal value.
1985
- * @format COLOR_HEX
1985
+ * @maxLength 19
1986
1986
  */
1987
1987
  backgroundColor?: string | null;
1988
1988
  }
1989
1989
  interface BorderColors {
1990
1990
  /**
1991
1991
  * Left border color as a hexadecimal value.
1992
- * @format COLOR_HEX
1992
+ * @maxLength 19
1993
1993
  */
1994
1994
  left?: string | null;
1995
1995
  /**
1996
1996
  * Right border color as a hexadecimal value.
1997
- * @format COLOR_HEX
1997
+ * @maxLength 19
1998
1998
  */
1999
1999
  right?: string | null;
2000
2000
  /**
2001
2001
  * Top border color as a hexadecimal value.
2002
- * @format COLOR_HEX
2002
+ * @maxLength 19
2003
2003
  */
2004
2004
  top?: string | null;
2005
2005
  /**
2006
2006
  * Bottom border color as a hexadecimal value.
2007
- * @format COLOR_HEX
2007
+ * @maxLength 19
2008
2008
  */
2009
2009
  bottom?: string | null;
2010
2010
  }
@@ -2079,7 +2079,7 @@ interface CaptionData {
2079
2079
  interface LayoutData {
2080
2080
  /**
2081
2081
  * Deprecated: Use `background` instead.
2082
- * @format COLOR_HEX
2082
+ * @maxLength 19
2083
2083
  * @deprecated
2084
2084
  */
2085
2085
  backgroundColor?: string | null;
@@ -2087,7 +2087,7 @@ interface LayoutData {
2087
2087
  backgroundImage?: LayoutDataBackgroundImage;
2088
2088
  /**
2089
2089
  * Border color as a hexadecimal value.
2090
- * @format COLOR_HEX
2090
+ * @maxLength 19
2091
2091
  */
2092
2092
  borderColor?: string | null;
2093
2093
  /** Border width in pixels. */
@@ -2096,7 +2096,7 @@ interface LayoutData {
2096
2096
  borderRadius?: number | null;
2097
2097
  /**
2098
2098
  * Deprecated: Use `backdrop` instead.
2099
- * @format COLOR_HEX
2099
+ * @maxLength 19
2100
2100
  * @deprecated
2101
2101
  */
2102
2102
  backdropColor?: string | null;
@@ -2234,7 +2234,7 @@ interface LayoutDataBackground {
2234
2234
  type?: LayoutDataBackgroundTypeWithLiterals;
2235
2235
  /**
2236
2236
  * Background color as a hexadecimal value.
2237
- * @format COLOR_HEX
2237
+ * @maxLength 19
2238
2238
  */
2239
2239
  color?: string | null;
2240
2240
  /** Gradient configuration. */
@@ -2246,7 +2246,7 @@ interface Backdrop {
2246
2246
  type?: BackdropTypeWithLiterals;
2247
2247
  /**
2248
2248
  * Backdrop color as a hexadecimal value.
2249
- * @format COLOR_HEX
2249
+ * @maxLength 19
2250
2250
  */
2251
2251
  color?: string | null;
2252
2252
  /** Gradient configuration. */
@@ -2267,7 +2267,7 @@ interface ShapeData {
2267
2267
  interface ShapeDataStyles {
2268
2268
  /**
2269
2269
  * Shape fill color as a hexadecimal value.
2270
- * @format COLOR_HEX
2270
+ * @maxLength 19
2271
2271
  */
2272
2272
  color?: string | null;
2273
2273
  /** Map of original color keys to their new color values. */
@@ -2326,7 +2326,7 @@ interface CardDataBackground {
2326
2326
  type?: CardDataBackgroundTypeWithLiterals;
2327
2327
  /**
2328
2328
  * Background color as a hexadecimal value.
2329
- * @format COLOR_HEX
2329
+ * @maxLength 19
2330
2330
  */
2331
2331
  color?: string | null;
2332
2332
  /** Gradient configuration. */
@@ -2353,7 +2353,7 @@ interface TocData {
2353
2353
  itemSpacing?: number | null;
2354
2354
  /**
2355
2355
  * Optional override for the text color.
2356
- * @format COLOR_HEX
2356
+ * @maxLength 19
2357
2357
  */
2358
2358
  color?: string | null;
2359
2359
  /** Indentation style. Default: NESTED. */
@@ -2395,7 +2395,10 @@ interface SmartBlockData {
2395
2395
  orientation?: string | null;
2396
2396
  /** Column size controlling cells per row. */
2397
2397
  columnSize?: ColumnSizeWithLiterals;
2398
- /** Border color (for SOLID_JOINED_BOXES variant). */
2398
+ /**
2399
+ * Border color (for SOLID_JOINED_BOXES variant).
2400
+ * @maxLength 19
2401
+ */
2399
2402
  borderColor?: string | null;
2400
2403
  /** Border width in pixels (for SOLID_JOINED_BOXES variant). */
2401
2404
  borderWidth?: number | null;
@@ -2454,7 +2457,10 @@ interface SmartBlockCellData {
2454
2457
  label?: string | null;
2455
2458
  /** Shape file details. */
2456
2459
  shape?: V1Media;
2457
- /** Border color of the cell. */
2460
+ /**
2461
+ * Border color of the cell.
2462
+ * @maxLength 19
2463
+ */
2458
2464
  borderColor?: string | null;
2459
2465
  /** Border width in pixels. */
2460
2466
  borderWidth?: number | null;
@@ -2462,11 +2468,20 @@ interface SmartBlockCellData {
2462
2468
  borderRadius?: number | null;
2463
2469
  /** The type of the parent smart block (must match parent). */
2464
2470
  type?: SmartBlockDataTypeWithLiterals;
2465
- /** Accent color for non-background variants (e.g., line, bullet, label color). */
2471
+ /**
2472
+ * Accent color for non-background variants (e.g., line, bullet, label color).
2473
+ * @maxLength 19
2474
+ */
2466
2475
  accentColor?: string | null;
2467
- /** Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES). */
2476
+ /**
2477
+ * Background color for background-based variants (SOLID_BOXES, SOLID_BOXES_ALTERNATING, SOLID_JOINED_BOXES).
2478
+ * @maxLength 19
2479
+ */
2468
2480
  backgroundColor?: string | null;
2469
- /** Shape fill color as a hexadecimal value. */
2481
+ /**
2482
+ * Shape fill color as a hexadecimal value.
2483
+ * @maxLength 19
2484
+ */
2470
2485
  shapeColor?: string | null;
2471
2486
  }
2472
2487
  interface Metadata {
@@ -2736,311 +2751,595 @@ interface PostUnlikedInitiatorOneOf {
2736
2751
  */
2737
2752
  anonymousVisitorId?: string | null;
2738
2753
  }
2739
- interface ListTemplatesRequest {
2754
+ interface GetTotalLikesPerMemberRequest {
2740
2755
  /**
2741
- * Filter post templates by given template category ids
2742
- * @maxSize 50
2756
+ * Member ID.
2743
2757
  * @format GUID
2744
2758
  */
2745
- categoryIds?: string[];
2746
- /**
2747
- * Filter post templates by provided language
2748
- * @format LANGUAGE_TAG
2749
- */
2750
- language?: string | null;
2751
- /** Returns post template categories when set to TRUE */
2752
- listTemplateCategories?: boolean;
2753
- /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
2754
- sort?: GetPostTemplatesSortWithLiterals;
2755
- /** Pagination options. */
2756
- paging?: BlogPaging;
2759
+ memberId?: string;
2757
2760
  }
2758
- declare enum GetPostTemplatesSort {
2759
- /** Sort by ascending publishing date. */
2760
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
2761
- /** Sort by descending publishing date. */
2762
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
2761
+ interface GetTotalLikesPerMemberResponse {
2762
+ /** The total number of likes of the member. */
2763
+ total?: number;
2763
2764
  }
2764
- /** @enumType */
2765
- type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
2766
- interface BlogPaging {
2765
+ interface DomainEvent extends DomainEventBodyOneOf {
2766
+ createdEvent?: EntityCreatedEvent;
2767
+ updatedEvent?: EntityUpdatedEvent;
2768
+ deletedEvent?: EntityDeletedEvent;
2769
+ actionEvent?: ActionEvent;
2770
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2771
+ _id?: string;
2767
2772
  /**
2768
- * Number of items to skip in the current sort order.
2769
- *
2770
- *
2771
- * Default: `0`
2773
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2774
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2772
2775
  */
2773
- offset?: number;
2776
+ entityFqdn?: string;
2774
2777
  /**
2775
- * Number of items to return.
2776
- *
2777
- *
2778
- * Default:`50`
2779
- * @min 1
2780
- * @max 100
2778
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2779
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2781
2780
  */
2782
- limit?: number;
2781
+ slug?: string;
2782
+ /** ID of the entity associated with the event. */
2783
+ entityId?: string;
2784
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2785
+ eventTime?: Date | null;
2783
2786
  /**
2784
- * Pointer to the next or previous page in the list of results.
2785
- * @maxLength 2000
2787
+ * Whether the event was triggered as a result of a privacy regulation application
2788
+ * (for example, GDPR).
2786
2789
  */
2787
- cursor?: string | null;
2790
+ triggeredByAnonymizeRequest?: boolean | null;
2791
+ /** If present, indicates the action that triggered the event. */
2792
+ originatedFrom?: string | null;
2793
+ /**
2794
+ * 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.
2795
+ * 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.
2796
+ */
2797
+ entityEventSequence?: string | null;
2788
2798
  }
2789
- interface ListTemplatesResponse {
2790
- /** Available post templates */
2791
- postTemplates?: Post[];
2792
- /** Details on the paged set of posts templates returned. */
2793
- postTemplatesMetaData?: MetaData;
2794
- /** Post template categories. This value is returned empty unless asked explicitly */
2795
- templateCategories?: Category[];
2799
+ /** @oneof */
2800
+ interface DomainEventBodyOneOf {
2801
+ createdEvent?: EntityCreatedEvent;
2802
+ updatedEvent?: EntityUpdatedEvent;
2803
+ deletedEvent?: EntityDeletedEvent;
2804
+ actionEvent?: ActionEvent;
2796
2805
  }
2797
- interface MetaData {
2798
- /** Number of items returned in this response. */
2799
- count?: number;
2800
- /** Requested offset. */
2801
- offset?: number;
2802
- /** Total number of items that match the query. */
2803
- total?: number;
2806
+ interface EntityCreatedEvent {
2807
+ entity?: string;
2808
+ }
2809
+ interface RestoreInfo {
2810
+ deletedDate?: Date | null;
2811
+ }
2812
+ interface EntityUpdatedEvent {
2804
2813
  /**
2805
- * Pointer to the next or previous page in the list of results.
2806
- * @maxLength 2000
2814
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2815
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2816
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2807
2817
  */
2808
- cursor?: string | null;
2818
+ currentEntity?: string;
2809
2819
  }
2810
- interface Category {
2820
+ interface EntityDeletedEvent {
2821
+ /** Entity that was deleted. */
2822
+ deletedEntity?: string | null;
2823
+ }
2824
+ interface ActionEvent {
2825
+ body?: string;
2826
+ }
2827
+ interface MessageEnvelope {
2811
2828
  /**
2812
- * Category ID.
2813
- * @immutable
2814
- * @maxLength 38
2829
+ * App instance ID.
2830
+ * @format GUID
2815
2831
  */
2816
- _id?: string;
2832
+ instanceId?: string | null;
2817
2833
  /**
2818
- * Category label. Displayed in the Category Menu.
2819
- * @maxLength 35
2834
+ * Event type.
2835
+ * @maxLength 150
2820
2836
  */
2821
- label?: string;
2837
+ eventType?: string;
2838
+ /** The identification type and identity data. */
2839
+ identity?: IdentificationData;
2840
+ /** Stringify payload. */
2841
+ data?: string;
2842
+ /** Details related to the account */
2843
+ accountInfo?: AccountInfo;
2844
+ }
2845
+ interface IdentificationData extends IdentificationDataIdOneOf {
2822
2846
  /**
2823
- * Number of posts in the category.
2824
- * @readonly
2847
+ * ID of a site visitor that has not logged in to the site.
2848
+ * @format GUID
2825
2849
  */
2826
- postCount?: number;
2850
+ anonymousVisitorId?: string;
2827
2851
  /**
2828
- * The `url` of the page that lists every post with the specified category.
2829
- * @readonly
2852
+ * ID of a site visitor that has logged in to the site.
2853
+ * @format GUID
2830
2854
  */
2831
- url?: string;
2855
+ memberId?: string;
2832
2856
  /**
2833
- * Category description.
2834
- * @maxLength 500
2857
+ * ID of a Wix user (site owner, contributor, etc.).
2858
+ * @format GUID
2835
2859
  */
2836
- description?: string | null;
2860
+ wixUserId?: string;
2837
2861
  /**
2838
- * Category title.
2839
- * @maxLength 200
2840
- * @deprecated Category title.
2841
- * @targetRemovalDate 2025-07-16
2862
+ * ID of an app.
2863
+ * @format GUID
2842
2864
  */
2843
- title?: string;
2865
+ appId?: string;
2866
+ /** @readonly */
2867
+ identityType?: WebhookIdentityTypeWithLiterals;
2868
+ }
2869
+ /** @oneof */
2870
+ interface IdentificationDataIdOneOf {
2844
2871
  /**
2845
- * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
2846
- * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
2847
- *
2848
- * Default: `-1`
2872
+ * ID of a site visitor that has not logged in to the site.
2873
+ * @format GUID
2849
2874
  */
2850
- displayPosition?: number | null;
2875
+ anonymousVisitorId?: string;
2851
2876
  /**
2852
- * ID of the category's translations. All translations of a single category share the same `translationId`.
2877
+ * ID of a site visitor that has logged in to the site.
2853
2878
  * @format GUID
2854
2879
  */
2855
- translationId?: string | null;
2880
+ memberId?: string;
2856
2881
  /**
2857
- * Category language.
2858
- *
2859
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2860
- * @immutable
2882
+ * ID of a Wix user (site owner, contributor, etc.).
2883
+ * @format GUID
2861
2884
  */
2862
- language?: string | null;
2885
+ wixUserId?: string;
2863
2886
  /**
2864
- * Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
2865
- * @maxLength 100
2887
+ * ID of an app.
2888
+ * @format GUID
2866
2889
  */
2867
- slug?: string;
2868
- /** SEO data. */
2869
- seoData?: SeoSchema;
2870
- /** Category cover image. */
2871
- coverImage?: string;
2890
+ appId?: string;
2891
+ }
2892
+ declare enum WebhookIdentityType {
2893
+ UNKNOWN = "UNKNOWN",
2894
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2895
+ MEMBER = "MEMBER",
2896
+ WIX_USER = "WIX_USER",
2897
+ APP = "APP"
2898
+ }
2899
+ /** @enumType */
2900
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2901
+ interface AccountInfo {
2872
2902
  /**
2873
- * Date and time the Category was last updated.
2874
- * @readonly
2903
+ * ID of the Wix account associated with the event.
2904
+ * @format GUID
2875
2905
  */
2876
- _updatedDate?: Date | null;
2877
- }
2878
- interface CategoryTranslation {
2906
+ accountId?: string | null;
2879
2907
  /**
2880
- * Category ID.
2908
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
2881
2909
  * @format GUID
2882
2910
  */
2883
- _id?: string;
2911
+ parentAccountId?: string | null;
2884
2912
  /**
2885
- * Label displayed in the categories menu on the site.
2886
- * @maxLength 100
2913
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
2914
+ * @format GUID
2887
2915
  */
2888
- label?: string | null;
2916
+ siteId?: string | null;
2917
+ }
2918
+ /** Get Blog Publications Count Stats request */
2919
+ interface QueryPublicationsCountStatsRequest {
2920
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2921
+ rangeStart?: Date | null;
2922
+ /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2923
+ rangeEnd?: Date | null;
2924
+ /** Order of the returned results. */
2925
+ order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
2926
+ /** Number of months to include in the response. */
2927
+ months?: number;
2889
2928
  /**
2890
- * Language of the category.
2929
+ * Language filter
2930
+ *
2931
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2891
2932
  * @format LANGUAGE_TAG
2892
2933
  */
2893
2934
  language?: string | null;
2894
- /** URL of this category page. */
2895
- url?: string;
2896
- }
2897
- interface GetTemplateRequest {
2898
2935
  /**
2899
- * Post template id
2900
- * @format GUID
2936
+ * Timezone of the client.
2937
+ * @minLength 3
2938
+ * @maxLength 100
2901
2939
  */
2902
- postTemplateId?: string;
2940
+ timeZone?: string | null;
2903
2941
  }
2904
- interface GetTemplateResponse {
2905
- /** Post template */
2906
- postTemplate?: Post;
2942
+ declare enum QueryPublicationsCountStatsRequestOrder {
2943
+ UNKNOWN = "UNKNOWN",
2944
+ OLDEST = "OLDEST",
2945
+ NEWEST = "NEWEST"
2907
2946
  }
2908
- interface CreateDraftPostFromTemplateRequest {
2909
- /**
2910
- * Post template id
2911
- * @format GUID
2912
- */
2913
- postTemplateId?: string;
2947
+ /** @enumType */
2948
+ type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
2949
+ /** Get Blog Publications Count Stats response */
2950
+ interface QueryPublicationsCountStatsResponse {
2951
+ /** Chronologically ordered list of publications. */
2952
+ stats?: PeriodPublicationsCount[];
2914
2953
  }
2915
- interface CreateDraftPostFromTemplateResponse {
2916
- /** Created draft post */
2917
- draftPost?: DraftPost;
2954
+ /** Publications count for a specific time period */
2955
+ interface PeriodPublicationsCount {
2956
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2957
+ periodStart?: Date | null;
2958
+ /** Number of posts published during this month. */
2959
+ publicationsCount?: number;
2918
2960
  }
2919
- interface DraftPost {
2920
- /**
2921
- * Draft post ID.
2922
- * @readonly
2923
- * @maxLength 38
2924
- */
2925
- _id?: string;
2926
- /**
2927
- * Draft post title.
2928
- * @maxLength 200
2929
- */
2930
- title?: string;
2961
+ /** Get Blog Post Count Stats request */
2962
+ interface QueryPostCountStatsRequest {
2963
+ /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
2964
+ rangeStart?: Date | null;
2931
2965
  /**
2932
- * Draft post excerpt.
2966
+ * Order of returned results.
2933
2967
  *
2934
- * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
2935
- * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
2936
- * @maxLength 500
2937
- */
2938
- excerpt?: string | null;
2939
- /** Whether the draft post is marked as featured. */
2940
- featured?: boolean | null;
2941
- /**
2942
- * Category IDs of the draft post.
2943
- * @maxSize 10
2944
- * @maxLength 38
2968
+ * - `OLDEST`: posts by date in ascending order.
2969
+ * - `NEWEST`: posts by date in descending order.
2970
+ *
2971
+ * Default: `OLDEST`
2945
2972
  */
2946
- categoryIds?: string[];
2973
+ order?: OrderWithLiterals;
2974
+ /** Number of months to include in response. */
2975
+ months?: number;
2947
2976
  /**
2948
- * Draft post owner's member ID.
2949
- * @format GUID
2977
+ * Language filter.
2978
+ *
2979
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2980
+ * Pass a language to only receive the period post count for that specified language.
2981
+ * @format LANGUAGE_TAG
2950
2982
  */
2951
- memberId?: string | null;
2983
+ language?: string | null;
2952
2984
  /**
2953
- * Hashtags in the post.
2954
- * @maxSize 100
2985
+ * Time zone to use when calculating the start of the month.
2986
+ *
2987
+ * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
2988
+ * @minLength 3
2955
2989
  * @maxLength 100
2956
2990
  */
2957
- hashtags?: string[];
2958
- /** Whether commenting on the draft post is enabled. */
2959
- commentingEnabled?: boolean | null;
2991
+ timeZone?: string | null;
2992
+ }
2993
+ declare enum Order {
2994
+ UNKNOWN = "UNKNOWN",
2995
+ OLDEST = "OLDEST",
2996
+ NEWEST = "NEWEST"
2997
+ }
2998
+ /** @enumType */
2999
+ type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3000
+ /** Get Blog Post Count Stats response */
3001
+ interface QueryPostCountStatsResponse {
3002
+ /** List of published post counts by month. */
3003
+ stats?: PeriodPostCount[];
3004
+ }
3005
+ /** Post count for a specific time period */
3006
+ interface PeriodPostCount {
3007
+ /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3008
+ periodStart?: Date | null;
3009
+ /** Number of posts published during this month. */
3010
+ postCount?: number;
3011
+ }
3012
+ interface GetTotalPublicationsRequest {
2960
3013
  /**
2961
- * Estimated reading time of the draft post (calculated automatically).
2962
- * @readonly
3014
+ * Language filter
3015
+ * @minLength 2
3016
+ * @format LANGUAGE_TAG
2963
3017
  */
2964
- minutesToRead?: number;
2965
- /** Image placed at the top of the blog page. */
2966
- heroImage?: string;
3018
+ language?: string | null;
3019
+ }
3020
+ interface GetTotalPublicationsResponse {
3021
+ /** Total amount of publications. */
3022
+ total?: number;
3023
+ }
3024
+ interface GetTotalPostsRequest {
2967
3025
  /**
2968
- * Tag IDs the draft post is tagged with.
2969
- * @maxSize 30
2970
- * @maxLength 38
3026
+ * Language filter.
3027
+ *
3028
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3029
+ * Pass a language to receive the total amount of posts in that specified language.
3030
+ * @format LANGUAGE_TAG
2971
3031
  */
2972
- tagIds?: string[];
3032
+ language?: string | null;
3033
+ }
3034
+ interface GetTotalPostsResponse {
3035
+ /** Total amount of published posts. */
3036
+ total?: number;
3037
+ }
3038
+ interface ListTemplatesRequest {
2973
3039
  /**
2974
- * IDs of posts related to this draft post.
2975
- * @maxSize 3
2976
- * @maxLength 38
3040
+ * Filter post templates by given template category ids
3041
+ * @maxSize 50
3042
+ * @format GUID
2977
3043
  */
2978
- relatedPostIds?: string[];
3044
+ categoryIds?: string[];
2979
3045
  /**
2980
- * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
2981
- * @maxSize 100
2982
- * @format GUID
3046
+ * Filter post templates by provided language
3047
+ * @format LANGUAGE_TAG
2983
3048
  */
2984
- pricingPlanIds?: string[];
3049
+ language?: string | null;
3050
+ /** Returns post template categories when set to TRUE */
3051
+ listTemplateCategories?: boolean;
3052
+ /** Sort order by ascending/descending publish date. Default is ascending publish date sort */
3053
+ sort?: GetPostTemplatesSortWithLiterals;
3054
+ /** Pagination options. */
3055
+ paging?: BlogPaging;
3056
+ }
3057
+ declare enum GetPostTemplatesSort {
3058
+ /** Sort by ascending publishing date. */
3059
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3060
+ /** Sort by descending publishing date. */
3061
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC"
3062
+ }
3063
+ /** @enumType */
3064
+ type GetPostTemplatesSortWithLiterals = GetPostTemplatesSort | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC';
3065
+ interface BlogPaging {
2985
3066
  /**
2986
- * ID of the draft post's translations.
3067
+ * Number of items to skip in the current sort order.
2987
3068
  *
2988
- * All translations of a single post share the same `translationId`.
2989
- * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
2990
- * @format GUID
3069
+ *
3070
+ * Default: `0`
2991
3071
  */
2992
- translationId?: string | null;
3072
+ offset?: number;
2993
3073
  /**
2994
- * Language the draft post is written in.
3074
+ * Number of items to return.
2995
3075
  *
2996
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2997
- * @format LANGUAGE_TAG
3076
+ *
3077
+ * Default:`50`
3078
+ * @min 1
3079
+ * @max 100
2998
3080
  */
2999
- language?: string | null;
3081
+ limit?: number;
3000
3082
  /**
3001
- * Draft Post rich content.
3002
- *
3003
- * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
3004
- * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3005
- * </widget>
3083
+ * Pointer to the next or previous page in the list of results.
3084
+ * @maxLength 2000
3006
3085
  */
3007
- richContent?: RichContent;
3086
+ cursor?: string | null;
3087
+ }
3088
+ interface ListTemplatesResponse {
3089
+ /** Available post templates */
3090
+ postTemplates?: Post[];
3091
+ /** Details on the paged set of posts templates returned. */
3092
+ postTemplatesMetaData?: MetaData;
3093
+ /** Post template categories. This value is returned empty unless asked explicitly */
3094
+ templateCategories?: Category[];
3095
+ }
3096
+ interface MetaData {
3097
+ /** Number of items returned in this response. */
3098
+ count?: number;
3099
+ /** Requested offset. */
3100
+ offset?: number;
3101
+ /** Total number of items that match the query. */
3102
+ total?: number;
3008
3103
  /**
3009
- * Status of the draft post.
3010
- * @readonly
3104
+ * Pointer to the next or previous page in the list of results.
3105
+ * @maxLength 2000
3011
3106
  */
3012
- status?: StatusWithLiterals;
3013
- /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3014
- moderationDetails?: ModerationDetails;
3107
+ cursor?: string | null;
3108
+ }
3109
+ interface Category {
3015
3110
  /**
3016
- * Indicates if there are changes made to the draft post that have not yet been published.
3017
- * @readonly
3111
+ * Category ID.
3112
+ * @immutable
3113
+ * @maxLength 38
3018
3114
  */
3019
- hasUnpublishedChanges?: boolean;
3115
+ _id?: string;
3020
3116
  /**
3021
- * Date the draft post was last edited.
3022
- * @readonly
3117
+ * Category label. Displayed in the Category Menu.
3118
+ * @maxLength 35
3023
3119
  */
3024
- editedDate?: Date | null;
3120
+ label?: string;
3025
3121
  /**
3026
- * Date the draft post is scheduled to be published.
3122
+ * Number of posts in the category.
3027
3123
  * @readonly
3028
3124
  */
3029
- scheduledPublishDate?: Date | null;
3030
- /** Date the post was first published. */
3031
- firstPublishedDate?: Date | null;
3032
- /** SEO data. */
3033
- seoData?: SeoSchema;
3125
+ postCount?: number;
3034
3126
  /**
3035
- * Draft post URL preview. What the URL will look like once the post is published.
3127
+ * The `url` of the page that lists every post with the specified category.
3036
3128
  * @readonly
3037
3129
  */
3038
3130
  url?: string;
3039
3131
  /**
3040
- * Date the draft post was first created.
3041
- * @readonly
3132
+ * Category description.
3133
+ * @maxLength 500
3042
3134
  */
3043
- _createdDate?: Date | null;
3135
+ description?: string | null;
3136
+ /**
3137
+ * Category title.
3138
+ * @maxLength 200
3139
+ * @deprecated Category title.
3140
+ * @targetRemovalDate 2025-07-16
3141
+ */
3142
+ title?: string;
3143
+ /**
3144
+ * Position of the category in the [Category Menu](https://support.wix.com/en/article/wix-blog-adding-and-customizing-a-category-menu).
3145
+ * Categories are displayed in ascending order. Categories with a position of `-1` appear at the end of the sequence.
3146
+ *
3147
+ * Default: `-1`
3148
+ */
3149
+ displayPosition?: number | null;
3150
+ /**
3151
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
3152
+ * @format GUID
3153
+ */
3154
+ translationId?: string | null;
3155
+ /**
3156
+ * Category language.
3157
+ *
3158
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3159
+ * @immutable
3160
+ */
3161
+ language?: string | null;
3162
+ /**
3163
+ * Part of a category's URL that refers to a specific category. For example, the slug of `https:/example.com/blog/category/famous-cats` is `famous-cats`.
3164
+ * @maxLength 100
3165
+ */
3166
+ slug?: string;
3167
+ /** SEO data. */
3168
+ seoData?: SeoSchema;
3169
+ /** Category cover image. */
3170
+ coverImage?: string;
3171
+ /**
3172
+ * Date and time the Category was last updated.
3173
+ * @readonly
3174
+ */
3175
+ _updatedDate?: Date | null;
3176
+ }
3177
+ interface CategoryTranslation {
3178
+ /**
3179
+ * Category ID.
3180
+ * @format GUID
3181
+ */
3182
+ _id?: string;
3183
+ /**
3184
+ * Label displayed in the categories menu on the site.
3185
+ * @maxLength 100
3186
+ */
3187
+ label?: string | null;
3188
+ /**
3189
+ * Language of the category.
3190
+ * @format LANGUAGE_TAG
3191
+ */
3192
+ language?: string | null;
3193
+ /** URL of this category page. */
3194
+ url?: string;
3195
+ }
3196
+ interface GetTemplateRequest {
3197
+ /**
3198
+ * Post template id
3199
+ * @format GUID
3200
+ */
3201
+ postTemplateId?: string;
3202
+ }
3203
+ interface GetTemplateResponse {
3204
+ /** Post template */
3205
+ postTemplate?: Post;
3206
+ }
3207
+ interface CreateDraftPostFromTemplateRequest {
3208
+ /**
3209
+ * Post template id
3210
+ * @format GUID
3211
+ */
3212
+ postTemplateId?: string;
3213
+ }
3214
+ interface CreateDraftPostFromTemplateResponse {
3215
+ /** Created draft post */
3216
+ draftPost?: DraftPost;
3217
+ }
3218
+ interface DraftPost {
3219
+ /**
3220
+ * Draft post ID.
3221
+ * @readonly
3222
+ * @maxLength 38
3223
+ */
3224
+ _id?: string;
3225
+ /**
3226
+ * Draft post title.
3227
+ * @maxLength 200
3228
+ */
3229
+ title?: string;
3230
+ /**
3231
+ * Draft post excerpt.
3232
+ *
3233
+ * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
3234
+ * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
3235
+ * @maxLength 500
3236
+ */
3237
+ excerpt?: string | null;
3238
+ /** Whether the draft post is marked as featured. */
3239
+ featured?: boolean | null;
3240
+ /**
3241
+ * Category IDs of the draft post.
3242
+ * @maxSize 10
3243
+ * @maxLength 38
3244
+ */
3245
+ categoryIds?: string[];
3246
+ /**
3247
+ * Draft post owner's member ID.
3248
+ * @format GUID
3249
+ */
3250
+ memberId?: string | null;
3251
+ /**
3252
+ * Hashtags in the post.
3253
+ * @maxSize 100
3254
+ * @maxLength 100
3255
+ */
3256
+ hashtags?: string[];
3257
+ /** Whether commenting on the draft post is enabled. */
3258
+ commentingEnabled?: boolean | null;
3259
+ /**
3260
+ * Estimated reading time of the draft post (calculated automatically).
3261
+ * @readonly
3262
+ */
3263
+ minutesToRead?: number;
3264
+ /** Image placed at the top of the blog page. */
3265
+ heroImage?: string;
3266
+ /**
3267
+ * Tag IDs the draft post is tagged with.
3268
+ * @maxSize 30
3269
+ * @maxLength 38
3270
+ */
3271
+ tagIds?: string[];
3272
+ /**
3273
+ * IDs of posts related to this draft post.
3274
+ * @maxSize 3
3275
+ * @maxLength 38
3276
+ */
3277
+ relatedPostIds?: string[];
3278
+ /**
3279
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. See the Pricing Plans API for more info.
3280
+ * @maxSize 100
3281
+ * @format GUID
3282
+ */
3283
+ pricingPlanIds?: string[];
3284
+ /**
3285
+ * ID of the draft post's translations.
3286
+ *
3287
+ * All translations of a single post share the same `translationId`.
3288
+ * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3289
+ * @format GUID
3290
+ */
3291
+ translationId?: string | null;
3292
+ /**
3293
+ * Language the draft post is written in.
3294
+ *
3295
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3296
+ * @format LANGUAGE_TAG
3297
+ */
3298
+ language?: string | null;
3299
+ /**
3300
+ * Draft Post rich content.
3301
+ *
3302
+ * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="image.gallery.video.audio.divider.linkButton.html.giphy.codeBlock.file.hashtag.lineSpacing.indent.link.textColor.textHighlight.heading.verticalEmbed.table.collapsibleList.poll" exampleid="72c23a25-524f-4f70-a260-4a2777b6f5d5">
3303
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3304
+ * </widget>
3305
+ */
3306
+ richContent?: RichContent;
3307
+ /**
3308
+ * Status of the draft post.
3309
+ * @readonly
3310
+ */
3311
+ status?: StatusWithLiterals;
3312
+ /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
3313
+ moderationDetails?: ModerationDetails;
3314
+ /**
3315
+ * Indicates if there are changes made to the draft post that have not yet been published.
3316
+ * @readonly
3317
+ */
3318
+ hasUnpublishedChanges?: boolean;
3319
+ /**
3320
+ * Date the draft post was last edited.
3321
+ * @readonly
3322
+ */
3323
+ editedDate?: Date | null;
3324
+ /**
3325
+ * Date the draft post is scheduled to be published.
3326
+ * @readonly
3327
+ */
3328
+ scheduledPublishDate?: Date | null;
3329
+ /** Date the post was first published. */
3330
+ firstPublishedDate?: Date | null;
3331
+ /** SEO data. */
3332
+ seoData?: SeoSchema;
3333
+ /**
3334
+ * Draft post URL preview. What the URL will look like once the post is published.
3335
+ * @readonly
3336
+ */
3337
+ url?: string;
3338
+ /**
3339
+ * Date the draft post was first created.
3340
+ * @readonly
3341
+ */
3342
+ _createdDate?: Date | null;
3044
3343
  /**
3045
3344
  * SEO slug.
3046
3345
  * @maxLength 100
@@ -3164,289 +3463,157 @@ interface DraftPostTranslation {
3164
3463
  /** Post URL. */
3165
3464
  url?: string;
3166
3465
  }
3167
- interface DomainEvent extends DomainEventBodyOneOf {
3168
- createdEvent?: EntityCreatedEvent;
3169
- updatedEvent?: EntityUpdatedEvent;
3170
- deletedEvent?: EntityDeletedEvent;
3171
- actionEvent?: ActionEvent;
3172
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3173
- _id?: string;
3174
- /**
3175
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3176
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3177
- */
3178
- entityFqdn?: string;
3179
- /**
3180
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
3181
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3182
- */
3183
- slug?: string;
3184
- /** ID of the entity associated with the event. */
3185
- entityId?: string;
3186
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3187
- eventTime?: Date | null;
3188
- /**
3189
- * Whether the event was triggered as a result of a privacy regulation application
3190
- * (for example, GDPR).
3191
- */
3192
- triggeredByAnonymizeRequest?: boolean | null;
3193
- /** If present, indicates the action that triggered the event. */
3194
- originatedFrom?: string | null;
3195
- /**
3196
- * 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.
3197
- * 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.
3198
- */
3199
- entityEventSequence?: string | null;
3200
- }
3201
- /** @oneof */
3202
- interface DomainEventBodyOneOf {
3203
- createdEvent?: EntityCreatedEvent;
3204
- updatedEvent?: EntityUpdatedEvent;
3205
- deletedEvent?: EntityDeletedEvent;
3206
- actionEvent?: ActionEvent;
3207
- }
3208
- interface EntityCreatedEvent {
3209
- entity?: string;
3210
- }
3211
- interface RestoreInfo {
3212
- deletedDate?: Date | null;
3213
- }
3214
- interface EntityUpdatedEvent {
3215
- /**
3216
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3217
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3218
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3219
- */
3220
- currentEntity?: string;
3221
- }
3222
- interface EntityDeletedEvent {
3223
- /** Entity that was deleted. */
3224
- deletedEntity?: string | null;
3225
- }
3226
- interface ActionEvent {
3227
- body?: string;
3228
- }
3229
- interface MessageEnvelope {
3230
- /**
3231
- * App instance ID.
3232
- * @format GUID
3233
- */
3234
- instanceId?: string | null;
3235
- /**
3236
- * Event type.
3237
- * @maxLength 150
3238
- */
3239
- eventType?: string;
3240
- /** The identification type and identity data. */
3241
- identity?: IdentificationData;
3242
- /** Stringify payload. */
3243
- data?: string;
3244
- /** Details related to the account */
3245
- accountInfo?: AccountInfo;
3246
- }
3247
- interface IdentificationData extends IdentificationDataIdOneOf {
3248
- /**
3249
- * ID of a site visitor that has not logged in to the site.
3250
- * @format GUID
3251
- */
3252
- anonymousVisitorId?: string;
3253
- /**
3254
- * ID of a site visitor that has logged in to the site.
3255
- * @format GUID
3256
- */
3257
- memberId?: string;
3258
- /**
3259
- * ID of a Wix user (site owner, contributor, etc.).
3260
- * @format GUID
3261
- */
3262
- wixUserId?: string;
3263
- /**
3264
- * ID of an app.
3265
- * @format GUID
3266
- */
3267
- appId?: string;
3268
- /** @readonly */
3269
- identityType?: WebhookIdentityTypeWithLiterals;
3270
- }
3271
- /** @oneof */
3272
- interface IdentificationDataIdOneOf {
3273
- /**
3274
- * ID of a site visitor that has not logged in to the site.
3275
- * @format GUID
3276
- */
3277
- anonymousVisitorId?: string;
3278
- /**
3279
- * ID of a site visitor that has logged in to the site.
3280
- * @format GUID
3281
- */
3282
- memberId?: string;
3283
- /**
3284
- * ID of a Wix user (site owner, contributor, etc.).
3285
- * @format GUID
3286
- */
3287
- wixUserId?: string;
3288
- /**
3289
- * ID of an app.
3290
- * @format GUID
3291
- */
3292
- appId?: string;
3293
- }
3294
- declare enum WebhookIdentityType {
3295
- UNKNOWN = "UNKNOWN",
3296
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3297
- MEMBER = "MEMBER",
3298
- WIX_USER = "WIX_USER",
3299
- APP = "APP"
3300
- }
3301
- /** @enumType */
3302
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3303
- interface AccountInfo {
3304
- /**
3305
- * ID of the Wix account associated with the event.
3306
- * @format GUID
3307
- */
3308
- accountId?: string | null;
3309
- /**
3310
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
3311
- * @format GUID
3312
- */
3313
- parentAccountId?: string | null;
3314
- /**
3315
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3316
- * @format GUID
3317
- */
3318
- siteId?: string | null;
3319
- }
3320
- /** Get Blog Publications Count Stats request */
3321
- interface QueryPublicationsCountStatsRequest {
3322
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3323
- rangeStart?: Date | null;
3324
- /** Non-inclusive end of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3325
- rangeEnd?: Date | null;
3326
- /** Order of the returned results. */
3327
- order?: QueryPublicationsCountStatsRequestOrderWithLiterals;
3328
- /** Number of months to include in the response. */
3329
- months?: number;
3466
+ interface ListDemoPostsRequest {
3330
3467
  /**
3331
- * Language filter
3468
+ * Whether to return only featured posts.
3332
3469
  *
3333
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3334
- * @format LANGUAGE_TAG
3470
+ * Default: `false`
3335
3471
  */
3336
- language?: string | null;
3472
+ featured?: boolean;
3337
3473
  /**
3338
- * Timezone of the client.
3339
- * @minLength 3
3474
+ * Hashtag filter.
3475
+ *
3476
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3477
+ * If omitted, all posts with or without hashtags are returned.
3478
+ * @maxSize 100
3340
3479
  * @maxLength 100
3341
3480
  */
3342
- timeZone?: string | null;
3343
- }
3344
- declare enum QueryPublicationsCountStatsRequestOrder {
3345
- UNKNOWN = "UNKNOWN",
3346
- OLDEST = "OLDEST",
3347
- NEWEST = "NEWEST"
3348
- }
3349
- /** @enumType */
3350
- type QueryPublicationsCountStatsRequestOrderWithLiterals = QueryPublicationsCountStatsRequestOrder | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3351
- /** Get Blog Publications Count Stats response */
3352
- interface QueryPublicationsCountStatsResponse {
3353
- /** Chronologically ordered list of publications. */
3354
- stats?: PeriodPublicationsCount[];
3355
- }
3356
- /** Publications count for a specific time period */
3357
- interface PeriodPublicationsCount {
3358
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3359
- periodStart?: Date | null;
3360
- /** Number of posts published during this month. */
3361
- publicationsCount?: number;
3362
- }
3363
- /** Get Blog Post Count Stats request */
3364
- interface QueryPostCountStatsRequest {
3365
- /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3366
- rangeStart?: Date | null;
3481
+ hashtags?: string[];
3367
3482
  /**
3368
- * Order of returned results.
3369
- *
3370
- * - `OLDEST`: posts by date in ascending order.
3371
- * - `NEWEST`: posts by date in descending order.
3483
+ * Category filter.
3372
3484
  *
3373
- * Default: `OLDEST`
3485
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3486
+ * If omitted, all posts with or without associated categories are returned.
3487
+ * @maxSize 50
3488
+ * @format GUID
3374
3489
  */
3375
- order?: OrderWithLiterals;
3376
- /** Number of months to include in response. */
3377
- months?: number;
3490
+ categoryIds?: string[];
3378
3491
  /**
3379
- * Language filter.
3492
+ * Tag filter.
3380
3493
  *
3381
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3382
- * Pass a language to only receive the period post count for that specified language.
3383
- * @format LANGUAGE_TAG
3494
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3495
+ * If omitted, all posts with or without tags are returned.
3496
+ * @maxSize 50
3497
+ * @format GUID
3384
3498
  */
3385
- language?: string | null;
3499
+ tagIds?: string[];
3386
3500
  /**
3387
- * Time zone to use when calculating the start of the month.
3501
+ * Sorting options.
3388
3502
  *
3389
- * [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) format. For example, New York time zone is `-05`.
3390
- * @minLength 3
3391
- * @maxLength 100
3503
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3504
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3505
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3506
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3507
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3508
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3509
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3510
+ * - `RATING`: reserved for internal use.
3511
+ *
3512
+ * Default: `FEED`
3392
3513
  */
3393
- timeZone?: string | null;
3394
- }
3395
- declare enum Order {
3396
- UNKNOWN = "UNKNOWN",
3397
- OLDEST = "OLDEST",
3398
- NEWEST = "NEWEST"
3399
- }
3400
- /** @enumType */
3401
- type OrderWithLiterals = Order | 'UNKNOWN' | 'OLDEST' | 'NEWEST';
3402
- /** Get Blog Post Count Stats response */
3403
- interface QueryPostCountStatsResponse {
3404
- /** List of published post counts by month. */
3405
- stats?: PeriodPostCount[];
3406
- }
3407
- /** Post count for a specific time period */
3408
- interface PeriodPostCount {
3409
- /** Start of time range in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
3410
- periodStart?: Date | null;
3411
- /** Number of posts published during this month. */
3412
- postCount?: number;
3413
- }
3414
- interface GetTotalPublicationsRequest {
3514
+ sort?: GetPostsSortWithLiterals;
3515
+ /** Pagination options. */
3516
+ paging?: BlogPaging;
3415
3517
  /**
3416
- * Language filter
3417
- * @minLength 2
3418
- * @format LANGUAGE_TAG
3518
+ * __Deprecated.__ Use `fieldsets` instead.
3519
+ * This parameter will be removed on June 30, 2023.
3520
+ *
3521
+ * List of post fields to be included in the response.
3522
+ * @maxSize 20
3523
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3524
+ * This parameter will be removed on June 30, 2023.
3525
+ *
3526
+ * List of post fields to be included in the response.
3527
+ * @replacedBy fieldsets
3528
+ * @targetRemovalDate 2024-06-30
3419
3529
  */
3420
- language?: string | null;
3421
- }
3422
- interface GetTotalPublicationsResponse {
3423
- /** Total amount of publications. */
3424
- total?: number;
3425
- }
3426
- interface GetTotalPostsRequest {
3530
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3427
3531
  /**
3428
3532
  * Language filter.
3429
3533
  *
3430
3534
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3431
- * Pass a language to receive the total amount of posts in that specified language.
3535
+ * Pass a language to only receive posts that are in that language.
3536
+ * If omitted, posts in all languages are returned.
3432
3537
  * @format LANGUAGE_TAG
3433
3538
  */
3434
3539
  language?: string | null;
3540
+ /**
3541
+ * Post owner's member ID.
3542
+ * @format GUID
3543
+ */
3544
+ memberId?: string | null;
3545
+ /**
3546
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3547
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3548
+ * only the post’s base fields are returned.
3549
+ * @maxSize 20
3550
+ */
3551
+ fieldsets?: PostFieldFieldWithLiterals[];
3435
3552
  }
3436
- interface GetTotalPostsResponse {
3437
- /** Total amount of published posts. */
3438
- total?: number;
3553
+ declare enum GetPostsSort {
3554
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3555
+ FEED = "FEED",
3556
+ /** Ordered by `firstPublishedDate` in ascending order. */
3557
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3558
+ /** Ordered by `firstPublishedDate` in descending order. */
3559
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3560
+ /** Ordered by total number of views in descending order. */
3561
+ VIEW_COUNT = "VIEW_COUNT",
3562
+ /** Ordered by total number of likes in descending order. */
3563
+ LIKE_COUNT = "LIKE_COUNT",
3564
+ /** Ordered by `title` in ascending order. */
3565
+ TITLE_ASC = "TITLE_ASC",
3566
+ /** Ordered by `title` in descending order. */
3567
+ TITLE_DESC = "TITLE_DESC"
3439
3568
  }
3440
- interface GetTotalLikesPerMemberRequest {
3569
+ /** @enumType */
3570
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3571
+ declare enum PostFieldField {
3572
+ UNKNOWN = "UNKNOWN",
3573
+ /** Includes post URL when present. */
3574
+ URL = "URL",
3575
+ /** Includes post content text string when present. */
3576
+ CONTENT_TEXT = "CONTENT_TEXT",
3577
+ /** Includes post metrics when present. */
3578
+ METRICS = "METRICS",
3579
+ /** Includes SEO data. */
3580
+ SEO = "SEO",
3581
+ /** Includes post owner's contact ID. */
3582
+ CONTACT_ID = "CONTACT_ID",
3583
+ /** Includes post rich content. */
3584
+ RICH_CONTENT = "RICH_CONTENT",
3585
+ /** Includes post reference ID field. */
3586
+ REFERENCE_ID = "REFERENCE_ID"
3587
+ }
3588
+ /** @enumType */
3589
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3590
+ interface ListDemoPostsResponse {
3591
+ /** List of posts. */
3592
+ posts?: Post[];
3593
+ /** Details on the paged set of results returned. */
3594
+ metaData?: MetaData;
3595
+ }
3596
+ interface ConvertDraftJsToRichContentRequest {
3597
+ /** DraftJs content to convert to Rich content. */
3598
+ content?: Record<string, any> | null;
3599
+ }
3600
+ interface ConvertDraftJsToRichContentResponse {
3441
3601
  /**
3442
- * Member ID.
3443
- * @format GUID
3602
+ * Rich content converted from DraftJs content.
3603
+ * @maxLength 2000000
3444
3604
  */
3445
- memberId?: string;
3605
+ richContent?: string;
3446
3606
  }
3447
- interface GetTotalLikesPerMemberResponse {
3448
- /** The total number of likes of the member. */
3449
- total?: number;
3607
+ interface ConvertRichContentToDraftJsRequest {
3608
+ /**
3609
+ * Rich content to convert to DraftJs content.
3610
+ * @maxLength 2000000
3611
+ */
3612
+ richContent?: string;
3613
+ }
3614
+ interface ConvertRichContentToDraftJsResponse {
3615
+ /** DraftJs content converted from Rich content. */
3616
+ content?: Record<string, any> | null;
3450
3617
  }
3451
3618
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3452
3619
  /**
@@ -3517,25 +3684,6 @@ interface GetPostRequest {
3517
3684
  */
3518
3685
  fieldsets?: PostFieldFieldWithLiterals[];
3519
3686
  }
3520
- declare enum PostFieldField {
3521
- UNKNOWN = "UNKNOWN",
3522
- /** Includes post URL when present. */
3523
- URL = "URL",
3524
- /** Includes post content text string when present. */
3525
- CONTENT_TEXT = "CONTENT_TEXT",
3526
- /** Includes post metrics when present. */
3527
- METRICS = "METRICS",
3528
- /** Includes SEO data. */
3529
- SEO = "SEO",
3530
- /** Includes post owner's contact ID. */
3531
- CONTACT_ID = "CONTACT_ID",
3532
- /** Includes post rich content. */
3533
- RICH_CONTENT = "RICH_CONTENT",
3534
- /** Includes post reference ID field. */
3535
- REFERENCE_ID = "REFERENCE_ID"
3536
- }
3537
- /** @enumType */
3538
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3539
3687
  interface GetPostResponse {
3540
3688
  /** Retrieved post info. */
3541
3689
  post?: Post;
@@ -3628,24 +3776,6 @@ interface ListPostsRequest {
3628
3776
  */
3629
3777
  fieldsets?: PostFieldFieldWithLiterals[];
3630
3778
  }
3631
- declare enum GetPostsSort {
3632
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3633
- FEED = "FEED",
3634
- /** Ordered by `firstPublishedDate` in ascending order. */
3635
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3636
- /** Ordered by `firstPublishedDate` in descending order. */
3637
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3638
- /** Ordered by total number of views in descending order. */
3639
- VIEW_COUNT = "VIEW_COUNT",
3640
- /** Ordered by total number of likes in descending order. */
3641
- LIKE_COUNT = "LIKE_COUNT",
3642
- /** Ordered by `title` in ascending order. */
3643
- TITLE_ASC = "TITLE_ASC",
3644
- /** Ordered by `title` in descending order. */
3645
- TITLE_DESC = "TITLE_DESC"
3646
- }
3647
- /** @enumType */
3648
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3649
3779
  interface ListPostsResponse {
3650
3780
  /** List of retrieved posts. */
3651
3781
  posts?: Post[];
@@ -3995,121 +4125,6 @@ interface PostCount {
3995
4125
  /** Number of posts. */
3996
4126
  postCount?: number;
3997
4127
  }
3998
- interface ListDemoPostsRequest {
3999
- /**
4000
- * Whether to return only featured posts.
4001
- *
4002
- * Default: `false`
4003
- */
4004
- featured?: boolean;
4005
- /**
4006
- * Hashtag filter.
4007
- *
4008
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
4009
- * If omitted, all posts with or without hashtags are returned.
4010
- * @maxSize 100
4011
- * @maxLength 100
4012
- */
4013
- hashtags?: string[];
4014
- /**
4015
- * Category filter.
4016
- *
4017
- * Pass an array of category IDs to return only posts with any of the provided categories.
4018
- * If omitted, all posts with or without associated categories are returned.
4019
- * @maxSize 50
4020
- * @format GUID
4021
- */
4022
- categoryIds?: string[];
4023
- /**
4024
- * Tag filter.
4025
- *
4026
- * Pass an array of tag IDs to return only posts with any of the provided tags.
4027
- * If omitted, all posts with or without tags are returned.
4028
- * @maxSize 50
4029
- * @format GUID
4030
- */
4031
- tagIds?: string[];
4032
- /**
4033
- * Sorting options.
4034
- *
4035
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
4036
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
4037
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
4038
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
4039
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
4040
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
4041
- * - `TITLE_DESC`: Ordered by `title` in descending order.
4042
- * - `RATING`: reserved for internal use.
4043
- *
4044
- * Default: `FEED`
4045
- */
4046
- sort?: GetPostsSortWithLiterals;
4047
- /** Pagination options. */
4048
- paging?: BlogPaging;
4049
- /**
4050
- * __Deprecated.__ Use `fieldsets` instead.
4051
- * This parameter will be removed on June 30, 2023.
4052
- *
4053
- * List of post fields to be included in the response.
4054
- * @maxSize 20
4055
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
4056
- * This parameter will be removed on June 30, 2023.
4057
- *
4058
- * List of post fields to be included in the response.
4059
- * @replacedBy fieldsets
4060
- * @targetRemovalDate 2024-06-30
4061
- */
4062
- fieldsToInclude?: PostFieldFieldWithLiterals[];
4063
- /**
4064
- * Language filter.
4065
- *
4066
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
4067
- * Pass a language to only receive posts that are in that language.
4068
- * If omitted, posts in all languages are returned.
4069
- * @format LANGUAGE_TAG
4070
- */
4071
- language?: string | null;
4072
- /**
4073
- * Post owner's member ID.
4074
- * @format GUID
4075
- */
4076
- memberId?: string | null;
4077
- /**
4078
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
4079
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
4080
- * only the post’s base fields are returned.
4081
- * @maxSize 20
4082
- */
4083
- fieldsets?: PostFieldFieldWithLiterals[];
4084
- }
4085
- interface ListDemoPostsResponse {
4086
- /** List of posts. */
4087
- posts?: Post[];
4088
- /** Details on the paged set of results returned. */
4089
- metaData?: MetaData;
4090
- }
4091
- interface ConvertDraftJsToRichContentRequest {
4092
- /** DraftJs content to convert to Rich content. */
4093
- content?: Record<string, any> | null;
4094
- }
4095
- interface ConvertDraftJsToRichContentResponse {
4096
- /**
4097
- * Rich content converted from DraftJs content.
4098
- * @maxLength 2000000
4099
- */
4100
- richContent?: string;
4101
- }
4102
- interface ConvertRichContentToDraftJsRequest {
4103
- /**
4104
- * Rich content to convert to DraftJs content.
4105
- * @maxLength 2000000
4106
- */
4107
- richContent?: string;
4108
- }
4109
- interface ConvertRichContentToDraftJsResponse {
4110
- /** DraftJs content converted from Rich content. */
4111
- content?: Record<string, any> | null;
4112
- }
4113
4128
  interface BaseEventMetadata {
4114
4129
  /**
4115
4130
  * App instance ID.