@wix/auto_sdk_blog_draft-posts 1.0.2 → 1.0.4

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 (61) hide show
  1. package/build/cjs/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
  2. package/build/cjs/src/blog-v3-draft-draft-posts.context.js +5 -4
  3. package/build/cjs/src/blog-v3-draft-draft-posts.context.js.map +1 -1
  4. package/build/cjs/src/blog-v3-draft-draft-posts.http.d.ts +25 -33
  5. package/build/cjs/src/blog-v3-draft-draft-posts.http.js +25 -33
  6. package/build/cjs/src/blog-v3-draft-draft-posts.http.js.map +1 -1
  7. package/build/cjs/src/blog-v3-draft-draft-posts.public.d.ts +23 -23
  8. package/build/cjs/src/blog-v3-draft-draft-posts.public.js +3 -2
  9. package/build/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -1
  10. package/build/cjs/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
  11. package/build/cjs/src/blog-v3-draft-draft-posts.types.js +27 -16
  12. package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
  13. package/build/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +893 -392
  14. package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +50 -39
  15. package/build/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
  16. package/build/es/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
  17. package/build/es/src/blog-v3-draft-draft-posts.context.js +1 -1
  18. package/build/es/src/blog-v3-draft-draft-posts.context.js.map +1 -1
  19. package/build/es/src/blog-v3-draft-draft-posts.http.d.ts +25 -33
  20. package/build/es/src/blog-v3-draft-draft-posts.http.js +25 -33
  21. package/build/es/src/blog-v3-draft-draft-posts.http.js.map +1 -1
  22. package/build/es/src/blog-v3-draft-draft-posts.public.d.ts +23 -23
  23. package/build/es/src/blog-v3-draft-draft-posts.public.js +1 -1
  24. package/build/es/src/blog-v3-draft-draft-posts.public.js.map +1 -1
  25. package/build/es/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
  26. package/build/es/src/blog-v3-draft-draft-posts.types.js +26 -15
  27. package/build/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
  28. package/build/es/src/blog-v3-draft-draft-posts.universal.d.ts +893 -392
  29. package/build/es/src/blog-v3-draft-draft-posts.universal.js +48 -37
  30. package/build/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
  31. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
  32. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js +5 -4
  33. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js.map +1 -1
  34. package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.d.ts +25 -33
  35. package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js +25 -33
  36. package/build/internal/cjs/src/blog-v3-draft-draft-posts.http.js.map +1 -1
  37. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.d.ts +23 -23
  38. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js +3 -2
  39. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -1
  40. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
  41. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +27 -16
  42. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
  43. package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +880 -395
  44. package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +50 -39
  45. package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
  46. package/build/internal/es/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
  47. package/build/internal/es/src/blog-v3-draft-draft-posts.context.js +1 -1
  48. package/build/internal/es/src/blog-v3-draft-draft-posts.context.js.map +1 -1
  49. package/build/internal/es/src/blog-v3-draft-draft-posts.http.d.ts +25 -33
  50. package/build/internal/es/src/blog-v3-draft-draft-posts.http.js +25 -33
  51. package/build/internal/es/src/blog-v3-draft-draft-posts.http.js.map +1 -1
  52. package/build/internal/es/src/blog-v3-draft-draft-posts.public.d.ts +23 -23
  53. package/build/internal/es/src/blog-v3-draft-draft-posts.public.js +1 -1
  54. package/build/internal/es/src/blog-v3-draft-draft-posts.public.js.map +1 -1
  55. package/build/internal/es/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
  56. package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +26 -15
  57. package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
  58. package/build/internal/es/src/blog-v3-draft-draft-posts.universal.d.ts +880 -395
  59. package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +48 -37
  60. package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
  61. package/package.json +2 -2
