@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
  /**
@@ -97,8 +138,7 @@ export interface DraftPost {
97
138
  /** SEO data. */
98
139
  seoData?: SeoSchema;
99
140
  /**
100
- * @internal Deprecated.
101
- * @internal Deprecated.
141
+ * Reserved for internal use.
102
142
  * @deprecated
103
143
  * @replacedBy preview_text_paragraph
104
144
  * @targetRemovalDate 2024-06-30
@@ -107,6 +147,8 @@ export interface DraftPost {
107
147
  /**
108
148
  * Reserved for internal use.
109
149
  * @readonly
150
+ * @maxSize 5000
151
+ * @maxLength 100
110
152
  */
111
153
  slugs?: string[];
112
154
  /**
@@ -119,7 +161,10 @@ export interface DraftPost {
119
161
  * @readonly
120
162
  */
121
163
  _createdDate?: Date | null;
122
- /** SEO slug. */
164
+ /**
165
+ * SEO slug.
166
+ * @maxLength 100
167
+ */
123
168
  seoSlug?: string | null;
124
169
  /** Post cover media. */
125
170
  media?: Media;
@@ -128,6 +173,7 @@ export interface DraftPost {
128
173
  /**
129
174
  * Reserved for internal use.
130
175
  * @readonly
176
+ * @maxLength 24
131
177
  */
132
178
  internalId?: string | null;
133
179
  }
@@ -149,7 +195,11 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
149
195
  displayed?: boolean;
150
196
  /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
151
197
  custom?: boolean;
152
- /** Media alternative text. */
198
+ /**
199
+ * Media alternative text.
200
+ * @minLength 1
201
+ * @maxLength 1000
202
+ */
153
203
  altText?: string | null;
154
204
  }
155
205
  /** @oneof */
@@ -526,7 +576,7 @@ export interface Link extends LinkDataOneOf {
526
576
  /** The target node's ID. Used for linking to another node in this object. */
527
577
  anchor?: string;
528
578
  /**
529
- * 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:
530
580
  * `SELF` - Default. Opens the linked document in the same frame as the link.
531
581
  * `BLANK` - Opens the linked document in a new browser tab or window.
532
582
  * `PARENT` - Opens the linked document in the link's parent frame.
@@ -562,7 +612,7 @@ export interface Rel {
562
612
  sponsored?: boolean | null;
563
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`. */
564
614
  ugc?: boolean | null;
565
- /** 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. */
566
616
  noreferrer?: boolean | null;
567
617
  }
