@wix/auto_sdk_blog_draft-posts 1.0.2 → 1.0.3

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 (49) 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.public.d.ts +1 -1
  5. package/build/cjs/src/blog-v3-draft-draft-posts.public.js +3 -2
  6. package/build/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -1
  7. package/build/cjs/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
  8. package/build/cjs/src/blog-v3-draft-draft-posts.types.js +27 -16
  9. package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
  10. package/build/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +807 -316
  11. package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +28 -17
  12. package/build/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
  13. package/build/es/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
  14. package/build/es/src/blog-v3-draft-draft-posts.context.js +1 -1
  15. package/build/es/src/blog-v3-draft-draft-posts.context.js.map +1 -1
  16. package/build/es/src/blog-v3-draft-draft-posts.public.d.ts +1 -1
  17. package/build/es/src/blog-v3-draft-draft-posts.public.js +1 -1
  18. package/build/es/src/blog-v3-draft-draft-posts.public.js.map +1 -1
  19. package/build/es/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
  20. package/build/es/src/blog-v3-draft-draft-posts.types.js +26 -15
  21. package/build/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
  22. package/build/es/src/blog-v3-draft-draft-posts.universal.d.ts +807 -316
  23. package/build/es/src/blog-v3-draft-draft-posts.universal.js +26 -15
  24. package/build/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
  25. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
  26. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js +5 -4
  27. package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js.map +1 -1
  28. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.d.ts +1 -1
  29. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js +3 -2
  30. package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -1
  31. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
  32. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +27 -16
  33. package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
  34. package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +807 -316
  35. package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +28 -17
  36. package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
  37. package/build/internal/es/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
  38. package/build/internal/es/src/blog-v3-draft-draft-posts.context.js +1 -1
  39. package/build/internal/es/src/blog-v3-draft-draft-posts.context.js.map +1 -1
  40. package/build/internal/es/src/blog-v3-draft-draft-posts.public.d.ts +1 -1
  41. package/build/internal/es/src/blog-v3-draft-draft-posts.public.js +1 -1
  42. package/build/internal/es/src/blog-v3-draft-draft-posts.public.js.map +1 -1
  43. package/build/internal/es/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
  44. package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +26 -15
  45. package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
  46. package/build/internal/es/src/blog-v3-draft-draft-posts.universal.d.ts +807 -316
  47. package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +26 -15
  48. package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
  49. 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 draft 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. 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,9 +87,13 @@ 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
98
  /** Draft post rich content. */
65
99
  richContent?: RichContent;
@@ -73,6 +107,7 @@ export interface DraftPost {
73
107
  /**
74
108
  * Reserved for internal use.
75
109
  * @readonly
110
+ * @format GUID
76
111
  */
77
112
  mostRecentContributorId?: string | null;
78
113
  /**
@@ -107,6 +142,8 @@ export interface DraftPost {
107
142
  /**
108
143
  * Reserved for internal use.
109
144
  * @readonly
145
+ * @maxSize 5000
146
+ * @maxLength 100
110
147
  */
111
148
  slugs?: string[];
112
149
  /**
@@ -119,7 +156,10 @@ export interface DraftPost {
119
156
  * @readonly
120
157
  */
121
158
  _createdDate?: Date | null;
122
- /** SEO slug. */
159
+ /**
160
+ * SEO slug.
161
+ * @maxLength 100
162
+ */
123
163
  seoSlug?: string | null;
124
164
  /** Post cover media. */
125
165
  media?: Media;
@@ -128,6 +168,7 @@ export interface DraftPost {
128
168
  /**
129
169
  * Reserved for internal use.
130
170
  * @readonly
171
+ * @maxLength 24
131
172
  */
132
173
  internalId?: string | null;
133
174
  }
@@ -149,7 +190,11 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
149
190
  displayed?: boolean;
150
191
  /** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
151
192
  custom?: boolean;
152
- /** Media alternative text. */
193
+ /**
194
+ * Media alternative text.
195
+ * @minLength 1
196
+ * @maxLength 1000
197
+ */
153
198
  altText?: string | null;
154
199
  }
155
200
  /** @oneof */
@@ -840,11 +885,20 @@ export interface GIFData {
840
885
  gifType?: GIFType;
841
886
  }
842
887
  export interface GIF {
843
- /** GIF format URL. */
888
+ /**
889
+ * GIF format URL.
890
+ * @format WEB_URL
891
+ */
844
892
  gif?: string | null;
845
- /** MP4 format URL. */
893
+ /**
894
+ * MP4 format URL.
895
+ * @format WEB_URL
896
+ */
846
897
  mp4?: string | null;
847
- /** Thumbnail URL. */
898
+ /**
899
+ * Thumbnail URL.
900
+ * @format WEB_URL
901
+ */
848
902
  still?: string | null;
849
903
  }