@@ -2,24 +2,40 @@ export interface DraftPost {
2
2
  /**
3
3
  * Draft post ID.
4
4
  * @readonly
5
+ * @maxLength 38
5
6
  */
6
7
  _id?: string;
7
- /** Draft post title. */
8
+ /**
9
+ * Draft post title.
10
+ * @maxLength 200
11
+ */
8
12
  title?: string;
9
13
  /**
10
14
  * Draft post excerpt.
11
15
  *
12
16
  * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
13
17
  * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
18
+ * @maxLength 500
14
19
  */
15
20
  excerpt?: string | null;
16
21
  /** Whether the draft post is marked as featured. */
17
22
  featured?: boolean | null;
18
- /** Category IDs of the draft post. */
23
+ /**
24
+ * Category IDs of the draft post.
25
+ * @maxSize 10
26
+ * @maxLength 38
27
+ */
19
28
  categoryIds?: string[];
20
- /** Draft post owner's member ID. */
29
+ /**
30
+ * Draft post owner's member ID.
31
+ * @format GUID
32
+ */
21
33
  memberId?: string | null;
22
- /** Hashtags in the draft post. */
34
+ /**
35
+ * Hashtags in the post.
36
+ * @maxSize 100
37
+ * @maxLength 100
38
+ */
23
39
  hashtags?: string[];
24
40
  /** Whether commenting on the draft post is enabled. */
25
41
  commentingEnabled?: boolean | null;
@@ -30,23 +46,37 @@ export interface DraftPost {
30
46
  minutesToRead?: number;
31
47
  /** Image placed at the top of the blog page. */
32
48
  heroImage?: string;
33
- /** Tag IDs the draft post is tagged with. */
49
+ /**
50
+ * Tag IDs the draft post is tagged with.
51
+ * @maxSize 30
52
+ * @maxLength 38
53
+ */
34
54
  tagIds?: string[];
35
- /** IDs of posts related to this draft post. */
55
+ /**
56
+ * IDs of posts related to this draft post.
57
+ * @maxSize 3
58
+ * @maxLength 38
59
+ */
36
60
  relatedPostIds?: string[];
37
- /** Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. */
61
+ /**
62
+ * [Pricing plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans). Only relevant if a post is assigned to a specific pricing plan.
63
+ * @maxSize 100
64
+ * @format GUID
65
+ */
38
66
  pricingPlanIds?: string[];
39
67
  /**
40
68
  * ID of the draft post's translations.
41
69
  *
42
70
  * All translations of a single post share the same `translationId`.
43
71
  * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
72
+ * @format GUID
44
73
  */
45
74
  translationId?: string | null;
46
75
  /**
47
76
  * Language the draft post is written in.
48
77
  *
49
78
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
79
+ * @format LANGUAGE_TAG
50
80
  */
51
81
  language?: string | null;
52
82
  /**
@@ -57,11 +87,21 @@ export interface DraftPost {
57
87
  /**
58
88
  * Reserved for internal use.
59
89
  * @readonly
90
+ * @maxLength 24
60
91
  */
61
92
  contentId?: string | null;
62
- /** Reserved for internal use. */
93
+ /**
94
+ * Reserved for internal use.
95
+ * @format GUID
96
+ */
63
97
  editingSessionId?: string | null;
64
- /** Draft post rich content. */
98
+ /**
99
+ * Draft Post rich content.
100
+ *
101
+ * <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">
102
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
103
+ * </widget>
104
+ */
65
105
  richContent?: RichContent;
66
106
  /**
67
107
  * Status of the draft post.
@@ -73,6 +113,7 @@ export interface DraftPost {
73
113
  /**
74
114
  * Reserved for internal use.
75
115
  * @readonly
116
+ * @format GUID
76
117
  */
77
118
  mostRecentContributorId?: string | null;
78
119
  /**
@@ -96,9 +137,18 @@ export interface DraftPost {
96
137
  firstPublishedDate?: Date | null;
97
138
  /** SEO data. */
98
139
  seoData?: SeoSchema;
140
+ /**
141
+ * Reserved for internal use.
142
+ * @deprecated
143
+ * @replacedBy preview_text_paragraph
144
+ * @targetRemovalDate 2024-06-30
145
+ */
146
+ paidContentParagraph?: number | null;
99
147
  /**
100
148
  * Reserved for internal use.
101
149
  * @readonly
150
+ * @maxSize 5000
151
+ * @maxLength 100
102
152
  */
103
153
  slugs?: string[];
104
154
  /**
@@ -111,7 +161,10 @@ export interface DraftPost {
111
161
  * @readonly
112
162
  */
113
163
  _createdDate?: Date | null;
114
- /** SEO slug. */
164
+ /**
165
+ * SEO slug.
166
+ * @maxLength 100
167
+ */
115
168
  seoSlug?: string | null;
116
169
  /** Post cover media. */
117
170
  media?: Media;
@@ -120,6 +173,7 @@ export interface DraftPost {
120
173
  /**
121
174
  * Reserved for internal use.
122
175
  * @readonly
176
+ * @maxLength 24
123
177
  */
124
178
  internalId?: string | null;
125
179
  }
@@ -141,7 +195,11 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
141
195
  displayed?: boolean;
142
196
  /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
143
197
  custom?: boolean;
144
- /** Media alternative text. */
198
+ /**
199
+ * Media alternative text.
200
+ * @minLength 1
201
+ * @maxLength 1000
202
+ */
145
203
  altText?: string | null;
146
204
  }
147
205
  /** @oneof */
@@ -518,7 +576,7 @@ export interface Link extends LinkDataOneOf {
518
576
  /** The target node's ID. Used for linking to another node in this object. */
519
577
  anchor?: string;
520
578
  /**
521
- * The HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
579
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
522
580
  * `SELF` - Default. Opens the linked document in the same frame as the link.
523
581
  * `BLANK` - Opens the linked document in a new browser tab or window.
524
582
  * `PARENT` - Opens the linked document in the link's parent frame.
@@ -554,7 +612,7 @@ export interface Rel {
554
612
  sponsored?: boolean | null;
555
613
  /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
556
614
  ugc?: boolean | null;
557
- /** Indicates that this link protects referral information from being passed to the target website. */
615
+ /** Indicates that this link protect referral information from being passed to the target website. */
558
616
  noreferrer?: boolean | null;
559
617
  }
560
618
  export interface CodeBlockData {
@@ -832,11 +890,20 @@ export interface GIFData {
832
890
  gifType?: GIFType;
833
891
  }
834
892
  export interface GIF {
835
- /** GIF format URL. */
893
+ /**
894
+ * GIF format URL.
895
+ * @format WEB_URL
896
+ */
836
897
  gif?: string | null;
837
- /** MP4 format URL. */
898
+ /**
899
+ * MP4 format URL.
900
+ * @format WEB_URL
901
+ */
838
902
  mp4?: string | null;
839
- /** Thumbnail URL. */
903
+ /**
904
+ * Thumbnail URL.
905
+ * @format WEB_URL
906
+ */
840
907
  still?: string | null;
841
908
  }
842
909
  export declare enum GIFType {
@@ -902,6 +969,25 @@ export interface ImageData {
902
969
  caption?: string | null;
903
970
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
904
971
  disableDownload?: boolean | null;
972
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
973
+ decorative?: boolean | null;
974
+ /** Styling for the image. */
975
+ styles?: ImageDataStyles;
976
+ }
977
+ export interface StylesBorder {
978
+ /** Border width in pixels. */
979
+ width?: number | null;
980
+ /**
981
+ * Border color as a hexadecimal value.
982
+ * @format COLOR_HEX
983
+ */
984
+ color?: string | null;
985
+ /** Border radius in pixels. */
986
+ radius?: number | null;
987
+ }
988
+ export interface ImageDataStyles {
989
+ /** Border attributes. */
990
+ border?: StylesBorder;
905
991
  }
906
992
  export interface LinkPreviewData {
907
993
  /** Styling for the link preview's container. */
@@ -916,6 +1002,51 @@ export interface LinkPreviewData {
916
1002
  description?: string | null;
917
1003
  /** The preview content as HTML. */
918
1004
  html?: string | null;
1005
+ /** Styling for the link preview. */
1006
+ styles?: LinkPreviewDataStyles;
1007
+ }
1008
+ export declare enum Position {
1009
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
1010
+ START = "START",
1011
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
1012
+ END = "END",
1013
+ /** Thumbnail positioned at the top */
1014
+ TOP = "TOP",
1015
+ /** Thumbnail hidden and not displayed */
1016
+ HIDDEN = "HIDDEN"
1017
+ }
1018
+ export interface LinkPreviewDataStyles {
1019
+ /**
1020
+ * Background color as a hexadecimal value.
1021
+ * @format COLOR_HEX
1022
+ */
1023
+ backgroundColor?: string | null;
1024
+ /**
1025
+ * Title color as a hexadecimal value.
1026
+ * @format COLOR_HEX
1027
+ */
1028
+ titleColor?: string | null;
1029
+ /**
1030
+ * Subtitle color as a hexadecimal value.
1031
+ * @format COLOR_HEX
1032
+ */
1033
+ subtitleColor?: string | null;
1034
+ /**
1035
+ * Link color as a hexadecimal value.
1036
+ * @format COLOR_HEX
1037
+ */
1038
+ linkColor?: string | null;
1039
+ /** Border width in pixels. */
1040
+ borderWidth?: number | null;
1041
+ /** Border radius in pixels. */
1042
+ borderRadius?: number | null;
1043
+ /**
1044
+ * Border color as a hexadecimal value.
1045
+ * @format COLOR_HEX
1046
+ */
1047
+ borderColor?: string | null;
1048
+ /** Position of thumbnail. Defaults to `START`. */
1049
+ thumbnailPosition?: Position;
919
1050
  }
920
1051
  export interface MapData {
921
1052
  /** Styling for the map's container. */
@@ -1048,13 +1179,22 @@ export declare enum BackgroundType {
1048
1179
  export interface Gradient {
1049
1180
  /** The gradient angle in degrees. */
1050
1181
  angle?: number | null;
1051
- /** The start color as a hexademical value. */
1182
+ /**
1183
+ * The start color as a hexademical value.
1184
+ * @format COLOR_HEX
1185
+ */
1052
1186
  startColor?: string | null;
1053
- /** The end color as a hexademical value. */
1187
+ /**
1188
+ * The end color as a hexademical value.
1189
+ * @format COLOR_HEX
1190
+ */
1054
1191
  lastColor?: string | null;
1055
1192
  }
1056
1193
  export interface Background extends BackgroundBackgroundOneOf {
1057
- /** The background color as a hexademical value. */
1194
+ /**
1195
+ * The background color as a hexademical value.
1196
+ * @format COLOR_HEX
1197
+ */
1058
1198
  color?: string | null;
1059
1199
  /** An image to use for the background. */
1060
1200
  image?: V1Media;
@@ -1065,7 +1205,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1065
1205
  }
1066
1206
  /** @oneof */
1067
1207
  export interface BackgroundBackgroundOneOf {
1068
- /** The background color as a hexademical value. */
1208
+ /**
1209
+ * The background color as a hexademical value.
1210
+ * @format COLOR_HEX
1211
+ */
1069
1212
  color?: string | null;
1070
1213
  /** An image to use for the background. */
1071
1214
  image?: V1Media;
@@ -1377,17 +1520,32 @@ export declare enum VerticalAlignment {
1377
1520
  export interface CellStyle {
1378
1521
  /** Vertical alignment for the cell's text. */
1379
1522
  verticalAlignment?: VerticalAlignment;
1380
- /** Cell background color as a hexadecimal value. */
1523
+ /**
1524
+ * Cell background color as a hexadecimal value.
1525
+ * @format COLOR_HEX
1526
+ */
1381
1527
  backgroundColor?: string | null;
1382
1528
  }
1383
1529
  export interface BorderColors {
1384
- /** Left border color as a hexadecimal value. */
1530
+ /**
1531
+ * Left border color as a hexadecimal value.
1532
+ * @format COLOR_HEX
1533
+ */
1385
1534
  left?: string | null;
1386
- /** Right border color as a hexadecimal value. */
1535
+ /**
1536
+ * Right border color as a hexadecimal value.
1537
+ * @format COLOR_HEX
1538
+ */
1387
1539
  right?: string | null;
1388
- /** Top border color as a hexadecimal value. */
1540
+ /**
1541
+ * Top border color as a hexadecimal value.
1542
+ * @format COLOR_HEX
1543
+ */
1389
1544
  top?: string | null;
1390
- /** Bottom border color as a hexadecimal value. */
1545
+ /**
1546
+ * Bottom border color as a hexadecimal value.
1547
+ * @format COLOR_HEX
1548
+ */
1391
1549
  bottom?: string | null;
1392
1550
  }
1393
1551
  /**
@@ -1515,13 +1673,19 @@ export declare enum Status {
1515
1673
  IN_REVIEW = "IN_REVIEW"
1516
1674
  }
1517
1675
  export interface ModerationDetails {
1518
- /** Member ID of the person submitting the draft post for review. */
1676
+ /**
1677
+ * Member ID of the person submitting the draft post for review.
1678
+ * @format GUID
1679
+ */
1519
1680
  submittedBy?: string;
1520
1681
  /** Date the post was submitted for review. */
1521
1682
  submittedDate?: Date | null;
1522
1683
  /** Status indicating whether the submission was approved or rejected by the moderator. */
1523
1684
  status?: ModerationStatusStatus;
1524
- /** Member ID of the person who approved or rejected the post. */
1685
+ /**
1686
+ * Member ID of the person who approved or rejected the post.
1687
+ * @format GUID
1688
+ */
1525
1689
  moderatedBy?: string | null;
1526
1690
  /** Date the post was approved or rejected. */
1527
1691
  moderationDate?: Date | null;
@@ -1547,7 +1711,10 @@ export interface Keyword {
1547
1711
  term?: string;
1548
1712
  /** Whether the keyword is the main focus keyword. */
1549
1713
  isMain?: boolean;
1550
- /** The source that added the keyword terms to the SEO settings. */
1714
+ /**
1715
+ * The source that added the keyword terms to the SEO settings.
1716
+ * @maxLength 1000
1717
+ */
1551
1718
  origin?: string | null;
1552
1719
  }
1553
1720
  export interface Tag {
@@ -1580,7 +1747,10 @@ export interface Settings {
1580
1747
  * Default: `false` (Auto Redirect is enabled.)
1581
1748
  */
1582
1749
  preventAutoRedirect?: boolean;
1583
- /** User-selected keyword terms for a specific page. */
1750
+ /**
1751
+ * User-selected keyword terms for a specific page.
1752
+ * @maxSize 5
1753
+ */
1584
1754
  keywords?: Keyword[];
1585
1755
  }
1586
1756
  export interface Media extends MediaMediaOneOf {
@@ -1592,7 +1762,11 @@ export interface Media extends MediaMediaOneOf {
1592
1762
  displayed?: boolean;
1593
1763
  /** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
1594
1764
  custom?: boolean;
1595
- /** Media alternative text. */
1765
+ /**
1766
+ * Media alternative text.
1767
+ * @minLength 1
1768
+ * @maxLength 1000
1769
+ */
1596
1770
  altText?: string | null;
1597
1771
  }
1598
1772
  /** @oneof */
@@ -1625,7 +1799,10 @@ export interface EmbedMedia {
1625
1799
  video?: EmbedVideo;
1626
1800
  }
1627
1801
  export interface EmbedThumbnail {
1628
- /** Thumbnail url. */
1802
+ /**
1803
+ * Thumbnail url.
1804
+ * @maxLength 2000
1805
+ */
1629
1806
  url?: string;
1630
1807
  /** Thumbnail width. */
1631
1808
  width?: number;
@@ -1633,7 +1810,10 @@ export interface EmbedThumbnail {
1633
1810
  height?: number;
1634
1811
  }
1635
1812
  export interface EmbedVideo {
1636
- /** Video url. */
1813
+ /**
1814
+ * Video url.
1815
+ * @maxLength 2000
1816
+ */
1637
1817
  url?: string;
1638
1818
  /** Video width. */
1639
1819
  width?: number;
@@ -1641,171 +1821,380 @@ export interface EmbedVideo {
1641
1821
  height?: number;
1642
1822
  }
1643
1823
  export interface DraftPostTranslation {
1644
- /** Post ID. */
1824
+ /**
1825
+ * Post ID.
1826
+ * @format GUID
1827
+ */
1645
1828
  _id?: string;
1646
1829
  /** Post status. */
1647
1830
  status?: Status;
1648
- /** Language the post is written in. */
1831
+ /**
1832
+ * Language the post is written in.
1833
+ * @format LANGUAGE_TAG
1834
+ */
1649
1835
  language?: string | null;
1650
- /** Post slug. For example, 'post-slug'. */
1836
+ /**
1837
+ * Post slug. For example, 'post-slug'.
1838
+ * @maxLength 100
1839
+ */
1651
1840
  slug?: string | null;
1652
1841
  /** SEO data. */
1653
1842
  seoData?: SeoSchema;
1654
1843
  /** Post URL. */
1655
1844
  url?: string;
1656
1845
  }
1657
- export interface InitialDraftPostsCopied {
1658
- /** Number of draft posts copied. */
1659
- count?: number;
1660
- }
1661
1846
  export interface DraftCategoriesUpdated {
1662
- /** Draft post ID. */
1847
+ /**
1848
+ * Draft post ID.
1849
+ * @maxLength 38
1850
+ */
1663
1851
  draftPostId?: string;
1664
- /** Current categories of the draft. */
1852
+ /**
1853
+ * Current categories of the draft.
1854
+ * @maxSize 10
1855
+ * @format GUID
1856
+ */
1665
1857
  categories?: string[];
1666
- /** Previous categories of the draft. */
1858
+ /**
1859
+ * Previous categories of the draft.
1860
+ * @maxSize 10
1861
+ * @format GUID
1862
+ */
1667
1863
  previousCategories?: string[];
1668
1864
  }
1669
1865
  export interface DraftTagsUpdated {
1670
- /** Draft post ID. */
1866
+ /**
1867
+ * Draft post ID.
1868
+ * @maxLength 38
1869
+ */
1671
1870
  draftPostId?: string;
1672
- /** Current tags of the draft. */
1673
- tags?: string[];
1674
- /** Previous tags of the draft. */
1675
- previousTags?: string[];
1676
- }
1677
- export interface CreateDraftPostRequest {
1678
- /** Draft post to create. */
1679
- draftPost: DraftPost;
1680
1871
  /**
1681
- * Whether the draft post should be published on creation.
1682
- *
1683
- * Default: `false`
1872
+ * Current tags of the draft.
1873
+ * @maxSize 30
1874
+ * @format GUID
1684
1875
  */
1685
- publish?: boolean;
1876
+ tags?: string[];
1686
1877
  /**
1687
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1688
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
1689
- * only the draft post's base fields are returned.
1878
+ * Previous tags of the draft.
1879
+ * @maxSize 30
1880
+ * @format GUID
1690
1881
  */
1691
- fieldsets?: Field[];
1692
- }
1693
- export declare enum Type {
1694
- UNKNOWN = "UNKNOWN",
1695
- /** Manually saved. */
1696
- MANUAL = "MANUAL",
1697
- /** Triggered by autosave. */
1698
- AUTO_SAVE = "AUTO_SAVE",
1699
- /** Copied from template during provisioning flow. */
1700
- PROVISIONING = "PROVISIONING",
1701
- /** Imported from another blog. */
1702
- IMPORT = "IMPORT",
1703
- /** Triggered by autosave when post created by AI tool. */
1704
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
1882
+ previousTags?: string[];
1705
1883
  }
1706
- export declare enum Field {
1707
- /** Unknown field. */
1708
- UNKNOWN = "UNKNOWN",
1709
- /** Includes draft post preview URL. */
1710
- URL = "URL",
1884
+ export interface GetDraftPostTotalsRequest {
1711
1885
  /**
1712
- * Includes internal id field.
1713
- * Reserved for internal use.
1886
+ * Group results by fields (defaults to grouping by status).
1887
+ * If, for example, grouping by language is passed, language values in response will be filled.
1888
+ * If, for example, grouping by language is not passed, null values will be filled in language field in response.
1889
+ * @maxSize 10
1714
1890
  */
1715
- INTERNAL_ID = "INTERNAL_ID",
1716
- /** Includes content field. */
1717
- CONTENT = "CONTENT",
1718
- /** Includes rich content field. */
1719
- RICH_CONTENT = "RICH_CONTENT",
1720
- /** If the user has not set excerpt, returns the one autogenerated from content. */
1721
- GENERATED_EXCERPT = "GENERATED_EXCERPT"
1722
- }
1723
- export interface CreateDraftPostResponse {
1724
- /** Created draft post info. */
1725
- draftPost?: DraftPost;
1726
- }
1727
- export interface BulkCreateDraftPostsRequest {
1728
- /** Draft posts to create. */
1729
- draftPosts: DraftPost[];
1730
- /** Whether the draft post should be published after creation. */
1731
- publish?: boolean;
1732
- /** Whether to return the full created draft post entities in the response. */
1733
- returnFullEntity?: boolean;
1891
+ groupBy?: TotalDraftPostsGroupingField[];
1734
1892
  /**
1735
- * List of draft post fields to be included in the response if the entities are present.
1736
- * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
1737
- * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
1893
+ * Optional language filter by provided language code. Useful in multilingual context.
1894
+ * @format LANGUAGE_TAG
1738
1895
  */
1739
- fieldsets?: Field[];
1740
- }
1741
- export interface BulkCreateDraftPostsResponse {
1742
- /** Draft posts created by bulk action. */
1743
- results?: BulkDraftPostResult[];
1744
- /** Bulk action metadata. */
1745
- bulkActionMetadata?: BulkActionMetadata;
1746
- }
1747
- export interface BulkDraftPostResult {
1748
- /** Bulk actions metadata for draft post. */
1749
- itemMetadata?: ItemMetadata;
1750
- /** Optional full draft post. */
1751
- item?: DraftPost;
1896
+ language?: string | null;
1752
1897
  }
1753
- export interface ItemMetadata {
1754
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1755
- _id?: string | null;
1756
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1757
- originalIndex?: number;
1758
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1759
- success?: boolean;
1760
- /** Details about the error in case of failure. */
1761
- error?: ApplicationError;
1898
+ export declare enum TotalDraftPostsGroupingField {
1899
+ /** Groups results by status. */
1900
+ STATUS = "STATUS",
1901
+ /** Groups results by language. */
1902
+ LANGUAGE = "LANGUAGE"
1762
1903
  }
1763
- export interface ApplicationError {
1764
- /** Error code. */
1765
- code?: string;
1766
- /** Description of the error. */
1767
- description?: string;
1768
- /** Data related to the error. */
1769
- data?: Record<string, any> | null;
1904
+ export interface GetDraftPostTotalsResponse {
1905
+ /** Draft post totals. */
1906
+ totalDraftPosts?: TotalDraftPosts[];
1770
1907
  }
1771
- export interface BulkActionMetadata {
1772
- /** Number of items that were successfully processed. */
1773
- totalSuccesses?: number;
1774
- /** Number of items that couldn't be processed. */
1775
- totalFailures?: number;
1776
- /** Number of failures without details because detailed failure threshold was exceeded. */
1777
- undetailedFailures?: number;
1908
+ export interface TotalDraftPosts {
1909
+ /** Draft post totals in that group. */
1910
+ total?: number;
1911
+ /** Draft post status (only has value when grouping by status, otherwise null). */
1912
+ status?: Status;
1913
+ /**
1914
+ * Draft post language code (only has value when grouping by language, otherwise null).
1915
+ * @format LANGUAGE_TAG
1916
+ */
1917
+ language?: string | null;
1778
1918
  }
1779
- export interface BulkUpdateDraftPostsRequest {
1780
- /** Draft posts to update. */
1781
- draftPosts?: MaskedDraftPosts[];
1919
+ export interface DomainEvent extends DomainEventBodyOneOf {
1920
+ createdEvent?: EntityCreatedEvent;
1921
+ updatedEvent?: EntityUpdatedEvent;
1922
+ deletedEvent?: EntityDeletedEvent;
1923
+ actionEvent?: ActionEvent;
1782
1924
  /**
1783
- * Action to perform on the posts.
1784
- *
1785
- * - `UPDATE`: Update the draft post.
1786
- * - `UPDATE_PUBLISH`: Update and publish the draft post.
1787
- * - `UPDATE_SCHEDULE`: Update the draft post and schedule a publish date.
1788
- * - `UPDATE_REVERT_TO_DRAFT`: Update the post and revert it to a draft post.
1789
- * - `UPDATE_CANCEL_SCHEDULE`: Update the draft post and cancel the scheduled publish date.
1790
- * - `UPDATE_REJECT`: Update and reject the draft post.
1791
- * - `UPDATE_PUBLICATION`: Update a published post. This creates and updates a draft version of the post. The original post is still published.
1792
- *
1793
- * Default: `UPDATE`
1925
+ * Unique event ID.
1926
+ * Allows clients to ignore duplicate webhooks.
1794
1927
  */
1795
- action?: Action;
1796
- /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
1797
- scheduledPublishDate?: Date | null;
1798
- /** Whether to return the full updated draft post entities in the response. */
1799
- returnFullEntity?: boolean;
1928
+ _id?: string;
1800
1929
  /**
1801
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1802
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
1803
- * only the draft post's base fields are returned.
1930
+ * Assumes actions are also always typed to an entity_type
1931
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1804
1932
  */
1805
- fieldsets?: Field[];
1806
- }
1933
+ entityFqdn?: string;
1934
+ /**
1935
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1936
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1937
+ * Example: created/updated/deleted/started/completed/email_opened
1938
+ */
1939
+ slug?: string;
1940
+ /** ID of the entity associated with the event. */
1941
+ entityId?: string;
1942
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1943
+ eventTime?: Date | null;
1944
+ /**
1945
+ * Whether the event was triggered as a result of a privacy regulation application
1946
+ * (for example, GDPR).
1947
+ */
1948
+ triggeredByAnonymizeRequest?: boolean | null;
1949
+ /** If present, indicates the action that triggered the event. */
1950
+ originatedFrom?: string | null;
1951
+ /**
1952
+ * A sequence number defining the order of updates to the underlying entity.
1953
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1954
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1955
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1956
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1957
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1958
+ */
1959
+ entityEventSequence?: string | null;
1960
+ }
1961
+ /** @oneof */
1962
+ export interface DomainEventBodyOneOf {
1963
+ createdEvent?: EntityCreatedEvent;
1964
+ updatedEvent?: EntityUpdatedEvent;
1965
+ deletedEvent?: EntityDeletedEvent;
1966
+ actionEvent?: ActionEvent;
1967
+ }
1968
+ export interface EntityCreatedEvent {
1969
+ entity?: string;
1970
+ }
1971
+ export interface RestoreInfo {
1972
+ deletedDate?: Date | null;
1973
+ }
1974
+ export interface EntityUpdatedEvent {
1975
+ /**
1976
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1977
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1978
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1979
+ */
1980
+ currentEntity?: string;
1981
+ }
1982
+ export interface EntityDeletedEvent {
1983
+ /** Entity that was deleted */
1984
+ deletedEntity?: string | null;
1985
+ }
1986
+ export interface ActionEvent {
1987
+ body?: string;
1988
+ }
1989
+ export interface MessageEnvelope {
1990
+ /**
1991
+ * App instance ID.
1992
+ * @format GUID
1993
+ */
1994
+ instanceId?: string | null;
1995
+ /**
1996
+ * Event type.
1997
+ * @maxLength 150
1998
+ */
1999
+ eventType?: string;
2000
+ /** The identification type and identity data. */
2001
+ identity?: IdentificationData;
2002
+ /** Stringify payload. */
2003
+ data?: string;
2004
+ }
2005
+ export interface IdentificationData extends IdentificationDataIdOneOf {
2006
+ /**
2007
+ * ID of a site visitor that has not logged in to the site.
2008
+ * @format GUID
2009
+ */
2010
+ anonymousVisitorId?: string;
2011
+ /**
2012
+ * ID of a site visitor that has logged in to the site.
2013
+ * @format GUID
2014
+ */
2015
+ memberId?: string;
2016
+ /**
2017
+ * ID of a Wix user (site owner, contributor, etc.).
2018
+ * @format GUID
2019
+ */
2020
+ wixUserId?: string;
2021
+ /**
2022
+ * ID of an app.
2023
+ * @format GUID
2024
+ */
2025
+ appId?: string;
2026
+ /** @readonly */
2027
+ identityType?: WebhookIdentityType;
2028
+ }
2029
+ /** @oneof */
2030
+ export interface IdentificationDataIdOneOf {
2031
+ /**
2032
+ * ID of a site visitor that has not logged in to the site.
2033
+ * @format GUID
2034
+ */
2035
+ anonymousVisitorId?: string;
2036
+ /**
2037
+ * ID of a site visitor that has logged in to the site.
2038
+ * @format GUID
2039
+ */
2040
+ memberId?: string;
2041
+ /**
2042
+ * ID of a Wix user (site owner, contributor, etc.).
2043
+ * @format GUID
2044
+ */
2045
+ wixUserId?: string;
2046
+ /**
2047
+ * ID of an app.
2048
+ * @format GUID
2049
+ */
2050
+ appId?: string;
2051
+ }
2052
+ export declare enum WebhookIdentityType {
2053
+ UNKNOWN = "UNKNOWN",
2054
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2055
+ MEMBER = "MEMBER",
2056
+ WIX_USER = "WIX_USER",
2057
+ APP = "APP"
2058
+ }
2059
+ export interface InitialDraftPostsCopied {
2060
+ /** Number of draft posts copied. */
2061
+ count?: number;
2062
+ }
2063
+ export interface CreateDraftPostRequest {
2064
+ /** Draft post to create. */
2065
+ draftPost: DraftPost;
2066
+ /**
2067
+ * Whether the draft post should be published on creation.
2068
+ *
2069
+ * Default: `false`
2070
+ */
2071
+ publish?: boolean;
2072
+ /**
2073
+ * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2074
+ * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2075
+ * only the draft post's base fields are returned.
2076
+ * @maxSize 10
2077
+ */
2078
+ fieldsets?: Field[];
2079
+ }
2080
+ export declare enum Type {
2081
+ UNKNOWN = "UNKNOWN",
2082
+ /** Manually saved. */
2083
+ MANUAL = "MANUAL",
2084
+ /** Triggered by autosave. */
2085
+ AUTO_SAVE = "AUTO_SAVE",
2086
+ /** Copied from template during provisioning flow. */
2087
+ PROVISIONING = "PROVISIONING",
2088
+ /** Imported from another blog. */
2089
+ IMPORT = "IMPORT",
2090
+ /** Triggered by autosave when post created by AI tool. */
2091
+ AI_AUTO_SAVE = "AI_AUTO_SAVE"
2092
+ }
2093
+ export declare enum Field {
2094
+ /** Unknown field. */
2095
+ UNKNOWN = "UNKNOWN",
2096
+ /** Includes draft post preview URL. */
2097
+ URL = "URL",
2098
+ /**
2099
+ * Includes internal id field.
2100
+ * Reserved for internal use.
2101
+ */
2102
+ INTERNAL_ID = "INTERNAL_ID",
2103
+ /** Includes content field. */
2104
+ CONTENT = "CONTENT",
2105
+ /** Includes rich content field. */
2106
+ RICH_CONTENT = "RICH_CONTENT",
2107
+ /** If the user has not set excerpt, returns the one autogenerated from content. */
2108
+ GENERATED_EXCERPT = "GENERATED_EXCERPT"
2109
+ }
2110
+ export interface CreateDraftPostResponse {
2111
+ /** Created draft post info. */
2112
+ draftPost?: DraftPost;
2113
+ }
2114
+ export interface BulkCreateDraftPostsRequest {
2115
+ /**
2116
+ * Draft posts to create.
2117
+ * @minSize 1
2118
+ * @maxSize 20
2119
+ */
2120
+ draftPosts: DraftPost[];
2121
+ /** Whether the draft post should be published after creation. */
2122
+ publish?: boolean;
2123
+ /** Whether to return the full created draft post entities in the response. */
2124
+ returnFullEntity?: boolean;
2125
+ /**
2126
+ * List of draft post fields to be included in the response if the entities are present.
2127
+ * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
2128
+ * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
2129
+ * @maxSize 10
2130
+ */
2131
+ fieldsets?: Field[];
2132
+ }
2133
+ export interface BulkCreateDraftPostsResponse {
2134
+ /** Draft posts created by bulk action. */
2135
+ results?: BulkDraftPostResult[];
2136
+ /** Bulk action metadata. */
2137
+ bulkActionMetadata?: BulkActionMetadata;
2138
+ }
2139
+ export interface BulkDraftPostResult {
2140
+ /** Bulk actions metadata for draft post. */
2141
+ itemMetadata?: ItemMetadata;
2142
+ /** Optional full draft post. */
2143
+ item?: DraftPost;
2144
+ }
2145
+ export interface ItemMetadata {
2146
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2147
+ _id?: string | null;
2148
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2149
+ originalIndex?: number;
2150
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2151
+ success?: boolean;
2152
+ /** Details about the error in case of failure. */
2153
+ error?: ApplicationError;
2154
+ }
2155
+ export interface ApplicationError {
2156
+ /** Error code. */
2157
+ code?: string;
2158
+ /** Description of the error. */
2159
+ description?: string;
2160
+ /** Data related to the error. */
2161
+ data?: Record<string, any> | null;
2162
+ }
2163
+ export interface BulkActionMetadata {
2164
+ /** Number of items that were successfully processed. */
2165
+ totalSuccesses?: number;
2166
+ /** Number of items that couldn't be processed. */
2167
+ totalFailures?: number;
2168
+ /** Number of failures without details because detailed failure threshold was exceeded. */
2169
+ undetailedFailures?: number;
2170
+ }
2171
+ export interface BulkUpdateDraftPostsRequest {
2172
+ /**
2173
+ * Draft posts to update.
2174
+ * @minSize 1
2175
+ * @maxSize 20
2176
+ */
2177
+ draftPosts?: MaskedDraftPosts[];
2178
+ /**
2179
+ * Action to perform on the posts.
2180
+ *
2181
+ * Default: `UPDATE`
2182
+ */
2183
+ action?: Action;
2184
+ /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
2185
+ scheduledPublishDate?: Date | null;
2186
+ /** Whether to return the full updated draft post entities in the response. */
2187
+ returnFullEntity?: boolean;
2188
+ /**
2189
+ * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2190
+ * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2191
+ * only the draft post's base fields are returned.
2192
+ * @maxSize 10
2193
+ */
2194
+ fieldsets?: Field[];
2195
+ }
1807
2196
  export interface MaskedDraftPosts {
1808
- /** Draft post info. */
2197
+ /** Draft post */
1809
2198
  draftPost?: DraftPost;
1810
2199
  /** Field mask of fields to update. */
1811
2200
  fieldMask?: string[];
@@ -1840,6 +2229,7 @@ export interface ListDeletedDraftPostsRequest {
1840
2229
  *
1841
2230
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1842
2231
  * If omitted, deleted draft posts in all languages are returned.
2232
+ * @format LANGUAGE_TAG
1843
2233
  */
1844
2234
  language?: string | null;
1845
2235
  /**
@@ -1854,9 +2244,14 @@ export interface ListDeletedDraftPostsRequest {
1854
2244
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1855
2245
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
1856
2246
  * only the draft post's base fields are returned.
2247
+ * @maxSize 10
1857
2248
  */
1858
2249
  fieldsets?: Field[];
1859
- /** Draft post ids. */
2250
+ /**
2251
+ * Draft post ids.
2252
+ * @maxSize 100
2253
+ * @format GUID
2254
+ */
1860
2255
  draftPostIds?: string[];
1861
2256
  }
1862
2257
  export declare enum GetDraftPostsSort {
@@ -1878,9 +2273,14 @@ export interface BlogPaging {
1878
2273
  *
1879
2274
  *
1880
2275
  * Default:`50`
2276
+ * @min 1
2277
+ * @max 100
1881
2278
  */
1882
2279
  limit?: number;
1883
- /** Pointer to the next or previous page in the list of results. */
2280
+ /**
2281
+ * Pointer to the next or previous page in the list of results.
2282
+ * @maxLength 2000
2283
+ */
1884
2284
  cursor?: string | null;
1885
2285
  }
1886
2286
  export interface ListDeletedDraftPostsResponse {
@@ -1896,16 +2296,23 @@ export interface MetaData {
1896
2296
  offset?: number;
1897
2297
  /** Total number of items that match the query. */
1898
2298
  total?: number;
1899
- /** Pointer to the next or previous page in the list of results. */
2299
+ /**
2300
+ * Pointer to the next or previous page in the list of results.
2301
+ * @maxLength 2000
2302
+ */
1900
2303
  cursor?: string | null;
1901
2304
  }
1902
2305
  export interface GetDraftPostRequest {
1903
- /** Draft post ID. */
2306
+ /**
2307
+ * Draft post ID.
2308
+ * @maxLength 38
2309
+ */
1904
2310
  draftPostId: string;
1905
2311
  /**
1906
2312
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1907
2313
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
1908
2314
  * only the draft post's base fields are returned.
2315
+ * @maxSize 10
1909
2316
  */
1910
2317
  fieldsets?: Field[];
1911
2318
  }
@@ -1914,11 +2321,17 @@ export interface GetDraftPostResponse {
1914
2321
  draftPost?: DraftPost;
1915
2322
  }
1916
2323
  export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
1917
- /** DraftJs content to update. */
2324
+ /**
2325
+ * DraftJs content to update.
2326
+ * @maxLength 400000
2327
+ */
1918
2328
  content?: string;
1919
- /** Draft post rich content. */
2329
+ /** Draft Post rich content. */
1920
2330
  richContent?: RichContent;
1921
- /** Draft post ID. */
2331
+ /**
2332
+ * Draft post ID.
2333
+ * @maxLength 38
2334
+ */
1922
2335
  draftPostId?: string;
1923
2336
  /** Change origin. */
1924
2337
  changeOrigin?: Origin;
@@ -1926,14 +2339,18 @@ export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentReq
1926
2339
  * List of draft post fields to be included if entities are present in the response.
1927
2340
  * Base fieldset, which is default, will return all core draft post properties.
1928
2341
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2342
+ * @maxSize 10
1929
2343
  */
1930
2344
  fieldsets?: Field[];
1931
2345
  }
1932
2346
  /** @oneof */
1933
2347
  export interface UpdateDraftPostContentRequestDraftContentOneOf {
1934
- /** DraftJs content to update. */
2348
+ /**
2349
+ * DraftJs content to update.
2350
+ * @maxLength 400000
2351
+ */
1935
2352
  content?: string;
1936
- /** Draft post rich content. */
2353
+ /** Draft Post rich content. */
1937
2354
  richContent?: RichContent;
1938
2355
  }
1939
2356
  export interface UpdateDraftPostContentResponse {
@@ -1955,6 +2372,7 @@ export interface UpdateDraftPostRequest {
1955
2372
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1956
2373
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
1957
2374
  * only the draft post's base fields are returned.
2375
+ * @maxSize 10
1958
2376
  */
1959
2377
  fieldsets?: Field[];
1960
2378
  }
@@ -1963,7 +2381,10 @@ export interface UpdateDraftPostResponse {
1963
2381
  draftPost?: DraftPost;
1964
2382
  }
1965
2383
  export interface DeleteDraftPostRequest {
1966
- /** Draft post ID. */
2384
+ /**
2385
+ * Draft post ID.
2386
+ * @maxLength 38
2387
+ */
1967
2388
  draftPostId: string;
1968
2389
  /**
1969
2390
  * Whether to bypass the trash bin and delete the post permanently.
@@ -1975,13 +2396,21 @@ export interface DeleteDraftPostRequest {
1975
2396
  export interface DeleteDraftPostResponse {
1976
2397
  }
1977
2398
  export interface RemoveFromTrashBinRequest {
1978
- /** Draft post ID. */
2399
+ /**
2400
+ * Draft post ID.
2401
+ * @maxLength 38
2402
+ */
1979
2403
  draftPostId: string;
1980
2404
  }
1981
2405
  export interface RemoveFromTrashBinResponse {
1982
2406
  }
1983
2407
  export interface BulkDeleteDraftPostsRequest {
1984
- /** Post IDs. */
2408
+ /**
2409
+ * Post IDs.
2410
+ * @minSize 1
2411
+ * @maxSize 100
2412
+ * @maxLength 38
2413
+ */
1985
2414
  postIds: string[];
1986
2415
  /** Should delete bypassing the trash-bin. */
1987
2416
  permanent?: boolean;
@@ -2005,6 +2434,7 @@ export interface ListDraftPostsRequest {
2005
2434
  *
2006
2435
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2007
2436
  * If omitted, draft posts in all languages are returned.
2437
+ * @format LANGUAGE_TAG
2008
2438
  */
2009
2439
  language?: string | null;
2010
2440
  /**
@@ -2019,6 +2449,7 @@ export interface ListDraftPostsRequest {
2019
2449
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2020
2450
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2021
2451
  * only the draft post's base fields are returned.
2452
+ * @maxSize 10
2022
2453
  */
2023
2454
  fieldsets?: Field[];
2024
2455
  }
@@ -2029,7 +2460,10 @@ export interface ListDraftPostsResponse {
2029
2460
  metaData?: MetaData;
2030
2461
  }
2031
2462
  export interface GetDeletedDraftPostRequest {
2032
- /** Draft post ID. */
2463
+ /**
2464
+ * Draft post ID.
2465
+ * @maxLength 38
2466
+ */
2033
2467
  draftPostId: string;
2034
2468
  }
2035
2469
  export interface GetDeletedDraftPostResponse {
@@ -2037,7 +2471,10 @@ export interface GetDeletedDraftPostResponse {
2037
2471
  draftPost?: DraftPost;
2038
2472
  }
2039
2473
  export interface RestoreFromTrashBinRequest {
2040
- /** Draft post ID. */
2474
+ /**
2475
+ * Draft post ID.
2476
+ * @maxLength 38
2477
+ */
2041
2478
  draftPostId: string;
2042
2479
  }
2043
2480
  export interface RestoreFromTrashBinResponse {
@@ -2049,13 +2486,17 @@ export interface QueryDraftPostsRequest {
2049
2486
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2050
2487
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2051
2488
  * only the draft post's base fields are returned.
2489
+ * @maxSize 10
2052
2490
  */
2053
2491
  fieldsets?: Field[];
2054
2492
  /** Query options. */
2055
2493
  query?: PlatformQuery;
2056
2494
  }
2057
2495
  export interface Sorting {
2058
- /** Name of the field to sort by. */
2496
+ /**
2497
+ * Name of the field to sort by.
2498
+ * @maxLength 512
2499
+ */
2059
2500
  fieldName?: string;
2060
2501
  /** Sort order. */
2061
2502
  order?: SortOrder;
@@ -2081,6 +2522,7 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2081
2522
  /**
2082
2523
  * Sort object in the following format:
2083
2524
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2525
+ * @maxSize 3
2084
2526
  */
2085
2527
  sort?: Sorting[];
2086
2528
  }
@@ -2092,13 +2534,19 @@ export interface PlatformQueryPagingMethodOneOf {
2092
2534
  cursorPaging?: CursorPaging;
2093
2535
  }
2094
2536
  export interface Paging {
2095
- /** Number of items to load. */
2537
+ /**
2538
+ * Number of items to load.
2539
+ * @max 100
2540
+ */
2096
2541
  limit?: number | null;
2097
2542
  /** Number of items to skip in the current sort order. */
2098
2543
  offset?: number | null;
2099
2544
  }
2100
2545
  export interface CursorPaging {
2101
- /** Number of items to load. */
2546
+ /**
2547
+ * Number of items to load.
2548
+ * @max 100
2549
+ */
2102
2550
  limit?: number | null;
2103
2551
  /**
2104
2552
  * Pointer to the next or previous page in the list of results.
@@ -2106,6 +2554,7 @@ export interface CursorPaging {
2106
2554
  * You can get the relevant cursor token
2107
2555
  * from the `pagingMetadata` object in the previous call's response.
2108
2556
  * Not relevant for the first request.
2557
+ * @maxLength 2000
2109
2558
  */
2110
2559
  cursor?: string | null;
2111
2560
  }
@@ -2141,167 +2590,50 @@ export interface PagingMetadataV2 {
2141
2590
  cursors?: Cursors;
2142
2591
  }
2143
2592
  export interface Cursors {
2144
- /** Cursor pointing to next page in the list of results. */
2593
+ /**
2594
+ * Cursor pointing to next page in the list of results.
2595
+ * @maxLength 2000
2596
+ */
2145
2597
  next?: string | null;
2146
- /** Cursor pointing to previous page in the list of results. */
2598
+ /**
2599
+ * Cursor pointing to previous page in the list of results.
2600
+ * @maxLength 2000
2601
+ */
2147
2602
  prev?: string | null;
2148
2603
  }
2149
2604
  export interface PublishDraftPostRequest {
2150
- /** Draft post ID. */
2605
+ /**
2606
+ * Draft post ID.
2607
+ * @maxLength 38
2608
+ */
2151
2609
  draftPostId: string;
2152
2610
  }
2153
2611
  export interface PublishDraftPostResponse {
2154
- /** Published post ID. */
2612
+ /**
2613
+ * Published post ID.
2614
+ * @format GUID
2615
+ */
2155
2616
  postId?: string;
2156
2617
  }
2157
2618
  export interface UnpublishPostRequest {
2158
- /** Draft post ID. */
2159
- draftPostId?: string;
2160
- }
2161
- export interface UnpublishPostResponse {
2162
- }
2163
- export interface DomainEvent extends DomainEventBodyOneOf {
2164
- createdEvent?: EntityCreatedEvent;
2165
- updatedEvent?: EntityUpdatedEvent;
2166
- deletedEvent?: EntityDeletedEvent;
2167
- actionEvent?: ActionEvent;
2168
- /**
2169
- * Unique event ID.
2170
- * Allows clients to ignore duplicate webhooks.
2171
- */
2172
- _id?: string;
2173
- /**
2174
- * Assumes actions are also always typed to an entity_type
2175
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2176
- */
2177
- entityFqdn?: string;
2178
- /**
2179
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2180
- * This is although the created/updated/deleted notion is duplication of the oneof types
2181
- * Example: created/updated/deleted/started/completed/email_opened
2182
- */
2183
- slug?: string;
2184
- /** ID of the entity associated with the event. */
2185
- entityId?: string;
2186
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2187
- eventTime?: Date | null;
2188
- /**
2189
- * Whether the event was triggered as a result of a privacy regulation application
2190
- * (for example, GDPR).
2191
- */
2192
- triggeredByAnonymizeRequest?: boolean | null;
2193
- /** If present, indicates the action that triggered the event. */
2194
- originatedFrom?: string | null;
2195
2619
  /**
2196
- * A sequence number defining the order of updates to the underlying entity.
2197
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2198
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2199
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2200
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2201
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2620
+ * Draft post ID.
2621
+ * @maxLength 38
2202
2622
  */
2203
- entityEventSequence?: string | null;
2204
- }
2205
- /** @oneof */
2206
- export interface DomainEventBodyOneOf {
2207
- createdEvent?: EntityCreatedEvent;
2208
- updatedEvent?: EntityUpdatedEvent;
2209
- deletedEvent?: EntityDeletedEvent;
2210
- actionEvent?: ActionEvent;
2211
- }
2212
- export interface EntityCreatedEvent {
2213
- entity?: string;
2623
+ draftPostId?: string;
2214
2624
  }
2215
- export interface RestoreInfo {
2216
- deletedDate?: Date | null;
2625
+ export interface UnpublishPostResponse {
2217
2626
  }
2218
- export interface EntityUpdatedEvent {
2627
+ export interface TranslateCategoryRequest {
2219
2628
  /**
2220
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2221
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2222
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2629
+ * Source category ID
2630
+ * @format GUID
2223
2631
  */
2224
- currentEntity?: string;
2225
- }
2226
- export interface EntityDeletedEvent {
2227
- /** Entity that was deleted */
2228
- deletedEntity?: string | null;
2229
- }
2230
- export interface ActionEvent {
2231
- body?: string;
2232
- }
2233
- export interface MessageEnvelope {
2234
- /** App instance ID. */
2235
- instanceId?: string | null;
2236
- /** Event type. */
2237
- eventType?: string;
2238
- /** The identification type and identity data. */
2239
- identity?: IdentificationData;
2240
- /** Stringify payload. */
2241
- data?: string;
2242
- }
2243
- export interface IdentificationData extends IdentificationDataIdOneOf {
2244
- /** ID of a site visitor that has not logged in to the site. */
2245
- anonymousVisitorId?: string;
2246
- /** ID of a site visitor that has logged in to the site. */
2247
- memberId?: string;
2248
- /** ID of a Wix user (site owner, contributor, etc.). */
2249
- wixUserId?: string;
2250
- /** ID of an app. */
2251
- appId?: string;
2252
- /** @readonly */
2253
- identityType?: WebhookIdentityType;
2254
- }
2255
- /** @oneof */
2256
- export interface IdentificationDataIdOneOf {
2257
- /** ID of a site visitor that has not logged in to the site. */
2258
- anonymousVisitorId?: string;
2259
- /** ID of a site visitor that has logged in to the site. */
2260
- memberId?: string;
2261
- /** ID of a Wix user (site owner, contributor, etc.). */
2262
- wixUserId?: string;
2263
- /** ID of an app. */
2264
- appId?: string;
2265
- }
2266
- export declare enum WebhookIdentityType {
2267
- UNKNOWN = "UNKNOWN",
2268
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2269
- MEMBER = "MEMBER",
2270
- WIX_USER = "WIX_USER",
2271
- APP = "APP"
2272
- }
2273
- export interface GetDraftPostTotalsRequest {
2632
+ categoryId?: string;
2274
2633
  /**
2275
- * Group results by fields (defaults to grouping by status).
2276
- * If, for example, grouping by language is passed, language values in response will be filled.
2277
- * If, for example, grouping by language is not passed, null values will be filled in language field in response.
2634
+ * Translation language
2635
+ * @format LANGUAGE_TAG
2278
2636
  */
2279
- groupBy?: TotalDraftPostsGroupingField[];
2280
- /** Optional language filter by provided language code. Useful in multilingual context. */
2281
- language?: string | null;
2282
- }
2283
- export declare enum TotalDraftPostsGroupingField {
2284
- /** Groups results by status. */
2285
- STATUS = "STATUS",
2286
- /** Groups results by language. */
2287
- LANGUAGE = "LANGUAGE"
2288
- }
2289
- export interface GetDraftPostTotalsResponse {
2290
- /** Draft post totals. */
2291
- totalDraftPosts?: TotalDraftPosts[];
2292
- }
2293
- export interface TotalDraftPosts {
2294
- /** Draft post totals in that group. */
2295
- total?: number;
2296
- /** Draft post status (only has value when grouping by status, otherwise null). */
2297
- status?: Status;
2298
- /** Draft post language code (only has value when grouping by language, otherwise null). */
2299
- language?: string | null;
2300
- }
2301
- export interface TranslateCategoryRequest {
2302
- /** Source category ID */
2303
- categoryId?: string;
2304
- /** Translation language */
2305
2637
  language?: string;
2306
2638
  }
2307
2639
  export interface TranslateCategoryResponse {
@@ -2311,9 +2643,16 @@ export interface TranslateCategoryResponse {
2311
2643
  translations?: CategoryTranslation[];
2312
2644
  }
2313
2645
  export interface Category {
2314
- /** Category ID. */
2646
+ /**
2647
+ * Category ID.
2648
+ * @immutable
2649
+ * @maxLength 38
2650
+ */
2315
2651
  _id?: string;
2316
- /** Category label. Displayed in the Category Menu. */
2652
+ /**
2653
+ * Category label. Displayed in the Category Menu.
2654
+ * @maxLength 35
2655
+ */
2317
2656
  label?: string;
2318
2657
  /**
2319
2658
  * Number of posts in the category.
@@ -2325,10 +2664,14 @@ export interface Category {
2325
2664
  * @readonly
2326
2665
  */
2327
2666
  url?: string;
2328
- /** Category description. */
2667
+ /**
2668
+ * Category description.
2669
+ * @maxLength 500
2670
+ */
2329
2671
  description?: string | null;
2330
2672
  /**
2331
2673
  * Category title.
2674
+ * @maxLength 200
2332
2675
  * @deprecated Category title.
2333
2676
  * @targetRemovalDate 2025-07-16
2334
2677
  */
@@ -2340,19 +2683,27 @@ export interface Category {
2340
2683
  * Default: `-1`
2341
2684
  */
2342
2685
  displayPosition?: number | null;
2343
- /** ID of the category's translations. All translations of a single category share the same `translationId`. */
2686
+ /**
2687
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2688
+ * @format GUID
2689
+ */
2344
2690
  translationId?: string | null;
2345
2691
  /**
2346
2692
  * Category language.
2347
2693
  *
2348
2694
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2695
+ * @immutable
2349
2696
  */
2350
2697
  language?: string | null;
2351
- /** 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`. */
2698
+ /**
2699
+ * 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`.
2700
+ * @maxLength 100
2701
+ */
2352
2702
  slug?: string;
2353
2703
  /**
2354
2704
  * Reserved for internal use.
2355
2705
  * @readonly
2706
+ * @maxLength 24
2356
2707
  */
2357
2708
  internalId?: string | null;
2358
2709
  /** SEO data. */
@@ -2366,24 +2717,40 @@ export interface Category {
2366
2717
  _updatedDate?: Date | null;
2367
2718
  }
2368
2719
  export interface CategoryTranslation {
2369
- /** Category ID. */
2720
+ /**
2721
+ * Category ID.
2722
+ * @format GUID
2723
+ */
2370
2724
  _id?: string;
2371
- /** Label displayed in the categories menu on the site. */
2725
+ /**
2726
+ * Label displayed in the categories menu on the site.
2727
+ * @maxLength 100
2728
+ */
2372
2729
  label?: string | null;
2373
- /** Language of the category. */
2730
+ /**
2731
+ * Language of the category.
2732
+ * @format LANGUAGE_TAG
2733
+ */
2374
2734
  language?: string | null;
2375
2735
  /** URL of this category page. */
2376
2736
  url?: string;
2377
2737
  }
2378
2738
  export interface TranslateDraftRequest {
2379
- /** Source post or draft ID */
2739
+ /**
2740
+ * Source post or draft ID
2741
+ * @format GUID
2742
+ */
2380
2743
  postId?: string;
2381
- /** Translation language */
2744
+ /**
2745
+ * Translation language
2746
+ * @format LANGUAGE_TAG
2747
+ */
2382
2748
  language?: string;
2383
2749
  /**
2384
2750
  * List of draft post fields to be included if entities are present in the response.
2385
2751
  * Base fieldset, which is default, will return all core draft post properties.
2386
2752
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2753
+ * @maxSize 10
2387
2754
  */
2388
2755
  fieldsets?: Field[];
2389
2756
  }
@@ -2392,11 +2759,17 @@ export interface TranslateDraftResponse {
2392
2759
  draftPost?: DraftPost;
2393
2760
  }
2394
2761
  export interface IsDraftPostAutoTranslatableRequest {
2395
- /** Source post or draft ID. */
2762
+ /**
2763
+ * Source post or draft ID.
2764
+ * @format GUID
2765
+ */
2396
2766
  draftPostId?: string;
2397
2767
  }
2398
2768
  export interface IsDraftPostAutoTranslatableResponse {
2399
- /** Source draft post ID. */
2769
+ /**
2770
+ * Source draft post ID.
2771
+ * @format GUID
2772
+ */
2400
2773
  draftPostId?: string;
2401
2774
  /** Indicates if enough machine translation credits are available for the draft post translation. */
2402
2775
  translatable?: boolean;
@@ -2412,14 +2785,22 @@ export interface IsDraftPostAutoTranslatableResponse {
2412
2785
  contentTextCharacterCount?: number;
2413
2786
  }
2414
2787
  export interface UpdateDraftPostLanguageRequest {
2415
- /** Source draft post ID */
2788
+ /**
2789
+ * Source draft post ID
2790
+ * @format GUID
2791
+ */
2416
2792
  postId?: string;
2417
- /** New language to replace to */
2793
+ /**
2794
+ * New language to replace to
2795
+ * @minLength 2
2796
+ * @format LANGUAGE_TAG
2797
+ */
2418
2798
  language?: string;
2419
2799
  /**
2420
2800
  * List of draft post fields to be included if entities are present in the response.
2421
2801
  * Base fieldset, which is default, will return all core draft post properties.
2422
2802
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2803
+ * @maxSize 10
2423
2804
  */
2424
2805
  fieldsets?: Field[];
2425
2806
  }
@@ -2428,9 +2809,16 @@ export interface UpdateDraftPostLanguageResponse {
2428
2809
  draftPost?: DraftPost;
2429
2810
  }
2430
2811
  export interface BulkUpdateDraftPostLanguageRequest {
2431
- /** Source post or draft IDs */
2812
+ /**
2813
+ * Source post or draft IDs
2814
+ * @maxSize 50
2815
+ * @format GUID
2816
+ */
2432
2817
  ids?: string[];
2433
- /** New language to replace to */
2818
+ /**
2819
+ * New language to replace to
2820
+ * @format LANGUAGE_TAG
2821
+ */
2434
2822
  language?: string;
2435
2823
  /** Should full draft post be returned */
2436
2824
  returnFullEntity?: boolean;
@@ -2438,6 +2826,7 @@ export interface BulkUpdateDraftPostLanguageRequest {
2438
2826
  * List of draft post fields to be included if entities are present in the response.
2439
2827
  * Base fieldset, which is default, will return all core draft post properties.
2440
2828
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2829
+ * @maxSize 10
2441
2830
  */
2442
2831
  fieldsets?: Field[];
2443
2832
  }
@@ -2448,7 +2837,10 @@ export interface BulkUpdateDraftPostLanguageResponse {
2448
2837
  bulkActionMetadata?: BulkActionMetadata;
2449
2838
  }
2450
2839
  export interface GetPostAmountsByLanguageRequest {
2451
- /** Post status to filter by */
2840
+ /**
2841
+ * Post status to filter by
2842
+ * @maxLength 100
2843
+ */
2452
2844
  status?: string;
2453
2845
  }
2454
2846
  export interface GetPostAmountsByLanguageResponse {
@@ -2456,15 +2848,26 @@ export interface GetPostAmountsByLanguageResponse {
2456
2848
  postAmountsByLanguage?: PostAmountByLanguage[];
2457
2849
  }
2458
2850
  export interface PostAmountByLanguage {
2459
- /** Post language code */
2851
+ /**
2852
+ * Post language code
2853
+ * @format LANGUAGE_TAG
2854
+ */
2460
2855
  languageCode?: string;
2461
- /** Language flag */
2856
+ /**
2857
+ * Language flag
2858
+ * @format LANGUAGE_TAG
2859
+ */
2462
2860
  flag?: string;
2463
2861
  /** Post amount in that language */
2464
2862
  postAmount?: number;
2465
2863
  }
2466
2864
  export interface BulkRevertToUnpublishedRequest {
2467
- /** Source post IDs. */
2865
+ /**
2866
+ * Source post IDs.
2867
+ * @minSize 1
2868
+ * @maxSize 100
2869
+ * @format GUID
2870
+ */
2468
2871
  postIds?: string[];
2469
2872
  /** Should full draft post be returned. */
2470
2873
  returnFullEntity?: boolean;
@@ -2476,7 +2879,12 @@ export interface BulkRevertToUnpublishedResponse {
2476
2879
  bulkActionMetadata?: BulkActionMetadata;
2477
2880
  }
2478
2881
  export interface BulkRejectDraftPostRequest {
2479
- /** Source post IDs. */
2882
+ /**
2883
+ * Source post IDs.
2884
+ * @minSize 1
2885
+ * @maxSize 100
2886
+ * @format GUID
2887
+ */
2480
2888
  postIds?: string[];
2481
2889
  /** Should full draft post be returned. */
2482
2890
  returnFullEntity?: boolean;
@@ -2488,12 +2896,16 @@ export interface BulkRejectDraftPostResponse {
2488
2896
  bulkActionMetadata?: BulkActionMetadata;
2489
2897
  }
2490
2898
  export interface RevertToUnpublishedRequest {
2491
- /** Source post ID. */
2899
+ /**
2900
+ * Source post ID.
2901
+ * @format GUID
2902
+ */
2492
2903
  postId?: string;
2493
2904
  /**
2494
2905
  * List of draft post fields to be included if entities are present in the response.
2495
2906
  * Base fieldset, which is default, will return all core draft post properties.
2496
2907
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2908
+ * @maxSize 10
2497
2909
  */
2498
2910
  fieldsets?: Field[];
2499
2911
  }
@@ -2502,12 +2914,16 @@ export interface RevertToUnpublishedResponse {
2502
2914
  draftPost?: DraftPost;
2503
2915
  }
2504
2916
  export interface RejectDraftPostRequest {
2505
- /** Source post ID. */
2917
+ /**
2918
+ * Source post ID.
2919
+ * @format GUID
2920
+ */
2506
2921
  postId?: string;
2507
2922
  /**
2508
2923
  * List of draft post fields to be included if entities are present in the response.
2509
2924
  * Base fieldset, which is default, will return all core draft post properties.
2510
2925
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2926
+ * @maxSize 10
2511
2927
  */
2512
2928
  fieldsets?: Field[];
2513
2929
  }
@@ -2516,14 +2932,21 @@ export interface RejectDraftPostResponse {
2516
2932
  draftPost?: DraftPost;
2517
2933
  }
2518
2934
  export interface ApproveDraftPostRequest {
2519
- /** Source post ID. */
2935
+ /**
2936
+ * Source post ID.
2937
+ * @format GUID
2938
+ */
2520
2939
  postId?: string;
2521
- /** Scheduled publish date if should be not immediately published. */
2940
+ /**
2941
+ * Scheduled publish date if should be not immediately published.
2942
+ * @maxLength 24
2943
+ */
2522
2944
  scheduledPublishDate?: string | null;
2523
2945
  /**
2524
2946
  * List of draft post fields to be included if entities are present in the response.
2525
2947
  * Base fieldset, which is default, will return all core draft post properties.
2526
2948
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2949
+ * @maxSize 10
2527
2950
  */
2528
2951
  fieldsets?: Field[];
2529
2952
  }
@@ -2532,12 +2955,16 @@ export interface ApproveDraftPostResponse {
2532
2955
  draftPost?: DraftPost;
2533
2956
  }
2534
2957
  export interface MarkPostAsInModerationRequest {
2535
- /** Source post ID. */
2958
+ /**
2959
+ * Source post ID.
2960
+ * @maxLength 38
2961
+ */
2536
2962
  postId?: string;
2537
2963
  /**
2538
2964
  * List of draft post fields to be included if entities are present in the response.
2539
2965
  * Base fieldset, which is default, will return all core draft post properties.
2540
2966
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2967
+ * @maxSize 10
2541
2968
  */
2542
2969
  fieldsets?: Field[];
2543
2970
  }
@@ -2634,9 +3061,13 @@ interface ImageDataNonNullableFields {
2634
3061
  containerData?: PluginContainerDataNonNullableFields;
2635
3062
  link?: LinkNonNullableFields;
2636
3063
  }
3064
+ interface LinkPreviewDataStylesNonNullableFields {
3065
+ thumbnailPosition: Position;
3066
+ }
2637
3067
  interface LinkPreviewDataNonNullableFields {
2638
3068
  containerData?: PluginContainerDataNonNullableFields;
2639
3069
  link?: LinkNonNullableFields;
3070
+ styles?: LinkPreviewDataStylesNonNullableFields;
2640
3071
  }
2641
3072
  interface MapSettingsNonNullableFields {
2642
3073
  mapType: MapType;
@@ -2940,9 +3371,15 @@ export interface PublishDraftPostResponseNonNullableFields {
2940
3371
  postId: string;
2941
3372
  }
2942
3373
  export interface BaseEventMetadata {
2943
- /** App instance ID. */
3374
+ /**
3375
+ * App instance ID.
3376
+ * @format GUID
3377
+ */
2944
3378
  instanceId?: string | null;
2945
- /** Event type. */
3379
+ /**
3380
+ * Event type.
3381
+ * @maxLength 150
3382
+ */
2946
3383
  eventType?: string;
2947
3384
  /** The identification type and identity data. */
2948
3385
  identity?: IdentificationData;
@@ -3060,7 +3497,7 @@ export declare function onDraftUpdated(handler: (event: DraftUpdatedEnvelope) =>
3060
3497
  /**
3061
3498
  * Creates a draft post.
3062
3499
  *
3063
- * The draft post's `memberId` is required for third-party apps.
3500
+ * A draft post's [memberId](https://dev.wix.com/api/rest/members/members) is required for 3rd-party apps.
3064
3501
  * @param draftPost - Draft post to create.
3065
3502
  * @public
3066
3503
  * @requiredField draftPost
@@ -3084,6 +3521,7 @@ export interface CreateDraftPostOptions {
3084
3521
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3085
3522
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3086
3523
  * only the draft post's base fields are returned.
3524
+ * @maxSize 10
3087
3525
  */
3088
3526
  fieldsets?: Field[];
3089
3527
  }
@@ -3110,6 +3548,7 @@ export interface BulkCreateDraftPostsOptions {
3110
3548
  * List of draft post fields to be included in the response if the entities are present.
3111
3549
  * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
3112
3550
  * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
3551
+ * @maxSize 10
3113
3552
  */
3114
3553
  fieldsets?: Field[];
3115
3554
  }
@@ -3127,19 +3566,15 @@ export interface BulkCreateDraftPostsOptions {
3127
3566
  */
3128
3567
  export declare function bulkUpdateDraftPosts(options?: BulkUpdateDraftPostsOptions): Promise<BulkUpdateDraftPostsResponse & BulkUpdateDraftPostsResponseNonNullableFields>;
3129
3568
  export interface BulkUpdateDraftPostsOptions {
3130
- /** Draft posts to update. */
3569
+ /**
3570
+ * Draft posts to update.
3571
+ * @minSize 1
3572
+ * @maxSize 20
3573
+ */
3131
3574
  draftPosts?: MaskedDraftPosts[];
3132
3575
  /**
3133
3576
  * Action to perform on the posts.
3134
3577
  *
3135
- * - `UPDATE`: Update the draft post.
3136
- * - `UPDATE_PUBLISH`: Update and publish the draft post.
3137
- * - `UPDATE_SCHEDULE`: Update the draft post and schedule a publish date.
3138
- * - `UPDATE_REVERT_TO_DRAFT`: Update the post and revert it to a draft post.
3139
- * - `UPDATE_CANCEL_SCHEDULE`: Update the draft post and cancel the scheduled publish date.
3140
- * - `UPDATE_REJECT`: Update and reject the draft post.
3141
- * - `UPDATE_PUBLICATION`: Update a published post. This creates and updates a draft version of the post. The original post is still published.
3142
- *
3143
3578
  * Default: `UPDATE`
3144
3579
  */
3145
3580
  action?: Action;
@@ -3151,13 +3586,14 @@ export interface BulkUpdateDraftPostsOptions {
3151
3586
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3152
3587
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3153
3588
  * only the draft post's base fields are returned.
3589
+ * @maxSize 10
3154
3590
  */
3155
3591
  fieldsets?: Field[];
3156
3592
  }
3157
3593
  /**
3158
3594
  * Retrieves a list of up to 100 deleted draft posts.
3159
3595
  *
3160
- * List Deleted Draft Posts runs with these defaults, which you can override:
3596
+ * List Draft Posts runs with these defaults, which you can override:
3161
3597
  * - `editedDate` is sorted in descending order. In this case,`editedDate` implies the date the post was deleted.
3162
3598
  * - `paging.limit` is `50`.
3163
3599
  * - `paging.offset` is `0`.
@@ -3176,6 +3612,7 @@ export interface ListDeletedDraftPostsOptions {
3176
3612
  *
3177
3613
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3178
3614
  * If omitted, deleted draft posts in all languages are returned.
3615
+ * @format LANGUAGE_TAG
3179
3616
  */
3180
3617
  language?: string | null;
3181
3618
  /**
@@ -3190,15 +3627,18 @@ export interface ListDeletedDraftPostsOptions {
3190
3627
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3191
3628
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3192
3629
  * only the draft post's base fields are returned.
3630
+ * @maxSize 10
3193
3631
  */
3194
3632
  fieldsets?: Field[];
3195
- /** Draft post ids. */
3633
+ /**
3634
+ * Draft post ids.
3635
+ * @maxSize 100
3636
+ * @format GUID
3637
+ */
3196
3638
  draftPostIds?: string[];
3197
3639
  }
3198
3640
  /**
3199
3641
  * Gets a draft post by the provided ID.
3200
- *
3201
- * Uses the provided `draftPostId` to retrieve a draft post.
3202
3642
  * @param draftPostId - Draft post ID.
3203
3643
  * @public
3204
3644
  * @requiredField draftPostId
@@ -3215,6 +3655,7 @@ export interface GetDraftPostOptions {
3215
3655
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3216
3656
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3217
3657
  * only the draft post's base fields are returned.
3658
+ * @maxSize 10
3218
3659
  */
3219
3660
  fieldsets?: Field[];
3220
3661
  }
@@ -3237,24 +3678,40 @@ export interface UpdateDraftPost {
3237
3678
  /**
3238
3679
  * Draft post ID.
3239
3680
  * @readonly
3681
+ * @maxLength 38
3240
3682
  */
3241
3683
  _id?: string;
3242
- /** Draft post title. */
3684
+ /**
3685
+ * Draft post title.
3686
+ * @maxLength 200
3687
+ */
3243
3688
  title?: string;
3244
3689
  /**
3245
3690
  * Draft post excerpt.
3246
3691
  *
3247
3692
  * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
3248
3693
  * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
3694
+ * @maxLength 500
3249
3695
  */
3250
3696
  excerpt?: string | null;
3251
3697
  /** Whether the draft post is marked as featured. */
3252
3698
  featured?: boolean | null;
3253
- /** Category IDs of the draft post. */
3699
+ /**
3700
+ * Category IDs of the draft post.
3701
+ * @maxSize 10
3702
+ * @maxLength 38
3703
+ */
3254
3704
  categoryIds?: string[];
3255
- /** Draft post owner's member ID. */
3705
+ /**
3706
+ * Draft post owner's member ID.
3707
+ * @format GUID
3708
+ */
3256
3709
  memberId?: string | null;
3257
- /** Hashtags in the draft post. */
3710
+ /**
3711
+ * Hashtags in the post.
3712
+ * @maxSize 100
3713
+ * @maxLength 100
3714
+ */
3258
3715
  hashtags?: string[];
3259
3716
  /** Whether commenting on the draft post is enabled. */
3260
3717
  commentingEnabled?: boolean | null;
@@ -3265,23 +3722,37 @@ export interface UpdateDraftPost {
3265
3722
  minutesToRead?: number;
3266
3723
  /** Image placed at the top of the blog page. */
3267
3724
  heroImage?: string;
3268
- /** Tag IDs the draft post is tagged with. */
3725
+ /**
3726
+ * Tag IDs the draft post is tagged with.
3727
+ * @maxSize 30
3728
+ * @maxLength 38
3729
+ */
3269
3730
  tagIds?: string[];
3270
- /** IDs of posts related to this draft post. */
3731
+ /**
3732
+ * IDs of posts related to this draft post.
3733
+ * @maxSize 3
3734
+ * @maxLength 38
3735
+ */
3271
3736
  relatedPostIds?: string[];
3272
- /** Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. */
3737
+ /**
3738
+ * [Pricing plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans). Only relevant if a post is assigned to a specific pricing plan.
3739
+ * @maxSize 100
3740
+ * @format GUID
3741
+ */
3273
3742
  pricingPlanIds?: string[];
3274
3743
  /**
3275
3744
  * ID of the draft post's translations.
3276
3745
  *
3277
3746
  * All translations of a single post share the same `translationId`.
3278
3747
  * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3748
+ * @format GUID
3279
3749
  */
3280
3750
  translationId?: string | null;
3281
3751
  /**
3282
3752
  * Language the draft post is written in.
3283
3753
  *
3284
3754
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3755
+ * @format LANGUAGE_TAG
3285
3756
  */
3286
3757
  language?: string | null;
3287
3758
  /**
@@ -3292,11 +3763,21 @@ export interface UpdateDraftPost {
3292
3763
  /**
3293
3764
  * Reserved for internal use.
3294
3765
  * @readonly
3766
+ * @maxLength 24
3295
3767
  */
3296
3768
  contentId?: string | null;
3297
- /** Reserved for internal use. */
3769
+ /**
3770
+ * Reserved for internal use.
3771
+ * @format GUID
3772
+ */
3298
3773
  editingSessionId?: string | null;
3299
- /** Draft post rich content. */
3774
+ /**
3775
+ * Draft Post rich content.
3776
+ *
3777
+ * <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">
3778
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
3779
+ * </widget>
3780
+ */
3300
3781
  richContent?: RichContent;
3301
3782
  /**
3302
3783
  * Status of the draft post.
@@ -3308,6 +3789,7 @@ export interface UpdateDraftPost {
3308
3789
  /**
3309
3790
  * Reserved for internal use.
3310
3791
  * @readonly
3792
+ * @format GUID
3311
3793
  */
3312
3794
  mostRecentContributorId?: string | null;
3313
3795
  /**
@@ -3331,9 +3813,18 @@ export interface UpdateDraftPost {
3331
3813
  firstPublishedDate?: Date | null;
3332
3814
  /** SEO data. */
3333
3815
  seoData?: SeoSchema;
3816
+ /**
3817
+ * Reserved for internal use.
3818
+ * @deprecated
3819
+ * @replacedBy preview_text_paragraph
3820
+ * @targetRemovalDate 2024-06-30
3821
+ */
3822
+ paidContentParagraph?: number | null;
3334
3823
  /**
3335
3824
  * Reserved for internal use.
3336
3825
  * @readonly
3826
+ * @maxSize 5000
3827
+ * @maxLength 100
3337
3828
  */
3338
3829
  slugs?: string[];
3339
3830
  /**
@@ -3346,7 +3837,10 @@ export interface UpdateDraftPost {
3346
3837
  * @readonly
3347
3838
  */
3348
3839
  _createdDate?: Date | null;
3349
- /** SEO slug. */
3840
+ /**
3841
+ * SEO slug.
3842
+ * @maxLength 100
3843
+ */
3350
3844
  seoSlug?: string | null;
3351
3845
  /** Post cover media. */
3352
3846
  media?: Media;
@@ -3355,6 +3849,7 @@ export interface UpdateDraftPost {
3355
3849
  /**
3356
3850
  * Reserved for internal use.
3357
3851
  * @readonly
3852
+ * @maxLength 24
3358
3853
  */
3359
3854
  internalId?: string | null;
3360
3855
  }
@@ -3371,14 +3866,15 @@ export interface UpdateDraftPostOptions {
3371
3866
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3372
3867
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3373
3868
  * only the draft post's base fields are returned.
3869
+ * @maxSize 10
3374
3870
  */
3375
3871
  fieldsets?: Field[];
3376
3872
  }
3377
3873
  /**
3378
- * Moves a draft post with the provided ID to the trash bin.
3379
- * A published post can also be deleted by its provided `draftPostId`.
3874
+ * Moves a draft post to the trash bin.
3875
+ * A published post can also be deleted by the [post `ID`](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats).
3380
3876
  *
3381
- * The optional `permanent` field enables you to delete a post permanently, bypassing the trash bin. When a draft post is deleted this way, it can't be restored.
3877
+ * To permanently delete a post bypassing the trash bin, set the `permanent` field value to `true`. The post can't be restored after this.
3382
3878
  * @param draftPostId - Draft post ID.
3383
3879
  * @public
3384
3880
  * @requiredField draftPostId
@@ -3399,9 +3895,7 @@ export interface DeleteDraftPostOptions {
3399
3895
  permanent?: boolean;
3400
3896
  }
3401
3897
  /**
3402
- * Permanently deletes a draft post by the provided ID from the trash bin.
3403
- *
3404
- * Uses the provided `draftPostId` to permanently delete a draft post from the trash bin. This action is permanent and cannot be reversed.
3898
+ * Permanently deletes a draft post that is currently in the trash bin.
3405
3899
  * @param draftPostId - Draft post ID.
3406
3900
  * @public
3407
3901
  * @requiredField draftPostId
@@ -3458,6 +3952,7 @@ export interface ListDraftPostsOptions {
3458
3952
  *
3459
3953
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3460
3954
  * If omitted, draft posts in all languages are returned.
3955
+ * @format LANGUAGE_TAG
3461
3956
  */
3462
3957
  language?: string | null;
3463
3958
  /**
@@ -3472,13 +3967,12 @@ export interface ListDraftPostsOptions {
3472
3967
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3473
3968
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3474
3969
  * only the draft post's base fields are returned.
3970
+ * @maxSize 10
3475
3971
  */
3476
3972
  fieldsets?: Field[];
3477
3973
  }
3478
3974
  /**
3479
3975
  * Gets a deleted draft post from the trash bin by the provided ID.
3480
- *
3481
- * Uses the provided `draftPostId` to retrieve a previously deleted draft post from the trash bin.
3482
3976
  * @param draftPostId - Draft post ID.
3483
3977
  * @public
3484
3978
  * @requiredField draftPostId
@@ -3491,8 +3985,6 @@ export interface ListDraftPostsOptions {
3491
3985
  export declare function getDeletedDraftPost(draftPostId: string): Promise<GetDeletedDraftPostResponse & GetDeletedDraftPostResponseNonNullableFields>;
3492
3986
  /**
3493
3987
  * Restores a deleted draft post from the trash bin by the provided ID.
3494
- *
3495
- * Uses the `draftPostId` to restore a deleted draft post from the trash bin.
3496
3988
  * @param draftPostId - Draft post ID.
3497
3989
  * @public
3498
3990
  * @requiredField draftPostId
@@ -3504,12 +3996,20 @@ export declare function getDeletedDraftPost(draftPostId: string): Promise<GetDel
3504
3996
  */
3505
3997
  export declare function restoreFromTrashBin(draftPostId: string): Promise<RestoreFromTrashBinResponse & RestoreFromTrashBinResponseNonNullableFields>;
3506
3998
  /**
3507
- * Retrieves a list of up to 100 draft posts, given the provided paging, filtering, and sorting.
3999
+ * Creates a query to retrieve a list of up to 100 draft posts.
3508
4000
  *
3509
- * Query Draft Posts runs with these defaults, which you can override:
3510
- * - `editedDate` is sorted in `DESC` order.
3511
- * - `paging.limit` is `50`.
3512
- * - `paging.offset` is `0`.
4001
+ *
4002
+ * The `queryDraftPosts()` function builds a query to retrieve a list of up to 100 draft posts, and returns a `DraftPostsQueryBuilder` object.
4003
+ *
4004
+ * The returned object contains the query definition, which is typically used to run the query using the `find()` function.
4005
+ *
4006
+ * You can refine the query by chaining `DraftPostsQueryBuilder` functions onto the query. `DraftPostsQueryBuilder` functions enable you to sort, filter, and control the results that `queryDraftPosts()` returns.
4007
+ *
4008
+ * `queryDraftPosts()` runs with these `DraftPostsQueryBuilder` defaults that can be overridden:
4009
+ * - `limit(50)`
4010
+ * - `ascending('_id')`
4011
+ *
4012
+ * The following `DraftPostsQueryBuilder` functions are supported for `queryDraftPosts()`. For a full description of the Draft Posts object, see the object returned for the `items` property in `DraftPostsQueryResult`.
3513
4013
  * @public
3514
4014
  * @param options - Options for querying draft posts.
3515
4015
  * @permissionScope Manage Blog
@@ -3524,6 +4024,7 @@ export interface QueryDraftPostsOptions {
3524
4024
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3525
4025
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
3526
4026
  * only the draft post's base fields are returned.
4027
+ * @maxSize 10
3527
4028
  */
3528
4029
  fieldsets?: Field[] | undefined;
3529
4030
  }
@@ -3582,9 +4083,9 @@ export interface DraftPostsQueryBuilder {
3582
4083
  find: () => Promise<DraftPostsQueryResult>;
3583
4084
  }
3584
4085
  /**
3585
- * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
3586
- *
3587
- * If the specified draft post was already published, the published post will be updated with the latest values from the draft post entity.
4086
+ * Publishes a specified draft post by ID. This creates a new [post](https://dev.wix.com/docs/rest/business-solutions/blog/posts-stats) entity with the data from the draft post.
4087
+ * If the specified draft post was already published, the published post will be updated with the latest values
4088
+ * from the draft post entity.
3588
4089
  * @param draftPostId - Draft post ID.
3589
4090
  * @public
3590
4091
  * @requiredField draftPostId