@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.
- package/build/cjs/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
- package/build/cjs/src/blog-v3-draft-draft-posts.context.js +5 -4
- package/build/cjs/src/blog-v3-draft-draft-posts.context.js.map +1 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.public.d.ts +1 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js +3 -2
- package/build/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js +27 -16
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +807 -316
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +28 -17
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
- package/build/es/src/blog-v3-draft-draft-posts.context.js +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.context.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.public.d.ts +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.public.js +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.public.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
- package/build/es/src/blog-v3-draft-draft-posts.types.js +26 -15
- package/build/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/es/src/blog-v3-draft-draft-posts.universal.d.ts +807 -316
- package/build/es/src/blog-v3-draft-draft-posts.universal.js +26 -15
- package/build/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js +5 -4
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.context.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.d.ts +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js +3 -2
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.public.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +27 -16
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.d.ts +807 -316
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +28 -17
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.d.ts +2 -2
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.js +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.context.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.d.ts +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.public.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.d.ts +657 -230
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +26 -15
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js.map +1 -1
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.d.ts +807 -316
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +26 -15
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js.map +1 -1
- 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
|
-
/**
|
|
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
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* Category IDs of the draft post.
|
|
25
|
+
* @maxSize 10
|
|
26
|
+
* @maxLength 38
|
|
27
|
+
*/
|
|
19
28
|
categoryIds?: string[];
|
|
20
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* Draft post owner's member ID.
|
|
31
|
+
* @format GUID
|
|
32
|
+
*/
|
|
21
33
|
memberId?: string | null;
|
|
22
|
-
/**
|
|
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
|
-
/**
|
|
49
|
+
/**
|
|
50
|
+
* Tag IDs the draft post is tagged with.
|
|
51
|
+
* @maxSize 30
|
|
52
|
+
* @maxLength 38
|
|
53
|
+
*/
|
|
34
54
|
tagIds?: string[];
|
|
35
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* IDs of posts related to this draft post.
|
|
57
|
+
* @maxSize 3
|
|
58
|
+
* @maxLength 38
|
|
59
|
+
*/
|
|
36
60
|
relatedPostIds?: string[];
|
|
37
|
-
/**
|
|
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
|
-
/**
|
|
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
|
/**
|
|
@@ -99,6 +134,8 @@ export interface DraftPost {
|
|
|
99
134
|
/**
|
|
100
135
|
* Reserved for internal use.
|
|
101
136
|
* @readonly
|
|
137
|
+
* @maxSize 5000
|
|
138
|
+
* @maxLength 100
|
|
102
139
|
*/
|
|
103
140
|
slugs?: string[];
|
|
104
141
|
/**
|
|
@@ -111,7 +148,10 @@ export interface DraftPost {
|
|
|
111
148
|
* @readonly
|
|
112
149
|
*/
|
|
113
150
|
_createdDate?: Date | null;
|
|
114
|
-
/**
|
|
151
|
+
/**
|
|
152
|
+
* SEO slug.
|
|
153
|
+
* @maxLength 100
|
|
154
|
+
*/
|
|
115
155
|
seoSlug?: string | null;
|
|
116
156
|
/** Post cover media. */
|
|
117
157
|
media?: Media;
|
|
@@ -120,6 +160,7 @@ export interface DraftPost {
|
|
|
120
160
|
/**
|
|
121
161
|
* Reserved for internal use.
|
|
122
162
|
* @readonly
|
|
163
|
+
* @maxLength 24
|
|
123
164
|
*/
|
|
124
165
|
internalId?: string | null;
|
|
125
166
|
}
|
|
@@ -141,7 +182,11 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
|
141
182
|
displayed?: boolean;
|
|
142
183
|
/** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
|
|
143
184
|
custom?: boolean;
|
|
144
|
-
/**
|
|
185
|
+
/**
|
|
186
|
+
* Media alternative text.
|
|
187
|
+
* @minLength 1
|
|
188
|
+
* @maxLength 1000
|
|
189
|
+
*/
|
|
145
190
|
altText?: string | null;
|
|
146
191
|
}
|
|
147
192
|
/** @oneof */
|
|
@@ -832,11 +877,20 @@ export interface GIFData {
|
|
|
832
877
|
gifType?: GIFType;
|
|
833
878
|
}
|
|
834
879
|
export interface GIF {
|
|
835
|
-
/**
|
|
880
|
+
/**
|
|
881
|
+
* GIF format URL.
|
|
882
|
+
* @format WEB_URL
|
|
883
|
+
*/
|
|
836
884
|
gif?: string | null;
|
|
837
|
-
/**
|
|
885
|
+
/**
|
|
886
|
+
* MP4 format URL.
|
|
887
|
+
* @format WEB_URL
|
|
888
|
+
*/
|
|
838
889
|
mp4?: string | null;
|
|
839
|
-
/**
|
|
890
|
+
/**
|
|
891
|
+
* Thumbnail URL.
|
|
892
|
+
* @format WEB_URL
|
|
893
|
+
*/
|
|
840
894
|
still?: string | null;
|
|
841
895
|
}
|
|
842
896
|
export declare enum GIFType {
|
|
@@ -902,6 +956,25 @@ export interface ImageData {
|
|
|
902
956
|
caption?: string | null;
|
|
903
957
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
904
958
|
disableDownload?: boolean | null;
|
|
959
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
960
|
+
decorative?: boolean | null;
|
|
961
|
+
/** Styling for the image. */
|
|
962
|
+
styles?: ImageDataStyles;
|
|
963
|
+
}
|
|
964
|
+
export interface StylesBorder {
|
|
965
|
+
/** Border width in pixels. */
|
|
966
|
+
width?: number | null;
|
|
967
|
+
/**
|
|
968
|
+
* Border color as a hexadecimal value.
|
|
969
|
+
* @format COLOR_HEX
|
|
970
|
+
*/
|
|
971
|
+
color?: string | null;
|
|
972
|
+
/** Border radius in pixels. */
|
|
973
|
+
radius?: number | null;
|
|
974
|
+
}
|
|
975
|
+
export interface ImageDataStyles {
|
|
976
|
+
/** Border attributes. */
|
|
977
|
+
border?: StylesBorder;
|
|
905
978
|
}
|
|
906
979
|
export interface LinkPreviewData {
|
|
907
980
|
/** Styling for the link preview's container. */
|
|
@@ -916,6 +989,51 @@ export interface LinkPreviewData {
|
|
|
916
989
|
description?: string | null;
|
|
917
990
|
/** The preview content as HTML. */
|
|
918
991
|
html?: string | null;
|
|
992
|
+
/** Styling for the link preview. */
|
|
993
|
+
styles?: LinkPreviewDataStyles;
|
|
994
|
+
}
|
|
995
|
+
export declare enum Position {
|
|
996
|
+
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
997
|
+
START = "START",
|
|
998
|
+
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
999
|
+
END = "END",
|
|
1000
|
+
/** Thumbnail positioned at the top */
|
|
1001
|
+
TOP = "TOP",
|
|
1002
|
+
/** Thumbnail hidden and not displayed */
|
|
1003
|
+
HIDDEN = "HIDDEN"
|
|
1004
|
+
}
|
|
1005
|
+
export interface LinkPreviewDataStyles {
|
|
1006
|
+
/**
|
|
1007
|
+
* Background color as a hexadecimal value.
|
|
1008
|
+
* @format COLOR_HEX
|
|
1009
|
+
*/
|
|
1010
|
+
backgroundColor?: string | null;
|
|
1011
|
+
/**
|
|
1012
|
+
* Title color as a hexadecimal value.
|
|
1013
|
+
* @format COLOR_HEX
|
|
1014
|
+
*/
|
|
1015
|
+
titleColor?: string | null;
|
|
1016
|
+
/**
|
|
1017
|
+
* Subtitle color as a hexadecimal value.
|
|
1018
|
+
* @format COLOR_HEX
|
|
1019
|
+
*/
|
|
1020
|
+
subtitleColor?: string | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Link color as a hexadecimal value.
|
|
1023
|
+
* @format COLOR_HEX
|
|
1024
|
+
*/
|
|
1025
|
+
linkColor?: string | null;
|
|
1026
|
+
/** Border width in pixels. */
|
|
1027
|
+
borderWidth?: number | null;
|
|
1028
|
+
/** Border radius in pixels. */
|
|
1029
|
+
borderRadius?: number | null;
|
|
1030
|
+
/**
|
|
1031
|
+
* Border color as a hexadecimal value.
|
|
1032
|
+
* @format COLOR_HEX
|
|
1033
|
+
*/
|
|
1034
|
+
borderColor?: string | null;
|
|
1035
|
+
/** Position of thumbnail. Defaults to `START`. */
|
|
1036
|
+
thumbnailPosition?: Position;
|
|
919
1037
|
}
|
|
920
1038
|
export interface MapData {
|
|
921
1039
|
/** Styling for the map's container. */
|
|
@@ -1048,13 +1166,22 @@ export declare enum BackgroundType {
|
|
|
1048
1166
|
export interface Gradient {
|
|
1049
1167
|
/** The gradient angle in degrees. */
|
|
1050
1168
|
angle?: number | null;
|
|
1051
|
-
/**
|
|
1169
|
+
/**
|
|
1170
|
+
* The start color as a hexademical value.
|
|
1171
|
+
* @format COLOR_HEX
|
|
1172
|
+
*/
|
|
1052
1173
|
startColor?: string | null;
|
|
1053
|
-
/**
|
|
1174
|
+
/**
|
|
1175
|
+
* The end color as a hexademical value.
|
|
1176
|
+
* @format COLOR_HEX
|
|
1177
|
+
*/
|
|
1054
1178
|
lastColor?: string | null;
|
|
1055
1179
|
}
|
|
1056
1180
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1057
|
-
/**
|
|
1181
|
+
/**
|
|
1182
|
+
* The background color as a hexademical value.
|
|
1183
|
+
* @format COLOR_HEX
|
|
1184
|
+
*/
|
|
1058
1185
|
color?: string | null;
|
|
1059
1186
|
/** An image to use for the background. */
|
|
1060
1187
|
image?: V1Media;
|
|
@@ -1065,7 +1192,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1065
1192
|
}
|
|
1066
1193
|
/** @oneof */
|
|
1067
1194
|
export interface BackgroundBackgroundOneOf {
|
|
1068
|
-
/**
|
|
1195
|
+
/**
|
|
1196
|
+
* The background color as a hexademical value.
|
|
1197
|
+
* @format COLOR_HEX
|
|
1198
|
+
*/
|
|
1069
1199
|
color?: string | null;
|
|
1070
1200
|
/** An image to use for the background. */
|
|
1071
1201
|
image?: V1Media;
|
|
@@ -1377,17 +1507,32 @@ export declare enum VerticalAlignment {
|
|
|
1377
1507
|
export interface CellStyle {
|
|
1378
1508
|
/** Vertical alignment for the cell's text. */
|
|
1379
1509
|
verticalAlignment?: VerticalAlignment;
|
|
1380
|
-
/**
|
|
1510
|
+
/**
|
|
1511
|
+
* Cell background color as a hexadecimal value.
|
|
1512
|
+
* @format COLOR_HEX
|
|
1513
|
+
*/
|
|
1381
1514
|
backgroundColor?: string | null;
|
|
1382
1515
|
}
|
|
1383
1516
|
export interface BorderColors {
|
|
1384
|
-
/**
|
|
1517
|
+
/**
|
|
1518
|
+
* Left border color as a hexadecimal value.
|
|
1519
|
+
* @format COLOR_HEX
|
|
1520
|
+
*/
|
|
1385
1521
|
left?: string | null;
|
|
1386
|
-
/**
|
|
1522
|
+
/**
|
|
1523
|
+
* Right border color as a hexadecimal value.
|
|
1524
|
+
* @format COLOR_HEX
|
|
1525
|
+
*/
|
|
1387
1526
|
right?: string | null;
|
|
1388
|
-
/**
|
|
1527
|
+
/**
|
|
1528
|
+
* Top border color as a hexadecimal value.
|
|
1529
|
+
* @format COLOR_HEX
|
|
1530
|
+
*/
|
|
1389
1531
|
top?: string | null;
|
|
1390
|
-
/**
|
|
1532
|
+
/**
|
|
1533
|
+
* Bottom border color as a hexadecimal value.
|
|
1534
|
+
* @format COLOR_HEX
|
|
1535
|
+
*/
|
|
1391
1536
|
bottom?: string | null;
|
|
1392
1537
|
}
|
|
1393
1538
|
/**
|
|
@@ -1515,13 +1660,19 @@ export declare enum Status {
|
|
|
1515
1660
|
IN_REVIEW = "IN_REVIEW"
|
|
1516
1661
|
}
|
|
1517
1662
|
export interface ModerationDetails {
|
|
1518
|
-
/**
|
|
1663
|
+
/**
|
|
1664
|
+
* Member ID of the person submitting the draft post for review.
|
|
1665
|
+
* @format GUID
|
|
1666
|
+
*/
|
|
1519
1667
|
submittedBy?: string;
|
|
1520
1668
|
/** Date the post was submitted for review. */
|
|
1521
1669
|
submittedDate?: Date | null;
|
|
1522
1670
|
/** Status indicating whether the submission was approved or rejected by the moderator. */
|
|
1523
1671
|
status?: ModerationStatusStatus;
|
|
1524
|
-
/**
|
|
1672
|
+
/**
|
|
1673
|
+
* Member ID of the person who approved or rejected the post.
|
|
1674
|
+
* @format GUID
|
|
1675
|
+
*/
|
|
1525
1676
|
moderatedBy?: string | null;
|
|
1526
1677
|
/** Date the post was approved or rejected. */
|
|
1527
1678
|
moderationDate?: Date | null;
|
|
@@ -1547,7 +1698,10 @@ export interface Keyword {
|
|
|
1547
1698
|
term?: string;
|
|
1548
1699
|
/** Whether the keyword is the main focus keyword. */
|
|
1549
1700
|
isMain?: boolean;
|
|
1550
|
-
/**
|
|
1701
|
+
/**
|
|
1702
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1703
|
+
* @maxLength 1000
|
|
1704
|
+
*/
|
|
1551
1705
|
origin?: string | null;
|
|
1552
1706
|
}
|
|
1553
1707
|
export interface Tag {
|
|
@@ -1580,7 +1734,10 @@ export interface Settings {
|
|
|
1580
1734
|
* Default: `false` (Auto Redirect is enabled.)
|
|
1581
1735
|
*/
|
|
1582
1736
|
preventAutoRedirect?: boolean;
|
|
1583
|
-
/**
|
|
1737
|
+
/**
|
|
1738
|
+
* User-selected keyword terms for a specific page.
|
|
1739
|
+
* @maxSize 5
|
|
1740
|
+
*/
|
|
1584
1741
|
keywords?: Keyword[];
|
|
1585
1742
|
}
|
|
1586
1743
|
export interface Media extends MediaMediaOneOf {
|
|
@@ -1592,7 +1749,11 @@ export interface Media extends MediaMediaOneOf {
|
|
|
1592
1749
|
displayed?: boolean;
|
|
1593
1750
|
/** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
|
|
1594
1751
|
custom?: boolean;
|
|
1595
|
-
/**
|
|
1752
|
+
/**
|
|
1753
|
+
* Media alternative text.
|
|
1754
|
+
* @minLength 1
|
|
1755
|
+
* @maxLength 1000
|
|
1756
|
+
*/
|
|
1596
1757
|
altText?: string | null;
|
|
1597
1758
|
}
|
|
1598
1759
|
/** @oneof */
|
|
@@ -1625,7 +1786,10 @@ export interface EmbedMedia {
|
|
|
1625
1786
|
video?: EmbedVideo;
|
|
1626
1787
|
}
|
|
1627
1788
|
export interface EmbedThumbnail {
|
|
1628
|
-
/**
|
|
1789
|
+
/**
|
|
1790
|
+
* Thumbnail url.
|
|
1791
|
+
* @maxLength 2000
|
|
1792
|
+
*/
|
|
1629
1793
|
url?: string;
|
|
1630
1794
|
/** Thumbnail width. */
|
|
1631
1795
|
width?: number;
|
|
@@ -1633,7 +1797,10 @@ export interface EmbedThumbnail {
|
|
|
1633
1797
|
height?: number;
|
|
1634
1798
|
}
|
|
1635
1799
|
export interface EmbedVideo {
|
|
1636
|
-
/**
|
|
1800
|
+
/**
|
|
1801
|
+
* Video url.
|
|
1802
|
+
* @maxLength 2000
|
|
1803
|
+
*/
|
|
1637
1804
|
url?: string;
|
|
1638
1805
|
/** Video width. */
|
|
1639
1806
|
width?: number;
|
|
@@ -1641,130 +1808,342 @@ export interface EmbedVideo {
|
|
|
1641
1808
|
height?: number;
|
|
1642
1809
|
}
|
|
1643
1810
|
export interface DraftPostTranslation {
|
|
1644
|
-
/**
|
|
1811
|
+
/**
|
|
1812
|
+
* Post ID.
|
|
1813
|
+
* @format GUID
|
|
1814
|
+
*/
|
|
1645
1815
|
_id?: string;
|
|
1646
1816
|
/** Post status. */
|
|
1647
1817
|
status?: Status;
|
|
1648
|
-
/**
|
|
1818
|
+
/**
|
|
1819
|
+
* Language the post is written in.
|
|
1820
|
+
* @format LANGUAGE_TAG
|
|
1821
|
+
*/
|
|
1649
1822
|
language?: string | null;
|
|
1650
|
-
/**
|
|
1823
|
+
/**
|
|
1824
|
+
* Post slug. For example, 'post-slug'.
|
|
1825
|
+
* @maxLength 100
|
|
1826
|
+
*/
|
|
1651
1827
|
slug?: string | null;
|
|
1652
1828
|
/** SEO data. */
|
|
1653
1829
|
seoData?: SeoSchema;
|
|
1654
1830
|
/** Post URL. */
|
|
1655
1831
|
url?: string;
|
|
1656
1832
|
}
|
|
1657
|
-
export interface InitialDraftPostsCopied {
|
|
1658
|
-
/** Number of draft posts copied. */
|
|
1659
|
-
count?: number;
|
|
1660
|
-
}
|
|
1661
1833
|
export interface DraftCategoriesUpdated {
|
|
1662
|
-
/**
|
|
1834
|
+
/**
|
|
1835
|
+
* Draft post ID.
|
|
1836
|
+
* @maxLength 38
|
|
1837
|
+
*/
|
|
1663
1838
|
draftPostId?: string;
|
|
1664
|
-
/**
|
|
1839
|
+
/**
|
|
1840
|
+
* Current categories of the draft.
|
|
1841
|
+
* @maxSize 10
|
|
1842
|
+
* @format GUID
|
|
1843
|
+
*/
|
|
1665
1844
|
categories?: string[];
|
|
1666
|
-
/**
|
|
1845
|
+
/**
|
|
1846
|
+
* Previous categories of the draft.
|
|
1847
|
+
* @maxSize 10
|
|
1848
|
+
* @format GUID
|
|
1849
|
+
*/
|
|
1667
1850
|
previousCategories?: string[];
|
|
1668
1851
|
}
|
|
1669
1852
|
export interface DraftTagsUpdated {
|
|
1670
|
-
/**
|
|
1853
|
+
/**
|
|
1854
|
+
* Draft post ID.
|
|
1855
|
+
* @maxLength 38
|
|
1856
|
+
*/
|
|
1671
1857
|
draftPostId?: string;
|
|
1672
|
-
/**
|
|
1858
|
+
/**
|
|
1859
|
+
* Current tags of the draft.
|
|
1860
|
+
* @maxSize 30
|
|
1861
|
+
* @format GUID
|
|
1862
|
+
*/
|
|
1673
1863
|
tags?: string[];
|
|
1674
|
-
/**
|
|
1864
|
+
/**
|
|
1865
|
+
* Previous tags of the draft.
|
|
1866
|
+
* @maxSize 30
|
|
1867
|
+
* @format GUID
|
|
1868
|
+
*/
|
|
1675
1869
|
previousTags?: string[];
|
|
1676
1870
|
}
|
|
1677
|
-
export interface
|
|
1678
|
-
/** Draft post to create. */
|
|
1679
|
-
draftPost: DraftPost;
|
|
1871
|
+
export interface GetDraftPostTotalsRequest {
|
|
1680
1872
|
/**
|
|
1681
|
-
*
|
|
1682
|
-
*
|
|
1683
|
-
*
|
|
1873
|
+
* Group results by fields (defaults to grouping by status).
|
|
1874
|
+
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
1875
|
+
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
1876
|
+
* @maxSize 10
|
|
1684
1877
|
*/
|
|
1685
|
-
|
|
1878
|
+
groupBy?: TotalDraftPostsGroupingField[];
|
|
1686
1879
|
/**
|
|
1687
|
-
*
|
|
1688
|
-
*
|
|
1689
|
-
* only the draft post's base fields are returned.
|
|
1880
|
+
* Optional language filter by provided language code. Useful in multilingual context.
|
|
1881
|
+
* @format LANGUAGE_TAG
|
|
1690
1882
|
*/
|
|
1691
|
-
|
|
1883
|
+
language?: string | null;
|
|
1692
1884
|
}
|
|
1693
|
-
export declare enum
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
AUTO_SAVE = "AUTO_SAVE",
|
|
1699
|
-
/** Copied from template during provisioning flow. */
|
|
1700
|
-
PROVISIONING = "PROVISIONING",
|
|
1701
|
-
/** Imported from another blog. */
|
|
1702
|
-
IMPORT = "IMPORT",
|
|
1703
|
-
/** Triggered by autosave when post created by AI tool. */
|
|
1704
|
-
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
1885
|
+
export declare enum TotalDraftPostsGroupingField {
|
|
1886
|
+
/** Groups results by status. */
|
|
1887
|
+
STATUS = "STATUS",
|
|
1888
|
+
/** Groups results by language. */
|
|
1889
|
+
LANGUAGE = "LANGUAGE"
|
|
1705
1890
|
}
|
|
1706
|
-
export
|
|
1707
|
-
/**
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1891
|
+
export interface GetDraftPostTotalsResponse {
|
|
1892
|
+
/** Draft post totals. */
|
|
1893
|
+
totalDraftPosts?: TotalDraftPosts[];
|
|
1894
|
+
}
|
|
1895
|
+
export interface TotalDraftPosts {
|
|
1896
|
+
/** Draft post totals in that group. */
|
|
1897
|
+
total?: number;
|
|
1898
|
+
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
1899
|
+
status?: Status;
|
|
1711
1900
|
/**
|
|
1712
|
-
*
|
|
1713
|
-
*
|
|
1901
|
+
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
1902
|
+
* @format LANGUAGE_TAG
|
|
1714
1903
|
*/
|
|
1715
|
-
|
|
1716
|
-
/** Includes content field. */
|
|
1717
|
-
CONTENT = "CONTENT",
|
|
1718
|
-
/** Includes rich content field. */
|
|
1719
|
-
RICH_CONTENT = "RICH_CONTENT",
|
|
1720
|
-
/** If the user has not set excerpt, returns the one autogenerated from content. */
|
|
1721
|
-
GENERATED_EXCERPT = "GENERATED_EXCERPT"
|
|
1722
|
-
}
|
|
1723
|
-
export interface CreateDraftPostResponse {
|
|
1724
|
-
/** Created draft post info. */
|
|
1725
|
-
draftPost?: DraftPost;
|
|
1904
|
+
language?: string | null;
|
|
1726
1905
|
}
|
|
1727
|
-
export interface
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
/** Whether to return the full created draft post entities in the response. */
|
|
1733
|
-
returnFullEntity?: boolean;
|
|
1906
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1907
|
+
createdEvent?: EntityCreatedEvent;
|
|
1908
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1909
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1910
|
+
actionEvent?: ActionEvent;
|
|
1734
1911
|
/**
|
|
1735
|
-
*
|
|
1736
|
-
*
|
|
1737
|
-
* For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
|
|
1912
|
+
* Unique event ID.
|
|
1913
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1738
1914
|
*/
|
|
1739
|
-
|
|
1915
|
+
_id?: string;
|
|
1916
|
+
/**
|
|
1917
|
+
* Assumes actions are also always typed to an entity_type
|
|
1918
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1919
|
+
*/
|
|
1920
|
+
entityFqdn?: string;
|
|
1921
|
+
/**
|
|
1922
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1923
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1924
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1925
|
+
*/
|
|
1926
|
+
slug?: string;
|
|
1927
|
+
/** ID of the entity associated with the event. */
|
|
1928
|
+
entityId?: string;
|
|
1929
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1930
|
+
eventTime?: Date | null;
|
|
1931
|
+
/**
|
|
1932
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1933
|
+
* (for example, GDPR).
|
|
1934
|
+
*/
|
|
1935
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1936
|
+
/** If present, indicates the action that triggered the event. */
|
|
1937
|
+
originatedFrom?: string | null;
|
|
1938
|
+
/**
|
|
1939
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1940
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1941
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1942
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1943
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1944
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1945
|
+
*/
|
|
1946
|
+
entityEventSequence?: string | null;
|
|
1740
1947
|
}
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1948
|
+
/** @oneof */
|
|
1949
|
+
export interface DomainEventBodyOneOf {
|
|
1950
|
+
createdEvent?: EntityCreatedEvent;
|
|
1951
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1952
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1953
|
+
actionEvent?: ActionEvent;
|
|
1746
1954
|
}
|
|
1747
|
-
export interface
|
|
1748
|
-
|
|
1749
|
-
itemMetadata?: ItemMetadata;
|
|
1750
|
-
/** Optional full draft post. */
|
|
1751
|
-
item?: DraftPost;
|
|
1955
|
+
export interface EntityCreatedEvent {
|
|
1956
|
+
entity?: string;
|
|
1752
1957
|
}
|
|
1753
|
-
export interface
|
|
1754
|
-
|
|
1755
|
-
_id?: string | null;
|
|
1756
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1757
|
-
originalIndex?: number;
|
|
1758
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1759
|
-
success?: boolean;
|
|
1760
|
-
/** Details about the error in case of failure. */
|
|
1761
|
-
error?: ApplicationError;
|
|
1958
|
+
export interface RestoreInfo {
|
|
1959
|
+
deletedDate?: Date | null;
|
|
1762
1960
|
}
|
|
1763
|
-
export interface
|
|
1764
|
-
/**
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1961
|
+
export interface EntityUpdatedEvent {
|
|
1962
|
+
/**
|
|
1963
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1964
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1965
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1966
|
+
*/
|
|
1967
|
+
currentEntity?: string;
|
|
1968
|
+
}
|
|
1969
|
+
export interface EntityDeletedEvent {
|
|
1970
|
+
/** Entity that was deleted */
|
|
1971
|
+
deletedEntity?: string | null;
|
|
1972
|
+
}
|
|
1973
|
+
export interface ActionEvent {
|
|
1974
|
+
body?: string;
|
|
1975
|
+
}
|
|
1976
|
+
export interface MessageEnvelope {
|
|
1977
|
+
/**
|
|
1978
|
+
* App instance ID.
|
|
1979
|
+
* @format GUID
|
|
1980
|
+
*/
|
|
1981
|
+
instanceId?: string | null;
|
|
1982
|
+
/**
|
|
1983
|
+
* Event type.
|
|
1984
|
+
* @maxLength 150
|
|
1985
|
+
*/
|
|
1986
|
+
eventType?: string;
|
|
1987
|
+
/** The identification type and identity data. */
|
|
1988
|
+
identity?: IdentificationData;
|
|
1989
|
+
/** Stringify payload. */
|
|
1990
|
+
data?: string;
|
|
1991
|
+
}
|
|
1992
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1993
|
+
/**
|
|
1994
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1995
|
+
* @format GUID
|
|
1996
|
+
*/
|
|
1997
|
+
anonymousVisitorId?: string;
|
|
1998
|
+
/**
|
|
1999
|
+
* ID of a site visitor that has logged in to the site.
|
|
2000
|
+
* @format GUID
|
|
2001
|
+
*/
|
|
2002
|
+
memberId?: string;
|
|
2003
|
+
/**
|
|
2004
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2005
|
+
* @format GUID
|
|
2006
|
+
*/
|
|
2007
|
+
wixUserId?: string;
|
|
2008
|
+
/**
|
|
2009
|
+
* ID of an app.
|
|
2010
|
+
* @format GUID
|
|
2011
|
+
*/
|
|
2012
|
+
appId?: string;
|
|
2013
|
+
/** @readonly */
|
|
2014
|
+
identityType?: WebhookIdentityType;
|
|
2015
|
+
}
|
|
2016
|
+
/** @oneof */
|
|
2017
|
+
export interface IdentificationDataIdOneOf {
|
|
2018
|
+
/**
|
|
2019
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2020
|
+
* @format GUID
|
|
2021
|
+
*/
|
|
2022
|
+
anonymousVisitorId?: string;
|
|
2023
|
+
/**
|
|
2024
|
+
* ID of a site visitor that has logged in to the site.
|
|
2025
|
+
* @format GUID
|
|
2026
|
+
*/
|
|
2027
|
+
memberId?: string;
|
|
2028
|
+
/**
|
|
2029
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2030
|
+
* @format GUID
|
|
2031
|
+
*/
|
|
2032
|
+
wixUserId?: string;
|
|
2033
|
+
/**
|
|
2034
|
+
* ID of an app.
|
|
2035
|
+
* @format GUID
|
|
2036
|
+
*/
|
|
2037
|
+
appId?: string;
|
|
2038
|
+
}
|
|
2039
|
+
export declare enum WebhookIdentityType {
|
|
2040
|
+
UNKNOWN = "UNKNOWN",
|
|
2041
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2042
|
+
MEMBER = "MEMBER",
|
|
2043
|
+
WIX_USER = "WIX_USER",
|
|
2044
|
+
APP = "APP"
|
|
2045
|
+
}
|
|
2046
|
+
export interface InitialDraftPostsCopied {
|
|
2047
|
+
/** Number of draft posts copied. */
|
|
2048
|
+
count?: number;
|
|
2049
|
+
}
|
|
2050
|
+
export interface CreateDraftPostRequest {
|
|
2051
|
+
/** Draft post to create. */
|
|
2052
|
+
draftPost: DraftPost;
|
|
2053
|
+
/**
|
|
2054
|
+
* Whether the draft post should be published on creation.
|
|
2055
|
+
*
|
|
2056
|
+
* Default: `false`
|
|
2057
|
+
*/
|
|
2058
|
+
publish?: boolean;
|
|
2059
|
+
/**
|
|
2060
|
+
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2061
|
+
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
2062
|
+
* only the draft post's base fields are returned.
|
|
2063
|
+
* @maxSize 10
|
|
2064
|
+
*/
|
|
2065
|
+
fieldsets?: Field[];
|
|
2066
|
+
}
|
|
2067
|
+
export declare enum Type {
|
|
2068
|
+
UNKNOWN = "UNKNOWN",
|
|
2069
|
+
/** Manually saved. */
|
|
2070
|
+
MANUAL = "MANUAL",
|
|
2071
|
+
/** Triggered by autosave. */
|
|
2072
|
+
AUTO_SAVE = "AUTO_SAVE",
|
|
2073
|
+
/** Copied from template during provisioning flow. */
|
|
2074
|
+
PROVISIONING = "PROVISIONING",
|
|
2075
|
+
/** Imported from another blog. */
|
|
2076
|
+
IMPORT = "IMPORT",
|
|
2077
|
+
/** Triggered by autosave when post created by AI tool. */
|
|
2078
|
+
AI_AUTO_SAVE = "AI_AUTO_SAVE"
|
|
2079
|
+
}
|
|
2080
|
+
export declare enum Field {
|
|
2081
|
+
/** Unknown field. */
|
|
2082
|
+
UNKNOWN = "UNKNOWN",
|
|
2083
|
+
/** Includes draft post preview URL. */
|
|
2084
|
+
URL = "URL",
|
|
2085
|
+
/**
|
|
2086
|
+
* Includes internal id field.
|
|
2087
|
+
* Reserved for internal use.
|
|
2088
|
+
*/
|
|
2089
|
+
INTERNAL_ID = "INTERNAL_ID",
|
|
2090
|
+
/** Includes content field. */
|
|
2091
|
+
CONTENT = "CONTENT",
|
|
2092
|
+
/** Includes rich content field. */
|
|
2093
|
+
RICH_CONTENT = "RICH_CONTENT",
|
|
2094
|
+
/** If the user has not set excerpt, returns the one autogenerated from content. */
|
|
2095
|
+
GENERATED_EXCERPT = "GENERATED_EXCERPT"
|
|
2096
|
+
}
|
|
2097
|
+
export interface CreateDraftPostResponse {
|
|
2098
|
+
/** Created draft post info. */
|
|
2099
|
+
draftPost?: DraftPost;
|
|
2100
|
+
}
|
|
2101
|
+
export interface BulkCreateDraftPostsRequest {
|
|
2102
|
+
/**
|
|
2103
|
+
* Draft posts to create.
|
|
2104
|
+
* @minSize 1
|
|
2105
|
+
* @maxSize 20
|
|
2106
|
+
*/
|
|
2107
|
+
draftPosts: DraftPost[];
|
|
2108
|
+
/** Whether the draft post should be published after creation. */
|
|
2109
|
+
publish?: boolean;
|
|
2110
|
+
/** Whether to return the full created draft post entities in the response. */
|
|
2111
|
+
returnFullEntity?: boolean;
|
|
2112
|
+
/**
|
|
2113
|
+
* List of draft post fields to be included in the response if the entities are present.
|
|
2114
|
+
* Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
|
|
2115
|
+
* For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
|
|
2116
|
+
* @maxSize 10
|
|
2117
|
+
*/
|
|
2118
|
+
fieldsets?: Field[];
|
|
2119
|
+
}
|
|
2120
|
+
export interface BulkCreateDraftPostsResponse {
|
|
2121
|
+
/** Draft posts created by bulk action. */
|
|
2122
|
+
results?: BulkDraftPostResult[];
|
|
2123
|
+
/** Bulk action metadata. */
|
|
2124
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
2125
|
+
}
|
|
2126
|
+
export interface BulkDraftPostResult {
|
|
2127
|
+
/** Bulk actions metadata for draft post. */
|
|
2128
|
+
itemMetadata?: ItemMetadata;
|
|
2129
|
+
/** Optional full draft post. */
|
|
2130
|
+
item?: DraftPost;
|
|
2131
|
+
}
|
|
2132
|
+
export interface ItemMetadata {
|
|
2133
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2134
|
+
_id?: string | null;
|
|
2135
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2136
|
+
originalIndex?: number;
|
|
2137
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2138
|
+
success?: boolean;
|
|
2139
|
+
/** Details about the error in case of failure. */
|
|
2140
|
+
error?: ApplicationError;
|
|
2141
|
+
}
|
|
2142
|
+
export interface ApplicationError {
|
|
2143
|
+
/** Error code. */
|
|
2144
|
+
code?: string;
|
|
2145
|
+
/** Description of the error. */
|
|
2146
|
+
description?: string;
|
|
1768
2147
|
/** Data related to the error. */
|
|
1769
2148
|
data?: Record<string, any> | null;
|
|
1770
2149
|
}
|
|
@@ -1777,7 +2156,11 @@ export interface BulkActionMetadata {
|
|
|
1777
2156
|
undetailedFailures?: number;
|
|
1778
2157
|
}
|
|
1779
2158
|
export interface BulkUpdateDraftPostsRequest {
|
|
1780
|
-
/**
|
|
2159
|
+
/**
|
|
2160
|
+
* Draft posts to update.
|
|
2161
|
+
* @minSize 1
|
|
2162
|
+
* @maxSize 20
|
|
2163
|
+
*/
|
|
1781
2164
|
draftPosts?: MaskedDraftPosts[];
|
|
1782
2165
|
/**
|
|
1783
2166
|
* Action to perform on the posts.
|
|
@@ -1801,6 +2184,7 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
1801
2184
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
1802
2185
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
1803
2186
|
* only the draft post's base fields are returned.
|
|
2187
|
+
* @maxSize 10
|
|
1804
2188
|
*/
|
|
1805
2189
|
fieldsets?: Field[];
|
|
1806
2190
|
}
|
|
@@ -1840,6 +2224,7 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
1840
2224
|
*
|
|
1841
2225
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
1842
2226
|
* If omitted, deleted draft posts in all languages are returned.
|
|
2227
|
+
* @format LANGUAGE_TAG
|
|
1843
2228
|
*/
|
|
1844
2229
|
language?: string | null;
|
|
1845
2230
|
/**
|
|
@@ -1854,9 +2239,14 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
1854
2239
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
1855
2240
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
1856
2241
|
* only the draft post's base fields are returned.
|
|
2242
|
+
* @maxSize 10
|
|
1857
2243
|
*/
|
|
1858
2244
|
fieldsets?: Field[];
|
|
1859
|
-
/**
|
|
2245
|
+
/**
|
|
2246
|
+
* Draft post ids.
|
|
2247
|
+
* @maxSize 100
|
|
2248
|
+
* @format GUID
|
|
2249
|
+
*/
|
|
1860
2250
|
draftPostIds?: string[];
|
|
1861
2251
|
}
|
|
1862
2252
|
export declare enum GetDraftPostsSort {
|
|
@@ -1878,9 +2268,14 @@ export interface BlogPaging {
|
|
|
1878
2268
|
*
|
|
1879
2269
|
*
|
|
1880
2270
|
* Default:`50`
|
|
2271
|
+
* @min 1
|
|
2272
|
+
* @max 100
|
|
1881
2273
|
*/
|
|
1882
2274
|
limit?: number;
|
|
1883
|
-
/**
|
|
2275
|
+
/**
|
|
2276
|
+
* Pointer to the next or previous page in the list of results.
|
|
2277
|
+
* @maxLength 2000
|
|
2278
|
+
*/
|
|
1884
2279
|
cursor?: string | null;
|
|
1885
2280
|
}
|
|
1886
2281
|
export interface ListDeletedDraftPostsResponse {
|
|
@@ -1896,16 +2291,23 @@ export interface MetaData {
|
|
|
1896
2291
|
offset?: number;
|
|
1897
2292
|
/** Total number of items that match the query. */
|
|
1898
2293
|
total?: number;
|
|
1899
|
-
/**
|
|
2294
|
+
/**
|
|
2295
|
+
* Pointer to the next or previous page in the list of results.
|
|
2296
|
+
* @maxLength 2000
|
|
2297
|
+
*/
|
|
1900
2298
|
cursor?: string | null;
|
|
1901
2299
|
}
|
|
1902
2300
|
export interface GetDraftPostRequest {
|
|
1903
|
-
/**
|
|
2301
|
+
/**
|
|
2302
|
+
* Draft post ID.
|
|
2303
|
+
* @maxLength 38
|
|
2304
|
+
*/
|
|
1904
2305
|
draftPostId: string;
|
|
1905
2306
|
/**
|
|
1906
2307
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
1907
2308
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
1908
2309
|
* only the draft post's base fields are returned.
|
|
2310
|
+
* @maxSize 10
|
|
1909
2311
|
*/
|
|
1910
2312
|
fieldsets?: Field[];
|
|
1911
2313
|
}
|
|
@@ -1914,11 +2316,17 @@ export interface GetDraftPostResponse {
|
|
|
1914
2316
|
draftPost?: DraftPost;
|
|
1915
2317
|
}
|
|
1916
2318
|
export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
|
|
1917
|
-
/**
|
|
2319
|
+
/**
|
|
2320
|
+
* DraftJs content to update.
|
|
2321
|
+
* @maxLength 400000
|
|
2322
|
+
*/
|
|
1918
2323
|
content?: string;
|
|
1919
2324
|
/** Draft post rich content. */
|
|
1920
2325
|
richContent?: RichContent;
|
|
1921
|
-
/**
|
|
2326
|
+
/**
|
|
2327
|
+
* Draft post ID.
|
|
2328
|
+
* @maxLength 38
|
|
2329
|
+
*/
|
|
1922
2330
|
draftPostId?: string;
|
|
1923
2331
|
/** Change origin. */
|
|
1924
2332
|
changeOrigin?: Origin;
|
|
@@ -1926,12 +2334,16 @@ export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentReq
|
|
|
1926
2334
|
* List of draft post fields to be included if entities are present in the response.
|
|
1927
2335
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
1928
2336
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2337
|
+
* @maxSize 10
|
|
1929
2338
|
*/
|
|
1930
2339
|
fieldsets?: Field[];
|
|
1931
2340
|
}
|
|
1932
2341
|
/** @oneof */
|
|
1933
2342
|
export interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
1934
|
-
/**
|
|
2343
|
+
/**
|
|
2344
|
+
* DraftJs content to update.
|
|
2345
|
+
* @maxLength 400000
|
|
2346
|
+
*/
|
|
1935
2347
|
content?: string;
|
|
1936
2348
|
/** Draft post rich content. */
|
|
1937
2349
|
richContent?: RichContent;
|
|
@@ -1955,6 +2367,7 @@ export interface UpdateDraftPostRequest {
|
|
|
1955
2367
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
1956
2368
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
1957
2369
|
* only the draft post's base fields are returned.
|
|
2370
|
+
* @maxSize 10
|
|
1958
2371
|
*/
|
|
1959
2372
|
fieldsets?: Field[];
|
|
1960
2373
|
}
|
|
@@ -1963,7 +2376,10 @@ export interface UpdateDraftPostResponse {
|
|
|
1963
2376
|
draftPost?: DraftPost;
|
|
1964
2377
|
}
|
|
1965
2378
|
export interface DeleteDraftPostRequest {
|
|
1966
|
-
/**
|
|
2379
|
+
/**
|
|
2380
|
+
* Draft post ID.
|
|
2381
|
+
* @maxLength 38
|
|
2382
|
+
*/
|
|
1967
2383
|
draftPostId: string;
|
|
1968
2384
|
/**
|
|
1969
2385
|
* Whether to bypass the trash bin and delete the post permanently.
|
|
@@ -1975,13 +2391,21 @@ export interface DeleteDraftPostRequest {
|
|
|
1975
2391
|
export interface DeleteDraftPostResponse {
|
|
1976
2392
|
}
|
|
1977
2393
|
export interface RemoveFromTrashBinRequest {
|
|
1978
|
-
/**
|
|
2394
|
+
/**
|
|
2395
|
+
* Draft post ID.
|
|
2396
|
+
* @maxLength 38
|
|
2397
|
+
*/
|
|
1979
2398
|
draftPostId: string;
|
|
1980
2399
|
}
|
|
1981
2400
|
export interface RemoveFromTrashBinResponse {
|
|
1982
2401
|
}
|
|
1983
2402
|
export interface BulkDeleteDraftPostsRequest {
|
|
1984
|
-
/**
|
|
2403
|
+
/**
|
|
2404
|
+
* Post IDs.
|
|
2405
|
+
* @minSize 1
|
|
2406
|
+
* @maxSize 100
|
|
2407
|
+
* @maxLength 38
|
|
2408
|
+
*/
|
|
1985
2409
|
postIds: string[];
|
|
1986
2410
|
/** Should delete bypassing the trash-bin. */
|
|
1987
2411
|
permanent?: boolean;
|
|
@@ -2005,6 +2429,7 @@ export interface ListDraftPostsRequest {
|
|
|
2005
2429
|
*
|
|
2006
2430
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2007
2431
|
* If omitted, draft posts in all languages are returned.
|
|
2432
|
+
* @format LANGUAGE_TAG
|
|
2008
2433
|
*/
|
|
2009
2434
|
language?: string | null;
|
|
2010
2435
|
/**
|
|
@@ -2019,6 +2444,7 @@ export interface ListDraftPostsRequest {
|
|
|
2019
2444
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2020
2445
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
2021
2446
|
* only the draft post's base fields are returned.
|
|
2447
|
+
* @maxSize 10
|
|
2022
2448
|
*/
|
|
2023
2449
|
fieldsets?: Field[];
|
|
2024
2450
|
}
|
|
@@ -2029,7 +2455,10 @@ export interface ListDraftPostsResponse {
|
|
|
2029
2455
|
metaData?: MetaData;
|
|
2030
2456
|
}
|
|
2031
2457
|
export interface GetDeletedDraftPostRequest {
|
|
2032
|
-
/**
|
|
2458
|
+
/**
|
|
2459
|
+
* Draft post ID.
|
|
2460
|
+
* @maxLength 38
|
|
2461
|
+
*/
|
|
2033
2462
|
draftPostId: string;
|
|
2034
2463
|
}
|
|
2035
2464
|
export interface GetDeletedDraftPostResponse {
|
|
@@ -2037,7 +2466,10 @@ export interface GetDeletedDraftPostResponse {
|
|
|
2037
2466
|
draftPost?: DraftPost;
|
|
2038
2467
|
}
|
|
2039
2468
|
export interface RestoreFromTrashBinRequest {
|
|
2040
|
-
/**
|
|
2469
|
+
/**
|
|
2470
|
+
* Draft post ID.
|
|
2471
|
+
* @maxLength 38
|
|
2472
|
+
*/
|
|
2041
2473
|
draftPostId: string;
|
|
2042
2474
|
}
|
|
2043
2475
|
export interface RestoreFromTrashBinResponse {
|
|
@@ -2049,13 +2481,17 @@ export interface QueryDraftPostsRequest {
|
|
|
2049
2481
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2050
2482
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
2051
2483
|
* only the draft post's base fields are returned.
|
|
2484
|
+
* @maxSize 10
|
|
2052
2485
|
*/
|
|
2053
2486
|
fieldsets?: Field[];
|
|
2054
2487
|
/** Query options. */
|
|
2055
2488
|
query?: PlatformQuery;
|
|
2056
2489
|
}
|
|
2057
2490
|
export interface Sorting {
|
|
2058
|
-
/**
|
|
2491
|
+
/**
|
|
2492
|
+
* Name of the field to sort by.
|
|
2493
|
+
* @maxLength 512
|
|
2494
|
+
*/
|
|
2059
2495
|
fieldName?: string;
|
|
2060
2496
|
/** Sort order. */
|
|
2061
2497
|
order?: SortOrder;
|
|
@@ -2081,6 +2517,7 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
2081
2517
|
/**
|
|
2082
2518
|
* Sort object in the following format:
|
|
2083
2519
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2520
|
+
* @maxSize 3
|
|
2084
2521
|
*/
|
|
2085
2522
|
sort?: Sorting[];
|
|
2086
2523
|
}
|
|
@@ -2092,13 +2529,19 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
2092
2529
|
cursorPaging?: CursorPaging;
|
|
2093
2530
|
}
|
|
2094
2531
|
export interface Paging {
|
|
2095
|
-
/**
|
|
2532
|
+
/**
|
|
2533
|
+
* Number of items to load.
|
|
2534
|
+
* @max 100
|
|
2535
|
+
*/
|
|
2096
2536
|
limit?: number | null;
|
|
2097
2537
|
/** Number of items to skip in the current sort order. */
|
|
2098
2538
|
offset?: number | null;
|
|
2099
2539
|
}
|
|
2100
2540
|
export interface CursorPaging {
|
|
2101
|
-
/**
|
|
2541
|
+
/**
|
|
2542
|
+
* Number of items to load.
|
|
2543
|
+
* @max 100
|
|
2544
|
+
*/
|
|
2102
2545
|
limit?: number | null;
|
|
2103
2546
|
/**
|
|
2104
2547
|
* Pointer to the next or previous page in the list of results.
|
|
@@ -2106,6 +2549,7 @@ export interface CursorPaging {
|
|
|
2106
2549
|
* You can get the relevant cursor token
|
|
2107
2550
|
* from the `pagingMetadata` object in the previous call's response.
|
|
2108
2551
|
* Not relevant for the first request.
|
|
2552
|
+
* @maxLength 2000
|
|
2109
2553
|
*/
|
|
2110
2554
|
cursor?: string | null;
|
|
2111
2555
|
}
|
|
@@ -2141,167 +2585,50 @@ export interface PagingMetadataV2 {
|
|
|
2141
2585
|
cursors?: Cursors;
|
|
2142
2586
|
}
|
|
2143
2587
|
export interface Cursors {
|
|
2144
|
-
/**
|
|
2588
|
+
/**
|
|
2589
|
+
* Cursor pointing to next page in the list of results.
|
|
2590
|
+
* @maxLength 2000
|
|
2591
|
+
*/
|
|
2145
2592
|
next?: string | null;
|
|
2146
|
-
/**
|
|
2593
|
+
/**
|
|
2594
|
+
* Cursor pointing to previous page in the list of results.
|
|
2595
|
+
* @maxLength 2000
|
|
2596
|
+
*/
|
|
2147
2597
|
prev?: string | null;
|
|
2148
2598
|
}
|
|
2149
2599
|
export interface PublishDraftPostRequest {
|
|
2150
|
-
/**
|
|
2600
|
+
/**
|
|
2601
|
+
* Draft post ID.
|
|
2602
|
+
* @maxLength 38
|
|
2603
|
+
*/
|
|
2151
2604
|
draftPostId: string;
|
|
2152
2605
|
}
|
|
2153
2606
|
export interface PublishDraftPostResponse {
|
|
2154
|
-
/**
|
|
2607
|
+
/**
|
|
2608
|
+
* Published post ID.
|
|
2609
|
+
* @format GUID
|
|
2610
|
+
*/
|
|
2155
2611
|
postId?: string;
|
|
2156
2612
|
}
|
|
2157
2613
|
export interface UnpublishPostRequest {
|
|
2158
|
-
/** Draft post ID. */
|
|
2159
|
-
draftPostId?: string;
|
|
2160
|
-
}
|
|
2161
|
-
export interface UnpublishPostResponse {
|
|
2162
|
-
}
|
|
2163
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2164
|
-
createdEvent?: EntityCreatedEvent;
|
|
2165
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2166
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2167
|
-
actionEvent?: ActionEvent;
|
|
2168
|
-
/**
|
|
2169
|
-
* Unique event ID.
|
|
2170
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2171
|
-
*/
|
|
2172
|
-
_id?: string;
|
|
2173
2614
|
/**
|
|
2174
|
-
*
|
|
2175
|
-
*
|
|
2176
|
-
*/
|
|
2177
|
-
entityFqdn?: string;
|
|
2178
|
-
/**
|
|
2179
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
2180
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2181
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2182
|
-
*/
|
|
2183
|
-
slug?: string;
|
|
2184
|
-
/** ID of the entity associated with the event. */
|
|
2185
|
-
entityId?: string;
|
|
2186
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2187
|
-
eventTime?: Date | null;
|
|
2188
|
-
/**
|
|
2189
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2190
|
-
* (for example, GDPR).
|
|
2191
|
-
*/
|
|
2192
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2193
|
-
/** If present, indicates the action that triggered the event. */
|
|
2194
|
-
originatedFrom?: string | null;
|
|
2195
|
-
/**
|
|
2196
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
2197
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2198
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2199
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2200
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2201
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2615
|
+
* Draft post ID.
|
|
2616
|
+
* @maxLength 38
|
|
2202
2617
|
*/
|
|
2203
|
-
|
|
2204
|
-
}
|
|
2205
|
-
/** @oneof */
|
|
2206
|
-
export interface DomainEventBodyOneOf {
|
|
2207
|
-
createdEvent?: EntityCreatedEvent;
|
|
2208
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2209
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2210
|
-
actionEvent?: ActionEvent;
|
|
2211
|
-
}
|
|
2212
|
-
export interface EntityCreatedEvent {
|
|
2213
|
-
entity?: string;
|
|
2618
|
+
draftPostId?: string;
|
|
2214
2619
|
}
|
|
2215
|
-
export interface
|
|
2216
|
-
deletedDate?: Date | null;
|
|
2620
|
+
export interface UnpublishPostResponse {
|
|
2217
2621
|
}
|
|
2218
|
-
export interface
|
|
2622
|
+
export interface TranslateCategoryRequest {
|
|
2219
2623
|
/**
|
|
2220
|
-
*
|
|
2221
|
-
*
|
|
2222
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2624
|
+
* Source category ID
|
|
2625
|
+
* @format GUID
|
|
2223
2626
|
*/
|
|
2224
|
-
|
|
2225
|
-
}
|
|
2226
|
-
export interface EntityDeletedEvent {
|
|
2227
|
-
/** Entity that was deleted */
|
|
2228
|
-
deletedEntity?: string | null;
|
|
2229
|
-
}
|
|
2230
|
-
export interface ActionEvent {
|
|
2231
|
-
body?: string;
|
|
2232
|
-
}
|
|
2233
|
-
export interface MessageEnvelope {
|
|
2234
|
-
/** App instance ID. */
|
|
2235
|
-
instanceId?: string | null;
|
|
2236
|
-
/** Event type. */
|
|
2237
|
-
eventType?: string;
|
|
2238
|
-
/** The identification type and identity data. */
|
|
2239
|
-
identity?: IdentificationData;
|
|
2240
|
-
/** Stringify payload. */
|
|
2241
|
-
data?: string;
|
|
2242
|
-
}
|
|
2243
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2244
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
2245
|
-
anonymousVisitorId?: string;
|
|
2246
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
2247
|
-
memberId?: string;
|
|
2248
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2249
|
-
wixUserId?: string;
|
|
2250
|
-
/** ID of an app. */
|
|
2251
|
-
appId?: string;
|
|
2252
|
-
/** @readonly */
|
|
2253
|
-
identityType?: WebhookIdentityType;
|
|
2254
|
-
}
|
|
2255
|
-
/** @oneof */
|
|
2256
|
-
export interface IdentificationDataIdOneOf {
|
|
2257
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
2258
|
-
anonymousVisitorId?: string;
|
|
2259
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
2260
|
-
memberId?: string;
|
|
2261
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2262
|
-
wixUserId?: string;
|
|
2263
|
-
/** ID of an app. */
|
|
2264
|
-
appId?: string;
|
|
2265
|
-
}
|
|
2266
|
-
export declare enum WebhookIdentityType {
|
|
2267
|
-
UNKNOWN = "UNKNOWN",
|
|
2268
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2269
|
-
MEMBER = "MEMBER",
|
|
2270
|
-
WIX_USER = "WIX_USER",
|
|
2271
|
-
APP = "APP"
|
|
2272
|
-
}
|
|
2273
|
-
export interface GetDraftPostTotalsRequest {
|
|
2627
|
+
categoryId?: string;
|
|
2274
2628
|
/**
|
|
2275
|
-
*
|
|
2276
|
-
*
|
|
2277
|
-
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
2629
|
+
* Translation language
|
|
2630
|
+
* @format LANGUAGE_TAG
|
|
2278
2631
|
*/
|
|
2279
|
-
groupBy?: TotalDraftPostsGroupingField[];
|
|
2280
|
-
/** Optional language filter by provided language code. Useful in multilingual context. */
|
|
2281
|
-
language?: string | null;
|
|
2282
|
-
}
|
|
2283
|
-
export declare enum TotalDraftPostsGroupingField {
|
|
2284
|
-
/** Groups results by status. */
|
|
2285
|
-
STATUS = "STATUS",
|
|
2286
|
-
/** Groups results by language. */
|
|
2287
|
-
LANGUAGE = "LANGUAGE"
|
|
2288
|
-
}
|
|
2289
|
-
export interface GetDraftPostTotalsResponse {
|
|
2290
|
-
/** Draft post totals. */
|
|
2291
|
-
totalDraftPosts?: TotalDraftPosts[];
|
|
2292
|
-
}
|
|
2293
|
-
export interface TotalDraftPosts {
|
|
2294
|
-
/** Draft post totals in that group. */
|
|
2295
|
-
total?: number;
|
|
2296
|
-
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
2297
|
-
status?: Status;
|
|
2298
|
-
/** Draft post language code (only has value when grouping by language, otherwise null). */
|
|
2299
|
-
language?: string | null;
|
|
2300
|
-
}
|
|
2301
|
-
export interface TranslateCategoryRequest {
|
|
2302
|
-
/** Source category ID */
|
|
2303
|
-
categoryId?: string;
|
|
2304
|
-
/** Translation language */
|
|
2305
2632
|
language?: string;
|
|
2306
2633
|
}
|
|
2307
2634
|
export interface TranslateCategoryResponse {
|
|
@@ -2311,9 +2638,16 @@ export interface TranslateCategoryResponse {
|
|
|
2311
2638
|
translations?: CategoryTranslation[];
|
|
2312
2639
|
}
|
|
2313
2640
|
export interface Category {
|
|
2314
|
-
/**
|
|
2641
|
+
/**
|
|
2642
|
+
* Category ID.
|
|
2643
|
+
* @immutable
|
|
2644
|
+
* @maxLength 38
|
|
2645
|
+
*/
|
|
2315
2646
|
_id?: string;
|
|
2316
|
-
/**
|
|
2647
|
+
/**
|
|
2648
|
+
* Category label. Displayed in the Category Menu.
|
|
2649
|
+
* @maxLength 35
|
|
2650
|
+
*/
|
|
2317
2651
|
label?: string;
|
|
2318
2652
|
/**
|
|
2319
2653
|
* Number of posts in the category.
|
|
@@ -2325,10 +2659,14 @@ export interface Category {
|
|
|
2325
2659
|
* @readonly
|
|
2326
2660
|
*/
|
|
2327
2661
|
url?: string;
|
|
2328
|
-
/**
|
|
2662
|
+
/**
|
|
2663
|
+
* Category description.
|
|
2664
|
+
* @maxLength 500
|
|
2665
|
+
*/
|
|
2329
2666
|
description?: string | null;
|
|
2330
2667
|
/**
|
|
2331
2668
|
* Category title.
|
|
2669
|
+
* @maxLength 200
|
|
2332
2670
|
* @deprecated Category title.
|
|
2333
2671
|
* @targetRemovalDate 2025-07-16
|
|
2334
2672
|
*/
|
|
@@ -2340,19 +2678,27 @@ export interface Category {
|
|
|
2340
2678
|
* Default: `-1`
|
|
2341
2679
|
*/
|
|
2342
2680
|
displayPosition?: number | null;
|
|
2343
|
-
/**
|
|
2681
|
+
/**
|
|
2682
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2683
|
+
* @format GUID
|
|
2684
|
+
*/
|
|
2344
2685
|
translationId?: string | null;
|
|
2345
2686
|
/**
|
|
2346
2687
|
* Category language.
|
|
2347
2688
|
*
|
|
2348
2689
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2690
|
+
* @immutable
|
|
2349
2691
|
*/
|
|
2350
2692
|
language?: string | null;
|
|
2351
|
-
/**
|
|
2693
|
+
/**
|
|
2694
|
+
* 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`.
|
|
2695
|
+
* @maxLength 100
|
|
2696
|
+
*/
|
|
2352
2697
|
slug?: string;
|
|
2353
2698
|
/**
|
|
2354
2699
|
* Reserved for internal use.
|
|
2355
2700
|
* @readonly
|
|
2701
|
+
* @maxLength 24
|
|
2356
2702
|
*/
|
|
2357
2703
|
internalId?: string | null;
|
|
2358
2704
|
/** SEO data. */
|
|
@@ -2366,24 +2712,40 @@ export interface Category {
|
|
|
2366
2712
|
_updatedDate?: Date | null;
|
|
2367
2713
|
}
|
|
2368
2714
|
export interface CategoryTranslation {
|
|
2369
|
-
/**
|
|
2715
|
+
/**
|
|
2716
|
+
* Category ID.
|
|
2717
|
+
* @format GUID
|
|
2718
|
+
*/
|
|
2370
2719
|
_id?: string;
|
|
2371
|
-
/**
|
|
2720
|
+
/**
|
|
2721
|
+
* Label displayed in the categories menu on the site.
|
|
2722
|
+
* @maxLength 100
|
|
2723
|
+
*/
|
|
2372
2724
|
label?: string | null;
|
|
2373
|
-
/**
|
|
2725
|
+
/**
|
|
2726
|
+
* Language of the category.
|
|
2727
|
+
* @format LANGUAGE_TAG
|
|
2728
|
+
*/
|
|
2374
2729
|
language?: string | null;
|
|
2375
2730
|
/** URL of this category page. */
|
|
2376
2731
|
url?: string;
|
|
2377
2732
|
}
|
|
2378
2733
|
export interface TranslateDraftRequest {
|
|
2379
|
-
/**
|
|
2734
|
+
/**
|
|
2735
|
+
* Source post or draft ID
|
|
2736
|
+
* @format GUID
|
|
2737
|
+
*/
|
|
2380
2738
|
postId?: string;
|
|
2381
|
-
/**
|
|
2739
|
+
/**
|
|
2740
|
+
* Translation language
|
|
2741
|
+
* @format LANGUAGE_TAG
|
|
2742
|
+
*/
|
|
2382
2743
|
language?: string;
|
|
2383
2744
|
/**
|
|
2384
2745
|
* List of draft post fields to be included if entities are present in the response.
|
|
2385
2746
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2386
2747
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2748
|
+
* @maxSize 10
|
|
2387
2749
|
*/
|
|
2388
2750
|
fieldsets?: Field[];
|
|
2389
2751
|
}
|
|
@@ -2392,11 +2754,17 @@ export interface TranslateDraftResponse {
|
|
|
2392
2754
|
draftPost?: DraftPost;
|
|
2393
2755
|
}
|
|
2394
2756
|
export interface IsDraftPostAutoTranslatableRequest {
|
|
2395
|
-
/**
|
|
2757
|
+
/**
|
|
2758
|
+
* Source post or draft ID.
|
|
2759
|
+
* @format GUID
|
|
2760
|
+
*/
|
|
2396
2761
|
draftPostId?: string;
|
|
2397
2762
|
}
|
|
2398
2763
|
export interface IsDraftPostAutoTranslatableResponse {
|
|
2399
|
-
/**
|
|
2764
|
+
/**
|
|
2765
|
+
* Source draft post ID.
|
|
2766
|
+
* @format GUID
|
|
2767
|
+
*/
|
|
2400
2768
|
draftPostId?: string;
|
|
2401
2769
|
/** Indicates if enough machine translation credits are available for the draft post translation. */
|
|
2402
2770
|
translatable?: boolean;
|
|
@@ -2412,14 +2780,22 @@ export interface IsDraftPostAutoTranslatableResponse {
|
|
|
2412
2780
|
contentTextCharacterCount?: number;
|
|
2413
2781
|
}
|
|
2414
2782
|
export interface UpdateDraftPostLanguageRequest {
|
|
2415
|
-
/**
|
|
2783
|
+
/**
|
|
2784
|
+
* Source draft post ID
|
|
2785
|
+
* @format GUID
|
|
2786
|
+
*/
|
|
2416
2787
|
postId?: string;
|
|
2417
|
-
/**
|
|
2788
|
+
/**
|
|
2789
|
+
* New language to replace to
|
|
2790
|
+
* @minLength 2
|
|
2791
|
+
* @format LANGUAGE_TAG
|
|
2792
|
+
*/
|
|
2418
2793
|
language?: string;
|
|
2419
2794
|
/**
|
|
2420
2795
|
* List of draft post fields to be included if entities are present in the response.
|
|
2421
2796
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2422
2797
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2798
|
+
* @maxSize 10
|
|
2423
2799
|
*/
|
|
2424
2800
|
fieldsets?: Field[];
|
|
2425
2801
|
}
|
|
@@ -2428,9 +2804,16 @@ export interface UpdateDraftPostLanguageResponse {
|
|
|
2428
2804
|
draftPost?: DraftPost;
|
|
2429
2805
|
}
|
|
2430
2806
|
export interface BulkUpdateDraftPostLanguageRequest {
|
|
2431
|
-
/**
|
|
2807
|
+
/**
|
|
2808
|
+
* Source post or draft IDs
|
|
2809
|
+
* @maxSize 50
|
|
2810
|
+
* @format GUID
|
|
2811
|
+
*/
|
|
2432
2812
|
ids?: string[];
|
|
2433
|
-
/**
|
|
2813
|
+
/**
|
|
2814
|
+
* New language to replace to
|
|
2815
|
+
* @format LANGUAGE_TAG
|
|
2816
|
+
*/
|
|
2434
2817
|
language?: string;
|
|
2435
2818
|
/** Should full draft post be returned */
|
|
2436
2819
|
returnFullEntity?: boolean;
|
|
@@ -2438,6 +2821,7 @@ export interface BulkUpdateDraftPostLanguageRequest {
|
|
|
2438
2821
|
* List of draft post fields to be included if entities are present in the response.
|
|
2439
2822
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2440
2823
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2824
|
+
* @maxSize 10
|
|
2441
2825
|
*/
|
|
2442
2826
|
fieldsets?: Field[];
|
|
2443
2827
|
}
|
|
@@ -2448,7 +2832,10 @@ export interface BulkUpdateDraftPostLanguageResponse {
|
|
|
2448
2832
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2449
2833
|
}
|
|
2450
2834
|
export interface GetPostAmountsByLanguageRequest {
|
|
2451
|
-
/**
|
|
2835
|
+
/**
|
|
2836
|
+
* Post status to filter by
|
|
2837
|
+
* @maxLength 100
|
|
2838
|
+
*/
|
|
2452
2839
|
status?: string;
|
|
2453
2840
|
}
|
|
2454
2841
|
export interface GetPostAmountsByLanguageResponse {
|
|
@@ -2456,15 +2843,26 @@ export interface GetPostAmountsByLanguageResponse {
|
|
|
2456
2843
|
postAmountsByLanguage?: PostAmountByLanguage[];
|
|
2457
2844
|
}
|
|
2458
2845
|
export interface PostAmountByLanguage {
|
|
2459
|
-
/**
|
|
2846
|
+
/**
|
|
2847
|
+
* Post language code
|
|
2848
|
+
* @format LANGUAGE_TAG
|
|
2849
|
+
*/
|
|
2460
2850
|
languageCode?: string;
|
|
2461
|
-
/**
|
|
2851
|
+
/**
|
|
2852
|
+
* Language flag
|
|
2853
|
+
* @format LANGUAGE_TAG
|
|
2854
|
+
*/
|
|
2462
2855
|
flag?: string;
|
|
2463
2856
|
/** Post amount in that language */
|
|
2464
2857
|
postAmount?: number;
|
|
2465
2858
|
}
|
|
2466
2859
|
export interface BulkRevertToUnpublishedRequest {
|
|
2467
|
-
/**
|
|
2860
|
+
/**
|
|
2861
|
+
* Source post IDs.
|
|
2862
|
+
* @minSize 1
|
|
2863
|
+
* @maxSize 100
|
|
2864
|
+
* @format GUID
|
|
2865
|
+
*/
|
|
2468
2866
|
postIds?: string[];
|
|
2469
2867
|
/** Should full draft post be returned. */
|
|
2470
2868
|
returnFullEntity?: boolean;
|
|
@@ -2476,7 +2874,12 @@ export interface BulkRevertToUnpublishedResponse {
|
|
|
2476
2874
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2477
2875
|
}
|
|
2478
2876
|
export interface BulkRejectDraftPostRequest {
|
|
2479
|
-
/**
|
|
2877
|
+
/**
|
|
2878
|
+
* Source post IDs.
|
|
2879
|
+
* @minSize 1
|
|
2880
|
+
* @maxSize 100
|
|
2881
|
+
* @format GUID
|
|
2882
|
+
*/
|
|
2480
2883
|
postIds?: string[];
|
|
2481
2884
|
/** Should full draft post be returned. */
|
|
2482
2885
|
returnFullEntity?: boolean;
|
|
@@ -2488,12 +2891,16 @@ export interface BulkRejectDraftPostResponse {
|
|
|
2488
2891
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2489
2892
|
}
|
|
2490
2893
|
export interface RevertToUnpublishedRequest {
|
|
2491
|
-
/**
|
|
2894
|
+
/**
|
|
2895
|
+
* Source post ID.
|
|
2896
|
+
* @format GUID
|
|
2897
|
+
*/
|
|
2492
2898
|
postId?: string;
|
|
2493
2899
|
/**
|
|
2494
2900
|
* List of draft post fields to be included if entities are present in the response.
|
|
2495
2901
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2496
2902
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2903
|
+
* @maxSize 10
|
|
2497
2904
|
*/
|
|
2498
2905
|
fieldsets?: Field[];
|
|
2499
2906
|
}
|
|
@@ -2502,12 +2909,16 @@ export interface RevertToUnpublishedResponse {
|
|
|
2502
2909
|
draftPost?: DraftPost;
|
|
2503
2910
|
}
|
|
2504
2911
|
export interface RejectDraftPostRequest {
|
|
2505
|
-
/**
|
|
2912
|
+
/**
|
|
2913
|
+
* Source post ID.
|
|
2914
|
+
* @format GUID
|
|
2915
|
+
*/
|
|
2506
2916
|
postId?: string;
|
|
2507
2917
|
/**
|
|
2508
2918
|
* List of draft post fields to be included if entities are present in the response.
|
|
2509
2919
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2510
2920
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2921
|
+
* @maxSize 10
|
|
2511
2922
|
*/
|
|
2512
2923
|
fieldsets?: Field[];
|
|
2513
2924
|
}
|
|
@@ -2516,14 +2927,21 @@ export interface RejectDraftPostResponse {
|
|
|
2516
2927
|
draftPost?: DraftPost;
|
|
2517
2928
|
}
|
|
2518
2929
|
export interface ApproveDraftPostRequest {
|
|
2519
|
-
/**
|
|
2930
|
+
/**
|
|
2931
|
+
* Source post ID.
|
|
2932
|
+
* @format GUID
|
|
2933
|
+
*/
|
|
2520
2934
|
postId?: string;
|
|
2521
|
-
/**
|
|
2935
|
+
/**
|
|
2936
|
+
* Scheduled publish date if should be not immediately published.
|
|
2937
|
+
* @maxLength 24
|
|
2938
|
+
*/
|
|
2522
2939
|
scheduledPublishDate?: string | null;
|
|
2523
2940
|
/**
|
|
2524
2941
|
* List of draft post fields to be included if entities are present in the response.
|
|
2525
2942
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2526
2943
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2944
|
+
* @maxSize 10
|
|
2527
2945
|
*/
|
|
2528
2946
|
fieldsets?: Field[];
|
|
2529
2947
|
}
|
|
@@ -2532,12 +2950,16 @@ export interface ApproveDraftPostResponse {
|
|
|
2532
2950
|
draftPost?: DraftPost;
|
|
2533
2951
|
}
|
|
2534
2952
|
export interface MarkPostAsInModerationRequest {
|
|
2535
|
-
/**
|
|
2953
|
+
/**
|
|
2954
|
+
* Source post ID.
|
|
2955
|
+
* @maxLength 38
|
|
2956
|
+
*/
|
|
2536
2957
|
postId?: string;
|
|
2537
2958
|
/**
|
|
2538
2959
|
* List of draft post fields to be included if entities are present in the response.
|
|
2539
2960
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2540
2961
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2962
|
+
* @maxSize 10
|
|
2541
2963
|
*/
|
|
2542
2964
|
fieldsets?: Field[];
|
|
2543
2965
|
}
|
|
@@ -2634,9 +3056,13 @@ interface ImageDataNonNullableFields {
|
|
|
2634
3056
|
containerData?: PluginContainerDataNonNullableFields;
|
|
2635
3057
|
link?: LinkNonNullableFields;
|
|
2636
3058
|
}
|
|
3059
|
+
interface LinkPreviewDataStylesNonNullableFields {
|
|
3060
|
+
thumbnailPosition: Position;
|
|
3061
|
+
}
|
|
2637
3062
|
interface LinkPreviewDataNonNullableFields {
|
|
2638
3063
|
containerData?: PluginContainerDataNonNullableFields;
|
|
2639
3064
|
link?: LinkNonNullableFields;
|
|
3065
|
+
styles?: LinkPreviewDataStylesNonNullableFields;
|
|
2640
3066
|
}
|
|
2641
3067
|
interface MapSettingsNonNullableFields {
|
|
2642
3068
|
mapType: MapType;
|
|
@@ -2940,9 +3366,15 @@ export interface PublishDraftPostResponseNonNullableFields {
|
|
|
2940
3366
|
postId: string;
|
|
2941
3367
|
}
|
|
2942
3368
|
export interface BaseEventMetadata {
|
|
2943
|
-
/**
|
|
3369
|
+
/**
|
|
3370
|
+
* App instance ID.
|
|
3371
|
+
* @format GUID
|
|
3372
|
+
*/
|
|
2944
3373
|
instanceId?: string | null;
|
|
2945
|
-
/**
|
|
3374
|
+
/**
|
|
3375
|
+
* Event type.
|
|
3376
|
+
* @maxLength 150
|
|
3377
|
+
*/
|
|
2946
3378
|
eventType?: string;
|
|
2947
3379
|
/** The identification type and identity data. */
|
|
2948
3380
|
identity?: IdentificationData;
|
|
@@ -3084,6 +3516,7 @@ export interface CreateDraftPostOptions {
|
|
|
3084
3516
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3085
3517
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3086
3518
|
* only the draft post's base fields are returned.
|
|
3519
|
+
* @maxSize 10
|
|
3087
3520
|
*/
|
|
3088
3521
|
fieldsets?: Field[];
|
|
3089
3522
|
}
|
|
@@ -3110,6 +3543,7 @@ export interface BulkCreateDraftPostsOptions {
|
|
|
3110
3543
|
* List of draft post fields to be included in the response if the entities are present.
|
|
3111
3544
|
* Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
|
|
3112
3545
|
* For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
|
|
3546
|
+
* @maxSize 10
|
|
3113
3547
|
*/
|
|
3114
3548
|
fieldsets?: Field[];
|
|
3115
3549
|
}
|
|
@@ -3127,7 +3561,11 @@ export interface BulkCreateDraftPostsOptions {
|
|
|
3127
3561
|
*/
|
|
3128
3562
|
export declare function bulkUpdateDraftPosts(options?: BulkUpdateDraftPostsOptions): Promise<BulkUpdateDraftPostsResponse & BulkUpdateDraftPostsResponseNonNullableFields>;
|
|
3129
3563
|
export interface BulkUpdateDraftPostsOptions {
|
|
3130
|
-
/**
|
|
3564
|
+
/**
|
|
3565
|
+
* Draft posts to update.
|
|
3566
|
+
* @minSize 1
|
|
3567
|
+
* @maxSize 20
|
|
3568
|
+
*/
|
|
3131
3569
|
draftPosts?: MaskedDraftPosts[];
|
|
3132
3570
|
/**
|
|
3133
3571
|
* Action to perform on the posts.
|
|
@@ -3151,6 +3589,7 @@ export interface BulkUpdateDraftPostsOptions {
|
|
|
3151
3589
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3152
3590
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3153
3591
|
* only the draft post's base fields are returned.
|
|
3592
|
+
* @maxSize 10
|
|
3154
3593
|
*/
|
|
3155
3594
|
fieldsets?: Field[];
|
|
3156
3595
|
}
|
|
@@ -3176,6 +3615,7 @@ export interface ListDeletedDraftPostsOptions {
|
|
|
3176
3615
|
*
|
|
3177
3616
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3178
3617
|
* If omitted, deleted draft posts in all languages are returned.
|
|
3618
|
+
* @format LANGUAGE_TAG
|
|
3179
3619
|
*/
|
|
3180
3620
|
language?: string | null;
|
|
3181
3621
|
/**
|
|
@@ -3190,9 +3630,14 @@ export interface ListDeletedDraftPostsOptions {
|
|
|
3190
3630
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3191
3631
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3192
3632
|
* only the draft post's base fields are returned.
|
|
3633
|
+
* @maxSize 10
|
|
3193
3634
|
*/
|
|
3194
3635
|
fieldsets?: Field[];
|
|
3195
|
-
/**
|
|
3636
|
+
/**
|
|
3637
|
+
* Draft post ids.
|
|
3638
|
+
* @maxSize 100
|
|
3639
|
+
* @format GUID
|
|
3640
|
+
*/
|
|
3196
3641
|
draftPostIds?: string[];
|
|
3197
3642
|
}
|
|
3198
3643
|
/**
|
|
@@ -3215,6 +3660,7 @@ export interface GetDraftPostOptions {
|
|
|
3215
3660
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3216
3661
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3217
3662
|
* only the draft post's base fields are returned.
|
|
3663
|
+
* @maxSize 10
|
|
3218
3664
|
*/
|
|
3219
3665
|
fieldsets?: Field[];
|
|
3220
3666
|
}
|
|
@@ -3237,24 +3683,40 @@ export interface UpdateDraftPost {
|
|
|
3237
3683
|
/**
|
|
3238
3684
|
* Draft post ID.
|
|
3239
3685
|
* @readonly
|
|
3686
|
+
* @maxLength 38
|
|
3240
3687
|
*/
|
|
3241
3688
|
_id?: string;
|
|
3242
|
-
/**
|
|
3689
|
+
/**
|
|
3690
|
+
* Draft post title.
|
|
3691
|
+
* @maxLength 200
|
|
3692
|
+
*/
|
|
3243
3693
|
title?: string;
|
|
3244
3694
|
/**
|
|
3245
3695
|
* Draft post excerpt.
|
|
3246
3696
|
*
|
|
3247
3697
|
* If no excerpt has been manually set, an excerpt is automatically generated from the post's text.
|
|
3248
3698
|
* This can be retrieved using the `GENERATED_EXCERPT` fieldset.
|
|
3699
|
+
* @maxLength 500
|
|
3249
3700
|
*/
|
|
3250
3701
|
excerpt?: string | null;
|
|
3251
3702
|
/** Whether the draft post is marked as featured. */
|
|
3252
3703
|
featured?: boolean | null;
|
|
3253
|
-
/**
|
|
3704
|
+
/**
|
|
3705
|
+
* Category IDs of the draft post.
|
|
3706
|
+
* @maxSize 10
|
|
3707
|
+
* @maxLength 38
|
|
3708
|
+
*/
|
|
3254
3709
|
categoryIds?: string[];
|
|
3255
|
-
/**
|
|
3710
|
+
/**
|
|
3711
|
+
* Draft post owner's member ID.
|
|
3712
|
+
* @format GUID
|
|
3713
|
+
*/
|
|
3256
3714
|
memberId?: string | null;
|
|
3257
|
-
/**
|
|
3715
|
+
/**
|
|
3716
|
+
* Hashtags in the draft post.
|
|
3717
|
+
* @maxSize 100
|
|
3718
|
+
* @maxLength 100
|
|
3719
|
+
*/
|
|
3258
3720
|
hashtags?: string[];
|
|
3259
3721
|
/** Whether commenting on the draft post is enabled. */
|
|
3260
3722
|
commentingEnabled?: boolean | null;
|
|
@@ -3265,23 +3727,37 @@ export interface UpdateDraftPost {
|
|
|
3265
3727
|
minutesToRead?: number;
|
|
3266
3728
|
/** Image placed at the top of the blog page. */
|
|
3267
3729
|
heroImage?: string;
|
|
3268
|
-
/**
|
|
3730
|
+
/**
|
|
3731
|
+
* Tag IDs the draft post is tagged with.
|
|
3732
|
+
* @maxSize 30
|
|
3733
|
+
* @maxLength 38
|
|
3734
|
+
*/
|
|
3269
3735
|
tagIds?: string[];
|
|
3270
|
-
/**
|
|
3736
|
+
/**
|
|
3737
|
+
* IDs of posts related to this draft post.
|
|
3738
|
+
* @maxSize 3
|
|
3739
|
+
* @maxLength 38
|
|
3740
|
+
*/
|
|
3271
3741
|
relatedPostIds?: string[];
|
|
3272
|
-
/**
|
|
3742
|
+
/**
|
|
3743
|
+
* Pricing plan IDs. Only relevant if a post is assigned to a specific pricing plan.
|
|
3744
|
+
* @maxSize 100
|
|
3745
|
+
* @format GUID
|
|
3746
|
+
*/
|
|
3273
3747
|
pricingPlanIds?: string[];
|
|
3274
3748
|
/**
|
|
3275
3749
|
* ID of the draft post's translations.
|
|
3276
3750
|
*
|
|
3277
3751
|
* All translations of a single post share the same `translationId`.
|
|
3278
3752
|
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
3753
|
+
* @format GUID
|
|
3279
3754
|
*/
|
|
3280
3755
|
translationId?: string | null;
|
|
3281
3756
|
/**
|
|
3282
3757
|
* Language the draft post is written in.
|
|
3283
3758
|
*
|
|
3284
3759
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3760
|
+
* @format LANGUAGE_TAG
|
|
3285
3761
|
*/
|
|
3286
3762
|
language?: string | null;
|
|
3287
3763
|
/**
|
|
@@ -3292,9 +3768,13 @@ export interface UpdateDraftPost {
|
|
|
3292
3768
|
/**
|
|
3293
3769
|
* Reserved for internal use.
|
|
3294
3770
|
* @readonly
|
|
3771
|
+
* @maxLength 24
|
|
3295
3772
|
*/
|
|
3296
3773
|
contentId?: string | null;
|
|
3297
|
-
/**
|
|
3774
|
+
/**
|
|
3775
|
+
* Reserved for internal use.
|
|
3776
|
+
* @format GUID
|
|
3777
|
+
*/
|
|
3298
3778
|
editingSessionId?: string | null;
|
|
3299
3779
|
/** Draft post rich content. */
|
|
3300
3780
|
richContent?: RichContent;
|
|
@@ -3308,6 +3788,7 @@ export interface UpdateDraftPost {
|
|
|
3308
3788
|
/**
|
|
3309
3789
|
* Reserved for internal use.
|
|
3310
3790
|
* @readonly
|
|
3791
|
+
* @format GUID
|
|
3311
3792
|
*/
|
|
3312
3793
|
mostRecentContributorId?: string | null;
|
|
3313
3794
|
/**
|
|
@@ -3334,6 +3815,8 @@ export interface UpdateDraftPost {
|
|
|
3334
3815
|
/**
|
|
3335
3816
|
* Reserved for internal use.
|
|
3336
3817
|
* @readonly
|
|
3818
|
+
* @maxSize 5000
|
|
3819
|
+
* @maxLength 100
|
|
3337
3820
|
*/
|
|
3338
3821
|
slugs?: string[];
|
|
3339
3822
|
/**
|
|
@@ -3346,7 +3829,10 @@ export interface UpdateDraftPost {
|
|
|
3346
3829
|
* @readonly
|
|
3347
3830
|
*/
|
|
3348
3831
|
_createdDate?: Date | null;
|
|
3349
|
-
/**
|
|
3832
|
+
/**
|
|
3833
|
+
* SEO slug.
|
|
3834
|
+
* @maxLength 100
|
|
3835
|
+
*/
|
|
3350
3836
|
seoSlug?: string | null;
|
|
3351
3837
|
/** Post cover media. */
|
|
3352
3838
|
media?: Media;
|
|
@@ -3355,6 +3841,7 @@ export interface UpdateDraftPost {
|
|
|
3355
3841
|
/**
|
|
3356
3842
|
* Reserved for internal use.
|
|
3357
3843
|
* @readonly
|
|
3844
|
+
* @maxLength 24
|
|
3358
3845
|
*/
|
|
3359
3846
|
internalId?: string | null;
|
|
3360
3847
|
}
|
|
@@ -3371,6 +3858,7 @@ export interface UpdateDraftPostOptions {
|
|
|
3371
3858
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3372
3859
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3373
3860
|
* only the draft post's base fields are returned.
|
|
3861
|
+
* @maxSize 10
|
|
3374
3862
|
*/
|
|
3375
3863
|
fieldsets?: Field[];
|
|
3376
3864
|
}
|
|
@@ -3458,6 +3946,7 @@ export interface ListDraftPostsOptions {
|
|
|
3458
3946
|
*
|
|
3459
3947
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
3460
3948
|
* If omitted, draft posts in all languages are returned.
|
|
3949
|
+
* @format LANGUAGE_TAG
|
|
3461
3950
|
*/
|
|
3462
3951
|
language?: string | null;
|
|
3463
3952
|
/**
|
|
@@ -3472,6 +3961,7 @@ export interface ListDraftPostsOptions {
|
|
|
3472
3961
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3473
3962
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3474
3963
|
* only the draft post's base fields are returned.
|
|
3964
|
+
* @maxSize 10
|
|
3475
3965
|
*/
|
|
3476
3966
|
fieldsets?: Field[];
|
|
3477
3967
|
}
|
|
@@ -3524,6 +4014,7 @@ export interface QueryDraftPostsOptions {
|
|
|
3524
4014
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
3525
4015
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
3526
4016
|
* only the draft post's base fields are returned.
|
|
4017
|
+
* @maxSize 10
|
|
3527
4018
|
*/
|
|
3528
4019
|
fieldsets?: Field[] | undefined;
|
|
3529
4020
|
}
|