850
904
  export declare enum GIFType {
@@ -910,6 +964,25 @@ export interface ImageData {
910
964
  caption?: string | null;
911
965
  /** Sets whether the image's download button is disabled. Defaults to `false`. */
912
966
  disableDownload?: boolean | null;
967
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
968
+ decorative?: boolean | null;
969
+ /** Styling for the image. */
970
+ styles?: ImageDataStyles;
971
+ }
972
+ export interface StylesBorder {
973
+ /** Border width in pixels. */
974
+ width?: number | null;
975
+ /**
976
+ * Border color as a hexadecimal value.
977
+ * @format COLOR_HEX
978
+ */
979
+ color?: string | null;
980
+ /** Border radius in pixels. */
981
+ radius?: number | null;
982
+ }
983
+ export interface ImageDataStyles {
984
+ /** Border attributes. */
985
+ border?: StylesBorder;
913
986
  }
914
987
  export interface LinkPreviewData {
915
988
  /** Styling for the link preview's container. */
@@ -924,6 +997,51 @@ export interface LinkPreviewData {
924
997
  description?: string | null;
925
998
  /** The preview content as HTML. */
926
999
  html?: string | null;
1000
+ /** Styling for the link preview. */
1001
+ styles?: LinkPreviewDataStyles;
1002
+ }
1003
+ export declare enum Position {
1004
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
1005
+ START = "START",
1006
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
1007
+ END = "END",
1008
+ /** Thumbnail positioned at the top */
1009
+ TOP = "TOP",
1010
+ /** Thumbnail hidden and not displayed */
1011
+ HIDDEN = "HIDDEN"
1012
+ }
1013
+ export interface LinkPreviewDataStyles {
1014
+ /**
1015
+ * Background color as a hexadecimal value.
1016
+ * @format COLOR_HEX
1017
+ */
1018
+ backgroundColor?: string | null;
1019
+ /**
1020
+ * Title color as a hexadecimal value.
1021
+ * @format COLOR_HEX
1022
+ */
1023
+ titleColor?: string | null;
1024
+ /**
1025
+ * Subtitle color as a hexadecimal value.
1026
+ * @format COLOR_HEX
1027
+ */
1028
+ subtitleColor?: string | null;
1029
+ /**
1030
+ * Link color as a hexadecimal value.
1031
+ * @format COLOR_HEX
1032
+ */
1033
+ linkColor?: string | null;
1034
+ /** Border width in pixels. */
1035
+ borderWidth?: number | null;
1036
+ /** Border radius in pixels. */
1037
+ borderRadius?: number | null;
1038
+ /**
1039
+ * Border color as a hexadecimal value.
1040
+ * @format COLOR_HEX
1041
+ */
1042
+ borderColor?: string | null;
1043
+ /** Position of thumbnail. Defaults to `START`. */
1044
+ thumbnailPosition?: Position;
927
1045
  }
928
1046
  export interface MapData {
929
1047
  /** Styling for the map's container. */
@@ -1056,13 +1174,22 @@ export declare enum BackgroundType {
1056
1174
  export interface Gradient {
1057
1175
  /** The gradient angle in degrees. */
1058
1176
  angle?: number | null;
1059
- /** The start color as a hexademical value. */
1177
+ /**
1178
+ * The start color as a hexademical value.
1179
+ * @format COLOR_HEX
1180
+ */
1060
1181
  startColor?: string | null;
1061
- /** The end color as a hexademical value. */
1182
+ /**
1183
+ * The end color as a hexademical value.
1184
+ * @format COLOR_HEX
1185
+ */
1062
1186
  lastColor?: string | null;
1063
1187
  }
1064
1188
  export interface Background extends BackgroundBackgroundOneOf {
1065
- /** The background color as a hexademical value. */
1189
+ /**
1190
+ * The background color as a hexademical value.
1191
+ * @format COLOR_HEX
1192
+ */
1066
1193
  color?: string | null;
1067
1194
  /** An image to use for the background. */
1068
1195
  image?: V1Media;
@@ -1073,7 +1200,10 @@ export interface Background extends BackgroundBackgroundOneOf {
1073
1200
  }
1074
1201
  /** @oneof */
1075
1202
  export interface BackgroundBackgroundOneOf {
1076
- /** The background color as a hexademical value. */
1203
+ /**
1204
+ * The background color as a hexademical value.
1205
+ * @format COLOR_HEX
1206
+ */
1077
1207
  color?: string | null;
1078
1208
  /** An image to use for the background. */
1079
1209
  image?: V1Media;
@@ -1385,17 +1515,32 @@ export declare enum VerticalAlignment {
1385
1515
  export interface CellStyle {
1386
1516
  /** Vertical alignment for the cell's text. */
1387
1517
  verticalAlignment?: VerticalAlignment;
1388
- /** Cell background color as a hexadecimal value. */
1518
+ /**
1519
+ * Cell background color as a hexadecimal value.
1520
+ * @format COLOR_HEX
1521
+ */
1389
1522
  backgroundColor?: string | null;
1390
1523
  }
1391
1524
  export interface BorderColors {
1392
- /** Left border color as a hexadecimal value. */
1525
+ /**
1526
+ * Left border color as a hexadecimal value.
1527
+ * @format COLOR_HEX
1528
+ */
1393
1529
  left?: string | null;
1394
- /** Right border color as a hexadecimal value. */
1530
+ /**
1531
+ * Right border color as a hexadecimal value.
1532
+ * @format COLOR_HEX
1533
+ */
1395
1534
  right?: string | null;
1396
- /** Top border color as a hexadecimal value. */
1535
+ /**
1536
+ * Top border color as a hexadecimal value.
1537
+ * @format COLOR_HEX
1538
+ */
1397
1539
  top?: string | null;
1398
- /** Bottom border color as a hexadecimal value. */
1540
+ /**
1541
+ * Bottom border color as a hexadecimal value.
1542
+ * @format COLOR_HEX
1543
+ */
1399
1544
  bottom?: string | null;
1400
1545
  }
1401
1546
  /**
@@ -1523,13 +1668,19 @@ export declare enum Status {
1523
1668
  IN_REVIEW = "IN_REVIEW"
1524
1669
  }
1525
1670
  export interface ModerationDetails {
1526
- /** Member ID of the person submitting the draft post for review. */
1671
+ /**
1672
+ * Member ID of the person submitting the draft post for review.
1673
+ * @format GUID
1674
+ */
1527
1675
  submittedBy?: string;
1528
1676
  /** Date the post was submitted for review. */
1529
1677
  submittedDate?: Date | null;
1530
1678
  /** Status indicating whether the submission was approved or rejected by the moderator. */
1531
1679
  status?: ModerationStatusStatus;
1532
- /** Member ID of the person who approved or rejected the post. */
1680
+ /**
1681
+ * Member ID of the person who approved or rejected the post.
1682
+ * @format GUID
1683
+ */
1533
1684
  moderatedBy?: string | null;
1534
1685
  /** Date the post was approved or rejected. */
1535
1686
  moderationDate?: Date | null;
@@ -1555,7 +1706,10 @@ export interface Keyword {
1555
1706
  term?: string;
1556
1707
  /** Whether the keyword is the main focus keyword. */
1557
1708
  isMain?: boolean;
1558
- /** The source that added the keyword terms to the SEO settings. */
1709
+ /**
1710
+ * The source that added the keyword terms to the SEO settings.
1711
+ * @maxLength 1000
1712
+ */
1559
1713
  origin?: string | null;
1560
1714
  }
1561
1715
  export interface Tag {
@@ -1588,7 +1742,10 @@ export interface Settings {
1588
1742
  * Default: `false` (Auto Redirect is enabled.)
1589
1743
  */
1590
1744
  preventAutoRedirect?: boolean;
1591
- /** User-selected keyword terms for a specific page. */
1745
+ /**
1746
+ * User-selected keyword terms for a specific page.
1747
+ * @maxSize 5
1748
+ */
1592
1749
  keywords?: Keyword[];
1593
1750
  }
1594
1751
  export interface Media extends MediaMediaOneOf {
@@ -1600,7 +1757,11 @@ export interface Media extends MediaMediaOneOf {
1600
1757
  displayed?: boolean;
1601
1758
  /** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
1602
1759
  custom?: boolean;
1603
- /** Media alternative text. */
1760
+ /**
1761
+ * Media alternative text.
1762
+ * @minLength 1
1763
+ * @maxLength 1000
1764
+ */
1604
1765
  altText?: string | null;
1605
1766
  }
1606
1767
  /** @oneof */
@@ -1633,7 +1794,10 @@ export interface EmbedMedia {
1633
1794
  video?: EmbedVideo;
1634
1795
  }
1635
1796
  export interface EmbedThumbnail {
1636
- /** Thumbnail url. */
1797
+ /**
1798
+ * Thumbnail url.
1799
+ * @maxLength 2000
1800
+ */
1637
1801
  url?: string;
1638
1802
  /** Thumbnail width. */
1639
1803
  width?: number;
@@ -1641,7 +1805,10 @@ export interface EmbedThumbnail {
1641
1805
  height?: number;
1642
1806
  }
1643
1807
  export interface EmbedVideo {
1644
- /** Video url. */
1808
+ /**
1809
+ * Video url.
1810
+ * @maxLength 2000
1811
+ */
1645
1812
  url?: string;
1646
1813
  /** Video width. */
1647
1814
  width?: number;
@@ -1649,130 +1816,342 @@ export interface EmbedVideo {
1649
1816
  height?: number;
1650
1817
  }
1651
1818
  export interface DraftPostTranslation {
1652
- /** Post ID. */
1819
+ /**
1820
+ * Post ID.
1821
+ * @format GUID
1822
+ */
1653
1823
  _id?: string;
1654
1824
  /** Post status. */
1655
1825
  status?: Status;
1656
- /** Language the post is written in. */
1826
+ /**
1827
+ * Language the post is written in.
1828
+ * @format LANGUAGE_TAG
1829
+ */
1657
1830
  language?: string | null;
1658
- /** Post slug. For example, 'post-slug'. */
1831
+ /**
1832
+ * Post slug. For example, 'post-slug'.
1833
+ * @maxLength 100
1834
+ */
1659
1835
  slug?: string | null;
1660
1836
  /** SEO data. */
1661
1837
  seoData?: SeoSchema;
1662
1838
  /** Post URL. */
1663
1839
  url?: string;
1664
1840
  }
1665
- export interface InitialDraftPostsCopied {
1666
- /** Number of draft posts copied. */
1667
- count?: number;
1668
- }
1669
1841
  export interface DraftCategoriesUpdated {
1670
- /** Draft post ID. */
1842
+ /**
1843
+ * Draft post ID.
1844
+ * @maxLength 38
1845
+ */
1671
1846
  draftPostId?: string;
1672
- /** Current categories of the draft. */
1847
+ /**
1848
+ * Current categories of the draft.
1849
+ * @maxSize 10
1850
+ * @format GUID
1851
+ */
1673
1852
  categories?: string[];
1674
- /** Previous categories of the draft. */
1853
+ /**
1854
+ * Previous categories of the draft.
1855
+ * @maxSize 10
1856
+ * @format GUID
1857
+ */
1675
1858
  previousCategories?: string[];
1676
1859
  }
1677
1860
  export interface DraftTagsUpdated {
1678
- /** Draft post ID. */
1861
+ /**
1862
+ * Draft post ID.
1863
+ * @maxLength 38
1864
+ */
1679
1865
  draftPostId?: string;
1680
- /** Current tags of the draft. */
1866
+ /**
1867
+ * Current tags of the draft.
1868
+ * @maxSize 30
1869
+ * @format GUID
1870
+ */
1681
1871
  tags?: string[];
1682
- /** Previous tags of the draft. */
1872
+ /**
1873
+ * Previous tags of the draft.
1874
+ * @maxSize 30
1875
+ * @format GUID
1876
+ */
1683
1877
  previousTags?: string[];
1684
1878
  }
1685
- export interface CreateDraftPostRequest {
1686
- /** Draft post to create. */
1687
- draftPost: DraftPost;
1879
+ export interface GetDraftPostTotalsRequest {
1688
1880
  /**
1689
- * Whether the draft post should be published on creation.
1690
- *
1691
- * Default: `false`
1881
+ * Group results by fields (defaults to grouping by status).
1882
+ * If, for example, grouping by language is passed, language values in response will be filled.
1883
+ * If, for example, grouping by language is not passed, null values will be filled in language field in response.
1884
+ * @maxSize 10
1692
1885
  */
1693
- publish?: boolean;
1886
+ groupBy?: TotalDraftPostsGroupingField[];
1694
1887
  /**
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.
1888
+ * Optional language filter by provided language code. Useful in multilingual context.
1889
+ * @format LANGUAGE_TAG
1698
1890
  */
1699
- fieldsets?: Field[];
1891
+ language?: string | null;
1700
1892
  }
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"
1893
+ export declare enum TotalDraftPostsGroupingField {
1894
+ /** Groups results by status. */
1895
+ STATUS = "STATUS",
1896
+ /** Groups results by language. */
1897
+ LANGUAGE = "LANGUAGE"
1713
1898
  }
1714
- export declare enum Field {
1715
- /** Unknown field. */
1716
- UNKNOWN = "UNKNOWN",
1717
- /** Includes draft post preview URL. */
1718
- URL = "URL",
1899
+ export interface GetDraftPostTotalsResponse {
1900
+ /** Draft post totals. */
1901
+ totalDraftPosts?: TotalDraftPosts[];
1902
+ }
1903
+ export interface TotalDraftPosts {
1904
+ /** Draft post totals in that group. */
1905
+ total?: number;
1906
+ /** Draft post status (only has value when grouping by status, otherwise null). */
1907
+ status?: Status;
1719
1908
  /**
1720
- * Includes internal id field.
1721
- * Reserved for internal use.
1909
+ * Draft post language code (only has value when grouping by language, otherwise null).
1910
+ * @format LANGUAGE_TAG
1722
1911
  */
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;
1912
+ language?: string | null;
1734
1913
  }
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;
1914
+ export interface DomainEvent extends DomainEventBodyOneOf {
1915
+ createdEvent?: EntityCreatedEvent;
1916
+ updatedEvent?: EntityUpdatedEvent;
1917
+ deletedEvent?: EntityDeletedEvent;
1918
+ actionEvent?: ActionEvent;
1742
1919
  /**
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.
1920
+ * Unique event ID.
1921
+ * Allows clients to ignore duplicate webhooks.
1746
1922
  */
1747
- fieldsets?: Field[];
1923
+ _id?: string;
1924
+ /**
1925
+ * Assumes actions are also always typed to an entity_type
1926
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1927
+ */
1928
+ entityFqdn?: string;
1929
+ /**
1930
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1931
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1932
+ * Example: created/updated/deleted/started/completed/email_opened
1933
+ */
1934
+ slug?: string;
1935
+ /** ID of the entity associated with the event. */
1936
+ entityId?: string;
1937
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1938
+ eventTime?: Date | null;
1939
+ /**
1940
+ * Whether the event was triggered as a result of a privacy regulation application
1941
+ * (for example, GDPR).
1942
+ */
1943
+ triggeredByAnonymizeRequest?: boolean | null;
1944
+ /** If present, indicates the action that triggered the event. */
1945
+ originatedFrom?: string | null;
1946
+ /**
1947
+ * A sequence number defining the order of updates to the underlying entity.
1948
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1949
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1950
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1951
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1952
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1953
+ */
1954
+ entityEventSequence?: string | null;
1748
1955
  }
1749
- export interface BulkCreateDraftPostsResponse {
1750
- /** Draft posts created by bulk action. */
1751
- results?: BulkDraftPostResult[];
1752
- /** Bulk action metadata. */
1753
- bulkActionMetadata?: BulkActionMetadata;
1956
+ /** @oneof */
1957
+ export interface DomainEventBodyOneOf {
1958
+ createdEvent?: EntityCreatedEvent;
1959
+ updatedEvent?: EntityUpdatedEvent;
1960
+ deletedEvent?: EntityDeletedEvent;
1961
+ actionEvent?: ActionEvent;
1754
1962
  }
1755
- export interface BulkDraftPostResult {
1756
- /** Bulk actions metadata for draft post. */
1757
- itemMetadata?: ItemMetadata;
1758
- /** Optional full draft post. */
1759
- item?: DraftPost;
1963
+ export interface EntityCreatedEvent {
1964
+ entity?: string;
1760
1965
  }
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;
1966
+ export interface RestoreInfo {
1967
+ deletedDate?: Date | null;
1770
1968
  }
1771
- export interface ApplicationError {
1772
- /** Error code. */
1773
- code?: string;
1774
- /** Description of the error. */
1775
- description?: string;
1969
+ export interface EntityUpdatedEvent {
1970
+ /**
1971
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1972
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1973
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1974
+ */
1975
+ currentEntity?: string;
1976
+ }
1977
+ export interface EntityDeletedEvent {
1978
+ /** Entity that was deleted */
1979
+ deletedEntity?: string | null;
1980
+ }
1981
+ export interface ActionEvent {
1982
+ body?: string;
1983
+ }
1984
+ export interface MessageEnvelope {
1985
+ /**
1986
+ * App instance ID.
1987
+ * @format GUID
1988
+ */
1989
+ instanceId?: string | null;
1990
+ /**
1991
+ * Event type.
1992
+ * @maxLength 150
1993
+ */
1994
+ eventType?: string;
1995
+ /** The identification type and identity data. */
1996
+ identity?: IdentificationData;
1997
+ /** Stringify payload. */
1998
+ data?: string;
1999
+ }
2000
+ export interface IdentificationData extends IdentificationDataIdOneOf {
2001
+ /**
2002
+ * ID of a site visitor that has not logged in to the site.
2003
+ * @format GUID
2004
+ */
2005
+ anonymousVisitorId?: string;
2006
+ /**
2007
+ * ID of a site visitor that has logged in to the site.
2008
+ * @format GUID
2009
+ */
2010
+ memberId?: string;
2011
+ /**
2012
+ * ID of a Wix user (site owner, contributor, etc.).
2013
+ * @format GUID
2014
+ */
2015
+ wixUserId?: string;
2016
+ /**
2017
+ * ID of an app.
2018
+ * @format GUID
2019
+ */
2020
+ appId?: string;
2021
+ /** @readonly */
2022
+ identityType?: WebhookIdentityType;
2023
+ }
2024
+ /** @oneof */
2025
+ export interface IdentificationDataIdOneOf {
2026
+ /**
2027
+ * ID of a site visitor that has not logged in to the site.
2028
+ * @format GUID
2029
+ */
2030
+ anonymousVisitorId?: string;
2031
+ /**
2032
+ * ID of a site visitor that has logged in to the site.
2033
+ * @format GUID
2034
+ */
2035
+ memberId?: string;
2036
+ /**
2037
+ * ID of a Wix user (site owner, contributor, etc.).
2038
+ * @format GUID
2039
+ */
2040
+ wixUserId?: string;
2041
+ /**
2042
+ * ID of an app.
2043
+ * @format GUID
2044
+ */
2045
+ appId?: string;
2046
+ }
2047
+ export declare enum WebhookIdentityType {
2048
+ UNKNOWN = "UNKNOWN",
2049
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2050
+ MEMBER = "MEMBER",
2051
+ WIX_USER = "WIX_USER",
2052
+ APP = "APP"
2053
+ }
2054
+ export interface InitialDraftPostsCopied {
2055
+ /** Number of draft posts copied. */
2056
+ count?: number;
2057
+ }
2058
+ export interface CreateDraftPostRequest {
2059
+ /** Draft post to create. */
2060
+ draftPost: DraftPost;
2061
+ /**
2062
+ * Whether the draft post should be published on creation.
2063
+ *
2064
+ * Default: `false`
2065
+ */
2066
+ publish?: boolean;
2067
+ /**
2068
+ * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2069
+ * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
2070
+ * only the draft post's base fields are returned.
2071
+ * @maxSize 10
2072
+ */
2073
+ fieldsets?: Field[];
2074
+ }
2075
+ export declare enum Type {
2076
+ UNKNOWN = "UNKNOWN",
2077
+ /** Manually saved. */
2078
+ MANUAL = "MANUAL",
2079
+ /** Triggered by autosave. */
2080
+ AUTO_SAVE = "AUTO_SAVE",
2081
+ /** Copied from template during provisioning flow. */
2082
+ PROVISIONING = "PROVISIONING",
2083
+ /** Imported from another blog. */
2084
+ IMPORT = "IMPORT",
2085
+ /** Triggered by autosave when post created by AI tool. */
2086
+ AI_AUTO_SAVE = "AI_AUTO_SAVE"
2087
+ }
2088
+ export declare enum Field {
2089
+ /** Unknown field. */
2090
+ UNKNOWN = "UNKNOWN",
2091
+ /** Includes draft post preview URL. */
2092
+ URL = "URL",
2093
+ /**
2094
+ * Includes internal id field.
2095
+ * Reserved for internal use.
2096
+ */
2097
+ INTERNAL_ID = "INTERNAL_ID",
2098
+ /** Includes content field. */
2099
+ CONTENT = "CONTENT",
2100
+ /** Includes rich content field. */
2101
+ RICH_CONTENT = "RICH_CONTENT",
2102
+ /** If the user has not set excerpt, returns the one autogenerated from content. */
2103
+ GENERATED_EXCERPT = "GENERATED_EXCERPT"
2104
+ }
2105
+ export interface CreateDraftPostResponse {
2106
+ /** Created draft post info. */
2107
+ draftPost?: DraftPost;
2108
+ }
2109
+ export interface BulkCreateDraftPostsRequest {
2110
+ /**
2111
+ * Draft posts to create.
2112
+ * @minSize 1
2113
+ * @maxSize 20
2114
+ */
2115
+ draftPosts: DraftPost[];
2116
+ /** Whether the draft post should be published after creation. */
2117
+ publish?: boolean;
2118
+ /** Whether to return the full created draft post entities in the response. */
2119
+ returnFullEntity?: boolean;
2120
+ /**
2121
+ * List of draft post fields to be included in the response if the entities are present.
2122
+ * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
2123
+ * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
2124
+ * @maxSize 10
2125
+ */
2126
+ fieldsets?: Field[];
2127
+ }
2128
+ export interface BulkCreateDraftPostsResponse {
2129
+ /** Draft posts created by bulk action. */
2130
+ results?: BulkDraftPostResult[];
2131
+ /** Bulk action metadata. */
2132
+ bulkActionMetadata?: BulkActionMetadata;
2133
+ }
2134
+ export interface BulkDraftPostResult {
2135
+ /** Bulk actions metadata for draft post. */
2136
+ itemMetadata?: ItemMetadata;
2137
+ /** Optional full draft post. */
2138
+ item?: DraftPost;
2139
+ }
2140
+ export interface ItemMetadata {
2141
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
2142
+ _id?: string | null;
2143
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
2144
+ originalIndex?: number;
2145
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
2146
+ success?: boolean;
2147
+ /** Details about the error in case of failure. */
2148
+ error?: ApplicationError;
2149
+ }
2150
+ export interface ApplicationError {
2151
+ /** Error code. */
2152
+ code?: string;
2153
+ /** Description of the error. */
2154
+ description?: string;
1776
2155
  /** Data related to the error. */
1777
2156
  data?: Record<string, any> | null;
1778
2157
  }
@@ -1785,7 +2164,11 @@ export interface BulkActionMetadata {
1785
2164
  undetailedFailures?: number;
1786
2165
  }
1787
2166
  export interface BulkUpdateDraftPostsRequest {
1788
- /** Draft posts to update. */
2167
+ /**
2168
+ * Draft posts to update.
2169
+ * @minSize 1
2170
+ * @maxSize 20
2171
+ */
1789
2172
  draftPosts?: MaskedDraftPosts[];
1790
2173
  /**
1791
2174
  * Action to perform on the posts.
@@ -1809,6 +2192,7 @@ export interface BulkUpdateDraftPostsRequest {
1809
2192
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1810
2193
  * 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
2194
  * only the draft post's base fields are returned.
2195
+ * @maxSize 10
1812
2196
  */
1813
2197
  fieldsets?: Field[];
1814
2198
  }
@@ -1848,6 +2232,7 @@ export interface ListDeletedDraftPostsRequest {
1848
2232
  *
1849
2233
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
1850
2234
  * If omitted, deleted draft posts in all languages are returned.
2235
+ * @format LANGUAGE_TAG
1851
2236
  */
1852
2237
  language?: string | null;
1853
2238
  /**
@@ -1862,9 +2247,14 @@ export interface ListDeletedDraftPostsRequest {
1862
2247
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1863
2248
  * 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
2249
  * only the draft post's base fields are returned.
2250
+ * @maxSize 10
1865
2251
  */
1866
2252
  fieldsets?: Field[];
1867
- /** Draft post ids. */
2253
+ /**
2254
+ * Draft post ids.
2255
+ * @maxSize 100
2256
+ * @format GUID
2257
+ */
1868
2258
  draftPostIds?: string[];
1869
2259
  }
1870
2260
  export declare enum GetDraftPostsSort {
@@ -1886,9 +2276,14 @@ export interface BlogPaging {
1886
2276
  *
1887
2277
  *
1888
2278
  * Default:`50`
2279
+ * @min 1
2280
+ * @max 100
1889
2281
  */
1890
2282
  limit?: number;
1891
- /** Pointer to the next or previous page in the list of results. */
2283
+ /**
2284
+ * Pointer to the next or previous page in the list of results.
2285
+ * @maxLength 2000
2286
+ */
1892
2287
  cursor?: string | null;
1893
2288
  }
1894
2289
  export interface ListDeletedDraftPostsResponse {
@@ -1904,16 +2299,23 @@ export interface MetaData {
1904
2299
  offset?: number;
1905
2300
  /** Total number of items that match the query. */
1906
2301
  total?: number;
1907
- /** Pointer to the next or previous page in the list of results. */
2302
+ /**
2303
+ * Pointer to the next or previous page in the list of results.
2304
+ * @maxLength 2000
2305
+ */
1908
2306
  cursor?: string | null;
1909
2307
  }
1910
2308
  export interface GetDraftPostRequest {
1911
- /** Draft post ID. */
2309
+ /**
2310
+ * Draft post ID.
2311
+ * @maxLength 38
2312
+ */
1912
2313
  draftPostId: string;
1913
2314
  /**
1914
2315
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1915
2316
  * 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
2317
  * only the draft post's base fields are returned.
2318
+ * @maxSize 10
1917
2319
  */
1918
2320
  fieldsets?: Field[];
1919
2321
  }
@@ -1922,11 +2324,17 @@ export interface GetDraftPostResponse {
1922
2324
  draftPost?: DraftPost;
1923
2325
  }
1924
2326
  export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
1925
- /** DraftJs content to update. */
2327
+ /**
2328
+ * DraftJs content to update.
2329
+ * @maxLength 400000
2330
+ */
1926
2331
  content?: string;
1927
2332
  /** Draft post rich content. */
1928
2333
  richContent?: RichContent;
1929
- /** Draft post ID. */
2334
+ /**
2335
+ * Draft post ID.
2336
+ * @maxLength 38
2337
+ */
1930
2338
  draftPostId?: string;
1931
2339
  /** Change origin. */
1932
2340
  changeOrigin?: Origin;
@@ -1934,12 +2342,16 @@ export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentReq
1934
2342
  * List of draft post fields to be included if entities are present in the response.
1935
2343
  * Base fieldset, which is default, will return all core draft post properties.
1936
2344
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2345
+ * @maxSize 10
1937
2346
  */
1938
2347
  fieldsets?: Field[];
1939
2348
  }
1940
2349
  /** @oneof */
1941
2350
  export interface UpdateDraftPostContentRequestDraftContentOneOf {
1942
- /** DraftJs content to update. */
2351
+ /**
2352
+ * DraftJs content to update.
2353
+ * @maxLength 400000
2354
+ */
1943
2355
  content?: string;
1944
2356
  /** Draft post rich content. */
1945
2357
  richContent?: RichContent;
@@ -1963,6 +2375,7 @@ export interface UpdateDraftPostRequest {
1963
2375
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
1964
2376
  * 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
2377
  * only the draft post's base fields are returned.
2378
+ * @maxSize 10
1966
2379
  */
1967
2380
  fieldsets?: Field[];
1968
2381
  }
@@ -1971,7 +2384,10 @@ export interface UpdateDraftPostResponse {
1971
2384
  draftPost?: DraftPost;
1972
2385
  }
1973
2386
  export interface DeleteDraftPostRequest {
1974
- /** Draft post ID. */
2387
+ /**
2388
+ * Draft post ID.
2389
+ * @maxLength 38
2390
+ */
1975
2391
  draftPostId: string;
1976
2392
  /**
1977
2393
  * Whether to bypass the trash bin and delete the post permanently.
@@ -1983,13 +2399,21 @@ export interface DeleteDraftPostRequest {
1983
2399
  export interface DeleteDraftPostResponse {
1984
2400
  }
1985
2401
  export interface RemoveFromTrashBinRequest {
1986
- /** Draft post ID. */
2402
+ /**
2403
+ * Draft post ID.
2404
+ * @maxLength 38
2405
+ */
1987
2406
  draftPostId: string;
1988
2407
  }
1989
2408
  export interface RemoveFromTrashBinResponse {
1990
2409
  }
1991
2410
  export interface BulkDeleteDraftPostsRequest {
1992
- /** Post IDs. */
2411
+ /**
2412
+ * Post IDs.
2413
+ * @minSize 1
2414
+ * @maxSize 100
2415
+ * @maxLength 38
2416
+ */
1993
2417
  postIds: string[];
1994
2418
  /** Should delete bypassing the trash-bin. */
1995
2419
  permanent?: boolean;
@@ -2013,6 +2437,7 @@ export interface ListDraftPostsRequest {
2013
2437
  *
2014
2438
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2015
2439
  * If omitted, draft posts in all languages are returned.
2440
+ * @format LANGUAGE_TAG
2016
2441
  */
2017
2442
  language?: string | null;
2018
2443
  /**
@@ -2027,6 +2452,7 @@ export interface ListDraftPostsRequest {
2027
2452
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2028
2453
  * 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
2454
  * only the draft post's base fields are returned.
2455
+ * @maxSize 10
2030
2456
  */
2031
2457
  fieldsets?: Field[];
2032
2458
  }
@@ -2037,7 +2463,10 @@ export interface ListDraftPostsResponse {
2037
2463
  metaData?: MetaData;
2038
2464
  }
2039
2465
  export interface GetDeletedDraftPostRequest {
2040
- /** Draft post ID. */
2466
+ /**
2467
+ * Draft post ID.
2468
+ * @maxLength 38
2469
+ */
2041
2470
  draftPostId: string;
2042
2471
  }
2043
2472
  export interface GetDeletedDraftPostResponse {
@@ -2045,7 +2474,10 @@ export interface GetDeletedDraftPostResponse {
2045
2474
  draftPost?: DraftPost;
2046
2475
  }
2047
2476
  export interface RestoreFromTrashBinRequest {
2048
- /** Draft post ID. */
2477
+ /**
2478
+ * Draft post ID.
2479
+ * @maxLength 38
2480
+ */
2049
2481
  draftPostId: string;
2050
2482
  }
2051
2483
  export interface RestoreFromTrashBinResponse {
@@ -2057,13 +2489,17 @@ export interface QueryDraftPostsRequest {
2057
2489
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
2058
2490
  * 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
2491
  * only the draft post's base fields are returned.
2492
+ * @maxSize 10
2060
2493
  */
2061
2494
  fieldsets?: Field[];
2062
2495
  /** Query options. */
2063
2496
  query?: PlatformQuery;
2064
2497
  }
2065
2498
  export interface Sorting {
2066
- /** Name of the field to sort by. */
2499
+ /**
2500
+ * Name of the field to sort by.
2501
+ * @maxLength 512
2502
+ */
2067
2503
  fieldName?: string;
2068
2504
  /** Sort order. */
2069
2505
  order?: SortOrder;
@@ -2089,6 +2525,7 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
2089
2525
  /**
2090
2526
  * Sort object in the following format:
2091
2527
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2528
+ * @maxSize 3
2092
2529
  */
2093
2530
  sort?: Sorting[];
2094
2531
  }
@@ -2100,13 +2537,19 @@ export interface PlatformQueryPagingMethodOneOf {
2100
2537
  cursorPaging?: CursorPaging;
2101
2538
  }
2102
2539
  export interface Paging {
2103
- /** Number of items to load. */
2540
+ /**
2541
+ * Number of items to load.
2542
+ * @max 100
2543
+ */
2104
2544
  limit?: number | null;
2105
2545
  /** Number of items to skip in the current sort order. */
2106
2546
  offset?: number | null;
2107
2547
  }
2108
2548
  export interface CursorPaging {
2109
- /** Number of items to load. */
2549
+ /**
2550
+ * Number of items to load.
2551
+ * @max 100
2552
+ */
2110
2553
  limit?: number | null;
2111
2554
  /**
2112
2555
  * Pointer to the next or previous page in the list of results.
@@ -2114,6 +2557,7 @@ export interface CursorPaging {
2114
2557
  * You can get the relevant cursor token
2115
2558
  * from the `pagingMetadata` object in the previous call's response.
2116
2559
  * Not relevant for the first request.
2560
+ * @maxLength 2000
2117
2561
  */
2118
2562
  cursor?: string | null;
2119
2563
  }
@@ -2149,167 +2593,50 @@ export interface PagingMetadataV2 {
2149
2593
  cursors?: Cursors;
2150
2594
  }
2151
2595
  export interface Cursors {
2152
- /** Cursor pointing to next page in the list of results. */
2596
+ /**
2597
+ * Cursor pointing to next page in the list of results.
2598
+ * @maxLength 2000
2599
+ */
2153
2600
  next?: string | null;
2154
- /** Cursor pointing to previous page in the list of results. */
2601
+ /**
2602
+ * Cursor pointing to previous page in the list of results.
2603
+ * @maxLength 2000
2604
+ */
2155
2605
  prev?: string | null;
2156
2606
  }
2157
2607
  export interface PublishDraftPostRequest {
2158
- /** Draft post ID. */
2608
+ /**
2609
+ * Draft post ID.
2610
+ * @maxLength 38
2611
+ */
2159
2612
  draftPostId: string;
2160
2613
  }
2161
2614
  export interface PublishDraftPostResponse {
2162
- /** Published post ID. */
2615
+ /**
2616
+ * Published post ID.
2617
+ * @format GUID
2618
+ */
2163
2619
  postId?: string;
2164
2620
  }
2165
2621
  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
2622
  /**
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
- /**
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.
2623
+ * Draft post ID.
2624
+ * @maxLength 38
2210
2625
  */
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;
2626
+ draftPostId?: string;
2222
2627
  }
2223
- export interface RestoreInfo {
2224
- deletedDate?: Date | null;
2628
+ export interface UnpublishPostResponse {
2225
2629
  }
2226
- export interface EntityUpdatedEvent {
2630
+ export interface TranslateCategoryRequest {
2227
2631
  /**
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.
2632
+ * Source category ID
2633
+ * @format GUID
2231
2634
  */
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 {
2635
+ categoryId?: string;
2282
2636
  /**
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.
2637
+ * Translation language
2638
+ * @format LANGUAGE_TAG
2286
2639
  */
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
2640
  language?: string;
2314
2641
  }
2315
2642
  export interface TranslateCategoryResponse {
@@ -2319,9 +2646,16 @@ export interface TranslateCategoryResponse {
2319
2646
  translations?: CategoryTranslation[];
2320
2647
  }
2321
2648
  export interface Category {
2322
- /** Category ID. */
2649
+ /**
2650
+ * Category ID.
2651
+ * @immutable
2652
+ * @maxLength 38
2653
+ */
2323
2654
  _id?: string;
2324
- /** Category label. Displayed in the Category Menu. */
2655
+ /**
2656
+ * Category label. Displayed in the Category Menu.
2657
+ * @maxLength 35
2658
+ */
2325
2659
  label?: string;
2326
2660
  /**
2327
2661
  * Number of posts in the category.
@@ -2333,10 +2667,14 @@ export interface Category {
2333
2667
  * @readonly
2334
2668
  */
2335
2669
  url?: string;
2336
- /** Category description. */
2670
+ /**
2671
+ * Category description.
2672
+ * @maxLength 500
2673
+ */
2337
2674
  description?: string | null;
2338
2675
  /**
2339
2676
  * Category title.
2677
+ * @maxLength 200
2340
2678
  * @deprecated Category title.
2341
2679
  * @targetRemovalDate 2025-07-16
2342
2680
  */
@@ -2348,19 +2686,27 @@ export interface Category {
2348
2686
  * Default: `-1`
2349
2687
  */
2350
2688
  displayPosition?: number | null;
2351
- /** ID of the category's translations. All translations of a single category share the same `translationId`. */
2689
+ /**
2690
+ * ID of the category's translations. All translations of a single category share the same `translationId`.
2691
+ * @format GUID
2692
+ */
2352
2693
  translationId?: string | null;
2353
2694
  /**
2354
2695
  * Category language.
2355
2696
  *
2356
2697
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
2698
+ * @immutable
2357
2699
  */
2358
2700
  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`. */
2701
+ /**
2702
+ * 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`.
2703
+ * @maxLength 100
2704
+ */
2360
2705
  slug?: string;
2361
2706
  /**
2362
2707
  * Reserved for internal use.
2363
2708
  * @readonly
2709
+ * @maxLength 24
2364
2710
  */
2365
2711
  internalId?: string | null;
2366
2712
  /** SEO data. */
@@ -2374,24 +2720,40 @@ export interface Category {
2374
2720
  _updatedDate?: Date | null;
2375
2721
  }
2376
2722
  export interface CategoryTranslation {
2377
- /** Category ID. */
2723
+ /**
2724
+ * Category ID.
2725
+ * @format GUID
2726
+ */
2378
2727
  _id?: string;
2379
- /** Label displayed in the categories menu on the site. */
2728
+ /**
2729
+ * Label displayed in the categories menu on the site.
2730
+ * @maxLength 100
2731
+ */
2380
2732
  label?: string | null;
2381
- /** Language of the category. */
2733
+ /**
2734
+ * Language of the category.
2735
+ * @format LANGUAGE_TAG
2736
+ */
2382
2737
  language?: string | null;
2383
2738
  /** URL of this category page. */
2384
2739
  url?: string;
2385
2740
  }
2386
2741
  export interface TranslateDraftRequest {
2387
- /** Source post or draft ID */
2742
+ /**
2743
+ * Source post or draft ID
2744
+ * @format GUID
2745
+ */
2388
2746
  postId?: string;
2389
- /** Translation language */
2747
+ /**
2748
+ * Translation language
2749
+ * @format LANGUAGE_TAG
2750
+ */
2390
2751
  language?: string;
2391
2752
  /**
2392
2753
  * List of draft post fields to be included if entities are present in the response.
2393
2754
  * Base fieldset, which is default, will return all core draft post properties.
2394
2755
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2756
+ * @maxSize 10
2395
2757
  */
2396
2758
  fieldsets?: Field[];
2397
2759
  }
@@ -2400,11 +2762,17 @@ export interface TranslateDraftResponse {
2400
2762
  draftPost?: DraftPost;
2401
2763
  }
2402
2764
  export interface IsDraftPostAutoTranslatableRequest {
2403
- /** Source post or draft ID. */
2765
+ /**
2766
+ * Source post or draft ID.
2767
+ * @format GUID
2768
+ */
2404
2769
  draftPostId?: string;
2405
2770
  }
2406
2771
  export interface IsDraftPostAutoTranslatableResponse {
2407
- /** Source draft post ID. */
2772
+ /**
2773
+ * Source draft post ID.
2774
+ * @format GUID
2775
+ */
2408
2776
  draftPostId?: string;
2409
2777
  /** Indicates if enough machine translation credits are available for the draft post translation. */
2410
2778
  translatable?: boolean;
@@ -2420,14 +2788,22 @@ export interface IsDraftPostAutoTranslatableResponse {
2420
2788
  contentTextCharacterCount?: number;
2421
2789
  }
2422
2790
  export interface UpdateDraftPostLanguageRequest {
2423
- /** Source draft post ID */
2791
+ /**
2792
+ * Source draft post ID
2793
+ * @format GUID
2794
+ */
2424
2795
  postId?: string;
2425
- /** New language to replace to */
2796
+ /**
2797
+ * New language to replace to
2798
+ * @minLength 2
2799
+ * @format LANGUAGE_TAG
2800
+ */
2426
2801
  language?: string;
2427
2802
  /**
2428
2803
  * List of draft post fields to be included if entities are present in the response.
2429
2804
  * Base fieldset, which is default, will return all core draft post properties.
2430
2805
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2806
+ * @maxSize 10
2431
2807
  */
2432
2808
  fieldsets?: Field[];
2433
2809
  }
@@ -2436,9 +2812,16 @@ export interface UpdateDraftPostLanguageResponse {
2436
2812
  draftPost?: DraftPost;
2437
2813
  }
2438
2814
  export interface BulkUpdateDraftPostLanguageRequest {
2439
- /** Source post or draft IDs */
2815
+ /**
2816
+ * Source post or draft IDs
2817
+ * @maxSize 50
2818
+ * @format GUID
2819
+ */
2440
2820
  ids?: string[];
2441
- /** New language to replace to */
2821
+ /**
2822
+ * New language to replace to
2823
+ * @format LANGUAGE_TAG
2824
+ */
2442
2825
  language?: string;
2443
2826
  /** Should full draft post be returned */
2444
2827
  returnFullEntity?: boolean;
@@ -2446,6 +2829,7 @@ export interface BulkUpdateDraftPostLanguageRequest {
2446
2829
  * List of draft post fields to be included if entities are present in the response.
2447
2830
  * Base fieldset, which is default, will return all core draft post properties.
2448
2831
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2832
+ * @maxSize 10
2449
2833
  */
2450
2834
  fieldsets?: Field[];
2451
2835
  }
@@ -2456,7 +2840,10 @@ export interface BulkUpdateDraftPostLanguageResponse {
2456
2840
  bulkActionMetadata?: BulkActionMetadata;
2457
2841
  }
2458
2842
  export interface GetPostAmountsByLanguageRequest {
2459
- /** Post status to filter by */
2843
+ /**
2844
+ * Post status to filter by
2845
+ * @maxLength 100
2846
+ */
2460
2847
  status?: string;
2461
2848
  }
2462
2849
  export interface GetPostAmountsByLanguageResponse {
@@ -2464,15 +2851,26 @@ export interface GetPostAmountsByLanguageResponse {
2464
2851
  postAmountsByLanguage?: PostAmountByLanguage[];
2465
2852
  }
2466
2853
  export interface PostAmountByLanguage {
2467
- /** Post language code */
2854
+ /**
2855
+ * Post language code
2856
+ * @format LANGUAGE_TAG
2857
+ */
2468
2858
  languageCode?: string;
2469
- /** Language flag */
2859
+ /**
2860
+ * Language flag
2861
+ * @format LANGUAGE_TAG
2862
+ */
2470
2863
  flag?: string;
2471
2864
  /** Post amount in that language */
2472
2865
  postAmount?: number;
2473
2866
  }
2474
2867
  export interface BulkRevertToUnpublishedRequest {
2475
- /** Source post IDs. */
2868
+ /**
2869
+ * Source post IDs.
2870
+ * @minSize 1
2871
+ * @maxSize 100
2872
+ * @format GUID
2873
+ */
2476
2874
  postIds?: string[];
2477
2875
  /** Should full draft post be returned. */
2478
2876
  returnFullEntity?: boolean;
@@ -2484,7 +2882,12 @@ export interface BulkRevertToUnpublishedResponse {
2484
2882
  bulkActionMetadata?: BulkActionMetadata;
2485
2883
  }
2486
2884
  export interface BulkRejectDraftPostRequest {
2487
- /** Source post IDs. */
2885
+ /**
2886
+ * Source post IDs.
2887
+ * @minSize 1
2888
+ * @maxSize 100
2889
+ * @format GUID
2890
+ */
2488
2891
  postIds?: string[];
2489
2892
  /** Should full draft post be returned. */
2490
2893
  returnFullEntity?: boolean;
@@ -2496,12 +2899,16 @@ export interface BulkRejectDraftPostResponse {
2496
2899
  bulkActionMetadata?: BulkActionMetadata;
2497
2900
  }
2498
2901
  export interface RevertToUnpublishedRequest {
2499
- /** Source post ID. */
2902
+ /**
2903
+ * Source post ID.
2904
+ * @format GUID
2905
+ */
2500
2906
  postId?: string;
2501
2907
  /**
2502
2908
  * List of draft post fields to be included if entities are present in the response.
2503
2909
  * Base fieldset, which is default, will return all core draft post properties.
2504
2910
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2911
+ * @maxSize 10
2505
2912
  */
2506
2913
  fieldsets?: Field[];
2507
2914
  }
@@ -2510,12 +2917,16 @@ export interface RevertToUnpublishedResponse {
2510
2917
  draftPost?: DraftPost;
2511
2918
  }
2512
2919
  export interface RejectDraftPostRequest {
2513
- /** Source post ID. */
2920
+ /**
2921
+ * Source post ID.
2922
+ * @format GUID
2923
+ */
2514
2924
  postId?: string;
2515
2925
  /**
2516
2926
  * List of draft post fields to be included if entities are present in the response.
2517
2927
  * Base fieldset, which is default, will return all core draft post properties.
2518
2928
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2929
+ * @maxSize 10
2519
2930
  */
2520
2931
  fieldsets?: Field[];
2521
2932
  }
@@ -2524,14 +2935,21 @@ export interface RejectDraftPostResponse {
2524
2935
  draftPost?: DraftPost;
2525
2936
  }
2526
2937
  export interface ApproveDraftPostRequest {
2527
- /** Source post ID. */
2938
+ /**
2939
+ * Source post ID.
2940
+ * @format GUID
2941
+ */
2528
2942
  postId?: string;
2529
- /** Scheduled publish date if should be not immediately published. */
2943
+ /**
2944
+ * Scheduled publish date if should be not immediately published.
2945
+ * @maxLength 24
2946
+ */
2530
2947
  scheduledPublishDate?: string | null;
2531
2948
  /**
2532
2949
  * List of draft post fields to be included if entities are present in the response.
2533
2950
  * Base fieldset, which is default, will return all core draft post properties.
2534
2951
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2952
+ * @maxSize 10
2535
2953
  */
2536
2954
  fieldsets?: Field[];
2537
2955
  }
@@ -2540,12 +2958,16 @@ export interface ApproveDraftPostResponse {
2540
2958
  draftPost?: DraftPost;
2541
2959
  }
2542
2960
  export interface MarkPostAsInModerationRequest {
2543
- /** Source post ID. */
2961
+ /**
2962
+ * Source post ID.
2963
+ * @maxLength 38
2964
+ */
2544
2965
  postId?: string;
2545
2966
  /**
2546
2967
  * List of draft post fields to be included if entities are present in the response.
2547
2968
  * Base fieldset, which is default, will return all core draft post properties.
2548
2969
  * Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
2970
+ * @maxSize 10
2549
2971
  */
2550
2972
  fieldsets?: Field[];
2551
2973
  }
@@ -2642,9 +3064,13 @@ interface ImageDataNonNullableFields {
2642
3064
  containerData?: PluginContainerDataNonNullableFields;
2643
3065
  link?: LinkNonNullableFields;
2644
3066
  }
3067
+ interface LinkPreviewDataStylesNonNullableFields {
3068
+ thumbnailPosition: Position;
3069
+ }
2645
3070
  interface LinkPreviewDataNonNullableFields {
2646
3071
  containerData?: PluginContainerDataNonNullableFields;
2647
3072
  link?: LinkNonNullableFields;
3073
+ styles?: LinkPreviewDataStylesNonNullableFields;
2648
3074
  }
2649
3075
  interface MapSettingsNonNullableFields {
2650
3076
  mapType: MapType;
@@ -2948,9 +3374,15 @@ export interface PublishDraftPostResponseNonNullableFields {
2948
3374
  postId: string;
2949
3375
  }
2950
3376
  export interface BaseEventMetadata {
2951
- /** App instance ID. */
3377
+ /**
3378
+ * App instance ID.
3379
+ * @format GUID
3380
+ */
2952
3381
  instanceId?: string | null;
2953
- /** Event type. */
3382
+ /**
3383
+ * Event type.
3384
+ * @maxLength 150
3385
+ */
2954
3386
  eventType?: string;
2955
3387
  /** The identification type and identity data. */
2956
3388
  identity?: IdentificationData;
@@ -3092,6 +3524,7 @@ export interface CreateDraftPostOptions {
3092
3524
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3093
3525
  * 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
3526
  * only the draft post's base fields are returned.
3527
+ * @maxSize 10
3095
3528
  */
3096
3529
  fieldsets?: Field[];
3097
3530
  }
@@ -3118,6 +3551,7 @@ export interface BulkCreateDraftPostsOptions {
3118
3551
  * List of draft post fields to be included in the response if the entities are present.
3119
3552
  * Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
3120
3553
  * For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
3554
+ * @maxSize 10
3121
3555
  */
3122
3556
  fieldsets?: Field[];
3123
3557
  }
@@ -3135,7 +3569,11 @@ export interface BulkCreateDraftPostsOptions {
3135
3569
  */
3136
3570
  export declare function bulkUpdateDraftPosts(options?: BulkUpdateDraftPostsOptions): Promise<BulkUpdateDraftPostsResponse & BulkUpdateDraftPostsResponseNonNullableFields>;
3137
3571
  export interface BulkUpdateDraftPostsOptions {
3138
- /** Draft posts to update. */
3572
+ /**
3573
+ * Draft posts to update.
3574
+ * @minSize 1
3575
+ * @maxSize 20
3576
+ */
3139
3577
  draftPosts?: MaskedDraftPosts[];
3140
3578
  /**
3141
3579
  * Action to perform on the posts.
@@ -3159,6 +3597,7 @@ export interface BulkUpdateDraftPostsOptions {
3159
3597
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3160
3598
  * 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
3599
  * only the draft post's base fields are returned.
3600
+ * @maxSize 10
3162
3601
  */
3163
3602
  fieldsets?: Field[];
3164
3603
  }
@@ -3184,6 +3623,7 @@ export interface ListDeletedDraftPostsOptions {
3184
3623
  *
3185
3624
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3186
3625
  * If omitted, deleted draft posts in all languages are returned.
3626
+ * @format LANGUAGE_TAG
3187
3627
  */
3188
3628
  language?: string | null;
3189
3629
  /**
@@ -3198,9 +3638,14 @@ export interface ListDeletedDraftPostsOptions {
3198
3638
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3199
3639
  * 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
3640
  * only the draft post's base fields are returned.
3641
+ * @maxSize 10
3201
3642
  */
3202
3643
  fieldsets?: Field[];
3203
- /** Draft post ids. */
3644
+ /**
3645
+ * Draft post ids.
3646
+ * @maxSize 100
3647
+ * @format GUID
3648
+ */
3204
3649
  draftPostIds?: string[];
3205
3650
  }
3206
3651
  /**
@@ -3223,6 +3668,7 @@ export interface GetDraftPostOptions {
3223
3668
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3224
3669
  * 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
3670
  * only the draft post's base fields are returned.
3671
+ * @maxSize 10
3226
3672
  */
3227
3673
  fieldsets?: Field[];
3228
3674
  }
@@ -3245,24 +3691,40 @@ export interface UpdateDraftPost {
3245
3691
  /**
3246
3692
  * Draft post ID.
3247
3693
  * @readonly
3694
+ * @maxLength 38
3248
3695
  */
3249
3696
  _id?: string;
3250
- /** Draft post title. */
3697
+ /**
3698
+ * Draft post title.
3699
+ * @maxLength 200
3700
+ */
3251
3701
  title?: string;
3252
3702
  /**
3253
3703
  * Draft post excerpt.
3254
3704
  *
3255
3705
  * If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
3256
3706
  * This can be retrieved using the `GENERATED_EXCERPT` fieldset.
3707
+ * @maxLength 500
3257
3708
  */
3258
3709
  excerpt?: string | null;
3259
3710
  /** Whether the draft post is marked as featured. */
3260
3711
  featured?: boolean | null;
3261
- /** Category IDs of the draft post. */
3712
+ /**
3713
+ * Category IDs of the draft post.
3714
+ * @maxSize 10
3715
+ * @maxLength 38
3716
+ */
3262
3717
  categoryIds?: string[];
3263
- /** Draft post owner's member ID. */
3718
+ /**
3719
+ * Draft post owner's member ID.
3720
+ * @format GUID
3721
+ */
3264
3722
  memberId?: string | null;
3265
- /** Hashtags in the draft post. */
3723
+ /**
3724
+ * Hashtags in the draft post.
3725
+ * @maxSize 100
3726
+ * @maxLength 100
3727
+ */
3266
3728
  hashtags?: string[];
3267
3729
  /** Whether commenting on the draft post is enabled. */
3268
3730
  commentingEnabled?: boolean | null;
@@ -3273,23 +3735,37 @@ export interface UpdateDraftPost {
3273
3735
  minutesToRead?: number;
3274
3736
  /** Image placed at the top of the blog page. */
3275
3737
  heroImage?: string;
3276
- /** Tag IDs the draft post is tagged with. */
3738
+ /**
3739
+ * Tag IDs the draft post is tagged with.
3740
+ * @maxSize 30
3741
+ * @maxLength 38
3742
+ */
3277
3743
  tagIds?: string[];
3278
- /** IDs of posts related to this draft post. */
3744
+ /**
3745
+ * IDs of posts related to this draft post.
3746
+ * @maxSize 3
3747
+ * @maxLength 38
3748
+ */
3279
3749
  relatedPostIds?: string[];
3280
- /** Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan. */
3750
+ /**
3751
+ * Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan.
3752
+ * @maxSize 100
3753
+ * @format GUID
3754
+ */
3281
3755
  pricingPlanIds?: string[];
3282
3756
  /**
3283
3757
  * ID of the draft post's translations.
3284
3758
  *
3285
3759
  * All translations of a single post share the same `translationId`.
3286
3760
  * Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
3761
+ * @format GUID
3287
3762
  */
3288
3763
  translationId?: string | null;
3289
3764
  /**
3290
3765
  * Language the draft post is written in.
3291
3766
  *
3292
3767
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3768
+ * @format LANGUAGE_TAG
3293
3769
  */
3294
3770
  language?: string | null;
3295
3771
  /**
@@ -3300,9 +3776,13 @@ export interface UpdateDraftPost {
3300
3776
  /**
3301
3777
  * Reserved for internal use.
3302
3778
  * @readonly
3779
+ * @maxLength 24
3303
3780
  */
3304
3781
  contentId?: string | null;
3305
- /** Reserved for internal use. */
3782
+ /**
3783
+ * Reserved for internal use.
3784
+ * @format GUID
3785
+ */
3306
3786
  editingSessionId?: string | null;
3307
3787
  /** Draft post rich content. */
3308
3788
  richContent?: RichContent;
@@ -3316,6 +3796,7 @@ export interface UpdateDraftPost {
3316
3796
  /**
3317
3797
  * Reserved for internal use.
3318
3798
  * @readonly
3799
+ * @format GUID
3319
3800
  */
3320
3801
  mostRecentContributorId?: string | null;
3321
3802
  /**
@@ -3350,6 +3831,8 @@ export interface UpdateDraftPost {
3350
3831
  /**
3351
3832
  * Reserved for internal use.
3352
3833
  * @readonly
3834
+ * @maxSize 5000
3835
+ * @maxLength 100
3353
3836
  */
3354
3837
  slugs?: string[];
3355
3838
  /**
@@ -3362,7 +3845,10 @@ export interface UpdateDraftPost {
3362
3845
  * @readonly
3363
3846
  */
3364
3847
  _createdDate?: Date | null;
3365
- /** SEO slug. */
3848
+ /**
3849
+ * SEO slug.
3850
+ * @maxLength 100
3851
+ */
3366
3852
  seoSlug?: string | null;
3367
3853
  /** Post cover media. */
3368
3854
  media?: Media;
@@ -3371,6 +3857,7 @@ export interface UpdateDraftPost {
3371
3857
  /**
3372
3858
  * Reserved for internal use.
3373
3859
  * @readonly
3860
+ * @maxLength 24
3374
3861
  */
3375
3862
  internalId?: string | null;
3376
3863
  }
@@ -3387,6 +3874,7 @@ export interface UpdateDraftPostOptions {
3387
3874
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3388
3875
  * 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
3876
  * only the draft post's base fields are returned.
3877
+ * @maxSize 10
3390
3878
  */
3391
3879
  fieldsets?: Field[];
3392
3880
  }
@@ -3474,6 +3962,7 @@ export interface ListDraftPostsOptions {
3474
3962
  *
3475
3963
  * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3476
3964
  * If omitted, draft posts in all languages are returned.
3965
+ * @format LANGUAGE_TAG
3477
3966
  */
3478
3967
  language?: string | null;
3479
3968
  /**
@@ -3488,6 +3977,7 @@ export interface ListDraftPostsOptions {
3488
3977
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3489
3978
  * 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
3979
  * only the draft post's base fields are returned.
3980
+ * @maxSize 10
3491
3981
  */
3492
3982
  fieldsets?: Field[];
3493
3983
  }
@@ -3540,6 +4030,7 @@ export interface QueryDraftPostsOptions {
3540
4030
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3541
4031
  * 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
4032
  * only the draft post's base fields are returned.
4033
+ * @maxSize 10
3543
4034
  */
3544
4035
  fieldsets?: Field[] | undefined;
3545
4036
  }