568
618
  export interface CodeBlockData {
@@ -840,11 +890,20 @@ export interface GIFData {
840
890
  gifType?: GIFType;
841
891
  }
842
892
  export interface GIF {
843
- /** GIF format URL. */
893
+ /**
894
+ * GIF format URL.
895
+ * @format WEB_URL
896
+ */
844
897
  gif?: string | null;
845
- /** MP4 format URL. */
898
+ /**
899
+ * MP4 format URL.
900
+ * @format WEB_URL
901
+ */
846
902
  mp4?: string | null;
847
- /** Thumbnail URL. */
903
+ /**
904
+ * Thumbnail URL.
905
+ * @format WEB_URL
906
+ */
848
907
  still?: string | null;
849
908
  }
850
909
  export declare enum GIFType {
@@ -910,6 +969,25 @@ export interface ImageData {
910
969
  caption?: string | null;
911
970
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
912
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;
913
991
  }
914
992
  export interface LinkPreviewData {
915
993
  /** Styling for the link preview's container. */
@@ -924,6 +1002,51 @@ export interface LinkPreviewData {
924
1002
  description?: string | null;
925
1003
  /** The preview content as HTML. */
926
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;
927
1050
  }
928
1051
  export interface MapData {
929
1052
  /** Styling for the map's container. */
@@ -1056,13 +1179,22 @@ export declare enum BackgroundType {
1056
1179
  export interface Gradient {
1057
1180
  /** The gradient angle in degrees. */
1058
1181
  angle?: number | null;
1059
- /** The start color as a hexademical value. */
1182
+ /**
1183
+ * The start color as a hexademical value.
1184
+ * @format COLOR_HEX
1185
+ */
1060
1186
  startColor?: string | null;
1061
- /** The end color as a hexademical value. */
1187
+ /**
1188
+ * The end color as a hexademical value.
1189
+ * @format COLOR_HEX
1190
+ */
1062
1191
  lastColor?: string | null;
1063
1192
  }
1064
1193
  export interface Background extends BackgroundBackgroundOneOf {
1065
- /** The background color as a hexademical value. */
1194
+ /**
1195
+ * The background color as a hexademical value.
1196
+ * @format COLOR_HEX
1197
+ */
1066
1198
  color?: string | null;
1067
1199
  /** An image to use for the background. */
1068
1200
  image?: V1Media;
@@ -1073,7 +1205,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1073
1205
  }
1074
1206
  /** @oneof */
1075
1207
  export interface BackgroundBackgroundOneOf {
1076
- /** The background color as a hexademical value. */
1208
+ /**
1209
+ * The background color as a hexademical value.
1210
+ * @format COLOR_HEX
1211
+ */
1077
1212
  color?: string | null;
1078
1213
  /** An image to use for the background. */
1079
1214
  image?: V1Media;
@@ -1385,17 +1520,32 @@ export declare enum VerticalAlignment {
1385
1520
  export interface CellStyle {
1386
1521
  /** Vertical alignment for the cell's text. */
1387
1522
  verticalAlignment?: VerticalAlignment;
1388
- /** Cell background color as a hexadecimal value. */
1523
+ /**
1524
+ * Cell background color as a hexadecimal value.
1525
+ * @format COLOR_HEX
1526
+ */
1389
1527
  backgroundColor?: string | null;
1390
1528
  }
1391
1529
  export interface BorderColors {
1392
- /** Left border color as a hexadecimal value. */
1530
+ /**
1531
+ * Left border color as a hexadecimal value.
1532
+ * @format COLOR_HEX
1533
+ */
1393
1534
  left?: string | null;
1394
- /** Right border color as a hexadecimal value. */
1535
+ /**
1536
+ * Right border color as a hexadecimal value.
1537
+ * @format COLOR_HEX
1538
+ */
1395
1539
  right?: string | null;
1396
- /** Top border color as a hexadecimal value. */
1540
+ /**
1541
+ * Top border color as a hexadecimal value.
1542
+ * @format COLOR_HEX
1543
+ */
1397
1544
  top?: string | null;
1398
- /** Bottom border color as a hexadecimal value. */
1545
+ /**
1546
+ * Bottom border color as a hexadecimal value.
1547
+ * @format COLOR_HEX
1548
+ */
1399
1549
  bottom?: string | null;
1400
1550
  }
1401
1551
  /**
@@ -1523,13 +1673,19 @@ export declare enum Status {
1523
1673
  IN_REVIEW = "IN_REVIEW"
1524
1674
  }
1525
1675
  export interface ModerationDetails {
1526
- /** 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
+ */
1527
1680
  submittedBy?: string;
1528
1681
  /** Date the post was submitted for review. */
1529
1682
  submittedDate?: Date | null;
1530
1683
  /** Status indicating whether the submission was approved or rejected by the moderator. */
1531
1684
  status?: ModerationStatusStatus;
1532
- /** 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
+ */
1533
1689
  moderatedBy?: string | null;
1534
1690
  /** Date the post was approved or rejected. */
1535
1691
  moderationDate?: Date | null;
@@ -1555,7 +1711,10 @@ export interface Keyword {
1555
1711
  term?: string;
1556
1712
  /** Whether the keyword is the main focus keyword. */
1557
1713
  isMain?: boolean;
1558
- /** 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
+ */
1559
1718
  origin?: string | null;
1560
1719
  }
1561
1720
  export interface Tag {
@@ -1588,7 +1747,10 @@ export interface Settings {
1588
1747
  * Default: `false` (Auto Redirect is enabled.)
1589
1748
  */
1590
1749
  preventAutoRedirect?: boolean;
1591
- /** User-selected keyword terms for a specific page. */
1750
+ /**
1751
+ * User-selected keyword terms for a specific page.
1752
+ * @maxSize 5
1753
+ */
1592
1754
  keywords?: Keyword[];
1593
1755
  }
1594
1756
  export interface Media extends MediaMediaOneOf {
@@ -1600,7 +1762,11 @@ export interface Media extends MediaMediaOneOf {
1600
1762
  displayed?: boolean;
1601
1763
  /** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
1602
1764
  custom?: boolean;
1603
- /** Media alternative text. */
1765
+ /**
1766
+ * Media alternative text.
1767
+ * @minLength 1
1768
+ * @maxLength 1000
1769
+ */
1604
1770
  altText?: string | null;
1605
1771
  }
1606
1772
  /** @oneof */
@@ -1633,7 +1799,10 @@ export interface EmbedMedia {
1633
1799
  video?: EmbedVideo;
1634
1800
  }
1635
1801
  export interface EmbedThumbnail {
1636
- /** Thumbnail url. */
1802
+ /**
1803
+ * Thumbnail url.
1804
+ * @maxLength 2000
1805
+ */
1637
1806
  url?: string;
1638
1807
  /** Thumbnail width. */
1639
1808
  width?: number;
@@ -1641,7 +1810,10 @@ export interface EmbedThumbnail {
1641
1810
  height?: number;
1642
1811
  }
1643
1812
  export interface EmbedVideo {
1644
- /** Video url. */
1813
+ /**
1814
+ * Video url.
1815
+ * @maxLength 2000
1816
+ */
1645
1817
  url?: string;
1646
1818
  /** Video width. */
1647
1819
  width?: number;
@@ -1649,171 +1821,380 @@ export interface EmbedVideo {
1649
1821
  height?: number;
1650
1822
  }
1651
1823
  export interface DraftPostTranslation {
1652
- /** Post ID. */
1824
+ /**
1825
+ * Post ID.
1826
+ * @format GUID
1827
+ */
1653
1828
  _id?: string;
1654
1829
  /** Post status. */
1655
1830
  status?: Status;
1656
- /** Language the post is written in. */
1831
+ /**
1832
+ * Language the post is written in.
1833
+ * @format LANGUAGE_TAG
1834
+ */
1657
1835
  language?: string | null;
1658
- /** Post slug. For example, 'post-slug'. */
1836
+ /**
1837
+ * Post slug. For example, 'post-slug'.
1838
+ * @maxLength 100
1839
+ */
1659
1840
  slug?: string | null;
1660
1841
  /** SEO data. */
1661
1842
  seoData?: SeoSchema;
1662
1843
  /** Post URL. */
1663
1844
  url?: string;
1664
1845
  }
1665
- export interface InitialDraftPostsCopied {
1666
- /** Number of draft posts copied. */
1667
- count?: number;
1668
- }
1669
1846
  export interface DraftCategoriesUpdated {
1670
- /** Draft post ID. */
1847
+ /**
1848
+ * Draft post ID.
1849
+ * @maxLength 38
1850
+ */
1671
1851
  draftPostId?: string;
1672
- /** Current categories of the draft. */
1852
+ /**
1853
+ * Current categories of the draft.
1854
+ * @maxSize 10
1855
+ * @format GUID
1856
+ */
1673
1857
  categories?: string[];
1674
- /** Previous categories of the draft. */
1858
+ /**
1859
+ * Previous categories of the draft.
1860
+ * @maxSize 10
1861
+ * @format GUID
1862
+ */
1675
1863
  previousCategories?: string[];
1676
1864
  }
1677
1865
  export interface DraftTagsUpdated {
1678
- /** Draft post ID. */
1866
+ /**
1867
+ * Draft post ID.
1868
+ * @maxLength 38
1869
+ */
1679
1870
  draftPostId?: string;
1680
- /** Current tags of the draft. */
1871
+ /**
1872
+ * Current tags of the draft.
1873
+ * @maxSize 30
1874
+ * @format GUID
1875
+ */
1681
1876
  tags?: string[];
1682
- /** Previous tags of the draft. */
1877
+ /**
1878
+ * Previous tags of the draft.
1879
+ * @maxSize 30
1880
+ * @format GUID
1881
+ */
1683
1882
  previousTags?: string[];
1684
1883
  }
1685
- export interface CreateDraftPostRequest {
1686
- /** Draft post to create. */
1687
- draftPost: DraftPost;
1884
+ export interface GetDraftPostTotalsRequest {
1688
1885
  /**
1689
- * Whether the draft post should be published on creation.
1690
- *
1691
- * Default: `false`
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
1692
1890
  */
1693
- publish?: boolean;
1891
+ groupBy?: TotalDraftPostsGroupingField[];
1694
1892
  /**
1695
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1696
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
1697
- * only the draft post's base fields are returned.
1893
+ * Optional language filter by provided language code. Useful in multilingual context.
1894
+ * @format LANGUAGE_TAG
1698
1895
  */
1699
- fieldsets?: Field[];
1896
+ language?: string | null;
1700
1897
  }
1701
- export declare enum Type {
1702
- UNKNOWN = "UNKNOWN",
1703
- /** Manually saved. */
1704
- MANUAL = "MANUAL",
1705
- /** Triggered by autosave. */
1706
- AUTO_SAVE = "AUTO_SAVE",
1707
- /** Copied from template during provisioning flow. */
1708
- PROVISIONING = "PROVISIONING",
1709
- /** Imported from another blog. */
1710
- IMPORT = "IMPORT",
1711
- /** Triggered by autosave when post created by AI tool. */
1712
- AI_AUTO_SAVE = "AI_AUTO_SAVE"
1898
+ export declare enum TotalDraftPostsGroupingField {
1899
+ /** Groups results by status. */
1900
+ STATUS = "STATUS",
1901
+ /** Groups results by language. */
1902
+ LANGUAGE = "LANGUAGE"
1713
1903
  }
1714
- export declare enum Field {
1715
- /** Unknown field. */
1716
- UNKNOWN = "UNKNOWN",
1717
- /** Includes draft post preview URL. */
1718
- URL = "URL",
1904
+ export interface GetDraftPostTotalsResponse {
1905
+ /** Draft post totals. */
1906
+ totalDraftPosts?: TotalDraftPosts[];
1907
+ }
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;
1719
1913
  /**
1720
- * Includes internal id field.
1721
- * Reserved for internal use.
1914
+ * Draft post language code (only has value when grouping by language, otherwise null).
1915
+ * @format LANGUAGE_TAG
1722
1916
  */
1723
- INTERNAL_ID = "INTERNAL_ID",
1724
- /** Includes content field. */
1725
- CONTENT = "CONTENT",
1726
- /** Includes rich content field. */
1727
- RICH_CONTENT = "RICH_CONTENT",
1728
- /** If the user has not set excerpt, returns the one autogenerated from content. */
1729
- GENERATED_EXCERPT = "GENERATED_EXCERPT"
1730
- }
1731
- export interface CreateDraftPostResponse {
1732
- /** Created draft post info. */
1733
- draftPost?: DraftPost;
1917
+ language?: string | null;
1734
1918
  }
1735
- export interface BulkCreateDraftPostsRequest {
1736
- /** Draft posts to create. */
1737
- draftPosts: DraftPost[];
1738
- /** Whether the draft post should be published after creation. */
1739
- publish?: boolean;
1740
- /** Whether to return the full created draft post entities in the response. */
1741
- returnFullEntity?: boolean;
1919
+ export interface DomainEvent extends DomainEventBodyOneOf {
1920
+ createdEvent?: EntityCreatedEvent;
1921
+ updatedEvent?: EntityUpdatedEvent;
1922
+ deletedEvent?: EntityDeletedEvent;
1923
+ actionEvent?: ActionEvent;
1742
1924
  /**
1743
- * List of draft post fields to be included in the response if the entities are present.
1744
- * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
1745
- * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
1925
+ * Unique event ID.
1926
+ * Allows clients to ignore duplicate webhooks.
1746
1927
  */
1747
- fieldsets?: Field[];
1748
- }
1749
- export interface BulkCreateDraftPostsResponse {
1750
- /** Draft posts created by bulk action. */
1751
- results?: BulkDraftPostResult[];
1752
- /** Bulk action metadata. */
1753
- bulkActionMetadata?: BulkActionMetadata;
1754
- }
1755
- export interface BulkDraftPostResult {
1756
- /** Bulk actions metadata for draft post. */
1757
- itemMetadata?: ItemMetadata;
1758
- /** Optional full draft post. */
1759
- item?: DraftPost;
1760
- }
1761
- export interface ItemMetadata {
1762
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1763
- _id?: string | null;
1764
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1765
- originalIndex?: number;
1766
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1767
- success?: boolean;
1768
- /** Details about the error in case of failure. */
1769
- error?: ApplicationError;
1770
- }
1771
- export interface ApplicationError {
1772
- /** Error code. */
1773
- code?: string;
1774
- /** Description of the error. */
1775
- description?: string;
1776
- /** Data related to the error. */
1777
- data?: Record<string, any> | null;
1778
- }
1779
- export interface BulkActionMetadata {
1780
- /** Number of items that were successfully processed. */
1781
- totalSuccesses?: number;
1782
- /** Number of items that couldn't be processed. */
1783
- totalFailures?: number;
1784
- /** Number of failures without details because detailed failure threshold was exceeded. */
1785
- undetailedFailures?: number;
1786
- }
1787
- export interface BulkUpdateDraftPostsRequest {
1788
- /** Draft posts to update. */
1789
- draftPosts?: MaskedDraftPosts[];
1928
+ _id?: string;
1790
1929
  /**
1791
- * Action to perform on the posts.
1792
- *
1793
- * - `UPDATE`: Update the draft post.
1794
- * - `UPDATE_PUBLISH`: Update and publish the draft post.
1795
- * - `UPDATE_SCHEDULE`: Update the draft post and schedule a publish date.
1796
- * - `UPDATE_REVERT_TO_DRAFT`: Update the post and revert it to a draft post.
1797
- * - `UPDATE_CANCEL_SCHEDULE`: Update the draft post and cancel the scheduled publish date.
1798
- * - `UPDATE_REJECT`: Update and reject the draft post.
1799
- * - `UPDATE_PUBLICATION`: Update a published post. This creates and updates a draft version of the post. The original post is still published.
1800
- *
1801
- * Default: `UPDATE`
1930
+ * Assumes actions are also always typed to an entity_type
1931
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1802
1932
  */
1803
- action?: Action;
1804
- /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
1805
- scheduledPublishDate?: Date | null;
1806
- /** Whether to return the full updated draft post entities in the response. */
1807
- returnFullEntity?: boolean;
1933
+ entityFqdn?: string;
1808
1934
  /**
1809
- * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1810
- * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
1811
- * only the draft post's base fields are returned.
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
1812
1938
  */
1813
- fieldsets?: Field[];
1814
- }
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
+ }
1815
2196
  export interface MaskedDraftPosts {
1816
- /** Draft post info. */
2197
+ /** Draft post */
1817
2198
  draftPost?: DraftPost;
1818
2199
  /** Field mask of fields to update. */
1819
2200
  fieldMask?: string[];
@@ -1848,6 +2229,7 @@ export interface ListDeletedDraftPostsRequest {
1848
2229
  *
1849
2230
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1850
2231
  * If omitted, deleted draft posts in all languages are returned.
2232
+ * @format LANGUAGE_TAG
1851
2233
  */
1852
2234
  language?: string | null;
1853
2235
  /**
@@ -1862,9 +2244,14 @@ export interface ListDeletedDraftPostsRequest {
1862
2244
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1863
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
1864
2246
  * only the draft post's base fields are returned.
2247
+ * @maxSize 10
1865
2248
  */
1866
2249
  fieldsets?: Field[];
1867
- /** Draft post ids. */
2250
+ /**
2251
+ * Draft post ids.
2252
+ * @maxSize 100
2253
+ * @format GUID
2254
+ */
1868
2255
  draftPostIds?: string[];
1869
2256
  }
1870
2257
  export declare enum GetDraftPostsSort {
@@ -1886,9 +2273,14 @@ export interface BlogPaging {
1886
2273
  *
1887
2274
  *
1888
2275
  * Default:`50`
2276
+ * @min 1
2277
+ * @max 100
1889
2278
  */
1890
2279
  limit?: number;
1891
- /** 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
+ */
1892
2284
  cursor?: string | null;
1893
2285
  }
1894
2286
  export interface ListDeletedDraftPostsResponse {
@@ -1904,16 +2296,23 @@ export interface MetaData {
1904
2296
  offset?: number;
1905
2297
  /** Total number of items that match the query. */
1906
2298
  total?: number;
1907
- /** 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
+ */
1908
2303
  cursor?: string | null;
1909
2304
  }
1910
2305
  export interface GetDraftPostRequest {
1911
- /** Draft post ID. */
2306
+ /**
2307
+ * Draft post ID.
2308
+ * @maxLength 38
2309
+ */
1912
2310
  draftPostId: string;
1913
2311
  /**
1914
2312
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1915
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
1916
2314
  * only the draft post's base fields are returned.
2315
+ * @maxSize 10
1917
2316
  */
1918
2317
  fieldsets?: Field[];
1919
2318
  }
@@ -1922,11 +2321,17 @@ export interface GetDraftPostResponse {
1922
2321
  draftPost?: DraftPost;
1923
2322
  }
1924
2323
  export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
1925
- /** DraftJs content to update. */
2324
+ /**
2325
+ * DraftJs content to update.
2326
+ * @maxLength 400000
2327
+ */
1926
2328
  content?: string;
1927
- /** Draft post rich content. */
2329
+ /** Draft Post rich content. */
1928
2330
  richContent?: RichContent;
1929
- /** Draft post ID. */
2331
+ /**
2332
+ * Draft post ID.
2333
+ * @maxLength 38
2334
+ */
1930
2335
  draftPostId?: string;
1931
2336
  /** Change origin. */
1932
2337
  changeOrigin?: Origin;
@@ -1934,14 +2339,18 @@ export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentReq
1934
2339
  * List of draft post fields to be included if entities are present in the response.
1935
2340
  * Base fieldset, which is default, will return all core draft post properties.
1936
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
1937
2343
  */
1938
2344
  fieldsets?: Field[];
1939
2345
  }
1940
2346
  /** @oneof */
1941
2347
  export interface UpdateDraftPostContentRequestDraftContentOneOf {
1942
- /** DraftJs content to update. */
2348
+ /**
2349
+ * DraftJs content to update.
2350
+ * @maxLength 400000
2351
+ */
1943
2352
  content?: string;
1944
- /** Draft post rich content. */
2353
+ /** Draft Post rich content. */
1945
2354
  richContent?: RichContent;
1946
2355
  }
1947
2356
  export interface UpdateDraftPostContentResponse {
@@ -1963,6 +2372,7 @@ export interface UpdateDraftPostRequest {
1963
2372
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1964
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
1965
2374
  * only the draft post's base fields are returned.
2375
+ * @maxSize 10
1966
2376
  */
1967
2377
  fieldsets?: Field[];
1968
2378
  }
@@ -1971,7 +2381,10 @@ export interface UpdateDraftPostResponse {
1971
2381
  draftPost?: DraftPost;
1972
2382
  }
1973
2383
  export interface DeleteDraftPostRequest {
1974
- /** Draft post ID. */
2384
+ /**
2385
+ * Draft post ID.
2386
+ * @maxLength 38
2387
+ */
1975
2388
  draftPostId: string;
1976
2389
  /**
1977
2390
  * Whether to bypass the trash bin and delete the post permanently.
@@ -1983,13 +2396,21 @@ export interface DeleteDraftPostRequest {
1983
2396
  export interface DeleteDraftPostResponse {
1984
2397
  }
1985
2398
  export interface RemoveFromTrashBinRequest {
1986
- /** Draft post ID. */
2399
+ /**
2400
+ * Draft post ID.
2401
+ * @maxLength 38
2402
+ */
1987
2403
  draftPostId: string;
1988
2404
  }
1989
2405
  export interface RemoveFromTrashBinResponse {
1990
2406
  }
1991
2407
  export interface BulkDeleteDraftPostsRequest {
1992
- /** Post IDs. */
2408
+ /**
2409
+ * Post IDs.
2410
+ * @minSize 1
2411
+ * @maxSize 100
2412
+ * @maxLength 38
2413
+ */
1993
2414
  postIds: string[];
1994
2415
  /** Should delete bypassing the trash-bin. */
1995
2416
  permanent?: boolean;
@@ -2013,6 +2434,7 @@ export interface ListDraftPostsRequest {
2013
2434
  *
2014
2435
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2015
2436
  * If omitted, draft posts in all languages are returned.
2437
+ * @format LANGUAGE_TAG
2016
2438
  */
2017
2439
  language?: string | null;
2018
2440
  /**
@@ -2027,6 +2449,7 @@ export interface ListDraftPostsRequest {
2027
2449
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2028
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
2029
2451
  * only the draft post's base fields are returned.
2452
+ * @maxSize 10
2030
2453
  */
2031
2454
  fieldsets?: Field[];
2032
2455
  }
@@ -2037,7 +2460,10 @@ export interface ListDraftPostsResponse {
2037
2460
  metaData?: MetaData;
2038
2461
  }
2039
2462
  export interface GetDeletedDraftPostRequest {
2040
- /** Draft post ID. */
2463
+ /**
2464
+ * Draft post ID.
2465
+ * @maxLength 38
2466
+ */
2041
2467
  draftPostId: string;
2042
2468
  }
2043
2469
  export interface GetDeletedDraftPostResponse {
@@ -2045,7 +2471,10 @@ export interface GetDeletedDraftPostResponse {
2045
2471
  draftPost?: DraftPost;
2046
2472
  }
2047
2473
  export interface RestoreFromTrashBinRequest {
2048
- /** Draft post ID. */
2474
+ /**
2475
+ * Draft post ID.
2476
+ * @maxLength 38
2477
+ */
2049
2478
  draftPostId: string;
2050
2479
  }
2051
2480
  export interface RestoreFromTrashBinResponse {
@@ -2057,13 +2486,17 @@ export interface QueryDraftPostsRequest {
2057
2486
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2058
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
2059
2488
  * only the draft post's base fields are returned.
2489
+ * @maxSize 10
2060
2490
  */
2061
2491
  fieldsets?: Field[];
2062
2492
  /** Query options. */
2063
2493
  query?: PlatformQuery;
2064
2494
  }
2065
2495
  export interface Sorting {
2066
- /** Name of the field to sort by. */
2496
+ /**
2497
+ * Name of the field to sort by.
2498
+ * @maxLength 512
2499
+ */
2067
2500
  fieldName?: string;
2068
2501
  /** Sort order. */
2069
2502
  order?: SortOrder;
@@ -2089,6 +2522,7 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2089
2522
  /**
2090
2523
  * Sort object in the following format:
2091
2524
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2525
+ * @maxSize 3
2092
2526
  */
2093
2527
  sort?: Sorting[];
2094
2528
  }
@@ -2100,13 +2534,19 @@ export interface PlatformQueryPagingMethodOneOf {
2100
2534
  cursorPaging?: CursorPaging;
2101
2535
  }
2102
2536
  export interface Paging {
2103
- /** Number of items to load. */
2537
+ /**
2538
+ * Number of items to load.
2539
+ * @max 100
2540
+ */
2104
2541
  limit?: number | null;
2105
2542
  /** Number of items to skip in the current sort order. */
2106
2543
  offset?: number | null;
2107
2544
  }
2108
2545
  export interface CursorPaging {
2109
- /** Number of items to load. */
2546
+ /**
2547
+ * Number of items to load.
2548
+ * @max 100
2549
+ */
2110
2550
  limit?: number | null;
2111
2551
  /**
2112
2552
  * Pointer to the next or previous page in the list of results.
@@ -2114,6 +2554,7 @@ export interface CursorPaging {
2114
2554
  * You can get the relevant cursor token
2115
2555
  * from the `pagingMetadata` object in the previous call's response.
2116
2556
  * Not relevant for the first request.
2557
+ * @maxLength 2000
2117
2558
  */
2118
2559
  cursor?: string | null;
2119
2560
  }
@@ -2149,167 +2590,50 @@ export interface PagingMetadataV2 {
2149
2590
  cursors?: Cursors;
2150
2591
  }
2151
2592
  export interface Cursors {
2152
- /** 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
+ */
2153
2597
  next?: string | null;
2154
- /** 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
+ */
2155
2602
  prev?: string | null;
2156
2603
  }
2157
2604
  export interface PublishDraftPostRequest {
2158
- /** Draft post ID. */
2605
+ /**
2606
+ * Draft post ID.
2607
+ * @maxLength 38
2608
+ */
2159
2609
  draftPostId: string;
2160
2610
  }
2161
2611
  export interface PublishDraftPostResponse {
2162
- /** Published post ID. */
2612
+ /**
2613
+ * Published post ID.
2614
+ * @format GUID
2615
+ */
2163
2616
  postId?: string;
2164
2617
  }
2165
2618
  export interface UnpublishPostRequest {
2166
- /** Draft post ID. */
2167
- draftPostId?: string;
2168
- }
2169
- export interface UnpublishPostResponse {
2170
- }
2171
- export interface DomainEvent extends DomainEventBodyOneOf {
2172
- createdEvent?: EntityCreatedEvent;
2173
- updatedEvent?: EntityUpdatedEvent;
2174
- deletedEvent?: EntityDeletedEvent;
2175
- actionEvent?: ActionEvent;
2176
- /**
2177
- * Unique event ID.
2178
- * Allows clients to ignore duplicate webhooks.
2179
- */
2180
- _id?: string;
2181
- /**
2182
- * Assumes actions are also always typed to an entity_type
2183
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2184
- */
2185
- entityFqdn?: string;
2186
2619
  /**
2187
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2188
- * This is although the created/updated/deleted notion is duplication of the oneof types
2189
- * Example: created/updated/deleted/started/completed/email_opened
2190
- */
2191
- slug?: string;
2192
- /** ID of the entity associated with the event. */
2193
- entityId?: string;
2194
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2195
- eventTime?: Date | null;
2196
- /**
2197
- * Whether the event was triggered as a result of a privacy regulation application
2198
- * (for example, GDPR).
2199
- */
2200
- triggeredByAnonymizeRequest?: boolean | null;
2201
- /** If present, indicates the action that triggered the event. */
2202
- originatedFrom?: string | null;
2203
- /**
2204
- * A sequence number defining the order of updates to the underlying entity.
2205
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2206
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2207
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2208
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2209
- * 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
2210
2622
  */
2211
- entityEventSequence?: string | null;
2212
- }
2213
- /** @oneof */
2214
- export interface DomainEventBodyOneOf {
2215
- createdEvent?: EntityCreatedEvent;
2216
- updatedEvent?: EntityUpdatedEvent;
2217
- deletedEvent?: EntityDeletedEvent;
2218
- actionEvent?: ActionEvent;
2219
- }
2220
- export interface EntityCreatedEvent {
2221
- entity?: string;
2623
+ draftPostId?: string;
2222
2624
  }
2223
- export interface RestoreInfo {
2224
- deletedDate?: Date | null;
2625
+ export interface UnpublishPostResponse {
2225
2626
  }
2226
- export interface EntityUpdatedEvent {
2627
+ export interface TranslateCategoryRequest {
2227
2628
  /**
2228
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2229
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2230
- * 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
2231
2631
  */
2232
- currentEntity?: string;
2233
- }
2234
- export interface EntityDeletedEvent {
2235
- /** Entity that was deleted */
2236
- deletedEntity?: string | null;
2237
- }
2238
- export interface ActionEvent {
2239
- body?: string;
2240
- }
2241
- export interface MessageEnvelope {
2242
- /** App instance ID. */
2243
- instanceId?: string | null;
2244
- /** Event type. */
2245
- eventType?: string;
2246
- /** The identification type and identity data. */
2247
- identity?: IdentificationData;
2248
- /** Stringify payload. */
2249
- data?: string;
2250
- }
2251
- export interface IdentificationData extends IdentificationDataIdOneOf {
2252
- /** ID of a site visitor that has not logged in to the site. */
2253
- anonymousVisitorId?: string;
2254
- /** ID of a site visitor that has logged in to the site. */
2255
- memberId?: string;
2256
- /** ID of a Wix user (site owner, contributor, etc.). */
2257
- wixUserId?: string;
2258
- /** ID of an app. */
2259
- appId?: string;
2260
- /** @readonly */
2261
- identityType?: WebhookIdentityType;
2262
- }
2263
- /** @oneof */
2264
- export interface IdentificationDataIdOneOf {
2265
- /** ID of a site visitor that has not logged in to the site. */
2266
- anonymousVisitorId?: string;
2267
- /** ID of a site visitor that has logged in to the site. */
2268
- memberId?: string;
2269
- /** ID of a Wix user (site owner, contributor, etc.). */
2270
- wixUserId?: string;
2271
- /** ID of an app. */
2272
- appId?: string;
2273
- }
2274
- export declare enum WebhookIdentityType {
2275
- UNKNOWN = "UNKNOWN",
2276
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2277
- MEMBER = "MEMBER",
2278
- WIX_USER = "WIX_USER",
2279
- APP = "APP"
2280
- }
2281
- export interface GetDraftPostTotalsRequest {
2632
+ categoryId?: string;
2282
2633
  /**
2283
- * Group results by fields (defaults to grouping by status).
2284
- * If, for example, grouping by language is passed, language values in response will be filled.
2285
- * 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
2286
2636
  */
2287
- groupBy?: TotalDraftPostsGroupingField[];
2288
- /** Optional language filter by provided language code. Useful in multilingual context. */
2289
- language?: string | null;
2290
- }
2291
- export declare enum TotalDraftPostsGroupingField {
2292
- /** Groups results by status. */
2293
- STATUS = "STATUS",
2294
- /** Groups results by language. */
2295
- LANGUAGE = "LANGUAGE"
2296
- }
2297
- export interface GetDraftPostTotalsResponse {
2298
- /** Draft post totals. */
2299
- totalDraftPosts?: TotalDraftPosts[];
2300
- }
2301
- export interface TotalDraftPosts {
2302
- /** Draft post totals in that group. */
2303
- total?: number;
2304
- /** Draft post status (only has value when grouping by status, otherwise null). */
2305
- status?: Status;
2306
- /** Draft post language code (only has value when grouping by language, otherwise null). */
2307
- language?: string | null;
2308
- }
2309
- export interface TranslateCategoryRequest {
2310
- /** Source category ID */
2311
- categoryId?: string;
2312
- /** Translation language */
2313
2637
  language?: string;
2314
2638
  }
2315
2639
  export interface TranslateCategoryResponse {
@@ -2319,9 +2643,16 @@ export interface TranslateCategoryResponse {
2319
2643
  translations?: CategoryTranslation[];
2320
2644
  }
2321
2645
  export interface Category {
2322
- /** Category ID. */
2646
+ /**
2647
+ * Category ID.
2648
+ * @immutable
2649
+ * @maxLength 38
2650
+ */
2323
2651
  _id?: string;
2324
- /** Category label. Displayed in the Category Menu. */
2652
+ /**
2653
+ * Category label. Displayed in the Category Menu.
2654
+ * @maxLength 35
2655
+ */
2325
2656
  label?: string;
2326
2657
  /**
2327
2658
  * Number of posts in the category.
@@ -2333,10 +2664,14 @@ export interface Category {
2333
2664
  * @readonly
2334
2665
  */
2335
2666
  url?: string;
2336
- /** Category description. */
2667
+ /**
2668
+ * Category description.
2669
+ * @maxLength 500
2670
+ */
2337
2671
  description?: string | null;
2338
2672
  /**
2339
2673
  * Category title.
2674
+ * @maxLength 200
2340
2675
  * @deprecated Category title.
2341
2676
  * @targetRemovalDate 2025-07-16
2342
2677
  */
@@ -2348,19 +2683,27 @@ export interface Category {
2348
2683
  * Default: `-1`
2349
2684
  */
2350
2685
  displayPosition?: number | null;
2351
- /** 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
+ */
2352
2690
  translationId?: string | null;
2353
2691
  /**
2354
2692
  * Category language.
2355
2693
  *
2356
2694
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2695
+ * @immutable
2357
2696
  */
2358
2697
  language?: string | null;
2359
- /** 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
+ */
2360
2702
  slug?: string;
2361
2703
  /**
2362
2704
  * Reserved for internal use.
2363
2705
  * @readonly
2706
+ * @maxLength 24
2364
2707
  */
2365
2708
  internalId?: string | null;
2366
2709
  /** SEO data. */
@@ -2374,24 +2717,40 @@ export interface Category {
2374
2717
  _updatedDate?: Date | null;
2375
2718
  }
2376
2719
  export interface CategoryTranslation {
2377
- /** Category ID. */
2720
+ /**
2721
+ * Category ID.
2722
+ * @format GUID
2723
+ */
2378
2724
  _id?: string;
2379
- /** Label displayed in the categories menu on the site. */
2725
+ /**
2726
+ * Label displayed in the categories menu on the site.
2727
+ * @maxLength 100
2728
+ */
2380
2729
  label?: string | null;
2381
- /** Language of the category. */
2730
+ /**
2731
+ * Language of the category.
2732
+ * @format LANGUAGE_TAG
2733
+ */
2382
2734
  language?: string | null;
2383
2735
  /** URL of this category page. */
2384
2736
  url?: string;
2385
2737
  }
2386
2738
  export interface TranslateDraftRequest {
2387
- /** Source post or draft ID */
2739
+ /**
2740
+ * Source post or draft ID
2741
+ * @format GUID
2742
+ */
2388
2743
  postId?: string;
2389
- /** Translation language */
2744
+ /**
2745
+ * Translation language
2746
+ * @format LANGUAGE_TAG
2747
+ */
2390
2748
  language?: string;
2391
2749
  /**
2392
2750
  * List of draft post fields to be included if entities are present in the response.
2393
2751
  * Base fieldset, which is default, will return all core draft post properties.
2394
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
2395
2754
  */
2396
2755
  fieldsets?: Field[];
2397
2756
  }
@@ -2400,11 +2759,17 @@ export interface TranslateDraftResponse {
2400
2759
  draftPost?: DraftPost;
2401
2760
  }
2402
2761
  export interface IsDraftPostAutoTranslatableRequest {
2403
- /** Source post or draft ID. */
2762
+ /**
2763
+ * Source post or draft ID.
2764
+ * @format GUID
2765
+ */
2404
2766
  draftPostId?: string;
2405
2767
  }
2406
2768
  export interface IsDraftPostAutoTranslatableResponse {
2407
- /** Source draft post ID. */
2769
+ /**
2770
+ * Source draft post ID.
2771
+ * @format GUID
2772
+ */
2408
2773
  draftPostId?: string;
2409
2774
  /** Indicates if enough machine translation credits are available for the draft post translation. */
2410
2775
  translatable?: boolean;
@@ -2420,14 +2785,22 @@ export interface IsDraftPostAutoTranslatableResponse {
2420
2785
  contentTextCharacterCount?: number;
2421
2786
  }
2422
2787
  export interface UpdateDraftPostLanguageRequest {
2423
- /** Source draft post ID */
2788
+ /**
2789
+ * Source draft post ID
2790
+ * @format GUID
2791
+ */
2424
2792
  postId?: string;
2425
- /** New language to replace to */
2793
+ /**
2794
+ * New language to replace to
2795
+ * @minLength 2
2796
+ * @format LANGUAGE_TAG
2797
+ */
2426
2798
  language?: string;
2427
2799
  /**
2428
2800
  * List of draft post fields to be included if entities are present in the response.
2429
2801
  * Base fieldset, which is default, will return all core draft post properties.
2430
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
2431
2804
  */
2432
2805
  fieldsets?: Field[];
2433
2806
  }
@@ -2436,9 +2809,16 @@ export interface UpdateDraftPostLanguageResponse {
2436
2809
  draftPost?: DraftPost;
2437
2810
  }
2438
2811
  export interface BulkUpdateDraftPostLanguageRequest {
2439
- /** Source post or draft IDs */
2812
+ /**
2813
+ * Source post or draft IDs
2814
+ * @maxSize 50
2815
+ * @format GUID
2816
+ */
2440
2817
  ids?: string[];
2441
- /** New language to replace to */
2818
+ /**
2819
+ * New language to replace to
2820
+ * @format LANGUAGE_TAG
2821
+ */
2442
2822
  language?: string;
2443
2823
  /** Should full draft post be returned */
2444
2824
  returnFullEntity?: boolean;
@@ -2446,6 +2826,7 @@ export interface BulkUpdateDraftPostLanguageRequest {
2446
2826
  * List of draft post fields to be included if entities are present in the response.
2447
2827
  * Base fieldset, which is default, will return all core draft post properties.
2448
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
2449
2830
  */
2450
2831
  fieldsets?: Field[];
2451
2832
  }
@@ -2456,7 +2837,10 @@ export interface BulkUpdateDraftPostLanguageResponse {
2456
2837
  bulkActionMetadata?: BulkActionMetadata;
2457
2838
  }
2458
2839
  export interface GetPostAmountsByLanguageRequest {
2459
- /** Post status to filter by */
2840
+ /**
2841
+ * Post status to filter by
2842
+ * @maxLength 100
2843
+ */
2460
2844
  status?: string;
2461
2845
  }
2462
2846
  export interface GetPostAmountsByLanguageResponse {
@@ -2464,15 +2848,26 @@ export interface GetPostAmountsByLanguageResponse {
2464
2848
  postAmountsByLanguage?: PostAmountByLanguage[];
2465
2849
  }
2466
2850
  export interface PostAmountByLanguage {
2467
- /** Post language code */
2851
+ /**
2852
+ * Post language code
2853
+ * @format LANGUAGE_TAG
2854
+ */
2468
2855
  languageCode?: string;
2469
- /** Language flag */
2856
+ /**
2857
+ * Language flag
2858
+ * @format LANGUAGE_TAG
2859
+ */
2470
2860
  flag?: string;
2471
2861
  /** Post amount in that language */
2472
2862
  postAmount?: number;
2473
2863
  }
2474
2864
  export interface BulkRevertToUnpublishedRequest {
2475
- /** Source post IDs. */
2865
+ /**
2866
+ * Source post IDs.
2867
+ * @minSize 1
2868
+ * @maxSize 100
2869
+ * @format GUID
2870
+ */
2476
2871
  postIds?: string[];
2477
2872
  /** Should full draft post be returned. */
2478
2873
  returnFullEntity?: boolean;
@@ -2484,7 +2879,12 @@ export interface BulkRevertToUnpublishedResponse {
2484
2879
  bulkActionMetadata?: BulkActionMetadata;
2485
2880
  }
2486
2881
  export interface BulkRejectDraftPostRequest {
2487
- /** Source post IDs. */
2882
+ /**
2883
+ * Source post IDs.
2884
+ * @minSize 1
2885
+ * @maxSize 100
2886
+ * @format GUID
2887
+ */
2488
2888
  postIds?: string[];
2489
2889
  /** Should full draft post be returned. */
2490
2890
  returnFullEntity?: boolean;
@@ -2496,12 +2896,16 @@ export interface BulkRejectDraftPostResponse {
2496
2896
  bulkActionMetadata?: BulkActionMetadata;
2497
2897
  }
2498
2898
  export interface RevertToUnpublishedRequest {
2499
- /** Source post ID. */
2899
+ /**
2900
+ * Source post ID.
2901
+ * @format GUID
2902
+ */
2500
2903
  postId?: string;
2501
2904
  /**
2502
2905
  * List of draft post fields to be included if entities are present in the response.
2503
2906
  * Base fieldset, which is default, will return all core draft post properties.
2504
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
2505
2909
  */
2506
2910
  fieldsets?: Field[];
2507
2911
  }
@@ -2510,12 +2914,16 @@ export interface RevertToUnpublishedResponse {
2510
2914
  draftPost?: DraftPost;
2511
2915
  }
2512
2916
  export interface RejectDraftPostRequest {
2513
- /** Source post ID. */
2917
+ /**
2918
+ * Source post ID.
2919
+ * @format GUID
2920
+ */
2514
2921
  postId?: string;
2515
2922
  /**
2516
2923
  * List of draft post fields to be included if entities are present in the response.
2517
2924
  * Base fieldset, which is default, will return all core draft post properties.
2518
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
2519
2927
  */
2520
2928
  fieldsets?: Field[];
2521
2929
  }
@@ -2524,14 +2932,21 @@ export interface RejectDraftPostResponse {
2524
2932
  draftPost?: DraftPost;
2525
2933
  }
2526
2934
  export interface ApproveDraftPostRequest {
2527
- /** Source post ID. */
2935
+ /**
2936
+ * Source post ID.
2937
+ * @format GUID
2938
+ */
2528
2939
  postId?: string;
2529
- /** Scheduled publish date if should be not immediately published. */
2940
+ /**
2941
+ * Scheduled publish date if should be not immediately published.
2942
+ * @maxLength 24
2943
+ */
2530
2944
  scheduledPublishDate?: string | null;
2531
2945
  /**
2532
2946
  * List of draft post fields to be included if entities are present in the response.
2533
2947
  * Base fieldset, which is default, will return all core draft post properties.
2534
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
2535
2950
  */
2536
2951
  fieldsets?: Field[];
2537
2952
  }
@@ -2540,12 +2955,16 @@ export interface ApproveDraftPostResponse {
2540
2955
  draftPost?: DraftPost;
2541
2956
  }
2542
2957
  export interface MarkPostAsInModerationRequest {
2543
- /** Source post ID. */
2958
+ /**
2959
+ * Source post ID.
2960
+ * @maxLength 38
2961
+ */
2544
2962
  postId?: string;
2545
2963
  /**
2546
2964
  * List of draft post fields to be included if entities are present in the response.
2547
2965
  * Base fieldset, which is default, will return all core draft post properties.
2548
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
2549
2968
  */
2550
2969
  fieldsets?: Field[];
2551
2970
  }
@@ -2642,9 +3061,13 @@ interface ImageDataNonNullableFields {
2642
3061
  containerData?: PluginContainerDataNonNullableFields;
2643
3062
  link?: LinkNonNullableFields;
2644
3063
  }
3064
+ interface LinkPreviewDataStylesNonNullableFields {
3065
+ thumbnailPosition: Position;
3066
+ }
2645
3067
  interface LinkPreviewDataNonNullableFields {
2646
3068
  containerData?: PluginContainerDataNonNullableFields;
2647
3069
  link?: LinkNonNullableFields;
3070
+ styles?: LinkPreviewDataStylesNonNullableFields;
2648
3071
  }
2649
3072
  interface MapSettingsNonNullableFields {
2650
3073
  mapType: MapType;
@@ -2948,9 +3371,15 @@ export interface PublishDraftPostResponseNonNullableFields {
2948
3371
  postId: string;
2949
3372
  }
2950
3373
  export interface BaseEventMetadata {
2951
- /** App instance ID. */
3374
+ /**
3375
+ * App instance ID.
3376
+ * @format GUID
3377
+ */
2952
3378
  instanceId?: string | null;
2953
- /** Event type. */
3379
+ /**
3380
+ * Event type.
3381
+ * @maxLength 150
3382
+ */
2954
3383
  eventType?: string;
2955
3384
  /** The identification type and identity data. */
2956
3385
  identity?: IdentificationData;
@@ -3068,7 +3497,7 @@ export declare function onDraftUpdated(handler: (event: DraftUpdatedEnvelope) =>
3068
3497
  /**
3069
3498
  * Creates a draft post.
3070
3499
  *
3071
- * 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.
3072
3501
  * @param draftPost - Draft post to create.
3073
3502
  * @public
3074
3503
  * @requiredField draftPost
@@ -3092,6 +3521,7 @@ export interface CreateDraftPostOptions {
3092
3521
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3093
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
3094
3523
  * only the draft post's base fields are returned.
3524
+ * @maxSize 10
3095
3525
  */
3096
3526
  fieldsets?: Field[];
3097
3527
  }
@@ -3118,6 +3548,7 @@ export interface BulkCreateDraftPostsOptions {
3118
3548
  * List of draft post fields to be included in the response if the entities are present.
3119
3549
  * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
3120
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
3121
3552
  */
3122
3553
  fieldsets?: Field[];
3123
3554
  }
@@ -3135,19 +3566,15 @@ export interface BulkCreateDraftPostsOptions {
3135
3566
  */
3136
3567
  export declare function bulkUpdateDraftPosts(options?: BulkUpdateDraftPostsOptions): Promise<BulkUpdateDraftPostsResponse & BulkUpdateDraftPostsResponseNonNullableFields>;
3137
3568
  export interface BulkUpdateDraftPostsOptions {
3138
- /** Draft posts to update. */
3569
+ /**
3570
+ * Draft posts to update.
3571
+ * @minSize 1
3572
+ * @maxSize 20
3573
+ */
3139
3574
  draftPosts?: MaskedDraftPosts[];
3140
3575
  /**
3141
3576
  * Action to perform on the posts.
3142
3577
  *
3143
- * - `UPDATE`: Update the draft post.
3144
- * - `UPDATE_PUBLISH`: Update and publish the draft post.
3145
- * - `UPDATE_SCHEDULE`: Update the draft post and schedule a publish date.
3146
- * - `UPDATE_REVERT_TO_DRAFT`: Update the post and revert it to a draft post.
3147
- * - `UPDATE_CANCEL_SCHEDULE`: Update the draft post and cancel the scheduled publish date.
3148
- * - `UPDATE_REJECT`: Update and reject the draft post.
3149
- * - `UPDATE_PUBLICATION`: Update a published post. This creates and updates a draft version of the post. The original post is still published.
3150
- *
3151
3578
  * Default: `UPDATE`
3152
3579
  */
3153
3580
  action?: Action;
@@ -3159,13 +3586,14 @@ export interface BulkUpdateDraftPostsOptions {
3159
3586
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3160
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
3161
3588
  * only the draft post's base fields are returned.
3589
+ * @maxSize 10
3162
3590
  */
3163
3591
  fieldsets?: Field[];
3164
3592
  }
3165
3593
  /**
3166
3594
  * Retrieves a list of up to 100 deleted draft posts.
3167
3595
  *
3168
- * List Deleted Draft Posts runs with these defaults, which you can override:
3596
+ * List Draft Posts runs with these defaults, which you can override:
3169
3597
  * - `editedDate` is sorted in descending order. In this case,`editedDate` implies the date the post was deleted.
3170
3598
  * - `paging.limit` is `50`.
3171
3599
  * - `paging.offset` is `0`.
@@ -3184,6 +3612,7 @@ export interface ListDeletedDraftPostsOptions {
3184
3612
  *
3185
3613
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3186
3614
  * If omitted, deleted draft posts in all languages are returned.
3615
+ * @format LANGUAGE_TAG
3187
3616
  */
3188
3617
  language?: string | null;
3189
3618
  /**
@@ -3198,15 +3627,18 @@ export interface ListDeletedDraftPostsOptions {
3198
3627
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3199
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
3200
3629
  * only the draft post's base fields are returned.
3630
+ * @maxSize 10
3201
3631
  */
3202
3632
  fieldsets?: Field[];
3203
- /** Draft post ids. */
3633
+ /**
3634
+ * Draft post ids.
3635
+ * @maxSize 100
3636
+ * @format GUID
3637
+ */
3204
3638
  draftPostIds?: string[];
3205
3639
  }
3206
3640
  /**
3207
3641
  * Gets a draft post by the provided ID.
3208
- *
3209
- * Uses the provided `draftPostId` to retrieve a draft post.
3210
3642
  * @param draftPostId - Draft post ID.
3211
3643
  * @public
3212
3644
  * @requiredField draftPostId
@@ -3223,6 +3655,7 @@ export interface GetDraftPostOptions {
3223
3655
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3224
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
3225
3657
  * only the draft post's base fields are returned.
3658
+ * @maxSize 10
3226
3659
  */
3227
3660
  fieldsets?: Field[];
3228
3661
  }
@@ -3245,24 +3678,40 @@ export interface UpdateDraftPost {
3245
3678
  /**
3246
3679
  * Draft post ID.
3247
3680
  * @readonly
3681
+ * @maxLength 38
3248
3682
  */
3249
3683
  _id?: string;
3250
- /** Draft post title. */
3684
+ /**
3685
+ * Draft post title.
3686
+ * @maxLength 200
3687
+ */
3251
3688
  title?: string;
3252
3689
  /**
3253
3690
  * Draft post excerpt.
3254
3691
  *
3255
3692
  * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
3256
3693
  * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
3694
+ * @maxLength 500
3257
3695
  */
3258
3696
  excerpt?: string | null;
3259
3697
  /** Whether the draft post is marked as featured. */
3260
3698
  featured?: boolean | null;
3261
- /** Category IDs of the draft post. */
3699
+ /**
3700
+ * Category IDs of the draft post.
3701
+ * @maxSize 10
3702
+ * @maxLength 38
3703
+ */
3262
3704
  categoryIds?: string[];
3263
- /** Draft post owner's member ID. */
3705
+ /**
3706
+ * Draft post owner's member ID.
3707
+ * @format GUID
3708
+ */
3264
3709
  memberId?: string | null;
3265
- /** Hashtags in the draft post. */
3710
+ /**
3711
+ * Hashtags in the post.
3712
+ * @maxSize 100
3713
+ * @maxLength 100
3714
+ */
3266
3715
  hashtags?: string[];
3267
3716
  /** Whether commenting on the draft post is enabled. */
3268
3717
  commentingEnabled?: boolean | null;
@@ -3273,23 +3722,37 @@ export interface UpdateDraftPost {
3273
3722
  minutesToRead?: number;
3274
3723
  /** Image placed at the top of the blog page. */
3275
3724
  heroImage?: string;
3276
- /** 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
+ */
3277
3730
  tagIds?: string[];
3278
- /** 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
+ */
3279
3736
  relatedPostIds?: string[];
3280
- /** 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
+ */
3281
3742
  pricingPlanIds?: string[];
3282
3743
  /**
3283
3744
  * ID of the draft post's translations.
3284
3745
  *
3285
3746
  * All translations of a single post share the same `translationId`.
3286
3747
  * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3748
+ * @format GUID
3287
3749
  */
3288
3750
  translationId?: string | null;
3289
3751
  /**
3290
3752
  * Language the draft post is written in.
3291
3753
  *
3292
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
3293
3756
  */
3294
3757
  language?: string | null;
3295
3758
  /**
@@ -3300,11 +3763,21 @@ export interface UpdateDraftPost {
3300
3763
  /**
3301
3764
  * Reserved for internal use.
3302
3765
  * @readonly
3766
+ * @maxLength 24
3303
3767
  */
3304
3768
  contentId?: string | null;
3305
- /** Reserved for internal use. */
3769
+ /**
3770
+ * Reserved for internal use.
3771
+ * @format GUID
3772
+ */
3306
3773
  editingSessionId?: string | null;
3307
- /** 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
+ */
3308
3781
  richContent?: RichContent;
3309
3782
  /**
3310
3783
  * Status of the draft post.
@@ -3316,6 +3789,7 @@ export interface UpdateDraftPost {
3316
3789
  /**
3317
3790
  * Reserved for internal use.
3318
3791
  * @readonly
3792
+ * @format GUID
3319
3793
  */
3320
3794
  mostRecentContributorId?: string | null;
3321
3795
  /**
@@ -3340,8 +3814,7 @@ export interface UpdateDraftPost {
3340
3814
  /** SEO data. */
3341
3815
  seoData?: SeoSchema;
3342
3816
  /**
3343
- * @internal Deprecated.
3344
- * @internal Deprecated.
3817
+ * Reserved for internal use.
3345
3818
  * @deprecated
3346
3819
  * @replacedBy preview_text_paragraph
3347
3820
  * @targetRemovalDate 2024-06-30
@@ -3350,6 +3823,8 @@ export interface UpdateDraftPost {
3350
3823
  /**
3351
3824
  * Reserved for internal use.
3352
3825
  * @readonly
3826
+ * @maxSize 5000
3827
+ * @maxLength 100
3353
3828
  */
3354
3829
  slugs?: string[];
3355
3830
  /**
@@ -3362,7 +3837,10 @@ export interface UpdateDraftPost {
3362
3837
  * @readonly
3363
3838
  */
3364
3839
  _createdDate?: Date | null;
3365
- /** SEO slug. */
3840
+ /**
3841
+ * SEO slug.
3842
+ * @maxLength 100
3843
+ */
3366
3844
  seoSlug?: string | null;
3367
3845
  /** Post cover media. */
3368
3846
  media?: Media;
@@ -3371,6 +3849,7 @@ export interface UpdateDraftPost {
3371
3849
  /**
3372
3850
  * Reserved for internal use.
3373
3851
  * @readonly
3852
+ * @maxLength 24
3374
3853
  */
3375
3854
  internalId?: string | null;
3376
3855
  }
@@ -3387,14 +3866,15 @@ export interface UpdateDraftPostOptions {
3387
3866
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3388
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
3389
3868
  * only the draft post's base fields are returned.
3869
+ * @maxSize 10
3390
3870
  */
3391
3871
  fieldsets?: Field[];
3392
3872
  }
3393
3873
  /**
3394
- * Moves a draft post with the provided ID to the trash bin.
3395
- * 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).
3396
3876
  *
3397
- * 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.
3398
3878
  * @param draftPostId - Draft post ID.
3399
3879
  * @public
3400
3880
  * @requiredField draftPostId
@@ -3415,9 +3895,7 @@ export interface DeleteDraftPostOptions {
3415
3895
  permanent?: boolean;
3416
3896
  }
3417
3897
  /**
3418
- * Permanently deletes a draft post by the provided ID from the trash bin.
3419
- *
3420
- * 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.
3421
3899
  * @param draftPostId - Draft post ID.
3422
3900
  * @public
3423
3901
  * @requiredField draftPostId
@@ -3474,6 +3952,7 @@ export interface ListDraftPostsOptions {
3474
3952
  *
3475
3953
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3476
3954
  * If omitted, draft posts in all languages are returned.
3955
+ * @format LANGUAGE_TAG
3477
3956
  */
3478
3957
  language?: string | null;
3479
3958
  /**
@@ -3488,13 +3967,12 @@ export interface ListDraftPostsOptions {
3488
3967
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3489
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
3490
3969
  * only the draft post's base fields are returned.
3970
+ * @maxSize 10
3491
3971
  */
3492
3972
  fieldsets?: Field[];
3493
3973
  }
3494
3974
  /**
3495
3975
  * Gets a deleted draft post from the trash bin by the provided ID.
3496
- *
3497
- * Uses the provided `draftPostId` to retrieve a previously deleted draft post from the trash bin.
3498
3976
  * @param draftPostId - Draft post ID.
3499
3977
  * @public
3500
3978
  * @requiredField draftPostId
@@ -3507,8 +3985,6 @@ export interface ListDraftPostsOptions {
3507
3985
  export declare function getDeletedDraftPost(draftPostId: string): Promise<GetDeletedDraftPostResponse & GetDeletedDraftPostResponseNonNullableFields>;
3508
3986
  /**
3509
3987
  * Restores a deleted draft post from the trash bin by the provided ID.
3510
- *
3511
- * Uses the `draftPostId` to restore a deleted draft post from the trash bin.
3512
3988
  * @param draftPostId - Draft post ID.
3513
3989
  * @public
3514
3990
  * @requiredField draftPostId
@@ -3520,12 +3996,20 @@ export declare function getDeletedDraftPost(draftPostId: string): Promise<GetDel
3520
3996
  */
3521
3997
  export declare function restoreFromTrashBin(draftPostId: string): Promise<RestoreFromTrashBinResponse & RestoreFromTrashBinResponseNonNullableFields>;
3522
3998
  /**
3523
- * 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.
3524
4000
  *
3525
- * Query Draft Posts runs with these defaults, which you can override:
3526
- * - `editedDate` is sorted in `DESC` order.
3527
- * - `paging.limit` is `50`.
3528
- * - `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`.
3529
4013
  * @public
3530
4014
  * @param options - Options for querying draft posts.
3531
4015
  * @permissionScope Manage Blog
@@ -3540,6 +4024,7 @@ export interface QueryDraftPostsOptions {
3540
4024
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3541
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
3542
4026
  * only the draft post's base fields are returned.
4027
+ * @maxSize 10
3543
4028
  */
3544
4029
  fieldsets?: Field[] | undefined;
3545
4030
  }
@@ -3598,9 +4083,9 @@ export interface DraftPostsQueryBuilder {
3598
4083
  find: () => Promise<DraftPostsQueryResult>;
3599
4084
  }
3600
4085
  /**
3601
- * Publishes a specified draft post by ID. This creates a new post entity with the data from the draft post.
3602
- *
3603
- * 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.
3604
4089
  * @param draftPostId - Draft post ID.
3605
4090
  * @public
3606
4091
  * @requiredField draftPostId