@wix/auto_sdk_blog_draft-posts 1.0.1 → 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 +659 -232
- package/build/cjs/src/blog-v3-draft-draft-posts.types.js +28 -17
- 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 +814 -317
- package/build/cjs/src/blog-v3-draft-draft-posts.universal.js +29 -18
- 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 +659 -232
- package/build/es/src/blog-v3-draft-draft-posts.types.js +27 -16
- 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 +814 -317
- package/build/es/src/blog-v3-draft-draft-posts.universal.js +27 -16
- 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 +659 -232
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.types.js +28 -17
- 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 +814 -317
- package/build/internal/cjs/src/blog-v3-draft-draft-posts.universal.js +29 -18
- 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 +659 -232
- package/build/internal/es/src/blog-v3-draft-draft-posts.types.js +27 -16
- 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 +814 -317
- package/build/internal/es/src/blog-v3-draft-draft-posts.universal.js +27 -16
- 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 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?: Image;
|
|
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](https://dev.wix.com/api/rest/wix-pricing-plans). Only relevant if a post is assigned to a specific pricing plan.
|
|
63
|
+
* @maxSize 100
|
|
64
|
+
* @format GUID
|
|
65
|
+
*/
|
|
38
66
|
pricingPlanIds?: string[];
|
|
39
67
|
/**
|
|
40
68
|
* ID of the draft post's translations.
|
|
41
69
|
*
|
|
42
70
|
* All translations of a single post share the same `translationId`.
|
|
43
71
|
* Available only if the [Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) app is installed.
|
|
72
|
+
* @format GUID
|
|
44
73
|
*/
|
|
45
74
|
translationId?: string | null;
|
|
46
75
|
/**
|
|
47
76
|
* Language the draft post is written in.
|
|
48
77
|
*
|
|
49
78
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
79
|
+
* @format LANGUAGE_TAG
|
|
50
80
|
*/
|
|
51
81
|
language?: string | null;
|
|
52
82
|
/**
|
|
@@ -57,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
|
/**
|
|
65
99
|
* Draft Post rich content.
|
|
@@ -79,6 +113,7 @@ export interface DraftPost {
|
|
|
79
113
|
/**
|
|
80
114
|
* Reserved for internal use.
|
|
81
115
|
* @readonly
|
|
116
|
+
* @format GUID
|
|
82
117
|
*/
|
|
83
118
|
mostRecentContributorId?: string | null;
|
|
84
119
|
/**
|
|
@@ -112,6 +147,8 @@ export interface DraftPost {
|
|
|
112
147
|
/**
|
|
113
148
|
* Reserved for internal use.
|
|
114
149
|
* @readonly
|
|
150
|
+
* @maxSize 5000
|
|
151
|
+
* @maxLength 100
|
|
115
152
|
*/
|
|
116
153
|
slugs?: string[];
|
|
117
154
|
/**
|
|
@@ -124,7 +161,10 @@ export interface DraftPost {
|
|
|
124
161
|
* @readonly
|
|
125
162
|
*/
|
|
126
163
|
createdDate?: Date | null;
|
|
127
|
-
/**
|
|
164
|
+
/**
|
|
165
|
+
* SEO slug.
|
|
166
|
+
* @maxLength 100
|
|
167
|
+
*/
|
|
128
168
|
seoSlug?: string | null;
|
|
129
169
|
/** Post cover media. */
|
|
130
170
|
media?: Media;
|
|
@@ -133,6 +173,7 @@ export interface DraftPost {
|
|
|
133
173
|
/**
|
|
134
174
|
* Reserved for internal use.
|
|
135
175
|
* @readonly
|
|
176
|
+
* @maxLength 24
|
|
136
177
|
*/
|
|
137
178
|
internalId?: string | null;
|
|
138
179
|
}
|
|
@@ -154,7 +195,11 @@ export interface CoverMedia extends CoverMediaMediaOneOf {
|
|
|
154
195
|
displayed?: boolean;
|
|
155
196
|
/** Whether cover media is custom. If `false` the cover image is set to the first media item that appears in the content. */
|
|
156
197
|
custom?: boolean;
|
|
157
|
-
/**
|
|
198
|
+
/**
|
|
199
|
+
* Media alternative text.
|
|
200
|
+
* @minLength 1
|
|
201
|
+
* @maxLength 1000
|
|
202
|
+
*/
|
|
158
203
|
altText?: string | null;
|
|
159
204
|
}
|
|
160
205
|
/** @oneof */
|
|
@@ -883,19 +928,28 @@ export interface GIFData {
|
|
|
883
928
|
height?: number;
|
|
884
929
|
/** Width in pixels. */
|
|
885
930
|
width?: number;
|
|
886
|
-
/** Type of GIF (Sticker or
|
|
931
|
+
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
887
932
|
gifType?: GIFType;
|
|
888
933
|
}
|
|
889
934
|
export interface GIF {
|
|
890
|
-
/**
|
|
935
|
+
/**
|
|
936
|
+
* GIF format URL.
|
|
937
|
+
* @format WEB_URL
|
|
938
|
+
*/
|
|
891
939
|
gif?: string | null;
|
|
892
|
-
/**
|
|
940
|
+
/**
|
|
941
|
+
* MP4 format URL.
|
|
942
|
+
* @format WEB_URL
|
|
943
|
+
*/
|
|
893
944
|
mp4?: string | null;
|
|
894
|
-
/**
|
|
945
|
+
/**
|
|
946
|
+
* Thumbnail URL.
|
|
947
|
+
* @format WEB_URL
|
|
948
|
+
*/
|
|
895
949
|
still?: string | null;
|
|
896
950
|
}
|
|
897
951
|
export declare enum GIFType {
|
|
898
|
-
|
|
952
|
+
NORMAL = "NORMAL",
|
|
899
953
|
STICKER = "STICKER"
|
|
900
954
|
}
|
|
901
955
|
export interface HeadingData {
|
|
@@ -957,6 +1011,25 @@ export interface ImageData {
|
|
|
957
1011
|
caption?: string | null;
|
|
958
1012
|
/** Sets whether the image's download button is disabled. Defaults to `false`. */
|
|
959
1013
|
disableDownload?: boolean | null;
|
|
1014
|
+
/** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
|
|
1015
|
+
decorative?: boolean | null;
|
|
1016
|
+
/** Styling for the image. */
|
|
1017
|
+
styles?: ImageDataStyles;
|
|
1018
|
+
}
|
|
1019
|
+
export interface StylesBorder {
|
|
1020
|
+
/** Border width in pixels. */
|
|
1021
|
+
width?: number | null;
|
|
1022
|
+
/**
|
|
1023
|
+
* Border color as a hexadecimal value.
|
|
1024
|
+
* @format COLOR_HEX
|
|
1025
|
+
*/
|
|
1026
|
+
color?: string | null;
|
|
1027
|
+
/** Border radius in pixels. */
|
|
1028
|
+
radius?: number | null;
|
|
1029
|
+
}
|
|
1030
|
+
export interface ImageDataStyles {
|
|
1031
|
+
/** Border attributes. */
|
|
1032
|
+
border?: StylesBorder;
|
|
960
1033
|
}
|
|
961
1034
|
export interface LinkPreviewData {
|
|
962
1035
|
/** Styling for the link preview's container. */
|
|
@@ -971,6 +1044,51 @@ export interface LinkPreviewData {
|
|
|
971
1044
|
description?: string | null;
|
|
972
1045
|
/** The preview content as HTML. */
|
|
973
1046
|
html?: string | null;
|
|
1047
|
+
/** Styling for the link preview. */
|
|
1048
|
+
styles?: LinkPreviewDataStyles;
|
|
1049
|
+
}
|
|
1050
|
+
export declare enum Position {
|
|
1051
|
+
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
1052
|
+
START = "START",
|
|
1053
|
+
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
1054
|
+
END = "END",
|
|
1055
|
+
/** Thumbnail positioned at the top */
|
|
1056
|
+
TOP = "TOP",
|
|
1057
|
+
/** Thumbnail hidden and not displayed */
|
|
1058
|
+
HIDDEN = "HIDDEN"
|
|
1059
|
+
}
|
|
1060
|
+
export interface LinkPreviewDataStyles {
|
|
1061
|
+
/**
|
|
1062
|
+
* Background color as a hexadecimal value.
|
|
1063
|
+
* @format COLOR_HEX
|
|
1064
|
+
*/
|
|
1065
|
+
backgroundColor?: string | null;
|
|
1066
|
+
/**
|
|
1067
|
+
* Title color as a hexadecimal value.
|
|
1068
|
+
* @format COLOR_HEX
|
|
1069
|
+
*/
|
|
1070
|
+
titleColor?: string | null;
|
|
1071
|
+
/**
|
|
1072
|
+
* Subtitle color as a hexadecimal value.
|
|
1073
|
+
* @format COLOR_HEX
|
|
1074
|
+
*/
|
|
1075
|
+
subtitleColor?: string | null;
|
|
1076
|
+
/**
|
|
1077
|
+
* Link color as a hexadecimal value.
|
|
1078
|
+
* @format COLOR_HEX
|
|
1079
|
+
*/
|
|
1080
|
+
linkColor?: string | null;
|
|
1081
|
+
/** Border width in pixels. */
|
|
1082
|
+
borderWidth?: number | null;
|
|
1083
|
+
/** Border radius in pixels. */
|
|
1084
|
+
borderRadius?: number | null;
|
|
1085
|
+
/**
|
|
1086
|
+
* Border color as a hexadecimal value.
|
|
1087
|
+
* @format COLOR_HEX
|
|
1088
|
+
*/
|
|
1089
|
+
borderColor?: string | null;
|
|
1090
|
+
/** Position of thumbnail. Defaults to `START`. */
|
|
1091
|
+
thumbnailPosition?: Position;
|
|
974
1092
|
}
|
|
975
1093
|
export interface MapData {
|
|
976
1094
|
/** Styling for the map's container. */
|
|
@@ -1103,13 +1221,22 @@ export declare enum BackgroundType {
|
|
|
1103
1221
|
export interface Gradient {
|
|
1104
1222
|
/** The gradient angle in degrees. */
|
|
1105
1223
|
angle?: number | null;
|
|
1106
|
-
/**
|
|
1224
|
+
/**
|
|
1225
|
+
* The start color as a hexademical value.
|
|
1226
|
+
* @format COLOR_HEX
|
|
1227
|
+
*/
|
|
1107
1228
|
startColor?: string | null;
|
|
1108
|
-
/**
|
|
1229
|
+
/**
|
|
1230
|
+
* The end color as a hexademical value.
|
|
1231
|
+
* @format COLOR_HEX
|
|
1232
|
+
*/
|
|
1109
1233
|
lastColor?: string | null;
|
|
1110
1234
|
}
|
|
1111
1235
|
export interface Background extends BackgroundBackgroundOneOf {
|
|
1112
|
-
/**
|
|
1236
|
+
/**
|
|
1237
|
+
* The background color as a hexademical value.
|
|
1238
|
+
* @format COLOR_HEX
|
|
1239
|
+
*/
|
|
1113
1240
|
color?: string | null;
|
|
1114
1241
|
/** An image to use for the background. */
|
|
1115
1242
|
image?: V1Media;
|
|
@@ -1120,7 +1247,10 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
1120
1247
|
}
|
|
1121
1248
|
/** @oneof */
|
|
1122
1249
|
export interface BackgroundBackgroundOneOf {
|
|
1123
|
-
/**
|
|
1250
|
+
/**
|
|
1251
|
+
* The background color as a hexademical value.
|
|
1252
|
+
* @format COLOR_HEX
|
|
1253
|
+
*/
|
|
1124
1254
|
color?: string | null;
|
|
1125
1255
|
/** An image to use for the background. */
|
|
1126
1256
|
image?: V1Media;
|
|
@@ -1432,17 +1562,32 @@ export declare enum VerticalAlignment {
|
|
|
1432
1562
|
export interface CellStyle {
|
|
1433
1563
|
/** Vertical alignment for the cell's text. */
|
|
1434
1564
|
verticalAlignment?: VerticalAlignment;
|
|
1435
|
-
/**
|
|
1565
|
+
/**
|
|
1566
|
+
* Cell background color as a hexadecimal value.
|
|
1567
|
+
* @format COLOR_HEX
|
|
1568
|
+
*/
|
|
1436
1569
|
backgroundColor?: string | null;
|
|
1437
1570
|
}
|
|
1438
1571
|
export interface BorderColors {
|
|
1439
|
-
/**
|
|
1572
|
+
/**
|
|
1573
|
+
* Left border color as a hexadecimal value.
|
|
1574
|
+
* @format COLOR_HEX
|
|
1575
|
+
*/
|
|
1440
1576
|
left?: string | null;
|
|
1441
|
-
/**
|
|
1577
|
+
/**
|
|
1578
|
+
* Right border color as a hexadecimal value.
|
|
1579
|
+
* @format COLOR_HEX
|
|
1580
|
+
*/
|
|
1442
1581
|
right?: string | null;
|
|
1443
|
-
/**
|
|
1582
|
+
/**
|
|
1583
|
+
* Top border color as a hexadecimal value.
|
|
1584
|
+
* @format COLOR_HEX
|
|
1585
|
+
*/
|
|
1444
1586
|
top?: string | null;
|
|
1445
|
-
/**
|
|
1587
|
+
/**
|
|
1588
|
+
* Bottom border color as a hexadecimal value.
|
|
1589
|
+
* @format COLOR_HEX
|
|
1590
|
+
*/
|
|
1446
1591
|
bottom?: string | null;
|
|
1447
1592
|
}
|
|
1448
1593
|
/**
|
|
@@ -1570,13 +1715,19 @@ export declare enum Status {
|
|
|
1570
1715
|
IN_REVIEW = "IN_REVIEW"
|
|
1571
1716
|
}
|
|
1572
1717
|
export interface ModerationDetails {
|
|
1573
|
-
/**
|
|
1718
|
+
/**
|
|
1719
|
+
* Member ID of the person submitting the draft post for review.
|
|
1720
|
+
* @format GUID
|
|
1721
|
+
*/
|
|
1574
1722
|
submittedBy?: string;
|
|
1575
1723
|
/** Date the post was submitted for review. */
|
|
1576
1724
|
submittedDate?: Date | null;
|
|
1577
1725
|
/** Status indicating whether the submission was approved or rejected by the moderator. */
|
|
1578
1726
|
status?: ModerationStatusStatus;
|
|
1579
|
-
/**
|
|
1727
|
+
/**
|
|
1728
|
+
* Member ID of the person who approved or rejected the post.
|
|
1729
|
+
* @format GUID
|
|
1730
|
+
*/
|
|
1580
1731
|
moderatedBy?: string | null;
|
|
1581
1732
|
/** Date the post was approved or rejected. */
|
|
1582
1733
|
moderationDate?: Date | null;
|
|
@@ -1602,7 +1753,10 @@ export interface Keyword {
|
|
|
1602
1753
|
term?: string;
|
|
1603
1754
|
/** Whether the keyword is the main focus keyword. */
|
|
1604
1755
|
isMain?: boolean;
|
|
1605
|
-
/**
|
|
1756
|
+
/**
|
|
1757
|
+
* The source that added the keyword terms to the SEO settings.
|
|
1758
|
+
* @maxLength 1000
|
|
1759
|
+
*/
|
|
1606
1760
|
origin?: string | null;
|
|
1607
1761
|
}
|
|
1608
1762
|
export interface Tag {
|
|
@@ -1635,7 +1789,10 @@ export interface Settings {
|
|
|
1635
1789
|
* Default: `false` (Auto Redirect is enabled.)
|
|
1636
1790
|
*/
|
|
1637
1791
|
preventAutoRedirect?: boolean;
|
|
1638
|
-
/**
|
|
1792
|
+
/**
|
|
1793
|
+
* User-selected keyword terms for a specific page.
|
|
1794
|
+
* @maxSize 5
|
|
1795
|
+
*/
|
|
1639
1796
|
keywords?: Keyword[];
|
|
1640
1797
|
}
|
|
1641
1798
|
export interface PageUrl {
|
|
@@ -1653,7 +1810,11 @@ export interface Media extends MediaMediaOneOf {
|
|
|
1653
1810
|
displayed?: boolean;
|
|
1654
1811
|
/** Whether custom cover media has been specified. If `false`, the first media item in the post's content serves as cover media. */
|
|
1655
1812
|
custom?: boolean;
|
|
1656
|
-
/**
|
|
1813
|
+
/**
|
|
1814
|
+
* Media alternative text.
|
|
1815
|
+
* @minLength 1
|
|
1816
|
+
* @maxLength 1000
|
|
1817
|
+
*/
|
|
1657
1818
|
altText?: string | null;
|
|
1658
1819
|
}
|
|
1659
1820
|
/** @oneof */
|
|
@@ -1675,6 +1836,7 @@ export interface VideoV2 {
|
|
|
1675
1836
|
/**
|
|
1676
1837
|
* Available resolutions for the video, starting with the optimal resolution.
|
|
1677
1838
|
* @readonly
|
|
1839
|
+
* @maxSize 100
|
|
1678
1840
|
*/
|
|
1679
1841
|
resolutions?: VideoResolution[];
|
|
1680
1842
|
/**
|
|
@@ -1700,7 +1862,10 @@ export interface EmbedMedia {
|
|
|
1700
1862
|
video?: EmbedVideo;
|
|
1701
1863
|
}
|
|
1702
1864
|
export interface EmbedThumbnail {
|
|
1703
|
-
/**
|
|
1865
|
+
/**
|
|
1866
|
+
* Thumbnail url.
|
|
1867
|
+
* @maxLength 2000
|
|
1868
|
+
*/
|
|
1704
1869
|
url?: string;
|
|
1705
1870
|
/** Thumbnail width. */
|
|
1706
1871
|
width?: number;
|
|
@@ -1708,7 +1873,10 @@ export interface EmbedThumbnail {
|
|
|
1708
1873
|
height?: number;
|
|
1709
1874
|
}
|
|
1710
1875
|
export interface EmbedVideo {
|
|
1711
|
-
/**
|
|
1876
|
+
/**
|
|
1877
|
+
* Video url.
|
|
1878
|
+
* @maxLength 2000
|
|
1879
|
+
*/
|
|
1712
1880
|
url?: string;
|
|
1713
1881
|
/** Video width. */
|
|
1714
1882
|
width?: number;
|
|
@@ -1716,39 +1884,247 @@ export interface EmbedVideo {
|
|
|
1716
1884
|
height?: number;
|
|
1717
1885
|
}
|
|
1718
1886
|
export interface DraftPostTranslation {
|
|
1719
|
-
/**
|
|
1887
|
+
/**
|
|
1888
|
+
* Post ID.
|
|
1889
|
+
* @format GUID
|
|
1890
|
+
*/
|
|
1720
1891
|
id?: string;
|
|
1721
1892
|
/** Post status. */
|
|
1722
1893
|
status?: Status;
|
|
1723
|
-
/**
|
|
1894
|
+
/**
|
|
1895
|
+
* Language the post is written in.
|
|
1896
|
+
* @format LANGUAGE_TAG
|
|
1897
|
+
*/
|
|
1724
1898
|
language?: string | null;
|
|
1725
|
-
/**
|
|
1899
|
+
/**
|
|
1900
|
+
* Post slug. For example, 'post-slug'.
|
|
1901
|
+
* @maxLength 100
|
|
1902
|
+
*/
|
|
1726
1903
|
slug?: string | null;
|
|
1727
1904
|
/** SEO data. */
|
|
1728
1905
|
seoData?: SeoSchema;
|
|
1729
1906
|
/** Post URL. */
|
|
1730
1907
|
url?: PageUrl;
|
|
1731
1908
|
}
|
|
1732
|
-
export interface InitialDraftPostsCopied {
|
|
1733
|
-
/** Number of draft posts copied. */
|
|
1734
|
-
count?: number;
|
|
1735
|
-
}
|
|
1736
1909
|
export interface DraftCategoriesUpdated {
|
|
1737
|
-
/**
|
|
1910
|
+
/**
|
|
1911
|
+
* Draft post ID.
|
|
1912
|
+
* @maxLength 38
|
|
1913
|
+
*/
|
|
1738
1914
|
draftPostId?: string;
|
|
1739
|
-
/**
|
|
1915
|
+
/**
|
|
1916
|
+
* Current categories of the draft.
|
|
1917
|
+
* @maxSize 10
|
|
1918
|
+
* @format GUID
|
|
1919
|
+
*/
|
|
1740
1920
|
categories?: string[];
|
|
1741
|
-
/**
|
|
1921
|
+
/**
|
|
1922
|
+
* Previous categories of the draft.
|
|
1923
|
+
* @maxSize 10
|
|
1924
|
+
* @format GUID
|
|
1925
|
+
*/
|
|
1742
1926
|
previousCategories?: string[];
|
|
1743
1927
|
}
|
|
1744
1928
|
export interface DraftTagsUpdated {
|
|
1745
|
-
/**
|
|
1929
|
+
/**
|
|
1930
|
+
* Draft post ID.
|
|
1931
|
+
* @maxLength 38
|
|
1932
|
+
*/
|
|
1746
1933
|
draftPostId?: string;
|
|
1747
|
-
/**
|
|
1934
|
+
/**
|
|
1935
|
+
* Current tags of the draft.
|
|
1936
|
+
* @maxSize 30
|
|
1937
|
+
* @format GUID
|
|
1938
|
+
*/
|
|
1748
1939
|
tags?: string[];
|
|
1749
|
-
/**
|
|
1940
|
+
/**
|
|
1941
|
+
* Previous tags of the draft.
|
|
1942
|
+
* @maxSize 30
|
|
1943
|
+
* @format GUID
|
|
1944
|
+
*/
|
|
1750
1945
|
previousTags?: string[];
|
|
1751
1946
|
}
|
|
1947
|
+
export interface GetDraftPostTotalsRequest {
|
|
1948
|
+
/**
|
|
1949
|
+
* Group results by fields (defaults to grouping by status).
|
|
1950
|
+
* If, for example, grouping by language is passed, language values in response will be filled.
|
|
1951
|
+
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
1952
|
+
* @maxSize 10
|
|
1953
|
+
*/
|
|
1954
|
+
groupBy?: TotalDraftPostsGroupingField[];
|
|
1955
|
+
/**
|
|
1956
|
+
* Optional language filter by provided language code. Useful in multilingual context.
|
|
1957
|
+
* @format LANGUAGE_TAG
|
|
1958
|
+
*/
|
|
1959
|
+
language?: string | null;
|
|
1960
|
+
}
|
|
1961
|
+
export declare enum TotalDraftPostsGroupingField {
|
|
1962
|
+
/** Groups results by status. */
|
|
1963
|
+
STATUS = "STATUS",
|
|
1964
|
+
/** Groups results by language. */
|
|
1965
|
+
LANGUAGE = "LANGUAGE"
|
|
1966
|
+
}
|
|
1967
|
+
export interface GetDraftPostTotalsResponse {
|
|
1968
|
+
/** Draft post totals. */
|
|
1969
|
+
totalDraftPosts?: TotalDraftPosts[];
|
|
1970
|
+
}
|
|
1971
|
+
export interface TotalDraftPosts {
|
|
1972
|
+
/** Draft post totals in that group. */
|
|
1973
|
+
total?: number;
|
|
1974
|
+
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
1975
|
+
status?: Status;
|
|
1976
|
+
/**
|
|
1977
|
+
* Draft post language code (only has value when grouping by language, otherwise null).
|
|
1978
|
+
* @format LANGUAGE_TAG
|
|
1979
|
+
*/
|
|
1980
|
+
language?: string | null;
|
|
1981
|
+
}
|
|
1982
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1983
|
+
createdEvent?: EntityCreatedEvent;
|
|
1984
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1985
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1986
|
+
actionEvent?: ActionEvent;
|
|
1987
|
+
/**
|
|
1988
|
+
* Unique event ID.
|
|
1989
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1990
|
+
*/
|
|
1991
|
+
id?: string;
|
|
1992
|
+
/**
|
|
1993
|
+
* Assumes actions are also always typed to an entity_type
|
|
1994
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1995
|
+
*/
|
|
1996
|
+
entityFqdn?: string;
|
|
1997
|
+
/**
|
|
1998
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1999
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
2000
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
2001
|
+
*/
|
|
2002
|
+
slug?: string;
|
|
2003
|
+
/** ID of the entity associated with the event. */
|
|
2004
|
+
entityId?: string;
|
|
2005
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2006
|
+
eventTime?: Date | null;
|
|
2007
|
+
/**
|
|
2008
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
2009
|
+
* (for example, GDPR).
|
|
2010
|
+
*/
|
|
2011
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
2012
|
+
/** If present, indicates the action that triggered the event. */
|
|
2013
|
+
originatedFrom?: string | null;
|
|
2014
|
+
/**
|
|
2015
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
2016
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2017
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2018
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2019
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2020
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2021
|
+
*/
|
|
2022
|
+
entityEventSequence?: string | null;
|
|
2023
|
+
}
|
|
2024
|
+
/** @oneof */
|
|
2025
|
+
export interface DomainEventBodyOneOf {
|
|
2026
|
+
createdEvent?: EntityCreatedEvent;
|
|
2027
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
2028
|
+
deletedEvent?: EntityDeletedEvent;
|
|
2029
|
+
actionEvent?: ActionEvent;
|
|
2030
|
+
}
|
|
2031
|
+
export interface EntityCreatedEvent {
|
|
2032
|
+
entityAsJson?: string;
|
|
2033
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2034
|
+
restoreInfo?: RestoreInfo;
|
|
2035
|
+
}
|
|
2036
|
+
export interface RestoreInfo {
|
|
2037
|
+
deletedDate?: Date | null;
|
|
2038
|
+
}
|
|
2039
|
+
export interface EntityUpdatedEvent {
|
|
2040
|
+
/**
|
|
2041
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
2042
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
2043
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2044
|
+
*/
|
|
2045
|
+
currentEntityAsJson?: string;
|
|
2046
|
+
}
|
|
2047
|
+
export interface EntityDeletedEvent {
|
|
2048
|
+
/** Entity that was deleted */
|
|
2049
|
+
deletedEntityAsJson?: string | null;
|
|
2050
|
+
}
|
|
2051
|
+
export interface ActionEvent {
|
|
2052
|
+
bodyAsJson?: string;
|
|
2053
|
+
}
|
|
2054
|
+
export interface MessageEnvelope {
|
|
2055
|
+
/**
|
|
2056
|
+
* App instance ID.
|
|
2057
|
+
* @format GUID
|
|
2058
|
+
*/
|
|
2059
|
+
instanceId?: string | null;
|
|
2060
|
+
/**
|
|
2061
|
+
* Event type.
|
|
2062
|
+
* @maxLength 150
|
|
2063
|
+
*/
|
|
2064
|
+
eventType?: string;
|
|
2065
|
+
/** The identification type and identity data. */
|
|
2066
|
+
identity?: IdentificationData;
|
|
2067
|
+
/** Stringify payload. */
|
|
2068
|
+
data?: string;
|
|
2069
|
+
}
|
|
2070
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2071
|
+
/**
|
|
2072
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2073
|
+
* @format GUID
|
|
2074
|
+
*/
|
|
2075
|
+
anonymousVisitorId?: string;
|
|
2076
|
+
/**
|
|
2077
|
+
* ID of a site visitor that has logged in to the site.
|
|
2078
|
+
* @format GUID
|
|
2079
|
+
*/
|
|
2080
|
+
memberId?: string;
|
|
2081
|
+
/**
|
|
2082
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2083
|
+
* @format GUID
|
|
2084
|
+
*/
|
|
2085
|
+
wixUserId?: string;
|
|
2086
|
+
/**
|
|
2087
|
+
* ID of an app.
|
|
2088
|
+
* @format GUID
|
|
2089
|
+
*/
|
|
2090
|
+
appId?: string;
|
|
2091
|
+
/** @readonly */
|
|
2092
|
+
identityType?: WebhookIdentityType;
|
|
2093
|
+
}
|
|
2094
|
+
/** @oneof */
|
|
2095
|
+
export interface IdentificationDataIdOneOf {
|
|
2096
|
+
/**
|
|
2097
|
+
* ID of a site visitor that has not logged in to the site.
|
|
2098
|
+
* @format GUID
|
|
2099
|
+
*/
|
|
2100
|
+
anonymousVisitorId?: string;
|
|
2101
|
+
/**
|
|
2102
|
+
* ID of a site visitor that has logged in to the site.
|
|
2103
|
+
* @format GUID
|
|
2104
|
+
*/
|
|
2105
|
+
memberId?: string;
|
|
2106
|
+
/**
|
|
2107
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
2108
|
+
* @format GUID
|
|
2109
|
+
*/
|
|
2110
|
+
wixUserId?: string;
|
|
2111
|
+
/**
|
|
2112
|
+
* ID of an app.
|
|
2113
|
+
* @format GUID
|
|
2114
|
+
*/
|
|
2115
|
+
appId?: string;
|
|
2116
|
+
}
|
|
2117
|
+
export declare enum WebhookIdentityType {
|
|
2118
|
+
UNKNOWN = "UNKNOWN",
|
|
2119
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2120
|
+
MEMBER = "MEMBER",
|
|
2121
|
+
WIX_USER = "WIX_USER",
|
|
2122
|
+
APP = "APP"
|
|
2123
|
+
}
|
|
2124
|
+
export interface InitialDraftPostsCopied {
|
|
2125
|
+
/** Number of draft posts copied. */
|
|
2126
|
+
count?: number;
|
|
2127
|
+
}
|
|
1752
2128
|
export interface CreateDraftPostRequest {
|
|
1753
2129
|
/** Draft post to create. */
|
|
1754
2130
|
draftPost: DraftPost;
|
|
@@ -1762,6 +2138,7 @@ export interface CreateDraftPostRequest {
|
|
|
1762
2138
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
1763
2139
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
1764
2140
|
* only the draft post's base fields are returned.
|
|
2141
|
+
* @maxSize 10
|
|
1765
2142
|
*/
|
|
1766
2143
|
fieldsets?: Field[];
|
|
1767
2144
|
}
|
|
@@ -1800,7 +2177,11 @@ export interface CreateDraftPostResponse {
|
|
|
1800
2177
|
draftPost?: DraftPost;
|
|
1801
2178
|
}
|
|
1802
2179
|
export interface BulkCreateDraftPostsRequest {
|
|
1803
|
-
/**
|
|
2180
|
+
/**
|
|
2181
|
+
* Draft posts to create.
|
|
2182
|
+
* @minSize 1
|
|
2183
|
+
* @maxSize 20
|
|
2184
|
+
*/
|
|
1804
2185
|
draftPosts: DraftPost[];
|
|
1805
2186
|
/** Whether the draft post should be published after creation. */
|
|
1806
2187
|
publish?: boolean;
|
|
@@ -1810,6 +2191,7 @@ export interface BulkCreateDraftPostsRequest {
|
|
|
1810
2191
|
* List of draft post fields to be included in the response if the entities are present.
|
|
1811
2192
|
* Base default fieldset returns all core draft post properties (all properties that are not a supported fieldset value).
|
|
1812
2193
|
* For example, when `URL` fieldset is selected, returned draft post will include the set of base properties and the draft post's preview url.
|
|
2194
|
+
* @maxSize 10
|
|
1813
2195
|
*/
|
|
1814
2196
|
fieldsets?: Field[];
|
|
1815
2197
|
}
|
|
@@ -1852,7 +2234,11 @@ export interface BulkActionMetadata {
|
|
|
1852
2234
|
undetailedFailures?: number;
|
|
1853
2235
|
}
|
|
1854
2236
|
export interface BulkUpdateDraftPostsRequest {
|
|
1855
|
-
/**
|
|
2237
|
+
/**
|
|
2238
|
+
* Draft posts to update.
|
|
2239
|
+
* @minSize 1
|
|
2240
|
+
* @maxSize 20
|
|
2241
|
+
*/
|
|
1856
2242
|
draftPosts?: MaskedDraftPosts[];
|
|
1857
2243
|
/**
|
|
1858
2244
|
* Action to perform on the posts.
|
|
@@ -1868,6 +2254,7 @@ export interface BulkUpdateDraftPostsRequest {
|
|
|
1868
2254
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
1869
2255
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
1870
2256
|
* only the draft post's base fields are returned.
|
|
2257
|
+
* @maxSize 10
|
|
1871
2258
|
*/
|
|
1872
2259
|
fieldsets?: Field[];
|
|
1873
2260
|
}
|
|
@@ -1907,6 +2294,7 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
1907
2294
|
*
|
|
1908
2295
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
1909
2296
|
* If omitted, deleted draft posts in all languages are returned.
|
|
2297
|
+
* @format LANGUAGE_TAG
|
|
1910
2298
|
*/
|
|
1911
2299
|
language?: string | null;
|
|
1912
2300
|
/**
|
|
@@ -1921,9 +2309,14 @@ export interface ListDeletedDraftPostsRequest {
|
|
|
1921
2309
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
1922
2310
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
1923
2311
|
* only the draft post's base fields are returned.
|
|
2312
|
+
* @maxSize 10
|
|
1924
2313
|
*/
|
|
1925
2314
|
fieldsets?: Field[];
|
|
1926
|
-
/**
|
|
2315
|
+
/**
|
|
2316
|
+
* Draft post ids.
|
|
2317
|
+
* @maxSize 100
|
|
2318
|
+
* @format GUID
|
|
2319
|
+
*/
|
|
1927
2320
|
draftPostIds?: string[];
|
|
1928
2321
|
}
|
|
1929
2322
|
export declare enum GetDraftPostsSort {
|
|
@@ -1945,9 +2338,14 @@ export interface BlogPaging {
|
|
|
1945
2338
|
*
|
|
1946
2339
|
*
|
|
1947
2340
|
* Default:`50`
|
|
2341
|
+
* @min 1
|
|
2342
|
+
* @max 100
|
|
1948
2343
|
*/
|
|
1949
2344
|
limit?: number;
|
|
1950
|
-
/**
|
|
2345
|
+
/**
|
|
2346
|
+
* Pointer to the next or previous page in the list of results.
|
|
2347
|
+
* @maxLength 2000
|
|
2348
|
+
*/
|
|
1951
2349
|
cursor?: string | null;
|
|
1952
2350
|
}
|
|
1953
2351
|
export interface ListDeletedDraftPostsResponse {
|
|
@@ -1963,16 +2361,23 @@ export interface MetaData {
|
|
|
1963
2361
|
offset?: number;
|
|
1964
2362
|
/** Total number of items that match the query. */
|
|
1965
2363
|
total?: number;
|
|
1966
|
-
/**
|
|
2364
|
+
/**
|
|
2365
|
+
* Pointer to the next or previous page in the list of results.
|
|
2366
|
+
* @maxLength 2000
|
|
2367
|
+
*/
|
|
1967
2368
|
cursor?: string | null;
|
|
1968
2369
|
}
|
|
1969
2370
|
export interface GetDraftPostRequest {
|
|
1970
|
-
/**
|
|
2371
|
+
/**
|
|
2372
|
+
* Draft post ID.
|
|
2373
|
+
* @maxLength 38
|
|
2374
|
+
*/
|
|
1971
2375
|
draftPostId: string;
|
|
1972
2376
|
/**
|
|
1973
2377
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
1974
2378
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
1975
2379
|
* only the draft post's base fields are returned.
|
|
2380
|
+
* @maxSize 10
|
|
1976
2381
|
*/
|
|
1977
2382
|
fieldsets?: Field[];
|
|
1978
2383
|
}
|
|
@@ -1981,11 +2386,17 @@ export interface GetDraftPostResponse {
|
|
|
1981
2386
|
draftPost?: DraftPost;
|
|
1982
2387
|
}
|
|
1983
2388
|
export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentRequestDraftContentOneOf {
|
|
1984
|
-
/**
|
|
2389
|
+
/**
|
|
2390
|
+
* DraftJs content to update.
|
|
2391
|
+
* @maxLength 400000
|
|
2392
|
+
*/
|
|
1985
2393
|
content?: string;
|
|
1986
2394
|
/** Draft Post rich content. */
|
|
1987
2395
|
richContent?: RichContent;
|
|
1988
|
-
/**
|
|
2396
|
+
/**
|
|
2397
|
+
* Draft post ID.
|
|
2398
|
+
* @maxLength 38
|
|
2399
|
+
*/
|
|
1989
2400
|
draftPostId?: string;
|
|
1990
2401
|
/** Change origin. */
|
|
1991
2402
|
changeOrigin?: Origin;
|
|
@@ -1993,12 +2404,16 @@ export interface UpdateDraftPostContentRequest extends UpdateDraftPostContentReq
|
|
|
1993
2404
|
* List of draft post fields to be included if entities are present in the response.
|
|
1994
2405
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
1995
2406
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2407
|
+
* @maxSize 10
|
|
1996
2408
|
*/
|
|
1997
2409
|
fieldsets?: Field[];
|
|
1998
2410
|
}
|
|
1999
2411
|
/** @oneof */
|
|
2000
2412
|
export interface UpdateDraftPostContentRequestDraftContentOneOf {
|
|
2001
|
-
/**
|
|
2413
|
+
/**
|
|
2414
|
+
* DraftJs content to update.
|
|
2415
|
+
* @maxLength 400000
|
|
2416
|
+
*/
|
|
2002
2417
|
content?: string;
|
|
2003
2418
|
/** Draft Post rich content. */
|
|
2004
2419
|
richContent?: RichContent;
|
|
@@ -2022,6 +2437,7 @@ export interface UpdateDraftPostRequest {
|
|
|
2022
2437
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2023
2438
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
2024
2439
|
* only the draft post's base fields are returned.
|
|
2440
|
+
* @maxSize 10
|
|
2025
2441
|
*/
|
|
2026
2442
|
fieldsets?: Field[];
|
|
2027
2443
|
}
|
|
@@ -2030,7 +2446,10 @@ export interface UpdateDraftPostResponse {
|
|
|
2030
2446
|
draftPost?: DraftPost;
|
|
2031
2447
|
}
|
|
2032
2448
|
export interface DeleteDraftPostRequest {
|
|
2033
|
-
/**
|
|
2449
|
+
/**
|
|
2450
|
+
* Draft post ID.
|
|
2451
|
+
* @maxLength 38
|
|
2452
|
+
*/
|
|
2034
2453
|
draftPostId: string;
|
|
2035
2454
|
/**
|
|
2036
2455
|
* Whether to bypass the trash bin and delete the post permanently.
|
|
@@ -2042,13 +2461,21 @@ export interface DeleteDraftPostRequest {
|
|
|
2042
2461
|
export interface DeleteDraftPostResponse {
|
|
2043
2462
|
}
|
|
2044
2463
|
export interface RemoveFromTrashBinRequest {
|
|
2045
|
-
/**
|
|
2464
|
+
/**
|
|
2465
|
+
* Draft post ID.
|
|
2466
|
+
* @maxLength 38
|
|
2467
|
+
*/
|
|
2046
2468
|
draftPostId: string;
|
|
2047
2469
|
}
|
|
2048
2470
|
export interface RemoveFromTrashBinResponse {
|
|
2049
2471
|
}
|
|
2050
2472
|
export interface BulkDeleteDraftPostsRequest {
|
|
2051
|
-
/**
|
|
2473
|
+
/**
|
|
2474
|
+
* Post IDs.
|
|
2475
|
+
* @minSize 1
|
|
2476
|
+
* @maxSize 100
|
|
2477
|
+
* @maxLength 38
|
|
2478
|
+
*/
|
|
2052
2479
|
postIds: string[];
|
|
2053
2480
|
/** Should delete bypassing the trash-bin. */
|
|
2054
2481
|
permanent?: boolean;
|
|
@@ -2072,6 +2499,7 @@ export interface ListDraftPostsRequest {
|
|
|
2072
2499
|
*
|
|
2073
2500
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2074
2501
|
* If omitted, draft posts in all languages are returned.
|
|
2502
|
+
* @format LANGUAGE_TAG
|
|
2075
2503
|
*/
|
|
2076
2504
|
language?: string | null;
|
|
2077
2505
|
/**
|
|
@@ -2086,6 +2514,7 @@ export interface ListDraftPostsRequest {
|
|
|
2086
2514
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2087
2515
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
2088
2516
|
* only the draft post's base fields are returned.
|
|
2517
|
+
* @maxSize 10
|
|
2089
2518
|
*/
|
|
2090
2519
|
fieldsets?: Field[];
|
|
2091
2520
|
}
|
|
@@ -2096,7 +2525,10 @@ export interface ListDraftPostsResponse {
|
|
|
2096
2525
|
metaData?: MetaData;
|
|
2097
2526
|
}
|
|
2098
2527
|
export interface GetDeletedDraftPostRequest {
|
|
2099
|
-
/**
|
|
2528
|
+
/**
|
|
2529
|
+
* Draft post ID.
|
|
2530
|
+
* @maxLength 38
|
|
2531
|
+
*/
|
|
2100
2532
|
draftPostId: string;
|
|
2101
2533
|
}
|
|
2102
2534
|
export interface GetDeletedDraftPostResponse {
|
|
@@ -2104,7 +2536,10 @@ export interface GetDeletedDraftPostResponse {
|
|
|
2104
2536
|
draftPost?: DraftPost;
|
|
2105
2537
|
}
|
|
2106
2538
|
export interface RestoreFromTrashBinRequest {
|
|
2107
|
-
/**
|
|
2539
|
+
/**
|
|
2540
|
+
* Draft post ID.
|
|
2541
|
+
* @maxLength 38
|
|
2542
|
+
*/
|
|
2108
2543
|
draftPostId: string;
|
|
2109
2544
|
}
|
|
2110
2545
|
export interface RestoreFromTrashBinResponse {
|
|
@@ -2116,13 +2551,17 @@ export interface QueryDraftPostsRequest {
|
|
|
2116
2551
|
* List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
|
|
2117
2552
|
* the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
|
|
2118
2553
|
* only the draft post's base fields are returned.
|
|
2554
|
+
* @maxSize 10
|
|
2119
2555
|
*/
|
|
2120
2556
|
fieldsets?: Field[];
|
|
2121
2557
|
/** Query options. */
|
|
2122
2558
|
query?: PlatformQuery;
|
|
2123
2559
|
}
|
|
2124
2560
|
export interface Sorting {
|
|
2125
|
-
/**
|
|
2561
|
+
/**
|
|
2562
|
+
* Name of the field to sort by.
|
|
2563
|
+
* @maxLength 512
|
|
2564
|
+
*/
|
|
2126
2565
|
fieldName?: string;
|
|
2127
2566
|
/** Sort order. */
|
|
2128
2567
|
order?: SortOrder;
|
|
@@ -2148,6 +2587,7 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
|
|
|
2148
2587
|
/**
|
|
2149
2588
|
* Sort object in the following format:
|
|
2150
2589
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
2590
|
+
* @maxSize 3
|
|
2151
2591
|
*/
|
|
2152
2592
|
sort?: Sorting[];
|
|
2153
2593
|
}
|
|
@@ -2159,13 +2599,19 @@ export interface PlatformQueryPagingMethodOneOf {
|
|
|
2159
2599
|
cursorPaging?: CursorPaging;
|
|
2160
2600
|
}
|
|
2161
2601
|
export interface Paging {
|
|
2162
|
-
/**
|
|
2602
|
+
/**
|
|
2603
|
+
* Number of items to load.
|
|
2604
|
+
* @max 100
|
|
2605
|
+
*/
|
|
2163
2606
|
limit?: number | null;
|
|
2164
2607
|
/** Number of items to skip in the current sort order. */
|
|
2165
2608
|
offset?: number | null;
|
|
2166
2609
|
}
|
|
2167
2610
|
export interface CursorPaging {
|
|
2168
|
-
/**
|
|
2611
|
+
/**
|
|
2612
|
+
* Number of items to load.
|
|
2613
|
+
* @max 100
|
|
2614
|
+
*/
|
|
2169
2615
|
limit?: number | null;
|
|
2170
2616
|
/**
|
|
2171
2617
|
* Pointer to the next or previous page in the list of results.
|
|
@@ -2173,6 +2619,7 @@ export interface CursorPaging {
|
|
|
2173
2619
|
* You can get the relevant cursor token
|
|
2174
2620
|
* from the `pagingMetadata` object in the previous call's response.
|
|
2175
2621
|
* Not relevant for the first request.
|
|
2622
|
+
* @maxLength 2000
|
|
2176
2623
|
*/
|
|
2177
2624
|
cursor?: string | null;
|
|
2178
2625
|
}
|
|
@@ -2208,169 +2655,50 @@ export interface PagingMetadataV2 {
|
|
|
2208
2655
|
cursors?: Cursors;
|
|
2209
2656
|
}
|
|
2210
2657
|
export interface Cursors {
|
|
2211
|
-
/**
|
|
2658
|
+
/**
|
|
2659
|
+
* Cursor pointing to next page in the list of results.
|
|
2660
|
+
* @maxLength 2000
|
|
2661
|
+
*/
|
|
2212
2662
|
next?: string | null;
|
|
2213
|
-
/**
|
|
2663
|
+
/**
|
|
2664
|
+
* Cursor pointing to previous page in the list of results.
|
|
2665
|
+
* @maxLength 2000
|
|
2666
|
+
*/
|
|
2214
2667
|
prev?: string | null;
|
|
2215
2668
|
}
|
|
2216
2669
|
export interface PublishDraftPostRequest {
|
|
2217
|
-
/**
|
|
2670
|
+
/**
|
|
2671
|
+
* Draft post ID.
|
|
2672
|
+
* @maxLength 38
|
|
2673
|
+
*/
|
|
2218
2674
|
draftPostId: string;
|
|
2219
2675
|
}
|
|
2220
2676
|
export interface PublishDraftPostResponse {
|
|
2221
|
-
/**
|
|
2677
|
+
/**
|
|
2678
|
+
* Published post ID.
|
|
2679
|
+
* @format GUID
|
|
2680
|
+
*/
|
|
2222
2681
|
postId?: string;
|
|
2223
2682
|
}
|
|
2224
2683
|
export interface UnpublishPostRequest {
|
|
2225
|
-
/** Draft post ID. */
|
|
2226
|
-
draftPostId?: string;
|
|
2227
|
-
}
|
|
2228
|
-
export interface UnpublishPostResponse {
|
|
2229
|
-
}
|
|
2230
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
2231
|
-
createdEvent?: EntityCreatedEvent;
|
|
2232
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2233
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2234
|
-
actionEvent?: ActionEvent;
|
|
2235
|
-
/**
|
|
2236
|
-
* Unique event ID.
|
|
2237
|
-
* Allows clients to ignore duplicate webhooks.
|
|
2238
|
-
*/
|
|
2239
|
-
id?: string;
|
|
2240
|
-
/**
|
|
2241
|
-
* Assumes actions are also always typed to an entity_type
|
|
2242
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
2243
|
-
*/
|
|
2244
|
-
entityFqdn?: string;
|
|
2245
2684
|
/**
|
|
2246
|
-
*
|
|
2247
|
-
*
|
|
2248
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
2249
|
-
*/
|
|
2250
|
-
slug?: string;
|
|
2251
|
-
/** ID of the entity associated with the event. */
|
|
2252
|
-
entityId?: string;
|
|
2253
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
2254
|
-
eventTime?: Date | null;
|
|
2255
|
-
/**
|
|
2256
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
2257
|
-
* (for example, GDPR).
|
|
2258
|
-
*/
|
|
2259
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
2260
|
-
/** If present, indicates the action that triggered the event. */
|
|
2261
|
-
originatedFrom?: string | null;
|
|
2262
|
-
/**
|
|
2263
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
2264
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
2265
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
2266
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
2267
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
2268
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
2685
|
+
* Draft post ID.
|
|
2686
|
+
* @maxLength 38
|
|
2269
2687
|
*/
|
|
2270
|
-
|
|
2271
|
-
}
|
|
2272
|
-
/** @oneof */
|
|
2273
|
-
export interface DomainEventBodyOneOf {
|
|
2274
|
-
createdEvent?: EntityCreatedEvent;
|
|
2275
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
2276
|
-
deletedEvent?: EntityDeletedEvent;
|
|
2277
|
-
actionEvent?: ActionEvent;
|
|
2278
|
-
}
|
|
2279
|
-
export interface EntityCreatedEvent {
|
|
2280
|
-
entityAsJson?: string;
|
|
2281
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
2282
|
-
restoreInfo?: RestoreInfo;
|
|
2688
|
+
draftPostId?: string;
|
|
2283
2689
|
}
|
|
2284
|
-
export interface
|
|
2285
|
-
deletedDate?: Date | null;
|
|
2690
|
+
export interface UnpublishPostResponse {
|
|
2286
2691
|
}
|
|
2287
|
-
export interface
|
|
2692
|
+
export interface TranslateCategoryRequest {
|
|
2288
2693
|
/**
|
|
2289
|
-
*
|
|
2290
|
-
*
|
|
2291
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
2694
|
+
* Source category ID
|
|
2695
|
+
* @format GUID
|
|
2292
2696
|
*/
|
|
2293
|
-
|
|
2294
|
-
}
|
|
2295
|
-
export interface EntityDeletedEvent {
|
|
2296
|
-
/** Entity that was deleted */
|
|
2297
|
-
deletedEntityAsJson?: string | null;
|
|
2298
|
-
}
|
|
2299
|
-
export interface ActionEvent {
|
|
2300
|
-
bodyAsJson?: string;
|
|
2301
|
-
}
|
|
2302
|
-
export interface MessageEnvelope {
|
|
2303
|
-
/** App instance ID. */
|
|
2304
|
-
instanceId?: string | null;
|
|
2305
|
-
/** Event type. */
|
|
2306
|
-
eventType?: string;
|
|
2307
|
-
/** The identification type and identity data. */
|
|
2308
|
-
identity?: IdentificationData;
|
|
2309
|
-
/** Stringify payload. */
|
|
2310
|
-
data?: string;
|
|
2311
|
-
}
|
|
2312
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
2313
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
2314
|
-
anonymousVisitorId?: string;
|
|
2315
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
2316
|
-
memberId?: string;
|
|
2317
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2318
|
-
wixUserId?: string;
|
|
2319
|
-
/** ID of an app. */
|
|
2320
|
-
appId?: string;
|
|
2321
|
-
/** @readonly */
|
|
2322
|
-
identityType?: WebhookIdentityType;
|
|
2323
|
-
}
|
|
2324
|
-
/** @oneof */
|
|
2325
|
-
export interface IdentificationDataIdOneOf {
|
|
2326
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
2327
|
-
anonymousVisitorId?: string;
|
|
2328
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
2329
|
-
memberId?: string;
|
|
2330
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
2331
|
-
wixUserId?: string;
|
|
2332
|
-
/** ID of an app. */
|
|
2333
|
-
appId?: string;
|
|
2334
|
-
}
|
|
2335
|
-
export declare enum WebhookIdentityType {
|
|
2336
|
-
UNKNOWN = "UNKNOWN",
|
|
2337
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
2338
|
-
MEMBER = "MEMBER",
|
|
2339
|
-
WIX_USER = "WIX_USER",
|
|
2340
|
-
APP = "APP"
|
|
2341
|
-
}
|
|
2342
|
-
export interface GetDraftPostTotalsRequest {
|
|
2697
|
+
categoryId?: string;
|
|
2343
2698
|
/**
|
|
2344
|
-
*
|
|
2345
|
-
*
|
|
2346
|
-
* If, for example, grouping by language is not passed, null values will be filled in language field in response.
|
|
2699
|
+
* Translation language
|
|
2700
|
+
* @format LANGUAGE_TAG
|
|
2347
2701
|
*/
|
|
2348
|
-
groupBy?: TotalDraftPostsGroupingField[];
|
|
2349
|
-
/** Optional language filter by provided language code. Useful in multilingual context. */
|
|
2350
|
-
language?: string | null;
|
|
2351
|
-
}
|
|
2352
|
-
export declare enum TotalDraftPostsGroupingField {
|
|
2353
|
-
/** Groups results by status. */
|
|
2354
|
-
STATUS = "STATUS",
|
|
2355
|
-
/** Groups results by language. */
|
|
2356
|
-
LANGUAGE = "LANGUAGE"
|
|
2357
|
-
}
|
|
2358
|
-
export interface GetDraftPostTotalsResponse {
|
|
2359
|
-
/** Draft post totals. */
|
|
2360
|
-
totalDraftPosts?: TotalDraftPosts[];
|
|
2361
|
-
}
|
|
2362
|
-
export interface TotalDraftPosts {
|
|
2363
|
-
/** Draft post totals in that group. */
|
|
2364
|
-
total?: number;
|
|
2365
|
-
/** Draft post status (only has value when grouping by status, otherwise null). */
|
|
2366
|
-
status?: Status;
|
|
2367
|
-
/** Draft post language code (only has value when grouping by language, otherwise null). */
|
|
2368
|
-
language?: string | null;
|
|
2369
|
-
}
|
|
2370
|
-
export interface TranslateCategoryRequest {
|
|
2371
|
-
/** Source category ID */
|
|
2372
|
-
categoryId?: string;
|
|
2373
|
-
/** Translation language */
|
|
2374
2702
|
language?: string;
|
|
2375
2703
|
}
|
|
2376
2704
|
export interface TranslateCategoryResponse {
|
|
@@ -2380,9 +2708,16 @@ export interface TranslateCategoryResponse {
|
|
|
2380
2708
|
translations?: CategoryTranslation[];
|
|
2381
2709
|
}
|
|
2382
2710
|
export interface Category {
|
|
2383
|
-
/**
|
|
2711
|
+
/**
|
|
2712
|
+
* Category ID.
|
|
2713
|
+
* @immutable
|
|
2714
|
+
* @maxLength 38
|
|
2715
|
+
*/
|
|
2384
2716
|
id?: string;
|
|
2385
|
-
/**
|
|
2717
|
+
/**
|
|
2718
|
+
* Category label. Displayed in the Category Menu.
|
|
2719
|
+
* @maxLength 35
|
|
2720
|
+
*/
|
|
2386
2721
|
label?: string;
|
|
2387
2722
|
/**
|
|
2388
2723
|
* Number of posts in the category.
|
|
@@ -2394,10 +2729,14 @@ export interface Category {
|
|
|
2394
2729
|
* @readonly
|
|
2395
2730
|
*/
|
|
2396
2731
|
url?: PageUrl;
|
|
2397
|
-
/**
|
|
2732
|
+
/**
|
|
2733
|
+
* Category description.
|
|
2734
|
+
* @maxLength 500
|
|
2735
|
+
*/
|
|
2398
2736
|
description?: string | null;
|
|
2399
2737
|
/**
|
|
2400
2738
|
* Category title.
|
|
2739
|
+
* @maxLength 200
|
|
2401
2740
|
* @deprecated Category title.
|
|
2402
2741
|
* @targetRemovalDate 2025-07-16
|
|
2403
2742
|
*/
|
|
@@ -2409,19 +2748,27 @@ export interface Category {
|
|
|
2409
2748
|
* Default: `-1`
|
|
2410
2749
|
*/
|
|
2411
2750
|
displayPosition?: number | null;
|
|
2412
|
-
/**
|
|
2751
|
+
/**
|
|
2752
|
+
* ID of the category's translations. All translations of a single category share the same `translationId`.
|
|
2753
|
+
* @format GUID
|
|
2754
|
+
*/
|
|
2413
2755
|
translationId?: string | null;
|
|
2414
2756
|
/**
|
|
2415
2757
|
* Category language.
|
|
2416
2758
|
*
|
|
2417
2759
|
* 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
|
|
2760
|
+
* @immutable
|
|
2418
2761
|
*/
|
|
2419
2762
|
language?: string | null;
|
|
2420
|
-
/**
|
|
2763
|
+
/**
|
|
2764
|
+
* 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`.
|
|
2765
|
+
* @maxLength 100
|
|
2766
|
+
*/
|
|
2421
2767
|
slug?: string;
|
|
2422
2768
|
/**
|
|
2423
2769
|
* Reserved for internal use.
|
|
2424
2770
|
* @readonly
|
|
2771
|
+
* @maxLength 24
|
|
2425
2772
|
*/
|
|
2426
2773
|
internalId?: string | null;
|
|
2427
2774
|
/** SEO data. */
|
|
@@ -2435,24 +2782,40 @@ export interface Category {
|
|
|
2435
2782
|
updatedDate?: Date | null;
|
|
2436
2783
|
}
|
|
2437
2784
|
export interface CategoryTranslation {
|
|
2438
|
-
/**
|
|
2785
|
+
/**
|
|
2786
|
+
* Category ID.
|
|
2787
|
+
* @format GUID
|
|
2788
|
+
*/
|
|
2439
2789
|
id?: string;
|
|
2440
|
-
/**
|
|
2790
|
+
/**
|
|
2791
|
+
* Label displayed in the categories menu on the site.
|
|
2792
|
+
* @maxLength 100
|
|
2793
|
+
*/
|
|
2441
2794
|
label?: string | null;
|
|
2442
|
-
/**
|
|
2795
|
+
/**
|
|
2796
|
+
* Language of the category.
|
|
2797
|
+
* @format LANGUAGE_TAG
|
|
2798
|
+
*/
|
|
2443
2799
|
language?: string | null;
|
|
2444
2800
|
/** URL of this category page. */
|
|
2445
2801
|
url?: PageUrl;
|
|
2446
2802
|
}
|
|
2447
2803
|
export interface TranslateDraftRequest {
|
|
2448
|
-
/**
|
|
2804
|
+
/**
|
|
2805
|
+
* Source post or draft ID
|
|
2806
|
+
* @format GUID
|
|
2807
|
+
*/
|
|
2449
2808
|
postId?: string;
|
|
2450
|
-
/**
|
|
2809
|
+
/**
|
|
2810
|
+
* Translation language
|
|
2811
|
+
* @format LANGUAGE_TAG
|
|
2812
|
+
*/
|
|
2451
2813
|
language?: string;
|
|
2452
2814
|
/**
|
|
2453
2815
|
* List of draft post fields to be included if entities are present in the response.
|
|
2454
2816
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2455
2817
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2818
|
+
* @maxSize 10
|
|
2456
2819
|
*/
|
|
2457
2820
|
fieldsets?: Field[];
|
|
2458
2821
|
}
|
|
@@ -2461,11 +2824,17 @@ export interface TranslateDraftResponse {
|
|
|
2461
2824
|
draftPost?: DraftPost;
|
|
2462
2825
|
}
|
|
2463
2826
|
export interface IsDraftPostAutoTranslatableRequest {
|
|
2464
|
-
/**
|
|
2827
|
+
/**
|
|
2828
|
+
* Source post or draft ID.
|
|
2829
|
+
* @format GUID
|
|
2830
|
+
*/
|
|
2465
2831
|
draftPostId?: string;
|
|
2466
2832
|
}
|
|
2467
2833
|
export interface IsDraftPostAutoTranslatableResponse {
|
|
2468
|
-
/**
|
|
2834
|
+
/**
|
|
2835
|
+
* Source draft post ID.
|
|
2836
|
+
* @format GUID
|
|
2837
|
+
*/
|
|
2469
2838
|
draftPostId?: string;
|
|
2470
2839
|
/** Indicates if enough machine translation credits are available for the draft post translation. */
|
|
2471
2840
|
translatable?: boolean;
|
|
@@ -2481,14 +2850,22 @@ export interface IsDraftPostAutoTranslatableResponse {
|
|
|
2481
2850
|
contentTextCharacterCount?: number;
|
|
2482
2851
|
}
|
|
2483
2852
|
export interface UpdateDraftPostLanguageRequest {
|
|
2484
|
-
/**
|
|
2853
|
+
/**
|
|
2854
|
+
* Source draft post ID
|
|
2855
|
+
* @format GUID
|
|
2856
|
+
*/
|
|
2485
2857
|
postId?: string;
|
|
2486
|
-
/**
|
|
2858
|
+
/**
|
|
2859
|
+
* New language to replace to
|
|
2860
|
+
* @minLength 2
|
|
2861
|
+
* @format LANGUAGE_TAG
|
|
2862
|
+
*/
|
|
2487
2863
|
language?: string;
|
|
2488
2864
|
/**
|
|
2489
2865
|
* List of draft post fields to be included if entities are present in the response.
|
|
2490
2866
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2491
2867
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2868
|
+
* @maxSize 10
|
|
2492
2869
|
*/
|
|
2493
2870
|
fieldsets?: Field[];
|
|
2494
2871
|
}
|
|
@@ -2497,9 +2874,16 @@ export interface UpdateDraftPostLanguageResponse {
|
|
|
2497
2874
|
draftPost?: DraftPost;
|
|
2498
2875
|
}
|
|
2499
2876
|
export interface BulkUpdateDraftPostLanguageRequest {
|
|
2500
|
-
/**
|
|
2877
|
+
/**
|
|
2878
|
+
* Source post or draft IDs
|
|
2879
|
+
* @maxSize 50
|
|
2880
|
+
* @format GUID
|
|
2881
|
+
*/
|
|
2501
2882
|
ids?: string[];
|
|
2502
|
-
/**
|
|
2883
|
+
/**
|
|
2884
|
+
* New language to replace to
|
|
2885
|
+
* @format LANGUAGE_TAG
|
|
2886
|
+
*/
|
|
2503
2887
|
language?: string;
|
|
2504
2888
|
/** Should full draft post be returned */
|
|
2505
2889
|
returnFullEntity?: boolean;
|
|
@@ -2507,6 +2891,7 @@ export interface BulkUpdateDraftPostLanguageRequest {
|
|
|
2507
2891
|
* List of draft post fields to be included if entities are present in the response.
|
|
2508
2892
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2509
2893
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2894
|
+
* @maxSize 10
|
|
2510
2895
|
*/
|
|
2511
2896
|
fieldsets?: Field[];
|
|
2512
2897
|
}
|
|
@@ -2517,7 +2902,10 @@ export interface BulkUpdateDraftPostLanguageResponse {
|
|
|
2517
2902
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2518
2903
|
}
|
|
2519
2904
|
export interface GetPostAmountsByLanguageRequest {
|
|
2520
|
-
/**
|
|
2905
|
+
/**
|
|
2906
|
+
* Post status to filter by
|
|
2907
|
+
* @maxLength 100
|
|
2908
|
+
*/
|
|
2521
2909
|
status?: string;
|
|
2522
2910
|
}
|
|
2523
2911
|
export interface GetPostAmountsByLanguageResponse {
|
|
@@ -2525,15 +2913,26 @@ export interface GetPostAmountsByLanguageResponse {
|
|
|
2525
2913
|
postAmountsByLanguage?: PostAmountByLanguage[];
|
|
2526
2914
|
}
|
|
2527
2915
|
export interface PostAmountByLanguage {
|
|
2528
|
-
/**
|
|
2916
|
+
/**
|
|
2917
|
+
* Post language code
|
|
2918
|
+
* @format LANGUAGE_TAG
|
|
2919
|
+
*/
|
|
2529
2920
|
languageCode?: string;
|
|
2530
|
-
/**
|
|
2921
|
+
/**
|
|
2922
|
+
* Language flag
|
|
2923
|
+
* @format LANGUAGE_TAG
|
|
2924
|
+
*/
|
|
2531
2925
|
flag?: string;
|
|
2532
2926
|
/** Post amount in that language */
|
|
2533
2927
|
postAmount?: number;
|
|
2534
2928
|
}
|
|
2535
2929
|
export interface BulkRevertToUnpublishedRequest {
|
|
2536
|
-
/**
|
|
2930
|
+
/**
|
|
2931
|
+
* Source post IDs.
|
|
2932
|
+
* @minSize 1
|
|
2933
|
+
* @maxSize 100
|
|
2934
|
+
* @format GUID
|
|
2935
|
+
*/
|
|
2537
2936
|
postIds?: string[];
|
|
2538
2937
|
/** Should full draft post be returned. */
|
|
2539
2938
|
returnFullEntity?: boolean;
|
|
@@ -2545,7 +2944,12 @@ export interface BulkRevertToUnpublishedResponse {
|
|
|
2545
2944
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2546
2945
|
}
|
|
2547
2946
|
export interface BulkRejectDraftPostRequest {
|
|
2548
|
-
/**
|
|
2947
|
+
/**
|
|
2948
|
+
* Source post IDs.
|
|
2949
|
+
* @minSize 1
|
|
2950
|
+
* @maxSize 100
|
|
2951
|
+
* @format GUID
|
|
2952
|
+
*/
|
|
2549
2953
|
postIds?: string[];
|
|
2550
2954
|
/** Should full draft post be returned. */
|
|
2551
2955
|
returnFullEntity?: boolean;
|
|
@@ -2557,12 +2961,16 @@ export interface BulkRejectDraftPostResponse {
|
|
|
2557
2961
|
bulkActionMetadata?: BulkActionMetadata;
|
|
2558
2962
|
}
|
|
2559
2963
|
export interface RevertToUnpublishedRequest {
|
|
2560
|
-
/**
|
|
2964
|
+
/**
|
|
2965
|
+
* Source post ID.
|
|
2966
|
+
* @format GUID
|
|
2967
|
+
*/
|
|
2561
2968
|
postId?: string;
|
|
2562
2969
|
/**
|
|
2563
2970
|
* List of draft post fields to be included if entities are present in the response.
|
|
2564
2971
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2565
2972
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2973
|
+
* @maxSize 10
|
|
2566
2974
|
*/
|
|
2567
2975
|
fieldsets?: Field[];
|
|
2568
2976
|
}
|
|
@@ -2571,12 +2979,16 @@ export interface RevertToUnpublishedResponse {
|
|
|
2571
2979
|
draftPost?: DraftPost;
|
|
2572
2980
|
}
|
|
2573
2981
|
export interface RejectDraftPostRequest {
|
|
2574
|
-
/**
|
|
2982
|
+
/**
|
|
2983
|
+
* Source post ID.
|
|
2984
|
+
* @format GUID
|
|
2985
|
+
*/
|
|
2575
2986
|
postId?: string;
|
|
2576
2987
|
/**
|
|
2577
2988
|
* List of draft post fields to be included if entities are present in the response.
|
|
2578
2989
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2579
2990
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
2991
|
+
* @maxSize 10
|
|
2580
2992
|
*/
|
|
2581
2993
|
fieldsets?: Field[];
|
|
2582
2994
|
}
|
|
@@ -2585,14 +2997,21 @@ export interface RejectDraftPostResponse {
|
|
|
2585
2997
|
draftPost?: DraftPost;
|
|
2586
2998
|
}
|
|
2587
2999
|
export interface ApproveDraftPostRequest {
|
|
2588
|
-
/**
|
|
3000
|
+
/**
|
|
3001
|
+
* Source post ID.
|
|
3002
|
+
* @format GUID
|
|
3003
|
+
*/
|
|
2589
3004
|
postId?: string;
|
|
2590
|
-
/**
|
|
3005
|
+
/**
|
|
3006
|
+
* Scheduled publish date if should be not immediately published.
|
|
3007
|
+
* @maxLength 24
|
|
3008
|
+
*/
|
|
2591
3009
|
scheduledPublishDate?: string | null;
|
|
2592
3010
|
/**
|
|
2593
3011
|
* List of draft post fields to be included if entities are present in the response.
|
|
2594
3012
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2595
3013
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3014
|
+
* @maxSize 10
|
|
2596
3015
|
*/
|
|
2597
3016
|
fieldsets?: Field[];
|
|
2598
3017
|
}
|
|
@@ -2601,12 +3020,16 @@ export interface ApproveDraftPostResponse {
|
|
|
2601
3020
|
draftPost?: DraftPost;
|
|
2602
3021
|
}
|
|
2603
3022
|
export interface MarkPostAsInModerationRequest {
|
|
2604
|
-
/**
|
|
3023
|
+
/**
|
|
3024
|
+
* Source post ID.
|
|
3025
|
+
* @maxLength 38
|
|
3026
|
+
*/
|
|
2605
3027
|
postId?: string;
|
|
2606
3028
|
/**
|
|
2607
3029
|
* List of draft post fields to be included if entities are present in the response.
|
|
2608
3030
|
* Base fieldset, which is default, will return all core draft post properties.
|
|
2609
3031
|
* Example: When URL fieldset is selected, returned draft post will have a set of base properties and draft post preview url.
|
|
3032
|
+
* @maxSize 10
|
|
2610
3033
|
*/
|
|
2611
3034
|
fieldsets?: Field[];
|
|
2612
3035
|
}
|
|
@@ -2721,9 +3144,13 @@ interface ImageDataNonNullableFields {
|
|
|
2721
3144
|
containerData?: PluginContainerDataNonNullableFields;
|
|
2722
3145
|
link?: LinkNonNullableFields;
|
|
2723
3146
|
}
|
|
3147
|
+
interface LinkPreviewDataStylesNonNullableFields {
|
|
3148
|
+
thumbnailPosition: Position;
|
|
3149
|
+
}
|
|
2724
3150
|
interface LinkPreviewDataNonNullableFields {
|
|
2725
3151
|
containerData?: PluginContainerDataNonNullableFields;
|
|
2726
3152
|
link?: LinkNonNullableFields;
|
|
3153
|
+
styles?: LinkPreviewDataStylesNonNullableFields;
|
|
2727
3154
|
}
|
|
2728
3155
|
interface MapSettingsNonNullableFields {
|
|
2729
3156
|
mapType: MapType;
|